PNGFilter Class Reference

Encapsulates a PNG export filter. Derives off the masked filter which provides funcitonality for doing masked bitmap export and import. More...

#include <pngfiltr.h>

Inheritance diagram for PNGFilter:

List of all members.

Public Member Functions
	PNGFilter ()
	Constructor for an PNGFilter object. The object should be initialised before use.
BOOL	Init ()
	Initialise an PNGFilter object.
virtual INT32	HowCompatible (PathName &Filename, ADDR HeaderStart, UINT32 HeaderSize, UINT32 FileSize)
	Determine if this filter can load the specified file.
virtual FilterType	GetFilterType () const
virtual BOOL	ReadFromFile (OILBitmap *pOilBitmap)
	Actually does the process of reading a bitmap from a file. Inherited classes override this to read in different file formats.
virtual BOOL	ReadFromFile (OILBitmap *pOilBitmap, BaseCamelotFilter *pFilter, CCLexFile *pFile, BOOL IsCompressed)
	Actually does the process of reading a bitmap from a file. Inherited classes override this to read in different file formats. It is used by the web/native filters to pull out a bitmap definition from inside a bitmap definition record. IsCompressed is only used for BMP/BMPZIP type bitmaps at present. Assumes: pFile has already been opened up for reading pFilter has been set up for reading the data e.g. progress bar.
virtual BOOL	WriteBitmapToFile (KernelBitmap *pKernelBitmap, BaseCamelotFilter *pFilter, CCLexFile *pFile, INT32 Compression)
virtual BOOL	IsThisBppOk (UINT32 Bpp)
	Check if this Bitmap filter can cope with saving at this Bpp/Colour depth.
virtual INT32	GetPNGCompatibility ()
virtual UINT32	GetExportMsgID ()
	Used to get the message id to be used during export. Overides the baseclass form of the function so that during the two stage export process it can change the message.
virtual void	PostGetExportOptions (BitmapExportOptions *pOptions)
Protected Member Functions
virtual void	InvertAlpha (LPBITMAPINFO lpBitmapInfo, LPBYTE lpBits)
	Camelot uses a different transparency scheme to the rest of the world, in that 255 is clear, and 0 is opaque. Until the rest of the world catches up, it's necessary to invert the alpha channel to make exported files compatible with other programs.
virtual OutputDIB *	GetOutputDIB (void)
	Casts the current output DIB to be a generic OutputDIB class. This allows the same code to be re-used in the base class.
virtual BitmapExportOptions *	CreateExportOptions () const
	See BaseBitmapFilter for interface details Notes: Provides a new PNGExportOptions instance.
virtual BOOL	GetExportOptions (BitmapExportOptions *pOptions)
	See BaseBitmapFilter for interface details.
virtual void	CleanUpAfterExport ()
	Cleans up the memory allocated at the end of Exporting or when exporting has been aborted for some reason. Does its cleaning up and then calls the baseclass version to do its stuff, - used when the import process ends, either normally or abnormally. Override if extra things are required.
virtual BOOL	EndWriteToFile ()
	Cleans up after writing the bitmap data out to a file. Inherited classes override this to write in different file formats. This is slightly different to most other bitmap filters in that it is here that the data actually gets written out to file, after doing the transparency translation, if required.
virtual BOOL	WriteFileHeader (void)
	To write out the file specific header data.
virtual BOOL	WritePreFrame (void)
	To write out any frame specific info before the image.
virtual BOOL	WritePreSecondPass (void)
	Called to do any processing required after the first and before the second pass of a two pass export.
virtual BOOL	WritePostOptimisedPalette (void)
	Called after the optimised palette has been generated but before the export of the bitmap.
virtual BOOL	WriteFrame (void)
	To write out the image itself This base class version actually calls the WriteToFile() function so that derived classes do not have to implement any of the multi-image stuff.
virtual BOOL	WritePostFrame (void)
	To write out any frame specific info after the image.
virtual BOOL	WriteFileEnd (void)
	To write out the file specific data at the end of the file This base class version calls EndWriteToFile() so that derived classes do not have to implement the multi-image stuff.
virtual BOOL	WriteBitmapToFile (KernelBitmap *pKernelBitmap, double Dpi)
	Physically put the bitmap into the disk. Inherited classes override this to write in different file formats.
void	AlterPaletteContents (LPLOGPALETTE pPalette)
Static Protected Member Functions
static BOOL	WriteDataToFile (BOOL End, UINT32 Bpp, UINT32 Compression)
	Physically put the bitmap into the disk. NOTE - ONLY COPES WITH End=TRUE currently AtEnd is ignored now and should always be set to TRUE. Unused at present due to static problems when cretaing the 1bpp bitmap.
static BOOL	WriteToFile (CCLexFile *, LPBITMAPINFO Info, LPBYTE Bits, String_64 *ProgressString=NULL)
	Write a bitmap in memory straight out as a PNG to file with no rendering or conversion between different colour depths (apart from 32 to 24) or resolution. Errors on 16-bit builds*** A progress hourglass can be shown if required. This function is used by the save bitmap button on the bitmap gallery. All other bitmap export uses the OutputDIB class instead as this copes with using a render region and converting from 32 to the destination format. (caller should close file).
static BOOL	WriteToFile (CCLexFile *, LPBITMAPINFO Info, LPBYTE Bits, BOOL Interlace, INT32 TransparentColour, BaseCamelotFilter *pFilter=NULL)
	Write a bitmap in memory straight out as a PNG to file with no rendering or conversion between different colour depths (apart from 32 to 24) or resolution. Errors on 16-bit builds*** A progress hourglass can be shown if required using the BaseCamelotFilter as the controlling influence.
Protected Attributes
INT32	PNGHowCompatible
UINT32	Export2ndStageMsgID
Static Protected Attributes
static FilterType	s_FilterType = PNG
Private Member Functions
	CC_DECLARE_DYNAMIC (PNGFilter)

---

Detailed Description

Encapsulates a PNG export filter. Derives off the masked filter which provides funcitonality for doing masked bitmap export and import.

Author:

Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>

Date:

26/4/96

Definition at line 155 of file pngfiltr.h.

---

Constructor & Destructor Documentation

PNGFilter::PNGFilter (   )

Constructor for an PNGFilter object. The object should be initialised before use. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 26/4/96 See also: PNGFilter::Init Definition at line 229 of file pngfiltr.cpp. : MaskedFilter() { ImportMsgID = _R(IDS_IMPORTMSG_PNG); Flags.CanImport = TRUE; Flags.CanExport = TRUE; FilterID = PNG; ExportMsgID = _R(IDS_EXPORTMSG_PNG); // "Preparing PNG file..." ExportingMsgID = _R(IDS_EXPORTINGMSG_PNG); // "Exporting PNG file..." // Special Mask prepartion stage ID Export2ndStageMsgID = _R(IDN_MASKINGMSG_PNG); // "Preparing mask for PNG file..." ExportRegion = NULL; }

---

Member Function Documentation

void PNGFilter::AlterPaletteContents (  LPLOGPALETTE  pPalette  )  [protected, virtual]

Reimplemented from BaseBitmapFilter. Definition at line 1215 of file pngfiltr.cpp. { DestPNG.AlterExportPalette( pPalette ); }

PNGFilter::CC_DECLARE_DYNAMIC (  PNGFilter   )  [private]

void PNGFilter::CleanUpAfterExport (   )  [protected, virtual]

Cleans up the memory allocated at the end of Exporting or when exporting has been aborted for some reason. Does its cleaning up and then calls the baseclass version to do its stuff, - used when the import process ends, either normally or abnormally. Override if extra things are required. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 14/5/96 See also: BaseBitmapFilter::PrepareToExport(); BaseBitmapFilter::CleanUpAfterExport(); Scope: Protected Reimplemented from BaseBitmapFilter. Definition at line 564 of file pngfiltr.cpp. { // Called right at the end of the export process or when the epxort has been aborted // Clean up any objects unique to this class. // Free up any DIBs that we might have left lying around on the export if (pDestBMInfo && pDestBMBytes) { FreeDIB( pDestBMInfo, pDestBMBytes ); pDestBMInfo = NULL; pDestBMBytes = NULL; } // the depth we ask GDraw to render is always 32-bit, so we can get transparency // we have to convert for other formats when writing the actual bytes to the file SetDepthToRender(32); // We haven't written the header yet WrittenHeader = FALSE; // We are a first pass render and not doing the mask, by default SecondPass = FALSE; DoingMask = FALSE; // Now call the baseclass version to do its stuff BaseBitmapFilter::CleanUpAfterExport(); }

BitmapExportOptions * PNGFilter::CreateExportOptions (   )  const [protected, virtual]

See BaseBitmapFilter for interface details Notes: Provides a new PNGExportOptions instance. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Reimplemented from BaseBitmapFilter. Definition at line 1209 of file pngfiltr.cpp. { PNGExportOptions* pPNGOptions = new PNGExportOptions(PNG, &FilterName); return (BitmapExportOptions*)pPNGOptions; }

BOOL PNGFilter::EndWriteToFile (  void   )  [protected, virtual]

Cleans up after writing the bitmap data out to a file. Inherited classes override this to write in different file formats. This is slightly different to most other bitmap filters in that it is here that the data actually gets written out to file, after doing the transparency translation, if required. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 14/5/96 Parameters: -  [INPUTS] Returns: TRUE if worked, FALSE if failed. Reimplemented from BaseBitmapFilter. Definition at line 657 of file pngfiltr.cpp. { if (GeneratingOptimisedPalette()) return TRUE; // No need to output anything // Can reset the band number now. m_BandNumber = 0; PNGExportOptions* pPNGOptions = (PNGExportOptions*)GetBitmapExportOptions(); ERROR2IF(pPNGOptions == NULL, FALSE, "NULL Args"); ERROR3IF(!pPNGOptions->IS_KIND_OF(PNGExportOptions), "pPNGOptions isn't"); // Do the transparency translation just before we write out the data as a PNG. // This involves doing a 1 bpp export of the same area and using this to work // out which areas are transparent or not. // Only do this if the user has requested transparency and we outputting at 8bpp BOOL ok = TRUE; BOOL SaveDataOut = TRUE; if (BadExportRender) { // Delete our whitearea bitmap if (pTempBitmapMask != NULL) CCFree(pTempBitmapMask); pTempBitmapMask = NULL; } // Save the data out if required. Only if we exported ok. if (SaveDataOut && !BadExportRender) { if (ok) { // Now that we know the transparent index we can output the PNG header ok = DestPNG.OutputPNGHeader(OutputFile, NULL, pPNGOptions->WantInterlaced(), pPNGOptions->GetTransparencyIndex(), pPNGOptions->GetDepth() <= 8 ? pPNGOptions->GetLogicalPalette() : NULL); } // Actually write the destination bitmap out to the file showing an hourglass // and/or progress bar as we go. Always show the Exporting message. // Need to do in one go due to interlacing if (ok) { String_64 ProgressString(ExportingMsgID); ProgressString = GetExportProgressString(OutputFile, ExportingMsgID); BeginSlowJob(100, FALSE, &ProgressString); DestPNG.OutputPNGBits(OutputFile, DestPNG.GetDestBitmapBits()); EndSlowJob(); } } ASSERT(ok); return DestPNG.TidyUp(); }

UINT32 PNGFilter::GetExportMsgID (   )  [virtual]

Used to get the message id to be used during export. Overides the baseclass form of the function so that during the two stage export process it can change the message. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 10/07/96 Returns: The id of the message to put on the progress display whilst exporting. See also: DoExport; TI_GIFFilter::GetExportMsgID; Reimplemented from BaseBitmapFilter. Definition at line 604 of file pngfiltr.cpp. { if (GeneratingOptimisedPalette()) return _R(IDS_GENOPTPALMSGID); // "Generating optimised palette..." PNGExportOptions* pPNGOptions = (PNGExportOptions*)GetBitmapExportOptions(); ERROR2IF(pPNGOptions == NULL, FALSE, "NULL Args"); ERROR3IF(!pPNGOptions->IS_KIND_OF(PNGExportOptions), "pPNGOptions isn't"); // If we are exporting with transparency on and on first pass use the masking message // otherwise use the exporting message. if (pPNGOptions->GetSelectionType() == SELECTION && pPNGOptions->WantTransparent()) { // Special 4 stage rendering operation // - Render selected objects to white background // - Render mask 1bpp // - Render all objects // - Save data out to disk if (!SecondPass) return Export2ndStageMsgID; // "Preparing mask for PNG file..." else return Filter::GetExportMsgID(); // "Preparing PNG file..." } else { // Special 3 stage rendering operation // - Render objects to white background // - Render mask 1bpp // - Save data out to disk if (DoingMask) return Export2ndStageMsgID; // "Preparing mask for PNG file..." else return Filter::GetExportMsgID(); // "Preparing PNG file..." } return ExportingMsgID; }

BOOL PNGFilter::GetExportOptions (  BitmapExportOptions *  pOptions  )  [protected, virtual]

See BaseBitmapFilter for interface details. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 12/11/96 Reimplemented from BaseBitmapFilter. Reimplemented in PreviewFilterPNG. Definition at line 463 of file pngfiltr.cpp. { ERROR2IF(pOptions == NULL, FALSE, "NULL Args"); PNGExportOptions* pPNGOptions = (PNGExportOptions*)pOptions; ERROR3IF(!pPNGOptions->IS_KIND_OF(PNGExportOptions), "pPNGOptions isn't"); // the depth we ask GDraw to render is always 32-bit, so we can get transparency // we have to convert for other formats when writing the actual bytes to the file SetDepthToRender(32); // We haven't written the header yet WrittenHeader = FALSE; // We are a first pass render and not doing the mask, by default SecondPass = FALSE; DoingMask = FALSE; // Determine the filter type currently in use in Accusoft format s_FilterType = PNG; pPNGOptions->SetFilterType(PNG); BOOL Ok = FALSE; OpDescriptor* pOpDes = OpDescriptor::FindOpDescriptor(OPTOKEN_GIFTABDLG); if (pOpDes != NULL) { // set up the data for the export options dialog OpParam Param((void *)pOptions, (void *)this); // invoke the dialog pOpDes->Invoke(&Param); // SMFIX // we have brought the dlg up so get the options from the dlg as the graphic type may have changed pOptions = BmapPrevDlg::m_pExportOptions; // check for valid options // This may get messed up, so have to use the second line below. Ok = BmapPrevDlg::m_bClickedOnExport; } else { ERROR3("Unable to find OPTOKEN_BMAPPREVDLG"); } // Return with the ok/cancel state used on the dialog box return Ok; }

virtual FilterType PNGFilter::GetFilterType (   )  const [inline, virtual]

Reimplemented from BaseBitmapFilter. Definition at line 167 of file pngfiltr.h. { return PNG; }

OutputDIB * PNGFilter::GetOutputDIB (  void   )  [protected, virtual]

Casts the current output DIB to be a generic OutputDIB class. This allows the same code to be re-used in the base class. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> Date: 27/6/00 Returns OutputDIB* - A pointer to DestPNG. Reimplemented from MaskedFilter. Definition at line 1193 of file pngfiltr.cpp. { // Perform an upcast to allow the pointer to be used in a generic manner. return static_cast<OutputDIB*> ( &DestPNG ); }

virtual INT32 PNGFilter::GetPNGCompatibility (   )  [inline, virtual]

Definition at line 184 of file pngfiltr.h. { return PNGHowCompatible; }

INT32 PNGFilter::HowCompatible (  PathName &  Filename, ADDR  HeaderStart, UINT32  HeaderSize, UINT32  FileSize )  [virtual]

Determine if this filter can load the specified file. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 26/4/96 Parameters: Filename  - name of the file. [INPUTS] HeaderStart - Address of the first few bytes of the file. HeaderSize - the number of bytes in the header pointed to by FileStart. FileSize - the size of the whole file, in bytes. Returns: 0 => Not a PNG file. 10 => It is a PNG file. Reimplemented from Filter. Definition at line 290 of file pngfiltr.cpp. { PORTNOTE("byteorder", "TODO: Check byte ordering") // We need to remember what we thought of this file in our class variable. // So, set it to a nice default value at the start. PNGHowCompatible = 0; // Check that we've got enough data to do our check if (HeaderSize < 8) return 0; // Not enough data - ignore this file. // Check the header for the "PNG" signature. // The first eight bytes of a PNG file always contain the following (decimal) values: // 137 80 78 71 13 10 26 10 if ( (HeaderStart[0] == 137) && // 0x89 (HeaderStart[1] == 80) && // 0x50 (HeaderStart[2] == 78) && // 0x4E (HeaderStart[3] == 71) && // 0x47 (HeaderStart[4] == 13) && // Carriage return (HeaderStart[5] == 10) && // Line feed (HeaderStart[6] == 26) && // end of file (0x1a) (HeaderStart[7] == 10) // Line feed ) { // This should be a good enough check that this is a PNG file // Hence, we like this file PNGHowCompatible = 10; } // Return the found value to the caller. return PNGHowCompatible; }

BOOL PNGFilter::Init (  void   )  [virtual]

Initialise an PNGFilter object. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 26/4/96 Returns: TRUE if the filter was initialised ok, FALSE otherwise. Errors: Will fail if not enough memory to initialise. See also: EPSStack Reimplemented from MaskedFilter. Reimplemented in PreviewFilterPNG. Definition at line 256 of file pngfiltr.cpp. { // Get the OILFilter object pOILFilter = new PNGOILFilter(this); if (pOILFilter==NULL) return FALSE; // Load the description strings FilterName.Load(_R(IDS_PNG_FILTERNAME)); FilterInfo.Load(_R(IDS_PNG_FILTERINFO)); if (!PNGExportOptions::Declare()) return FALSE; // All ok return TRUE; }

void PNGFilter::InvertAlpha (  LPBITMAPINFO  lpBitmapInfo, LPBYTE  lpBits )  [protected, virtual]

Camelot uses a different transparency scheme to the rest of the world, in that 255 is clear, and 0 is opaque. Until the rest of the world catches up, it's necessary to invert the alpha channel to make exported files compatible with other programs. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> Date: 27/6/00 Reimplemented from MaskedFilter. Definition at line 1176 of file pngfiltr.cpp. { DIBUtil::InvertAlpha(lpBitmapInfo, lpBits); }

BOOL PNGFilter::IsThisBppOk (  UINT32  Bpp  )  [virtual]

Check if this Bitmap filter can cope with saving at this Bpp/Colour depth. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 26/4/96 Parameters: Bpp  or Colour depth. [INPUTS] Returns: TRUE if this filter can cope with this colour depth, FALSE otherwise. See also: OpMenuExport::DoWithParam; Reimplemented from BaseBitmapFilter. Definition at line 337 of file pngfiltr.cpp. { return (Bpp == 1 || Bpp == 4 || Bpp == 8 || Bpp == 24 || Bpp == 32); }

void PNGFilter::PostGetExportOptions (  BitmapExportOptions *  pOptions  )  [virtual]

Reimplemented from BaseBitmapFilter. Definition at line 517 of file pngfiltr.cpp. { // should be of this type PNGExportOptions* pPNGOptions = (PNGExportOptions*)pOptions; ERROR3IF(!pPNGOptions->IS_KIND_OF(PNGExportOptions), "pPNGOptions isn't"); // do the baseclass options MaskedFilter::PostGetExportOptions(pOptions); // do the specific to this class options // Filter type can be changed by the export options dialog box from say // PNG to PNG_INTERLACED UINT32 Silliness = pPNGOptions->WantTransparent() ? 2 : 0; Silliness |= pPNGOptions->WantInterlaced() ? 1 : 0; if (Silliness >= 0 && Silliness <= 4) { Compression = Silliness; // Compression ranges from 0 .. 4 so map this onto our filter types // s_FilterType = PNG + Silliness; switch (Silliness) { case 0: s_FilterType = PNG; break; case 1: s_FilterType = PNG_INTERLACED; break; case 2: s_FilterType = PNG_TRANSPARENT; break; case 3: s_FilterType = PNG_TRANSINTER; break; } if (pPNGOptions->WantTransparent() && pPNGOptions->GetSelectionType() == SELECTION) DoingMask = TRUE; } }

BOOL PNGFilter::ReadFromFile (  OILBitmap *  pOilBitmap, BaseCamelotFilter *  pFilter, CCLexFile *  pFile, BOOL  IsCompressed )  [virtual]

Actually does the process of reading a bitmap from a file. Inherited classes override this to read in different file formats. It is used by the web/native filters to pull out a bitmap definition from inside a bitmap definition record. IsCompressed is only used for BMP/BMPZIP type bitmaps at present. Assumes: pFile has already been opened up for reading pFilter has been set up for reading the data e.g. progress bar. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 20/7/96 Parameters: pOilBitmap  pointer to the oil bitmap data to be filled in [INPUTS] pFilter - the BaseCamelotFilter which provides functions like progress update pFile - the CCFile class to use to read the data from IsCompressed - Flag to say the bitmap is compressed or not. Will  have filled in BMInfo pointer to the bitmap header to fill in [OUTPUTS] BMBytes pointer to the bitmap data to fill in Returns: TRUE if worked, FALSE if failed. Reimplemented from BaseBitmapFilter. Definition at line 366 of file pngfiltr.cpp. { ERROR2IF(pOilBitmap == NULL,FALSE,"BMPFilter::ReadFromFile null OilBitmap pointer"); ERROR2IF(pFilter == NULL,FALSE,"BMPFilter::ReadFromFile null pFilter pointer"); ERROR2IF(pFile == NULL,FALSE,"BMPFilter::ReadFromFile null pFile pointer"); // Try to import bitmap as usual binary BMP file. CWxBitmap* pWBitmap = (CWxBitmap*)pOilBitmap; LPBITMAPINFO *pInfo = &(pWBitmap->BMInfo); LPBYTE *pBytes = &(pWBitmap->BMBytes); INT32 TransColour = -1; // Read from file,using pFilter for progress bar updates if (!PNGUtil::ReadFromFile(pFile, pInfo, pBytes, &TransColour, NULL, pFilter)) return FALSE; if(pWBitmap->BMInfo->bmiHeader.biBitCount == 32) { // If we`re exporting a 32Bit BMP then we need to make sure that we convert the // Alpha channel to Transparency! i.e. invert it! UINT32 BmpSize = pWBitmap->BMInfo->bmiHeader.biSizeImage; BYTE* Bits = pWBitmap->BMBytes; for(UINT32 i = 0; i < BmpSize; i+=4) Bits[i+3] = ~Bits[i+3]; } // Everything went ok and we imported the bitmap ok SetTransColour(TransColour); UINT32 Bpp = pWBitmap->GetBPP(); if (TransColour != -1 && Bpp <= 8) pOilBitmap->SetTransparencyIndex(TransColour); SetLastBitmap(); // can only import one bitmap at the moment return TRUE; }

BOOL PNGFilter::ReadFromFile (  OILBitmap *  pOilBitmap  )  [virtual]

Actually does the process of reading a bitmap from a file. Inherited classes override this to read in different file formats. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 26/4/96 Parameters: pOilBitmap  pointer to the oil bitmap data to be filled in [INPUTS] Will  have filled in BMInfo pointer to the bitmap header to fill in [OUTPUTS] BMBytes pointer to the bitmap data to fill in Returns: TRUE if worked, FALSE if failed. Reimplemented from BaseBitmapFilter. Definition at line 421 of file pngfiltr.cpp. { ERROR2IF(pOilBitmap == NULL,FALSE,"PNGFilter::ReadFromFile null OilBitmap pointer"); // Try to import the bitmap as a PNG file. CCLexFile *pImportFile = GetImportFile(); ERROR2IF(pImportFile==NULL,FALSE,"PNGFilter::ReadFromFile - No import file"); UINT32 ImportMsgId = GetImportMsgID(); String_64 ProgressString(ImportMsgId); ProgressString = GetImportProgressString(pImportFile, ImportMsgId); CWxBitmap* pWBitmap = (CWxBitmap*)pOilBitmap; LPBITMAPINFO *pInfo = &(pWBitmap->BMInfo); LPBYTE *pBytes = &(pWBitmap->BMBytes); INT32 TransColour = -1; // The PNG filter liked it very much and so use it, showing progress bar if (!PNGUtil::ReadFromFile(pImportFile, pInfo, pBytes, &TransColour, &ProgressString)) return FALSE; SetTransColour(TransColour); UINT32 Bpp = pWBitmap->GetBPP(); if (TransColour != -1 && Bpp <= 8) pOilBitmap->SetTransparencyIndex(TransColour); SetLastBitmap(); // can only import one bitmap at the moment return TRUE; }

BOOL PNGFilter::WriteBitmapToFile (  KernelBitmap *  pKernelBitmap, double  Dpi )  [protected, virtual]

Physically put the bitmap into the disk. Inherited classes override this to write in different file formats. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 26/4/96 Parameters: Pointer  to the bitmap to save. [INPUTS] Dpi of the bitmap to be saved Returns: TRUE if worked, FALSE if errored. See also: WriteDataToFile(); AccusoftFilters::WriteToFile; AccusoftFilters::WriteDataToFile; Reimplemented from BaseBitmapFilter. Definition at line 754 of file pngfiltr.cpp. { ERROR2IF(pKernelBitmap == NULL,FALSE,"PNGFilter::WriteBitmapToFile null bitmap pointer specified"); // Get a pointer to the actual bitmap so that we can get some details from it. OILBitmap *pOilBitmap = pKernelBitmap->ActualBitmap; ERROR2IF(pOilBitmap == NULL,FALSE,"PNGFilter::WriteBitmapToFile null oil bitmap pointer"); // Now get the pointer to the info header and actual bits data. // Need to use the actual bitmap pointer CWxBitmap* pWBitmap = (CWxBitmap*)pOilBitmap; LPBITMAPINFO pInfo = pWBitmap->BMInfo; LPBYTE pBytes = pWBitmap->BMBytes; // UINT32 Bpp = pWBitmap->GetBPP(); // Now, save the data out showing the correct progress string String_64 ProgressString(ExportingMsgID); BOOL ok = FALSE; // BOOL Interlace = TRUE; // Use interlace or not // BOOL Transparency = FALSE; // Use transparency or not if(pInfo->bmiHeader.biBitCount == 32) { // If we`re exporting a 32Bit BMP then we need to make sure that we convert the // Alpha channel to Transparency! i.e. invert it! UINT32 BmpSize = pInfo->bmiHeader.biSizeImage; for(UINT32 i = 0; i < BmpSize; i+=4) pBytes[i+3] = ~pBytes[i+3]; } ok = WriteToFile(OutputFile, pInfo, pBytes, &ProgressString); // This function is used when saving from the bitmap gallery. If we save a 32-bit bitmap as // a PNG, then we have to undo the alpha channel reversing that we did above. // Failure to do this will change the bitmap displayed in the bitmap gallery. if(pInfo->bmiHeader.biBitCount == 32) { UINT32 BmpSize = pInfo->bmiHeader.biSizeImage; for(UINT32 i = 0; i < BmpSize; i+=4) pBytes[i+3] = ~pBytes[i+3]; } return ok; }

BOOL PNGFilter::WriteBitmapToFile (  KernelBitmap *  pKernelBitmap, BaseCamelotFilter *  pFilter, CCLexFile *  pFile, INT32  Compression )  [virtual]

Reimplemented from BaseBitmapFilter. Definition at line 822 of file pngfiltr.cpp. { ERROR2IF(pKernelBitmap == NULL,FALSE, "PNGFilter::WriteBitmapToFile null pKernelBitmap"); ERROR2IF(pFilter == NULL,FALSE, "PNGFilter::WriteBitmapToFile null pFilter"); ERROR2IF(pFile == NULL,FALSE, "PNGFilter::WriteBitmapToFile null pFile"); // Get a pointer to the actual bitmap so that we can get some details from it. OILBitmap *pOilBitmap = pKernelBitmap->ActualBitmap; ERROR2IF(pOilBitmap == NULL,FALSE,"PNGFilter::WriteBitmapToFile null oil bitmap pointer"); // Now get the pointer to the info header and actual bits data. // Need to use the actual bitmap pointer CWxBitmap* pWBitmap = (CWxBitmap*)pOilBitmap; LPBITMAPINFO Info = pWBitmap->BMInfo; LPBYTE Bytes = pWBitmap->BMBytes; UINT32 Bpp = pWBitmap->GetBPP(); // Now, save the data out showing the correct progress string BOOL ok = FALSE; BOOL Interlace = FALSE; // Must not use interlacing as it will screw the progress bar updates // BOOL Transparency = FALSE; // Use transparency or not INT32 Transparent = -1; // colour or -1 = no transparency if (Bpp <= 8) pOilBitmap->GetTransparencyIndex(&Transparent); if(Info->bmiHeader.biBitCount == 32) { // If we`re exporting a 32Bit BMP then we need to make sure that we convert the // Alpha channel to Transparency! i.e. invert it! UINT32 BmpSize = Info->bmiHeader.biSizeImage; for(UINT32 i = 0; i < BmpSize; i+=4) Bytes[i+3] = ~Bytes[i+3]; } // Write to file, no header and using pFilter for progress bar updates ok = WriteToFile(pFile, Info, Bytes, Interlace, Transparent, pFilter); return ok; }

BOOL PNGFilter::WriteDataToFile (  BOOL  End, UINT32  Bpp, UINT32  Compression )  [static, protected]

Physically put the bitmap into the disk. NOTE - ONLY COPES WITH End=TRUE currently AtEnd is ignored now and should always be set to TRUE. Unused at present due to static problems when cretaing the 1bpp bitmap. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 14/5/96 Parameters: End  - TRUE if this is the last block of the file. [INPUTS] Bpp - output depth in terms of bits per pixel Compression - usually True if compression required, False otherwise In the PNG case this is used to pass in the transparency and interlace state. Returns: TRUE if worked, FALSE if errored. See also: WriteToFile(); AccusoftFilters::WriteToFile; AccusoftFilters::WriteDataToFile; Definition at line 735 of file pngfiltr.cpp. { ERROR2(FALSE,"PNGFilter::WriteDataToFile called when not implemented"); }

BOOL PNGFilter::WriteFileEnd (  void   )  [protected, virtual]

To write out the file specific data at the end of the file This base class version calls EndWriteToFile() so that derived classes do not have to implement the multi-image stuff. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 11/7/96 Parameters: -  [INPUTS] Returns: FALSE if failed else TRUE See also: GIFFilter::WriteFileEnd(void) Reimplemented from BaseBitmapFilter. Definition at line 1140 of file pngfiltr.cpp. { return DestPNG.TidyUp(); }

virtual BOOL PNGFilter::WriteFileHeader (  void   )  [inline, protected, virtual]

To write out the file specific header data. Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> Date: 12/6/96 Parameters: -  [INPUTS] Returns: FALSE if failed else TRUE See also: - Reimplemented from BaseBitmapFilter. Definition at line 205 of file pngfiltr.h. { return TRUE; }

BOOL PNGFilter::WriteFrame (  void   )  [protected, virtual]

To write out the image itself This base class version actually calls the WriteToFile() function so that derived classes do not have to implement any of the multi-image stuff. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 11/7/96 Parameters: -  [INPUTS] Returns: FALSE if failed else TRUE See also: GIFFilter::WriteFrame(void) Reimplemented from BaseBitmapFilter. Definition at line 1103 of file pngfiltr.cpp. { return MaskedFilter::WriteToFile(TRUE); }

BOOL PNGFilter::WritePostFrame (  void   )  [protected, virtual]

To write out any frame specific info after the image. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 11/7/96 Parameters: -  [INPUTS] Returns: FALSE if failed else TRUE See also: GIFFilter::WritePostFrame(void) Reimplemented from BaseBitmapFilter. Definition at line 1121 of file pngfiltr.cpp. { return EndWriteToFile(); }

virtual BOOL PNGFilter::WritePostOptimisedPalette (  void   )  [inline, protected, virtual]

Called after the optimised palette has been generated but before the export of the bitmap. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 17/6/96 Parameters: -  [INPUTS] Returns: FALSE if failed else TRUE See also: - Reimplemented from BaseBitmapFilter. Definition at line 208 of file pngfiltr.h. { return TRUE; }

BOOL PNGFilter::WritePreFrame (  void   )  [protected, virtual]

To write out any frame specific info before the image. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 11/7/96 Parameters: -  [INPUTS] Returns: FALSE if failed else TRUE See also: GIFFilter::WritePreFrame(void) Reimplemented from BaseBitmapFilter. Definition at line 1084 of file pngfiltr.cpp. { return DestPNG.ReStartFile(NULL); }

BOOL PNGFilter::WritePreSecondPass (  void   )  [protected, virtual]

Called to do any processing required after the first and before the second pass of a two pass export. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 11/7/96 Parameters: -  [INPUTS] Returns: FALSE if failed else TRUE See also: GIFFilter::WritePreSecondPass(void) Reimplemented from BaseBitmapFilter. Definition at line 1158 of file pngfiltr.cpp. { return EndWriteToFile(); }

BOOL PNGFilter::WriteToFile (  CCLexFile *  File, LPBITMAPINFO  Info, LPBYTE  Bits, BOOL  Interlace, INT32  TransparentColour, BaseCamelotFilter *  pFilter = NULL )  [static, protected]

Write a bitmap in memory straight out as a PNG to file with no rendering or conversion between different colour depths (apart from 32 to 24) or resolution. Errors on 16-bit builds*** A progress hourglass can be shown if required using the BaseCamelotFilter as the controlling influence. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 10/7/96 Parameters: File  An opened CCFile that can be written to. It should be positioned at the [INPUTS] start. Caller is responsible for closing it. The file needs to be in Binary mode. Info BITMAPINFO structure for the dib. Bits The bitmap data itself Interlace allows interlacing to be turned off or on Transparent if -1 then no transpparent colour, if not -1 then specifies the index number of the transparent colour in the palette pFilter is an alternative way of handling the progress bar, assume the progress bar has been start and just call the IncProgressBarCount in BaseCamelotFilter to do the progress bar update. Defaults to NULL i.e. no progress bar. -  [OUTPUTS] Returns: TRUE if worked, FALSE if failed (error will be set accordingly but not reported) This function is used by the new native/web file format to do a straight save of the data into the file. (caller should close file) Returns: Errors: Calls SetError on FALSE returns. Scope: Static See also: AccusoftFilters::WriteToFile; DIBUtil::WriteToFile; Definition at line 900 of file pngfiltr.cpp. { #ifdef DO_EXPORT ERROR2IF(File==NULL,FALSE,"PNGFilter::WriteToFile File pointer is null"); ERROR2IF(Info==NULL,FALSE,"PNGFilter::WriteToFile BitmapInfo pointer is null"); ERROR2IF(Bits==NULL,FALSE,"PNGFilter::WriteToFile Bits pointer is null"); // BITMAPINFO consists of:- // BITMAPINFOHEADER bmiHeader; // RGBQUAD bmiColors[1]; LPBITMAPINFOHEADER pInfoHeader = &Info->bmiHeader; ERROR2IF(pInfoHeader==NULL,FALSE,"PNGFilter::WriteToFile BitmapInfoHeader pointer is null"); LPRGBQUAD pPalette = &(Info->bmiColors[0]); ERROR2IF(pPalette==NULL,FALSE,"PNGFilter::WriteToFile palette pointer is null"); // Set up our format type flags. if(Info->bmiHeader.biBitCount == 32) { // If we`re exporting a 32Bit BMP then we need to make sure that we convert the // Alpha channel to Transparency! i.e. invert it! UINT32 BmpSize = Info->bmiHeader.biSizeImage; for(UINT32 i = 0; i < BmpSize; i+=4) Bits[i+3] = ~Bits[i+3]; } // Output a PNG header for this file, using the RGBQUAD palette rather than a LOGPALETTE DestPNG.OutputPNGHeader(File, pInfoHeader, Interlace, TransparentColour, NULL, pPalette); // Now write out the bitmap data itself. DestPNG.OutputPNGBits(File, Bits, TRUE, pFilter); // The above has set the OutputFile member variable of DestPNG. We desperately need to // reset this as otherwise the next bitmap export may go wrong as it calls the tidy up // and so will refer to the deleted CCFile. Oh Er! DestPNG.TidyUp(); // er, we seem to have finished OK so say so return TRUE; #else return FALSE; #endif }

BOOL PNGFilter::WriteToFile (  CCLexFile *  File, LPBITMAPINFO  Info, LPBYTE  Bits, String_64 *  ProgressString = NULL )  [static, protected]

Write a bitmap in memory straight out as a PNG to file with no rendering or conversion between different colour depths (apart from 32 to 24) or resolution. Errors on 16-bit builds*** A progress hourglass can be shown if required. This function is used by the save bitmap button on the bitmap gallery. All other bitmap export uses the OutputDIB class instead as this copes with using a render region and converting from 32 to the destination format. (caller should close file). Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 26/4/96 Parameters: File  An opened CCFile that can be written to. It should be positioned at the [INPUTS] start. Caller is responsible for closing it. The file needs to be in Binary mode. Info BITMAPINFO structure for the dib. Bits The bitmap data itself ProgressString allows the user to specify whether they require a progress hourglass or not. If NULL then none is shown, otherwise an progress bar is shown using the text supplied. Defaults to NULL i.e. no progress bar. -  [OUTPUTS] Returns: TRUE if worked, FALSE if failed (error will be set accordingly but not reported) Errors: Calls SetError on FALSE returns. Scope: Static See also: AccusoftFilters::WriteToFile; DIBUtil::WriteToFile; Definition at line 977 of file pngfiltr.cpp. { #ifdef DO_EXPORT ERROR2IF(File==NULL,FALSE,"PNGFilter::WriteToFile File pointer is null"); ERROR2IF(Info==NULL,FALSE,"PNGFilter::WriteToFile BitmapInfo pointer is null"); ERROR2IF(Bits==NULL,FALSE,"PNGFilter::WriteToFile Bits pointer is null"); // If the caller has specified a string then assume they require a progress bar // Start it up. if (ProgressString != NULL) BeginSlowJob(100, FALSE, ProgressString); // BITMAPINFO consists of:- // BITMAPINFOHEADER bmiHeader; // RGBQUAD bmiColors[1]; LPBITMAPINFOHEADER pInfoHeader = &Info->bmiHeader; ERROR2IF(pInfoHeader==NULL,FALSE,"PNGFilter::WriteToFile BitmapInfoHeader pointer is null"); LPRGBQUAD pPalette = &(Info->bmiColors[0]); ERROR2IF(pPalette==NULL,FALSE,"PNGFilter::WriteToFile palette pointer is null"); // Set up our format type flags. BOOL Interlace = TRUE; // Use interlace or not INT32 Transparent = -1; // colour or -1 = no transparency BOOL WantTransparent = FALSE; switch (s_FilterType) { default: case PNG: Interlace = FALSE; WantTransparent = FALSE; break; case PNG_INTERLACED: Interlace = TRUE; WantTransparent = FALSE; break; case PNG_TRANSPARENT: Interlace = FALSE; WantTransparent = TRUE; break; case PNG_TRANSINTER: Interlace = TRUE; WantTransparent = TRUE; break; } if (WantTransparent) { // We want to try and output the transparency if possible ... // Scan through the palette, and try and find an index with // the transparency flag set INT32 cols = Info->bmiHeader.biClrUsed; // If we have zero colours on a bitmap which is 8bpp or less then this is bad. // This should be translated as the maximum number of colours allowed if (Info->bmiHeader.biBitCount <= 8 && cols == 0) cols = 1 << Info->bmiHeader.biBitCount; for (INT32 i = 0; i < cols; i++) { if (Info->bmiColors[i].rgbReserved == 0xFF) { Transparent = i; TRACEUSER( "Neville", _T("PNG output with transp index of %d\n"),Transparent); break; } } } // Output the PNG data BOOL ok = TRUE; // Output a PNG header for this file, using the RGBQUAD palette rather than a LOGPALETTE if (Transparent == -1) ok = DestPNG.OutputPNGHeader(File, pInfoHeader, Interlace, -1, NULL, pPalette); else ok = DestPNG.OutputPNGHeader(File, pInfoHeader, Interlace, Transparent, NULL, pPalette); // Now write out the bitmap data itself. if (ok) ok = DestPNG.OutputPNGBits(File, Bits, TRUE); // If started, then stop then progress bar if (ProgressString != NULL) EndSlowJob(); // er, we seem to have finished OK so say so return TRUE; #else return FALSE; #endif }

---

Member Data Documentation

UINT32 PNGFilter::Export2ndStageMsgID [protected]

Definition at line 238 of file pngfiltr.h.

INT32 PNGFilter::PNGHowCompatible [protected]

Definition at line 233 of file pngfiltr.h.

FilterType PNGFilter::s_FilterType = PNG [static, protected]

Definition at line 235 of file pngfiltr.h.

---

The documentation for this class was generated from the following files:

• wxOil/pngfiltr.h (r1785/r809)
• wxOil/pngfiltr.cpp (r1785/r1558)

---