TXMPFiles.hpp

Go to the documentation of this file.

#ifndef __TXMPFiles_hpp__
#define __TXMPFiles_hpp__    1

#if ( ! __XMP_hpp__ )
    #error "Do not directly include, use XMP.hpp"
#endif

// =================================================================================================
// ADOBE SYSTEMS INCORPORATED
// Copyright 2002 Adobe Systems Incorporated
// All Rights Reserved
//
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance with the terms
// of the Adobe license agreement accompanying it.
// =================================================================================================

// =================================================================================================
// =================================================================================================


// =================================================================================================
// =================================================================================================


#if XMP_StaticBuild    // ! Client XMP_IO objects can only be used in static builds.
    #include "XMP_IO.hpp"
#endif


template <class tStringObj>
class TXMPFiles {

public:

    // =============================================================================================

    // ---------------------------------------------------------------------------------------------

    static void GetVersionInfo ( XMP_VersionInfo * versionInfo );

    // ---------------------------------------------------------------------------------------------

    static bool Initialize();

    // ---------------------------------------------------------------------------------------------

    static bool Initialize ( XMP_OptionBits options );

    // ---------------------------------------------------------------------------------------------

    static bool Initialize ( const char* pluginFolder, const char* plugins = NULL );

    // ---------------------------------------------------------------------------------------------

    static bool Initialize ( XMP_OptionBits options, const char* pluginFolder, const char* plugins = NULL );

    // ---------------------------------------------------------------------------------------------

    static void Terminate();


    // =============================================================================================

    // ---------------------------------------------------------------------------------------------

    TXMPFiles();

    // ---------------------------------------------------------------------------------------------

    virtual ~TXMPFiles() throw();

    // ---------------------------------------------------------------------------------------------

    TXMPFiles ( XMP_StringPtr  filePath,
                XMP_FileFormat format = kXMP_UnknownFile,
                XMP_OptionBits openFlags = 0 );

    // ---------------------------------------------------------------------------------------------

    TXMPFiles ( const tStringObj & filePath,
                XMP_FileFormat     format = kXMP_UnknownFile,
                XMP_OptionBits     openFlags = 0 );

    // ---------------------------------------------------------------------------------------------

    TXMPFiles ( const TXMPFiles<tStringObj> & original );

    // ---------------------------------------------------------------------------------------------

    void operator= ( const TXMPFiles<tStringObj> & rhs );

    // ---------------------------------------------------------------------------------------------

    TXMPFiles ( XMPFilesRef xmpFilesObj );

    // ---------------------------------------------------------------------------------------------

    XMPFilesRef GetInternalRef();


    // =============================================================================================

    // ---------------------------------------------------------------------------------------------


    static bool GetFormatInfo ( XMP_FileFormat   format,
                                XMP_OptionBits * handlerFlags = 0 );


    // =============================================================================================

    // ---------------------------------------------------------------------------------------------

    static XMP_FileFormat CheckFileFormat ( XMP_StringPtr filePath );

    // ---------------------------------------------------------------------------------------------

    static XMP_FileFormat CheckPackageFormat ( XMP_StringPtr folderPath );

    // ---------------------------------------------------------------------------------------------

    static bool GetFileModDate ( XMP_StringPtr    filePath,
                                 XMP_DateTime *   modDate,
                                 XMP_FileFormat * format = 0,
                                 XMP_OptionBits   options = 0 );
        

    // ---------------------------------------------------------------------------------------------
    
    static bool GetAssociatedResources ( XMP_StringPtr            filePath,
                                         std::vector<tStringObj>* resourceList,
                                         XMP_FileFormat           format = kXMP_UnknownFile, 
                                         XMP_OptionBits           options = 0);

    // ---------------------------------------------------------------------------------------------
    
    static bool IsMetadataWritable (XMP_StringPtr  filePath,
                                   bool *         writable,    
                                   XMP_FileFormat format = kXMP_UnknownFile,
                                   XMP_OptionBits options = 0 );

    // ---------------------------------------------------------------------------------------------

    bool OpenFile ( XMP_StringPtr  filePath,
                    XMP_FileFormat format = kXMP_UnknownFile,
                    XMP_OptionBits openFlags = 0 );

    // ---------------------------------------------------------------------------------------------

    bool OpenFile ( const tStringObj & filePath,
                    XMP_FileFormat     format = kXMP_UnknownFile,
                    XMP_OptionBits     openFlags = 0 );

    #if XMP_StaticBuild    // ! Client XMP_IO objects can only be used in static builds.
    // ---------------------------------------------------------------------------------------------

    bool OpenFile ( XMP_IO *       clientIO,
                    XMP_FileFormat format = kXMP_UnknownFile,
                    XMP_OptionBits openFlags = 0 );
    #endif

    // ---------------------------------------------------------------------------------------------

    void CloseFile ( XMP_OptionBits closeFlags = 0 );

    // ---------------------------------------------------------------------------------------------

    bool GetFileInfo ( tStringObj *     filePath = 0,
                       XMP_OptionBits * openFlags = 0,
                       XMP_FileFormat * format = 0,
                       XMP_OptionBits * handlerFlags = 0 );

    // ---------------------------------------------------------------------------------------------

    void SetAbortProc ( XMP_AbortProc abortProc,
                        void *        abortArg );


    // =============================================================================================

    // ---------------------------------------------------------------------------------------------

    bool GetXMP ( SXMPMeta *       xmpObj = 0,
                  tStringObj *     xmpPacket = 0,
                  XMP_PacketInfo * packetInfo = 0 );

    // ---------------------------------------------------------------------------------------------

    void PutXMP ( const SXMPMeta & xmpObj );

    // ---------------------------------------------------------------------------------------------

    void PutXMP ( const tStringObj & xmpPacket );

    // ---------------------------------------------------------------------------------------------

    void PutXMP ( XMP_StringPtr xmpPacket,
                  XMP_StringLen xmpLength = kXMP_UseNullTermination );

    // ---------------------------------------------------------------------------------------------

    bool CanPutXMP ( const SXMPMeta & xmpObj );

    // ---------------------------------------------------------------------------------------------

    bool CanPutXMP ( const tStringObj & xmpPacket );

    // ---------------------------------------------------------------------------------------------

    bool CanPutXMP ( XMP_StringPtr xmpPacket,
                     XMP_StringLen xmpLength = kXMP_UseNullTermination );


    // =============================================================================================

    // ---------------------------------------------------------------------------------------------

    static void SetDefaultProgressCallback ( XMP_ProgressReportProc proc, void * context = 0,
                                             float interval = 1.0, bool sendStartStop = false );

    // ---------------------------------------------------------------------------------------------

    void SetProgressCallback ( XMP_ProgressReportProc proc, void * context = 0,
                               float interval = 1.0, bool sendStartStop = false );
                                             

    // =============================================================================================
    // Error notifications
    // ===================

    // ---------------------------------------------------------------------------------------------

    //  --------------------------------------------------------------------------------------------

    static void SetDefaultErrorCallback ( XMPFiles_ErrorCallbackProc proc, void* context = 0, XMP_Uns32 limit = 1 );

    //  --------------------------------------------------------------------------------------------

    void SetErrorCallback ( XMPFiles_ErrorCallbackProc proc, void* context = 0, XMP_Uns32 limit = 1 );

    //  --------------------------------------------------------------------------------------------

    void ResetErrorCallbackLimit ( XMP_Uns32 limit = 1 );


    // =============================================================================================

private:

    XMPFilesRef xmpFilesRef;

    // These are used as callbacks from the library code to the client when returning values that
    // involve heap allocations. This ensures the allocations occur within the client.
    static void SetClientString ( void * clientPtr, XMP_StringPtr valuePtr, XMP_StringLen valueLen );
    static void SetClientStringVector ( void * clientPtr, XMP_StringPtr* arrayPtr, XMP_Uns32 stringCount );
};    // class TXMPFiles

// =================================================================================================

#endif // __TXMPFiles_hpp__