FFmpeg
qsv_internal.h
Go to the documentation of this file.
1 /*
2  * Intel MediaSDK QSV encoder/decoder shared code
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 #ifndef AVCODEC_QSV_INTERNAL_H
22 #define AVCODEC_QSV_INTERNAL_H
23 
24 #include "config.h"
25 
26 #if CONFIG_VAAPI && !defined(_WIN32) // Do not enable for libva-win32 on Windows
27 #define AVCODEC_QSV_LINUX_SESSION_HANDLE
28 #endif //CONFIG_VAAPI && !defined(_WIN32)
29 
30 #ifdef AVCODEC_QSV_LINUX_SESSION_HANDLE
31 #include <stdio.h>
32 #include <string.h>
33 #if HAVE_UNISTD_H
34 #include <unistd.h>
35 #endif
36 #include <fcntl.h>
37 #include <va/va.h>
39 #endif
40 
41 #include <mfxvideo.h>
42 
43 #include "libavutil/frame.h"
44 
45 #include "avcodec.h"
46 
47 #define QSV_VERSION_MAJOR 1
48 #define QSV_VERSION_MINOR 1
49 
50 #define ASYNC_DEPTH_DEFAULT 4 // internal parallelism
51 
52 #define QSV_MAX_ENC_PAYLOAD 2 // # of mfxEncodeCtrl payloads supported
53 #define QSV_MAX_ENC_EXTPARAM 8 // # of mfxEncodeCtrl extparam supported
54 
55 #define QSV_MAX_ROI_NUM 256
56 
57 #define QSV_MAX_FRAME_EXT_PARAMS 4
58 
59 #define QSV_VERSION_ATLEAST(MAJOR, MINOR) \
60  (MFX_VERSION_MAJOR > (MAJOR) || \
61  MFX_VERSION_MAJOR == (MAJOR) && MFX_VERSION_MINOR >= (MINOR))
62 
63 #define QSV_RUNTIME_VERSION_ATLEAST(MFX_VERSION, MAJOR, MINOR) \
64  ((MFX_VERSION.Major > (MAJOR)) || \
65  (MFX_VERSION.Major == (MAJOR) && MFX_VERSION.Minor >= (MINOR)))
66 
67 #define QSV_ONEVPL QSV_VERSION_ATLEAST(2, 0)
68 #define QSV_HAVE_OPAQUE !QSV_ONEVPL
69 
70 typedef struct QSVMid {
72  mfxHDLPair *handle_pair;
73 
76  mfxFrameSurface1 surf;
77 } QSVMid;
78 
79 typedef struct QSVFrame {
81  mfxFrameSurface1 surface;
82  mfxEncodeCtrl enc_ctrl;
83  mfxExtDecodedFrameInfo dec_info;
84 #if QSV_VERSION_ATLEAST(1, 34)
85  mfxExtAV1FilmGrainParam av1_film_grain_param;
86 #endif
87 
88 #if QSV_VERSION_ATLEAST(1, 35)
89  mfxExtMasteringDisplayColourVolume mdcv;
90  mfxExtContentLightLevelInfo clli;
91 #endif
92 
95 
96  mfxPayload *payloads[QSV_MAX_ENC_PAYLOAD]; ///< used for enc_ctrl.Payload
97  mfxExtBuffer *extparam[QSV_MAX_ENC_EXTPARAM]; ///< used for enc_ctrl.ExtParam
98 
99  int queued;
100  int used;
101 
102  struct QSVFrame *next;
103 } QSVFrame;
104 
105 typedef struct QSVSession {
106  mfxSession session;
107 #ifdef AVCODEC_QSV_LINUX_SESSION_HANDLE
108  AVBufferRef *va_device_ref;
109  AVHWDeviceContext *va_device_ctx;
110 #endif
111  void *loader;
112 } QSVSession;
113 
114 typedef struct QSVFramesContext {
116  void *logctx;
117 
118  /**
119  * The memory ids for the external frames.
120  * Refcounted (via the RefStruct API), since we need one reference
121  * owned by the QSVFramesContext (i.e. by the encoder/decoder) and
122  * another one given to the MFX session from the frame allocator.
123  */
125  int nb_mids;
127 
128 int ff_qsv_print_iopattern(void *log_ctx, int mfx_iopattern,
129  const char *extra_string);
130 
131 int ff_qsv_print_error(void *log_ctx, mfxStatus err,
132  const char *error_string);
133 
134 int ff_qsv_print_warning(void *log_ctx, mfxStatus err,
135  const char *warning_string);
136 
138 
139 enum AVPixelFormat ff_qsv_map_fourcc(uint32_t fourcc);
140 
141 int ff_qsv_map_pixfmt(enum AVPixelFormat format, uint32_t *fourcc, uint16_t *shift);
142 enum AVPictureType ff_qsv_map_pictype(int mfx_pic_type);
143 
144 enum AVFieldOrder ff_qsv_map_picstruct(int mfx_pic_struct);
145 
147  const char *load_plugins, int gpu_copy);
148 
150 
151 int ff_qsv_init_session_device(AVCodecContext *avctx, mfxSession *psession,
152  AVBufferRef *device_ref, const char *load_plugins,
153  int gpu_copy);
154 
155 int ff_qsv_init_session_frames(AVCodecContext *avctx, mfxSession *session,
156  QSVFramesContext *qsv_frames_ctx,
157  const char *load_plugins, int opaque, int gpu_copy);
158 
160 
162  mfxExtBuffer *param);
163 
164 int ff_qsv_map_frame_to_surface(const AVFrame *frame, mfxFrameSurface1 *surface);
165 
166 
167 #endif /* AVCODEC_QSV_INTERNAL_H */
QSV_MAX_FRAME_EXT_PARAMS
#define QSV_MAX_FRAME_EXT_PARAMS
Definition: qsv_internal.h:57
ff_qsv_map_pictype
enum AVPictureType ff_qsv_map_pictype(int mfx_pic_type)
Definition: qsv.c:379
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:71
ff_qsv_print_iopattern
int ff_qsv_print_iopattern(void *log_ctx, int mfx_iopattern, const char *extra_string)
Definition: qsv.c:104
QSVFramesContext::nb_mids
int nb_mids
Definition: qsv_internal.h:125
ff_qsv_map_pixfmt
int ff_qsv_map_pixfmt(enum AVPixelFormat format, uint32_t *fourcc, uint16_t *shift)
Definition: qsv.c:228
QSVFramesContext::hw_frames_ctx
AVBufferRef * hw_frames_ctx
Definition: qsv_internal.h:115
AVFieldOrder
AVFieldOrder
Definition: defs.h:200
QSVMid::locked_frame
AVFrame * locked_frame
Definition: qsv_internal.h:74
AVPictureType
AVPictureType
Definition: avutil.h:277
QSVFrame::extparam
mfxExtBuffer * extparam[QSV_MAX_ENC_EXTPARAM]
used for enc_ctrl.ExtParam
Definition: qsv_internal.h:97
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:389
QSVFrame::ext_param
mfxExtBuffer * ext_param[QSV_MAX_FRAME_EXT_PARAMS]
Definition: qsv_internal.h:93
QSVFrame::frame
AVFrame * frame
Definition: qsv_internal.h:80
QSVFrame::used
int used
Definition: qsv_internal.h:100
QSVFrame::enc_ctrl
mfxEncodeCtrl enc_ctrl
Definition: qsv_internal.h:82
QSVFrame::num_ext_params
int num_ext_params
Definition: qsv_internal.h:94
ff_qsv_init_internal_session
int ff_qsv_init_internal_session(AVCodecContext *avctx, QSVSession *qs, const char *load_plugins, int gpu_copy)
Definition: qsv.c:681
AVHWDeviceContext
This struct aggregates all the (hardware/vendor-specific) "high-level" state, i.e.
Definition: hwcontext.h:60
ff_qsv_init_session_frames
int ff_qsv_init_session_frames(AVCodecContext *avctx, mfxSession *session, QSVFramesContext *qsv_frames_ctx, const char *load_plugins, int opaque, int gpu_copy)
Definition: qsv.c:1109
ff_qsv_map_picstruct
enum AVFieldOrder ff_qsv_map_picstruct(int mfx_pic_struct)
Definition: qsv.c:361
QSVMid::hw_frame
AVFrame * hw_frame
Definition: qsv_internal.h:75
format
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample format(the sample packing is implied by the sample format) and sample rate. The lists are not just lists
ctx
AVFormatContext * ctx
Definition: movenc.c:49
codec_id
enum AVCodecID codec_id
Definition: vaapi_decode.c:394
ff_qsv_codec_id_to_mfx
int ff_qsv_codec_id_to_mfx(enum AVCodecID codec_id)
Definition: qsv.c:54
QSVFrame
Definition: qsv_internal.h:79
QSVFrame::payloads
mfxPayload * payloads[QSV_MAX_ENC_PAYLOAD]
used for enc_ctrl.Payload
Definition: qsv_internal.h:96
QSVFrame::surface
mfxFrameSurface1 surface
Definition: qsv_internal.h:81
ff_qsv_print_warning
int ff_qsv_print_warning(void *log_ctx, mfxStatus err, const char *warning_string)
Definition: qsv.c:198
AVCodecID
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: codec_id.h:49
QSV_MAX_ENC_EXTPARAM
#define QSV_MAX_ENC_EXTPARAM
Definition: qsv_internal.h:53
shift
static int shift(int a, int b)
Definition: bonk.c:261
QSVMid::hw_frames_ref
AVBufferRef * hw_frames_ref
Definition: qsv_internal.h:71
ff_qsv_init_session_device
int ff_qsv_init_session_device(AVCodecContext *avctx, mfxSession *psession, AVBufferRef *device_ref, const char *load_plugins, int gpu_copy)
Definition: qsv.c:1032
frame.h
mfx_iopattern
int mfx_iopattern
Definition: qsv.c:89
QSVMid::handle_pair
mfxHDLPair * handle_pair
Definition: qsv_internal.h:72
ff_qsv_find_surface_idx
int ff_qsv_find_surface_idx(QSVFramesContext *ctx, QSVFrame *frame)
Definition: qsv.c:348
QSVFramesContext::mids
QSVMid * mids
The memory ids for the external frames.
Definition: qsv_internal.h:124
QSVMid::surf
mfxFrameSurface1 surf
Definition: qsv_internal.h:76
avcodec.h
hwcontext_vaapi.h
frame
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:264
QSVFrame::queued
int queued
Definition: qsv_internal.h:99
QSVSession
Definition: qsv_internal.h:105
ff_qsv_map_frame_to_surface
int ff_qsv_map_frame_to_surface(const AVFrame *frame, mfxFrameSurface1 *surface)
Definition: qsv.c:287
AVCodecContext
main external API structure.
Definition: avcodec.h:451
ff_qsv_map_fourcc
enum AVPixelFormat ff_qsv_map_fourcc(uint32_t fourcc)
Definition: qsv.c:207
QSVSession::session
mfxSession session
Definition: qsv_internal.h:106
QSV_MAX_ENC_PAYLOAD
#define QSV_MAX_ENC_PAYLOAD
Definition: qsv_internal.h:52
AVBufferRef
A reference to a data buffer.
Definition: buffer.h:82
QSVFrame::dec_info
mfxExtDecodedFrameInfo dec_info
Definition: qsv_internal.h:83
ff_qsv_print_error
int ff_qsv_print_error(void *log_ctx, mfxStatus err, const char *error_string)
Definition: qsv.c:189
QSVFramesContext::logctx
void * logctx
Definition: qsv_internal.h:116
QSVFramesContext
Definition: qsv_internal.h:114
QSVSession::loader
void * loader
Definition: qsv_internal.h:111
QSVFrame::next
struct QSVFrame * next
Definition: qsv_internal.h:102
QSVMid
Definition: qsv_internal.h:70
fourcc
uint32_t fourcc
Definition: vaapi_decode.c:247
ff_qsv_frame_add_ext_param
void ff_qsv_frame_add_ext_param(AVCodecContext *avctx, QSVFrame *frame, mfxExtBuffer *param)
Definition: qsv.c:1177
ff_qsv_close_internal_session
int ff_qsv_close_internal_session(QSVSession *qs)
Definition: qsv.c:1159