rsiprtp 0.4.1

//! Opus codec implementation.
//!
//! Opus is a versatile audio codec for interactive speech and music.
//! - Variable bitrate (6-510 kbps)
//! - Sample rates: 8, 12, 16, 24, 48 kHz
//! - Frame sizes: 2.5, 5, 10, 20, 40, 60 ms
//! - RTP payload type: dynamic (typically 111)
//!
//! Backed by the pure-Rust `ropus` crate (bit-exact against the xiph reference).

use ropus::{Application, Channels, DecodeMode, Decoder, Encoder};

pub use ropus::{Bitrate, InbandFec};

/// Default Opus sample rate (48 kHz).
pub const OPUS_SAMPLE_RATE: u32 = 48000;

/// Samples per 20ms frame at 48kHz.
pub const OPUS_SAMPLES_PER_FRAME: usize = 960; // 48000 * 0.020

/// Maximum Opus packet size.
pub(crate) const OPUS_MAX_PACKET_SIZE: usize = 4000;

/// Opus encoder/decoder configuration.
#[derive(Debug, Clone)]
pub struct OpusConfig {
    /// Sample rate in Hz (8000, 12000, 16000, 24000, or 48000).
    pub sample_rate: u32,
    /// Number of channels (1 for mono, 2 for stereo).
    pub channels: u8,
    /// Encoder bitrate. Use `Bitrate::Bits(bps)`, `Bitrate::Auto`, or `Bitrate::Max`.
    pub bitrate: Bitrate,
    /// Frame size in milliseconds (2.5, 5, 10, 20, 40, or 60).
    pub frame_ms: f32,
}

impl Default for OpusConfig {
    fn default() -> Self {
        Self {
            sample_rate: OPUS_SAMPLE_RATE,
            channels: 1,
            bitrate: Bitrate::Bits(32_000), // 32 kbps for speech
            frame_ms: 20.0,
        }
    }
}

impl OpusConfig {
    /// Create config for wideband speech (16 kHz mono).
    pub fn wideband_speech() -> Self {
        Self {
            sample_rate: 16000,
            channels: 1,
            bitrate: Bitrate::Bits(24_000),
            frame_ms: 20.0,
        }
    }

    /// Create config for fullband speech (48 kHz mono).
    pub fn fullband_speech() -> Self {
        Self {
            sample_rate: 48000,
            channels: 1,
            bitrate: Bitrate::Bits(32_000),
            frame_ms: 20.0,
        }
    }

    /// Create config for music (48 kHz stereo).
    pub fn music() -> Self {
        Self {
            sample_rate: 48000,
            channels: 2,
            bitrate: Bitrate::Bits(96_000),
            frame_ms: 20.0,
        }
    }

    /// Get samples per frame.
    pub fn samples_per_frame(&self) -> usize {
        (self.sample_rate as f32 * self.frame_ms / 1000.0) as usize
    }

    fn to_channels(&self) -> Channels {
        if self.channels >= 2 {
            Channels::Stereo
        } else {
            Channels::Mono
        }
    }
}

/// Opus encoder/decoder.
pub struct OpusCodec {
    encoder: Encoder,
    decoder: Decoder,
    sample_rate: u32,
    channels: u8,
    frame_ms: f32,
    encode_buffer: Vec<u8>,
}

impl OpusCodec {
    /// Create a new Opus codec with default configuration.
    pub fn new() -> Result<Self, String> {
        Self::with_config(OpusConfig::default())
    }

    /// Create a new Opus codec with custom configuration.
    pub fn with_config(config: OpusConfig) -> Result<Self, String> {
        let channels = config.to_channels();

        let encoder = Encoder::builder(config.sample_rate, channels, Application::Voip)
            .bitrate(config.bitrate)
            .build()
            .map_err(|e| format!("Failed to create Opus encoder: {e}"))?;

        let decoder = Decoder::new(config.sample_rate, channels)
            .map_err(|e| format!("Failed to create Opus decoder: {e}"))?;

        Ok(Self {
            encoder,
            decoder,
            sample_rate: config.sample_rate,
            channels: config.channels,
            frame_ms: config.frame_ms,
            encode_buffer: vec![0u8; OPUS_MAX_PACKET_SIZE],
        })
    }

    /// Get the codec name.
    pub fn name(&self) -> &'static str {
        "opus"
    }

    /// Get the sample rate.
    pub fn sample_rate(&self) -> u32 {
        self.sample_rate
    }

    /// Get number of channels.
    pub fn channels(&self) -> u8 {
        self.channels
    }

    /// Get samples per frame.
    pub fn samples_per_frame(&self) -> usize {
        (self.sample_rate as f32 * self.frame_ms / 1000.0) as usize
    }

    /// Encode 16-bit PCM samples to Opus.
    ///
    /// Input: 16-bit signed linear PCM samples
    /// Output: Opus encoded bytes
    pub fn encode(&mut self, pcm: &[i16]) -> Result<Vec<u8>, String> {
        let len = self
            .encoder
            .encode(pcm, &mut self.encode_buffer)
            .map_err(|e| format!("Opus encode error: {e}"))?;

        Ok(self.encode_buffer[..len].to_vec())
    }

    /// Decode Opus to 16-bit PCM samples.
    ///
    /// Input: Opus encoded bytes
    /// Output: 16-bit signed linear PCM samples
    pub fn decode(&mut self, data: &[u8]) -> Result<Vec<i16>, String> {
        let frame_size = self.samples_per_frame() * self.channels() as usize;
        let mut decoded = vec![0i16; frame_size];

        let samples = self
            .decoder
            .decode(data, &mut decoded, DecodeMode::Normal)
            .map_err(|e| format!("Opus decode error: {e}"))?;

        decoded.truncate(samples * self.channels() as usize);
        Ok(decoded)
    }

    /// Decode with packet loss concealment.
    ///
    /// Call this when a packet is lost to generate concealment audio.
    pub fn decode_plc(&mut self) -> Result<Vec<i16>, String> {
        let frame_size = self.samples_per_frame() * self.channels() as usize;
        let mut decoded = vec![0i16; frame_size];

        // ropus: an empty packet triggers PLC.
        let samples = self
            .decoder
            .decode(&[], &mut decoded, DecodeMode::Normal)
            .map_err(|e| format!("Opus PLC error: {e}"))?;

        decoded.truncate(samples * self.channels() as usize);
        Ok(decoded)
    }

    /// Set the encoder bitrate at runtime.
    pub fn set_bitrate(&mut self, b: Bitrate) -> Result<(), String> {
        self.encoder
            .set_bitrate(b)
            .map_err(|e| format!("Opus set_bitrate error: {e}"))
    }

    /// Set the inband FEC mode at runtime.
    ///
    /// Wraps ropus's `set_inband_fec`.
    pub fn set_fec(&mut self, mode: InbandFec) -> Result<(), String> {
        self.encoder
            .set_inband_fec(mode)
            .map_err(|e| format!("Opus set_inband_fec error: {e}"))
    }

    /// Toggle DTX (discontinuous transmission) at runtime.
    pub fn set_dtx(&mut self, on: bool) -> Result<(), String> {
        self.encoder
            .set_dtx(on)
            .map_err(|e| format!("Opus set_dtx error: {e}"))
    }

    /// Set the expected packet-loss percentage (0..=100) used by FEC.
    ///
    /// Wraps ropus's `set_packet_loss_perc`.
    pub fn set_packet_loss(&mut self, pct: u8) -> Result<(), String> {
        self.encoder
            .set_packet_loss_perc(pct)
            .map_err(|e| format!("Opus set_packet_loss_perc error: {e}"))
    }

    /// Get the configured bitrate.
    pub fn bitrate(&self) -> Bitrate {
        self.encoder.bitrate()
    }

    /// Get the configured inband FEC mode.
    pub fn inband_fec(&self) -> InbandFec {
        self.encoder.inband_fec()
    }

    /// Get whether DTX is enabled.
    pub fn dtx(&self) -> bool {
        self.encoder.dtx()
    }

    /// Get the expected packet-loss percentage.
    pub fn packet_loss_perc(&self) -> u8 {
        self.encoder.packet_loss_perc()
    }
}

impl Default for OpusCodec {
    fn default() -> Self {
        Self::new().expect("Failed to create default Opus codec")
    }
}

impl super::AdaptiveBitrate for OpusCodec {
    fn set_target_bitrate_bps(&mut self, bps: u32) -> Result<(), String> {
        self.set_bitrate(Bitrate::Bits(bps))
    }
}

const _: fn() = || {
    fn assert_send_sync<T: Send + Sync>() {}
    assert_send_sync::<OpusCodec>();
};

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

    #[test]
    fn test_create_codec() {
        let codec = OpusCodec::new();
        assert!(codec.is_ok());
    }

    #[test]
    fn test_encode_decode_roundtrip() {
        let mut codec = OpusCodec::new().unwrap();

        // Create a test signal (sine wave)
        let samples: Vec<i16> = (0..codec.samples_per_frame())
            .map(|i| ((i as f32 * 0.1).sin() * 16000.0) as i16)
            .collect();

        // Encode
        let encoded = codec.encode(&samples).unwrap();
        assert!(!encoded.is_empty());
        assert!(encoded.len() < samples.len() * 2); // Should compress

        // Decode
        let decoded = codec.decode(&encoded).unwrap();
        assert_eq!(decoded.len(), samples.len());
    }

    #[test]
    fn test_wideband_config() {
        let config = OpusConfig::wideband_speech();
        assert_eq!(config.sample_rate, 16000);
        assert_eq!(config.channels, 1);
        assert_eq!(config.samples_per_frame(), 320);
    }

    #[test]
    fn test_fullband_config() {
        let config = OpusConfig::fullband_speech();
        assert_eq!(config.sample_rate, 48000);
        assert_eq!(config.samples_per_frame(), 960);
    }

    #[test]
    fn test_plc() {
        let mut codec = OpusCodec::new().unwrap();

        // First, encode and decode a real frame to prime the decoder
        let samples: Vec<i16> = (0..codec.samples_per_frame())
            .map(|i| ((i as f32 * 0.1).sin() * 8000.0) as i16)
            .collect();
        let encoded = codec.encode(&samples).unwrap();
        let _ = codec.decode(&encoded).unwrap();

        // Now test PLC
        let plc = codec.decode_plc();
        assert!(plc.is_ok());
        let plc_samples = plc.unwrap();
        assert_eq!(plc_samples.len(), codec.samples_per_frame());
    }

    #[test]
    fn test_name() {
        let codec = OpusCodec::new().unwrap();
        assert_eq!(codec.name(), "opus");
    }

    fn sample_frame(codec: &OpusCodec) -> Vec<i16> {
        (0..codec.samples_per_frame())
            .map(|i| ((i as f32 * 0.1).sin() * 16000.0) as i16)
            .collect()
    }

    #[test]
    fn test_set_bitrate_explicit() {
        let mut codec = OpusCodec::new().unwrap();
        let frame_len = codec.samples_per_frame();

        codec.set_bitrate(Bitrate::Bits(24_000)).unwrap();
        let pcm = sample_frame(&codec);
        let encoded = codec.encode(&pcm).unwrap();
        assert!(!encoded.is_empty());
        let decoded = codec.decode(&encoded).unwrap();
        assert_eq!(decoded.len(), frame_len);

        codec.set_bitrate(Bitrate::Bits(64_000)).unwrap();
        let encoded = codec.encode(&pcm).unwrap();
        assert!(!encoded.is_empty());
        let decoded = codec.decode(&encoded).unwrap();
        assert_eq!(decoded.len(), frame_len);

        assert_eq!(codec.bitrate(), Bitrate::Bits(64_000));
    }

    #[test]
    fn test_set_bitrate_zero_rejected() {
        let mut codec = OpusCodec::new().unwrap();
        let err = codec
            .set_bitrate(Bitrate::Bits(0))
            .expect_err("zero bitrate must be rejected");
        assert!(
            err.contains("set_bitrate"),
            "error message should reference set_bitrate, got: {err}"
        );
    }

    #[test]
    fn test_set_packet_loss_out_of_range() {
        let mut codec = OpusCodec::new().unwrap();
        let err = codec
            .set_packet_loss(101)
            .expect_err("packet-loss percent above 100 must be rejected");
        assert!(
            err.contains("set_packet_loss"),
            "error message should reference set_packet_loss, got: {err}"
        );
    }

    #[test]
    fn test_set_bitrate_huge_clamped() {
        // Note: ropus 0.12 silently clamps bitrates above `750_000 * channels`
        // rather than returning an error (see ropus::Bitrate docs). On a mono
        // encoder the upper bound is 750_000 bps. We assert the actual
        // contract — set_bitrate returns Ok and the read-back is the clamped
        // value — so the wrapper does not paper over upstream behaviour.
        let mut codec = OpusCodec::new().unwrap();
        codec
            .set_bitrate(Bitrate::Bits(10_000_000))
            .expect("ropus clamps high bitrate rather than erroring");
        assert_eq!(codec.bitrate(), Bitrate::Bits(750_000));
    }

    #[test]
    fn test_set_bitrate_auto() {
        let mut codec = OpusCodec::new().unwrap();
        codec.set_bitrate(Bitrate::Auto).unwrap();
        assert_eq!(codec.bitrate(), Bitrate::Auto);

        let pcm = sample_frame(&codec);
        let encoded = codec.encode(&pcm).unwrap();
        assert!(!encoded.is_empty());
    }

    #[test]
    fn test_set_fec_modes() {
        let mut codec = OpusCodec::new().unwrap();

        for mode in [InbandFec::Disabled, InbandFec::Enabled, InbandFec::Forced] {
            codec.set_fec(mode).unwrap();
            assert_eq!(codec.inband_fec(), mode);
        }
    }

    #[test]
    fn test_set_dtx_toggle() {
        let mut codec = OpusCodec::new().unwrap();

        codec.set_dtx(true).unwrap();
        assert!(codec.dtx());

        codec.set_dtx(false).unwrap();
        assert!(!codec.dtx());
    }

    #[test]
    fn test_set_packet_loss_perc() {
        let mut codec = OpusCodec::new().unwrap();

        codec.set_packet_loss(10).unwrap();
        assert_eq!(codec.packet_loss_perc(), 10);

        codec.set_packet_loss(50).unwrap();
        assert_eq!(codec.packet_loss_perc(), 50);
    }

    #[test]
    fn test_config_uses_bitrate_enum() {
        let config = OpusConfig {
            sample_rate: OPUS_SAMPLE_RATE,
            channels: 1,
            bitrate: Bitrate::Bits(48_000),
            frame_ms: 20.0,
        };
        let codec = OpusCodec::with_config(config).unwrap();
        assert_eq!(codec.bitrate(), Bitrate::Bits(48_000));
    }
}