CVideo.h

Go to the documentation of this file.

//==============================================================================
/*
    Software License Agreement (BSD License)
    Copyright (c) 2003-2016, CHAI3D.
    (www.chai3d.org)

    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:

    * Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.

    * Redistributions in binary form must reproduce the above
    copyright notice, this list of conditions and the following
    disclaimer in the documentation and/or other materials provided
    with the distribution.

    * Neither the name of CHAI3D nor the names of its contributors may
    be used to endorse or promote products derived from this software
    without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE. 

    \author    <http://www.chai3d.org>
    \author    Sebastien Grange
    \version   3.2.0 $Rev: 1884 $
*/
//==============================================================================

//------------------------------------------------------------------------------
#ifndef CVideoH
#define CVideoH
//------------------------------------------------------------------------------
#include "graphics/CImage.h"
#include "timers/CPrecisionClock.h"
#include "system/CMutex.h"
//------------------------------------------------------------------------------
#include <memory>
//------------------------------------------------------------------------------
namespace chai3d {
//------------------------------------------------------------------------------

//==============================================================================
//==============================================================================

//------------------------------------------------------------------------------
class cVideo;
typedef std::shared_ptr<cVideo> cVideoPtr;
//------------------------------------------------------------------------------

//==============================================================================
//==============================================================================
class cVideo
{
    //--------------------------------------------------------------------------
    // CONSTRUCTOR & DESTRUCTOR:
    //--------------------------------------------------------------------------

public:

    cVideo();

    virtual ~cVideo();

    static cVideoPtr create() { return (std::make_shared<cVideo>()); }


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - GENERAL COMMANDS:
    //--------------------------------------------------------------------------

public:

    cVideoPtr copy();

    void erase() { cleanup(); }

    inline bool isInitialized() const { return (m_clip != NULL); }

    inline unsigned int getWidth() const { return (m_width);  }

    inline unsigned int getHeight() const { return (m_height); }

    inline unsigned int getFrameCount() const { return (m_frameCount); }

    inline double getDuration() const { return (m_duration); }

    inline double getFPS() const { return (m_fps); }


    //-----------------------------------------------------------------------
    // PUBLIC METHODS - MANIPULATING VIDEO:
    //--------------------------------------------------------------------------

public:

    void play();

    void setPlaybackSpeed(double a_speed);

    double getPlaybackSpeed();

    void pause();

    void stop();

    void setAutoReplay(bool a_replay = true);

    bool isPaused();

    bool seek(double a_time);

    bool seekFrame(unsigned int a_index);

    int getCurrentFrameIndex() { return (m_frameIndex); }

    double getCurrentTimePosition();

    bool getCurrentFramePointer(cImage &a_image);

    bool getCurrentFrame(cImage &a_image);

    bool getFramePointer(int a_index, cImage &a_image);

    bool getFrame(int a_index, cImage &a_image);


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - FILES:
    //--------------------------------------------------------------------------

public:

    bool loadFromFile(const std::string& a_filename);

    std::string getFilename() const { return (m_filename); }

    std::string getName() const { return (m_name); }


    //--------------------------------------------------------------------------
    // PROTECTED  METHODS:
    //--------------------------------------------------------------------------

protected:

    void defaults();

    void cleanup();

    bool update();

    void reset();

    inline void storeFrame(void *frame);


    //--------------------------------------------------------------------------
    // PROTECTED MEMBERS:
    //--------------------------------------------------------------------------

protected:

    std::string m_filename;

    std::string m_name;

    unsigned int m_width;

    unsigned int m_height;

    unsigned int m_frameCount;

    unsigned int m_frameIndex;

    double m_duration;

    double m_lastUpdate;

    bool m_firstFrame;

    bool m_autoReplay;

    double m_fps;

    cPrecisionClock m_clock;

    void *m_clip;

    unsigned char *m_data;

    static unsigned int m_clipCount;

    static cMutex m_sharedLock;

    static void *m_manager;

    static void *m_audio;
};

//------------------------------------------------------------------------------
} // namespace chai3d
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
#endif
//------------------------------------------------------------------------------