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;
115 
124 
125  /* output options */
128  AudioChannelMap *audio_channel_maps; /* one info entry per -map_channel */
129  int nb_audio_channel_maps; /* number of (valid) -map_channel settings */
133  const char **attachments;
135 
137 
138  int64_t recording_time;
139  int64_t stop_time;
140  uint64_t limit_filesize;
141  float mux_preload;
143  int shortest;
144 
149 
150  /* indexed by output file stream index */
153 
201  int nb_pass;
207  int nb_apad;
213 
214 typedef struct InputFilter {
216  struct InputStream *ist;
219 } InputFilter;
220 
221 typedef struct OutputFilter {
223  struct OutputStream *ost;
226 
227  /* temporary storage until stream maps are processed */
229 } OutputFilter;
230 
231 typedef struct FilterGraph {
232  int index;
233  const char *graph_desc;
234 
237 
242 } FilterGraph;
243 
244 typedef struct InputStream {
247  int discard; /* true if stream data should be discarded */
249  int decoding_needed; /* non zero if the packets must be decoded in 'raw_fifo', see DECODING_FOR_* */
250 #define DECODING_FOR_OST 1
251 #define DECODING_FOR_FILTER 2
252 
256  AVFrame *filter_frame; /* a ref of decoded_frame, to be sent to filters */
257 
258  int64_t start; /* time when read started */
259  /* predicted dts of the next packet read for this stream or (when there are
260  * several frames in a packet) of the next frame in current packet (in AV_TIME_BASE units) */
261  int64_t next_dts;
262  int64_t dts; ///< dts of the last packet read for this stream (in AV_TIME_BASE units)
263 
264  int64_t next_pts; ///< synthetic pts for the next decode frame (in AV_TIME_BASE units)
265  int64_t pts; ///< current pts of the decoded frame (in AV_TIME_BASE units)
267 
269 
270  double ts_scale;
274  AVRational framerate; /* framerate forced with -r */
277 
281 
286 
288  struct { /* previous decoded subtitle and related variables */
290  int ret;
292  } prev_sub;
293 
294  struct sub2video {
295  int64_t last_pts;
296  int64_t end_pts;
298  int w, h;
299  } sub2video;
300 
301  int dr1;
302 
303  /* decoded data from this stream goes into all those filters
304  * currently video and audio only */
307 
309 
310  /* hwaccel options */
313 
314  /* hwaccel context */
316  void *hwaccel_ctx;
322 
323  /* stats */
324  // combined size of all the packets read
325  uint64_t data_size;
326  /* number of packets successfully read for this stream */
327  uint64_t nb_packets;
328  // number of frames/samples retrieved from the decoder
329  uint64_t frames_decoded;
330  uint64_t samples_decoded;
331 } InputStream;
332 
333 typedef struct InputFile {
335  int eof_reached; /* true if eof reached */
336  int eagain; /* true if last read attempt returned EAGAIN */
337  int ist_index; /* index of first stream in input_streams */
339  int64_t ts_offset;
340  int64_t last_ts;
341  int64_t start_time; /* user-specified start time in AV_TIME_BASE or AV_NOPTS_VALUE */
342  int64_t recording_time;
343  int nb_streams; /* number of stream that ffmpeg is aware of; may be different
344  from ctx.nb_streams if new streams appear during av_read_frame() */
345  int nb_streams_warn; /* number of streams that the user was warned of */
346  int rate_emu;
348 
349 #if HAVE_PTHREADS
350  AVThreadMessageQueue *in_thread_queue;
351  pthread_t thread; /* thread reading from this file */
352  int non_blocking; /* reading packets from the thread should not block */
353  int joined; /* the thread has been joined */
354  int thread_queue_size; /* maximum number of queued packets */
355 #endif
356 } InputFile;
357 
365 };
366 
367 extern const char *const forced_keyframes_const_names[];
368 
369 typedef enum {
372 } OSTFinished ;
373 
374 typedef struct OutputStream {
375  int file_index; /* file index */
376  int index; /* stream index in the output file */
377  int source_index; /* InputStream index */
378  AVStream *st; /* stream in the output file */
379  int encoding_needed; /* true if encoding needed for this stream */
381  /* input pts and corresponding output pts
382  for A/V sync */
383  struct InputStream *sync_ist; /* input stream to sync against */
384  int64_t sync_opts; /* output frame counter, could be changed to some true timestamp */ // FIXME look at frame_number
385  /* pts of the first frame encoded for this stream, used for limiting
386  * recording time */
387  int64_t first_pts;
388  /* dts of the last packet sent to the muxer */
389  int64_t last_mux_dts;
393  int64_t max_frames;
397 
398  /* video only */
402 
404 
405  /* forced key frames */
406  int64_t *forced_kf_pts;
412 
413  /* audio only */
414  int *audio_channels_map; /* list of the channels id to pick from the source stream */
415  int audio_channels_mapped; /* number of channels in audio_channels_map */
416 
418  FILE *logfile;
419 
421  char *avfilter;
422  char *filters; ///< filtergraph associated to the -filter option
423  char *filters_script; ///< filtergraph script associated to the -filter_script option
424 
425  int64_t sws_flags;
430  char *apad;
431  OSTFinished finished; /* no more packets should be written for this stream */
432  int unavailable; /* true if the steram is unavailable (possibly temporarily) */
434  const char *attachment_filename;
437  char *disposition;
438 
440 
442 
443  /* stats */
444  // combined size of all the packets written
445  uint64_t data_size;
446  // number of packets send to the muxer
447  uint64_t packets_written;
448  // number of frames/samples sent to the encoder
449  uint64_t frames_encoded;
450  uint64_t samples_encoded;
451 } OutputStream;
452 
453 typedef struct OutputFile {
456  int ost_index; /* index of the first stream in output_streams */
457  int64_t recording_time; ///< desired length of the resulting file in microseconds == AV_TIME_BASE units
458  int64_t start_time; ///< start time in microseconds == AV_TIME_BASE units
459  uint64_t limit_filesize; /* filesize limit expressed in bytes */
460 
461  int shortest;
462 } OutputFile;
463 
464 extern InputStream **input_streams;
465 extern int nb_input_streams;
466 extern InputFile **input_files;
467 extern int nb_input_files;
468 
470 extern int nb_output_streams;
471 extern OutputFile **output_files;
472 extern int nb_output_files;
473 
474 extern FilterGraph **filtergraphs;
475 extern int nb_filtergraphs;
476 
477 extern char *vstats_filename;
478 extern char *sdp_filename;
479 
480 extern float audio_drift_threshold;
481 extern float dts_delta_threshold;
482 extern float dts_error_threshold;
483 
484 extern int audio_volume;
485 extern int audio_sync_method;
486 extern int video_sync_method;
487 extern float frame_drop_threshold;
488 extern int do_benchmark;
489 extern int do_benchmark_all;
490 extern int do_deinterlace;
491 extern int do_hex_dump;
492 extern int do_pkt_dump;
493 extern int copy_ts;
494 extern int start_at_zero;
495 extern int copy_tb;
496 extern int debug_ts;
497 extern int exit_on_error;
498 extern int print_stats;
499 extern int qp_hist;
500 extern int stdin_interaction;
501 extern int frame_bits_per_raw_sample;
502 extern AVIOContext *progress_avio;
503 extern float max_error_rate;
504 extern int vdpau_api_ver;
505 
506 extern const AVIOInterruptCB int_cb;
507 
508 extern const OptionDef options[];
509 extern const HWAccel hwaccels[];
510 
511 
512 void term_init(void);
513 void term_exit(void);
514 
515 void reset_options(OptionsContext *o, int is_input);
516 void show_usage(void);
517 
518 void opt_output_file(void *optctx, const char *filename);
519 
522 
524 
525 enum AVPixelFormat choose_pixel_fmt(AVStream *st, AVCodecContext *avctx, AVCodec *codec, enum AVPixelFormat target);
526 void choose_sample_fmt(AVStream *st, AVCodec *codec);
527 
532 
533 int ffmpeg_parse_options(int argc, char **argv);
534 
538 
539 #endif /* FFMPEG_H */