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_ports/config.h"
18 #include "treewriter.h"
20 #include "onyxc_int.h"
26 #include "threading.h"
27 #include "vpx_ports/mem.h"
28 #include "vpx/internal/vpx_codec_internal.h"
30 #include "temporal_filter.h"
32 //#define SPEEDSTATS 1
33 #define MIN_GF_INTERVAL 4
34 #define DEFAULT_GF_INTERVAL 7
36 #define KEY_FRAME_CONTEXT 5
38 #define MAX_LAG_BUFFERS (CONFIG_REALTIME_ONLY? 1 : 25)
41 #define AF_THRESH2 100
42 #define ARF_DECAY_THRESH 12
45 #define MIN_THRESHMULT 32
46 #define MAX_THRESHMULT 512
48 #define GF_ZEROMV_ZBIN_BOOST 24
49 #define LF_ZEROMV_ZBIN_BOOST 12
50 #define MV_ZBIN_BOOST 4
51 #define ZBIN_OQ_MAX 192
53 #define VP8_TEMPORAL_ALT_REF 1
58 unsigned int frames_since_key;
59 unsigned int frames_since_golden;
61 int frames_till_gf_update_due;
62 int recent_ref_frame_usage[MAX_REF_FRAMES];
65 int mvcosts[2][MVvals+1];
72 int inter_y_modes[10];
73 int inter_uv_modes[4];
74 int inter_b_modes[10];
77 vp8_prob ymode_prob[4], uv_mode_prob[3]; /* interframe intra mode probs */
78 vp8_prob kf_ymode_prob[4], kf_uv_mode_prob[3]; /* keyframe "" */
80 int ymode_count[5], uv_mode_count[4]; /* intra MB type cts this frame */
82 int count_mb_ref_frame_usage[MAX_REF_FRAMES];
84 int this_frame_percent_intra;
85 int last_frame_percent_intra;
95 double ssim_weighted_pred_err;
98 double pcnt_second_ref;
105 double mv_in_out_count;
114 double frame_intra_error;
115 double frame_coded_error;
116 double frame_pcnt_inter;
117 double frame_pcnt_motion;
119 double frame_mvr_abs;
121 double frame_mvc_abs;
123 } ONEPASS_FRAMESTATS;
169 SEARCH_METHODS search_method;
174 int iterative_sub_pixel;
175 int half_pixel_search;
176 int quarter_pixel_search;
177 int thresh_mult[MAX_MODES];
181 int max_step_search_steps;
183 int optimize_coefficients;
185 int use_fastquant_for_pick;
194 int segment_counts[MAX_MB_SEGMENTS];
219 INT64 source_time_stamp;
220 INT64 source_end_time_stamp;
222 DECLARE_ALIGNED(16, YV12_BUFFER_CONFIG, source_buffer);
223 unsigned int source_frame_flags;
226 typedef struct VP8_ENCODER_RTCD
228 VP8_COMMON_RTCD *common;
229 vp8_variance_rtcd_vtable_t variance;
230 vp8_fdct_rtcd_vtable_t fdct;
231 vp8_encodemb_rtcd_vtable_t encodemb;
232 vp8_quantize_rtcd_vtable_t quantize;
233 vp8_search_rtcd_vtable_t search;
234 vp8_temporal_rtcd_vtable_t temporal;
251 } int_mv; /* facilitates rapid equality tests */
256 DECLARE_ALIGNED(16, short, Y1quant[QINDEX_RANGE][16]);
257 DECLARE_ALIGNED(16, short, Y1quant_shift[QINDEX_RANGE][16]);
258 DECLARE_ALIGNED(16, short, Y1zbin[QINDEX_RANGE][16]);
259 DECLARE_ALIGNED(16, short, Y1round[QINDEX_RANGE][16]);
261 DECLARE_ALIGNED(16, short, Y2quant[QINDEX_RANGE][16]);
262 DECLARE_ALIGNED(16, short, Y2quant_shift[QINDEX_RANGE][16]);
263 DECLARE_ALIGNED(16, short, Y2zbin[QINDEX_RANGE][16]);
264 DECLARE_ALIGNED(16, short, Y2round[QINDEX_RANGE][16]);
266 DECLARE_ALIGNED(16, short, UVquant[QINDEX_RANGE][16]);
267 DECLARE_ALIGNED(16, short, UVquant_shift[QINDEX_RANGE][16]);
268 DECLARE_ALIGNED(16, short, UVzbin[QINDEX_RANGE][16]);
269 DECLARE_ALIGNED(16, short, UVround[QINDEX_RANGE][16]);
271 DECLARE_ALIGNED(16, short, zrun_zbin_boost_y1[QINDEX_RANGE][16]);
272 DECLARE_ALIGNED(16, short, zrun_zbin_boost_y2[QINDEX_RANGE][16]);
273 DECLARE_ALIGNED(16, short, zrun_zbin_boost_uv[QINDEX_RANGE][16]);
274 DECLARE_ALIGNED(16, short, Y1quant_fast[QINDEX_RANGE][16]);
275 DECLARE_ALIGNED(16, short, Y2quant_fast[QINDEX_RANGE][16]);
276 DECLARE_ALIGNED(16, short, UVquant_fast[QINDEX_RANGE][16]);
286 YV12_BUFFER_CONFIG *Source;
287 YV12_BUFFER_CONFIG *un_scaled_source;
288 INT64 source_time_stamp;
289 INT64 source_end_time_stamp;
290 unsigned int source_frame_flags;
291 YV12_BUFFER_CONFIG scaled_source;
293 int source_buffer_count; // number of src_buffers in use for lagged encoding
294 int source_encode_index; // index of buffer in src_buffer to encode
295 int source_alt_ref_pending; // frame in src_buffers has been identified to be encoded as an alt ref
296 int source_alt_ref_active; // an alt ref frame has been encoded and is usable
298 int last_alt_ref_sei; // index into src_buffers of frame used as alt reference
299 int is_src_frame_alt_ref; // source of frame to encode is an exact copy of an alt ref frame
300 int is_next_src_alt_ref; // source of next frame to encode is an exact copy of an alt ref frame
302 int gold_is_last; // golden frame same as last frame ( short circuit gold searches)
303 int alt_is_last; // Alt reference frame same as last ( short circuit altref search)
304 int gold_is_alt; // don't do both alt and gold search ( just do gold).
306 //int refresh_alt_ref_frame;
307 SOURCE_SAMPLE src_buffer[MAX_LAG_BUFFERS];
309 YV12_BUFFER_CONFIG last_frame_uf;
314 unsigned int tok_count;
317 unsigned int frames_since_key;
318 unsigned int key_frame_frequency;
319 unsigned int next_key;
321 unsigned int mode_check_freq[MAX_MODES];
322 unsigned int mode_test_hit_counts[MAX_MODES];
323 unsigned int mode_chosen_counts[MAX_MODES];
324 unsigned int mbs_tested_so_far;
326 unsigned int check_freq[2];
327 unsigned int do_full[2];
329 int rd_thresh_mult[MAX_MODES];
330 int rd_baseline_thresh[MAX_MODES];
331 int rd_threshes[MAX_MODES];
333 int mvcostmultiplier;
334 int subseqblockweight;
336 unsigned int activity_avg;
343 int intra_mode_costs[10];
346 CODING_CONTEXT coding_context;
348 // Rate targetting variables
349 long long prediction_error;
350 long long last_prediction_error;
351 long long intra_error;
352 long long last_intra_error;
353 long long last_auto_filter_prediction_error;
356 // Experimental RD code
357 long long frame_distortion;
358 long long last_frame_distortion;
361 int last_mb_distortion;
363 int frames_since_auto_filter;
365 int this_frame_target;
366 int projected_frame_size;
367 int last_q[2]; // Separate values for Intra/Inter
368 int target_bits_per_mb;
370 double rate_correction_factor;
371 double key_frame_rate_correction_factor;
372 double gf_rate_correction_factor;
373 double est_max_qcorrection_factor;
375 int frames_till_gf_update_due; // Count down till next GF
376 int current_gf_interval; // GF interval chosen when we coded the last GF
378 int gf_overspend_bits; // Total bits overspent becasue of GF boost (cumulative)
380 int gf_group_bits; // Projected Bits available for a group of frames including 1 GF or ARF
381 int gf_bits; // Bits for the golden frame or ARF - 2 pass only
382 int mid_gf_extra_bits; // A few extra bits for the frame half way between two gfs.
384 // Projected total bits available for a key frame group of frames
385 long long kf_group_bits;
387 // Error score of frames still to be coded in kf group
388 long long kf_group_error_left;
390 // Bits for the key frame in a key frame group - 2 pass only
393 int non_gf_bitrate_adjustment; // Used in the few frames following a GF to recover the extra bits spent in that GF
394 int initial_gf_use; // percentage use of gf 2 frames after gf
396 int gf_group_error_left; // Remaining error from uncoded frames in a gf group. Two pass use only
398 int kf_overspend_bits; // Extra bits spent on key frames that need to be recovered on inter frames
399 int kf_bitrate_adjustment; // Current number of bit s to try and recover on each inter frame.
401 int baseline_gf_interval;
403 int active_arnr_frames; // <= cpi->oxcf.arnr_max_frames
405 INT64 key_frame_count;
406 INT64 tot_key_frame_bits;
407 int prior_key_frame_size[KEY_FRAME_CONTEXT];
408 int prior_key_frame_distance[KEY_FRAME_CONTEXT];
409 int per_frame_bandwidth; // Current section per frame bandwidth target
410 int av_per_frame_bandwidth; // Average frame size target for clip
411 int min_frame_bandwidth; // Minimum allocation that should be used for any frame
412 int last_key_frame_size;
413 int intra_frame_target;
414 int inter_frame_target;
415 double output_frame_rate;
416 long long last_time_stamp_seen;
417 long long last_end_time_stamp_seen;
418 long long first_time_stamp_ever;
423 int avg_frame_qindex;
427 int zbin_mode_boost_enabled;
429 INT64 total_byte_count;
436 int rolling_target_bits;
437 int rolling_actual_bits;
439 int long_rolling_target_bits;
440 int long_rolling_actual_bits;
442 long long total_actual_bits;
443 int total_target_vs_actual; // debug stats
446 int active_worst_quality;
448 int active_best_quality;
450 int drop_frames_allowed; // Are we permitted to drop frames?
451 int drop_frame; // Drop this frame?
452 int drop_count; // How many frames have we dropped?
453 int max_drop_count; // How many frames should we drop?
454 int max_consec_dropped_frames; // Limit number of consecutive frames that can be dropped.
457 int ymode_count [VP8_YMODES]; /* intra MB type cts this frame */
458 int uv_mode_count[VP8_UV_MODES]; /* intra MB type cts this frame */
460 unsigned int MVcount [2] [MVvals]; /* (row,col) MV cts this frame */
462 unsigned int coef_counts [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [vp8_coef_tokens]; /* for this frame */
463 //DECLARE_ALIGNED(16, int, coef_counts_backup [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [vp8_coef_tokens]); //not used any more
464 //save vp8_tree_probs_from_distribution result for each frame to avoid repeat calculation
465 vp8_prob frame_coef_probs [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [vp8_coef_tokens-1];
466 unsigned int frame_branch_ct [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [vp8_coef_tokens-1][2];
468 /* Second compressed data partition contains coefficient data. */
470 unsigned char *output_partition2;
471 size_t output_partition2size;
477 double total_error_left;
478 double total_intra_error_left;
479 double total_coded_error_left;
480 double start_tot_err_left;
483 double modified_error_total;
484 double modified_error_used;
485 double modified_error_left;
491 int target_bandwidth;
493 long long clip_bits_total;
494 FIRSTPASS_STATS *total_stats;
495 FIRSTPASS_STATS *this_frame_stats;
496 FIRSTPASS_STATS *stats_in, *stats_in_end;
497 struct vpx_codec_pkt_list *output_pkt_list;
499 unsigned char *fp_motion_map;
501 unsigned char *fp_motion_map_stats, *fp_motion_map_stats_save;
504 // Experimental code for lagged and one pass
505 ONEPASS_FRAMESTATS one_pass_frame_stats[MAX_LAG_BUFFERS];
506 int one_pass_frame_index;
509 int decimation_factor;
510 int decimation_count;
512 // for real time encoding
513 int avg_encode_time; //microsecond
514 int avg_pick_mode_time; //microsecond
516 unsigned int cpu_freq; //Mhz
517 int compressor_speed;
521 int auto_adjust_gold_quantizer;
524 int auto_adjust_key_quantizer;
535 int prob_intra_coded;
539 int last_skip_false_probs[3];
540 int last_skip_probs_q[3];
541 int recent_ref_frame_usage[MAX_REF_FRAMES];
543 int count_mb_ref_frame_usage[MAX_REF_FRAMES];
544 int this_frame_percent_intra;
545 int last_frame_percent_intra;
547 int last_key_frame_q;
555 int error_bins[1024];
562 unsigned int next_iiratio;
563 unsigned int this_iiratio;
564 int this_frame_modified_error;
566 double norm_intra_err_per_mb;
567 double norm_inter_err_per_mb;
568 double norm_iidiff_per_mb;
570 int last_best_mode_index; // Record of mode index chosen for previous macro block.
571 int last_auto_filt_val;
572 int last_auto_filt_q;
574 // Data used for real time conferencing mode to help determine if it would be good to update the gf
577 int gf_update_recommended;
579 int skip_false_count;
583 int ready_for_new_frame;
585 unsigned char *segmentation_map;
586 signed char segment_feature_data[MB_LVL_MAX][MAX_MB_SEGMENTS]; // Segment data (can be deltas or absolute values)
587 int segment_encode_breakout[MAX_MB_SEGMENTS]; // segment threashold for encode breakout
589 unsigned char *active_map;
590 unsigned int active_map_enabled;
591 // Video conferencing cyclic refresh mode flags etc
592 // This is a mode designed to clean up the background over time in live encoding scenarious. It uses segmentation
593 int cyclic_refresh_mode_enabled;
594 int cyclic_refresh_mode_max_mbs_perframe;
595 int cyclic_refresh_mode_index;
596 int cyclic_refresh_q;
597 signed char *cyclic_refresh_map;
600 int current_mb_col_main;
601 int processor_core_count;
602 int b_multi_threaded;
603 int encoding_thread_count;
605 #if CONFIG_MULTITHREAD
606 pthread_t *h_encoding_thread;
608 MB_ROW_COMP *mb_row_ei;
609 ENCODETHREAD_DATA *en_thread_data;
611 #if CONFIG_MULTITHREAD
613 sem_t *h_event_mbrencoding;
618 // end of multithread data
621 fractional_mv_step_fp *find_fractional_mv_step;
622 vp8_full_search_fn_t full_search_sad;
623 vp8_diamond_search_fn_t diamond_search_sad;
624 vp8_variance_fn_ptr_t fn_ptr[BLOCK_MAX_SEGMENTS];
625 unsigned int time_receive_data;
626 unsigned int time_compress_data;
627 unsigned int time_pick_lpf;
628 unsigned int time_encode_mb_row;
630 unsigned int tempdata1;
631 unsigned int tempdata2;
633 int base_skip_false_prob[128];
634 unsigned int section_intra_rating;
636 double section_max_qfactor;
639 #if CONFIG_RUNTIME_CPU_DETECT
640 VP8_ENCODER_RTCD rtcd;
642 #if VP8_TEMPORAL_ALT_REF
643 SOURCE_SAMPLE alt_ref_buffer;
644 YV12_BUFFER_CONFIG *frames[MAX_LAG_BUFFERS];
645 int fixed_divide[512];
647 // Flag to indicate temporal filter method
648 int use_weighted_temporal_filter;
656 double total_sq_error;
661 double total_sq_error2;
663 double summed_quality;
664 double summed_weights;
665 unsigned int tot_recode_hits;
668 double total_ssimg_y;
669 double total_ssimg_u;
670 double total_ssimg_v;
671 double total_ssimg_all;
673 int b_calculate_ssimg;
675 int b_calculate_psnr;
678 unsigned char *gf_active_flags; // Record of which MBs still refer to last golden frame either directly or through 0,0
681 //Store last frame's MV info for next frame MV prediction
683 int *lf_ref_frame_sign_bias;
688 void control_data_rate(VP8_COMP *cpi);
690 void vp8_encode_frame(VP8_COMP *cpi);
692 void vp8_pack_bitstream(VP8_COMP *cpi, unsigned char *dest, unsigned long *size);
694 unsigned int vp8_activity_masking(VP8_COMP *cpi, MACROBLOCK *x);
696 int rd_cost_intra_mb(MACROBLOCKD *x);
698 void vp8_tokenize_mb(VP8_COMP *, MACROBLOCKD *, TOKENEXTRA **);
700 void vp8_set_speed_features(VP8_COMP *cpi);
703 #define CHECK_MEM_ERROR(lval,expr) do {\
706 vpx_internal_error(&cpi->common.error, VPX_CODEC_MEM_ERROR,\
707 "Failed to allocate "#lval" at %s:%d", \
711 #define CHECK_MEM_ERROR(lval,expr) do {\
714 vpx_internal_error(&cpi->common.error, VPX_CODEC_MEM_ERROR,\
715 "Failed to allocate "#lval);\