videoplayerapp/videoplayerengine/inc/mpxvideoplayerappuiengine.h
author hgs
Fri, 16 Apr 2010 18:13:14 +0300
changeset 36 8aed59de29f9
parent 35 3738fe97f027
child 44 518105d52e45
permissions -rw-r--r--
201015
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
34
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  CMpxVideoPlayerAppUiEngine
hgs
parents:
diff changeset
    15
 *
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
36
hgs
parents: 35
diff changeset
    18
// Version : %version:  5 %
34
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#ifndef CMPXVIDEOPLAYERAPPUIENGINE_H
hgs
parents:
diff changeset
    23
#define CMPXVIDEOPLAYERAPPUIENGINE_H
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
#include <e32base.h>
hgs
parents:
diff changeset
    26
#include <mpxplaybackutility.h>
hgs
parents:
diff changeset
    27
#include <mpxviewutility.h>
hgs
parents:
diff changeset
    28
#include <mpxcollectionutility.h>
hgs
parents:
diff changeset
    29
#include <mpxmessage2.h>
hgs
parents:
diff changeset
    30
#include <mpxcollectionplaylist.h>
hgs
parents:
diff changeset
    31
#include <mediarecognizer.h>
hgs
parents:
diff changeset
    32
#include <mpxplaybackobserver.h>
hgs
parents:
diff changeset
    33
#include <mpxviewactivationobserver.h>
hgs
parents:
diff changeset
    34
#include <mpxcollectionobserver.h>
hgs
parents:
diff changeset
    35
#include <mpxcollectionuihelperobserver.h>
hgs
parents:
diff changeset
    36
hgs
parents:
diff changeset
    37
class CMPXCommonUiHelper;
hgs
parents:
diff changeset
    38
class MMPXCollectionUiHelper;
hgs
parents:
diff changeset
    39
class CVideoPlaylistUtility;
hgs
parents:
diff changeset
    40
class QMpxVideoPlaybackWrapper;
hgs
parents:
diff changeset
    41
hgs
parents:
diff changeset
    42
/**
hgs
parents:
diff changeset
    43
*  Application UI class.
hgs
parents:
diff changeset
    44
*
hgs
parents:
diff changeset
    45
*  @lib mpxvideoplayer.exe
hgs
parents:
diff changeset
    46
*  @since MpxVideoPlayer 0.1
hgs
parents:
diff changeset
    47
*/
hgs
parents:
diff changeset
    48
class CMpxVideoPlayerAppUiEngine : public CBase,
hgs
parents:
diff changeset
    49
                                   public MMPXPlaybackObserver,
hgs
parents:
diff changeset
    50
                                   public MMPXViewActivationObserver,
hgs
parents:
diff changeset
    51
                                   public MMPXCollectionObserver ,
hgs
parents:
diff changeset
    52
                                   public MMPXCHelperEmbeddedOpenObserver
hgs
parents:
diff changeset
    53
{
hgs
parents:
diff changeset
    54
    public:        // Constructors and destructor
hgs
parents:
diff changeset
    55
        static CMpxVideoPlayerAppUiEngine* NewL( QMpxVideoPlaybackWrapper* aWrapper );
hgs
parents:
diff changeset
    56
hgs
parents:
diff changeset
    57
        /**
hgs
parents:
diff changeset
    58
        * Destructor.
hgs
parents:
diff changeset
    59
        */
hgs
parents:
diff changeset
    60
        virtual ~CMpxVideoPlayerAppUiEngine();
hgs
parents:
diff changeset
    61
hgs
parents:
diff changeset
    62
    public:
hgs
parents:
diff changeset
    63
        /*
hgs
parents:
diff changeset
    64
         *  Retrieve the playback utility pointer
hgs
parents:
diff changeset
    65
         */
hgs
parents:
diff changeset
    66
        inline MMPXPlaybackUtility* PlaybackUtility();
hgs
parents:
diff changeset
    67
hgs
parents:
diff changeset
    68
        /**
hgs
parents:
diff changeset
    69
         * Opens the specified file in response to a corresponding message.
hgs
parents:
diff changeset
    70
         *
hgs
parents:
diff changeset
    71
         * @param aFile File to be opened.
hgs
parents:
diff changeset
    72
         */
36
hgs
parents: 35
diff changeset
    73
        void OpenFileL( const TDesC& aFileName );
hgs
parents: 35
diff changeset
    74
        
34
hgs
parents:
diff changeset
    75
        /**
hgs
parents:
diff changeset
    76
         * Opens the specified file in response to a corresponding message.
hgs
parents:
diff changeset
    77
         *
hgs
parents:
diff changeset
    78
         * @param aFile File to be opened.
36
hgs
parents: 35
diff changeset
    79
         */        
hgs
parents: 35
diff changeset
    80
        void OpenFileL( RFile& aFile );
34
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
        /**
hgs
parents:
diff changeset
    83
         * Opens the specified mpx media object.
hgs
parents:
diff changeset
    84
         *
hgs
parents:
diff changeset
    85
         * @param aMedia Media to be opened.
hgs
parents:
diff changeset
    86
         */
hgs
parents:
diff changeset
    87
        void OpenMediaL( const CMPXMedia& aMedia );
hgs
parents:
diff changeset
    88
hgs
parents:
diff changeset
    89
        /**
hgs
parents:
diff changeset
    90
         * Handle playback message
hgs
parents:
diff changeset
    91
         *
hgs
parents:
diff changeset
    92
         * @param aMessage playback message
hgs
parents:
diff changeset
    93
         */
hgs
parents:
diff changeset
    94
        void DoHandlePlaybackMessageL( const CMPXMessage& aMessage );
hgs
parents:
diff changeset
    95
hgs
parents:
diff changeset
    96
        /**
hgs
parents:
diff changeset
    97
         * Handle Player Changed Playback Message
hgs
parents:
diff changeset
    98
         */
hgs
parents:
diff changeset
    99
        void HandlePlaybackPlayerChangedL();
hgs
parents:
diff changeset
   100
hgs
parents:
diff changeset
   101
        /**
hgs
parents:
diff changeset
   102
         * Sets mpx components ready for application shutdown
hgs
parents:
diff changeset
   103
         */
hgs
parents:
diff changeset
   104
        void PrepareCloseMpxL();
hgs
parents:
diff changeset
   105
hgs
parents:
diff changeset
   106
        /**
hgs
parents:
diff changeset
   107
         * Handle media properties.
hgs
parents:
diff changeset
   108
         */
hgs
parents:
diff changeset
   109
        void DoHandelCollectionMediaL( const CMPXMedia& aMedia );
hgs
parents:
diff changeset
   110
hgs
parents:
diff changeset
   111
        /*
hgs
parents:
diff changeset
   112
         * Handle embedded playback message
hgs
parents:
diff changeset
   113
         * @param aMessageUid message identification uid
hgs
parents:
diff changeset
   114
         * @param aMessageParameters  aiw generic parameters
hgs
parents:
diff changeset
   115
         */
hgs
parents:
diff changeset
   116
        TBool HandleMessageL( TUid aMessageUid,
hgs
parents:
diff changeset
   117
                              const TDesC8& aMessageParameters );
hgs
parents:
diff changeset
   118
hgs
parents:
diff changeset
   119
        /**
hgs
parents:
diff changeset
   120
         * From MMPXPlaybackObserver
hgs
parents:
diff changeset
   121
         * Handle playback message
hgs
parents:
diff changeset
   122
         *
hgs
parents:
diff changeset
   123
         * @since 3.1
hgs
parents:
diff changeset
   124
         * @param aMessage playback message
hgs
parents:
diff changeset
   125
         * @param aErr system error code.
hgs
parents:
diff changeset
   126
         */
hgs
parents:
diff changeset
   127
        void HandlePlaybackMessage( CMPXMessage* aMessage, TInt aError );
hgs
parents:
diff changeset
   128
hgs
parents:
diff changeset
   129
        /**
hgs
parents:
diff changeset
   130
         * From MMPXViewActivationObserver
hgs
parents:
diff changeset
   131
         * Handle view activation.
hgs
parents:
diff changeset
   132
         *
hgs
parents:
diff changeset
   133
         * @since 3.1
hgs
parents:
diff changeset
   134
         * @param aCurrentViewType Current view type Uid.
hgs
parents:
diff changeset
   135
         * @param aPreviousViewType Previous view type Uid.
hgs
parents:
diff changeset
   136
         */
hgs
parents:
diff changeset
   137
        void HandleViewActivation( const TUid& aCurrentViewType, const TUid& aPreviousViewType );
hgs
parents:
diff changeset
   138
hgs
parents:
diff changeset
   139
hgs
parents:
diff changeset
   140
        /**
hgs
parents:
diff changeset
   141
         *  From MPXCollectionObserver
hgs
parents:
diff changeset
   142
         *  @since S60 3.2.3
hgs
parents:
diff changeset
   143
         *  @param aMessage collection message, ownership not transferred.
hgs
parents:
diff changeset
   144
         *         Please check aMsg is not NULL before using it. If aErr is not
hgs
parents:
diff changeset
   145
         *         KErrNone, plugin might still call back with more info in the aMsg.
hgs
parents:
diff changeset
   146
         *  @param aErr system error code
hgs
parents:
diff changeset
   147
         */
hgs
parents:
diff changeset
   148
        void HandleCollectionMessage( CMPXMessage* aMsg, TInt /*aErr*/ );
hgs
parents:
diff changeset
   149
hgs
parents:
diff changeset
   150
        /**
hgs
parents:
diff changeset
   151
         * From MMPXCollectionObserver
hgs
parents:
diff changeset
   152
         * Handle media properties.
hgs
parents:
diff changeset
   153
         *
hgs
parents:
diff changeset
   154
         * @since 3.1
hgs
parents:
diff changeset
   155
         * @param aMedia  media properties.
hgs
parents:
diff changeset
   156
         * @param aError Error code.
hgs
parents:
diff changeset
   157
         */
hgs
parents:
diff changeset
   158
        void HandleCollectionMediaL( const CMPXMedia& aMedia, TInt aError );
hgs
parents:
diff changeset
   159
hgs
parents:
diff changeset
   160
         /**
hgs
parents:
diff changeset
   161
         * From MMPXCollectionObserver
hgs
parents:
diff changeset
   162
         * Handles the collection entries being opened.
hgs
parents:
diff changeset
   163
         *
hgs
parents:
diff changeset
   164
         * @since 3.1
hgs
parents:
diff changeset
   165
         * @param aEntries Collection entries opened.
hgs
parents:
diff changeset
   166
         * @param aIndex Focused entry.
hgs
parents:
diff changeset
   167
         * @param aComplete ETrue no more entries. EFalse more entries
hgs
parents:
diff changeset
   168
         *                  expected.
hgs
parents:
diff changeset
   169
         * @param aError Error code.
hgs
parents:
diff changeset
   170
         */
hgs
parents:
diff changeset
   171
        void HandleOpenL( const CMPXMedia& aEntries,
hgs
parents:
diff changeset
   172
                          TInt aIndex,
hgs
parents:
diff changeset
   173
                          TBool aComplete,
hgs
parents:
diff changeset
   174
                          TInt aError );
hgs
parents:
diff changeset
   175
hgs
parents:
diff changeset
   176
        /**
hgs
parents:
diff changeset
   177
         * From MMPXCollectionObserver
hgs
parents:
diff changeset
   178
         * Handles the item being opened.
hgs
parents:
diff changeset
   179
         *
hgs
parents:
diff changeset
   180
         * @since 3.1
hgs
parents:
diff changeset
   181
         * @param aPlaylist Collection playlist, owner ship is transfered.
hgs
parents:
diff changeset
   182
         * @param aError Error code.
hgs
parents:
diff changeset
   183
         */
hgs
parents:
diff changeset
   184
        void HandleOpenL( const CMPXCollectionPlaylist& aPlaylist, TInt aError);
hgs
parents:
diff changeset
   185
hgs
parents:
diff changeset
   186
        // from base class MMPXCHelperEmbeddedOpenObserver
hgs
parents:
diff changeset
   187
            /**
hgs
parents:
diff changeset
   188
            * From MMPXCHelperEmbeddedOpenObserver
hgs
parents:
diff changeset
   189
            * Handles errors from opening in embedded mode
hgs
parents:
diff changeset
   190
            *
hgs
parents:
diff changeset
   191
            * @since 3.1
hgs
parents:
diff changeset
   192
            * @param aErr Error code
hgs
parents:
diff changeset
   193
            * @param aCategory Type of item to be opened.
hgs
parents:
diff changeset
   194
            */
hgs
parents:
diff changeset
   195
        void HandleEmbeddedOpenL( TInt aErr, TMPXGeneralCategory aCategory  );
36
hgs
parents: 35
diff changeset
   196
       
35
hgs
parents: 34
diff changeset
   197
        /*
hgs
parents: 34
diff changeset
   198
         *  Late initializatoin of members that can be delayed 
hgs
parents: 34
diff changeset
   199
         *  to help improve startup time
hgs
parents: 34
diff changeset
   200
         *  @since 10.1
hgs
parents: 34
diff changeset
   201
         */        
hgs
parents: 34
diff changeset
   202
        void LateInitL();
34
hgs
parents:
diff changeset
   203
hgs
parents:
diff changeset
   204
    private:
hgs
parents:
diff changeset
   205
        /**
hgs
parents:
diff changeset
   206
         * Constructor
hgs
parents:
diff changeset
   207
         */
hgs
parents:
diff changeset
   208
        CMpxVideoPlayerAppUiEngine( QMpxVideoPlaybackWrapper* aWrapper );
hgs
parents:
diff changeset
   209
hgs
parents:
diff changeset
   210
        /**
hgs
parents:
diff changeset
   211
         * By default Symbian 2nd phase constructor is private.
hgs
parents:
diff changeset
   212
         */
hgs
parents:
diff changeset
   213
        void ConstructL();
hgs
parents:
diff changeset
   214
hgs
parents:
diff changeset
   215
hgs
parents:
diff changeset
   216
        void HandleMultiLinksFileL( const TDesC& aFileName,
hgs
parents:
diff changeset
   217
                                    CMediaRecognizer::TMediaType aMediaType );
hgs
parents:
diff changeset
   218
hgs
parents:
diff changeset
   219
        void HandleMultiLinksFileL( RFile& aFile,
hgs
parents:
diff changeset
   220
                                    CMediaRecognizer::TMediaType aMediaType );
hgs
parents:
diff changeset
   221
hgs
parents:
diff changeset
   222
        void DoHandleMultiLinksFileL( CVideoPlaylistUtility* aPlaylistUtil,
hgs
parents:
diff changeset
   223
                                      TBool aSingleLink,
hgs
parents:
diff changeset
   224
                                      TBool aLocalFile );
hgs
parents:
diff changeset
   225
hgs
parents:
diff changeset
   226
        /**
hgs
parents:
diff changeset
   227
         *  Handles the Url descriptor
hgs
parents:
diff changeset
   228
         *
hgs
parents:
diff changeset
   229
         *  @param aUrl - the ulr to be handled
hgs
parents:
diff changeset
   230
         */
hgs
parents:
diff changeset
   231
        void HandleUrlDesL(const TDesC& aUrl);
hgs
parents:
diff changeset
   232
36
hgs
parents: 35
diff changeset
   233
       /**
hgs
parents: 35
diff changeset
   234
       * Handle collection message
hgs
parents: 35
diff changeset
   235
       *
hgs
parents: 35
diff changeset
   236
       * @param aMessage collection message
hgs
parents: 35
diff changeset
   237
       */
34
hgs
parents:
diff changeset
   238
       void DoHandleCollectionMessageL( CMPXMessage* aMessage );
hgs
parents:
diff changeset
   239
36
hgs
parents: 35
diff changeset
   240
       void CreatePlaybackUtilityL();
34
hgs
parents:
diff changeset
   241
hgs
parents:
diff changeset
   242
       void CreateCollectionUtilityMemberVariablesL();
36
hgs
parents: 35
diff changeset
   243
      
34
hgs
parents:
diff changeset
   244
	   /*
hgs
parents:
diff changeset
   245
	   * used to send media info to plugin
hgs
parents:
diff changeset
   246
	   */
hgs
parents:
diff changeset
   247
       void UpdatePbPluginMediaL();
hgs
parents:
diff changeset
   248
hgs
parents:
diff changeset
   249
       void ActivateVideoPlaybackView();
hgs
parents:
diff changeset
   250
hgs
parents:
diff changeset
   251
    private:       // data
hgs
parents:
diff changeset
   252
hgs
parents:
diff changeset
   253
        //
hgs
parents:
diff changeset
   254
        //  Owned Utilities
hgs
parents:
diff changeset
   255
        //
hgs
parents:
diff changeset
   256
        MMPXPlaybackUtility*     iPlaybackUtility;
hgs
parents:
diff changeset
   257
        MMPXCollectionUtility*   iCollectionUtility;
hgs
parents:
diff changeset
   258
        MMPXCollectionUiHelper*  iCollectionUiHelper;  // own
hgs
parents:
diff changeset
   259
hgs
parents:
diff changeset
   260
        TUid iVideoCollectionId;
hgs
parents:
diff changeset
   261
hgs
parents:
diff changeset
   262
        CMediaRecognizer*             iRecognizer;       // own
hgs
parents:
diff changeset
   263
hgs
parents:
diff changeset
   264
        TInt                     iAccessPointId;
hgs
parents:
diff changeset
   265
        TBool                    iMultilinkPlaylist;
hgs
parents:
diff changeset
   266
        TBool                    iSeekable;
hgs
parents:
diff changeset
   267
        TBool                    iUpdateSeekInfo;
hgs
parents:
diff changeset
   268
hgs
parents:
diff changeset
   269
        QMpxVideoPlaybackWrapper* iPlaybackWrapper;
hgs
parents:
diff changeset
   270
};
hgs
parents:
diff changeset
   271
hgs
parents:
diff changeset
   272
//
hgs
parents:
diff changeset
   273
//  Inline methods
hgs
parents:
diff changeset
   274
//
hgs
parents:
diff changeset
   275
inline
hgs
parents:
diff changeset
   276
MMPXPlaybackUtility* CMpxVideoPlayerAppUiEngine::PlaybackUtility()
hgs
parents:
diff changeset
   277
{
hgs
parents:
diff changeset
   278
    return iPlaybackUtility;
hgs
parents:
diff changeset
   279
}
hgs
parents:
diff changeset
   280
hgs
parents:
diff changeset
   281
#endif             // CMPXVIDEOPLAYERAPPUIENGINE_H