bauiv1lib.soundtrack.browser

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""Provides UI for browsing soundtracks."""
  4
  5from __future__ import annotations
  6
  7import copy
  8import logging
  9from typing import TYPE_CHECKING
 10
 11import bauiv1 as bui
 12
 13if TYPE_CHECKING:
 14    from typing import Any
 15
 16
 17class SoundtrackBrowserWindow(bui.Window):
 18    """Window for browsing soundtracks."""
 19
 20    def __init__(
 21        self,
 22        transition: str = 'in_right',
 23        origin_widget: bui.Widget | None = None,
 24    ):
 25        # pylint: disable=too-many-locals
 26        # pylint: disable=too-many-statements
 27
 28        # If they provided an origin-widget, scale up from that.
 29        scale_origin: tuple[float, float] | None
 30        if origin_widget is not None:
 31            self._transition_out = 'out_scale'
 32            scale_origin = origin_widget.get_screen_space_center()
 33            transition = 'in_scale'
 34        else:
 35            self._transition_out = 'out_right'
 36            scale_origin = None
 37
 38        self._r = 'editSoundtrackWindow'
 39        assert bui.app.classic is not None
 40        uiscale = bui.app.ui_v1.uiscale
 41        self._width = 800 if uiscale is bui.UIScale.SMALL else 600
 42        x_inset = 100 if uiscale is bui.UIScale.SMALL else 0
 43        self._height = (
 44            340
 45            if uiscale is bui.UIScale.SMALL
 46            else 370
 47            if uiscale is bui.UIScale.MEDIUM
 48            else 440
 49        )
 50        spacing = 40.0
 51        v = self._height - 40.0
 52        v -= spacing * 1.0
 53
 54        super().__init__(
 55            root_widget=bui.containerwidget(
 56                size=(self._width, self._height),
 57                transition=transition,
 58                toolbar_visibility='menu_minimal',
 59                scale_origin_stack_offset=scale_origin,
 60                scale=(
 61                    2.3
 62                    if uiscale is bui.UIScale.SMALL
 63                    else 1.6
 64                    if uiscale is bui.UIScale.MEDIUM
 65                    else 1.0
 66                ),
 67                stack_offset=(0, -18)
 68                if uiscale is bui.UIScale.SMALL
 69                else (0, 0),
 70            )
 71        )
 72
 73        assert bui.app.classic is not None
 74        if bui.app.ui_v1.use_toolbars and uiscale is bui.UIScale.SMALL:
 75            self._back_button = None
 76        else:
 77            self._back_button = bui.buttonwidget(
 78                parent=self._root_widget,
 79                position=(45 + x_inset, self._height - 60),
 80                size=(120, 60),
 81                scale=0.8,
 82                label=bui.Lstr(resource='backText'),
 83                button_type='back',
 84                autoselect=True,
 85            )
 86            bui.buttonwidget(
 87                edit=self._back_button,
 88                button_type='backSmall',
 89                size=(60, 60),
 90                label=bui.charstr(bui.SpecialChar.BACK),
 91            )
 92        bui.textwidget(
 93            parent=self._root_widget,
 94            position=(self._width * 0.5, self._height - 35),
 95            size=(0, 0),
 96            maxwidth=300,
 97            text=bui.Lstr(resource=self._r + '.titleText'),
 98            color=bui.app.ui_v1.title_color,
 99            h_align='center',
100            v_align='center',
101        )
102
103        h = 43 + x_inset
104        v = self._height - 60
105        b_color = (0.6, 0.53, 0.63)
106        b_textcolor = (0.75, 0.7, 0.8)
107        lock_tex = bui.gettexture('lock')
108        self._lock_images: list[bui.Widget] = []
109
110        scl = (
111            1.0
112            if uiscale is bui.UIScale.SMALL
113            else 1.13
114            if uiscale is bui.UIScale.MEDIUM
115            else 1.4
116        )
117        v -= 60.0 * scl
118        self._new_button = btn = bui.buttonwidget(
119            parent=self._root_widget,
120            position=(h, v),
121            size=(100, 55.0 * scl),
122            on_activate_call=self._new_soundtrack,
123            color=b_color,
124            button_type='square',
125            autoselect=True,
126            textcolor=b_textcolor,
127            text_scale=0.7,
128            label=bui.Lstr(resource=self._r + '.newText'),
129        )
130        self._lock_images.append(
131            bui.imagewidget(
132                parent=self._root_widget,
133                size=(30, 30),
134                draw_controller=btn,
135                position=(h - 10, v + 55.0 * scl - 28),
136                texture=lock_tex,
137            )
138        )
139
140        if self._back_button is None:
141            bui.widget(
142                edit=btn,
143                left_widget=bui.get_special_widget('back_button'),
144            )
145        v -= 60.0 * scl
146
147        self._edit_button = btn = bui.buttonwidget(
148            parent=self._root_widget,
149            position=(h, v),
150            size=(100, 55.0 * scl),
151            on_activate_call=self._edit_soundtrack,
152            color=b_color,
153            button_type='square',
154            autoselect=True,
155            textcolor=b_textcolor,
156            text_scale=0.7,
157            label=bui.Lstr(resource=self._r + '.editText'),
158        )
159        self._lock_images.append(
160            bui.imagewidget(
161                parent=self._root_widget,
162                size=(30, 30),
163                draw_controller=btn,
164                position=(h - 10, v + 55.0 * scl - 28),
165                texture=lock_tex,
166            )
167        )
168        if self._back_button is None:
169            bui.widget(
170                edit=btn,
171                left_widget=bui.get_special_widget('back_button'),
172            )
173        v -= 60.0 * scl
174
175        self._duplicate_button = btn = bui.buttonwidget(
176            parent=self._root_widget,
177            position=(h, v),
178            size=(100, 55.0 * scl),
179            on_activate_call=self._duplicate_soundtrack,
180            button_type='square',
181            autoselect=True,
182            color=b_color,
183            textcolor=b_textcolor,
184            text_scale=0.7,
185            label=bui.Lstr(resource=self._r + '.duplicateText'),
186        )
187        self._lock_images.append(
188            bui.imagewidget(
189                parent=self._root_widget,
190                size=(30, 30),
191                draw_controller=btn,
192                position=(h - 10, v + 55.0 * scl - 28),
193                texture=lock_tex,
194            )
195        )
196        if self._back_button is None:
197            bui.widget(
198                edit=btn,
199                left_widget=bui.get_special_widget('back_button'),
200            )
201        v -= 60.0 * scl
202
203        self._delete_button = btn = bui.buttonwidget(
204            parent=self._root_widget,
205            position=(h, v),
206            size=(100, 55.0 * scl),
207            on_activate_call=self._delete_soundtrack,
208            color=b_color,
209            button_type='square',
210            autoselect=True,
211            textcolor=b_textcolor,
212            text_scale=0.7,
213            label=bui.Lstr(resource=self._r + '.deleteText'),
214        )
215        self._lock_images.append(
216            bui.imagewidget(
217                parent=self._root_widget,
218                size=(30, 30),
219                draw_controller=btn,
220                position=(h - 10, v + 55.0 * scl - 28),
221                texture=lock_tex,
222            )
223        )
224        if self._back_button is None:
225            bui.widget(
226                edit=btn,
227                left_widget=bui.get_special_widget('back_button'),
228            )
229
230        # Keep our lock images up to date/etc.
231        self._update_timer = bui.AppTimer(
232            1.0, bui.WeakCall(self._update), repeat=True
233        )
234        self._update()
235
236        v = self._height - 65
237        scroll_height = self._height - 105
238        v -= scroll_height
239        self._scrollwidget = scrollwidget = bui.scrollwidget(
240            parent=self._root_widget,
241            position=(152 + x_inset, v),
242            highlight=False,
243            size=(self._width - (205 + 2 * x_inset), scroll_height),
244        )
245        bui.widget(
246            edit=self._scrollwidget,
247            left_widget=self._new_button,
248            right_widget=bui.get_special_widget('party_button')
249            if bui.app.ui_v1.use_toolbars
250            else self._scrollwidget,
251        )
252        self._col = bui.columnwidget(parent=scrollwidget, border=2, margin=0)
253
254        self._soundtracks: dict[str, Any] | None = None
255        self._selected_soundtrack: str | None = None
256        self._selected_soundtrack_index: int | None = None
257        self._soundtrack_widgets: list[bui.Widget] = []
258        self._allow_changing_soundtracks = False
259        self._refresh()
260        if self._back_button is not None:
261            bui.buttonwidget(
262                edit=self._back_button, on_activate_call=self._back
263            )
264            bui.containerwidget(
265                edit=self._root_widget, cancel_button=self._back_button
266            )
267        else:
268            bui.containerwidget(
269                edit=self._root_widget, on_cancel_call=self._back
270            )
271
272    def _update(self) -> None:
273        have = (
274            bui.app.classic is None
275            or bui.app.classic.accounts.have_pro_options()
276        )
277        for lock in self._lock_images:
278            bui.imagewidget(edit=lock, opacity=0.0 if have else 1.0)
279
280    def _do_delete_soundtrack(self) -> None:
281        cfg = bui.app.config
282        soundtracks = cfg.setdefault('Soundtracks', {})
283        if self._selected_soundtrack in soundtracks:
284            del soundtracks[self._selected_soundtrack]
285        cfg.commit()
286        bui.getsound('shieldDown').play()
287        assert self._selected_soundtrack_index is not None
288        assert self._soundtracks is not None
289        if self._selected_soundtrack_index >= len(self._soundtracks):
290            self._selected_soundtrack_index = len(self._soundtracks)
291        self._refresh()
292
293    def _delete_soundtrack(self) -> None:
294        # pylint: disable=cyclic-import
295        from bauiv1lib.purchase import PurchaseWindow
296        from bauiv1lib.confirm import ConfirmWindow
297
298        if (
299            bui.app.classic is not None
300            and not bui.app.classic.accounts.have_pro_options()
301        ):
302            PurchaseWindow(items=['pro'])
303            return
304        if self._selected_soundtrack is None:
305            return
306        if self._selected_soundtrack == '__default__':
307            bui.getsound('error').play()
308            bui.screenmessage(
309                bui.Lstr(resource=self._r + '.cantDeleteDefaultText'),
310                color=(1, 0, 0),
311            )
312        else:
313            ConfirmWindow(
314                bui.Lstr(
315                    resource=self._r + '.deleteConfirmText',
316                    subs=[('${NAME}', self._selected_soundtrack)],
317                ),
318                self._do_delete_soundtrack,
319                450,
320                150,
321            )
322
323    def _duplicate_soundtrack(self) -> None:
324        # pylint: disable=cyclic-import
325        from bauiv1lib.purchase import PurchaseWindow
326
327        if (
328            bui.app.classic is not None
329            and not bui.app.classic.accounts.have_pro_options()
330        ):
331            PurchaseWindow(items=['pro'])
332            return
333        cfg = bui.app.config
334        cfg.setdefault('Soundtracks', {})
335
336        if self._selected_soundtrack is None:
337            return
338        sdtk: dict[str, Any]
339        if self._selected_soundtrack == '__default__':
340            sdtk = {}
341        else:
342            sdtk = cfg['Soundtracks'][self._selected_soundtrack]
343
344        # Find a valid dup name that doesn't exist.
345        test_index = 1
346        copy_text = bui.Lstr(resource='copyOfText').evaluate()
347        # Get just 'Copy' or whatnot.
348        copy_word = copy_text.replace('${NAME}', '').strip()
349        base_name = self._get_soundtrack_display_name(
350            self._selected_soundtrack
351        ).evaluate()
352        assert isinstance(base_name, str)
353
354        # If it looks like a copy, strip digits and spaces off the end.
355        if copy_word in base_name:
356            while base_name[-1].isdigit() or base_name[-1] == ' ':
357                base_name = base_name[:-1]
358        while True:
359            if copy_word in base_name:
360                test_name = base_name
361            else:
362                test_name = copy_text.replace('${NAME}', base_name)
363            if test_index > 1:
364                test_name += ' ' + str(test_index)
365            if test_name not in cfg['Soundtracks']:
366                break
367            test_index += 1
368
369        cfg['Soundtracks'][test_name] = copy.deepcopy(sdtk)
370        cfg.commit()
371        self._refresh(select_soundtrack=test_name)
372
373    def _select(self, name: str, index: int) -> None:
374        assert bui.app.classic is not None
375        music = bui.app.classic.music
376        self._selected_soundtrack_index = index
377        self._selected_soundtrack = name
378        cfg = bui.app.config
379        current_soundtrack = cfg.setdefault('Soundtrack', '__default__')
380
381        # If it varies from current, commit and play.
382        if current_soundtrack != name and self._allow_changing_soundtracks:
383            bui.getsound('gunCocking').play()
384            cfg['Soundtrack'] = self._selected_soundtrack
385            cfg.commit()
386
387            # Just play whats already playing.. this'll grab it from the
388            # new soundtrack.
389            music.do_play_music(
390                music.music_types[bui.app.classic.MusicPlayMode.REGULAR]
391            )
392
393    def _back(self) -> None:
394        # pylint: disable=cyclic-import
395        from bauiv1lib.settings import audio
396
397        self._save_state()
398        bui.containerwidget(
399            edit=self._root_widget, transition=self._transition_out
400        )
401        assert bui.app.classic is not None
402        bui.app.ui_v1.set_main_menu_window(
403            audio.AudioSettingsWindow(transition='in_left').get_root_widget()
404        )
405
406    def _edit_soundtrack_with_sound(self) -> None:
407        # pylint: disable=cyclic-import
408        from bauiv1lib.purchase import PurchaseWindow
409
410        if (
411            bui.app.classic is not None
412            and not bui.app.classic.accounts.have_pro_options()
413        ):
414            PurchaseWindow(items=['pro'])
415            return
416        bui.getsound('swish').play()
417        self._edit_soundtrack()
418
419    def _edit_soundtrack(self) -> None:
420        # pylint: disable=cyclic-import
421        from bauiv1lib.purchase import PurchaseWindow
422        from bauiv1lib.soundtrack.edit import SoundtrackEditWindow
423
424        if (
425            bui.app.classic is not None
426            and not bui.app.classic.accounts.have_pro_options()
427        ):
428            PurchaseWindow(items=['pro'])
429            return
430        if self._selected_soundtrack is None:
431            return
432        if self._selected_soundtrack == '__default__':
433            bui.getsound('error').play()
434            bui.screenmessage(
435                bui.Lstr(resource=self._r + '.cantEditDefaultText'),
436                color=(1, 0, 0),
437            )
438            return
439
440        self._save_state()
441        bui.containerwidget(edit=self._root_widget, transition='out_left')
442        assert bui.app.classic is not None
443        bui.app.ui_v1.set_main_menu_window(
444            SoundtrackEditWindow(
445                existing_soundtrack=self._selected_soundtrack
446            ).get_root_widget()
447        )
448
449    def _get_soundtrack_display_name(self, soundtrack: str) -> bui.Lstr:
450        if soundtrack == '__default__':
451            return bui.Lstr(resource=self._r + '.defaultSoundtrackNameText')
452        return bui.Lstr(value=soundtrack)
453
454    def _refresh(self, select_soundtrack: str | None = None) -> None:
455        from efro.util import asserttype
456
457        self._allow_changing_soundtracks = False
458        old_selection = self._selected_soundtrack
459
460        # If there was no prev selection, look in prefs.
461        if old_selection is None:
462            old_selection = bui.app.config.get('Soundtrack')
463        old_selection_index = self._selected_soundtrack_index
464
465        # Delete old.
466        while self._soundtrack_widgets:
467            self._soundtrack_widgets.pop().delete()
468
469        self._soundtracks = bui.app.config.get('Soundtracks', {})
470        assert self._soundtracks is not None
471        items = list(self._soundtracks.items())
472        items.sort(key=lambda x: asserttype(x[0], str).lower())
473        items = [('__default__', None)] + items  # default is always first
474        index = 0
475        for pname, _pval in items:
476            assert pname is not None
477            txtw = bui.textwidget(
478                parent=self._col,
479                size=(self._width - 40, 24),
480                text=self._get_soundtrack_display_name(pname),
481                h_align='left',
482                v_align='center',
483                maxwidth=self._width - 110,
484                always_highlight=True,
485                on_select_call=bui.WeakCall(self._select, pname, index),
486                on_activate_call=self._edit_soundtrack_with_sound,
487                selectable=True,
488            )
489            if index == 0:
490                bui.widget(edit=txtw, up_widget=self._back_button)
491            self._soundtrack_widgets.append(txtw)
492
493            # Select this one if the user requested it
494            if select_soundtrack is not None:
495                if pname == select_soundtrack:
496                    bui.columnwidget(
497                        edit=self._col, selected_child=txtw, visible_child=txtw
498                    )
499            else:
500                # Select this one if it was previously selected.
501                # Go by index if there's one.
502                if old_selection_index is not None:
503                    if index == old_selection_index:
504                        bui.columnwidget(
505                            edit=self._col,
506                            selected_child=txtw,
507                            visible_child=txtw,
508                        )
509                else:  # Otherwise look by name.
510                    if pname == old_selection:
511                        bui.columnwidget(
512                            edit=self._col,
513                            selected_child=txtw,
514                            visible_child=txtw,
515                        )
516            index += 1
517
518        # Explicitly run select callback on current one and re-enable
519        # callbacks.
520
521        # Eww need to run this in a timer so it happens after our select
522        # callbacks. With a small-enough time sometimes it happens before
523        # anyway. Ew. need a way to just schedule a callable i guess.
524        bui.apptimer(0.1, bui.WeakCall(self._set_allow_changing))
525
526    def _set_allow_changing(self) -> None:
527        self._allow_changing_soundtracks = True
528        assert self._selected_soundtrack is not None
529        assert self._selected_soundtrack_index is not None
530        self._select(self._selected_soundtrack, self._selected_soundtrack_index)
531
532    def _new_soundtrack(self) -> None:
533        # pylint: disable=cyclic-import
534        from bauiv1lib.purchase import PurchaseWindow
535        from bauiv1lib.soundtrack.edit import SoundtrackEditWindow
536
537        if (
538            bui.app.classic is not None
539            and not bui.app.classic.accounts.have_pro_options()
540        ):
541            PurchaseWindow(items=['pro'])
542            return
543        self._save_state()
544        bui.containerwidget(edit=self._root_widget, transition='out_left')
545        SoundtrackEditWindow(existing_soundtrack=None)
546
547    def _create_done(self, new_soundtrack: str) -> None:
548        if new_soundtrack is not None:
549            bui.getsound('gunCocking').play()
550            self._refresh(select_soundtrack=new_soundtrack)
551
552    def _save_state(self) -> None:
553        try:
554            sel = self._root_widget.get_selected_child()
555            if sel == self._scrollwidget:
556                sel_name = 'Scroll'
557            elif sel == self._new_button:
558                sel_name = 'New'
559            elif sel == self._edit_button:
560                sel_name = 'Edit'
561            elif sel == self._duplicate_button:
562                sel_name = 'Duplicate'
563            elif sel == self._delete_button:
564                sel_name = 'Delete'
565            elif sel == self._back_button:
566                sel_name = 'Back'
567            else:
568                raise ValueError(f'unrecognized selection \'{sel}\'')
569            assert bui.app.classic is not None
570            bui.app.ui_v1.window_states[type(self)] = sel_name
571        except Exception:
572            logging.exception('Error saving state for %s.', self)
573
574    def _restore_state(self) -> None:
575        try:
576            assert bui.app.classic is not None
577            sel_name = bui.app.ui_v1.window_states.get(type(self))
578            if sel_name == 'Scroll':
579                sel = self._scrollwidget
580            elif sel_name == 'New':
581                sel = self._new_button
582            elif sel_name == 'Edit':
583                sel = self._edit_button
584            elif sel_name == 'Duplicate':
585                sel = self._duplicate_button
586            elif sel_name == 'Delete':
587                sel = self._delete_button
588            else:
589                sel = self._scrollwidget
590            bui.containerwidget(edit=self._root_widget, selected_child=sel)
591        except Exception:
592            logging.exception('Error restoring state for %s.', self)