os/mm/mmlibs/mmfw/inc/mmf/common/mmfhelper.h
author sl@SLION-WIN7.fritz.box
Fri, 15 Jun 2012 03:10:57 +0200 (2012-06-15)
changeset 0 bde4ae8d615e
permissions -rw-r--r--
First public contribution.
sl@0
     1
// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     2
// All rights reserved.
sl@0
     3
// This component and the accompanying materials are made available
sl@0
     4
// under the terms of "Eclipse Public License v1.0"
sl@0
     5
// which accompanies this distribution, and is available
sl@0
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     7
//
sl@0
     8
// Initial Contributors:
sl@0
     9
// Nokia Corporation - initial contribution.
sl@0
    10
//
sl@0
    11
// Contributors:
sl@0
    12
//
sl@0
    13
// Description:
sl@0
    14
// include\mmf\common\mmfutilities.h
sl@0
    15
// 
sl@0
    16
//
sl@0
    17
sl@0
    18
#ifndef __MMF_COMMON_HELPER_H__
sl@0
    19
#define __MMF_COMMON_HELPER_H__
sl@0
    20
sl@0
    21
#include <e32base.h>
sl@0
    22
#include <mmf/server/mmfdatabuffer.h>
sl@0
    23
#include <mmf/common/mmffourcc.h>
sl@0
    24
sl@0
    25
sl@0
    26
/**
sl@0
    27
@internalAll
sl@0
    28
sl@0
    29
Base utility class to change the sample rate of audio data in a buffer
sl@0
    30
*/
sl@0
    31
class CMMFChannelAndSampleRateConverter : public CBase
sl@0
    32
	{
sl@0
    33
public:
sl@0
    34
	/**
sl@0
    35
	Reads the audio data from the source buffer,
sl@0
    36
	converts the number of channels and the sample rate
sl@0
    37
	and copies the result to the destination buffer
sl@0
    38
sl@0
    39
	@param  aSrcBuffer
sl@0
    40
	        A pointer to a source buffer containing the audio data to convert.
sl@0
    41
	@param  aDstBuffer
sl@0
    42
	        A pointer to a destination buffer.
sl@0
    43
sl@0
    44
	@return The length of the destination buffer.
sl@0
    45
	*/
sl@0
    46
	virtual TInt Convert(const CMMFDataBuffer& aSrcBuffer, CMMFDataBuffer& aDstBuffer) =0;
sl@0
    47
	virtual void Reset() {};
sl@0
    48
sl@0
    49
	/*
sl@0
    50
	Indicates what buffer size is required to hold the converted data.
sl@0
    51
	*/
sl@0
    52
	virtual TUint MaxConvertBufferSize(TUint aSrcBufferSize) {return aSrcBufferSize;}
sl@0
    53
sl@0
    54
	void SetRates(TInt aSrcRate,TInt aSrcChannels,TInt aDstRate,TInt aDstChannels);
sl@0
    55
public:
sl@0
    56
	/*
sl@0
    57
	The sample rate of the data in the source buffer
sl@0
    58
	*/
sl@0
    59
	TInt iFromRate;
sl@0
    60
	/*
sl@0
    61
	The sample rate of the data in the destination buffer
sl@0
    62
	*/
sl@0
    63
	TInt iToRate;
sl@0
    64
	/*
sl@0
    65
	The number of channels of data in the source buffer
sl@0
    66
	*/
sl@0
    67
	TInt iFromChannels;
sl@0
    68
	/*
sl@0
    69
	The number of channels of data in the destination buffer
sl@0
    70
	*/
sl@0
    71
	TInt iToChannels;
sl@0
    72
protected:
sl@0
    73
	TReal iRatio;
sl@0
    74
	TInt iFraction;
sl@0
    75
	TInt iIndex;
sl@0
    76
	};
sl@0
    77
sl@0
    78
/**
sl@0
    79
@internalAll
sl@0
    80
*/
sl@0
    81
class CMMFStereoToMonoRateConverter : public CMMFChannelAndSampleRateConverter
sl@0
    82
	{
sl@0
    83
	public:
sl@0
    84
		virtual TInt Convert(const CMMFDataBuffer& aSrcBuffer, CMMFDataBuffer& aDstBuffer);
sl@0
    85
		virtual TUint MaxConvertBufferSize(TUint aSrcBufferSize);
sl@0
    86
sl@0
    87
	};
sl@0
    88
sl@0
    89
/**
sl@0
    90
@internalAll
sl@0
    91
*/
sl@0
    92
class CMMFStereoToMonoConverter : public CMMFChannelAndSampleRateConverter
sl@0
    93
	{
sl@0
    94
	public:
sl@0
    95
		virtual TInt Convert(const CMMFDataBuffer& aSrcBuffer, CMMFDataBuffer& aDstBuffer);
sl@0
    96
		virtual TUint MaxConvertBufferSize(TUint aSrcBufferSize);
sl@0
    97
	};
sl@0
    98
sl@0
    99
/**
sl@0
   100
@internalAll
sl@0
   101
*/
sl@0
   102
class CMMFStereoToStereoRateConverter : public CMMFChannelAndSampleRateConverter
sl@0
   103
	{
sl@0
   104
	public:
sl@0
   105
		virtual TInt Convert(const CMMFDataBuffer& aSrcBuffer, CMMFDataBuffer& aDstBuffer);
sl@0
   106
	};
sl@0
   107
sl@0
   108
/**
sl@0
   109
@internalAll
sl@0
   110
*/
sl@0
   111
class CMMFMonoToMonoRateConverter : public CMMFChannelAndSampleRateConverter
sl@0
   112
	{
sl@0
   113
	public:
sl@0
   114
		virtual TInt Convert(const CMMFDataBuffer& aSrcBuffer, CMMFDataBuffer& aDstBuffer);
sl@0
   115
	};
sl@0
   116
sl@0
   117
/**
sl@0
   118
@internalAll
sl@0
   119
*/
sl@0
   120
class CMMFMonoToStereoConverter : public CMMFChannelAndSampleRateConverter
sl@0
   121
	{
sl@0
   122
	public:
sl@0
   123
		virtual TInt Convert(const CMMFDataBuffer& aSrcBuffer, CMMFDataBuffer& aDstBuffer);
sl@0
   124
		virtual TUint MaxConvertBufferSize(TUint aSrcBufferSize);
sl@0
   125
	};
sl@0
   126
sl@0
   127
/**
sl@0
   128
@internalAll
sl@0
   129
*/
sl@0
   130
class CMMFMonoToStereoRateConverter : public CMMFChannelAndSampleRateConverter
sl@0
   131
	{
sl@0
   132
	public:
sl@0
   133
		virtual TInt Convert(const CMMFDataBuffer& aSrcBuffer, CMMFDataBuffer& aDstBuffer);
sl@0
   134
		virtual TUint MaxConvertBufferSize(TUint aSrcBufferSize);
sl@0
   135
	};
sl@0
   136
sl@0
   137
/**
sl@0
   138
@internalAll
sl@0
   139
sl@0
   140
Factory class to create the appropriate CMMFChannelAndSampleRateConverter-derived
sl@0
   141
class depending on the supplied number of channels and bit rate
sl@0
   142
*/
sl@0
   143
class CMMFChannelAndSampleRateConverterFactory : public CBase
sl@0
   144
	{
sl@0
   145
sl@0
   146
public:
sl@0
   147
	IMPORT_C CMMFChannelAndSampleRateConverter* CreateConverterL(TInt aFromRate,TInt aFromChannels,
sl@0
   148
												 TInt aToRate,TInt aToChannels);
sl@0
   149
	IMPORT_C CMMFChannelAndSampleRateConverter* CreateConverterL();
sl@0
   150
	CMMFChannelAndSampleRateConverter* Converter() {return iConverter;}
sl@0
   151
	IMPORT_C ~CMMFChannelAndSampleRateConverterFactory();
sl@0
   152
	TInt Rate() {return iToRate;}
sl@0
   153
	TInt Channels() {return iToChannels;}
sl@0
   154
public:
sl@0
   155
	/**
sl@0
   156
	The sample rate of the data in the source buffer
sl@0
   157
	*/
sl@0
   158
	TInt iFromRate;
sl@0
   159
	/**
sl@0
   160
	The sample rate of the data in the destination buffer
sl@0
   161
	*/
sl@0
   162
	TInt iToRate;
sl@0
   163
	/**
sl@0
   164
	The number of channels of data in the source buffer
sl@0
   165
	*/
sl@0
   166
	TInt iFromChannels;
sl@0
   167
	/**
sl@0
   168
	The number of channels of data in the destination buffer
sl@0
   169
	*/
sl@0
   170
	TInt iToChannels;
sl@0
   171
private:
sl@0
   172
	CMMFChannelAndSampleRateConverter* iConverter;
sl@0
   173
	};
sl@0
   174
sl@0
   175
#endif //__MMF_COMMON_HELPER_H__
sl@0
   176