ClipWorkflow.h 9.39 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"
27
#include "ClipHelper.h"
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
28

29
#include <QObject>
30
#include <QUuid>
31 32

class   QMutex;
33 34
class   QReadWriteLock;
class   QWaitCondition;
35 36 37 38 39

class   Clip;
class   WaitCondition;
class   LightVideoFrame;

40 41 42 43 44 45
namespace LibVLCpp
{
    class   MediaPlayer;
    class   Media;
}

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

    public:
51 52
        enum        State
        {
53
            None = -1,
54
            /// \brief  Used when the clipworkflow hasn't been started yet
55
            Stopped,            //0
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
56 57 58 59 60
            /**
             *  \brief  Used when initializing is in progress (until the mediaplayer
             *          enters the playing state.
             */
            Initializing,       //1
61
            /// \brief  Used when the clipworkflow is launched and active
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
62
            Rendering,          //2
63
            /// \brief  Used when stopping
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
64
            Stopping,           //3
65 66
            /// \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
67
            EndReached,         //4
68 69 70
            // 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
71
            UnpauseRequired,    //5
72 73
            /// \brief  This state will be used when a pause
            ///         has been required
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
74
            PauseRequired,      //6
75 76
            /// \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
77
            Paused,             //7
78
            /// \brief  This state means a clip is mutted and must not be restarted
79 80 81
            Muted,              //8
            /// \brief  An error was encountered, this ClipWorkflow must not be used anymore.
            Error,              //9
82 83
        };

84 85 86 87 88 89 90 91 92 93 94
        /**
         *  \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,
        };

95
        ClipWorkflow( ClipHelper* clip );
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
96 97
        virtual ~ClipWorkflow();

98
        /**
99 100 101
         *  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.
102
         */
103 104
        virtual void*           getOutput( ClipWorkflow::GetMode mode ) = 0;
        void                    postGetOutput();
105
        virtual void            initVlcOutput() = 0;
106
        void                    initialize();
107

108
        /**
109 110 111 112
         *  \return             true if the ClipWorkflow is able to, and should render
         *                      a frame.
         *
         *  This is true when the state is not stopped, stopping, nor rendering.
113
         */
114
        bool                    shouldRender() const;
115 116 117

        /**
         *  Returns the current workflow state.
118 119 120
         *  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.
121 122 123
         */
        State                   getState() const;

124
        /**
125
            \brief              Returns the ClipHelper this workflow instance is based
126
                                uppon, so that you can query information on it.
127
            \return             A pointer to a ClipHelper instance.
128
        */
129
        inline ClipHelper*      getClipHelper()
130
        {
131 132 133 134 135
            return m_clipHelper;
        }
        inline Clip*            clip()
        {
            return m_clipHelper->clip();
136 137
        }

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

148 149 150 151 152 153 154 155
        /**
         *  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 );
156

157 158 159 160 161 162 163
        /**
         *  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();

164
        bool                    waitForCompleteInit();
165

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

169 170
        LibVLCpp::MediaPlayer*  getMediaPlayer();

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

176 177 178
        void                    mute();
        void                    unmute();

179 180 181 182 183 184 185 186 187
        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();

188 189 190 191 192 193 194
        /**
         *  \brief              Stop the renderer part of the ClipWorkflow
         *
         *  IE. just stop the VLC thread, and do not flush anything.
         */
        void                    stopRenderer();

Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
195
    private:
196
        void                    setState( State state );
197
        void                    adjustBegin();
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
198

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

216 217 218 219 220
        /**
         *  \brief  Release the preallocated buffers
         */
        virtual void            releasePrealocated() = 0;

Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
221
    private:
222
        WaitCondition           *m_initWaitCond;
223 224 225 226 227 228 229
        /**
         *  \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;
230

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

253
    private slots:
254
        void                    loadingComplete();
255
        void                    clipEndReached();
256 257
        void                    mediaPlayerPaused();
        void                    mediaPlayerUnpaused();
258
        void                    resyncClipWorkflow();
259 260 261 262
        void                    errorEncountered();

    signals:
        void                    error();
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
263 264 265
};

#endif // CLIPWORKFLOW_H