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

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

Parent Directory | Revision Log | View Patch Patch

-revision 3488 by schoenebeck,
Thu Feb 28 17:49:07 2019 UTC
+revision 3722 by schoenebeck,
Wed Jan 22 15:37:09 2020 UTC
 Line 2
   *                                                                         *
   *   libgig - C++ cross-platform Gigasampler format file access library    *
   *                                                                         *
-  *   Copyright (C) 2003-2019 by Christian Schoenebeck                      *
+  *   Copyright (C) 2003-2020 by Christian Schoenebeck                      *
   *                              <cuse@users.sourceforge.net>               *
   *                                                                         *
   *   This library is free software; you can redistribute it and/or modify  *
 Line 1740 
 namespace {
              VCFType                         = vcf_type_lowpass;
              memset(DimensionUpperLimits, 127, 8);
          }
          // chunk for own format extensions, these will *NOT* work with Gigasampler/GigaStudio !
          RIFF::Chunk* lsde = _3ewl->GetSubChunk(CHUNK_ID_LSDE);
          if (lsde) { // format extension for EG behavior options
-Line 1765 
 namespace {
+Line 1766 
 namespace {
              SustainReleaseTrigger   = sust_rel_trg_none;
              NoNoteOffReleaseTrigger = false;
          }
+         // format extension for LFOs' wave form, phase displacement and for
+         // LFO3's flip phase
+         if (lsde && lsde->GetSize() > 4) {
+             lsde->SetPos(4);
+             LFO1WaveForm = static_cast<lfo_wave_t>( lsde->ReadUint16() );
+             LFO2WaveForm = static_cast<lfo_wave_t>( lsde->ReadUint16() );
+             LFO3WaveForm = static_cast<lfo_wave_t>( lsde->ReadUint16() );
+             lsde->ReadUint16(); // unused 16 bits, reserved for potential future use
+             LFO1Phase = (double) GIG_EXP_DECODE( lsde->ReadInt32() );
+             LFO2Phase = (double) GIG_EXP_DECODE( lsde->ReadInt32() );
+             LFO3Phase = (double) GIG_EXP_DECODE( lsde->ReadInt32() );
+             const uint32_t flags = lsde->ReadInt32();
+             LFO3FlipPhase = flags & 1;
+         } else {
+             LFO1WaveForm = lfo_wave_sine;
+             LFO2WaveForm = lfo_wave_sine;
+             LFO3WaveForm = lfo_wave_sine;
+             LFO1Phase = 0.0;
+             LFO2Phase = 0.0;
+             LFO3Phase = 0.0;
+             LFO3FlipPhase = false;
+         }
          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,
                                                       VelocityResponseDepth,
-Line 1890 
 namespace {
+Line 1913 
 namespace {
          SRLZ(EG1ControllerAttackInfluence);
          SRLZ(EG1ControllerDecayInfluence);
          SRLZ(EG1ControllerReleaseInfluence);
+         SRLZ(LFO1WaveForm);
          SRLZ(LFO1Frequency);
+         SRLZ(LFO1Phase);
          SRLZ(LFO1InternalDepth);
          SRLZ(LFO1ControlDepth);
          SRLZ(LFO1Controller);
-Line 1908 
 namespace {
+Line 1933 
 namespace {
          SRLZ(EG2ControllerAttackInfluence);
          SRLZ(EG2ControllerDecayInfluence);
          SRLZ(EG2ControllerReleaseInfluence);
+         SRLZ(LFO2WaveForm);
          SRLZ(LFO2Frequency);
+         SRLZ(LFO2Phase);
          SRLZ(LFO2InternalDepth);
          SRLZ(LFO2ControlDepth);
          SRLZ(LFO2Controller);
-Line 1916 
 namespace {
+Line 1943 
 namespace {
          SRLZ(LFO2Sync);
          SRLZ(EG3Attack);
          SRLZ(EG3Depth);
+         SRLZ(LFO3WaveForm);
          SRLZ(LFO3Frequency);
+         SRLZ(LFO3Phase);
          SRLZ(LFO3InternalDepth);
          SRLZ(LFO3ControlDepth);
          SRLZ(LFO3Controller);
+         SRLZ(LFO3FlipPhase);
          SRLZ(LFO3Sync);
          SRLZ(VCFEnabled);
          SRLZ(VCFType);
-Line 2267 
 namespace {
+Line 2297 
 namespace {
          // chunk for own format extensions, these will *NOT* work with
          // Gigasampler/GigaStudio !
          RIFF::Chunk* lsde = pParentList->GetSubChunk(CHUNK_ID_LSDE);
-         const int lsdeSize = 4; // NOTE: we reserved the 3rd byte for a potential future EG3 option
+         const int lsdeSize =
-         if (!lsde) {
+/* EG cancel options */ +
-             // only add this "LSDE" chunk if either EG options or release
+/* sustain pedal up on release trigger option */ +
-             // trigger options deviate from their default behaviour
+/* LFOs' wave forms */ + 12 /* LFOs' phase */ + 4 /* flags (LFO3FlipPhase) */;
-             eg_opt_t defaultOpt;
+         if (!lsde && UsesAnyGigFormatExtension()) {
-             if (memcmp(&EG1Options, &defaultOpt, sizeof(eg_opt_t)) ||
+             // only add this "LSDE" chunk if there is some (format extension)
-                 memcmp(&EG2Options, &defaultOpt, sizeof(eg_opt_t)) ||
+             // setting effective that would require our "LSDE" format extension
-                 SustainReleaseTrigger || NoNoteOffReleaseTrigger)
+             // chunk to be stored
-             {
+             lsde = pParentList->AddSubChunk(CHUNK_ID_LSDE, lsdeSize);
-                 lsde = pParentList->AddSubChunk(CHUNK_ID_LSDE, lsdeSize);
+             // move LSDE chunk to the end of parent list
-                 // move LSDE chunk to the end of parent list
+             pParentList->MoveSubChunk(lsde, (RIFF::Chunk*)NULL);
-                 pParentList->MoveSubChunk(lsde, (RIFF::Chunk*)NULL);
-             }
          }
          if (lsde) {
              if (lsde->GetNewSize() < lsdeSize)
-Line 2297 
 namespace {
+Line 2325 
 namespace {
              }
              // format extension for release trigger options
              pData[3] = static_cast<uint8_t>(SustainReleaseTrigger) | (NoNoteOffReleaseTrigger ? (1<<7) : 0);
+             // format extension for LFOs' wave form, phase displacement and for
+             // LFO3's flip phase
+             store16(&pData[4], LFO1WaveForm);
+             store16(&pData[6], LFO2WaveForm);
+             store16(&pData[8], LFO3WaveForm);
+             //NOTE: 16 bits reserved here for potential future use !
+             const int32_t lfo1Phase = (int32_t) GIG_EXP_ENCODE(LFO1Phase);
+             const int32_t lfo2Phase = (int32_t) GIG_EXP_ENCODE(LFO2Phase);
+             const int32_t lfo3Phase = (int32_t) GIG_EXP_ENCODE(LFO3Phase);
+             store32(&pData[12], lfo1Phase);
+             store32(&pData[16], lfo2Phase);
+             store32(&pData[20], lfo3Phase);
+             const int32_t flags = LFO3FlipPhase ? 1 : 0;
+             store32(&pData[24], flags);
+             // compile time sanity check: is our last store access here
+             // consistent with the initial lsdeSize value assignment?
+             static_assert(lsdeSize == 28, "Inconsistency in assumed 'LSDE' RIFF chunk size");
          }
      }
+     /**
+      * Returns @c true in case this DimensionRegion object uses any gig format
+      * extension, that is whether this DimensionRegion object currently has any
+      * setting effective that would require our "LSDE" RIFF chunk to be stored
+      * to the gig file.
+      *
+      * Right now this is a private method. It is considerable though this method
+      * to become (in slightly modified form) a public API method in future, i.e.
+      * to allow instrument editors to visualize and/or warn the user of any
+      * format extension being used. Right now this method really just serves to
+      * answer the question whether an LSDE chunk is required, for the public API
+      * purpose this method would also need to check whether any other setting
+      * stored to the regular value '3ewa' chunk, is actually a format extension
+      * as well.
+      */
+     bool DimensionRegion::UsesAnyGigFormatExtension() const {
+         eg_opt_t defaultOpt;
+         return memcmp(&EG1Options, &defaultOpt, sizeof(eg_opt_t)) ||
+                memcmp(&EG2Options, &defaultOpt, sizeof(eg_opt_t)) ||
+                SustainReleaseTrigger || NoNoteOffReleaseTrigger ||
+                LFO1WaveForm || LFO2WaveForm || LFO3WaveForm ||
+                LFO1Phase || LFO2Phase || LFO3Phase ||
+                LFO3FlipPhase;
+     }
      double* DimensionRegion::GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth) {
          curve_type_t curveType = releaseVelocityResponseCurve;
          uint8_t depth = releaseVelocityResponseDepth;
-Line 3341 
 namespace {
+Line 3412 
 namespace {
          }
          File* pFile = (File*) GetParent()->GetParent();
-         bool versiongt2 = pFile->pVersion && pFile->pVersion->major > 2;
+         const bool versiongt2 = pFile->pVersion && pFile->pVersion->major > 2;
          const int iMaxDimensions =  versiongt2 ? 8 : 5;
          const int iMaxDimensionRegions = versiongt2 ? 256 : 32;
-Line 3388 
 namespace {
+Line 3459 
 namespace {
              }
              store32(&pData[iWavePoolOffset + i * 4], iWaveIndex);
          }
+         // The following chunks are just added for compatibility with the
+         // GigaStudio software, which would show a warning if these were
+         // missing. However currently these chunks don't cover any useful
+         // data. So if this gig file uses any of our own gig format
+         // extensions which would cause this gig file to be unloadable
+         // with GSt software anyway, then just skip these GSt compatibility
+         // chunks here as well.
+         if (versiongt2 && !UsesAnyGigFormatExtension()) {
+             // add 3dnm list which always seems to be empty
+             RIFF::List* _3dnm = pCkRegion->GetSubList(LIST_TYPE_3DNM);
+             if (!_3dnm) _3dnm = pCkRegion->AddSubList(LIST_TYPE_3DNM);
+             // add 3ddp chunk which always seems to have 16 bytes of 0xFF
+             RIFF::Chunk* _3ddp = pCkRegion->GetSubChunk(CHUNK_ID_3DDP);
+             if (!_3ddp) _3ddp =  pCkRegion->AddSubChunk(CHUNK_ID_3DDP, 16);
+             uint8_t* pData = (uint8_t*) _3ddp->LoadChunkData();
+             for (int i = 0; i < 16; i += 4) {
+                 store32(&pData[i], 0xFFFFFFFF);
+             }
+             // move 3dnm and 3ddp to the end of the region list
+             pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3DNM), (RIFF::Chunk*)NULL);
+             pCkRegion->MoveSubChunk(pCkRegion->GetSubChunk(CHUNK_ID_3DDP), (RIFF::Chunk*)NULL);
+         } else {
+             // this is intended for the user switching from GSt >= 3 version
+             // back to an older format version, delete GSt3 chunks ...
+             RIFF::List* _3dnm = pCkRegion->GetSubList(LIST_TYPE_3DNM);
+             if (_3dnm) pCkRegion->DeleteSubChunk(_3dnm);
+             RIFF::Chunk* _3ddp = pCkRegion->GetSubChunk(CHUNK_ID_3DDP);
+             if (_3ddp) pCkRegion->DeleteSubChunk(_3ddp);
+         }
      }
      void Region::LoadDimensionRegions(RIFF::List* rgn) {
-Line 3786 
 namespace {
+Line 3890 
 namespace {
          // now tempRegion's dimensions and DimensionRegions basically reflect
          // what we wanted to get for this actual Region here, so we now just
          // delete and recreate the dimension in question with the new amount
-         // zones and then copy back from tempRegion
+         // zones and then copy back from tempRegion. we're actually deleting and
-         DeleteDimension(oldDef);
+         // recreating all dimensions here, to avoid altering the precise order
-         AddDimension(&newDef);
+         // of the dimensions (which would not be an error per se, but it would
+         // cause usability issues with instrument editors)
+         {
+             std::vector<dimension_def_t> oldDefs;
+             for (int i = 0; i < Dimensions; ++i)
+                 oldDefs.push_back(pDimensionDefinitions[i]); // copy, don't reference
+             for (int i = Dimensions - 1; i >= 0; --i)
+                 DeleteDimension(&pDimensionDefinitions[i]);
+             for (int i = 0; i < oldDefs.size(); ++i) {
+                 dimension_def_t& def = oldDefs[i];
+                 AddDimension(
+                     (def.dimension == newDef.dimension) ? &newDef : &def
+                 );
+             }
+         }
          for (int iSrc = 0; iSrc < 256; ++iSrc) {
              DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
              if (!srcDimRgn) continue;
-Line 3926 
 namespace {
+Line 4044 
 namespace {
          // now tempRegion's dimensions and DimensionRegions basically reflect
          // what we wanted to get for this actual Region here, so we now just
          // delete and recreate the dimension in question with the new amount
-         // zones and then copy back from tempRegion
+         // zones and then copy back from tempRegion. we're actually deleting and
-         DeleteDimension(oldDef);
+         // recreating all dimensions here, to avoid altering the precise order
-         AddDimension(&newDef);
+         // of the dimensions (which would not be an error per se, but it would
+         // cause usability issues with instrument editors)
+         {
+             std::vector<dimension_def_t> oldDefs;
+             for (int i = 0; i < Dimensions; ++i)
+                 oldDefs.push_back(pDimensionDefinitions[i]); // copy, don't reference
+             for (int i = Dimensions - 1; i >= 0; --i)
+                 DeleteDimension(&pDimensionDefinitions[i]);
+             for (int i = 0; i < oldDefs.size(); ++i) {
+                 dimension_def_t& def = oldDefs[i];
+                 AddDimension(
+                     (def.dimension == newDef.dimension) ? &newDef : &def
+                 );
+             }
+         }
          for (int iSrc = 0; iSrc < 256; ++iSrc) {
              DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
              if (!srcDimRgn) continue;
-Line 4252 
 namespace {
+Line 4384 
 namespace {
          Layers = orig->Layers;
      }
+     /**
+      * Returns @c true in case this Region object uses any gig format
+      * extension, that is e.g. whether any DimensionRegion object currently
+      * has any setting effective that would require our "LSDE" RIFF chunk to
+      * be stored to the gig file.
+      *
+      * Right now this is a private method. It is considerable though this method
+      * to become (in slightly modified form) a public API method in future, i.e.
+      * to allow instrument editors to visualize and/or warn the user of any gig
+      * format extension being used. See also comments on
+      * DimensionRegion::UsesAnyGigFormatExtension() for details about such a
+      * potential public API change in future.
+      */
+     bool Region::UsesAnyGigFormatExtension() const {
+         for (int i = 0; i < 256; i++) {
+             if (pDimensionRegions[i]) {
+                 if (pDimensionRegions[i]->UsesAnyGigFormatExtension())
+                     return true;
+             }
+         }
+         return false;
+     }
  // *************** MidiRule ***************
  // *
-Line 4433 
 namespace {
+Line 4588 
 namespace {
              Compression = (Compression_t) ckScri->ReadUint32();
              Encoding    = (Encoding_t) ckScri->ReadUint32();
              Language    = (Language_t) ckScri->ReadUint32();
-             Bypass      = (Language_t) ckScri->ReadUint32() & 1;
+             Bypass      = ckScri->ReadUint32() & 1;
              crc         = ckScri->ReadUint32();
              uint32_t nameSize = ckScri->ReadUint32();
              Name.resize(nameSize, ' ');
-Line 5422 
 namespace {
+Line 5577 
 namespace {
          UpdateRegionKeyTable();
      }
+     /**
+      * Returns @c true in case this Instrument object uses any gig format
+      * extension, that is e.g. whether any DimensionRegion object currently
+      * has any setting effective that would require our "LSDE" RIFF chunk to
+      * be stored to the gig file.
+      *
+      * Right now this is a private method. It is considerable though this method
+      * to become (in slightly modified form) a public API method in future, i.e.
+      * to allow instrument editors to visualize and/or warn the user of any gig
+      * format extension being used. See also comments on
+      * DimensionRegion::UsesAnyGigFormatExtension() for details about such a
+      * potential public API change in future.
+      */
+     bool Instrument::UsesAnyGigFormatExtension() const {
+         if (!pRegions) return false;
+         RegionList::const_iterator iter = pRegions->begin();
+         RegionList::const_iterator end  = pRegions->end();
+         for (; iter != end; ++iter) {
+             gig::Region* rgn = static_cast<gig::Region*>(*iter);
+             if (rgn->UsesAnyGigFormatExtension())
+                 return true;
+         }
+         return false;
+     }
  // *************** Group ***************
  // *
-Line 6554 
 namespace {
+Line 6734 
 namespace {
              if (pVersion && pVersion->major > 2) {
                  RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();
                  for (int i = 0 ; i < 128 ; i++) {
-                     if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
+                     // create 128 empty placeholder strings which will either
+                     // be filled by Group::UpdateChunks below or left empty.
+                     ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
                      if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();
                  }
              }
-Line 6750 
 namespace {
+Line 6932 
 namespace {
          return bAutoLoad;
      }
+     /**
+      * Returns @c true in case this gig File object uses any gig format
+      * extension, that is e.g. whether any DimensionRegion object currently
+      * has any setting effective that would require our "LSDE" RIFF chunk to
+      * be stored to the gig file.
+      *
+      * Right now this is a private method. It is considerable though this method
+      * to become (in slightly modified form) a public API method in future, i.e.
+      * to allow instrument editors to visualize and/or warn the user of any gig
+      * format extension being used. See also comments on
+      * DimensionRegion::UsesAnyGigFormatExtension() for details about such a
+      * potential public API change in future.
+      */
+     bool File::UsesAnyGigFormatExtension() const {
+         if (!pInstruments) return false;
+         InstrumentList::iterator iter = pInstruments->begin();
+         InstrumentList::iterator end  = pInstruments->end();
+         for (; iter != end; ++iter) {
+             Instrument* pInstrument = static_cast<gig::Instrument*>(*iter);
+             if (pInstrument->UsesAnyGigFormatExtension())
+                 return true;
+         }
+         return false;
+     }
  // *************** Exception ***************

 Legend:



Removed from v.3488
 


changed lines


 
Added in v.3722
 Legend:



Removed from v.3488
 


changed lines


 
Added in v.3722
-Removed from v.3488
+Added in v.3722

	ViewVC Help
Powered by ViewVC