kfbximageconverter.h

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXIMAGECONVERTER_H
#define FBXFILESDK_KFBXPLUGINS_KFBXIMAGECONVERTER_H

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

 Copyright (C) 2001 - 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 <fbxfilesdk/components/kbaselib/kaydaradef_h.h>
#include <fbxfilesdk/components/kbaselib/kaydara.h>

#include <fbxfilesdk/components/kbaselib/klib/kstring.h>

#include <fbxfilesdk/components/kbaselib/kbaselib_forward.h>
#include <fbxfilesdk/kfbxplugins/kfbxobject.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxSdkManager;

const int ColorSpaceRGB = 0;
const int ColorSpaceYUV = 1;
const int FileToBuffer  = 0;
const int BufferToFile  = 1;

class KFBX_DLL ImageConverterBuffer
{
private:
    int     mWidth;         // number of horizontal pixels
    int     mHeight;        // number of vertical pixels
    int     mColorSpace;    // either RGB or YUV
    int     mPixelSize;     // 3 or 4 (case of RGBA)
    kByte  *mData;          // pointer to the array of pixels

    bool    mOriginalFormat;    // true if the data in this object has 
    KString mOriginalFileName;  // not been converted in any way

    bool    mValid;
    bool    mUseDataBuffer;    // if false, the data to use is an external file on disk
                               // otherwise the data is the allocated memory buffer.

public:

    ImageConverterBuffer();
    ~ImageConverterBuffer();

    bool    IsValid()               { return mValid; }

    bool    UseDataBuffer()         { return mUseDataBuffer; }

    int     GetWidth()              { return mWidth; }

    int     GetHeight()             { return mHeight; }

    int     GetColorSpace()         { return mColorSpace; }

    char    GetPixelSize()          { return (char) mPixelSize; }

    kByte*  GetData()               { return mData; }

    bool    GetOriginalFormat()     { return mOriginalFormat; }

    KString GetOriginalFileName()   { return mOriginalFileName; }

    void Init(int pWidth, int pHeight, bool pUseDataBuffer, int pColorSpace = ColorSpaceRGB, char pPixelSize = 4);

    void SetOriginalFormat(bool pState);

    void SetOriginalFileName(KString pFilename);
};

// This function should return 0 if successful and any non zero value otherwise. And should
// init the pBuffer with the correct values.
typedef int (*ImageConverterFunction)(int pDirection, KString& pFileName, ImageConverterBuffer& pBuffer);


class KFBX_DLL KFbxImageConverter : public KFbxObject
{
    KFBXOBJECT_DECLARE(KFbxImageConverter,KFbxObject);

public:

    void RegisterConverterFunction(KString pFileExt, ImageConverterFunction pFct);

    void UnregisterConverterFunction(ImageConverterFunction pFct);

    bool Convert(int pDirection, KString& pFileName, ImageConverterBuffer& pBuffer);

//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is 
//  subject to change without notice.
//
#ifndef DOXYGEN_SHOULD_SKIP_THIS

protected:

    virtual KFbxObject* Clone( KFbxObject* pContainer, KFbxObject::ECloneType pCloneType ) const;
    KFbxImageConverter(KFbxSdkManager& pManager,char const *pName);
    virtual void Destruct(bool pRecursive, bool pDependents);

    KFbxImageConverter& operator=( const KFbxImageConverter& pOther );

    KCharPtrSet*    mConverterFunctions;
    KFbxSdkManager* mManager;

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

};

// global utilities
KFBX_DLL bool IsCompressedTif(KString pFile);
KFBX_DLL bool IsTif(KString pFile);
KFBX_DLL bool ReadFromTif(KString pFile, ImageConverterBuffer& pBuffer, bool deleteFile);
KFBX_DLL bool WriteToTif(KString pFile, bool pCompressed, ImageConverterBuffer& pBuffer);

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXIMAGECONVERTER_H