fbvideo.h

Go to the documentation of this file.

#ifndef __FBVIDEO_H__
#define __FBVIDEO_H__
/**************************************************************************
Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
All Rights Reserved.

The coded instructions, statements, computer programs, and/or related 
material (collectively the "Data") in these files contain unpublished 
information proprietary to Autodesk, Inc. and/or its licensors, which is 
protected by Canada and United States of America federal copyright law 
and by international treaties.

The Data may not be disclosed or distributed to third parties, in whole 
or in part, without the prior written consent of Autodesk, Inc. 
("Autodesk").

THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO 
WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR 
ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES 
OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR 
PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT 
WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR 
FREE.

IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS 
OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR 
EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE 
DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS 
OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR 
DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF 
LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT 
LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE 
DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS 
BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.

**************************************************************************/

#include <kaydaradef.h>
#ifndef FBSDK_DLL 

#define FBSDK_DLL K_DLLIMPORT
#endif

#include <fbsdk/fbcomponent.h>
#include <fbsdk/fbcore.h>

#ifdef FBSDKUseNamespace
namespace FBSDKNamespace {
#endif

    FB_DEFINE_COMPONENT( FBSDK_DLL, Video           );
    FB_DEFINE_COMPONENT( FBSDK_DLL, VideoIn         );
    FB_DEFINE_COMPONENT( FBSDK_DLL, VideoOut        );
    FB_DEFINE_COMPONENT( FBSDK_DLL, VideoClip       );
    FB_DEFINE_COMPONENT( FBSDK_DLL, VideoClipImage  );
    FB_DEFINE_COMPONENT( FBSDK_DLL, VideoSwitcher   );

#define FBVideoDeclare( ClassName, Parent ) \
    FBClassDeclare( ClassName,Parent ); \
public: \
    ClassName(const char* pName):Parent(pName) { FBClassInit; } \
private:

#define FBVideoImplementation( ThisComponent ) \
    FBClassImplementation( ThisComponent )

    // FBVideo
    __FB_FORWARD( FBVideo );
    __FB_FORWARD( FBVideoClip );

    enum FBVideoProxyMode {   
        kFBVideoProxyNone,      
        kFBVideoProxyOnPlay,    
        kFBVideoProxyAlways     
    };

    enum FBVideoStorageMode {
        kFBVideoStorageDisk,            
        kFBVideoStorageMemory,          
        kFBVideoStorageDiskAsync        
    };

    enum FBVideoInterlaceMode {
        kFBVideoInterlaceNone,              
        kFBVideoInterlaceHalfFrameEven,     
        kFBVideoInterlaceHalfFrameOdd,      
        kFBVideoInterlaceFullFrameEven,     
        kFBVideoInterlaceFullFrameOdd       
    };

    enum FBVideoFormat {
        kFBVideoFormat_Any,
        kFBVideoFormat_Other,
        kFBVideoFormat_RGBA_32,
        kFBVideoFormat_RGB_24,
        kFBVideoFormat_BGRA_32,
        kFBVideoFormat_BGR_24,
        kFBVideoFormat_BGR_16,
        kFBVideoFormat_ABGR_32,
        kFBVideoFormat_ARGB_32,
        kFBVideoFormat_422
    };

    enum FBVideoResolution
    {
        kFBVideo_RES_FULL = 0,
        kFBVideo_RES_1,
        kFBVideo_RES_2,
        kFBVideo_RES_4,
        kFBVideo_RES_8,
        kFBVideo_RES_16,
        kFBVideo_RES_32,
        kFBVideo_RES_64,
        kFBVideo_RES_128,
        kFBVideo_RES_256,
        kFBVideo_RES_512,
        kFBVideo_RES_1K,
        kFBVideo_RES_2K,
        kFBVideo_RES_4K,
        kFBVideo_RES_8K,
        kFBVideo_RES_16K
    };

    FB_DEFINE_ENUM( FBSDK_DLL, TimeMode );
    FB_DEFINE_ENUM( FBSDK_DLL, VideoProxyMode       );
    FB_DEFINE_ENUM( FBSDK_DLL, VideoStorageMode     );
    FB_DEFINE_ENUM( FBSDK_DLL, VideoInterlaceMode   );
    FB_DEFINE_ENUM( FBSDK_DLL, VideoFormat          );
    FB_DEFINE_ENUM( FBSDK_DLL, VideoResolution      );

    class FBSDK_DLL FBVideo : public FBBox {
        __FBClassDeclare( FBVideo,FBBox );
    public:
        FBVideo(const char* pName, HIObject pObject=NULL);

        FBPropertyBool                  KeepOnGPU;      
    };

    class FBSDK_DLL FBVideoClip : public FBVideo {
        __FBClassDeclare( FBVideoClip,FBVideo );
    public:
        FBVideoClip(const char* pName, HIObject pObject=NULL);

        virtual void FBDelete();

        bool IsValid();

        //--- Video (generic) properties.
        FBPropertyString                Filename;           
        FBPropertyString                RelativePath;       
        FBPropertyVideoProxyMode        ProxyMode;          
        FBPropertyVideoStorageMode      StorageMode;        
        FBPropertyInt                   Width;              
        FBPropertyInt                   Height;             
        FBPropertyInt                   PowerOfTwoWidth;    
        FBPropertyInt                   PowerOfTwoHeight;   
        FBPropertyVideoInterlaceMode    InterlaceMode;      
        FBPropertyVideoFormat           Format;             

        //--- Video (clip) properties
        FBPropertyTime                  TimeOffset;         
        FBPropertyInt                   StartFrame;         
        FBPropertyInt                   StopFrame;          
        FBPropertyDouble                FrameRate;          
        FBPropertyDouble                PlaySpeed;          
        FBPropertyBool                  FreeRunning;        
        FBPropertyBool                  Loop;               

        FBPropertyTime                  FrameTime;          
        FBPropertyInt                   CurrentFrame;       
        FBPropertyInt                   LastFrame;          
        FBPropertyTime                  LastFrameTime;      
        FBPropertyTime                  CurrentFrameTime;   

        FBPropertyTime                  CurrentFrameTimeCode;   

        virtual void DrawImage(int pX = 0, int pY = 0, int pW = -1, int pH = -1, int pFrame = -1);

        virtual unsigned char* GetImage(int pFrame = -1 );

        virtual void ImageIncUpdateID();

        virtual unsigned char* GetPowerOfTwoImage();

        int GetTextureID();

        virtual bool GetEmbeddedTimecode( int pFrame, FBTimeCode& pTimeCode );
    };

    __FB_FORWARD( FBVideoClipImage );

    class FBSDK_DLL FBVideoClipImage : public FBVideoClip {
        __FBClassDeclare( FBVideoClipImage,FBVideoClip );
    public:
        FBVideoClipImage(const char* pName, HIObject pObject=NULL);

        FBPropertyBool                  ImageSequence;
        FBPropertyBool                  UseSystemFrameRate; 
        FBPropertyVideoResolution       MaxMipMapResolution;
    };

    // FBVideoMemory
    __FB_FORWARD( FBVideoMemory );

    class FBSDK_DLL FBVideoMemory : public FBVideo {
        __FBClassDeclare( FBVideoMemory,FBVideo );
    public:
        FBVideoMemory(const char* pName, HIObject pObject=NULL);

        virtual void SetObjectImageSize(int pW,int pH);

        FBPropertyInt   TextureOGLId;               
    };

    // FBVideoIn
    __FB_FORWARD( FBVideoIn );

    enum FBVideoLiveType { 
        kFBVideoLiveDefault,    
        kFBVideoLiveBasic       
    };

    class FBSDK_DLL FBVideoIn : public FBVideo {
        __FBClassDeclare( FBVideoIn, FBVideo );
    public:
        FBVideoIn(HIObject pObject=NULL);

        FBPropertyBool      Online;     
        FBPropertyBool      Recording;  
        FBPropertyBool      RecordAudio;
        FBPropertyString    FilePath;   

        virtual bool    LiveSetCompressor(int pCompressorIndex);

        virtual int     LiveGetCompressor();

        virtual int     LiveGetCompressorCount();

        virtual const char* LiveGetCompressorName(int pCompressorIndex);

        virtual void    LiveSetResolutionFR(int pIndex);

        virtual int     LiveGetResolutionFR();

        virtual int     LiveGetResolutionFRCount();

        virtual const char* LiveGetResolutionFRName(int pIndex);

        virtual FBVideoLiveType  LiveGetType();
    };

    // FBVideoOut
    __FB_FORWARD( FBVideoOut );

    class FBSDK_DLL FBVideoOut : public FBVideo {
        __FBClassDeclare( FBVideoOut, FBVideo );
    public:
        FBVideoOut(HIObject pObject=NULL);
        FBPropertyBool      Online;     
    };


    // FBVideoSwitcher
    __FB_FORWARD( FBVideoSwitcher       );
    __FB_FORWARD( FBEventVideoSwitcher  );

    enum FBClipEnd { 
        kFBClipEndEnd,  
        kFBClipEndLoop  
    };
    enum FBPlayMode { 
        kFBPlayModeNoPlay,          
        kFBPlayModePreviewToEnd,    
        kFBPlayModePlay,            
        kFBPlayModeLoop,            
        kFBPlayModePlayToEnd        
    };

    FB_DEFINE_ENUM( FBSDK_DLL, ClipEnd  );
    FB_DEFINE_ENUM( FBSDK_DLL, PlayMode );

    class FBSDK_DLL FBEventVideoSwitcher : public FBEvent
    {
    public:
        FBEventVideoSwitcher( HKEventBase pEvent );     

        FBPropertyVideoSwitcher         VideoSwitcher;      
        FBPropertykReference            Reference;          
        FBPropertyClipEnd               EndType;            
    };

    class FBSDK_DLL FBVideoSwitcher : public FBVideo
    {
        __FBClassDeclare( FBVideoSwitcher, FBVideo );
    public:
        FBVideoSwitcher( const char* pName = NULL, HIObject pObject = NULL );

        virtual void ResetVideoSwitcher();
        virtual void FinishCurrentVideo();  
        virtual void PrepareNextFrame();
        virtual void SwapCurrent( FBVideo* pVideo );
        virtual void SetNextClip( FBVideo* pVideo, FBPlayMode pMode );

        virtual bool IsSDKSwitcher();

        FBPropertyInt                   CurrentFrame;       
        FBPropertyPlayMode              PlayMode;           
        FBPropertyTime                  TimeRemaining;      

        FBPropertyVideo                 CurrentVideo;       
        FBPropertyEvent                 OnClipEnd;          
        FBPropertyDevice                DeviceOwner;        
        FBPropertyBool                  UsingSystemTime;    
    };

    // FBPropertyListVideoClip
    class FBSDK_DLL FBPropertyListVideoClip : public FBPropertyListComponent
    {
    public:
        FBPropertyListVideoClip();
        FBVideoClip* operator[](int pIndex);
    };

    // FBPropertyListVideoIn
    class FBSDK_DLL FBPropertyListVideoIn : public FBPropertyListComponent
    {
    public:
        FBPropertyListVideoIn();
        FBVideoIn* operator[](int pIndex);
    };

    // FBPropertyListVideoOut
    class FBSDK_DLL FBPropertyListVideoOut : public FBPropertyListComponent
    {
    public:
        FBPropertyListVideoOut();
        FBVideoOut* operator[](int pIndex);
    };

#ifdef FBSDKUseNamespace
}
#endif
#endif