sl@0: /*
sl@0: * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). 
sl@0: * All rights reserved.
sl@0: * This component and the accompanying materials are made available
sl@0: * under the terms of "Eclipse Public License v1.0"
sl@0: * which accompanies this distribution, and is available
sl@0: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: *
sl@0: * Initial Contributors:
sl@0: * Nokia Corporation - initial contribution.
sl@0: *
sl@0: * Contributors:
sl@0: *
sl@0: * Description:  Project specification for WMA 10 Pro decoder 
sl@0: *              : Custom Interface.
sl@0: *
sl@0: */
sl@0: 
sl@0: 
sl@0: #ifndef WMADECODERINTFC_H
sl@0: #define WMADECODERINTFC_H
sl@0: 
sl@0: // INCLUDES
sl@0: #include <e32base.h>
sl@0: 
sl@0: // CONSTANTS
sl@0: const TUid KUidWmaDecoderIntfc = {0x10207BAD};
sl@0: 
sl@0: // MACROS
sl@0: 
sl@0: // DATA TYPES
sl@0: 
sl@0: // FUNCTION PROTOTYPES
sl@0: 
sl@0: // FORWARD DECLARATIONS
sl@0: class CMMFDevSound;
sl@0: class CMdaAudioInputStream;
sl@0: class CMdaAudioOutputStream;
sl@0: 
sl@0: // CLASS DECLARATION
sl@0: 
sl@0: /**
sl@0: *  Interface for sending configuration info to WMA 10 Pro decoder.
sl@0: *  This abstract class just provides the static NewL function for the 
sl@0: *  creation of the proxy. Also, it defines the APIs to be implemented 
sl@0: *  by the proxy and the real custom interface implementation.
sl@0: *
sl@0: *  @lib WmaDecoderIntfc.lib
sl@0: *  @since S60 3.2
sl@0: */
sl@0: class CWmaDecoderIntfc : public CBase
sl@0:     {
sl@0:     public: //data types
sl@0: 
sl@0:     enum TFormat
sl@0:         {
sl@0:         EWmaVoice = 10,
sl@0:         EWmaV1 = 352,
sl@0:         EWma = 353, 
sl@0:         EWmaV2 = 353, 
sl@0:         EWmaPro  = 354,
sl@0:         EWmaLossless = 355,
sl@0:         };
sl@0: 
sl@0:     enum TTool
sl@0:         {
sl@0:  		EToolOutput32Bit	= 1, //default = disabled
sl@0: 		EDownMixToStereo	= 2, //default = disabled
sl@0: 		ELostDataConcealment= 3  // default = disabled
sl@0: 		};
sl@0: 
sl@0:     public:  // Constructors and destructor
sl@0: 
sl@0:         /**
sl@0:         * Creates the interface.
sl@0:         */
sl@0: 		IMPORT_C static CWmaDecoderIntfc* 
sl@0: 		                NewL(CMMFDevSound& aDevSound);
sl@0: 
sl@0:         /**
sl@0:         * Creates the interface 
sl@0:         * This function will always leave with KErrNotSuppored
sl@0:         */
sl@0: 		IMPORT_C static CWmaDecoderIntfc* 
sl@0: 		                NewL(CMdaAudioInputStream& aUtility);
sl@0: 
sl@0:         /**
sl@0:         * Creates the interface.
sl@0:         */
sl@0: 		IMPORT_C static CWmaDecoderIntfc* 
sl@0: 		                NewL(CMdaAudioOutputStream& aUtility);
sl@0: 
sl@0:     public: // New functions
sl@0: 
sl@0:         /**
sl@0:         * Configures the compressed audio format
sl@0:         * @since S60 3.2
sl@0:         * @param aFormat - the audio format.
sl@0:         * @return void
sl@0:         */
sl@0: 		IMPORT_C virtual void SetFormat(TFormat aFormat) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Configures the number of bits per sample 
sl@0:         * @since S60 3.2
sl@0:         * @param aBitsPerSample - bits per sample.
sl@0:         * @return void
sl@0:         */
sl@0: 		IMPORT_C virtual void SetBitsPerSampleIn(TUint aBitsPerSample) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Configures the number of audio channels  
sl@0:         * @since S60 3.2
sl@0:         * @param aNumOfChannels: The number of audio channels.
sl@0:         * @return void
sl@0:         */
sl@0: 		IMPORT_C virtual void SetNumChannelsIn (TUint aNumChannelsIn) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Configures the sampling rate   
sl@0:         * @since S60 3.2
sl@0:         * @param aSamplesPerSec: Sample rate value in Hertz.
sl@0:         * @return void
sl@0:         */
sl@0: 		IMPORT_C virtual void SetSamplesPerSec (TUint aSamplesPerSec) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Configures the average number of bytes per second   
sl@0:         * @since S60 3.2
sl@0:         * @param aAvgBytesPerSec: Average bytes per second.
sl@0:         * @return void
sl@0:         */
sl@0: 		IMPORT_C virtual void SetAvgBytesPerSec (TUint aAvgBytesPerSec) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Configures the block align size in bytes    
sl@0:         * @since S60 3.2
sl@0:         * @param aBlockAlign: Block size in bytes
sl@0:         * @return void
sl@0:         */
sl@0: 		IMPORT_C virtual void SetBlockAlign (TUint aBlockAlign) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Configures information specific to the WMA decoder
sl@0:         * @since S60 3.2
sl@0:         * @param aEncodeOptions: The encode options
sl@0:         * @return void
sl@0:         */
sl@0: 		IMPORT_C virtual void SetEncodeOptions (TUint aEncodeOptions) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Configures information specific to the WMA 10 Pro decoder
sl@0:         * @since S60 3.2
sl@0:         * @param aEncodeOpts1: The encode options 1
sl@0:         * @return void
sl@0:         */
sl@0: 		IMPORT_C virtual void SetEncodeOptions1 (TUint aEncodeOpts1) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Configures information specific to the WMA 10 Pro decoder
sl@0:         * @since S60 3.2
sl@0:         * @param aEncodeOpts2: The encode options 2
sl@0:         * @return void
sl@0:         */
sl@0: 		IMPORT_C virtual void SetEncodeOptions2 (TUint aEncodeOpts2) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Configures the decoder for the channel data arrangement 
sl@0:         * @since S60 3.2
sl@0:         * @param aChannelMask: Channel mask
sl@0:         * @return void
sl@0:         */
sl@0: 		IMPORT_C virtual void SetChannelMaskIn (TUint aChannelMask) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Commits configuration settings to the decoder.
sl@0:         * @since S60 3.2
sl@0:         * @return TInt - Status
sl@0:         */
sl@0: 		IMPORT_C virtual TInt ApplyConfig() = 0;
sl@0: 
sl@0:         /**
sl@0:         * Returns the configuration state of audio format.
sl@0:         * @since S60 3.2
sl@0:         * @return aFormat: The audio format
sl@0:         */
sl@0: 		IMPORT_C virtual TInt GetFormat (TFormat& aFormat) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Returns the configuration state of number of bits per sample.
sl@0:         * @since S60 3.2
sl@0:         * @return aBitsPerSample: Number of bits per sample
sl@0:         */
sl@0: 		IMPORT_C virtual TInt GetBitsPerSampleIn(TUint& aBitsPerSample) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Returns the configuration state of the number of channels.
sl@0:         * @since S60 3.2
sl@0:         * @return aNumOfChannels: Number of channels
sl@0:         */
sl@0: 		IMPORT_C virtual TInt GetNumOfChannelsIn (TUint& aNumOfChannels) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Returns the configuration state of the sample rate.
sl@0:         * @since S60 3.2
sl@0:         * @return aSamplesPerSec: Sample rate value in Hertz
sl@0:         */
sl@0: 		IMPORT_C virtual TInt GetSamplesPerSec (TUint& aSamplesPerSec) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Returns the configuration state of average bytes per second.
sl@0:         * @since S60 3.2
sl@0:         * @return aAvgBytesPerSec: Average bytes per second
sl@0:         */
sl@0: 		IMPORT_C virtual TInt GetAvgBytesPerSec (TUint& aAvgBytesPerSec) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Returns the configuration state of block alignment. 
sl@0:         * @since S60 3.2
sl@0:         * @return aBlockAlign: Block size in bytes
sl@0:         */
sl@0: 		IMPORT_C virtual TInt GetBlockAlign (TUint& aBlockAlign) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Returns the configuration state of the encode options.
sl@0:         * @since S60 3.2
sl@0:         * @return aEncodeOpts: The encode options.
sl@0:         */
sl@0: 		IMPORT_C virtual TInt GetEncodeOptions (TUint& aEncodeOpts) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Returns the configuration state of the advanced encode options.
sl@0:         * @since S60 3.2
sl@0:         * @return aEncodeOpts1: The encode options
sl@0:         */
sl@0: 		IMPORT_C virtual TInt GetEncodeOptions1 (TUint& aEncodeOpts1) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Returns the configuration state of the advanced encode options.
sl@0:         * @since S60 3.2
sl@0:         * @return aEncodeOpts2: The encode options
sl@0:         */
sl@0: 		IMPORT_C virtual TInt GetEncodeOptions2 (TUint& aEncodeOpts2) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Returns the configuration state of the input channel mask.
sl@0:         * @since S60 3.2
sl@0:         * @return aChannelMask: Channel mask. 
sl@0:         */
sl@0: 		IMPORT_C virtual TInt GetChannelMaskIn (TUint& aChannelMask) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Returns a list of formats supported by the decoder.
sl@0:         * @since S60 3.2
sl@0:         * @return aSupportedFormats: An array of the formats, as defined in  TFormat
sl@0:         */
sl@0: 		IMPORT_C virtual TInt GetSupportedFormats(RArray<TFormat>& aSupportedFormats) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Returns a list of tools supported by the decoder.
sl@0:         * @since S60 3.2
sl@0:         * @return aSupportedTools: An array of the tools supported by the decoder
sl@0:         */
sl@0: 		IMPORT_C virtual TInt GetSupportedTools(RArray<TTool>& aSupportedTools) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Returns the maximum number of input channels supported by the decoder.
sl@0:         * @since S60 3.2
sl@0:         * @return aSupportedMaxChannelsIn: number of channels. 
sl@0:         */
sl@0: 		IMPORT_C virtual TInt GetSupportedMaxChannelsIn(TUint& aSupportedMaxChannelsIn) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Returns the maximum bit rate supported by the decoder.
sl@0:         * @since S60 3.2
sl@0:         * @return aSupportedMaxBitrate: maximum bitrate
sl@0:         */
sl@0: 		IMPORT_C virtual TInt GetSupportedMaxBitrate(TUint& aSupportedMaxBitrate) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Returns the maximum sample rate supported by the decoder.
sl@0:         * @since S60 3.2
sl@0:         * @return aSupportedMaxSampleRate: maximum sample rate
sl@0:         */
sl@0: 		IMPORT_C virtual TInt GetSupportedMaxSampleRate(TUint& aSupportedMaxSampleRate) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Returns a list of the tools that are controllable through this interface.
sl@0:         * @since S60 3.2
sl@0:         * @return aControllableTools: An array of the tools that are controllable through this interface. 
sl@0:         */
sl@0: 		IMPORT_C virtual TInt GetControllableTools(RArray<TTool>& aControllableTools) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Enables the tool specified.
sl@0:         * @since S60 3.2
sl@0:         * @return aTool: Specifies the tool to enable.
sl@0:         */
sl@0: 		IMPORT_C virtual void EnableTool(TTool aTool) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Disables the tool specified.
sl@0:         * @since S60 3.2
sl@0:         * @return aTool: Specifies the tool to disable. 
sl@0:         */
sl@0: 		IMPORT_C virtual void DisableTool(TTool aTool) = 0;
sl@0: 
sl@0:         /**
sl@0:         * Returns the state of the specified tool
sl@0:         * @since S60 3.2
sl@0:         * @return aTool: Specifies the tool for which the state is requested
sl@0:         * @       aEnabled : Indicates the state of the tool specified in aTool
sl@0:         */
sl@0: 		IMPORT_C virtual TInt GetTool(TTool aTool, TBool& aEnabled) = 0;
sl@0: 
sl@0: 	};
sl@0: 
sl@0: #endif      // WMADECODERINTFC_H
sl@0: 
sl@0: // End of File