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