os/mm/mmlibs/mmfw/inc/mmf/utils/rateconvert.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
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\utils\rateconvert.h
sl@0
    15
// 
sl@0
    16
//
sl@0
    17
sl@0
    18
#ifndef RATECONVERT_H
sl@0
    19
#define RATECONVERT_H
sl@0
    20
sl@0
    21
/**
sl@0
    22
@internalTechnology
sl@0
    23
@file
sl@0
    24
*/
sl@0
    25
sl@0
    26
#include <e32base.h>
sl@0
    27
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 CChannelAndSampleRateConverter : public CBase
sl@0
    32
	{
sl@0
    33
protected:
sl@0
    34
	CChannelAndSampleRateConverter();
sl@0
    35
	
sl@0
    36
public:
sl@0
    37
	/*
sl@0
    38
	Create a converter that will do rate and channel conversion as requested
sl@0
    39
	*/
sl@0
    40
	IMPORT_C static CChannelAndSampleRateConverter* CreateL(TInt aFromRate,TInt aFromChannels,
sl@0
    41
												 TInt aToRate,TInt aToChannels);
sl@0
    42
	/**
sl@0
    43
	Reads the audio data from the source buffer,
sl@0
    44
	converts the number of channels and the sample rate
sl@0
    45
	and copies the result to the destination buffer
sl@0
    46
sl@0
    47
	@param  aSrcBuffer
sl@0
    48
	        The source buffer containing the audio data to convert.
sl@0
    49
	@param  aDstBuffer
sl@0
    50
	        The destination buffer - assumed big enough
sl@0
    51
sl@0
    52
	@return The length of the source buffer that was consumed.
sl@0
    53
	*/
sl@0
    54
	virtual TInt Convert(const TDesC8& aSrcBuffer, TDes8& aDstBuffer)=0;
sl@0
    55
	virtual void Reset()=0;
sl@0
    56
sl@0
    57
	/*
sl@0
    58
	Indicates what buffer size is required to hold the converted data.
sl@0
    59
	Support size of original buffer. 
sl@0
    60
	aRoundUpToPower means give next power of 2 size up from raw size.
sl@0
    61
	NB. May be bigger than strictly necessary.
sl@0
    62
	*/
sl@0
    63
	virtual TInt MaxConvertBufferSize(TInt aSrcBufferSize, TBool aRoundUpToPower=EFalse)=0;
sl@0
    64
	};
sl@0
    65
sl@0
    66
sl@0
    67
#endif
sl@0
    68