ICCProfile.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/ICCProfile.h - Released 2024-06-18T15:48:54Z
// ----------------------------------------------------------------------------
// 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_ICCProfile_h
#define __PCL_ICCProfile_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/ByteArray.h>
#include <pcl/Flags.h>
#include <pcl/StringList.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
namespace ICCProfileClass
{
   enum mask_type
   {
      Unknown              = 0x80000000,
      Any                  = 0x00000000,
      InputDevice          = 0x00000001,
      DisplayDevice        = 0x00000002,
      OutputDevice         = 0x00000004,
      DeviceLink           = 0x00000008,
      ColorSpaceConversion = 0x00000010,
      AbstractProfile      = 0x00000020,
      NamedColorProfile    = 0x00000040
   };
}
 
using ICCProfileClasses = Flags<ICCProfileClass::mask_type>;
 
// ----------------------------------------------------------------------------
 
namespace ICCColorSpace
{
   enum mask_type
   {
      Unknown  = 0x80000000,
      Any      = 0x00000000,
      XYZ      = 0x00000001,
      Lab      = 0x00000002,
      Luv      = 0x00000004,
      YCbCr    = 0x00000008,
      Yxy      = 0x00000010,
      RGB      = 0x00000020,
      Gray     = 0x00000040,
      HSV      = 0x00000080,
      HLS      = 0x00000100,
      CMYK     = 0x00000200,
      CMY      = 0x00000400,
      LuvK     = 0x00000800
   };
}
 
using ICCColorSpaces = Flags<ICCColorSpace::mask_type>;
 
// ----------------------------------------------------------------------------
 
namespace ICCRenderingIntent
{
   enum value_type
   {
      Perceptual,
      Saturation,
      RelativeColorimetric,
      AbsoluteColorimetric
   };
}
 
// ----------------------------------------------------------------------------
 
namespace ICCRenderingDirection
{
   enum value_type
   {
      Input,
      Output,
      Proofing
   };
}
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS ICCProfile
{
public:
 
   using handle = void*;
 
   using profile_class = ICCProfileClass::mask_type;
 
   using color_space = ICCColorSpace::mask_type;
 
   using rendering_intent = ICCRenderingIntent::value_type;
 
   using rendering_direction = ICCRenderingDirection::value_type;
 
   ICCProfile() = default;
 
   ICCProfile( const ICCProfile& ) = default;
 
   ICCProfile( ICCProfile&& ) = default;
 
   ICCProfile( const String& profilePath )
   {
      Load( profilePath );
   }
 
   ICCProfile( const ByteArray& rawData )
   {
      Set( rawData );
   }
 
   ICCProfile( const void* rawData )
   {
      Set( rawData );
   }
 
   virtual ~ICCProfile()
   {
   }
 
   ICCProfile& operator =( const ICCProfile& ) = default;
 
   ICCProfile& operator =( ICCProfile&& ) = default;
 
   bool IsProfile() const
   {
      return !m_data.IsEmpty();
   }
 
   operator bool() const
   {
      return IsProfile();
   }
 
   bool IsDiskProfile() const
   {
      return !m_path.IsEmpty();
   }
 
   bool IsSameProfile( const ICCProfile& other ) const;
 
   const ByteArray& ProfileData() const
   {
      return m_data;
   }
 
   size_type ProfileSize() const;
 
   String FilePath() const
   {
      return m_path;
   }
 
   String Description( const char* language = "en", const char* country = "US" ) const;
 
   String Manufacturer( const char* language = "en", const char* country = "US" ) const;
 
   String Model( const char* language = "en", const char* country = "US" ) const;
 
   String Copyright( const char* language = "en", const char* country = "US" ) const;
 
   void GetInformation( String& description, String& manufacturer, String& model, String& copyright,
                        const char* language = "en", const char* country = "US" ) const;
 
   profile_class Class() const;
 
   color_space ColorSpace() const;
 
   bool IsRGB() const
   {
      return ColorSpace() == ICCColorSpace::RGB;
   }
 
   bool IsGrayscale() const
   {
      return ColorSpace() == ICCColorSpace::Gray;
   }
 
   bool SupportsRenderingIntent( rendering_intent intent, rendering_direction direction ) const;
 
   bool IsEmbedded() const;
 
   void SetEmbeddedFlag( bool on = true );
 
   void ClearEmbeddedFlag()
   {
      SetEmbeddedFlag( false );
   }
 
   void Load( const String& profilePath );
 
   void Set( const ByteArray& profile );
 
   void Set( const void* rawData );
 
   void Clear()
   {
      m_data.Clear();
      m_path.Clear();
   }
 
   handle Open() const
   {
      return Open( m_data );
   }
 
   friend void Swap( ICCProfile& x1, ICCProfile& x2 )
   {
      pcl::Swap( x1.m_data, x2.m_data );
      pcl::Swap( x1.m_path, x2.m_path );
   }
 
   static handle Open( const String& profilePath );
 
   static handle Open( const void* rawData );
 
   static handle Open( const ByteArray& icc )
   {
      return Open( icc.Begin() );
   }
 
   static void Close( handle h );
 
   static bool IsValidHandle( handle h );
 
   static bool IsValidFile( const String& profilePath );
 
   static bool IsValid( const void* rawdata );
 
   static bool IsValid( const ByteArray& icc )
   {
      return IsValid( icc.Begin() );
   }
 
   static String Description( handle h, const char* language = "en", const char* country = "US" );
 
   static String Manufacturer( handle h, const char* language = "en", const char* country = "US" );
 
   static String Model( handle h, const char* language = "en", const char* country = "US" );
 
   static String Copyright( handle h, const char* language = "en", const char* country = "US" );
 
   static profile_class Class( handle h );
 
   static color_space ColorSpace( handle h );
 
   static bool SupportsRenderingIntent( handle h, rendering_intent intent, rendering_direction direction );
 
   static StringList ProfileDirectories();
 
   static StringList FindProfiles( const String& dirPath = String() );
 
   static String FindInstalledProfile( const String& description, bool exactMatch = true );
 
   static void ExtractProfileList( StringList& selectedDescriptionsList,
                                   StringList& selectedPathsList,
                                   const StringList& pathList,
                                   ICCColorSpaces spaces = ICCColorSpace::Any,
                                   ICCProfileClasses classes = ICCProfileClass::Any );
 
   // -------------------------------------------------------------------------
 
   struct Info
   {
      String description;  
      String path;         
 
      Info( const String& a_description, const String& a_path = String() )
         : description( a_description )
         , path( a_path )
      {
      }
 
      bool operator ==( const Info& x ) const
      {
         return description == x.description;
      }
 
      bool operator <( const Info& x ) const
      {
         return description < x.description;
      }
   };
 
   using profile_list = SortedArray<Info>;
 
   static profile_list FindProfilesByColorSpace( ICCColorSpaces spaces );
 
   static void ThrowErrorWithCMSInfo( const String& message );
 
private:
 
   ByteArray m_data; // ICC profile data
   String    m_path; // empty if this is an embedded or newly created profile
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_ICCProfile_h
 
// ----------------------------------------------------------------------------
// EOF pcl/ICCProfile.h - Released 2024-06-18T15:48:54Z