2 |
* * |
* * |
3 |
* libgig - C++ cross-platform Gigasampler format file access library * |
* libgig - C++ cross-platform Gigasampler format file access library * |
4 |
* * |
* * |
5 |
* Copyright (C) 2003-2013 by Christian Schoenebeck * |
* Copyright (C) 2003-2014 by Christian Schoenebeck * |
6 |
* <cuse@users.sourceforge.net> * |
* <cuse@users.sourceforge.net> * |
7 |
* * |
* * |
8 |
* This library is free software; you can redistribute it and/or modify * |
* This library is free software; you can redistribute it and/or modify * |
342 |
*/ |
*/ |
343 |
class DimensionRegion : protected DLS::Sampler { |
class DimensionRegion : protected DLS::Sampler { |
344 |
public: |
public: |
345 |
uint8_t VelocityUpperLimit; ///< Defines the upper velocity value limit of a velocity split (only if an user defined limit was set, thus a value not equal to 128/NumberOfSplits, else this value is 0). Only for gig2, otherwise the DimensionUpperLimts are used instead. |
uint8_t VelocityUpperLimit; ///< Defines the upper velocity value limit of a velocity split (only if an user defined limit was set, thus a value not equal to 128/NumberOfSplits, else this value is 0). Only for gig2, for gig3 and above the DimensionUpperLimits are used instead. |
346 |
Sample* pSample; ///< Points to the Sample which is assigned to the dimension region. |
Sample* pSample; ///< Points to the Sample which is assigned to the dimension region. |
347 |
// Sample Amplitude EG/LFO |
// Sample Amplitude EG/LFO |
348 |
uint16_t EG1PreAttack; ///< Preattack value of the sample amplitude EG (0 - 1000 permille). |
uint16_t EG1PreAttack; ///< Preattack value of the sample amplitude EG (0 - 1000 permille). |
426 |
bool MSDecode; ///< Gigastudio flag: defines if Mid Side Recordings should be decoded. |
bool MSDecode; ///< Gigastudio flag: defines if Mid Side Recordings should be decoded. |
427 |
uint16_t SampleStartOffset; ///< Number of samples the sample start should be moved (0 - 2000). |
uint16_t SampleStartOffset; ///< Number of samples the sample start should be moved (0 - 2000). |
428 |
double SampleAttenuation; ///< Sample volume (calculated from DLS::Sampler::Gain) |
double SampleAttenuation; ///< Sample volume (calculated from DLS::Sampler::Gain) |
429 |
uint8_t DimensionUpperLimits[8]; ///< gig3: defines the upper limit of the dimension values for this dimension region |
uint8_t DimensionUpperLimits[8]; ///< gig3: defines the upper limit of the dimension values for this dimension region. In case you wondered why this is defined on DimensionRegion level and not on Region level: the zone sizes (upper limits) of the velocity dimension can indeed differ in the individual dimension regions, depending on which zones of the other dimension types are currently selected. So this is exceptional for the velocity dimension only. All other dimension types have the same dimension zone sizes for every single DimensionRegion (of the sample Region). |
430 |
|
|
431 |
// derived attributes from DLS::Sampler |
// derived attributes from DLS::Sampler |
432 |
using DLS::Sampler::UnityNote; |
using DLS::Sampler::UnityNote; |
461 |
DimensionRegion(Region* pParent, RIFF::List* _3ewl); |
DimensionRegion(Region* pParent, RIFF::List* _3ewl); |
462 |
DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src); |
DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src); |
463 |
~DimensionRegion(); |
~DimensionRegion(); |
464 |
|
void CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples); |
465 |
friend class Region; |
friend class Region; |
466 |
private: |
private: |
467 |
typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller |
typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller |
468 |
|
// official leverage controllers as they were defined in the original Gigasampler/GigaStudio format: |
469 |
_lev_ctrl_none = 0x00, |
_lev_ctrl_none = 0x00, |
470 |
_lev_ctrl_modwheel = 0x03, ///< Modulation Wheel (MIDI Controller 1) |
_lev_ctrl_modwheel = 0x03, ///< Modulation Wheel (MIDI Controller 1) |
471 |
_lev_ctrl_breath = 0x05, ///< Breath Controller (Coarse, MIDI Controller 2) |
_lev_ctrl_breath = 0x05, ///< Breath Controller (Coarse, MIDI Controller 2) |
491 |
_lev_ctrl_effect4depth = 0x2b, ///< Effect 4 Depth (MIDI Controller 94) |
_lev_ctrl_effect4depth = 0x2b, ///< Effect 4 Depth (MIDI Controller 94) |
492 |
_lev_ctrl_effect5depth = 0x2d, ///< Effect 5 Depth (MIDI Controller 95) |
_lev_ctrl_effect5depth = 0x2d, ///< Effect 5 Depth (MIDI Controller 95) |
493 |
_lev_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure |
_lev_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure |
494 |
_lev_ctrl_velocity = 0xff ///< Key Velocity |
_lev_ctrl_velocity = 0xff, ///< Key Velocity |
495 |
|
|
496 |
|
// format extension (these controllers are so far only supported by LinuxSampler & gigedit) they will *NOT* work with Gigasampler/GigaStudio ! |
497 |
|
// (the assigned values here are their official MIDI CC number plus the highest bit set): |
498 |
|
_lev_ctrl_CC3_EXT = 0x83, ///< MIDI Controller 3 [gig format extension] |
499 |
|
|
500 |
|
_lev_ctrl_CC6_EXT = 0x86, ///< Data Entry MSB (MIDI Controller 6) [gig format extension] |
501 |
|
_lev_ctrl_CC7_EXT = 0x87, ///< Channel Volume (MIDI Controller 7) [gig format extension] |
502 |
|
_lev_ctrl_CC8_EXT = 0x88, ///< Balance (MIDI Controller 8) [gig format extension] |
503 |
|
_lev_ctrl_CC9_EXT = 0x89, ///< MIDI Controller 9 [gig format extension] |
504 |
|
_lev_ctrl_CC10_EXT = 0x8a, ///< Pan (MIDI Controller 10) [gig format extension] |
505 |
|
_lev_ctrl_CC11_EXT = 0x8b, ///< Expression Controller (MIDI Controller 11) [gig format extension] |
506 |
|
|
507 |
|
_lev_ctrl_CC14_EXT = 0x8e, ///< MIDI Controller 14 [gig format extension] |
508 |
|
_lev_ctrl_CC15_EXT = 0x8f, ///< MIDI Controller 15 [gig format extension] |
509 |
|
|
510 |
|
_lev_ctrl_CC20_EXT = 0x94, ///< MIDI Controller 20 [gig format extension] |
511 |
|
_lev_ctrl_CC21_EXT = 0x95, ///< MIDI Controller 21 [gig format extension] |
512 |
|
_lev_ctrl_CC22_EXT = 0x96, ///< MIDI Controller 22 [gig format extension] |
513 |
|
_lev_ctrl_CC23_EXT = 0x97, ///< MIDI Controller 23 [gig format extension] |
514 |
|
_lev_ctrl_CC24_EXT = 0x98, ///< MIDI Controller 24 [gig format extension] |
515 |
|
_lev_ctrl_CC25_EXT = 0x99, ///< MIDI Controller 25 [gig format extension] |
516 |
|
_lev_ctrl_CC26_EXT = 0x9a, ///< MIDI Controller 26 [gig format extension] |
517 |
|
_lev_ctrl_CC27_EXT = 0x9b, ///< MIDI Controller 27 [gig format extension] |
518 |
|
_lev_ctrl_CC28_EXT = 0x9c, ///< MIDI Controller 28 [gig format extension] |
519 |
|
_lev_ctrl_CC29_EXT = 0x9d, ///< MIDI Controller 29 [gig format extension] |
520 |
|
_lev_ctrl_CC30_EXT = 0x9e, ///< MIDI Controller 30 [gig format extension] |
521 |
|
_lev_ctrl_CC31_EXT = 0x9f, ///< MIDI Controller 31 [gig format extension] |
522 |
|
|
523 |
|
_lev_ctrl_CC68_EXT = 0xc4, ///< Legato Footswitch (MIDI Controller 68) [gig format extension] |
524 |
|
_lev_ctrl_CC69_EXT = 0xc5, ///< Hold 2 (MIDI Controller 69) [gig format extension] |
525 |
|
_lev_ctrl_CC70_EXT = 0xc6, ///< Sound Ctrl. 1 - Sound Variation (MIDI Controller 70) [gig format extension] |
526 |
|
_lev_ctrl_CC71_EXT = 0xc7, ///< Sound Ctrl. 2 - Timbre (MIDI Controller 71) [gig format extension] |
527 |
|
_lev_ctrl_CC72_EXT = 0xc8, ///< Sound Ctrl. 3 - Release Time (MIDI Controller 72) [gig format extension] |
528 |
|
_lev_ctrl_CC73_EXT = 0xc9, ///< Sound Ctrl. 4 - Attack Time (MIDI Controller 73) [gig format extension] |
529 |
|
_lev_ctrl_CC74_EXT = 0xca, ///< Sound Ctrl. 5 - Brightness (MIDI Controller 74) [gig format extension] |
530 |
|
_lev_ctrl_CC75_EXT = 0xcb, ///< Sound Ctrl. 6 - Decay Time (MIDI Controller 75) [gig format extension] |
531 |
|
_lev_ctrl_CC76_EXT = 0xcc, ///< Sound Ctrl. 7 - Vibrato Rate (MIDI Controller 76) [gig format extension] |
532 |
|
_lev_ctrl_CC77_EXT = 0xcd, ///< Sound Ctrl. 8 - Vibrato Depth (MIDI Controller 77) [gig format extension] |
533 |
|
_lev_ctrl_CC78_EXT = 0xce, ///< Sound Ctrl. 9 - Vibrato Delay (MIDI Controller 78) [gig format extension] |
534 |
|
_lev_ctrl_CC79_EXT = 0xcf, ///< Sound Ctrl. 10 (MIDI Controller 79) [gig format extension] |
535 |
|
|
536 |
|
_lev_ctrl_CC84_EXT = 0xd4, ///< Portamento Control (MIDI Controller 84) [gig format extension] |
537 |
|
_lev_ctrl_CC85_EXT = 0xd5, ///< MIDI Controller 85 [gig format extension] |
538 |
|
_lev_ctrl_CC86_EXT = 0xd6, ///< MIDI Controller 86 [gig format extension] |
539 |
|
_lev_ctrl_CC87_EXT = 0xd7, ///< MIDI Controller 87 [gig format extension] |
540 |
|
|
541 |
|
_lev_ctrl_CC89_EXT = 0xd9, ///< MIDI Controller 89 [gig format extension] |
542 |
|
_lev_ctrl_CC90_EXT = 0xda, ///< MIDI Controller 90 [gig format extension] |
543 |
|
|
544 |
|
_lev_ctrl_CC96_EXT = 0xe0, ///< Data Increment (MIDI Controller 96) [gig format extension] |
545 |
|
_lev_ctrl_CC97_EXT = 0xe1, ///< Data Decrement (MIDI Controller 97) [gig format extension] |
546 |
|
|
547 |
|
_lev_ctrl_CC102_EXT = 0xe6, ///< MIDI Controller 102 [gig format extension] |
548 |
|
_lev_ctrl_CC103_EXT = 0xe7, ///< MIDI Controller 103 [gig format extension] |
549 |
|
_lev_ctrl_CC104_EXT = 0xe8, ///< MIDI Controller 104 [gig format extension] |
550 |
|
_lev_ctrl_CC105_EXT = 0xe9, ///< MIDI Controller 105 [gig format extension] |
551 |
|
_lev_ctrl_CC106_EXT = 0xea, ///< MIDI Controller 106 [gig format extension] |
552 |
|
_lev_ctrl_CC107_EXT = 0xeb, ///< MIDI Controller 107 [gig format extension] |
553 |
|
_lev_ctrl_CC108_EXT = 0xec, ///< MIDI Controller 108 [gig format extension] |
554 |
|
_lev_ctrl_CC109_EXT = 0xed, ///< MIDI Controller 109 [gig format extension] |
555 |
|
_lev_ctrl_CC110_EXT = 0xee, ///< MIDI Controller 110 [gig format extension] |
556 |
|
_lev_ctrl_CC111_EXT = 0xef, ///< MIDI Controller 111 [gig format extension] |
557 |
|
_lev_ctrl_CC112_EXT = 0xf0, ///< MIDI Controller 112 [gig format extension] |
558 |
|
_lev_ctrl_CC113_EXT = 0xf1, ///< MIDI Controller 113 [gig format extension] |
559 |
|
_lev_ctrl_CC114_EXT = 0xf2, ///< MIDI Controller 114 [gig format extension] |
560 |
|
_lev_ctrl_CC115_EXT = 0xf3, ///< MIDI Controller 115 [gig format extension] |
561 |
|
_lev_ctrl_CC116_EXT = 0xf4, ///< MIDI Controller 116 [gig format extension] |
562 |
|
_lev_ctrl_CC117_EXT = 0xf5, ///< MIDI Controller 117 [gig format extension] |
563 |
|
_lev_ctrl_CC118_EXT = 0xf6, ///< MIDI Controller 118 [gig format extension] |
564 |
|
_lev_ctrl_CC119_EXT = 0xf7 ///< MIDI Controller 119 [gig format extension] |
565 |
} _lev_ctrl_t; |
} _lev_ctrl_t; |
566 |
typedef std::map<uint32_t, double*> VelocityTableMap; |
typedef std::map<uint32_t, double*> VelocityTableMap; |
567 |
|
|
629 |
void ReleaseSampleData(); |
void ReleaseSampleData(); |
630 |
void Resize(int iNewSize); |
void Resize(int iNewSize); |
631 |
unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start); |
unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start); |
632 |
unsigned long GetPos(); |
unsigned long GetPos() const; |
633 |
unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL); |
unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL); |
634 |
unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer = NULL); |
unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer = NULL); |
635 |
unsigned long Write(void* pBuffer, unsigned long SampleCount); |
unsigned long Write(void* pBuffer, unsigned long SampleCount); |
636 |
Group* GetGroup() const; |
Group* GetGroup() const; |
637 |
virtual void UpdateChunks(); |
virtual void UpdateChunks(); |
638 |
|
void CopyAssignMeta(const Sample* orig); |
639 |
|
void CopyAssignWave(const Sample* orig); |
640 |
protected: |
protected: |
641 |
static unsigned int Instances; ///< Number of instances of class Sample. |
static unsigned int Instances; ///< Number of instances of class Sample. |
642 |
static buffer_t InternalDecompressionBuffer; ///< Buffer used for decompression as well as for truncation of 24 Bit -> 16 Bit samples. |
static buffer_t InternalDecompressionBuffer; ///< Buffer used for decompression as well as for truncation of 24 Bit -> 16 Bit samples. |
685 |
}; |
}; |
686 |
|
|
687 |
// TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions) |
// TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions) |
688 |
/** Defines <i>Region</i> information of an <i>Instrument</i>. */ |
/** @brief Defines Region information of an Instrument. |
689 |
|
* |
690 |
|
* A Region reflects a consecutive area on the keyboard. The individual |
691 |
|
* regions in the gig format may not overlap with other regions (of the same |
692 |
|
* instrument). Further, in the gig format a Region is merely a container |
693 |
|
* for DimensionRegions (a.k.a. "Cases"). The Region itself does not provide |
694 |
|
* the sample mapping or articulation informations used, even though the |
695 |
|
* data structures indeed provide such informations. The latter is however |
696 |
|
* just of historical nature, because the gig format was derived from the |
697 |
|
* DLS format. |
698 |
|
* |
699 |
|
* Each Region consists of at least one or more DimensionRegions. The actual |
700 |
|
* amount of DimensionRegions depends on which kind of "dimensions" are |
701 |
|
* defined for this region, and on the split / zone amount for each of those |
702 |
|
* dimensions. |
703 |
|
*/ |
704 |
class Region : public DLS::Region { |
class Region : public DLS::Region { |
705 |
public: |
public: |
706 |
unsigned int Dimensions; ///< Number of defined dimensions, do not alter! |
unsigned int Dimensions; ///< Number of defined dimensions, do not alter! |
715 |
Sample* GetSample(); |
Sample* GetSample(); |
716 |
void AddDimension(dimension_def_t* pDimDef); |
void AddDimension(dimension_def_t* pDimDef); |
717 |
void DeleteDimension(dimension_def_t* pDimDef); |
void DeleteDimension(dimension_def_t* pDimDef); |
718 |
|
dimension_def_t* GetDimensionDefinition(dimension_t type); |
719 |
|
void DeleteDimensionZone(dimension_t type, int zone); |
720 |
|
void SplitDimensionZone(dimension_t type, int zone); |
721 |
// overridden methods |
// overridden methods |
722 |
virtual void SetKeyRange(uint16_t Low, uint16_t High); |
virtual void SetKeyRange(uint16_t Low, uint16_t High); |
723 |
virtual void UpdateChunks(); |
virtual void UpdateChunks(); |
727 |
void LoadDimensionRegions(RIFF::List* rgn); |
void LoadDimensionRegions(RIFF::List* rgn); |
728 |
void UpdateVelocityTable(); |
void UpdateVelocityTable(); |
729 |
Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL); |
Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL); |
730 |
|
void CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples); |
731 |
|
DimensionRegion* GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase); |
732 |
~Region(); |
~Region(); |
733 |
friend class Instrument; |
friend class Instrument; |
734 |
}; |
}; |
877 |
|
|
878 |
Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL); |
Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL); |
879 |
~Instrument(); |
~Instrument(); |
880 |
|
void CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples); |
881 |
void UpdateRegionKeyTable(); |
void UpdateRegionKeyTable(); |
882 |
friend class File; |
friend class File; |
883 |
friend class Region; // so Region can call UpdateRegionKeyTable() |
friend class Region; // so Region can call UpdateRegionKeyTable() |
936 |
// derived methods from DLS::File |
// derived methods from DLS::File |
937 |
using DLS::File::Save; |
using DLS::File::Save; |
938 |
using DLS::File::GetFileName; |
using DLS::File::GetFileName; |
939 |
|
using DLS::File::SetFileName; |
940 |
// overridden methods |
// overridden methods |
941 |
File(); |
File(); |
942 |
File(RIFF::File* pRIFF); |
File(RIFF::File* pRIFF); |
943 |
Sample* GetFirstSample(progress_t* pProgress = NULL); ///< Returns a pointer to the first <i>Sample</i> object of the file, <i>NULL</i> otherwise. |
Sample* GetFirstSample(progress_t* pProgress = NULL); ///< Returns a pointer to the first <i>Sample</i> object of the file, <i>NULL</i> otherwise. |
944 |
Sample* GetNextSample(); ///< Returns a pointer to the next <i>Sample</i> object of the file, <i>NULL</i> otherwise. |
Sample* GetNextSample(); ///< Returns a pointer to the next <i>Sample</i> object of the file, <i>NULL</i> otherwise. |
945 |
|
Sample* GetSample(uint index); |
946 |
Sample* AddSample(); |
Sample* AddSample(); |
947 |
void DeleteSample(Sample* pSample); |
void DeleteSample(Sample* pSample); |
948 |
Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <i>Instrument</i> object of the file, <i>NULL</i> otherwise. |
Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <i>Instrument</i> object of the file, <i>NULL</i> otherwise. |
954 |
Group* GetFirstGroup(); ///< Returns a pointer to the first <i>Group</i> object of the file, <i>NULL</i> otherwise. |
Group* GetFirstGroup(); ///< Returns a pointer to the first <i>Group</i> object of the file, <i>NULL</i> otherwise. |
955 |
Group* GetNextGroup(); ///< Returns a pointer to the next <i>Group</i> object of the file, <i>NULL</i> otherwise. |
Group* GetNextGroup(); ///< Returns a pointer to the next <i>Group</i> object of the file, <i>NULL</i> otherwise. |
956 |
Group* GetGroup(uint index); |
Group* GetGroup(uint index); |
957 |
|
Group* GetGroup(String name); |
958 |
Group* AddGroup(); |
Group* AddGroup(); |
959 |
void DeleteGroup(Group* pGroup); |
void DeleteGroup(Group* pGroup); |
960 |
void DeleteGroupOnly(Group* pGroup); |
void DeleteGroupOnly(Group* pGroup); |
961 |
void SetAutoLoad(bool b); |
void SetAutoLoad(bool b); |
962 |
bool GetAutoLoad(); |
bool GetAutoLoad(); |
963 |
|
void AddContentOf(File* pFile); |
964 |
virtual ~File(); |
virtual ~File(); |
965 |
virtual void UpdateChunks(); |
virtual void UpdateChunks(); |
966 |
protected: |
protected: |