|
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". |
|
7 // |
|
8 // Initial Contributors: |
|
9 // Nokia Corporation - initial contribution. |
|
10 // |
|
11 // Contributors: |
|
12 // |
|
13 // Description: |
|
14 // |
|
15 |
|
16 /** |
|
17 @file |
|
18 @publishedPartner |
|
19 @released |
|
20 */ |
|
21 |
|
22 #ifndef __IMAGE_PROCESSOR_OVERLAY_INF_H__ |
|
23 #define __IMAGE_PROCESSOR_OVERLAY_INF_H__ |
|
24 |
|
25 #include <e32base.h> |
|
26 |
|
27 class CFbsBitmap; |
|
28 class CImageFrame; |
|
29 class TMMSource; |
|
30 class RFile; |
|
31 |
|
32 namespace ImageProcessor |
|
33 { |
|
34 namespace Plugin |
|
35 { |
|
36 |
|
37 /** |
|
38 Plugin API for the overlay effects. |
|
39 |
|
40 @see TOverlay |
|
41 @publishedPartner |
|
42 @released |
|
43 */ |
|
44 class MOverlay |
|
45 { |
|
46 public: |
|
47 /** |
|
48 This must provide an implementation as defined by TOverlay::SupportedInputSubFormatsL(TUid aFormat, RArray<TUid>& aSubFormats) |
|
49 |
|
50 @see TOverlay::SupportedInputSubFormatsL(TUid aFormat, RArray<TUid>& aSubFormats) |
|
51 */ |
|
52 virtual void SupportedInputSubFormatsL(TUid aFormat, RArray<TUid>& aSubFormats) const = 0; |
|
53 |
|
54 /** |
|
55 This must provide an implementation as defined by TOverlay::SetInputL(const TDesC& aFilename, const TUid& aFormat, const TUid& aSubFormat) |
|
56 |
|
57 @see TOverlay::SetInputL(const TDesC& aFilename, const TUid& aFormat, const TUid& aSubFormat) |
|
58 */ |
|
59 virtual void SetInputL(const TDesC& aFilename, const TUid& aFormat, const TUid& aSubFormat) = 0; |
|
60 |
|
61 /** |
|
62 This must provide an implementation as defined by TOverlay::SetInputL(RFile& aFile, const TUid& aFormat, const TUid& aSubFormat) |
|
63 |
|
64 @see TOverlay::SetInputL(RFile& aFile, const TUid& aFormat, const TUid& aSubFormat) |
|
65 */ |
|
66 virtual void SetInputL(RFile& aFile, const TUid& aFormat, const TUid& aSubFormat) = 0; |
|
67 |
|
68 /** |
|
69 This must provide an implementation as defined by TOverlay::SetInputL(TMMSource& aDrmFile, const TUid& aFormat, const TUid& aSubFormat) |
|
70 |
|
71 @see TOverlay::SetInputL(TMMSource& aDrmFile, const TUid& aFormat, const TUid& aSubFormat) |
|
72 */ |
|
73 virtual void SetInputL(TMMSource& aDrmFile, const TUid& aFormat, const TUid& aSubFormat) = 0; |
|
74 |
|
75 /** |
|
76 This must provide an implementation as defined by TOverlay::SetInputL(const TDesC8& aBuffer, const TUid& aFormat, const TUid& aSubFormat) |
|
77 |
|
78 @see TOverlay::SetInputL(const TDesC8& aBuffer, const TUid& aFormat, const TUid& aSubFormat) |
|
79 */ |
|
80 virtual void SetInputL(const TDesC8& aBuffer, const TUid& aFormat, const TUid& aSubFormat) = 0; |
|
81 |
|
82 /** |
|
83 This must provide an implementation as defined by TOverlay::SetInputL(const CFbsBitmap& aBitmap, const CFbsBitmap* aMask = NULL) |
|
84 |
|
85 @see TOverlay::SetInputL(const CFbsBitmap& aBitmap, const CFbsBitmap* aMask = NULL) |
|
86 */ |
|
87 virtual void SetInputL(const CFbsBitmap& aBitmap, const CFbsBitmap* aMask = NULL) = 0; |
|
88 |
|
89 /** |
|
90 This must provide an implementation as defined by TOverlay::SetInputL(const CImageFrame& aPixelBuffer) |
|
91 |
|
92 @see TOverlay::SetInputL(const CImageFrame& aPixelBuffer) |
|
93 */ |
|
94 virtual void SetInputL(const CImageFrame& aPixelBuffer) = 0; |
|
95 |
|
96 |
|
97 /** |
|
98 This must provide an implementation as defined by TOverlay::BeginL() |
|
99 |
|
100 @see TOverlay::BeginL() |
|
101 */ |
|
102 virtual void BeginL() = 0; |
|
103 |
|
104 /** |
|
105 This must provide an implementation as defined by TOverlay::SetL(const TSize &aSize, const TPoint &aPosition, TReal32 aAngle) |
|
106 |
|
107 @see TOverlay::SetL(const TSize &aSize, const TPoint &aPosition, TReal32 aAngle) |
|
108 */ |
|
109 virtual void SetL(const TSize &aSize, const TPoint &aPosition, TReal32 aAngle) = 0; |
|
110 |
|
111 /** |
|
112 This must provide an implementation as defined by TOverlay::SetL(TReal32 aScaleX, TReal32 aScaleY, const TPoint &aPosition, TReal32 aAngle) |
|
113 |
|
114 @see TOverlay::SetL(TReal32 aScaleX, TReal32 aScaleY, const TPoint &aPosition, TReal32 aAngle) |
|
115 */ |
|
116 virtual void SetL(TReal32 aScaleX, TReal32 aScaleY, const TPoint &aPosition, TReal32 aAngle) = 0; |
|
117 |
|
118 /** |
|
119 This must provide an implementation as defined by TOverlay::EndL() |
|
120 |
|
121 @see TOverlay::EndL() |
|
122 */ |
|
123 virtual void EndL() = 0; |
|
124 |
|
125 /** |
|
126 This must provide an implementation as defined by TOverlay::ResetL() |
|
127 |
|
128 @see TOverlay::ResetL() |
|
129 */ |
|
130 virtual void ResetL() = 0; |
|
131 |
|
132 /** |
|
133 This must provide an implementation as defined by TOverlay::PositionL() |
|
134 |
|
135 @see TOverlay::PositionL() |
|
136 */ |
|
137 virtual TPoint PositionL() const = 0; |
|
138 |
|
139 /** |
|
140 This must provide an implementation as defined by TOverlay::SizeL() |
|
141 |
|
142 @see TOverlay::SizeL() |
|
143 */ |
|
144 virtual TSize SizeL() const = 0; |
|
145 |
|
146 /** |
|
147 This must provide an implementation as defined by TOverlay::AngleL() |
|
148 |
|
149 @see TOverlay::AngleL() |
|
150 */ |
|
151 virtual TReal32 AngleL() const = 0; |
|
152 |
|
153 /** |
|
154 This must provide an implementation as defined by TOverlay::GetScaleL(TReal32& aScaleX, TReal32& aScaleY) |
|
155 |
|
156 @see TOverlay::GetScaleL(TReal32& aScaleX, TReal32& aScaleY) |
|
157 */ |
|
158 virtual void GetScaleL(TReal32& aScaleX, TReal32& aScaleY) const = 0; |
|
159 |
|
160 private: |
|
161 TInt iReserved; // future proof |
|
162 }; |
|
163 |
|
164 } |
|
165 } |
|
166 |
|
167 #endif //__IMAGE_PROCESSOR_OVERLAY_H__ |