/[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 353 by schoenebeck, Sat Jan 29 14:25:35 2005 UTC revision 2482 by schoenebeck, Mon Nov 25 02:22:38 2013 UTC
# Line 1  Line 1 
1  /***************************************************************************  /***************************************************************************
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file loader library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003, 2004 by Christian Schoenebeck                     *   *   Copyright (C) 2003-2013 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  *
9   *   it under the terms of the GNU General Public License as published by  *   *   it under the terms of the GNU General Public License as published by  *
# Line 26  Line 26 
26    
27  #include "DLS.h"  #include "DLS.h"
28    
 #include <math.h>  
 #include <string.h>  
   
 /// Initial size of the sample buffer which is used for decompression of  
 /// compressed sample wave streams - this value should always be bigger than  
 /// the biggest sample piece expected to be read by the sampler engine,  
 /// otherwise the buffer size will be raised at runtime and thus the buffer  
 /// reallocated which is time consuming and unefficient.  
 #define INITIAL_SAMPLE_BUFFER_SIZE              512000 // 512 kB  
   
29  #if WORDS_BIGENDIAN  #if WORDS_BIGENDIAN
30  # define LIST_TYPE_3PRG 0x33707267  # define LIST_TYPE_3PRG 0x33707267
31  # define LIST_TYPE_3EWL 0x3365776C  # define LIST_TYPE_3EWL 0x3365776C
32  # define CHUNK_ID_SMPL  0x736D706C  # define LIST_TYPE_3GRI 0x33677269
33    # define LIST_TYPE_3GNL 0x33676E6C
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
37  # define CHUNK_ID_3EWG  0x33657767  # define CHUNK_ID_3EWG  0x33657767
38  # define CHUNK_ID_EWAV  0x65776176  # define CHUNK_ID_EWAV  0x65776176
39    # define CHUNK_ID_3GNM  0x33676E6D
40    # define CHUNK_ID_EINF  0x65696E66
41    # define CHUNK_ID_3CRC  0x33637263
42  #else  // little endian  #else  // little endian
43  # define LIST_TYPE_3PRG 0x67727033  # define LIST_TYPE_3PRG 0x67727033
44  # define LIST_TYPE_3EWL 0x6C776533  # define LIST_TYPE_3EWL 0x6C776533
45  # define CHUNK_ID_SMPL  0x6C706D73  # define LIST_TYPE_3GRI 0x69726733
46    # define LIST_TYPE_3GNL 0x6C6E6733
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
50  # define CHUNK_ID_3EWG  0x67776533  # define CHUNK_ID_3EWG  0x67776533
51  # define CHUNK_ID_EWAV  0x76617765  # define CHUNK_ID_EWAV  0x76617765
52    # define CHUNK_ID_3GNM  0x6D6E6733
53    # define CHUNK_ID_EINF  0x666E6965
54    # define CHUNK_ID_3CRC  0x63726333
55  #endif // WORDS_BIGENDIAN  #endif // WORDS_BIGENDIAN
56    
 /** (so far) every exponential paramater in the gig format has a basis of 1.000000008813822 */  
 #define GIG_EXP_DECODE(x)                                       (pow(1.000000008813822, x))  
 #define GIG_PITCH_TRACK_EXTRACT(x)                              (!(x & 0x01))  
 #define GIG_VCF_RESONANCE_CTRL_EXTRACT(x)                       ((x >> 4) & 0x03)  
 #define GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(x)                  ((x >> 1) & 0x03)  
 #define GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(x)                   ((x >> 3) & 0x03)  
 #define GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(x)                 ((x >> 5) & 0x03)  
   
57  /** Gigasampler specific classes and definitions */  /** Gigasampler specific classes and definitions */
58  namespace gig {  namespace gig {
59    
# Line 80  namespace gig { Line 70  namespace gig {
70          void*         pStart;            ///< Points to the beginning of the buffer.          void*         pStart;            ///< Points to the beginning of the buffer.
71          unsigned long Size;              ///< Size of the actual data in the buffer in bytes.          unsigned long Size;              ///< Size of the actual data in the buffer in bytes.
72          unsigned long NullExtensionSize; ///< The buffer might be bigger than the actual data, if that's the case that unused space at the end of the buffer is filled with NULLs and NullExtensionSize reflects that unused buffer space in bytes. Those NULL extensions are mandatory for differential algorithms that have to take the following data words into account, thus have to access past the buffer's boundary. If you don't know what I'm talking about, just forget this variable. :)          unsigned long NullExtensionSize; ///< The buffer might be bigger than the actual data, if that's the case that unused space at the end of the buffer is filled with NULLs and NullExtensionSize reflects that unused buffer space in bytes. Those NULL extensions are mandatory for differential algorithms that have to take the following data words into account, thus have to access past the buffer's boundary. If you don't know what I'm talking about, just forget this variable. :)
73            buffer_t() {
74                pStart            = NULL;
75                Size              = 0;
76                NullExtensionSize = 0;
77            }
78      };      };
79    
80      /** Standard types of sample loops. */      /** Standard types of sample loops. */
# Line 143  namespace gig { Line 138  namespace gig {
138      /** Defines how the filter cutoff frequency is controlled by. */      /** Defines how the filter cutoff frequency is controlled by. */
139      typedef enum {      typedef enum {
140          vcf_cutoff_ctrl_none         = 0x00,          vcf_cutoff_ctrl_none         = 0x00,
141            vcf_cutoff_ctrl_none2        = 0x01,  ///< The difference between none and none2 is unknown
142          vcf_cutoff_ctrl_modwheel     = 0x81,  ///< Modulation Wheel (MIDI Controller 1)          vcf_cutoff_ctrl_modwheel     = 0x81,  ///< Modulation Wheel (MIDI Controller 1)
143          vcf_cutoff_ctrl_effect1      = 0x8c,  ///< Effect Controller 1 (Coarse, MIDI Controller 12)          vcf_cutoff_ctrl_effect1      = 0x8c,  ///< Effect Controller 1 (Coarse, MIDI Controller 12)
144          vcf_cutoff_ctrl_effect2      = 0x8d,  ///< Effect Controller 2 (Coarse, MIDI Controller 13)          vcf_cutoff_ctrl_effect2      = 0x8d,  ///< Effect Controller 2 (Coarse, MIDI Controller 13)
# Line 216  namespace gig { Line 212  namespace gig {
212          dimension_none              = 0x00, ///< Dimension not in use.          dimension_none              = 0x00, ///< Dimension not in use.
213          dimension_samplechannel     = 0x80, ///< If used sample has more than one channel (thus is not mono).          dimension_samplechannel     = 0x80, ///< If used sample has more than one channel (thus is not mono).
214          dimension_layer             = 0x81, ///< For layering of up to 8 instruments (and eventually crossfading of 2 or 4 layers).          dimension_layer             = 0x81, ///< For layering of up to 8 instruments (and eventually crossfading of 2 or 4 layers).
215          dimension_velocity          = 0x82, ///< Key Velocity (this is the only dimension where the ranges can exactly be defined).          dimension_velocity          = 0x82, ///< Key Velocity (this is the only dimension in gig2 where the ranges can exactly be defined).
216          dimension_channelaftertouch = 0x83, ///< Channel Key Pressure          dimension_channelaftertouch = 0x83, ///< Channel Key Pressure
217          dimension_releasetrigger    = 0x84, ///< Special dimension for triggering samples on releasing a key.          dimension_releasetrigger    = 0x84, ///< Special dimension for triggering samples on releasing a key.
218          dimension_keyboard          = 0x85, ///< Dimension for keyswitching          dimension_keyboard          = 0x85, ///< Dimension for keyswitching
219            dimension_roundrobin        = 0x86, ///< Different samples triggered each time a note is played, dimension regions selected in sequence
220            dimension_random            = 0x87, ///< Different samples triggered each time a note is played, random order
221            dimension_smartmidi         = 0x88, ///< For MIDI tools like legato and repetition mode
222            dimension_roundrobinkeyboard = 0x89, ///< Different samples triggered each time a note is played, any key advances the counter
223          dimension_modwheel          = 0x01, ///< Modulation Wheel (MIDI Controller 1)          dimension_modwheel          = 0x01, ///< Modulation Wheel (MIDI Controller 1)
224          dimension_breath            = 0x02, ///< Breath Controller (Coarse, MIDI Controller 2)          dimension_breath            = 0x02, ///< Breath Controller (Coarse, MIDI Controller 2)
225          dimension_foot              = 0x04, ///< Foot Pedal (Coarse, MIDI Controller 4)          dimension_foot              = 0x04, ///< Foot Pedal (Coarse, MIDI Controller 4)
# Line 250  namespace gig { Line 250  namespace gig {
250       * into the corresponding dimension bit number.       * into the corresponding dimension bit number.
251       */       */
252      typedef enum {      typedef enum {
253          split_type_normal,         ///< dimension value between 0-127, no custom range of zones          split_type_normal,         ///< dimension value between 0-127
         split_type_customvelocity, ///< a velocity dimension split with custom range definition for each zone (if a velocity dimension split has no custom defined zone ranges then it's also just of type split_type_normal)  
254          split_type_bit             ///< dimension values are already the sought bit number          split_type_bit             ///< dimension values are already the sought bit number
255      } split_type_t;      } split_type_t;
256    
# Line 261  namespace gig { Line 260  namespace gig {
260          uint8_t      bits;       ///< Number of "bits" (1 bit = 2 splits/zones, 2 bit = 4 splits/zones, 3 bit = 8 splits/zones,...).          uint8_t      bits;       ///< Number of "bits" (1 bit = 2 splits/zones, 2 bit = 4 splits/zones, 3 bit = 8 splits/zones,...).
261          uint8_t      zones;      ///< Number of zones the dimension has.          uint8_t      zones;      ///< Number of zones the dimension has.
262          split_type_t split_type; ///< Intended for internal usage: will be used to convert a dimension value into the corresponding dimension bit number.          split_type_t split_type; ///< Intended for internal usage: will be used to convert a dimension value into the corresponding dimension bit number.
263          range_t*     ranges;     ///< Intended for internal usage: Points to the beginning of a range_t array which reflects the value ranges of each dimension zone (only if custom defined ranges are defined, is NULL otherwise).          float        zone_size;  ///< Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only, 0 otherwise.
         unsigned int zone_size;  ///< Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only, 0 otherwise.  
264      };      };
265    
266      /** Defines which frequencies are filtered by the VCF. */      /** Defines which frequencies are filtered by the VCF. */
# Line 302  namespace gig { Line 300  namespace gig {
300          unsigned long loop_cycles_left;  ///< How many times the loop has still to be passed, this value will be decremented with each loop cycle.          unsigned long loop_cycles_left;  ///< How many times the loop has still to be passed, this value will be decremented with each loop cycle.
301      };      };
302    
303        /**
304         * @brief Used for indicating the progress of a certain task.
305         *
306         * The function pointer argument has to be supplied with a valid
307         * function of the given signature which will then be called on
308         * progress changes. An equivalent progress_t structure will be passed
309         * back as argument to the callback function on each progress change.
310         * The factor field of the supplied progress_t structure will then
311         * reflect the current progress as value between 0.0 and 1.0. You might
312         * want to use the custom field for data needed in your callback
313         * function.
314         */
315        struct progress_t {
316            void (*callback)(progress_t*); ///< Callback function pointer which has to be assigned to a function for progress notification.
317            float factor;                  ///< Reflects current progress as value between 0.0 and 1.0.
318            void* custom;                  ///< This pointer can be used for arbitrary data.
319            float __range_min;             ///< Only for internal usage, do not modify!
320            float __range_max;             ///< Only for internal usage, do not modify!
321            progress_t();
322        };
323    
324      // just symbol prototyping      // just symbol prototyping
325      class File;      class File;
326      class Instrument;      class Instrument;
327      class Sample;      class Sample;
328      class Region;      class Region;
329        class Group;
330    
331      /** Encapsulates articulation information of a dimension region.      /** @brief Encapsulates articulation information of a dimension region.
332       *       *
333       *  Every Gigasampler Instrument has at least one dimension region       *  Every Gigasampler Instrument has at least one dimension region
334       *  (exactly then when it has no dimension defined).       *  (exactly then when it has no dimension defined).
# Line 322  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).              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.
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 374  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
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).              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 404  namespace gig { Line 425  namespace gig {
425              bool               SustainDefeat;                 ///< If <i>true</i>: Sustain pedal will not hold a note.              bool               SustainDefeat;                 ///< If <i>true</i>: Sustain pedal will not hold a note.
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)
429                uint8_t            DimensionUpperLimits[8];       ///< gig3: defines the upper limit of the dimension values for this dimension 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              // Methods              // own methods
439              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
440                double GetVelocityRelease(uint8_t MIDIKeyVelocity);
441                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;
452                // derived methods
453                using DLS::Sampler::AddSampleLoop;
454                using DLS::Sampler::DeleteSampleLoop;
455                // overridden methods
456                virtual void SetGain(int32_t gain);
457                virtual void UpdateChunks();
458                virtual void CopyAssign(const DimensionRegion* orig);
459          protected:          protected:
460              DimensionRegion(RIFF::List* _3ewl);              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);
462                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
# Line 451  namespace gig { Line 497  namespace gig {
497              static uint              Instances;                  ///< Number of DimensionRegion instances.              static uint              Instances;                  ///< Number of DimensionRegion instances.
498              static VelocityTableMap* pVelocityTables;            ///< Contains the tables corresponding to the various velocity parameters (VelocityResponseCurve and VelocityResponseDepth).              static VelocityTableMap* pVelocityTables;            ///< Contains the tables corresponding to the various velocity parameters (VelocityResponseCurve and VelocityResponseDepth).
499              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.
500                double*                  pVelocityReleaseTable;      ///< Points to the velocity table corresponding to the release velocity parameters of this DimensionRegion
501                double*                  pVelocityCutoffTable;       ///< Points to the velocity table corresponding to the filter velocity parameters of this DimensionRegion
502                Region*                  pRegion;
503    
504              leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);              leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
505                _lev_ctrl_t     EncodeLeverageController(leverage_ctrl_t DecodedController);
506                double* GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth);
507                double* GetCutoffVelocityTable(curve_type_t vcfVelocityCurve, uint8_t vcfVelocityDynamicRange, uint8_t vcfVelocityScale, vcf_cutoff_ctrl_t vcfCutoffController);
508                double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
509              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
510      };      };
511    
512      /** Encapsulates sample waves used for playback. */      /** @brief Encapsulates sample waves used for playback.
513         *
514         * In case you created a new sample with File::AddSample(), you should
515         * first update all attributes with the desired meta informations
516         * (amount of channels, bit depth, sample rate, etc.), then call
517         * Resize() with the desired sample size, followed by File::Save(), this
518         * will create the mandatory RIFF chunk which will hold the sample wave
519         * data and / or resize the file so you will be able to Write() the
520         * sample data directly to disk.
521         *
522         * @e Caution: for gig synthesis, most looping relevant information are
523         * retrieved from the respective DimensionRegon instead from the Sample
524         * itself. This was made for allowing different loop definitions for the
525         * same sample under different conditions.
526         */
527      class Sample : public DLS::Sample {      class Sample : public DLS::Sample {
528          public:          public:
             uint16_t       SampleGroup;  
529              uint32_t       Manufacturer;      ///< Specifies the MIDI Manufacturer's Association (MMA) Manufacturer code for the sampler intended to receive this file's waveform. If no particular manufacturer is to be specified, a value of 0 should be used.              uint32_t       Manufacturer;      ///< Specifies the MIDI Manufacturer's Association (MMA) Manufacturer code for the sampler intended to receive this file's waveform. If no particular manufacturer is to be specified, a value of 0 should be used.
530              uint32_t       Product;           ///< Specifies the MIDI model ID defined by the manufacturer corresponding to the Manufacturer field. If no particular manufacturer's product is to be specified, a value of 0 should be used.              uint32_t       Product;           ///< Specifies the MIDI model ID defined by the manufacturer corresponding to the Manufacturer field. If no particular manufacturer's product is to be specified, a value of 0 should be used.
531              uint32_t       SamplePeriod;      ///< Specifies the duration of time that passes during the playback of one sample in nanoseconds (normally equal to 1 / Samplers Per Second, where Samples Per Second is the value found in the format chunk).              uint32_t       SamplePeriod;      ///< Specifies the duration of time that passes during the playback of one sample in nanoseconds (normally equal to 1 / Samples Per Second, where Samples Per Second is the value found in the format chunk), don't bother to update this attribute, it won't be saved.
532              uint32_t       MIDIUnityNote;     ///< Specifies the musical note at which the sample will be played at it's original sample rate.              uint32_t       MIDIUnityNote;     ///< Specifies the musical note at which the sample will be played at it's original sample rate.
533              uint32_t       FineTune;          ///< Specifies the fraction of a semitone up from the specified MIDI unity note field. A value of 0x80000000 means 1/2 semitone (50 cents) and a value of 0x00000000 means no fine tuning between semitones.              uint32_t       FineTune;          ///< Specifies the fraction of a semitone up from the specified MIDI unity note field. A value of 0x80000000 means 1/2 semitone (50 cents) and a value of 0x00000000 means no fine tuning between semitones.
534              smpte_format_t SMPTEFormat;       ///< Specifies the Society of Motion Pictures and Television E time format used in the following <i>SMPTEOffset</i> field. If a value of 0 is set, <i>SMPTEOffset</i> should also be set to 0.              smpte_format_t SMPTEFormat;       ///< Specifies the Society of Motion Pictures and Television E time format used in the following <i>SMPTEOffset</i> field. If a value of 0 is set, <i>SMPTEOffset</i> should also be set to 0.
535              uint32_t       SMPTEOffset;       ///< The SMPTE Offset value specifies the time offset to be used for the synchronization / calibration to the first sample in the waveform. This value uses a format of 0xhhmmssff where hh is a signed value that specifies the number of hours (-23 to 23), mm is an unsigned value that specifies the number of minutes (0 to 59), ss is an unsigned value that specifies the number of seconds (0 to 59) and ff is an unsigned value that specifies the number of frames (0 to -1).              uint32_t       SMPTEOffset;       ///< The SMPTE Offset value specifies the time offset to be used for the synchronization / calibration to the first sample in the waveform. This value uses a format of 0xhhmmssff where hh is a signed value that specifies the number of hours (-23 to 23), mm is an unsigned value that specifies the number of minutes (0 to 59), ss is an unsigned value that specifies the number of seconds (0 to 59) and ff is an unsigned value that specifies the number of frames (0 to -1).
536              uint32_t       Loops;             ///< Number of defined sample loops (so far only seen single loops in gig files - please report me if you encounter more!).              uint32_t       Loops;             ///< @e Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: Number of defined sample loops. So far only seen single loops in gig files - please report if you encounter more!)
537              uint32_t       LoopID;            ///< Specifies the unique ID that corresponds to one of the defined cue points in the cue point list (only if Loops > 0), as the Gigasampler format only allows one loop definition at the moment, this attribute isn't really useful for anything.              uint32_t       LoopID;            ///< Specifies the unique ID that corresponds to one of the defined cue points in the cue point list (only if Loops > 0), as the Gigasampler format only allows one loop definition at the moment, this attribute isn't really useful for anything.
538              loop_type_t    LoopType;          ///< The type field defines how the waveform samples will be looped (only if Loops > 0).              loop_type_t    LoopType;          ///< @e Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The type field defines how the waveform samples will be looped.)
539              uint32_t       LoopStart;         ///< The start value specifies the offset (in sample points) in the waveform data of the first sample to be played in the loop (only if Loops > 0).              uint32_t       LoopStart;         ///< @e Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The start value specifies the offset [in sample points] in the waveform data of the first sample to be played in the loop [only if Loops > 0].)
540              uint32_t       LoopEnd;           ///< The end value specifies the offset (in sample points) in the waveform data which represents the end of the loop (only if Loops > 0).              uint32_t       LoopEnd;           ///< @e Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The end value specifies the offset [in sample points] in the waveform data which represents the end of the loop [only if Loops > 0].)
541              uint32_t       LoopSize;          ///< Length of the looping area (in sample points) which is equivalent to <i>LoopEnd - LoopStart</i>.              uint32_t       LoopSize;          ///< @e Caution: Use the respective fields in the DimensionRegion instead of this one! (Intended purpose: Length of the looping area [in sample points] which is equivalent to @code LoopEnd - LoopStart @endcode.)
542              uint32_t       LoopFraction;      ///< The fractional value specifies a fraction of a sample at which to loop (only if Loops > 0). This allows a loop to be fine tuned at a resolution greater than one sample. A value of 0 means no fraction, a value of 0x80000000 means 1/2 of a sample length. 0xFFFFFFFF is the smallest fraction of a sample that can be represented.              uint32_t       LoopFraction;      ///< The fractional value specifies a fraction of a sample at which to loop. This allows a loop to be fine tuned at a resolution greater than one sample. A value of 0 means no fraction, a value of 0x80000000 means 1/2 of a sample length. 0xFFFFFFFF is the smallest fraction of a sample that can be represented.
543              uint32_t       LoopPlayCount;     ///< Number of times the loop should be played (only if Loops > 0, a value of 0 = infinite).              uint32_t       LoopPlayCount;     ///< Number of times the loop should be played (a value of 0 = infinite).
544              bool           Compressed;        ///< If the sample wave is compressed (probably just interesting for instrument and sample editors, as this library already handles the decompression in it's sample access methods anyway).              bool           Compressed;        ///< If the sample wave is compressed (probably just interesting for instrument and sample editors, as this library already handles the decompression in it's sample access methods anyway).
545                uint32_t       TruncatedBits;     ///< For 24-bit compressed samples only: number of bits truncated during compression (0, 4 or 6)
546                bool           Dithered;          ///< For 24-bit compressed samples only: if dithering was used during compression with bit reduction
547    
548              // own methods              // own methods
549              buffer_t      LoadSampleData();              buffer_t      LoadSampleData();
# Line 483  namespace gig { Line 551  namespace gig {
551              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
552              buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);
553              buffer_t      GetCache();              buffer_t      GetCache();
554                // own static methods
555                static buffer_t CreateDecompressionBuffer(unsigned long MaxReadSize);
556                static void     DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);
557              // overridden methods              // overridden methods
558              void          ReleaseSampleData();              void          ReleaseSampleData();
559                void          Resize(int iNewSize);
560              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);
561              unsigned long GetPos();              unsigned long GetPos() const;
562              unsigned long Read(void* pBuffer, unsigned long SampleCount);              unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
563              unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState);              unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer = NULL);
564                unsigned long Write(void* pBuffer, unsigned long SampleCount);
565                Group*        GetGroup() const;
566                virtual void  UpdateChunks();
567                void CopyAssignMeta(const Sample* orig);
568                void CopyAssignWave(const Sample* orig);
569          protected:          protected:
570              static unsigned int  Instances;               ///< Number of instances of class Sample.              static unsigned int  Instances;               ///< Number of instances of class Sample.
571              static unsigned long DecompressionBufferSize; ///< Current size of the decompression buffer.              static buffer_t      InternalDecompressionBuffer; ///< Buffer used for decompression as well as for truncation of 24 Bit -> 16 Bit samples.
572              static void*         pDecompressionBuffer;    ///< Small buffer used for decompression only.              Group*               pGroup;                  ///< pointer to the Group this sample belongs to (always not-NULL)
573              unsigned long        FrameOffset;             ///< Current offset (sample points) in current sample frame (for decompression only).              unsigned long        FrameOffset;             ///< Current offset (sample points) in current sample frame (for decompression only).
574              unsigned long*       FrameTable;              ///< For positioning within compressed samples only: stores the offset values for each frame.              unsigned long*       FrameTable;              ///< For positioning within compressed samples only: stores the offset values for each frame.
575              unsigned long        SamplePos;               ///< For compressed samples only: stores the current position (in sample points).              unsigned long        SamplePos;               ///< For compressed samples only: stores the current position (in sample points).
576                unsigned long        SamplesInLastFrame;      ///< For compressed samples only: length of the last sample frame.
577                unsigned long        WorstCaseFrameSize;      ///< For compressed samples only: size (in bytes) of the largest possible sample frame.
578                unsigned long        SamplesPerFrame;         ///< For compressed samples only: number of samples in a full sample frame.
579              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.
580                unsigned long        FileNo;                  ///< File number (> 0 when sample is stored in an extension file, 0 when it's in the gig)
581                RIFF::Chunk*         pCk3gix;
582                RIFF::Chunk*         pCkSmpl;
583                uint32_t             crc;                     ///< CRC-32 checksum of the raw sample data
584    
585              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo = 0);
586             ~Sample();             ~Sample();
587              /**  
588               * Swaps the order of the data words in the given memory area              // Guess size (in bytes) of a compressed sample
589               * with a granularity given by \a WordSize.              inline unsigned long GuessSize(unsigned long samples) {
590               *                  // 16 bit: assume all frames are compressed - 1 byte
591               * @param pData    - pointer to the memory area to be swapped                  // per sample and 5 bytes header per 2048 samples
592               * @param AreaSize - size of the memory area to be swapped (in bytes)  
593               * @param WordSize - size of the data words (in bytes)                  // 24 bit: assume next best compression rate - 1.5
594               */                  // bytes per sample and 13 bytes header per 256
595              inline void SwapMemoryArea(void* pData, unsigned long AreaSize, uint WordSize) {                  // samples
596                  switch (WordSize) { // TODO: unefficient                  const unsigned long size =
597                      case 1: {                      BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
598                          uint8_t* pDst = (uint8_t*) pData;                                     : samples + (samples >> 10) * 5;
599                          uint8_t  cache;                  // Double for stereo and add one worst case sample
600                          unsigned long lo = 0, hi = AreaSize - 1;                  // frame
601                          for (; lo < hi; hi--, lo++) {                  return (Channels == 2 ? size << 1 : size) + WorstCaseFrameSize;
                             cache    = pDst[lo];  
                             pDst[lo] = pDst[hi];  
                             pDst[hi] = cache;  
                         }  
                         break;  
                     }  
                     case 2: {  
                         uint16_t* pDst = (uint16_t*) pData;  
                         uint16_t  cache;  
                         unsigned long lo = 0, hi = (AreaSize >> 1) - 1;  
                         for (; lo < hi; hi--, lo++) {  
                             cache    = pDst[lo];  
                             pDst[lo] = pDst[hi];  
                             pDst[hi] = cache;  
                         }  
                         break;  
                     }  
                     case 4: {  
                         uint32_t* pDst = (uint32_t*) pData;  
                         uint32_t  cache;  
                         unsigned long lo = 0, hi = (AreaSize >> 2) - 1;  
                         for (; lo < hi; hi--, lo++) {  
                             cache    = pDst[lo];  
                             pDst[lo] = pDst[hi];  
                             pDst[hi] = cache;  
                         }  
                         break;  
                     }  
                     default: {  
                         uint8_t* pCache = new uint8_t[WordSize]; // TODO: unefficient  
                         unsigned long lo = 0, hi = AreaSize - WordSize;  
                         for (; lo < hi; hi -= WordSize, lo += WordSize) {  
                             memcpy(pCache, (uint8_t*) pData + lo, WordSize);  
                             memcpy((uint8_t*) pData + lo, (uint8_t*) pData + hi, WordSize);  
                             memcpy((uint8_t*) pData + hi, pCache, WordSize);  
                         }  
                         delete[] pCache;  
                         break;  
                     }  
                 }  
602              }              }
603              inline long Min(long A, long B) {  
604                  return (A > B) ? B : A;              // Worst case amount of sample points that can be read with the
605                // given decompression buffer.
606                inline unsigned long WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
607                    return (unsigned long) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
608              }              }
             inline long Abs(long val) { return (val > 0) ? val : -val; }  
609          private:          private:
610              void ScanCompressedSample();              void ScanCompressedSample();
611              friend class File;              friend class File;
612              friend class Region;              friend class Region;
613                friend class Group; // allow to modify protected member pGroup
614      };      };
615    
616      // 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)
617      /** Defines <i>Region</i> information of an <i>Instrument</i>. */      /** Defines <i>Region</i> information of an <i>Instrument</i>. */
618      class Region : public DLS::Region {      class Region : public DLS::Region {
619          public:          public:
620              unsigned int            Dimensions;               ///< Number of defined dimensions.              unsigned int            Dimensions;               ///< Number of defined dimensions, do not alter!
621              dimension_def_t         pDimensionDefinitions[8]; ///< Defines the five (gig2) or eight (gig3) possible dimensions (the dimension's controller and number of bits/splits).              dimension_def_t         pDimensionDefinitions[8]; ///< Defines the five (gig2) or eight (gig3) possible dimensions (the dimension's controller and number of bits/splits). Use AddDimension() and DeleteDimension() to create a new dimension or delete an existing one.
622              uint32_t                DimensionRegions;         ///< Total number of DimensionRegions this Region contains.              uint32_t                DimensionRegions;         ///< Total number of DimensionRegions this Region contains, do not alter!
623              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).              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).
624              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.              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!
625    
626                // own methods
627              DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);              DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);
628              DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);              DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);
629              Sample*          GetSample();              Sample*          GetSample();
630                void             AddDimension(dimension_def_t* pDimDef);
631                void             DeleteDimension(dimension_def_t* pDimDef);
632                // overridden methods
633                virtual void     SetKeyRange(uint16_t Low, uint16_t High);
634                virtual void     UpdateChunks();
635                virtual void     CopyAssign(const Region* orig);
636          protected:          protected:
             uint8_t VelocityTable[128]; ///< For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity MIDI value to dimension bit number.  
   
637              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
638              void LoadDimensionRegions(RIFF::List* rgn);              void LoadDimensionRegions(RIFF::List* rgn);
639              Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex);              void UpdateVelocityTable();
640                Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
641                void CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples);
642             ~Region();             ~Region();
643              friend class Instrument;              friend class Instrument;
644      };      };
645    
646        /** Abstract base class for all MIDI rules. */
647        class MidiRule {
648            public:
649                virtual ~MidiRule() { }
650            protected:
651                virtual void UpdateChunks(uint8_t* pData) const = 0;
652                friend class Instrument;
653        };
654    
655        /** MIDI rule for triggering notes by control change events. */
656        class MidiRuleCtrlTrigger : public MidiRule {
657            public:
658                uint8_t ControllerNumber;   ///< MIDI controller number.
659                uint8_t Triggers;           ///< Number of triggers.
660                struct trigger_t {
661                    uint8_t TriggerPoint;   ///< The CC value to pass for the note to be triggered.
662                    bool    Descending;     ///< If the change in CC value should be downwards.
663                    uint8_t VelSensitivity; ///< How sensitive the velocity should be to the speed of the controller change.
664                    uint8_t Key;            ///< Key to trigger.
665                    bool    NoteOff;        ///< If a note off should be triggered instead of a note on.
666                    uint8_t Velocity;       ///< Velocity of the note to trigger. 255 means that velocity should depend on the speed of the controller change.
667                    bool    OverridePedal;  ///< If a note off should be triggered even if the sustain pedal is down.
668                } pTriggers[32];
669    
670            protected:
671                MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg);
672                MidiRuleCtrlTrigger();
673                void UpdateChunks(uint8_t* pData) const;
674                friend class Instrument;
675        };
676    
677        /** MIDI rule for instruments with legato samples. */
678        class MidiRuleLegato : public MidiRule {
679            public:
680                uint8_t LegatoSamples;     ///< Number of legato samples per key in each direction (always 12)
681                bool BypassUseController;  ///< If a controller should be used to bypass the sustain note
682                uint8_t BypassKey;         ///< Key to be used to bypass the sustain note
683                uint8_t BypassController;  ///< Controller to be used to bypass the sustain note
684                uint16_t ThresholdTime;    ///< Maximum time (ms) between two notes that should be played legato
685                uint16_t ReleaseTime;      ///< Release time
686                range_t KeyRange;          ///< Key range for legato notes
687                uint8_t ReleaseTriggerKey; ///< Key triggering release samples
688                uint8_t AltSustain1Key;    ///< Key triggering alternate sustain samples
689                uint8_t AltSustain2Key;    ///< Key triggering a second set of alternate sustain samples
690    
691            protected:
692                MidiRuleLegato(RIFF::Chunk* _3ewg);
693                MidiRuleLegato();
694                void UpdateChunks(uint8_t* pData) const;
695                friend class Instrument;
696        };
697    
698        /** MIDI rule to automatically cycle through specified sequences of different articulations. The instrument must be using the smartmidi dimension. */
699        class MidiRuleAlternator : public MidiRule {
700            public:
701                uint8_t Articulations;     ///< Number of articulations in the instrument
702                String pArticulations[32]; ///< Names of the articulations
703    
704                range_t PlayRange;         ///< Key range of the playable keys in the instrument
705    
706                uint8_t Patterns;          ///< Number of alternator patterns
707                struct pattern_t {
708                    String Name;           ///< Name of the pattern
709                    int Size;              ///< Number of steps in the pattern
710                    const uint8_t& operator[](int i) const { /// Articulation to play
711                        return data[i];
712                    }
713                    uint8_t& operator[](int i) {
714                        return data[i];
715                    }
716                private:
717                    uint8_t data[32];
718                } pPatterns[32];           ///< A pattern is a sequence of articulation numbers
719    
720                typedef enum {
721                    selector_none,
722                    selector_key_switch,
723                    selector_controller
724                } selector_t;
725                selector_t Selector;       ///< Method by which pattern is chosen
726                range_t KeySwitchRange;    ///< Key range for key switch selector
727                uint8_t Controller;        ///< CC number for controller selector
728    
729                bool Polyphonic;           ///< If alternator should step forward only when all notes are off
730                bool Chained;              ///< If all patterns should be chained together
731    
732            protected:
733                MidiRuleAlternator(RIFF::Chunk* _3ewg);
734                MidiRuleAlternator();
735                void UpdateChunks(uint8_t* pData) const;
736                friend class Instrument;
737        };
738    
739        /** A MIDI rule not yet implemented by libgig. */
740        class MidiRuleUnknown : public MidiRule {
741            protected:
742                MidiRuleUnknown() { }
743                void UpdateChunks(uint8_t* pData) const { }
744                friend class Instrument;
745        };
746    
747      /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */      /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */
748      class Instrument : protected DLS::Instrument {      class Instrument : protected DLS::Instrument {
749          public:          public:
750              // derived attributes from DLS::Resource              // derived attributes from DLS::Resource
751              DLS::Resource::pInfo;              using DLS::Resource::pInfo;
752              DLS::Resource::pDLSID;              using DLS::Resource::pDLSID;
753              // derived attributes from DLS::Instrument              // derived attributes from DLS::Instrument
754              DLS::Instrument::IsDrum;              using DLS::Instrument::IsDrum;
755              DLS::Instrument::MIDIBank;              using DLS::Instrument::MIDIBank;
756              DLS::Instrument::MIDIBankCoarse;              using DLS::Instrument::MIDIBankCoarse;
757              DLS::Instrument::MIDIBankFine;              using DLS::Instrument::MIDIBankFine;
758              DLS::Instrument::MIDIProgram;              using DLS::Instrument::MIDIProgram;
759              DLS::Instrument::Regions;              using DLS::Instrument::Regions;
760              // own attributes              // own attributes
761              int32_t   Attenuation;       ///< in dB              int32_t   Attenuation;       ///< in dB
762              uint16_t  EffectSend;              uint16_t  EffectSend;
# Line 612  namespace gig { Line 767  namespace gig {
767    
768    
769              // derived methods from DLS::Resource              // derived methods from DLS::Resource
770              DLS::Resource::GetParent;              using DLS::Resource::GetParent;
771              // overridden methods              // overridden methods
772              Region*   GetFirstRegion();              Region*   GetFirstRegion();
773              Region*   GetNextRegion();              Region*   GetNextRegion();
774                Region*   AddRegion();
775                void      DeleteRegion(Region* pRegion);
776                virtual void UpdateChunks();
777                virtual void CopyAssign(const Instrument* orig);
778              // own methods              // own methods
779              Region*   GetRegion(unsigned int Key);              Region*   GetRegion(unsigned int Key);
780                MidiRule* GetMidiRule(int i);
781                MidiRuleCtrlTrigger* AddMidiRuleCtrlTrigger();
782                MidiRuleLegato*      AddMidiRuleLegato();
783                MidiRuleAlternator*  AddMidiRuleAlternator();
784                void      DeleteMidiRule(int i);
785          protected:          protected:
             Region**  pRegions;            ///< Pointer array to the regions  
786              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
             int       RegionIndex;  
787    
788              Instrument(File* pFile, RIFF::List* insList);              Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);
789             ~Instrument();             ~Instrument();
790                void CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples);
791                void UpdateRegionKeyTable();
792              friend class File;              friend class File;
793                friend class Region; // so Region can call UpdateRegionKeyTable()
794            private:
795                MidiRule** pMidiRules;
796        };
797    
798        /** @brief Group of Gigasampler objects
799         *
800         * Groups help to organize a huge collection of Gigasampler objects.
801         * Groups are not concerned at all for the synthesis, but they help
802         * sound library developers when working on complex instruments with an
803         * instrument editor (as long as that instrument editor supports it ;-).
804         *
805         * At the moment, it seems as only samples can be grouped together in
806         * the Gigasampler format yet. If this is false in the meantime, please
807         * tell us !
808         *
809         * A sample is always assigned to exactly one Group. This also means
810         * there is always at least one Group in a .gig file, no matter if you
811         * created one yet or not.
812         */
813        class Group {
814            public:
815                String Name; ///< Stores the name of this Group.
816    
817                Sample* GetFirstSample();
818                Sample* GetNextSample();
819                void AddSample(Sample* pSample);
820            protected:
821                Group(File* file, RIFF::Chunk* ck3gnm);
822                virtual ~Group();
823                virtual void UpdateChunks();
824                void MoveAll();
825                friend class File;
826            private:
827                File*        pFile;
828                RIFF::Chunk* pNameChunk; ///< '3gnm' chunk
829      };      };
830    
     // TODO: <3gnm> chunk not added yet (just contains the names of the sample groups)  
831      /** Parses Gigasampler files and provides abstract access to the data. */      /** Parses Gigasampler files and provides abstract access to the data. */
832      class File : protected DLS::File {      class File : protected DLS::File {
833          public:          public:
834                static const DLS::version_t VERSION_2;
835                static const DLS::version_t VERSION_3;
836    
837              // derived attributes from DLS::Resource              // derived attributes from DLS::Resource
838              DLS::Resource::pInfo;              using DLS::Resource::pInfo;
839              DLS::Resource::pDLSID;              using DLS::Resource::pDLSID;
840              // derived attributes from DLS::File              // derived attributes from DLS::File
841              DLS::File::pVersion;              using DLS::File::pVersion;
842              DLS::File::Instruments;              using DLS::File::Instruments;
843    
844              // derived methods from DLS::Resource              // derived methods from DLS::Resource
845              DLS::Resource::GetParent;              using DLS::Resource::GetParent;
846                // derived methods from DLS::File
847                using DLS::File::Save;
848                using DLS::File::GetFileName;
849                using DLS::File::SetFileName;
850              // overridden  methods              // overridden  methods
851                File();
852              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
853              Sample*     GetFirstSample();     ///< 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.
854              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.
855                Sample*     GetSample(uint index);
856                Sample*     AddSample();
857                void        DeleteSample(Sample* pSample);
858              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.
859              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.
860              Instrument* GetInstrument(uint index);              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
861             ~File();              Instrument* AddInstrument();
862                Instrument* AddDuplicateInstrument(const Instrument* orig);
863                void        DeleteInstrument(Instrument* pInstrument);
864                Group*      GetFirstGroup(); ///< Returns a pointer to the first <i>Group</i> object of the file, <i>NULL</i> otherwise.
865                Group*      GetNextGroup();  ///< Returns a pointer to the next <i>Group</i> object of the file, <i>NULL</i> otherwise.
866                Group*      GetGroup(uint index);
867                Group*      AddGroup();
868                void        DeleteGroup(Group* pGroup);
869                void        DeleteGroupOnly(Group* pGroup);
870                void        SetAutoLoad(bool b);
871                bool        GetAutoLoad();
872                void        AddContentOf(File* pFile);
873                virtual    ~File();
874                virtual void UpdateChunks();
875          protected:          protected:
876              typedef std::list<Sample*>     SampleList;              // overridden protected methods from DLS::File
877              typedef std::list<Instrument*> InstrumentList;              virtual void LoadSamples();
878                virtual void LoadInstruments();
879              SampleList*              pSamples;              virtual void LoadGroups();
880              SampleList::iterator     SamplesIterator;              // own protected methods
881              InstrumentList*          pInstruments;              virtual void LoadSamples(progress_t* pProgress);
882              InstrumentList::iterator InstrumentsIterator;              virtual void LoadInstruments(progress_t* pProgress);
883                void SetSampleChecksum(Sample* pSample, uint32_t crc);
             void LoadSamples();  
             void LoadInstruments();  
884              friend class Region;              friend class Region;
885                friend class Sample;
886                friend class Group; // so Group can access protected member pRIFF
887            private:
888                std::list<Group*>*          pGroups;
889                std::list<Group*>::iterator GroupsIterator;
890                bool                        bAutoLoad;
891      };      };
892    
893      /** Will be thrown whenever a gig specific error occurs while trying to access a Gigasampler File. */      /**
894         * Will be thrown whenever a gig specific error occurs while trying to
895         * access a Gigasampler File. Note: In your application you should
896         * better catch for RIFF::Exception rather than this one, except you
897         * explicitly want to catch and handle gig::Exception, DLS::Exception
898         * and RIFF::Exception independently, which usually shouldn't be
899         * necessary though.
900         */
901      class Exception : public DLS::Exception {      class Exception : public DLS::Exception {
902          public:          public:
903              Exception(String Message);              Exception(String Message);
904              void PrintMessage();              void PrintMessage();
905      };      };
906    
907        String libraryName();
908        String libraryVersion();
909    
910  } // namespace gig  } // namespace gig
911    
912  #endif // __GIG_H__  #endif // __GIG_H__
Legend:
Removed from v.353  
changed lines
  Added in v.2482
  ViewVC Help
Powered by ViewVC