gzVideo.h

Go to the documentation of this file.

//******************************************************************************
// File         : gzVide.h
// Module       : gzBase
// Description  : Class definition of the gzVideo class
// Author       : Anders Modén      
// Product      : GizmoBase 2.1.1
//      
// Copyright © 2003- Saab Training Systems AB, Sweden
//          
// NOTE:    GizmoBase is a platform abstraction utility layer for C++. It contains 
//          design patterns and C++ solutions for the advanced programmer.
//
//
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  060630  Created file    
//
//******************************************************************************
#ifndef __GZ_VIDEO_H__
#define __GZ_VIDEO_H__

#include "gzImage.h"

const gzULong GZ_INVALID_FRAME=0xffffffffUL;    

class gzVideoControlInterface
{
public:

    virtual gzVoid updateFrame(gzULong frame)=0;

    virtual gzBool skipFrame(gzULong frame)=0;

    virtual gzBool forceFrame(gzULong frame)=0;

    virtual gzBool discardFrame(gzULong frame)=0;

    virtual gzDouble getCurrentTime()=0;

    virtual gzULongLong getCurrentTimeStamp()=0;
};

typedef gzVideoControlInterface * gzVideoControlInterfacePtr;

const gzString GZ_VIDEO_CONTROL_INTERFACE="gzVideoControlInterface";


class gzVideo : public gzImage
{
public:

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_BASE_EXPORT);   // typed interface

    GZ_BASE_EXPORT gzVideo(const gzString & name=GZ_EMPTY_STRING);
    GZ_BASE_EXPORT virtual ~gzVideo(){};
    
    GZ_BASE_EXPORT gzVoid   setTime(const gzDouble &seconds);
    GZ_BASE_EXPORT gzBool   setFrame(gzULong frameNumber);

    GZ_BASE_EXPORT gzVoid   start(const gzDouble &startTime=0);
    GZ_BASE_EXPORT gzVoid   stop();

    GZ_BASE_EXPORT gzULong  getCurrentFrame();

    GZ_BASE_EXPORT gzULong  updateFrameCount();

    GZ_BASE_EXPORT virtual  gzBool onFrame(gzULong frame){ return FALSE; }

    GZ_BASE_EXPORT virtual  gzVoid restart(){};
    
    GZ_BASE_EXPORT virtual  gzUByte getVideoComponents();

    GZ_BASE_EXPORT virtual gzVoid reset();

    GZ_BASE_EXPORT virtual gzBool enableVideoThread(gzBool videoThread=TRUE){ return FALSE; }
    GZ_BASE_EXPORT virtual gzBool enableAudioThread(gzBool audioThread=TRUE){ return FALSE; }
    GZ_BASE_EXPORT virtual gzBool hasVideoThread() { return FALSE; }
    GZ_BASE_EXPORT virtual gzBool hasAudioThread() { return FALSE; }
    
    GZ_PROPERTY_EXPORT(     gzULong,                    FrameCount          ,GZ_BASE_EXPORT);
    GZ_PROPERTY_EXPORT(     gzULong,                    MaxLagFrames        ,GZ_BASE_EXPORT);
    GZ_PROPERTY_EXPORT(     gzDouble,                   FrameDuration       ,GZ_BASE_EXPORT);
    GZ_PROPERTY_GET_EXPORT( gzDouble,                   RealTimeStartDiff   ,GZ_BASE_EXPORT);
    GZ_PROPERTY_EXPORT(     gzVideoControlInterfacePtr, ControlInterface    ,GZ_BASE_EXPORT);
    GZ_PROPERTY_EXPORT(     gzDouble,                   FramesPerSecond     ,GZ_BASE_EXPORT);
    GZ_PROPERTY_EXPORT(     gzString,                   VideoInfo           ,GZ_BASE_EXPORT);
    GZ_PROPERTY_EXPORT(     gzString,                   AudioInfo           ,GZ_BASE_EXPORT);

private:

    gzDouble    m_startTime;
    gzBool      m_running;

    gzULong     m_currentFrame;
};

#endif //__GZ_VIDEO_H__

---