dvbsub: cosmetics: Group all debug code together
[libav.git] / avconv.h
1 /*
2 * This file is part of Libav.
3 *
4 * Libav is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * Libav is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with Libav; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17 */
18
19 #ifndef AVCONV_H
20 #define AVCONV_H
21
22 #include "config.h"
23
24 #include <stdint.h>
25 #include <stdio.h>
26
27 #if HAVE_PTHREADS
28 #include <pthread.h>
29 #endif
30
31 #include "cmdutils.h"
32
33 #include "libavformat/avformat.h"
34 #include "libavformat/avio.h"
35
36 #include "libavcodec/avcodec.h"
37
38 #include "libavfilter/avfilter.h"
39
40 #include "libavutil/avutil.h"
41 #include "libavutil/dict.h"
42 #include "libavutil/fifo.h"
43 #include "libavutil/pixfmt.h"
44 #include "libavutil/rational.h"
45
46 #define VSYNC_AUTO -1
47 #define VSYNC_PASSTHROUGH 0
48 #define VSYNC_CFR 1
49 #define VSYNC_VFR 2
50
51 enum HWAccelID {
52 HWACCEL_NONE = 0,
53 HWACCEL_AUTO,
54 HWACCEL_VDPAU,
55 HWACCEL_DXVA2,
56 HWACCEL_VDA,
57 HWACCEL_QSV,
58 HWACCEL_VAAPI,
59 };
60
61 typedef struct HWAccel {
62 const char *name;
63 int (*init)(AVCodecContext *s);
64 enum HWAccelID id;
65 enum AVPixelFormat pix_fmt;
66 } HWAccel;
67
68 /* select an input stream for an output stream */
69 typedef struct StreamMap {
70 int disabled; /* 1 is this mapping is disabled by a negative map */
71 int file_index;
72 int stream_index;
73 int sync_file_index;
74 int sync_stream_index;
75 char *linklabel; /* name of an output link, for mapping lavfi outputs */
76 } StreamMap;
77
78 /* select an input file for an output file */
79 typedef struct MetadataMap {
80 int file; // file index
81 char type; // type of metadata to copy -- (g)lobal, (s)tream, (c)hapter or (p)rogram
82 int index; // stream/chapter/program number
83 } MetadataMap;
84
85 typedef struct OptionsContext {
86 OptionGroup *g;
87
88 /* input/output options */
89 int64_t start_time;
90 const char *format;
91
92 SpecifierOpt *codec_names;
93 int nb_codec_names;
94 SpecifierOpt *audio_channels;
95 int nb_audio_channels;
96 SpecifierOpt *audio_sample_rate;
97 int nb_audio_sample_rate;
98 SpecifierOpt *frame_rates;
99 int nb_frame_rates;
100 SpecifierOpt *frame_sizes;
101 int nb_frame_sizes;
102 SpecifierOpt *frame_pix_fmts;
103 int nb_frame_pix_fmts;
104
105 /* input options */
106 int64_t input_ts_offset;
107 int loop;
108 int rate_emu;
109 int accurate_seek;
110
111 SpecifierOpt *ts_scale;
112 int nb_ts_scale;
113 SpecifierOpt *dump_attachment;
114 int nb_dump_attachment;
115 SpecifierOpt *hwaccels;
116 int nb_hwaccels;
117 SpecifierOpt *hwaccel_devices;
118 int nb_hwaccel_devices;
119 SpecifierOpt *hwaccel_output_formats;
120 int nb_hwaccel_output_formats;
121 SpecifierOpt *autorotate;
122 int nb_autorotate;
123
124 /* output options */
125 StreamMap *stream_maps;
126 int nb_stream_maps;
127 /* first item specifies output metadata, second is input */
128 MetadataMap (*meta_data_maps)[2];
129 int nb_meta_data_maps;
130 int metadata_global_manual;
131 int metadata_streams_manual;
132 int metadata_chapters_manual;
133 const char **attachments;
134 int nb_attachments;
135
136 int chapters_input_file;
137
138 int64_t recording_time;
139 uint64_t limit_filesize;
140 float mux_preload;
141 float mux_max_delay;
142 int shortest;
143
144 int video_disable;
145 int audio_disable;
146 int subtitle_disable;
147 int data_disable;
148
149 /* indexed by output file stream index */
150 int *streamid_map;
151 int nb_streamid_map;
152
153 SpecifierOpt *metadata;
154 int nb_metadata;
155 SpecifierOpt *max_frames;
156 int nb_max_frames;
157 SpecifierOpt *bitstream_filters;
158 int nb_bitstream_filters;
159 SpecifierOpt *codec_tags;
160 int nb_codec_tags;
161 SpecifierOpt *sample_fmts;
162 int nb_sample_fmts;
163 SpecifierOpt *qscale;
164 int nb_qscale;
165 SpecifierOpt *forced_key_frames;
166 int nb_forced_key_frames;
167 SpecifierOpt *force_fps;
168 int nb_force_fps;
169 SpecifierOpt *frame_aspect_ratios;
170 int nb_frame_aspect_ratios;
171 SpecifierOpt *rc_overrides;
172 int nb_rc_overrides;
173 SpecifierOpt *intra_matrices;
174 int nb_intra_matrices;
175 SpecifierOpt *inter_matrices;
176 int nb_inter_matrices;
177 SpecifierOpt *top_field_first;
178 int nb_top_field_first;
179 SpecifierOpt *metadata_map;
180 int nb_metadata_map;
181 SpecifierOpt *presets;
182 int nb_presets;
183 SpecifierOpt *copy_initial_nonkeyframes;
184 int nb_copy_initial_nonkeyframes;
185 SpecifierOpt *filters;
186 int nb_filters;
187 SpecifierOpt *filter_scripts;
188 int nb_filter_scripts;
189 SpecifierOpt *pass;
190 int nb_pass;
191 SpecifierOpt *passlogfiles;
192 int nb_passlogfiles;
193 SpecifierOpt *max_muxing_queue_size;
194 int nb_max_muxing_queue_size;
195 } OptionsContext;
196
197 typedef struct InputFilter {
198 AVFilterContext *filter;
199 struct InputStream *ist;
200 struct FilterGraph *graph;
201 uint8_t *name;
202
203 AVFifoBuffer *frame_queue;
204
205 // parameters configured for this input
206 int format;
207
208 int width, height;
209 AVRational sample_aspect_ratio;
210
211 int sample_rate;
212 uint64_t channel_layout;
213
214 AVBufferRef *hw_frames_ctx;
215
216 int eof;
217 } InputFilter;
218
219 typedef struct OutputFilter {
220 AVFilterContext *filter;
221 struct OutputStream *ost;
222 struct FilterGraph *graph;
223 uint8_t *name;
224
225 /* temporary storage until stream maps are processed */
226 AVFilterInOut *out_tmp;
227 enum AVMediaType type;
228
229 /* desired output stream properties */
230 int width, height;
231 AVRational frame_rate;
232 int format;
233 int sample_rate;
234 uint64_t channel_layout;
235
236 // those are only set if no format is specified and the encoder gives us multiple options
237 int *formats;
238 uint64_t *channel_layouts;
239 int *sample_rates;
240 } OutputFilter;
241
242 typedef struct FilterGraph {
243 int index;
244 const char *graph_desc;
245
246 AVFilterGraph *graph;
247
248 InputFilter **inputs;
249 int nb_inputs;
250 OutputFilter **outputs;
251 int nb_outputs;
252 } FilterGraph;
253
254 typedef struct InputStream {
255 int file_index;
256 AVStream *st;
257 int discard; /* true if stream data should be discarded */
258 int decoding_needed; /* true if the packets must be decoded in 'raw_fifo' */
259 AVCodecContext *dec_ctx;
260 AVCodec *dec;
261 AVFrame *decoded_frame;
262 AVFrame *filter_frame; /* a ref of decoded_frame, to be sent to filters */
263
264 int64_t start; /* time when read started */
265 /* predicted dts of the next packet read for this stream or (when there are
266 * several frames in a packet) of the next frame in current packet */
267 int64_t next_dts;
268 /* dts of the last packet read for this stream */
269 int64_t last_dts;
270 int64_t min_pts; /* pts with the smallest value in a current stream */
271 int64_t max_pts; /* pts with the higher value in a current stream */
272
273 // when forcing constant input framerate through -r,
274 // this contains the pts that will be given to the next decoded frame
275 int64_t cfr_next_pts;
276
277 int64_t nb_samples; /* number of samples in the last decoded audio frame before looping */
278 PtsCorrectionContext pts_ctx;
279 double ts_scale;
280 AVDictionary *decoder_opts;
281 AVRational framerate; /* framerate forced with -r */
282
283 int autorotate;
284
285 /* decoded data from this stream goes into all those filters
286 * currently video and audio only */
287 InputFilter **filters;
288 int nb_filters;
289
290 /* hwaccel options */
291 enum HWAccelID hwaccel_id;
292 char *hwaccel_device;
293 enum AVPixelFormat hwaccel_output_format;
294
295 /* hwaccel context */
296 enum HWAccelID active_hwaccel_id;
297 void *hwaccel_ctx;
298 void (*hwaccel_uninit)(AVCodecContext *s);
299 int (*hwaccel_get_buffer)(AVCodecContext *s, AVFrame *frame, int flags);
300 int (*hwaccel_retrieve_data)(AVCodecContext *s, AVFrame *frame);
301 enum AVPixelFormat hwaccel_pix_fmt;
302 enum AVPixelFormat hwaccel_retrieved_pix_fmt;
303 AVBufferRef *hw_frames_ctx;
304
305 /* stats */
306 // combined size of all the packets read
307 uint64_t data_size;
308 /* number of packets successfully read for this stream */
309 uint64_t nb_packets;
310 // number of frames/samples retrieved from the decoder
311 uint64_t frames_decoded;
312 uint64_t samples_decoded;
313 } InputStream;
314
315 typedef struct InputFile {
316 AVFormatContext *ctx;
317 int eof_reached; /* true if eof reached */
318 int eagain; /* true if last read attempt returned EAGAIN */
319 int ist_index; /* index of first stream in ist_table */
320 int loop; /* set number of times input stream should be looped */
321 int64_t duration; /* actual duration of the longest stream in a file
322 at the moment when looping happens */
323 AVRational time_base; /* time base of the duration */
324 int64_t ts_offset;
325 int64_t start_time; /* user-specified start time in AV_TIME_BASE or AV_NOPTS_VALUE */
326 int64_t recording_time;
327 int nb_streams; /* number of stream that avconv is aware of; may be different
328 from ctx.nb_streams if new streams appear during av_read_frame() */
329 int rate_emu;
330 int accurate_seek;
331
332 #if HAVE_PTHREADS
333 pthread_t thread; /* thread reading from this file */
334 int finished; /* the thread has exited */
335 int joined; /* the thread has been joined */
336 pthread_mutex_t fifo_lock; /* lock for access to fifo */
337 pthread_cond_t fifo_cond; /* the main thread will signal on this cond after reading from fifo */
338 AVFifoBuffer *fifo; /* demuxed packets are stored here; freed by the main thread */
339 #endif
340 } InputFile;
341
342 typedef struct OutputStream {
343 int file_index; /* file index */
344 int index; /* stream index in the output file */
345 int source_index; /* InputStream index */
346 AVStream *st; /* stream in the output file */
347 int encoding_needed; /* true if encoding needed for this stream */
348 int frame_number;
349 /* input pts and corresponding output pts
350 for A/V sync */
351 // double sync_ipts; /* dts from the AVPacket of the demuxer in second units */
352 struct InputStream *sync_ist; /* input stream to sync against */
353 int64_t sync_opts; /* output frame counter, could be changed to some true timestamp */ // FIXME look at frame_number
354 /* pts of the first frame encoded for this stream, used for limiting
355 * recording time */
356 int64_t first_pts;
357 /* dts of the last packet sent to the muxer */
358 int64_t last_mux_dts;
359 // the timebase of the packets sent to the muxer
360 AVRational mux_timebase;
361
362 int nb_bitstream_filters;
363 AVBSFContext **bsf_ctx;
364
365 AVCodecContext *enc_ctx;
366 AVCodec *enc;
367 int64_t max_frames;
368 AVFrame *filtered_frame;
369
370 void *hwaccel_ctx;
371
372 /* video only */
373 AVRational frame_rate;
374 int force_fps;
375 int top_field_first;
376
377 float frame_aspect_ratio;
378
379 /* forced key frames */
380 int64_t *forced_kf_pts;
381 int forced_kf_count;
382 int forced_kf_index;
383 char *forced_keyframes;
384
385 char *logfile_prefix;
386 FILE *logfile;
387
388 OutputFilter *filter;
389 char *avfilter;
390
391 int64_t sws_flags;
392 AVDictionary *encoder_opts;
393 AVDictionary *resample_opts;
394 int finished; /* no more packets should be written for this stream */
395 int stream_copy;
396
397 // init_output_stream() has been called for this stream
398 // The encoder and the bistream filters have been initialized and the stream
399 // parameters are set in the AVStream.
400 int initialized;
401
402 const char *attachment_filename;
403 int copy_initial_nonkeyframes;
404
405 enum AVPixelFormat pix_fmts[2];
406
407 AVCodecParserContext *parser;
408 AVCodecContext *parser_avctx;
409
410 /* stats */
411 // combined size of all the packets written
412 uint64_t data_size;
413 // number of packets send to the muxer
414 uint64_t packets_written;
415 // number of frames/samples sent to the encoder
416 uint64_t frames_encoded;
417 uint64_t samples_encoded;
418
419 /* packet quality factor */
420 int quality;
421
422 int max_muxing_queue_size;
423
424 /* the packets are buffered here until the muxer is ready to be initialized */
425 AVFifoBuffer *muxing_queue;
426 } OutputStream;
427
428 typedef struct OutputFile {
429 AVFormatContext *ctx;
430 AVDictionary *opts;
431 int ost_index; /* index of the first stream in output_streams */
432 int64_t recording_time; /* desired length of the resulting file in microseconds */
433 int64_t start_time; /* start time in microseconds */
434 uint64_t limit_filesize;
435
436 int shortest;
437
438 int header_written;
439 } OutputFile;
440
441 extern InputStream **input_streams;
442 extern int nb_input_streams;
443 extern InputFile **input_files;
444 extern int nb_input_files;
445
446 extern OutputStream **output_streams;
447 extern int nb_output_streams;
448 extern OutputFile **output_files;
449 extern int nb_output_files;
450
451 extern FilterGraph **filtergraphs;
452 extern int nb_filtergraphs;
453
454 extern char *vstats_filename;
455
456 extern float audio_drift_threshold;
457 extern float dts_delta_threshold;
458
459 extern int audio_volume;
460 extern int audio_sync_method;
461 extern int video_sync_method;
462 extern int do_benchmark;
463 extern int do_deinterlace;
464 extern int do_hex_dump;
465 extern int do_pkt_dump;
466 extern int copy_ts;
467 extern int copy_tb;
468 extern int exit_on_error;
469 extern int print_stats;
470 extern int qp_hist;
471
472 extern const AVIOInterruptCB int_cb;
473
474 extern const OptionDef options[];
475
476 extern const HWAccel hwaccels[];
477 extern int hwaccel_lax_profile_check;
478 extern AVBufferRef *hw_device_ctx;
479
480 void reset_options(OptionsContext *o);
481 void show_usage(void);
482
483 void opt_output_file(void *optctx, const char *filename);
484
485 void assert_avoptions(AVDictionary *m);
486
487 int guess_input_channel_layout(InputStream *ist);
488
489 int configure_filtergraph(FilterGraph *fg);
490 int configure_output_filter(FilterGraph *fg, OutputFilter *ofilter, AVFilterInOut *out);
491 int ist_in_filtergraph(FilterGraph *fg, InputStream *ist);
492 int filtergraph_is_simple(FilterGraph *fg);
493 int init_simple_filtergraph(InputStream *ist, OutputStream *ost);
494 int init_complex_filtergraph(FilterGraph *fg);
495
496 int ifilter_parameters_from_frame(InputFilter *ifilter, const AVFrame *frame);
497
498 int avconv_parse_options(int argc, char **argv);
499
500 int vdpau_init(AVCodecContext *s);
501 int dxva2_init(AVCodecContext *s);
502 int vda_init(AVCodecContext *s);
503 int qsv_init(AVCodecContext *s);
504 int qsv_transcode_init(OutputStream *ost);
505 int vaapi_decode_init(AVCodecContext *avctx);
506 int vaapi_device_init(const char *device);
507
508 #endif /* AVCONV_H */