lavu/opt: add AV_OPT_FLAG_DEPRECATED
[ffmpeg.git] / doc / demuxers.texi
index 87f78f3..e7c2abc 100644 (file)
@@ -13,8 +13,9 @@ You can disable all the demuxers using the configure option
 the option @code{--enable-demuxer=@var{DEMUXER}}, or disable it
 with the option @code{--disable-demuxer=@var{DEMUXER}}.
 
-The option @code{-formats} of the ff* tools will display the list of
-enabled demuxers.
+The option @code{-demuxers} of the ff* tools will display the list of
+enabled demuxers. Use @code{-formats} to view a combined list of
+enabled demuxers and muxers.
 
 The description of some of the currently available demuxers follows.
 
@@ -243,55 +244,31 @@ file subdir/file-2.wav
 @end example
 @end itemize
 
-@section flv
+@section dash
 
-Adobe Flash Video Format demuxer.
-
-This demuxer is used to demux FLV files and RTMP network streams.
-
-@table @option
-@item -flv_metadata @var{bool}
-Allocate the streams according to the onMetaData array content.
-@end table
-
-@section libgme
-
-The Game Music Emu library is a collection of video game music file emulators.
-
-See @url{http://code.google.com/p/game-music-emu/} for more information.
-
-Some files have multiple tracks. The demuxer will pick the first track by
-default. The @option{track_index} option can be used to select a different
-track. Track indexes start at 0. The demuxer exports the number of tracks as
-@var{tracks} meta data entry.
+Dynamic Adaptive Streaming over HTTP demuxer.
 
-For very large files, the @option{max_size} option may have to be adjusted.
+This demuxer presents all AVStreams found in the manifest.
+By setting the discard flags on AVStreams the caller can decide
+which streams to actually receive.
+Each stream mirrors the @code{id} and @code{bandwidth} properties from the
+@code{<Representation>} as metadata keys named "id" and "variant_bitrate" respectively.
 
-@section libopenmpt
+@section flv, live_flv
 
-libopenmpt based module demuxer
+Adobe Flash Video Format demuxer.
 
-See @url{https://lib.openmpt.org/libopenmpt/} for more information.
+This demuxer is used to demux FLV files and RTMP network streams. In case of live network streams, if you force format, you may use live_flv option instead of flv to survive timestamp discontinuities.
 
-Some files have multiple subsongs (tracks) this can be set with the @option{subsong}
-option.
+@example
+ffmpeg -f flv -i myfile.flv ...
+ffmpeg -f live_flv -i rtmp://<any.server>/anything/key ....
+@end example
 
-It accepts the following options:
 
 @table @option
-@item subsong
-Set the subsong index. This can be either  'all', 'auto', or the index of the
-subsong. Subsong indexes start at 0. The default is 'auto'.
-
-The default value is to let libopenmpt choose.
-
-@item layout
-Set the channel layout. Valid values are 1, 2, and 4 channel layouts.
-The default value is STEREO.
-
-@item sample_rate
-Set the sample rate for libopenmpt to output.
-Range is from 1000 to INT_MAX. The value default is 48000.
+@item -flv_metadata @var{bool}
+Allocate the streams according to the onMetaData array content.
 @end table
 
 @section gif
@@ -333,6 +310,32 @@ used to end the output video at the length of the shortest input file,
 which in this case is @file{input.mp4} as the GIF in this example loops
 infinitely.
 
+@section hls
+
+HLS demuxer
+
+It accepts the following options:
+
+@table @option
+@item live_start_index
+segment index to start live streams at (negative values are from the end).
+
+@item allowed_extensions
+',' separated list of file extensions that hls is allowed to access.
+
+@item max_reload
+Maximum number of times a insufficient list is attempted to be reloaded.
+Default value is 1000.
+
+@item http_persistent
+Use persistent HTTP connections. Applicable only for HTTP streams.
+Enabled by default.
+
+@item http_multiple
+Use multiple HTTP connections for downloading HTTP segments.
+Enabled by default for HTTP/1.1 servers.
+@end table
+
 @section image2
 
 Image file demuxer.
@@ -468,6 +471,46 @@ ffmpeg -framerate 10 -pattern_type glob -i "*.png" out.mkv
 @end example
 @end itemize
 
+@section libgme
+
+The Game Music Emu library is a collection of video game music file emulators.
+
+See @url{http://code.google.com/p/game-music-emu/} for more information.
+
+Some files have multiple tracks. The demuxer will pick the first track by
+default. The @option{track_index} option can be used to select a different
+track. Track indexes start at 0. The demuxer exports the number of tracks as
+@var{tracks} meta data entry.
+
+For very large files, the @option{max_size} option may have to be adjusted.
+
+@section libopenmpt
+
+libopenmpt based module demuxer
+
+See @url{https://lib.openmpt.org/libopenmpt/} for more information.
+
+Some files have multiple subsongs (tracks) this can be set with the @option{subsong}
+option.
+
+It accepts the following options:
+
+@table @option
+@item subsong
+Set the subsong index. This can be either  'all', 'auto', or the index of the
+subsong. Subsong indexes start at 0. The default is 'auto'.
+
+The default value is to let libopenmpt choose.
+
+@item layout
+Set the channel layout. Valid values are 1, 2, and 4 channel layouts.
+The default value is STEREO.
+
+@item sample_rate
+Set the sample rate for libopenmpt to output.
+Range is from 1000 to INT_MAX. The value default is 48000.
+@end table
+
 @section mov/mp4/3gp/QuickTime
 
 QuickTime / MP4 demuxer.