[6f8185]: libkwave / KwaveSampleSource.h Maximize Restore History

Download this file

KwaveSampleSource.h    80 lines (67 with data), 2.9 kB

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/*************************************************************************
KwaveSampleSource.h - base class with a generic sample source
-------------------
begin : Sun Oct 07 2007
copyright : (C) 2007 by Thomas Eschenbacher
email : Thomas.Eschenbacher@gmx.de
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef _KWAVE_SAMPLE_SOURCE_H_
#define _KWAVE_SAMPLE_SOURCE_H_
#include "config.h"
#include <qobject.h>
#include "libkwave/KwaveSampleArray.h"
namespace Kwave {
class SampleSource: public QObject
{
Q_OBJECT
public:
/**
* Constructor
*
* @param parent a parent object, passed to QObject (optional)
* @param name a free name, for identifying this object,
* will be passed to the QObject (optional)
*/
SampleSource(QObject *parent=0, const char *name=0);
/** Destructor */
virtual ~SampleSource();
/**
* Each KwaveSampleSource has to derive this method for producing
* sample data. It then should emit a signal like this:
* "output(SampleArray &data)"
*/
virtual void goOn() = 0;
/**
* Returns true if the end of the source has been reached,
* e.g. at EOF of an input stream. The default implementation
* always returns false, which means that the source is always
* able to produce data (useful for signal generators).
*
* @return true if it can produce more sample data, otherwise false
*/
virtual bool done() { return false; };
/**
* Returns the number of tracks that the source provides
* @return number of tracks, default is 1
*/
virtual unsigned int tracks() const { return 1; };
/**
* Returns the source that corresponds to one specific track
* if the object has multiple tracks. For single-track objects
* it returns "this" for the first index and 0 for all others
*/
virtual Kwave::SampleSource * operator [] (unsigned int track)
{
return (track == 0) ? this : 0;
};
};
}
#endif /* _KWAVE_SAMPLE_SOURCE_H_ */