doc: Add more information in the README
[platform/upstream/libav.git] / 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
40 #include "libavutil/avutil.h"
41 #include "libavutil/dict.h"
42 #include "libavutil/fifo.h"
43 #include "libavutil/pixfmt.h"
44 #include "libavutil/rational.h"
45
46 #define VSYNC_AUTO       -1
47 #define VSYNC_PASSTHROUGH 0
48 #define VSYNC_CFR         1
49 #define VSYNC_VFR         2
50
51 enum HWAccelID {
52     HWACCEL_NONE = 0,
53     HWACCEL_AUTO,
54     HWACCEL_VDPAU,
55     HWACCEL_DXVA2,
56     HWACCEL_VDA,
57 };
58
59 typedef struct HWAccel {
60     const char *name;
61     int (*init)(AVCodecContext *s);
62     enum HWAccelID id;
63     enum AVPixelFormat pix_fmt;
64 } HWAccel;
65
66 /* select an input stream for an output stream */
67 typedef struct StreamMap {
68     int disabled;           /* 1 is this mapping is disabled by a negative map */
69     int file_index;
70     int stream_index;
71     int sync_file_index;
72     int sync_stream_index;
73     char *linklabel;       /* name of an output link, for mapping lavfi outputs */
74 } StreamMap;
75
76 /* select an input file for an output file */
77 typedef struct MetadataMap {
78     int  file;      // file index
79     char type;      // type of metadata to copy -- (g)lobal, (s)tream, (c)hapter or (p)rogram
80     int  index;     // stream/chapter/program number
81 } MetadataMap;
82
83 typedef struct OptionsContext {
84     OptionGroup *g;
85
86     /* input/output options */
87     int64_t start_time;
88     const char *format;
89
90     SpecifierOpt *codec_names;
91     int        nb_codec_names;
92     SpecifierOpt *audio_channels;
93     int        nb_audio_channels;
94     SpecifierOpt *audio_sample_rate;
95     int        nb_audio_sample_rate;
96     SpecifierOpt *frame_rates;
97     int        nb_frame_rates;
98     SpecifierOpt *frame_sizes;
99     int        nb_frame_sizes;
100     SpecifierOpt *frame_pix_fmts;
101     int        nb_frame_pix_fmts;
102
103     /* input options */
104     int64_t input_ts_offset;
105     int rate_emu;
106     int accurate_seek;
107
108     SpecifierOpt *ts_scale;
109     int        nb_ts_scale;
110     SpecifierOpt *dump_attachment;
111     int        nb_dump_attachment;
112     SpecifierOpt *hwaccels;
113     int        nb_hwaccels;
114     SpecifierOpt *hwaccel_devices;
115     int        nb_hwaccel_devices;
116
117     /* output options */
118     StreamMap *stream_maps;
119     int     nb_stream_maps;
120     /* first item specifies output metadata, second is input */
121     MetadataMap (*meta_data_maps)[2];
122     int nb_meta_data_maps;
123     int metadata_global_manual;
124     int metadata_streams_manual;
125     int metadata_chapters_manual;
126     const char **attachments;
127     int       nb_attachments;
128
129     int chapters_input_file;
130
131     int64_t recording_time;
132     uint64_t limit_filesize;
133     float mux_preload;
134     float mux_max_delay;
135     int shortest;
136
137     int video_disable;
138     int audio_disable;
139     int subtitle_disable;
140     int data_disable;
141
142     /* indexed by output file stream index */
143     int   *streamid_map;
144     int nb_streamid_map;
145
146     SpecifierOpt *metadata;
147     int        nb_metadata;
148     SpecifierOpt *max_frames;
149     int        nb_max_frames;
150     SpecifierOpt *bitstream_filters;
151     int        nb_bitstream_filters;
152     SpecifierOpt *codec_tags;
153     int        nb_codec_tags;
154     SpecifierOpt *sample_fmts;
155     int        nb_sample_fmts;
156     SpecifierOpt *qscale;
157     int        nb_qscale;
158     SpecifierOpt *forced_key_frames;
159     int        nb_forced_key_frames;
160     SpecifierOpt *force_fps;
161     int        nb_force_fps;
162     SpecifierOpt *frame_aspect_ratios;
163     int        nb_frame_aspect_ratios;
164     SpecifierOpt *rc_overrides;
165     int        nb_rc_overrides;
166     SpecifierOpt *intra_matrices;
167     int        nb_intra_matrices;
168     SpecifierOpt *inter_matrices;
169     int        nb_inter_matrices;
170     SpecifierOpt *top_field_first;
171     int        nb_top_field_first;
172     SpecifierOpt *metadata_map;
173     int        nb_metadata_map;
174     SpecifierOpt *presets;
175     int        nb_presets;
176     SpecifierOpt *copy_initial_nonkeyframes;
177     int        nb_copy_initial_nonkeyframes;
178     SpecifierOpt *filters;
179     int        nb_filters;
180     SpecifierOpt *filter_scripts;
181     int        nb_filter_scripts;
182     SpecifierOpt *pass;
183     int        nb_pass;
184     SpecifierOpt *passlogfiles;
185     int        nb_passlogfiles;
186 } OptionsContext;
187
188 typedef struct InputFilter {
189     AVFilterContext    *filter;
190     struct InputStream *ist;
191     struct FilterGraph *graph;
192     uint8_t            *name;
193 } InputFilter;
194
195 typedef struct OutputFilter {
196     AVFilterContext     *filter;
197     struct OutputStream *ost;
198     struct FilterGraph  *graph;
199     uint8_t             *name;
200
201     /* temporary storage until stream maps are processed */
202     AVFilterInOut       *out_tmp;
203 } OutputFilter;
204
205 typedef struct FilterGraph {
206     int            index;
207     const char    *graph_desc;
208
209     AVFilterGraph *graph;
210
211     InputFilter   **inputs;
212     int          nb_inputs;
213     OutputFilter **outputs;
214     int         nb_outputs;
215 } FilterGraph;
216
217 typedef struct InputStream {
218     int file_index;
219     AVStream *st;
220     int discard;             /* true if stream data should be discarded */
221     int decoding_needed;     /* true if the packets must be decoded in 'raw_fifo' */
222     AVCodecContext *dec_ctx;
223     AVCodec *dec;
224     AVFrame *decoded_frame;
225     AVFrame *filter_frame; /* a ref of decoded_frame, to be sent to filters */
226
227     int64_t       start;     /* time when read started */
228     /* predicted dts of the next packet read for this stream or (when there are
229      * several frames in a packet) of the next frame in current packet */
230     int64_t       next_dts;
231     /* dts of the last packet read for this stream */
232     int64_t       last_dts;
233     PtsCorrectionContext pts_ctx;
234     double ts_scale;
235     int showed_multi_packet_warning;
236     AVDictionary *decoder_opts;
237     AVRational framerate;               /* framerate forced with -r */
238
239     int resample_height;
240     int resample_width;
241     int resample_pix_fmt;
242
243     int      resample_sample_fmt;
244     int      resample_sample_rate;
245     int      resample_channels;
246     uint64_t resample_channel_layout;
247
248     /* decoded data from this stream goes into all those filters
249      * currently video and audio only */
250     InputFilter **filters;
251     int        nb_filters;
252
253     /* hwaccel options */
254     enum HWAccelID hwaccel_id;
255     char  *hwaccel_device;
256
257     /* hwaccel context */
258     enum HWAccelID active_hwaccel_id;
259     void  *hwaccel_ctx;
260     void (*hwaccel_uninit)(AVCodecContext *s);
261     int  (*hwaccel_get_buffer)(AVCodecContext *s, AVFrame *frame, int flags);
262     int  (*hwaccel_retrieve_data)(AVCodecContext *s, AVFrame *frame);
263     enum AVPixelFormat hwaccel_pix_fmt;
264     enum AVPixelFormat hwaccel_retrieved_pix_fmt;
265
266     /* stats */
267     // combined size of all the packets read
268     uint64_t data_size;
269     /* number of packets successfully read for this stream */
270     uint64_t nb_packets;
271     // number of frames/samples retrieved from the decoder
272     uint64_t frames_decoded;
273     uint64_t samples_decoded;
274 } InputStream;
275
276 typedef struct InputFile {
277     AVFormatContext *ctx;
278     int eof_reached;      /* true if eof reached */
279     int eagain;           /* true if last read attempt returned EAGAIN */
280     int ist_index;        /* index of first stream in ist_table */
281     int64_t ts_offset;
282     int64_t start_time;   /* user-specified start time in AV_TIME_BASE or AV_NOPTS_VALUE */
283     int64_t recording_time;
284     int nb_streams;       /* number of stream that avconv is aware of; may be different
285                              from ctx.nb_streams if new streams appear during av_read_frame() */
286     int rate_emu;
287     int accurate_seek;
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 typedef struct OutputStream {
300     int file_index;          /* file index */
301     int index;               /* stream index in the output file */
302     int source_index;        /* InputStream index */
303     AVStream *st;            /* stream in the output file */
304     int encoding_needed;     /* true if encoding needed for this stream */
305     int frame_number;
306     /* input pts and corresponding output pts
307        for A/V sync */
308     // double sync_ipts;        /* dts from the AVPacket of the demuxer in second units */
309     struct InputStream *sync_ist; /* input stream to sync against */
310     int64_t sync_opts;       /* output frame counter, could be changed to some true timestamp */ // FIXME look at frame_number
311     /* pts of the first frame encoded for this stream, used for limiting
312      * recording time */
313     int64_t first_pts;
314     /* dts of the last packet sent to the muxer */
315     int64_t last_mux_dts;
316     AVBitStreamFilterContext *bitstream_filters;
317     AVCodecContext *enc_ctx;
318     AVCodec *enc;
319     int64_t max_frames;
320     AVFrame *filtered_frame;
321
322     /* video only */
323     AVRational frame_rate;
324     int force_fps;
325     int top_field_first;
326
327     float frame_aspect_ratio;
328
329     /* forced key frames */
330     int64_t *forced_kf_pts;
331     int forced_kf_count;
332     int forced_kf_index;
333     char *forced_keyframes;
334
335     char *logfile_prefix;
336     FILE *logfile;
337
338     OutputFilter *filter;
339     char *avfilter;
340
341     int64_t sws_flags;
342     AVDictionary *encoder_opts;
343     AVDictionary *resample_opts;
344     int finished;        /* no more packets should be written for this stream */
345     int stream_copy;
346     const char *attachment_filename;
347     int copy_initial_nonkeyframes;
348
349     enum AVPixelFormat pix_fmts[2];
350
351     AVCodecParserContext *parser;
352
353     /* stats */
354     // combined size of all the packets written
355     uint64_t data_size;
356     // number of packets send to the muxer
357     uint64_t packets_written;
358     // number of frames/samples sent to the encoder
359     uint64_t frames_encoded;
360     uint64_t samples_encoded;
361 } OutputStream;
362
363 typedef struct OutputFile {
364     AVFormatContext *ctx;
365     AVDictionary *opts;
366     int ost_index;       /* index of the first stream in output_streams */
367     int64_t recording_time; /* desired length of the resulting file in microseconds */
368     int64_t start_time;     /* start time in microseconds */
369     uint64_t limit_filesize;
370
371     int shortest;
372 } OutputFile;
373
374 extern InputStream **input_streams;
375 extern int        nb_input_streams;
376 extern InputFile   **input_files;
377 extern int        nb_input_files;
378
379 extern OutputStream **output_streams;
380 extern int         nb_output_streams;
381 extern OutputFile   **output_files;
382 extern int         nb_output_files;
383
384 extern FilterGraph **filtergraphs;
385 extern int        nb_filtergraphs;
386
387 extern char *vstats_filename;
388
389 extern float audio_drift_threshold;
390 extern float dts_delta_threshold;
391
392 extern int audio_volume;
393 extern int audio_sync_method;
394 extern int video_sync_method;
395 extern int do_benchmark;
396 extern int do_deinterlace;
397 extern int do_hex_dump;
398 extern int do_pkt_dump;
399 extern int copy_ts;
400 extern int copy_tb;
401 extern int exit_on_error;
402 extern int print_stats;
403 extern int qp_hist;
404
405 extern const AVIOInterruptCB int_cb;
406
407 extern const OptionDef options[];
408
409 extern const HWAccel hwaccels[];
410
411 void reset_options(OptionsContext *o);
412 void show_usage(void);
413
414 void opt_output_file(void *optctx, const char *filename);
415
416 void assert_avoptions(AVDictionary *m);
417
418 int guess_input_channel_layout(InputStream *ist);
419
420 int configure_filtergraph(FilterGraph *fg);
421 int configure_output_filter(FilterGraph *fg, OutputFilter *ofilter, AVFilterInOut *out);
422 int ist_in_filtergraph(FilterGraph *fg, InputStream *ist);
423 FilterGraph *init_simple_filtergraph(InputStream *ist, OutputStream *ost);
424
425 int avconv_parse_options(int argc, char **argv);
426
427 int vdpau_init(AVCodecContext *s);
428 int dxva2_init(AVCodecContext *s);
429 int vda_init(AVCodecContext *s);
430
431 #endif /* AVCONV_H */