api.rs 16.2 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 20 21 22
use std::sync::Arc;

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

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

35 36
#[derive(Copy, Clone, Debug)]
pub struct EncoderConfig {
Josh Holmer's avatar
Josh Holmer committed
37 38 39 40
  /// The *minimum* interval between two keyframes
  pub min_key_frame_interval: u64,
  /// The *maximum* interval between two keyframes
  pub max_key_frame_interval: u64,
41
  pub low_latency: bool,
42
  pub quantizer: usize,
43
  pub tune: Tune,
44
  pub color_description: Option<ColorDescription>,
45
  pub speed_settings: SpeedSettings,
46
  pub show_psnr: bool,
47 48 49 50
}

impl Default for EncoderConfig {
  fn default() -> Self {
51 52
    const DEFAULT_SPEED: usize = 3;
    Self::with_speed_preset(DEFAULT_SPEED)
53 54 55
  }
}

56 57 58
impl EncoderConfig {
  pub fn with_speed_preset(speed: usize) -> Self {
    EncoderConfig {
Josh Holmer's avatar
Josh Holmer committed
59 60
      min_key_frame_interval: 12,
      max_key_frame_interval: 240,
61 62 63
      low_latency: true,
      quantizer: 100,
      tune: Tune::Psnr,
64
      color_description: None,
65 66
      speed_settings: SpeedSettings::from_preset(speed),
      show_psnr: false,
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 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
    }
  }
}

#[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 {
138
    if speed <= 1 {
139
      PredictionModesSetting::ComplexAll
140
    } else if speed <= 3 {
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
      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,
}

159 160
arg_enum!{
  #[derive(Debug, Clone, Copy, PartialEq)]
161
  #[repr(C)]
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
  pub enum MatrixCoefficients {
      Identity = 0,
      BT709,
      Unspecified,
      BT470M = 4,
      BT470BG,
      ST170M,
      ST240M,
      YCgCo,
      BT2020NonConstantLuminance,
      BT2020ConstantLuminance,
      ST2085,
      ChromaticityDerivedNonConstantLuminance,
      ChromaticityDerivedConstantLuminance,
      ICtCp,
  }
178 179 180 181 182 183 184 185
}

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

186 187
arg_enum!{
  #[derive(Debug,Clone,Copy,PartialEq)]
188
  #[repr(C)]
189 190 191 192 193 194 195 196 197 198 199 200 201 202
  pub enum ColorPrimaries {
      BT709 = 1,
      Unspecified,
      BT470M = 4,
      BT470BG,
      ST170M,
      ST240M,
      Film,
      BT2020,
      ST428,
      P3DCI,
      P3Display,
      Tech3213 = 22,
  }
203 204 205 206 207 208 209 210
}

impl Default for ColorPrimaries {
    fn default() -> Self {
        ColorPrimaries::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 230 231 232
  pub enum TransferCharacteristics {
      BT1886 = 1,
      Unspecified,
      BT470M = 4,
      BT470BG,
      ST170M,
      ST240M,
      Linear,
      Logarithmic100,
      Logarithmic316,
      XVYCC,
      BT1361E,
      SRGB,
      BT2020Ten,
      BT2020Twelve,
      PerceptualQuantizer,
      ST428,
      HybridLogGamma,
  }
233 234 235 236 237 238 239 240
}

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

241 242 243 244 245 246 247
#[derive(Copy, Clone, Debug)]
pub struct ColorDescription {
    pub color_primaries: ColorPrimaries,
    pub transfer_characteristics: TransferCharacteristics,
    pub matrix_coefficients: MatrixCoefficients
}

248
/// Frame-specific information
249
#[derive(Clone, Copy, Debug)]
250
pub struct FrameInfo {
Luca Barbato's avatar
Luca Barbato committed
251 252 253
  pub width: usize,
  pub height: usize,
  pub bit_depth: usize,
254
  pub chroma_sampling: ChromaSampling,
255
  pub chroma_sample_position: ChromaSamplePosition
256 257
}

258 259 260 261 262 263 264 265 266 267 268 269
impl Default for FrameInfo {
    fn default() -> FrameInfo {
        FrameInfo {
            width: 640,
            height: 480,
            bit_depth: 8,
            chroma_sampling: Default::default(),
            chroma_sample_position: Default::default()
        }
    }
}

270 271 272 273
/// Contain all the encoder configuration
#[derive(Clone, Copy, Debug)]
pub struct Config {
  pub frame_info: FrameInfo,
Luca Barbato's avatar
Luca Barbato committed
274
  pub timebase: Rational,
Luca Barbato's avatar
Luca Barbato committed
275 276 277 278
  pub enc: EncoderConfig
}

impl Config {
Luca Barbato's avatar
Luca Barbato committed
279 280
  pub fn parse(&mut self, key: &str, value: &str) -> Result<(), EncoderStatus> {
    match key {
281
      "low_latency" => self.enc.low_latency = value.parse().map_err(|_e| ParseError)?,
Josh Holmer's avatar
Josh Holmer committed
282 283
      "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)?,
284
      "quantizer" => self.enc.quantizer = value.parse().map_err(|_e| ParseError)?,
285
      "speed" => self.enc.speed_settings = SpeedSettings::from_preset(value.parse().map_err(|_e| ParseError)?),
286 287
      "tune" => self.enc.tune = value.parse().map_err(|_e| ParseError)?,
      _ => return Err(InvalidKey)
Luca Barbato's avatar
Luca Barbato committed
288 289 290 291 292
    }

    Ok(())
  }

Luca Barbato's avatar
Luca Barbato committed
293
  pub fn new_context(&self) -> Context {
294
    let seq = Sequence::new(&self.frame_info);
295 296 297
    let fi = FrameInvariants::new(
      self.frame_info.width,
      self.frame_info.height,
298 299
      self.enc,
      seq,
Luca Barbato's avatar
Luca Barbato committed
300 301
    );

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 312 313 314 315 316 317 318 319
    Context {
      fi,
      frame_count: 0,
      frames_to_be_coded: 0,
      idx: 0,
      frame_q: BTreeMap::new(),
      packet_data: Vec::new(),
      segment_start_idx: 0,
      segment_start_frame: 0,
      frame_types: BTreeMap::new(),
      keyframe_detector: SceneChangeDetector::new(&self.frame_info),
    }
Luca Barbato's avatar
Luca Barbato committed
320 321 322 323 324
  }
}

pub struct Context {
  fi: FrameInvariants,
Luca Barbato's avatar
Luca Barbato committed
325
  //    timebase: Rational,
fbossen's avatar
fbossen committed
326
  frame_count: u64,
327
  frames_to_be_coded: u64,
fbossen's avatar
fbossen committed
328
  idx: u64,
329
  frame_q: BTreeMap<u64, Option<Arc<Frame>>>, //    packet_q: VecDeque<Packet>
Josh Holmer's avatar
Josh Holmer committed
330 331 332 333 334
  packet_data: Vec<u8>,
  segment_start_idx: u64,
  segment_start_frame: u64,
  frame_types: BTreeMap<u64, FrameType>,
  keyframe_detector: SceneChangeDetector,
Luca Barbato's avatar
Luca Barbato committed
335 336 337 338 339 340 341 342 343
}

#[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
344 345 346
  Failure,
  InvalidKey,
  ParseError
Luca Barbato's avatar
Luca Barbato committed
347 348 349 350
}

pub struct Packet {
  pub data: Vec<u8>,
fbossen's avatar
fbossen committed
351 352
  pub rec: Option<Frame>,
  pub number: u64,
353 354 355
  pub frame_type: FrameType,
  /// PSNR for Y, U, and V planes
  pub psnr: Option<(f64, f64, f64)>,
356 357 358 359
}

impl fmt::Display for Packet {
  fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
Luca Barbato's avatar
Luca Barbato committed
360 361 362 363 364 365 366
    write!(
      f,
      "Frame {} - {} - {} bytes",
      self.number,
      self.frame_type,
      self.data.len()
    )
367
  }
Luca Barbato's avatar
Luca Barbato committed
368 369 370 371
}

impl Context {
  pub fn new_frame(&self) -> Arc<Frame> {
372
    Arc::new(Frame::new(self.fi.padded_w, self.fi.padded_h, self.fi.sequence.chroma_sampling))
Luca Barbato's avatar
Luca Barbato committed
373 374 375 376 377 378
  }

  pub fn send_frame<F>(&mut self, frame: F) -> Result<(), EncoderStatus>
  where
    F: Into<Option<Arc<Frame>>>
  {
Josh Holmer's avatar
Josh Holmer committed
379 380 381
    let idx = self.frame_count;
    self.frame_q.insert(idx, frame.into());
    self.save_frame_type(idx);
fbossen's avatar
fbossen committed
382
    self.frame_count = self.frame_count + 1;
Luca Barbato's avatar
Luca Barbato committed
383 384 385
    Ok(())
  }

386 387 388 389 390 391 392 393 394 395 396 397
  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;
  }

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

398 399 400
  pub fn container_sequence_header(&mut self) -> Vec<u8> {
    fn sequence_header_inner(seq: &Sequence) -> io::Result<Vec<u8>> {
      let mut buf = Vec::new();
401

402
      {
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
        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
420
      }
421

422 423 424
      Ok(buf)
    }

425
    sequence_header_inner(&self.fi.sequence).unwrap()
426 427
  }

Josh Holmer's avatar
Josh Holmer committed
428 429 430 431 432 433 434 435 436 437
  fn next_keyframe(&self) -> u64 {
    let next_detected = self.frame_types.iter()
      .find(|(&i, &ty)| ty == FrameType::KEY && i > self.segment_start_frame)
      .map(|(&i, _)| i);
    let next_limit = self.segment_start_frame + self.fi.config.max_key_frame_interval;
    if next_detected.is_none() {
      return next_limit;
    }
    cmp::min(next_detected.unwrap(), next_limit)
  }
fbossen's avatar
fbossen committed
438

Josh Holmer's avatar
Josh Holmer committed
439
  fn set_frame_properties(&mut self, idx: u64) -> Result<(), ()> {
Josh Holmer's avatar
Josh Holmer committed
440 441
    if idx == 0 {
      // The first frame will always be a key frame
Josh Holmer's avatar
Josh Holmer committed
442
      self.fi = FrameInvariants::new_key_frame(&self.fi,0);
Josh Holmer's avatar
Josh Holmer committed
443 444 445 446 447 448 449 450 451
      return Ok(());
    }

    // 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
452 453 454 455 456
      let next_keyframe = self.next_keyframe();
      let (fi, success) = FrameInvariants::new_inter_frame(&self.fi, self.segment_start_frame, idx_in_segment, next_keyframe);
      self.fi = fi;
      if !success {
        if !self.fi.inter_cfg.unwrap().reorder || ((idx_in_segment - 1) % self.fi.inter_cfg.unwrap().group_len == 0 && self.fi.number == (next_keyframe - 1)) {
Josh Holmer's avatar
Josh Holmer committed
457
          self.segment_start_idx = idx;
Josh Holmer's avatar
Josh Holmer committed
458 459
          self.segment_start_frame = next_keyframe;
          self.fi.number = next_keyframe;
Josh Holmer's avatar
Josh Holmer committed
460
        } else {
Josh Holmer's avatar
Josh Holmer committed
461
          return Err(());
Josh Holmer's avatar
Josh Holmer committed
462 463
        }
      }
fbossen's avatar
fbossen committed
464
    }
Luca Barbato's avatar
Luca Barbato committed
465

Josh Holmer's avatar
Josh Holmer committed
466 467 468 469 470 471 472 473 474 475 476
    // Now that we know the frame number, look up the correct frame type
    let frame_type = self.frame_types.get(&self.fi.number).cloned();
    if let Some(frame_type) = frame_type {
      if frame_type == FrameType::KEY {
        self.segment_start_idx = idx;
        self.segment_start_frame = self.fi.number;
      }
      self.fi.frame_type = frame_type;

      let idx_in_segment = idx - self.segment_start_idx;
      if idx_in_segment == 0 {
Josh Holmer's avatar
Josh Holmer committed
477
        self.fi = FrameInvariants::new_key_frame(&self.fi, self.segment_start_frame);
Josh Holmer's avatar
Josh Holmer committed
478
      } else {
Josh Holmer's avatar
Josh Holmer committed
479 480 481 482 483 484
        let next_keyframe = self.next_keyframe();
        let (fi, success) = FrameInvariants::new_inter_frame(&self.fi, self.segment_start_frame, idx_in_segment, next_keyframe);
        self.fi = fi;
        if !success {
          return Err(());
        }
Josh Holmer's avatar
Josh Holmer committed
485 486 487
      }
    }
    Ok(())
fbossen's avatar
fbossen committed
488
  }
Luca Barbato's avatar
Luca Barbato committed
489

fbossen's avatar
fbossen committed
490 491
  pub fn receive_packet(&mut self) -> Result<Packet, EncoderStatus> {
    let mut idx = self.idx;
Josh Holmer's avatar
Josh Holmer committed
492
    while self.set_frame_properties(idx).is_err() {
Josh Holmer's avatar
Josh Holmer committed
493
      self.idx += 1;
fbossen's avatar
fbossen committed
494 495
      idx = self.idx;
    }
Luca Barbato's avatar
Luca Barbato committed
496

497
    if !self.needs_more_frames(self.fi.number) {
Josh Holmer's avatar
Josh Holmer committed
498
      self.idx += 1;
499 500 501
      return Err(EncoderStatus::EnoughData)
    }

fbossen's avatar
fbossen committed
502
    if self.fi.show_existing_frame {
Josh Holmer's avatar
Josh Holmer committed
503
      self.idx += 1;
Luca Barbato's avatar
Luca Barbato committed
504

505
      let mut fs = FrameState::new(&self.fi);
fbossen's avatar
fbossen committed
506

507
      let data = encode_frame(&mut self.fi, &mut fs);
Luca Barbato's avatar
Luca Barbato committed
508

Romain Vimont's avatar
Romain Vimont committed
509
      let rec = if self.fi.show_frame { Some(fs.rec) } else { None };
510 511 512
      let mut psnr = None;
      if self.fi.config.show_psnr {
        if let Some(ref rec) = rec {
513
          psnr = Some(calculate_frame_psnr(&*fs.input, rec, self.fi.sequence.bit_depth));
514 515
        }
      }
Luca Barbato's avatar
Luca Barbato committed
516

517
      Ok(Packet { data, rec, number: self.fi.number, frame_type: self.fi.frame_type, psnr })
Luca Barbato's avatar
Luca Barbato committed
518
    } else {
fbossen's avatar
fbossen committed
519
      if let Some(f) = self.frame_q.remove(&self.fi.number) {
Josh Holmer's avatar
Josh Holmer committed
520
        self.idx += 1;
fbossen's avatar
fbossen committed
521 522

        if let Some(frame) = f {
523
          let mut fs = FrameState::new_with_frame(&self.fi, frame.clone());
fbossen's avatar
fbossen committed
524

525
          let data = encode_frame(&mut self.fi, &mut fs);
526
          self.packet_data.extend(data);
fbossen's avatar
fbossen committed
527

Frank Bossen's avatar
Frank Bossen committed
528
          fs.rec.pad(self.fi.width, self.fi.height);
fbossen's avatar
fbossen committed
529 530 531 532 533 534

          // TODO avoid the clone by having rec Arc.
          let rec = if self.fi.show_frame { Some(fs.rec.clone()) } else { None };

          update_rec_buffer(&mut self.fi, fs);

535 536 537
          if self.fi.show_frame {
            let data = self.packet_data.clone();
            self.packet_data = Vec::new();
538 539 540 541

            let mut psnr = None;
            if self.fi.config.show_psnr {
              if let Some(ref rec) = rec {
542
                psnr = Some(calculate_frame_psnr(&*frame, rec, self.fi.sequence.bit_depth));
543 544 545 546
              }
            }

            Ok(Packet { data, rec, number: self.fi.number, frame_type: self.fi.frame_type, psnr })
547 548 549
          } else {
            Err(EncoderStatus::NeedMoreData)
          }
fbossen's avatar
fbossen committed
550 551 552 553 554 555
        } else {
          Err(EncoderStatus::NeedMoreData)
        }
      } else {
        Err(EncoderStatus::NeedMoreData)
      }
Luca Barbato's avatar
Luca Barbato committed
556 557 558 559
    }
  }

  pub fn flush(&mut self) {
fbossen's avatar
fbossen committed
560 561
    self.frame_q.insert(self.frame_count, None);
    self.frame_count = self.frame_count + 1;
Luca Barbato's avatar
Luca Barbato committed
562
  }
Josh Holmer's avatar
Josh Holmer committed
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594

  fn save_frame_type(&mut self, idx: u64) {
    let frame_type = self.determine_frame_type(idx);
    self.frame_types.insert(idx, frame_type);
  }

  fn determine_frame_type(&mut self, idx: u64) -> FrameType {
    if idx == 0 {
      return FrameType::KEY;
    }

    let prev_keyframe = *self.frame_types.iter().rfind(|(_, &ty)| ty == FrameType::KEY).unwrap().0;
    let frame = self.frame_q.get(&idx).cloned().unwrap();
    if let Some(frame) = frame {
      let distance = idx - prev_keyframe;
      if distance < self.fi.config.min_key_frame_interval {
        if distance + 1 == self.fi.config.min_key_frame_interval {
          // 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.
          self.keyframe_detector.detect_scene_change(frame, idx as usize);
        }
        return FrameType::INTER;
      }
      if distance >= self.fi.config.max_key_frame_interval {
        return FrameType::KEY;
      }
      if self.keyframe_detector.detect_scene_change(frame, idx as usize) {
        return FrameType::KEY;
      }
    }
    FrameType::INTER
  }
Luca Barbato's avatar
Luca Barbato committed
595
}
Luca Barbato's avatar
Luca Barbato committed
596 597 598 599 600 601

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