Saves a list of bitmaps, to a file in any supported JPEG 2000 format.


#include "l_bitmap.h"

L_LTJP2_API L_INT EXT_FUNCTION L_Jp2SaveList(hJp2, pszFile, hList, eFormat, nBitsPerPixel, nQFactor, pSaveOptions, pSaveCallBack, pUserData)


L_HJP2 hJp2

JPEG 2000 engine handle that was created by the L_Jp2Create function.

L_TCHAR * pszFile

Character string that contains the name of the JPEG 2000 file.


Handle to the list of bitmaps.


Output JPEG 2000 file format.

L_INT nBitsPerPixel

Resulting files pixel depth. Possible values are: 8, 12, 16, 24, 32, 48, 64, and 0. Zero [0] means that each bitmap will be saved with its bits per pixel value, if that value is equal to one of the possible values (8, 12, 16, 24, 32, 48, or 64). If it is not one of the possible values, it will return: ERROR_J2K_UNSUPPORTED.

L_INT nQFactor

Quality factor. This value determines the degree of loss in the compression process. Possible values are from 0 to 255. Zero (0) represents lossless compression. Values between 1 and 255 are interpreted as a compression ratio.


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


Optional callback function for additional processing.If you do not provide a callback function, pass NULL.If you provide a callback function, use the function pointer as the value of this parameter.The callback function must adhere to the syntax described in FILESAVECALLBACK.

L_VOID * pUserData

Void pointer you can use to pass one or more additional parameters used by the callback function.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 additional parameters are not needed, pass NULL.


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


L_Jp2SaveList saves a list of bitmaps, to a file in any supported JPEG 2000 format. However, note that the JPEG 2000 part 1 (JP2) file format does not support multiple codestreams. Therefore, if eFormat passes JP2, only the first bitmap in the list will be saved. All of the currently-set engines boxes will also be saved in this file.

Required DLLs and Libraries


Win32, x64.

See Also




This example saves/loads bitmap list in JPEG 2000 file format

L_INT Jp2SaveListExample(L_UINT8 * pXMLData, L_SIZE_T uSize) 
   L_HJP2 hEngine; 
   L_INT  nRet; 
   pL_JP2_MPEG7_BOX pMPEG7Box; 
   L_UINT uNumOfMPEG7; 
   // Create JPEG  2000 engine handle 
   hEngine = L_Jp2Create(); 
   // Load an image 
   nRet = L_Jp2ReadList(hEngine, MAKE_IMAGE_PATH("image1.jpx"), &hList, 0, ORDER_BGR, NULL, NULL, NULL, NULL); 
   if (nRet != SUCCESS) 
      return nRet; 
   // Read MPEG7 boxes 
   nRet = L_Jp2GetBoxes(hEngine, L_JPXB_MPEG7, (L_VOID**)&pMPEG7Box, &uNumOfMPEG7); 
   if (nRet != SUCCESS) 
      return nRet; 
   // Reset all engine boxes 
   nRet = L_Jp2ResetBoxes(hEngine); 
   if (nRet != SUCCESS) 
      return nRet; 
   // Set JPX Engine Boxes 
   if (uNumOfMPEG7) 
      nRet = L_Jp2SetBoxes(hEngine, L_JPXB_MPEG7, pMPEG7Box, uNumOfMPEG7); 
      if (nRet != SUCCESS) 
         return nRet; 
   // Create an XML box 
   XMLBox.uStructSize = sizeof(L_JP2_XML_BOX); 
   XMLBox.pData = pXMLData; 
   XMLBox.uDataSize = uSize; 
   // Set XML box of JPX engine 
   nRet = L_Jp2SetBoxes(hEngine, L_JPXB_XML, &XMLBox, 1); 
   if (nRet != SUCCESS) 
      return nRet; 
   // Save the image in JPx format 
   nRet = L_Jp2SaveList(hEngine, MAKE_IMAGE_PATH("Test.jpx"), hList, LEADJP2_JPX, 24, 5, NULL, NULL, NULL); 
   if (nRet != SUCCESS) 
      return nRet; 
   // Free MPEG7 boxes 
   if (uNumOfMPEG7) 
      nRet = L_Jp2FreeBoxes(hEngine, L_JPXB_MPEG7, pMPEG7Box, uNumOfMPEG7); 
      if (nRet != SUCCESS) 
         return nRet; 
   // Destroy engine handle 
   nRet = L_Jp2Destroy(hEngine); 
   if (nRet != SUCCESS) 
      return nRet; 
   nRet = L_DestroyBitmapList(hList); 
   if (nRet != SUCCESS) 
      return nRet; 
   return SUCCESS; 

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

LEADTOOLS Raster Imaging C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.