encoder.rs 101 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 lrf::*;
13
use context::*;
14
use deblock::*;
15
use segmentation::*;
16
use ec::*;
17 18
use partition::*;
use plane::*;
19
use quantize::*;
20 21
use rdo::*;
use std::fmt;
22
use transform::*;
23
use util::*;
24
use me::*;
25

26
use bitstream_io::{BitWriter, BigEndian, LittleEndian};
27
use std;
28
use std::io;
Josh Holmer's avatar
Josh Holmer committed
29
use std::io::Write;
30
use std::rc::Rc;
31 32 33 34 35 36 37 38 39 40 41

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

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

42 43
const FRAME_MARGIN: usize = 16 + SUBPEL_FILTER_SIZE;

44 45 46 47
impl Frame {
    pub fn new(width: usize, height:usize) -> Frame {
        Frame {
            planes: [
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
                Plane::new(
                    width, height,
                    0, 0,
                    MAX_SB_SIZE + FRAME_MARGIN, MAX_SB_SIZE + FRAME_MARGIN
                ),
                Plane::new(
                    width/2, height/2,
                    1, 1,
                    MAX_SB_SIZE/2 + FRAME_MARGIN, MAX_SB_SIZE/2 + FRAME_MARGIN
                ),
                Plane::new(
                    width/2, height/2,
                    1, 1,
                    MAX_SB_SIZE/2 + FRAME_MARGIN, MAX_SB_SIZE/2 + FRAME_MARGIN
                )
63 64 65
            ]
        }
    }
fbossen's avatar
fbossen committed
66

Frank Bossen's avatar
Frank Bossen committed
67
    pub fn pad(&mut self, w: usize, h: usize) {
fbossen's avatar
fbossen committed
68
        for p in self.planes.iter_mut() {
Frank Bossen's avatar
Frank Bossen committed
69
            p.pad(w, h);
fbossen's avatar
fbossen committed
70 71
        }
    }
72 73 74 75 76 77 78 79 80 81

    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))
            ]
        }
    }
Josh Holmer's avatar
Josh Holmer committed
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 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

    /// Returns a `PixelIter` containing the data of this frame's planes in YUV format.
    /// Each point in the `PixelIter` is a triple consisting of a Y, U, and V component.
    /// The `PixelIter` is laid out as contiguous rows, e.g. to get a given 0-indexed row
    /// you could use `data.skip(width * row_idx).take(width)`.
    ///
    /// This data retains any padding, e.g. it uses the width and height specifed in
    /// the Y-plane's `cfg` struct, and not the display width and height specied in
    /// `FrameInvariants`.
    pub fn iter(&self) -> PixelIter {
      PixelIter::new(&self.planes)
    }
}

#[derive(Debug)]
pub struct PixelIter<'a> {
  planes: &'a [Plane; 3],
  y: usize,
  x: usize,
}

impl<'a> PixelIter<'a> {
  pub fn new(planes: &'a [Plane; 3]) -> Self {
    PixelIter {
      planes,
      y: 0,
      x: 0,
    }
  }

  fn width(&self) -> usize {
    self.planes[0].cfg.width
  }

  fn height(&self) -> usize {
    self.planes[0].cfg.height
  }
}

impl<'a> Iterator for PixelIter<'a> {
  type Item = (u16, u16, u16);

  fn next(&mut self) -> Option<<Self as Iterator>::Item> {
    if self.y == self.height() - 1 && self.x == self.width() - 1 {
      return None;
    }
    let pixel = (
      self.planes[0].p(self.x, self.y),
      self.planes[1].p(self.x / 2, self.y / 2),
      self.planes[2].p(self.x / 2, self.y / 2),
    );
    if self.x == self.width() - 1 {
      self.x = 0;
      self.y += 1;
    } else {
      self.x += 1;
    }
    Some(pixel)
  }
141 142
}

143 144
#[derive(Debug, Clone)]
pub struct ReferenceFrame {
fbossen's avatar
fbossen committed
145
  pub order_hint: u32,
146
  pub frame: Frame,
147 148
  pub input_hres: Plane,
  pub input_qres: Plane,
149
  pub cdfs: CDFContext
150 151
}

Josh Holmer's avatar
Josh Holmer committed
152
#[derive(Debug, Clone)]
153
pub struct ReferenceFramesSet {
154
    pub frames: [Option<Rc<ReferenceFrame>>; (REF_FRAMES as usize)],
155
    pub deblock: [DeblockState; (REF_FRAMES as usize)]
156 157 158 159 160
}

impl ReferenceFramesSet {
    pub fn new() -> ReferenceFramesSet {
        ReferenceFramesSet {
161
            frames: Default::default(),
162
            deblock: Default::default()
163 164 165 166 167 168 169 170
        }
    }
}

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;

171
pub const PRIMARY_REF_NONE: u32 = 7;
172 173 174 175
const PRIMARY_REF_BITS: u32 = 3;

arg_enum!{
    #[derive(Copy, Clone, Debug, PartialEq)]
176
    #[repr(C)]
177 178 179 180 181 182 183 184 185 186 187 188 189
    pub enum Tune {
        Psnr,
        Psychovisual
    }
}

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

#[derive(Copy, Clone, Debug, PartialEq)]
190
#[repr(C)]
191 192 193 194 195 196 197 198 199 200 201 202
pub enum ChromaSampling {
    Cs420,
    Cs422,
    Cs444
}

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

203 204 205 206 207 208 209 210 211 212 213 214 215 216
#[derive(Copy, Clone, Debug, PartialEq)]
#[repr(C)]
pub enum ChromaSamplePosition {
    Unknown,
    Vertical,
    Colocated
}

impl Default for ChromaSamplePosition {
    fn default() -> Self {
        ChromaSamplePosition::Unknown
    }
}

217 218 219 220 221 222 223 224
#[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,
225
    pub chroma_sample_position: ChromaSamplePosition,
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
    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 {
277 278 279
    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();
280 281 282
        assert!(width_bits <= 16);
        assert!(height_bits <= 16);

283
        let profile = if info.bit_depth == 12 {
284
            2
285
        } else if info.chroma_sampling == ChromaSampling::Cs444 {
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
            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,
306 307
            bit_depth: info.bit_depth,
            chroma_sampling: info.chroma_sampling,
308
            chroma_sample_position: info.chroma_sample_position,
309 310
            max_frame_width: info.width as u32,
            max_frame_height: info.height as u32,
311 312 313 314
            frame_id_numbers_present_flag: false,
            frame_id_length: 0,
            delta_frame_id_length: 0,
            use_128x128_superblock: false,
315
            order_hint_bits_minus_1: 5,
316 317 318 319 320 321 322 323 324 325
            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
326
            enable_order_hint: true,
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
            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
343 344 345 346 347 348

    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
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401

    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
          }
        }
      }
    }
402 403
}

Luca Barbato's avatar
Luca Barbato committed
404 405
use std::sync::Arc;

406 407
#[derive(Debug)]
pub struct FrameState {
Luca Barbato's avatar
Luca Barbato committed
408
    pub input: Arc<Frame>,
409 410
    pub input_hres: Plane, // half-resolution version of input luma
    pub input_qres: Plane, // quarter-resolution version of input luma
411 412
    pub rec: Frame,
    pub qc: QuantizationContext,
413
    pub cdfs: CDFContext,
414
    pub deblock: DeblockState,
415
    pub segmentation: SegmentationState,
416 417 418 419
}

impl FrameState {
    pub fn new(fi: &FrameInvariants) -> FrameState {
420 421 422 423
        FrameState::new_with_frame(fi, Arc::new(Frame::new(fi.padded_w, fi.padded_h)))
    }

    pub fn new_with_frame(fi: &FrameInvariants, frame: Arc<Frame>) -> FrameState {
424
        FrameState {
425 426 427 428 429 430 431 432 433 434 435
            input: frame,
            input_hres: Plane::new(
                fi.padded_w/2, fi.padded_h/2,
                1, 1,
                (MAX_SB_SIZE + FRAME_MARGIN) / 2, (MAX_SB_SIZE + FRAME_MARGIN) / 2
            ),
            input_qres: Plane::new(
                fi.padded_w/4, fi.padded_h/4,
                2, 2,
                (MAX_SB_SIZE + FRAME_MARGIN) / 4, (MAX_SB_SIZE + FRAME_MARGIN) / 4
            ),
436 437
            rec: Frame::new(fi.padded_w, fi.padded_h),
            qc: Default::default(),
438
            cdfs: CDFContext::new(0),
439
            deblock: Default::default(),
440
            segmentation: Default::default(),
441 442
        }
    }
443 444 445

    pub fn window(&self, sbo: &SuperBlockOffset) -> FrameState {
        FrameState {
446
            input: Arc::new(self.input.window(sbo)),
447 448
            input_hres: self.input_hres.window(&sbo.plane_offset(&self.input_hres.cfg)),
            input_qres: self.input_qres.window(&sbo.plane_offset(&self.input_qres.cfg)),
449
            rec: self.rec.window(sbo),
450 451
            qc: self.qc,
            cdfs: self.cdfs,
452 453
            deblock: self.deblock,
            segmentation: self.segmentation,
454 455
        }
    }
456 457
}

458 459
#[derive(Copy, Clone, Debug)]
pub struct DeblockState {
460
    pub levels: [u8; PLANES+1],  // Y vertical edges, Y horizontal, U, V
461 462 463 464 465
    pub sharpness: u8,
    pub deltas_enabled: bool,
    pub delta_updates_enabled: bool,
    pub ref_deltas: [i8; REF_FRAMES],
    pub mode_deltas: [i8; 2],
466 467 468
    pub block_deltas_enabled: bool,
    pub block_delta_shift: u8,
    pub block_delta_multi: bool,
469 470 471 472 473
}

impl Default for DeblockState {
    fn default() -> Self {
        DeblockState {
474
            levels: [8,8,4,4],
475
            sharpness: 0,
476
            deltas_enabled: false, // requires delta_q_enabled
477 478
            delta_updates_enabled: false,
            ref_deltas: [1, 0, 0, 0, 0, -1, -1, -1],
479 480 481 482
            mode_deltas: [0, 0],
            block_deltas_enabled: false,
            block_delta_shift: 0,
            block_delta_multi: false
483 484 485 486
        }
    }
}

487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
#[derive(Copy, Clone, Debug)]
pub struct SegmentationState {
    pub enabled: bool,
    pub update_data: bool,
    pub update_map: bool,
    pub preskip: bool,
    pub last_active_segid: u8,
    pub features: [[bool; SegLvl::SEG_LVL_MAX as usize]; 8],
    pub data: [[i16; SegLvl::SEG_LVL_MAX as usize]; 8],
}

impl Default for SegmentationState {
    fn default() -> Self {
        SegmentationState {
            enabled: false,
            update_data: false,
            update_map: false,
            preskip: true,
            last_active_segid: 0,
            features: [[false; SegLvl::SEG_LVL_MAX as usize]; 8],
            data: [[0; SegLvl::SEG_LVL_MAX as usize]; 8],
        }
    }
}

512 513
// Frame Invariants are invariant inside a frame
#[allow(dead_code)]
Josh Holmer's avatar
Josh Holmer committed
514
#[derive(Debug, Clone)]
515 516 517 518 519 520 521 522 523 524
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
525
    pub order_hint: u32,
526 527 528 529 530 531 532
    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
533
    pub frame_to_show_map_idx: u32,
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
    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],
558
    pub lrf_types: [u8; PLANES],
559
    pub delta_q_present: bool,
560
    pub config: EncoderConfig,
561
    pub ref_frames: [u8; INTER_REFS_PER_FRAME],
fbossen's avatar
fbossen committed
562
    pub ref_frame_sign_bias: [bool; INTER_REFS_PER_FRAME],
563
    pub rec_buffer: ReferenceFramesSet,
Frank Bossen's avatar
Frank Bossen committed
564
    pub base_q_idx: u8,
fbossen's avatar
fbossen committed
565
    pub me_range_scale: u8,
566
    pub use_tx_domain_distortion: bool,
Josh Holmer's avatar
Josh Holmer committed
567
    pub inter_cfg: Option<InterPropsConfig>,
568 569 570 571 572 573 574
}

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.
575
        let mut min_partition_size = config.speed_settings.min_block_size;
576 577 578 579 580 581 582 583

        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");
            }
        }
584 585
        let use_reduced_tx_set = config.speed_settings.reduced_tx_set;
        let use_tx_domain_distortion = config.tune == Tune::Psnr && config.speed_settings.tx_domain_distortion;
586 587 588 589 590 591 592 593 594 595 596

        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
597
            order_hint: 0,
598 599
            show_frame: true,
            showable_frame: true,
600
            error_resilient: false,
601
            intra_only: false,
602
            allow_high_precision_mv: false,
603 604
            frame_type: FrameType::KEY,
            show_existing_frame: false,
fbossen's avatar
fbossen committed
605
            frame_to_show_map_idx: 0,
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
            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],
628
            lrf_types: [RESTORE_NONE, RESTORE_NONE, RESTORE_NONE],
629
            delta_q_present: false,
630 631
            config,
            ref_frames: [0; INTER_REFS_PER_FRAME],
fbossen's avatar
fbossen committed
632
            ref_frame_sign_bias: [false; INTER_REFS_PER_FRAME],
633
            rec_buffer: ReferenceFramesSet::new(),
Frank Bossen's avatar
Frank Bossen committed
634
            base_q_idx: config.quantizer as u8,
fbossen's avatar
fbossen committed
635
            me_range_scale: 1,
636
            use_tx_domain_distortion: use_tx_domain_distortion,
Josh Holmer's avatar
Josh Holmer committed
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 754 755 756 757 758 759 760 761 762 763
            inter_cfg: None,
        }
    }

  pub fn new_key_frame(previous_fi: &Self, segment_start_frame: u64) -> Self {
    let mut fi = previous_fi.clone();
    fi.frame_type = FrameType::KEY;
    fi.intra_only = true;
    fi.inter_cfg = None;
    fi.order_hint = 0;
    fi.refresh_frame_flags = ALL_REF_FRAMES_MASK;
    fi.show_frame = true;
    fi.show_existing_frame = false;
    fi.frame_to_show_map_idx = 0;
    let q_boost = 15;
    fi.base_q_idx = (fi.config.quantizer.max(1 + q_boost).min(255 + q_boost) - q_boost) as u8;
    fi.primary_ref_frame = PRIMARY_REF_NONE;
    fi.number = segment_start_frame;
    for i in 0..INTER_REFS_PER_FRAME {
      fi.ref_frames[i] = 0;
    }
    fi
  }

  fn apply_inter_props_cfg(&mut self, idx_in_segment: u64) {
    let reorder = !self.config.low_latency;
    let multiref = reorder || self.config.speed_settings.multiref;

    let pyramid_depth = if reorder { 2 } else { 0 };
    let group_src_len = 1 << pyramid_depth;
    let group_len = group_src_len + if reorder { pyramid_depth } else { 0 };

    let idx_in_group = (idx_in_segment - 1) % group_len;
    let group_idx = (idx_in_segment - 1) / group_len;

    self.inter_cfg = Some(InterPropsConfig {
      reorder,
      multiref,
      pyramid_depth,
      group_src_len,
      group_len,
      idx_in_group,
      group_idx,
    })
  }

  /// Returns the created FrameInvariants along with a bool indicating success.
  /// This interface provides simpler usage, because we always need the produced
  /// FrameInvariants regardless of success or failure.
  pub fn new_inter_frame(previous_fi: &Self, segment_start_frame: u64, idx_in_segment: u64, next_keyframe: u64) -> (Self, bool) {
    let mut fi = previous_fi.clone();
    fi.frame_type = FrameType::INTER;
    fi.intra_only = false;
    fi.apply_inter_props_cfg(idx_in_segment);
    let inter_cfg = fi.inter_cfg.unwrap();

    fi.order_hint = (inter_cfg.group_src_len * inter_cfg.group_idx +
      if inter_cfg.reorder && inter_cfg.idx_in_group < inter_cfg.pyramid_depth {
        inter_cfg.group_src_len >> inter_cfg.idx_in_group
      } else {
        inter_cfg.idx_in_group - inter_cfg.pyramid_depth + 1
      }) as u32;
    let number = segment_start_frame + fi.order_hint as u64;
    if number >= next_keyframe {
      fi.show_existing_frame = false;
      fi.show_frame = false;
      return (fi, false);
    }

    fn pos_to_lvl(pos: u64, pyramid_depth: u64) -> u64 {
      // Derive level within pyramid for a frame with a given coding order position
      // For example, with a pyramid of depth 2, the 2 least significant bits of the
      // position determine the level:
      // 00 -> 0
      // 01 -> 2
      // 10 -> 1
      // 11 -> 2
      pyramid_depth - (pos | (1 << pyramid_depth)).trailing_zeros() as u64
    }

    let lvl = if !inter_cfg.reorder {
      0
    } else if inter_cfg.idx_in_group < inter_cfg.pyramid_depth {
      inter_cfg.idx_in_group
    } else {
      pos_to_lvl(inter_cfg.idx_in_group - inter_cfg.pyramid_depth + 1, inter_cfg.pyramid_depth)
    };

    // Frames with lvl == 0 are stored in slots 0..4 and frames with higher values
    // of lvl in slots 4..8
    let slot_idx = if lvl == 0 {
      (fi.order_hint >> inter_cfg.pyramid_depth) % 4 as u32
    } else {
      3 + lvl as u32
    };
    fi.show_frame = !inter_cfg.reorder || inter_cfg.idx_in_group >= inter_cfg.pyramid_depth;
    fi.show_existing_frame = fi.show_frame && inter_cfg.reorder &&
      (inter_cfg.idx_in_group - inter_cfg.pyramid_depth + 1).count_ones() == 1 &&
      inter_cfg.idx_in_group != inter_cfg.pyramid_depth;
    fi.frame_to_show_map_idx = slot_idx;
    fi.refresh_frame_flags = if fi.show_existing_frame {
      0
    } else {
      1 << slot_idx
    };

    let q_drop = 15 * lvl as usize;
    fi.base_q_idx = (fi.config.quantizer.min(255 - q_drop) + q_drop) as u8;

    let second_ref_frame = if !inter_cfg.multiref {
      NONE_FRAME
    } else if !inter_cfg.reorder || inter_cfg.idx_in_group == 0 {
      LAST2_FRAME
    } else {
      ALTREF_FRAME
    };
    let ref_in_previous_group = LAST3_FRAME;

    // reuse probability estimates from previous frames only in top level frames
    fi.primary_ref_frame = if lvl > 0 { PRIMARY_REF_NONE } else { (ref_in_previous_group - LAST_FRAME) as u32 };

    for i in 0..INTER_REFS_PER_FRAME {
      fi.ref_frames[i] = if lvl == 0 {
        if i == second_ref_frame - LAST_FRAME {
          (slot_idx + 4 - 2) as u8 % 4
        } else {
          (slot_idx + 4 - 1) as u8 % 4
764
        }
Josh Holmer's avatar
Josh Holmer committed
765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
      } else {
        if i == second_ref_frame - LAST_FRAME {
          let oh = fi.order_hint + (inter_cfg.group_src_len as u32 >> lvl);
          let lvl2 = pos_to_lvl(oh as u64, inter_cfg.pyramid_depth);
          if lvl2 == 0 {
            ((oh >> inter_cfg.pyramid_depth) % 4) as u8
          } else {
            3 + lvl2 as u8
          }
        } else if i == ref_in_previous_group - LAST_FRAME {
          if lvl == 0 {
            (slot_idx + 4 - 1) as u8 % 4
          } else {
            slot_idx as u8
          }
        } else {
          let oh = fi.order_hint - (inter_cfg.group_src_len as u32 >> lvl);
          let lvl1 = pos_to_lvl(oh as u64, inter_cfg.pyramid_depth);
          if lvl1 == 0 {
            ((oh >> inter_cfg.pyramid_depth) % 4) as u8
          } else {
            3 + lvl1 as u8
          }
        }
      }
790
    }
Josh Holmer's avatar
Josh Holmer committed
791 792 793 794 795 796 797 798 799 800

    fi.reference_mode = if inter_cfg.multiref && inter_cfg.reorder && inter_cfg.idx_in_group != 0 {
      ReferenceMode::SELECT
    } else {
      ReferenceMode::SINGLE
    };
    fi.number = number;
    fi.me_range_scale = (inter_cfg.group_src_len >> lvl) as u8;
    (fi, true)
  }
801 802 803 804 805 806 807 808
}

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

Josh Holmer's avatar
Josh Holmer committed
809 810 811 812 813 814 815 816 817 818 819
#[derive(Debug, Clone, Copy)]
pub struct InterPropsConfig {
  pub reorder: bool,
  pub multiref: bool,
  pub pyramid_depth: u64,
  pub group_src_len: u64,
  pub group_len: u64,
  pub idx_in_group: u64,
  pub group_idx: u64,
}

820 821
#[allow(dead_code,non_camel_case_types)]
#[derive(Debug,PartialEq,Clone,Copy)]
822
#[repr(C)]
823 824 825 826 827 828 829 830 831 832
pub enum FrameType {
    KEY,
    INTER,
    INTRA_ONLY,
    SWITCH,
}

//const REFERENCE_MODES: usize = 3;

#[allow(dead_code,non_camel_case_types)]
Josh Holmer's avatar
Josh Holmer committed
833
#[derive(Debug, Clone, Copy, PartialEq)]
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
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) {
854
    let mut bw = BitWriter::endian(output_file, LittleEndian);
855 856 857 858 859 860 861 862 863 864 865 866 867
    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]) {
868
    let mut bw = BitWriter::endian(output_file, LittleEndian);
869 870 871 872 873 874 875 876 877 878 879
    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<()>;
880
    fn write_frame_header_obu(&mut self, seq: &Sequence, fi: &FrameInvariants, fs: &FrameState)
881 882 883 884 885 886 887
            -> 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<()>;
888 889
    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<()>;
890
    fn write_frame_cdef(&mut self, seq: &Sequence, fi: &FrameInvariants) -> io::Result<()>;
891
    fn write_frame_lrf(&mut self, seq: &Sequence, fi: &FrameInvariants) -> io::Result<()>;
892
    fn write_segment_data(&mut self, fi: &FrameInvariants, fs: &FrameState) -> io::Result<()>;
893 894 895 896 897 898 899 900 901 902 903 904 905 906
}
#[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;

907
impl<W: io::Write> UncompressedHeader for BitWriter<W, BigEndian> {
908 909 910 911 912 913 914 915 916 917 918
    // 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 {
Raphaël Zumer's avatar
Raphaël Zumer committed
919
            unimplemented!();
920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937
            //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 {
Raphaël Zumer's avatar
Raphaël Zumer committed
938
            unimplemented!();
939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
        }

        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;

Raphaël Zumer's avatar
Raphaël Zumer committed
1018
        self.write_bit(high_bd)?;
1019 1020

        if seq.bit_depth == 12 {
Raphaël Zumer's avatar
Raphaël Zumer committed
1021
            self.write_bit(true)?;
1022 1023 1024
        }

        if seq.profile != 1 {
Raphaël Zumer's avatar
Raphaël Zumer committed
1025
            self.write_bit(seq.monochrome)?;
1026 1027
        }

Raphaël Zumer's avatar
Raphaël Zumer committed
1028
        self.write_bit(false)?; // color description present flag
1029 1030

        if seq.monochrome {
Raphaël Zumer's avatar
Raphaël Zumer committed
1031
            unimplemented!();
1032 1033
        }

Raphaël Zumer's avatar
Raphaël Zumer committed
1034
        self.write_bit(false)?; // full color range
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050

        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
        }

1051
        self.write(2, seq.chroma_sample_position as u32)?;
1052

Raphaël Zumer's avatar
Raphaël Zumer committed
1053
        self.write_bit(false)?; // separate U/V delta quantizers
1054 1055 1056 1057 1058

        Ok(())
    }

#[allow(unused)]
1059
    fn write_frame_header_obu(&mut self, seq: &Sequence, fi: &FrameInvariants, fs: &FrameState)
1060 1061 1062 1063 1064 1065
        -> io::Result<()> {
      if seq.reduced_still_picture_hdr {
        assert!(fi.show_existing_frame);
        assert!(fi.frame_type == FrameType::KEY);
        assert!(fi.show_frame);
      } else {
Raphaël Zumer's avatar
Raphaël Zumer committed
1066 1067
        self.write_bit(fi.show_existing_frame)?;

1068
        if fi.show_existing_frame {
fbossen's avatar
fbossen committed
1069
          self.write(3, fi.frame_to_show_map_idx)?;
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080

          //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
1081
          self.write_bit(true)?; // trailing bit
1082
          self.byte_align()?;
1083
          return Ok(());
1084
        }
Raphaël Zumer's avatar
Raphaël Zumer committed
1085

1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128
        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 {
Raphaël Zumer's avatar
Raphaël Zumer committed
1129 1130
        unimplemented!();

1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
        //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
1146 1147 1148
        let n = seq.order_hint_bits_minus_1 + 1;
        let mask = (1 << n) - 1;
        self.write(n, fi.order_hint & mask)?;
1149
      }
fbossen's avatar
fbossen committed
1150

1151 1152 1153 1154 1155 1156
      if fi.error_resilient || fi.intra_only {
      } else {
        self.write(PRIMARY_REF_BITS, fi.primary_ref_frame)?;
      }

      if seq.decoder_model_info_present_flag {
Raphaël Zumer's avatar
Raphaël Zumer committed
1157
        unimplemented!();
1158 1159 1160 1161
      }

      if fi.frame_type == FrameType::KEY {
        if !fi.show_frame {  // unshown keyframe (forward keyframe)
Raphaël Zumer's avatar
Raphaël Zumer committed
1162
          unimplemented!();
1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
          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) {
Raphaël Zumer's avatar
Raphaël Zumer committed
1181
          unimplemented!();
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191
          //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 {
Raphaël Zumer's avatar
Raphaël Zumer committed
1192
          unimplemented!();
1193 1194
        }
        if seq.enable_superres {
Raphaël Zumer's avatar
Raphaël Zumer committed
1195
          unimplemented!();
1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
        }
        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 {
Raphaël Zumer's avatar
Raphaël Zumer committed
1214
              unimplemented!();
1215 1216 1217
            }
          }

1218
          for i in 0..INTER_REFS_PER_FRAME {
1219 1220 1221 1222
            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 {
Raphaël Zumer's avatar
Raphaël Zumer committed
1223
              unimplemented!();
1224 1225 1226
            }
          }
          if fi.error_resilient && frame_size_override_flag {
Raphaël Zumer's avatar
Raphaël Zumer committed
1227
            unimplemented!();
1228 1229
          } else {
            if frame_size_override_flag {
Raphaël Zumer's avatar
Raphaël Zumer committed
1230
               unimplemented!();
1231 1232
            }
            if seq.enable_superres {
Raphaël Zumer's avatar
Raphaël Zumer committed
1233
              unimplemented!();
1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
            }
            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
1269 1270
      assert!(fi.base_q_idx > 0);
      self.write(8, fi.base_q_idx)?; // base_q_idx
1271 1272 1273 1274 1275 1276
      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
1277
      self.write_segment_data(fi, fs)?;
1278 1279 1280 1281

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

1282
      // delta_lf_params in the spec
1283
      self.write_deblock_filter_a(fi, fs)?;
1284 1285 1286 1287

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

      // loop_filter_params in the spec
1288
      self.write_deblock_filter_b(fi, fs)?;
1289

1290 1291
      // cdef
      self.write_frame_cdef(seq, fi)?;
1292

1293
      // loop restoration
1294 1295
      self.write_frame_lrf(seq,fi)?;

1296 1297 1298 1299 1300 1301 1302 1303
      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
1304
      let skip_mode_allowed = seq.get_skip_mode_allowed(fi, reference_select);
1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376
      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(())
    }

1377
    fn write_deblock_filter_a(&mut self, fi: &FrameInvariants, fs: &FrameState) -> io::Result<()> {
1378 1379
        if fi.delta_q_present {
            if !fi.allow_intrabc {
1380
                self.write_bit(fs.deblock.block_deltas_enabled)?;
1381
            }
1382 1383 1384
            if fs.deblock.block_deltas_enabled {
                self.write(2,fs.deblock.block_delta_shift)?;
                self.write_bit(fs.deblock.block_delta_multi)?;
1385 1386 1387 1388 1389
            }
        }
        Ok(())
    }

1390 1391 1392 1393 1394 1395 1396 1397 1398 1399
    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
1400
        }
1401 1402 1403 1404 1405
        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 {
1406 1407 1408 1409
                // 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 {
1410
                    fi.rec_buffer.deblock[fi.ref_frames[fi.primary_ref_frame as usize] as usize].ref_deltas
1411 1412
                };
                for i in 0..REF_FRAMES {
1413
                    let update = fs.deblock.ref_deltas[i] != prev_ref_deltas[i];
1414 1415
                    self.write_bit(update)?;
                    if update {
1416
                        self.write_signed(7,fs.deblock.ref_deltas[i])?;
1417 1418 1419 1420 1421 1422
                    }
                }
                // conditionally write mode delta updates
                let prev_mode_deltas = if fi.primary_ref_frame == PRIMARY_REF_NONE {
                    [0, 0]
                } else {
1423
                    fi.rec_buffer.deblock[fi.ref_frames[fi.primary_ref_frame as usize] as usize].mode_deltas
1424 1425
                };
                for i in 0..2 {
1426
                    let update = fs.deblock.mode_deltas[i] != prev_mode_deltas[i];
1427 1428
                    self.write_bit(update)?;
                    if update {
1429
                        self.write_signed(7,fs.deblock.mode_deltas[i])?;
1430 1431 1432 1433 1434
                    }
                }
            }
        }
        Ok(())
1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452
    }

    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(())
    }
1453 1454

    fn write_frame_lrf(&mut self, seq: &Sequence, fi: &FrameInvariants) -> io::Result<()> {
1455
      if seq.enable_restoration && !fi.allow_intrabc { // && !self.lossless
1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487
        let mut use_lrf = false;
        let mut use_chroma_lrf = false;
        for i in 0..PLANES {
          self.write(2,fi.lrf_types[i])?; // filter type by plane
          if fi.lrf_types[i] != RESTORE_NONE {
            use_lrf = true;
            if i > 0 { use_chroma_lrf = true; }
          }
        }
        if use_lrf {
          // At present, we're locked to a restoration unit size equal to superblock size.
          // Signal as such.
          if seq.use_128x128_superblock {
            self.write(1,0)?; // do not double the restoration unit from 128x128
          } else {
            self.write(1,0)?; // do not double the restoration unit from 64x64
          }

          if use_chroma_lrf {
            // until we're able to support restoration units larger than
            // the chroma superblock size, we can't perform LRF for
            // anything other than 4:4:4 and 4:2:0
            assert!(seq.chroma_sampling == ChromaSampling::Cs444 ||
                   seq.chroma_sampling == ChromaSampling::Cs420);
            if seq.chroma_sampling == ChromaSampling::Cs420 {
              self.write(1,1)?; // halve the chroma restoration unit in both directions
            }
          }
        }
      }
      Ok(())
    }
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520

    fn write_segment_data(&mut self, fi: &FrameInvariants, fs: &FrameState) -> io::Result<()> {
        self.write_bit(fs.segmentation.enabled)?;
        if fs.segmentation.enabled {
            if fi.primary_ref_frame == PRIMARY_REF_NONE {
                assert_eq!(fs.segmentation.update_map, true);
                assert_eq!(fs.segmentation.update_data, true);
            } else {
                self.write_bit(fs.segmentation.update_map)?;
                if fs.segmentation.update_map {
                    self.write_bit(false)?; /* Without using temporal prediction */
                }
                self.write_bit(fs.segmentation.update_data)?;
            }
            if fs.segmentation.update_data {
                for i in 0..8 {
                    for j in 0..SegLvl::SEG_LVL_MAX as usize {
                        self.write_bit(fs.segmentation.features[i][j])?;
                        if fs.segmentation.features[i][j] {
                            let bits = seg_feature_bits[j];
                            let data = fs.segmentation.data[i][j];
                            if seg_feature_is_signed[j] {
                                self.write_signed(bits + 1, data)?;
                            } else {
                                self.write(bits, data)?;
                            }
                        }
                    }
                }
            }
        }
        Ok(())
    }
1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546
}

#[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; }
  }
1547
  size
1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563
}

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,
1564
                            fi: &mut FrameInvariants, fs: &FrameState) -> io::Result<()> {
1565
    //let mut uch = BitWriter::endian(packet, BigEndian);
1566 1567 1568 1569
    let obu_extension = 0 as u32;

    let mut buf1 = Vec::new();
    {
1570
        let mut bw1 = BitWriter::endian(&mut buf1, BigEndian);
1571 1572 1573
      bw1.write_obu_header(OBU_Type::OBU_TEMPORAL_DELIMITER, obu_extension)?;
      bw1.write(8,0)?;	// size of payload == 0, one byte
    }
1574
    packet.write_all(&buf1).unwrap();
1575 1576 1577 1578 1579 1580
    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();
        {
1581
            let mut bw2 = BitWriter::endian(&mut buf2, BigEndian);
1582 1583 1584 1585 1586
            bw2.write_sequence_header_obu(sequence, fi)?;
            bw2.byte_align()?;
        }

        {
1587
            let mut bw1 = BitWriter::endian(&mut buf1, BigEndian);
1588 1589
            bw1.write_obu_header(OBU_Type::OBU_SEQUENCE_HEADER, obu_extension)?;
        }
1590
        packet.write_all(&buf1).unwrap();
1591 1592 1593 1594
        buf1.clear();

        let obu_payload_size = buf2.len() as u64;
        {
1595
            let mut bw1 = BitWriter::endian(&mut buf1, BigEndian);
1596 1597 1598 1599 1600 1601 1602
            // 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])?;
            }
        }
1603
        packet.write_all(&buf1).unwrap();
1604 1605
        buf1.clear();

1606
        packet.write_all(&buf2).unwrap();
1607 1608 1609 1610 1611
        buf2.clear();
    }

    let mut buf2 = Vec::new();
    {
1612
        let mut bw2 = BitWriter::endian(&mut buf2, BigEndian);
1613
        bw2.write_frame_header_obu(sequence, fi, fs)?;
1614 1615 1616
    }

    {
1617
        let mut bw1 = BitWriter::endian(&mut buf1, BigEndian);
1618 1619
        bw1.write_obu_header(OBU_Type::OBU_FRAME_HEADER, obu_extension)?;
    }
1620
    packet.write_all(&buf1).unwrap();
1621 1622 1623 1624
    buf1.clear();

    let obu_payload_size = buf2.len() as u64;
    {
1625
        let mut bw1 = BitWriter::endian(&mut buf1, BigEndian);
1626 1627 1628 1629 1630 1631