FILEINFO - Raster Imaging C API Help

FILEINFO

typedef struct _FILEINFO 
{ 
   L_UINT uStructSize;           // use sizeof(FILEINFO) 
   L_INT Format;                 // File format: FILE_PCX, ... 
   L_TCHAR Name[_MAX_FNAME+_MAX_EXT];// File name, including the Extension 
   L_INT Width;                  // Image width 
   L_INT Height;                 // Image height 
   L_INT BitsPerPixel;           // Bits per pixel 
   L_SSIZE_T SizeDisk;           // Size of file on disk 
   L_SSIZE_T SizeMem;           // Size of image in memory 
   L_TCHAR Compression[20];      // Compression method name 
   L_INT ViewPerspective;        // Image view perspective 
   L_INT Order;                  // RGB order 
   L_INT PageNumber;             // Page number 
   L_INT TotalPages;             // Total number of pages present in the file 
   L_INT XResolution;           // Resolution along the X axis, in dpi. 
   L_INT YResolution;           // Resolution along the Y axis, in dpi. 
   L_UINT Flags;                // Identifies file subtypes: progressive, interlaced 
   L_UINT GlobalLoop;           // Global animation loop count 0 = infinity 
   L_INT GlobalWidth;           // Global width, in pixels 
   L_INT GlobalHeight;           // Global height, in pixels 
   L_COLORREF GlobalBackground;  // Global background color (see Flags) 
   L_RGBQUAD GlobalPalette[256]; // Global palette (see Flags) 
   L_SIZE_T IFD;                 // IFD offset (for TIF files only) 
   L_INT Layers;                // The number of layers in the file 
   L_INT ColorSpace;            // The colorspace (RGB, CMYK, CIELAB, etc) 
   L_INT Channels;               // The number of channels in the file 
   L_BOOL bIsDocFile;           // Specifies whether the file is a DOC file 
   L_DOUBLE dDocPageWidth;       // (Only valid for DOC files), the width in uDocUnit 
   L_DOUBLE dDocPageHeight;      // (Only valid for DOC files), the height in uDocUnit 
   RASTERIZEDOC_UNIT uDocUnit;   // (Only valid for DOC files), the unit of measure to be used for the width and height 
   L_BOOL bIsVectorFile;         // Value that indicates whether the file is a vector file 
   VECTORPARALLELOGRAM VectorParallelogram;     // Bounding parallelogram for the vector 
   L_INT MessageCount; // Total number of messages (for PST files only) 
   L_INT nHorzTiles; // Number of horizontal tiles. 
   L_INT nVertTiles; // Number of vertical tiles. 
   L_VOID *pFilterData; 
   L_SIZE_T uFilterDataSize; 
   L_INT nFilter; 
} FILEINFO, *pFILEINFO; 

The FILEINFO structure, which is loaded by calling the L_FileInfo function, provides information about the specified file.

Note: You should never pass an uninitialized FILEINFO structure to L_FileInfo.

Note: The LTFIL.H header file describes the entire FILEINFO structure.

Member Data Type Description
uStructSize L_UINT Size of this structure, in bytes (for versioning). Use the sizeof() operator to calculate this value.
Format L_INT File format. For possible values, refer to Summary of All Supported Image File Formats.
Name[_MAX_FNAME+_MAX_EXT] L_TCHAR A character array containing the null-terminated string that is the filename. The name is truncated if it exceeds _MAX_FNAME + _MAX_EXT characters.
Width L_INT Image width, in pixels.
Height L_INT Image height, in pixels.
BitsPerPixel L_INT Bits per pixel.
SizeDisk L_SSIZE_T Size of the file on disk (in bytes).
SizeMem L_SSIZE_T Amount of memory (in bytes) required to load the file.
Compression[20] L_TCHAR A 20-character array containing the null-terminated string that describes the compression method.
ViewPerspective L_INT Where the beginning of the image is stored. The following values are valid:

TOP_LEFT
BOTTOM_LEFT
TOP_RIGHT
BOTTOM_RIGHT
TOP_LEFT90
TOP_LEFT270.

For descriptions, refer to Accounting for View Perspective.

Order L_INT Color order of the bitmap. This field is meaningful if the image does not have a palette. It indicates whether the color values are in red-green-blue or blue-green-red order. The following values are valid: 

ORDER_RGB
ORDER_BGR
ORDER_GRAY

PageNumber L_INT The page number in a multi-page file.

To determine the total number of pages in a file, call L_FileInfo with uFlags set to FILEINFO_TOTALPAGES.

TotalPages L_INT The total number of pages present in a file.

To update this field, call L_FileInfo with uFlags set to FILEINFO_TOTALPAGES.

If you do not want this field updated, call L_FileInfo with uFlags set to 0.

XResolution L_INT Horizontal resolution, in dots per inch. Some file formats save this value in the file header.
YResolution L_INT Vertical resolution, in dots per inch. Some file formats save this value in the file header.
Flags L_UINT File characteristics. For possible values, refer to FILEINFO Flags.
GlobalLoop L_UINT Global animation loop count. 0 = infinity. This field is valid only if the FILEINFO_HAS_GLOBALLOOP flag is set.
GlobalWidth L_INT Global width for animation playback
GlobalHeight L_INT Global height for animation playback
GlobalBackground L_COLORREF Global background color for animation playback (FILEINFO Flags)
GlobalPalette[256] L_RGBQUAD Global palette for animation playback (FILEINFO Flags).
IFD L_SIZE_T Offset within a TIFF file where a page starts. This member is updated when L_FileInfo is called.
Layers L_INT The number of layers the PSD file contains (only PSD files can have layers). Layers is 0 if the file is not a PSD file, or if the file is a PSD file but does not have any layers.
ColorSpace L_INT Color space of the file. The possible values are:
    Value Meaning
    COLORSPACE_BGR [0] RGB or BGR
    COLORSPACE_YUV [1] YUV or YCbCr
    COLORSPACE_CMYK [2] CMYK
    COLORSPACE_CIELAB [3] CIELab
Channels L_INT The number of channels the PSD file contains (only PSD files can have channels).  If this value is 0, then the file does not contain channels. 
bIsDocFile L_BOOL TRUE if the image file or stream is a document format, FALSE otherwise.

When the value of this member is TRUE, then the image file or stream passed to the L_FileInfo is a document file such as PDF or XPS and dDocPageWidth, dDocPageHeight and uDocUnit will contain the original document logical size. The physical load (rasterization size) is calculated based on the current rasterization values and is stored in Width, Height, XResolution and YResolution.

When the value of this member is FALSE, then the image file or stream is a raster image such as JPEG or TIFF. These files have physical size so dDocPageWidth, dDocPageHeight and uDocUnit should not be used.

dDocPageWidth L_DOUBLE The logical width of the document. This value is in uDocUnit.

The logical width and height of the document is the original size before rasterization. LEADTOOLS usually returns the logical size in inches.

Use dDocPageWidth only if the value of bIsDocFile is TRUE.

dDocPageHeight L_DOUBLE The logical height of the document. This value is in uDocUnit.

The logical width and height of the document is the original size before rasterization. LEADTOOLS usually returns the logical size in inches.

Use  dDocPageHeight only if the value of bIsDocFile is TRUE.

uDocUnit RASTERIZEDOC_UNIT The unit for dDocPageWidth and dDocPageHeight. Valid values are as follows:
    Value Meaning
    RASTERIZEDOC_UNIT_PIXEL [0] Page width and height measurements are in pixels.
    RASTERIZEDOC_UNIT_INCH [1] Page width and height measurements are in inches.
    RASTERIZEDOC_UNIT_MILLIMETER [2] Page width and height measurements are in millimeters.
bIsVectorFile L_BOOL TRUE if the image file or stream is a vector format, FALSE otherwise.
VectorParallelogram VECTORPARALLELOGRAM Parallelogram structure that contains the bounding parallelogram for the vector. Only valid when loading vector files and the value of bIsVectorFile is TRUE.

When loading vector files such as DXF and DWG, the parallelogram values retrieved by L_FileInfo and set in FILEINFO may not always be correct because the values depend on the file's saved data. L_FileInfo does not load file objects but reads the file dimensions which may not be saved within the file.

MessageCount L_INT Total number of messages (for PST files only).
nHorzTiles L_INT Number of horizontal tiles.
nVertTiles L_INT Number of vertical tiles.
pFilterData L_VOID * A pointer to a filter data structure used to speed up loading. pFilterData is valid only if the FILEINFO_USEFILTERDATA flag was passed to L_FileInfo. If not NULL, pass the data through the LOADFILEOPTION structure and free it by calling L_FreeFilterData when it is no longer needed.

See the Using Filter Data to Speed up Loading Large Files topic for more information.

uFilterDataSize L_SIZE_T Size of the filter data. Returned only if the FILEINFO_USEFILTERDATA flag was passed to L_FileInfo.

If 0, it is possible that the filter data contains handles or pointers that are valid only in the current process. Also, if 0, the filter data can be used only in one thread at a time. Currently, this is the case for most filters.

If not 0, the filter data is flat and can be saved to disk and reloaded later.

See the Using Filter Data to Speed up Loading Large Files topic for more information.

nFilter L_INT The filter that allocated the filter data. Returned only if the FILEINFO_USEFILTERDATA flag was passed to L_FileInfo.

See the Using Filter Data to Speed up Loading Large Files topic for more information.

Comments

pFILEINFO is a pointer to a FILEINFO structure. Where the function parameter type is pFILEINFO, you can declare a FILEINFO variable, update the structure's fields, and pass the variable's address in the parameter. Declaring a pFILEINFO variable is necessary only if your program requires a pointer.

Some functions which take this structure as a parameter require that the structure must be initialized prior to the function call. You must set the uStructSize member to the total size, in bytes, of the structure. Use the sizeof() operator to calculate this value. Functions that do not require the structure be initialized will take the total size of the structure, in bytes, as an additional function parameter.

Multi-page files can be loaded more quickly using two mechanisms, as follows:

  1. TIFF files can use the IFD (offset of each page). For more information about loading and saving large TIFF files more quickly, refer to Loading and Saving Large TIFF/BigTIFF Files.

  2. Files other than TIFF files can use a filter data mechanism. Retrieve the filter data by calling L_FileInfo with the FILEINFO_USEFILTERDATA flag. If the filter supports this mechanism, the filter data is returned by filling the pFilterData, uFilterDataSize and nFilter members of the FILEINFO structure. You then pass the filter data through LOADFILEOPTION structures to the load or convert functions and then free them with L_FreeFilterData when they are not needed anymore. See the Using Filter Data to Speed up Loading Large Files topic for more information.

Please note that if FILEINFO.Format is FILE_JPEG or FILE_TIF_JPEG and FILEINFO.BitsPerPixel is 8, then the image uses the 4:0:0 color space, not the 4:4:4 color space.

Currently only PSD files support layers.

Help Version 20.0.2018.7.30
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help