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