generic-library/ffmpeg
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

doc/protocols/udp,lavf/udp: apply minor documentation fixes

Browse Source
This commit is contained in:
Stefano Sabatini 2013-12-24 14:38:48 +01:00
parent ca0d8e839e
commit b80cf46090
2 changed files with 26 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/protocols.texi
View File

@ -979,7 +979,7 @@ ffplay tls://@var{hostname}:@var{port}
User Datagram Protocol. User Datagram Protocol.
The required syntax for a UDP url is: The required syntax for an UDP URL is:
@example @example
udp://@var{hostname}:@var{port}[?@var{options}] udp://@var{hostname}:@var{port}[?@var{options}]
@end example @end example
@ -994,7 +994,6 @@ UDP socket buffer overruns. The @var{fifo_size} and
The list of supported options follows. The list of supported options follows.
@table @option @table @option
@item buffer_size=@var{size} @item buffer_size=@var{size}
Set the UDP socket buffer size in bytes. This is used both for the Set the UDP socket buffer size in bytes. This is used both for the
receiving and the sending buffer size. receiving and the sending buffer size.
@ -1044,25 +1043,34 @@ Survive in case of UDP receiving circular buffer overrun. Default
value is 0. value is 0.
@item timeout=@var{microseconds} @item timeout=@var{microseconds}
In read mode: if no data arrived in more than this time interval, raise error. Set raise error timeout, expressed in microseconds.
This option is only relevant in read mode: if no data arrived in more
than this time interval, raise error.
@end table @end table
Some usage examples of the UDP protocol with @command{ffmpeg} follow. @section Examples
To stream over UDP to a remote endpoint: @itemize
@item
Use @command{ffmpeg} to stream over UDP to a remote endpoint:
@example @example
ffmpeg -i @var{input} -f @var{format} udp://@var{hostname}:@var{port} ffmpeg -i @var{input} -f @var{format} udp://@var{hostname}:@var{port}
@end example @end example
To stream in mpegts format over UDP using 188 sized UDP packets, using a large input buffer: @item
Use @command{ffmpeg} to stream in mpegts format over UDP using 188
sized UDP packets, using a large input buffer:
@example @example
ffmpeg -i @var{input} -f mpegts udp://@var{hostname}:@var{port}?pkt_size=188&buffer_size=65535 ffmpeg -i @var{input} -f mpegts udp://@var{hostname}:@var{port}?pkt_size=188&buffer_size=65535
@end example @end example
To receive over UDP from a remote endpoint: @item
Use @command{ffmpeg} to receive over UDP from a remote endpoint:
@example @example
ffmpeg -i udp://[@var{multicast-address}]:@var{port} ffmpeg -i udp://[@var{multicast-address}]:@var{port} ...
@end example @end example
@end itemize
@section unix @section unix

20
libavformat/udp.c
View File

@ -91,17 +91,17 @@ typedef struct {
#define D AV_OPT_FLAG_DECODING_PARAM #define D AV_OPT_FLAG_DECODING_PARAM
#define E AV_OPT_FLAG_ENCODING_PARAM #define E AV_OPT_FLAG_ENCODING_PARAM
static const AVOption options[] = { static const AVOption options[] = {
{"buffer_size", "Socket buffer size in bytes", OFFSET(buffer_size), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, D|E }, {"buffer_size", "set packet buffer size in bytes", OFFSET(buffer_size), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, D|E },
{"localport", "Set local port to bind to", OFFSET(local_port), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, D|E }, {"localport", "set local port to bind to", OFFSET(local_port), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, D|E },
{"localaddr", "Choose local IP address", OFFSET(local_addr), AV_OPT_TYPE_STRING, {.str = ""}, 0, 0, D|E }, {"localaddr", "choose local IP address", OFFSET(local_addr), AV_OPT_TYPE_STRING, {.str = ""}, 0, 0, D|E },
{"pkt_size", "Set size of UDP packets", OFFSET(packet_size), AV_OPT_TYPE_INT, {.i64 = 1472}, 0, INT_MAX, D|E }, {"pkt_size", "set size of UDP packets", OFFSET(packet_size), AV_OPT_TYPE_INT, {.i64 = 1472}, 0, INT_MAX, D|E },
{"reuse", "Explicitly allow or disallow reusing UDP sockets", OFFSET(reuse_socket), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, D|E }, {"reuse", "explicitly allow or disallow reusing UDP sockets", OFFSET(reuse_socket), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, D|E },
{"ttl", "Set the time to live value (for multicast only)", OFFSET(ttl), AV_OPT_TYPE_INT, {.i64 = 16}, 0, INT_MAX, E }, {"ttl", "set the time to live value (for multicast only)", OFFSET(ttl), AV_OPT_TYPE_INT, {.i64 = 16}, 0, INT_MAX, E },
{"connect", "Should connect() be called on socket", OFFSET(is_connected), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, D|E }, {"connect", "set if connect() should be called on socket", OFFSET(is_connected), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, D|E },
/* TODO 'sources', 'block' option */ /* TODO 'sources', 'block' option */
{"fifo_size", "Set the UDP receiving circular buffer size, expressed as a number of packets with size of 188 bytes", OFFSET(circular_buffer_size), AV_OPT_TYPE_INT, {.i64 = 7*4096}, 0, INT_MAX, D }, {"fifo_size", "set the UDP receiving circular buffer size, expressed as a number of packets with size of 188 bytes", OFFSET(circular_buffer_size), AV_OPT_TYPE_INT, {.i64 = 7*4096}, 0, INT_MAX, D },
{"overrun_nonfatal", "Survive in case of UDP receiving circular buffer overrun", OFFSET(overrun_nonfatal), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, D }, {"overrun_nonfatal", "survive in case of UDP receiving circular buffer overrun", OFFSET(overrun_nonfatal), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, D },
{"timeout", "In read mode: if no data arrived in more than this time interval, raise error", OFFSET(timeout), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, D }, {"timeout", "set raise error timeout (only in read mode)", OFFSET(timeout), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, D },
{NULL} {NULL}
}; };