CIccTagCicp Class Reference

#include <IccTagBasic.h>

Inheritance diagram for CIccTagCicp:

Collaboration diagram for CIccTagCicp:

Public Member Functions
	CIccTagCicp ()
	CIccTagCicp (const CIccTagCicp &ITCICP)
virtual	~CIccTagCicp ()
virtual void	Describe (std::string &sDescription, int nVerboseness)
virtual void	DetachIO ()
virtual const icChar *	GetClassName () const
virtual IIccExtensionTag *	GetExtension ()
void	GetFields (icUInt8Number &colorPrimaries, icUInt8Number &transferCharacteristics, icUInt8Number &matrixCoefficients, icUInt8Number &videoFullRangeFlag)
virtual icArraySignature	GetTagArrayType () const
virtual icStructSignature	GetTagStructType () const
virtual icTagTypeSignature	GetType () const
virtual bool	IsArrayType ()
virtual bool	IsMBBType ()
virtual bool	IsNumArrayType () const
virtual bool	IsSupported ()
virtual CIccTag *	NewCopy () const
CIccTagCicp &	operator= (const CIccTagCicp &XYZTag)
virtual bool	Read (icUInt32Number size, CIccIO *pIO)
virtual bool	Read (icUInt32Number size, CIccIO *pIO, CIccProfile *pProfile)
virtual bool	ReadAll ()
void	SetFields (icUInt8Number colorPrimaries, icUInt8Number transferCharacteristics, icUInt8Number matrixCoefficients, icUInt8Number videoFullRangeFlag)
virtual icValidateStatus	Validate (std::string sigPath, std::string &sReport, const CIccProfile *pProfile=NULL) const
virtual bool	Write (CIccIO *pIO)

Static Public Member Functions
static CIccTag *	Create (icTagTypeSignature sig)

Data Fields
icUInt32Number	m_nReserved

Protected Attributes
icUInt8Number	m_nColorPrimaries
icUInt8Number	m_nMatrixCoefficients
icUInt8Number	m_nTransferCharacteristics
icUInt8Number	m_nVideoFullRangeFlag

Detailed Description

Class: CIccTagCicp

Purpose: the cicpType tag - metadata containing ITU-T H.273 fields

Constructor & Destructor Documentation

CIccTagCicp() [1/2]

CIccTagCicp::CIccTagCicp

(

)

Name: CIccTagCicp::CIccTagCicp

Purpose: Constructor

Args: nSize = number of XYZ entries

{
  m_nColorPrimaries = 0;
  m_nTransferCharacteristics = 0;
  m_nMatrixCoefficients = 0;
  m_nVideoFullRangeFlag = 0;
}

References m_nColorPrimaries, m_nMatrixCoefficients, m_nTransferCharacteristics, and m_nVideoFullRangeFlag.

CIccTagCicp() [2/2]

CIccTagCicp::CIccTagCicp

(

const CIccTagCicp &

ITXYZ

)

Name: CIccTagCicp::CIccTagCicp

Purpose: Copy Constructor

Args: ITCICP = The CIccTagCicp object to be copied

{
}

Referenced by NewCopy().

Here is the caller graph for this function:

~CIccTagCicp()

CIccTagCicp::~CIccTagCicp ( )

virtual

Name: CIccTagCicp::~CIccTagCicp

Purpose: Destructor

{
}

Member Function Documentation

Create()

CIccTag * CIccTag::Create ( icTagTypeSignature  sig )

staticinherited

Name: CIccTag::Create

Purpose: This is a static tag creator based upon tag signature type

Args: sig = tag type signature

Return: Pointer to Allocated tag

{
  return CIccTagCreator::CreateTag(sig);
}

References CIccTagCreator::CreateTag().

Referenced by CIccDefaultEncProfileConverter::ConvertFromParams(), CIccTagStruct::LoadElem(), CIccProfileXml::ParseTag(), CIccTagXmlStruct::ParseTag(), CIccMpeXmlTintArray::ParseXml(), CIccTagXmlArray::ParseXml(), CIccMpeTintArray::Read(), CIccTagLutAtoB::Read(), CIccTagLut8::Read(), CIccTagLut16::Read(), CIccTagLut8::SetColorSpaces(), CIccTagLut16::SetColorSpaces(), and CIccProfileDescText::SetType().

Here is the call graph for this function:

Here is the caller graph for this function:

Describe()

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

virtual

Name: CIccTagCicp::Describe

Purpose: Dump data associated with the tag to a string

Args: sDescription - string to concatenate tag dump to

Reimplemented from CIccTag.

{
  icChar buf[256], code[128];
  sprintf(code, "%u-%u-%u-%u", m_nColorPrimaries, m_nTransferCharacteristics, m_nMatrixCoefficients, m_nVideoFullRangeFlag);
 
  sprintf(buf, "ColorPrimaries=%u\r\n", m_nColorPrimaries);
  sDescription += buf;
 
  sprintf(buf, "TransferCharacteristics=%u\r\n", m_nTransferCharacteristics);
  sDescription += buf;
 
  sprintf(buf, "MatrixCoefficients=%u\r\n", m_nMatrixCoefficients);
  sDescription += buf;
 
  sprintf(buf, "VideoFullRangeFlag=%u\r\n\r\n", m_nVideoFullRangeFlag);
  sDescription += buf;
 
  sprintf(buf, "Combined Code: %s\r\n", code);
  sDescription += buf;
 
  int i;
  for (i = 0; icExampleCicpCodes[i].code; i++)
    if (!strcmp(code, icExampleCicpCodes[i].code))
      break;
 
  sDescription += "Interpretation: ";
  if (icExampleCicpCodes[i].code) {
    sDescription += icExampleCicpCodes[i].interp;
  }
  else {
    sDescription += "unknown";
  }
  sDescription += "\r\n";
}

References m_nColorPrimaries, m_nMatrixCoefficients, m_nTransferCharacteristics, and m_nVideoFullRangeFlag.

DetachIO()

virtual void CIccTag::DetachIO ( )

inlinevirtualinherited

Function: ReadAll() - Read All sub data for tag from file. Called by CIccProfile::ReadAll() to read all sub data for tag

Returns true if ReadAll is successful.

{}

GetClassName()

virtual const icChar * CIccTagCicp::GetClassName ( ) const

inlinevirtual

Reimplemented from CIccTag.

Reimplemented in CIccTagXmlCicp.

{ return "CIccTagCicp"; }

GetExtension()

virtual IIccExtensionTag * CIccTag::GetExtension ( )

inlinevirtualinherited

Reimplemented in CIccTagXmlUnknown, CIccTagXmlText, CIccTagXmlUtf8Text, CIccTagXmlZipUtf8Text, CIccTagXmlZipXml, CIccTagXmlUtf16Text, CIccTagXmlTextDescription, CIccTagXmlSignature, CIccTagXmlNamedColor2, CIccTagXmlXYZ, CIccTagXmlChromaticity, CIccTagXmlCicp, CIccTagXmlSparseMatrixArray, CIccTagXmlFixedNum< T, Tsig >, CIccTagXmlNum< T, A, Tsig >, CIccTagXmlFloatNum< T, A, Tsig >, CIccTagXmlMeasurement, CIccTagXmlMultiLocalizedUnicode, CIccTagXmlTagData, CIccTagXmlDateTime, CIccTagXmlColorantOrder, CIccTagXmlColorantTable, CIccTagXmlViewingConditions, CIccTagXmlSpectralDataInfo, CIccTagXmlSpectralViewingConditions, CIccTagXmlProfileSeqDesc, CIccTagXmlResponseCurveSet16, CIccTagXmlCurve, CIccTagXmlParametricCurve, CIccTagXmlSegmentedCurve, CIccTagXmlLutAtoB, CIccTagXmlLutBtoA, CIccTagXmlLut8, CIccTagXmlLut16, CIccTagXmlMultiProcessElement, CIccTagXmlProfileSequenceId, CIccTagXmlDict, CIccTagXmlStruct, CIccTagXmlArray, CIccTagXmlGamutBoundaryDesc, CIccTagXmlEmbeddedHeightImage, CIccTagXmlEmbeddedNormalImage, and CIccTagXmlEmbeddedProfile.

{return NULL;}

Referenced by icCurvesFromXml(), icCurvesToXml(), icProfDescToXml(), icXmlParseProfDesc(), CIccProfileXml::ParseTag(), CIccTagXmlStruct::ParseTag(), CIccMpeXmlTintArray::ParseXml(), CIccTagXmlArray::ParseXml(), CIccMpeXmlTintArray::ToXml(), CIccTagXmlStruct::ToXml(), CIccTagXmlArray::ToXml(), and CIccProfileXml::ToXmlWithBlanks().

Here is the caller graph for this function:

GetFields()

void CIccTagCicp::GetFields	(	icUInt8Number &	colorPrimaries,
		icUInt8Number &	transferCharacteristics,
		icUInt8Number &	matrixCoefficients,
		icUInt8Number &	videoFullRangeFlag
	)

Name: CIccTagCicp::GetFields

Purpose: gets the ITU-T H.273 field values

Args: meaning of args as named

{
  colorPrimaries = m_nColorPrimaries;
  transferCharacteristics = m_nTransferCharacteristics;
  matrixCoefficients = m_nMatrixCoefficients;
  videoFullRangeFlag = m_nVideoFullRangeFlag;
}

References m_nColorPrimaries, m_nMatrixCoefficients, m_nTransferCharacteristics, and m_nVideoFullRangeFlag.

GetTagArrayType()

virtual icArraySignature CIccTag::GetTagArrayType ( ) const

inlinevirtualinherited

Reimplemented in CIccTagArray.

{ return icSigUndefinedArray; }

References icSigUndefinedArray.

Referenced by icGetTagArrayHandlerOfType(), and CIccProfileXml::ParseTag().

Here is the caller graph for this function:

GetTagStructType()

virtual icStructSignature CIccTag::GetTagStructType ( ) const

inlinevirtualinherited

Reimplemented in CIccTagStruct.

{ return icSigUndefinedStruct; }

References icSigUndefinedStruct.

Referenced by icGetTagStructHandlerOfType(), CIccArrayColorantInfo::Validate(), and CIccArrayNamedColor::Validate().

Here is the caller graph for this function:

GetType()

virtual icTagTypeSignature CIccTagCicp::GetType ( ) const

inlinevirtual

Function: GetType()

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

Reimplemented from CIccTag.

{ return icSigCicpType; }

References icSigCicpType.

Referenced by Write().

Here is the caller graph for this function:

IsArrayType()

virtual bool CIccTag::IsArrayType ( )

inlinevirtualinherited

Reimplemented in CIccTagXYZ, CIccTagChromaticity, CIccTagSparseMatrixArray, CIccTagFixedNum< T, Tsig >, CIccTagNum< T, Tsig >, CIccTagFloatNum< T, Tsig >, and CIccTagData.

{ return false; }

Referenced by MyTagDialog::MyTagDialog(), and DumpTag().

Here is the caller graph for this function:

IsMBBType()

virtual bool CIccTag::IsMBBType ( )

inlinevirtualinherited

Reimplemented in CIccMBB.

{ return false; } //If true then CIccTag can be cast as an CIccMBB 

Referenced by CIccProfileXml::ParseTag().

Here is the caller graph for this function:

IsNumArrayType()

virtual bool CIccTag::IsNumArrayType ( ) const

inlinevirtualinherited

Reimplemented in CIccTagSparseMatrixArray, CIccTagFixedNum< T, Tsig >, CIccTagNum< T, Tsig >, and CIccTagFloatNum< T, Tsig >.

{ return false;} //If true then CIccTag can be cast as a CIccTagNumArray

Referenced by CIccArrayNamedColor::FindDeviceColor(), CIccArrayNamedColor::FindPcsColor(), CIccArrayNamedColor::FindSpectralColor(), CIccTagStruct::GetElemNumberValue(), CIccStructNamedColor::GetNumArray(), CIccMpeXmlTintArray::ParseXml(), and CIccMpeTintArray::Read().

Here is the caller graph for this function:

IsSupported()

virtual bool CIccTag::IsSupported ( )

inlinevirtualinherited

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 in CIccTagUnknown, CIccTagEmbeddedProfile, and CIccTagMultiProcessElement.

{ return true; }

NewCopy()

virtual CIccTag * CIccTagCicp::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.

{ return new CIccTagCicp(*this); }

References CIccTagCicp().

Here is the call graph for this function:

operator=()

CIccTagCicp & CIccTagCicp::operator=

(

const CIccTagCicp &

cicpTag

)

Name: CIccTagCicp::operator=

Purpose: Copy Operator

Args: cicpTag = The CIccTagCicp object to be copied

{
  if (&cicpTag == this)
    return *this;
 
  m_nColorPrimaries = cicpTag.m_nColorPrimaries;
  m_nTransferCharacteristics = cicpTag.m_nTransferCharacteristics;
  m_nMatrixCoefficients = cicpTag.m_nMatrixCoefficients;
  m_nVideoFullRangeFlag = cicpTag.m_nVideoFullRangeFlag;
 
  return *this;
}

References m_nColorPrimaries, m_nMatrixCoefficients, m_nTransferCharacteristics, and m_nVideoFullRangeFlag.

Read() [1/2]

bool CIccTagCicp::Read ( icUInt32Number  size, CIccIO *  pIO  )

virtual

Name: CIccTagCicp::Read

Purpose: Read in the tag contents into a data block

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

Return: true = successful, false = failure

Reimplemented from CIccTag.

{
  icTagTypeSignature sig;
 
  if (sizeof(icTagTypeSignature) +
    sizeof(icUInt32Number) +
    sizeof(icUInt8Number)*4 > size)
    return false;
 
  if (!pIO) {
    return false;
  }
 
  if (!pIO->Read32(&sig))
    return false;
 
  if (!pIO->Read32(&m_nReserved))
    return false;
 
  if (!pIO->Read8(&m_nColorPrimaries) ||
      !pIO->Read8(&m_nTransferCharacteristics) ||
      !pIO->Read8(&m_nMatrixCoefficients) ||
      !pIO->Read8(&m_nVideoFullRangeFlag))
    return false;
 
  return true;
}

References m_nColorPrimaries, m_nMatrixCoefficients, CIccTag::m_nReserved, m_nTransferCharacteristics, m_nVideoFullRangeFlag, CIccIO::Read32(), and CIccIO::Read8().

Here is the call graph for this function:

Read() [2/2]

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

inlinevirtualinherited

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 in CIccTagEmbeddedProfile.

{ return Read(size, pIO); }

References CIccTag::Read().

Here is the call graph for this function:

ReadAll()

virtual bool CIccTag::ReadAll ( )

inlinevirtualinherited

Function: ReadAll() - Read All sub data for tag from file. Called by CIccProfile::ReadAll() to read all sub data for tag

Returns true if ReadAll is successful.

Reimplemented in CIccTagEmbeddedProfile.

{ return true; }

SetFields()

void CIccTagCicp::SetFields	(	icUInt8Number	colorPrimaries,
		icUInt8Number	transferCharacteristics,
		icUInt8Number	matrixCoefficients,
		icUInt8Number	videoFullRangeFlag
	)

Name: CIccTagCicp::SetFields

Purpose: Sets the ITU-T H.273 field values

Args: meaning of args as named

{
  m_nColorPrimaries = colorPrimaries;
  m_nTransferCharacteristics = transferCharacteristics;
  m_nMatrixCoefficients =matrixCoefficients;
  m_nVideoFullRangeFlag = videoFullRangeFlag;
}

References m_nColorPrimaries, m_nMatrixCoefficients, m_nTransferCharacteristics, and m_nVideoFullRangeFlag.

Validate()

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

virtual

Name: CIccTagCicp::Validate

Purpose: Check tag data validity.

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

Return: icValidateStatusOK if valid, or other error status.

Reimplemented from CIccTag.

{
  icValidateStatus rv = CIccTag::Validate(sigPath, sReport, pProfile);
 
  CIccInfo Info;
  std::string sSigPathName = Info.GetSigPathName(sigPath);
 
  if (!pProfile)
    return rv;
 
  if ((pProfile->m_Header.colorSpace == icSigRgbData || pProfile->m_Header.colorSpace == icSigXYZData) && m_nMatrixCoefficients) {
    sReport += icMsgValidateNonCompliant;
    sReport += sSigPathName;
    sReport += " - CICP MatrixCoefficients not zero for RGB or XYZ colour space data.\r\n";
    rv = icMaxStatus(rv, icValidateNonCompliant);
  }
 
  if (pProfile->m_Header.colorSpace == icSigYCbCrData && !m_nMatrixCoefficients) {
    sReport += icMsgValidateNonCompliant;
    sReport += sSigPathName;
    sReport += " - CICP MatrixCoefficients zero for YCbCr colour space data.\r\n";
    rv = icMaxStatus(rv, icValidateNonCompliant);
  }
 
  return rv;
}

References icHeader::colorSpace, CIccInfo::GetSigPathName(), icMaxStatus(), icMsgValidateNonCompliant, icSigRgbData, icSigXYZData, icSigYCbCrData, icValidateNonCompliant, m_nMatrixCoefficients, and CIccTag::Validate().

Here is the call graph for this function:

Write()

bool CIccTagCicp::Write ( CIccIO *  pIO )

virtual

Name: CIccTagCicp::Write

Purpose: Write the tag to a file

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

Return: true = succesful, false = failure

Reimplemented from CIccTag.

{
  icTagTypeSignature sig = GetType();
 
  if (!pIO)
    return false;
 
  if (!pIO->Write32(&sig))
    return false;
 
  if (!pIO->Write32(&m_nReserved))
    return false;
 
  if (!pIO->Write8(&m_nColorPrimaries) ||
      !pIO->Write8(&m_nTransferCharacteristics) ||
      !pIO->Write8(&m_nMatrixCoefficients) ||
      !pIO->Write8(&m_nVideoFullRangeFlag))
    return false;
 
  return true;
}

References GetType(), m_nColorPrimaries, m_nMatrixCoefficients, CIccTag::m_nReserved, m_nTransferCharacteristics, m_nVideoFullRangeFlag, CIccIO::Write32(), and CIccIO::Write8().

Here is the call graph for this function:

Field Documentation

m_nColorPrimaries

icUInt8Number CIccTagCicp::m_nColorPrimaries

protected

Referenced by CIccTagCicp(), Describe(), GetFields(), operator=(), CIccTagXmlCicp::ParseXml(), Read(), SetFields(), CIccTagXmlCicp::ToXml(), and Write().

m_nMatrixCoefficients

icUInt8Number CIccTagCicp::m_nMatrixCoefficients

protected

Referenced by CIccTagCicp(), Describe(), GetFields(), operator=(), CIccTagXmlCicp::ParseXml(), Read(), SetFields(), CIccTagXmlCicp::ToXml(), Validate(), and Write().

m_nReserved

icUInt32Number CIccTag::m_nReserved

inherited

Referenced by CIccTag::CIccTag(), CIccTagMultiProcessElement::CIccTagMultiProcessElement(), CIccTagMultiProcessElement::CIccTagMultiProcessElement(), CIccTagMultiProcessElement::operator=(), CIccProfileXml::ParseTag(), CIccTagXmlStruct::ParseTag(), CIccMpeXmlTintArray::ParseXml(), CIccTagXmlArray::ParseXml(), CIccTagText::Read(), CIccTagUtf8Text::Read(), CIccTagZipUtf8Text::Read(), CIccTagUtf16Text::Read(), CIccTagTextDescription::Read(), CIccTagSignature::Read(), CIccTagNamedColor2::Read(), CIccTagXYZ::Read(), CIccTagChromaticity::Read(), Read(), CIccTagSparseMatrixArray::Read(), CIccTagFixedNum< T, Tsig >::Read(), CIccTagNum< T, Tsig >::Read(), CIccTagFloatNum< T, Tsig >::Read(), CIccTagMeasurement::Read(), CIccTagMultiLocalizedUnicode::Read(), CIccTagData::Read(), CIccTagDateTime::Read(), CIccTagColorantOrder::Read(), CIccTagColorantTable::Read(), CIccTagViewingConditions::Read(), CIccTagProfileSeqDesc::Read(), CIccTagResponseCurveSet16::Read(), CIccTagSpectralDataInfo::Read(), CIccTagSpectralViewingConditions::Read(), CIccTagEmbeddedHeightImage::Read(), CIccTagEmbeddedNormalImage::Read(), CIccTagStruct::Read(), CIccTagArray::Read(), CIccTagDict::Read(), CIccTagCurve::Read(), CIccTagParametricCurve::Read(), CIccTagLutAtoB::Read(), CIccTagLut8::Read(), CIccTagLut16::Read(), CIccTagGamutBoundaryDesc::Read(), CIccTagMultiProcessElement::Read(), CIccTagProfileSequenceId::Read(), CIccTagEmbeddedProfile::Read(), CIccTag::Validate(), CIccTagText::Write(), CIccTagUtf8Text::Write(), CIccTagZipUtf8Text::Write(), CIccTagUtf16Text::Write(), CIccTagTextDescription::Write(), CIccTagSignature::Write(), CIccTagNamedColor2::Write(), CIccTagXYZ::Write(), CIccTagChromaticity::Write(), Write(), CIccTagSparseMatrixArray::Write(), CIccTagFixedNum< T, Tsig >::Write(), CIccTagNum< T, Tsig >::Write(), CIccTagFloatNum< T, Tsig >::Write(), CIccTagMeasurement::Write(), CIccTagMultiLocalizedUnicode::Write(), CIccTagData::Write(), CIccTagDateTime::Write(), CIccTagColorantOrder::Write(), CIccTagColorantTable::Write(), CIccTagViewingConditions::Write(), CIccTagProfileSeqDesc::Write(), CIccTagResponseCurveSet16::Write(), CIccTagSpectralDataInfo::Write(), CIccTagSpectralViewingConditions::Write(), CIccTagEmbeddedHeightImage::Write(), CIccTagEmbeddedNormalImage::Write(), CIccTagStruct::Write(), CIccTagArray::Write(), CIccTagDict::Write(), CIccTagEmbeddedProfile::Write(), CIccTagCurve::Write(), CIccTagParametricCurve::Write(), CIccTagLutAtoB::Write(), CIccTagLut8::Write(), CIccTagLut16::Write(), CIccTagGamutBoundaryDesc::Write(), CIccTagMultiProcessElement::Write(), and CIccTagProfileSequenceId::Write().

m_nTransferCharacteristics

icUInt8Number CIccTagCicp::m_nTransferCharacteristics

protected

Referenced by CIccTagCicp(), Describe(), GetFields(), operator=(), CIccTagXmlCicp::ParseXml(), Read(), SetFields(), CIccTagXmlCicp::ToXml(), and Write().

m_nVideoFullRangeFlag

icUInt8Number CIccTagCicp::m_nVideoFullRangeFlag

protected

Referenced by CIccTagCicp(), Describe(), GetFields(), operator=(), CIccTagXmlCicp::ParseXml(), Read(), SetFields(), CIccTagXmlCicp::ToXml(), and Write().

---

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

• IccProfLib/IccTagBasic.h
• IccProfLib/IccTagBasic.cpp