ClipWorkflow.h 7.97 KB
Newer Older
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
/*****************************************************************************
 * ClipWorkflow.h : Clip workflow. Will extract a single frame from a VLCMedia
 *****************************************************************************
 * Copyright (C) 2008-2009 the VLMC team
 *
 * 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

//TODO: THIS HAS TO GO REALLY REALLY REALLY SOON !!!!
//FIXME:
//UGLY:
#define VIDEOWIDTH 640
#define VIDEOHEIGHT 480

#include <QReadWriteLock>
#include <QMutex>
34
#include "WaitCondition.hpp"
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
35
#include <QObject>
36
#include <QQueue>
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
37 38 39 40 41 42 43 44 45

#include "Clip.h"
#include "VLCMediaPlayer.h"

class   ClipWorkflow : public QObject
{
    Q_OBJECT

    public:
46 47
        enum        State
        {
48
            None = -1,
49 50 51 52 53 54 55
            Stopped,        //0
            Initializing,   //1
            Ready,          //2
            Rendering,      //3
            Sleeping,       //4
            Pausing,        //5
            Paused,         //6
56 57 58
            ThreadPaused,   //7
            Stopping,       //8
            EndReached,     //9
59
        };
60
       int                     debugId;
61

62
        ClipWorkflow( Clip* clip );
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
63 64
        virtual ~ClipWorkflow();

65
        /**
66 67 68
         *  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.
69
         */
70
        unsigned char*          getOutput();
71
        void                    initialize();
72 73 74 75 76
        /**
         *  Return true ONLY if the state is equal to Ready.
         *  If the state is Rendering, EndReached or anything else, this will
         *  return false.
         */
77
        bool                    isReady() const;
78 79 80 81
        /**
         *  Return true ONLY if the state is equal to EndReached.
         *  In any other cases, this will return false.
         */
82
        bool                    isEndReached() const;
83 84 85 86 87 88 89 90

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

        /**
91
         *  Return true ONLY if the state is equal to Rendering.
92 93 94 95
         *  In any other cases, this will return false.
         */
        bool                    isRendering() const;

96 97
        bool                    isPausing() const;

98 99
        bool                    isThreadPaused() const;

100 101
        /**
         *  Returns the current workflow state.
102 103 104
         *  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.
105 106 107 108 109 110 111 112
         */
        State                   getState() const;

        /**
         *  This method start the effective render, ie calling the play() method
         *  on the media player.
         *  If the media player isn't ready, this method waits.
         */
113
        void                    startRender();
114

115 116 117 118 119
        /**
            \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.
        */
120
        Clip*                   getClip();
121 122 123 124
        /**
            \brief  Stop this workflow.
        */
        void                    stop();
125
        void                    pause();
126
        void                    setPosition( float pos );
127

128 129 130 131 132 133 134 135
        /**
         *  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 );
136

137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
        /**
         *  This method will wake the renderer thread for one iteration.
         */
        void                    wake();

        /**
         *  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();

        /**
         *  Put back the ClipWorkflow in its initial state.
         */
        void                    reinitialize();

154 155
        void                    unpause( bool wakeRenderThread = true );

156
        void                    waitForCompleteInit();
157
        void                    waitForCompleteRender( bool dontCheckRenderStarted = false );
158
        void                    waitForPausingState();
159
        void                    waitForPausedThread();
160
        QMutex*                 getSleepMutex();
161

162 163
        LibVLCpp::MediaPlayer*  getMediaPlayer();

Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
164 165 166
    private:
        static void             lock( ClipWorkflow* clipWorkflow, void** pp_ret );
        static void             unlock( ClipWorkflow* clipWorkflow );
167
        void                    setVmem();
168
        void                    setState( State state );
169
        void                    checkSynchronisation( State newState );
170 171 172
        /**
         *  Don't ever call this method from anywhere else than the unlock() method
         */
173
        void                    checkStateChange();
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
174 175 176

    private:
        Clip*                   m_clip;
177 178 179 180 181 182

        /**
         *  \brief  The VLC media used to render
         */
        LibVLCpp::Media*        m_vlcMedia;

183 184 185
        QQueue<unsigned char*>  m_availableBuffers;
        QQueue<unsigned char*>  m_buffers;
        QMutex*                 m_buffersLock;
186 187

        LibVLCpp::MediaPlayer*  m_mediaPlayer;
188

Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
189
        QMutex*                 m_condMutex;
190
        QWaitCondition*         m_waitCond;
191

192 193
        State                   m_state;
        QReadWriteLock*         m_stateLock;
194 195
        State                   m_requiredState;
        QMutex*                 m_requiredStateLock;
196

197 198
        QAtomicInt              m_oneFrameOnly;

199
        WaitCondition*          m_initWaitCond;
200 201
        WaitCondition*          m_renderWaitCond;
        WaitCondition*          m_pausingStateWaitCond;
202
        WaitCondition*          m_pausedThreadCondWait;
203

204 205 206 207 208 209 210 211 212 213 214 215
        /**
         *  While this flag is set to false, we will use the same buffer, to prevent
         *  having X buffers with the same picture (when media player is paused mainly)
         */
        bool                                    m_rendering;
        /**
         *  This flag is here to avoid multiple connection to the mediaPlayer* slots.
         *  It's essentially a nasty hack due to the multiples calls to lock/unlock when
         *  the render is started, and that cannot really be avoided...
         */
        bool                                    m_initFlag;

216
    private slots:
217
        void                    pauseAfterPlaybackStarted();
218
        void                    initializedMediaPlayer();
219
        void                    setPositionAfterPlayback();
220 221 222

    public slots:
        void                    clipEndReached();
223 224 225

    signals:
        void                    renderComplete( ClipWorkflow* );
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
226 227 228
};

#endif // CLIPWORKFLOW_H