videographicsobjectinterface.h

/*
    Copyright (C) 2011 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) 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_VIDEOGRAPHICSOBJECTINTERFACE_H
#define PHONON_VIDEOGRAPHICSOBJECTINTERFACE_H

#include "videoframe.h"
namespace Phonon {


class VideoGraphicsObjectInterface
{
public:
    virtual ~VideoGraphicsObjectInterface() {}

    virtual void lock() = 0;

    virtual bool tryLock() = 0;

    virtual void unlock() = 0;

    virtual const VideoFrame *frame() const = 0;

    virtual QList<VideoFrame::Format> offering(QList<VideoFrame::Format> offers) = 0;

    // --------------------------- Q_INVOKABLES ----------------------------- //
    virtual void choose(VideoFrame::Format format) = 0;

    // ------------------------------ Signals ------------------------------- //
    virtual void frameReady() = 0;

    virtual void reset() = 0;

    virtual void needFormat() = 0;
};

} // namespace Phonon

Q_DECLARE_INTERFACE(Phonon::VideoGraphicsObjectInterface,
                    "org.kde.phonon.VideoGraphicsObjectInterface/1.0")

#endif // PHONON_VIDEOGRAPHICSOBJECTINTERFACE_H