/[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 2543 by schoenebeck, Sat May 10 02:06:58 2014 UTC revision 2640 by schoenebeck, Mon Jun 16 14:54:06 2014 UTC
# Line 28  Line 28 
28  #include <algorithm>  #include <algorithm>
29  #include <math.h>  #include <math.h>
30  #include <iostream>  #include <iostream>
31    #include <assert.h>
32    
33  /// Initial size of the sample buffer which is used for decompression of  /// Initial size of the sample buffer which is used for decompression of
34  /// compressed sample wave streams - this value should always be bigger than  /// compressed sample wave streams - this value should always be bigger than
# Line 1708  namespace { Line 1709  namespace {
1709          //NOTE: copy code copied from assignment constructor above, see comment there as well          //NOTE: copy code copied from assignment constructor above, see comment there as well
1710                    
1711          *this = *orig; // default memberwise shallow copy of all parameters          *this = *orig; // default memberwise shallow copy of all parameters
1712            
1713            // restore members that shall not be altered
1714          pParentList = p; // restore the chunk pointer          pParentList = p; // restore the chunk pointer
1715            pRegion = pOriginalRegion;
1716                    
1717          // only take the raw sample reference & parent region reference if the          // only take the raw sample reference reference if the
1718          // two DimensionRegion objects are part of the same file          // two DimensionRegion objects are part of the same file
1719          if (pOriginalRegion->GetParent()->GetParent() != orig->pRegion->GetParent()->GetParent()) {          if (pOriginalRegion->GetParent()->GetParent() != orig->pRegion->GetParent()->GetParent()) {
             pRegion = pOriginalRegion;  
1720              pSample = pOriginalSample;              pSample = pOriginalSample;
1721          }          }
1722                    
# Line 3053  namespace { Line 3056  namespace {
3056              memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);              memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);
3057    
3058              // move 3prg to last position              // move 3prg to last position
3059              pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), 0);              pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), (RIFF::Chunk*)NULL);
3060          }          }
3061    
3062          // update dimension definitions in '3lnk' chunk          // update dimension definitions in '3lnk' chunk
# Line 3199  namespace { Line 3202  namespace {
3202       *                        dimension bits limit is violated       *                        dimension bits limit is violated
3203       */       */
3204      void Region::AddDimension(dimension_def_t* pDimDef) {      void Region::AddDimension(dimension_def_t* pDimDef) {
3205            // some initial sanity checks of the given dimension definition
3206            if (pDimDef->zones < 2)
3207                throw gig::Exception("Could not add new dimension, amount of requested zones must always be at least two");
3208            if (pDimDef->bits < 1)
3209                throw gig::Exception("Could not add new dimension, amount of requested requested zone bits must always be at least one");
3210            if (pDimDef->dimension == dimension_samplechannel) {
3211                if (pDimDef->zones != 2)
3212                    throw gig::Exception("Could not add new 'sample channel' dimensions, the requested amount of zones must always be 2 for this dimension type");
3213                if (pDimDef->bits != 1)
3214                    throw gig::Exception("Could not add new 'sample channel' dimensions, the requested amount of zone bits must always be 1 for this dimension type");
3215            }
3216    
3217          // check if max. amount of dimensions reached          // check if max. amount of dimensions reached
3218          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
3219          const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;          const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;
# Line 3374  namespace { Line 3389  namespace {
3389          if (pDimDef->dimension == dimension_layer) Layers = 1;          if (pDimDef->dimension == dimension_layer) Layers = 1;
3390      }      }
3391    
3392        /** @brief Delete one split zone of a dimension (decrement zone amount).
3393         *
3394         * Instead of deleting an entire dimensions, this method will only delete
3395         * one particular split zone given by @a zone of the Region's dimension
3396         * given by @a type. So this method will simply decrement the amount of
3397         * zones by one of the dimension in question. To be able to do that, the
3398         * respective dimension must exist on this Region and it must have at least
3399         * 3 zones. All DimensionRegion objects associated with the zone will be
3400         * deleted.
3401         *
3402         * @param type - identifies the dimension where a zone shall be deleted
3403         * @param zone - index of the dimension split zone that shall be deleted
3404         * @throws gig::Exception if requested zone could not be deleted
3405         */
3406        void Region::DeleteDimensionZone(dimension_t type, int zone) {
3407            dimension_def_t* oldDef = GetDimensionDefinition(type);
3408            if (!oldDef)
3409                throw gig::Exception("Could not delete dimension zone, no such dimension of given type");
3410            if (oldDef->zones <= 2)
3411                throw gig::Exception("Could not delete dimension zone, because it would end up with only one zone.");
3412            if (zone < 0 || zone >= oldDef->zones)
3413                throw gig::Exception("Could not delete dimension zone, requested zone index out of bounds.");
3414    
3415            const int newZoneSize = oldDef->zones - 1;
3416    
3417            // create a temporary Region which just acts as a temporary copy
3418            // container and will be deleted at the end of this function and will
3419            // also not be visible through the API during this process
3420            gig::Region* tempRgn = NULL;
3421            {
3422                // adding these temporary chunks is probably not even necessary
3423                Instrument* instr = static_cast<Instrument*>(GetParent());
3424                RIFF::List* pCkInstrument = instr->pCkInstrument;
3425                RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
3426                if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
3427                RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
3428                tempRgn = new Region(instr, rgn);
3429            }
3430    
3431            // copy this region's dimensions (with already the dimension split size
3432            // requested by the arguments of this method call) to the temporary
3433            // region, and don't use Region::CopyAssign() here for this task, since
3434            // it would also alter fast lookup helper variables here and there
3435            dimension_def_t newDef;
3436            for (int i = 0; i < Dimensions; ++i) {
3437                dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
3438                // is this the dimension requested by the method arguments? ...
3439                if (def.dimension == type) { // ... if yes, decrement zone amount by one
3440                    def.zones = newZoneSize;
3441                    if ((1 << (def.bits - 1)) == def.zones) def.bits--;
3442                    newDef = def;
3443                }
3444                tempRgn->AddDimension(&def);
3445            }
3446    
3447            // find the dimension index in the tempRegion which is the dimension
3448            // type passed to this method (paranoidly expecting different order)
3449            int tempReducedDimensionIndex = -1;
3450            for (int d = 0; d < tempRgn->Dimensions; ++d) {
3451                if (tempRgn->pDimensionDefinitions[d].dimension == type) {
3452                    tempReducedDimensionIndex = d;
3453                    break;
3454                }
3455            }
3456    
3457            // copy dimension regions from this region to the temporary region
3458            for (int iDst = 0; iDst < 256; ++iDst) {
3459                DimensionRegion* dstDimRgn = tempRgn->pDimensionRegions[iDst];
3460                if (!dstDimRgn) continue;
3461                std::map<dimension_t,int> dimCase;
3462                bool isValidZone = true;
3463                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3464                    const int dstBits = tempRgn->pDimensionDefinitions[d].bits;
3465                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3466                        (iDst >> baseBits) & ((1 << dstBits) - 1);
3467                    baseBits += dstBits;
3468                    // there are also DimensionRegion objects of unused zones, skip them
3469                    if (dimCase[tempRgn->pDimensionDefinitions[d].dimension] >= tempRgn->pDimensionDefinitions[d].zones) {
3470                        isValidZone = false;
3471                        break;
3472                    }
3473                }
3474                if (!isValidZone) continue;
3475                // a bit paranoid: cope with the chance that the dimensions would
3476                // have different order in source and destination regions
3477                const bool isLastZone = (dimCase[type] == newZoneSize - 1);
3478                if (dimCase[type] >= zone) dimCase[type]++;
3479                DimensionRegion* srcDimRgn = GetDimensionRegionByBit(dimCase);
3480                dstDimRgn->CopyAssign(srcDimRgn);
3481                // if this is the upper most zone of the dimension passed to this
3482                // method, then correct (raise) its upper limit to 127
3483                if (newDef.split_type == split_type_normal && isLastZone)
3484                    dstDimRgn->DimensionUpperLimits[tempReducedDimensionIndex] = 127;
3485            }
3486    
3487            // now tempRegion's dimensions and DimensionRegions basically reflect
3488            // what we wanted to get for this actual Region here, so we now just
3489            // delete and recreate the dimension in question with the new amount
3490            // zones and then copy back from tempRegion      
3491            DeleteDimension(oldDef);
3492            AddDimension(&newDef);
3493            for (int iSrc = 0; iSrc < 256; ++iSrc) {
3494                DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
3495                if (!srcDimRgn) continue;
3496                std::map<dimension_t,int> dimCase;
3497                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3498                    const int srcBits = tempRgn->pDimensionDefinitions[d].bits;
3499                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3500                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
3501                    baseBits += srcBits;
3502                }
3503                // a bit paranoid: cope with the chance that the dimensions would
3504                // have different order in source and destination regions
3505                DimensionRegion* dstDimRgn = GetDimensionRegionByBit(dimCase);
3506                if (!dstDimRgn) continue;
3507                dstDimRgn->CopyAssign(srcDimRgn);
3508            }
3509    
3510            // delete temporary region
3511            delete tempRgn;
3512    
3513            UpdateVelocityTable();
3514        }
3515    
3516        /** @brief Divide split zone of a dimension in two (increment zone amount).
3517         *
3518         * This will increment the amount of zones for the dimension (given by
3519         * @a type) by one. It will do so by dividing the zone (given by @a zone)
3520         * in the middle of its zone range in two. So the two zones resulting from
3521         * the zone being splitted, will be an equivalent copy regarding all their
3522         * articulation informations and sample reference. The two zones will only
3523         * differ in their zone's upper limit
3524         * (DimensionRegion::DimensionUpperLimits).
3525         *
3526         * @param type - identifies the dimension where a zone shall be splitted
3527         * @param zone - index of the dimension split zone that shall be splitted
3528         * @throws gig::Exception if requested zone could not be splitted
3529         */
3530        void Region::SplitDimensionZone(dimension_t type, int zone) {
3531            dimension_def_t* oldDef = GetDimensionDefinition(type);
3532            if (!oldDef)
3533                throw gig::Exception("Could not split dimension zone, no such dimension of given type");
3534            if (zone < 0 || zone >= oldDef->zones)
3535                throw gig::Exception("Could not split dimension zone, requested zone index out of bounds.");
3536    
3537            const int newZoneSize = oldDef->zones + 1;
3538    
3539            // create a temporary Region which just acts as a temporary copy
3540            // container and will be deleted at the end of this function and will
3541            // also not be visible through the API during this process
3542            gig::Region* tempRgn = NULL;
3543            {
3544                // adding these temporary chunks is probably not even necessary
3545                Instrument* instr = static_cast<Instrument*>(GetParent());
3546                RIFF::List* pCkInstrument = instr->pCkInstrument;
3547                RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
3548                if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
3549                RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
3550                tempRgn = new Region(instr, rgn);
3551            }
3552    
3553            // copy this region's dimensions (with already the dimension split size
3554            // requested by the arguments of this method call) to the temporary
3555            // region, and don't use Region::CopyAssign() here for this task, since
3556            // it would also alter fast lookup helper variables here and there
3557            dimension_def_t newDef;
3558            for (int i = 0; i < Dimensions; ++i) {
3559                dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
3560                // is this the dimension requested by the method arguments? ...
3561                if (def.dimension == type) { // ... if yes, increment zone amount by one
3562                    def.zones = newZoneSize;
3563                    if ((1 << oldDef->bits) < newZoneSize) def.bits++;
3564                    newDef = def;
3565                }
3566                tempRgn->AddDimension(&def);
3567            }
3568    
3569            // find the dimension index in the tempRegion which is the dimension
3570            // type passed to this method (paranoidly expecting different order)
3571            int tempIncreasedDimensionIndex = -1;
3572            for (int d = 0; d < tempRgn->Dimensions; ++d) {
3573                if (tempRgn->pDimensionDefinitions[d].dimension == type) {
3574                    tempIncreasedDimensionIndex = d;
3575                    break;
3576                }
3577            }
3578    
3579            // copy dimension regions from this region to the temporary region
3580            for (int iSrc = 0; iSrc < 256; ++iSrc) {
3581                DimensionRegion* srcDimRgn = pDimensionRegions[iSrc];
3582                if (!srcDimRgn) continue;
3583                std::map<dimension_t,int> dimCase;
3584                bool isValidZone = true;
3585                for (int d = 0, baseBits = 0; d < Dimensions; ++d) {
3586                    const int srcBits = pDimensionDefinitions[d].bits;
3587                    dimCase[pDimensionDefinitions[d].dimension] =
3588                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
3589                    // there are also DimensionRegion objects for unused zones, skip them
3590                    if (dimCase[pDimensionDefinitions[d].dimension] >= pDimensionDefinitions[d].zones) {
3591                        isValidZone = false;
3592                        break;
3593                    }
3594                    baseBits += srcBits;
3595                }
3596                if (!isValidZone) continue;
3597                // a bit paranoid: cope with the chance that the dimensions would
3598                // have different order in source and destination regions            
3599                if (dimCase[type] > zone) dimCase[type]++;
3600                DimensionRegion* dstDimRgn = tempRgn->GetDimensionRegionByBit(dimCase);
3601                dstDimRgn->CopyAssign(srcDimRgn);
3602                // if this is the requested zone to be splitted, then also copy
3603                // the source DimensionRegion to the newly created target zone
3604                // and set the old zones upper limit lower
3605                if (dimCase[type] == zone) {
3606                    // lower old zones upper limit
3607                    if (newDef.split_type == split_type_normal) {
3608                        const int high =
3609                            dstDimRgn->DimensionUpperLimits[tempIncreasedDimensionIndex];
3610                        int low = 0;
3611                        if (zone > 0) {
3612                            std::map<dimension_t,int> lowerCase = dimCase;
3613                            lowerCase[type]--;
3614                            DimensionRegion* dstDimRgnLow = tempRgn->GetDimensionRegionByBit(lowerCase);
3615                            low = dstDimRgnLow->DimensionUpperLimits[tempIncreasedDimensionIndex];
3616                        }
3617                        dstDimRgn->DimensionUpperLimits[tempIncreasedDimensionIndex] = low + (high - low) / 2;
3618                    }
3619                    // fill the newly created zone of the divided zone as well
3620                    dimCase[type]++;
3621                    dstDimRgn = tempRgn->GetDimensionRegionByBit(dimCase);
3622                    dstDimRgn->CopyAssign(srcDimRgn);
3623                }
3624            }
3625    
3626            // now tempRegion's dimensions and DimensionRegions basically reflect
3627            // what we wanted to get for this actual Region here, so we now just
3628            // delete and recreate the dimension in question with the new amount
3629            // zones and then copy back from tempRegion      
3630            DeleteDimension(oldDef);
3631            AddDimension(&newDef);
3632            for (int iSrc = 0; iSrc < 256; ++iSrc) {
3633                DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
3634                if (!srcDimRgn) continue;
3635                std::map<dimension_t,int> dimCase;
3636                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3637                    const int srcBits = tempRgn->pDimensionDefinitions[d].bits;
3638                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3639                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
3640                    baseBits += srcBits;
3641                }
3642                // a bit paranoid: cope with the chance that the dimensions would
3643                // have different order in source and destination regions
3644                DimensionRegion* dstDimRgn = GetDimensionRegionByBit(dimCase);
3645                if (!dstDimRgn) continue;
3646                dstDimRgn->CopyAssign(srcDimRgn);
3647            }
3648    
3649            // delete temporary region
3650            delete tempRgn;
3651    
3652            UpdateVelocityTable();
3653        }
3654    
3655        /** @brief Change type of an existing dimension.
3656         *
3657         * Alters the dimension type of a dimension already existing on this
3658         * region. If there is currently no dimension on this Region with type
3659         * @a oldType, then this call with throw an Exception. Likewise there are
3660         * cases where the requested dimension type cannot be performed. For example
3661         * if the new dimension type shall be gig::dimension_samplechannel, and the
3662         * current dimension has more than 2 zones. In such cases an Exception is
3663         * thrown as well.
3664         *
3665         * @param oldType - identifies the existing dimension to be changed
3666         * @param newType - to which dimension type it should be changed to
3667         * @throws gig::Exception if requested change cannot be performed
3668         */
3669        void Region::SetDimensionType(dimension_t oldType, dimension_t newType) {
3670            if (oldType == newType) return;
3671            dimension_def_t* def = GetDimensionDefinition(oldType);
3672            if (!def)
3673                throw gig::Exception("No dimension with provided old dimension type exists on this region");
3674            if (newType == dimension_samplechannel && def->zones != 2)
3675                throw gig::Exception("Cannot change to dimension type 'sample channel', because existing dimension does not have 2 zones");
3676            if (GetDimensionDefinition(newType))
3677                throw gig::Exception("There is already a dimension with requested new dimension type on this region");
3678            def->dimension  = newType;
3679            def->split_type = __resolveSplitType(newType);
3680        }
3681    
3682        DimensionRegion* Region::GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase) {
3683            uint8_t bits[8] = {};
3684            for (std::map<dimension_t,int>::const_iterator it = DimCase.begin();
3685                 it != DimCase.end(); ++it)
3686            {
3687                for (int d = 0; d < Dimensions; ++d) {
3688                    if (pDimensionDefinitions[d].dimension == it->first) {
3689                        bits[d] = it->second;
3690                        goto nextDimCaseSlice;
3691                    }
3692                }
3693                assert(false); // do crash ... too harsh maybe ? ignore it instead ?
3694                nextDimCaseSlice:
3695                ; // noop
3696            }
3697            return GetDimensionRegionByBit(bits);
3698        }
3699    
3700        /**
3701         * Searches in the current Region for a dimension of the given dimension
3702         * type and returns the precise configuration of that dimension in this
3703         * Region.
3704         *
3705         * @param type - dimension type of the sought dimension
3706         * @returns dimension definition or NULL if there is no dimension with
3707         *          sought type in this Region.
3708         */
3709        dimension_def_t* Region::GetDimensionDefinition(dimension_t type) {
3710            for (int i = 0; i < Dimensions; ++i)
3711                if (pDimensionDefinitions[i].dimension == type)
3712                    return &pDimensionDefinitions[i];
3713            return NULL;
3714        }
3715    
3716      Region::~Region() {      Region::~Region() {
3717          for (int i = 0; i < 256; i++) {          for (int i = 0; i < 256; i++) {
3718              if (pDimensionRegions[i]) delete pDimensionRegions[i];              if (pDimensionRegions[i]) delete pDimensionRegions[i];
# Line 3431  namespace { Line 3770  namespace {
3770              }              }
3771              bitpos += pDimensionDefinitions[i].bits;              bitpos += pDimensionDefinitions[i].bits;
3772          }          }
3773          DimensionRegion* dimreg = pDimensionRegions[dimregidx];          DimensionRegion* dimreg = pDimensionRegions[dimregidx & 255];
3774            if (!dimreg) return NULL;
3775          if (veldim != -1) {          if (veldim != -1) {
3776              // (dimreg is now the dimension region for the lowest velocity)              // (dimreg is now the dimension region for the lowest velocity)
3777              if (dimreg->VelocityTable) // custom defined zone ranges              if (dimreg->VelocityTable) // custom defined zone ranges
3778                  bits = dimreg->VelocityTable[DimValues[veldim]];                  bits = dimreg->VelocityTable[DimValues[veldim] & 127];
3779              else // normal split type              else // normal split type
3780                  bits = uint8_t(DimValues[veldim] / pDimensionDefinitions[veldim].zone_size);                  bits = uint8_t((DimValues[veldim] & 127) / pDimensionDefinitions[veldim].zone_size);
3781    
3782              dimregidx |= bits << velbitpos;              const uint8_t limiter_mask = (1 << pDimensionDefinitions[veldim].bits) - 1;
3783              dimreg = pDimensionRegions[dimregidx];              dimregidx |= (bits & limiter_mask) << velbitpos;
3784                dimreg = pDimensionRegions[dimregidx & 255];
3785          }          }
3786          return dimreg;          return dimreg;
3787      }      }
3788    
3789        int Region::GetDimensionRegionIndexByValue(const uint DimValues[8]) {
3790            uint8_t bits;
3791            int veldim = -1;
3792            int velbitpos;
3793            int bitpos = 0;
3794            int dimregidx = 0;
3795            for (uint i = 0; i < Dimensions; i++) {
3796                if (pDimensionDefinitions[i].dimension == dimension_velocity) {
3797                    // the velocity dimension must be handled after the other dimensions
3798                    veldim = i;
3799                    velbitpos = bitpos;
3800                } else {
3801                    switch (pDimensionDefinitions[i].split_type) {
3802                        case split_type_normal:
3803                            if (pDimensionRegions[0]->DimensionUpperLimits[i]) {
3804                                // gig3: all normal dimensions (not just the velocity dimension) have custom zone ranges
3805                                for (bits = 0 ; bits < pDimensionDefinitions[i].zones ; bits++) {
3806                                    if (DimValues[i] <= pDimensionRegions[bits << bitpos]->DimensionUpperLimits[i]) break;
3807                                }
3808                            } else {
3809                                // gig2: evenly sized zones
3810                                bits = uint8_t(DimValues[i] / pDimensionDefinitions[i].zone_size);
3811                            }
3812                            break;
3813                        case split_type_bit: // the value is already the sought dimension bit number
3814                            const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;
3815                            bits = DimValues[i] & limiter_mask; // just make sure the value doesn't use more bits than allowed
3816                            break;
3817                    }
3818                    dimregidx |= bits << bitpos;
3819                }
3820                bitpos += pDimensionDefinitions[i].bits;
3821            }
3822            dimregidx &= 255;
3823            DimensionRegion* dimreg = pDimensionRegions[dimregidx];
3824            if (!dimreg) return -1;
3825            if (veldim != -1) {
3826                // (dimreg is now the dimension region for the lowest velocity)
3827                if (dimreg->VelocityTable) // custom defined zone ranges
3828                    bits = dimreg->VelocityTable[DimValues[veldim] & 127];
3829                else // normal split type
3830                    bits = uint8_t((DimValues[veldim] & 127) / pDimensionDefinitions[veldim].zone_size);
3831    
3832                const uint8_t limiter_mask = (1 << pDimensionDefinitions[veldim].bits) - 1;
3833                dimregidx |= (bits & limiter_mask) << velbitpos;
3834                dimregidx &= 255;
3835            }
3836            return dimregidx;
3837        }
3838    
3839      /**      /**
3840       * Returns the appropriate DimensionRegion for the given dimension bit       * Returns the appropriate DimensionRegion for the given dimension bit
3841       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>
# Line 3711  namespace { Line 4102  namespace {
4102          }          }
4103      }      }
4104    
4105    // *************** Script ***************
4106    // *
4107    
4108        Script::Script(ScriptGroup* group, RIFF::Chunk* ckScri) {
4109            pGroup = group;
4110            pChunk = ckScri;
4111            if (ckScri) { // object is loaded from file ...
4112                // read header
4113                uint32_t headerSize = ckScri->ReadUint32();
4114                Compression = (Compression_t) ckScri->ReadUint32();
4115                Encoding    = (Encoding_t) ckScri->ReadUint32();
4116                Language    = (Language_t) ckScri->ReadUint32();
4117                Bypass      = (Language_t) ckScri->ReadUint32() & 1;
4118                crc         = ckScri->ReadUint32();
4119                uint32_t nameSize = ckScri->ReadUint32();
4120                Name.resize(nameSize, ' ');
4121                for (int i = 0; i < nameSize; ++i)
4122                    Name[i] = ckScri->ReadUint8();
4123                // to handle potential future extensions of the header
4124                ckScri->SetPos(sizeof(int32_t) + headerSize);
4125                // read actual script data
4126                uint32_t scriptSize = ckScri->GetSize() - ckScri->GetPos();
4127                data.resize(scriptSize);
4128                for (int i = 0; i < scriptSize; ++i)
4129                    data[i] = ckScri->ReadUint8();
4130            } else { // this is a new script object, so just initialize it as such ...
4131                Compression = COMPRESSION_NONE;
4132                Encoding = ENCODING_ASCII;
4133                Language = LANGUAGE_NKSP;
4134                Bypass   = false;
4135                crc      = 0;
4136                Name     = "Unnamed Script";
4137            }
4138        }
4139    
4140        Script::~Script() {
4141        }
4142    
4143        /**
4144         * Returns the current script (i.e. as source code) in text format.
4145         */
4146        String Script::GetScriptAsText() {
4147            String s;
4148            s.resize(data.size(), ' ');
4149            memcpy(&s[0], &data[0], data.size());
4150            return s;
4151        }
4152    
4153        /**
4154         * Replaces the current script with the new script source code text given
4155         * by @a text.
4156         *
4157         * @param text - new script source code
4158         */
4159        void Script::SetScriptAsText(const String& text) {
4160            data.resize(text.size());
4161            memcpy(&data[0], &text[0], text.size());
4162        }
4163    
4164        void Script::UpdateChunks() {
4165            // recalculate CRC32 check sum
4166            __resetCRC(crc);
4167            __calculateCRC(&data[0], data.size(), crc);
4168            __encodeCRC(crc);
4169            // make sure chunk exists and has the required size
4170            const int chunkSize = 7*sizeof(int32_t) + Name.size() + data.size();
4171            if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize);
4172            else pChunk->Resize(chunkSize);
4173            // fill the chunk data to be written to disk
4174            uint8_t* pData = (uint8_t*) pChunk->LoadChunkData();
4175            int pos = 0;
4176            store32(&pData[pos], 6*sizeof(int32_t) + Name.size()); // total header size
4177            pos += sizeof(int32_t);
4178            store32(&pData[pos], Compression);
4179            pos += sizeof(int32_t);
4180            store32(&pData[pos], Encoding);
4181            pos += sizeof(int32_t);
4182            store32(&pData[pos], Language);
4183            pos += sizeof(int32_t);
4184            store32(&pData[pos], Bypass ? 1 : 0);
4185            pos += sizeof(int32_t);
4186            store32(&pData[pos], crc);
4187            pos += sizeof(int32_t);
4188            store32(&pData[pos], Name.size());
4189            pos += sizeof(int32_t);
4190            for (int i = 0; i < Name.size(); ++i, ++pos)
4191                pData[pos] = Name[i];
4192            for (int i = 0; i < data.size(); ++i, ++pos)
4193                pData[pos] = data[i];
4194        }
4195    
4196        /**
4197         * Move this script from its current ScriptGroup to another ScriptGroup
4198         * given by @a pGroup.
4199         *
4200         * @param pGroup - script's new group
4201         */
4202        void Script::SetGroup(ScriptGroup* pGroup) {
4203            if (this->pGroup = pGroup) return;
4204            if (pChunk)
4205                pChunk->GetParent()->MoveSubChunk(pChunk, pGroup->pList);
4206            this->pGroup = pGroup;
4207        }
4208    
4209        /**
4210         * Returns the script group this script currently belongs to. Each script
4211         * is a member of exactly one ScriptGroup.
4212         *
4213         * @returns current script group
4214         */
4215        ScriptGroup* Script::GetGroup() const {
4216            return pGroup;
4217        }
4218    
4219        void Script::RemoveAllScriptReferences() {
4220            File* pFile = pGroup->pFile;
4221            for (int i = 0; pFile->GetInstrument(i); ++i) {
4222                Instrument* instr = pFile->GetInstrument(i);
4223                instr->RemoveScript(this);
4224            }
4225        }
4226    
4227    // *************** ScriptGroup ***************
4228    // *
4229    
4230        ScriptGroup::ScriptGroup(File* file, RIFF::List* lstRTIS) {
4231            pFile = file;
4232            pList = lstRTIS;
4233            pScripts = NULL;
4234            if (lstRTIS) {
4235                RIFF::Chunk* ckName = lstRTIS->GetSubChunk(CHUNK_ID_LSNM);
4236                ::LoadString(ckName, Name);
4237            } else {
4238                Name = "Default Group";
4239            }
4240        }
4241    
4242        ScriptGroup::~ScriptGroup() {
4243            if (pScripts) {
4244                std::list<Script*>::iterator iter = pScripts->begin();
4245                std::list<Script*>::iterator end  = pScripts->end();
4246                while (iter != end) {
4247                    delete *iter;
4248                    ++iter;
4249                }
4250                delete pScripts;
4251            }
4252        }
4253    
4254        void ScriptGroup::UpdateChunks() {
4255            if (pScripts) {
4256                if (!pList)
4257                    pList = pFile->pRIFF->GetSubList(LIST_TYPE_3LS)->AddSubList(LIST_TYPE_RTIS);
4258    
4259                // now store the name of this group as <LSNM> chunk as subchunk of the <RTIS> list chunk
4260                ::SaveString(CHUNK_ID_LSNM, NULL, pList, Name, String("Unnamed Group"), true, 64);
4261    
4262                for (std::list<Script*>::iterator it = pScripts->begin();
4263                     it != pScripts->end(); ++it)
4264                {
4265                    (*it)->UpdateChunks();
4266                }
4267            }
4268        }
4269    
4270        /** @brief Get instrument script.
4271         *
4272         * Returns the real-time instrument script with the given index.
4273         *
4274         * @param index - number of the sought script (0..n)
4275         * @returns sought script or NULL if there's no such script
4276         */
4277        Script* ScriptGroup::GetScript(uint index) {
4278            if (!pScripts) LoadScripts();
4279            std::list<Script*>::iterator it = pScripts->begin();
4280            for (uint i = 0; it != pScripts->end(); ++i, ++it)
4281                if (i == index) return *it;
4282            return NULL;
4283        }
4284    
4285        /** @brief Add new instrument script.
4286         *
4287         * Adds a new real-time instrument script to the file. The script is not
4288         * actually used / executed unless it is referenced by an instrument to be
4289         * used. This is similar to samples, which you can add to a file, without
4290         * an instrument necessarily actually using it.
4291         *
4292         * You have to call Save() to make this persistent to the file.
4293         *
4294         * @return new empty script object
4295         */
4296        Script* ScriptGroup::AddScript() {
4297            if (!pScripts) LoadScripts();
4298            Script* pScript = new Script(this, NULL);
4299            pScripts->push_back(pScript);
4300            return pScript;
4301        }
4302    
4303        /** @brief Delete an instrument script.
4304         *
4305         * This will delete the given real-time instrument script. References of
4306         * instruments that are using that script will be removed accordingly.
4307         *
4308         * You have to call Save() to make this persistent to the file.
4309         *
4310         * @param pScript - script to delete
4311         * @throws gig::Exception if given script could not be found
4312         */
4313        void ScriptGroup::DeleteScript(Script* pScript) {
4314            if (!pScripts) LoadScripts();
4315            std::list<Script*>::iterator iter =
4316                find(pScripts->begin(), pScripts->end(), pScript);
4317            if (iter == pScripts->end())
4318                throw gig::Exception("Could not delete script, could not find given script");
4319            pScripts->erase(iter);
4320            pScript->RemoveAllScriptReferences();
4321            if (pScript->pChunk)
4322                pScript->pChunk->GetParent()->DeleteSubChunk(pScript->pChunk);
4323            delete pScript;
4324        }
4325    
4326        void ScriptGroup::LoadScripts() {
4327            if (pScripts) return;
4328            pScripts = new std::list<Script*>;
4329            if (!pList) return;
4330    
4331            for (RIFF::Chunk* ck = pList->GetFirstSubChunk(); ck;
4332                 ck = pList->GetNextSubChunk())
4333            {
4334                if (ck->GetChunkID() == CHUNK_ID_SCRI) {
4335                    pScripts->push_back(new Script(this, ck));
4336                }
4337            }
4338        }
4339    
4340  // *************** Instrument ***************  // *************** Instrument ***************
4341  // *  // *
4342    
# Line 3733  namespace { Line 4359  namespace {
4359          DimensionKeyRange.high = 0;          DimensionKeyRange.high = 0;
4360          pMidiRules = new MidiRule*[3];          pMidiRules = new MidiRule*[3];
4361          pMidiRules[0] = NULL;          pMidiRules[0] = NULL;
4362            pScriptRefs = NULL;
4363    
4364          // Loading          // Loading
4365          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);
# Line 3793  namespace { Line 4420  namespace {
4420              }              }
4421          }          }
4422    
4423            // own gig format extensions
4424            RIFF::List* lst3LS = insList->GetSubList(LIST_TYPE_3LS);
4425            if (lst3LS) {
4426                RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4427                if (ckSCSL) {
4428                    int headerSize = ckSCSL->ReadUint32();
4429                    int slotCount  = ckSCSL->ReadUint32();
4430                    if (slotCount) {
4431                        int slotSize  = ckSCSL->ReadUint32();
4432                        ckSCSL->SetPos(headerSize); // in case of future header extensions
4433                        int unknownSpace = slotSize - 2*sizeof(uint32_t); // in case of future slot extensions
4434                        for (int i = 0; i < slotCount; ++i) {
4435                            _ScriptPooolEntry e;
4436                            e.fileOffset = ckSCSL->ReadUint32();
4437                            e.bypass     = ckSCSL->ReadUint32() & 1;
4438                            if (unknownSpace) ckSCSL->SetPos(unknownSpace, RIFF::stream_curpos); // in case of future extensions
4439                            scriptPoolFileOffsets.push_back(e);
4440                        }
4441                    }
4442                }
4443            }
4444    
4445          __notify_progress(pProgress, 1.0f); // notify done          __notify_progress(pProgress, 1.0f); // notify done
4446      }      }
4447    
# Line 3813  namespace { Line 4462  namespace {
4462              delete pMidiRules[i];              delete pMidiRules[i];
4463          }          }
4464          delete[] pMidiRules;          delete[] pMidiRules;
4465            if (pScriptRefs) delete pScriptRefs;
4466      }      }
4467    
4468      /**      /**
# Line 3868  namespace { Line 4518  namespace {
4518                  pMidiRules[i]->UpdateChunks(pData);                  pMidiRules[i]->UpdateChunks(pData);
4519              }              }
4520          }          }
4521    
4522            // own gig format extensions
4523           if (pScriptRefs) {
4524               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
4525               if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS);
4526               const int slotCount = pScriptRefs->size();
4527               const int headerSize = 3 * sizeof(uint32_t);
4528               const int slotSize  = 2 * sizeof(uint32_t);
4529               const int totalChunkSize = headerSize + slotCount * slotSize;
4530               RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4531               if (!ckSCSL) ckSCSL = lst3LS->AddSubChunk(CHUNK_ID_SCSL, totalChunkSize);
4532               else ckSCSL->Resize(totalChunkSize);
4533               uint8_t* pData = (uint8_t*) ckSCSL->LoadChunkData();
4534               int pos = 0;
4535               store32(&pData[pos], headerSize);
4536               pos += sizeof(uint32_t);
4537               store32(&pData[pos], slotCount);
4538               pos += sizeof(uint32_t);
4539               store32(&pData[pos], slotSize);
4540               pos += sizeof(uint32_t);
4541               for (int i = 0; i < slotCount; ++i) {
4542                   // arbitrary value, the actual file offset will be updated in
4543                   // UpdateScriptFileOffsets() after the file has been resized
4544                   int bogusFileOffset = 0;
4545                   store32(&pData[pos], bogusFileOffset);
4546                   pos += sizeof(uint32_t);
4547                   store32(&pData[pos], (*pScriptRefs)[i].bypass ? 1 : 0);
4548                   pos += sizeof(uint32_t);
4549               }
4550           }
4551        }
4552    
4553        void Instrument::UpdateScriptFileOffsets() {
4554           // own gig format extensions
4555           if (pScriptRefs) {
4556               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
4557               RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4558               const int slotCount = pScriptRefs->size();
4559               const int headerSize = 3 * sizeof(uint32_t);
4560               ckSCSL->SetPos(headerSize);
4561               for (int i = 0; i < slotCount; ++i) {
4562                   uint32_t fileOffset =
4563                        (*pScriptRefs)[i].script->pChunk->GetFilePos() -
4564                        (*pScriptRefs)[i].script->pChunk->GetPos() -
4565                        CHUNK_HEADER_SIZE;
4566                   ckSCSL->WriteUint32(&fileOffset);
4567                   // jump over flags entry (containing the bypass flag)
4568                   ckSCSL->SetPos(sizeof(uint32_t), RIFF::stream_curpos);
4569               }
4570           }        
4571      }      }
4572    
4573      /**      /**
# Line 3999  namespace { Line 4699  namespace {
4699          pMidiRules[i] = 0;          pMidiRules[i] = 0;
4700      }      }
4701    
4702        void Instrument::LoadScripts() {
4703            if (pScriptRefs) return;
4704            pScriptRefs = new std::vector<_ScriptPooolRef>;
4705            if (scriptPoolFileOffsets.empty()) return;
4706            File* pFile = (File*) GetParent();
4707            for (uint k = 0; k < scriptPoolFileOffsets.size(); ++k) {
4708                uint32_t soughtOffset = scriptPoolFileOffsets[k].fileOffset;
4709                for (uint i = 0; pFile->GetScriptGroup(i); ++i) {
4710                    ScriptGroup* group = pFile->GetScriptGroup(i);
4711                    for (uint s = 0; group->GetScript(s); ++s) {
4712                        Script* script = group->GetScript(s);
4713                        if (script->pChunk) {
4714                            uint32_t offset = script->pChunk->GetFilePos() -
4715                                              script->pChunk->GetPos() -
4716                                              CHUNK_HEADER_SIZE;
4717                            if (offset == soughtOffset)
4718                            {
4719                                _ScriptPooolRef ref;
4720                                ref.script = script;
4721                                ref.bypass = scriptPoolFileOffsets[k].bypass;
4722                                pScriptRefs->push_back(ref);
4723                                break;
4724                            }
4725                        }
4726                    }
4727                }
4728            }
4729            // we don't need that anymore
4730            scriptPoolFileOffsets.clear();
4731        }
4732    
4733        /** @brief Get instrument script (gig format extension).
4734         *
4735         * Returns the real-time instrument script of instrument script slot
4736         * @a index.
4737         *
4738         * @note This is an own format extension which did not exist i.e. in the
4739         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4740         * gigedit.
4741         *
4742         * @param index - instrument script slot index
4743         * @returns script or NULL if index is out of bounds
4744         */
4745        Script* Instrument::GetScriptOfSlot(uint index) {
4746            LoadScripts();
4747            if (index >= pScriptRefs->size()) return NULL;
4748            return pScriptRefs->at(index).script;
4749        }
4750    
4751        /** @brief Add new instrument script slot (gig format extension).
4752         *
4753         * Add the given real-time instrument script reference to this instrument,
4754         * which shall be executed by the sampler for for this instrument. The
4755         * script will be added to the end of the script list of this instrument.
4756         * The positions of the scripts in the Instrument's Script list are
4757         * relevant, because they define in which order they shall be executed by
4758         * the sampler. For this reason it is also legal to add the same script
4759         * twice to an instrument, for example you might have a script called
4760         * "MyFilter" which performs an event filter task, and you might have
4761         * another script called "MyNoteTrigger" which triggers new notes, then you
4762         * might for example have the following list of scripts on the instrument:
4763         *
4764         * 1. Script "MyFilter"
4765         * 2. Script "MyNoteTrigger"
4766         * 3. Script "MyFilter"
4767         *
4768         * Which would make sense, because the 2nd script launched new events, which
4769         * you might need to filter as well.
4770         *
4771         * There are two ways to disable / "bypass" scripts. You can either disable
4772         * a script locally for the respective script slot on an instrument (i.e. by
4773         * passing @c false to the 2nd argument of this method, or by calling
4774         * SetScriptBypassed()). Or you can disable a script globally for all slots
4775         * and all instruments by setting Script::Bypass.
4776         *
4777         * @note This is an own format extension which did not exist i.e. in the
4778         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4779         * gigedit.
4780         *
4781         * @param pScript - script that shall be executed for this instrument
4782         * @param bypass  - if enabled, the sampler shall skip executing this
4783         *                  script (in the respective list position)
4784         * @see SetScriptBypassed()
4785         */
4786        void Instrument::AddScriptSlot(Script* pScript, bool bypass) {
4787            LoadScripts();
4788            _ScriptPooolRef ref = { pScript, bypass };
4789            pScriptRefs->push_back(ref);
4790        }
4791    
4792        /** @brief Flip two script slots with each other (gig format extension).
4793         *
4794         * Swaps the position of the two given scripts in the Instrument's Script
4795         * list. The positions of the scripts in the Instrument's Script list are
4796         * relevant, because they define in which order they shall be executed by
4797         * the sampler.
4798         *
4799         * @note This is an own format extension which did not exist i.e. in the
4800         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4801         * gigedit.
4802         *
4803         * @param index1 - index of the first script slot to swap
4804         * @param index2 - index of the second script slot to swap
4805         */
4806        void Instrument::SwapScriptSlots(uint index1, uint index2) {
4807            LoadScripts();
4808            if (index1 >= pScriptRefs->size() || index2 >= pScriptRefs->size())
4809                return;
4810            _ScriptPooolRef tmp = (*pScriptRefs)[index1];
4811            (*pScriptRefs)[index1] = (*pScriptRefs)[index2];
4812            (*pScriptRefs)[index2] = tmp;
4813        }
4814    
4815        /** @brief Remove script slot.
4816         *
4817         * Removes the script slot with the given slot index.
4818         *
4819         * @param index - index of script slot to remove
4820         */
4821        void Instrument::RemoveScriptSlot(uint index) {
4822            LoadScripts();
4823            if (index >= pScriptRefs->size()) return;
4824            pScriptRefs->erase( pScriptRefs->begin() + index );
4825        }
4826    
4827        /** @brief Remove reference to given Script (gig format extension).
4828         *
4829         * This will remove all script slots on the instrument which are referencing
4830         * the given script.
4831         *
4832         * @note This is an own format extension which did not exist i.e. in the
4833         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4834         * gigedit.
4835         *
4836         * @param pScript - script reference to remove from this instrument
4837         * @see RemoveScriptSlot()
4838         */
4839        void Instrument::RemoveScript(Script* pScript) {
4840            LoadScripts();
4841            for (int i = pScriptRefs->size() - 1; i >= 0; --i) {
4842                if ((*pScriptRefs)[i].script == pScript) {
4843                    pScriptRefs->erase( pScriptRefs->begin() + i );
4844                }
4845            }
4846        }
4847    
4848        /** @brief Instrument's amount of script slots.
4849         *
4850         * This method returns the amount of script slots this instrument currently
4851         * uses.
4852         *
4853         * A script slot is a reference of a real-time instrument script to be
4854         * executed by the sampler. The scripts will be executed by the sampler in
4855         * sequence of the slots. One (same) script may be referenced multiple
4856         * times in different slots.
4857         *
4858         * @note This is an own format extension which did not exist i.e. in the
4859         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4860         * gigedit.
4861         */
4862        uint Instrument::ScriptSlotCount() const {
4863            return pScriptRefs ? pScriptRefs->size() : scriptPoolFileOffsets.size();
4864        }
4865    
4866        /** @brief Whether script execution shall be skipped.
4867         *
4868         * Defines locally for the Script reference slot in the Instrument's Script
4869         * list, whether the script shall be skipped by the sampler regarding
4870         * execution.
4871         *
4872         * It is also possible to ignore exeuction of the script globally, for all
4873         * slots and for all instruments by setting Script::Bypass.
4874         *
4875         * @note This is an own format extension which did not exist i.e. in the
4876         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4877         * gigedit.
4878         *
4879         * @param index - index of the script slot on this instrument
4880         * @see Script::Bypass
4881         */
4882        bool Instrument::IsScriptSlotBypassed(uint index) {
4883            if (index >= ScriptSlotCount()) return false;
4884            return pScriptRefs ? pScriptRefs->at(index).bypass
4885                               : scriptPoolFileOffsets.at(index).bypass;
4886            
4887        }
4888    
4889        /** @brief Defines whether execution shall be skipped.
4890         *
4891         * You can call this method to define locally whether or whether not the
4892         * given script slot shall be executed by the sampler.
4893         *
4894         * @note This is an own format extension which did not exist i.e. in the
4895         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4896         * gigedit.
4897         *
4898         * @param index - script slot index on this instrument
4899         * @param bBypass - if true, the script slot will be skipped by the sampler
4900         * @see Script::Bypass
4901         */
4902        void Instrument::SetScriptSlotBypassed(uint index, bool bBypass) {
4903            if (index >= ScriptSlotCount()) return;
4904            if (pScriptRefs)
4905                pScriptRefs->at(index).bypass = bBypass;
4906            else
4907                scriptPoolFileOffsets.at(index).bypass = bBypass;
4908        }
4909    
4910      /**      /**
4911       * Make a (semi) deep copy of the Instrument object given by @a orig       * Make a (semi) deep copy of the Instrument object given by @a orig
4912       * and assign it to this object.       * and assign it to this object.
# Line 4032  namespace { Line 4940  namespace {
4940          PitchbendRange = orig->PitchbendRange;          PitchbendRange = orig->PitchbendRange;
4941          PianoReleaseMode = orig->PianoReleaseMode;          PianoReleaseMode = orig->PianoReleaseMode;
4942          DimensionKeyRange = orig->DimensionKeyRange;          DimensionKeyRange = orig->DimensionKeyRange;
4943            scriptPoolFileOffsets = orig->scriptPoolFileOffsets;
4944            pScriptRefs = orig->pScriptRefs;
4945                    
4946          // free old midi rules          // free old midi rules
4947          for (int i = 0 ; pMidiRules[i] ; i++) {          for (int i = 0 ; pMidiRules[i] ; i++) {
# Line 4217  namespace { Line 5127  namespace {
5127          bAutoLoad = true;          bAutoLoad = true;
5128          *pVersion = VERSION_3;          *pVersion = VERSION_3;
5129          pGroups = NULL;          pGroups = NULL;
5130            pScriptGroups = NULL;
5131          pInfo->SetFixedStringLengths(_FileFixedStringLengths);          pInfo->SetFixedStringLengths(_FileFixedStringLengths);
5132          pInfo->ArchivalLocation = String(256, ' ');          pInfo->ArchivalLocation = String(256, ' ');
5133    
# Line 4232  namespace { Line 5143  namespace {
5143      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {
5144          bAutoLoad = true;          bAutoLoad = true;
5145          pGroups = NULL;          pGroups = NULL;
5146            pScriptGroups = NULL;
5147          pInfo->SetFixedStringLengths(_FileFixedStringLengths);          pInfo->SetFixedStringLengths(_FileFixedStringLengths);
5148      }      }
5149    
# Line 4245  namespace { Line 5157  namespace {
5157              }              }
5158              delete pGroups;              delete pGroups;
5159          }          }
5160            if (pScriptGroups) {
5161                std::list<ScriptGroup*>::iterator iter = pScriptGroups->begin();
5162                std::list<ScriptGroup*>::iterator end  = pScriptGroups->end();
5163                while (iter != end) {
5164                    delete *iter;
5165                    ++iter;
5166                }
5167                delete pScriptGroups;
5168            }
5169      }      }
5170    
5171      Sample* File::GetFirstSample(progress_t* pProgress) {      Sample* File::GetFirstSample(progress_t* pProgress) {
# Line 4757  namespace { Line 5678  namespace {
5678          }          }
5679      }      }
5680    
5681        /** @brief Get instrument script group (by index).
5682         *
5683         * Returns the real-time instrument script group with the given index.
5684         *
5685         * @param index - number of the sought group (0..n)
5686         * @returns sought script group or NULL if there's no such group
5687         */
5688        ScriptGroup* File::GetScriptGroup(uint index) {
5689            if (!pScriptGroups) LoadScriptGroups();
5690            std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
5691            for (uint i = 0; it != pScriptGroups->end(); ++i, ++it)
5692                if (i == index) return *it;
5693            return NULL;
5694        }
5695    
5696        /** @brief Get instrument script group (by name).
5697         *
5698         * Returns the first real-time instrument script group found with the given
5699         * group name. Note that group names may not necessarily be unique.
5700         *
5701         * @param name - name of the sought script group
5702         * @returns sought script group or NULL if there's no such group
5703         */
5704        ScriptGroup* File::GetScriptGroup(const String& name) {
5705            if (!pScriptGroups) LoadScriptGroups();
5706            std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
5707            for (uint i = 0; it != pScriptGroups->end(); ++i, ++it)
5708                if ((*it)->Name == name) return *it;
5709            return NULL;
5710        }
5711    
5712        /** @brief Add new instrument script group.
5713         *
5714         * Adds a new, empty real-time instrument script group to the file.
5715         *
5716         * You have to call Save() to make this persistent to the file.
5717         *
5718         * @return new empty script group
5719         */
5720        ScriptGroup* File::AddScriptGroup() {
5721            if (!pScriptGroups) LoadScriptGroups();
5722            ScriptGroup* pScriptGroup = new ScriptGroup(this, NULL);
5723            pScriptGroups->push_back(pScriptGroup);
5724            return pScriptGroup;
5725        }
5726    
5727        /** @brief Delete an instrument script group.
5728         *
5729         * This will delete the given real-time instrument script group and all its
5730         * instrument scripts it contains. References inside instruments that are
5731         * using the deleted scripts will be removed from the respective instruments
5732         * accordingly.
5733         *
5734         * You have to call Save() to make this persistent to the file.
5735         *
5736         * @param pScriptGroup - script group to delete
5737         * @throws gig::Exception if given script group could not be found
5738         */
5739        void File::DeleteScriptGroup(ScriptGroup* pScriptGroup) {
5740            if (!pScriptGroups) LoadScriptGroups();
5741            std::list<ScriptGroup*>::iterator iter =
5742                find(pScriptGroups->begin(), pScriptGroups->end(), pScriptGroup);
5743            if (iter == pScriptGroups->end())
5744                throw gig::Exception("Could not delete script group, could not find given script group");
5745            pScriptGroups->erase(iter);
5746            for (int i = 0; pScriptGroup->GetScript(i); ++i)
5747                pScriptGroup->DeleteScript(pScriptGroup->GetScript(i));
5748            if (pScriptGroup->pList)
5749                pScriptGroup->pList->GetParent()->DeleteSubChunk(pScriptGroup->pList);
5750            delete pScriptGroup;
5751        }
5752    
5753        void File::LoadScriptGroups() {
5754            if (pScriptGroups) return;
5755            pScriptGroups = new std::list<ScriptGroup*>;
5756            RIFF::List* lstLS = pRIFF->GetSubList(LIST_TYPE_3LS);
5757            if (lstLS) {
5758                for (RIFF::List* lst = lstLS->GetFirstSubList(); lst;
5759                     lst = lstLS->GetNextSubList())
5760                {
5761                    if (lst->GetListType() == LIST_TYPE_RTIS) {
5762                        pScriptGroups->push_back(new ScriptGroup(this, lst));
5763                    }
5764                }
5765            }
5766        }
5767    
5768      /**      /**
5769       * Apply all the gig file's current instruments, samples, groups and settings       * Apply all the gig file's current instruments, samples, groups and settings
5770       * to the respective RIFF chunks. You have to call Save() to make changes       * to the respective RIFF chunks. You have to call Save() to make changes
# Line 4772  namespace { Line 5780  namespace {
5780    
5781          b64BitWavePoolOffsets = pVersion && pVersion->major == 3;          b64BitWavePoolOffsets = pVersion && pVersion->major == 3;
5782    
5783            // update own gig format extension chunks
5784            // (not part of the GigaStudio 4 format)
5785            //
5786            // This must be performed before writing the chunks for instruments,
5787            // because the instruments' script slots will write the file offsets
5788            // of the respective instrument script chunk as reference.
5789            if (pScriptGroups) {
5790                RIFF::List* lst3LS = pRIFF->GetSubList(LIST_TYPE_3LS);
5791                if (pScriptGroups->empty()) {
5792                    if (lst3LS) pRIFF->DeleteSubChunk(lst3LS);
5793                } else {
5794                    if (!lst3LS) lst3LS = pRIFF->AddSubList(LIST_TYPE_3LS);
5795    
5796                    // Update instrument script (group) chunks.
5797    
5798                    for (std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
5799                         it != pScriptGroups->end(); ++it)
5800                    {
5801                        (*it)->UpdateChunks();
5802                    }
5803                }
5804            }
5805    
5806          // first update base class's chunks          // first update base class's chunks
5807          DLS::File::UpdateChunks();          DLS::File::UpdateChunks();
5808    
# Line 4942  namespace { Line 5973  namespace {
5973              if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);              if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);
5974          }          }
5975      }      }
5976        
5977        void File::UpdateFileOffsets() {
5978            DLS::File::UpdateFileOffsets();
5979    
5980            for (Instrument* instrument = GetFirstInstrument(); instrument;
5981                 instrument = GetNextInstrument())
5982            {
5983                instrument->UpdateScriptFileOffsets();
5984            }
5985        }
5986    
5987      /**      /**
5988       * Enable / disable automatic loading. By default this properyt is       * Enable / disable automatic loading. By default this properyt is

Legend:
Removed from v.2543  
changed lines
  Added in v.2640

  ViewVC Help
Powered by ViewVC