In This Topic ▼

L_Jp2AppendFrames

Summary

Appends new frames to the specified JPEG 2000 file.

Syntax

#include "l_bitmap.h"

L_LTJP2_API L_INT EXT_FUNCTION L_Jp2AppendFrames(hJp2, pszFile, pComposite, 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 to append new frames.

pL_JP2_JPXCOMPOSITE pComposite

Pointer to a composite structure that contains new frames information (color channels, opacity channels, pre-multiplied opacity channels, and compression type).

L_INT nBitsPerPixel

Resulting frames pixel depth. The available valid bits per pixel are 8, 12, 16, 24, 32, 48, and 64. If the value is zero, then each bitmap will be saved by its own bits per pixel but it shall be one of the above values.

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_Jp2AppendFrames appends new frames to already existing JPEG 2000 file. The new frames codestreams are determined by pComposite. pComposite determines the channels of this layers. If the channels bitmap is not allocated, the channel does not exist. The color bitmap must be allocated in all frames. If any color bitmap is not allocated, the function will return ERROR_NO_BITMAP. All of the engines boxes will be reset.

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 appends an image to already existing JPEG 2000 file.

L_INT Jp2AppendFramesExample(pBITMAPHANDLE pBitmap) 
{ 
   L_HJP2 hEngine; 
   L_INT  nRet; 
   L_JP2_JPXBITMAPS pBitmaps[1] = { 0 }; 
   L_JP2_JPXCOMPOSITE Composite; 
 
 
   pBitmaps[0].uStructSize = sizeof(L_JP2_JPXBITMAPS); 
   pBitmaps[0].ColorBitmap = *pBitmap; 
   pBitmaps[0].eColorFormat = LEADJP2_J2K; 
 
   Composite.uStructSize = sizeof(L_JP2_JPXCOMPOSITE); 
   Composite.pBitmaps = pBitmaps; 
   Composite.uNumOfBitmaps = 1; 
 
   // Create JPEG  2000 engine handle 
   hEngine = L_Jp2Create(); 
 
   // Append frames to a JPX file 
   nRet = L_Jp2AppendFrames(hEngine, MAKE_IMAGE_PATH("image1.jpx"), &Composite, 24, 5, NULL, NULL, NULL); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   // Destroy engine handle 
   nRet = L_Jp2Destroy(hEngine); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   return SUCCESS; 
}