]> git.sesse.net Git - ffmpeg/blob - avconv.h
document the release process
[ffmpeg] / avconv.h
1 /*
2  * This file is part of Libav.
3  *
4  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 #ifndef AVCONV_H
20 #define AVCONV_H
21
22 #include "config.h"
23
24 #include <stdint.h>
25 #include <stdio.h>
26
27 #if HAVE_PTHREADS
28 #include <pthread.h>
29 #endif
30
31 #include "cmdutils.h"
32
33 #include "libavformat/avformat.h"
34 #include "libavformat/avio.h"
35
36 #include "libavcodec/avcodec.h"
37
38 #include "libavfilter/avfilter.h"
39 #include "libavfilter/avfiltergraph.h"
40
41 #include "libavutil/avutil.h"
42 #include "libavutil/dict.h"
43 #include "libavutil/fifo.h"
44 #include "libavutil/pixfmt.h"
45 #include "libavutil/rational.h"
46
47 #define VSYNC_AUTO       -1
48 #define VSYNC_PASSTHROUGH 0
49 #define VSYNC_CFR         1
50 #define VSYNC_VFR         2
51
52 /* select an input stream for an output stream */
53 typedef struct StreamMap {
54     int disabled;           /* 1 is this mapping is disabled by a negative map */
55     int file_index;
56     int stream_index;
57     int sync_file_index;
58     int sync_stream_index;
59     char *linklabel;       /* name of an output link, for mapping lavfi outputs */
60 } StreamMap;
61
62 /* select an input file for an output file */
63 typedef struct MetadataMap {
64     int  file;      // file index
65     char type;      // type of metadata to copy -- (g)lobal, (s)tream, (c)hapter or (p)rogram
66     int  index;     // stream/chapter/program number
67 } MetadataMap;
68
69 typedef struct OptionsContext {
70     OptionGroup *g;
71
72     /* input/output options */
73     int64_t start_time;
74     const char *format;
75
76     SpecifierOpt *codec_names;
77     int        nb_codec_names;
78     SpecifierOpt *audio_channels;
79     int        nb_audio_channels;
80     SpecifierOpt *audio_sample_rate;
81     int        nb_audio_sample_rate;
82     SpecifierOpt *frame_rates;
83     int        nb_frame_rates;
84     SpecifierOpt *frame_sizes;
85     int        nb_frame_sizes;
86     SpecifierOpt *frame_pix_fmts;
87     int        nb_frame_pix_fmts;
88
89     /* input options */
90     int64_t input_ts_offset;
91     int rate_emu;
92
93     SpecifierOpt *ts_scale;
94     int        nb_ts_scale;
95     SpecifierOpt *dump_attachment;
96     int        nb_dump_attachment;
97
98     /* output options */
99     StreamMap *stream_maps;
100     int     nb_stream_maps;
101     /* first item specifies output metadata, second is input */
102     MetadataMap (*meta_data_maps)[2];
103     int nb_meta_data_maps;
104     int metadata_global_manual;
105     int metadata_streams_manual;
106     int metadata_chapters_manual;
107     const char **attachments;
108     int       nb_attachments;
109
110     int chapters_input_file;
111
112     int64_t recording_time;
113     uint64_t limit_filesize;
114     float mux_preload;
115     float mux_max_delay;
116     int shortest;
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     SpecifierOpt *pass;
162     int        nb_pass;
163     SpecifierOpt *passlogfiles;
164     int        nb_passlogfiles;
165 } OptionsContext;
166
167 typedef struct InputFilter {
168     AVFilterContext    *filter;
169     struct InputStream *ist;
170     struct FilterGraph *graph;
171     uint8_t            *name;
172 } InputFilter;
173
174 typedef struct OutputFilter {
175     AVFilterContext     *filter;
176     struct OutputStream *ost;
177     struct FilterGraph  *graph;
178     uint8_t             *name;
179
180     /* temporary storage until stream maps are processed */
181     AVFilterInOut       *out_tmp;
182 } OutputFilter;
183
184 typedef struct FilterGraph {
185     int            index;
186     const char    *graph_desc;
187
188     AVFilterGraph *graph;
189
190     InputFilter   **inputs;
191     int          nb_inputs;
192     OutputFilter **outputs;
193     int         nb_outputs;
194 } FilterGraph;
195
196 typedef struct InputStream {
197     int file_index;
198     AVStream *st;
199     int discard;             /* true if stream data should be discarded */
200     int decoding_needed;     /* true if the packets must be decoded in 'raw_fifo' */
201     AVCodec *dec;
202     AVFrame *decoded_frame;
203     AVFrame *filter_frame; /* a ref of decoded_frame, to be sent to filters */
204
205     int64_t       start;     /* time when read started */
206     /* predicted dts of the next packet read for this stream or (when there are
207      * several frames in a packet) of the next frame in current packet */
208     int64_t       next_dts;
209     /* dts of the last packet read for this stream */
210     int64_t       last_dts;
211     PtsCorrectionContext pts_ctx;
212     double ts_scale;
213     int is_start;            /* is 1 at the start and after a discontinuity */
214     int showed_multi_packet_warning;
215     AVDictionary *opts;
216     AVRational framerate;               /* framerate forced with -r */
217
218     int resample_height;
219     int resample_width;
220     int resample_pix_fmt;
221
222     int      resample_sample_fmt;
223     int      resample_sample_rate;
224     int      resample_channels;
225     uint64_t resample_channel_layout;
226
227     /* decoded data from this stream goes into all those filters
228      * currently video and audio only */
229     InputFilter **filters;
230     int        nb_filters;
231 } InputStream;
232
233 typedef struct InputFile {
234     AVFormatContext *ctx;
235     int eof_reached;      /* true if eof reached */
236     int eagain;           /* true if last read attempt returned EAGAIN */
237     int ist_index;        /* index of first stream in ist_table */
238     int64_t ts_offset;
239     int nb_streams;       /* number of stream that avconv is aware of; may be different
240                              from ctx.nb_streams if new streams appear during av_read_frame() */
241     int rate_emu;
242
243 #if HAVE_PTHREADS
244     pthread_t thread;           /* thread reading from this file */
245     int finished;               /* the thread has exited */
246     int joined;                 /* the thread has been joined */
247     pthread_mutex_t fifo_lock;  /* lock for access to fifo */
248     pthread_cond_t  fifo_cond;  /* the main thread will signal on this cond after reading from fifo */
249     AVFifoBuffer *fifo;         /* demuxed packets are stored here; freed by the main thread */
250 #endif
251 } InputFile;
252
253 typedef struct OutputStream {
254     int file_index;          /* file index */
255     int index;               /* stream index in the output file */
256     int source_index;        /* InputStream index */
257     AVStream *st;            /* stream in the output file */
258     int encoding_needed;     /* true if encoding needed for this stream */
259     int frame_number;
260     /* input pts and corresponding output pts
261        for A/V sync */
262     // double sync_ipts;        /* dts from the AVPacket of the demuxer in second units */
263     struct InputStream *sync_ist; /* input stream to sync against */
264     int64_t sync_opts;       /* output frame counter, could be changed to some true timestamp */ // FIXME look at frame_number
265     /* pts of the first frame encoded for this stream, used for limiting
266      * recording time */
267     int64_t first_pts;
268     AVBitStreamFilterContext *bitstream_filters;
269     AVCodec *enc;
270     int64_t max_frames;
271     AVFrame *filtered_frame;
272
273     /* video only */
274     AVRational frame_rate;
275     int force_fps;
276     int top_field_first;
277
278     float frame_aspect_ratio;
279
280     /* forced key frames */
281     int64_t *forced_kf_pts;
282     int forced_kf_count;
283     int forced_kf_index;
284     char *forced_keyframes;
285
286     char *logfile_prefix;
287     FILE *logfile;
288
289     OutputFilter *filter;
290     char *avfilter;
291
292     int64_t sws_flags;
293     AVDictionary *opts;
294     AVDictionary *resample_opts;
295     int finished;        /* no more packets should be written for this stream */
296     int stream_copy;
297     const char *attachment_filename;
298     int copy_initial_nonkeyframes;
299
300     enum AVPixelFormat pix_fmts[2];
301 } OutputStream;
302
303 typedef struct OutputFile {
304     AVFormatContext *ctx;
305     AVDictionary *opts;
306     int ost_index;       /* index of the first stream in output_streams */
307     int64_t recording_time; /* desired length of the resulting file in microseconds */
308     int64_t start_time;     /* start time in microseconds */
309     uint64_t limit_filesize;
310
311     int shortest;
312 } OutputFile;
313
314 extern InputStream **input_streams;
315 extern int        nb_input_streams;
316 extern InputFile   **input_files;
317 extern int        nb_input_files;
318
319 extern OutputStream **output_streams;
320 extern int         nb_output_streams;
321 extern OutputFile   **output_files;
322 extern int         nb_output_files;
323
324 extern FilterGraph **filtergraphs;
325 extern int        nb_filtergraphs;
326
327 extern char *vstats_filename;
328
329 extern float audio_drift_threshold;
330 extern float dts_delta_threshold;
331
332 extern int audio_volume;
333 extern int audio_sync_method;
334 extern int video_sync_method;
335 extern int do_benchmark;
336 extern int do_deinterlace;
337 extern int do_hex_dump;
338 extern int do_pkt_dump;
339 extern int copy_ts;
340 extern int copy_tb;
341 extern int exit_on_error;
342 extern int print_stats;
343 extern int qp_hist;
344
345 extern const AVIOInterruptCB int_cb;
346
347 extern const OptionDef options[];
348
349 void reset_options(OptionsContext *o);
350 void show_usage(void);
351
352 int opt_cpuflags(void *optctx, const char *opt, const char *arg);
353
354 void opt_output_file(void *optctx, const char *filename);
355
356 void assert_avoptions(AVDictionary *m);
357
358 int guess_input_channel_layout(InputStream *ist);
359
360 int configure_filtergraph(FilterGraph *fg);
361 int configure_output_filter(FilterGraph *fg, OutputFilter *ofilter, AVFilterInOut *out);
362 int ist_in_filtergraph(FilterGraph *fg, InputStream *ist);
363 FilterGraph *init_simple_filtergraph(InputStream *ist, OutputStream *ost);
364
365 int avconv_parse_options(int argc, char **argv);
366
367 #endif /* AVCONV_H */