File: | root/firefox-clang/third_party/aom/av1/decoder/decoder.h |
Warning: | line 232, column 16 Excessive padding in 'struct AV1Decoder' (51 padding bytes, where 19 is optimal). Optimal fields order: dcb, common, td, cdef_worker, tile_workers, thread_data, tile_data, num_output_frames, frame_header_size, cb_buffer_base, row_mt_mutex_, row_mt_cond_, metadata, obu_size_hdr, cdef_sync, tile_mt_info, output_frames, lf_worker, lf_row_sync, lr_row_sync, lr_ctxt, tile_list_outbuf, error, seq_params, ext_refs, tile_buffers, num_workers, allocated_tiles, output_all_layers, decoding_first_frame, allow_lowbitdepth, max_threads, inv_tile_order, need_resync, reset_decoder_state, tile_size_bytes, tile_col_size_bytes, dec_tile_row, dec_tile_col, sequence_header_ready, sequence_header_changed, operating_point, current_operating_point, seen_frame_header, next_start_tile, camera_frame_header_ready, output_frame_width_in_tiles_minus_1, output_frame_height_in_tiles_minus_1, tile_count_minus_1, coded_tile_data_size, ext_tile_debug, row_mt, cb_buffer_alloc_size, allocated_row_mt_sync_rows, context_update_tile_id, skip_loop_filter, skip_film_grain, is_annexb, is_fwd_kf_present, is_arf_frame_present, num_tile_groups, number_temporal_layers, number_spatial_layers, sframe_info, valid_for_referencing, frame_row_mt_info, buffer_removal_time_present, consider reordering the fields or adding explicit padding members |
Press '?' to see keyboard shortcuts
Keyboard shortcuts:
1 | /* |
2 | * Copyright (c) 2016, Alliance for Open Media. All rights reserved. |
3 | * |
4 | * This source code is subject to the terms of the BSD 2 Clause License and |
5 | * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License |
6 | * was not distributed with this source code in the LICENSE file, you can |
7 | * obtain it at www.aomedia.org/license/software. If the Alliance for Open |
8 | * Media Patent License 1.0 was not distributed with this source code in the |
9 | * PATENTS file, you can obtain it at www.aomedia.org/license/patent. |
10 | */ |
11 | |
12 | #ifndef AOM_AV1_DECODER_DECODER_H_ |
13 | #define AOM_AV1_DECODER_DECODER_H_ |
14 | |
15 | #include "config/aom_config.h" |
16 | |
17 | #include "aom/aom_codec.h" |
18 | #include "aom_dsp/bitreader.h" |
19 | #include "aom_scale/yv12config.h" |
20 | #include "aom_util/aom_thread.h" |
21 | |
22 | #include "av1/common/av1_common_int.h" |
23 | #include "av1/common/thread_common.h" |
24 | #include "av1/decoder/dthread.h" |
25 | #if CONFIG_ACCOUNTING0 |
26 | #include "av1/decoder/accounting.h" |
27 | #endif |
28 | #if CONFIG_INSPECTION0 |
29 | #include "av1/decoder/inspection.h" |
30 | #endif |
31 | |
32 | #ifdef __cplusplus |
33 | extern "C" { |
34 | #endif |
35 | |
36 | /*! |
37 | * \brief Contains coding block data required by the decoder. |
38 | * |
39 | * This includes: |
40 | * - Coding block info that is common between encoder and decoder. |
41 | * - Other coding block info only needed by the decoder. |
42 | * Contrast this with a similar struct MACROBLOCK on encoder side. |
43 | * This data is also common between ThreadData and AV1Decoder structs. |
44 | */ |
45 | typedef struct DecoderCodingBlock { |
46 | /*! |
47 | * Coding block info that is common between encoder and decoder. |
48 | */ |
49 | DECLARE_ALIGNED(32, MACROBLOCKD, xd)MACROBLOCKD xd __attribute__((aligned(32))); |
50 | /*! |
51 | * True if the at least one of the coding blocks decoded was corrupted. |
52 | */ |
53 | int corrupted; |
54 | /*! |
55 | * Pointer to 'mc_buf' inside 'pbi->td' (single-threaded decoding) or |
56 | * 'pbi->thread_data[i].td' (multi-threaded decoding). |
57 | */ |
58 | uint8_t *mc_buf[2]; |
59 | /*! |
60 | * Pointer to 'dqcoeff' inside 'td->cb_buffer_base' or 'pbi->cb_buffer_base' |
61 | * with appropriate offset for the current superblock, for each plane. |
62 | */ |
63 | tran_low_t *dqcoeff_block[MAX_MB_PLANE3]; |
64 | /*! |
65 | * cb_offset[p] is the offset into the dqcoeff_block[p] for the current coding |
66 | * block, for each plane 'p'. |
67 | */ |
68 | uint16_t cb_offset[MAX_MB_PLANE3]; |
69 | /*! |
70 | * Pointer to 'eob_data' inside 'td->cb_buffer_base' or 'pbi->cb_buffer_base' |
71 | * with appropriate offset for the current superblock, for each plane. |
72 | */ |
73 | eob_info *eob_data[MAX_MB_PLANE3]; |
74 | /*! |
75 | * txb_offset[p] is the offset into the eob_data[p] for the current coding |
76 | * block, for each plane 'p'. |
77 | */ |
78 | uint16_t txb_offset[MAX_MB_PLANE3]; |
79 | /*! |
80 | * ref_mv_count[i] specifies the number of number of motion vector candidates |
81 | * in xd->ref_mv_stack[i]. |
82 | */ |
83 | uint8_t ref_mv_count[MODE_CTX_REF_FRAMES(REF_FRAMES + (FWD_REFS * BWD_REFS + TOTAL_UNIDIR_COMP_REFS))]; |
84 | } DecoderCodingBlock; |
85 | |
86 | /*!\cond */ |
87 | |
88 | typedef void (*decode_block_visitor_fn_t)(const AV1_COMMON *const cm, |
89 | DecoderCodingBlock *dcb, |
90 | aom_reader *const r, const int plane, |
91 | const int row, const int col, |
92 | const TX_SIZE tx_size); |
93 | |
94 | typedef void (*predict_inter_block_visitor_fn_t)(AV1_COMMON *const cm, |
95 | DecoderCodingBlock *dcb, |
96 | BLOCK_SIZE bsize); |
97 | |
98 | typedef void (*cfl_store_inter_block_visitor_fn_t)(AV1_COMMON *const cm, |
99 | MACROBLOCKD *const xd); |
100 | |
101 | typedef struct ThreadData { |
102 | DecoderCodingBlock dcb; |
103 | |
104 | // Coding block buffer for the current superblock. |
105 | // Used only for single-threaded decoding and multi-threaded decoding with |
106 | // row_mt == 1 cases. |
107 | // See also: similar buffer in 'AV1Decoder'. |
108 | CB_BUFFER cb_buffer_base; |
109 | |
110 | aom_reader *bit_reader; |
111 | |
112 | // Motion compensation buffer used to get a prediction buffer with extended |
113 | // borders. One buffer for each of the two possible references. |
114 | uint8_t *mc_buf[2]; |
115 | // Mask for this block used for compound prediction. |
116 | uint8_t *seg_mask; |
117 | // Allocated size of 'mc_buf'. |
118 | int32_t mc_buf_size; |
119 | // If true, the pointers in 'mc_buf' were converted from highbd pointers. |
120 | int mc_buf_use_highbd; // Boolean: whether the byte pointers stored in |
121 | // mc_buf were converted from highbd pointers. |
122 | |
123 | CONV_BUF_TYPE *tmp_conv_dst; |
124 | uint8_t *tmp_obmc_bufs[2]; |
125 | |
126 | decode_block_visitor_fn_t read_coeffs_tx_intra_block_visit; |
127 | decode_block_visitor_fn_t predict_and_recon_intra_block_visit; |
128 | decode_block_visitor_fn_t read_coeffs_tx_inter_block_visit; |
129 | decode_block_visitor_fn_t inverse_tx_inter_block_visit; |
130 | predict_inter_block_visitor_fn_t predict_inter_block_visit; |
131 | cfl_store_inter_block_visitor_fn_t cfl_store_inter_block_visit; |
132 | } ThreadData; |
133 | |
134 | typedef struct AV1DecRowMTJobInfo { |
135 | int tile_row; |
136 | int tile_col; |
137 | int mi_row; |
138 | } AV1DecRowMTJobInfo; |
139 | |
140 | typedef struct AV1DecRowMTSyncData { |
141 | #if CONFIG_MULTITHREAD1 |
142 | pthread_mutex_t *mutex_; |
143 | pthread_cond_t *cond_; |
144 | #endif |
145 | int allocated_sb_rows; |
146 | int *cur_sb_col; |
147 | // Denotes the superblock interval at which conditional signalling should |
148 | // happen. Also denotes the minimum number of extra superblocks of the top row |
149 | // to be complete to start decoding the current superblock. A value of 1 |
150 | // indicates top-right dependency. |
151 | int sync_range; |
152 | // Denotes the additional number of superblocks in the previous row to be |
153 | // complete to start decoding the current superblock when intraBC tool is |
154 | // enabled. This additional top-right delay is required to satisfy the |
155 | // hardware constraints for intraBC tool when row multithreading is enabled. |
156 | int intrabc_extra_top_right_sb_delay; |
157 | int mi_rows; |
158 | int mi_cols; |
159 | int mi_rows_parse_done; |
160 | int mi_rows_decode_started; |
161 | int num_threads_working; |
162 | } AV1DecRowMTSync; |
163 | |
164 | typedef struct AV1DecRowMTInfo { |
165 | int tile_rows_start; |
166 | int tile_rows_end; |
167 | int tile_cols_start; |
168 | int tile_cols_end; |
169 | int start_tile; |
170 | int end_tile; |
171 | int mi_rows_to_decode; |
172 | |
173 | // Invariant: |
174 | // mi_rows_parse_done >= mi_rows_decode_started. |
175 | // mi_rows_parse_done and mi_rows_decode_started are both initialized to 0. |
176 | // mi_rows_parse_done is incremented freely. mi_rows_decode_started may only |
177 | // be incremented to catch up with mi_rows_parse_done but is not allowed to |
178 | // surpass mi_rows_parse_done. |
179 | // |
180 | // When mi_rows_decode_started reaches mi_rows_to_decode, there are no more |
181 | // decode jobs. |
182 | |
183 | // Indicates the progress of the bit-stream parsing of superblocks. |
184 | // Initialized to 0. Incremented by sb_mi_size when parse sb row is done. |
185 | int mi_rows_parse_done; |
186 | // Indicates the progress of the decoding of superblocks. |
187 | // Initialized to 0. Incremented by sb_mi_size when decode sb row is started. |
188 | int mi_rows_decode_started; |
189 | // Boolean: Initialized to 0 (false). Set to 1 (true) on error to abort |
190 | // decoding. |
191 | int row_mt_exit; |
192 | } AV1DecRowMTInfo; |
193 | |
194 | typedef struct TileDataDec { |
195 | TileInfo tile_info; |
196 | aom_reader bit_reader; |
197 | DECLARE_ALIGNED(16, FRAME_CONTEXT, tctx)FRAME_CONTEXT tctx __attribute__((aligned(16))); |
198 | AV1DecRowMTSync dec_row_mt_sync; |
199 | } TileDataDec; |
200 | |
201 | typedef struct TileBufferDec { |
202 | const uint8_t *data; |
203 | size_t size; |
204 | } TileBufferDec; |
205 | |
206 | typedef struct DataBuffer { |
207 | const uint8_t *data; |
208 | size_t size; |
209 | } DataBuffer; |
210 | |
211 | typedef struct EXTERNAL_REFERENCES { |
212 | YV12_BUFFER_CONFIG refs[MAX_EXTERNAL_REFERENCES128]; |
213 | int num; |
214 | } EXTERNAL_REFERENCES; |
215 | |
216 | typedef struct TileJobsDec { |
217 | TileBufferDec *tile_buffer; |
218 | TileDataDec *tile_data; |
219 | } TileJobsDec; |
220 | |
221 | typedef struct AV1DecTileMTData { |
222 | #if CONFIG_MULTITHREAD1 |
223 | pthread_mutex_t *job_mutex; |
224 | #endif |
225 | TileJobsDec *job_queue; |
226 | int jobs_enqueued; |
227 | int jobs_dequeued; |
228 | int alloc_tile_rows; |
229 | int alloc_tile_cols; |
230 | } AV1DecTileMT; |
231 | |
232 | typedef struct AV1Decoder { |
Excessive padding in 'struct AV1Decoder' (51 padding bytes, where 19 is optimal). Optimal fields order: dcb, common, td, cdef_worker, tile_workers, thread_data, tile_data, num_output_frames, frame_header_size, cb_buffer_base, row_mt_mutex_, row_mt_cond_, metadata, obu_size_hdr, cdef_sync, tile_mt_info, output_frames, lf_worker, lf_row_sync, lr_row_sync, lr_ctxt, tile_list_outbuf, error, seq_params, ext_refs, tile_buffers, num_workers, allocated_tiles, output_all_layers, decoding_first_frame, allow_lowbitdepth, max_threads, inv_tile_order, need_resync, reset_decoder_state, tile_size_bytes, tile_col_size_bytes, dec_tile_row, dec_tile_col, sequence_header_ready, sequence_header_changed, operating_point, current_operating_point, seen_frame_header, next_start_tile, camera_frame_header_ready, output_frame_width_in_tiles_minus_1, output_frame_height_in_tiles_minus_1, tile_count_minus_1, coded_tile_data_size, ext_tile_debug, row_mt, cb_buffer_alloc_size, allocated_row_mt_sync_rows, context_update_tile_id, skip_loop_filter, skip_film_grain, is_annexb, is_fwd_kf_present, is_arf_frame_present, num_tile_groups, number_temporal_layers, number_spatial_layers, sframe_info, valid_for_referencing, frame_row_mt_info, buffer_removal_time_present, consider reordering the fields or adding explicit padding members | |
233 | DecoderCodingBlock dcb; |
234 | |
235 | DECLARE_ALIGNED(32, AV1_COMMON, common)AV1_COMMON common __attribute__((aligned(32))); |
236 | |
237 | AVxWorker lf_worker; |
238 | AV1LfSync lf_row_sync; |
239 | AV1LrSync lr_row_sync; |
240 | AV1LrStruct lr_ctxt; |
241 | AV1CdefSync cdef_sync; |
242 | AV1CdefWorkerData *cdef_worker; |
243 | AVxWorker *tile_workers; |
244 | int num_workers; |
245 | DecWorkerData *thread_data; |
246 | ThreadData td; |
247 | TileDataDec *tile_data; |
248 | int allocated_tiles; |
249 | |
250 | TileBufferDec tile_buffers[MAX_TILE_ROWS64][MAX_TILE_COLS64]; |
251 | AV1DecTileMT tile_mt_info; |
252 | |
253 | // Each time the decoder is called, we expect to receive a full temporal unit. |
254 | // This can contain up to one shown frame per spatial layer in the current |
255 | // operating point (note that some layers may be entirely omitted). |
256 | // If the 'output_all_layers' option is true, we save all of these shown |
257 | // frames so that they can be returned to the application. If the |
258 | // 'output_all_layers' option is false, then we only output one image per |
259 | // temporal unit. |
260 | // |
261 | // Note: The saved buffers are released at the start of the next time the |
262 | // application calls aom_codec_decode(). |
263 | int output_all_layers; |
264 | RefCntBuffer *output_frames[MAX_NUM_SPATIAL_LAYERS4]; |
265 | size_t num_output_frames; // How many frames are queued up so far? |
266 | |
267 | // In order to properly support random-access decoding, we need |
268 | // to behave slightly differently for the very first frame we decode. |
269 | // So we track whether this is the first frame or not. |
270 | int decoding_first_frame; |
271 | |
272 | int allow_lowbitdepth; |
273 | int max_threads; |
274 | int inv_tile_order; |
275 | int need_resync; // wait for key/intra-only frame. |
276 | int reset_decoder_state; |
277 | |
278 | int tile_size_bytes; |
279 | int tile_col_size_bytes; |
280 | int dec_tile_row, dec_tile_col; // always -1 for non-VR tile encoding |
281 | #if CONFIG_ACCOUNTING0 |
282 | int acct_enabled; |
283 | Accounting accounting; |
284 | #endif |
285 | int sequence_header_ready; |
286 | int sequence_header_changed; |
287 | #if CONFIG_INSPECTION0 |
288 | aom_inspect_cb inspect_cb; |
289 | void *inspect_ctx; |
290 | #endif |
291 | int operating_point; |
292 | int current_operating_point; |
293 | int seen_frame_header; |
294 | // The expected start_tile (tg_start syntax element) of the next tile group. |
295 | int next_start_tile; |
296 | |
297 | // State if the camera frame header is already decoded while |
298 | // large_scale_tile = 1. |
299 | int camera_frame_header_ready; |
300 | size_t frame_header_size; |
301 | DataBuffer obu_size_hdr; |
302 | int output_frame_width_in_tiles_minus_1; |
303 | int output_frame_height_in_tiles_minus_1; |
304 | int tile_count_minus_1; |
305 | uint32_t coded_tile_data_size; |
306 | unsigned int ext_tile_debug; // for ext-tile software debug & testing |
307 | |
308 | // Decoder has 3 modes of operation: |
309 | // (1) Single-threaded decoding. |
310 | // (2) Multi-threaded decoding with each tile decoded in parallel. |
311 | // (3) In addition to (2), each thread decodes 1 superblock row in parallel. |
312 | // row_mt = 1 triggers mode (3) above, while row_mt = 0, will trigger mode (1) |
313 | // or (2) depending on 'max_threads'. |
314 | unsigned int row_mt; |
315 | |
316 | EXTERNAL_REFERENCES ext_refs; |
317 | YV12_BUFFER_CONFIG tile_list_outbuf; |
318 | |
319 | // Coding block buffer for the current frame. |
320 | // Allocated and used only for multi-threaded decoding with 'row_mt == 0'. |
321 | // See also: similar buffer in 'ThreadData' struct. |
322 | CB_BUFFER *cb_buffer_base; |
323 | // Allocated size of 'cb_buffer_base'. Currently same as the number of |
324 | // superblocks in the coded frame. |
325 | int cb_buffer_alloc_size; |
326 | |
327 | int allocated_row_mt_sync_rows; |
328 | |
329 | #if CONFIG_MULTITHREAD1 |
330 | pthread_mutex_t *row_mt_mutex_; |
331 | pthread_cond_t *row_mt_cond_; |
332 | #endif |
333 | |
334 | AV1DecRowMTInfo frame_row_mt_info; |
335 | aom_metadata_array_t *metadata; |
336 | |
337 | int context_update_tile_id; |
338 | int skip_loop_filter; |
339 | int skip_film_grain; |
340 | int is_annexb; |
341 | int valid_for_referencing[REF_FRAMES]; |
342 | int is_fwd_kf_present; |
343 | int is_arf_frame_present; |
344 | int num_tile_groups; |
345 | aom_s_frame_info sframe_info; |
346 | |
347 | /*! |
348 | * Elements part of the sequence header, that are applicable for all the |
349 | * frames in the video. |
350 | */ |
351 | SequenceHeader seq_params; |
352 | |
353 | /*! |
354 | * If true, buffer removal times are present. |
355 | */ |
356 | bool_Bool buffer_removal_time_present; |
357 | |
358 | /*! |
359 | * Code and details about current error status. |
360 | */ |
361 | struct aom_internal_error_info error; |
362 | |
363 | /*! |
364 | * Number of temporal layers: may be > 1 for SVC (scalable vector coding). |
365 | */ |
366 | unsigned int number_temporal_layers; |
367 | |
368 | /*! |
369 | * Number of spatial layers: may be > 1 for SVC (scalable vector coding). |
370 | */ |
371 | unsigned int number_spatial_layers; |
372 | } AV1Decoder; |
373 | |
374 | // Returns 0 on success. Sets pbi->common.error.error_code to a nonzero error |
375 | // code and returns a nonzero value on failure. |
376 | int av1_receive_compressed_data(struct AV1Decoder *pbi, size_t size, |
377 | const uint8_t **psource); |
378 | |
379 | // Get the frame at a particular index in the output queue |
380 | int av1_get_raw_frame(AV1Decoder *pbi, size_t index, YV12_BUFFER_CONFIG **sd, |
381 | aom_film_grain_t **grain_params); |
382 | |
383 | int av1_get_frame_to_show(struct AV1Decoder *pbi, YV12_BUFFER_CONFIG *frame); |
384 | |
385 | aom_codec_err_t av1_copy_reference_dec(struct AV1Decoder *pbi, int idx, |
386 | YV12_BUFFER_CONFIG *sd); |
387 | |
388 | aom_codec_err_t av1_set_reference_dec(AV1_COMMON *cm, int idx, |
389 | int use_external_ref, |
390 | YV12_BUFFER_CONFIG *sd); |
391 | aom_codec_err_t av1_copy_new_frame_dec(AV1_COMMON *cm, |
392 | YV12_BUFFER_CONFIG *new_frame, |
393 | YV12_BUFFER_CONFIG *sd); |
394 | |
395 | struct AV1Decoder *av1_decoder_create(BufferPool *const pool); |
396 | |
397 | void av1_decoder_remove(struct AV1Decoder *pbi); |
398 | void av1_dealloc_dec_jobs(struct AV1DecTileMTData *tile_mt_info); |
399 | |
400 | void av1_dec_row_mt_dealloc(AV1DecRowMTSync *dec_row_mt_sync); |
401 | |
402 | void av1_dec_free_cb_buf(AV1Decoder *pbi); |
403 | |
404 | static inline void decrease_ref_count(RefCntBuffer *const buf, |
405 | BufferPool *const pool) { |
406 | if (buf != NULL((void*)0)) { |
407 | --buf->ref_count; |
408 | // Reference counts should never become negative. If this assertion fails, |
409 | // there is a bug in our reference count management. |
410 | assert(buf->ref_count >= 0)((void) sizeof ((buf->ref_count >= 0) ? 1 : 0), __extension__ ({ if (buf->ref_count >= 0) ; else __assert_fail ("buf->ref_count >= 0" , "/root/firefox-clang/third_party/aom/av1/decoder/decoder.h" , 410, __extension__ __PRETTY_FUNCTION__); })); |
411 | // A worker may only get a free framebuffer index when calling get_free_fb. |
412 | // But the raw frame buffer is not set up until we finish decoding header. |
413 | // So if any error happens during decoding header, frame_bufs[idx] will not |
414 | // have a valid raw frame buffer. |
415 | if (buf->ref_count == 0 && buf->raw_frame_buffer.data) { |
416 | pool->release_fb_cb(pool->cb_priv, &buf->raw_frame_buffer); |
417 | buf->raw_frame_buffer.data = NULL((void*)0); |
418 | buf->raw_frame_buffer.size = 0; |
419 | buf->raw_frame_buffer.priv = NULL((void*)0); |
420 | } |
421 | } |
422 | } |
423 | |
424 | #define ACCT_STR__func__ __func__ |
425 | static inline int av1_read_uniform(aom_reader *r, int n) { |
426 | const int l = get_unsigned_bits(n); |
427 | const int m = (1 << l) - n; |
428 | const int v = aom_read_literal(r, l - 1, ACCT_STR)aom_read_literal_(r, l - 1 ); |
429 | assert(l != 0)((void) sizeof ((l != 0) ? 1 : 0), __extension__ ({ if (l != 0 ) ; else __assert_fail ("l != 0", "/root/firefox-clang/third_party/aom/av1/decoder/decoder.h" , 429, __extension__ __PRETTY_FUNCTION__); })); |
430 | if (v < m) |
431 | return v; |
432 | else |
433 | return (v << 1) - m + aom_read_literal(r, 1, ACCT_STR)aom_read_literal_(r, 1 ); |
434 | } |
435 | |
436 | typedef void (*palette_visitor_fn_t)(MACROBLOCKD *const xd, int plane, |
437 | aom_reader *r); |
438 | |
439 | void av1_visit_palette(AV1Decoder *const pbi, MACROBLOCKD *const xd, |
440 | aom_reader *r, palette_visitor_fn_t visit); |
441 | |
442 | typedef void (*block_visitor_fn_t)(AV1Decoder *const pbi, ThreadData *const td, |
443 | int mi_row, int mi_col, aom_reader *r, |
444 | PARTITION_TYPE partition, BLOCK_SIZE bsize); |
445 | |
446 | /*!\endcond */ |
447 | |
448 | #ifdef __cplusplus |
449 | } // extern "C" |
450 | #endif |
451 | |
452 | #endif // AOM_AV1_DECODER_DECODER_H_ |