IImageAttributes.h

//========================================================================================
// 
// $File$
// 
// Owner: jargast
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 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 you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IImageAttributes__
#define __IImageAttributes__

#include "IPMUnknown.h"
#include "ImageTypes.h"
#include "ImageID.h"
#include "UIDList.h"

class IImageAttributes : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IIMAGEATTRIBUTES};

 typedef enum {
 kPMTagDefault = 0, // If not one of the Tags enumerated below, then treat as bytes
 kPMTagByte = 1, // 8-bit quantity
 kPMTagWord = 2, // 16-bit integer
 kPMTagLong = 3, // 32-bit integer
 kPMTagFixed = 4 // 32-bit quantity containing the integer part in the 
 // high order word and the fractional part in the low order 
 // word. Divide by 65536.0 to convert to float
 } ImageTagTypes;

 enum {
 kOPIExtraTIFFASCIITagPrefix = 0x17000000
 };

 enum
 {
 kPMTagImageWidth = 100, //R TYPE: uint32 
 kPMTagImageHeight = 101, //R TYPE: uint32
 kPMTagBitsPerChannel = 102, //R TYPE: uint32 1, 2, 4, 6, and 8 are supported.
 kPMTagColorSpace = 103, //R TYPE: uint32 One of the defined PM image color spaces
 kPMTagDocumentName = 104, // TYPE: array null terminated string
 kPMTagImageDescription = 105, // TYPE: array null terminated strings
 kPMTagChannelsPerPixel = 106, //R TYPE: uint32 Number of channels (including extra samples) in image
 kPMTagNumberOfLayers = 107, // TYPE: uint32 default 1, but for Photoshop format images could be more
 kPMTagXResolution = 108, //R TYPE: UFixed32 X resolution in DPI (UNSIGNED 32-bit quantity containing the integer part in the 
 // high order word and the fractional part in the low order word).
 kPMTagYResolution = 109, //R TYPE: UFixed32 Y resolution in DPI (UNSIGNED 32-bit quantity containing the integer part in the 
 // high order word and the fractional part in the low order word).
 kPMTagPlanarConfig = 110, //R TYPE: uint32 kPMChunky or kPMPlanar.
 kPMTagColorMap = 111, // TYPE: array Arranged in interleaved order, 1 >> numBits entries. 
 kPMTagOptimalTileWidth = 112, // TYPE: uint32 Gives the width in pixels of the best tile size to ask for
 kPMTagOptimalTileHeight = 113, // TYPE: uint32 Gives the height in pixels of the best tile size to ask for
 kPMTagChannelNames = 114, // TYPE: array null terminated strings. There should be SamplesPerPixel names
 kPMTagChannelInfo = 115, // TYPE: array TODO: set of channel descriptions. Primary, mask, assocatied, unassociated?
 kPMTagLayerInfo = 116, // TYPE: array TODO: layer info. Required if num layers > 1
 kPMTagTIFFClipPath = 117, // TYPE: array TIFF clipping path data.
 kPMTagTIFFXClipPathUnits = 118, // TYPE: uint32 
 kPMTagTIFFYClipPathUnits = 119, // TYPE: uint32
 kPMTagOPIProxy = 120, // TYPE: uint8 0 = not proxy, 1 = proxy: high-res image is given by kPMTagOPIImageID
 kPMTagOPIImageID = 121, // TYPE: array Full path name of original high-res image
 kPMTagICCProfileData = 122, // TYPE: array black box inter color 3.0 profile
 kPMTagWhiteIsZero = 123, // TYPE: uint8 For bilevel and grayscale images: True: indicates 0 is imaged as white, False: indicates 0 is imaged as black.
 // If no tag value is set, then 1-bit images will be treated as 1 and non-1-bit grayscale images will be treated as 0
 // by the ImageStreamManager.
 kPMTagAlphaType_obsolete = 124, // TYPE: uint32 depreciated - replaced by kPMTagChannelTypeArray
 kPMTagTIFFClipPathName = 125, // TYPE: array Name of the Photoshop clipping path which identifies the resource.
 kPMTagNoOPIGeneration = 126, // TYPE: uint8 If non-zero, InDesign will not generate OPI comments for this image.
 kPMTagNeverOmit = 127, // TYPE: uint8 If non-zero, InDesign will never Omit this image.
 kPMTagPhotoshop8BIM = 128, // TYPE: array PhotoShop's Image Resource Block field
 kPMTagTransparencyMask = 129, // TYPE: uint8 zero-based index with respect to the first extra channel of the channel
 // to use as a kPMUnassociatedTransparency mask.
 kPMTagAlphaPacking = 130, // TYPE: uint32 kPMAlphaPackingPreOrder or kPMAlphaPackingPostOrder -- PostOrder is preferred. PreOrder may not
 // be supported by Write filters.
 kPMTagNumberOfVisibleLayers = 131, // TYPE: uint32 number of visible layers
 kPMTagVisibleLayerInfo = 132, // TYPE: array if num visible layers exists and is > 0, array of name strings
 kPMTagXMPData = 133, // TYPE: array A block of XMP data.
 kPMTagChannelTypeArray = 134, // TYPE: array one of kPMAlphaAssociated, kPMAlphaUnassociated or kPMSpotChannel. Default is kPMAlphaUnassociated.
 // kPMAlphaAssociated indicates a transparency mask where the alpha has been pre-multiplied into
 // the color values. To use a kPMAlphaUnassociated alpha as a transparency mask, set the
 // kPMTagTransparencyMask tag to the zero based index of the alpha to use. Note: Currently, InDesign 2.0
 // only supports an index of 0 but in the future we will allow the client to specify any channel and we
 // will automatically un-pre-multiply any existing Associated alpha channel if necessary.
 kPMTagChannelNameArray = 135, // TYPE: array names associated with the channels in the kPMTagChannelTypeArray tag. Each name is null terminated.
 // If there is no name (i.e. for kPMAlphaAssociated alpha channel), there will only be a null to
 // represent the name. 
 kPMTagEPSProxySource = 136, // TYPE: uint32 This tag is only present in the proxy image for an EPS. The tag value tells us if the proxy
 // was created from a PICT preview, TIFF preview or from rendering the PostScript. PICT based proxies
 // are the least trust worthy because they do not usually have transparency data.
 kPMTagHavePSDComposite = 137, // TYPE: uint8 Non-zero value indicates that we have a PSD image which was saved from Photoshop with
 // Maximize Backwards Compatibility turned on.
 kPMAttributesAreSynthetic = 138, // TYPE: uint8 Non-zero value indicates that attributes are synthetic and not based on actual image attributes
 // This will be true if image is a temporary created by scripting code and import is still pending
 kPMTagHaveICCProfileData = 139, // TYPE: uint8 Large profiles end up getting deleted from the IImageAttributes to avoid bloat. Therefore, to
 // get the profile data, we have to re-read the IImageAttributes from the linked image. To avoid
 // unnecessary disk access, this tag can be used as a cache to indicate whether or not there is
 // an embedded profile. If the tag does not exist, then we do not know if the profile exists or not.
 kPMTagImageAttributeRev = 140, // TYPE: uint32 This tag holds the revision of the filter when the attributes were initialized via GetImageAttributes.
 // It is in the form 0xAAAABBBB where AAAA = filter major version, BBBB = filter minor version.
 kPMTagMetaDataRotation = 141, // TYPE: int16 This holds the angle that was read out of the meta data tiff:orientation tag, so we can undo the
 // rotation when the image is replaced.
 kPMTagJPEG_EXIF_Resolution = 142, // TYPE: UFixed32 Same as kPMTagXResolution except that this resolution value came from the EXIF structure of a JPEG (camera raw) image.
 kPMTagPrivate_Thumbnail = 143, // TYPE: array Private.
 kPMTagOrientation = 144, // TYPE: int16 Corresponds to TIFF tag #274
 kPMTagUseAIDEforPng = 145, // TYPE: uint32 This tag holds the revision of the filter when the attributes were initialized via GetImageAttributes.
 };

 enum { 
 kFirstImageAttributeTag = kPMTagImageWidth, 
 kLastImageAttributeTag = kPMTagEPSProxySource // Any tag greater than this value will require an ImageTagTypes passed to SetTag
 };

 enum
 {
 kEPSPICTProxy = 0, // The proxy was generated from a PICT preview
 kEPSTIFFProxy = 1, // The proxy was generated from a TIFF preview
 kEPSPSProxy = 2 // The proxy was generated by rendering the PostScript into a raster port
 };

 enum {
 kPMPlanarDefault = kPMChunky
 };

 virtual uint32 GetTagSize (uint32 tagID) const = 0;
 
 virtual const char* GetTag (uint32 tagID, void* imageTagData) const = 0;
 
 virtual ImageTagTypes GetTagType (uint32 tagID) const = 0;

 virtual bool16 SetTag (uint32 tagID, uint32 imageTagSize, const void* imageTagData, ImageTagTypes type = kPMTagDefault) = 0;
 
 virtual bool16 DeleteTag (uint32 tagID) = 0;
 
 virtual bool16 TagExists (uint32 tagID) const = 0;
 
 virtual bool16 CopyTags (const IImageAttributes* copy) = 0;
 
 
 virtual uint32 GetTagCount() const = 0;
 
 virtual uint32 GetNthTagSize (uint32 n) const = 0;
 
 virtual uint32 GetNthTagID (uint32 n) const = 0;
 
 virtual ImageTagTypes GetNthTagType (uint32 n) const = 0;

 virtual const char* GetNthTag (uint32 n) const = 0;

 virtual const UIDList* CreateUsedColorUIDList(const UIDList* pUIDList) = 0;
 virtual const UIDList* GetUsedColorUIDList() const = 0;

};

#endif