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