2 * This file is part of FFmpeg.
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.
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.
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
19 #ifndef FFTOOLS_FFMPEG_H
20 #define FFTOOLS_FFMPEG_H
30 #include "libavformat/avformat.h"
31 #include "libavformat/avio.h"
33 #include "libavcodec/avcodec.h"
35 #include "libavfilter/avfilter.h"
37 #include "libavutil/avutil.h"
38 #include "libavutil/dict.h"
39 #include "libavutil/eval.h"
40 #include "libavutil/fifo.h"
41 #include "libavutil/hwcontext.h"
42 #include "libavutil/pixfmt.h"
43 #include "libavutil/rational.h"
44 #include "libavutil/thread.h"
45 #include "libavutil/threadmessage.h"
47 #include "libswresample/swresample.h"
50 #define VSYNC_PASSTHROUGH 0
53 #define VSYNC_VSCFR 0xfe
54 #define VSYNC_DROP 0xff
56 #define MAX_STREAMS 1024 /* arbitrary sanity check value */
67 typedef struct HWAccel {
69 int (*init)(AVCodecContext *s);
71 enum AVPixelFormat pix_fmt;
74 typedef struct HWDevice {
76 enum AVHWDeviceType type;
77 AVBufferRef *device_ref;
80 /* select an input stream for an output stream */
81 typedef struct StreamMap {
82 int disabled; /* 1 is this mapping is disabled by a negative map */
86 int sync_stream_index;
87 char *linklabel; /* name of an output link, for mapping lavfi outputs */
91 int file_idx, stream_idx, channel_idx; // input
92 int ofile_idx, ostream_idx; // output
95 typedef struct OptionsContext {
98 /* input/output options */
100 int64_t start_time_eof;
104 SpecifierOpt *codec_names;
106 SpecifierOpt *audio_channels;
107 int nb_audio_channels;
108 SpecifierOpt *audio_sample_rate;
109 int nb_audio_sample_rate;
110 SpecifierOpt *frame_rates;
112 SpecifierOpt *frame_sizes;
114 SpecifierOpt *frame_pix_fmts;
115 int nb_frame_pix_fmts;
118 int64_t input_ts_offset;
122 int thread_queue_size;
124 SpecifierOpt *ts_scale;
126 SpecifierOpt *dump_attachment;
127 int nb_dump_attachment;
128 SpecifierOpt *hwaccels;
130 SpecifierOpt *hwaccel_devices;
131 int nb_hwaccel_devices;
132 SpecifierOpt *hwaccel_output_formats;
133 int nb_hwaccel_output_formats;
134 SpecifierOpt *autorotate;
138 StreamMap *stream_maps;
140 AudioChannelMap *audio_channel_maps; /* one info entry per -map_channel */
141 int nb_audio_channel_maps; /* number of (valid) -map_channel settings */
142 int metadata_global_manual;
143 int metadata_streams_manual;
144 int metadata_chapters_manual;
145 const char **attachments;
148 int chapters_input_file;
150 int64_t recording_time;
152 uint64_t limit_filesize;
160 int subtitle_disable;
163 /* indexed by output file stream index */
167 SpecifierOpt *metadata;
169 SpecifierOpt *max_frames;
171 SpecifierOpt *bitstream_filters;
172 int nb_bitstream_filters;
173 SpecifierOpt *codec_tags;
175 SpecifierOpt *sample_fmts;
177 SpecifierOpt *qscale;
179 SpecifierOpt *forced_key_frames;
180 int nb_forced_key_frames;
181 SpecifierOpt *force_fps;
183 SpecifierOpt *frame_aspect_ratios;
184 int nb_frame_aspect_ratios;
185 SpecifierOpt *rc_overrides;
187 SpecifierOpt *intra_matrices;
188 int nb_intra_matrices;
189 SpecifierOpt *inter_matrices;
190 int nb_inter_matrices;
191 SpecifierOpt *chroma_intra_matrices;
192 int nb_chroma_intra_matrices;
193 SpecifierOpt *top_field_first;
194 int nb_top_field_first;
195 SpecifierOpt *metadata_map;
197 SpecifierOpt *presets;
199 SpecifierOpt *copy_initial_nonkeyframes;
200 int nb_copy_initial_nonkeyframes;
201 SpecifierOpt *copy_prior_start;
202 int nb_copy_prior_start;
203 SpecifierOpt *filters;
205 SpecifierOpt *filter_scripts;
206 int nb_filter_scripts;
207 SpecifierOpt *reinit_filters;
208 int nb_reinit_filters;
209 SpecifierOpt *fix_sub_duration;
210 int nb_fix_sub_duration;
211 SpecifierOpt *canvas_sizes;
215 SpecifierOpt *passlogfiles;
217 SpecifierOpt *max_muxing_queue_size;
218 int nb_max_muxing_queue_size;
219 SpecifierOpt *guess_layout_max;
220 int nb_guess_layout_max;
223 SpecifierOpt *discard;
225 SpecifierOpt *disposition;
227 SpecifierOpt *program;
229 SpecifierOpt *time_bases;
231 SpecifierOpt *enc_time_bases;
232 int nb_enc_time_bases;
235 typedef struct InputFilter {
236 AVFilterContext *filter;
237 struct InputStream *ist;
238 struct FilterGraph *graph;
240 enum AVMediaType type; // AVMEDIA_TYPE_SUBTITLE for sub2video
242 AVFifoBuffer *frame_queue;
244 // parameters configured for this input
248 AVRational sample_aspect_ratio;
252 uint64_t channel_layout;
254 AVBufferRef *hw_frames_ctx;
259 typedef struct OutputFilter {
260 AVFilterContext *filter;
261 struct OutputStream *ost;
262 struct FilterGraph *graph;
265 /* temporary storage until stream maps are processed */
266 AVFilterInOut *out_tmp;
267 enum AVMediaType type;
269 /* desired output stream properties */
271 AVRational frame_rate;
274 uint64_t channel_layout;
276 // those are only set if no format is specified and the encoder gives us multiple options
278 uint64_t *channel_layouts;
282 typedef struct FilterGraph {
284 const char *graph_desc;
286 AVFilterGraph *graph;
289 InputFilter **inputs;
291 OutputFilter **outputs;
295 typedef struct InputStream {
298 int discard; /* true if stream data should be discarded */
299 int user_set_discard;
300 int decoding_needed; /* non zero if the packets must be decoded in 'raw_fifo', see DECODING_FOR_* */
301 #define DECODING_FOR_OST 1
302 #define DECODING_FOR_FILTER 2
304 AVCodecContext *dec_ctx;
306 AVFrame *decoded_frame;
307 AVFrame *filter_frame; /* a ref of decoded_frame, to be sent to filters */
309 int64_t start; /* time when read started */
310 /* predicted dts of the next packet read for this stream or (when there are
311 * several frames in a packet) of the next frame in current packet (in AV_TIME_BASE units) */
313 int64_t dts; ///< dts of the last packet read for this stream (in AV_TIME_BASE units)
315 int64_t next_pts; ///< synthetic pts for the next decode frame (in AV_TIME_BASE units)
316 int64_t pts; ///< current pts of the decoded frame (in AV_TIME_BASE units)
317 int wrap_correction_done;
319 int64_t filter_in_rescale_delta_last;
321 int64_t min_pts; /* pts with the smallest value in a current stream */
322 int64_t max_pts; /* pts with the higher value in a current stream */
324 // when forcing constant input framerate through -r,
325 // this contains the pts that will be given to the next decoded frame
326 int64_t cfr_next_pts;
328 int64_t nb_samples; /* number of samples in the last decoded audio frame before looping */
332 AVDictionary *decoder_opts;
333 AVRational framerate; /* framerate forced with -r */
335 int guess_layout_max;
339 int fix_sub_duration;
340 struct { /* previous decoded subtitle and related variables */
349 AVFifoBuffer *sub_queue; ///< queue of AVSubtitle* before filter init
356 /* decoded data from this stream goes into all those filters
357 * currently video and audio only */
358 InputFilter **filters;
363 /* hwaccel options */
364 enum HWAccelID hwaccel_id;
365 enum AVHWDeviceType hwaccel_device_type;
366 char *hwaccel_device;
367 enum AVPixelFormat hwaccel_output_format;
369 /* hwaccel context */
371 void (*hwaccel_uninit)(AVCodecContext *s);
372 int (*hwaccel_get_buffer)(AVCodecContext *s, AVFrame *frame, int flags);
373 int (*hwaccel_retrieve_data)(AVCodecContext *s, AVFrame *frame);
374 enum AVPixelFormat hwaccel_pix_fmt;
375 enum AVPixelFormat hwaccel_retrieved_pix_fmt;
376 AVBufferRef *hw_frames_ctx;
379 // combined size of all the packets read
381 /* number of packets successfully read for this stream */
383 // number of frames/samples retrieved from the decoder
384 uint64_t frames_decoded;
385 uint64_t samples_decoded;
393 typedef struct InputFile {
394 AVFormatContext *ctx;
395 int eof_reached; /* true if eof reached */
396 int eagain; /* true if last read attempt returned EAGAIN */
397 int ist_index; /* index of first stream in input_streams */
398 int loop; /* set number of times input stream should be looped */
399 int64_t duration; /* actual duration of the longest stream in a file
400 at the moment when looping happens */
401 AVRational time_base; /* time base of the duration */
402 int64_t input_ts_offset;
406 int64_t start_time; /* user-specified start time in AV_TIME_BASE or AV_NOPTS_VALUE */
408 int64_t recording_time;
409 int nb_streams; /* number of stream that ffmpeg is aware of; may be different
410 from ctx.nb_streams if new streams appear during av_read_frame() */
411 int nb_streams_warn; /* number of streams that the user was warned of */
416 AVThreadMessageQueue *in_thread_queue;
417 pthread_t thread; /* thread reading from this file */
418 int non_blocking; /* reading packets from the thread should not block */
419 int joined; /* the thread has been joined */
420 int thread_queue_size; /* maximum number of queued packets */
424 enum forced_keyframes_const {
433 #define ABORT_ON_FLAG_EMPTY_OUTPUT (1 << 0)
435 extern const char *const forced_keyframes_const_names[];
438 ENCODER_FINISHED = 1,
442 typedef struct OutputStream {
443 int file_index; /* file index */
444 int index; /* stream index in the output file */
445 int source_index; /* InputStream index */
446 AVStream *st; /* stream in the output file */
447 int encoding_needed; /* true if encoding needed for this stream */
449 /* input pts and corresponding output pts
451 struct InputStream *sync_ist; /* input stream to sync against */
452 int64_t sync_opts; /* output frame counter, could be changed to some true timestamp */ // FIXME look at frame_number
453 /* pts of the first frame encoded for this stream, used for limiting
456 /* dts of the last packet sent to the muxer */
457 int64_t last_mux_dts;
458 // the timebase of the packets sent to the muxer
459 AVRational mux_timebase;
460 AVRational enc_timebase;
462 int nb_bitstream_filters;
463 AVBSFContext **bsf_ctx;
465 AVCodecContext *enc_ctx;
466 AVCodecParameters *ref_par; /* associated input codec parameters with encoders options applied */
469 AVFrame *filtered_frame;
472 int last_nb0_frames[3];
477 AVRational frame_rate;
481 int rotate_overridden;
482 double rotate_override_value;
484 AVRational frame_aspect_ratio;
486 /* forced key frames */
487 int64_t *forced_kf_pts;
490 char *forced_keyframes;
491 AVExpr *forced_keyframes_pexpr;
492 double forced_keyframes_expr_const_values[FKF_NB];
495 int *audio_channels_map; /* list of the channels id to pick from the source stream */
496 int audio_channels_mapped; /* number of channels in audio_channels_map */
498 char *logfile_prefix;
501 OutputFilter *filter;
503 char *filters; ///< filtergraph associated to the -filter option
504 char *filters_script; ///< filtergraph script associated to the -filter_script option
506 AVDictionary *encoder_opts;
507 AVDictionary *sws_dict;
508 AVDictionary *swr_opts;
509 AVDictionary *resample_opts;
511 OSTFinished finished; /* no more packets should be written for this stream */
512 int unavailable; /* true if the steram is unavailable (possibly temporarily) */
515 // init_output_stream() has been called for this stream
516 // The encoder and the bitstream filters have been initialized and the stream
517 // parameters are set in the AVStream.
522 const char *attachment_filename;
523 int copy_initial_nonkeyframes;
524 int copy_prior_start;
529 AVCodecParserContext *parser;
530 AVCodecContext *parser_avctx;
533 // combined size of all the packets written
535 // number of packets send to the muxer
536 uint64_t packets_written;
537 // number of frames/samples sent to the encoder
538 uint64_t frames_encoded;
539 uint64_t samples_encoded;
541 /* packet quality factor */
544 int max_muxing_queue_size;
546 /* the packets are buffered here until the muxer is ready to be initialized */
547 AVFifoBuffer *muxing_queue;
549 /* packet picture type */
552 /* frame encode sum of squared error values */
556 typedef struct OutputFile {
557 AVFormatContext *ctx;
559 int ost_index; /* index of the first stream in output_streams */
560 int64_t recording_time; ///< desired length of the resulting file in microseconds == AV_TIME_BASE units
561 int64_t start_time; ///< start time in microseconds == AV_TIME_BASE units
562 uint64_t limit_filesize; /* filesize limit expressed in bytes */
569 extern InputStream **input_streams;
570 extern int nb_input_streams;
571 extern InputFile **input_files;
572 extern int nb_input_files;
574 extern OutputStream **output_streams;
575 extern int nb_output_streams;
576 extern OutputFile **output_files;
577 extern int nb_output_files;
579 extern FilterGraph **filtergraphs;
580 extern int nb_filtergraphs;
582 extern char *vstats_filename;
583 extern char *sdp_filename;
585 extern float audio_drift_threshold;
586 extern float dts_delta_threshold;
587 extern float dts_error_threshold;
589 extern int audio_volume;
590 extern int audio_sync_method;
591 extern int video_sync_method;
592 extern float frame_drop_threshold;
593 extern int do_benchmark;
594 extern int do_benchmark_all;
595 extern int do_deinterlace;
596 extern int do_hex_dump;
597 extern int do_pkt_dump;
599 extern int start_at_zero;
602 extern int exit_on_error;
603 extern int abort_on_flags;
604 extern int print_stats;
606 extern int stdin_interaction;
607 extern int frame_bits_per_raw_sample;
608 extern AVIOContext *progress_avio;
609 extern float max_error_rate;
610 extern char *videotoolbox_pixfmt;
612 extern int filter_nbthreads;
613 extern int filter_complex_nbthreads;
614 extern int vstats_version;
616 extern const AVIOInterruptCB int_cb;
618 extern const OptionDef options[];
619 extern const HWAccel hwaccels[];
620 extern AVBufferRef *hw_device_ctx;
622 extern char *qsv_device;
624 extern HWDevice *filter_hw_device;
627 void term_init(void);
628 void term_exit(void);
630 void reset_options(OptionsContext *o, int is_input);
631 void show_usage(void);
633 void opt_output_file(void *optctx, const char *filename);
635 void remove_avoptions(AVDictionary **a, AVDictionary *b);
636 void assert_avoptions(AVDictionary *m);
638 int guess_input_channel_layout(InputStream *ist);
640 enum AVPixelFormat choose_pixel_fmt(AVStream *st, AVCodecContext *avctx, AVCodec *codec, enum AVPixelFormat target);
641 void choose_sample_fmt(AVStream *st, AVCodec *codec);
643 int configure_filtergraph(FilterGraph *fg);
644 int configure_output_filter(FilterGraph *fg, OutputFilter *ofilter, AVFilterInOut *out);
645 void check_filter_outputs(void);
646 int ist_in_filtergraph(FilterGraph *fg, InputStream *ist);
647 int filtergraph_is_simple(FilterGraph *fg);
648 int init_simple_filtergraph(InputStream *ist, OutputStream *ost);
649 int init_complex_filtergraph(FilterGraph *fg);
651 void sub2video_update(InputStream *ist, AVSubtitle *sub);
653 int ifilter_parameters_from_frame(InputFilter *ifilter, const AVFrame *frame);
655 int ffmpeg_parse_options(int argc, char **argv);
657 int videotoolbox_init(AVCodecContext *s);
658 int qsv_init(AVCodecContext *s);
659 int cuvid_init(AVCodecContext *s);
661 HWDevice *hw_device_get_by_name(const char *name);
662 int hw_device_init_from_string(const char *arg, HWDevice **dev);
663 void hw_device_free_all(void);
665 int hw_device_setup_for_decode(InputStream *ist);
666 int hw_device_setup_for_encode(OutputStream *ost);
668 int hwaccel_decode_init(AVCodecContext *avctx);
670 #endif /* FFTOOLS_FFMPEG_H */