libgig 4.4.1
gig.h
1/***************************************************************************
2 * *
3 * libgig - C++ cross-platform Gigasampler format file access library *
4 * *
5 * Copyright (C) 2003-2021 by Christian Schoenebeck *
6 * <cuse@users.sourceforge.net> *
7 * *
8 * This library is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
12 * *
13 * This library is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
17 * *
18 * You should have received a copy of the GNU General Public License *
19 * along with this library; if not, write to the Free Software *
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21 * MA 02111-1307 USA *
22 ***************************************************************************/
23
24#ifndef __GIG_H__
25#define __GIG_H__
26
27#include "DLS.h"
28#include <vector>
29#include <array> // since C++11
30
31#ifndef __has_feature
32# define __has_feature(x) 0
33#endif
34#ifndef HAVE_RTTI
35# if __GXX_RTTI || __has_feature(cxx_rtti) || _CPPRTTI
36# define HAVE_RTTI 1
37# else
38# define HAVE_RTTI 0
39# endif
40#endif
41#if HAVE_RTTI
42# include <typeinfo>
43#else
44# warning No RTTI available!
45#endif
46
47#if WORDS_BIGENDIAN
48# define LIST_TYPE_3PRG 0x33707267
49# define LIST_TYPE_3EWL 0x3365776C
50# define LIST_TYPE_3GRI 0x33677269
51# define LIST_TYPE_3GNL 0x33676E6C
52# define LIST_TYPE_3LS 0x334c5320 // own gig format extension
53# define LIST_TYPE_RTIS 0x52544953 // own gig format extension
54# define LIST_TYPE_3DNM 0x33646e6d
55# define CHUNK_ID_3GIX 0x33676978
56# define CHUNK_ID_3EWA 0x33657761
57# define CHUNK_ID_3LNK 0x336C6E6B
58# define CHUNK_ID_3EWG 0x33657767
59# define CHUNK_ID_EWAV 0x65776176
60# define CHUNK_ID_3GNM 0x33676E6D
61# define CHUNK_ID_EINF 0x65696E66
62# define CHUNK_ID_3CRC 0x33637263
63# define CHUNK_ID_SCRI 0x53637269 // own gig format extension
64# define CHUNK_ID_LSNM 0x4c534e4d // own gig format extension
65# define CHUNK_ID_SCSL 0x5343534c // own gig format extension
66# define CHUNK_ID_SCPV 0x53435056 // own gig format extension
67# define CHUNK_ID_LSDE 0x4c534445 // own gig format extension
68# define CHUNK_ID_3DDP 0x33646470
69#else // little endian
70# define LIST_TYPE_3PRG 0x67727033
71# define LIST_TYPE_3EWL 0x6C776533
72# define LIST_TYPE_3GRI 0x69726733
73# define LIST_TYPE_3GNL 0x6C6E6733
74# define LIST_TYPE_3LS 0x20534c33 // own gig format extension
75# define LIST_TYPE_RTIS 0x53495452 // own gig format extension
76# define LIST_TYPE_3DNM 0x6d6e6433
77# define CHUNK_ID_3GIX 0x78696733
78# define CHUNK_ID_3EWA 0x61776533
79# define CHUNK_ID_3LNK 0x6B6E6C33
80# define CHUNK_ID_3EWG 0x67776533
81# define CHUNK_ID_EWAV 0x76617765
82# define CHUNK_ID_3GNM 0x6D6E6733
83# define CHUNK_ID_EINF 0x666E6965
84# define CHUNK_ID_3CRC 0x63726333
85# define CHUNK_ID_SCRI 0x69726353 // own gig format extension
86# define CHUNK_ID_LSNM 0x4d4e534c // own gig format extension
87# define CHUNK_ID_SCSL 0x4c534353 // own gig format extension
88# define CHUNK_ID_SCPV 0x56504353 // own gig format extension
89# define CHUNK_ID_LSDE 0x4544534c // own gig format extension
90# define CHUNK_ID_3DDP 0x70646433
91#endif // WORDS_BIGENDIAN
92
93#ifndef GIG_DECLARE_ENUM
94# define GIG_DECLARE_ENUM(type, ...) enum type { __VA_ARGS__ }
95#endif
96
97// just symbol prototyping (since Serialization.h not included by default here)
98namespace Serialization { class Archive; }
99
101namespace gig {
102
103 typedef std::string String;
105 typedef RIFF::file_offset_t file_offset_t;
106
108 struct range_t {
109 uint8_t low;
110 uint8_t high;
111 };
112
114 struct buffer_t {
115 void* pStart;
116 file_offset_t Size;
117 file_offset_t NullExtensionSize;
118 buffer_t() {
119 pStart = NULL;
120 Size = 0;
122 }
123 };
124
129 GIG_DECLARE_ENUM(loop_type_t,
130 loop_type_normal = 0x00000000,
131 loop_type_bidirectional = 0x00000001,
132 loop_type_backward = 0x00000002
133 );
134
139 GIG_DECLARE_ENUM(smpte_format_t,
140 smpte_format_no_offset = 0x00000000,
141 smpte_format_24_frames = 0x00000018,
142 smpte_format_25_frames = 0x00000019,
144 smpte_format_30_frames = 0x0000001E
145 );
146
151 GIG_DECLARE_ENUM(curve_type_t,
155 curve_type_unknown = 0xffffffff
156 );
157
168 GIG_DECLARE_ENUM(lfo_wave_t,
169 lfo_wave_sine = 0,
171 lfo_wave_saw = 2,
172 lfo_wave_square = 3,
173 );
174
179 GIG_DECLARE_ENUM(dim_bypass_ctrl_t,
183 );
184
189 GIG_DECLARE_ENUM(lfo3_ctrl_t,
190 lfo3_ctrl_internal = 0x00,
191 lfo3_ctrl_modwheel = 0x01,
192 lfo3_ctrl_aftertouch = 0x02,
195 );
196
201 GIG_DECLARE_ENUM(lfo2_ctrl_t,
202 lfo2_ctrl_internal = 0x00,
203 lfo2_ctrl_modwheel = 0x01,
204 lfo2_ctrl_foot = 0x02,
207 );
208
213 GIG_DECLARE_ENUM(lfo1_ctrl_t,
214 lfo1_ctrl_internal = 0x00,
215 lfo1_ctrl_modwheel = 0x01,
216 lfo1_ctrl_breath = 0x02,
219 );
220
225 GIG_DECLARE_ENUM(vcf_cutoff_ctrl_t,
226 vcf_cutoff_ctrl_none = 0x00,
227 vcf_cutoff_ctrl_none2 = 0x01,
232 vcf_cutoff_ctrl_foot = 0x84,
238 );
239
244 GIG_DECLARE_ENUM(vcf_res_ctrl_t,
245 vcf_res_ctrl_none = 0xffffffff,
250 );
251
265 GIG_DECLARE_ENUM(type_t,
266 type_none = 0x00,
268 type_velocity = 0xff,
269 type_controlchange = 0xfe
270 );
271
274
275 void serialize(Serialization::Archive* archive);
276 };
277
284
291
298
308 GIG_DECLARE_ENUM(dimension_t,
309 dimension_none = 0x00,
311 dimension_layer = 0x81,
312 dimension_velocity = 0x82,
315 dimension_keyboard = 0x85,
316 dimension_roundrobin = 0x86,
317 dimension_random = 0x87,
318 dimension_smartmidi = 0x88,
320 dimension_modwheel = 0x01,
321 dimension_breath = 0x02,
322 dimension_foot = 0x04,
324 dimension_effect1 = 0x0c,
325 dimension_effect2 = 0x0d,
326 dimension_genpurpose1 = 0x10,
327 dimension_genpurpose2 = 0x11,
328 dimension_genpurpose3 = 0x12,
329 dimension_genpurpose4 = 0x13,
331 dimension_portamento = 0x41,
333 dimension_softpedal = 0x43,
334 dimension_genpurpose5 = 0x30,
335 dimension_genpurpose6 = 0x31,
336 dimension_genpurpose7 = 0x32,
337 dimension_genpurpose8 = 0x33,
343 );
344
351 GIG_DECLARE_ENUM(split_type_t,
354 );
355
364
380 GIG_DECLARE_ENUM(vcf_type_t,
381 vcf_type_lowpass = 0x00,
382 vcf_type_lowpassturbo = 0xff,
383 vcf_type_bandpass = 0x01,
384 vcf_type_highpass = 0x02,
385 vcf_type_bandreject = 0x03,
386 vcf_type_lowpass_1p = 0x11,
387 vcf_type_lowpass_2p = 0x12,
388 vcf_type_lowpass_4p = 0x14,
389 vcf_type_lowpass_6p = 0x16,
390 vcf_type_highpass_1p = 0x21,
391 vcf_type_highpass_2p = 0x22,
392 vcf_type_highpass_4p = 0x24,
393 vcf_type_highpass_6p = 0x26,
394 vcf_type_bandpass_2p = 0x32,
396 );
397
405 struct crossfade_t {
406 #if WORDS_BIGENDIAN
407 uint8_t out_end;
408 uint8_t out_start;
409 uint8_t in_end;
410 uint8_t in_start;
411 #else // little endian
412 uint8_t in_start;
413 uint8_t in_end;
414 uint8_t out_start;
415 uint8_t out_end;
416 #endif // WORDS_BIGENDIAN
417
418 void serialize(Serialization::Archive* archive);
419 };
420
423 file_offset_t position;
424 bool reverse;
425 file_offset_t loop_cycles_left;
426 };
427
451 struct eg_opt_t {
457
458 eg_opt_t();
459 void serialize(Serialization::Archive* archive);
460 };
461
478 GIG_DECLARE_ENUM(sust_rel_trg_t,
479 sust_rel_trg_none = 0x00,
482 );
483
484 // just symbol prototyping
485 class File;
486 class Instrument;
487 class Sample;
488 class Region;
489 class Group;
490 class Script;
491 class ScriptGroup;
492
535 class DimensionRegion : protected DLS::Sampler {
536 public:
539 // Sample Amplitude EG/LFO
540 uint16_t EG1PreAttack;
541 double EG1Attack;
542 double EG1Decay1;
543 double EG1Decay2;
545 uint16_t EG1Sustain;
546 double EG1Release;
547 bool EG1Hold;
555 double LFO1Phase;
560 bool LFO1Sync;
561 // Filter Cutoff Frequency EG/LFO
562 uint16_t EG2PreAttack;
563 double EG2Attack;
564 double EG2Decay1;
565 double EG2Decay2;
567 uint16_t EG2Sustain;
568 double EG2Release;
576 double LFO2Phase;
581 bool LFO2Sync;
582 // Sample Pitch EG/LFO
583 double EG3Attack;
584 int16_t EG3Depth;
587 double LFO3Phase;
592 bool LFO3Sync;
593 // Filter
598 uint8_t VCFCutoff;
602 uint8_t VCFResonance;
607 // Key Velocity Transformations
614 // Mix / Layer
615 crossfade_t Crossfade;
618 int8_t Pan;
619 bool SelfMask;
625 bool MSDecode;
633
634 // derived attributes from DLS::Sampler
635 using DLS::Sampler::UnityNote;
636 using DLS::Sampler::FineTune;
637 using DLS::Sampler::Gain;
640
641 // own methods
642 double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
643 double GetVelocityRelease(uint8_t MIDIKeyVelocity);
644 double GetVelocityCutoff(uint8_t MIDIKeyVelocity);
646 void SetVelocityResponseDepth(uint8_t depth);
647 void SetVelocityResponseCurveScaling(uint8_t scaling);
649 void SetReleaseVelocityResponseDepth(uint8_t depth);
652 void SetVCFVelocityDynamicRange(uint8_t range);
653 void SetVCFVelocityScale(uint8_t scaling);
654 Region* GetParent() const;
655 // derived methods
658 // overridden methods
659 virtual void SetGain(int32_t gain) OVERRIDE;
660 virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
661 virtual void CopyAssign(const DimensionRegion* orig);
662 protected:
663 uint8_t* VelocityTable;
664 DimensionRegion(Region* pParent, RIFF::List* _3ewl);
665 DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src);
667 void CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples);
668 void serialize(Serialization::Archive* archive);
669 friend class Region;
670 friend class Serialization::Archive;
671 private:
672 typedef enum {
673 // official leverage controllers as they were defined in the original Gigasampler/GigaStudio format:
674 _lev_ctrl_none = 0x00,
675 _lev_ctrl_modwheel = 0x03,
676 _lev_ctrl_breath = 0x05,
677 _lev_ctrl_foot = 0x07,
678 _lev_ctrl_effect1 = 0x0d,
679 _lev_ctrl_effect2 = 0x0f,
680 _lev_ctrl_genpurpose1 = 0x11,
681 _lev_ctrl_genpurpose2 = 0x13,
682 _lev_ctrl_genpurpose3 = 0x15,
683 _lev_ctrl_genpurpose4 = 0x17,
684 _lev_ctrl_portamentotime = 0x0b,
685 _lev_ctrl_sustainpedal = 0x01,
686 _lev_ctrl_portamento = 0x19,
687 _lev_ctrl_sostenutopedal = 0x1b,
688 _lev_ctrl_softpedal = 0x09,
689 _lev_ctrl_genpurpose5 = 0x1d,
690 _lev_ctrl_genpurpose6 = 0x1f,
691 _lev_ctrl_genpurpose7 = 0x21,
692 _lev_ctrl_genpurpose8 = 0x23,
693 _lev_ctrl_effect1depth = 0x25,
694 _lev_ctrl_effect2depth = 0x27,
695 _lev_ctrl_effect3depth = 0x29,
696 _lev_ctrl_effect4depth = 0x2b,
697 _lev_ctrl_effect5depth = 0x2d,
698 _lev_ctrl_channelaftertouch = 0x2f,
699 _lev_ctrl_velocity = 0xff,
700
701 // format extension (these controllers are so far only supported by LinuxSampler & gigedit) they will *NOT* work with Gigasampler/GigaStudio !
702 // (the assigned values here are their official MIDI CC number plus the highest bit set):
703 _lev_ctrl_CC3_EXT = 0x83,
704
705 _lev_ctrl_CC6_EXT = 0x86,
706 _lev_ctrl_CC7_EXT = 0x87,
707 _lev_ctrl_CC8_EXT = 0x88,
708 _lev_ctrl_CC9_EXT = 0x89,
709 _lev_ctrl_CC10_EXT = 0x8a,
710 _lev_ctrl_CC11_EXT = 0x8b,
711
712 _lev_ctrl_CC14_EXT = 0x8e,
713 _lev_ctrl_CC15_EXT = 0x8f,
714
715 _lev_ctrl_CC20_EXT = 0x94,
716 _lev_ctrl_CC21_EXT = 0x95,
717 _lev_ctrl_CC22_EXT = 0x96,
718 _lev_ctrl_CC23_EXT = 0x97,
719 _lev_ctrl_CC24_EXT = 0x98,
720 _lev_ctrl_CC25_EXT = 0x99,
721 _lev_ctrl_CC26_EXT = 0x9a,
722 _lev_ctrl_CC27_EXT = 0x9b,
723 _lev_ctrl_CC28_EXT = 0x9c,
724 _lev_ctrl_CC29_EXT = 0x9d,
725 _lev_ctrl_CC30_EXT = 0x9e,
726 _lev_ctrl_CC31_EXT = 0x9f,
727
728 _lev_ctrl_CC68_EXT = 0xc4,
729 _lev_ctrl_CC69_EXT = 0xc5,
730 _lev_ctrl_CC70_EXT = 0xc6,
731 _lev_ctrl_CC71_EXT = 0xc7,
732 _lev_ctrl_CC72_EXT = 0xc8,
733 _lev_ctrl_CC73_EXT = 0xc9,
734 _lev_ctrl_CC74_EXT = 0xca,
735 _lev_ctrl_CC75_EXT = 0xcb,
736 _lev_ctrl_CC76_EXT = 0xcc,
737 _lev_ctrl_CC77_EXT = 0xcd,
738 _lev_ctrl_CC78_EXT = 0xce,
739 _lev_ctrl_CC79_EXT = 0xcf,
740
741 _lev_ctrl_CC84_EXT = 0xd4,
742 _lev_ctrl_CC85_EXT = 0xd5,
743 _lev_ctrl_CC86_EXT = 0xd6,
744 _lev_ctrl_CC87_EXT = 0xd7,
745
746 _lev_ctrl_CC89_EXT = 0xd9,
747 _lev_ctrl_CC90_EXT = 0xda,
748
749 _lev_ctrl_CC96_EXT = 0xe0,
750 _lev_ctrl_CC97_EXT = 0xe1,
751
752 _lev_ctrl_CC102_EXT = 0xe6,
753 _lev_ctrl_CC103_EXT = 0xe7,
754 _lev_ctrl_CC104_EXT = 0xe8,
755 _lev_ctrl_CC105_EXT = 0xe9,
756 _lev_ctrl_CC106_EXT = 0xea,
757 _lev_ctrl_CC107_EXT = 0xeb,
758 _lev_ctrl_CC108_EXT = 0xec,
759 _lev_ctrl_CC109_EXT = 0xed,
760 _lev_ctrl_CC110_EXT = 0xee,
761 _lev_ctrl_CC111_EXT = 0xef,
762 _lev_ctrl_CC112_EXT = 0xf0,
763 _lev_ctrl_CC113_EXT = 0xf1,
764 _lev_ctrl_CC114_EXT = 0xf2,
765 _lev_ctrl_CC115_EXT = 0xf3,
766 _lev_ctrl_CC116_EXT = 0xf4,
767 _lev_ctrl_CC117_EXT = 0xf5,
768 _lev_ctrl_CC118_EXT = 0xf6,
769 _lev_ctrl_CC119_EXT = 0xf7
770 } _lev_ctrl_t;
771 typedef std::map<uint32_t, double*> VelocityTableMap;
772
773 static size_t Instances;
774 static VelocityTableMap* pVelocityTables;
775 double* pVelocityAttenuationTable;
776 double* pVelocityReleaseTable;
777 double* pVelocityCutoffTable;
778 Region* pRegion;
779
780 leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
781 _lev_ctrl_t EncodeLeverageController(leverage_ctrl_t DecodedController);
782 double* GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth);
783 double* GetCutoffVelocityTable(curve_type_t vcfVelocityCurve, uint8_t vcfVelocityDynamicRange, uint8_t vcfVelocityScale, vcf_cutoff_ctrl_t vcfCutoffController);
784 double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
785 double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
786 bool UsesAnyGigFormatExtension() const;
787 };
788
814 class Sample : public DLS::Sample {
815 public:
816 uint32_t Manufacturer;
817 uint32_t Product;
818 uint32_t SamplePeriod;
819 uint32_t MIDIUnityNote;
820 uint32_t FineTune;
822 uint32_t SMPTEOffset;
823 uint32_t Loops;
824 uint32_t LoopID;
826 uint32_t LoopStart;
827 uint32_t LoopEnd;
828 uint32_t LoopSize;
829 uint32_t LoopFraction;
830 uint32_t LoopPlayCount;
832 uint32_t TruncatedBits;
833 bool Dithered;
834
835 // own methods
837 buffer_t LoadSampleData(file_offset_t SampleCount);
839 buffer_t LoadSampleDataWithNullSamplesExtension(file_offset_t SampleCount, uint NullSamplesCount);
841 // own static methods
842 static buffer_t CreateDecompressionBuffer(file_offset_t MaxReadSize);
843 static void DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);
844 // overridden methods
845 void ReleaseSampleData();
846 void Resize(file_offset_t NewSize);
847 file_offset_t SetPos(file_offset_t SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
848 file_offset_t GetPos() const;
849 file_offset_t Read(void* pBuffer, file_offset_t SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
850 file_offset_t ReadAndLoop(void* pBuffer, file_offset_t SampleCount, playback_state_t* pPlaybackState, DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer = NULL);
851 file_offset_t Write(void* pBuffer, file_offset_t SampleCount);
852 Group* GetGroup() const;
853 virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
854 void CopyAssignMeta(const Sample* orig);
855 void CopyAssignWave(const Sample* orig);
856 uint32_t GetWaveDataCRC32Checksum();
857 bool VerifyWaveData(uint32_t* pActually = NULL);
858 protected:
859 static size_t Instances;
862 file_offset_t FrameOffset;
863 file_offset_t* FrameTable;
864 file_offset_t SamplePos;
865 file_offset_t SamplesInLastFrame;
866 file_offset_t WorstCaseFrameSize;
867 file_offset_t SamplesPerFrame;
869 unsigned long FileNo;
870 RIFF::Chunk* pCk3gix;
871 RIFF::Chunk* pCkSmpl;
872 uint32_t crc;
873
874 Sample(File* pFile, RIFF::List* waveList, file_offset_t WavePoolOffset, unsigned long fileNo = 0, int index = -1);
875 ~Sample();
876 uint32_t CalculateWaveDataChecksum();
877
878 // Guess size (in bytes) of a compressed sample
879 inline file_offset_t GuessSize(file_offset_t samples) {
880 // 16 bit: assume all frames are compressed - 1 byte
881 // per sample and 5 bytes header per 2048 samples
882
883 // 24 bit: assume next best compression rate - 1.5
884 // bytes per sample and 13 bytes header per 256
885 // samples
886 const file_offset_t size =
887 BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
888 : samples + (samples >> 10) * 5;
889 // Double for stereo and add one worst case sample
890 // frame
891 return (Channels == 2 ? size << 1 : size) + WorstCaseFrameSize;
892 }
893
894 // Worst case amount of sample points that can be read with the
895 // given decompression buffer.
896 inline file_offset_t WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
897 return (file_offset_t) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
898 }
899 private:
900 void ScanCompressedSample();
901 friend class File;
902 friend class Region;
903 friend class Group; // allow to modify protected member pGroup
904 };
905
906 // TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions)
927 class Region : public DLS::Region {
928 public:
929 unsigned int Dimensions;
933 unsigned int Layers;
934
935 // own methods
936 DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);
937 DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);
938 int GetDimensionRegionIndexByValue(const uint DimValues[8]);
939 Sample* GetSample();
940 void AddDimension(dimension_def_t* pDimDef);
941 void DeleteDimension(dimension_def_t* pDimDef);
943 void DeleteDimensionZone(dimension_t type, int zone);
944 void SplitDimensionZone(dimension_t type, int zone);
945 void SetDimensionType(dimension_t oldType, dimension_t newType);
946 // overridden methods
947 virtual void SetKeyRange(uint16_t Low, uint16_t High) OVERRIDE;
948 virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
949 virtual void CopyAssign(const Region* orig);
950 protected:
951 Region(Instrument* pInstrument, RIFF::List* rgnList);
952 void LoadDimensionRegions(RIFF::List* rgn);
953 void UpdateVelocityTable();
954 Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
955 void CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples);
956 DimensionRegion* GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase);
957 ~Region();
958 friend class Instrument;
959 private:
960 bool UsesAnyGigFormatExtension() const;
961 };
962
1005 class MidiRule {
1006 public:
1007 virtual ~MidiRule() { }
1008 protected:
1009 virtual void UpdateChunks(uint8_t* pData) const = 0;
1010 friend class Instrument;
1011 };
1012
1027 public:
1029 uint8_t Triggers;
1030 struct trigger_t {
1031 uint8_t TriggerPoint;
1032 bool Descending;
1033 uint8_t VelSensitivity;
1034 uint8_t Key;
1035 bool NoteOff;
1036 uint8_t Velocity;
1037 bool OverridePedal;
1038 } pTriggers[32];
1039
1040 protected:
1043 void UpdateChunks(uint8_t* pData) const OVERRIDE;
1044 friend class Instrument;
1045 };
1046
1067 class MidiRuleLegato : public MidiRule {
1068 public:
1071 uint8_t BypassKey;
1073 uint16_t ThresholdTime;
1074 uint16_t ReleaseTime;
1079
1080 protected:
1083 void UpdateChunks(uint8_t* pData) const OVERRIDE;
1084 friend class Instrument;
1085 };
1086
1100 public:
1102 String pArticulations[32];
1103
1105
1106 uint8_t Patterns;
1107 struct pattern_t {
1108 String Name;
1109 int Size;
1110 const uint8_t& operator[](int i) const {
1111 return data[i];
1112 }
1113 uint8_t& operator[](int i) {
1114 return data[i];
1115 }
1116 private:
1117 uint8_t data[32];
1119
1120 typedef enum {
1121 selector_none,
1122 selector_key_switch,
1123 selector_controller
1124 } selector_t;
1125 selector_t Selector;
1127 uint8_t Controller;
1128
1130 bool Chained;
1131
1132 protected:
1135 void UpdateChunks(uint8_t* pData) const OVERRIDE;
1136 friend class Instrument;
1137 };
1138
1152 class MidiRuleUnknown : public MidiRule {
1153 protected:
1154 MidiRuleUnknown() { }
1155 void UpdateChunks(uint8_t* pData) const OVERRIDE { }
1156 friend class Instrument;
1157 };
1158
1179 class Script : protected DLS::Storage {
1180 public:
1188 LANGUAGE_NKSP = 0
1190
1191 String Name;
1195 bool Bypass;
1196 uint8_t Uuid[16];
1197
1198 String GetScriptAsText();
1199 void SetScriptAsText(const String& text);
1200 void SetGroup(ScriptGroup* pGroup);
1201 ScriptGroup* GetGroup() const;
1202 void CopyAssign(const Script* orig);
1203 protected:
1204 Script(ScriptGroup* group, RIFF::Chunk* ckScri);
1205 virtual ~Script();
1206 void UpdateChunks(progress_t* pProgress) OVERRIDE;
1207 void DeleteChunks() OVERRIDE;
1208 void RemoveAllScriptReferences();
1209 void GenerateUuid();
1210 friend class ScriptGroup;
1211 friend class Instrument;
1212 private:
1213 ScriptGroup* pGroup;
1214 RIFF::Chunk* pChunk;
1215 std::vector<uint8_t> data;
1216 uint32_t crc;
1217 };
1218
1230 class ScriptGroup : protected DLS::Storage {
1231 public:
1232 String Name;
1233
1234 Script* GetScript(size_t index);
1235 Script* AddScript();
1236 void DeleteScript(Script* pScript);
1237 protected:
1238 ScriptGroup(File* file, RIFF::List* lstRTIS);
1239 virtual ~ScriptGroup();
1240 void LoadScripts();
1241 virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
1242 virtual void DeleteChunks() OVERRIDE;
1243 friend class Script;
1244 friend class File;
1245 private:
1246 File* pFile;
1247 RIFF::List* pList;
1248 std::vector<Script*>* pScripts;
1249 };
1250
1266 class Instrument : protected DLS::Instrument {
1267 public:
1268 // derived attributes from DLS::Resource
1271 // derived attributes from DLS::Instrument
1278 // own attributes
1279 int32_t Attenuation;
1280 uint16_t EffectSend;
1281 int16_t FineTune;
1283 bool PianoReleaseMode;
1285
1286
1287 // derived methods
1288 using DLS::Resource::GetParent;
1290 // overridden methods
1291 Region* GetRegionAt(size_t pos);
1292 Region* GetFirstRegion() LIBGIG_DEPRECATED_API("Use GetRegionAt() instead.");
1293 Region* GetNextRegion() LIBGIG_DEPRECATED_API("Use GetRegionAt() instead.");
1294 Region* AddRegion();
1295 void DeleteRegion(Region* pRegion);
1296 void MoveTo(Instrument* dst);
1297 virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
1298 virtual void CopyAssign(const Instrument* orig);
1299 // own methods
1300 Region* GetRegion(unsigned int Key);
1301 MidiRule* GetMidiRule(int i);
1302 MidiRuleCtrlTrigger* AddMidiRuleCtrlTrigger();
1303 MidiRuleLegato* AddMidiRuleLegato();
1304 MidiRuleAlternator* AddMidiRuleAlternator();
1305 void DeleteMidiRule(int i);
1306 // real-time instrument script methods
1307 Script* GetScriptOfSlot(size_t index);
1308 void AddScriptSlot(Script* pScript, bool bypass = false);
1309 void SwapScriptSlots(size_t index1, size_t index2);
1310 void RemoveScriptSlot(size_t index);
1311 void RemoveScript(Script* pScript);
1312 size_t ScriptSlotCount() const;
1313 bool IsScriptSlotBypassed(size_t index);
1314 void SetScriptSlotBypassed(size_t index, bool bBypass);
1315 bool IsScriptPatchVariableSet(size_t slot, String variable);
1316 std::map<String,String> GetScriptPatchVariables(size_t slot);
1317 String GetScriptPatchVariable(size_t slot, String variable);
1318 void SetScriptPatchVariable(size_t slot, String variable, String value);
1319 void UnsetScriptPatchVariable(ssize_t slot = -1, String variable = "");
1320 protected:
1321 Region* RegionKeyTable[128];
1322
1323 Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);
1324 ~Instrument();
1325 void CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples);
1326 void UpdateRegionKeyTable();
1327 void LoadScripts();
1328 void UpdateScriptFileOffsets();
1329 friend class File;
1330 friend class Region; // so Region can call UpdateRegionKeyTable()
1331 private:
1332 struct _ScriptPooolEntry {
1333 uint32_t fileOffset;
1334 bool bypass;
1335 };
1336 struct _ScriptPooolRef {
1337 Script* script;
1338 bool bypass;
1339 };
1340 typedef std::array<uint8_t,16> _UUID;
1341 typedef std::map<String,String> _PatchVars;
1342 typedef std::map<size_t,_PatchVars> _VarsBySlot;
1343 typedef std::map<_UUID,_VarsBySlot> _VarsByScript;
1344 MidiRule** pMidiRules;
1345 std::vector<_ScriptPooolEntry> scriptPoolFileOffsets;
1346 std::vector<_ScriptPooolRef>* pScriptRefs;
1347 _VarsByScript scriptVars;
1348
1349 _VarsByScript stripScriptVars();
1350 bool ReferencesScriptWithUuid(const _UUID& uuid);
1351 bool UsesAnyGigFormatExtension() const;
1352 };
1353
1365 class Group : public DLS::Storage {
1366 public:
1367 String Name;
1368
1369 Sample* GetSample(size_t index);
1370 Sample* GetFirstSample() LIBGIG_DEPRECATED_API("Use GetSample() instead.");
1371 Sample* GetNextSample() LIBGIG_DEPRECATED_API("Use GetSample() instead.");
1372 void AddSample(Sample* pSample);
1373 protected:
1374 Group(File* file, RIFF::Chunk* ck3gnm);
1375 virtual ~Group();
1376 virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
1377 virtual void DeleteChunks() OVERRIDE;
1378 void MoveAll();
1379 friend class File;
1380 private:
1381 File* pFile;
1382 RIFF::Chunk* pNameChunk;
1383 size_t SamplesIterator;
1384 };
1385
1422 class File : protected DLS::File {
1423 public:
1427
1428 // derived attributes from DLS::Resource
1431 // derived attributes from DLS::File
1432 using DLS::File::pVersion;
1434
1435 // derived methods from DLS::Resource
1436 using DLS::Resource::GetParent;
1437 // derived methods from DLS::File
1438 using DLS::File::Save;
1442 // overridden methods
1443 File();
1444 File(RIFF::File* pRIFF);
1445 Sample* GetFirstSample(progress_t* pProgress = NULL) LIBGIG_DEPRECATED_API("Use GetSample() instead.");
1446 Sample* GetNextSample() LIBGIG_DEPRECATED_API("Use GetSample() instead.");
1447 Sample* GetSample(size_t index, progress_t* pProgress = NULL);
1448 Sample* AddSample();
1449 size_t CountSamples();
1450 void DeleteSample(Sample* pSample);
1451 Instrument* GetFirstInstrument() LIBGIG_DEPRECATED_API("Use GetInstrument() instead.");
1452 Instrument* GetNextInstrument() LIBGIG_DEPRECATED_API("Use GetInstrument() instead.");
1453 Instrument* GetInstrument(size_t index, progress_t* pProgress = NULL);
1454 Instrument* AddInstrument();
1455 Instrument* AddDuplicateInstrument(const Instrument* orig);
1456 size_t CountInstruments();
1457 void DeleteInstrument(Instrument* pInstrument);
1458 Group* GetFirstGroup() LIBGIG_DEPRECATED_API("Use GetGroup() instead.");
1459 Group* GetNextGroup() LIBGIG_DEPRECATED_API("Use GetGroup() instead.");
1460 Group* GetGroup(size_t index);
1461 Group* GetGroup(String name);
1462 Group* AddGroup();
1463 void DeleteGroup(Group* pGroup);
1464 void DeleteGroupOnly(Group* pGroup);
1465 void SetAutoLoad(bool b);
1466 bool GetAutoLoad();
1467 void AddContentOf(File* pFile);
1468 ScriptGroup* GetScriptGroup(size_t index);
1469 ScriptGroup* GetScriptGroup(const String& name);
1470 ScriptGroup* AddScriptGroup();
1471 void DeleteScriptGroup(ScriptGroup* pGroup);
1472 virtual ~File();
1473 virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
1474 protected:
1475 // overridden protected methods from DLS::File
1476 virtual void LoadSamples() OVERRIDE;
1477 virtual void LoadInstruments() OVERRIDE;
1478 virtual void LoadGroups();
1479 virtual void UpdateFileOffsets() OVERRIDE;
1480 // own protected methods
1481 virtual void LoadSamples(progress_t* pProgress);
1482 virtual void LoadInstruments(progress_t* pProgress);
1483 virtual void LoadScriptGroups();
1484 void SetSampleChecksum(Sample* pSample, uint32_t crc);
1485 uint32_t GetSampleChecksum(Sample* pSample);
1486 uint32_t GetSampleChecksumByIndex(int index);
1487 bool VerifySampleChecksumTable();
1488 bool RebuildSampleChecksumTable();
1489 int GetWaveTableIndexOf(gig::Sample* pSample);
1490 friend class Region;
1491 friend class Sample;
1492 friend class Instrument;
1493 friend class Group; // so Group can access protected member pRIFF
1494 friend class ScriptGroup; // so ScriptGroup can access protected member pRIFF
1495 private:
1496 std::vector<Group*>* pGroups;
1497 std::vector<Group*>::iterator GroupsIterator;
1498 bool bAutoLoad;
1499 std::vector<ScriptGroup*>* pScriptGroups;
1500
1501 bool UsesAnyGigFormatExtension() const;
1502 };
1503
1512 class Exception : public DLS::Exception {
1513 public:
1514 Exception(String format, ...);
1515 Exception(String format, va_list arg);
1516 void PrintMessage();
1517 protected:
1518 Exception();
1519 };
1520
1521#if HAVE_RTTI
1522 size_t enumCount(const std::type_info& type);
1523 const char* enumKey(const std::type_info& type, size_t value);
1524 bool enumKey(const std::type_info& type, String key);
1525 const char** enumKeys(const std::type_info& type);
1526#endif // HAVE_RTTI
1527 size_t enumCount(String typeName);
1528 const char* enumKey(String typeName, size_t value);
1529 bool enumKey(String typeName, String key);
1530 const char** enumKeys(String typeName);
1531 size_t enumValue(String key);
1532
1533 String libraryName();
1534 String libraryVersion();
1535
1536} // namespace gig
1537
1538#endif // __GIG_H__
version_t * pVersion
Points to a version_t structure if the file provided a version number else is set to NULL.
Definition DLS.h:566
void SetFileName(const String &name)
You may call this method store a future file name, so you don't have to to pass it to the Save() call...
Definition DLS.cpp:2009
uint32_t Instruments
Reflects the number of available Instrument objects.
Definition DLS.h:567
virtual void Save(const String &Path, progress_t *pProgress=NULL)
Save changes to another file.
Definition DLS.cpp:2263
RIFF::File * GetRiffFile()
Returns the underlying RIFF::File used for persistency of this DLS::File object.
Definition DLS.cpp:1968
String GetFileName()
File name of this DLS file.
Definition DLS.cpp:2001
uint8_t MIDIBankFine
Reflects the MIDI Bank number for MIDI Control Change 32 (bank 1 - 128).
Definition DLS.h:529
uint8_t MIDIBankCoarse
Reflects the MIDI Bank number for MIDI Control Change 0 (bank 1 - 128).
Definition DLS.h:528
bool IsDrum
Indicates if the Instrument is a drum type, as they differ in the synthesis model of DLS from melodic...
Definition DLS.h:526
uint32_t Regions
Reflects the number of Region defintions this Instrument has.
Definition DLS.h:531
uint16_t MIDIBank
Reflects combination of MIDIBankCoarse and MIDIBankFine (bank 1 - bank 16384). Do not change this val...
Definition DLS.h:527
uint32_t MIDIProgram
Specifies the MIDI Program Change Number this Instrument should be assigned to.
Definition DLS.h:530
size_t CountRegions()
Returns the amount of regions of this instrument.
Definition DLS.cpp:1402
Defines Region information of an Instrument.
Definition DLS.h:493
Info * pInfo
Points (in any case) to an Info object, providing additional, optional infos and comments.
Definition DLS.h:406
dlsid_t * pDLSID
Points to a dlsid_t structure if the file provided a DLS ID else is NULL.
Definition DLS.h:407
Encapsulates sample waves used for playback.
Definition DLS.h:457
uint16_t BitDepth
Size of each sample per channel (only if known sample data format is used, 0 otherwise).
Definition DLS.h:464
uint16_t Channels
Number of channels represented in the waveform data, e.g. 1 for mono, 2 for stereo (defaults to 1=mon...
Definition DLS.h:460
Abstract base class which provides mandatory informations about sample players in general.
Definition DLS.h:425
void AddSampleLoop(sample_loop_t *pLoopDef)
Adds a new sample loop with the provided loop definition.
Definition DLS.cpp:742
uint32_t SampleLoops
Reflects the number of sample loops.
Definition DLS.h:432
sample_loop_t * pSampleLoops
Points to the beginning of a sample loop array, or is NULL if there are no loops defined.
Definition DLS.h:433
void DeleteSampleLoop(sample_loop_t *pLoopDef)
Deletes an existing sample loop.
Definition DLS.cpp:764
int32_t Gain
Definition DLS.h:429
Abstract base class for all classes using RIFF::Chunks for persistency.
Definition DLS.h:283
Ordinary RIFF Chunk.
Definition RIFF.h:179
RIFF File.
Definition RIFF.h:313
RIFF List Chunk.
Definition RIFF.h:261
Destination container for serialization, and source container for deserialization.
Encapsulates articulation informations of a dimension region.
Definition gig.h:535
uint8_t VelocityResponseCurveScaling
0 - 127 (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead).
Definition gig.h:610
vcf_cutoff_ctrl_t VCFCutoffController
Specifies which external controller has influence on the filter cutoff frequency.
Definition gig.h:596
void SetReleaseVelocityResponseDepth(uint8_t depth)
Updates the respective member variable and the lookup table / cache that depends on this value.
Definition gig.cpp:3190
uint8_t VelocityResponseDepth
Dynamic range of velocity affecting amplitude (0 - 4) (usually you don't have to interpret this param...
Definition gig.h:609
bool EG2InfiniteSustain
If true, instead of going into Decay2 phase, Decay1 level will be hold until note will be released.
Definition gig.h:566
void SetVCFCutoffController(vcf_cutoff_ctrl_t controller)
Updates the respective member variable and the lookup table / cache that depends on this value.
Definition gig.cpp:3199
eg2_ctrl_t EG2Controller
MIDI Controller which has influence on filter cutoff EG parameters (attack, decay,...
Definition gig.h:569
double EG2Release
Release time of the filter cutoff EG (0.000 - 60.000s).
Definition gig.h:568
eg1_ctrl_t EG1Controller
MIDI Controller which has influence on sample amplitude EG parameters (attack, decay,...
Definition gig.h:548
vcf_type_t VCFType
Defines the general filter characteristic (lowpass, highpass, bandpass, etc.).
Definition gig.h:595
double LFO3Phase
[gig extension]: Phase displacement of the pitch LFO's wave form (0.0° - 360.0°).
Definition gig.h:587
bool LFO3Sync
If set to true only one LFO should be used for all voices.
Definition gig.h:592
uint8_t VCFVelocityDynamicRange
0x04 = lowest, 0x00 = highest .
Definition gig.h:601
lfo3_ctrl_t LFO3Controller
MIDI Controller which controls the sample pitch LFO.
Definition gig.h:590
double EG1Decay1
Decay time of the sample amplitude EG (0.000 - 60.000s).
Definition gig.h:542
bool PitchTrack
If true: sample will be pitched according to the key position (this will be disabled for drums for ex...
Definition gig.h:616
double SampleAttenuation
Sample volume (calculated from DLS::Sampler::Gain)
Definition gig.h:627
uint8_t VCFVelocityScale
(0-127) Amount velocity controls VCF cutoff frequency (only if no other VCF cutoff controller is defi...
Definition gig.h:600
virtual void CopyAssign(const DimensionRegion *orig)
Make a (semi) deep copy of the DimensionRegion object given by orig and assign it to this object.
Definition gig.cpp:1842
uint8_t EG1ControllerDecayInfluence
Amount EG1 Controller has influence on the EG1 Decay time (0 - 3, where 0 means off).
Definition gig.h:551
eg_opt_t EG1Options
[gig extension]: Behavior options which should be used for envelope generator 1 (volume amplitude EG)...
Definition gig.h:629
uint8_t EG2ControllerDecayInfluence
Amount EG2 Controller has influence on the EG2 Decay time (0 - 3, where 0 means off).
Definition gig.h:572
bool EG1InfiniteSustain
If true, instead of going into Decay2 phase, Decay1 level will be hold until note will be released.
Definition gig.h:544
double EG2Decay1
Decay time of the filter cutoff EG (0.000 - 60.000s).
Definition gig.h:564
bool LFO1FlipPhase
Inverts the polarity of the sample amplitude LFO wave, so it flips the wave form vertically.
Definition gig.h:559
int16_t EG3Depth
Depth of the sample pitch EG (-1200 - +1200).
Definition gig.h:584
uint8_t ChannelOffset
Audio output where the audio signal of the dimension region should be routed to (0 - 9).
Definition gig.h:623
Sample * pSample
Points to the Sample which is assigned to the dimension region.
Definition gig.h:538
lfo_wave_t LFO1WaveForm
[gig extension]: The fundamental wave form to be used by the amplitude LFO, e.g. sine,...
Definition gig.h:553
uint8_t EG2ControllerAttackInfluence
Amount EG2 Controller has influence on the EG2 Attack time (0 - 3, where 0 means off).
Definition gig.h:571
void SetVCFVelocityScale(uint8_t scaling)
Updates the respective member variable and the lookup table / cache that depends on this value.
Definition gig.cpp:3226
lfo_wave_t LFO3WaveForm
[gig extension]: The fundamental wave form to be used by the pitch LFO, e.g. sine,...
Definition gig.h:585
int16_t LFO3ControlDepth
Controller depth of the sample pitch LFO (-1200 - +1200 cents).
Definition gig.h:589
uint8_t EG2ControllerReleaseInfluence
Amount EG2 Controller has influence on the EG2 Release time (0 - 3, where 0 means off).
Definition gig.h:573
uint8_t EG1ControllerAttackInfluence
Amount EG1 Controller has influence on the EG1 Attack time (0 - 3, where 0 means off).
Definition gig.h:550
void SetReleaseVelocityResponseCurve(curve_type_t curve)
Updates the respective member variable and the lookup table / cache that depends on this value.
Definition gig.cpp:3181
lfo2_ctrl_t LFO2Controller
MIDI Controlle which controls the filter cutoff LFO.
Definition gig.h:579
uint8_t VCFKeyboardTrackingBreakpoint
See VCFKeyboardTracking (0 - 127).
Definition gig.h:606
bool VCFResonanceDynamic
If true: Increases the resonance Q according to changes of controllers that actually control the VCF ...
Definition gig.h:603
double LFO2Phase
[gig extension]: Phase displacement of the filter cutoff LFO's wave form (0.0° - 360....
Definition gig.h:576
uint8_t DimensionUpperLimits[8]
gig3: defines the upper limit of the dimension values for this dimension region. In case you wondered...
Definition gig.h:628
uint8_t EG1ControllerReleaseInfluence
Amount EG1 Controller has influence on the EG1 Release time (0 - 3, where 0 means off).
Definition gig.h:552
uint8_t VCFResonance
Firm internal filter resonance weight.
Definition gig.h:602
uint16_t EG1Sustain
Sustain value of the sample amplitude EG (0 - 1000 permille).
Definition gig.h:545
dim_bypass_ctrl_t DimensionBypass
If defined, the MIDI controller can switch on/off the dimension in realtime.
Definition gig.h:617
bool EG2ControllerInvert
Invert values coming from defined EG2 controller.
Definition gig.h:570
void SetVCFVelocityDynamicRange(uint8_t range)
Updates the respective member variable and the lookup table / cache that depends on this value.
Definition gig.cpp:3217
uint8_t * VelocityTable
For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity ...
Definition gig.h:663
bool LFO1Sync
If set to true only one LFO should be used for all voices.
Definition gig.h:560
double EG1Attack
Attack time of the sample amplitude EG (0.000 - 60.000s).
Definition gig.h:541
void SetVelocityResponseCurve(curve_type_t curve)
Updates the respective member variable and the lookup table / cache that depends on this value.
Definition gig.cpp:3145
attenuation_ctrl_t AttenuationController
MIDI Controller which has influence on the volume level of the sample (or entire sample group).
Definition gig.h:620
double LFO1Phase
[gig extension]: Phase displacement of the amplitude LFO's wave form (0.0° - 360.0°).
Definition gig.h:555
virtual void UpdateChunks(progress_t *pProgress)
Apply dimension region settings to the respective RIFF chunks.
Definition gig.cpp:2014
double GetVelocityAttenuation(uint8_t MIDIKeyVelocity)
Returns the correct amplitude factor for the given MIDIKeyVelocity.
Definition gig.cpp:3129
double LFO1Frequency
Frequency of the sample amplitude LFO (0.10 - 10.00 Hz).
Definition gig.h:554
curve_type_t VelocityResponseCurve
Defines a transformation curve to the incoming velocity values affecting amplitude (usually you don't...
Definition gig.h:608
uint16_t EG2Sustain
Sustain value of the filter cutoff EG (0 - 1000 permille).
Definition gig.h:567
uint16_t LFO2ControlDepth
Controller depth influencing filter cutoff LFO pitch (0 - 1200).
Definition gig.h:578
lfo_wave_t LFO2WaveForm
[gig extension]: The fundamental wave form to be used by the filter cutoff LFO, e....
Definition gig.h:574
bool VCFKeyboardTracking
If true: VCF cutoff frequence will be dependend to the note key position relative to the defined brea...
Definition gig.h:605
uint8_t AttenuationControllerThreshold
0-127
Definition gig.h:622
double EG1Release
Release time of the sample amplitude EG (0.000 - 60.000s).
Definition gig.h:546
bool NoNoteOffReleaseTrigger
[gig extension]: If true then don't play a release trigger sample on MIDI note-off events.
Definition gig.h:632
void SetVelocityResponseCurveScaling(uint8_t scaling)
Updates the respective member variable and the lookup table / cache that depends on this value.
Definition gig.cpp:3169
uint8_t VelocityUpperLimit
Defines the upper velocity value limit of a velocity split (only if an user defined limit was set,...
Definition gig.h:537
bool EG1Hold
If true, Decay1 stage should be postponed until the sample reached the sample loop start.
Definition gig.h:547
uint8_t ReleaseVelocityResponseDepth
Dynamic range of release velocity affecting envelope time (0 - 4).
Definition gig.h:612
curve_type_t ReleaseVelocityResponseCurve
Defines a transformation curve to the incoming release veloctiy values affecting envelope times.
Definition gig.h:611
void SetVCFVelocityCurve(curve_type_t curve)
Updates the respective member variable and the lookup table / cache that depends on this value.
Definition gig.cpp:3208
double EG1Decay2
Only if EG1InfiniteSustain == false: 2nd decay stage time of the sample amplitude EG (0....
Definition gig.h:543
bool InvertAttenuationController
Inverts the values coming from the defined Attenuation Controller.
Definition gig.h:621
uint16_t SampleStartOffset
Number of samples the sample start should be moved (0 - 2000).
Definition gig.h:626
double EG2Decay2
Only if EG2InfiniteSustain == false: 2nd stage decay time of the filter cutoff EG (0....
Definition gig.h:565
uint16_t LFO1InternalDepth
Firm pitch of the sample amplitude LFO (0 - 1200 cents).
Definition gig.h:556
bool EG1ControllerInvert
Invert values coming from defined EG1 controller.
Definition gig.h:549
lfo1_ctrl_t LFO1Controller
MIDI Controller which controls sample amplitude LFO.
Definition gig.h:558
bool VCFCutoffControllerInvert
Inverts values coming from the defined cutoff controller.
Definition gig.h:597
double LFO3Frequency
Frequency of the sample pitch LFO (0.10 - 10.00 Hz).
Definition gig.h:586
uint8_t ReleaseTriggerDecay
0 - 8
Definition gig.h:613
double EG3Attack
Attack time of the sample pitch EG (0.000 - 10.000s).
Definition gig.h:583
virtual void SetGain(int32_t gain)
Updates the respective member variable and updates SampleAttenuation which depends on this value.
Definition gig.cpp:2000
double LFO2Frequency
Frequency of the filter cutoff LFO (0.10 - 10.00 Hz).
Definition gig.h:575
bool SustainDefeat
If true: Sustain pedal will not hold a note.
Definition gig.h:624
eg_opt_t EG2Options
[gig extension]: Behavior options which should be used for envelope generator 2 (filter cutoff EG).
Definition gig.h:630
bool LFO2FlipPhase
Inverts the polarity of the filter cutoff LFO wave, so it flips the wave form vertically.
Definition gig.h:580
sust_rel_trg_t SustainReleaseTrigger
[gig extension]: Whether a sustain pedal up event shall play release trigger sample.
Definition gig.h:631
bool MSDecode
Gigastudio flag: defines if Mid Side Recordings should be decoded.
Definition gig.h:625
bool VCFEnabled
If filter should be used.
Definition gig.h:594
uint16_t LFO1ControlDepth
Controller depth influencing sample amplitude LFO pitch (0 - 1200 cents).
Definition gig.h:557
int8_t Pan
Panorama / Balance (-64..0..63 <-> left..middle..right)
Definition gig.h:618
void SetVelocityResponseDepth(uint8_t depth)
Updates the respective member variable and the lookup table / cache that depends on this value.
Definition gig.cpp:3157
bool LFO2Sync
If set to true only one LFO should be used for all voices.
Definition gig.h:581
uint16_t EG1PreAttack
Preattack value of the sample amplitude EG (0 - 1000 permille).
Definition gig.h:540
bool SelfMask
If true: high velocity notes will stop low velocity notes at the same note, with that you can save vo...
Definition gig.h:619
uint8_t VCFCutoff
Max. cutoff frequency.
Definition gig.h:598
curve_type_t VCFVelocityCurve
Defines a transformation curve for the incoming velocity values, affecting the VCF.
Definition gig.h:599
double EG2Attack
Attack time of the filter cutoff EG (0.000 - 60.000s).
Definition gig.h:563
uint16_t EG2PreAttack
Preattack value of the filter cutoff EG (0 - 1000 permille).
Definition gig.h:562
uint16_t LFO2InternalDepth
Firm pitch of the filter cutoff LFO (0 - 1200 cents).
Definition gig.h:577
vcf_res_ctrl_t VCFResonanceController
Specifies which external controller has influence on the filter resonance Q.
Definition gig.h:604
int16_t LFO3InternalDepth
Firm depth of the sample pitch LFO (-1200 - +1200 cents).
Definition gig.h:588
bool LFO3FlipPhase
[gig extension]: Inverts the polarity of the pitch LFO wave, so it flips the wave form vertically (NO...
Definition gig.h:591
Will be thrown whenever a gig specific error occurs while trying to access a Gigasampler File.
Definition gig.h:1512
Provides convenient access to Gigasampler/GigaStudio .gig files.
Definition gig.h:1422
static const DLS::version_t VERSION_3
Reflects Gigasampler file format version 3.0 (2003-03-31).
Definition gig.h:1425
static const DLS::version_t VERSION_2
Reflects Gigasampler file format version 2.0 (1998-06-28).
Definition gig.h:1424
static const DLS::version_t VERSION_4
Reflects Gigasampler file format version 4.0 (2007-10-12).
Definition gig.h:1426
Group of Gigasampler samples.
Definition gig.h:1365
String Name
Stores the name of this Group.
Definition gig.h:1367
Provides access to a Gigasampler/GigaStudio instrument.
Definition gig.h:1266
int16_t FineTune
in cents
Definition gig.h:1281
int32_t Attenuation
in dB
Definition gig.h:1279
uint16_t PitchbendRange
Number of semitones pitchbend controller can pitch (default is 2).
Definition gig.h:1282
range_t DimensionKeyRange
0-127 (where 0 means C1 and 127 means G9)
Definition gig.h:1284
MIDI rule to automatically cycle through specified sequences of different articulations.
Definition gig.h:1099
uint8_t Controller
CC number for controller selector.
Definition gig.h:1127
struct gig::MidiRuleAlternator::pattern_t pPatterns[32]
A pattern is a sequence of articulation numbers.
range_t KeySwitchRange
Key range for key switch selector.
Definition gig.h:1126
bool Polyphonic
If alternator should step forward only when all notes are off.
Definition gig.h:1129
selector_t Selector
Method by which pattern is chosen.
Definition gig.h:1125
uint8_t Patterns
Number of alternator patterns.
Definition gig.h:1106
range_t PlayRange
Key range of the playable keys in the instrument.
Definition gig.h:1104
uint8_t Articulations
Number of articulations in the instrument.
Definition gig.h:1101
String pArticulations[32]
Names of the articulations.
Definition gig.h:1102
bool Chained
If all patterns should be chained together.
Definition gig.h:1130
MIDI rule for triggering notes by control change events.
Definition gig.h:1026
uint8_t ControllerNumber
MIDI controller number.
Definition gig.h:1028
uint8_t Triggers
Number of triggers.
Definition gig.h:1029
MIDI rule for instruments with legato samples.
Definition gig.h:1067
uint16_t ThresholdTime
Maximum time (ms) between two notes that should be played legato.
Definition gig.h:1073
uint8_t LegatoSamples
Number of legato samples per key in each direction (always 12)
Definition gig.h:1069
uint8_t BypassKey
Key to be used to bypass the sustain note.
Definition gig.h:1071
uint8_t AltSustain1Key
Key triggering alternate sustain samples.
Definition gig.h:1077
bool BypassUseController
If a controller should be used to bypass the sustain note.
Definition gig.h:1070
uint8_t AltSustain2Key
Key triggering a second set of alternate sustain samples.
Definition gig.h:1078
uint16_t ReleaseTime
Release time.
Definition gig.h:1074
range_t KeyRange
Key range for legato notes.
Definition gig.h:1075
uint8_t ReleaseTriggerKey
Key triggering release samples.
Definition gig.h:1076
uint8_t BypassController
Controller to be used to bypass the sustain note.
Definition gig.h:1072
A MIDI rule not yet implemented by libgig.
Definition gig.h:1152
Abstract base class for all MIDI rules.
Definition gig.h:1005
Defines Region information of a Gigasampler/GigaStudio instrument.
Definition gig.h:927
DimensionRegion * pDimensionRegions[256]
Pointer array to the 32 (gig2) or 256 (gig3) possible dimension regions (reflects NULL for dimension ...
Definition gig.h:932
unsigned int Dimensions
Number of defined dimensions, do not alter!
Definition gig.h:929
dimension_def_t pDimensionDefinitions[8]
Defines the five (gig2) or eight (gig3) possible dimensions (the dimension's controller and number of...
Definition gig.h:930
virtual void CopyAssign(const Region *orig)
Make a (semi) deep copy of the Region object given by orig and assign it to this object.
Definition gig.cpp:4359
void SetDimensionType(dimension_t oldType, dimension_t newType)
Change type of an existing dimension.
Definition gig.cpp:4113
dimension_def_t * GetDimensionDefinition(dimension_t type)
Searches in the current Region for a dimension of the given dimension type and returns the precise co...
Definition gig.cpp:4153
void SplitDimensionZone(dimension_t type, int zone)
Divide split zone of a dimension in two (increment zone amount).
Definition gig.cpp:3954
DimensionRegion * GetDimensionRegionByValue(const uint DimValues[8])
Use this method in your audio engine to get the appropriate dimension region with it's articulation d...
Definition gig.cpp:4184
void DeleteDimensionZone(dimension_t type, int zone)
Delete one split zone of a dimension (decrement zone amount).
Definition gig.cpp:3810
void AddDimension(dimension_def_t *pDimDef)
Einstein would have dreamed of it - create a new dimension.
Definition gig.cpp:3608
unsigned int Layers
Amount of defined layers (1 - 32). A value of 1 actually means no layering, a value > 1 means there i...
Definition gig.h:933
~Region()
Destructor.
Definition gig.cpp:4160
Sample * GetSample()
Returns pointer address to the Sample referenced with this region.
Definition gig.cpp:4312
virtual void SetKeyRange(uint16_t Low, uint16_t High)
Modifies the key range of this Region and makes sure the respective chunks are in correct order.
Definition gig.cpp:3514
DimensionRegion * GetDimensionRegionByBit(const uint8_t DimBits[8])
Returns the appropriate DimensionRegion for the given dimension bit numbers (zone index).
Definition gig.cpp:4293
void DeleteDimension(dimension_def_t *pDimDef)
Delete an existing dimension.
Definition gig.cpp:3720
virtual void UpdateChunks(progress_t *pProgress)
Apply Region settings and all its DimensionRegions to the respective RIFF chunks.
Definition gig.cpp:3399
uint32_t DimensionRegions
Total number of DimensionRegions this Region contains, do not alter!
Definition gig.h:931
Encapsulates sample waves of Gigasampler/GigaStudio files used for playback.
Definition gig.h:814
static void DestroyDecompressionBuffer(buffer_t &DecompressionBuffer)
Free decompression buffer, previously created with CreateDecompressionBuffer().
Definition gig.cpp:1390
file_offset_t SamplesInLastFrame
For compressed samples only: length of the last sample frame.
Definition gig.h:865
loop_type_t LoopType
Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The ...
Definition gig.h:825
uint32_t Loops
Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: Numb...
Definition gig.h:823
bool VerifyWaveData(uint32_t *pActually=NULL)
Checks the integrity of this sample's raw audio wave data.
Definition gig.cpp:1452
uint32_t LoopFraction
The fractional value specifies a fraction of a sample at which to loop. This allows a loop to be fine...
Definition gig.h:829
unsigned long FileNo
File number (> 0 when sample is stored in an extension file, 0 when it's in the gig)
Definition gig.h:869
void CopyAssignMeta(const Sample *orig)
Make a (semi) deep copy of the Sample object given by orig (without the actual waveform data) and ass...
Definition gig.cpp:510
uint32_t LoopStart
Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The ...
Definition gig.h:826
uint32_t SMPTEOffset
The SMPTE Offset value specifies the time offset to be used for the synchronization / calibration to ...
Definition gig.h:822
buffer_t RAMCache
Buffers samples (already uncompressed) in RAM.
Definition gig.h:868
file_offset_t * FrameTable
For positioning within compressed samples only: stores the offset values for each frame.
Definition gig.h:863
uint32_t Product
Specifies the MIDI model ID defined by the manufacturer corresponding to the Manufacturer field....
Definition gig.h:817
~Sample()
Destructor.
Definition gig.cpp:1477
uint32_t LoopEnd
Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The ...
Definition gig.h:827
Group * pGroup
pointer to the Group this sample belongs to (always not-NULL)
Definition gig.h:861
file_offset_t WorstCaseFrameSize
For compressed samples only: size (in bytes) of the largest possible sample frame.
Definition gig.h:866
static buffer_t CreateDecompressionBuffer(file_offset_t MaxReadSize)
Allocates a decompression buffer for streaming (compressed) samples with Sample::Read().
Definition gig.cpp:1373
void Resize(file_offset_t NewSize)
Resize sample.
Definition gig.cpp:866
file_offset_t SamplePos
For compressed samples only: stores the current position (in sample points).
Definition gig.h:864
file_offset_t FrameOffset
Current offset (sample points) in current sample frame (for decompression only).
Definition gig.h:862
bool Compressed
If the sample wave is compressed (probably just interesting for instrument and sample editors,...
Definition gig.h:831
Group * GetGroup() const
Returns pointer to the Group this Sample belongs to.
Definition gig.cpp:1407
uint32_t MIDIUnityNote
Specifies the musical note at which the sample will be played at it's original sample rate.
Definition gig.h:819
uint32_t crc
Reflects CRC-32 checksum of the raw sample data at the last time when the sample's raw wave form data...
Definition gig.h:872
buffer_t LoadSampleData()
Loads (and uncompresses if needed) the whole sample wave into RAM.
Definition gig.cpp:706
void CopyAssignWave(const Sample *orig)
Should be called after CopyAssignMeta() and File::Save() sequence.
Definition gig.cpp:546
smpte_format_t SMPTEFormat
Specifies the Society of Motion Pictures and Television E time format used in the following SMPTEOffs...
Definition gig.h:821
file_offset_t GetPos() const
Returns the current position in the sample (in sample points).
Definition gig.cpp:926
static size_t Instances
Number of instances of class Sample.
Definition gig.h:859
file_offset_t SetPos(file_offset_t SampleCount, RIFF::stream_whence_t Whence=RIFF::stream_start)
Sets the position within the sample (in sample points, not in bytes).
Definition gig.cpp:892
uint32_t GetWaveDataCRC32Checksum()
Returns the CRC-32 checksum of the sample's raw wave form data at the time when this sample's wave fo...
Definition gig.cpp:1423
file_offset_t ReadAndLoop(void *pBuffer, file_offset_t SampleCount, playback_state_t *pPlaybackState, DimensionRegion *pDimRgn, buffer_t *pExternalDecompressionBuffer=NULL)
Reads SampleCount number of sample points from the position stored in pPlaybackState into the buffer ...
Definition gig.cpp:965
bool Dithered
For 24-bit compressed samples only: if dithering was used during compression with bit reduction.
Definition gig.h:833
file_offset_t Read(void *pBuffer, file_offset_t SampleCount, buffer_t *pExternalDecompressionBuffer=NULL)
Reads SampleCount number of sample points from the current position into the buffer pointed by pBuffe...
Definition gig.cpp:1140
uint32_t LoopID
Specifies the unique ID that corresponds to one of the defined cue points in the cue point list (only...
Definition gig.h:824
static buffer_t InternalDecompressionBuffer
Buffer used for decompression of samples, and only if no external decompression buffer was supplied.
Definition gig.h:860
uint32_t SamplePeriod
Specifies the duration of time that passes during the playback of one sample in nanoseconds (normally...
Definition gig.h:818
uint32_t LoopPlayCount
Number of times the loop should be played (a value of 0 = infinite).
Definition gig.h:830
buffer_t LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount)
Loads (and uncompresses if needed) the whole sample wave into RAM.
Definition gig.cpp:755
void ReleaseSampleData()
Frees the cached sample from RAM if loaded with LoadSampleData() previously.
Definition gig.cpp:829
virtual void UpdateChunks(progress_t *pProgress)
Apply sample and its settings to the respective RIFF chunks.
Definition gig.cpp:574
file_offset_t Write(void *pBuffer, file_offset_t SampleCount)
Write sample wave data.
Definition gig.cpp:1329
uint32_t Manufacturer
Specifies the MIDI Manufacturer's Association (MMA) Manufacturer code for the sampler intended to rec...
Definition gig.h:816
uint32_t TruncatedBits
For 24-bit compressed samples only: number of bits truncated during compression (0,...
Definition gig.h:832
buffer_t GetCache()
Returns current cached sample points.
Definition gig.cpp:814
uint32_t FineTune
Specifies the fraction of a semitone up from the specified MIDI unity note field. A value of 0x800000...
Definition gig.h:820
file_offset_t SamplesPerFrame
For compressed samples only: number of samples in a full sample frame.
Definition gig.h:867
uint32_t LoopSize
Caution: Use the respective fields in the DimensionRegion instead of this one! (Intended purpose: Len...
Definition gig.h:828
Group of instrument scripts (gig format extension).
Definition gig.h:1230
String Name
Name of this script group. For example to be displayed in an instrument editor.
Definition gig.h:1232
Real-time instrument script (gig format extension).
Definition gig.h:1179
Compression_t Compression
Whether the script was/should be compressed, and if so, which compression algorithm shall be used.
Definition gig.h:1192
Compression_t
Definition gig.h:1184
@ COMPRESSION_NONE
Is not compressed at all (default).
Definition gig.h:1185
void SetGroup(ScriptGroup *pGroup)
Move this script from its current ScriptGroup to another ScriptGroup given by pGroup.
Definition gig.cpp:4746
Language_t Language
Programming language and dialect the script is written in.
Definition gig.h:1194
Encoding_t Encoding
Format the script's source code text is encoded with.
Definition gig.h:1193
uint8_t Uuid[16]
Persistent Universally Unique Identifier of this script, which remains identical after any changes to...
Definition gig.h:1196
@ ENCODING_ASCII
Standard 8 bit US ASCII character encoding (default).
Definition gig.h:1182
void UpdateChunks(progress_t *pProgress)
Apply this script to the respective RIFF chunks.
Definition gig.cpp:4681
@ LANGUAGE_NKSP
NKSP stands for "Is Not KSP" (default). Refer to the NKSP Reference Manual for details about this scr...
Definition gig.h:1188
bool Bypass
Global bypass: if enabled, this script shall not be executed by the sampler for any instrument.
Definition gig.h:1195
String Name
Arbitrary name of the script, which may be displayed i.e. in an instrument editor.
Definition gig.h:1191
void DeleteChunks()
Remove all RIFF chunks associated with this Script object.
Definition gig.cpp:4669
void SetScriptAsText(const String &text)
Replaces the current script with the new script source code text given by text.
Definition gig.cpp:4655
String GetScriptAsText()
Returns the current script (i.e.
Definition gig.cpp:4642
void CopyAssign(const Script *orig)
Make a (semi) deep copy of the Script object given by orig and assign it to this object.
Definition gig.cpp:4770
ScriptGroup * GetGroup() const
Returns the script group this script currently belongs to.
Definition gig.cpp:4759
void GenerateUuid()
Generate a new Universally Unique Identifier (UUID) for this script.
Definition gig.cpp:4719
DLS specific classes and definitions.
Definition DLS.h:108
RIFF specific classes and definitions.
Definition RIFF.h:97
stream_whence_t
File stream position dependent to these relations.
Definition RIFF.h:124
uint64_t file_offset_t
Type used by libgig for handling file positioning during file I/O tasks.
Definition RIFF.h:107
Serialization / deserialization framework.
Definition gig.h:98
Gigasampler/GigaStudio specific classes and definitions.
Definition gig.h:101
size_t enumValue(String key)
Numeric value of enum constant.
Definition typeinfo.cpp:219
dim_bypass_ctrl_t
Dimensions allow to bypass one of the following controllers.
Definition gig.h:183
@ dim_bypass_ctrl_94
Effect 4 Depth (MIDI Controller 94)
Definition gig.h:183
@ dim_bypass_ctrl_95
Effect 5 Depth (MIDI Controller 95)
Definition gig.h:183
@ dim_bypass_ctrl_none
No controller bypass.
Definition gig.h:183
vcf_res_ctrl_t
Defines how the filter resonance is controlled by.
Definition gig.h:250
@ vcf_res_ctrl_genpurpose5
General Purpose Controller 5 (Button, MIDI Controller 80)
Definition gig.h:250
@ vcf_res_ctrl_none
No MIDI controller assigned for filter resonance.
Definition gig.h:250
@ vcf_res_ctrl_genpurpose3
General Purpose Controller 3 (Slider, MIDI Controller 18)
Definition gig.h:250
@ vcf_res_ctrl_genpurpose6
General Purpose Controller 6 (Button, MIDI Controller 81)
Definition gig.h:250
@ vcf_res_ctrl_genpurpose4
General Purpose Controller 4 (Slider, MIDI Controller 19)
Definition gig.h:250
smpte_format_t
Society of Motion Pictures and Television E time format.
Definition gig.h:145
@ smpte_format_30_frames
30 frames per second
Definition gig.h:145
@ smpte_format_24_frames
24 frames per second
Definition gig.h:145
@ smpte_format_no_offset
no SMPTE offset
Definition gig.h:145
@ smpte_format_25_frames
25 frames per second
Definition gig.h:145
@ smpte_format_30_frames_dropping
30 frames per second with frame dropping (30 drop)
Definition gig.h:145
curve_type_t
Defines the shape of a function graph.
Definition gig.h:156
@ curve_type_nonlinear
Non-linear curve type.
Definition gig.h:156
@ curve_type_unknown
Unknown curve type.
Definition gig.h:156
@ curve_type_linear
Linear curve type.
Definition gig.h:156
@ curve_type_special
Special curve type.
Definition gig.h:156
lfo1_ctrl_t
Defines how LFO1 is controlled by.
Definition gig.h:219
@ lfo1_ctrl_breath
Only controlled by external breath controller.
Definition gig.h:219
@ lfo1_ctrl_modwheel
Only controlled by external modulation wheel.
Definition gig.h:219
@ lfo1_ctrl_internal_modwheel
Controlled internally and by external modulation wheel.
Definition gig.h:219
@ lfo1_ctrl_internal_breath
Controlled internally and by external breath controller.
Definition gig.h:219
@ lfo1_ctrl_internal
Only internally controlled.
Definition gig.h:219
sust_rel_trg_t
Defines behaviour of release triggered sample(s) on sustain pedal up event.
Definition gig.h:482
@ sust_rel_trg_maxvelocity
Play release trigger sample(s) on sustain pedal up, and simply use 127 as MIDI velocity for playback.
Definition gig.h:482
@ sust_rel_trg_none
No release triggered sample(s) are played on sustain pedal up (default).
Definition gig.h:482
@ sust_rel_trg_keyvelocity
Play release trigger sample(s) on sustain pedal up, and use the key`s last MIDI note-on velocity for ...
Definition gig.h:482
const char ** enumKeys(String typeName)
All element names of enum type.
Definition typeinfo.cpp:323
leverage_ctrl_t eg1_ctrl_t
Defines controller influencing envelope generator 1.
Definition gig.h:290
vcf_cutoff_ctrl_t
Defines how the filter cutoff frequency is controlled by.
Definition gig.h:238
@ vcf_cutoff_ctrl_none2
The difference between none and none2 is unknown.
Definition gig.h:238
@ vcf_cutoff_ctrl_softpedal
Soft Pedal (MIDI Controller 67)
Definition gig.h:238
@ vcf_cutoff_ctrl_aftertouch
Key Pressure.
Definition gig.h:238
@ vcf_cutoff_ctrl_foot
Foot Pedal (Coarse, MIDI Controller 4)
Definition gig.h:238
@ vcf_cutoff_ctrl_genpurpose8
General Purpose Controller 8 (Button, MIDI Controller 83)
Definition gig.h:238
@ vcf_cutoff_ctrl_effect2
Effect Controller 2 (Coarse, MIDI Controller 13)
Definition gig.h:238
@ vcf_cutoff_ctrl_genpurpose7
General Purpose Controller 7 (Button, MIDI Controller 82)
Definition gig.h:238
@ vcf_cutoff_ctrl_effect1
Effect Controller 1 (Coarse, MIDI Controller 12)
Definition gig.h:238
@ vcf_cutoff_ctrl_breath
Breath Controller (Coarse, MIDI Controller 2)
Definition gig.h:238
@ vcf_cutoff_ctrl_sustainpedal
Sustain Pedal (MIDI Controller 64)
Definition gig.h:238
@ vcf_cutoff_ctrl_modwheel
Modulation Wheel (MIDI Controller 1)
Definition gig.h:238
@ vcf_cutoff_ctrl_none
No MIDI controller assigned for filter cutoff frequency.
Definition gig.h:238
size_t enumCount(String typeName)
Amount of elements in given enum type.
Definition typeinfo.cpp:190
lfo_wave_t
Defines the wave form type used by an LFO (gig format extension).
Definition gig.h:173
@ lfo_wave_square
Square wave form.
Definition gig.h:173
@ lfo_wave_triangle
Triangle wave form.
Definition gig.h:173
@ lfo_wave_sine
Sine (sinus) wave form (this is the default wave form).
Definition gig.h:173
@ lfo_wave_saw
Saw (up) wave form (saw down wave form can be achieved by flipping the phase).
Definition gig.h:173
split_type_t
Intended for internal usage: will be used to convert a dimension value into the corresponding dimensi...
Definition gig.h:354
@ split_type_bit
dimension values are already the sought bit number
Definition gig.h:354
@ split_type_normal
dimension value between 0-127
Definition gig.h:354
leverage_ctrl_t attenuation_ctrl_t
Defines controller influencing attenuation.
Definition gig.h:283
loop_type_t
Standard types of sample loops.
Definition gig.h:133
@ loop_type_bidirectional
Alternating loop (forward/backward, also known as Ping Pong)
Definition gig.h:133
@ loop_type_backward
Loop backward (reverse)
Definition gig.h:133
@ loop_type_normal
Loop forward (normal)
Definition gig.h:133
lfo3_ctrl_t
Defines how LFO3 is controlled by.
Definition gig.h:195
@ lfo3_ctrl_internal_aftertouch
Controlled internally and by aftertouch controller.
Definition gig.h:195
@ lfo3_ctrl_internal_modwheel
Controlled internally and by external modulation wheel.
Definition gig.h:195
@ lfo3_ctrl_aftertouch
Only controlled by aftertouch controller.
Definition gig.h:195
@ lfo3_ctrl_modwheel
Only controlled by external modulation wheel.
Definition gig.h:195
@ lfo3_ctrl_internal
Only internally controlled.
Definition gig.h:195
lfo2_ctrl_t
Defines how LFO2 is controlled by.
Definition gig.h:207
@ lfo2_ctrl_internal
Only internally controlled.
Definition gig.h:207
@ lfo2_ctrl_modwheel
Only controlled by external modulation wheel.
Definition gig.h:207
@ lfo2_ctrl_internal_modwheel
Controlled internally and by external modulation wheel.
Definition gig.h:207
@ lfo2_ctrl_foot
Only controlled by external foot controller.
Definition gig.h:207
@ lfo2_ctrl_internal_foot
Controlled internally and by external foot controller.
Definition gig.h:207
leverage_ctrl_t eg2_ctrl_t
Defines controller influencing envelope generator 2.
Definition gig.h:297
const char * enumKey(String typeName, size_t value)
Enum constant name of numeric value.
Definition typeinfo.cpp:280
dimension_t
Defines the type of dimension, that is how the dimension zones (and thus how the dimension regions ar...
Definition gig.h:343
@ dimension_keyboard
Dimension for keyswitching.
Definition gig.h:343
@ dimension_genpurpose5
General Purpose Controller 5 (Button, MIDI Controller 80)
Definition gig.h:343
@ dimension_genpurpose8
General Purpose Controller 8 (Button, MIDI Controller 83)
Definition gig.h:343
@ dimension_roundrobinkeyboard
Different samples triggered each time a note is played, any key advances the counter.
Definition gig.h:343
@ dimension_samplechannel
If used sample has more than one channel (thus is not mono).
Definition gig.h:343
@ dimension_effect1
Effect Controller 1 (Coarse, MIDI Controller 12)
Definition gig.h:343
@ dimension_smartmidi
For MIDI tools like legato and repetition mode.
Definition gig.h:343
@ dimension_breath
Breath Controller (Coarse, MIDI Controller 2)
Definition gig.h:343
@ dimension_genpurpose2
General Purpose Controller 2 (Slider, MIDI Controller 17)
Definition gig.h:343
@ dimension_effect5depth
Effect 5 Depth (MIDI Controller 95)
Definition gig.h:343
@ dimension_genpurpose4
General Purpose Controller 4 (Slider, MIDI Controller 19)
Definition gig.h:343
@ dimension_releasetrigger
Special dimension for triggering samples on releasing a key.
Definition gig.h:343
@ dimension_effect3depth
Effect 3 Depth (MIDI Controller 93)
Definition gig.h:343
@ dimension_sustainpedal
Sustain Pedal (MIDI Controller 64)
Definition gig.h:343
@ dimension_genpurpose7
General Purpose Controller 7 (Button, MIDI Controller 82)
Definition gig.h:343
@ dimension_foot
Foot Pedal (Coarse, MIDI Controller 4)
Definition gig.h:343
@ dimension_effect2
Effect Controller 2 (Coarse, MIDI Controller 13)
Definition gig.h:343
@ dimension_portamento
Portamento (MIDI Controller 65)
Definition gig.h:343
@ dimension_softpedal
Soft Pedal (MIDI Controller 67)
Definition gig.h:343
@ dimension_velocity
Key Velocity (this is the only dimension in gig2 where the ranges can exactly be defined).
Definition gig.h:343
@ dimension_random
Different samples triggered each time a note is played, random order.
Definition gig.h:343
@ dimension_effect1depth
Effect 1 Depth (MIDI Controller 91)
Definition gig.h:343
@ dimension_none
Dimension not in use.
Definition gig.h:343
@ dimension_portamentotime
Portamento Time (Coarse, MIDI Controller 5)
Definition gig.h:343
@ dimension_sostenutopedal
Sostenuto Pedal (MIDI Controller 66)
Definition gig.h:343
@ dimension_effect2depth
Effect 2 Depth (MIDI Controller 92)
Definition gig.h:343
@ dimension_modwheel
Modulation Wheel (MIDI Controller 1)
Definition gig.h:343
@ dimension_roundrobin
Different samples triggered each time a note is played, dimension regions selected in sequence.
Definition gig.h:343
@ dimension_genpurpose3
General Purpose Controller 3 (Slider, MIDI Controller 18)
Definition gig.h:343
@ dimension_layer
For layering of up to 8 instruments (and eventually crossfading of 2 or 4 layers).
Definition gig.h:343
@ dimension_effect4depth
Effect 4 Depth (MIDI Controller 94)
Definition gig.h:343
@ dimension_genpurpose6
General Purpose Controller 6 (Button, MIDI Controller 81)
Definition gig.h:343
@ dimension_channelaftertouch
Channel Key Pressure.
Definition gig.h:343
@ dimension_genpurpose1
General Purpose Controller 1 (Slider, MIDI Controller 16)
Definition gig.h:343
vcf_type_t
Audio filter types.
Definition gig.h:396
@ vcf_type_lowpass_1p
[gig extension]: 1-pole lowpass filter type (LinuxSampler).
Definition gig.h:396
@ vcf_type_lowpassturbo
More poles than normal lowpass (GigaStudio).
Definition gig.h:396
@ vcf_type_highpass_1p
[gig extension]: 1-pole highpass filter type (LinuxSampler).
Definition gig.h:396
@ vcf_type_bandpass
Bandpass filter type (GigaStudio).
Definition gig.h:396
@ vcf_type_bandreject
Band reject filter type (GigaStudio).
Definition gig.h:396
@ vcf_type_lowpass_6p
[gig extension]: 6-pole lowpass filter type (LinuxSampler).
Definition gig.h:396
@ vcf_type_highpass_2p
[gig extension]: 2-pole highpass filter type (LinuxSampler).
Definition gig.h:396
@ vcf_type_highpass
Highpass filter type (GigaStudio).
Definition gig.h:396
@ vcf_type_lowpass_2p
[gig extension]: 2-pole lowpass filter type (LinuxSampler).
Definition gig.h:396
@ vcf_type_highpass_4p
[gig extension]: 4-pole highpass filter type (LinuxSampler).
Definition gig.h:396
@ vcf_type_lowpass_4p
[gig extension]: 4-pole lowpass filter type (LinuxSampler).
Definition gig.h:396
@ vcf_type_bandreject_2p
[gig extension]: 2-pole bandreject filter type (LinuxSampler).
Definition gig.h:396
@ vcf_type_lowpass
Standard lowpass filter type (GigaStudio).
Definition gig.h:396
@ vcf_type_highpass_6p
[gig extension]: 6-pole highpass filter type (LinuxSampler).
Definition gig.h:396
@ vcf_type_bandpass_2p
[gig extension]: 2-pole bandpass filter type (LinuxSampler).
Definition gig.h:396
Quadtuple version number ("major.minor.release.build").
Definition DLS.h:115
Used for indicating the progress of a certain task.
Definition RIFF.h:163
Pointer address and size of a buffer.
Definition gig.h:114
file_offset_t NullExtensionSize
The buffer might be bigger than the actual data, if that's the case that unused space at the end of t...
Definition gig.h:117
void * pStart
Points to the beginning of the buffer.
Definition gig.h:115
file_offset_t Size
Size of the actual data in the buffer in bytes.
Definition gig.h:116
Defines the envelope of a crossfade.
Definition gig.h:405
uint8_t in_end
End position of fade in.
Definition gig.h:413
uint8_t in_start
Start position of fade in.
Definition gig.h:412
uint8_t out_end
End postition of fade out.
Definition gig.h:415
uint8_t out_start
Start position of fade out.
Definition gig.h:414
General dimension definition.
Definition gig.h:357
dimension_t dimension
Specifies which source (usually a MIDI controller) is associated with the dimension.
Definition gig.h:358
uint8_t zones
Number of zones the dimension has.
Definition gig.h:360
uint8_t bits
Number of "bits" (1 bit = 2 splits/zones, 2 bit = 4 splits/zones, 3 bit = 8 splits/zones,...
Definition gig.h:359
float zone_size
Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only,...
Definition gig.h:362
split_type_t split_type
Intended for internal usage: will be used to convert a dimension value into the corresponding dimensi...
Definition gig.h:361
Defines behavior options for envelope generators (gig format extension).
Definition gig.h:451
bool AttackHoldCancel
Whether the "attack hold" stage is cancelled when receiving a note-off (default: true).
Definition gig.h:453
bool Decay1Cancel
Whether the "decay 1" stage is cancelled when receiving a note-off (default: true).
Definition gig.h:454
bool ReleaseCancel
Whether the "release" stage is cancelled when receiving a note-on (default: true).
Definition gig.h:456
bool AttackCancel
Whether the "attack" stage is cancelled when receiving a note-off (default: true).
Definition gig.h:452
bool Decay2Cancel
Whether the "decay 2" stage is cancelled when receiving a note-off (default: true).
Definition gig.h:455
Defines a controller that has a certain contrained influence on a particular synthesis parameter (use...
Definition gig.h:260
type_t
Defines possible controllers.
Definition gig.h:270
@ type_none
No controller defined.
Definition gig.h:270
@ type_velocity
Key Velocity.
Definition gig.h:270
@ type_controlchange
Ordinary MIDI control change controller, see field 'controller_number'.
Definition gig.h:270
@ type_channelaftertouch
Channel Key Pressure.
Definition gig.h:270
uint controller_number
MIDI controller number if this controller is a control change controller, 0 otherwise.
Definition gig.h:273
type_t type
Controller type.
Definition gig.h:272
Reflects the current playback state for a sample.
Definition gig.h:422
bool reverse
If playback direction is currently backwards (in case there is a pingpong or reverse loop defined).
Definition gig.h:424
file_offset_t loop_cycles_left
How many times the loop has still to be passed, this value will be decremented with each loop cycle.
Definition gig.h:425
file_offset_t position
Current position within the sample.
Definition gig.h:423
Lower and upper limit of a range.
Definition gig.h:108
uint8_t high
High value of range.
Definition gig.h:110
uint8_t low
Low value of range.
Definition gig.h:109