| Message ID | 20200331140808.8839-1-lance.lmwang@gmail.com |
|---|---|
| State | Accepted |
| Commit | 83ed11b12e10457bb2863c9c73cf7f3ee9a801a5 |
| Headers | show |
| Series | [FFmpeg-devel,v1,1/3] doc/protocols: clarify timeout and latency unit of measurement for SRT | expand |
| Context | Check | Description |
|---|---|---|
| andriy/ffmpeg-patchwork | success | Make fate finished |
ping the patchset. On Tue, Mar 31, 2020 at 10:08:06PM +0800, lance.lmwang@gmail.com wrote: > From: Limin Wang <lance.lmwang@gmail.com> > > Signed-off-by: Limin Wang <lance.lmwang@gmail.com> > --- > doc/protocols.texi | 12 ++++++------ > 1 file changed, 6 insertions(+), 6 deletions(-) > > diff --git a/doc/protocols.texi b/doc/protocols.texi > index e510019..7aa7585 100644 > --- a/doc/protocols.texi > +++ b/doc/protocols.texi > @@ -1255,7 +1255,7 @@ options. > This protocol accepts the following options. > > @table @option > -@item connect_timeout > +@item connect_timeout=@var{milliseconds} > Connection timeout; SRT cannot connect for RTT > 1500 msec > (2 handshake exchanges) with the default connect timeout of > 3 seconds. This option applies to the caller and rendezvous > @@ -1286,7 +1286,7 @@ IP Type of Service. Applies to sender only. Default value is 0xB8. > @item ipttl=@var{ttl} > IP Time To Live. Applies to sender only. Default value is 64. > > -@item latency > +@item latency=@var{microseconds} > Timestamp-based Packet Delivery Delay. > Used to absorb bursts of missed packet retransmissions. > This flag sets both @option{rcvlatency} and @option{peerlatency} > @@ -1297,7 +1297,7 @@ when side is sender and @option{rcvlatency} > when side is receiver, and the bidirectional stream > sending is not supported. > > -@item listen_timeout > +@item listen_timeout=@var{microseconds} > Set socket listen timeout. > > @item maxbw=@var{bytes/seconds} > @@ -1377,7 +1377,7 @@ use a bigger maximum frame size, though not greater than > @item pkt_size=@var{bytes} > Alias for @samp{payload_size}. > > -@item peerlatency > +@item peerlatency=@var{microseconds} > The latency value (as described in @option{rcvlatency}) that is > set by the sender side as a minimum value for the receiver. > > @@ -1389,7 +1389,7 @@ Not required on receiver (set to 0), > key size obtained from sender in HaiCrypt handshake. > Default value is 0. > > -@item rcvlatency > +@item rcvlatency=@var{microseconds} > The time that should elapse since the moment when the > packet was sent and the moment when it's delivered to > the receiver application in the receiving function. > @@ -1407,7 +1407,7 @@ Set UDP receive buffer size, expressed in bytes. > @item send_buffer_size=@var{bytes} > Set UDP send buffer size, expressed in bytes. > > -@item timeout > +@item timeout=@var{microseconds} > Set raise error timeouts for read, write and connect operations. Note that the > SRT library has internal timeouts which can be controlled separately, the > value set here is only a cap on those. > -- > 2.9.5 >
On Tue, Mar 31, 2020 at 10:08:06PM +0800, lance.lmwang@gmail.com wrote: > From: Limin Wang <lance.lmwang@gmail.com> > > Signed-off-by: Limin Wang <lance.lmwang@gmail.com> > --- > doc/protocols.texi | 12 ++++++------ > 1 file changed, 6 insertions(+), 6 deletions(-) > > diff --git a/doc/protocols.texi b/doc/protocols.texi > index e510019..7aa7585 100644 > --- a/doc/protocols.texi > +++ b/doc/protocols.texi > @@ -1255,7 +1255,7 @@ options. > This protocol accepts the following options. > > @table @option > -@item connect_timeout > +@item connect_timeout=@var{milliseconds} > Connection timeout; SRT cannot connect for RTT > 1500 msec > (2 handshake exchanges) with the default connect timeout of > 3 seconds. This option applies to the caller and rendezvous > @@ -1286,7 +1286,7 @@ IP Type of Service. Applies to sender only. Default value is 0xB8. > @item ipttl=@var{ttl} > IP Time To Live. Applies to sender only. Default value is 64. > > -@item latency > +@item latency=@var{microseconds} > Timestamp-based Packet Delivery Delay. > Used to absorb bursts of missed packet retransmissions. > This flag sets both @option{rcvlatency} and @option{peerlatency} > @@ -1297,7 +1297,7 @@ when side is sender and @option{rcvlatency} > when side is receiver, and the bidirectional stream > sending is not supported. > > -@item listen_timeout > +@item listen_timeout=@var{microseconds} > Set socket listen timeout. > > @item maxbw=@var{bytes/seconds} > @@ -1377,7 +1377,7 @@ use a bigger maximum frame size, though not greater than > @item pkt_size=@var{bytes} > Alias for @samp{payload_size}. > > -@item peerlatency > +@item peerlatency=@var{microseconds} > The latency value (as described in @option{rcvlatency}) that is > set by the sender side as a minimum value for the receiver. > > @@ -1389,7 +1389,7 @@ Not required on receiver (set to 0), > key size obtained from sender in HaiCrypt handshake. > Default value is 0. > > -@item rcvlatency > +@item rcvlatency=@var{microseconds} > The time that should elapse since the moment when the > packet was sent and the moment when it's delivered to > the receiver application in the receiving function. > @@ -1407,7 +1407,7 @@ Set UDP receive buffer size, expressed in bytes. > @item send_buffer_size=@var{bytes} > Set UDP send buffer size, expressed in bytes. > > -@item timeout > +@item timeout=@var{microseconds} > Set raise error timeouts for read, write and connect operations. Note that the > SRT library has internal timeouts which can be controlled separately, the > value set here is only a cap on those. > -- > 2.9.5 > will apply the patch set tomorrow if no comments.
lance.lmwang@gmail.com (12020-05-02):
> will apply the patch set tomorrow if no comments.
I lost track of all these patches, I thought the options were to be
changed to AV_OPT_TYPE_DURATION.
Regards,
On Sat, 2 May 2020, Nicolas George wrote: > lance.lmwang@gmail.com (12020-05-02): >> will apply the patch set tomorrow if no comments. > > I lost track of all these patches, I thought the options were to be > changed to AV_OPT_TYPE_DURATION. That would break existing command lines... Regards, Marton
On Sat, May 02, 2020 at 01:18:19PM +0200, Nicolas George wrote: > lance.lmwang@gmail.com (12020-05-02): > > will apply the patch set tomorrow if no comments. > > I lost track of all these patches, I thought the options were to be > changed to AV_OPT_TYPE_DURATION. Please see the below thread, pkv submit a patch to solve the same issue later, more discussion are there, why not change to AV_OPT_TYPE_DURATION. https://patchwork.ffmpeg.org/project/ffmpeg/patch/ecec232b-cc81-b544-db5c-56752f1b889b@obsproject.com/ > > Regards, > > -- > Nicolas George > _______________________________________________ > ffmpeg-devel mailing list > ffmpeg-devel@ffmpeg.org > https://ffmpeg.org/mailman/listinfo/ffmpeg-devel > > To unsubscribe, visit link above, or email > ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
Marton Balint (12020-05-02):
> That would break existing command lines...
Then a reasonable transition plan needs to be prepared. Not blocking for
this patch, though.
Regards,
lance.lmwang@gmail.com (12020-05-02): > Please see the below thread, pkv submit a patch to solve the same issue later, > more discussion are there, why not change to AV_OPT_TYPE_DURATION. > https://patchwork.ffmpeg.org/project/ffmpeg/patch/ecec232b-cc81-b544-db5c-56752f1b889b@obsproject.com/ It still needs to be changed, just properly: introduce a new option, warn about deprecation. It would have been simpler to catch it in the beginning :-( Regards,
On Sat, May 02, 2020 at 01:56:02PM +0200, Nicolas George wrote: > lance.lmwang@gmail.com (12020-05-02): > > Please see the below thread, pkv submit a patch to solve the same issue later, > > more discussion are there, why not change to AV_OPT_TYPE_DURATION. > > https://patchwork.ffmpeg.org/project/ffmpeg/patch/ecec232b-cc81-b544-db5c-56752f1b889b@obsproject.com/ > > It still needs to be changed, just properly: introduce a new option, > warn about deprecation. > > It would have been simpler to catch it in the beginning :-( The most important is document, I think current option is OK to use. deprecation is more confusing. > > Regards, > > -- > Nicolas George > _______________________________________________ > ffmpeg-devel mailing list > ffmpeg-devel@ffmpeg.org > https://ffmpeg.org/mailman/listinfo/ffmpeg-devel > > To unsubscribe, visit link above, or email > ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
lance.lmwang@gmail.com (12020-05-02): > The most important is document, I think current option is OK to use. > deprecation is more confusing. An option with the wrong type is confusing too. But deprecation is temporary. Regards,
diff --git a/doc/protocols.texi b/doc/protocols.texi index e510019..7aa7585 100644 --- a/doc/protocols.texi +++ b/doc/protocols.texi @@ -1255,7 +1255,7 @@ options. This protocol accepts the following options. @table @option -@item connect_timeout +@item connect_timeout=@var{milliseconds} Connection timeout; SRT cannot connect for RTT > 1500 msec (2 handshake exchanges) with the default connect timeout of 3 seconds. This option applies to the caller and rendezvous @@ -1286,7 +1286,7 @@ IP Type of Service. Applies to sender only. Default value is 0xB8. @item ipttl=@var{ttl} IP Time To Live. Applies to sender only. Default value is 64. -@item latency +@item latency=@var{microseconds} Timestamp-based Packet Delivery Delay. Used to absorb bursts of missed packet retransmissions. This flag sets both @option{rcvlatency} and @option{peerlatency} @@ -1297,7 +1297,7 @@ when side is sender and @option{rcvlatency} when side is receiver, and the bidirectional stream sending is not supported. -@item listen_timeout +@item listen_timeout=@var{microseconds} Set socket listen timeout. @item maxbw=@var{bytes/seconds} @@ -1377,7 +1377,7 @@ use a bigger maximum frame size, though not greater than @item pkt_size=@var{bytes} Alias for @samp{payload_size}. -@item peerlatency +@item peerlatency=@var{microseconds} The latency value (as described in @option{rcvlatency}) that is set by the sender side as a minimum value for the receiver. @@ -1389,7 +1389,7 @@ Not required on receiver (set to 0), key size obtained from sender in HaiCrypt handshake. Default value is 0. -@item rcvlatency +@item rcvlatency=@var{microseconds} The time that should elapse since the moment when the packet was sent and the moment when it's delivered to the receiver application in the receiving function. @@ -1407,7 +1407,7 @@ Set UDP receive buffer size, expressed in bytes. @item send_buffer_size=@var{bytes} Set UDP send buffer size, expressed in bytes. -@item timeout +@item timeout=@var{microseconds} Set raise error timeouts for read, write and connect operations. Note that the SRT library has internal timeouts which can be controlled separately, the value set here is only a cap on those.