mediasource.h

/*  This file is part of the KDE project
    Copyright (C) 2007 Matthias Kretz <kretz@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) version 3, or any
    later version accepted by the membership of KDE e.V. (or its
    successor approved by the membership of KDE e.V.), Nokia Corporation
    (or its successors, if any) and the KDE Free Qt Foundation, which shall
    act as a proxy defined in Section 6 of version 3 of the license.

    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/>.

*/

#ifndef PHONON_MEDIASOURCE_H
#define PHONON_MEDIASOURCE_H

#include "phonon_export.h"
#include "phononnamespace.h"

#include "mrl.h"
#include "objectdescription.h"

#include <QtCore/QSharedData>
#include <QtCore/QString>


class QUrl;
class QIODevice;

namespace Phonon
{

class MediaSourcePrivate;
class AbstractMediaStream;

class PHONON_EXPORT MediaSource
{
    friend class StreamInterface;
    friend QDebug operator <<(QDebug dbg, const Phonon::MediaSource &);
    public:
        enum Type {
            Invalid = -1,
            LocalFile,
            Url,
            Disc,
            Stream,
            CaptureDevice,
            Empty,
            AudioVideoCapture
/*          post 4.0:
            / **
             * Links multiple MediaSource objects together.
             * /
            Link
*/
        };

        MediaSource();

        PHONON_DEPRECATED MediaSource(const QString &fileName); //krazy:exclude=explicit

        MediaSource(const QUrl &url); //krazy:exclude=explicit

        MediaSource(DiscType discType, const QString &deviceName = QString()); //krazy:exclude=explicit

#ifndef PHONON_NO_AUDIOCAPTURE

        MediaSource(const AudioCaptureDevice& device);
#endif

#ifndef PHONON_NO_VIDEOCAPTURE

        MediaSource(const VideoCaptureDevice& device);
#endif

#if !defined(PHONON_NO_VIDEOCAPTURE) && !defined(PHONON_NO_AUDIOCAPTURE)

        MediaSource(Capture::DeviceType deviceType, CaptureCategory category = NoCaptureCategory);

        MediaSource(CaptureCategory category);
#endif

#ifndef QT_NO_PHONON_ABSTRACTMEDIASTREAM

        MediaSource(AbstractMediaStream *stream); //krazy:exclude=explicit

        MediaSource(QIODevice *ioDevice); //krazy:exclude=explicit
#endif

        ~MediaSource();

        MediaSource(const MediaSource &rhs);

        MediaSource &operator=(const MediaSource &rhs);

        bool operator==(const MediaSource &rhs) const;

        void setAutoDelete(bool enable);

        bool autoDelete() const;

        Type type() const;

        QString fileName() const;

        Mrl mrl() const;

        QUrl url() const;

        DiscType discType() const;

        const DeviceAccessList& deviceAccessList() const;

        const DeviceAccessList& videoDeviceAccessList() const;

        const DeviceAccessList& audioDeviceAccessList() const;

        QString deviceName() const;

#ifndef QT_NO_PHONON_ABSTRACTMEDIASTREAM

        AbstractMediaStream *stream() const;
#endif

#ifndef PHONON_NO_AUDIOCAPTURE

        AudioCaptureDevice audioCaptureDevice() const;
#endif

#ifndef PHONON_NO_VIDEOCAPTURE

        VideoCaptureDevice videoCaptureDevice() const;
#endif

/*      post 4.0:
        MediaSource(const QList<MediaSource> &mediaList);
        QList<MediaSource> substreams() const;
*/

    protected:
        QExplicitlySharedDataPointer<MediaSourcePrivate> d;
        MediaSource(MediaSourcePrivate &);

        PHONON_DEPRECATED MediaSource(const DeviceAccess &access);
};

PHONON_EXPORT QDebug operator <<(QDebug dbg, const Phonon::MediaSource &);

} // namespace Phonon


#endif // PHONON_MEDIASOURCE_H