Make sure Config can be instantiated only through new()

In preparation of the rate control API update.

Add Config::new(), Config::with_encoder_config() and Config::with_threads().

Author: lu-zero

src/api/config/mod.rs

@@ -96,6 +96,34 @@ pub struct Config {
   pub enc: EncoderConfig,
   /// The number of threads in the threadpool.
   pub threads: usize,
+  _guard: (),
+}
+
+impl Config {
+  /// Create a default configuration
+  ///
+  /// same as Default::default()
+  pub fn new() -> Self {
+    Config::default()
+  }
+
+  /// Set the encoder configuration
+  ///
+  /// EncoderConfig contains the settings impacting the
+  /// codec features used in the produced bitstream.
+  pub fn with_encoder_config(mut self, enc: EncoderConfig) -> Self {
+    self.enc = enc;
+    self
+  }
+
+  /// Set the number of workers in the threadpool
+  ///
+  /// The threadpool is shared across all the different parallel
+  /// components in the encoder.
+  pub fn with_threads(mut self, threads: usize) -> Self {
+    self.threads = threads;
+    self
+  }
 }
 
 fn check_tile_log2(n: usize) -> bool {

src/api/test.rs

@@ -35,7 +35,7 @@ fn setup_encoder<T: Pixel>(
   enc.speed_settings.no_scene_detection = no_scene_detection;
   enc.rdo_lookahead_frames = rdo_lookahead_frames;
 
-  let cfg = Config { enc, threads: 0 };
+  let cfg = Config::new().with_encoder_config(enc).with_threads(1);
 
   cfg.new_context().unwrap()
 }
@@ -1724,60 +1724,58 @@ fn rdo_lookahead_frames_overflow() {
 
 #[test]
 fn log_q_exp_overflow() {
-  let config = Config {
-    enc: EncoderConfig {
-      width: 16,
-      height: 16,
-      bit_depth: 8,
-      chroma_sampling: ChromaSampling::Cs420,
-      chroma_sample_position: ChromaSamplePosition::Unknown,
-      pixel_range: PixelRange::Limited,
-      color_description: None,
-      mastering_display: None,
-      content_light: None,
-      enable_timing_info: false,
-      still_picture: false,
-      error_resilient: false,
-      switch_frame_interval: 0,
-      time_base: Rational { num: 1, den: 25 },
-      min_key_frame_interval: 12,
-      max_key_frame_interval: 240,
-      reservoir_frame_delay: None,
-      low_latency: false,
-      quantizer: 100,
-      min_quantizer: 64,
-      bitrate: 1,
-      tune: Tune::Psychovisual,
-      tile_cols: 0,
-      tile_rows: 0,
-      tiles: 0,
-      rdo_lookahead_frames: 40,
-      speed_settings: SpeedSettings {
-        partition_range: PartitionRange::new(
-          BlockSize::BLOCK_64X64,
-          BlockSize::BLOCK_64X64,
-        ),
-        multiref: false,
-        fast_deblock: true,
-        reduced_tx_set: true,
-        tx_domain_distortion: true,
-        tx_domain_rate: false,
-        encode_bottomup: false,
-        rdo_tx_decision: false,
-        prediction_modes: PredictionModesSetting::Simple,
-        include_near_mvs: false,
-        no_scene_detection: true,
-        fast_scene_detection: false,
-        diamond_me: true,
-        cdef: true,
-        lrf: true,
-        use_satd_subpel: false,
-        non_square_partition: false,
-        ..Default::default()
-      },
+  let enc = EncoderConfig {
+    width: 16,
+    height: 16,
+    bit_depth: 8,
+    chroma_sampling: ChromaSampling::Cs420,
+    chroma_sample_position: ChromaSamplePosition::Unknown,
+    pixel_range: PixelRange::Limited,
+    color_description: None,
+    mastering_display: None,
+    content_light: None,
+    enable_timing_info: false,
+    still_picture: false,
+    error_resilient: false,
+    switch_frame_interval: 0,
+    time_base: Rational { num: 1, den: 25 },
+    min_key_frame_interval: 12,
+    max_key_frame_interval: 240,
+    reservoir_frame_delay: None,
+    low_latency: false,
+    quantizer: 100,
+    min_quantizer: 64,
+    bitrate: 1,
+    tune: Tune::Psychovisual,
+    tile_cols: 0,
+    tile_rows: 0,
+    tiles: 0,
+    rdo_lookahead_frames: 40,
+    speed_settings: SpeedSettings {
+      partition_range: PartitionRange::new(
+        BlockSize::BLOCK_64X64,
+        BlockSize::BLOCK_64X64,
+      ),
+      multiref: false,
+      fast_deblock: true,
+      reduced_tx_set: true,
+      tx_domain_distortion: true,
+      tx_domain_rate: false,
+      encode_bottomup: false,
+      rdo_tx_decision: false,
+      prediction_modes: PredictionModesSetting::Simple,
+      include_near_mvs: false,
+      no_scene_detection: true,
+      fast_scene_detection: false,
+      diamond_me: true,
+      cdef: true,
+      lrf: true,
+      use_satd_subpel: false,
+      non_square_partition: false,
+      ..Default::default()
     },
-    threads: 1,
   };
+  let config = Config::new().with_encoder_config(enc).with_threads(1);
 
   let mut ctx: Context<u8> = config.new_context().unwrap();
   for _ in 0..2 {
@@ -1791,60 +1789,58 @@ fn log_q_exp_overflow() {
 
 #[test]
 fn guess_frame_subtypes_assert() {
-  let config = Config {
-    enc: EncoderConfig {
-      width: 16,
-      height: 16,
-      bit_depth: 8,
-      chroma_sampling: ChromaSampling::Cs420,
-      chroma_sample_position: ChromaSamplePosition::Unknown,
-      pixel_range: PixelRange::Limited,
-      color_description: None,
-      mastering_display: None,
-      content_light: None,
-      enable_timing_info: false,
-      still_picture: false,
-      error_resilient: false,
-      switch_frame_interval: 0,
-      time_base: Rational { num: 1, den: 25 },
-      min_key_frame_interval: 0,
-      max_key_frame_interval: 1,
-      reservoir_frame_delay: None,
-      low_latency: false,
-      quantizer: 100,
-      min_quantizer: 0,
-      bitrate: 16384,
-      tune: Tune::Psychovisual,
-      tile_cols: 0,
-      tile_rows: 0,
-      tiles: 0,
-      rdo_lookahead_frames: 40,
-      speed_settings: SpeedSettings {
-        partition_range: PartitionRange::new(
-          BlockSize::BLOCK_64X64,
-          BlockSize::BLOCK_64X64,
-        ),
-        multiref: false,
-        fast_deblock: true,
-        reduced_tx_set: true,
-        tx_domain_distortion: true,
-        tx_domain_rate: false,
-        encode_bottomup: false,
-        rdo_tx_decision: false,
-        prediction_modes: PredictionModesSetting::Simple,
-        include_near_mvs: false,
-        no_scene_detection: true,
-        fast_scene_detection: false,
-        diamond_me: true,
-        cdef: true,
-        lrf: true,
-        use_satd_subpel: false,
-        non_square_partition: false,
-        ..Default::default()
-      },
+  let enc = EncoderConfig {
+    width: 16,
+    height: 16,
+    bit_depth: 8,
+    chroma_sampling: ChromaSampling::Cs420,
+    chroma_sample_position: ChromaSamplePosition::Unknown,
+    pixel_range: PixelRange::Limited,
+    color_description: None,
+    mastering_display: None,
+    content_light: None,
+    enable_timing_info: false,
+    still_picture: false,
+    error_resilient: false,
+    switch_frame_interval: 0,
+    time_base: Rational { num: 1, den: 25 },
+    min_key_frame_interval: 0,
+    max_key_frame_interval: 1,
+    reservoir_frame_delay: None,
+    low_latency: false,
+    quantizer: 100,
+    min_quantizer: 0,
+    bitrate: 16384,
+    tune: Tune::Psychovisual,
+    tile_cols: 0,
+    tile_rows: 0,
+    tiles: 0,
+    rdo_lookahead_frames: 40,
+    speed_settings: SpeedSettings {
+      partition_range: PartitionRange::new(
+        BlockSize::BLOCK_64X64,
+        BlockSize::BLOCK_64X64,
+      ),
+      multiref: false,
+      fast_deblock: true,
+      reduced_tx_set: true,
+      tx_domain_distortion: true,
+      tx_domain_rate: false,
+      encode_bottomup: false,
+      rdo_tx_decision: false,
+      prediction_modes: PredictionModesSetting::Simple,
+      include_near_mvs: false,
+      no_scene_detection: true,
+      fast_scene_detection: false,
+      diamond_me: true,
+      cdef: true,
+      lrf: true,
+      use_satd_subpel: false,
+      non_square_partition: false,
+      ..Default::default()
     },
-    threads: 1,
   };
+  let config = Config::new().with_encoder_config(enc).with_threads(1);
 
   let mut ctx: Context<u8> = config.new_context().unwrap();
   ctx.send_frame(ctx.new_frame()).unwrap();

src/bin/rav1e.rs

@@ -398,7 +398,8 @@ fn run() -> Result<(), error::CliError> {
     cli.enc.time_base = video_info.time_base;
   }
 
-  let cfg = Config { enc: cli.enc, threads: cli.threads };
+  let cfg =
+    Config::new().with_encoder_config(cli.enc).with_threads(cli.threads);
 
   #[cfg(feature = "serialize")]
   {

src/capi.rs

@@ -349,7 +349,7 @@ pub unsafe extern fn rav1e_data_unref(data: *mut Data) {
 /// Create a RaConfig filled with default parameters.
 #[no_mangle]
 pub unsafe extern fn rav1e_config_default() -> *mut Config {
-  let cfg = rav1e::Config { enc: rav1e::EncoderConfig::default(), threads: 0 };
+  let cfg = rav1e::Config::default();
 
   let c = Box::new(Config { cfg });
 

src/test_encode_decode/mod.rs

@@ -192,7 +192,7 @@ fn setup_encoder<T: Pixel>(
   enc.tile_rows = 1 << tile_rows_log2;
   enc.still_picture = still_picture;
 
-  let cfg = Config { enc, threads: 0 };
+  let cfg = Config::new().with_encoder_config(enc);
 
   cfg.new_context().unwrap()
 }