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 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652
// Copyright © 2019 George Burton // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in all // copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE // SOFTWARE. //! # Nvtt //! //! nvtt is a library for converting textures into common compressed formats for use //! with graphics APIs. See the [wiki] for more info. //! //! # Example //! //! ```no_run //! # fn main() -> Result<(), Box<dyn std::error::Error>> { //! # let (w, h) = (0, 0); //! use nvtt_rs::{Compressor, CompressionOptions, Format, InputOptions, OutputOptions}; //! //! let input_options = InputOptions::new()?; //! //! let mut output_options = OutputOptions::new()?; //! output_options.set_output_location("output.dds"); //! //! let mut compression_opts = CompressionOptions::new()?; //! compression_opts.set_format(Format::Dxt1); //! //! let mut compressor = Compressor::new()?; //! compressor.compress(&compression_opts, &input_options, &output_options)?; //! //! # Ok(()) //! # } //! ``` //! //! # Features //! //! ## `nvtt_image_integration` //! //! This feature provides the convenience method [`InputOptions::set_image`], which //! can be used to configure the `InputOptions` directly from types provided by the //! [`image`] crate. //! //! Only a limited number of image formats are supported, although this library can //! provide automatic conversions from a [`DynamicImage`]. See the [`ValidImage`] //! type for more information. //! //! # Dependencies //! //! ## Linux/macOS //! //! This crate requires a valid cmake installation and a C++ compiler to build. //! //! ## Windows //! //! This crate requires a valid installation of Visual Studio. //! //! # Notes //! //! This crate does not currently work on Microsoft Windows due to incomplete work //! on the build system. //! //! [wiki]: https://github.com/castano/nvidia-texture-tools/wiki/ApiDocumentation //! [`InputOptions::set_image`]: struct.InputOptions.html#method.set_image //! [`image`]: https://docs.rs/image/latest/image //! [`DynamicImage`]: https://docs.rs/image/latest/image/enum.DynamicImage.html //! [`ValidImage`]: enum.ValidImage.html use cfg_if::cfg_if; #[cfg(feature = "nvtt_image_integration")] use image::{Bgra, DynamicImage, ImageBuffer, Luma, Rgba}; use log::{error, trace}; #[cfg(feature = "nvtt_image_integration")] use maybe_owned::MaybeOwned; use nvtt_sys::*; #[cfg(feature = "nvtt_image_integration")] use safe_transmute::transmute_to_bytes; #[cfg(feature = "nvtt_image_integration")] use std::ops::Deref; use std::{ any::type_name, cell::{Cell, RefCell}, cmp::PartialEq, convert::TryFrom, error::Error as ErrorTrait, ffi::{CStr, CString, NulError, OsStr}, fmt, mem, os::raw::{c_int, c_uint, c_void}, path::Path, ptr::NonNull, slice, thread_local, }; /// Get the version of the linked `nvtt` library. #[inline(always)] pub const fn version() -> u32 { NVTT_VERSION } macro_rules! decl_enum { ( $(#[$($attr:meta)*])* $v:vis enum $enum_name:ident: $raw:ident { $( $(#[$($brnch_attr:meta)*])* $rust_nm:ident = $sys_nm:ident ),* $(,)? } ) => { $(#[$($attr)*])* $v enum $enum_name { $( $(#[$($brnch_attr)*])* $rust_nm ),* } impl From<&'_ $enum_name> for $raw { #[inline] fn from(val: &'_ $enum_name) -> Self { From::from(*val) } } impl From<$enum_name> for $raw { #[inline] fn from(val: $enum_name) -> Self { match val { $( $enum_name :: $rust_nm => $sys_nm ),* } } } impl TryFrom<$raw> for $enum_name { type Error = EnumConvertError; // NvttFormat contains overlapping enum instances, so only the first // value declared will be returned. #[allow(nonstandard_style, unreachable_patterns)] #[inline] fn try_from(raw: $raw) -> Result<Self, Self::Error> { match raw { $( $sys_nm => { Ok($enum_name::$rust_nm) } )* _ => Err(EnumConvertError::new::<$enum_name>(raw)) } } } impl PartialEq<$raw> for $enum_name { #[inline] fn eq(&self, rhs: &$raw) -> bool { let lhs: $raw = (*self).into(); lhs == *rhs } } impl PartialEq<$enum_name> for $raw { #[inline] fn eq(&self, rhs: &$enum_name) -> bool { let rhs: $raw = (*rhs).into(); *self == rhs } } }; } decl_enum! { /// The container format used to store the texture data. #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] pub enum Container: NvttContainer { /// Dds container. This is used to contain data compressed /// in the `dxt` format. Dds = NvttContainer_NVTT_Container_DDS, /// Dds10 container. This is used to contain data compressed /// in the `dxt` format. Dds10 = NvttContainer_NVTT_Container_DDS10, /// Ktx container. This is used to contain data compressed /// in the `etc` format. Ktx = NvttContainer_NVTT_Container_KTX, } } impl Container { /// Gets the file extension of files used for the container. #[inline] pub fn file_extension(&self) -> &OsStr { match *self { Self::Dds | Self::Dds10 => OsStr::new("dds"), Self::Ktx => OsStr::new("ktx"), } } } decl_enum! { /// Specifies how the alpha should be interpreted on the image. /// /// You can view [`wikipedia`] for more information about alpha blending. /// /// [`wikipedia`]: https://en.wikipedia.org/wiki/Alpha_compositing #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] pub enum AlphaMode: NvttAlphaMode { /// The image does not contain any alpha information. None = NvttAlphaMode_NVTT_AlphaMode_None, /// The image uses premultiplied alpha. Premultiplied = NvttAlphaMode_NVTT_AlphaMode_Premultiplied, /// The image uses straight alpha, where the color channels represent /// the straight color of the channel without transparency. Transparency = NvttAlphaMode_NVTT_AlphaMode_Transparency, } } /// Parameters used to customise the kaiser filter used /// for mipmapping. #[derive(Clone, Copy, Debug, PartialEq)] pub struct KaiserParameters { pub width: f32, pub alpha: f32, pub stretch: f32, } /// Specify which type of filter used to calculate mipmaps. #[derive(Clone, Copy, Debug, PartialEq)] pub enum MipmapFilter { /// Use a box filter. This is the default. Box, /// Use a triangle filter. Triangle, /// Use a kaiser filter. If the parameters are set, then /// they will override the defaults. Kaiser(Option<KaiserParameters>), } impl From<&'_ MipmapFilter> for NvttMipmapFilter { #[inline] fn from(filter: &'_ MipmapFilter) -> Self { match *filter { MipmapFilter::Box => NvttMipmapFilter_NVTT_MipmapFilter_Box, MipmapFilter::Triangle => NvttMipmapFilter_NVTT_MipmapFilter_Triangle, MipmapFilter::Kaiser(_) => NvttMipmapFilter_NVTT_MipmapFilter_Kaiser, } } } impl From<MipmapFilter> for NvttMipmapFilter { #[inline] fn from(filter: MipmapFilter) -> Self { From::from(&filter) } } impl From<KaiserParameters> for MipmapFilter { #[inline] fn from(params: KaiserParameters) -> Self { MipmapFilter::Kaiser(Some(params)) } } impl Default for MipmapFilter { #[inline] fn default() -> Self { MipmapFilter::Box } } decl_enum! { /// Specify the quality level of the compression output. #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] pub enum Quality: NvttQuality { /// Produces the lowest quality level, but at the fastest speed. Fastest = NvttQuality_NVTT_Quality_Fastest, /// Produces the highest quality compression output. Highest = NvttQuality_NVTT_Quality_Highest, /// Provides a medium quality level, trading off between /// processing time and output quality. /// /// This is the default quality. Normal = NvttQuality_NVTT_Quality_Normal, /// Equivalent to `Quality::Highest`. Production = NvttQuality_NVTT_Quality_Production, } } impl Default for Quality { #[inline] fn default() -> Self { Quality::Normal } } decl_enum! { /// Specify the output format. /// /// You can see the [`Microsoft Documentation`] for more information about the `Bc` formats. /// /// [`Microsoft Documentation`]: https://docs.microsoft.com/en-us/windows/win32/direct3d10/d3d10-graphics-programming-guide-resources-block-compression #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] pub enum Format: NvttFormat { /// Use the `bc1` compression algorithm. This supports images with 3 rgb channels. Bc1 = NvttFormat_NVTT_Format_BC1, /// Use the `bc1` with alpha compression algorithm. This supports images with 3 rgb channels, and 1 bit /// for the alpha channel. Bc1a = NvttFormat_NVTT_Format_BC1a, /// Use `bc2` compression, which supports rgb channels, and 4 bits of alpha. Bc2 = NvttFormat_NVTT_Format_BC2, /// Use `bc3` compression, which supports rgb channels, and 8 bits of alpha. Bc3 = NvttFormat_NVTT_Format_BC3, /// @TODO Bc3n = NvttFormat_NVTT_Format_BC3n, /// @TODO Bc3Rgbm = NvttFormat_NVTT_Format_BC3_RGBM, /// Use `bc4` compression, which supports a single red channel using 8 bits. Bc4 = NvttFormat_NVTT_Format_BC4, /// Use `bc5` compression, which supports two channels of 8 bits each. Bc5 = NvttFormat_NVTT_Format_BC5, /// Use `bc6` compression, which supports HDR encoded textures. See the [MSDN] docs for more. /// /// [MSDN]: https://docs.microsoft.com/en-us/windows/win32/direct3d11/bc6h-format Bc6 = NvttFormat_NVTT_Format_BC6, /// Use `bc7` compression, which supports high quality `Rgb` and `Rgba` textures. See the [MSDN] /// docs for more. /// /// [MSDN]: https://docs.microsoft.com/en-us/windows/win32/direct3d11/bc7-format Bc7 = NvttFormat_NVTT_Format_BC7, Ctx1 = NvttFormat_NVTT_Format_CTX1, Dxt1 = NvttFormat_NVTT_Format_DXT1, Dxt1a = NvttFormat_NVTT_Format_DXT1a, Dxt1n = NvttFormat_NVTT_Format_DXT1n, Dxt3 = NvttFormat_NVTT_Format_DXT3, Dxt5 = NvttFormat_NVTT_Format_DXT5, Dxt5n = NvttFormat_NVTT_Format_DXT5n, Etc1 = NvttFormat_NVTT_Format_ETC1, Etc2R = NvttFormat_NVTT_Format_ETC2_R, Etc2Rg = NvttFormat_NVTT_Format_ETC2_RG, Etc2Rgb = NvttFormat_NVTT_Format_ETC2_RGB, Etc2Rgba = NvttFormat_NVTT_Format_ETC2_RGBA, Etc2Rgbm = NvttFormat_NVTT_Format_ETC2_RGBM, Etc2RgbA1 = NvttFormat_NVTT_Format_ETC2_RGB_A1, Pvr2BppRgb = NvttFormat_NVTT_Format_PVR_2BPP_RGB, Pvr2BppRgba = NvttFormat_NVTT_Format_PVR_2BPP_RGBA, Pvr4BppRgb = NvttFormat_NVTT_Format_PVR_4BPP_RGB, Pvr4BppRgba = NvttFormat_NVTT_Format_PVR_4BPP_RGBA, Rgb = NvttFormat_NVTT_Format_RGB, Rgba = NvttFormat_NVTT_Format_RGBA, } } decl_enum! { /// Specify the color format of the input image. #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] pub enum InputFormat: NvttInputFormat { /// 4 unsigned byte channels comprised of `blue`, `green`, `red` and `alpha`. Bgra8Ub = NvttInputFormat_NVTT_InputFormat_BGRA_8UB, /// 4 16-bit float channels comprised of `red`, `green`, `blue` and `alpha`. Rgba16F = NvttInputFormat_NVTT_InputFormat_RGBA_16F, /// 4 32-bit float channels comprised of `red`, `green`, `blue` and `alpha`. Rgba32F = NvttInputFormat_NVTT_InputFormat_RGBA_32F, /// A single 32 bit floating point channel. R32F = NvttInputFormat_NVTT_InputFormat_R_32F, } } decl_enum! { /// Controls how the image edge length is rounded when the image is compressed. #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] pub enum RoundMode: NvttRoundMode { /// The image size is not changed. None = NvttRoundMode_NVTT_RoundMode_None, /// Round the size of each edge to the nearest multiple of four. ToNearestMultipleOfFour = NvttRoundMode_NVTT_RoundMode_ToNearestMultipleOfFour, /// Round the size of each edge to the nearest power of two. ToNearestPowerOfTwo = NvttRoundMode_NVTT_RoundMode_ToNearestPowerOfTwo, /// Round the size of each edge up to the next highest multiple of four. ToNextMultipleOfFour = NvttRoundMode_NVTT_RoundMode_ToNextMultipleOfFour, /// Round the size of each edge up to the next highest power of two. ToNextPowerOfTwo = NvttRoundMode_NVTT_RoundMode_ToNextPowerOfTwo, /// Round the size of each edge down to the next lowest multiple of four. ToPreviousMultipleOfFour = NvttRoundMode_NVTT_RoundMode_ToPreviousMultipleOfFour, /// Round the size of each edge down to the next lowest power of two. ToPreviousPowerOfTwo = NvttRoundMode_NVTT_RoundMode_ToPreviousPowerOfTwo, } } impl Default for RoundMode { #[inline] fn default() -> Self { RoundMode::None } } decl_enum! { /// The type of the texture. #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] pub enum TextureType: NvttTextureType { /// The texture is a standard 2D image with a width and /// a height. D2 = NvttTextureType_NVTT_TextureType_2D, /// The texture is a cube texture comprised of 6 2D textures /// for each face of the cube. Cube = NvttTextureType_NVTT_TextureType_Cube, /// The texture is a 3D texture, with a width, height and depth. D3 = NvttTextureType_TextureType_3D, /// The texture is an array of 2D textures. Array = NvttTextureType_TextureType_Array, } } impl Default for TextureType { #[inline] fn default() -> Self { TextureType::D2 } } decl_enum! { /// Specify how the image should wrap if image boundaries are modified. #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] pub enum WrapMode: NvttWrapMode { /// Clamp the image edge to a single color. Clamp = NvttWrapMode_NVTT_WrapMode_Clamp, /// Mirror the texture from the edge of the image. Mirror = NvttWrapMode_NVTT_WrapMode_Mirror, /// Repeat the image. Repeat = NvttWrapMode_NVTT_WrapMode_Repeat, } } #[derive(Clone, Copy, Debug, PartialEq)] pub struct NormalMapFilter { pub small: f32, pub medium: f32, pub big: f32, pub large: f32, } impl NormalMapFilter { /// Construct a new `NormalMapFilter` with the given parameters. #[inline] pub const fn new(small: f32, medium: f32, big: f32, large: f32) -> Self { Self { small, medium, big, large, } } } /// Describes the layout of the input texture data. #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] pub enum TextureLayout { /// The texture is a standard 2D image with a width and /// a height. D2 { /// The with of the texture in pixels. width: usize, /// The height of the texture in pixels. height: usize, }, /// The texture is a 3D texture, with a width, height and depth. D3 { /// The with of the texture in pixels. width: usize, /// The height of the texture in pixels. height: usize, /// The depth of the texture in pixels. depth: usize, }, /// The texture is an array of 2D textures. Array { /// The width of each texture in pixels. width: usize, /// The height of each texture in pixels. height: usize, /// The total number of textures in the array. array_length: usize, }, /// The texture is a cube texture comprised of 6 2D textures /// for each face of the cube. Cube { /// The width of each face of the cube texture in pixels. face_width: usize, /// The height of each face of the cube texture in pixels. face_height: usize, }, } impl TextureLayout { /// Construct a new [`TextureLayout::D2`] from the given `width` and `height`. /// /// [`TextureLayout::D2`]: ./enum.TextureLayout.html#variant.D2 #[inline] pub const fn d2(width: usize, height: usize) -> Self { Self::D2 { width, height } } /// Construct a new [`TextureLayout::D3`] from the given `width`, `height` and `depth`. /// /// [`TextureLayout::D3`]: ./enum.TextureLayout.html#variant.D3 #[inline] pub const fn d3(width: usize, height: usize, depth: usize) -> Self { Self::D3 { width, height, depth, } } /// Construct a new [`TextureLayout::Array`] from the given `width`, `height` and /// `array_length`. /// /// [`TextureLayout::Array`]: ./enum.TextureLayout.html#variant.Array #[inline] pub const fn array(width: usize, height: usize, array_length: usize) -> Self { Self::Array { width, height, array_length, } } /// Construct a new [`TextureLayout::Cube`] from the given `face_width` and `face_height`. /// /// [`TextureLayout::Cube`]: ./enum.TextureLayout.html#variant.Cube #[inline] pub const fn cube(face_width: usize, face_height: usize) -> Self { Self::Cube { face_width, face_height, } } /// Get the `TextureType` corresponding to this `TextureLayout`. #[inline] pub fn texture_type(&self) -> TextureType { match *self { Self::D2 { .. } => TextureType::D2, Self::D3 { .. } => TextureType::D3, Self::Array { .. } => TextureType::Array, Self::Cube { .. } => TextureType::Cube, } } /// Get the `TextureDimensions` of this `TextureLayout`. Used /// internally. #[inline] fn dimensions(&self) -> TextureDimensions { match *self { Self::D2 { width, height } => TextureDimensions { width: width as c_int, height: height as c_int, ..Default::default() }, Self::D3 { width, height, depth, } => TextureDimensions { width: width as c_int, height: height as c_int, depth: depth as c_int, ..Default::default() }, Self::Array { width, height, array_length, } => TextureDimensions { width: width as c_int, height: height as c_int, array_length: array_length as c_int, ..Default::default() }, Self::Cube { face_width, face_height, } => TextureDimensions { width: face_width as c_int, height: face_height as c_int, ..Default::default() }, } } } /// Describes the dimensions of an input texture. Unused parameters /// are set to `1`. struct TextureDimensions { width: c_int, height: c_int, depth: c_int, array_length: c_int, } impl Default for TextureDimensions { #[inline] fn default() -> Self { Self { width: 1, height: 1, depth: 1, array_length: 1, } } } /// The `Compressor` is used to perform the texture compression. This provides a /// safer interface for the [`NvttCompressor`] type. /// /// [`NvttCompressor`]: https://docs.rs/nvtt_sys/latest/nvtt_sys/struct.NvttCompressor.html #[derive(Debug)] pub struct Compressor(NonNull<NvttCompressor>); impl Compressor { /// Create a new `Compressor`. If the `Compressor` cannot be created, returns /// `Error::Unknown`. #[inline] pub fn new() -> Result<Self, Error> { let compressor = unsafe { nvttCreateCompressor() }; NonNull::new(compressor).map(Self).ok_or(Error::Unknown) } /// Returns the underlying [`NvttCompressor`] pointer type. It is your responsibility /// to call [`nvttDestroyCompressor`] on this value to clean up the [`NvttCompressor`] /// resources. /// /// [`nvttDestroyCompressor`]: https://docs.rs/nvtt_sys/latest/nvtt_sys/fn.nvttDestroyCompressionOptions.html /// [`NvttCompressor`]: https://docs.rs/nvtt_sys/latest/nvtt_sys/struct.NvttCompressor.html #[inline] pub fn into_raw(self) -> *mut NvttCompressor { let ptr = self.0.as_ptr(); mem::forget(self); ptr } /// If the platform supports the `cuda` api, this method can be used to enable /// gpu compression. This may give different results to a pure cpu implementation, /// so this is set to `false` by default. /// /// On platforms without `cuda`, this function is a no-op. #[inline] pub fn enable_cuda_acceleration<B: Into<NvttBoolean>>(&mut self, enable: B) -> &mut Self { unsafe { nvttEnableCudaAcceleration(self.0.as_ptr(), enable.into()); } self } /// Returns `true` if cuda acceleration has been enabled. Otherwise, returns /// false. #[inline] pub fn is_cuda_acceleration_enabled(&self) -> bool { unsafe { nvttIsCudaAccelerationEnabled(self.0.as_ptr()).into() } } /// Perform the compression. pub fn compress( &self, compress_options: &CompressionOptions, input_options: &InputOptions, output_options: &OutputOptions, ) -> Result<CompressionOutput, Error> { thread_local! { static ERR: Cell<NvttError> = Cell::new(0); static OUT_DATA: RefCell<Vec<u8>> = RefCell::new(vec![]); static HEIGHT: Cell<usize> = Cell::new(0); static WIDTH: Cell<usize> = Cell::new(0); static DEPTH: Cell<usize> = Cell::new(0); static FACE: Cell<usize> = Cell::new(0); static MIPLEVEL: Cell<usize> = Cell::new(0); } extern "C" fn err_callback(err: NvttError) { error!( "nvtt: Encountered an error while compressing\nCaused by: {err}", err = Error::try_from(err).unwrap_or(Error::Unknown) ); ERR.with(|e| e.set(err)); } extern "C" fn output_begin_callback( size: c_int, width: c_int, height: c_int, depth: c_int, face: c_int, miplevel: c_int, ) { trace!("Beginning texture compression with image size {sz} ({w} x {h} x {d}), face = {fc}, mip = {mp}", sz = size, w = width, h = height, d = depth, fc = face, mp = miplevel); OUT_DATA.with(|d| d.borrow_mut().reserve(size as _)); ERR.with(|e| e.set(0)); WIDTH.with(|w| w.set(width as _)); HEIGHT.with(|h| h.set(height as _)); DEPTH.with(|d| d.set(depth as _)); FACE.with(|f| f.set(face as _)); MIPLEVEL.with(|ml| ml.set(miplevel as _)); } extern "C" fn output_callback(data_ptr: *const c_void, len: c_int) -> bool { let len = match usize::try_from(len) { Ok(len) => len, Err(err) => { error!( "Could not append texture data: len {l} is invalid\nCaused by: {e}", l = len, e = err ); return false; } }; let data = unsafe { slice::from_raw_parts(data_ptr as *const u8, len) }; OUT_DATA.with(|d| d.borrow_mut().extend_from_slice(data)); true } OUT_DATA.with(|d| d.borrow_mut().clear()); let res = unsafe { let out_opts_ptr = output_options.out_opts.as_ptr(); nvttSetOutputOptionsErrorHandler(out_opts_ptr, Some(err_callback)); if !output_options.write_to_file { nvttSetOutputOptionsOutputHandler( out_opts_ptr, Some(output_begin_callback), // begin image Some(output_callback), None, // end image ); } nvttCompress( self.0.as_ptr(), input_options.0.as_ptr(), compress_options.0.as_ptr(), output_options.out_opts.as_ptr(), ) }; if res != NvttBoolean::NVTT_True { let mut err = 0; ERR.with(|e| err = e.get()); Err(Error::try_from(err).unwrap_or(Error::Unknown)) } else { if !output_options.write_to_file { Ok(CompressionOutput::Memory { data: OUT_DATA.with(|d| d.replace(vec![])), width: WIDTH.with(|w| w.get()), height: HEIGHT.with(|h| h.get()), depth: DEPTH.with(|d| d.get()), face: FACE.with(|f| f.get()), miplevel: MIPLEVEL.with(|ml| ml.get()), }) } else { Ok(CompressionOutput::File) } } } /// Estimate the final compressed size of the output texture. #[inline] pub fn estimate_size( &self, input_options: &InputOptions, compression_options: &CompressionOptions, ) -> usize { unsafe { nvttEstimateSize( self.0.as_ptr(), input_options.0.as_ptr(), compression_options.0.as_ptr(), ) as usize } } } impl Drop for Compressor { #[inline] fn drop(&mut self) { unsafe { nvttDestroyCompressor(self.0.as_ptr()); } } } // @SAFETY: A `Compressor` cannot be copied or unsafely mutated in a shared way. // @NOTE: Not `Sync` because `Compressor::compress` could otherwise thrash thread local vars. unsafe impl Send for Compressor {} /// Communicates the output of a compressed texture. #[derive(Clone, Debug, Eq, Hash, PartialEq)] pub enum CompressionOutput { /// The texture was saved into the file specified on the `OutputOptions`. File, /// The texture was saved into memory. Memory { /// The bytes of the image. data: Vec<u8>, /// The width of the texture in pixels. width: usize, /// The height of the texture in pixels. height: usize, /// The depth of the texture. depth: usize, /// The face of the texture. face: usize, /// The mipmap level of the texture. miplevel: usize, }, } /// Object which stores the compression options for the texture. This provides a /// safer interface for the [`NvttCompressionOptions`] type. /// /// [`NvttCompressionOptions`]: https://docs.rs/nvtt_sys/latest/nvtt_sys/struct.NvttCompressionOptions.html #[derive(Debug)] pub struct CompressionOptions(NonNull<NvttCompressionOptions>); impl CompressionOptions { /// Create a new `CompressionOptions`. #[inline] pub fn new() -> Result<Self, Error> { let opts = unsafe { nvttCreateCompressionOptions() }; NonNull::new(opts).map(Self).ok_or(Error::Unknown) } /// Returns the underlying [`NvttCompressionOptions`] pointer type. It is your /// responsibility to call [`nvttDestroyCompressionOptions`] on this value to /// clean up the [`NvttCompressionOptions`] resources. /// /// [`nvttDestroyCompressionOptions`]: https://docs.rs/nvtt_sys/latest/nvtt_sys/fn.nvttDestroyCompressionOptions.html /// [`NvttCompressionOptions`]: https://docs.rs/nvtt_sys/latest/nvtt_sys/struct.NvttCompressionOptions.html #[inline] pub fn into_raw(self) -> *mut NvttCompressionOptions { let ptr = self.0.as_ptr(); mem::forget(self); ptr } #[inline] pub fn set_color_weights(&mut self, r: f32, g: f32, b: f32, a: f32) -> &mut Self { unsafe { nvttSetCompressionOptionsColorWeights(self.0.as_ptr(), r, g, b, a); } self } /// Set the output format of the compressed image. #[inline] pub fn set_format(&mut self, format: Format) -> &mut Self { unsafe { nvttSetCompressionOptionsFormat(self.0.as_ptr(), format.into()); } self } #[inline] pub fn set_pixel_format( &mut self, bitcount: c_uint, rmask: c_uint, gmask: c_uint, bmask: c_uint, amask: c_uint, ) -> &mut Self { unsafe { nvttSetCompressionOptionsPixelFormat( self.0.as_ptr(), bitcount, rmask, gmask, bmask, amask, ) } self } /// Set the `Quality` of the output image. #[inline] pub fn set_quality(&mut self, quality: Quality) -> &mut Self { unsafe { nvttSetCompressionOptionsQuality(self.0.as_ptr(), quality.into()); } self } /// Set quantization settings on the `CompressionOptions`. /// /// * If `color_dithering` is `true`, then dithering will be applied to the color channel. /// * If `alpha_dithering` is `true`, then dithering will be applied to the alpha channel. /// * If `binary_alpha` is `true`, Then only one bit will be used to encode alpha information. /// * `alpha_threshold` is used to determine if a pixel's alpha channel is high enough to be /// transparent. This parameter is ignored if `binary_alpha` is set to false. #[inline] pub fn set_quanitzation( &mut self, color_dithering: impl Into<NvttBoolean>, alpha_dithering: impl Into<NvttBoolean>, binary_alpha: impl Into<NvttBoolean>, alpha_threshold: i32, ) -> &mut Self { unsafe { nvttSetCompressionOptionsQuantization( self.0.as_ptr(), color_dithering.into(), alpha_dithering.into(), binary_alpha.into(), alpha_threshold, ) } self } } impl Drop for CompressionOptions { #[inline] fn drop(&mut self) { unsafe { nvttDestroyCompressionOptions(self.0.as_ptr()) } } } // @SAFETY: A `CompressionOptions` cannot be copied or unsafely mutated in a shared way. unsafe impl Send for CompressionOptions {} unsafe impl Sync for CompressionOptions {} /// Object which stores the input options for the texture. This provides a /// safer interface for the [`NvttInputOptions`] type. /// /// [`NvttInputOptions`]: https://docs.rs/nvtt_sys/latest/nvtt_sys/struct.NvttInputOptions.html #[derive(Debug)] pub struct InputOptions(NonNull<NvttInputOptions>); impl InputOptions { /// Create a new `InputOptions`. #[inline] pub fn new() -> Result<Self, Error> { let opts = unsafe { nvttCreateInputOptions() }; NonNull::new(opts).map(Self).ok_or(Error::Unknown) } /// Returns the underlying [`NvttInputOptions`] pointer type. It is your responsibility /// to call [`nvttDestroyInputOptions`] on this value to clean up the [`NvttInputOptions`] /// resources. /// /// [`nvttDestroyInputOptions`]: https://docs.rs/nvtt_sys/latest/nvtt_sys/fn.nvttDestroyInputOptions.html /// [`NvttInputOptions`]: https://docs.rs/nvtt_sys/latest/nvtt_sys/struct.NvttInputOptions.html #[inline] pub fn into_raw(self) -> *mut NvttInputOptions { let ptr = self.0.as_ptr(); mem::forget(self); ptr } /// Set the `AlphaMode` on the `InputOptions`. #[inline] pub fn set_alpha_mode(&mut self, alpha_mode: AlphaMode) -> &mut Self { unsafe { nvttSetInputOptionsAlphaMode(self.0.as_ptr(), alpha_mode.into()); } self } /// If this parameter is set, then `nvtt` will convert the image into a normal map. #[inline] pub fn convert_to_normal_map( &mut self, convert_to_normal_map: impl Into<NvttBoolean>, ) -> &mut Self { unsafe { nvttSetInputOptionsConvertToNormalMap(self.0.as_ptr(), convert_to_normal_map.into()); } self } /// Sets the `InputFormat` of the input data. This tells `nvtt` which pixel format /// it should interpret the byte data passed in [`InputOptions::set_mipmap_data`] as. /// /// [`InputOptions::set_mipmap_data`]: struct.InputOptions.html#method.set_mipmap_data #[inline] pub fn set_format(&mut self, format: InputFormat) -> &mut Self { unsafe { nvttSetInputOptionsFormat(self.0.as_ptr(), format.into()); } self } /// Set the `input_gamma` and `output_gamma` on the `InputOptions`. #[inline] pub fn set_gamma(&mut self, input_gamma: f32, output_gamma: f32) -> &mut Self { unsafe { nvttSetInputOptionsGamma(self.0.as_ptr(), input_gamma, output_gamma); } self } #[inline] pub fn set_height_evaluation( &mut self, red_scale: f32, green_scale: f32, blue_scale: f32, alpha_scale: f32, ) -> &mut Self { unsafe { nvttSetInputOptionsHeightEvaluation( self.0.as_ptr(), red_scale, green_scale, blue_scale, alpha_scale, ); } self } /// Set the `MipmapFilter` on the `InputOptions`. See the [`MipmapFilter`] /// type for more info. /// /// [`MipmapFilter`]: enum.MipmapFilter.html #[inline] pub fn set_mipmap_filter(&mut self, mipmap_filter: MipmapFilter) -> &mut Self { let opts_ptr = self.0.as_ptr(); unsafe { nvttSetInputOptionsMipmapFilter(opts_ptr, mipmap_filter.into()); } if let MipmapFilter::Kaiser(Some(KaiserParameters { width, alpha, stretch, })) = mipmap_filter { unsafe { nvttSetInputOptionsKaiserParameters(opts_ptr, width, alpha, stretch); } } self } /// Sets the input data which should be compressed. /// /// The `data` is copied into the `InputOptions` object. /// /// # Errors /// /// If the dimensions of the image do not match the length of the `data`, /// then this method will fail with [`Error::Unknown`]. /// /// [`Error::Unknown`]: enum.Error.html#variant.Unknown #[inline] pub fn set_mipmap_data( &mut self, data: &[u8], w: i32, h: i32, d: i32, face: i32, mipmap: i32, ) -> Result<&mut Self, Error> { let result = unsafe { nvttSetInputOptionsMipmapData( self.0.as_ptr(), data.as_ptr() as *const _, w, h, d, face, mipmap, ) }; match result { NvttBoolean::NVTT_True => Ok(self), NvttBoolean::NVTT_False => Err(Error::Unknown), } } /// Resets the `InputOptions` back to the default state. #[inline] pub fn reset(&mut self) -> &mut Self { unsafe { nvttResetInputOptionsTextureLayout(self.0.as_ptr()) } self } /// Sets the input texture data to the data contained by `image`. /// /// # Notes /// /// * This method requires the [`nvtt_image_integration`] feature. /// * This method clears any previous state set on the `InputOptions`. /// /// [`nvtt_image_integration`]: index.html#nvtt_image_integration #[cfg(feature = "nvtt_image_integration")] #[inline] pub fn set_image<'a, I: Into<ValidImage<'a>>>( &mut self, image: I, face: i32, mipmap: i32, ) -> Result<&mut Self, Error> { let image = image.into(); let (w, h) = image.image_dimensions(); let image_layout = TextureLayout::d2(w as _, h as _); self.reset() .set_format(image.format()) .set_texture_layout(image_layout) .set_mipmap_data(image.data_bytes(), w as _, h as _, 1, face, mipmap)?; Ok(self) } /// Constrain the texture size to the value in `max_extents`. #[inline] pub fn set_max_extents(&mut self, max_extents: c_int) -> &mut Self { unsafe { nvttSetInputOptionsMaxExtents(self.0.as_ptr(), max_extents); } self } /// Specify whether the image is a normal map. Normal maps may be compressed /// differently to better preserve the normal information. #[inline] pub fn set_normal_map(&mut self, is_normal_map: impl Into<NvttBoolean>) -> &mut Self { unsafe { nvttSetInputOptionsNormalMap(self.0.as_ptr(), is_normal_map.into()); } self } #[inline] pub fn set_normalize_mipmaps(&mut self, normalize_mips: impl Into<NvttBoolean>) -> &mut Self { unsafe { nvttSetInputOptionsNormalizeMipmaps(self.0.as_ptr(), normalize_mips.into()); } self } /// Set the `NormalMapFilter` params on the `InputOptions`. pub fn set_normal_filter(&mut self, filter: NormalMapFilter) -> &mut Self { unsafe { nvttSetInputOptionsNormalFilter( self.0.as_ptr(), filter.small, filter.medium, filter.big, filter.large, ); } self } /// Set the `RoundMode` on the `InputOptions`. #[inline] pub fn set_round_mode(&mut self, round_mode: RoundMode) -> &mut Self { unsafe { nvttSetInputOptionsRoundMode(self.0.as_ptr(), round_mode.into()); } self } /// Sets the layout of the texture on the `InputOptions`. #[inline] pub fn set_texture_layout(&mut self, texture_layout: TextureLayout) -> &mut Self { let tex_type = texture_layout.texture_type(); let tex_dims = texture_layout.dimensions(); unsafe { nvttSetInputOptionsTextureLayout( self.0.as_ptr(), tex_type.into(), tex_dims.width, tex_dims.height, tex_dims.depth, tex_dims.array_length, ) } self } /// Set the `WrapMode` on the `InputOptions`. #[inline] pub fn set_wrap_mode(&mut self, wrap_mode: WrapMode) -> &mut Self { unsafe { nvttSetInputOptionsWrapMode(self.0.as_ptr(), wrap_mode.into()); } self } } impl Drop for InputOptions { #[inline] fn drop(&mut self) { unsafe { nvttDestroyInputOptions(self.0.as_ptr()) } } } // @SAFETY: An `InputOptions` cannot be copied or unsafely mutated in a shared way. unsafe impl Send for InputOptions {} unsafe impl Sync for InputOptions {} cfg_if! { if #[cfg(feature = "nvtt_image_integration")] { /// An enumeration of the valid image buffer types which can be /// used with nvtt. /// /// # Notes /// /// This type requires the [`nvtt_image_integration`] feature. /// /// [`nvtt_image_integration`]: index.html#nvtt_image_integration #[derive(Clone, Debug)] pub enum ValidImage<'a> { /// A bgra image with byte values for each subpixel. Bgra(MaybeOwned<'a, ImageBuffer<Bgra<u8>, Vec<u8>>>), /// An rgba image with floats for each subpixel. Rgba(MaybeOwned<'a, ImageBuffer<Rgba<f32>, Vec<f32>>>), /// A luma image with floats for each subpixel. Luma(MaybeOwned<'a, ImageBuffer<Luma<f32>, Vec<f32>>>), } impl ValidImage<'_> { /// Create a new `ValidImage` from `image`. #[inline] pub fn new<I: Into<Self>>(image: I) -> Self { image.into() } #[inline] fn format(&self) -> InputFormat { match *self { ValidImage::Bgra(_) => InputFormat::Bgra8Ub, ValidImage::Rgba(_) => InputFormat::Rgba32F, ValidImage::Luma(_) => InputFormat::R32F, } } #[inline] fn image_dimensions(&self) -> (u32, u32) { match *self { ValidImage::Bgra(ref i) => i.dimensions(), ValidImage::Rgba(ref i) => i.dimensions(), ValidImage::Luma(ref i) => i.dimensions(), } } #[inline] fn data_bytes(&self) -> &[u8] { match *self { ValidImage::Bgra(ref i) => i.deref(), ValidImage::Rgba(ref i) => transmute_to_bytes(i.deref()), ValidImage::Luma(ref i) => transmute_to_bytes(i.deref()), } } } impl From<DynamicImage> for ValidImage<'_> { #[inline] fn from(img: DynamicImage) -> Self { ValidImage::Bgra(MaybeOwned::Owned(img.to_bgra())) } } impl From<&'_ DynamicImage> for ValidImage<'_> { #[inline] fn from(img: &'_ DynamicImage) -> Self { ValidImage::Bgra(MaybeOwned::Owned(img.to_bgra())) } } macro_rules! impl_maybeowned_from { ($( ($pix:ident, $subpix:ident) ),+ $(,)?) => { $( impl From<ImageBuffer<$pix<$subpix>, Vec<$subpix>>> for ValidImage<'_> { #[inline] fn from(buf: ImageBuffer<$pix<$subpix>, Vec<$subpix>>) -> Self { ValidImage:: $pix (MaybeOwned::from(buf)) } } impl<'a> From<&'a ImageBuffer<$pix<$subpix>, Vec<$subpix>>> for ValidImage<'a> { #[inline] fn from(buf: &'a ImageBuffer<$pix<$subpix>, Vec<$subpix>>) -> Self { ValidImage:: $pix (MaybeOwned::from(buf)) } } impl<'a> From<MaybeOwned<'a, ImageBuffer<$pix<$subpix>, Vec<$subpix>>>> for ValidImage<'a> { #[inline] fn from(img: MaybeOwned<'a, ImageBuffer<$pix<$subpix>, Vec<$subpix>>>) -> Self { ValidImage::$pix(img) } } )* }; } impl_maybeowned_from! { (Bgra, u8), (Rgba, f32), (Luma, f32), } } } /// Object which stores the output options for the texture. This provides a /// safer interface for the [`NvttOutputOptions`] type. /// /// [`NvttOutputOptions`]: https://docs.rs/nvtt_sys/latest/nvtt_sys/struct.NvttOutputOptions.html #[derive(Debug)] pub struct OutputOptions { out_opts: NonNull<NvttOutputOptions>, /// If this is `true`, then the `OutputOptions` will use nvtt's native file output /// system rather than using the callbacks. write_to_file: bool, } impl OutputOptions { /// Create a new `OutputOptions`. #[inline] pub fn new() -> Result<Self, Error> { let opts = unsafe { nvttCreateOutputOptions() }; NonNull::new(opts) .ok_or(Error::Unknown) .map(|out_opts| OutputOptions { out_opts, write_to_file: false, }) } /// Returns the underlying [`NvttOutputOptions`] pointer type. It is your responsibility /// to call [`nvttDestroyOutputOptions`] on this value to clean up the [`NvttOutputOptions`] /// resources. /// /// [`nvttDestroyOutputOptions`]: https://docs.rs/nvtt_sys/latest/nvtt_sys/fn.nvttDestroyOutputOptions.html /// [`NvttOutputOptions`]: https://docs.rs/nvtt_sys/latest/nvtt_sys/struct.NvttOutputOptions.html #[inline] pub fn into_raw(self) -> *mut NvttOutputOptions { let ptr = self.out_opts.as_ptr(); mem::forget(self); ptr } /// Set the output location. This can be either a path or an in-memory /// buffer. For more information, see the [`OutputLocation`] type. /// /// # Notes /// /// `nvtt` only supports ASCII filenames on Windows. If you need to support /// non-ASCII filenames, you will need to pass [`OutputLocation::Buffer`], /// and then write the data into the file using another method. An example of /// to do this is shown below. /// /// The `OutputOptions` will write to a buffer unless specified otherwise. /// /// ## Example /// /// ```no_run /// # fn main() -> Result<(), Box<dyn std::error::Error>> { /// use nvtt_rs::{ /// CompressionOptions, CompressionOutput, Compressor, /// InputOptions, OutputLocation, OutputOptions, /// }; /// /// let compressor = Compressor::new()?; /// let input_opts = InputOptions::new()?; /// let compression_opts = CompressionOptions::new()?; /// let mut output_opts = OutputOptions::new()?; /// /// output_opts.set_output_location(OutputLocation::Buffer); /// /// // Set other texture options here... /// /// match compressor.compress(&compression_opts, &input_opts, &output_opts)? { /// CompressionOutput::Memory { data, .. } => { /// std::fs::write("OutFile.dds", &data[..])?; /// } /// _ => {} /// }; /// /// # Ok(()) /// # } /// ``` /// /// [`OutputLocation`]: enum.OutputLocation.html /// [`OutputLocation::Buffer`]: enum.OutputLocation.html#variant.Buffer #[inline] pub fn set_output_location<'a, T: 'a + ?Sized + Into<OutputLocation<'a>>>( &mut self, out_location: T, ) -> Result<&mut Self, PathConvertError> { #[inline(never)] fn inner( opts: &mut OutputOptions, loc: OutputLocation<'_>, ) -> Result<(), PathConvertError> { match loc { OutputLocation::File(p) => { #[inline(always)] fn to_c_filepath(path: &Path) -> Result<CString, PathConvertError> { cfg_if! { if #[cfg(target_family = "windows")] { match path.to_str() { Some(s) => { if !s.is_ascii() { return Err(PathConvertError::AsciiConvert) } CString::new(s.as_bytes()).map_err(From::from) } None => Err(PathConvertError::Utf8Convert), } } else if #[cfg(target_family = "unix")] { use std::os::unix::ffi::OsStrExt; CString::new(path.as_os_str().as_bytes()).map_err(From::from) } else { compile_error!("This platform is unsupported"); } } } let out_file = to_c_filepath(p)?; unsafe { nvttSetOutputOptionsFileName(opts.out_opts.as_ptr(), out_file.as_ptr()); } opts.write_to_file = true; Ok(()) } OutputLocation::Buffer => { opts.write_to_file = false; Ok(()) } } } inner(self, out_location.into()).map(|_| self) } /// If set to `true`, then the `OutputOptions` will write texture metadata into a /// header section of the file. #[inline] pub fn set_write_header<B: Into<NvttBoolean>>(&mut self, write_header: B) -> &mut Self { unsafe { nvttSetOutputOptionsOutputHeader(self.out_opts.as_ptr(), write_header.into()); } self } /// If `write_srgb` is set to true, then the output image will be in the [sRGB] colorspace. /// /// [sRGB]: https://en.wikipedia.org/wiki/SRGB #[inline] pub fn set_srgb_flag<B: Into<NvttBoolean>>(&mut self, write_srgb: B) -> &mut Self { unsafe { nvttSetOutputOptionsSrgbFlag(self.out_opts.as_ptr(), write_srgb.into()); } self } /// Set the `Container` type of the output image. #[inline] pub fn set_container(&mut self, container: Container) -> &mut Self { unsafe { nvttSetOutputOptionsContainer(self.out_opts.as_ptr(), container.into()); } self } } impl Drop for OutputOptions { #[inline] fn drop(&mut self) { unsafe { nvttDestroyOutputOptions(self.out_opts.as_ptr()) } } } // @SAFETY: An `OutputOptions` cannot be copied or unsafely mutated in a shared way. unsafe impl Send for OutputOptions {} unsafe impl Sync for OutputOptions {} /// This enum is used to define the output location of the compressed /// texture data. /// /// See the method [`OutputOptions::set_output_location`] for more information. /// /// [`OutputOptions::set_output_location`]: struct.OutputOptions.html#method.set_output_location #[derive(Clone, Debug, Eq, Hash, PartialEq)] pub enum OutputLocation<'a> { /// Output the texture to the file specified by the `Path`. File(&'a Path), /// Output the texture into an in-memory buffer. This will be returned /// by [`Compressor::compress`]. /// /// [`Compressor::compress`]: struct.Compressor.html#method.compress Buffer, } impl<'a, P: 'a + ?Sized + AsRef<Path>> From<&'a P> for OutputLocation<'a> { #[inline] fn from(p: &'a P) -> Self { OutputLocation::File(p.as_ref()) } } decl_enum! { /// An error which may occur during compression. #[derive(Copy, Clone, Debug, Eq, Hash, PartialEq)] pub enum Error: NvttError { /// An error occurred while running a CUDA kernel. CudaError = NvttError_NVTT_Error_CudaError, /// An error occurred while opening a file. FileOpen = NvttError_NVTT_Error_FileOpen, /// An error occurred while writing a file. FileWrite = NvttError_NVTT_Error_FileWrite, /// The input was invalid. InvalidInput = NvttError_NVTT_Error_InvalidInput, /// An unknown error occurred. Unknown = NvttError_NVTT_Error_Unknown, /// The requested feature is not supported. UnsupportedFeature = NvttError_NVTT_Error_UnsupportedFeature, /// The requested output format is not supported. UnsupportedOutputFormat = NvttError_NVTT_Error_UnsupportedOutputFormat, } } impl Default for Error { #[inline] fn default() -> Self { Error::Unknown } } impl fmt::Display for Error { #[inline] fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { let s = unsafe { CStr::from_ptr(nvttErrorString(self.into())) }; f.write_str(&s.to_string_lossy()) } } impl ErrorTrait for Error { #[inline] fn description(&self) -> &'static str { let s = unsafe { CStr::from_ptr(nvttErrorString(self.into())) }; s.to_str().unwrap_or("An unknown error occurred") } } /// An error type for when a path could not be converted. #[derive(Clone, Debug)] pub enum PathConvertError { /// An error occurred while converting the path into utf8. Utf8Convert, /// An error occurred while converting the path into ASCII. AsciiConvert, /// The path contained a nul byte and could not be converted /// into a C compatible string. Nul(NulError), } impl fmt::Display for PathConvertError { #[inline] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { PathConvertError::Utf8Convert => { f.write_str("Could not convert path losslessly to UTF8 string") } PathConvertError::AsciiConvert => f.write_str("The given path was not valid ASCII"), PathConvertError::Nul(ref e) => fmt::Display::fmt(e, f), } } } impl ErrorTrait for PathConvertError { #[inline] fn source(&self) -> Option<&(dyn ErrorTrait + 'static)> { match *self { PathConvertError::Nul(ref e) => Some(e), _ => None, } } } impl From<NulError> for PathConvertError { #[inline] fn from(e: NulError) -> Self { PathConvertError::Nul(e) } } /// An error type which may be generated when converting a raw enum value /// into a rust native enum using the [`TryFrom`] trait. /// /// [`TryFrom`]: https://doc.rust-lang.org/stable/std/convert/trait.TryFrom.html #[derive(Debug)] pub struct EnumConvertError { value: u32, enum_name: &'static str, } impl EnumConvertError { /// Create a new `EnumConvertError`. #[inline] fn new<T>(value: u32) -> Self { Self { value, enum_name: type_name::<T>(), } } /// Returns the erroneous numeric value. #[inline] pub const fn value(&self) -> u32 { self.value } } impl fmt::Display for EnumConvertError { #[inline] fn fmt(&self, fmtr: &mut fmt::Formatter<'_>) -> fmt::Result { write!( fmtr, "Could not convert value {val} into a type of {enum_nm}", val = self.value, enum_nm = self.enum_name ) } } impl ErrorTrait for EnumConvertError {}