Make Config fully opaque

The fields are `pub(crate)` since the C-API setters would use them.

Author: lu-zero

examples/simple_encoding.rs

@@ -12,12 +12,14 @@ use rav1e::config::SpeedSettings;
 use rav1e::*;
 
 fn main() {
-  let mut cfg = Config::default();
+  let mut enc = EncoderConfig::default();
 
-  cfg.enc.width = 64;
-  cfg.enc.height = 96;
+  enc.width = 64;
+  enc.height = 96;
 
-  cfg.enc.speed_settings = SpeedSettings::from_preset(9);
+  enc.speed_settings = SpeedSettings::from_preset(9);
+
+  let cfg = Config::new().with_encoder_config(enc);
 
   let mut ctx: Context<u16> = cfg.new_context().unwrap();
 

src/api/config/mod.rs

@@ -93,10 +93,9 @@ pub enum InvalidConfig {
 #[derive(Clone, Debug, Default)]
 pub struct Config {
   /// Settings which impact the produced bitstream.
-  pub enc: EncoderConfig,
+  pub(crate) enc: EncoderConfig,
   /// The number of threads in the threadpool.
-  pub threads: usize,
-  _guard: (),
+  pub(crate) threads: usize,
 }
 
 impl Config {

src/api/context.rs

@@ -265,10 +265,11 @@ impl<T: Pixel> Context<T> {
   ///     Ok(())
   /// }
   /// # fn main() -> Result<(), Box<dyn std::error::Error>> {
-  /// #     let mut cfg = Config::default();
+  /// #     let mut enc = EncoderConfig::default();
   /// #     // So it runs faster.
-  /// #     cfg.enc.width = 16;
-  /// #     cfg.enc.height = 16;
+  /// #     enc.width = 16;
+  /// #     enc.height = 16;
+  /// #     let cfg = Config::new().with_encoder_config(enc);
   /// #     let mut ctx: Context<u8> = cfg.new_context()?;
   /// #
   /// #     let frames = vec![ctx.new_frame(); 4].into_iter();

src/api/test.rs

@@ -1662,62 +1662,70 @@ fn zero_frames() {
 
 #[test]
 fn tile_cols_overflow() {
-  let mut config = Config::default();
-  config.enc.tile_cols = usize::max_value();
+  let mut enc = EncoderConfig::default();
+  enc.tile_cols = usize::max_value();
+  let config = Config::new().with_encoder_config(enc);
   let _: Result<Context<u8>, _> = config.new_context();
 }
 
 #[test]
 fn max_key_frame_interval_overflow() {
-  let mut config = Config::default();
-  config.enc.max_key_frame_interval = i32::max_value() as u64;
-  config.enc.reservoir_frame_delay = None;
+  let mut enc = EncoderConfig::default();
+  enc.max_key_frame_interval = i32::max_value() as u64;
+  enc.reservoir_frame_delay = None;
+  let config = Config::new().with_encoder_config(enc);
   let _: Result<Context<u8>, _> = config.new_context();
 }
 
 #[test]
 fn target_bitrate_overflow() {
-  let mut config = Config::default();
-  config.enc.bitrate = i32::max_value();
-  config.enc.time_base = Rational::new(i64::max_value() as u64, 1);
+  let mut enc = EncoderConfig::default();
+  enc.bitrate = i32::max_value();
+  enc.time_base = Rational::new(i64::max_value() as u64, 1);
+  let config = Config::new().with_encoder_config(enc);
   let _: Result<Context<u8>, _> = config.new_context();
 }
 
 #[test]
 fn time_base_den_divide_by_zero() {
-  let mut config = Config::default();
-  config.enc.time_base = Rational::new(1, 0);
+  let mut enc = EncoderConfig::default();
+  enc.time_base = Rational::new(1, 0);
+  let config = Config::new().with_encoder_config(enc);
   let _: Result<Context<u8>, _> = config.new_context();
 }
 
 #[test]
 fn large_width_assert() {
-  let mut config = Config::default();
-  config.enc.width = u32::max_value() as usize;
+  let mut enc = EncoderConfig::default();
+  enc.width = u32::max_value() as usize;
+  let config = Config::new().with_encoder_config(enc);
   let _: Result<Context<u8>, _> = config.new_context();
 }
 
 #[test]
 fn reservoir_max_overflow() {
-  let mut config = Config::default();
-  config.enc.reservoir_frame_delay = Some(i32::max_value());
-  config.enc.bitrate = i32::max_value();
-  config.enc.time_base = Rational::new(i32::max_value() as u64 * 2, 1);
+  let mut enc = EncoderConfig::default();
+  enc.reservoir_frame_delay = Some(i32::max_value());
+  enc.bitrate = i32::max_value();
+  enc.time_base = Rational::new(i32::max_value() as u64 * 2, 1);
+  let config = Config::new().with_encoder_config(enc);
   let _: Result<Context<u8>, _> = config.new_context();
 }
 
 #[test]
 fn zero_width() {
-  let mut config = Config::default();
-  config.enc.width = 0;
+  let mut enc = EncoderConfig::default();
+  enc.width = 0;
+  let config = Config::new().with_encoder_config(enc);
   let res: Result<Context<u8>, _> = config.new_context();
   assert!(res.is_err());
 }
 
 #[test]
 fn rdo_lookahead_frames_overflow() {
-  let mut config = Config::default();
-  config.enc.rdo_lookahead_frames = usize::max_value();
+  let mut enc = EncoderConfig::default();
+  enc.rdo_lookahead_frames = usize::max_value();
+  let config = Config::new().with_encoder_config(enc);
   let res: Result<Context<u8>, _> = config.new_context();
   assert!(res.is_err());
 }

src/bin/rav1e.rs

@@ -406,7 +406,7 @@ fn run() -> Result<(), error::CliError> {
     if let Some(save_config) = cli.save_config {
       let mut out = File::create(save_config)
         .map_err(|e| e.context("Cannot create configuration file"))?;
-      let s = toml::to_string(&cfg.enc).unwrap();
+      let s = toml::to_string(&cli.enc).unwrap();
       out
         .write_all(s.as_bytes())
         .map_err(|e| e.context("Cannot write the configuration file"))?
@@ -429,7 +429,7 @@ fn run() -> Result<(), error::CliError> {
     video_info.chroma_sampling,
     video_info.bit_depth
   );
-  info!("Encoding settings: {}", cfg.enc);
+  info!("Encoding settings: {}", cli.enc);
 
   let progress = ProgressInfo::new(
     Rational { num: video_info.time_base.den, den: video_info.time_base.num },

src/lib.rs

@@ -195,7 +195,9 @@ mod header;
 
 use crate::encoder::*;
 
-pub use crate::api::{Config, Context, EncoderStatus, InvalidConfig, Packet};
+pub use crate::api::{
+  Config, Context, EncoderConfig, EncoderStatus, InvalidConfig, Packet,
+};
 pub use crate::frame::Frame;
 pub use crate::util::{CastFromPrimitive, Pixel, PixelType};