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
34 #include "libavformat/avformat.h"
35 #include "libavformat/avio.h"
37 #include "libavcodec/avcodec.h"
39 #include "libavfilter/avfilter.h"
41 #include "libavutil/avutil.h"
42 #include "libavutil/dict.h"
43 #include "libavutil/eval.h"
44 #include "libavutil/fifo.h"
45 #include "libavutil/hwcontext.h"
46 #include "libavutil/pixfmt.h"
47 #include "libavutil/rational.h"
48 #include "libavutil/threadmessage.h"
50 #include "libswresample/swresample.h"
53 #define VSYNC_PASSTHROUGH 0
56 #define VSYNC_VSCFR 0xfe
57 #define VSYNC_DROP 0xff
59 #define MAX_STREAMS 1024 /* arbitrary sanity check value */
74 typedef struct HWAccel {
76 int (*init)(AVCodecContext *s);
78 enum AVPixelFormat pix_fmt;
79 enum AVHWDeviceType device_type;
82 typedef struct HWDevice {
84 enum AVHWDeviceType type;
85 AVBufferRef *device_ref;
88 /* select an input stream for an output stream */
89 typedef struct StreamMap {
90 int disabled; /* 1 is this mapping is disabled by a negative map */
94 int sync_stream_index;
95 char *linklabel; /* name of an output link, for mapping lavfi outputs */
99 int file_idx, stream_idx, channel_idx; // input
100 int ofile_idx, ostream_idx; // output
103 typedef struct OptionsContext {
106 /* input/output options */
108 int64_t start_time_eof;
112 SpecifierOpt *codec_names;
114 SpecifierOpt *audio_channels;
115 int nb_audio_channels;
116 SpecifierOpt *audio_sample_rate;
117 int nb_audio_sample_rate;
118 SpecifierOpt *frame_rates;
120 SpecifierOpt *frame_sizes;
122 SpecifierOpt *frame_pix_fmts;
123 int nb_frame_pix_fmts;
126 int64_t input_ts_offset;
130 int thread_queue_size;
132 SpecifierOpt *ts_scale;
134 SpecifierOpt *dump_attachment;
135 int nb_dump_attachment;
136 SpecifierOpt *hwaccels;
138 SpecifierOpt *hwaccel_devices;
139 int nb_hwaccel_devices;
140 SpecifierOpt *hwaccel_output_formats;
141 int nb_hwaccel_output_formats;
142 SpecifierOpt *autorotate;
146 StreamMap *stream_maps;
148 AudioChannelMap *audio_channel_maps; /* one info entry per -map_channel */
149 int nb_audio_channel_maps; /* number of (valid) -map_channel settings */
150 int metadata_global_manual;
151 int metadata_streams_manual;
152 int metadata_chapters_manual;
153 const char **attachments;
156 int chapters_input_file;
158 int64_t recording_time;
160 uint64_t limit_filesize;
167 int subtitle_disable;
170 /* indexed by output file stream index */
174 SpecifierOpt *metadata;
176 SpecifierOpt *max_frames;
178 SpecifierOpt *bitstream_filters;
179 int nb_bitstream_filters;
180 SpecifierOpt *codec_tags;
182 SpecifierOpt *sample_fmts;
184 SpecifierOpt *qscale;
186 SpecifierOpt *forced_key_frames;
187 int nb_forced_key_frames;
188 SpecifierOpt *force_fps;
190 SpecifierOpt *frame_aspect_ratios;
191 int nb_frame_aspect_ratios;
192 SpecifierOpt *rc_overrides;
194 SpecifierOpt *intra_matrices;
195 int nb_intra_matrices;
196 SpecifierOpt *inter_matrices;
197 int nb_inter_matrices;
198 SpecifierOpt *chroma_intra_matrices;
199 int nb_chroma_intra_matrices;
200 SpecifierOpt *top_field_first;
201 int nb_top_field_first;
202 SpecifierOpt *metadata_map;
204 SpecifierOpt *presets;
206 SpecifierOpt *copy_initial_nonkeyframes;
207 int nb_copy_initial_nonkeyframes;
208 SpecifierOpt *copy_prior_start;
209 int nb_copy_prior_start;
210 SpecifierOpt *filters;
212 SpecifierOpt *filter_scripts;
213 int nb_filter_scripts;
214 SpecifierOpt *reinit_filters;
215 int nb_reinit_filters;
216 SpecifierOpt *fix_sub_duration;
217 int nb_fix_sub_duration;
218 SpecifierOpt *canvas_sizes;
222 SpecifierOpt *passlogfiles;
224 SpecifierOpt *max_muxing_queue_size;
225 int nb_max_muxing_queue_size;
226 SpecifierOpt *guess_layout_max;
227 int nb_guess_layout_max;
230 SpecifierOpt *discard;
232 SpecifierOpt *disposition;
234 SpecifierOpt *program;
236 SpecifierOpt *time_bases;
238 SpecifierOpt *enc_time_bases;
239 int nb_enc_time_bases;
242 typedef struct InputFilter {
243 AVFilterContext *filter;
244 struct InputStream *ist;
245 struct FilterGraph *graph;
247 enum AVMediaType type; // AVMEDIA_TYPE_SUBTITLE for sub2video
249 AVFifoBuffer *frame_queue;
251 // parameters configured for this input
255 AVRational sample_aspect_ratio;
259 uint64_t channel_layout;
261 AVBufferRef *hw_frames_ctx;
266 typedef struct OutputFilter {
267 AVFilterContext *filter;
268 struct OutputStream *ost;
269 struct FilterGraph *graph;
272 /* temporary storage until stream maps are processed */
273 AVFilterInOut *out_tmp;
274 enum AVMediaType type;
276 /* desired output stream properties */
278 AVRational frame_rate;
281 uint64_t channel_layout;
283 // those are only set if no format is specified and the encoder gives us multiple options
285 uint64_t *channel_layouts;
289 typedef struct FilterGraph {
291 const char *graph_desc;
293 AVFilterGraph *graph;
296 InputFilter **inputs;
298 OutputFilter **outputs;
302 typedef struct InputStream {
305 int discard; /* true if stream data should be discarded */
306 int user_set_discard;
307 int decoding_needed; /* non zero if the packets must be decoded in 'raw_fifo', see DECODING_FOR_* */
308 #define DECODING_FOR_OST 1
309 #define DECODING_FOR_FILTER 2
311 AVCodecContext *dec_ctx;
313 AVFrame *decoded_frame;
314 AVFrame *filter_frame; /* a ref of decoded_frame, to be sent to filters */
316 int64_t start; /* time when read started */
317 /* predicted dts of the next packet read for this stream or (when there are
318 * several frames in a packet) of the next frame in current packet (in AV_TIME_BASE units) */
320 int64_t dts; ///< dts of the last packet read for this stream (in AV_TIME_BASE units)
322 int64_t next_pts; ///< synthetic pts for the next decode frame (in AV_TIME_BASE units)
323 int64_t pts; ///< current pts of the decoded frame (in AV_TIME_BASE units)
324 int wrap_correction_done;
326 int64_t filter_in_rescale_delta_last;
328 int64_t min_pts; /* pts with the smallest value in a current stream */
329 int64_t max_pts; /* pts with the higher value in a current stream */
331 // when forcing constant input framerate through -r,
332 // this contains the pts that will be given to the next decoded frame
333 int64_t cfr_next_pts;
335 int64_t nb_samples; /* number of samples in the last decoded audio frame before looping */
339 AVDictionary *decoder_opts;
340 AVRational framerate; /* framerate forced with -r */
342 int guess_layout_max;
346 int fix_sub_duration;
347 struct { /* previous decoded subtitle and related variables */
356 AVFifoBuffer *sub_queue; ///< queue of AVSubtitle* before filter init
363 /* decoded data from this stream goes into all those filters
364 * currently video and audio only */
365 InputFilter **filters;
370 /* hwaccel options */
371 enum HWAccelID hwaccel_id;
372 char *hwaccel_device;
373 enum AVPixelFormat hwaccel_output_format;
375 /* hwaccel context */
376 enum HWAccelID active_hwaccel_id;
378 void (*hwaccel_uninit)(AVCodecContext *s);
379 int (*hwaccel_get_buffer)(AVCodecContext *s, AVFrame *frame, int flags);
380 int (*hwaccel_retrieve_data)(AVCodecContext *s, AVFrame *frame);
381 enum AVPixelFormat hwaccel_pix_fmt;
382 enum AVPixelFormat hwaccel_retrieved_pix_fmt;
383 AVBufferRef *hw_frames_ctx;
386 // combined size of all the packets read
388 /* number of packets successfully read for this stream */
390 // number of frames/samples retrieved from the decoder
391 uint64_t frames_decoded;
392 uint64_t samples_decoded;
400 typedef struct InputFile {
401 AVFormatContext *ctx;
402 int eof_reached; /* true if eof reached */
403 int eagain; /* true if last read attempt returned EAGAIN */
404 int ist_index; /* index of first stream in input_streams */
405 int loop; /* set number of times input stream should be looped */
406 int64_t duration; /* actual duration of the longest stream in a file
407 at the moment when looping happens */
408 AVRational time_base; /* time base of the duration */
409 int64_t input_ts_offset;
413 int64_t start_time; /* user-specified start time in AV_TIME_BASE or AV_NOPTS_VALUE */
415 int64_t recording_time;
416 int nb_streams; /* number of stream that ffmpeg is aware of; may be different
417 from ctx.nb_streams if new streams appear during av_read_frame() */
418 int nb_streams_warn; /* number of streams that the user was warned of */
423 AVThreadMessageQueue *in_thread_queue;
424 pthread_t thread; /* thread reading from this file */
425 int non_blocking; /* reading packets from the thread should not block */
426 int joined; /* the thread has been joined */
427 int thread_queue_size; /* maximum number of queued packets */
431 enum forced_keyframes_const {
440 #define ABORT_ON_FLAG_EMPTY_OUTPUT (1 << 0)
442 extern const char *const forced_keyframes_const_names[];
445 ENCODER_FINISHED = 1,
449 typedef struct OutputStream {
450 int file_index; /* file index */
451 int index; /* stream index in the output file */
452 int source_index; /* InputStream index */
453 AVStream *st; /* stream in the output file */
454 int encoding_needed; /* true if encoding needed for this stream */
456 /* input pts and corresponding output pts
458 struct InputStream *sync_ist; /* input stream to sync against */
459 int64_t sync_opts; /* output frame counter, could be changed to some true timestamp */ // FIXME look at frame_number
460 /* pts of the first frame encoded for this stream, used for limiting
463 /* dts of the last packet sent to the muxer */
464 int64_t last_mux_dts;
465 // the timebase of the packets sent to the muxer
466 AVRational mux_timebase;
467 AVRational enc_timebase;
469 int nb_bitstream_filters;
470 AVBSFContext **bsf_ctx;
472 AVCodecContext *enc_ctx;
473 AVCodecParameters *ref_par; /* associated input codec parameters with encoders options applied */
476 AVFrame *filtered_frame;
479 int last_nb0_frames[3];
484 AVRational frame_rate;
488 int rotate_overridden;
489 double rotate_override_value;
491 AVRational frame_aspect_ratio;
493 /* forced key frames */
494 int64_t *forced_kf_pts;
497 char *forced_keyframes;
498 AVExpr *forced_keyframes_pexpr;
499 double forced_keyframes_expr_const_values[FKF_NB];
502 int *audio_channels_map; /* list of the channels id to pick from the source stream */
503 int audio_channels_mapped; /* number of channels in audio_channels_map */
505 char *logfile_prefix;
508 OutputFilter *filter;
510 char *filters; ///< filtergraph associated to the -filter option
511 char *filters_script; ///< filtergraph script associated to the -filter_script option
513 AVDictionary *encoder_opts;
514 AVDictionary *sws_dict;
515 AVDictionary *swr_opts;
516 AVDictionary *resample_opts;
518 OSTFinished finished; /* no more packets should be written for this stream */
519 int unavailable; /* true if the steram is unavailable (possibly temporarily) */
522 // init_output_stream() has been called for this stream
523 // The encoder and the bitstream filters have been initialized and the stream
524 // parameters are set in the AVStream.
529 const char *attachment_filename;
530 int copy_initial_nonkeyframes;
531 int copy_prior_start;
536 AVCodecParserContext *parser;
537 AVCodecContext *parser_avctx;
540 // combined size of all the packets written
542 // number of packets send to the muxer
543 uint64_t packets_written;
544 // number of frames/samples sent to the encoder
545 uint64_t frames_encoded;
546 uint64_t samples_encoded;
548 /* packet quality factor */
551 int max_muxing_queue_size;
553 /* the packets are buffered here until the muxer is ready to be initialized */
554 AVFifoBuffer *muxing_queue;
556 /* packet picture type */
559 /* frame encode sum of squared error values */
563 typedef struct OutputFile {
564 AVFormatContext *ctx;
566 int ost_index; /* index of the first stream in output_streams */
567 int64_t recording_time; ///< desired length of the resulting file in microseconds == AV_TIME_BASE units
568 int64_t start_time; ///< start time in microseconds == AV_TIME_BASE units
569 uint64_t limit_filesize; /* filesize limit expressed in bytes */
576 extern InputStream **input_streams;
577 extern int nb_input_streams;
578 extern InputFile **input_files;
579 extern int nb_input_files;
581 extern OutputStream **output_streams;
582 extern int nb_output_streams;
583 extern OutputFile **output_files;
584 extern int nb_output_files;
586 extern FilterGraph **filtergraphs;
587 extern int nb_filtergraphs;
589 extern char *vstats_filename;
590 extern char *sdp_filename;
592 extern float audio_drift_threshold;
593 extern float dts_delta_threshold;
594 extern float dts_error_threshold;
596 extern int audio_volume;
597 extern int audio_sync_method;
598 extern int video_sync_method;
599 extern float frame_drop_threshold;
600 extern int do_benchmark;
601 extern int do_benchmark_all;
602 extern int do_deinterlace;
603 extern int do_hex_dump;
604 extern int do_pkt_dump;
606 extern int start_at_zero;
609 extern int exit_on_error;
610 extern int abort_on_flags;
611 extern int print_stats;
613 extern int stdin_interaction;
614 extern int frame_bits_per_raw_sample;
615 extern AVIOContext *progress_avio;
616 extern float max_error_rate;
617 extern char *videotoolbox_pixfmt;
619 extern int filter_nbthreads;
620 extern int filter_complex_nbthreads;
621 extern int vstats_version;
623 extern const AVIOInterruptCB int_cb;
625 extern const OptionDef options[];
626 extern const HWAccel hwaccels[];
627 extern int hwaccel_lax_profile_check;
628 extern AVBufferRef *hw_device_ctx;
630 extern char *qsv_device;
632 extern HWDevice *filter_hw_device;
635 void term_init(void);
636 void term_exit(void);
638 void reset_options(OptionsContext *o, int is_input);
639 void show_usage(void);
641 void opt_output_file(void *optctx, const char *filename);
643 void remove_avoptions(AVDictionary **a, AVDictionary *b);
644 void assert_avoptions(AVDictionary *m);
646 int guess_input_channel_layout(InputStream *ist);
648 enum AVPixelFormat choose_pixel_fmt(AVStream *st, AVCodecContext *avctx, AVCodec *codec, enum AVPixelFormat target);
649 void choose_sample_fmt(AVStream *st, AVCodec *codec);
651 int configure_filtergraph(FilterGraph *fg);
652 int configure_output_filter(FilterGraph *fg, OutputFilter *ofilter, AVFilterInOut *out);
653 void check_filter_outputs(void);
654 int ist_in_filtergraph(FilterGraph *fg, InputStream *ist);
655 int filtergraph_is_simple(FilterGraph *fg);
656 int init_simple_filtergraph(InputStream *ist, OutputStream *ost);
657 int init_complex_filtergraph(FilterGraph *fg);
659 void sub2video_update(InputStream *ist, AVSubtitle *sub);
661 int ifilter_parameters_from_frame(InputFilter *ifilter, const AVFrame *frame);
663 int ffmpeg_parse_options(int argc, char **argv);
665 int vda_init(AVCodecContext *s);
666 int videotoolbox_init(AVCodecContext *s);
667 int qsv_init(AVCodecContext *s);
668 int cuvid_init(AVCodecContext *s);
670 HWDevice *hw_device_get_by_name(const char *name);
671 int hw_device_init_from_string(const char *arg, HWDevice **dev);
672 void hw_device_free_all(void);
674 int hw_device_setup_for_decode(InputStream *ist);
675 int hw_device_setup_for_encode(OutputStream *ost);
677 int hwaccel_decode_init(AVCodecContext *avctx);
679 #endif /* FFMPEG_H */