CIccTagEmbeddedProfile Class Reference

Class: IccTagEmbeddedProfile. More...

#include <IccTagEmbedIcc.h>

Inheritance diagram for CIccTagEmbeddedProfile:

Collaboration diagram for CIccTagEmbeddedProfile:

Public Member Functions
	CIccTagEmbeddedProfile ()
	Name: CIccTagEmbedProfile::CIccTagEmbedProfile.
	CIccTagEmbeddedProfile (const CIccTagEmbeddedProfile &ITU)
	Name: CIccTagEmbedProfile::CIccTagEmbedProfile.
virtual void	Describe (std::string &sDescription, int nVerboseness)
	Name: CIccTagEmbedProfile::Describe.
virtual const icChar *	GetClassName () const
virtual CIccProfile *	GetProfile () const
virtual icTagTypeSignature	GetType () const
	Function: GetType()
virtual bool	IsSupported ()
	Function: IsSupported(size, pIO) - Check if tag fully supported for apply purposes.
virtual CIccTag *	NewCopy () const
	Function: NewCopy(sDescription) Each derived tag will implement it's own NewCopy() function.
CIccTagEmbeddedProfile &	operator= (const CIccTagEmbeddedProfile &UnknownTag)
	Name: CIccTagEmbedProfile::operator=.
virtual bool	Read (icUInt32Number size, CIccIO *pIO)
	Function: Read(size, pIO) - Read tag from file.
virtual bool	Read (icUInt32Number size, CIccIO *pIO, CIccProfile *pProfile)
	Name: CIccTagEmbedProfile::Read.
virtual bool	ReadAll ()
	Name: CIccTagEmbedProfile::ReadAll.
virtual icValidateStatus	Validate (std::string sigPath, std::string &sReport, const CIccProfile *pProfile=NULL) const
	Name: CIccTagEmbedProfile::Validate.
virtual bool	Write (CIccIO *pIO)
	Name: CIccTagEmbedProfile::Write.
virtual	~CIccTagEmbeddedProfile ()
	Name: CIccTagEmbedProfile::~CIccTagEmbedProfile.
Public Member Functions inherited from CIccTag
	CIccTag ()
	Name: CIccTag::CIccTag.
virtual void	DetachIO ()
	Function: ReadAll() - Read All sub data for tag from file.
virtual IIccExtensionTag *	GetExtension ()
virtual icArraySignature	GetTagArrayType () const
virtual icStructSignature	GetTagStructType () const
virtual bool	IsArrayType ()
virtual bool	IsMBBType ()
virtual bool	IsNumArrayType () const
virtual	~CIccTag ()
	Name: CIccTag::CIccTag.

Public Attributes
CIccProfile *	m_pProfile
Public Attributes inherited from CIccTag
icUInt32Number	m_nReserved

Additional Inherited Members
Static Public Member Functions inherited from CIccTag
static CIccTag *	Create (icTagTypeSignature sig)
	Name: CIccTag::Create.

Detailed Description

Class: IccTagEmbeddedProfile.

Purpose: This "private" tag is used to embed a profile within a profile allowing for v5 profiles to be embedded in v2/v4 profiles

Definition at line 84 of file IccTagEmbedIcc.h.

Constructor & Destructor Documentation

CIccTagEmbeddedProfile() [1/2]

CIccTagEmbeddedProfile::CIccTagEmbeddedProfile

(

)

Name: CIccTagEmbedProfile::CIccTagEmbedProfile.

Purpose: Constructor

Definition at line 93 of file IccTagEmbedIcc.cpp.

{
  m_pProfile = NULL;
}

References m_pProfile.

CIccTagEmbeddedProfile() [2/2]

CIccTagEmbeddedProfile::CIccTagEmbeddedProfile

(

const CIccTagEmbeddedProfile &

ITEP

)

Name: CIccTagEmbedProfile::CIccTagEmbedProfile.

Purpose: Copy Constructor

Args: ITU = The CIccTagEmbedProfile object to be copied

Definition at line 108 of file IccTagEmbedIcc.cpp.

{
  if (ITEP.m_pProfile) {
    m_pProfile = ITEP.m_pProfile->NewCopy();
  }
  else
    m_pProfile = NULL;
}

References m_pProfile.

~CIccTagEmbeddedProfile()

CIccTagEmbeddedProfile::~CIccTagEmbeddedProfile ( )

virtual

Name: CIccTagEmbedProfile::~CIccTagEmbedProfile.

Purpose: Destructor

Definition at line 150 of file IccTagEmbedIcc.cpp.

{
  if (m_pProfile)
    delete m_pProfile;
}

References m_pProfile.

Member Function Documentation

Describe()

void CIccTagEmbeddedProfile::Describe ( std::string & sDescription, int nVerboseness )

virtual

Name: CIccTagEmbedProfile::Describe.

Purpose: Dump data associated with unknown tag to a string

Args: sDescription - string to concatenate tag dump to

Reimplemented from CIccTag.

Definition at line 308 of file IccTagEmbedIcc.cpp.

{
  if (m_pProfile) {
    sDescription += "Embedded profile in Tag\n";
 
    // Code below is copied from iccDumpProfile.cpp
    icHeader* pHdr = &m_pProfile->m_Header;
    CIccInfo Fmt;
    char buf[180];
 
    if (Fmt.IsProfileIDCalculated(&pHdr->profileID)) {
        sDescription += "Profile ID:         %s\n";
        sDescription += Fmt.GetProfileID(&pHdr->profileID);
    }
    else
        sDescription += "Profile ID:         Profile ID not calculated.\n";
    sDescription += "Size:               ";
    sprintf(buf, "%d(0x%x) bytes\n", pHdr->size, pHdr->size);
    sDescription += buf;
    sDescription += "\nHeader\n";
    sDescription += "------\n";
    sprintf(buf, "Attributes:         %s\n", Fmt.GetDeviceAttrName(pHdr->attributes));
    sDescription += buf;
    sprintf(buf, "Cmm:                %s\n", Fmt.GetCmmSigName((icCmmSignature)(pHdr->cmmId)));
    sDescription += buf;
    sprintf(buf, "Creation Date:      %d/%d/%d  %02u:%02u:%02u\n",
        pHdr->date.month, pHdr->date.day, pHdr->date.year,
        pHdr->date.hours, pHdr->date.minutes, pHdr->date.seconds);
    sDescription += buf;
    sprintf(buf, "Creator:            %s\n", icGetSig(buf, pHdr->creator));
    sDescription += buf;
    sprintf(buf, "Data Color Space:   %s\n", Fmt.GetColorSpaceSigName(pHdr->colorSpace));
    sDescription += buf;
    sprintf(buf, "Flags               %s\n", Fmt.GetProfileFlagsName(pHdr->flags));
    sDescription += buf;
    sprintf(buf, "PCS Color Space:    %s\n", Fmt.GetColorSpaceSigName(pHdr->pcs));
    sDescription += buf;
    sprintf(buf, "Platform:           %s\n", Fmt.GetPlatformSigName(pHdr->platform));
    sDescription += buf;
    sprintf(buf, "Rendering Intent:   %s\n", Fmt.GetRenderingIntentName((icRenderingIntent)(pHdr->renderingIntent)));
    sDescription += buf;
    sprintf(buf, "Profile Class:      %s\n", Fmt.GetProfileClassSigName(pHdr->deviceClass));
    sDescription += buf;
    if (pHdr->deviceSubClass) {
        sprintf(buf, "Profile SubClass:   %s\n", icGetSig(buf, pHdr->deviceSubClass));
        sDescription += buf;
    }
    else
        sDescription += "Profile SubClass:   Not Defined\n";
    sprintf(buf, "Version:            %s\n", Fmt.GetVersionName(pHdr->version));
    sDescription += buf;
    if (pHdr->version >= icVersionNumberV5 && pHdr->deviceSubClass) {
       sprintf(buf, "SubClass Version:   %s\n", Fmt.GetSubClassVersionName(pHdr->version));
       sDescription += buf;
    }
    sprintf(buf, "Illuminant:         X=%.4lf, Y=%.4lf, Z=%.4lf\n",
      icFtoD(pHdr->illuminant.X),
      icFtoD(pHdr->illuminant.Y),
      icFtoD(pHdr->illuminant.Z));
    sDescription += buf;
    sprintf(buf, "Spectral PCS:       %s\n", Fmt.GetSpectralColorSigName(pHdr->spectralPCS));
    sDescription += buf;
    if (pHdr->spectralRange.start || pHdr->spectralRange.end || pHdr->spectralRange.steps) {
      sprintf(buf, "Spectral PCS Range: start=%.1fnm, end=%.1fnm, steps=%d\n",
         icF16toF(pHdr->spectralRange.start),
         icF16toF(pHdr->spectralRange.end),
         pHdr->spectralRange.steps);
      sDescription += buf;
    }
    else {
      sDescription += "Spectral PCS Range: Not Defined\n";
    }
 
    if (pHdr->biSpectralRange.start || pHdr->biSpectralRange.end || pHdr->biSpectralRange.steps) {
      sprintf(buf, "BiSpectral Range:     start=%.1fnm, end=%.1fnm, steps=%d\n",
            icF16toF(pHdr->biSpectralRange.start),
            icF16toF(pHdr->biSpectralRange.end),
            pHdr->biSpectralRange.steps);
      sDescription += buf;
    }
    else {
      sDescription += "BiSpectral Range:   Not Defined\n";
    }
    if (pHdr->mcs) {
      sprintf(buf, "MCS Color Space:    %s\n", Fmt.GetColorSpaceSigName((icColorSpaceSignature)pHdr->mcs));
      sDescription += buf;
    }
    else {
      sDescription += "MCS Color Space:    Not Defined\n";
    }
 
    sDescription += "\nProfile Tags\n";
    sDescription += "------------\n";
 
    sprintf(buf, "%28s    ID    %8s\t%8s\t%8s\n", "Tag", "Offset", "Size", "Pad");
    sDescription += buf;
    sprintf(buf, "%28s  ------  %8s\t%8s\t%8s\n", "----", "------", "----", "---");
    sDescription += buf;
 
    int n, closest, pad;
    TagEntryList::iterator i, j;
 
    // n is number of Tags in Tag Table
    for (n = 0, i = m_pProfile->m_Tags->begin(); i != m_pProfile->m_Tags->end(); i++, n++) {
        // Find closest tag after this tag, by scanning all offsets of other tags 
        closest = pHdr->size;
        for (j = m_pProfile->m_Tags->begin(); j != m_pProfile->m_Tags->end(); j++) {
            if ((i != j) && (j->TagInfo.offset >= i->TagInfo.offset + i->TagInfo.size) && ((int)j->TagInfo.offset <= closest)) {
                closest = j->TagInfo.offset;
            }
        }
        // Number of actual padding bytes between this tag and closest neighbour (or EOF)
        // Should be 0-3 if compliant. Negative number if tags overlap!
        pad = closest - i->TagInfo.offset - i->TagInfo.size;
 
        sprintf(buf, "%28s  %s  %8d\t%8d\t%8d\n", Fmt.GetTagSigName(i->TagInfo.sig),
            icGetSig(buf, i->TagInfo.sig, false), i->TagInfo.offset, i->TagInfo.size, pad);
        sDescription += buf;
    }
  }
  else {
    sDescription += "No profile embedded in Tag\n";
  }
}

References icHeader::attributes, icHeader::biSpectralRange, icHeader::cmmId, icHeader::colorSpace, icHeader::creator, icHeader::date, icDateTimeNumber::day, icHeader::deviceClass, icHeader::deviceSubClass, icSpectralRange::end, icHeader::flags, CIccInfo::GetCmmSigName(), CIccInfo::GetColorSpaceSigName(), CIccInfo::GetDeviceAttrName(), CIccInfo::GetPlatformSigName(), CIccInfo::GetProfileClassSigName(), CIccInfo::GetProfileFlagsName(), CIccInfo::GetProfileID(), CIccInfo::GetRenderingIntentName(), CIccInfo::GetSpectralColorSigName(), CIccInfo::GetSubClassVersionName(), CIccInfo::GetTagSigName(), CIccInfo::GetVersionName(), icDateTimeNumber::hours, icF16toF(), icFtoD(), icGetSig(), icVersionNumberV5, icHeader::illuminant, CIccInfo::IsProfileIDCalculated(), m_pProfile, icHeader::mcs, icDateTimeNumber::minutes, icDateTimeNumber::month, icHeader::pcs, icHeader::platform, icHeader::profileID, icHeader::renderingIntent, icDateTimeNumber::seconds, icHeader::size, icHeader::spectralPCS, icHeader::spectralRange, icSpectralRange::start, icSpectralRange::steps, icHeader::version, icXYZNumber::X, icXYZNumber::Y, icDateTimeNumber::year, and icXYZNumber::Z.

Here is the call graph for this function:

GetClassName()

virtual const icChar * CIccTagEmbeddedProfile::GetClassName ( ) const

inlinevirtual

Reimplemented from CIccTag.

Definition at line 96 of file IccTagEmbedIcc.h.

{ return "CIccTagEmbeddedProfile"; }

GetProfile()

virtual CIccProfile * CIccTagEmbeddedProfile::GetProfile ( ) const

inlinevirtual

Definition at line 98 of file IccTagEmbedIcc.h.

{ return m_pProfile; }

GetType()

virtual icTagTypeSignature CIccTagEmbeddedProfile::GetType ( ) const

inlinevirtual

Function: GetType()

Purpose: Get Tag Type. Each derived tag will implement it's own GetType() function.

Reimplemented from CIccTag.

Definition at line 95 of file IccTagEmbedIcc.h.

{ return icSigEmbeddedProfileType; }

References icSigEmbeddedProfileType.

Referenced by Read(), and Write().

Here is the caller graph for this function:

IsSupported()

virtual bool CIccTagEmbeddedProfile::IsSupported ( )

inlinevirtual

Function: IsSupported(size, pIO) - Check if tag fully supported for apply purposes.

By Default inherited classes are supported. Unknown tag types are not supported.

Returns true if tag type is supported.

Reimplemented from CIccTag.

Definition at line 93 of file IccTagEmbedIcc.h.

{ return true; }

NewCopy()

virtual CIccTag * CIccTagEmbeddedProfile::NewCopy ( ) const

inlinevirtual

Function: NewCopy(sDescription) Each derived tag will implement it's own NewCopy() function.

Parameter(s): none

Returns a new CIccTag object that is a copy of this object.

Reimplemented from CIccTag.

Definition at line 90 of file IccTagEmbedIcc.h.

{ return new CIccTagEmbeddedProfile(*this); }

operator=()

CIccTagEmbeddedProfile & CIccTagEmbeddedProfile::operator=

(

const CIccTagEmbeddedProfile &

ITEP

)

Name: CIccTagEmbedProfile::operator=.

Purpose: Copy Operator

Args: UnknownTag = The CIccTagEmbedProfile object to be copied

Definition at line 127 of file IccTagEmbedIcc.cpp.

{
  if (&ITEP == this)
    return *this;
 
  if (m_pProfile)
    delete m_pProfile;
 
  if (ITEP.m_pProfile)
    m_pProfile = ITEP.m_pProfile->NewCopy();
  else
    m_pProfile = NULL;
 
  return *this;
}

References m_pProfile.

Read() [1/2]

virtual bool CIccTagEmbeddedProfile::Read ( icUInt32Number size, CIccIO * pIO )

inlinevirtual

Function: Read(size, pIO) - Read tag from file.

Each derived tag will implement it's own Read() function.

Parameter(s): size - number of bytes in tag including the type signature. pIO - IO object used to read in tag. The IO object should already be initialized to point to the begining of the tag.

Returns true if Read is successful.

Reimplemented from CIccTag.

Definition at line 100 of file IccTagEmbedIcc.h.

{ return Read(size, pIO, NULL); }

References Read().

Referenced by Read().

Here is the call graph for this function:

Here is the caller graph for this function:

Read() [2/2]

bool CIccTagEmbeddedProfile::Read ( icUInt32Number size, CIccIO * pIO, CIccProfile * pProfile )

virtual

Name: CIccTagEmbedProfile::Read.

Purpose: Read in an unknown tag type into a data block

Args: size - # of bytes in tag, pIO - IO object to read tag from pProfile - pProfile object calling read

Return: true = successful, false = failure

Reimplemented from CIccTag.

Definition at line 172 of file IccTagEmbedIcc.cpp.

{
  if (size<sizeof(icTagTypeSignature) || !pIO) {
    return false;
  }
 
  icTagTypeSignature nType;
 
  if (!pIO->Read32(&nType))
    return false;
  
  if (nType != GetType())
    return false;
 
  size = size - sizeof(icTagTypeSignature);
 
  if (size < sizeof(m_nReserved))
    return false;
 
  if (!pIO->Read32(&m_nReserved))
    return false;
 
  size = size - sizeof(m_nReserved);
 
  CIccEmbedIO *pEmbedIO = new CIccEmbedIO();
 
  if (!pEmbedIO->Attach(pIO, size)) {
    delete pEmbedIO;
    return false;
  }
 
  if (m_pProfile)
    delete m_pProfile;
 
  m_pProfile = pProfile ? pProfile->NewProfile() : new CIccProfile();
 
  if (pProfile && pProfile->HasIO()) {
    if (!m_pProfile->Attach(pEmbedIO)) {
      delete pEmbedIO;
      delete m_pProfile;
      m_pProfile = NULL;
 
      return false;
    }
  }
  else {
    bool stat = m_pProfile->Read(pEmbedIO);
    delete pEmbedIO;
 
    if (!stat) {
      delete m_pProfile;
      m_pProfile = NULL;
 
      return false;
    }
 
    return stat;
  }
 
  return true;
}

References GetType(), CIccTag::m_nReserved, m_pProfile, and CIccIO::Read32().

Here is the call graph for this function:

ReadAll()

bool CIccTagEmbeddedProfile::ReadAll ( )

virtual

Name: CIccTagEmbedProfile::ReadAll.

Purpose: Read all tags associated with the embedded profile

Return: true = successful, false = failure

Reimplemented from CIccTag.

Definition at line 245 of file IccTagEmbedIcc.cpp.

{
  if (!m_pProfile)
    return true;
 
  return m_pProfile->ReadTags(m_pProfile);
}

References m_pProfile.

Validate()

icValidateStatus CIccTagEmbeddedProfile::Validate ( std::string sigPath, std::string & sReport, const CIccProfile * pProfile = NULL ) const

virtual

Name: CIccTagEmbedProfile::Validate.

Purpose: Check tag data validity. In base class we only look at the tag's reserved data value

Args: sig = signature of tag being validated, sReport = String to add report information to

Return: icValidateStatusOK if valid, or other error status.

Reimplemented from CIccTag.

Definition at line 448 of file IccTagEmbedIcc.cpp.

{
  icValidateStatus rv = CIccTag::Validate(sigPath, sReport, pProfile);
 
  CIccInfo Info;
 
  if (!m_pProfile) {
    sReport += icMsgValidateWarning;
    sReport += Info.GetSigPathName(sigPath);
    sReport += " - No Profile defined for embedded profile tag.\n";
 
    rv = icMaxStatus(rv, icValidateWarning);
    return rv;
  }
 
  rv = icMaxStatus(rv, m_pProfile->Validate(sReport, sigPath));
 
  if (pProfile) {
    if (m_pProfile->m_Header.colorSpace != pProfile->m_Header.colorSpace) {
      sReport += icMsgValidateCriticalError;
      sReport += Info.GetSigPathName(sigPath);
      sReport += " - color space does not match for embedded profile.\n";
 
      rv = icMaxStatus(rv, icValidateCriticalError);
    }
    if (m_pProfile->m_Header.deviceClass != pProfile->m_Header.deviceClass) {
      sReport += icMsgValidateCriticalError;
      sReport += Info.GetSigPathName(sigPath);
      sReport += " - device class does not match for embedded profile.\n";
 
      rv = icMaxStatus(rv, icValidateCriticalError);
    }
  }
  
  return rv;
}

References CIccInfo::GetSigPathName(), icMaxStatus(), icMsgValidateCriticalError, icMsgValidateWarning, icValidateCriticalError, icValidateWarning, m_pProfile, and CIccTag::Validate().

Here is the call graph for this function:

Write()

bool CIccTagEmbeddedProfile::Write ( CIccIO * pIO )

virtual

Name: CIccTagEmbedProfile::Write.

Purpose: Write an unknown tag to a file

Args: pIO - The IO object to write tag to.

Return: true = succesful, false = failure

Reimplemented from CIccTag.

Definition at line 267 of file IccTagEmbedIcc.cpp.

{
  if (!pIO)
    return false;
 
  icTagTypeSignature nType = GetType();
 
  if (!pIO->Write32(&nType))
    return false;
 
  if (!pIO->Write32(&m_nReserved))
    return false;
 
 
  if (m_pProfile) {
    CIccEmbedIO embedIO;
    if (!embedIO.Attach(pIO))
      return false;
 
    icProfileIDSaveMethod bWriteId = (m_pProfile->m_Header.profileID.ID32[0] ||
                                      m_pProfile->m_Header.profileID.ID32[1] ||
                                      m_pProfile->m_Header.profileID.ID32[2] ||
                                      m_pProfile->m_Header.profileID.ID32[3]) ? icAlwaysWriteID : icVersionBasedID;
    bool rv = m_pProfile->Write(&embedIO, bWriteId);
    return rv;
  }
 
  return true;
}

References CIccEmbedIO::Attach(), GetType(), CIccTag::m_nReserved, m_pProfile, and CIccIO::Write32().

Here is the call graph for this function:

Member Data Documentation

m_pProfile

CIccProfile* CIccTagEmbeddedProfile::m_pProfile

Definition at line 112 of file IccTagEmbedIcc.h.

Referenced by CIccTagEmbeddedProfile(), CIccTagEmbeddedProfile(), Describe(), operator=(), Read(), ReadAll(), Validate(), Write(), and ~CIccTagEmbeddedProfile().

---

The documentation for this class was generated from the following files:

• IccProfLib/IccTagEmbedIcc.h
• IccProfLib/IccTagEmbedIcc.cpp