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