/[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 926 by schoenebeck, Tue Oct 24 14:29:16 2006 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-2006 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 between 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 220  namespace gig { Line 208  namespace gig {
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, ///< Dimension for keyswitching          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 250  namespace gig { Line 240  namespace gig {
240       * into the corresponding dimension bit number.       * into the corresponding dimension bit number.
241       */       */
242      typedef enum {      typedef enum {
243          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)  
244          split_type_bit             ///< dimension values are already the sought bit number          split_type_bit             ///< dimension values are already the sought bit number
245      } split_type_t;      } split_type_t;
246    
# Line 261  namespace gig { Line 250  namespace gig {
250          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,...).
251          uint8_t      zones;      ///< Number of zones the dimension has.          uint8_t      zones;      ///< Number of zones the dimension has.
252          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.
253          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.  
254      };      };
255    
256      /** Defines which frequencies are filtered by the VCF. */      /** Defines which frequencies are filtered by the VCF. */
# Line 302  namespace gig { Line 290  namespace gig {
290          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.
291      };      };
292    
293        /**
294         * @brief Used for indicating the progress of a certain task.
295         *
296         * The function pointer argument has to be supplied with a valid
297         * function of the given signature which will then be called on
298         * progress changes. An equivalent progress_t structure will be passed
299         * back as argument to the callback function on each progress change.
300         * The factor field of the supplied progress_t structure will then
301         * reflect the current progress as value between 0.0 and 1.0. You might
302         * want to use the custom field for data needed in your callback
303         * function.
304         */
305        struct progress_t {
306            void (*callback)(progress_t*); ///< Callback function pointer which has to be assigned to a function for progress notification.
307            float factor;                  ///< Reflects current progress as value between 0.0 and 1.0.
308            void* custom;                  ///< This pointer can be used for arbitrary data.
309            float __range_min;             ///< Only for internal usage, do not modify!
310            float __range_max;             ///< Only for internal usage, do not modify!
311            progress_t();
312        };
313    
314      // just symbol prototyping      // just symbol prototyping
315      class File;      class File;
316      class Instrument;      class Instrument;
# Line 375  namespace gig { Line 384  namespace gig {
384              bool               VCFEnabled;                    ///< If filter should be used.              bool               VCFEnabled;                    ///< If filter should be used.
385              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.).
386              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.
387                bool               VCFCutoffControllerInvert;     ///< Inverts values coming from the defined cutoff controller
388              uint8_t            VCFCutoff;                     ///< Max. cutoff frequency.              uint8_t            VCFCutoff;                     ///< Max. cutoff frequency.
389              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.
390              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).
391              uint8_t            VCFVelocityDynamicRange;       ///< 0x04 = lowest, 0x00 = highest              uint8_t            VCFVelocityDynamicRange;       ///< 0x04 = lowest, 0x00 = highest
392              uint8_t            VCFResonance;                  ///< Firm internal filter resonance weight.              uint8_t            VCFResonance;                  ///< Firm internal filter resonance weight.
393              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 404  namespace gig { Line 414  namespace gig {
414              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.
415              bool               MSDecode;                      ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.              bool               MSDecode;                      ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.
416              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).
417                double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)
418    
419              // derived attributes from DLS::Sampler              // derived attributes from DLS::Sampler
420              DLS::Sampler::UnityNote;              DLS::Sampler::UnityNote;
421              DLS::Sampler::FineTune;              DLS::Sampler::FineTune;
# Line 411  namespace gig { Line 423  namespace gig {
423              DLS::Sampler::SampleLoops;              DLS::Sampler::SampleLoops;
424              DLS::Sampler::pSampleLoops;              DLS::Sampler::pSampleLoops;
425    
426              // Methods              // own methods
427              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
428                double GetVelocityRelease(uint8_t MIDIKeyVelocity);
429                double GetVelocityCutoff(uint8_t MIDIKeyVelocity);
430                // overridden methods
431                virtual void UpdateChunks();
432          protected:          protected:
433                uint8_t* VelocityTable; ///< For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity MIDI value to dimension bit number.
434              DimensionRegion(RIFF::List* _3ewl);              DimensionRegion(RIFF::List* _3ewl);
435             ~DimensionRegion();             ~DimensionRegion();
436              friend class Region;              friend class Region;
# Line 451  namespace gig { Line 468  namespace gig {
468              static uint              Instances;                  ///< Number of DimensionRegion instances.              static uint              Instances;                  ///< Number of DimensionRegion instances.
469              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).
470              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.
471                double*                  pVelocityReleaseTable;      ///< Points to the velocity table corresponding to the release velocity parameters of this DimensionRegion
472                double*                  pVelocityCutoffTable;       ///< Points to the velocity table corresponding to the filter velocity parameters of this DimensionRegion
473    
474              leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);              leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
475                _lev_ctrl_t     EncodeLeverageController(leverage_ctrl_t DecodedController);
476                double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
477              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
478      };      };
479    
480      /** Encapsulates sample waves used for playback. */      /** @brief Encapsulates sample waves used for playback.
481         *
482         * In case you created a new sample with File::AddSample(), you should
483         * first update all attributes with the desired meta informations
484         * (amount of channels, bit depth, sample rate, etc.), then call
485         * Resize() with the desired sample size, followed by File::Save(), this
486         * will create the mandatory RIFF chunk which will hold the sample wave
487         * data and / or resize the file so you will be able to Write() the
488         * sample data directly to disk.
489         */
490      class Sample : public DLS::Sample {      class Sample : public DLS::Sample {
491          public:          public:
492              uint16_t       SampleGroup;              uint16_t       SampleGroup;
493              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.
494              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.
495              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.
496              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.
497              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.
498              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 476  namespace gig { Line 506  namespace gig {
506              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.
507              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).
508              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).
509                uint32_t       TruncatedBits;     ///< For 24-bit compressed samples only: number of bits truncated during compression (0, 4 or 6)
510                bool           Dithered;          ///< For 24-bit compressed samples only: if dithering was used during compression with bit reduction
511    
512              // own methods              // own methods
513              buffer_t      LoadSampleData();              buffer_t      LoadSampleData();
# Line 483  namespace gig { Line 515  namespace gig {
515              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
516              buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);
517              buffer_t      GetCache();              buffer_t      GetCache();
518                // own static methods
519                static buffer_t CreateDecompressionBuffer(unsigned long MaxReadSize);
520                static void     DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);
521              // overridden methods              // overridden methods
522              void          ReleaseSampleData();              void          ReleaseSampleData();
523                void          Resize(int iNewSize);
524              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);
525              unsigned long GetPos();              unsigned long GetPos();
526              unsigned long Read(void* pBuffer, unsigned long SampleCount);              unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
527              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);
528                unsigned long Write(void* pBuffer, unsigned long SampleCount);
529                virtual void  UpdateChunks();
530          protected:          protected:
531              static unsigned int  Instances;               ///< Number of instances of class Sample.              static unsigned int  Instances;               ///< Number of instances of class Sample.
532              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.  
533              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).
534              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.
535              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).
536                unsigned long        SamplesInLastFrame;      ///< For compressed samples only: length of the last sample frame.
537                unsigned long        WorstCaseFrameSize;      ///< For compressed samples only: size (in bytes) of the largest possible sample frame.
538                unsigned long        SamplesPerFrame;         ///< For compressed samples only: number of samples in a full sample frame.
539              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.
540                unsigned long        FileNo;                  ///< File number (> 0 when sample is stored in an extension file, 0 when it's in the gig)
541                RIFF::Chunk*         pCk3gix;
542                RIFF::Chunk*         pCkSmpl;
543    
544              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo = 0);
545             ~Sample();             ~Sample();
546              /**  
547               * Swaps the order of the data words in the given memory area              // Guess size (in bytes) of a compressed sample
548               * with a granularity given by \a WordSize.              inline unsigned long GuessSize(unsigned long samples) {
549               *                  // 16 bit: assume all frames are compressed - 1 byte
550               * @param pData    - pointer to the memory area to be swapped                  // per sample and 5 bytes header per 2048 samples
551               * @param AreaSize - size of the memory area to be swapped (in bytes)  
552               * @param WordSize - size of the data words (in bytes)                  // 24 bit: assume next best compression rate - 1.5
553               */                  // bytes per sample and 13 bytes header per 256
554              inline void SwapMemoryArea(void* pData, unsigned long AreaSize, uint WordSize) {                  // samples
555                  switch (WordSize) { // TODO: unefficient                  const unsigned long size =
556                      case 1: {                      BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
557                          uint8_t* pDst = (uint8_t*) pData;                                     : samples + (samples >> 10) * 5;
558                          uint8_t  cache;                  // Double for stereo and add one worst case sample
559                          unsigned long lo = 0, hi = AreaSize - 1;                  // frame
560                          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;  
                     }  
                 }  
561              }              }
562              inline long Min(long A, long B) {  
563                  return (A > B) ? B : A;              // Worst case amount of sample points that can be read with the
564                // given decompression buffer.
565                inline unsigned long WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
566                    return (unsigned long) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
567              }              }
             inline long Abs(long val) { return (val > 0) ? val : -val; }  
568          private:          private:
569              void ScanCompressedSample();              void ScanCompressedSample();
570              friend class File;              friend class File;
# Line 570  namespace gig { Line 575  namespace gig {
575      /** Defines <i>Region</i> information of an <i>Instrument</i>. */      /** Defines <i>Region</i> information of an <i>Instrument</i>. */
576      class Region : public DLS::Region {      class Region : public DLS::Region {
577          public:          public:
578              unsigned int            Dimensions;               ///< Number of defined dimensions.              unsigned int            Dimensions;               ///< Number of defined dimensions, do not alter!
579              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.
580              uint32_t                DimensionRegions;         ///< Total number of DimensionRegions this Region contains.              uint32_t                DimensionRegions;         ///< Total number of DimensionRegions this Region contains, do not alter!
581              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).
582              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!
583    
584              DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);              DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);
585              DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);              DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);
586              Sample*          GetSample();              Sample*          GetSample();
587                void             AddDimension(dimension_def_t* pDimDef);
588                void             DeleteDimension(dimension_def_t* pDimDef);
589                virtual void     UpdateChunks();
590          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.  
   
591              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
592              void LoadDimensionRegions(RIFF::List* rgn);              void LoadDimensionRegions(RIFF::List* rgn);
593              Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex);              void UpdateVelocityTable();
594                Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
595             ~Region();             ~Region();
596              friend class Instrument;              friend class Instrument;
597      };      };
# Line 616  namespace gig { Line 623  namespace gig {
623              // overridden methods              // overridden methods
624              Region*   GetFirstRegion();              Region*   GetFirstRegion();
625              Region*   GetNextRegion();              Region*   GetNextRegion();
626                Region*   AddRegion();
627                void      DeleteRegion(Region* pRegion);
628                virtual void UpdateChunks();
629              // own methods              // own methods
630              Region*   GetRegion(unsigned int Key);              Region*   GetRegion(unsigned int Key);
631          protected:          protected:
             Region**  pRegions;            ///< Pointer array to the regions  
632              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;  
633    
634              Instrument(File* pFile, RIFF::List* insList);              Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);
635             ~Instrument();             ~Instrument();
636                void UpdateRegionKeyTable();
637              friend class File;              friend class File;
638      };      };
639    
# Line 641  namespace gig { Line 650  namespace gig {
650    
651              // derived methods from DLS::Resource              // derived methods from DLS::Resource
652              DLS::Resource::GetParent;              DLS::Resource::GetParent;
653                // derived methods from DLS::File
654                DLS::File::Save;
655              // overridden  methods              // overridden  methods
656                File();
657              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
658              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.
659              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.
660              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.
661                Sample*     AddSample();
662                void        DeleteSample(Sample* pSample);
663              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.
664              Instrument* GetInstrument(uint index);              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
665             ~File();              Instrument* AddInstrument();
666                void        DeleteInstrument(Instrument* pInstrument);
667          protected:          protected:
668              typedef std::list<Sample*>     SampleList;              // overridden protected methods from DLS::File
669              typedef std::list<Instrument*> InstrumentList;              virtual void LoadSamples();
670                virtual void LoadInstruments();
671              SampleList*              pSamples;              // own protected methods
672              SampleList::iterator     SamplesIterator;              virtual void LoadSamples(progress_t* pProgress);
673              InstrumentList*          pInstruments;              virtual void LoadInstruments(progress_t* pProgress);
             InstrumentList::iterator InstrumentsIterator;  
   
             void LoadSamples();  
             void LoadInstruments();  
674              friend class Region;              friend class Region;
675      };      };
676    
# Line 670  namespace gig { Line 681  namespace gig {
681              void PrintMessage();              void PrintMessage();
682      };      };
683    
684        String libraryName();
685        String libraryVersion();
686    
687  } // namespace gig  } // namespace gig
688    
689  #endif // __GIG_H__  #endif // __GIG_H__

Legend:
Removed from v.353  
changed lines
  Added in v.926

  ViewVC Help
Powered by ViewVC