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