xref: /xiu/protocol/rtmp/src/session/client_session.rs (revision 69de9bbd)

use crate::chunk::packetizer::ChunkPacketizer;

use {
    super::{
        common::Common,
        define,
        define::SessionType,
        errors::{SessionError, SessionErrorValue},
    },
    crate::{
        amf0::Amf0ValueType,
        chunk::{
            define::CHUNK_SIZE,
            unpacketizer::{ChunkUnpacketizer, UnpackResult},
        },
        handshake,
        handshake::{define::ClientHandshakeState, handshake_client::SimpleHandshakeClient},
        messages::{define::RtmpMessageData, parser::MessageParser},
        netconnection::writer::{ConnectProperties, NetConnection},
        netstream::writer::NetStreamWriter,
        protocol_control_messages::writer::ProtocolControlMessagesWriter,
        user_control_messages::writer::EventMessagesWriter,
        utils::RtmpUrlParser,
    },
    bytesio::{
        bytes_writer::AsyncBytesWriter,
        bytesio::{TNetIO, TcpIO},
    },
    indexmap::IndexMap,
    std::sync::Arc,
    //crate::utils::print::print,
    streamhub::define::StreamHubEventSender,
    streamhub::utils::RandomDigitCount,
    streamhub::utils::Uuid,
    tokio::{net::TcpStream, sync::Mutex},
};

#[allow(dead_code)]
enum ClientSessionState {
    Handshake,
    Connect,
    CreateStream,
    Play,
    PublishingContent,
    StartPublish,
    WaitStateChange,
}

#[allow(dead_code)]
enum ClientSessionPlayState {
    Handshake,
    Connect,
    CreateStream,
    Play,
}

#[allow(dead_code)]
enum ClientSessionPublishState {
    Handshake,
    Connect,
    CreateStream,
    PublishingContent,
}
#[allow(dead_code)]
#[derive(Clone, Debug, PartialEq)]
pub enum ClientType {
    Play,
    Publish,
}
pub struct ClientSession {
    io: Arc<Mutex<Box<dyn TNetIO + Send + Sync>>>,
    common: Common,
    handshaker: SimpleHandshakeClient,
    unpacketizer: ChunkUnpacketizer,
    //domain name with port
    raw_domain_name: String,
    app_name: String,
    //stream name with parameters
    raw_stream_name: String,
    stream_name: String,
    /* Used to mark the subscriber's the data producer
    in channels and delete it from map when unsubscribe
    is called. */
    session_id: Uuid,
    state: ClientSessionState,
    client_type: ClientType,
    sub_app_name: Option<String>,
    sub_stream_name: Option<String>,
    /*configure how many gops will be cached.*/
    gop_num: usize,
}

impl ClientSession {
    pub fn new(
        stream: TcpStream,
        client_type: ClientType,
        raw_domain_name: String,
        app_name: String,
        raw_stream_name: String,
        event_producer: StreamHubEventSender,
        gop_num: usize,
    ) -> Self {
        let remote_addr = if let Ok(addr) = stream.peer_addr() {
            log::info!("server session: {}", addr.to_string());
            Some(addr)
        } else {
            None
        };

        let tcp_io: Box<dyn TNetIO + Send + Sync> = Box::new(TcpIO::new(stream));
        let net_io = Arc::new(Mutex::new(tcp_io));

        let subscriber_id = Uuid::new(RandomDigitCount::Four);

        let packetizer = if client_type == ClientType::Publish {
            Some(ChunkPacketizer::new(Arc::clone(&net_io)))
        } else {
            None
        };

        let common = Common::new(packetizer, event_producer, SessionType::Client, remote_addr);

        let (stream_name, _) = RtmpUrlParser::default()
            .set_raw_stream_name(raw_stream_name.clone())
            .parse_raw_stream_name();

        Self {
            io: Arc::clone(&net_io),
            common,
            handshaker: SimpleHandshakeClient::new(Arc::clone(&net_io)),
            unpacketizer: ChunkUnpacketizer::new(),
            raw_domain_name,
            app_name,
            raw_stream_name,
            stream_name,
            session_id: subscriber_id,
            state: ClientSessionState::Handshake,
            client_type,
            sub_app_name: None,
            sub_stream_name: None,
            gop_num,
        }
    }

    pub async fn run(&mut self) -> Result<(), SessionError> {
        loop {
            match self.state {
                ClientSessionState::Handshake => {
                    log::info!("[C -> S] handshake...");
                    self.handshake().await?;
                    continue;
                }
                ClientSessionState::Connect => {
                    log::info!("[C -> S] connect...");
                    self.send_connect(&(define::TRANSACTION_ID_CONNECT as f64))
                        .await?;
                    self.state = ClientSessionState::WaitStateChange;
                }
                ClientSessionState::CreateStream => {
                    log::info!("[C -> S] CreateStream...");
                    self.send_create_stream(&(define::TRANSACTION_ID_CREATE_STREAM as f64))
                        .await?;
                    self.state = ClientSessionState::WaitStateChange;
                }
                ClientSessionState::Play => {
                    log::info!("[C -> S] Play...");
                    self.send_play(&0.0, &self.raw_stream_name.clone(), &0.0, &0.0, &false)
                        .await?;
                    self.state = ClientSessionState::WaitStateChange;
                }
                ClientSessionState::PublishingContent => {
                    log::info!("[C -> S] PublishingContent...");
                    self.send_publish(&3.0, &self.raw_stream_name.clone(), &"live".to_string())
                        .await?;
                    self.state = ClientSessionState::WaitStateChange;
                }
                ClientSessionState::StartPublish => {
                    log::info!("[C -> S] StartPublish...");
                    self.common.send_channel_data().await?;
                }
                ClientSessionState::WaitStateChange => {}
            }

            let data = self.io.lock().await.read().await?;
            self.unpacketizer.extend_data(&data[..]);

            loop {
                match self.unpacketizer.read_chunks() {
                    Ok(rv) => {
                        if let UnpackResult::Chunks(chunks) = rv {
                            for chunk_info in chunks.iter() {
                                if let Some(mut msg) =
                                    MessageParser::new(chunk_info.clone()).parse()?
                                {
                                    let timestamp = chunk_info.message_header.timestamp;
                                    self.process_messages(&mut msg, &timestamp).await?;
                                }
                            }
                        }
                    }
                    Err(err) => {
                        log::trace!("read trunks error: {}", err);
                        break;
                    }
                }
            }
        }
    }

    async fn handshake(&mut self) -> Result<(), SessionError> {
        loop {
            self.handshaker.handshake().await?;
            if self.handshaker.state == ClientHandshakeState::Finish {
                log::info!("handshake finish");
                break;
            }

            let mut bytes_len = 0;
            while bytes_len < handshake::define::RTMP_HANDSHAKE_SIZE * 2 {
                let data = self.io.lock().await.read().await?;
                bytes_len += data.len();
                self.handshaker.extend_data(&data[..]);
            }
        }

        self.state = ClientSessionState::Connect;

        Ok(())
    }

    pub async fn process_messages(
        &mut self,
        msg: &mut RtmpMessageData,
        timestamp: &u32,
    ) -> Result<(), SessionError> {
        match msg {
            RtmpMessageData::Amf0Command {
                command_name,
                transaction_id,
                command_object,
                others,
            } => {
                log::info!("[C <- S] on_amf0_command_message...");
                self.on_amf0_command_message(command_name, transaction_id, command_object, others)
                    .await?
            }
            RtmpMessageData::SetPeerBandwidth { .. } => {
                log::info!("[C <- S] on_set_peer_bandwidth...");
                self.on_set_peer_bandwidth().await?
            }
            RtmpMessageData::WindowAcknowledgementSize { .. } => {
                log::info!("[C <- S] on_windows_acknowledgement_size...");
            }
            RtmpMessageData::SetChunkSize { chunk_size } => {
                log::info!("[C <- S] on_set_chunk_size...");
                self.on_set_chunk_size(chunk_size)?;
            }
            RtmpMessageData::StreamBegin { stream_id } => {
                log::info!("[C <- S] on_stream_begin...");
                self.on_stream_begin(stream_id)?;
            }
            RtmpMessageData::StreamIsRecorded { stream_id } => {
                log::info!("[C <- S] on_stream_is_recorded...");
                self.on_stream_is_recorded(stream_id)?;
            }
            RtmpMessageData::AudioData { data } => {
                self.common.on_audio_data(data, timestamp).await?
            }
            RtmpMessageData::VideoData { data } => {
                self.common.on_video_data(data, timestamp).await?
            }
            RtmpMessageData::AmfData { raw_data } => {
                self.common.on_meta_data(raw_data, timestamp).await?;
            }

            _ => {}
        }
        Ok(())
    }

    pub async fn on_amf0_command_message(
        &mut self,
        command_name: &Amf0ValueType,
        transaction_id: &Amf0ValueType,
        command_object: &Amf0ValueType,
        others: &mut Vec<Amf0ValueType>,
    ) -> Result<(), SessionError> {
        log::info!("[C <- S] on_amf0_command_message...");
        let empty_cmd_name = &String::new();
        let cmd_name = match command_name {
            Amf0ValueType::UTF8String(str) => str,
            _ => empty_cmd_name,
        };

        let transaction_id = match transaction_id {
            Amf0ValueType::Number(number) => *number as u8,
            _ => 0,
        };

        let empty_cmd_obj: IndexMap<String, Amf0ValueType> = IndexMap::new();
        let _ = match command_object {
            Amf0ValueType::Object(obj) => obj,
            // Amf0ValueType::Null =>
            _ => &empty_cmd_obj,
        };

        match cmd_name.as_str() {
            "_result" => match transaction_id {
                define::TRANSACTION_ID_CONNECT => {
                    log::info!("[C <- S] on_result_connect...");
                    self.on_result_connect().await?;
                }
                define::TRANSACTION_ID_CREATE_STREAM => {
                    log::info!("[C <- S] on_result_create_stream...");
                    self.on_result_create_stream()?;
                }
                _ => {}
            },
            "_error" => {
                self.on_error()?;
            }
            "onStatus" => {
                match others.remove(0) {
                    Amf0ValueType::Object(obj) => self.on_status(&obj).await?,
                    _ => {
                        return Err(SessionError {
                            value: SessionErrorValue::Amf0ValueCountNotCorrect,
                        })
                    }
                };
            }

            _ => {}
        }

        Ok(())
    }

    pub async fn send_connect(&mut self, transaction_id: &f64) -> Result<(), SessionError> {
        self.send_set_chunk_size().await?;

        let mut netconnection = NetConnection::new(Arc::clone(&self.io));
        let mut properties = ConnectProperties::new_none();

        let url = format!(
            "rtmp://{domain_name}/{app_name}",
            domain_name = self.raw_domain_name,
            app_name = self.app_name
        );
        properties.app = Some(self.app_name.clone());

        match self.client_type {
            ClientType::Play => {
                properties.flash_ver = Some("LNX 9,0,124,2".to_string());
                properties.tc_url = Some(url.clone());
                properties.fpad = Some(false);
                properties.capabilities = Some(15_f64);
                properties.audio_codecs = Some(4071_f64);
                properties.video_codecs = Some(252_f64);
                properties.video_function = Some(1_f64);
            }
            ClientType::Publish => {
                properties.pub_type = Some("nonprivate".to_string());
                properties.flash_ver = Some("FMLE/3.0 (compatible; xiu)".to_string());
                properties.fpad = Some(false);
                properties.tc_url = Some(url.clone());
            }
        }

        netconnection
            .write_connect(transaction_id, &properties)
            .await?;

        Ok(())
    }

    pub async fn send_create_stream(&mut self, transaction_id: &f64) -> Result<(), SessionError> {
        let mut netconnection = NetConnection::new(Arc::clone(&self.io));
        netconnection.write_create_stream(transaction_id).await?;

        Ok(())
    }

    pub async fn send_delete_stream(
        &mut self,
        transaction_id: &f64,
        stream_id: &f64,
    ) -> Result<(), SessionError> {
        let mut netstream = NetStreamWriter::new(Arc::clone(&self.io));
        netstream
            .write_delete_stream(transaction_id, stream_id)
            .await?;

        Ok(())
    }

    pub async fn send_publish(
        &mut self,
        transaction_id: &f64,
        stream_name: &String,
        stream_type: &String,
    ) -> Result<(), SessionError> {
        let mut netstream = NetStreamWriter::new(Arc::clone(&self.io));
        netstream
            .write_publish(transaction_id, stream_name, stream_type)
            .await?;

        Ok(())
    }

    pub async fn send_play(
        &mut self,
        transaction_id: &f64,
        stream_name: &String,
        start: &f64,
        duration: &f64,
        reset: &bool,
    ) -> Result<(), SessionError> {
        let mut netstream = NetStreamWriter::new(Arc::clone(&self.io));
        netstream
            .write_play(transaction_id, stream_name, start, duration, reset)
            .await?;

        let mut netconnection = NetConnection::new(Arc::clone(&self.io));
        netconnection
            .write_get_stream_length(transaction_id, stream_name)
            .await?;

        self.send_set_buffer_length(1, 1300).await?;

        Ok(())
    }

    pub async fn send_set_chunk_size(&mut self) -> Result<(), SessionError> {
        let mut controlmessage =
            ProtocolControlMessagesWriter::new(AsyncBytesWriter::new(self.io.clone()));
        controlmessage.write_set_chunk_size(CHUNK_SIZE).await?;
        Ok(())
    }

    pub async fn send_window_acknowledgement_size(
        &mut self,
        window_size: u32,
    ) -> Result<(), SessionError> {
        let mut controlmessage =
            ProtocolControlMessagesWriter::new(AsyncBytesWriter::new(self.io.clone()));
        controlmessage
            .write_window_acknowledgement_size(window_size)
            .await?;
        Ok(())
    }

    pub async fn send_set_buffer_length(
        &mut self,
        stream_id: u32,
        ms: u32,
    ) -> Result<(), SessionError> {
        let mut eventmessages = EventMessagesWriter::new(AsyncBytesWriter::new(self.io.clone()));
        eventmessages.write_set_buffer_length(stream_id, ms).await?;

        Ok(())
    }

    pub async fn on_result_connect(&mut self) -> Result<(), SessionError> {
        let mut controlmessage =
            ProtocolControlMessagesWriter::new(AsyncBytesWriter::new(self.io.clone()));
        controlmessage.write_acknowledgement(3107).await?;

        let mut netstream = NetStreamWriter::new(Arc::clone(&self.io));
        netstream
            .write_release_stream(&(define::TRANSACTION_ID_CONNECT as f64), &self.stream_name)
            .await?;
        netstream
            .write_fcpublish(&(define::TRANSACTION_ID_CONNECT as f64), &self.stream_name)
            .await?;

        self.state = ClientSessionState::CreateStream;

        Ok(())
    }

    pub fn on_result_create_stream(&mut self) -> Result<(), SessionError> {
        match self.client_type {
            ClientType::Play => {
                self.state = ClientSessionState::Play;
            }
            ClientType::Publish => {
                self.state = ClientSessionState::PublishingContent;
            }
        }
        Ok(())
    }

    pub fn on_set_chunk_size(&mut self, chunk_size: &mut u32) -> Result<(), SessionError> {
        self.unpacketizer
            .update_max_chunk_size(*chunk_size as usize);
        Ok(())
    }

    pub fn on_stream_is_recorded(&mut self, stream_id: &mut u32) -> Result<(), SessionError> {
        log::trace!("stream is recorded stream_id is {}", stream_id);
        Ok(())
    }

    pub fn on_stream_begin(&mut self, stream_id: &mut u32) -> Result<(), SessionError> {
        log::trace!("stream is begin stream_id is {}", stream_id);
        Ok(())
    }

    pub async fn on_set_peer_bandwidth(&mut self) -> Result<(), SessionError> {
        self.send_window_acknowledgement_size(5000000).await?;

        Ok(())
    }

    pub fn on_error(&mut self) -> Result<(), SessionError> {
        Ok(())
    }

    pub async fn on_status(
        &mut self,
        obj: &IndexMap<String, Amf0ValueType>,
    ) -> Result<(), SessionError> {
        if let Some(Amf0ValueType::UTF8String(code_info)) = obj.get("code") {
            match &code_info[..] {
                "NetStream.Publish.Start" => {
                    self.state = ClientSessionState::StartPublish;
                    //subscribe from local session and publish to remote rtmp server
                    if let (Some(app_name), Some(stream_name)) =
                        (&self.sub_app_name, &self.sub_stream_name)
                    {
                        self.common
                            .subscribe_from_channels(
                                app_name.clone(),
                                stream_name.clone(),
                                self.session_id,
                            )
                            .await?;
                    } else {
                        self.common
                            .subscribe_from_channels(
                                self.app_name.clone(),
                                self.stream_name.clone(),
                                self.session_id,
                            )
                            .await?;
                    }
                }
                "NetStream.Publish.Reset" => {}
                "NetStream.Play.Start" => {
                    //pull from remote rtmp server and publish to local session
                    self.common
                        .publish_to_channels(
                            self.app_name.clone(),
                            self.stream_name.clone(),
                            self.session_id,
                            self.gop_num,
                        )
                        .await?
                }
                _ => {}
            }
        }
        log::trace!("{}", obj.len());
        Ok(())
    }

    pub fn subscribe(&mut self, app_name: String, stream_name: String) {
        self.sub_app_name = Some(app_name);
        self.sub_stream_name = Some(stream_name);
    }
}