JPEGExportFilter Class Reference

Provides an Accusoft-free JPEG export filter. More...

#include <exjpeg.h>

Inheritance diagram for JPEGExportFilter:

List of all members.

Public Member Functions
	JPEGExportFilter ()
	Default constructor for a JPEGFilter object.
	~JPEGExportFilter ()
	Default destructor for a JPEGExportFilter object.
virtual BOOL	Init ()
	Initializes the JPEGExportFilter class.
INT32	HowCompatible (PathName &Filename, ADDR HeaderStart, UINT32 HeaderSize, UINT32 FileSize)
virtual BOOL	IsThisBppOk (UINT32 Bpp)
	Overriden for JPEG specifics: supports 24 & 8.
virtual BOOL	WriteBitmapToFile (KernelBitmap *pKernelBitmap, double Dpi)
	To duplicate code.
virtual BOOL	WriteBitmapToFile (KernelBitmap *pKernelBitmap, BaseCamelotFilter *pFilter, CCLexFile *pFile, INT32 Compression)
BOOL	WriteBitmapSource (BitmapSource *Source, UINT32 Height, BaseCamelotFilter *pThisFilter, CCLexFile *pCCFile)
	Writes out the given BitmapSource to this file.
BOOL	DoExportBitmapWithOptions (Operation *pOp, CCLexFile *pFile, PathName *pPath, KernelBitmap *pBitmap, BitmapExportOptions *pOptions)
	Exports the specified bitmap straight out to file with none of the rendering that DoExport does. Uses the virtual fns of the inherited class. Do not override unless really necessary. Similar to DoExportBitmap in the base class, but uses the passed options, rather then invoking a dialog to get ones.
virtual BitmapExportOptions *	CreateExportOptions () const
	Overrides base class to provide JPEGExportOptions See Also: BaseBitmapFilter::CreateExportOptions().
virtual void	PostGetExportOptions (BitmapExportOptions *pOptions)
Protected Member Functions
virtual BOOL	SetExportHint (Document *pDoc)
	Overrides base class to set correct hint See Also: BaseBitmapFilter::SetExportHint().
virtual BOOL	GetRenderBottomToTop ()
	See BaseBitmapFilter for details Notes: From IJG docs: "Image data should be written in top-to-bottom scanline order. The JPEG spec contains some weasel wording about how top and bottom are application-defined terms (a curious interpretation of the English language...) but if you want your files to be compatible with everyone else's, you WILL use top-to-bottom order.".
virtual BOOL	GetExportOptions (BitmapExportOptions *pOptions)
	Overridden version provides JPEG export dialog Scope: Protected See Also: BaseBitmapFilter::GetBitmapExportOptions().
virtual BOOL	PrepareForOperation ()
	Support function to do something before any actual output.
virtual BOOL	PrepareToExport (Spread *pSpread, UINT32 Depth, double DPI, SelectionType Selection, UINT32 Dither)
BOOL	InternalPrepareToExport ()
	Support function setting up the IJG library options and starting the compression.
BOOL	EndWriteToFile (void)
	Overrides base class: does nothing See Also: BaseBitmapFilter::EndWriteToFile(void).
virtual BOOL	WriteFileHeader (void)
	To write out the file specific header data: actually sets up the JPEG filter.
virtual BOOL	WriteFrame (void)
	Overrides 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)
	Overrides base class to finish JPEG compression cycle of the current frame.
virtual void	CleanUpAfterExport ()
	Overridden to clean up JPEG specific mess.
BOOL	DoFilter (KernelBitmap *pKernelBitmap, CCLexFile *pFile)
BOOL	WriteRawBitmap (const ADDR &pBitmapData, const BMP_SIZE &Width, const BMP_SIZE &Height, const BMP_DEPTH &Depth, DIBConvert *pConverter)
	Support function for writing out the bitmap scanlines Called by WriteFrame() & WriteBitmap().
BOOL	InitErrorHandler ()
	Creates & initializes an error handler for this filter.
BOOL	InitFileHandler ()
	Creates & initializes a source data provider for this filter.
Filter *	GetFilterForUpdate () const
	Allows feedback to any primary filter.
BOOL	SetFilterForUpdate (Filter *const pFilterForUpdate)
	Sets the filter for any progress update on export Notes: Should be set to NULL for ordinary import.
BOOL	GetPostOperation () const
void	SetPostOperation (BOOL Value)
Protected Attributes
BOOL	m_bOldReportErrors
BOOL	m_bOldThrowExceptions
BOOL	m_PostOperation
Filter *	m_pFilterForUpdate
libJPEG::jpeg_compress_struct	m_cinfo
JPEGErrorManager *	m_pErrorHandler
JPEGDataDestination *	m_pDestinationHandler
Private Member Functions
	CC_DECLARE_DYNAMIC (JPEGExportFilter)

---

Detailed Description

Provides an Accusoft-free JPEG export filter.

Author:

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

Date:

29/10/96

Definition at line 196 of file exjpeg.h.

---

Constructor & Destructor Documentation

JPEGExportFilter::JPEGExportFilter (   )

Default constructor for a JPEGFilter object. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Definition at line 600 of file exjpeg.cpp. : BaseBitmapFilter() { // Initialize members for class Filter ExportMsgID = _R(IDS_EXPORTMSG_JPG); // "Preparing JPEG file..." ExportingMsgID = _R(IDS_EXPORTINGMSG_JPG); // "Exporting JPEG file..." Flags.CanImport = FALSE; Flags.CanExport = TRUE; Flags.CanExportMultipleImages = FALSE; Flags.ShowFilter = TRUE; FilterID = FILTERID_EXPORT_JPEG; // Initialize our class members m_bOldReportErrors = FALSE; m_bOldThrowExceptions = FALSE; m_pFilterForUpdate = NULL; m_pErrorHandler = NULL; m_pDestinationHandler = NULL; m_PostOperation = TRUE; }

JPEGExportFilter::~JPEGExportFilter (   )

Default destructor for a JPEGExportFilter object. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Definition at line 634 of file exjpeg.cpp. { if (m_pErrorHandler != NULL) delete m_pErrorHandler; if (m_pDestinationHandler != NULL) delete m_pDestinationHandler; }

---

Member Function Documentation

JPEGExportFilter::CC_DECLARE_DYNAMIC (  JPEGExportFilter   )  [private]

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

Overridden to clean up JPEG specific mess. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 See also: BaseBitmapFilter::CleanUpAfterExport() Reimplemented from BaseBitmapFilter. Definition at line 1477 of file exjpeg.cpp. { if (GetPostOperation()) { libJPEG::jpeg_destroy_compress(&m_cinfo); } if (m_pDestinationHandler != NULL) { delete m_pDestinationHandler; m_pDestinationHandler = NULL; } if (m_pErrorHandler != NULL) { delete m_pErrorHandler; m_pErrorHandler = NULL; } // Now call the baseclass version to do its stuff BaseBitmapFilter::CleanUpAfterExport(); }

BitmapExportOptions * JPEGExportFilter::CreateExportOptions (   )  const [virtual]

Overrides base class to provide JPEGExportOptions See Also: BaseBitmapFilter::CreateExportOptions(). Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Reimplemented from BaseBitmapFilter. Definition at line 1567 of file exjpeg.cpp. { JPEGExportOptions* pExportOptions = new JPEGExportOptions(JPEG, &FilterName); return (BitmapExportOptions*)pExportOptions; }

BOOL JPEGExportFilter::DoExportBitmapWithOptions (  Operation *  pOp, CCLexFile *  pFile, PathName *  pPath, KernelBitmap *  pBitmap, BitmapExportOptions *  pOptions )  [virtual]

Exports the specified bitmap straight out to file with none of the rendering that DoExport does. Uses the virtual fns of the inherited class. Do not override unless really necessary. Similar to DoExportBitmap in the base class, but uses the passed options, rather then invoking a dialog to get ones. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 25/4/95 Parameters: [INPUTS]  Returns: TRUE if worked, FALSE if failed. Reimplemented from BaseBitmapFilter. Definition at line 1690 of file exjpeg.cpp. { #ifdef DO_EXPORT ERROR2IF(pBitmap == NULL,FALSE,"BaseBitmapFilter::DoExportBitmap null bitmap pointer specified"); if (pOptions == NULL) { // Create a record of information about the export SetUpExportBitmapOptions(&pOptions, pBitmap, TRUE); } if (pOptions == NULL) return FALSE; // remember the old export options // BitmapExportOptions *pOldOptions = GetBitmapExportOptions(); // if (pOldOptions != NULL) // pOldOptions->RetrieveDefaults(); // Added by Craig Hamilton 11/9/00. // Make a copy of the old options since the pointer to the old options gets vaped by // SetExportOptions. The copy is used to reinitialise pOldOptions later. // BitmapExportOptions *tempOptions = pOldOptions->MakeCopy(); // End added. // set the new ones SetExportOptions(pOptions); pOptions->SetAsDefaults(); // Make a note of the Disk file we are to use OutputFile = pFile; // Note this pointer for later use pExportBitmap = pBitmap; // Note this ptr for use in JPEG export. JPEGExportOptions::SetKernelBitmap(pBitmap); // Get a pointer to the actual bitmap so that we can get some details from it. OILBitmap *pOilBitmap = pBitmap->ActualBitmap; ERROR2IF(pOilBitmap == NULL,FALSE,"BaseBitmapFilter::DoExportBitmap null oil bitmap pointer"); // Get the details from the specified bitmap BitmapInfo BmInfo; pOilBitmap->GetInfo(&BmInfo); GetBitmapExportOptions()->SetDepth(BmInfo.PixelDepth); // get the bitmaps bpp // Should really save the dpi when we load the file itself rather than doing // all this conversion with possible rounding errors. // Use the original size that has been calculated in the info header UINT32 PixWidth = BmInfo.PixelWidth; // UINT32 PixHeight = BmInfo.PixelHeight; MILLIPOINT RecWidth = BmInfo.RecommendedWidth; // MILLIPOINT RecHeight = BmInfo.RecommendedHeight; // double DPI = 0.0; if (PixWidth > 0) { //DPI = Mul32Div32( PixWidth, 72000, RecWidth ); GetBitmapExportOptions()->SetDPI((PixWidth * 72000.0)/(double)RecWidth); } BOOL ok = TRUE; // Used to open the file up before starting DoExport. But this meant a cancel on the export // options dialog had filled the file, if it was already present. So now up up here if // not open already. In the PreviewBitmap case the file will already be open. if (!pFile->isOpen()) { if (pFile->IsKindOf(CC_RUNTIME_CLASS(CCDiskFile))) { ok = OpenExportFile((CCDiskFile*) pFile, pPath); if (!ok) return FALSE; } else { TRACEUSER( "JustinF", _T("Tried to open non-CCDiskFile in BaseBitmapFilter::DoExportBitmap\n")); return FALSE; } } // Make a note of the Disk file we are to use OutputFile = pFile; // We do not use an export region so specify null. ExportRegion = NULL; // Actually write to the file, showing progress hourglass as we go ok = WriteBitmapToFile(pBitmap, GetBitmapExportOptions()->GetDPI()); if (ok) WriteFileEnd(); // All done - deallocate dynamic objects, stop the progress display/hourglass // and return success. (Also closes file). CleanUpAfterExport(); // restore the old export options // if (pOldOptions != NULL) // { // Added by Craig Hamilton 11/9/00. // With the call to SetExportOptions the memory pointed to by pOldOptions is vaped. // Use tempOptions to reinitialise or get an access violation. // pOldOptions = tempOptions->MakeCopy(); // End added. // SetExportOptions(pOldOptions); // pOldOptions->SetAsDefaults(); // } // restore the file OutputFile = pFile; return ok; #else return FALSE; #endif }

BOOL JPEGExportFilter::DoFilter (  KernelBitmap *  pKernelBitmap, CCLexFile *  pFile )  [protected]

Definition at line 885 of file exjpeg.cpp. { ERROR2IF(pKernelBitmap == NULL || pFile == NULL, FALSE, "NULL Args"); ERROR3IF(!pKernelBitmap->IS_KIND_OF(KernelBitmap), "pKernelBitmap isn't"); ERROR3IF(!pFile->IS_KIND_OF(CCLexFile), "pFile isn't"); JPEGExportOptions* pOptions = (JPEGExportOptions*)GetBitmapExportOptions(); if (pOptions == NULL) return FALSE; OILBitmap* pOily = pKernelBitmap->GetActualBitmap(); if (pOptions->GetJPEGPresentAndSelected()) { SetPostOperation(FALSE); // Get the origianl source. BitmapSource* pSource = NULL; BaseBitmapFilter* pDummyFilter; KernelBitmap* pBitmap = pOptions->GetKernelBitmap(); if (pBitmap == NULL) return FALSE; // set our KernelBitmap pointer to NULL. pOptions->SetKernelBitmap(NULL); pBitmap->GetOriginalSource(&pSource,&pDummyFilter); OILBitmap* pOILBitmap = pBitmap->ActualBitmap; if (pOILBitmap == NULL) return FALSE; BitmapInfo Info; pOILBitmap->GetInfo(&Info); UINT32 Height = Info.PixelHeight; // Write out the orginal JPEG image. if(WriteBitmapSource(pSource, Height, (BaseCamelotFilter*) pDummyFilter, pFile)) return TRUE; } else { BOOL bOK = FALSE; bOK = PrepareForOperation(); DIBConvert* pConverter = NULL; switch (pOily->GetBPP()) { case 8: if (pKernelBitmap->IsGreyscale()) { pOptions->SetColourModel(libJPEG::JCS_GRAYSCALE); } else { pOptions->SetColourModel(libJPEG::JCS_RGB); } break; case 24: case 32: pOptions->SetColourModel(libJPEG::JCS_RGB); break; default: ERROR3("DoFilter: invalid bpp"); bOK = FALSE; break; } // Create a converter from bitmap depth to export depth // pConverter = DIBConvert::Create(((WinBitmap*)pOily)->BMInfo, // (8 * pOptions->GetColourComponentCount())); pConverter = DIBConvert::Create(((CWxBitmap*)pOily)->BMInfo, (8 * pOptions->GetColourComponentCount())); if (bOK) { SetPixelWidth(pOily->GetWidth()); SetPixelHeight(pOily->GetHeight()); SetDepthToRender(pOily->GetBPP()); bOK = InternalPrepareToExport(); } if (bOK) { bOK = WriteRawBitmap( pKernelBitmap->GetBitmapBits(), GetPixelWidth(), GetPixelHeight(), pOily->GetBPP(), pConverter); } if (bOK) { bOK = WritePostFrame(); } if (pConverter != NULL) { delete pConverter; } CleanUpAfterExport(); // set our KernelBitmap pointer to NULL. pOptions->SetKernelBitmap(NULL); return bOK; } // set our KernelBitmap pointer to NULL. pOptions->SetKernelBitmap(NULL); return FALSE; }

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

Overrides base class: does nothing See Also: BaseBitmapFilter::EndWriteToFile(void). Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Reimplemented from BaseBitmapFilter. Definition at line 1461 of file exjpeg.cpp. { return TRUE; }

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

Overridden version provides JPEG export dialog Scope: Protected See Also: BaseBitmapFilter::GetBitmapExportOptions(). Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Reimplemented from BaseBitmapFilter. Reimplemented in PreviewFilterJPEG. Definition at line 1064 of file exjpeg.cpp. { #if !defined(EXCLUDE_FROM_RALPH) ERROR2IF(pOptions == NULL, FALSE, "NULL Args"); BOOL Ok = TRUE; // JPEGExportOptions* pJPEGOptions = (JPEGExportOptions*)pOptions; // ERROR3IF(!pJPEGOptions->IS_KIND_OF(JPEGExportOptions), "pJPEGOptions isn't"); OpDescriptor* pOpDes = OpDescriptor::FindOpDescriptor(OPTOKEN_GIFTABDLG); if (pOpDes != NULL) { // set up the data for the export options dialog OpParam Param( pOptions, 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_GIFTABDLG"); } /* if (Ok) { // If Ok used then set the new defaults pJPEGOptions->SetAsDefaults(); pJPEGOptions->SetDepth(24); // Always output at 24bpp SetDepthToRender(24); } */ // Return with the ok/cancel state used on the dialog box return Ok; #else return FALSE; #endif }

Filter * JPEGExportFilter::GetFilterForUpdate (   )  const [protected]

Allows feedback to any primary filter. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Returns: A pointer to the filter whose member IncProgressBarCount() is called during the export for progress update or NULL if no filter is to be used for such Definition at line 1642 of file exjpeg.cpp. { return m_pFilterForUpdate; }

BOOL JPEGExportFilter::GetPostOperation (   )  const [inline, protected]

Definition at line 261 of file exjpeg.h. {return m_PostOperation; }

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

See BaseBitmapFilter for details Notes: From IJG docs: "Image data should be written in top-to-bottom scanline order. The JPEG spec contains some weasel wording about how top and bottom are application-defined terms (a curious interpretation of the English language...) but if you want your files to be compatible with everyone else's, you WILL use top-to-bottom order.". Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Reimplemented from BaseBitmapFilter. Definition at line 701 of file exjpeg.cpp. { return FALSE; }

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

Reimplemented from Filter. Definition at line 208 of file exjpeg.h. {return 0;} // dummy implementation

BOOL JPEGExportFilter::Init (  void   )  [virtual]

Initializes the JPEGExportFilter class. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Returns: TRUE if the filter was initialized ok FALSE otherwise Reimplemented from BaseBitmapFilter. Reimplemented in PreviewFilterJPEG. Definition at line 655 of file exjpeg.cpp. { // Get the OILFilter object pOILFilter = new JPEGExportOILFilter(this); if (pOILFilter==NULL) return FALSE; // Load the description strings FilterName.Load(_R(IDS_JPG_IMP_FILTERNAME)); FilterInfo.Load(_R(IDS_JPG_IMP_FILTERINFO)); if (DeclareFilterPreferenceSection()) { Camelot.DeclarePref( NULL, g_szCompression, &g_DefaultCompression, 0, 100 ); Camelot.DeclarePref( NULL, g_szDCTMethod, (INT32*)&g_DefaultDCTMethod, 0, 2 ); Camelot.DeclarePref( NULL, g_szProgressive, &g_bExportProgressive, 0, 1 ); Camelot.DeclarePref( NULL, g_szOptimize, &g_bOptimizeCoding, 0, 1 ); Camelot.DeclarePref( NULL, g_szSmoothing, &g_Smoothing, 0, 100 ); // DeclarePreference(Compression); // DeclarePreference(DCTMethod); // DeclarePreference(Progressive); // DeclarePreference(Xppm); // DeclarePreference(Yppm); } // All ok return TRUE; }

BOOL JPEGExportFilter::InitErrorHandler (   )  [protected]

Creates & initializes an error handler for this filter. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Definition at line 1510 of file exjpeg.cpp. { if (m_pErrorHandler == NULL) { m_pErrorHandler = new JPEGErrorManager; if (m_pErrorHandler == NULL) { Error::SetError(_R(IDS_OUT_OF_MEMORY)); return FALSE; } } m_cinfo.err = m_pErrorHandler->GetErrorMgrStruct(); return TRUE; }

BOOL JPEGExportFilter::InitFileHandler (   )  [protected]

Creates & initializes a source data provider for this filter. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Definition at line 1536 of file exjpeg.cpp. { SetPostOperation(TRUE); if (m_cinfo.dest == NULL) { if (m_pDestinationHandler == NULL) { m_pDestinationHandler = new JPEGDataDestination(GetExportFile()); if (m_pDestinationHandler == NULL) { Error::SetError(_R(IDS_OUT_OF_MEMORY)); return FALSE; } } m_pDestinationHandler->Init(&m_cinfo); } return TRUE; }

BOOL JPEGExportFilter::InternalPrepareToExport (   )  [protected]

Support function setting up the IJG library options and starting the compression. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Returns: FALSE if failed else TRUE See also: PrepareToExport(), DoFilter() (callers) Definition at line 1180 of file exjpeg.cpp. { JPEGExportOptions* pExportInfo = (JPEGExportOptions*)GetBitmapExportOptions(); ERROR3IF(!pExportInfo->IS_KIND_OF(JPEGExportOptions), "pExportInfo isn't"); m_cinfo.image_width = GetPixelWidth(); m_cinfo.image_height = GetPixelHeight(); m_cinfo.in_color_space = pExportInfo->GetColourModel(); m_cinfo.input_components = pExportInfo->GetColourComponentCount(); try { libJPEG::jpeg_set_defaults(&m_cinfo); if (pExportInfo->DoAsProgressive()) { libJPEG::jpeg_simple_progression(&m_cinfo); } m_cinfo.density_unit = 1; // that's JFIF for DPI m_cinfo.X_density = UINT16 (pExportInfo->GetDPI()); m_cinfo.Y_density = UINT16 (pExportInfo->GetDPI()); libJPEG::jpeg_set_quality (&m_cinfo, pExportInfo->GetQuality(), TRUE); m_cinfo.optimize_coding = g_bOptimizeCoding; m_cinfo.smoothing_factor = g_Smoothing; // DCT algorithm preference m_cinfo.dct_method = pExportInfo->GetDCTMethod(); libJPEG::jpeg_start_compress(&m_cinfo, TRUE); // "TRUE" for complete JPEG interchange datastream } catch (...) { StringID errorString = m_pErrorHandler->GetStringIDForError(); Error::SetError(errorString); return FALSE; } return TRUE; }

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

Overriden for JPEG specifics: supports 24 & 8. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Parameters: See  BaseBitmapFilter for interface details [INPUTS] Reimplemented from BaseBitmapFilter. Definition at line 717 of file exjpeg.cpp. { return (Bpp == 24 || Bpp == 8); }

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

Reimplemented from BaseBitmapFilter. Definition at line 1119 of file exjpeg.cpp. { // should be of this type // do the baseclass options BaseBitmapFilter::PostGetExportOptions(pOptions); // do the specific to this class options pOptions->SetDepth(24); // Always output at 24bpp SetDepthToRender(24); }

BOOL JPEGExportFilter::PrepareForOperation (   )  [protected, virtual]

Support function to do something before any actual output. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Definition at line 1010 of file exjpeg.cpp. { // The error handling in the following should probably be replaced by exceptions at // some time, when somebody can decide on a standard. // Set up a JPEGErrorManager if (!InitErrorHandler()) { return FALSE; } // Initialize the main JPG library structure try { using namespace libJPEG; jpeg_create_compress(&m_cinfo); } catch (...) { StringID errorString = m_pErrorHandler->GetStringIDForError(); Error::SetError(errorString); return FALSE; } // Setup a JPEGDataDestination if (!InitFileHandler()) { return FALSE; } // Don't let the CCLexFile report errors or throw exceptions m_bOldThrowExceptions = GetExportFile()->SetThrowExceptions(FALSE); m_bOldReportErrors = GetExportFile()->SetReportErrors(FALSE); // Shouldn't have to do this PaletteType = PAL_STANDARD; // don't - HATE this SetDepthToRender(24); // immer but not necessarily what we get return TRUE; }

BOOL JPEGExportFilter::PrepareToExport (  Spread *  pSpread, UINT32  Depth, double  DPI, SelectionType  Selection, UINT32  Dither )  [protected, virtual]

Reimplemented from BaseBitmapFilter. Definition at line 1143 of file exjpeg.cpp. { if (!BaseBitmapFilter::PrepareToExport(pSpread, Depth, DPI, Selection, Dither)) { return FALSE; } SetFilterForUpdate(NULL); if (!((JPEGExportOptions*)GetBitmapExportOptions())->SetColourModel(libJPEG::JCS_RGB)) { ERROR2(FALSE,"Can't set colour model"); return FALSE; } if (!InternalPrepareToExport()) { return FALSE; } return TRUE; }

BOOL JPEGExportFilter::SetExportHint (  Document *  pDoc  )  [protected, virtual]

Overrides base class to set correct hint See Also: BaseBitmapFilter::SetExportHint(). Author: Gerry_Iles (Xara Group Ltd) <camelotdev@xara.com> Date: 27/07/97 Reimplemented from BaseBitmapFilter. Definition at line 1586 of file exjpeg.cpp. { BOOL Ok = TRUE; if (pDoc != NULL) { ExportHint* pHint = pDoc->GetExportHint(); ERROR3IF(pHint == NULL, "NULL ExportHint"); BitmapExportOptions* pBaseOptions = GetBitmapExportOptions(); ERROR3IF(pBaseOptions == NULL, "NULL Options"); if (pHint != NULL && pBaseOptions != NULL) { ERROR2IF(!(IS_A(pBaseOptions, JPEGExportOptions)), FALSE, "Incorrect type of options"); JPEGExportOptions* pOptions = (JPEGExportOptions*) pBaseOptions; pHint->SetType(HINTTYPE_JPEG); pHint->SetWidth(GetPixelWidth()); pHint->SetHeight(GetPixelHeight()); pHint->SetBPP(pOptions->GetDepth()); String_256 Opts; Opts._MakeMsg(_T("Q#1%ld"), pOptions->GetQuality()); String_32 DPIString; Ok = Convert::DoubleToString( pOptions->GetDPI(), &DPIString, 3); Opts += _T(" D"); Opts += DPIString; if (pOptions->DoAsProgressive()) { Opts += _T(" P"); } pHint->SetOptionsString(Opts); } } return Ok; }

BOOL JPEGExportFilter::SetFilterForUpdate (  Filter *const   pFilterForUpdate  )  [protected]

Sets the filter for any progress update on export Notes: Should be set to NULL for ordinary import. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Returns: TRUE if successfully set, FALSE otherwise. Errors: ERROR3IF invalid arg type Definition at line 1661 of file exjpeg.cpp. { ERROR3IF(pFilterForUpdate != NULL && !pFilterForUpdate->IS_KIND_OF(Filter), "pFilterForUpdate isn't"); m_pFilterForUpdate = pFilterForUpdate; return TRUE; }

void JPEGExportFilter::SetPostOperation (  BOOL  Value  )  [inline, protected]

Definition at line 262 of file exjpeg.h. { m_PostOperation = Value; }

BOOL JPEGExportFilter::WriteBitmapSource (  BitmapSource *  Source, UINT32  Height, BaseCamelotFilter *  pThisFilter, CCLexFile *  pCCFile )

Writes out the given BitmapSource to this file. Author: Ranbir_Rana (Xara Group Ltd) <camelotdev@xara.com> (From Colin) Date: 22/01/97 Parameters: Source  : the BitmapSource to write out [INPUTS] Height : the height of the bitmap in this source pThisFilter : the filter whose IncProgressBarCount we will use for the progress indicator Returns: TRUE if written successfully FALSE otherwise Errors: ERROR2's if Height is zero or pThisFilter NULL See Also: CXaraFile::WriteBitmapSource Definition at line 820 of file exjpeg.cpp. { ERROR2IF(pThisFilter == NULL, FALSE, "pThisFilter == NULL"); ERROR2IF(Height == 0, FALSE, "Height == 0"); CCBufferFile* pBufferFile = new CCBufferFile(pCCFile); // Now create a file that can fill it if (pBufferFile == NULL || !pBufferFile->IsInited()) { return FALSE; } // Provide the filter with something to work with Source->AttachToBufferFile(pBufferFile); // Work out how much to increment the progress bar by on each loop OFFSET Size = Source->GetSize(); UINT32 Increment = (Height * CCBufferFile::DEFAULT_BUFSIZ) / Size; if (Increment > Height) { Increment = Height; } else if (Increment < 1) { Increment = 1; } UINT32 UpdateEvery = Size / (Height * CCBufferFile::DEFAULT_BUFSIZ); // Write out the BitmapSource DEFAULT_BUFSIZ bytes at a time UINT32 WritesSinceUpdate = 0; while (!pBufferFile->IsAllWritten()) { pBufferFile->write(NULL, CCBufferFile::DEFAULT_BUFSIZ); if (pBufferFile->bad() || pBufferFile->fail()) { delete pBufferFile; return FALSE; } // We've made some progress so provide some user feedback ++WritesSinceUpdate; if (WritesSinceUpdate >= UpdateEvery) { pThisFilter->IncProgressBarCount(Increment); WritesSinceUpdate = 0; } }; // Destroy our file handle delete pBufferFile; return TRUE; }

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

Reimplemented from BaseBitmapFilter. Definition at line 772 of file exjpeg.cpp. { ERROR2IF(pKernelBitmap == NULL || pFilter == NULL || pFile == NULL, FALSE, "NULL Args"); ERROR3IF(!pKernelBitmap->IS_KIND_OF(KernelBitmap), "pKernelBitmap isn't"); ERROR3IF(!pFilter->IS_KIND_OF(BaseCamelotFilter), "pFilter isn't"); ERROR3IF(!pFile->IS_KIND_OF(CCLexFile), "pFile isn't"); if (!BaseBitmapFilter::WriteBitmapToFile(pKernelBitmap, pFilter, pFile, Compression)) { return FALSE; } SetFilterForUpdate(pFilter); JPEGExportOptions* pOptions = (JPEGExportOptions*)GetBitmapExportOptions(); pOptions->RetrieveDefaults(); pOptions->SetQuality(Compression); if (!DoFilter(pKernelBitmap, pFile)) { return FALSE; } return TRUE; }

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

To duplicate code. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 See also: BaseBitmapFilter::WriteBitmapToFile Reimplemented from BaseBitmapFilter. Definition at line 733 of file exjpeg.cpp. { ERROR2IF(pKernelBitmap == NULL, FALSE, "NULL Args"); ERROR3IF(!pKernelBitmap->IS_KIND_OF(KernelBitmap), "pKernelBitmap isn't"); BOOL bSuccess = FALSE; JPEGExportOptions* pOptions = (JPEGExportOptions*)GetBitmapExportOptions(); pOptions->RetrieveDefaults(); pOptions->SetDPI(Dpi); // export the jpeg just as it is (sjk 21/12/00) pOptions->m_bJPEGPresentAndSelected = TRUE; SetFilterForUpdate(NULL); // Set up the progress bar ProgressOffset = 0; // reset this Filter member!!! so WriteBitmap() does progress correctly OILBitmap* pOILBitmap = pKernelBitmap->GetActualBitmap(); String_64 ProgressString = GetExportProgressString(GetExportFile(), GetExportMsgID()); BeginSlowJob(pOILBitmap->GetHeight(), FALSE, &ProgressString); bSuccess = DoFilter(pKernelBitmap, GetExportFile()); EndSlowJob(); return bSuccess; }

BOOL JPEGExportFilter::WriteFileHeader (  void   )  [protected, virtual]

To write out the file specific header data: actually sets up the JPEG filter. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Returns: FALSE if failed else TRUE See also: BaseBitmapFilter::WriteFileHeader() Reimplemented from BaseBitmapFilter. Definition at line 1238 of file exjpeg.cpp. { BOOL ok = FALSE; ok = PrepareForOperation(); return ok; }

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

Overrides 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: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Returns: FALSE if failed else TRUE See also: BaseBitmapFilter::WriteFrame(void) 8. Aborting. If you decide to abort a compression cycle before finishing, you can clean up in either of two ways: If you don't need the JPEG object any more, just call jpeg_destroy_compress() or jpeg_destroy() to release memory. This is legitimate at any point after calling jpeg_create_compress() --- in fact, it's safe even if jpeg_create_compress() fails. If you want to re-use the JPEG object, call jpeg_abort_compress(), or jpeg_abort() which works on both compression and decompression objects. This will return the object to an idle state, releasing any working memory. jpeg_abort() is allowed at any time after successful object creation. Note that cleaning up the data destination, if required, is your responsibility. Reimplemented from BaseBitmapFilter. Definition at line 1279 of file exjpeg.cpp. { BOOL Ok; BMP_SIZE Width, Height; BMP_DEPTH Depth; ADDR pBitmapBits; Ok = GetCurrentStripInfo(&pBitmapBits, &Width, &Height, &Depth); // Create a converter from bitmap depth to export depth DIBConvert* pConverter = DIBConvert::Create( Depth, GetRenderDepth(), Width, NULL ); if (Ok) { Ok = WriteRawBitmap( pBitmapBits, Width, Height, Depth, pConverter ); } return Ok; }

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

Overrides base class to finish JPEG compression cycle of the current frame. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Returns: FALSE if failed else TRUE See also: BaseBitmapFilter Reimplemented from BaseBitmapFilter. Definition at line 1432 of file exjpeg.cpp. { try { libJPEG::jpeg_finish_compress(&m_cinfo); } catch (...) { StringID errorString = m_pErrorHandler->GetStringIDForError(); Error::SetError(errorString); return FALSE; } return TRUE; }

BOOL JPEGExportFilter::WriteRawBitmap (  const ADDR &  pBitmapData, const BMP_SIZE &  Width, const BMP_SIZE &  Height, const BMP_DEPTH &  Bpp, DIBConvert *  pConverter )  [protected]

Support function for writing out the bitmap scanlines Called by WriteFrame() & WriteBitmap(). Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 29/10/96 Parameters: pBitmapData  : The bits, as in "bitmap" [INPUTS] Width: The bitmap width in pixels Height: The bitmap height in pixels Depth: The bitmap depth in bits per pixel pConverter: A pointer to a DIBConvert to convert the actual bitmap given to 32bpp data Returns: FALSE if failed else TRUE Definition at line 1322 of file exjpeg.cpp. { // ERROR2IF(pConverter == NULL && Bpp != (BMP_DEPTH)GetRenderDepth(), FALSE, "Parameters incorrect"); const UINT32 ScanlineSize = DIBUtil::ScanlineSize( Width, Bpp ); const UINT32 ExportlineSize = DIBUtil::ScanlineSize( Width, 32 ); Filter* const pFilterForUpdate = GetFilterForUpdate(); ADDR pExportBuffer = NULL; ADDR pBitmapLine = pBitmapData; ADDR pExportLine = NULL; if (pConverter != NULL) { pExportBuffer = new BYTE[ExportlineSize]; pExportLine = pExportBuffer; } try { UINT32 ScanlinesRemaining = Height; pBitmapLine += (ScanlinesRemaining - 1) * ScanlineSize; RGBTRIPLE* pTempLine = (RGBTRIPLE*)alloca( ExportlineSize ); // Do it one line at a time like it or not while (ScanlinesRemaining > 0) { // Convert the bitmap to 32bpp if necessary if (pConverter == NULL) { pExportLine = pBitmapLine; } else { pConverter->Convert(pBitmapLine, pExportBuffer, 1, FALSE); } #if !defined(__WXMSW__) && defined(BIG_ENDIAN) // Component swapping must be done out-of-line, to stop original // being blatted RGBTRIPLE* pExportRGB = (RGBTRIPLE*)pExportLine; if( pExportLine == pBitmapLine ) { pExportRGB = pTempLine; memcpy( pExportRGB, pExportLine, ExportlineSize ); pExportLine = PBYTE(pExportRGB); } for( unsigned ord = 0; ord < Width; ++ord, ++ pExportRGB ) std::swap( pExportRGB->rgbtBlue, pExportRGB->rgbtRed ); #endif libJPEG::jpeg_write_scanlines(&m_cinfo, &pExportLine, 1); if (pFilterForUpdate != NULL) { // Ask the pFilter to update the progress bar for us pFilterForUpdate->IncProgressBarCount(1); } else { ContinueSlowJob(ProgressOffset + (Height - ScanlinesRemaining)); } pBitmapLine -= ScanlineSize; --ScanlinesRemaining; } } catch (...) { if (pExportBuffer != NULL) { delete pExportBuffer; } StringID errorString = m_pErrorHandler->GetStringIDForError(); Error::SetError(errorString); return FALSE; } if (pExportBuffer != NULL) { delete pExportBuffer; } if (pFilterForUpdate == NULL) { // Add in the height of the strip that we have just exported to the progress offset value ProgressOffset += Height; } return TRUE; }

---

Member Data Documentation

BOOL JPEGExportFilter::m_bOldReportErrors [protected]

Definition at line 268 of file exjpeg.h.

BOOL JPEGExportFilter::m_bOldThrowExceptions [protected]

Definition at line 269 of file exjpeg.h.

struct libJPEG::jpeg_compress_struct JPEGExportFilter::m_cinfo [protected]

Definition at line 275 of file exjpeg.h.

JPEGDataDestination* JPEGExportFilter::m_pDestinationHandler [protected]

Definition at line 278 of file exjpeg.h.

JPEGErrorManager* JPEGExportFilter::m_pErrorHandler [protected]

Definition at line 277 of file exjpeg.h.

Filter* JPEGExportFilter::m_pFilterForUpdate [protected]

Definition at line 272 of file exjpeg.h.

BOOL JPEGExportFilter::m_PostOperation [protected]

Definition at line 270 of file exjpeg.h.

---

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

• Kernel/exjpeg.h (r1785/r809)
• Kernel/exjpeg.cpp (r1785/r1708)

---