AOMedia AV1 Codec
bitstream.h
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_ENCODER_BITSTREAM_H_
13 #define AOM_AV1_ENCODER_BITSTREAM_H_
14 
15 #ifdef __cplusplus
16 extern "C" {
17 #endif
18 
19 #include "av1/common/av1_common_int.h"
20 #include "av1/common/blockd.h"
21 #include "av1/common/enums.h"
22 #include "av1/encoder/level.h"
23 #include "aom_dsp/bitwriter.h"
24 #include "aom_util/aom_pthread.h"
25 
26 struct aom_write_bit_buffer;
27 struct AV1_COMP;
28 struct ThreadData;
29 
32 // Stores the location and size of a tile's data in the bitstream. Used for
33 // later identifying identical tiles
34 typedef struct {
35  uint8_t *data;
36  size_t size;
37 } TileBufferEnc;
38 
39 typedef struct {
40  uint8_t *frame_header;
41  size_t obu_header_byte_offset;
42  size_t total_length;
43 } FrameHeaderInfo;
44 
45 typedef struct {
46  struct aom_write_bit_buffer *saved_wb; // Bit stream buffer writer structure
47  TileBufferEnc buf; // Structure to hold bitstream buffer and size
48  uint32_t *total_size; // Size of the bitstream buffer for the tile in bytes
49  uint8_t *dst; // Base address of tile bitstream buffer
50  uint8_t *tile_data_curr; // Base address of tile-group bitstream buffer
51  size_t tile_buf_size; // Available bitstream buffer for the tile in bytes
52  uint8_t obu_extn_header; // Presence of OBU extension header
53  uint32_t obu_header_size; // Size of the OBU header
54  int curr_tg_hdr_size; // Size of the obu, tg, frame headers
55  int tile_size_mi; // Tile size in mi units
56  int tile_row; // Number of tile rows
57  int tile_col; // Number of tile columns
58  int is_last_tile_in_tg; // Flag to indicate last tile in a tile-group
59  int new_tg; // Flag to indicate starting of a new tile-group
60 } PackBSParams;
61 
62 typedef struct {
63  uint64_t abs_sum_level;
64  uint16_t tile_idx;
65 } PackBSTileOrder;
66 
67 // Pack bitstream data for pack bitstream multi-threading.
68 typedef struct {
69 #if CONFIG_MULTITHREAD
70  // Mutex lock used while dispatching jobs.
71  pthread_mutex_t *mutex_;
72 #endif
73  // Tile order structure of pack bitstream multithreading.
74  PackBSTileOrder pack_bs_tile_order[MAX_TILES];
75 
76  // Index of next job to be processed.
77  int next_job_idx;
78  // Initialized to false, set to true by the worker thread that encounters an
79  // error in order to abort the processing of other worker threads.
80  bool pack_bs_mt_exit;
81 } AV1EncPackBSSync;
82 
85 // Writes only the OBU Sequence Header payload, and returns the size of the
86 // payload written to 'dst'. This function does not write the OBU header, the
87 // optional extension, or the OBU size to 'dst'.
88 uint32_t av1_write_sequence_header_obu(const SequenceHeader *seq_params,
89  uint8_t *const dst);
90 
91 // Writes the OBU header byte, and the OBU header extension byte when
92 // 'obu_extension' is non-zero. Returns number of bytes written to 'dst'.
93 uint32_t av1_write_obu_header(AV1LevelParams *const level_params,
94  int *frame_header_count, OBU_TYPE obu_type,
95  int obu_extension, uint8_t *const dst);
96 
97 int av1_write_uleb_obu_size(size_t obu_header_size, size_t obu_payload_size,
98  uint8_t *dest);
99 
100 // Pack tile data in the bitstream with tile_group, frame
101 // and OBU header.
102 void av1_pack_tile_info(struct AV1_COMP *const cpi, struct ThreadData *const td,
103  PackBSParams *const pack_bs_params);
104 
105 void av1_write_last_tile_info(
106  struct AV1_COMP *const cpi, const FrameHeaderInfo *fh_info,
107  struct aom_write_bit_buffer *saved_wb, size_t *curr_tg_data_size,
108  uint8_t *curr_tg_start, uint32_t *const total_size,
109  uint8_t **tile_data_start, int *const largest_tile_id,
110  int *const is_first_tg, uint32_t obu_header_size, uint8_t obu_extn_header);
111 
117 int av1_pack_bitstream(struct AV1_COMP *const cpi, uint8_t *dst, size_t *size,
118  int *const largest_tile_id);
119 
120 void av1_write_tx_type(const AV1_COMMON *const cm, const MACROBLOCKD *xd,
121  TX_TYPE tx_type, TX_SIZE tx_size, aom_writer *w);
122 
123 void av1_reset_pack_bs_thread_data(struct ThreadData *const td);
124 
125 void av1_accumulate_pack_bs_thread_data(struct AV1_COMP *const cpi,
126  struct ThreadData const *td);
127 
128 void av1_write_obu_tg_tile_headers(struct AV1_COMP *const cpi,
129  MACROBLOCKD *const xd,
130  PackBSParams *const pack_bs_params,
131  const int tile_idx);
132 
133 int av1_neg_interleave(int x, int ref, int max);
134 #ifdef __cplusplus
135 } // extern "C"
136 #endif
137 
138 #endif // AOM_AV1_ENCODER_BITSTREAM_H_
OBU_TYPE
OBU types.
Definition: aom_codec.h:546
int av1_pack_bitstream(struct AV1_COMP *const cpi, uint8_t *dst, size_t *size, int *const largest_tile_id)
Pack the bitstream for one frame.
Variables related to current coding block.
Definition: blockd.h:570
Top level encoder structure.
Definition: encoder.h:2866
Top level common structure used by both encoder and decoder.
Definition: av1_common_int.h:752