File size: 40,719 Bytes
c1f1d32 |
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 |
# imagecodecs/numcodecs.py
# Copyright (c) 2021-2022, Christoph Gohlke
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
"""Additional numcodecs implemented using imagecodecs."""
__version__ = '2022.9.26'
__all__ = ('register_codecs',)
import numpy
from numcodecs.abc import Codec
from numcodecs.registry import register_codec, get_codec
import imagecodecs
def protective_squeeze(x: numpy.ndarray):
"""
Squeeze dim only if it's not the last dim.
Image dim expected to be *, H, W, C
"""
img_shape = x.shape[-3:]
if len(x.shape) > 3:
n_imgs = numpy.prod(x.shape[:-3])
if n_imgs > 1:
img_shape = (-1,) + img_shape
return x.reshape(img_shape)
def get_default_image_compressor(**kwargs):
if imagecodecs.JPEGXL:
# has JPEGXL
this_kwargs = {
'effort': 3,
'distance': 0.3,
# bug in libjxl, invalid codestream for non-lossless
# when decoding speed > 1
'decodingspeed': 1
}
this_kwargs.update(kwargs)
return JpegXl(**this_kwargs)
else:
this_kwargs = {
'level': 50
}
this_kwargs.update(kwargs)
return Jpeg2k(**this_kwargs)
class Aec(Codec):
"""AEC codec for numcodecs."""
codec_id = 'imagecodecs_aec'
def __init__(
self, bitspersample=None, flags=None, blocksize=None, rsi=None
):
self.bitspersample = bitspersample
self.flags = flags
self.blocksize = blocksize
self.rsi = rsi
def encode(self, buf):
return imagecodecs.aec_encode(
buf,
bitspersample=self.bitspersample,
flags=self.flags,
blocksize=self.blocksize,
rsi=self.rsi,
)
def decode(self, buf, out=None):
return imagecodecs.aec_decode(
buf,
bitspersample=self.bitspersample,
flags=self.flags,
blocksize=self.blocksize,
rsi=self.rsi,
out=_flat(out),
)
class Apng(Codec):
"""APNG codec for numcodecs."""
codec_id = 'imagecodecs_apng'
def __init__(self, level=None, photometric=None, delay=None):
self.level = level
self.photometric = photometric
self.delay = delay
def encode(self, buf):
buf = protective_squeeze(numpy.asarray(buf))
return imagecodecs.apng_encode(
buf,
level=self.level,
photometric=self.photometric,
delay=self.delay,
)
def decode(self, buf, out=None):
return imagecodecs.apng_decode(buf, out=out)
class Avif(Codec):
"""AVIF codec for numcodecs."""
codec_id = 'imagecodecs_avif'
def __init__(
self,
level=None,
speed=None,
tilelog2=None,
bitspersample=None,
pixelformat=None,
numthreads=None,
index=None,
):
self.level = level
self.speed = speed
self.tilelog2 = tilelog2
self.bitspersample = bitspersample
self.pixelformat = pixelformat
self.numthreads = numthreads
self.index = index
def encode(self, buf):
buf = protective_squeeze(numpy.asarray(buf))
return imagecodecs.avif_encode(
buf,
level=self.level,
speed=self.speed,
tilelog2=self.tilelog2,
bitspersample=self.bitspersample,
pixelformat=self.pixelformat,
numthreads=self.numthreads,
)
def decode(self, buf, out=None):
return imagecodecs.avif_decode(
buf, index=self.index, numthreads=self.numthreads, out=out
)
class Bitorder(Codec):
"""Bitorder codec for numcodecs."""
codec_id = 'imagecodecs_bitorder'
def encode(self, buf):
return imagecodecs.bitorder_encode(buf)
def decode(self, buf, out=None):
return imagecodecs.bitorder_decode(buf, out=_flat(out))
class Bitshuffle(Codec):
"""Bitshuffle codec for numcodecs."""
codec_id = 'imagecodecs_bitshuffle'
def __init__(self, itemsize=1, blocksize=0):
self.itemsize = itemsize
self.blocksize = blocksize
def encode(self, buf):
return imagecodecs.bitshuffle_encode(
buf, itemsize=self.itemsize, blocksize=self.blocksize
).tobytes()
def decode(self, buf, out=None):
return imagecodecs.bitshuffle_decode(
buf,
itemsize=self.itemsize,
blocksize=self.blocksize,
out=_flat(out),
)
class Blosc(Codec):
"""Blosc codec for numcodecs."""
codec_id = 'imagecodecs_blosc'
def __init__(
self,
level=None,
compressor=None,
typesize=None,
blocksize=None,
shuffle=None,
numthreads=None,
):
self.level = level
self.compressor = compressor
self.typesize = typesize
self.blocksize = blocksize
self.shuffle = shuffle
self.numthreads = numthreads
def encode(self, buf):
buf = protective_squeeze(numpy.asarray(buf))
return imagecodecs.blosc_encode(
buf,
level=self.level,
compressor=self.compressor,
typesize=self.typesize,
blocksize=self.blocksize,
shuffle=self.shuffle,
numthreads=self.numthreads,
)
def decode(self, buf, out=None):
return imagecodecs.blosc_decode(
buf, numthreads=self.numthreads, out=_flat(out)
)
class Blosc2(Codec):
"""Blosc2 codec for numcodecs."""
codec_id = 'imagecodecs_blosc2'
def __init__(
self,
level=None,
compressor=None,
typesize=None,
blocksize=None,
shuffle=None,
numthreads=None,
):
self.level = level
self.compressor = compressor
self.typesize = typesize
self.blocksize = blocksize
self.shuffle = shuffle
self.numthreads = numthreads
def encode(self, buf):
buf = protective_squeeze(numpy.asarray(buf))
return imagecodecs.blosc2_encode(
buf,
level=self.level,
compressor=self.compressor,
typesize=self.typesize,
blocksize=self.blocksize,
shuffle=self.shuffle,
numthreads=self.numthreads,
)
def decode(self, buf, out=None):
return imagecodecs.blosc2_decode(
buf, numthreads=self.numthreads, out=_flat(out)
)
class Brotli(Codec):
"""Brotli codec for numcodecs."""
codec_id = 'imagecodecs_brotli'
def __init__(self, level=None, mode=None, lgwin=None):
self.level = level
self.mode = mode
self.lgwin = lgwin
def encode(self, buf):
return imagecodecs.brotli_encode(
buf, level=self.level, mode=self.mode, lgwin=self.lgwin
)
def decode(self, buf, out=None):
return imagecodecs.brotli_decode(buf, out=_flat(out))
class ByteShuffle(Codec):
"""ByteShuffle codec for numcodecs."""
codec_id = 'imagecodecs_byteshuffle'
def __init__(
self, shape, dtype, axis=-1, dist=1, delta=False, reorder=False
):
self.shape = tuple(shape)
self.dtype = numpy.dtype(dtype).str
self.axis = axis
self.dist = dist
self.delta = bool(delta)
self.reorder = bool(reorder)
def encode(self, buf):
buf = protective_squeeze(numpy.asarray(buf))
assert buf.shape == self.shape
assert buf.dtype == self.dtype
return imagecodecs.byteshuffle_encode(
buf,
axis=self.axis,
dist=self.dist,
delta=self.delta,
reorder=self.reorder,
).tobytes()
def decode(self, buf, out=None):
if not isinstance(buf, numpy.ndarray):
buf = numpy.frombuffer(buf, dtype=self.dtype).reshape(*self.shape)
return imagecodecs.byteshuffle_decode(
buf,
axis=self.axis,
dist=self.dist,
delta=self.delta,
reorder=self.reorder,
out=out,
)
class Bz2(Codec):
"""Bz2 codec for numcodecs."""
codec_id = 'imagecodecs_bz2'
def __init__(self, level=None):
self.level = level
def encode(self, buf):
return imagecodecs.bz2_encode(buf, level=self.level)
def decode(self, buf, out=None):
return imagecodecs.bz2_decode(buf, out=_flat(out))
class Cms(Codec):
"""CMS codec for numcodecs."""
codec_id = 'imagecodecs_cms'
def __init__(self, *args, **kwargs):
pass
def encode(self, buf, out=None):
# return imagecodecs.cms_transform(buf)
raise NotImplementedError
def decode(self, buf, out=None):
# return imagecodecs.cms_transform(buf)
raise NotImplementedError
class Deflate(Codec):
"""Deflate codec for numcodecs."""
codec_id = 'imagecodecs_deflate'
def __init__(self, level=None, raw=False):
self.level = level
self.raw = bool(raw)
def encode(self, buf):
return imagecodecs.deflate_encode(buf, level=self.level, raw=self.raw)
def decode(self, buf, out=None):
return imagecodecs.deflate_decode(buf, out=_flat(out), raw=self.raw)
class Delta(Codec):
"""Delta codec for numcodecs."""
codec_id = 'imagecodecs_delta'
def __init__(self, shape=None, dtype=None, axis=-1, dist=1):
self.shape = None if shape is None else tuple(shape)
self.dtype = None if dtype is None else numpy.dtype(dtype).str
self.axis = axis
self.dist = dist
def encode(self, buf):
if self.shape is not None or self.dtype is not None:
buf = protective_squeeze(numpy.asarray(buf))
assert buf.shape == self.shape
assert buf.dtype == self.dtype
return imagecodecs.delta_encode(
buf, axis=self.axis, dist=self.dist
).tobytes()
def decode(self, buf, out=None):
if self.shape is not None or self.dtype is not None:
buf = numpy.frombuffer(buf, dtype=self.dtype).reshape(*self.shape)
return imagecodecs.delta_decode(
buf, axis=self.axis, dist=self.dist, out=out
)
class Float24(Codec):
"""Float24 codec for numcodecs."""
codec_id = 'imagecodecs_float24'
def __init__(self, byteorder=None, rounding=None):
self.byteorder = byteorder
self.rounding = rounding
def encode(self, buf):
buf = protective_squeeze(numpy.asarray(buf))
return imagecodecs.float24_encode(
buf, byteorder=self.byteorder, rounding=self.rounding
)
def decode(self, buf, out=None):
return imagecodecs.float24_decode(
buf, byteorder=self.byteorder, out=out
)
class FloatPred(Codec):
"""Floating Point Predictor codec for numcodecs."""
codec_id = 'imagecodecs_floatpred'
def __init__(self, shape, dtype, axis=-1, dist=1):
self.shape = tuple(shape)
self.dtype = numpy.dtype(dtype).str
self.axis = axis
self.dist = dist
def encode(self, buf):
buf = protective_squeeze(numpy.asarray(buf))
assert buf.shape == self.shape
assert buf.dtype == self.dtype
return imagecodecs.floatpred_encode(
buf, axis=self.axis, dist=self.dist
).tobytes()
def decode(self, buf, out=None):
if not isinstance(buf, numpy.ndarray):
buf = numpy.frombuffer(buf, dtype=self.dtype).reshape(*self.shape)
return imagecodecs.floatpred_decode(
buf, axis=self.axis, dist=self.dist, out=out
)
class Gif(Codec):
"""GIF codec for numcodecs."""
codec_id = 'imagecodecs_gif'
def encode(self, buf):
buf = protective_squeeze(numpy.asarray(buf))
return imagecodecs.gif_encode(buf)
def decode(self, buf, out=None):
return imagecodecs.gif_decode(buf, asrgb=False, out=out)
class Heif(Codec):
"""HEIF codec for numcodecs."""
codec_id = 'imagecodecs_heif'
def __init__(
self,
level=None,
bitspersample=None,
photometric=None,
compression=None,
numthreads=None,
index=None,
):
self.level = level
self.bitspersample = bitspersample
self.photometric = photometric
self.compression = compression
self.numthreads = numthreads
self.index = index
def encode(self, buf):
buf = protective_squeeze(numpy.asarray(buf))
return imagecodecs.heif_encode(
buf,
level=self.level,
bitspersample=self.bitspersample,
photometric=self.photometric,
compression=self.compression,
numthreads=self.numthreads,
)
def decode(self, buf, out=None):
return imagecodecs.heif_decode(
buf,
index=self.index,
photometric=self.photometric,
numthreads=self.numthreads,
out=out,
)
class Jetraw(Codec):
"""Jetraw codec for numcodecs."""
codec_id = 'imagecodecs_jetraw'
def __init__(
self,
shape,
identifier,
parameters=None,
verbosity=None,
errorbound=None,
):
self.shape = shape
self.identifier = identifier
self.errorbound = errorbound
imagecodecs.jetraw_init(parameters, verbosity)
def encode(self, buf):
return imagecodecs.jetraw_encode(
buf, identifier=self.identifier, errorbound=self.errorbound
)
def decode(self, buf, out=None):
if out is None:
out = numpy.empty(self.shape, numpy.uint16)
return imagecodecs.jetraw_decode(buf, out=out)
class Jpeg(Codec):
"""JPEG codec for numcodecs."""
codec_id = 'imagecodecs_jpeg'
def __init__(
self,
bitspersample=None,
tables=None,
header=None,
colorspace_data=None,
colorspace_jpeg=None,
level=None,
subsampling=None,
optimize=None,
smoothing=None,
):
self.tables = tables
self.header = header
self.bitspersample = bitspersample
self.colorspace_data = colorspace_data
self.colorspace_jpeg = colorspace_jpeg
self.level = level
self.subsampling = subsampling
self.optimize = optimize
self.smoothing = smoothing
def encode(self, buf):
buf = protective_squeeze(numpy.asarray(buf))
return imagecodecs.jpeg_encode(
buf,
level=self.level,
colorspace=self.colorspace_data,
outcolorspace=self.colorspace_jpeg,
subsampling=self.subsampling,
optimize=self.optimize,
smoothing=self.smoothing,
)
def decode(self, buf, out=None):
out_shape = None
if out is not None:
out_shape = out.shape
out = protective_squeeze(out)
img = imagecodecs.jpeg_decode(
buf,
bitspersample=self.bitspersample,
tables=self.tables,
header=self.header,
colorspace=self.colorspace_jpeg,
outcolorspace=self.colorspace_data,
out=out,
)
if out_shape is not None:
img = img.reshape(out_shape)
return img
def get_config(self):
"""Return dictionary holding configuration parameters."""
config = dict(id=self.codec_id)
for key in self.__dict__:
if not key.startswith('_'):
value = getattr(self, key)
if value is not None and key in ('header', 'tables'):
import base64
value = base64.b64encode(value).decode()
config[key] = value
return config
@classmethod
def from_config(cls, config):
"""Instantiate codec from configuration object."""
for key in ('header', 'tables'):
value = config.get(key, None)
if value is not None and isinstance(value, str):
import base64
config[key] = base64.b64decode(value.encode())
return cls(**config)
class Jpeg2k(Codec):
"""JPEG 2000 codec for numcodecs."""
codec_id = 'imagecodecs_jpeg2k'
def __init__(
self,
level=None,
codecformat=None,
colorspace=None,
tile=None,
reversible=None,
bitspersample=None,
resolutions=None,
numthreads=None,
verbose=0,
):
self.level = level
self.codecformat = codecformat
self.colorspace = colorspace
self.tile = None if tile is None else tuple(tile)
self.reversible = reversible
self.bitspersample = bitspersample
self.resolutions = resolutions
self.numthreads = numthreads
self.verbose = verbose
def encode(self, buf):
buf = protective_squeeze(numpy.asarray(buf))
return imagecodecs.jpeg2k_encode(
buf,
level=self.level,
codecformat=self.codecformat,
colorspace=self.colorspace,
tile=self.tile,
reversible=self.reversible,
bitspersample=self.bitspersample,
resolutions=self.resolutions,
numthreads=self.numthreads,
verbose=self.verbose,
)
def decode(self, buf, out=None):
return imagecodecs.jpeg2k_decode(
buf, verbose=self.verbose, numthreads=self.numthreads, out=out
)
class JpegLs(Codec):
"""JPEG LS codec for numcodecs."""
codec_id = 'imagecodecs_jpegls'
def __init__(self, level=None):
self.level = level
def encode(self, buf):
buf = protective_squeeze(numpy.asarray(buf))
return imagecodecs.jpegls_encode(buf, level=self.level)
def decode(self, buf, out=None):
return imagecodecs.jpegls_decode(buf, out=out)
class JpegXl(Codec):
"""JPEG XL codec for numcodecs."""
codec_id = 'imagecodecs_jpegxl'
def __init__(
self,
# encode
level=None,
effort=None,
distance=None,
lossless=None,
decodingspeed=None,
photometric=None,
planar=None,
usecontainer=None,
# decode
index=None,
keeporientation=None,
# both
numthreads=None,
):
"""
Return JPEG XL image from numpy array.
Float must be in nominal range 0..1.
Currently L, LA, RGB, RGBA images are supported in contig mode.
Extra channels are only supported for grayscale images in planar mode.
Parameters
----------
level : Default to None, i.e. not overwriting lossess and decodingspeed options.
When < 0: Use lossless compression
When in [0,1,2,3,4]: Sets the decoding speed tier for the provided options.
Minimum is 0 (slowest to decode, best quality/density), and maximum
is 4 (fastest to decode, at the cost of some quality/density).
effort : Default to 3.
Sets encoder effort/speed level without affecting decoding speed.
Valid values are, from faster to slower speed: 1:lightning 2:thunder
3:falcon 4:cheetah 5:hare 6:wombat 7:squirrel 8:kitten 9:tortoise.
Speed: lightning, thunder, falcon, cheetah, hare, wombat, squirrel, kitten, tortoise
control the encoder effort in ascending order.
This also affects memory usage: using lower effort will typically reduce memory
consumption during encoding.
lightning and thunder are fast modes useful for lossless mode (modular).
falcon disables all of the following tools.
cheetah enables coefficient reordering, context clustering, and heuristics for selecting DCT sizes and quantization steps.
hare enables Gaborish filtering, chroma from luma, and an initial estimate of quantization steps.
wombat enables error diffusion quantization and full DCT size selection heuristics.
squirrel (default) enables dots, patches, and spline detection, and full context clustering.
kitten optimizes the adaptive quantization for a psychovisual metric.
tortoise enables a more thorough adaptive quantization search.
distance : Default to 1.0
Sets the distance level for lossy compression: target max butteraugli distance,
lower = higher quality. Range: 0 .. 15. 0.0 = mathematically lossless
(however, use JxlEncoderSetFrameLossless instead to use true lossless,
as setting distance to 0 alone is not the only requirement).
1.0 = visually lossless. Recommended range: 0.5 .. 3.0.
lossess : Default to False.
Use lossess encoding.
decodingspeed : Default to 0.
Duplicate to level. [0,4]
photometric : Return JxlColorSpace value.
Default logic is quite complicated but works most of the time.
Accepted value:
int: [-1,3]
str: ['RGB',
'WHITEISZERO', 'MINISWHITE',
'BLACKISZERO', 'MINISBLACK', 'GRAY',
'XYB', 'KNOWN']
planar : Enable multi-channel mode.
Default to false.
usecontainer :
Forces the encoder to use the box-based container format (BMFF)
even when not necessary.
When using JxlEncoderUseBoxes, JxlEncoderStoreJPEGMetadata or
JxlEncoderSetCodestreamLevel with level 10, the encoder will
automatically also use the container format, it is not necessary
to use JxlEncoderUseContainer for those use cases.
By default this setting is disabled.
index : Selectively decode frames for animation.
Default to 0, decode all frames.
When set to > 0, decode that frame index only.
keeporientation :
Enables or disables preserving of as-in-bitstream pixeldata orientation.
Some images are encoded with an Orientation tag indicating that the
decoder must perform a rotation and/or mirroring to the encoded image data.
If skip_reorientation is JXL_FALSE (the default): the decoder will apply
the transformation from the orientation setting, hence rendering the image
according to its specified intent. When producing a JxlBasicInfo, the decoder
will always set the orientation field to JXL_ORIENT_IDENTITY (matching the
returned pixel data) and also align xsize and ysize so that they correspond
to the width and the height of the returned pixel data.
If skip_reorientation is JXL_TRUE: the decoder will skip applying the
transformation from the orientation setting, returning the image in
the as-in-bitstream pixeldata orientation. This may be faster to decode
since the decoder doesnt have to apply the transformation, but can
cause wrong display of the image if the orientation tag is not correctly
taken into account by the user.
By default, this option is disabled, and the returned pixel data is
re-oriented according to the images Orientation setting.
threads : Default to 1.
If <= 0, use all cores.
If > 32, clipped to 32.
"""
self.level = level
self.effort = effort
self.distance = distance
self.lossless = bool(lossless)
self.decodingspeed = decodingspeed
self.photometric = photometric
self.planar = planar
self.usecontainer = usecontainer
self.index = index
self.keeporientation = keeporientation
self.numthreads = numthreads
def encode(self, buf):
# TODO: only squeeze all but last dim
buf = protective_squeeze(numpy.asarray(buf))
return imagecodecs.jpegxl_encode(
buf,
level=self.level,
effort=self.effort,
distance=self.distance,
lossless=self.lossless,
decodingspeed=self.decodingspeed,
photometric=self.photometric,
planar=self.planar,
usecontainer=self.usecontainer,
numthreads=self.numthreads,
)
def decode(self, buf, out=None):
return imagecodecs.jpegxl_decode(
buf,
index=self.index,
keeporientation=self.keeporientation,
numthreads=self.numthreads,
out=out,
)
class JpegXr(Codec):
"""JPEG XR codec for numcodecs."""
codec_id = 'imagecodecs_jpegxr'
def __init__(
self,
level=None,
photometric=None,
hasalpha=None,
resolution=None,
fp2int=None,
):
self.level = level
self.photometric = photometric
self.hasalpha = hasalpha
self.resolution = resolution
self.fp2int = fp2int
def encode(self, buf):
buf = protective_squeeze(numpy.asarray(buf))
return imagecodecs.jpegxr_encode(
buf,
level=self.level,
photometric=self.photometric,
hasalpha=self.hasalpha,
resolution=self.resolution,
)
def decode(self, buf, out=None):
return imagecodecs.jpegxr_decode(buf, fp2int=self.fp2int, out=out)
class Lerc(Codec):
"""LERC codec for numcodecs."""
codec_id = 'imagecodecs_lerc'
def __init__(self, level=None, version=None, planar=None):
self.level = level
self.version = version
self.planar = bool(planar)
# TODO: support mask?
# self.mask = None
def encode(self, buf):
buf = protective_squeeze(numpy.asarray(buf))
return imagecodecs.lerc_encode(
buf,
level=self.level,
version=self.version,
planar=self.planar,
)
def decode(self, buf, out=None):
return imagecodecs.lerc_decode(buf, out=out)
class Ljpeg(Codec):
"""LJPEG codec for numcodecs."""
codec_id = 'imagecodecs_ljpeg'
def __init__(self, bitspersample=None):
self.bitspersample = bitspersample
def encode(self, buf):
buf = protective_squeeze(numpy.asarray(buf))
return imagecodecs.ljpeg_encode(buf, bitspersample=self.bitspersample)
def decode(self, buf, out=None):
return imagecodecs.ljpeg_decode(buf, out=out)
class Lz4(Codec):
"""LZ4 codec for numcodecs."""
codec_id = 'imagecodecs_lz4'
def __init__(self, level=None, hc=False, header=True):
self.level = level
self.hc = hc
self.header = bool(header)
def encode(self, buf):
return imagecodecs.lz4_encode(
buf, level=self.level, hc=self.hc, header=self.header
)
def decode(self, buf, out=None):
return imagecodecs.lz4_decode(buf, header=self.header, out=_flat(out))
class Lz4f(Codec):
"""LZ4F codec for numcodecs."""
codec_id = 'imagecodecs_lz4f'
def __init__(
self,
level=None,
blocksizeid=False,
contentchecksum=None,
blockchecksum=None,
):
self.level = level
self.blocksizeid = blocksizeid
self.contentchecksum = contentchecksum
self.blockchecksum = blockchecksum
def encode(self, buf):
return imagecodecs.lz4f_encode(
buf,
level=self.level,
blocksizeid=self.blocksizeid,
contentchecksum=self.contentchecksum,
blockchecksum=self.blockchecksum,
)
def decode(self, buf, out=None):
return imagecodecs.lz4f_decode(buf, out=_flat(out))
class Lzf(Codec):
"""LZF codec for numcodecs."""
codec_id = 'imagecodecs_lzf'
def __init__(self, header=True):
self.header = bool(header)
def encode(self, buf):
return imagecodecs.lzf_encode(buf, header=self.header)
def decode(self, buf, out=None):
return imagecodecs.lzf_decode(buf, header=self.header, out=_flat(out))
class Lzma(Codec):
"""LZMA codec for numcodecs."""
codec_id = 'imagecodecs_lzma'
def __init__(self, level=None):
self.level = level
def encode(self, buf):
return imagecodecs.lzma_encode(buf, level=self.level)
def decode(self, buf, out=None):
return imagecodecs.lzma_decode(buf, out=_flat(out))
class Lzw(Codec):
"""LZW codec for numcodecs."""
codec_id = 'imagecodecs_lzw'
def encode(self, buf):
return imagecodecs.lzw_encode(buf)
def decode(self, buf, out=None):
return imagecodecs.lzw_decode(buf, out=_flat(out))
class PackBits(Codec):
"""PackBits codec for numcodecs."""
codec_id = 'imagecodecs_packbits'
def __init__(self, axis=None):
self.axis = axis
def encode(self, buf):
if not isinstance(buf, (bytes, bytearray)):
buf = protective_squeeze(numpy.asarray(buf))
return imagecodecs.packbits_encode(buf, axis=self.axis)
def decode(self, buf, out=None):
return imagecodecs.packbits_decode(buf, out=_flat(out))
class Pglz(Codec):
"""PGLZ codec for numcodecs."""
codec_id = 'imagecodecs_pglz'
def __init__(self, header=True, strategy=None):
self.header = bool(header)
self.strategy = strategy
def encode(self, buf):
return imagecodecs.pglz_encode(
buf, strategy=self.strategy, header=self.header
)
def decode(self, buf, out=None):
return imagecodecs.pglz_decode(buf, header=self.header, out=_flat(out))
class Png(Codec):
"""PNG codec for numcodecs."""
codec_id = 'imagecodecs_png'
def __init__(self, level=None):
self.level = level
def encode(self, buf):
buf = protective_squeeze(numpy.asarray(buf))
return imagecodecs.png_encode(buf, level=self.level)
def decode(self, buf, out=None):
return imagecodecs.png_decode(buf, out=out)
class Qoi(Codec):
"""QOI codec for numcodecs."""
codec_id = 'imagecodecs_qoi'
def __init__(self):
pass
def encode(self, buf):
buf = protective_squeeze(numpy.asarray(buf))
return imagecodecs.qoi_encode(buf)
def decode(self, buf, out=None):
return imagecodecs.qoi_decode(buf, out=out)
class Rgbe(Codec):
"""RGBE codec for numcodecs."""
codec_id = 'imagecodecs_rgbe'
def __init__(self, header=False, shape=None, rle=None):
if not header and shape is None:
raise ValueError('must specify data shape if no header')
if shape and shape[-1] != 3:
raise ValueError('invalid shape')
self.shape = shape
self.header = bool(header)
self.rle = None if rle is None else bool(rle)
def encode(self, buf):
buf = protective_squeeze(numpy.asarray(buf))
return imagecodecs.rgbe_encode(buf, header=self.header, rle=self.rle)
def decode(self, buf, out=None):
if out is None and not self.header:
out = numpy.empty(self.shape, numpy.float32)
return imagecodecs.rgbe_decode(
buf, header=self.header, rle=self.rle, out=out
)
class Rcomp(Codec):
"""Rcomp codec for numcodecs."""
codec_id = 'imagecodecs_rcomp'
def __init__(self, shape, dtype, nblock=None):
self.shape = tuple(shape)
self.dtype = numpy.dtype(dtype).str
self.nblock = nblock
def encode(self, buf):
return imagecodecs.rcomp_encode(buf, nblock=self.nblock)
def decode(self, buf, out=None):
return imagecodecs.rcomp_decode(
buf,
shape=self.shape,
dtype=self.dtype,
nblock=self.nblock,
out=out,
)
class Snappy(Codec):
"""Snappy codec for numcodecs."""
codec_id = 'imagecodecs_snappy'
def encode(self, buf):
return imagecodecs.snappy_encode(buf)
def decode(self, buf, out=None):
return imagecodecs.snappy_decode(buf, out=_flat(out))
class Spng(Codec):
"""SPNG codec for numcodecs."""
codec_id = 'imagecodecs_spng'
def __init__(self, level=None):
self.level = level
def encode(self, buf):
buf = protective_squeeze(numpy.asarray(buf))
return imagecodecs.spng_encode(buf, level=self.level)
def decode(self, buf, out=None):
return imagecodecs.spng_decode(buf, out=out)
class Tiff(Codec):
"""TIFF codec for numcodecs."""
codec_id = 'imagecodecs_tiff'
def __init__(self, index=None, asrgb=None, verbose=0):
self.index = index
self.asrgb = bool(asrgb)
self.verbose = verbose
def encode(self, buf):
# TODO: not implemented
buf = protective_squeeze(numpy.asarray(buf))
return imagecodecs.tiff_encode(buf)
def decode(self, buf, out=None):
return imagecodecs.tiff_decode(
buf,
index=self.index,
asrgb=self.asrgb,
verbose=self.verbose,
out=out,
)
class Webp(Codec):
"""WebP codec for numcodecs."""
codec_id = 'imagecodecs_webp'
def __init__(self, level=None, lossless=None, method=None, hasalpha=None):
self.level = level
self.hasalpha = bool(hasalpha)
self.method = method
self.lossless = lossless
def encode(self, buf):
buf = protective_squeeze(numpy.asarray(buf))
return imagecodecs.webp_encode(
buf, level=self.level, lossless=self.lossless, method=self.method
)
def decode(self, buf, out=None):
return imagecodecs.webp_decode(buf, hasalpha=self.hasalpha, out=out)
class Xor(Codec):
"""XOR codec for numcodecs."""
codec_id = 'imagecodecs_xor'
def __init__(self, shape=None, dtype=None, axis=-1):
self.shape = None if shape is None else tuple(shape)
self.dtype = None if dtype is None else numpy.dtype(dtype).str
self.axis = axis
def encode(self, buf):
if self.shape is not None or self.dtype is not None:
buf = protective_squeeze(numpy.asarray(buf))
assert buf.shape == self.shape
assert buf.dtype == self.dtype
return imagecodecs.xor_encode(buf, axis=self.axis).tobytes()
def decode(self, buf, out=None):
if self.shape is not None or self.dtype is not None:
buf = numpy.frombuffer(buf, dtype=self.dtype).reshape(*self.shape)
return imagecodecs.xor_decode(buf, axis=self.axis, out=_flat(out))
class Zfp(Codec):
"""ZFP codec for numcodecs."""
codec_id = 'imagecodecs_zfp'
def __init__(
self,
shape=None,
dtype=None,
strides=None,
level=None,
mode=None,
execution=None,
numthreads=None,
chunksize=None,
header=True,
):
if header:
self.shape = None
self.dtype = None
self.strides = None
elif shape is None or dtype is None:
raise ValueError('invalid shape or dtype')
else:
self.shape = tuple(shape)
self.dtype = numpy.dtype(dtype).str
self.strides = None if strides is None else tuple(strides)
self.level = level
self.mode = mode
self.execution = execution
self.numthreads = numthreads
self.chunksize = chunksize
self.header = bool(header)
def encode(self, buf):
buf = protective_squeeze(numpy.asarray(buf))
if not self.header:
assert buf.shape == self.shape
assert buf.dtype == self.dtype
return imagecodecs.zfp_encode(
buf,
level=self.level,
mode=self.mode,
execution=self.execution,
header=self.header,
numthreads=self.numthreads,
chunksize=self.chunksize,
)
def decode(self, buf, out=None):
if self.header:
return imagecodecs.zfp_decode(buf, out=out)
return imagecodecs.zfp_decode(
buf,
shape=self.shape,
dtype=numpy.dtype(self.dtype),
strides=self.strides,
numthreads=self.numthreads,
out=out,
)
class Zlib(Codec):
"""Zlib codec for numcodecs."""
codec_id = 'imagecodecs_zlib'
def __init__(self, level=None):
self.level = level
def encode(self, buf):
return imagecodecs.zlib_encode(buf, level=self.level)
def decode(self, buf, out=None):
return imagecodecs.zlib_decode(buf, out=_flat(out))
class Zlibng(Codec):
"""Zlibng codec for numcodecs."""
codec_id = 'imagecodecs_zlibng'
def __init__(self, level=None):
self.level = level
def encode(self, buf):
return imagecodecs.zlibng_encode(buf, level=self.level)
def decode(self, buf, out=None):
return imagecodecs.zlibng_decode(buf, out=_flat(out))
class Zopfli(Codec):
"""Zopfli codec for numcodecs."""
codec_id = 'imagecodecs_zopfli'
def encode(self, buf):
return imagecodecs.zopfli_encode(buf)
def decode(self, buf, out=None):
return imagecodecs.zopfli_decode(buf, out=_flat(out))
class Zstd(Codec):
"""ZStandard codec for numcodecs."""
codec_id = 'imagecodecs_zstd'
def __init__(self, level=None):
self.level = level
def encode(self, buf):
return imagecodecs.zstd_encode(buf, level=self.level)
def decode(self, buf, out=None):
return imagecodecs.zstd_decode(buf, out=_flat(out))
def _flat(out):
"""Return numpy array as contiguous view of bytes if possible."""
if out is None:
return None
view = memoryview(out)
if view.readonly or not view.contiguous:
return None
return view.cast('B')
def register_codecs(codecs=None, force=False, verbose=True):
"""Register codecs in this module with numcodecs."""
for name, cls in globals().items():
if not hasattr(cls, 'codec_id') or name == 'Codec':
continue
if codecs is not None and cls.codec_id not in codecs:
continue
try:
try:
get_codec({'id': cls.codec_id})
except TypeError:
# registered, but failed
pass
except ValueError:
# not registered yet
pass
else:
if not force:
if verbose:
log_warning(
f'numcodec {cls.codec_id!r} already registered'
)
continue
if verbose:
log_warning(f'replacing registered numcodec {cls.codec_id!r}')
register_codec(cls)
def log_warning(msg, *args, **kwargs):
"""Log message with level WARNING."""
import logging
logging.getLogger(__name__).warning(msg, *args, **kwargs)
|