lavf/movenc: Do not print an error when muxing gray8 rawvideo.
[ffmpeg.git] / ffmpeg.h
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"
47 #include "libavutil/threadmessage.h"
48
49 #include "libswresample/swresample.h"
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 {
61     HWACCEL_NONE = 0,
62     HWACCEL_AUTO,
63     HWACCEL_VDPAU,
64     HWACCEL_DXVA2,
65     HWACCEL_VDA,
66     HWACCEL_VIDEOTOOLBOX,
67     HWACCEL_QSV,
68     HWACCEL_VAAPI,
69     HWACCEL_CUVID,
70 };
71
72 typedef struct HWAccel {
73     const char *name;
74     int (*init)(AVCodecContext *s);
75     enum HWAccelID id;
76     enum AVPixelFormat pix_fmt;
77 } HWAccel;
78
79 /* select an input stream for an output stream */
80 typedef struct StreamMap {
81     int disabled;           /* 1 is this mapping is disabled by a negative map */
82     int file_index;
83     int stream_index;
84     int sync_file_index;
85     int sync_stream_index;
86     char *linklabel;       /* name of an output link, for mapping lavfi outputs */
87 } StreamMap;
88
89 typedef struct {
90     int  file_idx,  stream_idx,  channel_idx; // input
91     int ofile_idx, ostream_idx;               // output
92 } AudioChannelMap;
93
94 typedef struct OptionsContext {
95     OptionGroup *g;
96
97     /* input/output options */
98     int64_t start_time;
99     int64_t start_time_eof;
100     int seek_timestamp;
101     const char *format;
102
103     SpecifierOpt *codec_names;
104     int        nb_codec_names;
105     SpecifierOpt *audio_channels;
106     int        nb_audio_channels;
107     SpecifierOpt *audio_sample_rate;
108     int        nb_audio_sample_rate;
109     SpecifierOpt *frame_rates;
110     int        nb_frame_rates;
111     SpecifierOpt *frame_sizes;
112     int        nb_frame_sizes;
113     SpecifierOpt *frame_pix_fmts;
114     int        nb_frame_pix_fmts;
115
116     /* input options */
117     int64_t input_ts_offset;
118     int loop;
119     int rate_emu;
120     int accurate_seek;
121     int thread_queue_size;
122
123     SpecifierOpt *ts_scale;
124     int        nb_ts_scale;
125     SpecifierOpt *dump_attachment;
126     int        nb_dump_attachment;
127     SpecifierOpt *hwaccels;
128     int        nb_hwaccels;
129     SpecifierOpt *hwaccel_devices;
130     int        nb_hwaccel_devices;
131     SpecifierOpt *hwaccel_output_formats;
132     int        nb_hwaccel_output_formats;
133     SpecifierOpt *autorotate;
134     int        nb_autorotate;
135
136     /* output options */
137     StreamMap *stream_maps;
138     int     nb_stream_maps;
139     AudioChannelMap *audio_channel_maps; /* one info entry per -map_channel */
140     int           nb_audio_channel_maps; /* number of (valid) -map_channel settings */
141     int metadata_global_manual;
142     int metadata_streams_manual;
143     int metadata_chapters_manual;
144     const char **attachments;
145     int       nb_attachments;
146
147     int chapters_input_file;
148
149     int64_t recording_time;
150     int64_t stop_time;
151     uint64_t limit_filesize;
152     float mux_preload;
153     float mux_max_delay;
154     int shortest;
155
156     int video_disable;
157     int audio_disable;
158     int subtitle_disable;
159     int data_disable;
160
161     /* indexed by output file stream index */
162     int   *streamid_map;
163     int nb_streamid_map;
164
165     SpecifierOpt *metadata;
166     int        nb_metadata;
167     SpecifierOpt *max_frames;
168     int        nb_max_frames;
169     SpecifierOpt *bitstream_filters;
170     int        nb_bitstream_filters;
171     SpecifierOpt *codec_tags;
172     int        nb_codec_tags;
173     SpecifierOpt *sample_fmts;
174     int        nb_sample_fmts;
175     SpecifierOpt *qscale;
176     int        nb_qscale;
177     SpecifierOpt *forced_key_frames;
178     int        nb_forced_key_frames;
179     SpecifierOpt *force_fps;
180     int        nb_force_fps;
181     SpecifierOpt *frame_aspect_ratios;
182     int        nb_frame_aspect_ratios;
183     SpecifierOpt *rc_overrides;
184     int        nb_rc_overrides;
185     SpecifierOpt *intra_matrices;
186     int        nb_intra_matrices;
187     SpecifierOpt *inter_matrices;
188     int        nb_inter_matrices;
189     SpecifierOpt *chroma_intra_matrices;
190     int        nb_chroma_intra_matrices;
191     SpecifierOpt *top_field_first;
192     int        nb_top_field_first;
193     SpecifierOpt *metadata_map;
194     int        nb_metadata_map;
195     SpecifierOpt *presets;
196     int        nb_presets;
197     SpecifierOpt *copy_initial_nonkeyframes;
198     int        nb_copy_initial_nonkeyframes;
199     SpecifierOpt *copy_prior_start;
200     int        nb_copy_prior_start;
201     SpecifierOpt *filters;
202     int        nb_filters;
203     SpecifierOpt *filter_scripts;
204     int        nb_filter_scripts;
205     SpecifierOpt *reinit_filters;
206     int        nb_reinit_filters;
207     SpecifierOpt *fix_sub_duration;
208     int        nb_fix_sub_duration;
209     SpecifierOpt *canvas_sizes;
210     int        nb_canvas_sizes;
211     SpecifierOpt *pass;
212     int        nb_pass;
213     SpecifierOpt *passlogfiles;
214     int        nb_passlogfiles;
215     SpecifierOpt *max_muxing_queue_size;
216     int        nb_max_muxing_queue_size;
217     SpecifierOpt *guess_layout_max;
218     int        nb_guess_layout_max;
219     SpecifierOpt *apad;
220     int        nb_apad;
221     SpecifierOpt *discard;
222     int        nb_discard;
223     SpecifierOpt *disposition;
224     int        nb_disposition;
225     SpecifierOpt *program;
226     int        nb_program;
227 } OptionsContext;
228
229 typedef struct InputFilter {
230     AVFilterContext    *filter;
231     struct InputStream *ist;
232     struct FilterGraph *graph;
233     uint8_t            *name;
234
235     // parameters configured for this input
236     int format;
237
238     int width, height;
239     AVRational sample_aspect_ratio;
240
241     int sample_rate;
242     int channels;
243     uint64_t channel_layout;
244
245     AVBufferRef *hw_frames_ctx;
246 } InputFilter;
247
248 typedef struct OutputFilter {
249     AVFilterContext     *filter;
250     struct OutputStream *ost;
251     struct FilterGraph  *graph;
252     uint8_t             *name;
253
254     /* temporary storage until stream maps are processed */
255     AVFilterInOut       *out_tmp;
256     enum AVMediaType     type;
257 } OutputFilter;
258
259 typedef struct FilterGraph {
260     int            index;
261     const char    *graph_desc;
262
263     AVFilterGraph *graph;
264     int reconfiguration;
265
266     InputFilter   **inputs;
267     int          nb_inputs;
268     OutputFilter **outputs;
269     int         nb_outputs;
270 } FilterGraph;
271
272 typedef struct InputStream {
273     int file_index;
274     AVStream *st;
275     int discard;             /* true if stream data should be discarded */
276     int user_set_discard;
277     int decoding_needed;     /* non zero if the packets must be decoded in 'raw_fifo', see DECODING_FOR_* */
278 #define DECODING_FOR_OST    1
279 #define DECODING_FOR_FILTER 2
280
281     AVCodecContext *dec_ctx;
282     AVCodec *dec;
283     AVFrame *decoded_frame;
284     AVFrame *filter_frame; /* a ref of decoded_frame, to be sent to filters */
285
286     int64_t       start;     /* time when read started */
287     /* predicted dts of the next packet read for this stream or (when there are
288      * several frames in a packet) of the next frame in current packet (in AV_TIME_BASE units) */
289     int64_t       next_dts;
290     int64_t       dts;       ///< dts of the last packet read for this stream (in AV_TIME_BASE units)
291
292     int64_t       next_pts;  ///< synthetic pts for the next decode frame (in AV_TIME_BASE units)
293     int64_t       pts;       ///< current pts of the decoded frame  (in AV_TIME_BASE units)
294     int           wrap_correction_done;
295
296     int64_t filter_in_rescale_delta_last;
297
298     int64_t min_pts; /* pts with the smallest value in a current stream */
299     int64_t max_pts; /* pts with the higher value in a current stream */
300     int64_t nb_samples; /* number of samples in the last decoded audio frame before looping */
301
302     double ts_scale;
303     int saw_first_ts;
304     AVDictionary *decoder_opts;
305     AVRational framerate;               /* framerate forced with -r */
306     int top_field_first;
307     int guess_layout_max;
308
309     int autorotate;
310     int resample_height;
311     int resample_width;
312     int resample_pix_fmt;
313
314     int      resample_sample_fmt;
315     int      resample_sample_rate;
316     int      resample_channels;
317     uint64_t resample_channel_layout;
318
319     int fix_sub_duration;
320     struct { /* previous decoded subtitle and related variables */
321         int got_output;
322         int ret;
323         AVSubtitle subtitle;
324     } prev_sub;
325
326     struct sub2video {
327         int64_t last_pts;
328         int64_t end_pts;
329         AVFrame *frame;
330         int w, h;
331     } sub2video;
332
333     int dr1;
334
335     /* decoded data from this stream goes into all those filters
336      * currently video and audio only */
337     InputFilter **filters;
338     int        nb_filters;
339
340     int reinit_filters;
341
342     /* hwaccel options */
343     enum HWAccelID hwaccel_id;
344     char  *hwaccel_device;
345     enum AVPixelFormat hwaccel_output_format;
346
347     /* hwaccel context */
348     enum HWAccelID active_hwaccel_id;
349     void  *hwaccel_ctx;
350     void (*hwaccel_uninit)(AVCodecContext *s);
351     int  (*hwaccel_get_buffer)(AVCodecContext *s, AVFrame *frame, int flags);
352     int  (*hwaccel_retrieve_data)(AVCodecContext *s, AVFrame *frame);
353     enum AVPixelFormat hwaccel_pix_fmt;
354     enum AVPixelFormat hwaccel_retrieved_pix_fmt;
355     AVBufferRef *hw_frames_ctx;
356
357     /* stats */
358     // combined size of all the packets read
359     uint64_t data_size;
360     /* number of packets successfully read for this stream */
361     uint64_t nb_packets;
362     // number of frames/samples retrieved from the decoder
363     uint64_t frames_decoded;
364     uint64_t samples_decoded;
365
366     int64_t *dts_buffer;
367     int nb_dts_buffer;
368 } InputStream;
369
370 typedef struct InputFile {
371     AVFormatContext *ctx;
372     int eof_reached;      /* true if eof reached */
373     int eagain;           /* true if last read attempt returned EAGAIN */
374     int ist_index;        /* index of first stream in input_streams */
375     int loop;             /* set number of times input stream should be looped */
376     int64_t duration;     /* actual duration of the longest stream in a file
377                              at the moment when looping happens */
378     AVRational time_base; /* time base of the duration */
379     int64_t input_ts_offset;
380
381     int64_t ts_offset;
382     int64_t last_ts;
383     int64_t start_time;   /* user-specified start time in AV_TIME_BASE or AV_NOPTS_VALUE */
384     int seek_timestamp;
385     int64_t recording_time;
386     int nb_streams;       /* number of stream that ffmpeg is aware of; may be different
387                              from ctx.nb_streams if new streams appear during av_read_frame() */
388     int nb_streams_warn;  /* number of streams that the user was warned of */
389     int rate_emu;
390     int accurate_seek;
391
392 #if HAVE_PTHREADS
393     AVThreadMessageQueue *in_thread_queue;
394     pthread_t thread;           /* thread reading from this file */
395     int non_blocking;           /* reading packets from the thread should not block */
396     int joined;                 /* the thread has been joined */
397     int thread_queue_size;      /* maximum number of queued packets */
398 #endif
399 } InputFile;
400
401 enum forced_keyframes_const {
402     FKF_N,
403     FKF_N_FORCED,
404     FKF_PREV_FORCED_N,
405     FKF_PREV_FORCED_T,
406     FKF_T,
407     FKF_NB
408 };
409
410 #define ABORT_ON_FLAG_EMPTY_OUTPUT (1 <<  0)
411
412 extern const char *const forced_keyframes_const_names[];
413
414 typedef enum {
415     ENCODER_FINISHED = 1,
416     MUXER_FINISHED = 2,
417 } OSTFinished ;
418
419 typedef struct OutputStream {
420     int file_index;          /* file index */
421     int index;               /* stream index in the output file */
422     int source_index;        /* InputStream index */
423     AVStream *st;            /* stream in the output file */
424     int encoding_needed;     /* true if encoding needed for this stream */
425     int frame_number;
426     /* input pts and corresponding output pts
427        for A/V sync */
428     struct InputStream *sync_ist; /* input stream to sync against */
429     int64_t sync_opts;       /* output frame counter, could be changed to some true timestamp */ // FIXME look at frame_number
430     /* pts of the first frame encoded for this stream, used for limiting
431      * recording time */
432     int64_t first_pts;
433     /* dts of the last packet sent to the muxer */
434     int64_t last_mux_dts;
435
436     int                    nb_bitstream_filters;
437     uint8_t                  *bsf_extradata_updated;
438     AVBSFContext            **bsf_ctx;
439
440     AVCodecContext *enc_ctx;
441     AVCodecParameters *ref_par; /* associated input codec parameters with encoders options applied */
442     AVCodec *enc;
443     int64_t max_frames;
444     AVFrame *filtered_frame;
445     AVFrame *last_frame;
446     int last_dropped;
447     int last_nb0_frames[3];
448
449     void  *hwaccel_ctx;
450
451     /* video only */
452     AVRational frame_rate;
453     int is_cfr;
454     int force_fps;
455     int top_field_first;
456     int rotate_overridden;
457
458     AVRational frame_aspect_ratio;
459
460     /* forced key frames */
461     int64_t *forced_kf_pts;
462     int forced_kf_count;
463     int forced_kf_index;
464     char *forced_keyframes;
465     AVExpr *forced_keyframes_pexpr;
466     double forced_keyframes_expr_const_values[FKF_NB];
467
468     /* audio only */
469     int *audio_channels_map;             /* list of the channels id to pick from the source stream */
470     int audio_channels_mapped;           /* number of channels in audio_channels_map */
471
472     char *logfile_prefix;
473     FILE *logfile;
474
475     OutputFilter *filter;
476     char *avfilter;
477     char *filters;         ///< filtergraph associated to the -filter option
478     char *filters_script;  ///< filtergraph script associated to the -filter_script option
479
480     AVDictionary *encoder_opts;
481     AVDictionary *sws_dict;
482     AVDictionary *swr_opts;
483     AVDictionary *resample_opts;
484     char *apad;
485     OSTFinished finished;        /* no more packets should be written for this stream */
486     int unavailable;                     /* true if the steram is unavailable (possibly temporarily) */
487     int stream_copy;
488
489     // init_output_stream() has been called for this stream
490     // The encoder and the bitstream filters have been initialized and the stream
491     // parameters are set in the AVStream.
492     int initialized;
493
494     const char *attachment_filename;
495     int copy_initial_nonkeyframes;
496     int copy_prior_start;
497     char *disposition;
498
499     int keep_pix_fmt;
500
501     AVCodecParserContext *parser;
502     AVCodecContext       *parser_avctx;
503
504     /* stats */
505     // combined size of all the packets written
506     uint64_t data_size;
507     // number of packets send to the muxer
508     uint64_t packets_written;
509     // number of frames/samples sent to the encoder
510     uint64_t frames_encoded;
511     uint64_t samples_encoded;
512
513     /* packet quality factor */
514     int quality;
515
516     int max_muxing_queue_size;
517
518     /* the packets are buffered here until the muxer is ready to be initialized */
519     AVFifoBuffer *muxing_queue;
520
521     /* packet picture type */
522     int pict_type;
523
524     /* frame encode sum of squared error values */
525     int64_t error[4];
526 } OutputStream;
527
528 typedef struct OutputFile {
529     AVFormatContext *ctx;
530     AVDictionary *opts;
531     int ost_index;       /* index of the first stream in output_streams */
532     int64_t recording_time;  ///< desired length of the resulting file in microseconds == AV_TIME_BASE units
533     int64_t start_time;      ///< start time in microseconds == AV_TIME_BASE units
534     uint64_t limit_filesize; /* filesize limit expressed in bytes */
535
536     int shortest;
537
538     int header_written;
539 } OutputFile;
540
541 extern InputStream **input_streams;
542 extern int        nb_input_streams;
543 extern InputFile   **input_files;
544 extern int        nb_input_files;
545
546 extern OutputStream **output_streams;
547 extern int         nb_output_streams;
548 extern OutputFile   **output_files;
549 extern int         nb_output_files;
550
551 extern FilterGraph **filtergraphs;
552 extern int        nb_filtergraphs;
553
554 extern char *vstats_filename;
555 extern char *sdp_filename;
556
557 extern float audio_drift_threshold;
558 extern float dts_delta_threshold;
559 extern float dts_error_threshold;
560
561 extern int audio_volume;
562 extern int audio_sync_method;
563 extern int video_sync_method;
564 extern float frame_drop_threshold;
565 extern int do_benchmark;
566 extern int do_benchmark_all;
567 extern int do_deinterlace;
568 extern int do_hex_dump;
569 extern int do_pkt_dump;
570 extern int copy_ts;
571 extern int start_at_zero;
572 extern int copy_tb;
573 extern int debug_ts;
574 extern int exit_on_error;
575 extern int abort_on_flags;
576 extern int print_stats;
577 extern int qp_hist;
578 extern int stdin_interaction;
579 extern int frame_bits_per_raw_sample;
580 extern AVIOContext *progress_avio;
581 extern float max_error_rate;
582 extern char *videotoolbox_pixfmt;
583
584 extern const AVIOInterruptCB int_cb;
585
586 extern const OptionDef options[];
587 extern const HWAccel hwaccels[];
588 extern int hwaccel_lax_profile_check;
589 extern AVBufferRef *hw_device_ctx;
590
591
592 void term_init(void);
593 void term_exit(void);
594
595 void reset_options(OptionsContext *o, int is_input);
596 void show_usage(void);
597
598 void opt_output_file(void *optctx, const char *filename);
599
600 void remove_avoptions(AVDictionary **a, AVDictionary *b);
601 void assert_avoptions(AVDictionary *m);
602
603 int guess_input_channel_layout(InputStream *ist);
604
605 enum AVPixelFormat choose_pixel_fmt(AVStream *st, AVCodecContext *avctx, AVCodec *codec, enum AVPixelFormat target);
606 void choose_sample_fmt(AVStream *st, AVCodec *codec);
607
608 int configure_filtergraph(FilterGraph *fg);
609 int configure_output_filter(FilterGraph *fg, OutputFilter *ofilter, AVFilterInOut *out);
610 int ist_in_filtergraph(FilterGraph *fg, InputStream *ist);
611 int filtergraph_is_simple(FilterGraph *fg);
612 int init_simple_filtergraph(InputStream *ist, OutputStream *ost);
613 int init_complex_filtergraph(FilterGraph *fg);
614
615 int ifilter_parameters_from_frame(InputFilter *ifilter, const AVFrame *frame);
616 int ifilter_parameters_from_decoder(InputFilter *ifilter, const AVCodecContext *avctx);
617
618 int ffmpeg_parse_options(int argc, char **argv);
619
620 int vdpau_init(AVCodecContext *s);
621 int dxva2_init(AVCodecContext *s);
622 int vda_init(AVCodecContext *s);
623 int videotoolbox_init(AVCodecContext *s);
624 int qsv_init(AVCodecContext *s);
625 int qsv_transcode_init(OutputStream *ost);
626 int vaapi_decode_init(AVCodecContext *avctx);
627 int vaapi_device_init(const char *device);
628 int cuvid_init(AVCodecContext *s);
629 int cuvid_transcode_init(OutputStream *ost);
630
631 #endif /* FFMPEG_H */