|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 2006-2009 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:
|
|
sl@0
|
15 |
*
|
|
sl@0
|
16 |
*/
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
|
|
sl@0
|
20 |
|
|
sl@0
|
21 |
/**
|
|
sl@0
|
22 |
@file
|
|
sl@0
|
23 |
@publishedPartner
|
|
sl@0
|
24 |
@released
|
|
sl@0
|
25 |
*/
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
#ifndef MAUDIOCODEC_H
|
|
sl@0
|
28 |
#define MAUDIOCODEC_H
|
|
sl@0
|
29 |
|
|
sl@0
|
30 |
#include <a3f/a3fbase.h>
|
|
sl@0
|
31 |
#include <a3f/maudioprocessingunit.h>
|
|
sl@0
|
32 |
#include <a3f/maudiocodecobserver.h>
|
|
sl@0
|
33 |
|
|
sl@0
|
34 |
|
|
sl@0
|
35 |
/**
|
|
sl@0
|
36 |
* A generic abstract interface for codecs.
|
|
sl@0
|
37 |
*
|
|
sl@0
|
38 |
* The client must add a codec to a stream for operation.
|
|
sl@0
|
39 |
* The codec can only be added to a stream when the codec is in uninitialized state.
|
|
sl@0
|
40 |
* The codec can only be removed from a stream when the codec is in uninitialized or dead states.
|
|
sl@0
|
41 |
*/
|
|
sl@0
|
42 |
class MAudioCodec
|
|
sl@0
|
43 |
{
|
|
sl@0
|
44 |
public:
|
|
sl@0
|
45 |
|
|
sl@0
|
46 |
/**
|
|
sl@0
|
47 |
* Sets the codec format.
|
|
sl@0
|
48 |
*
|
|
sl@0
|
49 |
* For encoders this sets the output format.
|
|
sl@0
|
50 |
* For decoders this configures the input format.
|
|
sl@0
|
51 |
* Format must be set before the codec can transfer to initialized state.
|
|
sl@0
|
52 |
*
|
|
sl@0
|
53 |
* @param aFormat codec format.
|
|
sl@0
|
54 |
* @return An error code. KErrNone on success, otherwise one of the system wide error codes.
|
|
sl@0
|
55 |
*/
|
|
sl@0
|
56 |
virtual TInt SetFormat(TUid aFormat)=0;
|
|
sl@0
|
57 |
|
|
sl@0
|
58 |
/**
|
|
sl@0
|
59 |
* Sets the sample rate in samples/sec.
|
|
sl@0
|
60 |
*
|
|
sl@0
|
61 |
* sets the sample rate of the encoded data,
|
|
sl@0
|
62 |
* and says nothing about the sample rate used on the output device
|
|
sl@0
|
63 |
* or whether re-sampling is required that is up to the adaptation.
|
|
sl@0
|
64 |
* the result of the operation is returned by MAudioCodecObserver::SampleRateSet().
|
|
sl@0
|
65 |
*
|
|
sl@0
|
66 |
* @param aSampleRate sample rate to be used, in samples/sec.
|
|
sl@0
|
67 |
* @return An error code. KErrNone on success, otherwise one of the system wide error codes.
|
|
sl@0
|
68 |
*/
|
|
sl@0
|
69 |
virtual TInt SetSampleRate(TInt aSampleRate)=0;
|
|
sl@0
|
70 |
|
|
sl@0
|
71 |
/**
|
|
sl@0
|
72 |
* Sets the mode, e.g. mono/stereo.
|
|
sl@0
|
73 |
* The result of the operation is returned by MAudioCodecObserver::ModeSet().
|
|
sl@0
|
74 |
*
|
|
sl@0
|
75 |
* @param aMode uid stating the mode.
|
|
sl@0
|
76 |
* @return An error code. KErrNone on success, otherwise one of the system wide error codes.
|
|
sl@0
|
77 |
*/
|
|
sl@0
|
78 |
virtual TInt SetMode(TUid aMode)=0;
|
|
sl@0
|
79 |
|
|
sl@0
|
80 |
/**
|
|
sl@0
|
81 |
* This returns a list of supported sample rates. The list need just include those of the standard list
|
|
sl@0
|
82 |
* that are supported. Includes rates supported by sample rate conversion.
|
|
sl@0
|
83 |
* GetSupportedSampleRatesComplete() callback shows result.
|
|
sl@0
|
84 |
* TODO Need to document that the implementation is responsible for calling Reset() on aSupportedRates.
|
|
sl@0
|
85 |
*
|
|
sl@0
|
86 |
* @param aSupportedRates array that is populated with the supported rates list.
|
|
sl@0
|
87 |
* @return An error code. KErrNone on success, otherwise one of the system wide error codes.
|
|
sl@0
|
88 |
*/
|
|
sl@0
|
89 |
virtual TInt GetSupportedSamplesRates(RArray<TInt>& aSupportedRates)=0;
|
|
sl@0
|
90 |
|
|
sl@0
|
91 |
/**
|
|
sl@0
|
92 |
* This returns a list of supported sample modes. The list corresponds to the current configuration
|
|
sl@0
|
93 |
* and support may include the use of mono/stereo conversion etc.
|
|
sl@0
|
94 |
* GetSupportedModesComplete() callback shows result.
|
|
sl@0
|
95 |
* TODO Need to document that the implementation is responsible for calling Reset() on aSupportedModes.
|
|
sl@0
|
96 |
*
|
|
sl@0
|
97 |
* @param aSupportedModes array that is populated with the supported modes list.
|
|
sl@0
|
98 |
* @return An error code. KErrNone on success, otherwise one of the system wide error codes.
|
|
sl@0
|
99 |
*/
|
|
sl@0
|
100 |
virtual TInt GetSupportedModes(RArray<TUid>& aSupportedModes)=0;
|
|
sl@0
|
101 |
|
|
sl@0
|
102 |
/**
|
|
sl@0
|
103 |
* Registers an audio codec observer.
|
|
sl@0
|
104 |
*
|
|
sl@0
|
105 |
* Note that this function is meant for clients of the Audio codec.
|
|
sl@0
|
106 |
* The client should unregister using UnregisterAudioCodecObserver() when applicable
|
|
sl@0
|
107 |
*
|
|
sl@0
|
108 |
* @param aObserver reference to the observer to register.
|
|
sl@0
|
109 |
* @return an error code. KErrNone if successful.
|
|
sl@0
|
110 |
* KErrAlreadyExists if the client is already registered.
|
|
sl@0
|
111 |
* KErrOutOfMemory in case of memory exhaustion.
|
|
sl@0
|
112 |
*/
|
|
sl@0
|
113 |
virtual TInt RegisterAudioCodecObserver(MAudioCodecObserver& aObserver)=0;
|
|
sl@0
|
114 |
|
|
sl@0
|
115 |
/**
|
|
sl@0
|
116 |
* Unregisters an audio codec observer.
|
|
sl@0
|
117 |
*
|
|
sl@0
|
118 |
* @param aObserver reference to the observer to unregister.
|
|
sl@0
|
119 |
* @return an error code. KErrNone if successful.
|
|
sl@0
|
120 |
* KErrNotFound if the client has not been registered as observer.
|
|
sl@0
|
121 |
*/
|
|
sl@0
|
122 |
virtual void UnregisterAudioCodecObserver(MAudioCodecObserver& aObserver)=0;
|
|
sl@0
|
123 |
|
|
sl@0
|
124 |
};
|
|
sl@0
|
125 |
|
|
sl@0
|
126 |
#endif // MAUDIOCODEC_H
|