/[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 308 by schoenebeck, Sun Nov 21 18:02:21 2004 UTC revision 809 by schoenebeck, Tue Nov 22 11:26:55 2005 UTC
# Line 2  Line 2 
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file loader library    *   *   libgig - C++ cross-platform Gigasampler format file loader library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003, 2004 by Christian Schoenebeck                     *   *   Copyright (C) 2003-2005 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
# Line 56  Line 46 
46  # define CHUNK_ID_EWAV  0x76617765  # define CHUNK_ID_EWAV  0x76617765
47  #endif // WORDS_BIGENDIAN  #endif // WORDS_BIGENDIAN
48    
 /** (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)  
   
49  /** Gigasampler specific classes and definitions */  /** Gigasampler specific classes and definitions */
50  namespace gig {  namespace gig {
51    
# Line 80  namespace gig { Line 62  namespace gig {
62          void*         pStart;            ///< Points to the beginning of the buffer.          void*         pStart;            ///< Points to the beginning of the buffer.
63          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.
64          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. :)
65            buffer_t() {
66                pStart            = NULL;
67                Size              = 0;
68                NullExtensionSize = 0;
69            }
70      };      };
71    
72      /** Standard types of sample loops. */      /** Standard types of sample loops. */
# Line 143  namespace gig { Line 130  namespace gig {
130      /** Defines how the filter cutoff frequency is controlled by. */      /** Defines how the filter cutoff frequency is controlled by. */
131      typedef enum {      typedef enum {
132          vcf_cutoff_ctrl_none         = 0x00,          vcf_cutoff_ctrl_none         = 0x00,
133            vcf_cutoff_ctrl_none2        = 0x01,  ///< The difference betwheen none and none2 is unknown
134          vcf_cutoff_ctrl_modwheel     = 0x81,  ///< Modulation Wheel (MIDI Controller 1)          vcf_cutoff_ctrl_modwheel     = 0x81,  ///< Modulation Wheel (MIDI Controller 1)
135          vcf_cutoff_ctrl_effect1      = 0x8c,  ///< Effect Controller 1 (Coarse, MIDI Controller 12)          vcf_cutoff_ctrl_effect1      = 0x8c,  ///< Effect Controller 1 (Coarse, MIDI Controller 12)
136          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 219  namespace gig { Line 207  namespace gig {
207          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 where the ranges can exactly be defined).
208          dimension_channelaftertouch = 0x83, ///< Channel Key Pressure          dimension_channelaftertouch = 0x83, ///< Channel Key Pressure
209          dimension_releasetrigger    = 0x84, ///< Special dimension for triggering samples on releasing a key.          dimension_releasetrigger    = 0x84, ///< Special dimension for triggering samples on releasing a key.
210          dimension_keyboard          = 0x85, ///< Key Position          dimension_keyboard          = 0x85, ///< Dimension for keyswitching
211            dimension_roundrobin        = 0x86, ///< Different samples triggered each time a note is played, dimension regions selected in sequence
212            dimension_random            = 0x87, ///< Different samples triggered each time a note is played, random order
213          dimension_modwheel          = 0x01, ///< Modulation Wheel (MIDI Controller 1)          dimension_modwheel          = 0x01, ///< Modulation Wheel (MIDI Controller 1)
214          dimension_breath            = 0x02, ///< Breath Controller (Coarse, MIDI Controller 2)          dimension_breath            = 0x02, ///< Breath Controller (Coarse, MIDI Controller 2)
215          dimension_foot              = 0x04, ///< Foot Pedal (Coarse, MIDI Controller 4)          dimension_foot              = 0x04, ///< Foot Pedal (Coarse, MIDI Controller 4)
# Line 262  namespace gig { Line 252  namespace gig {
252          uint8_t      zones;      ///< Number of zones the dimension has.          uint8_t      zones;      ///< Number of zones the dimension has.
253          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.
254          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).          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).
255          unsigned int zone_size;  ///< Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only, 0 otherwise.          float        zone_size;  ///< Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only, 0 otherwise.
256    
257            dimension_def_t& operator=(const dimension_def_t& arg);
258      };      };
259    
260      /** Defines which frequencies are filtered by the VCF. */      /** Defines which frequencies are filtered by the VCF. */
# Line 274  namespace gig { Line 266  namespace gig {
266          vcf_type_bandreject   = 0x03          vcf_type_bandreject   = 0x03
267      } vcf_type_t;      } vcf_type_t;
268    
269      /** Defines the envelope of a crossfade. */      /**
270         * Defines the envelope of a crossfade.
271         *
272         * Note: The default value for crossfade points is 0,0,0,0. Layers with
273         * such a default value should be treated as if they would not have a
274         * crossfade.
275         */
276      struct crossfade_t {      struct crossfade_t {
277          #if WORDS_BIGENDIAN          #if WORDS_BIGENDIAN
         uint8_t in_start;   ///< Start position of fade in.  
         uint8_t in_end;     ///< End position of fade in.  
         uint8_t out_start;  ///< Start position of fade out.  
         uint8_t out_end;    ///< End postition of fade out.  
         #else // little endian  
278          uint8_t out_end;    ///< End postition of fade out.          uint8_t out_end;    ///< End postition of fade out.
279          uint8_t out_start;  ///< Start position of fade out.          uint8_t out_start;  ///< Start position of fade out.
280          uint8_t in_end;     ///< End position of fade in.          uint8_t in_end;     ///< End position of fade in.
281          uint8_t in_start;   ///< Start position of fade in.          uint8_t in_start;   ///< Start position of fade in.
282            #else // little endian
283            uint8_t in_start;   ///< Start position of fade in.
284            uint8_t in_end;     ///< End position of fade in.
285            uint8_t out_start;  ///< Start position of fade out.
286            uint8_t out_end;    ///< End postition of fade out.
287          #endif // WORDS_BIGENDIAN          #endif // WORDS_BIGENDIAN
288      };      };
289    
# Line 296  namespace gig { Line 294  namespace gig {
294          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.
295      };      };
296    
297        /**
298         * @brief Used for indicating the progress of a certain task.
299         *
300         * The function pointer argument has to be supplied with a valid
301         * function of the given signature which will then be called on
302         * progress changes. An equivalent progress_t structure will be passed
303         * back as argument to the callback function on each progress change.
304         * The factor field of the supplied progress_t structure will then
305         * reflect the current progress as value between 0.0 and 1.0. You might
306         * want to use the custom field for data needed in your callback
307         * function.
308         */
309        struct progress_t {
310            void (*callback)(progress_t*); ///< Callback function pointer which has to be assigned to a function for progress notification.
311            float factor;                  ///< Reflects current progress as value between 0.0 and 1.0.
312            void* custom;                  ///< This pointer can be used for arbitrary data.
313            float __range_min;             ///< Only for internal usage, do not modify!
314            float __range_max;             ///< Only for internal usage, do not modify!
315            progress_t();
316        };
317    
318      // just symbol prototyping      // just symbol prototyping
319      class File;      class File;
320      class Instrument;      class Instrument;
321      class Sample;      class Sample;
322        class Region;
323    
324      /** Encapsulates articulation information of a dimension region.      /** Encapsulates articulation information of a dimension region.
325       *       *
# Line 368  namespace gig { Line 388  namespace gig {
388              bool               VCFEnabled;                    ///< If filter should be used.              bool               VCFEnabled;                    ///< If filter should be used.
389              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.).
390              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.
391                bool               VCFCutoffControllerInvert;     ///< Inverts values coming from the defined cutoff controller
392              uint8_t            VCFCutoff;                     ///< Max. cutoff frequency.              uint8_t            VCFCutoff;                     ///< Max. cutoff frequency.
393              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.
394              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).
395              uint8_t            VCFVelocityDynamicRange;       ///< 0x04 = lowest, 0x00 = highest              uint8_t            VCFVelocityDynamicRange;       ///< 0x04 = lowest, 0x00 = highest
396              uint8_t            VCFResonance;                  ///< Firm internal filter resonance weight.              uint8_t            VCFResonance;                  ///< Firm internal filter resonance weight.
397              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).
# Line 397  namespace gig { Line 418  namespace gig {
418              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.
419              bool               MSDecode;                      ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.              bool               MSDecode;                      ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.
420              uint16_t           SampleStartOffset;             ///< Number of samples the sample start should be moved (0 - 2000).              uint16_t           SampleStartOffset;             ///< Number of samples the sample start should be moved (0 - 2000).
421                double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)
422    
423              // derived attributes from DLS::Sampler              // derived attributes from DLS::Sampler
424              DLS::Sampler::UnityNote;              DLS::Sampler::UnityNote;
425              DLS::Sampler::FineTune;              DLS::Sampler::FineTune;
# Line 404  namespace gig { Line 427  namespace gig {
427              DLS::Sampler::SampleLoops;              DLS::Sampler::SampleLoops;
428              DLS::Sampler::pSampleLoops;              DLS::Sampler::pSampleLoops;
429    
430              // Methods              // own methods
431              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
432                double GetVelocityRelease(uint8_t MIDIKeyVelocity);
433                double GetVelocityCutoff(uint8_t MIDIKeyVelocity);
434                // overridden methods
435                virtual void UpdateChunks();
436          protected:          protected:
437              DimensionRegion(RIFF::List* _3ewl);              DimensionRegion(RIFF::List* _3ewl);
438             ~DimensionRegion();             ~DimensionRegion();
# Line 444  namespace gig { Line 471  namespace gig {
471              static uint              Instances;                  ///< Number of DimensionRegion instances.              static uint              Instances;                  ///< Number of DimensionRegion instances.
472              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).
473              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.
474                double*                  pVelocityReleaseTable;      ///< Points to the velocity table corresponding to the release velocity parameters of this DimensionRegion
475                double*                  pVelocityCutoffTable;       ///< Points to the velocity table corresponding to the filter velocity parameters of this DimensionRegion
476    
477              leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);              leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
478                _lev_ctrl_t     EncodeLeverageController(leverage_ctrl_t DecodedController);
479                double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
480              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
481      };      };
482    
483      /** Encapsulates sample waves used for playback. */      /** @brief Encapsulates sample waves used for playback.
484         *
485         * In case you created a new sample with File::AddSample(), you should
486         * first update all attributes with the desired meta informations
487         * (amount of channels, bit depth, sample rate, etc.), then call
488         * Resize() with the desired sample size, followed by File::Save(), this
489         * will create the mandatory RIFF chunk which will hold the sample wave
490         * data and / or resize the file so you will be able to Write() the
491         * sample data directly to disk.
492         */
493      class Sample : public DLS::Sample {      class Sample : public DLS::Sample {
494          public:          public:
495              uint16_t       SampleGroup;              uint16_t       SampleGroup;
496              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.
497              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.
498              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.
499              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.
500              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.
501              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.
# Line 469  namespace gig { Line 509  namespace gig {
509              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 (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.
510              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 (only if Loops > 0, a value of 0 = infinite).
511              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).
512                uint32_t       TruncatedBits;     ///< For 24-bit compressed samples only: number of bits truncated during compression (0, 4 or 6)
513                bool           Dithered;          ///< For 24-bit compressed samples only: if dithering was used during compression with bit reduction
514    
515              // own methods              // own methods
516              buffer_t      LoadSampleData();              buffer_t      LoadSampleData();
# Line 476  namespace gig { Line 518  namespace gig {
518              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
519              buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);
520              buffer_t      GetCache();              buffer_t      GetCache();
521                // own static methods
522                static buffer_t CreateDecompressionBuffer(unsigned long MaxReadSize);
523                static void     DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);
524              // overridden methods              // overridden methods
525              void          ReleaseSampleData();              void          ReleaseSampleData();
526                void          Resize(int iNewSize);
527              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);
528              unsigned long GetPos();              unsigned long GetPos();
529              unsigned long Read(void* pBuffer, unsigned long SampleCount);              unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
530              unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState);              unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, buffer_t* pExternalDecompressionBuffer = NULL);
531                unsigned long Write(void* pBuffer, unsigned long SampleCount);
532                virtual void  UpdateChunks();
533          protected:          protected:
534              static unsigned int  Instances;               ///< Number of instances of class Sample.              static unsigned int  Instances;               ///< Number of instances of class Sample.
535              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.
             static void*         pDecompressionBuffer;    ///< Small buffer used for decompression only.  
536              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).
537              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.
538              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).
539                unsigned long        SamplesInLastFrame;      ///< For compressed samples only: length of the last sample frame.
540                unsigned long        WorstCaseFrameSize;      ///< For compressed samples only: size (in bytes) of the largest possible sample frame.
541                unsigned long        SamplesPerFrame;         ///< For compressed samples only: number of samples in a full sample frame.
542              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.
543                unsigned long        FileNo;                  ///< File number (> 0 when sample is stored in an extension file, 0 when it's in the gig)
544                RIFF::Chunk*         pCk3gix;
545                RIFF::Chunk*         pCkSmpl;
546    
547              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo = 0);
548             ~Sample();             ~Sample();
549              /**  
550               * Swaps the order of the data words in the given memory area              // Guess size (in bytes) of a compressed sample
551               * with a granularity given by \a WordSize.              inline unsigned long GuessSize(unsigned long samples) {
552               *                  // 16 bit: assume all frames are compressed - 1 byte
553               * @param pData    - pointer to the memory area to be swapped                  // per sample and 5 bytes header per 2048 samples
554               * @param AreaSize - size of the memory area to be swapped (in bytes)  
555               * @param WordSize - size of the data words (in bytes)                  // 24 bit: assume next best compression rate - 1.5
556               */                  // bytes per sample and 13 bytes header per 256
557              inline void SwapMemoryArea(void* pData, unsigned long AreaSize, uint WordSize) {                  // samples
558                  switch (WordSize) { // TODO: unefficient                  const unsigned long size =
559                      case 1: {                      BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
560                          uint8_t* pDst = (uint8_t*) pData;                                     : samples + (samples >> 10) * 5;
561                          uint8_t  cache;                  // Double for stereo and add one worst case sample
562                          unsigned long lo = 0, hi = AreaSize - 1;                  // frame
563                          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;  
                     }  
                 }  
564              }              }
565              inline long Min(long A, long B) {  
566                  return (A > B) ? B : A;              // Worst case amount of sample points that can be read with the
567                // given decompression buffer.
568                inline unsigned long WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
569                    return (unsigned long) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
570              }              }
             inline long Abs(long val) { return (val > 0) ? val : -val; }  
571          private:          private:
572              void ScanCompressedSample();              void ScanCompressedSample();
573              friend class File;              friend class File;
# Line 563  namespace gig { Line 578  namespace gig {
578      /** Defines <i>Region</i> information of an <i>Instrument</i>. */      /** Defines <i>Region</i> information of an <i>Instrument</i>. */
579      class Region : public DLS::Region {      class Region : public DLS::Region {
580          public:          public:
581              unsigned int            Dimensions;               ///< Number of defined dimensions.              unsigned int            Dimensions;               ///< Number of defined dimensions, do not alter!
582              dimension_def_t         pDimensionDefinitions[5]; ///< Defines the five 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 ot delete an existing one.
583              uint32_t                DimensionRegions;         ///< Total number of DimensionRegions this Region contains.              uint32_t                DimensionRegions;         ///< Total number of DimensionRegions this Region contains, do not alter!
584              DimensionRegion*        pDimensionRegions[32];    ///< Pointer array to the 32 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 ot delete an existing one (which will create or delete the respective dimension region(s) automatically).
585              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!
586    
587              DimensionRegion* GetDimensionRegionByValue(uint Dim4Val, uint Dim3Val, uint Dim2Val, uint Dim1Val, uint Dim0Val);              DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);
588              DimensionRegion* GetDimensionRegionByBit(uint8_t Dim4Bit, uint8_t Dim3Bit, uint8_t Dim2Bit, uint8_t Dim1Bit, uint8_t Dim0Bit);              DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);
589              Sample*          GetSample();              Sample*          GetSample();
590                void             AddDimension(dimension_def_t* pDimDef);
591                void             DeleteDimension(dimension_def_t* pDimDef);
592                virtual void     UpdateChunks();
593          protected:          protected:
594                typedef std::list<dimension_def_t*> DimensionList;
595    
596              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.              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.
597                DimensionList DimensionDefinitions;
598    
599              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
600              void LoadDimensionRegions(RIFF::List* rgn);              void LoadDimensionRegions(RIFF::List* rgn);
601              Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex);              void UpdateVelocityTable(dimension_def_t* pDimDef);
602                Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
603             ~Region();             ~Region();
604              friend class Instrument;              friend class Instrument;
605      };      };
# Line 609  namespace gig { Line 631  namespace gig {
631              // overridden methods              // overridden methods
632              Region*   GetFirstRegion();              Region*   GetFirstRegion();
633              Region*   GetNextRegion();              Region*   GetNextRegion();
634                Region*   AddRegion();
635                void      DeleteRegion(Region* pRegion);
636                virtual void UpdateChunks();
637              // own methods              // own methods
638              Region*   GetRegion(unsigned int Key);              Region*   GetRegion(unsigned int Key);
639          protected:          protected:
# Line 616  namespace gig { Line 641  namespace gig {
641              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
642              int       RegionIndex;              int       RegionIndex;
643    
644              Instrument(File* pFile, RIFF::List* insList);              Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);
645             ~Instrument();             ~Instrument();
646                void UpdateRegionKeyTable();
647              friend class File;              friend class File;
648      };      };
649    
# Line 634  namespace gig { Line 660  namespace gig {
660    
661              // derived methods from DLS::Resource              // derived methods from DLS::Resource
662              DLS::Resource::GetParent;              DLS::Resource::GetParent;
663                // derived methods from DLS::File
664                DLS::File::Save;
665              // overridden  methods              // overridden  methods
666                File();
667              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
668              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.
669              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.
670              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.
671                Sample*     AddSample();
672                void        DeleteSample(Sample* pSample);
673              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.
674              Instrument* GetInstrument(uint index);              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
675             ~File() {};              Instrument* AddInstrument();
676                void        DeleteInstrument(Instrument* pInstrument);
677               ~File();
678          protected:          protected:
679              typedef std::list<Sample*>     SampleList;              typedef std::list<Sample*>     SampleList;
680              typedef std::list<Instrument*> InstrumentList;              typedef std::list<Instrument*> InstrumentList;
# Line 651  namespace gig { Line 684  namespace gig {
684              InstrumentList*          pInstruments;              InstrumentList*          pInstruments;
685              InstrumentList::iterator InstrumentsIterator;              InstrumentList::iterator InstrumentsIterator;
686    
687              void LoadSamples();              void LoadSamples(progress_t* pProgress = NULL);
688              void LoadInstruments();              void LoadInstruments(progress_t* pProgress = NULL);
689              friend class Region;              friend class Region;
690    
691                std::list<RIFF::File*> ExtensionFiles;
692      };      };
693    
694      /** Will be thrown whenever a gig specific error occurs while trying to access a Gigasampler File. */      /** Will be thrown whenever a gig specific error occurs while trying to access a Gigasampler File. */
# Line 663  namespace gig { Line 698  namespace gig {
698              void PrintMessage();              void PrintMessage();
699      };      };
700    
701        String libraryName();
702        String libraryVersion();
703    
704  } // namespace gig  } // namespace gig
705    
706  #endif // __GIG_H__  #endif // __GIG_H__

Legend:
Removed from v.308  
changed lines
  Added in v.809

  ViewVC Help
Powered by ViewVC