/[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 1207 by persson, Sat May 26 13:59:40 2007 UTC revision 2639 by schoenebeck, Mon Jun 16 13:22:50 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 323  namespace gig { Line 332  namespace gig {
332          progress_t();          progress_t();
333      };      };
334    
     /** @brief CRC-32 checksum implementation  
      *  
      * This class is used to calculate checksums of the sample data in  
      * a gig file. The checksums are stored in the 3crc chunk of the  
      * gig file and automatically updated when a sample is written  
      * with Sample::Write().  
      */  
     class CRC {  
     private:  
         uint32_t value;  
         static const uint32_t* table;  
         static uint32_t* initTable();  
     public:  
         CRC() {  
             reset();  
         }  
         void reset() {  
             value = 0xffffffff;  
         }  
         void update(unsigned char* buf, int len) {  
             for (int i = 0 ; i < len ; i++) {  
                 value = table[(value ^ buf[i]) & 0xff] ^ (value >> 8);  
             }  
         }  
         uint32_t getValue() {  
             return value ^ 0xffffffff;  
         }  
     };  
   
335      // just symbol prototyping      // just symbol prototyping
336      class File;      class File;
337      class Instrument;      class Instrument;
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 373  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 425  namespace gig { Line 407  namespace gig {
407              // Filter              // Filter
408              bool               VCFEnabled;                    ///< If filter should be used.              bool               VCFEnabled;                    ///< If filter should be used.
409              vcf_type_t         VCFType;                       ///< Defines the general filter characteristic (lowpass, highpass, bandpass, etc.).              vcf_type_t         VCFType;                       ///< Defines the general filter characteristic (lowpass, highpass, bandpass, etc.).
410              vcf_cutoff_ctrl_t  VCFCutoffController;           ///< Specifies which external controller has influence on the filter cutoff frequency.              vcf_cutoff_ctrl_t  VCFCutoffController;           ///< Specifies which external controller has influence on the filter cutoff frequency. @deprecated Don't alter directly, use SetVCFCutoffController() instead!
411              bool               VCFCutoffControllerInvert;     ///< Inverts values coming from the defined cutoff controller              bool               VCFCutoffControllerInvert;     ///< Inverts values coming from the defined cutoff controller
412              uint8_t            VCFCutoff;                     ///< Max. cutoff frequency.              uint8_t            VCFCutoff;                     ///< Max. cutoff frequency.
413              curve_type_t       VCFVelocityCurve;              ///< Defines a transformation curve for the incoming velocity values, affecting the VCF.              curve_type_t       VCFVelocityCurve;              ///< Defines a transformation curve for the incoming velocity values, affecting the VCF. @deprecated Don't alter directly, use SetVCFVelocityCurve() instead!
414              uint8_t            VCFVelocityScale;              ///< (0-127) Amount velocity controls VCF cutoff frequency (only if no other VCF cutoff controller is defined, otherwise this is the minimum cutoff).              uint8_t            VCFVelocityScale;              ///< (0-127) Amount velocity controls VCF cutoff frequency (only if no other VCF cutoff controller is defined, otherwise this is the minimum cutoff). @deprecated Don't alter directly, use SetVCFVelocityScale() instead!
415              uint8_t            VCFVelocityDynamicRange;       ///< 0x04 = lowest, 0x00 = highest              uint8_t            VCFVelocityDynamicRange;       ///< 0x04 = lowest, 0x00 = highest . @deprecated Don't alter directly, use SetVCFVelocityDynamicRange() instead!
416              uint8_t            VCFResonance;                  ///< Firm internal filter resonance weight.              uint8_t            VCFResonance;                  ///< Firm internal filter resonance weight.
417              bool               VCFResonanceDynamic;           ///< If <i>true</i>: Increases the resonance Q according to changes of controllers that actually control the VCF cutoff frequency (EG2, ext. VCF MIDI controller).              bool               VCFResonanceDynamic;           ///< If <i>true</i>: Increases the resonance Q according to changes of controllers that actually control the VCF cutoff frequency (EG2, ext. VCF MIDI controller).
418              vcf_res_ctrl_t     VCFResonanceController;        ///< Specifies which external controller has influence on the filter resonance Q.              vcf_res_ctrl_t     VCFResonanceController;        ///< Specifies which external controller has influence on the filter resonance Q.
419              bool               VCFKeyboardTracking;           ///< If <i>true</i>: VCF cutoff frequence will be dependend to the note key position relative to the defined breakpoint value.              bool               VCFKeyboardTracking;           ///< If <i>true</i>: VCF cutoff frequence will be dependend to the note key position relative to the defined breakpoint value.
420              uint8_t            VCFKeyboardTrackingBreakpoint; ///< See VCFKeyboardTracking (0 - 127).              uint8_t            VCFKeyboardTrackingBreakpoint; ///< See VCFKeyboardTracking (0 - 127).
421              // Key Velocity Transformations              // Key Velocity Transformations
422              curve_type_t       VelocityResponseCurve;         ///< Defines a transformation curve to the incoming velocity values affecting amplitude (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead).              curve_type_t       VelocityResponseCurve;         ///< Defines a transformation curve to the incoming velocity values affecting amplitude (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead). @deprecated Don't alter directly, use SetVelocityResponseCurve() instead!
423              uint8_t            VelocityResponseDepth;         ///< Dynamic range of velocity affecting amplitude (0 - 4) (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead).              uint8_t            VelocityResponseDepth;         ///< Dynamic range of velocity affecting amplitude (0 - 4) (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead). @deprecated Don't alter directly, use SetVelocityResponseDepth() instead!
424              uint8_t            VelocityResponseCurveScaling;  ///< 0 - 127 (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead)              uint8_t            VelocityResponseCurveScaling;  ///< 0 - 127 (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead). @deprecated Don't alter directly, use SetVelocityResponseCurveScaling() instead!
425              curve_type_t       ReleaseVelocityResponseCurve;  ///< Defines a transformation curve to the incoming release veloctiy values affecting envelope times.              curve_type_t       ReleaseVelocityResponseCurve;  ///< Defines a transformation curve to the incoming release veloctiy values affecting envelope times. @deprecated Don't alter directly, use SetReleaseVelocityResponseCurve() instead!
426              uint8_t            ReleaseVelocityResponseDepth;  ///< Dynamic range of release velocity affecting envelope time (0 - 4).              uint8_t            ReleaseVelocityResponseDepth;  ///< Dynamic range of release velocity affecting envelope time (0 - 4). @deprecated Don't alter directly, use SetReleaseVelocityResponseDepth() instead!
427              uint8_t            ReleaseTriggerDecay;           ///< 0 - 8              uint8_t            ReleaseTriggerDecay;           ///< 0 - 8
428              // Mix / Layer              // Mix / Layer
429              crossfade_t        Crossfade;              crossfade_t        Crossfade;
# Line 457  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);
453              double GetVelocityRelease(uint8_t MIDIKeyVelocity);              double GetVelocityRelease(uint8_t MIDIKeyVelocity);
454              double GetVelocityCutoff(uint8_t MIDIKeyVelocity);              double GetVelocityCutoff(uint8_t MIDIKeyVelocity);
455                void SetVelocityResponseCurve(curve_type_t curve);
456                void SetVelocityResponseDepth(uint8_t depth);
457                void SetVelocityResponseCurveScaling(uint8_t scaling);
458                void SetReleaseVelocityResponseCurve(curve_type_t curve);
459                void SetReleaseVelocityResponseDepth(uint8_t depth);
460                void SetVCFCutoffController(vcf_cutoff_ctrl_t controller);
461                void SetVCFVelocityCurve(curve_type_t curve);
462                void SetVCFVelocityDynamicRange(uint8_t range);
463                void SetVCFVelocityScale(uint8_t scaling);
464                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);
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(RIFF::List* _3ewl);              DimensionRegion(Region* pParent, RIFF::List* _3ewl);
475                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 507  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 516  namespace gig { Line 583  namespace gig {
583              double*                  pVelocityAttenuationTable;  ///< Points to the velocity table corresponding to the velocity parameters of this DimensionRegion.              double*                  pVelocityAttenuationTable;  ///< Points to the velocity table corresponding to the velocity parameters of this DimensionRegion.
584              double*                  pVelocityReleaseTable;      ///< Points to the velocity table corresponding to the release velocity parameters of this DimensionRegion              double*                  pVelocityReleaseTable;      ///< Points to the velocity table corresponding to the release velocity parameters of this DimensionRegion
585              double*                  pVelocityCutoffTable;       ///< Points to the velocity table corresponding to the filter velocity parameters of this DimensionRegion              double*                  pVelocityCutoffTable;       ///< Points to the velocity table corresponding to the filter velocity parameters of this DimensionRegion
586                Region*                  pRegion;
587    
588              leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);              leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
589              _lev_ctrl_t     EncodeLeverageController(leverage_ctrl_t DecodedController);              _lev_ctrl_t     EncodeLeverageController(leverage_ctrl_t DecodedController);
590                double* GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth);
591                double* GetCutoffVelocityTable(curve_type_t vcfVelocityCurve, uint8_t vcfVelocityDynamicRange, uint8_t vcfVelocityScale, vcf_cutoff_ctrl_t vcfCutoffController);
592              double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);              double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
593              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
594      };      };
# Line 572  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 592  namespace gig { Line 664  namespace gig {
664              unsigned long        FileNo;                  ///< File number (> 0 when sample is stored in an extension file, 0 when it's in the gig)              unsigned long        FileNo;                  ///< File number (> 0 when sample is stored in an extension file, 0 when it's in the gig)
665              RIFF::Chunk*         pCk3gix;              RIFF::Chunk*         pCk3gix;
666              RIFF::Chunk*         pCkSmpl;              RIFF::Chunk*         pCkSmpl;
667              CRC                  crc;                     ///< CRC-32 checksum of the raw sample data              uint32_t             crc;                     ///< CRC-32 checksum of the raw sample data
668    
669              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo = 0);              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo = 0);
670             ~Sample();             ~Sample();
# Line 626  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 635  namespace gig { Line 722  namespace gig {
722              DimensionRegion*        pDimensionRegions[256];   ///< Pointer array to the 32 (gig2) or 256 (gig3) possible dimension regions (reflects NULL for dimension regions not in use). Avoid to access the array directly and better use GetDimensionRegionByValue() instead, but of course in some cases it makes sense to use the array (e.g. iterating through all DimensionRegions). Use AddDimension() and DeleteDimension() to create a new dimension or delete an existing one (which will create or delete the respective dimension region(s) automatically).              DimensionRegion*        pDimensionRegions[256];   ///< Pointer array to the 32 (gig2) or 256 (gig3) possible dimension regions (reflects NULL for dimension regions not in use). Avoid to access the array directly and better use GetDimensionRegionByValue() instead, but of course in some cases it makes sense to use the array (e.g. iterating through all DimensionRegions). Use AddDimension() and DeleteDimension() to create a new dimension or delete an existing one (which will create or delete the respective dimension region(s) automatically).
723              unsigned int            Layers;                   ///< Amount of defined layers (1 - 32). A value of 1 actually means no layering, a value > 1 means there is Layer dimension. The same information can of course also be obtained by accessing pDimensionDefinitions. Do not alter this value!              unsigned int            Layers;                   ///< Amount of defined layers (1 - 32). A value of 1 actually means no layering, a value > 1 means there is Layer dimension. The same information can of course also be obtained by accessing pDimensionDefinitions. Do not alter this value!
724    
725                // 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                void             SetDimensionType(dimension_t oldType, dimension_t newType);
736                // overridden methods
737                virtual void     SetKeyRange(uint16_t Low, uint16_t High);
738              virtual void     UpdateChunks();              virtual void     UpdateChunks();
739                virtual void     CopyAssign(const Region* orig);
740          protected:          protected:
741              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
742              void LoadDimensionRegions(RIFF::List* rgn);              void LoadDimensionRegions(RIFF::List* rgn);
743              void UpdateVelocityTable();              void UpdateVelocityTable();
744              Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);              Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
745                void CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples);
746                DimensionRegion* GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase);
747             ~Region();             ~Region();
748              friend class Instrument;              friend class Instrument;
749      };      };
750    
751        /** Abstract base class for all MIDI rules. */
752        class MidiRule {
753            public:
754                virtual ~MidiRule() { }
755            protected:
756                virtual void UpdateChunks(uint8_t* pData) const = 0;
757                friend class Instrument;
758        };
759    
760        /** MIDI rule for triggering notes by control change events. */
761        class MidiRuleCtrlTrigger : public MidiRule {
762            public:
763                uint8_t ControllerNumber;   ///< MIDI controller number.
764                uint8_t Triggers;           ///< Number of triggers.
765                struct trigger_t {
766                    uint8_t TriggerPoint;   ///< The CC value to pass for the note to be triggered.
767                    bool    Descending;     ///< If the change in CC value should be downwards.
768                    uint8_t VelSensitivity; ///< How sensitive the velocity should be to the speed of the controller change.
769                    uint8_t Key;            ///< Key to trigger.
770                    bool    NoteOff;        ///< If a note off should be triggered instead of a note on.
771                    uint8_t Velocity;       ///< Velocity of the note to trigger. 255 means that velocity should depend on the speed of the controller change.
772                    bool    OverridePedal;  ///< If a note off should be triggered even if the sustain pedal is down.
773                } pTriggers[32];
774    
775            protected:
776                MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg);
777                MidiRuleCtrlTrigger();
778                void UpdateChunks(uint8_t* pData) const;
779                friend class Instrument;
780        };
781    
782        /** MIDI rule for instruments with legato samples. */
783        class MidiRuleLegato : public MidiRule {
784            public:
785                uint8_t LegatoSamples;     ///< Number of legato samples per key in each direction (always 12)
786                bool BypassUseController;  ///< If a controller should be used to bypass the sustain note
787                uint8_t BypassKey;         ///< Key to be used to bypass the sustain note
788                uint8_t BypassController;  ///< Controller to be used to bypass the sustain note
789                uint16_t ThresholdTime;    ///< Maximum time (ms) between two notes that should be played legato
790                uint16_t ReleaseTime;      ///< Release time
791                range_t KeyRange;          ///< Key range for legato notes
792                uint8_t ReleaseTriggerKey; ///< Key triggering release samples
793                uint8_t AltSustain1Key;    ///< Key triggering alternate sustain samples
794                uint8_t AltSustain2Key;    ///< Key triggering a second set of alternate sustain samples
795    
796            protected:
797                MidiRuleLegato(RIFF::Chunk* _3ewg);
798                MidiRuleLegato();
799                void UpdateChunks(uint8_t* pData) const;
800                friend class Instrument;
801        };
802    
803        /** MIDI rule to automatically cycle through specified sequences of different articulations. The instrument must be using the smartmidi dimension. */
804        class MidiRuleAlternator : public MidiRule {
805            public:
806                uint8_t Articulations;     ///< Number of articulations in the instrument
807                String pArticulations[32]; ///< Names of the articulations
808    
809                range_t PlayRange;         ///< Key range of the playable keys in the instrument
810    
811                uint8_t Patterns;          ///< Number of alternator patterns
812                struct pattern_t {
813                    String Name;           ///< Name of the pattern
814                    int Size;              ///< Number of steps in the pattern
815                    const uint8_t& operator[](int i) const { /// Articulation to play
816                        return data[i];
817                    }
818                    uint8_t& operator[](int i) {
819                        return data[i];
820                    }
821                private:
822                    uint8_t data[32];
823                } pPatterns[32];           ///< A pattern is a sequence of articulation numbers
824    
825                typedef enum {
826                    selector_none,
827                    selector_key_switch,
828                    selector_controller
829                } selector_t;
830                selector_t Selector;       ///< Method by which pattern is chosen
831                range_t KeySwitchRange;    ///< Key range for key switch selector
832                uint8_t Controller;        ///< CC number for controller selector
833    
834                bool Polyphonic;           ///< If alternator should step forward only when all notes are off
835                bool Chained;              ///< If all patterns should be chained together
836    
837            protected:
838                MidiRuleAlternator(RIFF::Chunk* _3ewg);
839                MidiRuleAlternator();
840                void UpdateChunks(uint8_t* pData) const;
841                friend class Instrument;
842        };
843    
844        /** A MIDI rule not yet implemented by libgig. */
845        class MidiRuleUnknown : public MidiRule {
846            protected:
847                MidiRuleUnknown() { }
848                void UpdateChunks(uint8_t* pData) const { }
849                friend class Instrument;
850        };
851    
852        /** @brief Real-time instrument script (gig format extension).
853         *
854         * Real-time instrument scripts are user supplied small programs which can
855         * be used by instrument designers to create custom behaviors and features
856         * not available in the stock sampler engine. Features which might be very
857         * exotic or specific for the respective instrument.
858         *
859         * This is an extension of the GigaStudio format, thus a feature which was
860         * not available in the GigaStudio 4 software. It is currently only
861         * supported by LinuxSampler and gigedit.
862         */
863        class Script {
864            public:
865                enum Encoding_t {
866                    ENCODING_ASCII = 0 ///< Standard 8 bit US ASCII character encoding (default).
867                };
868                enum Compression_t {
869                    COMPRESSION_NONE = 0 ///< Is not compressed at all (default).
870                };
871                enum Language_t {
872                    LANGUAGE_NKSP = 0 ///< NKSP stands for "Is Not KSP" (default).
873                };
874    
875                String         Name;        ///< Arbitrary name of the script, which may be displayed i.e. in an instrument editor.
876                Compression_t  Compression; ///< Whether the script was/should be compressed, and if so, which compression algorithm shall be used.
877                Encoding_t     Encoding;    ///< Format the script's source code text is encoded with.
878                Language_t     Language;    ///< Programming language and dialect the script is written in.
879                bool           Bypass;      ///< Global bypass: if enabled, this script shall not be executed by the sampler for any instrument.
880    
881                String GetScriptAsText();
882                void   SetScriptAsText(const String& text);
883                void   SetGroup(ScriptGroup* pGroup);
884                ScriptGroup* GetGroup() const;
885            protected:
886                Script(ScriptGroup* group, RIFF::Chunk* ckScri);
887                virtual ~Script();
888                void UpdateChunks();
889                void RemoveAllScriptReferences();
890                friend class ScriptGroup;
891                friend class Instrument;
892            private:
893                ScriptGroup*          pGroup;
894                RIFF::Chunk*          pChunk; ///< 'Scri' chunk
895                std::vector<uint8_t>  data;
896                uint32_t              crc; ///< CRC-32 checksum of the raw script data
897        };
898    
899        /** @brief Group of instrument scripts (gig format extension).
900         *
901         * This class is simply used to sort a bunch of real-time instrument scripts
902         * into individual groups. This allows instrument designers and script
903         * developers to keep scripts in a certain order while working with a larger
904         * amount of scripts in an instrument editor.
905         *
906         * This is an extension of the GigaStudio format, thus a feature which was
907         * not available in the GigaStudio 4 software. It is currently only
908         * supported by LinuxSampler and gigedit.
909         */
910        class ScriptGroup {
911            public:
912                String   Name; ///< Name of this script group. For example to be displayed in an instrument editor.
913    
914                Script*  GetScript(uint index);
915                Script*  AddScript();
916                void     DeleteScript(Script* pScript);
917            protected:
918                ScriptGroup(File* file, RIFF::List* lstRTIS);
919                virtual ~ScriptGroup();
920                void LoadScripts();
921                void UpdateChunks();
922                friend class Script;
923                friend class File;
924            private:
925                File*                pFile;
926                RIFF::List*          pList; ///< 'RTIS' list chunk
927                std::list<Script*>*  pScripts;
928        };
929    
930      /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */      /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */
931      class Instrument : protected DLS::Instrument {      class Instrument : protected DLS::Instrument {
932          public:          public:
933              // derived attributes from DLS::Resource              // derived attributes from DLS::Resource
934              DLS::Resource::pInfo;              using DLS::Resource::pInfo;
935              DLS::Resource::pDLSID;              using DLS::Resource::pDLSID;
936              // derived attributes from DLS::Instrument              // derived attributes from DLS::Instrument
937              DLS::Instrument::IsDrum;              using DLS::Instrument::IsDrum;
938              DLS::Instrument::MIDIBank;              using DLS::Instrument::MIDIBank;
939              DLS::Instrument::MIDIBankCoarse;              using DLS::Instrument::MIDIBankCoarse;
940              DLS::Instrument::MIDIBankFine;              using DLS::Instrument::MIDIBankFine;
941              DLS::Instrument::MIDIProgram;              using DLS::Instrument::MIDIProgram;
942              DLS::Instrument::Regions;              using DLS::Instrument::Regions;
943              // own attributes              // own attributes
944              int32_t   Attenuation;       ///< in dB              int32_t   Attenuation;       ///< in dB
945              uint16_t  EffectSend;              uint16_t  EffectSend;
# Line 673  namespace gig { Line 950  namespace gig {
950    
951    
952              // derived methods from DLS::Resource              // derived methods from DLS::Resource
953              DLS::Resource::GetParent;              using DLS::Resource::GetParent;
             // derived methods from DLS::Instrument  
             DLS::Instrument::MoveRegion;  
954              // overridden methods              // overridden methods
955              Region*   GetFirstRegion();              Region*   GetFirstRegion();
956              Region*   GetNextRegion();              Region*   GetNextRegion();
957              Region*   AddRegion();              Region*   AddRegion();
958              void      DeleteRegion(Region* pRegion);              void      DeleteRegion(Region* pRegion);
959              virtual void UpdateChunks();              virtual void UpdateChunks();
960                virtual void CopyAssign(const Instrument* orig);
961              // own methods              // own methods
962              Region*   GetRegion(unsigned int Key);              Region*   GetRegion(unsigned int Key);
963                MidiRule* GetMidiRule(int i);
964                MidiRuleCtrlTrigger* AddMidiRuleCtrlTrigger();
965                MidiRuleLegato*      AddMidiRuleLegato();
966                MidiRuleAlternator*  AddMidiRuleAlternator();
967                void      DeleteMidiRule(int i);
968                // real-time instrument script methods
969                Script*   GetScriptOfSlot(uint index);
970                void      AddScriptSlot(Script* pScript, bool bypass = false);
971                void      SwapScriptSlots(uint index1, uint index2);
972                void      RemoveScriptSlot(uint index);
973                void      RemoveScript(Script* pScript);
974                uint      ScriptSlotCount() const;
975                bool      IsScriptSlotBypassed(uint index);
976                void      SetScriptSlotBypassed(uint index, bool bBypass);
977          protected:          protected:
978              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
979    
980              Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);              Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);
981             ~Instrument();             ~Instrument();
982                void CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples);
983              void UpdateRegionKeyTable();              void UpdateRegionKeyTable();
984                void LoadScripts();
985                void UpdateScriptFileOffsets();
986              friend class File;              friend class File;
987                friend class Region; // so Region can call UpdateRegionKeyTable()
988            private:
989                struct _ScriptPooolEntry {
990                    uint32_t fileOffset;
991                    bool     bypass;
992                };
993                struct _ScriptPooolRef {
994                    Script*  script;
995                    bool     bypass;
996                };
997                MidiRule** pMidiRules;
998                std::vector<_ScriptPooolEntry> scriptPoolFileOffsets;
999                std::vector<_ScriptPooolRef>* pScriptRefs;
1000      };      };
1001    
1002      /** @brief Group of Gigasampler objects      /** @brief Group of Gigasampler objects
# Line 723  namespace gig { Line 1029  namespace gig {
1029              friend class File;              friend class File;
1030          private:          private:
1031              File*        pFile;              File*        pFile;
1032              RIFF::Chunk* pNameChunk;              RIFF::Chunk* pNameChunk; ///< '3gnm' chunk
1033      };      };
1034    
1035      /** Parses Gigasampler files and provides abstract access to the data. */      /** Parses Gigasampler files and provides abstract access to the data. */
# Line 733  namespace gig { Line 1039  namespace gig {
1039              static const DLS::version_t VERSION_3;              static const DLS::version_t VERSION_3;
1040    
1041              // derived attributes from DLS::Resource              // derived attributes from DLS::Resource
1042              DLS::Resource::pInfo;              using DLS::Resource::pInfo;
1043              DLS::Resource::pDLSID;              using DLS::Resource::pDLSID;
1044              // derived attributes from DLS::File              // derived attributes from DLS::File
1045              DLS::File::pVersion;              using DLS::File::pVersion;
1046              DLS::File::Instruments;              using DLS::File::Instruments;
1047    
1048              // derived methods from DLS::Resource              // derived methods from DLS::Resource
1049              DLS::Resource::GetParent;              using DLS::Resource::GetParent;
1050              // derived methods from DLS::File              // derived methods from DLS::File
1051              DLS::File::Save;              using DLS::File::Save;
1052                using DLS::File::GetFileName;
1053                using DLS::File::SetFileName;
1054              // overridden  methods              // overridden  methods
1055              File();              File();
1056              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
1057              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.
1058              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.
1059                Sample*     GetSample(uint index);
1060              Sample*     AddSample();              Sample*     AddSample();
1061              void        DeleteSample(Sample* pSample);              void        DeleteSample(Sample* pSample);
1062              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.
1063              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.
1064              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
1065              Instrument* AddInstrument();              Instrument* AddInstrument();
1066                Instrument* AddDuplicateInstrument(const Instrument* orig);
1067              void        DeleteInstrument(Instrument* pInstrument);              void        DeleteInstrument(Instrument* pInstrument);
1068              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.
1069              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.
1070              Group*      GetGroup(uint index);              Group*      GetGroup(uint index);
1071                Group*      GetGroup(String name);
1072              Group*      AddGroup();              Group*      AddGroup();
1073              void        DeleteGroup(Group* pGroup);              void        DeleteGroup(Group* pGroup);
1074              void        DeleteGroupOnly(Group* pGroup);              void        DeleteGroupOnly(Group* pGroup);
1075                void        SetAutoLoad(bool b);
1076                bool        GetAutoLoad();
1077                void        AddContentOf(File* pFile);
1078                ScriptGroup* GetScriptGroup(uint index);
1079                ScriptGroup* GetScriptGroup(const String& name);
1080                ScriptGroup* AddScriptGroup();
1081                void        DeleteScriptGroup(ScriptGroup* pGroup);
1082              virtual    ~File();              virtual    ~File();
1083              virtual void UpdateChunks();              virtual void UpdateChunks();
1084          protected:          protected:
# Line 768  namespace gig { Line 1086  namespace gig {
1086              virtual void LoadSamples();              virtual void LoadSamples();
1087              virtual void LoadInstruments();              virtual void LoadInstruments();
1088              virtual void LoadGroups();              virtual void LoadGroups();
1089                virtual void UpdateFileOffsets();
1090              // own protected methods              // own protected methods
1091              virtual void LoadSamples(progress_t* pProgress);              virtual void LoadSamples(progress_t* pProgress);
1092              virtual void LoadInstruments(progress_t* pProgress);              virtual void LoadInstruments(progress_t* pProgress);
1093                virtual void LoadScriptGroups();
1094              void SetSampleChecksum(Sample* pSample, uint32_t crc);              void SetSampleChecksum(Sample* pSample, uint32_t crc);
1095              friend class Region;              friend class Region;
1096              friend class Sample;              friend class Sample;
1097              friend class Group; // so Group can access protected member pRIFF              friend class Group; // so Group can access protected member pRIFF
1098                friend class ScriptGroup; // so ScriptGroup can access protected member pRIFF
1099          private:          private:
             static const DLS::Info::FixedStringLength FixedStringLengths[];  
1100              std::list<Group*>*          pGroups;              std::list<Group*>*          pGroups;
1101              std::list<Group*>::iterator GroupsIterator;              std::list<Group*>::iterator GroupsIterator;
1102                bool                        bAutoLoad;
1103                std::list<ScriptGroup*>*    pScriptGroups;
1104      };      };
1105    
1106      /**      /**
Legend:
Removed from v.1207  
changed lines
  Added in v.2639
  ViewVC Help
Powered by ViewVC