FBX SDK Reference Guide: kfbximageconverter.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef _FBXSDK_IMAGE_CONVERTER_H_
00005 #define _FBXSDK_IMAGE_CONVERTER_H_
00006 
00007 /**************************************************************************************
00008 
00009  Copyright  2001 - 2008 Autodesk, Inc. and/or its licensors.
00010  All Rights Reserved.
00011 
00012  The coded instructions, statements, computer programs, and/or related material 
00013  (collectively the "Data") in these files contain unpublished information 
00014  proprietary to Autodesk, Inc. and/or its licensors, which is protected by 
00015  Canada and United States of America federal copyright law and by international 
00016  treaties. 
00017  
00018  The Data may not be disclosed or distributed to third parties, in whole or in
00019  part, without the prior written consent of Autodesk, Inc. ("Autodesk").
00020 
00021  THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
00022  ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
00023  WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
00024  BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE, 
00025  NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE. 
00026  WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
00027  OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE. 
00028  
00029  IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
00030  OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
00031  OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
00032  SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
00033  OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
00034  HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
00035  FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
00036  ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
00037  WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
00038  OR DAMAGE. 
00039 
00040 **************************************************************************************/
00041 
00042 #include <kaydaradef.h>
00043 #ifndef KFBX_DLL 
00044     #define KFBX_DLL K_DLLIMPORT
00045 #endif
00046 
00047 #include <kaydara.h>
00048 
00049 #include <klib/kstring.h>
00050 
00051 #ifndef MB_FBXSDK
00052 #include <kbaselib_nsuse.h>
00053 #endif
00054 #include <kbaselib_forward.h>
00055 #include <kfbxplugins/kfbxobject.h>
00056 
00057 #include <fbxfilesdk_nsbegin.h>
00058 
00059 class KFbxSdkManager;
00060 
00061 const int ColorSpaceRGB = 0;
00062 const int ColorSpaceYUV = 1;
00063 const int FileToBuffer  = 0;
00064 const int BufferToFile  = 1;
00065 
00069 class KFBX_DLL ImageConverterBuffer
00070 {
00071 private:
00072     int     mWidth;         // nb of horizontal pixels
00073     int     mHeight;        // nb of vertical pixels
00074     int     mColorSpace;    // either RGB or YUV
00075     int     mPixelSize;     // 3 or 4 (case of RGBA)
00076     kByte  *mData;          // pointer to the array of pixels
00077 
00078     bool    mOriginalFormat;    // true if the data in this object has 
00079     KString mOriginalFileName;  // not been converted in any way
00080 
00081     bool    mValid;
00082     bool    mUseDataBuffer;    // if false, the data to use is an external file on disk
00083                                // otherwise the data is the allocated memory buffer.
00084 
00085 public:
00090 
00092     ImageConverterBuffer();
00094     ~ImageConverterBuffer();
00096 
00100     bool    IsValid()               { return mValid; }
00101 
00105     bool    UseDataBuffer()         { return mUseDataBuffer; }
00106 
00110     int     GetWidth()              { return mWidth; }
00111 
00115     int     GetHeight()             { return mHeight; }
00116 
00120     int     GetColorSpace()         { return mColorSpace; }
00121 
00125     char    GetPixelSize()          { return (char) mPixelSize; }
00126 
00130     kByte*  GetData()               { return mData; }
00131 
00135     bool    GetOriginalFormat()     { return mOriginalFormat; }
00136 
00143     KString GetOriginalFileName()   { return mOriginalFileName; }
00144 
00154     void Init(int pWidth, int pHeight, bool pUseDataBuffer, int pColorSpace = ColorSpaceRGB, char pPixelSize = 4);
00155 
00159     void SetOriginalFormat(bool pState);
00160 
00164     void SetOriginalFileName(KString pFilename);
00165 };
00166 
00167 // This function should return 0 if successful and any non zero value otherwise. And should
00168 // init the pBuffer with the correct values.
00169 typedef int (*ImageConverterFunction)(int pDirection, KString& pFileName, ImageConverterBuffer& pBuffer);
00170 
00171 
00173 class KFBX_DLL KFbxImageConverter : public KFbxObject
00174 {
00175     KFBXOBJECT_DECLARE(KFbxImageConverter,KFbxObject);
00176 
00177 public:
00178 
00186     void RegisterConverterFunction(KString pFileExt, ImageConverterFunction pFct);
00187 
00191     void UnregisterConverterFunction(ImageConverterFunction pFct);
00192 
00199     bool Convert(int pDirection, KString& pFileName, ImageConverterBuffer& pBuffer);
00200 
00202 //
00203 //  WARNING!
00204 //
00205 //  Anything beyond these lines may not be documented accurately and is 
00206 //  subject to change without notice.
00207 //
00209 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00210 
00211 protected:
00212 
00213     virtual KFbxObject* Clone( KFbxObject* pContainer, KFbxObject::ECloneType pCloneType ) const;
00214     KFbxImageConverter(KFbxSdkManager& pManager,char const *pName);
00215     ~KFbxImageConverter();
00216 
00217     KFbxImageConverter& operator=( const KFbxImageConverter& pOther );
00218 
00219     KCharPtrSet*    mConverterFunctions;
00220     KFbxSdkManager* mManager;
00221 
00222 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00223 
00224 };
00225 
00226 // global utilities
00227 KFBX_DLL bool IsCompressedTif(KString pFile);
00228 KFBX_DLL bool ReadFromTif(KString pFile, ImageConverterBuffer& pBuffer, bool deleteFile);
00229 KFBX_DLL bool WriteToTif(KString pFile, bool pCompressed, ImageConverterBuffer& pBuffer);
00230 
00231 #include <fbxfilesdk_nsend.h>
00232 
00233 #endif // #ifndef _FBXSDK_IMAGE_CONVERTER_H_
00234 
00235