os/mm/mmplugins/mmfwplugins/src/Plugin/subtitle/common/mmfsubtitlegraphicmessage.h
Update contrib.
1 // Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
2 // All rights reserved.
3 // This component and the accompanying materials are made available
4 // under the terms of "Eclipse Public License v1.0"
5 // which accompanies this distribution, and is available
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
8 // Initial Contributors:
9 // Nokia Corporation - initial contribution.
21 #ifndef MMFSUBTITLEGRAPHICMESSAGE_H
22 #define MMFSUBTITLEGRAPHICMESSAGE_H
28 Defines the message classes for communication between the MMF CRP
29 subtitle rendering client and the WSERV CRP graphic plug-in
33 enum TSubtitleGraphicMessage
35 ESubtitleCrpMessageInit = 10,
36 ESubtitleCrpMessageInitSimple = 20,
37 ESubtitleCrpMessageClear = 30,
38 ESubtitleCrpMessageDrawFrame = 40,
39 ESubtitleCrpMessageSwapFrame = 50
43 Base class for all CRP messages
45 class TSubtitleGraphicMessageBase
48 TSubtitleGraphicMessageBase(TSubtitleGraphicMessage aMsgType);
56 Passes two bitmap handles to the CRP
57 @see CMMFSubtitleGraphic::Initialize(TInt aBuffer1, TInt aBuffer2);
59 class TSubtitleCrpMsgInit : public TSubtitleGraphicMessageBase
62 TSubtitleCrpMsgInit();
63 TSubtitleCrpMsgInit(TInt aBitmapHandle1, TInt aBitmapHandle2);
72 @see CMMFSubtitleGraphic::Initialize()
74 class TSubtitleCrpMsgInitSimple : public TSubtitleGraphicMessageBase
77 TSubtitleCrpMsgInitSimple();
81 Request that the CRP clears all content from the window
82 @see CMMFSubtitleGraphic::Clear()
84 class TSubtitleCrpMsgClear : public TSubtitleGraphicMessageBase
87 TSubtitleCrpMsgClear();
91 Requests that the CRP draws a frame indicated by the CFBSBitmap handle provided
92 @see CMMFSubtitleGraphic::DrawFrame(TInt aFrameHandle, TRect& aDirtyRegion,
93 TTimeIntervalMicroSeconds& aDisplayDuration)
95 class TSubtitleCrpMsgDrawFrame : public TSubtitleGraphicMessageBase
98 TSubtitleCrpMsgDrawFrame();
99 TSubtitleCrpMsgDrawFrame(TInt aBitmapHandle, const TRect& aDirtyRegion, const TTimeIntervalMicroSeconds& aDisplayDuration);
104 TTimeIntervalMicroSeconds iDisplayDuration;
108 Request that the CRP draw the content in the current back buffer. Assumes that the CRP
109 has been intialized with TSubtitleCrpMsgInit
110 @see CMMFSubtitleGraphic::SwapFrame(TInt aExpectedBuffer,
111 TTimeIntervalMicroSeconds& aDisplayDuration, const TRect& aDirtyRegion)
113 class TSubtitleCrpMsgRenderSwapFrame : public TSubtitleGraphicMessageBase
116 TSubtitleCrpMsgRenderSwapFrame();
117 TSubtitleCrpMsgRenderSwapFrame(TInt aExpectedFrame, const TRect& aDirtyRegion, const TTimeIntervalMicroSeconds& aDisplayDuration);
121 TTimeIntervalMicroSeconds iDisplayDuration;