kfbxcache.h

Go to the documentation of this file.

#ifndef _FBXSDK_CACHE_H_ 
#define _FBXSDK_CACHE_H_

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

 Copyright © 2006 - 2007 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 KFBX_DLL 
    #define KFBX_DLL K_DLLIMPORT
#endif

#include <kaydara.h>
#include <kfbxplugins/kfbxobject.h>
#include <kfbxplugins/kfbxgroupname.h>

#include <fbxfilesdk_nsbegin.h>

class KFbxCache_internal;
class KFbxVertexCacheDeformer;

class KFBX_DLL KFbxCache : public KFbxObject
{
    KFBXOBJECT_DECLARE(KFbxCache);

public:

    typedef enum    
    {
        eUNKNOWN,
        ePC2,
        eMC
    } EFileFormat;

    void SetCacheFileFormat(EFileFormat pFileFormat);

    EFileFormat GetCacheFileFormat();   

    void SetCacheFileName(const char* pRelativeFileName, const char* pAbsoluteFileName);

    void GetCacheFileName(KString& pRelativeFileName, KString& pAbsoluteFileName);

    bool OpenFileForRead();

    bool IsOpen();

    bool CloseFile();



    typedef enum 
    {
        eMC_ONE_FILE,
        eMC_ONE_FILE_PER_FRAME
    } EMCFileCount; 

    bool OpenFileForWrite(EMCFileCount pFileCount, double pSamplingFrameRate, const char* pChannelName);    

    int  GetChannelCount();
    
    bool GetChannelName(int pChannelIndex, KString& pChannelName);
    
    int  GetChannelIndex(const char* pChannelName);
    
    bool Read(int pChannelIndex, KTime& pTime, double* pBuffer, unsigned int pPointCount);
    
    bool Write(int pChannelIndex, KTime& pTime, double* pBuffer, unsigned int pPointCount);



    bool OpenFileForWrite(double pFrameStartOffset, double pSamplingFrameRate, unsigned int pSampleCount, unsigned int pPointCount); 
    
    unsigned int GetSampleCount();
    
    unsigned int GetPointCount();
    
    double GetFrameStartOffset();
    
    double GetSamplingFrameRate();
    
    bool Read(unsigned int pFrameIndex, double* pBuffer, unsigned int pPointCount);
    
    bool Write(unsigned int pFrameIndex, double* pBuffer);



    bool ConvertFromPC2ToMC(EMCFileCount pFileCount, double pSamplingFrameRate);
    
    bool ConvertFromMCToPC2(double pSamplingFrameRate, unsigned int pChannelIndex);



    KError& GetError();

    typedef enum 
    {
        eUNSUPPORTED_ARCHITECTURE,
        eINVALID_ABSOLUTE_PATH,
        eINVALID_SAMPLING_RATE,
        eINVALID_CACHE_FORMAT,
        eUNSUPPORTED_FILE_VERSION,
        eCONVERSION_FROM_PC2_FAILED,
        eCONVERSION_FROM_MC_FAILED,
        eCACHE_FILE_NOT_FOUND,
        eCACHE_FILE_NOT_OPENED,
        eCACHE_FILE_NOT_CREATED,
        eINVALID_OPEN_FLAG,
        eERROR_WRITING_SAMPLE,
        eERROR_READING_SAMPLE,
        eERROR_COUNT
    } EError;   

    EError GetLastErrorID();

    char* GetLastErrorString();


    KFbxCache& operator=( const KFbxCache& pOther );

    virtual KFbxObject::ENameSpace GetNameSpace() const;

//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is 
//  subject to change without notice.
//
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    static const char* CacheFilePropertyName;
    static const char* CacheFileAbsolutePathPropertyName;
    static const char* CacheFileTypePropertyName;

    // Clone
    virtual KFbxObject* Clone(KFbxObject::ECloneType pCloneType) const;

    void FillPropertyList(void* pPropertyList);

    typedef enum
    {
        _O_RDONLY,
        _O_WRONLY
    } EOpenFlag;

protected:
    bool OpenFile(EOpenFlag pFlag, EMCFileCount pFileCount, double pSamplingFrameRate, const char* pChannelName, unsigned int pSampleCount, unsigned int pPointCount, double pFrameStartOffset); 

    static char const* GetNamePrefix() { return CACHE_PREFIX; }

    KFbxCache(KFbxSdkManager& pManager, char const* pName);
    virtual ~KFbxCache();

    virtual void Destruct(bool pRecursive, bool pDependents);

    // Properties Handler
    virtual KObject* GetFbxObject_internal();
    virtual KObject const*  GetFbxObject_internal() const;

    // Cache
    KFbxCache_internal* mData;

    friend class KFbxReaderFbx;
    friend class KFbxReaderFbx6;
    friend class KFbxWriterFbx;
    friend class KFbxWriterFbx6;

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};

typedef KFbxCache* HKFbxCache;

#include <fbxfilesdk_nsend.h>

#endif //_FBXSDK_CACHE_H_