 |
XMP Toolkit SDK
6.0.0
|
Go to the documentation of this file. 1 #ifndef __XMP_Const_h__
2 #define __XMP_Const_h__ 1
18 #if XMP_MacBuild | XMP_iOSBuild // ! No stdint.h on Windows and some UNIXes.
22 #if XMP_UNIXBuild | XMP_AndroidBuild // hopefully an inttypes.h on all UNIXes...
26 #ifndef XMP_MARKER_EXTENSIBILITY_BACKWARD_COMPATIBILITY
27 #define XMP_MARKER_EXTENSIBILITY_BACKWARD_COMPATIBILITY 1
31 #define __AVAILABILITY_INTERNAL_DEPRECATED_XMP __AVAILABILITY_INTERNAL_DEPRECATED
33 #define __AVAILABILITY_INTERNAL_DEPRECATED_XMP
53 #if XMP_MacBuild | XMP_iOSBuild
55 typedef int8_t XMP_Int8;
56 typedef int16_t XMP_Int16;
57 typedef int32_t XMP_Int32;
58 typedef int64_t XMP_Int64;
60 typedef uint8_t XMP_Uns8;
61 typedef uint16_t XMP_Uns16;
62 typedef uint32_t XMP_Uns32;
63 typedef uint64_t XMP_Uns64;
67 typedef signed char XMP_Int8;
68 typedef signed short XMP_Int16;
69 typedef signed long XMP_Int32;
70 typedef signed long long XMP_Int64;
72 typedef unsigned char XMP_Uns8;
73 typedef unsigned short XMP_Uns16;
74 typedef unsigned long XMP_Uns32;
75 typedef unsigned long long XMP_Uns64;
77 #elif XMP_UNIXBuild | XMP_AndroidBuild
81 typedef signed char XMP_Int8;
82 typedef signed short XMP_Int16;
83 typedef signed long XMP_Int32;
84 typedef signed long long XMP_Int64;
86 typedef unsigned char XMP_Uns8;
87 typedef unsigned short XMP_Uns16;
88 typedef unsigned long XMP_Uns32;
89 typedef unsigned long long XMP_Uns64;
93 typedef signed char XMP_Int8;
94 typedef signed short XMP_Int16;
95 typedef signed int XMP_Int32;
96 typedef signed long long XMP_Int64;
98 typedef unsigned char XMP_Uns8;
99 typedef unsigned short XMP_Uns16;
100 typedef unsigned int XMP_Uns32;
101 typedef unsigned long long XMP_Uns64;
107 #error "XMP environment error - must define one of XMP_MacBuild, XMP_WinBuild, XMP_UNIXBuild, XMP_AndroidBuild or XMP_iOSBuild"
115 #define ConvertXMP_BoolToBool(a) (a) != kXMP_Bool_False
116 #define ConvertBoolToXMP_Bool(a) (a) ? !kXMP_Bool_False : kXMP_Bool_False
125 static const XMP_Uns64
Max_XMP_Uns64 = ( (XMP_Uns64) 0xFFFFFFFFFFFFFFFFLL );
133 static const XMP_Int64
Min_XMP_Int64 = ( (XMP_Int64) 0x8000000000000000LL );
134 static const XMP_Int64
Max_XMP_Int64 = ( (XMP_Int64) 0x7FFFFFFFFFFFFFFFLL );
193 #define kXMP_TrueStr "True" // Serialized XMP spellings, not for the type bool.
194 #define kXMP_FalseStr "False"
291 #define XMPDateTime_IsDateOnly(dt) ((dt).hasDate & (! (dt).hasTime))
292 #define XMPDateTime_IsTimeOnly(dt) ((dt).hasTime & (! (dt).hasDate))
294 #define XMPDateTime_ClearTimeZone(dt) { (dt).hasTimeZone = (dt).tzSign = (dt).tzHour = (dt).tzMinute = 0; }
335 #define kXMP_NS_XMP "http://ns.adobe.com/xap/1.0/"
337 #define kXMP_NS_XMP_Rights "http://ns.adobe.com/xap/1.0/rights/"
338 #define kXMP_NS_XMP_MM "http://ns.adobe.com/xap/1.0/mm/"
339 #define kXMP_NS_XMP_BJ "http://ns.adobe.com/xap/1.0/bj/"
341 #define kXMP_NS_PDF "http://ns.adobe.com/pdf/1.3/"
342 #define kXMP_NS_Photoshop "http://ns.adobe.com/photoshop/1.0/"
343 #define kXMP_NS_PSAlbum "http://ns.adobe.com/album/1.0/"
344 #define kXMP_NS_EXIF "http://ns.adobe.com/exif/1.0/"
345 #define kXMP_NS_EXIF_Aux "http://ns.adobe.com/exif/1.0/aux/"
346 #define kXMP_NS_TIFF "http://ns.adobe.com/tiff/1.0/"
347 #define kXMP_NS_PNG "http://ns.adobe.com/png/1.0/"
348 #define kXMP_NS_SWF "http://ns.adobe.com/swf/1.0/"
349 #define kXMP_NS_JPEG "http://ns.adobe.com/jpeg/1.0/"
350 #define kXMP_NS_JP2K "http://ns.adobe.com/jp2k/1.0/"
351 #define kXMP_NS_CameraRaw "http://ns.adobe.com/camera-raw-settings/1.0/"
352 #define kXMP_NS_DM "http://ns.adobe.com/xmp/1.0/DynamicMedia/"
353 #define kXMP_NS_Script "http://ns.adobe.com/xmp/1.0/Script/"
354 #define kXMP_NS_ASF "http://ns.adobe.com/asf/1.0/"
355 #define kXMP_NS_WAV "http://ns.adobe.com/xmp/wav/1.0/"
356 #define kXMP_NS_BWF "http://ns.adobe.com/bwf/bext/1.0/"
357 #define kXMP_NS_AEScart "http://ns.adobe.com/aes/cart/"
358 #define kXMP_NS_RIFFINFO "http://ns.adobe.com/riff/info/"
359 #define kXMP_NS_iXML "http://ns.adobe.com/ixml/1.0/"
360 #define kXMP_NS_XMP_Note "http://ns.adobe.com/xmp/note/"
362 #define kXMP_NS_AdobeStockPhoto "http://ns.adobe.com/StockPhoto/1.0/"
363 #define kXMP_NS_CreatorAtom "http://ns.adobe.com/creatorAtom/1.0/"
365 #define kXMP_NS_ExifEX "http://cipa.jp/exif/1.0/"
393 #define kXMP_NS_XMP_IdentifierQual "http://ns.adobe.com/xmp/Identifier/qual/1.0/"
394 #define kXMP_NS_XMP_Dimensions "http://ns.adobe.com/xap/1.0/sType/Dimensions#"
395 #define kXMP_NS_XMP_Text "http://ns.adobe.com/xap/1.0/t/"
396 #define kXMP_NS_XMP_PagedFile "http://ns.adobe.com/xap/1.0/t/pg/"
397 #define kXMP_NS_XMP_Graphics "http://ns.adobe.com/xap/1.0/g/"
398 #define kXMP_NS_XMP_Image "http://ns.adobe.com/xap/1.0/g/img/"
399 #define kXMP_NS_XMP_Font "http://ns.adobe.com/xap/1.0/sType/Font#"
400 #define kXMP_NS_XMP_ResourceEvent "http://ns.adobe.com/xap/1.0/sType/ResourceEvent#"
401 #define kXMP_NS_XMP_ResourceRef "http://ns.adobe.com/xap/1.0/sType/ResourceRef#"
402 #define kXMP_NS_XMP_ST_Version "http://ns.adobe.com/xap/1.0/sType/Version#"
403 #define kXMP_NS_XMP_ST_Job "http://ns.adobe.com/xap/1.0/sType/Job#"
404 #define kXMP_NS_XMP_ManifestItem "http://ns.adobe.com/xap/1.0/sType/ManifestItem#"
407 #define kXMP_NS_XMP_T "http://ns.adobe.com/xap/1.0/t/"
408 #define kXMP_NS_XMP_T_PG "http://ns.adobe.com/xap/1.0/t/pg/"
409 #define kXMP_NS_XMP_G_IMG "http://ns.adobe.com/xap/1.0/g/img/"
431 #define kXMP_NS_DC "http://purl.org/dc/elements/1.1/"
433 #define kXMP_NS_IPTCCore "http://iptc.org/std/Iptc4xmpCore/1.0/xmlns/"
434 #define kXMP_NS_IPTCExt "http://iptc.org/std/Iptc4xmpExt/2008-02-29/"
436 #define kXMP_NS_DICOM "http://ns.adobe.com/DICOM/"
438 #define kXMP_NS_PLUS "http://ns.useplus.org/ldf/xmp/1.0/"
440 #define kXMP_NS_PDFA_Schema "http://www.aiim.org/pdfa/ns/schema#"
441 #define kXMP_NS_PDFA_Property "http://www.aiim.org/pdfa/ns/property#"
442 #define kXMP_NS_PDFA_Type "http://www.aiim.org/pdfa/ns/type#"
443 #define kXMP_NS_PDFA_Field "http://www.aiim.org/pdfa/ns/field#"
444 #define kXMP_NS_PDFA_ID "http://www.aiim.org/pdfa/ns/id/"
445 #define kXMP_NS_PDFA_Extension "http://www.aiim.org/pdfa/ns/extension/"
447 #define kXMP_NS_PDFX "http://ns.adobe.com/pdfx/1.3/"
448 #define kXMP_NS_PDFX_ID "http://www.npes.org/pdfx/ns/id/"
450 #define kXMP_NS_RDF "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
451 #define kXMP_NS_XML "http://www.w3.org/XML/1998/namespace"
471 #define kXMP_ArrayLastItem ((XMP_Index)(-1L))
472 #define kXMP_UseNullTermination ((XMP_StringLen)(~0UL))
473 #define kXMP_NoOptions ((XMP_OptionBits)0UL)
508 #define XMP_SetOption(var,opt) var |= (opt)
509 #define XMP_ClearOption(var,opt) var &= ~(opt)
510 #define XMP_TestOption(var,opt) (((var) & (opt)) != 0)
511 #define XMP_OptionIsSet(var,opt) (((var) & (opt)) != 0)
512 #define XMP_OptionIsClear(var,opt) (((var) & (opt)) == 0)
567 #define XMP_PropIsSimple(opt) (((opt) & kXMP_PropCompositeMask) == 0)
568 #define XMP_PropIsStruct(opt) (((opt) & kXMP_PropValueIsStruct) != 0)
569 #define XMP_PropIsArray(opt) (((opt) & kXMP_PropValueIsArray) != 0)
571 #define XMP_ArrayIsUnordered(opt) (((opt) & kXMP_PropArrayIsOrdered) == 0)
572 #define XMP_ArrayIsOrdered(opt) (((opt) & kXMP_PropArrayIsOrdered) != 0)
573 #define XMP_ArrayIsAlternate(opt) (((opt) & kXMP_PropArrayIsAlternate) != 0)
574 #define XMP_ArrayIsAltText(opt) (((opt) & kXMP_PropArrayIsAltText) != 0)
576 #define XMP_PropHasQualifiers(opt) (((opt) & kXMP_PropHasQualifiers) != 0)
577 #define XMP_PropIsQualifier(opt) (((opt) & kXMP_PropIsQualifier) != 0)
578 #define XMP_PropHasLang(opt) (((opt) & kXMP_PropHasLang) != 0)
580 #define XMP_NodeIsSchema(opt) (((opt) & kXMP_SchemaNode) != 0)
581 #define XMP_PropIsAlias(opt) (((opt) & kXMP_PropIsAlias) != 0)
676 #define kXMP_SchemaNode ((XMP_OptionBits)0x80000000UL)
1064 #define XMP_CharFormIs16Bit(f) ( ((int)(f) & kXMP_Char16BitMask) != 0 )
1065 #define XMP_CharFormIs32Bit(f) ( ((int)(f) & kXMP_Char32BitMask) != 0 )
1066 #define XMP_CharFormIsBigEndian(f) ( ((int)(f) & kXMP_CharLittleEndianMask) == 0 )
1067 #define XMP_CharFormIsLittleEndian(f) ( ((int)(f) & kXMP_CharLittleEndianMask) != 0 )
1068 #define XMP_GetCharSize(f) ( ((int)(f)&6) == 0 ? 1 : (int)(f)&6 )
1069 #define XMP_CharToSerializeForm(cf) ( (XMP_OptionBits)(cf) )
1070 #define XMP_CharFromSerializeForm(sf) ( (XMP_Uns8)(sf) )
1074 #define kXMPFiles_UnknownOffset ((XMP_Int64)-1)
1078 #define kXMPFiles_UnknownLength ((XMP_Int32)-1)
1556 float elapsedTime,
float fractionDone,
float secondsToGo );
1589 #endif // __XMP_Const_h__
@ kXMP_MXFFile
Public file format constant: 'MXF '.
@ kXMPErr_RejectedFileExtension
Rejected File extension.
@ kXMP_PropHasQualifiers
The property has qualifiers, includes rdf:type and xml:lang.
@ kXMPTS_Maybe
The part or parts might, or might not, have changed.
@ kXMP_FLVFile
Public file format constant: 'FLV '.
@ kXMP_PhotoshopFile
Adobe application file format constant: 'PSD '.
@ kXMP_AEFilterPresetFile
Adobe application file format constant: 'FFX '.
@ kXMP_IterOmitQualifiers
Omit all qualifiers.
#define kXMPFiles_UnknownLength
Constant for an unknown packet length within a file.
@ kXMP_PropValueIsURI
The XML string form of the property value is a URI, use rdf:resource attribute. DISCOURAGED.
@ kXMPTS_No
The part or parts have definitely not changed.
@ kXMPFiles_ServerMode
Combination of flags necessary for server products using XMPFiles.
@ kXMP_IterJustChildren
Just do the immediate children of the root, default is subtree.
XMP_StringPtr GetErrMsg() const
Retrieves the descriptive string from an XMP_Error.
@ kXMP_Char16BitLittle
16-bit little-endian
@ kXMP_SESFile
Public file format constant: 'SES ', Audition session.
static const XMP_Uns16 Max_XMP_Uns16
@ kXMPErr_InternalFailure
Generic internal failure.
XMP_Int32 padSize
Packet padding size in bytes, zero if unknown.
@ kXMPErr_NoError
Generic error codes.
@ kXMPErr_Deprecated
Generic deprecated error.
@ kXMPFiles_OpenForUpdate
Open for reading and writing.
@ kXMPErrSev_Recoverable
Partial recovery and continuation is possible.
@ kXMPFiles_OpenUseSmartHandler
Require the use of a smart handler.
XMP_Int32 minute
The minute in the range 0..59.
XMP Toolkit version information.
@ kXMP_PropArrayLocationMask
Bit-flag mask for array-item location bits.
@ kXMP_PropArrayIsUnordered
The item order does not matter.
@ kXMPErr_BadXML
XML format error.
bool(* XMPFiles_ErrorCallbackProc)(void *context, XMP_StringPtr filePath, XMP_ErrorSeverity severity, XMP_Int32 cause, XMP_StringPtr message)
The signature of a client-defined callback for TXMPFiles error notifications.
XMP_Bool isDebug
A 0/1 boolean value, true if this is a debug build.
XMP_Int32 id
Exception code. See constants kXMPErr_Unknown and following.
XMP_Uns8 charForm
Character format using the values kXMP_Char8Bit, kXMP_Char16BitBig, etc.
@ kXMP_SVGFile
Public file format constant: 'SVG '.
bool(* XMP_AbortProc)(void *arg)
The signature of a client-defined callback to check for a user request to abort a time-consuming oper...
@ kXMPErr_ReadError
A file read failed.
@ kXMP_TimeWestOfUTC
Time zone is west of UTC.
@ kXMPErr_BadIPTC
IPTC format error.
@ kXMP_Char32BitLittle
32-bit little-endian
@ kXMP_ParseMoreBuffers
This is the not last input buffer for this parse stream.
XMP_Int32 tzMinute
The time zone minute in the range 0..59.
static const XMP_Int8 Max_XMP_Int8
@ kXMP_XDCAM_FAMFile
Public file format constant: 'XDCF', a collection not really a single file.
XMP_Uns32 build
A rolling build number, monotonically increasing in a release.
SeekMode
Seek mode constants for use with XMP_IO and inside XMPFiles library code.
void SetNotified()
Sets the notification status for an error.
@ kXMPUtil_IncludeAliases
Include aliases, default is just actual properties.
@ kXMP_XDCAM_SAMFile
Public file format constant: 'XDCS', a collection not really a single file.
XMP_Uns8 minor
The secondary release number, the "2" in version "1.2.3".
@ kXMP_IterSkipSiblings
Skip the subtree below and remaining siblings of the current node.
@ kXMPFiles_CanInjectXMP
Can inject first-time XMP into an existing file.
XMP_Int32 day
The day of the month in the range 1..31.
@ kXMP_InsertBeforeItem
Option for array item location: Insert a new item before the given index.
@ kXMPFiles_CanReconcile
Supports reconciliation between XMP and other forms.
XMP_Status(* XMP_TextOutputProc)(void *refCon, XMP_StringPtr buffer, XMP_StringLen bufferSize)
The signature of a client-defined callback for text output from XMP Toolkit debugging operations.
@ kXMP_TimeEastOfUTC
Time zone is east of UTC.
@ kXMP_SWFFile
Public file format constant: 'SWF '.
@ kXMPTemplate_ClearUnnamedProperties
Perform a Clear operation, keep named properties and delete everything else.
@ kXMPErr_Unavailable
Generic unavailable error.
@ kXMP_TimeIsUTC
UTC time.
@ kXMP_RequireXMPMeta
Require a surrounding x:xmpmeta element.
@ kXMP_PNGFile
Public file format constant: 'PNG '.
@ kXMPErr_StdException
Generic standard exception.
struct __XMPFiles__ * XMPFilesRef
An "ABI safe" pointer to the internal part of an XMP file-handling object. Use to pass an XMP file-ha...
@ kXMPErr_BadFileFormat
File format error.
@ kXMP_IncludeRDFHash
Include a rdf Hash and Merged flag in x:xmpmeta element.
@ kXMPFiles_IgnoreLocalText
Ignore non-XMP text that uses an undefined "local" encoding.
@ kXMP_PremiereProjectFile
Adobe application file format constant: 'PRPJ'.
@ kXMP_OmitAllFormatting
Omit all formatting whitespace.
@ kXMPErrSev_OperationFatal
Recovery is not possible, an exception will be thrown aborting the API call.
XMP_Int32 hour
The hour in the range 0..23.
@ kXMPFiles_OpenUsePacketScanning
Force packet scanning, do not use a smart handler.
@ kXMPFiles_AllowsOnlyXMP
Allows access to just the XMP, ignoring other forms.
@ kXMPTemplate_IncludeInternalProperties
Do all properties, default is just external properties.
@ kXMP_REDFile
Public file format constant: 'RED ', RED file format.
@ kXMP_UnknownFile
Unknown file format constant: ' '.
@ kXMP_IterJustLeafNodes
Just do the leaf nodes, default is all nodes in the subtree.
XMP_Uns8 major
The primary release number, the "1" in version "1.2.3".
@ kXMPErr_BadXMP
XMP format error.
@ kXMPFiles_PrefersInPlace
Can expand, but prefers in-place update.
@ kXMPUtil_DeleteEmptyValues
Delete properties if the new value is empty.
@ kXMPErr_BadValue
Generic bad value error.
@ kXMPUtil_DoAllProperties
Do all properties, default is just external properties.
@ kXMPErr_BadMPEG
MPEG format error.
@ kXMP_PremiereTitleFile
Adobe application file format constant: 'PRTL'.
@ kXMPFiles_OptimizeFileLayout
When updating a file, spend the effort necessary to optimize file layout.
@ kXMP_CharLittleEndianMask
@ kXMP_MPEG2File
Public file format constant: 'MP2 '.
@ kXMPErr_AssertFailure
Generic assertion failure.
@ kXMP_PropIsInternal
The value of this property is "owned" by the application, and should not generally be editable in a U...
@ kXMPFiles_OpenLimitedScanning
Only packet scan files "known" to need scanning.
@ kXMP_InDesignFile
Adobe application file format constant: 'INDD'.
@ kXMP_PostScriptFile
Public file format constant: 'PS ', general PostScript following DSC conventions.
XMP_Int32 GetID() const
Retrieves the numeric code from an XMP_Error.
@ kXMP_EncoreProjectFile
Adobe application file format constant: 'NCOR'.
@ kXMP_XDCAM_EXFile
Public file format constant: 'XDCX', a collection not really a single file.
static const XMP_Int16 Max_XMP_Int16
@ kXMPErr_FilePathNotAFile
File Path is not a file.
@ kXMP_PropIsDerived
The value of this property is derived from the document content.
@ kXMP_AVCHDFile
Public file format constant: 'AVHD', a collection not really a single file.
@ kXMP_UCFFile
Adobe application file format constant: 'UCF ', Universal Container Format.
static const XMP_Int64 Min_XMP_Int64
@ kXMP_MPEGFile
Public file format constant: 'MPEG'.
@ kXMP_CELFile
Public file format constant: 'CEL ', Audition loop.
XMP_Bool(* XMPFiles_ErrorCallbackWrapper)(XMPFiles_ErrorCallbackProc clientProc, void *context, XMP_StringPtr filePath, XMP_ErrorSeverity severity, XMP_Int32 cause, XMP_StringPtr message)
@ kXMP_AVIFile
Public file format constant: 'AVI '.
@ kXMP_EPSFile
Public file format constant: 'EPS ', encapsulated PostScript.
@ kXMP_ImplReservedMask
Mask for bits that are reserved for transient use by the implementation.
@ kXMP_CharUnknown
Variable or not-yet-known cases.
@ kXMPFiles_UsesSidecarXMP
The file handler uses a "sidecar" file for the XMP.
@ kXMPUtil_AllowCommas
Allow commas in item values, default is separator.
@ kXMP_MPEG4File
Public file format constant: 'MP4 ', ISO 14494-12 and -14.
@ kXMPErr_BadIterPosition
Bad iteration position.
@ kXMPErrSev_FileFatal
Recovery is not possible, an exception will be thrown, the file is corrupt and possibly unusable.
@ kXMP_TextFile
Public file format constant: 'text'.
@ kXMP_MP3File
Public file format constant: 'MP3 '.
@ kXMP_JPEG2KFile
Public file format constant: 'JPX ', JPEG 2000, ISO 15444-1.
struct __XMPDocOps__ * XMPDocOpsRef
An "ABI safe" pointer to the internal part of an XMP document operations object. Use to pass an XMP d...
@ kXMPErr_BadPSIR
PSIR format error.
@ kXMPErr_WriteError
A file write failed for a reason other than lack of disk space.
#define kXMPFiles_UnknownOffset
Constant for an unknown packet offset within a file.
@ kXMP_EncodeUTF16Big
Use UTF16 big-endian encoding.
static const XMP_Uns32 Min_XMP_Uns32
@ kXMP_PropArrayIsAltText
@ kXMPErr_BadUnicode
Unicode error.
@ kXMP_AEProjectFile
Adobe application file format constant: 'AEP '.
@ kXMP_UseCanonicalFormat
Use a canonical form of RDF.
@ kXMPErr_BadJPEG
JPEG format error.
@ kXMP_StrictAliasing
Do not reconcile alias differences, throw an exception.
@ kXMPErr_TBD
Generic undefined error.
@ kXMPFiles_OpenOnlyXMP
Only the XMP is wanted, allows space/time optimizations.
@ kXMP_Char16BitBig
16-bit big-endian
const typedef char * XMP_StringPtr
The type for input string parameters. A const char *, a null-terminated UTF-8 string.
@ kXMPTS_Yes
The part or parts have definitely changed.
@ kXMP_FLAFile
Public file format constant: 'FLA '.
@ kXMP_IterSkipSubtree
Skip the subtree below the current node.
@ kXMPErr_NoFile
A file does not exist.
static const XMP_Int32 Min_XMP_Int32
@ kXMPErr_FilePermission
A file exists but cannot be opened.
XMP_Uns8 micro
The tertiary release number, the "3" in version "1.2.3".
@ kXMPFiles_NeedsPreloading
The plugin handler is not capable for delay loading.
@ kXMP_PropCompositeMask
Property type bit-flag mask for composite types (array and struct)
struct __XMPMeta__ * XMPMetaRef
An "ABI safe" pointer to the internal part of an XMP object. Use to pass an XMP object across client ...
XMP_Error(XMP_Int32 _id, XMP_StringPtr _errMsg)
Constructor for an XMP_Error.
@ kXMPFiles_FolderBasedFormat
The format is folder oriented, for example the P2 video format.
bool(* XMP_ProgressReportProc)(void *context, float elapsedTime, float fractionDone, float secondsToGo)
The signature of a client-defined callback for progress report notifications.
XMP_Int64 offset
Packet offset in the file in bytes, -1 if unknown.
XMP_Int32 nanoSecond
Nanoseconds within a second, often left as zero.
@ kXMP_PacketInfoVersion
Version of the XMP_PacketInfo type.
@ kXMPErr_ExternalFailure
Generic external failure.
XMP_Uns8 pad
Padding to make the struct's size be a multiple 4.
@ kXMPFiles_CanRewrite
Can copy one file to another, writing new metadata.
@ kXMP_ExactPacketLength
The padding parameter is the overall packet length.
@ kXMP_SonyHDVFile
Public file format constant: 'SHDV', a collection not really a single file.
@ kXMPTemplate_ReplaceWithDeleteEmpty
Similar to Replace, also delete if the template has an empty value.
@ kXMP_PropArrayFormMask
Property type bit-flag mask for all array types.
XMP_Bool writeable
True if there is a packet wrapper and the trailer says writeable by dumb packet scanners.
@ kXMPFiles_ReturnsRawPacket
File handler returns raw XMP packet information.
@ kXMP_PropArrayIsOrdered
Implies kXMP_PropValueIsArray, item order matters. It is serialized using an rdf:Seq container.
@ kXMPErr_ProgressAbort
Progress reporting callback requested abort.
@ kXMPErr_HEIFConstructionMethodNotSupported
HEIF format: Modify Operation is not supported for Construction Method 1 or 2.
@ kXMP_EncodeUTF16Little
Use UTF16 little-endian encoding.
@ kXMPErr_BadParam
Generic bad parameter error.
XMP_Uns32 XMP_StringLen
The type for string length parameters. A 32-bit unsigned integer, as big as will be practically neede...
@ kXMPErr_DiskSpace
A file write failed due to lack of disk space.
@ kXMPFiles_OpenForRead
Open for read-only access.
XMP Toolkit error, associates an error code with a descriptive error string.
static const XMP_Uns32 Max_XMP_Uns32
static const XMP_Int8 Min_XMP_Int8
static const XMP_Uns8 Max_XMP_Uns8
@ kXMP_DeleteExisting
Delete any pre-existing property.
@ kXMPErr_BadSerialize
Serialization error.
static const XMP_Uns64 Min_XMP_Uns64
static const XMP_Uns64 Max_XMP_Uns64
@ kXMP_AVCUltraFile
Public file format constant: 'AVCU', a collection not really a single file.
XMP_Int32 year
The year, can be negative.
@ kXMPFiles_AllowsSafeUpdate
The file handler allows crash-safe file updates.
XMP_Int32 XMP_Index
The type for offsets and indices. A 32-bit signed integer. It is signed to allow -1 for loop terminat...
XMP_Uns32 flags
Individual feature implementation flags.
@ kXMP_ARRIFile
Public file format constant: 'ARRI', ARRI file format.
XMP_Uns8 XMP_ErrorSeverity
@ kXMPErr_TooLargeForJPEG
Data too large for JPEG file format.
XMP_Bool(* XMPMeta_ErrorCallbackWrapper)(XMPMeta_ErrorCallbackProc clientProc, void *context, XMP_ErrorSeverity severity, XMP_Int32 cause, XMP_StringPtr message)
Internal: The signatures of client-side wrappers for the error notification callbacks.
@ kXMPErr_BadXPath
Bad XPath parameter.
XMP_Int32 length
Packet length in the file in bytes, -1 if unknown.
@ kXMP_OmitXMPMetaElement
Omit the x:xmpmeta element surrounding the rdf:RDF element.
@ kXMP_WMAVFile
Public file format constant: 'WMAV', Windows Media Audio and Video.
XMP_PacketInfo()
Default constructor.
@ kXMP_OmitPacketWrapper
Omit the XML packet wrapper.
@ kXMP_IterClassMask
The low 8 bits are an enum of what data structure to iterate.
@ kXMPErr_NoMemory
Generic out-of-memory error.
XMP_StringPtr message
A comprehensive version information string.
@ kXMPTemplate_ReplaceExistingProperties
Perform a Replace operation, add new properties and modify existing ones.
XMP_Bool notified
Variable to store whether this particular error is notified to user or not.
@ kXMP_IterAliases
Iterate the global alias table.
@ kXMPFiles_ForceGivenHandler
Force use of the given handler (format), do not even verify the format.
@ kXMPUtil_ReplaceOldValues
Replace existing values, default is to leave them.
@ kXMP_PDFFile
Public file format constant: 'PDF '.
@ kXMPErr_BadObject
Generic bad object error.
XMP_Int32 second
The second in the range 0..59.
@ kXMP_WAVFile
Public file format constant: 'WAV '.
@ kXMPErrSev_ProcessFatal
Recovery is not possible, an exception will be thrown, the entire process should be aborted.
@ kXMP_AIFFFile
Public file format constant: 'AIFF'.
static const XMP_Int16 Min_XMP_Int16
@ kXMP_HEIFFile
Public file format constant: 'HEIF', HEIF file format.
@ kXMPTemplate_AddNewProperties
Perform an Add operation, add properties if they don't already exist.
XMP_Bool hasTime
Is the time portion meaningful?
struct XMP_VersionInfo XMP_VersionInfo
XMP Toolkit version information.
@ kXMP_CINFile
Public file format constant: 'CIN ', Cineon.
@ kXMPErr_BadParse
XML parsing error (deprecated)
XMP_Bool(* XMP_ProgressReportWrapper)(XMP_ProgressReportProc proc, void *context, float elapsedTime, float fractionDone, float secondsToGo)
Internal: The signature of a client-side wrapper for the progress report callback.
@ kXMP_PropHasType
Implies kXMP_PropHasQualifiers, property has rdf:type.
bool(* XMPMeta_ErrorCallbackProc)(void *context, XMP_ErrorSeverity severity, XMP_Int32 cause, XMP_StringPtr message)
The signature of a client-defined callback for TXMPMeta error notifications.
@ kXMPErr_BadBlockFormat
A block of a file is ill-formed, e.g. invalid IPTC-IIM in a photo.
@ kXMP_IterNamespaces
Iterate the global namespace table.
@ kXMPFiles_NeedsReadOnlyPacket
The file format needs the XMP packet to be read-only.
static const XMP_Uns8 Min_XMP_Uns8
static const XMP_Int64 Max_XMP_Int64
XMP_Bool hasTimeZone
Is the time zone meaningful?
@ kXMP_JPEGFile
Public file format constant: 'JPEG'.
@ kXMPErr_NoFileHandler
No file handler found for format.
@ kXMPErr_BadIndex
Bad index parameter.
@ kXMPErr_BadOptions
Bad options parameter.
struct __XMPIterator__ * XMPIteratorRef
An "ABI safe" pointer to the internal part of an XMP iteration object. Use to pass an XMP iteration o...
@ kXMPFiles_CanExpand
Can expand XMP or other metadata in an existing file.
static const XMP_Int32 Max_XMP_Int32
@ kXMP_Char32BitBig
32-bit big-endian
const XMP_Uns8 kXMP_Bool_False
@ kXMP_EncodeUTF32Big
Use UTF32 big-endian encoding.
@ kXMPErr_EmptyIterator
Empty iterator.
XMP_Bool hasWrapper
True if there is a packet wrapper, the "<?xpacket...>" XML processing instructions.
@ kXMP_TIFFFile
Public file format constant: 'TIFF'.
XMP_Bool IsNotified() const
Retrieves the information whether particular error is notified or not.
@ kXMP_P2File
Public file format constant: 'P2 ', a collection not really a single file.
@ kXMP_XMLFile
Public file format constant: 'XML '.
XMP_Int32 XMP_Status
A signed 32-bit integer used as a status result for the output callback routine, XMP_TextOutputProc....
@ kXMPErr_BadPNG
PNG format error.
@ kXMP_EncodeUTF32Little
Use UTF13 little-endian encoding.
@ kXMP_EncodingMask
Bit-flag mask for encoding-type bits.
@ kXMP_EncodeUTF8
Use UTF8 encoding.
@ kXMP_AEProjTemplateFile
Adobe application file format constant: 'AET ', After Effects Project Template.
@ kXMPFiles_HandlerOwnsFile
The file handler does the file open and close.
@ kXMPErr_BadTIFF
TIFF format error.
@ kXMP_IterProperties
Iterate the property tree of a TXMPMeta object.
@ kXMPErr_UserAbort
Generic user abort error.
@ kXMP_CanonXFFile
Public file format constant: 'CNXF', a collection not really a single file.
@ kXMP_IllustratorFile
Adobe application file format constant: 'AI '.
@ kXMP_IncludeThumbnailPad
Include a padding allowance for a thumbnail image.
@ kXMP_PropArrayIsAlternate
Implies kXMP_PropArrayIsOrdered, items are alternates. It is serialized using an rdf:Alt container.
XMP_Uns32 XMP_OptionBits
The type for a collection of 32 flag bits.
@ kXMP_HTMLFile
Public file format constant: 'HTML'.
@ kXMPErr_BadPSD
PSD format error.
XMP_Int32 tzHour
The time zone hour in the range 0..23.
The expanded type for a date and time.
@ kXMP_InsertAfterItem
Option for array item location: Insert a new item after the given index.
@ kXMP_UseCompactFormat
Use a compact form of RDF.
@ kXMP_PropIsStable
The value of this property is not derived from the document content.
@ kXMPErr_BadSchema
Bad schema parameter.
@ kXMPFiles_OpenStrictly
Be strict about only attempting to use the designated file handler, no fallback to other handlers.
@ kXMPFiles_NeedsLocalFileOpened
XMP_Int32 month
The month in the range 1..12.
@ kXMP_MOVFile
Public file format constant: 'MOV ', Quicktime.
@ kXMP_ReadOnlyPacket
Default is a writeable packet.
static const XMP_Uns16 Min_XMP_Uns16
XMP_Uns32 XMP_FileFormat
Type for file format identification constants. See kXMP_PDFFile and following.
@ kXMPFiles_UpdateSafely
Write into a temporary file and swap for crash safety.
@ kXMP_IterJustLeafName
Return just the leaf part of the path, default is the full path.
@ kXMPFiles_OpenRepairFile
Attempt to repair a file opened for update, default is to not open (throw an exception).
@ kXMPErr_BadRDF
RDF format error.
@ kXMPErr_UnknownException
Generic unknown exception.
XMP_Bool hasDate
Is the date portion meaningful?
@ kXMPFiles_CanNotifyProgress
The file Handler is capable of notifying progress notifications.
@ kXMP_PropHasLang
Implies kXMP_PropHasQualifiers, property has xml:lang.
@ kXMPErr_EnforceFailure
Generic enforcement failure.
@ kXMP_PropValueOptionsMask
Bit-flag mask for property-value option bits.
@ kXMP_GIFFile
Public file format constant: 'GIF '.
@ kXMPErr_Unknown
Generic unknown error.
@ kXMP_PropValueIsStruct
The value is a structure with nested fields.
@ kXMPErr_Unimplemented
Generic unimplemented error.