FFmpeg
libaomdec.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2010, Google, Inc.
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 /**
22  * @file
23  * AV1 decoder support via libaom
24  */
25 
26 #include <aom/aom_decoder.h>
27 #include <aom/aomdx.h>
28 
29 #include "libavutil/common.h"
30 #include "libavutil/cpu.h"
31 #include "libavutil/imgutils.h"
32 
33 #include "avcodec.h"
34 #include "codec_internal.h"
35 #include "internal.h"
36 #include "libaom.h"
37 #include "profiles.h"
38 
39 typedef struct AV1DecodeContext {
40  struct aom_codec_ctx decoder;
42 
43 static av_cold int aom_init(AVCodecContext *avctx,
44  const struct aom_codec_iface *iface)
45 {
46  AV1DecodeContext *ctx = avctx->priv_data;
47  struct aom_codec_dec_cfg deccfg = {
48  .threads = FFMIN(avctx->thread_count ? avctx->thread_count : av_cpu_count(), 16)
49  };
50 
51  av_log(avctx, AV_LOG_INFO, "%s\n", aom_codec_version_str());
52  av_log(avctx, AV_LOG_VERBOSE, "%s\n", aom_codec_build_config());
53 
54  if (aom_codec_dec_init(&ctx->decoder, iface, &deccfg, 0) != AOM_CODEC_OK) {
55  const char *error = aom_codec_error(&ctx->decoder);
56  av_log(avctx, AV_LOG_ERROR, "Failed to initialize decoder: %s\n",
57  error);
58  return AVERROR(EINVAL);
59  }
60 
61  return 0;
62 }
63 
64 // returns 0 on success, AVERROR_INVALIDDATA otherwise
65 static int set_pix_fmt(AVCodecContext *avctx, struct aom_image *img)
66 {
67  static const enum AVColorRange color_ranges[] = {
69  };
70  avctx->color_range = color_ranges[img->range];
71  avctx->color_primaries = img->cp;
72  avctx->colorspace = img->mc;
73  avctx->color_trc = img->tc;
74 
75  switch (img->fmt) {
76  case AOM_IMG_FMT_I420:
77  case AOM_IMG_FMT_I42016:
78  if (img->bit_depth == 8) {
79  avctx->pix_fmt = img->monochrome ?
82  return 0;
83  } else if (img->bit_depth == 10) {
84  avctx->pix_fmt = img->monochrome ?
87  return 0;
88  } else if (img->bit_depth == 12) {
89  avctx->pix_fmt = img->monochrome ?
92  return 0;
93  } else {
94  return AVERROR_INVALIDDATA;
95  }
96  case AOM_IMG_FMT_I422:
97  case AOM_IMG_FMT_I42216:
98  if (img->bit_depth == 8) {
99  avctx->pix_fmt = AV_PIX_FMT_YUV422P;
101  return 0;
102  } else if (img->bit_depth == 10) {
103  avctx->pix_fmt = AV_PIX_FMT_YUV422P10;
105  return 0;
106  } else if (img->bit_depth == 12) {
107  avctx->pix_fmt = AV_PIX_FMT_YUV422P12;
109  return 0;
110  } else {
111  return AVERROR_INVALIDDATA;
112  }
113  case AOM_IMG_FMT_I444:
114  case AOM_IMG_FMT_I44416:
115  if (img->bit_depth == 8) {
116  avctx->pix_fmt = AV_PIX_FMT_YUV444P;
117  avctx->profile = FF_PROFILE_AV1_HIGH;
118  return 0;
119  } else if (img->bit_depth == 10) {
120  avctx->pix_fmt = AV_PIX_FMT_YUV444P10;
121  avctx->profile = FF_PROFILE_AV1_HIGH;
122  return 0;
123  } else if (img->bit_depth == 12) {
124  avctx->pix_fmt = AV_PIX_FMT_YUV444P12;
126  return 0;
127  } else {
128  return AVERROR_INVALIDDATA;
129  }
130 
131  default:
132  return AVERROR_INVALIDDATA;
133  }
134 }
135 
136 static int aom_decode(AVCodecContext *avctx, AVFrame *picture,
137  int *got_frame, AVPacket *avpkt)
138 {
139  AV1DecodeContext *ctx = avctx->priv_data;
140  const void *iter = NULL;
141  struct aom_image *img;
142  int ret;
143 
144  if (aom_codec_decode(&ctx->decoder, avpkt->data, avpkt->size, NULL) !=
145  AOM_CODEC_OK) {
146  const char *error = aom_codec_error(&ctx->decoder);
147  const char *detail = aom_codec_error_detail(&ctx->decoder);
148 
149  av_log(avctx, AV_LOG_ERROR, "Failed to decode frame: %s\n", error);
150  if (detail)
151  av_log(avctx, AV_LOG_ERROR, " Additional information: %s\n",
152  detail);
153  return AVERROR_INVALIDDATA;
154  }
155 
156  if ((img = aom_codec_get_frame(&ctx->decoder, &iter))) {
157  if (img->d_w > img->w || img->d_h > img->h) {
158  av_log(avctx, AV_LOG_ERROR, "Display dimensions %dx%d exceed storage %dx%d\n",
159  img->d_w, img->d_h, img->w, img->h);
160  return AVERROR_EXTERNAL;
161  }
162 
163  if ((ret = set_pix_fmt(avctx, img)) < 0) {
164  av_log(avctx, AV_LOG_ERROR, "Unsupported output colorspace (%d) / bit_depth (%d)\n",
165  img->fmt, img->bit_depth);
166  return ret;
167  }
168 
169  if ((int)img->d_w != avctx->width || (int)img->d_h != avctx->height) {
170  av_log(avctx, AV_LOG_INFO, "dimension change! %dx%d -> %dx%d\n",
171  avctx->width, avctx->height, img->d_w, img->d_h);
172  ret = ff_set_dimensions(avctx, img->d_w, img->d_h);
173  if (ret < 0)
174  return ret;
175  }
176  if ((ret = ff_get_buffer(avctx, picture, 0)) < 0)
177  return ret;
178 
179 #ifdef AOM_CTRL_AOMD_GET_FRAME_FLAGS
180  {
181  aom_codec_frame_flags_t flags;
182  ret = aom_codec_control(&ctx->decoder, AOMD_GET_FRAME_FLAGS, &flags);
183  if (ret == AOM_CODEC_OK) {
184  picture->key_frame = !!(flags & AOM_FRAME_IS_KEY);
185  if (flags & (AOM_FRAME_IS_KEY | AOM_FRAME_IS_INTRAONLY))
186  picture->pict_type = AV_PICTURE_TYPE_I;
187  else if (flags & AOM_FRAME_IS_SWITCH)
188  picture->pict_type = AV_PICTURE_TYPE_SP;
189  else
190  picture->pict_type = AV_PICTURE_TYPE_P;
191  }
192  }
193 #endif
194 
196  &picture->sample_aspect_ratio.den,
197  picture->height * img->r_w,
198  picture->width * img->r_h,
199  INT_MAX);
200  ff_set_sar(avctx, picture->sample_aspect_ratio);
201 
202  if ((img->fmt & AOM_IMG_FMT_HIGHBITDEPTH) && img->bit_depth == 8)
203  ff_aom_image_copy_16_to_8(picture, img);
204  else {
205  const uint8_t *planes[4] = { img->planes[0], img->planes[1], img->planes[2] };
206  const int stride[4] = { img->stride[0], img->stride[1], img->stride[2] };
207 
208  av_image_copy(picture->data, picture->linesize, planes,
209  stride, avctx->pix_fmt, img->d_w, img->d_h);
210  }
211  *got_frame = 1;
212  }
213  return avpkt->size;
214 }
215 
216 static av_cold int aom_free(AVCodecContext *avctx)
217 {
218  AV1DecodeContext *ctx = avctx->priv_data;
219  aom_codec_destroy(&ctx->decoder);
220  return 0;
221 }
222 
223 static av_cold int av1_init(AVCodecContext *avctx)
224 {
225  return aom_init(avctx, aom_codec_av1_dx());
226 }
227 
229  .p.name = "libaom-av1",
230  .p.long_name = NULL_IF_CONFIG_SMALL("libaom AV1"),
231  .p.type = AVMEDIA_TYPE_VIDEO,
232  .p.id = AV_CODEC_ID_AV1,
233  .priv_data_size = sizeof(AV1DecodeContext),
234  .init = av1_init,
235  .close = aom_free,
237  .p.capabilities = AV_CODEC_CAP_OTHER_THREADS | AV_CODEC_CAP_DR1,
238  .caps_internal = FF_CODEC_CAP_NOT_INIT_THREADSAFE |
240  .p.profiles = NULL_IF_CONFIG_SMALL(ff_av1_profiles),
241  .p.wrapper_name = "libaom",
242 };
error
static void error(const char *err)
Definition: target_bsf_fuzzer.c:31
aom_free
static av_cold int aom_free(AVCodecContext *avctx)
Definition: libaomdec.c:216
aom_init
static av_cold int aom_init(AVCodecContext *avctx, const struct aom_codec_iface *iface)
Definition: libaomdec.c:43
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::colorspace
enum AVColorSpace colorspace
YUV colorspace type.
Definition: avcodec.h:975
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:325
AVCodecContext::color_trc
enum AVColorTransferCharacteristic color_trc
Color Transfer Characteristic.
Definition: avcodec.h:968
AVFrame::width
int width
Definition: frame.h:397
AVCOL_RANGE_JPEG
@ AVCOL_RANGE_JPEG
Full range content.
Definition: pixfmt.h:606
internal.h
AVPacket::data
uint8_t * data
Definition: packet.h:374
set_pix_fmt
static int set_pix_fmt(AVCodecContext *avctx, struct aom_image *img)
Definition: libaomdec.c:65
AV_PIX_FMT_YUV420P10
#define AV_PIX_FMT_YUV420P10
Definition: pixfmt.h:411
FF_CODEC_CAP_NOT_INIT_THREADSAFE
#define FF_CODEC_CAP_NOT_INIT_THREADSAFE
The codec is not known to be init-threadsafe (i.e.
Definition: codec_internal.h:33
FFCodec
Definition: codec_internal.h:118
AV_LOG_VERBOSE
#define AV_LOG_VERBOSE
Detailed information.
Definition: log.h:196
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:346
init
static int init
Definition: av_tx.c:47
FFCodec::p
AVCodec p
The public AVCodec.
Definition: codec_internal.h:122
AVCodecContext::thread_count
int thread_count
thread count is used to decide how many independent tasks should be passed to execute()
Definition: avcodec.h:1472
AVFrame::key_frame
int key_frame
1 -> keyframe, 0-> not
Definition: frame.h:417
av_reduce
int av_reduce(int *dst_num, int *dst_den, int64_t num, int64_t den, int64_t max)
Reduce a fraction.
Definition: rational.c:35
AVRational::num
int num
Numerator.
Definition: rational.h:59
AV_PIX_FMT_YUV444P10
#define AV_PIX_FMT_YUV444P10
Definition: pixfmt.h:414
AV1DecodeContext::decoder
struct aom_codec_ctx decoder
Definition: libaomdec.c:40
AVCodecContext::color_primaries
enum AVColorPrimaries color_primaries
Chromaticity coordinates of the source primaries.
Definition: avcodec.h:961
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:260
AV_CODEC_CAP_OTHER_THREADS
#define AV_CODEC_CAP_OTHER_THREADS
Codec supports multithreading through a method other than slice- or frame-level multithreading.
Definition: codec.h:127
ctx
AVFormatContext * ctx
Definition: movenc.c:48
ff_av1_profiles
const AVProfile ff_av1_profiles[]
Definition: profiles.c:147
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_PIX_FMT_GRAY10
#define AV_PIX_FMT_GRAY10
Definition: pixfmt.h:392
if
if(ret)
Definition: filter_design.txt:179
NULL
#define NULL
Definition: coverity.c:32
AVCodecContext::color_range
enum AVColorRange color_range
MPEG vs JPEG YUV range.
Definition: avcodec.h:982
AV_CODEC_ID_AV1
@ AV_CODEC_ID_AV1
Definition: codec_id.h:279
ff_libaom_av1_decoder
const FFCodec ff_libaom_av1_decoder
Definition: libaomdec.c:228
AV_PICTURE_TYPE_I
@ AV_PICTURE_TYPE_I
Intra.
Definition: avutil.h:274
profiles.h
AV_PIX_FMT_YUV422P10
#define AV_PIX_FMT_YUV422P10
Definition: pixfmt.h:412
AV_PIX_FMT_GRAY8
@ AV_PIX_FMT_GRAY8
Y , 8bpp.
Definition: pixfmt.h:74
AV_PICTURE_TYPE_SP
@ AV_PICTURE_TYPE_SP
Switching Predicted.
Definition: avutil.h:279
av_cpu_count
int av_cpu_count(void)
Definition: cpu.c:195
planes
static const struct @335 planes[]
AVFrame::pict_type
enum AVPictureType pict_type
Picture type of the frame.
Definition: frame.h:422
ff_get_buffer
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: decode.c:1462
FF_PROFILE_AV1_MAIN
#define FF_PROFILE_AV1_MAIN
Definition: avcodec.h:1652
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
av1_init
static av_cold int av1_init(AVCodecContext *avctx)
Definition: libaomdec.c:223
codec_internal.h
cpu.h
AV_PIX_FMT_YUV422P12
#define AV_PIX_FMT_YUV422P12
Definition: pixfmt.h:416
AV_PIX_FMT_YUV444P12
#define AV_PIX_FMT_YUV444P12
Definition: pixfmt.h:418
aom_decode
static int aom_decode(AVCodecContext *avctx, AVFrame *picture, int *got_frame, AVPacket *avpkt)
Definition: libaomdec.c:136
img
#define img
Definition: vf_colormatrix.c:116
AVERROR_EXTERNAL
#define AVERROR_EXTERNAL
Generic error in an external library.
Definition: error.h:59
AV_LOG_INFO
#define AV_LOG_INFO
Standard information.
Definition: log.h:191
common.h
FFMIN
#define FFMIN(a, b)
Definition: macros.h:49
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:211
AVCodecContext::height
int height
Definition: avcodec.h:571
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:608
AVCOL_RANGE_MPEG
@ AVCOL_RANGE_MPEG
Narrow or limited range content.
Definition: pixfmt.h:589
FF_PROFILE_AV1_PROFESSIONAL
#define FF_PROFILE_AV1_PROFESSIONAL
Definition: avcodec.h:1654
avcodec.h
stride
#define stride
Definition: h264pred_template.c:537
ret
ret
Definition: filter_design.txt:187
AVFrame::sample_aspect_ratio
AVRational sample_aspect_ratio
Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
Definition: frame.h:427
AV_PIX_FMT_YUV420P12
#define AV_PIX_FMT_YUV420P12
Definition: pixfmt.h:415
ff_set_sar
int ff_set_sar(AVCodecContext *avctx, AVRational sar)
Check that the provided sample aspect ratio is valid and set it on the codec context.
Definition: utils.c:105
AVCodecContext
main external API structure.
Definition: avcodec.h:398
AVFrame::height
int height
Definition: frame.h:397
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
AVRational::den
int den
Denominator.
Definition: rational.h:60
AVCodecContext::profile
int profile
profile
Definition: avcodec.h:1556
AV1DecodeContext
Definition: libaomdec.c:39
AV_PIX_FMT_YUV444P
@ AV_PIX_FMT_YUV444P
planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
Definition: pixfmt.h:71
AV_PICTURE_TYPE_P
@ AV_PICTURE_TYPE_P
Predicted.
Definition: avutil.h:275
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AV_PIX_FMT_YUV422P
@ AV_PIX_FMT_YUV422P
planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
Definition: pixfmt.h:70
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
FF_CODEC_CAP_AUTO_THREADS
#define FF_CODEC_CAP_AUTO_THREADS
Codec handles avctx->thread_count == 0 (auto) internally.
Definition: codec_internal.h:72
ff_aom_image_copy_16_to_8
void ff_aom_image_copy_16_to_8(AVFrame *pic, struct aom_image *img)
Definition: libaom.c:27
AVPacket
This structure stores compressed data.
Definition: packet.h:351
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:425
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:571
imgutils.h
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
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
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
FF_PROFILE_AV1_HIGH
#define FF_PROFILE_AV1_HIGH
Definition: avcodec.h:1653
AV_PIX_FMT_GRAY12
#define AV_PIX_FMT_GRAY12
Definition: pixfmt.h:393
libaom.h
AVColorRange
AVColorRange
Visual content value range.
Definition: pixfmt.h:571