OpGrabAllFrames Class Reference

Performs an operation to grab all of the frame layers and preview them. More...

#include <frameops.h>

Inheritance diagram for OpGrabAllFrames:

List of all members.

Public Member Functions
	OpGrabAllFrames ()
void	Do (OpDescriptor *pOpDesc)
	Tries to grab the selected animation frame (i.e. layer).
Static Public Attributes
static BOOL	ms_ForceRefreshOfAllFrames = FALSE
Protected Member Functions
void	CreateGlobalPalette (DWORD NumColsInPalette, BOOL RegenerateAllFrames)
Private Member Functions
	CC_DECLARE_DYNCREATE (OpGrabAllFrames)

---

Detailed Description

Performs an operation to grab all of the frame layers and preview them.

Author:

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

Date:

23/4/97

See also:

-

Definition at line 610 of file frameops.h.

---

Constructor & Destructor Documentation

OpGrabAllFrames::OpGrabAllFrames (   )  [inline]

Definition at line 615 of file frameops.h. { } // nothing yet

---

Member Function Documentation

OpGrabAllFrames::CC_DECLARE_DYNCREATE (  OpGrabAllFrames   )  [private]

void OpGrabAllFrames::CreateGlobalPalette (  DWORD  NumColsInPalette, BOOL  RegenerateAllFrames )  [protected]

Definition at line 3029 of file frameops.cpp. { ERROR3IF(!m_pBitmapFilter, "No bitmap filter to use when generating global palette"); if (!m_pBitmapFilter) return; PaletteOptimiser* pPalOpt = new PaletteOptimiser(); if (!pPalOpt) return; pPalOpt->Initialise(); // Go through all the frame layers in the spread and export them KernelBitmap * pBitmap = NULL; Layer* pCurrentLayer = NULL; // Set the filter to generate preview bitmaps m_pBitmapFilter->SetGrabMode(GrabFrameFilter::GRABMODE_PREVIEW); pBitmap = NULL; pCurrentLayer = m_pSpread->FindFirstFrameLayer(); while (pCurrentLayer != NULL) { // see if the user has hidden the frame if (!pCurrentLayer->IsPseudoFrame() || pCurrentLayer->IsHiddenFrame()) { // It is either an invalid frame or it is hidden. In both cases but especially // the second we should ensure that if there is a generated bitmap then we // vape it as it is now out of date. pCurrentLayer->SetGeneratedBitmap(NULL); // Move to the next bitmap in the animation pCurrentLayer = pCurrentLayer->FindNextFrameLayer(); // Go to the next frame continue; } // Set up the visibility of the other layers using this layer // as the new temporary and acting active layer FrameSGallery::FixOtherLayersFromActive(pCurrentLayer); // This is the layer that we are adding to the global palette m_pLayer = pCurrentLayer; // Render a bitmap of the entire image being exported KernelBitmap* pTestBitmap=NULL; m_pBitmapFilter->DoCreateBitmap(this, m_pDocument, &pTestBitmap); // not enough memory? or no content worth talking about then give up! if (!pTestBitmap || !pTestBitmap->GetActualBitmap()) { FailAndExecute(); End(); return; } // We need to pass Gavin a 32bbp bitmap with an empty channel (rather than an // alpha channel). Lets quickly create one (I am sure this is not the best way // of doing this but it will do for now). UINT32 nPixels = pTestBitmap->GetActualBitmap()->GetBitmapSize() / 3; RGBQUAD* pNewBitmap = new RGBQUAD[nPixels]; UINT32 width = pTestBitmap->GetActualBitmap()->GetBitmapInfoHeader()->biWidth; UINT32 height = pTestBitmap->GetActualBitmap()->GetBitmapInfoHeader()->biHeight; BYTE* pOldBitmapBytes = (BYTE*)pTestBitmap->GetActualBitmap()->GetBitmapBits(); UINT32 bytesPerLine = BYTESPERLINE(width, 24); for (UINT32 y = 0; y < height; ++y) for (UINT32 x = 0; x < width; x++) { pNewBitmap[y * width + x].rgbBlue = pOldBitmapBytes[bytesPerLine * y + x * 3 + 0]; pNewBitmap[y * width + x].rgbGreen = pOldBitmapBytes[bytesPerLine * y + x * 3 + 1]; pNewBitmap[y * width + x].rgbRed = pOldBitmapBytes[bytesPerLine * y + x * 3 + 2]; pNewBitmap[y * width + x].rgbReserved = 0; } // add the stats to the palette optimiser pPalOpt->AddStats(pNewBitmap, nPixels); delete pNewBitmap; delete pTestBitmap; // Move to the next bitmap in the animation pCurrentLayer = pCurrentLayer->FindNextFrameLayer(); } // set the global palette pPalOpt->SnapToBrowserPalette(0); pPalOpt->SnapToPrimaries(1); pPalOpt->AddSystemColours((m_pSpread->GetSpreadAnimPropertiesParam().GetUseSystemCols() == TRUE)); pPalOpt->UseBrowserPalette(0); pPalOpt->SetFast(TRUE); INT32 ColoursToOptimise = camMax(2, NumColsInPalette-1); // tell the optimiser that we have finished gathering the stats pPalOpt->GenPalette(ColoursToOptimise); LOGPALETTE * pGlobalPal = DIBUtil::AllocateLogPalette(ColoursToOptimise + 1); pGlobalPal->palNumEntries = ColoursToOptimise; // get the optimised palette from the optimser pPalOpt->GetPalette( pGlobalPal, ColoursToOptimise); // we want to add a transparent colour to this palette pGlobalPal->palNumEntries = camMin(255,pGlobalPal->palNumEntries+1); // the first entry in the palette is special it should be the background colour as it will // be what is visible if the background is not transparent so swap the first entry into // the last and set the last pGlobalPal->palPalEntry[ pGlobalPal->palNumEntries-1 ].peRed = pGlobalPal->palPalEntry[ 0 ].peRed; pGlobalPal->palPalEntry[ pGlobalPal->palNumEntries-1 ].peGreen = pGlobalPal->palPalEntry[ 0 ].peGreen; pGlobalPal->palPalEntry[ pGlobalPal->palNumEntries-1 ].peBlue = pGlobalPal->palPalEntry[ 0 ].peBlue; pGlobalPal->palPalEntry[ pGlobalPal->palNumEntries-1 ].peFlags = 0; DocColour dcol = Page::GetPageColour(); INT32 r = 255, g = 255, b = 255; dcol.GetRGBValue(&r,&g,&b); pGlobalPal->palPalEntry[ 0 ].peRed = (BYTE)r; pGlobalPal->palPalEntry[ 0 ].peGreen = (BYTE)g; pGlobalPal->palPalEntry[ 0 ].peBlue = (BYTE)b; pGlobalPal->palPalEntry[ 0 ].peFlags = 255; // the transp entry - not renderable // remove the optimiser delete pPalOpt; // save this global palette for later m_pBitmapFilter->SetGlobalOptimisedPalette(pGlobalPal); m_pBitmapFilter->AlterPaletteContents(pGlobalPal); // Undo our change to the filter m_pBitmapFilter->SetGrabMode(GrabFrameFilter::GRABMODE_FOROUTPUT); }

void OpGrabAllFrames::Do (  OpDescriptor *  pOpDesc  )  [virtual]

Tries to grab the selected animation frame (i.e. layer). Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 22/4/97 Parameters: OpDescriptor  (unused) [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Reimplemented from OpGrabFrame. Definition at line 3178 of file frameops.cpp. { // Get useful data and set up items before starting the grab process if (!StartGrab()) { // We failed to grab the frame FailAndExecute(); End(); return; } // If required, allow the op to get a filename from the user. // This also allows them access to the options via the button on the save dialog box. // This is why we must do this first rather than after we have generated the frames. if (!GetFileNameFromUser()) { // We failed to grab the frame FailAndExecute(); End(); return; } // Get our static pointer to the Preview Dialog. PreviewDialog* pPreviewDlg = PreviewDialog::GetPreviewDialog(); // If the preview dialog is already open, find the selected frame layer. BOOL PlayAnimation = TRUE; if (pPreviewDlg) { // Note the current state of the playing PlayAnimation = pPreviewDlg->GetPlayAnimation(); // Force the dialog into stop mode pPreviewDlg->StopPreviewing(); } // Create a special Bitmap filter, that creates a bitmap // and puts it in the tree ERROR3IF(m_pBitmapFilter != NULL,"Already have a pBitmapFilter!"); m_pBitmapFilter = new GrabFrameFilter(); if (m_pBitmapFilter == NULL) { // We failed to grab the frame // Try and put back the selection that we recorded at the start PutBackTheSelection(); FailAndExecute(); End(); return; } // Get the stored cliprect from the spread. // This may be blank if the frames have not been generated before. DocRect OldBoundingRect = m_pSpread->GetAnimationBoundingRect(); // Get the filter to work out the new rectangle m_pBitmapFilter->SetUpClippingRectangleForExport(m_pSpread, DRAWING); DocRect NewBoundingRect = m_pBitmapFilter->GetClipRect(); // Save away the new bounding rectangle m_pSpread->SetAnimationBoundingRect(NewBoundingRect); m_ExportParams.SetAnimationBoundingRect(NewBoundingRect); // If they are different then we must regenerate all frames BOOL RegenerateAllFrames = ms_ForceRefreshOfAllFrames; // used to be = FALSE (sjk) ms_ForceRefreshOfAllFrames = FALSE; // have used the force refresh if (NewBoundingRect != OldBoundingRect) RegenerateAllFrames = TRUE; Quality OldQuality = m_pSpread->GetAnimationQuality(); // AMB doesn't understand what the following lines were meant to do. Quality // is a linear scale. And in any case this doesn't compile (unsurprisingly) // Quality NewQuality = m_pView->RenderQuality; // NewQuality.Antialias = Quality::FullAntialias; // NewQuality.Transparency = Quality::FullTransparency; Quality NewQuality(Quality::QualityMax); // Save away the new quality m_pSpread->SetAnimationQuality(NewQuality); if (NewQuality != OldQuality) RegenerateAllFrames = TRUE; // Check if somebody has edited the page background layer. If they have then // regenerate all frames Layer * pPageBackground = m_pSpread->FindFirstPageBackgroundLayer(); if (pPageBackground) { if (pPageBackground->IsEdited()) RegenerateAllFrames = TRUE; } // If the user has a global optimised palette and they have edited one layer // then we have really no choice but to always regenerate all frames // as the user may have changed something that will affect the colours in the palette. //DITHER Dither; WEB_PALETTE WebPalette = PAL_GLOBAL; PALETTE_COLOURS ColoursPalette = PALCOL_BROWSER; DWORD NumColsInPalette; m_pSpread->GetAnimationColours(NULL, &WebPalette, &ColoursPalette, &NumColsInPalette, NULL); if (WebPalette == PAL_GLOBAL && ColoursPalette == PALCOL_OPTIMIZED) { // check to see if one of the frame layers has been edited Layer * pTestLayer = m_pSpread->FindFirstFrameLayer(); while (pTestLayer) { if (pTestLayer->IsEdited() && pTestLayer->IsPseudoFrame()) { // Somebody has edited one of the frames so we must regenerate all RegenerateAllFrames = TRUE; break; } pTestLayer = pTestLayer->FindNextFrameLayer(); } } // Check all the layers to see if they contain a single bitmap which we can use // instead of generating one. // This will mark all valid single bitmaps using the reference in the layer if (!CheckAllForSingleBitmaps(m_pSpread, m_pBitmapFilter)) { // Try and put back the selection that we recorded at the start PutBackTheSelection(); delete m_pBitmapFilter; m_pBitmapFilter = NULL; // We failed to clean up after grabbing the frame FailAndExecute(); End(); return; } // As this will affect us during grabbing, we should force it into the known // non-interferring state BOOL CurrentVisEdState = Layer::ActiveLayerVisibleAndEditable; Layer::ActiveLayerVisibleAndEditable = FALSE; // The all visible flag will also do this for us. Document* pDoc = m_pSpread->FindParentDocument(); BOOL CurrentAllVisibleState = FALSE; if (pDoc != NULL) { CurrentAllVisibleState = pDoc->IsAllVisible(); pDoc->SetAllVisible(FALSE); } // SMFIX Do we need a global palette for all the frames? BOOL CreatingGlobalPalette = (WebPalette == PAL_GLOBAL && ColoursPalette == PALCOL_OPTIMIZED); // if we are having a global palette then get an optimiser to create one from the bitmaps if (CreatingGlobalPalette) CreateGlobalPalette(NumColsInPalette, RegenerateAllFrames); // Go through all the frame layers in the spread and export them KernelBitmap * pBitmap = NULL; Layer* pCurrentLayer = NULL; // Set the filter to generate output bitmaps m_pBitmapFilter->SetGrabMode(GrabFrameFilter::GRABMODE_FOROUTPUT); // go round once unless we are creating a global palette then go round twice pBitmap = NULL; pCurrentLayer = m_pSpread->FindFirstFrameLayer(); while (pCurrentLayer != NULL) { // see if the user has hidden the frame if (!pCurrentLayer->IsPseudoFrame() || pCurrentLayer->IsHiddenFrame()) { // It is either an invalid frame or it is hidden. In both cases but especially // the second we should ensure that if there is a generated bitmap then we // vape it as it is now out of date. pCurrentLayer->SetGeneratedBitmap(NULL); // Move to the next bitmap in the animation pCurrentLayer = pCurrentLayer->FindNextFrameLayer(); // Go to the next frame continue; } // Set up the visibility of the other layers using this layer // as the new temporary and acting active layer FrameSGallery::FixOtherLayersFromActive(pCurrentLayer); // This is where the real work starts! // This is the layer that we want grabbing m_pLayer = pCurrentLayer; // Check to see if we have a single bitmap on the layer which is stored // in a NodeBitmap at a 1:1 scale and is 8bpp or less and the palette matches // the present options. // If it passes all these tests, then set pBitmap to be that bitmap. //if (!CheckIfSingleBitmap(pCurrentLayer, &pBitmap)) // If there is a referenced bitmap then we can use this instead of generating one pBitmap = m_pLayer->GetReferencedBitmap(); if (pBitmap == NULL) { // Look to see if we have a bitmap for this layer KernelBitmap * pOldBitmap = pCurrentLayer->GetGeneratedBitmap(); // Look to see if any visible foreground layers below this one have // been edited BOOL LayersBelowEdited = FALSE; // Only check if we are not already forced to regnerate all frames if (!RegenerateAllFrames) { Layer * pTestLayer = pCurrentLayer; pTestLayer = pTestLayer->FindPrevFrameLayer(); while (pTestLayer) { // Dont disclude hidden frames as they can affect the make up of the current frame if (pTestLayer->IsEdited() && pTestLayer->IsPseudoFrame() && pTestLayer->IsVisible()) { LayersBelowEdited = TRUE; break; } pTestLayer = pTestLayer->FindPrevFrameLayer(); } } // we are getting the bitmaps themselves // check that the quality it was last captured at was the same as the current quality Quality CurrentFrameQuality = pCurrentLayer->GetCaptureQuality(); // For a number of reasons we may need to regenerate the bitmap for this frame // If nay are true then regenerate, otherwise reuse the old one if (pOldBitmap == NULL || LayersBelowEdited || RegenerateAllFrames || pCurrentLayer->IsEdited() || CurrentFrameQuality != NewQuality) { // Turn this frame into a bitmap pBitmap = GrabTheFrame(); } else { // Reuse the old bitmap that was generated pBitmap = pOldBitmap; // test to see that this bitmap uses the correct palette if required // otherwise we will have to grab it anyway if (CreatingGlobalPalette) { // compare palettes LOGPALETTE * pGlobalPalette = m_pBitmapFilter->GetGlobalOptimisedPalette(); if (!pBitmap->GetActualBitmap()->ArePalettesTheSame(pGlobalPalette, 0)) { // NOTE: This happens when the preview window has just gone and generated a bitmap // using a locally optimal palette rather than our globally optimal palette and in // the process it has replaced our cache version with its dodgy bitmap. TRACEALL( _T("Bum bitmap passed to us with wrong palette, grab a fresh one")); pBitmap = GrabTheFrame(); } } } } BOOL bAddLayer = pBitmap != 0; if (bAddLayer) { // We have a bitmap so add this layer pairing to our export list bAddLayer = m_ExportParams.AddLayerAndBitmap(pCurrentLayer, pBitmap); } if (!bAddLayer) { // We failed to grab the frame or failed to add it to our export list // Put back the active layer's visibilty and selection Layer::ActiveLayerVisibleAndEditable = CurrentVisEdState; FrameSGallery::FixOtherLayersFromActive(m_pLayer); // Try and put back the selection that we recorded at the start PutBackTheSelection(); FailAndExecute(); End(); return; } //TRACEUSER( "SimonK", _T("colours in frame %d\n"), pBitmap->GetNumPaletteEntries()); // Note the capture quality that the frame was captured at but only if we worked correctly pCurrentLayer->SetCaptureQuality(NewQuality); // Move to the next bitmap in the animation pCurrentLayer = pCurrentLayer->FindNextFrameLayer(); } // Put back the active layer's visibilty and selection Layer::ActiveLayerVisibleAndEditable = CurrentVisEdState; // Put back the all visible state if (pDoc != NULL) pDoc->SetAllVisible(CurrentAllVisibleState); Layer *pActiveLayer = m_pSpread->FindActiveLayer(); if (pActiveLayer) FrameSGallery::FixOtherLayersFromActive(pActiveLayer); // Go and mark all layers as not edited now that we have finished the grabbing // process Layer* pLayer = m_pSpread->FindFirstFrameLayer(); while (pLayer != NULL) { // This is just as a double check if (pLayer->IsPseudoFrame()) { // Clear the edited flag on the layer pLayer->SetEdited(FALSE); #ifdef _DEBUG // Tell the frame gallery to update its display of the frame BROADCAST_TO_ALL(LayerMsg(pLayer, LayerMsg::REDRAW_LAYER)); #endif } // Move to the next frame layer in the animation pLayer = pLayer->FindNextFrameLayer(); } // If we found a page background layer above, now mark it as not edited if (pPageBackground) pPageBackground->SetEdited(FALSE); // Clean up after the grabbing process if (!EndGrab()) { // We failed to clean up after grabbing the frame delete m_pBitmapFilter; m_pBitmapFilter = NULL; FailAndExecute(); End(); return; } // Grab all frames should usually play the animation. // If the preview dialog is open and in stop mode then it should continue in stop mode. // In this case we should have noted this before calling stop at the start of this function // So up the play state we noted earlier before we preview PreviewDialog * pPreviewDialog = PreviewDialog::GetPreviewDialog(); INT32 CurrentFrame = 0; if (pPreviewDialog != NULL) { pPreviewDialog->SetPlayAnimation(PlayAnimation); CurrentFrame = pPreviewDialog->GetCurrentItem(); } // Fire up the preview dialog box with the bitmaps in our list if (!PreviewAnimation()) { // We failed to preview the bitmap delete m_pBitmapFilter; m_pBitmapFilter = NULL; FailAndExecute(); End(); return; } // If the dialog is still there then select the new frame to be displayed // Default is frame 0 so only do it if the requested item is different to this pPreviewDialog = PreviewDialog::GetPreviewDialog(); if (pPreviewDialog && CurrentFrame != 0) pPreviewDialog->SelectCurrentFrame(CurrentFrame); // remove the filter as we have no more use for it delete m_pBitmapFilter; m_pBitmapFilter = NULL; End(); return; }

---

Member Data Documentation

BOOL OpGrabAllFrames::ms_ForceRefreshOfAllFrames = FALSE [static]

Definition at line 621 of file frameops.h.

---

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

• Kernel/frameops.h (r1785/r1282)
• Kernel/frameops.cpp (r1785/r1282)

---