forked from edgardoh/darktable
/
iop_order.c
2052 lines (1728 loc) · 67.2 KB
/
iop_order.c
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
/*
This file is part of darktable,
Copyright (C) 2018-2021 darktable developers.
darktable 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 3 of the License, or
(at your option) any later version.
darktable 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 darktable. If not, see <http://www.gnu.org/licenses/>.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "common/darktable.h"
#include "common/iop_order.h"
#include "common/styles.h"
#include "common/debug.h"
#include "develop/imageop.h"
#include "develop/pixelpipe.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#define DT_IOP_ORDER_VERSION 5
#define DT_IOP_ORDER_INFO (darktable.unmuted & DT_DEBUG_IOPORDER)
static void _ioppr_reset_iop_order(GList *iop_order_list);
/** Note :
* we do not use finite-math-only and fast-math because divisions by zero are not manually avoided in the code
* fp-contract=fast enables hardware-accelerated Fused Multiply-Add
* the rest is loop reorganization and vectorization optimization
**/
#if defined(__GNUC__)
#pragma GCC optimize ("unroll-loops", "tree-loop-if-convert", \
"tree-loop-distribution", "no-strict-aliasing", \
"loop-interchange", "loop-nest-optimize", "tree-loop-im", \
"unswitch-loops", "tree-loop-ivcanon", "ira-loop-pressure", \
"split-ivs-in-unroller", "variable-expansion-in-unroller", \
"split-loops", "ivopts", "predictive-commoning",\
"tree-loop-linear", "loop-block", "loop-strip-mine", \
"fp-contract=fast", \
"tree-vectorize")
#endif
const char *iop_order_string[] =
{
N_("custom"),
N_("legacy"),
N_("v3.0")
};
const char *dt_iop_order_string(const dt_iop_order_t order)
{
if(order >= DT_IOP_ORDER_LAST)
return "???";
else
return iop_order_string[order];
}
// note legacy_order & v30_order have the original iop-order double that is
// used only for the initial database migration.
//
// in the new code only the iop-order as int is used to order the module on the GUI.
// @@_NEW_MODULE: For new module it is required to insert the new module name in both lists below.
const dt_iop_order_entry_t legacy_order[] = {
{ { 1.0f }, "rawprepare", 0},
{ { 2.0f }, "invert", 0},
{ { 3.0f }, "temperature", 0},
{ { 4.0f }, "highlights", 0},
{ { 5.0f }, "cacorrect", 0},
{ { 6.0f }, "hotpixels", 0},
{ { 7.0f }, "rawdenoise", 0},
{ { 8.0f }, "demosaic", 0},
{ { 9.0f }, "mask_manager", 0},
{ {10.0f }, "denoiseprofile", 0},
{ {11.0f }, "tonemap", 0},
{ {12.0f }, "exposure", 0},
{ {13.0f }, "spots", 0},
{ {14.0f }, "retouch", 0},
{ {15.0f }, "lens", 0},
{ {15.5f }, "cacorrectrgb", 0},
{ {16.0f }, "ashift", 0},
{ {17.0f }, "liquify", 0},
{ {18.0f }, "rotatepixels", 0},
{ {19.0f }, "scalepixels", 0},
{ {20.0f }, "flip", 0},
{ {21.0f }, "clipping", 0},
{ {21.5f }, "toneequal", 0},
{ {21.7f }, "crop", 0},
{ {22.0f }, "graduatednd", 0},
{ {23.0f }, "basecurve", 0},
{ {24.0f }, "bilateral", 0},
{ {25.0f }, "profile_gamma", 0},
{ {26.0f }, "hazeremoval", 0},
{ {27.0f }, "colorin", 0},
{ {27.5f }, "diffuse", 0},
{ {27.5f }, "channelmixerrgb", 0},
{ {27.5f }, "censorize", 0},
{ {27.5f }, "negadoctor", 0},
{ {27.5f }, "blurs", 0},
{ {27.5f }, "basicadj", 0},
{ {28.0f }, "colorreconstruct", 0},
{ {29.0f }, "colorchecker", 0},
{ {30.0f }, "defringe", 0},
{ {31.0f }, "equalizer", 0},
{ {32.0f }, "vibrance", 0},
{ {33.0f }, "colorbalance", 0},
{ {33.5f }, "colorbalancergb", 0},
{ {34.0f }, "colorize", 0},
{ {35.0f }, "colortransfer", 0},
{ {36.0f }, "colormapping", 0},
{ {37.0f }, "bloom", 0},
{ {38.0f }, "nlmeans", 0},
{ {39.0f }, "globaltonemap", 0},
{ {40.0f }, "shadhi", 0},
{ {41.0f }, "atrous", 0},
{ {42.0f }, "bilat", 0},
{ {43.0f }, "colorzones", 0},
{ {44.0f }, "lowlight", 0},
{ {45.0f }, "monochrome", 0},
{ {46.0f }, "filmic", 0},
{ {46.5f }, "filmicrgb", 0},
{ {47.0f }, "colisa", 0},
{ {48.0f }, "zonesystem", 0},
{ {49.0f }, "tonecurve", 0},
{ {50.0f }, "levels", 0},
{ {50.2f }, "rgblevels", 0},
{ {50.5f }, "rgbcurve", 0},
{ {51.0f }, "relight", 0},
{ {52.0f }, "colorcorrection", 0},
{ {53.0f }, "sharpen", 0},
{ {54.0f }, "lowpass", 0},
{ {55.0f }, "highpass", 0},
{ {56.0f }, "grain", 0},
{ {56.5f }, "lut3d", 0},
{ {57.0f }, "colorcontrast", 0},
{ {58.0f }, "colorout", 0},
{ {59.0f }, "channelmixer", 0},
{ {60.0f }, "soften", 0},
{ {61.0f }, "vignette", 0},
{ {62.0f }, "splittoning", 0},
{ {63.0f }, "velvia", 0},
{ {64.0f }, "clahe", 0},
{ {65.0f }, "finalscale", 0},
{ {66.0f }, "overexposed", 0},
{ {67.0f }, "rawoverexposed", 0},
{ {67.5f }, "dither", 0},
{ {68.0f }, "borders", 0},
{ {69.0f }, "watermark", 0},
{ {71.0f }, "gamma", 0},
{ { 0.0f }, "", 0}
};
const dt_iop_order_entry_t v30_order[] = {
{ { 1.0 }, "rawprepare", 0},
{ { 2.0 }, "invert", 0},
{ { 3.0f }, "temperature", 0},
{ { 4.0f }, "highlights", 0},
{ { 5.0f }, "cacorrect", 0},
{ { 6.0f }, "hotpixels", 0},
{ { 7.0f }, "rawdenoise", 0},
{ { 8.0f }, "demosaic", 0},
{ { 9.0f }, "denoiseprofile", 0},
{ {10.0f }, "bilateral", 0},
{ {11.0f }, "rotatepixels", 0},
{ {12.0f }, "scalepixels", 0},
{ {13.0f }, "lens", 0},
{ {13.5f }, "cacorrectrgb", 0}, // correct chromatic aberrations after lens correction so that lensfun
// does not reintroduce chromatic aberrations when trying to correct them
{ {14.0f }, "hazeremoval", 0},
{ {15.0f }, "ashift", 0},
{ {16.0f }, "flip", 0},
{ {17.0f }, "clipping", 0},
{ {18.0f }, "liquify", 0},
{ {19.0f }, "spots", 0},
{ {20.0f }, "retouch", 0},
{ {21.0f }, "exposure", 0},
{ {22.0f }, "mask_manager", 0},
{ {23.0f }, "tonemap", 0},
{ {24.0f }, "toneequal", 0}, // last module that need enlarged roi_in
{ {24.5f }, "crop", 0}, // should go after all modules that may need a wider roi_in
{ {25.0f }, "graduatednd", 0},
{ {26.0f }, "profile_gamma", 0},
{ {27.0f }, "equalizer", 0},
{ {28.0f }, "colorin", 0},
{ {28.5f }, "diffuse", 0},
{ {28.5f }, "channelmixerrgb", 0},
{ {28.5f }, "censorize", 0},
{ {28.5f }, "negadoctor", 0}, // Cineon film encoding comes after scanner input color profile
{ {28.5f }, "blurs", 0}, // physically-accurate blurs (motion and lens)
{ {29.0f }, "nlmeans", 0}, // signal processing (denoising)
// -> needs a signal as scene-referred as possible (even if it works in Lab)
{ {30.0f }, "colorchecker", 0}, // calibration to "neutral" exchange colour space
// -> improve colour calibration of colorin and reproductibility
// of further edits (styles etc.)
{ {31.0f }, "defringe", 0}, // desaturate fringes in Lab, so needs properly calibrated colours
// in order for chromaticity to be meaningful,
{ {32.0f }, "atrous", 0}, // frequential operation, needs a signal as scene-referred as possible to avoid halos
{ {33.0f }, "lowpass", 0}, // same
{ {34.0f }, "highpass", 0}, // same
{ {35.0f }, "sharpen", 0}, // same, worst than atrous in same use-case, less control overall
{ {36.0f }, "lut3d", 0}, // apply a creative style or film emulation, possibly non-linear,
// so better move it after frequential ops that need L2 Hilbert spaces
// of square summable functions
{ {37.0f }, "colortransfer", 0}, // probably better if source and destination colours are neutralized in the same
// colour exchange space, hence after colorin and colorcheckr,
// but apply after frequential ops in case it does non-linear witchcraft,
// just to be safe
{ {38.0f }, "colormapping", 0}, // same
{ {39.0f }, "channelmixer", 0}, // does exactly the same thing as colorin, aka RGB to RGB matrix conversion,
// but coefs are user-defined instead of calibrated and read from ICC profile.
// Really versatile yet under-used module, doing linear ops,
// very good in scene-referred workflow
{ {40.0f }, "basicadj", 0}, // module mixing view/model/control at once, usage should be discouraged
{ {41.0f }, "colorbalance", 0}, // scene-referred color manipulation
{ {41.5f }, "colorbalancergb", 0}, // scene-referred color manipulation
{ {42.0f }, "rgbcurve", 0}, // really versatile way to edit colour in scene-referred and display-referred workflow
{ {43.0f }, "rgblevels", 0}, // same
{ {44.0f }, "basecurve", 0}, // conversion from scene-referred to display referred, reverse-engineered
// on camera JPEG default look
{ {45.0f }, "filmic", 0}, // same, but different (parametric) approach
{ {46.0f }, "filmicrgb", 0}, // same, upgraded
{ {47.0f }, "colisa", 0}, // edit contrast while damaging colour
{ {48.0f }, "tonecurve", 0}, // same
{ {49.0f }, "levels", 0}, // same
{ {50.0f }, "shadhi", 0}, // same
{ {51.0f }, "zonesystem", 0}, // same
{ {52.0f }, "globaltonemap", 0}, // same
{ {53.0f }, "relight", 0}, // flatten local contrast while pretending do add lightness
{ {54.0f }, "bilat", 0}, // improve clarity/local contrast after all the bad things we have done
// to it with tonemapping
{ {55.0f }, "colorcorrection", 0}, // now that the colours have been damaged by contrast manipulations,
// try to recover them - global adjustment of white balance for shadows and highlights
{ {56.0f }, "colorcontrast", 0}, // adjust chrominance globally
{ {57.0f }, "velvia", 0}, // same
{ {58.0f }, "vibrance", 0}, // same, but more subtle
{ {60.0f }, "colorzones", 0}, // same, but locally
{ {61.0f }, "bloom", 0}, // creative module
{ {62.0f }, "colorize", 0}, // creative module
{ {63.0f }, "lowlight", 0}, // creative module
{ {64.0f }, "monochrome", 0}, // creative module
{ {65.0f }, "grain", 0}, // creative module
{ {66.0f }, "soften", 0}, // creative module
{ {67.0f }, "splittoning", 0}, // creative module
{ {68.0f }, "vignette", 0}, // creative module
{ {69.0f }, "colorreconstruct", 0},// try to salvage blown areas before ICC intents in LittleCMS2 do things with them.
{ {70.0f }, "colorout", 0},
{ {71.0f }, "clahe", 0},
{ {72.0f }, "finalscale", 0},
{ {73.0f }, "overexposed", 0},
{ {74.0f }, "rawoverexposed", 0},
{ {75.0f }, "dither", 0},
{ {76.0f }, "borders", 0},
{ {77.0f }, "watermark", 0},
{ {78.0f }, "gamma", 0},
{ { 0.0f }, "", 0 }
};
static void *_dup_iop_order_entry(const void *src, gpointer data);
static int _count_entries_operation(GList *e_list, const char *operation);
static GList *_insert_before(GList *iop_order_list, const char *module, const char *new_module)
{
gboolean exists = FALSE;
// first check that new module is missing
for(const GList *l = iop_order_list; l; l = g_list_next(l))
{
const dt_iop_order_entry_t *const restrict entry = (dt_iop_order_entry_t *)l->data;
if(!strcmp(entry->operation, new_module))
{
exists = TRUE;
break;
}
}
// the insert it if needed
if(!exists)
{
for(GList *l = iop_order_list; l; l = g_list_next(l))
{
const dt_iop_order_entry_t *const restrict entry = (dt_iop_order_entry_t *)l->data;
if(!strcmp(entry->operation, module))
{
dt_iop_order_entry_t *new_entry = (dt_iop_order_entry_t *)malloc(sizeof(dt_iop_order_entry_t));
g_strlcpy(new_entry->operation, new_module, sizeof(new_entry->operation));
new_entry->instance = 0;
new_entry->o.iop_order = 0;
iop_order_list = g_list_insert_before(iop_order_list, l, new_entry);
break;
}
}
}
return iop_order_list;
}
dt_iop_order_t dt_ioppr_get_iop_order_version(const int32_t imgid)
{
const gboolean is_display_referred =
dt_conf_is_equal("plugins/darkroom/workflow", "display-referred");
dt_iop_order_t iop_order_version =
is_display_referred ? DT_IOP_ORDER_LEGACY : DT_IOP_ORDER_V30;
// check current iop order version
sqlite3_stmt *stmt;
DT_DEBUG_SQLITE3_PREPARE_V2(dt_database_get(darktable.db), "SELECT version FROM main.module_order WHERE imgid = ?1",
-1, &stmt, NULL);
DT_DEBUG_SQLITE3_BIND_INT(stmt, 1, imgid);
if(sqlite3_step(stmt) == SQLITE_ROW)
{
iop_order_version = sqlite3_column_int(stmt, 0);
}
sqlite3_finalize(stmt);
return iop_order_version;
}
// a rule prevents operations to be switched,
// that is a prev operation will not be allowed to be moved on top of the next operation.
GList *dt_ioppr_get_iop_order_rules()
{
GList *rules = NULL;
const dt_iop_order_rule_t rule_entry[] = {
{ .op_prev = "rawprepare", .op_next = "invert" },
{ .op_prev = "invert", .op_next = "temperature" },
{ .op_prev = "temperature", .op_next = "highlights" },
{ .op_prev = "highlights", .op_next = "cacorrect" },
{ .op_prev = "cacorrect", .op_next = "hotpixels" },
{ .op_prev = "hotpixels", .op_next = "rawdenoise" },
{ .op_prev = "rawdenoise", .op_next = "demosaic" },
{ .op_prev = "demosaic", .op_next = "colorin" },
{ .op_prev = "colorin", .op_next = "colorout" },
{ .op_prev = "colorout", .op_next = "gamma" },
{ .op_prev = "flip", .op_next = "clipping" }, // clipping GUI broken if flip is done on top
{ .op_prev = "ashift", .op_next = "clipping" }, // clipping GUI broken if ashift is done on top
{ .op_prev = "colorin", .op_next = "channelmixerrgb"},
{ "\0", "\0" } };
int i = 0;
while(rule_entry[i].op_prev[0])
{
dt_iop_order_rule_t *rule = calloc(1, sizeof(dt_iop_order_rule_t));
memcpy(rule->op_prev, rule_entry[i].op_prev, sizeof(rule->op_prev));
memcpy(rule->op_next, rule_entry[i].op_next, sizeof(rule->op_next));
rules = g_list_prepend(rules, rule);
i++;
}
return g_list_reverse(rules); // list was built in reverse order, so un-reverse it
}
GList *dt_ioppr_get_iop_order_link(GList *iop_order_list, const char *op_name, const int multi_priority)
{
GList *link = NULL;
for(GList *iops_order = iop_order_list; iops_order; iops_order = g_list_next(iops_order))
{
dt_iop_order_entry_t *order_entry = (dt_iop_order_entry_t *)iops_order->data;
if(strcmp(order_entry->operation, op_name) == 0
&& (order_entry->instance == multi_priority || multi_priority == -1))
{
link = iops_order;
break;
}
}
return link;
}
// returns the first iop order entry that matches operation == op_name
dt_iop_order_entry_t *dt_ioppr_get_iop_order_entry(GList *iop_order_list, const char *op_name, const int multi_priority)
{
const GList * const restrict link = dt_ioppr_get_iop_order_link(iop_order_list, op_name, multi_priority);
if(link)
return (dt_iop_order_entry_t *)link->data;
else
return NULL;
}
// returns the iop_order associated with the iop order entry that matches operation == op_name
int dt_ioppr_get_iop_order(GList *iop_order_list, const char *op_name, const int multi_priority)
{
int iop_order = INT_MAX;
const dt_iop_order_entry_t *const restrict order_entry =
dt_ioppr_get_iop_order_entry(iop_order_list, op_name, multi_priority);
if(order_entry)
{
iop_order = order_entry->o.iop_order;
}
else
fprintf(stderr, "cannot get iop-order for %s instance %d\n", op_name, multi_priority);
return iop_order;
}
gboolean dt_ioppr_is_iop_before(GList *iop_order_list, const char *base_operation,
const char *operation, const int multi_priority)
{
const int base_order = dt_ioppr_get_iop_order(iop_order_list, base_operation, -1);
const int op_order = dt_ioppr_get_iop_order(iop_order_list, operation, multi_priority);
return op_order < base_order;
}
gint dt_sort_iop_list_by_order(gconstpointer a, gconstpointer b)
{
const dt_iop_order_entry_t *const restrict am = (const dt_iop_order_entry_t *)a;
const dt_iop_order_entry_t *const restrict bm = (const dt_iop_order_entry_t *)b;
if(am->o.iop_order > bm->o.iop_order) return 1;
if(am->o.iop_order < bm->o.iop_order) return -1;
return 0;
}
gint dt_sort_iop_list_by_order_f(gconstpointer a, gconstpointer b)
{
const dt_iop_order_entry_t *const restrict am = (const dt_iop_order_entry_t *)a;
const dt_iop_order_entry_t *const restrict bm = (const dt_iop_order_entry_t *)b;
if(am->o.iop_order_f > bm->o.iop_order_f) return 1;
if(am->o.iop_order_f < bm->o.iop_order_f) return -1;
return 0;
}
dt_iop_order_t dt_ioppr_get_iop_order_list_kind(GList *iop_order_list)
{
// first check if this is the v30 order
int k = 0;
GList *l = iop_order_list;
gboolean ok = TRUE;
while(l)
{
const dt_iop_order_entry_t *const restrict entry = (dt_iop_order_entry_t *)l->data;
if(strcmp(v30_order[k].operation, entry->operation))
{
ok = FALSE;
break;
}
else
{
// skip all the other instance of same module if any
while(g_list_next(l)
&& !strcmp(v30_order[k].operation, ((dt_iop_order_entry_t *)(g_list_next(l)->data))->operation))
l = g_list_next(l);
}
k++;
l = g_list_next(l);
}
if(ok) return DT_IOP_ORDER_V30;
// then check if this is the legacy order
k = 0;
l = iop_order_list;
ok = TRUE;
while(l)
{
const dt_iop_order_entry_t *const restrict entry = (dt_iop_order_entry_t *)l->data;
if(strcmp(legacy_order[k].operation, entry->operation))
{
ok = FALSE;
break;
}
else
{
// skip all the other instance of same module if any
while(g_list_next(l)
&& !strcmp(legacy_order[k].operation, ((dt_iop_order_entry_t *)(g_list_next(l)->data))->operation))
l = g_list_next(l);
}
k++;
l = g_list_next(l);
}
if(ok) return DT_IOP_ORDER_LEGACY;
return DT_IOP_ORDER_CUSTOM;
}
gboolean dt_ioppr_has_multiple_instances(GList *iop_order_list)
{
GList *l = iop_order_list;
while(l)
{
GList *next = g_list_next(l);
if(next
&& (strcmp(((dt_iop_order_entry_t *)(l->data))->operation,
((dt_iop_order_entry_t *)(next->data))->operation) == 0))
{
return TRUE;
}
l = next;
}
return FALSE;
}
gboolean dt_ioppr_write_iop_order(const dt_iop_order_t kind, GList *iop_order_list, const int32_t imgid)
{
sqlite3_stmt *stmt;
DT_DEBUG_SQLITE3_PREPARE_V2(dt_database_get(darktable.db),
"INSERT OR REPLACE INTO main.module_order VALUES (?1, 0, NULL)", -1,
&stmt, NULL);
DT_DEBUG_SQLITE3_BIND_INT(stmt, 1, imgid);
if(sqlite3_step(stmt) != SQLITE_DONE) return FALSE;
sqlite3_finalize(stmt);
if(kind == DT_IOP_ORDER_CUSTOM || dt_ioppr_has_multiple_instances(iop_order_list))
{
gchar *iop_list_txt = dt_ioppr_serialize_text_iop_order_list(iop_order_list);
DT_DEBUG_SQLITE3_PREPARE_V2(dt_database_get(darktable.db),
"UPDATE main.module_order SET version = ?2, iop_list = ?3 WHERE imgid = ?1", -1,
&stmt, NULL);
DT_DEBUG_SQLITE3_BIND_INT(stmt, 1, imgid);
DT_DEBUG_SQLITE3_BIND_INT(stmt, 2, kind);
DT_DEBUG_SQLITE3_BIND_TEXT(stmt, 3, iop_list_txt, -1, SQLITE_TRANSIENT);
if(sqlite3_step(stmt) != SQLITE_DONE) return FALSE;
sqlite3_finalize(stmt);
g_free(iop_list_txt);
}
else
{
DT_DEBUG_SQLITE3_PREPARE_V2(dt_database_get(darktable.db),
"UPDATE main.module_order SET version = ?2, iop_list = NULL WHERE imgid = ?1", -1,
&stmt, NULL);
DT_DEBUG_SQLITE3_BIND_INT(stmt, 1, imgid);
DT_DEBUG_SQLITE3_BIND_INT(stmt, 2, kind);
if(sqlite3_step(stmt) != SQLITE_DONE) return FALSE;
sqlite3_finalize(stmt);
}
return TRUE;
}
gboolean dt_ioppr_write_iop_order_list(GList *iop_order_list, const int32_t imgid)
{
const dt_iop_order_t kind = dt_ioppr_get_iop_order_list_kind(iop_order_list);
return dt_ioppr_write_iop_order(kind, iop_order_list, imgid);
}
GList *_table_to_list(const dt_iop_order_entry_t entries[])
{
GList *iop_order_list = NULL;
int k = 0;
while(entries[k].operation[0])
{
dt_iop_order_entry_t *entry = (dt_iop_order_entry_t *)malloc(sizeof(dt_iop_order_entry_t));
g_strlcpy(entry->operation, entries[k].operation, sizeof(entry->operation));
entry->instance = 0;
entry->o.iop_order_f = entries[k].o.iop_order_f;
iop_order_list = g_list_prepend(iop_order_list, entry);
k++;
}
return g_list_reverse(iop_order_list); // list was built in reverse order, so un-reverse it
}
GList *dt_ioppr_get_iop_order_list_version(dt_iop_order_t version)
{
GList *iop_order_list = NULL;
if(version == DT_IOP_ORDER_LEGACY)
{
iop_order_list = _table_to_list(legacy_order);
}
else if(version == DT_IOP_ORDER_V30)
{
iop_order_list = _table_to_list(v30_order);
}
return iop_order_list;
}
gboolean dt_ioppr_has_iop_order_list(int32_t imgid)
{
gboolean result = FALSE;
sqlite3_stmt *stmt;
DT_DEBUG_SQLITE3_PREPARE_V2(dt_database_get(darktable.db),
"SELECT version, iop_list"
" FROM main.module_order"
" WHERE imgid=?1", -1, &stmt, NULL);
DT_DEBUG_SQLITE3_BIND_INT(stmt, 1, imgid);
if(sqlite3_step(stmt) == SQLITE_ROW)
{
result = (sqlite3_column_type(stmt, 1) != SQLITE_NULL);
}
sqlite3_finalize(stmt);
return result;
}
GList *dt_ioppr_get_iop_order_list(int32_t imgid, gboolean sorted)
{
GList *iop_order_list = NULL;
if(imgid > 0)
{
sqlite3_stmt *stmt;
// we read the iop-order-list in the preset table, the actual version is
// the first int32_t serialized into the io_params. This is then a sequential
// search, but there will not be many such presets and we do call this routine
// only when loading an image and when changing the iop-order.
DT_DEBUG_SQLITE3_PREPARE_V2(dt_database_get(darktable.db),
"SELECT version, iop_list"
" FROM main.module_order"
" WHERE imgid=?1", -1, &stmt, NULL);
DT_DEBUG_SQLITE3_BIND_INT(stmt, 1, imgid);
if(sqlite3_step(stmt) == SQLITE_ROW)
{
const dt_iop_order_t version = sqlite3_column_int(stmt, 0);
const gboolean has_iop_list = (sqlite3_column_type(stmt, 1) != SQLITE_NULL);
if(version == DT_IOP_ORDER_CUSTOM || has_iop_list)
{
const char *buf = (char *)sqlite3_column_text(stmt, 1);
if(buf) iop_order_list = dt_ioppr_deserialize_text_iop_order_list(buf);
if(!iop_order_list)
{
// preset not found, fall back to last built-in version, will be loaded below
fprintf(stderr, "[dt_ioppr_get_iop_order_list] error building iop_order_list imgid %d\n", imgid);
}
else
{
// @@_NEW_MODULE: For new module it is required to insert the new module name in the iop-order list here.
// The insertion can be done depending on the current iop-order list kind.
_insert_before(iop_order_list, "nlmeans", "negadoctor");
_insert_before(iop_order_list, "negadoctor", "channelmixerrgb");
_insert_before(iop_order_list, "negadoctor", "censorize");
_insert_before(iop_order_list, "rgbcurve", "colorbalancergb");
_insert_before(iop_order_list, "ashift", "cacorrectrgb");
_insert_before(iop_order_list, "graduatednd", "crop");
_insert_before(iop_order_list, "channelmixerrgb", "diffuse");
_insert_before(iop_order_list, "nlmeans", "blurs");
}
}
else if(version == DT_IOP_ORDER_LEGACY)
{
iop_order_list = _table_to_list(legacy_order);
}
else if(version == DT_IOP_ORDER_V30)
{
iop_order_list = _table_to_list(v30_order);
}
else
fprintf(stderr, "[dt_ioppr_get_iop_order_list] invalid iop order version %d for imgid %d\n", version, imgid);
if(iop_order_list)
{
_ioppr_reset_iop_order(iop_order_list);
}
}
sqlite3_finalize(stmt);
}
// fallback to last iop order list (also used to initialize the pipe when imgid = 0)
// and new image not yet loaded or whose history has been reset.
if(!iop_order_list)
{
const char *workflow = dt_conf_get_string_const("plugins/darkroom/workflow");
dt_iop_order_t iop_order_version = strcmp(workflow, "display-referred") == 0 ? DT_IOP_ORDER_LEGACY : DT_IOP_ORDER_V30;
if(iop_order_version == DT_IOP_ORDER_LEGACY)
iop_order_list = _table_to_list(legacy_order);
else
iop_order_list = _table_to_list(v30_order);
}
if(sorted) iop_order_list = g_list_sort(iop_order_list, dt_sort_iop_list_by_order);
return iop_order_list;
}
static void _ioppr_reset_iop_order(GList *iop_order_list)
{
// iop-order must start with a number > 0 and be incremented. There is no
// other constraints.
int iop_order = 1;
for(const GList *l = iop_order_list; l; l = g_list_next(l))
{
dt_iop_order_entry_t *e = (dt_iop_order_entry_t *)l->data;
e->o.iop_order = iop_order++;
}
}
void dt_ioppr_resync_iop_list(dt_develop_t *dev)
{
// make sure that the iop_order_list does not contains possibly removed modules
GList *l = dev->iop_order_list;
while(l)
{
GList *next = g_list_next(l); // need to get next pointer now, as we may be deleting this node
const dt_iop_order_entry_t *const restrict e = (dt_iop_order_entry_t *)l->data;
const dt_iop_module_t *const restrict mod = dt_iop_get_module_by_op_priority(dev->iop, e->operation, e->instance);
if(mod == NULL)
{
dev->iop_order_list = g_list_remove_link(dev->iop_order_list, l);
}
l = next;
}
}
void dt_ioppr_resync_modules_order(dt_develop_t *dev)
{
_ioppr_reset_iop_order(dev->iop_order_list);
// and reset all module iop_order
GList *modules = dev->iop;
while(modules)
{
dt_iop_module_t *mod = (dt_iop_module_t *)(modules->data);
GList *next = g_list_next(modules);
// modules with iop_order set to INT_MAX we keep them as they will be removed (non visible)
// _lib_modulegroups_update_iop_visibility.
if(mod->iop_order != INT_MAX)
mod->iop_order = dt_ioppr_get_iop_order(dev->iop_order_list, mod->op, mod->multi_priority);
modules = next;
}
dev->iop = g_list_sort(dev->iop, dt_sort_iop_by_order);
}
// sets the iop_order on each module of *_iop_list
// iop_order is set only for base modules, multi-instances will be flagged as unused with INT_MAX
// if a module do not exists on iop_order_list it is flagged as unused with INT_MAX
void dt_ioppr_set_default_iop_order(dt_develop_t *dev, const int32_t imgid)
{
// get the iop-order for this image
GList *iop_order_list = dt_ioppr_get_iop_order_list(imgid, FALSE);
// we assign a single iop-order to each module
_ioppr_reset_iop_order(iop_order_list);
if(dev->iop_order_list) g_list_free_full(dev->iop_order_list, free);
dev->iop_order_list = iop_order_list;
// we now set the module list given to this iop-order
dt_ioppr_resync_modules_order(dev);
}
void dt_ioppr_migrate_iop_order(struct dt_develop_t *dev, const int32_t imgid)
{
dt_ioppr_set_default_iop_order(dev, imgid);
dt_dev_reload_history_items(dev);
}
void dt_ioppr_change_iop_order(struct dt_develop_t *dev, const int32_t imgid, GList *new_iop_list)
{
GList *iop_list = dt_ioppr_iop_order_copy_deep(new_iop_list);
GList *mi = dt_ioppr_extract_multi_instances_list(darktable.develop->iop_order_list);
if(mi) iop_list = dt_ioppr_merge_multi_instance_iop_order_list(iop_list, mi);
dt_dev_write_history(darktable.develop);
dt_ioppr_write_iop_order(DT_IOP_ORDER_CUSTOM, iop_list, imgid);
g_list_free_full(iop_list, free);
dt_ioppr_migrate_iop_order(darktable.develop, imgid);
}
GList *dt_ioppr_extract_multi_instances_list(GList *iop_order_list)
{
GList *mi = NULL;
for(const GList *l = iop_order_list; l; l = g_list_next(l))
{
const dt_iop_order_entry_t *const restrict entry = (dt_iop_order_entry_t *)l->data;
if(_count_entries_operation(iop_order_list, entry->operation) > 1)
{
dt_iop_order_entry_t *copy = (dt_iop_order_entry_t *)_dup_iop_order_entry((void *)entry, NULL);
mi = g_list_prepend(mi, copy);
}
}
return g_list_reverse(mi); // list was built in reverse order, so un-reverse it
}
GList *dt_ioppr_merge_module_multi_instance_iop_order_list(GList *iop_order_list,
const char *operation, GList *multi_instance_list)
{
const int count_to = _count_entries_operation(iop_order_list, operation);
int item_nb = 0;
GList *link = iop_order_list;
for(const GList *l = multi_instance_list; l; l = g_list_next(l))
{
dt_iop_order_entry_t *entry = (dt_iop_order_entry_t *)l->data;
item_nb++;
if(item_nb <= count_to)
{
link = dt_ioppr_get_iop_order_link(link, operation, -1);
dt_iop_order_entry_t *e = (dt_iop_order_entry_t *)link->data;
e->instance = entry->instance;
// free this entry as not merged into the list
free(entry);
// next replace should happen to any module after this one
link = g_list_next(link);
}
else
{
iop_order_list = g_list_insert_before(iop_order_list, link, entry);
}
}
// if needed removes all other instance of this operation which are superfluous
if(g_list_shorter_than(multi_instance_list, count_to))
{
while(link)
{
const dt_iop_order_entry_t *const restrict entry = (dt_iop_order_entry_t *)link->data;
GList *next = g_list_next(link);
if(strcmp(operation, entry->operation) == 0)
{
iop_order_list = g_list_remove_link(iop_order_list, link);
}
link = next;
}
}
return iop_order_list;
}
GList *dt_ioppr_merge_multi_instance_iop_order_list(GList *iop_order_list, GList *multi_instance_list)
{
GList *op = NULL;
GList *copy = dt_ioppr_iop_order_copy_deep(multi_instance_list);
GList *l = copy;
while(l)
{
dt_iop_order_entry_t *entry = (dt_iop_order_entry_t *)l->data;
GList *l_next = g_list_next(l);
op = g_list_append(op, entry);
copy = g_list_remove_link(copy, l);
GList *mi = l_next;
while(mi)
{
GList *next = g_list_next(mi);
dt_iop_order_entry_t *mi_entry = (dt_iop_order_entry_t *)mi->data;
if(strcmp(entry->operation, mi_entry->operation) == 0)
{
op = g_list_append(op, mi_entry);
copy = g_list_remove_link(copy, mi);
}
mi = next;
}
// copy operation as entry may be freed
char operation[20];
memcpy(operation, entry->operation, sizeof(entry->operation));
iop_order_list = dt_ioppr_merge_module_multi_instance_iop_order_list(iop_order_list, operation, op);
g_list_free(op);
op = NULL;
l = copy;
}
return iop_order_list;
}
static void _count_iop_module(GList *iop, const char *operation, int *max_multi_priority, int *count,
int *max_multi_priority_enabled, int *count_enabled)
{
*max_multi_priority = 0;
*count = 0;
*max_multi_priority_enabled = 0;
*count_enabled = 0;
for(const GList *modules = iop; modules; modules = g_list_next(modules))
{
const dt_iop_module_t *const restrict mod = (dt_iop_module_t *)modules->data;
if(!strcmp(mod->op, operation))
{
(*count)++;
if(*max_multi_priority < mod->multi_priority) *max_multi_priority = mod->multi_priority;
if(mod->enabled)
{
(*count_enabled)++;
if(*max_multi_priority_enabled < mod->multi_priority) *max_multi_priority_enabled = mod->multi_priority;
}
}
}
assert(*count >= *count_enabled);
}
static int _count_entries_operation(GList *e_list, const char *operation)
{
int count = 0;
for(const GList *l = e_list; l; l = g_list_next(l))
{
dt_iop_order_entry_t *ep = (dt_iop_order_entry_t *)l->data;
if(!strcmp(ep->operation, operation)) count++;
}
return count;
}
static gboolean _operation_already_handled(GList *e_list, const char *operation)
{
for(const GList *l = g_list_previous(e_list); l; l = g_list_previous(l))
{
const dt_iop_order_entry_t *const restrict ep = (dt_iop_order_entry_t *)l->data;
if(!strcmp(ep->operation, operation)) return TRUE;
}
return FALSE;
}
// returns the nth module's priority being active or not
int _get_multi_priority(dt_develop_t *dev, const char *operation, const int n, const gboolean only_disabled)
{
int count = 0;
for(const GList *l = dev->iop; l; l = g_list_next(l))
{
const dt_iop_module_t *const restrict mod = (dt_iop_module_t *)l->data;
if((!only_disabled || mod->enabled == FALSE) && !strcmp(mod->op, operation))
{
count++;
if(count == n) return mod->multi_priority;
}
}
return INT_MAX;
}
void dt_ioppr_update_for_entries(dt_develop_t *dev, GList *entry_list, gboolean append)
{
// for each priority list to be checked
for(GList *e_list = entry_list; e_list; e_list = g_list_next(e_list))
{
const dt_iop_order_entry_t *const restrict ep = (dt_iop_order_entry_t *)e_list->data;
gboolean force_append = FALSE;
// we also need to force append (even if overwrite mode is
// selected - append = FALSE) when a module has a specific name
// and this name is not present into the current iop list.