L_Jp2SaveComposite

Summary

Creates a file in any of the supported JPEG 2000 file formats, using the layer information you provide in pComposite.

Syntax

#include "l_bitmap.h"

L_LTJP2_API L_INT EXT_FUNCTION L_Jp2SaveComposite(hJp2, pszFile, pComposite, eFormat, nBitsPerPixel, nQFactor, pSaveOptions, pSaveCallBack, pUserData)

Parameters

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.

pL_JP2_JPXCOMPOSITE pComposite

Pointer to the L_JP2_JPXCOMPOSITE structure that provides information (color, opacity, pre-opacity, and compression) for all layers to be saved.

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.

pSAVEFILEOPTION pSaveOptions

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

FILESAVECALLBACK pSaveCallBack

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.

Returns

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

Comments

L_Jp2SaveComposite creates a file in any of the supported JPEG 2000 file formats, using the layer information you provide in pComposite. The color bitmap must be allocated in all layers. If any color bitmap is not allocated, the function will return: ERROR_NO_BITMAP. All of the engines boxes will be reset. The JPEG 2000 part 1 (JP2) file format supports only one layer. If you set more than one layer in pComposite, only the first layer will be saved. Also, the JPEG 2000 part 1 (JP2) file format does not support multiple codestreams, so only the color bitmap will be saved. All of the currently-set engines boxes will also be saved in this file.

Required DLLs and Libraries

LTJP2
LTIMGEFX
LFJ2K
For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

Example

This example saves/loads composite bitmaps in JPEG 2000 file format

L_INT Jp2SaveCompositeExample(L_UINT8 * pXMLData, L_SIZE_T uSize) 
{ 
   L_HJP2 hEngine; 
   L_INT  nRet; 
   L_UINT i; 
   L_JP2_JPXCOMPOSITE Composite; 
   L_JP2_XML_BOX XMLBox; 
   pL_JP2_MPEG7_BOX pMPEG7Box; 
   L_UINT uNumOfMPEG7; 
 
   // Create JPEG  2000 engine handle 
   hEngine = L_Jp2Create(); 
   Composite.uStructSize = sizeof(L_JP2_JPXCOMPOSITE); 
 
   // Load an image 
   nRet = L_Jp2ReadComposite(hEngine, MAKE_IMAGE_PATH("image1.jpx"), &Composite, 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; 
   } 
 
   // Set codestream compression type 
   for (i = 0; i < Composite.uNumOfBitmaps; i++) 
   { 
      Composite.pBitmaps[i].eColorFormat = LEADJP2_J2K; 
      Composite.pBitmaps[i].eOpacityFormat = LEADJP2_J2K; 
      Composite.pBitmaps[i].ePreOpacityFormat = LEADJP2_J2K; 
   } 
 
   // 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_Jp2SaveComposite(hEngine, MAKE_IMAGE_PATH("Test.jpx"), &Composite, 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; 
 
   // Free composite bitmaps 
   for (i = 0; i < Composite.uNumOfBitmaps; i++) 
   { 
      if (Composite.pBitmaps[i].ColorBitmap.Flags.Allocated) 
         L_FreeBitmap(&Composite.pBitmaps[i].ColorBitmap); 
      if (Composite.pBitmaps[i].OpacityBitmap.Flags.Allocated) 
         L_FreeBitmap(&Composite.pBitmaps[i].OpacityBitmap); 
      if (Composite.pBitmaps[i].PreOpacityBitmap.Flags.Allocated) 
         L_FreeBitmap(&Composite.pBitmaps[i].PreOpacityBitmap); 
   } 
 
   // Free composite structure 
   nRet = L_Jp2FreeComposite(hEngine, &Composite); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   return SUCCESS; 
}