MrSID Decode SDK for Raster Reference Manual  9.5.5.5244
lti_imageStage.h
Go to the documentation of this file.
1 //
2 // This code is property of Celartem, Inc dba Extensis.
3 // Copyright (c) 1995-2023. All rights reserved.
4 // Use permitted only under license from Extensis.
5 //
6 /* PUBLIC */
7 
8 #ifndef LTI_IMAGESTAGE_H
9 #define LTI_IMAGESTAGE_H
10 
11 // lt_lib_mrsid_core
12 #include "lti_image.h"
13 
14 LT_BEGIN_LIZARDTECH_NAMESPACE
15 
23 class LTIImageStage : public LTIImage
24 {
26 public:
41  virtual void setProgressDelegate(LTIProgressDelegate* delegate) = 0;
42 
57 
72  virtual void setInterruptDelegate(LTIInterruptDelegate* delegate) = 0;
73 
88 
106  LT_STATUS read(const LTIScene& scene,
107  LTISceneBuffer& buffer);
108 
121  virtual LT_STATUS readBegin(const LTIPixel &pixelProps,
122  const LTIScene &fullScene);
123 
144  const LTIScene &stripScene);
145 
156  virtual LT_STATUS readEnd();
157 
169  virtual lt_uint32 getStripHeight() const = 0;
170 
183  virtual LT_STATUS setStripHeight(lt_uint32 stripHeight) = 0;
184 
196  virtual lt_int64 getEncodingCost(const LTIScene& scene) const = 0;
197 
209  virtual bool getReaderScene(const LTIScene &decodeScene,
210  LTIScene &readerScene) const = 0;
211 
221 
232  LTIScene getStripScene(lt_uint32 stripNumber) const;
233 
242  virtual LT_STATUS overrideBackgroundPixel(const LTIPixel *backgroundPixel) = 0;
243 
253  virtual LT_STATUS overrideNoDataPixel(const LTIPixel *nodataPixel) = 0;
254 
263  virtual LT_STATUS overrideGeoCoord(const LTIGeoCoord &geoCoord) = 0;
264 
269  const LTIPixel& drmax) = 0;
270 
275 
279  virtual LT_STATUS overridePixelLookupTable(const LTIPixelLookupTable* pixelLookupTable) = 0;
280 
284  virtual LT_STATUS overrideMetadata(const LTIMetadataDatabase &metadata) = 0;
285 
289  virtual LT_STATUS overrideColorSpace(LTIColorSpace colorspace) = 0;
290 
291  // for LizardTech internal use only
292  virtual LTIMaskSource *getMask() const = 0;
293  virtual bool getPipelineInfo(LTIPipelineInfo info) const = 0;
294  virtual LTIImageStage *getPreviousStage() const = 0;
295 protected:
308  LTISceneBuffer& buffer);
309 
321  LTISceneBuffer &buffer,
322  const LTIPixel &color);
323 
324  bool isBandSelected(const LTIPixel &pixelProps) const;
339  virtual LT_STATUS decodeBegin(const LTIPixel &pixelProps,
340  const LTIScene &fullScene) = 0;
341 
356  virtual LT_STATUS decodeStrip(LTISceneBuffer &stripBuffer,
357  const LTIScene &stripScene) = 0;
358 
371  virtual LT_STATUS decodeEnd(void) = 0;
372 
381  const LTIScene &getFullScene() const;
382 
383 private:
387  LT_STATUS validateReadRequest(const LTIPixel &pixelProps,
388  const LTIScene &scene) const;
389  LT_STATUS validateReadRequest(const LTISceneBuffer &buffer,
390  const LTIScene &scene) const;
391 
392  LT_STATUS checkDelegates(const LTIScene*, bool);
393 
394  struct StripMarcher;
395  StripMarcher* m_stripMarcher;
396 };
397 
398 LT_END_LIZARDTECH_NAMESPACE
399 
400 #endif // LTI_IMAGESTAGE_H
lt_uint32 LT_STATUS
An integral status code.
Definition: lt_status.h:30
unsigned char lt_uint8
unsigned 8-bit integer
Definition: lt_types.h:36
unsigned int lt_uint32
unsigned 32-bit integer
Definition: lt_types.h:44
long long int lt_int64
signed 64-bit integer
Definition: lt_types.h:57
#define LTI_REFERENCE_COUNTED_BOILERPLATE_BASE(classname)
Macros for defining boilerplate parts of derived LTIReferenceCountedObject classes.
LTIColorSpace
colorspaces
Definition: lti_types.h:34
LTIPipelineInfo
Definition: lti_types.h:224
interrupt delegate (callback) base class
Definition: lti_delegates.h:35
progress delegate (callback) base class
Definition: lti_delegates.h:68
represents a geographic coordinate
Definition: lti_geoCoord.h:28
abstract class representing an image
Definition: lti_image.h:28
abstract class for decoding from an image
virtual bool getReaderScene(const LTIScene &decodeScene, LTIScene &readerScene) const =0
get the underlying scene to be used
virtual LT_STATUS overrideBackgroundPixel(const LTIPixel *backgroundPixel)=0
override the background color of the image
virtual LT_STATUS overrideMetadata(const LTIMetadataDatabase &metadata)=0
override the metadata of the image
virtual LTIMaskSource * getMask() const =0
virtual LT_STATUS readEnd()
finish strip-based read
virtual lt_uint32 getStripHeight() const =0
get strip height
virtual LT_STATUS setStripHeight(lt_uint32 stripHeight)=0
set the strip height
virtual LT_STATUS decodeBegin(const LTIPixel &pixelProps, const LTIScene &fullScene)=0
start strip-based read
virtual LTIInterruptDelegate * getInterruptDelegate() const =0
get interrupt delegate
virtual LT_STATUS overrideGeoCoord(const LTIGeoCoord &geoCoord)=0
override the geographic coordinates of the image
virtual LTIProgressDelegate * getProgressDelegate() const =0
get progress delegate
virtual LT_STATUS overridePixelBPS(lt_uint8)=0
override the bits-per-sample of the image's (sample's) datatype
const LTIScene & getFullScene() const
get full scene
virtual void setInterruptDelegate(LTIInterruptDelegate *delegate)=0
set interrupt delegate
LTIScene getStripScene(lt_uint32 stripNumber) const
get a strip for current scene
virtual bool getPipelineInfo(LTIPipelineInfo info) const =0
virtual LTIImageStage * getPreviousStage() const =0
lt_uint32 getNumStrips() const
get number of strips in scene
virtual LT_STATUS readBegin(const LTIPixel &pixelProps, const LTIScene &fullScene)
start strip-based read
virtual LT_STATUS decodeStrip(LTISceneBuffer &stripBuffer, const LTIScene &stripScene)=0
read a strip from the image
virtual lt_int64 getEncodingCost(const LTIScene &scene) const =0
get the cost to encode this scene
bool isBandSelected(const LTIPixel &pixelProps) const
virtual LT_STATUS overrideColorSpace(LTIColorSpace colorspace)=0
override the colorspace of all the pixel properties (PixelProps, NoData, Background,...
virtual LT_STATUS overridePixelLookupTable(const LTIPixelLookupTable *pixelLookupTable)=0
override the CLUT of the image
LT_STATUS fillBackground(const LTIScene &scene, LTISceneBuffer &buffer)
fill the background of the scene
virtual void setProgressDelegate(LTIProgressDelegate *delegate)=0
set progress delegate
virtual LT_STATUS decodeEnd(void)=0
finish strip-based read
LT_STATUS fillBackground(const LTIScene &scene, LTISceneBuffer &buffer, const LTIPixel &color)
fill the scene to given pixel
virtual LT_STATUS readStrip(LTISceneBuffer &buffer, const LTIScene &stripScene)
read a strip from the image
virtual LT_STATUS overrideDynamicRange(const LTIPixel &drmin, const LTIPixel &drmax)=0
override the dynamic range of the image
LT_STATUS read(const LTIScene &scene, LTISceneBuffer &buffer)
read (decode) a scene from the image
virtual LT_STATUS overrideNoDataPixel(const LTIPixel *nodataPixel)=0
override the "no data" (transparency) color of the image
class for storing metadata associated with an image
basic properties of a pixel
Definition: lti_pixel.h:32
color lookup table
representation of a scene
Definition: lti_scene.h:60
class to hold data passed between image stages

Extensis