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"
27 #include "threading.h"
28 #include "vpx_ports/mem.h"
29 #include "vpx/internal/vpx_codec_internal.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;
192 int segment_counts[MAX_MB_SEGMENTS];
217 INT64 source_time_stamp;
218 INT64 source_end_time_stamp;
220 DECLARE_ALIGNED(16, YV12_BUFFER_CONFIG, source_buffer);
221 unsigned int source_frame_flags;
224 typedef struct VP8_ENCODER_RTCD
226 VP8_COMMON_RTCD *common;
227 vp8_variance_rtcd_vtable_t variance;
228 vp8_fdct_rtcd_vtable_t fdct;
229 vp8_encodemb_rtcd_vtable_t encodemb;
230 vp8_quantize_rtcd_vtable_t quantize;
231 vp8_search_rtcd_vtable_t search;
248 } int_mv; /* facilitates rapid equality tests */
253 DECLARE_ALIGNED(16, short, Y1quant[QINDEX_RANGE][16]);
254 DECLARE_ALIGNED(16, short, Y1quant_shift[QINDEX_RANGE][16]);
255 DECLARE_ALIGNED(16, short, Y1zbin[QINDEX_RANGE][16]);
256 DECLARE_ALIGNED(16, short, Y1round[QINDEX_RANGE][16]);
258 DECLARE_ALIGNED(16, short, Y2quant[QINDEX_RANGE][16]);
259 DECLARE_ALIGNED(16, short, Y2quant_shift[QINDEX_RANGE][16]);
260 DECLARE_ALIGNED(16, short, Y2zbin[QINDEX_RANGE][16]);
261 DECLARE_ALIGNED(16, short, Y2round[QINDEX_RANGE][16]);
263 DECLARE_ALIGNED(16, short, UVquant[QINDEX_RANGE][16]);
264 DECLARE_ALIGNED(16, short, UVquant_shift[QINDEX_RANGE][16]);
265 DECLARE_ALIGNED(16, short, UVzbin[QINDEX_RANGE][16]);
266 DECLARE_ALIGNED(16, short, UVround[QINDEX_RANGE][16]);
268 DECLARE_ALIGNED(16, short, zrun_zbin_boost_y1[QINDEX_RANGE][16]);
269 DECLARE_ALIGNED(16, short, zrun_zbin_boost_y2[QINDEX_RANGE][16]);
270 DECLARE_ALIGNED(16, short, zrun_zbin_boost_uv[QINDEX_RANGE][16]);
280 YV12_BUFFER_CONFIG *Source;
281 YV12_BUFFER_CONFIG *un_scaled_source;
282 INT64 source_time_stamp;
283 INT64 source_end_time_stamp;
284 unsigned int source_frame_flags;
285 YV12_BUFFER_CONFIG scaled_source;
287 int source_buffer_count; // number of src_buffers in use for lagged encoding
288 int source_encode_index; // index of buffer in src_buffer to encode
289 int source_alt_ref_pending; // frame in src_buffers has been identified to be encoded as an alt ref
290 int source_alt_ref_active; // an alt ref frame has been encoded and is usable
292 int last_alt_ref_sei; // index into src_buffers of frame used as alt reference
293 int is_src_frame_alt_ref; // source of frame to encode is an exact copy of an alt ref frame
294 int is_next_src_alt_ref; // source of next frame to encode is an exact copy of an alt ref frame
296 int gold_is_last; // golden frame same as last frame ( short circuit gold searches)
297 int alt_is_last; // Alt reference frame same as last ( short circuit altref search)
298 int gold_is_alt; // don't do both alt and gold search ( just do gold).
300 //int refresh_alt_ref_frame;
301 SOURCE_SAMPLE src_buffer[MAX_LAG_BUFFERS];
303 YV12_BUFFER_CONFIG last_frame_uf;
308 unsigned int tok_count;
311 unsigned int frames_since_key;
312 unsigned int key_frame_frequency;
313 unsigned int next_key;
315 unsigned int mode_check_freq[MAX_MODES];
316 unsigned int mode_test_hit_counts[MAX_MODES];
317 unsigned int mode_chosen_counts[MAX_MODES];
318 unsigned int mbs_tested_so_far;
320 unsigned int check_freq[2];
321 unsigned int do_full[2];
323 int rd_thresh_mult[MAX_MODES];
324 int rd_baseline_thresh[MAX_MODES];
325 int rd_threshes[MAX_MODES];
327 int mvcostmultiplier;
328 int subseqblockweight;
330 unsigned int activity_avg;
337 int intra_mode_costs[10];
340 CODING_CONTEXT coding_context;
342 // Rate targetting variables
343 long long prediction_error;
344 long long last_prediction_error;
345 long long intra_error;
346 long long last_intra_error;
347 long long last_auto_filter_prediction_error;
350 // Experimental RD code
351 long long frame_distortion;
352 long long last_frame_distortion;
355 int last_mb_distortion;
357 int frames_since_auto_filter;
359 int this_frame_target;
360 int projected_frame_size;
361 int last_q[2]; // Separate values for Intra/Inter
362 int target_bits_per_mb;
364 double rate_correction_factor;
365 double key_frame_rate_correction_factor;
366 double gf_rate_correction_factor;
367 double est_max_qcorrection_factor;
369 int frames_till_gf_update_due; // Count down till next GF
370 int current_gf_interval; // GF interval chosen when we coded the last GF
372 int gf_overspend_bits; // Total bits overspent becasue of GF boost (cumulative)
374 int gf_group_bits; // Projected Bits available for a group of frames including 1 GF or ARF
375 int gf_bits; // Bits for the golden frame or ARF - 2 pass only
376 int mid_gf_extra_bits; // A few extra bits for the frame half way between two gfs.
378 // Projected total bits available for a key frame group of frames
379 long long kf_group_bits;
381 // Error score of frames still to be coded in kf group
382 long long kf_group_error_left;
384 // Bits for the key frame in a key frame group - 2 pass only
387 int non_gf_bitrate_adjustment; // Used in the few frames following a GF to recover the extra bits spent in that GF
388 int initial_gf_use; // percentage use of gf 2 frames after gf
390 int gf_group_error_left; // Remaining error from uncoded frames in a gf group. Two pass use only
392 int kf_overspend_bits; // Extra bits spent on key frames that need to be recovered on inter frames
393 int kf_bitrate_adjustment; // Current number of bit s to try and recover on each inter frame.
395 int baseline_gf_interval;
397 int active_arnr_frames; // <= cpi->oxcf.arnr_max_frames
399 INT64 key_frame_count;
400 INT64 tot_key_frame_bits;
401 int prior_key_frame_size[KEY_FRAME_CONTEXT];
402 int prior_key_frame_distance[KEY_FRAME_CONTEXT];
403 int per_frame_bandwidth; // Current section per frame bandwidth target
404 int av_per_frame_bandwidth; // Average frame size target for clip
405 int min_frame_bandwidth; // Minimum allocation that should be used for any frame
406 int last_key_frame_size;
407 int intra_frame_target;
408 int inter_frame_target;
409 double output_frame_rate;
410 long long last_time_stamp_seen;
411 long long last_end_time_stamp_seen;
412 long long first_time_stamp_ever;
417 int avg_frame_qindex;
421 int zbin_mode_boost_enabled;
423 INT64 total_byte_count;
430 int rolling_target_bits;
431 int rolling_actual_bits;
433 int long_rolling_target_bits;
434 int long_rolling_actual_bits;
436 long long total_actual_bits;
437 int total_target_vs_actual; // debug stats
440 int active_worst_quality;
442 int active_best_quality;
444 int drop_frames_allowed; // Are we permitted to drop frames?
445 int drop_frame; // Drop this frame?
446 int drop_count; // How many frames have we dropped?
447 int max_drop_count; // How many frames should we drop?
448 int max_consec_dropped_frames; // Limit number of consecutive frames that can be dropped.
451 int ymode_count [VP8_YMODES]; /* intra MB type cts this frame */
452 int uv_mode_count[VP8_UV_MODES]; /* intra MB type cts this frame */
454 unsigned int MVcount [2] [MVvals]; /* (row,col) MV cts this frame */
456 unsigned int coef_counts [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [vp8_coef_tokens]; /* for this frame */
457 //DECLARE_ALIGNED(16, int, coef_counts_backup [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [vp8_coef_tokens]); //not used any more
458 //save vp8_tree_probs_from_distribution result for each frame to avoid repeat calculation
459 vp8_prob frame_coef_probs [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [vp8_coef_tokens-1];
460 unsigned int frame_branch_ct [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [vp8_coef_tokens-1][2];
462 /* Second compressed data partition contains coefficient data. */
464 unsigned char *output_partition2;
465 size_t output_partition2size;
467 pre_proc_instance ppi;
473 double total_error_left;
474 double total_intra_error_left;
475 double total_coded_error_left;
476 double start_tot_err_left;
479 double modified_error_total;
480 double modified_error_used;
481 double modified_error_left;
487 int target_bandwidth;
489 long long clip_bits_total;
490 FIRSTPASS_STATS *total_stats;
491 FIRSTPASS_STATS *this_frame_stats;
492 FIRSTPASS_STATS *stats_in, *stats_in_end;
493 struct vpx_codec_pkt_list *output_pkt_list;
495 unsigned char *fp_motion_map;
497 unsigned char *fp_motion_map_stats, *fp_motion_map_stats_save;
500 // Experimental code for lagged and one pass
501 ONEPASS_FRAMESTATS one_pass_frame_stats[MAX_LAG_BUFFERS];
502 int one_pass_frame_index;
505 int decimation_factor;
506 int decimation_count;
508 // for real time encoding
509 int avg_encode_time; //microsecond
510 int avg_pick_mode_time; //microsecond
512 unsigned int cpu_freq; //Mhz
513 int compressor_speed;
517 int auto_adjust_gold_quantizer;
520 int auto_adjust_key_quantizer;
531 int prob_intra_coded;
535 int last_skip_false_probs[3];
536 int last_skip_probs_q[3];
537 int recent_ref_frame_usage[MAX_REF_FRAMES];
539 int count_mb_ref_frame_usage[MAX_REF_FRAMES];
540 int this_frame_percent_intra;
541 int last_frame_percent_intra;
543 int last_key_frame_q;
551 int error_bins[1024];
558 unsigned int next_iiratio;
559 unsigned int this_iiratio;
560 int this_frame_modified_error;
562 double norm_intra_err_per_mb;
563 double norm_inter_err_per_mb;
564 double norm_iidiff_per_mb;
566 int last_best_mode_index; // Record of mode index chosen for previous macro block.
567 int last_auto_filt_val;
568 int last_auto_filt_q;
570 // Data used for real time conferencing mode to help determine if it would be good to update the gf
573 int gf_update_recommended;
575 int skip_false_count;
579 int ready_for_new_frame;
581 unsigned char *segmentation_map;
582 signed char segment_feature_data[MB_LVL_MAX][MAX_MB_SEGMENTS]; // Segment data (can be deltas or absolute values)
583 int segment_encode_breakout[MAX_MB_SEGMENTS]; // segment threashold for encode breakout
585 unsigned char *active_map;
586 unsigned int active_map_enabled;
587 // Video conferencing cyclic refresh mode flags etc
588 // This is a mode designed to clean up the background over time in live encoding scenarious. It uses segmentation
589 int cyclic_refresh_mode_enabled;
590 int cyclic_refresh_mode_max_mbs_perframe;
591 int cyclic_refresh_mode_index;
592 int cyclic_refresh_q;
593 signed char *cyclic_refresh_map;
596 int current_mb_col_main;
597 int processor_core_count;
598 int b_multi_threaded;
599 int encoding_thread_count;
601 #if CONFIG_MULTITHREAD
602 pthread_t *h_encoding_thread;
604 MB_ROW_COMP *mb_row_ei;
605 ENCODETHREAD_DATA *en_thread_data;
607 #if CONFIG_MULTITHREAD
609 sem_t *h_event_mbrencoding;
614 // end of multithread data
617 fractional_mv_step_fp *find_fractional_mv_step;
618 vp8_full_search_fn_t full_search_sad;
619 vp8_diamond_search_fn_t diamond_search_sad;
620 vp8_variance_fn_ptr_t fn_ptr[BLOCK_MAX_SEGMENTS];
621 unsigned int time_receive_data;
622 unsigned int time_compress_data;
623 unsigned int time_pick_lpf;
624 unsigned int time_encode_mb_row;
626 unsigned int tempdata1;
627 unsigned int tempdata2;
629 int base_skip_false_prob[128];
630 unsigned int section_intra_rating;
632 double section_max_qfactor;
635 #if CONFIG_RUNTIME_CPU_DETECT
636 VP8_ENCODER_RTCD rtcd;
638 #if VP8_TEMPORAL_ALT_REF
639 SOURCE_SAMPLE alt_ref_buffer;
640 YV12_BUFFER_CONFIG *frames[MAX_LAG_BUFFERS];
641 int fixed_divide[512];
643 // Flag to indicate temporal filter method
644 int use_weighted_temporal_filter;
652 double total_sq_error;
657 double total_sq_error2;
659 double summed_quality;
660 double summed_weights;
661 unsigned int tot_recode_hits;
664 double total_ssimg_y;
665 double total_ssimg_u;
666 double total_ssimg_v;
667 double total_ssimg_all;
669 int b_calculate_ssimg;
671 int b_calculate_psnr;
674 unsigned char *gf_active_flags; // Record of which MBs still refer to last golden frame either directly or through 0,0
677 //Store last frame's MV info for next frame MV prediction
679 int *lf_ref_frame_sign_bias;
684 void control_data_rate(VP8_COMP *cpi);
686 void vp8_encode_frame(VP8_COMP *cpi);
688 void vp8_pack_bitstream(VP8_COMP *cpi, unsigned char *dest, unsigned long *size);
690 unsigned int vp8_activity_masking(VP8_COMP *cpi, MACROBLOCK *x);
692 int rd_cost_intra_mb(MACROBLOCKD *x);
694 void vp8_tokenize_mb(VP8_COMP *, MACROBLOCKD *, TOKENEXTRA **);
696 void vp8_set_speed_features(VP8_COMP *cpi);
699 #define CHECK_MEM_ERROR(lval,expr) do {\
702 vpx_internal_error(&cpi->common.error, VPX_CODEC_MEM_ERROR,\
703 "Failed to allocate "#lval" at %s:%d", \
707 #define CHECK_MEM_ERROR(lval,expr) do {\
710 vpx_internal_error(&cpi->common.error, VPX_CODEC_MEM_ERROR,\
711 "Failed to allocate "#lval);\