31 # define LIST_TYPE_3PRG 0x33707267 32 # define LIST_TYPE_3EWL 0x3365776C 33 # define LIST_TYPE_3GRI 0x33677269 34 # define LIST_TYPE_3GNL 0x33676E6C 35 # define LIST_TYPE_3LS 0x334c5320 // own gig format extension 36 # define LIST_TYPE_RTIS 0x52544953 // own gig format extension 37 # define CHUNK_ID_3GIX 0x33676978 38 # define CHUNK_ID_3EWA 0x33657761 39 # define CHUNK_ID_3LNK 0x336C6E6B 40 # define CHUNK_ID_3EWG 0x33657767 41 # define CHUNK_ID_EWAV 0x65776176 42 # define CHUNK_ID_3GNM 0x33676E6D 43 # define CHUNK_ID_EINF 0x65696E66 44 # define CHUNK_ID_3CRC 0x33637263 45 # define CHUNK_ID_SCRI 0x53637269 // own gig format extension 46 # define CHUNK_ID_LSNM 0x4c534e4d // own gig format extension 47 # define CHUNK_ID_SCSL 0x5343534c // own gig format extension 48 #else // little endian 49 # define LIST_TYPE_3PRG 0x67727033 50 # define LIST_TYPE_3EWL 0x6C776533 51 # define LIST_TYPE_3GRI 0x69726733 52 # define LIST_TYPE_3GNL 0x6C6E6733 53 # define LIST_TYPE_3LS 0x20534c33 // own gig format extension 54 # define LIST_TYPE_RTIS 0x53495452 // own gig format extension 55 # define CHUNK_ID_3GIX 0x78696733 56 # define CHUNK_ID_3EWA 0x61776533 57 # define CHUNK_ID_3LNK 0x6B6E6C33 58 # define CHUNK_ID_3EWG 0x67776533 59 # define CHUNK_ID_EWAV 0x76617765 60 # define CHUNK_ID_3GNM 0x6D6E6733 61 # define CHUNK_ID_EINF 0x666E6965 62 # define CHUNK_ID_3CRC 0x63726333 63 # define CHUNK_ID_SCRI 0x69726353 // own gig format extension 64 # define CHUNK_ID_LSNM 0x4d4e534c // own gig format extension 65 # define CHUNK_ID_SCSL 0x4c534353 // own gig format extension 66 #endif // WORDS_BIGENDIAN 300 #else // little endian 305 #endif // WORDS_BIGENDIAN 479 virtual void SetGain(int32_t gain);
492 _lev_ctrl_none = 0x00,
493 _lev_ctrl_modwheel = 0x03,
494 _lev_ctrl_breath = 0x05,
495 _lev_ctrl_foot = 0x07,
496 _lev_ctrl_effect1 = 0x0d,
497 _lev_ctrl_effect2 = 0x0f,
498 _lev_ctrl_genpurpose1 = 0x11,
499 _lev_ctrl_genpurpose2 = 0x13,
500 _lev_ctrl_genpurpose3 = 0x15,
501 _lev_ctrl_genpurpose4 = 0x17,
502 _lev_ctrl_portamentotime = 0x0b,
503 _lev_ctrl_sustainpedal = 0x01,
504 _lev_ctrl_portamento = 0x19,
505 _lev_ctrl_sostenutopedal = 0x1b,
506 _lev_ctrl_softpedal = 0x09,
507 _lev_ctrl_genpurpose5 = 0x1d,
508 _lev_ctrl_genpurpose6 = 0x1f,
509 _lev_ctrl_genpurpose7 = 0x21,
510 _lev_ctrl_genpurpose8 = 0x23,
511 _lev_ctrl_effect1depth = 0x25,
512 _lev_ctrl_effect2depth = 0x27,
513 _lev_ctrl_effect3depth = 0x29,
514 _lev_ctrl_effect4depth = 0x2b,
515 _lev_ctrl_effect5depth = 0x2d,
516 _lev_ctrl_channelaftertouch = 0x2f,
517 _lev_ctrl_velocity = 0xff,
521 _lev_ctrl_CC3_EXT = 0x83,
523 _lev_ctrl_CC6_EXT = 0x86,
524 _lev_ctrl_CC7_EXT = 0x87,
525 _lev_ctrl_CC8_EXT = 0x88,
526 _lev_ctrl_CC9_EXT = 0x89,
527 _lev_ctrl_CC10_EXT = 0x8a,
528 _lev_ctrl_CC11_EXT = 0x8b,
530 _lev_ctrl_CC14_EXT = 0x8e,
531 _lev_ctrl_CC15_EXT = 0x8f,
533 _lev_ctrl_CC20_EXT = 0x94,
534 _lev_ctrl_CC21_EXT = 0x95,
535 _lev_ctrl_CC22_EXT = 0x96,
536 _lev_ctrl_CC23_EXT = 0x97,
537 _lev_ctrl_CC24_EXT = 0x98,
538 _lev_ctrl_CC25_EXT = 0x99,
539 _lev_ctrl_CC26_EXT = 0x9a,
540 _lev_ctrl_CC27_EXT = 0x9b,
541 _lev_ctrl_CC28_EXT = 0x9c,
542 _lev_ctrl_CC29_EXT = 0x9d,
543 _lev_ctrl_CC30_EXT = 0x9e,
544 _lev_ctrl_CC31_EXT = 0x9f,
546 _lev_ctrl_CC68_EXT = 0xc4,
547 _lev_ctrl_CC69_EXT = 0xc5,
548 _lev_ctrl_CC70_EXT = 0xc6,
549 _lev_ctrl_CC71_EXT = 0xc7,
550 _lev_ctrl_CC72_EXT = 0xc8,
551 _lev_ctrl_CC73_EXT = 0xc9,
552 _lev_ctrl_CC74_EXT = 0xca,
553 _lev_ctrl_CC75_EXT = 0xcb,
554 _lev_ctrl_CC76_EXT = 0xcc,
555 _lev_ctrl_CC77_EXT = 0xcd,
556 _lev_ctrl_CC78_EXT = 0xce,
557 _lev_ctrl_CC79_EXT = 0xcf,
559 _lev_ctrl_CC84_EXT = 0xd4,
560 _lev_ctrl_CC85_EXT = 0xd5,
561 _lev_ctrl_CC86_EXT = 0xd6,
562 _lev_ctrl_CC87_EXT = 0xd7,
564 _lev_ctrl_CC89_EXT = 0xd9,
565 _lev_ctrl_CC90_EXT = 0xda,
567 _lev_ctrl_CC96_EXT = 0xe0,
568 _lev_ctrl_CC97_EXT = 0xe1,
570 _lev_ctrl_CC102_EXT = 0xe6,
571 _lev_ctrl_CC103_EXT = 0xe7,
572 _lev_ctrl_CC104_EXT = 0xe8,
573 _lev_ctrl_CC105_EXT = 0xe9,
574 _lev_ctrl_CC106_EXT = 0xea,
575 _lev_ctrl_CC107_EXT = 0xeb,
576 _lev_ctrl_CC108_EXT = 0xec,
577 _lev_ctrl_CC109_EXT = 0xed,
578 _lev_ctrl_CC110_EXT = 0xee,
579 _lev_ctrl_CC111_EXT = 0xef,
580 _lev_ctrl_CC112_EXT = 0xf0,
581 _lev_ctrl_CC113_EXT = 0xf1,
582 _lev_ctrl_CC114_EXT = 0xf2,
583 _lev_ctrl_CC115_EXT = 0xf3,
584 _lev_ctrl_CC116_EXT = 0xf4,
585 _lev_ctrl_CC117_EXT = 0xf5,
586 _lev_ctrl_CC118_EXT = 0xf6,
587 _lev_ctrl_CC119_EXT = 0xf7
589 typedef std::map<uint32_t, double*> VelocityTableMap;
591 static uint Instances;
592 static VelocityTableMap* pVelocityTables;
593 double* pVelocityAttenuationTable;
594 double* pVelocityReleaseTable;
595 double* pVelocityCutoffTable;
598 leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
599 _lev_ctrl_t EncodeLeverageController(
leverage_ctrl_t DecodedController);
600 double* GetReleaseVelocityTable(
curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth);
601 double* GetCutoffVelocityTable(
curve_type_t vcfVelocityCurve, uint8_t vcfVelocityDynamicRange, uint8_t vcfVelocityScale,
vcf_cutoff_ctrl_t vcfCutoffController);
602 double* GetVelocityTable(
curve_type_t curveType, uint8_t depth, uint8_t scaling);
603 double* CreateVelocityTable(
curve_type_t curveType, uint8_t depth, uint8_t scaling);
663 void Resize(
int iNewSize);
665 unsigned long GetPos()
const;
666 unsigned long Read(
void* pBuffer,
unsigned long SampleCount,
buffer_t* pExternalDecompressionBuffer = NULL);
668 unsigned long Write(
void* pBuffer,
unsigned long SampleCount);
689 Sample(
File* pFile,
RIFF::List* waveList,
unsigned long WavePoolOffset,
unsigned long fileNo = 0);
700 const unsigned long size =
701 BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
702 : samples + (samples >> 10) * 5;
714 void ScanCompressedSample();
761 virtual void SetKeyRange(uint16_t Low, uint16_t High);
769 void CopyAssign(
const Region* orig,
const std::map<Sample*,Sample*>* mSamples);
1023 std::vector<uint8_t> data;
1055 std::list<Script*>* pScripts;
1132 struct _ScriptPooolEntry {
1133 uint32_t fileOffset;
1136 struct _ScriptPooolRef {
1140 MidiRule** pMidiRules;
1141 std::vector<_ScriptPooolEntry> scriptPoolFileOffsets;
1142 std::vector<_ScriptPooolRef>* pScriptRefs;
1275 std::list<Group*>* pGroups;
1276 std::list<Group*>::iterator GroupsIterator;
1278 std::list<ScriptGroup*>* pScriptGroups;
range_t KeySwitchRange
Key range for key switch selector.
bool LFO2FlipPhase
Inverts phase of the filter cutoff LFO wave.
void UpdateRegionKeyTable()
void SetScriptAsText(const String &text)
Replaces the current script with the new script source code text given by text.
void AddContentOf(File *pFile)
Add content of another existing file.
General Purpose Controller 4 (Slider, MIDI Controller 19)
void MoveAll()
Move all members of this group to another group (preferably the 1st one except this).
dim_bypass_ctrl_t DimensionBypass
If defined, the MIDI controller can switch on/off the dimension in realtime.
Encapsulates articulation informations of a dimension region.
range_t DimensionKeyRange
0-127 (where 0 means C1 and 127 means G9)
sample_loop_t * pSampleLoops
Points to the beginning of a sample loop array, or is NULL if there are no loops defined.
uint8_t VCFVelocityScale
(0-127) Amount velocity controls VCF cutoff frequency (only if no other VCF cutoff controller is defi...
void SetDimensionType(dimension_t oldType, dimension_t newType)
Change type of an existing dimension.
unsigned long FrameOffset
Current offset (sample points) in current sample frame (for decompression only).
bool reverse
If playback direction is currently backwards (in case there is a pingpong or reverse loop defined).
Only controlled by aftertouch controller.
uint8_t AltSustain2Key
Key triggering a second set of alternate sustain samples.
uint32_t Regions
Reflects the number of Region defintions this Instrument has.
Region * GetRegion(unsigned int Key)
Returns the appropriate Region for a triggered note.
void AddSample(Sample *pSample)
Move Sample given by pSample from another Group to this Group.
String GetScriptAsText()
Returns the current script (i.e.
void UpdateChunks(uint8_t *pData) const
Effect Controller 2 (Coarse, MIDI Controller 13)
MidiRuleAlternator * AddMidiRuleAlternator()
Adds the alternator MIDI rule to the instrument.
Sample * AddSample()
Add a new sample.
bool VCFEnabled
If filter should be used.
Controlled internally and by external modulation wheel.
Controlled internally and by aftertouch controller.
Parses DLS Level 1 and 2 compliant files and provides abstract access to the data.
void AddDimension(dimension_def_t *pDimDef)
Einstein would have dreamed of it - create a new dimension.
stream_whence_t
File stream position dependent to these relations.
Soft Pedal (MIDI Controller 67)
uint32_t FineTune
Specifies the fraction of a semitone up from the specified MIDI unity note field. A value of 0x800000...
uint8_t BypassKey
Key to be used to bypass the sustain note.
uint16_t LFO1ControlDepth
Controller depth influencing sample amplitude LFO pitch (0 - 1200 cents).
lfo1_ctrl_t
Defines how LFO1 is controlled by.
Group of Gigasampler samples.
uint8_t VCFVelocityDynamicRange
0x04 = lowest, 0x00 = highest .
String Name
Stores the name of this Group.
DimensionRegion * GetDimensionRegionByBit(const uint8_t DimBits[8])
Returns the appropriate DimensionRegion for the given dimension bit numbers (zone index).
Special dimension for triggering samples on releasing a key.
uint16_t PitchbendRange
Number of semitones pitchbend controller can pitch (default is 2).
double EG1Release
Release time of the sample amplitude EG (0.000 - 60.000s).
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 ...
Only internally controlled.
uint8_t Triggers
Number of triggers.
vcf_type_t VCFType
Defines the general filter characteristic (lowpass, highpass, bandpass, etc.).
Effect Controller 1 (Coarse, MIDI Controller 12)
Script * AddScript()
Add new instrument script.
uint32_t LoopSize
Caution: Use the respective fields in the DimensionRegion instead of this one! (Intended purpose: Len...
Instrument * AddInstrument()
Add a new instrument definition.
Controlled internally and by external modulation wheel.
virtual void LoadScriptGroups()
Script * GetScript(uint index)
Get instrument script.
loop_type_t LoopType
Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The ...
lfo1_ctrl_t LFO1Controller
MIDI Controller which controls sample amplitude LFO.
Effect 2 Depth (MIDI Controller 92)
Effect Controller 1 (Coarse, MIDI Controller 12)
Only internally controlled.
Sample * GetFirstSample()
Returns a pointer to the first Sample object of the file, NULL otherwise.
uint8_t low
Low value of range.
Modulation Wheel (MIDI Controller 1)
void UpdateChunks(progress_t *pProgress)
Apply this script group to the respective RIFF chunks.
Will be thrown whenever a DLS specific error occurs while trying to access a DLS File.
uint16_t SampleStartOffset
Number of samples the sample start should be moved (0 - 2000).
MIDI rule for triggering notes by control change events.
NKSP stands for "Is Not KSP" (default). Refer to the NKSP Reference Manual for details about this scr...
uint8_t Key
Key to trigger.
unsigned long WorstCaseFrameSize
For compressed samples only: size (in bytes) of the largest possible sample frame.
void AddScriptSlot(Script *pScript, bool bypass=false)
Add new instrument script slot (gig format extension).
bool EG1Hold
If true, Decay1 stage should be postponed until the sample reached the sample loop start.
range_t PlayRange
Key range of the playable keys in the instrument.
uint16_t ThresholdTime
Maximum time (ms) between two notes that should be played legato.
dimension values are already the sought bit number
uint8_t VelocityResponseCurveScaling
0 - 127 (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead).
bool Descending
If the change in CC value should be downwards.
Group * GetGroup() const
Returns pointer to the Group this Sample belongs to.
double GetVelocityCutoff(uint8_t MIDIKeyVelocity)
unsigned long Size
Size of the actual data in the buffer in bytes.
Effect 1 Depth (MIDI Controller 91)
Instrument * GetFirstInstrument()
Returns a pointer to the first Instrument object of the file, NULL otherwise.
Breath Controller (Coarse, MIDI Controller 2)
Region * RegionKeyTable[128]
fast lookup for the corresponding Region of a MIDI key
uint8_t ReleaseTriggerKey
Key triggering release samples.
Sample(File *pFile, RIFF::List *waveList, unsigned long WavePoolOffset, unsigned long fileNo=0)
Constructor.
For MIDI tools like legato and repetition mode.
bool VCFKeyboardTracking
If true: VCF cutoff frequence will be dependend to the note key position relative to the defined brea...
uint32_t WavePoolTableIndex
uint8_t Velocity
Velocity of the note to trigger. 255 means that velocity should depend on the speed of the controller...
void CopyAssignWave(const Sample *orig)
Should be called after CopyAssignMeta() and File::Save() sequence.
uint32_t crc
CRC-32 checksum of the raw sample data.
Defines a controller that has a certain contrained influence on a particular synthesis parameter (use...
uint16_t Channels
Number of channels represented in the waveform data, e.g. 1 for mono, 2 for stereo (defaults to 1=mon...
uint8_t Controller
CC number for controller selector.
void SetVCFVelocityScale(uint8_t scaling)
Updates the respective member variable and the lookup table / cache that depends on this value.
Defines Region information of a Gigasampler/GigaStudio instrument.
Only controlled by external modulation wheel.
void UpdateVelocityTable()
unsigned long SamplesPerFrame
For compressed samples only: number of samples in a full sample frame.
uint32_t LoopPlayCount
Number of times the loop should be played (a value of 0 = infinite).
uint8_t ReleaseTriggerDecay
0 - 8
lfo3_ctrl_t LFO3Controller
MIDI Controller which controls the sample pitch LFO.
static unsigned int Instances
Number of instances of class Sample.
bool Chained
If all patterns should be chained together.
uint32_t MIDIUnityNote
Specifies the musical note at which the sample will be played at it's original sample rate.
uint8_t ControllerNumber
MIDI controller number.
Portamento (MIDI Controller 65)
uint8_t ChannelOffset
Audio output where the audio signal of the dimension region should be routed to (0 - 9).
void Resize(int iNewSize)
Resize sample.
General Purpose Controller 6 (Button, MIDI Controller 81)
Region * GetParent() const
uint8_t VCFResonance
Firm internal filter resonance weight.
Standard 8 bit US ASCII character encoding (default).
bool VCFResonanceDynamic
If true: Increases the resonance Q according to changes of controllers that actually control the VCF ...
Language_t Language
Programming language and dialect the script is written in.
void DeleteMidiRule(int i)
Deletes a MIDI rule from the instrument.
unsigned int Dimensions
Number of defined dimensions, do not alter!
Only controlled by external modulation wheel.
vcf_cutoff_ctrl_t VCFCutoffController
Specifies which external controller has influence on the filter cutoff frequency.
uint16_t MIDIBank
Reflects combination of MIDIBankCoarse and MIDIBankFine (bank 1 - bank 16384). Do not change this val...
MidiRuleCtrlTrigger * AddMidiRuleCtrlTrigger()
Adds the "controller trigger" MIDI rule to the instrument.
Foot Pedal (Coarse, MIDI Controller 4)
double EG1Decay1
Decay time of the sample amplitude EG (0.000 - 60.000s).
DimensionRegion * GetDimensionRegionByValue(const uint DimValues[8])
Use this method in your audio engine to get the appropriate dimension region with it's articulation d...
void UpdateScriptFileOffsets()
lfo2_ctrl_t LFO2Controller
MIDI Controlle which controls the filter cutoff LFO.
Compression_t Compression
Whether the script was/should be compressed, and if so, which compression algorithm shall be used.
void LoadDimensionRegions(RIFF::List *rgn)
Different samples triggered each time a note is played, any key advances the counter.
bool Dithered
For 24-bit compressed samples only: if dithering was used during compression with bit reduction.
Region * GetFirstRegion()
Returns the first Region of the instrument.
String libraryVersion()
Returns version of this C++ library.
uint8_t VelocityUpperLimit
Defines the upper velocity value limit of a velocity split (only if an user defined limit was set,...
uint8_t ReleaseVelocityResponseDepth
Dynamic range of release velocity affecting envelope time (0 - 4).
void RemoveAllScriptReferences()
Will be thrown whenever a gig specific error occurs while trying to access a Gigasampler File.
buffer_t LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount)
Loads (and uncompresses if needed) the whole sample wave into RAM.
void UpdateChunks(progress_t *pProgress)
Apply this script to the respective RIFF chunks.
Instrument(File *pFile, RIFF::List *insList, progress_t *pProgress=NULL)
uint8_t MIDIBankCoarse
Reflects the MIDI Bank number for MIDI Control Change 0 (bank 1 - 128).
uint8_t in_end
End position of fade in.
void SetVCFCutoffController(vcf_cutoff_ctrl_t controller)
Updates the respective member variable and the lookup table / cache that depends on this value.
unsigned long WorstCaseMaxSamples(buffer_t *pDecompressionBuffer)
static const DLS::version_t VERSION_2
Reflects Gigasampler file format version 2.0 (1998-06-28).
Sample * pSample
Points to the Sample which is assigned to the dimension region.
buffer_t LoadSampleData()
Loads (and uncompresses if needed) the whole sample wave into RAM.
uint16_t ReleaseTime
Release time.
smpte_format_t
Society of Motion Pictures and Television E time format.
uint32_t LoopStart
Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The ...
Group * GetNextGroup()
Returns a pointer to the next Group object of the file, NULL otherwise.
void SetVCFVelocityCurve(curve_type_t curve)
Updates the respective member variable and the lookup table / cache that depends on this value.
double EG2Decay1
Decay time of the filter cutoff EG (0.000 - 60.000s).
uint8_t EG1ControllerAttackInfluence
Amount EG1 Controller has influence on the EG1 Attack time (0 - 3, where 0 means off).
unsigned long position
Current position within the sample.
String pArticulations[32]
Names of the articulations.
Only controlled by external foot controller.
void SetAutoLoad(bool b)
Enable / disable automatic loading.
MidiRule * GetMidiRule(int i)
Returns a MIDI rule of the instrument.
void DeleteSampleLoop(sample_loop_t *pLoopDef)
Deletes an existing sample loop.
smpte_format_t SMPTEFormat
Specifies the Society of Motion Pictures and Television E time format used in the following SMPTEOffs...
double SampleAttenuation
Sample volume (calculated from DLS::Sampler::Gain)
lfo3_ctrl_t
Defines how LFO3 is controlled by.
Sustain Pedal (MIDI Controller 64)
double EG1Decay2
Only if EG1InfiniteSustain == false: 2nd decay stage time of the sample amplitude EG (0....
void RemoveScript(Script *pScript)
Remove reference to given Script (gig format extension).
uint8_t BypassController
Controller to be used to bypass the sustain note.
attenuation_ctrl_t AttenuationController
MIDI Controller which has influence on the volume level of the sample (or entire sample group).
static buffer_t InternalDecompressionBuffer
Buffer used for decompression as well as for truncation of 24 Bit -> 16 Bit samples.
static void DestroyDecompressionBuffer(buffer_t &DecompressionBuffer)
Free decompression buffer, previously created with CreateDecompressionBuffer().
Pointer address and size of a buffer.
virtual void LoadSamples()
uint8_t in_start
Start position of fade in.
uint8_t Patterns
Number of alternator patterns.
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...
dimension_t dimension
Specifies which source (usually a MIDI controller) is associated with the dimension.
bool Bypass
Global bypass: if enabled, this script shall not be executed by the sampler for any instrument.
Abstract base class which provides mandatory informations about sample players in general.
loop_type_t
Standard types of sample loops.
range_t KeyRange
Key range for legato notes.
Sustain Pedal (MIDI Controller 64)
unsigned long SamplesInLastFrame
For compressed samples only: length of the last sample frame.
bool EG2ControllerInvert
Invert values coming from defined EG2 controller.
uint8_t Articulations
Number of articulations in the instrument.
Group * GetFirstGroup()
Returns a pointer to the first Group object of the file, NULL otherwise.
Group * GetGroup(uint index)
Returns the group with the given index.
uint8_t VelSensitivity
How sensitive the velocity should be to the speed of the controller change.
String Name
Arbitrary name of the script, which may be displayed i.e. in an instrument editor.
uint32_t DimensionRegions
Total number of DimensionRegions this Region contains, do not alter!
Instrument * AddDuplicateInstrument(const Instrument *orig)
Add a duplicate of an existing instrument.
uint ScriptSlotCount() const
Instrument's amount of script slots.
bool MSDecode
Gigastudio flag: defines if Mid Side Recordings should be decoded.
Key Velocity (this is the only dimension in gig2 where the ranges can exactly be defined).
bool EG1InfiniteSustain
If true, instead of going into Decay2 phase, Decay1 level will be hold until note will be released.
bool Compressed
If the sample wave is compressed (probably just interesting for instrument and sample editors,...
void ReleaseSampleData()
Frees the cached sample from RAM if loaded with LoadSampleData() previously.
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...
General Purpose Controller 3 (Slider, MIDI Controller 18)
uint32_t SampleLoops
Reflects the number of sample loops.
More poles than normal lowpass.
virtual void Save(const String &Path, progress_t *pProgress=NULL)
Save changes to another file.
uint16_t LFO2InternalDepth
Firm pitch of the filter cutoff LFO (0 - 1200 cents).
void DeleteDimensionZone(dimension_t type, int zone)
Delete one split zone of a dimension (decrement zone amount).
uint16_t LFO1InternalDepth
Firm pitch of the sample amplitude LFO (0 - 1200 cents).
The difference between none and none2 is unknown.
Controlled internally and by external breath controller.
virtual void LoadInstruments()
float zone_size
Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only,...
virtual void UpdateFileOffsets()
Updates all file offsets stored all over the file.
Only controlled by external breath controller.
bool PitchTrack
If true: sample will be pitched according to the key position (this will be disabled for drums for ex...
double GetVelocityRelease(uint8_t MIDIKeyVelocity)
unsigned long Write(void *pBuffer, unsigned long SampleCount)
Write sample wave data.
bool BypassUseController
If a controller should be used to bypass the sustain note.
unsigned int Layers
Amount of defined layers (1 - 32). A value of 1 actually means no layering, a value > 1 means there i...
void * pStart
Points to the beginning of the buffer.
bool EG2InfiniteSustain
If true, instead of going into Decay2 phase, Decay1 level will be hold until note will be released.
const uint8_t & operator[](int i) const
General Purpose Controller 4 (Slider, MIDI Controller 19)
unsigned long SamplePos
For compressed samples only: stores the current position (in sample points).
Group * pGroup
pointer to the Group this sample belongs to (always not-NULL)
Script(ScriptGroup *group, RIFF::Chunk *ckScri)
struct gig::MidiRuleAlternator::pattern_t pPatterns[32]
A pattern is a sequence of articulation numbers.
Effect 4 Depth (MIDI Controller 94)
Breath Controller (Coarse, MIDI Controller 2)
MidiRuleLegato * AddMidiRuleLegato()
Adds the legato MIDI rule to the instrument.
uint8_t EG2ControllerAttackInfluence
Amount EG2 Controller has influence on the EG2 Attack time (0 - 3, where 0 means off).
Exception(String Message)
bool SelfMask
If true: high velocity notes will stop low velocity notes at the same note, with that you can save vo...
int16_t LFO3ControlDepth
Controller depth of the sample pitch LFO (-1200 - +1200 cents).
void RemoveScriptSlot(uint index)
Remove script slot.
Only controlled by external modulation wheel.
double EG3Attack
Attack time of the sample pitch EG (0.000 - 10.000s).
void DeleteDimension(dimension_def_t *pDimDef)
Delete an existing dimension.
void UpdateChunks(uint8_t *pData) const
void UpdateChunks(uint8_t *pData) const
Instrument * GetNextInstrument()
Returns a pointer to the next Instrument object of the file, NULL otherwise.
uint8_t LegatoSamples
Number of legato samples per key in each direction (always 12)
uint8_t out_end
End postition of fade out.
void DeleteGroupOnly(Group *pGroup)
Delete a group.
double EG2Attack
Attack time of the filter cutoff EG (0.000 - 60.000s).
uint16_t BitDepth
Size of each sample per channel (only if known sample data format is used, 0 otherwise).
bool InvertAttenuationController
Inverts the values coming from the defined Attenuation Controller.
double LFO1Frequency
Frequency of the sample amplitude LFO (0.10 - 10.00 Hz).
DimensionRegion(Region *pParent, RIFF::List *_3ewl)
uint32_t LoopID
Specifies the unique ID that corresponds to one of the defined cue points in the cue point list (only...
bool LFO1FlipPhase
Inverts phase of the sample amplitude LFO wave.
uint8_t AltSustain1Key
Key triggering alternate sustain samples.
void DeleteSample(Sample *pSample)
Delete a sample.
Region(Instrument *pInstrument, RIFF::List *rgnList)
Effect 5 Depth (MIDI Controller 95)
static buffer_t CreateDecompressionBuffer(unsigned long MaxReadSize)
Allocates a decompression buffer for streaming (compressed) samples with Sample::Read().
bool LFO3Sync
If set to true only one LFO should be used for all voices.
uint32_t MIDIProgram
Specifies the MIDI Program Change Number this Instrument should be assigned to.
bool IsScriptSlotBypassed(uint index)
Whether script execution shall be skipped.
double LFO3Frequency
Frequency of the sample pitch LFO (0.10 - 10.00 Hz).
static const DLS::version_t VERSION_3
Reflects Gigasampler file format version 3.0 (2003-03-31).
void DeleteRegion(Region *pRegion)
Soft Pedal (MIDI Controller 67)
ScriptGroup * AddScriptGroup()
Add new instrument script group.
DimensionRegion * pDimensionRegions[256]
Pointer array to the 32 (gig2) or 256 (gig3) possible dimension regions (reflects NULL for dimension ...
uint32_t Product
Specifies the MIDI model ID defined by the manufacturer corresponding to the Manufacturer field....
bool LFO1Sync
If set to true only one LFO should be used for all voices.
split_type_t
Intended for internal usage: will be used to convert a dimension value into the corresponding dimensi...
Alternating loop (forward/backward, also known as Ping Pong)
ScriptGroup * GetScriptGroup(uint index)
Get instrument script group (by index).
unsigned long loop_cycles_left
How many times the loop has still to be passed, this value will be decremented with each loop cycle.
void SetSampleChecksum(Sample *pSample, uint32_t crc)
Updates the 3crc chunk with the checksum of a sample.
Sample * GetNextSample()
Returns the next Sample of the Group.
leverage_ctrl_t eg2_ctrl_t
Defines controller influencing envelope generator 2.
uint8_t EG2ControllerReleaseInfluence
Amount EG2 Controller has influence on the EG2 Release time (0 - 3, where 0 means off).
Used for indicating the progress of a certain task.
uint16_t EG2PreAttack
Preattack value of the filter cutoff EG (0 - 1000 permille).
leverage_ctrl_t attenuation_ctrl_t
Defines controller influencing attenuation.
uint32_t Loops
Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: Numb...
String Name
Name of the pattern.
bool LFO2Sync
If set to true only one LFO should be used for all voices.
uint32_t SMPTEOffset
The SMPTE Offset value specifies the time offset to be used for the synchronization / calibration to ...
unsigned long FileNo
File number (> 0 when sample is stored in an extension file, 0 when it's in the gig)
void SplitDimensionZone(dimension_t type, int zone)
Divide split zone of a dimension in two (increment zone amount).
bool EG1ControllerInvert
Invert values coming from defined EG1 controller.
Ordinary MIDI control change controller, see field 'controller_number'.
30 frames per second with frame dropping (30 drop)
vcf_res_ctrl_t
Defines how the filter resonance is controlled by.
vcf_type_t
Defines which frequencies are filtered by the VCF.
General Purpose Controller 5 (Button, MIDI Controller 80)
version_t * pVersion
Points to a version_t structure if the file provided a version number else is set to NULL.
void DeleteInstrument(Instrument *pInstrument)
Delete an instrument.
uint16_t LFO2ControlDepth
Controller depth influencing filter cutoff LFO pitch (0 - 1200).
virtual void UpdateChunks(progress_t *pProgress)
Update chunks with current group settings.
String Name
Name of this script group. For example to be displayed in an instrument editor.
int GetDimensionRegionIndexByValue(const uint DimValues[8])
int16_t EG3Depth
Depth of the sample pitch EG (-1200 - +1200).
bool GetAutoLoad()
Returns whether automatic loading is enabled.
void UpdateChunks(uint8_t *pData) const
uint8_t VCFKeyboardTrackingBreakpoint
See VCFKeyboardTracking (0 - 127).
eg2_ctrl_t EG2Controller
MIDI Controller which has influence on filter cutoff EG parameters (attack, decay,...
For layering of up to 8 instruments (and eventually crossfading of 2 or 4 layers).
bool VCFCutoffControllerInvert
Inverts values coming from the defined cutoff controller.
General Purpose Controller 7 (Button, MIDI Controller 82)
Controlled internally and by external foot controller.
Different samples triggered each time a note is played, random order.
virtual void CopyAssign(const Region *orig)
Make a (semi) deep copy of the Region object given by orig and assign it to this object.
void SwapScriptSlots(uint index1, uint index2)
Flip two script slots with each other (gig format extension).
double EG2Release
Release time of the filter cutoff EG (0.000 - 60.000s).
uint8_t EG1ControllerReleaseInfluence
Amount EG1 Controller has influence on the EG1 Release time (0 - 3, where 0 means off).
uint8_t EG2ControllerDecayInfluence
Amount EG2 Controller has influence on the EG2 Decay time (0 - 3, where 0 means off).
bool Polyphonic
If alternator should step forward only when all notes are off.
Abstract base class for all MIDI rules.
ScriptGroup * GetGroup() const
Returns the script group this script currently belongs to.
void SetVelocityResponseCurveScaling(uint8_t scaling)
Updates the respective member variable and the lookup table / cache that depends on this value.
virtual void UpdateChunks(progress_t *pProgress)
Apply all the gig file's current instruments, samples, groups and settings to the respective RIFF chu...
General Purpose Controller 2 (Slider, MIDI Controller 17)
dimension_t
Defines the type of dimension, that is how the dimension zones (and thus how the dimension regions ar...
ScriptGroup(File *file, RIFF::List *lstRTIS)
uint32_t LoopEnd
Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The ...
Defines the envelope of a crossfade.
uint8_t MIDIBankFine
Reflects the MIDI Bank number for MIDI Control Change 32 (bank 1 - 128).
curve_type_t ReleaseVelocityResponseCurve
Defines a transformation curve to the incoming release veloctiy values affecting envelope times.
Different samples triggered each time a note is played, dimension regions selected in sequence.
dimension_def_t pDimensionDefinitions[8]
Defines the five (gig2) or eight (gig3) possible dimensions (the dimension's controller and number of...
uint8_t zones
Number of zones the dimension has.
Effect 5 Depth (MIDI Controller 95)
General Purpose Controller 3 (Slider, MIDI Controller 18)
uint8_t & operator[](int i)
General Purpose Controller 8 (Button, MIDI Controller 83)
uint8_t AttenuationControllerThreshold
0-127
buffer_t GetCache()
Returns current cached sample points.
void SetVCFVelocityDynamicRange(uint8_t range)
Updates the respective member variable and the lookup table / cache that depends on this value.
vcf_cutoff_ctrl_t
Defines how the filter cutoff frequency is controlled by.
Encapsulates sample waves of Gigasampler/GigaStudio files used for playback.
virtual void SetGain(int32_t gain)
Updates the respective member variable and updates SampleAttenuation which depends on this value.
Group(File *file, RIFF::Chunk *ck3gnm)
Constructor.
General Purpose Controller 8 (Button, MIDI Controller 83)
unsigned long GuessSize(unsigned long samples)
dimension value between 0-127
Modulation Wheel (MIDI Controller 1)
int16_t LFO3InternalDepth
Firm depth of the sample pitch LFO (-1200 - +1200 cents).
virtual void UpdateChunks(progress_t *pProgress)
Apply dimension region settings to the respective RIFF chunks.
General Purpose Controller 5 (Button, MIDI Controller 80)
Lower and upper limit of a range.
Sample * GetNextSample()
Returns a pointer to the next Sample object of the file, NULL otherwise.
General Purpose Controller 1 (Slider, MIDI Controller 16)
double EG2Decay2
Only if EG2InfiniteSustain == false: 2nd stage decay time of the filter cutoff EG (0....
Portamento Time (Coarse, MIDI Controller 5)
virtual void UpdateChunks(progress_t *pProgress)
Apply Instrument with all its Regions to the respective RIFF chunks.
Encapsulates sample waves used for playback.
type_t type
Controller type.
uint controller_number
MIDI controller number if this controller is a control change controller, 0 otherwise.
uint8_t * VelocityTable
For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity ...
curve_type_t VelocityResponseCurve
Defines a transformation curve to the incoming velocity values affecting amplitude (usually you don't...
Effect Controller 2 (Coarse, MIDI Controller 13)
A MIDI rule not yet implemented by libgig.
Foot Pedal (Coarse, MIDI Controller 4)
uint16_t EG1Sustain
Sustain value of the sample amplitude EG (0 - 1000 permille).
Sample * GetSample(uint index)
Returns Sample object of index.
String GetFileName()
File name of this DLS file.
Real-time instrument script (gig format extension).
unsigned long NullExtensionSize
The buffer might be bigger than the actual data, if that's the case that unused space at the end of t...
void SetVelocityResponseDepth(uint8_t depth)
Updates the respective member variable and the lookup table / cache that depends on this value.
Sample * GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t *pProgress=NULL)
General Purpose Controller 6 (Button, MIDI Controller 81)
Gigasampler/GigaStudio specific classes and definitions.
uint8_t DimensionUpperLimits[8]
gig3: defines the upper limit of the dimension values for this dimension region. In case you wondered...
virtual void CopyAssign(const DimensionRegion *orig)
Make a (semi) deep copy of the DimensionRegion object given by orig and assign it to this object.
virtual void UpdateChunks(progress_t *pProgress)
Apply Region settings and all its DimensionRegions to the respective RIFF chunks.
uint8_t TriggerPoint
The CC value to pass for the note to be triggered.
uint8_t VelocityResponseDepth
Dynamic range of velocity affecting amplitude (0 - 4) (usually you don't have to interpret this param...
uint32_t LoopFraction
The fractional value specifies a fraction of a sample at which to loop. This allows a loop to be fine...
RIFF::progress_t progress_t
uint32_t TruncatedBits
For 24-bit compressed samples only: number of bits truncated during compression (0,...
Instrument * GetInstrument(uint index, progress_t *pProgress=NULL)
Returns the instrument with the given index.
virtual void UpdateChunks(uint8_t *pData) const =0
Group of instrument scripts (gig format extension).
int8_t Pan
Panorama / Balance (-64..0..63 <-> left..middle..right)
Provides convenient access to Gigasampler/GigaStudio .gig files.
Only internally controlled.
void SetGroup(ScriptGroup *pGroup)
Move this script from its current ScriptGroup to another ScriptGroup given by pGroup.
lfo2_ctrl_t
Defines how LFO2 is controlled by.
Effect 3 Depth (MIDI Controller 93)
Dimension for keyswitching.
MIDI rule for instruments with legato samples.
void SetReleaseVelocityResponseDepth(uint8_t depth)
Updates the respective member variable and the lookup table / cache that depends on this value.
Sample * GetFirstSample()
Returns the first Sample of this Group.
struct gig::MidiRuleCtrlTrigger::trigger_t pTriggers[32]
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...
leverage_ctrl_t eg1_ctrl_t
Defines controller influencing envelope generator 1.
uint16_t EG2Sustain
Sustain value of the filter cutoff EG (0 - 1000 permille).
dlsid_t * pDLSID
Points to a dlsid_t structure if the file provided a DLS ID else is NULL.
uint32_t Instruments
Reflects the number of available Instrument objects.
Provides all neccessary information for the synthesis of a DLS Instrument.
Provides access to a Gigasampler/GigaStudio instrument.
void SetScriptSlotBypassed(uint index, bool bBypass)
Defines whether execution shall be skipped.
void DeleteGroup(Group *pGroup)
Delete a group and its samples.
bool SustainDefeat
If true: Sustain pedal will not hold a note.
Encoding_t Encoding
Format the script's source code text is encoded with.
buffer_t RAMCache
Buffers samples (already uncompressed) in RAM.
virtual void CopyAssign(const Instrument *orig)
Make a (semi) deep copy of the Instrument object given by orig and assign it to this object.
bool NoteOff
If a note off should be triggered instead of a note on.
String libraryName()
Returns the name of this C++ library.
unsigned long GetPos() const
Returns the current position in the sample (in sample points).
Controlled internally and by external modulation wheel.
virtual void LoadGroups()
Quadtuple version number ("major.minor.release.build").
void MoveTo(Instrument *dst)
Move this instrument at the position before.
double LFO2Frequency
Frequency of the filter cutoff LFO (0.10 - 10.00 Hz).
uint32_t SamplePeriod
Specifies the duration of time that passes during the playback of one sample in nanoseconds (normally...
uint16_t EG1PreAttack
Preattack value of the sample amplitude EG (0 - 1000 permille).
Script * GetScriptOfSlot(uint index)
Get instrument script (gig format extension).
unsigned long * FrameTable
For positioning within compressed samples only: stores the offset values for each frame.
curve_type_t
Defines the shape of a function graph.
uint8_t bits
Number of "bits" (1 bit = 2 splits/zones, 2 bit = 4 splits/zones, 3 bit = 8 splits/zones,...
selector_t Selector
Method by which pattern is chosen.
uint8_t out_start
Start position of fade out.
uint8_t VCFCutoff
Max. cutoff frequency.
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.
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).
Info * pInfo
Points (in any case) to an Info object, providing additional, optional infos and comments.
uint32_t Manufacturer
Specifies the MIDI Manufacturer's Association (MMA) Manufacturer code for the sampler intended to rec...
uint8_t high
High value of range.
bool OverridePedal
If a note off should be triggered even if the sustain pedal is down.
MIDI rule to automatically cycle through specified sequences of different articulations.
Reflects the current playback state for a sample.
General dimension definition.
int Size
Number of steps in the pattern.
void CopyAssignMeta(const Sample *orig)
Make a (semi) deep copy of the Sample object given by orig (without the actual waveform data) and ass...
eg1_ctrl_t EG1Controller
MIDI Controller which has influence on sample amplitude EG parameters (attack, decay,...
Sostenuto Pedal (MIDI Controller 66)
split_type_t split_type
Intended for internal usage: will be used to convert a dimension value into the corresponding dimensi...
void DeleteScript(Script *pScript)
Delete an instrument script.
If used sample has more than one channel (thus is not mono).
virtual void UpdateChunks(progress_t *pProgress)
Apply sample and its settings to the respective RIFF chunks.
void SetReleaseVelocityResponseCurve(curve_type_t curve)
Updates the respective member variable and the lookup table / cache that depends on this value.
dim_bypass_ctrl_t
Dimensions allow to bypass one of the following controllers.
vcf_res_ctrl_t VCFResonanceController
Specifies which external controller has influence on the filter resonance Q.
Is not compressed at all (default).
curve_type_t VCFVelocityCurve
Defines a transformation curve for the incoming velocity values, affecting the VCF.
uint8_t EG1ControllerDecayInfluence
Amount EG1 Controller has influence on the EG1 Decay time (0 - 3, where 0 means off).
Defines Region information of an Instrument.
Effect 4 Depth (MIDI Controller 94)
General Purpose Controller 7 (Button, MIDI Controller 82)
double GetVelocityAttenuation(uint8_t MIDIKeyVelocity)
Returns the correct amplitude factor for the given MIDIKeyVelocity.
Sample * GetSample()
Returns pointer address to the Sample referenced with this region.
void SetVelocityResponseCurve(curve_type_t curve)
Updates the respective member variable and the lookup table / cache that depends on this value.
double EG1Attack
Attack time of the sample amplitude EG (0.000 - 60.000s).
bool IsDrum
Indicates if the Instrument is a drum type, as they differ in the synthesis model of DLS from melodic...
void DeleteScriptGroup(ScriptGroup *pGroup)
Delete an instrument script group.
Region * GetNextRegion()
Returns the next Region of the instrument.
void AddSampleLoop(sample_loop_t *pLoopDef)
Adds a new sample loop with the provided loop definition.