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

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

Parent Directory | Revision Log | View Patch Patch

-revision 1358 by schoenebeck,
Sun Sep 30 18:13:33 2007 UTC
+revision 1875 by schoenebeck,
Thu Mar 26 13:32:59 2009 UTC
 Line 2
   *                                                                         *
   *   libgig - C++ cross-platform Gigasampler format file access library    *
   *                                                                         *
-  *   Copyright (C) 2003-2007 by Christian Schoenebeck                      *
+  *   Copyright (C) 2003-2009 by Christian Schoenebeck                      *
   *                              <cuse@users.sourceforge.net>               *
   *                                                                         *
   *   This library is free software; you can redistribute it and/or modify  *
 Line 25
  #include "helper.h"
+ #include <algorithm>
  #include <math.h>
  #include <iostream>
-Line 255 
 namespace {
+Line 256 
 namespace {
+ // *************** Internal CRC-32 (Cyclic Redundancy Check) functions  ***************
+ // *
+     static uint32_t* __initCRCTable() {
+         static uint32_t res[256];
+         for (int i = 0 ; i < 256 ; i++) {
+             uint32_t c = i;
+             for (int j = 0 ; j < 8 ; j++) {
+                 c = (c & 1) ? 0xedb88320 ^ (c >> 1) : c >> 1;
+             }
+             res[i] = c;
+         }
+         return res;
+     }
+     static const uint32_t* __CRCTable = __initCRCTable();
+     /**
+      * Initialize a CRC variable.
+      *
+      * @param crc - variable to be initialized
+      */
+     inline static void __resetCRC(uint32_t& crc) {
+         crc = 0xffffffff;
+     }
+     /**
+      * Used to calculate checksums of the sample data in a gig file. The
+      * checksums are stored in the 3crc chunk of the gig file and
+      * automatically updated when a sample is written with Sample::Write().
+      *
+      * One should call __resetCRC() to initialize the CRC variable to be
+      * used before calling this function the first time.
+      *
+      * After initializing the CRC variable one can call this function
+      * arbitrary times, i.e. to split the overall CRC calculation into
+      * steps.
+      *
+      * Once the whole data was processed by __calculateCRC(), one should
+      * call __encodeCRC() to get the final CRC result.
+      *
+      * @param buf     - pointer to data the CRC shall be calculated of
+      * @param bufSize - size of the data to be processed
+      * @param crc     - variable the CRC sum shall be stored to
+      */
+     static void __calculateCRC(unsigned char* buf, int bufSize, uint32_t& crc) {
+         for (int i = 0 ; i < bufSize ; i++) {
+             crc = __CRCTable[(crc ^ buf[i]) & 0xff] ^ (crc >> 8);
+         }
+     }
+     /**
+      * Returns the final CRC result.
+      *
+      * @param crc - variable previously passed to __calculateCRC()
+      */
+     inline static uint32_t __encodeCRC(const uint32_t& crc) {
+         return crc ^ 0xffffffff;
+     }
  // *************** Other Internal functions  ***************
  // *
-Line 278 
 namespace {
+Line 342 
 namespace {
- // *************** CRC ***************
- // *
-     const uint32_t* CRC::table(initTable());
-     uint32_t* CRC::initTable() {
-         uint32_t* res = new uint32_t[256];
-         for (int i = 0 ; i < 256 ; i++) {
-             uint32_t c = i;
-             for (int j = 0 ; j < 8 ; j++) {
-                 c = (c & 1) ? 0xedb88320 ^ (c >> 1) : c >> 1;
-             }
-             res[i] = c;
-         }
-         return res;
-     }
  // *************** Sample ***************
  // *
-Line 323 
 namespace {
+Line 367 
 namespace {
       *                         is located, 0 otherwise
       */
      Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {
-         static const DLS::Info::FixedStringLength fixedStringLengths[] = {
+         static const DLS::Info::string_length_t fixedStringLengths[] = {
              { CHUNK_ID_INAM, 64 },
              { 0, 0 }
          };
-         pInfo->FixedStringLengths = fixedStringLengths;
+         pInfo->SetFixedStringLengths(fixedStringLengths);
          Instances++;
          FileNo = fileNo;
+         __resetCRC(crc);
          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);
          if (pCk3gix) {
              uint16_t iSampleGroup = pCk3gix->ReadInt16();
-Line 631 
 namespace {
+Line 677 
 namespace {
          if (SampleCount > this->SamplesTotal) SampleCount = this->SamplesTotal;
          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
          unsigned long allocationsize = (SampleCount + NullSamplesCount) * this->FrameSize;
+         SetPos(0); // reset read position to begin of sample
          RAMCache.pStart            = new int8_t[allocationsize];
          RAMCache.Size              = Read(RAMCache.pStart, SampleCount) * this->FrameSize;
          RAMCache.NullExtensionSize = allocationsize - RAMCache.Size;
-Line 668 
 namespace {
+Line 715 
 namespace {
          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
          RAMCache.pStart = NULL;
          RAMCache.Size   = 0;
+         RAMCache.NullExtensionSize = 0;
      }
      /** @brief Resize sample.
-Line 862 
 namespace {
+Line 910 
 namespace {
                                  }
                                  // reverse the sample frames for backward playback
-                                 SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
+                                 if (totalreadsamples > swapareastart) //FIXME: this if() is just a crash workaround for now (#102), but totalreadsamples <= swapareastart should never be the case, so there's probably still a bug above!
+                                     SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
                              }
                          } while (samplestoread && readsamples);
                          break;
-Line 1168 
 namespace {
+Line 1217 
 namespace {
          // if this is the first write in this sample, reset the
          // checksum calculator
          if (pCkData->GetPos() == 0) {
-             crc.reset();
+             __resetCRC(crc);
          }
          if (GetSize() < SampleCount) throw Exception("Could not write sample data, current sample size to small");
          unsigned long res;
-Line 1178 
 namespace {
+Line 1227 
 namespace {
              res = Channels == 2 ? pCkData->Write(pBuffer, SampleCount << 1, 2) >> 1
                                  : pCkData->Write(pBuffer, SampleCount, 2);
          }
-         crc.update((unsigned char *)pBuffer, SampleCount * FrameSize);
+         __calculateCRC((unsigned char *)pBuffer, SampleCount * FrameSize, crc);
          // if this is the last write, update the checksum chunk in the
          // file
          if (pCkData->GetPos() == pCkData->GetSize()) {
              File* pFile = static_cast<File*>(GetParent());
-             pFile->SetSampleChecksum(this, crc.getValue());
+             pFile->SetSampleChecksum(this, __encodeCRC(crc));
          }
          return res;
      }
-Line 1789 
 namespace {
+Line 1838 
 namespace {
          const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth
                                                    : uint16_t(((-EG3Depth) - 1) ^ 0xffff); /* binary complementary for negatives */
-         pData[116] = eg3depth;
+         store16(&pData[116], eg3depth);
          // next 2 bytes unknown
-Line 2327 
 namespace {
+Line 2376 
 namespace {
          // Actual Loading
+         if (!file->GetAutoLoad()) return;
          LoadDimensionRegions(rgnList);
          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);
-Line 2370 
 namespace {
+Line 2421 
 namespace {
              else
                  _3lnk->SetPos(44);
-             // load sample references
+             // load sample references (if auto loading is enabled)
-             for (uint i = 0; i < DimensionRegions; i++) {
+             if (file->GetAutoLoad()) {
-                 uint32_t wavepoolindex = _3lnk->ReadUint32();
+                 for (uint i = 0; i < DimensionRegions; i++) {
-                 if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
+                     uint32_t wavepoolindex = _3lnk->ReadUint32();
+                     if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
+                 }
+                 GetSample(); // load global region sample reference
              }
-             GetSample(); // load global region sample reference
          } else {
              DimensionRegions = 0;
              for (int i = 0 ; i < 8 ; i++) {
-Line 2874 
 namespace {
+Line 2927 
 namespace {
      }
+ // *************** MidiRule ***************
+ // *
+ MidiRuleCtrlTrigger::MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg) {
+     _3ewg->SetPos(36);
+     Triggers = _3ewg->ReadUint8();
+     _3ewg->SetPos(40);
+     ControllerNumber = _3ewg->ReadUint8();
+     _3ewg->SetPos(46);
+     for (int i = 0 ; i < Triggers ; i++) {
+         pTriggers[i].TriggerPoint = _3ewg->ReadUint8();
+         pTriggers[i].Descending = _3ewg->ReadUint8();
+         pTriggers[i].VelSensitivity = _3ewg->ReadUint8();
+         pTriggers[i].Key = _3ewg->ReadUint8();
+         pTriggers[i].NoteOff = _3ewg->ReadUint8();
+         pTriggers[i].Velocity = _3ewg->ReadUint8();
+         pTriggers[i].OverridePedal = _3ewg->ReadUint8();
+         _3ewg->ReadUint8();
+     }
+ }
  // *************** Instrument ***************
  // *
      Instrument::Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress) : DLS::Instrument((DLS::File*)pFile, insList) {
-         static const DLS::Info::FixedStringLength fixedStringLengths[] = {
+         static const DLS::Info::string_length_t fixedStringLengths[] = {
              { CHUNK_ID_INAM, 64 },
              { CHUNK_ID_ISFT, 12 },
              { 0, 0 }
          };
-         pInfo->FixedStringLengths = fixedStringLengths;
+         pInfo->SetFixedStringLengths(fixedStringLengths);
          // Initialization
          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
-Line 2895 
 namespace {
+Line 2969 
 namespace {
          PianoReleaseMode = false;
          DimensionKeyRange.low = 0;
          DimensionKeyRange.high = 0;
+         pMidiRules = new MidiRule*[3];
+         pMidiRules[0] = NULL;
          // Loading
          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);
-Line 2909 
 namespace {
+Line 2985 
 namespace {
                  PianoReleaseMode       = dimkeystart & 0x01;
                  DimensionKeyRange.low  = dimkeystart >> 1;
                  DimensionKeyRange.high = _3ewg->ReadUint8();
+                 if (_3ewg->GetSize() > 32) {
+                     // read MIDI rules
+                     int i = 0;
+                     _3ewg->SetPos(32);
+                     uint8_t id1 = _3ewg->ReadUint8();
+                     uint8_t id2 = _3ewg->ReadUint8();
+                     if (id1 == 4 && id2 == 16) {
+                         pMidiRules[i++] = new MidiRuleCtrlTrigger(_3ewg);
+                     }
+                     //TODO: all the other types of rules
+                     pMidiRules[i] = NULL;
+                 }
              }
          }
-         if (!pRegions) pRegions = new RegionList;
+         if (pFile->GetAutoLoad()) {
-         RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
+             if (!pRegions) pRegions = new RegionList;
-         if (lrgn) {
+             RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
-             RIFF::List* rgn = lrgn->GetFirstSubList();
+             if (lrgn) {
-             while (rgn) {
+                 RIFF::List* rgn = lrgn->GetFirstSubList();
-                 if (rgn->GetListType() == LIST_TYPE_RGN) {
+                 while (rgn) {
-                     __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
+                     if (rgn->GetListType() == LIST_TYPE_RGN) {
-                     pRegions->push_back(new Region(this, rgn));
+                         __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
+                         pRegions->push_back(new Region(this, rgn));
+                     }
+                     rgn = lrgn->GetNextSubList();
                  }
-                 rgn = lrgn->GetNextSubList();
+                 // Creating Region Key Table for fast lookup
+                 UpdateRegionKeyTable();
              }
-             // Creating Region Key Table for fast lookup
-             UpdateRegionKeyTable();
          }
          __notify_progress(pProgress, 1.0f); // notify done
-Line 2943 
 namespace {
+Line 3036 
 namespace {
      }
      Instrument::~Instrument() {
+         delete[] pMidiRules;
      }
      /**
-Line 3057 
 namespace {
+Line 3151 
 namespace {
          UpdateRegionKeyTable();
      }
+     /**
+      * Returns a MIDI rule of the instrument.
+      *
+      * The list of MIDI rules, at least in gig v3, always contains at
+      * most two rules. The second rule can only be the DEF filter
+      * (which currently isn't supported by libgig).
+      *
+      * @param i - MIDI rule number
+      * @returns   pointer address to MIDI rule number i or NULL if there is none
+      */
+     MidiRule* Instrument::GetMidiRule(int i) {
+         return pMidiRules[i];
+     }
  // *************** Group ***************
-Line 3182 
 namespace {
+Line 3289 
 namespace {
  // *************** File ***************
  // *
-     // File version 2.0, 1998-06-28
+     /// Reflects Gigasampler file format version 2.0 (1998-06-28).
      const DLS::version_t File::VERSION_2 = {
 , 2, 19980628 & 0xffff, 19980628 >> 16
      };
-     // File version 3.0, 2003-03-31
+     /// Reflects Gigasampler file format version 3.0 (2003-03-31).
      const DLS::version_t File::VERSION_3 = {
 , 3, 20030331 & 0xffff, 20030331 >> 16
      };
-     const DLS::Info::FixedStringLength File::FixedStringLengths[] = {
+     static const DLS::Info::string_length_t _FileFixedStringLengths[] = {
          { CHUNK_ID_IARL, 256 },
          { CHUNK_ID_IART, 128 },
          { CHUNK_ID_ICMS, 128 },
-Line 3214 
 namespace {
+Line 3321 
 namespace {
      };
      File::File() : DLS::File() {
+         bAutoLoad = true;
          *pVersion = VERSION_3;
          pGroups = NULL;
-         pInfo->FixedStringLengths = FixedStringLengths;
+         pInfo->SetFixedStringLengths(_FileFixedStringLengths);
          pInfo->ArchivalLocation = String(256, ' ');
          // add some mandatory chunks to get the file chunks in right
-Line 3229 
 namespace {
+Line 3337 
 namespace {
      }
      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {
+         bAutoLoad = true;
          pGroups = NULL;
-         pInfo->FixedStringLengths = FixedStringLengths;
+         pInfo->SetFixedStringLengths(_FileFixedStringLengths);
      }
      File::~File() {
-Line 3298 
 namespace {
+Line 3407 
 namespace {
          pSamples->erase(iter);
          delete pSample;
+         SampleList::iterator tmp = SamplesIterator;
          // remove all references to the sample
          for (Instrument* instrument = GetFirstInstrument() ; instrument ;
               instrument = GetNextInstrument()) {
-Line 3312 
 namespace {
+Line 3422 
 namespace {
                  }
              }
          }
+         SamplesIterator = tmp; // restore iterator
      }
      void File::LoadSamples() {
-Line 3402 
 namespace {
+Line 3513 
 namespace {
              progress_t subprogress;
              __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask
              __notify_progress(&subprogress, 0.0f);
-             GetFirstSample(&subprogress); // now force all samples to be loaded
+             if (GetAutoLoad())
+                 GetFirstSample(&subprogress); // now force all samples to be loaded
              __notify_progress(&subprogress, 1.0f);
              // instrument loading subtask
-Line 3809 
 namespace {
+Line 3921 
 namespace {
          }
      }
+     /**
+      * Enable / disable automatic loading. By default this properyt is
+      * enabled and all informations are loaded automatically. However
+      * loading all Regions, DimensionRegions and especially samples might
+      * take a long time for large .gig files, and sometimes one might only
+      * be interested in retrieving very superficial informations like the
+      * amount of instruments and their names. In this case one might disable
+      * automatic loading to avoid very slow response times.
+      *
+      * @e CAUTION: by disabling this property many pointers (i.e. sample
+      * references) and informations will have invalid or even undefined
+      * data! This feature is currently only intended for retrieving very
+      * superficial informations in a very fast way. Don't use it to retrieve
+      * details like synthesis informations or even to modify .gig files!
+      */
+     void File::SetAutoLoad(bool b) {
+         bAutoLoad = b;
+     }
+     /**
+      * Returns whether automatic loading is enabled.
+      * @see SetAutoLoad()
+      */
+     bool File::GetAutoLoad() {
+         return bAutoLoad;
+     }
  // *************** Exception ***************

 Legend:



Removed from v.1358
 


changed lines


 
Added in v.1875
 Legend:



Removed from v.1358
 


changed lines


 
Added in v.1875
-Removed from v.1358
+Added in v.1875

	ViewVC Help
Powered by ViewVC