api.rs 19.1 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::*;
11 12 13
use crate::encoder::*;
use crate::metrics::calculate_frame_psnr;
use crate::partition::*;
14
use crate::rate::RCState;
15
use crate::scenechange::SceneChangeDetector;
Raphaël Zumer's avatar
Raphaël Zumer committed
16
use self::EncoderStatus::*;
Luca Barbato's avatar
Luca Barbato committed
17

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

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

// TODO: use the num crate?
#[derive(Clone, Copy, Debug)]
27
#[repr(C)]
Luca Barbato's avatar
Luca Barbato committed
28 29 30
pub struct Rational {
  pub num: u64,
  pub den: u64
Luca Barbato's avatar
Luca Barbato committed
31 32
}

Luca Barbato's avatar
Luca Barbato committed
33 34 35
impl Rational {
  pub fn new(num: u64, den: u64) -> Self {
    Rational { num, den }
Luca Barbato's avatar
Luca Barbato committed
36 37 38
  }
}

39 40 41 42 43 44 45
#[derive(Clone, Copy, Debug)]
#[repr(C)]
pub struct Point {
  pub x: u16,
  pub y: u16
}

46 47
#[derive(Copy, Clone, Debug)]
pub struct EncoderConfig {
48
  // output size
49 50
  pub width: usize,
  pub height: usize,
51 52

  // data format and ancillary color information
53 54 55
  pub bit_depth: usize,
  pub chroma_sampling: ChromaSampling,
  pub chroma_sample_position: ChromaSamplePosition,
56 57 58 59 60 61
  pub pixel_range: PixelRange,
  pub color_description: Option<ColorDescription>,
  pub mastering_display: Option<MasteringDisplay>,
  pub content_light: Option<ContentLight>,

  // encoder configuration
62
  pub time_base: Rational,
Josh Holmer's avatar
Josh Holmer committed
63 64 65 66
  /// The *minimum* interval between two keyframes
  pub min_key_frame_interval: u64,
  /// The *maximum* interval between two keyframes
  pub max_key_frame_interval: u64,
67
  pub low_latency: bool,
68
  pub quantizer: usize,
69 70
  pub tune: Tune,
  pub speed_settings: SpeedSettings,
71
  pub show_psnr: bool,
72 73 74 75
}

impl Default for EncoderConfig {
  fn default() -> Self {
76 77
    const DEFAULT_SPEED: usize = 3;
    Self::with_speed_preset(DEFAULT_SPEED)
78 79 80
  }
}

81 82 83
impl EncoderConfig {
  pub fn with_speed_preset(speed: usize) -> Self {
    EncoderConfig {
84 85
      width: 640,
      height: 480,
86

87 88 89
      bit_depth: 8,
      chroma_sampling: ChromaSampling::Cs420,
      chroma_sample_position: ChromaSamplePosition::Unknown,
90 91 92 93 94
      pixel_range: PixelRange::Unspecified,
      color_description: None,
      mastering_display: None,
      content_light: None,

95
      time_base: Rational { num: 30, den: 1 },
Josh Holmer's avatar
Josh Holmer committed
96 97
      min_key_frame_interval: 12,
      max_key_frame_interval: 240,
98
      low_latency: false,
99 100
      quantizer: 100,
      tune: Tune::Psnr,
101 102
      speed_settings: SpeedSettings::from_preset(speed),
      show_psnr: false,
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
    }
  }
}

#[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 {
162
    speed >= 4
163 164 165 166 167 168 169 170 171 172 173
  }

  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 {
174
    if speed <= 1 {
175
      PredictionModesSetting::ComplexAll
176
    } else if speed <= 3 {
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
      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,
}

195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
arg_enum!{
  #[derive(Debug, Clone, Copy, PartialEq)]
  #[repr(C)]
  pub enum PixelRange {
      Unspecified = 0,
      Limited,
      Full,
  }
}

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

211 212
arg_enum!{
  #[derive(Debug, Clone, Copy, PartialEq)]
213
  #[repr(C)]
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
  pub enum MatrixCoefficients {
      Identity = 0,
      BT709,
      Unspecified,
      BT470M = 4,
      BT470BG,
      ST170M,
      ST240M,
      YCgCo,
      BT2020NonConstantLuminance,
      BT2020ConstantLuminance,
      ST2085,
      ChromaticityDerivedNonConstantLuminance,
      ChromaticityDerivedConstantLuminance,
      ICtCp,
  }
230 231 232 233 234 235 236 237
}

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

238 239
arg_enum!{
  #[derive(Debug,Clone,Copy,PartialEq)]
240
  #[repr(C)]
241 242 243 244 245 246 247 248 249 250 251 252 253 254
  pub enum ColorPrimaries {
      BT709 = 1,
      Unspecified,
      BT470M = 4,
      BT470BG,
      ST170M,
      ST240M,
      Film,
      BT2020,
      ST428,
      P3DCI,
      P3Display,
      Tech3213 = 22,
  }
255 256 257 258 259 260 261 262
}

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

263 264
arg_enum!{
  #[derive(Debug,Clone,Copy,PartialEq)]
265
  #[repr(C)]
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
  pub enum TransferCharacteristics {
      BT1886 = 1,
      Unspecified,
      BT470M = 4,
      BT470BG,
      ST170M,
      ST240M,
      Linear,
      Logarithmic100,
      Logarithmic316,
      XVYCC,
      BT1361E,
      SRGB,
      BT2020Ten,
      BT2020Twelve,
      PerceptualQuantizer,
      ST428,
      HybridLogGamma,
  }
285 286 287 288 289 290 291 292
}

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

293 294 295 296 297 298 299
#[derive(Copy, Clone, Debug)]
pub struct ColorDescription {
    pub color_primaries: ColorPrimaries,
    pub transfer_characteristics: TransferCharacteristics,
    pub matrix_coefficients: MatrixCoefficients
}

300 301 302 303 304 305 306 307 308 309 310 311 312 313
#[derive(Copy, Clone, Debug)]
pub struct MasteringDisplay {
    pub primaries: [Point; 3],
    pub white_point: Point,
    pub max_luminance: u32,
    pub min_luminance: u32,
}

#[derive(Copy, Clone, Debug)]
pub struct ContentLight {
    pub max_content_light_level: u16,
    pub max_frame_average_light_level: u16,
}

314 315 316
/// Contain all the encoder configuration
#[derive(Clone, Copy, Debug)]
pub struct Config {
Luca Barbato's avatar
Luca Barbato committed
317 318 319 320
  pub enc: EncoderConfig
}

impl Config {
Luca Barbato's avatar
Luca Barbato committed
321 322
  pub fn parse(&mut self, key: &str, value: &str) -> Result<(), EncoderStatus> {
    match key {
323
      "low_latency" => self.enc.low_latency = value.parse().map_err(|_e| ParseError)?,
Josh Holmer's avatar
Josh Holmer committed
324 325
      "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)?,
326
      "quantizer" => self.enc.quantizer = value.parse().map_err(|_e| ParseError)?,
327
      "speed" => self.enc.speed_settings = SpeedSettings::from_preset(value.parse().map_err(|_e| ParseError)?),
328 329
      "tune" => self.enc.tune = value.parse().map_err(|_e| ParseError)?,
      _ => return Err(InvalidKey)
Luca Barbato's avatar
Luca Barbato committed
330 331 332 333 334
    }

    Ok(())
  }

Luca Barbato's avatar
Luca Barbato committed
335
  pub fn new_context(&self) -> Context {
336
    #[cfg(feature = "aom")]
Luca Barbato's avatar
Luca Barbato committed
337
    unsafe {
Luca Barbato's avatar
Luca Barbato committed
338 339
      av1_rtcd();
      aom_dsp_rtcd();
Luca Barbato's avatar
Luca Barbato committed
340 341
    }

342 343 344
    // initialize with temporal delimiter
    let packet_data = TEMPORAL_DELIMITER.to_vec();

Josh Holmer's avatar
Josh Holmer committed
345 346
    Context {
      frame_count: 0,
347
      limit: 0,
Josh Holmer's avatar
Josh Holmer committed
348
      idx: 0,
Josh Holmer's avatar
Josh Holmer committed
349
      frames_processed: 0,
Josh Holmer's avatar
Josh Holmer committed
350
      frame_q: BTreeMap::new(),
Josh Holmer's avatar
Josh Holmer committed
351 352
      frame_data: BTreeMap::new(),
      keyframes: BTreeSet::new(),
353
      packet_data,
Josh Holmer's avatar
Josh Holmer committed
354 355
      segment_start_idx: 0,
      segment_start_frame: 0,
356
      keyframe_detector: SceneChangeDetector::new(self.enc.bit_depth),
Josh Holmer's avatar
Josh Holmer committed
357
      config: *self,
358
      rc_state: RCState::new()
Josh Holmer's avatar
Josh Holmer committed
359
    }
Luca Barbato's avatar
Luca Barbato committed
360 361 362 363
  }
}

pub struct Context {
Luca Barbato's avatar
Luca Barbato committed
364
  //    timebase: Rational,
fbossen's avatar
fbossen committed
365
  frame_count: u64,
366
  limit: u64,
fbossen's avatar
fbossen committed
367
  idx: u64,
Josh Holmer's avatar
Josh Holmer committed
368 369
  frames_processed: u64,
  /// Maps frame *number* to frames
370
  frame_q: BTreeMap<u64, Option<Arc<Frame>>>, //    packet_q: VecDeque<Packet>
Josh Holmer's avatar
Josh Holmer committed
371 372 373 374 375
  /// 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>,
376
  /// A storage space for reordered frames.
Josh Holmer's avatar
Josh Holmer committed
377 378 379 380
  packet_data: Vec<u8>,
  segment_start_idx: u64,
  segment_start_frame: u64,
  keyframe_detector: SceneChangeDetector,
381
  pub config: Config,
382
  rc_state: RCState
Luca Barbato's avatar
Luca Barbato committed
383 384 385 386 387 388 389 390 391
}

#[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
392 393 394
  Failure,
  InvalidKey,
  ParseError
Luca Barbato's avatar
Luca Barbato committed
395 396 397 398
}

pub struct Packet {
  pub data: Vec<u8>,
fbossen's avatar
fbossen committed
399 400
  pub rec: Option<Frame>,
  pub number: u64,
401 402 403
  pub frame_type: FrameType,
  /// PSNR for Y, U, and V planes
  pub psnr: Option<(f64, f64, f64)>,
404 405 406 407
}

impl fmt::Display for Packet {
  fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
Luca Barbato's avatar
Luca Barbato committed
408 409 410 411 412 413 414
    write!(
      f,
      "Frame {} - {} - {} bytes",
      self.number,
      self.frame_type,
      self.data.len()
    )
415
  }
Luca Barbato's avatar
Luca Barbato committed
416 417 418 419
}

impl Context {
  pub fn new_frame(&self) -> Arc<Frame> {
Josh Holmer's avatar
Josh Holmer committed
420
    Arc::new(Frame::new(
421 422
      self.config.enc.width,
      self.config.enc.height,
423
      self.config.enc.chroma_sampling
Josh Holmer's avatar
Josh Holmer committed
424
    ))
Luca Barbato's avatar
Luca Barbato committed
425 426 427 428 429 430
  }

  pub fn send_frame<F>(&mut self, frame: F) -> Result<(), EncoderStatus>
  where
    F: Into<Option<Arc<Frame>>>
  {
Josh Holmer's avatar
Josh Holmer committed
431 432
    let idx = self.frame_count;
    self.frame_q.insert(idx, frame.into());
433
    self.frame_count += 1;
Luca Barbato's avatar
Luca Barbato committed
434 435 436
    Ok(())
  }

437 438 439 440
  pub fn get_frame_count(&self) -> u64 {
    self.frame_count
  }

441 442
  pub fn set_limit(&mut self, limit: u64) {
    self.limit = limit;
443 444
  }

Josh Holmer's avatar
Josh Holmer committed
445 446 447 448
  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)
  }

449
  pub fn needs_more_frames(&self, frame_count: u64) -> bool {
450
    self.limit == 0 || frame_count < self.limit
451 452
  }

453 454 455
  pub fn container_sequence_header(&mut self) -> Vec<u8> {
    fn sequence_header_inner(seq: &Sequence) -> io::Result<Vec<u8>> {
      let mut buf = Vec::new();
456

457
      {
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
        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
475
      }
476

477 478 479
      Ok(buf)
    }

Josh Holmer's avatar
Josh Holmer committed
480
    sequence_header_inner(&self.frame_data[&0].sequence).unwrap()
481 482
  }

Josh Holmer's avatar
Josh Holmer committed
483
  fn next_keyframe(&self) -> u64 {
Josh Holmer's avatar
Josh Holmer committed
484 485 486 487
    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
488 489 490 491 492
    if next_detected.is_none() {
      return next_limit;
    }
    cmp::min(next_detected.unwrap(), next_limit)
  }
fbossen's avatar
fbossen committed
493

494
  fn set_frame_properties(&mut self, idx: u64) -> bool {
495
    let (fi, end_of_subgop) = self.build_frame_properties(idx);
496 497 498
    self.frame_data.insert(idx, fi);

    end_of_subgop
Josh Holmer's avatar
Josh Holmer committed
499 500
  }

501
  fn build_frame_properties(&mut self, idx: u64) -> (FrameInvariants, bool) {
Josh Holmer's avatar
Josh Holmer committed
502
    if idx == 0 {
503
      let seq = Sequence::new(&self.config.enc);
504

Josh Holmer's avatar
Josh Holmer committed
505
      // The first frame will always be a key frame
Josh Holmer's avatar
Josh Holmer committed
506 507 508
      let fi = FrameInvariants::new_key_frame(
        &FrameInvariants::new(
          self.config.enc,
509
          seq
Josh Holmer's avatar
Josh Holmer committed
510 511 512
        ),
        0
      );
513
      return (fi, true);
Josh Holmer's avatar
Josh Holmer committed
514 515
    }

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

518 519 520 521 522
    // FIXME: inter unsupported with 4:2:2 and 4:4:4 chroma sampling
    let chroma_sampling = self.config.enc.chroma_sampling;
    let keyframe_only = chroma_sampling == ChromaSampling::Cs444 ||
      chroma_sampling == ChromaSampling::Cs422;

Josh Holmer's avatar
Josh Holmer committed
523 524 525 526 527 528
    // 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 {
529
      let next_keyframe = if keyframe_only { self.segment_start_frame + 1 } else { self.next_keyframe() };
530
      let (fi_temp, end_of_subgop) = FrameInvariants::new_inter_frame(
Josh Holmer's avatar
Josh Holmer committed
531
        &fi,
532 533 534 535
        self.segment_start_frame,
        idx_in_segment,
        next_keyframe
      );
Josh Holmer's avatar
Josh Holmer committed
536
      fi = fi_temp;
537
      if !end_of_subgop {
Josh Holmer's avatar
Josh Holmer committed
538 539 540
        if !fi.inter_cfg.unwrap().reorder
          || ((idx_in_segment - 1) % fi.inter_cfg.unwrap().group_len == 0
          && fi.number == (next_keyframe - 1))
541
        {
Josh Holmer's avatar
Josh Holmer committed
542
          self.segment_start_idx = idx;
Josh Holmer's avatar
Josh Holmer committed
543
          self.segment_start_frame = next_keyframe;
Josh Holmer's avatar
Josh Holmer committed
544
          fi.number = next_keyframe;
Josh Holmer's avatar
Josh Holmer committed
545
        } else {
546
          return (fi, false);
Josh Holmer's avatar
Josh Holmer committed
547 548
        }
      }
fbossen's avatar
fbossen committed
549
    }
Luca Barbato's avatar
Luca Barbato committed
550

551 552
    match self.frame_q.get(&fi.number) {
      Some(Some(_)) => {},
Josh Holmer's avatar
Josh Holmer committed
553
      _ => { return (fi, false); }
554 555
    }

Josh Holmer's avatar
Josh Holmer committed
556
    // Now that we know the frame number, look up the correct frame type
Josh Holmer's avatar
Josh Holmer committed
557 558 559 560 561 562 563
    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
564

Josh Holmer's avatar
Josh Holmer committed
565 566 567 568 569
    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();
570
      let (fi_temp, end_of_subgop) = FrameInvariants::new_inter_frame(
Josh Holmer's avatar
Josh Holmer committed
571 572 573 574 575 576
        &fi,
        self.segment_start_frame,
        idx_in_segment,
        next_keyframe
      );
      fi = fi_temp;
577 578
      if !end_of_subgop {
        return (fi, false);
Josh Holmer's avatar
Josh Holmer committed
579 580
      }
    }
581
    (fi, true)
fbossen's avatar
fbossen committed
582
  }
Luca Barbato's avatar
Luca Barbato committed
583

fbossen's avatar
fbossen committed
584
  pub fn receive_packet(&mut self) -> Result<Packet, EncoderStatus> {
585 586 587 588 589 590
    let idx = {
      let mut idx = self.idx;
      while !self.set_frame_properties(idx) {
        self.idx += 1;
        idx = self.idx;
      }
Luca Barbato's avatar
Luca Barbato committed
591

592 593 594 595 596 597
      if !self.needs_more_frames(self.frame_data.get(&idx).unwrap().number) {
        self.idx += 1;
        return Err(EncoderStatus::EnoughData);
      }
      idx
    };
598

599
    let ret = {
Luca Barbato's avatar
Luca Barbato committed
600 601 602
      let fi = self.frame_data.get_mut(&idx).unwrap();
      if fi.show_existing_frame {
        self.idx += 1;
Luca Barbato's avatar
Luca Barbato committed
603

Luca Barbato's avatar
Luca Barbato committed
604
        let mut fs = FrameState::new(fi);
fbossen's avatar
fbossen committed
605

606 607
        let sef_data = encode_frame(fi, &mut fs);
        self.packet_data.extend(sef_data);
Luca Barbato's avatar
Luca Barbato committed
608

Luca Barbato's avatar
Luca Barbato committed
609
        let rec = if fi.show_frame { Some(fs.rec) } else { None };
610 611
        let fi = fi.clone();
        self.finalize_packet(&*fs.input, rec, &fi)
Luca Barbato's avatar
Luca Barbato committed
612 613 614
      } else {
        if let Some(f) = self.frame_q.get(&fi.number) {
          self.idx += 1;
fbossen's avatar
fbossen committed
615

616
          if let Some(frame) = f.clone() {
617 618 619
            let fti = fi.get_frame_subtype();
            let qps = self.rc_state.select_qi(fi, fti);
            fi.set_quantizers(&qps);
Luca Barbato's avatar
Luca Barbato committed
620
            let mut fs = FrameState::new_with_frame(fi, frame.clone());
fbossen's avatar
fbossen committed
621

Luca Barbato's avatar
Luca Barbato committed
622 623
            let data = encode_frame(fi, &mut fs);
            self.packet_data.extend(data);
fbossen's avatar
fbossen committed
624

Luca Barbato's avatar
Luca Barbato committed
625
            fs.rec.pad(fi.width, fi.height);
fbossen's avatar
fbossen committed
626

Luca Barbato's avatar
Luca Barbato committed
627 628
            // TODO avoid the clone by having rec Arc.
            let rec = if fi.show_frame { Some(fs.rec.clone()) } else { None };
fbossen's avatar
fbossen committed
629

Luca Barbato's avatar
Luca Barbato committed
630
            update_rec_buffer(fi, fs);
fbossen's avatar
fbossen committed
631

Luca Barbato's avatar
Luca Barbato committed
632
            if fi.show_frame {
633 634
              let fi = fi.clone();
              self.finalize_packet(&*frame, rec, &fi)
Luca Barbato's avatar
Luca Barbato committed
635 636 637
            } else {
              Err(EncoderStatus::NeedMoreData)
            }
638 639 640
          } else {
            Err(EncoderStatus::NeedMoreData)
          }
fbossen's avatar
fbossen committed
641 642 643 644
        } else {
          Err(EncoderStatus::NeedMoreData)
        }
      }
645 646 647
    };

    if let Ok(ref pkt) = ret {
Luca Barbato's avatar
Luca Barbato committed
648
      self.garbage_collect(pkt.number);
649 650 651
    }

    ret
Luca Barbato's avatar
Luca Barbato committed
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
  fn finalize_packet(&mut self, original_frame: &Frame, rec: Option<Frame>, fi: &FrameInvariants) -> Result<Packet, EncoderStatus> {
    let data = self.packet_data.clone();
    self.packet_data.clear();
    if write_temporal_delimiter(&mut self.packet_data).is_err() {
      return Err(EncoderStatus::Failure);
    }

    let mut psnr = None;
    if self.config.enc.show_psnr {
      if let Some(ref rec) = rec {
        psnr = Some(calculate_frame_psnr(
          &*original_frame,
          rec,
          fi.sequence.bit_depth
        ));
      }
    }

    self.frames_processed += 1;
    Ok(Packet {
      data,
      rec,
      number: fi.number,
      frame_type: fi.frame_type,
      psnr
    })
  }

682
  fn garbage_collect(&mut self, cur_frame: u64) {
Josh Holmer's avatar
Josh Holmer committed
683 684 685 686 687 688 689 690 691 692 693 694 695 696
    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
697
  pub fn flush(&mut self) {
fbossen's avatar
fbossen committed
698
    self.frame_q.insert(self.frame_count, None);
699
    self.frame_count += 1;
Luca Barbato's avatar
Luca Barbato committed
700
  }
Josh Holmer's avatar
Josh Holmer committed
701

Josh Holmer's avatar
Josh Holmer committed
702 703
  fn determine_frame_type(&mut self, frame_number: u64) -> FrameType {
    if frame_number == 0 {
Josh Holmer's avatar
Josh Holmer committed
704 705 706
      return FrameType::KEY;
    }

Josh Holmer's avatar
Josh Holmer committed
707 708 709 710 711 712 713 714
    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
715
    if let Some(frame) = frame {
Josh Holmer's avatar
Josh Holmer committed
716 717 718
      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
719 720
          // 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
721
          self.keyframe_detector.detect_scene_change(frame, frame_number as usize);
Josh Holmer's avatar
Josh Holmer committed
722 723 724
        }
        return FrameType::INTER;
      }
Josh Holmer's avatar
Josh Holmer committed
725
      if distance >= self.config.enc.max_key_frame_interval {
Josh Holmer's avatar
Josh Holmer committed
726 727
        return FrameType::KEY;
      }
Josh Holmer's avatar
Josh Holmer committed
728
      if self.keyframe_detector.detect_scene_change(frame, frame_number as usize) {
Josh Holmer's avatar
Josh Holmer committed
729 730 731 732 733
        return FrameType::KEY;
      }
    }
    FrameType::INTER
  }
Luca Barbato's avatar
Luca Barbato committed
734
}