L_LoadFile

#include "l_bitmap.h"

L_LTFIL_API L_INT L_LoadFile(pszFile, pBitmap, uStructSize, nBitsPerPixel, nOrder, uFlags, pfnCallback, pUserData, pLoadOptions, pFileInfo)

Loads any supported file, using a callback function.

Parameters

L_TCHAR* pszFile

Character string containing the name of the image file to load.

pBITMAPHANDLE pBitmap

Pointer to the bitmap handle for the loaded data.

L_UINT uStructSize

Size in bytes, of the structure pointed to by pBitmap, for versioning. Use sizeof(BITMAPHANDLE).

L_INT nBitsPerPixel

Resulting bitmap pixel depth. The following are valid values:

Value Meaning
0 Keep the original file's pixel depth (Do not convert). A Special Note about Loading 12- and 16-bit Grayscale Images
1 to 8 The specified bits per pixel in the resulting bitmap
12 12 bits per pixel in the resulting bitmap
16 16 bits per pixel in the resulting bitmap
24 24 bits per pixel in the resulting bitmap
32 32 bits per pixel in the resulting bitmap
48 48 bits per pixel in the resulting bitmap
64 64 bits per pixel in the resulting bitmap

 

L_INT nOrder

The desired color order. Possible values are:

Value Meaning
ORDER_RGB [0] Red-green-blue order.
ORDER_BGR [1] Blue-green-red order.
ORDER_GRAY [2] 12- or 16-bit grayscale image. 12- and 16-bit grayscale images are supported in the Document and Medical Imaging toolkits.
ORDER_RGBORGRAY [3] Load the image as red, green, blue OR as a 12- or 16-bit grayscale image. 12- and 16-bit grayscale images are supported in the Document and Medical Imaging toolkits.
ORDER_BGRORGRAY [4] Load the image as blue, green, red OR as a 12- or 16-bit grayscale image. 12- and 16-bit grayscale images are supported in the Document and Medical Imaging toolkits.
0 The data is 8 bits per pixel or less.
ORDER_ROMM [5] ROMM order. ROMM only supports 24- and 48-bit images.
ORDER_BGRORGRAYORROMM [6] Load the image as red, green, blue OR as a 12- or 16-bit grayscale image OR as ROMM. 12- and 16-bit grayscale images are supported in the Document and Medical Imaging toolkits. ROMM only supports 24- and 48-bit color images.

L_UINT uFlags

Binary flags that determine the behavior of L_LoadFile. You can specify one or more of the following values:

Value Meaning
LOADFILE_ALLOCATE [0x0001] The function allocates memory for the specified bitmap. (This takes place in addition to the actions of your callback function.)
LOADFILE_STORE [0x0002] The function loads data into the specified bitmap. (This takes place in addition to the actions of your callback function.)
LOADFILE_FIXEDPALETTE [0x0004] This flag will force a palletized image to be dithered to a fixed palette.
LOADFILE_NOINTERLACE [0x0008] The function passes image data in the order that is displayed, regardless of how it is stored in the file. (Set this flag if your program does not handle interlaced file formats.)
LOADFILE_ALLPAGES [0x0010] The function loads all pages of a multi-page file. Use this flag only if you are creating a bitmap list using the L_AppendPlayback function.
LOADFILE_NOINITBITMAP [0x0020] The function does not initialize the bitmap handle when it loads the file. Use this flag only if you are supplying all of the required information in the BITMAPHANDLE structure.
LOADFILE_COMPRESSED [0x0040] (Document and Medical Imaging toolkits) If possible, load the file as a 1-bit RLE-compressed image. For more information, refer to Speeding Up 1-Bit Documents.
LOADFILE_SUPERCOMPRESSED [0x0080] (Document and Medical Imaging toolkits) Load 1-bit, 8-bit, or 24-bit images as super compressed. This flag is ignored if the bitmaps are not loaded as 1-bit, 8-bit, or 24-bit. Please note that 8-bit images will be loaded as grayscale, even if the source image is color.
LOADFILE_TILED [0x0200] Create tiled bitmap first. Allocates the memory for bitmaps in tiles.
LOADFILE_NOTILED [0x0400] Do not use tiled bitmaps.
LOADFILE_DISK [0x0800] Use Disk (if possible).  Allocates the memory for bitmaps using hard disk space.
LOADFILE_NODISK [0x1000] Do not use disk.
LOADFILE_MULTITHREADED [0x2000] Use Multi-threaded load

FILEREADCALLBACK pfnCallback

Optional callback function for additional processing.

If you do not provide a callback function, use NULL as the value of this parameter.

If you do provide a callback function, use the function pointer as the value of this parameter.

The callback function must adhere to the function prototype described in the FILEREADCALLBACK Function.

L_VOID* pUserData

Void pointer that you can use to pass one or more additional parameters that the callback function needs.

To use this feature, assign a value to a variable or create a structure that contains as many fields as you need. Then, in this parameter, pass the address of the variable or structure, casting it to L_VOID *. The callback function, which receives the address in its own pUserData parameter, can cast it to a pointer of the appropriate data type to access your variable or structure.

If the additional parameters are not needed, pass NULL in this parameter.

pLOADFILEOPTION pLoadOptions

Pointer to optional extended load options. Pass NULL to use the default load options.

pFILEINFO pFileInfo

Pointer to a FILEINFO structure. This structure may contain file information used in loading an image, or it may be updated with information about the file being loaded.

If nothing is known about the file, pass NULL for this parameter, or declare a variable of type FILEINFO and set the FILEINFO.Flags to 0, then pass the address of the FILEINFO structure in this parameter. In this case, if the address of a FILEINFO structure is passed, the FILEINFO structure will be updated with the results of L_FileInfo.

If only the file type is known, set pFileInfo.Format to the file type and set pFileInfo.Flags to FILEINFO_FORMATVALID. This can also be done if L_FileInfo has been called previously, but values that affect the size of the image loaded have been changed (for example, by calling L_SetPCDResolution or L_SetWMFResolution). In this case the FILEINFO structure pointed to by pFileInfo will be updated with the results of L_FileInfo.

If L_FileInfo has been called prior to calling this function, and no changes have been made to the contents of the structure filled by L_FileInfo, then the address of the filled FILEINFO structure can be passed as this parameter. In this case, set the FILEINFO.Flags member to FILEINFO_INFOVALID. The L_FileInfo function will set the FILEINFO.Flags to FILEINFO_INFOVALID. In this case loading will be faster since L_LoadFile does not have to query the file filters for the file type.

Note: Local variables are not initialized (since they are placed on the stack). So if you have a FILEINFO structure as a local variable, the value of its Flags parameter is undefined, possibly having FILEINFO_INFOVALID or FILEINFO_FORMATVALID set. That is why it is important to initialize FILEINFO.Flags before passing the address of the FILEINFO structure to the function.

Returns

Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Comments

Support for 12- and 16-bit grayscale images is only available in the Document and Medical Imaging toolkits.

Before calling this function, you may need to get or set file information, such as the page number of a multi-page file or the resolution of a PCD file. Refer to Getting and Setting File Information.

The callback function can display the image to the screen, write to a file, or do other useful things. L_LoadFile will create a buffer and fill it with the actual image data. Once the buffer is full, the callback function is called.

Notes:

Required DLLs and Libraries

Platforms

Win32, x64, Linux.

See Also

Functions

Topics

Example

For complete sample code, refer to the RESIZE example. This example uses L_LoadFile with a callback function to implement a paint-while-load feature. Refer to the FILEREADCALLBACK function to see how the callback function paints the image data.

/* Structure used for the callback function's user data */ 
typedef struct tagIMAGECBPARM 
{ 
   HWND hwnd;     /* Current window */ 
   HDC hdc;       /* Device context for the current window */ 
} IMAGECBPARM; 
 
static L_INT EXT_CALLBACK LoadImageCB(pFILEINFO     pFileInfo, 
                                      pBITMAPHANDLE pBitmap, 
                                      L_UCHAR     * pBuffer, 
                                      L_UINT        uFlags, 
                                      L_INT         nRow, 
                                      L_INT         nLines, 
                                      L_VOID      * pUserData) 
{ 
   static RECT rLeadSource; 
   static RECT rLeadDest; 
   IMAGECBPARM *pData = (IMAGECBPARM*)pUserData; 
 
   /* If this is the first call (row 0), select and realize the palette */ 
   if((uFlags & FILEREAD_FIRSTPASS) && (uFlags & FILEREAD_FIRSTROW) ) 
   { 
      /* Set the source rectangle to use the whole bitmap */ 
      SetRect(&rLeadSource, 0, 0, pFileInfo->Width, pFileInfo->Height); 
      /* Set the dest rectangle to use the whole client area */ 
      GetClientRect(pData->hwnd, &rLeadDest); 
   } 
 
   /* Paint the buffer to the specified device context */ 
   L_PaintDCBuffer( pData->hdc, /* Device context - from function parameter */ 
                    pBitmap, /* Bitmap handle - from function parameter */ 
                    &rLeadSource, /* Source rect - set globally in WM_CREATE */ 
                    &rLeadSource, /* Source clip rect - same as source rect */ 
                    &rLeadDest, /* Destination rect - set globally in WM_CREATE */ 
                    &rLeadDest, /* Destination clip rect - same as destination rect */ 
                    SRCCOPY, /* ROP code for normal painting */  
                    pBuffer, /* Input buffer - from function parameter */  
                    nRow, /* First row in the buffer - from function parameter */  
                   (uFlags & FILEREAD_COMPRESSED) ? -nLines : nLines ); 
   return( SUCCESS ); 
} 
 
L_INT LoadFileExample(HWND hWnd, pBITMAPHANDLE pBitmap) 
{ 
   L_INT nRet; 
   static IMAGECBPARM UserData;  /* Structure used for the callback function's user data */ 
 
   /* Set the user data used for the callback in the nRet = L_LoadFile function */ 
   UserData.hwnd = hWnd;         /* Current window */ 
   UserData.hdc = GetDC( hWnd ); /* Device context for the current window */ 
 
   /* Load the file, calling lpfnCallBack to paint the bitmap. */ 
   if(pBitmap->Flags.Allocated) 
      L_FreeBitmap(pBitmap); 
 
   nRet = L_LoadFile( MAKE_IMAGE_PATH(TEXT("IMAGE1.CMP")), 
               pBitmap, sizeof(BITMAPHANDLE), 
               0, 
               ORDER_BGR, 
               LOADFILE_ALLOCATE |  LOADFILE_STORE, 
               LoadImageCB, 
               &UserData, 
               NULL, NULL); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   return SUCCESS; 
} 

Help Version 20.0.2019.10.13
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help