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
use crate::context::Context;
use crate::*;
use std::fmt;
use std::marker::PhantomData;
use std::mem::MaybeUninit;
use std::os::raw::c_void;
/// Conversion between two ICC profiles.
///
/// The transform ensures type safety and thread safety at compile time. To do this, it has a few generic types associated with it.
/// Usually, you don't need to specify any of the generic parameters (like `InputPixelFormat`/`OutputPixelFormat`) explicitly,
/// because they are inferred from calls to constructors and `transform_pixels` or `transform_in_place`.
///
/// If you get error such as:
///
/// > cannot infer type for `InputPixelFormat`
/// > type annotations required: cannot resolve `_: std::marker::Copy`
///
/// then don't worry! Write some code that calls `transform_pixels()`,
/// because this is the function that makes the type of the transform clear.
///
/// In case you need to store the transform in a struct or return from a function, the full type of `Transform` is:
///
/// ```rust,ignore
/// Transform<InputPixelFormat, OutputPixelFormat, Context = GlobalContext, Flags = AllowCache>
/// ```
///
/// * `InputPixelFormat` — e.g. `(u8,u8,u8)` or struct `RGB<u8>`, etc.
/// The type must have appropriate number of bytes per pixel (i.e. you can't just use `[u8]` for everything).
/// * `OutputPixelFormat` — similar to `InputPixelFormat`. If both are the same, then `transform_in_place()` function works.
/// * `Context` — it's `GlobalContext` for the default non-thread-safe version, or `ThreadContext` for thread-safe version.
/// * `Flags` — `AllowCache` or `DisallowCache`. If you disallow cache, then the transform will be accessible from multiple threads.
///
/// Thread-safety:
///
/// * Transform is `Send` if you create it with `ThreadContext` (use `new_*_context()` functions).
/// * Transform is `Sync` if you create it without cache. Set flags to `Flags::NO_CACHE`.
///
#[repr(transparent)]
pub struct Transform<InputPixelFormat, OutputPixelFormat, Context = GlobalContext, Flags = AllowCache> {
pub(crate) handle: ffi::HTRANSFORM,
_from: PhantomData<InputPixelFormat>,
_to: PhantomData<OutputPixelFormat>,
_context_ref: PhantomData<Context>,
_flags_ref: PhantomData<Flags>,
}
unsafe impl<F, T, C: Send, Z> Send for Transform<F, T, C, Z> {}
unsafe impl<F, T, C: Send> Sync for Transform<F, T, C, DisallowCache> {}
impl<InputPixelFormat: Copy + Pod, OutputPixelFormat: Copy + Pod> Transform<InputPixelFormat, OutputPixelFormat, GlobalContext, AllowCache> {
/// Creates a color transform for translating bitmaps.
///
/// Pixel types used in later `transform_pixels` calls must be either arrays or `Pod` `#[repr(C)]` structs that have appropriate number of bytes per pixel,
/// or `u8` specifically. `[u8]` slices are treated as a special case that is allowed for any pixel type.
///
/// Basic, non-tread-safe version.
///
/// * Input: Handle to a profile object capable to work in input direction
/// * `InputFormat`: A bit-field format specifier
/// * Output: Handle to a profile object capable to work in output direction
/// * `OutputFormat`: A bit-field format specifier
/// * Intent: Rendering intent
///
/// See documentation of these types for more detail.
#[inline]
pub fn new(input: &Profile,
in_format: PixelFormat,
output: &Profile,
out_format: PixelFormat,
intent: Intent) -> LCMSResult<Self> {
Self::new_flags(input, in_format, output, out_format, intent, Flags::default())
}
/// Non-thread-safe. See [`Transform::new`].
#[inline]
pub fn new_flags<Fl: CacheFlag>(input: &Profile,
in_format: PixelFormat,
output: &Profile,
out_format: PixelFormat,
intent: Intent,
flags: Flags<Fl>)
-> LCMSResult<Self> {
Self::new_flags_context(GlobalContext::new(), input, in_format, output, out_format, intent, flags.allow_cache())
}
/// A proofing transform does emulate the colors that would appear as the image were rendered on a specific device.
/// The obtained transform emulates the device described by the "Proofing" profile. Useful to preview final result without rendering to the physical medium.
///
/// That is, for example, with a proofing transform I can see how will look a photo of my little daughter if rendered on my HP printer. Since most printer profiles does include some sort of gamut-remapping, it is likely colors will not look as the original. Using a proofing transform, it can be done by using the appropriate function. Note that this is an important feature for final users, it is worth of all color-management stuff if the final media is not cheap.
///
/// To enable proofing and gamut check you need to include following flags:
///
/// * `Flags::GAMUTCHECK`: Color out of gamut are flagged to a fixed color defined by the function `cmsSetAlarmCodes`
/// * `Flags::SOFTPROOFING`: does emulate the Proofing device.
///
/// Pixel types used in later `transform_pixels` calls must be either arrays or `Pod` `#[repr(C)]` structs that have appropriate number of bytes per pixel,
/// or `u8` specifically. `[u8]` slices are treated as a special case that is allowed for any pixel type.
#[inline]
pub fn new_proofing(input: &Profile, in_format: PixelFormat,
output: &Profile, out_format: PixelFormat,
proofing: &Profile, intent: Intent, proofng_intent: Intent,
flags: Flags)
-> LCMSResult<Self> {
Self::new_proofing_context(GlobalContext::new(), input, in_format, output, out_format, proofing, intent, proofng_intent, flags)
}
/// Multiprofile transforms
///
/// User passes in an array of handles to open profiles. The returned color transform do "smelt" all profiles in a single devicelink.
/// Color spaces must be paired with the exception of Lab/XYZ, which can be interchanged.
///
/// Pixel types used in later `transform_pixels` calls must be either arrays or `Pod` `#[repr(C)]` structs that have appropriate number of bytes per pixel,
/// or `u8` specifically. `[u8]` slices are treated as a special case that is allowed for any pixel type.
#[inline]
pub fn new_multiprofile(profiles: &[&Profile], in_format: PixelFormat, out_format: PixelFormat, intent: Intent, flags: Flags) -> LCMSResult<Self> {
Self::new_multiprofile_context(GlobalContext::new(), profiles, in_format, out_format, intent, flags)
}
}
impl<PixelFormat: Copy + Pod, Ctx: Context, Fl: CacheFlag> Transform<PixelFormat, PixelFormat, Ctx, Fl> {
/// Read pixels and write them back to the same slice. Input and output pixel types must be identical.
///
/// This processes up to `u32::MAX` pixels.
///
/// Pixel types must be either arrays or `Pod` `#[repr(C)]` structs that have appropriate number of bytes per pixel,
/// or `u8` specifically. `[u8]` slices are treated as a special case that is allowed for any pixel type.
/// When `[u8]` is used, it will panic if the byte length of the slice is not a round number of pixels.
#[inline]
#[track_caller]
pub fn transform_in_place(&self, srcdst: &mut [PixelFormat]) {
let num_pixels = self.num_pixels(srcdst.len(), srcdst.len());
unsafe {
ffi::cmsDoTransform(self.handle,
srcdst.as_ptr().cast::<c_void>(),
srcdst.as_mut_ptr().cast::<c_void>(),
num_pixels);
}
}
}
impl<InputPixelFormat: Copy + Pod, OutputPixelFormat: Copy + Pod, Ctx: Context> Transform<InputPixelFormat, OutputPixelFormat, Ctx, AllowCache> {
// Same as `new()`, but allows specifying thread-safe context (enables `Send`)
//
// For `Sync`, see `new_flags_context` and `Flags::NO_CACHE`
#[inline]
pub fn new_context(context: impl AsRef<Ctx>, input: &Profile<Ctx>, in_format: PixelFormat,
output: &Profile<Ctx>, out_format: PixelFormat, intent: Intent) -> LCMSResult<Self> {
Self::new_flags_context(context, input, in_format, output, out_format, intent, Flags::default())
}
}
impl<InputPixelFormat: Copy + Pod, OutputPixelFormat: Copy + Pod, Ctx: Context, Fl: CacheFlag> Transform<InputPixelFormat, OutputPixelFormat, Ctx, Fl> {
#[inline]
unsafe fn new_handle(handle: ffi::HTRANSFORM) -> LCMSResult<Self> {
if handle.is_null() {
Err(Error::ObjectCreationError)
} else {
Ok(Transform {
handle,
_from: PhantomData,
_to: PhantomData,
_context_ref: PhantomData,
_flags_ref: PhantomData,
})
}
}
#[track_caller]
fn check_formats(in_format: PixelFormat, out_format: PixelFormat) {
Self::check_format::<InputPixelFormat>(in_format, true);
Self::check_format::<OutputPixelFormat>(out_format, false);
}
#[track_caller]
fn check_format<P: Copy + Pod>(format: PixelFormat, input: bool) {
let io = if input {"input"} else {"output"};
assert!(!format.planar(), "Planar {format:?} {io} format not supported");
// Special-case u8
if is_u8::<P>() {
return;
}
assert_eq!(format.bytes_per_pixel(),
std::mem::size_of::<P>(),
"{format:?} has {} bytes per pixel, but the {io} format has {}",
format.bytes_per_pixel(),
std::mem::size_of::<P>());
}
/// Description of the input pixel format this transform has been created for
#[inline]
#[must_use] pub fn input_pixel_format(&self) -> PixelFormat {
unsafe { ffi::cmsGetTransformInputFormat(self.handle) }
}
/// Description of the output pixel format this transform has been created for
#[inline]
#[must_use] pub fn output_pixel_format(&self) -> PixelFormat {
unsafe { ffi::cmsGetTransformOutputFormat(self.handle) }
}
#[inline]
#[track_caller]
fn num_pixels(&self, mut src_len: usize, mut dst_len: usize) -> u32 {
if is_u8::<InputPixelFormat>() {
let bpp = self.input_pixel_format().bytes_per_pixel();
if bpp > 1 {
assert_eq!(0, src_len % bpp, "Input [u8] slice's length {src_len} is not a multiple of {bpp}");
src_len /= bpp;
}
}
if is_u8::<OutputPixelFormat>() {
let bpp = self.output_pixel_format().bytes_per_pixel();
if bpp > 1 {
assert_eq!(0, dst_len % bpp, "Output [u8] slice's length {dst_len} is not a multiple of {bpp}");
dst_len /= bpp;
}
}
src_len.min(dst_len).min(u32::MAX as usize) as u32
}
/// This function translates bitmaps according of parameters setup when creating the color transform.
///
/// If slices differ in length, the smaller amount of pixels is processed.
/// This processes up to `u32::MAX` pixels.
///
/// Pixel types must be either arrays or `Pod` `#[repr(C)]` structs that have appropriate number of bytes per pixel,
/// or `u8` specifically. `[u8]` slices are treated as a special case that is allowed for any pixel type.
/// When `[u8]` is used, it will panic if the byte length of the slice is not a round number of pixels.
#[inline]
#[track_caller]
pub fn transform_pixels(&self, src: &[InputPixelFormat], dst: &mut [OutputPixelFormat]) {
let num_pixels = self.num_pixels(src.len(), dst.len());
unsafe {
ffi::cmsDoTransform(self.handle,
src.as_ptr().cast::<c_void>(),
dst.as_mut_ptr().cast::<c_void>(),
num_pixels);
}
}
/// This function translates bitmaps according of parameters setup when creating the color transform.
///
/// It allows destination to be uninitailized, and returns the same slice, initialized.
///
/// # Panics
///
/// If the source slice is shorter than the destination, or larger than `u32::MAX`.
/// When `[u8]` is used, it will panic if the byte length of the slice is not a round number of pixels.
#[inline]
#[track_caller]
pub fn transform_pixels_uninit<'dst>(&self, src: &[InputPixelFormat], dst: &'dst mut [MaybeUninit<OutputPixelFormat>]) -> &'dst mut [OutputPixelFormat] {
let num_pixels = self.num_pixels(src.len(), dst.len());
assert_eq!(num_pixels as usize, dst.len());
unsafe {
ffi::cmsDoTransform(self.handle,
src.as_ptr().cast::<c_void>(),
dst.as_mut_ptr().cast::<c_void>(),
num_pixels);
// assume_init for slices is currently still unstable
std::mem::transmute::<&'dst mut [MaybeUninit<OutputPixelFormat>], &'dst mut [OutputPixelFormat]>(dst)
}
}
#[inline]
#[track_caller]
pub fn new_flags_context(context: impl AsRef<Ctx>, input: &Profile<Ctx>, in_format: PixelFormat,
output: &Profile<Ctx>, out_format: PixelFormat,
intent: Intent, flags: Flags<Fl>)
-> LCMSResult<Self> {
Self::check_formats(in_format, out_format);
unsafe {
Self::new_handle(ffi::cmsCreateTransformTHR(context.as_ref().as_ptr(),
input.handle, in_format,
output.handle, out_format,
intent, flags.bits()))
}
}
#[inline]
#[track_caller]
pub fn new_proofing_context(context: impl AsRef<Ctx>, input: &Profile<Ctx>, in_format: PixelFormat,
output: &Profile<Ctx>, out_format: PixelFormat,
proofing: &Profile<Ctx>, intent: Intent, proofng_intent: Intent,
flags: Flags<Fl>)
-> LCMSResult<Self> {
Self::check_formats(in_format, out_format);
unsafe {
Self::new_handle(ffi::cmsCreateProofingTransformTHR(context.as_ref().as_ptr(), input.handle, in_format,
output.handle, out_format,
proofing.handle, intent, proofng_intent, flags.bits()))
}
}
#[inline]
#[track_caller]
pub fn new_multiprofile_context(context: impl AsRef<Ctx>, profiles: &[&Profile<Ctx>],
in_format: PixelFormat, out_format: PixelFormat, intent: Intent, flags: Flags<Fl>) -> LCMSResult<Self> {
Self::check_formats(in_format, out_format);
let mut handles: Vec<_> = profiles.iter().map(|p| p.handle).collect();
unsafe {
Self::new_handle(
ffi::cmsCreateMultiprofileTransformTHR(context.as_ref().as_ptr(), handles.as_mut_ptr(), handles.len() as u32, in_format, out_format, intent, flags.bits()),
)
}
}
}
impl<F, T, C, L> Transform<F, T, C, L> {
#[inline]
#[must_use]
pub fn input_format(&self) -> PixelFormat {
unsafe { ffi::cmsGetTransformInputFormat(self.handle) as PixelFormat }
}
#[inline]
#[must_use]
pub fn output_format(&self) -> PixelFormat {
unsafe { ffi::cmsGetTransformOutputFormat(self.handle) as PixelFormat }
}
}
impl<F, T, L> Transform<F, T, GlobalContext, L> {
/// Adaptation state for absolute colorimetric intent, on all but `cmsCreateExtendedTransform`.
///
/// See `ThreadContext::adaptation_state()`
#[inline]
#[must_use]
pub fn global_adaptation_state() -> f64 {
unsafe { ffi::cmsSetAdaptationState(-1.) }
}
/// Sets adaptation state for absolute colorimetric intent, on all but `cmsCreateExtendedTransform`.
/// Little CMS can handle incomplete adaptation states.
///
/// See `ThreadContext::set_adaptation_state()`
///
/// Degree on adaptation 0=Not adapted, 1=Complete adaptation, in-between=Partial adaptation.
#[deprecated(note = "Use `ThreadContext::set_adaptation_state()`")]
pub fn set_global_adaptation_state(value: f64) {
unsafe {
ffi::cmsSetAdaptationState(value);
}
}
/// Sets the global codes used to mark out-out-gamut on Proofing transforms. Values are meant to be encoded in 16 bits.
/// `AlarmCodes`: Array [16] of codes. ALL 16 VALUES MUST BE SPECIFIED, set to zero unused channels.
///
/// See `ThreadContext::set_alarm_codes()`
#[deprecated(note = "Use `ThreadContext::set_alarm_codes()`")]
pub fn set_global_alarm_codes(codes: [u16; ffi::MAXCHANNELS]) {
unsafe { ffi::cmsSetAlarmCodes(codes.as_ptr()) }
}
/// Gets the current global codes used to mark out-out-gamut on Proofing transforms. Values are meant to be encoded in 16 bits.
///
/// See `ThreadContext::alarm_codes()`
#[must_use]
pub fn global_alarm_codes() -> [u16; ffi::MAXCHANNELS] {
let mut tmp = [0u16; ffi::MAXCHANNELS];
unsafe {
ffi::cmsGetAlarmCodes(tmp.as_mut_ptr());
}
tmp
}
}
fn is_u8<P: 'static>() -> bool {
std::mem::size_of::<P>() == 1 && std::mem::align_of::<P>() == 1 && std::any::TypeId::of::<P>() == std::any::TypeId::of::<u8>()
}
impl<F, T, C, L> Drop for Transform<F, T, C, L> {
fn drop(&mut self) {
unsafe {
ffi::cmsDeleteTransform(self.handle);
}
}
}
impl<F, T, C, L> fmt::Debug for Transform<F, T, C, L> {
#[cold]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let mut s = f.debug_struct(&format!(
"Transform<{}, {}, {}, {}>",
std::any::type_name::<F>(),
std::any::type_name::<T>(),
std::any::type_name::<C>(),
std::any::type_name::<L>(),
));
s.field("input_format", &self.input_format());
s.field("output_format", &self.output_format());
s.finish()
}
}