forked from openlp/openlp
6ea4893ad6
Signed-off-by: Tim <tim.bentley@gmail.com>
1574 lines
73 KiB
Python
1574 lines
73 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
##########################################################################
|
|
# OpenLP - Open Source Lyrics Projection #
|
|
# ---------------------------------------------------------------------- #
|
|
# Copyright (c) 2008-2020 OpenLP Developers #
|
|
# ---------------------------------------------------------------------- #
|
|
# This program is free software: you can redistribute it and/or modify #
|
|
# it under the terms of the GNU General Public License as published by #
|
|
# the Free Software Foundation, either version 3 of the License, or #
|
|
# (at your option) any later version. #
|
|
# #
|
|
# This program is distributed in the hope that it will be useful, #
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of #
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
|
|
# GNU General Public License for more details. #
|
|
# #
|
|
# You should have received a copy of the GNU General Public License #
|
|
# along with this program. If not, see <https://www.gnu.org/licenses/>. #
|
|
##########################################################################
|
|
"""
|
|
The :mod:`slidecontroller` module contains the most important part of OpenLP - the slide controller
|
|
"""
|
|
import copy
|
|
import datetime
|
|
from collections import deque
|
|
from pathlib import Path
|
|
from threading import Lock
|
|
|
|
from PyQt5 import QtCore, QtGui, QtWidgets
|
|
|
|
from openlp.core.common import SlideLimits
|
|
from openlp.core.common.actions import ActionList, CategoryOrder
|
|
from openlp.core.common.i18n import UiStrings, translate
|
|
from openlp.core.common.mixins import LogMixin, RegistryProperties
|
|
from openlp.core.common.registry import Registry, RegistryBase
|
|
from openlp.core.display.screens import ScreenList
|
|
from openlp.core.display.window import DisplayWindow
|
|
from openlp.core.lib import ServiceItemAction, image_to_byte
|
|
from openlp.core.lib.serviceitem import ItemCapabilities
|
|
from openlp.core.lib.ui import create_action
|
|
from openlp.core.ui import DisplayControllerType, HideMode
|
|
from openlp.core.ui.icons import UiIcons
|
|
from openlp.core.widgets.layouts import AspectRatioLayout
|
|
from openlp.core.widgets.toolbar import OpenLPToolbar
|
|
from openlp.core.widgets.views import ListPreviewWidget
|
|
|
|
# Threshold which has to be trespassed to toggle.
|
|
HIDE_MENU_THRESHOLD = 27
|
|
|
|
NARROW_MENU = [
|
|
'hide_menu'
|
|
]
|
|
LOOP_LIST = [
|
|
'play_slides_menu',
|
|
'loop_separator',
|
|
'delay_spin_box'
|
|
]
|
|
WIDE_MENU = [
|
|
'blank_screen_button',
|
|
'theme_screen_button',
|
|
'desktop_screen_button'
|
|
]
|
|
|
|
NON_TEXT_MENU = [
|
|
'blank_screen_button',
|
|
'desktop_screen_button'
|
|
]
|
|
|
|
|
|
class MediaSlider(QtWidgets.QSlider):
|
|
"""
|
|
Allows the mouse events of a slider to be overridden and extra functionality added
|
|
"""
|
|
def __init__(self, direction, manager, controller):
|
|
"""
|
|
Constructor
|
|
"""
|
|
super(MediaSlider, self).__init__(direction)
|
|
self.manager = manager
|
|
self.controller = controller
|
|
|
|
def mouseMoveEvent(self, event):
|
|
"""
|
|
Override event to allow hover time to be displayed.
|
|
|
|
:param event: The triggering event
|
|
"""
|
|
time_value = QtWidgets.QStyle.sliderValueFromPosition(self.minimum(), self.maximum(), event.x(), self.width())
|
|
self.setToolTip('%s' % datetime.timedelta(seconds=int(time_value / 1000)))
|
|
QtWidgets.QSlider.mouseMoveEvent(self, event)
|
|
|
|
def mousePressEvent(self, event):
|
|
"""
|
|
Mouse Press event no new functionality
|
|
:param event: The triggering event
|
|
"""
|
|
QtWidgets.QSlider.mousePressEvent(self, event)
|
|
|
|
def mouseReleaseEvent(self, event):
|
|
"""
|
|
Set the slider position when the mouse is clicked and released on the slider.
|
|
|
|
:param event: The triggering event
|
|
"""
|
|
self.setValue(QtWidgets.QStyle.sliderValueFromPosition(self.minimum(), self.maximum(), event.x(), self.width()))
|
|
QtWidgets.QSlider.mouseReleaseEvent(self, event)
|
|
|
|
|
|
class InfoLabel(QtWidgets.QLabel):
|
|
"""
|
|
InfoLabel is a subclassed QLabel. Created to provide the ability to add a ellipsis if the text is cut off. Original
|
|
source: https://stackoverflow.com/questions/11446478/pyside-pyqt-truncate-text-in-qlabel-based-on-minimumsize
|
|
"""
|
|
|
|
def paintEvent(self, event):
|
|
"""
|
|
Reimplemented to allow the drawing of elided text if the text is longer than the width of the label
|
|
"""
|
|
painter = QtGui.QPainter(self)
|
|
metrics = QtGui.QFontMetrics(self.font())
|
|
elided = metrics.elidedText(self.text(), QtCore.Qt.ElideRight, self.width())
|
|
# If the text is elided align it left to stop it jittering as the label is resized
|
|
if elided == self.text():
|
|
alignment = QtCore.Qt.AlignCenter
|
|
else:
|
|
alignment = QtCore.Qt.AlignLeft
|
|
painter.drawText(self.rect(), alignment, elided)
|
|
|
|
def setText(self, text):
|
|
"""
|
|
Reimplemented to set the tool tip text.
|
|
"""
|
|
self.setToolTip(text)
|
|
super().setText(text)
|
|
|
|
|
|
class SlideController(QtWidgets.QWidget, LogMixin, RegistryProperties):
|
|
"""
|
|
SlideController is the slide controller widget. This widget is what the
|
|
user uses to control the displaying of verses/slides/etc on the screen.
|
|
"""
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
"""
|
|
Set up the Slide Controller.
|
|
"""
|
|
super().__init__(*args, **kwargs)
|
|
self.is_live = False
|
|
self.controller_type = None
|
|
self.displays = []
|
|
self.screens = ScreenList()
|
|
Registry().set_flag('has doubleclick added item to service', True)
|
|
Registry().set_flag('replace service manager item', False)
|
|
|
|
def post_set_up(self):
|
|
"""
|
|
Call by bootstrap functions
|
|
"""
|
|
self.initialise()
|
|
self.setup_displays()
|
|
self.screen_size_changed()
|
|
|
|
def setup_displays(self):
|
|
"""
|
|
Set up the display
|
|
"""
|
|
if not self.is_live:
|
|
return
|
|
if self.displays:
|
|
# Delete any existing displays
|
|
del self.displays[:]
|
|
for screen in self.screens:
|
|
if screen.is_display:
|
|
display = DisplayWindow(self, screen)
|
|
self.displays.append(display)
|
|
if self.display:
|
|
self.__add_actions_to_widget(self.display)
|
|
|
|
@property
|
|
def display(self):
|
|
return self.displays[0] if self.displays else None
|
|
|
|
def initialise(self):
|
|
"""
|
|
Initialise the UI elements of the controller
|
|
"""
|
|
try:
|
|
self.ratio = self.screens.current.display_geometry.width() / self.screens.current.display_geometry.height()
|
|
except ZeroDivisionError:
|
|
self.ratio = 1
|
|
self.process_queue_lock = Lock()
|
|
self.slide_selected_lock = Lock()
|
|
self.timer_id = 0
|
|
self.song_edit = False
|
|
self.selected_row = 0
|
|
self.service_item = None
|
|
self.slide_limits = None
|
|
self.update_slide_limits()
|
|
self.panel = QtWidgets.QWidget(self.main_window.control_splitter)
|
|
self.slide_list = {}
|
|
self.slide_count = 0
|
|
self.slide_image = None
|
|
self.controller_width = -1
|
|
# Layout for holding panel
|
|
self.panel_layout = QtWidgets.QVBoxLayout(self.panel)
|
|
self.panel_layout.setSpacing(0)
|
|
self.panel_layout.setContentsMargins(0, 0, 0, 0)
|
|
# Type label at the top of the slide controller
|
|
self.type_label = QtWidgets.QLabel(self.panel)
|
|
self.type_label.setStyleSheet('font-weight: bold; font-size: 12pt;')
|
|
self.type_label.setAlignment(QtCore.Qt.AlignCenter)
|
|
if self.is_live:
|
|
self.type_label.setText(UiStrings().Live)
|
|
else:
|
|
self.type_label.setText(UiStrings().Preview)
|
|
self.panel_layout.addWidget(self.type_label)
|
|
# Info label for the title of the current item, at the top of the slide controller
|
|
self.info_label = InfoLabel(self.panel)
|
|
self.info_label.setSizePolicy(QtWidgets.QSizePolicy.Ignored, QtWidgets.QSizePolicy.Preferred)
|
|
self.panel_layout.addWidget(self.info_label)
|
|
# Splitter
|
|
self.splitter = QtWidgets.QSplitter(self.panel)
|
|
self.splitter.setOrientation(QtCore.Qt.Vertical)
|
|
self.panel_layout.addWidget(self.splitter)
|
|
# Actual controller section
|
|
self.controller = QtWidgets.QWidget(self.splitter)
|
|
self.controller.setGeometry(QtCore.QRect(0, 0, 100, 536))
|
|
self.controller.setSizePolicy(QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Preferred,
|
|
QtWidgets.QSizePolicy.Maximum))
|
|
self.controller_layout = QtWidgets.QVBoxLayout(self.controller)
|
|
self.controller_layout.setSpacing(0)
|
|
self.controller_layout.setContentsMargins(0, 0, 0, 0)
|
|
# Controller list view
|
|
self.preview_widget = ListPreviewWidget(self, self.ratio)
|
|
self.controller_layout.addWidget(self.preview_widget)
|
|
# Build the full toolbar
|
|
self.toolbar = OpenLPToolbar(self)
|
|
size_toolbar_policy = QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Fixed, QtWidgets.QSizePolicy.Fixed)
|
|
size_toolbar_policy.setHorizontalStretch(0)
|
|
size_toolbar_policy.setVerticalStretch(0)
|
|
size_toolbar_policy.setHeightForWidth(self.toolbar.sizePolicy().hasHeightForWidth())
|
|
self.toolbar.setSizePolicy(size_toolbar_policy)
|
|
self.previous_item = create_action(self, 'previousItem_' + self.type_prefix,
|
|
text=translate('OpenLP.SlideController', 'Previous Slide'),
|
|
icon=UiIcons().arrow_left,
|
|
tooltip=translate('OpenLP.SlideController', 'Move to previous.'),
|
|
can_shortcuts=True, context=QtCore.Qt.WidgetWithChildrenShortcut,
|
|
category=self.category, triggers=self.on_slide_selected_previous)
|
|
self.toolbar.addAction(self.previous_item)
|
|
self.next_item = create_action(self, 'nextItem_' + self.type_prefix,
|
|
text=translate('OpenLP.SlideController', 'Next Slide'),
|
|
icon=UiIcons().arrow_right,
|
|
tooltip=translate('OpenLP.SlideController', 'Move to next.'),
|
|
can_shortcuts=True, context=QtCore.Qt.WidgetWithChildrenShortcut,
|
|
category=self.category, triggers=self.on_slide_selected_next_action)
|
|
self.toolbar.addAction(self.next_item)
|
|
self.toolbar.addSeparator()
|
|
self.controller_type = DisplayControllerType.Preview
|
|
if self.is_live:
|
|
self.controller_type = DisplayControllerType.Live
|
|
# Hide Menu
|
|
self.hide_menu = QtWidgets.QToolButton(self.toolbar)
|
|
self.hide_menu.setObjectName('hide_menu')
|
|
self.hide_menu.setText(translate('OpenLP.SlideController', 'Hide'))
|
|
self.hide_menu.setPopupMode(QtWidgets.QToolButton.MenuButtonPopup)
|
|
self.hide_menu.setMenu(QtWidgets.QMenu(translate('OpenLP.SlideController', 'Hide'), self.toolbar))
|
|
self.toolbar.add_toolbar_widget(self.hide_menu)
|
|
self.toolbar.add_toolbar_action('goPreview', icon=UiIcons().live,
|
|
tooltip=translate('OpenLP.SlideController', 'Move to preview.'),
|
|
triggers=self.on_go_preview)
|
|
# The order of the blank to modes in Shortcuts list comes from here.
|
|
self.desktop_screen_enable = create_action(self, 'desktopScreenEnable',
|
|
text=translate('OpenLP.SlideController', 'Show Desktop'),
|
|
icon=UiIcons().desktop, can_shortcuts=True,
|
|
context=QtCore.Qt.WidgetWithChildrenShortcut,
|
|
category=self.category, triggers=self.on_hide_display_enable)
|
|
self.desktop_screen = create_action(self, 'desktopScreen',
|
|
text=translate('OpenLP.SlideController', 'Toggle Desktop'),
|
|
icon=UiIcons().desktop,
|
|
checked=False, can_shortcuts=True, category=self.category,
|
|
triggers=self.on_hide_display)
|
|
self.theme_screen = create_action(self, 'themeScreen',
|
|
text=translate('OpenLP.SlideController', 'Toggle Blank to Theme'),
|
|
icon=UiIcons().blank_theme,
|
|
checked=False, can_shortcuts=True, category=self.category,
|
|
triggers=self.on_theme_display)
|
|
self.blank_screen = create_action(self, 'blankScreen',
|
|
text=translate('OpenLP.SlideController', 'Toggle Blank Screen'),
|
|
icon=UiIcons().blank,
|
|
checked=False, can_shortcuts=True, category=self.category,
|
|
triggers=self.on_blank_display)
|
|
self.hide_menu.setDefaultAction(self.blank_screen)
|
|
self.hide_menu.menu().addAction(self.blank_screen)
|
|
self.hide_menu.menu().addAction(self.theme_screen)
|
|
self.hide_menu.menu().addAction(self.desktop_screen)
|
|
self.hide_menu.menu().addAction(self.desktop_screen_enable)
|
|
# Wide menu of display control buttons.
|
|
self.blank_screen_button = QtWidgets.QToolButton(self.toolbar)
|
|
self.blank_screen_button.setObjectName('blank_screen_button')
|
|
self.toolbar.add_toolbar_widget(self.blank_screen_button)
|
|
self.blank_screen_button.setDefaultAction(self.blank_screen)
|
|
self.theme_screen_button = QtWidgets.QToolButton(self.toolbar)
|
|
self.theme_screen_button.setObjectName('theme_screen_button')
|
|
self.toolbar.add_toolbar_widget(self.theme_screen_button)
|
|
self.theme_screen_button.setDefaultAction(self.theme_screen)
|
|
self.desktop_screen_button = QtWidgets.QToolButton(self.toolbar)
|
|
self.desktop_screen_button.setObjectName('desktop_screen_button')
|
|
self.toolbar.add_toolbar_widget(self.desktop_screen_button)
|
|
self.desktop_screen_button.setDefaultAction(self.desktop_screen)
|
|
self.toolbar.add_toolbar_action('loop_separator', separator=True)
|
|
# Play Slides Menu
|
|
self.play_slides_menu = QtWidgets.QToolButton(self.toolbar)
|
|
self.play_slides_menu.setObjectName('play_slides_menu')
|
|
self.play_slides_menu.setText(translate('OpenLP.SlideController', 'Play Slides'))
|
|
self.play_slides_menu.setPopupMode(QtWidgets.QToolButton.MenuButtonPopup)
|
|
self.play_slides_menu.setMenu(QtWidgets.QMenu(translate('OpenLP.SlideController', 'Play Slides'),
|
|
self.toolbar))
|
|
self.toolbar.add_toolbar_widget(self.play_slides_menu)
|
|
self.play_slides_loop = create_action(self, 'playSlidesLoop', text=UiStrings().PlaySlidesInLoop,
|
|
icon=UiIcons().clock, checked=False, can_shortcuts=True,
|
|
category=self.category, triggers=self.on_play_slides_loop)
|
|
self.play_slides_once = create_action(self, 'playSlidesOnce', text=UiStrings().PlaySlidesToEnd,
|
|
icon=UiIcons().clock, checked=False, can_shortcuts=True,
|
|
category=self.category, triggers=self.on_play_slides_once)
|
|
if self.settings.value(self.main_window.advanced_settings_section + '/slide limits') == SlideLimits.Wrap:
|
|
self.play_slides_menu.setDefaultAction(self.play_slides_loop)
|
|
else:
|
|
self.play_slides_menu.setDefaultAction(self.play_slides_once)
|
|
self.play_slides_menu.menu().addAction(self.play_slides_loop)
|
|
self.play_slides_menu.menu().addAction(self.play_slides_once)
|
|
# Loop Delay Spinbox
|
|
self.delay_spin_box = QtWidgets.QSpinBox()
|
|
self.delay_spin_box.setObjectName('delay_spin_box')
|
|
self.delay_spin_box.setRange(1, 180)
|
|
self.delay_spin_box.setSuffix(' {unit}'.format(unit=UiStrings().Seconds))
|
|
self.delay_spin_box.setToolTip(translate('OpenLP.SlideController', 'Delay between slides in seconds.'))
|
|
self.receive_spin_delay()
|
|
self.toolbar.add_toolbar_widget(self.delay_spin_box)
|
|
else:
|
|
self.toolbar.add_toolbar_action('goLive', icon=UiIcons().live,
|
|
tooltip=translate('OpenLP.SlideController', 'Move to live.'),
|
|
triggers=self.on_go_live)
|
|
self.toolbar.add_toolbar_action('addToService', icon=UiIcons().add,
|
|
tooltip=translate('OpenLP.SlideController', 'Add to Service.'),
|
|
triggers=self.on_preview_add_to_service)
|
|
self.toolbar.addSeparator()
|
|
self.toolbar.add_toolbar_action('editSong', icon=UiIcons().edit,
|
|
tooltip=translate('OpenLP.SlideController',
|
|
'Edit and reload song preview.'),
|
|
triggers=self.on_edit_song)
|
|
self.toolbar.add_toolbar_action('clear', icon=UiIcons().delete,
|
|
tooltip=translate('OpenLP.SlideController',
|
|
'Clear'),
|
|
triggers=self.on_clear)
|
|
self.controller_layout.addWidget(self.toolbar)
|
|
# Build a Media ToolBar
|
|
self.mediabar = OpenLPToolbar(self)
|
|
self.mediabar.add_toolbar_action('playbackPlay', text='media_playback_play',
|
|
icon=UiIcons().play,
|
|
tooltip=translate('OpenLP.SlideController', 'Start playing media.'),
|
|
triggers=self.send_to_plugins)
|
|
self.mediabar.add_toolbar_action('playbackPause', text='media_playback_pause',
|
|
icon=UiIcons().pause,
|
|
tooltip=translate('OpenLP.SlideController', 'Pause playing media.'),
|
|
triggers=self.send_to_plugins)
|
|
self.mediabar.add_toolbar_action('playbackStop', text='media_playback_stop',
|
|
icon=UiIcons().stop,
|
|
tooltip=translate('OpenLP.SlideController', 'Stop playing media.'),
|
|
triggers=self.send_to_plugins)
|
|
self.mediabar.add_toolbar_action('playbackLoop', text='media_playback_loop',
|
|
icon=UiIcons().repeat, checked=False,
|
|
tooltip=translate('OpenLP.SlideController', 'Loop playing media.'),
|
|
triggers=self.send_to_plugins)
|
|
self.position_label = QtWidgets.QLabel()
|
|
self.position_label.setText(' 00:00 / 00:00')
|
|
self.position_label.setAlignment(QtCore.Qt.AlignRight | QtCore.Qt.AlignVCenter)
|
|
self.position_label.setToolTip(translate('OpenLP.SlideController', 'Video timer.'))
|
|
self.position_label.setMinimumSize(90, 0)
|
|
self.position_label.setObjectName('position_label')
|
|
self.mediabar.add_toolbar_widget(self.position_label)
|
|
# Build the media seek_slider.
|
|
self.seek_slider = MediaSlider(QtCore.Qt.Horizontal, self, self)
|
|
self.seek_slider.setMaximum(1000)
|
|
self.seek_slider.setTracking(True)
|
|
self.seek_slider.setMouseTracking(True)
|
|
self.seek_slider.setToolTip(translate('OpenLP.SlideController', 'Video position.'))
|
|
self.seek_slider.setGeometry(QtCore.QRect(90, 260, 221, 24))
|
|
self.seek_slider.setObjectName('seek_slider')
|
|
self.mediabar.add_toolbar_widget(self.seek_slider)
|
|
# Build the volume_slider.
|
|
self.volume_slider = QtWidgets.QSlider(QtCore.Qt.Horizontal)
|
|
self.volume_slider.setTickInterval(10)
|
|
self.volume_slider.setTickPosition(QtWidgets.QSlider.TicksAbove)
|
|
self.volume_slider.setMinimum(0)
|
|
self.volume_slider.setMaximum(100)
|
|
self.volume_slider.setTracking(True)
|
|
self.volume_slider.setToolTip(translate('OpenLP.SlideController', 'Audio Volume.'))
|
|
self.volume_slider.setGeometry(QtCore.QRect(90, 160, 221, 24))
|
|
self.volume_slider.setObjectName('volume_slider')
|
|
self.mediabar.add_toolbar_widget(self.volume_slider)
|
|
self.controller_layout.addWidget(self.mediabar)
|
|
self.mediabar.setVisible(False)
|
|
# Signals
|
|
self.seek_slider.valueChanged.connect(self.send_to_plugins)
|
|
self.volume_slider.valueChanged.connect(self.send_to_plugins)
|
|
if self.is_live:
|
|
# Build the Song Toolbar
|
|
self.song_menu = QtWidgets.QToolButton(self.toolbar)
|
|
self.song_menu.setObjectName('song_menu')
|
|
self.song_menu.setText(translate('OpenLP.SlideController', 'Go To'))
|
|
self.song_menu.setPopupMode(QtWidgets.QToolButton.InstantPopup)
|
|
self.song_menu.setMenu(QtWidgets.QMenu(translate('OpenLP.SlideController', 'Go To'), self.toolbar))
|
|
self.toolbar.add_toolbar_widget(self.song_menu)
|
|
self.toolbar.set_widget_visible('song_menu', False)
|
|
# Screen preview area
|
|
self.preview_frame = QtWidgets.QFrame(self.splitter)
|
|
self.preview_frame.setGeometry(QtCore.QRect(0, 0, 300, 300 * self.ratio))
|
|
self.preview_frame.setMinimumHeight(100)
|
|
self.preview_frame.setSizePolicy(QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Ignored,
|
|
QtWidgets.QSizePolicy.Ignored,
|
|
QtWidgets.QSizePolicy.Label))
|
|
self.preview_frame.setFrameShape(QtWidgets.QFrame.StyledPanel)
|
|
self.preview_frame.setFrameShadow(QtWidgets.QFrame.Sunken)
|
|
self.preview_frame.setObjectName('preview_frame')
|
|
self.slide_layout = AspectRatioLayout(self.preview_frame, self.ratio)
|
|
self.slide_layout.margin = 8
|
|
self.slide_layout.setSpacing(0)
|
|
self.slide_layout.setObjectName('SlideLayout')
|
|
# Set up the preview display
|
|
self.preview_display = DisplayWindow(self)
|
|
self.slide_layout.addWidget(self.preview_display)
|
|
self.slide_layout.resize.connect(self.on_preview_resize)
|
|
# Actual preview screen
|
|
if self.is_live:
|
|
self.current_shortcut = ''
|
|
self.shortcut_timer = QtCore.QTimer()
|
|
self.shortcut_timer.setObjectName('shortcut_timer')
|
|
self.shortcut_timer.setSingleShot(True)
|
|
shortcuts = [
|
|
{'key': 'V', 'configurable': True, 'text': translate('OpenLP.SlideController', 'Go to "Verse"')},
|
|
{'key': 'C', 'configurable': True, 'text': translate('OpenLP.SlideController', 'Go to "Chorus"')},
|
|
{'key': 'B', 'configurable': True, 'text': translate('OpenLP.SlideController', 'Go to "Bridge"')},
|
|
{'key': 'P', 'configurable': True,
|
|
'text': translate('OpenLP.SlideController', 'Go to "Pre-Chorus"')},
|
|
{'key': 'I', 'configurable': True, 'text': translate('OpenLP.SlideController', 'Go to "Intro"')},
|
|
{'key': 'E', 'configurable': True, 'text': translate('OpenLP.SlideController', 'Go to "Ending"')},
|
|
{'key': 'O', 'configurable': True, 'text': translate('OpenLP.SlideController', 'Go to "Other"')}
|
|
]
|
|
shortcuts.extend([{'key': str(number)} for number in range(10)])
|
|
self.controller.addActions([create_action(self, 'shortcutAction_{key}'.format(key=s['key']),
|
|
text=s.get('text'),
|
|
can_shortcuts=True,
|
|
context=QtCore.Qt.WidgetWithChildrenShortcut,
|
|
category=self.category if s.get('configurable') else None,
|
|
triggers=self._slide_shortcut_activated) for s in shortcuts])
|
|
self.shortcut_timer.timeout.connect(self._slide_shortcut_activated)
|
|
# Signals
|
|
self.preview_widget.clicked.connect(self.on_slide_selected)
|
|
self.preview_widget.verticalHeader().sectionClicked.connect(self.on_slide_selected)
|
|
if self.is_live:
|
|
# Need to use event as called across threads and UI is updated
|
|
self.slidecontroller_toggle_display.connect(self.toggle_display)
|
|
Registry().register_function('slidecontroller_live_spin_delay', self.receive_spin_delay)
|
|
self.toolbar.set_widget_visible(LOOP_LIST, False)
|
|
self.toolbar.set_widget_visible(WIDE_MENU, False)
|
|
self.set_live_hot_keys(self)
|
|
self.__add_actions_to_widget(self.controller)
|
|
else:
|
|
self.preview_widget.doubleClicked.connect(self.on_preview_double_click)
|
|
self.toolbar.set_widget_visible('editSong', False)
|
|
self.toolbar.set_widget_visible('clear', False)
|
|
self.controller.addActions([self.next_item, self.previous_item])
|
|
Registry().register_function('slidecontroller_{text}_stop_loop'.format(text=self.type_prefix),
|
|
self.on_stop_loop)
|
|
Registry().register_function('slidecontroller_{text}_change'.format(text=self.type_prefix),
|
|
self.on_slide_change)
|
|
Registry().register_function('slidecontroller_{text}_blank'.format(text=self.type_prefix),
|
|
self.on_slide_blank)
|
|
Registry().register_function('slidecontroller_{text}_unblank'.format(text=self.type_prefix),
|
|
self.on_slide_unblank)
|
|
Registry().register_function('slidecontroller_update_slide_limits', self.update_slide_limits)
|
|
getattr(self, 'slidecontroller_{text}_set'.format(text=self.type_prefix)).connect(self.on_slide_selected_index)
|
|
getattr(self, 'slidecontroller_{text}_next'.format(text=self.type_prefix)).connect(self.on_slide_selected_next)
|
|
# NOTE: {} used to keep line length < maxline
|
|
getattr(self,
|
|
'slidecontroller_{}_previous'.format(self.type_prefix)).connect(self.on_slide_selected_previous)
|
|
if self.is_live:
|
|
self.mediacontroller_live_play.connect(self.media_controller.on_media_play)
|
|
self.mediacontroller_live_pause.connect(self.media_controller.on_media_pause)
|
|
self.mediacontroller_live_stop.connect(self.media_controller.on_media_stop)
|
|
|
|
def _slide_shortcut_activated(self):
|
|
"""
|
|
Called, when a shortcut has been activated to jump to a chorus, verse, etc.
|
|
|
|
**Note**: This implementation is based on shortcuts. But it rather works like "key sequences". You have to
|
|
press one key after the other and **not** at the same time.
|
|
For example to jump to "V3" you have to press "V" and afterwards but within a time frame of 350ms
|
|
you have to press "3".
|
|
"""
|
|
try:
|
|
from openlp.plugins.songs.lib import VerseType
|
|
is_songs_plugin_available = True
|
|
except ImportError:
|
|
class VerseType(object):
|
|
"""
|
|
This empty class is mostly just to satisfy Python, PEP8 and PyCharm
|
|
"""
|
|
pass
|
|
|
|
is_songs_plugin_available = False
|
|
sender_name = self.sender().objectName()
|
|
verse_type = sender_name[15:] if sender_name[:15] == 'shortcutAction_' else ''
|
|
if is_songs_plugin_available:
|
|
if verse_type == 'V':
|
|
self.current_shortcut = VerseType.translated_tags[VerseType.Verse]
|
|
elif verse_type == 'C':
|
|
self.current_shortcut = VerseType.translated_tags[VerseType.Chorus]
|
|
elif verse_type == 'B':
|
|
self.current_shortcut = VerseType.translated_tags[VerseType.Bridge]
|
|
elif verse_type == 'P':
|
|
self.current_shortcut = VerseType.translated_tags[VerseType.PreChorus]
|
|
elif verse_type == 'I':
|
|
self.current_shortcut = VerseType.translated_tags[VerseType.Intro]
|
|
elif verse_type == 'E':
|
|
self.current_shortcut = VerseType.translated_tags[VerseType.Ending]
|
|
elif verse_type == 'O':
|
|
self.current_shortcut = VerseType.translated_tags[VerseType.Other]
|
|
elif verse_type.isnumeric():
|
|
self.current_shortcut += verse_type
|
|
self.current_shortcut = self.current_shortcut.upper()
|
|
elif verse_type.isnumeric():
|
|
self.current_shortcut += verse_type
|
|
elif verse_type:
|
|
self.current_shortcut = verse_type
|
|
keys = list(self.slide_list.keys())
|
|
matches = [match for match in keys if match.startswith(self.current_shortcut)]
|
|
if len(matches) == 1:
|
|
self.shortcut_timer.stop()
|
|
self.current_shortcut = ''
|
|
self.preview_widget.change_slide(self.slide_list[matches[0]])
|
|
self.slide_selected()
|
|
elif sender_name != 'shortcut_timer':
|
|
# Start the time as we did not have any match.
|
|
self.shortcut_timer.start(350)
|
|
else:
|
|
# The timer timed out.
|
|
if self.current_shortcut in keys:
|
|
# We had more than one match for example "V1" and "V10", but
|
|
# "V1" was the slide we wanted to go.
|
|
self.preview_widget.change_slide(self.slide_list[self.current_shortcut])
|
|
self.slide_selected()
|
|
# Reset the shortcut.
|
|
self.current_shortcut = ''
|
|
|
|
def send_to_plugins(self, *args):
|
|
"""
|
|
This is the generic function to send signal for control widgets, created from within other plugins
|
|
This function is needed to catch the current controller
|
|
|
|
:param args: Arguments to send to the plugins
|
|
"""
|
|
sender = self.sender().objectName() if self.sender().objectName() else self.sender().text()
|
|
controller = self
|
|
Registry().execute('{text}'.format(text=sender), [controller, args])
|
|
|
|
def set_live_hot_keys(self, parent=None):
|
|
"""
|
|
Set the live hotkeys
|
|
|
|
:param parent: The parent UI object for actions to be added to.
|
|
"""
|
|
self.previous_service = create_action(parent, 'previousService',
|
|
text=translate('OpenLP.SlideController', 'Previous Service'),
|
|
can_shortcuts=True, context=QtCore.Qt.WidgetWithChildrenShortcut,
|
|
category=self.category,
|
|
triggers=self.service_previous)
|
|
self.next_service = create_action(parent, 'nextService',
|
|
text=translate('OpenLP.SlideController', 'Next Service'),
|
|
can_shortcuts=True, context=QtCore.Qt.WidgetWithChildrenShortcut,
|
|
category=self.category,
|
|
triggers=self.service_next)
|
|
|
|
def toggle_display(self, action):
|
|
"""
|
|
Toggle the display settings triggered from remote messages.
|
|
|
|
:param action: The blank action to be processed.
|
|
"""
|
|
if action == 'blank' or action == 'hide':
|
|
self.on_blank_display(True)
|
|
elif action == 'theme':
|
|
self.on_theme_display(True)
|
|
elif action == 'desktop':
|
|
self.on_hide_display(True)
|
|
elif action == 'show':
|
|
self.on_blank_display(False)
|
|
self.on_theme_display(False)
|
|
self.on_hide_display(False)
|
|
|
|
def service_previous(self):
|
|
"""
|
|
Live event to select the previous service item from the service manager.
|
|
"""
|
|
self.keypress_queue.append(ServiceItemAction.Previous)
|
|
self._process_queue()
|
|
|
|
def service_next(self):
|
|
"""
|
|
Live event to select the next service item from the service manager.
|
|
"""
|
|
self.keypress_queue.append(ServiceItemAction.Next)
|
|
self._process_queue()
|
|
|
|
def _process_queue(self):
|
|
"""
|
|
Process the service item request queue. The key presses can arrive
|
|
faster than the processing so implement a FIFO queue.
|
|
"""
|
|
# Make sure only one thread get in here. Just return if already locked.
|
|
if self.keypress_queue and self.process_queue_lock.acquire(False):
|
|
while len(self.keypress_queue):
|
|
keypress_command = self.keypress_queue.popleft()
|
|
if keypress_command == ServiceItemAction.Previous:
|
|
self.service_manager.previous_item()
|
|
elif keypress_command == ServiceItemAction.PreviousLastSlide:
|
|
# Go to the last slide of the previous item
|
|
self.service_manager.previous_item(last_slide=True)
|
|
else:
|
|
self.service_manager.next_item()
|
|
self.process_queue_lock.release()
|
|
|
|
def screen_size_changed(self):
|
|
"""
|
|
Settings dialog has changed the screen size of adjust output and screen previews.
|
|
"""
|
|
if self.is_live and self.displays:
|
|
for display in self.displays:
|
|
display.resize(self.screens.current.display_geometry.size())
|
|
|
|
def __add_actions_to_widget(self, widget):
|
|
"""
|
|
Add actions to the widget specified by `widget`
|
|
This defines the controls available when Live display has stolen focus.
|
|
Examples of this happening: Clicking anything in the live window or certain single screen mode scenarios.
|
|
Needles to say, blank to modes should not be removed from here.
|
|
For some reason this required a test. It may be found in test_slidecontroller.py as
|
|
"live_stolen_focus_shortcuts_test. If you want to modify things here, you must also modify them there. (Duh)
|
|
|
|
:param widget: The UI widget for the actions
|
|
"""
|
|
widget.addActions([
|
|
self.previous_item, self.next_item,
|
|
self.previous_service, self.next_service,
|
|
self.desktop_screen_enable,
|
|
self.desktop_screen,
|
|
self.theme_screen,
|
|
self.blank_screen])
|
|
|
|
def on_controller_size_changed(self, width):
|
|
"""
|
|
Change layout of display control buttons on controller size change
|
|
|
|
:param width: the new width of the display
|
|
"""
|
|
if self.is_live:
|
|
# Space used by the toolbar.
|
|
used_space = self.toolbar.size().width() + self.hide_menu.size().width()
|
|
# Add the threshold to prevent flickering.
|
|
if width > used_space + HIDE_MENU_THRESHOLD and self.hide_menu.isVisible():
|
|
self.toolbar.set_widget_visible(NARROW_MENU, False)
|
|
self.set_blank_menu()
|
|
# Take away a threshold to prevent flickering.
|
|
elif width < used_space - HIDE_MENU_THRESHOLD and not self.hide_menu.isVisible():
|
|
self.set_blank_menu(False)
|
|
self.toolbar.set_widget_visible(NARROW_MENU)
|
|
# Fallback to the standard blank toolbar if the hide_menu is not visible.
|
|
elif not self.hide_menu.isVisible():
|
|
self.toolbar.set_widget_visible(NARROW_MENU, False)
|
|
self.set_blank_menu()
|
|
|
|
def set_blank_menu(self, visible=True):
|
|
"""
|
|
Set the correct menu type dependent on the service item type
|
|
|
|
:param visible: Do I need to hide the menu?
|
|
"""
|
|
self.toolbar.set_widget_visible(WIDE_MENU, False)
|
|
if self.service_item and self.service_item.is_text():
|
|
self.toolbar.set_widget_visible(WIDE_MENU, visible)
|
|
else:
|
|
self.toolbar.set_widget_visible(NON_TEXT_MENU, visible)
|
|
|
|
def receive_spin_delay(self):
|
|
"""
|
|
Adjusts the value of the ``delay_spin_box`` to the given one.
|
|
"""
|
|
self.delay_spin_box.setValue(self.settings.value('core/loop delay'))
|
|
|
|
def update_slide_limits(self):
|
|
"""
|
|
Updates the Slide Limits variable from the settings.
|
|
"""
|
|
self.slide_limits = self.settings.value(self.main_window.advanced_settings_section + '/slide limits')
|
|
|
|
def enable_tool_bar(self, item):
|
|
"""
|
|
Allows the toolbars to be reconfigured based on Controller Type and ServiceItem Type
|
|
|
|
:param item: current service item being processed
|
|
"""
|
|
if self.is_live:
|
|
self.enable_live_tool_bar(item)
|
|
else:
|
|
self.enable_preview_tool_bar(item)
|
|
|
|
def enable_live_tool_bar(self, item):
|
|
"""
|
|
Allows the live toolbar to be customised
|
|
|
|
:param item: The current service item
|
|
"""
|
|
# Work-around for OS X, hide and then show the toolbar
|
|
# See bug #791050
|
|
self.toolbar.hide()
|
|
self.mediabar.hide()
|
|
self.song_menu.hide()
|
|
self.toolbar.set_widget_visible(LOOP_LIST, False)
|
|
self.toolbar.set_widget_visible('song_menu', False)
|
|
# Reset the button
|
|
self.play_slides_once.setChecked(False)
|
|
self.play_slides_once.setIcon(UiIcons().clock)
|
|
self.play_slides_once.setText(UiStrings().PlaySlidesToEnd)
|
|
self.play_slides_loop.setChecked(False)
|
|
self.play_slides_loop.setIcon(UiIcons().clock)
|
|
self.play_slides_loop.setText(UiStrings().PlaySlidesInLoop)
|
|
if item.is_text():
|
|
if (self.settings.value(self.main_window.songs_settings_section + '/display songbar') and
|
|
not self.song_menu.menu().isEmpty()):
|
|
self.toolbar.set_widget_visible('song_menu', True)
|
|
if item.is_capable(ItemCapabilities.CanLoop) and len(item.slides) > 1:
|
|
self.toolbar.set_widget_visible(LOOP_LIST)
|
|
if item.is_media() or item.is_capable(ItemCapabilities.HasBackgroundAudio):
|
|
self.mediabar.show()
|
|
self.previous_item.setVisible(not item.is_media())
|
|
self.next_item.setVisible(not item.is_media())
|
|
# The layout of the toolbar is size dependent, so make sure it fits. Reset stored controller_width.
|
|
if self.is_live:
|
|
self.controller_width = -1
|
|
self.on_controller_size_changed(self.controller.width())
|
|
# Work-around for OS X, hide and then show the toolbar
|
|
# See bug #791050
|
|
self.toolbar.show()
|
|
|
|
def enable_preview_tool_bar(self, item):
|
|
"""
|
|
Allows the Preview toolbar to be customised
|
|
|
|
:param item: The current service item
|
|
"""
|
|
# Work-around for OS X, hide and then show the toolbar
|
|
# See bug #791050
|
|
self.toolbar.hide()
|
|
self.mediabar.hide()
|
|
self.toolbar.set_widget_visible('editSong', False)
|
|
self.toolbar.set_widget_visible('clear', True)
|
|
if item.is_capable(ItemCapabilities.CanEdit) and item.from_plugin:
|
|
self.toolbar.set_widget_visible('editSong')
|
|
elif item.is_media():
|
|
self.mediabar.show()
|
|
self.previous_item.setVisible(not item.is_media())
|
|
self.next_item.setVisible(not item.is_media())
|
|
# Work-around for OS X, hide and then show the toolbar
|
|
# See bug #791050
|
|
self.toolbar.show()
|
|
|
|
def refresh_service_item(self):
|
|
"""
|
|
Method to update the service item if the screen has changed
|
|
"""
|
|
if self.service_item.is_text() or self.service_item.is_image():
|
|
item = self.service_item
|
|
item.render()
|
|
self._process_item(item, self.selected_row)
|
|
|
|
def add_service_item(self, item):
|
|
"""
|
|
Method to install the service item into the controller
|
|
Called by plugins
|
|
|
|
:param item: The current service item
|
|
"""
|
|
slide_no = 0
|
|
if self.song_edit:
|
|
slide_no = self.selected_row
|
|
self.song_edit = False
|
|
self._process_item(item, slide_no)
|
|
|
|
def replace_service_manager_item(self, item):
|
|
"""
|
|
Replacement item following a remote edit.
|
|
This action also takes place when a song that is sent to live from Service Manager is edited.
|
|
|
|
:param item: The current service item
|
|
"""
|
|
if item == self.service_item:
|
|
Registry().set_flag('replace service manager item', True)
|
|
self._process_item(item, self.preview_widget.current_slide_number())
|
|
Registry().set_flag('replace service manager item', False)
|
|
|
|
def add_service_manager_item(self, item, slide_no):
|
|
"""
|
|
Method to install the service item into the controller and request the correct toolbar for the plugin. Called by
|
|
:class:`~openlp.core.ui.servicemanager.ServiceManager`
|
|
|
|
:param item: The current service item
|
|
:param slide_no: The slide number to select
|
|
"""
|
|
# If no valid slide number is specified we take the first one, but we remember the initial value to see if we
|
|
# should reload the song or not
|
|
slide_num = slide_no
|
|
if slide_no == -1:
|
|
slide_num = 0
|
|
# If service item is the same as the current one, only change slide
|
|
if slide_no >= 0 and item == self.service_item:
|
|
self.preview_widget.change_slide(slide_num)
|
|
self.slide_selected()
|
|
else:
|
|
self._process_item(item, slide_num)
|
|
if self.is_live and item.auto_play_slides_loop and item.timed_slide_interval > 0:
|
|
self.play_slides_loop.setChecked(item.auto_play_slides_loop)
|
|
self.delay_spin_box.setValue(int(item.timed_slide_interval))
|
|
self.on_play_slides_loop()
|
|
elif self.is_live and item.auto_play_slides_once and item.timed_slide_interval > 0:
|
|
self.play_slides_once.setChecked(item.auto_play_slides_once)
|
|
self.delay_spin_box.setValue(int(item.timed_slide_interval))
|
|
self.on_play_slides_once()
|
|
|
|
def _process_item(self, service_item, slide_no):
|
|
"""
|
|
Loads a ServiceItem into the system from ServiceManager. Display the slide number passed.
|
|
|
|
:param service_item: The current service item
|
|
:param slide_no: The slide number to select
|
|
"""
|
|
self.on_stop_loop()
|
|
old_item = self.service_item
|
|
# rest to allow the remote pick up verse 1 if large imaged
|
|
self.selected_row = 0
|
|
self.preview_display.go_to_slide(0)
|
|
# take a copy not a link to the servicemanager copy.
|
|
self.service_item = copy.copy(service_item)
|
|
if self.service_item.is_command():
|
|
Registry().execute(
|
|
'{text}_start'.format(text=service_item.name.lower()),
|
|
[self.service_item, self.is_live, self.hide_mode(), slide_no])
|
|
else:
|
|
# Get theme
|
|
theme_data = service_item.get_theme_data()
|
|
# Set theme for preview
|
|
self.preview_display.set_theme(theme_data)
|
|
# Set theme for displays
|
|
for display in self.displays:
|
|
display.set_theme(theme_data)
|
|
|
|
# Reset blanking if needed
|
|
if old_item and self.is_live and (old_item.is_capable(ItemCapabilities.ProvidesOwnDisplay) or
|
|
self.service_item.is_capable(ItemCapabilities.ProvidesOwnDisplay)):
|
|
self._reset_blank(self.service_item.is_capable(ItemCapabilities.ProvidesOwnDisplay))
|
|
self.info_label.setText(self.service_item.title)
|
|
self.slide_list = {}
|
|
if old_item and old_item.is_capable(ItemCapabilities.HasBackgroundAudio):
|
|
self.on_media_close()
|
|
if self.is_live:
|
|
self.song_menu.menu().clear()
|
|
if self.service_item.is_capable(ItemCapabilities.HasBackgroundAudio):
|
|
self.on_media_start(service_item)
|
|
row = 0
|
|
width = self.main_window.control_splitter.sizes()[self.split]
|
|
if self.service_item.is_text():
|
|
self.preview_display.load_verses(service_item.rendered_slides)
|
|
self.preview_display.show()
|
|
for display in self.displays:
|
|
display.load_verses(service_item.rendered_slides)
|
|
for slide_index, slide in enumerate(self.service_item.display_slides):
|
|
if not slide['verse'].isdigit():
|
|
# These tags are already translated.
|
|
verse_def = slide['verse']
|
|
verse_def = '{def1}{def2}'.format(def1=verse_def[0], def2=verse_def[1:])
|
|
two_line_def = '{def1}\n{def2}'.format(def1=verse_def[0], def2=verse_def[1:])
|
|
row = two_line_def
|
|
if verse_def not in self.slide_list:
|
|
self.slide_list[verse_def] = slide_index
|
|
if self.is_live:
|
|
self.song_menu.menu().addAction(verse_def, self.on_song_bar_handler)
|
|
else:
|
|
row += 1
|
|
self.slide_list[str(row)] = row - 1
|
|
else:
|
|
if service_item.is_image():
|
|
self.preview_display.load_images(service_item.slides)
|
|
for display in self.displays:
|
|
display.load_images(service_item.slides)
|
|
for slide_index, slide in enumerate(self.service_item.slides):
|
|
row += 1
|
|
self.slide_list[str(row)] = row - 1
|
|
self.preview_widget.replace_service_item(self.service_item, width, slide_no)
|
|
self.enable_tool_bar(self.service_item)
|
|
if self.service_item.is_media():
|
|
self.on_media_start(self.service_item)
|
|
self.slide_selected(True)
|
|
if self.service_item.from_service:
|
|
self.preview_widget.setFocus()
|
|
if old_item:
|
|
# Close the old item after the new one is opened
|
|
# This avoids the service theme/desktop flashing on screen
|
|
# However opening a new item of the same type will automatically
|
|
# close the previous, so make sure we don't close the new one.
|
|
if old_item.is_command() and not self.service_item.is_command() or \
|
|
old_item.is_command() and not old_item.is_media() and self.service_item.is_media():
|
|
Registry().execute('{name}_stop'.format(name=old_item.name.lower()), [old_item, self.is_live])
|
|
if old_item.is_media() and not self.service_item.is_media():
|
|
self.on_media_close()
|
|
if self.is_live:
|
|
Registry().execute('slidecontroller_{item}_started'.format(item=self.type_prefix), [self.service_item])
|
|
|
|
def on_slide_selected_index(self, message):
|
|
"""
|
|
Go to the requested slide
|
|
|
|
:param message: remote message to be processed.
|
|
"""
|
|
index = int(message[0])
|
|
if not self.service_item:
|
|
return
|
|
if self.service_item.is_command():
|
|
Registry().execute('{name}_slide'.format(name=self.service_item.name.lower()),
|
|
[self.service_item, self.is_live, index])
|
|
self.update_preview()
|
|
self.selected_row = index
|
|
else:
|
|
self.preview_widget.change_slide(index)
|
|
self.slide_selected()
|
|
|
|
def on_song_bar_handler(self):
|
|
"""
|
|
Some song handler
|
|
"""
|
|
request = self.sender().text()
|
|
slide_no = self.slide_list[request]
|
|
width = self.main_window.control_splitter.sizes()[self.split]
|
|
self.preview_widget.replace_service_item(self.service_item, width, slide_no)
|
|
self.slide_selected()
|
|
|
|
def on_preview_resize(self, size):
|
|
"""
|
|
Set the preview display's zoom factor based on the size relative to the display size
|
|
"""
|
|
display_with = 0
|
|
for screen in self.screens:
|
|
if screen.is_display:
|
|
display_with = screen.display_geometry.width()
|
|
if display_with == 0:
|
|
ratio = 0.25
|
|
else:
|
|
ratio = float(size.width()) / display_with
|
|
self.preview_display.set_scale(ratio)
|
|
|
|
def main_display_set_background(self):
|
|
"""
|
|
Allow the main display to blank the main display at startup time
|
|
"""
|
|
# display_type = Settings().value(self.main_window.general_settings_section + '/screen blank')
|
|
# if self.screens.which_screen(self.window()) != self.screens.which_screen(self.display):
|
|
# # Order done to handle initial conversion
|
|
# if display_type == 'themed':
|
|
# self.on_theme_display(True)
|
|
# elif display_type == 'hidden':
|
|
# self.on_hide_display(True)
|
|
# elif display_type == 'blanked':
|
|
# self.on_blank_display(True)
|
|
# else:
|
|
# Registry().execute('live_display_show')
|
|
# else:
|
|
# self.on_hide_display_enable()
|
|
|
|
def on_slide_blank(self):
|
|
"""
|
|
Handle the slidecontroller blank event
|
|
"""
|
|
self.on_blank_display(True)
|
|
|
|
def on_slide_unblank(self):
|
|
"""
|
|
Handle the slidecontroller unblank event.
|
|
"""
|
|
if not Registry().get_flag('replace service manager item') is True:
|
|
self.on_blank_display(False)
|
|
|
|
def on_blank_display(self, checked=None):
|
|
"""
|
|
Handle the blank screen button actions
|
|
|
|
:param checked: the new state of the of the widget
|
|
"""
|
|
if checked is None:
|
|
checked = self.blank_screen.isChecked()
|
|
self.log_debug('on_blank_display {text}'.format(text=checked))
|
|
self.hide_menu.setDefaultAction(self.blank_screen)
|
|
self.blank_screen.setChecked(checked)
|
|
self.theme_screen.setChecked(False)
|
|
self.desktop_screen.setChecked(False)
|
|
if checked:
|
|
self.settings.setValue(self.main_window.general_settings_section + '/screen blank', 'blanked')
|
|
else:
|
|
self.settings.remove(self.main_window.general_settings_section + '/screen blank')
|
|
self.blank_plugin()
|
|
self.update_preview()
|
|
self.on_toggle_loop()
|
|
|
|
def on_theme_display(self, checked=None):
|
|
"""
|
|
Handle the Theme screen button
|
|
|
|
:param checked: the new state of the of the widget
|
|
"""
|
|
if checked is None:
|
|
checked = self.theme_screen.isChecked()
|
|
self.log_debug('on_theme_display {text}'.format(text=checked))
|
|
self.hide_menu.setDefaultAction(self.theme_screen)
|
|
self.blank_screen.setChecked(False)
|
|
self.theme_screen.setChecked(checked)
|
|
self.desktop_screen.setChecked(False)
|
|
if checked:
|
|
self.settings.setValue(self.main_window.general_settings_section + '/screen blank', 'themed')
|
|
else:
|
|
self.settings.remove(self.main_window.general_settings_section + '/screen blank')
|
|
self.blank_plugin()
|
|
self.update_preview()
|
|
self.on_toggle_loop()
|
|
|
|
def on_hide_display(self, checked=None):
|
|
"""
|
|
Handle the Hide screen button
|
|
This toggles the desktop screen.
|
|
|
|
:param checked: the new state of the of the widget
|
|
"""
|
|
if checked is None:
|
|
checked = self.desktop_screen.isChecked()
|
|
self.log_debug('on_hide_display {text}'.format(text=checked))
|
|
self.hide_menu.setDefaultAction(self.desktop_screen)
|
|
self.blank_screen.setChecked(False)
|
|
self.theme_screen.setChecked(False)
|
|
self.desktop_screen.setChecked(checked)
|
|
if checked:
|
|
self.settings.setValue(self.main_window.general_settings_section + '/screen blank', 'hidden')
|
|
else:
|
|
self.settings.remove(self.main_window.general_settings_section + '/screen blank')
|
|
self.hide_plugin(checked)
|
|
self.update_preview()
|
|
self.on_toggle_loop()
|
|
|
|
def on_hide_display_enable(self, checked=None):
|
|
"""
|
|
Handle the on_hide_display_enable
|
|
This only enables the desktop screen.
|
|
|
|
:param checked: the new state of the of the widget
|
|
"""
|
|
self.blank_screen.setChecked(False)
|
|
self.theme_screen.setChecked(False)
|
|
Registry().execute('live_display_hide', HideMode.Screen)
|
|
self.desktop_screen.setChecked(True)
|
|
self.update_preview()
|
|
self.on_toggle_loop()
|
|
|
|
def blank_plugin(self):
|
|
"""
|
|
Blank/Hide the display screen within a plugin if required.
|
|
"""
|
|
hide_mode = self.hide_mode()
|
|
self.log_debug('blank_plugin {text}'.format(text=hide_mode))
|
|
if self.service_item is not None:
|
|
if hide_mode:
|
|
if not self.service_item.is_command():
|
|
Registry().execute('live_display_hide', hide_mode)
|
|
Registry().execute('{text}_blank'.format(text=self.service_item.name.lower()),
|
|
[self.service_item, self.is_live, hide_mode])
|
|
else:
|
|
if not self.service_item.is_command():
|
|
Registry().execute('live_display_show')
|
|
Registry().execute('{text}_unblank'.format(text=self.service_item.name.lower()),
|
|
[self.service_item, self.is_live])
|
|
else:
|
|
if hide_mode:
|
|
Registry().execute('live_display_hide', hide_mode)
|
|
else:
|
|
Registry().execute('live_display_show')
|
|
|
|
def hide_plugin(self, hide):
|
|
"""
|
|
Tell the plugin to hide the display screen.
|
|
"""
|
|
self.log_debug('hide_plugin {text}'.format(text=hide))
|
|
if self.service_item is not None:
|
|
if hide:
|
|
Registry().execute('live_display_hide', HideMode.Screen)
|
|
Registry().execute('{text}_hide'.format(text=self.service_item.name.lower()),
|
|
[self.service_item, self.is_live])
|
|
else:
|
|
if not self.service_item.is_command():
|
|
Registry().execute('live_display_show')
|
|
Registry().execute('{text}_unblank'.format(text=self.service_item.name.lower()),
|
|
[self.service_item, self.is_live])
|
|
else:
|
|
if hide:
|
|
Registry().execute('live_display_hide', HideMode.Screen)
|
|
else:
|
|
Registry().execute('live_display_show')
|
|
|
|
def on_slide_selected(self):
|
|
"""
|
|
Slide selected in controller
|
|
Note for some reason a dummy field is required. Nothing is passed!
|
|
"""
|
|
self.slide_selected()
|
|
|
|
def slide_selected(self, start=False):
|
|
"""
|
|
Generate the preview when you click on a slide. If this is the Live Controller also display on the screen
|
|
|
|
:param start:
|
|
"""
|
|
# Only one thread should be in here at the time. If already locked just skip, since the update will be
|
|
# done by the thread holding the lock. If it is a "start" slide, we must wait for the lock, but only for 0.2
|
|
# seconds, since we don't want to cause a deadlock
|
|
timeout = 0.2 if start else -1
|
|
if not self.slide_selected_lock.acquire(start, timeout):
|
|
if start:
|
|
self.log_debug('Could not get lock in slide_selected after waiting %f, skip to avoid deadlock.'
|
|
% timeout)
|
|
return
|
|
# If "click live slide to unblank" is enabled, unblank the display. And start = Item is sent to Live.
|
|
# Note: If this if statement is placed at the bottom of this function instead of top slide transitions are lost.
|
|
if self.is_live and self.settings.value('core/click live slide to unblank'):
|
|
if not start:
|
|
Registry().execute('slidecontroller_live_unblank')
|
|
row = self.preview_widget.current_slide_number()
|
|
# old_selected_row = self.selected_row
|
|
self.selected_row = 0
|
|
if -1 < row < self.preview_widget.slide_count():
|
|
if self.service_item.is_command():
|
|
if self.is_live and not start:
|
|
Registry().execute('{text}_slide'.format(text=self.service_item.name.lower()),
|
|
[self.service_item, self.is_live, row])
|
|
else:
|
|
# to_display = self.service_item.get_rendered_frame(row)
|
|
if self.service_item.is_text():
|
|
for display in self.displays:
|
|
display.go_to_slide(row)
|
|
# self.display.text(to_display, row != old_selected_row)
|
|
else:
|
|
if start:
|
|
for display in self.displays:
|
|
display.load_images(self.service_item.slides)
|
|
# self.display.build_html(self.service_item, to_display)
|
|
else:
|
|
for display in self.displays:
|
|
display.go_to_slide(row)
|
|
# self.display.image(to_display)
|
|
# reset the store used to display first image
|
|
self.service_item.bg_image_bytes = None
|
|
self.selected_row = row
|
|
self.update_preview()
|
|
self.preview_widget.change_slide(row)
|
|
# TODO: self.display.setFocus()
|
|
# Release lock
|
|
self.slide_selected_lock.release()
|
|
|
|
def on_slide_change(self, row):
|
|
"""
|
|
The slide has been changed. Update the slidecontroller accordingly
|
|
|
|
:param row: Row to be selected
|
|
"""
|
|
self.preview_widget.change_slide(row)
|
|
self.update_preview()
|
|
self.selected_row = row
|
|
|
|
def update_preview(self):
|
|
"""
|
|
This updates the preview frame, for example after changing a slide or using *Blank to Theme*.
|
|
"""
|
|
self.log_debug('update_preview {text} '.format(text=self.screens.current))
|
|
if self.service_item and self.service_item.is_capable(ItemCapabilities.ProvidesOwnDisplay):
|
|
if self.is_live:
|
|
# If live, grab screen-cap of main display now
|
|
QtCore.QTimer.singleShot(500, self.grab_maindisplay)
|
|
# but take another in a couple of seconds in case slide change is slow
|
|
QtCore.QTimer.singleShot(2500, self.grab_maindisplay)
|
|
else:
|
|
# If not live, use the slide's thumbnail/icon instead
|
|
image_path = Path(self.service_item.get_rendered_frame(self.selected_row))
|
|
# if self.service_item.is_capable(ItemCapabilities.HasThumbnails):
|
|
# image = self.image_manager.get_image(image_path, ImageSource.CommandPlugins)
|
|
# self.slide_image = QtGui.QPixmap.fromImage(image)
|
|
# else:
|
|
# self.slide_image = QtGui.QPixmap(image_path)
|
|
# self.slide_image.setDevicePixelRatio(self.main_window.devicePixelRatio())
|
|
# self.slide_preview.setPixmap(self.slide_image)
|
|
self.preview_display.set_single_image('#000', image_path)
|
|
else:
|
|
self.preview_display.go_to_slide(self.selected_row)
|
|
self.slide_count += 1
|
|
|
|
def grab_maindisplay(self):
|
|
"""
|
|
Creates an image of the current screen and updates the preview frame.
|
|
"""
|
|
win_id = QtWidgets.QApplication.desktop().winId()
|
|
screen = QtWidgets.QApplication.primaryScreen()
|
|
rect = ScreenList().current.display_geometry
|
|
win_image = screen.grabWindow(win_id, rect.x(), rect.y(), rect.width(), rect.height())
|
|
win_image.setDevicePixelRatio(self.preview_display.devicePixelRatio())
|
|
# self.slide_preview.setPixmap(win_image)
|
|
self.slide_image = win_image
|
|
base64_image = image_to_byte(win_image, True)
|
|
self.preview_display.set_single_image_data('#000', base64_image)
|
|
|
|
def on_slide_selected_next_action(self, checked):
|
|
"""
|
|
Wrapper function from create_action so we can throw away the incorrect parameter
|
|
|
|
:param checked: the new state of the of the widget
|
|
"""
|
|
self.on_slide_selected_next()
|
|
|
|
def on_slide_selected_next(self, wrap=None):
|
|
"""
|
|
Go to the next slide.
|
|
|
|
:param wrap: Are we wrapping round the service item
|
|
"""
|
|
if not self.service_item:
|
|
return
|
|
if self.service_item.is_command():
|
|
past_end = Registry().execute('{text}_next'.format(text=self.service_item.name.lower()),
|
|
[self.service_item, self.is_live])
|
|
# Check if we have gone past the end of the last slide
|
|
if self.is_live and past_end and past_end[0]:
|
|
if wrap is None:
|
|
if self.slide_limits == SlideLimits.Wrap:
|
|
self.on_slide_selected_index([0])
|
|
elif self.is_live and self.slide_limits == SlideLimits.Next:
|
|
self.service_next()
|
|
elif wrap:
|
|
self.on_slide_selected_index([0])
|
|
elif self.is_live:
|
|
self.update_preview()
|
|
else:
|
|
row = self.preview_widget.current_slide_number() + 1
|
|
if row == self.preview_widget.slide_count():
|
|
if wrap is None:
|
|
if self.slide_limits == SlideLimits.Wrap:
|
|
row = 0
|
|
elif self.is_live and self.slide_limits == SlideLimits.Next:
|
|
self.service_next()
|
|
return
|
|
else:
|
|
row = self.preview_widget.slide_count() - 1
|
|
elif wrap:
|
|
row = 0
|
|
else:
|
|
row = self.preview_widget.slide_count() - 1
|
|
self.preview_widget.change_slide(row)
|
|
self.slide_selected()
|
|
|
|
def on_slide_selected_previous(self):
|
|
"""
|
|
Go to the previous slide.
|
|
"""
|
|
if not self.service_item:
|
|
return
|
|
if self.service_item.is_command():
|
|
before_start = Registry().execute('{text}_previous'.format(text=self.service_item.name.lower()),
|
|
[self.service_item, self.is_live])
|
|
# Check id we have tried to go before that start slide
|
|
if self.is_live and before_start and before_start[0]:
|
|
if self.slide_limits == SlideLimits.Wrap:
|
|
self.on_slide_selected_index([self.preview_widget.slide_count() - 1])
|
|
elif self.is_live and self.slide_limits == SlideLimits.Next:
|
|
self.keypress_queue.append(ServiceItemAction.PreviousLastSlide)
|
|
self._process_queue()
|
|
elif self.is_live:
|
|
self.update_preview()
|
|
else:
|
|
row = self.preview_widget.current_slide_number() - 1
|
|
if row == -1:
|
|
if self.slide_limits == SlideLimits.Wrap:
|
|
row = self.preview_widget.slide_count() - 1
|
|
elif self.is_live and self.slide_limits == SlideLimits.Next:
|
|
self.keypress_queue.append(ServiceItemAction.PreviousLastSlide)
|
|
self._process_queue()
|
|
return
|
|
else:
|
|
row = 0
|
|
self.preview_widget.change_slide(row)
|
|
self.slide_selected()
|
|
|
|
def on_toggle_loop(self):
|
|
"""
|
|
Toggles the loop state.
|
|
"""
|
|
hide_mode = self.hide_mode()
|
|
if hide_mode is None and (self.play_slides_loop.isChecked() or self.play_slides_once.isChecked()):
|
|
self.on_start_loop()
|
|
else:
|
|
self.on_stop_loop()
|
|
|
|
def on_start_loop(self):
|
|
"""
|
|
Start the timer loop running and store the timer id
|
|
"""
|
|
if self.preview_widget.slide_count() > 1:
|
|
self.timer_id = self.startTimer(int(self.delay_spin_box.value()) * 1000)
|
|
|
|
def on_stop_loop(self):
|
|
"""
|
|
Stop the timer loop running
|
|
"""
|
|
if self.timer_id:
|
|
self.killTimer(self.timer_id)
|
|
self.timer_id = 0
|
|
|
|
def on_play_slides_loop(self, checked=None):
|
|
"""
|
|
Start or stop 'Play Slides in Loop'
|
|
|
|
:param checked: is the check box checked.
|
|
"""
|
|
if checked is None:
|
|
checked = self.play_slides_loop.isChecked()
|
|
else:
|
|
self.play_slides_loop.setChecked(checked)
|
|
self.log_debug('on_play_slides_loop {text}'.format(text=checked))
|
|
if checked:
|
|
self.play_slides_loop.setIcon(UiIcons().stop)
|
|
self.play_slides_loop.setText(UiStrings().StopPlaySlidesInLoop)
|
|
self.play_slides_once.setIcon(UiIcons().clock)
|
|
self.play_slides_once.setText(UiStrings().PlaySlidesToEnd)
|
|
self.play_slides_menu.setDefaultAction(self.play_slides_loop)
|
|
self.play_slides_once.setChecked(False)
|
|
if self.settings.value('core/click live slide to unblank'):
|
|
Registry().execute('slidecontroller_live_unblank')
|
|
else:
|
|
self.play_slides_loop.setIcon(UiIcons().clock)
|
|
self.play_slides_loop.setText(UiStrings().PlaySlidesInLoop)
|
|
self.on_toggle_loop()
|
|
|
|
def on_play_slides_once(self, checked=None):
|
|
"""
|
|
Start or stop 'Play Slides to End'
|
|
|
|
:param checked: is the check box checked.
|
|
"""
|
|
if checked is None:
|
|
checked = self.play_slides_once.isChecked()
|
|
else:
|
|
self.play_slides_once.setChecked(checked)
|
|
self.log_debug('on_play_slides_once {text}'.format(text=checked))
|
|
if checked:
|
|
self.play_slides_once.setIcon(UiIcons().stop)
|
|
self.play_slides_once.setText(UiStrings().StopPlaySlidesToEnd)
|
|
self.play_slides_loop.setIcon(UiIcons().clock)
|
|
self.play_slides_loop.setText(UiStrings().PlaySlidesInLoop)
|
|
self.play_slides_menu.setDefaultAction(self.play_slides_once)
|
|
self.play_slides_loop.setChecked(False)
|
|
if self.settings.value('core/click live slide to unblank'):
|
|
Registry().execute('slidecontroller_live_unblank')
|
|
else:
|
|
self.play_slides_once.setIcon(UiIcons().clock)
|
|
self.play_slides_once.setText(UiStrings().PlaySlidesToEnd)
|
|
self.on_toggle_loop()
|
|
|
|
def timerEvent(self, event):
|
|
"""
|
|
If the timer event is for this window select next slide
|
|
|
|
:param event: The triggered event
|
|
"""
|
|
if event.timerId() == self.timer_id:
|
|
self.on_slide_selected_next(self.play_slides_loop.isChecked())
|
|
|
|
def on_edit_song(self):
|
|
"""
|
|
From the preview display requires the service Item to be editied
|
|
"""
|
|
self.song_edit = True
|
|
new_item = Registry().get(self.service_item.name).on_remote_edit(self.service_item.edit_id, True)
|
|
if new_item:
|
|
self.add_service_item(new_item)
|
|
|
|
def on_clear(self):
|
|
"""
|
|
Clear the preview bar.
|
|
"""
|
|
self.preview_widget.clear_list()
|
|
self.toolbar.set_widget_visible('editSong', False)
|
|
self.toolbar.set_widget_visible('clear', False)
|
|
|
|
def on_preview_add_to_service(self):
|
|
"""
|
|
From the preview display request the Item to be added to service
|
|
"""
|
|
if self.service_item:
|
|
self.service_manager.add_service_item(self.service_item)
|
|
|
|
def on_preview_double_click(self):
|
|
"""
|
|
Triggered when a preview slide item is double clicked
|
|
"""
|
|
if self.service_item:
|
|
if self.settings.value('advanced/double click live') and self.settings.value('core/auto unblank'):
|
|
# Live and Preview have issues if we have video or presentations
|
|
# playing in both at the same time.
|
|
if self.service_item.is_command():
|
|
Registry().execute('{text}_stop'.format(text=self.service_item.name.lower()),
|
|
[self.service_item, self.is_live])
|
|
if self.service_item.is_media():
|
|
self.on_media_close()
|
|
self.on_go_live()
|
|
# If ('advanced/double click live') is not enabled, double clicking preview adds the item to Service.
|
|
# Prevent same item in preview from being sent to Service multiple times.
|
|
# Changing the preview slide resets this flag to False.
|
|
# Do note that this still allows to add item to Service multiple times if icon is clicked.
|
|
elif not Registry().get_flag('has doubleclick added item to service') is True:
|
|
self.on_preview_add_to_service()
|
|
Registry().set_flag('has doubleclick added item to service', True)
|
|
|
|
def on_go_live(self, field=None):
|
|
"""
|
|
If preview copy slide item to live controller from Preview Controller
|
|
"""
|
|
row = self.preview_widget.current_slide_number()
|
|
if -1 < row < self.preview_widget.slide_count():
|
|
if self.service_item.from_service:
|
|
self.service_manager.preview_live(self.service_item.unique_identifier, row)
|
|
else:
|
|
self.live_controller.add_service_manager_item(self.service_item, row)
|
|
self.live_controller.preview_widget.setFocus()
|
|
|
|
def on_go_preview(self, field=None):
|
|
"""
|
|
If live copy slide item to preview controller from live Controller
|
|
"""
|
|
row = self.preview_widget.current_slide_number()
|
|
if -1 < row < self.preview_widget.slide_count():
|
|
self.preview_controller.add_service_manager_item(self.service_item, row)
|
|
self.preview_controller.preview_widget.setFocus()
|
|
|
|
def on_media_start(self, item):
|
|
"""
|
|
Respond to the arrival of a media service item
|
|
|
|
:param item: The service item to be processed
|
|
"""
|
|
if self.is_live and self.hide_mode() == HideMode.Theme:
|
|
self.media_controller.load_video(self.controller_type, item, HideMode.Blank)
|
|
self.on_blank_display(True)
|
|
else:
|
|
self.media_controller.load_video(self.controller_type, item, self.hide_mode())
|
|
if not self.is_live:
|
|
self.preview_display.show()
|
|
|
|
def on_media_close(self):
|
|
"""
|
|
Respond to a request to close the Video
|
|
"""
|
|
self.media_controller.media_reset(self)
|
|
|
|
def _reset_blank(self, no_theme):
|
|
"""
|
|
Used by command items which provide their own displays to reset the screen hide attributes
|
|
|
|
:param no_theme: Does the new item support theme-blanking.
|
|
"""
|
|
hide_mode = self.hide_mode()
|
|
if hide_mode == HideMode.Blank:
|
|
self.on_blank_display(True)
|
|
elif hide_mode == HideMode.Theme:
|
|
# The new item-type doesn't support theme-blanking, so 'switch' to normal blanking.
|
|
if no_theme:
|
|
self.on_blank_display(True)
|
|
else:
|
|
self.on_theme_display(True)
|
|
elif hide_mode == HideMode.Screen:
|
|
self.on_hide_display(True)
|
|
else:
|
|
self.hide_plugin(False)
|
|
|
|
def hide_mode(self):
|
|
"""
|
|
Determine what the hide mode should be according to the blank button
|
|
"""
|
|
if not self.is_live:
|
|
return None
|
|
elif self.blank_screen.isChecked():
|
|
return HideMode.Blank
|
|
elif self.theme_screen.isChecked():
|
|
return HideMode.Theme
|
|
elif self.desktop_screen.isChecked():
|
|
return HideMode.Screen
|
|
else:
|
|
return None
|
|
|
|
|
|
class PreviewController(RegistryBase, SlideController):
|
|
"""
|
|
Set up the Preview Controller.
|
|
"""
|
|
slidecontroller_preview_set = QtCore.pyqtSignal(list)
|
|
slidecontroller_preview_next = QtCore.pyqtSignal()
|
|
slidecontroller_preview_previous = QtCore.pyqtSignal()
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
"""
|
|
Set up the base Controller as a preview.
|
|
"""
|
|
self.__registry_name = 'preview_controller'
|
|
super().__init__(*args, **kwargs)
|
|
self.split = 0
|
|
self.type_prefix = 'preview'
|
|
self.category = 'Preview Toolbar'
|
|
|
|
def bootstrap_initialise(self):
|
|
"""
|
|
process the bootstrap post setup request
|
|
"""
|
|
self.post_set_up()
|
|
|
|
|
|
class LiveController(RegistryBase, SlideController):
|
|
"""
|
|
Set up the Live Controller.
|
|
"""
|
|
slidecontroller_live_set = QtCore.pyqtSignal(list)
|
|
slidecontroller_live_next = QtCore.pyqtSignal()
|
|
slidecontroller_live_previous = QtCore.pyqtSignal()
|
|
slidecontroller_toggle_display = QtCore.pyqtSignal(str)
|
|
mediacontroller_live_play = QtCore.pyqtSignal()
|
|
mediacontroller_live_pause = QtCore.pyqtSignal()
|
|
mediacontroller_live_stop = QtCore.pyqtSignal()
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
"""
|
|
Set up the base Controller as a live.
|
|
"""
|
|
self.__registry_name = 'live_controller'
|
|
super().__init__(*args, **kwargs)
|
|
self.is_live = True
|
|
self.split = 1
|
|
self.type_prefix = 'live'
|
|
self.keypress_queue = deque()
|
|
self.category = UiStrings().LiveToolbar
|
|
ActionList.get_instance().add_category(str(self.category), CategoryOrder.standard_toolbar)
|
|
|
|
def bootstrap_initialise(self):
|
|
"""
|
|
process the bootstrap post setup request
|
|
"""
|
|
self.post_set_up()
|