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_PERIODICITY 16
62 #define MAX(x,y) (((x)>(y))?(x):(y))
63 #define MIN(x,y) (((x)<(y))?(x):(y))
68 unsigned int frames_since_key;
69 unsigned int frames_since_golden;
71 int frames_till_gf_update_due;
72 int recent_ref_frame_usage[MAX_REF_FRAMES];
75 int mvcosts[2][MVvals+1];
82 int inter_y_modes[10];
83 int inter_uv_modes[4];
84 int inter_b_modes[10];
87 vp8_prob ymode_prob[4], uv_mode_prob[3]; /* interframe intra mode probs */
88 vp8_prob kf_ymode_prob[4], kf_uv_mode_prob[3]; /* keyframe "" */
90 int ymode_count[5], uv_mode_count[4]; /* intra MB type cts this frame */
92 int count_mb_ref_frame_usage[MAX_REF_FRAMES];
94 int this_frame_percent_intra;
95 int last_frame_percent_intra;
105 double ssim_weighted_pred_err;
108 double pcnt_second_ref;
116 double mv_in_out_count;
126 double frame_intra_error;
127 double frame_coded_error;
128 double frame_pcnt_inter;
129 double frame_pcnt_motion;
131 double frame_mvr_abs;
133 double frame_mvc_abs;
135 } ONEPASS_FRAMESTATS;
181 SEARCH_METHODS search_method;
186 int iterative_sub_pixel;
187 int half_pixel_search;
188 int quarter_pixel_search;
189 int thresh_mult[MAX_MODES];
190 int max_step_search_steps;
192 int optimize_coefficients;
194 int use_fastquant_for_pick;
195 int no_skip_block4x4_search;
196 int improved_mv_pred;
203 int segment_counts[MAX_MB_SEGMENTS];
237 // Layer configuration
239 int target_bandwidth;
241 // Layer specific coding parameters
242 int starting_buffer_level;
243 int optimal_buffer_level;
244 int maximum_buffer_size;
245 int starting_buffer_level_in_ms;
246 int optimal_buffer_level_in_ms;
247 int maximum_buffer_size_in_ms;
249 int avg_frame_size_for_layer;
254 int64_t total_actual_bits;
255 int total_target_vs_actual;
258 int active_worst_quality;
260 int active_best_quality;
265 int avg_frame_qindex;
267 double rate_correction_factor;
268 double key_frame_rate_correction_factor;
269 double gf_rate_correction_factor;
273 int inter_frame_target;
274 int64_t total_byte_count;
278 int last_frame_percent_intra;
280 int count_mb_ref_frame_usage[MAX_REF_FRAMES];
284 typedef struct VP8_COMP
287 DECLARE_ALIGNED(16, short, Y1quant[QINDEX_RANGE][16]);
288 DECLARE_ALIGNED(16, unsigned char, Y1quant_shift[QINDEX_RANGE][16]);
289 DECLARE_ALIGNED(16, short, Y1zbin[QINDEX_RANGE][16]);
290 DECLARE_ALIGNED(16, short, Y1round[QINDEX_RANGE][16]);
292 DECLARE_ALIGNED(16, short, Y2quant[QINDEX_RANGE][16]);
293 DECLARE_ALIGNED(16, unsigned char, Y2quant_shift[QINDEX_RANGE][16]);
294 DECLARE_ALIGNED(16, short, Y2zbin[QINDEX_RANGE][16]);
295 DECLARE_ALIGNED(16, short, Y2round[QINDEX_RANGE][16]);
297 DECLARE_ALIGNED(16, short, UVquant[QINDEX_RANGE][16]);
298 DECLARE_ALIGNED(16, unsigned char, UVquant_shift[QINDEX_RANGE][16]);
299 DECLARE_ALIGNED(16, short, UVzbin[QINDEX_RANGE][16]);
300 DECLARE_ALIGNED(16, short, UVround[QINDEX_RANGE][16]);
302 DECLARE_ALIGNED(16, short, zrun_zbin_boost_y1[QINDEX_RANGE][16]);
303 DECLARE_ALIGNED(16, short, zrun_zbin_boost_y2[QINDEX_RANGE][16]);
304 DECLARE_ALIGNED(16, short, zrun_zbin_boost_uv[QINDEX_RANGE][16]);
305 DECLARE_ALIGNED(16, short, Y1quant_fast[QINDEX_RANGE][16]);
306 DECLARE_ALIGNED(16, short, Y2quant_fast[QINDEX_RANGE][16]);
307 DECLARE_ALIGNED(16, short, UVquant_fast[QINDEX_RANGE][16]);
312 vp8_writer bc[9]; // one boolcoder for each partition
316 struct lookahead_ctx *lookahead;
317 struct lookahead_entry *source;
318 struct lookahead_entry *alt_ref_source;
319 struct lookahead_entry *last_source;
321 YV12_BUFFER_CONFIG *Source;
322 YV12_BUFFER_CONFIG *un_scaled_source;
323 YV12_BUFFER_CONFIG scaled_source;
324 YV12_BUFFER_CONFIG *last_frame_unscaled_source;
326 int source_alt_ref_pending; // frame in src_buffers has been identified to be encoded as an alt ref
327 int source_alt_ref_active; // an alt ref frame has been encoded and is usable
329 int is_src_frame_alt_ref; // source of frame to encode is an exact copy of an alt ref frame
331 int gold_is_last; // golden frame same as last frame ( short circuit gold searches)
332 int alt_is_last; // Alt reference frame same as last ( short circuit altref search)
333 int gold_is_alt; // don't do both alt and gold search ( just do gold).
335 //int refresh_alt_ref_frame;
336 YV12_BUFFER_CONFIG pick_lf_lvl_frame;
339 unsigned int tok_count;
342 unsigned int frames_since_key;
343 unsigned int key_frame_frequency;
344 unsigned int this_key_frame_forced;
345 unsigned int next_key_frame_forced;
347 // Ambient reconstruction err target for force key frames
350 unsigned int mode_check_freq[MAX_MODES];
351 unsigned int mode_test_hit_counts[MAX_MODES];
352 unsigned int mode_chosen_counts[MAX_MODES];
353 unsigned int mbs_tested_so_far;
355 int rd_thresh_mult[MAX_MODES];
356 int rd_baseline_thresh[MAX_MODES];
357 int rd_threshes[MAX_MODES];
362 CODING_CONTEXT coding_context;
364 // Rate targetting variables
365 int64_t prediction_error;
366 int64_t last_prediction_error;
368 int64_t last_intra_error;
370 int this_frame_target;
371 int projected_frame_size;
372 int last_q[2]; // Separate values for Intra/Inter
374 double rate_correction_factor;
375 double key_frame_rate_correction_factor;
376 double gf_rate_correction_factor;
378 int frames_till_gf_update_due; // Count down till next GF
379 int current_gf_interval; // GF interval chosen when we coded the last GF
381 int gf_overspend_bits; // Total bits overspent becasue of GF boost (cumulative)
383 int non_gf_bitrate_adjustment; // Used in the few frames following a GF to recover the extra bits spent in that GF
385 int kf_overspend_bits; // Extra bits spent on key frames that need to be recovered on inter frames
386 int kf_bitrate_adjustment; // Current number of bit s to try and recover on each inter frame.
388 int baseline_gf_interval;
389 int active_arnr_frames; // <= cpi->oxcf.arnr_max_frames
391 int64_t key_frame_count;
392 int prior_key_frame_distance[KEY_FRAME_CONTEXT];
393 int per_frame_bandwidth; // Current section per frame bandwidth target
394 int av_per_frame_bandwidth; // Average frame size target for clip
395 int min_frame_bandwidth; // Minimum allocation that should be used for any frame
396 int inter_frame_target;
397 double output_frame_rate;
398 int64_t last_time_stamp_seen;
399 int64_t last_end_time_stamp_seen;
400 int64_t first_time_stamp_ever;
405 int avg_frame_qindex;
409 int zbin_mode_boost_enabled;
410 int last_zbin_over_quant;
411 int last_zbin_mode_boost;
413 int64_t total_byte_count;
418 double ref_frame_rate;
419 int64_t buffer_level;
422 int rolling_target_bits;
423 int rolling_actual_bits;
425 int long_rolling_target_bits;
426 int long_rolling_actual_bits;
428 int64_t total_actual_bits;
429 int total_target_vs_actual; // debug stats
432 int active_worst_quality;
434 int active_best_quality;
436 int cq_target_quality;
438 int drop_frames_allowed; // Are we permitted to drop frames?
439 int drop_frame; // Drop this frame?
440 int drop_count; // How many frames have we dropped?
441 int max_drop_count; // How many frames should we drop?
442 int max_consec_dropped_frames; // Limit number of consecutive frames that can be dropped.
445 int ymode_count [VP8_YMODES]; /* intra MB type cts this frame */
446 int uv_mode_count[VP8_UV_MODES]; /* intra MB type cts this frame */
448 unsigned int MVcount [2] [MVvals]; /* (row,col) MV cts this frame */
450 unsigned int coef_counts [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [MAX_ENTROPY_TOKENS]; /* for this frame */
452 //DECLARE_ALIGNED(16, int, coef_counts_backup [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [MAX_ENTROPY_TOKENS]); //not used any more
453 //save vp8_tree_probs_from_distribution result for each frame to avoid repeat calculation
454 vp8_prob frame_coef_probs [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [ENTROPY_NODES];
455 char update_probs [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [ENTROPY_NODES];
457 unsigned int frame_branch_ct [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [ENTROPY_NODES][2];
463 int target_bandwidth;
464 struct vpx_codec_pkt_list *output_pkt_list;
467 // Experimental code for lagged and one pass
468 ONEPASS_FRAMESTATS one_pass_frame_stats[MAX_LAG_BUFFERS];
469 int one_pass_frame_index;
472 int decimation_factor;
473 int decimation_count;
475 // for real time encoding
476 int avg_encode_time; //microsecond
477 int avg_pick_mode_time; //microsecond
479 unsigned int cpu_freq; //Mhz
480 int compressor_speed;
484 int auto_adjust_gold_quantizer;
491 int prob_intra_coded;
495 int last_skip_false_probs[3];
496 int last_skip_probs_q[3];
497 int recent_ref_frame_usage[MAX_REF_FRAMES];
499 int count_mb_ref_frame_usage[MAX_REF_FRAMES];
500 int this_frame_percent_intra;
501 int last_frame_percent_intra;
506 int error_bins[1024];
508 // Data used for real time conferencing mode to help determine if it would be good to update the gf
511 int gf_update_recommended;
514 unsigned char *segmentation_map;
515 signed char segment_feature_data[MB_LVL_MAX][MAX_MB_SEGMENTS]; // Segment data (can be deltas or absolute values)
516 int segment_encode_breakout[MAX_MB_SEGMENTS]; // segment threashold for encode breakout
518 unsigned char *active_map;
519 unsigned int active_map_enabled;
520 // Video conferencing cyclic refresh mode flags etc
521 // This is a mode designed to clean up the background over time in live encoding scenarious. It uses segmentation
522 int cyclic_refresh_mode_enabled;
523 int cyclic_refresh_mode_max_mbs_perframe;
524 int cyclic_refresh_mode_index;
525 int cyclic_refresh_q;
526 signed char *cyclic_refresh_map;
528 #if CONFIG_MULTITHREAD
530 int * mt_current_mb_col;
532 int b_multi_threaded;
533 int encoding_thread_count;
536 pthread_t *h_encoding_thread;
537 pthread_t h_filter_thread;
539 MB_ROW_COMP *mb_row_ei;
540 ENCODETHREAD_DATA *en_thread_data;
541 LPFTHREAD_DATA lpf_thread_data;
544 sem_t *h_event_start_encoding;
545 sem_t h_event_end_encoding;
546 sem_t h_event_start_lpf;
547 sem_t h_event_end_lpf;
551 unsigned int partition_sz[MAX_PARTITIONS];
552 unsigned char *partition_d[MAX_PARTITIONS];
553 unsigned char *partition_d_end[MAX_PARTITIONS];
554 // end of multithread data
557 fractional_mv_step_fp *find_fractional_mv_step;
558 vp8_full_search_fn_t full_search_sad;
559 vp8_refining_search_fn_t refining_search_sad;
560 vp8_diamond_search_fn_t diamond_search_sad;
561 vp8_variance_fn_ptr_t fn_ptr[BLOCK_MAX_SEGMENTS];
562 unsigned int time_receive_data;
563 unsigned int time_compress_data;
564 unsigned int time_pick_lpf;
565 unsigned int time_encode_mb_row;
567 int base_skip_false_prob[128];
569 FRAME_CONTEXT lfc_n; /* last frame entropy */
570 FRAME_CONTEXT lfc_a; /* last alt ref entropy */
571 FRAME_CONTEXT lfc_g; /* last gold ref entropy */
576 unsigned int section_intra_rating;
577 double section_max_qfactor;
578 unsigned int next_iiratio;
579 unsigned int this_iiratio;
580 FIRSTPASS_STATS total_stats;
581 FIRSTPASS_STATS this_frame_stats;
582 FIRSTPASS_STATS *stats_in, *stats_in_end, *stats_in_start;
583 FIRSTPASS_STATS total_left_stats;
586 int64_t clip_bits_total;
588 double modified_error_total;
589 double modified_error_used;
590 double modified_error_left;
591 double kf_intra_err_min;
592 double gf_intra_err_min;
597 int static_scene_max_gf_interval;
599 int gf_group_error_left; // Remaining error from uncoded frames in a gf group. Two pass use only
601 // Projected total bits available for a key frame group of frames
602 int64_t kf_group_bits;
604 // Error score of frames still to be coded in kf group
605 int64_t kf_group_error_left;
607 int gf_group_bits; // Projected Bits available for a group of frames including 1 GF or ARF
608 int gf_bits; // Bits for the golden frame or ARF - 2 pass only
610 double est_max_qcorrection_factor;
613 #if VP8_TEMPORAL_ALT_REF
614 YV12_BUFFER_CONFIG alt_ref_buffer;
615 YV12_BUFFER_CONFIG *frames[MAX_LAG_BUFFERS];
616 int fixed_divide[512];
619 #if CONFIG_INTERNAL_STATS
625 double total_sq_error;
630 double total_sq_error2;
632 double summed_quality;
633 double summed_weights;
634 unsigned int tot_recode_hits;
637 double total_ssimg_y;
638 double total_ssimg_u;
639 double total_ssimg_v;
640 double total_ssimg_all;
642 int b_calculate_ssimg;
644 int b_calculate_psnr;
646 // Per MB activity measurement
647 unsigned int activity_avg;
648 unsigned int * mb_activity_map;
649 int * mb_norm_activity_map;
651 // Record of which MBs still refer to last golden frame either
652 // directly or through 0,0
653 unsigned char *gf_active_flags;
656 int output_partition;
658 //Store last frame's MV info for next frame MV prediction
660 int *lf_ref_frame_sign_bias;
663 int force_next_frame_intra; /* force next frame to intra when kf_auto says so */
667 #if CONFIG_TEMPORAL_DENOISING
668 VP8_DENOISER denoiser;
671 // Coding layer state variables
672 unsigned int current_layer;
673 LAYER_CONTEXT layer_context[MAX_LAYERS];
675 int64_t frames_in_layer[MAX_LAYERS];
676 int64_t bytes_in_layer[MAX_LAYERS];
677 double sum_psnr[MAX_LAYERS];
678 double sum_psnr_p[MAX_LAYERS];
679 double total_error2[MAX_LAYERS];
680 double total_error2_p[MAX_LAYERS];
681 double sum_ssim[MAX_LAYERS];
682 double sum_weights[MAX_LAYERS];
684 double total_ssimg_y_in_layer[MAX_LAYERS];
685 double total_ssimg_u_in_layer[MAX_LAYERS];
686 double total_ssimg_v_in_layer[MAX_LAYERS];
687 double total_ssimg_all_in_layer[MAX_LAYERS];
689 #if CONFIG_MULTI_RES_ENCODING
690 /* Number of MBs per row at lower-resolution level */
691 int mr_low_res_mb_cols;
696 void control_data_rate(VP8_COMP *cpi);
698 void vp8_encode_frame(VP8_COMP *cpi);
700 void vp8_pack_bitstream(VP8_COMP *cpi, unsigned char *dest, unsigned char *dest_end, unsigned long *size);
702 void vp8_activity_masking(VP8_COMP *cpi, MACROBLOCK *x);
704 int rd_cost_intra_mb(MACROBLOCKD *x);
706 void vp8_tokenize_mb(VP8_COMP *, MACROBLOCKD *, TOKENEXTRA **);
708 void vp8_set_speed_features(VP8_COMP *cpi);
711 #define CHECK_MEM_ERROR(lval,expr) do {\
714 vpx_internal_error(&cpi->common.error, VPX_CODEC_MEM_ERROR,\
715 "Failed to allocate "#lval" at %s:%d", \
719 #define CHECK_MEM_ERROR(lval,expr) do {\
722 vpx_internal_error(&cpi->common.error, VPX_CODEC_MEM_ERROR,\
723 "Failed to allocate "#lval);\