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 ZBIN_OQ_MAX 192
51 #define VP8_TEMPORAL_ALT_REF 1
56 unsigned int frames_since_key;
57 unsigned int frames_since_golden;
59 int frames_till_gf_update_due;
60 int recent_ref_frame_usage[MAX_REF_FRAMES];
63 int mvcosts[2][MVvals+1];
70 int inter_y_modes[10];
71 int inter_uv_modes[4];
72 int inter_b_modes[10];
75 vp8_prob ymode_prob[4], uv_mode_prob[3]; /* interframe intra mode probs */
76 vp8_prob kf_ymode_prob[4], kf_uv_mode_prob[3]; /* keyframe "" */
78 int ymode_count[5], uv_mode_count[4]; /* intra MB type cts this frame */
80 int count_mb_ref_frame_usage[MAX_REF_FRAMES];
82 int this_frame_percent_intra;
83 int last_frame_percent_intra;
93 double ssim_weighted_pred_err;
96 double pcnt_second_ref;
103 double mv_in_out_count;
112 double frame_intra_error;
113 double frame_coded_error;
114 double frame_pcnt_inter;
115 double frame_pcnt_motion;
117 double frame_mvr_abs;
119 double frame_mvc_abs;
121 } ONEPASS_FRAMESTATS;
167 SEARCH_METHODS search_method;
172 int iterative_sub_pixel;
173 int half_pixel_search;
174 int quarter_pixel_search;
175 int thresh_mult[MAX_MODES];
179 int max_step_search_steps;
181 int optimize_coefficients;
190 int segment_counts[MAX_MB_SEGMENTS];
215 INT64 source_time_stamp;
216 INT64 source_end_time_stamp;
218 DECLARE_ALIGNED(16, YV12_BUFFER_CONFIG, source_buffer);
219 unsigned int source_frame_flags;
222 typedef struct VP8_ENCODER_RTCD
224 VP8_COMMON_RTCD *common;
225 vp8_variance_rtcd_vtable_t variance;
226 vp8_fdct_rtcd_vtable_t fdct;
227 vp8_encodemb_rtcd_vtable_t encodemb;
228 vp8_quantize_rtcd_vtable_t quantize;
229 vp8_search_rtcd_vtable_t search;
235 DECLARE_ALIGNED(16, short, Y1quant[QINDEX_RANGE][4][4]);
236 DECLARE_ALIGNED(16, short, Y1quant_shift[QINDEX_RANGE][4][4]);
237 DECLARE_ALIGNED(16, short, Y1zbin[QINDEX_RANGE][4][4]);
238 DECLARE_ALIGNED(16, short, Y1round[QINDEX_RANGE][4][4]);
240 DECLARE_ALIGNED(16, short, Y2quant[QINDEX_RANGE][4][4]);
241 DECLARE_ALIGNED(16, short, Y2quant_shift[QINDEX_RANGE][4][4]);
242 DECLARE_ALIGNED(16, short, Y2zbin[QINDEX_RANGE][4][4]);
243 DECLARE_ALIGNED(16, short, Y2round[QINDEX_RANGE][4][4]);
245 DECLARE_ALIGNED(16, short, UVquant[QINDEX_RANGE][4][4]);
246 DECLARE_ALIGNED(16, short, UVquant_shift[QINDEX_RANGE][4][4]);
247 DECLARE_ALIGNED(16, short, UVzbin[QINDEX_RANGE][4][4]);
248 DECLARE_ALIGNED(16, short, UVround[QINDEX_RANGE][4][4]);
250 DECLARE_ALIGNED(16, short, zrun_zbin_boost_y1[QINDEX_RANGE][16]);
251 DECLARE_ALIGNED(16, short, zrun_zbin_boost_y2[QINDEX_RANGE][16]);
252 DECLARE_ALIGNED(16, short, zrun_zbin_boost_uv[QINDEX_RANGE][16]);
262 YV12_BUFFER_CONFIG *Source;
263 YV12_BUFFER_CONFIG *un_scaled_source;
264 INT64 source_time_stamp;
265 INT64 source_end_time_stamp;
266 unsigned int source_frame_flags;
267 YV12_BUFFER_CONFIG scaled_source;
269 int source_buffer_count;
270 int source_encode_index;
271 int source_alt_ref_pending;
272 int source_alt_ref_active;
274 int last_alt_ref_sei;
275 int is_src_frame_alt_ref;
277 int gold_is_last; // golden frame same as last frame ( short circuit gold searches)
278 int alt_is_last; // Alt reference frame same as last ( short circuit altref search)
279 int gold_is_alt; // don't do both alt and gold search ( just do gold).
281 //int refresh_alt_ref_frame;
282 SOURCE_SAMPLE src_buffer[MAX_LAG_BUFFERS];
284 YV12_BUFFER_CONFIG last_frame_uf;
289 unsigned int tok_count;
292 unsigned int frames_since_key;
293 unsigned int key_frame_frequency;
294 unsigned int next_key;
296 unsigned int mode_check_freq[MAX_MODES];
297 unsigned int mode_test_hit_counts[MAX_MODES];
298 unsigned int mode_chosen_counts[MAX_MODES];
299 unsigned int mbs_tested_so_far;
301 unsigned int check_freq[2];
302 unsigned int do_full[2];
304 int rd_thresh_mult[MAX_MODES];
305 int rd_baseline_thresh[MAX_MODES];
306 int rd_threshes[MAX_MODES];
308 int mvcostmultiplier;
309 int subseqblockweight;
317 int intra_mode_costs[10];
320 CODING_CONTEXT coding_context;
322 // Rate targetting variables
323 long long prediction_error;
324 long long last_prediction_error;
325 long long intra_error;
326 long long last_intra_error;
327 long long last_auto_filter_prediction_error;
330 // Experimental RD code
331 long long frame_distortion;
332 long long last_frame_distortion;
335 int last_mb_distortion;
337 int frames_since_auto_filter;
339 int this_frame_target;
340 int projected_frame_size;
341 int last_q[2]; // Separate values for Intra/Inter
342 int target_bits_per_mb;
344 double rate_correction_factor;
345 double key_frame_rate_correction_factor;
346 double gf_rate_correction_factor;
347 double est_max_qcorrection_factor;
349 int frames_till_gf_update_due; // Count down till next GF
350 int current_gf_interval; // GF interval chosen when we coded the last GF
352 int gf_overspend_bits; // Total bits overspent becasue of GF boost (cumulative)
354 int gf_group_bits; // Projected Bits available for a group of frames including 1 GF or ARF
355 int gf_bits; // Bits for the golden frame or ARF - 2 pass only
356 int mid_gf_extra_bits; // A few extra bits for the frame half way between two gfs.
358 // Projected total bits available for a key frame group of frames
359 long long kf_group_bits;
361 // Error score of frames still to be coded in kf group
362 long long kf_group_error_left;
364 // Bits for the key frame in a key frame group - 2 pass only
367 int non_gf_bitrate_adjustment; // Used in the few frames following a GF to recover the extra bits spent in that GF
368 int initial_gf_use; // percentage use of gf 2 frames after gf
370 int gf_group_error_left; // Remaining error from uncoded frames in a gf group. Two pass use only
372 int kf_overspend_bits; // Extra bits spent on key frames that need to be recovered on inter frames
373 int kf_bitrate_adjustment; // Current number of bit s to try and recover on each inter frame.
375 int baseline_gf_interval;
377 int active_arnr_frames; // <= cpi->oxcf.arnr_max_frames
379 INT64 key_frame_count;
380 INT64 tot_key_frame_bits;
381 int prior_key_frame_size[KEY_FRAME_CONTEXT];
382 int prior_key_frame_distance[KEY_FRAME_CONTEXT];
383 int per_frame_bandwidth; // Current section per frame bandwidth target
384 int av_per_frame_bandwidth; // Average frame size target for clip
385 int min_frame_bandwidth; // Minimum allocation that should be used for any frame
386 int last_key_frame_size;
387 int intra_frame_target;
388 int inter_frame_target;
389 double output_frame_rate;
390 long long last_time_stamp_seen;
391 long long first_time_stamp_ever;
396 int avg_frame_qindex;
400 int zbin_mode_boost_enabled;
402 INT64 total_byte_count;
409 int rolling_target_bits;
410 int rolling_actual_bits;
412 int long_rolling_target_bits;
413 int long_rolling_actual_bits;
415 long long total_actual_bits;
416 int total_target_vs_actual; // debug stats
419 int active_worst_quality;
421 int active_best_quality;
423 int drop_frames_allowed; // Are we permitted to drop frames?
424 int drop_frame; // Drop this frame?
425 int drop_count; // How many frames have we dropped?
426 int max_drop_count; // How many frames should we drop?
427 int max_consec_dropped_frames; // Limit number of consecutive frames that can be dropped.
430 int ymode_count [VP8_YMODES]; /* intra MB type cts this frame */
431 int uv_mode_count[VP8_UV_MODES]; /* intra MB type cts this frame */
433 unsigned int MVcount [2] [MVvals]; /* (row,col) MV cts this frame */
435 unsigned int coef_counts [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [vp8_coef_tokens]; /* for this frame */
436 //DECLARE_ALIGNED(16, int, coef_counts_backup [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [vp8_coef_tokens]); //not used any more
437 //save vp8_tree_probs_from_distribution result for each frame to avoid repeat calculation
438 vp8_prob frame_coef_probs [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [vp8_coef_tokens-1];
439 unsigned int frame_branch_ct [BLOCK_TYPES] [COEF_BANDS] [PREV_COEF_CONTEXTS] [vp8_coef_tokens-1][2];
441 /* Second compressed data partition contains coefficient data. */
443 unsigned char *output_partition2;
444 size_t output_partition2size;
446 pre_proc_instance ppi;
452 double total_error_left;
453 double total_intra_error_left;
454 double total_coded_error_left;
455 double start_tot_err_left;
458 double modified_total_error_left;
461 int target_bandwidth;
463 FIRSTPASS_STATS total_stats;
464 FIRSTPASS_STATS this_frame_stats;
465 FIRSTPASS_STATS *stats_in, *stats_in_end;
466 struct vpx_codec_pkt_list *output_pkt_list;
468 unsigned char *fp_motion_map;
469 FILE *fp_motion_mapfile;
473 // Experimental code for lagged and one pass
474 ONEPASS_FRAMESTATS one_pass_frame_stats[MAX_LAG_BUFFERS];
475 int one_pass_frame_index;
478 int decimation_factor;
479 int decimation_count;
481 // for real time encoding
482 int avg_encode_time; //microsecond
483 int avg_pick_mode_time; //microsecond
485 unsigned int cpu_freq; //Mhz
486 int compressor_speed;
490 int auto_adjust_gold_quantizer;
493 int auto_adjust_key_quantizer;
504 int prob_intra_coded;
508 int last_skip_false_probs[3];
509 int last_skip_probs_q[3];
510 int recent_ref_frame_usage[MAX_REF_FRAMES];
512 int count_mb_ref_frame_usage[MAX_REF_FRAMES];
513 int this_frame_percent_intra;
514 int last_frame_percent_intra;
516 int last_key_frame_q;
524 int error_bins[1024];
531 unsigned int next_iiratio;
532 unsigned int this_iiratio;
533 int this_frame_modified_error;
535 double norm_intra_err_per_mb;
536 double norm_inter_err_per_mb;
537 double norm_iidiff_per_mb;
539 int last_best_mode_index; // Record of mode index chosen for previous macro block.
540 int last_auto_filt_val;
541 int last_auto_filt_q;
543 // Data used for real time conferencing mode to help determine if it would be good to update the gf
546 int gf_update_recommended;
548 int skip_false_count;
552 int ready_for_new_frame;
554 unsigned char *segmentation_map;
555 signed char segment_feature_data[MB_LVL_MAX][MAX_MB_SEGMENTS]; // Segment data (can be deltas or absolute values)
556 int segment_encode_breakout[MAX_MB_SEGMENTS]; // segment threashold for encode breakout
558 unsigned char *active_map;
559 unsigned int active_map_enabled;
560 // Video conferencing cyclic refresh mode flags etc
561 // This is a mode designed to clean up the background over time in live encoding scenarious. It uses segmentation
562 int cyclic_refresh_mode_enabled;
563 int cyclic_refresh_mode_max_mbs_perframe;
564 int cyclic_refresh_mode_index;
565 int cyclic_refresh_q;
566 signed char *cyclic_refresh_map;
569 int current_mb_col_main;
570 int processor_core_count;
571 int b_multi_threaded;
572 int encoding_thread_count;
574 #if CONFIG_MULTITHREAD
575 pthread_t *h_encoding_thread;
577 MB_ROW_COMP *mb_row_ei;
578 ENCODETHREAD_DATA *en_thread_data;
580 #if CONFIG_MULTITHREAD
582 sem_t *h_event_mbrencoding;
587 // end of multithread data
590 fractional_mv_step_fp *find_fractional_mv_step;
591 vp8_full_search_fn_t full_search_sad;
592 vp8_diamond_search_fn_t diamond_search_sad;
593 vp8_variance_fn_ptr_t fn_ptr;
594 unsigned int time_receive_data;
595 unsigned int time_compress_data;
596 unsigned int time_pick_lpf;
597 unsigned int time_encode_mb_row;
599 unsigned int tempdata1;
600 unsigned int tempdata2;
602 int base_skip_false_prob[128];
603 unsigned int section_is_low_motion;
604 unsigned int section_benefits_from_aggresive_q;
605 unsigned int section_is_fast_motion;
606 unsigned int section_intra_rating;
608 double section_max_qfactor;
611 #if CONFIG_RUNTIME_CPU_DETECT
612 VP8_ENCODER_RTCD rtcd;
614 #if VP8_TEMPORAL_ALT_REF
615 SOURCE_SAMPLE alt_ref_buffer;
616 YV12_BUFFER_CONFIG *frames[MAX_LAG_BUFFERS];
617 int fixed_divide[512];
619 // Flag to indicate temporal filter method
620 int use_weighted_temporal_filter;
628 double total_sq_error;
633 double total_sq_error2;
635 double summed_quality;
636 double summed_weights;
637 unsigned int tot_recode_hits;
640 double total_ssimg_y;
641 double total_ssimg_u;
642 double total_ssimg_v;
643 double total_ssimg_all;
645 int b_calculate_ssimg;
647 int b_calculate_psnr;
650 unsigned char *gf_active_flags; // Record of which MBs still refer to last golden frame either directly or through 0,0
656 void control_data_rate(VP8_COMP *cpi);
658 void vp8_encode_frame(VP8_COMP *cpi);
660 void vp8_pack_bitstream(VP8_COMP *cpi, unsigned char *dest, unsigned long *size);
662 int rd_cost_intra_mb(MACROBLOCKD *x);
664 void vp8_tokenize_mb(VP8_COMP *, MACROBLOCKD *, TOKENEXTRA **);
666 void vp8_set_speed_features(VP8_COMP *cpi);
669 #define CHECK_MEM_ERROR(lval,expr) do {\
672 vpx_internal_error(&cpi->common.error, VPX_CODEC_MEM_ERROR,\
673 "Failed to allocate "#lval" at %s:%d", \
677 #define CHECK_MEM_ERROR(lval,expr) do {\
680 vpx_internal_error(&cpi->common.error, VPX_CODEC_MEM_ERROR,\
681 "Failed to allocate "#lval);\