FFmpeg
qsvdec.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Anton Khirnov
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to deal
6  * in the Software without restriction, including without limitation the rights
7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  * copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20  * THE SOFTWARE.
21  */
22 
23 /**
24  * @file
25  * Intel QSV-accelerated H.264 decoding example.
26  *
27  * @example qsvdec.c
28  * This example shows how to do QSV-accelerated H.264 decoding with output
29  * frames in the GPU video surfaces.
30  */
31 
32 #include "config.h"
33 
34 #include <stdio.h>
35 
36 #include "libavformat/avformat.h"
37 #include "libavformat/avio.h"
38 
39 #include "libavcodec/avcodec.h"
40 
41 #include "libavutil/buffer.h"
42 #include "libavutil/error.h"
43 #include "libavutil/hwcontext.h"
45 #include "libavutil/mem.h"
46 
47 typedef struct DecodeContext {
50 
51 static int get_format(AVCodecContext *avctx, const enum AVPixelFormat *pix_fmts)
52 {
53  while (*pix_fmts != AV_PIX_FMT_NONE) {
54  if (*pix_fmts == AV_PIX_FMT_QSV) {
55  DecodeContext *decode = avctx->opaque;
56  AVHWFramesContext *frames_ctx;
57  AVQSVFramesContext *frames_hwctx;
58  int ret;
59 
60  /* create a pool of surfaces to be used by the decoder */
61  avctx->hw_frames_ctx = av_hwframe_ctx_alloc(decode->hw_device_ref);
62  if (!avctx->hw_frames_ctx)
63  return AV_PIX_FMT_NONE;
64  frames_ctx = (AVHWFramesContext*)avctx->hw_frames_ctx->data;
65  frames_hwctx = frames_ctx->hwctx;
66 
67  frames_ctx->format = AV_PIX_FMT_QSV;
68  frames_ctx->sw_format = avctx->sw_pix_fmt;
69  frames_ctx->width = FFALIGN(avctx->coded_width, 32);
70  frames_ctx->height = FFALIGN(avctx->coded_height, 32);
71  frames_ctx->initial_pool_size = 32;
72 
73  frames_hwctx->frame_type = MFX_MEMTYPE_VIDEO_MEMORY_DECODER_TARGET;
74 
76  if (ret < 0)
77  return AV_PIX_FMT_NONE;
78 
79  return AV_PIX_FMT_QSV;
80  }
81 
82  pix_fmts++;
83  }
84 
85  fprintf(stderr, "The QSV pixel format not offered in get_format()\n");
86 
87  return AV_PIX_FMT_NONE;
88 }
89 
91  AVFrame *frame, AVFrame *sw_frame,
92  AVPacket *pkt, AVIOContext *output_ctx)
93 {
94  int ret = 0;
95 
97  if (ret < 0) {
98  fprintf(stderr, "Error during decoding\n");
99  return ret;
100  }
101 
102  while (ret >= 0) {
103  int i, j;
104 
106  if (ret == AVERROR(EAGAIN) || ret == AVERROR_EOF)
107  break;
108  else if (ret < 0) {
109  fprintf(stderr, "Error during decoding\n");
110  return ret;
111  }
112 
113  /* A real program would do something useful with the decoded frame here.
114  * We just retrieve the raw data and write it to a file, which is rather
115  * useless but pedagogic. */
116  ret = av_hwframe_transfer_data(sw_frame, frame, 0);
117  if (ret < 0) {
118  fprintf(stderr, "Error transferring the data to system memory\n");
119  goto fail;
120  }
121 
122  for (i = 0; i < FF_ARRAY_ELEMS(sw_frame->data) && sw_frame->data[i]; i++)
123  for (j = 0; j < (sw_frame->height >> (i > 0)); j++)
124  avio_write(output_ctx, sw_frame->data[i] + j * sw_frame->linesize[i], sw_frame->width);
125 
126 fail:
127  av_frame_unref(sw_frame);
129 
130  if (ret < 0)
131  return ret;
132  }
133 
134  return 0;
135 }
136 
137 int main(int argc, char **argv)
138 {
139  AVFormatContext *input_ctx = NULL;
142  const AVCodec *decoder;
143 
144  AVPacket pkt = { 0 };
145  AVFrame *frame = NULL, *sw_frame = NULL;
146 
147  DecodeContext decode = { NULL };
148 
149  AVIOContext *output_ctx = NULL;
150 
151  int ret, i;
152 
153  if (argc < 3) {
154  fprintf(stderr, "Usage: %s <input file> <output file>\n", argv[0]);
155  return 1;
156  }
157 
158  /* open the input file */
159  ret = avformat_open_input(&input_ctx, argv[1], NULL, NULL);
160  if (ret < 0) {
161  fprintf(stderr, "Cannot open input file '%s': ", argv[1]);
162  goto finish;
163  }
164 
165  /* find the first H.264 video stream */
166  for (i = 0; i < input_ctx->nb_streams; i++) {
167  AVStream *st = input_ctx->streams[i];
168 
169  if (st->codecpar->codec_id == AV_CODEC_ID_H264 && !video_st)
170  video_st = st;
171  else
172  st->discard = AVDISCARD_ALL;
173  }
174  if (!video_st) {
175  fprintf(stderr, "No H.264 video stream in the input file\n");
176  goto finish;
177  }
178 
179  /* open the hardware device */
181  "auto", NULL, 0);
182  if (ret < 0) {
183  fprintf(stderr, "Cannot open the hardware device\n");
184  goto finish;
185  }
186 
187  /* initialize the decoder */
189  if (!decoder) {
190  fprintf(stderr, "The QSV decoder is not present in libavcodec\n");
191  goto finish;
192  }
193 
195  if (!decoder_ctx) {
196  ret = AVERROR(ENOMEM);
197  goto finish;
198  }
203  if (!decoder_ctx->extradata) {
204  ret = AVERROR(ENOMEM);
205  goto finish;
206  }
210  }
211 
214 
216  if (ret < 0) {
217  fprintf(stderr, "Error opening the decoder: ");
218  goto finish;
219  }
220 
221  /* open the output stream */
222  ret = avio_open(&output_ctx, argv[2], AVIO_FLAG_WRITE);
223  if (ret < 0) {
224  fprintf(stderr, "Error opening the output context: ");
225  goto finish;
226  }
227 
228  frame = av_frame_alloc();
229  sw_frame = av_frame_alloc();
230  if (!frame || !sw_frame) {
231  ret = AVERROR(ENOMEM);
232  goto finish;
233  }
234 
235  /* actual decoding */
236  while (ret >= 0) {
237  ret = av_read_frame(input_ctx, &pkt);
238  if (ret < 0)
239  break;
240 
241  if (pkt.stream_index == video_st->index)
242  ret = decode_packet(&decode, decoder_ctx, frame, sw_frame, &pkt, output_ctx);
243 
245  }
246 
247  /* flush the decoder */
248  pkt.data = NULL;
249  pkt.size = 0;
250  ret = decode_packet(&decode, decoder_ctx, frame, sw_frame, &pkt, output_ctx);
251 
252 finish:
253  if (ret < 0) {
254  char buf[1024];
255  av_strerror(ret, buf, sizeof(buf));
256  fprintf(stderr, "%s\n", buf);
257  }
258 
259  avformat_close_input(&input_ctx);
260 
262  av_frame_free(&sw_frame);
263 
265 
266  av_buffer_unref(&decode.hw_device_ref);
267 
268  avio_close(output_ctx);
269 
270  return ret;
271 }
av_packet_unref
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: avpacket.c:403
AVCodec
AVCodec.
Definition: codec.h:197
AVQSVFramesContext::frame_type
int frame_type
A combination of MFX_MEMTYPE_* describing the frame pool.
Definition: hwcontext_qsv.h:49
AVCodecParameters::extradata
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: codec_par.h:74
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
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
AVCodecContext::get_format
enum AVPixelFormat(* get_format)(struct AVCodecContext *s, const enum AVPixelFormat *fmt)
callback to negotiate the pixelFormat
Definition: avcodec.h:636
avio_close
int avio_close(AVIOContext *s)
Close the resource accessed by the AVIOContext s and free it.
Definition: aviobuf.c:1152
AVERROR_EOF
#define AVERROR_EOF
End of file.
Definition: error.h:55
AVBufferRef::data
uint8_t * data
The data buffer.
Definition: buffer.h:92
AVStream::discard
enum AVDiscard discard
Selects which packets can be discarded at will and do not need to be demuxed.
Definition: avformat.h:886
AVHWFramesContext::format
enum AVPixelFormat format
The pixel format identifying the underlying HW surface type.
Definition: hwcontext.h:209
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:111
av_hwframe_ctx_init
int av_hwframe_ctx_init(AVBufferRef *ref)
Finalize the context before use.
Definition: hwcontext.c:333
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
AVFormatContext::streams
AVStream ** streams
A list of all streams in the file.
Definition: avformat.h:1165
AVFrame::width
int width
Definition: frame.h:361
av_hwframe_ctx_alloc
AVBufferRef * av_hwframe_ctx_alloc(AVBufferRef *device_ref_in)
Allocate an AVHWFramesContext tied to a given device context.
Definition: hwcontext.c:247
AVPacket::data
uint8_t * data
Definition: packet.h:365
decode_packet
static int decode_packet(DecodeContext *decode, AVCodecContext *decoder_ctx, AVFrame *frame, AVFrame *sw_frame, AVPacket *pkt, AVIOContext *output_ctx)
Definition: qsvdec.c:90
av_read_frame
int av_read_frame(AVFormatContext *s, AVPacket *pkt)
Return the next frame of a stream.
Definition: utils.c:1667
AVHWFramesContext::width
int width
The allocated dimensions of the frames in this pool.
Definition: hwcontext.h:229
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:317
avformat_close_input
void avformat_close_input(AVFormatContext **s)
Close an opened input AVFormatContext.
Definition: utils.c:4348
decoder
static const chunk_decoder decoder[8]
Definition: dfa.c:330
finish
static void finish(void)
Definition: movenc.c:342
fail
#define fail()
Definition: checkasm.h:134
av_strerror
int av_strerror(int errnum, char *errbuf, size_t errbuf_size)
Put a description of the AVERROR code errnum in errbuf.
Definition: error.c:105
AVCodecContext::coded_height
int coded_height
Definition: avcodec.h:572
av_frame_alloc
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:98
pkt
AVPacket * pkt
Definition: movenc.c:59
FF_ARRAY_ELEMS
#define FF_ARRAY_ELEMS(a)
Definition: sinewin_tablegen.c:29
AVHWFramesContext::height
int height
Definition: hwcontext.h:229
avformat_open_input
int avformat_open_input(AVFormatContext **ps, const char *url, const AVInputFormat *fmt, AVDictionary **options)
Open an input stream and read the header.
Definition: utils.c:481
decode
static void decode(AVCodecContext *dec_ctx, AVPacket *pkt, AVFrame *frame, FILE *outfile)
Definition: decode_audio.c:71
AVCodecContext::extradata_size
int extradata_size
Definition: avcodec.h:486
avcodec_alloc_context3
AVCodecContext * avcodec_alloc_context3(const AVCodec *codec)
Allocate an AVCodecContext and set its fields to default values.
Definition: options.c:141
avcodec_receive_frame
int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame)
Return decoded output data from a decoder.
Definition: decode.c:628
pix_fmts
static enum AVPixelFormat pix_fmts[]
Definition: libkvazaar.c:290
AVIO_FLAG_WRITE
#define AVIO_FLAG_WRITE
write-only
Definition: avio.h:656
decoder_ctx
static AVCodecContext * decoder_ctx
Definition: vaapi_transcode.c:43
AV_CODEC_ID_H264
@ AV_CODEC_ID_H264
Definition: codec_id.h:77
AVCodecContext::codec_id
enum AVCodecID codec_id
Definition: avcodec.h:394
AVDISCARD_ALL
@ AVDISCARD_ALL
discard all
Definition: defs.h:54
AVFormatContext
Format I/O context.
Definition: avformat.h:1097
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:984
NULL
#define NULL
Definition: coverity.c:32
avcodec_find_decoder_by_name
const AVCodec * avcodec_find_decoder_by_name(const char *name)
Find a registered decoder with the specified name.
Definition: allcodecs.c:939
AVHWFramesContext::sw_format
enum AVPixelFormat sw_format
The pixel format identifying the actual data layout of the hardware frames.
Definition: hwcontext.h:222
av_buffer_unref
void av_buffer_unref(AVBufferRef **buf)
Free a given reference and automatically free the buffer if there are no more references to it.
Definition: buffer.c:125
main
int main(int argc, char **argv)
Definition: qsvdec.c:137
avcodec_free_context
void avcodec_free_context(AVCodecContext **avctx)
Free the codec context and everything associated with it and write NULL to the provided pointer.
Definition: options.c:156
get_format
static int get_format(AVCodecContext *avctx, const enum AVPixelFormat *pix_fmts)
Definition: qsvdec.c:51
avcodec_open2
int attribute_align_arg avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options)
Initialize the AVCodecContext to use the given AVCodec.
Definition: avcodec.c:135
AV_PIX_FMT_QSV
@ AV_PIX_FMT_QSV
HW acceleration through QSV, data[3] contains a pointer to the mfxFrameSurface1 structure.
Definition: pixfmt.h:212
error.h
AVCodecParameters::extradata_size
int extradata_size
Size of the extradata content in bytes.
Definition: codec_par.h:78
AVFormatContext::nb_streams
unsigned int nb_streams
Number of elements in AVFormatContext.streams.
Definition: avformat.h:1153
AVIOContext
Bytestream IO Context.
Definition: avio.h:161
AVPacket::size
int size
Definition: packet.h:366
avio.h
video_st
AVStream * video_st
Definition: movenc.c:60
buffer.h
avio_write
void avio_write(AVIOContext *s, const unsigned char *buf, int size)
Definition: aviobuf.c:215
avcodec_send_packet
int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt)
Supply raw packet data as input to a decoder.
Definition: decode.c:565
hwcontext_qsv.h
DecodeContext::hw_device_ref
AVBufferRef * hw_device_ref
Definition: qsvdec.c:48
i
int i
Definition: input.c:407
AVCodecContext::extradata
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:485
av_frame_unref
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:436
av_mallocz
void * av_mallocz(size_t size)
Allocate a memory block with alignment suitable for all memory accesses (including vectors if availab...
Definition: mem.c:244
AVCodecContext::hw_frames_ctx
AVBufferRef * hw_frames_ctx
A reference to the AVHWFramesContext describing the input (for encoding) or output (decoding) frames.
Definition: avcodec.h:1846
avcodec.h
AVHWFramesContext
This struct describes a set or pool of "hardware" frames (i.e.
Definition: hwcontext.h:124
ret
ret
Definition: filter_design.txt:187
AVStream
Stream structure.
Definition: avformat.h:837
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
AVHWFramesContext::hwctx
void * hwctx
The format-specific data, allocated and freed automatically along with this context.
Definition: hwcontext.h:162
av_hwdevice_ctx_create
int av_hwdevice_ctx_create(AVBufferRef **pdevice_ref, enum AVHWDeviceType type, const char *device, AVDictionary *opts, int flags)
Open a device of the specified type and create an AVHWDeviceContext for it.
Definition: hwcontext.c:610
AVCodecContext::opaque
void * opaque
Private data of the user, can be used to carry app specific stuff.
Definition: avcodec.h:426
avformat.h
AV_INPUT_BUFFER_PADDING_SIZE
#define AV_INPUT_BUFFER_PADDING_SIZE
Definition: defs.h:40
av_hwframe_transfer_data
int av_hwframe_transfer_data(AVFrame *dst, const AVFrame *src, int flags)
Copy data to or from a hw surface.
Definition: hwcontext.c:443
AV_HWDEVICE_TYPE_QSV
@ AV_HWDEVICE_TYPE_QSV
Definition: hwcontext.h:33
AVCodecContext
main external API structure.
Definition: avcodec.h:384
AVFrame::height
int height
Definition: frame.h:361
AVStream::index
int index
stream index in AVFormatContext
Definition: avformat.h:838
AV_PIX_FMT_NONE
@ AV_PIX_FMT_NONE
Definition: pixfmt.h:65
avio_open
int avio_open(AVIOContext **s, const char *url, int flags)
Create and initialize a AVIOContext for accessing the resource indicated by url.
Definition: aviobuf.c:1120
AVPacket::stream_index
int stream_index
Definition: packet.h:367
AVQSVFramesContext
This struct is allocated as AVHWFramesContext.hwctx.
Definition: hwcontext_qsv.h:42
AVCodecContext::coded_width
int coded_width
Bitstream width / height, may be different from width/height e.g.
Definition: avcodec.h:572
AVHWFramesContext::initial_pool_size
int initial_pool_size
Initial size of the frame pool.
Definition: hwcontext.h:199
mem.h
AVBufferRef
A reference to a data buffer.
Definition: buffer.h:84
FFALIGN
#define FFALIGN(x, a)
Definition: macros.h:48
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:60
AVPacket
This structure stores compressed data.
Definition: packet.h:342
hwcontext.h
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:334
AVCodecContext::sw_pix_fmt
enum AVPixelFormat sw_pix_fmt
Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:1706
DecodeContext
Definition: qsvdec.c:47