libgig 4.6.1
SF.h
1/***************************************************************************
2 * *
3 * libsf2 - C++ cross-platform SF2 format file access library *
4 * *
5 * Copyright (C) 2009-2010 by Grigor Iliev <grigor@grigoriliev.com> *
6 * *
7 * This library is free software; you can redistribute it and/or modify *
8 * it under the terms of the GNU General Public License as published by *
9 * the Free Software Foundation; either version 2 of the License, or *
10 * (at your option) any later version. *
11 * *
12 * This library is distributed in the hope that it will be useful, *
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
15 * GNU General Public License for more details. *
16 * *
17 * You should have received a copy of the GNU General Public License *
18 * along with this library; if not, write to the Free Software *
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
20 * MA 02111-1307 USA *
21 ***************************************************************************/
22
23#ifndef __SF2_SF_H__
24#define __SF2_SF_H__
25
26#include "RIFF.h"
27
28#include <vector>
29
30
31#define RIFF_ID(x) (*((uint32_t*) x))
32
33
34#define RIFF_TYPE_SF2 RIFF_ID("sfbk")
35
36// Level 0
37#define LIST_TYPE_SDTA RIFF_ID("sdta")
38#define LIST_TYPE_PDTA RIFF_ID("pdta")
39
40// Level 1
41//<INFO-list>
42#define CHUNK_ID_IFIL RIFF_ID("ifil")
43#define CHUNK_ID_ISNG RIFF_ID("isng")
44#define CHUNK_ID_IROM RIFF_ID("irom")
45#define CHUNK_ID_IVER RIFF_ID("iver")
46
47//<sdta-list>
48#define CHUNK_ID_SM24 RIFF_ID("sm24")
49
50//<pdta-list>
51#define CHUNK_ID_PHDR RIFF_ID("phdr")
52#define CHUNK_ID_PBAG RIFF_ID("pbag")
53#define CHUNK_ID_PMOD RIFF_ID("pmod")
54#define CHUNK_ID_PGEN RIFF_ID("pgen")
55#define CHUNK_ID_INST RIFF_ID("inst")
56#define CHUNK_ID_IBAG RIFF_ID("ibag")
57#define CHUNK_ID_IMOD RIFF_ID("imod")
58#define CHUNK_ID_IGEN RIFF_ID("igen")
59#define CHUNK_ID_SHDR RIFF_ID("shdr")
60
62namespace sf2 {
63
64 static uint NONE = 0x1ffffff;
65
66 double ToSeconds(int Timecents);
67 double ToRatio(int Centibels);
68 double ToHz(int cents);
69
70 typedef struct _PresetBag {
71 uint16_t GenNdx;
72 uint16_t ModNdx;
73 } PresetBag;
74
75 typedef uint16_t SFModulator;
76 typedef uint16_t SFGenerator;
77 typedef uint16_t SFTransform;
78
79 typedef struct _ModList {
80 SFModulator ModSrcOper;
81 SFGenerator ModDestOper;
82 uint16_t ModAmount;
83 SFModulator ModAmtSrcOper;
84 SFTransform ModTransOper;
85 } ModList;
86
87 typedef struct _RangesType {
88 #if WORDS_BIGENDIAN
89 uint8_t byHi;
90 uint8_t byLo;
91 #else
92 uint8_t byLo;
93 uint8_t byHi;
94 #endif
95 } RangesType;
96
97 typedef union _GenAmountType {
98 RangesType ranges;
99 short shAmount;
100 uint16_t wAmount;
101 } GenAmountType;
102
103 typedef struct _GenList {
104 SFGenerator GenOper;
105 GenAmountType GenAmount;
106 } GenList;
107
108 typedef struct _InstBag {
109 uint16_t InstGenNdx;
110 uint16_t InstModNdx;
111 } InstBag;
112
113 typedef enum {
114 START_ADDRS_OFFSET = 0,
115 END_ADDRS_OFFSET,
116 STARTLOOP_ADDRS_OFFSET,
117 ENDLOOP_ADDRS_OFFSET ,
118 START_ADDRS_COARSE_OFFSET,
119 MOD_LFO_TO_PITCH,
120 VIB_LFO_TO_PITCH,
121 MOD_ENV_TO_PITCH,
122 INITIAL_FILTER_FC,
123 INITIAL_FILTER_Q,
124 MOD_LFO_TO_FILTER_FC, // 10
125 MOD_ENV_TO_FILTER_FC,
126 END_ADDRS_COARSE_OFFSET,
127 MOD_LFO_TO_VOLUME,
128 UNUSED1,
129 CHORUS_EFFECTS_SEND,
130 REVERB_EFFECTS_SEND,
131 PAN,
132 UNUSED2,
133 UNUSED3,
134 UNUSED4, //20
135 DELAY_MOD_LFO,
136 FREQ_MOD_LFO,
137 DELAY_VIB_LFO,
138 FREQ_VIB_LFO,
139 DELAY_MOD_ENV,
140 ATTACK_MOD_ENV,
141 HOLD_MOD_ENV,
142 DECAY_MOD_ENV,
143 SUSTAIN_MOD_ENV,
144 RELEASE_MOD_ENV, // 30
145 KEYNUM_TO_MOD_ENV_HOLD,
146 KEYNUM_TO_MOD_ENV_DECAY,
147 DELAY_VOL_ENV,
148 ATTACK_VOL_ENV,
149 HOLD_VOL_ENV,
150 DECAY_VOL_ENV,
151 SUSTAIN_VOL_ENV,
152 RELEASE_VOL_ENV,
153 KEYNUM_TO_VOL_ENV_HOLD,
154 KEYNUM_TO_VOL_ENV_DECAY, //40
155 INSTRUMENT,
156 RESERVED1,
157 KEY_RANGE,
158 VEL_RANGE,
159 STARTLOOP_ADDRS_COARSE_OFFSET,
160 KEYNUM,
161 VELOCITY,
162 INITIAL_ATTENUATION,
163 RESERVED2,
164 ENDLOOP_ADDRS_COARSE_OFFSET, // 50
165 COARSE_TUNE,
166 FINE_TUNE,
167 SAMPLE_ID,
168 SAMPLE_MODES,
169 RESERVED3,
170 SCALE_TUNING,
171 EXCLUSIVE_CLASS,
172 OVERRIDING_ROOT_KEY,
173 UNUSED5,
174 END_OPER
175 } SFGeneratorType;
176
177 class File;
178 class Instrument;
179
180 class Modulator {
181 public:
182
187 enum {
188 NO_CONTROLLER = 0,
189 NOTE_ON_VELOCITY = 2,
190 NOTE_ON_KEY_NUMBER = 3,
191 POLY_PRESSURE = 10,
192 CHANNEL_PRESSURE = 13,
193 PITCH_WHEEL = 14,
194 PITCH_WHEEL_SENSITIVITY = 16,
195 LINK = 127
196 };
197
201 enum {
202 LINEAR = 0,
203 CONCAVE,
204 CONVEX,
205 SWITCH
206 };
207
208 int Type;
209 bool MidiPalete;
210 bool Direction;
211 bool Polarity;
212 int Index;
213
214 Modulator(SFModulator mod);
215 };
216
217 class ModulatorItem {
218 public:
219 Modulator ModSrcOper;
220 SFGenerator ModDestOper;
221 uint16_t ModAmount;
222 Modulator ModAmtSrcOper;
223 SFTransform ModTransOper;
224
225 ModulatorItem(ModList& mod);
226 };
227
228
229 typedef std::string String;
230
231 class Exception : public RIFF::Exception {
232 public: Exception(String Message) : RIFF::Exception(Message) { }
233 };
234
235 class Version {
236 public:
237 int Major;
238 int Minor;
239
240 Version(RIFF::Chunk* ck);
241 };
242
243 class Info {
244 public:
245 Version* pVer;
246 String SoundEngine;
247 String BankName;
248 String RomName;
249 Version* pRomVer;
250 String CreationDate;
251 String Engineers;
252 String Product;
253 String Copyright;
254 String Comments;
255 String Software;
256
257 Info(RIFF::List* list);
258 ~Info();
259 private:
260 static void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);
261 };
262
263 class Region;
264
265 class Sample {
266 public:
267
294 typedef enum {
295 MONO_SAMPLE = 1,
296 RIGHT_SAMPLE = 2,
297 LEFT_SAMPLE = 4,
298 LINKED_SAMPLE = 8,
299 ROM_MONO_SAMPLE = 0x8001,
300 ROM_RIGHT_SAMPLE = 0x8002,
301 ROM_LEFT_SAMPLE = 0x8004,
302 ROM_LINKED_SAMPLE = 0x8008
303 } Link;
304
307 public:
308 unsigned long position;
309 bool reverse;
310 unsigned long loop_cycles_left;
311 };
312
314 struct buffer_t {
315 void* pStart;
316 unsigned long Size;
317 unsigned long NullExtensionSize;
318 buffer_t() {
319 pStart = NULL;
320 Size = 0;
322 }
323 };
324
325 String Name;
326
327 Sample(File* file, RIFF::Chunk* ck, RIFF::Chunk* pCkSmpl, RIFF::Chunk* pCkSm24);
328
329 String GetName() { return Name; }
330 int GetChannelCount();
331 long GetTotalFrameCount();
332 int GetFrameSize();
333 bool HasLoops();
334 bool IsUnpitched() { return OriginalPitch == 255; }
335 File* GetFile() { return pFile; }
336
337 buffer_t LoadSampleData();
338 buffer_t LoadSampleData(unsigned long SampleCount);
339 buffer_t LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
340 buffer_t LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);
341 buffer_t GetCache();
342 void ReleaseSampleData();
343 unsigned long SetPos(unsigned long SampleCount);
344 unsigned long GetPos();
345 unsigned long Read(void* pBuffer, unsigned long SampleCount);
346 unsigned long ReadNoClear(void* pBuffer, unsigned long SampleCount, buffer_t& tempBuffer);
347
348 unsigned long ReadAndLoop (
349 void* pBuffer,
350 unsigned long FrameCount,
351 PlaybackState* pPlaybackState,
352 Region* pRegion
353 );
354
355 //protected:
356 buffer_t RAMCache;
357 RIFF::Chunk* pCkSmpl;
358 RIFF::Chunk* pCkSm24;
359
360 //private:
361 int ChannelCount; // 2 for left and right samples
362
363 uint32_t Start; // in sample data points (frames) from the begining of the sample data field
364 uint32_t End; // in sample data points (frames) from the begining of the sample data field
365 uint32_t StartLoop; // in sample data points (frames) from the begining of the sample data field
366 uint32_t EndLoop; // in sample data points (frames) from the begining of the sample data field
367 uint32_t SampleRate;
368 uint8_t OriginalPitch;
369 uint8_t PitchCorrection;
370 uint16_t SampleLink; /* If sfSampleType indicates a left or right sample, the
371 * sample header index of the associated right or left stereo
372 * sample respectively; zero otherwise. */
373 uint16_t SampleType;
374
375 File* pFile;
376 };
377
381 class Region {
382 public:
383 int loKey, hiKey;
384 int minVel, maxVel;
385 int pan; // -64 - +63
386 int fineTune; // -99 - +99
387 int coarseTune; // TODO:
388 int overridingRootKey; // represents the MIDI key number at which the sample is to be played back at its original sample rate.
389 int startAddrsOffset, startAddrsCoarseOffset, endAddrsOffset, endAddrsCoarseOffset;
390 int startloopAddrsOffset, startloopAddrsCoarseOffset, endloopAddrsOffset, endloopAddrsCoarseOffset;
391
392 int modEnvToPitch , modLfoToPitch, modEnvToFilterFc, modLfoToFilterFc; // in cents
393 int modLfoToVolume /* in centibels */, freqModLfo /* in absolute cents */;
394 int delayModLfo; // in absolute timecents
395 int vibLfoToPitch, freqVibLfo /* in absolute cents */;
396 int delayVibLfo; // in absolute timecents
397 int initialFilterFc /* in absolute cents */, initialFilterQ /* in centibels */;
398
399 uint exclusiveClass; // exclusive group
400
401 Sample* pSample;
402 bool HasLoop;
403 uint LoopStart; // index (in frames) from the beginning of the sample
404 uint LoopEnd; // index (in frames) from the beginning of the sample
405 Instrument* pInstrument; // used when the region belongs to preset
406
407 Region();
408 Sample* GetSample() { return pSample; }
409 Region* GetParent() { return this; }
410
411 int GetUnityNote();
412
417 Instrument* GetParentInstrument() { return pParentInstrument; }
418
419 std::vector<ModulatorItem> modulators;
420
421
422 // Instrument can be referenced by more than one presets so we need to calculate values on the fly
423 int GetPan(Region* pPresetRegion = NULL); // -64 - +63
424 int GetFineTune(Region* pPresetRegion = NULL); // -99 - +99
425 int GetCoarseTune(Region* pPresetRegion = NULL); // -120 - +120
426 double GetEG1PreAttackDelay(Region* pPresetRegion = NULL); // in seconds
427 double GetEG1Attack(Region* pPresetRegion = NULL); // in seconds
428 double GetEG1Hold(Region* pPresetRegion = NULL); // in seconds
429 double GetEG1Decay(Region* pPresetRegion = NULL); // in seconds
430 int GetEG1Sustain(Region* pPresetRegion = NULL); // Sustain value of the sample amplitude EG (the decrease in level, expressed in centibels)
431 double GetEG1Release(Region* pPresetRegion = NULL); // in seconds
432
433 double GetEG2PreAttackDelay(Region* pPresetRegion = NULL); // in seconds
434 double GetEG2Attack(Region* pPresetRegion = NULL); // in seconds
435 double GetEG2Hold(Region* pPresetRegion = NULL); // in seconds
436 double GetEG2Decay(Region* pPresetRegion = NULL); // in seconds
437 int GetEG2Sustain(Region* pPresetRegion = NULL); // Sustain value of the filter cutoff EG (in permilles)
438 double GetEG2Release(Region* pPresetRegion = NULL); // in seconds
439
440 int GetModEnvToPitch(Region* pPresetRegion = NULL); // in cents
441 int GetModLfoToPitch(Region* pPresetRegion = NULL); // in cents
442 int GetModEnvToFilterFc(Region* pPresetRegion = NULL); // in cents
443 int GetModLfoToFilterFc(Region* pPresetRegion = NULL); // in cents
444 double GetModLfoToVolume(Region* pPresetRegion = NULL); // in centibels
445 double GetFreqModLfo(Region* pPresetRegion = NULL); // in Hz
446 double GetDelayModLfo(Region* pPresetRegion = NULL); // in seconds
447 int GetVibLfoToPitch(Region* pPresetRegion = NULL); // in cents
448 double GetFreqVibLfo(Region* pPresetRegion = NULL); // in Hz
449 double GetDelayVibLfo(Region* pPresetRegion = NULL); // in seconds
450 int GetInitialFilterFc(Region* pPresetRegion); // in absolute cents
451 int GetInitialFilterQ(Region* pPresetRegion); // in centibels
452
453 friend class Instrument;
454 friend class Preset;
455
456 private:
457 int EG1PreAttackDelay; // in timecents
458 int EG1Attack; // in timecents
459 int EG1Hold; // in timecents
460 int EG1Decay; // in timecents
461 int EG1Sustain; // Sustain value (the decrease in level, expressed in centibels)
462 int EG1Release; // in timecents
463
464 int EG2PreAttackDelay; // in timecents
465 int EG2Attack; // in timecents
466 int EG2Hold; // in timecents
467 int EG2Decay; // in timecents
468 int EG2Sustain; // Sustain value of the filter cutoff EG (in permilles)
469 int EG2Release; // in timecents
470
471 Instrument* pParentInstrument;
472
473 void SetGenerator(sf2::File* pFile, GenList& Gen);
474 void SetModulator(sf2::File* pFile, ModList& Mod);
475 };
476
477 class InstrumentBase {
478 public:
479 String Name;
480 Region* pGlobalRegion;
481
482 InstrumentBase(sf2::File* pFile);
483 virtual ~InstrumentBase();
484
485 sf2::File* GetFile() { return pFile; }
486 String GetName() { return Name; }
487
488 int GetRegionCount();
489 Region* GetRegion(int idx);
490
491 protected:
492 std::vector<Region*> regions;
493 sf2::File* pFile;
494 };
495
496 class Query {
497 public:
498 int key;
499 uint8_t vel;
500
501 Query(InstrumentBase& instrument);
502 Region* next();
503
504 private:
505 InstrumentBase& instrument;
506 int i;
507 };
508
509 class Instrument : public InstrumentBase {
510 public:
511 Instrument(sf2::File* pFile, RIFF::Chunk* ck);
512 ~Instrument();
513
514 void DeleteRegion(Region* pRegion);
515 //private:
516 uint16_t InstBagNdx;
517
521 void LoadRegions(int idx1, int idx2);
522
523 Region* CreateRegion();
524 };
525
526 class Preset : public InstrumentBase {
527 public:
528 uint16_t PresetNum;
529 uint16_t Bank;
530 uint32_t Library;
531 uint32_t Genre;
532 uint32_t Morphology;
533
534 Preset(sf2::File* pFile, RIFF::Chunk* ck);
535 ~Preset();
536
537 //private:
538 sf2::File* pFile;
539 uint16_t PresetBagNdx;
540
544 void LoadRegions(int idx1, int idx2);
545
546 Region* CreateRegion();
547 };
548
549 class File {
550 public:
551 Info* pInfo;
552
553 File(RIFF::File* pRIFF);
554 ~File();
555
556 int GetPresetCount();
557 Preset* GetPreset(int idx);
558 int GetInstrumentCount();
559 Instrument* GetInstrument(int idx);
560 void DeleteInstrument(Instrument* pInstrument);
561 int GetSampleCount();
562 Sample* GetSample(int idx);
563 void DeleteSample(Sample* pSample);
564 bool HasSamples();
565 RIFF::File* GetRiffFile();
566
567 friend class Region;
568 friend class Instrument;
569 friend class Preset;
570
571 protected:
572 RIFF::File* pRIFF;
573 std::vector<PresetBag> PresetBags;
574 std::vector<ModList> PresetModLists;
575 std::vector<GenList> PresetGenLists;
576 std::vector<InstBag> InstBags;
577 std::vector<ModList> InstModLists;
578 std::vector<GenList> InstGenLists;
579
580 private:
581 std::vector<Preset*> Presets;
582 std::vector<Instrument*> Instruments;
583 std::vector<Sample*> Samples;
584 };
585
586 String libraryName();
587 String libraryVersion();
588
589} // namespace sf2
590#endif // __SF2_SF_H__
Ordinary RIFF Chunk.
Definition RIFF.h:186
Will be thrown whenever an error occurs while handling a RIFF file.
Definition RIFF.h:397
RIFF List Chunk.
Definition RIFF.h:262
Instrument zone.
Definition SF.h:381
Instrument * GetParentInstrument()
Definition SF.h:417
Reflects the current playback state for a sample.
Definition SF.h:306
unsigned long loop_cycles_left
How many times the loop has still to be passed, this value will be decremented with each loop cycle.
Definition SF.h:310
bool reverse
If playback direction is currently backwards (in case there is a pingpong or reverse loop defined).
Definition SF.h:309
unsigned long position
Current position within the sample.
Definition SF.h:308
SoundFont specific classes and definitions.
Definition SF.h:62
String libraryVersion()
Returns version of this C++ library.
Definition SF.cpp:1614
String libraryName()
Returns the name of this C++ library.
Definition SF.cpp:1607
Pointer address and size of a buffer.
Definition SF.h:314
unsigned long Size
Size of the actual data in the buffer in bytes.
Definition SF.h:316
void * pStart
Points to the beginning of the buffer.
Definition SF.h:315
unsigned long NullExtensionSize
The buffer might be bigger than the actual data, if that's the case that unused space at the end of t...
Definition SF.h:317