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