File: tools_widgets.py

package info (click to toggle)
raysession 0.17.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 19,168 kB
  • sloc: python: 44,371; sh: 1,538; makefile: 208; xml: 86
file content (523 lines) | stat: -rw-r--r-- 18,939 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
from enum import Enum, IntEnum
from typing import TYPE_CHECKING, Optional

from qtpy.QtCore import QTimer, Slot, QPoint, QObject, Qt # type:ignore
from qtpy.QtGui import QPalette, QIcon
if TYPE_CHECKING:
    # FIX : QAction not found by pylance
    from qtpy.QtGui import QAction
from qtpy.QtWidgets import (
    QWidget, QMainWindow, QAction, QApplication, QMenu) # type:ignore

from patshared import TransportPosition

from .widgets.bar_widget_jack import BarWidgetJack
from .widgets.bar_widget_transport import BarWidgetTransport
from .widgets.bar_widget_canvas import BarWidgetCanvas

from .bases.elements import ToolDisplayed

if TYPE_CHECKING:
    from .patchbay_manager import PatchbayManager
    from .widgets.tool_bar import PatchbayToolBar


_translate = QApplication.translate


def is_dark_theme(widget: QWidget) -> bool:
    return bool(
        widget.palette().brush(
            QPalette.ColorGroup.Active,
            QPalette.ColorRole.WindowText).color().lightness()
        > 128)


class JackAgnostic(Enum):
    'Enum used by Patchichi to set what is displayed'
    
    NONE = 0
    'Not JACK agnostic, used by Patchance and RaySession'
    
    DUMMY = 1
    'JACK agnostic in reality, but display all widgets'
    
    FULL = 2
    'Hide all widgets related to JACK'


class TextWithIcons(Enum):
    NO = 0
    AUTO = 1
    YES = 2

    @classmethod    
    def by_name(cls, name: str) -> 'TextWithIcons':
        if name == 'NO':
            return cls.NO
        if name == 'YES':
            return cls.YES
        return cls.AUTO


class TBar(IntEnum):
    MAIN = 0
    TRANSPORT = 1
    JACK = 2
    CANVAS = 3


class PatchbayToolsWidget(QObject):
    def __init__(self):
        QObject.__init__(self)
        self._jack_running = True
        
        self.mng: 'Optional[PatchbayManager]' = None

        self.no_text_with_icons_act = False

        self._jack_agnostic = JackAgnostic.NONE
        
        self._tools_displayed = ToolDisplayed.ALL
        self.tbars : Optional[tuple[PatchbayToolBar, ...]] = None
        self._last_layout = ''
        self._text_with_icons = TextWithIcons.AUTO

        self._transport_wg: Optional[BarWidgetTransport] = None
        self._jack_wg: Optional[BarWidgetJack] = None
        self._canvas_wg: Optional[BarWidgetCanvas] = None
        
        self._last_win_width = 0
        self._main_bar_little_width = 0
        self._main_bar_large_width = 0
        self._first_resize_done = False

    @staticmethod
    def _make_context_actions() -> dict[ToolDisplayed, QAction]:
        return {
            ToolDisplayed.UNDO_REDO:
                QAction(QIcon.fromTheme('edit-undo'),
                        _translate('tool_bar', 'Undo / Redo')),
            ToolDisplayed.VIEWS_SELECTOR:
                QAction(QIcon.fromTheme('view-multiple-objects'),
                        _translate('tool_bar', 'Views selector')),
            ToolDisplayed.HIDDENS_BOX:
                QAction(QIcon.fromTheme('hint'),
                        _translate('tool_bar', 'Hidden boxes')),
            ToolDisplayed.PORT_TYPES_VIEW:
                QAction(QIcon.fromTheme('view-filter'),
                        _translate('tool_bar', 'Type filter')),
            ToolDisplayed.ZOOM_SLIDER:
                QAction(QIcon.fromTheme('zoom-select'),
                        _translate('tool_bar', 'Zoom slider')),
            ToolDisplayed.TRANSPORT_CLOCK:
                QAction(QIcon.fromTheme('clock'),
                        _translate('tool_bar', 'Transport clock')),
            ToolDisplayed.TRANSPORT_PLAY_STOP:
                QAction(QIcon.fromTheme('media-playback-pause'),
                        _translate('tool_bar', 'Transport Play/Stop')),
            ToolDisplayed.TRANSPORT_TEMPO:
                QAction(QIcon.fromTheme('folder-music-symbolic'),
                        _translate('tool_bar', 'Transport Tempo')),
            ToolDisplayed.BUFFER_SIZE:
                QAction(QIcon.fromTheme('settings-configure'),
                        _translate('tool_bar', 'Buffer size')),
            ToolDisplayed.SAMPLERATE:
                QAction(QIcon.fromTheme('filename-sample-rate'),
                        _translate('tool_bar', 'Sample rate')),
            ToolDisplayed.LATENCY:
                QAction(QIcon.fromTheme('chronometer-lap'),
                        _translate('tool_bar', 'Latency')),
            ToolDisplayed.XRUNS:
                QAction(QIcon.fromTheme('data-error'),
                        _translate('tool_bar', 'Xruns')),
            ToolDisplayed.DSP_LOAD:
                QAction(QIcon.fromTheme('histogram-symbolic'),
                        _translate('tool_bar', 'DSP Load'))
        }

    def _make_context_menu(
            self, context_actions: dict[ToolDisplayed, QAction]) -> QMenu:
        menu = QMenu()
        menu.addSection(_translate('tool_bar', 'Displayed tools'))
        
        for key, act in context_actions.items():
            act.setCheckable(True)
            act.setChecked(bool(self._tools_displayed & key))
            if self.mng is not None:
                if not self.mng.server_is_started:
                    if key in (ToolDisplayed.UNDO_REDO,
                               ToolDisplayed.VIEWS_SELECTOR,
                               ToolDisplayed.PORT_TYPES_VIEW,
                               ToolDisplayed.HIDDENS_BOX,
                               ToolDisplayed.ZOOM_SLIDER):
                        act.setEnabled(self.mng.alsa_midi_enabled)
                    else:
                        act.setEnabled(False)
            
            if self._jack_agnostic is JackAgnostic.FULL:
                if key in (ToolDisplayed.TRANSPORT_CLOCK,
                           ToolDisplayed.TRANSPORT_PLAY_STOP,
                           ToolDisplayed.TRANSPORT_TEMPO,
                           ToolDisplayed.BUFFER_SIZE,
                           ToolDisplayed.SAMPLERATE,
                           ToolDisplayed.LATENCY,
                           ToolDisplayed.XRUNS,
                           ToolDisplayed.DSP_LOAD):
                    continue
            
            menu.addAction(act)
            
            if key is ToolDisplayed.ZOOM_SLIDER:
                menu.addSeparator()
        
        return menu

    def set_patchbay_manager(self, mng: 'PatchbayManager'):
        self.mng = mng
        if self._canvas_wg is not None:
            self._canvas_wg.set_patchbay_manager(mng)
        if self._transport_wg is not None:
            self._transport_wg.set_patchbay_manager(mng)
        if self._jack_wg is not None:
            self._jack_wg.set_patchbay_manager(mng)
    
    def set_tool_bars(self, *tool_bars: 'PatchbayToolBar'):
        self.tbars = tool_bars

        if self._transport_wg is None:
            self._transport_wg = BarWidgetTransport(
                self.tbars[TBar.TRANSPORT])
        if self._jack_wg is None:
            self._jack_wg = BarWidgetJack(self.tbars[TBar.JACK])
        if self._canvas_wg is None:
            self._canvas_wg = BarWidgetCanvas(self.tbars[TBar.CANVAS])

        if self._text_with_icons is not TextWithIcons.NO:
            # evaluate main bar widths (with and without text beside icons)
            main_bar = self.tbars[TBar.MAIN]
            tool_button_style = main_bar.toolButtonStyle()
            main_bar.setToolButtonStyle(Qt.ToolButtonStyle.ToolButtonIconOnly)
            self._main_bar_little_width = main_bar.sizeHint().width()
            main_bar.setToolButtonStyle(Qt.ToolButtonStyle.ToolButtonTextBesideIcon)
            self._main_bar_large_width = main_bar.sizeHint().width()
            main_bar.setToolButtonStyle(tool_button_style)

        self.tbars[TBar.TRANSPORT].addWidget(self._transport_wg)        
        self.tbars[TBar.JACK].addWidget(self._jack_wg)
        self.tbars[TBar.CANVAS].addWidget(self._canvas_wg)

        for tbar in self.tbars:
            tbar.toggleViewAction().setEnabled(False)
            tbar.toggleViewAction().setVisible(False)
            tbar.menu_asked.connect(self._menu_asked)
    
    def change_text_with_icons(self, text_with_icons: TextWithIcons):
        if text_with_icons is self._text_with_icons:
            return
        
        self._text_with_icons = text_with_icons
        if self.tbars is None:
            return

        main_bar = self.tbars[TBar.MAIN]
        
        main_bar.setToolButtonStyle(Qt.ToolButtonStyle.ToolButtonIconOnly)
        self._main_bar_little_width = main_bar.sizeHint().width()
        
        main_bar.setToolButtonStyle(Qt.ToolButtonStyle.ToolButtonTextBesideIcon)
        self._main_bar_large_width = main_bar.sizeHint().width()
        
        self._resize_later()
    
    @Slot(QPoint)
    def _menu_asked(self, point: QPoint):
        context_actions = self._make_context_actions()
        menu = self._make_context_menu(context_actions)
        
        act_text_with_icons = QAction(
            QIcon.fromTheme('format-text-direction-symbolic'),
            _translate('tool_bar', 'Display text beside icons'))
        act_text_with_icons.setCheckable(True)
        act_text_with_icons.setChecked(
            self._text_with_icons is TextWithIcons.YES)

        if not self.no_text_with_icons_act:
            menu.addSeparator()
            menu.addAction(act_text_with_icons)
        
        selected_act = menu.exec(point)
        if selected_act is None:
            return

        if selected_act is act_text_with_icons:
            if act_text_with_icons.isChecked():
                self._text_with_icons = TextWithIcons.YES
            else:
                self._text_with_icons = TextWithIcons.NO

        for key, act in context_actions.items():
            if act is selected_act:
                if act.isChecked():
                    self._tools_displayed |= key
                else:
                    self._tools_displayed &= ~key
                    
        self.change_tools_displayed(self._tools_displayed)
    
    def set_jack_agnostic(self, agnostic: JackAgnostic):
        '''Use without any jack tool. Used by Patchichi.'''
        self._jack_agnostic = agnostic
        self.change_tools_displayed(self._tools_displayed)
    
    def change_tools_displayed(self, tools_displayed: ToolDisplayed):        
        self._tools_displayed = tools_displayed
        
        if (self._jack_agnostic is not JackAgnostic.FULL
                and not self._jack_running):
            if self.mng is not None:
                self.set_jack_running(
                    False, use_alsa_midi=self.mng.alsa_midi_enabled)
            return
        
        if self.tbars is None:
            return

        if self._canvas_wg is not None:
            self._canvas_wg.change_tools_displayed(tools_displayed)

        if self._transport_wg is not None:
            self._transport_wg.change_tools_displayed(tools_displayed)
            
        if self._jack_wg is not None:
            self._jack_wg.change_tools_displayed(tools_displayed)

        if self._jack_agnostic is JackAgnostic.FULL:
            if self._jack_wg is not None:
                self._jack_wg.setVisible(False)
            if self._transport_wg is not None:
                self._transport_wg.setVisible(False)
            
        elif self._jack_agnostic is JackAgnostic.DUMMY:
            if self._jack_wg is not None:
                self._jack_wg.set_jack_running(True)
                self._jack_wg.set_dsp_load(2)

        QTimer.singleShot(0, self._resize_later)        

    @Slot()
    def _resize_later(self):
        if self.mng is not None and self.mng.main_win is not None:
            self.main_win_resize(self.mng.main_win)

    def set_samplerate(self, samplerate: int):
        if self._jack_wg is not None:
            self._jack_wg.set_samplerate(samplerate)
        
        if self._transport_wg is not None:
            self._transport_wg.set_samplerate(samplerate)

    def set_buffer_size(self, buffer_size: int):
        if self._jack_wg is not None:
            self._jack_wg.set_buffer_size(buffer_size)

    def update_xruns(self):
        if self._jack_wg is not None:
            self._jack_wg.update_xruns()

    def add_xrun(self):
        if self._jack_wg is not None:
            self._jack_wg.add_xrun()

    def reset_xruns(self):
        if self._jack_wg is not None:
            self._jack_wg.reset_xruns()

    def set_dsp_load(self, dsp_load: int):
        if self._jack_wg is not None:
            self._jack_wg.set_dsp_load(dsp_load)

    def change_buffersize(self, buffersize: int):
        if self._jack_wg is not None:
            self._jack_wg.change_buffersize(buffersize)

    def refresh_transport(self, transport_pos: TransportPosition):
        if self._transport_wg is not None:
            self._transport_wg.refresh_transport(transport_pos)

    def set_jack_running(self, yesno: bool, use_alsa_midi=False):
        self._jack_running = yesno
        if self._transport_wg is not None:
            self._transport_wg.set_jack_running(yesno)
        if self._jack_wg is not None:
            self._jack_wg.set_jack_running(yesno)
        
        if yesno:
            self.change_tools_displayed(self._tools_displayed)

    def _canvas_is_last_of_line(self, layout: str) -> bool:
        for line in layout.split('_'):
            if line.endswith('C'):
                return True
        return False

    def _get_toolbars_layout(
            self, width: int, text_icons=TextWithIcons.AUTO) -> str:
        if self.tbars is None:
            return ''
        
        tbar_widths = [b.needed_width() for b in self.tbars]
        if text_icons is TextWithIcons.NO:
            tbar_widths[TBar.MAIN] = self._main_bar_little_width
        elif text_icons is TextWithIcons.YES:
            tbar_widths[TBar.MAIN] = self._main_bar_large_width
        
        m, t, j, c = tbar_widths
        # Main, Transport, Jack, Canvas
        # '_' for toolbarBreak (new line)

        if self._jack_agnostic is JackAgnostic.FULL:
            if width >= m + c:
                return 'MC'
            return 'M_C'
        
        if width >= sum(tbar_widths):
            return 'MCTJ'

        if width >= m + t + j:
            return 'MTJ_C'
        
        if width >= m + j:
            if width >= t + c:
                return 'MJ_CT'
            return 'MJ_T_C'
        
        if width >= c + t + j:
            return 'M_TJC'
        
        if width >= t + j:
            return 'M_TJ_C'
        
        if width >= t + c:
            return 'M_J_CT'
        
        return 'M_J_T_C'

    def main_win_resize(self, main_win: QMainWindow):
        if self.tbars is None:
            return
        
        self._last_win_width = main_win.width()
        
        if self._text_with_icons is TextWithIcons.AUTO:
            layout_little = self._get_toolbars_layout(
                self._last_win_width, TextWithIcons.NO)
            layout_large = self._get_toolbars_layout(
                self._last_win_width, TextWithIcons.YES)
            little_lines = len(layout_little.split('_'))
            large_lines = len(layout_large.split('_'))
            if little_lines < large_lines:
                layout = layout_little
                self.tbars[TBar.MAIN].setToolButtonStyle(
                    Qt.ToolButtonStyle.ToolButtonIconOnly)
            else:
                layout = layout_large
                if self._main_bar_large_width < self._last_win_width:
                    self.tbars[TBar.MAIN].setToolButtonStyle(
                        Qt.ToolButtonStyle.ToolButtonTextBesideIcon)
                else:
                    self.tbars[TBar.MAIN].setToolButtonStyle(
                        Qt.ToolButtonStyle.ToolButtonIconOnly)

        elif self._text_with_icons is TextWithIcons.YES:
            if (self._main_bar_large_width
                    > self._last_win_width):
                self.tbars[TBar.MAIN].setToolButtonStyle(
                    Qt.ToolButtonStyle.ToolButtonIconOnly)
            else:
                self.tbars[TBar.MAIN].setToolButtonStyle(
                    Qt.ToolButtonStyle.ToolButtonTextBesideIcon)
            layout = self._get_toolbars_layout(self._last_win_width)
        
        else:
            self.tbars[TBar.MAIN].setToolButtonStyle(
                Qt.ToolButtonStyle.ToolButtonIconOnly)
            layout = self._get_toolbars_layout(self._last_win_width)
            

        if (layout == self._last_layout):
            self._arrange_tool_bars()
            return
        
        self._last_layout = layout
        
        # add/remove spacer at right of canvas bar widget
        if self._canvas_wg is not None:
            self._canvas_wg.set_at_end_of_line(
                self._canvas_is_last_of_line(self._last_layout))
        
        self._arrange_tool_bars()
        
        visibles = [t.isVisible() for t in self.tbars]
        if (self._first_resize_done
                and visibles == [False, False, False, False]):
            return

        for toolbar in self.tbars:
            main_win.removeToolBar(toolbar)
        
        letter_bar = {'M': TBar.MAIN,
                      'T': TBar.TRANSPORT, 
                      'C': TBar.CANVAS,
                      'J': TBar.JACK}
        
        for letter in layout:
            if letter == '_':
                main_win.addToolBarBreak()
            elif letter in letter_bar:
                main_win.addToolBar(self.tbars[letter_bar[letter]])

        for i in range(len(self.tbars)):
            if (self._jack_agnostic is JackAgnostic.FULL
                    and i in (TBar.JACK, TBar.TRANSPORT)):
                continue

            self.tbars[i].setVisible(True)
        
        self._first_resize_done = True

    def _arrange_tool_bars(self):
        if self.tbars is None:
            return
        tbar_widths = [b.needed_width() for b in self.tbars]
        m, t, j, c = tbar_widths

        if self._last_layout in ('MCTJ', 'M_CTJ', 'MJ_CT'):            
            diff = self._last_win_width - t - c
            if self._last_layout in ('MCTJ', 'M_CTJ'):
                diff -= j
            if self._last_layout == 'MCTJ':
                diff -= m

            if diff > 0:
                self.tbars[TBar.CANVAS].set_min_width(c + int(diff * 1.0))
            else:
                for tbar in self.tbars:
                    tbar.set_min_width(None)
                    
        elif self._last_layout in ('MTJ_C', 'M_TJ_C'):
            diff = self._last_win_width - t - j
            if self._last_layout == 'MTJ_C':
                diff -= m
            
            if diff > 0:
                self.tbars[TBar.TRANSPORT].set_min_width(t + diff)
            else:
                for tbar in self.tbars:
                    tbar.set_min_width(None)

        else:
            for tbar in self.tbars:
                tbar.set_min_width(None)