FFmpeg
 All Data Structures Namespaces 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"
40 
41 #include "libavutil/avutil.h"
42 #include "libavutil/dict.h"
43 #include "libavutil/eval.h"
44 #include "libavutil/fifo.h"
45 #include "libavutil/pixfmt.h"
46 #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_VSCFR 0xfe
56 #define VSYNC_DROP 0xff
57 
58 #define MAX_STREAMS 1024 /* arbitrary sanity check value */
59 
60 enum HWAccelID {
66 };
67 
68 typedef struct HWAccel {
69  const char *name;
70  int (*init)(AVCodecContext *s);
71  enum HWAccelID id;
73 } HWAccel;
74 
75 /* select an input stream for an output stream */
76 typedef struct StreamMap {
77  int disabled; /* 1 is this mapping is disabled by a negative map */
82  char *linklabel; /* name of an output link, for mapping lavfi outputs */
83 } StreamMap;
84 
85 typedef struct {
86  int file_idx, stream_idx, channel_idx; // input
87  int ofile_idx, ostream_idx; // output
89 
90 typedef struct OptionsContext {
92 
93  /* input/output options */
94  int64_t start_time;
95  const char *format;
96 
109 
110  /* input options */
112  int rate_emu;
114 
123 
124  /* output options */
127  AudioChannelMap *audio_channel_maps; /* one info entry per -map_channel */
128  int nb_audio_channel_maps; /* number of (valid) -map_channel settings */
132  const char **attachments;
134 
136 
137  int64_t recording_time;
138  int64_t stop_time;
139  uint64_t limit_filesize;
140  float mux_preload;
142  int shortest;
143 
148 
149  /* indexed by output file stream index */
152 
200  int nb_pass;
206  int nb_apad;
210 
211 typedef struct InputFilter {
213  struct InputStream *ist;
216 } InputFilter;
217 
218 typedef struct OutputFilter {
220  struct OutputStream *ost;
223 
224  /* temporary storage until stream maps are processed */
226 } OutputFilter;
227 
228 typedef struct FilterGraph {
229  int index;
230  const char *graph_desc;
231 
234 
239 } FilterGraph;
240 
241 typedef struct InputStream {
244  int discard; /* true if stream data should be discarded */
246  int decoding_needed; /* true if the packets must be decoded in 'raw_fifo' */
250  AVFrame *filter_frame; /* a ref of decoded_frame, to be sent to filters */
251 
252  int64_t start; /* time when read started */
253  /* predicted dts of the next packet read for this stream or (when there are
254  * several frames in a packet) of the next frame in current packet (in AV_TIME_BASE units) */
255  int64_t next_dts;
256  int64_t dts; ///< dts of the last packet read for this stream (in AV_TIME_BASE units)
257 
258  int64_t next_pts; ///< synthetic pts for the next decode frame (in AV_TIME_BASE units)
259  int64_t pts; ///< current pts of the decoded frame (in AV_TIME_BASE units)
261 
263 
264  double ts_scale;
268  AVRational framerate; /* framerate forced with -r */
271 
275 
280 
282  struct { /* previous decoded subtitle and related variables */
284  int ret;
286  } prev_sub;
287 
288  struct sub2video {
289  int64_t last_pts;
290  int64_t end_pts;
292  int w, h;
293  } sub2video;
294 
295  int dr1;
296 
297  /* decoded data from this stream goes into all those filters
298  * currently video and audio only */
301 
303 
304  /* hwaccel options */
307 
308  /* hwaccel context */
310  void *hwaccel_ctx;
316 
317  /* stats */
318  // combined size of all the packets read
319  uint64_t data_size;
320  /* number of packets successfully read for this stream */
321  uint64_t nb_packets;
322  // number of frames/samples retrieved from the decoder
323  uint64_t frames_decoded;
324  uint64_t samples_decoded;
325 } InputStream;
326 
327 typedef struct InputFile {
329  int eof_reached; /* true if eof reached */
330  int eagain; /* true if last read attempt returned EAGAIN */
331  int ist_index; /* index of first stream in input_streams */
333  int64_t ts_offset;
334  int64_t last_ts;
335  int64_t start_time; /* user-specified start time in AV_TIME_BASE or AV_NOPTS_VALUE */
336  int64_t recording_time;
337  int nb_streams; /* number of stream that ffmpeg is aware of; may be different
338  from ctx.nb_streams if new streams appear during av_read_frame() */
339  int nb_streams_warn; /* number of streams that the user was warned of */
340  int rate_emu;
342 
343 #if HAVE_PTHREADS
344  AVThreadMessageQueue *in_thread_queue;
345  pthread_t thread; /* thread reading from this file */
346  int non_blocking; /* reading packets from the thread should not block */
347  int joined; /* the thread has been joined */
348 #endif
349 } InputFile;
350 
358 };
359 
360 extern const char *const forced_keyframes_const_names[];
361 
362 typedef enum {
365 } OSTFinished ;
366 
367 typedef struct OutputStream {
368  int file_index; /* file index */
369  int index; /* stream index in the output file */
370  int source_index; /* InputStream index */
371  AVStream *st; /* stream in the output file */
372  int encoding_needed; /* true if encoding needed for this stream */
374  /* input pts and corresponding output pts
375  for A/V sync */
376  struct InputStream *sync_ist; /* input stream to sync against */
377  int64_t sync_opts; /* output frame counter, could be changed to some true timestamp */ // FIXME look at frame_number
378  /* pts of the first frame encoded for this stream, used for limiting
379  * recording time */
380  int64_t first_pts;
381  /* dts of the last packet sent to the muxer */
382  int64_t last_mux_dts;
386  int64_t max_frames;
388 
389  /* video only */
393 
395 
396  /* forced key frames */
397  int64_t *forced_kf_pts;
403 
404  /* audio only */
405  int *audio_channels_map; /* list of the channels id to pick from the source stream */
406  int audio_channels_mapped; /* number of channels in audio_channels_map */
407 
409  FILE *logfile;
410 
412  char *avfilter;
413  char *filters; ///< filtergraph associated to the -filter option
414  char *filters_script; ///< filtergraph script associated to the -filter_script option
415 
416  int64_t sws_flags;
420  char *apad;
421  OSTFinished finished; /* no more packets should be written for this stream */
422  int unavailable; /* true if the steram is unavailable (possibly temporarily) */
424  const char *attachment_filename;
427 
429 
431 
432  /* stats */
433  // combined size of all the packets written
434  uint64_t data_size;
435  // number of packets send to the muxer
436  uint64_t packets_written;
437  // number of frames/samples sent to the encoder
438  uint64_t frames_encoded;
439  uint64_t samples_encoded;
440 } OutputStream;
441 
442 typedef struct OutputFile {
445  int ost_index; /* index of the first stream in output_streams */
446  int64_t recording_time; ///< desired length of the resulting file in microseconds == AV_TIME_BASE units
447  int64_t start_time; ///< start time in microseconds == AV_TIME_BASE units
448  uint64_t limit_filesize; /* filesize limit expressed in bytes */
449 
450  int shortest;
451 } OutputFile;
452 
453 extern InputStream **input_streams;
454 extern int nb_input_streams;
455 extern InputFile **input_files;
456 extern int nb_input_files;
457 
459 extern int nb_output_streams;
460 extern OutputFile **output_files;
461 extern int nb_output_files;
462 
463 extern FilterGraph **filtergraphs;
464 extern int nb_filtergraphs;
465 
466 extern char *vstats_filename;
467 
468 extern float audio_drift_threshold;
469 extern float dts_delta_threshold;
470 extern float dts_error_threshold;
471 
472 extern int audio_volume;
473 extern int audio_sync_method;
474 extern int video_sync_method;
475 extern int do_benchmark;
476 extern int do_benchmark_all;
477 extern int do_deinterlace;
478 extern int do_hex_dump;
479 extern int do_pkt_dump;
480 extern int copy_ts;
481 extern int copy_tb;
482 extern int debug_ts;
483 extern int exit_on_error;
484 extern int print_stats;
485 extern int qp_hist;
486 extern int stdin_interaction;
487 extern int frame_bits_per_raw_sample;
488 extern AVIOContext *progress_avio;
489 extern float max_error_rate;
490 
491 extern const AVIOInterruptCB int_cb;
492 
493 extern const OptionDef options[];
494 extern const HWAccel hwaccels[];
495 
496 
497 void term_init(void);
498 void term_exit(void);
499 
500 void reset_options(OptionsContext *o, int is_input);
501 void show_usage(void);
502 
503 void opt_output_file(void *optctx, const char *filename);
504 
507 
509 
510 enum AVPixelFormat choose_pixel_fmt(AVStream *st, AVCodecContext *avctx, AVCodec *codec, enum AVPixelFormat target);
511 void choose_sample_fmt(AVStream *st, AVCodec *codec);
512 
517 
518 int ffmpeg_parse_options(int argc, char **argv);
519 
523 
524 #endif /* FFMPEG_H */