encoder.rs 81.3 KB
Newer Older
rzumer's avatar
rzumer committed
1 2 3 4 5 6 7 8 9
// Copyright (c) 2018, The rav1e contributors. All rights reserved
//
// This source code is subject to the terms of the BSD 2 Clause License and
// the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
// was not distributed with this source code in the LICENSE file, you can
// obtain it at www.aomedia.org/license/software. If the Alliance for Open
// Media Patent License 1.0 was not distributed with this source code in the
// PATENTS file, you can obtain it at www.aomedia.org/license/patent.

10
use api::*;
11
use cdef::*;
12
use context::*;
13 14
use deblock::*;
use ec::*;
15 16
use partition::*;
use plane::*;
17
use quantize::*;
18 19
use rdo::*;
use std::fmt;
20
use transform::*;
21 22
use util::*;

23
use bitstream_io::{BitWriter, BigEndian, LittleEndian};
24
use std;
25 26 27
use std::io;
use std::io::*;
use std::rc::Rc;
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42

extern {
    pub fn av1_rtcd();
    pub fn aom_dsp_rtcd();
}

#[derive(Debug, Clone)]
pub struct Frame {
    pub planes: [Plane; 3]
}

impl Frame {
    pub fn new(width: usize, height:usize) -> Frame {
        Frame {
            planes: [
fbossen's avatar
fbossen committed
43 44 45
                Plane::new(width, height, 0, 0, 128+8, 128+8),
                Plane::new(width/2, height/2, 1, 1, 64+8, 64+8),
                Plane::new(width/2, height/2, 1, 1, 64+8, 64+8)
46 47 48
            ]
        }
    }
fbossen's avatar
fbossen committed
49 50 51 52 53 54

    pub fn pad(&mut self) {
        for p in self.planes.iter_mut() {
            p.pad();
        }
    }
55 56 57 58 59 60 61 62 63 64

    pub fn window(&self, sbo: &SuperBlockOffset) -> Frame {
        Frame {
            planes: [
                self.planes[0].window(&sbo.plane_offset(&self.planes[0].cfg)),
                self.planes[1].window(&sbo.plane_offset(&self.planes[1].cfg)),
                self.planes[2].window(&sbo.plane_offset(&self.planes[2].cfg))
            ]
        }
    }
65 66
}

67 68
#[derive(Debug, Clone)]
pub struct ReferenceFrame {
fbossen's avatar
fbossen committed
69
  pub order_hint: u32,
70
  pub frame: Frame,
71
  pub cdfs: CDFContext
72 73
}

74 75
#[derive(Debug)]
pub struct ReferenceFramesSet {
76
    pub frames: [Option<Rc<ReferenceFrame>>; (REF_FRAMES as usize)],
77
    pub deblock: [DeblockState; (REF_FRAMES as usize)]
78 79 80 81 82
}

impl ReferenceFramesSet {
    pub fn new() -> ReferenceFramesSet {
        ReferenceFramesSet {
83
            frames: Default::default(),
84
            deblock: Default::default()
85 86 87 88 89 90 91 92
        }
    }
}

const MAX_NUM_TEMPORAL_LAYERS: usize = 8;
const MAX_NUM_SPATIAL_LAYERS: usize = 4;
const MAX_NUM_OPERATING_POINTS: usize = MAX_NUM_TEMPORAL_LAYERS * MAX_NUM_SPATIAL_LAYERS;

93
pub const PRIMARY_REF_NONE: u32 = 7;
94 95 96 97
const PRIMARY_REF_BITS: u32 = 3;

arg_enum!{
    #[derive(Copy, Clone, Debug, PartialEq)]
98
    #[repr(C)]
99 100 101 102 103 104 105 106 107 108 109 110 111
    pub enum Tune {
        Psnr,
        Psychovisual
    }
}

impl Default for Tune {
    fn default() -> Self {
        Tune::Psnr
    }
}

#[derive(Copy, Clone, Debug, PartialEq)]
112
#[repr(C)]
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
pub enum ChromaSampling {
    Cs420,
    Cs422,
    Cs444
}

impl Default for ChromaSampling {
    fn default() -> Self {
        ChromaSampling::Cs420
    }
}

#[derive(Copy, Clone)]
pub struct Sequence {
  // OBU Sequence header of AV1
    pub profile: u8,
    pub num_bits_width: u32,
    pub num_bits_height: u32,
    pub bit_depth: usize,
    pub chroma_sampling: ChromaSampling,
    pub max_frame_width: u32,
    pub max_frame_height: u32,
    pub frame_id_numbers_present_flag: bool,
    pub frame_id_length: u32,
    pub delta_frame_id_length: u32,
    pub use_128x128_superblock: bool,
    pub order_hint_bits_minus_1: u32,
    pub force_screen_content_tools: u32,  // 0 - force off
                                           // 1 - force on
                                           // 2 - adaptive
    pub force_integer_mv: u32,      // 0 - Not to force. MV can be in 1/4 or 1/8
                                     // 1 - force to integer
                                     // 2 - adaptive
    pub still_picture: bool,               // Video is a single frame still picture
    pub reduced_still_picture_hdr: bool,   // Use reduced header for still picture
    pub monochrome: bool,                  // Monochrome video
    pub enable_filter_intra: bool,         // enables/disables filterintra
    pub enable_intra_edge_filter: bool,    // enables/disables corner/edge/upsampling
    pub enable_interintra_compound: bool,  // enables/disables interintra_compound
    pub enable_masked_compound: bool,      // enables/disables masked compound
    pub enable_dual_filter: bool,         // 0 - disable dual interpolation filter
                                          // 1 - enable vert/horiz filter selection
    pub enable_order_hint: bool,     // 0 - disable order hint, and related tools
                                     // jnt_comp, ref_frame_mvs, frame_sign_bias
                                     // if 0, enable_jnt_comp and
                                     // enable_ref_frame_mvs must be set zs 0.
    pub enable_jnt_comp: bool,        // 0 - disable joint compound modes
                                     // 1 - enable it
    pub enable_ref_frame_mvs: bool,  // 0 - disable ref frame mvs
                                     // 1 - enable it
    pub enable_warped_motion: bool,   // 0 - disable warped motion for sequence
                                     // 1 - enable it for the sequence
    pub enable_superres: bool,// 0 - Disable superres for the sequence, and disable
                              //     transmitting per-frame superres enabled flag.
                              // 1 - Enable superres for the sequence, and also
                              //     enable per-frame flag to denote if superres is
                              //     enabled for that frame.
    pub enable_cdef: bool,         // To turn on/off CDEF
    pub enable_restoration: bool,  // To turn on/off loop restoration
    pub operating_points_cnt_minus_1: usize,
    pub operating_point_idc: [u16; MAX_NUM_OPERATING_POINTS],
    pub display_model_info_present_flag: bool,
    pub decoder_model_info_present_flag: bool,
    pub level: [[usize; 2]; MAX_NUM_OPERATING_POINTS],	// minor, major
    pub tier: [usize; MAX_NUM_OPERATING_POINTS],  // seq_tier in the spec. One bit: 0
                                                  // or 1.
    pub film_grain_params_present: bool,
    pub separate_uv_delta_q: bool,
}

impl Sequence {
184 185 186
    pub fn new(info: &FrameInfo) -> Sequence {
        let width_bits = 32 - (info.width as u32).leading_zeros();
        let height_bits = 32 - (info.height as u32).leading_zeros();
187 188 189
        assert!(width_bits <= 16);
        assert!(height_bits <= 16);

190
        let profile = if info.bit_depth == 12 {
191
            2
192
        } else if info.chroma_sampling == ChromaSampling::Cs444 {
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
            1
        } else {
            0
        };

        let mut operating_point_idc = [0 as u16; MAX_NUM_OPERATING_POINTS];
        let mut level = [[1, 2 as usize]; MAX_NUM_OPERATING_POINTS];
        let mut tier = [0 as usize; MAX_NUM_OPERATING_POINTS];

        for i in 0..MAX_NUM_OPERATING_POINTS {
            operating_point_idc[i] = 0;
            level[i][0] = 1;	// minor
            level[i][1] = 2;	// major
            tier[i] = 0;
        }

        Sequence {
            profile: profile,
            num_bits_width: width_bits,
            num_bits_height: height_bits,
213 214 215 216
            bit_depth: info.bit_depth,
            chroma_sampling: info.chroma_sampling,
            max_frame_width: info.width as u32,
            max_frame_height: info.height as u32,
217 218 219 220
            frame_id_numbers_present_flag: false,
            frame_id_length: 0,
            delta_frame_id_length: 0,
            use_128x128_superblock: false,
fbossen's avatar
fbossen committed
221
            order_hint_bits_minus_1: 3,
222 223 224 225 226 227 228 229 230 231
            force_screen_content_tools: 0,
            force_integer_mv: 2,
            still_picture: false,
            reduced_still_picture_hdr: false,
            monochrome: false,
            enable_filter_intra: true,
            enable_intra_edge_filter: true,
            enable_interintra_compound: false,
            enable_masked_compound: false,
            enable_dual_filter: false,
fbossen's avatar
fbossen committed
232
            enable_order_hint: true,
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
            enable_jnt_comp: false,
            enable_ref_frame_mvs: false,
            enable_warped_motion: false,
            enable_superres: false,
            enable_cdef: true,
            enable_restoration: true,
            operating_points_cnt_minus_1: 0,
            operating_point_idc: operating_point_idc,
            display_model_info_present_flag: false,
            decoder_model_info_present_flag: false,
            level: level,
            tier: tier,
            film_grain_params_present: false,
            separate_uv_delta_q: false,
        }
    }
fbossen's avatar
fbossen committed
249 250 251 252 253 254

    pub fn get_relative_dist(&self, a: u32, b: u32) -> i32 {
        let diff = a as i32 - b as i32;
        let m = 1 << self.order_hint_bits_minus_1;
        (diff & (m - 1)) - (diff & m)
    }
fbossen's avatar
fbossen committed
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307

    pub fn get_skip_mode_allowed(&self, fi: &FrameInvariants, reference_select: bool) -> bool {
      if fi.intra_only || !reference_select || !self.enable_order_hint {
        false
      } else {
        let mut forward_idx: isize = -1;
        let mut backward_idx: isize = -1;
        let mut forward_hint = 0;
        let mut backward_hint = 0;
        for i in 0..INTER_REFS_PER_FRAME {
          if let Some(ref rec) = fi.rec_buffer.frames[fi.ref_frames[i] as usize] {
            let ref_hint = rec.order_hint;
            if self.get_relative_dist(ref_hint, fi.order_hint) < 0 {
              if forward_idx < 0 || self.get_relative_dist(ref_hint, forward_hint) > 0 {
                forward_idx = i as isize;
                forward_hint = ref_hint;
              }
            } else if self.get_relative_dist(ref_hint, fi.order_hint) > 0 {
              if backward_idx < 0 || self.get_relative_dist(ref_hint, backward_hint) > 0 {
                backward_idx = i as isize;
                backward_hint = ref_hint;
              }
            }
          }
        }
        if forward_idx < 0 {
          false
        } else if backward_idx >= 0 {
          // set skip_mode_frame
          true
        } else {
          let mut second_forward_idx: isize = -1;
          let mut second_forward_hint = 0;
          for i in 0..INTER_REFS_PER_FRAME {
            if let Some(ref rec) = fi.rec_buffer.frames[fi.ref_frames[i] as usize] {
              let ref_hint = rec.order_hint;
              if self.get_relative_dist(ref_hint, forward_hint) < 0 {
                if second_forward_idx < 0 || self.get_relative_dist(ref_hint, second_forward_hint) > 0 {
                  second_forward_idx = i as isize;
                  second_forward_hint = ref_hint;
                }
              }
            }
          }
          if second_forward_idx < 0 {
            false
          } else {
            // set skip_mode_frame
            true
          }
        }
      }
    }
308 309
}

Luca Barbato's avatar
Luca Barbato committed
310 311
use std::sync::Arc;

312 313
#[derive(Debug)]
pub struct FrameState {
Luca Barbato's avatar
Luca Barbato committed
314
    pub input: Arc<Frame>,
315 316
    pub rec: Frame,
    pub qc: QuantizationContext,
317
    pub cdfs: CDFContext,
318
    pub deblock: DeblockState,
319 320 321 322 323
}

impl FrameState {
    pub fn new(fi: &FrameInvariants) -> FrameState {
        FrameState {
Luca Barbato's avatar
Luca Barbato committed
324
            input: Arc::new(Frame::new(fi.padded_w, fi.padded_h)),
325 326
            rec: Frame::new(fi.padded_w, fi.padded_h),
            qc: Default::default(),
327
            cdfs: CDFContext::new(0),
328
            deblock: Default::default(),
329 330
        }
    }
331 332 333

    pub fn window(&self, sbo: &SuperBlockOffset) -> FrameState {
        FrameState {
334
            input: Arc::new(self.input.window(sbo)),
335 336
            rec: self.rec.window(sbo),
            qc: self.qc.clone(),
337 338
            cdfs: self.cdfs.clone(),
            deblock: self.deblock.clone()
339 340
        }
    }
341 342
}

343 344
#[derive(Copy, Clone, Debug)]
pub struct DeblockState {
345
    pub levels: [u8; PLANES+1],  // Y vertical edges, Y horizontal, U, V
346 347 348 349 350
    pub sharpness: u8,
    pub deltas_enabled: bool,
    pub delta_updates_enabled: bool,
    pub ref_deltas: [i8; REF_FRAMES],
    pub mode_deltas: [i8; 2],
351 352 353
    pub block_deltas_enabled: bool,
    pub block_delta_shift: u8,
    pub block_delta_multi: bool,
354 355 356 357 358
}

impl Default for DeblockState {
    fn default() -> Self {
        DeblockState {
359
            levels: [8,8,4,4],
360
            sharpness: 0,
361
            deltas_enabled: false, // requires delta_q_enabled
362 363
            delta_updates_enabled: false,
            ref_deltas: [1, 0, 0, 0, 0, -1, -1, -1],
364 365 366 367
            mode_deltas: [0, 0],
            block_deltas_enabled: false,
            block_delta_shift: 0,
            block_delta_multi: false
368 369 370 371
        }
    }
}

372 373 374 375 376 377 378 379 380 381 382 383 384
// Frame Invariants are invariant inside a frame
#[allow(dead_code)]
#[derive(Debug)]
pub struct FrameInvariants {
    pub width: usize,
    pub height: usize,
    pub padded_w: usize,
    pub padded_h: usize,
    pub sb_width: usize,
    pub sb_height: usize,
    pub w_in_b: usize,
    pub h_in_b: usize,
    pub number: u64,
fbossen's avatar
fbossen committed
385
    pub order_hint: u32,
386 387 388 389 390 391 392
    pub show_frame: bool,
    pub showable_frame: bool,
    pub error_resilient: bool,
    pub intra_only: bool,
    pub allow_high_precision_mv: bool,
    pub frame_type: FrameType,
    pub show_existing_frame: bool,
fbossen's avatar
fbossen committed
393
    pub frame_to_show_map_idx: u32,
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
    pub use_reduced_tx_set: bool,
    pub reference_mode: ReferenceMode,
    pub use_prev_frame_mvs: bool,
    pub min_partition_size: BlockSize,
    pub globalmv_transformation_type: [GlobalMVMode; ALTREF_FRAME + 1],
    pub num_tg: usize,
    pub large_scale_tile: bool,
    pub disable_cdf_update: bool,
    pub allow_screen_content_tools: u32,
    pub force_integer_mv: u32,
    pub primary_ref_frame: u32,
    pub refresh_frame_flags: u32,  // a bitmask that specifies which
    // reference frame slots will be updated with the current frame
    // after it is decoded.
    pub allow_intrabc: bool,
    pub use_ref_frame_mvs: bool,
    pub is_filter_switchable: bool,
    pub is_motion_mode_switchable: bool,
    pub disable_frame_end_update_cdf: bool,
    pub allow_warped_motion: bool,
    pub cdef_damping: u8,
    pub cdef_bits: u8,
    pub cdef_y_strengths: [u8; 8],
    pub cdef_uv_strengths: [u8; 8],
418
    pub delta_q_present: bool,
419
    pub config: EncoderConfig,
420
    pub ref_frames: [u8; INTER_REFS_PER_FRAME],
fbossen's avatar
fbossen committed
421
    pub ref_frame_sign_bias: [bool; INTER_REFS_PER_FRAME],
422
    pub rec_buffer: ReferenceFramesSet,
Frank Bossen's avatar
Frank Bossen committed
423
    pub base_q_idx: u8,
fbossen's avatar
fbossen committed
424
    pub me_range_scale: u8,
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
}

impl FrameInvariants {
    pub fn new(width: usize, height: usize, config: EncoderConfig) -> FrameInvariants {
        // Speed level decides the minimum partition size, i.e. higher speed --> larger min partition size,
        // with exception that SBs on right or bottom frame borders split down to BLOCK_4X4.
        // At speed = 0, RDO search is exhaustive.
        let mut min_partition_size = if config.speed <= 1 { BlockSize::BLOCK_4X4 }
                                 else if config.speed <= 2 { BlockSize::BLOCK_8X8 }
                                 else if config.speed <= 3 { BlockSize::BLOCK_16X16 }
                                 else { BlockSize::BLOCK_32X32 };

        if config.tune == Tune::Psychovisual {
            if min_partition_size < BlockSize::BLOCK_8X8 {
                // TODO: Display message that min partition size is enforced to 8x8
                min_partition_size = BlockSize::BLOCK_8X8;
                println!("If tune=Psychovisual is used, min partition size is enforced to 8x8");
            }
        }
        let use_reduced_tx_set = config.speed > 1;

        FrameInvariants {
            width,
            height,
            padded_w: width.align_power_of_two(3),
            padded_h: height.align_power_of_two(3),
            sb_width: width.align_power_of_two_and_shift(6),
            sb_height: height.align_power_of_two_and_shift(6),
            w_in_b: 2 * width.align_power_of_two_and_shift(3), // MiCols, ((width+7)/8)<<3 >> MI_SIZE_LOG2
            h_in_b: 2 * height.align_power_of_two_and_shift(3), // MiRows, ((height+7)/8)<<3 >> MI_SIZE_LOG2
            number: 0,
fbossen's avatar
fbossen committed
456
            order_hint: 0,
457 458
            show_frame: true,
            showable_frame: true,
459
            error_resilient: false,
460
            intra_only: false,
461
            allow_high_precision_mv: false,
462 463
            frame_type: FrameType::KEY,
            show_existing_frame: false,
fbossen's avatar
fbossen committed
464
            frame_to_show_map_idx: 0,
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
            use_reduced_tx_set,
            reference_mode: ReferenceMode::SINGLE,
            use_prev_frame_mvs: false,
            min_partition_size,
            globalmv_transformation_type: [GlobalMVMode::IDENTITY; ALTREF_FRAME + 1],
            num_tg: 1,
            large_scale_tile: false,
            disable_cdf_update: false,
            allow_screen_content_tools: 0,
            force_integer_mv: 0,
            primary_ref_frame: PRIMARY_REF_NONE,
            refresh_frame_flags: 0,
            allow_intrabc: false,
            use_ref_frame_mvs: false,
            is_filter_switchable: false,
            is_motion_mode_switchable: false, // 0: only the SIMPLE motion mode will be used.
            disable_frame_end_update_cdf: false,
            allow_warped_motion: false,
            cdef_damping: 3,
            cdef_bits: 3,
            cdef_y_strengths: [0*4+0, 1*4+0, 2*4+1, 3*4+1, 5*4+2, 7*4+3, 10*4+3, 13*4+3],
            cdef_uv_strengths: [0*4+0, 1*4+0, 2*4+1, 3*4+1, 5*4+2, 7*4+3, 10*4+3, 13*4+3],
487
            delta_q_present: false,
488 489
            config,
            ref_frames: [0; INTER_REFS_PER_FRAME],
fbossen's avatar
fbossen committed
490
            ref_frame_sign_bias: [false; INTER_REFS_PER_FRAME],
491
            rec_buffer: ReferenceFramesSet::new(),
Frank Bossen's avatar
Frank Bossen committed
492
            base_q_idx: config.quantizer as u8,
fbossen's avatar
fbossen committed
493
            me_range_scale: 1,
494 495 496 497 498
        }
    }

    pub fn new_frame_state(&self) -> FrameState {
        FrameState {
Luca Barbato's avatar
Luca Barbato committed
499
            input: Arc::new(Frame::new(self.padded_w, self.padded_h)),
500 501
            rec: Frame::new(self.padded_w, self.padded_h),
            qc: Default::default(),
502
            cdfs: CDFContext::new(0),
503
            deblock: Default::default(),
504 505
        }
    }
fbossen's avatar
fbossen committed
506

507 508 509 510 511 512 513 514 515 516
}

impl fmt::Display for FrameInvariants{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Frame {} - {}", self.number, self.frame_type)
    }
}

#[allow(dead_code,non_camel_case_types)]
#[derive(Debug,PartialEq,Clone,Copy)]
517
#[repr(C)]
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
pub enum FrameType {
    KEY,
    INTER,
    INTRA_ONLY,
    SWITCH,
}

//const REFERENCE_MODES: usize = 3;

#[allow(dead_code,non_camel_case_types)]
#[derive(Debug,PartialEq)]
pub enum ReferenceMode {
  SINGLE = 0,
  COMPOUND = 1,
  SELECT = 2,
}

pub const ALL_REF_FRAMES_MASK: u32 = (1 << REF_FRAMES) - 1;

impl fmt::Display for FrameType{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            FrameType::KEY => write!(f, "Key frame"),
            FrameType::INTER => write!(f, "Inter frame"),
            FrameType::INTRA_ONLY => write!(f, "Intra only frame"),
            FrameType::SWITCH => write!(f, "Switching frame"),
        }
    }
}

pub fn write_ivf_header(output_file: &mut dyn io::Write, width: usize, height: usize, num: usize, den: usize) {
549
    let mut bw = BitWriter::endian(output_file, LittleEndian);
550 551 552 553 554 555 556 557 558 559 560 561 562
    bw.write_bytes(b"DKIF").unwrap();
    bw.write(16, 0).unwrap(); // version
    bw.write(16, 32).unwrap(); // version
    bw.write_bytes(b"AV01").unwrap();
    bw.write(16, width as u16).unwrap();
    bw.write(16, height as u16).unwrap();
    bw.write(32, num as u32).unwrap();
    bw.write(32, den as u32).unwrap();
    bw.write(32, 0).unwrap();
    bw.write(32, 0).unwrap();
}

pub fn write_ivf_frame(output_file: &mut dyn io::Write, pts: u64, data: &[u8]) {
563
    let mut bw = BitWriter::endian(output_file, LittleEndian);
564 565 566 567 568 569 570 571 572 573 574
    bw.write(32, data.len() as u32).unwrap();
    bw.write(64, pts).unwrap();
    bw.write_bytes(data).unwrap();
}

trait UncompressedHeader {
    // Start of OBU Headers
    fn write_obu_header(&mut self, obu_type: OBU_Type, obu_extension: u32)
            -> io::Result<()>;
    fn write_sequence_header_obu(&mut self, seq: &mut Sequence, fi: &FrameInvariants)
            -> io::Result<()>;
575
    fn write_frame_header_obu(&mut self, seq: &Sequence, fi: &FrameInvariants, fs: &FrameState)
576 577 578 579 580 581 582
            -> io::Result<()>;
    fn write_sequence_header(&mut self, seq: &mut Sequence, fi: &FrameInvariants)
                                    -> io::Result<()>;
    fn write_color_config(&mut self, seq: &mut Sequence) -> io::Result<()>;
    // End of OBU Headers

    fn write_frame_size(&mut self, fi: &FrameInvariants) -> io::Result<()>;
583 584
    fn write_deblock_filter_a(&mut self, fi: &FrameInvariants, fs: &FrameState) -> io::Result<()>;
    fn write_deblock_filter_b(&mut self, fi: &FrameInvariants, fs: &FrameState) -> io::Result<()>;
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
    fn write_frame_cdef(&mut self, seq: &Sequence, fi: &FrameInvariants) -> io::Result<()>;
}
#[allow(unused)]
const OP_POINTS_IDC_BITS:usize = 12;
#[allow(unused)]
const LEVEL_MAJOR_MIN:usize = 2;
#[allow(unused)]
const LEVEL_MAJOR_BITS:usize = 3;
#[allow(unused)]
const LEVEL_MINOR_BITS:usize = 2;
#[allow(unused)]
const LEVEL_BITS:usize = LEVEL_MAJOR_BITS + LEVEL_MINOR_BITS;
const FRAME_ID_LENGTH: usize = 15;
const DELTA_FRAME_ID_LENGTH: usize = 14;

600
impl<W: io::Write> UncompressedHeader for BitWriter<W, BigEndian> {
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
    // Start of OBU Headers
    // Write OBU Header syntax
    fn write_obu_header(&mut self, obu_type: OBU_Type, obu_extension: u32)
            -> io::Result<()>{
        self.write_bit(false)?; // forbidden bit.
        self.write(4, obu_type as u32)?;
        self.write_bit(obu_extension != 0)?;
        self.write_bit(true)?; // obu_has_payload_length_field
        self.write_bit(false)?; // reserved

        if obu_extension != 0 {
            assert!(false);
            //self.write(8, obu_extension & 0xFF)?; size += 8;
        }

        Ok(())
    }

    fn write_sequence_header_obu(&mut self, seq: &mut Sequence, fi: &FrameInvariants)
        -> io::Result<()> {
        self.write(3, seq.profile)?; // profile, 3 bits
        self.write(1, 0)?; // still_picture
        self.write(1, 0)?; // reduced_still_picture
        self.write_bit(false)?; // display model present
        self.write_bit(false)?; // no timing info present
        self.write(5, 0)?; // one operating point
        self.write(12,0)?; // idc
        self.write(5, 31)?; // level
        self.write(1, 0)?; // tier
        if seq.reduced_still_picture_hdr {
            assert!(false);
        }

        self.write_sequence_header(seq, fi)?;

        self.write_color_config(seq)?;

        self.write_bit(seq.film_grain_params_present)?;

        self.write_bit(true)?; // add_trailing_bits

        Ok(())
    }

    fn write_sequence_header(&mut self, seq: &mut Sequence, fi: &FrameInvariants)
        -> io::Result<()> {
        self.write_frame_size(fi)?;

        if !seq.reduced_still_picture_hdr {
            seq.frame_id_numbers_present_flag = false;
            seq.frame_id_length = FRAME_ID_LENGTH as u32;
            seq.delta_frame_id_length = DELTA_FRAME_ID_LENGTH as u32;

            self.write_bit(seq.frame_id_numbers_present_flag)?;

            if seq.frame_id_numbers_present_flag {
              // We must always have delta_frame_id_length < frame_id_length,
              // in order for a frame to be referenced with a unique delta.
              // Avoid wasting bits by using a coding that enforces this restriction.
              self.write(4, seq.delta_frame_id_length - 2)?;
              self.write(3, seq.frame_id_length - seq.delta_frame_id_length - 1)?;
            }
        }

        self.write_bit(seq.use_128x128_superblock)?;
        self.write_bit(seq.enable_filter_intra)?;
        self.write_bit(seq.enable_intra_edge_filter)?;

        if !seq.reduced_still_picture_hdr {
            self.write_bit(seq.enable_interintra_compound)?;
            self.write_bit(seq.enable_masked_compound)?;
            self.write_bit(seq.enable_warped_motion)?;
            self.write_bit(seq.enable_dual_filter)?;
            self.write_bit(seq.enable_order_hint)?;

            if seq.enable_order_hint {
              self.write_bit(seq.enable_jnt_comp)?;
              self.write_bit(seq.enable_ref_frame_mvs)?;
            }
            if seq.force_screen_content_tools == 2 {
              self.write_bit(true)?;
            } else {
              self.write_bit(false)?;
              self.write_bit(seq.force_screen_content_tools != 0)?;
            }
            if seq.force_screen_content_tools > 0 {
              if seq.force_integer_mv == 2 {
                self.write_bit(true)?;
              } else {
                self.write_bit(false)?;
                self.write_bit(seq.force_integer_mv != 0)?;
              }
            } else {
              assert!(seq.force_integer_mv == 2);
            }
            if seq.enable_order_hint {
              self.write(3, seq.order_hint_bits_minus_1)?;
            }
        }

        self.write_bit(seq.enable_superres)?;
        self.write_bit(seq.enable_cdef)?;
        self.write_bit(seq.enable_restoration)?;

        Ok(())
    }

    fn write_color_config(&mut self, seq: &mut Sequence) -> io::Result<()> {
        let high_bd = seq.bit_depth > 8;

        self.write_bit(high_bd)?; // high bit depth

        if seq.bit_depth == 12 {
            self.write_bit(true)?; // 12-bit
        }

        if seq.profile != 1 {
            self.write_bit(seq.monochrome)?; // monochrome?
        } else {
            unimplemented!(); // 4:4:4 sampling at 8 or 10 bits
        }

        self.write_bit(false)?; // No color description present

        if seq.monochrome {
            assert!(false);
        }

        self.write_bit(false)?; // color range

        let subsampling_x = seq.chroma_sampling != ChromaSampling::Cs444;
        let subsampling_y = seq.chroma_sampling == ChromaSampling::Cs420;

        if seq.bit_depth == 12 {
            self.write_bit(subsampling_x)?;

            if subsampling_x {
                self.write_bit(subsampling_y)?;
            }
        }

        if !subsampling_y {
            unimplemented!(); // 4:2:2 or 4:4:4 sampling
        }

        self.write(2, 0)?; // chroma_sample_position == CSP_UNKNOWN

        self.write_bit(false)?; // separate uv delta q

        Ok(())
    }

#[allow(unused)]
754
    fn write_frame_header_obu(&mut self, seq: &Sequence, fi: &FrameInvariants, fs: &FrameState)
755 756 757 758 759 760 761 762
        -> io::Result<()> {
      if seq.reduced_still_picture_hdr {
        assert!(fi.show_existing_frame);
        assert!(fi.frame_type == FrameType::KEY);
        assert!(fi.show_frame);
      } else {
        if fi.show_existing_frame {
          self.write_bit(true)?; // show_existing_frame=1
fbossen's avatar
fbossen committed
763
          self.write(3, fi.frame_to_show_map_idx)?;
764 765 766 767 768 769 770 771 772 773 774

          //TODO:
          /* temporal_point_info();
            if seq.decoder_model_info_present_flag &&
              timing_info.equal_picture_interval == 0 {
            // write frame_presentation_delay;
          }
          if seq.frame_id_numbers_present_flag {
            // write display_frame_id;
          }*/

fbossen's avatar
fbossen committed
775
          self.write_bit(true)?; // trailing bit
776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
          self.byte_align()?;
          return Ok((()));
        }
        self.write_bit(false)?; // show_existing_frame=0
        self.write(2, fi.frame_type as u32)?;
        self.write_bit(fi.show_frame)?; // show frame

        if fi.show_frame {
          //TODO:
          /* temporal_point_info();
              if seq.decoder_model_info_present_flag &&
              timing_info.equal_picture_interval == 0 {
            // write frame_presentation_delay;*/
        } else {
          self.write_bit(fi.showable_frame)?;
        }

        if fi.frame_type == FrameType::SWITCH {
          assert!(fi.error_resilient);
        } else {
          if !(fi.frame_type == FrameType::KEY && fi.show_frame) {
            self.write_bit(fi.error_resilient)?; // error resilient
          }
        }
      }

      self.write_bit(fi.disable_cdf_update)?;

      if seq.force_screen_content_tools == 2 {
        self.write_bit(fi.allow_screen_content_tools != 0)?;
      } else {
        assert!(fi.allow_screen_content_tools ==
                seq.force_screen_content_tools);
      }

      if fi.allow_screen_content_tools == 2 {
        if seq.force_integer_mv == 2 {
          self.write_bit(fi.force_integer_mv != 0)?;
        } else {
          assert!(fi.force_integer_mv == seq.force_integer_mv);
        }
      } else {
        assert!(fi.allow_screen_content_tools ==
                seq.force_screen_content_tools);
      }

      if seq.frame_id_numbers_present_flag {
        assert!(false); // Not supported by rav1e yet!
        //TODO:
        //let frame_id_len = seq.frame_id_length;
        //self.write(frame_id_len, fi.current_frame_id);
      }

      let mut frame_size_override_flag = false;
      if fi.frame_type == FrameType::SWITCH {
        frame_size_override_flag = true;
      } else if seq.reduced_still_picture_hdr {
        frame_size_override_flag = false;
      } else {
        self.write_bit(frame_size_override_flag)?; // frame size overhead flag
      }

      if seq.enable_order_hint {
fbossen's avatar
fbossen committed
839 840 841
        let n = seq.order_hint_bits_minus_1 + 1;
        let mask = (1 << n) - 1;
        self.write(n, fi.order_hint & mask)?;
842
      }
fbossen's avatar
fbossen committed
843

844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
      if fi.error_resilient || fi.intra_only {
      } else {
        self.write(PRIMARY_REF_BITS, fi.primary_ref_frame)?;
      }

      if seq.decoder_model_info_present_flag {
        assert!(false); // Not supported by rav1e yet!
      }

      if fi.frame_type == FrameType::KEY {
        if !fi.show_frame {  // unshown keyframe (forward keyframe)
          assert!(false); // Not supported by rav1e yet!
          self.write(REF_FRAMES as u32, fi.refresh_frame_flags)?;
        } else {
          assert!(fi.refresh_frame_flags == ALL_REF_FRAMES_MASK);
        }
      } else { // Inter frame info goes here
        if fi.intra_only {
          assert!(fi.refresh_frame_flags != ALL_REF_FRAMES_MASK);
          self.write(REF_FRAMES as u32, fi.refresh_frame_flags)?;
        } else {
          // TODO: This should be set once inter mode is used
          self.write(REF_FRAMES as u32, fi.refresh_frame_flags)?;
        }

      };

      if (!fi.intra_only || fi.refresh_frame_flags != ALL_REF_FRAMES_MASK) {
        // Write all ref frame order hints if error_resilient_mode == 1
        if (fi.error_resilient && seq.enable_order_hint) {
          assert!(false); // Not supported by rav1e yet!
          //for _ in 0..REF_FRAMES {
          //  self.write(order_hint_bits_minus_1,ref_order_hint[i])?; // order_hint
          //}
        }
      }

      // if KEY or INTRA_ONLY frame
      // FIXME: Not sure whether putting frame/render size here is good idea
      if fi.intra_only {
        if frame_size_override_flag {
          assert!(false); // Not supported by rav1e yet!
        }
        if seq.enable_superres {
          assert!(false); // Not supported by rav1e yet!
        }
        self.write_bit(false)?; // render_and_frame_size_different
        //if render_and_frame_size_different { }
        if fi.allow_screen_content_tools != 0 && true /* UpscaledWidth == FrameWidth */ {
          self.write_bit(fi.allow_intrabc)?;
        }
      }

      let frame_refs_short_signaling = false;
      if fi.frame_type == FrameType::KEY {
        // Done by above
      } else {
        if fi.intra_only {
          // Done by above
        } else {
          if seq.enable_order_hint {
            self.write_bit(frame_refs_short_signaling)?;
            if frame_refs_short_signaling {
              assert!(false); // Not supported by rav1e yet!
            }
          }

911
          for i in 0..INTER_REFS_PER_FRAME {
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961
            if !frame_refs_short_signaling {
              self.write(REF_FRAMES_LOG2 as u32, fi.ref_frames[i] as u8)?;
            }
            if seq.frame_id_numbers_present_flag {
              assert!(false); // Not supported by rav1e yet!
            }
          }
          if fi.error_resilient && frame_size_override_flag {
            assert!(false); // Not supported by rav1e yet!
          } else {
            if frame_size_override_flag {
               assert!(false); // Not supported by rav1e yet!
            }
            if seq.enable_superres {
              assert!(false); // Not supported by rav1e yet!
            }
            self.write_bit(false)?; // render_and_frame_size_different
          }
          if fi.force_integer_mv != 0 {
          } else {
            self.write_bit(fi.allow_high_precision_mv);
          }
          self.write_bit(fi.is_filter_switchable)?;
          self.write_bit(fi.is_motion_mode_switchable)?;
          self.write(2,0)?; // EIGHTTAP_REGULAR
          if fi.error_resilient || !seq.enable_ref_frame_mvs {
          } else {
            self.write_bit(fi.use_ref_frame_mvs)?;
          }
        }
      }

      if !seq.reduced_still_picture_hdr && !fi.disable_cdf_update {
        self.write_bit(fi.disable_frame_end_update_cdf)?;
      }

      // tile
      self.write_bit(true)?; // uniform_tile_spacing_flag
      if fi.width > 64 {
        // TODO: if tile_cols > 1, write more increment_tile_cols_log2 bits
        self.write_bit(false)?; // tile cols
      }
      if fi.height > 64 {
        // TODO: if tile_rows > 1, write increment_tile_rows_log2 bits
        self.write_bit(false)?; // tile rows
      }
      // TODO: if tile_cols * tile_rows > 1 {
      // write context_update_tile_id and tile_size_bytes_minus_1 }

      // quantization
Frank Bossen's avatar
Frank Bossen committed
962 963
      assert!(fi.base_q_idx > 0);
      self.write(8, fi.base_q_idx)?; // base_q_idx
964 965 966 967 968 969 970 971 972 973 974
      self.write_bit(false)?; // y dc delta q
      self.write_bit(false)?; // uv dc delta q
      self.write_bit(false)?; // uv ac delta q
      self.write_bit(false)?; // no qm

      // segmentation
      self.write_bit(false)?; // segmentation is disabled

      // delta_q
      self.write_bit(false)?; // delta_q_present_flag: no delta q

975
      // delta_lf_params in the spec
976
      self.write_deblock_filter_a(fi, fs)?;
977 978 979 980

      // code for features not yet implemented....

      // loop_filter_params in the spec
981
      self.write_deblock_filter_b(fi, fs)?;
982

983 984 985 986 987 988 989 990 991 992 993 994 995 996
      // cdef
      self.write_frame_cdef(seq, fi)?;
      // loop restoration
      if seq.enable_restoration {
          self.write(6,0)?; // no y, u or v loop restoration
      }
      self.write_bit(false)?; // tx mode == TX_MODE_SELECT ?

      let mut reference_select = false;
      if !fi.intra_only {
        reference_select = fi.reference_mode != ReferenceMode::SINGLE;
        self.write_bit(reference_select)?;
      }

fbossen's avatar
fbossen committed
997
      let skip_mode_allowed = seq.get_skip_mode_allowed(fi, reference_select);
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
      if skip_mode_allowed {
        self.write_bit(false)?; // skip_mode_present
      }

      if fi.intra_only || fi.error_resilient || !seq.enable_warped_motion {
      } else {
        self.write_bit(fi.allow_warped_motion)?; // allow_warped_motion
      }

      self.write_bit(fi.use_reduced_tx_set)?; // reduced tx

      // global motion
      if !fi.intra_only {
          for i in LAST_FRAME..ALTREF_FRAME+1 {
              let mode = fi.globalmv_transformation_type[i];
              self.write_bit(mode != GlobalMVMode::IDENTITY)?;
              if mode != GlobalMVMode::IDENTITY {
                  self.write_bit(mode == GlobalMVMode::ROTZOOM)?;
                  if mode != GlobalMVMode::ROTZOOM {
                      self.write_bit(mode == GlobalMVMode::TRANSLATION)?;
                  }
              }
              match mode {
                  GlobalMVMode::IDENTITY => { /* Nothing to do */ }
                  GlobalMVMode::TRANSLATION => {
                      let mv_x = 0;
                      let mv_x_ref = 0;
                      let mv_y = 0;
                      let mv_y_ref = 0;
                      let bits = 12 - 6 + 3 - !fi.allow_high_precision_mv as u8;
                      let bits_diff = 12 - 3 + fi.allow_high_precision_mv as u8;
                      BCodeWriter::write_s_refsubexpfin(self, (1 << bits) + 1,
                                                        3, mv_x_ref >> bits_diff,
                                                        mv_x >> bits_diff)?;
                      BCodeWriter::write_s_refsubexpfin(self, (1 << bits) + 1,
                                                        3, mv_y_ref >> bits_diff,
                                                        mv_y >> bits_diff)?;
                  }
                  GlobalMVMode::ROTZOOM => unimplemented!(),
                  GlobalMVMode::AFFINE => unimplemented!(),
              };
          }
      }

      if seq.film_grain_params_present && fi.show_frame {
          unimplemented!();
      }

      if fi.large_scale_tile {
          unimplemented!();
      }
      self.write_bit(true)?; // trailing bit
      self.byte_align()?;

      Ok(())
    }
    // End of OBU Headers

    fn write_frame_size(&mut self, fi: &FrameInvariants) -> io::Result<()> {
        // width_bits and height_bits will have to be moved to the sequence header OBU
        // when we add support for it.
        let width_bits = 32 - (fi.width as u32).leading_zeros();
        let height_bits = 32 - (fi.height as u32).leading_zeros();
        assert!(width_bits <= 16);
        assert!(height_bits <= 16);
        self.write(4, width_bits - 1)?;
        self.write(4, height_bits - 1)?;
        self.write(width_bits, (fi.width - 1) as u16)?;
        self.write(height_bits, (fi.height - 1) as u16)?;
        Ok(())
    }

1070
    fn write_deblock_filter_a(&mut self, fi: &FrameInvariants, fs: &FrameState) -> io::Result<()> {
1071 1072
        if fi.delta_q_present {
            if !fi.allow_intrabc {
1073
                self.write_bit(fs.deblock.block_deltas_enabled)?;
1074
            }
1075 1076 1077
            if fs.deblock.block_deltas_enabled {
                self.write(2,fs.deblock.block_delta_shift)?;
                self.write_bit(fs.deblock.block_delta_multi)?;
1078 1079 1080 1081 1082
            }
        }
        Ok(())
    }

1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
    fn write_deblock_filter_b(&mut self, fi: &FrameInvariants, fs: &FrameState) -> io::Result<()> {
        assert!(fs.deblock.levels[0] < 64);
        self.write(6, fs.deblock.levels[0])?; // loop deblocking filter level 0
        assert!(fs.deblock.levels[1] < 64);
        self.write(6, fs.deblock.levels[1])?; // loop deblocking filter level 1
        if PLANES > 1 && (fs.deblock.levels[0] > 0 || fs.deblock.levels[1] > 0) {
            assert!(fs.deblock.levels[2] < 64);
            self.write(6, fs.deblock.levels[2])?; // loop deblocking filter level 2
            assert!(fs.deblock.levels[3] < 64);
            self.write(6, fs.deblock.levels[3])?; // loop deblocking filter level 3
1093
        }
1094 1095 1096 1097 1098
        self.write(3,fs.deblock.sharpness)?; // deblocking filter sharpness
        self.write_bit(fs.deblock.deltas_enabled)?; // loop deblocking filter deltas enabled
        if fs.deblock.deltas_enabled {
            self.write_bit(fs.deblock.delta_updates_enabled)?; // deltas updates enabled
            if fs.deblock.delta_updates_enabled {
1099 1100 1101 1102
                // conditionally write ref delta updates
                let prev_ref_deltas = if fi.primary_ref_frame == PRIMARY_REF_NONE {
                    [1, 0, 0, 0, 0, -1, -1, -1]
                } else {
1103
                    fi.rec_buffer.deblock[fi.ref_frames[fi.primary_ref_frame as usize] as usize].ref_deltas
1104 1105
                };
                for i in 0..REF_FRAMES {
1106
                    let update = fs.deblock.ref_deltas[i] != prev_ref_deltas[i];
1107 1108
                    self.write_bit(update)?;
                    if update {
1109
                        self.write_signed(7,fs.deblock.ref_deltas[i])?;
1110 1111 1112 1113 1114 1115
                    }
                }
                // conditionally write mode delta updates
                let prev_mode_deltas = if fi.primary_ref_frame == PRIMARY_REF_NONE {
                    [0, 0]
                } else {
1116
                    fi.rec_buffer.deblock[fi.ref_frames[fi.primary_ref_frame as usize] as usize].mode_deltas
1117 1118
                };
                for i in 0..2 {
1119
                    let update = fs.deblock.mode_deltas[i] != prev_mode_deltas[i];
1120 1121
                    self.write_bit(update)?;
                    if update {
1122
                        self.write_signed(7,fs.deblock.mode_deltas[i])?;
1123 1124 1125 1126 1127
                    }
                }
            }
        }
        Ok(())
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188
    }

    fn write_frame_cdef(&mut self, seq: &Sequence, fi: &FrameInvariants) -> io::Result<()> {
        if seq.enable_cdef {
            assert!(fi.cdef_damping >= 3);
            assert!(fi.cdef_damping <= 6);
            self.write(2, fi.cdef_damping - 3)?;
            assert!(fi.cdef_bits < 4);
            self.write(2,fi.cdef_bits)?; // cdef bits
            for i in 0..(1<<fi.cdef_bits) {
                assert!(fi.cdef_y_strengths[i]<64);
                assert!(fi.cdef_uv_strengths[i]<64);
                self.write(6,fi.cdef_y_strengths[i])?; // cdef y strength
                self.write(6,fi.cdef_uv_strengths[i])?; // cdef uv strength
            }
        }
        Ok(())
    }
}

#[allow(non_camel_case_types)]
pub enum OBU_Type {
  OBU_SEQUENCE_HEADER = 1,
  OBU_TEMPORAL_DELIMITER = 2,
  OBU_FRAME_HEADER = 3,
  OBU_TILE_GROUP = 4,
  OBU_METADATA = 5,
  OBU_FRAME = 6,
  OBU_REDUNDANT_FRAME_HEADER = 7,
  OBU_TILE_LIST = 8,
  OBU_PADDING = 15,
}

// NOTE from libaom:
// Disallow values larger than 32-bits to ensure consistent behavior on 32 and
// 64 bit targets: value is typically used to determine buffer allocation size
// when decoded.
fn aom_uleb_size_in_bytes(mut value: u64) -> usize {
  let mut size = 0;
  loop {
    size += 1;
    value = value >> 7;
    if value == 0 { break; }
  }
  return size;
}

fn aom_uleb_encode(mut value: u64, coded_value: &mut [u8]) -> usize {
  let leb_size = aom_uleb_size_in_bytes(value);

  for i in 0..leb_size {
    let mut byte = (value & 0x7f) as u8;
    value >>= 7;
    if value != 0 { byte |= 0x80 };  // Signal that more bytes follow.
    coded_value[i] = byte;
  }

  leb_size
}

fn write_obus(packet: &mut dyn io::Write, sequence: &mut Sequence,
1189
                            fi: &mut FrameInvariants, fs: &FrameState) -> io::Result<()> {
1190
    //let mut uch = BitWriter::endian(packet, BigEndian);
1191 1192 1193 1194
    let obu_extension = 0 as u32;

    let mut buf1 = Vec::new();
    {
1195
        let mut bw1 = BitWriter::endian(&mut buf1, BigEndian);
1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
      bw1.write_obu_header(OBU_Type::OBU_TEMPORAL_DELIMITER, obu_extension)?;
      bw1.write(8,0)?;	// size of payload == 0, one byte
    }
    packet.write(&buf1).unwrap();
    buf1.clear();

    // write sequence header obu if KEY_FRAME, preceded by 4-byte size
    if fi.frame_type == FrameType::KEY {
        let mut buf2 = Vec::new();
        {
1206
            let mut bw2 = BitWriter::endian(&mut buf2, BigEndian);
1207 1208 1209 1210 1211
            bw2.write_sequence_header_obu(sequence, fi)?;
            bw2.byte_align()?;
        }

        {
1212
            let mut bw1 = BitWriter::endian(&mut buf1, BigEndian);
1213 1214 1215 1216 1217 1218 1219
            bw1.write_obu_header(OBU_Type::OBU_SEQUENCE_HEADER, obu_extension)?;
        }
        packet.write(&buf1).unwrap();
        buf1.clear();

        let obu_payload_size = buf2.len() as u64;
        {
1220
            let mut bw1 = BitWriter::endian(&mut buf1, BigEndian);
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
            // uleb128()
            let mut coded_payload_length = [0 as u8; 8];
            let leb_size = aom_uleb_encode(obu_payload_size, &mut coded_payload_length);
            for i in 0..leb_size {
                bw1.write(8, coded_payload_length[i])?;
            }
        }
        packet.write(&buf1).unwrap();
        buf1.clear();

        packet.write(&buf2).unwrap();
        buf2.clear();
    }

    let mut buf2 = Vec::new();
    {
1237
        let mut bw2 = BitWriter::endian(&mut buf2, BigEndian);
1238
        bw2.write_frame_header_obu(sequence, fi, fs)?;
1239 1240 1241
    }

    {
1242
        let mut bw1 = BitWriter::endian(&mut buf1, BigEndian);
1243 1244 1245 1246 1247 1248 1249
        bw1.write_obu_header(OBU_Type::OBU_FRAME_HEADER, obu_extension)?;
    }
    packet.write(&buf1).unwrap();
    buf1.clear();

    let obu_payload_size = buf2.len() as u64;
    {
1250
        let mut bw1 = BitWriter::endian(&mut buf1, BigEndian);
1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
        // uleb128()
        let mut coded_payload_length = [0 as u8; 8];
        let leb_size = aom_uleb_encode(obu_payload_size, &mut coded_payload_length);
        for i in 0..leb_size {
            bw1.write(8, coded_payload_length[i])?;
        }
    }
    packet.write(&buf1).unwrap();
    buf1.clear();

    packet.write(&buf2).unwrap();
    buf2.clear();

    Ok(())
}

/// Write into `dst` the difference between the blocks at `src1` and `src2`
fn diff(dst: &mut [i16], src1: &PlaneSlice<'_>, src2: &PlaneSlice<'_>, width: usize, height: usize) {
fbossen's avatar
fbossen committed
1269 1270 1271 1272 1273 1274 1275 1276
  let src1_stride = src1.plane.cfg.stride;
  let src2_stride = src2.plane.cfg.stride;

  for ((l, s1), s2) in dst.chunks_mut(width).take(height)
                        .zip(src1.as_slice().chunks(src1_stride))
                        .zip(src2.as_slice().chunks(src2_stride)) {
    for ((r, v1), v2) in l.iter_mut().zip(s1).zip(s2) {
      *r = *v1 as i16 - *v2 as i16;
1277
    }
fbossen's avatar
fbossen committed
1278
  }
1279 1280 1281 1282 1283
}

// For a transform block,
// predict, transform, quantize, write coefficients to a bitstream,
// dequantize, inverse-transform.
1284 1285 1286 1287 1288 1289
pub fn encode_tx_block(
  fi: &FrameInvariants, fs: &mut FrameState, cw: &mut ContextWriter,
  w: &mut dyn Writer, p: usize, bo: &BlockOffset, mode: PredictionMode,
  tx_size: TxSize, tx_type: TxType, plane_bsize: BlockSize, po: &PlaneOffset,
  skip: bool, bit_depth: usize, ac: &[i16], alpha: i16
) -> bool {
1290 1291 1292 1293
    let rec = &mut fs.rec.planes[p];
    let PlaneConfig { stride, xdec, ydec, .. } = fs.input.planes[p].cfg;

    if mode.is_intra() {
1294
      mode.predict_intra(&mut rec.mut_slice(po), tx_size, bit_depth, &ac, alpha);
1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312
    }

    if skip { return false; }

    let mut residual: AlignedArray<[i16; 64 * 64]> = UninitializedAlignedArray();
    let mut coeffs_storage: AlignedArray<[i32; 64 * 64]> = UninitializedAlignedArray();
    let mut rcoeffs: AlignedArray<[i32; 64 * 64]> = UninitializedAlignedArray();
    let coeffs = &mut coeffs_storage.array[..tx_size.area()];

    diff(&mut residual.array,
         &fs.input.planes[p].slice(po),
         &rec.slice(po),
         tx_size.width(),
         tx_size.height());

    forward_transform(&residual.array, coeffs, tx_size.width(), tx_size, tx_type, bit_depth);
    fs.qc.quantize(coeffs);

1313
    let has_coeff = cw.write_coeffs_lv_map(w, p, bo, &coeffs, mode, tx_size, tx_type, plane_bsize, xdec, ydec,
1314 1315 1316
                            fi.use_reduced_tx_set);

    // Reconstruct
Frank Bossen's avatar
Frank Bossen committed
1317
    dequantize(fi.base_q_idx, &coeffs, &mut rcoeffs.array, tx_size, bit_depth);
1318 1319 1320 1321 1322

    inverse_transform_add(&rcoeffs.array, &mut rec.mut_slice(po).as_mut_slice(), stride, tx_size, tx_type, bit_depth);
    has_coeff
}

1323
pub fn motion_compensate(fi: &FrameInvariants, fs: &mut FrameState, cw: &mut ContextWriter,
fbossen's avatar
fbossen committed
1324
                         luma_mode: PredictionMode, ref_frames: &[usize; 2], mvs: &[MotionVector; 2],
1325 1326
                         bsize: BlockSize, bo: &BlockOffset, bit_depth: usize,
                         luma_only: bool) {
1327 1328 1329 1330 1331 1332
  if luma_mode.is_intra() { return; }

  let PlaneConfig { xdec, ydec, .. } = fs.input.planes[1].cfg;

  // Inter mode prediction can take place once for a whole partition,
  // instead of each tx-block.
1333
  let num_planes = 1 + if !luma_only && has_chroma(bo, bsize, xdec, ydec) { 2 } else { 0 };
1334

1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348
  for p in 0..num_planes {
    let plane_bsize = if p == 0 { bsize }
    else { get_plane_block_size(bsize, xdec, ydec) };

    let po = bo.plane_offset(&fs.input.planes[p].cfg);
    let rec = &mut fs.rec.planes[p];
    // TODO: make more generic to handle 2xN and Nx2 MC
    if p > 0 && bsize == BlockSize::BLOCK_4X4 {
      let some_use_intra = cw.bc.at(&bo.with_offset(-1,-1)).mode.is_intra()
        || cw.bc.at(&bo.with_offset(0,-1)).mode.is_intra()
        || cw.bc.at(&bo.with_offset(-1,0)).mode.is_intra();

      if some_use_intra {
        luma_mode.predict_inter(fi, p, &po, &mut rec.mut_slice(&po), plane_bsize.width(),
fbossen's avatar
fbossen committed
1349
          plane_bsize.height(), ref_frames, &mvs, bit_depth);
1350
      } else {
1351 1352
        assert!(xdec == 1 && ydec == 1);
        // TODO: these are only valid for 4:2:0
fbossen's avatar
fbossen committed
1353 1354 1355 1356
        let mv0 = &cw.bc.at(&bo.with_offset(-1,-1)).mv;
        let rf0 = &cw.bc.at(&bo.with_offset(-1,-1)).ref_frames;
        let mv1 = &cw.bc.at(&bo.with_offset(0,-1)).mv;
        let rf1 = &cw.bc.at(&bo.with_offset(0,-1)).ref_frames;
1357
        let po1 = PlaneOffset { x: po.x+2, y: po.y };
fbossen's avatar
fbossen committed
1358 1359
        let mv2 = &cw.bc.at(&bo.with_offset(-1,0)).mv;
        let rf2 = &cw.bc.at(&bo.with_offset(-1,0)).ref_frames;
1360 1361
        let po2 = PlaneOffset { x: po.x, y: po.y+2 };
        let po3 = PlaneOffset { x: po.x+2, y: po.y+2 };
1362 1363 1364
        luma_mode.predict_inter(fi, p, &po, &mut rec.mut_slice(&po), 2, 2, rf0, mv0, bit_depth);
        luma_mode.predict_inter(fi, p, &po1, &mut rec.mut_slice(&po1), 2, 2, rf1, mv1, bit_depth);
        luma_mode.predict_inter(fi, p, &po2, &mut rec.mut_slice(&po2), 2, 2, rf2, mv2, bit_depth);
fbossen's avatar
fbossen committed
1365
        luma_mode.predict_inter(fi, p, &po3, &mut rec.mut_slice(&po3), 2, 2, ref_frames, mvs, bit_depth);
1366 1367 1368
      }
    } else {
      luma_mode.predict_inter(fi, p, &po, &mut rec.mut_slice(&po), plane_bsize.width(),
fbossen's avatar
fbossen committed
1369
        plane_bsize.height(), ref_frames, &mvs, bit_depth);
1370 1371 1372 1373
    }
  }
}

1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384
pub fn encode_block_a(seq: &Sequence,
                 cw: &mut ContextWriter, w: &mut dyn Writer,
                 bsize: BlockSize, bo: &BlockOffset, skip: bool) -> bool {
    cw.bc.set_skip(bo, bsize, skip);
    cw.write_skip(w, bo, skip);
    if !skip && seq.enable_cdef {
        cw.bc.cdef_coded = true;
    }
    cw.bc.cdef_coded
}

1385
pub fn encode_block_b(seq: &Sequence, fi: &FrameInvariants, fs: &mut FrameState,
1386 1387
                 cw: &mut ContextWriter, w: &mut dyn Writer,
                 luma_mode: PredictionMode, chroma_mode: PredictionMode,
fbossen's avatar
fbossen committed
1388
                 ref_frames: &[usize; 2], mvs: &[MotionVector; 2],
1389
                 bsize: BlockSize, bo: &BlockOffset, skip: bool, bit_depth: usize,
fbossen's avatar
fbossen committed
1390 1391
                 cfl: CFLParams, tx_size: TxSize, tx_type: TxType,
                 mode_context: usize, mv_stack: &Vec<CandidateMV>) {
1392
    let is_inter = !luma_mode.is_intra();
1393
    if is_inter { assert!(luma_mode == chroma_mode); };
1394 1395 1396 1397 1398
    let sb_size = if seq.use_128x128_superblock {
        BlockSize::BLOCK_128X128
    } else {
        BlockSize::BLOCK_64X64
    };
1399 1400 1401 1402
    let PlaneConfig { xdec, ydec, .. } = fs.input.planes[1].cfg;
    if skip {
        cw.bc.reset_skip_context(bo, bsize, xdec, ydec);
    }
1403
    cw.bc.set_block_size(bo, bsize);
1404
    cw.bc.set_mode(bo, bsize, luma_mode);
fbossen's avatar
fbossen committed
1405 1406
    cw.bc.set_ref_frames(bo, bsize, ref_frames);
    cw.bc.set_motion_vectors(bo, bsize, mvs);
1407

1408
    //write_q_deltas();
1409 1410
    if cw.bc.code_deltas && fs.deblock.block_deltas_enabled && (bsize < sb_size || !skip) {
        cw.write_block_deblock_deltas(w, bo, fs.deblock.block_delta_multi);
1411 1412
    }
    cw.bc.code_deltas = false;
1413 1414 1415 1416 1417

    if fi.frame_type == FrameType::INTER {
        cw.write_is_inter(w, bo, is_inter);
        if is_inter {
            cw.fill_neighbours_ref_counts(bo);
fbossen's avatar
fbossen committed
1418
            cw.write_ref_frames(w, fi, bo);
1419

1420
            // NOTE: Until rav1e supports other inter modes than GLOBALMV
fbossen's avatar
fbossen committed
1421 1422 1423 1424 1425 1426 1427 1428
            if luma_mode >= PredictionMode::NEAREST_NEARESTMV {
                cw.write_compound_mode(w, luma_mode, mode_context);
            } else {
                cw.write_inter_mode(w, luma_mode, mode_context);
            }

            let ref_mv_idx = 0;
            let num_mv_found = mv_stack.len();