bauiv1lib.soundtrack.entrytypeselect

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""Provides UI for selecting soundtrack entry types."""
  4from __future__ import annotations
  5
  6import copy
  7from typing import TYPE_CHECKING, override
  8
  9import bauiv1 as bui
 10
 11if TYPE_CHECKING:
 12    from typing import Any, Callable
 13
 14
 15class SoundtrackEntryTypeSelectWindow(bui.MainWindow):
 16    """Window for selecting a soundtrack entry type."""
 17
 18    def __init__(
 19        self,
 20        callback: Callable[[Any], Any],
 21        current_entry: Any,
 22        selection_target_name: str,
 23        transition: str | None = 'in_right',
 24        origin_widget: bui.Widget | None = None,
 25    ):
 26        # pylint: disable=too-many-locals
 27        assert bui.app.classic is not None
 28        music = bui.app.classic.music
 29        self._r = 'editSoundtrackWindow'
 30
 31        self._selection_target_name = selection_target_name
 32        self._callback = callback
 33        self._current_entry = copy.deepcopy(current_entry)
 34
 35        self._width = 580
 36        self._height = 220
 37        spacing = 80
 38
 39        # FIXME: Generalize this so new custom soundtrack types can add
 40        # themselves here.
 41        do_default = True
 42        do_mac_music_app_playlist = music.supports_soundtrack_entry_type(
 43            'iTunesPlaylist'
 44        )
 45        do_music_file = music.supports_soundtrack_entry_type('musicFile')
 46        do_music_folder = music.supports_soundtrack_entry_type('musicFolder')
 47
 48        if do_mac_music_app_playlist:
 49            self._height += spacing
 50        if do_music_file:
 51            self._height += spacing
 52        if do_music_folder:
 53            self._height += spacing
 54
 55        uiscale = bui.app.ui_v1.uiscale
 56
 57        # NOTE: When something is selected, we close our UI and kick off
 58        # another window which then calls us back when its done, so the
 59        # standard UI-cleanup-check complains that something is holding
 60        # on to our instance after its ui is gone. Should restructure in
 61        # a cleaner way, but just disabling that check for now.
 62        super().__init__(
 63            root_widget=bui.containerwidget(
 64                size=(self._width, self._height),
 65                scale=(
 66                    1.7
 67                    if uiscale is bui.UIScale.SMALL
 68                    else 1.4 if uiscale is bui.UIScale.MEDIUM else 1.0
 69                ),
 70            ),
 71            cleanupcheck=False,
 72            transition=transition,
 73            origin_widget=origin_widget,
 74        )
 75        btn = bui.buttonwidget(
 76            parent=self._root_widget,
 77            position=(35, self._height - 65),
 78            size=(160, 60),
 79            scale=0.8,
 80            text_scale=1.2,
 81            label=bui.Lstr(resource='cancelText'),
 82            on_activate_call=self._on_cancel_press,
 83        )
 84        bui.containerwidget(edit=self._root_widget, cancel_button=btn)
 85        bui.textwidget(
 86            parent=self._root_widget,
 87            position=(self._width * 0.5, self._height - 32),
 88            size=(0, 0),
 89            text=bui.Lstr(resource=f'{self._r}.selectASourceText'),
 90            color=bui.app.ui_v1.title_color,
 91            maxwidth=230,
 92            h_align='center',
 93            v_align='center',
 94        )
 95
 96        bui.textwidget(
 97            parent=self._root_widget,
 98            position=(self._width * 0.5, self._height - 56),
 99            size=(0, 0),
100            text=selection_target_name,
101            color=bui.app.ui_v1.infotextcolor,
102            scale=0.7,
103            maxwidth=230,
104            h_align='center',
105            v_align='center',
106        )
107
108        v = self._height - 155
109
110        current_entry_type = music.get_soundtrack_entry_type(current_entry)
111
112        if do_default:
113            btn = bui.buttonwidget(
114                parent=self._root_widget,
115                size=(self._width - 100, 60),
116                position=(50, v),
117                label=bui.Lstr(resource=f'{self._r}.useDefaultGameMusicText'),
118                on_activate_call=self._on_default_press,
119            )
120            if current_entry_type == 'default':
121                bui.containerwidget(edit=self._root_widget, selected_child=btn)
122            v -= spacing
123
124        if do_mac_music_app_playlist:
125            btn = bui.buttonwidget(
126                parent=self._root_widget,
127                size=(self._width - 100, 60),
128                position=(50, v),
129                label=bui.Lstr(resource=f'{self._r}.useITunesPlaylistText'),
130                on_activate_call=self._on_mac_music_app_playlist_press,
131                icon=None,
132            )
133            if current_entry_type == 'iTunesPlaylist':
134                bui.containerwidget(edit=self._root_widget, selected_child=btn)
135            v -= spacing
136
137        if do_music_file:
138            btn = bui.buttonwidget(
139                parent=self._root_widget,
140                size=(self._width - 100, 60),
141                position=(50, v),
142                label=bui.Lstr(resource=f'{self._r}.useMusicFileText'),
143                on_activate_call=self._on_music_file_press,
144                icon=bui.gettexture('file'),
145            )
146            if current_entry_type == 'musicFile':
147                bui.containerwidget(edit=self._root_widget, selected_child=btn)
148            v -= spacing
149
150        if do_music_folder:
151            btn = bui.buttonwidget(
152                parent=self._root_widget,
153                size=(self._width - 100, 60),
154                position=(50, v),
155                label=bui.Lstr(resource=f'{self._r}.useMusicFolderText'),
156                on_activate_call=self._on_music_folder_press,
157                icon=bui.gettexture('folder'),
158                icon_color=(1.1, 0.8, 0.2),
159            )
160            if current_entry_type == 'musicFolder':
161                bui.containerwidget(edit=self._root_widget, selected_child=btn)
162            v -= spacing
163
164    @override
165    def get_main_window_state(self) -> bui.MainWindowState:
166        # Support recreating our window for back/refresh purposes.
167        cls = type(self)
168
169        # Pull these out of self here; if we reference self in the
170        # lambda we'll keep our window alive which is bad.
171        current_entry = self._current_entry
172        callback = self._callback
173        selection_target_name = self._selection_target_name
174
175        return bui.BasicMainWindowState(
176            create_call=lambda transition, origin_widget: cls(
177                transition=transition,
178                origin_widget=origin_widget,
179                current_entry=current_entry,
180                callback=callback,
181                selection_target_name=selection_target_name,
182            )
183        )
184
185    def _on_mac_music_app_playlist_press(self) -> None:
186        assert bui.app.classic is not None
187        music = bui.app.classic.music
188        from bauiv1lib.soundtrack.macmusicapp import (
189            MacMusicAppPlaylistSelectWindow,
190        )
191
192        # no-op if we're not in control.
193        if not self.main_window_has_control():
194            return
195
196        current_playlist_entry: str | None
197        if (
198            music.get_soundtrack_entry_type(self._current_entry)
199            == 'iTunesPlaylist'
200        ):
201            current_playlist_entry = music.get_soundtrack_entry_name(
202                self._current_entry
203            )
204        else:
205            current_playlist_entry = None
206
207        self.main_window_replace(
208            MacMusicAppPlaylistSelectWindow(
209                self._callback, current_playlist_entry, self._current_entry
210            )
211        )
212
213    def _on_music_file_press(self) -> None:
214        from babase import android_get_external_files_dir
215        from baclassic.osmusic import OSMusicPlayer
216        from bauiv1lib.fileselector import FileSelectorWindow
217
218        # no-op if we're not in control.
219        if not self.main_window_has_control():
220            return
221
222        base_path = android_get_external_files_dir()
223        assert bui.app.classic is not None
224
225        self.main_window_replace(
226            FileSelectorWindow(
227                base_path,
228                callback=self._music_file_selector_cb,
229                show_base_path=False,
230                valid_file_extensions=(
231                    OSMusicPlayer.get_valid_music_file_extensions()
232                ),
233                allow_folders=False,
234            ),
235        )
236
237    def _on_music_folder_press(self) -> None:
238        from bauiv1lib.fileselector import FileSelectorWindow
239        from babase import android_get_external_files_dir
240
241        # no-op if we're not in control.
242        if not self.main_window_has_control():
243            return
244
245        base_path = android_get_external_files_dir()
246        assert bui.app.classic is not None
247
248        self.main_window_replace(
249            FileSelectorWindow(
250                base_path,
251                callback=self._music_folder_selector_cb,
252                show_base_path=False,
253                valid_file_extensions=[],
254                allow_folders=True,
255            ),
256        )
257
258    def _music_file_selector_cb(self, result: str | None) -> None:
259        if result is None:
260            self._callback(self._current_entry)
261        else:
262            self._callback({'type': 'musicFile', 'name': result})
263
264    def _music_folder_selector_cb(self, result: str | None) -> None:
265        if result is None:
266            self._callback(self._current_entry)
267        else:
268            self._callback({'type': 'musicFolder', 'name': result})
269
270    def _on_default_press(self) -> None:
271        self.main_window_back()
272        self._callback(None)
273
274    def _on_cancel_press(self) -> None:
275        self.main_window_back()
276        self._callback(self._current_entry)