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