Browse code

doc/muxers: cleanup mpegts section

Add missing options.
List correct variable types.
Re-order options and markup flag options properly.
Add more texinfo markup.

Signed-off-by: Lou Logan <lou@lrcd.com>

Lou Logan authored on 2017/03/16 12:51:01
Showing 1 changed files
... ...
@@ -1091,69 +1091,35 @@ This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
1091 1091
 
1092 1092
 The recognized metadata settings in mpegts muxer are @code{service_provider}
1093 1093
 and @code{service_name}. If they are not set the default for
1094
-@code{service_provider} is "FFmpeg" and the default for
1095
-@code{service_name} is "Service01".
1094
+@code{service_provider} is @samp{FFmpeg} and the default for
1095
+@code{service_name} is @samp{Service01}.
1096 1096
 
1097 1097
 @subsection Options
1098 1098
 
1099 1099
 The muxer options are:
1100 1100
 
1101 1101
 @table @option
1102
-@item mpegts_original_network_id @var{number}
1103
-Set the original_network_id (default 0x0001). This is unique identifier
1104
-of a network in DVB. Its main use is in the unique identification of a
1105
-service through the path Original_Network_ID, Transport_Stream_ID.
1106
-@item mpegts_transport_stream_id @var{number}
1107
-Set the transport_stream_id (default 0x0001). This identifies a
1108
-transponder in DVB.
1109
-@item mpegts_service_id @var{number}
1110
-Set the service_id (default 0x0001) also known as program in DVB.
1111
-@item mpegts_service_type @var{number}
1112
-Set the program service_type (default @var{digital_tv}), see below
1113
-a list of pre defined values.
1114
-@item mpegts_pmt_start_pid @var{number}
1115
-Set the first PID for PMT (default 0x1000, max 0x1f00).
1116
-@item mpegts_start_pid @var{number}
1117
-Set the first PID for data packets (default 0x0100, max 0x0f00).
1118
-@item mpegts_m2ts_mode @var{number}
1119
-Enable m2ts mode if set to 1. Default value is -1 which disables m2ts mode.
1120
-@item muxrate @var{number}
1121
-Set a constant muxrate (default VBR).
1122
-@item pcr_period @var{numer}
1123
-Override the default PCR retransmission time (default 20ms), ignored
1124
-if variable muxrate is selected.
1125
-@item pat_period @var{number}
1126
-Maximal time in seconds between PAT/PMT tables.
1127
-@item sdt_period @var{number}
1128
-Maximal time in seconds between SDT tables.
1129
-@item pes_payload_size @var{number}
1130
-Set minimum PES packet payload in bytes.
1131
-@item mpegts_flags @var{flags}
1132
-Set flags (see below).
1133
-@item mpegts_copyts @var{number}
1134
-Preserve original timestamps, if value is set to 1. Default value is -1, which
1135
-results in shifting timestamps so that they start from 0.
1136
-@item tables_version @var{number}
1137
-Set PAT, PMT and SDT version (default 0, valid values are from 0 to 31, inclusively).
1138
-This option allows updating stream structure so that standard consumer may
1139
-detect the change. To do so, reopen output AVFormatContext (in case of API
1140
-usage) or restart ffmpeg instance, cyclically changing tables_version value:
1141
-@example
1142
-ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
1143
-ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
1144
-...
1145
-ffmpeg -i source3.ts -codec copy -f mpegts -tables_version 31 udp://1.1.1.1:1111
1146
-ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
1147
-ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
1148
-...
1149
-@end example
1150
-@end table
1151
-
1152
-Option @option{mpegts_service_type} accepts the following values:
1153
-
1154
-@table @option
1102
+@item mpegts_transport_stream_id @var{integer}
1103
+Set the @samp{transport_stream_id}. This identifies a transponder in DVB.
1104
+Default is @code{0x0001}.
1105
+
1106
+@item mpegts_original_network_id @var{integer}
1107
+Set the @samp{original_network_id}. This is unique identifier of a
1108
+network in DVB. Its main use is in the unique identification of a service
1109
+through the path @samp{Original_Network_ID, Transport_Stream_ID}. Default
1110
+is @code{0x0001}.
1111
+
1112
+@item mpegts_service_id @var{integer}
1113
+Set the @samp{service_id}, also known as program in DVB. Default is
1114
+@code{0x0001}.
1115
+
1116
+@item mpegts_service_type @var{integer}
1117
+Set the program @samp{service_type}. Default is @code{digital_tv}.
1118
+Accepts the following options:
1119
+@table @samp
1155 1120
 @item hex_value
1156
-Any hexdecimal value between 0x01 to 0xff as defined in ETSI 300 468.
1121
+Any hexdecimal value between @code{0x01} to @code{0xff} as defined in
1122
+ETSI 300 468.
1157 1123
 @item digital_tv
1158 1124
 Digital TV service.
1159 1125
 @item digital_radio
... ...
@@ -1170,9 +1136,26 @@ Advanced Codec Digital SDTV service.
1170 1170
 Advanced Codec Digital HDTV service.
1171 1171
 @end table
1172 1172
 
1173
-Option @option{mpegts_flags} may take a set of such flags:
1173
+@item mpegts_pmt_start_pid @var{integer}
1174
+Set the first PID for PMT. Default is @code{0x1000}. Max is @code{0x1f00}.
1174 1175
 
1175
-@table @option
1176
+@item mpegts_start_pid @var{integer}
1177
+Set the first PID for data packets. Default is @code{0x0100}. Max is
1178
+@code{0x0f00}.
1179
+
1180
+@item mpegts_m2ts_mode @var{boolean}
1181
+Enable m2ts mode if set to @code{1}. Default value is @code{-1} which
1182
+disables m2ts mode.
1183
+
1184
+@item muxrate @var{integer}
1185
+Set a constant muxrate. Default is VBR.
1186
+
1187
+@item pes_payload_size @var{integer}
1188
+Set minimum PES packet payload in bytes. Default is @code{2930}.
1189
+
1190
+@item mpegts_flags @var{flags}
1191
+Set mpegts flags. Accepts the following options:
1192
+@table @samp
1176 1193
 @item resend_headers
1177 1194
 Reemit PAT/PMT before writing the next packet.
1178 1195
 @item latm
... ...
@@ -1185,6 +1168,45 @@ Conform to System B (DVB) instead of System A (ATSC).
1185 1185
 Mark the initial packet of each stream as discontinuity.
1186 1186
 @end table
1187 1187
 
1188
+@item resend_headers @var{integer}
1189
+Reemit PAT/PMT before writing the next packet. This option is deprecated:
1190
+use @option{mpegts_flags} instead.
1191
+
1192
+@item mpegts_copyts @var{boolean}
1193
+Preserve original timestamps, if value is set to @code{1}. Default value
1194
+is @code{-1}, which results in shifting timestamps so that they start from 0.
1195
+
1196
+@item omit_video_pes_length @var{boolean}
1197
+Omit the PES packet length for video packets. Default is @code{1} (true).
1198
+
1199
+@item pcr_period @var{integer}
1200
+Override the default PCR retransmission time in milliseconds. Ignored if
1201
+variable muxrate is selected. Default is @code{20}.
1202
+
1203
+@item pat_period @var{double}
1204
+Maximum time in seconds between PAT/PMT tables.
1205
+
1206
+@item sdt_period @var{double}
1207
+Maximum time in seconds between SDT tables.
1208
+
1209
+@item tables_version @var{integer}
1210
+Set PAT, PMT and SDT version (default @code{0}, valid values are from 0 to 31, inclusively).
1211
+This option allows updating stream structure so that standard consumer may
1212
+detect the change. To do so, reopen output @code{AVFormatContext} (in case of API
1213
+usage) or restart @command{ffmpeg} instance, cyclically changing
1214
+@option{tables_version} value:
1215
+
1216
+@example
1217
+ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
1218
+ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
1219
+...
1220
+ffmpeg -i source3.ts -codec copy -f mpegts -tables_version 31 udp://1.1.1.1:1111
1221
+ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
1222
+ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
1223
+...
1224
+@end example
1225
+@end table
1226
+
1188 1227
 @subsection Example
1189 1228
 
1190 1229
 @example
... ...
@@ -1196,7 +1218,7 @@ ffmpeg -i file.mpg -c copy \
1196 1196
      -mpegts_start_pid 0x150 \
1197 1197
      -metadata service_provider="Some provider" \
1198 1198
      -metadata service_name="Some Channel" \
1199
-     -y out.ts
1199
+     out.ts
1200 1200
 @end example
1201 1201
 
1202 1202
 @section mxf, mxf_d10