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