FFmpeg: libavcodec/libxavs2.c Source File

FFmpeg

[フレーム]

libavcodec

libxavs2.c

Go to the documentation of this file.

1 /*

2 * AVS2 encoding using the xavs2 library

3 *

5 * Falei Luo, <falei.luo@gmail.com>

6 * Huiwen Ren, <hwrenx@gmail.com>

7 *

8 * This file is part of FFmpeg.

9 *

10 * FFmpeg is free software; you can redistribute it and/or

11 * modify it under the terms of the GNU Lesser General Public

12 * License as published by the Free Software Foundation; either

13 * version 2.1 of the License, or (at your option) any later version.

14 *

15 * FFmpeg is distributed in the hope that it will be useful,

16 * but WITHOUT ANY WARRANTY; without even the implied warranty of

17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

18 * Lesser General Public License for more details.

19 *

20 * You should have received a copy of the GNU Lesser General Public

21 * License along with FFmpeg; if not, write to the Free Software

22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

23 */

25 #include "xavs2.h"

26 #include "codec_internal.h"

27 #include "encode.h"

28 #include "mpeg12.h"

29 #include "libavutil/avstring.h"

30 #include "libavutil/opt.h"

32 #define xavs2_opt_set2(name, format, ...) do{ \

33 char opt_str[16] = {0}; \

34 int err; \

35 av_strlcatf(opt_str, sizeof(opt_str), format, __VA_ARGS__); \

36 err = cae->api->opt_set2(cae->param, name, opt_str); \

37 if (err < 0) {\

38 av_log(avctx, AV_LOG_WARNING, "Invalid value for %s: %s\n", name, opt_str);\

39 }\

40 } while(0);

42 typedef struct XAVS2EContext {

43 AVClass *class;

45 int lcu_row_threads;

46 int initial_qp;

47 int qp;

48 int max_qp;

49 int min_qp;

50 int preset_level;

51 int log_level;

53 void *encoder;

54 AVDictionary *xavs2_opts;

56 xavs2_outpacket_t packet;

57 xavs2_param_t *param;

59 const xavs2_api_t *api;

61 } XAVS2EContext;

63 static av_cold int xavs2_init(AVCodecContext *avctx)

64 {

65 XAVS2EContext *cae = avctx->priv_data;

66 int bit_depth, code;

68 bit_depth = avctx->pix_fmt == AV_PIX_FMT_YUV420P ? 8 : 10;

70 /* get API handler */

71 cae->api = xavs2_api_get(bit_depth);

72 if (!cae->api) {

73 av_log(avctx, AV_LOG_ERROR, "Failed to get xavs2 api context\n");

74 return AVERROR_EXTERNAL;

75 }

77 cae->param = cae->api->opt_alloc();

78 if (!cae->param) {

79 av_log(avctx, AV_LOG_ERROR, "Failed to alloc xavs2 parameters\n");

80 return AVERROR(ENOMEM);

81 }

83 xavs2_opt_set2("Width", "%d", avctx->width);

84 xavs2_opt_set2("Height", "%d", avctx->height);

85 xavs2_opt_set2("BFrames", "%d", avctx->max_b_frames);

86 xavs2_opt_set2("BitDepth", "%d", bit_depth);

87 xavs2_opt_set2("Log", "%d", cae->log_level);

88 xavs2_opt_set2("Preset", "%d", cae->preset_level);

90 xavs2_opt_set2("IntraPeriodMax", "%d", avctx->gop_size);

91 xavs2_opt_set2("IntraPeriodMin", "%d", avctx->gop_size);

93 xavs2_opt_set2("ThreadFrames", "%d", avctx->thread_count);

94 xavs2_opt_set2("ThreadRows", "%d", cae->lcu_row_threads);

96 xavs2_opt_set2("OpenGOP", "%d", !(avctx->flags & AV_CODEC_FLAG_CLOSED_GOP));

98 {

99 const AVDictionaryEntry *en = NULL;

100 while ((en = av_dict_iterate(cae->xavs2_opts, en)))

101 xavs2_opt_set2(en->key, "%s", en->value);

102 }

103

104 /* Rate control */

105 if (avctx->bit_rate > 0) {

106 xavs2_opt_set2("RateControl", "%d", 1);

107 xavs2_opt_set2("TargetBitRate", "%"PRId64"", avctx->bit_rate);

108 xavs2_opt_set2("InitialQP", "%d", cae->initial_qp);

109 xavs2_opt_set2("MaxQP", "%d", avctx->qmax >= 0 ? avctx->qmax : cae->max_qp);

110 xavs2_opt_set2("MinQP", "%d", avctx->qmin >= 0 ? avctx->qmin : cae->min_qp);

111 } else {

112 xavs2_opt_set2("InitialQP", "%d", cae->qp);

113 }

114

115 ff_mpeg12_find_best_frame_rate(avctx->framerate, &code, NULL, NULL, 0);

116 xavs2_opt_set2("FrameRate", "%d", code);

117

118 cae->encoder = cae->api->encoder_create(cae->param);

119

120 if (!cae->encoder) {

121 av_log(avctx, AV_LOG_ERROR, "Failed to create xavs2 encoder instance.\n");

122 return AVERROR(EINVAL);

123 }

124

125 return 0;

126 }

127

128 static void xavs2_copy_frame_with_shift(xavs2_picture_t *pic, const AVFrame *frame, const int shift_in)

129 {

130 uint16_t *p_plane;

131 uint8_t *p_buffer;

132 int plane;

133 int hIdx;

134 int wIdx;

135

136 for (plane = 0; plane < 3; plane++) {

137 p_plane = (uint16_t *)pic->img.img_planes[plane];

138 p_buffer = frame->data[plane];

139 for (hIdx = 0; hIdx < pic->img.i_lines[plane]; hIdx++) {

140 memset(p_plane, 0, pic->img.i_stride[plane]);

141 for (wIdx = 0; wIdx < pic->img.i_width[plane]; wIdx++) {

142 p_plane[wIdx] = p_buffer[wIdx] << shift_in;

143 }

144 p_plane += pic->img.i_stride[plane];

145 p_buffer += frame->linesize[plane];

146 }

147 }

148 }

149

150 static void xavs2_copy_frame(xavs2_picture_t *pic, const AVFrame *frame)

151 {

152 uint8_t *p_plane;

153 uint8_t *p_buffer;

154 int plane;

155 int hIdx;

156 int stride;

157

158 for (plane = 0; plane < 3; plane++) {

159 p_plane = pic->img.img_planes[plane];

160 p_buffer = frame->data[plane];

161 stride = pic->img.i_width[plane] * pic->img.in_sample_size;

162 for (hIdx = 0; hIdx < pic->img.i_lines[plane]; hIdx++) {

163 memcpy(p_plane, p_buffer, stride);

164 p_plane += pic->img.i_stride[plane];

165 p_buffer += frame->linesize[plane];

166 }

167 }

168 }

169

170 static int xavs2_encode_frame(AVCodecContext *avctx, AVPacket *pkt,

171 const AVFrame *frame, int *got_packet)

172 {

173 XAVS2EContext *cae = avctx->priv_data;

174 xavs2_picture_t pic;

175 int ret;

176

177 /* create the XAVS2 video encoder */

178 /* read frame data and send to the XAVS2 video encoder */

179 if (cae->api->encoder_get_buffer(cae->encoder, &pic) < 0) {

180 av_log(avctx, AV_LOG_ERROR, "Failed to get xavs2 frame buffer\n");

181 return AVERROR_EXTERNAL;

182 }

183 if (frame) {

184 switch (frame->format) {

185 case AV_PIX_FMT_YUV420P:

186 if (pic.img.in_sample_size == pic.img.enc_sample_size) {

187 xavs2_copy_frame(&pic, frame);

188 } else {

189 const int shift_in = atoi(cae->api->opt_get(cae->param, "SampleShift"));

190 xavs2_copy_frame_with_shift(&pic, frame, shift_in);

191 }

192 break;

193 case AV_PIX_FMT_YUV420P10:

194 if (pic.img.in_sample_size == pic.img.enc_sample_size) {

195 xavs2_copy_frame(&pic, frame);

196 break;

197 }

198 default:

199 av_log(avctx, AV_LOG_ERROR, "Unsupported pixel format\n");

200 return AVERROR(EINVAL);

201 break;

202 }

203

204 pic.i_state = 0;

205 pic.i_pts = frame->pts;

206 pic.i_type = XAVS2_TYPE_AUTO;

207

208 ret = cae->api->encoder_encode(cae->encoder, &pic, &cae->packet);

209

210 if (ret) {

211 av_log(avctx, AV_LOG_ERROR, "Encoding error occurred.\n");

212 return AVERROR_EXTERNAL;

213 }

214

215 } else {

216 cae->api->encoder_encode(cae->encoder, NULL, &cae->packet);

217 }

218

219 if ((cae->packet.len) && (cae->packet.state != XAVS2_STATE_FLUSH_END)) {

220 if ((ret = ff_get_encode_buffer(avctx, pkt, cae->packet.len, 0)) < 0) {

221 cae->api->encoder_packet_unref(cae->encoder, &cae->packet);

222 return ret;

223 }

224

225 pkt->pts = cae->packet.pts;

226 pkt->dts = cae->packet.dts;

227

228 if (cae->packet.type == XAVS2_TYPE_IDR ||

229 cae->packet.type == XAVS2_TYPE_I ||

230 cae->packet.type == XAVS2_TYPE_KEYFRAME) {

231 pkt->flags |= AV_PKT_FLAG_KEY;

232 }

233

234 memcpy(pkt->data, cae->packet.stream, cae->packet.len);

235

236 cae->api->encoder_packet_unref(cae->encoder, &cae->packet);

237

238 *got_packet = 1;

239 } else {

240 *got_packet = 0;

241 }

242

243 return 0;

244 }

245

246 static av_cold int xavs2_close(AVCodecContext *avctx)

247 {

248 XAVS2EContext *cae = avctx->priv_data;

249 /* destroy the encoder */

250 if (cae->api) {

251 cae->api->encoder_destroy(cae->encoder);

252

253 if (cae->param) {

254 cae->api->opt_destroy(cae->param);

255 }

256 }

257 return 0;

258 }

259

260 #define OFFSET(x) offsetof(XAVS2EContext, x)

261 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM

262

263 static const AVOption options[] = {

264 { "lcu_row_threads" , "number of parallel threads for rows" , OFFSET(lcu_row_threads) , AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, VE },

265 { "initial_qp" , "Quantization initial parameter" , OFFSET(initial_qp) , AV_OPT_TYPE_INT, {.i64 = 34 }, 1, 63, VE },

266 { "qp" , "Quantization parameter" , OFFSET(qp) , AV_OPT_TYPE_INT, {.i64 = 34 }, 1, 63, VE },

267 { "max_qp" , "max qp for rate control" , OFFSET(max_qp) , AV_OPT_TYPE_INT, {.i64 = 55 }, 0, 63, VE },

268 { "min_qp" , "min qp for rate control" , OFFSET(min_qp) , AV_OPT_TYPE_INT, {.i64 = 20 }, 0, 63, VE },

269 { "speed_level" , "Speed level, higher is better but slower", OFFSET(preset_level) , AV_OPT_TYPE_INT, {.i64 = 0 }, 0, 9, VE },

270 { "log_level" , "log level: -1: none, 0: error, 1: warning, 2: info, 3: debug", OFFSET(log_level) , AV_OPT_TYPE_INT, {.i64 = 0 }, -1, 3, VE },

271 { "xavs2-params" , "set the xavs2 configuration using a :-separated list of key=value parameters", OFFSET(xavs2_opts), AV_OPT_TYPE_DICT, { 0 }, 0, 0, VE },

272 { NULL },

273 };

274

275 static const AVClass libxavs2 = {

276 .class_name = "XAVS2EContext",

277 .item_name = av_default_item_name,

278 .option = options,

279 .version = LIBAVUTIL_VERSION_INT,

280 };

281

282 static const FFCodecDefault xavs2_defaults[] = {

283 { "b", "0" },

284 { "g", "48"},

285 { "bf", "7" },

286 { NULL },

287 };

288

289 const FFCodec ff_libxavs2_encoder = {

290 .p.name = "libxavs2",

291 CODEC_LONG_NAME("libxavs2 AVS2-P2/IEEE1857.4"),

292 .p.type = AVMEDIA_TYPE_VIDEO,

293 .p.id = AV_CODEC_ID_AVS2,

294 .p.capabilities = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_DELAY |

295 AV_CODEC_CAP_OTHER_THREADS,

296 .priv_data_size = sizeof(XAVS2EContext),

297 .init = xavs2_init,

298 FF_CODEC_ENCODE_CB(xavs2_encode_frame),

299 .close = xavs2_close,

300 .caps_internal = FF_CODEC_CAP_NOT_INIT_THREADSAFE |

301 FF_CODEC_CAP_AUTO_THREADS,

302 CODEC_PIXFMTS(AV_PIX_FMT_YUV420P),

303 .color_ranges = AVCOL_RANGE_MPEG,

304 .p.priv_class = &libxavs2,

305 .defaults = xavs2_defaults,

306 .p.wrapper_name = "libxavs2",

307 } ;

xavs2_copy_frame

static void xavs2_copy_frame(xavs2_picture_t *pic, const AVFrame *frame)

Definition: libxavs2.c:150

CODEC_PIXFMTS

#define CODEC_PIXFMTS(...)

Definition: codec_internal.h:391

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

XAVS2EContext::initial_qp

int initial_qp

Definition: libxavs2.c:46

XAVS2EContext::min_qp

int min_qp

Definition: libxavs2.c:49

XAVS2EContext::lcu_row_threads

int lcu_row_threads

Definition: libxavs2.c:45

xavs2_copy_frame_with_shift

static void xavs2_copy_frame_with_shift(xavs2_picture_t *pic, const AVFrame *frame, const int shift_in)

Definition: libxavs2.c:128

AVFrame

This structure describes decoded (raw) audio or video data.

Definition: frame.h:427

AVPacket::data

uint8_t * data

Definition: packet.h:558

AVOption

AVOption.

Definition: opt.h:429

encode.h

AV_CODEC_ID_AVS2

@ AV_CODEC_ID_AVS2

Definition: codec_id.h:248

XAVS2EContext::xavs2_opts

AVDictionary * xavs2_opts

Definition: libxavs2.c:54

AV_PIX_FMT_YUV420P10

#define AV_PIX_FMT_YUV420P10

Definition: pixfmt.h:539

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:34

FFCodec

Definition: codec_internal.h:127

libxavs2

static const AVClass libxavs2

Definition: libxavs2.c:275

AVDictionary

Definition: dict.c:32

XAVS2EContext::encoder

void * encoder

Definition: libxavs2.c:53

AVCodecContext::qmax

int qmax

maximum quantizer

Definition: avcodec.h:1241

bit_depth

static void bit_depth(AudioStatsContext *s, const uint64_t *const mask, uint8_t *depth)

Definition: af_astats.c:246

AV_PKT_FLAG_KEY

#define AV_PKT_FLAG_KEY

The packet contains a keyframe.

Definition: packet.h:613

ff_mpeg12_find_best_frame_rate

void ff_mpeg12_find_best_frame_rate(AVRational frame_rate, int *code, int *ext_n, int *ext_d, int nonstandard)

Definition: mpeg12framerate.c:44

AVCodecContext::framerate

AVRational framerate

Definition: avcodec.h:551

FFCodecDefault

Definition: codec_internal.h:96

FFCodec::p

AVCodec p

The public AVCodec.

Definition: codec_internal.h:131

XAVS2EContext::log_level

int log_level

Definition: libxavs2.c:51

AVCodecContext::thread_count

int thread_count

thread count is used to decide how many independent tasks should be passed to execute()

Definition: avcodec.h:1561

AVCodecContext::flags

int flags

AV_CODEC_FLAG_*.

Definition: avcodec.h:488

XAVS2EContext::api

const xavs2_api_t * api

Definition: libxavs2.c:59

FF_CODEC_ENCODE_CB

#define FF_CODEC_ENCODE_CB(func)

Definition: codec_internal.h:358

mpeg12.h

pkt

AVPacket * pkt

Definition: movenc.c:60

AV_LOG_ERROR

#define AV_LOG_ERROR

Something went wrong and cannot losslessly be recovered.

Definition: log.h:210

av_cold

#define av_cold

Definition: attributes.h:106

XAVS2EContext

Definition: libxavs2.c:42

AVDictionaryEntry::key

char * key

Definition: dict.h:91

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:109

XAVS2EContext::packet

xavs2_outpacket_t packet

Definition: libxavs2.c:56

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:73

CODEC_LONG_NAME

#define CODEC_LONG_NAME(str)

Definition: codec_internal.h:331

XAVS2EContext::preset_level

int preset_level

Definition: libxavs2.c:50

LIBAVUTIL_VERSION_INT

#define LIBAVUTIL_VERSION_INT

Definition: version.h:85

AVClass

Describe the class of an AVClass context structure.

Definition: log.h:76

NULL

#define NULL

Definition: coverity.c:32

xavs2_encode_frame

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

Definition: libxavs2.c:170

XAVS2EContext::qp

int qp

Definition: libxavs2.c:47

xavs2_init

static av_cold int xavs2_init(AVCodecContext *avctx)

Definition: libxavs2.c:63

#define VE

Definition: libxavs2.c:261

AVCodecContext::bit_rate

int64_t bit_rate

the average bitrate

Definition: avcodec.h:481

AV_OPT_TYPE_DICT

@ AV_OPT_TYPE_DICT

Underlying C type is AVDictionary*.

Definition: opt.h:290

av_default_item_name

const char * av_default_item_name(void *ptr)

Return the context name.

Definition: log.c:241

options

Definition: swscale.c:43

init

int(* init)(AVBSFContext *ctx)

Definition: dts2pts.c:368

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

ff_libxavs2_encoder

const FFCodec ff_libxavs2_encoder

Definition: libxavs2.c:289

AVCodecContext::gop_size

int gop_size

the number of pictures in a group of pictures, or 0 for intra_only

Definition: avcodec.h:1005

codec_internal.h

for

for(k=2;k<=8;++k)

Definition: h264pred_template.c:424

xavs2_opt_set2

#define xavs2_opt_set2(name, format,...)

Definition: libxavs2.c:32

AVPacket::dts

int64_t dts

Decompression timestamp in AVStream->time_base units; the time at which the packet is decompressed.

Definition: packet.h:557

AVERROR_EXTERNAL

#define AVERROR_EXTERNAL

Generic error in an external library.

Definition: error.h:59

AVPacket::flags

int flags

A combination of AV_PKT_FLAG values.

Definition: packet.h:564

XAVS2EContext::param

xavs2_param_t * param

Definition: libxavs2.c:57

XAVS2EContext::max_qp

int max_qp

Definition: libxavs2.c:48

AVPacket::pts

int64_t pts

Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...

Definition: packet.h:551

code

and forward the test the status of outputs and forward it to the corresponding return FFERROR_NOT_READY If the filters stores internally one or a few frame for some it can consider them to be part of the FIFO and delay acknowledging a status change accordingly Example code

Definition: filter_design.txt:178

AVCodec::name

const char * name

Name of the codec implementation.

Definition: codec.h:179

AVCodecContext::height

int height

Definition: avcodec.h:592

AVCodecContext::pix_fmt

enum AVPixelFormat pix_fmt

Pixel format, see AV_PIX_FMT_xxx.

Definition: avcodec.h:631

AVCOL_RANGE_MPEG

@ AVCOL_RANGE_MPEG

Narrow or limited range content.

Definition: pixfmt.h:750

OFFSET

#define OFFSET(x)

Definition: libxavs2.c:260

stride

#define stride

Definition: h264pred_template.c:536

AV_CODEC_FLAG_CLOSED_GOP

#define AV_CODEC_FLAG_CLOSED_GOP

Definition: avcodec.h:332

ret

Definition: filter_design.txt:187

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:81

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:265

AVCodecContext

main external API structure.

Definition: avcodec.h:431

ff_get_encode_buffer

int ff_get_encode_buffer(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int flags)

Get a buffer for a packet.

Definition: encode.c:104

AVCodecContext::qmin

int qmin

minimum quantizer

Definition: avcodec.h:1234