proteus_lib/container/play_settings/
mod.rs

1//! Serde models for `play_settings.json` with versioned decoding.
2
3use log::{info, warn};
4use serde::{Deserialize, Deserializer, Serialize, Serializer};
5
6use crate::dsp::effects::AudioEffect;
7#[allow(deprecated)]
8#[deprecated(note = "Use DelayReverbSettings instead.")]
9pub use crate::dsp::effects::BasicReverbSettings;
10pub use crate::dsp::effects::{
11    CompressorSettings, ConvolutionReverbSettings, DelayReverbSettings, DistortionSettings,
12    HighPassFilterSettings, LimiterSettings, LowPassFilterSettings,
13};
14
15pub mod legacy;
16pub mod v1;
17pub mod v2;
18pub mod v3;
19
20pub use legacy::{PlaySettingsLegacy, PlaySettingsLegacyFile, PlaySettingsTrackLegacy};
21pub use v1::{PlaySettingsV1, PlaySettingsV1File};
22pub use v2::{PlaySettingsV2, PlaySettingsV2File};
23pub use v3::{PlaySettingsV3, PlaySettingsV3File};
24
25/// Effect settings variants that can appear in the settings file.
26pub type EffectSettings = AudioEffect;
27
28/// Track-level configuration shared by newer settings versions.
29#[derive(Debug, Clone, Serialize, Deserialize)]
30pub struct SettingsTrack {
31    pub level: f32,
32    pub pan: f32,
33    pub ids: Vec<u32>,
34    pub name: String,
35    pub safe_name: String,
36    #[serde(default = "default_selections_count")]
37    pub selections_count: u32,
38}
39
40fn default_selections_count() -> u32 {
41    1
42}
43
44/// Wrapper allowing `play_settings` to be nested or flat.
45#[derive(Debug, Clone, Serialize, Deserialize)]
46#[serde(untagged)]
47pub enum PlaySettingsContainer<T> {
48    Nested { play_settings: T },
49    Flat(T),
50}
51
52impl<T> PlaySettingsContainer<T> {
53    /// Return the inner settings payload, regardless of nesting.
54    pub fn inner(&self) -> &T {
55        match self {
56            PlaySettingsContainer::Nested { play_settings } => play_settings,
57            PlaySettingsContainer::Flat(inner) => inner,
58        }
59    }
60}
61
62/// Versioned settings file representation.
63#[derive(Debug, Clone)]
64pub enum PlaySettingsFile {
65    Legacy(PlaySettingsLegacyFile),
66    V1(PlaySettingsV1File),
67    V2(PlaySettingsV2File),
68    V3(PlaySettingsV3File),
69    Unknown {
70        encoder_version: Option<String>,
71        raw: serde_json::Value,
72    },
73}
74
75impl PlaySettingsFile {
76    /// Get the encoder version string, if known.
77    pub fn encoder_version(&self) -> Option<&str> {
78        match self {
79            PlaySettingsFile::Legacy(_) => None,
80            PlaySettingsFile::V1(_) => Some("1"),
81            PlaySettingsFile::V2(_) => Some("2"),
82            PlaySettingsFile::V3(_) => Some("3"),
83            PlaySettingsFile::Unknown {
84                encoder_version, ..
85            } => encoder_version.as_deref(),
86        }
87    }
88}
89
90impl<'de> Deserialize<'de> for PlaySettingsFile {
91    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
92    where
93        D: Deserializer<'de>,
94    {
95        let value = serde_json::Value::deserialize(deserializer)?;
96        let encoder_version = value.get("encoder_version").and_then(|raw| match raw {
97            serde_json::Value::String(version) => Some(version.clone()),
98            serde_json::Value::Number(number) => number
99                .as_f64()
100                .map(|val| {
101                    if (val - 1.0).abs() < f64::EPSILON {
102                        "1".to_string()
103                    } else if (val - 2.0).abs() < f64::EPSILON {
104                        "2".to_string()
105                    } else if (val - 3.0).abs() < f64::EPSILON {
106                        "3".to_string()
107                    } else {
108                        number.to_string()
109                    }
110                })
111                .or_else(|| Some(number.to_string())),
112            _ => None,
113        });
114
115        info!("Encoder version: {:?}", encoder_version);
116
117        let parsed = match encoder_version.as_deref() {
118            None => serde_json::from_value::<PlaySettingsLegacyFile>(value.clone())
119                .map(PlaySettingsFile::Legacy),
120            Some("1") => serde_json::from_value::<PlaySettingsV1File>(value.clone())
121                .map(PlaySettingsFile::V1),
122            Some("2") => serde_json::from_value::<PlaySettingsV2File>(value.clone())
123                .map(PlaySettingsFile::V2),
124            Some("3") => serde_json::from_value::<PlaySettingsV3File>(value.clone())
125                .map(PlaySettingsFile::V3),
126            Some(version) => {
127                warn!("Unknown encoder version: {:?}", version);
128                return Ok(PlaySettingsFile::Unknown {
129                    encoder_version,
130                    raw: value,
131                });
132            }
133        };
134
135        parsed.or_else(|_| {
136            Ok(PlaySettingsFile::Unknown {
137                encoder_version,
138                raw: value,
139            })
140        })
141    }
142}
143
144impl Serialize for PlaySettingsFile {
145    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
146    where
147        S: Serializer,
148    {
149        fn with_version<T, S>(payload: &T, version: &str, serializer: S) -> Result<S::Ok, S::Error>
150        where
151            T: Serialize,
152            S: Serializer,
153        {
154            let mut value = serde_json::to_value(payload).map_err(serde::ser::Error::custom)?;
155            match value {
156                serde_json::Value::Object(ref mut map) => {
157                    map.insert(
158                        "encoder_version".to_string(),
159                        serde_json::Value::String(version.to_string()),
160                    );
161                }
162                other => {
163                    let mut map = serde_json::Map::new();
164                    map.insert(
165                        "encoder_version".to_string(),
166                        serde_json::Value::String(version.to_string()),
167                    );
168                    map.insert("play_settings".to_string(), other);
169                    value = serde_json::Value::Object(map);
170                }
171            }
172            value.serialize(serializer)
173        }
174
175        match self {
176            PlaySettingsFile::Legacy(file) => file.serialize(serializer),
177            PlaySettingsFile::V1(file) => with_version(file, "1", serializer),
178            PlaySettingsFile::V2(file) => with_version(file, "2", serializer),
179            PlaySettingsFile::V3(file) => with_version(file, "3", serializer),
180            PlaySettingsFile::Unknown { raw, .. } => raw.serialize(serializer),
181        }
182    }
183}
proteus_lib/container/play_settings/mod.rs

proteus_lib/container/play_settings/
mod.rs
