Fix encoder range check for frame width and height
[libvpx.git] / vp8 / vp8_cx_iface.c
blob39b1e5e19c2ce791d6b82b5bb174a8ee00d2f990
1 /*
2 * Copyright (c) 2010 The WebM project authors. All Rights Reserved.
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
12 #include "vpx/vpx_codec.h"
13 #include "vpx/internal/vpx_codec_internal.h"
14 #include "vpx_version.h"
15 #include "vp8/encoder/onyx_int.h"
16 #include "vpx/vp8e.h"
17 #include "vp8/encoder/firstpass.h"
18 #include "vp8/common/onyx.h"
19 #include <stdlib.h>
20 #include <string.h>
22 /* This value is a sentinel for determining whether the user has set a mode
23 * directly through the deprecated VP8E_SET_ENCODING_MODE control.
25 #define NO_MODE_SET 255
27 struct vp8_extracfg
29 struct vpx_codec_pkt_list *pkt_list;
30 vp8e_encoding_mode encoding_mode; /** best, good, realtime */
31 int cpu_used; /** available cpu percentage in 1/16*/
32 unsigned int enable_auto_alt_ref; /** if encoder decides to uses alternate reference frame */
33 unsigned int noise_sensitivity;
34 unsigned int Sharpness;
35 unsigned int static_thresh;
36 unsigned int token_partitions;
37 unsigned int arnr_max_frames; /* alt_ref Noise Reduction Max Frame Count */
38 unsigned int arnr_strength; /* alt_ref Noise Reduction Strength */
39 unsigned int arnr_type; /* alt_ref filter type */
40 vp8e_tuning tuning;
41 unsigned int cq_level; /* constrained quality level */
45 struct extraconfig_map
47 int usage;
48 struct vp8_extracfg cfg;
51 static const struct extraconfig_map extracfg_map[] =
56 NULL,
57 #if !(CONFIG_REALTIME_ONLY)
58 VP8_BEST_QUALITY_ENCODING, /* Encoding Mode */
59 0, /* cpu_used */
60 #else
61 VP8_REAL_TIME_ENCODING, /* Encoding Mode */
62 4, /* cpu_used */
63 #endif
64 0, /* enable_auto_alt_ref */
65 0, /* noise_sensitivity */
66 0, /* Sharpness */
67 0, /* static_thresh */
68 VP8_ONE_TOKENPARTITION, /* token_partitions */
69 0, /* arnr_max_frames */
70 3, /* arnr_strength */
71 3, /* arnr_type*/
72 0, /* tuning*/
73 10, /* cq_level */
78 struct vpx_codec_alg_priv
80 vpx_codec_priv_t base;
81 vpx_codec_enc_cfg_t cfg;
82 struct vp8_extracfg vp8_cfg;
83 VP8_CONFIG oxcf;
84 VP8_PTR cpi;
85 unsigned char *cx_data;
86 unsigned int cx_data_sz;
87 vpx_image_t preview_img;
88 unsigned int next_frame_flag;
89 vp8_postproc_cfg_t preview_ppcfg;
90 vpx_codec_pkt_list_decl(64) pkt_list; // changed to accomendate the maximum number of lagged frames allowed
91 int deprecated_mode;
92 unsigned int fixed_kf_cntr;
96 static vpx_codec_err_t
97 update_error_state(vpx_codec_alg_priv_t *ctx,
98 const struct vpx_internal_error_info *error)
100 vpx_codec_err_t res;
102 if ((res = error->error_code))
103 ctx->base.err_detail = error->has_detail
104 ? error->detail
105 : NULL;
107 return res;
111 #undef ERROR
112 #define ERROR(str) do {\
113 ctx->base.err_detail = str;\
114 return VPX_CODEC_INVALID_PARAM;\
115 } while(0)
117 #define RANGE_CHECK(p,memb,lo,hi) do {\
118 if(!(((p)->memb == lo || (p)->memb > (lo)) && (p)->memb <= hi)) \
119 ERROR(#memb " out of range ["#lo".."#hi"]");\
120 } while(0)
122 #define RANGE_CHECK_HI(p,memb,hi) do {\
123 if(!((p)->memb <= (hi))) \
124 ERROR(#memb " out of range [.."#hi"]");\
125 } while(0)
127 #define RANGE_CHECK_LO(p,memb,lo) do {\
128 if(!((p)->memb >= (lo))) \
129 ERROR(#memb " out of range ["#lo"..]");\
130 } while(0)
132 #define RANGE_CHECK_BOOL(p,memb) do {\
133 if(!!((p)->memb) != (p)->memb) ERROR(#memb " expected boolean");\
134 } while(0)
136 static vpx_codec_err_t validate_config(vpx_codec_alg_priv_t *ctx,
137 const vpx_codec_enc_cfg_t *cfg,
138 const struct vp8_extracfg *vp8_cfg)
140 RANGE_CHECK(cfg, g_w, 1, 16383); /* 14 bits available */
141 RANGE_CHECK(cfg, g_h, 1, 16383); /* 14 bits available */
142 RANGE_CHECK(cfg, g_timebase.den, 1, 1000000000);
143 RANGE_CHECK(cfg, g_timebase.num, 1, cfg->g_timebase.den);
144 RANGE_CHECK_HI(cfg, g_profile, 3);
145 RANGE_CHECK_HI(cfg, rc_max_quantizer, 63);
146 RANGE_CHECK_HI(cfg, rc_min_quantizer, cfg->rc_max_quantizer);
147 RANGE_CHECK_HI(cfg, g_threads, 64);
148 #if !(CONFIG_REALTIME_ONLY)
149 RANGE_CHECK_HI(cfg, g_lag_in_frames, 25);
150 #else
151 RANGE_CHECK_HI(cfg, g_lag_in_frames, 0);
152 #endif
153 RANGE_CHECK(cfg, rc_end_usage, VPX_VBR, VPX_CQ);
154 RANGE_CHECK_HI(cfg, rc_undershoot_pct, 100);
155 RANGE_CHECK_HI(cfg, rc_2pass_vbr_bias_pct, 100);
156 RANGE_CHECK(cfg, kf_mode, VPX_KF_DISABLED, VPX_KF_AUTO);
157 //RANGE_CHECK_BOOL(cfg, g_delete_firstpassfile);
158 RANGE_CHECK_BOOL(cfg, rc_resize_allowed);
159 RANGE_CHECK_HI(cfg, rc_dropframe_thresh, 100);
160 RANGE_CHECK_HI(cfg, rc_resize_up_thresh, 100);
161 RANGE_CHECK_HI(cfg, rc_resize_down_thresh, 100);
162 #if !(CONFIG_REALTIME_ONLY)
163 RANGE_CHECK(cfg, g_pass, VPX_RC_ONE_PASS, VPX_RC_LAST_PASS);
164 #else
165 RANGE_CHECK(cfg, g_pass, VPX_RC_ONE_PASS, VPX_RC_ONE_PASS);
166 #endif
168 /* VP8 does not support a lower bound on the keyframe interval in
169 * automatic keyframe placement mode.
171 if (cfg->kf_mode != VPX_KF_DISABLED && cfg->kf_min_dist != cfg->kf_max_dist
172 && cfg->kf_min_dist > 0)
173 ERROR("kf_min_dist not supported in auto mode, use 0 "
174 "or kf_max_dist instead.");
176 RANGE_CHECK_BOOL(vp8_cfg, enable_auto_alt_ref);
177 #if !(CONFIG_REALTIME_ONLY)
178 RANGE_CHECK(vp8_cfg, encoding_mode, VP8_BEST_QUALITY_ENCODING, VP8_REAL_TIME_ENCODING);
179 RANGE_CHECK(vp8_cfg, cpu_used, -16, 16);
180 RANGE_CHECK_HI(vp8_cfg, noise_sensitivity, 6);
181 #else
182 RANGE_CHECK(vp8_cfg, encoding_mode, VP8_REAL_TIME_ENCODING, VP8_REAL_TIME_ENCODING);
184 if (!((vp8_cfg->cpu_used >= -16 && vp8_cfg->cpu_used <= -4) || (vp8_cfg->cpu_used >= 4 && vp8_cfg->cpu_used <= 16)))
185 ERROR("cpu_used out of range [-16..-4] or [4..16]");
187 RANGE_CHECK(vp8_cfg, noise_sensitivity, 0, 0);
188 #endif
190 RANGE_CHECK(vp8_cfg, token_partitions, VP8_ONE_TOKENPARTITION, VP8_EIGHT_TOKENPARTITION);
191 RANGE_CHECK_HI(vp8_cfg, Sharpness, 7);
192 RANGE_CHECK(vp8_cfg, arnr_max_frames, 0, 15);
193 RANGE_CHECK_HI(vp8_cfg, arnr_strength, 6);
194 RANGE_CHECK(vp8_cfg, arnr_type, 1, 3);
195 RANGE_CHECK(vp8_cfg, cq_level, 0, 63);
197 #if !(CONFIG_REALTIME_ONLY)
198 if (cfg->g_pass == VPX_RC_LAST_PASS)
200 size_t packet_sz = sizeof(FIRSTPASS_STATS);
201 int n_packets = cfg->rc_twopass_stats_in.sz / packet_sz;
202 FIRSTPASS_STATS *stats;
204 if (!cfg->rc_twopass_stats_in.buf)
205 ERROR("rc_twopass_stats_in.buf not set.");
207 if (cfg->rc_twopass_stats_in.sz % packet_sz)
208 ERROR("rc_twopass_stats_in.sz indicates truncated packet.");
210 if (cfg->rc_twopass_stats_in.sz < 2 * packet_sz)
211 ERROR("rc_twopass_stats_in requires at least two packets.");
213 stats = (void*)((char *)cfg->rc_twopass_stats_in.buf
214 + (n_packets - 1) * packet_sz);
216 if ((int)(stats->count + 0.5) != n_packets - 1)
217 ERROR("rc_twopass_stats_in missing EOS stats packet");
219 #endif
221 return VPX_CODEC_OK;
225 static vpx_codec_err_t validate_img(vpx_codec_alg_priv_t *ctx,
226 const vpx_image_t *img)
228 switch (img->fmt)
230 case VPX_IMG_FMT_YV12:
231 case VPX_IMG_FMT_I420:
232 case VPX_IMG_FMT_VPXI420:
233 case VPX_IMG_FMT_VPXYV12:
234 break;
235 default:
236 ERROR("Invalid image format. Only YV12 and I420 images are supported");
239 if ((img->d_w != ctx->cfg.g_w) || (img->d_h != ctx->cfg.g_h))
240 ERROR("Image size must match encoder init configuration size");
242 return VPX_CODEC_OK;
246 static vpx_codec_err_t set_vp8e_config(VP8_CONFIG *oxcf,
247 vpx_codec_enc_cfg_t cfg,
248 struct vp8_extracfg vp8_cfg)
250 oxcf->multi_threaded = cfg.g_threads;
251 oxcf->Version = cfg.g_profile;
253 oxcf->Width = cfg.g_w;
254 oxcf->Height = cfg.g_h;
255 /* guess a frame rate if out of whack, use 30 */
256 oxcf->frame_rate = (double)(cfg.g_timebase.den) / (double)(cfg.g_timebase.num);
258 if (oxcf->frame_rate > 180)
260 oxcf->frame_rate = 30;
263 oxcf->error_resilient_mode = cfg.g_error_resilient;
265 switch (cfg.g_pass)
267 case VPX_RC_ONE_PASS:
268 oxcf->Mode = MODE_BESTQUALITY;
269 break;
270 case VPX_RC_FIRST_PASS:
271 oxcf->Mode = MODE_FIRSTPASS;
272 break;
273 case VPX_RC_LAST_PASS:
274 oxcf->Mode = MODE_SECONDPASS_BEST;
275 break;
278 if (cfg.g_pass == VPX_RC_FIRST_PASS)
280 oxcf->allow_lag = 0;
281 oxcf->lag_in_frames = 0;
283 else
285 oxcf->allow_lag = (cfg.g_lag_in_frames) > 0;
286 oxcf->lag_in_frames = cfg.g_lag_in_frames;
289 oxcf->allow_df = (cfg.rc_dropframe_thresh > 0);
290 oxcf->drop_frames_water_mark = cfg.rc_dropframe_thresh;
292 oxcf->allow_spatial_resampling = cfg.rc_resize_allowed;
293 oxcf->resample_up_water_mark = cfg.rc_resize_up_thresh;
294 oxcf->resample_down_water_mark = cfg.rc_resize_down_thresh;
296 if (cfg.rc_end_usage == VPX_VBR)
298 oxcf->end_usage = USAGE_LOCAL_FILE_PLAYBACK;
300 else if (cfg.rc_end_usage == VPX_CBR)
302 oxcf->end_usage = USAGE_STREAM_FROM_SERVER;
304 else if (cfg.rc_end_usage == VPX_CQ)
306 oxcf->end_usage = USAGE_CONSTRAINED_QUALITY;
309 oxcf->target_bandwidth = cfg.rc_target_bitrate;
311 oxcf->best_allowed_q = cfg.rc_min_quantizer;
312 oxcf->worst_allowed_q = cfg.rc_max_quantizer;
313 oxcf->cq_level = vp8_cfg.cq_level;
314 oxcf->fixed_q = -1;
316 oxcf->under_shoot_pct = cfg.rc_undershoot_pct;
317 //oxcf->over_shoot_pct = cfg.rc_overshoot_pct;
319 oxcf->maximum_buffer_size = cfg.rc_buf_sz;
320 oxcf->starting_buffer_level = cfg.rc_buf_initial_sz;
321 oxcf->optimal_buffer_level = cfg.rc_buf_optimal_sz;
323 oxcf->two_pass_vbrbias = cfg.rc_2pass_vbr_bias_pct;
324 oxcf->two_pass_vbrmin_section = cfg.rc_2pass_vbr_minsection_pct;
325 oxcf->two_pass_vbrmax_section = cfg.rc_2pass_vbr_maxsection_pct;
327 oxcf->auto_key = cfg.kf_mode == VPX_KF_AUTO
328 && cfg.kf_min_dist != cfg.kf_max_dist;
329 //oxcf->kf_min_dist = cfg.kf_min_dis;
330 oxcf->key_freq = cfg.kf_max_dist;
332 //oxcf->delete_first_pass_file = cfg.g_delete_firstpassfile;
333 //strcpy(oxcf->first_pass_file, cfg.g_firstpass_file);
335 oxcf->cpu_used = vp8_cfg.cpu_used;
336 oxcf->encode_breakout = vp8_cfg.static_thresh;
337 oxcf->play_alternate = vp8_cfg.enable_auto_alt_ref;
338 oxcf->noise_sensitivity = vp8_cfg.noise_sensitivity;
339 oxcf->Sharpness = vp8_cfg.Sharpness;
340 oxcf->token_partitions = vp8_cfg.token_partitions;
342 oxcf->two_pass_stats_in = cfg.rc_twopass_stats_in;
343 oxcf->output_pkt_list = vp8_cfg.pkt_list;
345 oxcf->arnr_max_frames = vp8_cfg.arnr_max_frames;
346 oxcf->arnr_strength = vp8_cfg.arnr_strength;
347 oxcf->arnr_type = vp8_cfg.arnr_type;
349 oxcf->tuning = vp8_cfg.tuning;
352 printf("Current VP8 Settings: \n");
353 printf("target_bandwidth: %d\n", oxcf->target_bandwidth);
354 printf("noise_sensitivity: %d\n", oxcf->noise_sensitivity);
355 printf("Sharpness: %d\n", oxcf->Sharpness);
356 printf("cpu_used: %d\n", oxcf->cpu_used);
357 printf("Mode: %d\n", oxcf->Mode);
358 printf("delete_first_pass_file: %d\n", oxcf->delete_first_pass_file);
359 printf("auto_key: %d\n", oxcf->auto_key);
360 printf("key_freq: %d\n", oxcf->key_freq);
361 printf("end_usage: %d\n", oxcf->end_usage);
362 printf("under_shoot_pct: %d\n", oxcf->under_shoot_pct);
363 printf("starting_buffer_level: %d\n", oxcf->starting_buffer_level);
364 printf("optimal_buffer_level: %d\n", oxcf->optimal_buffer_level);
365 printf("maximum_buffer_size: %d\n", oxcf->maximum_buffer_size);
366 printf("fixed_q: %d\n", oxcf->fixed_q);
367 printf("worst_allowed_q: %d\n", oxcf->worst_allowed_q);
368 printf("best_allowed_q: %d\n", oxcf->best_allowed_q);
369 printf("allow_spatial_resampling: %d\n", oxcf->allow_spatial_resampling);
370 printf("resample_down_water_mark: %d\n", oxcf->resample_down_water_mark);
371 printf("resample_up_water_mark: %d\n", oxcf->resample_up_water_mark);
372 printf("allow_df: %d\n", oxcf->allow_df);
373 printf("drop_frames_water_mark: %d\n", oxcf->drop_frames_water_mark);
374 printf("two_pass_vbrbias: %d\n", oxcf->two_pass_vbrbias);
375 printf("two_pass_vbrmin_section: %d\n", oxcf->two_pass_vbrmin_section);
376 printf("two_pass_vbrmax_section: %d\n", oxcf->two_pass_vbrmax_section);
377 printf("allow_lag: %d\n", oxcf->allow_lag);
378 printf("lag_in_frames: %d\n", oxcf->lag_in_frames);
379 printf("play_alternate: %d\n", oxcf->play_alternate);
380 printf("Version: %d\n", oxcf->Version);
381 printf("multi_threaded: %d\n", oxcf->multi_threaded);
382 printf("encode_breakout: %d\n", oxcf->encode_breakout);
384 return VPX_CODEC_OK;
387 static vpx_codec_err_t vp8e_set_config(vpx_codec_alg_priv_t *ctx,
388 const vpx_codec_enc_cfg_t *cfg)
390 vpx_codec_err_t res;
392 if ((cfg->g_w != ctx->cfg.g_w) || (cfg->g_h != ctx->cfg.g_h))
393 ERROR("Cannot change width or height after initialization");
395 /* Prevent increasing lag_in_frames. This check is stricter than it needs
396 * to be -- the limit is not increasing past the first lag_in_frames
397 * value, but we don't track the initial config, only the last successful
398 * config.
400 if ((cfg->g_lag_in_frames > ctx->cfg.g_lag_in_frames))
401 ERROR("Cannot increase lag_in_frames");
403 res = validate_config(ctx, cfg, &ctx->vp8_cfg);
405 if (!res)
407 ctx->cfg = *cfg;
408 set_vp8e_config(&ctx->oxcf, ctx->cfg, ctx->vp8_cfg);
409 vp8_change_config(ctx->cpi, &ctx->oxcf);
412 return res;
416 int vp8_reverse_trans(int);
419 static vpx_codec_err_t get_param(vpx_codec_alg_priv_t *ctx,
420 int ctrl_id,
421 va_list args)
423 void *arg = va_arg(args, void *);
425 #define MAP(id, var) case id: *(RECAST(id, arg)) = var; break
427 if (!arg)
428 return VPX_CODEC_INVALID_PARAM;
430 switch (ctrl_id)
432 MAP(VP8E_GET_LAST_QUANTIZER, vp8_get_quantizer(ctx->cpi));
433 MAP(VP8E_GET_LAST_QUANTIZER_64, vp8_reverse_trans(vp8_get_quantizer(ctx->cpi)));
436 return VPX_CODEC_OK;
437 #undef MAP
441 static vpx_codec_err_t set_param(vpx_codec_alg_priv_t *ctx,
442 int ctrl_id,
443 va_list args)
445 vpx_codec_err_t res = VPX_CODEC_OK;
446 struct vp8_extracfg xcfg = ctx->vp8_cfg;
448 #define MAP(id, var) case id: var = CAST(id, args); break;
450 switch (ctrl_id)
452 MAP(VP8E_SET_ENCODING_MODE, ctx->deprecated_mode);
453 MAP(VP8E_SET_CPUUSED, xcfg.cpu_used);
454 MAP(VP8E_SET_ENABLEAUTOALTREF, xcfg.enable_auto_alt_ref);
455 MAP(VP8E_SET_NOISE_SENSITIVITY, xcfg.noise_sensitivity);
456 MAP(VP8E_SET_SHARPNESS, xcfg.Sharpness);
457 MAP(VP8E_SET_STATIC_THRESHOLD, xcfg.static_thresh);
458 MAP(VP8E_SET_TOKEN_PARTITIONS, xcfg.token_partitions);
460 MAP(VP8E_SET_ARNR_MAXFRAMES, xcfg.arnr_max_frames);
461 MAP(VP8E_SET_ARNR_STRENGTH , xcfg.arnr_strength);
462 MAP(VP8E_SET_ARNR_TYPE , xcfg.arnr_type);
463 MAP(VP8E_SET_TUNING, xcfg.tuning);
464 MAP(VP8E_SET_CQ_LEVEL, xcfg.cq_level);
468 res = validate_config(ctx, &ctx->cfg, &xcfg);
470 if (!res)
472 ctx->vp8_cfg = xcfg;
473 set_vp8e_config(&ctx->oxcf, ctx->cfg, ctx->vp8_cfg);
474 vp8_change_config(ctx->cpi, &ctx->oxcf);
477 return res;
478 #undef MAP
480 static vpx_codec_err_t vp8e_init(vpx_codec_ctx_t *ctx)
482 vpx_codec_err_t res = VPX_DEC_OK;
483 struct vpx_codec_alg_priv *priv;
484 vpx_codec_enc_cfg_t *cfg;
485 unsigned int i;
487 VP8_PTR optr;
489 if (!ctx->priv)
491 priv = calloc(1, sizeof(struct vpx_codec_alg_priv));
493 if (!priv)
495 return VPX_CODEC_MEM_ERROR;
498 ctx->priv = &priv->base;
499 ctx->priv->sz = sizeof(*ctx->priv);
500 ctx->priv->iface = ctx->iface;
501 ctx->priv->alg_priv = priv;
502 ctx->priv->init_flags = ctx->init_flags;
504 if (ctx->config.enc)
506 /* Update the reference to the config structure to an
507 * internal copy.
509 ctx->priv->alg_priv->cfg = *ctx->config.enc;
510 ctx->config.enc = &ctx->priv->alg_priv->cfg;
513 cfg = &ctx->priv->alg_priv->cfg;
515 /* Select the extra vp6 configuration table based on the current
516 * usage value. If the current usage value isn't found, use the
517 * values for usage case 0.
519 for (i = 0;
520 extracfg_map[i].usage && extracfg_map[i].usage != cfg->g_usage;
521 i++);
523 priv->vp8_cfg = extracfg_map[i].cfg;
524 priv->vp8_cfg.pkt_list = &priv->pkt_list.head;
526 priv->cx_data_sz = priv->cfg.g_w * priv->cfg.g_h * 3 / 2 * 2;
528 if (priv->cx_data_sz < 4096) priv->cx_data_sz = 4096;
530 priv->cx_data = malloc(priv->cx_data_sz);
532 if (!priv->cx_data)
534 return VPX_CODEC_MEM_ERROR;
537 priv->deprecated_mode = NO_MODE_SET;
539 vp8_initialize();
541 res = validate_config(priv, &priv->cfg, &priv->vp8_cfg);
543 if (!res)
545 set_vp8e_config(&ctx->priv->alg_priv->oxcf,
546 ctx->priv->alg_priv->cfg,
547 ctx->priv->alg_priv->vp8_cfg);
548 optr = vp8_create_compressor(&ctx->priv->alg_priv->oxcf);
550 if (!optr)
551 res = VPX_CODEC_MEM_ERROR;
552 else
553 ctx->priv->alg_priv->cpi = optr;
557 return res;
560 static vpx_codec_err_t vp8e_destroy(vpx_codec_alg_priv_t *ctx)
563 free(ctx->cx_data);
564 vp8_remove_compressor(&ctx->cpi);
565 free(ctx);
566 return VPX_CODEC_OK;
569 static vpx_codec_err_t image2yuvconfig(const vpx_image_t *img,
570 YV12_BUFFER_CONFIG *yv12)
572 vpx_codec_err_t res = VPX_CODEC_OK;
573 yv12->y_buffer = img->planes[VPX_PLANE_Y];
574 yv12->u_buffer = img->planes[VPX_PLANE_U];
575 yv12->v_buffer = img->planes[VPX_PLANE_V];
577 yv12->y_width = img->d_w;
578 yv12->y_height = img->d_h;
579 yv12->uv_width = (1 + yv12->y_width) / 2;
580 yv12->uv_height = (1 + yv12->y_height) / 2;
582 yv12->y_stride = img->stride[VPX_PLANE_Y];
583 yv12->uv_stride = img->stride[VPX_PLANE_U];
585 yv12->border = (img->stride[VPX_PLANE_Y] - img->w) / 2;
586 yv12->clrtype = (img->fmt == VPX_IMG_FMT_VPXI420 || img->fmt == VPX_IMG_FMT_VPXYV12); //REG_YUV = 0
587 return res;
590 static void pick_quickcompress_mode(vpx_codec_alg_priv_t *ctx,
591 unsigned long duration,
592 unsigned long deadline)
594 unsigned int new_qc;
596 #if !(CONFIG_REALTIME_ONLY)
597 /* Use best quality mode if no deadline is given. */
598 new_qc = MODE_BESTQUALITY;
600 if (deadline)
602 uint64_t duration_us;
604 /* Convert duration parameter from stream timebase to microseconds */
605 duration_us = (uint64_t)duration * 1000000
606 * (uint64_t)ctx->cfg.g_timebase.num
607 / (uint64_t)ctx->cfg.g_timebase.den;
609 /* If the deadline is more that the duration this frame is to be shown,
610 * use good quality mode. Otherwise use realtime mode.
612 new_qc = (deadline > duration_us) ? MODE_GOODQUALITY : MODE_REALTIME;
615 #else
616 new_qc = MODE_REALTIME;
617 #endif
619 switch (ctx->deprecated_mode)
621 case VP8_BEST_QUALITY_ENCODING:
622 new_qc = MODE_BESTQUALITY;
623 break;
624 case VP8_GOOD_QUALITY_ENCODING:
625 new_qc = MODE_GOODQUALITY;
626 break;
627 case VP8_REAL_TIME_ENCODING:
628 new_qc = MODE_REALTIME;
629 break;
632 if (ctx->cfg.g_pass == VPX_RC_FIRST_PASS)
633 new_qc = MODE_FIRSTPASS;
634 else if (ctx->cfg.g_pass == VPX_RC_LAST_PASS)
635 new_qc = (new_qc == MODE_BESTQUALITY)
636 ? MODE_SECONDPASS_BEST
637 : MODE_SECONDPASS;
639 if (ctx->oxcf.Mode != new_qc)
641 ctx->oxcf.Mode = new_qc;
642 vp8_change_config(ctx->cpi, &ctx->oxcf);
647 static vpx_codec_err_t vp8e_encode(vpx_codec_alg_priv_t *ctx,
648 const vpx_image_t *img,
649 vpx_codec_pts_t pts,
650 unsigned long duration,
651 vpx_enc_frame_flags_t flags,
652 unsigned long deadline)
654 vpx_codec_err_t res = VPX_CODEC_OK;
656 if (img)
657 res = validate_img(ctx, img);
659 pick_quickcompress_mode(ctx, duration, deadline);
660 vpx_codec_pkt_list_init(&ctx->pkt_list);
662 /* Handle Flags */
663 if (((flags & VP8_EFLAG_NO_UPD_GF) && (flags & VP8_EFLAG_FORCE_GF))
664 || ((flags & VP8_EFLAG_NO_UPD_ARF) && (flags & VP8_EFLAG_FORCE_ARF)))
666 ctx->base.err_detail = "Conflicting flags.";
667 return VPX_CODEC_INVALID_PARAM;
670 if (flags & (VP8_EFLAG_NO_REF_LAST | VP8_EFLAG_NO_REF_GF
671 | VP8_EFLAG_NO_REF_ARF))
673 int ref = 7;
675 if (flags & VP8_EFLAG_NO_REF_LAST)
676 ref ^= VP8_LAST_FLAG;
678 if (flags & VP8_EFLAG_NO_REF_GF)
679 ref ^= VP8_GOLD_FLAG;
681 if (flags & VP8_EFLAG_NO_REF_ARF)
682 ref ^= VP8_ALT_FLAG;
684 vp8_use_as_reference(ctx->cpi, ref);
687 if (flags & (VP8_EFLAG_NO_UPD_LAST | VP8_EFLAG_NO_UPD_GF
688 | VP8_EFLAG_NO_UPD_ARF | VP8_EFLAG_FORCE_GF
689 | VP8_EFLAG_FORCE_ARF))
691 int upd = 7;
693 if (flags & VP8_EFLAG_NO_UPD_LAST)
694 upd ^= VP8_LAST_FLAG;
696 if (flags & VP8_EFLAG_NO_UPD_GF)
697 upd ^= VP8_GOLD_FLAG;
699 if (flags & VP8_EFLAG_NO_UPD_ARF)
700 upd ^= VP8_ALT_FLAG;
702 vp8_update_reference(ctx->cpi, upd);
705 if (flags & VP8_EFLAG_NO_UPD_ENTROPY)
707 vp8_update_entropy(ctx->cpi, 0);
710 /* Handle fixed keyframe intervals */
711 if (ctx->cfg.kf_mode == VPX_KF_AUTO
712 && ctx->cfg.kf_min_dist == ctx->cfg.kf_max_dist)
714 if (++ctx->fixed_kf_cntr > ctx->cfg.kf_min_dist)
716 flags |= VPX_EFLAG_FORCE_KF;
717 ctx->fixed_kf_cntr = 1;
721 /* Initialize the encoder instance on the first frame*/
722 if (!res && ctx->cpi)
724 unsigned int lib_flags;
725 YV12_BUFFER_CONFIG sd;
726 INT64 dst_time_stamp, dst_end_time_stamp;
727 unsigned long size, cx_data_sz;
728 unsigned char *cx_data;
730 /* Set up internal flags */
731 if (ctx->base.init_flags & VPX_CODEC_USE_PSNR)
732 ((VP8_COMP *)ctx->cpi)->b_calculate_psnr = 1;
734 /* Convert API flags to internal codec lib flags */
735 lib_flags = (flags & VPX_EFLAG_FORCE_KF) ? FRAMEFLAGS_KEY : 0;
737 /* vp8 use 10,000,000 ticks/second as time stamp */
738 dst_time_stamp = pts * 10000000 * ctx->cfg.g_timebase.num / ctx->cfg.g_timebase.den;
739 dst_end_time_stamp = (pts + duration) * 10000000 * ctx->cfg.g_timebase.num / ctx->cfg.g_timebase.den;
741 if (img != NULL)
743 res = image2yuvconfig(img, &sd);
745 if (vp8_receive_raw_frame(ctx->cpi, ctx->next_frame_flag | lib_flags,
746 &sd, dst_time_stamp, dst_end_time_stamp))
748 VP8_COMP *cpi = (VP8_COMP *)ctx->cpi;
749 res = update_error_state(ctx, &cpi->common.error);
752 /* reset for next frame */
753 ctx->next_frame_flag = 0;
756 cx_data = ctx->cx_data;
757 cx_data_sz = ctx->cx_data_sz;
758 lib_flags = 0;
760 while (cx_data_sz >= ctx->cx_data_sz / 2
761 && -1 != vp8_get_compressed_data(ctx->cpi, &lib_flags, &size, cx_data, &dst_time_stamp, &dst_end_time_stamp, !img))
763 if (size)
765 vpx_codec_pts_t round, delta;
766 vpx_codec_cx_pkt_t pkt;
767 VP8_COMP *cpi = (VP8_COMP *)ctx->cpi;
769 /* Add the frame packet to the list of returned packets. */
770 round = 1000000 * ctx->cfg.g_timebase.num / 2 - 1;
771 delta = (dst_end_time_stamp - dst_time_stamp);
772 pkt.kind = VPX_CODEC_CX_FRAME_PKT;
773 pkt.data.frame.buf = cx_data;
774 pkt.data.frame.sz = size;
775 pkt.data.frame.pts =
776 (dst_time_stamp * ctx->cfg.g_timebase.den + round)
777 / ctx->cfg.g_timebase.num / 10000000;
778 pkt.data.frame.duration =
779 (delta * ctx->cfg.g_timebase.den + round)
780 / ctx->cfg.g_timebase.num / 10000000;
781 pkt.data.frame.flags = lib_flags << 16;
783 if (lib_flags & FRAMEFLAGS_KEY)
784 pkt.data.frame.flags |= VPX_FRAME_IS_KEY;
786 if (!cpi->common.show_frame)
788 pkt.data.frame.flags |= VPX_FRAME_IS_INVISIBLE;
790 // This timestamp should be as close as possible to the
791 // prior PTS so that if a decoder uses pts to schedule when
792 // to do this, we start right after last frame was decoded.
793 // Invisible frames have no duration.
794 pkt.data.frame.pts = ((cpi->last_time_stamp_seen
795 * ctx->cfg.g_timebase.den + round)
796 / ctx->cfg.g_timebase.num / 10000000) + 1;
797 pkt.data.frame.duration = 0;
800 vpx_codec_pkt_list_add(&ctx->pkt_list.head, &pkt);
802 //printf("timestamp: %lld, duration: %d\n", pkt->data.frame.pts, pkt->data.frame.duration);
803 cx_data += size;
804 cx_data_sz -= size;
809 return res;
813 static const vpx_codec_cx_pkt_t *vp8e_get_cxdata(vpx_codec_alg_priv_t *ctx,
814 vpx_codec_iter_t *iter)
816 return vpx_codec_pkt_list_get(&ctx->pkt_list.head, iter);
819 static vpx_codec_err_t vp8e_set_reference(vpx_codec_alg_priv_t *ctx,
820 int ctr_id,
821 va_list args)
823 vpx_ref_frame_t *data = va_arg(args, vpx_ref_frame_t *);
825 if (data)
827 vpx_ref_frame_t *frame = (vpx_ref_frame_t *)data;
828 YV12_BUFFER_CONFIG sd;
830 image2yuvconfig(&frame->img, &sd);
831 vp8_set_reference(ctx->cpi, frame->frame_type, &sd);
832 return VPX_CODEC_OK;
834 else
835 return VPX_CODEC_INVALID_PARAM;
839 static vpx_codec_err_t vp8e_get_reference(vpx_codec_alg_priv_t *ctx,
840 int ctr_id,
841 va_list args)
844 vpx_ref_frame_t *data = va_arg(args, vpx_ref_frame_t *);
846 if (data)
848 vpx_ref_frame_t *frame = (vpx_ref_frame_t *)data;
849 YV12_BUFFER_CONFIG sd;
851 image2yuvconfig(&frame->img, &sd);
852 vp8_get_reference(ctx->cpi, frame->frame_type, &sd);
853 return VPX_CODEC_OK;
855 else
856 return VPX_CODEC_INVALID_PARAM;
859 static vpx_codec_err_t vp8e_set_previewpp(vpx_codec_alg_priv_t *ctx,
860 int ctr_id,
861 va_list args)
863 #if CONFIG_POSTPROC
864 vp8_postproc_cfg_t *data = va_arg(args, vp8_postproc_cfg_t *);
865 (void)ctr_id;
867 if (data)
869 ctx->preview_ppcfg = *((vp8_postproc_cfg_t *)data);
870 return VPX_CODEC_OK;
872 else
873 return VPX_CODEC_INVALID_PARAM;
874 #else
875 (void)ctx;
876 (void)ctr_id;
877 (void)args;
878 return VPX_CODEC_INCAPABLE;
879 #endif
883 static vpx_image_t *vp8e_get_preview(vpx_codec_alg_priv_t *ctx)
886 YV12_BUFFER_CONFIG sd;
887 vp8_ppflags_t flags = {0};
889 if (ctx->preview_ppcfg.post_proc_flag)
891 flags.post_proc_flag = ctx->preview_ppcfg.post_proc_flag;
892 flags.deblocking_level = ctx->preview_ppcfg.deblocking_level;
893 flags.noise_level = ctx->preview_ppcfg.noise_level;
896 if (0 == vp8_get_preview_raw_frame(ctx->cpi, &sd, &flags))
900 vpx_img_wrap(&ctx->preview_img, VPX_IMG_FMT_YV12,
901 sd.y_width + 2*VP8BORDERINPIXELS,
902 sd.y_height + 2*VP8BORDERINPIXELS,
904 sd.buffer_alloc);
905 vpx_img_set_rect(&ctx->preview_img,
906 VP8BORDERINPIXELS, VP8BORDERINPIXELS,
907 sd.y_width, sd.y_height);
910 ctx->preview_img.bps = 12;
911 ctx->preview_img.planes[VPX_PLANE_Y] = sd.y_buffer;
912 ctx->preview_img.planes[VPX_PLANE_U] = sd.u_buffer;
913 ctx->preview_img.planes[VPX_PLANE_V] = sd.v_buffer;
915 if (sd.clrtype == REG_YUV)
916 ctx->preview_img.fmt = VPX_IMG_FMT_I420;
917 else
918 ctx->preview_img.fmt = VPX_IMG_FMT_VPXI420;
920 ctx->preview_img.x_chroma_shift = 1;
921 ctx->preview_img.y_chroma_shift = 1;
923 ctx->preview_img.d_w = sd.y_width;
924 ctx->preview_img.d_h = sd.y_height;
925 ctx->preview_img.stride[VPX_PLANE_Y] = sd.y_stride;
926 ctx->preview_img.stride[VPX_PLANE_U] = sd.uv_stride;
927 ctx->preview_img.stride[VPX_PLANE_V] = sd.uv_stride;
928 ctx->preview_img.w = sd.y_width;
929 ctx->preview_img.h = sd.y_height;
931 return &ctx->preview_img;
933 else
934 return NULL;
937 static vpx_codec_err_t vp8e_update_entropy(vpx_codec_alg_priv_t *ctx,
938 int ctr_id,
939 va_list args)
941 int update = va_arg(args, int);
942 vp8_update_entropy(ctx->cpi, update);
943 return VPX_CODEC_OK;
947 static vpx_codec_err_t vp8e_update_reference(vpx_codec_alg_priv_t *ctx,
948 int ctr_id,
949 va_list args)
951 int update = va_arg(args, int);
952 vp8_update_reference(ctx->cpi, update);
953 return VPX_CODEC_OK;
956 static vpx_codec_err_t vp8e_use_reference(vpx_codec_alg_priv_t *ctx,
957 int ctr_id,
958 va_list args)
960 int reference_flag = va_arg(args, int);
961 vp8_use_as_reference(ctx->cpi, reference_flag);
962 return VPX_CODEC_OK;
965 static vpx_codec_err_t vp8e_set_roi_map(vpx_codec_alg_priv_t *ctx,
966 int ctr_id,
967 va_list args)
969 vpx_roi_map_t *data = va_arg(args, vpx_roi_map_t *);
971 if (data)
973 vpx_roi_map_t *roi = (vpx_roi_map_t *)data;
975 if (!vp8_set_roimap(ctx->cpi, roi->roi_map, roi->rows, roi->cols, roi->delta_q, roi->delta_lf, roi->static_threshold))
976 return VPX_CODEC_OK;
977 else
978 return VPX_CODEC_INVALID_PARAM;
980 else
981 return VPX_CODEC_INVALID_PARAM;
985 static vpx_codec_err_t vp8e_set_activemap(vpx_codec_alg_priv_t *ctx,
986 int ctr_id,
987 va_list args)
989 vpx_active_map_t *data = va_arg(args, vpx_active_map_t *);
991 if (data)
994 vpx_active_map_t *map = (vpx_active_map_t *)data;
996 if (!vp8_set_active_map(ctx->cpi, map->active_map, map->rows, map->cols))
997 return VPX_CODEC_OK;
998 else
999 return VPX_CODEC_INVALID_PARAM;
1001 else
1002 return VPX_CODEC_INVALID_PARAM;
1005 static vpx_codec_err_t vp8e_set_scalemode(vpx_codec_alg_priv_t *ctx,
1006 int ctr_id,
1007 va_list args)
1010 vpx_scaling_mode_t *data = va_arg(args, vpx_scaling_mode_t *);
1012 if (data)
1014 int res;
1015 vpx_scaling_mode_t scalemode = *(vpx_scaling_mode_t *)data ;
1016 res = vp8_set_internal_size(ctx->cpi, scalemode.h_scaling_mode, scalemode.v_scaling_mode);
1018 if (!res)
1020 /*force next frame a key frame to effect scaling mode */
1021 ctx->next_frame_flag |= FRAMEFLAGS_KEY;
1022 return VPX_CODEC_OK;
1024 else
1025 return VPX_CODEC_INVALID_PARAM;
1027 else
1028 return VPX_CODEC_INVALID_PARAM;
1032 static vpx_codec_ctrl_fn_map_t vp8e_ctf_maps[] =
1034 {VP8_SET_REFERENCE, vp8e_set_reference},
1035 {VP8_COPY_REFERENCE, vp8e_get_reference},
1036 {VP8_SET_POSTPROC, vp8e_set_previewpp},
1037 {VP8E_UPD_ENTROPY, vp8e_update_entropy},
1038 {VP8E_UPD_REFERENCE, vp8e_update_reference},
1039 {VP8E_USE_REFERENCE, vp8e_use_reference},
1040 {VP8E_SET_ROI_MAP, vp8e_set_roi_map},
1041 {VP8E_SET_ACTIVEMAP, vp8e_set_activemap},
1042 {VP8E_SET_SCALEMODE, vp8e_set_scalemode},
1043 {VP8E_SET_ENCODING_MODE, set_param},
1044 {VP8E_SET_CPUUSED, set_param},
1045 {VP8E_SET_NOISE_SENSITIVITY, set_param},
1046 {VP8E_SET_ENABLEAUTOALTREF, set_param},
1047 {VP8E_SET_SHARPNESS, set_param},
1048 {VP8E_SET_STATIC_THRESHOLD, set_param},
1049 {VP8E_SET_TOKEN_PARTITIONS, set_param},
1050 {VP8E_GET_LAST_QUANTIZER, get_param},
1051 {VP8E_GET_LAST_QUANTIZER_64, get_param},
1052 {VP8E_SET_ARNR_MAXFRAMES, set_param},
1053 {VP8E_SET_ARNR_STRENGTH , set_param},
1054 {VP8E_SET_ARNR_TYPE , set_param},
1055 {VP8E_SET_TUNING, set_param},
1056 {VP8E_SET_CQ_LEVEL, set_param},
1057 { -1, NULL},
1060 static vpx_codec_enc_cfg_map_t vp8e_usage_cfg_map[] =
1065 0, /* g_usage */
1066 0, /* g_threads */
1067 0, /* g_profile */
1069 320, /* g_width */
1070 240, /* g_height */
1071 {1, 30}, /* g_timebase */
1073 0, /* g_error_resilient */
1075 VPX_RC_ONE_PASS, /* g_pass */
1077 0, /* g_lag_in_frames */
1079 0, /* rc_dropframe_thresh */
1080 0, /* rc_resize_allowed */
1081 60, /* rc_resize_down_thresold */
1082 30, /* rc_resize_up_thresold */
1084 VPX_VBR, /* rc_end_usage */
1085 #if VPX_ENCODER_ABI_VERSION > (1 + VPX_CODEC_ABI_VERSION)
1086 {0}, /* rc_twopass_stats_in */
1087 #endif
1088 256, /* rc_target_bandwidth */
1090 4, /* rc_min_quantizer */
1091 63, /* rc_max_quantizer */
1092 95, /* rc_undershoot_pct */
1093 200, /* rc_overshoot_pct */
1095 6000, /* rc_max_buffer_size */
1096 4000, /* rc_buffer_initial_size; */
1097 5000, /* rc_buffer_optimal_size; */
1099 50, /* rc_two_pass_vbrbias */
1100 0, /* rc_two_pass_vbrmin_section */
1101 400, /* rc_two_pass_vbrmax_section */
1103 /* keyframing settings (kf) */
1104 VPX_KF_AUTO, /* g_kfmode*/
1105 0, /* kf_min_dist */
1106 9999, /* kf_max_dist */
1108 #if VPX_ENCODER_ABI_VERSION == (1 + VPX_CODEC_ABI_VERSION)
1109 1, /* g_delete_first_pass_file */
1110 "vp8.fpf" /* first pass filename */
1111 #endif
1113 { -1, {NOT_IMPLEMENTED}}
1117 #ifndef VERSION_STRING
1118 #define VERSION_STRING
1119 #endif
1120 CODEC_INTERFACE(vpx_codec_vp8_cx) =
1122 "WebM Project VP8 Encoder" VERSION_STRING,
1123 VPX_CODEC_INTERNAL_ABI_VERSION,
1124 VPX_CODEC_CAP_ENCODER | VPX_CODEC_CAP_PSNR,
1125 /* vpx_codec_caps_t caps; */
1126 vp8e_init, /* vpx_codec_init_fn_t init; */
1127 vp8e_destroy, /* vpx_codec_destroy_fn_t destroy; */
1128 vp8e_ctf_maps, /* vpx_codec_ctrl_fn_map_t *ctrl_maps; */
1129 NOT_IMPLEMENTED, /* vpx_codec_get_mmap_fn_t get_mmap; */
1130 NOT_IMPLEMENTED, /* vpx_codec_set_mmap_fn_t set_mmap; */
1132 NOT_IMPLEMENTED, /* vpx_codec_peek_si_fn_t peek_si; */
1133 NOT_IMPLEMENTED, /* vpx_codec_get_si_fn_t get_si; */
1134 NOT_IMPLEMENTED, /* vpx_codec_decode_fn_t decode; */
1135 NOT_IMPLEMENTED, /* vpx_codec_frame_get_fn_t frame_get; */
1138 vp8e_usage_cfg_map, /* vpx_codec_enc_cfg_map_t peek_si; */
1139 vp8e_encode, /* vpx_codec_encode_fn_t encode; */
1140 vp8e_get_cxdata, /* vpx_codec_get_cx_data_fn_t frame_get; */
1141 vp8e_set_config,
1142 NOT_IMPLEMENTED,
1143 vp8e_get_preview,
1144 } /* encoder functions */
1149 * BEGIN BACKWARDS COMPATIBILITY SHIM.
1151 #define FORCE_KEY 2
1152 static vpx_codec_err_t api1_control(vpx_codec_alg_priv_t *ctx,
1153 int ctrl_id,
1154 va_list args)
1156 vpx_codec_ctrl_fn_map_t *entry;
1158 switch (ctrl_id)
1160 case VP8E_SET_FLUSHFLAG:
1161 /* VP8 sample code did VP8E_SET_FLUSHFLAG followed by
1162 * vpx_codec_get_cx_data() rather than vpx_codec_encode().
1164 return vp8e_encode(ctx, NULL, 0, 0, 0, 0);
1165 case VP8E_SET_FRAMETYPE:
1166 ctx->base.enc.tbd |= FORCE_KEY;
1167 return VPX_CODEC_OK;
1170 for (entry = vp8e_ctf_maps; entry && entry->fn; entry++)
1172 if (!entry->ctrl_id || entry->ctrl_id == ctrl_id)
1174 return entry->fn(ctx, ctrl_id, args);
1178 return VPX_CODEC_ERROR;
1182 static vpx_codec_ctrl_fn_map_t api1_ctrl_maps[] =
1184 {0, api1_control},
1185 { -1, NULL}
1189 static vpx_codec_err_t api1_encode(vpx_codec_alg_priv_t *ctx,
1190 const vpx_image_t *img,
1191 vpx_codec_pts_t pts,
1192 unsigned long duration,
1193 vpx_enc_frame_flags_t flags,
1194 unsigned long deadline)
1196 int force = ctx->base.enc.tbd;
1198 ctx->base.enc.tbd = 0;
1199 return vp8e_encode
1200 (ctx,
1201 img,
1202 pts,
1203 duration,
1204 flags | ((force & FORCE_KEY) ? VPX_EFLAG_FORCE_KF : 0),
1205 deadline);
1209 vpx_codec_iface_t vpx_enc_vp8_algo =
1211 "WebM Project VP8 Encoder (Deprecated API)" VERSION_STRING,
1212 VPX_CODEC_INTERNAL_ABI_VERSION,
1213 VPX_CODEC_CAP_ENCODER,
1214 /* vpx_codec_caps_t caps; */
1215 vp8e_init, /* vpx_codec_init_fn_t init; */
1216 vp8e_destroy, /* vpx_codec_destroy_fn_t destroy; */
1217 api1_ctrl_maps, /* vpx_codec_ctrl_fn_map_t *ctrl_maps; */
1218 NOT_IMPLEMENTED, /* vpx_codec_get_mmap_fn_t get_mmap; */
1219 NOT_IMPLEMENTED, /* vpx_codec_set_mmap_fn_t set_mmap; */
1220 {NOT_IMPLEMENTED}, /* decoder functions */
1222 vp8e_usage_cfg_map, /* vpx_codec_enc_cfg_map_t peek_si; */
1223 api1_encode, /* vpx_codec_encode_fn_t encode; */
1224 vp8e_get_cxdata, /* vpx_codec_get_cx_data_fn_t frame_get; */
1225 vp8e_set_config,
1226 NOT_IMPLEMENTED,
1227 vp8e_get_preview,
1228 } /* encoder functions */