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