PIFormat.h

Go to the documentation of this file.

// ADOBE SYSTEMS INCORPORATED
// Copyright  1993 - 2014 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 __PIFormat__
#define __PIFormat__

#if PRAGMA_ONCE
#pragma once
#endif

#include <stdio.h>

#if MSWindows
#ifndef __PSWorld__
#include "PITypes.h"    // contains FSSpec
#else
#include <Files.h>      // contains betterer FSSpec
#endif
#endif

#include "PIActions.h"
#include "PIGeneral.h"
#include "SPBasic.h"
#include "SPFiles.h"

/* Operation selectors */


#define formatSelectorAbout                 0

#define formatSelectorReadPrepare           1

#define formatSelectorReadStart             2

#define formatSelectorReadContinue          3

#define formatSelectorReadFinish            4

#define formatSelectorOptionsPrepare        5

#define formatSelectorOptionsStart          6

#define formatSelectorOptionsContinue       7

#define formatSelectorOptionsFinish         8

#define formatSelectorEstimatePrepare       9

#define formatSelectorEstimateStart         10

#define formatSelectorEstimateContinue      11

#define formatSelectorEstimateFinish        12

#define formatSelectorWritePrepare          13

#define formatSelectorWriteStart            14

#define formatSelectorWriteContinue         15

#define formatSelectorWriteFinish           16

#define formatSelectorFilterFile            17

#define formatSelectorGetFilePropertyValue  18  
#define formatSelectorLosslessRotate        19  
#define formatSelectorBulkSettings          20  
#define formatSelectorXMPRead               21  
#define formatSelectorXMPWrite              22  
#define formatSelectorBulkOpen              23

#define formatSelectorLoad                  24
#define formatSelectorUnload                25

#define formatSelectorPreferences           26

#define formatSelectorSettingsCopy          27
#define formatSelectorSettingsPaste         28
#define formatSelectorSettingsClear         29
#define formatSelectorSettingsDefault       30
#define formatSelectorSettingsPrevious      31
#define formatSelectorSettingsPresetList    32
#define formatSelectorSettingsChecksum      33

#define formatSelectorXMPAppend             34

#define formatSelectorReadLayerStart        35
#define formatSelectorReadLayerContinue     36
#define formatSelectorReadLayerFinish       37

#define formatSelectorWriteLayerStart       38
#define formatSelectorWriteLayerContinue    39
#define formatSelectorWriteLayerFinish      40
 // end ingroup
  
// called when the plugin is used to launch an external editor (that Photoshop may not know about)
// fileSpec and fileSpec2 will be the only valid fields in the format record
#define formatSelectorLaunchExternalEditor  41

/*  We keep various pieces of information about the file format in the PiMI resource.
    Here is the structure of that resource. */

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




#define PIFmtFileTypeProperty           0x666d5443  /* 'fmTC' <TypeCreatorPair> Default file type for file format. */

#define PIReadTypesProperty             0x52645479  /* 'RdTy' <TypeCreatorPair []> File type info for file format plug-ins */

#define PIFilteredTypesProperty         0x66667454  /* 'fftT' <TypeCreatorPair []> File types to filter for file format plug-ins */

#define PIReadExtProperty               0x52644578  
#define PIFilteredExtProperty           0x66667445  /* 'fftE' <OSType []> File types to filter for file format plug-ins */

#define PIFmtFlagsProperty              0x666d7466  /* 'fmtf' <Set> Format flags */

#define PIFmtHiddenFlagsProperty        0x666D6869  /* 'fmhi' Hidden read/write flags  */

#define PIFmtICCFlagsProperty           0x666D6970  /* 'fmip' ICC profile flags. */

#define PIFmtICCRequiredFlagsProperty   0x666D6972  /* 'fmir' ICC required profile flags.*/

#define PIFmtMaxSizeProperty            0x6d78737a  /* 'mxsz' <Point> Max rows and cols supported by this format.   */

#define PIFmtMaxChannelsProperty        0x6d786368  /* 'mxch' <int16 []> Max channels per mode for this format. */

#define PIFmtFilePropertiesProperty     0x66667073  /* 'ffps' Supports formatSelectorGetFilePropertyValue selector. */

#define PIFmtLosslessRotateProperty     0x666C6C72  /* 'fllr' Supports formatSelectorLosslessRotate selector. */

#define PIFmtBulkSettingsProperty       0x66666273  /* 'ffbs' Supports formatSelectorBulkSettings selector.*/

#define PIFmtPrimaryMetadataProperty    0x6666706d  /* 'ffpm' File format is primary metadata source.*/

#define PIFmtPrimaryThumbnailProperty   0x66667074  /* 'ffpt' File format is primary thumbnail source. */

#define PIFmtXMPReadProperty            0x786D7072  /* 'xmpr' Supports formatSelectorXMPRead selector.*/

#define PIFmtXMPWriteProperty           0x786D7077  /* 'xmpw' Supports formatSelectorXMPWrite selector. */

#define PIFmtQuickThumbExtractProperty  0x7174686D  /* 'qthm' Supports extractQuickThumbnail field. */

#define PIFmtBulkOpenProperty           'ffbo'      /* 'ffbo' Supports formatSelectorBulkOpen selector. */

#define PIFmtRawSettingsProperty        'rscp'      /* 'rscp' Supports settings copy/paste/etc selectors.*/

#define PIFmtOpenWriteAccessProperty    'fowa'      /* 'fowa' Plug-in prefers write access when opening.*/

#define PIFmtWarnIfOverriddenProperty   'fwio'      /* 'fwio' Warning if this plug-in is override by another. */

#define PIFmtResourceThreadSafeProperty 'frts'      /* 'ft' Plug-in is resource fork thread safe. */

#define PIFmtSupportsLayersProperty     'fmsl'      /* 'fmsl' plug-in supports layers */

#define PIFmtSupportsLayersReadOnlyProperty 'slRO'  /* 'slRO' plug-in layer support is read-only */

#define PIFmtSupportsBackgroundSaveProperty 'fbgs'  /* 'fbgs' plug-in supports background save */

#define PIFmtSupportsPOSIXIOProperty 'fxio'     /* 'fxio' plug-in supports POSIX API for read and write */

#define PIFmtFileSizeLimitProperty          0x66736c6d  /* 'fslm' <int32 > Max size on disk your format can read and write. In gigabytes. */

#define PIFmtSupportsPluginOpeningFile 'fpof'   /* 'fpof' plug-in supports open and closing files for itself. */


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

/* properties that can be requested through formatSelectorGetFilePropertyValue */

#define PIFmtPRotate                0x66726F74  
/******************************************************************************/

/* property values that should be returned by formatSelectorGetFilePropertyValue */

#define PIFmtPVNotSupported                 0   
/* values for kFFPRotate */
#define PIFmtPVRotateNo                     2   
#define PIFmtPVRotateIsLossy                3   
#define PIFmtPVRotateIsLossless             4   
#define PIFmtPVRotateIsLosslessWithCallback 5   
    /* add values for other format file properties here */

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

/* Format Hidden Flags Indices. */



#define PIFmtShowReadFlag       0
#define PIFmtShowWriteFlag      1


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

/* Format flags indices. */



#define PIFmtReadsAllTypesFlag 0

#define PIFmtSavesImageResourcesFlag 1

#define PIFmtCanReadFlag 2

#define PIFmtCanWriteFlag 3

#define PIFmtCanWriteIfReadFlag 4

#define PIFmtCanWriteTransparency 5

#define PIFmtCanCreateThumbnail 6

#define PIFmtCanWriteSpotChannel 7

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

/* Format ICC Profile Flags Indices. */



#define PIFmtICCEmbedGrayFlag       0    
#define PIFmtICCEmbedIndexedFlag    1    
#define PIFmtICCEmbedRGBFlag        2    
#define PIFmtICCEmbedCMYKFlag       3    

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

/* Required Format ICC Profile Flags Indices. */



#define PIFmtICCRequireGrayFlag         0    
#define PIFmtICCRequireIndexedFlag      1    
#define PIFmtICCRequireRGBFlag          2    
#define PIFmtICCRequireCMYKFlag         3    

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

/* Bit masks for the browserRotation field */



#define PIFmtBrowserRotationFlipFlag        2   
#define PIFmtBrowserRotationDisableFlag     3   
#define PIFmtBrowserRotationEnableFlag      4   

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

/* Bit masks for bulkMask and bulkFlags fields */



#define PIFmtBulkOpenMask               1
#define PIFmtBulkInvalPreviewMask       2
#define PIFmtBulkInvalMetaMask          4
#define PIFmtBulkDeleteMask             8
#define PIFmtBulkModifyListMask        16


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

/* Pragma to byte align structures; for Microsoft C */
#if WIN32
#pragma pack(push,1)
#endif

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

#if PRAGMA_STRUCT_ALIGN
#pragma options align=mac68k
#endif

typedef struct FormatInfo
    {

    PlugInInfo  plugInInfo;             
    int16       typeCount;              
    int16       extensionCount;         
    Boolean     canRead;                
    Boolean     readsAllTypes;          
    Boolean     canWrite;               
    Boolean     canWriteIfRead;         
    Boolean     savesImageResources;    
    Boolean     padFlag;                
    int16       maxChannels [16];       
    int16       maxRows;                
    int16       maxCols;                
    OSType      fileType;               
    OSType      creatorType;            
    OSType      typeList [1];           
    }
FormatInfo;

/* Pragma to turn off align structures for Microsoft C */
#if WIN32
#pragma pack(pop)
#endif
/******************************************************************************/




#define formatBadParameters     -30500  
#define formatCannotRead        -30501  
#define formatSkipFile          -30502  
#define formatPasswordProtected -30503  
#define formatUnsupportedRaw    -30504  
#define formatUnsupportedDNG    -30505  

#if WIN32
#pragma pack(push,4)
#endif

typedef struct FormatRecord
    {

    int32               serialNumber;   
    TestAbortProc       abortProc;      
    ProgressProc        progressProc;   
    int32               maxData;        
    int32               minDataBytes;   
    int32               maxDataBytes;   
    int32               minRsrcBytes;   
    int32               maxRsrcBytes;   
    intptr_t            dataFork;       
    intptr_t            rsrcFork;       
#if __LP64__
    FSSpec *            unusedFileSpec; 
#else
    FSSpec *            fileSpec;       
#endif

    int16               imageMode;      
    Point               imageSize;      
    int16               depth;          
    int16               planes;         
    Fixed               imageHRes;      
    Fixed               imageVRes;      
    LookUpTable         redLUT;         
    LookUpTable         greenLUT;       
    LookUpTable         blueLUT;        
    void *              data;           
    Rect                theRect;        
    int16               loPlane;        
    int16               hiPlane;        
    int16               colBytes;       
    int32               rowBytes;       
    int32               planeBytes;     
    PlaneMap            planeMap;       
    Boolean             canTranspose;   
    Boolean             needTranspose;  
    OSType              hostSig;        
    HostProc            hostProc;       
    int16               hostModes;      
    Handle              revertInfo;     
    NewPIHandleProc     hostNewHdl;     
    DisposePIHandleProc hostDisposeHdl; 
    Handle              imageRsrcData;  
    int32               imageRsrcSize;  
    PlugInMonitor       monitor;        
    void *              platformData;   
    BufferProcs *       bufferProcs;    
    ResourceProcs *     resourceProcs;  
    ProcessEventProc    processEvent;   
    DisplayPixelsProc   displayPixels;  
    HandleProcs         *handleProcs;   
    // New in 3.0

    OSType              fileType;       
    ColorServicesProc   colorServices;  
    AdvanceStateProc    advanceState;   
    // New in 3.0.4

    PropertyProcs       *propertyProcs; 
    ImageServicesProcs  *imageServicesProcs;
    int16               tileWidth;      
    int16               tileHeight;     
    Point               tileOrigin;     
    // New in 4.0 

    PIDescriptorParameters  *descriptorParameters;  
    Str255                  *errorString;           
    // New in 5.0 

    int32               maxValue;       
    SPBasicSuite        *sSPBasic;      
    void                *plugInRef;     
    int32               transparentIndex;   
    Handle              iCCprofileData; 
    int32               iCCprofileSize;     
    int32               canUseICCProfiles; 
    // New in 5.5 

    int32           lutCount;           
    // New in 6.0 

    /* The following fields are only relevant when reading. */
    
    int32           preferredColorModes;
    int32           convertMode;        
    VPoint          preferredSize;      
    int32           imageIndex;         
    int32           transparencyPlane;  
    int32           transparencyMatting;
    // New in 7.0 

    ChannelPortProcs *channelPortProcs; 
    ReadImageDocumentDesc *documentInfo;
    Boolean         openForPreview;     
    // New in 8.0 

    int32           browserRotation;    
    int32       HostSupports32BitCoordinates;   
    int32       PluginUsing32BitCoordinates;    
    VPoint      imageSize32;            
    VRect       theRect32;              
    uint32      requestedFileProperty;  
    uint32      filePropertyValue;      
    uint32      fileCount;              
    Handle      xmp;                    
    int32       supportsSkipFile;       
    // New in 9.0 

    Boolean     extractQuickThumbnail;  
    Boolean     hostInSecondaryThread;  
    uint32      bulkMask;               
    uint32 *    bulkFlags;              
    uint32      presetCount;            
    Handle      presetNames;            
    Handle      presetData;             
    uint32      settingsChecksum;       
    SPPlatformFileSpecificationW *fileSpec2;    
    // New in 10.0 

    uint32          layerData;          
    uint16          *layerName;         
    void            *renderRecord;      
    Handle *        bulkParams;         
    Boolean openAsSmartObject;          
    // New in 11.0 

    PIDescriptorParameters  *layerMetaData;     
    uint16 *finalSpec;                  
    Boolean isTextLayer;                
    PIDescriptorHandle  *textDescriptor; 
    Boolean isGroupDivider;             
    Boolean isGroupStart;               
    Boolean isVisible;              
    Boolean isLocked;               
    PIType  blendMode;                  
    unsigned8 opacity;                  
    // New in 15.0

    Handle bulkExtraData;               
    // New in 17.0

    XPlatFileSpec*  fileSpecX;          
    // New in 20.0

    int16       hostSupportsPOSIXIO;    
    int16       pluginUsingPOSIXIO;     
    int32       posixFileDescriptor;    
    // New in 21.0

    Boolean      hostSupportsPluginOpeningFile;         
    Boolean      hostSupportsSingleOpenToBulkSwitch;    
    Boolean      pluginWantsSingleOpenToBulkSwitch;     



    char        reserved [50];                  

    }
FormatRecord, *FormatRecordPtr;

#if WIN32
#pragma pack(pop)
#endif

#if PRAGMA_STRUCT_ALIGN
#pragma options align=reset
#endif

#endif  // __PIFormat_h__