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