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"
31 //#define SPEEDSTATS 1
32 #define MIN_GF_INTERVAL 4
33 #define DEFAULT_GF_INTERVAL 7
35 #define KEY_FRAME_CONTEXT 5
37 #define MAX_LAG_BUFFERS (CONFIG_REALTIME_ONLY? 1 : 25)
40 #define AF_THRESH2 100
41 #define ARF_DECAY_THRESH 12
44 #define MIN_THRESHMULT 32
45 #define MAX_THRESHMULT 512
47 #define GF_ZEROMV_ZBIN_BOOST 24
48 #define LF_ZEROMV_ZBIN_BOOST 12
49 #define MV_ZBIN_BOOST 4
50 #define ZBIN_OQ_MAX 192
52 #define VP8_TEMPORAL_ALT_REF 1
57 unsigned int frames_since_key;
58 unsigned int frames_since_golden;
60 int frames_till_gf_update_due;
61 int recent_ref_frame_usage[MAX_REF_FRAMES];
64 int mvcosts[2][MVvals+1];
71 int inter_y_modes[10];
72 int inter_uv_modes[4];
73 int inter_b_modes[10];
76 vp8_prob ymode_prob[4], uv_mode_prob[3]; /* interframe intra mode probs */
77 vp8_prob kf_ymode_prob[4], kf_uv_mode_prob[3]; /* keyframe "" */
79 int ymode_count[5], uv_mode_count[4]; /* intra MB type cts this frame */
81 int count_mb_ref_frame_usage[MAX_REF_FRAMES];
83 int this_frame_percent_intra;
84 int last_frame_percent_intra;
94 double ssim_weighted_pred_err;
97 double pcnt_second_ref;
104 double mv_in_out_count;
113 double frame_intra_error;
114 double frame_coded_error;
115 double frame_pcnt_inter;
116 double frame_pcnt_motion;
118 double frame_mvr_abs;
120 double frame_mvc_abs;
122 } ONEPASS_FRAMESTATS;
168 SEARCH_METHODS search_method;
173 int iterative_sub_pixel;
174 int half_pixel_search;
175 int quarter_pixel_search;
176 int thresh_mult[MAX_MODES];
180 int max_step_search_steps;
182 int optimize_coefficients;
191 int segment_counts[MAX_MB_SEGMENTS];
216 INT64 source_time_stamp;
217 INT64 source_end_time_stamp;
219 DECLARE_ALIGNED(16, YV12_BUFFER_CONFIG, source_buffer);
220 unsigned int source_frame_flags;
223 typedef struct VP8_ENCODER_RTCD
225 VP8_COMMON_RTCD *common;
226 vp8_variance_rtcd_vtable_t variance;
227 vp8_fdct_rtcd_vtable_t fdct;
228 vp8_encodemb_rtcd_vtable_t encodemb;
229 vp8_quantize_rtcd_vtable_t quantize;
230 vp8_search_rtcd_vtable_t search;
247 } int_mv; /* facilitates rapid equality tests */
252 DECLARE_ALIGNED(16, short, Y1quant[QINDEX_RANGE][16]);
253 DECLARE_ALIGNED(16, short, Y1quant_shift[QINDEX_RANGE][16]);
254 DECLARE_ALIGNED(16, short, Y1zbin[QINDEX_RANGE][16]);
255 DECLARE_ALIGNED(16, short, Y1round[QINDEX_RANGE][16]);
257 DECLARE_ALIGNED(16, short, Y2quant[QINDEX_RANGE][16]);
258 DECLARE_ALIGNED(16, short, Y2quant_shift[QINDEX_RANGE][16]);
259 DECLARE_ALIGNED(16, short, Y2zbin[QINDEX_RANGE][16]);
260 DECLARE_ALIGNED(16, short, Y2round[QINDEX_RANGE][16]);
262 DECLARE_ALIGNED(16, short, UVquant[QINDEX_RANGE][16]);
263 DECLARE_ALIGNED(16, short, UVquant_shift[QINDEX_RANGE][16]);
264 DECLARE_ALIGNED(16, short, UVzbin[QINDEX_RANGE][16]);
265 DECLARE_ALIGNED(16, short, UVround[QINDEX_RANGE][16]);
267 DECLARE_ALIGNED(16, short, zrun_zbin_boost_y1[QINDEX_RANGE][16]);
268 DECLARE_ALIGNED(16, short, zrun_zbin_boost_y2[QINDEX_RANGE][16]);
269 DECLARE_ALIGNED(16, short, zrun_zbin_boost_uv[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;
307 unsigned int tok_count;
310 unsigned int frames_since_key;
311 unsigned int key_frame_frequency;
312 unsigned int next_key;
314 unsigned int mode_check_freq[MAX_MODES];
315 unsigned int mode_test_hit_counts[MAX_MODES];
316 unsigned int mode_chosen_counts[MAX_MODES];
317 unsigned int mbs_tested_so_far;
319 unsigned int check_freq[2];
320 unsigned int do_full[2];
322 int rd_thresh_mult[MAX_MODES];
323 int rd_baseline_thresh[MAX_MODES];
324 int rd_threshes[MAX_MODES];
326 int mvcostmultiplier;
327 int subseqblockweight;
329 unsigned int activity_avg;
336 int intra_mode_costs[10];
339 CODING_CONTEXT coding_context;
341 // Rate targetting variables
342 long long prediction_error;
343 long long last_prediction_error;
344 long long intra_error;
345 long long last_intra_error;
346 long long last_auto_filter_prediction_error;
349 // Experimental RD code
350 long long frame_distortion;
351 long long last_frame_distortion;
354 int last_mb_distortion;
356 int frames_since_auto_filter;
358 int this_frame_target;
359 int projected_frame_size;
360 int last_q[2]; // Separate values for Intra/Inter
361 int target_bits_per_mb;
363 double rate_correction_factor;
364 double key_frame_rate_correction_factor;
365 double gf_rate_correction_factor;
366 double est_max_qcorrection_factor;
368 int frames_till_gf_update_due; // Count down till next GF
369 int current_gf_interval; // GF interval chosen when we coded the last GF
371 int gf_overspend_bits; // Total bits overspent becasue of GF boost (cumulative)
373 int gf_group_bits; // Projected Bits available for a group of frames including 1 GF or ARF
374 int gf_bits; // Bits for the golden frame or ARF - 2 pass only
375 int mid_gf_extra_bits; // A few extra bits for the frame half way between two gfs.
377 // Projected total bits available for a key frame group of frames
378 long long kf_group_bits;
380 // Error score of frames still to be coded in kf group
381 long long kf_group_error_left;
383 // Bits for the key frame in a key frame group - 2 pass only
386 int non_gf_bitrate_adjustment; // Used in the few frames following a GF to recover the extra bits spent in that GF
387 int initial_gf_use; // percentage use of gf 2 frames after gf
389 int gf_group_error_left; // Remaining error from uncoded frames in a gf group. Two pass use only
391 int kf_overspend_bits; // Extra bits spent on key frames that need to be recovered on inter frames
392 int kf_bitrate_adjustment; // Current number of bit s to try and recover on each inter frame.
394 int baseline_gf_interval;
396 int active_arnr_frames; // <= cpi->oxcf.arnr_max_frames
398 INT64 key_frame_count;
399 INT64 tot_key_frame_bits;
400 int prior_key_frame_size[KEY_FRAME_CONTEXT];
401 int prior_key_frame_distance[KEY_FRAME_CONTEXT];
402 int per_frame_bandwidth; // Current section per frame bandwidth target
403 int av_per_frame_bandwidth; // Average frame size target for clip
404 int min_frame_bandwidth; // Minimum allocation that should be used for any frame
405 int last_key_frame_size;
406 int intra_frame_target;
407 int inter_frame_target;
408 double output_frame_rate;
409 long long last_time_stamp_seen;
410 long long last_end_time_stamp_seen;
411 long long first_time_stamp_ever;
416 int avg_frame_qindex;
420 int zbin_mode_boost_enabled;
422 INT64 total_byte_count;
429 int rolling_target_bits;
430 int rolling_actual_bits;
432 int long_rolling_target_bits;
433 int long_rolling_actual_bits;
435 long long total_actual_bits;
436 int total_target_vs_actual; // debug stats
439 int active_worst_quality;
441 int active_best_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;
476 double modified_error_total;
477 double modified_error_used;
478 double modified_error_left;
484 int target_bandwidth;
486 long long clip_bits_total;
487 FIRSTPASS_STATS *total_stats;
488 FIRSTPASS_STATS *this_frame_stats;
489 FIRSTPASS_STATS *stats_in, *stats_in_end;
490 struct vpx_codec_pkt_list *output_pkt_list;
492 unsigned char *fp_motion_map;
494 unsigned char *fp_motion_map_stats, *fp_motion_map_stats_save;
497 // Experimental code for lagged and one pass
498 ONEPASS_FRAMESTATS one_pass_frame_stats[MAX_LAG_BUFFERS];
499 int one_pass_frame_index;
502 int decimation_factor;
503 int decimation_count;
505 // for real time encoding
506 int avg_encode_time; //microsecond
507 int avg_pick_mode_time; //microsecond
509 unsigned int cpu_freq; //Mhz
510 int compressor_speed;
514 int auto_adjust_gold_quantizer;
517 int auto_adjust_key_quantizer;
528 int prob_intra_coded;
532 int last_skip_false_probs[3];
533 int last_skip_probs_q[3];
534 int recent_ref_frame_usage[MAX_REF_FRAMES];
536 int count_mb_ref_frame_usage[MAX_REF_FRAMES];
537 int this_frame_percent_intra;
538 int last_frame_percent_intra;
540 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 current_mb_col_main;
594 int processor_core_count;
595 int b_multi_threaded;
596 int encoding_thread_count;
598 #if CONFIG_MULTITHREAD
599 pthread_t *h_encoding_thread;
601 MB_ROW_COMP *mb_row_ei;
602 ENCODETHREAD_DATA *en_thread_data;
604 #if CONFIG_MULTITHREAD
606 sem_t *h_event_mbrencoding;
611 // end of multithread data
614 fractional_mv_step_fp *find_fractional_mv_step;
615 vp8_full_search_fn_t full_search_sad;
616 vp8_diamond_search_fn_t diamond_search_sad;
617 vp8_variance_fn_ptr_t fn_ptr[BLOCK_MAX_SEGMENTS];
618 unsigned int time_receive_data;
619 unsigned int time_compress_data;
620 unsigned int time_pick_lpf;
621 unsigned int time_encode_mb_row;
623 unsigned int tempdata1;
624 unsigned int tempdata2;
626 int base_skip_false_prob[128];
627 unsigned int section_intra_rating;
629 double section_max_qfactor;
632 #if CONFIG_RUNTIME_CPU_DETECT
633 VP8_ENCODER_RTCD rtcd;
635 #if VP8_TEMPORAL_ALT_REF
636 SOURCE_SAMPLE alt_ref_buffer;
637 YV12_BUFFER_CONFIG *frames[MAX_LAG_BUFFERS];
638 int fixed_divide[512];
640 // Flag to indicate temporal filter method
641 int use_weighted_temporal_filter;
649 double total_sq_error;
654 double total_sq_error2;
656 double summed_quality;
657 double summed_weights;
658 unsigned int tot_recode_hits;
661 double total_ssimg_y;
662 double total_ssimg_u;
663 double total_ssimg_v;
664 double total_ssimg_all;
666 int b_calculate_ssimg;
668 int b_calculate_psnr;
671 unsigned char *gf_active_flags; // Record of which MBs still refer to last golden frame either directly or through 0,0
674 //Store last frame's MV info for next frame MV prediction
676 int *lf_ref_frame_sign_bias;
681 void control_data_rate(VP8_COMP *cpi);
683 void vp8_encode_frame(VP8_COMP *cpi);
685 void vp8_pack_bitstream(VP8_COMP *cpi, unsigned char *dest, unsigned long *size);
687 unsigned int vp8_activity_masking(VP8_COMP *cpi, MACROBLOCK *x);
689 int rd_cost_intra_mb(MACROBLOCKD *x);
691 void vp8_tokenize_mb(VP8_COMP *, MACROBLOCKD *, TOKENEXTRA **);
693 void vp8_set_speed_features(VP8_COMP *cpi);
696 #define CHECK_MEM_ERROR(lval,expr) do {\
699 vpx_internal_error(&cpi->common.error, VPX_CODEC_MEM_ERROR,\
700 "Failed to allocate "#lval" at %s:%d", \
704 #define CHECK_MEM_ERROR(lval,expr) do {\
707 vpx_internal_error(&cpi->common.error, VPX_CODEC_MEM_ERROR,\
708 "Failed to allocate "#lval);\