Replace defines in libavformat/mpegtsenc.c with AVOptions
[libav.git] / doc / muxers.texi
1 @chapter Muxers
2 @c man begin MUXERS
4 Muxers are configured elements in FFmpeg which allow writing
5 multimedia streams to a particular type of file.
7 When you configure your FFmpeg build, all the supported muxers
8 are enabled by default. You can list all available muxers using the
9 configure option @code{--list-muxers}.
11 You can disable all the muxers with the configure option
12 @code{--disable-muxers} and selectively enable / disable single muxers
13 with the options @code{--enable-muxer=@var{MUXER}} /
14 @code{--disable-muxer=@var{MUXER}}.
16 The option @code{-formats} of the ff* tools will display the list of
17 enabled muxers.
19 A description of some of the currently available muxers follows.
21 @section image2
23 Image file muxer.
25 This muxer writes video frames to multiple image files specified by a
26 pattern.
28 The pattern may contain the string "%d" or "%0@var{N}d", which
29 specifies the position of the characters representing a numbering in
30 the filenames. If the form "%d0@var{N}d" is used, the string
31 representing the number in each filename is 0-padded to @var{N}
32 digits. The literal character '%' can be specified in the pattern with
33 the string "%%".
35 If the pattern contains "%d" or "%0@var{N}d", the first filename of
36 the file list specified will contain the number 1, all the following
37 numbers will be sequential.
39 The pattern may contain a suffix which is used to automatically
40 determine the format of the image files to write.
42 For example the pattern "img-%03d.bmp" will specify a sequence of
43 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
44 @file{img-010.bmp}, etc.
45 The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
46 form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
47 etc.
49 The following example shows how to use @file{ffmpeg} for creating a
50 sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
51 taking one image every second from the input video:
52 @example
53 ffmpeg -i in.avi -r 1 -f image2 'img-%03d.jpeg'
54 @end example
56 Note that with @file{ffmpeg}, if the format is not specified with the
57 @code{-f} option and the output filename specifies an image file
58 format, the image2 muxer is automatically selected, so the previous
59 command can be written as:
60 @example
61 ffmpeg -i in.avi -r 1 'img-%03d.jpeg'
62 @end example
64 Note also that the pattern must not necessarily contain "%d" or
65 "%0@var{N}d", for example to create a single image file
66 @file{img.jpeg} from the input video you can employ the command:
67 @example
68 ffmpeg -i in.avi -f image2 -vframes 1 img.jpeg
69 @end example
71 @section mpegts
73 MPEG transport stream muxer.
75 This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
77 The muxer options are:
79 @table @option
80 @item -mpegts_original_network_id @var{number}
81 Set the original_network_id (default 0x0001). This is unique identifier
82 of a network in DVB. Its main use is in the unique identification of a
83 service through the path Original_Network_ID, Transport_Stream_ID.
84 @item -mpegts_transport_stream_id @var{number}
85 Set the transport_stream_id (default 0x0001). This identifies a
86 transponder in DVB.
87 @item -mpegts_service_id @var{number}
88 Set the service_id (default 0x0001) also known as program in DVB.
89 @item -mpegts_pmt_start_pid @var{number}
90 Set the first PID for PMT (default 0x1000, max 0x1f00).
91 @item -mpegts_start_pid @var{number}
92 Set the first PID for data packets (default 0x0100, max 0x0f00).
93 @end table
95 The recognized metadata settings in mpegts muxer are @code{service_provider}
96 and @code{service_name}. If they are not set the default for
97 @code{service_provider} is "FFmpeg" and the default for
98 @code{service_name} is "Service01".
100 @example
101 ffmpeg -i file.mpg -acodec copy -vcodec copy \
102 -mpegts_original_network_id 0x1122 \
103 -mpegts_transport_stream_id 0x3344 \
104 -mpegts_service_id 0x5566 \
105 -mpegts_pmt_start_pid 0x1500 \
106 -mpegts_start_pid 0x150 \
107 -metadata service_provider="Some provider" \
108 -metadata service_name="Some Channel" \
109 -y out.ts
110 @end example
112 @c man end MUXERS