FFmpeg  4.0
Data Structures | Macros | Functions | Variables
libaomenc.c File Reference

AV1 encoder support via libaom. More...

#include <aom/aom_encoder.h>
#include <aom/aomcx.h>
#include "libavutil/avassert.h"
#include "libavutil/base64.h"
#include "libavutil/common.h"
#include "libavutil/mathematics.h"
#include "libavutil/opt.h"
#include "libavutil/pixdesc.h"
#include "avcodec.h"
#include "internal.h"
#include "profiles.h"

Go to the source code of this file.

Data Structures

struct  FrameListData
 Portion of struct vpx_codec_cx_pkt from vpx_encoder.h. More...
 
struct  AOMContext
 

Macros

#define AOM_DISABLE_CTRL_TYPECHECKS   1
 
#define OFFSET(x)   offsetof(AOMContext, x)
 
#define VE   AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
 

Functions

static av_cold void log_encoder_error (AVCodecContext *avctx, const char *desc)
 
static av_cold void dump_enc_cfg (AVCodecContext *avctx, const struct aom_codec_enc_cfg *cfg)
 
static void coded_frame_add (void *list, struct FrameListData *cx_frame)
 
static av_cold void free_coded_frame (struct FrameListData *cx_frame)
 
static av_cold void free_frame_list (struct FrameListData *list)
 
static av_cold int codecctl_int (AVCodecContext *avctx, enum aome_enc_control_id id, int val)
 
static av_cold int aom_free (AVCodecContext *avctx)
 
static int set_pix_fmt (AVCodecContext *avctx, aom_codec_caps_t codec_caps, struct aom_codec_enc_cfg *enccfg, aom_codec_flags_t *flags, aom_img_fmt_t *img_fmt)
 
static void set_color_range (AVCodecContext *avctx)
 
static av_cold int aom_init (AVCodecContext *avctx, const struct aom_codec_iface *iface)
 
static void cx_pktcpy (struct FrameListData *dst, const struct aom_codec_cx_pkt *src)
 
static int storeframe (AVCodecContext *avctx, struct FrameListData *cx_frame, AVPacket *pkt)
 Store coded frame information in format suitable for return from encode2(). More...
 
static int queue_frames (AVCodecContext *avctx, AVPacket *pkt_out)
 Queue multiple output frames from the encoder, returning the front-most. More...
 
static int aom_encode (AVCodecContext *avctx, AVPacket *pkt, const AVFrame *frame, int *got_packet)
 
static av_cold void av1_init_static (AVCodec *codec)
 
static av_cold int av1_init (AVCodecContext *avctx)
 

Variables

static const char *const ctlidstr []
 
static enum AVPixelFormat av1_pix_fmts []
 
static enum AVPixelFormat av1_pix_fmts_highbd []
 
static const AVOption options []
 
static const AVCodecDefault defaults []
 
static const AVClass class_aom
 
AVCodec ff_libaom_av1_encoder
 

Detailed Description

AV1 encoder support via libaom.

Definition in file libaomenc.c.

Macro Definition Documentation

◆ AOM_DISABLE_CTRL_TYPECHECKS

#define AOM_DISABLE_CTRL_TYPECHECKS   1

Definition at line 26 of file libaomenc.c.

◆ OFFSET

#define OFFSET (   x)    offsetof(AOMContext, x)

Definition at line 690 of file libaomenc.c.

◆ VE

Definition at line 691 of file libaomenc.c.

Function Documentation

◆ log_encoder_error()

static av_cold void log_encoder_error ( AVCodecContext avctx,
const char *  desc 
)
static

Definition at line 83 of file libaomenc.c.

Referenced by aom_encode(), aom_init(), and codecctl_int().

◆ dump_enc_cfg()

static av_cold void dump_enc_cfg ( AVCodecContext avctx,
const struct aom_codec_enc_cfg *  cfg 
)
static

Definition at line 94 of file libaomenc.c.

Referenced by aom_init().

◆ coded_frame_add()

static void coded_frame_add ( void list,
struct FrameListData cx_frame 
)
static

Definition at line 148 of file libaomenc.c.

Referenced by queue_frames().

◆ free_coded_frame()

static av_cold void free_coded_frame ( struct FrameListData cx_frame)
static

Definition at line 158 of file libaomenc.c.

Referenced by free_frame_list(), and queue_frames().

◆ free_frame_list()

static av_cold void free_frame_list ( struct FrameListData list)
static

Definition at line 164 of file libaomenc.c.

Referenced by aom_free().

◆ codecctl_int()

static av_cold int codecctl_int ( AVCodecContext avctx,
enum aome_enc_control_id  id,
int  val 
)
static

Definition at line 175 of file libaomenc.c.

Referenced by aom_init(), and set_color_range().

◆ aom_free()

static av_cold int aom_free ( AVCodecContext avctx)
static

Definition at line 197 of file libaomenc.c.

◆ set_pix_fmt()

static int set_pix_fmt ( AVCodecContext avctx,
aom_codec_caps_t  codec_caps,
struct aom_codec_enc_cfg *  enccfg,
aom_codec_flags_t *  flags,
aom_img_fmt_t *  img_fmt 
)
static

Definition at line 208 of file libaomenc.c.

Referenced by aom_init().

◆ set_color_range()

static void set_color_range ( AVCodecContext avctx)
static

Definition at line 269 of file libaomenc.c.

Referenced by aom_init(), vpx_free(), and vpx_init().

◆ aom_init()

static av_cold int aom_init ( AVCodecContext avctx,
const struct aom_codec_iface *  iface 
)
static

Definition at line 285 of file libaomenc.c.

Referenced by av1_init().

◆ cx_pktcpy()

static void cx_pktcpy ( struct FrameListData dst,
const struct aom_codec_cx_pkt *  src 
)
inlinestatic

Definition at line 477 of file libaomenc.c.

Referenced by queue_frames().

◆ storeframe()

static int storeframe ( AVCodecContext avctx,
struct FrameListData cx_frame,
AVPacket pkt 
)
static

Store coded frame information in format suitable for return from encode2().

Write information from cx_frame to pkt

Returns
packet data size on success
a negative AVERROR on error

Definition at line 494 of file libaomenc.c.

Referenced by queue_frames().

◆ queue_frames()

static int queue_frames ( AVCodecContext avctx,
AVPacket pkt_out 
)
static

Queue multiple output frames from the encoder, returning the front-most.

In cases where aom_codec_get_cx_data() returns more than 1 frame append the frame queue. Return the head frame if available.

Returns
Stored frame size
AVERROR(EINVAL) on output size error
AVERROR(ENOMEM) on coded frame queue data allocation error

Definition at line 519 of file libaomenc.c.

Referenced by aom_encode().

◆ aom_encode()

static int aom_encode ( AVCodecContext avctx,
AVPacket pkt,
const AVFrame frame,
int got_packet 
)
static

Definition at line 600 of file libaomenc.c.

◆ av1_init_static()

static av_cold void av1_init_static ( AVCodec codec)
static

Definition at line 676 of file libaomenc.c.

◆ av1_init()

static av_cold int av1_init ( AVCodecContext avctx)
static

Definition at line 685 of file libaomenc.c.

Variable Documentation

◆ ctlidstr

const char* const ctlidstr[]
static
Initial value:
= {
[AOME_SET_CPUUSED] = "AOME_SET_CPUUSED",
[AOME_SET_CQ_LEVEL] = "AOME_SET_CQ_LEVEL",
[AOME_SET_ENABLEAUTOALTREF] = "AOME_SET_ENABLEAUTOALTREF",
[AOME_SET_STATIC_THRESHOLD] = "AOME_SET_STATIC_THRESHOLD",
[AV1E_SET_COLOR_RANGE] = "AV1E_SET_COLOR_RANGE",
[AV1E_SET_COLOR_PRIMARIES] = "AV1E_SET_COLOR_PRIMARIES",
[AV1E_SET_MATRIX_COEFFICIENTS] = "AV1E_SET_MATRIX_COEFFICIENTS",
[AV1E_SET_TRANSFER_CHARACTERISTICS] = "AV1E_SET_TRANSFER_CHARACTERISTICS",
}

Definition at line 72 of file libaomenc.c.

Referenced by codecctl_int().

◆ av1_pix_fmts

enum AVPixelFormat av1_pix_fmts[]
static
Initial value:
= {
}
planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
Definition: pixfmt.h:67
planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
Definition: pixfmt.h:66
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:62

Definition at line 656 of file libaomenc.c.

Referenced by av1_init_static().

◆ av1_pix_fmts_highbd

enum AVPixelFormat av1_pix_fmts_highbd[]
static
Initial value:
= {
}
planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
Definition: pixfmt.h:67
#define AV_PIX_FMT_YUV420P12
Definition: pixfmt.h:372
#define AV_PIX_FMT_YUV422P12
Definition: pixfmt.h:373
#define AV_PIX_FMT_YUV444P10
Definition: pixfmt.h:371
planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
Definition: pixfmt.h:66
#define AV_PIX_FMT_YUV420P10
Definition: pixfmt.h:368
#define AV_PIX_FMT_YUV422P10
Definition: pixfmt.h:369
#define AV_PIX_FMT_YUV444P12
Definition: pixfmt.h:375
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:62

Definition at line 663 of file libaomenc.c.

Referenced by av1_init_static().

◆ options

const AVOption options[]
static
Initial value:
= {
{ "cpu-used", "Quality/Speed ratio modifier", OFFSET(cpu_used), AV_OPT_TYPE_INT, {.i64 = 1}, -8, 8, VE},
{ "auto-alt-ref", "Enable use of alternate reference "
"frames (2-pass only)", OFFSET(auto_alt_ref), AV_OPT_TYPE_INT, {.i64 = -1}, -1, 2, VE},
{ "lag-in-frames", "Number of frames to look ahead at for "
"alternate reference frame selection", OFFSET(lag_in_frames), AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX, VE},
{ "error-resilience", "Error resilience configuration", OFFSET(error_resilient), AV_OPT_TYPE_FLAGS, {.i64 = 0}, INT_MIN, INT_MAX, VE, "er"},
{ "default", "Improve resiliency against losses of whole frames", 0, AV_OPT_TYPE_CONST, {.i64 = AOM_ERROR_RESILIENT_DEFAULT}, 0, 0, VE, "er"},
{ "partitions", "The frame partitions are independently decodable "
"by the bool decoder, meaning that partitions can be decoded even "
"though earlier partitions have been lost. Note that intra predicition"
" is still done over the partition boundary.", 0, AV_OPT_TYPE_CONST, {.i64 = AOM_ERROR_RESILIENT_PARTITIONS}, 0, 0, VE, "er"},
{ "crf", "Select the quality for constant quality mode", 0x42, AV_OPT_TYPE_INT, {.i64 = -1}, -1, 63, VE },
{ "static-thresh", "A change threshold on blocks below which they will be skipped by the encoder", OFFSET(static_thresh), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, VE },
{ "drop-threshold", "Frame drop threshold", 0x42, AV_OPT_TYPE_INT, {.i64 = 0 }, INT_MIN, INT_MAX, VE },
{ "noise-sensitivity", "Noise sensitivity", OFFSET(noise_sensitivity), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, 4, VE},
{ NULL }
}
#define OFFSET(x)
Definition: libaomenc.c:690
#define NULL
Definition: coverity.c:32
#define VE
Definition: libaomenc.c:691

Definition at line 692 of file libaomenc.c.

◆ defaults

const AVCodecDefault defaults[]
static
Initial value:
= {
{ "qmin", "-1" },
{ "qmax", "-1" },
{ "g", "-1" },
{ "keyint_min", "-1" },
{ NULL },
}
#define NULL
Definition: coverity.c:32

Definition at line 711 of file libaomenc.c.

◆ class_aom

const AVClass class_aom
static
Initial value:
= {
.class_name = "libaom-av1 encoder",
.item_name = av_default_item_name,
.option = options,
}
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:191
static const AVOption options[]
Definition: libaomenc.c:692

Definition at line 719 of file libaomenc.c.

◆ ff_libaom_av1_encoder

AVCodec ff_libaom_av1_encoder
Initial value:
= {
.name = "libaom-av1",
.long_name = NULL_IF_CONFIG_SMALL("libaom AV1"),
.priv_data_size = sizeof(AOMContext),
.encode2 = aom_encode,
.close = aom_free,
.priv_class = &class_aom,
.defaults = defaults,
.init_static_data = av1_init_static,
.wrapper_name = "libaom",
}
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
#define AV_CODEC_CAP_EXPERIMENTAL
Codec is experimental and is thus avoided in favor of non experimental encoders.
Definition: avcodec.h:1007
#define AV_CODEC_CAP_AUTO_THREADS
Codec supports avctx->thread_count == 0 (auto).
Definition: avcodec.h:1027
#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: avcodec.h:984
static av_cold void av1_init_static(AVCodec *codec)
Definition: libaomenc.c:676
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
static const AVClass class_aom
Definition: libaomenc.c:719
const AVProfile ff_av1_profiles[]
Definition: profiles.c:143
static av_cold int av1_init(AVCodecContext *avctx)
Definition: libaomenc.c:685
static const AVProfile profiles[]
static int aom_encode(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *frame, int *got_packet)
Definition: libaomenc.c:600
static const AVCodecDefault defaults[]
Definition: libaomenc.c:711
static av_cold int aom_free(AVCodecContext *avctx)
Definition: libaomenc.c:197

Definition at line 726 of file libaomenc.c.