/*

* Copyright (c) 2003 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:   Main code file for plugin

*

*/

#include <eikenv.h>

#include <e32math.h>

#include <bitdev.h>

#include <aknutils.h>

#include <akniconutils.h>

#include <mifconvdefs.h>

#include "CBmpAnimScrPlugin.h"

#include "BmpAnimUtils.h"

#include <AknQueryDialog.h>

#include <avkon.rsg>

// "BmpAnimScrPlugin.rsg"

const TInt KDefaultViewTime = 1000000;

//

// CBmpAnimSrcPlugin

//

// Creates and returns a new instance of CBmpAnimScrPlugin

CBmpAnimScrPlugin* CBmpAnimScrPlugin::NewL()

    {

    CBmpAnimScrPlugin *plugin = new (ELeave) CBmpAnimScrPlugin();

    // Initialize settings object so that the plugin name can be retrieved

    iSettings = CBmpAnimSettings::NewL();

    return plugin;

    }

// Default constructor

CBmpAnimScrPlugin::CBmpAnimScrPlugin()

    : iState(EPluginStateLoading),

      iStopDisplaying(EFalse),

      iLoadedAnimation(ENone)

    {

    BMALOGGER_CREATE;

    }

// Destructor

CBmpAnimScrPlugin::~CBmpAnimScrPlugin()

    {

    delete iModel;

    delete iSettings;

    StopDisplayTimer();

    delete iDisplayTimer;

    BMALOGGER_DELETE;

    }

// --- from Screensaverplugin ---

// Initialization function. Must be called before anything but

// name query can be done

TInt CBmpAnimScrPlugin::InitializeL(MScreensaverPluginHost *aHost) 

    {

    ASSERT(aHost);

    // Sanity check

    if (!aHost)

        {

        return KErrArgument;

        }

    // Save the host interface

    iHost = aHost;

    // Start state

    iState = EPluginStateLoading;

    // Initial timing (may be overridden by settings)

    iHost->SetRefreshTimerValue(KDefaultViewTime);

    // Lie that we'll show indicators so that host does not prevent

    // plugin to be run if there are any to show. We'll stop after a

    // while anyway and the indicators are shown by normal Screensaver

    iHost->OverrideStandardIndicators();

    // Grab hold of the environment (this could be in the plugin host interface)

    iEikEnv = CEikonEnv::Static();

    // Create the model to store the animation in

    iModel = new(ELeave) CBmpAnimModel();

    iModel->ConstructL(iSettings);

    // Get screen info

    UpdateDisplayInfo();

    // Load the animation (Reload figures out which graphics should be used)

    ReloadAnimationL();

    // Create display timer

    iDisplayTimer = CPeriodic::NewL(CActive::EPriorityStandard);

    return KErrNone;

    }

// Draw function being called repeatedly by the host

TInt CBmpAnimScrPlugin::Draw(CWindowGc& aGc) 

    {

    // If initializing, start the timer and move on to animation state

    if (iState == EPluginStateInitializing)

        {

        BMALOGGER_WRITE("First draw, initializing");

        StartDisplayTimer();

        HandlePluginState();

        SetDisplayMode();

        TInt nLights = iModel->Settings()->Lights();

        if (nLights > 0)

            {

            Lights(nLights);

            }

        // Make sure the animation sequence starts from the beginning

        iModel->SetCurrentItemIndex(0);

        }

    // Retrieve the next image in sequence

    TBool endOfSequence = EFalse;

    CBmpAnimItem* pItem = iModel->NextItem(endOfSequence);

    if ((endOfSequence) || (!pItem))

        {

        // End of sequence reached, see if we've shown enough (1 minute)

        if (iStopDisplaying)

            {

            // Stop the timer

            StopDisplayTimer();

            // Back to square 1

            iState = EPluginStateInitializing;

			// Set a lower refresh rate while plugin is suspended.

            // This allows the Screensaver to stop Window Server heartbeat

            // and the system is able to sleep normally

            // NOTE: Not needed anymore, Screensaver now shuts down

            // WSERV heartbeat for suspended plugins

            // iHost->SetRefreshTimerValue(KDefaultViewTime);

            TInt suspendTime = iModel->Settings()->SuspendTime();

            BMALOGGER_WRITEF(_L("BMA: Done drawing, suspending for %d"),

                             suspendTime);

            iHost->Suspend(suspendTime);

            return KErrNone;

            }

        }

    if (pItem)

        {

        // Make sure the window is empty in case the bitmap doesn't

        // fill the whole screen

        aGc.Clear();

        DrawCentered(aGc, pItem);

        }

// Activate code if centering INI-controllable

#if 0

        // Retrieve drawing information

        CGulIcon* pIcon = pItem->Icon();

        TPoint position = pItem->Position();

        CFbsBitmap* bitmap = pIcon->Bitmap();

        CFbsBitmap* mask = pIcon->Mask();

        // Draw the whole bitmap at position

        TRect rect(position, bitmap->SizeInPixels());

        if (mask)

            {

            // Looks like a real icon - draw masked

            aGc.BitBltMasked(position, bitmap, rect, mask, ETrue);

            }

        else

            {

            // Just the bitmap - no masked draw

            aGc.BitBlt(position, bitmap, rect);

            }

        // Wait for the specified time until next image

        //

        // TODO: The new wk28 Screensaver crashes if the next call

        // is uncommented. Maybe the timer is not stopped

        // before starting again? Hmm... doesn't seem to happen

        // anymore. I wonder what changed. Anyway, I'll have it

        // commented out for the time being, in order to control

        // all frames' rate with the single setting

        // 

        // NOTE: There was a flaw in Screensaver where it would try to

        // start refresh timer twice, if plugin changes the value during

        // the first draw. The fix is released for 2.6_wk40_FB4

        // iHost->SetRefreshTimerValue(pItem->Timing());

        }

/*

    aGc.SetPenColor(TRgb(255,0,0));

    aGc.SetPenStyle(CGraphicsContext::ESolidPen);

    aGc.DrawRect(TRect(30, 30, 100, 100));

    aGc.SetPenColor(TRgb(255,0,0));

    aGc.SetPenSize(TSize(3,3));

    aGc.DrawRect(TRect(120, 100, 200, 150));

*/

#endif

    return KErrNone;

    }

// Return the name of the plugin

const TDesC16& CBmpAnimScrPlugin::Name() const

    {

    if (iSettings)

        {

        return iSettings->PluginName();

        }

    return KPluginName;

    }

// Handles events sent by the screensaver

TInt CBmpAnimScrPlugin::HandleScreensaverEventL(

    TScreensaverEvent aEvent,

    TAny* /* aData */)

    {

    switch (aEvent)

        {

        case EScreensaverEventStarting:

            BMALOGGER_WRITE("Start event");

            break;

        case EScreensaverEventStopping:

            BMALOGGER_WRITE("Stop event");

            StopDisplayTimer();

            iState = EPluginStateInitializing;

            break;

        case EScreensaverEventDisplayChanged:

            BMALOGGER_WRITE("Display changed event");

            // Grab current screen info

            UpdateDisplayInfo();

            // Reload animation, if needed

            ReloadAnimationL();

            break;

        default:

            break;

        }

    return KErrNone;

    }

// Return plugin capabilities (configurable)

TInt CBmpAnimScrPlugin::Capabilities()

    {

    return EScpCapsConfigure;

    }

// Perform a plugin function

TInt CBmpAnimScrPlugin::PluginFunction(TScPluginCaps aFunction, TAny* aParam)

    {

    switch (aFunction)

        {

        case EScpCapsConfigure:

            {

            TRAPD(err, err = ConfigureL(aParam));

            return err;

            }

            break;

        default:

            return KErrNotSupported;

            break;

        }

    }

// --- private functions ---

// Draws centered items

void CBmpAnimScrPlugin::DrawCentered(CWindowGc& aGc, CBmpAnimItem* aItem)

    {

    CGulIcon* pIcon = aItem->Icon();

    CFbsBitmap* bitmap = pIcon->Bitmap();

    CFbsBitmap* mask = pIcon->Mask();

    if (!bitmap)

        return;

    // Center the bitmap horizontally and vertically (crop off excess)    

    TPoint pos;

    TRect rectToDraw;

    TSize sizeBmp = bitmap->SizeInPixels();

    TInt screenWidth = iDi.iRect.Width();

    TInt screenHeight = iDi.iRect.Height();

    // Horizontally

    if (sizeBmp.iWidth <= screenWidth)

        {

        // Width fits on screen - center xpos

        pos.iX = (screenWidth - sizeBmp.iWidth) / 2;

        // Whole width of bmp can be drawn

        rectToDraw.SetWidth(sizeBmp.iWidth);

        }

    else

        {

        // Bmp wider than screen - xpos top left

        pos.iX = 0;

        // Adjust draw rect position and width

        rectToDraw.iTl.iX = (sizeBmp.iWidth - screenWidth) / 2;

        rectToDraw.SetWidth(screenWidth);

        }

    // Vertically

    if (sizeBmp.iHeight <= screenHeight)

        {

        // Height fits on screen - center ypos

        pos.iY = (screenHeight - sizeBmp.iHeight) / 2;

        // Whole height of bmp can be drawn

        rectToDraw.SetHeight(sizeBmp.iHeight);

        }

    else

        {

        // Bmp higher than screen - ypos top left

        pos.iY = 0;

        // Adjust draw rect position and height

        rectToDraw.iTl.iY = (sizeBmp.iHeight - screenHeight) / 2;

        rectToDraw.SetHeight(screenHeight);

        }

    // Do the drawing

    if (mask)

        {

        // Looks like a real icon - draw masked

        aGc.BitBltMasked(pos, bitmap, rectToDraw, mask, ETrue);

        }

    else

        {

        // Just the bitmap - no masked draw

        aGc.BitBlt(pos, bitmap, rectToDraw);

        }

    }

// Loads the animation into the model

void CBmpAnimScrPlugin::LoadAnimationL(TBool aLandscape, TBool aRotate)

    {

    // Rotated landscape not supported

    ASSERT(!(aLandscape && aRotate));

    // Start by getting rid of a possible loaded animation

    iModel->DeleteAll();

    // Bitmap index. If negative, loading is finished.

    TInt nIndex = KMifIdFirst;

    TFileName fileName;

    if (aLandscape)

        {

        fileName = iModel->Settings()->BitmapFilenameLandscape();

        }

    else

        {

        fileName = iModel->Settings()->BitmapFilename();

        }

    BMALOGGER_WRITEF(_L("BMA: Loading from: %S"), &(fileName));

    while (nIndex > 0)

        {

        CFbsBitmap* pBmp = NULL;

        TRAPD(err, pBmp = AknIconUtils::CreateIconL(fileName, nIndex));

        if ((pBmp) && (err == KErrNone))

            {

            // Got bitmap, push and set size

            CleanupStack::PushL(pBmp);

            TInt scaleErr = ScaleBitmap(pBmp, aRotate);

            if (scaleErr == KErrNone)

                {

                // Create an item with the bitmap and store it in the model

                CBmpAnimItem* pItem = new(ELeave) CBmpAnimItem();

                CleanupStack::PushL(pItem);

                pItem->SetIconL(pBmp);

                iModel->AppendItemL(pItem);

                CleanupStack::Pop(2); // pBmp, pItem

                BMALOGGER_WRITEF(_L("BMA: Loaded bmp %d"), nIndex);

                // Try loading next bitmap (skip mask IDs)

                nIndex += 2;

                }

            else

                {

                BMALOGGER_WRITEF(_L("BMA: Bmp %d scale err %d"),

                                 nIndex, scaleErr);

                // Apparently SVG icon was not found, this is not caught

                // in CreateIconL(). Assume last image was loaded.

                CleanupStack::PopAndDestroy();  // pBmp

                nIndex = -1;

                }

            }

        else

            {

            // Loading failed - maybe reached end of bitmaps 

            nIndex = -1;

            BMALOGGER_WRITEF(_L("BMA: Bmp load failed: %d"), err);

            }

        }

    // Save the type of loaded animation

    if (aLandscape)

        {

        iLoadedAnimation = ELandscape;

        }

    else if (aRotate)

        {

        iLoadedAnimation = EPortraitRotated;

        }

    else

        {

        iLoadedAnimation = EPortrait;

        }

    // On to next state

    HandlePluginState();

    // Start animating, when appropriate

    iHost->SetRefreshTimerValue(iModel->Settings()->Timing());

    BMALOGGER_WRITE("BMA: Animation loaded");

    }

// Re-loads the animation into the model, if needed

void CBmpAnimScrPlugin::ReloadAnimationL()

    {

    // Check if the correct graphics are already loaded

    if (!ReloadNeeded())

        {

        // Done! That was easy :)

        return;

        }

    // Load correct graphics

    LoadAnimationL(LoadLandscape(), RotateNeeded());

    }

// Starts the display timer

void CBmpAnimScrPlugin::StartDisplayTimer()

    {

    ASSERT(iDisplayTimer);

    TInt time = iModel->Settings()->RunningTime();

    BMALOGGER_WRITEF(_L("BMA: Start display timer for %d"), time);

    iStopDisplaying = EFalse;

    iDisplayTimer->Start(

        time,

        time,

        TCallBack(DisplayTimerCallback, this));

    }

// Stops the display timer

void CBmpAnimScrPlugin::StopDisplayTimer()

    {

    BMALOGGER_WRITE("BMA: Stop display timer");

    if (iDisplayTimer)

        {

        iDisplayTimer->Cancel();

        }

    iStopDisplaying = EFalse;

    }

// Display timer callback - sets animation stop flag

TInt CBmpAnimScrPlugin::DisplayTimerCallback(TAny* aPtr)

    {

    BMALOGGER_WRITE("BMA: Display timer timeout");

    CBmpAnimScrPlugin* _this = REINTERPRET_CAST(CBmpAnimScrPlugin*, aPtr);

    _this->iStopDisplaying = ETrue;

    return KErrNone;

    }