2 * Copyright (c) 2010, Google, Inc.
4 * This file is part of FFmpeg.
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.
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.
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
23 * VP8/9 encoder support via libvpx
26 #define VPX_DISABLE_CTRL_TYPECHECKS 1
27 #define VPX_CODEC_DISABLE_COMPAT 1
28 #include <vpx/vpx_encoder.h>
29 #include <vpx/vp8cx.h>
33 #include "libavutil/avassert.h"
36 #include "libavutil/avstring.h"
37 #include "libavutil/base64.h"
38 #include "libavutil/common.h"
39 #include "libavutil/internal.h"
40 #include "libavutil/intreadwrite.h"
41 #include "libavutil/mathematics.h"
42 #include "libavutil/opt.h"
45 * Portion of struct vpx_codec_cx_pkt from vpx_encoder.h.
46 * One encoded frame returned from the library.
48 struct FrameListData {
49 void *buf; /**< compressed data buffer */
50 size_t sz; /**< length of compressed data */
53 int64_t pts; /**< time stamp to show frame
54 (in timebase units) */
55 unsigned long duration; /**< duration to show frame
56 (in timebase units) */
57 uint32_t flags; /**< flags for this frame */
59 int have_sse; /**< true if we have pending sse[] */
60 uint64_t frame_number;
61 struct FrameListData *next;
64 typedef struct VPxEncoderContext {
66 struct vpx_codec_ctx encoder;
67 struct vpx_image rawimg;
68 struct vpx_codec_ctx encoder_alpha;
69 struct vpx_image rawimg_alpha;
71 struct vpx_fixed_buf twopass_stats;
72 int deadline; //i.e., RT/GOOD/BEST
74 int have_sse; /**< true if we have pending sse[] */
75 uint64_t frame_number;
76 struct FrameListData *coded_frame_list;
81 * VP8 specific flags, see VP8F_* below.
84 #define VP8F_ERROR_RESILIENT 0x00000001 ///< Enable measures appropriate for streaming over lossy links
85 #define VP8F_AUTO_ALT_REF 0x00000002 ///< Enable automatic alternate reference frame generation
100 int rc_undershoot_pct;
101 int rc_overshoot_pct;
103 AVDictionary *vp8_ts_parameters;
112 int noise_sensitivity;
117 int corpus_complexity;
120 * If the driver does not support ROI then warn the first time we
121 * encounter a frame with ROI side data.
126 /** String mappings for enum vp8e_enc_control_id */
127 static const char *const ctlidstr[] = {
128 [VP8E_SET_CPUUSED] = "VP8E_SET_CPUUSED",
129 [VP8E_SET_ENABLEAUTOALTREF] = "VP8E_SET_ENABLEAUTOALTREF",
130 [VP8E_SET_NOISE_SENSITIVITY] = "VP8E_SET_NOISE_SENSITIVITY",
131 [VP8E_SET_STATIC_THRESHOLD] = "VP8E_SET_STATIC_THRESHOLD",
132 [VP8E_SET_TOKEN_PARTITIONS] = "VP8E_SET_TOKEN_PARTITIONS",
133 [VP8E_SET_ARNR_MAXFRAMES] = "VP8E_SET_ARNR_MAXFRAMES",
134 [VP8E_SET_ARNR_STRENGTH] = "VP8E_SET_ARNR_STRENGTH",
135 [VP8E_SET_ARNR_TYPE] = "VP8E_SET_ARNR_TYPE",
136 [VP8E_SET_TUNING] = "VP8E_SET_TUNING",
137 [VP8E_SET_CQ_LEVEL] = "VP8E_SET_CQ_LEVEL",
138 [VP8E_SET_MAX_INTRA_BITRATE_PCT] = "VP8E_SET_MAX_INTRA_BITRATE_PCT",
139 [VP8E_SET_SHARPNESS] = "VP8E_SET_SHARPNESS",
140 #if CONFIG_LIBVPX_VP9_ENCODER
141 [VP9E_SET_LOSSLESS] = "VP9E_SET_LOSSLESS",
142 [VP9E_SET_TILE_COLUMNS] = "VP9E_SET_TILE_COLUMNS",
143 [VP9E_SET_TILE_ROWS] = "VP9E_SET_TILE_ROWS",
144 [VP9E_SET_FRAME_PARALLEL_DECODING] = "VP9E_SET_FRAME_PARALLEL_DECODING",
145 [VP9E_SET_AQ_MODE] = "VP9E_SET_AQ_MODE",
146 [VP9E_SET_COLOR_SPACE] = "VP9E_SET_COLOR_SPACE",
147 #if VPX_ENCODER_ABI_VERSION >= 11
148 [VP9E_SET_COLOR_RANGE] = "VP9E_SET_COLOR_RANGE",
150 #if VPX_ENCODER_ABI_VERSION >= 12
151 [VP9E_SET_TARGET_LEVEL] = "VP9E_SET_TARGET_LEVEL",
152 [VP9E_GET_LEVEL] = "VP9E_GET_LEVEL",
154 #ifdef VPX_CTRL_VP9E_SET_ROW_MT
155 [VP9E_SET_ROW_MT] = "VP9E_SET_ROW_MT",
157 #ifdef VPX_CTRL_VP9E_SET_TUNE_CONTENT
158 [VP9E_SET_TUNE_CONTENT] = "VP9E_SET_TUNE_CONTENT",
160 #ifdef VPX_CTRL_VP9E_SET_TPL
161 [VP9E_SET_TPL] = "VP9E_SET_TPL",
166 static av_cold void log_encoder_error(AVCodecContext *avctx, const char *desc)
168 VPxContext *ctx = avctx->priv_data;
169 const char *error = vpx_codec_error(&ctx->encoder);
170 const char *detail = vpx_codec_error_detail(&ctx->encoder);
172 av_log(avctx, AV_LOG_ERROR, "%s: %s\n", desc, error);
174 av_log(avctx, AV_LOG_ERROR, " Additional information: %s\n", detail);
177 static av_cold void dump_enc_cfg(AVCodecContext *avctx,
178 const struct vpx_codec_enc_cfg *cfg)
181 int level = AV_LOG_DEBUG;
184 av_log(avctx, level, "vpx_codec_enc_cfg\n");
185 av_log(avctx, level, "generic settings\n"
186 " %*s%u\n %*s%u\n %*s%u\n %*s%u\n %*s%u\n"
187 #if CONFIG_LIBVPX_VP9_ENCODER
190 " %*s{%u/%u}\n %*s%u\n %*s%d\n %*s%u\n",
191 width, "g_usage:", cfg->g_usage,
192 width, "g_threads:", cfg->g_threads,
193 width, "g_profile:", cfg->g_profile,
194 width, "g_w:", cfg->g_w,
195 width, "g_h:", cfg->g_h,
196 #if CONFIG_LIBVPX_VP9_ENCODER
197 width, "g_bit_depth:", cfg->g_bit_depth,
198 width, "g_input_bit_depth:", cfg->g_input_bit_depth,
200 width, "g_timebase:", cfg->g_timebase.num, cfg->g_timebase.den,
201 width, "g_error_resilient:", cfg->g_error_resilient,
202 width, "g_pass:", cfg->g_pass,
203 width, "g_lag_in_frames:", cfg->g_lag_in_frames);
204 av_log(avctx, level, "rate control settings\n"
205 " %*s%u\n %*s%u\n %*s%u\n %*s%u\n"
206 " %*s%d\n %*s%p(%"SIZE_SPECIFIER")\n %*s%u\n",
207 width, "rc_dropframe_thresh:", cfg->rc_dropframe_thresh,
208 width, "rc_resize_allowed:", cfg->rc_resize_allowed,
209 width, "rc_resize_up_thresh:", cfg->rc_resize_up_thresh,
210 width, "rc_resize_down_thresh:", cfg->rc_resize_down_thresh,
211 width, "rc_end_usage:", cfg->rc_end_usage,
212 width, "rc_twopass_stats_in:", cfg->rc_twopass_stats_in.buf, cfg->rc_twopass_stats_in.sz,
213 width, "rc_target_bitrate:", cfg->rc_target_bitrate);
214 av_log(avctx, level, "quantizer settings\n"
216 width, "rc_min_quantizer:", cfg->rc_min_quantizer,
217 width, "rc_max_quantizer:", cfg->rc_max_quantizer);
218 av_log(avctx, level, "bitrate tolerance\n"
220 width, "rc_undershoot_pct:", cfg->rc_undershoot_pct,
221 width, "rc_overshoot_pct:", cfg->rc_overshoot_pct);
222 av_log(avctx, level, "temporal layering settings\n"
223 " %*s%u\n", width, "ts_number_layers:", cfg->ts_number_layers);
225 "\n %*s", width, "ts_target_bitrate:");
226 for (i = 0; i < VPX_TS_MAX_LAYERS; i++)
227 av_log(avctx, level, "%u ", cfg->ts_target_bitrate[i]);
228 av_log(avctx, level, "\n");
230 "\n %*s", width, "ts_rate_decimator:");
231 for (i = 0; i < VPX_TS_MAX_LAYERS; i++)
232 av_log(avctx, level, "%u ", cfg->ts_rate_decimator[i]);
233 av_log(avctx, level, "\n");
235 "\n %*s%u\n", width, "ts_periodicity:", cfg->ts_periodicity);
237 "\n %*s", width, "ts_layer_id:");
238 for (i = 0; i < VPX_TS_MAX_PERIODICITY; i++)
239 av_log(avctx, level, "%u ", cfg->ts_layer_id[i]);
240 av_log(avctx, level, "\n");
241 av_log(avctx, level, "decoder buffer model\n"
242 " %*s%u\n %*s%u\n %*s%u\n",
243 width, "rc_buf_sz:", cfg->rc_buf_sz,
244 width, "rc_buf_initial_sz:", cfg->rc_buf_initial_sz,
245 width, "rc_buf_optimal_sz:", cfg->rc_buf_optimal_sz);
246 av_log(avctx, level, "2 pass rate control settings\n"
247 " %*s%u\n %*s%u\n %*s%u\n",
248 width, "rc_2pass_vbr_bias_pct:", cfg->rc_2pass_vbr_bias_pct,
249 width, "rc_2pass_vbr_minsection_pct:", cfg->rc_2pass_vbr_minsection_pct,
250 width, "rc_2pass_vbr_maxsection_pct:", cfg->rc_2pass_vbr_maxsection_pct);
251 #if VPX_ENCODER_ABI_VERSION >= 14
252 av_log(avctx, level, " %*s%u\n",
253 width, "rc_2pass_vbr_corpus_complexity:", cfg->rc_2pass_vbr_corpus_complexity);
255 av_log(avctx, level, "keyframing settings\n"
256 " %*s%d\n %*s%u\n %*s%u\n",
257 width, "kf_mode:", cfg->kf_mode,
258 width, "kf_min_dist:", cfg->kf_min_dist,
259 width, "kf_max_dist:", cfg->kf_max_dist);
260 av_log(avctx, level, "\n");
263 static void coded_frame_add(void *list, struct FrameListData *cx_frame)
265 struct FrameListData **p = list;
270 cx_frame->next = NULL;
273 static av_cold void free_coded_frame(struct FrameListData *cx_frame)
275 av_freep(&cx_frame->buf);
276 if (cx_frame->buf_alpha)
277 av_freep(&cx_frame->buf_alpha);
281 static av_cold void free_frame_list(struct FrameListData *list)
283 struct FrameListData *p = list;
292 static av_cold int codecctl_int(AVCodecContext *avctx,
293 enum vp8e_enc_control_id id, int val)
295 VPxContext *ctx = avctx->priv_data;
300 snprintf(buf, sizeof(buf), "%s:", ctlidstr[id]);
301 av_log(avctx, AV_LOG_DEBUG, " %*s%d\n", width, buf, val);
303 res = vpx_codec_control(&ctx->encoder, id, val);
304 if (res != VPX_CODEC_OK) {
305 snprintf(buf, sizeof(buf), "Failed to set %s codec control",
307 log_encoder_error(avctx, buf);
310 return res == VPX_CODEC_OK ? 0 : AVERROR(EINVAL);
313 #if VPX_ENCODER_ABI_VERSION >= 12
314 static av_cold int codecctl_intp(AVCodecContext *avctx,
315 enum vp8e_enc_control_id id, int *val)
317 VPxContext *ctx = avctx->priv_data;
322 snprintf(buf, sizeof(buf), "%s:", ctlidstr[id]);
323 av_log(avctx, AV_LOG_DEBUG, " %*s%d\n", width, buf, *val);
325 res = vpx_codec_control(&ctx->encoder, id, val);
326 if (res != VPX_CODEC_OK) {
327 snprintf(buf, sizeof(buf), "Failed to set %s codec control",
329 log_encoder_error(avctx, buf);
332 return res == VPX_CODEC_OK ? 0 : AVERROR(EINVAL);
336 static av_cold int vpx_free(AVCodecContext *avctx)
338 VPxContext *ctx = avctx->priv_data;
340 #if VPX_ENCODER_ABI_VERSION >= 12
341 if (avctx->codec_id == AV_CODEC_ID_VP9 && ctx->level >= 0 &&
342 !(avctx->flags & AV_CODEC_FLAG_PASS1)) {
344 if (!codecctl_intp(avctx, VP9E_GET_LEVEL, &level_out))
345 av_log(avctx, AV_LOG_INFO, "Encoded level %.1f\n", level_out * 0.1);
349 vpx_codec_destroy(&ctx->encoder);
351 vpx_codec_destroy(&ctx->encoder_alpha);
352 av_freep(&ctx->rawimg_alpha.planes[VPX_PLANE_U]);
353 av_freep(&ctx->rawimg_alpha.planes[VPX_PLANE_V]);
355 av_freep(&ctx->twopass_stats.buf);
356 av_freep(&avctx->stats_out);
357 free_frame_list(ctx->coded_frame_list);
361 static void vp8_ts_parse_int_array(int *dest, char *value, size_t value_len, int max_entries)
364 char *saveptr = NULL;
365 char *token = av_strtok(value, ",", &saveptr);
367 while (token && dest_idx < max_entries) {
368 dest[dest_idx++] = strtoul(token, NULL, 10);
369 token = av_strtok(NULL, ",", &saveptr);
373 static int vp8_ts_param_parse(struct vpx_codec_enc_cfg *enccfg, char *key, char *value)
375 size_t value_len = strlen(value);
380 if (!strcmp(key, "ts_number_layers"))
381 enccfg->ts_number_layers = strtoul(value, &value, 10);
382 else if (!strcmp(key, "ts_target_bitrate"))
383 vp8_ts_parse_int_array(enccfg->ts_target_bitrate, value, value_len, VPX_TS_MAX_LAYERS);
384 else if (!strcmp(key, "ts_rate_decimator"))
385 vp8_ts_parse_int_array(enccfg->ts_rate_decimator, value, value_len, VPX_TS_MAX_LAYERS);
386 else if (!strcmp(key, "ts_periodicity"))
387 enccfg->ts_periodicity = strtoul(value, &value, 10);
388 else if (!strcmp(key, "ts_layer_id"))
389 vp8_ts_parse_int_array(enccfg->ts_layer_id, value, value_len, VPX_TS_MAX_PERIODICITY);
394 #if CONFIG_LIBVPX_VP9_ENCODER
395 static int set_pix_fmt(AVCodecContext *avctx, vpx_codec_caps_t codec_caps,
396 struct vpx_codec_enc_cfg *enccfg, vpx_codec_flags_t *flags,
397 vpx_img_fmt_t *img_fmt)
399 VPxContext av_unused *ctx = avctx->priv_data;
400 enccfg->g_bit_depth = enccfg->g_input_bit_depth = 8;
401 switch (avctx->pix_fmt) {
402 case AV_PIX_FMT_YUV420P:
403 case AV_PIX_FMT_YUVA420P:
404 enccfg->g_profile = 0;
405 *img_fmt = VPX_IMG_FMT_I420;
407 case AV_PIX_FMT_YUV422P:
408 enccfg->g_profile = 1;
409 *img_fmt = VPX_IMG_FMT_I422;
411 case AV_PIX_FMT_YUV440P:
412 enccfg->g_profile = 1;
413 *img_fmt = VPX_IMG_FMT_I440;
415 case AV_PIX_FMT_GBRP:
416 ctx->vpx_cs = VPX_CS_SRGB;
417 case AV_PIX_FMT_YUV444P:
418 enccfg->g_profile = 1;
419 *img_fmt = VPX_IMG_FMT_I444;
421 case AV_PIX_FMT_YUV420P10:
422 case AV_PIX_FMT_YUV420P12:
423 if (codec_caps & VPX_CODEC_CAP_HIGHBITDEPTH) {
424 enccfg->g_bit_depth = enccfg->g_input_bit_depth =
425 avctx->pix_fmt == AV_PIX_FMT_YUV420P10 ? 10 : 12;
426 enccfg->g_profile = 2;
427 *img_fmt = VPX_IMG_FMT_I42016;
428 *flags |= VPX_CODEC_USE_HIGHBITDEPTH;
432 case AV_PIX_FMT_YUV422P10:
433 case AV_PIX_FMT_YUV422P12:
434 if (codec_caps & VPX_CODEC_CAP_HIGHBITDEPTH) {
435 enccfg->g_bit_depth = enccfg->g_input_bit_depth =
436 avctx->pix_fmt == AV_PIX_FMT_YUV422P10 ? 10 : 12;
437 enccfg->g_profile = 3;
438 *img_fmt = VPX_IMG_FMT_I42216;
439 *flags |= VPX_CODEC_USE_HIGHBITDEPTH;
443 case AV_PIX_FMT_YUV440P10:
444 case AV_PIX_FMT_YUV440P12:
445 if (codec_caps & VPX_CODEC_CAP_HIGHBITDEPTH) {
446 enccfg->g_bit_depth = enccfg->g_input_bit_depth =
447 avctx->pix_fmt == AV_PIX_FMT_YUV440P10 ? 10 : 12;
448 enccfg->g_profile = 3;
449 *img_fmt = VPX_IMG_FMT_I44016;
450 *flags |= VPX_CODEC_USE_HIGHBITDEPTH;
454 case AV_PIX_FMT_GBRP10:
455 case AV_PIX_FMT_GBRP12:
456 ctx->vpx_cs = VPX_CS_SRGB;
457 case AV_PIX_FMT_YUV444P10:
458 case AV_PIX_FMT_YUV444P12:
459 if (codec_caps & VPX_CODEC_CAP_HIGHBITDEPTH) {
460 enccfg->g_bit_depth = enccfg->g_input_bit_depth =
461 avctx->pix_fmt == AV_PIX_FMT_YUV444P10 ||
462 avctx->pix_fmt == AV_PIX_FMT_GBRP10 ? 10 : 12;
463 enccfg->g_profile = 3;
464 *img_fmt = VPX_IMG_FMT_I44416;
465 *flags |= VPX_CODEC_USE_HIGHBITDEPTH;
472 av_log(avctx, AV_LOG_ERROR, "Unsupported pixel format.\n");
473 return AVERROR_INVALIDDATA;
476 static void set_colorspace(AVCodecContext *avctx)
478 enum vpx_color_space vpx_cs;
479 VPxContext *ctx = avctx->priv_data;
482 vpx_cs = ctx->vpx_cs;
484 switch (avctx->colorspace) {
485 case AVCOL_SPC_RGB: vpx_cs = VPX_CS_SRGB; break;
486 case AVCOL_SPC_BT709: vpx_cs = VPX_CS_BT_709; break;
487 case AVCOL_SPC_UNSPECIFIED: vpx_cs = VPX_CS_UNKNOWN; break;
488 case AVCOL_SPC_RESERVED: vpx_cs = VPX_CS_RESERVED; break;
489 case AVCOL_SPC_BT470BG: vpx_cs = VPX_CS_BT_601; break;
490 case AVCOL_SPC_SMPTE170M: vpx_cs = VPX_CS_SMPTE_170; break;
491 case AVCOL_SPC_SMPTE240M: vpx_cs = VPX_CS_SMPTE_240; break;
492 case AVCOL_SPC_BT2020_NCL: vpx_cs = VPX_CS_BT_2020; break;
494 av_log(avctx, AV_LOG_WARNING, "Unsupported colorspace (%d)\n",
499 codecctl_int(avctx, VP9E_SET_COLOR_SPACE, vpx_cs);
502 #if VPX_ENCODER_ABI_VERSION >= 11
503 static void set_color_range(AVCodecContext *avctx)
505 enum vpx_color_range vpx_cr;
506 switch (avctx->color_range) {
507 case AVCOL_RANGE_UNSPECIFIED:
508 case AVCOL_RANGE_MPEG: vpx_cr = VPX_CR_STUDIO_RANGE; break;
509 case AVCOL_RANGE_JPEG: vpx_cr = VPX_CR_FULL_RANGE; break;
511 av_log(avctx, AV_LOG_WARNING, "Unsupported color range (%d)\n",
516 codecctl_int(avctx, VP9E_SET_COLOR_RANGE, vpx_cr);
522 * Set the target bitrate to VPX library default. Also set CRF to 32 if needed.
524 static void set_vp8_defaults(AVCodecContext *avctx,
525 struct vpx_codec_enc_cfg *enccfg)
527 VPxContext *ctx = avctx->priv_data;
528 av_assert0(!avctx->bit_rate);
529 avctx->bit_rate = enccfg->rc_target_bitrate * 1000;
530 if (enccfg->rc_end_usage == VPX_CQ) {
531 av_log(avctx, AV_LOG_WARNING,
532 "Bitrate not specified for constrained quality mode, using default of %dkbit/sec\n",
533 enccfg->rc_target_bitrate);
535 enccfg->rc_end_usage = VPX_CQ;
537 av_log(avctx, AV_LOG_WARNING,
538 "Neither bitrate nor constrained quality specified, using default CRF of %d and bitrate of %dkbit/sec\n",
539 ctx->crf, enccfg->rc_target_bitrate);
544 #if CONFIG_LIBVPX_VP9_ENCODER
546 * Keep the target bitrate at 0 to engage constant quality mode. If CRF is not
549 static void set_vp9_defaults(AVCodecContext *avctx,
550 struct vpx_codec_enc_cfg *enccfg)
552 VPxContext *ctx = avctx->priv_data;
553 av_assert0(!avctx->bit_rate);
554 if (enccfg->rc_end_usage != VPX_Q && ctx->lossless < 0) {
555 enccfg->rc_end_usage = VPX_Q;
557 av_log(avctx, AV_LOG_WARNING,
558 "Neither bitrate nor constrained quality specified, using default CRF of %d\n",
565 * Called when the bitrate is not set. It sets appropriate default values for
568 static void set_vpx_defaults(AVCodecContext *avctx,
569 struct vpx_codec_enc_cfg *enccfg)
571 av_assert0(!avctx->bit_rate);
572 #if CONFIG_LIBVPX_VP9_ENCODER
573 if (avctx->codec_id == AV_CODEC_ID_VP9) {
574 set_vp9_defaults(avctx, enccfg);
578 set_vp8_defaults(avctx, enccfg);
581 static av_cold int vpx_init(AVCodecContext *avctx,
582 const struct vpx_codec_iface *iface)
584 VPxContext *ctx = avctx->priv_data;
585 struct vpx_codec_enc_cfg enccfg = { 0 };
586 struct vpx_codec_enc_cfg enccfg_alpha;
587 vpx_codec_flags_t flags = (avctx->flags & AV_CODEC_FLAG_PSNR) ? VPX_CODEC_USE_PSNR : 0;
588 AVCPBProperties *cpb_props;
590 vpx_img_fmt_t img_fmt = VPX_IMG_FMT_I420;
591 #if CONFIG_LIBVPX_VP9_ENCODER
592 vpx_codec_caps_t codec_caps = vpx_codec_get_caps(iface);
595 av_log(avctx, AV_LOG_INFO, "%s\n", vpx_codec_version_str());
596 av_log(avctx, AV_LOG_VERBOSE, "%s\n", vpx_codec_build_config());
598 if (avctx->pix_fmt == AV_PIX_FMT_YUVA420P)
601 if ((res = vpx_codec_enc_config_default(iface, &enccfg, 0)) != VPX_CODEC_OK) {
602 av_log(avctx, AV_LOG_ERROR, "Failed to get config: %s\n",
603 vpx_codec_err_to_string(res));
604 return AVERROR(EINVAL);
607 #if CONFIG_LIBVPX_VP9_ENCODER
608 if (avctx->codec_id == AV_CODEC_ID_VP9) {
609 if (set_pix_fmt(avctx, codec_caps, &enccfg, &flags, &img_fmt))
610 return AVERROR(EINVAL);
615 if(avctx->rc_max_rate || avctx->rc_buffer_size || avctx->rc_initial_buffer_occupancy) {
616 av_log( avctx, AV_LOG_ERROR, "Rate control parameters set without a bitrate\n");
617 return AVERROR(EINVAL);
620 dump_enc_cfg(avctx, &enccfg);
622 enccfg.g_w = avctx->width;
623 enccfg.g_h = avctx->height;
624 enccfg.g_timebase.num = avctx->time_base.num;
625 enccfg.g_timebase.den = avctx->time_base.den;
627 FFMIN(avctx->thread_count ? avctx->thread_count : av_cpu_count(), 16);
628 enccfg.g_lag_in_frames= ctx->lag_in_frames;
630 if (avctx->flags & AV_CODEC_FLAG_PASS1)
631 enccfg.g_pass = VPX_RC_FIRST_PASS;
632 else if (avctx->flags & AV_CODEC_FLAG_PASS2)
633 enccfg.g_pass = VPX_RC_LAST_PASS;
635 enccfg.g_pass = VPX_RC_ONE_PASS;
637 if (avctx->rc_min_rate == avctx->rc_max_rate &&
638 avctx->rc_min_rate == avctx->bit_rate && avctx->bit_rate) {
639 enccfg.rc_end_usage = VPX_CBR;
640 } else if (ctx->crf >= 0) {
641 enccfg.rc_end_usage = VPX_CQ;
642 #if CONFIG_LIBVPX_VP9_ENCODER
643 if (!avctx->bit_rate && avctx->codec_id == AV_CODEC_ID_VP9)
644 enccfg.rc_end_usage = VPX_Q;
648 if (avctx->bit_rate) {
649 enccfg.rc_target_bitrate = av_rescale_rnd(avctx->bit_rate, 1, 1000,
652 // Set bitrate to default value. Also sets CRF to default if needed.
653 set_vpx_defaults(avctx, &enccfg);
656 if (avctx->codec_id == AV_CODEC_ID_VP9 && ctx->lossless == 1) {
657 enccfg.rc_min_quantizer =
658 enccfg.rc_max_quantizer = 0;
660 if (avctx->qmin >= 0)
661 enccfg.rc_min_quantizer = avctx->qmin;
662 if (avctx->qmax >= 0)
663 enccfg.rc_max_quantizer = avctx->qmax;
666 if (enccfg.rc_end_usage == VPX_CQ
667 #if CONFIG_LIBVPX_VP9_ENCODER
668 || enccfg.rc_end_usage == VPX_Q
671 if (ctx->crf < enccfg.rc_min_quantizer || ctx->crf > enccfg.rc_max_quantizer) {
672 av_log(avctx, AV_LOG_ERROR,
673 "CQ level %d must be between minimum and maximum quantizer value (%d-%d)\n",
674 ctx->crf, enccfg.rc_min_quantizer, enccfg.rc_max_quantizer);
675 return AVERROR(EINVAL);
679 #if FF_API_PRIVATE_OPT
680 FF_DISABLE_DEPRECATION_WARNINGS
681 if (avctx->frame_skip_threshold)
682 ctx->drop_threshold = avctx->frame_skip_threshold;
683 FF_ENABLE_DEPRECATION_WARNINGS
685 enccfg.rc_dropframe_thresh = ctx->drop_threshold;
687 //0-100 (0 => CBR, 100 => VBR)
688 enccfg.rc_2pass_vbr_bias_pct = lrint(avctx->qcompress * 100);
690 enccfg.rc_2pass_vbr_minsection_pct =
691 avctx->rc_min_rate * 100LL / avctx->bit_rate;
692 if (avctx->rc_max_rate)
693 enccfg.rc_2pass_vbr_maxsection_pct =
694 avctx->rc_max_rate * 100LL / avctx->bit_rate;
695 #if CONFIG_LIBVPX_VP9_ENCODER
696 if (avctx->codec_id == AV_CODEC_ID_VP9) {
697 #if VPX_ENCODER_ABI_VERSION >= 14
698 if (ctx->corpus_complexity >= 0)
699 enccfg.rc_2pass_vbr_corpus_complexity = ctx->corpus_complexity;
704 if (avctx->rc_buffer_size)
706 avctx->rc_buffer_size * 1000LL / avctx->bit_rate;
707 if (avctx->rc_initial_buffer_occupancy)
708 enccfg.rc_buf_initial_sz =
709 avctx->rc_initial_buffer_occupancy * 1000LL / avctx->bit_rate;
710 enccfg.rc_buf_optimal_sz = enccfg.rc_buf_sz * 5 / 6;
711 if (ctx->rc_undershoot_pct >= 0)
712 enccfg.rc_undershoot_pct = ctx->rc_undershoot_pct;
713 if (ctx->rc_overshoot_pct >= 0)
714 enccfg.rc_overshoot_pct = ctx->rc_overshoot_pct;
716 //_enc_init() will balk if kf_min_dist differs from max w/VPX_KF_AUTO
717 if (avctx->keyint_min >= 0 && avctx->keyint_min == avctx->gop_size)
718 enccfg.kf_min_dist = avctx->keyint_min;
719 if (avctx->gop_size >= 0)
720 enccfg.kf_max_dist = avctx->gop_size;
722 if (enccfg.g_pass == VPX_RC_FIRST_PASS)
723 enccfg.g_lag_in_frames = 0;
724 else if (enccfg.g_pass == VPX_RC_LAST_PASS) {
725 int decode_size, ret;
727 if (!avctx->stats_in) {
728 av_log(avctx, AV_LOG_ERROR, "No stats file for second pass\n");
729 return AVERROR_INVALIDDATA;
732 ctx->twopass_stats.sz = strlen(avctx->stats_in) * 3 / 4;
733 ret = av_reallocp(&ctx->twopass_stats.buf, ctx->twopass_stats.sz);
735 av_log(avctx, AV_LOG_ERROR,
736 "Stat buffer alloc (%"SIZE_SPECIFIER" bytes) failed\n",
737 ctx->twopass_stats.sz);
738 ctx->twopass_stats.sz = 0;
741 decode_size = av_base64_decode(ctx->twopass_stats.buf, avctx->stats_in,
742 ctx->twopass_stats.sz);
743 if (decode_size < 0) {
744 av_log(avctx, AV_LOG_ERROR, "Stat buffer decode failed\n");
745 return AVERROR_INVALIDDATA;
748 ctx->twopass_stats.sz = decode_size;
749 enccfg.rc_twopass_stats_in = ctx->twopass_stats;
752 /* 0-3: For non-zero values the encoder increasingly optimizes for reduced
753 complexity playback on low powered devices at the expense of encode
755 if (avctx->profile != FF_PROFILE_UNKNOWN)
756 enccfg.g_profile = avctx->profile;
758 enccfg.g_error_resilient = ctx->error_resilient || ctx->flags & VP8F_ERROR_RESILIENT;
760 if (CONFIG_LIBVPX_VP8_ENCODER && avctx->codec_id == AV_CODEC_ID_VP8) {
761 AVDictionaryEntry* en = NULL;
762 while ((en = av_dict_get(ctx->vp8_ts_parameters, "", en, AV_DICT_IGNORE_SUFFIX))) {
763 if (vp8_ts_param_parse(&enccfg, en->key, en->value) < 0)
764 av_log(avctx, AV_LOG_WARNING,
765 "Error parsing option '%s = %s'.\n",
770 dump_enc_cfg(avctx, &enccfg);
771 /* Construct Encoder Context */
772 res = vpx_codec_enc_init(&ctx->encoder, iface, &enccfg, flags);
773 if (res != VPX_CODEC_OK) {
774 log_encoder_error(avctx, "Failed to initialize encoder");
775 return AVERROR(EINVAL);
779 enccfg_alpha = enccfg;
780 res = vpx_codec_enc_init(&ctx->encoder_alpha, iface, &enccfg_alpha, flags);
781 if (res != VPX_CODEC_OK) {
782 log_encoder_error(avctx, "Failed to initialize alpha encoder");
783 return AVERROR(EINVAL);
787 //codec control failures are currently treated only as warnings
788 av_log(avctx, AV_LOG_DEBUG, "vpx_codec_control\n");
789 codecctl_int(avctx, VP8E_SET_CPUUSED, ctx->cpu_used);
790 if (ctx->flags & VP8F_AUTO_ALT_REF)
791 ctx->auto_alt_ref = 1;
792 if (ctx->auto_alt_ref >= 0)
793 codecctl_int(avctx, VP8E_SET_ENABLEAUTOALTREF,
794 avctx->codec_id == AV_CODEC_ID_VP8 ? !!ctx->auto_alt_ref : ctx->auto_alt_ref);
795 if (ctx->arnr_max_frames >= 0)
796 codecctl_int(avctx, VP8E_SET_ARNR_MAXFRAMES, ctx->arnr_max_frames);
797 if (ctx->arnr_strength >= 0)
798 codecctl_int(avctx, VP8E_SET_ARNR_STRENGTH, ctx->arnr_strength);
799 if (ctx->arnr_type >= 0)
800 codecctl_int(avctx, VP8E_SET_ARNR_TYPE, ctx->arnr_type);
802 codecctl_int(avctx, VP8E_SET_TUNING, ctx->tune);
804 if (ctx->auto_alt_ref && ctx->is_alpha && avctx->codec_id == AV_CODEC_ID_VP8) {
805 av_log(avctx, AV_LOG_ERROR, "Transparency encoding with auto_alt_ref does not work\n");
806 return AVERROR(EINVAL);
809 if (ctx->sharpness >= 0)
810 codecctl_int(avctx, VP8E_SET_SHARPNESS, ctx->sharpness);
812 if (CONFIG_LIBVPX_VP8_ENCODER && avctx->codec_id == AV_CODEC_ID_VP8) {
813 #if FF_API_PRIVATE_OPT
814 FF_DISABLE_DEPRECATION_WARNINGS
815 if (avctx->noise_reduction)
816 ctx->noise_sensitivity = avctx->noise_reduction;
817 FF_ENABLE_DEPRECATION_WARNINGS
819 codecctl_int(avctx, VP8E_SET_NOISE_SENSITIVITY, ctx->noise_sensitivity);
820 codecctl_int(avctx, VP8E_SET_TOKEN_PARTITIONS, av_log2(avctx->slices));
822 codecctl_int(avctx, VP8E_SET_STATIC_THRESHOLD, ctx->static_thresh);
824 codecctl_int(avctx, VP8E_SET_CQ_LEVEL, ctx->crf);
825 if (ctx->max_intra_rate >= 0)
826 codecctl_int(avctx, VP8E_SET_MAX_INTRA_BITRATE_PCT, ctx->max_intra_rate);
828 #if CONFIG_LIBVPX_VP9_ENCODER
829 if (avctx->codec_id == AV_CODEC_ID_VP9) {
830 if (ctx->lossless >= 0)
831 codecctl_int(avctx, VP9E_SET_LOSSLESS, ctx->lossless);
832 if (ctx->tile_columns >= 0)
833 codecctl_int(avctx, VP9E_SET_TILE_COLUMNS, ctx->tile_columns);
834 if (ctx->tile_rows >= 0)
835 codecctl_int(avctx, VP9E_SET_TILE_ROWS, ctx->tile_rows);
836 if (ctx->frame_parallel >= 0)
837 codecctl_int(avctx, VP9E_SET_FRAME_PARALLEL_DECODING, ctx->frame_parallel);
838 if (ctx->aq_mode >= 0)
839 codecctl_int(avctx, VP9E_SET_AQ_MODE, ctx->aq_mode);
840 set_colorspace(avctx);
841 #if VPX_ENCODER_ABI_VERSION >= 11
842 set_color_range(avctx);
844 #if VPX_ENCODER_ABI_VERSION >= 12
845 codecctl_int(avctx, VP9E_SET_TARGET_LEVEL, ctx->level < 0 ? 255 : lrint(ctx->level * 10));
847 #ifdef VPX_CTRL_VP9E_SET_ROW_MT
848 if (ctx->row_mt >= 0)
849 codecctl_int(avctx, VP9E_SET_ROW_MT, ctx->row_mt);
851 #ifdef VPX_CTRL_VP9E_SET_TUNE_CONTENT
852 if (ctx->tune_content >= 0)
853 codecctl_int(avctx, VP9E_SET_TUNE_CONTENT, ctx->tune_content);
855 #ifdef VPX_CTRL_VP9E_SET_TPL
856 if (ctx->tpl_model >= 0)
857 codecctl_int(avctx, VP9E_SET_TPL, ctx->tpl_model);
862 av_log(avctx, AV_LOG_DEBUG, "Using deadline: %d\n", ctx->deadline);
864 //provide dummy value to initialize wrapper, values will be updated each _encode()
865 vpx_img_wrap(&ctx->rawimg, img_fmt, avctx->width, avctx->height, 1,
867 #if CONFIG_LIBVPX_VP9_ENCODER
868 if (avctx->codec_id == AV_CODEC_ID_VP9 && (codec_caps & VPX_CODEC_CAP_HIGHBITDEPTH))
869 ctx->rawimg.bit_depth = enccfg.g_bit_depth;
872 cpb_props = ff_add_cpb_side_data(avctx);
874 return AVERROR(ENOMEM);
876 if (enccfg.rc_end_usage == VPX_CBR ||
877 enccfg.g_pass != VPX_RC_ONE_PASS) {
878 cpb_props->max_bitrate = avctx->rc_max_rate;
879 cpb_props->min_bitrate = avctx->rc_min_rate;
880 cpb_props->avg_bitrate = avctx->bit_rate;
882 cpb_props->buffer_size = avctx->rc_buffer_size;
887 static inline void cx_pktcpy(struct FrameListData *dst,
888 const struct vpx_codec_cx_pkt *src,
889 const struct vpx_codec_cx_pkt *src_alpha,
892 dst->pts = src->data.frame.pts;
893 dst->duration = src->data.frame.duration;
894 dst->flags = src->data.frame.flags;
895 dst->sz = src->data.frame.sz;
896 dst->buf = src->data.frame.buf;
898 /* For alt-ref frame, don't store PSNR or increment frame_number */
899 if (!(dst->flags & VPX_FRAME_IS_INVISIBLE)) {
900 dst->frame_number = ++ctx->frame_number;
901 dst->have_sse = ctx->have_sse;
903 /* associate last-seen SSE to the frame. */
904 /* Transfers ownership from ctx to dst. */
905 /* WARNING! This makes the assumption that PSNR_PKT comes
906 just before the frame it refers to! */
907 memcpy(dst->sse, ctx->sse, sizeof(dst->sse));
911 dst->frame_number = -1; /* sanity marker */
914 dst->buf_alpha = src_alpha->data.frame.buf;
915 dst->sz_alpha = src_alpha->data.frame.sz;
917 dst->buf_alpha = NULL;
923 * Store coded frame information in format suitable for return from encode2().
925 * Write information from @a cx_frame to @a pkt
926 * @return packet data size on success
927 * @return a negative AVERROR on error
929 static int storeframe(AVCodecContext *avctx, struct FrameListData *cx_frame,
932 int ret = ff_alloc_packet2(avctx, pkt, cx_frame->sz, 0);
936 memcpy(pkt->data, cx_frame->buf, pkt->size);
937 pkt->pts = pkt->dts = cx_frame->pts;
938 #if FF_API_CODED_FRAME
939 FF_DISABLE_DEPRECATION_WARNINGS
940 avctx->coded_frame->pts = cx_frame->pts;
941 avctx->coded_frame->key_frame = !!(cx_frame->flags & VPX_FRAME_IS_KEY);
942 FF_ENABLE_DEPRECATION_WARNINGS
945 if (!!(cx_frame->flags & VPX_FRAME_IS_KEY)) {
946 pict_type = AV_PICTURE_TYPE_I;
947 #if FF_API_CODED_FRAME
948 FF_DISABLE_DEPRECATION_WARNINGS
949 avctx->coded_frame->pict_type = pict_type;
950 FF_ENABLE_DEPRECATION_WARNINGS
952 pkt->flags |= AV_PKT_FLAG_KEY;
954 pict_type = AV_PICTURE_TYPE_P;
955 #if FF_API_CODED_FRAME
956 FF_DISABLE_DEPRECATION_WARNINGS
957 avctx->coded_frame->pict_type = pict_type;
958 FF_ENABLE_DEPRECATION_WARNINGS
962 ff_side_data_set_encoder_stats(pkt, 0, cx_frame->sse + 1,
963 cx_frame->have_sse ? 3 : 0, pict_type);
965 if (cx_frame->have_sse) {
967 /* Beware of the Y/U/V/all order! */
968 #if FF_API_CODED_FRAME
969 FF_DISABLE_DEPRECATION_WARNINGS
970 avctx->coded_frame->error[0] = cx_frame->sse[1];
971 avctx->coded_frame->error[1] = cx_frame->sse[2];
972 avctx->coded_frame->error[2] = cx_frame->sse[3];
973 avctx->coded_frame->error[3] = 0; // alpha
974 FF_ENABLE_DEPRECATION_WARNINGS
976 for (i = 0; i < 3; ++i) {
977 avctx->error[i] += cx_frame->sse[i + 1];
979 cx_frame->have_sse = 0;
981 if (cx_frame->sz_alpha > 0) {
982 side_data = av_packet_new_side_data(pkt,
983 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
984 cx_frame->sz_alpha + 8);
986 av_packet_unref(pkt);
988 return AVERROR(ENOMEM);
990 AV_WB64(side_data, 1);
991 memcpy(side_data + 8, cx_frame->buf_alpha, cx_frame->sz_alpha);
1000 * Queue multiple output frames from the encoder, returning the front-most.
1001 * In cases where vpx_codec_get_cx_data() returns more than 1 frame append
1002 * the frame queue. Return the head frame if available.
1003 * @return Stored frame size
1004 * @return AVERROR(EINVAL) on output size error
1005 * @return AVERROR(ENOMEM) on coded frame queue data allocation error
1007 static int queue_frames(AVCodecContext *avctx, AVPacket *pkt_out)
1009 VPxContext *ctx = avctx->priv_data;
1010 const struct vpx_codec_cx_pkt *pkt;
1011 const struct vpx_codec_cx_pkt *pkt_alpha = NULL;
1012 const void *iter = NULL;
1013 const void *iter_alpha = NULL;
1016 if (ctx->coded_frame_list) {
1017 struct FrameListData *cx_frame = ctx->coded_frame_list;
1018 /* return the leading frame if we've already begun queueing */
1019 size = storeframe(avctx, cx_frame, pkt_out);
1022 ctx->coded_frame_list = cx_frame->next;
1023 free_coded_frame(cx_frame);
1026 /* consume all available output from the encoder before returning. buffers
1027 are only good through the next vpx_codec call */
1028 while ((pkt = vpx_codec_get_cx_data(&ctx->encoder, &iter)) &&
1030 (pkt_alpha = vpx_codec_get_cx_data(&ctx->encoder_alpha, &iter_alpha)))) {
1031 switch (pkt->kind) {
1032 case VPX_CODEC_CX_FRAME_PKT:
1034 struct FrameListData cx_frame;
1036 /* avoid storing the frame when the list is empty and we haven't yet
1037 provided a frame for output */
1038 av_assert0(!ctx->coded_frame_list);
1039 cx_pktcpy(&cx_frame, pkt, pkt_alpha, ctx);
1040 size = storeframe(avctx, &cx_frame, pkt_out);
1044 struct FrameListData *cx_frame = av_malloc(sizeof(*cx_frame));
1047 av_log(avctx, AV_LOG_ERROR,
1048 "Frame queue element alloc failed\n");
1049 return AVERROR(ENOMEM);
1051 cx_pktcpy(cx_frame, pkt, pkt_alpha, ctx);
1052 cx_frame->buf = av_malloc(cx_frame->sz);
1054 if (!cx_frame->buf) {
1055 av_log(avctx, AV_LOG_ERROR,
1056 "Data buffer alloc (%"SIZE_SPECIFIER" bytes) failed\n",
1058 av_freep(&cx_frame);
1059 return AVERROR(ENOMEM);
1061 memcpy(cx_frame->buf, pkt->data.frame.buf, pkt->data.frame.sz);
1062 if (ctx->is_alpha) {
1063 cx_frame->buf_alpha = av_malloc(cx_frame->sz_alpha);
1064 if (!cx_frame->buf_alpha) {
1065 av_log(avctx, AV_LOG_ERROR,
1066 "Data buffer alloc (%"SIZE_SPECIFIER" bytes) failed\n",
1067 cx_frame->sz_alpha);
1069 return AVERROR(ENOMEM);
1071 memcpy(cx_frame->buf_alpha, pkt_alpha->data.frame.buf, pkt_alpha->data.frame.sz);
1073 coded_frame_add(&ctx->coded_frame_list, cx_frame);
1076 case VPX_CODEC_STATS_PKT: {
1077 struct vpx_fixed_buf *stats = &ctx->twopass_stats;
1079 if ((err = av_reallocp(&stats->buf,
1081 pkt->data.twopass_stats.sz)) < 0) {
1083 av_log(avctx, AV_LOG_ERROR, "Stat buffer realloc failed\n");
1086 memcpy((uint8_t*)stats->buf + stats->sz,
1087 pkt->data.twopass_stats.buf, pkt->data.twopass_stats.sz);
1088 stats->sz += pkt->data.twopass_stats.sz;
1091 case VPX_CODEC_PSNR_PKT:
1092 av_assert0(!ctx->have_sse);
1093 ctx->sse[0] = pkt->data.psnr.sse[0];
1094 ctx->sse[1] = pkt->data.psnr.sse[1];
1095 ctx->sse[2] = pkt->data.psnr.sse[2];
1096 ctx->sse[3] = pkt->data.psnr.sse[3];
1099 case VPX_CODEC_CUSTOM_PKT:
1100 //ignore unsupported/unrecognized packet types
1108 static int set_roi_map(AVCodecContext *avctx, const AVFrameSideData *sd, int frame_width, int frame_height,
1109 vpx_roi_map_t *roi_map, int block_size, int segment_cnt)
1112 * range of vpx_roi_map_t.delta_q[i] is [-63, 63]
1114 #define MAX_DELTA_Q 63
1116 const AVRegionOfInterest *roi = NULL;
1121 /* record the mapping from delta_q to "segment id + 1" in segment_mapping[].
1122 * the range of delta_q is [-MAX_DELTA_Q, MAX_DELTA_Q],
1123 * and its corresponding array index is [0, 2 * MAX_DELTA_Q],
1124 * and so the length of the mapping array is 2 * MAX_DELTA_Q + 1.
1125 * "segment id + 1", so we can say there's no mapping if the value of array element is zero.
1127 int segment_mapping[2 * MAX_DELTA_Q + 1] = { 0 };
1129 memset(roi_map, 0, sizeof(*roi_map));
1131 /* segment id 0 in roi_map is reserved for the areas not covered by AVRegionOfInterest.
1132 * segment id 0 in roi_map is also for the areas with AVRegionOfInterest.qoffset near 0.
1133 * (delta_q of segment id 0 is 0).
1135 segment_mapping[MAX_DELTA_Q] = 1;
1138 roi = (const AVRegionOfInterest*)sd->data;
1139 self_size = roi->self_size;
1140 if (!self_size || sd->size % self_size) {
1141 av_log(avctx, AV_LOG_ERROR, "Invalid AVRegionOfInterest.self_size.\n");
1142 return AVERROR(EINVAL);
1144 nb_rois = sd->size / self_size;
1146 /* This list must be iterated from zero because regions are
1147 * defined in order of decreasing importance. So discard less
1148 * important areas if they exceed the segment count.
1150 for (int i = 0; i < nb_rois; i++) {
1154 roi = (const AVRegionOfInterest*)(sd->data + self_size * i);
1155 if (!roi->qoffset.den) {
1156 av_log(avctx, AV_LOG_ERROR, "AVRegionOfInterest.qoffset.den must not be zero.\n");
1157 return AVERROR(EINVAL);
1160 delta_q = (int)(roi->qoffset.num * 1.0f / roi->qoffset.den * MAX_DELTA_Q);
1161 delta_q = av_clip(delta_q, -MAX_DELTA_Q, MAX_DELTA_Q);
1163 mapping_index = delta_q + MAX_DELTA_Q;
1164 if (!segment_mapping[mapping_index]) {
1165 if (segment_id == segment_cnt) {
1166 av_log(avctx, AV_LOG_WARNING,
1167 "ROI only supports %d segments (and segment 0 is reserved for non-ROIs), skipping the left ones.\n",
1172 segment_mapping[mapping_index] = segment_id + 1;
1173 roi_map->delta_q[segment_id] = delta_q;
1178 roi_map->rows = (frame_height + block_size - 1) / block_size;
1179 roi_map->cols = (frame_width + block_size - 1) / block_size;
1180 roi_map->roi_map = av_mallocz_array(roi_map->rows * roi_map->cols, sizeof(*roi_map->roi_map));
1181 if (!roi_map->roi_map) {
1182 av_log(avctx, AV_LOG_ERROR, "roi_map alloc failed.\n");
1183 return AVERROR(ENOMEM);
1186 /* This list must be iterated in reverse, so for the case that
1187 * two regions are overlapping, the more important area takes effect.
1189 for (int i = nb_rois - 1; i >= 0; i--) {
1192 int starty, endy, startx, endx;
1194 roi = (const AVRegionOfInterest*)(sd->data + self_size * i);
1196 starty = av_clip(roi->top / block_size, 0, roi_map->rows);
1197 endy = av_clip((roi->bottom + block_size - 1) / block_size, 0, roi_map->rows);
1198 startx = av_clip(roi->left / block_size, 0, roi_map->cols);
1199 endx = av_clip((roi->right + block_size - 1) / block_size, 0, roi_map->cols);
1201 delta_q = (int)(roi->qoffset.num * 1.0f / roi->qoffset.den * MAX_DELTA_Q);
1202 delta_q = av_clip(delta_q, -MAX_DELTA_Q, MAX_DELTA_Q);
1204 mapping_value = segment_mapping[delta_q + MAX_DELTA_Q];
1205 if (mapping_value) {
1206 for (int y = starty; y < endy; y++)
1207 for (int x = startx; x < endx; x++)
1208 roi_map->roi_map[x + y * roi_map->cols] = mapping_value - 1;
1215 static int vp9_encode_set_roi(AVCodecContext *avctx, int frame_width, int frame_height, const AVFrameSideData *sd)
1217 VPxContext *ctx = avctx->priv_data;
1219 #ifdef VPX_CTRL_VP9E_SET_ROI_MAP
1220 int version = vpx_codec_version();
1221 int major = VPX_VERSION_MAJOR(version);
1222 int minor = VPX_VERSION_MINOR(version);
1223 int patch = VPX_VERSION_PATCH(version);
1225 if (major > 1 || (major == 1 && minor > 8) || (major == 1 && minor == 8 && patch >= 1)) {
1226 vpx_roi_map_t roi_map;
1227 const int segment_cnt = 8;
1228 const int block_size = 8;
1231 if (ctx->aq_mode > 0 || ctx->cpu_used < 5 || ctx->deadline != VPX_DL_REALTIME) {
1232 if (!ctx->roi_warned) {
1233 ctx->roi_warned = 1;
1234 av_log(avctx, AV_LOG_WARNING, "ROI is only enabled when aq_mode is 0, cpu_used >= 5 "
1235 "and deadline is REALTIME, so skipping ROI.\n");
1236 return AVERROR(EINVAL);
1240 ret = set_roi_map(avctx, sd, frame_width, frame_height, &roi_map, block_size, segment_cnt);
1242 log_encoder_error(avctx, "Failed to set_roi_map.\n");
1246 memset(roi_map.ref_frame, -1, sizeof(roi_map.ref_frame));
1248 if (vpx_codec_control(&ctx->encoder, VP9E_SET_ROI_MAP, &roi_map)) {
1249 log_encoder_error(avctx, "Failed to set VP9E_SET_ROI_MAP codec control.\n");
1250 ret = AVERROR_INVALIDDATA;
1252 av_freep(&roi_map.roi_map);
1257 if (!ctx->roi_warned) {
1258 ctx->roi_warned = 1;
1259 av_log(avctx, AV_LOG_WARNING, "ROI is not supported, please upgrade libvpx to version >= 1.8.1. "
1260 "You may need to rebuild ffmpeg.\n");
1265 static int vp8_encode_set_roi(AVCodecContext *avctx, int frame_width, int frame_height, const AVFrameSideData *sd)
1267 vpx_roi_map_t roi_map;
1268 const int segment_cnt = 4;
1269 const int block_size = 16;
1270 VPxContext *ctx = avctx->priv_data;
1272 int ret = set_roi_map(avctx, sd, frame_width, frame_height, &roi_map, block_size, segment_cnt);
1274 log_encoder_error(avctx, "Failed to set_roi_map.\n");
1278 if (vpx_codec_control(&ctx->encoder, VP8E_SET_ROI_MAP, &roi_map)) {
1279 log_encoder_error(avctx, "Failed to set VP8E_SET_ROI_MAP codec control.\n");
1280 ret = AVERROR_INVALIDDATA;
1283 av_freep(&roi_map.roi_map);
1287 static int realloc_alpha_uv(AVCodecContext *avctx, int width, int height)
1289 VPxContext *ctx = avctx->priv_data;
1290 struct vpx_image *rawimg_alpha = &ctx->rawimg_alpha;
1291 unsigned char **planes = rawimg_alpha->planes;
1292 int *stride = rawimg_alpha->stride;
1294 if (!planes[VPX_PLANE_U] ||
1295 !planes[VPX_PLANE_V] ||
1296 width != (int)rawimg_alpha->d_w ||
1297 height != (int)rawimg_alpha->d_h) {
1298 av_freep(&planes[VPX_PLANE_U]);
1299 av_freep(&planes[VPX_PLANE_V]);
1301 vpx_img_wrap(rawimg_alpha, VPX_IMG_FMT_I420, width, height, 1,
1303 planes[VPX_PLANE_U] = av_malloc_array(stride[VPX_PLANE_U], height);
1304 planes[VPX_PLANE_V] = av_malloc_array(stride[VPX_PLANE_V], height);
1305 if (!planes[VPX_PLANE_U] || !planes[VPX_PLANE_V])
1306 return AVERROR(ENOMEM);
1308 memset(planes[VPX_PLANE_U], 0x80, stride[VPX_PLANE_U] * height);
1309 memset(planes[VPX_PLANE_V], 0x80, stride[VPX_PLANE_V] * height);
1315 static int vpx_encode(AVCodecContext *avctx, AVPacket *pkt,
1316 const AVFrame *frame, int *got_packet)
1318 VPxContext *ctx = avctx->priv_data;
1319 struct vpx_image *rawimg = NULL;
1320 struct vpx_image *rawimg_alpha = NULL;
1321 int64_t timestamp = 0;
1322 int res, coded_size;
1323 vpx_enc_frame_flags_t flags = 0;
1326 const AVFrameSideData *sd = av_frame_get_side_data(frame, AV_FRAME_DATA_REGIONS_OF_INTEREST);
1327 rawimg = &ctx->rawimg;
1328 rawimg->planes[VPX_PLANE_Y] = frame->data[0];
1329 rawimg->planes[VPX_PLANE_U] = frame->data[1];
1330 rawimg->planes[VPX_PLANE_V] = frame->data[2];
1331 rawimg->stride[VPX_PLANE_Y] = frame->linesize[0];
1332 rawimg->stride[VPX_PLANE_U] = frame->linesize[1];
1333 rawimg->stride[VPX_PLANE_V] = frame->linesize[2];
1334 if (ctx->is_alpha) {
1335 rawimg_alpha = &ctx->rawimg_alpha;
1336 res = realloc_alpha_uv(avctx, frame->width, frame->height);
1339 rawimg_alpha->planes[VPX_PLANE_Y] = frame->data[3];
1340 rawimg_alpha->stride[VPX_PLANE_Y] = frame->linesize[3];
1342 timestamp = frame->pts;
1343 #if VPX_IMAGE_ABI_VERSION >= 4
1344 switch (frame->color_range) {
1345 case AVCOL_RANGE_MPEG:
1346 rawimg->range = VPX_CR_STUDIO_RANGE;
1348 case AVCOL_RANGE_JPEG:
1349 rawimg->range = VPX_CR_FULL_RANGE;
1353 if (frame->pict_type == AV_PICTURE_TYPE_I)
1354 flags |= VPX_EFLAG_FORCE_KF;
1355 if (CONFIG_LIBVPX_VP8_ENCODER && avctx->codec_id == AV_CODEC_ID_VP8 && frame->metadata) {
1356 AVDictionaryEntry* en = av_dict_get(frame->metadata, "vp8-flags", NULL, 0);
1358 flags |= strtoul(en->value, NULL, 10);
1363 if (avctx->codec_id == AV_CODEC_ID_VP8) {
1364 vp8_encode_set_roi(avctx, frame->width, frame->height, sd);
1366 vp9_encode_set_roi(avctx, frame->width, frame->height, sd);
1371 res = vpx_codec_encode(&ctx->encoder, rawimg, timestamp,
1372 avctx->ticks_per_frame, flags, ctx->deadline);
1373 if (res != VPX_CODEC_OK) {
1374 log_encoder_error(avctx, "Error encoding frame");
1375 return AVERROR_INVALIDDATA;
1378 if (ctx->is_alpha) {
1379 res = vpx_codec_encode(&ctx->encoder_alpha, rawimg_alpha, timestamp,
1380 avctx->ticks_per_frame, flags, ctx->deadline);
1381 if (res != VPX_CODEC_OK) {
1382 log_encoder_error(avctx, "Error encoding alpha frame");
1383 return AVERROR_INVALIDDATA;
1387 coded_size = queue_frames(avctx, pkt);
1389 if (!frame && avctx->flags & AV_CODEC_FLAG_PASS1) {
1390 unsigned int b64_size = AV_BASE64_SIZE(ctx->twopass_stats.sz);
1392 avctx->stats_out = av_malloc(b64_size);
1393 if (!avctx->stats_out) {
1394 av_log(avctx, AV_LOG_ERROR, "Stat buffer alloc (%d bytes) failed\n",
1396 return AVERROR(ENOMEM);
1398 av_base64_encode(avctx->stats_out, b64_size, ctx->twopass_stats.buf,
1399 ctx->twopass_stats.sz);
1402 *got_packet = !!coded_size;
1406 #define OFFSET(x) offsetof(VPxContext, x)
1407 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
1409 #define COMMON_OPTIONS \
1410 { "lag-in-frames", "Number of frames to look ahead for " \
1411 "alternate reference frame selection", OFFSET(lag_in_frames), AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX, VE}, \
1412 { "arnr-maxframes", "altref noise reduction max frame count", OFFSET(arnr_max_frames), AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX, VE}, \
1413 { "arnr-strength", "altref noise reduction filter strength", OFFSET(arnr_strength), AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX, VE}, \
1414 { "arnr-type", "altref noise reduction filter type", OFFSET(arnr_type), AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX, VE, "arnr_type"}, \
1415 { "backward", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = 1}, 0, 0, VE, "arnr_type" }, \
1416 { "forward", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = 2}, 0, 0, VE, "arnr_type" }, \
1417 { "centered", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = 3}, 0, 0, VE, "arnr_type" }, \
1418 { "tune", "Tune the encoding to a specific scenario", OFFSET(tune), AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX, VE, "tune"}, \
1419 { "psnr", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = VP8_TUNE_PSNR}, 0, 0, VE, "tune"}, \
1420 { "ssim", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = VP8_TUNE_SSIM}, 0, 0, VE, "tune"}, \
1421 { "deadline", "Time to spend encoding, in microseconds.", OFFSET(deadline), AV_OPT_TYPE_INT, {.i64 = VPX_DL_GOOD_QUALITY}, INT_MIN, INT_MAX, VE, "quality"}, \
1422 { "best", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = VPX_DL_BEST_QUALITY}, 0, 0, VE, "quality"}, \
1423 { "good", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = VPX_DL_GOOD_QUALITY}, 0, 0, VE, "quality"}, \
1424 { "realtime", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = VPX_DL_REALTIME}, 0, 0, VE, "quality"}, \
1425 { "error-resilient", "Error resilience configuration", OFFSET(error_resilient), AV_OPT_TYPE_FLAGS, {.i64 = 0}, INT_MIN, INT_MAX, VE, "er"}, \
1426 { "max-intra-rate", "Maximum I-frame bitrate (pct) 0=unlimited", OFFSET(max_intra_rate), AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX, VE}, \
1427 { "default", "Improve resiliency against losses of whole frames", 0, AV_OPT_TYPE_CONST, {.i64 = VPX_ERROR_RESILIENT_DEFAULT}, 0, 0, VE, "er"}, \
1428 { "partitions", "The frame partitions are independently decodable " \
1429 "by the bool decoder, meaning that partitions can be decoded even " \
1430 "though earlier partitions have been lost. Note that intra prediction" \
1431 " is still done over the partition boundary.", 0, AV_OPT_TYPE_CONST, {.i64 = VPX_ERROR_RESILIENT_PARTITIONS}, 0, 0, VE, "er"}, \
1432 { "crf", "Select the quality for constant quality mode", offsetof(VPxContext, crf), AV_OPT_TYPE_INT, {.i64 = -1}, -1, 63, VE }, \
1433 { "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 }, \
1434 { "drop-threshold", "Frame drop threshold", offsetof(VPxContext, drop_threshold), AV_OPT_TYPE_INT, {.i64 = 0 }, INT_MIN, INT_MAX, VE }, \
1435 { "noise-sensitivity", "Noise sensitivity", OFFSET(noise_sensitivity), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, 4, VE}, \
1436 { "undershoot-pct", "Datarate undershoot (min) target (%)", OFFSET(rc_undershoot_pct), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 100, VE }, \
1437 { "overshoot-pct", "Datarate overshoot (max) target (%)", OFFSET(rc_overshoot_pct), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 1000, VE }, \
1439 #define LEGACY_OPTIONS \
1440 {"speed", "", offsetof(VPxContext, cpu_used), AV_OPT_TYPE_INT, {.i64 = 1}, -16, 16, VE}, \
1441 {"quality", "", offsetof(VPxContext, deadline), AV_OPT_TYPE_INT, {.i64 = VPX_DL_GOOD_QUALITY}, INT_MIN, INT_MAX, VE, "quality"}, \
1442 {"vp8flags", "", offsetof(VPxContext, flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, UINT_MAX, VE, "flags"}, \
1443 {"error_resilient", "enable error resilience", 0, AV_OPT_TYPE_CONST, {.i64 = VP8F_ERROR_RESILIENT}, INT_MIN, INT_MAX, VE, "flags"}, \
1444 {"altref", "enable use of alternate reference frames (VP8/2-pass only)", 0, AV_OPT_TYPE_CONST, {.i64 = VP8F_AUTO_ALT_REF}, INT_MIN, INT_MAX, VE, "flags"}, \
1445 {"arnr_max_frames", "altref noise reduction max frame count", offsetof(VPxContext, arnr_max_frames), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 15, VE}, \
1446 {"arnr_strength", "altref noise reduction filter strength", offsetof(VPxContext, arnr_strength), AV_OPT_TYPE_INT, {.i64 = 3}, 0, 6, VE}, \
1447 {"arnr_type", "altref noise reduction filter type", offsetof(VPxContext, arnr_type), AV_OPT_TYPE_INT, {.i64 = 3}, 1, 3, VE}, \
1448 {"rc_lookahead", "Number of frames to look ahead for alternate reference frame selection", offsetof(VPxContext, lag_in_frames), AV_OPT_TYPE_INT, {.i64 = 25}, 0, 25, VE}, \
1449 {"sharpness", "Increase sharpness at the expense of lower PSNR", offsetof(VPxContext, sharpness), AV_OPT_TYPE_INT, {.i64 = -1}, -1, 7, VE},
1451 #if CONFIG_LIBVPX_VP8_ENCODER
1452 static const AVOption vp8_options[] = {
1454 { "auto-alt-ref", "Enable use of alternate reference "
1455 "frames (2-pass only)", OFFSET(auto_alt_ref), AV_OPT_TYPE_INT, {.i64 = -1}, -1, 2, VE},
1456 { "cpu-used", "Quality/Speed ratio modifier", OFFSET(cpu_used), AV_OPT_TYPE_INT, {.i64 = 1}, -16, 16, VE},
1457 { "ts-parameters", "Temporal scaling configuration using a "
1458 ":-separated list of key=value parameters", OFFSET(vp8_ts_parameters), AV_OPT_TYPE_DICT, {.str=NULL}, 0, 0, VE},
1464 #if CONFIG_LIBVPX_VP9_ENCODER
1465 static const AVOption vp9_options[] = {
1467 { "auto-alt-ref", "Enable use of alternate reference "
1468 "frames (2-pass only)", OFFSET(auto_alt_ref), AV_OPT_TYPE_INT, {.i64 = -1}, -1, 6, VE},
1469 { "cpu-used", "Quality/Speed ratio modifier", OFFSET(cpu_used), AV_OPT_TYPE_INT, {.i64 = 1}, -8, 8, VE},
1470 { "lossless", "Lossless mode", OFFSET(lossless), AV_OPT_TYPE_INT, {.i64 = -1}, -1, 1, VE},
1471 { "tile-columns", "Number of tile columns to use, log2", OFFSET(tile_columns), AV_OPT_TYPE_INT, {.i64 = -1}, -1, 6, VE},
1472 { "tile-rows", "Number of tile rows to use, log2", OFFSET(tile_rows), AV_OPT_TYPE_INT, {.i64 = -1}, -1, 2, VE},
1473 { "frame-parallel", "Enable frame parallel decodability features", OFFSET(frame_parallel), AV_OPT_TYPE_BOOL,{.i64 = -1}, -1, 1, VE},
1474 #if VPX_ENCODER_ABI_VERSION >= 12
1475 { "aq-mode", "adaptive quantization mode", OFFSET(aq_mode), AV_OPT_TYPE_INT, {.i64 = -1}, -1, 4, VE, "aq_mode"},
1477 { "aq-mode", "adaptive quantization mode", OFFSET(aq_mode), AV_OPT_TYPE_INT, {.i64 = -1}, -1, 3, VE, "aq_mode"},
1479 { "none", "Aq not used", 0, AV_OPT_TYPE_CONST, {.i64 = 0}, 0, 0, VE, "aq_mode" },
1480 { "variance", "Variance based Aq", 0, AV_OPT_TYPE_CONST, {.i64 = 1}, 0, 0, VE, "aq_mode" },
1481 { "complexity", "Complexity based Aq", 0, AV_OPT_TYPE_CONST, {.i64 = 2}, 0, 0, VE, "aq_mode" },
1482 { "cyclic", "Cyclic Refresh Aq", 0, AV_OPT_TYPE_CONST, {.i64 = 3}, 0, 0, VE, "aq_mode" },
1483 #if VPX_ENCODER_ABI_VERSION >= 12
1484 { "equator360", "360 video Aq", 0, AV_OPT_TYPE_CONST, {.i64 = 4}, 0, 0, VE, "aq_mode" },
1485 {"level", "Specify level", OFFSET(level), AV_OPT_TYPE_FLOAT, {.dbl=-1}, -1, 6.2, VE},
1487 #ifdef VPX_CTRL_VP9E_SET_ROW_MT
1488 {"row-mt", "Row based multi-threading", OFFSET(row_mt), AV_OPT_TYPE_BOOL, {.i64 = -1}, -1, 1, VE},
1490 #ifdef VPX_CTRL_VP9E_SET_TUNE_CONTENT
1491 #if VPX_ENCODER_ABI_VERSION >= 14
1492 { "tune-content", "Tune content type", OFFSET(tune_content), AV_OPT_TYPE_INT, {.i64 = -1}, -1, 2, VE, "tune_content" },
1494 { "tune-content", "Tune content type", OFFSET(tune_content), AV_OPT_TYPE_INT, {.i64 = -1}, -1, 1, VE, "tune_content" },
1496 { "default", "Regular video content", 0, AV_OPT_TYPE_CONST, {.i64 = 0}, 0, 0, VE, "tune_content" },
1497 { "screen", "Screen capture content", 0, AV_OPT_TYPE_CONST, {.i64 = 1}, 0, 0, VE, "tune_content" },
1498 #if VPX_ENCODER_ABI_VERSION >= 14
1499 { "film", "Film content; improves grain retention", 0, AV_OPT_TYPE_CONST, {.i64 = 2}, 0, 0, VE, "tune_content" },
1502 #if VPX_ENCODER_ABI_VERSION >= 14
1503 { "corpus-complexity", "corpus vbr complexity midpoint", OFFSET(corpus_complexity), AV_OPT_TYPE_INT, {.i64 = -1}, -1, 10000, VE },
1505 #ifdef VPX_CTRL_VP9E_SET_TPL
1506 { "enable-tpl", "Enable temporal dependency model", OFFSET(tpl_model), AV_OPT_TYPE_BOOL, {.i64 = -1}, -1, 1, VE },
1513 #undef COMMON_OPTIONS
1514 #undef LEGACY_OPTIONS
1516 static const AVCodecDefault defaults[] = {
1521 { "keyint_min", "-1" },
1525 #if CONFIG_LIBVPX_VP8_ENCODER
1526 static av_cold int vp8_init(AVCodecContext *avctx)
1528 return vpx_init(avctx, vpx_codec_vp8_cx());
1531 static const AVClass class_vp8 = {
1532 .class_name = "libvpx-vp8 encoder",
1533 .item_name = av_default_item_name,
1534 .option = vp8_options,
1535 .version = LIBAVUTIL_VERSION_INT,
1538 AVCodec ff_libvpx_vp8_encoder = {
1540 .long_name = NULL_IF_CONFIG_SMALL("libvpx VP8"),
1541 .type = AVMEDIA_TYPE_VIDEO,
1542 .id = AV_CODEC_ID_VP8,
1543 .priv_data_size = sizeof(VPxContext),
1545 .encode2 = vpx_encode,
1547 .capabilities = AV_CODEC_CAP_DELAY | AV_CODEC_CAP_AUTO_THREADS,
1548 .pix_fmts = (const enum AVPixelFormat[]){ AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUVA420P, AV_PIX_FMT_NONE },
1549 .priv_class = &class_vp8,
1550 .defaults = defaults,
1551 .wrapper_name = "libvpx",
1553 #endif /* CONFIG_LIBVPX_VP8_ENCODER */
1555 #if CONFIG_LIBVPX_VP9_ENCODER
1556 static av_cold int vp9_init(AVCodecContext *avctx)
1558 return vpx_init(avctx, vpx_codec_vp9_cx());
1561 static const AVClass class_vp9 = {
1562 .class_name = "libvpx-vp9 encoder",
1563 .item_name = av_default_item_name,
1564 .option = vp9_options,
1565 .version = LIBAVUTIL_VERSION_INT,
1568 AVCodec ff_libvpx_vp9_encoder = {
1569 .name = "libvpx-vp9",
1570 .long_name = NULL_IF_CONFIG_SMALL("libvpx VP9"),
1571 .type = AVMEDIA_TYPE_VIDEO,
1572 .id = AV_CODEC_ID_VP9,
1573 .priv_data_size = sizeof(VPxContext),
1575 .encode2 = vpx_encode,
1577 .capabilities = AV_CODEC_CAP_DELAY | AV_CODEC_CAP_AUTO_THREADS,
1578 .profiles = NULL_IF_CONFIG_SMALL(ff_vp9_profiles),
1579 .priv_class = &class_vp9,
1580 .defaults = defaults,
1581 .init_static_data = ff_vp9_init_static,
1582 .wrapper_name = "libvpx",
1584 #endif /* CONFIG_LIBVPX_VP9_ENCODER */