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