File: instrument.cpp

package info (click to toggle)
tiatracker 1.3-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,664 kB
  • sloc: cpp: 8,875; asm: 664; makefile: 8
file content (359 lines) | stat: -rw-r--r-- 10,508 bytes parent folder | download | duplicates (2)
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
/* TIATracker, (c) 2016 Andre "Kylearan" Wichmann.
 * Website: https://bitbucket.org/kylearan/tiatracker
 * Email: andre.wichmann@gmx.de
 * See the file "license.txt" for information on usage and redistribution
 * of this file.
 */

#include "instrument.h"

#include <QMutex>

#include <stdexcept>
#include <iostream>
#include <QJsonArray>
#include <QJsonObject>
#include "mainwindow.h"
#include "instrumentstab.h"


namespace Track {

/* TODO: More sensible empty detection, like a bool flag that gets
 * changed whenever the instrument data gets updated by the GUI...
 */
bool Instrument::isEmpty() {
    bool empty = true;
    if (name != "---"
            || envelopeLength > 2
            || frequencies.size() > 2
            || volumes[0] != 0 || volumes[1] != 0
            || frequencies[0] != 0 || frequencies[1] != 0
            || sustainStart != 0 || releaseStart != 1
            || baseDistortion != TiaSound::Distortion::PURE_COMBINED
            ) {
        empty = false;
    }

    return empty;
}

/*************************************************************************/

void Instrument::toJson(QJsonObject &json) {
    json["version"] = MainWindow::version;
    json["name"] = name;
    json["waveform"] = static_cast<int>(baseDistortion);
    json["envelopeLength"] = envelopeLength;
    json["sustainStart"] = sustainStart;
    json["releaseStart"] = releaseStart;

    QJsonArray freqArray;
    for (int iFreq = 0; iFreq < envelopeLength; ++iFreq) {
        freqArray.append(QJsonValue(frequencies[iFreq]));
    }
    json["frequencies"] = freqArray;

    QJsonArray volArray;
    for (int iVol = 0; iVol < envelopeLength; ++iVol) {
        volArray.append(QJsonValue(volumes[iVol]));
    }
    json["volumes"] = volArray;
}

/*************************************************************************/

bool Instrument::import(const QJsonObject &json) {
    int version = json["version"].toInt();
    if (version > MainWindow::version) {
        MainWindow::displayMessage("An instrument is from a later version of TIATracker!");
        return false;
    }

    QString newName = json["name"].toString();
    int newWaveform = json["waveform"].toInt();
    int newEnvelopeLength = json["envelopeLength"].toInt();
    int newSustainStart = json["sustainStart"].toInt();
    int newReleaseStart = json["releaseStart"].toInt();
    QJsonArray freqArray = json["frequencies"].toArray();
    QJsonArray volArray = json["volumes"].toArray();

    // Check for data validity
    if (newName.length() > InstrumentsTab::maxInstrumentNameLength) {
        MainWindow::displayMessage("An instrument has an invalid name: " + newName);
        return false;
    }
    if (newWaveform < 0 || newWaveform > 16) {
        MainWindow::displayMessage("An instrument has an invalid waveform: " + newName);
        return false;
    }
    if (newEnvelopeLength < 2 || newEnvelopeLength > 99
            || newSustainStart < 0 || newSustainStart >= newEnvelopeLength - 1
            || newReleaseStart <= newSustainStart || newReleaseStart > newEnvelopeLength - 1) {
        MainWindow::displayMessage("An instrument has an invalid envelope structure: " + newName);
        return false;
    }
    if (newEnvelopeLength != freqArray.size() || newEnvelopeLength != volArray.size()) {
        MainWindow::displayMessage("An instrument has an invalid frequency envelope: " + newName);
        return false;
    }

    // Copy data. Adjust volumes or frequencies if necessary.
    frequencies.clear();
    volumes.clear();
    for (int frame = 0; frame < newEnvelopeLength; ++frame) {
        int newVolume = volArray[frame].toInt();
        if (newVolume < 0) {
            newVolume = 0;
        }
        if (newVolume > 15) {
            newVolume = 15;
        }
        volumes.append(newVolume);
        int newFrequency = freqArray[frame].toInt();
        if (newFrequency < -8) {
            newFrequency = -8;
        }
        if (newFrequency > 7) {
            newFrequency = 7;
        }
        frequencies.append(newFrequency);
    }
    name = newName;
    baseDistortion = TiaSound::distortions[newWaveform];
    envelopeLength = newEnvelopeLength;
    sustainStart = newSustainStart;
    releaseStart = newReleaseStart;

    return true;
}

/*************************************************************************/

void Instrument::setEnvelopeLength(int newSize) {
    if (newSize > volumes.size()) {
        // grow
        int lastVolume = volumes[volumes.size() - 1];
        int lastFrequency = frequencies[volumes.size() - 1];
        while (volumes.size() != newSize) {
            volumes.append(lastVolume);
            frequencies.append(lastFrequency);
        }
    }
    envelopeLength = newSize;
    validateSustainReleaseValues();
}

/*************************************************************************/

int Instrument::getAudCValue(int frequency) {
    int result;

    if (baseDistortion != TiaSound::Distortion::PURE_COMBINED) {
        result = (static_cast<int>(baseDistortion));
    } else {
        if (frequency < 32) {
            result = (static_cast<int>(TiaSound::Distortion::PURE_HIGH));
        } else {
            result = (static_cast<int>(TiaSound::Distortion::PURE_LOW));
        }
    }

    return result;
}

/*************************************************************************/

void Instrument::validateSustainReleaseValues() {
    if (releaseStart >= envelopeLength) {
        releaseStart = envelopeLength - 1;
    }
    if (sustainStart >= releaseStart) {
        sustainStart = releaseStart - 1;
    }
}

/*************************************************************************/

void Instrument::setSustainAndRelease(int newSustainStart, int newReleaseStart) {
    // TODO: change intro assert
    if (newReleaseStart <= newSustainStart
            || newSustainStart >= envelopeLength - 1
            || newReleaseStart >= envelopeLength) {
        throw std::invalid_argument("Invalid new sustain/release index values!");
    }
    sustainStart = newSustainStart;
    releaseStart = newReleaseStart;
}

/*************************************************************************/

void Instrument::deleteInstrument()
{
    name = "---";
    while (volumes.size() > 2) {
        volumes.removeLast();
        frequencies.removeLast();
    }
    volumes[0] = 0;
    volumes[1] = 0;
    frequencies[0] = 0;
    frequencies[1] = 0;
    envelopeLength = 2;
    sustainStart = 0;
    releaseStart = 1;
    baseDistortion = TiaSound::Distortion::PURE_COMBINED;
}

/*************************************************************************/

int Instrument::getMinVolume() {
    int min = volumes[0];
    for (int i = 1; i < volumes.size(); ++i) {
        min = qMin(min, volumes[i]);
    }
    return min;
}

/*************************************************************************/

int Instrument::getMaxVolume() {
    int max = volumes[0];
    for (int i = 1; i < volumes.size(); ++i) {
        max = qMax(max, volumes[i]);
    }
    return max;
}

/*************************************************************************/

void Instrument::correctSustainReleaseForInsert(int frame) {
    if (frame < sustainStart) {
        // in AD
        sustainStart++;
        releaseStart++;
    } else if (frame < releaseStart) {
        // in Sustain
        releaseStart++;
    }
}

void Instrument::insertFrameBefore(int frame) {
    if (envelopeLength == maxEnvelopeLength) {
        return;
    }
    envelopeLength++;

    correctSustainReleaseForInsert(frame);

    // Interpolate
    int volBefore = 0;
    int freqBefore = 0;
    if (frame != 0) {
        volBefore = volumes[frame - 1];
        freqBefore = frequencies[frame - 1];
    }
    int volAfter = volumes[frame];
    int newVol = int((volAfter + volBefore)/2);
    int freqAfter = frequencies[frame];
    int freqNew = int((freqAfter + freqBefore)/2);

    volumes.insert(frame, newVol);
    frequencies.insert(frame, freqNew);
}

/*************************************************************************/

void Instrument::insertFrameAfter(int frame) {
    if (envelopeLength == maxEnvelopeLength) {
        return;
    }
    envelopeLength++;

    correctSustainReleaseForInsert(frame);

    // Interpolate
    int volBefore = volumes[frame];
    int freqBefore = frequencies[frame];
    int volAfter = 0;
    int freqAfter = 0;
    // -1 b/c we increased length already
    if (frame + 1 != envelopeLength - 1) {
        volAfter = volumes[frame + 1];
        freqAfter = frequencies[frame + 1];
    }
    int newVol = int((volAfter + volBefore)/2);
    int newFreq = int((freqAfter + freqBefore)/2);

    volumes.insert(frame + 1, newVol);
    frequencies.insert(frame + 1, newFreq);
}

/*************************************************************************/

void Instrument::deleteFrame(int frame) {
    if (envelopeLength == 2) {
        return;
    }
    envelopeLength--;

    // Correct sustain and release
    if (frame < sustainStart) {
        // in AD
        sustainStart--;
        releaseStart--;
    } else if (frame < releaseStart) {
        // in Sustain
        if (releaseStart - sustainStart > 1) {
            releaseStart--;
        } else {
            // Trying to delete single sustain frame.
            if (sustainStart > 0) {
                // Move sustain one back
                sustainStart--;
                releaseStart--;
            } else {
                // keep sustain at this position
            }
        }
    } else {
        // in Release
        if (releaseStart - sustainStart == 1) {
            // Move Release back one frame
            sustainStart--;
            releaseStart--;
        }
    }

    // Delete frames
    volumes.removeAt(frame);
    frequencies.removeAt(frame);
}

/*************************************************************************/

int Instrument::getSustainStart() const {
    return sustainStart;
}

int Instrument::getReleaseStart() const {
    return releaseStart;
}

/*************************************************************************/

int Instrument::calcEffectiveSize() {
    int realSize = envelopeLength;
    while (realSize > (releaseStart + 1) && frequencies[realSize - 1] == 0 && volumes[realSize - 1] == 0) {
        realSize--;
    }
    return realSize + 1;    // +1 for "end of instrument" 0 byte
}

/*************************************************************************/

int Instrument::getEnvelopeLength() {
    return envelopeLength;
}

}