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