Add a progress callback

Author: lu-zero

src/api/config/mod.rs

@@ -25,6 +25,9 @@ pub use rate::{RateControlConfig, RateControlSummary};
 mod speedsettings;
 pub use speedsettings::*;
 
+mod progress;
+pub use progress::*;
+
 pub use crate::tiling::TilingInfo;
 
 /// Enumeration of possible invalid configuration errors.
@@ -131,6 +134,8 @@ pub struct Config {
   #[cfg(feature = "unstable")]
   /// Number of parallel encoding slots
   pub(crate) slots: usize,
+  /// Granular progress callback called when a macroblock is processed.
+  pub(crate) progress: Option<Arc<dyn GranularProgress>>,
 }
 
 impl Config {
@@ -185,6 +190,14 @@ impl Config {
     self.slots = slots;
     self
   }
+
+  /// Set a granular progress callback
+  pub fn with_granular_progress(
+    mut self, progress: Arc<dyn GranularProgress>,
+  ) -> Self {
+    self.progress = Some(progress);
+    self
+  }
 }
 
 fn check_tile_log2(n: usize) -> bool {

src/api/config/progress.rs

@@ -0,0 +1,27 @@
+// Copyright (c) 2020, 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.
+
+/// Information provided to the progress callback
+#[derive(Debug, Clone)]
+pub struct ProgressData {}
+
+/// Progress callback
+pub trait GranularProgress: std::fmt::Debug + Sync + Send {
+  /// Return if the encoding process should continue or not
+  fn progress(&self, info: &ProgressData) -> bool;
+}
+
+#[derive(Debug)]
+pub(crate) struct DefaultProgress {}
+
+impl GranularProgress for DefaultProgress {
+  fn progress(&self, _info: &ProgressData) -> bool {
+    true
+  }
+}