/[svn]/libgig/trunk/src/gig.h

Diff of /libgig/trunk/src/gig.h

Parent Directory | Revision Log | View Patch Patch

-revision 406 by persson,
Wed Feb 23 19:11:07 2005 UTC
+revision 774 by persson,
Sun Sep 18 12:41:56 2005 UTC
 Line 148 
 namespace gig {
      /** Defines how the filter cutoff frequency is controlled by. */
      typedef enum {
          vcf_cutoff_ctrl_none         = 0x00,
+         vcf_cutoff_ctrl_none2        = 0x01,  ///< The difference betwheen none and none2 is unknown
          vcf_cutoff_ctrl_modwheel     = 0x81,  ///< Modulation Wheel (MIDI Controller 1)
          vcf_cutoff_ctrl_effect1      = 0x8c,  ///< Effect Controller 1 (Coarse, MIDI Controller 12)
          vcf_cutoff_ctrl_effect2      = 0x8d,  ///< Effect Controller 2 (Coarse, MIDI Controller 13)
-Line 225 
 namespace gig {
+Line 226 
 namespace gig {
          dimension_channelaftertouch = 0x83, ///< Channel Key Pressure
          dimension_releasetrigger    = 0x84, ///< Special dimension for triggering samples on releasing a key.
          dimension_keyboard          = 0x85, ///< Dimension for keyswitching
+         dimension_roundrobin        = 0x86, ///< Different samples triggered each time a note is played, dimension regions selected in sequence
+         dimension_random            = 0x87, ///< Different samples triggered each time a note is played, random order
          dimension_modwheel          = 0x01, ///< Modulation Wheel (MIDI Controller 1)
          dimension_breath            = 0x02, ///< Breath Controller (Coarse, MIDI Controller 2)
          dimension_foot              = 0x04, ///< Foot Pedal (Coarse, MIDI Controller 4)
-Line 267 
 namespace gig {
+Line 270 
 namespace gig {
          uint8_t      zones;      ///< Number of zones the dimension has.
          split_type_t split_type; ///< Intended for internal usage: will be used to convert a dimension value into the corresponding dimension bit number.
          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).
-         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.
      };
      /** Defines which frequencies are filtered by the VCF. */
-Line 307 
 namespace gig {
+Line 310 
 namespace gig {
          unsigned long loop_cycles_left;  ///< How many times the loop has still to be passed, this value will be decremented with each loop cycle.
      };
+     /**
+      * @brief Used for indicating the progress of a certain task.
+      *
+      * The function pointer argument has to be supplied with a valid
+      * function of the given signature which will then be called on
+      * progress changes. An equivalent progress_t structure will be passed
+      * back as argument to the callback function on each progress change.
+      * The factor field of the supplied progress_t structure will then
+      * reflect the current progress as value between 0.0 and 1.0. You might
+      * want to use the custom field for data needed in your callback
+      * function.
+      */
+     struct progress_t {
+         void (*callback)(progress_t*); ///< Callback function pointer which has to be assigned to a function for progress notification.
+         float factor;                  ///< Reflects current progress as value between 0.0 and 1.0.
+         void* custom;                  ///< This pointer can be used for arbitrary data.
+         float __range_min;             ///< Only for internal usage, do not modify!
+         float __range_max;             ///< Only for internal usage, do not modify!
+         progress_t();
+     };
      // just symbol prototyping
      class File;
      class Instrument;
-Line 380 
 namespace gig {
+Line 404 
 namespace gig {
              bool               VCFEnabled;                    ///< If filter should be used.
              vcf_type_t         VCFType;                       ///< Defines the general filter characteristic (lowpass, highpass, bandpass, etc.).
              vcf_cutoff_ctrl_t  VCFCutoffController;           ///< Specifies which external controller has influence on the filter cutoff frequency.
+             bool               VCFCutoffControllerInvert;     ///< Inverts values coming from the defined cutoff controller
              uint8_t            VCFCutoff;                     ///< Max. cutoff frequency.
              curve_type_t       VCFVelocityCurve;              ///< Defines a transformation curve for the incoming velocity values, affecting the VCF.
-             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).
              uint8_t            VCFVelocityDynamicRange;       ///< 0x04 = lowest, 0x00 = highest
              uint8_t            VCFResonance;                  ///< Firm internal filter resonance weight.
              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 420 
 namespace gig {
+Line 445 
 namespace gig {
              // Methods
              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
+             double GetVelocityRelease(uint8_t MIDIKeyVelocity);
+             double GetVelocityCutoff(uint8_t MIDIKeyVelocity);
          protected:
              DimensionRegion(RIFF::List* _3ewl);
             ~DimensionRegion();
-Line 458 
 namespace gig {
+Line 486 
 namespace gig {
              static uint              Instances;                  ///< Number of DimensionRegion instances.
              static VelocityTableMap* pVelocityTables;            ///< Contains the tables corresponding to the various velocity parameters (VelocityResponseCurve and VelocityResponseDepth).
              double*                  pVelocityAttenuationTable;  ///< Points to the velocity table corresponding to the velocity parameters of this DimensionRegion.
+             double*                  pVelocityReleaseTable;      ///< Points to the velocity table corresponding to the release velocity parameters of this DimensionRegion
+             double*                  pVelocityCutoffTable;       ///< Points to the velocity table corresponding to the filter velocity parameters of this DimensionRegion
              leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
+             double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
      };
-Line 483 
 namespace gig {
+Line 514 
 namespace gig {
              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       LoopPlayCount;     ///< Number of times the loop should be played (only if Loops > 0, a value of 0 = infinite).
              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).
+             uint32_t       TruncatedBits;     ///< For 24-bit compressed samples only: number of bits truncated during compression (0, 4 or 6)
+             bool           Dithered;          ///< For 24-bit compressed samples only: if dithering was used during compression with bit reduction
              // own methods
              buffer_t      LoadSampleData();
-Line 509 
 namespace gig {
+Line 542 
 namespace gig {
              unsigned long        WorstCaseFrameSize;      ///< For compressed samples only: size (in bytes) of the largest possible sample frame.
              unsigned long        SamplesPerFrame;         ///< For compressed samples only: number of samples in a full sample frame.
              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.
+             unsigned long        FileNo;                  ///< File number (> 0 when sample is stored in an extension file, 0 when it's in the gig)
-             Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);
+             Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo = 0);
             ~Sample();
              /**
               * Swaps the order of the data words in the given memory area
-Line 618 
 namespace gig {
+Line 652 
 namespace gig {
              Region(Instrument* pInstrument, RIFF::List* rgnList);
              void LoadDimensionRegions(RIFF::List* rgn);
-             Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex);
+             Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
             ~Region();
              friend class Instrument;
      };
-Line 657 
 namespace gig {
+Line 691 
 namespace gig {
              Region*   RegionKeyTable[128]; ///< fast lookup for the corresponding Region of a MIDI key
              int       RegionIndex;
-             Instrument(File* pFile, RIFF::List* insList);
+             Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);
             ~Instrument();
              friend class File;
      };
-Line 677 
 namespace gig {
+Line 711 
 namespace gig {
              DLS::Resource::GetParent;
              // overridden  methods
              File(RIFF::File* pRIFF);
-             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.
              Sample*     GetNextSample();      ///< Returns a pointer to the next <i>Sample</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.
              Instrument* GetNextInstrument();  ///< Returns a pointer to the next <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
-             Instrument* GetInstrument(uint index);
+             Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
             ~File();
          protected:
              typedef std::list<Sample*>     SampleList;
-Line 692 
 namespace gig {
+Line 726 
 namespace gig {
              InstrumentList*          pInstruments;
              InstrumentList::iterator InstrumentsIterator;
-             void LoadSamples();
+             void LoadSamples(progress_t* pProgress = NULL);
-             void LoadInstruments();
+             void LoadInstruments(progress_t* pProgress = NULL);
              friend class Region;
+             std::list<RIFF::File*> ExtensionFiles;
      };
      /** Will be thrown whenever a gig specific error occurs while trying to access a Gigasampler File. */
-Line 704 
 namespace gig {
+Line 740 
 namespace gig {
              void PrintMessage();
      };
+     String libraryName();
+     String libraryVersion();
  } // namespace gig
  #endif // __GIG_H__

 Legend:



Removed from v.406
 


changed lines


 
Added in v.774
 Legend:



Removed from v.406
 


changed lines


 
Added in v.774
-Removed from v.406
+Added in v.774

	ViewVC Help
Powered by ViewVC