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

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

Parent Directory | Revision Log | View Patch Patch

-revision 2639 by schoenebeck,
Mon Jun 16 13:22:50 2014 UTC
+revision 3140 by schoenebeck,
Wed May  3 16:19:53 2017 UTC
 Line 2
   *                                                                         *
   *   libgig - C++ cross-platform Gigasampler format file access library    *
   *                                                                         *
-  *   Copyright (C) 2003-2014 by Christian Schoenebeck                      *
+  *   Copyright (C) 2003-2017 by Christian Schoenebeck                      *
   *                              <cuse@users.sourceforge.net>               *
   *                                                                         *
   *   This library is free software; you can redistribute it and/or modify  *
 Line 65
  # define CHUNK_ID_SCSL  0x4c534353 // own gig format extension
  #endif // WORDS_BIGENDIAN
- /** Gigasampler specific classes and definitions */
+ // just symbol prototyping (since Serialization.h not included by default here)
+ namespace Serialization { class Archive; }
+ /** Gigasampler/GigaStudio specific classes and definitions */
  namespace gig {
      typedef std::string String;
+     typedef RIFF::progress_t progress_t;
+     typedef RIFF::file_offset_t file_offset_t;
      /** Lower and upper limit of a range. */
      struct range_t {
-Line 79 
 namespace gig {
+Line 84 
 namespace gig {
      /** Pointer address and size of a buffer. */
      struct buffer_t {
          void*         pStart;            ///< Points to the beginning of the buffer.
-         unsigned long Size;              ///< Size of the actual data in the buffer in bytes.
+         file_offset_t Size;              ///< Size of the actual data in the buffer in bytes.
-         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. :)
+         file_offset_t 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. :)
          buffer_t() {
              pStart            = NULL;
              Size              = 0;
-Line 189 
 namespace gig {
+Line 194 
 namespace gig {
          type_t type;              ///< Controller type
          uint   controller_number; ///< MIDI controller number if this controller is a control change controller, 0 otherwise
+         void serialize(Serialization::Archive* archive);
      };
      /**
-Line 302 
 namespace gig {
+Line 309 
 namespace gig {
          uint8_t out_start;  ///< Start position of fade out.
          uint8_t out_end;    ///< End postition of fade out.
          #endif // WORDS_BIGENDIAN
+         void serialize(Serialization::Archive* archive);
      };
      /** Reflects the current playback state for a sample. */
      struct playback_state_t {
-         unsigned long position;          ///< Current position within the sample.
+         file_offset_t position;          ///< Current position within the sample.
          bool          reverse;           ///< If playback direction is currently backwards (in case there is a pingpong or reverse loop defined).
-         unsigned long loop_cycles_left;  ///< How many times the loop has still to be passed, this value will be decremented with each loop cycle.
+         file_offset_t 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
-Line 341 
 namespace gig {
+Line 329 
 namespace gig {
      class Script;
      class ScriptGroup;
-     /** @brief Encapsulates articulation information of a dimension region.
+     /** @brief Encapsulates articulation informations of a dimension region.
+      *
+      * This is the most important data object of the Gigasampler / GigaStudio
+      * format. A DimensionRegion provides the link to the sample to be played
+      * and all required articulation informations to be interpreted for playing
+      * back the sample and processing it appropriately by the sampler software.
+      * Every Region of a Gigasampler Instrument has at least one dimension
+      * region (exactly then when the Region has no dimension defined). Many
+      * Regions though provide more than one DimensionRegion, which reflect
+      * different playing "cases". For example a different sample might be played
+      * if a certain pedal is pressed down, or if the note was triggered with
+      * different velocity.
       *
-      *  Every Gigasampler Instrument has at least one dimension region
+      * One instance of a DimensionRegion reflects exactly one particular case
-      *  (exactly then when it has no dimension defined).
+      * while playing an instrument (for instance "note between C3 and E3 was
+      * triggered AND note on velocity was between 20 and 42 AND modulation wheel
+      * controller is between 80 and 127). The DimensionRegion defines what to do
+      * under that one particular case, that is which sample to play back and how
+      * to play that sample back exactly and how to process it. So a
+      * DimensionRegion object is always linked to exactly one sample. It may
+      * however also link to no sample at all, for defining a "silence" case
+      * where nothing shall be played (for example when note on velocity was
+      * below 6).
       *
-      *  Gigasampler provides three Envelope Generators and Low Frequency
+      * Note that a DimensionRegion object only defines "what to do", but it does
-      *  Oscillators:
+      * not define "when to do it". To actually resolve which DimensionRegion to
+      * pick under which situation, you need to refer to the DimensionRegions'
+      * parent Region object. The Region object contains the necessary
+      * "Dimension" definitions, which in turn define which DimensionRegion is
+      * associated with which playing case exactly.
+      *
+      * The Gigasampler/GigaStudio format defines 3 Envelope Generators and 3
+      * Low Frequency Oscillators:
       *
       *  - EG1 and LFO1, both controlling sample amplitude
       *  - EG2 and LFO2, both controlling filter cutoff frequency
       *  - EG3 and LFO3, both controlling sample pitch
+      *
+      * Since the gig format was designed as extension to the DLS file format,
+      * this class is derived from the DLS::Sampler class. So also refer to
+      * DLS::Sampler for additional informations, class attributes and methods.
       */
      class DimensionRegion : protected DLS::Sampler {
          public:
-Line 467 
 namespace gig {
+Line 485 
 namespace gig {
              using DLS::Sampler::DeleteSampleLoop;
              // overridden methods
              virtual void SetGain(int32_t gain);
-             virtual void UpdateChunks();
+             virtual void UpdateChunks(progress_t* pProgress);
              virtual void CopyAssign(const DimensionRegion* orig);
          protected:
              uint8_t* VelocityTable; ///< For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity MIDI value to dimension bit number.
-Line 475 
 namespace gig {
+Line 493 
 namespace gig {
              DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src);
             ~DimensionRegion();
              void CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples);
+             void serialize(Serialization::Archive* archive);
              friend class Region;
+             friend class Serialization::Archive;
          private:
              typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller
                  // official leverage controllers as they were defined in the original Gigasampler/GigaStudio format:
-Line 578 
 namespace gig {
+Line 598 
 namespace gig {
              } _lev_ctrl_t;
              typedef std::map<uint32_t, double*> VelocityTableMap;
-             static uint              Instances;                  ///< Number of DimensionRegion instances.
+             static size_t            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
-Line 593 
 namespace gig {
+Line 613 
 namespace gig {
              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
      };
-     /** @brief Encapsulates sample waves used for playback.
+     /** @brief Encapsulates sample waves of Gigasampler/GigaStudio files used for playback.
+      *
+      * This class provides access to the actual audio sample data of a
+      * Gigasampler/GigaStudio file. Along to the actual sample data, it also
+      * provides access to the sample's meta informations like bit depth,
+      * sample rate, encoding type, but also loop informations. The latter may be
+      * used by instruments for resembling sounds with arbitary note lengths.
       *
       * In case you created a new sample with File::AddSample(), you should
       * first update all attributes with the desired meta informations
-Line 607 
 namespace gig {
+Line 633 
 namespace gig {
       * retrieved from the respective DimensionRegon instead from the Sample
       * itself. This was made for allowing different loop definitions for the
       * same sample under different conditions.
+      *
+      * Since the gig format was designed as extension to the DLS file format,
+      * this class is derived from the DLS::Sample class. So also refer to
+      * DLS::Sample for additional informations, class attributes and methods.
       */
      class Sample : public DLS::Sample {
          public:
-Line 631 
 namespace gig {
+Line 661 
 namespace gig {
              // own methods
              buffer_t      LoadSampleData();
-             buffer_t      LoadSampleData(unsigned long SampleCount);
+             buffer_t      LoadSampleData(file_offset_t SampleCount);
              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
-             buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);
+             buffer_t      LoadSampleDataWithNullSamplesExtension(file_offset_t SampleCount, uint NullSamplesCount);
              buffer_t      GetCache();
              // own static methods
-             static buffer_t CreateDecompressionBuffer(unsigned long MaxReadSize);
+             static buffer_t CreateDecompressionBuffer(file_offset_t MaxReadSize);
              static void     DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);
              // overridden methods
              void          ReleaseSampleData();
-             void          Resize(int iNewSize);
+             void          Resize(file_offset_t NewSize);
-             unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
+             file_offset_t SetPos(file_offset_t SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
-             unsigned long GetPos() const;
+             file_offset_t GetPos() const;
-             unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
+             file_offset_t Read(void* pBuffer, file_offset_t SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
-             unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer = NULL);
+             file_offset_t ReadAndLoop(void* pBuffer, file_offset_t SampleCount, playback_state_t* pPlaybackState, DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer = NULL);
-             unsigned long Write(void* pBuffer, unsigned long SampleCount);
+             file_offset_t Write(void* pBuffer, file_offset_t SampleCount);
              Group*        GetGroup() const;
-             virtual void  UpdateChunks();
+             virtual void  UpdateChunks(progress_t* pProgress);
              void CopyAssignMeta(const Sample* orig);
              void CopyAssignWave(const Sample* orig);
+             uint32_t GetWaveDataCRC32Checksum();
+             bool VerifyWaveData(uint32_t* pActually = NULL);
          protected:
-             static unsigned int  Instances;               ///< Number of instances of class Sample.
+             static size_t        Instances;               ///< Number of instances of class Sample.
              static buffer_t      InternalDecompressionBuffer; ///< Buffer used for decompression as well as for truncation of 24 Bit -> 16 Bit samples.
              Group*               pGroup;                  ///< pointer to the Group this sample belongs to (always not-NULL)
-             unsigned long        FrameOffset;             ///< Current offset (sample points) in current sample frame (for decompression only).
+             file_offset_t        FrameOffset;             ///< Current offset (sample points) in current sample frame (for decompression only).
-             unsigned long*       FrameTable;              ///< For positioning within compressed samples only: stores the offset values for each frame.
+             file_offset_t*       FrameTable;              ///< For positioning within compressed samples only: stores the offset values for each frame.
-             unsigned long        SamplePos;               ///< For compressed samples only: stores the current position (in sample points).
+             file_offset_t        SamplePos;               ///< For compressed samples only: stores the current position (in sample points).
-             unsigned long        SamplesInLastFrame;      ///< For compressed samples only: length of the last sample frame.
+             file_offset_t        SamplesInLastFrame;      ///< For compressed samples only: length of the last sample frame.
-             unsigned long        WorstCaseFrameSize;      ///< For compressed samples only: size (in bytes) of the largest possible sample frame.
+             file_offset_t        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.
+             file_offset_t        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)
              RIFF::Chunk*         pCk3gix;
              RIFF::Chunk*         pCkSmpl;
-             uint32_t             crc;                     ///< CRC-32 checksum of the raw sample data
+             uint32_t             crc;                     ///< Reflects CRC-32 checksum of the raw sample data at the last time when the sample's raw wave form data has been modified consciously by the user by calling Write().
-             Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo = 0);
+             Sample(File* pFile, RIFF::List* waveList, file_offset_t WavePoolOffset, unsigned long fileNo = 0, int index = -1);
             ~Sample();
+             uint32_t CalculateWaveDataChecksum();
              // Guess size (in bytes) of a compressed sample
-             inline unsigned long GuessSize(unsigned long samples) {
+             inline file_offset_t GuessSize(file_offset_t samples) {
                  // 16 bit: assume all frames are compressed - 1 byte
                  // per sample and 5 bytes header per 2048 samples
                  // 24 bit: assume next best compression rate - 1.5
                  // bytes per sample and 13 bytes header per 256
                  // samples
-                 const unsigned long size =
+                 const file_offset_t size =
                      BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
                                     : samples + (samples >> 10) * 5;
                  // Double for stereo and add one worst case sample
-Line 687 
 namespace gig {
+Line 720 
 namespace gig {
              // Worst case amount of sample points that can be read with the
              // given decompression buffer.
-             inline unsigned long WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
+             inline file_offset_t WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
-                 return (unsigned long) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
+                 return (file_offset_t) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
              }
          private:
              void ScanCompressedSample();
-Line 698 
 namespace gig {
+Line 731 
 namespace gig {
      };
      // TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions)
-     /** @brief Defines Region information of an Instrument.
+     /** @brief Defines Region information of a Gigasampler/GigaStudio instrument.
       *
-      * A Region reflects a consecutive area on the keyboard. The individual
+      * A Region reflects a consecutive area (key range) on the keyboard. The
-      * regions in the gig format may not overlap with other regions (of the same
+      * individual regions in the gig format may not overlap with other regions
-      * instrument). Further, in the gig format a Region is merely a container
+      * (of the same instrument that is). Further, in the gig format a Region is
-      * for DimensionRegions (a.k.a. "Cases"). The Region itself does not provide
+      * merely a container for DimensionRegions (a.k.a. "Cases"). The Region
-      * the sample mapping or articulation informations used, even though the
+      * itself does not provide the sample mapping or articulation informations
-      * data structures indeed provide such informations. The latter is however
+      * used, even though the data structures of regions indeed provide such
-      * just of historical nature, because the gig format was derived from the
+      * informations. The latter is however just of historical nature, because
-      * DLS format.
+      * the gig file format was derived from the DLS file format.
       *
       * Each Region consists of at least one or more DimensionRegions. The actual
       * amount of DimensionRegions depends on which kind of "dimensions" are
       * defined for this region, and on the split / zone amount for each of those
       * dimensions.
+      *
+      * Since the gig format was designed as extension to the DLS file format,
+      * this class is derived from the DLS::Region class. So also refer to
+      * DLS::Region for additional informations, class attributes and methods.
       */
      class Region : public DLS::Region {
          public:
-Line 735 
 namespace gig {
+Line 772 
 namespace gig {
              void             SetDimensionType(dimension_t oldType, dimension_t newType);
              // overridden methods
              virtual void     SetKeyRange(uint16_t Low, uint16_t High);
-             virtual void     UpdateChunks();
+             virtual void     UpdateChunks(progress_t* pProgress);
              virtual void     CopyAssign(const Region* orig);
          protected:
              Region(Instrument* pInstrument, RIFF::List* rgnList);
-Line 748 
 namespace gig {
+Line 785 
 namespace gig {
              friend class Instrument;
      };
-     /** Abstract base class for all MIDI rules. */
+     /** @brief Abstract base class for all MIDI rules.
+      *
+      * Note: Instead of using MIDI rules, we recommend you using real-time
+      * instrument scripts instead. Read about the reasons below.
+      *
+      * MIDI Rules (also called "iMIDI rules" or "intelligent MIDI rules") were
+      * introduced with GigaStudio 4 as an attempt to increase the power of
+      * potential user controls over sounds. At that point other samplers already
+      * supported certain powerful user control features, which were not possible
+      * with GigaStudio yet. For example triggering new notes by MIDI CC
+      * controller.
+      *
+      * Such extended features however were usually implemented by other samplers
+      * by requiring the sound designer to write an instrument script which the
+      * designer would then bundle with the respective instrument file. Such
+      * scripts are essentially text files, using a very specific programming
+      * language for the purpose of controlling the sampler in real-time. Since
+      * however musicians are not typically keen to writing such cumbersome
+      * script files, the GigaStudio designers decided to implement such extended
+      * features completely without instrument scripts. Instead they created a
+      * set of rules, which could be defined and altered conveniently by mouse
+      * clicks in GSt's instrument editor application. The downside of this
+      * overall approach however, was that those MIDI rules were very limited in
+      * practice. As sound designer you easily came across the possiblities such
+      * MIDI rules were able to offer.
+      *
+      * Due to such severe use case constraints, support for MIDI rules is quite
+      * limited in libgig. At the moment only the "Control Trigger", "Alternator"
+      * and the "Legato" MIDI rules are supported by libgig. Consequently the
+      * graphical instrument editor application gigedit just supports the
+      * "Control Trigger" and "Legato" MIDI rules, and LinuxSampler even does not
+      * support any MIDI rule type at all and LinuxSampler probably will not
+      * support MIDI rules in future either.
+      *
+      * Instead of using MIDI rules, we introduced real-time instrument scripts
+      * as extension to the original GigaStudio file format. This script based
+      * solution is much more powerful than MIDI rules and is already supported
+      * by libgig, gigedit and LinuxSampler.
+      *
+      * @deprecated Just provided for backward compatiblity, use Script for new
+      *             instruments instead.
+      */
      class MidiRule {
          public:
              virtual ~MidiRule() { }
-Line 757 
 namespace gig {
+Line 835 
 namespace gig {
              friend class Instrument;
      };
-     /** MIDI rule for triggering notes by control change events. */
+     /** @brief MIDI rule for triggering notes by control change events.
+      *
+      * A "Control Trigger MIDI rule" allows to trigger new notes by sending MIDI
+      * control change events to the sampler.
+      *
+      * Note: "Control Trigger" MIDI rules are only supported by gigedit, but not
+      * by LinuxSampler. We recommend you using real-time instrument scripts
+      * instead. Read more about the details and reasons for this in the
+      * description of the MidiRule base class.
+      *
+      * @deprecated Just provided for backward compatiblity, use Script for new
+      *             instruments instead. See description of MidiRule for details.
+      */
      class MidiRuleCtrlTrigger : public MidiRule {
          public:
              uint8_t ControllerNumber;   ///< MIDI controller number.
-Line 779 
 namespace gig {
+Line 869 
 namespace gig {
              friend class Instrument;
      };
-     /** MIDI rule for instruments with legato samples. */
+     /** @brief MIDI rule for instruments with legato samples.
+      *
+      * A "Legato MIDI rule" allows playing instruments resembling the legato
+      * playing technique. In the past such legato articulations were tried to be
+      * simulated by pitching the samples of the instrument. However since
+      * usually a high amount of pitch is needed for legatos, this always sounded
+      * very artificial and unrealistic. The "Legato MIDI rule" thus uses another
+      * approach. Instead of pitching the samples, it allows the sound designer
+      * to bundle separate, additional samples for the individual legato
+      * situations and the legato rules defined which samples to be played in
+      * which situation.
+      *
+      * Note: "Legato MIDI rules" are only supported by gigedit, but not
+      * by LinuxSampler. We recommend you using real-time instrument scripts
+      * instead. Read more about the details and reasons for this in the
+      * description of the MidiRule base class.
+      *
+      * @deprecated Just provided for backward compatiblity, use Script for new
+      *             instruments instead. See description of MidiRule for details.
+      */
      class MidiRuleLegato : public MidiRule {
          public:
              uint8_t LegatoSamples;     ///< Number of legato samples per key in each direction (always 12)
-Line 800 
 namespace gig {
+Line 909 
 namespace gig {
              friend class Instrument;
      };
-     /** MIDI rule to automatically cycle through specified sequences of different articulations. The instrument must be using the smartmidi dimension. */
+     /** @brief MIDI rule to automatically cycle through specified sequences of different articulations.
+      *
+      * The instrument must be using the smartmidi dimension.
+      *
+      * Note: "Alternator" MIDI rules are neither supported by gigedit nor by
+      * LinuxSampler. We recommend you using real-time instrument scripts
+      * instead. Read more about the details and reasons for this in the
+      * description of the MidiRule base class.
+      *
+      * @deprecated Just provided for backward compatiblity, use Script for new
+      *             instruments instead. See description of MidiRule for details.
+      */
      class MidiRuleAlternator : public MidiRule {
          public:
              uint8_t Articulations;     ///< Number of articulations in the instrument
-Line 841 
 namespace gig {
+Line 961 
 namespace gig {
              friend class Instrument;
      };
-     /** A MIDI rule not yet implemented by libgig. */
+     /** @brief A MIDI rule not yet implemented by libgig.
+      *
+      * This class is currently used as a place holder by libgig for MIDI rule
+      * types which are not supported by libgig yet.
+      *
+      * Note: Support for missing MIDI rule types are probably never added to
+      * libgig. We recommend you using real-time instrument scripts instead.
+      * Read more about the details and reasons for this in the description of
+      * the MidiRule base class.
+      *
+      * @deprecated Just provided for backward compatiblity, use Script for new
+      *             instruments instead. See description of MidiRule for details.
+      */
      class MidiRuleUnknown : public MidiRule {
          protected:
              MidiRuleUnknown() { }
-Line 858 
 namespace gig {
+Line 990 
 namespace gig {
       *
       * This is an extension of the GigaStudio format, thus a feature which was
       * not available in the GigaStudio 4 software. It is currently only
-      * supported by LinuxSampler and gigedit.
+      * supported by LinuxSampler and gigedit. Scripts will not load with the
+      * original GigaStudio software.
+      *
+      * You find more informations about Instrument Scripts on the LinuxSampler
+      * documentation site:
+      *
+      * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/">About Instrument Scripts in General</a>
+      * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language">Introduction to the NKSP Script Language</a>
+      * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language/Reference/">NKSP Reference Manual</a>
+      * - <a href="http://doc.linuxsampler.org/Gigedit/Managing_Scripts">Using Instrument Scripts with Gigedit</a>
       */
      class Script {
          public:
-Line 869 
 namespace gig {
+Line 1010 
 namespace gig {
                  COMPRESSION_NONE = 0 ///< Is not compressed at all (default).
              };
              enum Language_t {
-                 LANGUAGE_NKSP = 0 ///< NKSP stands for "Is Not KSP" (default).
+                 LANGUAGE_NKSP = 0 ///< NKSP stands for "Is Not KSP" (default). Refer to the <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language/Reference/">NKSP Reference Manual</a> for details about this script language.
              };
              String         Name;        ///< Arbitrary name of the script, which may be displayed i.e. in an instrument editor.
-Line 882 
 namespace gig {
+Line 1023 
 namespace gig {
              void   SetScriptAsText(const String& text);
              void   SetGroup(ScriptGroup* pGroup);
              ScriptGroup* GetGroup() const;
+             void   CopyAssign(const Script* orig);
          protected:
              Script(ScriptGroup* group, RIFF::Chunk* ckScri);
              virtual ~Script();
-             void UpdateChunks();
+             void UpdateChunks(progress_t* pProgress);
              void RemoveAllScriptReferences();
              friend class ScriptGroup;
              friend class Instrument;
-Line 918 
 namespace gig {
+Line 1060 
 namespace gig {
              ScriptGroup(File* file, RIFF::List* lstRTIS);
              virtual ~ScriptGroup();
              void LoadScripts();
-             void UpdateChunks();
+             void UpdateChunks(progress_t* pProgress);
              friend class Script;
              friend class File;
          private:
-Line 927 
 namespace gig {
+Line 1069 
 namespace gig {
              std::list<Script*>*  pScripts;
      };
-     /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */
+     /** @brief Provides access to a Gigasampler/GigaStudio instrument.
+      *
+      * This class provides access to Gigasampler/GigaStudio instruments
+      * contained in .gig files. A gig instrument is merely a set of keyboard
+      * ranges (called Region), plus some additional global informations about
+      * the instrument. The major part of the actual instrument definition used
+      * for the synthesis of the instrument is contained in the respective Region
+      * object (or actually in the respective DimensionRegion object being, see
+      * description of Region for details).
+      *
+      * Since the gig format was designed as extension to the DLS file format,
+      * this class is derived from the DLS::Instrument class. So also refer to
+      * DLS::Instrument for additional informations, class attributes and
+      * methods.
+      */
      class Instrument : protected DLS::Instrument {
          public:
              // derived attributes from DLS::Resource
-Line 956 
 namespace gig {
+Line 1112 
 namespace gig {
              Region*   GetNextRegion();
              Region*   AddRegion();
              void      DeleteRegion(Region* pRegion);
-             virtual void UpdateChunks();
+             void      MoveTo(Instrument* dst);
+             virtual void UpdateChunks(progress_t* pProgress);
              virtual void CopyAssign(const Instrument* orig);
              // own methods
              Region*   GetRegion(unsigned int Key);
-Line 999 
 namespace gig {
+Line 1156 
 namespace gig {
              std::vector<_ScriptPooolRef>* pScriptRefs;
      };
-     /** @brief Group of Gigasampler objects
+     /** @brief Group of Gigasampler samples
       *
-      * Groups help to organize a huge collection of Gigasampler objects.
+      * Groups help to organize a huge collection of Gigasampler samples.
       * Groups are not concerned at all for the synthesis, but they help
       * sound library developers when working on complex instruments with an
       * instrument editor (as long as that instrument editor supports it ;-).
       *
-      * At the moment, it seems as only samples can be grouped together in
-      * the Gigasampler format yet. If this is false in the meantime, please
-      * tell us !
-      *
       * A sample is always assigned to exactly one Group. This also means
       * there is always at least one Group in a .gig file, no matter if you
       * created one yet or not.
-Line 1024 
 namespace gig {
+Line 1177 
 namespace gig {
          protected:
              Group(File* file, RIFF::Chunk* ck3gnm);
              virtual ~Group();
-             virtual void UpdateChunks();
+             virtual void UpdateChunks(progress_t* pProgress);
              void MoveAll();
              friend class File;
          private:
-Line 1032 
 namespace gig {
+Line 1185 
 namespace gig {
              RIFF::Chunk* pNameChunk; ///< '3gnm' chunk
      };
-     /** Parses Gigasampler files and provides abstract access to the data. */
+     /** @brief Provides convenient access to Gigasampler/GigaStudio .gig files.
+      *
+      * This is the entry class for accesing a Gigasampler/GigaStudio (.gig) file
+      * with libgig. It allows you to open existing .gig files, modifying them
+      * and saving them persistently either under the same file name or under a
+      * different location.
+      *
+      * A .gig file is merely a monolithic file. That means samples and the
+      * defintion of the virtual instruments are contained in the same file. A
+      * .gig file contains an arbitrary amount of samples, and an arbitrary
+      * amount of instruments which are referencing those samples. It is also
+      * possible to store samples in .gig files not being referenced by any
+      * instrument. This is not an error from the file format's point of view and
+      * it is actually often used in practice during the design phase of new gig
+      * instruments.
+      *
+      * So on toplevel of the gig file format you have:
+      *
+      * - A set of samples (see Sample).
+      * - A set of virtual instruments (see Instrument).
+      *
+      * And as extension to the original GigaStudio format, we added:
+      *
+      * - Real-time instrument scripts (see Script).
+      *
+      * Note that the latter however is only supported by libgig, gigedit and
+      * LinuxSampler. Scripts are not supported by the original GigaStudio
+      * software.
+      *
+      * All released Gigasampler/GigaStudio file format versions are supported
+      * (so from first Gigasampler version up to including GigaStudio 4).
+      *
+      * Since the gig format was designed as extension to the DLS file format,
+      * this class is derived from the DLS::File class. So also refer to
+      * DLS::File for additional informations, class attributes and methods.
+      */
      class File : protected DLS::File {
          public:
              static const DLS::version_t VERSION_2;
-Line 1080 
 namespace gig {
+Line 1268 
 namespace gig {
              ScriptGroup* AddScriptGroup();
              void        DeleteScriptGroup(ScriptGroup* pGroup);
              virtual    ~File();
-             virtual void UpdateChunks();
+             virtual void UpdateChunks(progress_t* pProgress);
          protected:
              // overridden protected methods from DLS::File
              virtual void LoadSamples();
-Line 1092 
 namespace gig {
+Line 1280 
 namespace gig {
              virtual void LoadInstruments(progress_t* pProgress);
              virtual void LoadScriptGroups();
              void SetSampleChecksum(Sample* pSample, uint32_t crc);
+             uint32_t GetSampleChecksum(Sample* pSample);
+             uint32_t GetSampleChecksumByIndex(int index);
+             bool VerifySampleChecksumTable();
+             bool RebuildSampleChecksumTable();
+             int  GetWaveTableIndexOf(gig::Sample* pSample);
              friend class Region;
              friend class Sample;
+             friend class Instrument;
              friend class Group; // so Group can access protected member pRIFF
              friend class ScriptGroup; // so ScriptGroup can access protected member pRIFF
          private:

 Legend:



Removed from v.2639
 


changed lines


 
Added in v.3140
 Legend:



Removed from v.2639
 


changed lines


 
Added in v.3140
-Removed from v.2639
+Added in v.3140

	ViewVC Help
Powered by ViewVC