LFile::Compact

Summary

Compacts TIFF / BigTIFF files. It can also be used to copy or extract one or more pages from a TIFF / BigTIFF file and copy them without recompression to another TIFF / BigTIFF file.

Syntax

L_INT LFile::Compact(pszDstFile, uPages, pLoadFileOption, pSaveFileOption)

Parameters

L_TCHAR * pszDstFile

Character string that contains the name of the file in which all the pages will be written. This cannot be NULL. If this is NULL, the function will return an error. The pages can be added to this file using the pSaveFileOption parameter.

L_UINT uPages

Number of pages to copy. Use 0 to copy all the pages. If uPages is > 0, only uPages will be copied to pszDstFile.

pLOADFILEOPTION pLoadFileOption

Optional pointer to the LOADFILEOPTION structure, which can be used to specify a starting page. You can also speed up the access to the starting page using the IFD. You can pass NULL, which is equivalent to starting from the first page and to use the default load options.

pSAVEFILEOPTION pSaveFileOption

Optional pointer to the SAVEFILEOPTION structure, which can be used to specify where to save the data or how to modify an existing file. You can modify whether the new pages should appended, inserted or whether they should replace existing pages. Pass NULL to use the default save options.

Returns

Comments

This function can also be used to convert a TIFF file to BigTIFF and vice versa (BigTIFF -> TIFF).

The following members of the LOADFILEOPTION structure are important for this function:

• PageNumber: specifies the start page. Page 0 is the first page, page 1 is the second page, etc. The pages will be read starting with this page.

• Flags: specifies whether to use the IFD.

• IFD: used only if Flags contains the ELO_USEIFD flag. If ELO_USEIFD is not set, the PageNumber references the beginning of the file.

If pSaveFileOption is NULL, then if pszDstFile exists, it will be overwritten regardless of its format. Also, defaults will be used when saving the file (it will be saved in Intel format). Refer to the SAVEFILEOPTION documentation. TIF files are saved in two possible byte orders: Intel or Motorola (see SAVEFILEOPTIONS.Flags and ESO_MOTOROLAORDER flag.

If pSaveFileOption is not NULL, the following members of the SAVEFILEOPTION structure are important for this function:

• PageNumber: specifies the start page. This parameter is used as follows:

  • If ESO_INSERTPAGE is set in Flags, all the pages are inserted before this page.

  • If ESO_REPLACEPAGE is set in Flags, this page and the remaining uPages 1 will be replaced.

• If none of the above parameters are set, then:

  • If PageNumber is 0, the file will be overwritten.

  • If PageNumber is <> 0, the pages will be appended to the end of the file.

• IFD: can be used to speed up file access for TIFF files having many pages. Used only if ESO_USEIFD is set in Flags.

Flags: can be used to specify one or more options:

• ESO_NOSUBFILETYPE if this flag is set, then the TGSUBFILETYPE tag will be stripped from all the pages.

• ESO_REPLACEPAGE if this is set, pages in pszDstFile are replaced starting with page PageNumber.

• ESO_INSERTPAGE - if this is set, all the pages are inserted before page PageNumber.

• ESO_USEIFD if this is set, the first page in pszDstFile is at offset IFD. All pages will be relative to that page. (Note that this might not be the first physical page in the file). This is a common technique for manipulating files with thousands of pages.

• ESO_MOTOROLAORDER if this is set and you are creating a new file, the pages will be saved in Motorola byte order. If the flag is not set, the pages will be saved in Inter byte order. If you are modifying an existing file, this flag has no meaning the pages will be saved in the same byte order used in the file.

Flags2: Can be used to specify one or more of the following options:

• ESO2_BIGTIFF: if set, the destination file will be BigTIFF instead of regular TIFF. BigTIFF files are similar to TIFF files, but are somewhat non-standard and not supported by all readers. But BigTIFF files use 64-bit file offsets so they can be greater than 4GB.

Required DLLs and Libraries

• LTFIL
• LFTIF
• 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.

See Also

Functions

• LFile::SaveFile
• LFile::SaveOffset
• LBitmapBase::Save
• LBitmapBase::Load
• LFile::LoadFile
• LFile::GetInfo
• LBaseFile::GetDefaultLoadFileOption
• LBaseFile::GetDefaultSaveFileOption

Topics

• Loading and Saving Large TIFF/BigTIFF Files
• Raster Image Functions: Loading Files
• Raster Image Functions: Saving Files

Example

// Example 1 
L_INT LFile__CompactExample_1()  
{ 
   /* This example will compact all the pages in a TIFF file. */ 
   /* It will create a new file called dstfile.tif */ 
 
   LFile File; 
   L_INT nRet = 0 ; 
 
   File.SetFileName(MAKE_IMAGE_PATH(TEXT("clean.tif"))) ; 
 
   nRet = File.Compact(MAKE_IMAGE_PATH(TEXT("dstfile.tif")), 0, NULL, NULL);  
 
   if(nRet != SUCCESS)  
   { 
      MessageBox(NULL, TEXT("Error compacting file!"), TEXT("ERROR"), MB_OK); 
 
      return nRet; 
   } 
 
   return SUCCESS; 
} 
 
// Example 2 
L_INT LFile__CompactExample_2()  
{ 
   /* This example will compact all the pages in a TIFF file.*/ 
   /* It will append all the pages to an existing file called dstfile.tif */ 
   LFile File; 
   SAVEFILEOPTION SaveFileOption; 
   L_INT nRet = 0 ; 
 
   File.SetFileName(MAKE_IMAGE_PATH(TEXT("clean.tif"))) ; 
 
   File.GetDefaultSaveFileOption(&SaveFileOption, sizeof(SaveFileOption)); 
   SaveFileOption.PageNumber = 2; 
 
   nRet = File.Compact(MAKE_IMAGE_PATH(TEXT("dstfile.tif")), 0, NULL, &SaveFileOption); 
   if(nRet != SUCCESS) 
   { 
      MessageBox(NULL, TEXT("Error compacting file!"), TEXT("ERROR"), MB_OK); 
 
      return nRet; 
   } 
 
   return SUCCESS; 
}