/[svn]/libgig/trunk/src/gig.h
ViewVC logotype

Diff of /libgig/trunk/src/gig.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2334 by persson, Sat Mar 17 06:18:52 2012 UTC revision 2609 by schoenebeck, Sun Jun 8 19:00:30 2014 UTC
# Line 2  Line 2 
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-2012 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  *
# Line 25  Line 25 
25  #define __GIG_H__  #define __GIG_H__
26    
27  #include "DLS.h"  #include "DLS.h"
28    #include <vector>
29    
30  #if WORDS_BIGENDIAN  #if WORDS_BIGENDIAN
31  # define LIST_TYPE_3PRG 0x33707267  # define LIST_TYPE_3PRG 0x33707267
32  # define LIST_TYPE_3EWL 0x3365776C  # define LIST_TYPE_3EWL 0x3365776C
33  # define LIST_TYPE_3GRI 0x33677269  # define LIST_TYPE_3GRI 0x33677269
34  # define LIST_TYPE_3GNL 0x33676E6C  # 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  # define CHUNK_ID_3GIX  0x33676978
38  # define CHUNK_ID_3EWA  0x33657761  # define CHUNK_ID_3EWA  0x33657761
39  # define CHUNK_ID_3LNK  0x336C6E6B  # define CHUNK_ID_3LNK  0x336C6E6B
# Line 39  Line 42 
42  # define CHUNK_ID_3GNM  0x33676E6D  # define CHUNK_ID_3GNM  0x33676E6D
43  # define CHUNK_ID_EINF  0x65696E66  # define CHUNK_ID_EINF  0x65696E66
44  # define CHUNK_ID_3CRC  0x33637263  # 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  #else  // little endian
49  # define LIST_TYPE_3PRG 0x67727033  # define LIST_TYPE_3PRG 0x67727033
50  # define LIST_TYPE_3EWL 0x6C776533  # define LIST_TYPE_3EWL 0x6C776533
51  # define LIST_TYPE_3GRI 0x69726733  # define LIST_TYPE_3GRI 0x69726733
52  # define LIST_TYPE_3GNL 0x6C6E6733  # 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  # define CHUNK_ID_3GIX  0x78696733
56  # define CHUNK_ID_3EWA  0x61776533  # define CHUNK_ID_3EWA  0x61776533
57  # define CHUNK_ID_3LNK  0x6B6E6C33  # define CHUNK_ID_3LNK  0x6B6E6C33
# Line 52  Line 60 
60  # define CHUNK_ID_3GNM  0x6D6E6733  # define CHUNK_ID_3GNM  0x6D6E6733
61  # define CHUNK_ID_EINF  0x666E6965  # define CHUNK_ID_EINF  0x666E6965
62  # define CHUNK_ID_3CRC  0x63726333  # 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  #endif // WORDS_BIGENDIAN
67    
68  /** Gigasampler specific classes and definitions */  /** Gigasampler specific classes and definitions */
# Line 327  namespace gig { Line 338  namespace gig {
338      class Sample;      class Sample;
339      class Region;      class Region;
340      class Group;      class Group;
341        class Script;
342        class ScriptGroup;
343    
344      /** @brief Encapsulates articulation information of a dimension region.      /** @brief Encapsulates articulation information of a dimension region.
345       *       *
# Line 342  namespace gig { Line 355  namespace gig {
355       */       */
356      class DimensionRegion : protected DLS::Sampler {      class DimensionRegion : protected DLS::Sampler {
357          public:          public:
358              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.
359              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.
360              // Sample Amplitude EG/LFO              // Sample Amplitude EG/LFO
361              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).
# Line 426  namespace gig { Line 439  namespace gig {
439              bool               MSDecode;                      ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.              bool               MSDecode;                      ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.
440              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).
441              double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)              double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)
442              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).
443    
444              // derived attributes from DLS::Sampler              // derived attributes from DLS::Sampler
445              using DLS::Sampler::UnityNote;              using DLS::Sampler::UnityNote;
# Line 455  namespace gig { Line 468  namespace gig {
468              // overridden methods              // overridden methods
469              virtual void SetGain(int32_t gain);              virtual void SetGain(int32_t gain);
470              virtual void UpdateChunks();              virtual void UpdateChunks();
471                virtual void CopyAssign(const DimensionRegion* orig);
472          protected:          protected:
473              uint8_t* VelocityTable; ///< For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity MIDI value to dimension bit number.              uint8_t* VelocityTable; ///< For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity MIDI value to dimension bit number.
474              DimensionRegion(Region* pParent, RIFF::List* _3ewl);              DimensionRegion(Region* pParent, RIFF::List* _3ewl);
475              DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src);              DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src);
476             ~DimensionRegion();             ~DimensionRegion();
477                void CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples);
478              friend class Region;              friend class Region;
479          private:          private:
480              typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller              typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller
481                    // official leverage controllers as they were defined in the original Gigasampler/GigaStudio format:
482                  _lev_ctrl_none              = 0x00,                  _lev_ctrl_none              = 0x00,
483                  _lev_ctrl_modwheel          = 0x03, ///< Modulation Wheel (MIDI Controller 1)                  _lev_ctrl_modwheel          = 0x03, ///< Modulation Wheel (MIDI Controller 1)
484                  _lev_ctrl_breath            = 0x05, ///< Breath Controller (Coarse, MIDI Controller 2)                  _lev_ctrl_breath            = 0x05, ///< Breath Controller (Coarse, MIDI Controller 2)
# Line 488  namespace gig { Line 504  namespace gig {
504                  _lev_ctrl_effect4depth      = 0x2b, ///< Effect 4 Depth (MIDI Controller 94)                  _lev_ctrl_effect4depth      = 0x2b, ///< Effect 4 Depth (MIDI Controller 94)
505                  _lev_ctrl_effect5depth      = 0x2d, ///< Effect 5 Depth (MIDI Controller 95)                  _lev_ctrl_effect5depth      = 0x2d, ///< Effect 5 Depth (MIDI Controller 95)
506                  _lev_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure                  _lev_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure
507                  _lev_ctrl_velocity          = 0xff  ///< Key Velocity                  _lev_ctrl_velocity          = 0xff, ///< Key Velocity
508    
509                    // format extension (these controllers are so far only supported by LinuxSampler & gigedit) they will *NOT* work with Gigasampler/GigaStudio !
510                    // (the assigned values here are their official MIDI CC number plus the highest bit set):
511                    _lev_ctrl_CC3_EXT           = 0x83, ///< MIDI Controller 3 [gig format extension]
512    
513                    _lev_ctrl_CC6_EXT           = 0x86, ///< Data Entry MSB (MIDI Controller 6) [gig format extension]
514                    _lev_ctrl_CC7_EXT           = 0x87, ///< Channel Volume (MIDI Controller 7) [gig format extension]
515                    _lev_ctrl_CC8_EXT           = 0x88, ///< Balance (MIDI Controller 8) [gig format extension]
516                    _lev_ctrl_CC9_EXT           = 0x89, ///< MIDI Controller 9 [gig format extension]
517                    _lev_ctrl_CC10_EXT          = 0x8a, ///< Pan (MIDI Controller 10) [gig format extension]
518                    _lev_ctrl_CC11_EXT          = 0x8b, ///< Expression Controller (MIDI Controller 11) [gig format extension]
519    
520                    _lev_ctrl_CC14_EXT          = 0x8e, ///< MIDI Controller 14 [gig format extension]
521                    _lev_ctrl_CC15_EXT          = 0x8f, ///< MIDI Controller 15 [gig format extension]
522    
523                    _lev_ctrl_CC20_EXT          = 0x94, ///< MIDI Controller 20 [gig format extension]
524                    _lev_ctrl_CC21_EXT          = 0x95, ///< MIDI Controller 21 [gig format extension]
525                    _lev_ctrl_CC22_EXT          = 0x96, ///< MIDI Controller 22 [gig format extension]
526                    _lev_ctrl_CC23_EXT          = 0x97, ///< MIDI Controller 23 [gig format extension]
527                    _lev_ctrl_CC24_EXT          = 0x98, ///< MIDI Controller 24 [gig format extension]
528                    _lev_ctrl_CC25_EXT          = 0x99, ///< MIDI Controller 25 [gig format extension]
529                    _lev_ctrl_CC26_EXT          = 0x9a, ///< MIDI Controller 26 [gig format extension]
530                    _lev_ctrl_CC27_EXT          = 0x9b, ///< MIDI Controller 27 [gig format extension]
531                    _lev_ctrl_CC28_EXT          = 0x9c, ///< MIDI Controller 28 [gig format extension]
532                    _lev_ctrl_CC29_EXT          = 0x9d, ///< MIDI Controller 29 [gig format extension]
533                    _lev_ctrl_CC30_EXT          = 0x9e, ///< MIDI Controller 30 [gig format extension]
534                    _lev_ctrl_CC31_EXT          = 0x9f, ///< MIDI Controller 31 [gig format extension]
535    
536                    _lev_ctrl_CC68_EXT          = 0xc4, ///< Legato Footswitch (MIDI Controller 68) [gig format extension]
537                    _lev_ctrl_CC69_EXT          = 0xc5, ///< Hold 2 (MIDI Controller 69) [gig format extension]
538                    _lev_ctrl_CC70_EXT          = 0xc6, ///< Sound Ctrl. 1 - Sound Variation (MIDI Controller 70) [gig format extension]
539                    _lev_ctrl_CC71_EXT          = 0xc7, ///< Sound Ctrl. 2 - Timbre (MIDI Controller 71) [gig format extension]
540                    _lev_ctrl_CC72_EXT          = 0xc8, ///< Sound Ctrl. 3 - Release Time (MIDI Controller 72) [gig format extension]
541                    _lev_ctrl_CC73_EXT          = 0xc9, ///< Sound Ctrl. 4 - Attack Time (MIDI Controller 73) [gig format extension]
542                    _lev_ctrl_CC74_EXT          = 0xca, ///< Sound Ctrl. 5 - Brightness (MIDI Controller 74) [gig format extension]
543                    _lev_ctrl_CC75_EXT          = 0xcb, ///< Sound Ctrl. 6 - Decay Time (MIDI Controller 75) [gig format extension]
544                    _lev_ctrl_CC76_EXT          = 0xcc, ///< Sound Ctrl. 7 - Vibrato Rate (MIDI Controller 76) [gig format extension]
545                    _lev_ctrl_CC77_EXT          = 0xcd, ///< Sound Ctrl. 8 - Vibrato Depth (MIDI Controller 77) [gig format extension]
546                    _lev_ctrl_CC78_EXT          = 0xce, ///< Sound Ctrl. 9 - Vibrato Delay (MIDI Controller 78) [gig format extension]
547                    _lev_ctrl_CC79_EXT          = 0xcf, ///< Sound Ctrl. 10 (MIDI Controller 79) [gig format extension]
548    
549                    _lev_ctrl_CC84_EXT          = 0xd4, ///< Portamento Control (MIDI Controller 84) [gig format extension]
550                    _lev_ctrl_CC85_EXT          = 0xd5, ///< MIDI Controller 85 [gig format extension]
551                    _lev_ctrl_CC86_EXT          = 0xd6, ///< MIDI Controller 86 [gig format extension]
552                    _lev_ctrl_CC87_EXT          = 0xd7, ///< MIDI Controller 87 [gig format extension]
553    
554                    _lev_ctrl_CC89_EXT          = 0xd9, ///< MIDI Controller 89 [gig format extension]
555                    _lev_ctrl_CC90_EXT          = 0xda, ///< MIDI Controller 90 [gig format extension]
556    
557                    _lev_ctrl_CC96_EXT          = 0xe0, ///< Data Increment (MIDI Controller 96) [gig format extension]
558                    _lev_ctrl_CC97_EXT          = 0xe1, ///< Data Decrement (MIDI Controller 97) [gig format extension]
559    
560                    _lev_ctrl_CC102_EXT         = 0xe6, ///< MIDI Controller 102 [gig format extension]
561                    _lev_ctrl_CC103_EXT         = 0xe7, ///< MIDI Controller 103 [gig format extension]
562                    _lev_ctrl_CC104_EXT         = 0xe8, ///< MIDI Controller 104 [gig format extension]
563                    _lev_ctrl_CC105_EXT         = 0xe9, ///< MIDI Controller 105 [gig format extension]
564                    _lev_ctrl_CC106_EXT         = 0xea, ///< MIDI Controller 106 [gig format extension]
565                    _lev_ctrl_CC107_EXT         = 0xeb, ///< MIDI Controller 107 [gig format extension]
566                    _lev_ctrl_CC108_EXT         = 0xec, ///< MIDI Controller 108 [gig format extension]
567                    _lev_ctrl_CC109_EXT         = 0xed, ///< MIDI Controller 109 [gig format extension]
568                    _lev_ctrl_CC110_EXT         = 0xee, ///< MIDI Controller 110 [gig format extension]
569                    _lev_ctrl_CC111_EXT         = 0xef, ///< MIDI Controller 111 [gig format extension]
570                    _lev_ctrl_CC112_EXT         = 0xf0, ///< MIDI Controller 112 [gig format extension]
571                    _lev_ctrl_CC113_EXT         = 0xf1, ///< MIDI Controller 113 [gig format extension]
572                    _lev_ctrl_CC114_EXT         = 0xf2, ///< MIDI Controller 114 [gig format extension]
573                    _lev_ctrl_CC115_EXT         = 0xf3, ///< MIDI Controller 115 [gig format extension]
574                    _lev_ctrl_CC116_EXT         = 0xf4, ///< MIDI Controller 116 [gig format extension]
575                    _lev_ctrl_CC117_EXT         = 0xf5, ///< MIDI Controller 117 [gig format extension]
576                    _lev_ctrl_CC118_EXT         = 0xf6, ///< MIDI Controller 118 [gig format extension]
577                    _lev_ctrl_CC119_EXT         = 0xf7  ///< MIDI Controller 119 [gig format extension]
578              } _lev_ctrl_t;              } _lev_ctrl_t;
579              typedef std::map<uint32_t, double*> VelocityTableMap;              typedef std::map<uint32_t, double*> VelocityTableMap;
580    
# Line 556  namespace gig { Line 642  namespace gig {
642              void          ReleaseSampleData();              void          ReleaseSampleData();
643              void          Resize(int iNewSize);              void          Resize(int iNewSize);
644              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);
645              unsigned long GetPos();              unsigned long GetPos() const;
646              unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);              unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
647              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);
648              unsigned long Write(void* pBuffer, unsigned long SampleCount);              unsigned long Write(void* pBuffer, unsigned long SampleCount);
649              Group*        GetGroup() const;              Group*        GetGroup() const;
650              virtual void  UpdateChunks();              virtual void  UpdateChunks();
651                void CopyAssignMeta(const Sample* orig);
652                void CopyAssignWave(const Sample* orig);
653          protected:          protected:
654              static unsigned int  Instances;               ///< Number of instances of class Sample.              static unsigned int  Instances;               ///< Number of instances of class Sample.
655              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.
# Line 610  namespace gig { Line 698  namespace gig {
698      };      };
699    
700      // 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)
701      /** Defines <i>Region</i> information of an <i>Instrument</i>. */      /** @brief Defines Region information of an Instrument.
702         *
703         * A Region reflects a consecutive area on the keyboard. The individual
704         * regions in the gig format may not overlap with other regions (of the same
705         * instrument). Further, in the gig format a Region is merely a container
706         * for DimensionRegions (a.k.a. "Cases"). The Region itself does not provide
707         * the sample mapping or articulation informations used, even though the
708         * data structures indeed provide such informations. The latter is however
709         * just of historical nature, because the gig format was derived from the
710         * DLS format.
711         *
712         * Each Region consists of at least one or more DimensionRegions. The actual
713         * amount of DimensionRegions depends on which kind of "dimensions" are
714         * defined for this region, and on the split / zone amount for each of those
715         * dimensions.
716         */
717      class Region : public DLS::Region {      class Region : public DLS::Region {
718          public:          public:
719              unsigned int            Dimensions;               ///< Number of defined dimensions, do not alter!              unsigned int            Dimensions;               ///< Number of defined dimensions, do not alter!
# Line 622  namespace gig { Line 725  namespace gig {
725              // own methods              // own methods
726              DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);              DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);
727              DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);              DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);
728                int              GetDimensionRegionIndexByValue(const uint DimValues[8]);
729              Sample*          GetSample();              Sample*          GetSample();
730              void             AddDimension(dimension_def_t* pDimDef);              void             AddDimension(dimension_def_t* pDimDef);
731              void             DeleteDimension(dimension_def_t* pDimDef);              void             DeleteDimension(dimension_def_t* pDimDef);
732                dimension_def_t* GetDimensionDefinition(dimension_t type);
733                void             DeleteDimensionZone(dimension_t type, int zone);
734                void             SplitDimensionZone(dimension_t type, int zone);
735              // overridden methods              // overridden methods
736              virtual void     SetKeyRange(uint16_t Low, uint16_t High);              virtual void     SetKeyRange(uint16_t Low, uint16_t High);
737              virtual void     UpdateChunks();              virtual void     UpdateChunks();
738                virtual void     CopyAssign(const Region* orig);
739          protected:          protected:
740              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
741              void LoadDimensionRegions(RIFF::List* rgn);              void LoadDimensionRegions(RIFF::List* rgn);
742              void UpdateVelocityTable();              void UpdateVelocityTable();
743              Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);              Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
744                void CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples);
745                DimensionRegion* GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase);
746             ~Region();             ~Region();
747              friend class Instrument;              friend class Instrument;
748      };      };
# Line 641  namespace gig { Line 751  namespace gig {
751      class MidiRule {      class MidiRule {
752          public:          public:
753              virtual ~MidiRule() { }              virtual ~MidiRule() { }
754            protected:
755                virtual void UpdateChunks(uint8_t* pData) const = 0;
756                friend class Instrument;
757      };      };
758    
759      /** MIDI rule for triggering notes by control change events. */      /** MIDI rule for triggering notes by control change events. */
# Line 660  namespace gig { Line 773  namespace gig {
773    
774          protected:          protected:
775              MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg);              MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg);
776                MidiRuleCtrlTrigger();
777                void UpdateChunks(uint8_t* pData) const;
778                friend class Instrument;
779        };
780    
781        /** MIDI rule for instruments with legato samples. */
782        class MidiRuleLegato : public MidiRule {
783            public:
784                uint8_t LegatoSamples;     ///< Number of legato samples per key in each direction (always 12)
785                bool BypassUseController;  ///< If a controller should be used to bypass the sustain note
786                uint8_t BypassKey;         ///< Key to be used to bypass the sustain note
787                uint8_t BypassController;  ///< Controller to be used to bypass the sustain note
788                uint16_t ThresholdTime;    ///< Maximum time (ms) between two notes that should be played legato
789                uint16_t ReleaseTime;      ///< Release time
790                range_t KeyRange;          ///< Key range for legato notes
791                uint8_t ReleaseTriggerKey; ///< Key triggering release samples
792                uint8_t AltSustain1Key;    ///< Key triggering alternate sustain samples
793                uint8_t AltSustain2Key;    ///< Key triggering a second set of alternate sustain samples
794    
795            protected:
796                MidiRuleLegato(RIFF::Chunk* _3ewg);
797                MidiRuleLegato();
798                void UpdateChunks(uint8_t* pData) const;
799                friend class Instrument;
800        };
801    
802        /** MIDI rule to automatically cycle through specified sequences of different articulations. The instrument must be using the smartmidi dimension. */
803        class MidiRuleAlternator : public MidiRule {
804            public:
805                uint8_t Articulations;     ///< Number of articulations in the instrument
806                String pArticulations[32]; ///< Names of the articulations
807    
808                range_t PlayRange;         ///< Key range of the playable keys in the instrument
809    
810                uint8_t Patterns;          ///< Number of alternator patterns
811                struct pattern_t {
812                    String Name;           ///< Name of the pattern
813                    int Size;              ///< Number of steps in the pattern
814                    const uint8_t& operator[](int i) const { /// Articulation to play
815                        return data[i];
816                    }
817                    uint8_t& operator[](int i) {
818                        return data[i];
819                    }
820                private:
821                    uint8_t data[32];
822                } pPatterns[32];           ///< A pattern is a sequence of articulation numbers
823    
824                typedef enum {
825                    selector_none,
826                    selector_key_switch,
827                    selector_controller
828                } selector_t;
829                selector_t Selector;       ///< Method by which pattern is chosen
830                range_t KeySwitchRange;    ///< Key range for key switch selector
831                uint8_t Controller;        ///< CC number for controller selector
832    
833                bool Polyphonic;           ///< If alternator should step forward only when all notes are off
834                bool Chained;              ///< If all patterns should be chained together
835    
836            protected:
837                MidiRuleAlternator(RIFF::Chunk* _3ewg);
838                MidiRuleAlternator();
839                void UpdateChunks(uint8_t* pData) const;
840                friend class Instrument;
841        };
842    
843        /** A MIDI rule not yet implemented by libgig. */
844        class MidiRuleUnknown : public MidiRule {
845            protected:
846                MidiRuleUnknown() { }
847                void UpdateChunks(uint8_t* pData) const { }
848                friend class Instrument;
849        };
850    
851        /** @brief Real-time instrument script (gig format extension).
852         *
853         * Real-time instrument scripts are user supplied small programs which can
854         * be used by instrument designers to create custom behaviors and features
855         * not available in the stock sampler engine. Features which might be very
856         * exotic or specific for the respective instrument.
857         *
858         * This is an extension of the GigaStudio format, thus a feature which was
859         * not available in the GigaStudio 4 software. It is currently only
860         * supported by LinuxSampler and gigedit.
861         */
862        class Script {
863            public:
864                enum Encoding_t {
865                    ENCODING_ASCII = 0 ///< Standard 8 bit US ASCII character encoding (default).
866                };
867                enum Compression_t {
868                    COMPRESSION_NONE = 0 ///< Is not compressed at all (default).
869                };
870                enum Language_t {
871                    LANGUAGE_NKSP = 0 ///< NKSP stands for "Is Not KSP" (default).
872                };
873    
874                String         Name;        ///< Arbitrary name of the script, which may be displayed i.e. in an instrument editor.
875                Compression_t  Compression; ///< Whether the script was/should be compressed, and if so, which compression algorithm shall be used.
876                Encoding_t     Encoding;    ///< Format the script's source code text is encoded with.
877                Language_t     Language;    ///< Programming language and dialect the script is written in.
878                bool           Bypass;      ///< Global bypass: if enabled, this script shall not be executed by the sampler for any instrument.
879    
880                String GetScriptAsText();
881                void   SetScriptAsText(const String& text);
882                void   SetGroup(ScriptGroup* pGroup);
883                ScriptGroup* GetGroup() const;
884            protected:
885                Script(ScriptGroup* group, RIFF::Chunk* ckScri);
886                virtual ~Script();
887                void UpdateChunks();
888                void RemoveAllScriptReferences();
889                friend class ScriptGroup;
890              friend class Instrument;              friend class Instrument;
891            private:
892                ScriptGroup*          pGroup;
893                RIFF::Chunk*          pChunk; ///< 'Scri' chunk
894                std::vector<uint8_t>  data;
895                uint32_t              crc; ///< CRC-32 checksum of the raw script data
896        };
897    
898        /** @brief Group of instrument scripts (gig format extension).
899         *
900         * This class is simply used to sort a bunch of real-time instrument scripts
901         * into individual groups. This allows instrument designers and script
902         * developers to keep scripts in a certain order while working with a larger
903         * amount of scripts in an instrument editor.
904         *
905         * This is an extension of the GigaStudio format, thus a feature which was
906         * not available in the GigaStudio 4 software. It is currently only
907         * supported by LinuxSampler and gigedit.
908         */
909        class ScriptGroup {
910            public:
911                String   Name; ///< Name of this script group. For example to be displayed in an instrument editor.
912    
913                Script*  GetScript(uint index);
914                Script*  AddScript();
915                void     DeleteScript(Script* pScript);
916            protected:
917                ScriptGroup(File* file, RIFF::List* lstRTIS);
918                virtual ~ScriptGroup();
919                void LoadScripts();
920                void UpdateChunks();
921                friend class Script;
922                friend class File;
923            private:
924                File*                pFile;
925                RIFF::List*          pList; ///< 'RTIS' list chunk
926                std::list<Script*>*  pScripts;
927      };      };
928    
929      /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */      /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */
# Line 693  namespace gig { Line 956  namespace gig {
956              Region*   AddRegion();              Region*   AddRegion();
957              void      DeleteRegion(Region* pRegion);              void      DeleteRegion(Region* pRegion);
958              virtual void UpdateChunks();              virtual void UpdateChunks();
959                virtual void CopyAssign(const Instrument* orig);
960              // own methods              // own methods
961              Region*   GetRegion(unsigned int Key);              Region*   GetRegion(unsigned int Key);
962              MidiRule* GetMidiRule(int i);              MidiRule* GetMidiRule(int i);
963                MidiRuleCtrlTrigger* AddMidiRuleCtrlTrigger();
964                MidiRuleLegato*      AddMidiRuleLegato();
965                MidiRuleAlternator*  AddMidiRuleAlternator();
966                void      DeleteMidiRule(int i);
967                // real-time instrument script methods
968                Script*   GetScriptOfSlot(uint index);
969                void      AddScriptSlot(Script* pScript, bool bypass = false);
970                void      SwapScriptSlots(uint index1, uint index2);
971                void      RemoveScriptSlot(uint index);
972                void      RemoveScript(Script* pScript);
973                uint      ScriptSlotCount() const;
974                bool      IsScriptSlotBypassed(uint index);
975                void      SetScriptSlotBypassed(uint index, bool bBypass);
976          protected:          protected:
977              Region*   RegionKeyTable[128]; ///< fast lookup for the corresponding Region of a MIDI key              Region*   RegionKeyTable[128]; ///< fast lookup for the corresponding Region of a MIDI key
978    
979              Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);              Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);
980             ~Instrument();             ~Instrument();
981                void CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples);
982              void UpdateRegionKeyTable();              void UpdateRegionKeyTable();
983                void LoadScripts();
984                void UpdateScriptFileOffsets();
985              friend class File;              friend class File;
986              friend class Region; // so Region can call UpdateRegionKeyTable()              friend class Region; // so Region can call UpdateRegionKeyTable()
987          private:          private:
988                struct _ScriptPooolEntry {
989                    uint32_t fileOffset;
990                    bool     bypass;
991                };
992                struct _ScriptPooolRef {
993                    Script*  script;
994                    bool     bypass;
995                };
996              MidiRule** pMidiRules;              MidiRule** pMidiRules;
997                std::vector<_ScriptPooolEntry> scriptPoolFileOffsets;
998                std::vector<_ScriptPooolRef>* pScriptRefs;
999      };      };
1000    
1001      /** @brief Group of Gigasampler objects      /** @brief Group of Gigasampler objects
# Line 738  namespace gig { Line 1028  namespace gig {
1028              friend class File;              friend class File;
1029          private:          private:
1030              File*        pFile;              File*        pFile;
1031              RIFF::Chunk* pNameChunk;              RIFF::Chunk* pNameChunk; ///< '3gnm' chunk
1032      };      };
1033    
1034      /** Parses Gigasampler files and provides abstract access to the data. */      /** Parses Gigasampler files and provides abstract access to the data. */
# Line 759  namespace gig { Line 1049  namespace gig {
1049              // derived methods from DLS::File              // derived methods from DLS::File
1050              using DLS::File::Save;              using DLS::File::Save;
1051              using DLS::File::GetFileName;              using DLS::File::GetFileName;
1052                using DLS::File::SetFileName;
1053              // overridden  methods              // overridden  methods
1054              File();              File();
1055              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
1056              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.
1057              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.
1058                Sample*     GetSample(uint index);
1059              Sample*     AddSample();              Sample*     AddSample();
1060              void        DeleteSample(Sample* pSample);              void        DeleteSample(Sample* pSample);
1061              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.
1062              Instrument* GetNextInstrument();  ///< Returns a pointer to the next <i>Instrument</i> object of the file, <i>NULL</i> otherwise.              Instrument* GetNextInstrument();  ///< Returns a pointer to the next <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
1063              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
1064              Instrument* AddInstrument();              Instrument* AddInstrument();
1065                Instrument* AddDuplicateInstrument(const Instrument* orig);
1066              void        DeleteInstrument(Instrument* pInstrument);              void        DeleteInstrument(Instrument* pInstrument);
1067              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.
1068              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.
1069              Group*      GetGroup(uint index);              Group*      GetGroup(uint index);
1070                Group*      GetGroup(String name);
1071              Group*      AddGroup();              Group*      AddGroup();
1072              void        DeleteGroup(Group* pGroup);              void        DeleteGroup(Group* pGroup);
1073              void        DeleteGroupOnly(Group* pGroup);              void        DeleteGroupOnly(Group* pGroup);
1074              void        SetAutoLoad(bool b);              void        SetAutoLoad(bool b);
1075              bool        GetAutoLoad();              bool        GetAutoLoad();
1076                void        AddContentOf(File* pFile);
1077                ScriptGroup* GetScriptGroup(uint index);
1078                ScriptGroup* GetScriptGroup(const String& name);
1079                ScriptGroup* AddScriptGroup();
1080                void        DeleteScriptGroup(ScriptGroup* pGroup);
1081              virtual    ~File();              virtual    ~File();
1082              virtual void UpdateChunks();              virtual void UpdateChunks();
1083          protected:          protected:
# Line 786  namespace gig { Line 1085  namespace gig {
1085              virtual void LoadSamples();              virtual void LoadSamples();
1086              virtual void LoadInstruments();              virtual void LoadInstruments();
1087              virtual void LoadGroups();              virtual void LoadGroups();
1088                virtual void UpdateFileOffsets();
1089              // own protected methods              // own protected methods
1090              virtual void LoadSamples(progress_t* pProgress);              virtual void LoadSamples(progress_t* pProgress);
1091              virtual void LoadInstruments(progress_t* pProgress);              virtual void LoadInstruments(progress_t* pProgress);
1092                virtual void LoadScriptGroups();
1093              void SetSampleChecksum(Sample* pSample, uint32_t crc);              void SetSampleChecksum(Sample* pSample, uint32_t crc);
1094              friend class Region;              friend class Region;
1095              friend class Sample;              friend class Sample;
1096              friend class Group; // so Group can access protected member pRIFF              friend class Group; // so Group can access protected member pRIFF
1097                friend class ScriptGroup; // so ScriptGroup can access protected member pRIFF
1098          private:          private:
1099              std::list<Group*>*          pGroups;              std::list<Group*>*          pGroups;
1100              std::list<Group*>::iterator GroupsIterator;              std::list<Group*>::iterator GroupsIterator;
1101              bool                        bAutoLoad;              bool                        bAutoLoad;
1102                std::list<ScriptGroup*>*    pScriptGroups;
1103      };      };
1104    
1105      /**      /**
Legend:
Removed from v.2334  
changed lines
  Added in v.2609
  ViewVC Help
Powered by ViewVC