1 /* 2 * Copyright © 2018-2020, VideoLAN and dav1d authors 3 * Copyright © 2018, Two Orioles, LLC 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions are met: 8 * 9 * 1. Redistributions of source code must retain the above copyright notice, this 10 * list of conditions and the following disclaimer. 11 * 12 * 2. Redistributions in binary form must reproduce the above copyright notice, 13 * this list of conditions and the following disclaimer in the documentation 14 * and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 19 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR 20 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 */ 27 28 #ifndef DAV1D_HEADERS_H 29 #define DAV1D_HEADERS_H 30 31 #include <stdint.h> 32 #include <stddef.h> 33 34 #ifdef __cplusplus 35 extern "C" { 36 #endif 37 38 // Constants from Section 3. "Symbols and abbreviated terms" 39 #define DAV1D_MAX_CDEF_STRENGTHS 8 40 #define DAV1D_MAX_OPERATING_POINTS 32 41 #define DAV1D_MAX_TILE_COLS 64 42 #define DAV1D_MAX_TILE_ROWS 64 43 #define DAV1D_MAX_SEGMENTS 8 44 #define DAV1D_NUM_REF_FRAMES 8 45 #define DAV1D_PRIMARY_REF_NONE 7 46 #define DAV1D_REFS_PER_FRAME 7 47 #define DAV1D_TOTAL_REFS_PER_FRAME (DAV1D_REFS_PER_FRAME + 1) 48 49 enum Dav1dObuType { 50 DAV1D_OBU_SEQ_HDR = 1, 51 DAV1D_OBU_TD = 2, 52 DAV1D_OBU_FRAME_HDR = 3, 53 DAV1D_OBU_TILE_GRP = 4, 54 DAV1D_OBU_METADATA = 5, 55 DAV1D_OBU_FRAME = 6, 56 DAV1D_OBU_REDUNDANT_FRAME_HDR = 7, 57 DAV1D_OBU_PADDING = 15, 58 }; 59 60 enum Dav1dTxfmMode { 61 DAV1D_TX_4X4_ONLY, 62 DAV1D_TX_LARGEST, 63 DAV1D_TX_SWITCHABLE, 64 DAV1D_N_TX_MODES, 65 }; 66 67 enum Dav1dFilterMode { 68 DAV1D_FILTER_8TAP_REGULAR, 69 DAV1D_FILTER_8TAP_SMOOTH, 70 DAV1D_FILTER_8TAP_SHARP, 71 DAV1D_N_SWITCHABLE_FILTERS, 72 DAV1D_FILTER_BILINEAR = DAV1D_N_SWITCHABLE_FILTERS, 73 DAV1D_N_FILTERS, 74 DAV1D_FILTER_SWITCHABLE = DAV1D_N_FILTERS, 75 }; 76 77 enum Dav1dAdaptiveBoolean { 78 DAV1D_OFF = 0, 79 DAV1D_ON = 1, 80 DAV1D_ADAPTIVE = 2, 81 }; 82 83 enum Dav1dRestorationType { 84 DAV1D_RESTORATION_NONE, 85 DAV1D_RESTORATION_SWITCHABLE, 86 DAV1D_RESTORATION_WIENER, 87 DAV1D_RESTORATION_SGRPROJ, 88 }; 89 90 enum Dav1dWarpedMotionType { 91 DAV1D_WM_TYPE_IDENTITY, 92 DAV1D_WM_TYPE_TRANSLATION, 93 DAV1D_WM_TYPE_ROT_ZOOM, 94 DAV1D_WM_TYPE_AFFINE, 95 }; 96 97 typedef struct Dav1dWarpedMotionParams { 98 enum Dav1dWarpedMotionType type; 99 int32_t matrix[6]; 100 union { 101 struct { 102 int16_t alpha, beta, gamma, delta; 103 } p; 104 int16_t abcd[4]; 105 } u; 106 } Dav1dWarpedMotionParams; 107 108 enum Dav1dPixelLayout { 109 DAV1D_PIXEL_LAYOUT_I400, ///< monochrome 110 DAV1D_PIXEL_LAYOUT_I420, ///< 4:2:0 planar 111 DAV1D_PIXEL_LAYOUT_I422, ///< 4:2:2 planar 112 DAV1D_PIXEL_LAYOUT_I444, ///< 4:4:4 planar 113 }; 114 115 enum Dav1dFrameType { 116 DAV1D_FRAME_TYPE_KEY = 0, ///< Key Intra frame 117 DAV1D_FRAME_TYPE_INTER = 1, ///< Inter frame 118 DAV1D_FRAME_TYPE_INTRA = 2, ///< Non key Intra frame 119 DAV1D_FRAME_TYPE_SWITCH = 3, ///< Switch Inter frame 120 }; 121 122 enum Dav1dColorPrimaries { 123 DAV1D_COLOR_PRI_BT709 = 1, 124 DAV1D_COLOR_PRI_UNKNOWN = 2, 125 DAV1D_COLOR_PRI_BT470M = 4, 126 DAV1D_COLOR_PRI_BT470BG = 5, 127 DAV1D_COLOR_PRI_BT601 = 6, 128 DAV1D_COLOR_PRI_SMPTE240 = 7, 129 DAV1D_COLOR_PRI_FILM = 8, 130 DAV1D_COLOR_PRI_BT2020 = 9, 131 DAV1D_COLOR_PRI_XYZ = 10, 132 DAV1D_COLOR_PRI_SMPTE431 = 11, 133 DAV1D_COLOR_PRI_SMPTE432 = 12, 134 DAV1D_COLOR_PRI_EBU3213 = 22, 135 DAV1D_COLOR_PRI_RESERVED = 255, 136 }; 137 138 enum Dav1dTransferCharacteristics { 139 DAV1D_TRC_BT709 = 1, 140 DAV1D_TRC_UNKNOWN = 2, 141 DAV1D_TRC_BT470M = 4, 142 DAV1D_TRC_BT470BG = 5, 143 DAV1D_TRC_BT601 = 6, 144 DAV1D_TRC_SMPTE240 = 7, 145 DAV1D_TRC_LINEAR = 8, 146 DAV1D_TRC_LOG100 = 9, ///< logarithmic (100:1 range) 147 DAV1D_TRC_LOG100_SQRT10 = 10, ///< lograithmic (100*sqrt(10):1 range) 148 DAV1D_TRC_IEC61966 = 11, 149 DAV1D_TRC_BT1361 = 12, 150 DAV1D_TRC_SRGB = 13, 151 DAV1D_TRC_BT2020_10BIT = 14, 152 DAV1D_TRC_BT2020_12BIT = 15, 153 DAV1D_TRC_SMPTE2084 = 16, ///< PQ 154 DAV1D_TRC_SMPTE428 = 17, 155 DAV1D_TRC_HLG = 18, ///< hybrid log/gamma (BT.2100 / ARIB STD-B67) 156 DAV1D_TRC_RESERVED = 255, 157 }; 158 159 enum Dav1dMatrixCoefficients { 160 DAV1D_MC_IDENTITY = 0, 161 DAV1D_MC_BT709 = 1, 162 DAV1D_MC_UNKNOWN = 2, 163 DAV1D_MC_FCC = 4, 164 DAV1D_MC_BT470BG = 5, 165 DAV1D_MC_BT601 = 6, 166 DAV1D_MC_SMPTE240 = 7, 167 DAV1D_MC_SMPTE_YCGCO = 8, 168 DAV1D_MC_BT2020_NCL = 9, 169 DAV1D_MC_BT2020_CL = 10, 170 DAV1D_MC_SMPTE2085 = 11, 171 DAV1D_MC_CHROMAT_NCL = 12, ///< Chromaticity-derived 172 DAV1D_MC_CHROMAT_CL = 13, 173 DAV1D_MC_ICTCP = 14, 174 DAV1D_MC_RESERVED = 255, 175 }; 176 177 enum Dav1dChromaSamplePosition { 178 DAV1D_CHR_UNKNOWN = 0, 179 DAV1D_CHR_VERTICAL = 1, ///< Horizontally co-located with luma(0, 0) 180 ///< sample, between two vertical samples 181 DAV1D_CHR_COLOCATED = 2, ///< Co-located with luma(0, 0) sample 182 }; 183 184 typedef struct Dav1dContentLightLevel { 185 uint16_t max_content_light_level; 186 uint16_t max_frame_average_light_level; 187 } Dav1dContentLightLevel; 188 189 typedef struct Dav1dMasteringDisplay { 190 ///< 0.16 fixed point 191 uint16_t primaries[3][2]; 192 ///< 0.16 fixed point 193 uint16_t white_point[2]; 194 ///< 24.8 fixed point 195 uint32_t max_luminance; 196 ///< 18.14 fixed point 197 uint32_t min_luminance; 198 } Dav1dMasteringDisplay; 199 200 typedef struct Dav1dITUTT35 { 201 uint8_t country_code; 202 uint8_t country_code_extension_byte; 203 size_t payload_size; 204 uint8_t *payload; 205 } Dav1dITUTT35; 206 207 typedef struct Dav1dSequenceHeader { 208 /** 209 * Stream profile, 0 for 8-10 bits/component 4:2:0 or monochrome; 210 * 1 for 8-10 bits/component 4:4:4; 2 for 4:2:2 at any bits/component, 211 * or 12 bits/component at any chroma subsampling. 212 */ 213 uint8_t profile; 214 /** 215 * Maximum dimensions for this stream. In non-scalable streams, these 216 * are often the actual dimensions of the stream, although that is not 217 * a normative requirement. 218 */ 219 int max_width, max_height; 220 enum Dav1dPixelLayout layout; ///< format of the picture 221 enum Dav1dColorPrimaries pri; ///< color primaries (av1) 222 enum Dav1dTransferCharacteristics trc; ///< transfer characteristics (av1) 223 enum Dav1dMatrixCoefficients mtrx; ///< matrix coefficients (av1) 224 enum Dav1dChromaSamplePosition chr; ///< chroma sample position (av1) 225 /** 226 * 0, 1 and 2 mean 8, 10 or 12 bits/component, respectively. This is not 227 * exactly the same as 'hbd' from the spec; the spec's hbd distinguishes 228 * between 8 (0) and 10-12 (1) bits/component, and another element 229 * (twelve_bit) to distinguish between 10 and 12 bits/component. To get 230 * the spec's hbd, use !!our_hbd, and to get twelve_bit, use hbd == 2. 231 */ 232 uint8_t hbd; 233 /** 234 * Pixel data uses JPEG pixel range ([0,255] for 8bits) instead of 235 * MPEG pixel range ([16,235] for 8bits luma, [16,240] for 8bits chroma). 236 */ 237 uint8_t color_range; 238 239 uint8_t num_operating_points; 240 struct Dav1dSequenceHeaderOperatingPoint { 241 uint8_t major_level, minor_level; 242 uint8_t initial_display_delay; 243 uint16_t idc; 244 uint8_t tier; 245 uint8_t decoder_model_param_present; 246 uint8_t display_model_param_present; 247 } operating_points[DAV1D_MAX_OPERATING_POINTS]; 248 249 uint8_t still_picture; 250 uint8_t reduced_still_picture_header; 251 uint8_t timing_info_present; 252 uint32_t num_units_in_tick; 253 uint32_t time_scale; 254 uint8_t equal_picture_interval; 255 uint32_t num_ticks_per_picture; 256 uint8_t decoder_model_info_present; 257 uint8_t encoder_decoder_buffer_delay_length; 258 uint32_t num_units_in_decoding_tick; 259 uint8_t buffer_removal_delay_length; 260 uint8_t frame_presentation_delay_length; 261 uint8_t display_model_info_present; 262 uint8_t width_n_bits, height_n_bits; 263 uint8_t frame_id_numbers_present; 264 uint8_t delta_frame_id_n_bits; 265 uint8_t frame_id_n_bits; 266 uint8_t sb128; 267 uint8_t filter_intra; 268 uint8_t intra_edge_filter; 269 uint8_t inter_intra; 270 uint8_t masked_compound; 271 uint8_t warped_motion; 272 uint8_t dual_filter; 273 uint8_t order_hint; 274 uint8_t jnt_comp; 275 uint8_t ref_frame_mvs; 276 enum Dav1dAdaptiveBoolean screen_content_tools; 277 enum Dav1dAdaptiveBoolean force_integer_mv; 278 uint8_t order_hint_n_bits; 279 uint8_t super_res; 280 uint8_t cdef; 281 uint8_t restoration; 282 uint8_t ss_hor, ss_ver, monochrome; 283 uint8_t color_description_present; 284 uint8_t separate_uv_delta_q; 285 uint8_t film_grain_present; 286 287 // Dav1dSequenceHeaders of the same sequence are required to be 288 // bit-identical until this offset. See 7.5 "Ordering of OBUs": 289 // Within a particular coded video sequence, the contents of 290 // sequence_header_obu must be bit-identical each time the 291 // sequence header appears except for the contents of 292 // operating_parameters_info. 293 struct Dav1dSequenceHeaderOperatingParameterInfo { 294 uint32_t decoder_buffer_delay; 295 uint32_t encoder_buffer_delay; 296 uint8_t low_delay_mode; 297 } operating_parameter_info[DAV1D_MAX_OPERATING_POINTS]; 298 } Dav1dSequenceHeader; 299 300 typedef struct Dav1dSegmentationData { 301 int16_t delta_q; 302 int8_t delta_lf_y_v, delta_lf_y_h, delta_lf_u, delta_lf_v; 303 int8_t ref; 304 uint8_t skip; 305 uint8_t globalmv; 306 } Dav1dSegmentationData; 307 308 typedef struct Dav1dSegmentationDataSet { 309 Dav1dSegmentationData d[DAV1D_MAX_SEGMENTS]; 310 uint8_t preskip; 311 int8_t last_active_segid; 312 } Dav1dSegmentationDataSet; 313 314 typedef struct Dav1dLoopfilterModeRefDeltas { 315 int8_t mode_delta[2 /* is_zeromv */]; 316 int8_t ref_delta[DAV1D_TOTAL_REFS_PER_FRAME]; 317 } Dav1dLoopfilterModeRefDeltas; 318 319 typedef struct Dav1dFilmGrainData { 320 unsigned seed; 321 int num_y_points; 322 uint8_t y_points[14][2 /* value, scaling */]; 323 int chroma_scaling_from_luma; 324 int num_uv_points[2]; 325 uint8_t uv_points[2][10][2 /* value, scaling */]; 326 int scaling_shift; 327 int ar_coeff_lag; 328 int8_t ar_coeffs_y[24]; 329 int8_t ar_coeffs_uv[2][25 + 3 /* padding for alignment purposes */]; 330 uint64_t ar_coeff_shift; 331 int grain_scale_shift; 332 int uv_mult[2]; 333 int uv_luma_mult[2]; 334 int uv_offset[2]; 335 int overlap_flag; 336 int clip_to_restricted_range; 337 } Dav1dFilmGrainData; 338 339 typedef struct Dav1dFrameHeader { 340 struct { 341 Dav1dFilmGrainData data; 342 uint8_t present, update; 343 } film_grain; ///< film grain parameters 344 enum Dav1dFrameType frame_type; ///< type of the picture 345 int width[2 /* { coded_width, superresolution_upscaled_width } */], height; 346 uint8_t frame_offset; ///< frame number 347 uint8_t temporal_id; ///< temporal id of the frame for SVC 348 uint8_t spatial_id; ///< spatial id of the frame for SVC 349 350 uint8_t show_existing_frame; 351 uint8_t existing_frame_idx; 352 uint32_t frame_id; 353 uint32_t frame_presentation_delay; 354 uint8_t show_frame; 355 uint8_t showable_frame; 356 uint8_t error_resilient_mode; 357 uint8_t disable_cdf_update; 358 uint8_t allow_screen_content_tools; 359 uint8_t force_integer_mv; 360 uint8_t frame_size_override; 361 uint8_t primary_ref_frame; 362 uint8_t buffer_removal_time_present; 363 struct Dav1dFrameHeaderOperatingPoint { 364 uint32_t buffer_removal_time; 365 } operating_points[DAV1D_MAX_OPERATING_POINTS]; 366 uint8_t refresh_frame_flags; 367 int render_width, render_height; 368 struct { 369 uint8_t width_scale_denominator; 370 uint8_t enabled; 371 } super_res; 372 uint8_t have_render_size; 373 uint8_t allow_intrabc; 374 uint8_t frame_ref_short_signaling; 375 int8_t refidx[DAV1D_REFS_PER_FRAME]; 376 uint8_t hp; 377 enum Dav1dFilterMode subpel_filter_mode; 378 uint8_t switchable_motion_mode; 379 uint8_t use_ref_frame_mvs; 380 uint8_t refresh_context; 381 struct { 382 uint8_t uniform; 383 uint8_t n_bytes; 384 uint8_t min_log2_cols, max_log2_cols, log2_cols, cols; 385 uint8_t min_log2_rows, max_log2_rows, log2_rows, rows; 386 uint16_t col_start_sb[DAV1D_MAX_TILE_COLS + 1]; 387 uint16_t row_start_sb[DAV1D_MAX_TILE_ROWS + 1]; 388 uint16_t update; 389 } tiling; 390 struct { 391 uint8_t yac; 392 int8_t ydc_delta; 393 int8_t udc_delta, uac_delta, vdc_delta, vac_delta; 394 uint8_t qm, qm_y, qm_u, qm_v; 395 } quant; 396 struct { 397 uint8_t enabled, update_map, temporal, update_data; 398 Dav1dSegmentationDataSet seg_data; 399 uint8_t lossless[DAV1D_MAX_SEGMENTS], qidx[DAV1D_MAX_SEGMENTS]; 400 } segmentation; 401 struct { 402 struct { 403 uint8_t present; 404 uint8_t res_log2; 405 } q; 406 struct { 407 uint8_t present; 408 uint8_t res_log2; 409 uint8_t multi; 410 } lf; 411 } delta; 412 uint8_t all_lossless; 413 struct { 414 uint8_t level_y[2 /* dir */]; 415 uint8_t level_u, level_v; 416 uint8_t mode_ref_delta_enabled; 417 uint8_t mode_ref_delta_update; 418 Dav1dLoopfilterModeRefDeltas mode_ref_deltas; 419 uint8_t sharpness; 420 } loopfilter; 421 struct { 422 uint8_t damping; 423 uint8_t n_bits; 424 uint8_t y_strength[DAV1D_MAX_CDEF_STRENGTHS]; 425 uint8_t uv_strength[DAV1D_MAX_CDEF_STRENGTHS]; 426 } cdef; 427 struct { 428 enum Dav1dRestorationType type[3 /* plane */]; 429 uint8_t unit_size[2 /* y, uv */]; 430 } restoration; 431 enum Dav1dTxfmMode txfm_mode; 432 uint8_t switchable_comp_refs; 433 uint8_t skip_mode_allowed, skip_mode_enabled; 434 int8_t skip_mode_refs[2]; 435 uint8_t warp_motion; 436 uint8_t reduced_txtp_set; 437 Dav1dWarpedMotionParams gmv[DAV1D_REFS_PER_FRAME]; 438 } Dav1dFrameHeader; 439 440 #ifdef __cplusplus 441 } /* extern "C" */ 442 #endif 443 444 #endif /* DAV1D_HEADERS_H */ 445