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 };
  67
  68 typedef struct HWAccel {
  69     const char *name;
  70     int (*init)(AVCodecContext *s);
  71     enum HWAccelID id;
  72     enum AVPixelFormat pix_fmt;
  73 } HWAccel;
  74
  75 /* select an input stream for an output stream */
  76 typedef struct StreamMap {
  77     int disabled;           /* 1 is this mapping is disabled by a negative map */
  78     int file_index;
  79     int stream_index;
  80     int sync_file_index;
  81     int sync_stream_index;
  82     char *linklabel;       /* name of an output link, for mapping lavfi outputs */
  83 } StreamMap;
  84
  85 typedef struct {
  86     int  file_idx,  stream_idx,  channel_idx; // input
  87     int ofile_idx, ostream_idx;               // output
  88 } AudioChannelMap;
  89
  90 typedef struct OptionsContext {
  91     OptionGroup *g;
  92
  93     /* input/output options */
  94     int64_t start_time;
  95     int seek_timestamp;
  96     const char *format;
  97
  98     SpecifierOpt *codec_names;
  99     int        nb_codec_names;
 100     SpecifierOpt *audio_channels;
 101     int        nb_audio_channels;
 102     SpecifierOpt *audio_sample_rate;
 103     int        nb_audio_sample_rate;
 104     SpecifierOpt *frame_rates;
 105     int        nb_frame_rates;
 106     SpecifierOpt *frame_sizes;
 107     int        nb_frame_sizes;
 108     SpecifierOpt *frame_pix_fmts;
 109     int        nb_frame_pix_fmts;
 110
 111     /* input options */
 112     int64_t input_ts_offset;
 113     int rate_emu;
 114     int accurate_seek;
 115     int thread_queue_size;
 116
 117     SpecifierOpt *ts_scale;
 118     int        nb_ts_scale;
 119     SpecifierOpt *dump_attachment;
 120     int        nb_dump_attachment;
 121     SpecifierOpt *hwaccels;
 122     int        nb_hwaccels;
 123     SpecifierOpt *hwaccel_devices;
 124     int        nb_hwaccel_devices;
 125     SpecifierOpt *autorotate;
 126     int        nb_autorotate;
 127
 128     /* output options */
 129     StreamMap *stream_maps;
 130     int     nb_stream_maps;
 131     AudioChannelMap *audio_channel_maps; /* one info entry per -map_channel */
 132     int           nb_audio_channel_maps; /* number of (valid) -map_channel settings */
 133     int metadata_global_manual;
 134     int metadata_streams_manual;
 135     int metadata_chapters_manual;
 136     const char **attachments;
 137     int       nb_attachments;
 138
 139     int chapters_input_file;
 140
 141     int64_t recording_time;
 142     int64_t stop_time;
 143     uint64_t limit_filesize;
 144     float mux_preload;
 145     float mux_max_delay;
 146     int shortest;
 147
 148     int video_disable;
 149     int audio_disable;
 150     int subtitle_disable;
 151     int data_disable;
 152
 153     /* indexed by output file stream index */
 154     int   *streamid_map;
 155     int nb_streamid_map;
 156
 157     SpecifierOpt *metadata;
 158     int        nb_metadata;
 159     SpecifierOpt *max_frames;
 160     int        nb_max_frames;
 161     SpecifierOpt *bitstream_filters;
 162     int        nb_bitstream_filters;
 163     SpecifierOpt *codec_tags;
 164     int        nb_codec_tags;
 165     SpecifierOpt *sample_fmts;
 166     int        nb_sample_fmts;
 167     SpecifierOpt *qscale;
 168     int        nb_qscale;
 169     SpecifierOpt *forced_key_frames;
 170     int        nb_forced_key_frames;
 171     SpecifierOpt *force_fps;
 172     int        nb_force_fps;
 173     SpecifierOpt *frame_aspect_ratios;
 174     int        nb_frame_aspect_ratios;
 175     SpecifierOpt *rc_overrides;
 176     int        nb_rc_overrides;
 177     SpecifierOpt *intra_matrices;
 178     int        nb_intra_matrices;
 179     SpecifierOpt *inter_matrices;
 180     int        nb_inter_matrices;
 181     SpecifierOpt *chroma_intra_matrices;
 182     int        nb_chroma_intra_matrices;
 183     SpecifierOpt *top_field_first;
 184     int        nb_top_field_first;
 185     SpecifierOpt *metadata_map;
 186     int        nb_metadata_map;
 187     SpecifierOpt *presets;
 188     int        nb_presets;
 189     SpecifierOpt *copy_initial_nonkeyframes;
 190     int        nb_copy_initial_nonkeyframes;
 191     SpecifierOpt *copy_prior_start;
 192     int        nb_copy_prior_start;
 193     SpecifierOpt *filters;
 194     int        nb_filters;
 195     SpecifierOpt *filter_scripts;
 196     int        nb_filter_scripts;
 197     SpecifierOpt *reinit_filters;
 198     int        nb_reinit_filters;
 199     SpecifierOpt *fix_sub_duration;
 200     int        nb_fix_sub_duration;
 201     SpecifierOpt *canvas_sizes;
 202     int        nb_canvas_sizes;
 203     SpecifierOpt *pass;
 204     int        nb_pass;
 205     SpecifierOpt *passlogfiles;
 206     int        nb_passlogfiles;
 207     SpecifierOpt *guess_layout_max;
 208     int        nb_guess_layout_max;
 209     SpecifierOpt *apad;
 210     int        nb_apad;
 211     SpecifierOpt *discard;
 212     int        nb_discard;
 213     SpecifierOpt *disposition;
 214     int        nb_disposition;
 215 } OptionsContext;
 216
 217 typedef struct InputFilter {
 218     AVFilterContext    *filter;
 219     struct InputStream *ist;
 220     struct FilterGraph *graph;
 221     uint8_t            *name;
 222 } InputFilter;
 223
 224 typedef struct OutputFilter {
 225     AVFilterContext     *filter;
 226     struct OutputStream *ost;
 227     struct FilterGraph  *graph;
 228     uint8_t             *name;
 229
 230     /* temporary storage until stream maps are processed */
 231     AVFilterInOut       *out_tmp;
 232 } OutputFilter;
 233
 234 typedef struct FilterGraph {
 235     int            index;
 236     const char    *graph_desc;
 237
 238     AVFilterGraph *graph;
 239     int reconfiguration;
 240
 241     InputFilter   **inputs;
 242     int          nb_inputs;
 243     OutputFilter **outputs;
 244     int         nb_outputs;
 245 } FilterGraph;
 246
 247 typedef struct InputStream {
 248     int file_index;
 249     AVStream *st;
 250     int discard;             /* true if stream data should be discarded */
 251     int user_set_discard;
 252     int decoding_needed;     /* non zero if the packets must be decoded in 'raw_fifo', see DECODING_FOR_* */
 253 #define DECODING_FOR_OST    1
 254 #define DECODING_FOR_FILTER 2
 255
 256     AVCodecContext *dec_ctx;
 257     AVCodec *dec;
 258     AVFrame *decoded_frame;
 259     AVFrame *filter_frame; /* a ref of decoded_frame, to be sent to filters */
 260
 261     int64_t       start;     /* time when read started */
 262     /* predicted dts of the next packet read for this stream or (when there are
 263      * several frames in a packet) of the next frame in current packet (in AV_TIME_BASE units) */
 264     int64_t       next_dts;
 265     int64_t       dts;       ///< dts of the last packet read for this stream (in AV_TIME_BASE units)
 266
 267     int64_t       next_pts;  ///< synthetic pts for the next decode frame (in AV_TIME_BASE units)
 268     int64_t       pts;       ///< current pts of the decoded frame  (in AV_TIME_BASE units)
 269     int           wrap_correction_done;
 270
 271     int64_t filter_in_rescale_delta_last;
 272
 273     double ts_scale;
 274     int saw_first_ts;
 275     int showed_multi_packet_warning;
 276     AVDictionary *decoder_opts;
 277     AVRational framerate;               /* framerate forced with -r */
 278     int top_field_first;
 279     int guess_layout_max;
 280
 281     int autorotate;
 282     int resample_height;
 283     int resample_width;
 284     int resample_pix_fmt;
 285
 286     int      resample_sample_fmt;
 287     int      resample_sample_rate;
 288     int      resample_channels;
 289     uint64_t resample_channel_layout;
 290
 291     int fix_sub_duration;
 292     struct { /* previous decoded subtitle and related variables */
 293         int got_output;
 294         int ret;
 295         AVSubtitle subtitle;
 296     } prev_sub;
 297
 298     struct sub2video {
 299         int64_t last_pts;
 300         int64_t end_pts;
 301         AVFrame *frame;
 302         int w, h;
 303     } sub2video;
 304
 305     int dr1;
 306
 307     /* decoded data from this stream goes into all those filters
 308      * currently video and audio only */
 309     InputFilter **filters;
 310     int        nb_filters;
 311
 312     int reinit_filters;
 313
 314     /* hwaccel options */
 315     enum HWAccelID hwaccel_id;
 316     char  *hwaccel_device;
 317
 318     /* hwaccel context */
 319     enum HWAccelID active_hwaccel_id;
 320     void  *hwaccel_ctx;
 321     void (*hwaccel_uninit)(AVCodecContext *s);
 322     int  (*hwaccel_get_buffer)(AVCodecContext *s, AVFrame *frame, int flags);
 323     int  (*hwaccel_retrieve_data)(AVCodecContext *s, AVFrame *frame);
 324     enum AVPixelFormat hwaccel_pix_fmt;
 325     enum AVPixelFormat hwaccel_retrieved_pix_fmt;
 326
 327     /* stats */
 328     // combined size of all the packets read
 329     uint64_t data_size;
 330     /* number of packets successfully read for this stream */
 331     uint64_t nb_packets;
 332     // number of frames/samples retrieved from the decoder
 333     uint64_t frames_decoded;
 334     uint64_t samples_decoded;
 335 } InputStream;
 336
 337 typedef struct InputFile {
 338     AVFormatContext *ctx;
 339     int eof_reached;      /* true if eof reached */
 340     int eagain;           /* true if last read attempt returned EAGAIN */
 341     int ist_index;        /* index of first stream in input_streams */
 342     int64_t input_ts_offset;
 343     int64_t ts_offset;
 344     int64_t last_ts;
 345     int64_t start_time;   /* user-specified start time in AV_TIME_BASE or AV_NOPTS_VALUE */
 346     int seek_timestamp;
 347     int64_t recording_time;
 348     int nb_streams;       /* number of stream that ffmpeg is aware of; may be different
 349                              from ctx.nb_streams if new streams appear during av_read_frame() */
 350     int nb_streams_warn;  /* number of streams that the user was warned of */
 351     int rate_emu;
 352     int accurate_seek;
 353
 354 #if HAVE_PTHREADS
 355     AVThreadMessageQueue *in_thread_queue;
 356     pthread_t thread;           /* thread reading from this file */
 357     int non_blocking;           /* reading packets from the thread should not block */
 358     int joined;                 /* the thread has been joined */
 359     int thread_queue_size;      /* maximum number of queued packets */
 360 #endif
 361 } InputFile;
 362
 363 enum forced_keyframes_const {
 364     FKF_N,
 365     FKF_N_FORCED,
 366     FKF_PREV_FORCED_N,
 367     FKF_PREV_FORCED_T,
 368     FKF_T,
 369     FKF_NB
 370 };
 371
 372 extern const char *const forced_keyframes_const_names[];
 373
 374 typedef enum {
 375     ENCODER_FINISHED = 1,
 376     MUXER_FINISHED = 2,
 377 } OSTFinished ;
 378
 379 typedef struct OutputStream {
 380     int file_index;          /* file index */
 381     int index;               /* stream index in the output file */
 382     int source_index;        /* InputStream index */
 383     AVStream *st;            /* stream in the output file */
 384     int encoding_needed;     /* true if encoding needed for this stream */
 385     int frame_number;
 386     /* input pts and corresponding output pts
 387        for A/V sync */
 388     struct InputStream *sync_ist; /* input stream to sync against */
 389     int64_t sync_opts;       /* output frame counter, could be changed to some true timestamp */ // FIXME look at frame_number
 390     /* pts of the first frame encoded for this stream, used for limiting
 391      * recording time */
 392     int64_t first_pts;
 393     /* dts of the last packet sent to the muxer */
 394     int64_t last_mux_dts;
 395     AVBitStreamFilterContext *bitstream_filters;
 396     AVCodecContext *enc_ctx;
 397     AVCodec *enc;
 398     int64_t max_frames;
 399     AVFrame *filtered_frame;
 400     AVFrame *last_frame;
 401     int last_droped;
 402     int last_nb0_frames[3];
 403
 404     /* video only */
 405     AVRational frame_rate;
 406     int force_fps;
 407     int top_field_first;
 408     int rotate_overridden;
 409
 410     AVRational frame_aspect_ratio;
 411
 412     /* forced key frames */
 413     int64_t *forced_kf_pts;
 414     int forced_kf_count;
 415     int forced_kf_index;
 416     char *forced_keyframes;
 417     AVExpr *forced_keyframes_pexpr;
 418     double forced_keyframes_expr_const_values[FKF_NB];
 419
 420     /* audio only */
 421     int *audio_channels_map;             /* list of the channels id to pick from the source stream */
 422     int audio_channels_mapped;           /* number of channels in audio_channels_map */
 423
 424     char *logfile_prefix;
 425     FILE *logfile;
 426
 427     OutputFilter *filter;
 428     char *avfilter;
 429     char *filters;         ///< filtergraph associated to the -filter option
 430     char *filters_script;  ///< filtergraph script associated to the -filter_script option
 431
 432     int64_t sws_flags;
 433     AVDictionary *encoder_opts;
 434     AVDictionary *swr_opts;
 435     AVDictionary *resample_opts;
 436     AVDictionary *bsf_args;
 437     char *apad;
 438     OSTFinished finished;        /* no more packets should be written for this stream */
 439     int unavailable;                     /* true if the steram is unavailable (possibly temporarily) */
 440     int stream_copy;
 441     const char *attachment_filename;
 442     int copy_initial_nonkeyframes;
 443     int copy_prior_start;
 444     char *disposition;
 445
 446     int keep_pix_fmt;
 447
 448     AVCodecParserContext *parser;
 449
 450     /* stats */
 451     // combined size of all the packets written
 452     uint64_t data_size;
 453     // number of packets send to the muxer
 454     uint64_t packets_written;
 455     // number of frames/samples sent to the encoder
 456     uint64_t frames_encoded;
 457     uint64_t samples_encoded;
 458 } OutputStream;
 459
 460 typedef struct OutputFile {
 461     AVFormatContext *ctx;
 462     AVDictionary *opts;
 463     int ost_index;       /* index of the first stream in output_streams */
 464     int64_t recording_time;  ///< desired length of the resulting file in microseconds == AV_TIME_BASE units
 465     int64_t start_time;      ///< start time in microseconds == AV_TIME_BASE units
 466     uint64_t limit_filesize; /* filesize limit expressed in bytes */
 467
 468     int shortest;
 469 } OutputFile;
 470
 471 extern InputStream **input_streams;
 472 extern int        nb_input_streams;
 473 extern InputFile   **input_files;
 474 extern int        nb_input_files;
 475
 476 extern OutputStream **output_streams;
 477 extern int         nb_output_streams;
 478 extern OutputFile   **output_files;
 479 extern int         nb_output_files;
 480
 481 extern FilterGraph **filtergraphs;
 482 extern int        nb_filtergraphs;
 483
 484 extern char *vstats_filename;
 485 extern char *sdp_filename;
 486
 487 extern float audio_drift_threshold;
 488 extern float dts_delta_threshold;
 489 extern float dts_error_threshold;
 490
 491 extern int audio_volume;
 492 extern int audio_sync_method;
 493 extern int video_sync_method;
 494 extern float frame_drop_threshold;
 495 extern int do_benchmark;
 496 extern int do_benchmark_all;
 497 extern int do_deinterlace;
 498 extern int do_hex_dump;
 499 extern int do_pkt_dump;
 500 extern int copy_ts;
 501 extern int start_at_zero;
 502 extern int copy_tb;
 503 extern int debug_ts;
 504 extern int exit_on_error;
 505 extern int print_stats;
 506 extern int qp_hist;
 507 extern int stdin_interaction;
 508 extern int frame_bits_per_raw_sample;
 509 extern AVIOContext *progress_avio;
 510 extern float max_error_rate;
 511 extern int vdpau_api_ver;
 512
 513 extern const AVIOInterruptCB int_cb;
 514
 515 extern const OptionDef options[];
 516 extern const HWAccel hwaccels[];
 517
 518
 519 void term_init(void);
 520 void term_exit(void);
 521
 522 void reset_options(OptionsContext *o, int is_input);
 523 void show_usage(void);
 524
 525 void opt_output_file(void *optctx, const char *filename);
 526
 527 void remove_avoptions(AVDictionary **a, AVDictionary *b);
 528 void assert_avoptions(AVDictionary *m);
 529
 530 int guess_input_channel_layout(InputStream *ist);
 531
 532 enum AVPixelFormat choose_pixel_fmt(AVStream *st, AVCodecContext *avctx, AVCodec *codec, enum AVPixelFormat target);
 533 void choose_sample_fmt(AVStream *st, AVCodec *codec);
 534
 535 int configure_filtergraph(FilterGraph *fg);
 536 int configure_output_filter(FilterGraph *fg, OutputFilter *ofilter, AVFilterInOut *out);
 537 int ist_in_filtergraph(FilterGraph *fg, InputStream *ist);
 538 FilterGraph *init_simple_filtergraph(InputStream *ist, OutputStream *ost);
 539
 540 int ffmpeg_parse_options(int argc, char **argv);
 541
 542 int vdpau_init(AVCodecContext *s);
 543 int dxva2_init(AVCodecContext *s);
 544 int vda_init(AVCodecContext *s);
 545
 546 #endif /* FFMPEG_H */