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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2616 - (show annotations) (download)
Tue Jun 10 20:20:21 2014 UTC (5 years, 4 months ago) by schoenebeck
File size: 43867 byte(s)
* Fixed a crash in "combine instruments" dialog which happened when
  there was a region which did not overlap with a region of the
  other instrument.
* Added scrollbar to "combine instruments" selection list.

1 /*
2 Copyright (c) 2014 Christian Schoenebeck
3
4 This file is part of "gigedit" and released under the terms of the
5 GNU General Public License version 2.
6 */
7
8 #include "CombineInstrumentsDialog.h"
9
10 // enable this for debug messages being printed while combining the instruments
11 #define DEBUG_COMBINE_INSTRUMENTS 0
12
13 #include "global.h"
14 #include "compat.h"
15
16 #include <set>
17 #include <iostream>
18 #include <assert.h>
19 #include <stdarg.h>
20 #include <string.h>
21
22 #include <glibmm/ustring.h>
23 #include <gtkmm/stock.h>
24 #include <gtkmm/messagedialog.h>
25 #include <gtkmm/label.h>
26
27 Glib::ustring gig_to_utf8(const gig::String& gig_string);
28 Glib::ustring dimTypeAsString(gig::dimension_t d);
29
30 typedef std::vector< std::pair<gig::Instrument*, gig::Region*> > OrderedRegionGroup;
31 typedef std::map<gig::Instrument*, gig::Region*> RegionGroup;
32 typedef std::map<DLS::range_t,RegionGroup> RegionGroups;
33
34 typedef std::vector<DLS::range_t> DimensionZones;
35 typedef std::map<gig::dimension_t,DimensionZones> Dimensions;
36
37 typedef std::map<gig::dimension_t,int> DimensionCase;
38
39 typedef std::map<gig::dimension_t, int> DimensionRegionUpperLimits;
40
41 typedef std::set<Glib::ustring> Warnings;
42
43 ///////////////////////////////////////////////////////////////////////////
44 // private static data
45
46 static Warnings g_warnings;
47
48 ///////////////////////////////////////////////////////////////////////////
49 // private functions
50
51 #if DEBUG_COMBINE_INSTRUMENTS
52 static void printRanges(const RegionGroups& regions) {
53 std::cout << "{ ";
54 for (RegionGroups::const_iterator it = regions.begin(); it != regions.end(); ++it) {
55 if (it != regions.begin()) std::cout << ", ";
56 std::cout << (int)it->first.low << ".." << (int)it->first.high;
57 }
58 std::cout << " }" << std::flush;
59 }
60 #endif
61
62 /**
63 * Store a warning message that shall be stored and displayed to the user as a
64 * list of warnings after the overall operation has finished. Duplicate warning
65 * messages are automatically eliminated.
66 */
67 inline void addWarning(const char* fmt, ...) {
68 va_list arg;
69 va_start(arg, fmt);
70 const int SZ = 255 + strlen(fmt);
71 char* buf = new char[SZ];
72 vsnprintf(buf, SZ, fmt, arg);
73 Glib::ustring s = buf;
74 delete [] buf;
75 va_end(arg);
76 std::cerr << _("WARNING:") << " " << s << std::endl << std::flush;
77 g_warnings.insert(s);
78 }
79
80 /**
81 * If the two ranges overlap, then this function returns the smallest point
82 * within that overlapping zone. If the two ranges do not overlap, then this
83 * function will return -1 instead.
84 */
85 inline int smallestOverlapPoint(const DLS::range_t& r1, const DLS::range_t& r2) {
86 if (r1.overlaps(r2.low)) return r2.low;
87 if (r2.overlaps(r1.low)) return r1.low;
88 return -1;
89 }
90
91 /**
92 * Get the most smallest region point (not necessarily its region start point)
93 * of all regions of the given instruments, start searching at keyboard
94 * position @a iStart.
95 *
96 * @returns very first region point >= iStart, or -1 if no region could be
97 * found with a range member point >= iStart
98 */
99 static int findLowestRegionPoint(std::vector<gig::Instrument*>& instruments, int iStart) {
100 DLS::range_t searchRange = { iStart, 127 };
101 int result = -1;
102 for (uint i = 0; i < instruments.size(); ++i) {
103 gig::Instrument* instr = instruments[i];
104 for (gig::Region* rgn = instr->GetFirstRegion(); rgn; rgn = instr->GetNextRegion()) {
105 if (rgn->KeyRange.overlaps(searchRange)) {
106 int lowest = smallestOverlapPoint(rgn->KeyRange, searchRange);
107 if (result == -1 || lowest < result) result = lowest;
108 }
109 }
110 }
111 return result;
112 }
113
114 /**
115 * Get the most smallest region end of all regions of the given instruments,
116 * start searching at keyboard position @a iStart.
117 *
118 * @returns very first region end >= iStart, or -1 if no region could be found
119 * with a range end >= iStart
120 */
121 static int findFirstRegionEnd(std::vector<gig::Instrument*>& instruments, int iStart) {
122 DLS::range_t searchRange = { iStart, 127 };
123 int result = -1;
124 for (uint i = 0; i < instruments.size(); ++i) {
125 gig::Instrument* instr = instruments[i];
126 for (gig::Region* rgn = instr->GetFirstRegion(); rgn; rgn = instr->GetNextRegion()) {
127 if (rgn->KeyRange.overlaps(searchRange)) {
128 if (result == -1 || rgn->KeyRange.high < result)
129 result = rgn->KeyRange.high;
130 }
131 }
132 }
133 return result;
134 }
135
136 /**
137 * Returns a list of all regions of the given @a instrument where the respective
138 * region's key range overlaps the given @a range.
139 */
140 static std::vector<gig::Region*> getAllRegionsWhichOverlapRange(gig::Instrument* instrument, DLS::range_t range) {
141 //std::cout << "All regions which overlap { " << (int)range.low << ".." << (int)range.high << " } : " << std::flush;
142 std::vector<gig::Region*> v;
143 for (gig::Region* rgn = instrument->GetFirstRegion(); rgn; rgn = instrument->GetNextRegion()) {
144 if (rgn->KeyRange.overlaps(range)) {
145 v.push_back(rgn);
146 //std::cout << (int)rgn->KeyRange.low << ".." << (int)rgn->KeyRange.high << ", " << std::flush;
147 }
148 }
149 //std::cout << " END." << std::endl;
150 return v;
151 }
152
153 /**
154 * Returns all regions of the given @a instruments where the respective region's
155 * key range overlaps the given @a range. The regions returned are ordered (in a
156 * map) by their instrument pointer.
157 */
158 static RegionGroup getAllRegionsWhichOverlapRange(std::vector<gig::Instrument*>& instruments, DLS::range_t range) {
159 RegionGroup group;
160 for (uint i = 0; i < instruments.size(); ++i) {
161 gig::Instrument* instr = instruments[i];
162 std::vector<gig::Region*> v = getAllRegionsWhichOverlapRange(instr, range);
163 if (v.empty()) continue;
164 if (v.size() > 1) {
165 addWarning("More than one region found!");
166 }
167 group[instr] = v[0];
168 }
169 return group;
170 }
171
172 /** @brief Identify required regions.
173 *
174 * Takes a list of @a instruments as argument (which are planned to be combined
175 * as separate dimension zones of a certain dimension into one single new
176 * instrument) and fulfills the following tasks:
177 *
178 * - 1. Identification of total amount of regions required to create a new
179 * instrument to become a combined version of the given instruments.
180 * - 2. Precise key range of each of those identified required regions to be
181 * created in that new instrument.
182 * - 3. Grouping the original source regions of the given original instruments
183 * to the respective target key range (new region) of the instrument to be
184 * created.
185 *
186 * @param instruments - list of instruments that are planned to be combined
187 * @returns structured result of the tasks described above
188 */
189 static RegionGroups groupByRegionIntersections(std::vector<gig::Instrument*>& instruments) {
190 RegionGroups groups;
191
192 // find all region intersections of all instruments
193 std::vector<DLS::range_t> intersections;
194 for (int iStart = 0; iStart <= 127; ) {
195 iStart = findLowestRegionPoint(instruments, iStart);
196 if (iStart < 0) break;
197 const int iEnd = findFirstRegionEnd(instruments, iStart);
198 DLS::range_t range = { iStart, iEnd };
199 intersections.push_back(range);
200 iStart = iEnd + 1;
201 }
202
203 // now sort all regions to those found intersections
204 for (uint i = 0; i < intersections.size(); ++i) {
205 const DLS::range_t& range = intersections[i];
206 RegionGroup group = getAllRegionsWhichOverlapRange(instruments, range);
207 if (!group.empty())
208 groups[range] = group;
209 else
210 addWarning("Empty region group!");
211 }
212
213 return groups;
214 }
215
216 /** @brief Identify required dimensions.
217 *
218 * Takes a planned new region (@a regionGroup) as argument and identifies which
219 * precise dimensions would have to be created for that new region, along with
220 * the amount of dimension zones and their precise individual zone sizes.
221 *
222 * @param regionGroup - planned new region for a new instrument
223 * @returns set of dimensions that shall be created for the given planned region
224 */
225 static Dimensions getDimensionsForRegionGroup(RegionGroup& regionGroup) {
226 std::map<gig::dimension_t, std::set<int> > dimUpperLimits;
227
228 // collect all dimension region zones' upper limits
229 for (RegionGroup::iterator it = regionGroup.begin();
230 it != regionGroup.end(); ++it)
231 {
232 gig::Region* rgn = it->second;
233 int previousBits = 0;
234 for (uint d = 0; d < rgn->Dimensions; ++d) {
235 const gig::dimension_def_t& def = rgn->pDimensionDefinitions[d];
236 for (uint z = 0; z < def.zones; ++z) {
237 int dr = z << previousBits;
238 gig::DimensionRegion* dimRgn = rgn->pDimensionRegions[dr];
239 // Store the individual dimension zone sizes (or actually their
240 // upper limits here) for each dimension.
241 // HACK: Note that the velocity dimension is specially handled
242 // here. Instead of taking over custom velocity split sizes
243 // here, only a bogus number (zone index number) is stored for
244 // each velocity zone, that way only the maxiumum amount of
245 // velocity splits of all regions is stored here, and when their
246 // individual DimensionRegions are finally copied (later), the
247 // individual velocity split size are copied by that.
248 dimUpperLimits[def.dimension].insert(
249 (def.dimension == gig::dimension_velocity) ?
250 z : (def.split_type == gig::split_type_bit) ?
251 ((z+1) * 128/def.zones - 1) : dimRgn->DimensionUpperLimits[dr]
252 );
253 }
254 previousBits += def.bits;
255 }
256 }
257
258 // convert upper limit set to range vector
259 Dimensions dims;
260 for (std::map<gig::dimension_t, std::set<int> >::const_iterator it = dimUpperLimits.begin();
261 it != dimUpperLimits.end(); ++it)
262 {
263 gig::dimension_t type = it->first;
264 int iLow = 0;
265 for (std::set<int>::const_iterator itNums = it->second.begin();
266 itNums != it->second.end(); ++itNums)
267 {
268 const int iUpperLimit = *itNums;
269 DLS::range_t range = { iLow, iUpperLimit };
270 dims[type].push_back(range);
271 iLow = iUpperLimit + 1;
272 }
273 }
274
275 return dims;
276 }
277
278 inline int getDimensionIndex(gig::dimension_t type, gig::Region* rgn) {
279 for (uint i = 0; i < rgn->Dimensions; ++i)
280 if (rgn->pDimensionDefinitions[i].dimension == type)
281 return i;
282 return -1;
283 }
284
285 static void fillDimValues(uint* values/*[8]*/, DimensionCase dimCase, gig::Region* rgn, bool bShouldHaveAllDimensionsPassed) {
286 #if DEBUG_COMBINE_INSTRUMENTS
287 printf("dimvalues = { ");
288 fflush(stdout);
289 #endif
290 for (DimensionCase::iterator it = dimCase.begin(); it != dimCase.end(); ++it) {
291 gig::dimension_t type = it->first;
292 int iDimIndex = getDimensionIndex(type, rgn);
293 if (bShouldHaveAllDimensionsPassed) assert(iDimIndex >= 0);
294 else if (iDimIndex < 0) continue;
295 values[iDimIndex] = it->second;
296 #if DEBUG_COMBINE_INSTRUMENTS
297 printf("%x=%d, ", type, it->second);
298 #endif
299 }
300 #if DEBUG_COMBINE_INSTRUMENTS
301 printf("}\n");
302 #endif
303 }
304
305 static DimensionRegionUpperLimits getDimensionRegionUpperLimits(gig::DimensionRegion* dimRgn) {
306 DimensionRegionUpperLimits limits;
307 gig::Region* rgn = dimRgn->GetParent();
308 for (uint d = 0; d < rgn->Dimensions; ++d) {
309 const gig::dimension_def_t& def = rgn->pDimensionDefinitions[d];
310 limits[def.dimension] = dimRgn->DimensionUpperLimits[d];
311 }
312 return limits;
313 }
314
315 static void restoreDimensionRegionUpperLimits(gig::DimensionRegion* dimRgn, const DimensionRegionUpperLimits& limits) {
316 gig::Region* rgn = dimRgn->GetParent();
317 for (DimensionRegionUpperLimits::const_iterator it = limits.begin();
318 it != limits.end(); ++it)
319 {
320 int index = getDimensionIndex(it->first, rgn);
321 assert(index >= 0);
322 dimRgn->DimensionUpperLimits[index] = it->second;
323 }
324 }
325
326 /**
327 * Returns the sum of all bits of all dimensions defined before the given
328 * dimensions (@a type). This allows to access cases of that particular
329 * dimension directly.
330 *
331 * @param type - dimension that shall be used
332 * @param rgn - parent region of that dimension
333 */
334 inline int baseBits(gig::dimension_t type, gig::Region* rgn) {
335 int previousBits = 0;
336 for (uint i = 0; i < rgn->Dimensions; ++i) {
337 if (rgn->pDimensionDefinitions[i].dimension == type) break;
338 previousBits += rgn->pDimensionDefinitions[i].bits;
339 }
340 return previousBits;
341 }
342
343 inline int dimensionRegionIndex(gig::DimensionRegion* dimRgn) {
344 gig::Region* rgn = dimRgn->GetParent();
345 int sz = sizeof(rgn->pDimensionRegions) / sizeof(gig::DimensionRegion*);
346 for (int i = 0; i < sz; ++i)
347 if (rgn->pDimensionRegions[i] == dimRgn)
348 return i;
349 return -1;
350 }
351
352 /** @brief Get exact zone ranges of given dimension.
353 *
354 * This function is useful for the velocity type dimension. In contrast to other
355 * dimension types, this dimension can have different zone ranges (that is
356 * different individual start and end points of its dimension zones) depending
357 * on which zones of other dimensions (on that gig::Region) are currently
358 * selected.
359 *
360 * @param type - dimension where the zone ranges should be retrieved for
361 * (usually the velocity dimension in this context)
362 * @param dimRgn - reflects the exact cases (zone selections) of all other
363 * dimensions than the given one in question
364 * @returns individual ranges for each zone of the questioned dimension type,
365 * it returns an empty result on errors instead
366 */
367 static DimensionZones preciseDimensionZonesFor(gig::dimension_t type, gig::DimensionRegion* dimRgn) {
368 DimensionZones zones;
369 gig::Region* rgn = dimRgn->GetParent();
370 int iDimension = getDimensionIndex(type, rgn);
371 if (iDimension < 0) return zones;
372 const gig::dimension_def_t& def = rgn->pDimensionDefinitions[iDimension];
373 int iDimRgn = dimensionRegionIndex(dimRgn);
374 int iBaseBits = baseBits(type, rgn);
375 int mask = ~(((1 << def.bits) - 1) << iBaseBits);
376
377 #if DEBUG_COMBINE_INSTRUMENTS
378 printf("velo zones { ");
379 fflush(stdout);
380 #endif
381 int iLow = 0;
382 for (int z = 0; z < def.zones; ++z) {
383 gig::DimensionRegion* dimRgn2 =
384 rgn->pDimensionRegions[ (iDimRgn & mask) | ( z << iBaseBits) ];
385 int iHigh = dimRgn2->DimensionUpperLimits[iDimension];
386 DLS::range_t range = { iLow, iHigh};
387 #if DEBUG_COMBINE_INSTRUMENTS
388 printf("%d..%d, ", iLow, iHigh);
389 fflush(stdout);
390 #endif
391 zones.push_back(range);
392 iLow = iHigh + 1;
393 }
394 #if DEBUG_COMBINE_INSTRUMENTS
395 printf("}\n");
396 #endif
397 return zones;
398 }
399
400 struct CopyAssignSchedEntry {
401 gig::DimensionRegion* src;
402 gig::DimensionRegion* dst;
403 int velocityZone;
404 int totalSrcVelocityZones;
405 };
406 typedef std::vector<CopyAssignSchedEntry> CopyAssignSchedule;
407
408 /** @brief Schedule copying DimensionRegions from source Region to target Region.
409 *
410 * Schedules copying the entire articulation informations (including sample
411 * reference) from all individual DimensionRegions of source Region @a inRgn to
412 * target Region @a outRgn. It is expected that the required dimensions (thus
413 * the required dimension regions) were already created before calling this
414 * function.
415 *
416 * To be precise, it does the task above only for the dimension zones defined by
417 * the three arguments @a mainDim, @a iSrcMainBit, @a iDstMainBit, which reflect
418 * a selection which dimension zones shall be copied. All other dimension zones
419 * will not be scheduled to be copied by a single call of this function. So this
420 * function needs to be called several time in case all dimension regions shall
421 * be copied of the entire region (@a inRgn, @a outRgn).
422 *
423 * @param outRgn - where the dimension regions shall be copied to
424 * @param inRgn - all dimension regions that shall be copied from
425 * @param dims - precise dimension definitions of target region
426 * @param mainDim - this dimension type, in combination with @a iSrcMainBit and
427 * @a iDstMainBit defines a selection which dimension region
428 * zones shall be copied by this call of this function
429 * @param iDstMainBit - destination bit of @a mainDim
430 * @param iSrcMainBit - source bit of @a mainDim
431 * @param schedule - list of all DimensionRegion copy operations which is filled
432 * during the nested loops / recursions of this function call
433 * @param dimCase - just for internal purpose (function recursion), don't pass
434 * anything here, this function will call itself recursively
435 * will fill this container with concrete dimension values for
436 * selecting the precise dimension regions during its task
437 */
438 static void scheduleCopyDimensionRegions(gig::Region* outRgn, gig::Region* inRgn,
439 Dimensions dims, gig::dimension_t mainDim,
440 int iDstMainBit, int iSrcMainBit,
441 CopyAssignSchedule* schedule,
442 DimensionCase dimCase = DimensionCase())
443 {
444 if (dims.empty()) { // reached deepest level of function recursion ...
445 CopyAssignSchedEntry e;
446
447 // resolve the respective source & destination DimensionRegion ...
448 uint srcDimValues[8] = {};
449 uint dstDimValues[8] = {};
450 DimensionCase srcDimCase = dimCase;
451 DimensionCase dstDimCase = dimCase;
452 if (dims.count(mainDim)) {
453 srcDimCase[mainDim] = iSrcMainBit;
454 dstDimCase[mainDim] = iDstMainBit;
455 }
456
457 #if DEBUG_COMBINE_INSTRUMENTS
458 printf("-------------------------------\n");
459 printf("iDstMainBit=%d iSrcMainBit=%d\n", iDstMainBit, iSrcMainBit);
460 #endif
461
462 // first select source & target dimension region with an arbitrary
463 // velocity split zone, to get access to the precise individual velocity
464 // split zone sizes (if there is actually a velocity dimension at all,
465 // otherwise we already select the desired source & target dimension
466 // region here)
467 #if DEBUG_COMBINE_INSTRUMENTS
468 printf("src "); fflush(stdout);
469 #endif
470 fillDimValues(srcDimValues, srcDimCase, inRgn, false);
471 #if DEBUG_COMBINE_INSTRUMENTS
472 printf("dst "); fflush(stdout);
473 #endif
474 fillDimValues(dstDimValues, dstDimCase, outRgn, true);
475 gig::DimensionRegion* srcDimRgn = inRgn->GetDimensionRegionByValue(srcDimValues);
476 gig::DimensionRegion* dstDimRgn = outRgn->GetDimensionRegionByValue(dstDimValues);
477 #if DEBUG_COMBINE_INSTRUMENTS
478 printf("iDstMainBit=%d iSrcMainBit=%d\n", iDstMainBit, iSrcMainBit);
479 printf("srcDimRgn=%lx dstDimRgn=%lx\n", (uint64_t)srcDimRgn, (uint64_t)dstDimRgn);
480 printf("srcSample='%s' dstSample='%s'\n",
481 (!srcDimRgn->pSample ? "NULL" : srcDimRgn->pSample->pInfo->Name.c_str()),
482 (!dstDimRgn->pSample ? "NULL" : dstDimRgn->pSample->pInfo->Name.c_str())
483 );
484 #endif
485
486 assert(srcDimRgn->GetParent() == inRgn);
487 assert(dstDimRgn->GetParent() == outRgn);
488
489 // now that we have access to the precise velocity split zone upper
490 // limits, we can select the actual source & destination dimension
491 // regions we need to copy (assuming that source or target region has
492 // a velocity dimension)
493 if (outRgn->GetDimensionDefinition(gig::dimension_velocity)) {
494 // re-select target dimension region (with correct velocity zone)
495 DimensionZones dstZones = preciseDimensionZonesFor(gig::dimension_velocity, dstDimRgn);
496 assert(dstZones.size() > 1);
497 const int iDstZoneIndex =
498 (mainDim == gig::dimension_velocity)
499 ? iDstMainBit : dstDimCase[gig::dimension_velocity]; // (mainDim == gig::dimension_velocity) exception case probably unnecessary here
500 e.velocityZone = iDstZoneIndex;
501 #if DEBUG_COMBINE_INSTRUMENTS
502 printf("dst velocity zone: %d/%d\n", iDstZoneIndex, (int)dstZones.size());
503 #endif
504 assert(uint(iDstZoneIndex) < dstZones.size());
505 dstDimCase[gig::dimension_velocity] = dstZones[iDstZoneIndex].low; // arbitrary value between low and high
506 #if DEBUG_COMBINE_INSTRUMENTS
507 printf("dst velocity value = %d\n", dstDimCase[gig::dimension_velocity]);
508 printf("dst refilled "); fflush(stdout);
509 #endif
510 fillDimValues(dstDimValues, dstDimCase, outRgn, true);
511 dstDimRgn = outRgn->GetDimensionRegionByValue(dstDimValues);
512 #if DEBUG_COMBINE_INSTRUMENTS
513 printf("reselected dstDimRgn=%lx\n", (uint64_t)dstDimRgn);
514 printf("dstSample='%s'%s\n",
515 (!dstDimRgn->pSample ? "NULL" : dstDimRgn->pSample->pInfo->Name.c_str()),
516 (dstDimRgn->pSample ? " <--- ERROR ERROR ERROR !!!!!!!!! " : "")
517 );
518 #endif
519
520 // re-select source dimension region with correct velocity zone
521 // (if it has a velocity dimension that is)
522 if (inRgn->GetDimensionDefinition(gig::dimension_velocity)) {
523 DimensionZones srcZones = preciseDimensionZonesFor(gig::dimension_velocity, srcDimRgn);
524 e.totalSrcVelocityZones = srcZones.size();
525 assert(srcZones.size() > 0);
526 if (srcZones.size() <= 1) {
527 addWarning("Input region has a velocity dimension with only ONE zone!");
528 }
529 int iSrcZoneIndex =
530 (mainDim == gig::dimension_velocity)
531 ? iSrcMainBit : iDstZoneIndex;
532 if (uint(iSrcZoneIndex) >= srcZones.size())
533 iSrcZoneIndex = srcZones.size() - 1;
534 srcDimCase[gig::dimension_velocity] = srcZones[iSrcZoneIndex].low; // same zone as used above for target dimension region (no matter what the precise zone ranges are)
535 #if DEBUG_COMBINE_INSTRUMENTS
536 printf("src refilled "); fflush(stdout);
537 #endif
538 fillDimValues(srcDimValues, srcDimCase, inRgn, false);
539 srcDimRgn = inRgn->GetDimensionRegionByValue(srcDimValues);
540 #if DEBUG_COMBINE_INSTRUMENTS
541 printf("reselected srcDimRgn=%lx\n", (uint64_t)srcDimRgn);
542 printf("srcSample='%s'\n",
543 (!srcDimRgn->pSample ? "NULL" : srcDimRgn->pSample->pInfo->Name.c_str())
544 );
545 #endif
546 }
547 }
548
549 // Schedule copy operation of source -> target DimensionRegion for the
550 // time after all nested loops have been traversed. We have to postpone
551 // the actual copy operations this way, because otherwise it would
552 // overwrite informations inside the destination DimensionRegion object
553 // that we need to read in the code block above.
554 e.src = srcDimRgn;
555 e.dst = dstDimRgn;
556 schedule->push_back(e);
557
558 return; // returning from deepest level of function recursion
559 }
560
561 // Copying n dimensions requires n nested loops. That's why this function
562 // is calling itself recursively to provide the required amount of nested
563 // loops. With each call it pops from argument 'dims' and pushes to
564 // argument 'dimCase'.
565
566 Dimensions::iterator itDimension = dims.begin();
567 gig::dimension_t type = itDimension->first;
568 DimensionZones zones = itDimension->second;
569 dims.erase(itDimension);
570
571 int iZone = 0;
572 for (DimensionZones::iterator itZone = zones.begin();
573 itZone != zones.end(); ++itZone, ++iZone)
574 {
575 DLS::range_t zoneRange = *itZone;
576 gig::dimension_def_t* def = outRgn->GetDimensionDefinition(type);
577 dimCase[type] = (def->split_type == gig::split_type_bit) ? iZone : zoneRange.low;
578
579 // recurse until 'dims' is exhausted (and dimCase filled up with concrete value)
580 scheduleCopyDimensionRegions(outRgn, inRgn, dims, mainDim, iDstMainBit, iSrcMainBit, schedule, dimCase);
581 }
582 }
583
584 static OrderedRegionGroup sortRegionGroup(const RegionGroup& group, const std::vector<gig::Instrument*>& instruments) {
585 OrderedRegionGroup result;
586 for (std::vector<gig::Instrument*>::const_iterator it = instruments.begin();
587 it != instruments.end(); ++it)
588 {
589 RegionGroup::const_iterator itRgn = group.find(*it);
590 if (itRgn == group.end()) continue;
591 result.push_back(
592 std::pair<gig::Instrument*, gig::Region*>(
593 itRgn->first, itRgn->second
594 )
595 );
596 }
597 return result;
598 }
599
600 /** @brief Combine given list of instruments to one instrument.
601 *
602 * Takes a list of @a instruments as argument and combines them to one single
603 * new @a output instrument. For this task, it will create a dimension of type
604 * given by @a mainDimension in the new instrument and copies the source
605 * instruments to those dimension zones.
606 *
607 * @param instruments - (input) list of instruments that shall be combined,
608 * they will only be read, so they will be left untouched
609 * @param gig - (input/output) .gig file where the new combined instrument shall
610 * be created
611 * @param output - (output) on success this pointer will be set to the new
612 * instrument being created
613 * @param mainDimension - the dimension that shall be used to combine the
614 * instruments
615 * @throw RIFF::Exception on any kinds of errors
616 */
617 static void combineInstruments(std::vector<gig::Instrument*>& instruments, gig::File* gig, gig::Instrument*& output, gig::dimension_t mainDimension) {
618 output = NULL;
619
620 // divide the individual regions to (probably even smaller) groups of
621 // regions, coping with the fact that the source regions of the instruments
622 // might have quite different range sizes and start and end points
623 RegionGroups groups = groupByRegionIntersections(instruments);
624 #if DEBUG_COMBINE_INSTRUMENTS
625 std::cout << std::endl << "New regions: " << std::flush;
626 printRanges(groups);
627 std::cout << std::endl;
628 #endif
629
630 if (groups.empty())
631 throw gig::Exception(_("No regions found to create a new instrument with."));
632
633 // create a new output instrument
634 gig::Instrument* outInstr = gig->AddInstrument();
635 outInstr->pInfo->Name = _("NEW COMBINATION");
636
637 // Distinguishing in the following code block between 'horizontal' and
638 // 'vertical' regions. The 'horizontal' ones are meant to be the key ranges
639 // in the output instrument, while the 'vertical' regions are meant to be
640 // the set of source regions that shall be layered to that 'horizontal'
641 // region / key range. It is important to know, that the key ranges defined
642 // in the 'horizontal' and 'vertical' regions might differ.
643
644 // merge the instruments to the new output instrument
645 for (RegionGroups::iterator itGroup = groups.begin();
646 itGroup != groups.end(); ++itGroup) // iterate over 'horizontal' / target regions ...
647 {
648 gig::Region* outRgn = outInstr->AddRegion();
649 outRgn->SetKeyRange(itGroup->first.low, itGroup->first.high);
650 #if DEBUG_COMBINE_INSTRUMENTS
651 printf("---> Start target region %d..%d\n", itGroup->first.low, itGroup->first.high);
652 #endif
653
654 // detect the total amount of zones required for the given main
655 // dimension to build up this combi for current key range
656 int iTotalZones = 0;
657 for (RegionGroup::iterator itRgn = itGroup->second.begin();
658 itRgn != itGroup->second.end(); ++itRgn)
659 {
660 gig::Region* inRgn = itRgn->second;
661 gig::dimension_def_t* def = inRgn->GetDimensionDefinition(mainDimension);
662 iTotalZones += (def) ? def->zones : 1;
663 }
664 #if DEBUG_COMBINE_INSTRUMENTS
665 printf("Required total zones: %d, vertical regions: %d\n", iTotalZones, itGroup->second.size());
666 #endif
667
668 // create all required dimensions for this output region
669 // (except the main dimension used for separating the individual
670 // instruments, we create that particular dimension as next step)
671 Dimensions dims = getDimensionsForRegionGroup(itGroup->second);
672 // the given main dimension which is used to combine the instruments is
673 // created separately after the next code block, and the main dimension
674 // should not be part of dims here, because it also used for iterating
675 // all dimensions zones, which would lead to this dimensions being
676 // iterated twice
677 dims.erase(mainDimension);
678 {
679 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
680
681 for (Dimensions::iterator itDim = dims.begin();
682 itDim != dims.end(); ++itDim)
683 {
684 gig::dimension_def_t def;
685 def.dimension = itDim->first; // dimension type
686 def.zones = itDim->second.size();
687 def.bits = zoneCountToBits(def.zones);
688 if (def.zones < 2) {
689 addWarning(
690 "Attempt to create dimension with type=0x%x with only "
691 "ONE zone (because at least one of the source "
692 "instruments seems to have such a velocity dimension "
693 "with only ONE zone, which is odd)! Skipping this "
694 "dimension for now.",
695 (int)itDim->first
696 );
697 skipTheseDimensions.push_back(itDim->first);
698 continue;
699 }
700 #if DEBUG_COMBINE_INSTRUMENTS
701 std::cout << "Adding new regular dimension type=" << std::hex << (int)def.dimension << std::dec << ", zones=" << (int)def.zones << ", bits=" << (int)def.bits << " ... " << std::flush;
702 #endif
703 outRgn->AddDimension(&def);
704 #if DEBUG_COMBINE_INSTRUMENTS
705 std::cout << "OK" << std::endl << std::flush;
706 #endif
707 }
708 // prevent the following dimensions to be processed further below
709 // (since the respective dimension was not created above)
710 for (int i = 0; i < skipTheseDimensions.size(); ++i)
711 dims.erase(skipTheseDimensions[i]);
712 }
713
714 // create the main dimension (if necessary for current key range)
715 if (iTotalZones > 1) {
716 gig::dimension_def_t def;
717 def.dimension = mainDimension; // dimension type
718 def.zones = iTotalZones;
719 def.bits = zoneCountToBits(def.zones);
720 #if DEBUG_COMBINE_INSTRUMENTS
721 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;
722 #endif
723 outRgn->AddDimension(&def);
724 #if DEBUG_COMBINE_INSTRUMENTS
725 std::cout << "OK" << std::endl << std::flush;
726 #endif
727 } else {
728 dims.erase(mainDimension);
729 }
730
731 // for the next task we need to have the current RegionGroup to be
732 // sorted by instrument in the same sequence as the 'instruments' vector
733 // argument passed to this function (because the std::map behind the
734 // 'RegionGroup' type sorts by memory address instead, and that would
735 // sometimes lead to the source instruments' region to be sorted into
736 // the wrong target layer)
737 OrderedRegionGroup currentGroup = sortRegionGroup(itGroup->second, instruments);
738
739 // schedule copying the source dimension regions to the target dimension
740 // regions
741 CopyAssignSchedule schedule;
742 int iDstMainBit = 0;
743 for (OrderedRegionGroup::iterator itRgn = currentGroup.begin();
744 itRgn != currentGroup.end(); ++itRgn) // iterate over 'vertical' / source regions ...
745 {
746 gig::Region* inRgn = itRgn->second;
747 #if DEBUG_COMBINE_INSTRUMENTS
748 printf("[source region of '%s']\n", inRgn->GetParent()->pInfo->Name.c_str());
749 #endif
750
751 // determine how many main dimension zones this input region requires
752 gig::dimension_def_t* def = inRgn->GetDimensionDefinition(mainDimension);
753 const int inRgnMainZones = (def) ? def->zones : 1;
754
755 for (uint iSrcMainBit = 0; iSrcMainBit < inRgnMainZones; ++iSrcMainBit, ++iDstMainBit) {
756 scheduleCopyDimensionRegions(
757 outRgn, inRgn, dims, mainDimension,
758 iDstMainBit, iSrcMainBit, &schedule
759 );
760 }
761 }
762
763 // finally copy the scheduled source -> target dimension regions
764 for (uint i = 0; i < schedule.size(); ++i) {
765 CopyAssignSchedEntry& e = schedule[i];
766
767 // backup the target DimensionRegion's current dimension zones upper
768 // limits (because the target DimensionRegion's upper limits are
769 // already defined correctly since calling AddDimension(), and the
770 // CopyAssign() call next, will overwrite those upper limits
771 // unfortunately
772 DimensionRegionUpperLimits dstUpperLimits = getDimensionRegionUpperLimits(e.dst);
773 DimensionRegionUpperLimits srcUpperLimits = getDimensionRegionUpperLimits(e.src);
774
775 // now actually copy over the current DimensionRegion
776 const gig::Region* const origRgn = e.dst->GetParent(); // just for sanity check below
777 e.dst->CopyAssign(e.src);
778 assert(origRgn == e.dst->GetParent()); // if gigedit is crashing here, then you must update libgig (to at least SVN r2547, v3.3.0.svn10)
779
780 // restore all original dimension zone upper limits except of the
781 // velocity dimension, because the velocity dimension zone sizes are
782 // allowed to differ for individual DimensionRegions in gig v3
783 // format
784 //
785 // if the main dinension is the 'velocity' dimension, then skip
786 // restoring the source's original velocity zone limits, because
787 // dealing with merging that is not implemented yet
788 // TODO: merge custom velocity splits if main dimension is the velocity dimension (for now equal sized velocity zones are used if mainDim is 'velocity')
789 if (srcUpperLimits.count(gig::dimension_velocity) && mainDimension != gig::dimension_velocity) {
790 if (!dstUpperLimits.count(gig::dimension_velocity)) {
791 addWarning("Source instrument seems to have a velocity dimension whereas new target instrument doesn't!");
792 } else {
793 dstUpperLimits[gig::dimension_velocity] =
794 (e.velocityZone >= e.totalSrcVelocityZones)
795 ? 127 : srcUpperLimits[gig::dimension_velocity];
796 }
797 }
798 restoreDimensionRegionUpperLimits(e.dst, dstUpperLimits);
799 }
800 }
801
802 // success
803 output = outInstr;
804 }
805
806 ///////////////////////////////////////////////////////////////////////////
807 // class 'CombineInstrumentsDialog'
808
809 CombineInstrumentsDialog::CombineInstrumentsDialog(Gtk::Window& parent, gig::File* gig)
810 : Gtk::Dialog(_("Combine Instruments"), parent, true),
811 m_gig(gig), m_fileWasChanged(false), m_newCombinedInstrument(NULL),
812 m_cancelButton(Gtk::Stock::CANCEL), m_OKButton(Gtk::Stock::OK),
813 m_descriptionLabel(), m_tableDimCombo(2, 2), m_comboDimType(),
814 m_labelDimType(Glib::ustring(_("Combine by Dimension:")) + " ", Gtk::ALIGN_END)
815 {
816 m_scrolledWindow.add(m_treeView);
817 m_scrolledWindow.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
818
819 get_vbox()->pack_start(m_descriptionLabel, Gtk::PACK_SHRINK);
820 get_vbox()->pack_start(m_tableDimCombo, Gtk::PACK_SHRINK);
821 get_vbox()->pack_start(m_scrolledWindow);
822 get_vbox()->pack_start(m_buttonBox, Gtk::PACK_SHRINK);
823
824 #if GTKMM_MAJOR_VERSION >= 3
825 m_descriptionLabel.set_line_wrap();
826 #endif
827 m_descriptionLabel.set_text(_(
828 "Select at least two instruments below that shall be combined (as "
829 "separate dimension zones of the selected dimension type) as a new "
830 "instrument. The original instruments remain untouched.\n\n"
831 "You may use this tool for example to combine solo instruments into "
832 "a combi sound arrangement by selecting the 'layer' dimension, or you "
833 "might combine similar sounding solo sounds into separate velocity "
834 "split layers by using the 'velocity' dimension, and so on."
835 ));
836
837 // add dimension type combo box
838 {
839 int iLayerDimIndex = -1;
840 Glib::RefPtr<Gtk::ListStore> refComboModel = Gtk::ListStore::create(m_comboDimsModel);
841 for (int i = 0x01, iRow = 0; i < 0xff; i++) {
842 Glib::ustring sType =
843 dimTypeAsString(static_cast<gig::dimension_t>(i));
844 if (sType.find("Unknown") != 0) {
845 Gtk::TreeModel::Row row = *(refComboModel->append());
846 row[m_comboDimsModel.m_type_id] = i;
847 row[m_comboDimsModel.m_type_name] = sType;
848 if (i == gig::dimension_layer) iLayerDimIndex = iRow;
849 iRow++;
850 }
851 }
852 m_comboDimType.set_model(refComboModel);
853 m_comboDimType.pack_start(m_comboDimsModel.m_type_id);
854 m_comboDimType.pack_start(m_comboDimsModel.m_type_name);
855 m_tableDimCombo.attach(m_labelDimType, 0, 1, 0, 1);
856 m_tableDimCombo.attach(m_comboDimType, 1, 2, 0, 1);
857 m_comboDimType.set_active(iLayerDimIndex); // preselect "layer" dimension
858 }
859
860 m_refTreeModel = Gtk::ListStore::create(m_columns);
861 m_treeView.set_model(m_refTreeModel);
862 m_treeView.set_tooltip_text(_(
863 "Use SHIFT + left click or CTRL + left click to select the instruments "
864 "you want to combine."
865 ));
866 m_treeView.append_column("Instrument", m_columns.m_col_name);
867 m_treeView.set_headers_visible(false);
868 m_treeView.get_selection()->set_mode(Gtk::SELECTION_MULTIPLE);
869 m_treeView.get_selection()->signal_changed().connect(
870 sigc::mem_fun(*this, &CombineInstrumentsDialog::onSelectionChanged)
871 );
872 m_treeView.show();
873
874 for (int i = 0; true; ++i) {
875 gig::Instrument* instr = gig->GetInstrument(i);
876 if (!instr) break;
877
878 #if DEBUG_COMBINE_INSTRUMENTS
879 {
880 std::cout << "Instrument (" << i << ") '" << instr->pInfo->Name << "' Regions: " << std::flush;
881 for (gig::Region* rgn = instr->GetFirstRegion(); rgn; rgn = instr->GetNextRegion()) {
882 std::cout << rgn->KeyRange.low << ".." << rgn->KeyRange.high << ", " << std::flush;
883 }
884 std::cout << std::endl;
885 }
886 std::cout << std::endl;
887 #endif
888
889 Glib::ustring name(gig_to_utf8(instr->pInfo->Name));
890 Gtk::TreeModel::iterator iter = m_refTreeModel->append();
891 Gtk::TreeModel::Row row = *iter;
892 row[m_columns.m_col_name] = name;
893 row[m_columns.m_col_instr] = instr;
894 }
895
896 m_buttonBox.set_layout(Gtk::BUTTONBOX_END);
897 m_buttonBox.set_border_width(5);
898 m_buttonBox.pack_start(m_cancelButton, Gtk::PACK_SHRINK);
899 m_buttonBox.pack_start(m_OKButton, Gtk::PACK_SHRINK);
900 m_buttonBox.show();
901
902 m_cancelButton.show();
903 m_OKButton.set_sensitive(false);
904 m_OKButton.show();
905
906 m_cancelButton.signal_clicked().connect(
907 sigc::mem_fun(*this, &CombineInstrumentsDialog::hide)
908 );
909
910 m_OKButton.signal_clicked().connect(
911 sigc::mem_fun(*this, &CombineInstrumentsDialog::combineSelectedInstruments)
912 );
913
914 show_all_children();
915
916 // show a warning to user if he uses a .gig in v2 format
917 if (gig->pVersion->major < 3) {
918 Glib::ustring txt = _(
919 "You are currently using a .gig file in old v2 format. The current "
920 "combine algorithm will most probably fail trying to combine "
921 "instruments in this old format. So better save the file in new v3 "
922 "format before trying to combine your instruments."
923 );
924 Gtk::MessageDialog msg(*this, txt, false, Gtk::MESSAGE_WARNING);
925 msg.run();
926 }
927 }
928
929 void CombineInstrumentsDialog::combineSelectedInstruments() {
930 std::vector<gig::Instrument*> instruments;
931 std::vector<Gtk::TreeModel::Path> v = m_treeView.get_selection()->get_selected_rows();
932 for (uint i = 0; i < v.size(); ++i) {
933 Gtk::TreeModel::iterator it = m_refTreeModel->get_iter(v[i]);
934 Gtk::TreeModel::Row row = *it;
935 Glib::ustring name = row[m_columns.m_col_name];
936 gig::Instrument* instrument = row[m_columns.m_col_instr];
937 #if DEBUG_COMBINE_INSTRUMENTS
938 printf("Selection '%s' 0x%lx\n\n", name.c_str(), int64_t((void*)instrument));
939 #endif
940 instruments.push_back(instrument);
941 }
942
943 g_warnings.clear();
944
945 try {
946 // which main dimension was selected in the combo box?
947 gig::dimension_t mainDimension;
948 {
949 Gtk::TreeModel::iterator iterType = m_comboDimType.get_active();
950 if (!iterType) throw gig::Exception("No dimension selected");
951 Gtk::TreeModel::Row rowType = *iterType;
952 if (!rowType) throw gig::Exception("Something is wrong regarding dimension selection");
953 int iTypeID = rowType[m_comboDimsModel.m_type_id];
954 mainDimension = static_cast<gig::dimension_t>(iTypeID);
955 }
956
957 // now start the actual cobination task ...
958 combineInstruments(instruments, m_gig, m_newCombinedInstrument, mainDimension);
959 } catch (RIFF::Exception e) {;
960 Gtk::MessageDialog msg(*this, e.Message, false, Gtk::MESSAGE_ERROR);
961 msg.run();
962 return;
963 } catch (...) {
964 Glib::ustring txt = _("An unknown exception occurred!");
965 Gtk::MessageDialog msg(*this, txt, false, Gtk::MESSAGE_ERROR);
966 msg.run();
967 return;
968 }
969
970 if (!g_warnings.empty()) {
971 Glib::ustring txt = _(
972 "Combined instrument was created successfully, but there were warnings:"
973 );
974 txt += "\n\n";
975 for (Warnings::const_iterator itWarn = g_warnings.begin();
976 itWarn != g_warnings.end(); ++itWarn)
977 {
978 txt += "-> " + *itWarn + "\n";
979 }
980 txt += "\n";
981 txt += _(
982 "You might also want to check the console for further warnings and "
983 "error messages."
984 );
985 Gtk::MessageDialog msg(*this, txt, false, Gtk::MESSAGE_WARNING);
986 msg.run();
987 }
988
989 // no error occurred
990 m_fileWasChanged = true;
991 hide();
992 }
993
994 void CombineInstrumentsDialog::onSelectionChanged() {
995 std::vector<Gtk::TreeModel::Path> v = m_treeView.get_selection()->get_selected_rows();
996 m_OKButton.set_sensitive(v.size() >= 2);
997 }
998
999 bool CombineInstrumentsDialog::fileWasChanged() const {
1000 return m_fileWasChanged;
1001 }
1002
1003 gig::Instrument* CombineInstrumentsDialog::newCombinedInstrument() const {
1004 return m_newCombinedInstrument;
1005 }

  ViewVC Help
Powered by ViewVC