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

proteus_lib/container/play_settings/
mod.rs
