File indexing completed on 2024-12-01 04:21:25

 /*
     Copyright (C) 2007-2008 Tanguy Krotoff <tkrotoff@gmail.com>
     Copyright (C) 2008 Lukas Durfina <lukas.durfina@gmail.com>
     Copyright (C) 2009 Fathi Boudra <fabo@kde.org>
     Copyright (C) 2009-2011 vlc-phonon AUTHORS <kde-multimedia@kde.org>
     Copyright (C) 2011-2013 Harald Sitter <sitter@kde.org>
 
     This library is free software; you can redistribute it and/or
     modify it under the terms of the GNU Lesser General Public
     License as published by the Free Software Foundation; either
     version 2.1 of the License, or (at your option) any later version.
 
     This library 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
     Lesser General Public License for more details.
 
     You should have received a copy of the GNU Lesser General Public
     License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "backend.h"
 
 #include <QApplication>
 #include <QIcon>
 #include <QMessageBox>
 #include <QtPlugin>
 #include <QVariant>
 
 #include <phonon/GlobalDescriptionContainer>
 #include <phonon/pulsesupport.h>
 
 #include <vlc/libvlc_version.h>
 
 #include "audio/audiooutput.h"
 #include "audio/volumefadereffect.h"
 #include "config.h"
 #include "devicemanager.h"
 #include "effect.h"
 #include "effectmanager.h"
 #include "mediaobject.h"
 #include "sinknode.h"
 #include "utils/debug.h"
 #include "utils/libvlc.h"
 #include "utils/mime.h"
 #ifdef PHONON_EXPERIMENTAL
 #include "video/videodataoutput.h"
 #endif
 #include "video/videowidget.h"
 
 namespace Phonon
 {
 namespace VLC
 {
 
 Backend *Backend::self;
 
 Backend::Backend(QObject *parent, const QVariantList &)
     : QObject(parent)
     , m_deviceManager(0)
     , m_effectManager(0)
 {
     self = this;
 
     // Backend information properties
     setProperty("identifier",     QLatin1String("phonon_vlc"));
     setProperty("backendName",    QLatin1String("VLC"));
     setProperty("backendComment", QLatin1String("VLC backend for Phonon"));
     setProperty("backendVersion", QLatin1String(PHONON_VLC_VERSION));
     setProperty("backendIcon",    QLatin1String("vlc"));
     setProperty("backendWebsite", QLatin1String("https://commits.kde.org/phonon-vlc"));
 
     // Check if we should enable debug output
     int debugLevel = qgetenv("PHONON_BACKEND_DEBUG").toInt();
     if (debugLevel > 3) // 3 is maximum
         debugLevel = 3;
     Debug::setMinimumDebugLevel((Debug::DebugLevel)((int) Debug::DEBUG_NONE - 1 - debugLevel));
 
     debug() << "Constructing Phonon-VLC Version" << PHONON_VLC_VERSION;
 
     // Actual libVLC initialisation
     if (LibVLC::init()) {
         debug() << "Using VLC version" << libvlc_get_version();
         if (!qApp->applicationName().isEmpty()) {
             QString userAgent =
                     QString("%0/%1 (Phonon/%2; Phonon-VLC/%3)").arg(
                         qApp->applicationName(),
                         qApp->applicationVersion(),
                         PHONON_VERSION_STR,
                         PHONON_VLC_VERSION);
             libvlc_set_user_agent(pvlc_libvlc,
                                   qApp->applicationName().toUtf8().constData(),
                                   userAgent.toUtf8().constData());
         } else {
             qWarning("WARNING: Setting the user agent for streaming and"
                      " PulseAudio requires you to set QCoreApplication::applicationName()");
         }
 
         PulseSupport::getInstance()->enable(true);
         const bool pulseActive = PulseSupport::getInstance()->isActive();
         PulseSupport::getInstance()->enable(false);
         if (!qApp->applicationName().isEmpty()) {
             const QString id = QString("org.kde.phonon.%1").arg(qApp->applicationName());
             const QString version = qApp->applicationVersion();
             QString icon;
             if (!qApp->windowIcon().isNull()){
                 // Try to get the fromTheme() name of the QIcon.
                 icon = qApp->windowIcon().name();
             }
             if (icon.isEmpty()) {
                 // If we failed to get a proper icon name, use the appname instead.
                 icon = qApp->applicationName().toLower();
             }
             libvlc_set_app_id(pvlc_libvlc,
                               id.toUtf8().constData(),
                               version.toUtf8().constData(),
                               icon.toUtf8().constData());
         } else if (pulseActive) {
             qWarning("WARNING: Setting PulseAudio context information requires you"
                      " to set QCoreApplication::applicationName(),"
                      " QCoreApplication::applicationVersion() and"
                      " QGuiApplication::windowIcon().");
         }
     } else {
 #ifdef __GNUC__
     #warning TODO - this error message is as useful as a knife at a gun fight
 #endif
         QMessageBox msg;
         msg.setIcon(QMessageBox::Critical);
         msg.setWindowTitle(tr("LibVLC Failed to Initialize"));
         msg.setText(tr("Phonon's VLC backend failed to start."
                        "\n\n"
                        "This usually means a problem with your VLC installation,"
                        " please report a bug with your distributor."));
         msg.setDetailedText(LibVLC::errorMessage());
         msg.exec();
         fatal() << "Phonon::VLC::vlcInit: Failed to initialize VLC";
     }
 
     // Since VLC 2.2 PulseSupport is disabled since the "overlay" it implements clashes substantially with libvlc
     // internals. Instead VLC has full control.
 
     m_deviceManager = new DeviceManager(this);
     m_effectManager = new EffectManager(this);
 }
 
 Backend::~Backend()
 {
     if (LibVLC::self)
         delete LibVLC::self;
     if (GlobalAudioChannels::self)
         delete GlobalAudioChannels::self;
     if (GlobalSubtitles::self)
         delete GlobalSubtitles::self;
     PulseSupport::shutdown();
 }
 
 QObject *Backend::createObject(BackendInterface::Class c, QObject *parent, const QList<QVariant> &args)
 {
     if (!LibVLC::self || !pvlc_libvlc)
         return 0;
 
     switch (c) {
     case MediaObjectClass:
         return new MediaObject(parent);
     case AudioOutputClass:
         return new AudioOutput(parent);
     case AudioDataOutputClass:
         // With VLC we can't have actual output and at the same time stream
         // the data to memory. We therefore can't support ADO.
         // https://trac.videolan.org/vlc/ticket/6992
         return nullptr;
 #ifdef PHONON_EXPERIMENTAL
     case VideoDataOutputClass:
         return new VideoDataOutput(parent);
 #endif
     case VideoGraphicsObjectClass:
         return nullptr; // No longer supported
     case EffectClass:
         return effectManager()->createEffect(args[0].toInt(), parent);
     case VideoWidgetClass:
         return new VideoWidget(qobject_cast<QWidget *>(parent));
 //    case VolumeFaderEffectClass:
 #ifdef __GNUC__
 #warning VFE crashes and has volume bugs ... deactivated
 //        return new VolumeFaderEffect(parent);
 #endif
     }
 
     warning() << "Backend class" << c << "is not supported by Phonon VLC :(";
     return 0;
 }
 
 QStringList Backend::availableMimeTypes() const
 {
     if (m_supportedMimeTypes.isEmpty())
         const_cast<Backend *>(this)->m_supportedMimeTypes = mimeTypeList();
     return m_supportedMimeTypes;
 }
 
 QList<int> Backend::objectDescriptionIndexes(ObjectDescriptionType type) const
 {
     QList<int> list;
 
     switch (type) {
     case Phonon::AudioChannelType: {
         list << GlobalAudioChannels::instance()->globalIndexes();
     }
     break;
     case Phonon::AudioOutputDeviceType:
     case Phonon::AudioCaptureDeviceType:
     case Phonon::VideoCaptureDeviceType: {
         return deviceManager()->deviceIds(type);
     }
     break;
     case Phonon::EffectType: {
         QList<EffectInfo> effectList = effectManager()->effects();
         for (int eff = 0; eff < effectList.size(); ++eff) {
             list.append(eff);
         }
     }
     break;
     case Phonon::SubtitleType: {
         list << GlobalSubtitles::instance()->globalIndexes();
     }
     break;
     }
 
     return list;
 }
 
 QHash<QByteArray, QVariant> Backend::objectDescriptionProperties(ObjectDescriptionType type, int index) const
 {
     QHash<QByteArray, QVariant> ret;
 
     switch (type) {
     case Phonon::AudioChannelType: {
         const AudioChannelDescription description = GlobalAudioChannels::instance()->fromIndex(index);
         ret.insert("name", description.name());
         ret.insert("description", description.description());
     }
     break;
     case Phonon::AudioOutputDeviceType:
     case Phonon::AudioCaptureDeviceType:
     case Phonon::VideoCaptureDeviceType: {
         // Index should be unique, even for different categories
         return deviceManager()->deviceProperties(index);
     }
     break;
     case Phonon::EffectType: {
         const QList<EffectInfo> effectList = effectManager()->effects();
         if (index >= 0 && index <= effectList.size()) {
             const EffectInfo &effect = effectList.at(index);
             ret.insert("name", effect.name());
             ret.insert("description", effect.description());
             ret.insert("author", effect.author());
         } else {
             Q_ASSERT(1); // Since we use list position as ID, this should not happen
         }
     }
     break;
     case Phonon::SubtitleType: {
         const SubtitleDescription description = GlobalSubtitles::instance()->fromIndex(index);
         ret.insert("name", description.name());
         ret.insert("description", description.description());
         ret.insert("type", description.property("type"));
     }
     break;
     }
 
     return ret;
 }
 
 bool Backend::startConnectionChange(QSet<QObject *> objects)
 {
     //FIXME
     foreach(QObject * object, objects) {
         debug() << "Object:" << object->metaObject()->className();
     }
 
     // There is nothing we can do but hope the connection changes will not take too long
     // so that buffers would underrun
     // But we should be pretty safe the way xine works by not doing anything here.
     return true;
 }
 
 bool Backend::connectNodes(QObject *source, QObject *sink)
 {
     debug() << "Backend connected" << source->metaObject()->className() << "to" << sink->metaObject()->className();
 
     SinkNode *sinkNode = dynamic_cast<SinkNode *>(sink);
     if (sinkNode) {
         MediaObject *mediaObject = qobject_cast<MediaObject *>(source);
         if (mediaObject) {
             // Connect the SinkNode to a MediaObject
             sinkNode->connectToMediaObject(mediaObject);
             return true;
         }
 
         VolumeFaderEffect *effect = qobject_cast<VolumeFaderEffect *>(source);
         if (effect) {
             sinkNode->connectToMediaObject(effect->mediaObject());
             return true;
         }
     }
 
     warning() << "Linking" << source->metaObject()->className() << "to" << sink->metaObject()->className() << "failed";
 
     return false;
 }
 
 bool Backend::disconnectNodes(QObject *source, QObject *sink)
 {
     SinkNode *sinkNode = dynamic_cast<SinkNode *>(sink);
     if (sinkNode) {
         MediaObject *const mediaObject = qobject_cast<MediaObject *>(source);
         if (mediaObject) {
             // Disconnect the SinkNode from a MediaObject
             sinkNode->disconnectFromMediaObject(mediaObject);
             return true;
         }
 
         VolumeFaderEffect *const effect = qobject_cast<VolumeFaderEffect *>(source);
         if (effect) {
             sinkNode->disconnectFromMediaObject(effect->mediaObject());
             return true;
         }
     }
 
     return false;
 }
 
 bool Backend::endConnectionChange(QSet<QObject *> objects)
 {
     foreach(QObject *object, objects) {
         debug() << "Object:" << object->metaObject()->className();
     }
     return true;
 }
 
 DeviceManager *Backend::deviceManager() const
 {
     return m_deviceManager;
 }
 
 EffectManager *Backend::effectManager() const
 {
     return m_effectManager;
 }
 
 } // namespace VLC
 } // namespace Phonon