libgig  3.3.0.svn4
gig.h
Go to the documentation of this file.
1 /***************************************************************************
2  * *
3  * libgig - C++ cross-platform Gigasampler format file access library *
4  * *
5  * Copyright (C) 2003-2013 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 
29 #if WORDS_BIGENDIAN
30 # define LIST_TYPE_3PRG 0x33707267
31 # define LIST_TYPE_3EWL 0x3365776C
32 # define LIST_TYPE_3GRI 0x33677269
33 # define LIST_TYPE_3GNL 0x33676E6C
34 # define CHUNK_ID_3GIX 0x33676978
35 # define CHUNK_ID_3EWA 0x33657761
36 # define CHUNK_ID_3LNK 0x336C6E6B
37 # define CHUNK_ID_3EWG 0x33657767
38 # define CHUNK_ID_EWAV 0x65776176
39 # define CHUNK_ID_3GNM 0x33676E6D
40 # define CHUNK_ID_EINF 0x65696E66
41 # define CHUNK_ID_3CRC 0x33637263
42 #else // little endian
43 # define LIST_TYPE_3PRG 0x67727033
44 # define LIST_TYPE_3EWL 0x6C776533
45 # define LIST_TYPE_3GRI 0x69726733
46 # define LIST_TYPE_3GNL 0x6C6E6733
47 # define CHUNK_ID_3GIX 0x78696733
48 # define CHUNK_ID_3EWA 0x61776533
49 # define CHUNK_ID_3LNK 0x6B6E6C33
50 # define CHUNK_ID_3EWG 0x67776533
51 # define CHUNK_ID_EWAV 0x76617765
52 # define CHUNK_ID_3GNM 0x6D6E6733
53 # define CHUNK_ID_EINF 0x666E6965
54 # define CHUNK_ID_3CRC 0x63726333
55 #endif // WORDS_BIGENDIAN
56 
58 namespace gig {
59 
60  typedef std::string String;
61 
63  struct range_t {
64  uint8_t low;
65  uint8_t high;
66  };
67 
69  struct buffer_t {
70  void* pStart;
71  unsigned long Size;
72  unsigned long NullExtensionSize;
74  pStart = NULL;
75  Size = 0;
77  }
78  };
79 
81  typedef enum {
82  loop_type_normal = 0x00000000,
83  loop_type_bidirectional = 0x00000001,
84  loop_type_backward = 0x00000002
85  } loop_type_t;
86 
88  typedef enum {
89  smpte_format_no_offset = 0x00000000,
90  smpte_format_24_frames = 0x00000018,
91  smpte_format_25_frames = 0x00000019,
93  smpte_format_30_frames = 0x0000001E
95 
97  typedef enum {
101  curve_type_unknown = 0xffffffff
102  } curve_type_t;
103 
105  typedef enum {
110 
112  typedef enum {
118  } lfo3_ctrl_t;
119 
121  typedef enum {
124  lfo2_ctrl_foot = 0x02,
127  } lfo2_ctrl_t;
128 
130  typedef enum {
136  } lfo1_ctrl_t;
137 
139  typedef enum {
153 
155  typedef enum {
156  vcf_res_ctrl_none = 0xffffffff,
161  } vcf_res_ctrl_t;
162 
172  typedef enum {
173  type_none = 0x00,
175  type_velocity = 0xff,
177  } type_t;
178 
181  };
182 
189 
196 
203 
211  typedef enum {
212  dimension_none = 0x00,
225  dimension_foot = 0x04,
246  } dimension_t;
247 
252  typedef enum {
255  } split_type_t;
256 
260  uint8_t bits;
261  uint8_t zones;
263  float zone_size;
264  };
265 
267  typedef enum {
273  } vcf_type_t;
274 
282  struct crossfade_t {
283  #if WORDS_BIGENDIAN
284  uint8_t out_end;
285  uint8_t out_start;
286  uint8_t in_end;
287  uint8_t in_start;
288  #else // little endian
289  uint8_t in_start;
290  uint8_t in_end;
291  uint8_t out_start;
292  uint8_t out_end;
293  #endif // WORDS_BIGENDIAN
294  };
295 
298  unsigned long position;
299  bool reverse;
300  unsigned long loop_cycles_left;
301  };
302 
315  struct progress_t {
316  void (*callback)(progress_t*);
317  float factor;
318  void* custom;
319  float __range_min;
320  float __range_max;
321  progress_t();
322  };
323 
324  // just symbol prototyping
325  class File;
326  class Instrument;
327  class Sample;
328  class Region;
329  class Group;
330 
343  class DimensionRegion : protected DLS::Sampler {
344  public:
347  // Sample Amplitude EG/LFO
348  uint16_t EG1PreAttack;
349  double EG1Attack;
350  double EG1Decay1;
351  double EG1Decay2;
353  uint16_t EG1Sustain;
354  double EG1Release;
355  bool EG1Hold;
361  double LFO1Frequency;
362  uint16_t LFO1InternalDepth;
363  uint16_t LFO1ControlDepth;
366  bool LFO1Sync;
367  // Filter Cutoff Frequency EG/LFO
368  uint16_t EG2PreAttack;
369  double EG2Attack;
370  double EG2Decay1;
371  double EG2Decay2;
373  uint16_t EG2Sustain;
374  double EG2Release;
380  double LFO2Frequency;
381  uint16_t LFO2InternalDepth;
382  uint16_t LFO2ControlDepth;
385  bool LFO2Sync;
386  // Sample Pitch EG/LFO
387  double EG3Attack;
388  int16_t EG3Depth;
389  double LFO3Frequency;
393  bool LFO3Sync;
394  // Filter
395  bool VCFEnabled;
399  uint8_t VCFCutoff;
403  uint8_t VCFResonance;
408  // Key Velocity Transformations
415  // Mix / Layer
417  bool PitchTrack;
419  int8_t Pan;
420  bool SelfMask;
424  uint8_t ChannelOffset;
426  bool MSDecode;
427  uint16_t SampleStartOffset;
429  uint8_t DimensionUpperLimits[8];
430 
431  // derived attributes from DLS::Sampler
434  using DLS::Sampler::Gain;
437 
438  // own methods
439  double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
440  double GetVelocityRelease(uint8_t MIDIKeyVelocity);
441  double GetVelocityCutoff(uint8_t MIDIKeyVelocity);
443  void SetVelocityResponseDepth(uint8_t depth);
444  void SetVelocityResponseCurveScaling(uint8_t scaling);
446  void SetReleaseVelocityResponseDepth(uint8_t depth);
447  void SetVCFCutoffController(vcf_cutoff_ctrl_t controller);
448  void SetVCFVelocityCurve(curve_type_t curve);
449  void SetVCFVelocityDynamicRange(uint8_t range);
450  void SetVCFVelocityScale(uint8_t scaling);
451  Region* GetParent() const;
452  // derived methods
455  // overridden methods
456  virtual void SetGain(int32_t gain);
457  virtual void UpdateChunks();
458  virtual void CopyAssign(const DimensionRegion* orig);
459  protected:
460  uint8_t* VelocityTable;
461  DimensionRegion(Region* pParent, RIFF::List* _3ewl);
462  DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src);
464  friend class Region;
465  private:
466  typedef enum {
467  _lev_ctrl_none = 0x00,
468  _lev_ctrl_modwheel = 0x03,
469  _lev_ctrl_breath = 0x05,
470  _lev_ctrl_foot = 0x07,
471  _lev_ctrl_effect1 = 0x0d,
472  _lev_ctrl_effect2 = 0x0f,
473  _lev_ctrl_genpurpose1 = 0x11,
474  _lev_ctrl_genpurpose2 = 0x13,
475  _lev_ctrl_genpurpose3 = 0x15,
476  _lev_ctrl_genpurpose4 = 0x17,
477  _lev_ctrl_portamentotime = 0x0b,
478  _lev_ctrl_sustainpedal = 0x01,
479  _lev_ctrl_portamento = 0x19,
480  _lev_ctrl_sostenutopedal = 0x1b,
481  _lev_ctrl_softpedal = 0x09,
482  _lev_ctrl_genpurpose5 = 0x1d,
483  _lev_ctrl_genpurpose6 = 0x1f,
484  _lev_ctrl_genpurpose7 = 0x21,
485  _lev_ctrl_genpurpose8 = 0x23,
486  _lev_ctrl_effect1depth = 0x25,
487  _lev_ctrl_effect2depth = 0x27,
488  _lev_ctrl_effect3depth = 0x29,
489  _lev_ctrl_effect4depth = 0x2b,
490  _lev_ctrl_effect5depth = 0x2d,
491  _lev_ctrl_channelaftertouch = 0x2f,
492  _lev_ctrl_velocity = 0xff
493  } _lev_ctrl_t;
494  typedef std::map<uint32_t, double*> VelocityTableMap;
495 
496  static uint Instances;
497  static VelocityTableMap* pVelocityTables;
498  double* pVelocityAttenuationTable;
499  double* pVelocityReleaseTable;
500  double* pVelocityCutoffTable;
501  Region* pRegion;
502 
503  leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
504  _lev_ctrl_t EncodeLeverageController(leverage_ctrl_t DecodedController);
505  double* GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth);
506  double* GetCutoffVelocityTable(curve_type_t vcfVelocityCurve, uint8_t vcfVelocityDynamicRange, uint8_t vcfVelocityScale, vcf_cutoff_ctrl_t vcfCutoffController);
507  double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
508  double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
509  };
510 
526  class Sample : public DLS::Sample {
527  public:
528  uint32_t Manufacturer;
529  uint32_t Product;
530  uint32_t SamplePeriod;
531  uint32_t MIDIUnityNote;
532  uint32_t FineTune;
534  uint32_t SMPTEOffset;
535  uint32_t Loops;
536  uint32_t LoopID;
538  uint32_t LoopStart;
539  uint32_t LoopEnd;
540  uint32_t LoopSize;
541  uint32_t LoopFraction;
542  uint32_t LoopPlayCount;
543  bool Compressed;
544  uint32_t TruncatedBits;
545  bool Dithered;
546 
547  // own methods
549  buffer_t LoadSampleData(unsigned long SampleCount);
550  buffer_t LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
551  buffer_t LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);
552  buffer_t GetCache();
553  // own static methods
554  static buffer_t CreateDecompressionBuffer(unsigned long MaxReadSize);
555  static void DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);
556  // overridden methods
557  void ReleaseSampleData();
558  void Resize(int iNewSize);
559  unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
560  unsigned long GetPos();
561  unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
562  unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer = NULL);
563  unsigned long Write(void* pBuffer, unsigned long SampleCount);
564  Group* GetGroup() const;
565  virtual void UpdateChunks();
566  protected:
567  static unsigned int Instances;
570  unsigned long FrameOffset;
571  unsigned long* FrameTable;
572  unsigned long SamplePos;
573  unsigned long SamplesInLastFrame;
574  unsigned long WorstCaseFrameSize;
575  unsigned long SamplesPerFrame;
577  unsigned long FileNo;
580  uint32_t crc;
581 
582  Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo = 0);
583  ~Sample();
584 
585  // Guess size (in bytes) of a compressed sample
586  inline unsigned long GuessSize(unsigned long samples) {
587  // 16 bit: assume all frames are compressed - 1 byte
588  // per sample and 5 bytes header per 2048 samples
589 
590  // 24 bit: assume next best compression rate - 1.5
591  // bytes per sample and 13 bytes header per 256
592  // samples
593  const unsigned long size =
594  BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
595  : samples + (samples >> 10) * 5;
596  // Double for stereo and add one worst case sample
597  // frame
598  return (Channels == 2 ? size << 1 : size) + WorstCaseFrameSize;
599  }
600 
601  // Worst case amount of sample points that can be read with the
602  // given decompression buffer.
603  inline unsigned long WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
604  return (unsigned long) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
605  }
606  private:
607  void ScanCompressedSample();
608  friend class File;
609  friend class Region;
610  friend class Group; // allow to modify protected member pGroup
611  };
612 
613  // TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions)
615  class Region : public DLS::Region {
616  public:
617  unsigned int Dimensions;
619  uint32_t DimensionRegions;
621  unsigned int Layers;
622 
623  // own methods
624  DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);
625  DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);
626  Sample* GetSample();
627  void AddDimension(dimension_def_t* pDimDef);
628  void DeleteDimension(dimension_def_t* pDimDef);
629  // overridden methods
630  virtual void SetKeyRange(uint16_t Low, uint16_t High);
631  virtual void UpdateChunks();
632  virtual void CopyAssign(const Region* orig);
633  protected:
634  Region(Instrument* pInstrument, RIFF::List* rgnList);
635  void LoadDimensionRegions(RIFF::List* rgn);
636  void UpdateVelocityTable();
637  Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
638  ~Region();
639  friend class Instrument;
640  };
641 
643  class MidiRule {
644  public:
645  virtual ~MidiRule() { }
646  protected:
647  virtual void UpdateChunks(uint8_t* pData) const = 0;
648  friend class Instrument;
649  };
650 
652  class MidiRuleCtrlTrigger : public MidiRule {
653  public:
655  uint8_t Triggers;
656  struct trigger_t {
657  uint8_t TriggerPoint;
658  bool Descending;
659  uint8_t VelSensitivity;
660  uint8_t Key;
661  bool NoteOff;
662  uint8_t Velocity;
664  } pTriggers[32];
665 
666  protected:
669  void UpdateChunks(uint8_t* pData) const;
670  friend class Instrument;
671  };
672 
674  class MidiRuleLegato : public MidiRule {
675  public:
676  uint8_t LegatoSamples;
678  uint8_t BypassKey;
680  uint16_t ThresholdTime;
681  uint16_t ReleaseTime;
684  uint8_t AltSustain1Key;
685  uint8_t AltSustain2Key;
686 
687  protected:
688  MidiRuleLegato(RIFF::Chunk* _3ewg);
689  MidiRuleLegato();
690  void UpdateChunks(uint8_t* pData) const;
691  friend class Instrument;
692  };
693 
695  class MidiRuleAlternator : public MidiRule {
696  public:
697  uint8_t Articulations;
699 
701 
702  uint8_t Patterns;
703  struct pattern_t {
705  int Size;
706  const uint8_t& operator[](int i) const {
707  return data[i];
708  }
709  uint8_t& operator[](int i) {
710  return data[i];
711  }
712  private:
713  uint8_t data[32];
714  } pPatterns[32];
715 
716  typedef enum {
720  } selector_t;
723  uint8_t Controller;
724 
725  bool Polyphonic;
726  bool Chained;
727 
728  protected:
731  void UpdateChunks(uint8_t* pData) const;
732  friend class Instrument;
733  };
734 
736  class MidiRuleUnknown : public MidiRule {
737  protected:
739  void UpdateChunks(uint8_t* pData) const { }
740  friend class Instrument;
741  };
742 
744  class Instrument : protected DLS::Instrument {
745  public:
746  // derived attributes from DLS::Resource
747  using DLS::Resource::pInfo;
748  using DLS::Resource::pDLSID;
749  // derived attributes from DLS::Instrument
756  // own attributes
757  int32_t Attenuation;
758  uint16_t EffectSend;
759  int16_t FineTune;
760  uint16_t PitchbendRange;
763 
764 
765  // derived methods from DLS::Resource
767  // overridden methods
770  Region* AddRegion();
771  void DeleteRegion(Region* pRegion);
772  virtual void UpdateChunks();
773  virtual void CopyAssign(const Instrument* orig);
774  // own methods
775  Region* GetRegion(unsigned int Key);
776  MidiRule* GetMidiRule(int i);
780  void DeleteMidiRule(int i);
781  protected:
783 
784  Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);
785  ~Instrument();
786  void UpdateRegionKeyTable();
787  friend class File;
788  friend class Region; // so Region can call UpdateRegionKeyTable()
789  private:
790  MidiRule** pMidiRules;
791  };
792 
808  class Group {
809  public:
811 
814  void AddSample(Sample* pSample);
815  protected:
816  Group(File* file, RIFF::Chunk* ck3gnm);
817  virtual ~Group();
818  virtual void UpdateChunks();
819  void MoveAll();
820  friend class File;
821  private:
822  File* pFile;
823  RIFF::Chunk* pNameChunk;
824  };
825 
827  class File : protected DLS::File {
828  public:
829  static const DLS::version_t VERSION_2;
830  static const DLS::version_t VERSION_3;
831 
832  // derived attributes from DLS::Resource
833  using DLS::Resource::pInfo;
834  using DLS::Resource::pDLSID;
835  // derived attributes from DLS::File
836  using DLS::File::pVersion;
838 
839  // derived methods from DLS::Resource
841  // derived methods from DLS::File
842  using DLS::File::Save;
844  // overridden methods
845  File();
847  Sample* GetFirstSample(progress_t* pProgress = NULL);
848  Sample* GetNextSample();
849  Sample* AddSample();
850  void DeleteSample(Sample* pSample);
853  Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
856  void DeleteInstrument(Instrument* pInstrument);
857  Group* GetFirstGroup();
858  Group* GetNextGroup();
859  Group* GetGroup(uint index);
860  Group* AddGroup();
861  void DeleteGroup(Group* pGroup);
862  void DeleteGroupOnly(Group* pGroup);
863  void SetAutoLoad(bool b);
864  bool GetAutoLoad();
865  virtual ~File();
866  virtual void UpdateChunks();
867  protected:
868  // overridden protected methods from DLS::File
869  virtual void LoadSamples();
870  virtual void LoadInstruments();
871  virtual void LoadGroups();
872  // own protected methods
873  virtual void LoadSamples(progress_t* pProgress);
874  virtual void LoadInstruments(progress_t* pProgress);
875  void SetSampleChecksum(Sample* pSample, uint32_t crc);
876  friend class Region;
877  friend class Sample;
878  friend class Group; // so Group can access protected member pRIFF
879  private:
880  std::list<Group*>* pGroups;
881  std::list<Group*>::iterator GroupsIterator;
882  bool bAutoLoad;
883  };
884 
893  class Exception : public DLS::Exception {
894  public:
896  void PrintMessage();
897  };
898 
901 
902 } // namespace gig
903 
904 #endif // __GIG_H__
range_t KeySwitchRange
Key range for key switch selector.
Definition: gig.h:722
bool LFO2FlipPhase
Inverts phase of the filter cutoff LFO wave.
Definition: gig.h:384
void UpdateRegionKeyTable()
Definition: gig.cpp:3251
General Purpose Controller 4 (Slider, MIDI Controller 19)
Definition: gig.h:232
void MoveAll()
Move all members of this group to another group (preferably the 1st one except this).
Definition: gig.cpp:3603
dim_bypass_ctrl_t DimensionBypass
If defined, the MIDI controller can switch on/off the dimension in realtime.
Definition: gig.h:418
~Instrument()
Destructor.
Definition: gig.cpp:3263
Encapsulates articulation information of a dimension region.
Definition: gig.h:343
range_t DimensionKeyRange
0-127 (where 0 means C1 and 127 means G9)
Definition: gig.h:762
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:351
uint8_t VCFVelocityScale
(0-127) Amount velocity controls VCF cutoff frequency (only if no other VCF cutoff controller is defi...
Definition: gig.h:401
unsigned long FrameOffset
Current offset (sample points) in current sample frame (for decompression only).
Definition: gig.h:570
bool reverse
If playback direction is currently backwards (in case there is a pingpong or reverse loop defined)...
Definition: gig.h:299
Only controlled by aftertouch controller.
Definition: gig.h:115
25 frames per second
Definition: gig.h:91
uint8_t AltSustain2Key
Key triggering a second set of alternate sustain samples.
Definition: gig.h:685
uint32_t Regions
Reflects the number of Region defintions this Instrument has.
Definition: DLS.h:443
Region * GetRegion(unsigned int Key)
Returns the appropriate Region for a triggered note.
Definition: gig.cpp:3332
void AddSample(Sample *pSample)
Move Sample given by pSample from another Group to this Group.
Definition: gig.cpp:3593
virtual void UpdateChunks()
Apply dimension region settings to the respective RIFF chunks.
Definition: gig.cpp:1652
Effect Controller 2 (Coarse, MIDI Controller 13)
Definition: gig.h:144
MidiRuleAlternator * AddMidiRuleAlternator()
Adds the alternator MIDI rule to the instrument.
Definition: gig.cpp:3436
Sample * AddSample()
Add a new sample.
Definition: gig.cpp:3709
bool VCFEnabled
If filter should be used.
Definition: gig.h:395
Controlled internally and by external modulation wheel.
Definition: gig.h:116
Controlled internally and by aftertouch controller.
Definition: gig.h:117
Parses DLS Level 1 and 2 compliant files and provides abstract access to the data.
Definition: DLS.h:473
no SMPTE offset
Definition: gig.h:89
void AddDimension(dimension_def_t *pDimDef)
Einstein would have dreamed of it - create a new dimension.
Definition: gig.cpp:2669
stream_whence_t
File stream position dependent to these relations.
Definition: RIFF.h:158
Soft Pedal (MIDI Controller 67)
Definition: gig.h:148
uint32_t FineTune
Specifies the fraction of a semitone up from the specified MIDI unity note field. A value of 0x800000...
Definition: gig.h:532
uint8_t BypassKey
Key to be used to bypass the sustain note.
Definition: gig.h:678
uint16_t LFO1ControlDepth
Controller depth influencing sample amplitude LFO pitch (0 - 1200 cents).
Definition: gig.h:363
lfo1_ctrl_t
Defines how LFO1 is controlled by.
Definition: gig.h:130
Group of Gigasampler objects.
Definition: gig.h:808
uint8_t VCFVelocityDynamicRange
0x04 = lowest, 0x00 = highest .
Definition: gig.h:402
String Name
Stores the name of this Group.
Definition: gig.h:810
DimensionRegion * GetDimensionRegionByBit(const uint8_t DimBits[8])
Returns the appropriate DimensionRegion for the given dimension bit numbers (zone index)...
Definition: gig.cpp:2926
Special dimension for triggering samples on releasing a key.
Definition: gig.h:217
uint16_t PitchbendRange
Number of semitones pitchbend controller can pitch (default is 2).
Definition: gig.h:760
virtual void UpdateChunks()
Apply all the gig file&#39;s current instruments, samples, groups and settings to the respective RIFF chu...
Definition: gig.cpp:4111
double EG1Release
Release time of the sample amplitude EG (0.000 - 60.000s).
Definition: gig.h:354
unsigned long ReadAndLoop(void *pBuffer, unsigned long 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:850
virtual ~File()
Definition: gig.cpp:3677
Only internally controlled.
Definition: gig.h:113
uint8_t Triggers
Number of triggers.
Definition: gig.h:655
virtual void UpdateChunks()
Apply Instrument with all its Regions to the respective RIFF chunks.
Definition: gig.cpp:3279
vcf_type_t VCFType
Defines the general filter characteristic (lowpass, highpass, bandpass, etc.).
Definition: gig.h:396
Effect Controller 1 (Coarse, MIDI Controller 12)
Definition: gig.h:227
uint32_t LoopSize
Caution: Use the respective fields in the DimensionRegion instead of this one! (Intended purpose: Len...
Definition: gig.h:540
void(* callback)(progress_t *)
Callback function pointer which has to be assigned to a function for progress notification.
Definition: gig.h:316
Instrument * AddInstrument()
Add a new instrument definition.
Definition: gig.cpp:3877
Controlled internally and by external modulation wheel.
Definition: gig.h:125
loop_type_t LoopType
Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The ...
Definition: gig.h:537
lfo1_ctrl_t LFO1Controller
MIDI Controller which controls sample amplitude LFO.
Definition: gig.h:364
Group * AddGroup()
Definition: gig.cpp:4021
Effect 2 Depth (MIDI Controller 92)
Definition: gig.h:242
Effect Controller 1 (Coarse, MIDI Controller 12)
Definition: gig.h:143
Only internally controlled.
Definition: gig.h:122
Sample * GetFirstSample()
Returns a pointer to the first Sample object of the file, NULL otherwise.
Definition: DLS.cpp:1435
uint8_t low
Low value of range.
Definition: gig.h:64
Modulation Wheel (MIDI Controller 1)
Definition: gig.h:223
Will be thrown whenever a DLS specific error occurs while trying to access a DLS File.
Definition: DLS.h:526
uint16_t SampleStartOffset
Number of samples the sample start should be moved (0 - 2000).
Definition: gig.h:427
MIDI rule for triggering notes by control change events.
Definition: gig.h:652
30 frames per second
Definition: gig.h:93
uint8_t Key
Key to trigger.
Definition: gig.h:660
unsigned long WorstCaseFrameSize
For compressed samples only: size (in bytes) of the largest possible sample frame.
Definition: gig.h:574
bool EG1Hold
If true, Decay1 stage should be postponed until the sample reached the sample loop start...
Definition: gig.h:355
range_t PlayRange
Key range of the playable keys in the instrument.
Definition: gig.h:700
void UpdateChunks(uint8_t *pData) const
Definition: gig.h:739
uint16_t ThresholdTime
Maximum time (ms) between two notes that should be played legato.
Definition: gig.h:680
const uint8_t & operator[](int i) const
Definition: gig.h:706
RIFF::Chunk * pCk3gix
Definition: gig.h:578
dimension values are already the sought bit number
Definition: gig.h:254
uint8_t VelocityResponseCurveScaling
0 - 127 (usually you don&#39;t have to interpret this parameter, use GetVelocityAttenuation() instead)...
Definition: gig.h:411
bool Descending
If the change in CC value should be downwards.
Definition: gig.h:658
double GetVelocityCutoff(uint8_t MIDIKeyVelocity)
Definition: gig.cpp:2238
unsigned long Size
Size of the actual data in the buffer in bytes.
Definition: gig.h:71
Effect 1 Depth (MIDI Controller 91)
Definition: gig.h:241
Instrument * GetFirstInstrument()
Returns a pointer to the first Instrument object of the file, NULL otherwise.
Definition: gig.cpp:3820
Breath Controller (Coarse, MIDI Controller 2)
Definition: gig.h:145
Region * RegionKeyTable[128]
fast lookup for the corresponding Region of a MIDI key
Definition: gig.h:782
uint8_t ReleaseTriggerKey
Key triggering release samples.
Definition: gig.h:683
Sample(File *pFile, RIFF::List *waveList, unsigned long WavePoolOffset, unsigned long fileNo=0)
Constructor.
Definition: gig.cpp:369
For MIDI tools like legato and repetition mode.
Definition: gig.h:221
bool VCFKeyboardTracking
If true: VCF cutoff frequence will be dependend to the note key position relative to the defined brea...
Definition: gig.h:406
uint32_t WavePoolTableIndex
Definition: DLS.h:425
uint8_t Velocity
Velocity of the note to trigger. 255 means that velocity should depend on the speed of the controller...
Definition: gig.h:662
uint32_t crc
CRC-32 checksum of the raw sample data.
Definition: gig.h:580
Defines a controller that has a certain contrained influence on a particular synthesis parameter (use...
Definition: gig.h:171
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:377
uint8_t Controller
CC number for controller selector.
Definition: gig.h:723
void SetVCFVelocityScale(uint8_t scaling)
Updates the respective member variable and the lookup table / cache that depends on this value...
Definition: gig.cpp:2327
Defines Region information of an Instrument.
Definition: gig.h:615
Only controlled by external modulation wheel.
Definition: gig.h:123
unsigned long GetPos()
Returns the current position in the sample (in sample points).
Definition: gig.cpp:811
void UpdateVelocityTable()
Definition: gig.cpp:2584
unsigned long SamplesPerFrame
For compressed samples only: number of samples in a full sample frame.
Definition: gig.h:575
uint32_t LoopPlayCount
Number of times the loop should be played (a value of 0 = infinite).
Definition: gig.h:542
uint8_t ReleaseTriggerDecay
0 - 8
Definition: gig.h:414
lfo3_ctrl_t LFO3Controller
MIDI Controller which controls the sample pitch LFO.
Definition: gig.h:392
static unsigned int Instances
Number of instances of class Sample.
Definition: gig.h:567
bool Chained
If all patterns should be chained together.
Definition: gig.h:726
uint32_t MIDIUnityNote
Specifies the musical note at which the sample will be played at it&#39;s original sample rate...
Definition: gig.h:531
int16_t FineTune
Definition: DLS.h:346
uint8_t ControllerNumber
MIDI controller number.
Definition: gig.h:654
Portamento (MIDI Controller 65)
Definition: gig.h:234
uint8_t ChannelOffset
Audio output where the audio signal of the dimension region should be routed to (0 - 9)...
Definition: gig.h:424
void Resize(int iNewSize)
Resize sample.
Definition: gig.cpp:751
General Purpose Controller 6 (Button, MIDI Controller 81)
Definition: gig.h:238
uint8_t VCFResonance
Firm internal filter resonance weight.
Definition: gig.h:403
bool VCFResonanceDynamic
If true: Increases the resonance Q according to changes of controllers that actually control the VCF ...
Definition: gig.h:404
void DeleteMidiRule(int i)
Deletes a MIDI rule from the instrument.
Definition: gig.cpp:3449
unsigned int Dimensions
Number of defined dimensions, do not alter!
Definition: gig.h:617
Only controlled by external modulation wheel.
Definition: gig.h:114
void UpdateChunks(uint8_t *pData) const
Definition: gig.cpp:3135
vcf_cutoff_ctrl_t VCFCutoffController
Specifies which external controller has influence on the filter cutoff frequency. ...
Definition: gig.h:397
uint16_t MIDIBank
Reflects combination of MIDIBankCoarse and MIDIBankFine (bank 1 - bank 16384). Do not change this val...
Definition: DLS.h:439
MidiRuleCtrlTrigger * AddMidiRuleCtrlTrigger()
Adds the &quot;controller trigger&quot; MIDI rule to the instrument.
Definition: gig.cpp:3410
Foot Pedal (Coarse, MIDI Controller 4)
Definition: gig.h:146
double EG1Decay1
Decay time of the sample amplitude EG (0.000 - 60.000s).
Definition: gig.h:350
float __range_min
Only for internal usage, do not modify!
Definition: gig.h:319
DimensionRegion * GetDimensionRegionByValue(const uint DimValues[8])
Use this method in your audio engine to get the appropriate dimension region with it&#39;s articulation d...
Definition: gig.cpp:2869
virtual void UpdateChunks()
Apply Region settings and all its DimensionRegions to the respective RIFF chunks. ...
Definition: gig.cpp:2496
lfo2_ctrl_t LFO2Controller
MIDI Controlle which controls the filter cutoff LFO.
Definition: gig.h:383
void LoadDimensionRegions(RIFF::List *rgn)
Definition: gig.cpp:2561
Different samples triggered each time a note is played, any key advances the counter.
Definition: gig.h:222
bool Dithered
For 24-bit compressed samples only: if dithering was used during compression with bit reduction...
Definition: gig.h:545
Region * GetFirstRegion()
Returns the first Region of the instrument.
Definition: gig.cpp:3350
String libraryVersion()
Returns version of this C++ library.
Definition: gig.cpp:4333
uint8_t VelocityUpperLimit
Defines the upper velocity value limit of a velocity split (only if an user defined limit was set...
Definition: gig.h:345
uint8_t ReleaseVelocityResponseDepth
Dynamic range of release velocity affecting envelope time (0 - 4).
Definition: gig.h:413
Will be thrown whenever a gig specific error occurs while trying to access a Gigasampler File...
Definition: gig.h:893
buffer_t LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount)
Loads (and uncompresses if needed) the whole sample wave into RAM.
Definition: gig.cpp:640
Group * GetGroup() const
Returns pointer to the Group this Sample belongs to.
Definition: gig.cpp:1291
Instrument(File *pFile, RIFF::List *insList, progress_t *pProgress=NULL)
Definition: gig.cpp:3169
Used for indicating the progress of a certain task.
Definition: gig.h:315
uint8_t MIDIBankCoarse
Reflects the MIDI Bank number for MIDI Control Change 0 (bank 1 - 128).
Definition: DLS.h:440
uint8_t in_end
End position of fade in.
Definition: gig.h:290
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:2300
unsigned long WorstCaseMaxSamples(buffer_t *pDecompressionBuffer)
Definition: gig.h:603
static const DLS::version_t VERSION_2
Reflects Gigasampler file format version 2.0 (1998-06-28).
Definition: gig.h:829
Sample * pSample
Points to the Sample which is assigned to the dimension region.
Definition: gig.h:346
buffer_t LoadSampleData()
Loads (and uncompresses if needed) the whole sample wave into RAM.
Definition: gig.cpp:591
uint16_t ReleaseTime
Release time.
Definition: gig.h:681
smpte_format_t
Society of Motion Pictures and Television E time format.
Definition: gig.h:88
uint32_t LoopStart
Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The ...
Definition: gig.h:538
Group * GetNextGroup()
Returns a pointer to the next Group object of the file, NULL otherwise.
Definition: gig.cpp:3999
Loop forward (normal)
Definition: gig.h:82
void SetVCFVelocityCurve(curve_type_t curve)
Updates the respective member variable and the lookup table / cache that depends on this value...
Definition: gig.cpp:2309
double EG2Decay1
Decay time of the filter cutoff EG (0.000 - 60.000s).
Definition: gig.h:370
uint8_t EG1ControllerAttackInfluence
Amount EG1 Controller has influence on the EG1 Attack time (0 - 3, where 0 means off).
Definition: gig.h:358
unsigned long position
Current position within the sample.
Definition: gig.h:298
String pArticulations[32]
Names of the articulations.
Definition: gig.h:698
Only controlled by external foot controller.
Definition: gig.h:124
crossfade_t Crossfade
Definition: gig.h:416
void SetAutoLoad(bool b)
Enable / disable automatic loading.
Definition: gig.cpp:4292
MidiRule * GetMidiRule(int i)
Returns a MIDI rule of the instrument.
Definition: gig.cpp:3401
void DeleteSampleLoop(sample_loop_t *pLoopDef)
Deletes an existing sample loop.
Definition: DLS.cpp:645
smpte_format_t SMPTEFormat
Specifies the Society of Motion Pictures and Television E time format used in the following SMPTEOffs...
Definition: gig.h:533
double SampleAttenuation
Sample volume (calculated from DLS::Sampler::Gain)
Definition: gig.h:428
File()
Definition: gig.cpp:3655
lfo3_ctrl_t
Defines how LFO3 is controlled by.
Definition: gig.h:112
Channel Key Pressure.
Definition: gig.h:216
RIFF List Chunk.
Definition: RIFF.h:273
Sustain Pedal (MIDI Controller 64)
Definition: gig.h:147
double EG1Decay2
Only if EG1InfiniteSustain == false: 2nd decay stage time of the sample amplitude EG (0...
Definition: gig.h:351
bool PianoReleaseMode
Definition: gig.h:761
uint8_t BypassController
Controller to be used to bypass the sustain note.
Definition: gig.h:679
attenuation_ctrl_t AttenuationController
MIDI Controller which has influence on the volume level of the sample (or entire sample group)...
Definition: gig.h:421
float __range_max
Only for internal usage, do not modify!
Definition: gig.h:320
static buffer_t InternalDecompressionBuffer
Buffer used for decompression as well as for truncation of 24 Bit -&gt; 16 Bit samples.
Definition: gig.h:568
static void DestroyDecompressionBuffer(buffer_t &DecompressionBuffer)
Free decompression buffer, previously created with CreateDecompressionBuffer().
Definition: gig.cpp:1274
Pointer address and size of a buffer.
Definition: gig.h:69
virtual void LoadSamples()
Definition: gig.cpp:3760
uint8_t in_start
Start position of fade in.
Definition: gig.h:289
uint8_t Patterns
Number of alternator patterns.
Definition: gig.h:702
unsigned long Read(void *pBuffer, unsigned long SampleCount, buffer_t *pExternalDecompressionBuffer=NULL)
Reads SampleCount number of sample points from the current position into the buffer pointed by pBuffe...
Definition: gig.cpp:1025
dimension_t dimension
Specifies which source (usually a MIDI controller) is associated with the dimension.
Definition: gig.h:259
Abstract base class which provides mandatory informations about sample players in general...
Definition: DLS.h:343
loop_type_t
Standard types of sample loops.
Definition: gig.h:81
range_t KeyRange
Key range for legato notes.
Definition: gig.h:682
Sustain Pedal (MIDI Controller 64)
Definition: gig.h:233
unsigned long SamplesInLastFrame
For compressed samples only: length of the last sample frame.
Definition: gig.h:573
bool EG2ControllerInvert
Invert values coming from defined EG2 controller.
Definition: gig.h:376
uint8_t Articulations
Number of articulations in the instrument.
Definition: gig.h:697
Group * GetFirstGroup()
Returns a pointer to the first Group object of the file, NULL otherwise.
Definition: gig.cpp:3992
Group * GetGroup(uint index)
Returns the group with the given index.
Definition: gig.cpp:4011
buffer_t()
Definition: gig.h:73
uint8_t VelSensitivity
How sensitive the velocity should be to the speed of the controller change.
Definition: gig.h:659
uint32_t DimensionRegions
Total number of DimensionRegions this Region contains, do not alter!
Definition: gig.h:619
Instrument * AddDuplicateInstrument(const Instrument *orig)
Add a duplicate of an existing instrument.
Definition: gig.cpp:3914
std::string String
Definition: gig.h:60
bool MSDecode
Gigastudio flag: defines if Mid Side Recordings should be decoded.
Definition: gig.h:426
Key Velocity (this is the only dimension in gig2 where the ranges can exactly be defined).
Definition: gig.h:215
bool EG1InfiniteSustain
If true, instead of going into Decay2 phase, Decay1 level will be hold until note will be released...
Definition: gig.h:352
bool Compressed
If the sample wave is compressed (probably just interesting for instrument and sample editors...
Definition: gig.h:543
void ReleaseSampleData()
Frees the cached sample from RAM if loaded with LoadSampleData() previously.
Definition: gig.cpp:714
General Purpose Controller 3 (Slider, MIDI Controller 18)
Definition: gig.h:231
uint32_t SampleLoops
Reflects the number of sample loops.
Definition: DLS.h:350
More poles than normal lowpass.
Definition: gig.h:269
uint16_t LFO2InternalDepth
Firm pitch of the filter cutoff LFO (0 - 1200 cents).
Definition: gig.h:381
uint16_t LFO1InternalDepth
Firm pitch of the sample amplitude LFO (0 - 1200 cents).
Definition: gig.h:362
The difference between none and none2 is unknown.
Definition: gig.h:141
Controlled internally and by external breath controller.
Definition: gig.h:135
virtual void LoadInstruments()
Definition: gig.cpp:3936
float zone_size
Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only...
Definition: gig.h:263
String Message
Definition: RIFF.h:370
Only controlled by external breath controller.
Definition: gig.h:133
bool PitchTrack
If true: sample will be pitched according to the key position (this will be disabled for drums for ex...
Definition: gig.h:417
double GetVelocityRelease(uint8_t MIDIKeyVelocity)
Definition: gig.cpp:2234
unsigned long Write(void *pBuffer, unsigned long SampleCount)
Write sample wave data.
Definition: gig.cpp:1214
bool BypassUseController
If a controller should be used to bypass the sustain note.
Definition: gig.h:677
unsigned int Layers
Amount of defined layers (1 - 32). A value of 1 actually means no layering, a value &gt; 1 means there i...
Definition: gig.h:621
void * pStart
Points to the beginning of the buffer.
Definition: gig.h:70
bool EG2InfiniteSustain
If true, instead of going into Decay2 phase, Decay1 level will be hold until note will be released...
Definition: gig.h:372
Region * AddRegion()
Definition: gig.cpp:3370
General Purpose Controller 4 (Slider, MIDI Controller 19)
Definition: gig.h:158
unsigned long SamplePos
For compressed samples only: stores the current position (in sample points).
Definition: gig.h:572
Group * pGroup
pointer to the Group this sample belongs to (always not-NULL)
Definition: gig.h:569
struct gig::MidiRuleAlternator::pattern_t pPatterns[32]
A pattern is a sequence of articulation numbers.
virtual ~MidiRule()
Definition: gig.h:645
Effect 4 Depth (MIDI Controller 94)
Definition: gig.h:244
Breath Controller (Coarse, MIDI Controller 2)
Definition: gig.h:224
MidiRuleLegato * AddMidiRuleLegato()
Adds the legato MIDI rule to the instrument.
Definition: gig.cpp:3423
uint8_t EG2ControllerAttackInfluence
Amount EG2 Controller has influence on the EG2 Attack time (0 - 3, where 0 means off).
Definition: gig.h:377
Exception(String Message)
Definition: gig.cpp:4309
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:420
int16_t LFO3ControlDepth
Controller depth of the sample pitch LFO (-1200 - +1200 cents).
Definition: gig.h:391
RIFF::Chunk * pCkSmpl
Definition: gig.h:579
Only controlled by external modulation wheel.
Definition: gig.h:132
double EG3Attack
Attack time of the sample pitch EG (0.000 - 10.000s).
Definition: gig.h:387
void DeleteDimension(dimension_def_t *pDimDef)
Delete an existing dimension.
Definition: gig.cpp:2769
Instrument * GetNextInstrument()
Returns a pointer to the next Instrument object of the file, NULL otherwise.
Definition: gig.cpp:3827
uint8_t LegatoSamples
Number of legato samples per key in each direction (always 12)
Definition: gig.h:676
uint8_t out_end
End postition of fade out.
Definition: gig.h:292
void DeleteGroupOnly(Group *pGroup)
Delete a group.
Definition: gig.cpp:4063
double EG2Attack
Attack time of the filter cutoff EG (0.000 - 60.000s).
Definition: gig.h:369
uint16_t BitDepth
Size of each sample per channel (only if known sample data format is used, 0 otherwise).
Definition: DLS.h:381
bool InvertAttenuationController
Inverts the values coming from the defined Attenuation Controller.
Definition: gig.h:422
double LFO1Frequency
Frequency of the sample amplitude LFO (0.10 - 10.00 Hz).
Definition: gig.h:361
Ordinary RIFF Chunk.
Definition: RIFF.h:177
DimensionRegion(Region *pParent, RIFF::List *_3ewl)
Definition: gig.cpp:1314
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:536
uint16_t EffectSend
Definition: gig.h:758
virtual void UpdateChunks()
Update chunks with current group settings.
Definition: gig.cpp:3529
bool LFO1FlipPhase
Inverts phase of the sample amplitude LFO wave.
Definition: gig.h:365
uint8_t AltSustain1Key
Key triggering alternate sustain samples.
Definition: gig.h:684
void DeleteSample(Sample *pSample)
Delete a sample.
Definition: gig.cpp:3734
int16_t FineTune
in cents
Definition: gig.h:759
Region(Instrument *pInstrument, RIFF::List *rgnList)
Definition: gig.cpp:2403
uint8_t UnityNote
Definition: DLS.h:345
Effect 5 Depth (MIDI Controller 95)
Definition: gig.h:245
static buffer_t CreateDecompressionBuffer(unsigned long MaxReadSize)
Allocates a decompression buffer for streaming (compressed) samples with Sample::Read().
Definition: gig.cpp:1257
bool LFO3Sync
If set to true only one LFO should be used for all voices.
Definition: gig.h:393
uint32_t MIDIProgram
Specifies the MIDI Program Change Number this Instrument should be assigned to.
Definition: DLS.h:442
double LFO3Frequency
Frequency of the sample pitch LFO (0.10 - 10.00 Hz).
Definition: gig.h:389
static const DLS::version_t VERSION_3
Reflects Gigasampler file format version 3.0 (2003-03-31).
Definition: gig.h:830
void DeleteRegion(Region *pRegion)
Definition: gig.cpp:3384
Soft Pedal (MIDI Controller 67)
Definition: gig.h:236
DimensionRegion * pDimensionRegions[256]
Pointer array to the 32 (gig2) or 256 (gig3) possible dimension regions (reflects NULL for dimension ...
Definition: gig.h:620
uint32_t Product
Specifies the MIDI model ID defined by the manufacturer corresponding to the Manufacturer field...
Definition: gig.h:529
bool LFO1Sync
If set to true only one LFO should be used for all voices.
Definition: gig.h:366
split_type_t
Intended for internal usage: will be used to convert a dimension value into the corresponding dimensi...
Definition: gig.h:252
Alternating loop (forward/backward, also known as Ping Pong)
Definition: gig.h:83
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: gig.h:300
~Sample()
Destructor.
Definition: gig.cpp:1295
void SetSampleChecksum(Sample *pSample, uint32_t crc)
Updates the 3crc chunk with the checksum of a sample.
Definition: gig.cpp:3969
Sample * GetNextSample()
Returns the next Sample of the Group.
Definition: gig.cpp:3582
leverage_ctrl_t eg2_ctrl_t
Defines controller influencing envelope generator 2.
Definition: gig.h:202
uint8_t EG2ControllerReleaseInfluence
Amount EG2 Controller has influence on the EG2 Release time (0 - 3, where 0 means off)...
Definition: gig.h:379
uint16_t EG2PreAttack
Preattack value of the filter cutoff EG (0 - 1000 permille).
Definition: gig.h:368
leverage_ctrl_t attenuation_ctrl_t
Defines controller influencing attenuation.
Definition: gig.h:188
uint32_t Loops
Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: Numb...
Definition: gig.h:535
String Name
Name of the pattern.
Definition: gig.h:704
bool LFO2Sync
If set to true only one LFO should be used for all voices.
Definition: gig.h:385
uint32_t SMPTEOffset
The SMPTE Offset value specifies the time offset to be used for the synchronization / calibration to ...
Definition: gig.h:534
unsigned long FileNo
File number (&gt; 0 when sample is stored in an extension file, 0 when it&#39;s in the gig) ...
Definition: gig.h:577
bool EG1ControllerInvert
Invert values coming from defined EG1 controller.
Definition: gig.h:357
void UpdateChunks(uint8_t *pData) const
Definition: gig.cpp:3026
Ordinary MIDI control change controller, see field &#39;controller_number&#39;.
Definition: gig.h:176
30 frames per second with frame dropping (30 drop)
Definition: gig.h:92
vcf_res_ctrl_t
Defines how the filter resonance is controlled by.
Definition: gig.h:155
vcf_type_t
Defines which frequencies are filtered by the VCF.
Definition: gig.h:267
General Purpose Controller 5 (Button, MIDI Controller 80)
Definition: gig.h:237
version_t * pVersion
Points to a version_t structure if the file provided a version number else is set to NULL...
Definition: DLS.h:475
void DeleteInstrument(Instrument *pInstrument)
Delete an instrument.
Definition: gig.cpp:3928
uint16_t LFO2ControlDepth
Controller depth influencing filter cutoff LFO pitch (0 - 1200).
Definition: gig.h:382
Loop backward (reverse)
Definition: gig.h:84
int16_t EG3Depth
Depth of the sample pitch EG (-1200 - +1200).
Definition: gig.h:388
bool GetAutoLoad()
Returns whether automatic loading is enabled.
Definition: gig.cpp:4300
uint8_t VCFKeyboardTrackingBreakpoint
See VCFKeyboardTracking (0 - 127).
Definition: gig.h:407
eg2_ctrl_t EG2Controller
MIDI Controller which has influence on filter cutoff EG parameters (attack, decay, release).
Definition: gig.h:375
For layering of up to 8 instruments (and eventually crossfading of 2 or 4 layers).
Definition: gig.h:214
bool VCFCutoffControllerInvert
Inverts values coming from the defined cutoff controller.
Definition: gig.h:398
General Purpose Controller 7 (Button, MIDI Controller 82)
Definition: gig.h:149
Controlled internally and by external foot controller.
Definition: gig.h:126
Different samples triggered each time a note is played, random order.
Definition: gig.h:220
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:2974
void * custom
This pointer can be used for arbitrary data.
Definition: gig.h:318
double EG2Release
Release time of the filter cutoff EG (0.000 - 60.000s).
Definition: gig.h:374
uint8_t EG1ControllerReleaseInfluence
Amount EG1 Controller has influence on the EG1 Release time (0 - 3, where 0 means off)...
Definition: gig.h:360
float factor
Reflects current progress as value between 0.0 and 1.0.
Definition: gig.h:317
uint8_t EG2ControllerDecayInfluence
Amount EG2 Controller has influence on the EG2 Decay time (0 - 3, where 0 means off).
Definition: gig.h:378
~Region()
Destructor.
Definition: gig.cpp:2845
bool Polyphonic
If alternator should step forward only when all notes are off.
Definition: gig.h:725
Abstract base class for all MIDI rules.
Definition: gig.h:643
void SetVelocityResponseCurveScaling(uint8_t scaling)
Updates the respective member variable and the lookup table / cache that depends on this value...
Definition: gig.cpp:2270
General Purpose Controller 2 (Slider, MIDI Controller 17)
Definition: gig.h:230
dimension_t
Defines the type of dimension, that is how the dimension zones (and thus how the dimension regions ar...
Definition: gig.h:211
uint32_t LoopEnd
Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The ...
Definition: gig.h:539
Defines the envelope of a crossfade.
Definition: gig.h:282
uint8_t MIDIBankFine
Reflects the MIDI Bank number for MIDI Control Change 32 (bank 1 - 128).
Definition: DLS.h:441
curve_type_t ReleaseVelocityResponseCurve
Defines a transformation curve to the incoming release veloctiy values affecting envelope times...
Definition: gig.h:412
Different samples triggered each time a note is played, dimension regions selected in sequence...
Definition: gig.h:219
dimension_def_t pDimensionDefinitions[8]
Defines the five (gig2) or eight (gig3) possible dimensions (the dimension&#39;s controller and number of...
Definition: gig.h:618
uint8_t zones
Number of zones the dimension has.
Definition: gig.h:261
Effect 5 Depth (MIDI Controller 95)
Definition: gig.h:108
General Purpose Controller 3 (Slider, MIDI Controller 18)
Definition: gig.h:157
uint8_t & operator[](int i)
Definition: gig.h:709
General Purpose Controller 8 (Button, MIDI Controller 83)
Definition: gig.h:150
uint8_t AttenuationControllerThreshold
0-127
Definition: gig.h:423
RIFF::File * pRIFF
Definition: DLS.h:498
buffer_t GetCache()
Returns current cached sample points.
Definition: gig.cpp:699
void SetVCFVelocityDynamicRange(uint8_t range)
Updates the respective member variable and the lookup table / cache that depends on this value...
Definition: gig.cpp:2318
vcf_cutoff_ctrl_t
Defines how the filter cutoff frequency is controlled by.
Definition: gig.h:139
No controller defined.
Definition: gig.h:173
Encapsulates sample waves used for playback.
Definition: gig.h:526
virtual void SetGain(int32_t gain)
Updates the respective member variable and updates SampleAttenuation which depends on this value...
Definition: gig.cpp:1640
RIFF File.
Definition: RIFF.h:320
Group(File *file, RIFF::Chunk *ck3gnm)
Constructor.
Definition: gig.cpp:3510
General Purpose Controller 8 (Button, MIDI Controller 83)
Definition: gig.h:240
unsigned long GuessSize(unsigned long samples)
Definition: gig.h:586
dimension value between 0-127
Definition: gig.h:253
24 frames per second
Definition: gig.h:90
Modulation Wheel (MIDI Controller 1)
Definition: gig.h:142
int16_t LFO3InternalDepth
Firm depth of the sample pitch LFO (-1200 - +1200 cents).
Definition: gig.h:390
General Purpose Controller 5 (Button, MIDI Controller 80)
Definition: gig.h:159
Lower and upper limit of a range.
Definition: gig.h:63
Sample * GetNextSample()
Returns a pointer to the next Sample object of the file, NULL otherwise.
Definition: gig.cpp:3696
virtual void Save()
Save changes to same file.
Definition: DLS.cpp:1692
General Purpose Controller 1 (Slider, MIDI Controller 16)
Definition: gig.h:229
double EG2Decay2
Only if EG2InfiniteSustain == false: 2nd stage decay time of the filter cutoff EG (0...
Definition: gig.h:371
Portamento Time (Coarse, MIDI Controller 5)
Definition: gig.h:226
int32_t Attenuation
in dB
Definition: gig.h:757
Encapsulates sample waves used for playback.
Definition: DLS.h:374
type_t type
Controller type.
Definition: gig.h:179
uint controller_number
MIDI controller number if this controller is a control change controller, 0 otherwise.
Definition: gig.h:180
uint8_t * VelocityTable
For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity ...
Definition: gig.h:460
curve_type_t VelocityResponseCurve
Defines a transformation curve to the incoming velocity values affecting amplitude (usually you don&#39;t...
Definition: gig.h:409
Effect Controller 2 (Coarse, MIDI Controller 13)
Definition: gig.h:228
A MIDI rule not yet implemented by libgig.
Definition: gig.h:736
Foot Pedal (Coarse, MIDI Controller 4)
Definition: gig.h:225
void PrintMessage()
Definition: gig.cpp:4312
uint16_t EG1Sustain
Sustain value of the sample amplitude EG (0 - 1000 permille).
Definition: gig.h:353
String GetFileName()
File name of this DLS file.
Definition: DLS.cpp:1599
unsigned long NullExtensionSize
The buffer might be bigger than the actual data, if that&#39;s the case that unused space at the end of t...
Definition: gig.h:72
void SetVelocityResponseDepth(uint8_t depth)
Updates the respective member variable and the lookup table / cache that depends on this value...
Definition: gig.cpp:2258
Sample * GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t *pProgress=NULL)
Definition: gig.cpp:2950
General Purpose Controller 6 (Button, MIDI Controller 81)
Definition: gig.h:160
uint8_t DimensionUpperLimits[8]
gig3: defines the upper limit of the dimension values for this dimension region
Definition: gig.h:429
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:1610
uint8_t TriggerPoint
The CC value to pass for the note to be triggered.
Definition: gig.h:657
uint8_t VelocityResponseDepth
Dynamic range of velocity affecting amplitude (0 - 4) (usually you don&#39;t have to interpret this param...
Definition: gig.h:410
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:541
uint32_t TruncatedBits
For 24-bit compressed samples only: number of bits truncated during compression (0, 4 or 6)
Definition: gig.h:544
Instrument * GetInstrument(uint index, progress_t *pProgress=NULL)
Returns the instrument with the given index.
Definition: gig.cpp:3840
Resource * GetParent()
Definition: DLS.h:330
virtual void UpdateChunks(uint8_t *pData) const =0
virtual void UpdateChunks()
Apply sample and its settings to the respective RIFF chunks.
Definition: gig.cpp:467
int8_t Pan
Panorama / Balance (-64..0..63 &lt;-&gt; left..middle..right)
Definition: gig.h:419
Parses Gigasampler files and provides abstract access to the data.
Definition: gig.h:827
Only internally controlled.
Definition: gig.h:131
lfo2_ctrl_t
Defines how LFO2 is controlled by.
Definition: gig.h:121
Effect 3 Depth (MIDI Controller 93)
Definition: gig.h:243
Dimension for keyswitching.
Definition: gig.h:218
MIDI rule for instruments with legato samples.
Definition: gig.h:674
virtual ~Group()
Definition: gig.cpp:3516
void SetReleaseVelocityResponseDepth(uint8_t depth)
Updates the respective member variable and the lookup table / cache that depends on this value...
Definition: gig.cpp:2291
Sample * GetFirstSample()
Returns the first Sample of this Group.
Definition: gig.cpp:3564
struct gig::MidiRuleCtrlTrigger::trigger_t pTriggers[32]
leverage_ctrl_t eg1_ctrl_t
Defines controller influencing envelope generator 1.
Definition: gig.h:195
uint16_t EG2Sustain
Sustain value of the filter cutoff EG (0 - 1000 permille).
Definition: gig.h:373
dlsid_t * pDLSID
Points to a dlsid_t structure if the file provided a DLS ID else is NULL.
Definition: DLS.h:328
uint32_t Instruments
Reflects the number of available Instrument objects.
Definition: DLS.h:476
Provides all neccessary information for the synthesis of a DLS Instrument.
Definition: DLS.h:436
Provides all neccessary information for the synthesis of an Instrument.
Definition: gig.h:744
void DeleteGroup(Group *pGroup)
Delete a group and its samples.
Definition: gig.cpp:4039
bool SustainDefeat
If true: Sustain pedal will not hold a note.
Definition: gig.h:425
buffer_t RAMCache
Buffers samples (already uncompressed) in RAM.
Definition: gig.h:576
virtual void CopyAssign(const Instrument *orig)
Make a (semi) deep copy of the Instrument object given by orig and assign it to this object...
Definition: gig.cpp:3463
bool NoteOff
If a note off should be triggered instead of a note on.
Definition: gig.h:661
String libraryName()
Returns the name of this C++ library.
Definition: gig.cpp:4325
int32_t Gain
Definition: DLS.h:347
Controlled internally and by external modulation wheel.
Definition: gig.h:134
virtual void LoadGroups()
Definition: gig.cpp:4074
Quadtuple version number (&quot;major.minor.release.build&quot;).
Definition: DLS.h:109
double LFO2Frequency
Frequency of the filter cutoff LFO (0.10 - 10.00 Hz).
Definition: gig.h:380
uint32_t SamplePeriod
Specifies the duration of time that passes during the playback of one sample in nanoseconds (normally...
Definition: gig.h:530
uint16_t EG1PreAttack
Preattack value of the sample amplitude EG (0 - 1000 permille).
Definition: gig.h:348
Dimension not in use.
Definition: gig.h:212
unsigned long * FrameTable
For positioning within compressed samples only: stores the offset values for each frame...
Definition: gig.h:571
curve_type_t
Defines the shape of a function graph.
Definition: gig.h:97
uint8_t bits
Number of &quot;bits&quot; (1 bit = 2 splits/zones, 2 bit = 4 splits/zones, 3 bit = 8 splits/zones,...).
Definition: gig.h:260
selector_t Selector
Method by which pattern is chosen.
Definition: gig.h:721
uint8_t out_start
Start position of fade out.
Definition: gig.h:291
uint8_t VCFCutoff
Max. cutoff frequency.
Definition: gig.h:399
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:2577
unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence=RIFF::stream_start)
Sets the position within the sample (in sample points, not in bytes).
Definition: gig.cpp:777
Info * pInfo
Points (in any case) to an Info object, providing additional, optional infos and comments.
Definition: DLS.h:327
uint32_t Manufacturer
Specifies the MIDI Manufacturer&#39;s Association (MMA) Manufacturer code for the sampler intended to rec...
Definition: gig.h:528
uint8_t high
High value of range.
Definition: gig.h:65
bool OverridePedal
If a note off should be triggered even if the sustain pedal is down.
Definition: gig.h:663
MIDI rule to automatically cycle through specified sequences of different articulations.
Definition: gig.h:695
Reflects the current playback state for a sample.
Definition: gig.h:297
Region * GetParent() const
Definition: gig.cpp:1985
General dimension definition.
Definition: gig.h:258
int Size
Number of steps in the pattern.
Definition: gig.h:705
eg1_ctrl_t EG1Controller
MIDI Controller which has influence on sample amplitude EG parameters (attack, decay, release).
Definition: gig.h:356
Sostenuto Pedal (MIDI Controller 66)
Definition: gig.h:235
split_type_t split_type
Intended for internal usage: will be used to convert a dimension value into the corresponding dimensi...
Definition: gig.h:262
If used sample has more than one channel (thus is not mono).
Definition: gig.h:213
void SetReleaseVelocityResponseCurve(curve_type_t curve)
Updates the respective member variable and the lookup table / cache that depends on this value...
Definition: gig.cpp:2282
dim_bypass_ctrl_t
Dimensions allow to bypass one of the following controllers.
Definition: gig.h:105
vcf_res_ctrl_t VCFResonanceController
Specifies which external controller has influence on the filter resonance Q.
Definition: gig.h:405
curve_type_t VCFVelocityCurve
Defines a transformation curve for the incoming velocity values, affecting the VCF.
Definition: gig.h:400
uint8_t EG1ControllerDecayInfluence
Amount EG1 Controller has influence on the EG1 Decay time (0 - 3, where 0 means off).
Definition: gig.h:359
Defines Region information of an Instrument.
Definition: DLS.h:406
Effect 4 Depth (MIDI Controller 94)
Definition: gig.h:107
General Purpose Controller 7 (Button, MIDI Controller 82)
Definition: gig.h:239
double GetVelocityAttenuation(uint8_t MIDIKeyVelocity)
Returns the correct amplitude factor for the given MIDIKeyVelocity.
Definition: gig.cpp:2230
void UpdateChunks(uint8_t *pData) const
Definition: gig.cpp:3075
Sample * GetSample()
Returns pointer address to the Sample referenced with this region.
Definition: gig.cpp:2945
void SetVelocityResponseCurve(curve_type_t curve)
Updates the respective member variable and the lookup table / cache that depends on this value...
Definition: gig.cpp:2246
double EG1Attack
Attack time of the sample amplitude EG (0.000 - 60.000s).
Definition: gig.h:349
bool IsDrum
Indicates if the Instrument is a drum type, as they differ in the synthesis model of DLS from melodic...
Definition: DLS.h:438
Region * GetNextRegion()
Returns the next Region of the instrument.
Definition: gig.cpp:3364
void AddSampleLoop(sample_loop_t *pLoopDef)
Adds a new sample loop with the provided loop definition.
Definition: DLS.cpp:623