/[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 350 by schoenebeck, Tue Jan 25 21:54:24 2005 UTC revision 515 by schoenebeck, Sat May 7 20:19:10 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 80  namespace gig { Line 80  namespace gig {
80          void*         pStart;            ///< Points to the beginning of the buffer.          void*         pStart;            ///< Points to the beginning of the buffer.
81          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.
82          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. :)
83            buffer_t() {
84                pStart            = NULL;
85                Size              = 0;
86                NullExtensionSize = 0;
87            }
88      };      };
89    
90      /** Standard types of sample loops. */      /** Standard types of sample loops. */
# Line 219  namespace gig { Line 224  namespace gig {
224          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).
225          dimension_channelaftertouch = 0x83, ///< Channel Key Pressure          dimension_channelaftertouch = 0x83, ///< Channel Key Pressure
226          dimension_releasetrigger    = 0x84, ///< Special dimension for triggering samples on releasing a key.          dimension_releasetrigger    = 0x84, ///< Special dimension for triggering samples on releasing a key.
227          dimension_keyboard          = 0x85, ///< Key Position          dimension_keyboard          = 0x85, ///< Dimension for keyswitching
228            dimension_roundrobin        = 0x86, ///< Different samples triggered each time a note is played, dimension regions selected in sequence
229            dimension_random            = 0x87, ///< Different samples triggered each time a note is played, random order
230          dimension_modwheel          = 0x01, ///< Modulation Wheel (MIDI Controller 1)          dimension_modwheel          = 0x01, ///< Modulation Wheel (MIDI Controller 1)
231          dimension_breath            = 0x02, ///< Breath Controller (Coarse, MIDI Controller 2)          dimension_breath            = 0x02, ///< Breath Controller (Coarse, MIDI Controller 2)
232          dimension_foot              = 0x04, ///< Foot Pedal (Coarse, MIDI Controller 4)          dimension_foot              = 0x04, ///< Foot Pedal (Coarse, MIDI Controller 4)
# Line 279  namespace gig { Line 286  namespace gig {
286       *       *
287       * Note: The default value for crossfade points is 0,0,0,0. Layers with       * Note: The default value for crossfade points is 0,0,0,0. Layers with
288       * such a default value should be treated as if they would not have a       * such a default value should be treated as if they would not have a
289       * crossfade, that is the crossfade volume factor should <b>always</b>       * crossfade.
      * be 1.0f for such layers.  
290       */       */
291      struct crossfade_t {      struct crossfade_t {
292          #if WORDS_BIGENDIAN          #if WORDS_BIGENDIAN
# Line 303  namespace gig { Line 309  namespace gig {
309          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.
310      };      };
311    
312        /**
313         * @brief Used for indicating the progress of a certain task.
314         *
315         * The function pointer argument has to be supplied with a valid
316         * function of the given signature which will then be called on
317         * progress changes. The float argument of the callback function will
318         * then reflect the current progress as a value between 0.0 and 1.0.
319         */
320        struct progress_t {
321            void (*callback)(float); ///< Callback function pointer which has to be assigned to a function for progress notification.
322            float __range_min;
323            float __range_max;
324            progress_t();
325        };
326    
327      // just symbol prototyping      // just symbol prototyping
328      class File;      class File;
329      class Instrument;      class Instrument;
# Line 405  namespace gig { Line 426  namespace gig {
426              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.
427              bool               MSDecode;                      ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.              bool               MSDecode;                      ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.
428              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).
429                double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)
430    
431              // derived attributes from DLS::Sampler              // derived attributes from DLS::Sampler
432              DLS::Sampler::UnityNote;              DLS::Sampler::UnityNote;
433              DLS::Sampler::FineTune;              DLS::Sampler::FineTune;
# Line 477  namespace gig { Line 500  namespace gig {
500              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.
501              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).
502              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).
503                uint32_t       TruncatedBits;     ///< For 24-bit compressed samples only: number of bits truncated during compression (0, 4 or 6)
504                bool           Dithered;          ///< For 24-bit compressed samples only: if dithering was used during compression with bit reduction
505    
506              // own methods              // own methods
507              buffer_t      LoadSampleData();              buffer_t      LoadSampleData();
# Line 484  namespace gig { Line 509  namespace gig {
509              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
510              buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);
511              buffer_t      GetCache();              buffer_t      GetCache();
512                // own static methods
513                static buffer_t CreateDecompressionBuffer(unsigned long MaxReadSize);
514                static void     DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);
515              // overridden methods              // overridden methods
516              void          ReleaseSampleData();              void          ReleaseSampleData();
517              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);
518              unsigned long GetPos();              unsigned long GetPos();
519              unsigned long Read(void* pBuffer, unsigned long SampleCount);              unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
520              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);
521          protected:          protected:
522              static unsigned int  Instances;               ///< Number of instances of class Sample.              static unsigned int  Instances;               ///< Number of instances of class Sample.
523              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.  
524              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).
525              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.
526              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).
527                unsigned long        SamplesInLastFrame;      ///< For compressed samples only: length of the last sample frame.
528                unsigned long        WorstCaseFrameSize;      ///< For compressed samples only: size (in bytes) of the largest possible sample frame.
529                unsigned long        SamplesPerFrame;         ///< For compressed samples only: number of samples in a full sample frame.
530              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.
531    
532              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);
# Line 561  namespace gig { Line 591  namespace gig {
591                  return (A > B) ? B : A;                  return (A > B) ? B : A;
592              }              }
593              inline long Abs(long val) { return (val > 0) ? val : -val; }              inline long Abs(long val) { return (val > 0) ? val : -val; }
594    
595                // Guess size (in bytes) of a compressed sample
596                inline unsigned long GuessSize(unsigned long samples) {
597                    // 16 bit: assume all frames are compressed - 1 byte
598                    // per sample and 5 bytes header per 2048 samples
599    
600                    // 24 bit: assume next best compression rate - 1.5
601                    // bytes per sample and 13 bytes header per 256
602                    // samples
603                    const unsigned long size =
604                        BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
605                                       : samples + (samples >> 10) * 5;
606                    // Double for stereo and add one worst case sample
607                    // frame
608                    return (Channels == 2 ? size << 1 : size) + WorstCaseFrameSize;
609                }
610    
611                // Worst case amount of sample points that can be read with the
612                // given decompression buffer.
613                inline unsigned long WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
614                    return (unsigned long) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
615                }
616          private:          private:
617              void ScanCompressedSample();              void ScanCompressedSample();
618              friend class File;              friend class File;
# Line 585  namespace gig { Line 637  namespace gig {
637    
638              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
639              void LoadDimensionRegions(RIFF::List* rgn);              void LoadDimensionRegions(RIFF::List* rgn);
640              Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex);              Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
641             ~Region();             ~Region();
642              friend class Instrument;              friend class Instrument;
643      };      };
# Line 624  namespace gig { Line 676  namespace gig {
676              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
677              int       RegionIndex;              int       RegionIndex;
678    
679              Instrument(File* pFile, RIFF::List* insList);              Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);
680             ~Instrument();             ~Instrument();
681              friend class File;              friend class File;
682      };      };
# Line 644  namespace gig { Line 696  namespace gig {
696              DLS::Resource::GetParent;              DLS::Resource::GetParent;
697              // overridden  methods              // overridden  methods
698              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
699              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.
700              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.
701              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.
702              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.
703              Instrument* GetInstrument(uint index);              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
704             ~File();             ~File();
705          protected:          protected:
706              typedef std::list<Sample*>     SampleList;              typedef std::list<Sample*>     SampleList;
# Line 659  namespace gig { Line 711  namespace gig {
711              InstrumentList*          pInstruments;              InstrumentList*          pInstruments;
712              InstrumentList::iterator InstrumentsIterator;              InstrumentList::iterator InstrumentsIterator;
713    
714              void LoadSamples();              void LoadSamples(progress_t* pProgress = NULL);
715              void LoadInstruments();              void LoadInstruments(progress_t* pProgress = NULL);
716              friend class Region;              friend class Region;
717      };      };
718    
Legend:
Removed from v.350  
changed lines
  Added in v.515
  ViewVC Help
Powered by ViewVC