MercurialSymaptic / file revision
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | raw | help
os/mm/mm_plat/wma_decoder_interface_api/inc/WmaDecoderIntfc.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib. 
     1 /*

     2 * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). 

     3 * All rights reserved.

     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".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Project specification for WMA 10 Pro decoder 

    15 *              : Custom Interface.

    16 *

    17 */

    18 

    19 

    20 #ifndef WMADECODERINTFC_H

    21 #define WMADECODERINTFC_H

    22 

    23 // INCLUDES

    24 #include <e32base.h>

    25 

    26 // CONSTANTS

    27 const TUid KUidWmaDecoderIntfc = {0x10207BAD};

    28 

    29 // MACROS

    30 

    31 // DATA TYPES

    32 

    33 // FUNCTION PROTOTYPES

    34 

    35 // FORWARD DECLARATIONS

    36 class CMMFDevSound;

    37 class CMdaAudioInputStream;

    38 class CMdaAudioOutputStream;

    39 

    40 // CLASS DECLARATION

    41 

    42 /**

    43 *  Interface for sending configuration info to WMA 10 Pro decoder.

    44 *  This abstract class just provides the static NewL function for the 

    45 *  creation of the proxy. Also, it defines the APIs to be implemented 

    46 *  by the proxy and the real custom interface implementation.

    47 *

    48 *  @lib WmaDecoderIntfc.lib

    49 *  @since S60 3.2

    50 */

    51 class CWmaDecoderIntfc : public CBase

    52     {

    53     public: //data types

    54 

    55     enum TFormat

    56         {

    57         EWmaVoice = 10,

    58         EWmaV1 = 352,

    59         EWma = 353, 

    60         EWmaV2 = 353, 

    61         EWmaPro  = 354,

    62         EWmaLossless = 355,

    63         };

    64 

    65     enum TTool

    66         {

    67  		EToolOutput32Bit	= 1, //default = disabled

    68 		EDownMixToStereo	= 2, //default = disabled

    69 		ELostDataConcealment= 3  // default = disabled

    70 		};

    71 

    72     public:  // Constructors and destructor

    73 

    74         /**

    75         * Creates the interface.

    76         */

    77 		IMPORT_C static CWmaDecoderIntfc* 

    78 		                NewL(CMMFDevSound& aDevSound);

    79 

    80         /**

    81         * Creates the interface 

    82         * This function will always leave with KErrNotSuppored

    83         */

    84 		IMPORT_C static CWmaDecoderIntfc* 

    85 		                NewL(CMdaAudioInputStream& aUtility);

    86 

    87         /**

    88         * Creates the interface.

    89         */

    90 		IMPORT_C static CWmaDecoderIntfc* 

    91 		                NewL(CMdaAudioOutputStream& aUtility);

    92 

    93     public: // New functions

    94 

    95         /**

    96         * Configures the compressed audio format

    97         * @since S60 3.2

    98         * @param aFormat - the audio format.

    99         * @return void

   100         */

   101 		IMPORT_C virtual void SetFormat(TFormat aFormat) = 0;

   102 

   103         /**

   104         * Configures the number of bits per sample 

   105         * @since S60 3.2

   106         * @param aBitsPerSample - bits per sample.

   107         * @return void

   108         */

   109 		IMPORT_C virtual void SetBitsPerSampleIn(TUint aBitsPerSample) = 0;

   110 

   111         /**

   112         * Configures the number of audio channels  

   113         * @since S60 3.2

   114         * @param aNumOfChannels: The number of audio channels.

   115         * @return void

   116         */

   117 		IMPORT_C virtual void SetNumChannelsIn (TUint aNumChannelsIn) = 0;

   118 

   119         /**

   120         * Configures the sampling rate   

   121         * @since S60 3.2

   122         * @param aSamplesPerSec: Sample rate value in Hertz.

   123         * @return void

   124         */

   125 		IMPORT_C virtual void SetSamplesPerSec (TUint aSamplesPerSec) = 0;

   126 

   127         /**

   128         * Configures the average number of bytes per second   

   129         * @since S60 3.2

   130         * @param aAvgBytesPerSec: Average bytes per second.

   131         * @return void

   132         */

   133 		IMPORT_C virtual void SetAvgBytesPerSec (TUint aAvgBytesPerSec) = 0;

   134 

   135         /**

   136         * Configures the block align size in bytes    

   137         * @since S60 3.2

   138         * @param aBlockAlign: Block size in bytes

   139         * @return void

   140         */

   141 		IMPORT_C virtual void SetBlockAlign (TUint aBlockAlign) = 0;

   142 

   143         /**

   144         * Configures information specific to the WMA decoder

   145         * @since S60 3.2

   146         * @param aEncodeOptions: The encode options

   147         * @return void

   148         */

   149 		IMPORT_C virtual void SetEncodeOptions (TUint aEncodeOptions) = 0;

   150 

   151         /**

   152         * Configures information specific to the WMA 10 Pro decoder

   153         * @since S60 3.2

   154         * @param aEncodeOpts1: The encode options 1

   155         * @return void

   156         */

   157 		IMPORT_C virtual void SetEncodeOptions1 (TUint aEncodeOpts1) = 0;

   158 

   159         /**

   160         * Configures information specific to the WMA 10 Pro decoder

   161         * @since S60 3.2

   162         * @param aEncodeOpts2: The encode options 2

   163         * @return void

   164         */

   165 		IMPORT_C virtual void SetEncodeOptions2 (TUint aEncodeOpts2) = 0;

   166 

   167         /**

   168         * Configures the decoder for the channel data arrangement 

   169         * @since S60 3.2

   170         * @param aChannelMask: Channel mask

   171         * @return void

   172         */

   173 		IMPORT_C virtual void SetChannelMaskIn (TUint aChannelMask) = 0;

   174 

   175         /**

   176         * Commits configuration settings to the decoder.

   177         * @since S60 3.2

   178         * @return TInt - Status

   179         */

   180 		IMPORT_C virtual TInt ApplyConfig() = 0;

   181 

   182         /**

   183         * Returns the configuration state of audio format.

   184         * @since S60 3.2

   185         * @return aFormat: The audio format

   186         */

   187 		IMPORT_C virtual TInt GetFormat (TFormat& aFormat) = 0;

   188 

   189         /**

   190         * Returns the configuration state of number of bits per sample.

   191         * @since S60 3.2

   192         * @return aBitsPerSample: Number of bits per sample

   193         */

   194 		IMPORT_C virtual TInt GetBitsPerSampleIn(TUint& aBitsPerSample) = 0;

   195 

   196         /**

   197         * Returns the configuration state of the number of channels.

   198         * @since S60 3.2

   199         * @return aNumOfChannels: Number of channels

   200         */

   201 		IMPORT_C virtual TInt GetNumOfChannelsIn (TUint& aNumOfChannels) = 0;

   202 

   203         /**

   204         * Returns the configuration state of the sample rate.

   205         * @since S60 3.2

   206         * @return aSamplesPerSec: Sample rate value in Hertz

   207         */

   208 		IMPORT_C virtual TInt GetSamplesPerSec (TUint& aSamplesPerSec) = 0;

   209 

   210         /**

   211         * Returns the configuration state of average bytes per second.

   212         * @since S60 3.2

   213         * @return aAvgBytesPerSec: Average bytes per second

   214         */

   215 		IMPORT_C virtual TInt GetAvgBytesPerSec (TUint& aAvgBytesPerSec) = 0;

   216 

   217         /**

   218         * Returns the configuration state of block alignment. 

   219         * @since S60 3.2

   220         * @return aBlockAlign: Block size in bytes

   221         */

   222 		IMPORT_C virtual TInt GetBlockAlign (TUint& aBlockAlign) = 0;

   223 

   224         /**

   225         * Returns the configuration state of the encode options.

   226         * @since S60 3.2

   227         * @return aEncodeOpts: The encode options.

   228         */

   229 		IMPORT_C virtual TInt GetEncodeOptions (TUint& aEncodeOpts) = 0;

   230 

   231         /**

   232         * Returns the configuration state of the advanced encode options.

   233         * @since S60 3.2

   234         * @return aEncodeOpts1: The encode options

   235         */

   236 		IMPORT_C virtual TInt GetEncodeOptions1 (TUint& aEncodeOpts1) = 0;

   237 

   238         /**

   239         * Returns the configuration state of the advanced encode options.

   240         * @since S60 3.2

   241         * @return aEncodeOpts2: The encode options

   242         */

   243 		IMPORT_C virtual TInt GetEncodeOptions2 (TUint& aEncodeOpts2) = 0;

   244 

   245         /**

   246         * Returns the configuration state of the input channel mask.

   247         * @since S60 3.2

   248         * @return aChannelMask: Channel mask. 

   249         */

   250 		IMPORT_C virtual TInt GetChannelMaskIn (TUint& aChannelMask) = 0;

   251 

   252         /**

   253         * Returns a list of formats supported by the decoder.

   254         * @since S60 3.2

   255         * @return aSupportedFormats: An array of the formats, as defined in  TFormat

   256         */

   257 		IMPORT_C virtual TInt GetSupportedFormats(RArray<TFormat>& aSupportedFormats) = 0;

   258 

   259         /**

   260         * Returns a list of tools supported by the decoder.

   261         * @since S60 3.2

   262         * @return aSupportedTools: An array of the tools supported by the decoder

   263         */

   264 		IMPORT_C virtual TInt GetSupportedTools(RArray<TTool>& aSupportedTools) = 0;

   265 

   266         /**

   267         * Returns the maximum number of input channels supported by the decoder.

   268         * @since S60 3.2

   269         * @return aSupportedMaxChannelsIn: number of channels. 

   270         */

   271 		IMPORT_C virtual TInt GetSupportedMaxChannelsIn(TUint& aSupportedMaxChannelsIn) = 0;

   272 

   273         /**

   274         * Returns the maximum bit rate supported by the decoder.

   275         * @since S60 3.2

   276         * @return aSupportedMaxBitrate: maximum bitrate

   277         */

   278 		IMPORT_C virtual TInt GetSupportedMaxBitrate(TUint& aSupportedMaxBitrate) = 0;

   279 

   280         /**

   281         * Returns the maximum sample rate supported by the decoder.

   282         * @since S60 3.2

   283         * @return aSupportedMaxSampleRate: maximum sample rate

   284         */

   285 		IMPORT_C virtual TInt GetSupportedMaxSampleRate(TUint& aSupportedMaxSampleRate) = 0;

   286 

   287         /**

   288         * Returns a list of the tools that are controllable through this interface.

   289         * @since S60 3.2

   290         * @return aControllableTools: An array of the tools that are controllable through this interface. 

   291         */

   292 		IMPORT_C virtual TInt GetControllableTools(RArray<TTool>& aControllableTools) = 0;

   293 

   294         /**

   295         * Enables the tool specified.

   296         * @since S60 3.2

   297         * @return aTool: Specifies the tool to enable.

   298         */

   299 		IMPORT_C virtual void EnableTool(TTool aTool) = 0;

   300 

   301         /**

   302         * Disables the tool specified.

   303         * @since S60 3.2

   304         * @return aTool: Specifies the tool to disable. 

   305         */

   306 		IMPORT_C virtual void DisableTool(TTool aTool) = 0;

   307 

   308         /**

   309         * Returns the state of the specified tool

   310         * @since S60 3.2

   311         * @return aTool: Specifies the tool for which the state is requested

   312         * @       aEnabled : Indicates the state of the tool specified in aTool

   313         */

   314 		IMPORT_C virtual TInt GetTool(TTool aTool, TBool& aEnabled) = 0;

   315 

   316 	};

   317 

   318 #endif      // WMADECODERINTFC_H

   319 

   320 // End of File
Symaptic