FFmpeg
qsvdec_h2645.c
Go to the documentation of this file.
1 /*
2  * Intel MediaSDK QSV based H.264 / HEVC decoder
3  *
4  * copyright (c) 2013 Luca Barbato
5  * copyright (c) 2015 Anton Khirnov
6  *
7  * This file is part of FFmpeg.
8  *
9  * FFmpeg is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * FFmpeg is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with FFmpeg; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  */
23 
24 
25 #include <stdint.h>
26 #include <string.h>
27 
28 #include <mfx/mfxvideo.h>
29 
30 #include "libavutil/common.h"
31 #include "libavutil/fifo.h"
32 #include "libavutil/opt.h"
33 
34 #include "avcodec.h"
35 #include "internal.h"
36 #include "qsv_internal.h"
37 #include "qsvdec.h"
38 #include "qsv.h"
39 
40 enum LoadPlugin {
44 };
45 
46 typedef struct QSVH2645Context {
47  AVClass *class;
49 
51 
53 
56 
58 {
59  AVPacket pkt;
60  while (av_fifo_size(s->packet_fifo) >= sizeof(pkt)) {
61  av_fifo_generic_read(s->packet_fifo, &pkt, sizeof(pkt), NULL);
63  }
64 
65  av_packet_unref(&s->buffer_pkt);
66 }
67 
69 {
70  QSVH2645Context *s = avctx->priv_data;
71 
72  ff_qsv_decode_close(&s->qsv);
73 
75 
76  av_fifo_free(s->packet_fifo);
77 
78  return 0;
79 }
80 
82 {
83  QSVH2645Context *s = avctx->priv_data;
84  int ret;
85 
86  if (avctx->codec_id == AV_CODEC_ID_HEVC && s->load_plugin != LOAD_PLUGIN_NONE) {
87  static const char * const uid_hevcdec_sw = "15dd936825ad475ea34e35f3f54217a6";
88  static const char * const uid_hevcdec_hw = "33a61c0b4c27454ca8d85dde757c6f8e";
89 
90  if (s->qsv.load_plugins[0]) {
91  av_log(avctx, AV_LOG_WARNING,
92  "load_plugins is not empty, but load_plugin is not set to 'none'."
93  "The load_plugin value will be ignored.\n");
94  } else {
95  av_freep(&s->qsv.load_plugins);
96 
97  if (s->load_plugin == LOAD_PLUGIN_HEVC_SW)
98  s->qsv.load_plugins = av_strdup(uid_hevcdec_sw);
99  else
100  s->qsv.load_plugins = av_strdup(uid_hevcdec_hw);
101  if (!s->qsv.load_plugins)
102  return AVERROR(ENOMEM);
103  }
104  }
105 
106  s->qsv.orig_pix_fmt = AV_PIX_FMT_NV12;
107  s->packet_fifo = av_fifo_alloc(sizeof(AVPacket));
108  if (!s->packet_fifo) {
109  ret = AVERROR(ENOMEM);
110  goto fail;
111  }
112 
113  return 0;
114 fail:
115  qsv_decode_close(avctx);
116  return ret;
117 }
118 
119 static int qsv_decode_frame(AVCodecContext *avctx, void *data,
120  int *got_frame, AVPacket *avpkt)
121 {
122  QSVH2645Context *s = avctx->priv_data;
123  AVFrame *frame = data;
124  int ret;
125 
126  /* buffer the input packet */
127  if (avpkt->size) {
128  AVPacket input_ref;
129 
130  if (av_fifo_space(s->packet_fifo) < sizeof(input_ref)) {
131  ret = av_fifo_realloc2(s->packet_fifo,
132  av_fifo_size(s->packet_fifo) + sizeof(input_ref));
133  if (ret < 0)
134  return ret;
135  }
136 
137  ret = av_packet_ref(&input_ref, avpkt);
138  if (ret < 0)
139  return ret;
140  av_fifo_generic_write(s->packet_fifo, &input_ref, sizeof(input_ref), NULL);
141  }
142 
143  /* process buffered data */
144  while (!*got_frame) {
145  /* prepare the input data */
146  if (s->buffer_pkt.size <= 0) {
147  /* no more data */
148  if (av_fifo_size(s->packet_fifo) < sizeof(AVPacket))
149  return avpkt->size ? avpkt->size : ff_qsv_process_data(avctx, &s->qsv, frame, got_frame, avpkt);
150  /* in progress of reinit, no read from fifo and keep the buffer_pkt */
151  if (!s->qsv.reinit_flag) {
152  av_packet_unref(&s->buffer_pkt);
153  av_fifo_generic_read(s->packet_fifo, &s->buffer_pkt, sizeof(s->buffer_pkt), NULL);
154  }
155  }
156 
157  ret = ff_qsv_process_data(avctx, &s->qsv, frame, got_frame, &s->buffer_pkt);
158  if (ret < 0){
159  /* Drop buffer_pkt when failed to decode the packet. Otherwise,
160  the decoder will keep decoding the failure packet. */
161  av_packet_unref(&s->buffer_pkt);
162  return ret;
163  }
164  if (s->qsv.reinit_flag)
165  continue;
166 
167  s->buffer_pkt.size -= ret;
168  s->buffer_pkt.data += ret;
169  }
170 
171  return avpkt->size;
172 }
173 
174 static void qsv_decode_flush(AVCodecContext *avctx)
175 {
176  QSVH2645Context *s = avctx->priv_data;
177 
179  ff_qsv_decode_flush(avctx, &s->qsv);
180 }
181 
182 #define OFFSET(x) offsetof(QSVH2645Context, x)
183 #define VD AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_DECODING_PARAM
184 
185 #if CONFIG_HEVC_QSV_DECODER
186 static const AVOption hevc_options[] = {
187  { "async_depth", "Internal parallelization depth, the higher the value the higher the latency.", OFFSET(qsv.async_depth), AV_OPT_TYPE_INT, { .i64 = ASYNC_DEPTH_DEFAULT }, 1, INT_MAX, VD },
188 
189  { "load_plugin", "A user plugin to load in an internal session", OFFSET(load_plugin), AV_OPT_TYPE_INT, { .i64 = LOAD_PLUGIN_HEVC_HW }, LOAD_PLUGIN_NONE, LOAD_PLUGIN_HEVC_HW, VD, "load_plugin" },
190  { "none", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = LOAD_PLUGIN_NONE }, 0, 0, VD, "load_plugin" },
191  { "hevc_sw", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = LOAD_PLUGIN_HEVC_SW }, 0, 0, VD, "load_plugin" },
192  { "hevc_hw", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = LOAD_PLUGIN_HEVC_HW }, 0, 0, VD, "load_plugin" },
193 
194  { "load_plugins", "A :-separate list of hexadecimal plugin UIDs to load in an internal session",
195  OFFSET(qsv.load_plugins), AV_OPT_TYPE_STRING, { .str = "" }, 0, 0, VD },
196 
197  { "gpu_copy", "A GPU-accelerated copy between video and system memory", OFFSET(qsv.gpu_copy), AV_OPT_TYPE_INT, { .i64 = MFX_GPUCOPY_DEFAULT }, MFX_GPUCOPY_DEFAULT, MFX_GPUCOPY_OFF, VD, "gpu_copy"},
198  { "default", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = MFX_GPUCOPY_DEFAULT }, 0, 0, VD, "gpu_copy"},
199  { "on", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = MFX_GPUCOPY_ON }, 0, 0, VD, "gpu_copy"},
200  { "off", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = MFX_GPUCOPY_OFF }, 0, 0, VD, "gpu_copy"},
201  { NULL },
202 };
203 
204 static const AVClass hevc_class = {
205  .class_name = "hevc_qsv",
206  .item_name = av_default_item_name,
207  .option = hevc_options,
208  .version = LIBAVUTIL_VERSION_INT,
209 };
210 
212  .name = "hevc_qsv",
213  .long_name = NULL_IF_CONFIG_SMALL("HEVC (Intel Quick Sync Video acceleration)"),
214  .priv_data_size = sizeof(QSVH2645Context),
216  .id = AV_CODEC_ID_HEVC,
220  .close = qsv_decode_close,
222  .priv_class = &hevc_class,
223  .pix_fmts = (const enum AVPixelFormat[]){ AV_PIX_FMT_NV12,
226  AV_PIX_FMT_NONE },
227  .hw_configs = ff_qsv_hw_configs,
228  .bsfs = "hevc_mp4toannexb",
229  .wrapper_name = "qsv",
230 };
231 #endif
232 
233 #if CONFIG_H264_QSV_DECODER
234 static const AVOption options[] = {
235  { "async_depth", "Internal parallelization depth, the higher the value the higher the latency.", OFFSET(qsv.async_depth), AV_OPT_TYPE_INT, { .i64 = ASYNC_DEPTH_DEFAULT }, 1, INT_MAX, VD },
236 
237  { "gpu_copy", "A GPU-accelerated copy between video and system memory", OFFSET(qsv.gpu_copy), AV_OPT_TYPE_INT, { .i64 = MFX_GPUCOPY_DEFAULT }, MFX_GPUCOPY_DEFAULT, MFX_GPUCOPY_OFF, VD, "gpu_copy"},
238  { "default", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = MFX_GPUCOPY_DEFAULT }, 0, 0, VD, "gpu_copy"},
239  { "on", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = MFX_GPUCOPY_ON }, 0, 0, VD, "gpu_copy"},
240  { "off", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = MFX_GPUCOPY_OFF }, 0, 0, VD, "gpu_copy"},
241  { NULL },
242 };
243 
244 static const AVClass class = {
245  .class_name = "h264_qsv",
246  .item_name = av_default_item_name,
247  .option = options,
248  .version = LIBAVUTIL_VERSION_INT,
249 };
250 
252  .name = "h264_qsv",
253  .long_name = NULL_IF_CONFIG_SMALL("H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10 (Intel Quick Sync Video acceleration)"),
254  .priv_data_size = sizeof(QSVH2645Context),
256  .id = AV_CODEC_ID_H264,
260  .close = qsv_decode_close,
262  .priv_class = &class,
263  .pix_fmts = (const enum AVPixelFormat[]){ AV_PIX_FMT_NV12,
266  AV_PIX_FMT_NONE },
267  .hw_configs = ff_qsv_hw_configs,
268  .bsfs = "h264_mp4toannexb",
269  .wrapper_name = "qsv",
270 };
271 #endif
LoadPlugin
LoadPlugin
Definition: qsvdec_h2645.c:40
av_packet_unref
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: avpacket.c:605
ff_qsv_hw_configs
const AVCodecHWConfigInternal * ff_qsv_hw_configs[]
Definition: qsvdec.c:46
AVCodec
AVCodec.
Definition: codec.h:190
AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
ff_qsv_process_data
int ff_qsv_process_data(AVCodecContext *avctx, QSVContext *q, AVFrame *frame, int *got_frame, AVPacket *pkt)
Definition: qsvdec.c:569
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
init
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
AVERROR
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 they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
av_fifo_generic_write
int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int(*func)(void *, void *, int))
Feed data from a user-supplied callback to an AVFifoBuffer.
Definition: fifo.c:122
av_fifo_free
void av_fifo_free(AVFifoBuffer *f)
Free an AVFifoBuffer.
Definition: fifo.c:55
QSVH2645Context::qsv
QSVContext qsv
Definition: qsvdec_h2645.c:48
QSVH2645Context::load_plugin
int load_plugin
Definition: qsvdec_h2645.c:50
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:300
internal.h
ff_h264_qsv_decoder
AVCodec ff_h264_qsv_decoder
AVOption
AVOption.
Definition: opt.h:246
qsvdec.h
data
const char data[16]
Definition: mxf.c:91
qsv_decode_close
static av_cold int qsv_decode_close(AVCodecContext *avctx)
Definition: qsvdec_h2645.c:68
av_fifo_generic_read
int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void(*func)(void *, void *, int))
Feed data from an AVFifoBuffer to a user-supplied callback.
Definition: fifo.c:213
ff_qsv_decode_close
int ff_qsv_decode_close(QSVContext *q)
Definition: qsvdec.c:533
QSVH2645Context
Definition: qsvdec_h2645.c:46
AVFifoBuffer
Definition: fifo.h:31
fifo.h
fail
#define fail()
Definition: checkasm.h:123
type
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf type
Definition: writing_filters.txt:86
QSVContext
Definition: qsvdec.h:39
qsv_internal.h
ff_qsv_decode_flush
void ff_qsv_decode_flush(AVCodecContext *avctx, QSVContext *q)
Definition: qsvdec.c:631
LOAD_PLUGIN_HEVC_SW
@ LOAD_PLUGIN_HEVC_SW
Definition: qsvdec_h2645.c:42
av_fifo_space
int av_fifo_space(const AVFifoBuffer *f)
Return the amount of space in bytes in the AVFifoBuffer, that is the amount of data you can write int...
Definition: fifo.c:82
ASYNC_DEPTH_DEFAULT
#define ASYNC_DEPTH_DEFAULT
Definition: qsv_internal.h:49
av_cold
#define av_cold
Definition: attributes.h:90
decode
static void decode(AVCodecContext *dec_ctx, AVPacket *pkt, AVFrame *frame, FILE *outfile)
Definition: decode_audio.c:71
VD
#define VD
Definition: qsvdec_h2645.c:183
s
#define s(width, name)
Definition: cbs_vp9.c:257
hevc_options
static const AVOption hevc_options[]
Definition: videotoolboxenc.c:2608
pix_fmts
static enum AVPixelFormat pix_fmts[]
Definition: libkvazaar.c:275
av_fifo_realloc2
int av_fifo_realloc2(AVFifoBuffer *f, unsigned int new_size)
Resize an AVFifoBuffer.
Definition: fifo.c:87
AV_CODEC_ID_H264
@ AV_CODEC_ID_H264
Definition: codec_id.h:76
ff_hevc_qsv_decoder
AVCodec ff_hevc_qsv_decoder
AVCodecContext::codec_id
enum AVCodecID codec_id
Definition: avcodec.h:536
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:67
flush
static void flush(AVCodecContext *avctx)
Definition: aacdec_template.c:500
NULL
#define NULL
Definition: coverity.c:32
qsv.h
LOAD_PLUGIN_HEVC_HW
@ LOAD_PLUGIN_HEVC_HW
Definition: qsvdec_h2645.c:43
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:235
AV_PIX_FMT_QSV
@ AV_PIX_FMT_QSV
HW acceleration through QSV, data[3] contains a pointer to the mfxFrameSurface1 structure.
Definition: pixfmt.h:222
av_packet_ref
int av_packet_ref(AVPacket *dst, const AVPacket *src)
Setup a new reference to the data described by a given packet.
Definition: avpacket.c:614
qsv_decode_flush
static void qsv_decode_flush(AVCodecContext *avctx)
Definition: qsvdec_h2645.c:174
OFFSET
#define OFFSET(x)
Definition: qsvdec_h2645.c:182
options
const OptionDef options[]
AV_CODEC_CAP_DR1
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() for allocating buffers and supports custom allocators.
Definition: codec.h:50
AVPacket::size
int size
Definition: packet.h:356
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:188
common.h
AV_CODEC_ID_HEVC
@ AV_CODEC_ID_HEVC
Definition: codec_id.h:223
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:197
QSVH2645Context::buffer_pkt
AVPacket buffer_pkt
Definition: qsvdec_h2645.c:54
qsv_decode_frame
static int qsv_decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
Definition: qsvdec_h2645.c:119
avcodec.h
ret
ret
Definition: filter_design.txt:187
AV_PIX_FMT_NV12
@ AV_PIX_FMT_NV12
planar YUV 4:2:0, 12bpp, 1 plane for Y and 1 plane for the UV components, which are interleaved (firs...
Definition: pixfmt.h:89
AVClass::class_name
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:72
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
AVCodecContext
main external API structure.
Definition: avcodec.h:526
QSVH2645Context::packet_fifo
AVFifoBuffer * packet_fifo
Definition: qsvdec_h2645.c:52
pkt
static AVPacket pkt
Definition: demuxing_decoding.c:54
qsv_decode_init
static av_cold int qsv_decode_init(AVCodecContext *avctx)
Definition: qsvdec_h2645.c:81
AV_PIX_FMT_NONE
@ AV_PIX_FMT_NONE
Definition: pixfmt.h:65
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:223
LOAD_PLUGIN_NONE
@ LOAD_PLUGIN_NONE
Definition: qsvdec_h2645.c:41
AV_CODEC_CAP_DELAY
#define AV_CODEC_CAP_DELAY
Encoder or decoder requires flushing with NULL input at the end in order to give the complete and cor...
Definition: codec.h:75
AV_PIX_FMT_P010
#define AV_PIX_FMT_P010
Definition: pixfmt.h:446
av_strdup
char * av_strdup(const char *s)
Duplicate a string.
Definition: mem.c:253
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AV_CODEC_CAP_HYBRID
#define AV_CODEC_CAP_HYBRID
Codec is potentially backed by a hardware implementation, but not necessarily.
Definition: codec.h:157
av_fifo_size
int av_fifo_size(const AVFifoBuffer *f)
Return the amount of data in bytes in the AVFifoBuffer, that is the amount of data you can read from ...
Definition: fifo.c:77
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:553
AVPacket
This structure stores compressed data.
Definition: packet.h:332
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:35
av_fifo_alloc
AVFifoBuffer * av_fifo_alloc(unsigned int size)
Initialize an AVFifoBuffer.
Definition: fifo.c:43
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
AV_CODEC_CAP_AVOID_PROBING
#define AV_CODEC_CAP_AVOID_PROBING
Decoder is not a preferred choice for probing.
Definition: codec.h:132
AV_OPT_TYPE_STRING
@ AV_OPT_TYPE_STRING
Definition: opt.h:227
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Definition: opt.h:232
qsv_clear_buffers
static void qsv_clear_buffers(QSVH2645Context *s)
Definition: qsvdec_h2645.c:57