ffmpeg.h
f5e66827
 /*
11a1033c
  * This file is part of FFmpeg.
f5e66827
  *
11a1033c
  * FFmpeg is free software; you can redistribute it and/or
f5e66827
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
11a1033c
  * FFmpeg is distributed in the hope that it will be useful,
f5e66827
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
11a1033c
  * License along with FFmpeg; if not, write to the Free Software
f5e66827
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
11a1033c
 #ifndef FFMPEG_H
 #define FFMPEG_H
f5e66827
 
 #include "config.h"
 
 #include <stdint.h>
 #include <stdio.h>
11a1033c
 #include <signal.h>
f5e66827
 
 #if HAVE_PTHREADS
 #include <pthread.h>
 #endif
 
 #include "cmdutils.h"
 
 #include "libavformat/avformat.h"
 #include "libavformat/avio.h"
 
 #include "libavcodec/avcodec.h"
 
 #include "libavfilter/avfilter.h"
 #include "libavfilter/avfiltergraph.h"
 
 #include "libavutil/avutil.h"
 #include "libavutil/dict.h"
 #include "libavutil/fifo.h"
 #include "libavutil/pixfmt.h"
 #include "libavutil/rational.h"
 
11a1033c
 #include "libswresample/swresample.h"
 
f5e66827
 #define VSYNC_AUTO       -1
 #define VSYNC_PASSTHROUGH 0
 #define VSYNC_CFR         1
 #define VSYNC_VFR         2
11a1033c
 #define VSYNC_DROP        0xff
 
 #define MAX_STREAMS 1024    /* arbitrary sanity check value */
f5e66827
 
 /* select an input stream for an output stream */
 typedef struct StreamMap {
c1ef30a6
     int disabled;           /* 1 is this mapping is disabled by a negative map */
f5e66827
     int file_index;
     int stream_index;
     int sync_file_index;
     int sync_stream_index;
c1ef30a6
     char *linklabel;       /* name of an output link, for mapping lavfi outputs */
f5e66827
 } StreamMap;
 
11a1033c
 typedef struct {
     int  file_idx,  stream_idx,  channel_idx; // input
     int ofile_idx, ostream_idx;               // output
 } AudioChannelMap;
f5e66827
 
 typedef struct OptionsContext {
77bd1bc7
     OptionGroup *g;
 
f5e66827
     /* input/output options */
     int64_t start_time;
     const char *format;
 
     SpecifierOpt *codec_names;
     int        nb_codec_names;
     SpecifierOpt *audio_channels;
     int        nb_audio_channels;
     SpecifierOpt *audio_sample_rate;
     int        nb_audio_sample_rate;
     SpecifierOpt *frame_rates;
     int        nb_frame_rates;
     SpecifierOpt *frame_sizes;
     int        nb_frame_sizes;
     SpecifierOpt *frame_pix_fmts;
     int        nb_frame_pix_fmts;
 
     /* input options */
     int64_t input_ts_offset;
     int rate_emu;
 
     SpecifierOpt *ts_scale;
     int        nb_ts_scale;
     SpecifierOpt *dump_attachment;
     int        nb_dump_attachment;
 
     /* output options */
     StreamMap *stream_maps;
     int     nb_stream_maps;
11a1033c
     AudioChannelMap *audio_channel_maps; /* one info entry per -map_channel */
     int           nb_audio_channel_maps; /* number of (valid) -map_channel settings */
f5e66827
     int metadata_global_manual;
     int metadata_streams_manual;
     int metadata_chapters_manual;
     const char **attachments;
     int       nb_attachments;
 
     int chapters_input_file;
 
     int64_t recording_time;
     uint64_t limit_filesize;
     float mux_preload;
     float mux_max_delay;
3c0df905
     int shortest;
f5e66827
 
     int video_disable;
     int audio_disable;
     int subtitle_disable;
     int data_disable;
 
     /* indexed by output file stream index */
     int   *streamid_map;
     int nb_streamid_map;
 
     SpecifierOpt *metadata;
     int        nb_metadata;
     SpecifierOpt *max_frames;
     int        nb_max_frames;
     SpecifierOpt *bitstream_filters;
     int        nb_bitstream_filters;
     SpecifierOpt *codec_tags;
     int        nb_codec_tags;
     SpecifierOpt *sample_fmts;
     int        nb_sample_fmts;
     SpecifierOpt *qscale;
     int        nb_qscale;
     SpecifierOpt *forced_key_frames;
     int        nb_forced_key_frames;
     SpecifierOpt *force_fps;
     int        nb_force_fps;
     SpecifierOpt *frame_aspect_ratios;
     int        nb_frame_aspect_ratios;
     SpecifierOpt *rc_overrides;
     int        nb_rc_overrides;
     SpecifierOpt *intra_matrices;
     int        nb_intra_matrices;
     SpecifierOpt *inter_matrices;
     int        nb_inter_matrices;
     SpecifierOpt *top_field_first;
     int        nb_top_field_first;
     SpecifierOpt *metadata_map;
     int        nb_metadata_map;
     SpecifierOpt *presets;
     int        nb_presets;
     SpecifierOpt *copy_initial_nonkeyframes;
     int        nb_copy_initial_nonkeyframes;
65f7aee6
     SpecifierOpt *copy_prior_start;
     int        nb_copy_prior_start;
f5e66827
     SpecifierOpt *filters;
     int        nb_filters;
3e0b29cc
     SpecifierOpt *reinit_filters;
     int        nb_reinit_filters;
0cad101e
     SpecifierOpt *fix_sub_duration;
     int        nb_fix_sub_duration;
038c0b1e
     SpecifierOpt *pass;
     int        nb_pass;
bbcedade
     SpecifierOpt *passlogfiles;
     int        nb_passlogfiles;
f5e66827
 } OptionsContext;
 
 typedef struct InputFilter {
     AVFilterContext    *filter;
     struct InputStream *ist;
     struct FilterGraph *graph;
     uint8_t            *name;
 } InputFilter;
 
 typedef struct OutputFilter {
     AVFilterContext     *filter;
     struct OutputStream *ost;
     struct FilterGraph  *graph;
     uint8_t             *name;
 
     /* temporary storage until stream maps are processed */
     AVFilterInOut       *out_tmp;
 } OutputFilter;
 
 typedef struct FilterGraph {
     int            index;
     const char    *graph_desc;
 
     AVFilterGraph *graph;
 
     InputFilter   **inputs;
     int          nb_inputs;
     OutputFilter **outputs;
     int         nb_outputs;
 } FilterGraph;
 
 typedef struct InputStream {
     int file_index;
     AVStream *st;
     int discard;             /* true if stream data should be discarded */
     int decoding_needed;     /* true if the packets must be decoded in 'raw_fifo' */
     AVCodec *dec;
     AVFrame *decoded_frame;
 
     int64_t       start;     /* time when read started */
     /* predicted dts of the next packet read for this stream or (when there are
11a1033c
      * several frames in a packet) of the next frame in current packet (in AV_TIME_BASE units) */
f5e66827
     int64_t       next_dts;
11a1033c
     int64_t       dts;       ///< dts of the last packet read for this stream (in AV_TIME_BASE units)
 
     int64_t       next_pts;  ///< synthetic pts for the next decode frame (in AV_TIME_BASE units)
     int64_t       pts;       ///< current pts of the decoded frame  (in AV_TIME_BASE units)
     int           wrap_correction_done;
a9d97e1b
 
     int64_t filter_in_rescale_delta_last;
 
f5e66827
     double ts_scale;
     int is_start;            /* is 1 at the start and after a discontinuity */
11a1033c
     int saw_first_ts;
f5e66827
     int showed_multi_packet_warning;
     AVDictionary *opts;
     AVRational framerate;               /* framerate forced with -r */
11a1033c
     int top_field_first;
f5e66827
 
     int resample_height;
     int resample_width;
     int resample_pix_fmt;
 
     int      resample_sample_fmt;
     int      resample_sample_rate;
     int      resample_channels;
     uint64_t resample_channel_layout;
 
0cad101e
     int fix_sub_duration;
     struct { /* previous decoded subtitle and related variables */
         int got_output;
         int ret;
         AVSubtitle subtitle;
     } prev_sub;
 
11a1033c
     struct sub2video {
         int64_t last_pts;
0f236345
         int64_t end_pts;
11a1033c
         AVFilterBufferRef *ref;
         int w, h;
     } sub2video;
 
f5e66827
     /* a pool of free buffers for decoded data */
     FrameBuffer *buffer_pool;
11a1033c
     int dr1;
f5e66827
 
     /* decoded data from this stream goes into all those filters
      * currently video and audio only */
     InputFilter **filters;
     int        nb_filters;
3e0b29cc
 
     int reinit_filters;
f5e66827
 } InputStream;
 
 typedef struct InputFile {
     AVFormatContext *ctx;
     int eof_reached;      /* true if eof reached */
0b26ef42
     int eagain;           /* true if last read attempt returned EAGAIN */
11a1033c
     int ist_index;        /* index of first stream in input_streams */
f5e66827
     int64_t ts_offset;
11a1033c
     int nb_streams;       /* number of stream that ffmpeg is aware of; may be different
f5e66827
                              from ctx.nb_streams if new streams appear during av_read_frame() */
11a1033c
     int nb_streams_warn;  /* number of streams that the user was warned of */
f5e66827
     int rate_emu;
 
 #if HAVE_PTHREADS
     pthread_t thread;           /* thread reading from this file */
     int finished;               /* the thread has exited */
     int joined;                 /* the thread has been joined */
     pthread_mutex_t fifo_lock;  /* lock for access to fifo */
     pthread_cond_t  fifo_cond;  /* the main thread will signal on this cond after reading from fifo */
     AVFifoBuffer *fifo;         /* demuxed packets are stored here; freed by the main thread */
 #endif
 } InputFile;
 
 typedef struct OutputStream {
     int file_index;          /* file index */
     int index;               /* stream index in the output file */
     int source_index;        /* InputStream index */
     AVStream *st;            /* stream in the output file */
     int encoding_needed;     /* true if encoding needed for this stream */
     int frame_number;
     /* input pts and corresponding output pts
        for A/V sync */
     struct InputStream *sync_ist; /* input stream to sync against */
     int64_t sync_opts;       /* output frame counter, could be changed to some true timestamp */ // FIXME look at frame_number
     /* pts of the first frame encoded for this stream, used for limiting
      * recording time */
     int64_t first_pts;
ba8ab4e7
     /* dts of the last packet sent to the muxer */
     int64_t last_mux_dts;
f5e66827
     AVBitStreamFilterContext *bitstream_filters;
     AVCodec *enc;
     int64_t max_frames;
     AVFrame *filtered_frame;
 
     /* video only */
     AVRational frame_rate;
     int force_fps;
     int top_field_first;
 
     float frame_aspect_ratio;
 
     /* forced key frames */
     int64_t *forced_kf_pts;
     int forced_kf_count;
     int forced_kf_index;
     char *forced_keyframes;
 
11a1033c
     /* audio only */
     int audio_channels_map[SWR_CH_MAX];  /* list of the channels id to pick from the source stream */
     int audio_channels_mapped;           /* number of channels in audio_channels_map */
 
bbcedade
     char *logfile_prefix;
f5e66827
     FILE *logfile;
 
     OutputFilter *filter;
     char *avfilter;
 
     int64_t sws_flags;
b5e0e327
     int64_t swr_filter_type;
11a1033c
     int64_t swr_dither_method;
     double swr_dither_scale;
f5e66827
     AVDictionary *opts;
57d24225
     int finished;        /* no more packets should be written for this stream */
11a1033c
     int unavailable;                     /* true if the steram is unavailable (possibly temporarily) */
f5e66827
     int stream_copy;
     const char *attachment_filename;
     int copy_initial_nonkeyframes;
65f7aee6
     int copy_prior_start;
f5e66827
 
11a1033c
     int keep_pix_fmt;
f5e66827
 } OutputStream;
 
 typedef struct OutputFile {
     AVFormatContext *ctx;
     AVDictionary *opts;
     int ost_index;       /* index of the first stream in output_streams */
11a1033c
     int64_t recording_time;  ///< desired length of the resulting file in microseconds == AV_TIME_BASE units
     int64_t start_time;      ///< start time in microseconds == AV_TIME_BASE units
     uint64_t limit_filesize; /* filesize limit expressed in bytes */
3c0df905
 
     int shortest;
f5e66827
 } OutputFile;
 
 extern InputStream **input_streams;
 extern int        nb_input_streams;
 extern InputFile   **input_files;
 extern int        nb_input_files;
 
 extern OutputStream **output_streams;
 extern int         nb_output_streams;
 extern OutputFile   **output_files;
 extern int         nb_output_files;
 
 extern FilterGraph **filtergraphs;
 extern int        nb_filtergraphs;
 
 extern char *vstats_filename;
 
 extern float audio_drift_threshold;
 extern float dts_delta_threshold;
11a1033c
 extern float dts_error_threshold;
f5e66827
 
 extern int audio_volume;
 extern int audio_sync_method;
 extern int video_sync_method;
 extern int do_benchmark;
11a1033c
 extern int do_benchmark_all;
f5e66827
 extern int do_deinterlace;
 extern int do_hex_dump;
 extern int do_pkt_dump;
 extern int copy_ts;
 extern int copy_tb;
11a1033c
 extern int debug_ts;
f5e66827
 extern int exit_on_error;
 extern int print_stats;
 extern int qp_hist;
11a1033c
 extern int stdin_interaction;
 extern int frame_bits_per_raw_sample;
 extern AVIOContext *progress_avio;
f5e66827
 
 extern const AVIOInterruptCB int_cb;
 
 extern const OptionDef options[];
 
11a1033c
 void term_init(void);
 void term_exit(void);
f5e66827
 
11a1033c
 void reset_options(OptionsContext *o, int is_input);
 void show_usage(void);
f5e66827
 
 void opt_output_file(void *optctx, const char *filename);
 
 void assert_avoptions(AVDictionary *m);
 
 int guess_input_channel_layout(InputStream *ist);
 
ac627b3d
 enum AVPixelFormat choose_pixel_fmt(AVStream *st, AVCodec *codec, enum AVPixelFormat target);
11a1033c
 void choose_sample_fmt(AVStream *st, AVCodec *codec);
 
f5e66827
 int configure_filtergraph(FilterGraph *fg);
 int configure_output_filter(FilterGraph *fg, OutputFilter *ofilter, AVFilterInOut *out);
fe2147e9
 int ist_in_filtergraph(FilterGraph *fg, InputStream *ist);
 FilterGraph *init_simple_filtergraph(InputStream *ist, OutputStream *ost);
f5e66827
 
af4b1c02
 int ffmpeg_parse_options(int argc, char **argv);
77bd1bc7
 
11a1033c
 #endif /* FFMPEG_H */