|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
3 |
* All rights reserved.
|
|
sl@0
|
4 |
* This component and the accompanying materials are made available
|
|
sl@0
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
6 |
* which accompanies this distribution, and is available
|
|
sl@0
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
8 |
*
|
|
sl@0
|
9 |
* Initial Contributors:
|
|
sl@0
|
10 |
* Nokia Corporation - initial contribution.
|
|
sl@0
|
11 |
*
|
|
sl@0
|
12 |
* Contributors:
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* Description:
|
|
sl@0
|
15 |
*
|
|
sl@0
|
16 |
*/
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
|
|
sl@0
|
20 |
|
|
sl@0
|
21 |
/**
|
|
sl@0
|
22 |
@file
|
|
sl@0
|
23 |
@publishedPartner
|
|
sl@0
|
24 |
@released
|
|
sl@0
|
25 |
*/
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
#ifndef MBUFFERSOURCE_H
|
|
sl@0
|
28 |
#define MBUFFERSOURCE_H
|
|
sl@0
|
29 |
|
|
sl@0
|
30 |
#include <a3f/a3fbase.h>
|
|
sl@0
|
31 |
#include <a3f/maudiodatasupplier.h>
|
|
sl@0
|
32 |
|
|
sl@0
|
33 |
class CMMFBuffer;
|
|
sl@0
|
34 |
|
|
sl@0
|
35 |
/**
|
|
sl@0
|
36 |
* Buffer source is used for providing audio data from outside the audio process.
|
|
sl@0
|
37 |
*
|
|
sl@0
|
38 |
* The type of the actual 'physical' source can be for example a file or a socket or the
|
|
sl@0
|
39 |
* data could also be generated. Nevertheless, the client (the MAudioDataSupplier) is responsible
|
|
sl@0
|
40 |
* for reading the data and providing it to the audio process by filling the buffers received
|
|
sl@0
|
41 |
* as a parameter with the callbacks in the MAudioDataSupplier interface.
|
|
sl@0
|
42 |
*/
|
|
sl@0
|
43 |
class MMMFBufferSource
|
|
sl@0
|
44 |
{
|
|
sl@0
|
45 |
public:
|
|
sl@0
|
46 |
/**
|
|
sl@0
|
47 |
* Initializes the source for using aSupplier as a data supplier.
|
|
sl@0
|
48 |
*
|
|
sl@0
|
49 |
* The source must be initialized before it is attached to a stream.
|
|
sl@0
|
50 |
*
|
|
sl@0
|
51 |
* @param aSupplier a reference to the data supplier which will provide the audio data by
|
|
sl@0
|
52 |
* filling the buffers received with the callbacks.
|
|
sl@0
|
53 |
* @return an error code. KErrNone if successful, otherwise one of the system wide error codes.
|
|
sl@0
|
54 |
*/
|
|
sl@0
|
55 |
virtual TInt SetDataSupplier(MMMFAudioDataSupplier& aSupplier)=0;
|
|
sl@0
|
56 |
|
|
sl@0
|
57 |
/**
|
|
sl@0
|
58 |
* Indicates that a buffer received from this buffer source has
|
|
sl@0
|
59 |
* been filled with audio data.
|
|
sl@0
|
60 |
*
|
|
sl@0
|
61 |
* @param aBuffer the buffer that has been filled.
|
|
sl@0
|
62 |
* @return an error code. KErrNone if successful, otherwise one of the system wide error codes.
|
|
sl@0
|
63 |
*/
|
|
sl@0
|
64 |
virtual TInt BufferFilled(CMMFBuffer* aBuffer)=0;
|
|
sl@0
|
65 |
|
|
sl@0
|
66 |
/**
|
|
sl@0
|
67 |
* Acknowledges the call to MMMFAudioDataSupplier::DiscardBuffers().
|
|
sl@0
|
68 |
*
|
|
sl@0
|
69 |
* A DiscardBuffers() callback will be issued to MMMFAudioDataSupplier to request that any requested buffers have been discarded.
|
|
sl@0
|
70 |
* This call acknowledges that the data supplier has stopped using the buffers, and returns their control to the framework proper
|
|
sl@0
|
71 |
*
|
|
sl@0
|
72 |
* @return an error code. KErrNone on success, otherwise one of the system wide error codes.
|
|
sl@0
|
73 |
*/
|
|
sl@0
|
74 |
virtual TInt BuffersDiscarded()=0;
|
|
sl@0
|
75 |
|
|
sl@0
|
76 |
};
|
|
sl@0
|
77 |
|
|
sl@0
|
78 |
#endif // MBUFFERSOURCE_H
|