avformat/utils: add missing brackets around arguments in av_realloc() call
[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
235     // parameters configured for this input
236     int format;
237
238     int width, height;
239     AVRational sample_aspect_ratio;
240
241     int sample_rate;
242     int channels;
243     uint64_t channel_layout;
244
245     AVBufferRef *hw_frames_ctx;
246 } InputFilter;
247
248 typedef struct OutputFilter {
249     AVFilterContext     *filter;
250     struct OutputStream *ost;
251     struct FilterGraph  *graph;
252     uint8_t             *name;
253
254     /* temporary storage until stream maps are processed */
255     AVFilterInOut       *out_tmp;
256     enum AVMediaType     type;
257
258     /* desired output stream properties */
259     int width, height;
260     AVRational frame_rate;
261     int format;
262     int sample_rate;
263     uint64_t channel_layout;
264
265     // those are only set if no format is specified and the encoder gives us multiple options
266     int *formats;
267     uint64_t *channel_layouts;
268     int *sample_rates;
269 } OutputFilter;
270
271 typedef struct FilterGraph {
272     int            index;
273     const char    *graph_desc;
274
275     AVFilterGraph *graph;
276     int reconfiguration;
277
278     InputFilter   **inputs;
279     int          nb_inputs;
280     OutputFilter **outputs;
281     int         nb_outputs;
282 } FilterGraph;
283
284 typedef struct InputStream {
285     int file_index;
286     AVStream *st;
287     int discard;             /* true if stream data should be discarded */
288     int user_set_discard;
289     int decoding_needed;     /* non zero if the packets must be decoded in 'raw_fifo', see DECODING_FOR_* */
290 #define DECODING_FOR_OST    1
291 #define DECODING_FOR_FILTER 2
292
293     AVCodecContext *dec_ctx;
294     AVCodec *dec;
295     AVFrame *decoded_frame;
296     AVFrame *filter_frame; /* a ref of decoded_frame, to be sent to filters */
297
298     int64_t       start;     /* time when read started */
299     /* predicted dts of the next packet read for this stream or (when there are
300      * several frames in a packet) of the next frame in current packet (in AV_TIME_BASE units) */
301     int64_t       next_dts;
302     int64_t       dts;       ///< dts of the last packet read for this stream (in AV_TIME_BASE units)
303
304     int64_t       next_pts;  ///< synthetic pts for the next decode frame (in AV_TIME_BASE units)
305     int64_t       pts;       ///< current pts of the decoded frame  (in AV_TIME_BASE units)
306     int           wrap_correction_done;
307
308     int64_t filter_in_rescale_delta_last;
309
310     int64_t min_pts; /* pts with the smallest value in a current stream */
311     int64_t max_pts; /* pts with the higher value in a current stream */
312     int64_t nb_samples; /* number of samples in the last decoded audio frame before looping */
313
314     double ts_scale;
315     int saw_first_ts;
316     AVDictionary *decoder_opts;
317     AVRational framerate;               /* framerate forced with -r */
318     int top_field_first;
319     int guess_layout_max;
320
321     int autorotate;
322     int resample_height;
323     int resample_width;
324     int resample_pix_fmt;
325
326     int      resample_sample_fmt;
327     int      resample_sample_rate;
328     int      resample_channels;
329     uint64_t resample_channel_layout;
330
331     int fix_sub_duration;
332     struct { /* previous decoded subtitle and related variables */
333         int got_output;
334         int ret;
335         AVSubtitle subtitle;
336     } prev_sub;
337
338     struct sub2video {
339         int64_t last_pts;
340         int64_t end_pts;
341         AVFrame *frame;
342         int w, h;
343     } sub2video;
344
345     int dr1;
346
347     /* decoded data from this stream goes into all those filters
348      * currently video and audio only */
349     InputFilter **filters;
350     int        nb_filters;
351
352     int reinit_filters;
353
354     /* hwaccel options */
355     enum HWAccelID hwaccel_id;
356     char  *hwaccel_device;
357     enum AVPixelFormat hwaccel_output_format;
358
359     /* hwaccel context */
360     enum HWAccelID active_hwaccel_id;
361     void  *hwaccel_ctx;
362     void (*hwaccel_uninit)(AVCodecContext *s);
363     int  (*hwaccel_get_buffer)(AVCodecContext *s, AVFrame *frame, int flags);
364     int  (*hwaccel_retrieve_data)(AVCodecContext *s, AVFrame *frame);
365     enum AVPixelFormat hwaccel_pix_fmt;
366     enum AVPixelFormat hwaccel_retrieved_pix_fmt;
367     AVBufferRef *hw_frames_ctx;
368
369     /* stats */
370     // combined size of all the packets read
371     uint64_t data_size;
372     /* number of packets successfully read for this stream */
373     uint64_t nb_packets;
374     // number of frames/samples retrieved from the decoder
375     uint64_t frames_decoded;
376     uint64_t samples_decoded;
377
378     int64_t *dts_buffer;
379     int nb_dts_buffer;
380 } InputStream;
381
382 typedef struct InputFile {
383     AVFormatContext *ctx;
384     int eof_reached;      /* true if eof reached */
385     int eagain;           /* true if last read attempt returned EAGAIN */
386     int ist_index;        /* index of first stream in input_streams */
387     int loop;             /* set number of times input stream should be looped */
388     int64_t duration;     /* actual duration of the longest stream in a file
389                              at the moment when looping happens */
390     AVRational time_base; /* time base of the duration */
391     int64_t input_ts_offset;
392
393     int64_t ts_offset;
394     int64_t last_ts;
395     int64_t start_time;   /* user-specified start time in AV_TIME_BASE or AV_NOPTS_VALUE */
396     int seek_timestamp;
397     int64_t recording_time;
398     int nb_streams;       /* number of stream that ffmpeg is aware of; may be different
399                              from ctx.nb_streams if new streams appear during av_read_frame() */
400     int nb_streams_warn;  /* number of streams that the user was warned of */
401     int rate_emu;
402     int accurate_seek;
403
404 #if HAVE_PTHREADS
405     AVThreadMessageQueue *in_thread_queue;
406     pthread_t thread;           /* thread reading from this file */
407     int non_blocking;           /* reading packets from the thread should not block */
408     int joined;                 /* the thread has been joined */
409     int thread_queue_size;      /* maximum number of queued packets */
410 #endif
411 } InputFile;
412
413 enum forced_keyframes_const {
414     FKF_N,
415     FKF_N_FORCED,
416     FKF_PREV_FORCED_N,
417     FKF_PREV_FORCED_T,
418     FKF_T,
419     FKF_NB
420 };
421
422 #define ABORT_ON_FLAG_EMPTY_OUTPUT (1 <<  0)
423
424 extern const char *const forced_keyframes_const_names[];
425
426 typedef enum {
427     ENCODER_FINISHED = 1,
428     MUXER_FINISHED = 2,
429 } OSTFinished ;
430
431 typedef struct OutputStream {
432     int file_index;          /* file index */
433     int index;               /* stream index in the output file */
434     int source_index;        /* InputStream index */
435     AVStream *st;            /* stream in the output file */
436     int encoding_needed;     /* true if encoding needed for this stream */
437     int frame_number;
438     /* input pts and corresponding output pts
439        for A/V sync */
440     struct InputStream *sync_ist; /* input stream to sync against */
441     int64_t sync_opts;       /* output frame counter, could be changed to some true timestamp */ // FIXME look at frame_number
442     /* pts of the first frame encoded for this stream, used for limiting
443      * recording time */
444     int64_t first_pts;
445     /* dts of the last packet sent to the muxer */
446     int64_t last_mux_dts;
447
448     int                    nb_bitstream_filters;
449     uint8_t                  *bsf_extradata_updated;
450     AVBSFContext            **bsf_ctx;
451
452     AVCodecContext *enc_ctx;
453     AVCodecParameters *ref_par; /* associated input codec parameters with encoders options applied */
454     AVCodec *enc;
455     int64_t max_frames;
456     AVFrame *filtered_frame;
457     AVFrame *last_frame;
458     int last_dropped;
459     int last_nb0_frames[3];
460
461     void  *hwaccel_ctx;
462
463     /* video only */
464     AVRational frame_rate;
465     int is_cfr;
466     int force_fps;
467     int top_field_first;
468     int rotate_overridden;
469
470     AVRational frame_aspect_ratio;
471
472     /* forced key frames */
473     int64_t *forced_kf_pts;
474     int forced_kf_count;
475     int forced_kf_index;
476     char *forced_keyframes;
477     AVExpr *forced_keyframes_pexpr;
478     double forced_keyframes_expr_const_values[FKF_NB];
479
480     /* audio only */
481     int *audio_channels_map;             /* list of the channels id to pick from the source stream */
482     int audio_channels_mapped;           /* number of channels in audio_channels_map */
483
484     char *logfile_prefix;
485     FILE *logfile;
486
487     OutputFilter *filter;
488     char *avfilter;
489     char *filters;         ///< filtergraph associated to the -filter option
490     char *filters_script;  ///< filtergraph script associated to the -filter_script option
491
492     AVDictionary *encoder_opts;
493     AVDictionary *sws_dict;
494     AVDictionary *swr_opts;
495     AVDictionary *resample_opts;
496     char *apad;
497     OSTFinished finished;        /* no more packets should be written for this stream */
498     int unavailable;                     /* true if the steram is unavailable (possibly temporarily) */
499     int stream_copy;
500
501     // init_output_stream() has been called for this stream
502     // The encoder and the bitstream filters have been initialized and the stream
503     // parameters are set in the AVStream.
504     int initialized;
505
506     const char *attachment_filename;
507     int copy_initial_nonkeyframes;
508     int copy_prior_start;
509     char *disposition;
510
511     int keep_pix_fmt;
512
513     AVCodecParserContext *parser;
514     AVCodecContext       *parser_avctx;
515
516     /* stats */
517     // combined size of all the packets written
518     uint64_t data_size;
519     // number of packets send to the muxer
520     uint64_t packets_written;
521     // number of frames/samples sent to the encoder
522     uint64_t frames_encoded;
523     uint64_t samples_encoded;
524
525     /* packet quality factor */
526     int quality;
527
528     int max_muxing_queue_size;
529
530     /* the packets are buffered here until the muxer is ready to be initialized */
531     AVFifoBuffer *muxing_queue;
532
533     /* packet picture type */
534     int pict_type;
535
536     /* frame encode sum of squared error values */
537     int64_t error[4];
538 } OutputStream;
539
540 typedef struct OutputFile {
541     AVFormatContext *ctx;
542     AVDictionary *opts;
543     int ost_index;       /* index of the first stream in output_streams */
544     int64_t recording_time;  ///< desired length of the resulting file in microseconds == AV_TIME_BASE units
545     int64_t start_time;      ///< start time in microseconds == AV_TIME_BASE units
546     uint64_t limit_filesize; /* filesize limit expressed in bytes */
547
548     int shortest;
549
550     int header_written;
551 } OutputFile;
552
553 extern InputStream **input_streams;
554 extern int        nb_input_streams;
555 extern InputFile   **input_files;
556 extern int        nb_input_files;
557
558 extern OutputStream **output_streams;
559 extern int         nb_output_streams;
560 extern OutputFile   **output_files;
561 extern int         nb_output_files;
562
563 extern FilterGraph **filtergraphs;
564 extern int        nb_filtergraphs;
565
566 extern char *vstats_filename;
567 extern char *sdp_filename;
568
569 extern float audio_drift_threshold;
570 extern float dts_delta_threshold;
571 extern float dts_error_threshold;
572
573 extern int audio_volume;
574 extern int audio_sync_method;
575 extern int video_sync_method;
576 extern float frame_drop_threshold;
577 extern int do_benchmark;
578 extern int do_benchmark_all;
579 extern int do_deinterlace;
580 extern int do_hex_dump;
581 extern int do_pkt_dump;
582 extern int copy_ts;
583 extern int start_at_zero;
584 extern int copy_tb;
585 extern int debug_ts;
586 extern int exit_on_error;
587 extern int abort_on_flags;
588 extern int print_stats;
589 extern int qp_hist;
590 extern int stdin_interaction;
591 extern int frame_bits_per_raw_sample;
592 extern AVIOContext *progress_avio;
593 extern float max_error_rate;
594 extern char *videotoolbox_pixfmt;
595
596 extern int filter_nbthreads;
597 extern int filter_complex_nbthreads;
598
599 extern const AVIOInterruptCB int_cb;
600
601 extern const OptionDef options[];
602 extern const HWAccel hwaccels[];
603 extern int hwaccel_lax_profile_check;
604 extern AVBufferRef *hw_device_ctx;
605
606
607 void term_init(void);
608 void term_exit(void);
609
610 void reset_options(OptionsContext *o, int is_input);
611 void show_usage(void);
612
613 void opt_output_file(void *optctx, const char *filename);
614
615 void remove_avoptions(AVDictionary **a, AVDictionary *b);
616 void assert_avoptions(AVDictionary *m);
617
618 int guess_input_channel_layout(InputStream *ist);
619
620 enum AVPixelFormat choose_pixel_fmt(AVStream *st, AVCodecContext *avctx, AVCodec *codec, enum AVPixelFormat target);
621 void choose_sample_fmt(AVStream *st, AVCodec *codec);
622
623 int configure_filtergraph(FilterGraph *fg);
624 int configure_output_filter(FilterGraph *fg, OutputFilter *ofilter, AVFilterInOut *out);
625 int ist_in_filtergraph(FilterGraph *fg, InputStream *ist);
626 int filtergraph_is_simple(FilterGraph *fg);
627 int init_simple_filtergraph(InputStream *ist, OutputStream *ost);
628 int init_complex_filtergraph(FilterGraph *fg);
629
630 int ifilter_parameters_from_frame(InputFilter *ifilter, const AVFrame *frame);
631 int ifilter_parameters_from_decoder(InputFilter *ifilter, const AVCodecContext *avctx);
632
633 int ffmpeg_parse_options(int argc, char **argv);
634
635 int vdpau_init(AVCodecContext *s);
636 int dxva2_init(AVCodecContext *s);
637 int vda_init(AVCodecContext *s);
638 int videotoolbox_init(AVCodecContext *s);
639 int qsv_init(AVCodecContext *s);
640 int qsv_transcode_init(OutputStream *ost);
641 int vaapi_decode_init(AVCodecContext *avctx);
642 int vaapi_device_init(const char *device);
643 int cuvid_init(AVCodecContext *s);
644 int cuvid_transcode_init(OutputStream *ost);
645
646 #endif /* FFMPEG_H */