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