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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
/*************************************************************************
StreamObject.h - base class with a generic sample source/sink
-------------------
begin : Thu Nov 01 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 STREAM_OBJECT_H
#define STREAM_OBJECT_H
#include "config.h"
#include "libkwave_export.h"
#include <QtGlobal>
#include <QObject>
#include <QRecursiveMutex>
class QVariant;
namespace Kwave
{
class LIBKWAVE_EXPORT StreamObject: public QObject
{
Q_OBJECT
public:
/**
* Constructor
*
* @param parent a parent object, passed to QObject (optional)
*/
explicit StreamObject(QObject *parent = nullptr);
/** Destructor */
~StreamObject() override;
/**
* Returns the default 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
* @param track index of the track
* @return a stream object or NULL
*/
virtual Kwave::StreamObject * operator [] (unsigned int track)
{
return (track == 0) ? this : nullptr;
}
/**
* Returns the number of tracks of a input or output port.
* Can be overwritten for objects that have a different count
* of inputs and outputs.
* @param port name of the port (name of signal or slot)
* @return number of tracks of a input or output, default is
* the same as tracks()
*/
virtual unsigned int tracksOfPort(const char *port) const
{
Q_UNUSED(port)
return tracks();
}
/**
* Returns an indexed port, identified by name
* @param port name of the port (name of signal or slot)
* @param track index of the track
* @return the corresponding stream object
*/
virtual Kwave::StreamObject *port(const char *port, unsigned int track)
{
Q_UNUSED(port)
return (*this)[track];
}
/**
* Returns the block size used for producing data.
* @return currently 32k [samples]
*/
virtual unsigned int blockSize() const;
/**
* Sets an attribute of a Kwave::StreamObject.
* @param attribute name of the attribute, with the signature of
* a Qt SLOT(\<name\>(QVariant value))
* @param value the new value of the attribute, stored in a QVariant
*/
void setAttribute(const char *attribute,
const QVariant &value);
/**
* Switch interactive mode on or off. In interactive mode we
* use a smaller block size for creating objects to get better
* response time to parameter changes. In non-interactive mode
* the block size is higher for better performance.
*/
static void setInteractive(bool interactive);
/** returns true if the transfer has been canceled */
virtual bool isCanceled() const { return m_canceled; }
public slots:
/**
* Can be connected to other stream objects to cancel the current
* transfer.
*/
void cancel();
signals:
/**
* Emitted by setAttribute and connected to the corresponding
* slot.
*/
void attributeChanged(const QVariant value);
/**
* emitted when cancel() is called, can be connected
* to the cancel() slot of child objects
*/
void sigCancel();
private:
/** Mutex for locking access to setAttribute (recursive) */
QRecursiveMutex m_lock_set_attribute;
/** interactive mode: if enabled, use smaller block size */
static bool m_interactive;
/**
* Initialized as false, will be true if the transfer has
* been canceled
*/
bool m_canceled;
};
}
#endif /* STREAM_OBJECT_H */
//***************************************************************************
//***************************************************************************
|
