/[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 2482 by schoenebeck, Mon Nov 25 02:22:38 2013 UTC revision 2682 by schoenebeck, Mon Dec 29 16:25:51 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-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  *
# 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 */
69  namespace gig {  namespace gig {
70    
71      typedef std::string String;      typedef std::string String;
72        typedef RIFF::progress_t progress_t;
73    
74      /** Lower and upper limit of a range. */      /** Lower and upper limit of a range. */
75      struct range_t {      struct range_t {
# Line 300  namespace gig { Line 312  namespace gig {
312          unsigned long loop_cycles_left;  ///< How many times the loop has still to be passed, this value will be decremented with each loop cycle.          unsigned long loop_cycles_left;  ///< How many times the loop has still to be passed, this value will be decremented with each loop cycle.
313      };      };
314    
     /**  
      * @brief Used for indicating the progress of a certain task.  
      *  
      * The function pointer argument has to be supplied with a valid  
      * function of the given signature which will then be called on  
      * progress changes. An equivalent progress_t structure will be passed  
      * back as argument to the callback function on each progress change.  
      * The factor field of the supplied progress_t structure will then  
      * reflect the current progress as value between 0.0 and 1.0. You might  
      * want to use the custom field for data needed in your callback  
      * function.  
      */  
     struct progress_t {  
         void (*callback)(progress_t*); ///< Callback function pointer which has to be assigned to a function for progress notification.  
         float factor;                  ///< Reflects current progress as value between 0.0 and 1.0.  
         void* custom;                  ///< This pointer can be used for arbitrary data.  
         float __range_min;             ///< Only for internal usage, do not modify!  
         float __range_max;             ///< Only for internal usage, do not modify!  
         progress_t();  
     };  
   
315      // just symbol prototyping      // just symbol prototyping
316      class File;      class File;
317      class Instrument;      class Instrument;
318      class Sample;      class Sample;
319      class Region;      class Region;
320      class Group;      class Group;
321        class Script;
322        class ScriptGroup;
323    
324      /** @brief Encapsulates articulation information of a dimension region.      /** @brief Encapsulates articulation information of a dimension region.
325       *       *
# Line 342  namespace gig { Line 335  namespace gig {
335       */       */
336      class DimensionRegion : protected DLS::Sampler {      class DimensionRegion : protected DLS::Sampler {
337          public:          public:
338              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.
339              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.
340              // Sample Amplitude EG/LFO              // Sample Amplitude EG/LFO
341              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 419  namespace gig {
419              bool               MSDecode;                      ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.              bool               MSDecode;                      ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.
420              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).
421              double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)              double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)
422              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).
423    
424              // derived attributes from DLS::Sampler              // derived attributes from DLS::Sampler
425              using DLS::Sampler::UnityNote;              using DLS::Sampler::UnityNote;
# Line 454  namespace gig { Line 447  namespace gig {
447              using DLS::Sampler::DeleteSampleLoop;              using DLS::Sampler::DeleteSampleLoop;
448              // overridden methods              // overridden methods
449              virtual void SetGain(int32_t gain);              virtual void SetGain(int32_t gain);
450              virtual void UpdateChunks();              virtual void UpdateChunks(progress_t* pProgress);
451              virtual void CopyAssign(const DimensionRegion* orig);              virtual void CopyAssign(const DimensionRegion* orig);
452          protected:          protected:
453              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.
# Line 465  namespace gig { Line 458  namespace gig {
458              friend class Region;              friend class Region;
459          private:          private:
460              typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller              typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller
461                    // official leverage controllers as they were defined in the original Gigasampler/GigaStudio format:
462                  _lev_ctrl_none              = 0x00,                  _lev_ctrl_none              = 0x00,
463                  _lev_ctrl_modwheel          = 0x03, ///< Modulation Wheel (MIDI Controller 1)                  _lev_ctrl_modwheel          = 0x03, ///< Modulation Wheel (MIDI Controller 1)
464                  _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 484  namespace gig {
484                  _lev_ctrl_effect4depth      = 0x2b, ///< Effect 4 Depth (MIDI Controller 94)                  _lev_ctrl_effect4depth      = 0x2b, ///< Effect 4 Depth (MIDI Controller 94)
485                  _lev_ctrl_effect5depth      = 0x2d, ///< Effect 5 Depth (MIDI Controller 95)                  _lev_ctrl_effect5depth      = 0x2d, ///< Effect 5 Depth (MIDI Controller 95)
486                  _lev_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure                  _lev_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure
487                  _lev_ctrl_velocity          = 0xff  ///< Key Velocity                  _lev_ctrl_velocity          = 0xff, ///< Key Velocity
488    
489                    // format extension (these controllers are so far only supported by LinuxSampler & gigedit) they will *NOT* work with Gigasampler/GigaStudio !
490                    // (the assigned values here are their official MIDI CC number plus the highest bit set):
491                    _lev_ctrl_CC3_EXT           = 0x83, ///< MIDI Controller 3 [gig format extension]
492    
493                    _lev_ctrl_CC6_EXT           = 0x86, ///< Data Entry MSB (MIDI Controller 6) [gig format extension]
494                    _lev_ctrl_CC7_EXT           = 0x87, ///< Channel Volume (MIDI Controller 7) [gig format extension]
495                    _lev_ctrl_CC8_EXT           = 0x88, ///< Balance (MIDI Controller 8) [gig format extension]
496                    _lev_ctrl_CC9_EXT           = 0x89, ///< MIDI Controller 9 [gig format extension]
497                    _lev_ctrl_CC10_EXT          = 0x8a, ///< Pan (MIDI Controller 10) [gig format extension]
498                    _lev_ctrl_CC11_EXT          = 0x8b, ///< Expression Controller (MIDI Controller 11) [gig format extension]
499    
500                    _lev_ctrl_CC14_EXT          = 0x8e, ///< MIDI Controller 14 [gig format extension]
501                    _lev_ctrl_CC15_EXT          = 0x8f, ///< MIDI Controller 15 [gig format extension]
502    
503                    _lev_ctrl_CC20_EXT          = 0x94, ///< MIDI Controller 20 [gig format extension]
504                    _lev_ctrl_CC21_EXT          = 0x95, ///< MIDI Controller 21 [gig format extension]
505                    _lev_ctrl_CC22_EXT          = 0x96, ///< MIDI Controller 22 [gig format extension]
506                    _lev_ctrl_CC23_EXT          = 0x97, ///< MIDI Controller 23 [gig format extension]
507                    _lev_ctrl_CC24_EXT          = 0x98, ///< MIDI Controller 24 [gig format extension]
508                    _lev_ctrl_CC25_EXT          = 0x99, ///< MIDI Controller 25 [gig format extension]
509                    _lev_ctrl_CC26_EXT          = 0x9a, ///< MIDI Controller 26 [gig format extension]
510                    _lev_ctrl_CC27_EXT          = 0x9b, ///< MIDI Controller 27 [gig format extension]
511                    _lev_ctrl_CC28_EXT          = 0x9c, ///< MIDI Controller 28 [gig format extension]
512                    _lev_ctrl_CC29_EXT          = 0x9d, ///< MIDI Controller 29 [gig format extension]
513                    _lev_ctrl_CC30_EXT          = 0x9e, ///< MIDI Controller 30 [gig format extension]
514                    _lev_ctrl_CC31_EXT          = 0x9f, ///< MIDI Controller 31 [gig format extension]
515    
516                    _lev_ctrl_CC68_EXT          = 0xc4, ///< Legato Footswitch (MIDI Controller 68) [gig format extension]
517                    _lev_ctrl_CC69_EXT          = 0xc5, ///< Hold 2 (MIDI Controller 69) [gig format extension]
518                    _lev_ctrl_CC70_EXT          = 0xc6, ///< Sound Ctrl. 1 - Sound Variation (MIDI Controller 70) [gig format extension]
519                    _lev_ctrl_CC71_EXT          = 0xc7, ///< Sound Ctrl. 2 - Timbre (MIDI Controller 71) [gig format extension]
520                    _lev_ctrl_CC72_EXT          = 0xc8, ///< Sound Ctrl. 3 - Release Time (MIDI Controller 72) [gig format extension]
521                    _lev_ctrl_CC73_EXT          = 0xc9, ///< Sound Ctrl. 4 - Attack Time (MIDI Controller 73) [gig format extension]
522                    _lev_ctrl_CC74_EXT          = 0xca, ///< Sound Ctrl. 5 - Brightness (MIDI Controller 74) [gig format extension]
523                    _lev_ctrl_CC75_EXT          = 0xcb, ///< Sound Ctrl. 6 - Decay Time (MIDI Controller 75) [gig format extension]
524                    _lev_ctrl_CC76_EXT          = 0xcc, ///< Sound Ctrl. 7 - Vibrato Rate (MIDI Controller 76) [gig format extension]
525                    _lev_ctrl_CC77_EXT          = 0xcd, ///< Sound Ctrl. 8 - Vibrato Depth (MIDI Controller 77) [gig format extension]
526                    _lev_ctrl_CC78_EXT          = 0xce, ///< Sound Ctrl. 9 - Vibrato Delay (MIDI Controller 78) [gig format extension]
527                    _lev_ctrl_CC79_EXT          = 0xcf, ///< Sound Ctrl. 10 (MIDI Controller 79) [gig format extension]
528    
529                    _lev_ctrl_CC84_EXT          = 0xd4, ///< Portamento Control (MIDI Controller 84) [gig format extension]
530                    _lev_ctrl_CC85_EXT          = 0xd5, ///< MIDI Controller 85 [gig format extension]
531                    _lev_ctrl_CC86_EXT          = 0xd6, ///< MIDI Controller 86 [gig format extension]
532                    _lev_ctrl_CC87_EXT          = 0xd7, ///< MIDI Controller 87 [gig format extension]
533    
534                    _lev_ctrl_CC89_EXT          = 0xd9, ///< MIDI Controller 89 [gig format extension]
535                    _lev_ctrl_CC90_EXT          = 0xda, ///< MIDI Controller 90 [gig format extension]
536    
537                    _lev_ctrl_CC96_EXT          = 0xe0, ///< Data Increment (MIDI Controller 96) [gig format extension]
538                    _lev_ctrl_CC97_EXT          = 0xe1, ///< Data Decrement (MIDI Controller 97) [gig format extension]
539    
540                    _lev_ctrl_CC102_EXT         = 0xe6, ///< MIDI Controller 102 [gig format extension]
541                    _lev_ctrl_CC103_EXT         = 0xe7, ///< MIDI Controller 103 [gig format extension]
542                    _lev_ctrl_CC104_EXT         = 0xe8, ///< MIDI Controller 104 [gig format extension]
543                    _lev_ctrl_CC105_EXT         = 0xe9, ///< MIDI Controller 105 [gig format extension]
544                    _lev_ctrl_CC106_EXT         = 0xea, ///< MIDI Controller 106 [gig format extension]
545                    _lev_ctrl_CC107_EXT         = 0xeb, ///< MIDI Controller 107 [gig format extension]
546                    _lev_ctrl_CC108_EXT         = 0xec, ///< MIDI Controller 108 [gig format extension]
547                    _lev_ctrl_CC109_EXT         = 0xed, ///< MIDI Controller 109 [gig format extension]
548                    _lev_ctrl_CC110_EXT         = 0xee, ///< MIDI Controller 110 [gig format extension]
549                    _lev_ctrl_CC111_EXT         = 0xef, ///< MIDI Controller 111 [gig format extension]
550                    _lev_ctrl_CC112_EXT         = 0xf0, ///< MIDI Controller 112 [gig format extension]
551                    _lev_ctrl_CC113_EXT         = 0xf1, ///< MIDI Controller 113 [gig format extension]
552                    _lev_ctrl_CC114_EXT         = 0xf2, ///< MIDI Controller 114 [gig format extension]
553                    _lev_ctrl_CC115_EXT         = 0xf3, ///< MIDI Controller 115 [gig format extension]
554                    _lev_ctrl_CC116_EXT         = 0xf4, ///< MIDI Controller 116 [gig format extension]
555                    _lev_ctrl_CC117_EXT         = 0xf5, ///< MIDI Controller 117 [gig format extension]
556                    _lev_ctrl_CC118_EXT         = 0xf6, ///< MIDI Controller 118 [gig format extension]
557                    _lev_ctrl_CC119_EXT         = 0xf7  ///< MIDI Controller 119 [gig format extension]
558              } _lev_ctrl_t;              } _lev_ctrl_t;
559              typedef std::map<uint32_t, double*> VelocityTableMap;              typedef std::map<uint32_t, double*> VelocityTableMap;
560    
# Line 563  namespace gig { Line 627  namespace gig {
627              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);
628              unsigned long Write(void* pBuffer, unsigned long SampleCount);              unsigned long Write(void* pBuffer, unsigned long SampleCount);
629              Group*        GetGroup() const;              Group*        GetGroup() const;
630              virtual void  UpdateChunks();              virtual void  UpdateChunks(progress_t* pProgress);
631              void CopyAssignMeta(const Sample* orig);              void CopyAssignMeta(const Sample* orig);
632              void CopyAssignWave(const Sample* orig);              void CopyAssignWave(const Sample* orig);
633          protected:          protected:
# Line 614  namespace gig { Line 678  namespace gig {
678      };      };
679    
680      // 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)
681      /** Defines <i>Region</i> information of an <i>Instrument</i>. */      /** @brief Defines Region information of an Instrument.
682         *
683         * A Region reflects a consecutive area on the keyboard. The individual
684         * regions in the gig format may not overlap with other regions (of the same
685         * instrument). Further, in the gig format a Region is merely a container
686         * for DimensionRegions (a.k.a. "Cases"). The Region itself does not provide
687         * the sample mapping or articulation informations used, even though the
688         * data structures indeed provide such informations. The latter is however
689         * just of historical nature, because the gig format was derived from the
690         * DLS format.
691         *
692         * Each Region consists of at least one or more DimensionRegions. The actual
693         * amount of DimensionRegions depends on which kind of "dimensions" are
694         * defined for this region, and on the split / zone amount for each of those
695         * dimensions.
696         */
697      class Region : public DLS::Region {      class Region : public DLS::Region {
698          public:          public:
699              unsigned int            Dimensions;               ///< Number of defined dimensions, do not alter!              unsigned int            Dimensions;               ///< Number of defined dimensions, do not alter!
# Line 626  namespace gig { Line 705  namespace gig {
705              // own methods              // own methods
706              DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);              DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);
707              DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);              DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);
708                int              GetDimensionRegionIndexByValue(const uint DimValues[8]);
709              Sample*          GetSample();              Sample*          GetSample();
710              void             AddDimension(dimension_def_t* pDimDef);              void             AddDimension(dimension_def_t* pDimDef);
711              void             DeleteDimension(dimension_def_t* pDimDef);              void             DeleteDimension(dimension_def_t* pDimDef);
712                dimension_def_t* GetDimensionDefinition(dimension_t type);
713                void             DeleteDimensionZone(dimension_t type, int zone);
714                void             SplitDimensionZone(dimension_t type, int zone);
715                void             SetDimensionType(dimension_t oldType, dimension_t newType);
716              // overridden methods              // overridden methods
717              virtual void     SetKeyRange(uint16_t Low, uint16_t High);              virtual void     SetKeyRange(uint16_t Low, uint16_t High);
718              virtual void     UpdateChunks();              virtual void     UpdateChunks(progress_t* pProgress);
719              virtual void     CopyAssign(const Region* orig);              virtual void     CopyAssign(const Region* orig);
720          protected:          protected:
721              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
# Line 639  namespace gig { Line 723  namespace gig {
723              void UpdateVelocityTable();              void UpdateVelocityTable();
724              Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);              Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
725              void CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples);              void CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples);
726                DimensionRegion* GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase);
727             ~Region();             ~Region();
728              friend class Instrument;              friend class Instrument;
729      };      };
# Line 744  namespace gig { Line 829  namespace gig {
829              friend class Instrument;              friend class Instrument;
830      };      };
831    
832        /** @brief Real-time instrument script (gig format extension).
833         *
834         * Real-time instrument scripts are user supplied small programs which can
835         * be used by instrument designers to create custom behaviors and features
836         * not available in the stock sampler engine. Features which might be very
837         * exotic or specific for the respective instrument.
838         *
839         * This is an extension of the GigaStudio format, thus a feature which was
840         * not available in the GigaStudio 4 software. It is currently only
841         * supported by LinuxSampler and gigedit.
842         */
843        class Script {
844            public:
845                enum Encoding_t {
846                    ENCODING_ASCII = 0 ///< Standard 8 bit US ASCII character encoding (default).
847                };
848                enum Compression_t {
849                    COMPRESSION_NONE = 0 ///< Is not compressed at all (default).
850                };
851                enum Language_t {
852                    LANGUAGE_NKSP = 0 ///< NKSP stands for "Is Not KSP" (default).
853                };
854    
855                String         Name;        ///< Arbitrary name of the script, which may be displayed i.e. in an instrument editor.
856                Compression_t  Compression; ///< Whether the script was/should be compressed, and if so, which compression algorithm shall be used.
857                Encoding_t     Encoding;    ///< Format the script's source code text is encoded with.
858                Language_t     Language;    ///< Programming language and dialect the script is written in.
859                bool           Bypass;      ///< Global bypass: if enabled, this script shall not be executed by the sampler for any instrument.
860    
861                String GetScriptAsText();
862                void   SetScriptAsText(const String& text);
863                void   SetGroup(ScriptGroup* pGroup);
864                ScriptGroup* GetGroup() const;
865            protected:
866                Script(ScriptGroup* group, RIFF::Chunk* ckScri);
867                virtual ~Script();
868                void UpdateChunks(progress_t* pProgress);
869                void RemoveAllScriptReferences();
870                friend class ScriptGroup;
871                friend class Instrument;
872            private:
873                ScriptGroup*          pGroup;
874                RIFF::Chunk*          pChunk; ///< 'Scri' chunk
875                std::vector<uint8_t>  data;
876                uint32_t              crc; ///< CRC-32 checksum of the raw script data
877        };
878    
879        /** @brief Group of instrument scripts (gig format extension).
880         *
881         * This class is simply used to sort a bunch of real-time instrument scripts
882         * into individual groups. This allows instrument designers and script
883         * developers to keep scripts in a certain order while working with a larger
884         * amount of scripts in an instrument editor.
885         *
886         * This is an extension of the GigaStudio format, thus a feature which was
887         * not available in the GigaStudio 4 software. It is currently only
888         * supported by LinuxSampler and gigedit.
889         */
890        class ScriptGroup {
891            public:
892                String   Name; ///< Name of this script group. For example to be displayed in an instrument editor.
893    
894                Script*  GetScript(uint index);
895                Script*  AddScript();
896                void     DeleteScript(Script* pScript);
897            protected:
898                ScriptGroup(File* file, RIFF::List* lstRTIS);
899                virtual ~ScriptGroup();
900                void LoadScripts();
901                void UpdateChunks(progress_t* pProgress);
902                friend class Script;
903                friend class File;
904            private:
905                File*                pFile;
906                RIFF::List*          pList; ///< 'RTIS' list chunk
907                std::list<Script*>*  pScripts;
908        };
909    
910      /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */      /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */
911      class Instrument : protected DLS::Instrument {      class Instrument : protected DLS::Instrument {
912          public:          public:
# Line 773  namespace gig { Line 936  namespace gig {
936              Region*   GetNextRegion();              Region*   GetNextRegion();
937              Region*   AddRegion();              Region*   AddRegion();
938              void      DeleteRegion(Region* pRegion);              void      DeleteRegion(Region* pRegion);
939              virtual void UpdateChunks();              virtual void UpdateChunks(progress_t* pProgress);
940              virtual void CopyAssign(const Instrument* orig);              virtual void CopyAssign(const Instrument* orig);
941              // own methods              // own methods
942              Region*   GetRegion(unsigned int Key);              Region*   GetRegion(unsigned int Key);
# Line 782  namespace gig { Line 945  namespace gig {
945              MidiRuleLegato*      AddMidiRuleLegato();              MidiRuleLegato*      AddMidiRuleLegato();
946              MidiRuleAlternator*  AddMidiRuleAlternator();              MidiRuleAlternator*  AddMidiRuleAlternator();
947              void      DeleteMidiRule(int i);              void      DeleteMidiRule(int i);
948                // real-time instrument script methods
949                Script*   GetScriptOfSlot(uint index);
950                void      AddScriptSlot(Script* pScript, bool bypass = false);
951                void      SwapScriptSlots(uint index1, uint index2);
952                void      RemoveScriptSlot(uint index);
953                void      RemoveScript(Script* pScript);
954                uint      ScriptSlotCount() const;
955                bool      IsScriptSlotBypassed(uint index);
956                void      SetScriptSlotBypassed(uint index, bool bBypass);
957          protected:          protected:
958              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
959    
# Line 789  namespace gig { Line 961  namespace gig {
961             ~Instrument();             ~Instrument();
962              void CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples);              void CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples);
963              void UpdateRegionKeyTable();              void UpdateRegionKeyTable();
964                void LoadScripts();
965                void UpdateScriptFileOffsets();
966              friend class File;              friend class File;
967              friend class Region; // so Region can call UpdateRegionKeyTable()              friend class Region; // so Region can call UpdateRegionKeyTable()
968          private:          private:
969                struct _ScriptPooolEntry {
970                    uint32_t fileOffset;
971                    bool     bypass;
972                };
973                struct _ScriptPooolRef {
974                    Script*  script;
975                    bool     bypass;
976                };
977              MidiRule** pMidiRules;              MidiRule** pMidiRules;
978                std::vector<_ScriptPooolEntry> scriptPoolFileOffsets;
979                std::vector<_ScriptPooolRef>* pScriptRefs;
980      };      };
981    
982      /** @brief Group of Gigasampler objects      /** @brief Group of Gigasampler objects
# Line 820  namespace gig { Line 1004  namespace gig {
1004          protected:          protected:
1005              Group(File* file, RIFF::Chunk* ck3gnm);              Group(File* file, RIFF::Chunk* ck3gnm);
1006              virtual ~Group();              virtual ~Group();
1007              virtual void UpdateChunks();              virtual void UpdateChunks(progress_t* pProgress);
1008              void MoveAll();              void MoveAll();
1009              friend class File;              friend class File;
1010          private:          private:
# Line 864  namespace gig { Line 1048  namespace gig {
1048              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.
1049              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.
1050              Group*      GetGroup(uint index);              Group*      GetGroup(uint index);
1051                Group*      GetGroup(String name);
1052              Group*      AddGroup();              Group*      AddGroup();
1053              void        DeleteGroup(Group* pGroup);              void        DeleteGroup(Group* pGroup);
1054              void        DeleteGroupOnly(Group* pGroup);              void        DeleteGroupOnly(Group* pGroup);
1055              void        SetAutoLoad(bool b);              void        SetAutoLoad(bool b);
1056              bool        GetAutoLoad();              bool        GetAutoLoad();
1057              void        AddContentOf(File* pFile);              void        AddContentOf(File* pFile);
1058                ScriptGroup* GetScriptGroup(uint index);
1059                ScriptGroup* GetScriptGroup(const String& name);
1060                ScriptGroup* AddScriptGroup();
1061                void        DeleteScriptGroup(ScriptGroup* pGroup);
1062              virtual    ~File();              virtual    ~File();
1063              virtual void UpdateChunks();              virtual void UpdateChunks(progress_t* pProgress);
1064          protected:          protected:
1065              // overridden protected methods from DLS::File              // overridden protected methods from DLS::File
1066              virtual void LoadSamples();              virtual void LoadSamples();
1067              virtual void LoadInstruments();              virtual void LoadInstruments();
1068              virtual void LoadGroups();              virtual void LoadGroups();
1069                virtual void UpdateFileOffsets();
1070              // own protected methods              // own protected methods
1071              virtual void LoadSamples(progress_t* pProgress);              virtual void LoadSamples(progress_t* pProgress);
1072              virtual void LoadInstruments(progress_t* pProgress);              virtual void LoadInstruments(progress_t* pProgress);
1073                virtual void LoadScriptGroups();
1074              void SetSampleChecksum(Sample* pSample, uint32_t crc);              void SetSampleChecksum(Sample* pSample, uint32_t crc);
1075              friend class Region;              friend class Region;
1076              friend class Sample;              friend class Sample;
1077              friend class Group; // so Group can access protected member pRIFF              friend class Group; // so Group can access protected member pRIFF
1078                friend class ScriptGroup; // so ScriptGroup can access protected member pRIFF
1079          private:          private:
1080              std::list<Group*>*          pGroups;              std::list<Group*>*          pGroups;
1081              std::list<Group*>::iterator GroupsIterator;              std::list<Group*>::iterator GroupsIterator;
1082              bool                        bAutoLoad;              bool                        bAutoLoad;
1083                std::list<ScriptGroup*>*    pScriptGroups;
1084      };      };
1085    
1086      /**      /**
Legend:
Removed from v.2482  
changed lines
  Added in v.2682
  ViewVC Help
Powered by ViewVC