/[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 1416 by schoenebeck, Sun Oct 14 12:06:32 2007 UTC revision 2584 by schoenebeck, Sat May 31 20:54:39 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-2007 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 CHUNK_ID_SMPL  0x736D706C  # 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 40  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 CHUNK_ID_SMPL  0x6C706D73  # 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 54  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 329  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 344  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 428  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              DLS::Sampler::UnityNote;              using DLS::Sampler::UnityNote;
446              DLS::Sampler::FineTune;              using DLS::Sampler::FineTune;
447              DLS::Sampler::Gain;              using DLS::Sampler::Gain;
448              DLS::Sampler::SampleLoops;              using DLS::Sampler::SampleLoops;
449              DLS::Sampler::pSampleLoops;              using DLS::Sampler::pSampleLoops;
450    
451              // own methods              // own methods
452              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
# Line 452  namespace gig { Line 463  namespace gig {
463              void SetVCFVelocityScale(uint8_t scaling);              void SetVCFVelocityScale(uint8_t scaling);
464              Region* GetParent() const;              Region* GetParent() const;
465              // derived methods              // derived methods
466              DLS::Sampler::AddSampleLoop;              using DLS::Sampler::AddSampleLoop;
467              DLS::Sampler::DeleteSampleLoop;              using DLS::Sampler::DeleteSampleLoop;
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 490  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 558  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 612  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 627  namespace gig { Line 728  namespace gig {
728              Sample*          GetSample();              Sample*          GetSample();
729              void             AddDimension(dimension_def_t* pDimDef);              void             AddDimension(dimension_def_t* pDimDef);
730              void             DeleteDimension(dimension_def_t* pDimDef);              void             DeleteDimension(dimension_def_t* pDimDef);
731                dimension_def_t* GetDimensionDefinition(dimension_t type);
732                void             DeleteDimensionZone(dimension_t type, int zone);
733                void             SplitDimensionZone(dimension_t type, int zone);
734              // overridden methods              // overridden methods
735              virtual void     SetKeyRange(uint16_t Low, uint16_t High);              virtual void     SetKeyRange(uint16_t Low, uint16_t High);
736              virtual void     UpdateChunks();              virtual void     UpdateChunks();
737                virtual void     CopyAssign(const Region* orig);
738          protected:          protected:
739              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
740              void LoadDimensionRegions(RIFF::List* rgn);              void LoadDimensionRegions(RIFF::List* rgn);
741              void UpdateVelocityTable();              void UpdateVelocityTable();
742              Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);              Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
743                void CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples);
744                DimensionRegion* GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase);
745             ~Region();             ~Region();
746              friend class Instrument;              friend class Instrument;
747      };      };
748    
749        /** Abstract base class for all MIDI rules. */
750        class MidiRule {
751            public:
752                virtual ~MidiRule() { }
753            protected:
754                virtual void UpdateChunks(uint8_t* pData) const = 0;
755                friend class Instrument;
756        };
757    
758        /** MIDI rule for triggering notes by control change events. */
759        class MidiRuleCtrlTrigger : public MidiRule {
760            public:
761                uint8_t ControllerNumber;   ///< MIDI controller number.
762                uint8_t Triggers;           ///< Number of triggers.
763                struct trigger_t {
764                    uint8_t TriggerPoint;   ///< The CC value to pass for the note to be triggered.
765                    bool    Descending;     ///< If the change in CC value should be downwards.
766                    uint8_t VelSensitivity; ///< How sensitive the velocity should be to the speed of the controller change.
767                    uint8_t Key;            ///< Key to trigger.
768                    bool    NoteOff;        ///< If a note off should be triggered instead of a note on.
769                    uint8_t Velocity;       ///< Velocity of the note to trigger. 255 means that velocity should depend on the speed of the controller change.
770                    bool    OverridePedal;  ///< If a note off should be triggered even if the sustain pedal is down.
771                } pTriggers[32];
772    
773            protected:
774                MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg);
775                MidiRuleCtrlTrigger();
776                void UpdateChunks(uint8_t* pData) const;
777                friend class Instrument;
778        };
779    
780        /** MIDI rule for instruments with legato samples. */
781        class MidiRuleLegato : public MidiRule {
782            public:
783                uint8_t LegatoSamples;     ///< Number of legato samples per key in each direction (always 12)
784                bool BypassUseController;  ///< If a controller should be used to bypass the sustain note
785                uint8_t BypassKey;         ///< Key to be used to bypass the sustain note
786                uint8_t BypassController;  ///< Controller to be used to bypass the sustain note
787                uint16_t ThresholdTime;    ///< Maximum time (ms) between two notes that should be played legato
788                uint16_t ReleaseTime;      ///< Release time
789                range_t KeyRange;          ///< Key range for legato notes
790                uint8_t ReleaseTriggerKey; ///< Key triggering release samples
791                uint8_t AltSustain1Key;    ///< Key triggering alternate sustain samples
792                uint8_t AltSustain2Key;    ///< Key triggering a second set of alternate sustain samples
793    
794            protected:
795                MidiRuleLegato(RIFF::Chunk* _3ewg);
796                MidiRuleLegato();
797                void UpdateChunks(uint8_t* pData) const;
798                friend class Instrument;
799        };
800    
801        /** MIDI rule to automatically cycle through specified sequences of different articulations. The instrument must be using the smartmidi dimension. */
802        class MidiRuleAlternator : public MidiRule {
803            public:
804                uint8_t Articulations;     ///< Number of articulations in the instrument
805                String pArticulations[32]; ///< Names of the articulations
806    
807                range_t PlayRange;         ///< Key range of the playable keys in the instrument
808    
809                uint8_t Patterns;          ///< Number of alternator patterns
810                struct pattern_t {
811                    String Name;           ///< Name of the pattern
812                    int Size;              ///< Number of steps in the pattern
813                    const uint8_t& operator[](int i) const { /// Articulation to play
814                        return data[i];
815                    }
816                    uint8_t& operator[](int i) {
817                        return data[i];
818                    }
819                private:
820                    uint8_t data[32];
821                } pPatterns[32];           ///< A pattern is a sequence of articulation numbers
822    
823                typedef enum {
824                    selector_none,
825                    selector_key_switch,
826                    selector_controller
827                } selector_t;
828                selector_t Selector;       ///< Method by which pattern is chosen
829                range_t KeySwitchRange;    ///< Key range for key switch selector
830                uint8_t Controller;        ///< CC number for controller selector
831    
832                bool Polyphonic;           ///< If alternator should step forward only when all notes are off
833                bool Chained;              ///< If all patterns should be chained together
834    
835            protected:
836                MidiRuleAlternator(RIFF::Chunk* _3ewg);
837                MidiRuleAlternator();
838                void UpdateChunks(uint8_t* pData) const;
839                friend class Instrument;
840        };
841    
842        /** A MIDI rule not yet implemented by libgig. */
843        class MidiRuleUnknown : public MidiRule {
844            protected:
845                MidiRuleUnknown() { }
846                void UpdateChunks(uint8_t* pData) const { }
847                friend class Instrument;
848        };
849    
850        /** @brief Real-time instrument script (gig format extension).
851         *
852         * Real-time instrument scripts are user supplied small programs which can
853         * be used by instrument designers to create custom behaviors and features
854         * not available in the stock sampler engine. Features which might be very
855         * exotic or specific for the respective instrument.
856         *
857         * This is an extension of the GigaStudio format, thus a feature which was
858         * not available in the GigaStudio 4 software. It is currently only
859         * supported by LinuxSampler and gigedit.
860         */
861        class Script {
862            public:
863                enum Encoding_t {
864                    ENCODING_ASCII = 0 ///< Standard 8 bit US ASCII character encoding (default).
865                };
866                enum Compression_t {
867                    COMPRESSION_NONE = 0 ///< Is not compressed at all (default).
868                };
869                enum Language_t {
870                    LANGUAGE_NKSP = 0 ///< NKSP stands for "Is Not KSP" (default).
871                };
872    
873                String         Name;        ///< Arbitrary name of the script, which may be displayed i.e. in an instrument editor.
874                Compression_t  Compression; ///< Whether the script was/should be compressed, and if so, which compression algorithm shall be used.
875                Encoding_t     Encoding;    ///< Format the script's source code text is encoded with.
876                Language_t     Language;    ///< Programming language and dialect the script is written in.
877                bool           Bypass;      ///< Global bypass: if enabled, this script shall not be executed by the sampler for any instrument.
878    
879                String GetScriptAsText();
880                void   SetScriptAsText(const String& text);
881                void   SetGroup(ScriptGroup* pGroup);
882            protected:
883                Script(ScriptGroup* group, RIFF::Chunk* ckScri);
884                virtual ~Script();
885                void UpdateChunks();
886                void RemoveAllScriptReferences();
887                friend class ScriptGroup;
888                friend class Instrument;
889            private:
890                ScriptGroup*          pGroup;
891                RIFF::Chunk*          pChunk; ///< 'Scri' chunk
892                std::vector<uint8_t>  data;
893                uint32_t              crc; ///< CRC-32 checksum of the raw script data
894        };
895    
896        /** @brief Group of instrument scripts (gig format extension).
897         *
898         * This class is simply used to sort a bunch of real-time instrument scripts
899         * into individual groups. This allows instrument designers and script
900         * developers to keep scripts in a certain order while working with a larger
901         * amount of scripts in an instrument editor.
902         *
903         * This is an extension of the GigaStudio format, thus a feature which was
904         * not available in the GigaStudio 4 software. It is currently only
905         * supported by LinuxSampler and gigedit.
906         */
907        class ScriptGroup {
908            public:
909                String   Name; ///< Name of this script group. For example to be displayed in an instrument editor.
910    
911                Script*  GetScript(uint index);
912                Script*  AddScript();
913                void     DeleteScript(Script* pScript);
914            protected:
915                ScriptGroup(File* file, RIFF::List* lstRTIS);
916                virtual ~ScriptGroup();
917                void LoadScripts();
918                void UpdateChunks();
919                friend class Script;
920                friend class File;
921            private:
922                File*                pFile;
923                RIFF::List*          pList; ///< 'RTIS' list chunk
924                std::list<Script*>*  pScripts;
925        };
926    
927      /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */      /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */
928      class Instrument : protected DLS::Instrument {      class Instrument : protected DLS::Instrument {
929          public:          public:
930              // derived attributes from DLS::Resource              // derived attributes from DLS::Resource
931              DLS::Resource::pInfo;              using DLS::Resource::pInfo;
932              DLS::Resource::pDLSID;              using DLS::Resource::pDLSID;
933              // derived attributes from DLS::Instrument              // derived attributes from DLS::Instrument
934              DLS::Instrument::IsDrum;              using DLS::Instrument::IsDrum;
935              DLS::Instrument::MIDIBank;              using DLS::Instrument::MIDIBank;
936              DLS::Instrument::MIDIBankCoarse;              using DLS::Instrument::MIDIBankCoarse;
937              DLS::Instrument::MIDIBankFine;              using DLS::Instrument::MIDIBankFine;
938              DLS::Instrument::MIDIProgram;              using DLS::Instrument::MIDIProgram;
939              DLS::Instrument::Regions;              using DLS::Instrument::Regions;
940              // own attributes              // own attributes
941              int32_t   Attenuation;       ///< in dB              int32_t   Attenuation;       ///< in dB
942              uint16_t  EffectSend;              uint16_t  EffectSend;
# Line 662  namespace gig { Line 947  namespace gig {
947    
948    
949              // derived methods from DLS::Resource              // derived methods from DLS::Resource
950              DLS::Resource::GetParent;              using DLS::Resource::GetParent;
951              // overridden methods              // overridden methods
952              Region*   GetFirstRegion();              Region*   GetFirstRegion();
953              Region*   GetNextRegion();              Region*   GetNextRegion();
954              Region*   AddRegion();              Region*   AddRegion();
955              void      DeleteRegion(Region* pRegion);              void      DeleteRegion(Region* pRegion);
956              virtual void UpdateChunks();              virtual void UpdateChunks();
957                virtual void CopyAssign(const Instrument* orig);
958              // own methods              // own methods
959              Region*   GetRegion(unsigned int Key);              Region*   GetRegion(unsigned int Key);
960                MidiRule* GetMidiRule(int i);
961                MidiRuleCtrlTrigger* AddMidiRuleCtrlTrigger();
962                MidiRuleLegato*      AddMidiRuleLegato();
963                MidiRuleAlternator*  AddMidiRuleAlternator();
964                void      DeleteMidiRule(int i);
965                // real-time instrument script methods
966                Script*   GetScriptOfSlot(uint index);
967                void      AddScriptSlot(Script* pScript, bool bypass = false);
968                void      SwapScriptSlots(uint index1, uint index2);
969                void      RemoveScriptSlot(uint index);
970                void      RemoveScript(Script* pScript);
971                uint      ScriptSlotCount() const;
972                bool      IsScriptSlotBypassed(uint index);
973                void      SetScriptSlotBypassed(uint index, bool bBypass);
974          protected:          protected:
975              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
976    
977              Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);              Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);
978             ~Instrument();             ~Instrument();
979                void CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples);
980              void UpdateRegionKeyTable();              void UpdateRegionKeyTable();
981                void LoadScripts();
982              friend class File;              friend class File;
983              friend class Region; // so Region can call UpdateRegionKeyTable()              friend class Region; // so Region can call UpdateRegionKeyTable()
984            private:
985                struct _ScriptPooolEntry {
986                    uint32_t fileOffset;
987                    bool     bypass;
988                };
989                struct _ScriptPooolRef {
990                    Script*  script;
991                    bool     bypass;
992                };
993                MidiRule** pMidiRules;
994                std::vector<_ScriptPooolEntry> scriptPoolFileOffsets;
995                std::vector<_ScriptPooolRef>* pScriptRefs;
996      };      };
997    
998      /** @brief Group of Gigasampler objects      /** @brief Group of Gigasampler objects
# Line 711  namespace gig { Line 1025  namespace gig {
1025              friend class File;              friend class File;
1026          private:          private:
1027              File*        pFile;              File*        pFile;
1028              RIFF::Chunk* pNameChunk;              RIFF::Chunk* pNameChunk; ///< '3gnm' chunk
1029      };      };
1030    
1031      /** Parses Gigasampler files and provides abstract access to the data. */      /** Parses Gigasampler files and provides abstract access to the data. */
# Line 721  namespace gig { Line 1035  namespace gig {
1035              static const DLS::version_t VERSION_3;              static const DLS::version_t VERSION_3;
1036    
1037              // derived attributes from DLS::Resource              // derived attributes from DLS::Resource
1038              DLS::Resource::pInfo;              using DLS::Resource::pInfo;
1039              DLS::Resource::pDLSID;              using DLS::Resource::pDLSID;
1040              // derived attributes from DLS::File              // derived attributes from DLS::File
1041              DLS::File::pVersion;              using DLS::File::pVersion;
1042              DLS::File::Instruments;              using DLS::File::Instruments;
1043    
1044              // derived methods from DLS::Resource              // derived methods from DLS::Resource
1045              DLS::Resource::GetParent;              using DLS::Resource::GetParent;
1046              // derived methods from DLS::File              // derived methods from DLS::File
1047              DLS::File::Save;              using DLS::File::Save;
1048                using DLS::File::GetFileName;
1049                using DLS::File::SetFileName;
1050              // overridden  methods              // overridden  methods
1051              File();              File();
1052              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
1053              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.
1054              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.
1055                Sample*     GetSample(uint index);
1056              Sample*     AddSample();              Sample*     AddSample();
1057              void        DeleteSample(Sample* pSample);              void        DeleteSample(Sample* pSample);
1058              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.
1059              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.
1060              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
1061              Instrument* AddInstrument();              Instrument* AddInstrument();
1062                Instrument* AddDuplicateInstrument(const Instrument* orig);
1063              void        DeleteInstrument(Instrument* pInstrument);              void        DeleteInstrument(Instrument* pInstrument);
1064              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.
1065              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.
1066              Group*      GetGroup(uint index);              Group*      GetGroup(uint index);
1067                Group*      GetGroup(String name);
1068              Group*      AddGroup();              Group*      AddGroup();
1069              void        DeleteGroup(Group* pGroup);              void        DeleteGroup(Group* pGroup);
1070              void        DeleteGroupOnly(Group* pGroup);              void        DeleteGroupOnly(Group* pGroup);
1071                void        SetAutoLoad(bool b);
1072                bool        GetAutoLoad();
1073                void        AddContentOf(File* pFile);
1074                ScriptGroup* GetScriptGroup(uint index);
1075                ScriptGroup* GetScriptGroup(const String& name);
1076                ScriptGroup* AddScriptGroup();
1077                void        DeleteScriptGroup(ScriptGroup* pGroup);
1078              virtual    ~File();              virtual    ~File();
1079              virtual void UpdateChunks();              virtual void UpdateChunks();
1080          protected:          protected:
# Line 759  namespace gig { Line 1085  namespace gig {
1085              // own protected methods              // own protected methods
1086              virtual void LoadSamples(progress_t* pProgress);              virtual void LoadSamples(progress_t* pProgress);
1087              virtual void LoadInstruments(progress_t* pProgress);              virtual void LoadInstruments(progress_t* pProgress);
1088                virtual void LoadScriptGroups();
1089              void SetSampleChecksum(Sample* pSample, uint32_t crc);              void SetSampleChecksum(Sample* pSample, uint32_t crc);
1090              friend class Region;              friend class Region;
1091              friend class Sample;              friend class Sample;
1092              friend class Group; // so Group can access protected member pRIFF              friend class Group; // so Group can access protected member pRIFF
1093                friend class ScriptGroup; // so ScriptGroup can access protected member pRIFF
1094          private:          private:
1095              std::list<Group*>*          pGroups;              std::list<Group*>*          pGroups;
1096              std::list<Group*>::iterator GroupsIterator;              std::list<Group*>::iterator GroupsIterator;
1097                bool                        bAutoLoad;
1098                std::list<ScriptGroup*>*    pScriptGroups;
1099      };      };
1100    
1101      /**      /**
Legend:
Removed from v.1416  
changed lines
  Added in v.2584
  ViewVC Help
Powered by ViewVC