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
// Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: MIT-0 // 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. // 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. #![warn(missing_docs)] #![warn(unused, clippy::cast_ptr_alignment)] #![deny(trivial_casts)] #![deny(trivial_numeric_casts)] #![deny(unstable_features)] #![deny(unused_import_braces)] //! DCV color primitives is a library to perform image color model conversion. //! //! It is able to convert the following pixel formats: //! //! | Source pixel format | Destination pixel formats | //! | -------------------- | -------------------------- | //! | ARGB | I420, I444, NV12 | //! | BGR | I420, I444, NV12 | //! | BGRA | I420, I444, NV12, RGB | //! | I420 | BGRA | //! | I444 | BGRA | //! | NV12 | BGRA | //! | RGB | BGRA | //! //! The supported color models are: //! * YCbCr, ITU-R Recommendation BT.601 (standard video system) //! * YCbCr, ITU-R Recommendation BT.709 (CSC systems) //! //! # Examples //! //! Initialize the library: //! ``` //! use dcv_color_primitives as dcp; //! dcp::initialize(); //! ``` //! //! Convert an image from bgra to nv12 (single plane) format, with Bt601 color space: //! ``` //! use dcv_color_primitives as dcp; //! use dcp::{convert_image, ColorSpace, ImageFormat, PixelFormat}; //! //! fn convert() { //! dcp::initialize(); //! //! const WIDTH: u32 = 640; //! const HEIGHT: u32 = 480; //! //! let src_buffers: &[&[u8]] = &[&[0u8; 4 * (WIDTH as usize) * (HEIGHT as usize)]]; //! let dst_buffers: &mut [&mut [u8]] = //! &mut [&mut [0u8; 3 * (WIDTH as usize) * (HEIGHT as usize) / 2]]; //! //! let src_format = ImageFormat { //! pixel_format: PixelFormat::Bgra, //! color_space: ColorSpace::Lrgb, //! num_planes: 1, //! }; //! //! let dst_format = ImageFormat { //! pixel_format: PixelFormat::Nv12, //! color_space: ColorSpace::Bt601, //! num_planes: 1, //! }; //! //! convert_image( //! WIDTH, //! HEIGHT, //! &src_format, //! None, //! src_buffers, //! &dst_format, //! None, //! dst_buffers, //! ); //! } //! ``` //! //! Handle conversion errors: //! ``` //! use dcv_color_primitives as dcp; //! use dcp::{convert_image, ColorSpace, ImageFormat, PixelFormat}; //! use std::error; //! //! fn convert() -> Result<(), Box<dyn error::Error>> { //! dcp::initialize(); //! //! const WIDTH: u32 = 640; //! const HEIGHT: u32 = 480; //! //! let src_buffers: &[&[u8]] = &[&[0u8; 4 * (WIDTH as usize) * (HEIGHT as usize)]]; //! let dst_buffers: &mut [&mut [u8]] = //! &mut [&mut [0u8; 3 * (WIDTH as usize) * (HEIGHT as usize) / 2]]; //! //! let src_format = ImageFormat { //! pixel_format: PixelFormat::Bgra, //! color_space: ColorSpace::Bt709, //! num_planes: 1, //! }; //! //! let dst_format = ImageFormat { //! pixel_format: PixelFormat::Nv12, //! color_space: ColorSpace::Bt601, //! num_planes: 1, //! }; //! //! convert_image( //! WIDTH, //! HEIGHT, //! &src_format, //! None, //! src_buffers, //! &dst_format, //! None, //! dst_buffers, //! )?; //! //! Ok(()) //! } //! ``` //! //! Compute how many bytes are needed to store and image of a given format and size: //! ``` //! use dcv_color_primitives as dcp; //! use dcp::{get_buffers_size, ColorSpace, ImageFormat, PixelFormat}; //! use std::error; //! //! fn compute_size() -> Result<(), Box<dyn error::Error>> { //! dcp::initialize(); //! //! const WIDTH: u32 = 640; //! const HEIGHT: u32 = 480; //! const NUM_PLANES: u32 = 1; //! //! let format = ImageFormat { //! pixel_format: PixelFormat::Bgra, //! color_space: ColorSpace::Lrgb, //! num_planes: NUM_PLANES, //! }; //! //! let sizes: &mut [usize] = &mut [0usize; NUM_PLANES as usize]; //! get_buffers_size(WIDTH, HEIGHT, &format, None, sizes)?; //! //! let buffer: Vec<_> = vec![0u8; sizes[0]]; //! //! // Do something with buffer //! // --snip-- //! //! Ok(()) //! } //! ``` //! //! Provide image planes to hangle data scattered in multiple buffers that are not //! necessarily contiguous: //! ``` //! use dcv_color_primitives as dcp; //! use dcp::{convert_image, get_buffers_size, ColorSpace, ImageFormat, PixelFormat}; //! use std::error; //! //! fn convert() -> Result<(), Box<dyn error::Error>> { //! dcp::initialize(); //! //! const WIDTH: u32 = 640; //! const HEIGHT: u32 = 480; //! const NUM_SRC_PLANES: u32 = 2; //! const NUM_DST_PLANES: u32 = 1; //! //! let src_format = ImageFormat { //! pixel_format: PixelFormat::Nv12, //! color_space: ColorSpace::Bt709, //! num_planes: NUM_SRC_PLANES, //! }; //! //! let src_sizes: &mut [usize] = &mut [0usize; NUM_SRC_PLANES as usize]; //! get_buffers_size(WIDTH, HEIGHT, &src_format, None, src_sizes)?; //! //! let src_y: Vec<_> = vec![0u8; src_sizes[0]]; //! let src_uv: Vec<_> = vec![0u8; src_sizes[1]]; //! let src_buffers: &[&[u8]] = &[&src_y[..], &src_uv[..]]; //! //! let dst_format = ImageFormat { //! pixel_format: PixelFormat::Bgra, //! color_space: ColorSpace::Lrgb, //! num_planes: NUM_DST_PLANES, //! }; //! //! let dst_sizes: &mut [usize] = &mut [0usize; NUM_DST_PLANES as usize]; //! get_buffers_size(WIDTH, HEIGHT, &dst_format, None, dst_sizes)?; //! //! let mut dst_rgba: Vec<_> = vec![0u8; dst_sizes[0]]; //! let dst_buffers: &mut [&mut [u8]] = &mut [&mut dst_rgba[..]]; //! //! convert_image( //! WIDTH, //! HEIGHT, //! &src_format, //! None, //! src_buffers, //! &dst_format, //! None, //! dst_buffers, //! )?; //! //! Ok(()) //! } //! ``` //! //! Provide image strides to convert data which is not tightly packed: //! ``` //! use dcv_color_primitives as dcp; //! use dcp::{convert_image, get_buffers_size, ColorSpace, ImageFormat, PixelFormat}; //! use std::error; //! //! fn convert() -> Result<(), Box<dyn error::Error>> { //! dcp::initialize(); //! //! const WIDTH: u32 = 640; //! const HEIGHT: u32 = 480; //! const NUM_SRC_PLANES: u32 = 1; //! const NUM_DST_PLANES: u32 = 2; //! const RGB_STRIDE: usize = 4 * (((3 * (WIDTH as usize)) + 3) / 4); //! //! let src_format = ImageFormat { //! pixel_format: PixelFormat::Bgr, //! color_space: ColorSpace::Lrgb, //! num_planes: NUM_SRC_PLANES, //! }; //! //! let src_strides: &[usize] = &[RGB_STRIDE]; //! //! let src_sizes: &mut [usize] = &mut [0usize; NUM_SRC_PLANES as usize]; //! get_buffers_size(WIDTH, HEIGHT, &src_format, Some(src_strides), src_sizes)?; //! //! let src_rgba: Vec<_> = vec![0u8; src_sizes[0]]; //! let src_buffers: &[&[u8]] = &[&src_rgba[..]]; //! //! let dst_format = ImageFormat { //! pixel_format: PixelFormat::Nv12, //! color_space: ColorSpace::Bt709, //! num_planes: NUM_DST_PLANES, //! }; //! //! let dst_sizes: &mut [usize] = &mut [0usize; NUM_DST_PLANES as usize]; //! get_buffers_size(WIDTH, HEIGHT, &dst_format, None, dst_sizes)?; //! //! let mut dst_y: Vec<_> = vec![0u8; dst_sizes[0]]; //! let mut dst_uv: Vec<_> = vec![0u8; dst_sizes[1]]; //! let dst_buffers: &mut [&mut [u8]] = &mut [&mut dst_y[..], &mut dst_uv[..]]; //! //! convert_image( //! WIDTH, //! HEIGHT, //! &src_format, //! Some(src_strides), //! src_buffers, //! &dst_format, //! None, //! dst_buffers, //! )?; //! //! Ok(()) //! } //! ``` mod color_space; mod convert_image; mod cpu_info; mod dispatcher; mod pixel_format; mod static_assert; use cpu_info::*; use std::error; use std::fmt; pub use color_space::ColorSpace; pub use pixel_format::{PixelFormat, STRIDE_AUTO}; /// An enumeration of errors. #[derive(Debug)] #[repr(C)] pub enum ErrorKind { /// [`initialize`] was never called /// /// [`initialize`]: ./fn.initialize.html NotInitialized, /// One or more parameters have invalid values for the called function InvalidValue, /// The combination of parameters is unsupported for the called function InvalidOperation, /// Not enough data was provided to the called function. Typically, provided /// arrays are not correctly sized NotEnoughData, } impl fmt::Display for ErrorKind { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { ErrorKind::NotInitialized => { write!(f, "Library was not initialized by calling initialize()") } ErrorKind::InvalidValue => write!( f, "One or more parameters have not legal values for the command" ), ErrorKind::InvalidOperation => write!( f, "The combination of parameters is not legal for the command" ), ErrorKind::NotEnoughData => write!(f, "Not enough data provided"), } } } impl error::Error for ErrorKind { fn cause(&self) -> Option<&dyn error::Error> { None } } /// Describes how the image data is laid out in memory and its color space. /// /// # Note /// Not all combinations of pixel format, color space and number of planes /// describe a valid image format. /// /// Each pixel format has one or more compatible color spaces: /// /// pixel_format | color_space /// ------------------|-------------------------------------- /// PixelFormat::Argb | ColorSpace::Lrgb /// PixelFormat::Bgra | ColorSpace::Lrgb /// PixelFormat::Bgr | ColorSpace::Lrgb /// PixelFormat::Rgba | ColorSpace::Lrgb /// PixelFormat::Rgb | ColorSpace::Lrgb /// PixelFormat::I444 | ColorSpace::Bt601, ColorSpace::Bt709 /// PixelFormat::I422 | ColorSpace::Bt601, ColorSpace::Bt709 /// PixelFormat::I420 | ColorSpace::Bt601, ColorSpace::Bt709 /// PixelFormat::Nv12 | ColorSpace::Bt601, ColorSpace::Bt709 /// /// Some pixel formats might impose additional restrictions on the accepted number of /// planes and the image size: /// /// pixel_format | subsampling | w | h | #planes | #1 | #2 | #3 /// ------------------|:-----------:|:---:|:---:|:-------:|:------:|:------:|:-------: /// PixelFormat::Argb | 4:4:4 | | | 1 | argb:4 | | /// PixelFormat::Bgra | 4:4:4 | | | 1 | bgra:4 | | /// PixelFormat::Bgr | 4:4:4 | | | 1 | bgr:3 | | /// PixelFormat::Rgba | 4:4:4 | | | 1 | rgba:4 | | /// PixelFormat::Rgb | 4:4:4 | | | 1 | rgb:3 | | /// PixelFormat::I444 | 4:4:4 | | | 3 | y:1 | u:1 | v:1 /// PixelFormat::I422 | 4:2:2 | 2 | | 1, 3 | y:1 | u:1/2 | v:1/2 /// PixelFormat::I420 | 4:2:0 | 2 | 2 | 3 | y:1 | u:1/4 | v:1/4 /// PixelFormat::Nv12 | 4:2:0 | 2 | 2 | 1, 2 | y:1 | uv:1/2 | /// /// The values reported in columns `w` and `h`, when specified, indicate that the described /// image should have width and height that are multiples of the specified values #[repr(C)] pub struct ImageFormat { /// Pixel format pub pixel_format: PixelFormat, /// Color space pub color_space: ColorSpace, /// Number of planes pub num_planes: u32, } type ConvertDispatcher = fn(u32, u32, u32, &[usize], &[&[u8]], u32, &[usize], &mut [&mut [u8]]) -> bool; macro_rules! set_dispatcher { ($conv:expr, $set:ident, $src_pf:ident, $src_cs:ident, $dst_pf:ident, $dst_cs:ident, $name:ident) => { $conv[dispatcher::get_index( dispatcher::get_image_index( PixelFormat::$src_pf as u32, ColorSpace::$src_cs as u32, dispatcher::get_pixel_format_mode(PixelFormat::$src_pf as u32), ), dispatcher::get_image_index( PixelFormat::$dst_pf as u32, ColorSpace::$dst_cs as u32, dispatcher::get_pixel_format_mode(PixelFormat::$dst_pf as u32), ), )] = Some(convert_image::$set::$name) }; } macro_rules! set_dispatch_table { ($conv:expr, $set:ident) => { set_dispatcher!($conv, $set, Argb, Lrgb, Nv12, Bt601, argb_lrgb_nv12_bt601); set_dispatcher!($conv, $set, Argb, Lrgb, Nv12, Bt709, argb_lrgb_nv12_bt709); set_dispatcher!($conv, $set, Bgra, Lrgb, Nv12, Bt601, bgra_lrgb_nv12_bt601); set_dispatcher!($conv, $set, Bgra, Lrgb, Nv12, Bt709, bgra_lrgb_nv12_bt709); set_dispatcher!($conv, $set, Bgr, Lrgb, Nv12, Bt601, bgr_lrgb_nv12_bt601); set_dispatcher!($conv, $set, Bgr, Lrgb, Nv12, Bt709, bgr_lrgb_nv12_bt709); set_dispatcher!($conv, $set, Argb, Lrgb, I420, Bt601, argb_lrgb_i420_bt601); set_dispatcher!($conv, $set, Argb, Lrgb, I420, Bt709, argb_lrgb_i420_bt709); set_dispatcher!($conv, $set, Bgra, Lrgb, I420, Bt601, bgra_lrgb_i420_bt601); set_dispatcher!($conv, $set, Bgra, Lrgb, I420, Bt709, bgra_lrgb_i420_bt709); set_dispatcher!($conv, $set, Bgr, Lrgb, I420, Bt601, bgr_lrgb_i420_bt601); set_dispatcher!($conv, $set, Bgr, Lrgb, I420, Bt709, bgr_lrgb_i420_bt709); set_dispatcher!($conv, $set, Argb, Lrgb, I444, Bt601, argb_lrgb_i444_bt601); set_dispatcher!($conv, $set, Argb, Lrgb, I444, Bt709, argb_lrgb_i444_bt709); set_dispatcher!($conv, $set, Bgra, Lrgb, I444, Bt601, bgra_lrgb_i444_bt601); set_dispatcher!($conv, $set, Bgra, Lrgb, I444, Bt709, bgra_lrgb_i444_bt709); set_dispatcher!($conv, $set, Bgr, Lrgb, I444, Bt601, bgr_lrgb_i444_bt601); set_dispatcher!($conv, $set, Bgr, Lrgb, I444, Bt709, bgr_lrgb_i444_bt709); set_dispatcher!($conv, $set, Nv12, Bt601, Bgra, Lrgb, nv12_bt601_bgra_lrgb); set_dispatcher!($conv, $set, Nv12, Bt709, Bgra, Lrgb, nv12_bt709_bgra_lrgb); set_dispatcher!($conv, $set, Rgb, Lrgb, Bgra, Lrgb, rgb_lrgb_bgra_lrgb); set_dispatcher!($conv, $set, I420, Bt601, Bgra, Lrgb, i420_bt601_bgra_lrgb); set_dispatcher!($conv, $set, I420, Bt709, Bgra, Lrgb, i420_bt709_bgra_lrgb); set_dispatcher!($conv, $set, I444, Bt601, Bgra, Lrgb, i444_bt601_bgra_lrgb); set_dispatcher!($conv, $set, I444, Bt709, Bgra, Lrgb, i444_bt709_bgra_lrgb); set_dispatcher!($conv, $set, Bgra, Lrgb, Rgb, Lrgb, bgra_lrgb_rgb_lrgb); }; } struct GlobalState { init: bool, manufacturer: CpuManufacturer, set: InstructionSet, converters: [Option<ConvertDispatcher>; dispatcher::TABLE_SIZE], } static mut GLOBAL_STATE: GlobalState = GlobalState { init: false, manufacturer: CpuManufacturer::Unknown, set: InstructionSet::X86, converters: [None; dispatcher::TABLE_SIZE], }; /// Automatically initializes the library functions that are most appropriate for /// the current processor type. /// /// You should call this function before calling any other library function /// /// # Safety /// You can not use any other library function (also in other threads) while the initialization /// is in progress. Failure to do so result in undefined behaviour /// /// # Examples /// ``` /// use dcv_color_primitives as dcp; /// dcp::initialize(); /// ``` pub fn initialize() { unsafe { if GLOBAL_STATE.init { return; } } let (manufacturer, set) = get_cpu_info(); unsafe { #[cfg(any(target_arch = "x86", target_arch = "x86_64"))] match set { InstructionSet::X86 => { set_dispatch_table!(GLOBAL_STATE.converters, x86); } InstructionSet::Sse2 => { set_dispatch_table!(GLOBAL_STATE.converters, sse2); } InstructionSet::Avx2 => { set_dispatch_table!(GLOBAL_STATE.converters, avx2); } } // This is the default for arm and wasm32 targets #[cfg(all(not(target_arch = "x86"), not(target_arch = "x86_64")))] { set_dispatch_table!(GLOBAL_STATE.converters, x86); } GLOBAL_STATE.manufacturer = manufacturer; GLOBAL_STATE.set = set; GLOBAL_STATE.init = true; } } /// Returns a description of the algorithms that are best for the running cpu and /// available instruction sets /// /// # Errors /// * [`NotInitialized`] if the library was not initialized before /// /// # Examples /// ``` /// use dcv_color_primitives as dcp; /// dcp::initialize(); /// match dcp::describe_acceleration() { /// Ok(description) => println!("{}", description), /// Err(error) => println!("Unable to describe the acceleration: {}", error), /// } /// // => {cpu-manufacturer:Intel,instruction-set:Avx2} /// ``` /// /// When [`initialize`] is not called: /// ``` /// use dcv_color_primitives as dcp; /// match dcp::describe_acceleration() { /// Ok(description) => println!("{}", description), /// Err(error) => println!("Unable to describe the acceleration: {}", error), /// } /// // => Unable to describe the acceleration: NotInitialized /// ``` /// /// [`NotInitialized`]: ./enum.ErrorKind.html#variant.NotInitialized /// [`initialize`]: ./fn.initialize.html pub fn describe_acceleration() -> Result<String, ErrorKind> { unsafe { if GLOBAL_STATE.init { Ok(format!( "{{cpu-manufacturer:{:?},instruction-set:{:?}}}", GLOBAL_STATE.manufacturer, GLOBAL_STATE.set )) } else { Err(ErrorKind::NotInitialized) } } } /// Compute number of bytes required to store an image given its format, dimensions /// and optionally its strides /// /// # Arguments /// * `width` - Width of the image in pixels /// * `height` - Height of the image in pixels /// * `format` - Image format /// * `strides` - An array of distances in bytes between starts of consecutive lines /// in each image planes /// * `buffers_size` - An array describing the minimum number of bytes required in each /// image planes /// /// # Examples /// Compute how many bytes are needed to store and image of a given format and size /// assuming *all planes contain data which is tightly packed*: /// ``` /// use dcv_color_primitives as dcp; /// use dcp::{get_buffers_size, ColorSpace, ImageFormat, PixelFormat}; /// use std::error; /// /// fn compute_size_packed() -> Result<(), Box<dyn error::Error>> { /// dcp::initialize(); /// /// const WIDTH: u32 = 640; /// const HEIGHT: u32 = 480; /// const NUM_PLANES: u32 = 2; /// /// let format = ImageFormat { /// pixel_format: PixelFormat::Nv12, /// color_space: ColorSpace::Bt601, /// num_planes: NUM_PLANES, /// }; /// /// let sizes: &mut [usize] = &mut [0usize; NUM_PLANES as usize]; /// get_buffers_size(WIDTH, HEIGHT, &format, None, sizes)?; /// /// Ok(()) /// } /// ``` /// /// Compute how many bytes are needed to store and image of a given format and size /// in which *all planes have custom strides*: /// ``` /// use dcv_color_primitives as dcp; /// use dcp::{get_buffers_size, ColorSpace, ImageFormat, PixelFormat}; /// use std::error; /// /// fn compute_size_custom_strides() -> Result<(), Box<dyn error::Error>> { /// dcp::initialize(); /// /// const WIDTH: u32 = 640; /// const HEIGHT: u32 = 480; /// const NUM_PLANES: u32 = 2; /// const Y_STRIDE: usize = (WIDTH as usize) + 1; /// const UV_STRIDE: usize = (WIDTH as usize) + 3; /// /// let format = ImageFormat { /// pixel_format: PixelFormat::Nv12, /// color_space: ColorSpace::Bt601, /// num_planes: NUM_PLANES, /// }; /// /// let strides: &[usize] = &[ Y_STRIDE, UV_STRIDE, ]; /// let sizes: &mut [usize] = &mut [0usize; NUM_PLANES as usize]; /// get_buffers_size(WIDTH, HEIGHT, &format, Some(strides), sizes)?; /// /// Ok(()) /// } /// ``` /// /// Compute how many bytes are needed to store and image of a given format and size /// in which *some planes have custom strides*, while *some other are assumed to /// contain data which is tightly packed*: /// ``` /// use dcv_color_primitives as dcp; /// use dcp::{get_buffers_size, ColorSpace, ImageFormat, PixelFormat, STRIDE_AUTO}; /// use std::error; /// /// fn compute_size_custom_strides() -> Result<(), Box<dyn error::Error>> { /// dcp::initialize(); /// /// const WIDTH: u32 = 640; /// const HEIGHT: u32 = 480; /// const NUM_PLANES: u32 = 2; /// const Y_STRIDE: usize = (WIDTH as usize) + 1; /// /// let format = ImageFormat { /// pixel_format: PixelFormat::Nv12, /// color_space: ColorSpace::Bt601, /// num_planes: NUM_PLANES, /// }; /// /// let strides: &[usize] = &[ Y_STRIDE, STRIDE_AUTO, ]; /// let sizes: &mut [usize] = &mut [0usize; NUM_PLANES as usize]; /// get_buffers_size(WIDTH, HEIGHT, &format, Some(strides), sizes)?; /// /// Ok(()) /// } /// ``` /// /// Default strides (e.g. the one you would set for tightly packed data) can be set /// using the constant [`STRIDE_AUTO`] /// /// # Errors /// /// * [`InvalidValue`] if `width` or `height` violate the [`size constraints`] that might by /// imposed by the image pixel format /// /// * [`InvalidValue`] if the image format has a number of planes which is not compatible /// with its pixel format /// /// * [`NotEnoughData`] if the strides array is not `None` and its length is less than the /// image format number of planes /// /// * [`NotEnoughData`] if the buffers_sizes array is not `None` and its length is less than the /// image format number of planes /// /// [`InvalidValue`]: ./enum.ErrorKind.html#variant.NotInitialized /// [`NotEnoughData`]: ./enum.ErrorKind.html#variant.NotEnoughData /// [`size constraints`]: ./struct.ImageFormat.html#note /// [`STRIDE_AUTO`]: ./constant.STRIDE_AUTO.html pub fn get_buffers_size( width: u32, height: u32, format: &ImageFormat, strides: Option<&[usize]>, buffers_size: &mut [usize], ) -> Result<(), ErrorKind> { let pixel_format = format.pixel_format as u32; let last_plane = format.num_planes.wrapping_sub(1); if !pixel_format::is_compatible(pixel_format, width, height, last_plane) { return Err(ErrorKind::InvalidValue); } if pixel_format::get_buffers_size( pixel_format, width, height, last_plane, strides.unwrap_or(&pixel_format::DEFAULT_STRIDES), buffers_size, ) { Ok(()) } else { Err(ErrorKind::NotEnoughData) } } /// Converts from a color space to another one, applying downsampling/upsampling /// to match destination image format. /// /// # Arguments /// * `width` - Width of the image to convert in pixels /// * `height` - Height of the image to convert in pixels /// * `src_format` - Source image format /// * `src_strides` - An array of distances in bytes between starts of consecutive lines /// in each source image planes /// * `src_buffers` - An array of image buffers in each source color plane /// * `dst_format` - Destination image format /// * `dst_strides` - An array of distances in bytes between starts of consecutive lines /// in each destination image planes /// * `dst_buffers` - An array of image buffers in each destination color plane /// /// # Errors /// /// * [`NotInitialized`] if the library was not initialized before /// /// * [`InvalidValue`] if `width` or `height` violate the [`size constraints`] /// that might by imposed by the source and destination image pixel formats /// /// * [`InvalidValue`] if source or destination image formats have a number of planes /// which is not compatible with their pixel formats /// /// * [`InvalidOperation`] if there is no available method to convert the image with the /// source pixel format to the image with the destination pixel format. /// /// The list of available conversions is specified here: /// /// Source image pixel format | Supported destination image pixel formats /// ------------------------------|------------------------------------------ /// PixelFormat::Argb | PixelFormat::I420 [`1`] /// PixelFormat::Argb | PixelFormat::I444 [`1`] /// PixelFormat::Argb | PixelFormat::Nv12 [`1`] /// PixelFormat::Bgra | PixelFormat::I420 [`1`] /// PixelFormat::Bgra | PixelFormat::I444 [`1`] /// PixelFormat::Bgra | PixelFormat::Nv12 [`1`] /// PixelFormat::Bgra | PixelFormat::Rgb [`4`] /// PixelFormat::Bgr | PixelFormat::I420 [`1`] /// PixelFormat::Bgr | PixelFormat::I444 [`1`] /// PixelFormat::Bgr | PixelFormat::Nv12 [`1`] /// PixelFormat::I420 | PixelFormat::Bgra [`2`] /// PixelFormat::I444 | PixelFormat::Bgra [`2`] /// PixelFormat::Nv12 | PixelFormat::Bgra [`2`] /// PixelFormat::Rgb | PixelFormat::Bgra [`3`] /// /// * [`NotEnoughData`] if the source stride array is not `None` and its length is less than the /// source image format number of planes /// /// * [`NotEnoughData`] if the destination stride array is not `None` and its length is less than the /// destination image format number of planes /// /// * [`NotEnoughData`] if one or more source/destination buffers does not provide enough data. /// /// The minimum number of bytes to provide for each buffer depends from the image format, dimensions, /// and strides (if they are not `None`). /// /// You can compute the buffers' size using [`get_buffers_size`] /// /// # Algorithm 1 /// Conversion from linear RGB model to YCbCr color model, with 4:2:0 downsampling /// /// If the destination image color space is Bt601, the following formula is applied: /// ```text /// y = 0.257 * r + 0.504 * g + 0.098 * b + 16 /// cb = -0.148 * r - 0.291 * g + 0.439 * b + 128 /// cr = 0.439 * r - 0.368 * g - 0.071 * b + 128 /// ``` /// /// If the destination image color space is Bt709, the following formula is applied: /// ```text /// y = 0.213 * r + 0.715 * g + 0.072 * b + 16 /// cb = -0.117 * r - 0.394 * g + 0.511 * b + 128 /// cr = 0.511 * r - 0.464 * g - 0.047 * b + 128 /// ``` /// /// # Algorithm 2 /// Conversion from YCbCr model to linear RGB model, with 4:4:4 upsampling /// /// If the destination image contains an alpha channel, each component will be set to 255 /// /// If the source image color space is Bt601, the following formula is applied: /// ```text /// r = 1.164 * (y - 16) + 1.596 * (cr - 128) /// g = 1.164 * (y - 16) - 0.813 * (cr - 128) - 0.392 * (cb - 128) /// b = 1.164 * (y - 16) + 2.017 * (cb - 128) /// ``` /// /// If the source image color space is Bt709, the following formula is applied: /// ```text /// r = 1.164 * (y - 16) + 1.793 * (cr - 128) /// g = 1.164 * (y - 16) - 0.534 * (cr - 128) - 0.213 * (cb - 128) /// b = 1.164 * (y - 16) + 2.115 * (cb - 128) /// ``` /// /// # Algorithm 3 /// Conversion from RGB to BGRA /// /// # Algorithm 4 /// Conversion from BGRA to RGB /// /// [`NotInitialized`]: ./enum.ErrorKind.html#variant.NotInitialized /// [`InvalidValue`]: ./enum.ErrorKind.html#variant.InvalidValue /// [`InvalidOperation`]: ./enum.ErrorKind.html#variant.InvalidOperation /// [`NotEnoughData`]: ./enum.ErrorKind.html#variant.NotEnoughData /// [`size constraints`]: ./struct.ImageFormat.html#note /// [`get_buffers_size`]: ./fn.get_buffers_size.html /// [`1`]: ./fn.convert_image.html#algorithm-1 /// [`2`]: ./fn.convert_image.html#algorithm-2 /// [`3`]: ./fn.convert_image.html#algorithm-3 pub fn convert_image( width: u32, height: u32, src_format: &ImageFormat, src_strides: Option<&[usize]>, src_buffers: &[&[u8]], dst_format: &ImageFormat, dst_strides: Option<&[usize]>, dst_buffers: &mut [&mut [u8]], ) -> Result<(), ErrorKind> { unsafe { if !GLOBAL_STATE.init { return Err(ErrorKind::NotInitialized); } } let src_pixel_format = src_format.pixel_format as u32; let dst_pixel_format = dst_format.pixel_format as u32; let src_color_space = src_format.color_space as u32; let dst_color_space = dst_format.color_space as u32; // Cross-correlate pixel format with color space. Predicate handles Table 1 let src_pf_mode = dispatcher::get_pixel_format_mode(src_pixel_format); let src_cs_mode = dispatcher::get_color_space_mode(src_color_space); let dst_pf_mode = dispatcher::get_pixel_format_mode(dst_pixel_format); let dst_cs_mode = dispatcher::get_color_space_mode(dst_color_space); let src_pf_cs_mismatch = src_pf_mode ^ src_cs_mode; let dst_pf_cs_mismatch = dst_pf_mode ^ dst_cs_mode; if src_pf_cs_mismatch | dst_pf_cs_mismatch { return Err(ErrorKind::InvalidValue); } // Cross-correlate pixel format with planes and alignment. // wrapping_sub is wanted. If num_planes is 0, this turns in a very big number that // still represents an invalid number of planes. let last_src_plane = src_format.num_planes.wrapping_sub(1); if !pixel_format::is_compatible(src_pixel_format, width, height, last_src_plane) { return Err(ErrorKind::InvalidValue); } let last_dst_plane = dst_format.num_planes.wrapping_sub(1); if !pixel_format::is_compatible(dst_pixel_format, width, height, last_dst_plane) { return Err(ErrorKind::InvalidValue); } // Cross-correlate modes. let src_index = dispatcher::get_image_index(src_pixel_format, src_color_space, src_pf_mode); let dst_index = dispatcher::get_image_index(dst_pixel_format, dst_color_space, dst_pf_mode); let index = dispatcher::get_index(src_index, dst_index); let converters = { unsafe { &GLOBAL_STATE.converters } }; if index >= converters.len() { return Err(ErrorKind::InvalidOperation); } let converter = converters[index]; match converter { None => Err(ErrorKind::InvalidOperation), Some(image_converter) => { if image_converter( width, height, last_src_plane, src_strides.unwrap_or(&pixel_format::DEFAULT_STRIDES), src_buffers, last_dst_plane, dst_strides.unwrap_or(&pixel_format::DEFAULT_STRIDES), dst_buffers, ) { Ok(()) } else { Err(ErrorKind::NotEnoughData) } } } } #[doc(hidden)] mod c_bindings { use super::*; use pixel_format::{are_planes_compatible, MAX_NUMBER_OF_PLANES}; use std::cmp; use std::ffi::CString; use std::mem::{transmute, MaybeUninit}; use std::os::raw::c_char; use std::ptr; use std::slice; const UNBOUNDED_C_ARRAY: usize = std::isize::MAX as usize; #[repr(C)] pub enum Result { Ok, Err, } unsafe fn set_error(error: *mut ErrorKind, value: ErrorKind) -> self::Result { if !error.is_null() { *error = value; } self::Result::Err } #[no_mangle] pub extern "C" fn dcp_initialize() { initialize(); } #[no_mangle] pub extern "C" fn dcp_describe_acceleration() -> *mut c_char { match describe_acceleration() { Ok(acc) => match CString::new(acc) { Ok(s) => s.into_raw(), Err(_) => { let p: *const c_char = ptr::null(); p as *mut c_char } }, Err(_) => { let p: *const c_char = ptr::null(); p as *mut c_char } } } #[no_mangle] pub unsafe extern "C" fn dcp_unref_string(string: *mut c_char) { if !string.is_null() { let _ = CString::from_raw(string); } } #[no_mangle] pub unsafe extern "C" fn dcp_get_buffers_size( width: u32, height: u32, format: *const ImageFormat, strides: *const usize, buffers_size: *mut usize, error: *mut ErrorKind, ) -> self::Result { // Protect from C null pointers if format.is_null() || buffers_size.is_null() { return set_error(error, ErrorKind::InvalidValue); } // C enums are untrusted in the sense you can cast any value to an enum type let format = &*format; let pixel_format = format.pixel_format as u32; if !dispatcher::is_pixel_format_valid(pixel_format) { return set_error(error, ErrorKind::InvalidValue); } // We assume there is enough data in the buffers // If the assumption will not hold undefined behaviour occurs (like in C) let num_planes = format.num_planes as usize; if !are_planes_compatible(pixel_format, format.num_planes) { return set_error(error, ErrorKind::InvalidValue); } // Convert nullable type to Option let strides = if strides.is_null() { None } else { Some(slice::from_raw_parts(strides, num_planes)) }; let buffers_size = slice::from_raw_parts_mut(buffers_size, num_planes); match get_buffers_size(width, height, format, strides, buffers_size) { Ok(_) => self::Result::Ok, Err(error_kind) => set_error(error, error_kind), } } #[no_mangle] pub unsafe extern "C" fn dcp_convert_image( width: u32, height: u32, src_format: *const ImageFormat, src_strides: *const usize, src_buffers: *const *const u8, dst_format: *const ImageFormat, dst_strides: *const usize, dst_buffers: *const *mut u8, error: *mut ErrorKind, ) -> self::Result { // Protect from C null pointers if src_format.is_null() || dst_format.is_null() || src_buffers.is_null() || dst_buffers.is_null() { return set_error(error, ErrorKind::InvalidValue); } // C enums are untrusted in the sense you can cast any value to an enum type let src_format: &ImageFormat = &*src_format; let dst_format: &ImageFormat = &*dst_format; let src_pixel_format = src_format.pixel_format as u32; let dst_pixel_format = dst_format.pixel_format as u32; if !dispatcher::is_pixel_format_valid(src_pixel_format) || !dispatcher::is_pixel_format_valid(dst_pixel_format) || !dispatcher::is_color_space_valid(src_format.color_space as u32) || !dispatcher::is_color_space_valid(dst_format.color_space as u32) { return set_error(error, ErrorKind::InvalidValue); } // We assume there is enough data in the buffers // If the assumption will not hold undefined behaviour occurs (like in C) if !are_planes_compatible(src_pixel_format, src_format.num_planes) || !are_planes_compatible(dst_pixel_format, dst_format.num_planes) { return set_error(error, ErrorKind::InvalidValue); } let src_buffers = { let src_num_planes = src_format.num_planes as usize; let num_planes = cmp::min(src_num_planes, MAX_NUMBER_OF_PLANES); let mut src_buf: [MaybeUninit<&[u8]>; MAX_NUMBER_OF_PLANES] = [MaybeUninit::uninit().assume_init(); MAX_NUMBER_OF_PLANES]; for (plane_index, item) in src_buf.iter_mut().enumerate().take(num_planes) { let ptr = *src_buffers.add(plane_index); if ptr.is_null() { return set_error(error, ErrorKind::InvalidValue); } *item = MaybeUninit::new(slice::from_raw_parts(ptr, UNBOUNDED_C_ARRAY)); } transmute::<_, [&[u8]; MAX_NUMBER_OF_PLANES]>(src_buf) }; let mut dst_buffers = { let dst_num_planes = dst_format.num_planes as usize; let num_planes = cmp::min(dst_num_planes, MAX_NUMBER_OF_PLANES); let mut dst_buf: [MaybeUninit<&[u8]>; MAX_NUMBER_OF_PLANES] = [MaybeUninit::uninit().assume_init(); MAX_NUMBER_OF_PLANES]; for (plane_index, item) in dst_buf.iter_mut().enumerate().take(num_planes) { let ptr = *dst_buffers.add(plane_index); if ptr.is_null() { return set_error(error, ErrorKind::InvalidValue); } *item = MaybeUninit::new(slice::from_raw_parts_mut(ptr, UNBOUNDED_C_ARRAY)); } transmute::<_, [&mut [u8]; MAX_NUMBER_OF_PLANES]>(dst_buf) }; // Convert nullable type to Option let src_strides = if src_strides.is_null() { None } else { Some(slice::from_raw_parts(src_strides, UNBOUNDED_C_ARRAY)) }; let dst_strides = if dst_strides.is_null() { None } else { Some(slice::from_raw_parts(dst_strides, UNBOUNDED_C_ARRAY)) }; match convert_image( width, height, src_format, src_strides, &src_buffers[..], dst_format, dst_strides, &mut dst_buffers[..], ) { Ok(_) => self::Result::Ok, Err(error_kind) => set_error(error, error_kind), } } }