diff --git a/docs/README.md b/docs/README.md index 8c00df7..278cfd2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -158,10 +158,10 @@ The default MTU size of uvgRTP has been set to 1492 to account for 8 bytes of un ## Trouble receiving burst of packets? -The default configuration of uvgRTP should be able to handle most basic scenarios up to 4K30p without any frame loss. If you are however 1) using a higher resolution, 2) higher fps value, 3) using a low power machine to receive the RTP stream, or 4) you are experiencing frame loss, you might consider setting or increasing the following parameters: +The default configuration of uvgRTP should be able to handle most basic scenarios up to 4K60p without any frame loss. If you are however 1) using a higher resolution, 2) higher fps value, 3) using a low power machine to receive the RTP stream, or 4) you are experiencing frame loss, you might consider setting or increasing the following parameters: * RCC_UDP_RCV_BUF_SIZE: You can try increasing this to 40 or 80 MB if it helps receiving frames * RCC_UDP_SND_BUF_SIZE_ You can try increasing this to 40 or 80 MB if it helps sending frames -* RCC_RING_BUFFER_SIZE: You can try increasing this to 40 or 80 MB if it helps receiving frames -* RCE_PACE_FRAGMENT_SENDING, RCC_FPS_ENUMERATOR and RCC_FPS_DENOMINATOR: You can try RCE_PACE_FRAGMENT_SENDING to make sender pace the sending of framents so receiver has easier time receiving them. Use RCC_FPS_ENUMERATOR and RCC_FPS_DENOMINATOR to set your fps +* RCC_RING_BUFFER_SIZE: You can try increasing this to 8 or 16 MB if it helps receiving frames +* RCE_PACE_FRAGMENT_SENDING, RCC_FPS_NUMERATOR and RCC_FPS_DENOMINATOR: You can try RCE_PACE_FRAGMENT_SENDING to make sender pace the sending of framents so receiver has easier time receiving them. Use RCC_FPS_NUMERATOR and RCC_FPS_DENOMINATOR to set your frame rate None of these parameters will however help if you are sending more data than the receiver can process, they only help when dealing with burst of (usually fragmented) RTP traffic. diff --git a/include/uvgrtp/util.hh b/include/uvgrtp/util.hh index 40c4929..c930817 100644 --- a/include/uvgrtp/util.hh +++ b/include/uvgrtp/util.hh @@ -166,19 +166,19 @@ enum RTP_CTX_ENABLE_FLAGS { /// \cond DO_NOT_DOCUMENT // Obsolete flags, they do nothing because the feature has been removed or they are enabled by default - RCE_OBSOLETE = 1, // for checking if user inputs obsolete flags - RCE_SYSTEM_CALL_DISPATCHER = 1, // removed feature - RCE_NO_H26X_INTRA_DELAY = 1, // removed feature - RCE_NO_H26X_SCL = 1, // this flag was moved to be an RTP flag - RCE_H26X_NO_DEPENDENCY_ENFORCEMENT = 1, // the feature is disabled by default - RCE_H26X_PREPEND_SC = 1, // the feature is enabled by default - RCE_NO_SYSTEM_CALL_CLUSTERING = 1, // disabled by default - RCE_SRTP_INPLACE_ENCRYPTION = 1, // the feature is enabled by default + RCE_OBSOLETE = 1, ///< for checking if user inputs obsolete flags + RCE_SYSTEM_CALL_DISPATCHER = 1, ///< obsolete flag, removed feature + RCE_NO_H26X_INTRA_DELAY = 1, ///< obsolete flag, removed feature + RCE_NO_H26X_SCL = 1, ///< obsolete flag, this flag was moved to be an RTP flag + RCE_H26X_NO_DEPENDENCY_ENFORCEMENT = 1, ///< obsolete flag, the feature is disabled by default + RCE_H26X_PREPEND_SC = 1, ///< obsolete flag, the feature is enabled by default + RCE_NO_SYSTEM_CALL_CLUSTERING = 1, ///< obsolete flag, disabled by default + RCE_SRTP_INPLACE_ENCRYPTION = 1, ///< obsolete flag, the feature is enabled by default // renamed flags - RCE_H26X_DO_NOT_PREPEND_SC = 1 << 6, - RCE_FRAMERATE = 1 << 18, - RCE_FRAGMENT_PACING = 1 << 19, + RCE_H26X_DO_NOT_PREPEND_SC = 1 << 6, ///< renamed flag, use RCE_NO_H26X_PREPEND_SC instead + RCE_FRAMERATE = 1 << 18, ///< renamed flag, use RCE_FRAME_RATE instead + RCE_FRAGMENT_PACING = 1 << 19, ///< renamed flag, use RCE_PACE_FRAGMENT_SENDING instead /// \endcond // These can be used to specify what the address does for one address create session @@ -286,8 +286,8 @@ enum RTP_CTX_ENABLE_FLAGS { */ enum RTP_CTX_CONFIGURATION_FLAGS { /// \cond DO_NOT_DOCUMENT - RCC_NO_FLAGS = 0, - RCC_FPS_ENUMERATOR = 8, // wrong spelling + RCC_NO_FLAGS = 0, // This flag has no purpose + RCC_FPS_ENUMERATOR = 8, ///< renamed flag, use RCC_FPS_NUMERATOR instead /// \endcond /** How large is the receiver UDP buffer size