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