TI_GIFFilter Class Reference

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

#include <giffiltr.h>

Inheritance diagram for TI_GIFFilter:

List of all members.

Public Member Functions
	TI_GIFFilter ()
	Allows a default GIF type to be remembered for the next export GIF operation. Constructor for an TI_GIFFilter object. The object should be initialised before use.
virtual BOOL	Init ()
	Initialise an TI_GIFFilter object.
virtual INT32	HowCompatible (PathName &Filename, ADDR HeaderStart, UINT32 HeaderSize, UINT32 FileSize)
	Determine if this filter can load the specified file.
virtual BOOL	IsDefaultDocRequired (const TCHAR *pcszPathName)
	Is called when a TIFF or GIF is opened, to let us say whether we need a default document.
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. It is also used for extracting previews. 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)
	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	SaveExportBitmapsToFile (CCLexFile *pFile, PathName *pPath, BitmapExportParam *pParam, BOOL DontShowFileName=FALSE)
	Exports the bitmaps specified by the BitmapExportParam object to a multi- image capable filter. Each of the bitmaps will be saved to file using the settings specified.
void	AlterPaletteContents (LPLOGPALETTE pPalette)
virtual BOOL	IsThisBppOk (UINT32 Bpp)
	Check if this Bitmap filter can cope with saving at this Bpp/Colour depth.
INT32	GetGifCompatibility ()
	Determine if this filter can load the specified file.
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 BOOL	ShouldReuseExistingBitmaps ()
	Determines whether or not to re-use existing bitmap. Animation Import will say no, so that frames that are same still appear more than once.
virtual void	PostGetExportOptions (BitmapExportOptions *pOptions)
Protected Member Functions
virtual BitmapImportOptions *	CreateImportOptions () const
	Overrides base class to provide GIF specific options.
virtual BitmapExportOptions *	CreateExportOptions () const
	Allows derived classes to override this function to provide their own class derived from BitmapExportInfo containing filter specific information.
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 UINT32	GetHintType (void)
	Base class sets bad so no hint is set.
virtual BOOL	GetExportOptions (BitmapExportOptions *pOptions)
	See BaseBitmapClass for interface details Notes: Initializes GIF specific members Scope: Protected.
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 an optimised palette has been generated.
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.
virtual BOOL	AddOffsetFromBitmap (DocCoord *pOffset)
	When loading in a bitmap, the bitmap definition may conatin an offset. We need to add this to the offset that we are given so that the bitmap is loaded at the correct position. This uses the class variables that were set up during the GIF loading process to add the offset onto the import position.
virtual BOOL	SetFlagsFromBitmap (Layer *pLayer, KernelBitmap *pBitmap, UINT32 nBitmapToRead)
	When loading in multiple bitmaps and placing them on new layers, we should give the filter an opportunity to set the layer flags from the bitmap. In the case of a GIF filter this would allow it to set the solid and overlay flags.
virtual BOOL	SetAnimationPropertiesFromLoaded (Spread *pSpread)
	When loading in multiple bitmaps and placing them on new layers, we should give the filter an opportunity after all the bitmaps have been loaded, to go and look at the bitmaps and set the animation properties accordingly. In the case of a GIF filter this would allow it to set the dithering to none and the palette to something closer to what has been loaded. Assumes that each bitmap has been added to a separate layer and that the referenced bitmap in the layer is set to this loaded bitmap.
virtual BOOL	GetDragAndDropTranslation (ImportPosition *pPos, DocRect BoundsRect, Coord *Offset)
	Given an drag'n'drop point (in pPos), calculate the translation necessary to position the imported objects at this position on the spread. It ensures that bounding rectangles smaller than the spread are wholly contained within the spread. i.e. if you drag a file right to the edge of a spread, the translation will move it closer to the centre of the spread so that it is wholly contained within the spread.
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 *File, LPBITMAPINFO Info, LPBYTE Bits, String_64 *ProgressString=NULL)
	Write a bitmap in memory straight out as a GIF 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 *File, LPBITMAPINFO Info, LPBYTE Bits, BOOL Interlace, INT32 Transparent, BaseCamelotFilter *pFilter=NULL)
	Write a bitmap in memory straight out as a GIF 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 native/web file format to save a bitmap as a GIF directly into the file. Hence why it needs to be completely different to the version below which is used for extras like saving animated gifs. (caller should close file).
Protected Attributes
INT32	GIFHowCompatible
BOOL	m_DoingAnimation
UINT32	m_AnimationFrame
UINT32	Export2ndStageMsgID
UINT32	m_LeftOffset
UINT32	m_TopOffset
GIFDisposalMethod	m_PreviousMethod
Static Protected Attributes
static OutputGIF	DestGIF
static FilterType	s_FilterType = GIF
Private Member Functions
	CC_DECLARE_DYNAMIC (TI_GIFFilter)

---

Detailed Description

Encapsulates a Windows GIF export and import 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:

24/4/95

Definition at line 235 of file giffiltr.h.

---

Constructor & Destructor Documentation

TI_GIFFilter::TI_GIFFilter (   )

Allows a default GIF type to be remembered for the next export GIF operation. Constructor for an TI_GIFFilter object. The object should be initialised before use. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 24/4/95 See also: TI_GIFFilter::Init Definition at line 621 of file giffiltr.cpp. : MaskedFilter() { ImportMsgID = _R(IDN_IMPORTMSG_GIF); Flags.CanImport = TRUE; #ifndef STANDALONE Flags.CanExport = TRUE; Flags.CanExportMultipleImages = TRUE; #else Flags.CanExport = FALSE; Flags.CanExportMultipleImages = FALSE; #endif FilterID = FILTERID_TI_GIF; ExportMsgID = _R(IDN_EXPORTMSG_GIF); // "Preparing GIF file..." ExportingMsgID = _R(IDN_EXPORTINGMSG_GIF); // "Exporting GIF file..." // Special Mask prepartion stage ID Export2ndStageMsgID = _R(IDN_MASKINGMSG_GIF); // "Preparing mask for GIF file..." ExportRegion = NULL; // Initalise flags m_DoingAnimation = FALSE; m_AnimationFrame = 0; m_LeftOffset = 0; m_TopOffset = 0; m_PreviousMethod = GDM_BACKTOBACK; }

---

Member Function Documentation

BOOL TI_GIFFilter::AddOffsetFromBitmap (  DocCoord *  pOffset  )  [protected, virtual]

When loading in a bitmap, the bitmap definition may conatin an offset. We need to add this to the offset that we are given so that the bitmap is loaded at the correct position. This uses the class variables that were set up during the GIF loading process to add the offset onto the import position. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 15/5/97 Parameters: pOffset  the present offset in the bitmap [INPUTS] Returns: TRUE if was ok, FALSE otherwise. Reimplemented from BaseBitmapFilter. Definition at line 1049 of file giffiltr.cpp. { if (pOffset && m_LeftOffset >= 0 && m_TopOffset >= 0) { // GIFs have no concept of DPI so assume 96 const UINT32 dpi = 96; // We have been told how many pixels to offset by so we should just // multiply by 72000 millipoints per inch and then divide by the pixels per inch or dpi. MILLIPOINT ExtraOffsetX = (m_LeftOffset * 72000) / dpi; MILLIPOINT ExtraOffsetY = (m_TopOffset * 72000) / dpi; // Add these offsets onto the one that is passed in pOffset->x += ExtraOffsetX; // Remember, we have been told the offset from the top, so we need to move downwards pOffset->y -= ExtraOffsetY; } return TRUE; }

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

Reimplemented from BaseBitmapFilter. Definition at line 2326 of file giffiltr.cpp. { DestGIF.AlterExportPalette( pPalette ); }

TI_GIFFilter::CC_DECLARE_DYNAMIC (  TI_GIFFilter   )  [private]

void TI_GIFFilter::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: 25/9/95 See also: BaseBitmapFilter::PrepareToExport(); BaseBitmapFilter::CleanUpAfterExport(); Scope: Protected Reimplemented from BaseBitmapFilter. Reimplemented in MakeBitmapFilter. Definition at line 1156 of file giffiltr.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; } // reset the filter settings, as the preview export might have messed with them // 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 * TI_GIFFilter::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. Reimplemented in MakeBitmapFilter. Definition at line 2497 of file giffiltr.cpp. { GIFExportOptions* pGIFOptions = new GIFExportOptions(TI_GIF, &FilterName); return (BitmapExportOptions*)pGIFOptions; }

BitmapImportOptions * TI_GIFFilter::CreateImportOptions (   )  const [protected, virtual]

Overrides base class to provide GIF specific options. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Definition at line 695 of file giffiltr.cpp. { GIFImportOptions* pOptions = new GIFImportOptions; return (BitmapImportOptions*)pOptions; }

BOOL TI_GIFFilter::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: 12/5/95 Parameters: -  [INPUTS] Returns: TRUE if worked, FALSE if failed. Reimplemented from BaseBitmapFilter. Reimplemented in MakeBitmapFilter. Definition at line 1379 of file giffiltr.cpp. { #ifndef STANDALONE if (GeneratingOptimisedPalette()) return TRUE; // No need to output anything // Can reset the band number now. m_BandNumber = 0; GIFExportOptions* pGIFOptions = (GIFExportOptions*)GetBitmapExportOptions(); ERROR2IF(pGIFOptions == NULL, FALSE, "NULL Args"); ERROR3IF(!pGIFOptions->IS_KIND_OF(GIFExportOptions), "pGIFOptions isn't"); TRACEUSER( "Neville", _T("TI_GIFFilter::EndWriteToFile\n")); // Do the transparency translation just before we write out the data as a GIF. // 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 if (BadExportRender) { // Delete our whitearea bitmap if (pTempBitmapMask != NULL) CCFree(pTempBitmapMask); pTempBitmapMask = NULL; } BOOL ok = TRUE; BOOL SaveDataOut = TRUE; BOOL WantTransparent = pGIFOptions->WantTransparent(); BOOL WantInterlaced = pGIFOptions->WantInterlaced(); // Save the data out if required. Only if we exported ok. if (SaveDataOut && !BadExportRender) { // Now that we know the transparent index we can output the GIF header if (ok) { // Work out whether we should save as GIF87 or GIF89 // If we are using animation or transparency then save out as GIF89 BOOL Enhanced = m_DoingAnimation || WantTransparent; if (m_DoingAnimation) { if (m_AnimationFrame == 0) { // We force a transparent colour of -1 so the transparent index colour is not changed to white in the global colour table. ok = DestGIF.OutputGifFileHeader(OutputFile, Enhanced, -1); if (ok) { // Shall we output a Loop block ? // We only put a loop block in if the loop count is 0, or > 1 // and we subtract 1 from values other than 0, so that the // loop count represent the number of times the animation // is 'played' rather than 'repeated' .... // // ie. 0, loop block with value 0. Repeat forever. // 1, no loop block. One shot animation. // 2, loop block with value 1. Plays animation 2 times. // 3, loop block with value 2. Plays animation 3 times. // 4, loop block with value 3. Plays animation 4 times. // etc ... UINT32 LoopCount = pGIFOptions->GetAnimationLoopCount(); if (LoopCount != 1) { if (LoopCount > 1) LoopCount -= 1; // Output a loop block then ... ok = DestGIF.OutputAnimationControl(OutputFile, LoopCount); } } } } else { ok = DestGIF.OutputGifFileHeader(OutputFile, Enhanced, pGIFOptions->GetTransparencyIndex()); } } // 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 // Andy, 13-12-00: removed progress bar. // It goes by very quickly compared with the main rendering jobbie. // Also removed corresponding ContinueSlowJob from OutputGIF::BumpPixel if (ok) { String_64 ProgressString(ExportingMsgID); ProgressString = GetExportProgressString(OutputFile, ExportingMsgID); //BeginSlowJob(100, FALSE, &ProgressString); if (ok && (WantTransparent || m_DoingAnimation || WantInterlaced)) { ok = DestGIF.OutputGifImageExtensionHeader(OutputFile, WantInterlaced, pGIFOptions->GetTransparencyIndex(), m_DoingAnimation ? pGIFOptions->GetAnimationDelay() : 0, m_DoingAnimation ? pGIFOptions->GetAnimationRestore() : 0); } // if we are doing an animation with an optimised palette then we will need // save out this palette as a local colour table (the first frame uses the global table) BOOL OutputLocalColourTable = (m_DoingAnimation && pOptimisedPalette != NULL && m_AnimationFrame != 0); if (ok) ok = DestGIF.OutputGifImageBits(OutputFile, DestGIF.GetDestBitmapBits(), WantInterlaced, OutputLocalColourTable); //EndSlowJob(); } } return ok; #else return TRUE; #endif }

BOOL TI_GIFFilter::GetDragAndDropTranslation (  ImportPosition *  pPos, DocRect  BoundsRect, Coord *  Offset )  [protected, virtual]

Given an drag'n'drop point (in pPos), calculate the translation necessary to position the imported objects at this position on the spread. It ensures that bounding rectangles smaller than the spread are wholly contained within the spread. i.e. if you drag a file right to the edge of a spread, the translation will move it closer to the centre of the spread so that it is wholly contained within the spread. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> based on Tim function Date: 15/5/97 Parameters: pSpread  - the spread to check against. [INPUTS] BoundsRect - the bounding rectangle to check (in spread coordinates). Offset  - [OUTPUTS] Returns: TRUE if the bounding rectangle is smaller than the spread => Offset now contains the translation necessary to position the objects correctly. FALSE if bounding rectangle is bigger than the spread, or pPos was NULL. In either case, a FALSE return results in Offset containing (0,0). Used by the import filters for drag'n'drop to ensure that after the imported objects are translated to the drop point, they are all still on the spread. See also: Filter::DoImport Reimplemented from Filter. Definition at line 882 of file giffiltr.cpp. { // First check to se if we actually have a drag and drop point. if (pPos == NULL || pPos->pSpread == NULL) { // No - set offset to 0 and return FALSE to indicate we can't cope with this. Offset->x = 0; Offset->y = 0; return FALSE; } // Get the spread's bounding rectangle and convert it to spread coords. DocRect SpreadRect = pPos->pSpread->GetPasteboardRect(); pPos->pSpread->DocCoordToSpreadCoord(&SpreadRect); // Now check that the bounding rectangle is small enough to fit on the spread... if ((BoundsRect.Width() > SpreadRect.Width()) || (BoundsRect.Height() > SpreadRect.Height())) { // No - set offset to 0 and return FALSE to indicate we can't cope with this. Offset->x = 0; Offset->y = 0; return FALSE; } // Bounding box should be centred on drop point // This is the default way of doing it. We actually want the bounding box of the animation // centered on the drop point with the inidividual frames positioned inside this. // The x and y offsets are handled latter so we must just position the rectangle to the left // of the main animations' bounding box UINT32 GIFWidth = GIFUtil::GetGlobalWidth(); UINT32 GIFHeight = GIFUtil::GetGlobalHeight(); if (GIFWidth > 0 && GIFHeight > 0) { // GIFs have no concept of DPI so assume 96 const double dpi = 96.0; const INT32 PixelSize = (INT32) ((72000.0 / dpi) + 0.5); // Size of output pixel in millipoints // We have been told how many pixels the animation is in size so we should just // multiply by 72000 millipoints per inch and then divide by the pixels per inch or dpi. MILLIPOINT AnimationWidth = (INT32) (((GIFWidth * 72000.0) / dpi) + 0.5); MILLIPOINT AnimationHeight = (INT32) (((GIFHeight * 72000.0) / dpi) + 0.5); // Add these offsets onto the one that is passed in DocCoord Centre; Centre.x = (AnimationWidth) / 2; Centre.y = (AnimationHeight) / 2; // If the height or width is an odd number then we may be positioning on half pixel // boundaries. So snap to the nearest whole pixel boundary. Centre.x -= Centre.x % PixelSize; Centre.y -= Centre.y % PixelSize; Offset->x = -Centre.x; Offset->y = -Centre.y; // The bitmaps will now be so that their bottom left hand corner is at the corner // of the animation. So we need to move it up so that its top left hand corner is // at the top left of the animation. Offset->y += AnimationHeight - (BoundsRect.hi.y - BoundsRect.lo.y); } else { // No - set offset to 0 and return FALSE to indicate we can't cope with this. Offset->x = 0; Offset->y = 0; } // Transform the bounding rect to see if it's off the spread. BoundsRect.Translate(Offset->x, Offset->y); // If it's off the spread - limit it to the edge of the spread: // (a) Horizontal adjustment if (BoundsRect.lo.x < SpreadRect.lo.x) Offset->x += (SpreadRect.lo.x - BoundsRect.lo.x); else if (BoundsRect.hi.x > SpreadRect.hi.x) Offset->x -= (BoundsRect.hi.x - SpreadRect.hi.x); // (b) Vertical adjustment if (BoundsRect.lo.y < SpreadRect.lo.y) Offset->y += (SpreadRect.lo.y - BoundsRect.lo.y); else if (BoundsRect.hi.y > SpreadRect.hi.y) Offset->y -= (BoundsRect.hi.y - SpreadRect.hi.y); // Whatever happened, we can fit it on the spread. return TRUE; }

UINT32 TI_GIFFilter::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: 18/09/95 Returns: The id of the message to put on the progress display whilst exporting. See also: DoExport; Reimplemented from BaseBitmapFilter. Reimplemented in GrabFrameFilter, and MakeBitmapFilter. Definition at line 1326 of file giffiltr.cpp. { if (GeneratingOptimisedPalette()) return _R(IDS_GENOPTPALMSGID); // "Generating optimised palette..." GIFExportOptions* pGIFOptions = (GIFExportOptions*)GetBitmapExportOptions(); ERROR2IF(pGIFOptions == NULL, FALSE, "NULL Args"); ERROR3IF(!pGIFOptions->IS_KIND_OF(GIFExportOptions), "pGIFOptions isn't"); // If we are exporting with transparency on and on first pass use the masking message // otherwise use the exporting message. if (pGIFOptions->GetSelectionType() == SELECTION && pGIFOptions->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 GIF file..." else return Filter::GetExportMsgID(); // "Preparing GIF 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 GIF file..." else return Filter::GetExportMsgID(); // "Preparing GIF file..." } }

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

See BaseBitmapClass for interface details Notes: Initializes GIF specific members Scope: Protected. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Reimplemented from BaseBitmapFilter. Reimplemented in GrabFrameFilter, MakeBitmapFilter, and PreviewFilterGIF. Definition at line 1196 of file giffiltr.cpp. { //[MD] #ifndef STANDALONE ERROR2IF(pOptions == NULL, FALSE, "NULL Args"); GIFExportOptions* pGIFOptions = (GIFExportOptions*)pOptions; ERROR3IF(!pGIFOptions->IS_KIND_OF(GIFExportOptions), "pGIFOptions 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; // Default will range from 0 to 4 types which correspond to the combinations of // on/off interlaced and on/off transparent // Determine the filter type currently in use in Accusoft format s_FilterType = (pGIFOptions->GetSelectionType() == SOMEBITMAPS) ? TI_GIF_ANIM : TI_GIF; pGIFOptions->SetFilterType(s_FilterType); m_DoingAnimation = (pGIFOptions->GetSelectionType() == SOMEBITMAPS); // This is ok as we are using a modal dialog box BOOL Ok = FALSE; if (s_FilterType == TI_GIF) { 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"); } } else { #ifndef EXCLUDE_FROM_XARALX // invoke the dialog Ok = BmpPrefsDlg::InvokeDialog( pOptions); #endif } // Return with the ok/cancel state used on the dialog box return Ok; #else return FALSE; #endif }

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

Reimplemented from BaseBitmapFilter. Definition at line 249 of file giffiltr.h. { return TI_GIF; }

INT32 TI_GIFFilter::GetGifCompatibility (   )

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

UINT32 TI_GIFFilter::GetHintType (  void   )  [protected, virtual]

Base class sets bad so no hint is set. Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> Date: 27/07/97 Reimplemented from MaskedFilter. Definition at line 2515 of file giffiltr.cpp. { return(HINTTYPE_GIF); }

OutputDIB * TI_GIFFilter::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 DestGIF. Reimplemented from MaskedFilter. Definition at line 2480 of file giffiltr.cpp. { // Perform an upcast to allow the pointer to be used in a generic manner. return static_cast<OutputDIB*> ( &DestGIF ); }

INT32 TI_GIFFilter::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: 24/4/95 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 GIF file. 10 => It is a GIF file. Reimplemented from Filter. Definition at line 1923 of file giffiltr.cpp. { TRACEUSER( "Neville", _T("TI_GIFFilter::HowCompatible")); // 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. GIFHowCompatible = 0; // Check that we've got enough data to do our check // This is really sizeof(GIFINFOHEADER) but this returns 14 instead of 13 // as it rounds to the nearest word boundary const size_t GIFHeaderSize = sizeof(char)* 6 + sizeof(WORD) * 2 + sizeof(BYTE) * 3; if (HeaderSize < GIFHeaderSize) { // Not enough data - ignore this file. return 0; } // Check the header for the "GIF" signature. LPGIFINFOHEADER pHeader = (LPGIFINFOHEADER) HeaderStart; if ( ( strncmp( pHeader->giName, "GIF89a", 6 ) == 0 ) || ( strncmp( pHeader->giName, "GIF87a", 6 ) == 0 ) ) { // the other fields in the GIFINFOHEADER don't really hold any useful information // and really finding GIF87a/89a should be good enough to determine that there is // a high chance that this is a GIF file. // Remember what we thought in our class variable. GIFHowCompatible = 10; } else { // No GIF signature - we don't want this file. GIFHowCompatible = 0; } TRACEUSER( "Neville", _T("TI_GIFFilter::HowCompatible returning = %d\n"),GIFHowCompatible); // Return the found value to the caller. return GIFHowCompatible; }

BOOL TI_GIFFilter::Init (  void   )  [virtual]

Initialise an TI_GIFFilter object. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 24/4/95 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 PreviewFilterGIF. Definition at line 665 of file giffiltr.cpp. { // Get the OILFilter object pOILFilter = new GIFOILFilter(this); if (pOILFilter==NULL) return FALSE; // Load the description strings FilterName.Load(_R(IDN_FILTERNAME_GIF)); FilterInfo.Load(_R(IDN_GIF_FILTERINFO)); if (!GIFExportOptions::Declare()) { return FALSE; } // All ok return TRUE; }

BOOL TI_GIFFilter::IsDefaultDocRequired (  const TCHAR *  pcszPathName  )  [virtual]

Is called when a TIFF or GIF is opened, to let us say whether we need a default document. > virtual BOOL TI_GIFFilter::IsDefaultDocRequired(const TCHAR* pcszPathName); Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 5/11/97 We need to open GIFs into the Animated template (in case they're animated). We do this as follows: we tell the Document system that the next template to use is the animation template. Then we return TRUE so that this template is loaded. Not very elegant, but it works. Reimplemented from BaseBitmapFilter. Definition at line 2537 of file giffiltr.cpp. { //Tell the system to use the default animation template CCamDoc::SetNextTemplateToUse( CTemplateManager::GetDefaultAnimationTemplate() ); return TRUE; }

BOOL TI_GIFFilter::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. Reimplemented in MakeBitmapFilter. Definition at line 2097 of file giffiltr.cpp. { // Webster - RanbirR // Animated GIF's do not support 24 colour bitmaps. // However, allow this format here, since we later convert to 8 Bpp. return (Bpp == 24 || Bpp == 8 || Bpp == 4 || Bpp == 1); }

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

Reimplemented from BaseBitmapFilter. Definition at line 1274 of file giffiltr.cpp. { // should be of this type GIFExportOptions* pGIFOptions = (GIFExportOptions*)pOptions; ERROR3IF(!pGIFOptions->IS_KIND_OF(GIFExportOptions), "pGIFOptions isn't"); // do the baseclass options MaskedFilter::PostGetExportOptions(pOptions); // do the specific to this class options SetDepthToRender(pGIFOptions->GetDepth()); m_DoingAnimation = (pGIFOptions->GetSelectionType() == SOMEBITMAPS); // Filter type can be changed by the export options dialog box from say // TI_GIF to TI_GIF_INTERLACED UINT32 Silliness = pGIFOptions->WantTransparent() ? 2 : 0; Silliness |= pGIFOptions->WantInterlaced() ? 1 : 0; if (Silliness >= 0 && Silliness < 4) { Compression = Silliness; // Compression ranges from 0 .. 3 so map this onto our filter types // FilterID = Silliness + TI_GIF; switch (Silliness) { case 0: s_FilterType = TI_GIF; break; case 1: s_FilterType = TI_GIF_INTERLACED; break; case 2: s_FilterType = TI_GIF_TRANSPARENT; break; case 3: s_FilterType = TI_GIF_TRANSINTER; break; case 4: s_FilterType = TI_GIF_ANIM; break; } if (pGIFOptions->WantTransparent() && pGIFOptions->GetSelectionType() == SELECTION) DoingMask = TRUE; } }

BOOL TI_GIFFilter::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. It is also used for extracting previews. 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 (not used at the moment 20/01/97) 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 732 of file giffiltr.cpp. { ERROR2IF(pOilBitmap == NULL,FALSE,"TI_GIFFilter::ReadFromFile null OilBitmap pointer"); // no pFilter means we don't get a progress WEBSTER-Martin-20/01/97 // as we are calling this from BaseFileDialog::GetPreviewBitmapFromFile we don't have // a BaseCamelotFilter. However GIFUtil::ReadImage expects a 100% progress bar. // ERROR2IF(pFilter == NULL,FALSE,"TI_GIFFilter::ReadFromFile null pFilter pointer"); ERROR2IF(pFile == NULL,FALSE,"TI_GIFFilter::ReadFromFile null pFile pointer"); if (!pFilter) BeginSlowJob(-1); // GIFUtil::ReadImage expects a progress bar. // Try to import bitmap as usual binary BMP file. CWxBitmap* pWBitmap = (CWxBitmap*) pOilBitmap; LPBITMAPINFO *pInfo = &(pWBitmap->BMInfo); LPBYTE *pBytes = &(pWBitmap->BMBytes); // Set a default transparent colour INT32 TransColour = -1; SetTransColour(TransColour); // Blank the offsets just in case m_LeftOffset = 0; m_TopOffset = 0; // Read from file, no header and using pFilter for progress bar updates // 20/01/97 In fact pFilter is not used so NULL ptr ok if (!GIFUtil::ReadFromFile(pFile, pInfo, pBytes, &TransColour, NULL, pFilter)) { if (!pFilter) EndSlowJob(); 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 if (!pFilter)