Bump minor versions for 3.2
[ffmpeg.git] / ffmpeg.h
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg 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  * FFmpeg 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 FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 #ifndef FFMPEG_H
20 #define FFMPEG_H
21
22 #include "config.h"
23
24 #include <stdint.h>
25 #include <stdio.h>
26 #include <signal.h>
27
28 #if HAVE_PTHREADS
29 #include <pthread.h>
30 #endif
31
32 #include "cmdutils.h"
33
34 #include "libavformat/avformat.h"
35 #include "libavformat/avio.h"
36
37 #include "libavcodec/avcodec.h"
38
39 #include "libavfilter/avfilter.h"
40
41 #include "libavutil/avutil.h"
42 #include "libavutil/dict.h"
43 #include "libavutil/eval.h"
44 #include "libavutil/fifo.h"
45 #include "libavutil/pixfmt.h"
46 #include "libavutil/rational.h"
47 #include "libavutil/threadmessage.h"
48
49 #include "libswresample/swresample.h"
50
51 #define VSYNC_AUTO       -1
52 #define VSYNC_PASSTHROUGH 0
53 #define VSYNC_CFR         1
54 #define VSYNC_VFR         2
55 #define VSYNC_VSCFR       0xfe
56 #define VSYNC_DROP        0xff
57
58 #define MAX_STREAMS 1024    /* arbitrary sanity check value */
59
60 enum HWAccelID {
61     HWACCEL_NONE = 0,
62     HWACCEL_AUTO,
63     HWACCEL_VDPAU,
64     HWACCEL_DXVA2,
65     HWACCEL_VDA,
66     HWACCEL_VIDEOTOOLBOX,
67     HWACCEL_QSV,
68     HWACCEL_VAAPI,
69     HWACCEL_CUVID,
70 };
71
72 typedef struct HWAccel {
73     const char *name;
74     int (*init)(AVCodecContext *s);
75     enum HWAccelID id;
76     enum AVPixelFormat pix_fmt;
77 } HWAccel;
78
79 /* select an input stream for an output stream */
80 typedef struct StreamMap {
81     int disabled;           /* 1 is this mapping is disabled by a negative map */
82     int file_index;
83     int stream_index;
84     int sync_file_index;
85     int sync_stream_index;
86     char *linklabel;       /* name of an output link, for mapping lavfi outputs */
87 } StreamMap;
88
89 typedef struct {
90     int  file_idx,  stream_idx,  channel_idx; // input
91     int ofile_idx, ostream_idx;               // output
92 } AudioChannelMap;
93
94 typedef struct OptionsContext {
95     OptionGroup *g;
96
97     /* input/output options */
98     int64_t start_time;
99     int64_t start_time_eof;
100     int seek_timestamp;
101     const char *format;
102
103     SpecifierOpt *codec_names;
104     int        nb_codec_names;
105     SpecifierOpt *audio_channels;
106     int        nb_audio_channels;
107     SpecifierOpt *audio_sample_rate;
108     int        nb_audio_sample_rate;
109     SpecifierOpt *frame_rates;
110     int        nb_frame_rates;
111     SpecifierOpt *frame_sizes;
112     int        nb_frame_sizes;
113     SpecifierOpt *frame_pix_fmts;
114     int        nb_frame_pix_fmts;
115
116     /* input options */
117     int64_t input_ts_offset;
118     int loop;
119     int rate_emu;
120     int accurate_seek;
121     int thread_queue_size;
122
123     SpecifierOpt *ts_scale;
124     int        nb_ts_scale;
125     SpecifierOpt *dump_attachment;
126     int        nb_dump_attachment;
127     SpecifierOpt *hwaccels;
128     int        nb_hwaccels;
129     SpecifierOpt *hwaccel_devices;
130     int        nb_hwaccel_devices;
131     SpecifierOpt *hwaccel_output_formats;
132     int        nb_hwaccel_output_formats;
133     SpecifierOpt *autorotate;
134     int        nb_autorotate;
135
136     /* output options */
137     StreamMap *stream_maps;
138     int     nb_stream_maps;
139     AudioChannelMap *audio_channel_maps; /* one info entry per -map_channel */
140     int           nb_audio_channel_maps; /* number of (valid) -map_channel settings */
141     int metadata_global_manual;
142     int metadata_streams_manual;
143     int metadata_chapters_manual;
144     const char **attachments;
145     int       nb_attachments;
146
147     int chapters_input_file;
148
149     int64_t recording_time;
150     int64_t stop_time;
151     uint64_t limit_filesize;
152     float mux_preload;
153     float mux_max_delay;
154     int shortest;
155
156     int video_disable;
157     int audio_disable;
158     int subtitle_disable;
159     int data_disable;
160
161     /* indexed by output file stream index */
162     int   *streamid_map;
163     int nb_streamid_map;
164
165     SpecifierOpt *metadata;
166     int        nb_metadata;
167     SpecifierOpt *max_frames;
168     int        nb_max_frames;
169     SpecifierOpt *bitstream_filters;
170     int        nb_bitstream_filters;
171     SpecifierOpt *codec_tags;
172     int        nb_codec_tags;
173     SpecifierOpt *sample_fmts;
174     int        nb_sample_fmts;
175     SpecifierOpt *qscale;
176     int        nb_qscale;
177     SpecifierOpt *forced_key_frames;
178     int        nb_forced_key_frames;
179     SpecifierOpt *force_fps;
180     int        nb_force_fps;
181     SpecifierOpt *frame_aspect_ratios;
182     int        nb_frame_aspect_ratios;
183     SpecifierOpt *rc_overrides;
184     int        nb_rc_overrides;
185     SpecifierOpt *intra_matrices;
186     int        nb_intra_matrices;
187     SpecifierOpt *inter_matrices;
188     int        nb_inter_matrices;
189     SpecifierOpt *chroma_intra_matrices;
190     int        nb_chroma_intra_matrices;
191     SpecifierOpt *top_field_first;
192     int        nb_top_field_first;
193     SpecifierOpt *metadata_map;
194     int        nb_metadata_map;
195     SpecifierOpt *presets;
196     int        nb_presets;
197     SpecifierOpt *copy_initial_nonkeyframes;
198     int        nb_copy_initial_nonkeyframes;
199     SpecifierOpt *copy_prior_start;
200     int        nb_copy_prior_start;
201     SpecifierOpt *filters;
202     int        nb_filters;
203     SpecifierOpt *filter_scripts;
204     int        nb_filter_scripts;
205     SpecifierOpt *reinit_filters;
206     int        nb_reinit_filters;
207     SpecifierOpt *fix_sub_duration;
208     int        nb_fix_sub_duration;
209     SpecifierOpt *canvas_sizes;
210     int        nb_canvas_sizes;
211     SpecifierOpt *pass;
212     int        nb_pass;
213     SpecifierOpt *passlogfiles;
214     int        nb_passlogfiles;
215     SpecifierOpt *max_muxing_queue_size;
216     int        nb_max_muxing_queue_size;
217     SpecifierOpt *guess_layout_max;
218     int        nb_guess_layout_max;
219     SpecifierOpt *apad;
220     int        nb_apad;
221     SpecifierOpt *discard;
222     int        nb_discard;
223     SpecifierOpt *disposition;
224     int        nb_disposition;
225     SpecifierOpt *program;
226     int        nb_program;
227 } OptionsContext;
228
229 typedef struct InputFilter {
230     AVFilterContext    *filter;
231     struct InputStream *ist;
232     struct FilterGraph *graph;
233     uint8_t            *name;
234 } InputFilter;
235
236 typedef struct OutputFilter {
237     AVFilterContext     *filter;
238     struct OutputStream *ost;
239     struct FilterGraph  *graph;
240     uint8_t             *name;
241
242     /* temporary storage until stream maps are processed */
243     AVFilterInOut       *out_tmp;
244     enum AVMediaType     type;
245 } OutputFilter;
246
247 typedef struct FilterGraph {
248     int            index;
249     const char    *graph_desc;
250
251     AVFilterGraph *graph;
252     int reconfiguration;
253
254     InputFilter   **inputs;
255     int          nb_inputs;
256     OutputFilter **outputs;
257     int         nb_outputs;
258 } FilterGraph;
259
260 typedef struct InputStream {
261     int file_index;
262     AVStream *st;
263     int discard;             /* true if stream data should be discarded */
264     int user_set_discard;
265     int decoding_needed;     /* non zero if the packets must be decoded in 'raw_fifo', see DECODING_FOR_* */
266 #define DECODING_FOR_OST    1
267 #define DECODING_FOR_FILTER 2
268
269     AVCodecContext *dec_ctx;
270     AVCodec *dec;
271     AVFrame *decoded_frame;
272     AVFrame *filter_frame; /* a ref of decoded_frame, to be sent to filters */
273
274     int64_t       start;     /* time when read started */
275     /* predicted dts of the next packet read for this stream or (when there are
276      * several frames in a packet) of the next frame in current packet (in AV_TIME_BASE units) */
277     int64_t       next_dts;
278     int64_t       dts;       ///< dts of the last packet read for this stream (in AV_TIME_BASE units)
279
280     int64_t       next_pts;  ///< synthetic pts for the next decode frame (in AV_TIME_BASE units)
281     int64_t       pts;       ///< current pts of the decoded frame  (in AV_TIME_BASE units)
282     int           wrap_correction_done;
283
284     int64_t filter_in_rescale_delta_last;
285
286     int64_t min_pts; /* pts with the smallest value in a current stream */
287     int64_t max_pts; /* pts with the higher value in a current stream */
288     int64_t nb_samples; /* number of samples in the last decoded audio frame before looping */
289
290     double ts_scale;
291     int saw_first_ts;
292     AVDictionary *decoder_opts;
293     AVRational framerate;               /* framerate forced with -r */
294     int top_field_first;
295     int guess_layout_max;
296
297     int autorotate;
298     int resample_height;
299     int resample_width;
300     int resample_pix_fmt;
301
302     int      resample_sample_fmt;
303     int      resample_sample_rate;
304     int      resample_channels;
305     uint64_t resample_channel_layout;
306
307     int fix_sub_duration;
308     struct { /* previous decoded subtitle and related variables */
309         int got_output;
310         int ret;
311         AVSubtitle subtitle;
312     } prev_sub;
313
314     struct sub2video {
315         int64_t last_pts;
316         int64_t end_pts;
317         AVFrame *frame;
318         int w, h;
319     } sub2video;
320
321     int dr1;
322
323     /* decoded data from this stream goes into all those filters
324      * currently video and audio only */
325     InputFilter **filters;
326     int        nb_filters;
327
328     int reinit_filters;
329
330     /* hwaccel options */
331     enum HWAccelID hwaccel_id;
332     char  *hwaccel_device;
333     enum AVPixelFormat hwaccel_output_format;
334
335     /* hwaccel context */
336     enum HWAccelID active_hwaccel_id;
337     void  *hwaccel_ctx;
338     void (*hwaccel_uninit)(AVCodecContext *s);
339     int  (*hwaccel_get_buffer)(AVCodecContext *s, AVFrame *frame, int flags);
340     int  (*hwaccel_retrieve_data)(AVCodecContext *s, AVFrame *frame);
341     enum AVPixelFormat hwaccel_pix_fmt;
342     enum AVPixelFormat hwaccel_retrieved_pix_fmt;
343     AVBufferRef *hw_frames_ctx;
344
345     /* stats */
346     // combined size of all the packets read
347     uint64_t data_size;
348     /* number of packets successfully read for this stream */
349     uint64_t nb_packets;
350     // number of frames/samples retrieved from the decoder
351     uint64_t frames_decoded;
352     uint64_t samples_decoded;
353
354     int64_t *dts_buffer;
355     int nb_dts_buffer;
356 } InputStream;
357
358 typedef struct InputFile {
359     AVFormatContext *ctx;
360     int eof_reached;      /* true if eof reached */
361     int eagain;           /* true if last read attempt returned EAGAIN */
362     int ist_index;        /* index of first stream in input_streams */
363     int loop;             /* set number of times input stream should be looped */
364     int64_t duration;     /* actual duration of the longest stream in a file
365                              at the moment when looping happens */
366     AVRational time_base; /* time base of the duration */
367     int64_t input_ts_offset;
368
369     int64_t ts_offset;
370     int64_t last_ts;
371     int64_t start_time;   /* user-specified start time in AV_TIME_BASE or AV_NOPTS_VALUE */
372     int seek_timestamp;
373     int64_t recording_time;
374     int nb_streams;       /* number of stream that ffmpeg is aware of; may be different
375                              from ctx.nb_streams if new streams appear during av_read_frame() */
376     int nb_streams_warn;  /* number of streams that the user was warned of */
377     int rate_emu;
378     int accurate_seek;
379
380 #if HAVE_PTHREADS
381     AVThreadMessageQueue *in_thread_queue;
382     pthread_t thread;           /* thread reading from this file */
383     int non_blocking;           /* reading packets from the thread should not block */
384     int joined;                 /* the thread has been joined */
385     int thread_queue_size;      /* maximum number of queued packets */
386 #endif
387 } InputFile;
388
389 enum forced_keyframes_const {
390     FKF_N,
391     FKF_N_FORCED,
392     FKF_PREV_FORCED_N,
393     FKF_PREV_FORCED_T,
394     FKF_T,
395     FKF_NB
396 };
397
398 #define ABORT_ON_FLAG_EMPTY_OUTPUT (1 <<  0)
399
400 extern const char *const forced_keyframes_const_names[];
401
402 typedef enum {
403     ENCODER_FINISHED = 1,
404     MUXER_FINISHED = 2,
405 } OSTFinished ;
406
407 typedef struct OutputStream {
408     int file_index;          /* file index */
409     int index;               /* stream index in the output file */
410     int source_index;        /* InputStream index */
411     AVStream *st;            /* stream in the output file */
412     int encoding_needed;     /* true if encoding needed for this stream */
413     int frame_number;
414     /* input pts and corresponding output pts
415        for A/V sync */
416     struct InputStream *sync_ist; /* input stream to sync against */
417     int64_t sync_opts;       /* output frame counter, could be changed to some true timestamp */ // FIXME look at frame_number
418     /* pts of the first frame encoded for this stream, used for limiting
419      * recording time */
420     int64_t first_pts;
421     /* dts of the last packet sent to the muxer */
422     int64_t last_mux_dts;
423
424     int                    nb_bitstream_filters;
425     uint8_t                  *bsf_extradata_updated;
426     AVBSFContext            **bsf_ctx;
427
428     AVCodecContext *enc_ctx;
429     AVCodecParameters *ref_par; /* associated input codec parameters with encoders options applied */
430     AVCodec *enc;
431     int64_t max_frames;
432     AVFrame *filtered_frame;
433     AVFrame *last_frame;
434     int last_dropped;
435     int last_nb0_frames[3];
436
437     void  *hwaccel_ctx;
438
439     /* video only */
440     AVRational frame_rate;
441     int is_cfr;
442     int force_fps;
443     int top_field_first;
444     int rotate_overridden;
445
446     AVRational frame_aspect_ratio;
447
448     /* forced key frames */
449     int64_t *forced_kf_pts;
450     int forced_kf_count;
451     int forced_kf_index;
452     char *forced_keyframes;
453     AVExpr *forced_keyframes_pexpr;
454     double forced_keyframes_expr_const_values[FKF_NB];
455
456     /* audio only */
457     int *audio_channels_map;             /* list of the channels id to pick from the source stream */
458     int audio_channels_mapped;           /* number of channels in audio_channels_map */
459
460     char *logfile_prefix;
461     FILE *logfile;
462
463     OutputFilter *filter;
464     char *avfilter;
465     char *filters;         ///< filtergraph associated to the -filter option
466     char *filters_script;  ///< filtergraph script associated to the -filter_script option
467
468     AVDictionary *encoder_opts;
469     AVDictionary *sws_dict;
470     AVDictionary *swr_opts;
471     AVDictionary *resample_opts;
472     char *apad;
473     OSTFinished finished;        /* no more packets should be written for this stream */
474     int unavailable;                     /* true if the steram is unavailable (possibly temporarily) */
475     int stream_copy;
476
477     // init_output_stream() has been called for this stream
478     // The encoder and the bitstream filters have been initialized and the stream
479     // parameters are set in the AVStream.
480     int initialized;
481
482     const char *attachment_filename;
483     int copy_initial_nonkeyframes;
484     int copy_prior_start;
485     char *disposition;
486
487     int keep_pix_fmt;
488
489     AVCodecParserContext *parser;
490     AVCodecContext       *parser_avctx;
491
492     /* stats */
493     // combined size of all the packets written
494     uint64_t data_size;
495     // number of packets send to the muxer
496     uint64_t packets_written;
497     // number of frames/samples sent to the encoder
498     uint64_t frames_encoded;
499     uint64_t samples_encoded;
500
501     /* packet quality factor */
502     int quality;
503
504     int max_muxing_queue_size;
505
506     /* the packets are buffered here until the muxer is ready to be initialized */
507     AVFifoBuffer *muxing_queue;
508
509     /* packet picture type */
510     int pict_type;
511
512     /* frame encode sum of squared error values */
513     int64_t error[4];
514 } OutputStream;
515
516 typedef struct OutputFile {
517     AVFormatContext *ctx;
518     AVDictionary *opts;
519     int ost_index;       /* index of the first stream in output_streams */
520     int64_t recording_time;  ///< desired length of the resulting file in microseconds == AV_TIME_BASE units
521     int64_t start_time;      ///< start time in microseconds == AV_TIME_BASE units
522     uint64_t limit_filesize; /* filesize limit expressed in bytes */
523
524     int shortest;
525
526     int header_written;
527 } OutputFile;
528
529 extern InputStream **input_streams;
530 extern int        nb_input_streams;
531 extern InputFile   **input_files;
532 extern int        nb_input_files;
533
534 extern OutputStream **output_streams;
535 extern int         nb_output_streams;
536 extern OutputFile   **output_files;
537 extern int         nb_output_files;
538
539 extern FilterGraph **filtergraphs;
540 extern int        nb_filtergraphs;
541
542 extern char *vstats_filename;
543 extern char *sdp_filename;
544
545 extern float audio_drift_threshold;
546 extern float dts_delta_threshold;
547 extern float dts_error_threshold;
548
549 extern int audio_volume;
550 extern int audio_sync_method;
551 extern int video_sync_method;
552 extern float frame_drop_threshold;
553 extern int do_benchmark;
554 extern int do_benchmark_all;
555 extern int do_deinterlace;
556 extern int do_hex_dump;
557 extern int do_pkt_dump;
558 extern int copy_ts;
559 extern int start_at_zero;
560 extern int copy_tb;
561 extern int debug_ts;
562 extern int exit_on_error;
563 extern int abort_on_flags;
564 extern int print_stats;
565 extern int qp_hist;
566 extern int stdin_interaction;
567 extern int frame_bits_per_raw_sample;
568 extern AVIOContext *progress_avio;
569 extern float max_error_rate;
570 extern char *videotoolbox_pixfmt;
571
572 extern const AVIOInterruptCB int_cb;
573
574 extern const OptionDef options[];
575 extern const HWAccel hwaccels[];
576 extern int hwaccel_lax_profile_check;
577 extern AVBufferRef *hw_device_ctx;
578
579
580 void term_init(void);
581 void term_exit(void);
582
583 void reset_options(OptionsContext *o, int is_input);
584 void show_usage(void);
585
586 void opt_output_file(void *optctx, const char *filename);
587
588 void remove_avoptions(AVDictionary **a, AVDictionary *b);
589 void assert_avoptions(AVDictionary *m);
590
591 int guess_input_channel_layout(InputStream *ist);
592
593 enum AVPixelFormat choose_pixel_fmt(AVStream *st, AVCodecContext *avctx, AVCodec *codec, enum AVPixelFormat target);
594 void choose_sample_fmt(AVStream *st, AVCodec *codec);
595
596 int configure_filtergraph(FilterGraph *fg);
597 int configure_output_filter(FilterGraph *fg, OutputFilter *ofilter, AVFilterInOut *out);
598 int ist_in_filtergraph(FilterGraph *fg, InputStream *ist);
599 int filtergraph_is_simple(FilterGraph *fg);
600 int init_simple_filtergraph(InputStream *ist, OutputStream *ost);
601 int init_complex_filtergraph(FilterGraph *fg);
602
603 int ffmpeg_parse_options(int argc, char **argv);
604
605 int vdpau_init(AVCodecContext *s);
606 int dxva2_init(AVCodecContext *s);
607 int vda_init(AVCodecContext *s);
608 int videotoolbox_init(AVCodecContext *s);
609 int qsv_init(AVCodecContext *s);
610 int qsv_transcode_init(OutputStream *ost);
611 int vaapi_decode_init(AVCodecContext *avctx);
612 int vaapi_device_init(const char *device);
613 int cuvid_init(AVCodecContext *s);
614 int cuvid_transcode_init(OutputStream *ost);
615
616 #endif /* FFMPEG_H */