runtime/phonon/kcm/factory_p.h

   1 /*  This file is part of the KDE project
   2     Copyright (C) 2004-2007 Matthias Kretz <kretz@kde.org>
   3
   4     This library is free software; you can redistribute it and/or
   5     modify it under the terms of the GNU Library General Public
   6     License version 2 as published by the Free Software Foundation.
   7
   8     This library is distributed in the hope that it will be useful,
   9     but WITHOUT ANY WARRANTY; without even the implied warranty of
  10     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11     Library General Public License for more details.
  12
  13     You should have received a copy of the GNU Library General Public License
  14     along with this library; see the file COPYING.LIB.  If not, write to
  15     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  16     Boston, MA 02110-1301, USA.
  17
  18 */
  19
  20 #ifndef PHONON_FACTORY_P_H
  21 #define PHONON_FACTORY_P_H
  22
  23 #include <phonon/phonon_export.h>
  24
  25 #include <QtCore/QObject>
  26 #include <QtCore/QStringList>
  27
  28 QT_BEGIN_HEADER
  29 QT_BEGIN_NAMESPACE
  30
  31 class QUrl;
  32 class QIcon;
  33
  34 namespace Phonon
  35 {
  36     class PlatformPlugin;
  37     class MediaNodePrivate;
  38     class AbstractMediaStream;
  39
  40 /**
  41  * \internal
  42  * \brief Factory to access the preferred Backend.
  43  *
  44  * This class is used internally to get the backend's implementation.
  45  * It keeps track of the objects that were created. When a
  46  * request for a backend change comes, it asks all frontend objects to delete
  47  * their backend objects and then checks whether they were all deleted. Only
  48  * then the old backend is unloaded and the new backend is loaded.
  49  *
  50  * \author Matthias Kretz <kretz@kde.org>
  51  */
  52 namespace Factory
  53 {
  54     /**
  55      * Emits signals for Phonon::Factory.
  56      */
  57     class Sender : public QObject
  58     {
  59         Q_OBJECT
  60         Q_SIGNALS:
  61             /**
  62              * Emitted after the backend has successfully been changed.
  63              */
  64             void backendChanged();
  65
  66             /**
  67              * \copydoc BackendCapabilities::Notifier::availableAudioOutputDevicesChanged
  68              */
  69             void availableAudioOutputDevicesChanged();
  70     };
  71
  72     /**
  73      * Returns a pointer to the object emitting the signals.
  74      *
  75      * \see Sender::backendChanged()
  76      */
  77     PHONON_EXPORT Sender *sender();
  78
  79     /**
  80      * Create a new backend object for a MediaObject.
  81      *
  82      * \return a pointer to the MediaObject the backend provides.
  83      */
  84     QObject *createMediaObject(QObject *parent = 0);
  85     /**
  86      * Create a new backend object for a Effect.
  87      *
  88      * \return a pointer to the Effect the backend provides.
  89      */
  90     QObject *createEffect(int effectId, QObject *parent = 0);
  91     /**
  92      * Create a new backend object for a VolumeFaderEffect.
  93      *
  94      * \return a pointer to the VolumeFaderEffect the backend provides.
  95      */
  96     QObject *createVolumeFaderEffect(QObject *parent = 0);
  97     /**
  98      * Create a new backend object for a AudioOutput.
  99      *
 100      * \return a pointer to the AudioOutput the backend provides.
 101      */
 102     QObject *createAudioOutput(QObject *parent = 0);
 103     /**
 104      * Create a new backend object for a AudioDataOutput.
 105      *
 106      * \return a pointer to the AudioDataOutput the backend provides.
 107      */
 108     PHONON_EXPORT QObject *createAudioDataOutput(QObject *parent = 0);
 109     /**
 110      * Create a new backend object for a Visualization.
 111      *
 112      * \return a pointer to the Visualization the backend provides.
 113      */
 114     PHONON_EXPORT QObject *createVisualization(QObject *parent = 0);
 115     /**
 116      * Create a new backend object for a VideoDataOutput.
 117      *
 118      * \return a pointer to the VideoDataOutput the backend provides.
 119      */
 120     PHONON_EXPORT QObject *createVideoDataOutput(QObject *parent = 0);
 121     /**
 122      * Create a new backend object for a VideoWidget.
 123      *
 124      * \return a pointer to the VideoWidget the backend provides.
 125      */
 126     QObject *createVideoWidget(QObject *parent = 0);
 127
 128     /**
 129      * \return a pointer to the backend interface.
 130      */
 131     PHONON_EXPORT QObject *backend(bool createWhenNull = true);
 132
 133     /**
 134      * Unique identifier for the Backend. Can be used in configuration files
 135      * for example.
 136      */
 137     QString identifier();
 138
 139     /**
 140      * Get the name of the Backend. It's the name from the .desktop file.
 141      */
 142     PHONON_EXPORT QString backendName();
 143
 144     /**
 145      * Get the comment of the Backend. It's the comment from the .desktop file.
 146      */
 147     QString backendComment();
 148
 149     /**
 150      * Get the version of the Backend. It's the version from the .desktop file.
 151      *
 152      * The version is especially interesting if there are several versions
 153      * available for binary incompatible versions of the backend's media
 154      * framework.
 155      */
 156     QString backendVersion();
 157
 158     /**
 159      * Get the icon (name) of the Backend. It's the icon from the .desktop file.
 160      */
 161     QString backendIcon();
 162
 163     /**
 164      * Get the website of the Backend. It's the website from the .desktop file.
 165      */
 166     QString backendWebsite();
 167
 168     /**
 169      * registers the backend object
 170      */
 171     PHONON_EXPORT QObject *registerQObject(QObject *o);
 172
 173     bool isMimeTypeAvailable(const QString &mimeType);
 174
 175     PHONON_EXPORT void registerFrontendObject(MediaNodePrivate *);
 176     PHONON_EXPORT void deregisterFrontendObject(MediaNodePrivate *);
 177
 178     PHONON_EXPORT void setBackend(QObject *);
 179     //PHONON_EXPORT void createBackend(const QString &library, const QString &version = QString());
 180
 181     PHONON_EXPORT PlatformPlugin *platformPlugin();
 182
 183 //X    It is probably better if we can get away with internal handling of
 184 //X    freeing the soundcard device when it's not needed anymore and
 185 //X    providing an IPC method to stop all MediaObjects -> free all
 186 //X    devices
 187 //X    /**
 188 //X     * \internal
 189 //X     * This is called when the application needs to free the soundcard
 190 //X     * device(s).
 191 //X     */
 192 //X    void freeSoundcardDevices();
 193 } // namespace Factory
 194 } // namespace Phonon
 195
 196 QT_END_NAMESPACE
 197 QT_END_HEADER
 198
 199 #endif // PHONON_FACTORY_P_H
 200 // vim: sw=4 ts=4