[FFmpeg-cvslog] doc/protocols: add description for the RTP protocol

[burek]

ffmpeg | branch: master | burek <burek021 at gmail.com> | Thu Oct 24 11:37:57 2013 +0200| [229042a52d5d718373b8a4a1905ea686d5b492e6] | committer: Stefano Sabatini

doc/protocols: add description for the RTP protocol

With some edits by Stefano.

Signed-off-by: Stefano Sabatini <stefasab at gmail.com>

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=229042a52d5d718373b8a4a1905ea686d5b492e6
---

 doc/protocols.texi |   60 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)

diff --git a/doc/protocols.texi b/doc/protocols.texi
index 5022cbe..31513f3 100644
--- a/doc/protocols.texi
+++ b/doc/protocols.texi
@@ -596,6 +596,66 @@ ffplay "rtmp://myserver/live/mystream live=1"
 
 Real-Time Protocol.
 
+The required syntax for an RTP URL is:
+rtp://@var{hostname}[:@var{port}][?@var{option}=@var{val}...]
+
+ at var{port} specifies the RTP port to use.
+
+The following URL options are supported:
+
+ at table @option
+
+ at item ttl=@var{n}
+Set the TTL (Time-To-Leave) value (for multicast only).
+
+ at item rtcpport=@var{n}
+Set the remote RTCP port to @var{n}.
+
+ at item localrtpport=@var{n}
+Set the local RTP port to @var{n}.
+
+ at item localrtcpport=@var{n}'
+Set the local RTCP port to @var{n}.
+
+ at item pkt_size=@var{n}
+Set max packet size (in bytes) to @var{n}.
+
+ at item connect=0|1
+Do a @code{connect()} on the UDP socket (if set to 1) or not (if set
+to 0).
+
+ at item sources=@var{ip}[, at var{ip}]
+List allowed source IP addresses.
+
+ at item block=@var{ip}[, at var{ip}]
+List disallowed (blocked) source IP addresses.
+
+ at item write_to_source=0|1
+Send packets to the source address of the latest received packet (if
+set to 1) or to a default remote address (if set to 0).
+
+ at item localport=@var{n} (DEPRECATED)
+Set the local port to @var{n}.
+
+ at end table
+
+Important notes:
+
+ at enumerate
+
+ at item
+if @option{rtcpport} is not set the RTCP port will be set to the RTP
+port value plus 1.
+
+ at item
+If @option{localport} (the local RTP port) is not set any available
+port will be used for the local RTP and RTCP ports.
+
+ at item
+If @option{localrtcpport} (the local RTCP port) is not set it will be
+set to the the local RTP port value plus 1.
+ at end enumerate
+
 @section rtsp
 
 RTSP is not technically a protocol handler in libavformat, it is a demuxer