ICCProfileTransformation.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/ICCProfileTransformation.h - Released 2024-01-13T15:47:58Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_ICCProfileTransformation_h
#define __PCL_ICCProfileTransformation_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/Array.h>
#include <pcl/Color.h>
#include <pcl/ICCProfile.h>
#include <pcl/ImageTransformation.h>
#include <pcl/ParallelProcess.h>
 
// ----------------------------------------------------------------------------
 
#ifdef __PCL_BUILDING_PIXINSIGHT_APPLICATION
namespace pi
{
   class ImageWindow;
} // pi
#endif
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS ICCProfileTransformation : public ImageTransformation, public ParallelProcess
{
public:
 
   using rendering_intent = ICCRenderingIntent::value_type;
 
   using transformation_handle = void*;
 
   using profile_list = Array<ICCProfile::handle>;
 
   ICCProfileTransformation() = default;
 
   ICCProfileTransformation( ICCProfileTransformation&& x )
      : ImageTransformation( x )
      , ParallelProcess( x )
      , m_transformation( x.m_transformation )
      , m_profiles( std::move( x.m_profiles ) )
      , m_intent( x.m_intent )
      , m_proofingIntent( x.m_proofingIntent )
      , m_blackPointCompensation( x.m_blackPointCompensation )
      , m_forceFloatingPoint( x.m_forceFloatingPoint )
      , m_highResolutionCLUT( x.m_highResolutionCLUT )
      , m_lowResolutionCLUT( x.m_lowResolutionCLUT )
      , m_proofingTransformation( x.m_proofingTransformation )
      , m_gamutCheck( x.m_gamutCheck )
      , m_srcRGB( x.m_srcRGB )
      , m_dstRGB( x.m_dstRGB )
      , m_floatingPoint( x.m_floatingPoint )
   {
      x.m_transformation = nullptr;
   }
 
   ICCProfileTransformation& operator =( ICCProfileTransformation&& x )
   {
      (void)ImageTransformation::operator =( x );
      (void)ParallelProcess::operator =( x );
      m_transformation = x.m_transformation;
      m_profiles = std::move( x.m_profiles );
      m_intent = x.m_intent;
      m_proofingIntent = x.m_proofingIntent;
      m_blackPointCompensation = x.m_blackPointCompensation;
      m_forceFloatingPoint = x.m_forceFloatingPoint;
      m_highResolutionCLUT = x.m_highResolutionCLUT;
      m_lowResolutionCLUT = x.m_lowResolutionCLUT;
      m_proofingTransformation = x.m_proofingTransformation;
      m_gamutCheck = x.m_gamutCheck;
      m_srcRGB = x.m_srcRGB;
      m_dstRGB = x.m_dstRGB;
      m_floatingPoint = x.m_floatingPoint;
      x.m_transformation = nullptr;
      return *this;
   }
 
   ICCProfileTransformation( const ICCProfileTransformation& ) = delete;
 
   ICCProfileTransformation& operator =( const ICCProfileTransformation& ) = delete;
 
   ~ICCProfileTransformation() override
   {
      Clear();
   }
 
   void Add( const String& profilePath );
 
   void Add( const ICCProfile& profile );
 
   void Add( const ICCProfile::handle profileHandle );
 
   bool IsValid() const
   {
      return m_transformation != nullptr;
   }
 
   const profile_list& Profiles() const
   {
      return m_profiles;
   }
 
   rendering_intent RenderingIntent() const
   {
      return m_intent;
   }
 
   void SetRenderingIntent( rendering_intent i )
   {
      CloseTransformation();
      m_intent = i;
   }
 
   bool UsingBlackPointCompensation() const
   {
      return m_blackPointCompensation;
   }
 
   void EnableBlackPointCompensation( bool enable = true )
   {
      CloseTransformation();
      m_blackPointCompensation = enable;
   }
 
   void DisableBlackPointCompensation( bool disable = true )
   {
      EnableBlackPointCompensation( !disable );
   }
 
   bool ForcesFloatingPointTransformation() const
   {
      return m_forceFloatingPoint;
   }
 
   void ForceFloatingPointTransformation( bool force = true )
   {
      CloseTransformation();
      m_forceFloatingPoint = force;
   }
 
   void RelaxFloatingPointTransformation( bool relax = true )
   {
      ForceFloatingPointTransformation( !relax );
   }
 
   bool UsingHighResolutionCLUT() const
   {
      return m_highResolutionCLUT;
   }
 
   void EnableHighResolutionCLUT( bool enable = true )
   {
      CloseTransformation();
      if ( (m_highResolutionCLUT = enable) == true )
         m_lowResolutionCLUT = false;
   }
 
   void DisableHighResolutionCLUT( bool disable = true )
   {
      EnableHighResolutionCLUT( !disable );
   }
 
   bool UsingLowResolutionCLUT() const
   {
      return m_lowResolutionCLUT;
   }
 
   void EnableLowResolutionCLUT( bool enable = true )
   {
      CloseTransformation();
      if ( (m_lowResolutionCLUT = enable) == true )
         m_highResolutionCLUT = false;
   }
 
   void DisableLowResolutionCLUT( bool disable = true )
   {
      EnableLowResolutionCLUT( !disable );
   }
 
   bool IsProofingTransformation() const
   {
      return m_proofingTransformation;
   }
 
   void Create()
   {
      CreateTransformation( m_forceFloatingPoint );
   }
 
   transformation_handle Handle() const
   {
      return m_transformation;
   }
 
   void Clear();
 
   bool IsSourceRGBProfile() const
   {
      return m_srcRGB;
   }
 
   bool IsTargetRGBProfile() const
   {
      return m_dstRGB;
   }
 
protected:
 
   /*
    * Opaque handle to the profile transformation.
    */
   mutable transformation_handle m_transformation = nullptr;
 
   /*
    * The ICC profiles, rendering intents and operating parameters that define
    * this color transformation.
    */
   profile_list     m_profiles;
   rendering_intent m_intent = ICCRenderingIntent::Perceptual;
   rendering_intent m_proofingIntent = ICCRenderingIntent::AbsoluteColorimetric;
   bool             m_blackPointCompensation = false;
   bool             m_forceFloatingPoint = false;
   bool             m_highResolutionCLUT = true;
   bool             m_lowResolutionCLUT = false;
   bool             m_proofingTransformation = false;
   bool             m_gamutCheck = false;
 
   /*
    * Flags indicating source and destination color spaces.
    * ### NB: These refer to the color spaces of the source and target pixel
    * buffers, *not* to the color spaces of the profiles involved in the
    * transformation.
    */
   mutable bool     m_srcRGB = false;
   mutable bool     m_dstRGB = false;
 
   /*
    * Flag indicating whether the current transformation (if any) has been
    * created forcing floating point arithmetics.
    */
   mutable bool     m_floatingPoint = false;
 
   void AddAt( size_type, const String& );
   void AddAt( size_type, const ICCProfile& );
   void AddAt( size_type, const ICCProfile::handle );
   void AddOrReplaceAt( size_type i, const ICCProfile::handle );
 
   void CreateTransformation( bool ) const;
   void CloseTransformation() const;
 
   // Inherited from ImageTransformation
   void Apply( pcl::Image& ) const override;
   void Apply( pcl::DImage& ) const override;
   void Apply( pcl::UInt8Image& ) const override;
   void Apply( pcl::UInt16Image& ) const override;
   void Apply( pcl::UInt32Image& ) const override;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS ICCProofingTransformation : public ICCProfileTransformation
{
public:
 
   ICCProofingTransformation()
   {
      m_proofingTransformation = true;
      m_profiles.Add( static_cast<ICCProfile::handle>( nullptr ), 3 );
   }
 
   ICCProofingTransformation( ICCProofingTransformation&& ) = default;
 
   ~ICCProofingTransformation() override
   {
   }
 
   ICCProofingTransformation& operator =( ICCProofingTransformation&& ) = default;
 
   void SetSourceProfile( const String& profilePath );
 
   void SetSourceProfile( const ICCProfile& profile );
 
   void SetSourceProfile( const ICCProfile::handle profileHandle );
 
   void SetProofingProfile( const String& profilePath );
 
   void SetProofingProfile( const ICCProfile& profile );
 
   void SetProofingProfile( const ICCProfile::handle profileHandle );
 
   void SetTargetProfile( const String& profilePath );
 
   void SetTargetProfile( const ICCProfile& profile );
 
   void SetTargetProfile( const ICCProfile::handle profileHandle );
 
   rendering_intent ProofingIntent() const
   {
      return m_intent;
   }
 
   void SetProofingIntent( rendering_intent i )
   {
      CloseTransformation();
      m_proofingIntent = i;
   }
 
   bool IsGamutCheckEnabled() const
   {
      return m_gamutCheck;
   }
 
   void EnableGamutCheck( bool enable = true )
   {
      CloseTransformation();
      m_gamutCheck = enable;
   }
 
   void DisableGamutCheck( bool disable = true )
   {
      EnableGamutCheck( !disable );
   }
 
   static RGBA GamutWarningColor();
 
   static void SetGamutWarningColor( RGBA color );
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_ICCProfileTransformation_h
 
// ----------------------------------------------------------------------------
// EOF pcl/ICCProfileTransformation.h - Released 2024-01-13T15:47:58Z