/*

* Copyright (c) 2003-2009 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:  CMIDCanvas - Implements the native part of the Canvas class.

*

*/

#ifndef CMIDCANVAS_H

#define CMIDCANVAS_H

/**

 * Enables platform support for accelerated GDI operations.

 *

 * Used for creating of hardware bitmap (e.g. in LcdFbsImage.cpp) which can be

 * used in hardware graphics accelerator if available.

 *

 * FIX for BITGDI failing to transparently support drawing to hardware

 * bitmaps. Certain accelerator operations fail silently rather than falling

 * back to software routines. If the licencee can be sure that their hardware

 * accelerator supports all BITGDI operations then it may be worth

 * uncommenting the following line.

 */

#define ACCELERATED_BITGDI 1

/**

 * Enables deffered BitBlting. With this flag on, CMIDCanvas counts BitBlt

 * cycles and tries to optimize BitBlt process.

 */

#define DEFER_BITBLT 1

/**

 * Enables update invalidate method of drawing. Use RWindow::BeginRedraw and

 * RWindow::EndRedraw to tell the window server when the window is about to

 * respond to the last redraw event by redrawing.

 */

#define CANVAS_UPDATE_INVALIDATE 1

/**

 * Used double buffer for Canvas. Enabled by MIDP 2.1 specification.

 *

 * Define to switch on native double buffering in canvas. Canvas may still be

 * double buffered in java even if this is switched off, however this has not

 * been tested without JSR_135_SUPPORT.

 */

#define CANVAS_DOUBLE_BUFFER 1

/**

 * Enable direct screen access for Canvas when not using double buffering.

 * Define to switch on direct access in canvas. Cannot be used without

 * CANVAS_DOUBLE_BUFFER.

 */

#ifndef RD_JAVA_NGA_ENABLED

#define CANVAS_DIRECT_ACCESS 1

#endif // !RD_JAVA_NGA_ENABLED

/**

 * If canvas is using direct access itself, it must provide a native

 * framebuffer.

 */

#ifdef CANVAS_DIRECT_ACCESS

#ifndef CANVAS_DOUBLE_BUFFER

#define CANVAS_DOUBLE_BUFFER

#endif

#endif

/**

 * Without a native framebuffer we cannot handle redraw events natively, but

 * will have to generate a java repaint.

 */

#ifndef CANVAS_DOUBLE_BUFFER

#define CANVAS_ASYNC_REPAINT

#endif

#include <w32std.h>

#include <gulgcmap.h>

#include <coemain.h>

#include <coecntrl.h>

#ifdef RD_JAVA_NGA_ENABLED

#include <EGL/egl.h>

#include <GLES/gl.h>

#include <platform/mw/alf/alfcompositionclient.h>

#include "monitor.h"

#endif // RD_JAVA_NGA_ENABLED

#include <lcdui.h>

#include <reflcdui.h>

#include <aknpointereventsuppressor.h>

#include <MMIDCustomComponentContainer.h>

/** MMIDMediaKeysListener in declaration. */

#include "MMIDMediaKeysListener.h"

/** Used CMIDDisplayable as member iDisplayable. */

#include "CMIDDisplayable.h"

class CMIDKeyDecoder;

class CMIDScaler;

class CMIDCallIndicator;

class CMIDNetworkIndicator;

class CMIDRemConObserver;

class CMIDTactileFeedbackExtension;

/**

 * Drawable canvas control.

 * Can be used as drawing surface of MIDP Canvas.

 * Key events, game actions, pointer events and size change events are

 * generated in the CMIDCanvas class. Whenever a key is pressed, that key is

 * translated and an event is posted to the Java side.

 *

 * @lib    lcdui.dll

 * @since  S60 v3.0

 */

NONSHARABLE_CLASS(CMIDCanvas) :

        public CCoeControl,

        public MMIDCanvas,

        public MMIDBufferProcessor,

        public MDirectContainer,

        public MMIDLcduiEventConsumer,

#ifdef CANVAS_DIRECT_ACCESS

        public MDirectScreenAccess,

#endif

        public MMIDMediaKeysListener,

#ifdef RD_TACTILE_FEEDBACK

        public MMIDTactileFeedbackComponent,

#endif

#ifdef RD_JAVA_NGA_ENABLED

        public MAlfBufferProvider,

#endif // RD_JAVA_NGA_ENABLED 

        public MMIDCustomComponentContainer

{

    /** CMIDNetworkIndicator is using protected function PostEvent. */

    friend class CMIDNetworkIndicator;

public:

    /**

     * Two-phased constructor.

     *

     * @param  aEnv Environment object.

     * @param  aComponentType The component type, can be ECanvas

     *         or EGameCanvas.

     * @param  aUpdateRequired Update is requied.

     */

    static CMIDCanvas* NewL(

        MMIDEnv& aEnv,

        CCoeControl& aWindow,

        MMIDComponent::TType aComponentType = MMIDComponent::ECanvas,

        TBool aUpdateRequired = EFalse);

    /**

     * Destructor.

     */

    virtual ~CMIDCanvas();

    /**

     * Set fullscreen mode on/off.

     *

     * @since  S60 v3.0

     * @param  aFullScreen The fullscreen mode state to be set.

     */

    void FullScreen(TBool aFullScreen);

    /**

     * Tells whether scaling is on or off.

     *

     * @since  S60 v3.0

     * @return ETrue if scaling is on, otherwise returns EFalse.

     */

    TBool IsScalingOn();

    /**

     * Tells whether application attribute

     * Nokia-MIDlet-S60-Selection-Key-Compatibility is set true or not.

     *

     * @since  S60 v5.0

     * @return ETrue if the attribute value is true, otherwise returns EFalse.

     */

    TBool SelectionKeyCompatibility();

// from base class CCoeControl

    /**

     * Counts the number of compound controls in this CCoeControl.

     *

     * @return The number of compound controls in this CCoeControl

     * @since S60 5.0

     */

    TInt CountComponentControls() const;

    /**

     * Returns the compound control in the specified index.

     *

     * @param aIndex The index of the control to be retrieved.

     * @return The control in the specified index or NULL if there

     *         is no control in that index.

     * @since S60 5.0

     */

    CCoeControl* ComponentControl(TInt aIndex) const;

    /**

     * From CCoeControl.

     * Process a key event.

     *

     * @since  S60 v3.0

     * @param  aKeyEvent Key event.

     * @param  aType Event code.

     * @return Key response.

     */

    TKeyResponse OfferKeyEventL(

        const TKeyEvent& aKeyEvent,

        TEventCode aType);

// from base class MMIDCanvas

    /**

     * From MMIDComponent.

     * Invoked by the framework to clean up any resources used by the

     * implementation. Deletes this.

     *

     * @since  S60 v3.0

     */

    void Dispose();

    /**

     * From MMIDComponent.

     * Returns the component type as a MMIDComponent::TType enum.

     *

     * @since  S60 v3.0

     * @return Always returns MMIDComponent::ECanvas.

     */

    MMIDComponent::TType Type() const;

    /**

     * From MMIDComponent.

     * Returns buffer processor associated with this component.

     *

     * @since  S60 v3.0

     * @return Always returns this.

     */

    MMIDBufferProcessor* Processor();

    /**

     * From MMIDCancas.

     * Returns a reference to the CCoeControl corresponding to this canvas.

     *

     * @since  S60 v3.0

     * @return Reference to the CCoeControl corresponding to this canvas.

     */

    CCoeControl& Control();

    /**

     * From MMIDCancas.

     * Double buffering support.

     *

     * Returns the frame buffer.

     *

     * @since  S60 v3.0

     * @return A pointer to the frame buffer.

     */

    CFbsBitmap* FrameBuffer() const;

    /**

     * From MMIDCancas.

     * Returns the size of the canvas content.

     *

     * @since  S60 v3.0

     * @return The size of the displayable content.

     */

    TSize ContentSize() const;

    /**

     * From MMIDCancas.

     * Direct screen access support.

     *

     * Disables temporarily direct screen access.

     *

     * @since  S60 v3.0

     */

    void PauseDirectAccess();

    /**

     * From MMIDCancas.

     * Re-enables direct screen access.

     *

     * @since  S60 v3.0

     */

    void ResumeDirectAccess();

    /**

     * From MMIDCancas.

     * Switch off key event posting. Game keys will still be tracked, but

     * keyPressed()/keyReleased() callbacks will not be called.

     *

     * @since  S60 v3.0

     */

    void SuppressKeys();

    /**

     * From MMIDCancas.

     * Returns the latched state of the game action keys.

     *

     * @since  S60 v3.0

     * @return The latched state of the game action keys.

     */

    TUint32 GameActions();

    /**

     * From MMIDCancas.

     * Returns a direct container on which video can be rendered.

     *

     * @since  S60 v3.0

     * @return A container on which video can be rendered

     */

    MDirectContainer& DirectContainer();

    /**

     * From MMIDCancas.

     * Draw a background image.

     *

     * @since  S60 v3.2

     * @param  aGc Target graphical context

     * @param  aPosition Position

     * @param  aSize Size

     */

    void DrawBackground(

        CBitmapContext& aGc,

        const TPoint& aPosition,

        const TSize& aSize);

    /**

     * From MMIDCancas.

     * Returns the type of Canvas object.

     *

     * @since  S60 v3.2

     * @return ETrue if the type is

     *         MMIDComponent::EGameCanvas and EFalse

     *         when the type is MMIDComponent::ECanvas.

     */

    TBool IsGameCanvas() const;

    /**

     * From MMIDCancas.

     * Gets a network indicator location and size on fullscreen Canvas.

     *

     * @since  S60 v5.0

     * @param  aPosition Returned top left position of network indicator

     * @param  aSize Returned size of nw indicator

     * @return EFalse if Canvas is not able to display nw indicator (not

     *         fullscreen), otherwise ETrue.

     */

    TBool NetworkIndicatorLocation(TPoint& aPosition, TSize& aSize) const;

#ifdef RD_TACTILE_FEEDBACK

    /**

     * From MMIDCancas.

     * Get tactile feedback component.

     *

     * @since  S60 v5.0

     * @return this as tactile feedback component.

     */

    MMIDTactileFeedbackComponent* TactileFeedbackComponent();

#endif // RD_TACTILE_FEEDBACK

    TBool ReadyToBlit() const;

// from base class MMIDBufferProcessor

    /**

     * From MMIDBufferProcessor.

     * Process a block of commands, updating read pointer as you go.

     *

     * @since  S60 v3.0

     * @param  aRead The address of the first command in the buffer for this

     *         processor.

     * @param  aEnd The address of the command *after* the last command in the

     *         buffer for this processor.

     * @param  aCycles The amount of 'compute effort' remaining in the current

     *         AO RunL.

     * @param  aStatus The request status.

     * @return Returns ETrue if processing will be async.

     */

    TBool ProcessL(

        const TMIDBufferOp*& aRead,

        const TMIDBufferOp* aEnd,

        TInt& aCycles,

#ifdef RD_JAVA_NGA_ENABLED

        java::util::Monitor* aMonitor);

#else

        TRequestStatus* aStatus = NULL);

#endif

    /**

     * From MMIDBufferProcessor.

     * Called by framework if the processor is doing some async operation

     * when the MIDlet is closed down. Processor should cancel the async

     * operation and clean up any resources.

     *

     * @since  S60 v3.0

     */

    void AbortAsync();

#ifdef CANVAS_DIRECT_ACCESS

// from base class MDirectScreenAccess

    /**

     * From MAbortDirectScreenAccess.

     * This function is called by the window server when direct screen access

     * must stop (for example because a dialogue is moved in front of the area

     * where direct screen access is taking place).

     *

     * @since  S60 v3.0

     * @param  aReason The reason why direct screen access was terminated.

     */

    void AbortNow(RDirectScreenAccess::TTerminationReasons aReasons);

    /**

     * From MDirectScreenAccess.

     * This function is called by the window server as soon as direct screen

     * access can resume.

     *

     * @since  S60 v3.0

     * @param  aReason Provides the reason why direct screen access was

     *         terminated.

     */

    void Restart(RDirectScreenAccess::TTerminationReasons aReasons);

#endif // CANVAS_DIRECT_ACCESS

// from base class MDirectContainer

    /**

     * From MDirectContainer.

     * Set the content of this direct container.

     *

     * @since  S60 v3.0

     * @param  aContent Content which is displayed on this container.

     */

    void MdcAddContent(MDirectContent* aContent);

    /**

     * From MDirectContainer.

     * Remove the content from this direct container. This will called when

     * the Player is closed.

     *

     * @since  S60 v3.0

     * @param  aContent Content which is displayed on this container.

     */

    void MdcRemoveContent(MDirectContent* aContent);

    /**

     * From MDirectContainer.

     * Add content bound to this direct container.

     * Container will not allow painting in this region.

     *

     * @since  S60 v3.0

      * @param  aRect Content bounds.

     */

    /**

     * From MDirectContainer.

     * Removes one content bound from this direct container.

     *

     * @since  S60 v3.2

     * @param  aRect Content bound to be removed.

     */

    /**

     * From MDirectContainer.

     * Get rect of a window on which content of this direct container can be

     * displayed.

     *

     * @since  S60 v3.2

     * @return Rect of a window.

     */

    TRect MdcContainerWindowRect() const;

    /**

     * From MDirectContainer.

     * Get the visiblity of this direct container.

     *

     * @since  S60 v3.0

     * @return ETrue if the container is visible, EFalse if it is

     * invisible.

     */

    TBool MdcContainerVisibility() const;

    /**

     * From MDirectContainer.

     * Get the bounds of the area that the content of this direct container

     * can occupy.

     *

     * @since  S60 v3.0

     * @return Maximum area that the content can occupy in screen

     *         co-ordinates.

     */

    TRect MdcContentBounds() const;

    /**

     * From MDirectContainer.

     * Get the area on the Item on which content can be displayed.

     *

     * @since  S60 v3.0

     * @param  aContentRect Return parameter for content area in Item