epoc32/include/bitmap.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
// Copyright (c) 1995-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#if !defined(__BITMAP_H__)
williamr@2
    17
#define __BITMAP_H__
williamr@2
    18
#if !defined(__E32STD_H__)
williamr@2
    19
#include <e32std.h>
williamr@2
    20
#endif
williamr@2
    21
#if !defined(__F32FILE_H__)
williamr@2
    22
#include <f32file.h>
williamr@2
    23
#endif
williamr@2
    24
#if !defined(__GDI_H__)
williamr@2
    25
#include <gdi.h>
williamr@2
    26
#endif
williamr@2
    27
williamr@4
    28
#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@4
    29
#include <graphics/bitmapuid.h>
williamr@4
    30
#endif
williamr@4
    31
williamr@2
    32
#ifdef _DEBUG
williamr@2
    33
	#define SYMBIAN_DEBUG_FBS_LOCKHEAP
williamr@2
    34
#endif
williamr@2
    35
williamr@2
    36
//Forward declarations
williamr@2
    37
class CChunkPile;
williamr@2
    38
class TCompressionBookMark;
williamr@4
    39
class CFbsRasterizer;
williamr@2
    40
williamr@2
    41
/** 
williamr@2
    42
Defines the types of file compression. 
williamr@2
    43
@publishedAll
williamr@2
    44
@released
williamr@2
    45
*/
williamr@2
    46
enum TBitmapfileCompression
williamr@2
    47
	{
williamr@2
    48
	/** Bitmap file is not compressed. */
williamr@2
    49
	ENoBitmapCompression,
williamr@2
    50
	/** File is compressed using run-length encoding compression. */
williamr@2
    51
	EByteRLECompression,
williamr@2
    52
	/** File is compressed using twelve bit run-length encoding compression. */
williamr@2
    53
	ETwelveBitRLECompression,
williamr@2
    54
	/** File is compressed using sixteen bit run-length encoding compression. */
williamr@2
    55
	ESixteenBitRLECompression,
williamr@2
    56
	/** File is compressed using twenty four bit run-length encoding compression. */
williamr@2
    57
	ETwentyFourBitRLECompression,
williamr@2
    58
	/** File is compressed using twenty four bit run-length encoding compression from 32-bit bitmap buffer. */
williamr@2
    59
	EThirtyTwoUBitRLECompression,
williamr@2
    60
	/** File is compressed using thirty two bit run-length encoding compression from 32-bit bitmap buffer. */
williamr@2
    61
	EThirtyTwoABitRLECompression,
williamr@2
    62
	/** File is compressed as a palette plus reduced bit-per-pixel.  Only applicable to bitmaps already loaded in RAM. */
williamr@2
    63
	EGenericPaletteCompression,
williamr@4
    64
	/** Extended bitmap. Data format is proprietary to licensee. */
williamr@4
    65
	EProprietaryCompression,
williamr@2
    66
	//Insert new enum items here!
williamr@2
    67
	ERLECompressionLast = 255
williamr@2
    68
	};
williamr@2
    69
williamr@2
    70
/** 
williamr@2
    71
Defines the available file compression schemes. 
williamr@2
    72
@publishedAll
williamr@2
    73
@released
williamr@2
    74
*/
williamr@2
    75
enum TBitmapfileCompressionScheme
williamr@2
    76
	{
williamr@2
    77
	/** File is compressed using run-length encoding compression. */
williamr@2
    78
	ERLECompression,
williamr@2
    79
	/** File is compressed as a palette plus reduced bit-per-pixel. */
williamr@2
    80
	EPaletteCompression,
williamr@2
    81
	/** File is compressed as a palette plus reduced bit-per-pixel, with automatic fallback to RLE if bitmap is not suitable*/
williamr@2
    82
	EPaletteCompressionWithRLEFallback
williamr@2
    83
	};
williamr@2
    84
williamr@2
    85
/**
williamr@4
    86
WARNING: Typedef for internal use ONLY. Compatibility is not guaranteed in future releases.
williamr@4
    87
@publishedAll
williamr@4
    88
@released
williamr@4
    89
 */
williamr@2
    90
typedef void (*TAssignFunction)(TUint8*& aDestPtr, TUint32 aColor);
williamr@2
    91
/**
williamr@4
    92
WARNING: Typedef for internal use ONLY. Compatibility is not guaranteed in future releases.
williamr@4
    93
@publishedAll
williamr@4
    94
@released
williamr@4
    95
 */
williamr@2
    96
typedef void (*TDecodeFunction)(TUint8* aDataPtr, TUint32* aPalettePtr, TUint8*& aDestPtr, TAssignFunction aAssignFunction);
williamr@2
    97
williamr@2
    98
/** 
williamr@2
    99
Contains information about the bitmap when streaming bitmaps to stores. 
williamr@2
   100
@publishedAll
williamr@2
   101
@released
williamr@2
   102
*/
williamr@2
   103
class SEpocBitmapHeader
williamr@2
   104
	{
williamr@2
   105
public:
williamr@2
   106
	inline SEpocBitmapHeader() :
williamr@2
   107
		iBitmapSize(sizeof(SEpocBitmapHeader)),
williamr@2
   108
		iStructSize(sizeof(SEpocBitmapHeader)),
williamr@2
   109
		iSizeInPixels(0, 0),
williamr@2
   110
		iSizeInTwips(0, 0),
williamr@2
   111
		iBitsPerPixel(0),
williamr@2
   112
		iColor(0),
williamr@2
   113
		iPaletteEntries(0),
williamr@2
   114
		iCompression(ENoBitmapCompression)
williamr@2
   115
		{
williamr@2
   116
		}
williamr@2
   117
public:
williamr@2
   118
	/** Defines whether bitmap is colour and if it comprises an alpha channel. */ 
williamr@2
   119
	enum TColor 
williamr@2
   120
		{
williamr@2
   121
		/** Bitmap doesn't comprise color */
williamr@2
   122
		ENoColor=0, 
williamr@2
   123
		/** Bitmap comprises color */
williamr@2
   124
		EColor=1, 
williamr@2
   125
		/** Bitmap comprises color with alpha channel */
williamr@2
   126
		EColorAlpha=2, 
williamr@2
   127
		/** Bitmap comprises pre-multiplied colors with alpha channel */
williamr@2
   128
		EColorAlphaPM=3,
williamr@2
   129
		/** Unknown format */
williamr@2
   130
		EColorUndefined=8
williamr@2
   131
		};
williamr@2
   132
public:
williamr@2
   133
	/** The size of the bitmap data, in bytes. */
williamr@2
   134
	TInt iBitmapSize;
williamr@2
   135
	/** The size of the structure in which the bitmap data is stored. */
williamr@2
   136
	TInt iStructSize;
williamr@2
   137
	/** The size of the bitmap, in pixels. */
williamr@2
   138
	TSize iSizeInPixels;
williamr@2
   139
	/** The size of the bitmap, in twips. */
williamr@2
   140
	TSize iSizeInTwips;
williamr@2
   141
	/** The bitmap's number of bits per pixel */
williamr@2
   142
	TInt iBitsPerPixel;
williamr@2
   143
	/** Whether or not the bitmap is colour and comprises an alpha value. */
williamr@2
   144
	TInt iColor;
williamr@2
   145
	/** The number of entries in the bitmap's palette. */
williamr@2
   146
	TInt iPaletteEntries;
williamr@2
   147
	/** The type of compression used to store the bitmap. */
williamr@2
   148
	TBitmapfileCompression iCompression;
williamr@2
   149
	};
williamr@2
   150
williamr@4
   151
/**
williamr@4
   152
WARNING: Class for internal use ONLY.  Compatibility is not guaranteed in future releases.
williamr@4
   153
williamr@4
   154
@publishedAll
williamr@4
   155
@released 
williamr@4
   156
 */
williamr@2
   157
class TLineScanningPosition
williamr@2
   158
	{
williamr@2
   159
public:
williamr@4
   160
	inline TLineScanningPosition(TUint32* aSrcDataPtr);
williamr@2
   161
public:
williamr@2
   162
	TUint8* iSrcDataPtr;
williamr@2
   163
	TInt iCursorPos;
williamr@2
   164
	HBufC8* iScanLineBuffer;
williamr@4
   165
	CFbsRasterizer* const iRasterizer;
williamr@2
   166
	};
williamr@2
   167
williamr@2
   168
class CShiftedFileStore;
williamr@4
   169
williamr@2
   170
/**
williamr@2
   171
BitGdi bitmap class (pseudo-CXxx class).
williamr@4
   172
WARNING: Class for internal use ONLY.  Compatibility is not guaranteed in future releases.
williamr@2
   173
@released
williamr@2
   174
*/
williamr@2
   175
class CBitwiseBitmap
williamr@2
   176
	{
williamr@2
   177
	friend class CFbTop;
williamr@2
   178
	friend class CFbClient;
williamr@2
   179
	friend class CFbsBitmap;
williamr@2
   180
	friend class CBitmapObject;
williamr@2
   181
	friend class CFbsBitmapAsyncStreamer;
williamr@2
   182
	friend class CFbsBackgroundCompression;
williamr@2
   183
	friend class CleanupDelete<CBitwiseBitmap>;
williamr@2
   184
public:
williamr@2
   185
	IMPORT_C TUid Uid() const;
williamr@2
   186
	IMPORT_C void ExternalizeL(RWriteStream& aStream,const CFbsBitmap& aHandleBitmap) const;
williamr@2
   187
	IMPORT_C void ExternalizeRectangleL(RWriteStream& aStream,const TRect& aRect,const CFbsBitmap& aHandleBitmap) const;
williamr@2
   188
	IMPORT_C void InternalizeL(RReadStream& aStream);
williamr@2
   189
	IMPORT_C static void InternalizeHeaderL(RReadStream& aStream,SEpocBitmapHeader& aHeader);
williamr@2
   190
	IMPORT_C TSize SizeInPixels() const;
williamr@2
   191
	IMPORT_C TSize SizeInTwips() const;
williamr@2
   192
	IMPORT_C TDisplayMode DisplayMode() const;
williamr@2
   193
	IMPORT_C TInt HorizontalTwipsToPixels(TInt aTwips) const;
williamr@2
   194
	IMPORT_C TInt VerticalTwipsToPixels(TInt aTwips) const;
williamr@2
   195
	IMPORT_C TInt HorizontalPixelsToTwips(TInt aPixels) const;
williamr@2
   196
	IMPORT_C TInt VerticalPixelsToTwips(TInt aPixels) const;
williamr@4
   197
	IMPORT_C void GetPixel(TRgb& aColor,const TPoint& aPos,TUint32* aBase, CFbsRasterizer* aRasterizer) const;
williamr@2
   198
	IMPORT_C TInt GetScanLinePtr(TUint32*& aSlptr, TPoint& aPixel,TInt aLength, TUint32* aBase, TLineScanningPosition& aLineScanningPosition) const;
williamr@2
   199
	IMPORT_C TInt GetScanLinePtr(TUint32*& aSlptr, TInt& aLength, TPoint& aPixel,TUint32* aBase, TLineScanningPosition& aLineScanningPosition) const;
williamr@2
   200
	IMPORT_C void GetScanLine(TDes8& aBuf,const TPoint& aPixel,TInt aLength,TBool aDither,const TPoint& aDitherOffset,TDisplayMode aDispMode,TUint32* aBase, TLineScanningPosition& aLineScanningPosition) const;
williamr@2
   201
	IMPORT_C void GetScanLine(TUint32*& aSlptr, TDes8& aBuf,const TPoint& aPixel,TInt aLength,TBool aDither,const TPoint& aDitherOffset,TDisplayMode aDispMode) const;
williamr@2
   202
	IMPORT_C void GetScanLine(TDes8& aBuf,const TPoint& aPixel,TInt aLength,TBool aDither,const TPoint& aDitherOffset,TDisplayMode aDispMode,TUint32* aBase) const;
williamr@4
   203
	IMPORT_C void GetVerticalScanLine(TDes8& aBuf,TInt aX,TBool aDither,const TPoint& aDitherOffset,TDisplayMode aDispMode,TUint32* aBase, CFbsRasterizer* aRasterizer) const;
williamr@2
   204
	IMPORT_C void StretchScanLine(TDes8& aBuf,const TPoint& aPixel,TInt aClipStrchX,TInt aClipStrchLen,TInt aStretchLength,TInt aOrgX,TInt aOrgLen,const TPoint& aDitherOffset,TDisplayMode aDispMode,TUint32* aBase) const;
williamr@2
   205
	IMPORT_C void StretchScanLine(TDes8& aBuf,const TPoint& aPixel,TInt aClipStrchX,TInt aClipStrchLen,TInt aStretchLength,TInt aOrgX,TInt aOrgLen,const TPoint& aDitherOffset,TDisplayMode aDispMode,TUint32* aBase, TLineScanningPosition& aLineScanningPosition) const;
williamr@2
   206
	IMPORT_C TUint32* ScanLineAddress(TUint32* aBase,TUint aY) const;
williamr@2
   207
	IMPORT_C TBool IsMonochrome(TUint32* aBase) const;
williamr@2
   208
	IMPORT_C TBool IsLargeBitmap() const;
williamr@2
   209
	IMPORT_C TInt CompressData();
williamr@2
   210
	IMPORT_C TInt CompressData(TBitmapfileCompressionScheme aScheme);
williamr@2
   211
	IMPORT_C TInt CheckBackgroundCompressData();
williamr@2
   212
	IMPORT_C void SetCompressionBookmark(TLineScanningPosition& aLineScanningPosition, TUint32* aBase, const CFbsBitmap* aFbsBitmap);
williamr@2
   213
	IMPORT_C TInt HardwareBitmapHandle() const;
williamr@2
   214
	IMPORT_C TBool IsCompressedInRAM() const;
williamr@2
   215
	IMPORT_C TBool IsCompressed() const;
williamr@2
   216
	IMPORT_C TInt DataStride() const;
williamr@2
   217
	IMPORT_C SEpocBitmapHeader Header() const;
williamr@2
   218
private:
williamr@2
   219
	IMPORT_C void operator delete(TAny*);
williamr@2
   220
	void operator delete(TAny*, TAny*) {}     // This function exists only to prevent a compiler warning
williamr@2
   221
	IMPORT_C CBitwiseBitmap(RHeap* aHeap,CChunkPile* aPile);
williamr@2
   222
	IMPORT_C ~CBitwiseBitmap();
williamr@2
   223
	IMPORT_C void Reset();
williamr@2
   224
	IMPORT_C TInt Construct(const TSize& aSize,TDisplayMode aDispMode,TUid aCreatorUid);
williamr@4
   225
	IMPORT_C TInt ConstructExtended(const TSize& aSize, TDisplayMode aDispMode, TUid aType, TInt aDataSize);
williamr@2
   226
	IMPORT_C void ConstructL(RFs& aFs,const TDesC& aFilename,TInt32 aId,TUint aFileOffset);
williamr@2
   227
	IMPORT_C void ConstructL(RFile& aFile,TInt32 aId,TUint aFileOffset);
williamr@2
   228
	IMPORT_C void ConstructL(CShiftedFileStore* aFileStore,TStreamId aStreamId);
williamr@2
   229
	IMPORT_C TInt CopyData(const CBitwiseBitmap& aSourceBitmap);
williamr@2
   230
private:
williamr@2
   231
	void GenerateLineFromCompressedTwelveBitData(TUint8* aDestBuffer, const TPoint& aPixel,TInt aLength,TUint32* aBase, TLineScanningPosition& aLineScanningPosition) const;
williamr@2
   232
	void GenerateLineFromCompressedEightBitData(TUint8* aDestBuffer, const TPoint& aPixel,TInt aLength,TUint32* aBase, TLineScanningPosition& aLineScanningPosition) const;
williamr@2
   233
	TUint8 GetGrayPixelEx(TInt aX,TUint32* aScanLineAddress) const;
williamr@2
   234
	TRgb GetRgbPixelEx(TInt aX,TUint32* aScanLineAddress) const;
williamr@2
   235
	void GetRgbPixelExMany(TInt aX,TUint32* aScanlinePtr,TUint32* aDest,TInt aLength) const;
williamr@2
   236
    void GetRgbPixelExMany16M(TInt aX,TUint32* aScanlinePtr,TUint8* aDest,TInt aLength) const;
williamr@2
   237
    void GetRgbPixelExMany16MAP(TInt aX,TUint32* aScanlinePtr,TUint32* aDest,TInt aLength) const;
williamr@2
   238
	void GetScanLineGray2(TDes8& aBuf,const TPoint& aPixel,TInt aLength,TBool aDither,const TPoint& aDitherOffset,TUint32* aScanlinePtr) const;
williamr@2
   239
	void GetScanLineGray4(TDes8& aBuf,const TPoint& aPixel,TInt aLength,TBool aDither,const TPoint& aDitherOffset,TUint32* aScanlinePtr) const;
williamr@2
   240
	void GetScanLineGray16(TDes8& aBuf,const TPoint& aPixel,TInt aLength,TUint32* aScanlinePtr) const;
williamr@2
   241
	void GetScanLineGray256(TDes8& aBuf,const TPoint& aPixel,TInt aLength,TUint32* aScanlinePtr) const;
williamr@2
   242
	void GetScanLineColor16(TDes8& aBuf,const TPoint& aPixel,TInt aLength,TUint32* aScanlinePtr) const;
williamr@2
   243
	void GetScanLineColor256(TDes8& aBuf,const TPoint& aPixel,TInt aLength,TUint32* aScanlinePtr) const;
williamr@2
   244
	void GetScanLineColor4K(TDes8& aBuf,const TPoint& aPixel,TInt aLength,TUint32* aScanlinePtr) const;
williamr@2
   245
	void GetScanLineColor64K(TDes8& aBuf,const TPoint& aPixel,TInt aLength,TUint32* aScanlinePtr) const;
williamr@2
   246
	void GetScanLineColor16M(TDes8& aBuf,const TPoint& aPixel,TInt aLength,TUint32* aScanlinePtr) const;
williamr@2
   247
	void GetScanLineColor16MU(TDes8& aBuf,const TPoint& aPixel,TInt aLength,TUint32* aScanlinePtr) const;
williamr@2
   248
	void GetScanLineColorRgb(TDes8& aBuf,const TPoint& aPixel,TInt aLength,TUint32* aScanlinePtr) const;
williamr@2
   249
	void GetScanLineExBits(TDes8& aBuf,TInt aX,TInt aLength,TUint32* aScanlinePtr) const;
williamr@2
   250
	void GetScanLineExBytes(TDes8& aBuf,TInt aX,TInt aLength,TUint32* aScanlinePtr) const;
williamr@2
   251
	void DoExternalizeDataCompressedL(RWriteStream& aStream,TUint8* aData,TInt aSizeInBytes) const;
williamr@2
   252
	void DoExternalizeByteDataCompressedL(RWriteStream& aStream,TUint8* aData,TInt aSizeInBytes) const;
williamr@2
   253
	void DoExternalizeTwelveBitDataCompressedL(RWriteStream& aStream,TUint8* aData,TInt aSizeInBytes) const;
williamr@2
   254
	void DoExternalizeSixteenBitDataCompressedL(RWriteStream& aStream,TUint8* aData,TInt aSizeInBytes) const;
williamr@2
   255
	void DoExternalizeTwentyFourBitDataCompressedL(RWriteStream& aStream,TUint8* aData,TInt aSizeInBytes) const;
williamr@2
   256
	void DoExternalizeThirtyTwoUBitDataCompressedL(RWriteStream& aStream,TUint8* aData,TInt aSizeInBytes) const;
williamr@2
   257
	void DoExternalizeThirtyTwoABitDataCompressedL(RWriteStream& aStream,TUint8* aData,TInt aSizeInBytes) const;
williamr@2
   258
	TInt SizeOfDataCompressed(TUint8* aData,TInt aSizeInBytes) const;
williamr@2
   259
	TInt SizeOfByteDataCompressed(TUint8* aData,TInt aSizeInBytes) const;
williamr@2
   260
	TInt SizeOfTwelveBitDataCompressed(TUint8* aData,TInt aSizeInBytes) const;
williamr@2
   261
	TInt SizeOfSixteenBitDataCompressed(TUint8* aData,TInt aSizeInBytes) const;
williamr@2
   262
	TInt SizeOfTwentyFourBitDataCompressed(TUint8* aData,TInt aSizeInBytes) const;
williamr@2
   263
	TInt SizeOfThirtyTwoUBitDataCompressed(TUint8* aData,TInt aSizeInBytes) const;
williamr@2
   264
	TInt SizeOfThirtyTwoABitDataCompressed(TUint8* aData,TInt aSizeInBytes) const;
williamr@2
   265
	TBool TrueColorPointerCompare(TUint8* aColorPointer,TUint8 aComponent1,TUint8 aComponent2,TUint8 aComponent3) const;
williamr@2
   266
	TBool ColorAlphaPointerCompare(TUint8* aColorPointer,TUint8 aComponent1,TUint8 aComponent2,TUint8 aComponent3,TUint8 aComponent4) const;
williamr@2
   267
	void DoInternalizeL(RReadStream& aStream,TInt aSrceSize,TUint32* aBase);
williamr@2
   268
	void DoInternalizeCompressedDataL(RReadStream& aStream,TInt aSrceSize,TUint32* aBase,TBitmapfileCompression aCompression);
williamr@2
   269
	void DoDecompressByteData(TUint8* aDestBuffer,TInt aDestSize,TUint8* aSrceBuffer,TInt aSrceSize);
williamr@2
   270
williamr@2
   271
	void DoDecompressByteDataAltL(RReadStream& aStream,TInt aSrceSizeInBytes,TUint32* aBase);
williamr@2
   272
	void DoDecompressTwelveBitData(TUint8* aDestBuffer,TInt aDestSize,TUint8* aSrceBuffer,TInt aSrceSize);
williamr@2
   273
	void DoDecompressTwelveBitDataAltL(RReadStream& aStream,TInt aSrceSizeInBytes,TUint32* aBase);
williamr@2
   274
	void DoDecompressSixteenBitData(TUint8* aDestBuffer,TInt aDestSize,TUint8* aSrceBuffer,TInt aSrceSize);
williamr@2
   275
	void DoDecompressSixteenBitDataAltL(RReadStream& aStream,TInt aSrceSizeInBytes,TUint32* aBase);
williamr@2
   276
	void DoDecompressTwentyFourBitData(TUint8* aDestBuffer,TInt aDestSize,TUint8* aSrceBuffer,TInt aSrceSize);
williamr@2
   277
	void DoDecompressTwentyFourBitDataAltL(RReadStream& aStream,TInt aSrceSizeInBytes,TUint32* aBase);
williamr@2
   278
	void DoDecompressThirtyTwoUBitData(TUint8* aDestBuffer,TInt aDestSize,TUint8* aSrceBuffer,TInt aSrceSize);
williamr@2
   279
	void DoDecompressThirtyTwoUBitDataAltL(RReadStream& aStream,TInt aSrceSizeInBytes,TUint32* aBase);
williamr@2
   280
	void DoDecompressThirtyTwoABitData(TUint8* aDestBuffer,TInt aDestSize,TUint8* aSrceBuffer,TInt aSrceSize);
williamr@2
   281
	void DoDecompressThirtyTwoABitDataAltL(RReadStream& aStream,TInt aSrceSizeInBytes,TUint32* aBase);
williamr@2
   282
	void DoStretchScanLine(TDes8& aBuf,TInt x,TInt y,TInt aClipStrchX,TInt aClipStrchLen,TInt aStretchLength,TInt aOrgX,TInt aOrgLen,const TPoint& aDitherOffset,TDisplayMode aDispMode,TUint32* aBase,TLineScanningPosition& aLineScanningPosition) const;
williamr@2
   283
	void DoCompressScanLine(TDes8& aBuf,TInt x,TInt y,TInt aClipStrchX,TInt aClipStrchLen,TInt aStretchLength,TInt aOrgX,TInt aOrgLen,const TPoint& aDitherOffset,TDisplayMode aDispMode,TUint32* aBase,TLineScanningPosition& aLineScanningPosition) const;
williamr@2
   284
	TUint32 HashTo1bpp(TUint32 aGray256,TBool aOddX,TBool aOddY) const;
williamr@2
   285
	TUint32 HashTo2bpp(TUint32 aGray256,TInt aDitherIndex) const;
williamr@2
   286
	TBool IsWordMonochrome(TUint32 aWord) const;
williamr@2
   287
	TUint32* DataAddress() const;
williamr@2
   288
	static void WhiteFill(TUint8* aData,TInt aDataSize,TDisplayMode aDispMode);
williamr@2
   289
	static TInt ByteWidth(TInt aPixelWidth,TDisplayMode aDispMode);
williamr@2
   290
	static TInt Bpp(TDisplayMode aDispMode);
williamr@2
   291
	static TInt IsColor(TDisplayMode aDispMode);
williamr@2
   292
	static TDisplayMode DisplayMode(TInt aBpp,TInt aColor);
williamr@2
   293
	static TBitmapfileCompression CompressionType(TInt aBpp, TInt aColor);
williamr@2
   294
	TInt DoGetScanLinePtr(TUint32*& aSlptr, TPoint& aPixel,TInt aLength, TUint32* aBase, TLineScanningPosition& aLineScanningPosition) const;
williamr@2
   295
	void GenerateLineFromCompressedSixteenBitData(TUint8* aDestBuffer, const TPoint& aPixel,TInt aLength, TUint32* aBase, TLineScanningPosition& aLineScanningPosition) const;
williamr@2
   296
	TDisplayMode InitialDisplayMode() const;
williamr@2
   297
	TInt SetDisplayMode(TDisplayMode aDisplayMode, TUint32* aDataAddress);
williamr@2
   298
	TInt DisplayModeArgCheck(TDisplayMode aDisplayMode, TUint32* aDataAddress) const;
williamr@2
   299
	void ChangeDisplayMode( TDisplayMode aNewDisplayMode,
williamr@2
   300
							TInt aScanLineWidthNew,
williamr@2
   301
							TUint8* aDataAddrNew,
williamr@2
   302
							TUint32* aDataAddress,
williamr@2
   303
							TInt aYStart,
williamr@2
   304
							TInt aYInc,
williamr@2
   305
							TInt aYEnd);
williamr@2
   306
	void UpdateBitmapProperties(TDisplayMode aNewDisplayMode);
williamr@2
   307
	TInt SwapWidthAndHeight(TUint32* aDataAddress);	
williamr@2
   308
	void GenerateLineFromCompressed24BitData(TUint8* aDestBuffer, const TPoint& aPixel,TInt aLength, TUint32* aBase, TLineScanningPosition& aLineScanningPosition) const;
williamr@2
   309
	void GenerateLineFromCompressed32UBitData(TUint8* aDestBuffer, const TPoint& aPixel,TInt aLength, TUint32* aBase, TLineScanningPosition& aLineScanningPosition) const;
williamr@2
   310
	void GenerateLineFromCompressed32ABitData(TUint8* aDestBuffer, const TPoint& aPixel,TInt aLength, TUint32* aBase, TLineScanningPosition& aLineScanningPosition) const;
williamr@2
   311
	void AdjustXCoord(TInt& aX) const;
williamr@2
   312
	void GetLineScanPos(TLineScanningPosition& aLineScanPos, 
williamr@2
   313
						const TCompressionBookMark*& aComprBookMark, 
williamr@2
   314
						const TUint8* aBase) const;
williamr@2
   315
	void UpdateBookMark(const TLineScanningPosition& aLineScanPos, 
williamr@2
   316
						TCompressionBookMark* aComprBookMark, 
williamr@2
   317
						const TUint8* aBase) const;
williamr@2
   318
	void GetScanLineColor16MA(TDes8& aBuf,const TPoint& aPixel,TInt aLength,TUint32* aScanlinePtr) const;
williamr@2
   319
	void GetScanLineColor16MAP(TDes8& aBuf,const TPoint& aPixel,TInt aLength,TUint32* aScanlinePtr) const;
williamr@2
   320
	TInt PaletteCompress();
williamr@2
   321
	void GenerateLineFromPaletteCompressedData(TUint8* aDestBuffer, const TPoint& aPixel,TInt aLength, TUint32* aBase, TLineScanningPosition& aLineScanningPosition) const;
williamr@2
   322
	TUint PaletteBitsPerPixel(TInt aNumColors) const;
williamr@2
   323
	TUint PaletteBytesPerPixel(TInt aBitsPerPixel) const;
williamr@2
   324
	void PaletteDecodeAndAssignGeneric(TUint8* aDataPtr, TUint32* aPalettePtr, TUint8*& aDestPtr, TUint aStartPixel, TUint aEndPixel, TUint aCompressedPixelsPerByte, TUint aCompressedBitsPerPixel) const;
williamr@2
   325
	static void PaletteDecode1PixelPerByte(TUint8* aDataPtr, TUint32* aPalettePtr, TUint8*& aDestPtr, TAssignFunction aAssignFunction);
williamr@2
   326
	static void PaletteDecode2PixelPerByte(TUint8* aDataPtr, TUint32* aPalettePtr, TUint8*& aDestPtr, TAssignFunction aAssignFunction);
williamr@2
   327
	static void PaletteDecode4PixelPerByte(TUint8* aDataPtr, TUint32* aPalettePtr, TUint8*& aDestPtr, TAssignFunction aAssignFunction);
williamr@2
   328
	static void PaletteDecode8PixelPerByte(TUint8* aDataPtr, TUint32* aPalettePtr, TUint8*& aDestPtr, TAssignFunction aAssignFunction);
williamr@2
   329
	static void PaletteAssign16BitColor(TUint8*& aDestPtr, TUint32 aColor);
williamr@2
   330
	static void PaletteAssign24BitColor(TUint8*& aDestPtr, TUint32 aColor);
williamr@2
   331
	static void PaletteAssign32BitColor(TUint8*& aDestPtr, TUint32 aColor);
williamr@2
   332
	void UpdatePaddingData(TUint32* aData);
williamr@2
   333
	static void CheckHeaderIsValidL(const SEpocBitmapHeader& aHeader);
williamr@2
   334
	static TInt CompressedFormatInfo(TDisplayMode aDispMode, TInt& aBytesPerPack, TInt& aBytesPerCompressed);
williamr@2
   335
	static void BitmapFill32(TUint32* aDestPtr32, TInt aCount, TUint32 aValue32);
williamr@2
   336
	static inline void BitmapFill16(TUint16* aDestPtr16, TInt aCount, TUint16 aValue16);
williamr@2
   337
private:
williamr@4
   338
	struct TExtra
williamr@4
   339
		{
williamr@4
   340
#ifdef SYMBIAN_DEBUG_FBS_LOCKHEAP
williamr@4
   341
		TInt iLockCount; // number of calls to CFbsBitmap::LockHeap() not balanced by calls to CFbsBitmap::UnlockHeap()
williamr@4
   342
		TThreadId iThreadId; // id of thread that called CFbsBitmap::LockHeap() if any
williamr@4
   343
#endif
williamr@4
   344
		TInt64 iSerialNumber; // serial number of bitmap which is unique to the whole FBServ
williamr@4
   345
		TInt iTouchCount; // number of calls to TouchBitmap()i.e. number of times bitmap has been changed
williamr@4
   346
		};
williamr@4
   347
	inline TExtra* Extra() const; // only for bitmaps created in RAM
williamr@4
   348
private:
williamr@2
   349
	TUid iUid;
williamr@2
   350
	struct TSettings
williamr@2
   351
		{
williamr@2
   352
		TSettings(TDisplayMode aDisplayMode);
williamr@2
   353
		void SetDisplayModes(TDisplayMode aDisplayMode);
williamr@2
   354
		void SetCurrentDisplayMode(TDisplayMode aDisplayMode);
williamr@2
   355
		TDisplayMode CurrentDisplayMode() const;
williamr@2
   356
		TDisplayMode InitialDisplayMode() const;
williamr@2
   357
		inline void SetDirtyBitmap();
williamr@2
   358
		inline TBool IsDirtyBitmap() const;
williamr@4
   359
		inline void SetVolatileBitmap();
williamr@4
   360
		inline TBool IsVolatileBitmap() const;
williamr@2
   361
		enum
williamr@2
   362
			{
williamr@4
   363
			EBitmapFlagDirty = 0x00010000, // set in the old bitmap when a re-allocating operation has created a new bitmap
williamr@4
   364
			EBitmapFlagVolatile = 0x00020000, // set when DataAddress() has been called but BeginDataAccess() has not
williamr@2
   365
			};
williamr@2
   366
		TUint32 iData;
williamr@2
   367
		} iSettings;
williamr@2
   368
	RHeap* iHeap;
williamr@2
   369
	CChunkPile* iPile;
williamr@2
   370
	TInt iByteWidth;
williamr@2
   371
	SEpocBitmapHeader iHeader;
williamr@4
   372
	TInt iSpare;
williamr@2
   373
	TInt iDataOffset; // offset in bytes from "this" or from base of bitmap chunk, or hardware bitmap handle
williamr@2
   374
	TBool iIsCompressedInRAM; //flag indicating whether CompressData has been called
williamr@2
   375
	};
williamr@2
   376
williamr@2
   377
#endif