api.rs 17.6 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.

Raphaël Zumer's avatar
Raphaël Zumer committed
10
use bitstream_io::*;
Luca Barbato's avatar
Luca Barbato committed
11
use encoder::*;
Raphaël Zumer's avatar
Raphaël Zumer committed
12
use metrics::calculate_frame_psnr;
13
use partition::*;
Raphaël Zumer's avatar
Raphaël Zumer committed
14 15
use scenechange::SceneChangeDetector;
use self::EncoderStatus::*;
Luca Barbato's avatar
Luca Barbato committed
16

Raphaël Zumer's avatar
Raphaël Zumer committed
17
use std::{cmp, fmt, io};
fbossen's avatar
fbossen committed
18
use std::collections::BTreeMap;
Luca Barbato's avatar
Luca Barbato committed
19
use std::sync::Arc;
Josh Holmer's avatar
Josh Holmer committed
20 21 22 23
use util::Fixed;
use std::collections::BTreeSet;

const LOOKAHEAD_FRAMES: u64 = 10;
Luca Barbato's avatar
Luca Barbato committed
24

25 26 27 28 29 30 31 32 33
#[derive(Debug, Clone, Copy)]
pub struct VideoDetails {
  pub width: usize,
  pub height: usize,
  pub bytes: usize,
  pub mono: bool,
  pub bit_depth: usize,
  pub chroma_sampling: ChromaSampling,
  pub chroma_sample_position: ChromaSamplePosition,
Luca Barbato's avatar
Luca Barbato committed
34
  pub time_base: Rational,
35 36 37 38 39 40 41 42 43 44 45 46
}

impl Default for VideoDetails {
  fn default() -> Self {
    VideoDetails {
      width: 640,
      height: 480,
      bytes: 1,
      mono: false,
      bit_depth: 8,
      chroma_sampling: ChromaSampling::Cs420,
      chroma_sample_position: ChromaSamplePosition::Unknown,
Luca Barbato's avatar
Luca Barbato committed
47
      time_base: Rational { num: 30, den: 1 }
48 49 50 51
    }
  }
}

Luca Barbato's avatar
Luca Barbato committed
52 53
// TODO: use the num crate?
#[derive(Clone, Copy, Debug)]
54
#[repr(C)]
Luca Barbato's avatar
Luca Barbato committed
55 56 57
pub struct Rational {
  pub num: u64,
  pub den: u64
Luca Barbato's avatar
Luca Barbato committed
58 59
}

Luca Barbato's avatar
Luca Barbato committed
60 61 62
impl Rational {
  pub fn new(num: u64, den: u64) -> Self {
    Rational { num, den }
Luca Barbato's avatar
Luca Barbato committed
63 64 65
  }
}

66 67
#[derive(Copy, Clone, Debug)]
pub struct EncoderConfig {
Josh Holmer's avatar
Josh Holmer committed
68 69 70 71
  /// The *minimum* interval between two keyframes
  pub min_key_frame_interval: u64,
  /// The *maximum* interval between two keyframes
  pub max_key_frame_interval: u64,
72
  pub low_latency: bool,
73
  pub quantizer: usize,
74
  pub tune: Tune,
75
  pub color_description: Option<ColorDescription>,
76
  pub speed_settings: SpeedSettings,
77
  pub show_psnr: bool,
78 79 80 81
}

impl Default for EncoderConfig {
  fn default() -> Self {
82 83
    const DEFAULT_SPEED: usize = 3;
    Self::with_speed_preset(DEFAULT_SPEED)
84 85 86
  }
}

87 88 89
impl EncoderConfig {
  pub fn with_speed_preset(speed: usize) -> Self {
    EncoderConfig {
Josh Holmer's avatar
Josh Holmer committed
90 91
      min_key_frame_interval: 12,
      max_key_frame_interval: 240,
92 93 94
      low_latency: true,
      quantizer: 100,
      tune: Tune::Psnr,
95
      color_description: None,
96 97
      speed_settings: SpeedSettings::from_preset(speed),
      show_psnr: false,
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 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
    }
  }
}

#[derive(Clone, Copy, Debug)]
pub struct SpeedSettings {
  pub min_block_size: BlockSize,
  pub multiref: bool,
  pub fast_deblock: bool,
  pub reduced_tx_set: bool,
  pub tx_domain_distortion: bool,
  pub encode_bottomup: bool,
  pub rdo_tx_decision: bool,
  pub prediction_modes: PredictionModesSetting,
  pub include_near_mvs: bool,
}

impl SpeedSettings {
  pub fn from_preset(speed: usize) -> Self {
    SpeedSettings {
      min_block_size: Self::min_block_size_preset(speed),
      multiref: Self::multiref_preset(speed),
      fast_deblock: Self::fast_deblock_preset(speed),
      reduced_tx_set: Self::reduced_tx_set_preset(speed),
      tx_domain_distortion: Self::tx_domain_distortion_preset(speed),
      encode_bottomup: Self::encode_bottomup_preset(speed),
      rdo_tx_decision: Self::rdo_tx_decision_preset(speed),
      prediction_modes: Self::prediction_modes_preset(speed),
      include_near_mvs: Self::include_near_mvs_preset(speed),
    }
  }

  fn min_block_size_preset(speed: usize) -> BlockSize {
    if speed <= 1 {
      BlockSize::BLOCK_4X4
    } else if speed <= 2 {
      BlockSize::BLOCK_8X8
    } else if speed <= 3 {
      BlockSize::BLOCK_16X16
    } else if speed <= 4 {
      BlockSize::BLOCK_32X32
    } else {
      BlockSize::BLOCK_64X64
    }
  }

  fn multiref_preset(speed: usize) -> bool {
    speed <= 2
  }

  fn fast_deblock_preset(speed: usize) -> bool {
    speed >= 4
  }

  fn reduced_tx_set_preset(speed: usize) -> bool {
    speed >= 2
  }

  fn tx_domain_distortion_preset(speed: usize) -> bool {
    speed >= 1
  }

  fn encode_bottomup_preset(speed: usize) -> bool {
    speed == 0
  }

  fn rdo_tx_decision_preset(speed: usize) -> bool {
    speed <= 3
  }

  fn prediction_modes_preset(speed: usize) -> PredictionModesSetting {
169
    if speed <= 1 {
170
      PredictionModesSetting::ComplexAll
171
    } else if speed <= 3 {
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
      PredictionModesSetting::ComplexKeyframes
    } else {
      PredictionModesSetting::Simple
    }
  }

  fn include_near_mvs_preset(speed: usize) -> bool {
    speed <= 2
  }
}

#[derive(Clone, Copy, Debug, PartialOrd, PartialEq)]
pub enum PredictionModesSetting {
  Simple,
  ComplexKeyframes,
  ComplexAll,
}

190 191
arg_enum!{
  #[derive(Debug, Clone, Copy, PartialEq)]
192
  #[repr(C)]
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
  pub enum MatrixCoefficients {
      Identity = 0,
      BT709,
      Unspecified,
      BT470M = 4,
      BT470BG,
      ST170M,
      ST240M,
      YCgCo,
      BT2020NonConstantLuminance,
      BT2020ConstantLuminance,
      ST2085,
      ChromaticityDerivedNonConstantLuminance,
      ChromaticityDerivedConstantLuminance,
      ICtCp,
  }
209 210 211 212 213 214 215 216
}

impl Default for MatrixCoefficients {
    fn default() -> Self {
        MatrixCoefficients::Unspecified
    }
}

217 218
arg_enum!{
  #[derive(Debug,Clone,Copy,PartialEq)]
219
  #[repr(C)]
220 221 222 223 224 225 226 227 228 229 230 231 232 233
  pub enum ColorPrimaries {
      BT709 = 1,
      Unspecified,
      BT470M = 4,
      BT470BG,
      ST170M,
      ST240M,
      Film,
      BT2020,
      ST428,
      P3DCI,
      P3Display,
      Tech3213 = 22,
  }
234 235 236 237 238 239 240 241
}

impl Default for ColorPrimaries {
    fn default() -> Self {
        ColorPrimaries::Unspecified
    }
}

242 243
arg_enum!{
  #[derive(Debug,Clone,Copy,PartialEq)]
244
  #[repr(C)]
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
  pub enum TransferCharacteristics {
      BT1886 = 1,
      Unspecified,
      BT470M = 4,
      BT470BG,
      ST170M,
      ST240M,
      Linear,
      Logarithmic100,
      Logarithmic316,
      XVYCC,
      BT1361E,
      SRGB,
      BT2020Ten,
      BT2020Twelve,
      PerceptualQuantizer,
      ST428,
      HybridLogGamma,
  }
264 265 266 267 268 269 270 271
}

impl Default for TransferCharacteristics {
    fn default() -> Self {
        TransferCharacteristics::Unspecified
    }
}

272 273 274 275 276 277 278
#[derive(Copy, Clone, Debug)]
pub struct ColorDescription {
    pub color_primaries: ColorPrimaries,
    pub transfer_characteristics: TransferCharacteristics,
    pub matrix_coefficients: MatrixCoefficients
}

279 280 281
/// Contain all the encoder configuration
#[derive(Clone, Copy, Debug)]
pub struct Config {
282
  pub video_info: VideoDetails,
Luca Barbato's avatar
Luca Barbato committed
283 284 285 286
  pub enc: EncoderConfig
}

impl Config {
Luca Barbato's avatar
Luca Barbato committed
287 288
  pub fn parse(&mut self, key: &str, value: &str) -> Result<(), EncoderStatus> {
    match key {
289
      "low_latency" => self.enc.low_latency = value.parse().map_err(|_e| ParseError)?,
Josh Holmer's avatar
Josh Holmer committed
290 291
      "min_key_frame_interval" => self.enc.min_key_frame_interval = value.parse().map_err(|_e| ParseError)?,
      "key_frame_interval" => self.enc.max_key_frame_interval = value.parse().map_err(|_e| ParseError)?,
292
      "quantizer" => self.enc.quantizer = value.parse().map_err(|_e| ParseError)?,
293
      "speed" => self.enc.speed_settings = SpeedSettings::from_preset(value.parse().map_err(|_e| ParseError)?),
294 295
      "tune" => self.enc.tune = value.parse().map_err(|_e| ParseError)?,
      _ => return Err(InvalidKey)
Luca Barbato's avatar
Luca Barbato committed
296 297 298 299 300
    }

    Ok(())
  }

Luca Barbato's avatar
Luca Barbato committed
301
  pub fn new_context(&self) -> Context {
302
    #[cfg(feature = "aom")]
Luca Barbato's avatar
Luca Barbato committed
303
    unsafe {
Luca Barbato's avatar
Luca Barbato committed
304 305
      av1_rtcd();
      aom_dsp_rtcd();
Luca Barbato's avatar
Luca Barbato committed
306 307
    }

Josh Holmer's avatar
Josh Holmer committed
308 309 310 311
    Context {
      frame_count: 0,
      frames_to_be_coded: 0,
      idx: 0,
Josh Holmer's avatar
Josh Holmer committed
312
      frames_processed: 0,
Josh Holmer's avatar
Josh Holmer committed
313
      frame_q: BTreeMap::new(),
Josh Holmer's avatar
Josh Holmer committed
314 315
      frame_data: BTreeMap::new(),
      keyframes: BTreeSet::new(),
Josh Holmer's avatar
Josh Holmer committed
316 317 318
      packet_data: Vec::new(),
      segment_start_idx: 0,
      segment_start_frame: 0,
319
      keyframe_detector: SceneChangeDetector::new(&self.video_info),
Josh Holmer's avatar
Josh Holmer committed
320
      config: *self,
Josh Holmer's avatar
Josh Holmer committed
321
    }
Luca Barbato's avatar
Luca Barbato committed
322 323 324 325
  }
}

pub struct Context {
Luca Barbato's avatar
Luca Barbato committed
326
  //    timebase: Rational,
fbossen's avatar
fbossen committed
327
  frame_count: u64,
328
  frames_to_be_coded: u64,
fbossen's avatar
fbossen committed
329
  idx: u64,
Josh Holmer's avatar
Josh Holmer committed
330 331
  frames_processed: u64,
  /// Maps frame *number* to frames
332
  frame_q: BTreeMap<u64, Option<Arc<Frame>>>, //    packet_q: VecDeque<Packet>
Josh Holmer's avatar
Josh Holmer committed
333 334 335 336 337
  /// Maps frame *idx* to frame data
  frame_data: BTreeMap<u64, FrameInvariants>,
  /// A list of keyframe *numbers* in this encode. Needed so that we don't
  /// need to keep all of the frame_data in memory for the whole life of the encode.
  keyframes: BTreeSet<u64>,
Josh Holmer's avatar
Josh Holmer committed
338 339 340 341
  packet_data: Vec<u8>,
  segment_start_idx: u64,
  segment_start_frame: u64,
  keyframe_detector: SceneChangeDetector,
342
  pub config: Config,
Luca Barbato's avatar
Luca Barbato committed
343 344 345 346 347 348 349 350 351
}

#[derive(Clone, Copy, Debug)]
pub enum EncoderStatus {
  /// The encoder needs more Frames to produce an output Packet
  NeedMoreData,
  /// There are enough Frames queue
  EnoughData,
  ///
Luca Barbato's avatar
Luca Barbato committed
352 353 354
  Failure,
  InvalidKey,
  ParseError
Luca Barbato's avatar
Luca Barbato committed
355 356 357 358
}

pub struct Packet {
  pub data: Vec<u8>,
fbossen's avatar
fbossen committed
359 360
  pub rec: Option<Frame>,
  pub number: u64,
361 362 363
  pub frame_type: FrameType,
  /// PSNR for Y, U, and V planes
  pub psnr: Option<(f64, f64, f64)>,
364 365 366 367
}

impl fmt::Display for Packet {
  fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
Luca Barbato's avatar
Luca Barbato committed
368 369 370 371 372 373 374
    write!(
      f,
      "Frame {} - {} - {} bytes",
      self.number,
      self.frame_type,
      self.data.len()
    )
375
  }
Luca Barbato's avatar
Luca Barbato committed
376 377 378 379
}

impl Context {
  pub fn new_frame(&self) -> Arc<Frame> {
Josh Holmer's avatar
Josh Holmer committed
380
    Arc::new(Frame::new(
381 382 383
      self.config.video_info.width.align_power_of_two(3),
      self.config.video_info.height.align_power_of_two(3),
      self.config.video_info.chroma_sampling
Josh Holmer's avatar
Josh Holmer committed
384
    ))
Luca Barbato's avatar
Luca Barbato committed
385 386 387 388 389 390
  }

  pub fn send_frame<F>(&mut self, frame: F) -> Result<(), EncoderStatus>
  where
    F: Into<Option<Arc<Frame>>>
  {
Josh Holmer's avatar
Josh Holmer committed
391 392
    let idx = self.frame_count;
    self.frame_q.insert(idx, frame.into());
393
    self.frame_count += 1;
Luca Barbato's avatar
Luca Barbato committed
394 395 396
    Ok(())
  }

397 398 399 400 401 402 403 404
  pub fn get_frame_count(&self) -> u64 {
    self.frame_count
  }

  pub fn set_frames_to_be_coded(&mut self, frames_to_be_coded: u64) {
    self.frames_to_be_coded = frames_to_be_coded;
  }

Josh Holmer's avatar
Josh Holmer committed
405 406 407 408
  pub fn needs_more_lookahead(&self) -> bool {
    self.needs_more_frames(self.frame_count) && self.frames_processed + LOOKAHEAD_FRAMES > self.frame_q.keys().last().cloned().unwrap_or(0)
  }

409 410 411 412
  pub fn needs_more_frames(&self, frame_count: u64) -> bool {
    self.frames_to_be_coded == 0 || frame_count < self.frames_to_be_coded
  }

413 414 415
  pub fn container_sequence_header(&mut self) -> Vec<u8> {
    fn sequence_header_inner(seq: &Sequence) -> io::Result<Vec<u8>> {
      let mut buf = Vec::new();
416

417
      {
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
        let mut bw = BitWriter::endian(&mut buf, BigEndian);
        bw.write_bit(true)?; // marker
        bw.write(7, 1)?; // version
        bw.write(3, seq.profile)?;
        bw.write(5, 32)?; // level
        bw.write_bit(false)?; // tier
        bw.write_bit(seq.bit_depth > 8)?; // high_bitdepth
        bw.write_bit(seq.bit_depth == 12)?; // twelve_bit
        bw.write_bit(seq.bit_depth == 1)?; // monochrome
        bw.write_bit(seq.bit_depth == 12)?; // twelve_bit
        bw.write_bit(seq.chroma_sampling != ChromaSampling::Cs444)?; // chroma_subsampling_x
        bw.write_bit(seq.chroma_sampling == ChromaSampling::Cs420)?; // chroma_subsampling_y
        bw.write(2, 0)?; // sample_position
        bw.write(3, 0)?; // reserved
        bw.write_bit(false)?; // initial_presentation_delay_present

        bw.write(4, 0)?; // reserved
435
      }
436

437 438 439
      Ok(buf)
    }

Josh Holmer's avatar
Josh Holmer committed
440
    sequence_header_inner(&self.frame_data[&0].sequence).unwrap()
441 442
  }

Josh Holmer's avatar
Josh Holmer committed
443
  fn next_keyframe(&self) -> u64 {
Josh Holmer's avatar
Josh Holmer committed
444 445 446 447
    let next_detected = self.frame_data.values()
      .find(|fi| fi.frame_type == FrameType::KEY && fi.number > self.segment_start_frame)
      .map(|fi| fi.number);
    let next_limit = self.segment_start_frame + self.config.enc.max_key_frame_interval;
Josh Holmer's avatar
Josh Holmer committed
448 449 450 451 452
    if next_detected.is_none() {
      return next_limit;
    }
    cmp::min(next_detected.unwrap(), next_limit)
  }
fbossen's avatar
fbossen committed
453

Josh Holmer's avatar
Josh Holmer committed
454
  fn set_frame_properties(&mut self, idx: u64) -> Result<(), ()> {
Josh Holmer's avatar
Josh Holmer committed
455 456 457 458 459 460 461 462 463 464 465
    let props = self.get_frame_properties(idx);
    let result = props.as_ref().map(|_| ()).map_err(|_| ());
    match props {
      Ok(props) | Err(props) => {
        self.frame_data.insert(idx, props);
      }
    }
    result
  }

  fn get_frame_properties(&mut self, idx: u64) -> Result<FrameInvariants, FrameInvariants> {
Josh Holmer's avatar
Josh Holmer committed
466 467
    if idx == 0 {
      // The first frame will always be a key frame
Josh Holmer's avatar
Josh Holmer committed
468 469
      let fi = FrameInvariants::new_key_frame(
        &FrameInvariants::new(
470 471
          self.config.video_info.width,
          self.config.video_info.height,
Josh Holmer's avatar
Josh Holmer committed
472
          self.config.enc,
473
          Sequence::new(&self.config.video_info)
Josh Holmer's avatar
Josh Holmer committed
474 475 476 477
        ),
        0
      );
      return Ok(fi);
Josh Holmer's avatar
Josh Holmer committed
478 479
    }

Josh Holmer's avatar
Josh Holmer committed
480 481
    let mut fi = self.frame_data[&(idx - 1)].clone();

Josh Holmer's avatar
Josh Holmer committed
482 483 484 485 486 487
    // Initially set up the frame as an inter frame.
    // We need to determine what the frame number is before we can
    // look up the frame type. If reordering is enabled, the idx
    // may not match the frame number.
    let idx_in_segment = idx - self.segment_start_idx;
    if idx_in_segment > 0 {
Josh Holmer's avatar
Josh Holmer committed
488
      let next_keyframe = self.next_keyframe();
Josh Holmer's avatar
Josh Holmer committed
489 490
      let (fi_temp, success) = FrameInvariants::new_inter_frame(
        &fi,
491 492 493 494
        self.segment_start_frame,
        idx_in_segment,
        next_keyframe
      );
Josh Holmer's avatar
Josh Holmer committed
495
      fi = fi_temp;
Josh Holmer's avatar
Josh Holmer committed
496
      if !success {
Josh Holmer's avatar
Josh Holmer committed
497 498 499
        if !fi.inter_cfg.unwrap().reorder
          || ((idx_in_segment - 1) % fi.inter_cfg.unwrap().group_len == 0
          && fi.number == (next_keyframe - 1))
500
        {
Josh Holmer's avatar
Josh Holmer committed
501
          self.segment_start_idx = idx;
Josh Holmer's avatar
Josh Holmer committed
502
          self.segment_start_frame = next_keyframe;
Josh Holmer's avatar
Josh Holmer committed
503
          fi.number = next_keyframe;
Josh Holmer's avatar
Josh Holmer committed
504
        } else {
Josh Holmer's avatar
Josh Holmer committed
505
          return Err(fi);
Josh Holmer's avatar
Josh Holmer committed
506 507
        }
      }
fbossen's avatar
fbossen committed
508
    }
Luca Barbato's avatar
Luca Barbato committed
509

Josh Holmer's avatar
Josh Holmer committed
510
    // Now that we know the frame number, look up the correct frame type
Josh Holmer's avatar
Josh Holmer committed
511 512 513 514 515 516 517
    let frame_type = self.determine_frame_type(fi.number);
    if frame_type == FrameType::KEY {
      self.segment_start_idx = idx;
      self.segment_start_frame = fi.number;
      self.keyframes.insert(fi.number);
    }
    fi.frame_type = frame_type;
Josh Holmer's avatar
Josh Holmer committed
518

Josh Holmer's avatar
Josh Holmer committed
519 520 521 522 523 524 525 526 527 528 529 530 531 532
    let idx_in_segment = idx - self.segment_start_idx;
    if idx_in_segment == 0 {
      fi = FrameInvariants::new_key_frame(&fi, self.segment_start_frame);
    } else {
      let next_keyframe = self.next_keyframe();
      let (fi_temp, success) = FrameInvariants::new_inter_frame(
        &fi,
        self.segment_start_frame,
        idx_in_segment,
        next_keyframe
      );
      fi = fi_temp;
      if !success {
        return Err(fi);
Josh Holmer's avatar
Josh Holmer committed
533 534
      }
    }
Josh Holmer's avatar
Josh Holmer committed
535
    Ok(fi)
fbossen's avatar
fbossen committed
536
  }
Luca Barbato's avatar
Luca Barbato committed
537

fbossen's avatar
fbossen committed
538 539
  pub fn receive_packet(&mut self) -> Result<Packet, EncoderStatus> {
    let mut idx = self.idx;
Josh Holmer's avatar
Josh Holmer committed
540
    while self.set_frame_properties(idx).is_err() {
Josh Holmer's avatar
Josh Holmer committed
541
      self.idx += 1;
fbossen's avatar
fbossen committed
542 543
      idx = self.idx;
    }
Luca Barbato's avatar
Luca Barbato committed
544

Josh Holmer's avatar
Josh Holmer committed
545
    if !self.needs_more_frames(self.frame_data.get(&idx).unwrap().number) {
Josh Holmer's avatar
Josh Holmer committed
546
      self.idx += 1;
547 548 549
      return Err(EncoderStatus::EnoughData)
    }

Josh Holmer's avatar
Josh Holmer committed
550 551
    let fi = self.frame_data.get_mut(&idx).unwrap();
    if fi.show_existing_frame {
Josh Holmer's avatar
Josh Holmer committed
552
      self.idx += 1;
Luca Barbato's avatar
Luca Barbato committed
553

Josh Holmer's avatar
Josh Holmer committed
554
      let mut fs = FrameState::new(fi);
fbossen's avatar
fbossen committed
555

Josh Holmer's avatar
Josh Holmer committed
556
      let data = encode_frame(fi, &mut fs);
Luca Barbato's avatar
Luca Barbato committed
557

Josh Holmer's avatar
Josh Holmer committed
558
      let rec = if fi.show_frame { Some(fs.rec) } else { None };
559
      let mut psnr = None;
Josh Holmer's avatar
Josh Holmer committed
560
      if self.config.enc.show_psnr {
561
        if let Some(ref rec) = rec {
Josh Holmer's avatar
Josh Holmer committed
562
          psnr = Some(calculate_frame_psnr(&*fs.input, rec, fi.sequence.bit_depth));
563 564
        }
      }
Luca Barbato's avatar
Luca Barbato committed
565

Josh Holmer's avatar
Josh Holmer committed
566 567
      self.frames_processed += 1;
      Ok(Packet { data, rec, number: fi.number, frame_type: fi.frame_type, psnr })
Luca Barbato's avatar
Luca Barbato committed
568
    } else {
Josh Holmer's avatar
Josh Holmer committed
569
      if let Some(f) = self.frame_q.get(&fi.number) {
Josh Holmer's avatar
Josh Holmer committed
570
        self.idx += 1;
fbossen's avatar
fbossen committed
571 572

        if let Some(frame) = f {
Josh Holmer's avatar
Josh Holmer committed
573
          let mut fs = FrameState::new_with_frame(fi, frame.clone());
fbossen's avatar
fbossen committed
574

Josh Holmer's avatar
Josh Holmer committed
575
          let data = encode_frame(fi, &mut fs);
576
          self.packet_data.extend(data);
fbossen's avatar
fbossen committed
577

Josh Holmer's avatar
Josh Holmer committed
578
          fs.rec.pad(fi.width, fi.height);
fbossen's avatar
fbossen committed
579 580

          // TODO avoid the clone by having rec Arc.
Josh Holmer's avatar
Josh Holmer committed
581
          let rec = if fi.show_frame { Some(fs.rec.clone()) } else { None };
fbossen's avatar
fbossen committed
582

Josh Holmer's avatar
Josh Holmer committed
583
          update_rec_buffer(fi, fs);
fbossen's avatar
fbossen committed
584

Josh Holmer's avatar
Josh Holmer committed
585
          if fi.show_frame {
586 587
            let data = self.packet_data.clone();
            self.packet_data = Vec::new();
588 589

            let mut psnr = None;
Josh Holmer's avatar
Josh Holmer committed
590
            if self.config.enc.show_psnr {
591
              if let Some(ref rec) = rec {
Josh Holmer's avatar
Josh Holmer committed
592
                psnr = Some(calculate_frame_psnr(&*frame, rec, fi.sequence.bit_depth));
593 594 595
              }
            }

Josh Holmer's avatar
Josh Holmer committed
596 597
            self.frames_processed += 1;
            Ok(Packet { data, rec, number: fi.number, frame_type: fi.frame_type, psnr })
598 599 600
          } else {
            Err(EncoderStatus::NeedMoreData)
          }
fbossen's avatar
fbossen committed
601 602 603 604 605 606
        } else {
          Err(EncoderStatus::NeedMoreData)
        }
      } else {
        Err(EncoderStatus::NeedMoreData)
      }
Luca Barbato's avatar
Luca Barbato committed
607 608 609
    }
  }

Josh Holmer's avatar
Josh Holmer committed
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
  pub fn garbage_collect(&mut self, cur_frame: u64) {
    if cur_frame == 0 {
      return;
    }
    for i in 0..cur_frame {
      self.frame_q.remove(&i);
    }
    if self.idx < 2 {
      return;
    }
    for i in 0..(self.idx - 1) {
      self.frame_data.remove(&i);
    }
  }

Luca Barbato's avatar
Luca Barbato committed
625
  pub fn flush(&mut self) {
fbossen's avatar
fbossen committed
626
    self.frame_q.insert(self.frame_count, None);
627
    self.frame_count += 1;
Luca Barbato's avatar
Luca Barbato committed
628
  }
Josh Holmer's avatar
Josh Holmer committed
629

Josh Holmer's avatar
Josh Holmer committed
630 631
  fn determine_frame_type(&mut self, frame_number: u64) -> FrameType {
    if frame_number == 0 {
Josh Holmer's avatar
Josh Holmer committed
632 633 634
      return FrameType::KEY;
    }

Josh Holmer's avatar
Josh Holmer committed
635 636 637 638 639 640 641 642
    let prev_keyframe = self.keyframes.iter()
      .rfind(|&&keyframe| keyframe < frame_number)
      .cloned()
      .unwrap_or(0);
    let frame = match self.frame_q.get(&frame_number).cloned() {
      Some(frame) => frame,
      None => { return FrameType::KEY; }
    };
Josh Holmer's avatar
Josh Holmer committed
643
    if let Some(frame) = frame {
Josh Holmer's avatar
Josh Holmer committed
644 645 646
      let distance = frame_number - prev_keyframe;
      if distance < self.config.enc.min_key_frame_interval {
        if distance + 1 == self.config.enc.min_key_frame_interval {
Josh Holmer's avatar
Josh Holmer committed
647 648
          // Run the detector for the current frame, so that it will contain this frame's information
          // to compare against the next frame. We can ignore the results for this frame.
Josh Holmer's avatar
Josh Holmer committed
649
          self.keyframe_detector.detect_scene_change(frame, frame_number as usize);
Josh Holmer's avatar
Josh Holmer committed
650 651 652
        }
        return FrameType::INTER;
      }
Josh Holmer's avatar
Josh Holmer committed
653
      if distance >= self.config.enc.max_key_frame_interval {
Josh Holmer's avatar
Josh Holmer committed
654 655
        return FrameType::KEY;
      }
Josh Holmer's avatar
Josh Holmer committed
656
      if self.keyframe_detector.detect_scene_change(frame, frame_number as usize) {
Josh Holmer's avatar
Josh Holmer committed
657 658 659 660 661
        return FrameType::KEY;
      }
    }
    FrameType::INTER
  }
Luca Barbato's avatar
Luca Barbato committed
662
}