]> granicus.if.org Git - libvpx/blob - vp9/encoder/vp9_encoder.h
Fix the decoder seg fault when frame is corrupted.
[libvpx] / vp9 / encoder / vp9_encoder.h
1 /*
2  *  Copyright (c) 2010 The WebM project authors. All Rights Reserved.
3  *
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.
9  */
10
11 #ifndef VP9_ENCODER_VP9_ENCODER_H_
12 #define VP9_ENCODER_VP9_ENCODER_H_
13
14 #include <stdio.h>
15
16 #include "./vpx_config.h"
17 #include "vpx/internal/vpx_codec_internal.h"
18 #include "vpx/vp8cx.h"
19 #if CONFIG_INTERNAL_STATS
20 #include "vpx_dsp/ssim.h"
21 #endif
22 #include "vpx_dsp/variance.h"
23 #include "vpx_ports/system_state.h"
24 #include "vpx_util/vpx_thread.h"
25
26 #include "vp9/common/vp9_alloccommon.h"
27 #include "vp9/common/vp9_ppflags.h"
28 #include "vp9/common/vp9_entropymode.h"
29 #include "vp9/common/vp9_thread_common.h"
30 #include "vp9/common/vp9_onyxc_int.h"
31
32 #include "vp9/encoder/vp9_alt_ref_aq.h"
33 #include "vp9/encoder/vp9_aq_cyclicrefresh.h"
34 #include "vp9/encoder/vp9_context_tree.h"
35 #include "vp9/encoder/vp9_encodemb.h"
36 #include "vp9/encoder/vp9_ethread.h"
37 #include "vp9/encoder/vp9_firstpass.h"
38 #include "vp9/encoder/vp9_job_queue.h"
39 #include "vp9/encoder/vp9_lookahead.h"
40 #include "vp9/encoder/vp9_mbgraph.h"
41 #include "vp9/encoder/vp9_mcomp.h"
42 #include "vp9/encoder/vp9_noise_estimate.h"
43 #include "vp9/encoder/vp9_quantize.h"
44 #include "vp9/encoder/vp9_ratectrl.h"
45 #include "vp9/encoder/vp9_rd.h"
46 #include "vp9/encoder/vp9_speed_features.h"
47 #include "vp9/encoder/vp9_svc_layercontext.h"
48 #include "vp9/encoder/vp9_tokenize.h"
49
50 #if CONFIG_VP9_TEMPORAL_DENOISING
51 #include "vp9/encoder/vp9_denoiser.h"
52 #endif
53
54 #ifdef __cplusplus
55 extern "C" {
56 #endif
57
58 // vp9 uses 10,000,000 ticks/second as time stamp
59 #define TICKS_PER_SEC 10000000
60
61 typedef struct {
62   int nmvjointcost[MV_JOINTS];
63   int nmvcosts[2][MV_VALS];
64   int nmvcosts_hp[2][MV_VALS];
65
66   vpx_prob segment_pred_probs[PREDICTION_PROBS];
67
68   unsigned char *last_frame_seg_map_copy;
69
70   // 0 = Intra, Last, GF, ARF
71   signed char last_ref_lf_deltas[MAX_REF_LF_DELTAS];
72   // 0 = ZERO_MV, MV
73   signed char last_mode_lf_deltas[MAX_MODE_LF_DELTAS];
74
75   FRAME_CONTEXT fc;
76 } CODING_CONTEXT;
77
78 typedef enum {
79   // encode_breakout is disabled.
80   ENCODE_BREAKOUT_DISABLED = 0,
81   // encode_breakout is enabled.
82   ENCODE_BREAKOUT_ENABLED = 1,
83   // encode_breakout is enabled with small max_thresh limit.
84   ENCODE_BREAKOUT_LIMITED = 2
85 } ENCODE_BREAKOUT_TYPE;
86
87 typedef enum {
88   NORMAL = 0,
89   FOURFIVE = 1,
90   THREEFIVE = 2,
91   ONETWO = 3
92 } VPX_SCALING;
93
94 typedef enum {
95   // Good Quality Fast Encoding. The encoder balances quality with the amount of
96   // time it takes to encode the output. Speed setting controls how fast.
97   GOOD,
98
99   // The encoder places priority on the quality of the output over encoding
100   // speed. The output is compressed at the highest possible quality. This
101   // option takes the longest amount of time to encode. Speed setting ignored.
102   BEST,
103
104   // Realtime/Live Encoding. This mode is optimized for realtime encoding (for
105   // example, capturing a television signal or feed from a live camera). Speed
106   // setting controls how fast.
107   REALTIME
108 } MODE;
109
110 typedef enum {
111   FRAMEFLAGS_KEY = 1 << 0,
112   FRAMEFLAGS_GOLDEN = 1 << 1,
113   FRAMEFLAGS_ALTREF = 1 << 2,
114 } FRAMETYPE_FLAGS;
115
116 typedef enum {
117   NO_AQ = 0,
118   VARIANCE_AQ = 1,
119   COMPLEXITY_AQ = 2,
120   CYCLIC_REFRESH_AQ = 3,
121   EQUATOR360_AQ = 4,
122   // AQ based on lookahead temporal
123   // variance (only valid for altref frames)
124   LOOKAHEAD_AQ = 5,
125   AQ_MODE_COUNT  // This should always be the last member of the enum
126 } AQ_MODE;
127
128 typedef enum {
129   RESIZE_NONE = 0,    // No frame resizing allowed (except for SVC).
130   RESIZE_FIXED = 1,   // All frames are coded at the specified dimension.
131   RESIZE_DYNAMIC = 2  // Coded size of each frame is determined by the codec.
132 } RESIZE_TYPE;
133
134 typedef enum {
135   kInvalid = 0,
136   kLowSadLowSumdiff = 1,
137   kLowSadHighSumdiff = 2,
138   kHighSadLowSumdiff = 3,
139   kHighSadHighSumdiff = 4,
140 } CONTENT_STATE_SB;
141
142 typedef struct VP9EncoderConfig {
143   BITSTREAM_PROFILE profile;
144   vpx_bit_depth_t bit_depth;     // Codec bit-depth.
145   int width;                     // width of data passed to the compressor
146   int height;                    // height of data passed to the compressor
147   unsigned int input_bit_depth;  // Input bit depth.
148   double init_framerate;         // set to passed in framerate
149   int64_t target_bandwidth;      // bandwidth to be used in bits per second
150
151   int noise_sensitivity;  // pre processing blur: recommendation 0
152   int sharpness;          // sharpening output: recommendation 0:
153   int speed;
154   // maximum allowed bitrate for any intra frame in % of bitrate target.
155   unsigned int rc_max_intra_bitrate_pct;
156   // maximum allowed bitrate for any inter frame in % of bitrate target.
157   unsigned int rc_max_inter_bitrate_pct;
158   // percent of rate boost for golden frame in CBR mode.
159   unsigned int gf_cbr_boost_pct;
160
161   MODE mode;
162   int pass;
163
164   // Key Framing Operations
165   int auto_key;  // autodetect cut scenes and set the keyframes
166   int key_freq;  // maximum distance to key frame.
167
168   int lag_in_frames;  // how many frames lag before we start encoding
169
170   // ----------------------------------------------------------------
171   // DATARATE CONTROL OPTIONS
172
173   // vbr, cbr, constrained quality or constant quality
174   enum vpx_rc_mode rc_mode;
175
176   // buffer targeting aggressiveness
177   int under_shoot_pct;
178   int over_shoot_pct;
179
180   // buffering parameters
181   int64_t starting_buffer_level_ms;
182   int64_t optimal_buffer_level_ms;
183   int64_t maximum_buffer_size_ms;
184
185   // Frame drop threshold.
186   int drop_frames_water_mark;
187
188   // controlling quality
189   int fixed_q;
190   int worst_allowed_q;
191   int best_allowed_q;
192   int cq_level;
193   AQ_MODE aq_mode;  // Adaptive Quantization mode
194
195   // Special handling of Adaptive Quantization for AltRef frames
196   int alt_ref_aq;
197
198   // Internal frame size scaling.
199   RESIZE_TYPE resize_mode;
200   int scaled_frame_width;
201   int scaled_frame_height;
202
203   // Enable feature to reduce the frame quantization every x frames.
204   int frame_periodic_boost;
205
206   // two pass datarate control
207   int two_pass_vbrbias;  // two pass datarate control tweaks
208   int two_pass_vbrmin_section;
209   int two_pass_vbrmax_section;
210   // END DATARATE CONTROL OPTIONS
211   // ----------------------------------------------------------------
212
213   // Spatial and temporal scalability.
214   int ss_number_layers;  // Number of spatial layers.
215   int ts_number_layers;  // Number of temporal layers.
216   // Bitrate allocation for spatial layers.
217   int layer_target_bitrate[VPX_MAX_LAYERS];
218   int ss_target_bitrate[VPX_SS_MAX_LAYERS];
219   int ss_enable_auto_arf[VPX_SS_MAX_LAYERS];
220   // Bitrate allocation (CBR mode) and framerate factor, for temporal layers.
221   int ts_rate_decimator[VPX_TS_MAX_LAYERS];
222
223   int enable_auto_arf;
224
225   int encode_breakout;  // early breakout : for video conf recommend 800
226
227   /* Bitfield defining the error resiliency features to enable.
228    * Can provide decodable frames after losses in previous
229    * frames and decodable partitions after losses in the same frame.
230    */
231   unsigned int error_resilient_mode;
232
233   /* Bitfield defining the parallel decoding mode where the
234    * decoding in successive frames may be conducted in parallel
235    * just by decoding the frame headers.
236    */
237   unsigned int frame_parallel_decoding_mode;
238
239   int arnr_max_frames;
240   int arnr_strength;
241
242   int min_gf_interval;
243   int max_gf_interval;
244
245   int tile_columns;
246   int tile_rows;
247
248   int max_threads;
249
250   unsigned int target_level;
251
252   vpx_fixed_buf_t two_pass_stats_in;
253   struct vpx_codec_pkt_list *output_pkt_list;
254
255 #if CONFIG_FP_MB_STATS
256   vpx_fixed_buf_t firstpass_mb_stats_in;
257 #endif
258
259   vp8e_tuning tuning;
260   vp9e_tune_content content;
261 #if CONFIG_VP9_HIGHBITDEPTH
262   int use_highbitdepth;
263 #endif
264   vpx_color_space_t color_space;
265   vpx_color_range_t color_range;
266   int render_width;
267   int render_height;
268   VP9E_TEMPORAL_LAYERING_MODE temporal_layering_mode;
269
270   int row_mt;
271   unsigned int row_mt_bit_exact;
272   unsigned int motion_vector_unit_test;
273 } VP9EncoderConfig;
274
275 static INLINE int is_lossless_requested(const VP9EncoderConfig *cfg) {
276   return cfg->best_allowed_q == 0 && cfg->worst_allowed_q == 0;
277 }
278
279 // TODO(jingning) All spatially adaptive variables should go to TileDataEnc.
280 typedef struct TileDataEnc {
281   TileInfo tile_info;
282   int thresh_freq_fact[BLOCK_SIZES][MAX_MODES];
283   int mode_map[BLOCK_SIZES][MAX_MODES];
284   int m_search_count;
285   int ex_search_count;
286   FIRSTPASS_DATA fp_data;
287   VP9RowMTSync row_mt_sync;
288
289   // Used for adaptive_rd_thresh with row multithreading
290   int *row_base_thresh_freq_fact;
291 #if CONFIG_MULTITHREAD
292   pthread_mutex_t *search_count_mutex;
293   pthread_mutex_t *enc_row_mt_mutex;
294 #endif
295 } TileDataEnc;
296
297 typedef struct RowMTInfo {
298   JobQueueHandle job_queue_hdl;
299 #if CONFIG_MULTITHREAD
300   pthread_mutex_t job_mutex;
301 #endif
302 } RowMTInfo;
303
304 typedef struct {
305   TOKENEXTRA *start;
306   TOKENEXTRA *stop;
307   unsigned int count;
308 } TOKENLIST;
309
310 typedef struct MultiThreadHandle {
311   int allocated_tile_rows;
312   int allocated_tile_cols;
313   int allocated_vert_unit_rows;
314
315   // Frame level params
316   int num_tile_vert_sbs[MAX_NUM_TILE_ROWS];
317
318   // Job Queue structure and handles
319   JobQueue *job_queue;
320
321   int jobs_per_tile_col;
322
323   RowMTInfo row_mt_info[MAX_NUM_TILE_COLS];
324   int thread_id_to_tile_id[MAX_NUM_THREADS];  // Mapping of threads to tiles
325 } MultiThreadHandle;
326
327 typedef struct RD_COUNTS {
328   vp9_coeff_count coef_counts[TX_SIZES][PLANE_TYPES];
329   int64_t comp_pred_diff[REFERENCE_MODES];
330   int64_t filter_diff[SWITCHABLE_FILTER_CONTEXTS];
331 } RD_COUNTS;
332
333 typedef struct ThreadData {
334   MACROBLOCK mb;
335   RD_COUNTS rd_counts;
336   FRAME_COUNTS *counts;
337
338   PICK_MODE_CONTEXT *leaf_tree;
339   PC_TREE *pc_tree;
340   PC_TREE *pc_root;
341 } ThreadData;
342
343 struct EncWorkerData;
344
345 typedef struct ActiveMap {
346   int enabled;
347   int update;
348   unsigned char *map;
349 } ActiveMap;
350
351 typedef enum { Y, U, V, ALL } STAT_TYPE;
352
353 typedef struct IMAGE_STAT {
354   double stat[ALL + 1];
355   double worst;
356 } ImageStat;
357
358 // Kf noise filtering currently disabled by default in build.
359 // #define ENABLE_KF_DENOISE 1
360
361 #define CPB_WINDOW_SIZE 4
362 #define FRAME_WINDOW_SIZE 128
363 #define SAMPLE_RATE_GRACE_P 0.015
364 #define VP9_LEVELS 14
365
366 typedef enum {
367   LEVEL_UNKNOWN = 0,
368   LEVEL_1 = 10,
369   LEVEL_1_1 = 11,
370   LEVEL_2 = 20,
371   LEVEL_2_1 = 21,
372   LEVEL_3 = 30,
373   LEVEL_3_1 = 31,
374   LEVEL_4 = 40,
375   LEVEL_4_1 = 41,
376   LEVEL_5 = 50,
377   LEVEL_5_1 = 51,
378   LEVEL_5_2 = 52,
379   LEVEL_6 = 60,
380   LEVEL_6_1 = 61,
381   LEVEL_6_2 = 62,
382   LEVEL_MAX = 255
383 } VP9_LEVEL;
384
385 typedef struct {
386   VP9_LEVEL level;
387   uint64_t max_luma_sample_rate;
388   uint32_t max_luma_picture_size;
389   double average_bitrate;  // in kilobits per second
390   double max_cpb_size;     // in kilobits
391   double compression_ratio;
392   uint8_t max_col_tiles;
393   uint32_t min_altref_distance;
394   uint8_t max_ref_frame_buffers;
395 } Vp9LevelSpec;
396
397 extern const Vp9LevelSpec vp9_level_defs[VP9_LEVELS];
398
399 typedef struct {
400   int64_t ts;  // timestamp
401   uint32_t luma_samples;
402   uint32_t size;  // in bytes
403 } FrameRecord;
404
405 typedef struct {
406   FrameRecord buf[FRAME_WINDOW_SIZE];
407   uint8_t start;
408   uint8_t len;
409 } FrameWindowBuffer;
410
411 typedef struct {
412   uint8_t seen_first_altref;
413   uint32_t frames_since_last_altref;
414   uint64_t total_compressed_size;
415   uint64_t total_uncompressed_size;
416   double time_encoded;  // in seconds
417   FrameWindowBuffer frame_window_buffer;
418   int ref_refresh_map;
419 } Vp9LevelStats;
420
421 typedef struct {
422   Vp9LevelStats level_stats;
423   Vp9LevelSpec level_spec;
424 } Vp9LevelInfo;
425
426 typedef enum {
427   BITRATE_TOO_LARGE = 0,
428   LUMA_PIC_SIZE_TOO_LARGE = 1,
429   LUMA_SAMPLE_RATE_TOO_LARGE = 2,
430   CPB_TOO_LARGE = 3,
431   COMPRESSION_RATIO_TOO_SMALL = 4,
432   TOO_MANY_COLUMN_TILE = 5,
433   ALTREF_DIST_TOO_SMALL = 6,
434   TOO_MANY_REF_BUFFER = 7,
435   TARGET_LEVEL_FAIL_IDS = 8
436 } TARGET_LEVEL_FAIL_ID;
437
438 typedef struct {
439   int8_t level_index;
440   uint8_t rc_config_updated;
441   uint8_t fail_flag;
442   int max_frame_size;   // in bits
443   double max_cpb_size;  // in bits
444 } LevelConstraint;
445
446 typedef struct ARNRFilterData {
447   YV12_BUFFER_CONFIG *frames[MAX_LAG_BUFFERS];
448   int strength;
449   int frame_count;
450   int alt_ref_index;
451   struct scale_factors sf;
452 } ARNRFilterData;
453
454 typedef struct VP9_COMP {
455   QUANTS quants;
456   ThreadData td;
457   MB_MODE_INFO_EXT *mbmi_ext_base;
458   DECLARE_ALIGNED(16, int16_t, y_dequant[QINDEX_RANGE][8]);
459   DECLARE_ALIGNED(16, int16_t, uv_dequant[QINDEX_RANGE][8]);
460   VP9_COMMON common;
461   VP9EncoderConfig oxcf;
462   struct lookahead_ctx *lookahead;
463   struct lookahead_entry *alt_ref_source;
464
465   YV12_BUFFER_CONFIG *Source;
466   YV12_BUFFER_CONFIG *Last_Source;  // NULL for first frame and alt_ref frames
467   YV12_BUFFER_CONFIG *un_scaled_source;
468   YV12_BUFFER_CONFIG scaled_source;
469   YV12_BUFFER_CONFIG *unscaled_last_source;
470   YV12_BUFFER_CONFIG scaled_last_source;
471 #ifdef ENABLE_KF_DENOISE
472   YV12_BUFFER_CONFIG raw_unscaled_source;
473   YV12_BUFFER_CONFIG raw_scaled_source;
474 #endif
475   YV12_BUFFER_CONFIG *raw_source_frame;
476
477   TileDataEnc *tile_data;
478   int allocated_tiles;  // Keep track of memory allocated for tiles.
479
480   // For a still frame, this flag is set to 1 to skip partition search.
481   int partition_search_skippable_frame;
482
483   int scaled_ref_idx[MAX_REF_FRAMES];
484   int lst_fb_idx;
485   int gld_fb_idx;
486   int alt_fb_idx;
487
488   int refresh_last_frame;
489   int refresh_golden_frame;
490   int refresh_alt_ref_frame;
491
492   int ext_refresh_frame_flags_pending;
493   int ext_refresh_last_frame;
494   int ext_refresh_golden_frame;
495   int ext_refresh_alt_ref_frame;
496
497   int ext_refresh_frame_context_pending;
498   int ext_refresh_frame_context;
499
500   YV12_BUFFER_CONFIG last_frame_uf;
501
502   TOKENEXTRA *tile_tok[4][1 << 6];
503   uint32_t tok_count[4][1 << 6];
504   TOKENLIST *tplist[4][1 << 6];
505
506   // Ambient reconstruction err target for force key frames
507   int64_t ambient_err;
508
509   RD_OPT rd;
510
511   CODING_CONTEXT coding_context;
512
513   int *nmvcosts[2];
514   int *nmvcosts_hp[2];
515   int *nmvsadcosts[2];
516   int *nmvsadcosts_hp[2];
517
518   int64_t last_time_stamp_seen;
519   int64_t last_end_time_stamp_seen;
520   int64_t first_time_stamp_ever;
521
522   RATE_CONTROL rc;
523   double framerate;
524
525   int interp_filter_selected[MAX_REF_FRAMES][SWITCHABLE];
526
527   struct vpx_codec_pkt_list *output_pkt_list;
528
529   MBGRAPH_FRAME_STATS mbgraph_stats[MAX_LAG_BUFFERS];
530   int mbgraph_n_frames;  // number of frames filled in the above
531   int static_mb_pct;     // % forced skip mbs by segmentation
532   int ref_frame_flags;
533
534   SPEED_FEATURES sf;
535
536   uint32_t max_mv_magnitude;
537   int mv_step_param;
538
539   int allow_comp_inter_inter;
540
541   // Default value is 1. From first pass stats, encode_breakout may be disabled.
542   ENCODE_BREAKOUT_TYPE allow_encode_breakout;
543
544   // Get threshold from external input. A suggested threshold is 800 for HD
545   // clips, and 300 for < HD clips.
546   int encode_breakout;
547
548   uint8_t *segmentation_map;
549
550   // segment threashold for encode breakout
551   int segment_encode_breakout[MAX_SEGMENTS];
552
553   CYCLIC_REFRESH *cyclic_refresh;
554   ActiveMap active_map;
555
556   fractional_mv_step_fp *find_fractional_mv_step;
557   vp9_full_search_fn_t full_search_sad;
558   vp9_diamond_search_fn_t diamond_search_sad;
559   vp9_variance_fn_ptr_t fn_ptr[BLOCK_SIZES];
560   uint64_t time_receive_data;
561   uint64_t time_compress_data;
562   uint64_t time_pick_lpf;
563   uint64_t time_encode_sb_row;
564
565 #if CONFIG_FP_MB_STATS
566   int use_fp_mb_stats;
567 #endif
568
569   TWO_PASS twopass;
570
571   // Force recalculation of segment_ids for each mode info
572   uint8_t force_update_segmentation;
573
574   YV12_BUFFER_CONFIG alt_ref_buffer;
575
576   // class responsible for adaptive
577   // quantization of altref frames
578   struct ALT_REF_AQ *alt_ref_aq;
579
580 #if CONFIG_INTERNAL_STATS
581   unsigned int mode_chosen_counts[MAX_MODES];
582
583   int count;
584   uint64_t total_sq_error;
585   uint64_t total_samples;
586   ImageStat psnr;
587
588   uint64_t totalp_sq_error;
589   uint64_t totalp_samples;
590   ImageStat psnrp;
591
592   double total_blockiness;
593   double worst_blockiness;
594
595   int bytes;
596   double summed_quality;
597   double summed_weights;
598   double summedp_quality;
599   double summedp_weights;
600   unsigned int tot_recode_hits;
601   double worst_ssim;
602
603   ImageStat ssimg;
604   ImageStat fastssim;
605   ImageStat psnrhvs;
606
607   int b_calculate_ssimg;
608   int b_calculate_blockiness;
609
610   int b_calculate_consistency;
611
612   double total_inconsistency;
613   double worst_consistency;
614   Ssimv *ssim_vars;
615   Metrics metrics;
616 #endif
617   int b_calculate_psnr;
618
619   int droppable;
620
621   int initial_width;
622   int initial_height;
623   int initial_mbs;  // Number of MBs in the full-size frame; to be used to
624                     // normalize the firstpass stats. This will differ from the
625                     // number of MBs in the current frame when the frame is
626                     // scaled.
627
628   int use_svc;
629
630   SVC svc;
631
632   // Store frame variance info in SOURCE_VAR_BASED_PARTITION search type.
633   diff *source_diff_var;
634   // The threshold used in SOURCE_VAR_BASED_PARTITION search type.
635   unsigned int source_var_thresh;
636   int frames_till_next_var_check;
637
638   int frame_flags;
639
640   search_site_config ss_cfg;
641
642   int mbmode_cost[INTRA_MODES];
643   unsigned int inter_mode_cost[INTER_MODE_CONTEXTS][INTER_MODES];
644   int intra_uv_mode_cost[FRAME_TYPES][INTRA_MODES][INTRA_MODES];
645   int y_mode_costs[INTRA_MODES][INTRA_MODES][INTRA_MODES];
646   int switchable_interp_costs[SWITCHABLE_FILTER_CONTEXTS][SWITCHABLE_FILTERS];
647   int partition_cost[PARTITION_CONTEXTS][PARTITION_TYPES];
648
649   int multi_arf_allowed;
650   int multi_arf_enabled;
651   int multi_arf_last_grp_enabled;
652
653 #if CONFIG_VP9_TEMPORAL_DENOISING
654   VP9_DENOISER denoiser;
655 #endif
656
657   int resize_pending;
658   RESIZE_STATE resize_state;
659   int external_resize;
660   int resize_scale_num;
661   int resize_scale_den;
662   int resize_avg_qp;
663   int resize_buffer_underflow;
664   int resize_count;
665
666   int use_skin_detection;
667
668   int target_level;
669
670   NOISE_ESTIMATE noise_estimate;
671
672   // Count on how many consecutive times a block uses small/zeromv for encoding.
673   uint8_t *consec_zero_mv;
674
675   // VAR_BASED_PARTITION thresholds
676   // 0 - threshold_64x64; 1 - threshold_32x32;
677   // 2 - threshold_16x16; 3 - vbp_threshold_8x8;
678   int64_t vbp_thresholds[4];
679   int64_t vbp_threshold_minmax;
680   int64_t vbp_threshold_sad;
681   // Threshold used for partition copy
682   int64_t vbp_threshold_copy;
683   BLOCK_SIZE vbp_bsize_min;
684
685   // Multi-threading
686   int num_workers;
687   VPxWorker *workers;
688   struct EncWorkerData *tile_thr_data;
689   VP9LfSync lf_row_sync;
690   struct VP9BitstreamWorkerData *vp9_bitstream_worker_data;
691
692   int keep_level_stats;
693   Vp9LevelInfo level_info;
694   MultiThreadHandle multi_thread_ctxt;
695   void (*row_mt_sync_read_ptr)(VP9RowMTSync *const, int, int);
696   void (*row_mt_sync_write_ptr)(VP9RowMTSync *const, int, int, const int);
697   ARNRFilterData arnr_filter_data;
698   int row_mt;
699
700   // Previous Partition Info
701   BLOCK_SIZE *prev_partition;
702   int8_t *prev_segment_id;
703   // Used to save the status of whether a block has a low variance in
704   // choose_partitioning. 0 for 64x64, 1~2 for 64x32, 3~4 for 32x64, 5~8 for
705   // 32x32, 9~24 for 16x16.
706   // This is for the last frame and is copied to the current frame
707   // when partition copy happens.
708   uint8_t *prev_variance_low;
709   uint8_t *copied_frame_cnt;
710   uint8_t max_copied_frame;
711
712   // For each superblock: keeps track of the last time (in frame distance) the
713   // the superblock did not have low source sad.
714   uint8_t *content_state_sb_fd;
715
716   int compute_source_sad_onepass;
717
718   LevelConstraint level_constraint;
719 } VP9_COMP;
720
721 void vp9_initialize_enc(void);
722
723 struct VP9_COMP *vp9_create_compressor(VP9EncoderConfig *oxcf,
724                                        BufferPool *const pool);
725 void vp9_remove_compressor(VP9_COMP *cpi);
726
727 void vp9_change_config(VP9_COMP *cpi, const VP9EncoderConfig *oxcf);
728
729 // receive a frames worth of data. caller can assume that a copy of this
730 // frame is made and not just a copy of the pointer..
731 int vp9_receive_raw_frame(VP9_COMP *cpi, vpx_enc_frame_flags_t frame_flags,
732                           YV12_BUFFER_CONFIG *sd, int64_t time_stamp,
733                           int64_t end_time_stamp);
734
735 int vp9_get_compressed_data(VP9_COMP *cpi, unsigned int *frame_flags,
736                             size_t *size, uint8_t *dest, int64_t *time_stamp,
737                             int64_t *time_end, int flush);
738
739 int vp9_get_preview_raw_frame(VP9_COMP *cpi, YV12_BUFFER_CONFIG *dest,
740                               vp9_ppflags_t *flags);
741
742 int vp9_use_as_reference(VP9_COMP *cpi, int ref_frame_flags);
743
744 void vp9_update_reference(VP9_COMP *cpi, int ref_frame_flags);
745
746 int vp9_copy_reference_enc(VP9_COMP *cpi, VP9_REFFRAME ref_frame_flag,
747                            YV12_BUFFER_CONFIG *sd);
748
749 int vp9_set_reference_enc(VP9_COMP *cpi, VP9_REFFRAME ref_frame_flag,
750                           YV12_BUFFER_CONFIG *sd);
751
752 int vp9_update_entropy(VP9_COMP *cpi, int update);
753
754 int vp9_set_active_map(VP9_COMP *cpi, unsigned char *map, int rows, int cols);
755
756 int vp9_get_active_map(VP9_COMP *cpi, unsigned char *map, int rows, int cols);
757
758 int vp9_set_internal_size(VP9_COMP *cpi, VPX_SCALING horiz_mode,
759                           VPX_SCALING vert_mode);
760
761 int vp9_set_size_literal(VP9_COMP *cpi, unsigned int width,
762                          unsigned int height);
763
764 void vp9_set_svc(VP9_COMP *cpi, int use_svc);
765
766 int vp9_get_quantizer(struct VP9_COMP *cpi);
767
768 static INLINE int frame_is_kf_gf_arf(const VP9_COMP *cpi) {
769   return frame_is_intra_only(&cpi->common) || cpi->refresh_alt_ref_frame ||
770          (cpi->refresh_golden_frame && !cpi->rc.is_src_frame_alt_ref);
771 }
772
773 static INLINE int get_ref_frame_map_idx(const VP9_COMP *cpi,
774                                         MV_REFERENCE_FRAME ref_frame) {
775   if (ref_frame == LAST_FRAME) {
776     return cpi->lst_fb_idx;
777   } else if (ref_frame == GOLDEN_FRAME) {
778     return cpi->gld_fb_idx;
779   } else {
780     return cpi->alt_fb_idx;
781   }
782 }
783
784 static INLINE int get_ref_frame_buf_idx(const VP9_COMP *const cpi,
785                                         int ref_frame) {
786   const VP9_COMMON *const cm = &cpi->common;
787   const int map_idx = get_ref_frame_map_idx(cpi, ref_frame);
788   return (map_idx != INVALID_IDX) ? cm->ref_frame_map[map_idx] : INVALID_IDX;
789 }
790
791 static INLINE YV12_BUFFER_CONFIG *get_ref_frame_buffer(
792     VP9_COMP *cpi, MV_REFERENCE_FRAME ref_frame) {
793   VP9_COMMON *const cm = &cpi->common;
794   const int buf_idx = get_ref_frame_buf_idx(cpi, ref_frame);
795   return buf_idx != INVALID_IDX ? &cm->buffer_pool->frame_bufs[buf_idx].buf
796                                 : NULL;
797 }
798
799 static INLINE int get_token_alloc(int mb_rows, int mb_cols) {
800   // TODO(JBB): double check we can't exceed this token count if we have a
801   // 32x32 transform crossing a boundary at a multiple of 16.
802   // mb_rows, cols are in units of 16 pixels. We assume 3 planes all at full
803   // resolution. We assume up to 1 token per pixel, and then allow
804   // a head room of 4.
805   return mb_rows * mb_cols * (16 * 16 * 3 + 4);
806 }
807
808 // Get the allocated token size for a tile. It does the same calculation as in
809 // the frame token allocation.
810 static INLINE int allocated_tokens(TileInfo tile) {
811   int tile_mb_rows = (tile.mi_row_end - tile.mi_row_start + 1) >> 1;
812   int tile_mb_cols = (tile.mi_col_end - tile.mi_col_start + 1) >> 1;
813
814   return get_token_alloc(tile_mb_rows, tile_mb_cols);
815 }
816
817 static INLINE void get_start_tok(VP9_COMP *cpi, int tile_row, int tile_col,
818                                  int mi_row, TOKENEXTRA **tok) {
819   VP9_COMMON *const cm = &cpi->common;
820   const int tile_cols = 1 << cm->log2_tile_cols;
821   TileDataEnc *this_tile = &cpi->tile_data[tile_row * tile_cols + tile_col];
822   const TileInfo *const tile_info = &this_tile->tile_info;
823
824   int tile_mb_cols = (tile_info->mi_col_end - tile_info->mi_col_start + 1) >> 1;
825   const int mb_row = (mi_row - tile_info->mi_row_start) >> 1;
826
827   *tok =
828       cpi->tile_tok[tile_row][tile_col] + get_token_alloc(mb_row, tile_mb_cols);
829 }
830
831 int64_t vp9_get_y_sse(const YV12_BUFFER_CONFIG *a, const YV12_BUFFER_CONFIG *b);
832 #if CONFIG_VP9_HIGHBITDEPTH
833 int64_t vp9_highbd_get_y_sse(const YV12_BUFFER_CONFIG *a,
834                              const YV12_BUFFER_CONFIG *b);
835 #endif  // CONFIG_VP9_HIGHBITDEPTH
836
837 void vp9_scale_references(VP9_COMP *cpi);
838
839 void vp9_update_reference_frames(VP9_COMP *cpi);
840
841 void vp9_set_high_precision_mv(VP9_COMP *cpi, int allow_high_precision_mv);
842
843 YV12_BUFFER_CONFIG *vp9_svc_twostage_scale(VP9_COMMON *cm,
844                                            YV12_BUFFER_CONFIG *unscaled,
845                                            YV12_BUFFER_CONFIG *scaled,
846                                            YV12_BUFFER_CONFIG *scaled_temp,
847                                            int phase_scaler, int phase_scaler2);
848
849 YV12_BUFFER_CONFIG *vp9_scale_if_required(VP9_COMMON *cm,
850                                           YV12_BUFFER_CONFIG *unscaled,
851                                           YV12_BUFFER_CONFIG *scaled,
852                                           int use_normative_scaler,
853                                           int phase_scaler);
854
855 void vp9_apply_encoding_flags(VP9_COMP *cpi, vpx_enc_frame_flags_t flags);
856
857 static INLINE int is_two_pass_svc(const struct VP9_COMP *const cpi) {
858   return cpi->use_svc && cpi->oxcf.pass != 0;
859 }
860
861 static INLINE int is_one_pass_cbr_svc(const struct VP9_COMP *const cpi) {
862   return (cpi->use_svc && cpi->oxcf.pass == 0);
863 }
864
865 #if CONFIG_VP9_TEMPORAL_DENOISING
866 static INLINE int denoise_svc(const struct VP9_COMP *const cpi) {
867   return (!cpi->use_svc ||
868           (cpi->use_svc &&
869            cpi->svc.spatial_layer_id == cpi->svc.number_spatial_layers - 1));
870 }
871 #endif
872
873 static INLINE int is_altref_enabled(const VP9_COMP *const cpi) {
874   return !(cpi->oxcf.mode == REALTIME && cpi->oxcf.rc_mode == VPX_CBR) &&
875          cpi->oxcf.lag_in_frames > 0 &&
876          (cpi->oxcf.enable_auto_arf &&
877           (!is_two_pass_svc(cpi) ||
878            cpi->oxcf.ss_enable_auto_arf[cpi->svc.spatial_layer_id]));
879 }
880
881 static INLINE void set_ref_ptrs(VP9_COMMON *cm, MACROBLOCKD *xd,
882                                 MV_REFERENCE_FRAME ref0,
883                                 MV_REFERENCE_FRAME ref1) {
884   xd->block_refs[0] =
885       &cm->frame_refs[ref0 >= LAST_FRAME ? ref0 - LAST_FRAME : 0];
886   xd->block_refs[1] =
887       &cm->frame_refs[ref1 >= LAST_FRAME ? ref1 - LAST_FRAME : 0];
888 }
889
890 static INLINE int get_chessboard_index(const int frame_index) {
891   return frame_index & 0x1;
892 }
893
894 static INLINE int *cond_cost_list(const struct VP9_COMP *cpi, int *cost_list) {
895   return cpi->sf.mv.subpel_search_method != SUBPEL_TREE ? cost_list : NULL;
896 }
897
898 static INLINE int get_num_vert_units(TileInfo tile, int shift) {
899   int num_vert_units =
900       (tile.mi_row_end - tile.mi_row_start + (1 << shift) - 1) >> shift;
901   return num_vert_units;
902 }
903
904 static INLINE int get_num_cols(TileInfo tile, int shift) {
905   int num_cols =
906       (tile.mi_col_end - tile.mi_col_start + (1 << shift) - 1) >> shift;
907   return num_cols;
908 }
909
910 static INLINE int get_level_index(VP9_LEVEL level) {
911   int i;
912   for (i = 0; i < VP9_LEVELS; ++i) {
913     if (level == vp9_level_defs[i].level) return i;
914   }
915   return -1;
916 }
917
918 VP9_LEVEL vp9_get_level(const Vp9LevelSpec *const level_spec);
919
920 void vp9_new_framerate(VP9_COMP *cpi, double framerate);
921
922 void vp9_set_row_mt(VP9_COMP *cpi);
923
924 #define LAYER_IDS_TO_IDX(sl, tl, num_tl) ((sl) * (num_tl) + (tl))
925
926 #ifdef __cplusplus
927 }  // extern "C"
928 #endif
929
930 #endif  // VP9_ENCODER_VP9_ENCODER_H_