api.rs 19.4 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::*;
Raphaël Zumer's avatar
Raphaël Zumer committed
11 12 13 14
use crate::encoder::*;
use crate::metrics::calculate_frame_psnr;
use crate::partition::*;
use crate::scenechange::SceneChangeDetector;
Raphaël Zumer's avatar
Raphaël Zumer committed
15
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
use std::collections::BTreeSet;

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

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

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

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

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

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

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

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

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

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

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

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

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

194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
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
    }
}

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

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

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

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

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

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

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

299 300 301 302 303 304 305 306 307 308 309 310 311 312
#[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,
}

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

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

    Ok(())
  }

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

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

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

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

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

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

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

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

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

434 435 436 437
  pub fn get_frame_count(&self) -> u64 {
    self.frame_count
  }

438 439
  pub fn set_limit(&mut self, limit: u64) {
    self.limit = limit;
440 441
  }

Josh Holmer's avatar
Josh Holmer committed
442 443 444 445
  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)
  }

446
  pub fn needs_more_frames(&self, frame_count: u64) -> bool {
447
    self.limit == 0 || frame_count < self.limit
448 449
  }

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

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

474 475 476
      Ok(buf)
    }

Josh Holmer's avatar
Josh Holmer committed
477
    sequence_header_inner(&self.frame_data[&0].sequence).unwrap()
478 479
  }

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

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

    end_of_subgop
Josh Holmer's avatar
Josh Holmer committed
496 497
  }

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

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

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

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

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

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

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

fbossen's avatar
fbossen committed
581
  pub fn receive_packet(&mut self) -> Result<Packet, EncoderStatus> {
582 583 584 585 586 587
    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
588

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

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

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

603 604 605 606 607 608 609
        let sef_data = encode_frame(fi, &mut fs);
        self.packet_data.extend(sef_data);
        let data = self.packet_data.clone();
        self.packet_data.clear();
        if write_temporal_delimiter(&mut self.packet_data).is_err() {
          return Err(EncoderStatus::Failure);
        };
Luca Barbato's avatar
Luca Barbato committed
610

Luca Barbato's avatar
Luca Barbato committed
611 612 613 614 615 616 617 618 619 620
        let rec = if fi.show_frame { Some(fs.rec) } else { None };
        let mut psnr = None;
        if self.config.enc.show_psnr {
          if let Some(ref rec) = rec {
            psnr = Some(calculate_frame_psnr(
              &*fs.input,
              rec,
              fi.sequence.bit_depth
            ));
          }
621
        }
Luca Barbato's avatar
Luca Barbato committed
622

Luca Barbato's avatar
Luca Barbato committed
623 624 625 626 627 628 629 630 631 632 633
        self.frames_processed += 1;
        Ok(Packet {
          data,
          rec,
          number: fi.number,
          frame_type: fi.frame_type,
          psnr
        })
      } else {
        if let Some(f) = self.frame_q.get(&fi.number) {
          self.idx += 1;
fbossen's avatar
fbossen committed
634

Luca Barbato's avatar
Luca Barbato committed
635 636
          if let Some(frame) = f {
            let mut fs = FrameState::new_with_frame(fi, frame.clone());
fbossen's avatar
fbossen committed
637

Luca Barbato's avatar
Luca Barbato committed
638 639
            let data = encode_frame(fi, &mut fs);
            self.packet_data.extend(data);
fbossen's avatar
fbossen committed
640

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

Luca Barbato's avatar
Luca Barbato committed
643 644
            // 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
645

Luca Barbato's avatar
Luca Barbato committed
646
            update_rec_buffer(fi, fs);
fbossen's avatar
fbossen committed
647

Luca Barbato's avatar
Luca Barbato committed
648 649 650
            if fi.show_frame {
              let data = self.packet_data.clone();
              self.packet_data.clear();
651 652 653
              if write_temporal_delimiter(&mut self.packet_data).is_err() {
                return Err(EncoderStatus::Failure);
              }
654

Luca Barbato's avatar
Luca Barbato committed
655 656 657 658 659 660 661 662 663
              let mut psnr = None;
              if self.config.enc.show_psnr {
                if let Some(ref rec) = rec {
                  psnr = Some(calculate_frame_psnr(
                    &*frame,
                    rec,
                    fi.sequence.bit_depth
                  ));
                }
664 665
              }

Luca Barbato's avatar
Luca Barbato committed
666 667 668 669 670 671 672 673 674 675 676
              self.frames_processed += 1;
              Ok(Packet {
                data,
                rec,
                number: fi.number,
                frame_type: fi.frame_type,
                psnr
              })
            } else {
              Err(EncoderStatus::NeedMoreData)
            }
677 678 679
          } else {
            Err(EncoderStatus::NeedMoreData)
          }
fbossen's avatar
fbossen committed
680 681 682 683
        } else {
          Err(EncoderStatus::NeedMoreData)
        }
      }
684 685 686
    };

    if let Ok(ref pkt) = ret {
Luca Barbato's avatar
Luca Barbato committed
687
      self.garbage_collect(pkt.number);
688 689 690
    }

    ret
Luca Barbato's avatar
Luca Barbato committed
691 692
  }

693
  fn garbage_collect(&mut self, cur_frame: u64) {
Josh Holmer's avatar
Josh Holmer committed
694 695 696 697 698 699 700 701 702 703 704 705 706 707
    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
708
  pub fn flush(&mut self) {
fbossen's avatar
fbossen committed
709
    self.frame_q.insert(self.frame_count, None);
710
    self.frame_count += 1;
Luca Barbato's avatar
Luca Barbato committed
711
  }
Josh Holmer's avatar
Josh Holmer committed
712

Josh Holmer's avatar
Josh Holmer committed
713 714
  fn determine_frame_type(&mut self, frame_number: u64) -> FrameType {
    if frame_number == 0 {
Josh Holmer's avatar
Josh Holmer committed
715 716 717
      return FrameType::KEY;
    }

Josh Holmer's avatar
Josh Holmer committed
718 719 720 721 722 723 724 725
    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
726
    if let Some(frame) = frame {
Josh Holmer's avatar
Josh Holmer committed
727 728 729
      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
730 731
          // 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
732
          self.keyframe_detector.detect_scene_change(frame, frame_number as usize);
Josh Holmer's avatar
Josh Holmer committed
733 734 735
        }
        return FrameType::INTER;
      }
Josh Holmer's avatar
Josh Holmer committed
736
      if distance >= self.config.enc.max_key_frame_interval {
Josh Holmer's avatar
Josh Holmer committed
737 738
        return FrameType::KEY;
      }
Josh Holmer's avatar
Josh Holmer committed
739
      if self.keyframe_detector.detect_scene_change(frame, frame_number as usize) {
Josh Holmer's avatar
Josh Holmer committed
740 741 742 743 744
        return FrameType::KEY;
      }
    }
    FrameType::INTER
  }
Luca Barbato's avatar
Luca Barbato committed
745
}