2 * Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
4 * This component and the accompanying materials are made available
5 * under the terms of "Eclipse Public License v1.0"
6 * which accompanies this distribution, and is available
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
9 * Initial Contributors:
10 * Nokia Corporation - initial contribution.
30 #include <a3f/a3fbase.h>
31 #include <a3f/maudioprocessingunit.h>
32 #include <a3f/maudiocodecobserver.h>
36 * A generic abstract interface for codecs.
38 * The client must add a codec to a stream for operation.
39 * The codec can only be added to a stream when the codec is in uninitialized state.
40 * The codec can only be removed from a stream when the codec is in uninitialized or dead states.
47 * Sets the codec format.
49 * For encoders this sets the output format.
50 * For decoders this configures the input format.
51 * Format must be set before the codec can transfer to initialized state.
53 * @param aFormat codec format.
54 * @return An error code. KErrNone on success, otherwise one of the system wide error codes.
56 virtual TInt SetFormat(TUid aFormat)=0;
59 * Sets the sample rate in samples/sec.
61 * sets the sample rate of the encoded data,
62 * and says nothing about the sample rate used on the output device
63 * or whether re-sampling is required that is up to the adaptation.
64 * the result of the operation is returned by MAudioCodecObserver::SampleRateSet().
66 * @param aSampleRate sample rate to be used, in samples/sec.
67 * @return An error code. KErrNone on success, otherwise one of the system wide error codes.
69 virtual TInt SetSampleRate(TInt aSampleRate)=0;
72 * Sets the mode, e.g. mono/stereo.
73 * The result of the operation is returned by MAudioCodecObserver::ModeSet().
75 * @param aMode uid stating the mode.
76 * @return An error code. KErrNone on success, otherwise one of the system wide error codes.
78 virtual TInt SetMode(TUid aMode)=0;
81 * This returns a list of supported sample rates. The list need just include those of the standard list
82 * that are supported. Includes rates supported by sample rate conversion.
83 * GetSupportedSampleRatesComplete() callback shows result.
84 * TODO Need to document that the implementation is responsible for calling Reset() on aSupportedRates.
86 * @param aSupportedRates array that is populated with the supported rates list.
87 * @return An error code. KErrNone on success, otherwise one of the system wide error codes.
89 virtual TInt GetSupportedSamplesRates(RArray<TInt>& aSupportedRates)=0;
92 * This returns a list of supported sample modes. The list corresponds to the current configuration
93 * and support may include the use of mono/stereo conversion etc.
94 * GetSupportedModesComplete() callback shows result.
95 * TODO Need to document that the implementation is responsible for calling Reset() on aSupportedModes.
97 * @param aSupportedModes array that is populated with the supported modes list.
98 * @return An error code. KErrNone on success, otherwise one of the system wide error codes.
100 virtual TInt GetSupportedModes(RArray<TUid>& aSupportedModes)=0;
103 * Registers an audio codec observer.
105 * Note that this function is meant for clients of the Audio codec.
106 * The client should unregister using UnregisterAudioCodecObserver() when applicable
108 * @param aObserver reference to the observer to register.
109 * @return an error code. KErrNone if successful.
110 * KErrAlreadyExists if the client is already registered.
111 * KErrOutOfMemory in case of memory exhaustion.
113 virtual TInt RegisterAudioCodecObserver(MAudioCodecObserver& aObserver)=0;
116 * Unregisters an audio codec observer.
118 * @param aObserver reference to the observer to unregister.
119 * @return an error code. KErrNone if successful.
120 * KErrNotFound if the client has not been registered as observer.
122 virtual void UnregisterAudioCodecObserver(MAudioCodecObserver& aObserver)=0;
126 #endif // MAUDIOCODEC_H