FFmpeg
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
ffmpeg.h
Go to the documentation of this file.
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"
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 
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 */
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
73 
74 typedef struct OptionsContext {
76 
77  /* input/output options */
78  int64_t start_time;
79  const char *format;
80 
93 
94  /* input options */
95  int64_t input_ts_offset;
96  int rate_emu;
97 
102 
103  /* output options */
106  AudioChannelMap *audio_channel_maps; /* one info entry per -map_channel */
107  int nb_audio_channel_maps; /* number of (valid) -map_channel settings */
111  const char **attachments;
113 
115 
116  int64_t recording_time;
117  int64_t stop_time;
118  uint64_t limit_filesize;
119  float mux_preload;
121  int shortest;
122 
127 
128  /* indexed by output file stream index */
131 
173  int nb_pass;
179 
180 typedef struct InputFilter {
182  struct InputStream *ist;
185 } InputFilter;
186 
187 typedef struct OutputFilter {
189  struct OutputStream *ost;
192 
193  /* temporary storage until stream maps are processed */
195 } OutputFilter;
196 
197 typedef struct FilterGraph {
198  int index;
199  const char *graph_desc;
200 
203 
208 } FilterGraph;
209 
210 typedef struct InputStream {
213  int discard; /* true if stream data should be discarded */
214  int decoding_needed; /* true if the packets must be decoded in 'raw_fifo' */
217 
218  int64_t start; /* time when read started */
219  /* predicted dts of the next packet read for this stream or (when there are
220  * several frames in a packet) of the next frame in current packet (in AV_TIME_BASE units) */
221  int64_t next_dts;
222  int64_t dts; ///< dts of the last packet read for this stream (in AV_TIME_BASE units)
223 
224  int64_t next_pts; ///< synthetic pts for the next decode frame (in AV_TIME_BASE units)
225  int64_t pts; ///< current pts of the decoded frame (in AV_TIME_BASE units)
227 
229 
230  double ts_scale;
231  int is_start; /* is 1 at the start and after a discontinuity */
235  AVRational framerate; /* framerate forced with -r */
238 
242 
247 
249  struct { /* previous decoded subtitle and related variables */
251  int ret;
253  } prev_sub;
254 
255  struct sub2video {
256  int64_t last_pts;
257  int64_t end_pts;
259  int w, h;
260  } sub2video;
261 
262  /* a pool of free buffers for decoded data */
264  int dr1;
265 
266  /* decoded data from this stream goes into all those filters
267  * currently video and audio only */
270 
272 } InputStream;
273 
274 typedef struct InputFile {
276  int eof_reached; /* true if eof reached */
277  int eagain; /* true if last read attempt returned EAGAIN */
278  int ist_index; /* index of first stream in input_streams */
279  int64_t ts_offset;
280  int nb_streams; /* number of stream that ffmpeg is aware of; may be different
281  from ctx.nb_streams if new streams appear during av_read_frame() */
282  int nb_streams_warn; /* number of streams that the user was warned of */
283  int rate_emu;
284 
285 #if HAVE_PTHREADS
286  pthread_t thread; /* thread reading from this file */
287  int finished; /* the thread has exited */
288  int joined; /* the thread has been joined */
289  pthread_mutex_t fifo_lock; /* lock for access to fifo */
290  pthread_cond_t fifo_cond; /* the main thread will signal on this cond after reading from fifo */
291  AVFifoBuffer *fifo; /* demuxed packets are stored here; freed by the main thread */
292 #endif
293 } InputFile;
294 
302 };
303 
304 extern const char *const forced_keyframes_const_names[];
305 
306 typedef struct OutputStream {
307  int file_index; /* file index */
308  int index; /* stream index in the output file */
309  int source_index; /* InputStream index */
310  AVStream *st; /* stream in the output file */
311  int encoding_needed; /* true if encoding needed for this stream */
313  /* input pts and corresponding output pts
314  for A/V sync */
315  struct InputStream *sync_ist; /* input stream to sync against */
316  int64_t sync_opts; /* output frame counter, could be changed to some true timestamp */ // FIXME look at frame_number
317  /* pts of the first frame encoded for this stream, used for limiting
318  * recording time */
319  int64_t first_pts;
322  int64_t max_frames;
324 
325  /* video only */
329 
331 
332  /* forced key frames */
333  int64_t *forced_kf_pts;
339 
340  /* audio only */
341  int audio_channels_map[SWR_CH_MAX]; /* list of the channels id to pick from the source stream */
342  int audio_channels_mapped; /* number of channels in audio_channels_map */
343 
345  FILE *logfile;
346 
348  char *avfilter;
349 
350  int64_t sws_flags;
354  int finished; /* no more packets should be written for this stream */
355  int unavailable; /* true if the steram is unavailable (possibly temporarily) */
357  const char *attachment_filename;
360 
362 } OutputStream;
363 
364 typedef struct OutputFile {
367  int ost_index; /* index of the first stream in output_streams */
368  int64_t recording_time; ///< desired length of the resulting file in microseconds == AV_TIME_BASE units
369  int64_t start_time; ///< start time in microseconds == AV_TIME_BASE units
370  uint64_t limit_filesize; /* filesize limit expressed in bytes */
371 
372  int shortest;
373 } OutputFile;
374 
375 extern InputStream **input_streams;
376 extern int nb_input_streams;
377 extern InputFile **input_files;
378 extern int nb_input_files;
379 
381 extern int nb_output_streams;
382 extern OutputFile **output_files;
383 extern int nb_output_files;
384 
385 extern FilterGraph **filtergraphs;
386 extern int nb_filtergraphs;
387 
388 extern char *vstats_filename;
389 
390 extern float audio_drift_threshold;
391 extern float dts_delta_threshold;
392 extern float dts_error_threshold;
393 
394 extern int audio_volume;
395 extern int audio_sync_method;
396 extern int video_sync_method;
397 extern int do_benchmark;
398 extern int do_benchmark_all;
399 extern int do_deinterlace;
400 extern int do_hex_dump;
401 extern int do_pkt_dump;
402 extern int copy_ts;
403 extern int copy_tb;
404 extern int debug_ts;
405 extern int exit_on_error;
406 extern int print_stats;
407 extern int qp_hist;
408 extern int stdin_interaction;
409 extern int frame_bits_per_raw_sample;
410 extern AVIOContext *progress_avio;
411 
412 extern const AVIOInterruptCB int_cb;
413 
414 extern const OptionDef options[];
415 
416 void term_init(void);
417 void term_exit(void);
418 
419 void reset_options(OptionsContext *o, int is_input);
420 void show_usage(void);
421 
422 void opt_output_file(void *optctx, const char *filename);
423 
425 
427 
428 enum AVPixelFormat choose_pixel_fmt(AVStream *st, AVCodec *codec, enum AVPixelFormat target);
429 void choose_sample_fmt(AVStream *st, AVCodec *codec);
430 
435 
436 int ffmpeg_parse_options(int argc, char **argv);
437 
438 #endif /* FFMPEG_H */