gls_video_to_texture.h

Go to the documentation of this file.

/*! \file
  \brief The GlsVideoToTexture 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_VIDEO_TO_TEXTURE_H
#define INCLUDE_VIDEO_TO_TEXTURE_H
 
#include "glpolygon.h"
#include "gls_cpp_lang_support.h"
 
/// Provides support for creating DLLs.
#if( defined( GLSGEN_EXPORT_GLSVIDEOTOTEXTURE ) || defined( GLSGEN_IMPORT_GLSVIDEOTOTEXTURE ) || defined( GLS_EXPORT_GENERATED ) || defined( GLS_IMPORT_GENERATED ) ) \
    && defined( _MSC_VER )
#    if defined( GLSGEN_EXPORT_GLSVIDEOTOTEXTURE ) || defined( GLS_EXPORT_GENERATED )
#        define GLSGEN_GLSVIDEOTOTEXTURE_EXPORT __declspec( dllexport )
#    else
#        define GLSGEN_GLSVIDEOTOTEXTURE_EXPORT __declspec( dllimport )
#    endif
#else
#    define GLSGEN_GLSVIDEOTOTEXTURE_EXPORT
#endif
///////////////////////////////////////////////////////////////////////////////
 
/// Automatically link the runtime library plugin (on Windows).
#define LIB_BASE_NAME "gls_video_to_texture"
#include "gls_auto_lib.h"
#undef LIB_BASE_NAME
 
/// Force inclusion of the DirectShow library.
#ifdef NO_GLS_AUTOLIB
#    define LIB_BASE_NAME "strmbase"
#    ifdef GLS_LIB_TYPE
#        undef GLS_LIB_TYPE
#    endif
/// DirectShow is always statically linked.
#    define GLS_LIB_TYPE ""
#    include "gls_auto_lib.h"
#    undef GLS_LIB_TYPE
#    undef LIB_BASE_NAME
#endif
 
namespace disti
{
class GlsVideoToTextureSource;
 
// SetValue enumerations
enum
{
    GLS_GLSVIDEOTOTEXTURE_FIRST_VALUE = GLS_LAST_INITIALIZER + 1,
    GLS_GLSVIDEOTOTEXTURE_CAPTUREDEVICE
};
 
/** Runtime implementation of a GlsVideoToTexture */
class GlsVideoToTexture : public GLPolygon
{
    friend class GlsVideoToTextureEditor;
 
private:
    GlsVideoToTexture& operator=( const GlsVideoToTexture& ) DISTI_SPECIAL_MEM_FUN_DELETE;
    GlsVideoToTexture( const GlsVideoToTexture& ) DISTI_SPECIAL_MEM_FUN_DELETE;
 
public:
    DISTI_DEPRECATED( "This identifier is forbidden by the C++ standard. Use BaseClass instead." )
    typedef GLPolygon _BaseClass; ///< Deprecated typedef for the base class.
    typedef GLPolygon BaseClass;  ///< Typedef for the base class.
 
    /// Constructor
    /// \param generateInstance Whether or not to generate an instance name for this object.
    GLSGEN_GLSVIDEOTOTEXTURE_EXPORT GlsVideoToTexture( bool generateInstance = false );
 
    /// Copy constructor
    /// \param that The object to copy from.
    /// \param generateNames Whether or not to generate an instance name for this object.
    GLSGEN_GLSVIDEOTOTEXTURE_EXPORT GlsVideoToTexture( const GlsVideoToTexture& that, const bool generateNames );
 
    /** Destructs a GlsVideoToTexture object */
    virtual GLSGEN_GLSVIDEOTOTEXTURE_EXPORT ~GlsVideoToTexture();
 
    /// \return A pointer to a new GlsVideoToTexture object.
    static GLSGEN_GLSVIDEOTOTEXTURE_EXPORT DisplayObject* CreateInstance();
 
    virtual GLSGEN_GLSVIDEOTOTEXTURE_EXPORT void SetAvailableAttributes( unsigned int value ) DISTI_METHOD_OVERRIDE;
 
    virtual GLSGEN_GLSVIDEOTOTEXTURE_EXPORT DisplayObject* CloneObject( bool generateNames = false ) DISTI_METHOD_OVERRIDE;
 
    virtual GLSGEN_GLSVIDEOTOTEXTURE_EXPORT void CopyProperties( DisplayObject* src ) DISTI_METHOD_OVERRIDE;
 
    virtual GLSGEN_GLSVIDEOTOTEXTURE_EXPORT InterfaceListType* GetCppInterfaceDescription( InterfaceListType* addToThisList = NULL ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GLSVIDEOTOTEXTURE_EXPORT void               GetCppInterfaceDescriptionFree( InterfaceListType* array ) DISTI_METHOD_OVERRIDE;
 
    virtual GLSGEN_GLSVIDEOTOTEXTURE_EXPORT void PreDraw( const OpenGLMatrices& parentMatrices, Culler& culler ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GLSVIDEOTOTEXTURE_EXPORT void Draw() DISTI_METHOD_OVERRIDE;
 
    virtual GLSGEN_GLSVIDEOTOTEXTURE_EXPORT void SetValue( int spec, va_list& args ) DISTI_METHOD_OVERRIDE;
 
    //////////////////////////////////////////////////
    // GlsVideoToTexture specific operations
    //////////////////////////////////////////////////
 
    /// Sets the desired capture device index.
    /// \param value The new capture device index to set.
    virtual GLSGEN_GLSVIDEOTOTEXTURE_EXPORT void CaptureDevice( const int& value );
 
    /// \return The current capture device index.
    virtual GLSGEN_GLSVIDEOTOTEXTURE_EXPORT int CaptureDevice();
 
    /// Specifies how many execution frames required to update on texture.
    /// 1 == Full update in one frame.
    /// \param value The new number of execution frames.
    virtual GLSGEN_GLSVIDEOTOTEXTURE_EXPORT void NumUpdateBlocks( const int& value );
 
    /// \return The number of execution frames required to update.
    virtual GLSGEN_GLSVIDEOTOTEXTURE_EXPORT int NumUpdateBlocks();
 
protected:
    int                      _captureDevice;   ///< The index of the device providing video input.
    int                      _numUpdateBlocks; ///< The number of execution frames required to update on texture.
    GlsVideoToTextureSource* _videoSource;     ///< Observing pointer to the underlying video source device.
};
 
} // namespace disti
 
#endif