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