sl@0: // Copyright (c) 2003-2009 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:
sl@0: // mmfswaudioinput.h
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef SWAUDIOINPUT_H
sl@0: #define SWAUDIOINPUT_H
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include <d32soundsc.h>
sl@0: 
sl@0: 
sl@0: //TAudioInputParams 
sl@0: //- give sample rate and buffer size
sl@0: class TAudioInputParams
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C TAudioInputParams();
sl@0: 	
sl@0: 	TInt iSampleRate;
sl@0: 		// The sample rate of the data past to the client. Ideally, but not
sl@0: 		// necessarily that used on the device
sl@0: 	TInt iNumChannels;
sl@0: 		// Number of channels to use. 1 = mono. 2 = (interleaved) stereo.
sl@0: 	TInt iNominalBufferSize;
sl@0: 		// "Full buffers" are to be of this size. (Only the penultimate can be shorter)
sl@0: 	TInt iInitialGain;
sl@0: 		// Gain to use on start.
sl@0: 	};
sl@0: 
sl@0: // Observer class for MAudioInput
sl@0: class MAudioInputObserver
sl@0: 	{
sl@0: public:
sl@0: 	virtual void InputBufferAvailable(const TDesC8& aBuffer)=0;
sl@0: 		// A buffer of data is available. Assume single buffering
sl@0: 		
sl@0: 	virtual void InputFinished()=0;
sl@0: 		// called following Pause() to say no more data left
sl@0: 		
sl@0: 	virtual void InputError(TInt aError)=0;
sl@0: 		// called on fatal(ish) error. Client should call Stop() and/or Close()
sl@0: 	};
sl@0: 	
sl@0: // Interface to SwWrapper AudioInput
sl@0: class MAudioInput
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C static MAudioInput* CreateL(MAudioInputObserver& aObserver);
sl@0: 		// Create new object
sl@0: 		
sl@0: 	virtual void Release()=0;
sl@0: 		// destructor call
sl@0: 		
sl@0: 	virtual TInt Initialize(const TAudioInputParams& aParams)=0;
sl@0: 		// Initialize with given properties. synchronous call.
sl@0: 		
sl@0: 	virtual void Close()=0;
sl@0: 		// undo of Initialize() - return to created state. Implied Stop() if required.
sl@0: 		
sl@0: 	virtual TInt Start()=0;
sl@0: 		// Start to record and supply buffers. Only valid if initialized
sl@0: 		// subsequently BufferToEmpty() will be called
sl@0: 		
sl@0: 	virtual void BufferAck()=0;
sl@0: 		// The buffer supplied by InputBufferAvailable has been read.
sl@0: 		// Client must have stopped reading from the buffer
sl@0: 		
sl@0: 	virtual TInt Pause()=0;
sl@0: 		// pause (temporarily stop) recording. When all buffers have been passed
sl@0: 		// InputFinished() is called.
sl@0: 		
sl@0: 	virtual TInt Resume()=0;
sl@0: 		// resume from paused mode. If InputFinished() has not been sent
sl@0: 		// already it won't be
sl@0: 		
sl@0: 	virtual TInt Flush()=0;
sl@0: 		// throw away any partially recorded buffers than have not been
sl@0: 		// received. Implied BufferAck(). Only legal when paused
sl@0: 		
sl@0: 	virtual void Stop()=0;
sl@0: 		// immediate stop, but does not close. Akin to Cancel() if we are running.
sl@0: 		
sl@0: 	virtual TAny* Interface(TUid aInterfaceUid)=0;
sl@0: 		// for standard extension pattern
sl@0: 	};
sl@0: 
sl@0: // Parameter access. Do as CI since API not so clear
sl@0: const TUid KUidAIParamInterface = {0x10287080};
sl@0: class MAIParamInterface
sl@0: 	{
sl@0: public:
sl@0: 	virtual TInt SetGain(TInt aGain)=0;
sl@0: 		// set basic gain
sl@0: 		
sl@0: 	virtual TInt GetBufferSizes(TInt& aMinSize, TInt& aMaxSize)=0;
sl@0: 		// min and max buffer size supported (or at least recommended)	
sl@0: 	
sl@0: 	virtual TInt GetSupportedSampleRates(RArray<TInt>& aSupportedSampleRates)=0;
sl@0: 	};
sl@0: 
sl@0: #endif // SWAUDIOINPUT_H
sl@0: