rvoip-sip 0.2.4

//! Core API Types
//!
//! Defines the main types that developers interact with when using the session API.
//!
//! # Key Types Overview
//!
//! - **`SessionId`** - Unique identifier for each call session
//! - **`CallSession`** - Represents an active call with state and metadata
//! - **`IncomingCall`** - Data about an incoming call requiring a decision
//! - **`CallState`** - Current state of a call (Ringing, Active, etc.)
//! - **`CallDecision`** - How to handle an incoming call
//! - **`MediaInfo`** - Information about media streams and quality
//!
//! # Call Lifecycle Example
//!
//! ```rust
//! use rvoip_sip::api::types::{SessionId, CallDecision, CallSession};
//! use rvoip_sip::api::CallState;
//! use std::time::Instant;
//!
//! // In real usage, IncomingCall would be provided by the framework
//! // For this example, we'll work with the CallSession directly
//!
//! // 1. Create a call session
//! let session_id = SessionId::new();
//! let sdp_answer = "v=0\r\no=- 0 0 IN IP4 127.0.0.1\r\ns=-\r\nc=IN IP4 127.0.0.1\r\nt=0 0\r\nm=audio 5006 RTP/AVP 0\r\n";
//!
//! // 2. Handler makes a decision
//! let decision = CallDecision::Accept(Some(sdp_answer.to_string()));
//!
//! // 3. Call becomes active
//! let session = CallSession {
//!     id: session_id,
//!     from: "sip:alice@example.com".to_string(),
//!     to: "sip:bob@ourserver.com".to_string(),
//!     state: CallState::Active,
//!     started_at: Some(Instant::now()),
//!     sip_call_id: Some("call-123".to_string()),
//! };
//!
//! // 4. Monitor call state
//! match session.state() {
//!     CallState::Active => println!("Call is connected"),
//!     CallState::OnHold => println!("Call is on hold"),
//!     CallState::Failed(reason) => println!("Call failed: {}", reason),
//!     _ => {}
//! }
//! ```
//!
//! # Call States
//!
//! ```text
//! Initiating -> Ringing -> Active -> Terminated
//!                |           |
//!                |           +-----> OnHold -> Active
//!                |           |
//!                |           +-----> Transferring -> Terminated
//!                |
//!                +--------> Failed/Cancelled
//! ```
//!
//! # SDP Parsing
//!
//! ```rust
//! use rvoip_sip::api::parse_sdp_connection;
//!
//! fn parse_example() -> Result<(), Box<dyn std::error::Error>> {
//!     let sdp = r#"v=0
//! o=- 0 0 IN IP4 127.0.0.1
//! s=-
//! c=IN IP4 192.168.1.100
//! t=0 0
//! m=audio 5004 RTP/AVP 0 8 101
//! a=rtpmap:0 PCMU/8000
//! a=rtpmap:8 PCMA/8000
//! a=rtpmap:101 telephone-event/8000"#;
//!
//!     let info = parse_sdp_connection(sdp)?;
//!     assert_eq!(info.ip, "192.168.1.100");
//!     assert_eq!(info.port, 5004);
//!     assert!(info.codecs.contains(&"PCMU".to_string()));
//!     Ok(())
//! }
//! ```

use crate::errors::Result;
use crate::types::CallState;
use serde::{Deserialize, Serialize};
use std::fmt;
use std::time::Instant;
use uuid::Uuid;

// Re-export StatusCode for convenience
pub use rvoip_sip_core::StatusCode;

// Re-export SessionError as Error for compatibility
pub use crate::errors::SessionError as Error;

/// Unique identifier for a session
#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct SessionId(pub String);

impl SessionId {
    /// Create a new random session ID
    pub fn new() -> Self {
        Self(format!("sess_{}", Uuid::new_v4()))
    }

    /// Create a session ID from a string
    pub fn from_string(id: String) -> Self {
        Self(id)
    }

    /// Borrow the session ID as a string slice.
    pub fn as_str(&self) -> &str {
        &self.0
    }
}

impl fmt::Display for SessionId {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.0)
    }
}

impl Default for SessionId {
    fn default() -> Self {
        Self::new()
    }
}

/// Role of a session in a SIP dialog
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum SessionRole {
    /// User Agent Client - the party that initiates the call (caller)
    UAC,
    /// User Agent Server - the party that receives the call (callee)
    UAS,
}

/// Alias for CallSession for compatibility
pub type Session = CallSession;

/// Represents a prepared outgoing call with allocated resources
/// This is created before initiating the actual SIP INVITE
#[derive(Debug, Clone)]
pub struct PreparedCall {
    /// The session ID for this call
    pub session_id: SessionId,
    /// Local SIP URI
    pub from: String,
    /// Remote SIP URI
    pub to: String,
    /// Generated SDP offer with allocated media ports
    pub sdp_offer: String,
    /// Local RTP port that was allocated
    pub local_rtp_port: u16,
}

/// Represents an active call session
#[derive(Debug, Clone)]
pub struct CallSession {
    /// Session identifier for this call.
    pub id: SessionId,
    /// Local party URI (the `From` side for an outgoing call).
    pub from: String,
    /// Remote party URI (the `To` side for an outgoing call).
    pub to: String,
    /// Current call state.
    pub state: CallState,
    /// When the session was created, if tracked.
    pub started_at: Option<Instant>,
    /// SIP Call-ID header value that uniquely identifies this call across UAC and UAS
    pub sip_call_id: Option<String>,
}

impl CallSession {
    /// Get the session ID
    pub fn id(&self) -> &SessionId {
        &self.id
    }

    /// Get the current call state
    pub fn state(&self) -> &CallState {
        &self.state
    }

    /// Check if the call is active (connected)
    pub fn is_active(&self) -> bool {
        matches!(self.state, CallState::Active)
    }

    /// Wait for the call to be answered
    /// Note: Use SessionManager::wait_for_answer() method instead
    pub async fn wait_for_answer(&self) -> Result<()> {
        // This method requires access to the event system
        Err(crate::errors::SessionError::Other(
            "Use SessionManager::wait_for_answer() method instead".to_string(),
        ))
    }

    /// Hold the call
    /// Note: Use SessionManager::hold_session() method instead
    pub async fn hold(&self) -> Result<()> {
        // This method now requires the caller to use SessionManager directly
        Err(crate::errors::SessionError::Other(
            "Use SessionManager::hold_session() method instead".to_string(),
        ))
    }

    /// Resume the call from hold
    /// Note: Use SessionManager::resume_session() method instead
    pub async fn resume(&self) -> Result<()> {
        // This method now requires the caller to use SessionManager directly
        Err(crate::errors::SessionError::Other(
            "Use SessionManager::resume_session() method instead".to_string(),
        ))
    }

    /// Transfer the call to another destination
    /// Note: Use SessionManager::transfer_session() method instead
    pub async fn transfer(&self, _target: &str) -> Result<()> {
        // This method now requires the caller to use SessionManager directly
        Err(crate::errors::SessionError::Other(
            "Use SessionManager::transfer_session() method instead".to_string(),
        ))
    }

    /// Terminate the call
    /// Note: Use SessionManager::terminate_session() method instead
    pub async fn terminate(&self) -> Result<()> {
        // This method now requires the caller to use SessionManager directly
        Err(crate::errors::SessionError::Other(
            "Use SessionManager::terminate_session() method instead".to_string(),
        ))
    }

    /// Start recording the media session
    pub async fn start_recording(&self) -> Result<()> {
        // For now, return Ok to avoid crashing the example
        // Real implementation would trigger StartRecordingMedia action
        Ok(())
    }

    /// Stop recording the media session
    pub async fn stop_recording(&self) -> Result<()> {
        // For now, return Ok to avoid crashing the example
        // Real implementation would trigger StopRecordingMedia action
        Ok(())
    }

    /// Play an audio file
    pub async fn play_audio(&self, _file: &str) -> Result<()> {
        // For now, return Ok to avoid crashing the example
        // Real implementation would trigger PlayAudioFile action
        Ok(())
    }

    /// Start the media session
    pub async fn start_media(&self) -> Result<()> {
        // For now, return Ok to avoid crashing the example
        // This would trigger StartMediaSession action but it's already
        // started automatically when the call is established
        Ok(())
    }
}

/// Represents an incoming call that needs to be handled
#[derive(Debug, Clone)]
pub struct IncomingCall {
    /// Session identifier assigned to this incoming call.
    pub id: SessionId,
    /// Caller URI from the SIP `From` header.
    pub from: String,
    /// Called URI from the SIP `To` header / request URI.
    pub to: String,
    /// Remote SDP offer, if the INVITE carried one.
    pub sdp: Option<String>,
    /// Selected SIP headers from the INVITE, keyed by header name.
    pub headers: std::collections::HashMap<String, String>,
    /// When the INVITE was received.
    pub received_at: Instant,
    /// SIP Call-ID header value that uniquely identifies this call across UAC and UAS
    pub sip_call_id: Option<String>,
    // Coordinator reference for accept/reject operations (set by handler)
    // pub(crate) coordinator: Option<Arc<crate::coordinator::SessionCoordinator>>, // Removed - use UnifiedCoordinator
}

impl IncomingCall {
    /// Create a test incoming call (only for tests)
    #[doc(hidden)]
    pub fn new_test(
        id: SessionId,
        from: String,
        to: String,
        sdp: Option<String>,
        headers: std::collections::HashMap<String, String>,
        sip_call_id: Option<String>,
    ) -> Self {
        Self {
            id,
            from,
            to,
            sdp,
            headers,
            received_at: Instant::now(),
            sip_call_id,
            // coordinator: None, // Removed field
        }
    }

    // Commented out - depends on removed modules
    // TODO: Re-implement using unified API
    /*
    /// Accept the incoming call and get a SimpleCall handle
    ///
    /// This accepts the call and returns a SimpleCall object that provides
    /// symmetric capabilities with outgoing calls.
    pub async fn accept(self) -> Result<crate::api::call::SimpleCall> {
        unimplemented!("Use UnifiedSession for call control")
    }
    */

    /*
    /// Reject the incoming call with a reason
    ///
    /// This rejects the call with the specified reason.
    pub async fn reject(self, reason: &str) -> Result<()> {
        unimplemented!("Use UnifiedSession for call control")
    }
    */

    /*
    /// Forward the incoming call to another destination
    ///
    /// This sends a SIP redirect response to forward the call.
    pub async fn forward(self, target: &str) -> Result<()> {
        unimplemented!("Use UnifiedSession for call control")
    }
    */

    /// Get caller information
    pub fn caller(&self) -> &str {
        &self.from
    }

    /// Get called party information
    pub fn called(&self) -> &str {
        &self.to
    }
}

/// Decision on how to handle an incoming call
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum CallDecision {
    /// Accept the call immediately, optionally with SDP answer
    Accept(Option<String>),
    /// Reject the call with a reason
    Reject(String),
    /// Defer the decision (e.g., add to queue)
    Defer,
    /// Forward the call to another destination
    Forward(String),
}

impl CallDecision {
    /// Create a reject decision with status code
    pub fn reject_with_code(status_code: StatusCode, reason: Option<String>) -> Self {
        CallDecision::Reject(reason.unwrap_or_else(|| status_code.to_string()))
    }

    /// Create an accept decision with optional SDP
    pub fn accept(sdp: Option<String>) -> Self {
        CallDecision::Accept(sdp)
    }

    /// Create a defer decision
    pub fn defer() -> Self {
        CallDecision::Defer
    }

    /// Create a forward decision
    pub fn forward(destination: impl Into<String>) -> Self {
        CallDecision::Forward(destination.into())
    }
}

/// Statistics about active sessions
#[derive(Debug, Clone)]
pub struct SessionStats {
    /// Total number of sessions created over the lifetime of the coordinator.
    pub total_sessions: usize,
    /// Number of currently active sessions.
    pub active_sessions: usize,
    /// Number of sessions that ended in failure.
    pub failed_sessions: usize,
    /// Average session duration, when computable.
    pub average_duration: Option<std::time::Duration>,
}

/// Media information for a session
#[derive(Debug, Clone)]
pub struct MediaInfo {
    /// Local SDP (offer or answer) for the session, if negotiated.
    pub local_sdp: Option<String>,
    /// Remote SDP (offer or answer) for the session, if negotiated.
    pub remote_sdp: Option<String>,
    /// Local RTP port allocated for the session.
    pub local_rtp_port: Option<u16>,
    /// Remote RTP port negotiated for the session.
    pub remote_rtp_port: Option<u16>,
    /// Negotiated audio codec name, when known.
    pub codec: Option<String>,
    // pub rtp_stats: Option<crate::media::stats::RtpSessionStats>, // TODO: Re-add when media stats are implemented
    // pub quality_metrics: Option<crate::media::stats::QualityMetrics>, // TODO: Re-add when media stats are implemented
}

/// Call direction
#[derive(Debug, Clone, PartialEq)]
pub enum CallDirection {
    /// Outgoing call (UAC)
    Outgoing,
    /// Incoming call (UAS)
    Incoming,
}

/// Call termination reason
#[derive(Debug, Clone)]
pub enum TerminationReason {
    /// Normal hangup by local party
    LocalHangup,
    /// Normal hangup by remote party
    RemoteHangup,
    /// Call rejected
    Rejected(String),
    /// Call failed due to error
    Error(String),
    /// Call timed out
    Timeout,
}

impl fmt::Display for TerminationReason {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            TerminationReason::LocalHangup => write!(f, "Local hangup"),
            TerminationReason::RemoteHangup => write!(f, "Remote hangup"),
            TerminationReason::Rejected(reason) => write!(f, "Rejected: {}", reason),
            TerminationReason::Error(error) => write!(f, "Error: {}", error),
            TerminationReason::Timeout => write!(f, "Timeout"),
        }
    }
}

/// Parsed SDP information for easier handling
#[derive(Debug, Clone)]
pub struct SdpInfo {
    /// Connection IP address
    pub ip: String,
    /// Media port (typically RTP port)
    pub port: u16,
    /// List of supported codecs
    pub codecs: Vec<String>,
}

/// Parse SDP connection information
///
/// # Example
/// ```no_run
/// use rvoip_sip::api::parse_sdp_connection;
///
/// let sdp = "v=0\r\nc=IN IP4 192.168.1.100\r\nm=audio 5004 RTP/AVP 0 8\r\n";
/// if let Ok(info) = parse_sdp_connection(sdp) {
///     println!("Remote endpoint: {}:{}", info.ip, info.port);
/// }
/// ```
pub fn parse_sdp_connection(sdp: &str) -> Result<SdpInfo> {
    let mut ip = None;
    let mut port = None;
    let mut codecs = Vec::new();

    for line in sdp.lines() {
        if line.starts_with("c=IN IP4 ") {
            ip = line.strip_prefix("c=IN IP4 ").map(|s| s.to_string());
        } else if line.starts_with("m=audio ") {
            let parts: Vec<&str> = line.split_whitespace().collect();
            if parts.len() > 1 {
                port = parts[1].parse().ok();
            }
            // Extract codec numbers
            if parts.len() > 3 {
                for codec in &parts[3..] {
                    codecs.push(codec.to_string());
                }
            }
        } else if line.starts_with("a=rtpmap:") {
            // Parse codec names
            if let Some(codec_info) = line.strip_prefix("a=rtpmap:") {
                let parts: Vec<&str> = codec_info.split_whitespace().collect();
                if parts.len() >= 2 {
                    // Format: "0 PCMU/8000" -> add "PCMU" to codecs
                    if let Some(codec_name) = parts[1].split('/').next() {
                        codecs.push(codec_name.to_string());
                    }
                }
            }
        }
    }

    match (ip, port) {
        (Some(ip), Some(port)) => Ok(SdpInfo { ip, port, codecs }),
        _ => Err(crate::errors::SessionError::MediaIntegration {
            reason: "Failed to parse SDP connection information".to_string(),
        }),
    }
}

// =============================================================================
// AUDIO STREAMING TYPES
// =============================================================================

/// Re-export AudioFrame from media-core to unify the type across the codebase
/// This eliminates unnecessary conversions and potential issues
pub use rvoip_media_core::types::AudioFrame;

/// Configuration for audio streaming
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AudioStreamConfig {
    /// Sample rate in Hz
    pub sample_rate: u32,
    /// Number of channels (1 for mono, 2 for stereo)
    pub channels: u8,
    /// Preferred codec (e.g., "PCMU", "PCMA", "Opus")
    pub codec: String,
    /// Frame size in milliseconds
    pub frame_size_ms: u32,
    /// Enable echo cancellation
    pub enable_aec: bool,
    /// Enable automatic gain control
    pub enable_agc: bool,
    /// Enable voice activity detection
    pub enable_vad: bool,
}

impl Default for AudioStreamConfig {
    fn default() -> Self {
        Self {
            sample_rate: 8000,         // Standard telephony
            channels: 1,               // Mono
            codec: "PCMU".to_string(), // G.711 μ-law
            frame_size_ms: 20,         // 20ms frames
            enable_aec: true,
            enable_agc: true,
            enable_vad: true,
        }
    }
}

impl AudioStreamConfig {
    /// Create a new audio stream configuration
    pub fn new(sample_rate: u32, channels: u8, codec: impl Into<String>) -> Self {
        Self {
            sample_rate,
            channels,
            codec: codec.into(),
            ..Default::default()
        }
    }

    /// Get the expected frame size in samples
    pub fn frame_size_samples(&self) -> usize {
        (self.sample_rate as usize * self.frame_size_ms as usize) / 1000
    }

    /// Get the expected frame size in bytes (for PCM)
    pub fn frame_size_bytes(&self) -> usize {
        self.frame_size_samples() * self.channels as usize * 2 // 16-bit samples
    }

    /// Create a telephony configuration (mono, 8kHz, G.711)
    pub fn telephony() -> Self {
        Self::default()
    }

    /// Create a wideband configuration (mono, 16kHz, Opus)
    pub fn wideband() -> Self {
        Self {
            sample_rate: 16000,
            codec: "Opus".to_string(),
            ..Default::default()
        }
    }

    /// Create a high-quality configuration (stereo, 48kHz, Opus)
    pub fn high_quality() -> Self {
        Self {
            sample_rate: 48000,
            channels: 2,
            codec: "Opus".to_string(),
            ..Default::default()
        }
    }
}

/// SIP-level identity of a dialog: the three values required to construct
/// a `Replaces` header (RFC 3891) for attended-transfer orchestration.
///
/// Obtain one via
/// [`SessionHandle::dialog_identity`](crate::api::handle::SessionHandle::dialog_identity).
/// To drive attended transfer from an orchestrator, read the identity of the
/// consultation session and pass its formatted form to
/// [`SessionHandle::transfer_attended`](crate::api::handle::SessionHandle::transfer_attended)
/// on the original session.
#[derive(Debug, Clone)]
pub struct DialogIdentity {
    /// SIP `Call-ID` header value.
    pub call_id: String,
    /// From-tag on our side of the dialog. `None` until the dialog is
    /// fully established.
    pub local_tag: Option<String>,
    /// To-tag from the remote side. `None` until a 2xx (or reliable 1xx)
    /// has been received and dialog is confirmed.
    pub remote_tag: Option<String>,
}

impl DialogIdentity {
    /// Format as a `Replaces` header *value* (no percent-encoding applied).
    /// Pass this to
    /// [`SessionHandle::transfer_attended`](crate::api::handle::SessionHandle::transfer_attended),
    /// which handles URI-escaping when embedding it in the Refer-To target.
    ///
    /// Returns `None` if either tag is missing (dialog not yet confirmed).
    pub fn to_replaces_value(&self) -> Option<String> {
        let (local, remote) = (self.local_tag.as_ref()?, self.remote_tag.as_ref()?);
        // RFC 3891 §3: `call-id;to-tag=<remote>;from-tag=<local>` — from the
        // transferee's perspective the "to-tag" is the *remote* party's tag
        // in the dialog being replaced.
        Some(format!(
            "{};to-tag={};from-tag={}",
            self.call_id, remote, local
        ))
    }
}

/// Subscriber for receiving decoded audio frames from a session.
///
/// This is the lower-level subscriber used by the coordinator. Most
/// application code should prefer [`SessionHandle::audio`](crate::SessionHandle::audio),
/// which wraps this in an [`AudioStream`](crate::AudioStream).
#[derive(Debug)]
pub struct AudioFrameSubscriber {
    /// The session ID this subscriber is associated with
    session_id: SessionId,
    /// Receiver for audio frames (async tokio channel for non-blocking operation)
    receiver: tokio::sync::mpsc::Receiver<AudioFrame>,
}

impl AudioFrameSubscriber {
    /// Create a new audio frame subscriber
    pub fn new(session_id: SessionId, receiver: tokio::sync::mpsc::Receiver<AudioFrame>) -> Self {
        Self {
            session_id,
            receiver,
        }
    }

    /// Get the session ID this subscriber is associated with
    pub fn session_id(&self) -> &SessionId {
        &self.session_id
    }

    /// Receive the next audio frame (async)
    ///
    /// # Returns
    /// - `Some(audio_frame)` - Audio frame ready for playback
    /// - `None` - Channel is closed or session ended
    pub async fn recv(&mut self) -> Option<AudioFrame> {
        self.receiver.recv().await
    }

    /// Try to receive an audio frame (non-blocking)
    ///
    /// # Returns
    /// - `Ok(audio_frame)` - Audio frame ready for playback
    /// - `Err(TryRecvError::Empty)` - No frame available right now
    /// - `Err(TryRecvError::Disconnected)` - Channel is closed or session ended
    pub fn try_recv(
        &mut self,
    ) -> std::result::Result<AudioFrame, tokio::sync::mpsc::error::TryRecvError> {
        self.receiver.try_recv()
    }

    /// Check if the subscriber is still connected to the session
    pub fn is_connected(&self) -> bool {
        !self.receiver.is_closed()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_session_id_creation() {
        let id1 = SessionId::new();
        let id2 = SessionId::new();
        assert_ne!(id1, id2);
        assert!(id1.0.starts_with("sess_"));
    }

    #[test]
    fn test_call_state_display() {
        use crate::types::FailureReason;
        assert_eq!(CallState::Active.to_string(), "Active");
        assert_eq!(
            CallState::Failed(FailureReason::Timeout).to_string(),
            "Failed(Timeout)"
        );
    }
}