#include <edl/idomimageresource.h>

Inheritance diagram for IDOMTIFFImage:

Classes
class	Data
	Initialization data. More...

Public Types
enum	eTIFFCompression { eTCAuto , eTCNone , eTCCCITT , eTCCCITT3 , eTCCCITT4 , eTCPackBits , eTCLZW }
	Available TIFF compression schemes. More...
enum	eTIFFPrediction { eTPNone , eTPHorizontal }
	Available TIFF prediction schemes. More...

Public Member Functions
virtual uint16	getImageIndex () const =0
	Get the image index of this TIFF to use.
Public Member Functions inherited from IDOMImage
virtual IImageDecoderPtr	createImageDecoder (IEDLClassFactory *factory, const IDOMImagePropertiesPtr &imageProperties)=0
	Creates a properly initialized image decoder object that reads from an inputstream that is specific to that image format.
virtual IImageFramePtr	getImageFrame (IEDLClassFactory *factory)
	Fetch the image frame; convenience.
virtual IImageEncoderPtr	createImageEncoder (const ISessionPtr &session, const IOutputStreamPtr &imageDest, const IDOMImagePropertiesPtr &imageProperties)=0
	Creates a properly initialized image encoder object that writes to an outputstream that is specific to that image format.
virtual IDOMImagePropertiesPtr	getImageProperties ()=0
	Returns an object that stores the properties for this image object. The properties can then be inspected (or more added) by clients that need to manipulate the image resource.
virtual eDOMImageType	getImageType ()=0
	Retrieves the image type.
virtual bool	getIsRendered ()=0
	Determine if the image is as a result of rendering. This is indicated if the image type is eDITRendered or if the image explicitly notes this is the case (such as for IDOMPDFImage).
virtual IDOMImagePtr	getImageWithSubstitutedColorSpace (IEDLClassFactory *factory, const IDOMColorSpacePtr &colorSpace)
	Obtain an image that is the same as this image, but with the colorspace substituted for another.
Public Member Functions inherited from IDOMResource
virtual IInputStreamPtr	getStream () const =0
	Retrieves the resource stream.
virtual void	setStream (const IInputStreamPtr &stream)=0
	Sets the resource stream for the node.
virtual uint64	getStreamLength () const =0
	Retrieves the stream length, if it is available.
virtual const EDLSysString &	getUri () const =0
	Retrieves the resource URI.
virtual void	setUri (const EDLSysString &uri)=0
	Sets the resource URI.
Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject.
virtual bool	init (CClassParams *pData)
	The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory.
virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Create a copy of EDLObject.
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.
Public Member Functions inherited from IDOMHashable
virtual	~IDOMHashable ()
	Virtual destructor.
virtual bool	hash (uint64 &hash)=0
	Retrieve a hash for this object.
virtual uint64	hashE ()
	As hash(), but throws an exception if the operation fails.

Static Public Member Functions
static EDL_API IDOMTIFFImagePtr	create (IEDLClassFactory *pFactory, const IInputStreamPtr &stream, uint16 imageIndex=0, bool allowMultiChannel=false)
	Create a TIFF Image resource with the given TIFF stream.
static EDL_API IDOMImagePtr	createWriterAndImage (const ISessionPtr &session, IImageFrameWriterPtr &frame, const IDOMColorSpacePtr &colorSpace, uint32 width, uint32 height, uint8 bitsPerComponent=8, double xResolution=96.0, double yResolution=96.0, eTIFFCompression compresssionType=eTCAuto, eTIFFPrediction predictionType=eTPNone, eImageExtraChannelType extraChannel=eIECNone, bool bigTiff=false, const IInputStreamPtr &inStream=IInputStreamPtr(), const IOutputStreamPtr &outStream=IOutputStreamPtr())
	Create an IDOMTIFFImage and frame that can be used to populate same.
static EDL_API void	encode (const ISessionPtr &pSession, const IDOMImagePtr &image, const IOutputStreamPtr &stream, eTIFFCompression scheme=eTCAuto, eTIFFPrediction predictionType=eTPNone, bool bigTiff=false)
	Encode an image as a TIFF stream, returning the stream. This routine may convert the image samples into a form that may be encoded as TIFF if required, such as by converting to a supported color space.
static EDL_API void	encode (const ISessionPtr &pSession, const IImageFramePtr &frame, const IOutputStreamPtr &stream, eTIFFCompression scheme=eTCAuto, eTIFFPrediction predictionType=eTPNone, bool bigTiff=false)
	Encode the contents of an IImageFrame as a TIFF stream, returning the stream. This routine may convert the image samples into a form that may be encoded as TIFF if required, such as by converting to a supported color space.
static const CClassID &	classID ()
	Retrieves class id of IDOMTIFFImage.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

IDOMTIFFImage interface.

Member Enumeration Documentation

◆ eTIFFCompression

enum IDOMTIFFImage::eTIFFCompression

Available TIFF compression schemes.

Enumerator
eTCAuto
eTCNone	Choose an appropriate scheme for the incoming image.
eTCCCITT
eTCCCITT3
eTCCCITT4
eTCPackBits
eTCLZW

◆ eTIFFPrediction

enum IDOMTIFFImage::eTIFFPrediction

Available TIFF prediction schemes.

Enumerator
eTPNone
eTPHorizontal

Member Function Documentation

◆ classID()

const CClassID & IDOMTIFFImage::classID ( )

inlinestatic

Retrieves class id of IDOMTIFFImage.

Returns: CClassID Class id of the element.

◆ create()

EDL_API IDOMTIFFImagePtr IDOMTIFFImage::create	(	IEDLClassFactory *	pFactory,
		const IInputStreamPtr &	stream,
		uint16	imageIndex = 0,
		bool	allowMultiChannel = false )

static

Create a TIFF Image resource with the given TIFF stream.

Parameters

pFactory	The EDL Class factory to use.
stream	The stream containing the TIFF image.
imageIndex	For multi-image TIFF files, the index of the image to use, with 0 being the first image in the TIFF file.
allowMultiChannel	If true, the TIFF decoder will allow Separated (CMYK) tiff files containing extra color samples. If found, a DeviceN color space will be used. Note however that this DeviceN color space will only be useful in cases where the TIFF decoder is able to read the color channels from the TIFF tags, in which case the decoder will set the image property HasTagColorants to true. Otherwise, some external knowledge of the color channels may be required. Please contact GlobalGraphics support if you have specialised needs.

Returns: IDOMTIFFImagePtr The new image.

◆ createWriterAndImage()

EDL_API IDOMImagePtr IDOMTIFFImage::createWriterAndImage	(	const ISessionPtr &	session,
		IImageFrameWriterPtr &	frame,
		const IDOMColorSpacePtr &	colorSpace,
		uint32	width,
		uint32	height,
		uint8	bitsPerComponent = 8,
		double	xResolution = 96.0,
		double	yResolution = 96.0,
		eTIFFCompression	compresssionType = eTCAuto,
		eTIFFPrediction	predictionType = eTPNone,
		eImageExtraChannelType	extraChannel = eIECNone,
		bool	bigTiff = false,
		const IInputStreamPtr &	inStream = IInputStreamPtr(),
		const IOutputStreamPtr &	outStream = IOutputStreamPtr() )

static

Create an IDOMTIFFImage and frame that can be used to populate same.

Parameters

session	The session to use.
frame	On exit, this is populated with a frame ready to receive image data via frame->writeScanLine(). Use frame->flushData() to complete the encoding process.
colorSpace	The color space to use. Must be compatible with the TIFF format.
width	The width of the image, in pixels.
height	The height of the image, in pixels.
bitsPerComponent	The bits per component to use. Must be compatible with the TIFF format.
xResolution	The x resolution, in pixels-per-inch.
yResolution	The y resolution, in pixels-per-inch.
extraChannel	The type of extra channel, if provided. Must be either eIECAlpha or eIECNone for TIFF.
compresssionType	The type of compression to use.
predictionType	The type of prediction to use. Ignored if the predictor is not compatible with the compressor.
bigTiff	Whether or not to use the bigTIFF extensions.
inStream	Optional. The first in a pair of streams used to read and write the raw image data if an external stream is desired. If NULL, a temporary store stream will be created. If non NULL, outStream must also be provided.
outStream	Optional. The second in a pair of streams used to read and write the raw image data if an external stream is desired. If NULL, a temporary store stream will be created. If non NULL, inStream must also be provided.

Returns: IDOMImagePtr The resulting image. Not valid until the frame is flushed.

◆ encode() [1/2]

EDL_API void IDOMTIFFImage::encode	(	const ISessionPtr &	pSession,
		const IDOMImagePtr &	image,
		const IOutputStreamPtr &	stream,
		eTIFFCompression	scheme = eTCAuto,
		eTIFFPrediction	predictionType = eTPNone,
		bool	bigTiff = false )

static

Encode an image as a TIFF stream, returning the stream. This routine may convert the image samples into a form that may be encoded as TIFF if required, such as by converting to a supported color space.

Parameters

pSession	The relevant EDL session.
image	The image to be encoded.
scheme	The TIFF compression scheme to be used.
predictionType	The type of prediction to use. Ignored if the predictor is not compatible with the compressor.
bigTiff	If true, use bigtff format, allowing for very large images. Not all TIFF-consuming software will support this format.
stream	The stream to use to store the image data. For best performance, this should be a random-access stream (IRAStream).

◆ encode() [2/2]

EDL_API void IDOMTIFFImage::encode	(	const ISessionPtr &	pSession,
		const IImageFramePtr &	frame,
		const IOutputStreamPtr &	stream,
		eTIFFCompression	scheme = eTCAuto,
		eTIFFPrediction	predictionType = eTPNone,
		bool	bigTiff = false )

static

Encode the contents of an IImageFrame as a TIFF stream, returning the stream. This routine may convert the image samples into a form that may be encoded as TIFF if required, such as by converting to a supported color space.

Parameters

pSession	The relevant EDL session.
frame	The frame providing the source image data.
scheme	The TIFF compression scheme to be used.
predictionType	The type of prediction to use. Ignored if the predictor is not compatible with the compressor.
bigTiff	If true, use bigtff format, allowing for very large images. Not all TIFF-consuming software will support this format.
stream	The stream to use to store the image data. For best performance, this should be a random-access stream (IRAStream).

◆ getImageIndex()

virtual uint16 IDOMTIFFImage::getImageIndex ( ) const

pure virtual

Get the image index of this TIFF to use.

TIFF files may contain multiple images; this member returns the index (beginning at 0) of the image that will be used from the TIFF file.

Returns: uint16 The image index.

The documentation for this class was generated from the following file:

edl/idomimageresource.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ eTIFFCompression

◆ eTIFFPrediction

Member Function Documentation

◆ classID()

◆ create()

◆ createWriterAndImage()

◆ encode() [1/2]

◆ encode() [2/2]

◆ getImageIndex()