ClipWorkflow.h 9.04 KB
Newer Older
1
 /*****************************************************************************
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
2 3
 * ClipWorkflow.h : Clip workflow. Will extract a single frame from a VLCMedia
 *****************************************************************************
Ludovic Fauvet's avatar
Ludovic Fauvet committed
4
 * Copyright (C) 2008-2010 VideoLAN
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
 *
 * Authors: Hugo Beauzee-Luyssen <hugo@vlmc.org>
 *
 * 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; either version 2
 * of the License, or (at your option) any later version.
 *
 * 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/

#ifndef CLIPWORKFLOW_H
#define CLIPWORKFLOW_H

26
#include "mdate.h"
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
27

28 29 30
#include <QObject>

class   QMutex;
31 32
class   QReadWriteLock;
class   QWaitCondition;
33 34 35 36 37

class   Clip;
class   WaitCondition;
class   LightVideoFrame;

38 39 40 41 42 43
namespace LibVLCpp
{
    class   MediaPlayer;
    class   Media;
}

Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
44 45 46 47 48
class   ClipWorkflow : public QObject
{
    Q_OBJECT

    public:
49 50
        enum        State
        {
51
            None = -1,
52
            /// \brief  Used when the clipworkflow hasn't been started yet
53
            Stopped,            //0
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
54 55 56 57 58
            /**
             *  \brief  Used when initializing is in progress (until the mediaplayer
             *          enters the playing state.
             */
            Initializing,       //1
59
            /// \brief  Used when the clipworkflow is launched and active
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
60
            Rendering,          //2
61
            /// \brief  Used when stopping
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
62
            Stopping,           //3
63 64
            /// \brief  Used when end is reached, IE no more frame has to be rendered, but the trackworkflow
            ///         may eventually ask for some.
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
65
            EndReached,         //4
66 67 68
            // Here starts internal states :
            /// \brief  This state will be used when an unpause
            ///         has been required
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
69
            UnpauseRequired,    //5
70 71
            /// \brief  This state will be used when a pause
            ///         has been required
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
72
            PauseRequired,      //6
73 74
            /// \brief  This state will be used when the media player is paused,
            ///         because of a sufficient number of computed buffers
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
75
            Paused,             //7
76 77
            /// \brief  This state means a clip is mutted and must not be restarted
            Muted,
78 79
        };

80 81 82 83 84 85 86 87 88 89 90
        /**
         *  \brief  Used to know which way you want to get a computed output.
         *          Pop: the buffer is popped and returned
         *          Get: the buffer is just returned (for paused mode for instance)
         */
        enum        GetMode
        {
            Pop,
            Get,
        };

91
        ClipWorkflow( Clip* clip );
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
92 93
        virtual ~ClipWorkflow();

94
        /**
95 96 97
         *  This method returns the current frame. It locks the renderMutex,
         *  therefore, you can call this method blindly, without taking care
         *  of the rendering process advancement.
98
         */
99 100
        virtual void*           getOutput( ClipWorkflow::GetMode mode ) = 0;
        void                    postGetOutput();
101
        virtual void            initVlcOutput() = 0;
102
        void                    initialize();
103

104 105 106 107
        /**
         *  Return true ONLY if the state is equal to EndReached.
         *  In any other cases, this will return false.
         */
108
        bool                    isEndReached() const;
109 110 111 112 113 114 115 116

        /**
         *  Return true ONLY if the state is equal to Stopped.
         *  In any other cases, this will return false.
         */
        bool                    isStopped() const;

        /**
117
         *  Return true ONLY if the state is equal to Rendering.
118 119 120 121 122 123
         *  In any other cases, this will return false.
         */
        bool                    isRendering() const;

        /**
         *  Returns the current workflow state.
124 125 126
         *  Be carrefull, as this function is NOT thread safe, and return the
         *  state without locking the state.
         *  It's your job to do it, by calling the getStateLock() method.
127 128 129
         */
        State                   getState() const;

130 131 132 133 134
        /**
            \brief              Returns the Clip this workflow instance is based
                                uppon, so that you can query information on it.
            \return             A pointer to a constant clip instance.
        */
135 136 137 138 139
        inline Clip*            getClip()
        {
            return m_clip;
        }

140 141 142 143
        /**
            \brief  Stop this workflow.
        */
        void                    stop();
144 145 146 147
        /**
         *  \brief  Set the rendering position
         *  \param  time    The position in millisecond
         */
148
        void                    setTime( qint64 time );
149

150 151 152 153 154 155 156 157
        /**
         *  This method must be used to change the state of the ClipWorkflow
         *  from outside its render loop, otherwise, it may lead to deadlocks.
         *  No additional operations will be executed (for example, if setting
         *  the new state to stop, the media player won't be stopped.)
         *  This is mainly to change the behaviour of the render loop.
         */
        void                    queryStateChange( State newState );
158

159 160 161 162 163 164 165
        /**
         *  This returns the QReadWriteLock that protects the ClipWorkflow's state.
         *  It should be use to lock the value when checking states from outside this
         *  class.
         */
        QReadWriteLock*         getStateLock();

166
        void                    waitForCompleteInit();
167

Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
168 169
        virtual void*           getLockCallback() const = 0;
        virtual void*           getUnlockCallback() const = 0;
170

171 172
        LibVLCpp::MediaPlayer*  getMediaPlayer();

173 174 175 176 177
        /**
         *  \sa MainWorkflow::setFullSpeedRender();
         */
        void                    setFullSpeedRender( bool val );

178 179 180
        void                    mute();
        void                    unmute();

181 182 183 184 185 186 187 188 189
        void                    requireResync();
        /**
         *  \return true if a resync is required.
         *
         *  If a resync is required, true will be returned, and the flag will be
         *  set back to false
         */
        bool                    isResyncRequired();

Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
190
    private:
191
        void                    setState( State state );
192
        void                    adjustBegin();
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
193

194
    protected:
195
        void                    computePtsDiff( qint64 pts );
196
        void                    commonUnlock();
197 198 199 200 201
        /**
         *  \warning    Must be called from a thread safe context.
         *              This thread safe context has to be set
         *              from the underlying ClipWorkflow implementation.
         */
202 203
        virtual quint32         getNbComputedBuffers() const = 0;
        virtual quint32         getMaxComputedBuffers() const = 0;
204 205 206 207 208
        /**
         *  \brief  Will empty the computed buffers stack.
         *          This has to be implemented in the underlying
         *          clipworkflow implementation.
         */
209 210
        virtual void            flushComputedBuffers() = 0;

211 212 213 214 215
        /**
         *  \brief  Release the preallocated buffers
         */
        virtual void            releasePrealocated() = 0;

Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
216
    private:
217
        WaitCondition           *m_initWaitCond;
218 219 220 221 222 223 224
        /**
         *  \brief              Used by the trackworkflow to query a clipworkflow resync.
         *
         *  Basically, this will be used when a clip is moved, and therefore has to be
         *  updated.
         */
        QAtomicInt              m_resyncRequired;
225

226
    protected:
227
        LibVLCpp::MediaPlayer*  m_mediaPlayer;
228
        Clip*                   m_clip;
229 230 231
        QMutex*                 m_renderLock;
        QReadWriteLock*         m_stateLock;
        State                   m_state;
232 233
        qint64                  m_previousPts;
        qint64                  m_currentPts;
234 235 236 237
        /**
         *  \brief  The VLC media used to render
         */
        LibVLCpp::Media*        m_vlcMedia;
238 239 240 241 242
        /**
         *  \brief  This is used for basic synchronisation when
         *          the clipworkflow hasn't generate a frame yet,
         *          while the renderer asks for one.
         */
243
        QWaitCondition          *m_renderWaitCond;
244 245
        qint64                  m_beginPausePts;
        qint64                  m_pauseDuration;
246
        bool                    m_fullSpeedRender;
247

248
    private slots:
249
        void                    loadingComplete();
250
        void                    clipEndReached();
251 252
        void                    mediaPlayerPaused();
        void                    mediaPlayerUnpaused();
253
        void                    resyncClipWorkflow();
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
254 255 256
};

#endif // CLIPWORKFLOW_H