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

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

Parent Directory | Revision Log | View Patch Patch

-revision 858 by persson,
Sat May  6 11:29:29 2006 UTC
+revision 933 by schoenebeck,
Fri Nov 24 12:50:05 2006 UTC
 Line 1
  /***************************************************************************
   *                                                                         *
-  *   libgig - C++ cross-platform Gigasampler format file loader library    *
+  *   libgig - C++ cross-platform Gigasampler format file access library    *
   *                                                                         *
-  *   Copyright (C) 2003-2005 by Christian Schoenebeck                      *
+  *   Copyright (C) 2003-2006 by Christian Schoenebeck                      *
   *                              <cuse@users.sourceforge.net>               *
   *                                                                         *
   *   This library is free software; you can redistribute it and/or modify  *
 Line 29
  #if WORDS_BIGENDIAN
  # define LIST_TYPE_3PRG 0x33707267
  # define LIST_TYPE_3EWL 0x3365776C
+ # define LIST_TYPE_3GRI 0x33677269
+ # define LIST_TYPE_3GNL 0x33676E6C
  # define CHUNK_ID_SMPL  0x736D706C
  # define CHUNK_ID_3GIX  0x33676978
  # define CHUNK_ID_3EWA  0x33657761
  # define CHUNK_ID_3LNK  0x336C6E6B
  # define CHUNK_ID_3EWG  0x33657767
  # define CHUNK_ID_EWAV  0x65776176
+ # define CHUNK_ID_3GNM  0x33676E6D
  #else  // little endian
  # define LIST_TYPE_3PRG 0x67727033
  # define LIST_TYPE_3EWL 0x6C776533
+ # define LIST_TYPE_3GRI 0x69726733
+ # define LIST_TYPE_3GNL 0x6C6E6733
  # define CHUNK_ID_SMPL  0x6C706D73
  # define CHUNK_ID_3GIX  0x78696733
  # define CHUNK_ID_3EWA  0x61776533
  # define CHUNK_ID_3LNK  0x6B6E6C33
  # define CHUNK_ID_3EWG  0x67776533
  # define CHUNK_ID_EWAV  0x76617765
+ # define CHUNK_ID_3GNM  0x6D6E6733
  #endif // WORDS_BIGENDIAN
  /** Gigasampler specific classes and definitions */
-Line 316 
 namespace gig {
+Line 322 
 namespace gig {
      class Instrument;
      class Sample;
      class Region;
+     class Group;
      /** Encapsulates articulation information of a dimension region.
       *
-Line 489 
 namespace gig {
+Line 496 
 namespace gig {
       */
      class Sample : public DLS::Sample {
          public:
-             uint16_t       SampleGroup;
              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       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       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.
-Line 524 
 namespace gig {
+Line 530 
 namespace gig {
              unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
              unsigned long GetPos();
              unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
-             unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, buffer_t* pExternalDecompressionBuffer = NULL);
+             unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer = NULL);
              unsigned long Write(void* pBuffer, unsigned long SampleCount);
+             Group*        GetGroup() const;
              virtual void  UpdateChunks();
          protected:
              static unsigned int  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).
              unsigned long*       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).
-Line 569 
 namespace gig {
+Line 577 
 namespace gig {
              void ScanCompressedSample();
              friend class File;
              friend class Region;
+             friend class Group; // allow to modify protected member pGroup
      };
      // TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions)
-Line 576 
 namespace gig {
+Line 585 
 namespace gig {
      class Region : public DLS::Region {
          public:
              unsigned int            Dimensions;               ///< Number of defined dimensions, do not alter!
-             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 ot delete an existing one.
+             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.
              uint32_t                DimensionRegions;         ///< Total number of DimensionRegions this Region contains, do not alter!
-             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 ot delete an existing one (which will create or delete the respective dimension region(s) automatically).
+             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).
              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!
              DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);
-Line 637 
 namespace gig {
+Line 646 
 namespace gig {
              friend class File;
      };
-     // TODO: <3gnm> chunk not added yet (just contains the names of the sample groups)
+     /** @brief Group of Gigasampler objects
+      *
+      * Groups help to organize a huge collection of Gigasampler objects.
+      * 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.
+      */
+     class Group {
+         public:
+             String Name; ///< Stores the name of this Group.
+             Sample* GetFirstSample();
+             Sample* GetNextSample();
+             void AddSample(Sample* pSample);
+         protected:
+             Group(File* file, RIFF::Chunk* ck3gnm);
+             virtual ~Group();
+             virtual void UpdateChunks();
+             void MoveAll();
+             friend class File;
+         private:
+             File*        pFile;
+             RIFF::Chunk* pNameChunk;
+     };
      /** Parses Gigasampler files and provides abstract access to the data. */
      class File : protected DLS::File {
          public:
-Line 657 
 namespace gig {
+Line 698 
 namespace gig {
              File(RIFF::File* pRIFF);
              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.
              Sample*     AddSample();
              void        DeleteSample(Sample* pSample);
+             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, progress_t* pProgress = NULL);
              Instrument* AddInstrument();
              void        DeleteInstrument(Instrument* pInstrument);
+             Group*      GetFirstGroup(); ///< Returns a pointer to the first <i>Group</i> object of the file, <i>NULL</i> otherwise.
+             Group*      GetNextGroup();  ///< Returns a pointer to the next <i>Group</i> object of the file, <i>NULL</i> otherwise.
+             Group*      GetGroup(uint index);
+             Group*      AddGroup();
+             void        DeleteGroup(Group* pGroup);
+             virtual    ~File();
          protected:
              // overridden protected methods from DLS::File
              virtual void LoadSamples();
              virtual void LoadInstruments();
+             virtual void LoadGroups();
              // own protected methods
              virtual void LoadSamples(progress_t* pProgress);
              virtual void LoadInstruments(progress_t* pProgress);
              friend class Region;
+             friend class Sample;
+             friend class Group; // so Group can access protected member pRIFF
+         private:
+             std::list<Group*>*          pGroups;
+             std::list<Group*>::iterator GroupsIterator;
      };
      /** Will be thrown whenever a gig specific error occurs while trying to access a Gigasampler File. */

 Legend:



Removed from v.858
 


changed lines


 
Added in v.933
 Legend:



Removed from v.858
 


changed lines


 
Added in v.933
-Removed from v.858
+Added in v.933

	ViewVC Help
Powered by ViewVC