/[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 1076 by persson, Tue Mar 6 18:33:30 2007 UTC revision 1155 by schoenebeck, Wed Apr 11 18:11:09 2007 UTC
# Line 2  Line 2 
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file access library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-2006 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2007 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  *
# Line 326  namespace gig { Line 326  namespace gig {
326      class Region;      class Region;
327      class Group;      class Group;
328    
329      /** Encapsulates articulation information of a dimension region.      /** @brief Encapsulates articulation information of a dimension region.
330       *       *
331       *  Every Gigasampler Instrument has at least one dimension region       *  Every Gigasampler Instrument has at least one dimension region
332       *  (exactly then when it has no dimension defined).       *  (exactly then when it has no dimension defined).
# Line 437  namespace gig { Line 437  namespace gig {
437              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
438              double GetVelocityRelease(uint8_t MIDIKeyVelocity);              double GetVelocityRelease(uint8_t MIDIKeyVelocity);
439              double GetVelocityCutoff(uint8_t MIDIKeyVelocity);              double GetVelocityCutoff(uint8_t MIDIKeyVelocity);
440                // derived methods
441                DLS::Sampler::AddSampleLoop;
442                DLS::Sampler::DeleteSampleLoop;
443              // overridden methods              // overridden methods
444              virtual void UpdateChunks();              virtual void UpdateChunks();
445          protected:          protected:
# Line 496  namespace gig { Line 499  namespace gig {
499       * will create the mandatory RIFF chunk which will hold the sample wave       * will create the mandatory RIFF chunk which will hold the sample wave
500       * data and / or resize the file so you will be able to Write() the       * data and / or resize the file so you will be able to Write() the
501       * sample data directly to disk.       * sample data directly to disk.
502         *
503         * @e Caution: for gig synthesis, most looping relevant information are
504         * retrieved from the respective DimensionRegon instead from the Sample
505         * itself. This was made for allowing different loop definitions for the
506         * same sample under different conditions.
507       */       */
508      class Sample : public DLS::Sample {      class Sample : public DLS::Sample {
509          public:          public:
# Line 506  namespace gig { Line 514  namespace gig {
514              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.
515              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.
516              uint32_t       SMPTEOffset;       ///< The SMPTE Offset value specifies the time offset to be used for the synchronization / calibration to the first sample in the waveform. This value uses a format of 0xhhmmssff where hh is a signed value that specifies the number of hours (-23 to 23), mm is an unsigned value that specifies the number of minutes (0 to 59), ss is an unsigned value that specifies the number of seconds (0 to 59) and ff is an unsigned value that specifies the number of frames (0 to -1).              uint32_t       SMPTEOffset;       ///< The SMPTE Offset value specifies the time offset to be used for the synchronization / calibration to the first sample in the waveform. This value uses a format of 0xhhmmssff where hh is a signed value that specifies the number of hours (-23 to 23), mm is an unsigned value that specifies the number of minutes (0 to 59), ss is an unsigned value that specifies the number of seconds (0 to 59) and ff is an unsigned value that specifies the number of frames (0 to -1).
517              uint32_t       Loops;             ///< Number of defined sample loops (so far only seen single loops in gig files - please report me if you encounter more!).              uint32_t       Loops;             ///< @e Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: Number of defined sample loops. So far only seen single loops in gig files - please report if you encounter more!)
518              uint32_t       LoopID;            ///< Specifies the unique ID that corresponds to one of the defined cue points in the cue point list (only if Loops > 0), as the Gigasampler format only allows one loop definition at the moment, this attribute isn't really useful for anything.              uint32_t       LoopID;            ///< Specifies the unique ID that corresponds to one of the defined cue points in the cue point list (only if Loops > 0), as the Gigasampler format only allows one loop definition at the moment, this attribute isn't really useful for anything.
519              loop_type_t    LoopType;          ///< The type field defines how the waveform samples will be looped (only if Loops > 0).              loop_type_t    LoopType;          ///< @e Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The type field defines how the waveform samples will be looped.)
520              uint32_t       LoopStart;         ///< The start value specifies the offset (in sample points) in the waveform data of the first sample to be played in the loop (only if Loops > 0).              uint32_t       LoopStart;         ///< @e Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The start value specifies the offset [in sample points] in the waveform data of the first sample to be played in the loop [only if Loops > 0].)
521              uint32_t       LoopEnd;           ///< The end value specifies the offset (in sample points) in the waveform data which represents the end of the loop (only if Loops > 0).              uint32_t       LoopEnd;           ///< @e Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The end value specifies the offset [in sample points] in the waveform data which represents the end of the loop [only if Loops > 0].)
522              uint32_t       LoopSize;          ///< Length of the looping area (in sample points) which is equivalent to <i>LoopEnd - LoopStart</i>.              uint32_t       LoopSize;          ///< @e Caution: Use the respective fields in the DimensionRegion instead of this one! (Intended purpose: Length of the looping area [in sample points] which is equivalent to @code LoopEnd - LoopStart @endcode.)
523              uint32_t       LoopFraction;      ///< The fractional value specifies a fraction of a sample at which to loop (only if Loops > 0). This allows a loop to be fine tuned at a resolution greater than one sample. A value of 0 means no fraction, a value of 0x80000000 means 1/2 of a sample length. 0xFFFFFFFF is the smallest fraction of a sample that can be represented.              uint32_t       LoopFraction;      ///< The fractional value specifies a fraction of a sample at which to loop. This allows a loop to be fine tuned at a resolution greater than one sample. A value of 0 means no fraction, a value of 0x80000000 means 1/2 of a sample length. 0xFFFFFFFF is the smallest fraction of a sample that can be represented.
524              uint32_t       LoopPlayCount;     ///< Number of times the loop should be played (only if Loops > 0, a value of 0 = infinite).              uint32_t       LoopPlayCount;     ///< Number of times the loop should be played (a value of 0 = infinite).
525              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).
526              uint32_t       TruncatedBits;     ///< For 24-bit compressed samples only: number of bits truncated during compression (0, 4 or 6)              uint32_t       TruncatedBits;     ///< For 24-bit compressed samples only: number of bits truncated during compression (0, 4 or 6)
527              bool           Dithered;          ///< For 24-bit compressed samples only: if dithering was used during compression with bit reduction              bool           Dithered;          ///< For 24-bit compressed samples only: if dithering was used during compression with bit reduction
# Line 632  namespace gig { Line 640  namespace gig {
640    
641              // derived methods from DLS::Resource              // derived methods from DLS::Resource
642              DLS::Resource::GetParent;              DLS::Resource::GetParent;
643                // derived methods from DLS::Instrument
644                DLS::Instrument::MoveRegion;
645              // overridden methods              // overridden methods
646              Region*   GetFirstRegion();              Region*   GetFirstRegion();
647              Region*   GetNextRegion();              Region*   GetNextRegion();
# Line 713  namespace gig { Line 723  namespace gig {
723              Group*      GetGroup(uint index);              Group*      GetGroup(uint index);
724              Group*      AddGroup();              Group*      AddGroup();
725              void        DeleteGroup(Group* pGroup);              void        DeleteGroup(Group* pGroup);
726                void        DeleteGroupOnly(Group* pGroup);
727              virtual    ~File();              virtual    ~File();
728                virtual void UpdateChunks();
729          protected:          protected:
730              // overridden protected methods from DLS::File              // overridden protected methods from DLS::File
731              virtual void LoadSamples();              virtual void LoadSamples();
# Line 730  namespace gig { Line 742  namespace gig {
742              std::list<Group*>::iterator GroupsIterator;              std::list<Group*>::iterator GroupsIterator;
743      };      };
744    
745      /** Will be thrown whenever a gig specific error occurs while trying to access a Gigasampler File. */      /**
746         * Will be thrown whenever a gig specific error occurs while trying to
747         * access a Gigasampler File. Note: In your application you should
748         * better catch for RIFF::Exception rather than this one, except you
749         * explicitly want to catch and handle gig::Exception, DLS::Exception
750         * and RIFF::Exception independently, which usually shouldn't be
751         * necessary though.
752         */
753      class Exception : public DLS::Exception {      class Exception : public DLS::Exception {
754          public:          public:
755              Exception(String Message);              Exception(String Message);
Legend:
Removed from v.1076  
changed lines
  Added in v.1155
  ViewVC Help
Powered by ViewVC