fbvideograbber.h

Go to the documentation of this file.

#ifndef __FBVIDEOGRABBER_H__
#define __FBVIDEOGRABBER_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/fbaudiofmt.h>
#include <fbsdk/fbimage.h>
#include <fbsdk/fbcamera.h>
#include <fbsdk/fbrenderer.h>
 
#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif
 
__FB_FORWARD( FBVideoGrabber );
FB_DEFINE_COMPONENT( FBSDK_DLL, VideoGrabber );
 
enum FBVideoRenderViewingMode   {
    FBViewingModeStandard,      
    FBViewingModeModelsOnly,    
    FBViewingModeXRay,          
    FBViewingModeCurrent,       
    FBViewingModeCount          
};      
enum FBVideoRenderFieldMode     {
    FBFieldModeNoField,     
    FBFieldModeField0,      
    FBFieldModeField1,      
    FBFieldModeHalfField0,  
    FBFieldModeHalfField1,  
    FBFieldModeCount        
};      
enum FBVideoRenderDepth     {
    FBVideoRender24Bits,        
    FBVideoRender32Bits,        
    FBVideoRenderDepthCount     
};  
enum FBAudioOutputLocation      {
    FBAudioOutputLocationEmbedded,              
    FBAudioOutputLocationStandalone,            
    FBAudioOutputLocationEmbeddedAndStandalone, 
    FBAudioOutputLocationCount                  
};
 
struct FBSDK_DLL FBVideoGrabOptions
{
    FBTimeSpan                  mTimeSpan;              
    FBTime                      mTimeSteps;             
    FBCameraResolutionMode      mCameraResolution;      
    FBVideoRenderDepth          mBitsPerPixel;          
    FBVideoRenderFieldMode      mFieldMode;             
    FBVideoRenderViewingMode    mViewingMode;           
    FBStereoDisplayMode         mStereoDisplayMode;     
    int                         mRendererCallbackIndex; 
    int                         mRendererCallbackPrefIndex; 
    FBString                    mOutputFileName;        
    bool                        mShowSafeArea;          
    bool                        mShowTimeCode;          
    bool                        mShowCameraLabel;       
    bool                        mAntiAliasing;          
    bool                        mRenderAudio;           
    FBAudioFmt                  mAudioRenderFormat;     
#ifdef _MSC_VER
    K_DEPRECATED_2024 int       mStillImageCompression; 
#else
    // There is a build break on Linux with the default undeclared constructor.
    /*K_DEPRECATED_2024*/ int   mStillImageCompression; 
#endif
    int                         mStillImageQuality;     
    int                         mStillImageCompressionType;         
    FBAudioOutputLocation       mAudioOutputLocation;   
    bool                        mAudioUseCustomStandaloneFileName;  
    FBString                    mAudioCustomStandaloneFileName;     
};
 
struct FBVideoGrabStats
{
    int     mTotalFrameCount;           
    int     mRemainingFrameCount;       
    FBTime  mTotalTimeElapsed;          
    FBTime  mEstimatedTime;             
    FBTime  mEstimatedTimeRemaining;    
    FBTime  mTimePerFrame;              
};
 
class FBSDK_DLL FBVideoGrabber : public FBComponent 
{
    //--- Open Reality declaration.
    __FBClassDeclare(FBVideoGrabber, FBComponent);
  public:
 
    FBVideoGrabber(HIObject pObject=NULL);
 
    //--- Grabbing options management
    void SetOptions(FBVideoGrabOptions* pOptions);
 
    FBVideoGrabOptions GetOptions();
 
    void ResetOptions();
 
    //--- Rendering functions setup
    void SetRefreshViewFunc(void* pThis, void(*pCallbackFuncPtr)(void*));
 
    void SetPostRenderFrameCallback(void* pThis, void(*pCallbackFuncPtr)(void*));
 
    //--- Grabbing control
    bool BeginGrab();
 
    void Grab();
 
    void EndGrab();
 
    FBImage* RenderSnapshot(int pWidth=-1, int pHeight=-1, bool pCameraLabel=false, bool pTimeCode=false, bool pSafeArea=false, bool pAxis=false, bool pGrid=false, bool pFrontPlate=false, bool pBackPlate=false);
    
    //--- Grabbing statistics query
    FBVideoGrabStats GetStatistics();
    
    //--- Errors management
    const char* GetLastErrorMsg();
};
 
 
#ifdef FBSDKUseNamespace
    }
#endif
#endif /* this must be the last line of this file */