/[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 1335 by schoenebeck, Sun Sep 9 21:22:58 2007 UTC revision 2555 by schoenebeck, Fri May 16 23:08:42 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 31  Line 31 
31  # define LIST_TYPE_3EWL 0x3365776C  # define LIST_TYPE_3EWL 0x3365776C
32  # define LIST_TYPE_3GRI 0x33677269  # define LIST_TYPE_3GRI 0x33677269
33  # define LIST_TYPE_3GNL 0x33676E6C  # define LIST_TYPE_3GNL 0x33676E6C
 # define CHUNK_ID_SMPL  0x736D706C  
34  # define CHUNK_ID_3GIX  0x33676978  # define CHUNK_ID_3GIX  0x33676978
35  # define CHUNK_ID_3EWA  0x33657761  # define CHUNK_ID_3EWA  0x33657761
36  # define CHUNK_ID_3LNK  0x336C6E6B  # define CHUNK_ID_3LNK  0x336C6E6B
# Line 45  Line 44 
44  # define LIST_TYPE_3EWL 0x6C776533  # define LIST_TYPE_3EWL 0x6C776533
45  # define LIST_TYPE_3GRI 0x69726733  # define LIST_TYPE_3GRI 0x69726733
46  # define LIST_TYPE_3GNL 0x6C6E6733  # define LIST_TYPE_3GNL 0x6C6E6733
 # define CHUNK_ID_SMPL  0x6C706D73  
47  # define CHUNK_ID_3GIX  0x78696733  # define CHUNK_ID_3GIX  0x78696733
48  # define CHUNK_ID_3EWA  0x61776533  # define CHUNK_ID_3EWA  0x61776533
49  # define CHUNK_ID_3LNK  0x6B6E6C33  # define CHUNK_ID_3LNK  0x6B6E6C33
# Line 323  namespace gig { Line 321  namespace gig {
321          progress_t();          progress_t();
322      };      };
323    
     /** @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;  
         }  
     };  
   
324      // just symbol prototyping      // just symbol prototyping
325      class File;      class File;
326      class Instrument;      class Instrument;
# Line 373  namespace gig { Line 342  namespace gig {
342       */       */
343      class DimensionRegion : protected DLS::Sampler {      class DimensionRegion : protected DLS::Sampler {
344          public:          public:
345              uint8_t            VelocityUpperLimit;            ///< Defines the upper velocity value limit of a velocity split (only if an user defined limit was set, thus a value not equal to 128/NumberOfSplits, else this value is 0). Only for gig2, otherwise the DimensionUpperLimts are used instead.              uint8_t            VelocityUpperLimit;            ///< Defines the upper velocity value limit of a velocity split (only if an user defined limit was set, thus a value not equal to 128/NumberOfSplits, else this value is 0). Only for gig2, for gig3 and above the DimensionUpperLimits are used instead.
346              Sample*            pSample;                       ///< Points to the Sample which is assigned to the dimension region.              Sample*            pSample;                       ///< Points to the Sample which is assigned to the dimension region.
347              // Sample Amplitude EG/LFO              // Sample Amplitude EG/LFO
348              uint16_t           EG1PreAttack;                  ///< Preattack value of the sample amplitude EG (0 - 1000 permille).              uint16_t           EG1PreAttack;                  ///< Preattack value of the sample amplitude EG (0 - 1000 permille).
# Line 425  namespace gig { Line 394  namespace gig {
394              // Filter              // Filter
395              bool               VCFEnabled;                    ///< If filter should be used.              bool               VCFEnabled;                    ///< If filter should be used.
396              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.).
397              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!
398              bool               VCFCutoffControllerInvert;     ///< Inverts values coming from the defined cutoff controller              bool               VCFCutoffControllerInvert;     ///< Inverts values coming from the defined cutoff controller
399              uint8_t            VCFCutoff;                     ///< Max. cutoff frequency.              uint8_t            VCFCutoff;                     ///< Max. cutoff frequency.
400              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!
401              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!
402              uint8_t            VCFVelocityDynamicRange;       ///< 0x04 = lowest, 0x00 = highest              uint8_t            VCFVelocityDynamicRange;       ///< 0x04 = lowest, 0x00 = highest . @deprecated Don't alter directly, use SetVCFVelocityDynamicRange() instead!
403              uint8_t            VCFResonance;                  ///< Firm internal filter resonance weight.              uint8_t            VCFResonance;                  ///< Firm internal filter resonance weight.
404              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).
405              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.
406              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.
407              uint8_t            VCFKeyboardTrackingBreakpoint; ///< See VCFKeyboardTracking (0 - 127).              uint8_t            VCFKeyboardTrackingBreakpoint; ///< See VCFKeyboardTracking (0 - 127).
408              // Key Velocity Transformations              // Key Velocity Transformations
409              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!
410              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!
411              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!
412              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!
413              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!
414              uint8_t            ReleaseTriggerDecay;           ///< 0 - 8              uint8_t            ReleaseTriggerDecay;           ///< 0 - 8
415              // Mix / Layer              // Mix / Layer
416              crossfade_t        Crossfade;              crossfade_t        Crossfade;
# Line 457  namespace gig { Line 426  namespace gig {
426              bool               MSDecode;                      ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.              bool               MSDecode;                      ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.
427              uint16_t           SampleStartOffset;             ///< Number of samples the sample start should be moved (0 - 2000).              uint16_t           SampleStartOffset;             ///< Number of samples the sample start should be moved (0 - 2000).
428              double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)              double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)
429              uint8_t            DimensionUpperLimits[8];       ///< gig3: defines the upper limit of the dimension values for this dimension region              uint8_t            DimensionUpperLimits[8];       ///< gig3: defines the upper limit of the dimension values for this dimension region. In case you wondered why this is defined on DimensionRegion level and not on Region level: the zone sizes (upper limits) of the velocity dimension can indeed differ in the individual dimension regions, depending on which zones of the other dimension types are currently selected. So this is exceptional for the velocity dimension only. All other dimension types have the same dimension zone sizes for every single DimensionRegion (of the sample Region).
430    
431              // derived attributes from DLS::Sampler              // derived attributes from DLS::Sampler
432              DLS::Sampler::UnityNote;              using DLS::Sampler::UnityNote;
433              DLS::Sampler::FineTune;              using DLS::Sampler::FineTune;
434              DLS::Sampler::Gain;              using DLS::Sampler::Gain;
435              DLS::Sampler::SampleLoops;              using DLS::Sampler::SampleLoops;
436              DLS::Sampler::pSampleLoops;              using DLS::Sampler::pSampleLoops;
437    
438              // own methods              // own methods
439              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
440              double GetVelocityRelease(uint8_t MIDIKeyVelocity);              double GetVelocityRelease(uint8_t MIDIKeyVelocity);
441              double GetVelocityCutoff(uint8_t MIDIKeyVelocity);              double GetVelocityCutoff(uint8_t MIDIKeyVelocity);
442                void SetVelocityResponseCurve(curve_type_t curve);
443                void SetVelocityResponseDepth(uint8_t depth);
444                void SetVelocityResponseCurveScaling(uint8_t scaling);
445                void SetReleaseVelocityResponseCurve(curve_type_t curve);
446                void SetReleaseVelocityResponseDepth(uint8_t depth);
447                void SetVCFCutoffController(vcf_cutoff_ctrl_t controller);
448                void SetVCFVelocityCurve(curve_type_t curve);
449                void SetVCFVelocityDynamicRange(uint8_t range);
450                void SetVCFVelocityScale(uint8_t scaling);
451              Region* GetParent() const;              Region* GetParent() const;
452              // derived methods              // derived methods
453              DLS::Sampler::AddSampleLoop;              using DLS::Sampler::AddSampleLoop;
454              DLS::Sampler::DeleteSampleLoop;              using DLS::Sampler::DeleteSampleLoop;
455              // overridden methods              // overridden methods
456                virtual void SetGain(int32_t gain);
457              virtual void UpdateChunks();              virtual void UpdateChunks();
458                virtual void CopyAssign(const DimensionRegion* orig);
459          protected:          protected:
460              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.
461              DimensionRegion(Region* pParent, RIFF::List* _3ewl);              DimensionRegion(Region* pParent, RIFF::List* _3ewl);
462              DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src);              DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src);
463             ~DimensionRegion();             ~DimensionRegion();
464                void CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples);
465              friend class Region;              friend class Region;
466          private:          private:
467              typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller              typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller
468                    // official leverage controllers as they were defined in the original Gigasampler/GigaStudio format:
469                  _lev_ctrl_none              = 0x00,                  _lev_ctrl_none              = 0x00,
470                  _lev_ctrl_modwheel          = 0x03, ///< Modulation Wheel (MIDI Controller 1)                  _lev_ctrl_modwheel          = 0x03, ///< Modulation Wheel (MIDI Controller 1)
471                  _lev_ctrl_breath            = 0x05, ///< Breath Controller (Coarse, MIDI Controller 2)                  _lev_ctrl_breath            = 0x05, ///< Breath Controller (Coarse, MIDI Controller 2)
# Line 509  namespace gig { Line 491  namespace gig {
491                  _lev_ctrl_effect4depth      = 0x2b, ///< Effect 4 Depth (MIDI Controller 94)                  _lev_ctrl_effect4depth      = 0x2b, ///< Effect 4 Depth (MIDI Controller 94)
492                  _lev_ctrl_effect5depth      = 0x2d, ///< Effect 5 Depth (MIDI Controller 95)                  _lev_ctrl_effect5depth      = 0x2d, ///< Effect 5 Depth (MIDI Controller 95)
493                  _lev_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure                  _lev_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure
494                  _lev_ctrl_velocity          = 0xff  ///< Key Velocity                  _lev_ctrl_velocity          = 0xff, ///< Key Velocity
495    
496                    // format extension (these controllers are so far only supported by LinuxSampler & gigedit) they will *NOT* work with Gigasampler/GigaStudio !
497                    // (the assigned values here are their official MIDI CC number plus the highest bit set):
498                    _lev_ctrl_CC3_EXT           = 0x83, ///< MIDI Controller 3 [gig format extension]
499    
500                    _lev_ctrl_CC6_EXT           = 0x86, ///< Data Entry MSB (MIDI Controller 6) [gig format extension]
501                    _lev_ctrl_CC7_EXT           = 0x87, ///< Channel Volume (MIDI Controller 7) [gig format extension]
502                    _lev_ctrl_CC8_EXT           = 0x88, ///< Balance (MIDI Controller 8) [gig format extension]
503                    _lev_ctrl_CC9_EXT           = 0x89, ///< MIDI Controller 9 [gig format extension]
504                    _lev_ctrl_CC10_EXT          = 0x8a, ///< Pan (MIDI Controller 10) [gig format extension]
505                    _lev_ctrl_CC11_EXT          = 0x8b, ///< Expression Controller (MIDI Controller 11) [gig format extension]
506    
507                    _lev_ctrl_CC14_EXT          = 0x8e, ///< MIDI Controller 14 [gig format extension]
508                    _lev_ctrl_CC15_EXT          = 0x8f, ///< MIDI Controller 15 [gig format extension]
509    
510                    _lev_ctrl_CC20_EXT          = 0x94, ///< MIDI Controller 20 [gig format extension]
511                    _lev_ctrl_CC21_EXT          = 0x95, ///< MIDI Controller 21 [gig format extension]
512                    _lev_ctrl_CC22_EXT          = 0x96, ///< MIDI Controller 22 [gig format extension]
513                    _lev_ctrl_CC23_EXT          = 0x97, ///< MIDI Controller 23 [gig format extension]
514                    _lev_ctrl_CC24_EXT          = 0x98, ///< MIDI Controller 24 [gig format extension]
515                    _lev_ctrl_CC25_EXT          = 0x99, ///< MIDI Controller 25 [gig format extension]
516                    _lev_ctrl_CC26_EXT          = 0x9a, ///< MIDI Controller 26 [gig format extension]
517                    _lev_ctrl_CC27_EXT          = 0x9b, ///< MIDI Controller 27 [gig format extension]
518                    _lev_ctrl_CC28_EXT          = 0x9c, ///< MIDI Controller 28 [gig format extension]
519                    _lev_ctrl_CC29_EXT          = 0x9d, ///< MIDI Controller 29 [gig format extension]
520                    _lev_ctrl_CC30_EXT          = 0x9e, ///< MIDI Controller 30 [gig format extension]
521                    _lev_ctrl_CC31_EXT          = 0x9f, ///< MIDI Controller 31 [gig format extension]
522    
523                    _lev_ctrl_CC68_EXT          = 0xc4, ///< Legato Footswitch (MIDI Controller 68) [gig format extension]
524                    _lev_ctrl_CC69_EXT          = 0xc5, ///< Hold 2 (MIDI Controller 69) [gig format extension]
525                    _lev_ctrl_CC70_EXT          = 0xc6, ///< Sound Ctrl. 1 - Sound Variation (MIDI Controller 70) [gig format extension]
526                    _lev_ctrl_CC71_EXT          = 0xc7, ///< Sound Ctrl. 2 - Timbre (MIDI Controller 71) [gig format extension]
527                    _lev_ctrl_CC72_EXT          = 0xc8, ///< Sound Ctrl. 3 - Release Time (MIDI Controller 72) [gig format extension]
528                    _lev_ctrl_CC73_EXT          = 0xc9, ///< Sound Ctrl. 4 - Attack Time (MIDI Controller 73) [gig format extension]
529                    _lev_ctrl_CC74_EXT          = 0xca, ///< Sound Ctrl. 5 - Brightness (MIDI Controller 74) [gig format extension]
530                    _lev_ctrl_CC75_EXT          = 0xcb, ///< Sound Ctrl. 6 - Decay Time (MIDI Controller 75) [gig format extension]
531                    _lev_ctrl_CC76_EXT          = 0xcc, ///< Sound Ctrl. 7 - Vibrato Rate (MIDI Controller 76) [gig format extension]
532                    _lev_ctrl_CC77_EXT          = 0xcd, ///< Sound Ctrl. 8 - Vibrato Depth (MIDI Controller 77) [gig format extension]
533                    _lev_ctrl_CC78_EXT          = 0xce, ///< Sound Ctrl. 9 - Vibrato Delay (MIDI Controller 78) [gig format extension]
534                    _lev_ctrl_CC79_EXT          = 0xcf, ///< Sound Ctrl. 10 (MIDI Controller 79) [gig format extension]
535    
536                    _lev_ctrl_CC84_EXT          = 0xd4, ///< Portamento Control (MIDI Controller 84) [gig format extension]
537                    _lev_ctrl_CC85_EXT          = 0xd5, ///< MIDI Controller 85 [gig format extension]
538                    _lev_ctrl_CC86_EXT          = 0xd6, ///< MIDI Controller 86 [gig format extension]
539                    _lev_ctrl_CC87_EXT          = 0xd7, ///< MIDI Controller 87 [gig format extension]
540    
541                    _lev_ctrl_CC89_EXT          = 0xd9, ///< MIDI Controller 89 [gig format extension]
542                    _lev_ctrl_CC90_EXT          = 0xda, ///< MIDI Controller 90 [gig format extension]
543    
544                    _lev_ctrl_CC96_EXT          = 0xe0, ///< Data Increment (MIDI Controller 96) [gig format extension]
545                    _lev_ctrl_CC97_EXT          = 0xe1, ///< Data Decrement (MIDI Controller 97) [gig format extension]
546    
547                    _lev_ctrl_CC102_EXT         = 0xe6, ///< MIDI Controller 102 [gig format extension]
548                    _lev_ctrl_CC103_EXT         = 0xe7, ///< MIDI Controller 103 [gig format extension]
549                    _lev_ctrl_CC104_EXT         = 0xe8, ///< MIDI Controller 104 [gig format extension]
550                    _lev_ctrl_CC105_EXT         = 0xe9, ///< MIDI Controller 105 [gig format extension]
551                    _lev_ctrl_CC106_EXT         = 0xea, ///< MIDI Controller 106 [gig format extension]
552                    _lev_ctrl_CC107_EXT         = 0xeb, ///< MIDI Controller 107 [gig format extension]
553                    _lev_ctrl_CC108_EXT         = 0xec, ///< MIDI Controller 108 [gig format extension]
554                    _lev_ctrl_CC109_EXT         = 0xed, ///< MIDI Controller 109 [gig format extension]
555                    _lev_ctrl_CC110_EXT         = 0xee, ///< MIDI Controller 110 [gig format extension]
556                    _lev_ctrl_CC111_EXT         = 0xef, ///< MIDI Controller 111 [gig format extension]
557                    _lev_ctrl_CC112_EXT         = 0xf0, ///< MIDI Controller 112 [gig format extension]
558                    _lev_ctrl_CC113_EXT         = 0xf1, ///< MIDI Controller 113 [gig format extension]
559                    _lev_ctrl_CC114_EXT         = 0xf2, ///< MIDI Controller 114 [gig format extension]
560                    _lev_ctrl_CC115_EXT         = 0xf3, ///< MIDI Controller 115 [gig format extension]
561                    _lev_ctrl_CC116_EXT         = 0xf4, ///< MIDI Controller 116 [gig format extension]
562                    _lev_ctrl_CC117_EXT         = 0xf5, ///< MIDI Controller 117 [gig format extension]
563                    _lev_ctrl_CC118_EXT         = 0xf6, ///< MIDI Controller 118 [gig format extension]
564                    _lev_ctrl_CC119_EXT         = 0xf7  ///< MIDI Controller 119 [gig format extension]
565              } _lev_ctrl_t;              } _lev_ctrl_t;
566              typedef std::map<uint32_t, double*> VelocityTableMap;              typedef std::map<uint32_t, double*> VelocityTableMap;
567    
# Line 522  namespace gig { Line 574  namespace gig {
574    
575              leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);              leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
576              _lev_ctrl_t     EncodeLeverageController(leverage_ctrl_t DecodedController);              _lev_ctrl_t     EncodeLeverageController(leverage_ctrl_t DecodedController);
577                double* GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth);
578                double* GetCutoffVelocityTable(curve_type_t vcfVelocityCurve, uint8_t vcfVelocityDynamicRange, uint8_t vcfVelocityScale, vcf_cutoff_ctrl_t vcfCutoffController);
579              double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);              double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
580              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
581      };      };
# Line 575  namespace gig { Line 629  namespace gig {
629              void          ReleaseSampleData();              void          ReleaseSampleData();
630              void          Resize(int iNewSize);              void          Resize(int iNewSize);
631              unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);              unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
632              unsigned long GetPos();              unsigned long GetPos() const;
633              unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);              unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
634              unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer = NULL);              unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer = NULL);
635              unsigned long Write(void* pBuffer, unsigned long SampleCount);              unsigned long Write(void* pBuffer, unsigned long SampleCount);
636              Group*        GetGroup() const;              Group*        GetGroup() const;
637              virtual void  UpdateChunks();              virtual void  UpdateChunks();
638                void CopyAssignMeta(const Sample* orig);
639                void CopyAssignWave(const Sample* orig);
640          protected:          protected:
641              static unsigned int  Instances;               ///< Number of instances of class Sample.              static unsigned int  Instances;               ///< Number of instances of class Sample.
642              static buffer_t      InternalDecompressionBuffer; ///< Buffer used for decompression as well as for truncation of 24 Bit -> 16 Bit samples.              static buffer_t      InternalDecompressionBuffer; ///< Buffer used for decompression as well as for truncation of 24 Bit -> 16 Bit samples.
# Line 595  namespace gig { Line 651  namespace gig {
651              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)
652              RIFF::Chunk*         pCk3gix;              RIFF::Chunk*         pCk3gix;
653              RIFF::Chunk*         pCkSmpl;              RIFF::Chunk*         pCkSmpl;
654              CRC                  crc;                     ///< CRC-32 checksum of the raw sample data              uint32_t             crc;                     ///< CRC-32 checksum of the raw sample data
655    
656              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);
657             ~Sample();             ~Sample();
# Line 629  namespace gig { Line 685  namespace gig {
685      };      };
686    
687      // TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions)      // TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions)
688      /** Defines <i>Region</i> information of an <i>Instrument</i>. */      /** @brief Defines Region information of an Instrument.
689         *
690         * A Region reflects a consecutive area on the keyboard. The individual
691         * regions in the gig format may not overlap with other regions (of the same
692         * instrument). Further, in the gig format a Region is merely a container
693         * for DimensionRegions (a.k.a. "Cases"). The Region itself does not provide
694         * the sample mapping or articulation informations used, even though the
695         * data structures indeed provide such informations. The latter is however
696         * just of historical nature, because the gig format was derived from the
697         * DLS format.
698         *
699         * Each Region consists of at least one or more DimensionRegions. The actual
700         * amount of DimensionRegions depends on which kind of "dimensions" are
701         * defined for this region, and on the split / zone amount for each of those
702         * dimensions.
703         */
704      class Region : public DLS::Region {      class Region : public DLS::Region {
705          public:          public:
706              unsigned int            Dimensions;               ///< Number of defined dimensions, do not alter!              unsigned int            Dimensions;               ///< Number of defined dimensions, do not alter!
# Line 644  namespace gig { Line 715  namespace gig {
715              Sample*          GetSample();              Sample*          GetSample();
716              void             AddDimension(dimension_def_t* pDimDef);              void             AddDimension(dimension_def_t* pDimDef);
717              void             DeleteDimension(dimension_def_t* pDimDef);              void             DeleteDimension(dimension_def_t* pDimDef);
718                dimension_def_t* GetDimensionDefinition(dimension_t type);
719                void             DeleteDimensionZone(dimension_t type, int zone);
720                void             SplitDimensionZone(dimension_t type, int zone);
721              // overridden methods              // overridden methods
722              virtual void     SetKeyRange(uint16_t Low, uint16_t High);              virtual void     SetKeyRange(uint16_t Low, uint16_t High);
723              virtual void     UpdateChunks();              virtual void     UpdateChunks();
724                virtual void     CopyAssign(const Region* orig);
725          protected:          protected:
726              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
727              void LoadDimensionRegions(RIFF::List* rgn);              void LoadDimensionRegions(RIFF::List* rgn);
728              void UpdateVelocityTable();              void UpdateVelocityTable();
729              Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);              Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
730                void CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples);
731                DimensionRegion* GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase);
732             ~Region();             ~Region();
733              friend class Instrument;              friend class Instrument;
734      };      };
735    
736        /** Abstract base class for all MIDI rules. */
737        class MidiRule {
738            public:
739                virtual ~MidiRule() { }
740            protected:
741                virtual void UpdateChunks(uint8_t* pData) const = 0;
742                friend class Instrument;
743        };
744    
745        /** MIDI rule for triggering notes by control change events. */
746        class MidiRuleCtrlTrigger : public MidiRule {
747            public:
748                uint8_t ControllerNumber;   ///< MIDI controller number.
749                uint8_t Triggers;           ///< Number of triggers.
750                struct trigger_t {
751                    uint8_t TriggerPoint;   ///< The CC value to pass for the note to be triggered.
752                    bool    Descending;     ///< If the change in CC value should be downwards.
753                    uint8_t VelSensitivity; ///< How sensitive the velocity should be to the speed of the controller change.
754                    uint8_t Key;            ///< Key to trigger.
755                    bool    NoteOff;        ///< If a note off should be triggered instead of a note on.
756                    uint8_t Velocity;       ///< Velocity of the note to trigger. 255 means that velocity should depend on the speed of the controller change.
757                    bool    OverridePedal;  ///< If a note off should be triggered even if the sustain pedal is down.
758                } pTriggers[32];
759    
760            protected:
761                MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg);
762                MidiRuleCtrlTrigger();
763                void UpdateChunks(uint8_t* pData) const;
764                friend class Instrument;
765        };
766    
767        /** MIDI rule for instruments with legato samples. */
768        class MidiRuleLegato : public MidiRule {
769            public:
770                uint8_t LegatoSamples;     ///< Number of legato samples per key in each direction (always 12)
771                bool BypassUseController;  ///< If a controller should be used to bypass the sustain note
772                uint8_t BypassKey;         ///< Key to be used to bypass the sustain note
773                uint8_t BypassController;  ///< Controller to be used to bypass the sustain note
774                uint16_t ThresholdTime;    ///< Maximum time (ms) between two notes that should be played legato
775                uint16_t ReleaseTime;      ///< Release time
776                range_t KeyRange;          ///< Key range for legato notes
777                uint8_t ReleaseTriggerKey; ///< Key triggering release samples
778                uint8_t AltSustain1Key;    ///< Key triggering alternate sustain samples
779                uint8_t AltSustain2Key;    ///< Key triggering a second set of alternate sustain samples
780    
781            protected:
782                MidiRuleLegato(RIFF::Chunk* _3ewg);
783                MidiRuleLegato();
784                void UpdateChunks(uint8_t* pData) const;
785                friend class Instrument;
786        };
787    
788        /** MIDI rule to automatically cycle through specified sequences of different articulations. The instrument must be using the smartmidi dimension. */
789        class MidiRuleAlternator : public MidiRule {
790            public:
791                uint8_t Articulations;     ///< Number of articulations in the instrument
792                String pArticulations[32]; ///< Names of the articulations
793    
794                range_t PlayRange;         ///< Key range of the playable keys in the instrument
795    
796                uint8_t Patterns;          ///< Number of alternator patterns
797                struct pattern_t {
798                    String Name;           ///< Name of the pattern
799                    int Size;              ///< Number of steps in the pattern
800                    const uint8_t& operator[](int i) const { /// Articulation to play
801                        return data[i];
802                    }
803                    uint8_t& operator[](int i) {
804                        return data[i];
805                    }
806                private:
807                    uint8_t data[32];
808                } pPatterns[32];           ///< A pattern is a sequence of articulation numbers
809    
810                typedef enum {
811                    selector_none,
812                    selector_key_switch,
813                    selector_controller
814                } selector_t;
815                selector_t Selector;       ///< Method by which pattern is chosen
816                range_t KeySwitchRange;    ///< Key range for key switch selector
817                uint8_t Controller;        ///< CC number for controller selector
818    
819                bool Polyphonic;           ///< If alternator should step forward only when all notes are off
820                bool Chained;              ///< If all patterns should be chained together
821    
822            protected:
823                MidiRuleAlternator(RIFF::Chunk* _3ewg);
824                MidiRuleAlternator();
825                void UpdateChunks(uint8_t* pData) const;
826                friend class Instrument;
827        };
828    
829        /** A MIDI rule not yet implemented by libgig. */
830        class MidiRuleUnknown : public MidiRule {
831            protected:
832                MidiRuleUnknown() { }
833                void UpdateChunks(uint8_t* pData) const { }
834                friend class Instrument;
835        };
836    
837      /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */      /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */
838      class Instrument : protected DLS::Instrument {      class Instrument : protected DLS::Instrument {
839          public:          public:
840              // derived attributes from DLS::Resource              // derived attributes from DLS::Resource
841              DLS::Resource::pInfo;              using DLS::Resource::pInfo;
842              DLS::Resource::pDLSID;              using DLS::Resource::pDLSID;
843              // derived attributes from DLS::Instrument              // derived attributes from DLS::Instrument
844              DLS::Instrument::IsDrum;              using DLS::Instrument::IsDrum;
845              DLS::Instrument::MIDIBank;              using DLS::Instrument::MIDIBank;
846              DLS::Instrument::MIDIBankCoarse;              using DLS::Instrument::MIDIBankCoarse;
847              DLS::Instrument::MIDIBankFine;              using DLS::Instrument::MIDIBankFine;
848              DLS::Instrument::MIDIProgram;              using DLS::Instrument::MIDIProgram;
849              DLS::Instrument::Regions;              using DLS::Instrument::Regions;
850              // own attributes              // own attributes
851              int32_t   Attenuation;       ///< in dB              int32_t   Attenuation;       ///< in dB
852              uint16_t  EffectSend;              uint16_t  EffectSend;
# Line 679  namespace gig { Line 857  namespace gig {
857    
858    
859              // derived methods from DLS::Resource              // derived methods from DLS::Resource
860              DLS::Resource::GetParent;              using DLS::Resource::GetParent;
861              // overridden methods              // overridden methods
862              Region*   GetFirstRegion();              Region*   GetFirstRegion();
863              Region*   GetNextRegion();              Region*   GetNextRegion();
864              Region*   AddRegion();              Region*   AddRegion();
865              void      DeleteRegion(Region* pRegion);              void      DeleteRegion(Region* pRegion);
866              virtual void UpdateChunks();              virtual void UpdateChunks();
867                virtual void CopyAssign(const Instrument* orig);
868              // own methods              // own methods
869              Region*   GetRegion(unsigned int Key);              Region*   GetRegion(unsigned int Key);
870                MidiRule* GetMidiRule(int i);
871                MidiRuleCtrlTrigger* AddMidiRuleCtrlTrigger();
872                MidiRuleLegato*      AddMidiRuleLegato();
873                MidiRuleAlternator*  AddMidiRuleAlternator();
874                void      DeleteMidiRule(int i);
875          protected:          protected:
876              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
877    
878              Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);              Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);
879             ~Instrument();             ~Instrument();
880                void CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples);
881              void UpdateRegionKeyTable();              void UpdateRegionKeyTable();
882              friend class File;              friend class File;
883              friend class Region; // so Region can call UpdateRegionKeyTable()              friend class Region; // so Region can call UpdateRegionKeyTable()
884            private:
885                MidiRule** pMidiRules;
886      };      };
887    
888      /** @brief Group of Gigasampler objects      /** @brief Group of Gigasampler objects
# Line 728  namespace gig { Line 915  namespace gig {
915              friend class File;              friend class File;
916          private:          private:
917              File*        pFile;              File*        pFile;
918              RIFF::Chunk* pNameChunk;              RIFF::Chunk* pNameChunk; ///< '3gnm' chunk
919      };      };
920    
921      /** Parses Gigasampler files and provides abstract access to the data. */      /** Parses Gigasampler files and provides abstract access to the data. */
# Line 738  namespace gig { Line 925  namespace gig {
925              static const DLS::version_t VERSION_3;              static const DLS::version_t VERSION_3;
926    
927              // derived attributes from DLS::Resource              // derived attributes from DLS::Resource
928              DLS::Resource::pInfo;              using DLS::Resource::pInfo;
929              DLS::Resource::pDLSID;              using DLS::Resource::pDLSID;
930              // derived attributes from DLS::File              // derived attributes from DLS::File
931              DLS::File::pVersion;              using DLS::File::pVersion;
932              DLS::File::Instruments;              using DLS::File::Instruments;
933    
934              // derived methods from DLS::Resource              // derived methods from DLS::Resource
935              DLS::Resource::GetParent;              using DLS::Resource::GetParent;
936              // derived methods from DLS::File              // derived methods from DLS::File
937              DLS::File::Save;              using DLS::File::Save;
938                using DLS::File::GetFileName;
939                using DLS::File::SetFileName;
940              // overridden  methods              // overridden  methods
941              File();              File();
942              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
943              Sample*     GetFirstSample(progress_t* pProgress = NULL); ///< Returns a pointer to the first <i>Sample</i> object of the file, <i>NULL</i> otherwise.              Sample*     GetFirstSample(progress_t* pProgress = NULL); ///< Returns a pointer to the first <i>Sample</i> object of the file, <i>NULL</i> otherwise.
944              Sample*     GetNextSample();      ///< Returns a pointer to the next <i>Sample</i> object of the file, <i>NULL</i> otherwise.              Sample*     GetNextSample();      ///< Returns a pointer to the next <i>Sample</i> object of the file, <i>NULL</i> otherwise.
945                Sample*     GetSample(uint index);
946              Sample*     AddSample();              Sample*     AddSample();
947              void        DeleteSample(Sample* pSample);              void        DeleteSample(Sample* pSample);
948              Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <i>Instrument</i> object of the file, <i>NULL</i> otherwise.              Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
949              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.
950              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
951              Instrument* AddInstrument();              Instrument* AddInstrument();
952                Instrument* AddDuplicateInstrument(const Instrument* orig);
953              void        DeleteInstrument(Instrument* pInstrument);              void        DeleteInstrument(Instrument* pInstrument);
954              Group*      GetFirstGroup(); ///< Returns a pointer to the first <i>Group</i> object of the file, <i>NULL</i> otherwise.              Group*      GetFirstGroup(); ///< Returns a pointer to the first <i>Group</i> object of the file, <i>NULL</i> otherwise.
955              Group*      GetNextGroup();  ///< Returns a pointer to the next <i>Group</i> object of the file, <i>NULL</i> otherwise.              Group*      GetNextGroup();  ///< Returns a pointer to the next <i>Group</i> object of the file, <i>NULL</i> otherwise.
956              Group*      GetGroup(uint index);              Group*      GetGroup(uint index);
957                Group*      GetGroup(String name);
958              Group*      AddGroup();              Group*      AddGroup();
959              void        DeleteGroup(Group* pGroup);              void        DeleteGroup(Group* pGroup);
960              void        DeleteGroupOnly(Group* pGroup);              void        DeleteGroupOnly(Group* pGroup);
961                void        SetAutoLoad(bool b);
962                bool        GetAutoLoad();
963                void        AddContentOf(File* pFile);
964              virtual    ~File();              virtual    ~File();
965              virtual void UpdateChunks();              virtual void UpdateChunks();
966          protected:          protected:
# Line 781  namespace gig { Line 976  namespace gig {
976              friend class Sample;              friend class Sample;
977              friend class Group; // so Group can access protected member pRIFF              friend class Group; // so Group can access protected member pRIFF
978          private:          private:
             static const DLS::Info::FixedStringLength FixedStringLengths[];  
979              std::list<Group*>*          pGroups;              std::list<Group*>*          pGroups;
980              std::list<Group*>::iterator GroupsIterator;              std::list<Group*>::iterator GroupsIterator;
981                bool                        bAutoLoad;
982      };      };
983    
984      /**      /**
Legend:
Removed from v.1335  
changed lines
  Added in v.2555
  ViewVC Help
Powered by ViewVC