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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
|
/**
* Copyright: Mike Wey 2011
* License: zlib (See accompanying LICENSE file)
* Authors: Mike Wey
*/
module dmagick.Image;
import std.conv;
import std.math;
import std.string;
import core.memory;
import core.stdc.string;
import core.sys.posix.sys.types;
import dmagick.Color;
import dmagick.Exception;
import dmagick.Geometry;
import dmagick.Options;
import dmagick.Utils;
import dmagick.c.annotate;
import dmagick.c.attribute;
import dmagick.c.blob;
import dmagick.c.cacheView;
import dmagick.c.constitute;
import dmagick.c.colormap;
import dmagick.c.colorspace;
import dmagick.c.composite;
import dmagick.c.compress;
import dmagick.c.draw;
import dmagick.c.effect;
import dmagick.c.enhance;
import dmagick.c.fx;
import dmagick.c.geometry;
import dmagick.c.histogram;
import dmagick.c.image;
import dmagick.c.layer;
import dmagick.c.magick;
import dmagick.c.magickString;
import dmagick.c.magickType;
import dmagick.c.memory;
import dmagick.c.pixel;
import dmagick.c.profile;
import dmagick.c.quantum;
import dmagick.c.resample;
import dmagick.c.resize;
import dmagick.c.resource;
import dmagick.c.shear;
import dmagick.c.transform;
import dmagick.c.threshold;
/**
* The image
*/
class Image
{
alias dmagick.c.image.Image MagickCoreImage;
alias RefCounted!( DestroyImage, MagickCoreImage ) ImageRef;
ImageRef imageRef;
Options options; ///The options for this image.
///
this()
{
options = new Options();
imageRef = ImageRef(AcquireImage(options.imageInfo));
}
this(MagickCoreImage* image)
{
options = new Options();
imageRef = ImageRef(image);
}
/**
* Construct an Image by reading from the file or
* URL specified by filename.
*/
this(string filename)
{
options = new Options();
read(filename);
}
/**
* Construct a blank image with the specified color.
*/
this(Geometry size, Color color)
{
options = new Options();
options.size = size;
//Use read to create a cnavas with the spacified color.
read( "canvas:"~ color.toString() );
}
/**
* Construct an image from an in-memory blob.
* The Blob size, depth and magick format may also be specified.
*
* Some image formats require size to be specified,
* the default depth Imagemagick uses is the Quantum size
* it's compiled with. If it doesn't match the depth of the image
* it may need to be specified.
*
* Imagemagick can usualy detect the image format, when the
* format can't be detected a magick format must be specified.
*/
this(void[] blob)
{
options = new Options();
read(blob);
}
///ditto
this(void[] blob, Geometry size)
{
options = new Options();
read(blob, size);
}
///ditto
this(void[] blob, Geometry size, size_t depth)
{
options = new Options();
read(blob, size, depth);
}
///ditto
this(void[] blob, Geometry size, size_t depth, string magick)
{
options = new Options();
read(blob, size, depth, magick);
}
///ditto
this(void[] blob, Geometry size, string magick)
{
options = new Options();
read(blob, size, magick);
}
/**
* Constructs an image from an array of pixels.
*
* Params:
* width = The number of columns in the image.
* height = The number of rows in the image.
* map = A string describing the expected ordering
* of the pixel array. It can be any combination
* or order of R = red, G = green, B = blue, A = alpha
* , C = cyan, Y = yellow, M = magenta, K = black,
* or I = intensity (for grayscale).
* storage = The pixel Staroage type (CharPixel,
* ShortPixel, IntegerPixel, FloatPixel, or DoublePixel).
* pixels = The pixel data.
*/
this(size_t columns, size_t rows, string map, StorageType storage, void[] pixels)
{
options = new Options();
read(columns, rows, map, storage, pixels);
}
/**
* Adaptively blurs the image by blurring more intensely near
* image edges and less intensely far from edges.
* The adaptiveBlur method blurs the image with a Gaussian operator
* of the given radius and standard deviation (sigma).
* For reasonable results, radius should be larger than sigma.
* Use a radius of 0 and adaptive_blur selects a suitable radius for you.
*
* Params:
* radius = The radius of the Gaussian in pixels,
* not counting the center pixel.
* sigma = The standard deviation of the Laplacian, in pixels.
* channel = If no channels are specified, blurs all the channels.
*/
void adaptiveBlur(double radius = 0, double sigma = 1, ChannelType channel = ChannelType.DefaultChannels)
{
MagickCoreImage* image =
AdaptiveBlurImageChannel(imageRef, channel, radius, sigma, DMagickExcepionInfo());
imageRef = ImageRef(image);
}
/**
* adaptiveResize uses the special Mesh Interpolation method
* to resize images. Basically adaptiveResize avoids the excessive
* blurring that resize can produce with sharp color changes.
* This works well for slight image size adjustments and in
* particularly for magnification, And especially with images
* with sharp color changes. But when images are enlarged or reduced
* by more than 50% it will start to produce aliasing,
* and Moiré effects in the results.
*/
void adaptiveResize(Geometry size)
{
ssize_t x, y;
size_t width = columns;
size_t height = rows;
ParseMetaGeometry(toStringz(size.toString), &x, &y, &width, &height);
MagickCoreImage* image =
AdaptiveResizeImage(imageRef, width, height, DMagickExcepionInfo());
imageRef = ImageRef(image);
}
/**
* Adaptively sharpens the image by sharpening more intensely near
* image edges and less intensely far from edges. The adaptiveSharpen
* method sharpens the image with a Gaussian operator of the given
* radius and standard deviation (sigma). For reasonable results,
* radius should be larger than sigma. Use a radius of 0 and
* adaptiveSharpen selects a suitable radius for you.
*
* Params:
* radius = The radius of the Gaussian in pixels,
* not counting the center pixel.
* sigma = The standard deviation of the Laplacian, in pixels.
* channel = If no channels are specified, blurs all the channels.
*/
void adaptiveSharpen(double radius = 0, double sigma = 1, ChannelType channel = ChannelType.DefaultChannels)
{
MagickCoreImage* image =
AdaptiveSharpenImageChannel(imageRef, channel, radius, sigma, DMagickExcepionInfo());
imageRef = ImageRef(image);
}
/**
* Selects an individual threshold for each pixel based on the range
* of intensity values in its local neighborhood. This allows for
* thresholding of an image whose global intensity histogram doesn't
* contain distinctive peaks.
*
* Params:
* width = define the width of the local neighborhood.
* heigth = define the height of the local neighborhood.
* offset = constant to subtract from pixel neighborhood mean.
*/
void adaptiveThreshold(size_t width = 3, size_t height = 3, ssize_t offset = 0)
{
MagickCoreImage* image =
AdaptiveThresholdImage(imageRef, width, height, offset, DMagickExcepionInfo());
imageRef = ImageRef(image);
}
/**
* Adds random noise to the specified channel or channels in the image.
* The amount of time addNoise requires depends on the NoiseType argument.
*
* Params:
* type = A NoiseType value.
* channel = 0 or more ChannelType arguments. If no channels are
* specified, adds noise to all the channels
*/
void addNoise(NoiseType type, ChannelType channel = ChannelType.DefaultChannels)
{
MagickCoreImage* image =
AddNoiseImageChannel(imageRef, channel, type, DMagickExcepionInfo());
imageRef = ImageRef(image);
}
/**
* Transforms the image as specified by the affine matrix.
*/
void affineTransform(AffineMatrix affine)
{
MagickCoreImage* image =
AffineTransformImage(imageRef, &affine, DMagickExcepionInfo());
imageRef = ImageRef(image);
}
/**
* Extracts the pixel data from the specified rectangle.
*
* Params:
* width = Width in pixels of the region to extract.
* height = Height in pixels of the region to extract.
* xOffset = Horizontal ordinate of left-most coordinate
* of region to extract.
* yOffset = Vertical ordinate of top-most coordinate of
* region to extract.
* map = This character string can be any combination
* or order of R = red, G = green, B = blue, A =
* alpha, C = cyan, Y = yellow, M = magenta, and K = black.
* The ordering reflects the order of the pixels in
* the supplied pixel array.
*
* Returns: An array of values contain the pixel components as
* defined by the map parameter and the Type.
*/
T[] exportPixels(T)(size_t width, size_t height, ssize_t xOffset = 0, ssize_t yOffset = 0, string map = "RGBA") const
{
StorageType storage;
void[] pixels = new T[width*height];
static if ( is( T == byte) )
{
storage = CharPixel;
}
else static if ( is( T == short) )
{
storage = ShortPixel;
}
else static if ( is( T == int) )
{
storage = IntegerPixel;
}
else static if ( is( T == long) )
{
storage = LongPixel;
}
else static if ( is( T == float) )
{
storage = FloatPixel;
}
else static if ( is( T == double) )
{
storage = DoublePixel;
}
else
{
assert(false, "Unsupported type");
}
ExportImagePixels(imageRef, xOffset, yOffset, width, height, map, storage, pixels.ptr, DMagickExcepionInfo());
return pixels;
}
/**
* Returns the TypeMetric class witch provides the information
* regarding font metrics such as ascent, descent, text width,
* text height, and maximum horizontal advance. The units of
* these font metrics are in pixels, and that the metrics are
* dependent on the current Image font (default Ghostscript's
* "Helvetica"), pointsize (default 12 points), and x/y resolution
* (default 72 DPI) settings.
*
* The pixel units may be converted to points (the standard
* resolution-independent measure used by the typesetting industry)
* via the following equation:
* ----------------------------------
* sizePoints = (sizePixels * 72)/resolution
* ----------------------------------
* where resolution is in dots-per-inch (DPI). This means that at the
* default image resolution, there is one pixel per point.
* See_Also:
* $(LINK2 http://freetype.sourceforge.net/freetype2/docs/glyphs/index.html
* FreeType Glyph Conventions) for a detailed description of
* font metrics related issues.
*/
TypeMetric getTypeMetrics(string text)
{
TypeMetric metric;
DrawInfo* drawInfo = options.drawInfo;
copyString(drawInfo.text, text);
GetMultilineTypeMetrics(imageRef, drawInfo, &metric);
copyString(drawInfo.text, null);
return metric;
}
/**
* Read an Image by reading from the file or
* URL specified by filename.
*/
void read(string filename)
{
options.filename = filename;
MagickCoreImage* image = ReadImage(options.imageInfo, DMagickExcepionInfo());
imageRef = ImageRef(image);
}
/**
* Read an Image by reading from the file or
* URL specified by filename with the specified size.
* Usefull for images that don't specify their size.
*/
void read(string filename, Geometry size)
{
options.size = size;
read(filename);
}
/**
* Reads an image from an in-memory blob.
* The Blob size, depth and magick format may also be specified.
*
* Some image formats require size to be specified,
* the default depth Imagemagick uses is the Quantum size
* it's compiled with. If it doesn't match the depth of the image
* it may need to be specified.
*
* Imagemagick can usualy detect the image format, when the
* format can't be detected a magick format must be specified.
*/
void read(void[] blob)
{
MagickCoreImage* image =
BlobToImage(options.imageInfo, blob.ptr, blob.length, DMagickExcepionInfo());
imageRef = ImageRef(image);
}
///ditto
void read(void[] blob, Geometry size)
{
options.size = size;
read(blob);
}
///ditto
void read(void[] blob, Geometry size, size_t depth)
{
options.size = size;
options.depth = depth;
read(blob);
}
///ditto
void read(void[] blob, Geometry size, size_t depth, string magick)
{
options.size = size;
options.depth = depth;
options.magick = magick;
//Also set the filename to the image format
options.filename = magick ~":";
read(blob);
}
///ditto
void read(void[] blob, Geometry size, string magick)
{
options.size = size;
options.magick = magick;
//Also set the filename to the image format
options.filename = magick ~":";
read(blob);
}
/**
* Reads an image from an array of pixels.
*
* Params:
* width = The number of columns in the image.
* height = The number of rows in the image.
* map = A string describing the expected ordering
* of the pixel array. It can be any combination
* or order of R = red, G = green, B = blue, A = alpha
* , C = cyan, Y = yellow, M = magenta, K = black,
* or I = intensity (for grayscale).
* storage = The pixel Staroage type (CharPixel,
* ShortPixel, IntegerPixel, FloatPixel, or DoublePixel).
* pixels = The pixel data.
*/
void read(size_t width, size_t height, string map, StorageType storage, void[] pixels)
{
MagickCoreImage* image =
ConstituteImage(width, height, toStringz(map), storage, pixels.ptr, DMagickExcepionInfo());
imageRef = ImageRef(image);
}
///ditto
void readPixels(T)(size_t width, size_t height, string map, T[] pixels)
{
StorageType storage;
static if ( is( T == byte) )
{
storage = CharPixel;
}
else static if ( is( T == short) )
{
storage = ShortPixel;
}
else static if ( is( T == int) )
{
storage = IntegerPixel;
}
else static if ( is( T == long) )
{
storage = LongPixel;
}
else static if ( is( T == float) )
{
storage = FloatPixel;
}
else static if ( is( T == double) )
{
storage = DoublePixel;
}
else
{
assert(false, "Unsupported type");
}
read(width, height, map, storage, pixels);
}
//TODO: set process monitor.
/**
* Splice the background color into the image as defined by the geometry.
* This method is the opposite of chop.
*/
void splice(Geometry geometry)
{
RectangleInfo rectangle = geometry.rectangleInfo;
MagickCoreImage* image = SpliceImage(imageRef, &rectangle, DMagickExcepionInfo());
imageRef = ImageRef(image);
}
/**
* Creates a Binary Large OBject, a direct-to-memory
* version of the image.
*
* if an image format is selected which is capable of supporting
* fewer colors than the original image or quantization has been
* requested, the original image will be quantized to fewer colors.
* Use a copy of the original if this is a problem.
*
* Params:
* magick = specifies the image format to write.
* depth = specifies the image depth.
*/
void[] toBlob(string magick = null, size_t depth = 0)
{
size_t length;
AcquireMemoryHandler oldMalloc;
ResizeMemoryHandler oldRealloc;
DestroyMemoryHandler oldFree;
if ( magick !is null )
this.magick = magick;
if ( depth != 0 )
this.depth = depth;
//Use the D GC to accolate the blob.
GetMagickMemoryMethods(&oldMalloc, &oldRealloc, &oldFree);
SetMagickMemoryMethods(&GC.malloc, &GC.realloc, &GC.free);
scope(exit) SetMagickMemoryMethods(oldMalloc, oldRealloc, oldFree);
void* blob = ImageToBlob(options.imageInfo, imageRef, &length, DMagickExcepionInfo());
return blob[0 .. length];
}
/**
* Writes the image to the specified file. ImageMagick
* determines image format from the prefix or extension.
*
* if an image format is selected which is capable of supporting
* fewer colors than the original image or quantization has been
* requested, the original image will be quantized to fewer colors.
* Use a copy of the original if this is a problem.
*/
void write(string filename)
{
options.filename = filename;
WriteImage(options.imageInfo, imageRef);
DMagickException.throwException(&(imageRef.exception));
}
/**
* Set a flag to indicate whether or not to use alpha channel data.
*/
void alpha(AlphaChannelType type)
{
SetImageAlphaChannel(imageRef, type);
}
///ditto
bool alpha() const
{
return GetImageAlphaChannel(imageRef) != 0;
}
/**
* Number of ticks which must expire before displaying the
* next image in an animated sequence. The default number
* of ticks is 0. By default there are 100 ticks per second.
*/
void animationDelay(ushort delay)
{
imageRef.delay = delay;
}
///ditto
ushort annimationDelay() const
{
return cast(ushort)imageRef.delay;
}
/**
* Number of iterations to loop an animation.
*/
void animationIterations(size_t iterations)
{
imageRef.iterations = iterations;
}
///ditto
size_t animationIterations() const
{
return imageRef.iterations;
}
/**
* Set the image background color. The default is "white".
*/
void backgroundColor(string color)
{
backgroundColor = new Color(color);
}
///ditto
void backgroundColor(Color color)
{
options.backgroundColor(color);
imageRef.background_color = color.pixelPacket;
}
///ditto
Color backgroundColor() const
{
return options.backgroundColor;
}
/**
* Set the image border color. The default is "#dfdfdf".
*/
void borderColor(string color)
{
borderColor = new Color(color);
}
///ditto
void borderColor(Color color)
{
options.borderColor = color;
imageRef.border_color = color.pixelPacket;
}
///ditto
Color borderColor() const
{
return options.borderColor;
}
/**
* Return smallest bounding box enclosing non-border pixels.
* The current fuzz value is used when discriminating between pixels.
*/
Geometry boundingBox() const
{
RectangleInfo box = GetImageBoundingBox(imageRef, DMagickExcepionInfo());
return Geometry(box);
}
/**
* Pixel cache threshold in megabytes. Once this threshold is exceeded,
* all subsequent pixels cache operations are to/from disk.
* This is a static method and the attribute it sets is shared
* by all Image objects
*/
static void cacheThreshold(size_t threshold)
{
SetMagickResourceLimit(ResourceType.MemoryResource, threshold);
}
/**
* Channel modulus depth. The channel modulus depth represents
* the minimum number of bits required to support the channel without loss.
* Setting the channel's modulus depth modifies the channel (i.e. discards
* resolution) if the requested modulus depth is less than the current
* modulus depth, otherwise the channel is not altered. There is no
* attribute associated with the modulus depth so the current modulus
* depth is obtained by inspecting the pixels. As a result, the depth
* returned may be less than the most recently set channel depth.
* Subsequent image processing may result in increasing the channel depth.
*/
//TODO: Is this a property?
void channelDepth(ChannelType channel, size_t depth)
{
SetImageChannelDepth(imageRef, channel, depth);
}
///ditto
size_t channelDepth(ChannelType channel) const
{
size_t depth = GetImageChannelDepth(imageRef, channel, DMagickExcepionInfo());
return depth;
}
/**
* The red, green, blue, and white-point chromaticity values.
*/
void chromaticity(ChromaticityInfo chroma)
{
imageRef.chromaticity = chroma;
}
///ditto
ChromaticityInfo chromaticity() const
{
return imageRef.chromaticity;
}
/**
* The image's storage class. If DirectClass then the pixels
* contain valid RGB or CMYK colors. If PseudoClass then the
* image has a colormap referenced by the pixel's index member.
*/
void classType(ClassType type)
{
if ( imageRef.storage_class == ClassType.PseudoClass && type == ClassType.DirectClass )
{
SyncImage(imageRef);
colormap() = null;
}
else if ( imageRef.storage_class == ClassType.DirectClass && type == ClassType.PseudoClass )
{
options.quantizeColors = MaxColormapSize;
//TODO: implement quantize function.
//quantize();
assert(false);
}
imageRef.storage_class = type;
}
///ditto
ClassType classType() const
{
return imageRef.storage_class;
}
/**
* Associate a clip mask image with the current image.
* The clip mask image must have the same dimensions as the current
* image or an exception is thrown. Clipping occurs wherever pixels are
* transparent in the clip mask image. Clipping Pass an invalid image
* to unset an existing clip mask.
*/
void clipMask(const(Image) image)
{
if ( image is null )
{
SetImageClipMask(imageRef, null);
return;
}
//Throw a chatchable exception when the size differs.
if ( image.columns != columns || image.rows != rows )
throw new ImageException("image size differs");
SetImageClipMask(imageRef, image.imageRef);
}
///ditto
Image clipMask() const
{
MagickCoreImage* image = CloneImage(imageRef.clip_mask, 0, 0, true, DMagickExcepionInfo());
return new Image(image);
}
/**
* Access the image color map.
* Only ClassType.PsseudoClass images have a colormap.
* ----------------------------------
* Color color = image.colormap[2];
* image.colormap()[2] = color;
* ----------------------------------
* To asign the complete colormap at once:
* ----------------------------------
* Color[] colors = new Colors[255];
* image.colormap() = colors;
* //Or
* image.colormap.size = 255;
* foreach(i, color; colors)
* image.colormap()[i] = color;
* ----------------------------------
* Bugs: because of dmd bug 2152 the parentheses are needed when assigning;
*/
auto colormap()
{
struct Colormap
{
Image img;
this(Image img)
{
this.img = img;
}
Color opIndex(uint index)
{
if ( index >= img.colormapSize )
throw new Exception("Index out of bounds");
return new Color(img.imageRef.colormap[index]);
}
void opIndexAssign(Color value, size_t index)
{
if ( index >= img.colormapSize )
throw new Exception("Index out of bounds");
img.imageRef.colormap[index] = value.pixelPacket;
}
void opAssign(Color[] colors)
{
img.colormapSize = colors.length;
if ( colors.length == 0 )
return;
foreach(i, color; colors)
this[i] = color;
}
void opOpAssign(string op)(Color color) if ( op == "~" )
{
img.colormapSize = img.colormapSize + 1;
this[img.colormapSize] = color;
}
void opOpAssign(string op)(Color[] colors) if ( op == "~" )
{
uint oldSize = img.colormapSize;
img.colormapSize = oldSize + colors.length;
foreach ( i; oldSize..img.colormapSize)
this[i] = colors[i];
}
size_t size()
{
return img.colormapSize;
}
void size(size_t s)
{
img.colormapSize = s;
}
}
return Colormap(this);
}
/**
* The number of colors in the colormap. Only meaningful for PseudoClass images.
*
* Setting the colormap size may extend or truncate the colormap.
* The maximum number of supported entries is specified by the
* MaxColormapSize constant, and is dependent on the value of
* QuantumDepth when ImageMagick is compiled. An exception is thrown
* if more entries are requested than may be supported.
* Care should be taken when truncating the colormap to ensure that
* the image colormap indexes reference valid colormap entries.
*/
void colormapSize(size_t size)
{
if ( size > MaxColormapSize )
throw new OptionException(
"the size of the colormap can't exceed MaxColormapSize");
if ( size == 0 && imageRef.colors > 0 )
{
imageRef.colormap = cast(PixelPacket*)RelinquishMagickMemory( imageRef.colormap );
imageRef.colors = 0;
return;
}
if ( imageRef.colormap is null )
{
AcquireImageColormap(imageRef, size);
imageRef.colors = 0;
}
else
{
imageRef.colormap = cast(PixelPacket*)
ResizeMagickMemory(imageRef.colormap, size * PixelPacket.sizeof);
}
//Initialize the colors as black.
foreach ( i; imageRef.colors .. size )
{
imageRef.colormap[i].blue = 0;
imageRef.colormap[i].green = 0;
imageRef.colormap[i].red = 0;
imageRef.colormap[i].opacity = 0;
}
imageRef.colors = size;
}
///ditto
size_t colormapSize() const
{
return imageRef.colors;
}
/**
* The colorspace used to represent the image pixel colors.
* Image pixels are always stored as RGB(A) except for the case of CMY(K).
*/
void colorspace(ColorspaceType type)
{
TransformImageColorspace(imageRef, type);
options.colorspace = type;
}
///ditto
ColorspaceType colorspace() const
{
return imageRef.colorspace;
}
/**
* The width of the image in pixels.
*/
size_t columns() const
{
return imageRef.columns;
}
/**
* Composition operator to be used when composition is
* implicitly used (such as for image flattening).
*/
void compose(CompositeOperator op)
{
imageRef.compose = op;
}
///ditto
CompositeOperator compose() const
{
return imageRef.compose;
}
/**
* The image compression type. The default is the
* compression type of the specified image file.
*/
void compression(CompressionType type)
{
imageRef.compression = type;
options.compression = type;
}
///ditto
CompressionType compression() const
{
return imageRef.compression;
}
/**
* The vertical and horizontal resolution in pixels of the image.
* This option specifies an image density when decoding
* a Postscript or Portable Document page.
*
* The default is "72x72".
*/
void density(Geometry value)
{
options.density = value;
imageRef.x_resolution = value.width;
imageRef.y_resolution = ( value.width != 0 ) ? value.width : value.height;
}
///ditto
Geometry density() const
{
ssize_t width = cast(ssize_t)rndtol(imageRef.x_resolution);
ssize_t height = cast(ssize_t)rndtol(imageRef.y_resolution);
return Geometry(width, height);
}
/**
* Image depth. Used to specify the bit depth when reading or writing
* raw images or when the output format supports multiple depths.
* Defaults to the quantum depth that ImageMagick is compiled with.
*/
void depth(size_t value)
{
if ( value > MagickQuantumDepth)
value = MagickQuantumDepth;
imageRef.depth = value;
options.depth = value;
}
///ditto
size_t depth() const
{
return imageRef.depth;
}
/**
* Tile names from within an image montage.
* Only valid after calling montage or reading a MIFF file
* which contains a directory.
*/
string directory() const
{
return to!(string)(imageRef.directory);
}
/**
* Specify (or obtain) endian option for formats which support it.
*/
void endian(EndianType type)
{
imageRef.endian = type;
options.endian = type;
}
///ditto
EndianType endian() const
{
return imageRef.endian;
}
/**
* The EXIF profile.
*/
void exifProfile(void[] blob)
{
StringInfo* profile = AcquireStringInfo(blob.length);
SetStringInfoDatum(profile, cast(ubyte*)blob.ptr);
SetImageProfile(imageRef, "exif", profile);
DestroyStringInfo(profile);
}
///ditto
void[] exifProfile() const
{
const(StringInfo)* profile = GetImageProfile(imageRef, "exif");
if ( profile is null )
return null;
return GetStringInfoDatum(profile)[0 .. GetStringInfoLength(profile)].dup;
}
/**
* The image filename.
*/
void filename(string str)
{
copyString(imageRef.filename, str);
options.filename = str;
}
/**
* The image filesize in bytes.
*/
MagickSizeType fileSize() const
{
return GetBlobSize(imageRef);
}
/**
* Filter to use when resizing image. The reduction filter employed
* has a significant effect on the time required to resize an image
* and the resulting quality. The default filter is Lanczos which has
* been shown to produce high quality results when reducing most images.
*/
void filter(FilterTypes type)
{
imageRef.filter = type;
}
///ditto
FilterTypes filter() const
{
return imageRef.filter;
}
/**
* The image encoding format. For example, "GIF" or "PNG".
*/
string format() const
{
const(MagickInfo)* info = GetMagickInfo(imageRef.magick.ptr, DMagickExcepionInfo());
return to!(string)( info.description );
}
/**
* Colors within this distance are considered equal.
* A number of algorithms search for a target color.
* By default the color must be exact. Use this option to match
* colors that are close to the target color in RGB space.
*/
void fuzz(double f)
{
options.fuzz = f;
imageRef.fuzz = f;
}
///ditto
double fuzz() const
{
return options.fuzz;
}
/**
* GammaImage() gamma-corrects a particular image channel.
* The same image viewed on different devices will have perceptual
* differences in the way the image's intensities are represented
* on the screen. Specify individual gamma levels for the red,
* green, and blue channels, or adjust all three with the gamma
* parameter. Values typically range from 0.8 to 2.3.
*
* You can also reduce the influence of a particular channel
* with a gamma value of 0.
*/
void gamma(double value)
{
GammaImageChannel(imageRef,
( ChannelType.RedChannel | ChannelType.GreenChannel | ChannelType.BlueChannel ),
value);
}
///ditto
void gamma(double red, double green, double blue)
{
GammaImageChannel(imageRef, ChannelType.RedChannel, red);
GammaImageChannel(imageRef, ChannelType.GreenChannel, green);
GammaImageChannel(imageRef, ChannelType.BlueChannel, blue);
}
/**
* Gamma level of the image. The same color image displayed on
* two different workstations may look different due to differences
* in the display monitor. Use gamma correction to adjust for this
* color difference.
*/
double gamma() const
{
return imageRef.gamma;
}
/**
* Preferred size of the image when encoding.
*/
void geometry(string str)
{
copyString(imageRef.geometry, str);
}
///ditto
void geometry(Geometry value)
{
geometry(value.toString());
}
///ditto
Geometry geometry() const
{
return Geometry( to!(string)(imageRef.geometry) );
}
/**
* GIF disposal method. This attribute is used to control how
* successive images are rendered (how the preceding image
* is disposed of) when creating a GIF animation.
*/
void gifDisposeMethod(DisposeType type)
{
imageRef.dispose = type;
}
///ditto
DisposeType gifDisposeMethod() const
{
return imageRef.dispose;
}
/**
* ICC color profile.
*/
void iccColorProfile(void[] blob)
{
profile("icm", blob);
}
///ditto
void[] iccColorProfile() const
{
const(StringInfo)* profile = GetImageProfile(imageRef, "icm");
if ( profile is null )
return null;
return GetStringInfoDatum(profile)[0 .. GetStringInfoLength(profile)].dup;
}
/**
* Specify the _type of interlacing scheme for raw image formats
* such as RGB or YUV. NoInterlace means do not _interlace,
* LineInterlace uses scanline interlacing, and PlaneInterlace
* uses plane interlacing. PartitionInterlace is like PlaneInterlace
* except the different planes are saved to individual files
* (e.g. image.R, image.G, and image.B). Use LineInterlace or
* PlaneInterlace to create an interlaced GIF or
* progressive JPEG image. The default is NoInterlace.
*/
void interlace(InterlaceType type)
{
imageRef.interlace = type;
options.interlace = type;
}
///ditto
InterlaceType interlace() const
{
return imageRef.interlace;
}
/**
* The International Press Telecommunications Council profile.
*/
void iptcProfile(void[] blob)
{
profile("iptc", blob);
}
///ditto
void[] iptcProfile() const
{
const(StringInfo)* profile = GetImageProfile(imageRef, "iptc");
if ( profile is null )
return null;
return GetStringInfoDatum(profile)[0 .. GetStringInfoLength(profile)].dup;
}
/**
* Image format (e.g. "GIF")
*/
void magick(string str)
{
copyString(imageRef.magick, str);
options.magick = str;
}
///ditto
string magick() const
{
if ( imageRef.magick !is null )
return imageRef.magick[0 .. strlen(imageRef.magick.ptr)].idup;
return options.magick;
}
/**
* Set the image transparent color. The default is "#bdbdbd".
*/
void matteColor(string color)
{
matteColor = new Color(color);
}
///ditto
void matteColor(Color color)
{
imageRef.matte_color = color.pixelPacket;
options.matteColor = color;
}
///ditto
Color matteColor() const
{
return new Color(imageRef.matte_color);
}
/**
* The mean error per pixel computed when an image is color reduced.
* This parameter is only valid if verbose is set to true and the
* image has just been quantized.
*/
double meanErrorPerPixel() const
{
return imageRef.error.mean_error_per_pixel;
}
/**
* Image modulus depth (minimum number of bits required to
* support red/green/blue components without loss of accuracy).
* The pixel modulus depth may be decreased by supplying a value
* which is less than the current value, updating the pixels
* (reducing accuracy) to the new depth. The pixel modulus depth
* can not be increased over the current value using this method.
*/
void modulusDepth(size_t depth)
{
SetImageDepth(imageRef, depth);
options.depth = depth;
}
///ditto
size_t modulusDepth() const
{
size_t depth = GetImageDepth(imageRef, DMagickExcepionInfo());
return depth;
}
/**
* Tile size and offset within an image montage.
* Only valid for images produced by montage.
*/
Geometry montageGeometry() const
{
return Geometry( to!(string)(imageRef.geometry) );
}
/**
* The normalized max error per pixel computed when
* an image is color reduced. This parameter is only
* valid if verbose is set to true and the image
* has just been quantized.
*/
double normalizedMaxError() const
{
return imageRef.error.normalized_maximum_error;
}
/**
* The normalized mean error per pixel computed when
* an image is color reduced. This parameter is only
* valid if verbose is set to true and the image
* has just been quantized.
*/
double normalizedMeanError() const
{
return imageRef.error.normalized_mean_error;
}
/**
* Image orientation. Supported by some file formats
* such as DPX and TIFF. Useful for turning the right way up.
*/
void orientation(OrientationType orientation)
{
imageRef.orientation = orientation;
}
///ditto
OrientationType orientation() const
{
return imageRef.orientation;
}
/**
* When compositing, this attribute describes the position
* of this image with respect to the underlying image.
*
* Use this option to specify the dimensions and position of
* the Postscript page in dots per inch or a TEXT page in pixels.
* This option is typically used in concert with density.
*
* Page may also be used to position a GIF image
* (such as for a scene in an animation).
*/
void page(Geometry geometry)
{
options.page = geometry;
imageRef.page = geometry.rectangleInfo;
}
///ditto
Geometry page() const
{
return Geometry(imageRef.page);
}
/**
* The pixel color interpolation method. Some methods (such
* as wave, swirl, implode, and composite) use the pixel color
* interpolation method to determine how to blend adjacent pixels.
*/
void pixelInterpolationMethod(InterpolatePixelMethod method)
{
imageRef.interpolate = method;
}
///ditto
InterpolatePixelMethod pixelInterpolationMethod() const
{
return imageRef.interpolate;
}
/**
* Get/set/remove a named profile. Valid names include "*",
* "8BIM", "ICM", "IPTC", or a user/format-defined profile name.
*/
void profile(string name, void[] blob)
{
ProfileImage(imageRef, toStringz(name), blob.ptr, blob.length, false);
}
///ditto
void[] profile(string name) const
{
const(StringInfo)* profile = GetImageProfile(imageRef, toStringz(name));
if ( profile is null )
return null;
return GetStringInfoDatum(profile)[0 .. GetStringInfoLength(profile)].dup;
}
/**
* JPEG/MIFF/PNG compression level (default 75).
*/
void quality(size_t )
{
imageRef.quality = quality;
options.quality = quality;
}
///ditto
size_t quality() const
{
return imageRef.quality;
}
/**
* The type of rendering intent.
* See_Also:
* $(LINK http://www.cambridgeincolour.com/tutorials/color-space-conversion.htm)
*/
void renderingIntent(RenderingIntent intent)
{
imageRef.rendering_intent = intent;
}
///ditto
RenderingIntent renderingIntent() const
{
return imageRef.rendering_intent;
}
/**
* Units of image resolution
*/
void resolutionUnits(ResolutionType type)
{
imageRef.units = type;
options.resolutionUnits = type;
}
///ditto
ResolutionType resolutionUnits() const
{
return options.resolutionUnits;
}
/**
* The scene number assigned to the image the last
* time the image was written to a multi-image image file.
*/
void scene(size_t value)
{
imageRef.scene = value;
}
///ditto
size_t scene() const
{
return imageRef.scene;
}
/**
* The height of the image in pixels.
*/
size_t rows() const
{
return imageRef.rows;
}
/**
* Width and height of a image.
*/
Geometry size() const
{
return Geometry(imageRef.columns, imageRef.rows);
}
//TODO: Statistics ?
/**
* Number of colors in the image.
*/
size_t totalColors() const
{
size_t colors = GetNumberColors(imageRef, null, DMagickExcepionInfo());
return colors;
}
/**
* Image type.
*/
void type(ImageType imageType)
{
options.type = imageType;
SetImageType(imageRef, imageType);
}
///ditto
ImageType type() const
{
if (options.type != ImageType.UndefinedType )
return options.type;
ImageType imageType = GetImageType(imageRef, DMagickExcepionInfo());
return imageType;
}
/**
* Specify how "virtual pixels" behave. Virtual pixels are
* pixels that are outside the boundaries of the image.
* Methods such as blurImage, sharpen, and wave use virtual pixels.
*/
void virtualPixelMethod(VirtualPixelMethod method)
{
options.virtualPixelMethod = method;
SetImageVirtualPixelMethod(imageRef, method);
}
///ditto
VirtualPixelMethod virtualPixelMethod() const
{
return GetImageVirtualPixelMethod(imageRef);
}
/**
* Horizontal resolution of the image.
*/
double xResolution() const
{
return imageRef.x_resolution;
}
/**
* Vertical resolution of the image.
*/
double yResolution() const
{
return imageRef.y_resolution;
}
//Image properties - set via SetImageProterties
//Should we implement these as actual properties?
//attribute
//comment
//label
//signature
//Other unimplemented porperties
//pixelColor
}
|