gls_movie_texture.h

Go to the documentation of this file.

/*! \file
  \brief The GlsMovieTexture class

  \par Copyright Information

  Copyright (c) 2017 by The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/
#ifndef INCLUDE_GLS_MOVIE_TEXTURE_H
#define INCLUDE_GLS_MOVIE_TEXTURE_H
#include "glpolygon.h"
#include "gls_cpp_lang_support.h"

//////////////////// Provides support for creating DLLs ////////////////////////
#if( defined( GLSGEN_EXPORT_GLSMOVIETEXTURE ) || defined( GLSGEN_IMPORT_GLSMOVIETEXTURE ) || defined( GLS_EXPORT_GENERATED ) || defined( GLS_IMPORT_GENERATED ) ) \
    && defined( _MSC_VER )
#    if defined( GLSGEN_EXPORT_GLSMOVIETEXTURE ) || defined( GLS_EXPORT_GENERATED )
#        define GLSGEN_GLSMOVIETEXTURE_EXPORT __declspec( dllexport )
#    else
#        define GLSGEN_GLSMOVIETEXTURE_EXPORT __declspec( dllimport )
#    endif
#else
#    define GLSGEN_GLSMOVIETEXTURE_EXPORT
#endif
///////////////////////////////////////////////////////////////////////////////

#define LIB_BASE_NAME "gls_movie_texture"
#include "gls_auto_lib.h"
#undef LIB_BASE_NAME

// Force inclusion of the DirectShow library
#ifndef NO_GLS_AUTOLIB
#    define LIB_BASE_NAME "strmbase"
#    ifdef GLS_LIB_TYPE
#        undef GLS_LIB_TYPE
#    endif
#    define GLS_LIB_TYPE ""
#    include "gls_auto_lib.h"
#    undef GLS_LIB_TYPE
#    undef LIB_BASE_NAME
#endif

class CVideoTexture;

namespace disti
{
// SetValue enumerations
enum
{
    GLS_GLSMOVIETEXTURE_FIRST_VALUE = GLS_LAST_INITIALIZER + 1,
    GLS_GLSMOVIETEXTURE_MOVIESOURCE,
    GLS_GLSMOVIETEXTURE_LOOP,
    GLS_GLSMOVIETEXTURE_SOUNDENABLED,
    GLS_GLSMOVIETEXTURE_SOUNDVOLUME
};

/** Runtime implementation of a GlsMovieTexture */
class GlsMovieTexture : public GLPolygon
{
    friend class GlsMovieTextureEditor;

private:
    GlsMovieTexture& operator=( const GlsMovieTexture& ) DISTI_SPECIAL_MEM_FUN_DELETE;
    GlsMovieTexture( const GlsMovieTexture& ) DISTI_SPECIAL_MEM_FUN_DELETE;

public:
    DISTI_DEPRECATED( "This identifier is forbidden by the C++ standard. Use BaseClass instead." )
    typedef GLPolygon _BaseClass;
    typedef GLPolygon BaseClass;

    /** Create a new GlsMovieTexture.
      * \param generateInstance  Whether or not to generate an instance name
      * for this inputdevice */
    GLSGEN_GLSMOVIETEXTURE_EXPORT GlsMovieTexture( bool generateInstance = false );

    GLSGEN_GLSMOVIETEXTURE_EXPORT GlsMovieTexture( const GlsMovieTexture& that, const bool generateNames );

    /** Destructs a GlsMovieTexture object */
    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT ~GlsMovieTexture();

    static GLSGEN_GLSMOVIETEXTURE_EXPORT DisplayObject* CreateInstance();

    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT void SetAvailableAttributes( unsigned int value );

    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT DisplayObject* CloneObject( bool generateNames = false );

    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT void CopyProperties( DisplayObject* src );

    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT InterfaceListType* GetCppInterfaceDescription( InterfaceListType* addToThisList = NULL );
    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT void               GetCppInterfaceDescriptionFree( InterfaceListType* array );

    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT void PreDraw( const OpenGLMatrices& parentMatrices, Culler& culler );
    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT void Draw( void );
    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT void Calculate( double time );

    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT void SetValue( int spec, va_list& args );

    //////////////////////////////////////////////////
    // GlsMovieTexture specific operations
    //////////////////////////////////////////////////
    /** Sets the desired video source file */
    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT void MovieSource( const GlsPropString& s );
    /** Gets the capture device index */
    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT GlsPropString MovieSource();

    /** Sets the looping state of the movie. should_loop == true will cause the movie to "rewind" and start playing again when the end is reached. */
    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT void Loop( const bool& should_loop );
    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT bool Loop();

    /** Sets the playing state of the movie.  should_play == false is equivalent to STOP */
    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT void Playing( const bool& should_play );
    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT bool Playing();

    /** Sets the paused state of the movie. */
    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT void Paused( const bool& should_pause );
    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT bool Paused();

    /** Sets the position of the stream pointer by percent. */
    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT void  PlayPosition( const float& pct );
    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT float PlayPosition();

    /** Sets the position of the stream pointer by frame number. */
    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT void         CurrentAbsoluteFrame( const unsigned int& frame );
    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT unsigned int CurrentAbsoluteFrame();

    /** Sets the audio playback behavior. */
    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT void SoundEnabled( const bool& soundon );
    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT bool SoundEnabled();

    /** Sets the audio volume */
    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT void  SoundVolume( const float& volume );
    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT float SoundVolume();

    /** Gets the length of the movie (in milliseconds). */
    virtual GLSGEN_GLSMOVIETEXTURE_EXPORT int DurationInMS();

protected:
    // Stores the name of the movie file
    GlsPropString _movieFile;

    // States whether sound should be enabled or not
    bool _soundEnabled;

    // Controls colume of sound (from 0.0f to 1.0f)
    float _soundVolume;

    // Stores the current play position percent
    float _playPositionPercent;

    // Stores the previous play position percent
    float _previousPlayPositionPercent;

    // Stores the current frame of the movie
    unsigned int _currentAbsoluteFrame;

    // Stores the previous frame count
    unsigned int _previousAbsoluteFrame;

    // Instance of CVideoTexture class that interfaces with D3D
    CVideoTexture* _vidTex;
};

} // namespace disti

#endif