/[svn]/gigedit/trunk/src/gigedit/CombineInstrumentsDialog.cpp
ViewVC logotype

Diff of /gigedit/trunk/src/gigedit/CombineInstrumentsDialog.cpp

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

revision 2550 by schoenebeck, Wed May 14 01:31:30 2014 UTC revision 3151 by schoenebeck, Fri May 5 18:44:59 2017 UTC
# Line 1  Line 1 
1  /*  /*
2      Copyright (c) 2014 Christian Schoenebeck      Copyright (c) 2014-2017 Christian Schoenebeck
3            
4      This file is part of "gigedit" and released under the terms of the      This file is part of "gigedit" and released under the terms of the
5      GNU General Public License version 2.      GNU General Public License version 2.
# Line 11  Line 11 
11  #define DEBUG_COMBINE_INSTRUMENTS 0  #define DEBUG_COMBINE_INSTRUMENTS 0
12    
13  #include "global.h"  #include "global.h"
14    #include "compat.h"
15    
16  #include <set>  #include <set>
17  #include <iostream>  #include <iostream>
18  #include <assert.h>  #include <assert.h>
19    #include <stdarg.h>
20    #include <string.h>
21    
22  #include <glibmm/ustring.h>  #include <glibmm/ustring.h>
 #include <gtkmm/stock.h>  
23  #include <gtkmm/messagedialog.h>  #include <gtkmm/messagedialog.h>
24    #include <gtkmm/label.h>
25    
26  Glib::ustring gig_to_utf8(const gig::String& gig_string);  Glib::ustring dimTypeAsString(gig::dimension_t d);
27    
28    typedef std::vector< std::pair<gig::Instrument*, gig::Region*> > OrderedRegionGroup;
29  typedef std::map<gig::Instrument*, gig::Region*> RegionGroup;  typedef std::map<gig::Instrument*, gig::Region*> RegionGroup;
30  typedef std::map<DLS::range_t,RegionGroup> RegionGroups;  typedef std::map<DLS::range_t,RegionGroup> RegionGroups;
31    
32  typedef std::vector<DLS::range_t> DimensionZones;  typedef std::vector<DLS::range_t> DimensionZones;
33  typedef std::map<gig::dimension_t,DimensionZones> Dimensions;  typedef std::map<gig::dimension_t,DimensionZones> Dimensions;
34    
 typedef std::map<gig::dimension_t,int> DimensionCase;  
   
35  typedef std::map<gig::dimension_t, int> DimensionRegionUpperLimits;  typedef std::map<gig::dimension_t, int> DimensionRegionUpperLimits;
36    
37    typedef std::set<Glib::ustring> Warnings;
38    
39    ///////////////////////////////////////////////////////////////////////////
40    // private static data
41    
42    static Warnings g_warnings;
43    
44  ///////////////////////////////////////////////////////////////////////////  ///////////////////////////////////////////////////////////////////////////
45  // private functions  // private functions
46    
# Line 47  static void printRanges(const RegionGrou Line 56  static void printRanges(const RegionGrou
56  #endif  #endif
57    
58  /**  /**
59     * Store a warning message that shall be stored and displayed to the user as a
60     * list of warnings after the overall operation has finished. Duplicate warning
61     * messages are automatically eliminated.
62     */
63    inline void addWarning(const char* fmt, ...) {
64        va_list arg;
65        va_start(arg, fmt);
66        const int SZ = 255 + strlen(fmt);
67        char* buf = new char[SZ];
68        vsnprintf(buf, SZ, fmt, arg);
69        Glib::ustring s = buf;
70        delete [] buf;
71        va_end(arg);
72        std::cerr << _("WARNING:") << " " << s << std::endl << std::flush;
73        g_warnings.insert(s);
74    }
75    
76    /**
77   * If the two ranges overlap, then this function returns the smallest point   * If the two ranges overlap, then this function returns the smallest point
78   * within that overlapping zone. If the two ranges do not overlap, then this   * within that overlapping zone. If the two ranges do not overlap, then this
79   * function will return -1 instead.   * function will return -1 instead.
# Line 66  inline int smallestOverlapPoint(const DL Line 93  inline int smallestOverlapPoint(const DL
93   *          found with a range member point >= iStart   *          found with a range member point >= iStart
94   */   */
95  static int findLowestRegionPoint(std::vector<gig::Instrument*>& instruments, int iStart) {  static int findLowestRegionPoint(std::vector<gig::Instrument*>& instruments, int iStart) {
96      DLS::range_t searchRange = { iStart, 127 };      DLS::range_t searchRange = { uint16_t(iStart), 127 };
97      int result = -1;      int result = -1;
98      for (uint i = 0; i < instruments.size(); ++i) {      for (uint i = 0; i < instruments.size(); ++i) {
99          gig::Instrument* instr = instruments[i];          gig::Instrument* instr = instruments[i];
# Line 88  static int findLowestRegionPoint(std::ve Line 115  static int findLowestRegionPoint(std::ve
115   *          with a range end >= iStart   *          with a range end >= iStart
116   */   */
117  static int findFirstRegionEnd(std::vector<gig::Instrument*>& instruments, int iStart) {  static int findFirstRegionEnd(std::vector<gig::Instrument*>& instruments, int iStart) {
118      DLS::range_t searchRange = { iStart, 127 };      DLS::range_t searchRange = { uint16_t(iStart), 127 };
119      int result = -1;      int result = -1;
120      for (uint i = 0; i < instruments.size(); ++i) {      for (uint i = 0; i < instruments.size(); ++i) {
121          gig::Instrument* instr = instruments[i];          gig::Instrument* instr = instruments[i];
# Line 131  static RegionGroup getAllRegionsWhichOve Line 158  static RegionGroup getAllRegionsWhichOve
158          std::vector<gig::Region*> v = getAllRegionsWhichOverlapRange(instr, range);          std::vector<gig::Region*> v = getAllRegionsWhichOverlapRange(instr, range);
159          if (v.empty()) continue;          if (v.empty()) continue;
160          if (v.size() > 1) {          if (v.size() > 1) {
161              std::cerr << "WARNING: More than one region found!" << std::endl;              addWarning("More than one region found!");
162          }          }
163          group[instr] = v[0];          group[instr] = v[0];
164      }      }
# Line 141  static RegionGroup getAllRegionsWhichOve Line 168  static RegionGroup getAllRegionsWhichOve
168  /** @brief Identify required regions.  /** @brief Identify required regions.
169   *   *
170   * Takes a list of @a instruments as argument (which are planned to be combined   * Takes a list of @a instruments as argument (which are planned to be combined
171   * as layers in one single new instrument) and fulfills the following tasks:   * as separate dimension zones of a certain dimension into one single new
172     * instrument) and fulfills the following tasks:
173   *   *
174   * - 1. Identification of total amount of regions required to create a new   * - 1. Identification of total amount of regions required to create a new
175   *      instrument to become a layered version of the given instruments.   *      instrument to become a combined version of the given instruments.
176   * - 2. Precise key range of each of those identified required regions to be   * - 2. Precise key range of each of those identified required regions to be
177   *      created in that new instrument.   *      created in that new instrument.
178   * - 3. Grouping the original source regions of the given original instruments   * - 3. Grouping the original source regions of the given original instruments
# Line 163  static RegionGroups groupByRegionInterse Line 191  static RegionGroups groupByRegionInterse
191          iStart = findLowestRegionPoint(instruments, iStart);          iStart = findLowestRegionPoint(instruments, iStart);
192          if (iStart < 0) break;          if (iStart < 0) break;
193          const int iEnd = findFirstRegionEnd(instruments, iStart);          const int iEnd = findFirstRegionEnd(instruments, iStart);
194          DLS::range_t range = { iStart, iEnd };          DLS::range_t range = { uint16_t(iStart), uint16_t(iEnd) };
195          intersections.push_back(range);          intersections.push_back(range);
196          iStart = iEnd + 1;          iStart = iEnd + 1;
197      }      }
# Line 175  static RegionGroups groupByRegionInterse Line 203  static RegionGroups groupByRegionInterse
203          if (!group.empty())          if (!group.empty())
204              groups[range] = group;              groups[range] = group;
205          else          else
206              std::cerr << "WARNING: empty region group!" << std::endl;              addWarning("Empty region group!");
207      }      }
208    
209      return groups;      return groups;
# Line 234  static Dimensions getDimensionsForRegion Line 262  static Dimensions getDimensionsForRegion
262               itNums != it->second.end(); ++itNums)               itNums != it->second.end(); ++itNums)
263          {          {
264              const int iUpperLimit = *itNums;              const int iUpperLimit = *itNums;
265              DLS::range_t range = { iLow, iUpperLimit };              DLS::range_t range = { uint16_t(iLow), uint16_t(iUpperLimit) };
266              dims[type].push_back(range);              dims[type].push_back(range);
267              iLow = iUpperLimit + 1;              iLow = iUpperLimit + 1;
268          }          }
# Line 243  static Dimensions getDimensionsForRegion Line 271  static Dimensions getDimensionsForRegion
271      return dims;      return dims;
272  }  }
273    
 inline int getDimensionIndex(gig::dimension_t type, gig::Region* rgn) {  
     for (uint i = 0; i < rgn->Dimensions; ++i)  
         if (rgn->pDimensionDefinitions[i].dimension == type)  
             return i;  
     return -1;  
 }  
   
274  static void fillDimValues(uint* values/*[8]*/, DimensionCase dimCase, gig::Region* rgn, bool bShouldHaveAllDimensionsPassed) {  static void fillDimValues(uint* values/*[8]*/, DimensionCase dimCase, gig::Region* rgn, bool bShouldHaveAllDimensionsPassed) {
275      #if DEBUG_COMBINE_INSTRUMENTS      #if DEBUG_COMBINE_INSTRUMENTS
276      printf("dimvalues = { ");      printf("dimvalues = { ");
# Line 266  static void fillDimValues(uint* values/* Line 287  static void fillDimValues(uint* values/*
287          #endif          #endif
288      }      }
289      #if DEBUG_COMBINE_INSTRUMENTS      #if DEBUG_COMBINE_INSTRUMENTS
290      printf("\n");      printf("}\n");
291      #endif      #endif
292  }  }
293    
# Line 291  static void restoreDimensionRegionUpperL Line 312  static void restoreDimensionRegionUpperL
312      }      }
313  }  }
314    
 /**  
  * Returns the sum of all bits of all dimensions defined before the given  
  * dimensions (@a type). This allows to access cases of that particular  
  * dimension directly.  
  *  
  * @param type - dimension that shall be used  
  * @param rgn - parent region of that dimension  
  */  
 inline int baseBits(gig::dimension_t type, gig::Region* rgn) {  
     int previousBits = 0;  
     for (uint i = 0; i < rgn->Dimensions; ++i) {  
         if (rgn->pDimensionDefinitions[i].dimension == type) break;  
         previousBits += rgn->pDimensionDefinitions[i].bits;  
     }  
     return previousBits;  
 }  
   
315  inline int dimensionRegionIndex(gig::DimensionRegion* dimRgn) {  inline int dimensionRegionIndex(gig::DimensionRegion* dimRgn) {
316      gig::Region* rgn = dimRgn->GetParent();      gig::Region* rgn = dimRgn->GetParent();
317      int sz = sizeof(rgn->pDimensionRegions) / sizeof(gig::DimensionRegion*);      int sz = sizeof(rgn->pDimensionRegions) / sizeof(gig::DimensionRegion*);
# Line 340  static DimensionZones preciseDimensionZo Line 344  static DimensionZones preciseDimensionZo
344      const gig::dimension_def_t& def = rgn->pDimensionDefinitions[iDimension];      const gig::dimension_def_t& def = rgn->pDimensionDefinitions[iDimension];
345      int iDimRgn = dimensionRegionIndex(dimRgn);      int iDimRgn = dimensionRegionIndex(dimRgn);
346      int iBaseBits = baseBits(type, rgn);      int iBaseBits = baseBits(type, rgn);
347        assert(iBaseBits >= 0);
348      int mask = ~(((1 << def.bits) - 1) << iBaseBits);      int mask = ~(((1 << def.bits) - 1) << iBaseBits);
349    
350      #if DEBUG_COMBINE_INSTRUMENTS      #if DEBUG_COMBINE_INSTRUMENTS
# Line 351  static DimensionZones preciseDimensionZo Line 356  static DimensionZones preciseDimensionZo
356          gig::DimensionRegion* dimRgn2 =          gig::DimensionRegion* dimRgn2 =
357              rgn->pDimensionRegions[ (iDimRgn & mask) | ( z << iBaseBits) ];              rgn->pDimensionRegions[ (iDimRgn & mask) | ( z << iBaseBits) ];
358          int iHigh = dimRgn2->DimensionUpperLimits[iDimension];          int iHigh = dimRgn2->DimensionUpperLimits[iDimension];
359          DLS::range_t range = { iLow, iHigh};          DLS::range_t range = { uint16_t(iLow), uint16_t(iHigh) };
360          #if DEBUG_COMBINE_INSTRUMENTS          #if DEBUG_COMBINE_INSTRUMENTS
361          printf("%d..%d, ", iLow, iHigh);          printf("%d..%d, ", iLow, iHigh);
362          fflush(stdout);          fflush(stdout);
# Line 373  struct CopyAssignSchedEntry { Line 378  struct CopyAssignSchedEntry {
378  };  };
379  typedef std::vector<CopyAssignSchedEntry> CopyAssignSchedule;  typedef std::vector<CopyAssignSchedEntry> CopyAssignSchedule;
380    
381  /** @brief Copy all DimensionRegions from source Region to target Region.  /** @brief Schedule copying DimensionRegions from source Region to target Region.
382   *   *
383   * Copies the entire articulation informations (including sample reference of   * Schedules copying the entire articulation informations (including sample
384   * course) from all individual DimensionRegions of source Region @a inRgn to   * reference) from all individual DimensionRegions of source Region @a inRgn to
385   * target Region @a outRgn. There are no dimension regions created during this   * target Region @a outRgn. It is expected that the required dimensions (thus
386   * task. It is expected that the required dimensions (thus the required   * the required dimension regions) were already created before calling this
387   * dimension regions) were already created before calling this function.   * function.
388   *   *
389   * To be precise, it does the task above only for the layer selected by   * To be precise, it does the task above only for the dimension zones defined by
390   * @a iSrcLayer and @a iDstLayer. All dimensions regions of other layers that   * the three arguments @a mainDim, @a iSrcMainBit, @a iDstMainBit, which reflect
391   * may exist, will not be copied by one single call of this function. So if   * a selection which dimension zones shall be copied. All other dimension zones
392   * there is a layer dimension, this function needs to be called several times.   * will not be scheduled to be copied by a single call of this function. So this
393     * function needs to be called several time in case all dimension regions shall
394     * be copied of the entire region (@a inRgn, @a outRgn).
395   *   *
396   * @param outRgn - where the dimension regions shall be copied to   * @param outRgn - where the dimension regions shall be copied to
397   * @param inRgn - all dimension regions that shall be copied from   * @param inRgn - all dimension regions that shall be copied from
398   * @param dims - precise dimension definitions of target region   * @param dims - precise dimension definitions of target region
399   * @param iDstLayer - layer index of destination region where the dimension   * @param mainDim - this dimension type, in combination with @a iSrcMainBit and
400   *                    regions shall be copied to   *                  @a iDstMainBit defines a selection which dimension region
401   * @param iSrcLayer - layer index of the source region where the dimension   *                  zones shall be copied by this call of this function
402   *                    regions shall be copied from   * @param iDstMainBit - destination bit of @a mainDim
403     * @param iSrcMainBit - source bit of @a mainDim
404     * @param schedule - list of all DimensionRegion copy operations which is filled
405     *                   during the nested loops / recursions of this function call
406   * @param dimCase - just for internal purpose (function recursion), don't pass   * @param dimCase - just for internal purpose (function recursion), don't pass
407   *                  anything here, this function will call itself recursively   *                  anything here, this function will call itself recursively
408   *                  will fill this container with concrete dimension values for   *                  will fill this container with concrete dimension values for
409   *                  selecting the precise dimension regions during its task   *                  selecting the precise dimension regions during its task
  * @param schedule - just for internal purpose (function recursion), don't pass  
                      anything here: list of all DimensionRegion copy operations  
  *                   which is filled during the nested loops / recursions of  
  *                   this function call, they will be peformed after all  
  *                   function recursions have been completed  
410   */   */
411  static void copyDimensionRegions(gig::Region* outRgn, gig::Region* inRgn, Dimensions dims, int iDstLayer, int iSrcLayer, DimensionCase dimCase = DimensionCase(), CopyAssignSchedule* schedule = NULL) {  static void scheduleCopyDimensionRegions(gig::Region* outRgn, gig::Region* inRgn,
412      const bool isHighestLevelOfRecursion = !schedule;                                   Dimensions dims, gig::dimension_t mainDim,
413                                     int iDstMainBit, int iSrcMainBit,
414      if (isHighestLevelOfRecursion)                                   CopyAssignSchedule* schedule,
415          schedule = new CopyAssignSchedule;                                   DimensionCase dimCase = DimensionCase())
416    {
417      if (dims.empty()) { // reached deepest level of function recursion ...      if (dims.empty()) { // reached deepest level of function recursion ...
418          CopyAssignSchedEntry e;          CopyAssignSchedEntry e;
419    
# Line 417  static void copyDimensionRegions(gig::Re Line 422  static void copyDimensionRegions(gig::Re
422          uint dstDimValues[8] = {};          uint dstDimValues[8] = {};
423          DimensionCase srcDimCase = dimCase;          DimensionCase srcDimCase = dimCase;
424          DimensionCase dstDimCase = dimCase;          DimensionCase dstDimCase = dimCase;
425          srcDimCase[gig::dimension_layer] = iSrcLayer;          srcDimCase[mainDim] = iSrcMainBit;
426          dstDimCase[gig::dimension_layer] = iDstLayer;          dstDimCase[mainDim] = iDstMainBit;
427    
428          #if DEBUG_COMBINE_INSTRUMENTS          #if DEBUG_COMBINE_INSTRUMENTS
429          printf("-------------------------------\n");          printf("-------------------------------\n");
430            printf("iDstMainBit=%d iSrcMainBit=%d\n", iDstMainBit, iSrcMainBit);
431          #endif          #endif
432    
433          // first select source & target dimension region with an arbitrary          // first select source & target dimension region with an arbitrary
# Line 436  static void copyDimensionRegions(gig::Re Line 442  static void copyDimensionRegions(gig::Re
442          #if DEBUG_COMBINE_INSTRUMENTS          #if DEBUG_COMBINE_INSTRUMENTS
443          printf("dst "); fflush(stdout);          printf("dst "); fflush(stdout);
444          #endif          #endif
445          fillDimValues(dstDimValues, dstDimCase, outRgn, true);          fillDimValues(dstDimValues, dstDimCase, outRgn, false);
446          gig::DimensionRegion* srcDimRgn = inRgn->GetDimensionRegionByValue(srcDimValues);          gig::DimensionRegion* srcDimRgn = inRgn->GetDimensionRegionByValue(srcDimValues);
447          gig::DimensionRegion* dstDimRgn = outRgn->GetDimensionRegionByValue(dstDimValues);          gig::DimensionRegion* dstDimRgn = outRgn->GetDimensionRegionByValue(dstDimValues);
448          #if DEBUG_COMBINE_INSTRUMENTS          #if DEBUG_COMBINE_INSTRUMENTS
449          printf("iDstLayer=%d iSrcLayer=%d\n", iDstLayer, iSrcLayer);          printf("iDstMainBit=%d iSrcMainBit=%d\n", iDstMainBit, iSrcMainBit);
450          printf("srcDimRgn=%lx dstDimRgn=%lx\n", (uint64_t)srcDimRgn, (uint64_t)dstDimRgn);          printf("srcDimRgn=%lx dstDimRgn=%lx\n", (uint64_t)srcDimRgn, (uint64_t)dstDimRgn);
451          printf("srcSample='%s' dstSample='%s'\n",          printf("srcSample='%s' dstSample='%s'\n",
452                 (!srcDimRgn->pSample ? "NULL" : srcDimRgn->pSample->pInfo->Name.c_str()),                 (!srcDimRgn->pSample ? "NULL" : srcDimRgn->pSample->pInfo->Name.c_str()),
# Line 459  static void copyDimensionRegions(gig::Re Line 465  static void copyDimensionRegions(gig::Re
465              // re-select target dimension region (with correct velocity zone)              // re-select target dimension region (with correct velocity zone)
466              DimensionZones dstZones = preciseDimensionZonesFor(gig::dimension_velocity, dstDimRgn);              DimensionZones dstZones = preciseDimensionZonesFor(gig::dimension_velocity, dstDimRgn);
467              assert(dstZones.size() > 1);              assert(dstZones.size() > 1);
468              int iZoneIndex = dstDimCase[gig::dimension_velocity];              const int iDstZoneIndex =
469              e.velocityZone = iZoneIndex;                  (mainDim == gig::dimension_velocity)
470                        ? iDstMainBit : dstDimCase[gig::dimension_velocity]; // (mainDim == gig::dimension_velocity) exception case probably unnecessary here
471                e.velocityZone = iDstZoneIndex;
472              #if DEBUG_COMBINE_INSTRUMENTS              #if DEBUG_COMBINE_INSTRUMENTS
473              printf("dst velocity zone: %d/%d\n", iZoneIndex, (int)dstZones.size());              printf("dst velocity zone: %d/%d\n", iDstZoneIndex, (int)dstZones.size());
474              #endif              #endif
475              assert(uint(iZoneIndex) < dstZones.size());              assert(uint(iDstZoneIndex) < dstZones.size());
476              dstDimCase[gig::dimension_velocity] = dstZones[iZoneIndex].low; // arbitrary value between low and high              dstDimCase[gig::dimension_velocity] = dstZones[iDstZoneIndex].low; // arbitrary value between low and high
477              #if DEBUG_COMBINE_INSTRUMENTS              #if DEBUG_COMBINE_INSTRUMENTS
478              printf("dst velocity value = %d\n", dstDimCase[gig::dimension_velocity]);              printf("dst velocity value = %d\n", dstDimCase[gig::dimension_velocity]);
479              printf("dst refilled "); fflush(stdout);              printf("dst refilled "); fflush(stdout);
480              #endif              #endif
481              fillDimValues(dstDimValues, dstDimCase, outRgn, true);              fillDimValues(dstDimValues, dstDimCase, outRgn, false);
482              dstDimRgn = outRgn->GetDimensionRegionByValue(dstDimValues);              dstDimRgn = outRgn->GetDimensionRegionByValue(dstDimValues);
483              #if DEBUG_COMBINE_INSTRUMENTS              #if DEBUG_COMBINE_INSTRUMENTS
484              printf("reselected dstDimRgn=%lx\n", (uint64_t)dstDimRgn);              printf("reselected dstDimRgn=%lx\n", (uint64_t)dstDimRgn);
485              printf("dstSample='%s'\n",              printf("dstSample='%s'%s\n",
486                  (!dstDimRgn->pSample ? "NULL" : dstDimRgn->pSample->pInfo->Name.c_str())                  (!dstDimRgn->pSample ? "NULL" : dstDimRgn->pSample->pInfo->Name.c_str()),
487                    (dstDimRgn->pSample ? " <--- ERROR ERROR ERROR !!!!!!!!! " : "")
488              );              );
489              #endif              #endif
490    
# Line 484  static void copyDimensionRegions(gig::Re Line 493  static void copyDimensionRegions(gig::Re
493              if (inRgn->GetDimensionDefinition(gig::dimension_velocity)) {              if (inRgn->GetDimensionDefinition(gig::dimension_velocity)) {
494                  DimensionZones srcZones = preciseDimensionZonesFor(gig::dimension_velocity, srcDimRgn);                  DimensionZones srcZones = preciseDimensionZonesFor(gig::dimension_velocity, srcDimRgn);
495                  e.totalSrcVelocityZones = srcZones.size();                  e.totalSrcVelocityZones = srcZones.size();
496                  assert(srcZones.size() > 1);                  assert(srcZones.size() > 0);
497                  if (uint(iZoneIndex) >= srcZones.size())                  if (srcZones.size() <= 1) {
498                      iZoneIndex  = srcZones.size() - 1;                      addWarning("Input region has a velocity dimension with only ONE zone!");
499                  srcDimCase[gig::dimension_velocity] = srcZones[iZoneIndex].low; // same zone as used above for target dimension region (no matter what the precise zone ranges are)                  }
500                    int iSrcZoneIndex =
501                        (mainDim == gig::dimension_velocity)
502                            ? iSrcMainBit : iDstZoneIndex;
503                    if (uint(iSrcZoneIndex) >= srcZones.size())
504                        iSrcZoneIndex = srcZones.size() - 1;
505                    srcDimCase[gig::dimension_velocity] = srcZones[iSrcZoneIndex].low; // same zone as used above for target dimension region (no matter what the precise zone ranges are)
506                  #if DEBUG_COMBINE_INSTRUMENTS                  #if DEBUG_COMBINE_INSTRUMENTS
507                  printf("src refilled "); fflush(stdout);                  printf("src refilled "); fflush(stdout);
508                  #endif                  #endif
# Line 502  static void copyDimensionRegions(gig::Re Line 517  static void copyDimensionRegions(gig::Re
517              }              }
518          }          }
519    
520          // Schedule copy opertion of source -> target DimensionRegion for the          // Schedule copy operation of source -> target DimensionRegion for the
521          // time after all nested loops have been traversed. We have to postpone          // time after all nested loops have been traversed. We have to postpone
522          // the actual copy operations this way, because otherwise it would          // the actual copy operations this way, because otherwise it would
523          // overwrite informations inside the destination DimensionRegion object          // overwrite informations inside the destination DimensionRegion object
# Line 533  static void copyDimensionRegions(gig::Re Line 548  static void copyDimensionRegions(gig::Re
548          dimCase[type] = (def->split_type == gig::split_type_bit) ? iZone : zoneRange.low;          dimCase[type] = (def->split_type == gig::split_type_bit) ? iZone : zoneRange.low;
549    
550          // recurse until 'dims' is exhausted (and dimCase filled up with concrete value)          // recurse until 'dims' is exhausted (and dimCase filled up with concrete value)
551          copyDimensionRegions(outRgn, inRgn, dims, iDstLayer, iSrcLayer, dimCase, schedule);          scheduleCopyDimensionRegions(outRgn, inRgn, dims, mainDim, iDstMainBit, iSrcMainBit, schedule, dimCase);
552      }      }
553    }
554    
555      // if current function call is the (very first) entry point ...  static OrderedRegionGroup sortRegionGroup(const RegionGroup& group, const std::vector<gig::Instrument*>& instruments) {
556      if (isHighestLevelOfRecursion) {      OrderedRegionGroup result;
557          // ... then perform all scheduled DimensionRegion copy operations      for (std::vector<gig::Instrument*>::const_iterator it = instruments.begin();
558          for (uint i = 0; i < schedule->size(); ++i) {           it != instruments.end(); ++it)
559              CopyAssignSchedEntry& e = (*schedule)[i];      {
560            RegionGroup::const_iterator itRgn = group.find(*it);
561              // backup the target DimensionRegion's current dimension zones upper          if (itRgn == group.end()) continue;
562              // limits (because the target DimensionRegion's upper limits are          result.push_back(
563              // already defined correctly since calling AddDimension(), and the              std::pair<gig::Instrument*, gig::Region*>(
564              // CopyAssign() call next, will overwrite those upper limits                  itRgn->first, itRgn->second
565              // unfortunately              )
566              DimensionRegionUpperLimits dstUpperLimits = getDimensionRegionUpperLimits(e.dst);          );
             DimensionRegionUpperLimits srcUpperLimits = getDimensionRegionUpperLimits(e.src);  
   
             // now actually copy over the current DimensionRegion  
             const gig::Region* const origRgn = e.dst->GetParent(); // just for sanity check below  
             e.dst->CopyAssign(e.src);  
             assert(origRgn == e.dst->GetParent()); // if gigedit is crashing here, then you must update libgig (to at least SVN r2547, v3.3.0.svn10)  
   
             // restore all original dimension zone upper limits except of the  
             // velocity dimension, because the velocity dimension zone sizes are  
             // allowed to differ for individual DimensionRegions in gig v3  
             // format  
             if (srcUpperLimits.count(gig::dimension_velocity)) {  
                 assert(dstUpperLimits.count(gig::dimension_velocity));  
                 dstUpperLimits[gig::dimension_velocity] =  
                     (e.velocityZone >= e.totalSrcVelocityZones)  
                         ? 127 : srcUpperLimits[gig::dimension_velocity];  
             }  
             restoreDimensionRegionUpperLimits(e.dst, dstUpperLimits);  
         }  
         delete schedule;  
567      }      }
568        return result;
569  }  }
570    
571  /** @brief Combine given list of instruments to one instrument.  /** @brief Combine given list of instruments to one instrument.
572   *   *
573   * Takes a list of @a instruments as argument and combines them to one single   * Takes a list of @a instruments as argument and combines them to one single
574   * new @a output instrument. For this task, it will create a 'layer' dimension   * new @a output instrument. For this task, it will create a dimension of type
575   * in the new instrument and copies the source instruments to those layers.   * given by @a mainDimension in the new instrument and copies the source
576     * instruments to those dimension zones.
577   *   *
578   * @param instruments - (input) list of instruments that shall be combined,   * @param instruments - (input) list of instruments that shall be combined,
579   *                      they will only be read, so they will be left untouched   *                      they will only be read, so they will be left untouched
# Line 583  static void copyDimensionRegions(gig::Re Line 581  static void copyDimensionRegions(gig::Re
581   *              be created   *              be created
582   * @param output - (output) on success this pointer will be set to the new   * @param output - (output) on success this pointer will be set to the new
583   *                 instrument being created   *                 instrument being created
584     * @param mainDimension - the dimension that shall be used to combine the
585     *                        instruments
586   * @throw RIFF::Exception on any kinds of errors   * @throw RIFF::Exception on any kinds of errors
587   */   */
588  static void combineInstruments(std::vector<gig::Instrument*>& instruments, gig::File* gig, gig::Instrument*& output) {  static void combineInstruments(std::vector<gig::Instrument*>& instruments, gig::File* gig, gig::Instrument*& output, gig::dimension_t mainDimension) {
589      output = NULL;      output = NULL;
590    
591      // divide the individual regions to (probably even smaller) groups of      // divide the individual regions to (probably even smaller) groups of
# Line 618  static void combineInstruments(std::vect Line 618  static void combineInstruments(std::vect
618      {      {
619          gig::Region* outRgn = outInstr->AddRegion();          gig::Region* outRgn = outInstr->AddRegion();
620          outRgn->SetKeyRange(itGroup->first.low, itGroup->first.high);          outRgn->SetKeyRange(itGroup->first.low, itGroup->first.high);
621            #if DEBUG_COMBINE_INSTRUMENTS
622            printf("---> Start target region %d..%d\n", itGroup->first.low, itGroup->first.high);
623            #endif
624    
625          // detect the total amount of layers required to build up this combi          // detect the total amount of zones required for the given main
626          // for current key range          // dimension to build up this combi for current key range
627          int iTotalLayers = 0;          int iTotalZones = 0;
628          for (RegionGroup::iterator itRgn = itGroup->second.begin();          for (RegionGroup::iterator itRgn = itGroup->second.begin();
629               itRgn != itGroup->second.end(); ++itRgn)               itRgn != itGroup->second.end(); ++itRgn)
630          {          {
631              gig::Region* inRgn = itRgn->second;              gig::Region* inRgn = itRgn->second;
632              iTotalLayers += inRgn->Layers;              gig::dimension_def_t* def = inRgn->GetDimensionDefinition(mainDimension);
633                iTotalZones += (def) ? def->zones : 1;
634          }          }
635            #if DEBUG_COMBINE_INSTRUMENTS
636            printf("Required total zones: %d, vertical regions: %d\n", iTotalZones, itGroup->second.size());
637            #endif
638    
639          // create all required dimensions for this output region          // create all required dimensions for this output region
640          // (except the layer dimension, which we create as next step)          // (except the main dimension used for separating the individual
641            // instruments, we create that particular dimension as next step)
642          Dimensions dims = getDimensionsForRegionGroup(itGroup->second);          Dimensions dims = getDimensionsForRegionGroup(itGroup->second);
643          for (Dimensions::iterator itDim = dims.begin();          // the given main dimension which is used to combine the instruments is
644               itDim != dims.end(); ++itDim)          // created separately after the next code block, and the main dimension
645            // should not be part of dims here, because it also used for iterating
646            // all dimensions zones, which would lead to this dimensions being
647            // iterated twice
648            dims.erase(mainDimension);
649          {          {
650              if (itDim->first == gig::dimension_layer) continue;              std::vector<gig::dimension_t> skipTheseDimensions; // used to prevent a misbehavior (i.e. crash) of the combine algorithm in case one of the source instruments has a dimension with only one zone, which is not standard conform
651    
652              gig::dimension_def_t def;              for (Dimensions::iterator itDim = dims.begin();
653              def.dimension = itDim->first; // dimension type                  itDim != dims.end(); ++itDim)
654              def.zones = itDim->second.size();              {
655              def.bits = zoneCountToBits(def.zones);                  gig::dimension_def_t def;
656              #if DEBUG_COMBINE_INSTRUMENTS                  def.dimension = itDim->first; // dimension type
657              std::cout << "Adding new regular dimension type=" << std::hex << (int)def.dimension << std::dec << ", zones=" << (int)def.zones << ", bits=" << (int)def.bits << " ... " << std::flush;                  def.zones = itDim->second.size();
658              #endif                  def.bits = zoneCountToBits(def.zones);
659              outRgn->AddDimension(&def);                  if (def.zones < 2) {
660              #if DEBUG_COMBINE_INSTRUMENTS                      addWarning(
661              std::cout << "OK" << std::endl << std::flush;                          "Attempt to create dimension with type=0x%x with only "
662              #endif                          "ONE zone (because at least one of the source "
663                            "instruments seems to have such a velocity dimension "
664                            "with only ONE zone, which is odd)! Skipping this "
665                            "dimension for now.",
666                            (int)itDim->first
667                        );
668                        skipTheseDimensions.push_back(itDim->first);
669                        continue;
670                    }
671                    #if DEBUG_COMBINE_INSTRUMENTS
672                    std::cout << "Adding new regular dimension type=" << std::hex << (int)def.dimension << std::dec << ", zones=" << (int)def.zones << ", bits=" << (int)def.bits << " ... " << std::flush;
673                    #endif
674                    outRgn->AddDimension(&def);
675                    #if DEBUG_COMBINE_INSTRUMENTS
676                    std::cout << "OK" << std::endl << std::flush;
677                    #endif
678                }
679                // prevent the following dimensions to be processed further below
680                // (since the respective dimension was not created above)
681                for (int i = 0; i < skipTheseDimensions.size(); ++i)
682                    dims.erase(skipTheseDimensions[i]);
683          }          }
684    
685          // create the layer dimension (if necessary for current key range)          // create the main dimension (if necessary for current key range)
686          if (iTotalLayers > 1) {          if (iTotalZones > 1) {
687              gig::dimension_def_t def;              gig::dimension_def_t def;
688              def.dimension = gig::dimension_layer; // dimension type              def.dimension = mainDimension; // dimension type
689              def.zones = iTotalLayers;              def.zones = iTotalZones;
690              def.bits = zoneCountToBits(def.zones);              def.bits = zoneCountToBits(def.zones);
691              #if DEBUG_COMBINE_INSTRUMENTS              #if DEBUG_COMBINE_INSTRUMENTS
692              std::cout << "Adding new (layer) dimension type=" << std::hex << (int)def.dimension << std::dec << ", zones=" << (int)def.zones << ", bits=" << (int)def.bits << " ... " << std::flush;              std::cout << "Adding new main combi dimension type=" << std::hex << (int)def.dimension << std::dec << ", zones=" << (int)def.zones << ", bits=" << (int)def.bits << " ... " << std::flush;
693              #endif              #endif
694              outRgn->AddDimension(&def);              outRgn->AddDimension(&def);
695              #if DEBUG_COMBINE_INSTRUMENTS              #if DEBUG_COMBINE_INSTRUMENTS
696              std::cout << "OK" << std::endl << std::flush;              std::cout << "OK" << std::endl << std::flush;
697              #endif              #endif
698            } else {
699                dims.erase(mainDimension);
700          }          }
701    
702          // now copy the source dimension regions to the target dimension regions          // for the next task we need to have the current RegionGroup to be
703          int iDstLayer = 0;          // sorted by instrument in the same sequence as the 'instruments' vector
704          for (RegionGroup::iterator itRgn = itGroup->second.begin();          // argument passed to this function (because the std::map behind the
705               itRgn != itGroup->second.end(); ++itRgn) // iterate over 'vertical' / source regions ...          // 'RegionGroup' type sorts by memory address instead, and that would
706            // sometimes lead to the source instruments' region to be sorted into
707            // the wrong target layer)
708            OrderedRegionGroup currentGroup = sortRegionGroup(itGroup->second, instruments);
709    
710            // schedule copying the source dimension regions to the target dimension
711            // regions
712            CopyAssignSchedule schedule;
713            int iDstMainBit = 0;
714            for (OrderedRegionGroup::iterator itRgn = currentGroup.begin();
715                 itRgn != currentGroup.end(); ++itRgn) // iterate over 'vertical' / source regions ...
716          {          {
717              gig::Region* inRgn = itRgn->second;              gig::Region* inRgn = itRgn->second;
718              for (uint iSrcLayer = 0; iSrcLayer < inRgn->Layers; ++iSrcLayer, ++iDstLayer) {              #if DEBUG_COMBINE_INSTRUMENTS
719                  copyDimensionRegions(outRgn, inRgn, dims, iDstLayer, iSrcLayer);              printf("[source region of '%s']\n", inRgn->GetParent()->pInfo->Name.c_str());
720                #endif
721    
722                // determine how many main dimension zones this input region requires
723                gig::dimension_def_t* def = inRgn->GetDimensionDefinition(mainDimension);
724                const int inRgnMainZones = (def) ? def->zones : 1;
725    
726                for (uint iSrcMainBit = 0; iSrcMainBit < inRgnMainZones; ++iSrcMainBit, ++iDstMainBit) {
727                    scheduleCopyDimensionRegions(
728                        outRgn, inRgn, dims, mainDimension,
729                        iDstMainBit, iSrcMainBit, &schedule
730                    );
731                }
732            }
733    
734            // finally copy the scheduled source -> target dimension regions
735            for (uint i = 0; i < schedule.size(); ++i) {
736                CopyAssignSchedEntry& e = schedule[i];
737    
738                // backup the target DimensionRegion's current dimension zones upper
739                // limits (because the target DimensionRegion's upper limits are
740                // already defined correctly since calling AddDimension(), and the
741                // CopyAssign() call next, will overwrite those upper limits
742                // unfortunately
743                DimensionRegionUpperLimits dstUpperLimits = getDimensionRegionUpperLimits(e.dst);
744                DimensionRegionUpperLimits srcUpperLimits = getDimensionRegionUpperLimits(e.src);
745    
746                // now actually copy over the current DimensionRegion
747                const gig::Region* const origRgn = e.dst->GetParent(); // just for sanity check below
748                e.dst->CopyAssign(e.src);
749                assert(origRgn == e.dst->GetParent()); // if gigedit is crashing here, then you must update libgig (to at least SVN r2547, v3.3.0.svn10)
750    
751                // restore all original dimension zone upper limits except of the
752                // velocity dimension, because the velocity dimension zone sizes are
753                // allowed to differ for individual DimensionRegions in gig v3
754                // format
755                //
756                // if the main dinension is the 'velocity' dimension, then skip
757                // restoring the source's original velocity zone limits, because
758                // dealing with merging that is not implemented yet
759                // TODO: merge custom velocity splits if main dimension is the velocity dimension (for now equal sized velocity zones are used if mainDim is 'velocity')
760                if (srcUpperLimits.count(gig::dimension_velocity) && mainDimension != gig::dimension_velocity) {
761                    if (!dstUpperLimits.count(gig::dimension_velocity)) {
762                        addWarning("Source instrument seems to have a velocity dimension whereas new target instrument doesn't!");
763                    } else {
764                        dstUpperLimits[gig::dimension_velocity] =
765                            (e.velocityZone >= e.totalSrcVelocityZones)
766                                ? 127 : srcUpperLimits[gig::dimension_velocity];
767                    }
768              }              }
769                restoreDimensionRegionUpperLimits(e.dst, dstUpperLimits);
770          }          }
771      }      }
772    
# Line 685  static void combineInstruments(std::vect Line 778  static void combineInstruments(std::vect
778  // class 'CombineInstrumentsDialog'  // class 'CombineInstrumentsDialog'
779    
780  CombineInstrumentsDialog::CombineInstrumentsDialog(Gtk::Window& parent, gig::File* gig)  CombineInstrumentsDialog::CombineInstrumentsDialog(Gtk::Window& parent, gig::File* gig)
781      : Gtk::Dialog(_("Combine Instruments"), parent, true),      : ManagedDialog(_("Combine Instruments"), parent, true),
782        m_gig(gig), m_fileWasChanged(false), m_newCombinedInstrument(NULL),        m_gig(gig), m_fileWasChanged(false), m_newCombinedInstrument(NULL),
783        m_cancelButton(Gtk::Stock::CANCEL), m_OKButton(Gtk::Stock::OK),        m_cancelButton(_("_Cancel"), true), m_OKButton(_("_OK"), true),
784        m_descriptionLabel()        m_descriptionLabel(), m_tableDimCombo(2, 2), m_comboDimType(),
785          m_labelDimType(Glib::ustring(_("Combine by Dimension:")) + "  ", Gtk::ALIGN_END)
786  {  {
787        m_scrolledWindow.add(m_treeView);
788        m_scrolledWindow.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
789    
790      get_vbox()->pack_start(m_descriptionLabel, Gtk::PACK_SHRINK);      get_vbox()->pack_start(m_descriptionLabel, Gtk::PACK_SHRINK);
791      get_vbox()->pack_start(m_treeView);      get_vbox()->pack_start(m_tableDimCombo, Gtk::PACK_SHRINK);
792        get_vbox()->pack_start(m_scrolledWindow);
793      get_vbox()->pack_start(m_buttonBox, Gtk::PACK_SHRINK);      get_vbox()->pack_start(m_buttonBox, Gtk::PACK_SHRINK);
794    
795  #if GTKMM_MAJOR_VERSION >= 3  #if GTKMM_MAJOR_VERSION >= 3
796      description.set_line_wrap();      m_descriptionLabel.set_line_wrap();
797  #endif  #endif
798      m_descriptionLabel.set_text(_(      m_descriptionLabel.set_text(_(
799          "Select at least two instruments below that shall be combined  "          "Select at least two instruments below that shall be combined (as "
800          "as layers (using a \"Layer\" dimension) to a new instrument. The "          "separate dimension zones of the selected dimension type) as a new "
801          "original instruments remain untouched.")          "instrument. The original instruments remain untouched.\n\n"
802      );          "You may use this tool for example to combine solo instruments into "
803            "a combi sound arrangement by selecting the 'layer' dimension, or you "
804            "might combine similar sounding solo sounds into separate velocity "
805            "split layers by using the 'velocity' dimension, and so on."
806        ));
807    
808        // add dimension type combo box
809        {
810            int iLayerDimIndex = -1;
811            Glib::RefPtr<Gtk::ListStore> refComboModel = Gtk::ListStore::create(m_comboDimsModel);
812            for (int i = 0x01, iRow = 0; i < 0xff; i++) {
813                Glib::ustring sType =
814                    dimTypeAsString(static_cast<gig::dimension_t>(i));
815                if (sType.find("Unknown") != 0) {
816                    Gtk::TreeModel::Row row = *(refComboModel->append());
817                    row[m_comboDimsModel.m_type_id]   = i;
818                    row[m_comboDimsModel.m_type_name] = sType;
819                    if (i == gig::dimension_layer) iLayerDimIndex = iRow;
820                    iRow++;
821                }
822            }
823            m_comboDimType.set_model(refComboModel);
824            m_comboDimType.pack_start(m_comboDimsModel.m_type_id);
825            m_comboDimType.pack_start(m_comboDimsModel.m_type_name);
826            m_tableDimCombo.attach(m_labelDimType, 0, 1, 0, 1);
827            m_tableDimCombo.attach(m_comboDimType, 1, 2, 0, 1);
828            m_comboDimType.set_active(iLayerDimIndex); // preselect "layer" dimension
829        }
830    
831      m_refTreeModel = Gtk::ListStore::create(m_columns);      m_refTreeModel = Gtk::ListStore::create(m_columns);
832      m_treeView.set_model(m_refTreeModel);      m_treeView.set_model(m_refTreeModel);
# Line 786  void CombineInstrumentsDialog::combineSe Line 911  void CombineInstrumentsDialog::combineSe
911          instruments.push_back(instrument);          instruments.push_back(instrument);
912      }      }
913    
914        g_warnings.clear();
915    
916      try {      try {
917          combineInstruments(instruments, m_gig, m_newCombinedInstrument);          // which main dimension was selected in the combo box?
918            gig::dimension_t mainDimension;
919            {
920                Gtk::TreeModel::iterator iterType = m_comboDimType.get_active();
921                if (!iterType) throw gig::Exception("No dimension selected");
922                Gtk::TreeModel::Row rowType = *iterType;
923                if (!rowType) throw gig::Exception("Something is wrong regarding dimension selection");
924                int iTypeID = rowType[m_comboDimsModel.m_type_id];
925                mainDimension = static_cast<gig::dimension_t>(iTypeID);
926            }
927    
928            // now start the actual cobination task ...
929            combineInstruments(instruments, m_gig, m_newCombinedInstrument, mainDimension);
930      } catch (RIFF::Exception e) {;      } catch (RIFF::Exception e) {;
931          Gtk::MessageDialog msg(*this, e.Message, false, Gtk::MESSAGE_ERROR);          Gtk::MessageDialog msg(*this, e.Message, false, Gtk::MESSAGE_ERROR);
932          msg.run();          msg.run();
933          return;          return;
934        } catch (...) {
935            Glib::ustring txt = _("An unknown exception occurred!");
936            Gtk::MessageDialog msg(*this, txt, false, Gtk::MESSAGE_ERROR);
937            msg.run();
938            return;
939        }
940    
941        if (!g_warnings.empty()) {
942            Glib::ustring txt = _(
943                "Combined instrument was created successfully, but there were warnings:"
944            );
945            txt += "\n\n";
946            for (Warnings::const_iterator itWarn = g_warnings.begin();
947                 itWarn != g_warnings.end(); ++itWarn)
948            {
949                txt += "-> " + *itWarn + "\n";
950            }
951            txt += "\n";
952            txt += _(
953                "You might also want to check the console for further warnings and "
954                "error messages."
955            );
956            Gtk::MessageDialog msg(*this, txt, false, Gtk::MESSAGE_WARNING);
957            msg.run();
958      }      }
959    
960      // no error occurred      // no error occurred
Legend:
Removed from v.2550  
changed lines
  Added in v.3151
  ViewVC Help
Powered by ViewVC