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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2923 by schoenebeck, Sat May 21 08:54:32 2016 UTC revision 3327 by schoenebeck, Sun Jul 23 18:18:30 2017 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-2016 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2017 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 24  Line 24 
24  #include "gig.h"  #include "gig.h"
25    
26  #include "helper.h"  #include "helper.h"
27    #include "Serialization.h"
28    
29  #include <algorithm>  #include <algorithm>
30  #include <math.h>  #include <math.h>
# Line 55  Line 56 
56  #define GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(x)    ((x & 0x03) << 3)  #define GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(x)    ((x & 0x03) << 3)
57  #define GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(x)  ((x & 0x03) << 5)  #define GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(x)  ((x & 0x03) << 5)
58    
59    #define SRLZ(member) \
60        archive->serializeMember(*this, member, #member);
61    
62  namespace gig {  namespace gig {
63    
64  // *************** Internal functions for sample decompression ***************  // *************** Internal functions for sample decompression ***************
# Line 269  namespace { Line 273  namespace {
273       * steps.       * steps.
274       *       *
275       * Once the whole data was processed by __calculateCRC(), one should       * Once the whole data was processed by __calculateCRC(), one should
276       * call __encodeCRC() to get the final CRC result.       * call __finalizeCRC() to get the final CRC result.
277       *       *
278       * @param buf     - pointer to data the CRC shall be calculated of       * @param buf     - pointer to data the CRC shall be calculated of
279       * @param bufSize - size of the data to be processed       * @param bufSize - size of the data to be processed
280       * @param crc     - variable the CRC sum shall be stored to       * @param crc     - variable the CRC sum shall be stored to
281       */       */
282      static void __calculateCRC(unsigned char* buf, int bufSize, uint32_t& crc) {      static void __calculateCRC(unsigned char* buf, size_t bufSize, uint32_t& crc) {
283          for (int i = 0 ; i < bufSize ; i++) {          for (size_t i = 0 ; i < bufSize ; i++) {
284              crc = __CRCTable[(crc ^ buf[i]) & 0xff] ^ (crc >> 8);              crc = __CRCTable[(crc ^ buf[i]) & 0xff] ^ (crc >> 8);
285          }          }
286      }      }
# Line 286  namespace { Line 290  namespace {
290       *       *
291       * @param crc - variable previously passed to __calculateCRC()       * @param crc - variable previously passed to __calculateCRC()
292       */       */
293      inline static uint32_t __encodeCRC(const uint32_t& crc) {      inline static void __finalizeCRC(uint32_t& crc) {
294          return crc ^ 0xffffffff;          crc ^= 0xffffffff;
295      }      }
296    
297    
# Line 315  namespace { Line 319  namespace {
319    
320    
321    
322    // *************** leverage_ctrl_t ***************
323    // *
324    
325        void leverage_ctrl_t::serialize(Serialization::Archive* archive) {
326            SRLZ(type);
327            SRLZ(controller_number);
328        }
329    
330    
331    
332    // *************** crossfade_t ***************
333    // *
334    
335        void crossfade_t::serialize(Serialization::Archive* archive) {
336            SRLZ(in_start);
337            SRLZ(in_end);
338            SRLZ(out_start);
339            SRLZ(out_end);
340        }
341    
342    
343    
344    // *************** eg_opt_t ***************
345    // *
346    
347        eg_opt_t::eg_opt_t() {
348            AttackCancel     = true;
349            AttackHoldCancel = true;
350            Decay1Cancel     = true;
351            Decay2Cancel     = true;
352            ReleaseCancel    = true;
353        }
354    
355        void eg_opt_t::serialize(Serialization::Archive* archive) {
356            SRLZ(AttackCancel);
357            SRLZ(AttackHoldCancel);
358            SRLZ(Decay1Cancel);
359            SRLZ(Decay2Cancel);
360            SRLZ(ReleaseCancel);
361        }
362    
363    
364    
365  // *************** Sample ***************  // *************** Sample ***************
366  // *  // *
367    
# Line 338  namespace { Line 385  namespace {
385       *                         ('wvpl') list chunk       *                         ('wvpl') list chunk
386       * @param fileNo         - number of an extension file where this sample       * @param fileNo         - number of an extension file where this sample
387       *                         is located, 0 otherwise       *                         is located, 0 otherwise
388         * @param index          - wave pool index of sample (may be -1 on new sample)
389       */       */
390      Sample::Sample(File* pFile, RIFF::List* waveList, file_offset_t WavePoolOffset, unsigned long fileNo) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {      Sample::Sample(File* pFile, RIFF::List* waveList, file_offset_t WavePoolOffset, unsigned long fileNo, int index)
391            : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset)
392        {
393          static const DLS::Info::string_length_t fixedStringLengths[] = {          static const DLS::Info::string_length_t fixedStringLengths[] = {
394              { CHUNK_ID_INAM, 64 },              { CHUNK_ID_INAM, 64 },
395              { 0, 0 }              { 0, 0 }
# Line 349  namespace { Line 399  namespace {
399          FileNo = fileNo;          FileNo = fileNo;
400    
401          __resetCRC(crc);          __resetCRC(crc);
402            // if this is not a new sample, try to get the sample's already existing
403            // CRC32 checksum from disk, this checksum will reflect the sample's CRC32
404            // checksum of the time when the sample was consciously modified by the
405            // user for the last time (by calling Sample::Write() that is).
406            if (index >= 0) { // not a new file ...
407                try {
408                    uint32_t crc = pFile->GetSampleChecksumByIndex(index);
409                    this->crc = crc;
410                } catch (...) {}
411            }
412    
413          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);
414          if (pCk3gix) {          if (pCk3gix) {
# Line 1281  namespace { Line 1341  namespace {
1341          // if this is the last write, update the checksum chunk in the          // if this is the last write, update the checksum chunk in the
1342          // file          // file
1343          if (pCkData->GetPos() == pCkData->GetSize()) {          if (pCkData->GetPos() == pCkData->GetSize()) {
1344                __finalizeCRC(crc);
1345              File* pFile = static_cast<File*>(GetParent());              File* pFile = static_cast<File*>(GetParent());
1346              pFile->SetSampleChecksum(this, __encodeCRC(crc));              pFile->SetSampleChecksum(this, crc);
1347          }          }
1348          return res;          return res;
1349      }      }
# Line 1341  namespace { Line 1402  namespace {
1402          return pGroup;          return pGroup;
1403      }      }
1404    
1405        /**
1406         * Returns the CRC-32 checksum of the sample's raw wave form data at the
1407         * time when this sample's wave form data was modified for the last time
1408         * by calling Write(). This checksum only covers the raw wave form data,
1409         * not any meta informations like i.e. bit depth or loop points. Since
1410         * this method just returns the checksum stored for this sample i.e. when
1411         * the gig file was loaded, this method returns immediately. So it does no
1412         * recalcuation of the checksum with the currently available sample wave
1413         * form data.
1414         *
1415         * @see VerifyWaveData()
1416         */
1417        uint32_t Sample::GetWaveDataCRC32Checksum() {
1418            return crc;
1419        }
1420    
1421        /**
1422         * Checks the integrity of this sample's raw audio wave data. Whenever a
1423         * Sample's raw wave data is intentionally modified (i.e. by calling
1424         * Write() and supplying the new raw audio wave form data) a CRC32 checksum
1425         * is calculated and stored/updated for this sample, along to the sample's
1426         * meta informations.
1427         *
1428         * Now by calling this method the current raw audio wave data is checked
1429         * against the already stored CRC32 check sum in order to check whether the
1430         * sample data had been damaged unintentionally for some reason. Since by
1431         * calling this method always the entire raw audio wave data has to be
1432         * read, verifying all samples this way may take a long time accordingly.
1433         * And that's also the reason why the sample integrity is not checked by
1434         * default whenever a gig file is loaded. So this method must be called
1435         * explicitly to fulfill this task.
1436         *
1437         * @param pActually - (optional) if provided, will be set to the actually
1438         *                    calculated checksum of the current raw wave form data,
1439         *                    you can get the expected checksum instead by calling
1440         *                    GetWaveDataCRC32Checksum()
1441         * @returns true if sample is OK or false if the sample is damaged
1442         * @throws Exception if no checksum had been stored to disk for this
1443         *         sample yet, or on I/O issues
1444         * @see GetWaveDataCRC32Checksum()
1445         */
1446        bool Sample::VerifyWaveData(uint32_t* pActually) {
1447            //File* pFile = static_cast<File*>(GetParent());
1448            uint32_t crc = CalculateWaveDataChecksum();
1449            if (pActually) *pActually = crc;
1450            return crc == this->crc;
1451        }
1452    
1453        uint32_t Sample::CalculateWaveDataChecksum() {
1454            const size_t sz = 20*1024; // 20kB buffer size
1455            std::vector<uint8_t> buffer(sz);
1456            buffer.resize(sz);
1457    
1458            const size_t n = sz / FrameSize;
1459            SetPos(0);
1460            uint32_t crc = 0;
1461            __resetCRC(crc);
1462            while (true) {
1463                file_offset_t nRead = Read(&buffer[0], n);
1464                if (nRead <= 0) break;
1465                __calculateCRC(&buffer[0], nRead * FrameSize, crc);
1466            }
1467            __finalizeCRC(crc);
1468            return crc;
1469        }
1470    
1471      Sample::~Sample() {      Sample::~Sample() {
1472          Instances--;          Instances--;
1473          if (!Instances && InternalDecompressionBuffer.Size) {          if (!Instances && InternalDecompressionBuffer.Size) {
# Line 1551  namespace { Line 1678  namespace {
1678              EG2Attack                       = 0.0;              EG2Attack                       = 0.0;
1679              EG2Decay1                       = 0.005;              EG2Decay1                       = 0.005;
1680              EG2Sustain                      = 1000;              EG2Sustain                      = 1000;
1681              EG2Release                      = 0.3;              EG2Release                      = 60;
1682              LFO2ControlDepth                = 0;              LFO2ControlDepth                = 0;
1683              LFO2Frequency                   = 1.0;              LFO2Frequency                   = 1.0;
1684              LFO2InternalDepth               = 0;              LFO2InternalDepth               = 0;
# Line 1605  namespace { Line 1732  namespace {
1732              VCFType                         = vcf_type_lowpass;              VCFType                         = vcf_type_lowpass;
1733              memset(DimensionUpperLimits, 127, 8);              memset(DimensionUpperLimits, 127, 8);
1734          }          }
1735            // format extension for EG behavior options, these will *NOT* work with
1736            // Gigasampler/GigaStudio !
1737            RIFF::Chunk* lsde = _3ewl->GetSubChunk(CHUNK_ID_LSDE);
1738            if (lsde) {
1739                eg_opt_t* pEGOpts[2] = { &EG1Options, &EG2Options };
1740                for (int i = 0; i < 2; ++i) {
1741                    unsigned char byte = lsde->ReadUint8();
1742                    pEGOpts[i]->AttackCancel     = byte & 1;
1743                    pEGOpts[i]->AttackHoldCancel = byte & (1 << 1);
1744                    pEGOpts[i]->Decay1Cancel     = byte & (1 << 2);
1745                    pEGOpts[i]->Decay2Cancel     = byte & (1 << 3);
1746                    pEGOpts[i]->ReleaseCancel    = byte & (1 << 4);
1747                }
1748            }
1749    
1750          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,
1751                                                       VelocityResponseDepth,                                                       VelocityResponseDepth,
# Line 1710  namespace { Line 1851  namespace {
1851          }          }
1852      }      }
1853    
1854        void DimensionRegion::serialize(Serialization::Archive* archive) {
1855            // in case this class will become backward incompatible one day,
1856            // then set a version and minimum version for this class like:
1857            //archive->setVersion(*this, 2);
1858            //archive->setMinVersion(*this, 1);
1859    
1860            SRLZ(VelocityUpperLimit);
1861            SRLZ(EG1PreAttack);
1862            SRLZ(EG1Attack);
1863            SRLZ(EG1Decay1);
1864            SRLZ(EG1Decay2);
1865            SRLZ(EG1InfiniteSustain);
1866            SRLZ(EG1Sustain);
1867            SRLZ(EG1Release);
1868            SRLZ(EG1Hold);
1869            SRLZ(EG1Controller);
1870            SRLZ(EG1ControllerInvert);
1871            SRLZ(EG1ControllerAttackInfluence);
1872            SRLZ(EG1ControllerDecayInfluence);
1873            SRLZ(EG1ControllerReleaseInfluence);
1874            SRLZ(LFO1Frequency);
1875            SRLZ(LFO1InternalDepth);
1876            SRLZ(LFO1ControlDepth);
1877            SRLZ(LFO1Controller);
1878            SRLZ(LFO1FlipPhase);
1879            SRLZ(LFO1Sync);
1880            SRLZ(EG2PreAttack);
1881            SRLZ(EG2Attack);
1882            SRLZ(EG2Decay1);
1883            SRLZ(EG2Decay2);
1884            SRLZ(EG2InfiniteSustain);
1885            SRLZ(EG2Sustain);
1886            SRLZ(EG2Release);
1887            SRLZ(EG2Controller);
1888            SRLZ(EG2ControllerInvert);
1889            SRLZ(EG2ControllerAttackInfluence);
1890            SRLZ(EG2ControllerDecayInfluence);
1891            SRLZ(EG2ControllerReleaseInfluence);
1892            SRLZ(LFO2Frequency);
1893            SRLZ(LFO2InternalDepth);
1894            SRLZ(LFO2ControlDepth);
1895            SRLZ(LFO2Controller);
1896            SRLZ(LFO2FlipPhase);
1897            SRLZ(LFO2Sync);
1898            SRLZ(EG3Attack);
1899            SRLZ(EG3Depth);
1900            SRLZ(LFO3Frequency);
1901            SRLZ(LFO3InternalDepth);
1902            SRLZ(LFO3ControlDepth);
1903            SRLZ(LFO3Controller);
1904            SRLZ(LFO3Sync);
1905            SRLZ(VCFEnabled);
1906            SRLZ(VCFType);
1907            SRLZ(VCFCutoffController);
1908            SRLZ(VCFCutoffControllerInvert);
1909            SRLZ(VCFCutoff);
1910            SRLZ(VCFVelocityCurve);
1911            SRLZ(VCFVelocityScale);
1912            SRLZ(VCFVelocityDynamicRange);
1913            SRLZ(VCFResonance);
1914            SRLZ(VCFResonanceDynamic);
1915            SRLZ(VCFResonanceController);
1916            SRLZ(VCFKeyboardTracking);
1917            SRLZ(VCFKeyboardTrackingBreakpoint);
1918            SRLZ(VelocityResponseCurve);
1919            SRLZ(VelocityResponseDepth);
1920            SRLZ(VelocityResponseCurveScaling);
1921            SRLZ(ReleaseVelocityResponseCurve);
1922            SRLZ(ReleaseVelocityResponseDepth);
1923            SRLZ(ReleaseTriggerDecay);
1924            SRLZ(Crossfade);
1925            SRLZ(PitchTrack);
1926            SRLZ(DimensionBypass);
1927            SRLZ(Pan);
1928            SRLZ(SelfMask);
1929            SRLZ(AttenuationController);
1930            SRLZ(InvertAttenuationController);
1931            SRLZ(AttenuationControllerThreshold);
1932            SRLZ(ChannelOffset);
1933            SRLZ(SustainDefeat);
1934            SRLZ(MSDecode);
1935            //SRLZ(SampleStartOffset);
1936            SRLZ(SampleAttenuation);
1937            SRLZ(EG1Options);
1938            SRLZ(EG2Options);
1939    
1940            // derived attributes from DLS::Sampler
1941            SRLZ(FineTune);
1942            SRLZ(Gain);
1943        }
1944    
1945      /**      /**
1946       * Updates the respective member variable and updates @c SampleAttenuation       * Updates the respective member variable and updates @c SampleAttenuation
1947       * which depends on this value.       * which depends on this value.
# Line 1750  namespace { Line 1982  namespace {
1982    
1983          // update '3ewa' chunk with DimensionRegion's current settings          // update '3ewa' chunk with DimensionRegion's current settings
1984    
1985          const uint32_t chunksize = _3ewa->GetNewSize();          const uint32_t chunksize = (uint32_t) _3ewa->GetNewSize();
1986          store32(&pData[0], chunksize); // unknown, always chunk size?          store32(&pData[0], chunksize); // unknown, always chunk size?
1987    
1988          const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);          const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);
# Line 2010  namespace { Line 2242  namespace {
2242          if (chunksize >= 148) {          if (chunksize >= 148) {
2243              memcpy(&pData[140], DimensionUpperLimits, 8);              memcpy(&pData[140], DimensionUpperLimits, 8);
2244          }          }
2245    
2246            // format extension for EG behavior options, these will *NOT* work with
2247            // Gigasampler/GigaStudio !
2248            RIFF::Chunk* lsde = pParentList->GetSubChunk(CHUNK_ID_LSDE);
2249            if (!lsde) {
2250                // only add this "LSDE" chunk if the EG options do not match the
2251                // default EG behavior
2252                eg_opt_t defaultOpt;
2253                if (memcmp(&EG1Options, &defaultOpt, sizeof(eg_opt_t)) ||
2254                    memcmp(&EG2Options, &defaultOpt, sizeof(eg_opt_t)))
2255                {
2256                    lsde = pParentList->AddSubChunk(CHUNK_ID_LSDE, 2);
2257                    // move LSDE chunk to the end of parent list
2258                    pParentList->MoveSubChunk(lsde, (RIFF::Chunk*)NULL);
2259                }
2260            }
2261            if (lsde) {
2262                unsigned char* pData = (unsigned char*) lsde->LoadChunkData();
2263                eg_opt_t* pEGOpts[2] = { &EG1Options, &EG2Options };
2264                for (int i = 0; i < 2; ++i) {
2265                    pData[i] =
2266                        (pEGOpts[i]->AttackCancel     ? 1 : 0) |
2267                        (pEGOpts[i]->AttackHoldCancel ? (1<<1) : 0) |
2268                        (pEGOpts[i]->Decay1Cancel     ? (1<<2) : 0) |
2269                        (pEGOpts[i]->Decay2Cancel     ? (1<<3) : 0) |
2270                        (pEGOpts[i]->ReleaseCancel    ? (1<<4) : 0);
2271                }
2272            }
2273      }      }
2274    
2275      double* DimensionRegion::GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth) {      double* DimensionRegion::GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth) {
# Line 2424  namespace { Line 2684  namespace {
2684    
2685              // unknown controller type              // unknown controller type
2686              default:              default:
2687                  throw gig::Exception("Unknown leverage controller type.");                  decodedcontroller.type = leverage_ctrl_t::type_none;
2688                    decodedcontroller.controller_number = 0;
2689                    printf("Warning: Unknown leverage controller type (0x%x).\n", EncodedController);
2690                    break;
2691          }          }
2692          return decodedcontroller;          return decodedcontroller;
2693      }      }
# Line 3718  namespace { Line 3981  namespace {
3981      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {
3982          uint8_t bits;          uint8_t bits;
3983          int veldim = -1;          int veldim = -1;
3984          int velbitpos;          int velbitpos = 0;
3985          int bitpos = 0;          int bitpos = 0;
3986          int dimregidx = 0;          int dimregidx = 0;
3987          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
# Line 3767  namespace { Line 4030  namespace {
4030      int Region::GetDimensionRegionIndexByValue(const uint DimValues[8]) {      int Region::GetDimensionRegionIndexByValue(const uint DimValues[8]) {
4031          uint8_t bits;          uint8_t bits;
4032          int veldim = -1;          int veldim = -1;
4033          int velbitpos;          int velbitpos = 0;
4034          int bitpos = 0;          int bitpos = 0;
4035          int dimregidx = 0;          int dimregidx = 0;
4036          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
# Line 4116  namespace { Line 4379  namespace {
4379              // to handle potential future extensions of the header              // to handle potential future extensions of the header
4380              ckScri->SetPos(sizeof(int32_t) + headerSize);              ckScri->SetPos(sizeof(int32_t) + headerSize);
4381              // read actual script data              // read actual script data
4382              uint32_t scriptSize = ckScri->GetSize() - ckScri->GetPos();              uint32_t scriptSize = uint32_t(ckScri->GetSize() - ckScri->GetPos());
4383              data.resize(scriptSize);              data.resize(scriptSize);
4384              for (int i = 0; i < scriptSize; ++i)              for (int i = 0; i < scriptSize; ++i)
4385                  data[i] = ckScri->ReadUint8();                  data[i] = ckScri->ReadUint8();
# Line 4167  namespace { Line 4430  namespace {
4430          // recalculate CRC32 check sum          // recalculate CRC32 check sum
4431          __resetCRC(crc);          __resetCRC(crc);
4432          __calculateCRC(&data[0], data.size(), crc);          __calculateCRC(&data[0], data.size(), crc);
4433          __encodeCRC(crc);          __finalizeCRC(crc);
4434          // make sure chunk exists and has the required size          // make sure chunk exists and has the required size
4435          const int chunkSize = 7*sizeof(int32_t) + Name.size() + data.size();          const file_offset_t chunkSize = (file_offset_t) 7*sizeof(int32_t) + Name.size() + data.size();
4436          if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize);          if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize);
4437          else pChunk->Resize(chunkSize);          else pChunk->Resize(chunkSize);
4438          // fill the chunk data to be written to disk          // fill the chunk data to be written to disk
4439          uint8_t* pData = (uint8_t*) pChunk->LoadChunkData();          uint8_t* pData = (uint8_t*) pChunk->LoadChunkData();
4440          int pos = 0;          int pos = 0;
4441          store32(&pData[pos], 6*sizeof(int32_t) + Name.size()); // total header size          store32(&pData[pos], uint32_t(6*sizeof(int32_t) + Name.size())); // total header size
4442          pos += sizeof(int32_t);          pos += sizeof(int32_t);
4443          store32(&pData[pos], Compression);          store32(&pData[pos], Compression);
4444          pos += sizeof(int32_t);          pos += sizeof(int32_t);
# Line 4187  namespace { Line 4450  namespace {
4450          pos += sizeof(int32_t);          pos += sizeof(int32_t);
4451          store32(&pData[pos], crc);          store32(&pData[pos], crc);
4452          pos += sizeof(int32_t);          pos += sizeof(int32_t);
4453          store32(&pData[pos], Name.size());          store32(&pData[pos], (uint32_t) Name.size());
4454          pos += sizeof(int32_t);          pos += sizeof(int32_t);
4455          for (int i = 0; i < Name.size(); ++i, ++pos)          for (int i = 0; i < Name.size(); ++i, ++pos)
4456              pData[pos] = Name[i];              pData[pos] = Name[i];
# Line 4218  namespace { Line 4481  namespace {
4481          return pGroup;          return pGroup;
4482      }      }
4483    
4484        /**
4485         * Make a (semi) deep copy of the Script object given by @a orig
4486         * and assign it to this object. Note: the ScriptGroup this Script
4487         * object belongs to remains untouched by this call.
4488         *
4489         * @param orig - original Script object to be copied from
4490         */
4491        void Script::CopyAssign(const Script* orig) {
4492            Name        = orig->Name;
4493            Compression = orig->Compression;
4494            Encoding    = orig->Encoding;
4495            Language    = orig->Language;
4496            Bypass      = orig->Bypass;
4497            data        = orig->data;
4498        }
4499    
4500      void Script::RemoveAllScriptReferences() {      void Script::RemoveAllScriptReferences() {
4501          File* pFile = pGroup->pFile;          File* pFile = pGroup->pFile;
4502          for (int i = 0; pFile->GetInstrument(i); ++i) {          for (int i = 0; pFile->GetInstrument(i); ++i) {
# Line 4364  namespace { Line 4643  namespace {
4643          EffectSend = 0;          EffectSend = 0;
4644          Attenuation = 0;          Attenuation = 0;
4645          FineTune = 0;          FineTune = 0;
4646          PitchbendRange = 0;          PitchbendRange = 2;
4647          PianoReleaseMode = false;          PianoReleaseMode = false;
4648          DimensionKeyRange.low = 0;          DimensionKeyRange.low = 0;
4649          DimensionKeyRange.high = 0;          DimensionKeyRange.high = 0;
# Line 4539  namespace { Line 4818  namespace {
4818    
4819             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
4820             if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS);             if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS);
4821             const int slotCount = pScriptRefs->size();             const int slotCount = (int) pScriptRefs->size();
4822             const int headerSize = 3 * sizeof(uint32_t);             const int headerSize = 3 * sizeof(uint32_t);
4823             const int slotSize  = 2 * sizeof(uint32_t);             const int slotSize  = 2 * sizeof(uint32_t);
4824             const int totalChunkSize = headerSize + slotCount * slotSize;             const int totalChunkSize = headerSize + slotCount * slotSize;
# Line 4575  namespace { Line 4854  namespace {
4854         if (pScriptRefs && pScriptRefs->size() > 0) {         if (pScriptRefs && pScriptRefs->size() > 0) {
4855             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
4856             RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);             RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4857             const int slotCount = pScriptRefs->size();             const int slotCount = (int) pScriptRefs->size();
4858             const int headerSize = 3 * sizeof(uint32_t);             const int headerSize = 3 * sizeof(uint32_t);
4859             ckSCSL->SetPos(headerSize);             ckSCSL->SetPos(headerSize);
4860             for (int i = 0; i < slotCount; ++i) {             for (int i = 0; i < slotCount; ++i) {
4861                 uint32_t fileOffset =                 uint32_t fileOffset = uint32_t(
4862                      (*pScriptRefs)[i].script->pChunk->GetFilePos() -                      (*pScriptRefs)[i].script->pChunk->GetFilePos() -
4863                      (*pScriptRefs)[i].script->pChunk->GetPos() -                      (*pScriptRefs)[i].script->pChunk->GetPos() -
4864                      CHUNK_HEADER_SIZE(ckSCSL->GetFile()->GetFileOffsetSize());                      CHUNK_HEADER_SIZE(ckSCSL->GetFile()->GetFileOffsetSize())
4865                   );
4866                 ckSCSL->WriteUint32(&fileOffset);                 ckSCSL->WriteUint32(&fileOffset);
4867                 // jump over flags entry (containing the bypass flag)                 // jump over flags entry (containing the bypass flag)
4868                 ckSCSL->SetPos(sizeof(uint32_t), RIFF::stream_curpos);                 ckSCSL->SetPos(sizeof(uint32_t), RIFF::stream_curpos);
# Line 4642  namespace { Line 4922  namespace {
4922          RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);          RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
4923          Region* pNewRegion = new Region(this, rgn);          Region* pNewRegion = new Region(this, rgn);
4924          pRegions->push_back(pNewRegion);          pRegions->push_back(pNewRegion);
4925          Regions = pRegions->size();          Regions = (uint32_t) pRegions->size();
4926          // update Region key table for fast lookup          // update Region key table for fast lookup
4927          UpdateRegionKeyTable();          UpdateRegionKeyTable();
4928          // done          // done
# Line 4788  namespace { Line 5068  namespace {
5068                  for (uint s = 0; group->GetScript(s); ++s) {                  for (uint s = 0; group->GetScript(s); ++s) {
5069                      Script* script = group->GetScript(s);                      Script* script = group->GetScript(s);
5070                      if (script->pChunk) {                      if (script->pChunk) {
5071                          uint32_t offset = script->pChunk->GetFilePos() -                          uint32_t offset = uint32_t(
5072                                            script->pChunk->GetPos() -                              script->pChunk->GetFilePos() -
5073                                            CHUNK_HEADER_SIZE(script->pChunk->GetFile()->GetFileOffsetSize());                              script->pChunk->GetPos() -
5074                                CHUNK_HEADER_SIZE(script->pChunk->GetFile()->GetFileOffsetSize())
5075                            );
5076                          if (offset == soughtOffset)                          if (offset == soughtOffset)
5077                          {                          {
5078                              _ScriptPooolRef ref;                              _ScriptPooolRef ref;
# Line 4915  namespace { Line 5197  namespace {
5197       */       */
5198      void Instrument::RemoveScript(Script* pScript) {      void Instrument::RemoveScript(Script* pScript) {
5199          LoadScripts();          LoadScripts();
5200          for (int i = pScriptRefs->size() - 1; i >= 0; --i) {          for (ssize_t i = pScriptRefs->size() - 1; i >= 0; --i) {
5201              if ((*pScriptRefs)[i].script == pScript) {              if ((*pScriptRefs)[i].script == pScript) {
5202                  pScriptRefs->erase( pScriptRefs->begin() + i );                  pScriptRefs->erase( pScriptRefs->begin() + i );
5203              }              }
# Line 4937  namespace { Line 5219  namespace {
5219       * gigedit.       * gigedit.
5220       */       */
5221      uint Instrument::ScriptSlotCount() const {      uint Instrument::ScriptSlotCount() const {
5222          return pScriptRefs ? pScriptRefs->size() : scriptPoolFileOffsets.size();          return uint(pScriptRefs ? pScriptRefs->size() : scriptPoolFileOffsets.size());
5223      }      }
5224    
5225      /** @brief Whether script execution shall be skipped.      /** @brief Whether script execution shall be skipped.
# Line 5361  namespace { Line 5643  namespace {
5643              }              }
5644          }          }
5645          String name(pRIFF->GetFileName());          String name(pRIFF->GetFileName());
5646          int nameLen = name.length();          int nameLen = (int) name.length();
5647          char suffix[6];          char suffix[6];
5648          if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;          if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;
5649    
# Line 5377  namespace { Line 5659  namespace {
5659                          __notify_progress(pProgress, subprogress);                          __notify_progress(pProgress, subprogress);
5660    
5661                          file_offset_t waveFileOffset = wave->GetFilePos();                          file_offset_t waveFileOffset = wave->GetFilePos();
5662                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo, iSampleIndex));
5663    
5664                          iSampleIndex++;                          iSampleIndex++;
5665                      }                      }
# Line 5530  namespace { Line 5812  namespace {
5812              mGroups[pFile->GetSample(i)->GetGroup()]->AddSample(s);              mGroups[pFile->GetSample(i)->GetGroup()]->AddSample(s);
5813              mSamples[pFile->GetSample(i)] = s;              mSamples[pFile->GetSample(i)] = s;
5814          }          }
5815            
5816            // clone script groups and their scripts
5817            for (int iGroup = 0; pFile->GetScriptGroup(iGroup); ++iGroup) {
5818                ScriptGroup* sg = pFile->GetScriptGroup(iGroup);
5819                ScriptGroup* dg = AddScriptGroup();
5820                dg->Name = "COPY" + ToString(iCallCount) + "_" + sg->Name;
5821                for (int iScript = 0; sg->GetScript(iScript); ++iScript) {
5822                    Script* ss = sg->GetScript(iScript);
5823                    Script* ds = dg->AddScript();
5824                    ds->CopyAssign(ss);
5825                }
5826            }
5827    
5828          //BUG: For some reason this method only works with this additional          //BUG: For some reason this method only works with this additional
5829          //     Save() call in between here.          //     Save() call in between here.
5830          //          //
# Line 5615  namespace { Line 5909  namespace {
5909          if (!_3crc) return;          if (!_3crc) return;
5910    
5911          // get the index of the sample          // get the index of the sample
5912          int iWaveIndex = -1;          int iWaveIndex = GetWaveTableIndexOf(pSample);
         File::SampleList::iterator iter = pSamples->begin();  
         File::SampleList::iterator end  = pSamples->end();  
         for (int index = 0; iter != end; ++iter, ++index) {  
             if (*iter == pSample) {  
                 iWaveIndex = index;  
                 break;  
             }  
         }  
5913          if (iWaveIndex < 0) throw gig::Exception("Could not update crc, could not find sample");          if (iWaveIndex < 0) throw gig::Exception("Could not update crc, could not find sample");
5914    
5915          // write the CRC-32 checksum to disk          // write the CRC-32 checksum to disk
5916          _3crc->SetPos(iWaveIndex * 8);          _3crc->SetPos(iWaveIndex * 8);
5917          uint32_t tmp = 1;          uint32_t one = 1;
5918          _3crc->WriteUint32(&tmp); // unknown, always 1?          _3crc->WriteUint32(&one); // always 1
5919          _3crc->WriteUint32(&crc);          _3crc->WriteUint32(&crc);
5920      }      }
5921    
5922        uint32_t File::GetSampleChecksum(Sample* pSample) {
5923            // get the index of the sample
5924            int iWaveIndex = GetWaveTableIndexOf(pSample);
5925            if (iWaveIndex < 0) throw gig::Exception("Could not retrieve reference crc of sample, could not resolve sample's wave table index");
5926    
5927            return GetSampleChecksumByIndex(iWaveIndex);
5928        }
5929    
5930        uint32_t File::GetSampleChecksumByIndex(int index) {
5931            if (index < 0) throw gig::Exception("Could not retrieve reference crc of sample, invalid wave pool index of sample");
5932    
5933            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
5934            if (!_3crc) throw gig::Exception("Could not retrieve reference crc of sample, no checksums stored for this file yet");
5935            uint8_t* pData = (uint8_t*) _3crc->LoadChunkData();
5936            if (!pData) throw gig::Exception("Could not retrieve reference crc of sample, no checksums stored for this file yet");
5937    
5938            // read the CRC-32 checksum directly from disk
5939            size_t pos = index * 8;
5940            if (pos + 8 > _3crc->GetNewSize())
5941                throw gig::Exception("Could not retrieve reference crc of sample, could not seek to required position in crc chunk");
5942    
5943            uint32_t one = load32(&pData[pos]); // always 1
5944            if (one != 1)
5945                throw gig::Exception("Could not retrieve reference crc of sample, because reference checksum table is damaged");
5946    
5947            return load32(&pData[pos+4]);
5948        }
5949    
5950        int File::GetWaveTableIndexOf(gig::Sample* pSample) {
5951            if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned
5952            File::SampleList::iterator iter = pSamples->begin();
5953            File::SampleList::iterator end  = pSamples->end();
5954            for (int index = 0; iter != end; ++iter, ++index)
5955                if (*iter == pSample)
5956                    return index;
5957            return -1;
5958        }
5959    
5960        /**
5961         * Checks whether the file's "3CRC" chunk was damaged. This chunk contains
5962         * the CRC32 check sums of all samples' raw wave data.
5963         *
5964         * @return true if 3CRC chunk is OK, or false if 3CRC chunk is damaged
5965         */
5966        bool File::VerifySampleChecksumTable() {
5967            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
5968            if (!_3crc) return false;
5969            if (_3crc->GetNewSize() <= 0) return false;
5970            if (_3crc->GetNewSize() % 8) return false;
5971            if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned
5972            if (_3crc->GetNewSize() != pSamples->size() * 8) return false;
5973    
5974            const file_offset_t n = _3crc->GetNewSize() / 8;
5975    
5976            uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
5977            if (!pData) return false;
5978    
5979            for (file_offset_t i = 0; i < n; ++i) {
5980                uint32_t one = pData[i*2];
5981                if (one != 1) return false;
5982            }
5983    
5984            return true;
5985        }
5986    
5987        /**
5988         * Recalculates CRC32 checksums for all samples and rebuilds this gig
5989         * file's checksum table with those new checksums. This might usually
5990         * just be necessary if the checksum table was damaged.
5991         *
5992         * @e IMPORTANT: The current implementation of this method only works
5993         * with files that have not been modified since it was loaded, because
5994         * it expects that no externally caused file structure changes are
5995         * required!
5996         *
5997         * Due to the expectation above, this method is currently protected
5998         * and actually only used by the command line tool "gigdump" yet.
5999         *
6000         * @returns true if Save() is required to be called after this call,
6001         *          false if no further action is required
6002         */
6003        bool File::RebuildSampleChecksumTable() {
6004            // make sure sample chunks were scanned
6005            if (!pSamples) GetFirstSample();
6006    
6007            bool bRequiresSave = false;
6008    
6009            // make sure "3CRC" chunk exists with required size
6010            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6011            if (!_3crc) {
6012                _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
6013                // the order of einf and 3crc is not the same in v2 and v3
6014                RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
6015                if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);
6016                bRequiresSave = true;
6017            } else if (_3crc->GetNewSize() != pSamples->size() * 8) {
6018                _3crc->Resize(pSamples->size() * 8);
6019                bRequiresSave = true;
6020            }
6021    
6022            if (bRequiresSave) { // refill CRC table for all samples in RAM ...
6023                uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6024                {
6025                    File::SampleList::iterator iter = pSamples->begin();
6026                    File::SampleList::iterator end  = pSamples->end();
6027                    for (; iter != end; ++iter) {
6028                        gig::Sample* pSample = (gig::Sample*) *iter;
6029                        int index = GetWaveTableIndexOf(pSample);
6030                        if (index < 0) throw gig::Exception("Could not rebuild crc table for samples, wave table index of a sample could not be resolved");
6031                        pData[index*2]   = 1; // always 1
6032                        pData[index*2+1] = pSample->CalculateWaveDataChecksum();
6033                    }
6034                }
6035            } else { // no file structure changes necessary, so directly write to disk and we are done ...
6036                // make sure file is in write mode
6037                pRIFF->SetMode(RIFF::stream_mode_read_write);
6038                {
6039                    File::SampleList::iterator iter = pSamples->begin();
6040                    File::SampleList::iterator end  = pSamples->end();
6041                    for (; iter != end; ++iter) {
6042                        gig::Sample* pSample = (gig::Sample*) *iter;
6043                        int index = GetWaveTableIndexOf(pSample);
6044                        if (index < 0) throw gig::Exception("Could not rebuild crc table for samples, wave table index of a sample could not be resolved");
6045                        pSample->crc  = pSample->CalculateWaveDataChecksum();
6046                        SetSampleChecksum(pSample, pSample->crc);
6047                    }
6048                }
6049            }
6050    
6051            return bRequiresSave;
6052        }
6053    
6054      Group* File::GetFirstGroup() {      Group* File::GetFirstGroup() {
6055          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
6056          // there must always be at least one group          // there must always be at least one group
# Line 5950  namespace { Line 6368  namespace {
6368          // Note that there are several fields with unknown use. These          // Note that there are several fields with unknown use. These
6369          // are set to zero.          // are set to zero.
6370    
6371          int sublen = pSamples->size() / 8 + 49;          int sublen = int(pSamples->size() / 8 + 49);
6372          int einfSize = (Instruments + 1) * sublen;          int einfSize = (Instruments + 1) * sublen;
6373    
6374          RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);          RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
# Line 6023  namespace { Line 6441  namespace {
6441                  store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);                  store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);
6442                  // next 8 bytes unknown                  // next 8 bytes unknown
6443                  store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);                  store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);
6444                  store32(&pData[(instrumentIdx + 1) * sublen + 40], pSamples->size());                  store32(&pData[(instrumentIdx + 1) * sublen + 40], (uint32_t) pSamples->size());
6445                  // next 4 bytes unknown                  // next 4 bytes unknown
6446    
6447                  totnbregions += instrument->Regions;                  totnbregions += instrument->Regions;
# Line 6041  namespace { Line 6459  namespace {
6459              store32(&pData[24], totnbloops);              store32(&pData[24], totnbloops);
6460              // next 8 bytes unknown              // next 8 bytes unknown
6461              // next 4 bytes unknown, not always 0              // next 4 bytes unknown, not always 0
6462              store32(&pData[40], pSamples->size());              store32(&pData[40], (uint32_t) pSamples->size());
6463              // next 4 bytes unknown              // next 4 bytes unknown
6464          }          }
6465    
6466          // update 3crc chunk          // update 3crc chunk
6467    
6468          // The 3crc chunk contains CRC-32 checksums for the          // The 3crc chunk contains CRC-32 checksums for the
6469          // samples. The actual checksum values will be filled in          // samples. When saving a gig file to disk, we first update the 3CRC
6470          // later, by Sample::Write.          // chunk here (in RAM) with the old crc values which we read from the
6471            // 3CRC chunk when we opened the file (available with gig::Sample::crc
6472            // member variable). This step is required, because samples might have
6473            // been deleted by the user since the file was opened, which in turn
6474            // changes the order of the (i.e. old) checksums within the 3crc chunk.
6475            // If a sample was conciously modified by the user (that is if
6476            // Sample::Write() was called later on) then Sample::Write() will just
6477            // update the respective individual checksum(s) directly on disk and
6478            // leaves all other sample checksums untouched.
6479    
6480          RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);          RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6481          if (_3crc) {          if (_3crc) {
6482              _3crc->Resize(pSamples->size() * 8);              _3crc->Resize(pSamples->size() * 8);
6483          } else if (newFile) {          } else /*if (newFile)*/ {
6484              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
             _3crc->LoadChunkData();  
   
6485              // the order of einf and 3crc is not the same in v2 and v3              // the order of einf and 3crc is not the same in v2 and v3
6486              if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);              if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);
6487          }          }
6488            { // must be performed in RAM here ...
6489                uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6490                if (pData) {
6491                    File::SampleList::iterator iter = pSamples->begin();
6492                    File::SampleList::iterator end  = pSamples->end();
6493                    for (int index = 0; iter != end; ++iter, ++index) {
6494                        gig::Sample* pSample = (gig::Sample*) *iter;
6495                        pData[index*2]   = 1; // always 1
6496                        pData[index*2+1] = pSample->crc;
6497                    }
6498                }
6499            }
6500      }      }
6501            
6502      void File::UpdateFileOffsets() {      void File::UpdateFileOffsets() {
# Line 6105  namespace { Line 6541  namespace {
6541  // *************** Exception ***************  // *************** Exception ***************
6542  // *  // *
6543    
6544      Exception::Exception(String Message) : DLS::Exception(Message) {      Exception::Exception() : DLS::Exception() {
6545        }
6546    
6547        Exception::Exception(String format, ...) : DLS::Exception() {
6548            va_list arg;
6549            va_start(arg, format);
6550            Message = assemble(format, arg);
6551            va_end(arg);
6552        }
6553    
6554        Exception::Exception(String format, va_list arg) : DLS::Exception() {
6555            Message = assemble(format, arg);
6556      }      }
6557    
6558      void Exception::PrintMessage() {      void Exception::PrintMessage() {

Legend:
Removed from v.2923  
changed lines
  Added in v.3327

  ViewVC Help
Powered by ViewVC