office-gobmx/include/vcl/bmpacc.hxx
Thomas Arnhold d0df04f299 fixincludeguards.sh: include/vcl
Change-Id: Iaea4396f60aeade5303bf83a4504ad62f161b83c
2013-10-23 23:22:29 +02:00

472 lines
17 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* 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 .
*/
#ifndef INCLUDED_VCL_BMPACC_HXX
#define INCLUDED_VCL_BMPACC_HXX
#include <tools/solar.h>
#include <vcl/dllapi.h>
#include <vcl/salbtype.hxx>
#include <vcl/bitmap.hxx>
// --------------------
// - Access defines -
// --------------------
#define DECL_FORMAT_GETPIXEL( Format ) \
static BitmapColor GetPixelFor##Format( ConstScanline pScanline, long nX, const ColorMask& rMask );
#define DECL_FORMAT_SETPIXEL( Format ) \
static void SetPixelFor##Format( Scanline pScanline, long nX, const BitmapColor& rBitmapColor, const ColorMask& rMask );
#define DECL_FORMAT( Format ) \
DECL_FORMAT_GETPIXEL( Format ) \
DECL_FORMAT_SETPIXEL( Format )
#define IMPL_FORMAT_GETPIXEL( Format ) \
BitmapColor BitmapReadAccess::GetPixelFor##Format( ConstScanline pScanline, long nX, const ColorMask& rMask )
#define IMPL_FORMAT_GETPIXEL_NOMASK( Format ) \
BitmapColor BitmapReadAccess::GetPixelFor##Format( ConstScanline pScanline, long nX, const ColorMask& )
#define IMPL_FORMAT_SETPIXEL( Format ) \
void BitmapReadAccess::SetPixelFor##Format( Scanline pScanline, long nX, const BitmapColor& rBitmapColor, const ColorMask& rMask )
#define IMPL_FORMAT_SETPIXEL_NOMASK( Format ) \
void BitmapReadAccess::SetPixelFor##Format( Scanline pScanline, long nX, const BitmapColor& rBitmapColor, const ColorMask& )
#define CASE_FORMAT( Format ) \
case( BMP_FORMAT##Format ): \
{ \
mFncGetPixel = GetPixelFor##Format;\
mFncSetPixel = SetPixelFor##Format;\
} \
break;
// --------------------
// - Access functions -
// --------------------
typedef BitmapColor (*FncGetPixel)( ConstScanline pScanline, long nX, const ColorMask& rMask );
typedef void (*FncSetPixel)( Scanline pScanline, long nX, const BitmapColor& rBitmapColor, const ColorMask& rMask );
// --------------------
// - BitmapReadAccess -
// --------------------
class VCL_DLLPUBLIC BitmapReadAccess
{
friend class BitmapWriteAccess;
private:
BitmapReadAccess() {}
BitmapReadAccess( const BitmapReadAccess& ) {}
BitmapReadAccess& operator=( const BitmapReadAccess& ) { return *this; }
protected:
Bitmap maBitmap;
BitmapBuffer* mpBuffer;
Scanline* mpScanBuf;
ColorMask maColorMask;
FncGetPixel mFncGetPixel;
FncSetPixel mFncSetPixel;
sal_Bool mbModify;
SAL_DLLPRIVATE void ImplCreate( Bitmap& rBitmap );
SAL_DLLPRIVATE void ImplDestroy();
SAL_DLLPRIVATE sal_Bool ImplSetAccessPointers( sal_uLong nFormat );
public:
SAL_DLLPRIVATE void ImplZeroInitUnusedBits();
SAL_DLLPRIVATE BitmapBuffer* ImplGetBitmapBuffer() const { return mpBuffer; }
DECL_FORMAT( _1BIT_MSB_PAL )
DECL_FORMAT( _1BIT_LSB_PAL )
DECL_FORMAT( _4BIT_MSN_PAL )
DECL_FORMAT( _4BIT_LSN_PAL )
DECL_FORMAT( _8BIT_PAL )
DECL_FORMAT( _8BIT_TC_MASK )
DECL_FORMAT( _16BIT_TC_MSB_MASK )
DECL_FORMAT( _16BIT_TC_LSB_MASK )
DECL_FORMAT( _24BIT_TC_BGR )
DECL_FORMAT( _24BIT_TC_RGB )
DECL_FORMAT( _24BIT_TC_MASK )
DECL_FORMAT( _32BIT_TC_ABGR )
DECL_FORMAT( _32BIT_TC_ARGB )
DECL_FORMAT( _32BIT_TC_BGRA )
DECL_FORMAT( _32BIT_TC_RGBA )
DECL_FORMAT( _32BIT_TC_MASK )
protected:
BitmapReadAccess( Bitmap& rBitmap, sal_Bool bModify );
public:
BitmapReadAccess( Bitmap& rBitmap );
virtual ~BitmapReadAccess();
inline sal_Bool operator!() const;
inline long Width() const;
inline long Height() const;
inline Point TopLeft() const;
inline Point BottomRight() const;
inline sal_Bool IsTopDown() const;
inline sal_Bool IsBottomUp() const;
inline sal_uLong GetScanlineFormat() const;
inline sal_uLong GetScanlineSize() const;
inline sal_uInt16 GetBitCount() const;
inline BitmapColor GetBestMatchingColor( const BitmapColor& rBitmapColor );
inline Scanline GetBuffer() const;
inline Scanline GetScanline( long nY ) const;
inline sal_Bool HasPalette() const;
inline const BitmapPalette& GetPalette() const;
inline sal_uInt16 GetPaletteEntryCount() const;
inline const BitmapColor& GetPaletteColor( sal_uInt16 nColor ) const;
inline const BitmapColor& GetBestPaletteColor( const BitmapColor& rBitmapColor ) const;
sal_uInt16 GetBestPaletteIndex( const BitmapColor& rBitmapColor ) const;
inline sal_Bool HasColorMask() const;
inline ColorMask& GetColorMask() const;
inline BitmapColor GetPixelFromData( const sal_uInt8* pData, long nX ) const;
inline void SetPixelOnData( sal_uInt8* pData, long nX, const BitmapColor& rBitmapColor );
inline BitmapColor GetPixel( long nY, long nX ) const;
inline BitmapColor GetColor( long nY, long nX ) const;
inline sal_uInt8 GetPixelIndex( long nY, long nX ) const;
inline sal_uInt8 GetLuminance( long nY, long nX ) const;
/** Get the interpolated color at coordinates fY, fX; if outside, return rFallback */
BitmapColor GetInterpolatedColorWithFallback( double fY, double fX, const BitmapColor& rFallback ) const;
/** Get the color at coordinates fY, fX; if outside, return rFallback. Automatically does the correct
inside/outside checks, e.g. static_cast< sal_uInt32 >(-0.25) *is* 0, not -1 and has to be outside */
BitmapColor GetColorWithFallback( double fY, double fX, const BitmapColor& rFallback ) const;
};
// ---------------------
// - BitmapWriteAccess -
// ---------------------
class VCL_DLLPUBLIC BitmapWriteAccess : public BitmapReadAccess
{
public:
BitmapWriteAccess( Bitmap& rBitmap );
virtual ~BitmapWriteAccess();
void CopyScanline( long nY, const BitmapReadAccess& rReadAcc );
void CopyScanline( long nY, ConstScanline aSrcScanline,
sal_uLong nSrcScanlineFormat, sal_uLong nSrcScanlineSize );
void CopyBuffer( const BitmapReadAccess& rReadAcc );
inline void SetPalette( const BitmapPalette& rPalette );
inline void SetPaletteEntryCount( sal_uInt16 nCount );
inline void SetPaletteColor( sal_uInt16 nColor, const BitmapColor& rBitmapColor );
inline void SetPixel( long nY, long nX, const BitmapColor& rBitmapColor );
inline void SetPixelIndex( long nY, long nX, sal_uInt8 cIndex );
void SetLineColor( const Color& rColor );
void SetFillColor( const Color& rColor );
void Erase( const Color& rColor );
void DrawLine( const Point& rStart, const Point& rEnd );
void FillRect( const Rectangle& rRect );
void DrawRect( const Rectangle& rRect );
private:
BitmapColor* mpLineColor;
BitmapColor* mpFillColor;
BitmapWriteAccess() {}
BitmapWriteAccess( const BitmapWriteAccess& ) : BitmapReadAccess() {}
BitmapWriteAccess& operator=( const BitmapWriteAccess& ) { return *this; }
};
// -----------
// - Inlines -
// -----------
inline sal_Bool BitmapReadAccess::operator!() const
{
return( mpBuffer == NULL );
}
// ------------------------------------------------------------------
inline long BitmapReadAccess::Width() const
{
return( mpBuffer ? mpBuffer->mnWidth : 0L );
}
// ------------------------------------------------------------------
inline long BitmapReadAccess::Height() const
{
return( mpBuffer ? mpBuffer->mnHeight : 0L );
}
// ------------------------------------------------------------------
inline Point BitmapReadAccess::TopLeft() const
{
return Point();
}
// ------------------------------------------------------------------
inline Point BitmapReadAccess::BottomRight() const
{
return Point( Width() - 1L, Height() - 1L );
}
// ------------------------------------------------------------------
inline sal_Bool BitmapReadAccess::IsTopDown() const
{
DBG_ASSERT( mpBuffer, "Access is not valid!" );
return( mpBuffer ? sal::static_int_cast<sal_Bool>( BMP_SCANLINE_ADJUSTMENT( mpBuffer->mnFormat ) == BMP_FORMAT_TOP_DOWN ) : sal_False );
}
// ------------------------------------------------------------------
inline sal_Bool BitmapReadAccess::IsBottomUp() const
{
return !IsTopDown();
}
// ------------------------------------------------------------------
inline sal_uLong BitmapReadAccess::GetScanlineFormat() const
{
DBG_ASSERT( mpBuffer, "Access is not valid!" );
return( mpBuffer ? BMP_SCANLINE_FORMAT( mpBuffer->mnFormat ) : 0UL );
}
// ------------------------------------------------------------------
inline sal_uLong BitmapReadAccess::GetScanlineSize() const
{
DBG_ASSERT( mpBuffer, "Access is not valid!" );
return( mpBuffer ? mpBuffer->mnScanlineSize : 0UL );
}
// ------------------------------------------------------------------
inline sal_uInt16 BitmapReadAccess::GetBitCount() const
{
DBG_ASSERT( mpBuffer, "Access is not valid!" );
return( mpBuffer ? mpBuffer->mnBitCount : 0 );
}
// ------------------------------------------------------------------
inline BitmapColor BitmapReadAccess::GetBestMatchingColor( const BitmapColor& rBitmapColor )
{
if( HasPalette() )
return BitmapColor( (sal_uInt8) GetBestPaletteIndex( rBitmapColor ) );
else
return rBitmapColor;
}
// ------------------------------------------------------------------
inline Scanline BitmapReadAccess::GetBuffer() const
{
DBG_ASSERT( mpBuffer, "Access is not valid!" );
return( mpBuffer ? mpBuffer->mpBits : NULL );
}
// ------------------------------------------------------------------
inline Scanline BitmapReadAccess::GetScanline( long nY ) const
{
DBG_ASSERT( mpBuffer, "Access is not valid!" );
DBG_ASSERT( nY < mpBuffer->mnHeight, "y-coordinate out of range!" );
return( mpBuffer ? mpScanBuf[ nY ] : NULL );
}
// ------------------------------------------------------------------
inline sal_Bool BitmapReadAccess::HasPalette() const
{
DBG_ASSERT( mpBuffer, "Access is not valid!" );
return( mpBuffer && !!mpBuffer->maPalette );
}
// ------------------------------------------------------------------
inline const BitmapPalette& BitmapReadAccess::GetPalette() const
{
DBG_ASSERT( mpBuffer, "Access is not valid!" );
return mpBuffer->maPalette;
}
// ------------------------------------------------------------------
inline sal_uInt16 BitmapReadAccess::GetPaletteEntryCount() const
{
DBG_ASSERT( HasPalette(), "Bitmap has no palette!" );
return( HasPalette() ? mpBuffer->maPalette.GetEntryCount() : 0 );
}
// ------------------------------------------------------------------
inline const BitmapColor& BitmapReadAccess::GetPaletteColor( sal_uInt16 nColor ) const
{
DBG_ASSERT( mpBuffer, "Access is not valid!" );
DBG_ASSERT( HasPalette(), "Bitmap has no palette!" );
return mpBuffer->maPalette[ nColor ];
}
// ------------------------------------------------------------------
inline const BitmapColor& BitmapReadAccess::GetBestPaletteColor( const BitmapColor& rBitmapColor ) const
{
return GetPaletteColor( GetBestPaletteIndex( rBitmapColor ) );
}
// ------------------------------------------------------------------
inline sal_Bool BitmapReadAccess::HasColorMask() const
{
DBG_ASSERT( mpBuffer, "Access is not valid!" );
const sal_uLong nFormat = BMP_SCANLINE_FORMAT( mpBuffer->mnFormat );
return( nFormat == BMP_FORMAT_8BIT_TC_MASK ||
nFormat == BMP_FORMAT_16BIT_TC_MSB_MASK ||
nFormat == BMP_FORMAT_16BIT_TC_LSB_MASK ||
nFormat == BMP_FORMAT_24BIT_TC_MASK ||
nFormat == BMP_FORMAT_32BIT_TC_MASK );
}
// ------------------------------------------------------------------
inline ColorMask& BitmapReadAccess::GetColorMask() const
{
DBG_ASSERT( mpBuffer, "Access is not valid!" );
return mpBuffer->maColorMask;
}
// ------------------------------------------------------------------
inline BitmapColor BitmapReadAccess::GetPixel( long nY, long nX ) const
{
DBG_ASSERT( mpBuffer, "Access is not valid!" );
DBG_ASSERT( nX < mpBuffer->mnWidth, "x-coordinate out of range!" );
DBG_ASSERT( nY < mpBuffer->mnHeight, "y-coordinate out of range!" );
return mFncGetPixel( mpScanBuf[ nY ], nX, maColorMask );
}
inline sal_uInt8 BitmapReadAccess::GetPixelIndex( long nY, long nX ) const
{
return GetPixel( nY, nX ).GetBlueOrIndex();
}
// ------------------------------------------------------------------
inline BitmapColor BitmapReadAccess::GetPixelFromData( const sal_uInt8* pData, long nX ) const
{
DBG_ASSERT( pData, "Access is not valid!" );
return mFncGetPixel( pData, nX, maColorMask );
}
// ------------------------------------------------------------------
inline void BitmapReadAccess::SetPixelOnData( sal_uInt8* pData, long nX, const BitmapColor& rBitmapColor )
{
DBG_ASSERT( pData, "Access is not valid!" );
mFncSetPixel( pData, nX, rBitmapColor, maColorMask );
}
// ------------------------------------------------------------------
inline BitmapColor BitmapReadAccess::GetColor( long nY, long nX ) const
{
if( HasPalette() )
return mpBuffer->maPalette[ GetPixelIndex( nY, nX ) ];
else
return GetPixel( nY, nX );
}
// ------------------------------------------------------------------
inline sal_uInt8 BitmapReadAccess::GetLuminance( long nY, long nX ) const
{
return GetColor( nY, nX ).GetLuminance();
}
// ------------------------------------------------------------------
inline void BitmapWriteAccess::SetPalette( const BitmapPalette& rPalette )
{
DBG_ASSERT( mpBuffer, "Access is not valid!" );
mpBuffer->maPalette = rPalette;
}
// ------------------------------------------------------------------
inline void BitmapWriteAccess::SetPaletteEntryCount( sal_uInt16 nCount )
{
DBG_ASSERT( mpBuffer, "Access is not valid!" );
mpBuffer->maPalette.SetEntryCount( nCount );
}
// ------------------------------------------------------------------
inline void BitmapWriteAccess::SetPaletteColor( sal_uInt16 nColor, const BitmapColor& rBitmapColor )
{
DBG_ASSERT( mpBuffer, "Access is not valid!" );
DBG_ASSERT( HasPalette(), "Bitmap has no palette!" );
mpBuffer->maPalette[ nColor ] = rBitmapColor;
}
// ------------------------------------------------------------------
inline void BitmapWriteAccess::SetPixel( long nY, long nX, const BitmapColor& rBitmapColor )
{
DBG_ASSERT( mpBuffer, "Access is not valid!" );
DBG_ASSERT( nX < mpBuffer->mnWidth, "x-coordinate out of range!" );
DBG_ASSERT( nY < mpBuffer->mnHeight, "y-coordinate out of range!" );
mFncSetPixel( mpScanBuf[ nY ], nX, rBitmapColor, maColorMask );
}
inline void BitmapWriteAccess::SetPixelIndex( long nY, long nX, sal_uInt8 cIndex )
{
SetPixel( nY, nX, BitmapColor( cIndex ));
}
// ------------------------------------------------------------------
#endif // INCLUDED_VCL_BMPACC_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */