FFmpeg
libopenh264dec.c
Go to the documentation of this file.
1 /*
2  * OpenH264 video decoder
3  * Copyright (C) 2016 Martin Storsjo
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
22 #include <wels/codec_api.h>
23 #include <wels/codec_ver.h>
24 
25 #include "libavutil/common.h"
26 #include "libavutil/fifo.h"
27 #include "libavutil/imgutils.h"
28 #include "libavutil/intreadwrite.h"
29 #include "libavutil/mathematics.h"
30 #include "libavutil/opt.h"
31 
32 #include "avcodec.h"
33 #include "codec_internal.h"
34 #include "internal.h"
35 #include "libopenh264.h"
36 
37 typedef struct SVCContext {
38  ISVCDecoder *decoder;
39 } SVCContext;
40 
42 {
43  SVCContext *s = avctx->priv_data;
44 
45  if (s->decoder)
46  WelsDestroyDecoder(s->decoder);
47 
48  return 0;
49 }
50 
52 {
53  SVCContext *s = avctx->priv_data;
54  SDecodingParam param = { 0 };
55  int err;
56  int log_level;
57  WelsTraceCallback callback_function;
58 
59  if ((err = ff_libopenh264_check_version(avctx)) < 0)
61 
62  if (WelsCreateDecoder(&s->decoder)) {
63  av_log(avctx, AV_LOG_ERROR, "Unable to create decoder\n");
64  return AVERROR_UNKNOWN;
65  }
66 
67  // Pass all libopenh264 messages to our callback, to allow ourselves to filter them.
68  log_level = WELS_LOG_DETAIL;
69  callback_function = ff_libopenh264_trace_callback;
70  (*s->decoder)->SetOption(s->decoder, DECODER_OPTION_TRACE_LEVEL, &log_level);
71  (*s->decoder)->SetOption(s->decoder, DECODER_OPTION_TRACE_CALLBACK, (void *)&callback_function);
72  (*s->decoder)->SetOption(s->decoder, DECODER_OPTION_TRACE_CALLBACK_CONTEXT, (void *)&avctx);
73 
74 #if !OPENH264_VER_AT_LEAST(1, 6)
75  param.eOutputColorFormat = videoFormatI420;
76 #endif
77  param.eEcActiveIdc = ERROR_CON_DISABLE;
78  param.sVideoProperty.eVideoBsType = VIDEO_BITSTREAM_DEFAULT;
79 
80  if ((*s->decoder)->Initialize(s->decoder, &param) != cmResultSuccess) {
81  av_log(avctx, AV_LOG_ERROR, "Initialize failed\n");
82  return AVERROR_UNKNOWN;
83  }
84 
85  avctx->pix_fmt = AV_PIX_FMT_YUV420P;
86 
87  return 0;
88 }
89 
90 static int svc_decode_frame(AVCodecContext *avctx, AVFrame *avframe,
91  int *got_frame, AVPacket *avpkt)
92 {
93  SVCContext *s = avctx->priv_data;
94  SBufferInfo info = { 0 };
95  uint8_t *ptrs[4] = { NULL };
96  int ret, linesize[4];
97  DECODING_STATE state;
98 #if OPENH264_VER_AT_LEAST(1, 7)
99  int opt;
100 #endif
101 
102  if (!avpkt->data) {
103 #if OPENH264_VER_AT_LEAST(1, 9)
104  int end_of_stream = 1;
105  (*s->decoder)->SetOption(s->decoder, DECODER_OPTION_END_OF_STREAM, &end_of_stream);
106  state = (*s->decoder)->FlushFrame(s->decoder, ptrs, &info);
107 #else
108  return 0;
109 #endif
110  } else {
111  info.uiInBsTimeStamp = avpkt->pts;
112 #if OPENH264_VER_AT_LEAST(1, 4)
113  // Contrary to the name, DecodeFrameNoDelay actually does buffering
114  // and reordering of frames, and is the recommended decoding entry
115  // point since 1.4. This is essential for successfully decoding
116  // B-frames.
117  state = (*s->decoder)->DecodeFrameNoDelay(s->decoder, avpkt->data, avpkt->size, ptrs, &info);
118 #else
119  state = (*s->decoder)->DecodeFrame2(s->decoder, avpkt->data, avpkt->size, ptrs, &info);
120 #endif
121  }
122  if (state != dsErrorFree) {
123  av_log(avctx, AV_LOG_ERROR, "DecodeFrame failed\n");
124  return AVERROR_UNKNOWN;
125  }
126  if (info.iBufferStatus != 1) {
127  av_log(avctx, AV_LOG_DEBUG, "No frame produced\n");
128  return avpkt->size;
129  }
130 
131  ret = ff_set_dimensions(avctx, info.UsrData.sSystemBuffer.iWidth, info.UsrData.sSystemBuffer.iHeight);
132  if (ret < 0)
133  return ret;
134  // The decoder doesn't (currently) support decoding into a user
135  // provided buffer, so do a copy instead.
136  if (ff_get_buffer(avctx, avframe, 0) < 0) {
137  av_log(avctx, AV_LOG_ERROR, "Unable to allocate buffer\n");
138  return AVERROR(ENOMEM);
139  }
140 
141  linesize[0] = info.UsrData.sSystemBuffer.iStride[0];
142  linesize[1] = linesize[2] = info.UsrData.sSystemBuffer.iStride[1];
143  linesize[3] = 0;
144  av_image_copy(avframe->data, avframe->linesize, (const uint8_t **) ptrs, linesize, avctx->pix_fmt, avctx->width, avctx->height);
145 
146  avframe->pts = info.uiOutYuvTimeStamp;
147  avframe->pkt_dts = AV_NOPTS_VALUE;
148 #if OPENH264_VER_AT_LEAST(1, 7)
149  (*s->decoder)->GetOption(s->decoder, DECODER_OPTION_PROFILE, &opt);
150  avctx->profile = opt;
151  (*s->decoder)->GetOption(s->decoder, DECODER_OPTION_LEVEL, &opt);
152  avctx->level = opt;
153 #endif
154 
155  *got_frame = 1;
156  return avpkt->size;
157 }
158 
160  .p.name = "libopenh264",
161  .p.long_name = NULL_IF_CONFIG_SMALL("OpenH264 H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10"),
162  .p.type = AVMEDIA_TYPE_VIDEO,
163  .p.id = AV_CODEC_ID_H264,
164  .priv_data_size = sizeof(SVCContext),
167  .close = svc_decode_close,
168  .p.capabilities = AV_CODEC_CAP_DELAY | AV_CODEC_CAP_DR1,
171  .bsfs = "h264_mp4toannexb",
172  .p.wrapper_name = "libopenh264",
173 };
ff_libopenh264_check_version
int ff_libopenh264_check_version(void *logctx)
Definition: libopenh264.c:50
SVCContext
Definition: libopenh264dec.c:37
FF_CODEC_CAP_INIT_CLEANUP
#define FF_CODEC_CAP_INIT_CLEANUP
The codec allows calling the close function for deallocation even if the init function returned a fai...
Definition: codec_internal.h:39
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
svc_decode_init
static av_cold int svc_decode_init(AVCodecContext *avctx)
Definition: libopenh264dec.c:51
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:325
AVFrame::pts
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:432
internal.h
AVPacket::data
uint8_t * data
Definition: packet.h:374
svc_decode_frame
static int svc_decode_frame(AVCodecContext *avctx, AVFrame *avframe, int *got_frame, AVPacket *avpkt)
Definition: libopenh264dec.c:90
FFCodec
Definition: codec_internal.h:112
mathematics.h
AVERROR_UNKNOWN
#define AVERROR_UNKNOWN
Unknown error, typically from an external library.
Definition: error.h:73
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:346
libopenh264.h
init
static int init
Definition: av_tx.c:47
fifo.h
FFCodec::p
AVCodec p
The public AVCodec.
Definition: codec_internal.h:116
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
av_cold
#define av_cold
Definition: attributes.h:90
FF_CODEC_DECODE_CB
#define FF_CODEC_DECODE_CB(func)
Definition: codec_internal.h:254
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:256
info
MIPS optimizations info
Definition: mips.txt:2
AV_LOG_DEBUG
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:201
AV_PIX_FMT_YUV420P
@ AV_PIX_FMT_YUV420P
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:66
AV_CODEC_ID_H264
@ AV_CODEC_ID_H264
Definition: codec_id.h:77
ff_libopenh264_decoder
const FFCodec ff_libopenh264_decoder
Definition: libopenh264dec.c:159
NULL
#define NULL
Definition: coverity.c:32
end_of_stream
static int FUNC() end_of_stream(CodedBitstreamContext *ctx, RWContext *rw, H264RawNALUnitHeader *current)
Definition: cbs_h264_syntax_template.c:1255
AVFrame::pkt_dts
int64_t pkt_dts
DTS copied from the AVPacket that triggered returning this frame.
Definition: frame.h:439
AVCodecContext::level
int level
level
Definition: avcodec.h:1673
ff_get_buffer
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: decode.c:1403
AV_CODEC_CAP_DR1
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() or get_encode_buffer() for allocating buffers and supports custom allocators.
Definition: codec.h:52
AVPacket::size
int size
Definition: packet.h:375
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:117
codec_internal.h
state
static struct @327 state
AV_NOPTS_VALUE
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:248
svc_decode_close
static av_cold int svc_decode_close(AVCodecContext *avctx)
Definition: libopenh264dec.c:41
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:367
common.h
FF_CODEC_CAP_INIT_THREADSAFE
#define FF_CODEC_CAP_INIT_THREADSAFE
The codec does not modify any global variables in the init function, allowing to call the init functi...
Definition: codec_internal.h:31
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:203
FF_CODEC_CAP_SETS_PKT_DTS
#define FF_CODEC_CAP_SETS_PKT_DTS
Decoders marked with FF_CODEC_CAP_SETS_PKT_DTS want to set AVFrame.pkt_dts manually.
Definition: codec_internal.h:46
AVCodecContext::height
int height
Definition: avcodec.h:562
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:599
avcodec.h
SVCContext::decoder
ISVCDecoder * decoder
Definition: libopenh264dec.c:38
ret
ret
Definition: filter_design.txt:187
AVCodecContext
main external API structure.
Definition: avcodec.h:389
av_image_copy
void av_image_copy(uint8_t *dst_data[4], int dst_linesizes[4], const uint8_t *src_data[4], const int src_linesizes[4], enum AVPixelFormat pix_fmt, int width, int height)
Copy image in src_data to dst_data.
Definition: imgutils.c:422
AVCodecContext::profile
int profile
profile
Definition: avcodec.h:1547
ff_libopenh264_trace_callback
void ff_libopenh264_trace_callback(void *ctx, int level, const char *msg)
Definition: libopenh264.c:42
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:82
AVERROR_DECODER_NOT_FOUND
#define AVERROR_DECODER_NOT_FOUND
Decoder not found.
Definition: error.h:54
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
ff_set_dimensions
int ff_set_dimensions(AVCodecContext *s, int width, int height)
Check that the provided frame dimensions are valid and set them on the codec context.
Definition: utils.c:90
AVPacket
This structure stores compressed data.
Definition: packet.h:351
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:416
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:562
imgutils.h
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, a positive or negative value, which is typically indicating the size in bytes of each pict...
Definition: frame.h:370
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27