/*******************************************************************************

 * Copyright (c) 2005, 2010 Nokia Corporation and/or its subsidiary(-ies).

 * All rights reserved. This program and the accompanying materials

 * are made available under the terms of the Eclipse Public License v1.0

 * which accompanies this distribution, and is available at

 * http://www.eclipse.org/legal/epl-v10.html

 *

 * Contributors:

 *     Nokia Corporation - S60 implementation

 *******************************************************************************/

#include "swtimage.h"

#include "swtgrimagedata.h"

#include "swtgrpalettedata.h"

#include "swtcontrolhelper.h"

#include "swtdisplay.h" // needed for macro definitions

// Look-up table for the bit-reversed value of a byte.

static const TUint8 KBitReverseTable[256] =

{

    0x00, 0x80, 0x40, 0xc0, 0x20, 0xa0, 0x60, 0xe0,

    0x10, 0x90, 0x50, 0xd0, 0x30, 0xb0, 0x70, 0xf0,

    0x08, 0x88, 0x48, 0xc8, 0x28, 0xa8, 0x68, 0xe8,

    0x18, 0x98, 0x58, 0xd8, 0x38, 0xb8, 0x78, 0xf8,

    0x04, 0x84, 0x44, 0xc4, 0x24, 0xa4, 0x64, 0xe4,

    0x14, 0x94, 0x54, 0xd4, 0x34, 0xb4, 0x74, 0xf4,

    0x0c, 0x8c, 0x4c, 0xcc, 0x2c, 0xac, 0x6c, 0xec,

    0x1c, 0x9c, 0x5c, 0xdc, 0x3c, 0xbc, 0x7c, 0xfc,

    0x02, 0x82, 0x42, 0xc2, 0x22, 0xa2, 0x62, 0xe2,

    0x12, 0x92, 0x52, 0xd2, 0x32, 0xb2, 0x72, 0xf2,

    0x0a, 0x8a, 0x4a, 0xca, 0x2a, 0xaa, 0x6a, 0xea,

    0x1a, 0x9a, 0x5a, 0xda, 0x3a, 0xba, 0x7a, 0xfa,

    0x06, 0x86, 0x46, 0xc6, 0x26, 0xa6, 0x66, 0xe6,

    0x16, 0x96, 0x56, 0xd6, 0x36, 0xb6, 0x76, 0xf6,

    0x0e, 0x8e, 0x4e, 0xce, 0x2e, 0xae, 0x6e, 0xee,

    0x1e, 0x9e, 0x5e, 0xde, 0x3e, 0xbe, 0x7e, 0xfe,

    0x01, 0x81, 0x41, 0xc1, 0x21, 0xa1, 0x61, 0xe1,

    0x11, 0x91, 0x51, 0xd1, 0x31, 0xb1, 0x71, 0xf1,

    0x09, 0x89, 0x49, 0xc9, 0x29, 0xa9, 0x69, 0xe9,

    0x19, 0x99, 0x59, 0xd9, 0x39, 0xb9, 0x79, 0xf9,

    0x05, 0x85, 0x45, 0xc5, 0x25, 0xa5, 0x65, 0xe5,

    0x15, 0x95, 0x55, 0xd5, 0x35, 0xb5, 0x75, 0xf5,

    0x0d, 0x8d, 0x4d, 0xcd, 0x2d, 0xad, 0x6d, 0xed,

    0x1d, 0x9d, 0x5d, 0xdd, 0x3d, 0xbd, 0x7d, 0xfd,

    0x03, 0x83, 0x43, 0xc3, 0x23, 0xa3, 0x63, 0xe3,

    0x13, 0x93, 0x53, 0xd3, 0x33, 0xb3, 0x73, 0xf3,

    0x0b, 0x8b, 0x4b, 0xcb, 0x2b, 0xab, 0x6b, 0xeb,

    0x1b, 0x9b, 0x5b, 0xdb, 0x3b, 0xbb, 0x7b, 0xfb,

    0x07, 0x87, 0x47, 0xc7, 0x27, 0xa7, 0x67, 0xe7,

    0x17, 0x97, 0x57, 0xd7, 0x37, 0xb7, 0x77, 0xf7,

    0x0f, 0x8f, 0x4f, 0xcf, 0x2f, 0xaf, 0x6f, 0xef,

    0x1f, 0x9f, 0x5f, 0xdf, 0x3f, 0xbf, 0x7f, 0xff

};

// ======== MEMBER FUNCTIONS ========

// ---------------------------------------------------------------------------

// CSwtImage::NewL

// ---------------------------------------------------------------------------

//

CSwtImage* CSwtImage::NewL(MSwtDevice& aDevice, const TSize& aSize,

                           MSwtDisplay& aDisplay, TDisplayMode aMode /*=ENone*/)

{

    CSwtImage* self = new(ELeave) CSwtImage(&aDevice, &aDisplay);

    CleanupStack::PushL(self);

    self->ConstructL(aSize, aMode);

    CleanupStack::Pop(self);

    return self;

}

// ---------------------------------------------------------------------------

// CSwtImage::NewL

// ---------------------------------------------------------------------------

//

CSwtImage* CSwtImage::NewL(MSwtDevice* aDevice, const MSwtImageData& aData,

                           MSwtDisplay* aDisplay)

{

    CSwtImage* self = new(ELeave) CSwtImage(aDevice, aDisplay);

    CleanupStack::PushL(self);

    self->ConstructL(aData);

    CleanupStack::Pop(self);

    return self;

}

// ---------------------------------------------------------------------------

// CSwtImage::NewL

// ---------------------------------------------------------------------------

//

CSwtImage* CSwtImage::NewL(CFbsBitmap& aBitmap, CFbsBitmap* aMask,

                           const TPoint& aTopLeft, TInt aDelayTime, TSwtGifDisposal aDisposalMethod)

{

    CSwtImage* self = new(ELeave) CSwtImage(NULL, NULL);

    CleanupStack::PushL(self);

    self->ConstructL(aBitmap, aMask, aTopLeft, aDelayTime, aDisposalMethod, ETrue);

    CleanupStack::Pop(self);

    return self;

}

// ---------------------------------------------------------------------------

// CSwtImage::NewL

// ---------------------------------------------------------------------------

//

CSwtImage* CSwtImage::NewL(CFbsBitmap& aBitmap, CFbsBitmap* aMask)

{

    CSwtImage* self = new(ELeave) CSwtImage(NULL, NULL);

    CleanupStack::PushL(self);

    self->ConstructL(aBitmap, aMask, TPoint(0, 0), 0, KSwtDisposalUnspecified, EFalse);

    CleanupStack::Pop(self);

    return self;

}

// ---------------------------------------------------------------------------

// CSwtImage::CSwtImage

// ---------------------------------------------------------------------------

//

inline CSwtImage::CSwtImage(MSwtDevice* aDevice, MSwtDisplay* aDisplay)

        : iDevice(aDevice)

        , iMaskType(ENoMask)

        , iDisplay(aDisplay)

{

}

// ---------------------------------------------------------------------------

// CSwtImage::~CSwtImage

// ---------------------------------------------------------------------------

//

CSwtImage::~CSwtImage()

{

    iScaledMasks.ResetAndDestroy();

    iScaledMasksInverted.ResetAndDestroy();

    iScaledBitmaps.ResetAndDestroy();

    iScaledBitmapRefs.Close();

    delete iColorKey;

    if (!iOwnExternally)

    {

        delete iMask;

        delete iBitmap;

    }

    delete iMaskInverted;

    delete iBitmapDevice;

    if (iDisplay)

    {

        iDisplay->RemoveResourceChangeObserver(this);

    }

}

// ---------------------------------------------------------------------------

// CSwtImage::ConstructL

// ---------------------------------------------------------------------------

//

void CSwtImage::ConstructL(const TSize& aSize, TDisplayMode aMode)

{

    ASSERT(iDevice);

    ASSERT(iDisplay);

    // Create the bitmap

    iBitmap = new(ELeave) CFbsBitmap;

    // By default set the image color depth to that of the device.

    TDisplayMode mode = (aMode != ENone) ? aMode :

                        iDisplay->CoeEnv()->ScreenDevice()->DisplayMode();

    // 12-bit images aren't handled by SWT, neither will we

    if (mode == EColor4K)

    {

        mode = iDisplay->CoeEnv()->ScreenDevice()->DisplayMode();

    }

    User::LeaveIfError(iBitmap->Create(aSize, mode));

    // We have to set twips size of bitmap because this is used in order to get

    // best sized fonts if a GC is created on this bitmap ( if we don't then

    // HAL will be used and maybe this could return wrong values if device

    // resolution has changed )

    iBitmap->SetSizeInTwips(&(iDevice->GraphicsDevice()));

    iDisplay->AddResourceChangeObserverL(this);

    // Create the bitmap device

    iBitmapDevice = CFbsBitmapDevice::NewL(iBitmap);

    // Initialise the image information

    iInfo.iSize = aSize;

    iInfo.iDepth = BitDepth(mode);

    iInfo.iScanlinePad = ScanlinePadding(iInfo.iDepth);

    iInfo.iBytesPerLine = BytesPerLine(iInfo.iSize.iWidth, iInfo.iDepth,

                                       iInfo.iScanlinePad);

    iInfo.iTransparentPixel = -1;

    iInfo.iMaskPad =  0;

    iInfo.iAlpha = -1;

    iInfo.iType = ESwtImagePng;

    iInfo.iTopLeft = TPoint(0, 0);

    iInfo.iDisposalMethod = KSwtDisposalUnspecified;

    iInfo.iDelayTime = 0;

}

// ---------------------------------------------------------------------------

// CSwtImage::ConstructL

// ---------------------------------------------------------------------------

//

void CSwtImage::ConstructL(const MSwtImageData& aData)

{

    TDisplayMode mode(DisplayMode(aData));

    if (mode == ENone)

    {

        User::Leave(ESwtErrorUnsupportedDepth);

    }

    iInfo = aData.Info();

    // Create the bitmap and its device

    iBitmap = new(ELeave) CFbsBitmap;

    User::LeaveIfError(iBitmap->Create(iInfo.iSize, mode));

    iBitmapDevice = CFbsBitmapDevice::NewL(iBitmap);

    // Fill the bitmap

    if (aData.PixelBuffer().Length() != 0)

    {

        CopyData(*iBitmap, aData.PixelBuffer(), iInfo.iSize.iHeight,

                 iInfo.iDepth, iInfo.iBytesPerLine, &(aData.Palette()));

    }

    else

    {

        FillBitmapL(*iBitmapDevice, KRgbBlack, TRect(iInfo.iSize));

    }

    if (iInfo.iAlpha != -1)

    {

        // Global alpha value, causes alphaData to be ignored.

        iMaskType = EAlphaMask;

        iMask = new(ELeave) CFbsBitmap;

        User::LeaveIfError(iMask->Create(iInfo.iSize, EGray256));

        iMask->LockHeap();

        Mem::Fill(iMask->DataAddress(),

                  iInfo.iSize.iWidth * iInfo.iSize.iHeight, iInfo.iAlpha);

        iMask->UnlockHeap();

    }

    else

    {

        // Binary mask

        if (aData.MaskBuffer())

        {

            iMaskType = EBinaryMask;

            iMask = new(ELeave) CFbsBitmap;

            User::LeaveIfError(iMask->Create(iInfo.iSize, EGray2));

            TInt bpl = BytesPerLine(iInfo.iSize.iWidth, 1, iInfo.iMaskPad);

            CopyData(*iMask, *aData.MaskBuffer(), iInfo.iSize.iHeight, 1, bpl, NULL);

        }

        // Colour key mask, binary mask

        else if (iInfo.iTransparentPixel != -1)

        {

            iMaskType = EDirtyColorKey;

            iMask = new(ELeave) CFbsBitmap;

            User::LeaveIfError(iMask->Create(iInfo.iSize, EGray2));

            SetColorKeyL(aData);

            ComputeColorKeyMask();

        }

        // Alpha mask

        else if (aData.AlphaBuffer())

        {

            iMaskType = EAlphaMask;

            iMask = new(ELeave) CFbsBitmap;

            User::LeaveIfError(iMask->Create(iInfo.iSize, EGray256));

            CopyData(*iMask, *aData.AlphaBuffer(), iInfo.iSize.iHeight, 8,

                     iInfo.iSize.iWidth, NULL);

        }

    }

}

// ---------------------------------------------------------------------------

// CSwtImage::ConstructL

// ---------------------------------------------------------------------------

//

void CSwtImage::ConstructL(CFbsBitmap& aBitmap, CFbsBitmap* aMask,

                           const TPoint& aTopLeft, TInt aDelayTime,

                           TSwtGifDisposal aDisposalMethod, TBool aBmpOwnExternally)

{

    // Caution: if true, the object depends on the external bitmap's lifetime

    iOwnExternally = aBmpOwnExternally;

    iBitmap = &aBitmap;

    iMask = aMask;

    TDisplayMode mode = iBitmap->DisplayMode();

    if (mode == ENone || mode == EColor4K)

    {

        // 12-bit images aren't handled by SWT, neither will we

        User::Leave(ESwtErrorUnsupportedDepth);

    }

    iInfo.iSize = iBitmap->SizeInPixels();

    iInfo.iDepth = BitDepth(mode);

    iInfo.iScanlinePad = ScanlinePadding(iInfo.iDepth);

    iInfo.iBytesPerLine = BytesPerLine(iInfo.iSize.iWidth, iInfo.iDepth, iInfo.iScanlinePad);

    iInfo.iTransparentPixel = -1;

    iInfo.iMaskPad = 0;

    iInfo.iAlpha = -1;

    iInfo.iType = ESwtImagePng;

    iInfo.iTopLeft = aTopLeft;

    iInfo.iDisposalMethod = aDisposalMethod;

    iInfo.iDelayTime = aDelayTime;

    if (iMask)

    {

        if (iMask->DisplayMode() == EGray2)

        {

            iMaskType = EBinaryMask;

        }

        else

        {

            iMaskType = EAlphaMask;

        }

    }

}

// ---------------------------------------------------------------------------

// CSwtImage::SetColorKeyL

// ---------------------------------------------------------------------------

//

void CSwtImage::SetColorKeyL(const MSwtImageData& aData)

{

    ASSERT(!iColorKey);

    iColorKey = new(ELeave) TRgb;

    const MSwtPaletteData& palette = aData.Palette();

    const MSwtImageData::TInfo& info = aData.Info();

    if (palette.IsDirect())

    {

        switch (info.iDepth)

        {

            // Monochrome, the transparent pixel is either black or white

        case 1:

            *iColorKey = (info.iTransparentPixel == 0) ?

                         TRgb(0, 0, 0) : TRgb(255u, 255u, 255u);

            break;

            // Direct colour, extract components

        case 16:

        case 24:

        case 32:

            *iColorKey = GetRgb(info.iTransparentPixel,

                                palette.DirectData());

            break;

        default:

            User::Leave(KErrNotSupported);

            break;

        }

    }

    else

    {

        switch (aData.Info().iDepth)

        {

            // Look up the transparent pixel in the palette

        case 1:

        case 2:

        case 4:

        case 8:

            *iColorKey = palette.IndirectData()->GetEntry(

                             info.iTransparentPixel);

            break;

        default:

            User::Leave(KErrNotSupported);

            break;

        }

    }

}

// ---------------------------------------------------------------------------

// CSwtImage::EnsureMaskIsUpToDate

// ---------------------------------------------------------------------------

//

void CSwtImage::EnsureMaskIsUpToDate() const

{

    if (iMaskType == EDirtyColorKey)

    {

        const_cast<CSwtImage*>(this)->ComputeColorKeyMask();

    }

}

// ---------------------------------------------------------------------------

// CSwtImage::ComputeColorKeyMask

// ---------------------------------------------------------------------------

//

void CSwtImage::ComputeColorKeyMask()

{

    ASSERT(iBitmap);

    ASSERT(iMask && iMask->DisplayMode() == EGray2);

    ASSERT(iColorKey);

    ASSERT(iMaskType == EDirtyColorKey);

    iMask->LockHeap(EFalse);

    TUint32* maskPtr = iMask->DataAddress();

    const TSize size(iBitmap->SizeInPixels());

    const TInt wordsPerMaskLine = CFbsBitmap::ScanLineLength(size.iWidth, EGray2) / 4;

    TRgb pixel;

    for (TInt y = 0; y < size.iHeight; ++y)

    {

        TUint32 word32 = 0;

        TInt bitsInWord = 0;

        TInt wordsWritten = 0;

        for (TInt x = 0; x < size.iWidth; ++x)

        {

            iBitmap->GetPixel(pixel, TPoint(x, y));

            word32 >>= 1;

            word32 |= (pixel == *iColorKey) ? 0 : 0x80000000;

            if (++bitsInWord == 32)

            {

                maskPtr[wordsWritten++] = word32;

                bitsInWord = 0;

            }

        }

        if (bitsInWord != 0)

        {

            maskPtr[wordsWritten] = word32 >> (32 - bitsInWord);

        }

        maskPtr += wordsPerMaskLine;

    }

    iMask->UnlockHeap();

    iMaskType = EColorKey;

}

// ---------------------------------------------------------------------------

// CSwtImage::IsGrayscale

// ---------------------------------------------------------------------------

//

TBool CSwtImage::IsGrayscale() const

{

    switch (iBitmap->DisplayMode())

    {

    case EGray2:

    case EGray4:

    case EGray16:

    case EGray256:

        return ETrue;

    default:

        return EFalse;

    }

}

// ---------------------------------------------------------------------------

// CSwtImage::GetPaletteDataL

// ---------------------------------------------------------------------------

//

CSwtGrPaletteData* CSwtImage::GetPaletteDataL() const

{

    TDisplayMode mode(iBitmap->DisplayMode());

    // Decide whether the palette is direct or indirect

    TBool isDirect;

    switch (mode)

    {

    case EGray2:

    case EGray4:

    case EGray16:

    case EGray256:

        isDirect = EFalse;

        break;

    case EColor64K:

    case EColor16M:

    case EColor16MU:

    case EColor16MA:

    case EColor16MAP:

        isDirect = ETrue;

        break;

    default:

        ASSERT(EFalse);

        return NULL;

    }

    // Create and fill the palette data

    CSwtGrPaletteData* data = CSwtGrPaletteData::NewL(isDirect);

    if (isDirect)

    {

        CSwtGrPaletteData::TDirectData directData;

        if (mode == EColor64K)

        {

            // 16-bit Symbian bitmaps are stored as [rrrrrggg gggbbbbb] ( binary )

            directData.iRedMask = 0xF800;   // [11111000 00000000] binary

            directData.iGreenMask = 0x07E0; // [00000111 11100000] binary

            directData.iBlueMask = 0x001F;  // [00000000 00011111] binary

            directData.iRedShift = -8;

            directData.iGreenShift = -3;

            directData.iBlueShift =  3;

        }

        else if (mode == EColor16M)

        {

            // 24-bit Symbian bitmaps are stored in BGR order; 24-bit SWT images

            // are stored in MSB first order, this yields a pixel format of 0xbbggrr

            directData.iRedMask = 0x0000FF;

            directData.iGreenMask = 0x00FF00;

            directData.iBlueMask = 0xFF0000;

            directData.iRedShift = 0;

            directData.iGreenShift = -8;

            directData.iBlueShift = -16;

        }

        else

        {

            // EColor16MU, EColor16MA or EColor16MAP

            // 32-bit Symbian bitmaps are stored in BGR order; 32-bit SWT images

            // are stored in MSB first order, this yields a pixel format of 0xbbggrraa

            directData.iRedMask = 0x0000FF00;

            directData.iGreenMask = 0x00FF0000;

            directData.iBlueMask = 0xFF000000;

            directData.iRedShift = -8;

            directData.iGreenShift = -16;

            directData.iBlueShift = -24;

        }

        data->SetDirectData(directData);

    }

    else

    {

        data->SetIndirectData(NewGrayPaletteL(mode));

    }

    return data;

}