/************************************************************** * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * *************************************************************/ // MARKER(update_precomp.py): autogen include statement, do not remove #include "precompiled_canvas.hxx" #include #include #include #include #include #include #include #include #include #include "cairo_spritecanvashelper.hxx" #include "cairo_canvascustomsprite.hxx" using namespace ::cairo; using namespace ::com::sun::star; namespace cairocanvas { namespace { /** Sprite redraw at original position Used to repaint the whole canvas (background and all sprites) */ void spriteRedraw( const CairoSharedPtr& pCairo, const ::canvas::Sprite::Reference& rSprite ) { // downcast to derived cairocanvas::Sprite interface, which // provides the actual redraw methods. ::boost::polymorphic_downcast< Sprite* >(rSprite.get())->redraw( pCairo, true); } void repaintBackground( const CairoSharedPtr& pCairo, const SurfaceSharedPtr& pBackgroundSurface, const ::basegfx::B2DRange& rArea ) { cairo_save( pCairo.get() ); cairo_rectangle( pCairo.get(), ceil( rArea.getMinX() ), ceil( rArea.getMinY() ), floor( rArea.getWidth() ), floor( rArea.getHeight() ) ); cairo_clip( pCairo.get() ); cairo_set_source_surface( pCairo.get(), pBackgroundSurface->getCairoSurface().get(), 0, 0 ); cairo_set_operator( pCairo.get(), CAIRO_OPERATOR_SOURCE ); cairo_paint( pCairo.get() ); cairo_restore( pCairo.get() ); } void opaqueUpdateSpriteArea( const ::canvas::Sprite::Reference& rSprite, const CairoSharedPtr& pCairo, const ::basegfx::B2IRange& rArea ) { // clip output to actual update region (otherwise a) // wouldn't save much render time, and b) will clutter // scrolled sprite content outside this area) cairo_save( pCairo.get() ); cairo_rectangle( pCairo.get(), rArea.getMinX(), rArea.getMinY(), sal::static_int_cast(rArea.getWidth()), sal::static_int_cast(rArea.getHeight()) ); cairo_clip( pCairo.get() ); // repaint affected sprite directly to output device (at // the actual screen output position) // rendering directly to device buffer ::boost::polymorphic_downcast< Sprite* >( rSprite.get() )->redraw( pCairo, false ); cairo_restore( pCairo.get() ); } /** Repaint sprite at original position Used for opaque updates, which render directly to the device buffer. */ void spriteRedrawStub( const CairoSharedPtr& pCairo, const ::canvas::Sprite::Reference& rSprite ) { if( rSprite.is() ) { ::boost::polymorphic_downcast< Sprite* >( rSprite.get() )->redraw( pCairo, false ); } } /** Repaint sprite at given position Used for generic update, which renders into device buffer. */ void spriteRedrawStub2( const CairoSharedPtr& pCairo, const ::canvas::Sprite::Reference& rSprite ) { if( rSprite.is() ) { ::boost::polymorphic_downcast< Sprite* >( rSprite.get() )->redraw( pCairo, true );; } } /** Repaint sprite at original position Used for opaque updates from scrollUpdate(), which render directly to the front buffer. */ void spriteRedrawStub3( const CairoSharedPtr& pCairo, const ::canvas::SpriteRedrawManager::AreaComponent& rComponent ) { const ::canvas::Sprite::Reference& rSprite( rComponent.second.getSprite() ); if( rSprite.is() ) ::boost::polymorphic_downcast< Sprite* >( rSprite.get() )->redraw( pCairo, false ); } } SpriteCanvasHelper::SpriteCanvasHelper() : mpRedrawManager( NULL ), mpOwningSpriteCanvas( NULL ), mpCompositingSurface(), maCompositingSurfaceSize() { } void SpriteCanvasHelper::init( ::canvas::SpriteRedrawManager& rManager, SpriteCanvas& rDevice, const ::basegfx::B2ISize& rSize ) { mpRedrawManager = &rManager; mpOwningSpriteCanvas = &rDevice; CanvasHelper::init( rSize, rDevice, &rDevice ); } void SpriteCanvasHelper::disposing() { mpCompositingSurface.reset(); mpOwningSpriteCanvas = NULL; mpRedrawManager = NULL; // forward to base CanvasHelper::disposing(); } uno::Reference< rendering::XAnimatedSprite > SpriteCanvasHelper::createSpriteFromAnimation( const uno::Reference< rendering::XAnimation >& ) { return uno::Reference< rendering::XAnimatedSprite >(); } uno::Reference< rendering::XAnimatedSprite > SpriteCanvasHelper::createSpriteFromBitmaps( const uno::Sequence< uno::Reference< rendering::XBitmap > >& /*animationBitmaps*/, sal_Int8 /*interpolationMode*/ ) { return uno::Reference< rendering::XAnimatedSprite >(); } uno::Reference< rendering::XCustomSprite > SpriteCanvasHelper::createCustomSprite( const geometry::RealSize2D& spriteSize ) { if( !mpRedrawManager ) return uno::Reference< rendering::XCustomSprite >(); // we're disposed return uno::Reference< rendering::XCustomSprite >( new CanvasCustomSprite( spriteSize, mpOwningSpriteCanvas ) ); } uno::Reference< rendering::XSprite > SpriteCanvasHelper::createClonedSprite( const uno::Reference< rendering::XSprite >& ) { return uno::Reference< rendering::XSprite >(); } sal_Bool SpriteCanvasHelper::updateScreen( const ::basegfx::B2IRange& /*rCurrArea*/, sal_Bool bUpdateAll, bool& io_bSurfaceDirty ) { if( !mpRedrawManager || !mpOwningSpriteCanvas || !mpOwningSpriteCanvas->getWindowSurface() || !mpOwningSpriteCanvas->getBufferSurface() ) { return sal_False; // disposed, or otherwise dysfunctional } OSL_TRACE("SpriteCanvasHelper::updateScreen called"); const ::basegfx::B2ISize& rSize = mpOwningSpriteCanvas->getSizePixel(); // force compositing surface to be available before using it // inside forEachSpriteArea SurfaceSharedPtr pCompositingSurface = getCompositingSurface(rSize); SurfaceSharedPtr pWindowSurface = mpOwningSpriteCanvas->getWindowSurface(); CairoSharedPtr pCompositingCairo = pCompositingSurface->getCairo(); CairoSharedPtr pWindowCairo = pWindowSurface->getCairo(); // TODO(P1): Might be worthwile to track areas of background // changes, too. if( !bUpdateAll && !io_bSurfaceDirty ) { // background has not changed, so we're free to optimize // repaint to areas where a sprite has changed // process each independent area of overlapping sprites // separately. mpRedrawManager->forEachSpriteArea( *this ); } else { OSL_TRACE("SpriteCanvasHelper::updateScreen update ALL"); // background has changed, so we currently have no choice // but repaint everything (or caller requested that) cairo_rectangle( pCompositingCairo.get(), 0, 0, rSize.getX(), rSize.getY() ); cairo_clip( pCompositingCairo.get() ); cairo_save( pCompositingCairo.get() ); cairo_set_source_surface( pCompositingCairo.get(), mpOwningSpriteCanvas->getBufferSurface()->getCairoSurface().get(), 0, 0 ); cairo_set_operator( pCompositingCairo.get(), CAIRO_OPERATOR_SOURCE ); cairo_paint( pCompositingCairo.get() ); cairo_restore( pCompositingCairo.get() ); // repaint all active sprites on top of background into // VDev. mpRedrawManager->forEachSprite( ::boost::bind( &spriteRedraw, boost::cref(pCompositingCairo), _1 ) ); // flush to screen cairo_rectangle( pWindowCairo.get(), 0, 0, rSize.getX(), rSize.getY() ); cairo_clip( pWindowCairo.get() ); cairo_set_source_surface( pWindowCairo.get(), pCompositingSurface->getCairoSurface().get(), 0, 0 ); cairo_set_operator( pWindowCairo.get(), CAIRO_OPERATOR_SOURCE ); cairo_paint( pWindowCairo.get() ); } // change record vector must be cleared, for the next turn of // rendering and sprite changing mpRedrawManager->clearChangeRecords(); io_bSurfaceDirty = false; // commit to screen mpOwningSpriteCanvas->flush(); return sal_True; } void SpriteCanvasHelper::backgroundPaint( const ::basegfx::B2DRange& rUpdateRect ) { if( mpOwningSpriteCanvas && mpCompositingSurface ) repaintBackground( mpCompositingSurface->getCairo(), mpOwningSpriteCanvas->getBufferSurface(), rUpdateRect ); } void SpriteCanvasHelper::scrollUpdate( const ::basegfx::B2DRange& rMoveStart, const ::basegfx::B2DRange& rMoveEnd, const ::canvas::SpriteRedrawManager::UpdateArea& rUpdateArea ) { ENSURE_OR_THROW( mpOwningSpriteCanvas && mpOwningSpriteCanvas->getBufferSurface(), "SpriteCanvasHelper::scrollUpdate(): NULL device pointer " ); OSL_TRACE("SpriteCanvasHelper::scrollUpdate called"); const ::basegfx::B2ISize& rSize = mpOwningSpriteCanvas->getSizePixel(); const ::basegfx::B2IRange aOutputBounds( 0,0, rSize.getX(), rSize.getY() ); SurfaceSharedPtr pCompositingSurface = getCompositingSurface(rSize); SurfaceSharedPtr pWindowSurface = mpOwningSpriteCanvas->getWindowSurface(); CairoSharedPtr pCompositingCairo = pCompositingSurface->getCairo(); CairoSharedPtr pWindowCairo = pWindowSurface->getCairo(); // round rectangles to integer pixel. Note: have to be // extremely careful here, to avoid off-by-one errors for // the destination area: otherwise, the next scroll update // would copy pixel that are not supposed to be part of // the sprite. ::basegfx::B2IRange aSourceRect( ::canvas::tools::spritePixelAreaFromB2DRange( rMoveStart ) ); const ::basegfx::B2IRange& rDestRect( ::canvas::tools::spritePixelAreaFromB2DRange( rMoveEnd ) ); ::basegfx::B2IPoint aDestPos( rDestRect.getMinimum() ); ::std::vector< ::basegfx::B2IRange > aUnscrollableAreas; // TODO(E3): This is plain buggy (but copies the behaviour of // the old Impress slideshow) - the scrolled area might // actually lie _below_ another window! // clip to output bounds (cannot properly scroll stuff // _outside_ our screen area) if( !::canvas::tools::clipScrollArea( aSourceRect, aDestPos, aUnscrollableAreas, aOutputBounds ) ) { // fully clipped scroll area: cannot simply scroll // then. Perform normal opaque update (can use that, since // one of the preconditions for scrollable update is // opaque sprite content) // repaint all affected sprites directly to output device ::std::for_each( rUpdateArea.maComponentList.begin(), rUpdateArea.maComponentList.end(), ::boost::bind( &spriteRedrawStub3, boost::cref(pCompositingCairo), _1 ) ); } else { const ::basegfx::B2IVector aSourceUpperLeftPos( aSourceRect.getMinimum() ); // clip dest area (which must be inside rDestBounds) ::basegfx::B2IRange aDestRect( rDestRect ); aDestRect.intersect( aOutputBounds ); cairo_save( pCompositingCairo.get() ); // scroll content in device back buffer cairo_set_source_surface( pCompositingCairo.get(), mpOwningSpriteCanvas->getBufferSurface()->getCairoSurface().get(), aDestPos.getX() - aSourceUpperLeftPos.getX(), aDestPos.getY() - aSourceUpperLeftPos.getY() ); cairo_rectangle( pCompositingCairo.get(), aDestPos.getX(), aDestPos.getY(), sal::static_int_cast(aDestRect.getWidth()), sal::static_int_cast(aDestRect.getHeight()) ); cairo_clip( pCompositingCairo.get() ); cairo_set_operator( pCompositingCairo.get(), CAIRO_OPERATOR_SOURCE ); cairo_paint( pCompositingCairo.get() ); cairo_restore( pCompositingCairo.get() ); const ::canvas::SpriteRedrawManager::SpriteConnectedRanges::ComponentListType::const_iterator aFirst( rUpdateArea.maComponentList.begin() ); ::canvas::SpriteRedrawManager::SpriteConnectedRanges::ComponentListType::const_iterator aSecond( aFirst ); ++aSecond; ENSURE_OR_THROW( aFirst->second.getSprite().is(), "VCLCanvas::scrollUpdate(): no sprite" ); // repaint uncovered areas from sprite. Need to actually // clip here, since we're only repainting _parts_ of the // sprite ::std::for_each( aUnscrollableAreas.begin(), aUnscrollableAreas.end(), ::boost::bind( &opaqueUpdateSpriteArea, ::boost::cref(aFirst->second.getSprite()), boost::cref(pCompositingCairo), _1 ) ); } // repaint uncovered areas from backbuffer - take the // _rounded_ rectangles from above, to have the update // consistent with the scroll above. ::std::vector< ::basegfx::B2DRange > aUncoveredAreas; ::basegfx::computeSetDifference( aUncoveredAreas, rUpdateArea.maTotalBounds, ::basegfx::B2DRange( rDestRect ) ); ::std::for_each( aUncoveredAreas.begin(), aUncoveredAreas.end(), ::boost::bind( &repaintBackground, boost::cref(pCompositingCairo), boost::cref(mpOwningSpriteCanvas->getBufferSurface()), _1 ) ); cairo_rectangle( pWindowCairo.get(), 0, 0, rSize.getX(), rSize.getY() ); cairo_clip( pWindowCairo.get() ); cairo_set_source_surface( pWindowCairo.get(), pCompositingSurface->getCairoSurface().get(), 0, 0 ); cairo_set_operator( pWindowCairo.get(), CAIRO_OPERATOR_SOURCE ); cairo_paint( pWindowCairo.get() ); } void SpriteCanvasHelper::opaqueUpdate( const ::basegfx::B2DRange& rTotalArea, const ::std::vector< ::canvas::Sprite::Reference >& rSortedUpdateSprites ) { ENSURE_OR_THROW( mpOwningSpriteCanvas && mpOwningSpriteCanvas->getBufferSurface(), "SpriteCanvasHelper::opaqueUpdate(): NULL device pointer " ); OSL_TRACE("SpriteCanvasHelper::opaqueUpdate called"); const ::basegfx::B2ISize& rDeviceSize = mpOwningSpriteCanvas->getSizePixel(); SurfaceSharedPtr pCompositingSurface = getCompositingSurface(rDeviceSize); SurfaceSharedPtr pWindowSurface = mpOwningSpriteCanvas->getWindowSurface(); CairoSharedPtr pCompositingCairo = pCompositingSurface->getCairo(); CairoSharedPtr pWindowCairo = pWindowSurface->getCairo(); cairo_rectangle( pCompositingCairo.get(), 0, 0, rDeviceSize.getX(), rDeviceSize.getY() ); cairo_clip( pCompositingCairo.get() ); ::basegfx::B2DVector aPos( ceil( rTotalArea.getMinX() ), ceil( rTotalArea.getMinY() ) ); ::basegfx::B2DVector aSize( floor( rTotalArea.getMaxX() - aPos.getX() ), floor( rTotalArea.getMaxY() - aPos.getY() ) ); cairo_rectangle( pCompositingCairo.get(), aPos.getX(), aPos.getY(), aSize.getX(), aSize.getY() ); cairo_clip( pCompositingCairo.get() ); // repaint all affected sprites directly to output device ::std::for_each( rSortedUpdateSprites.begin(), rSortedUpdateSprites.end(), ::boost::bind( &spriteRedrawStub, boost::cref(pCompositingCairo), _1 ) ); // flush to screen cairo_rectangle( pWindowCairo.get(), 0, 0, rDeviceSize.getX(), rDeviceSize.getY() ); cairo_clip( pWindowCairo.get() ); cairo_rectangle( pWindowCairo.get(), aPos.getX(), aPos.getY(), aSize.getX(), aSize.getY() ); cairo_clip( pWindowCairo.get() ); cairo_set_source_surface( pWindowCairo.get(), pCompositingSurface->getCairoSurface().get(), 0, 0 ); cairo_set_operator( pWindowCairo.get(), CAIRO_OPERATOR_SOURCE ); cairo_paint( pWindowCairo.get() ); } void SpriteCanvasHelper::genericUpdate( const ::basegfx::B2DRange& rRequestedArea, const ::std::vector< ::canvas::Sprite::Reference >& rSortedUpdateSprites ) { // TODO OSL_TRACE("SpriteCanvasHelper::genericUpdate called"); ENSURE_OR_THROW( mpOwningSpriteCanvas && mpOwningSpriteCanvas->getBufferSurface(), "SpriteCanvasHelper::genericUpdate(): NULL device pointer " ); // limit size of update VDev to target outdev's size const ::basegfx::B2ISize& rSize = mpOwningSpriteCanvas->getSizePixel(); SurfaceSharedPtr pCompositingSurface = getCompositingSurface(rSize); SurfaceSharedPtr pWindowSurface = mpOwningSpriteCanvas->getWindowSurface(); CairoSharedPtr pCompositingCairo = pCompositingSurface->getCairo(); CairoSharedPtr pWindowCairo = pWindowSurface->getCairo(); // round output position towards zero. Don't want to truncate // a fraction of a sprite pixel... Clip position at origin, // otherwise, truncation of size below might leave visible // areas uncovered by VDev. const Point aOutputPosition( ::std::max( sal_Int32( 0 ), static_cast< sal_Int32 >(rRequestedArea.getMinX()) ), ::std::max( sal_Int32( 0 ), static_cast< sal_Int32 >(rRequestedArea.getMinY()) ) ); // round output size towards +infty. Don't want to truncate a // fraction of a sprite pixel... Limit size of VDev to output // device's area. const Size aOutputSize( ::std::min( rSize.getX(), ::canvas::tools::roundUp( rRequestedArea.getMaxX() - aOutputPosition.X()) ), ::std::min( rSize.getY(), ::canvas::tools::roundUp( rRequestedArea.getMaxY() - aOutputPosition.Y()) ) ); cairo_rectangle( pCompositingCairo.get(), aOutputPosition.X(), aOutputPosition.Y(), aOutputSize.Width(), aOutputSize.Height() ); cairo_clip( pCompositingCairo.get() ); // paint background cairo_save( pCompositingCairo.get() ); cairo_set_source_surface( pCompositingCairo.get(), mpOwningSpriteCanvas->getBufferSurface()->getCairoSurface().get(), 0, 0 ); cairo_set_operator( pCompositingCairo.get(), CAIRO_OPERATOR_SOURCE ); cairo_paint( pCompositingCairo.get() ); cairo_restore( pCompositingCairo.get() ); // repaint all affected sprites on top of background into // VDev. ::std::for_each( rSortedUpdateSprites.begin(), rSortedUpdateSprites.end(), ::boost::bind( &spriteRedrawStub2, boost::cref(pCompositingCairo), _1 ) ); // flush to screen cairo_rectangle( pWindowCairo.get(), aOutputPosition.X(), aOutputPosition.Y(), aOutputSize.Width(), aOutputSize.Height() ); cairo_clip( pWindowCairo.get() ); cairo_set_source_surface( pWindowCairo.get(), pCompositingSurface->getCairoSurface().get(), 0, 0 ); cairo_set_operator( pWindowCairo.get(), CAIRO_OPERATOR_SOURCE ); cairo_paint( pWindowCairo.get() ); } ::cairo::SurfaceSharedPtr SpriteCanvasHelper::getCompositingSurface( const ::basegfx::B2ISize& rNeededSize ) { if( rNeededSize.getX() < maCompositingSurfaceSize.getX() || rNeededSize.getY() < maCompositingSurfaceSize.getY() ) { // need to give buffer more size mpCompositingSurface.reset(); } if( !mpCompositingSurface ) { mpCompositingSurface = mpOwningSpriteCanvas->getWindowSurface()->getSimilar( CAIRO_CONTENT_COLOR, rNeededSize.getX(), rNeededSize.getY() ); maCompositingSurfaceSize = rNeededSize; } return mpCompositingSurface; } }