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