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 */
66 typedef struct HWAccel {
68 int (*init)(AVCodecContext *s);
70 enum AVPixelFormat pix_fmt;
73 typedef struct HWDevice {
75 enum AVHWDeviceType type;
76 AVBufferRef *device_ref;
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 */
85 int sync_stream_index;
86 char *linklabel; /* name of an output link, for mapping lavfi outputs */
90 int file_idx, stream_idx, channel_idx; // input
91 int ofile_idx, ostream_idx; // output
94 typedef struct OptionsContext {
97 /* input/output options */
99 int64_t start_time_eof;
103 SpecifierOpt *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;
111 SpecifierOpt *frame_sizes;
113 SpecifierOpt *frame_pix_fmts;
114 int nb_frame_pix_fmts;
117 int64_t input_ts_offset;
121 int thread_queue_size;
123 SpecifierOpt *ts_scale;
125 SpecifierOpt *dump_attachment;
126 int nb_dump_attachment;
127 SpecifierOpt *hwaccels;
129 SpecifierOpt *hwaccel_devices;
130 int nb_hwaccel_devices;
131 SpecifierOpt *hwaccel_output_formats;
132 int nb_hwaccel_output_formats;
133 SpecifierOpt *autorotate;
137 StreamMap *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;
147 int chapters_input_file;
149 int64_t recording_time;
151 uint64_t limit_filesize;
159 int subtitle_disable;
162 /* indexed by output file stream index */
166 SpecifierOpt *metadata;
168 SpecifierOpt *max_frames;
170 SpecifierOpt *bitstream_filters;
171 int nb_bitstream_filters;
172 SpecifierOpt *codec_tags;
174 SpecifierOpt *sample_fmts;
176 SpecifierOpt *qscale;
178 SpecifierOpt *forced_key_frames;
179 int nb_forced_key_frames;
180 SpecifierOpt *force_fps;
182 SpecifierOpt *frame_aspect_ratios;
183 int nb_frame_aspect_ratios;
184 SpecifierOpt *rc_overrides;
186 SpecifierOpt *intra_matrices;
187 int nb_intra_matrices;
188 SpecifierOpt *inter_matrices;
189 int nb_inter_matrices;
190 SpecifierOpt *chroma_intra_matrices;
191 int nb_chroma_intra_matrices;
192 SpecifierOpt *top_field_first;
193 int nb_top_field_first;
194 SpecifierOpt *metadata_map;
196 SpecifierOpt *presets;
198 SpecifierOpt *copy_initial_nonkeyframes;
199 int nb_copy_initial_nonkeyframes;
200 SpecifierOpt *copy_prior_start;
201 int nb_copy_prior_start;
202 SpecifierOpt *filters;
204 SpecifierOpt *filter_scripts;
205 int nb_filter_scripts;
206 SpecifierOpt *reinit_filters;
207 int nb_reinit_filters;
208 SpecifierOpt *fix_sub_duration;
209 int nb_fix_sub_duration;
210 SpecifierOpt *canvas_sizes;
214 SpecifierOpt *passlogfiles;
216 SpecifierOpt *max_muxing_queue_size;
217 int nb_max_muxing_queue_size;
218 SpecifierOpt *guess_layout_max;
219 int nb_guess_layout_max;
222 SpecifierOpt *discard;
224 SpecifierOpt *disposition;
226 SpecifierOpt *program;
228 SpecifierOpt *time_bases;
230 SpecifierOpt *enc_time_bases;
231 int nb_enc_time_bases;
234 typedef struct InputFilter {
235 AVFilterContext *filter;
236 struct InputStream *ist;
237 struct FilterGraph *graph;
239 enum AVMediaType type; // AVMEDIA_TYPE_SUBTITLE for sub2video
241 AVFifoBuffer *frame_queue;
243 // parameters configured for this input
247 AVRational sample_aspect_ratio;
251 uint64_t channel_layout;
253 AVBufferRef *hw_frames_ctx;
258 typedef struct OutputFilter {
259 AVFilterContext *filter;
260 struct OutputStream *ost;
261 struct FilterGraph *graph;
264 /* temporary storage until stream maps are processed */
265 AVFilterInOut *out_tmp;
266 enum AVMediaType type;
268 /* desired output stream properties */
270 AVRational frame_rate;
273 uint64_t channel_layout;
275 // those are only set if no format is specified and the encoder gives us multiple options
277 uint64_t *channel_layouts;
281 typedef struct FilterGraph {
283 const char *graph_desc;
285 AVFilterGraph *graph;
288 InputFilter **inputs;
290 OutputFilter **outputs;
294 typedef struct InputStream {
297 int discard; /* true if stream data should be discarded */
298 int user_set_discard;
299 int decoding_needed; /* non zero if the packets must be decoded in 'raw_fifo', see DECODING_FOR_* */
300 #define DECODING_FOR_OST 1
301 #define DECODING_FOR_FILTER 2
303 AVCodecContext *dec_ctx;
305 AVFrame *decoded_frame;
306 AVFrame *filter_frame; /* a ref of decoded_frame, to be sent to filters */
308 int64_t start; /* time when read started */
309 /* predicted dts of the next packet read for this stream or (when there are
310 * several frames in a packet) of the next frame in current packet (in AV_TIME_BASE units) */
312 int64_t dts; ///< dts of the last packet read for this stream (in AV_TIME_BASE units)
314 int64_t next_pts; ///< synthetic pts for the next decode frame (in AV_TIME_BASE units)
315 int64_t pts; ///< current pts of the decoded frame (in AV_TIME_BASE units)
316 int wrap_correction_done;
318 int64_t filter_in_rescale_delta_last;
320 int64_t min_pts; /* pts with the smallest value in a current stream */
321 int64_t max_pts; /* pts with the higher value in a current stream */
323 // when forcing constant input framerate through -r,
324 // this contains the pts that will be given to the next decoded frame
325 int64_t cfr_next_pts;
327 int64_t nb_samples; /* number of samples in the last decoded audio frame before looping */
331 AVDictionary *decoder_opts;
332 AVRational framerate; /* framerate forced with -r */
334 int guess_layout_max;
338 int fix_sub_duration;
339 struct { /* previous decoded subtitle and related variables */
348 AVFifoBuffer *sub_queue; ///< queue of AVSubtitle* before filter init
355 /* decoded data from this stream goes into all those filters
356 * currently video and audio only */
357 InputFilter **filters;
362 /* hwaccel options */
363 enum HWAccelID hwaccel_id;
364 enum AVHWDeviceType hwaccel_device_type;
365 char *hwaccel_device;
366 enum AVPixelFormat hwaccel_output_format;
368 /* hwaccel context */
370 void (*hwaccel_uninit)(AVCodecContext *s);
371 int (*hwaccel_get_buffer)(AVCodecContext *s, AVFrame *frame, int flags);
372 int (*hwaccel_retrieve_data)(AVCodecContext *s, AVFrame *frame);
373 enum AVPixelFormat hwaccel_pix_fmt;
374 enum AVPixelFormat hwaccel_retrieved_pix_fmt;
375 AVBufferRef *hw_frames_ctx;
378 // combined size of all the packets read
380 /* number of packets successfully read for this stream */
382 // number of frames/samples retrieved from the decoder
383 uint64_t frames_decoded;
384 uint64_t samples_decoded;
392 typedef struct InputFile {
393 AVFormatContext *ctx;
394 int eof_reached; /* true if eof reached */
395 int eagain; /* true if last read attempt returned EAGAIN */
396 int ist_index; /* index of first stream in input_streams */
397 int loop; /* set number of times input stream should be looped */
398 int64_t duration; /* actual duration of the longest stream in a file
399 at the moment when looping happens */
400 AVRational time_base; /* time base of the duration */
401 int64_t input_ts_offset;
405 int64_t start_time; /* user-specified start time in AV_TIME_BASE or AV_NOPTS_VALUE */
407 int64_t recording_time;
408 int nb_streams; /* number of stream that ffmpeg is aware of; may be different
409 from ctx.nb_streams if new streams appear during av_read_frame() */
410 int nb_streams_warn; /* number of streams that the user was warned of */
415 AVThreadMessageQueue *in_thread_queue;
416 pthread_t thread; /* thread reading from this file */
417 int non_blocking; /* reading packets from the thread should not block */
418 int joined; /* the thread has been joined */
419 int thread_queue_size; /* maximum number of queued packets */
423 enum forced_keyframes_const {
432 #define ABORT_ON_FLAG_EMPTY_OUTPUT (1 << 0)
434 extern const char *const forced_keyframes_const_names[];
437 ENCODER_FINISHED = 1,
441 typedef struct OutputStream {
442 int file_index; /* file index */
443 int index; /* stream index in the output file */
444 int source_index; /* InputStream index */
445 AVStream *st; /* stream in the output file */
446 int encoding_needed; /* true if encoding needed for this stream */
448 /* input pts and corresponding output pts
450 struct InputStream *sync_ist; /* input stream to sync against */
451 int64_t sync_opts; /* output frame counter, could be changed to some true timestamp */ // FIXME look at frame_number
452 /* pts of the first frame encoded for this stream, used for limiting
455 /* dts of the last packet sent to the muxer */
456 int64_t last_mux_dts;
457 // the timebase of the packets sent to the muxer
458 AVRational mux_timebase;
459 AVRational enc_timebase;
461 int nb_bitstream_filters;
462 AVBSFContext **bsf_ctx;
464 AVCodecContext *enc_ctx;
465 AVCodecParameters *ref_par; /* associated input codec parameters with encoders options applied */
468 AVFrame *filtered_frame;
471 int last_nb0_frames[3];
476 AVRational frame_rate;
480 int rotate_overridden;
481 double rotate_override_value;
483 AVRational frame_aspect_ratio;
485 /* forced key frames */
486 int64_t forced_kf_ref_pts;
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;
530 // combined size of all the packets written
532 // number of packets send to the muxer
533 uint64_t packets_written;
534 // number of frames/samples sent to the encoder
535 uint64_t frames_encoded;
536 uint64_t samples_encoded;
538 /* packet quality factor */
541 int max_muxing_queue_size;
543 /* the packets are buffered here until the muxer is ready to be initialized */
544 AVFifoBuffer *muxing_queue;
546 /* packet picture type */
549 /* frame encode sum of squared error values */
553 typedef struct OutputFile {
554 AVFormatContext *ctx;
556 int ost_index; /* index of the first stream in output_streams */
557 int64_t recording_time; ///< desired length of the resulting file in microseconds == AV_TIME_BASE units
558 int64_t start_time; ///< start time in microseconds == AV_TIME_BASE units
559 uint64_t limit_filesize; /* filesize limit expressed in bytes */
566 extern InputStream **input_streams;
567 extern int nb_input_streams;
568 extern InputFile **input_files;
569 extern int nb_input_files;
571 extern OutputStream **output_streams;
572 extern int nb_output_streams;
573 extern OutputFile **output_files;
574 extern int nb_output_files;
576 extern FilterGraph **filtergraphs;
577 extern int nb_filtergraphs;
579 extern char *vstats_filename;
580 extern char *sdp_filename;
582 extern float audio_drift_threshold;
583 extern float dts_delta_threshold;
584 extern float dts_error_threshold;
586 extern int audio_volume;
587 extern int audio_sync_method;
588 extern int video_sync_method;
589 extern float frame_drop_threshold;
590 extern int do_benchmark;
591 extern int do_benchmark_all;
592 extern int do_deinterlace;
593 extern int do_hex_dump;
594 extern int do_pkt_dump;
596 extern int start_at_zero;
599 extern int exit_on_error;
600 extern int abort_on_flags;
601 extern int print_stats;
603 extern int stdin_interaction;
604 extern int frame_bits_per_raw_sample;
605 extern AVIOContext *progress_avio;
606 extern float max_error_rate;
607 extern char *videotoolbox_pixfmt;
609 extern int filter_nbthreads;
610 extern int filter_complex_nbthreads;
611 extern int vstats_version;
613 extern const AVIOInterruptCB int_cb;
615 extern const OptionDef options[];
616 extern const HWAccel hwaccels[];
617 extern AVBufferRef *hw_device_ctx;
619 extern char *qsv_device;
621 extern HWDevice *filter_hw_device;
624 void term_init(void);
625 void term_exit(void);
627 void reset_options(OptionsContext *o, int is_input);
628 void show_usage(void);
630 void opt_output_file(void *optctx, const char *filename);
632 void remove_avoptions(AVDictionary **a, AVDictionary *b);
633 void assert_avoptions(AVDictionary *m);
635 int guess_input_channel_layout(InputStream *ist);
637 enum AVPixelFormat choose_pixel_fmt(AVStream *st, AVCodecContext *avctx, AVCodec *codec, enum AVPixelFormat target);
638 void choose_sample_fmt(AVStream *st, AVCodec *codec);
640 int configure_filtergraph(FilterGraph *fg);
641 int configure_output_filter(FilterGraph *fg, OutputFilter *ofilter, AVFilterInOut *out);
642 void check_filter_outputs(void);
643 int ist_in_filtergraph(FilterGraph *fg, InputStream *ist);
644 int filtergraph_is_simple(FilterGraph *fg);
645 int init_simple_filtergraph(InputStream *ist, OutputStream *ost);
646 int init_complex_filtergraph(FilterGraph *fg);
648 void sub2video_update(InputStream *ist, AVSubtitle *sub);
650 int ifilter_parameters_from_frame(InputFilter *ifilter, const AVFrame *frame);
652 int ffmpeg_parse_options(int argc, char **argv);
654 int videotoolbox_init(AVCodecContext *s);
655 int qsv_init(AVCodecContext *s);
657 HWDevice *hw_device_get_by_name(const char *name);
658 int hw_device_init_from_string(const char *arg, HWDevice **dev);
659 void hw_device_free_all(void);
661 int hw_device_setup_for_decode(InputStream *ist);
662 int hw_device_setup_for_encode(OutputStream *ost);
664 int hwaccel_decode_init(AVCodecContext *avctx);
666 #endif /* FFTOOLS_FFMPEG_H */