|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
3 |
* All rights reserved.
|
|
sl@0
|
4 |
* This component and the accompanying materials are made available
|
|
sl@0
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
6 |
* which accompanies this distribution, and is available
|
|
sl@0
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
8 |
*
|
|
sl@0
|
9 |
* Initial Contributors:
|
|
sl@0
|
10 |
* Nokia Corporation - initial contribution.
|
|
sl@0
|
11 |
*
|
|
sl@0
|
12 |
* Contributors:
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* Description: Interface definition for BT SBC Encoder configuration.
|
|
sl@0
|
15 |
*
|
|
sl@0
|
16 |
*/
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
#ifndef CSBCENCODERINTFC_H
|
|
sl@0
|
20 |
#define CSBCENCODERINTFC_H
|
|
sl@0
|
21 |
|
|
sl@0
|
22 |
// INCLUDES
|
|
sl@0
|
23 |
#include <e32base.h>
|
|
sl@0
|
24 |
|
|
sl@0
|
25 |
// CONSTANTS
|
|
sl@0
|
26 |
const TUid KUidSbcEncoderIntfc = {0x10207B24};
|
|
sl@0
|
27 |
|
|
sl@0
|
28 |
// MACROS
|
|
sl@0
|
29 |
|
|
sl@0
|
30 |
// DATA TYPES
|
|
sl@0
|
31 |
|
|
sl@0
|
32 |
// FUNCTION PROTOTYPES
|
|
sl@0
|
33 |
|
|
sl@0
|
34 |
// FORWARD DECLARATIONS
|
|
sl@0
|
35 |
class CMMFDevSound;
|
|
sl@0
|
36 |
class CMdaAudioInputStream;
|
|
sl@0
|
37 |
|
|
sl@0
|
38 |
// CLASS DECLARATION
|
|
sl@0
|
39 |
|
|
sl@0
|
40 |
/**
|
|
sl@0
|
41 |
* Interface for configuring the SBC encoder.
|
|
sl@0
|
42 |
* Used to configure the SBC encoder operating modes.
|
|
sl@0
|
43 |
* This abstract class just provides the static NewL function for the creation
|
|
sl@0
|
44 |
* of the proxy, and also defines the custom interface to be implemented by the
|
|
sl@0
|
45 |
* proxy and the real custom interface implementation.
|
|
sl@0
|
46 |
*
|
|
sl@0
|
47 |
* @lib SbcEncoderIntfc.lib
|
|
sl@0
|
48 |
* @since S60 3.0
|
|
sl@0
|
49 |
*/
|
|
sl@0
|
50 |
class CSbcEncoderIntfc : public CBase
|
|
sl@0
|
51 |
{
|
|
sl@0
|
52 |
public: // Data
|
|
sl@0
|
53 |
|
|
sl@0
|
54 |
// Supported channel modes
|
|
sl@0
|
55 |
enum TSbcChannelMode
|
|
sl@0
|
56 |
{
|
|
sl@0
|
57 |
ESbcChannelMono,
|
|
sl@0
|
58 |
ESbcChannelDual,
|
|
sl@0
|
59 |
ESbcChannelStereo,
|
|
sl@0
|
60 |
ESbcChannelJointStereo
|
|
sl@0
|
61 |
};
|
|
sl@0
|
62 |
|
|
sl@0
|
63 |
// Supported allocation methods
|
|
sl@0
|
64 |
enum TSbcAllocationMethod
|
|
sl@0
|
65 |
{
|
|
sl@0
|
66 |
ESbcAllocationSNR,
|
|
sl@0
|
67 |
ESbcAllocationLoudness
|
|
sl@0
|
68 |
};
|
|
sl@0
|
69 |
|
|
sl@0
|
70 |
public: // Constructors and destructor
|
|
sl@0
|
71 |
|
|
sl@0
|
72 |
/**
|
|
sl@0
|
73 |
* Creates the interface.
|
|
sl@0
|
74 |
*/
|
|
sl@0
|
75 |
IMPORT_C static CSbcEncoderIntfc* NewL(CMMFDevSound& aDevSound);
|
|
sl@0
|
76 |
|
|
sl@0
|
77 |
/**
|
|
sl@0
|
78 |
* Creates the interface.
|
|
sl@0
|
79 |
*/
|
|
sl@0
|
80 |
IMPORT_C static CSbcEncoderIntfc* NewL(CMdaAudioInputStream& aUtility);
|
|
sl@0
|
81 |
|
|
sl@0
|
82 |
public: // New functions
|
|
sl@0
|
83 |
/**
|
|
sl@0
|
84 |
* Retrieves the sampling frequencies supported by the encoder.
|
|
sl@0
|
85 |
* @since S60 3.0
|
|
sl@0
|
86 |
* @param aSupportedSamplingFrequencies array returning the supported
|
|
sl@0
|
87 |
* frequencies.
|
|
sl@0
|
88 |
* @return TInt status
|
|
sl@0
|
89 |
*/
|
|
sl@0
|
90 |
IMPORT_C virtual TInt GetSupportedSamplingFrequencies(
|
|
sl@0
|
91 |
RArray<TUint>& aSupportedSamplingFrequencies) = 0;
|
|
sl@0
|
92 |
|
|
sl@0
|
93 |
/**
|
|
sl@0
|
94 |
* Retrieves the channel configurations supported by the encoder.
|
|
sl@0
|
95 |
* @since S60 3.0
|
|
sl@0
|
96 |
* @param aSupportedChannelModes array returning the supported
|
|
sl@0
|
97 |
* frequencies.
|
|
sl@0
|
98 |
* @return TInt status
|
|
sl@0
|
99 |
*/
|
|
sl@0
|
100 |
IMPORT_C virtual TInt GetSupportedChannelModes(
|
|
sl@0
|
101 |
RArray<TSbcChannelMode>&
|
|
sl@0
|
102 |
aSupportedChannelModes) = 0;
|
|
sl@0
|
103 |
|
|
sl@0
|
104 |
/**
|
|
sl@0
|
105 |
* Retrieves array of supported block numbers by the encoder.
|
|
sl@0
|
106 |
* @since S60 3.0
|
|
sl@0
|
107 |
* @param aNumBlocks array returning block numbers.
|
|
sl@0
|
108 |
* @return TInt status
|
|
sl@0
|
109 |
*/
|
|
sl@0
|
110 |
IMPORT_C virtual TInt GetSupportedNumOfBlocks(
|
|
sl@0
|
111 |
RArray<TUint>& aSupportedNumOfBlocks) = 0;
|
|
sl@0
|
112 |
|
|
sl@0
|
113 |
/**
|
|
sl@0
|
114 |
* Retrieves the number of subbands supported by the encoder.
|
|
sl@0
|
115 |
* @since S60 3.0
|
|
sl@0
|
116 |
* @param aSupportedNumOfSubbands array returning the supported number
|
|
sl@0
|
117 |
* of subbands.
|
|
sl@0
|
118 |
* @return TInt status
|
|
sl@0
|
119 |
*/
|
|
sl@0
|
120 |
IMPORT_C virtual TInt GetSupportedNumOfSubbands(
|
|
sl@0
|
121 |
RArray<TUint>& aSupportedNumOfSubbands) = 0;
|
|
sl@0
|
122 |
|
|
sl@0
|
123 |
/**
|
|
sl@0
|
124 |
* Retrieves the allocation methods supported by the encoder.
|
|
sl@0
|
125 |
* @since S60 3.0
|
|
sl@0
|
126 |
* @param aSupportedAllocationMethods array returning the supported
|
|
sl@0
|
127 |
* allocation methods.
|
|
sl@0
|
128 |
* @return TInt status
|
|
sl@0
|
129 |
*/
|
|
sl@0
|
130 |
IMPORT_C virtual TInt GetSupportedAllocationMethods(
|
|
sl@0
|
131 |
RArray<TSbcAllocationMethod>&
|
|
sl@0
|
132 |
aSupportedAllocationMethods) = 0;
|
|
sl@0
|
133 |
|
|
sl@0
|
134 |
/**
|
|
sl@0
|
135 |
* Retrieves the supported bitpool range by the encoder.
|
|
sl@0
|
136 |
* @since S60 3.0
|
|
sl@0
|
137 |
* @param aMinSupportedBitpoolSize returning the min bitpool size.
|
|
sl@0
|
138 |
* @param aMaxSupportedBitpoolSize returning the max bitpool size.
|
|
sl@0
|
139 |
* @return TInt status
|
|
sl@0
|
140 |
*/
|
|
sl@0
|
141 |
IMPORT_C virtual TInt GetSupportedBitpoolRange(
|
|
sl@0
|
142 |
TUint& aMinSupportedBitpoolSize,
|
|
sl@0
|
143 |
TUint& aMaxSupportedBitpoolSize) = 0;
|
|
sl@0
|
144 |
|
|
sl@0
|
145 |
/**
|
|
sl@0
|
146 |
* Sets the sampling frequency for encoding.
|
|
sl@0
|
147 |
* @since S60 3.0
|
|
sl@0
|
148 |
* @param aSamplingFrequency requested encoding sampling frequency.
|
|
sl@0
|
149 |
* @return void
|
|
sl@0
|
150 |
*/
|
|
sl@0
|
151 |
IMPORT_C virtual void SetSamplingFrequency(
|
|
sl@0
|
152 |
TUint aSamplingFrequency) = 0;
|
|
sl@0
|
153 |
|
|
sl@0
|
154 |
/**
|
|
sl@0
|
155 |
* Retrieves the current encode sampling frequency.
|
|
sl@0
|
156 |
* @since S60 3.0
|
|
sl@0
|
157 |
* @param aSamplingFrequency returns current encode sampling frequency.
|
|
sl@0
|
158 |
* @return TInt status
|
|
sl@0
|
159 |
*/
|
|
sl@0
|
160 |
IMPORT_C virtual TInt GetSamplingFrequency(
|
|
sl@0
|
161 |
TUint& aSamplingFrequency) = 0;
|
|
sl@0
|
162 |
|
|
sl@0
|
163 |
/**
|
|
sl@0
|
164 |
* Sets the channel mode for encoding.
|
|
sl@0
|
165 |
* @since S60 3.0
|
|
sl@0
|
166 |
* @param aChannelMode requested encoding channel mode.
|
|
sl@0
|
167 |
* @return void
|
|
sl@0
|
168 |
*/
|
|
sl@0
|
169 |
IMPORT_C virtual void SetChannelMode(
|
|
sl@0
|
170 |
TSbcChannelMode aChannelMode) = 0;
|
|
sl@0
|
171 |
|
|
sl@0
|
172 |
/**
|
|
sl@0
|
173 |
* Retrieves the current encode channel mode.
|
|
sl@0
|
174 |
* @since S60 3.0
|
|
sl@0
|
175 |
* @param aChannelMode returns current encode channel mode.
|
|
sl@0
|
176 |
* @return TInt status
|
|
sl@0
|
177 |
*/
|
|
sl@0
|
178 |
IMPORT_C virtual TInt GetChannelMode(
|
|
sl@0
|
179 |
TSbcChannelMode& aChannelMode) = 0;
|
|
sl@0
|
180 |
|
|
sl@0
|
181 |
/**
|
|
sl@0
|
182 |
* Sets the number of subbands for encoding.
|
|
sl@0
|
183 |
* @since S60 3.0
|
|
sl@0
|
184 |
* @param aNumofSubbands requested encoding number of subbands.
|
|
sl@0
|
185 |
* @return void
|
|
sl@0
|
186 |
*/
|
|
sl@0
|
187 |
IMPORT_C virtual void SetNumOfSubbands(TUint aNumOfSubbands) = 0;
|
|
sl@0
|
188 |
|
|
sl@0
|
189 |
/**
|
|
sl@0
|
190 |
* Retrieves the current encode number of subbands.
|
|
sl@0
|
191 |
* @since S60 3.0
|
|
sl@0
|
192 |
* @param aNumOfSubbands returns current encode number of subbands.
|
|
sl@0
|
193 |
* @return TInt status
|
|
sl@0
|
194 |
*/
|
|
sl@0
|
195 |
IMPORT_C virtual TInt GetNumOfSubbands(TUint& aNumOfSubbands) = 0;
|
|
sl@0
|
196 |
|
|
sl@0
|
197 |
/**
|
|
sl@0
|
198 |
* Sets the number of blocks for encoding.
|
|
sl@0
|
199 |
* @since S60 3.0
|
|
sl@0
|
200 |
* @param aNumOfBlocks requested encoding number of blocks.
|
|
sl@0
|
201 |
* @return void
|
|
sl@0
|
202 |
*/
|
|
sl@0
|
203 |
IMPORT_C virtual void SetNumOfBlocks(TUint aNumOfBlocks) = 0;
|
|
sl@0
|
204 |
|
|
sl@0
|
205 |
/**
|
|
sl@0
|
206 |
* Retrieves the current encode number of blocks.
|
|
sl@0
|
207 |
* @since S60 3.0
|
|
sl@0
|
208 |
* @param aNumOfBlocks returns current encode number of blocks.
|
|
sl@0
|
209 |
* @return TInt status
|
|
sl@0
|
210 |
*/
|
|
sl@0
|
211 |
IMPORT_C virtual TInt GetNumOfBlocks(TUint& aNumOfBlocks) = 0;
|
|
sl@0
|
212 |
|
|
sl@0
|
213 |
/**
|
|
sl@0
|
214 |
* Sets the allocation method for encoding.
|
|
sl@0
|
215 |
* @since S60 3.0
|
|
sl@0
|
216 |
* @param aAllocationMethod requested encoding allocation method.
|
|
sl@0
|
217 |
* @return void
|
|
sl@0
|
218 |
*/
|
|
sl@0
|
219 |
IMPORT_C virtual void SetAllocationMethod(
|
|
sl@0
|
220 |
TSbcAllocationMethod aAllocationMethod) = 0;
|
|
sl@0
|
221 |
|
|
sl@0
|
222 |
/**
|
|
sl@0
|
223 |
* Retrieves the current encode allocation method.
|
|
sl@0
|
224 |
* @since S60 3.0
|
|
sl@0
|
225 |
* @param aAllocationMethod returns current encode allocation method.
|
|
sl@0
|
226 |
* @return TInt status
|
|
sl@0
|
227 |
*/
|
|
sl@0
|
228 |
IMPORT_C virtual TInt GetAllocationMethod(
|
|
sl@0
|
229 |
TSbcAllocationMethod& aAllocationMethod) = 0;
|
|
sl@0
|
230 |
|
|
sl@0
|
231 |
/**
|
|
sl@0
|
232 |
* Sets the bitpool size for encoding.
|
|
sl@0
|
233 |
* @since S60 3.0
|
|
sl@0
|
234 |
* @param aBitpoolSize requested encoding number of blocks.
|
|
sl@0
|
235 |
* @return void
|
|
sl@0
|
236 |
*/
|
|
sl@0
|
237 |
IMPORT_C virtual void SetBitpoolSize(TUint aBitpoolSize) = 0;
|
|
sl@0
|
238 |
|
|
sl@0
|
239 |
/**
|
|
sl@0
|
240 |
* Retrieves the current encode bitpool size.
|
|
sl@0
|
241 |
* @since S60 3.0
|
|
sl@0
|
242 |
* @param aBitpoolSize returns current encode bitpool size.
|
|
sl@0
|
243 |
* @return TInt status
|
|
sl@0
|
244 |
*/
|
|
sl@0
|
245 |
IMPORT_C virtual TInt GetBitpoolSize(TUint& aBitpoolSize) = 0;
|
|
sl@0
|
246 |
|
|
sl@0
|
247 |
/**
|
|
sl@0
|
248 |
* Applies configuration to the encoder.
|
|
sl@0
|
249 |
* @since S60 3.0
|
|
sl@0
|
250 |
* @return TInt - status
|
|
sl@0
|
251 |
*/
|
|
sl@0
|
252 |
IMPORT_C virtual TInt ApplyConfig() = 0;
|
|
sl@0
|
253 |
|
|
sl@0
|
254 |
};
|
|
sl@0
|
255 |
|
|
sl@0
|
256 |
#endif // CSBCENCODERINTFC_H
|
|
sl@0
|
257 |
|
|
sl@0
|
258 |
// End of File
|