- uvgRTP 2.0.1
+ uvgRTP 2.1.0
An open-source library for RTP/SRTP media delivery
|
@@ -99,30 +99,33 @@ typedef enum |
| enum | RTP_ERROR {
- RTP_MULTIPLE_PKTS_READY = 6
-, RTP_PKT_READY = 5
-, RTP_PKT_MODIFIED = 4
-, RTP_PKT_NOT_HANDLED = 3
+ RTP_OK = 0
,
- RTP_INTERRUPTED = 2
-, RTP_NOT_READY = 1
-, RTP_OK = 0
-, RTP_GENERIC_ERROR = -1
+ RTP_GENERIC_ERROR = -1
,
RTP_SOCKET_ERROR = -2
-, RTP_BIND_ERROR = -3
-, RTP_INVALID_VALUE = -4
-, RTP_SEND_ERROR = -5
+,
+ RTP_BIND_ERROR = -3
+,
+ RTP_INVALID_VALUE = -4
+,
+ RTP_SEND_ERROR = -5
,
RTP_MEMORY_ERROR = -6
-, RTP_SSRC_COLLISION = -7
-, RTP_INITIALIZED = -8
-, RTP_NOT_INITIALIZED = -9
+,
+ RTP_SSRC_COLLISION = -7
+,
+ RTP_INITIALIZED = -8
+,
+ RTP_NOT_INITIALIZED = -9
,
RTP_NOT_SUPPORTED = -10
-, RTP_RECV_ERROR = -11
-, RTP_TIMEOUT = -12
-, RTP_NOT_FOUND = -13
+,
+ RTP_RECV_ERROR = -11
+,
+ RTP_TIMEOUT = -12
+,
+ RTP_NOT_FOUND = -13
,
RTP_AUTH_TAG_MISMATCH = -14
@@ -131,48 +134,68 @@ Enumerations |
| |
| enum | RTP_FORMAT {
RTP_FORMAT_GENERIC = 0
-, RTP_FORMAT_PCMU = 0
-, RTP_FORMAT_GSM = 3
-, RTP_FORMAT_G723 = 4
+,
+ RTP_FORMAT_PCMU = 0
+,
+ RTP_FORMAT_GSM = 3
+,
+ RTP_FORMAT_G723 = 4
,
RTP_FORMAT_DVI4_32 = 5
-, RTP_FORMAT_DVI4_64 = 6
-, RTP_FORMAT_LPC = 7
-, RTP_FORMAT_PCMA = 8
+,
+ RTP_FORMAT_DVI4_64 = 6
+,
+ RTP_FORMAT_LPC = 7
+,
+ RTP_FORMAT_PCMA = 8
,
RTP_FORMAT_G722 = 9
-, RTP_FORMAT_L16_STEREO = 10
-, RTP_FORMAT_L16_MONO = 11
-, RTP_FORMAT_G728 = 15
+,
+ RTP_FORMAT_L16_STEREO = 10
+,
+ RTP_FORMAT_L16_MONO = 11
+,
+ RTP_FORMAT_G728 = 15
,
RTP_FORMAT_DVI4_441 = 16
-, RTP_FORMAT_DVI4_882 = 17
-, RTP_FORMAT_G729 = 18
-, RTP_FORMAT_G726_40 = 96
+,
+ RTP_FORMAT_DVI4_882 = 17
+,
+ RTP_FORMAT_G729 = 18
+,
+ RTP_FORMAT_G726_40 = 96
,
RTP_FORMAT_G726_32 = 97
-, RTP_FORMAT_G726_24 = 98
-, RTP_FORMAT_G726_16 = 99
-, RTP_FORMAT_G729D = 100
+,
+ RTP_FORMAT_G726_24 = 98
+,
+ RTP_FORMAT_G726_16 = 99
+,
+ RTP_FORMAT_G729D = 100
,
RTP_FORMAT_G729E = 101
-, RTP_FORMAT_GSM_EFR = 102
-, RTP_FORMAT_L8 = 103
-, RTP_FORMAT_VDVI = 104
+,
+ RTP_FORMAT_GSM_EFR = 102
+,
+ RTP_FORMAT_L8 = 103
+,
+ RTP_FORMAT_VDVI = 104
,
RTP_FORMAT_OPUS = 105
-, RTP_FORMAT_H264 = 106
-, RTP_FORMAT_H265 = 107
-, RTP_FORMAT_H266 = 108
+,
+ RTP_FORMAT_H264 = 106
+,
+ RTP_FORMAT_H265 = 107
+,
+ RTP_FORMAT_H266 = 108
} |
| | These flags are given to uvgrtp::session::create_stream() More...
|
| |
| enum | RTP_FLAGS {
RTP_NO_FLAGS = 0
-, RTP_OBSOLETE = 1
-, RTP_SLICE = 1
-, RTP_COPY = 1 << 1
+,
+ RTP_COPY = 1 << 1
,
RTP_NO_H26X_SCL = 1 << 2
@@ -180,60 +203,67 @@ Enumerations |
| | These flags are given to uvgrtp::media_stream::push_frame() and they can be OR'ed together. More...
|
| |
| enum | RTP_CTX_ENABLE_FLAGS {
- RCE_NO_FLAGS = 0
-, RCE_OBSOLETE = 1
-, RCE_SYSTEM_CALL_DISPATCHER = 1
-, RCE_NO_H26X_INTRA_DELAY = 1
+ RCE_NO_FLAGS = 0
,
- RCE_NO_H26X_SCL = 1
-, RCE_H26X_NO_DEPENDENCY_ENFORCEMENT = 1
-, RCE_H26X_PREPEND_SC = 1
-, RCE_NO_SYSTEM_CALL_CLUSTERING = 1
+ RCE_SEND_ONLY = 1 << 1
,
- RCE_SRTP_INPLACE_ENCRYPTION = 1
-, RCE_SEND_ONLY = 1 << 1
-, RCE_RECEIVE_ONLY = 1 << 2
-, RCE_SRTP = 1 << 3
+ RCE_RECEIVE_ONLY = 1 << 2
+,
+ RCE_SRTP = 1 << 3
,
RCE_SRTP_KMNGMNT_ZRTP = 1 << 4
-, RCE_SRTP_KMNGMNT_USER = 1 << 5
-, RCE_H26X_DO_NOT_PREPEND_SC = 1 << 6
-, RCE_H26X_DEPENDENCY_ENFORCEMENT = 1 << 7
+,
+ RCE_SRTP_KMNGMNT_USER = 1 << 5
+,
+ RCE_NO_H26X_PREPEND_SC = 1 << 6
+,
+ RCE_H26X_DEPENDENCY_ENFORCEMENT = 1 << 7
,
RCE_FRAGMENT_GENERIC = 1 << 8
-, RCE_SYSTEM_CALL_CLUSTERING = 1 << 9
-, RCE_SRTP_NULL_CIPHER = 1 << 10
-, RCE_SRTP_AUTHENTICATE_RTP = 1 << 11
+,
+ RCE_SYSTEM_CALL_CLUSTERING = 1 << 9
+,
+ RCE_SRTP_NULL_CIPHER = 1 << 10
+,
+ RCE_SRTP_AUTHENTICATE_RTP = 1 << 11
,
RCE_SRTP_REPLAY_PROTECTION = 1 << 12
-, RCE_RTCP = 1 << 13
-, RCE_HOLEPUNCH_KEEPALIVE = 1 << 14
-, RCE_SRTP_KEYSIZE_192 = 1 << 15
+,
+ RCE_RTCP = 1 << 13
+,
+ RCE_HOLEPUNCH_KEEPALIVE = 1 << 14
+,
+ RCE_SRTP_KEYSIZE_192 = 1 << 15
,
RCE_SRTP_KEYSIZE_256 = 1 << 16
-, RCE_ZRTP_MULTISTREAM_NO_DH = 1 << 17
-, RCE_FRAMERATE = 1 << 18
-, RCE_FRAGMENT_PACING = 1 << 19
,
- RCE_LAST = 1 << 20
+ RCE_ZRTP_MULTISTREAM_NO_DH = 1 << 17
+,
+ RCE_FRAME_RATE = 1 << 18
+,
+ RCE_PACE_FRAGMENT_SENDING = 1 << 19
} |
| | RTP context enable flags. More...
|
| |
| enum | RTP_CTX_CONFIGURATION_FLAGS {
- RCC_NO_FLAGS = 0
-, RCC_UDP_RCV_BUF_SIZE = 1
-, RCC_UDP_SND_BUF_SIZE = 2
-, RCC_RING_BUFFER_SIZE = 3
+ RCC_UDP_RCV_BUF_SIZE = 1
+,
+ RCC_UDP_SND_BUF_SIZE = 2
+,
+ RCC_RING_BUFFER_SIZE = 3
,
RCC_PKT_MAX_DELAY = 4
-, RCC_DYN_PAYLOAD_TYPE = 5
-, RCC_CLOCK_RATE = 6
-, RCC_MTU_SIZE = 7
,
- RCC_FPS_ENUMERATOR = 8
-, RCC_FPS_DENOMINATOR = 9
-, RCC_LAST
+ RCC_DYN_PAYLOAD_TYPE = 5
+,
+ RCC_CLOCK_RATE = 6
+,
+ RCC_MTU_SIZE = 7
+,
+ RCC_FPS_NUMERATOR = 8
+,
+ RCC_FPS_DENOMINATOR = 9
} |
| | RTP context configuration flags. More...
|
@@ -285,20 +315,19 @@ thread_local rtp_error_t r
Default is 1492, from this IPv4 and UDP, and RTP headers are removed, giving a payload size of 1452 bytes.
If application wishes to use small UDP datagram, it can set MTU size to, for example, 500 bytes or if it wishes to use jumbo frames, it can set the MTU size to 9000 bytes
|
-| RCC_FPS_ENUMERATOR | Set the enumerator of frame rate enforced by uvgRTP.
+ |
| RCC_FPS_NUMERATOR | Set the numerator of frame rate used by uvgRTP.
Default is 30.
-Setting a positive value enables this functionality. Setting it to 0 or less, disables it.
-The fps API paces the sending of the RTP packets so that receiver is under less strain to receive all. Setting this is not neccessary for small frame sizes, but even then it makes the stream smoother. The cost is at most one frame extra latency.
+Setting the fps for uvgRTP serves two possible functions:
+1) if RCE_FRAME_RATE has been set, the fps is enforced and uvgRTP tries to send frames at this exact frame rate,
+2) if RCE_PACE_FRAGMENT_SENDING has been set, the fragments are set at a constant pace spaced out evenly within frame interval
|
-| RCC_FPS_DENOMINATOR | Set the denominator of frame rate enforced by uvgRTP.
-Default is 1.
-Setting a positive value enables this functionality. Setting it to 0 or less, disables it.
-Setting the denominator is only necessary for fractional fps values as setting the enumerator already enables the fps functionality.
-
+ |
| RCC_FPS_DENOMINATOR | Set the denominator of frame rate used by uvgRTP.
+Default is 1
+See RCC_FPS_NUMERATOR for more info.
|
-Definition at line 273 of file util.hh.
+Definition at line 287 of file util.hh.
@@ -317,7 +346,13 @@ thread_local rtp_error_t r
RTP context enable flags.
These flags are passed to uvgrtp::session::create_stream and can be OR'ed together
-| Enumerator |
|---|
| RCE_SRTP | Use SRTP for this connection
+ | | Enumerator |
|---|
| RCE_NO_FLAGS | Use this if you have no RCE flags.
+ |
+| RCE_SEND_ONLY | address/port interpreted as remote, no binding to local socket
+ |
+| RCE_RECEIVE_ONLY | address/port interpreted as local, sending not possible
+ |
+| RCE_SRTP | Use SRTP for this connection
|
| RCE_SRTP_KMNGMNT_ZRTP | Use ZRTP for key management
If this flag is provided, before the session starts, ZRTP will negotiate keys with the remote participants and these keys are used as salting/keying material for the session.
@@ -327,7 +362,7 @@ thread_local rtp_error_t | r
If this flag is provided, before the media transportation starts, user must provide a master key and salt form which SRTP session keys are derived
This flag must be coupled with RCE_SRTP and is mutually exclusive with RCE_SRTP_KMNGMNT_ZRTP
|
-| RCE_H26X_DO_NOT_PREPEND_SC | By default, uvgRTP restores the stream by prepending 3 or 4 byte start code to each received H26x frame, so there is no difference with sender input. You can remove start code prefix with this flag
+ | | RCE_NO_H26X_PREPEND_SC | By default, uvgRTP restores the stream by prepending 3 or 4 byte start code to each received H26x frame, so there is no difference with sender input. You can remove start code prefix with this flag
|
| RCE_H26X_DEPENDENCY_ENFORCEMENT | Use this flag to discard inter frames that don't have their previous dependencies arrived. Does not work if the dependencies are not in monotonic order.
|
@@ -355,13 +390,13 @@ thread_local rtp_error_t r
|
| RCE_ZRTP_MULTISTREAM_NO_DH | Select which ZRTP stream does not perform Diffie-Hellman negotiation
|
-| RCE_FRAMERATE | Force uvgRTP to send packets at certain framerate (default 30 fps)
+ | | RCE_FRAME_RATE | Force uvgRTP to send packets at certain framerate (default 30 fps)
|
-| RCE_FRAGMENT_PACING | Paces the sending of frame fragments within frame interval (default 1/30 s)
+ | | RCE_PACE_FRAGMENT_SENDING | Paces the sending of frame fragments within frame interval (default 1/30 s)
|
-Definition at line 160 of file util.hh.
+Definition at line 164 of file util.hh.
@@ -430,9 +465,7 @@ thread_local rtp_error_t | r
These flags are given to uvgrtp::media_stream::push_frame() and they can be OR'ed together.
-| Enumerator |
|---|
| RTP_NO_FLAGS | No flags
- |
-| RTP_OBSOLETE | Obsolete flags
+ | | Enumerator |
|---|
| RTP_NO_FLAGS | Use this if you have no RTP flags.
|
| RTP_COPY | Make a copy of the frame and perform operation on the copy. Cannot be used with unique_ptr.
|
@@ -440,7 +473,7 @@ thread_local rtp_error_t r
|
-Definition at line 133 of file util.hh.
+Definition at line 136 of file util.hh.
@@ -516,7 +549,7 @@ thread_local rtp_error_t | r
|
-Definition at line 59 of file util.hh.
+Definition at line 62 of file util.hh.
diff --git a/docs/html/util_8hh_source.html b/docs/html/util_8hh_source.html
index 050de10..799c8ec 100644
--- a/docs/html/util_8hh_source.html
+++ b/docs/html/util_8hh_source.html
@@ -21,7 +21,7 @@