|
sl@0
|
1 |
// Copyright (c) 2006-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 |
//
|
|
sl@0
|
15 |
|
|
sl@0
|
16 |
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
/**
|
|
sl@0
|
19 |
@file
|
|
sl@0
|
20 |
@publishedPartner
|
|
sl@0
|
21 |
@released
|
|
sl@0
|
22 |
*/
|
|
sl@0
|
23 |
|
|
sl@0
|
24 |
#ifndef MBUFFERSINK_H
|
|
sl@0
|
25 |
#define MBUFFERSINK_H
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
#include <a3f/a3fbase.h>
|
|
sl@0
|
28 |
#include <a3f/maudiodataconsumer.h>
|
|
sl@0
|
29 |
|
|
sl@0
|
30 |
class CMMFBuffer;
|
|
sl@0
|
31 |
class MMMFAudioDataConsumer;
|
|
sl@0
|
32 |
|
|
sl@0
|
33 |
/**
|
|
sl@0
|
34 |
* Buffer sink is used for receiving the audio data in buffers outside the audio process.
|
|
sl@0
|
35 |
*
|
|
sl@0
|
36 |
* The type of the actual 'physical' sink can be for example a file or a socket or the
|
|
sl@0
|
37 |
* data could also be simple analysed and then discarded. Nevertheless, the client
|
|
sl@0
|
38 |
* (the MAudioDataConsumer) is responsible for writing the data to its final sink
|
|
sl@0
|
39 |
* while reading it from the buffers received as a parameter with the callbacks in
|
|
sl@0
|
40 |
* the MAudioDataConsumer interface.
|
|
sl@0
|
41 |
*/
|
|
sl@0
|
42 |
class MMMFBufferSink
|
|
sl@0
|
43 |
{
|
|
sl@0
|
44 |
public:
|
|
sl@0
|
45 |
/**
|
|
sl@0
|
46 |
* Initializes the sink for using aConsumer as a data consumer.
|
|
sl@0
|
47 |
*
|
|
sl@0
|
48 |
* The sink must be initialized before it is attahced to a stream.
|
|
sl@0
|
49 |
*
|
|
sl@0
|
50 |
* @param aConsumer a reference to the data consumer which will be responsible
|
|
sl@0
|
51 |
* for reading the audio data from the buffers provided by this sink.
|
|
sl@0
|
52 |
* @return an error code. KErrNone if successful, otherwise one of the system wide error codes.
|
|
sl@0
|
53 |
*/
|
|
sl@0
|
54 |
virtual TInt SetDataConsumer(MMMFAudioDataConsumer& aConsumer)=0;
|
|
sl@0
|
55 |
|
|
sl@0
|
56 |
/**
|
|
sl@0
|
57 |
* Indicates that the audio data has been read from a buffer received from this buffer sink.
|
|
sl@0
|
58 |
*
|
|
sl@0
|
59 |
* @param aBuffer the buffer that has been consumed.
|
|
sl@0
|
60 |
* @return an error code. KErrNone if successful, otherwise one of the system wide error codes.
|
|
sl@0
|
61 |
*/
|
|
sl@0
|
62 |
virtual TInt BufferEmptied(CMMFBuffer* aBuffer)=0;
|
|
sl@0
|
63 |
|
|
sl@0
|
64 |
/**
|
|
sl@0
|
65 |
* Called by the client to acknowledgement the processing of DiscardBuffers() to indicate that
|
|
sl@0
|
66 |
* control of any buffer previously passed to the client.
|
|
sl@0
|
67 |
* (by BufferToBeEmptied()) returns to the framework proper.
|
|
sl@0
|
68 |
*
|
|
sl@0
|
69 |
* @return an error code. KErrNone on success, otherwise one of the system wide error codes.
|
|
sl@0
|
70 |
*/
|
|
sl@0
|
71 |
virtual TInt BuffersDiscarded()=0;
|
|
sl@0
|
72 |
};
|
|
sl@0
|
73 |
|
|
sl@0
|
74 |
#endif // MBUFFERSINK_H
|