gainlayer router implemented

reorganise package structure and update imports.

patch bump

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "vmr-http"
-version = "0.5.0"
+version = "0.6.0"
 description = "HTTP API for controlling Voicemeeter"
 readme = "README.md"
 authors = [{ name = "onyx-and-iris", email = "code@onyxandiris.online" }]

src/vmr_http/models/bus.py

@@ -2,12 +2,12 @@
 
 from typing import Optional
 
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
 
 
 class BusParams(BaseModel):
     """Parameters for a single bus."""
 
-    gain: Optional[float] = None
-    mute: Optional[bool] = None
-    mono: Optional[int] = None
+    gain: Optional[float] = Field(None, ge=-60.0, le=12.0, description='Gain value for the bus')
+    mute: Optional[bool] = Field(None, description='Mute status for the bus')
+    mono: Optional[int] = Field(None, description='Mono status for the bus')

src/vmr_http/models/eq.py

@@ -2,21 +2,21 @@
 
 from typing import Optional
 
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
 
 
 class EQParams(BaseModel):
     """Parameters for an equalizer."""
 
-    on: Optional[bool] = None
-    ab: Optional[bool] = None
+    on: Optional[bool] = Field(description='Whether the equalizer is enabled or not.')
+    ab: Optional[bool] = Field(description='Whether the equalizer is in mode A/B.')
 
 
 class EQChannelCellParams(BaseModel):
     """Parameters for an equalizer channel."""
 
-    on: Optional[bool] = None
-    type: Optional[int] = None
-    f: Optional[float] = None
-    gain: Optional[float] = None
-    q: Optional[float] = None
+    on: Optional[bool] = Field(description='Whether the equalizer channel is enabled or not.')
+    type: Optional[int] = Field(ge=0, le=6, description='Type of the equalizer channel.')
+    f: Optional[float] = Field(ge=20.0, le=20000.0, description='Frequency of the equalizer channel.')
+    gain: Optional[float] = Field(ge=-36.0, le=18.0, description='Gain of the equalizer channel.')
+    q: Optional[float] = Field(ge=0.3, le=100.0, description='Q factor of the equalizer channel.')

src/vmr_http/models/strip.py

@@ -2,53 +2,53 @@
 
 from typing import Optional
 
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
 
 
 class StripParams(BaseModel):
     """Parameters for a single strip."""
 
-    gain: Optional[float] = None
-    mute: Optional[bool] = None
-    mono: Optional[bool] = None
-    solo: Optional[bool] = None
-    A1: Optional[bool] = None
-    A2: Optional[bool] = None
-    A3: Optional[bool] = None
-    A4: Optional[bool] = None
-    A5: Optional[bool] = None
-    B1: Optional[bool] = None
-    B2: Optional[bool] = None
-    B3: Optional[bool] = None
+    gain: Optional[float] = Field(None, ge=-60.0, le=12.0, description='Gain value for the strip')
+    mute: Optional[bool] = Field(None, description='Mute status for the strip')
+    mono: Optional[bool] = Field(None, description='Mono status for the strip')
+    solo: Optional[bool] = Field(None, description='Solo status for the strip')
+    A1: Optional[bool] = Field(None, description='A1 output status for the strip')
+    A2: Optional[bool] = Field(None, description='A2 output status for the strip')
+    A3: Optional[bool] = Field(None, description='A3 output status for the strip')
+    A4: Optional[bool] = Field(None, description='A4 output status for the strip')
+    A5: Optional[bool] = Field(None, description='A5 output status for the strip')
+    B1: Optional[bool] = Field(None, description='B1 output status for the strip')
+    B2: Optional[bool] = Field(None, description='B2 output status for the strip')
+    B3: Optional[bool] = Field(None, description='B3 output status for the strip')
 
 
 class StripCompParams(BaseModel):
     """Parameters for the compressor of a strip."""
 
-    knob: Optional[float] = None
-    gainin: Optional[float] = None
-    ratio: Optional[float] = None
-    threshold: Optional[float] = None
-    attack: Optional[float] = None
-    release: Optional[float] = None
-    knee: Optional[float] = None
-    gainout: Optional[float] = None
-    makeup: Optional[bool] = None
+    knob: Optional[float] = Field(None, ge=0.0, le=10.0, description='Compressor knob value for the strip')
+    gainin: Optional[float] = Field(None, ge=-24.0, le=24.0, description='Compressor gain in value for the strip')
+    ratio: Optional[float] = Field(None, ge=1.0, le=8.0, description='Compressor ratio value for the strip')
+    threshold: Optional[float] = Field(None, ge=-40.0, le=-3.0, description='Compressor threshold value for the strip')
+    attack: Optional[float] = Field(None, ge=0.0, le=200.0, description='Compressor attack value for the strip')
+    release: Optional[float] = Field(None, ge=0.0, le=5000.0, description='Compressor release value for the strip')
+    knee: Optional[float] = Field(None, ge=0.0, le=1.0, description='Compressor knee value for the strip')
+    gainout: Optional[float] = Field(None, ge=-24.0, le=24.0, description='Compressor gain out value for the strip')
+    makeup: Optional[bool] = Field(None, description='Compressor makeup status for the strip')
 
 
 class StripGateParams(BaseModel):
     """Parameters for the gate of a strip."""
 
-    knob: Optional[float] = None
-    threshold: Optional[float] = None
-    damping: Optional[float] = None
-    bpsidechain: Optional[float] = None
-    attack: Optional[float] = None
-    hold: Optional[float] = None
-    release: Optional[float] = None
+    knob: Optional[float] = Field(None, ge=0.0, le=10.0, description='Gate knob value for the strip')
+    threshold: Optional[float] = Field(None, ge=-60.0, le=-10.0, description='Gate threshold value for the strip')
+    damping: Optional[float] = Field(None, ge=-60.0, le=-10.0, description='Gate damping value for the strip')
+    bpsidechain: Optional[float] = Field(None, ge=100.0, le=4000.0, description='Gate sidechain value for the strip')
+    attack: Optional[float] = Field(None, ge=0.0, le=1000.0, description='Gate attack value for the strip')
+    hold: Optional[float] = Field(None, ge=0.0, le=5000.0, description='Gate hold value for the strip')
+    release: Optional[float] = Field(None, ge=0.0, le=5000.0, description='Gate release value for the strip')
 
 
 class StripDenoiserParams(BaseModel):
     """Parameters for the denoiser of a strip."""
 
-    knob: Optional[float] = None
+    knob: Optional[float] = Field(None, ge=0.0, le=10.0, description='Denoiser knob value for the strip')

src/vmr_http/web/__init__.py

@@ -0,0 +1,5 @@
+"""API endpoints for controlling various Voicemeeter components."""
+
+from . import bus, strip
+
+__all__ = ['bus', 'strip']

src/vmr_http/web/bus/__init__.py

@@ -0,0 +1,5 @@
+"""module for bus-related endpoints, including the bus equalizer."""
+
+from .bus import router
+
+__all__ = ['router']

src/vmr_http/web/bus/bus.py

@@ -4,12 +4,13 @@ from fastapi import APIRouter, Depends
 
 from vmr_http.dependencies import get_voicemeeter_client
 from vmr_http.models.bus import BusParams
+from vmr_http.web import eq
 
-from . import busmode, eq
+from . import mode
 
 router = APIRouter()
-router.include_router(busmode.router, prefix='/mode', tags=['bus mode'])
-router.include_router(eq.create_router(parent_router_kind='bus'), prefix='/eq', tags=['bus eq'])
+router.include_router(mode.router, prefix='/mode', tags=['bus mode'])
+router.include_router(eq.create_router(eq_kind='bus'), prefix='/eq', tags=['bus eq'])
 
 
 @router.patch('', tags=['bus'])

src/vmr_http/web/eq.py

@@ -1,18 +1,20 @@
 """Module for equalizer related endpoints, supporting both strip and bus parents via a factory function."""
 
+from typing import Literal
+
 from fastapi import APIRouter, Depends
 
 from vmr_http.dependencies import get_voicemeeter_client
 from vmr_http.models.eq import EQChannelCellParams, EQParams
 
 
-def create_router(parent_router_kind: str) -> APIRouter:
-    """Create an APIRouter for equalizer endpoints, with the specified parent kind ('strip' or 'bus')."""
-    if parent_router_kind not in ('strip', 'bus'):
-        raise ValueError(f'Invalid router kind: {parent_router_kind}')
-    parent_attr = parent_router_kind
+def create_router(eq_kind: str) -> APIRouter:
+    """Create an APIRouter for equalizer endpoints, with the specified kind ('strip' or 'bus')."""
+    if eq_kind not in ('strip', 'bus'):
+        raise ValueError(f'Invalid router kind: {eq_kind}')
+    parent_attr: Literal['strip', 'bus'] = eq_kind
 
-    def get_parent(voicemeeter, index):
+    def target_cls(voicemeeter, index):
         return getattr(voicemeeter, parent_attr)[index]
 
     cell_router = APIRouter()
@@ -27,7 +29,7 @@ def create_router(parent_router_kind: str) -> APIRouter:
         voicemeeter=Depends(get_voicemeeter_client),
     ):
         """Update one or more parameters for the specified eq channel cell."""
-        cell = get_parent(voicemeeter, index).eq.channel[channel_index].cell[cell_index]
+        cell = target_cls(voicemeeter, index).eq.channel[channel_index].cell[cell_index]
         updated = {}
         for key, value in params.model_dump(exclude_unset=True).items():
             setattr(cell, key, value)
@@ -39,35 +41,35 @@ def create_router(parent_router_kind: str) -> APIRouter:
         index: int, channel_index: int, cell_index: int, voicemeeter=Depends(get_voicemeeter_client)
     ):
         """Get the current on status for the specified eq channel cell."""
-        return {'on': get_parent(voicemeeter, index).eq.channel[channel_index].cell[cell_index].on}
+        return {'on': target_cls(voicemeeter, index).eq.channel[channel_index].cell[cell_index].on}
 
     @cell_router.get('/type')
     async def get_eq_channel_cell_type(
         index: int, channel_index: int, cell_index: int, voicemeeter=Depends(get_voicemeeter_client)
     ):
         """Get the current type for the specified eq channel cell."""
-        return {'type': get_parent(voicemeeter, index).eq.channel[channel_index].cell[cell_index].type}
+        return {'type': target_cls(voicemeeter, index).eq.channel[channel_index].cell[cell_index].type}
 
     @cell_router.get('/f')
     async def get_eq_channel_cell_f(
         index: int, channel_index: int, cell_index: int, voicemeeter=Depends(get_voicemeeter_client)
     ):
         """Get the current f value for the specified eq channel cell."""
-        return {'f': get_parent(voicemeeter, index).eq.channel[channel_index].cell[cell_index].f}
+        return {'f': target_cls(voicemeeter, index).eq.channel[channel_index].cell[cell_index].f}
 
     @cell_router.get('/gain')
     async def get_eq_channel_cell_gain(
         index: int, channel_index: int, cell_index: int, voicemeeter=Depends(get_voicemeeter_client)
     ):
         """Get the current gain value for the specified eq channel cell."""
-        return {'gain': get_parent(voicemeeter, index).eq.channel[channel_index].cell[cell_index].gain}
+        return {'gain': target_cls(voicemeeter, index).eq.channel[channel_index].cell[cell_index].gain}
 
     @cell_router.get('/q')
     async def get_eq_channel_cell_q(
         index: int, channel_index: int, cell_index: int, voicemeeter=Depends(get_voicemeeter_client)
     ):
         """Get the current q value for the specified eq channel cell."""
-        return {'q': get_parent(voicemeeter, index).eq.channel[channel_index].cell[cell_index].q}
+        return {'q': target_cls(voicemeeter, index).eq.channel[channel_index].cell[cell_index].q}
 
     router = APIRouter()
     router.include_router(cell_router, prefix='/channel/{channel_index}/cell/{cell_index}')
@@ -76,7 +78,7 @@ def create_router(parent_router_kind: str) -> APIRouter:
     @router.put('')
     async def update_eq_params(index: int, params: EQParams, voicemeeter=Depends(get_voicemeeter_client)):
         """Update one or more equalizer parameters for the specified index."""
-        eq = get_parent(voicemeeter, index).eq
+        eq = target_cls(voicemeeter, index).eq
         updated = {}
         for key, value in params.model_dump(exclude_unset=True).items():
             setattr(eq, key, value)
@@ -86,11 +88,11 @@ def create_router(parent_router_kind: str) -> APIRouter:
     @router.get('/on')
     async def get_eq_on(index: int, voicemeeter=Depends(get_voicemeeter_client)):
         """Get the current equalizer on status for the specified index."""
-        return {'on': get_parent(voicemeeter, index).eq.on}
+        return {'on': target_cls(voicemeeter, index).eq.on}
 
     @router.get('/ab')
     async def get_eq_ab(index: int, voicemeeter=Depends(get_voicemeeter_client)):
         """Get the current equalizer A/B status for the specified index."""
-        return {'ab': get_parent(voicemeeter, index).eq.ab}
+        return {'ab': target_cls(voicemeeter, index).eq.ab}
 
     return router

src/vmr_http/web/strip/__init__.py

@@ -0,0 +1,5 @@
+"""module for strip-related endpoints, including the strip equalizer."""
+
+from .strip import router
+
+__all__ = ['router']

src/vmr_http/web/strip/gainlayer.py

@@ -0,0 +1,27 @@
+"""module for strip gain layer related endpoints."""
+
+from fastapi import APIRouter, Body, Depends
+
+from vmr_http.dependencies import get_voicemeeter_client
+
+router = APIRouter()
+
+
+@router.patch('')
+@router.put('')
+async def update_strip_comp_params(
+    index: int,
+    gainlayer_index: int,
+    level: float = Body(..., ge=-60.0, le=12.0, embed=True),
+    voicemeeter=Depends(get_voicemeeter_client),
+):
+    """Update one or more compressor parameters for the specified strip index."""
+    gainlayer = voicemeeter.strip[index].gainlayer[gainlayer_index]
+    gainlayer.gain = level
+    return {'gain_layer': {'level': gainlayer.gain}}
+
+
+@router.get('/level')
+async def get_strip_gain_layer_level(index: int, gainlayer_index: int, voicemeeter=Depends(get_voicemeeter_client)):
+    """Get the current gain layer level for the specified strip index."""
+    return {'gain_layer': {'level': voicemeeter.strip[index].gainlayer[gainlayer_index].gain}}

src/vmr_http/web/strip/strip.py

@@ -4,14 +4,16 @@ from fastapi import APIRouter, Depends
 
 from vmr_http.dependencies import get_voicemeeter_client
 from vmr_http.models.strip import StripParams
+from vmr_http.web import eq
 
-from . import eq, stripcomp, stripdenoiser, stripgate
+from . import comp, denoiser, gainlayer, gate
 
 router = APIRouter()
-router.include_router(stripcomp.router, prefix='/comp', tags=['strip comp'])
-router.include_router(stripgate.router, prefix='/gate', tags=['strip gate'])
-router.include_router(stripdenoiser.router, prefix='/denoiser', tags=['strip denoiser'])
-router.include_router(eq.create_router(parent_router_kind='strip'), prefix='/eq', tags=['strip eq'])
+router.include_router(gainlayer.router, prefix='/gainlayer/{gainlayer_index}', tags=['strip gainlayer'])
+router.include_router(comp.router, prefix='/comp', tags=['strip comp'])
+router.include_router(gate.router, prefix='/gate', tags=['strip gate'])
+router.include_router(denoiser.router, prefix='/denoiser', tags=['strip denoiser'])
+router.include_router(eq.create_router(eq_kind='strip'), prefix='/eq', tags=['strip eq'])
 
 
 @router.patch('', tags=['strip'])

uv.lock

@@ -1151,7 +1151,7 @@ wheels = [
 
 [[package]]
 name = "vmr-http"
-version = "0.5.0"
+version = "0.6.0"
 source = { editable = "." }
 dependencies = [
     { name = "fastapi" },