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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
/*************************************************************************
RecordDevice.h - base class for audio recording devices
-------------------
begin : Wed Sep 17 2003
copyright : (C) 2003 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 RECORD_DEVICE_H
#define RECORD_DEVICE_H
#include "config.h"
#include <errno.h>
#include <QByteArray>
#include <QList>
#include <QString>
#include <QStringList>
#include "libkwave/ByteOrder.h"
#include "libkwave/Compression.h"
#include "libkwave/SampleFormat.h"
#include "libkwave/String.h"
namespace Kwave
{
class RecordDevice
{
public:
/** Constructor */
RecordDevice() {}
/** Destructor */
virtual ~RecordDevice() {}
/**
* Open the record device.
* @param dev path of the record device
* @retval QString() if successful
* @retval QString::number(ENODEV) if device not found
* @retval QString::number(EBUSY) if device is busy
* @retval QString::number(EINVAL) on invalid parameters
* @retval QString(...) device specific error message
* (already translated)
*/
virtual QString open(const QString &dev) = 0;
/**
* Read the raw audio data from the record device.
* @param buffer array of bytes to receive the audio data
* might be resized for alignment
* @param offset offset in bytes within the buffer
* @return number of bytes read, zero or negative if failed
*/
virtual int read(QByteArray &buffer, unsigned int offset) = 0;
/** Close the device */
virtual int close() = 0;
/** return a string list with supported device names */
virtual QStringList supportedDevices() = 0;
/** return a string suitable for a "File Open..." dialog */
virtual QString fileFilter() { return _(""); }
/**
* Detect the minimum and maximum number of tracks.
* If the detection fails, minimum and maximum are set to zero.
* @param min receives the lowest supported number of tracks
* @param max receives the highest supported number of tracks
* @return zero or positive number if ok,
* negative error number if failed
*/
virtual int detectTracks(unsigned int &min, unsigned int &max) = 0;
/**
* Try to set a new number of tracks.
* @note the device must be open
* @param tracks the number of tracks to be set, can be modified and
* decreased to the next supported number of tracks if the
* underlying driver supports that.
* @return zero on success, negative error code if failed
*/
virtual int setTracks(unsigned int &tracks) = 0;
/** Returns the current number of tracks */
virtual int tracks() = 0;
/** get a list of supported sample rates */
virtual QList<double> detectSampleRates() = 0;
/**
* Try to set a new sample rate.
* @param new_rate the sample rate to be set [samples/second], can
* be modified and rounded up/down to the nearest supported
* sample rate if the underlying driver supports that.
* @return zero on success, negative error code if failed
*/
virtual int setSampleRate(double &new_rate) = 0;
/** Returns the current sample rate of the device */
virtual double sampleRate() = 0;
/**
* Gets a list of supported compression types. If no compression is
* supported, the list might be empty.
*/
virtual QList<Kwave::Compression::Type> detectCompressions() = 0;
/**
* Try to set a new compression type.
* @param new_comp the identifier of the new compression
* @return zero on success, negative error code if failed
* @see class Kwave::Compression
*/
virtual int setCompression(Kwave::Compression::Type new_comp) = 0;
/** Returns the current compression type (0==none) */
virtual Kwave::Compression::Type compression() = 0;
/**
* Detect a list of supported bits per sample.
* @note this depends on the compression type
* @return a list of bits per sample, empty if failed
*/
virtual QList<unsigned int> supportedBits() = 0;
/**
* Set the resolution in bits per sample
* @param new_bits resolution [bits/sample]
*/
virtual int setBitsPerSample(unsigned int new_bits) = 0;
/**
* Returns the current resolution in bits per sample or a negative
* error code if failed
*/
virtual int bitsPerSample() = 0;
/**
* Gets a list of supported sample formats.
* @note this depends on the current setting of the compression!
*/
virtual QList<Kwave::SampleFormat::Format> detectSampleFormats() = 0;
/**
* Try to set a new sample format (signed/unsigned)
* @param new_format the identifier for the new format
* @return zero on success, negative error code if failed
* @see class SampleFormat
*/
virtual int setSampleFormat(Kwave::SampleFormat::Format new_format) = 0;
/** Returns the current sample format (signed/unsigned) */
virtual Kwave::SampleFormat::Format sampleFormat() = 0;
/** Returns the current endianness (big/little) */
virtual Kwave::byte_order_t endianness() = 0;
};
}
#endif /* RECORD_DEVICE_H */
//***************************************************************************
//***************************************************************************
|
