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"
31 #include "findnearmv.h"
33 //#define SPEEDSTATS 1
34 #define MIN_GF_INTERVAL 4
35 #define DEFAULT_GF_INTERVAL 7
37 #define KEY_FRAME_CONTEXT 5
39 #define MAX_LAG_BUFFERS (CONFIG_REALTIME_ONLY? 1 : 25)
42 #define AF_THRESH2 100
43 #define ARF_DECAY_THRESH 12
46 #define MIN_THRESHMULT 32
47 #define MAX_THRESHMULT 512
49 #define GF_ZEROMV_ZBIN_BOOST 24
50 #define LF_ZEROMV_ZBIN_BOOST 12
51 #define MV_ZBIN_BOOST 4
52 #define ZBIN_OQ_MAX 192
54 #define VP8_TEMPORAL_ALT_REF 1
59 unsigned int frames_since_key;
60 unsigned int frames_since_golden;
62 int frames_till_gf_update_due;
63 int recent_ref_frame_usage[MAX_REF_FRAMES];
66 int mvcosts[2][MVvals+1];
73 int inter_y_modes[10];
74 int inter_uv_modes[4];
75 int inter_b_modes[10];
78 vp8_prob ymode_prob[4], uv_mode_prob[3]; /* interframe intra mode probs */
79 vp8_prob kf_ymode_prob[4], kf_uv_mode_prob[3]; /* keyframe "" */
81 int ymode_count[5], uv_mode_count[4]; /* intra MB type cts this frame */
83 int count_mb_ref_frame_usage[MAX_REF_FRAMES];
85 int this_frame_percent_intra;
86 int last_frame_percent_intra;
96 double ssim_weighted_pred_err;
99 double pcnt_second_ref;
106 double mv_in_out_count;
115 double frame_intra_error;
116 double frame_coded_error;
117 double frame_pcnt_inter;
118 double frame_pcnt_motion;
120 double frame_mvr_abs;
122 double frame_mvc_abs;
124 } ONEPASS_FRAMESTATS;
170 SEARCH_METHODS search_method;
175 int iterative_sub_pixel;
176 int half_pixel_search;
177 int quarter_pixel_search;
178 int thresh_mult[MAX_MODES];
182 int max_step_search_steps;
184 int optimize_coefficients;
186 int use_fastquant_for_pick;
187 int no_skip_block4x4_search;
194 int segment_counts[MAX_MB_SEGMENTS];
218 INT64 source_time_stamp;
219 INT64 source_end_time_stamp;
221 DECLARE_ALIGNED(16, YV12_BUFFER_CONFIG, source_buffer);
222 unsigned int source_frame_flags;
225 typedef struct VP8_ENCODER_RTCD
227 VP8_COMMON_RTCD *common;
228 vp8_variance_rtcd_vtable_t variance;
229 vp8_fdct_rtcd_vtable_t fdct;
230 vp8_encodemb_rtcd_vtable_t encodemb;
231 vp8_quantize_rtcd_vtable_t quantize;
232 vp8_search_rtcd_vtable_t search;
233 vp8_temporal_rtcd_vtable_t temporal;
249 DECLARE_ALIGNED(16, short, Y1quant[QINDEX_RANGE][16]);
250 DECLARE_ALIGNED(16, short, Y1quant_shift[QINDEX_RANGE][16]);
251 DECLARE_ALIGNED(16, short, Y1zbin[QINDEX_RANGE][16]);
252 DECLARE_ALIGNED(16, short, Y1round[QINDEX_RANGE][16]);
254 DECLARE_ALIGNED(16, short, Y2quant[QINDEX_RANGE][16]);
255 DECLARE_ALIGNED(16, short, Y2quant_shift[QINDEX_RANGE][16]);
256 DECLARE_ALIGNED(16, short, Y2zbin[QINDEX_RANGE][16]);
257 DECLARE_ALIGNED(16, short, Y2round[QINDEX_RANGE][16]);
259 DECLARE_ALIGNED(16, short, UVquant[QINDEX_RANGE][16]);
260 DECLARE_ALIGNED(16, short, UVquant_shift[QINDEX_RANGE][16]);
261 DECLARE_ALIGNED(16, short, UVzbin[QINDEX_RANGE][16]);
262 DECLARE_ALIGNED(16, short, UVround[QINDEX_RANGE][16]);
264 DECLARE_ALIGNED(16, short, zrun_zbin_boost_y1[QINDEX_RANGE][16]);
265 DECLARE_ALIGNED(16, short, zrun_zbin_boost_y2[QINDEX_RANGE][16]);
266 DECLARE_ALIGNED(16, short, zrun_zbin_boost_uv[QINDEX_RANGE][16]);
267 DECLARE_ALIGNED(16, short, Y1quant_fast[QINDEX_RANGE][16]);
268 DECLARE_ALIGNED(16, short, Y2quant_fast[QINDEX_RANGE][16]);
269 DECLARE_ALIGNED(16, short, UVquant_fast[QINDEX_RANGE][16]);
279 YV12_BUFFER_CONFIG *Source;
280 YV12_BUFFER_CONFIG *un_scaled_source;
281 INT64 source_time_stamp;
282 INT64 source_end_time_stamp;
283 unsigned int source_frame_flags;
284 YV12_BUFFER_CONFIG scaled_source;
286 int source_buffer_count; // number of src_buffers in use for lagged encoding
287 int source_encode_index; // index of buffer in src_buffer to encode
288 int source_alt_ref_pending; // frame in src_buffers has been identified to be encoded as an alt ref
289 int source_alt_ref_active; // an alt ref frame has been encoded and is usable
291 int last_alt_ref_sei; // index into src_buffers of frame used as alt reference
292 int is_src_frame_alt_ref; // source of frame to encode is an exact copy of an alt ref frame
293 int is_next_src_alt_ref; // source of next frame to encode is an exact copy of an alt ref frame
295 int gold_is_last; // golden frame same as last frame ( short circuit gold searches)
296 int alt_is_last; // Alt reference frame same as last ( short circuit altref search)
297 int gold_is_alt; // don't do both alt and gold search ( just do gold).
299 //int refresh_alt_ref_frame;
300 SOURCE_SAMPLE src_buffer[MAX_LAG_BUFFERS];
302 YV12_BUFFER_CONFIG last_frame_uf;
305 unsigned int tok_count;
308 unsigned int frames_since_key;
309 unsigned int key_frame_frequency;
310 unsigned int this_key_frame_forced;
311 unsigned int next_key_frame_forced;
313 // Ambient reconstruction err target for force key frames
316 unsigned int mode_check_freq[MAX_MODES];
317 unsigned int mode_test_hit_counts[MAX_MODES];
318 unsigned int mode_chosen_counts[MAX_MODES];
319 unsigned int mbs_tested_so_far;
321 unsigned int check_freq[2];
322 unsigned int do_full[2];
324 int rd_thresh_mult[MAX_MODES];
325 int rd_baseline_thresh[MAX_MODES];
326 int rd_threshes[MAX_MODES];
328 int mvcostmultiplier;
329 int subseqblockweight;
331 unsigned int activity_avg;
336 CODING_CONTEXT coding_context;
338 // Rate targetting variables
339 long long prediction_error;
340 long long last_prediction_error;
341 long long intra_error;
342 long long last_intra_error;
345 // Experimental RD code
346 long long frame_distortion;
347 long long last_frame_distortion;
350 int last_mb_distortion;
352 int frames_since_auto_filter;
354 int this_frame_target;
355 int projected_frame_size;
356 int last_q[2]; // Separate values for Intra/Inter
358 double rate_correction_factor;
359 double key_frame_rate_correction_factor;
360 double gf_rate_correction_factor;
361 double est_max_qcorrection_factor;
363 int frames_till_gf_update_due; // Count down till next GF
364 int current_gf_interval; // GF interval chosen when we coded the last GF
366 int gf_overspend_bits; // Total bits overspent becasue of GF boost (cumulative)
368 int gf_group_bits; // Projected Bits available for a group of frames including 1 GF or ARF
369 int gf_bits; // Bits for the golden frame or ARF - 2 pass only
370 int mid_gf_extra_bits; // A few extra bits for the frame half way between two gfs.
372 // Projected total bits available for a key frame group of frames
373 long long kf_group_bits;
375 // Error score of frames still to be coded in kf group
376 long long kf_group_error_left;
378 // Bits for the key frame in a key frame group - 2 pass only
381 int non_gf_bitrate_adjustment; // Used in the few frames following a GF to recover the extra bits spent in that GF
382 int initial_gf_use; // percentage use of gf 2 frames after gf
384 int gf_group_error_left; // Remaining error from uncoded frames in a gf group. Two pass use only
386 int kf_overspend_bits; // Extra bits spent on key frames that need to be recovered on inter frames
387 int kf_bitrate_adjustment; // Current number of bit s to try and recover on each inter frame.
389 int static_scene_max_gf_interval;
390 int baseline_gf_interval;
392 int active_arnr_frames; // <= cpi->oxcf.arnr_max_frames
394 INT64 key_frame_count;
395 INT64 tot_key_frame_bits;
396 int prior_key_frame_size[KEY_FRAME_CONTEXT];
397 int prior_key_frame_distance[KEY_FRAME_CONTEXT];
398 int per_frame_bandwidth; // Current section per frame bandwidth target
399 int av_per_frame_bandwidth; // Average frame size target for clip
400 int min_frame_bandwidth; // Minimum allocation that should be used for any frame
401 int last_key_frame_size;
402 int intra_frame_target;
403 int inter_frame_target;
404 double output_frame_rate;
405 long long last_time_stamp_seen;
406 long long last_end_time_stamp_seen;
407 long long first_time_stamp_ever;
412 int avg_frame_qindex;
416 int zbin_mode_boost_enabled;
418 INT64 total_byte_count;
425 int rolling_target_bits;
426 int rolling_actual_bits;
428 int long_rolling_target_bits;
429 int long_rolling_actual_bits;
431 long long total_actual_bits;
432 int total_target_vs_actual; // debug stats
435 int active_worst_quality;
437 int active_best_quality;
439 int cq_target_quality;
443 int drop_frames_allowed; // Are we permitted to drop frames?
444 int drop_frame; // Drop this frame?
445 int drop_count; // How many frames have we dropped?
446 int max_drop_count; // How many frames should we drop?
447 int max_consec_dropped_frames; // Limit number of consecutive frames that can be dropped.
450 int ymode_count [VP8_YMODES]; /* intra MB type cts this frame */
451 int uv_mode_count[VP8_UV_MODES]; /* intra MB type cts this frame */
453 unsigned int MVcount [2] [MVvals]; /* (row,col) MV cts this frame */
455 unsigned int coef_counts [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [vp8_coef_tokens]; /* for this frame */
456 //DECLARE_ALIGNED(16, int, coef_counts_backup [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [vp8_coef_tokens]); //not used any more
457 //save vp8_tree_probs_from_distribution result for each frame to avoid repeat calculation
458 vp8_prob frame_coef_probs [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [vp8_coef_tokens-1];
459 unsigned int frame_branch_ct [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [vp8_coef_tokens-1][2];
461 /* Second compressed data partition contains coefficient data. */
463 unsigned char *output_partition2;
464 size_t output_partition2size;
470 double total_error_left;
471 double total_intra_error_left;
472 double total_coded_error_left;
473 double start_tot_err_left;
475 double kf_intra_err_min;
476 double gf_intra_err_min;
478 double modified_error_total;
479 double modified_error_used;
480 double modified_error_left;
486 int target_bandwidth;
488 long long clip_bits_total;
489 FIRSTPASS_STATS *total_stats;
490 FIRSTPASS_STATS *this_frame_stats;
491 FIRSTPASS_STATS *stats_in, *stats_in_end;
492 struct vpx_codec_pkt_list *output_pkt_list;
494 unsigned char *fp_motion_map;
496 unsigned char *fp_motion_map_stats, *fp_motion_map_stats_save;
499 // Experimental code for lagged and one pass
500 ONEPASS_FRAMESTATS one_pass_frame_stats[MAX_LAG_BUFFERS];
501 int one_pass_frame_index;
504 int decimation_factor;
505 int decimation_count;
507 // for real time encoding
508 int avg_encode_time; //microsecond
509 int avg_pick_mode_time; //microsecond
511 unsigned int cpu_freq; //Mhz
512 int compressor_speed;
516 int auto_adjust_gold_quantizer;
519 int auto_adjust_key_quantizer;
530 int prob_intra_coded;
534 int last_skip_false_probs[3];
535 int last_skip_probs_q[3];
536 int recent_ref_frame_usage[MAX_REF_FRAMES];
538 int count_mb_ref_frame_usage[MAX_REF_FRAMES];
539 int this_frame_percent_intra;
540 int last_frame_percent_intra;
542 int last_key_frame_q;
548 int error_bins[1024];
555 unsigned int next_iiratio;
556 unsigned int this_iiratio;
557 int this_frame_modified_error;
559 double norm_intra_err_per_mb;
560 double norm_inter_err_per_mb;
561 double norm_iidiff_per_mb;
563 int last_best_mode_index; // Record of mode index chosen for previous macro block.
564 int last_auto_filt_val;
565 int last_auto_filt_q;
567 // Data used for real time conferencing mode to help determine if it would be good to update the gf
570 int gf_update_recommended;
572 int skip_false_count;
576 int ready_for_new_frame;
578 unsigned char *segmentation_map;
579 signed char segment_feature_data[MB_LVL_MAX][MAX_MB_SEGMENTS]; // Segment data (can be deltas or absolute values)
580 int segment_encode_breakout[MAX_MB_SEGMENTS]; // segment threashold for encode breakout
582 unsigned char *active_map;
583 unsigned int active_map_enabled;
584 // Video conferencing cyclic refresh mode flags etc
585 // This is a mode designed to clean up the background over time in live encoding scenarious. It uses segmentation
586 int cyclic_refresh_mode_enabled;
587 int cyclic_refresh_mode_max_mbs_perframe;
588 int cyclic_refresh_mode_index;
589 int cyclic_refresh_q;
590 signed char *cyclic_refresh_map;
593 int * mt_current_mb_col;
595 int processor_core_count;
596 int b_multi_threaded;
597 int encoding_thread_count;
599 #if CONFIG_MULTITHREAD
600 pthread_t *h_encoding_thread;
602 MB_ROW_COMP *mb_row_ei;
603 ENCODETHREAD_DATA *en_thread_data;
605 #if CONFIG_MULTITHREAD
607 sem_t *h_event_start_encoding;
608 sem_t h_event_end_encoding;
612 // end of multithread data
615 fractional_mv_step_fp *find_fractional_mv_step;
616 vp8_full_search_fn_t full_search_sad;
617 vp8_diamond_search_fn_t diamond_search_sad;
618 vp8_variance_fn_ptr_t fn_ptr[BLOCK_MAX_SEGMENTS];
619 unsigned int time_receive_data;
620 unsigned int time_compress_data;
621 unsigned int time_pick_lpf;
622 unsigned int time_encode_mb_row;
624 unsigned int tempdata1;
625 unsigned int tempdata2;
627 int base_skip_false_prob[128];
628 unsigned int section_intra_rating;
630 double section_max_qfactor;
633 #if CONFIG_RUNTIME_CPU_DETECT
634 VP8_ENCODER_RTCD rtcd;
636 #if VP8_TEMPORAL_ALT_REF
637 SOURCE_SAMPLE alt_ref_buffer;
638 YV12_BUFFER_CONFIG *frames[MAX_LAG_BUFFERS];
639 int fixed_divide[512];
641 // Flag to indicate temporal filter method
642 int use_weighted_temporal_filter;
650 double total_sq_error;
655 double total_sq_error2;
657 double summed_quality;
658 double summed_weights;
659 unsigned int tot_recode_hits;
662 double total_ssimg_y;
663 double total_ssimg_u;
664 double total_ssimg_v;
665 double total_ssimg_all;
667 int b_calculate_ssimg;
669 int b_calculate_psnr;
672 unsigned char *gf_active_flags; // Record of which MBs still refer to last golden frame either directly or through 0,0
675 //Store last frame's MV info for next frame MV prediction
677 int *lf_ref_frame_sign_bias;
680 #if CONFIG_REALTIME_ONLY
681 int force_next_frame_intra; /* force next frame to intra when kf_auto says so */
685 void control_data_rate(VP8_COMP *cpi);
687 void vp8_encode_frame(VP8_COMP *cpi);
689 void vp8_pack_bitstream(VP8_COMP *cpi, unsigned char *dest, unsigned long *size);
691 unsigned int vp8_activity_masking(VP8_COMP *cpi, MACROBLOCK *x);
693 int rd_cost_intra_mb(MACROBLOCKD *x);
695 void vp8_tokenize_mb(VP8_COMP *, MACROBLOCKD *, TOKENEXTRA **);
697 void vp8_set_speed_features(VP8_COMP *cpi);
700 #define CHECK_MEM_ERROR(lval,expr) do {\
703 vpx_internal_error(&cpi->common.error, VPX_CODEC_MEM_ERROR,\
704 "Failed to allocate "#lval" at %s:%d", \
708 #define CHECK_MEM_ERROR(lval,expr) do {\
711 vpx_internal_error(&cpi->common.error, VPX_CODEC_MEM_ERROR,\
712 "Failed to allocate "#lval);\