BMPFilter Class Reference

Encapsulates a Windows BMP export filter. Will probably import one day too. More...

#include <bmpfiltr.h>

Inheritance diagram for BMPFilter:

List of all members.

Public Member Functions
	BMPFilter ()
	Constructor for an BMPFilter object. The object should be initialised before use.
BOOL	Init ()
	Initialise an BMPFilter 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.
void	AlterPaletteContents (LPLOGPALETTE pPalette)
virtual void	PostGetExportOptions (BitmapExportOptions *pOptions)
virtual BOOL	WriteBitmapToFile (KernelBitmap *pKernelBitmap, BaseCamelotFilter *pFilter, CCLexFile *pFile, INT32 Compression)
	Physically put the bitmap into the disk. Inherited classes override this to write in different file formats. This is used by the native/web format to output the actual bitmap data content of a bitmap definition record. The function can assume that the CCFile is open and ready for writing and must use the functions provided by pFilter to update the progress system.
virtual BOOL	IsThisBppOk (UINT32 Bpp)
	Check if this Bitmap filter can cope with saving at this Bpp/Colour depth.
INT32	GetBmpCompatibility ()
	Determine if this filter can load the specified file.
Static Public Member Functions
static UINT32	GetDefaultExportDepth ()
	Allows a default export dots per inch size to be remembered when exporting either as a BMP or via the Accusoft loaders. Allows a default export bits per pixel amount to be remembered when exporting either as a BMP or via the Accusoft loaders. Allows other bitmap export filters to get at this value. Needs to be here rather than in BaseBitmapFilter as that Init is never used.
static double	GetDefaultExportDPI ()
	Allows other bitmap export filters to get at this value. Needs to be here rather than in BaseBitmapFilter as that Init is never used.
static void	SetDefaultExportDepth (UINT32)
	Allows other bitmap export filters to set this value. Needs to be here rather than in BaseBitmapFilter as that Init is never used.
static void	SetDefaultExportDPI (double)
	Allows other bitmap export filters to set this value. Needs to be here rather than in BaseBitmapFilter as that Init is never used.
static UINT32	GetDefaultExportDither ()
static void	SetDefaultExportDither (UINT32)
Protected Member Functions
virtual BitmapExportOptions *	CreateExportOptions () const
	Allows derived classes to override this function to provide their own class derived from BitmapExportInfo containing filter specific information.
virtual BOOL	WriteToFile (BOOL End)
	Physically put the bitmap into the disk. NOTE - ONLY COPES WITH End=TRUE currently Most of the work now is down by WriteDataToFile as this is a static form and there is a similar version in the Accusoft DLL. This can therefore be used to pass work onto the Accusoft DLL, for the cases we don't cope with. End is ignored now and should always be set to TRUE.
virtual BOOL	EndWriteToFile ()
	Cleans up after writing the bitmap data out to a file. Inherited classes override this to write in different file formats.
virtual BOOL	GetExportOptions (BitmapExportOptions *pOptions)
	See BaseBitmapClass for interface details Notes: Initializes BMP specific members Scope: Protected.
virtual void	CleanUpAfterExport ()
	Allows the filter to clean up any allocated resources.
virtual BOOL	WriteBitmapToFile (KernelBitmap *pKernelBitmap, double Dpi)
	Physically put the bitmap into the disk.
virtual BOOL	WriteDataToFile (BOOL End, UINT32 Bpp, UINT32 Compression)
	Physically put the bitmap into the disk. NOTE - ONLY COPES WITH End=TRUE currently End is ignored now and should always be set to TRUE.
BOOL	ExportViaAccusoftFilters ()
	Function to see if we should export via Accusoft filters or not as we cannot cope with this format.
virtual BOOL	GetRenderBottomToTop ()
	Find out which way we need to render.
Static Protected Member Functions
static BOOL	EndWriteDataToFile ()
	Actually does the job of cleaning up after writing the bitmap data out to a file. Usually called by EndWriteToFile.
Protected Attributes
INT32	BMPHowCompatible
Static Protected Attributes
static OutputDIB	DestDIB
Private Member Functions
	CC_DECLARE_DYNAMIC (BMPFilter)

---

Detailed Description

Encapsulates a Windows BMP export filter. Will probably import one day too.

Author:

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

Date:

28/6/94

Definition at line 179 of file bmpfiltr.h.

---

Constructor & Destructor Documentation

BMPFilter::BMPFilter (   )

Constructor for an BMPFilter object. The object should be initialised before use. Author: Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com> Date: 28/6/94 See also: BMPFilter::Init Definition at line 605 of file bmpfiltr.cpp. : BaseBitmapFilter() { ImportMsgID = _R(IDT_IMPORTMSG_BMP); #ifndef STANDALONE Flags.CanImport = TRUE; Flags.CanExport = TRUE; #else Flags.CanImport = TRUE; Flags.CanExport = FALSE; #endif FilterID = FILTERID_BMP; ExportRegion = NULL; ExportMsgID = _R(IDT_EXPORTMSG_BMP); ExportingMsgID = _R(IDT_EXPORTMSG_BMP); }

---

Member Function Documentation

void BMPFilter::AlterPaletteContents (  LPLOGPALETTE  pPalette  )  [virtual]

Reimplemented from BaseBitmapFilter. Definition at line 1553 of file bmpfiltr.cpp. { DestDIB.AlterExportPalette( pPalette ); }

BMPFilter::CC_DECLARE_DYNAMIC (  BMPFilter   )  [private]

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

Allows the filter to clean up any allocated resources. Author: Stefan_Stoykov (Xara Group Ltd) <camelotdev@xara.com> Date: 14/07/97 Returns: - Reimplemented from BaseBitmapFilter. Definition at line 1544 of file bmpfiltr.cpp. { // call the base filter first BaseBitmapFilter::CleanUpAfterExport(); WrittenHeader = FALSE; }

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

Allows derived classes to override this function to provide their own class derived from BitmapExportInfo containing filter specific information. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Returns: A pointer to a new BitmapExportInfo class Reimplemented from BaseBitmapFilter. Definition at line 1525 of file bmpfiltr.cpp. { BMPExportOptions* pExportOptions = new BMPExportOptions(BMP_UNCOMPRESSED, &FilterName); return (BitmapExportOptions*)pExportOptions; }

BOOL BMPFilter::EndWriteDataToFile (   )  [static, protected]

Actually does the job of cleaning up after writing the bitmap data out to a file. Usually called by EndWriteToFile. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 15/5/95 Parameters: -  [INPUTS] Returns: TRUE if worked, FALSE if failed. Definition at line 1246 of file bmpfiltr.cpp. { #ifdef DO_EXPORT if (GeneratingOptimisedPalette()) return TRUE; // No need to output anything return DestDIB.TidyUp(); #else return FALSE; #endif }

BOOL BMPFilter::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. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 12/5/95 Parameters: -  [INPUTS] Returns: TRUE if worked, FALSE if failed. See also: WriteToFile Reimplemented from BaseBitmapFilter. Definition at line 1051 of file bmpfiltr.cpp. { #ifdef DO_EXPORT // Must use the same check here and trasnfer the clean up process to the same filter // that we used to actually write the data to the file if ( ExportViaAccusoftFilters() ) #ifndef WEBSTER PORTNOTE("ExtFilt", "Removed use of external filters") #ifndef EXCLUDE_FROM_XARALX return AccusoftFilters::EndWriteDataToFile(); #else return FALSE; #endif #else //WEBSTER-Martin-07/01/97 return FALSE; #endif //WEBSTER else return EndWriteDataToFile(); #else return FALSE; #endif }

BOOL BMPFilter::ExportViaAccusoftFilters (   )  [protected]

Function to see if we should export via Accusoft filters or not as we cannot cope with this format. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 17/5/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if going to use the Accusoft filter, FALSE if not Definition at line 937 of file bmpfiltr.cpp. { #ifdef DO_EXPORT // Check if Accusoft filters are present // 8 and 4 as we cannot export as RLE in these formats #ifndef WEBSTER PORTNOTE("ExtFilt", "Removed use of external filters") #ifndef EXCLUDE_FROM_XARALX return (DefaultExportDepth==8 || DefaultExportDepth==4 || DefaultExportDepth==1) && (AccusoftFilters::GetVersionNumber() > 0); #else return FALSE; #endif #else //WEBSTER-Martin-07/01/97 return FALSE; #endif //WEBSTER #else return FALSE; #endif }

INT32 BMPFilter::GetBmpCompatibility (   )

Determine if this filter can load the specified file. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 03/02/95 Parameters: -  [INPUTS] Returns: The value we found in the HowCompatible call. 0 => Not a BMP file. 10 => It is a BMP file. Definition at line 1359 of file bmpfiltr.cpp. { return BMPHowCompatible; }

UINT32 BMPFilter::GetDefaultExportDepth (   )  [static]

Allows a default export dots per inch size to be remembered when exporting either as a BMP or via the Accusoft loaders. Allows a default export bits per pixel amount to be remembered when exporting either as a BMP or via the Accusoft loaders. Allows other bitmap export filters to get at this value. Needs to be here rather than in BaseBitmapFilter as that Init is never used. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 17/11/94 Parameters: None  [INPUTS] None  [OUTPUTS] Returns: The value currently set for the DefaultExportDepth See also: BMPFilter::Init; BMPFilter::GetDefaultExportDpi; BMPFilter::SetDefaultExportDepth; Definition at line 518 of file bmpfiltr.cpp. { return DefaultExportDepth; }

UINT32 BMPFilter::GetDefaultExportDither (   )  [static]

Definition at line 583 of file bmpfiltr.cpp. { return DefaultExportDither; }

double BMPFilter::GetDefaultExportDPI (   )  [static]

Allows other bitmap export filters to get at this value. Needs to be here rather than in BaseBitmapFilter as that Init is never used. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 17/11/94 Parameters: None  [INPUTS] None  [OUTPUTS] Returns: The value currently set for the DefaultExportDpi See also: BMPFilter::Init; BMPFilter::GetDefaultExportDepth; BMPFilter::SetDefaultExportDPI; Definition at line 538 of file bmpfiltr.cpp. { return DefaultExportDPI; }

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

See BaseBitmapClass for interface details Notes: Initializes BMP specific members Scope: Protected. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Reimplemented from BaseBitmapFilter. Reimplemented in PreviewFilterBMP. Definition at line 812 of file bmpfiltr.cpp. { #ifdef DO_EXPORT ERROR2IF(pOptions == NULL, FALSE, "NULL Args"); BMPExportOptions* pBMPOptions = (BMPExportOptions*)pOptions; ERROR3IF(!pBMPOptions->IS_KIND_OF(BMPExportOptions), "pBMPOptions isn't"); WrittenHeader = FALSE; // Set up the variables which the export dialog box uses UINT32 BitmapDepth = 0; if (pBMPOptions->GetSelectionType() == ABITMAP) { // Exporting the bitmap itself // dpi should be set to the dpi of the bitmap itself BitmapDepth = pBMPOptions->GetDepth(); } // Determine the filter type currently in use in Accusoft format // INT32 FilterID = BMP_UNCOMPRESSED; // Sets the Accusoft filter type to the same specified value just in case // we wish to use the Accusoft DLL to do some of the BMP saving for us //WEBSTER-Martin-07/01/97 #ifndef WEBSTER PORTNOTE("ExtFilt", "Removed use of external filters") #ifndef EXCLUDE_FROM_XARALX AccusoftFilters::SetFilterType(BMP_UNCOMPRESSED); #endif #endif // When saving a bitmap directly then only use the dialog box for 8 and 4 bpp export // as these are the only forms that can request a compression type. // Otherwise, always use it. BOOL Ok = TRUE; if ( pBMPOptions->GetSelectionType() != ABITMAP ) { // This is ok as we are using a modal dialog box 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 PORTNOTE("BmpPrevDlg", "Removed use of bitmap preview dialog") #ifndef EXCLUDE_FROM_XARALX pOptions = BmapPrevDlg::m_pExportOptions; // check for valid options //Ok = pOptions->IsValid(); // This line decides if we will create a file on disk for the bmp or not Ok = BmapPrevDlg::m_bClickedOnExport; #else pOptions = NULL; Ok = FALSE; #endif } else { ERROR3("Unable to find OPTOKEN_BMAPPREVDLG"); Ok = FALSE; } } // Return with the ok/cancel state used on the dialog box return Ok; #else return FALSE; #endif }

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

Reimplemented from BaseBitmapFilter. Definition at line 198 of file bmpfiltr.h. { return BMP_UNCOMPRESSED; }

BOOL BMPFilter::GetRenderBottomToTop (   )  [protected, virtual]

Find out which way we need to render. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 17/5/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if going to use the default of rendering bottom to top, FALSE otherwise Reimplemented from BaseBitmapFilter. Definition at line 972 of file bmpfiltr.cpp. { // We may be exporting via the Accusoft filters but when rendering BMPs they are // the correct way round already. return TRUE; }

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

Determine if this filter can load the specified file. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 31/08/94 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 BMP file. 10 => It is a BMP file. Reimplemented from Filter. Definition at line 1277 of file bmpfiltr.cpp. { // 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. BMPHowCompatible = 0; // Check that we've got enough data to do our check if (HeaderSize < sizeof(BITMAPFILEHEADER)) // Not enough data - ignore this file. return 0; // Check the header for the "BM" signature, and a sensible image size. LPBITMAPFILEHEADER pHeader = (LPBITMAPFILEHEADER) HeaderStart; if (pHeader->bfType != ( ('M'<<8) | 'B' ) ) // No BMP signature - we don't want this file. return 0; // the other fields in the BITMAPFILEHEADER cannot be relied upon. The bfSize // field seems particularly random. We can check the size of the structure following // it though const DWORD HdrSize = *(DWORD*)(HeaderStart + sizeof(BITMAPFILEHEADER) ); // If the header is of the correct size then now see what we think of this bitmap // header that we have been given. Cope with old OS/2 style headers and more up // to date ones. // If the header was ok we used to just say 'we like it' immediately. What we want // to do now instead is only say we are really interested if it is special types of // BMP, such as 32bpp, if it is anything else then say we are less interested in it. // This should allow the Accusoft BMP filter to take over the loading of BMPs which // we do not support. // Pointer to the info header should be the next one after the file header INT32 FileCompatibility = 0; // default, didn't like this file value if ( (HdrSize==sizeof( BITMAPCOREHEADER )) // old OS/2 1.0 ) { LPBITMAPCOREHEADER pCoreHeader = (LPBITMAPCOREHEADER)(pHeader+1); if ( DIBUtil::CanReadFromFile(pCoreHeader) ) FileCompatibility = 10; else FileCompatibility = 9; } else if ( (HdrSize==sizeof( BITMAPINFOHEADER )) // Win 3.0+ ) { LPBITMAPINFOHEADER pInfoHeader = (LPBITMAPINFOHEADER)(pHeader+1); // Use the function in DIBUtil to say if we like this file or not if ( DIBUtil::CanReadFromFile(pInfoHeader) ) FileCompatibility = 10; else FileCompatibility = 9; } TRACEUSER( "Neville", _T("BMPFilter::HowCompatible FileCompatibility = %d\n"),FileCompatibility); // Remember what we thought in our class variable. BMPHowCompatible = FileCompatibility; // Return the found value to the caller. return FileCompatibility; }

BOOL BMPFilter::Init (  void   )  [virtual]

Initialise an BMPFilter object. Author: Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com> Date: 28/6/94 Returns: TRUE if the filter was initialised ok, FALSE otherwise. Errors: Will fail if not enough memory to initialise. See also: EPSStack Reimplemented from BaseBitmapFilter. Reimplemented in PreviewFilterBMP. Definition at line 638 of file bmpfiltr.cpp. { // Get the OILFilter object pOILFilter = new BMPOILFilter(this); if (pOILFilter==NULL) return FALSE; // Load the description strings FilterName.Load(_R(IDT_BMP_FILTERNAME)); FilterInfo.Load(_R(IDT_BMP_FILTERINFO)); if (Camelot.DeclareSection(_T("Filters"), 10)) { // Requested that we don't store DPI for export (see bug 6757) // Camelot.DeclarePref( NULL, "ExportBitmapDPI", &DefaultExportDPI, 1.0, 3000.0 ); Camelot.DeclarePref( NULL, _T("ExportBitmapDepth"), &DefaultExportDepth, 1, 32 ); } // All ok return TRUE; }

BOOL BMPFilter::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: 27/4/95 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 1508 of file bmpfiltr.cpp. { return (Bpp == 1 || Bpp == 4 || Bpp == 8|| Bpp == 24 || Bpp == 32); }

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

Reimplemented from BaseBitmapFilter. Definition at line 897 of file bmpfiltr.cpp. { // should be of this type BMPExportOptions* pBMPOptions = (BMPExportOptions*)pOptions; ERROR3IF(!pBMPOptions->IS_KIND_OF(BMPExportOptions), "pBMPOptions isn't"); // do the baseclass first BaseBitmapFilter::PostGetExportOptions(pOptions); // do the filter specific stuff SetDepthToRender(pBMPOptions->GetDepth()); PaletteType = pBMPOptions->GetPalette() ? 1 : 0; // 1 for an optimised palette // Make sure that the Accusoft form of the stored dither is correctly set // as we may be calling this to do the exporting for us! //WEBSTER-Martin-07/01/97 #ifndef WEBSTER PORTNOTE("ExtFilt", "Removed use of external filters") #ifndef EXCLUDE_FROM_XARALX AccusoftFilters::SetDitherToUse(pBMPOptions->GetDither()); //Mark Howitt, 24/10/97. Reset the FilterType as import uses FilterType as something else! AccusoftFilters::SetFilterType(pBMPOptions->GetFilterType()); #endif #endif }

BOOL BMPFilter::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/6/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 file 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 685 of file bmpfiltr.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); if (IsCompressed) { // We want compression on so turn it on if (!pFile->SetCompression(TRUE)) return FALSE; } // Read from file, no header and using pFilter for progress bar updates if (!DIBUtil::ReadFromFile(pFile, pInfo, pBytes, FALSE, NULL, pFilter)) return FALSE; if (IsCompressed) { // We have finished with compression, so turn it off if (!pFile->SetCompression(FALSE)) return FALSE; } // Everything went ok and we imported the bitmap ok return TRUE; }

BOOL BMPFilter::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: 18/8/95 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 736 of file bmpfiltr.cpp. { ERROR2IF(pOilBitmap == NULL,FALSE,"BMPFilter::ReadFromFile null OilBitmap pointer"); // Try to import bitmap as usual binary BMP file. // The only problem is that if the user has chosen to use the BMP filter explicitly // then this may not be what they really want. The BMP filter may not cope with all // BMP types, whereas we may possibly have an AccusoftFilter which might cope better. // If the user has not chosen explicitly then the BMP will be directed towards the // correct filter by the HowCompatible call. // Generally, if the filter has been chosen at this point then HowCompatible will have // been called and so we can ask the BMP filter what it found when asked this and use // this result to determine whether to load the file or not. UINT32 ImportMsgId = GetImportMsgID(); String_64 ProgressString(ImportMsgId); CCLexFile *pImportFile = GetImportFile(); ERROR2IF(pImportFile==NULL,FALSE,"BMPFilter::ReadFromFile - No import file"); ProgressString = GetImportProgressString(pImportFile, ImportMsgId); CWxBitmap* pWBitmap = (CWxBitmap*)pOilBitmap; LPBITMAPINFO *pInfo = &(pWBitmap->BMInfo); LPBYTE *pBytes = &(pWBitmap->BMBytes); PORTNOTE("ExtFilt", "Removed use of external filters") #if !defined(EXCLUDE_FROM_RALPH) && !defined(EXCLUDE_FROM_XARALX) #ifndef WEBSTER if ( (GetBmpCompatibility() == 10) || (AccusoftFilters::GetVersionNumber() == 0) ) { // The BMP filter liked it very much and so use it, showing progress bar if (!DIBUtil::ReadFromFile(pImportFile, pInfo, pBytes, TRUE, &ProgressString)) return FALSE; } else { // The BMP filter was not totally sure about that file and so we should try and // see if the Accusoft loader is present and if so give this an attempt at // loading that file. // Get a cast version of a pointer to the filter PORTNOTE("ExtFilt", "Removed use of external filters") #ifndef EXCLUDE_FROM_XARALX if (!AccusoftFilters::ReadFromFile(pImportFile, pInfo, pBytes, TRUE, &ProgressString)) return FALSE; #endif } #else //WEBSTER //WEBSTER-Martin-07/01/97 all we can do is try to read it if (!DIBUtil::ReadFromFile(pImportFile, pInfo, pBytes, TRUE, &ProgressString)) return FALSE; #endif //WEBSTER #else //EXCLUDE_FROM_RALPH if (!DIBUtil::ReadFromFile(pImportFile, pInfo, pBytes, TRUE, &ProgressString)) return FALSE; #endif //EXCLUDE_FROM_RALPH // Everything went ok and we imported the bitmap ok SetLastBitmap(); // can only import one bitmap at the moment return TRUE; }

void BMPFilter::SetDefaultExportDepth (  UINT32  Depth  )  [static]

Allows other bitmap export filters to set this value. Needs to be here rather than in BaseBitmapFilter as that Init is never used. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 17/11/94 Parameters: The  new value to set for the DefaultExportDepth [INPUTS] None  [OUTPUTS] Returns: None See also: BMPFilter::Init; BMPFilter::GetDefaultExportDepth; BMPFilter::GetDefaultExportDPI; Definition at line 558 of file bmpfiltr.cpp. { DefaultExportDepth = Depth; }

void BMPFilter::SetDefaultExportDither (  UINT32   )  [static]

Definition at line 588 of file bmpfiltr.cpp. { DefaultExportDither = Dither; }

void BMPFilter::SetDefaultExportDPI (  double  DPI  )  [static]

Allows other bitmap export filters to set this value. Needs to be here rather than in BaseBitmapFilter as that Init is never used. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 17/11/94 Parameters: The  new value to set for the DefaultExportDpi [INPUTS] None  [OUTPUTS] Returns: None See also: BMPFilter::Init; BMPFilter::GetDefaultExportDepth; BMPFilter::GetDefaultExportDPI; Definition at line 578 of file bmpfiltr.cpp. { DefaultExportDPI = DPI; }

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

Physically put the bitmap into the disk. Inherited classes override this to write in different file formats. This is used by the native/web format to output the actual bitmap data content of a bitmap definition record. The function can assume that the CCFile is open and ready for writing and must use the functions provided by pFilter to update the progress system. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 20/6/96 Parameters: pKernelBitmap  - Pointer to the bitmap to be exported. [INPUTS] pFilter - Pointer to the BaseCamelot filter which provides progress functions pFile - Pointer to the CCFile class to use for export Compression - used to flag how much compression of the data is required. Returns: TRUE if worked, FALSE if errored. See also: BitmapListComponent::SaveBitmapDefinition; Reimplemented from BaseBitmapFilter. Definition at line 1452 of file bmpfiltr.cpp. { #ifdef DO_EXPORT ERROR2IF(pKernelBitmap == NULL,FALSE, "BMPFilter::WriteBitmapToFile null pKernelBitmap"); ERROR2IF(pFilter == NULL,FALSE, "BMPFilter::WriteBitmapToFile null pFilter"); ERROR2IF(pFile == NULL,FALSE, "BMPFilter::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,"BMPFilter::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; // We never worry about compresion of bmps for the present moment // Just changed that so we zlib the bitmaps // Start up the compressor BOOL Ok = pFile->InitCompression(); if (!Ok) return FALSE; // Now start the compression pFile->SetCompression(TRUE); // Write to file, no header and using pFilter for progress bar updates ok = DIBUtil::WriteToFile(pFile, Info, Bytes, NULL, FALSE, pFilter); // Now that we have finished, close the compressor down pFile->SetCompression(FALSE); return ok; #else return FALSE; #endif }

BOOL BMPFilter::WriteBitmapToFile (  KernelBitmap *  pKernelBitmap, double  TheDpi )  [protected, virtual]

Physically put the bitmap into the disk. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 25/4/95 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 1378 of file bmpfiltr.cpp. { #ifdef DO_EXPORT ERROR2IF(pKernelBitmap == NULL,FALSE,"BMPFilter::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,"BMPFilter::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; // Now, save the data out showing the correct progress string String_64 ProgressString(ExportingMsgID); BOOL ok = FALSE; // If the user has chosen a compressed BMP then we must use the Accusoft code, // if it is present as the built in one cannot do RLE compression. //WEBSTER-Martin-07/01/97 #ifndef WEBSTER PORTNOTE("ExtFilt", "Removed use of external filters") #ifndef EXCLUDE_FROM_XARALX BOOL Compression = FALSE; UINT32 Bpp = pWBitmap->GetBPP(); if ( (DefaultExportCompression && (Bpp == 4)) || (DefaultExportCompression && (Bpp == 8)) ) { // Set Compression TRUE and force the Accusoft filter type to be compressed. Compression = TRUE; AccusoftFilters::SetFilterType(BMP_COMPRESSED); AccusoftFilters::SetExportDpi(TheDpi); } if ( Compression && (AccusoftFilters::GetVersionNumber() > 0) ) ok = AccusoftFilters::WriteToFile(OutputFile, Info, Bytes, &ProgressString); else #endif #endif //WEBSTER ok = DIBUtil::WriteToFile(OutputFile, Info, Bytes, &ProgressString); return ok; #else return FALSE; #endif }

BOOL BMPFilter::WriteDataToFile (  BOOL  End, UINT32  Bpp, UINT32  Compression )  [protected, virtual]

Physically put the bitmap into the disk. NOTE - ONLY COPES WITH End=TRUE currently End is ignored now and should always be set to TRUE. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 16/3/95 Parameters: End  - TRUE if this is the last block of the file. [INPUTS] Bpp - output depth in terms of bits per pixel Compression - True if compression required, False otherwise Returns: TRUE if worked, FALSE if errored. See also: WriteToFile(); AccusoftFilters::WriteToFile; AccusoftFilters::WriteDataToFile; Definition at line 1093 of file bmpfiltr.cpp. { #ifdef DO_EXPORT if (GeneratingOptimisedPalette()) return TRUE; // No need to output anything BMPExportOptions* pBMPOptions = (BMPExportOptions*)GetBitmapExportOptions(); ERROR2IF(pBMPOptions == NULL, FALSE, "NULL Args"); ERROR3IF(!pBMPOptions->IS_KIND_OF(BMPExportOptions), "pBMPOptions isn't"); LPBITMAPINFO lpBitmapInfo; LPBYTE lpBits; // Get the bitmap data from the Render Region ExportRegion->GetBitmapData(&lpBitmapInfo, &lpBits); ERROR3IF(lpBitmapInfo == NULL, "Bitmap has no info in BMPFilter::WriteDataToFile"); if (lpBitmapInfo == NULL) return FALSE; ERROR3IF(lpBits == NULL, "Bitmap has no data in BMPFilter::WriteDataToFile"); if (lpBits == NULL) return FALSE; // First time through, lets write out a suitable header. // As we write it in one big chunk (currently), its easy // If we are rendering in strips then the bitmap information in the render region will // be set for the height of the strip and not the height of the entire bitmap. if (!WrittenHeader) { WrittenHeader = TRUE; LPBITMAPINFO lpInfo = lpBitmapInfo; LPLOGPALETTE lpPalette = NULL; ERROR2IF(lpInfo==NULL,FALSE,"BMPFilter::WriteDataToFile null export region bitmap"); // Set up some useful variables giving details on the bitmap to save const UINT32 OutputDepth = Bpp; // First, get the size of the bitmap we are going to export not just the simple // lpInfo->bmiHeader.biHeight as this might just be the height of the first // strip to be exported. With the width we can use the old method. // const UINT32 OutputWidth = lpInfo->bmiHeader.biWidth; const UINT32 OutputHeight = (INT32)ExportRegion->GetFullRegionHeight(); TRACEUSER( "Neville", _T("BMPFilter::WriteDataToFile Total output height = %d\n"),OutputHeight); TRACEUSER( "Neville", _T("BMPFilter::WriteDataToFile height of 1st strip = %d\n"),lpInfo->bmiHeader.biHeight); if (OutputDepth==8 || OutputDepth==4 || OutputDepth==1 ) { // SMFIX lpPalette = pBMPOptions->GetLogicalPalette(); /* if (pOptimisedPalette) { lpPalette = pOptimisedPalette; TRACEUSER( "Will", _T("BMP filter is using an Optimised Palette\n")); } else { GDrawContext *GDC = GRenderRegion::GetDrawContext(); // In the 4 or 1 bpp this will not necessarily be the palette that we // should export with as it will just be the default 8bpp palette. // Must tell it what depth (BPP) we want. The other information is superfluous // at present as this should be called again when the info is correct. GDC->SetupBitmap(OutputWidth, OutputHeight, OutputDepth, NULL ); // WEBSTER - markn 8/2/97 // Centralised the palette creation code for all bitmap filters lpPalette = Create8bppPalette(); if (OutputDepth == 1) { // The easy one, I think black and white might be the correct choice here! OutputDIB::FixBlackAndWhitePalette(lpPalette); } else if (OutputDepth == 4) { // Bit more tricky this one, Gavin uses a fixed 16 colour palette OutputDIB::Fix16ColourPalette(lpPalette); } } */ } // Set up the compression flag only if the output depth is correct UINT32 Compress = BI_RGB; if (OutputDepth==4 && Compression) Compress = BI_RLE4; if (OutputDepth==8 && Compression) Compress = BI_RLE8; if (!DestDIB.StartFile( OutputFile, &lpInfo->bmiHeader, // pointer to BITMAPINFOHEADER lpPalette, OutputDepth, // actual file depth Compress, // compression (BI_RGB = none) OutputHeight, // all of it SizeOfExport, // progress bar size FALSE, pBMPOptions->GetDither() ) ) { // if (lpPalette != pOptimisedPalette) // CCFree(lpPalette); return FALSE; } // if (lpPalette != pOptimisedPalette) // CCFree(lpPalette); } if (!End) { ENSURE(FALSE, "WriteToFile cannot do segmented writes"); return FALSE; } // now lets write out our block const UINT32 StripHeight = lpBitmapInfo->bmiHeader.biHeight; if (!DestDIB.WriteBlock( 0, // Ypos StripHeight, // height of this strip lpBits, // pointer to actual bitmap data 32, // input bpp ProgressOffset // value to add to progress bar updats ) ) return FALSE; // Add in the height of the strip that we have just exported to the progress offset value ProgressOffset += StripHeight; #endif return TRUE; }

BOOL BMPFilter::WriteToFile (  BOOL  End  )  [protected, virtual]

Physically put the bitmap into the disk. NOTE - ONLY COPES WITH End=TRUE currently Most of the work now is down by WriteDataToFile as this is a static form and there is a similar version in the Accusoft DLL. This can therefore be used to pass work onto the Accusoft DLL, for the cases we don't cope with. End is ignored now and should always be set to TRUE. Author: Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com> Date: 28/6/94 Parameters: End  is TRUE if this is the last block of the file. [INPUTS] Returns: TRUE if worked, FALSE if errored. See also: WriteDataToFile(); AccusoftFilters::WriteToFile; AccusoftFilters::WriteDataToFile; Reimplemented from BaseBitmapFilter. Definition at line 997 of file bmpfiltr.cpp. { #ifdef DO_EXPORT // Functionality transferred to new static function so that we can share // the work between this built in BMP filter and the external Accusoft DLL. // if we are at the low depths of the bpp range then use the Accusoft DLL as on // 8 and 4 bpp the user may have chosen RLE compression and this filter cannot // cope with that. // Of course, only use the Accusoft DLL if it is present. if ( ExportViaAccusoftFilters() ) #ifndef WEBSTER { PORTNOTE("ExtFilt", "Removed use of external filters") #ifndef EXCLUDE_FROM_XARALX // Graeme (26-1-00) - I've added a call to the static SetFilterType method in the // AccusoftFilters class to set up the bitmap type to be an uncompressed bitmap. // This line isn't strictly necessary - the filter contains code to catch an unset // FilterType value, and set it to BMP_UNCOMPRESSED, but there potentially could be // problems if a JPEG or GIF value is passed in. Besides, it stops Camelot from // throwing an error message in debug builds, which adds just a little polish. AccusoftFilters::SetFilterType ( BMP_UNCOMPRESSED ); return AccusoftFilters::WriteDataToFile ( End, DefaultExportDepth, DefaultExportCompression, GetBitmapExportOptions()); #else return FALSE; #endif } #else //WEBSTER-Martin-07/01/97 return FALSE; #endif else return WriteDataToFile(End, DefaultExportDepth, DefaultExportCompression); #else return FALSE; #endif }

---

Member Data Documentation

INT32 BMPFilter::BMPHowCompatible [protected]

Definition at line 227 of file bmpfiltr.h.

OutputDIB BMPFilter::DestDIB [static, protected]

Definition at line 224 of file bmpfiltr.h.

---

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

• wxOil/bmpfiltr.h (r1785/r1282)
• wxOil/bmpfiltr.cpp (r1785/r1282)

---