tvout/tvoutengine/inc/glxhdmicontroller.h
author hgs
Fri, 23 Jul 2010 20:41:04 +0530
changeset 52 a3a4c0de738e
parent 43 72396548277c
child 69 45459746d5e8
permissions -rw-r--r--
201029
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
52
hgs
parents: 43
diff changeset
     1
/**
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     2
* Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies). 
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     3
* All rights reserved.
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     4
* This component and the accompanying materials are made available
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     6
* which accompanies this distribution, and is available
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     8
*
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     9
* Initial Contributors:
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    11
*
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    12
* Contributors:
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    13
*
52
hgs
parents: 43
diff changeset
    14
* Description:    Creates the HDMI engine and provides functionality 
hgs
parents: 43
diff changeset
    15
*               for all its usage and needs through simple API's
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    16
*
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    17
*/
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    18
52
hgs
parents: 43
diff changeset
    19
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    20
#ifndef GLXHDMICONTROLLER_H_
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    21
#define GLXHDMICONTROLLER_H_
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    22
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    23
// Internal includes
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    24
class CGlxHdmiContainer;
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    25
class CGlxHdmiSurfaceUpdater;
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    26
52
hgs
parents: 43
diff changeset
    27
/**
hgs
parents: 43
diff changeset
    28
 * Class Description
hgs
parents: 43
diff changeset
    29
 * This is the entry point of the HDMI engine.
hgs
parents: 43
diff changeset
    30
 * It Promisses to provide all HDMI functionality with simple API calls.
hgs
parents: 43
diff changeset
    31
 * 
hgs
parents: 43
diff changeset
    32
 * To Show an image on TV, create an instance of this object and call 
hgs
parents: 43
diff changeset
    33
 * CGlxHdmiController::SetImageL() with appropriate parameters.
hgs
parents: 43
diff changeset
    34
 * 
hgs
parents: 43
diff changeset
    35
 * To Shift from native to clone and vice versa, use ShiftToPostingMode() and 
hgs
parents: 43
diff changeset
    36
 * ShiftToCloningMode() respectively 
hgs
parents: 43
diff changeset
    37
 * 
hgs
parents: 43
diff changeset
    38
 * For Not supported items, make sure to call ItemNotSupported() API
hgs
parents: 43
diff changeset
    39
 */        
hgs
parents: 43
diff changeset
    40
42
5e1df1b52eb3 201019_01
hgs
parents: 40
diff changeset
    41
class CGlxHdmiController : public CBase
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    42
    {
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    43
public:
52
hgs
parents: 43
diff changeset
    44
    /**
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    45
     * NewLC 
52
hgs
parents: 43
diff changeset
    46
     * @param aRect rect in which the CCoecontrol actually needs to be constructed
hgs
parents: 43
diff changeset
    47
     * @param EffectsOn - if the effect should be on, by default it is OFF, 
hgs
parents: 43
diff changeset
    48
     *  used only for SLIDESHOW
hgs
parents: 43
diff changeset
    49
     *   
hgs
parents: 43
diff changeset
    50
     * @return CGlxHdmiController object. 
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    51
     */
52
hgs
parents: 43
diff changeset
    52
    IMPORT_C static CGlxHdmiController* NewL(TRect aRect ,TBool aEfectsOn = EFalse);
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    53
52
hgs
parents: 43
diff changeset
    54
    /**
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    55
     * Destructor
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    56
     */
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    57
    IMPORT_C ~CGlxHdmiController();
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    58
    
52
hgs
parents: 43
diff changeset
    59
    /**
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    60
     * Update Image
52
hgs
parents: 43
diff changeset
    61
     * @param aImageFile  file path
hgs
parents: 43
diff changeset
    62
     * @param aFsBitmap Fullscreen bitmap, make sure to send a grid bitmap if FS bitmap not present
hgs
parents: 43
diff changeset
    63
     * @param aStore An internal parameter to store the image path or not, clients neednot use this. 
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    64
     */
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    65
    IMPORT_C void SetImageL(const TDesC& aImageFile, CFbsBitmap* aFsBitmap = NULL, 
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    66
            TBool aStore = ETrue);
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    67
52
hgs
parents: 43
diff changeset
    68
    /**
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    69
     * To intimate that the item is not supported.  
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    70
     */
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    71
    IMPORT_C void ItemNotSupported();
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    72
    
52
hgs
parents: 43
diff changeset
    73
    /**
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    74
     * Activating zoom in posting mode 
52
hgs
parents: 43
diff changeset
    75
     * @param aAutoZoomOut if it should auto zoom out
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    76
     */
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    77
    IMPORT_C void ActivateZoom(TBool aAutoZoomOut);
52
hgs
parents: 43
diff changeset
    78
    
hgs
parents: 43
diff changeset
    79
    /**
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    80
     * Deactivating zoom in posting mode 
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    81
     */
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    82
    IMPORT_C void DeactivateZoom();
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    83
    
52
hgs
parents: 43
diff changeset
    84
    /**
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    85
     * ShiftToCloningMode
52
hgs
parents: 43
diff changeset
    86
     * Shifts the TV UI to cloning mode if it is posting
hgs
parents: 43
diff changeset
    87
     * else does nothing
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    88
     */
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    89
    IMPORT_C void ShiftToCloningMode();
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    90
    
52
hgs
parents: 43
diff changeset
    91
    /**
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    92
     * ShiftToPostingMode
52
hgs
parents: 43
diff changeset
    93
     * Shifts the TV UI to posting mode if cloning mode, 
hgs
parents: 43
diff changeset
    94
     * else does nothing
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    95
     */
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    96
    IMPORT_C void ShiftToPostingMode();
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    97
52
hgs
parents: 43
diff changeset
    98
    /**
43
hgs
parents: 42
diff changeset
    99
     * Fadeing of the Surface
52
hgs
parents: 43
diff changeset
   100
     * @param aFadeInOut ETrue - FadeIn ( as in gaining brightness )
hgs
parents: 43
diff changeset
   101
     *                   EFalse - FadeOut ( as in loosing brightness ) 
43
hgs
parents: 42
diff changeset
   102
     */
hgs
parents: 42
diff changeset
   103
    IMPORT_C void FadeSurface(TBool aFadeInOut);
hgs
parents: 42
diff changeset
   104
    
52
hgs
parents: 43
diff changeset
   105
private:/// class private method
hgs
parents: 43
diff changeset
   106
    /**
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   107
     * Constructor
52
hgs
parents: 43
diff changeset
   108
     * @param aRect Rect size 
hgs
parents: 43
diff changeset
   109
     * @param aEfectsOn if effects needs to be on(used in Slideshow only)
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   110
     */
52
hgs
parents: 43
diff changeset
   111
    CGlxHdmiController(TRect aRect ,TBool aEfectsOn);
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   112
    
52
hgs
parents: 43
diff changeset
   113
    /**
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   114
     * ConstructL 
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   115
     */
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   116
    void ConstructL();
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   117
    
52
hgs
parents: 43
diff changeset
   118
    /**
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   119
     * Create the Hdmi Container 
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   120
     */
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   121
    void CreateHdmiContainerL();
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   122
    
52
hgs
parents: 43
diff changeset
   123
    /**
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   124
     * Create surface updater and update background surface 
52
hgs
parents: 43
diff changeset
   125
     * @param aImageFile Image file     
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   126
     */
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   127
    void CreateSurfaceUpdaterL(const TDesC& aImageFile);
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   128
    
52
hgs
parents: 43
diff changeset
   129
    /**
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   130
     * To Destroy the surface updater if present
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   131
     */
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   132
    void DestroySurfaceUpdater();
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   133
    
52
hgs
parents: 43
diff changeset
   134
    /**
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   135
     * Detroy the container 
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   136
     */
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   137
    void DestroyContainer();
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   138
52
hgs
parents: 43
diff changeset
   139
    /**
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   140
     * Stores the Image File name
52
hgs
parents: 43
diff changeset
   141
     * @param aImageFile Image file path
hgs
parents: 43
diff changeset
   142
     * @param aFsBitmap Fullscreen Bitmap
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   143
     */
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   144
    void StoreImageInfoL(const TDesC& aImageFile, CFbsBitmap* aFsBitmap);
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   145
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   146
private:
52
hgs
parents: 43
diff changeset
   147
    /// Fullscreen Bitmap
hgs
parents: 43
diff changeset
   148
    CFbsBitmap*         iFsBitmap;
hgs
parents: 43
diff changeset
   149
    /**
hgs
parents: 43
diff changeset
   150
     * Stored image path 
hgs
parents: 43
diff changeset
   151
     */
hgs
parents: 43
diff changeset
   152
    HBufC*              iStoredImagePath;
hgs
parents: 43
diff changeset
   153
    /**
hgs
parents: 43
diff changeset
   154
     * Hdmi container
hgs
parents: 43
diff changeset
   155
     */
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   156
    CGlxHdmiContainer*      iHdmiContainer;
52
hgs
parents: 43
diff changeset
   157
    /// Surface updater instance
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   158
    CGlxHdmiSurfaceUpdater* iSurfaceUpdater;
52
hgs
parents: 43
diff changeset
   159
    /// Rect
hgs
parents: 43
diff changeset
   160
    TRect   iRect;                   
hgs
parents: 43
diff changeset
   161
    /// Flag to see if Image is supported
hgs
parents: 43
diff changeset
   162
    TBool   iIsImageSupported;      
hgs
parents: 43
diff changeset
   163
    /// Flag to set if effects should be on
hgs
parents: 43
diff changeset
   164
    TBool   iEffectsOn;                 
26
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   165
    };
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   166
c499df2dbb33 Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   167
#endif /* GLXHDMICONTROLLER_H_ */