MrSID Decode SDK for Raster Reference Manual  9.1.0.4045
ltic_api.h
Go to the documentation of this file.
1 /* $Id$ */
2 /* //////////////////////////////////////////////////////////////////////////
3 // //
4 // This code is Copyright (c) 2004 LizardTech, Inc, 1008 Western Avenue, //
5 // Suite 200, Seattle, WA 98104. Unauthorized use or distribution //
6 // prohibited. Access to and use of this code is permitted only under //
7 // license from LizardTech, Inc. Portions of the code are protected by //
8 // US and foreign patents and other filings. All Rights Reserved. //
9 // //
11 /* PUBLIC - C */
12 
13 #ifndef LTI_CAPI_H
14 #define LTI_CAPI_H
15 
16 #include "lti_types.h"
17 #include "lti_metadataTypes.h"
18 #include "lt_ioCStream.h"
19 
20 #ifdef LT_CPLUSPLUS
21 extern "C" {
22 #endif
23 
24 #if defined(LT_COMPILER_MS)
25  #pragma warning(push,4)
26 #endif
27 
28 
41 #define LT_STS_CAPI_BASE ((LT_STATUS)52000)
42 #define LT_STS_CAPI_BadParam ((LT_STATUS)52001)
43 #define LT_STS_CAPI_MAX ((LT_STATUS)52099)
44 
50 typedef void* LTICImageH;
51 
52 
69  lt_uint32* minor,
70  lt_uint32* revision,
71  lt_uint32* build,
72  const char** branch);
73 
87 LT_STATUS ltic_getMrSIDGeneration(const char *fileName,
88  int *generation,
89  int *raster);
90 
105 LT_STATUS ltic_openMrSIDImageFile(LTICImageH* image,
106  const char* fileName);
107 
122 LT_STATUS ltic_openMrSIDImageStream(LTICImageH* image,
123  LTIOStreamH stream);
124 
139 LT_STATUS ltic_openJP2ImageFile(LTICImageH* image,
140  const char* fileName);
141 
156 LT_STATUS ltic_openJP2ImageStream(LTICImageH* image,
157  LTIOStreamH stream);
158 
173 LT_STATUS ltic_openNITFImageFile(LTICImageH* image,
174  const char* fileName);
175 
187 LT_STATUS ltic_closeImage(LTICImageH image);
188 
200 lt_uint32 ltic_getWidth(const LTICImageH image);
201 
213 lt_uint32 ltic_getHeight(const LTICImageH image);
214 
224 LT_STATUS ltic_getDimsAtMag(LTICImageH image,
225  double magnification,
226  lt_uint32 *width,
227  lt_uint32 *height);
228 
240 LTIColorSpace ltic_getColorSpace(const LTICImageH image);
241 
253 lt_uint16 ltic_getNumBands(const LTICImageH image);
254 
266 LTIDataType ltic_getDataType(const LTICImageH image);
267 
279 double ltic_getMinMagnification(const LTICImageH image);
280 
292 double ltic_getMaxMagnification(const LTICImageH image);
293 
307 lt_uint8 ltic_isMrSIDLocked(const LTICImageH image);
308 
322 LT_STATUS ltic_setMrSIDPassword(LTICImageH image, const lt_utf8* passwd);
323 
335 double ltic_getGeoXOrigin(const LTICImageH image);
336 
348 double ltic_getGeoYOrigin(const LTICImageH image);
349 
361 double ltic_getGeoXResolution(const LTICImageH image);
362 
374 double ltic_getGeoYResolution(const LTICImageH image);
375 
387 double ltic_getGeoXRotation(const LTICImageH image);
388 
400 double ltic_getGeoYRotation(const LTICImageH image);
401 
422 LT_STATUS ltic_decode(LTICImageH image,
423  double xUpperLeft,
424  double yUpperLeft,
425  double width,
426  double height,
427  double magnification,
428  void** buffers);
429 
443 lt_uint32 ltic_getNumMetadataRecords(LTICImageH image);
444 
463 LT_STATUS ltic_getMetadataRecord(LTICImageH image,
464  lt_uint32 recordNum,
465  const char** tag,
466  LTIMetadataDataType* datatype,
467  lt_uint32* numDims,
468  const lt_uint32** dims,
469  const void** data);
470 
471 #ifdef LT_CPLUSPLUS
472 }
473 #endif
474 
475 #if defined(LT_COMPILER_MS)
476  #pragma warning(pop)
477 #endif
478 
479 #endif
LTIDataType ltic_getDataType(const LTICImageH image)
get image datatype (C API)
void * LTIOStreamH
opaque pointer to an LTIOStreamInf
LTIMetadataDataType
datatypes used in database records
LT_STATUS ltic_getMrSIDGeneration(const char *fileName, int *generation, int *raster)
get MrSID generation (C API)
LT_STATUS ltic_openMrSIDImageFile(LTICImageH *image, const char *fileName)
open MrSID image via filename (C API)
unsigned int lt_uint32
unsigned 32-bit integer
Definition: lt_types.h:54
unsigned char lt_uint8
unsigned 8-bit integer
Definition: lt_types.h:46
This file contains a number of enums, typedefs, etc, that are used throughout the MrSID SDK...
lt_uint32 ltic_getWidth(const LTICImageH image)
get image width (C API)
LT_STATUS ltic_closeImage(LTICImageH image)
close an image (C API)
double ltic_getMinMagnification(const LTICImageH image)
get image minimum magnifaction (C API)
double ltic_getGeoYResolution(const LTICImageH image)
get geo Y resolution of image (C API)
lt_uint32 ltic_getNumMetadataRecords(LTICImageH image)
get number of metadata records (C API)
void * LTICImageH
opaque pointer (handle) to an LTIImage
Definition: ltic_api.h:50
LT_STATUS ltic_openNITFImageFile(LTICImageH *image, const char *fileName)
open NITF image via filename (C API)
LT_STATUS ltic_openJP2ImageFile(LTICImageH *image, const char *fileName)
open JPEG 2000 image via filename (C API)
LT_STATUS ltic_getMetadataRecord(LTICImageH image, lt_uint32 recordNum, const char **tag, LTIMetadataDataType *datatype, lt_uint32 *numDims, const lt_uint32 **dims, const void **data)
get a metadata record from an image (C API)
LT_STATUS ltic_decode(LTICImageH image, double xUpperLeft, double yUpperLeft, double width, double height, double magnification, void **buffers)
decode a scene from the image (C API)
double ltic_getGeoYOrigin(const LTICImageH image)
get geo Y position of image (C API)
double ltic_getGeoYRotation(const LTICImageH image)
get geo Y rotation term of image (C API)
lt_uint32 LT_STATUS
An integral status code.
Definition: lt_status.h:39
double ltic_getMaxMagnification(const LTICImageH image)
get image maximum magnifacation (C API)
double ltic_getGeoXOrigin(const LTICImageH image)
get geo X position of image (C API)
unsigned short lt_uint16
unsigned 16-bit integer
Definition: lt_types.h:50
lt_uint8 lt_utf8
(DEPRECATED)
Definition: lt_types.h:146
double ltic_getGeoXRotation(const LTICImageH image)
get geo X rotation term of image (C API)
LT_STATUS ltic_getDimsAtMag(LTICImageH image, double magnification, lt_uint32 *width, lt_uint32 *height)
get dimensions of an image at a given magnification (C API)
lt_uint8 ltic_isMrSIDLocked(const LTICImageH image)
query if MrSID image is locked (C API)
double ltic_getGeoXResolution(const LTICImageH image)
get geo X resolution of image (C API)
LT_STATUS ltic_setMrSIDPassword(LTICImageH image, const lt_utf8 *passwd)
set password for decoding MrSID image (C API)
LTIColorSpace ltic_getColorSpace(const LTICImageH image)
get image colorspace (C API)
lt_uint16 ltic_getNumBands(const LTICImageH image)
get number of bands in trhe image (C API)
LT_STATUS ltic_getVersion(lt_uint32 *major, lt_uint32 *minor, lt_uint32 *revision, lt_uint32 *build, const char **branch)
get SDK version (C API)
lt_uint32 ltic_getHeight(const LTICImageH image)
get image height (C API)
LTIColorSpace
colorspaces
Definition: lti_types.h:38
LTIDataType
datatypes
Definition: lti_types.h:105
LT_STATUS ltic_openJP2ImageStream(LTICImageH *image, LTIOStreamH stream)
open JPEG 2000 image via stream (C API)
LT_STATUS ltic_openMrSIDImageStream(LTICImageH *image, LTIOStreamH stream)
open MrSID image via stream (C API)

LizardTech