Swap "buffer" verbiage to "overflow"

Author: SteveMicroNova

amplipi/ctrl.py

@@ -852,13 +852,13 @@ def set_vol():
           # Field precedence: vol (db) > vol_delta > vol (float)
           # NOTE: checks happen in reverse precedence to cover default case of unchanged volume
           if update.vol_delta_f is not None and update.vol is None:
-            true_vol_f = zone.vol_f + zone.vol_f_buffer
+            true_vol_f = zone.vol_f + zone.vol_f_overflow
             totaled_delta = update.vol_delta_f + true_vol_f
             applied_delta = utils.clamp(totaled_delta, 0, 1)
 
             vol_db = utils.vol_float_to_db(applied_delta, zone.vol_min, zone.vol_max)
             vol_f_new = applied_delta
-            zone.vol_f_buffer = 0 if models.MIN_VOL_F < totaled_delta and totaled_delta < models.MAX_VOL_F else utils.clamp((totaled_delta - applied_delta), -1.0, 1.0)
+            zone.vol_f_overflow = 0 if models.MIN_VOL_F < totaled_delta and totaled_delta < models.MAX_VOL_F else utils.clamp((totaled_delta - applied_delta), -1.0, 1.0)
 
           elif update.vol_f is not None and update.vol is None:
             clamp_vol_f = utils.clamp(vol_f, 0, 1)
@@ -875,7 +875,7 @@ def set_vol():
           else:
             raise Exception('unable to update zone volume')
 
-          zone.vol_f_buffer = 0 if models.MIN_VOL_F < vol_f_new and vol_f_new < models.MAX_VOL_F else zone.vol_f_buffer
+          zone.vol_f_overflow = 0 if models.MIN_VOL_F < vol_f_new and vol_f_new < models.MAX_VOL_F else zone.vol_f_overflow
 
         # To avoid potential unwanted loud output:
         # If muting, mute before setting volumes

amplipi/defaults.py

@@ -41,17 +41,17 @@
   ],
   "zones": [  # this is an array of zones, array length depends on # of boxes connected
     {"id": 0, "name": "Zone 1", "source_id": 0, "mute": True, "disabled": False,
-     "vol_f": models.MIN_VOL_F, "vol_f_buffer": 0.0, "vol_min": models.MIN_VOL_DB, "vol_max": models.MAX_VOL_DB},
+     "vol_f": models.MIN_VOL_F, "vol_f_overflow": 0.0, "vol_min": models.MIN_VOL_DB, "vol_max": models.MAX_VOL_DB},
     {"id": 1, "name": "Zone 2", "source_id": 0, "mute": True, "disabled": False,
-     "vol_f": models.MIN_VOL_F, "vol_f_buffer": 0.0, "vol_min": models.MIN_VOL_DB, "vol_max": models.MAX_VOL_DB},
+     "vol_f": models.MIN_VOL_F, "vol_f_overflow": 0.0, "vol_min": models.MIN_VOL_DB, "vol_max": models.MAX_VOL_DB},
     {"id": 2, "name": "Zone 3", "source_id": 0, "mute": True, "disabled": False,
-     "vol_f": models.MIN_VOL_F, "vol_f_buffer": 0.0, "vol_min": models.MIN_VOL_DB, "vol_max": models.MAX_VOL_DB},
+     "vol_f": models.MIN_VOL_F, "vol_f_overflow": 0.0, "vol_min": models.MIN_VOL_DB, "vol_max": models.MAX_VOL_DB},
     {"id": 3, "name": "Zone 4", "source_id": 0, "mute": True, "disabled": False,
-     "vol_f": models.MIN_VOL_F, "vol_f_buffer": 0.0, "vol_min": models.MIN_VOL_DB, "vol_max": models.MAX_VOL_DB},
+     "vol_f": models.MIN_VOL_F, "vol_f_overflow": 0.0, "vol_min": models.MIN_VOL_DB, "vol_max": models.MAX_VOL_DB},
     {"id": 4, "name": "Zone 5", "source_id": 0, "mute": True, "disabled": False,
-     "vol_f": models.MIN_VOL_F, "vol_f_buffer": 0.0, "vol_min": models.MIN_VOL_DB, "vol_max": models.MAX_VOL_DB},
+     "vol_f": models.MIN_VOL_F, "vol_f_overflow": 0.0, "vol_min": models.MIN_VOL_DB, "vol_max": models.MAX_VOL_DB},
     {"id": 5, "name": "Zone 6", "source_id": 0, "mute": True, "disabled": False,
-     "vol_f": models.MIN_VOL_F, "vol_f_buffer": 0.0, "vol_min": models.MIN_VOL_DB, "vol_max": models.MAX_VOL_DB},
+     "vol_f": models.MIN_VOL_F, "vol_f_overflow": 0.0, "vol_min": models.MIN_VOL_DB, "vol_max": models.MAX_VOL_DB},
   ],
   "groups": [
   ],

amplipi/models.py

@@ -111,8 +111,8 @@ class fields_w_default(SimpleNamespace):
   Volume = Field(default=MIN_VOL_DB, ge=MIN_VOL_DB, le=MAX_VOL_DB, description='Output volume in dB')
   VolumeF = Field(default=MIN_VOL_F, ge=MIN_VOL_F, le=MAX_VOL_F,
                   description='Output volume as a floating-point scalar from 0.0 to 1.0 representing MIN_VOL_DB to MAX_VOL_DB')
-  VolumeFBuffer = Field(default=0.0, ge=(MIN_VOL_F - MAX_VOL_F), le=(MAX_VOL_F - MIN_VOL_F),
-                        description='Output volume as a floating-point scalar that has a range equal to MIN_VOL_F - MAX_VOL_F in both directions from zero, and is used to keep track of the relative distance between two or more zone volumes when they would otherwise have to exceed their VOL_F range')
+  VolumeFOverflow = Field(default=0.0, ge=(MIN_VOL_F - MAX_VOL_F), le=(MAX_VOL_F - MIN_VOL_F),
+                          description='Output volume as a floating-point scalar that has a range equal to MIN_VOL_F - MAX_VOL_F in both directions from zero, and is used to keep track of the relative distance between two or more zone volumes when they would otherwise have to exceed their VOL_F range')
   VolumeMin = Field(default=MIN_VOL_DB, ge=MIN_VOL_DB, le=MAX_VOL_DB,
                     description='Min output volume in dB')
   VolumeMax = Field(default=MAX_VOL_DB, ge=MIN_VOL_DB, le=MAX_VOL_DB,
@@ -323,7 +323,7 @@ class Zone(Base):
   mute: bool = fields_w_default.Mute
   vol: int = fields_w_default.Volume
   vol_f: float = fields_w_default.VolumeF
-  vol_f_buffer: float = fields_w_default.VolumeFBuffer
+  vol_f_overflow: float = fields_w_default.VolumeFOverflow
   vol_min: int = fields_w_default.VolumeMin
   vol_max: int = fields_w_default.VolumeMax
   disabled: bool = fields_w_default.Disabled

web/src/App.jsx

@@ -50,11 +50,11 @@ export const useStatusStore = create((set, get) => ({
                 applyPlayerVol(vol, zones, sourceId, (zone_id, new_vol) => {
                     for (const i in s.status.zones) {
                         if (s.status.zones[i].id === zone_id) {
-                            let true_vol = Math.round((new_vol + s.status.zones[i].vol_f_buffer) * 100) / 100;
+                            let true_vol = Math.round((new_vol + s.status.zones[i].vol_f_overflow) * 100) / 100;
                             let clamped = Math.min(Math.max(true_vol, 0), 1);
 
                             s.status.zones[i].vol_f = clamped;
-                            s.status.zones[i].vol_f_buffer = true_vol - clamped;
+                            s.status.zones[i].vol_f_overflow = true_vol - clamped;
                         }
                     }
                 });
@@ -174,7 +174,7 @@ export const useStatusStore = create((set, get) => ({
                 const g = s.status.groups.filter((g) => g.id === groupId)[0];
                 for (const i of g.zones) {
                     s.skipUpdate = true;
-                    s.status.zones[i].vol_f = new_vol + s.status.zones[i].vol_f_buffer;
+                    s.status.zones[i].vol_f = new_vol + s.status.zones[i].vol_f_overflow;
                 }
 
                 updateGroupVols(s);
@@ -208,7 +208,7 @@ export const useStatusStore = create((set, get) => ({
 const updateGroupVols = (s) => {
     s.status.groups.forEach((g) => {
         if (g.zones.length > 1) {
-            const vols = g.zones.map((id) => s.status.zones[id].vol_f + s.status.zones[id].vol_f_buffer);
+            const vols = g.zones.map((id) => s.status.zones[id].vol_f + s.status.zones[id].vol_f_overflow);
             let calculated_vol = Math.min(...vols) * 0.5 + Math.max(...vols) * 0.5;
             g.vol_f = calculated_vol;
         } else if (g.zones.length == 1) {

web/src/components/CardVolumeSlider/CardVolumeSlider.jsx

@@ -11,7 +11,7 @@ const getPlayerVol = (sourceId, zones) => {
     let n = 0;
     for (const i of getSourceZones(sourceId, zones)) {
         n += 1;
-        vol += i.vol_f + i.vol_f_buffer; // Add buffer to retain proper relative space when doing an action that would un-overload the slider
+        vol += i.vol_f + i.vol_f_overflow; // Add buffer to retain proper relative space when doing an action that would un-overload the slider
     }
 
     const avg = vol / n;

web/src/components/GroupVolumeSlider/GroupVolumeSlider.jsx

@@ -22,10 +22,10 @@ const GroupVolumeSlider = ({ groupId, sourceId, groupsLeft }) => {
     const setGroupMute = useStatusStore(s => s.setGroupMute);
     const [slidersOpen, setSlidersOpen] = React.useState(false);
 
-    const getVolume = () => { // Make sure group sliders account for vol_f_buffer
+    const getVolume = () => { // Make sure group sliders account for vol_f_overflow
         let v = 0;
         for(let i = 0; i < group.zones.length; i++){
-            v += (zones[group.zones[i]].vol_f + zones[group.zones[i]].vol_f_buffer);
+            v += (zones[group.zones[i]].vol_f + zones[group.zones[i]].vol_f_overflow);
         }
 
         return v / group.zones.length;