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.
12 #ifndef __INC_VP8_INT_H
13 #define __INC_VP8_INT_H
16 #include "vpx_config.h"
17 #include "vp8/common/onyx.h"
18 #include "treewriter.h"
20 #include "vp8/common/onyxc_int.h"
21 #include "vp8/common/variance.h"
24 #include "vp8/common/entropy.h"
25 #include "vp8/common/threading.h"
26 #include "vpx_ports/mem.h"
27 #include "vpx/internal/vpx_codec_internal.h"
29 #include "vp8/common/findnearmv.h"
30 #include "lookahead.h"
31 #if CONFIG_TEMPORAL_DENOISING
32 #include "vp8/encoder/denoising.h"
35 //#define SPEEDSTATS 1
36 #define MIN_GF_INTERVAL 4
37 #define DEFAULT_GF_INTERVAL 7
39 #define KEY_FRAME_CONTEXT 5
41 #define MAX_LAG_BUFFERS (CONFIG_REALTIME_ONLY? 1 : 25)
44 #define AF_THRESH2 100
45 #define ARF_DECAY_THRESH 12
48 #define MIN_THRESHMULT 32
49 #define MAX_THRESHMULT 512
51 #define GF_ZEROMV_ZBIN_BOOST 12
52 #define LF_ZEROMV_ZBIN_BOOST 6
53 #define MV_ZBIN_BOOST 4
54 #define ZBIN_OQ_MAX 192
56 #if !(CONFIG_REALTIME_ONLY)
57 #define VP8_TEMPORAL_ALT_REF 1
60 #define MAX(x,y) (((x)>(y))?(x):(y))
61 #define MIN(x,y) (((x)<(y))?(x):(y))
66 unsigned int frames_since_key;
67 unsigned int frames_since_golden;
69 int frames_till_gf_update_due;
70 int recent_ref_frame_usage[MAX_REF_FRAMES];
73 int mvcosts[2][MVvals+1];
80 int inter_y_modes[10];
81 int inter_uv_modes[4];
82 int inter_b_modes[10];
85 vp8_prob ymode_prob[4], uv_mode_prob[3]; /* interframe intra mode probs */
86 vp8_prob kf_ymode_prob[4], kf_uv_mode_prob[3]; /* keyframe "" */
88 int ymode_count[5], uv_mode_count[4]; /* intra MB type cts this frame */
90 int count_mb_ref_frame_usage[MAX_REF_FRAMES];
92 int this_frame_percent_intra;
93 int last_frame_percent_intra;
103 double ssim_weighted_pred_err;
106 double pcnt_second_ref;
114 double mv_in_out_count;
124 double frame_intra_error;
125 double frame_coded_error;
126 double frame_pcnt_inter;
127 double frame_pcnt_motion;
129 double frame_mvr_abs;
131 double frame_mvc_abs;
133 } ONEPASS_FRAMESTATS;
179 SEARCH_METHODS search_method;
184 int iterative_sub_pixel;
185 int half_pixel_search;
186 int quarter_pixel_search;
187 int thresh_mult[MAX_MODES];
188 int max_step_search_steps;
190 int optimize_coefficients;
192 int use_fastquant_for_pick;
193 int no_skip_block4x4_search;
194 int improved_mv_pred;
201 int segment_counts[MAX_MB_SEGMENTS];
235 // Layer configuration
237 int target_bandwidth;
239 // Layer specific coding parameters
240 int starting_buffer_level;
241 int optimal_buffer_level;
242 int maximum_buffer_size;
243 int starting_buffer_level_in_ms;
244 int optimal_buffer_level_in_ms;
245 int maximum_buffer_size_in_ms;
247 int avg_frame_size_for_layer;
252 int64_t total_actual_bits;
253 int total_target_vs_actual;
256 int active_worst_quality;
258 int active_best_quality;
263 int avg_frame_qindex;
265 double rate_correction_factor;
266 double key_frame_rate_correction_factor;
267 double gf_rate_correction_factor;
271 int inter_frame_target;
272 int64_t total_byte_count;
276 int last_frame_percent_intra;
278 int count_mb_ref_frame_usage[MAX_REF_FRAMES];
282 typedef struct VP8_COMP
285 DECLARE_ALIGNED(16, short, Y1quant[QINDEX_RANGE][16]);
286 DECLARE_ALIGNED(16, unsigned char, Y1quant_shift[QINDEX_RANGE][16]);
287 DECLARE_ALIGNED(16, short, Y1zbin[QINDEX_RANGE][16]);
288 DECLARE_ALIGNED(16, short, Y1round[QINDEX_RANGE][16]);
290 DECLARE_ALIGNED(16, short, Y2quant[QINDEX_RANGE][16]);
291 DECLARE_ALIGNED(16, unsigned char, Y2quant_shift[QINDEX_RANGE][16]);
292 DECLARE_ALIGNED(16, short, Y2zbin[QINDEX_RANGE][16]);
293 DECLARE_ALIGNED(16, short, Y2round[QINDEX_RANGE][16]);
295 DECLARE_ALIGNED(16, short, UVquant[QINDEX_RANGE][16]);
296 DECLARE_ALIGNED(16, unsigned char, UVquant_shift[QINDEX_RANGE][16]);
297 DECLARE_ALIGNED(16, short, UVzbin[QINDEX_RANGE][16]);
298 DECLARE_ALIGNED(16, short, UVround[QINDEX_RANGE][16]);
300 DECLARE_ALIGNED(16, short, zrun_zbin_boost_y1[QINDEX_RANGE][16]);
301 DECLARE_ALIGNED(16, short, zrun_zbin_boost_y2[QINDEX_RANGE][16]);
302 DECLARE_ALIGNED(16, short, zrun_zbin_boost_uv[QINDEX_RANGE][16]);
303 DECLARE_ALIGNED(16, short, Y1quant_fast[QINDEX_RANGE][16]);
304 DECLARE_ALIGNED(16, short, Y2quant_fast[QINDEX_RANGE][16]);
305 DECLARE_ALIGNED(16, short, UVquant_fast[QINDEX_RANGE][16]);
310 vp8_writer bc[9]; // one boolcoder for each partition
314 struct lookahead_ctx *lookahead;
315 struct lookahead_entry *source;
316 struct lookahead_entry *alt_ref_source;
317 struct lookahead_entry *last_source;
319 YV12_BUFFER_CONFIG *Source;
320 YV12_BUFFER_CONFIG *un_scaled_source;
321 YV12_BUFFER_CONFIG scaled_source;
322 YV12_BUFFER_CONFIG *last_frame_unscaled_source;
324 int source_alt_ref_pending; // frame in src_buffers has been identified to be encoded as an alt ref
325 int source_alt_ref_active; // an alt ref frame has been encoded and is usable
327 int is_src_frame_alt_ref; // source of frame to encode is an exact copy of an alt ref frame
329 int gold_is_last; // golden frame same as last frame ( short circuit gold searches)
330 int alt_is_last; // Alt reference frame same as last ( short circuit altref search)
331 int gold_is_alt; // don't do both alt and gold search ( just do gold).
333 //int refresh_alt_ref_frame;
334 YV12_BUFFER_CONFIG pick_lf_lvl_frame;
337 unsigned int tok_count;
340 unsigned int frames_since_key;
341 unsigned int key_frame_frequency;
342 unsigned int this_key_frame_forced;
343 unsigned int next_key_frame_forced;
345 // Ambient reconstruction err target for force key frames
348 unsigned int mode_check_freq[MAX_MODES];
349 unsigned int mode_test_hit_counts[MAX_MODES];
350 unsigned int mode_chosen_counts[MAX_MODES];
351 unsigned int mbs_tested_so_far;
353 int rd_thresh_mult[MAX_MODES];
354 int rd_baseline_thresh[MAX_MODES];
355 int rd_threshes[MAX_MODES];
360 CODING_CONTEXT coding_context;
362 // Rate targetting variables
363 int64_t prediction_error;
364 int64_t last_prediction_error;
366 int64_t last_intra_error;
368 int this_frame_target;
369 int projected_frame_size;
370 int last_q[2]; // Separate values for Intra/Inter
372 double rate_correction_factor;
373 double key_frame_rate_correction_factor;
374 double gf_rate_correction_factor;
376 int frames_till_gf_update_due; // Count down till next GF
377 int current_gf_interval; // GF interval chosen when we coded the last GF
379 int gf_overspend_bits; // Total bits overspent becasue of GF boost (cumulative)
381 int non_gf_bitrate_adjustment; // Used in the few frames following a GF to recover the extra bits spent in that GF
383 int kf_overspend_bits; // Extra bits spent on key frames that need to be recovered on inter frames
384 int kf_bitrate_adjustment; // Current number of bit s to try and recover on each inter frame.
386 int baseline_gf_interval;
387 int active_arnr_frames; // <= cpi->oxcf.arnr_max_frames
389 int64_t key_frame_count;
390 int prior_key_frame_distance[KEY_FRAME_CONTEXT];
391 int per_frame_bandwidth; // Current section per frame bandwidth target
392 int av_per_frame_bandwidth; // Average frame size target for clip
393 int min_frame_bandwidth; // Minimum allocation that should be used for any frame
394 int inter_frame_target;
395 double output_frame_rate;
396 int64_t last_time_stamp_seen;
397 int64_t last_end_time_stamp_seen;
398 int64_t first_time_stamp_ever;
403 int avg_frame_qindex;
407 int zbin_mode_boost_enabled;
408 int last_zbin_over_quant;
409 int last_zbin_mode_boost;
411 int64_t total_byte_count;
416 double ref_frame_rate;
417 int64_t buffer_level;
420 int rolling_target_bits;
421 int rolling_actual_bits;
423 int long_rolling_target_bits;
424 int long_rolling_actual_bits;
426 int64_t total_actual_bits;
427 int total_target_vs_actual; // debug stats
430 int active_worst_quality;
432 int active_best_quality;
434 int cq_target_quality;
436 int drop_frames_allowed; // Are we permitted to drop frames?
437 int drop_frame; // Drop this frame?
438 int drop_count; // How many frames have we dropped?
439 int max_drop_count; // How many frames should we drop?
440 int max_consec_dropped_frames; // Limit number of consecutive frames that can be dropped.
443 int ymode_count [VP8_YMODES]; /* intra MB type cts this frame */
444 int uv_mode_count[VP8_UV_MODES]; /* intra MB type cts this frame */
446 unsigned int MVcount [2] [MVvals]; /* (row,col) MV cts this frame */
448 unsigned int coef_counts [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [MAX_ENTROPY_TOKENS]; /* for this frame */
450 //DECLARE_ALIGNED(16, int, coef_counts_backup [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [MAX_ENTROPY_TOKENS]); //not used any more
451 //save vp8_tree_probs_from_distribution result for each frame to avoid repeat calculation
452 vp8_prob frame_coef_probs [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [ENTROPY_NODES];
453 char update_probs [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [ENTROPY_NODES];
455 unsigned int frame_branch_ct [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [ENTROPY_NODES][2];
461 int target_bandwidth;
462 struct vpx_codec_pkt_list *output_pkt_list;
465 // Experimental code for lagged and one pass
466 ONEPASS_FRAMESTATS one_pass_frame_stats[MAX_LAG_BUFFERS];
467 int one_pass_frame_index;
470 int decimation_factor;
471 int decimation_count;
473 // for real time encoding
474 int avg_encode_time; //microsecond
475 int avg_pick_mode_time; //microsecond
477 unsigned int cpu_freq; //Mhz
478 int compressor_speed;
482 int auto_adjust_gold_quantizer;
489 int prob_intra_coded;
493 int last_skip_false_probs[3];
494 int last_skip_probs_q[3];
495 int recent_ref_frame_usage[MAX_REF_FRAMES];
497 int count_mb_ref_frame_usage[MAX_REF_FRAMES];
498 int this_frame_percent_intra;
499 int last_frame_percent_intra;
504 int error_bins[1024];
506 // Data used for real time conferencing mode to help determine if it would be good to update the gf
509 int gf_update_recommended;
512 unsigned char *segmentation_map;
513 signed char segment_feature_data[MB_LVL_MAX][MAX_MB_SEGMENTS]; // Segment data (can be deltas or absolute values)
514 int segment_encode_breakout[MAX_MB_SEGMENTS]; // segment threashold for encode breakout
516 unsigned char *active_map;
517 unsigned int active_map_enabled;
518 // Video conferencing cyclic refresh mode flags etc
519 // This is a mode designed to clean up the background over time in live encoding scenarious. It uses segmentation
520 int cyclic_refresh_mode_enabled;
521 int cyclic_refresh_mode_max_mbs_perframe;
522 int cyclic_refresh_mode_index;
523 int cyclic_refresh_q;
524 signed char *cyclic_refresh_map;
526 #if CONFIG_MULTITHREAD
528 int * mt_current_mb_col;
530 int b_multi_threaded;
531 int encoding_thread_count;
534 pthread_t *h_encoding_thread;
535 pthread_t h_filter_thread;
537 MB_ROW_COMP *mb_row_ei;
538 ENCODETHREAD_DATA *en_thread_data;
539 LPFTHREAD_DATA lpf_thread_data;
542 sem_t *h_event_start_encoding;
543 sem_t h_event_end_encoding;
544 sem_t h_event_start_lpf;
545 sem_t h_event_end_lpf;
549 unsigned int partition_sz[MAX_PARTITIONS];
550 unsigned char *partition_d[MAX_PARTITIONS];
551 unsigned char *partition_d_end[MAX_PARTITIONS];
552 // end of multithread data
555 fractional_mv_step_fp *find_fractional_mv_step;
556 vp8_full_search_fn_t full_search_sad;
557 vp8_refining_search_fn_t refining_search_sad;
558 vp8_diamond_search_fn_t diamond_search_sad;
559 vp8_variance_fn_ptr_t fn_ptr[BLOCK_MAX_SEGMENTS];
560 unsigned int time_receive_data;
561 unsigned int time_compress_data;
562 unsigned int time_pick_lpf;
563 unsigned int time_encode_mb_row;
565 int base_skip_false_prob[128];
567 FRAME_CONTEXT lfc_n; /* last frame entropy */
568 FRAME_CONTEXT lfc_a; /* last alt ref entropy */
569 FRAME_CONTEXT lfc_g; /* last gold ref entropy */
574 unsigned int section_intra_rating;
575 double section_max_qfactor;
576 unsigned int next_iiratio;
577 unsigned int this_iiratio;
578 FIRSTPASS_STATS total_stats;
579 FIRSTPASS_STATS this_frame_stats;
580 FIRSTPASS_STATS *stats_in, *stats_in_end, *stats_in_start;
581 FIRSTPASS_STATS total_left_stats;
584 int64_t clip_bits_total;
586 double modified_error_total;
587 double modified_error_used;
588 double modified_error_left;
589 double kf_intra_err_min;
590 double gf_intra_err_min;
595 int static_scene_max_gf_interval;
597 int gf_group_error_left; // Remaining error from uncoded frames in a gf group. Two pass use only
599 // Projected total bits available for a key frame group of frames
600 int64_t kf_group_bits;
602 // Error score of frames still to be coded in kf group
603 int64_t kf_group_error_left;
605 int gf_group_bits; // Projected Bits available for a group of frames including 1 GF or ARF
606 int gf_bits; // Bits for the golden frame or ARF - 2 pass only
608 double est_max_qcorrection_factor;
611 #if VP8_TEMPORAL_ALT_REF
612 YV12_BUFFER_CONFIG alt_ref_buffer;
613 YV12_BUFFER_CONFIG *frames[MAX_LAG_BUFFERS];
614 int fixed_divide[512];
617 #if CONFIG_INTERNAL_STATS
623 double total_sq_error;
628 double total_sq_error2;
630 double summed_quality;
631 double summed_weights;
632 unsigned int tot_recode_hits;
635 double total_ssimg_y;
636 double total_ssimg_u;
637 double total_ssimg_v;
638 double total_ssimg_all;
640 int b_calculate_ssimg;
642 int b_calculate_psnr;
644 // Per MB activity measurement
645 unsigned int activity_avg;
646 unsigned int * mb_activity_map;
647 int * mb_norm_activity_map;
649 // Record of which MBs still refer to last golden frame either
650 // directly or through 0,0
651 unsigned char *gf_active_flags;
654 int output_partition;
656 //Store last frame's MV info for next frame MV prediction
658 int *lf_ref_frame_sign_bias;
661 int force_next_frame_intra; /* force next frame to intra when kf_auto says so */
665 #if CONFIG_TEMPORAL_DENOISING
666 VP8_DENOISER denoiser;
669 // Coding layer state variables
670 unsigned int current_layer;
671 LAYER_CONTEXT layer_context[VPX_TS_MAX_LAYERS];
673 int64_t frames_in_layer[VPX_TS_MAX_LAYERS];
674 int64_t bytes_in_layer[VPX_TS_MAX_LAYERS];
675 double sum_psnr[VPX_TS_MAX_LAYERS];
676 double sum_psnr_p[VPX_TS_MAX_LAYERS];
677 double total_error2[VPX_TS_MAX_LAYERS];
678 double total_error2_p[VPX_TS_MAX_LAYERS];
679 double sum_ssim[VPX_TS_MAX_LAYERS];
680 double sum_weights[VPX_TS_MAX_LAYERS];
682 double total_ssimg_y_in_layer[VPX_TS_MAX_LAYERS];
683 double total_ssimg_u_in_layer[VPX_TS_MAX_LAYERS];
684 double total_ssimg_v_in_layer[VPX_TS_MAX_LAYERS];
685 double total_ssimg_all_in_layer[VPX_TS_MAX_LAYERS];
687 #if CONFIG_MULTI_RES_ENCODING
688 /* Number of MBs per row at lower-resolution level */
689 int mr_low_res_mb_cols;
692 struct rd_costs_struct
694 int mvcosts[2][MVvals+1];
695 int mvsadcosts[2][MVfpvals+1];
696 int mbmode_cost[2][MB_MODE_COUNT];
697 int intra_uv_mode_cost[2][MB_MODE_COUNT];
698 int bmode_costs[10][10][10];
699 int inter_bmode_costs[B_MODE_COUNT];
700 int token_costs[BLOCK_TYPES][COEF_BANDS]
701 [PREV_COEF_CONTEXTS][MAX_ENTROPY_TOKENS];
705 void control_data_rate(VP8_COMP *cpi);
707 void vp8_pack_bitstream(VP8_COMP *cpi, unsigned char *dest, unsigned char *dest_end, unsigned long *size);
709 int rd_cost_intra_mb(MACROBLOCKD *x);
711 void vp8_tokenize_mb(VP8_COMP *, MACROBLOCKD *, TOKENEXTRA **);
713 void vp8_set_speed_features(VP8_COMP *cpi);
716 #define CHECK_MEM_ERROR(lval,expr) do {\
719 vpx_internal_error(&cpi->common.error, VPX_CODEC_MEM_ERROR,\
720 "Failed to allocate "#lval" at %s:%d", \
724 #define CHECK_MEM_ERROR(lval,expr) do {\
727 vpx_internal_error(&cpi->common.error, VPX_CODEC_MEM_ERROR,\
728 "Failed to allocate "#lval);\