forked from NatronGitHub/Natron
-
Notifications
You must be signed in to change notification settings - Fork 0
/
KnobTypes.cpp
2597 lines (2223 loc) · 69.1 KB
/
KnobTypes.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* ***** BEGIN LICENSE BLOCK *****
* This file is part of Natron <https://natrongithub.github.io/>,
* (C) 2018-2021 The Natron developers
* (C) 2013-2018 INRIA and Alexandre Gauthier-Foichat
*
* Natron is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* Natron is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Natron. If not, see <http://www.gnu.org/licenses/gpl-2.0.html>
* ***** END LICENSE BLOCK ***** */
// ***** BEGIN PYTHON BLOCK *****
// from <https://docs.python.org/3/c-api/intro.html#include-files>:
// "Since Python may define some pre-processor definitions which affect the standard headers on some systems, you must include Python.h before any standard headers are included."
#include <Python.h>
// ***** END PYTHON BLOCK *****
#include "KnobTypes.h"
#include <cfloat>
#include <locale>
#include <sstream>
#include <algorithm> // min, max
#include <cassert>
#include <stdexcept>
#include <sstream> // stringstream
#if !defined(SBK_RUN) && !defined(Q_MOC_RUN)
GCC_DIAG_UNUSED_LOCAL_TYPEDEFS_OFF
#include <boost/math/special_functions/fpclassify.hpp>
#include <boost/algorithm/string/trim.hpp>
#include <boost/algorithm/string/predicate.hpp>
#include <boost/algorithm/string.hpp>
#include <boost/algorithm/string/replace.hpp>
GCC_DIAG_UNUSED_LOCAL_TYPEDEFS_ON
#endif
#include <QtCore/QDebug>
#include <QtCore/QThread>
#include <QtCore/QCoreApplication>
#include "Engine/AppInstance.h"
#include "Engine/Bezier.h"
#include "Engine/BezierCP.h"
#include "Engine/Curve.h"
#include "Engine/EffectInstance.h"
#include "Engine/Format.h"
#include "Engine/Image.h"
#include "Engine/KnobFile.h"
#include "Engine/KnobSerialization.h"
#include "Engine/Node.h"
#include "Engine/Project.h"
#include "Engine/RotoContext.h"
#include "Engine/TimeLine.h"
#include "Engine/Transform.h"
#include "Engine/ViewIdx.h"
NATRON_NAMESPACE_ENTER
//using std::make_pair;
//using std::pair;
/******************************KnobInt**************************************/
KnobInt::KnobInt(KnobHolder* holder,
const std::string &label,
int dimension,
bool declaredByPlugin)
: KnobIntBase(holder, label, dimension, declaredByPlugin)
, _increments(dimension, 1)
, _disableSlider(false)
, _isRectangle(false)
{
}
KnobInt::KnobInt(KnobHolder* holder,
const QString &label,
int dimension,
bool declaredByPlugin)
: KnobIntBase(holder, label.toStdString(), dimension, declaredByPlugin)
, _increments(dimension, 1)
, _disableSlider(false)
, _isRectangle(false)
{
}
void
KnobInt::disableSlider()
{
_disableSlider = true;
}
bool
KnobInt::isSliderDisabled() const
{
return _disableSlider;
}
void
KnobInt::setIncrement(int incr,
int index)
{
if (incr <= 0) {
qDebug() << "Attempting to set the increment of an int param to a value lesser or equal to 0";
return;
}
if ( index >= (int)_increments.size() ) {
throw std::runtime_error("KnobInt::setIncrement , dimension out of range");
}
_increments[index] = incr;
Q_EMIT incrementChanged(_increments[index], index);
}
void
KnobInt::setIncrement(const std::vector<int> &incr)
{
assert( (int)incr.size() == getDimension() );
_increments = incr;
for (U32 i = 0; i < _increments.size(); ++i) {
if (_increments[i] <= 0) {
qDebug() << "Attempting to set the increment of an int param to a value lesser or equal to 0";
continue;
}
Q_EMIT incrementChanged(_increments[i], i);
}
}
const std::vector<int> &
KnobInt::getIncrements() const
{
return _increments;
}
bool
KnobInt::canAnimate() const
{
return true;
}
const std::string KnobInt::_typeNameStr("Int");
const std::string &
KnobInt::typeNameStatic()
{
return _typeNameStr;
}
const std::string &
KnobInt::typeName() const
{
return typeNameStatic();
}
/******************************KnobBool**************************************/
KnobBool::KnobBool(KnobHolder* holder,
const std::string &label,
int dimension,
bool declaredByPlugin)
: KnobBoolBase(holder, label, dimension, declaredByPlugin)
{
}
KnobBool::KnobBool(KnobHolder* holder,
const QString &label,
int dimension,
bool declaredByPlugin)
: KnobBoolBase(holder, label.toStdString(), dimension, declaredByPlugin)
{
}
bool
KnobBool::canAnimate() const
{
return canAnimateStatic();
}
const std::string KnobBool::_typeNameStr("Bool");
const std::string &
KnobBool::typeNameStatic()
{
return _typeNameStr;
}
const std::string &
KnobBool::typeName() const
{
return typeNameStatic();
}
/******************************KnobDouble**************************************/
KnobDouble::KnobDouble(KnobHolder* holder,
const std::string &label,
int dimension,
bool declaredByPlugin)
: KnobDoubleBase(holder, label, dimension, declaredByPlugin)
, _spatial(false)
, _isRectangle(false)
, _increments(dimension, 1)
, _decimals(dimension, 2)
, _disableSlider(false)
, _autoFoldEnabled(false)
, _valueIsNormalized(dimension, eValueIsNormalizedNone)
, _defaultValuesAreNormalized(false)
, _hasHostOverlayHandle(false)
{
}
KnobDouble::KnobDouble(KnobHolder* holder,
const QString &label,
int dimension,
bool declaredByPlugin)
: KnobDoubleBase(holder, label.toStdString(), dimension, declaredByPlugin)
, _spatial(false)
, _isRectangle(false)
, _increments(dimension, 1)
, _decimals(dimension, 2)
, _disableSlider(false)
, _autoFoldEnabled(false)
, _valueIsNormalized(dimension, eValueIsNormalizedNone)
, _defaultValuesAreNormalized(false)
, _hasHostOverlayHandle(false)
{
if (dimension >= 4) {
disableSlider();
}
}
void
KnobDouble::setHasHostOverlayHandle(bool handle)
{
KnobHolder* holder = getHolder();
if (holder) {
EffectInstance* effect = dynamic_cast<EffectInstance*>(holder);
if (!effect) {
return;
}
if ( !effect->getNode() ) {
return;
}
KnobDoublePtr thisSharedDouble = boost::dynamic_pointer_cast<KnobDouble>(shared_from_this());
assert(thisSharedDouble);
if (handle) {
effect->getNode()->addPositionInteract(thisSharedDouble,
KnobBoolPtr() /*interactive*/);
} else {
effect->getNode()->removePositionHostOverlay(this);
}
_hasHostOverlayHandle = handle;
}
}
bool
KnobDouble::getHasHostOverlayHandle() const
{
return _hasHostOverlayHandle;
}
void
KnobDouble::disableSlider()
{
_disableSlider = true;
}
bool
KnobDouble::isSliderDisabled() const
{
return _disableSlider;
}
bool
KnobDouble::canAnimate() const
{
return true;
}
const std::string KnobDouble::_typeNameStr("Double");
const std::string &
KnobDouble::typeNameStatic()
{
return _typeNameStr;
}
const std::string &
KnobDouble::typeName() const
{
return typeNameStatic();
}
const std::vector<double> &
KnobDouble::getIncrements() const
{
return _increments;
}
const std::vector<int> &
KnobDouble::getDecimals() const
{
return _decimals;
}
void
KnobDouble::setIncrement(double incr,
int index)
{
if (incr <= 0.) {
qDebug() << "Attempting to set the increment of a double param to a value lesser or equal to 0.";
return;
}
if ( index >= (int)_increments.size() ) {
throw std::runtime_error("KnobDouble::setIncrement , dimension out of range");
}
_increments[index] = incr;
Q_EMIT incrementChanged(_increments[index], index);
}
void
KnobDouble::setDecimals(int decis,
int index)
{
if ( index >= (int)_decimals.size() ) {
throw std::runtime_error("KnobDouble::setDecimals , dimension out of range");
}
_decimals[index] = decis;
Q_EMIT decimalsChanged(_decimals[index], index);
}
void
KnobDouble::setIncrement(const std::vector<double> &incr)
{
assert( incr.size() == (U32)getDimension() );
_increments = incr;
for (U32 i = 0; i < incr.size(); ++i) {
Q_EMIT incrementChanged(_increments[i], i);
}
}
void
KnobDouble::setDecimals(const std::vector<int> &decis)
{
assert( decis.size() == (U32)getDimension() );
_decimals = decis;
for (U32 i = 0; i < decis.size(); ++i) {
Q_EMIT decimalsChanged(decis[i], i);
}
}
KnobDouble::~KnobDouble()
{
}
static void
getInputRoD(EffectInstance* effect,
double /*time*/,
RectD & rod)
{
#ifdef NATRON_NORMALIZE_SPATIAL_WITH_ROD
RenderScale scale;
scale.y = scale.x = 1.;
bool isProjectFormat;
Status stat = effect->getRegionOfDefinition_public(effect->getHash(), time, scale, /*view*/ 0, &rod, &isProjectFormat);
if ( (stat == StatFailed) || ( (rod.x1 == 0) && (rod.y1 == 0) && (rod.x2 == 1) && (rod.y2 == 1) ) ) {
Format f;
effect->getRenderFormat(&f);
rod = f;
}
#else
Format f;
effect->getApp()->getProject()->getProjectDefaultFormat(&f);
rod = f.toCanonicalFormat();
#endif
}
double
KnobDouble::denormalize(const int dimension,
const double time,
const double value) const
{
EffectInstance* effect = dynamic_cast<EffectInstance*>( getHolder() );
assert(effect);
if (!effect) {
// coverity[dead_error_line]
return value;
}
RectD rod;
getInputRoD(effect, time, rod);
ValueIsNormalizedEnum e = getValueIsNormalized(dimension);
// the second expression (with e == eValueIsNormalizedNone) is used when denormalizing default values
if ( (e == eValueIsNormalizedX) || ( (e == eValueIsNormalizedNone) && (dimension == 0) ) ) {
return value * rod.width();
} else if ( (e == eValueIsNormalizedY) || ( (e == eValueIsNormalizedNone) && (dimension == 1) ) ) {
return value * rod.height();
}
return value;
}
double
KnobDouble::normalize(const int dimension,
const double time,
const double value) const
{
EffectInstance* effect = dynamic_cast<EffectInstance*>( getHolder() );
assert(effect);
if (!effect) {
// coverity[dead_error_line]
return value;
}
RectD rod;
getInputRoD(effect, time, rod);
ValueIsNormalizedEnum e = getValueIsNormalized(dimension);
// the second expression (with e == eValueIsNormalizedNone) is used when normalizing default values
if ( (e == eValueIsNormalizedX) || ( (e == eValueIsNormalizedNone) && (dimension == 0) ) ) {
return value / rod.width();
} else if ( (e == eValueIsNormalizedY) || ( (e == eValueIsNormalizedNone) && (dimension == 1) ) ) {
return value / rod.height();
}
return value;
}
bool
KnobDouble::computeValuesHaveModifications(int dimension,
const double& value,
const double& defaultValue) const
{
if (_defaultValuesAreNormalized) {
double tmp = denormalize(dimension, 0, defaultValue);
return value != tmp;
} else {
return value != defaultValue;
}
}
/******************************KnobButton**************************************/
KnobButton::KnobButton(KnobHolder* holder,
const std::string &label,
int dimension,
bool declaredByPlugin)
: KnobBoolBase(holder, label, dimension, declaredByPlugin)
, _renderButton(false)
, _checkable(false)
, _isToolButtonAction(false)
{
//setIsPersistent(false);
}
KnobButton::KnobButton(KnobHolder* holder,
const QString &label,
int dimension,
bool declaredByPlugin)
: KnobBoolBase(holder, label.toStdString(), dimension, declaredByPlugin)
, _renderButton(false)
, _checkable(false)
, _isToolButtonAction(false)
{
//setIsPersistent(false);
}
bool
KnobButton::canAnimate() const
{
return false;
}
const std::string KnobButton::_typeNameStr("Button");
const std::string &
KnobButton::typeNameStatic()
{
return _typeNameStr;
}
const std::string &
KnobButton::typeName() const
{
return typeNameStatic();
}
bool
KnobButton::trigger()
{
return evaluateValueChange(0, getCurrentTime(), ViewIdx(0), eValueChangedReasonUserEdited);
}
/******************************KnobChoice**************************************/
#define KNOBCHOICE_MAX_ENTRIES_HELP 40 \
// don't show help in the tootlip if there are more entries that this
KnobChoice::KnobChoice(KnobHolder* holder,
const std::string &label,
int dimension,
bool declaredByPlugin)
: KnobIntBase(holder, label, dimension, declaredByPlugin)
, _entriesMutex()
, _currentEntry()
, _addNewChoice(false)
, _isCascading(false)
{
}
KnobChoice::KnobChoice(KnobHolder* holder,
const QString &label,
int dimension,
bool declaredByPlugin)
: KnobIntBase(holder, label.toStdString(), dimension, declaredByPlugin)
, _entriesMutex()
, _currentEntry()
, _addNewChoice(false)
, _isCascading(false)
{
}
KnobChoice::~KnobChoice()
{
}
void
KnobChoice::setHostCanAddOptions(bool add)
{
_addNewChoice = add;
}
bool
KnobChoice::getHostCanAddOptions() const
{
return _addNewChoice;
}
bool
KnobChoice::canAnimate() const
{
return canAnimateStatic();
}
const std::string KnobChoice::_typeNameStr("Choice");
const std::string &
KnobChoice::typeNameStatic()
{
return _typeNameStr;
}
const std::string &
KnobChoice::typeName() const
{
return typeNameStatic();
}
void
KnobChoice::cloneExtraData(KnobI* other,
int /*dimension*/,
int /*otherDimension*/)
{
KnobChoice* isChoice = dynamic_cast<KnobChoice*>(other);
if (!isChoice) {
return;
}
QMutexLocker k(&_entriesMutex);
_currentEntry = isChoice->getActiveEntry();
}
bool
KnobChoice::cloneExtraDataAndCheckIfChanged(KnobI* other,
int /*dimension*/,
int /*otherDimension*/)
{
KnobChoice* isChoice = dynamic_cast<KnobChoice*>(other);
if (!isChoice) {
return false;
}
ChoiceOption otherEntry = isChoice->getActiveEntry();
QMutexLocker k(&_entriesMutex);
if (_currentEntry.id != otherEntry.id) {
_currentEntry = otherEntry;
return true;
}
return false;
}
void
KnobChoice::cloneExtraData(KnobI* other,
double /*offset*/,
const RangeD* /*range*/,
int /*dimension*/,
int /*otherDimension*/)
{
// TODO: Isn't this redundant, as it's implementation is identical to the other cloneExtraData?
KnobChoice* isChoice = dynamic_cast<KnobChoice*>(other);
if (!isChoice) {
return;
}
QMutexLocker k(&_entriesMutex);
_currentEntry = isChoice->getActiveEntry();
}
void
KnobChoice::onInternalValueChanged(int dimension,
double time,
ViewSpec /*view*/)
{
// by-pass any master/slave link here
int index = getValueAtTime(time, dimension, ViewSpec::current(), true, true);
QMutexLocker k(&_entriesMutex);
if ( (index >= 0) && ( index < (int)_entries.size() ) ) {
_currentEntry = _entries[index];
}
}
#if 0 // dead code
// replaced by boost::iequals(a, b)
static bool
caseInsensitiveCompare(const std::string& a,
const std::string& b)
{
if ( a.size() != b.size() ) {
return false;
}
std::locale loc;
for (std::size_t i = 0; i < a.size(); ++i) {
char aLow = std::tolower(a[i], loc);
char bLow = std::tolower(b[i], loc);
if (aLow != bLow) {
return false;
}
}
return true;
}
#endif
void
KnobChoice::findAndSetOldChoice()
{
int found = -1;
{
QMutexLocker k(&_entriesMutex);
if ( !_currentEntry.id.empty() ) {
ChoiceOption matched;
found = choiceMatch(_currentEntry.id, _entries, &matched);
if (found != -1) {
_currentEntry = matched;
}
}
}
if (found != -1) {
// Make sure we don't call knobChanged if we found the value
blockValueChanges();
beginChanges();
setValue(found);
unblockValueChanges();
endChanges();
}
}
bool
KnobChoice::populateChoices(const std::vector<ChoiceOption> &entries)
{
bool hasChanged = false;
{
QMutexLocker l(&_entriesMutex);
_entries = entries;
for (std::size_t i = 0; i < _entries.size(); ++i) {
// The ID cannot be empty, this is the only way to uniquely identify the choice.
assert(!_entries[i].id.empty());
// If the label is not set, use the ID
if (_entries[i].label.empty()) {
_entries[i].label = _entries[i].id;
}
}
hasChanged = true;
}
/*
Try to restore the last choice.
*/
if (hasChanged) {
findAndSetOldChoice();
if (_signalSlotHandler) {
_signalSlotHandler->s_helpChanged();
}
Q_EMIT populated();
}
return hasChanged;
} // KnobChoice::populateChoices
void
KnobChoice::resetChoices()
{
{
QMutexLocker l(&_entriesMutex);
_entries.clear();
}
findAndSetOldChoice();
if (_signalSlotHandler) {
_signalSlotHandler->s_helpChanged();
}
Q_EMIT entriesReset();
}
void
KnobChoice::appendChoice(const ChoiceOption& entry)
{
{
QMutexLocker l(&_entriesMutex);
_entries.push_back(entry);
ChoiceOption& opt = _entries.back();
// If label is empty, set to the option id
if (opt.label.empty()) {
opt.label = opt.id;
}
}
findAndSetOldChoice();
if (_signalSlotHandler) {
_signalSlotHandler->s_helpChanged();
}
Q_EMIT entryAppended();
}
std::vector<ChoiceOption>
KnobChoice::getEntries_mt_safe() const
{
QMutexLocker l(&_entriesMutex);
return _entries;
}
bool
KnobChoice::isActiveEntryPresentInEntries() const
{
QMutexLocker k(&_entriesMutex);
if ( _currentEntry.id.empty() ) {
return true;
}
for (std::size_t i = 0; i < _entries.size(); ++i) {
if (_entries[i].id == _currentEntry.id) {
return true;
}
}
return false;
}
ChoiceOption
KnobChoice::getEntry(int v) const
{
if ( (int)_entries.size() <= v || v < 0) {
throw std::runtime_error( std::string("KnobChoice::getEntry: index out of range") );
}
return _entries[v];
}
int
KnobChoice::getNumEntries() const
{
QMutexLocker l(&_entriesMutex);
return (int)_entries.size();
}
void
KnobChoice::setActiveEntry(const ChoiceOption& opt)
{
QMutexLocker l(&_entriesMutex);
_currentEntry = opt;
}
ChoiceOption
KnobChoice::getActiveEntry()
{
std::pair<int, KnobIPtr> master = getMaster(0);
if (master.second) {
KnobChoice* isChoice = dynamic_cast<KnobChoice*>( master.second.get() );
if (isChoice) {
return isChoice->getActiveEntry();
}
}
QMutexLocker l(&_entriesMutex);
if ( !_currentEntry.id.empty() ) {
return _currentEntry;
}
int activeIndex = getValue();
if ( activeIndex < (int)_entries.size() ) {
_currentEntry = _entries[activeIndex];
return _entries[activeIndex];
}
return ChoiceOption();
}
#if 0 // dead code
// replaced by boost::trim_copy(str)
static std::string
trim(std::string const & str)
{
const std::string whitespace = " \t\f\v\n\r";
std::size_t first = str.find_first_not_of(whitespace);
// If there is no non-whitespace character, both first and last will be std::string::npos (-1)
// There is no point in checking both, since if either doesn't work, the
// other won't work, either.
if (first == std::string::npos) {
return "";
}
std::size_t last = str.find_last_not_of(whitespace);
return str.substr(first, last - first + 1);
}
// replaced by std::replace_if(str.begin(), str.end(), ::isspace, ' ');
static void
whitespacify(std::string & str)
{
std::replace( str.begin(), str.end(), '\t', ' ');
std::replace( str.begin(), str.end(), '\f', ' ');
std::replace( str.begin(), str.end(), '\v', ' ');
std::replace( str.begin(), str.end(), '\n', ' ');
std::replace( str.begin(), str.end(), '\r', ' ');
}
#endif
std::string
KnobChoice::getHintToolTipFull() const
{
assert( QThread::currentThread() == qApp->thread() );
int gothelp = 0;
// list values that either have help or have label != id
if ( !_entries.empty() ) {
assert( _entries.size() == _entries.size() );
for (U32 i = 0; i < _entries.size(); ++i) {
if ( !_entries.empty() && ( (_entries[i].id != _entries[i].label) || !_entries[i].tooltip.empty() ) ) {
++gothelp;
}
}
}
if (gothelp > KNOBCHOICE_MAX_ENTRIES_HELP) {
// too many entries
gothelp = 0;
}
std::stringstream ss;
if ( !getHintToolTip().empty() ) {
ss << boost::trim_copy( getHintToolTip() );
if (gothelp) {
// if there are per-option help strings, separate them from main hint
ss << "\n\n";
}
}
// param may have no hint but still have per-option help
if (gothelp) {
for (U32 i = 0; i < _entries.size(); ++i) {
if ( !_entries[i].tooltip.empty() ) { // no help line is needed if help is unavailable for this option
std::string entry = boost::trim_copy(_entries[i].label);
std::replace_if(entry.begin(), entry.end(), ::isspace, ' ');
if (_entries[i].label != _entries[i].id) {
entry += " (" + _entries[i].id + ")";
}
std::string help = boost::trim_copy(_entries[i].tooltip);
std::replace_if(help.begin(), help.end(), ::isspace, ' ');
if ( isHintInMarkdown() ) {
ss << "* **" << entry << "**";
} else {
ss << entry;
}
ss << ": ";
ss << help;
if (i < _entries.size() - 1) {
ss << '\n';
}
}
}
}
return ss.str();
} // KnobChoice::getHintToolTipFull
KnobHelper::ValueChangedReturnCodeEnum
KnobChoice::setValueFromID(const std::string & value,
int dimension,
bool turnOffAutoKeying)
{
int i;
{
QMutexLocker k(&_entriesMutex);
i = choiceMatch(value, _entries, &_currentEntry);
}
if (i >= 0) {
return setValue(i, ViewIdx(0), dimension, turnOffAutoKeying);
}
/*{
QMutexLocker k(&_entriesMutex);
_currentEntryLabel = value;
}
return setValue(-1, ViewIdx(0), dimension, turnOffAutoKeying);*/
return eValueChangedReturnCodeNothingChanged;
}
void
KnobChoice::setDefaultValueFromIDWithoutApplying(const std::string & value,
int dimension)
{
int i = choiceMatch(value, _entries, 0);
if (i >= 0) {
return setDefaultValueWithoutApplying(i, dimension);
}
throw std::runtime_error(std::string("KnobChoice::setDefaultValueFromLabel: unknown label ") + value);
}
void
KnobChoice::setDefaultValueFromID(const std::string & value,
int dimension)
{
int i = choiceMatch(value, _entries, 0);
if (i >= 0) {
return setDefaultValue(i, dimension);
}
throw std::runtime_error(std::string("KnobChoice::setDefaultValueFromLabel: unknown label ") + value);
}
// try to match entry id first, then label
static
const std::string&
entryStr(const ChoiceOption& opt, int s)
{
return s == 0 ? opt.id : opt.label;
}
static
bool BothAreSpaces(char lhs, char rhs) { return (lhs == rhs) && (lhs == ' '); }
// Choice restoration tries several options to restore a choice value:
// 1- exact string match, same index
// 2- exact string match, other index
// 3- exact string match before the first '\t', other index
// 4- case-insensistive string match, other index
// 5- paren/bracket-insensitive match (for WriteFFmpeg's format and codecs)
// 6- if the choice ends with " 1" try to match exactly everything before that (for formats with PAR=1, where the PAR was removed)
// returns index if choice was matched, -1 if not matched
#pragma message WARN("choiceMatch() should be moved into filterKnobChoiceOptionCompat().")
// TODO: choiceMatch() should be moved into filterKnobChoiceOptionCompat()
// TODO: filterKnobChoiceOptionCompat() should be used everywhere instead of choiceMatch()
int
KnobChoice::choiceMatch(const std::string& choice,
const std::vector<ChoiceOption>& entries,
ChoiceOption* matchedEntry)
{
if (entries.size() == 0) {
// no match
return -1;
}