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