rvoip-rtp-core 0.2.3

RTP/RTCP protocol implementation for the rvoip stack
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

//! Public traits for integration with other crates
//!
//! This module provides trait definitions that allow rtp-core to be integrated
//! with other components of the rVOIP stack, such as media-core.

use async_trait::async_trait;
use bytes::Bytes;
use std::net::SocketAddr;

use crate::error::Error;
use crate::Result;

// Export the media_transport module
pub mod media_transport;
pub use media_transport::RtpMediaTransport;

/// Media Transport trait for transporting media data
///
/// This trait is used by media-core to send media samples over RTP.
#[async_trait]
pub trait MediaTransport: Send + Sync {
    /// Get the local address for media transport
    async fn local_addr(&self) -> Result<SocketAddr>;

    /// Send media data with the given payload type, timestamp, and marker bit
    async fn send_media(
        &self,
        payload_type: u8,
        timestamp: u32,
        payload: Bytes,
        marker: bool,
    ) -> Result<()>;

    /// Close the transport
    async fn close(&self) -> Result<()>;
}

/// RTP Events that can be received from the transport
#[derive(Debug, Clone)]
pub enum RtpEvent {
    /// Media data received
    MediaReceived {
        /// Payload type
        payload_type: u8,

        /// RTP sequence number
        sequence_number: u16,

        /// RTP timestamp
        timestamp: u32,

        /// Marker bit
        marker: bool,

        /// Payload data
        payload: Bytes,

        /// Source address
        source: SocketAddr,

        /// SSRC (Synchronization Source)
        ssrc: u32,
    },

    /// RTCP packet received (raw bytes for now)
    RtcpReceived {
        /// RTCP data
        data: Bytes,

        /// Source address
        source: SocketAddr,
    },

    /// RFC 4733 telephone-event received (DTMF / fax / modem tone).
    ///
    /// Emitted by the UDP receive loop whenever a packet arrives with
    /// the negotiated telephone-event payload type (PT 101 by default).
    /// Payload is pre-decoded into typed fields so the media layer
    /// doesn't re-parse; dedup across redundant retransmits (RFC 4733
    /// §2.5.1.3) is left to the consumer — the recommended shape is to
    /// key on `(ssrc, timestamp)` since retransmits of the same tone
    /// share both while distinct tones get distinct timestamps.
    DtmfEvent {
        /// Event code (0-15 for DTMF: 0-9 / `*` / `#` / A-D).
        event: u8,
        /// End-of-event bit (RFC 4733 §2.3 `E`). The last three frames
        /// of a tone all have this set.
        end_of_event: bool,
        /// Volume in -dBm0 (0 = loudest, 63 = quietest). RFC 4733 6-bit.
        volume: u8,
        /// Duration in RTP timestamp units since event start.
        duration: u16,
        /// RTP packet timestamp. Distinct per tone; shared across the
        /// three retransmissions of a single tone per RFC 4733 §2.5.1.3.
        /// This is the stable dedup key on the consumer side.
        timestamp: u32,
        /// Source address.
        source: SocketAddr,
        /// SSRC — lets the consumer disambiguate simultaneous DTMF
        /// streams on the same socket (rare, but possible for b2bua).
        ssrc: u32,
    },

    /// Transport error occurred
    Error(Error),
}

/// RTP Event Consumer trait
///
/// This trait is implemented by components that want to receive RTP events.
#[async_trait]
pub trait RtpEventConsumer: Send + Sync {
    /// Process an RTP event
    async fn process_event(&self, event: RtpEvent) -> Result<()>;
}