openlp/openlp/core/ui/media/mediacontroller.py

485 lines
20 KiB
Python
Raw Normal View History

2011-06-05 21:10:49 +00:00
# -*- coding: utf-8 -*-
# vim: autoindent shiftwidth=4 expandtab textwidth=80 tabstop=4 softtabstop=4
###############################################################################
# OpenLP - Open Source Lyrics Projection #
# --------------------------------------------------------------------------- #
# Copyright (c) 2008-2011 Raoul Snyman #
2011-06-14 16:10:20 +00:00
# Portions copyright (c) 2008-2011 Tim Bentley, Gerald Britton, Jonathan #
# Corwin, Michael Gorven, Scott Guerrieri, Matthias Hub, Meinert Jordan, #
# Armin Köhler, Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias #
# Põldaru, Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
2011-06-05 21:10:49 +00:00
# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Frode Woldsund #
# --------------------------------------------------------------------------- #
# 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; version 2 of the License. #
# #
# 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, write to the Free Software Foundation, Inc., 59 #
# Temple Place, Suite 330, Boston, MA 02111-1307 USA #
###############################################################################
import logging
import sys, os,time
from PyQt4 import QtCore, QtGui, QtWebKit
from openlp.core.lib import OpenLPToolbar, Receiver, translate
from openlp.core.lib.ui import UiStrings, critical_error_message_box
2011-08-29 19:55:58 +00:00
from openlp.core.ui.media import MediaAPI, MediaState, MediaInfo, MediaType
2011-07-10 21:43:07 +00:00
from openlp.core.utils import AppLocation
2011-06-05 21:10:49 +00:00
log = logging.getLogger(__name__)
2011-08-29 21:51:03 +00:00
class MediaController(object):
2011-06-05 21:10:49 +00:00
"""
2011-09-22 18:22:35 +00:00
The implementation of the Media Controller
The Media Controller adds an own class for every API
2011-06-05 21:10:49 +00:00
Currently these are QtWebkit, Phonon and planed Vlc.
"""
def __init__(self, parent):
self.parent = parent
self.APIs = {}
self.controller = []
2011-09-22 18:22:35 +00:00
self.overridenApi = ''
2011-06-05 21:10:49 +00:00
self.curDisplayMediaAPI = {}
2011-08-29 19:55:58 +00:00
# Timer for video state
2011-09-22 18:22:35 +00:00
self.timer = QtCore.QTimer()
self.timer.setInterval(200)
2011-06-05 21:10:49 +00:00
self.withLivePreview = False
2011-08-29 19:55:58 +00:00
self.check_available_media_apis()
# Signals
2011-09-22 18:22:35 +00:00
QtCore.QObject.connect(self.timer,
2011-06-05 21:10:49 +00:00
QtCore.SIGNAL("timeout()"), self.video_state)
QtCore.QObject.connect(Receiver.get_receiver(),
QtCore.SIGNAL(u'Media Start'), self.video_play)
QtCore.QObject.connect(Receiver.get_receiver(),
QtCore.SIGNAL(u'Media Pause'), self.video_pause)
QtCore.QObject.connect(Receiver.get_receiver(),
QtCore.SIGNAL(u'Media Stop'), self.video_stop)
QtCore.QObject.connect(Receiver.get_receiver(),
QtCore.SIGNAL(u'seekSlider'), self.video_seek)
QtCore.QObject.connect(Receiver.get_receiver(),
QtCore.SIGNAL(u'volumeSlider'), self.video_volume)
QtCore.QObject.connect(Receiver.get_receiver(),
QtCore.SIGNAL(u'media_hide'), self.video_hide)
QtCore.QObject.connect(Receiver.get_receiver(),
QtCore.SIGNAL(u'media_blank'), self.video_blank)
QtCore.QObject.connect(Receiver.get_receiver(),
QtCore.SIGNAL(u'media_unblank'), self.video_unblank)
2011-09-22 18:22:35 +00:00
QtCore.QObject.connect(Receiver.get_receiver(),
QtCore.SIGNAL(u'media_overrideApi'), self.override_api)
2011-06-05 21:10:49 +00:00
2011-08-29 19:55:58 +00:00
def register_controllers(self, controller):
2011-07-10 21:43:07 +00:00
"""
Register each media API controller (Webkit, Phonon, etc) and
store for later use
"""
if controller.check_available():
self.APIs[controller.name] = controller
2011-08-29 19:55:58 +00:00
def check_available_media_apis(self):
2011-07-10 21:43:07 +00:00
"""
Check to see if we have any media API's available
If Not do not install the plugin.
"""
2011-08-29 19:55:58 +00:00
log.debug(u'check_available_media_apis')
2011-07-10 21:43:07 +00:00
controller_dir = os.path.join(
AppLocation.get_directory(AppLocation.AppDir),
u'core', u'ui', u'media')
for filename in os.listdir(controller_dir):
if filename.endswith(u'api.py') and \
2011-08-29 21:51:03 +00:00
not filename == 'media_api.py':
2011-07-10 21:43:07 +00:00
path = os.path.join(controller_dir, filename)
if os.path.isfile(path):
modulename = u'openlp.core.ui.media.' + \
os.path.splitext(filename)[0]
log.debug(u'Importing controller %s', modulename)
try:
__import__(modulename, globals(), locals(), [])
except ImportError:
log.warn(u'Failed to import %s on path %s',
modulename, path)
controller_classes = MediaAPI.__subclasses__()
for controller_class in controller_classes:
controller = controller_class(self)
2011-08-29 19:55:58 +00:00
self.register_controllers(controller)
2011-07-10 21:43:07 +00:00
if self.APIs:
return True
else:
return False
2011-06-05 21:10:49 +00:00
def video_state(self):
"""
Check if there is an assigned media API and do some
updating stuff (e.g. update the UI)
"""
isAnyonePlaying = False
if len(self.curDisplayMediaAPI.keys()) == 0:
2011-09-22 18:22:35 +00:00
self.timer.stop()
2011-06-05 21:10:49 +00:00
else:
for display in self.curDisplayMediaAPI.keys():
2011-08-23 20:19:45 +00:00
self.curDisplayMediaAPI[display].resize(display)
2011-06-05 21:10:49 +00:00
self.curDisplayMediaAPI[display].update_ui(display)
if self.curDisplayMediaAPI[display] \
.state == MediaState.Playing:
isAnyonePlaying = True
if not isAnyonePlaying:
2011-09-22 18:22:35 +00:00
self.timer.stop()
2011-06-05 21:10:49 +00:00
2011-08-29 19:55:58 +00:00
def get_media_display_css(self):
2011-06-08 13:18:05 +00:00
"""
Add css style sheets to htmlbuilder
"""
css = u'';
for api in self.APIs.values():
2011-08-29 19:55:58 +00:00
css += api.get_media_display_css()
2011-06-08 13:18:05 +00:00
return css
2011-08-29 19:55:58 +00:00
def get_media_display_javascript(self):
2011-06-08 13:18:05 +00:00
"""
Add javascript functions to htmlbuilder
"""
js = u''
for api in self.APIs.values():
2011-08-29 19:55:58 +00:00
js += api.get_media_display_javascript()
2011-06-08 13:18:05 +00:00
return js
2011-08-29 19:55:58 +00:00
def get_media_display_html(self):
2011-06-08 13:18:05 +00:00
"""
Add html code to htmlbuilder
"""
html = u''
for api in self.APIs.values():
2011-08-29 19:55:58 +00:00
html += api.get_media_display_html()
2011-06-08 13:18:05 +00:00
return html
2011-08-29 19:55:58 +00:00
def add_controller_items(self, controller, control_panel):
2011-06-05 21:10:49 +00:00
self.controller.append(controller)
self.setup_generic_controls(controller, control_panel)
for api in self.APIs.values():
api.setup_controls(controller, control_panel)
def setup_generic_controls(self, controller, control_panel):
controller.media_info = MediaInfo()
# Build a Media ToolBar
controller.mediabar = OpenLPToolbar(controller)
controller.mediabar.addToolbarButton(
u'Media Start', u':/slides/media_playback_start.png',
translate('OpenLP.SlideController', 'Start playing media'),
controller.sendToPlugins)
controller.mediabar.addToolbarButton(
u'Media Pause', u':/slides/media_playback_pause.png',
2011-06-08 13:18:05 +00:00
translate('OpenLP.SlideController', 'Pause playing media'),
2011-06-05 21:10:49 +00:00
controller.sendToPlugins)
controller.mediabar.addToolbarButton(
u'Media Stop', u':/slides/media_playback_stop.png',
2011-06-08 13:18:05 +00:00
translate('OpenLP.SlideController', 'Stop playing media'),
2011-06-05 21:10:49 +00:00
controller.sendToPlugins)
# Build the seekSlider.
controller.seekSlider = QtGui.QSlider(QtCore.Qt.Horizontal)
controller.seekSlider.setMaximum(1000)
# Build the volumeSlider.
controller.volumeSlider = QtGui.QSlider(QtCore.Qt.Horizontal)
controller.volumeSlider.setTickInterval(10)
controller.volumeSlider.setTickPosition(QtGui.QSlider.TicksAbove)
controller.volumeSlider.setMinimum(0)
controller.volumeSlider.setMaximum(100)
controller.volumeSlider.setValue(controller.media_info.volume)
controller.seekSlider.setGeometry(QtCore.QRect(90, 260, 221, 24))
controller.seekSlider.setObjectName(u'seekSlider')
controller.mediabar.addToolbarWidget(u'Seek Slider', controller.seekSlider)
controller.volumeSlider.setGeometry(QtCore.QRect(90, 160, 221, 24))
controller.volumeSlider.setObjectName(u'volumeSlider')
controller.mediabar.addToolbarWidget(u'Audio Volume', controller.volumeSlider)
control_panel.addWidget(controller.mediabar)
controller.mediabar.setVisible(False)
2011-08-29 19:55:58 +00:00
# Signals
2011-06-05 21:10:49 +00:00
QtCore.QObject.connect(controller.seekSlider,
QtCore.SIGNAL(u'sliderMoved(int)'), controller.sendToPlugins)
QtCore.QObject.connect(controller.volumeSlider,
QtCore.SIGNAL(u'sliderMoved(int)'), controller.sendToPlugins)
def setup_display(self, display):
"""
After a new display is configured, all media related widget
will be created too
"""
2011-07-20 21:16:36 +00:00
# clean up possible running old media files
self.finalise()
2011-06-05 21:10:49 +00:00
display.hasAudio = True
if not self.withLivePreview and \
display == self.parent.liveController.previewDisplay:
return
if display == self.parent.previewController.previewDisplay or \
display == self.parent.liveController.previewDisplay:
display.hasAudio = False
for api in self.APIs.values():
api.setup(display)
def set_controls_visible(self, controller, value):
# Generic controls
controller.mediabar.setVisible(value)
# Special controls
2011-06-14 16:10:20 +00:00
# TODO
2011-06-05 21:10:49 +00:00
# for api in self.APIs.values():
# api.setup_controls(controller, control_panel)
2011-06-06 19:12:14 +00:00
def resize(self, controller, display, api):
2011-06-05 21:10:49 +00:00
"""
After Mainwindow changes or Splitter moved all related media
widgets have to be resized
"""
api.resize(display)
2011-07-18 21:25:10 +00:00
def video(self, controller, file, muted, isBackground):
2011-06-05 21:10:49 +00:00
"""
Loads and starts a video to run with the option of sound
"""
log.debug(u'video')
isValid = False
# stop running videos
self.video_reset(controller)
controller.media_info = MediaInfo()
2011-07-18 21:25:10 +00:00
if muted:
controller.media_info.volume = 0
else:
controller.media_info.volume = controller.volumeSlider.value()
controller.media_info.file_info = QtCore.QFileInfo(file)
controller.media_info.is_background = isBackground
2011-06-05 21:10:49 +00:00
if controller.isLive:
2011-07-25 20:56:39 +00:00
if self.withLivePreview and controller.previewDisplay:
2011-06-05 21:10:49 +00:00
display = controller.previewDisplay
2011-06-06 19:12:14 +00:00
isValid = self.check_file_type(controller, display)
2011-06-05 21:10:49 +00:00
display = controller.display
2011-06-06 19:12:14 +00:00
isValid = self.check_file_type(controller, display)
2011-07-20 21:16:36 +00:00
display.override[u'theme'] = u''
display.override[u'video'] = True
2011-07-25 20:56:39 +00:00
controller.media_info.start_time = display.serviceItem.start_time
controller.media_info.end_time = display.serviceItem.end_time
elif controller.previewDisplay:
2011-06-05 21:10:49 +00:00
display = controller.previewDisplay
2011-06-06 19:12:14 +00:00
isValid = self.check_file_type(controller, display)
2011-06-05 21:10:49 +00:00
if not isValid:
2011-08-29 19:55:58 +00:00
# Media could not be loaded correctly
2011-06-05 21:10:49 +00:00
critical_error_message_box(
translate('MediaPlugin.MediaItem', 'Unsupported File'),
unicode(translate('MediaPlugin.MediaItem',
'Unsupported File')))
2011-07-18 21:25:10 +00:00
return False
2011-08-29 19:55:58 +00:00
# now start playing
if self.video_play([controller]):
self.video_pause([controller])
self.video_seek([controller, [0]])
2011-09-22 19:20:25 +00:00
if controller.isLive and QtCore.QSettings().value(u'general/auto unblank',
QtCore.QVariant(False)).toBool():
self.video_play([controller])
self.set_controls_visible(controller, True)
log.debug(u'use %s controller' % self.curDisplayMediaAPI[display])
return True
2011-08-29 19:55:58 +00:00
else:
critical_error_message_box(
translate('MediaPlugin.MediaItem', 'Unsupported File'),
unicode(translate('MediaPlugin.MediaItem',
'Unsupported File')))
return False
2011-06-05 21:10:49 +00:00
2011-06-06 19:12:14 +00:00
def check_file_type(self, controller, display):
2011-06-05 21:10:49 +00:00
"""
Used to choose the right media API type
from the prioritized API list
"""
apiSettings = str(QtCore.QSettings().value(u'media/apis',
QtCore.QVariant(u'Webkit')).toString())
usedAPIs = apiSettings.split(u',')
2011-09-22 18:22:35 +00:00
if QtCore.QSettings().value(u'media/override api',
QtCore.QVariant(QtCore.Qt.Unchecked)) == QtCore.Qt.Checked:
if self.overridenApi != '':
usedAPIs = [self.overridenApi]
2011-06-05 21:10:49 +00:00
if controller.media_info.file_info.isFile():
suffix = u'*.%s' % controller.media_info.file_info.suffix()
for title in usedAPIs:
api = self.APIs[title]
if suffix in api.video_extensions_list:
if not controller.media_info.is_background or \
controller.media_info.is_background and api.canBackground:
2011-06-06 19:12:14 +00:00
self.resize(controller, display, api)
2011-06-05 21:10:49 +00:00
if api.load(display):
self.curDisplayMediaAPI[display] = api
2011-08-29 19:55:58 +00:00
controller.media_info.media_type = MediaType.Video
2011-06-05 21:10:49 +00:00
return True
2011-08-29 19:55:58 +00:00
if suffix in api.audio_extensions_list:
if api.load(display):
self.curDisplayMediaAPI[display] = api
controller.media_info.media_type = MediaType.Audio
return True
2011-09-22 18:22:35 +00:00
else:
for title in usedAPIs:
api = self.APIs[title]
if api.canFolder:
self.resize(controller, display, api)
if api.load(display):
self.curDisplayMediaAPI[display] = api
controller.media_info.media_type = MediaType.Video
return True
2011-06-05 21:10:49 +00:00
# no valid api found
return False
def video_play(self, msg):
"""
Responds to the request to play a loaded video
"""
log.debug(u'video_play')
controller = msg[0]
for display in self.curDisplayMediaAPI.keys():
2011-06-06 19:12:14 +00:00
if display.controller == controller:
2011-07-20 21:16:36 +00:00
if controller.isLive:
if controller.hideMenu.defaultAction().isChecked():
controller.hideMenu.defaultAction().trigger()
2011-08-29 19:55:58 +00:00
if not self.curDisplayMediaAPI[display].play(display):
return False
self.curDisplayMediaAPI[display].set_visible(display, True)
2011-06-05 21:10:49 +00:00
# Start Timer for ui updates
2011-09-22 18:22:35 +00:00
if not self.timer.isActive():
self.timer.start()
2011-08-29 19:55:58 +00:00
return True
2011-06-05 21:10:49 +00:00
def video_pause(self, msg):
"""
Responds to the request to pause a loaded video
"""
2011-08-29 19:55:58 +00:00
log.debug(u'video_pause')
2011-06-05 21:10:49 +00:00
controller = msg[0]
for display in self.curDisplayMediaAPI.keys():
2011-06-06 19:12:14 +00:00
if display.controller == controller:
2011-06-05 21:10:49 +00:00
self.curDisplayMediaAPI[display].pause(display)
def video_stop(self, msg):
"""
Responds to the request to stop a loaded video
"""
log.debug(u'video_stop')
controller = msg[0]
for display in self.curDisplayMediaAPI.keys():
2011-06-06 19:12:14 +00:00
if display.controller == controller:
2011-06-05 21:10:49 +00:00
self.curDisplayMediaAPI[display].stop(display)
self.curDisplayMediaAPI[display].set_visible(display, False)
def video_volume(self, msg):
"""
Changes the volume of a running video
"""
controller = msg[0]
2011-06-08 14:49:48 +00:00
vol = msg[1][0]
2011-06-05 21:10:49 +00:00
log.debug(u'video_volume %d' % vol)
for display in self.curDisplayMediaAPI.keys():
2011-06-06 19:12:14 +00:00
if display.controller == controller:
2011-06-05 21:10:49 +00:00
self.curDisplayMediaAPI[display].volume(display, vol)
def video_seek(self, msg):
"""
Responds to the request to change the seek Slider of a loaded video
"""
log.debug(u'video_seek')
controller = msg[0]
2011-06-08 14:49:48 +00:00
seekVal = msg[1][0]
2011-06-05 21:10:49 +00:00
for display in self.curDisplayMediaAPI.keys():
2011-06-06 19:12:14 +00:00
if display.controller == controller:
2011-06-05 21:10:49 +00:00
self.curDisplayMediaAPI[display].seek(display, seekVal)
def video_reset(self, controller):
"""
Responds to the request to reset a loaded video
"""
log.debug(u'video_reset')
for display in self.curDisplayMediaAPI.keys():
2011-06-06 19:12:14 +00:00
if display.controller == controller:
2011-07-20 21:16:36 +00:00
display.override = {}
2011-06-05 21:10:49 +00:00
self.curDisplayMediaAPI[display].reset(display)
2011-08-29 19:55:58 +00:00
self.curDisplayMediaAPI[display].set_visible(display, False)
2011-06-05 21:10:49 +00:00
del self.curDisplayMediaAPI[display]
self.set_controls_visible(controller, False)
def video_hide(self, msg):
"""
Hide the related video Widget
"""
isLive = msg[1]
if isLive:
controller = self.parent.liveController
for display in self.curDisplayMediaAPI.keys():
2011-06-06 19:12:14 +00:00
if display.controller == controller:
2011-06-05 21:10:49 +00:00
if self.curDisplayMediaAPI[display] \
.state == MediaState.Playing:
self.curDisplayMediaAPI[display].pause(display)
self.curDisplayMediaAPI[display] \
.set_visible(display, False)
def video_blank(self, msg):
"""
Blank the related video Widget
"""
isLive = msg[1]
if isLive:
controller = self.parent.liveController
for display in self.curDisplayMediaAPI.keys():
2011-06-06 19:12:14 +00:00
if display.controller == controller:
2011-06-05 21:10:49 +00:00
if self.curDisplayMediaAPI[display] \
.state == MediaState.Playing:
self.curDisplayMediaAPI[display].pause(display)
self.curDisplayMediaAPI[display] \
.set_visible(display, False)
def video_unblank(self, msg):
"""
Unblank the related video Widget
"""
Receiver.send_message(u'maindisplay_show')
isLive = msg[1]
if isLive:
controller = self.parent.liveController
for display in self.curDisplayMediaAPI.keys():
2011-06-06 19:12:14 +00:00
if display.controller == controller:
2011-06-05 21:10:49 +00:00
if self.curDisplayMediaAPI[display] \
.state == MediaState.Paused:
2011-08-29 19:55:58 +00:00
if self.curDisplayMediaAPI[display].play(display):
self.curDisplayMediaAPI[display] \
.set_visible(display, True)
2011-06-05 21:10:49 +00:00
def get_audio_extensions_list(self):
audio_list = []
for api in self.APIs.values():
for item in api.audio_extensions_list:
if not item in audio_list:
audio_list.append(item)
return audio_list
def get_video_extensions_list(self):
video_list = []
for api in self.APIs.values():
for item in api.video_extensions_list:
if not item in video_list:
video_list.append(item)
return video_list
2011-07-20 21:16:36 +00:00
2011-09-22 18:22:35 +00:00
def override_api(self, override_api):
apiSettings = str(QtCore.QSettings().value(u'media/apis',
QtCore.QVariant(u'Webkit')).toString())
usedAPIs = apiSettings.split(u',')
if override_api in usedAPIs:
self.overridenApi = override_api
else:
self.overridenApi = ''
2011-07-20 21:16:36 +00:00
def finalise(self):
2011-09-22 18:22:35 +00:00
self.timer.stop()
2011-07-20 21:16:36 +00:00
for controller in self.controller:
self.video_reset(controller)