bauiv1lib.settings.audio

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""Provides audio settings UI."""
  4
  5from __future__ import annotations
  6
  7from typing import TYPE_CHECKING
  8import logging
  9
 10import bauiv1 as bui
 11
 12if TYPE_CHECKING:
 13    pass
 14
 15
 16class AudioSettingsWindow(bui.Window):
 17    """Window for editing audio settings."""
 18
 19    def __init__(
 20        self,
 21        transition: str = 'in_right',
 22        origin_widget: bui.Widget | None = None,
 23    ):
 24        # pylint: disable=too-many-statements
 25        # pylint: disable=too-many-locals
 26        # pylint: disable=cyclic-import
 27        from bauiv1lib.popup import PopupMenu
 28        from bauiv1lib.config import ConfigNumberEdit
 29
 30        assert bui.app.classic is not None
 31        music = bui.app.classic.music
 32
 33        # If they provided an origin-widget, scale up from that.
 34        scale_origin: tuple[float, float] | None
 35        if origin_widget is not None:
 36            self._transition_out = 'out_scale'
 37            scale_origin = origin_widget.get_screen_space_center()
 38            transition = 'in_scale'
 39        else:
 40            self._transition_out = 'out_right'
 41            scale_origin = None
 42
 43        self._r = 'audioSettingsWindow'
 44
 45        spacing = 50.0
 46        width = 460.0
 47        height = 210.0
 48
 49        # Update: hard-coding head-relative audio to true now,
 50        # so not showing options.
 51        # show_vr_head_relative_audio = True if bui.app.vr_mode else False
 52        show_vr_head_relative_audio = False
 53
 54        if show_vr_head_relative_audio:
 55            height += 70
 56
 57        show_soundtracks = False
 58        if music.have_music_player():
 59            show_soundtracks = True
 60            height += spacing * 2.0
 61
 62        uiscale = bui.app.ui_v1.uiscale
 63        base_scale = (
 64            2.05
 65            if uiscale is bui.UIScale.SMALL
 66            else 1.6 if uiscale is bui.UIScale.MEDIUM else 1.0
 67        )
 68        popup_menu_scale = base_scale * 1.2
 69
 70        super().__init__(
 71            root_widget=bui.containerwidget(
 72                size=(width, height),
 73                transition=transition,
 74                scale=base_scale,
 75                scale_origin_stack_offset=scale_origin,
 76                stack_offset=(
 77                    (0, -20) if uiscale is bui.UIScale.SMALL else (0, 0)
 78                ),
 79            )
 80        )
 81
 82        self._back_button = back_button = btn = bui.buttonwidget(
 83            parent=self._root_widget,
 84            position=(35, height - 55),
 85            size=(120, 60),
 86            scale=0.8,
 87            text_scale=1.2,
 88            label=bui.Lstr(resource='backText'),
 89            button_type='back',
 90            on_activate_call=self._back,
 91            autoselect=True,
 92        )
 93        bui.containerwidget(edit=self._root_widget, cancel_button=btn)
 94        v = height - 60
 95        v -= spacing * 1.0
 96        bui.textwidget(
 97            parent=self._root_widget,
 98            position=(width * 0.5, height - 32),
 99            size=(0, 0),
100            text=bui.Lstr(resource=self._r + '.titleText'),
101            color=bui.app.ui_v1.title_color,
102            maxwidth=180,
103            h_align='center',
104            v_align='center',
105        )
106
107        bui.buttonwidget(
108            edit=self._back_button,
109            button_type='backSmall',
110            size=(60, 60),
111            label=bui.charstr(bui.SpecialChar.BACK),
112        )
113
114        self._sound_volume_numedit = svne = ConfigNumberEdit(
115            parent=self._root_widget,
116            position=(40, v),
117            xoffset=10,
118            configkey='Sound Volume',
119            displayname=bui.Lstr(resource=self._r + '.soundVolumeText'),
120            minval=0.0,
121            maxval=1.0,
122            increment=0.05,
123            as_percent=True,
124        )
125        if bui.app.ui_v1.use_toolbars:
126            bui.widget(
127                edit=svne.plusbutton,
128                right_widget=bui.get_special_widget('party_button'),
129            )
130        v -= spacing
131        self._music_volume_numedit = ConfigNumberEdit(
132            parent=self._root_widget,
133            position=(40, v),
134            xoffset=10,
135            configkey='Music Volume',
136            displayname=bui.Lstr(resource=self._r + '.musicVolumeText'),
137            minval=0.0,
138            maxval=1.0,
139            increment=0.05,
140            callback=music.music_volume_changed,
141            changesound=False,
142            as_percent=True,
143        )
144
145        v -= 0.5 * spacing
146
147        self._vr_head_relative_audio_button: bui.Widget | None
148        if show_vr_head_relative_audio:
149            v -= 40
150            bui.textwidget(
151                parent=self._root_widget,
152                position=(40, v + 24),
153                size=(0, 0),
154                text=bui.Lstr(resource=self._r + '.headRelativeVRAudioText'),
155                color=(0.8, 0.8, 0.8),
156                maxwidth=230,
157                h_align='left',
158                v_align='center',
159            )
160
161            popup = PopupMenu(
162                parent=self._root_widget,
163                position=(290, v),
164                width=120,
165                button_size=(135, 50),
166                scale=popup_menu_scale,
167                choices=['Auto', 'On', 'Off'],
168                choices_display=[
169                    bui.Lstr(resource='autoText'),
170                    bui.Lstr(resource='onText'),
171                    bui.Lstr(resource='offText'),
172                ],
173                current_choice=bui.app.config.resolve('VR Head Relative Audio'),
174                on_value_change_call=self._set_vr_head_relative_audio,
175            )
176            self._vr_head_relative_audio_button = popup.get_button()
177            bui.textwidget(
178                parent=self._root_widget,
179                position=(width * 0.5, v - 11),
180                size=(0, 0),
181                text=bui.Lstr(
182                    resource=self._r + '.headRelativeVRAudioInfoText'
183                ),
184                scale=0.5,
185                color=(0.7, 0.8, 0.7),
186                maxwidth=400,
187                flatness=1.0,
188                h_align='center',
189                v_align='center',
190            )
191            v -= 30
192        else:
193            self._vr_head_relative_audio_button = None
194
195        self._soundtrack_button: bui.Widget | None
196        if show_soundtracks:
197            v -= 1.2 * spacing
198            self._soundtrack_button = bui.buttonwidget(
199                parent=self._root_widget,
200                position=((width - 310) / 2, v),
201                size=(310, 50),
202                autoselect=True,
203                label=bui.Lstr(resource=self._r + '.soundtrackButtonText'),
204                on_activate_call=self._do_soundtracks,
205            )
206            v -= spacing * 0.5
207            bui.textwidget(
208                parent=self._root_widget,
209                position=(0, v),
210                size=(width, 20),
211                text=bui.Lstr(resource=self._r + '.soundtrackDescriptionText'),
212                flatness=1.0,
213                h_align='center',
214                scale=0.5,
215                color=(0.7, 0.8, 0.7, 1.0),
216                maxwidth=400,
217            )
218        else:
219            self._soundtrack_button = None
220
221        # Tweak a few navigation bits.
222        try:
223            bui.widget(edit=back_button, down_widget=svne.minusbutton)
224        except Exception:
225            logging.exception('Error wiring AudioSettingsWindow.')
226
227        self._restore_state()
228
229    def _set_vr_head_relative_audio(self, val: str) -> None:
230        cfg = bui.app.config
231        cfg['VR Head Relative Audio'] = val
232        cfg.apply_and_commit()
233
234    def _do_soundtracks(self) -> None:
235        # pylint: disable=cyclic-import
236        from bauiv1lib.soundtrack import browser as stb
237
238        # no-op if our underlying widget is dead or on its way out.
239        if not self._root_widget or self._root_widget.transitioning_out:
240            return
241
242        # We require disk access for soundtracks;
243        # if we don't have it, request it.
244        if not bui.have_permission(bui.Permission.STORAGE):
245            bui.getsound('ding').play()
246            bui.screenmessage(
247                bui.Lstr(resource='storagePermissionAccessText'),
248                color=(0.5, 1, 0.5),
249            )
250            bui.apptimer(
251                1.0, bui.Call(bui.request_permission, bui.Permission.STORAGE)
252            )
253            return
254
255        self._save_state()
256        bui.containerwidget(edit=self._root_widget, transition='out_left')
257        assert bui.app.classic is not None
258        bui.app.ui_v1.set_main_menu_window(
259            stb.SoundtrackBrowserWindow(
260                origin_widget=self._soundtrack_button
261            ).get_root_widget(),
262            from_window=self._root_widget,
263        )
264
265    def _back(self) -> None:
266        # pylint: disable=cyclic-import
267        from bauiv1lib.settings import allsettings
268
269        # no-op if our underlying widget is dead or on its way out.
270        if not self._root_widget or self._root_widget.transitioning_out:
271            return
272
273        self._save_state()
274        bui.containerwidget(
275            edit=self._root_widget, transition=self._transition_out
276        )
277        assert bui.app.classic is not None
278        bui.app.ui_v1.set_main_menu_window(
279            allsettings.AllSettingsWindow(
280                transition='in_left'
281            ).get_root_widget(),
282            from_window=self._root_widget,
283        )
284
285    def _save_state(self) -> None:
286        try:
287            sel = self._root_widget.get_selected_child()
288            if sel == self._sound_volume_numedit.minusbutton:
289                sel_name = 'SoundMinus'
290            elif sel == self._sound_volume_numedit.plusbutton:
291                sel_name = 'SoundPlus'
292            elif sel == self._music_volume_numedit.minusbutton:
293                sel_name = 'MusicMinus'
294            elif sel == self._music_volume_numedit.plusbutton:
295                sel_name = 'MusicPlus'
296            elif sel == self._soundtrack_button:
297                sel_name = 'Soundtrack'
298            elif sel == self._back_button:
299                sel_name = 'Back'
300            elif sel == self._vr_head_relative_audio_button:
301                sel_name = 'VRHeadRelative'
302            else:
303                raise ValueError(f'unrecognized selection \'{sel}\'')
304            assert bui.app.classic is not None
305            bui.app.ui_v1.window_states[type(self)] = sel_name
306        except Exception:
307            logging.exception('Error saving state for %s.', self)
308
309    def _restore_state(self) -> None:
310        try:
311            assert bui.app.classic is not None
312            sel_name = bui.app.ui_v1.window_states.get(type(self))
313            sel: bui.Widget | None
314            if sel_name == 'SoundMinus':
315                sel = self._sound_volume_numedit.minusbutton
316            elif sel_name == 'SoundPlus':
317                sel = self._sound_volume_numedit.plusbutton
318            elif sel_name == 'MusicMinus':
319                sel = self._music_volume_numedit.minusbutton
320            elif sel_name == 'MusicPlus':
321                sel = self._music_volume_numedit.plusbutton
322            elif sel_name == 'VRHeadRelative':
323                sel = self._vr_head_relative_audio_button
324            elif sel_name == 'Soundtrack':
325                sel = self._soundtrack_button
326            elif sel_name == 'Back':
327                sel = self._back_button
328            else:
329                sel = self._back_button
330            if sel:
331                bui.containerwidget(edit=self._root_widget, selected_child=sel)
332        except Exception:
333            logging.exception('Error restoring state for %s.', self)