`KcsXform` Class

8

This chapter describes the KCMS framework KcsXform class. This base class provides an interface for component transformations of different transformation types; for example, matrix and grid-table based.

As you read this chapter, you will find it helpful to have access to the following header files:

kcsxform.h
kcschunk.h and kcsload.h
kcsattr.h and icc.h

The header file for the class is kcsxform.h. The constant and #define identifiers for this class are defined in the kcsxform.h header file as:

const KcsId KcsLoadXfrmId = {(0x5866726dUL)}; /* 'Xfrm' */
#define KcsLoadXfrmIdd (0x5866726dUL) /* 'Xfrm' */

In addition to the KcsLoadable methods overridden by this class, there are methods for component transformations of different transformation types. The public members are described, as well as the member function override rules when deriving from this class.

Enumerations

The KcsXform class has the following enumerations.

Table 8-1

Enumeration	Description
`enum KcsInOut {In, Out};`	Enumeration used in `getNumComponents()` , `getComponentDepth()`, `setNumComponents()` and `setComponentDepth()`.

Public Members

The KcsXform class has the following public members.

Table 8-2 KcsXform

Public Member	Description
`int` `areLayoutsCloseEnough(KcsPixelLayout in1, KcsPixelLayout in2, KcsPixelLayout *out);`	Returns non zero if the nth pixel in `in1` and `in2` uses the pixel in `out` without corrupting the (n+1)th pixel of `out`, (for example, `planar<->chunky` fails while `chunky<->chunky` does not), else returns zero.
`int` `areLayoutsEqual(KcsPixelLayout l1, KcsPixelLayout l2);`	Returns non zero if the pixel layout structs in `l1` and `l2` are identical (especially the pointers to the data buffers), else returns zero.
`virtual KcsStatus` `compose(KcsXformSeq xformSeq,` `KcsXform *newXform,` `KcsCallbackFunction progress);`	Generates a new Xform from `xformSeq` supplied. Connects `numXforms` transforms supplied in a `KcsXformSeq` and returns a `KcsXform` in `newXform` that has the same effect as the list of Xforms in the order supplied. An error in connecting from techs[n] to techs[n+1] is reflected in errors[n]. A `NULL` `KcsXform` is returned on error.
`virtual KcsStatus` `connect(const KcsOperationType opsAndHints, const long numXforms, KcsXform technologies, KcsXform newXform, KcsCallbackFunction progress, long *numberThatFailed);`	Connects `numXforms` transforms supplied in technologies and returns a `KcsXform` that has the same effect as the list of Xforms in the order supplied. If an error is found, they are reported. An error in connecting from techs[n] to techs[n+1] is reflected in errors[n]. A `NULL KcsXform` is returned on error.

Table 8-2 KcsXform(Continued)

Public Member	Description
`virtual KcsStatus` `connectSink(KcsPixelLayout *sinkLayout);`	Associates `sinkLayout` as the default layout buffer for output from this transform.
`virtual KcsStatus` `connectSource(KcsPixelLayout` `*sourceLayout);`	Associates `sourceLayout` as the default layout buffer for input to this transform.
`virtual KcsXform` `convertXform(KcsStatus aStat,` `KcsId aXformType);`	Converts the instance into a derivative of type `aXformType` and returns a pointer to the new transform. Does automatic xform conversion when needed.
`static KcsXform ` `createXform(KcsStatus status,` `KcsChunkSet aChunkSet,` `KcsChunkId chunkId,` `KcsAttributeSet aAttrSet=NULL);`	Creates a `KcsXform` from a chunk set.
`KcsStatus eval();`	Evaluates the data described in the local `inBuffer` set by `connectSource()`, through this transform into the buffer described by the `outBuffer` set by `connectSink()`. The operation is from `myOptType`. This provides no progress.
`KcsStatus` `eval(const KcsOperationType opsAndHints, long in32, long out32);`	Evaluates the data described in one 32-bit integer.
`KcsStatus` `eval(const KcsOperationType opsAndHints,` `KcsPixelLayout inBuffer,` `KcsPixelLayout outBuffer,` `KcsCallbackFunction progress) = 0;`	Evaluates the data described in `inBuffer` through the Xform described by this instance into the buffer described by `outBuffer`.
`KcsStatus` `eval(const KcsOperationType opsAndHints, const float inComp, const float outComp, const long inStride, const long outStride, const long num, KcsCallbackFunction progress);`	Evaluates the data described in the float-based buffer supplied through this transform into the float-based buffer supplied.

Table 8-2 KcsXform(Continued)

Public Member	Description
`KcsStatus` `eval(const KcsOperationType opsAndHints, const unsigned char inComp, const unsigned char outComp, const long inStride, const long outStride, const long num, KcsCallbackFunction progress);`	Evaluates the data described in the byte-based buffer supplied through this transform into the byte-based buffer supplied.
`virtual KcsAttributeSet` `getAttrSet(KcsStatus aStat = NULL);`	Returns the set of attributes associated with this `KcsXform` instance. If `NULL`, creates an empty one.
`virtual KcsStatus` `getLoadOrder(long aNumTypes, KcsLoadSaveSet aAvailableTypes, KcsLoadSaveSet *aOrderOfTypes);`	Returns the order to load the types in an array `aOrderOfTypes[aNumTypes]`.
`KcsOperationType getOpsAndHints();`	Retrieves the ops and hints.
`virtual long` `getComponentDepth(KcsInOut whichOne);`	Retrieves the component depth.
`virtual long` `getNumComponents(KcsInOut whichOne);`	Retrieves the number of components.
`virtual KcsStatus` `getSaveOrder(long aNumTypes, KcsLoadSaveSet aAvailableTypes, KcsLoadSaveSet *aOrderOfTypes);`	Returns the order to save the types in an array `aOrderOfTypes[aNumTypes]`.
`static KcsId` `getXformType(KcsChunkSet aChunkSet, KcsChunkId chunkId, KcsStatus stat, int InComp, int OutComp);`	Gets the Xform type.
`typedef long KcsLoadSaveSet;`	Used in `getLoadOrder()` and `getSaveOrder()`.
`typedef unsigned long KcsTransformKind;`	Used in `kindOfTransform()`;
`KcsXform(KcsStatus status,` `KcsAttributeSet aAttrSet=NULL);`	Constructor.
`KcsXform(KcsStatus status,` `KcsOperationType opsAndHints,` `KcsChunkSet aChunkSet,` `KcsChunkId chunkId,` `KcsAttributeSet *aAttrSet=NULL);`	Constructor.

Table 8-2 KcsXform(Continued)

Public Member	Description
`virtual ~KcsXform();`	Destructor.
`virtual KcsTransformKind kindOfTransform();`	Retrieves the kind of transform.
`virtual KcsStatus` `loadU(KcsMemoryBlock *aXform,` `KcsCallbackFunction aCallback = NULL);`	Loads the Xform from the universal buffer supplied.
`virtual int` `numberOfCallbacks(KcsPixelLayout aIn, KcsPixelLayout aOut);`	If the Xform evaluated data with the supplied pixel layouts and a callback was supplied, tells how many times would it be called. The default is for every four scan lines of `aIn`.
`KcsStatus optimize();`	Optimizes the Xform.
`virtual KcsStatus` `optimize(const KcsOperationType opsAndHints,` `const KcsOptimizationType optimization,` `KcsCallbackFunction progress);`	Optimizes the Xform.
`virtual KcsStatus` `saveU(KcsMemoryBlock *aXform,` `KcsCallbackFunction aCallback=NULL);`	Saves the Xform into the universal buffer supplied.
`virtual KcsStatus` `setCallbackInterval(int callbackInt);`	Sets the callback interval.
`virtual KcsStatus` `setComponentDepth(KcsInOut whichOne, long Depth = 8);`	Sets the component depth.
`virtual KcsStatus` `setAttrSet(KcsAttributeSet *aAttrSet);`	Sets the set of attributes associated with this `KcsXform` instance.
`virtual KcsStatus` `setDefaultAttributes(void);`	Sets up the default set of attributes for Xforms.
`virtual KcsStatus` `setNumComponents(KcsInOut whichOne, long numComp = 3);`	Sets the number of components.
`void setOpsAndHints(KcsOperationType);`	Sets the ops and hints.
`KcsStatus` `validateLayouts(` `KcsPixelLayout sourceLayout, KcsPixelLayout sinkLayout);`	Makes sure the source layout and sink layout are compatible with each other and with transform. The color space of the buffer is validated once that field is added to the `KcsPixelLayout` struct.

External Loadable Interface

Use these KcsXform external entry points to load your derivatives at runtime. See the DDK manual KCMS CMM Developer's Guide for more information on creating a KcsXform derivative as a runtime loadable CMM.

Table 8-3 KcsXform

Extern "C"	Description
`extern long KcsDLOpenXfrmCount;`	Holds a counter for the number of times this dynamically loadable module has been loaded.
`KcsStatus KcsInitXfrm(long libMajor, long libMinor, long myMajor, long myMinor);`	Returns `KCS_SUCCESS`.
`KcsXfrm` `* KcsCreateXfrm(KcsStatus aStat,` `KcsChunkSet aChunkSet,` `KcsChunkId aChunkId,` `KcsAttributeSet *aAttrSet);`	Returns a `KcsXform` object by invoking the `KcsXform` constructor.
`KcsStatus KcsCleanupXfrm();`	Returns `KCS_SUCCESS`.

Member Function Override Rules

The following table tells you which KcsXform member functions you must override, can override, and should not override when deriving from this class. The member functions indicated with an "X" in the Must column are requiredto successfully derive from this base class.

Table 8-4 KcsXform

Member Function	Must	Override Rules Can Do Not
`compose()`		X
`connect()`		X
`connectSink()`		X
`connectSource()`		X
`convertXform()`		X

Table 8-4 KcsXform(Continued)

Member Function	Must	Override Rules Can Do Not
`eval()`	X
`getAttrSet()`		X
`getComponentDepth()`			X
`getLoadOrder()`		X
`getNumComponents()`			X
`getSaveOrder()`		X
`KcsXform()`	X
`~KcsXform()`		X
`kindOfTransform()`			X
`loadU()`		X
`numberOfCallbacks()`		X
`optimize()`		X
`saveU()`		X
`setAttrSet()`		X
`setCallbackInterval()`		X
`setComponentDepth()`		X
`setDefaultAttributes()`		X
`setNumComponents()`		X
`validateLayouts()`		X

包含在

尋找其他文件

熱門支援資源

KcsXform Class

8

Enumerations

Public Members

External Loadable Interface

Member Function Override Rules

`KcsXform` Class