cosmetics: Drop particularly redundant silly comments
[ffmpeg.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 };
59
60 typedef struct HWAccel {
61     const char *name;
62     int (*init)(AVCodecContext *s);
63     enum HWAccelID id;
64     enum AVPixelFormat pix_fmt;
65 } HWAccel;
66
67 /* select an input stream for an output stream */
68 typedef struct StreamMap {
69     int disabled;           /* 1 is this mapping is disabled by a negative map */
70     int file_index;
71     int stream_index;
72     int sync_file_index;
73     int sync_stream_index;
74     char *linklabel;       /* name of an output link, for mapping lavfi outputs */
75 } StreamMap;
76
77 /* select an input file for an output file */
78 typedef struct MetadataMap {
79     int  file;      // file index
80     char type;      // type of metadata to copy -- (g)lobal, (s)tream, (c)hapter or (p)rogram
81     int  index;     // stream/chapter/program number
82 } MetadataMap;
83
84 typedef struct OptionsContext {
85     OptionGroup *g;
86
87     /* input/output options */
88     int64_t start_time;
89     const char *format;
90
91     SpecifierOpt *codec_names;
92     int        nb_codec_names;
93     SpecifierOpt *audio_channels;
94     int        nb_audio_channels;
95     SpecifierOpt *audio_sample_rate;
96     int        nb_audio_sample_rate;
97     SpecifierOpt *frame_rates;
98     int        nb_frame_rates;
99     SpecifierOpt *frame_sizes;
100     int        nb_frame_sizes;
101     SpecifierOpt *frame_pix_fmts;
102     int        nb_frame_pix_fmts;
103
104     /* input options */
105     int64_t input_ts_offset;
106     int loop;
107     int rate_emu;
108     int accurate_seek;
109
110     SpecifierOpt *ts_scale;
111     int        nb_ts_scale;
112     SpecifierOpt *dump_attachment;
113     int        nb_dump_attachment;
114     SpecifierOpt *hwaccels;
115     int        nb_hwaccels;
116     SpecifierOpt *hwaccel_devices;
117     int        nb_hwaccel_devices;
118     SpecifierOpt *autorotate;
119     int        nb_autorotate;
120
121     /* output options */
122     StreamMap *stream_maps;
123     int     nb_stream_maps;
124     /* first item specifies output metadata, second is input */
125     MetadataMap (*meta_data_maps)[2];
126     int nb_meta_data_maps;
127     int metadata_global_manual;
128     int metadata_streams_manual;
129     int metadata_chapters_manual;
130     const char **attachments;
131     int       nb_attachments;
132
133     int chapters_input_file;
134
135     int64_t recording_time;
136     uint64_t limit_filesize;
137     float mux_preload;
138     float mux_max_delay;
139     int shortest;
140
141     int video_disable;
142     int audio_disable;
143     int subtitle_disable;
144     int data_disable;
145
146     /* indexed by output file stream index */
147     int   *streamid_map;
148     int nb_streamid_map;
149
150     SpecifierOpt *metadata;
151     int        nb_metadata;
152     SpecifierOpt *max_frames;
153     int        nb_max_frames;
154     SpecifierOpt *bitstream_filters;
155     int        nb_bitstream_filters;
156     SpecifierOpt *codec_tags;
157     int        nb_codec_tags;
158     SpecifierOpt *sample_fmts;
159     int        nb_sample_fmts;
160     SpecifierOpt *qscale;
161     int        nb_qscale;
162     SpecifierOpt *forced_key_frames;
163     int        nb_forced_key_frames;
164     SpecifierOpt *force_fps;
165     int        nb_force_fps;
166     SpecifierOpt *frame_aspect_ratios;
167     int        nb_frame_aspect_ratios;
168     SpecifierOpt *rc_overrides;
169     int        nb_rc_overrides;
170     SpecifierOpt *intra_matrices;
171     int        nb_intra_matrices;
172     SpecifierOpt *inter_matrices;
173     int        nb_inter_matrices;
174     SpecifierOpt *top_field_first;
175     int        nb_top_field_first;
176     SpecifierOpt *metadata_map;
177     int        nb_metadata_map;
178     SpecifierOpt *presets;
179     int        nb_presets;
180     SpecifierOpt *copy_initial_nonkeyframes;
181     int        nb_copy_initial_nonkeyframes;
182     SpecifierOpt *filters;
183     int        nb_filters;
184     SpecifierOpt *filter_scripts;
185     int        nb_filter_scripts;
186     SpecifierOpt *pass;
187     int        nb_pass;
188     SpecifierOpt *passlogfiles;
189     int        nb_passlogfiles;
190 } OptionsContext;
191
192 typedef struct InputFilter {
193     AVFilterContext    *filter;
194     struct InputStream *ist;
195     struct FilterGraph *graph;
196     uint8_t            *name;
197 } InputFilter;
198
199 typedef struct OutputFilter {
200     AVFilterContext     *filter;
201     struct OutputStream *ost;
202     struct FilterGraph  *graph;
203     uint8_t             *name;
204
205     /* temporary storage until stream maps are processed */
206     AVFilterInOut       *out_tmp;
207     enum AVMediaType     type;
208 } OutputFilter;
209
210 typedef struct FilterGraph {
211     int            index;
212     const char    *graph_desc;
213
214     AVFilterGraph *graph;
215
216     InputFilter   **inputs;
217     int          nb_inputs;
218     OutputFilter **outputs;
219     int         nb_outputs;
220 } FilterGraph;
221
222 typedef struct InputStream {
223     int file_index;
224     AVStream *st;
225     int discard;             /* true if stream data should be discarded */
226     int decoding_needed;     /* true if the packets must be decoded in 'raw_fifo' */
227     AVCodecContext *dec_ctx;
228     AVCodec *dec;
229     AVFrame *decoded_frame;
230     AVFrame *filter_frame; /* a ref of decoded_frame, to be sent to filters */
231
232     int64_t       start;     /* time when read started */
233     /* predicted dts of the next packet read for this stream or (when there are
234      * several frames in a packet) of the next frame in current packet */
235     int64_t       next_dts;
236     /* dts of the last packet read for this stream */
237     int64_t       last_dts;
238     int64_t min_pts; /* pts with the smallest value in a current stream */
239     int64_t max_pts; /* pts with the higher value in a current stream */
240     int64_t nb_samples; /* number of samples in the last decoded audio frame before looping */
241     PtsCorrectionContext pts_ctx;
242     double ts_scale;
243     int showed_multi_packet_warning;
244     AVDictionary *decoder_opts;
245     AVRational framerate;               /* framerate forced with -r */
246
247     int autorotate;
248     int resample_height;
249     int resample_width;
250     int resample_pix_fmt;
251
252     int      resample_sample_fmt;
253     int      resample_sample_rate;
254     int      resample_channels;
255     uint64_t resample_channel_layout;
256
257     /* decoded data from this stream goes into all those filters
258      * currently video and audio only */
259     InputFilter **filters;
260     int        nb_filters;
261
262     /* hwaccel options */
263     enum HWAccelID hwaccel_id;
264     char  *hwaccel_device;
265
266     /* hwaccel context */
267     enum HWAccelID active_hwaccel_id;
268     void  *hwaccel_ctx;
269     void (*hwaccel_uninit)(AVCodecContext *s);
270     int  (*hwaccel_get_buffer)(AVCodecContext *s, AVFrame *frame, int flags);
271     int  (*hwaccel_retrieve_data)(AVCodecContext *s, AVFrame *frame);
272     enum AVPixelFormat hwaccel_pix_fmt;
273     enum AVPixelFormat hwaccel_retrieved_pix_fmt;
274
275     /* stats */
276     // combined size of all the packets read
277     uint64_t data_size;
278     /* number of packets successfully read for this stream */
279     uint64_t nb_packets;
280     // number of frames/samples retrieved from the decoder
281     uint64_t frames_decoded;
282     uint64_t samples_decoded;
283 } InputStream;
284
285 typedef struct InputFile {
286     AVFormatContext *ctx;
287     int eof_reached;      /* true if eof reached */
288     int eagain;           /* true if last read attempt returned EAGAIN */
289     int ist_index;        /* index of first stream in ist_table */
290     int loop;             /* set number of times input stream should be looped */
291     int64_t duration;     /* actual duration of the longest stream in a file
292                              at the moment when looping happens */
293     AVRational time_base; /* time base of the duration */
294     int64_t ts_offset;
295     int64_t start_time;   /* user-specified start time in AV_TIME_BASE or AV_NOPTS_VALUE */
296     int64_t recording_time;
297     int nb_streams;       /* number of stream that avconv is aware of; may be different
298                              from ctx.nb_streams if new streams appear during av_read_frame() */
299     int rate_emu;
300     int accurate_seek;
301
302 #if HAVE_PTHREADS
303     pthread_t thread;           /* thread reading from this file */
304     int finished;               /* the thread has exited */
305     int joined;                 /* the thread has been joined */
306     pthread_mutex_t fifo_lock;  /* lock for access to fifo */
307     pthread_cond_t  fifo_cond;  /* the main thread will signal on this cond after reading from fifo */
308     AVFifoBuffer *fifo;         /* demuxed packets are stored here; freed by the main thread */
309 #endif
310 } InputFile;
311
312 typedef struct OutputStream {
313     int file_index;          /* file index */
314     int index;               /* stream index in the output file */
315     int source_index;        /* InputStream index */
316     AVStream *st;            /* stream in the output file */
317     int encoding_needed;     /* true if encoding needed for this stream */
318     int frame_number;
319     /* input pts and corresponding output pts
320        for A/V sync */
321     // double sync_ipts;        /* dts from the AVPacket of the demuxer in second units */
322     struct InputStream *sync_ist; /* input stream to sync against */
323     int64_t sync_opts;       /* output frame counter, could be changed to some true timestamp */ // FIXME look at frame_number
324     /* pts of the first frame encoded for this stream, used for limiting
325      * recording time */
326     int64_t first_pts;
327     /* dts of the last packet sent to the muxer */
328     int64_t last_mux_dts;
329     AVBitStreamFilterContext *bitstream_filters;
330     AVCodecContext *enc_ctx;
331     AVCodec *enc;
332     int64_t max_frames;
333     AVFrame *filtered_frame;
334
335     void  *hwaccel_ctx;
336
337     /* video only */
338     AVRational frame_rate;
339     int force_fps;
340     int top_field_first;
341
342     float frame_aspect_ratio;
343
344     /* forced key frames */
345     int64_t *forced_kf_pts;
346     int forced_kf_count;
347     int forced_kf_index;
348     char *forced_keyframes;
349
350     char *logfile_prefix;
351     FILE *logfile;
352
353     OutputFilter *filter;
354     char *avfilter;
355
356     int64_t sws_flags;
357     AVDictionary *encoder_opts;
358     AVDictionary *resample_opts;
359     int finished;        /* no more packets should be written for this stream */
360     int stream_copy;
361     const char *attachment_filename;
362     int copy_initial_nonkeyframes;
363
364     enum AVPixelFormat pix_fmts[2];
365
366     AVCodecParserContext *parser;
367
368     /* stats */
369     // combined size of all the packets written
370     uint64_t data_size;
371     // number of packets send to the muxer
372     uint64_t packets_written;
373     // number of frames/samples sent to the encoder
374     uint64_t frames_encoded;
375     uint64_t samples_encoded;
376
377     /* packet quality factor */
378     int quality;
379 } OutputStream;
380
381 typedef struct OutputFile {
382     AVFormatContext *ctx;
383     AVDictionary *opts;
384     int ost_index;       /* index of the first stream in output_streams */
385     int64_t recording_time; /* desired length of the resulting file in microseconds */
386     int64_t start_time;     /* start time in microseconds */
387     uint64_t limit_filesize;
388
389     int shortest;
390 } OutputFile;
391
392 extern InputStream **input_streams;
393 extern int        nb_input_streams;
394 extern InputFile   **input_files;
395 extern int        nb_input_files;
396
397 extern OutputStream **output_streams;
398 extern int         nb_output_streams;
399 extern OutputFile   **output_files;
400 extern int         nb_output_files;
401
402 extern FilterGraph **filtergraphs;
403 extern int        nb_filtergraphs;
404
405 extern char *vstats_filename;
406
407 extern float audio_drift_threshold;
408 extern float dts_delta_threshold;
409
410 extern int audio_volume;
411 extern int audio_sync_method;
412 extern int video_sync_method;
413 extern int do_benchmark;
414 extern int do_deinterlace;
415 extern int do_hex_dump;
416 extern int do_pkt_dump;
417 extern int copy_ts;
418 extern int copy_tb;
419 extern int exit_on_error;
420 extern int print_stats;
421 extern int qp_hist;
422
423 extern const AVIOInterruptCB int_cb;
424
425 extern const OptionDef options[];
426
427 extern const HWAccel hwaccels[];
428
429 void reset_options(OptionsContext *o);
430 void show_usage(void);
431
432 void opt_output_file(void *optctx, const char *filename);
433
434 void assert_avoptions(AVDictionary *m);
435
436 int guess_input_channel_layout(InputStream *ist);
437
438 int configure_filtergraph(FilterGraph *fg);
439 int configure_output_filter(FilterGraph *fg, OutputFilter *ofilter, AVFilterInOut *out);
440 int ist_in_filtergraph(FilterGraph *fg, InputStream *ist);
441 FilterGraph *init_simple_filtergraph(InputStream *ist, OutputStream *ost);
442 int init_complex_filtergraph(FilterGraph *fg);
443
444 int avconv_parse_options(int argc, char **argv);
445
446 int vdpau_init(AVCodecContext *s);
447 int dxva2_init(AVCodecContext *s);
448 int vda_init(AVCodecContext *s);
449 int qsv_init(AVCodecContext *s);
450 int qsv_transcode_init(OutputStream *ost);
451
452 #endif /* AVCONV_H */