CIccTagCicp Class Reference

Class: CIccTagCicp. More...

#include <IccTagBasic.h>

Inheritance diagram for CIccTagCicp:

Collaboration diagram for CIccTagCicp:

Public Member Functions
	CIccTagCicp ()
	Name: CIccTagCicp::CIccTagCicp.
	CIccTagCicp (const CIccTagCicp &ITCICP)
	Name: CIccTagCicp::CIccTagCicp.
virtual void	Describe (std::string &sDescription, int nVerboseness)
	Name: CIccTagCicp::Describe.
virtual const icChar *	GetClassName () const
void	GetFields (icUInt8Number &colorPrimaries, icUInt8Number &transferCharacteristics, icUInt8Number &matrixCoefficients, icUInt8Number &videoFullRangeFlag)
	Name: CIccTagCicp::GetFields.
virtual icTagTypeSignature	GetType () const
	Function: GetType()
virtual CIccTag *	NewCopy () const
	Function: NewCopy(sDescription) Each derived tag will implement it's own NewCopy() function.
CIccTagCicp &	operator= (const CIccTagCicp &XYZTag)
	Name: CIccTagCicp::operator=.
virtual bool	Read (icUInt32Number size, CIccIO *pIO)
	Name: CIccTagCicp::Read.
void	SetFields (icUInt8Number colorPrimaries, icUInt8Number transferCharacteristics, icUInt8Number matrixCoefficients, icUInt8Number videoFullRangeFlag)
	Name: CIccTagCicp::SetFields.
virtual icValidateStatus	Validate (std::string sigPath, std::string &sReport, const CIccProfile *pProfile=NULL) const
	Name: CIccTagCicp::Validate.
virtual bool	Write (CIccIO *pIO)
	Name: CIccTagCicp::Write.
virtual	~CIccTagCicp ()
	Name: CIccTagCicp::~CIccTagCicp.
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 bool	IsSupported ()
	Function: IsSupported(size, pIO) - Check if tag fully supported for apply purposes.
virtual bool	Read (icUInt32Number size, CIccIO *pIO, CIccProfile *pProfile)
	Function: Read(size, pIO) - Read tag from file.
virtual bool	ReadAll ()
	Function: ReadAll() - Read All sub data for tag from file.
virtual	~CIccTag ()
	Name: CIccTag::CIccTag.

Protected Attributes
icUInt8Number	m_nColorPrimaries
icUInt8Number	m_nMatrixCoefficients
icUInt8Number	m_nTransferCharacteristics
icUInt8Number	m_nVideoFullRangeFlag

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

Detailed Description

Class: CIccTagCicp.

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

Definition at line 745 of file IccTagBasic.h.

Constructor & Destructor Documentation

CIccTagCicp() [1/2]

CIccTagCicp::CIccTagCicp

(

)

Name: CIccTagCicp::CIccTagCicp.

Purpose: Constructor

Args: nSize = number of XYZ entries

Definition at line 4092 of file IccTagBasic.cpp.

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

CIccTagCicp() [2/2]

CIccTagCicp::CIccTagCicp

(

const CIccTagCicp &

ITXYZ

)

Name: CIccTagCicp::CIccTagCicp.

Purpose: Copy Constructor

Args: ITCICP = The CIccTagCicp object to be copied

Definition at line 4111 of file IccTagBasic.cpp.

{
}

~CIccTagCicp()

CIccTagCicp::~CIccTagCicp ( )

virtual

Name: CIccTagCicp::~CIccTagCicp.

Purpose: Destructor

Definition at line 4149 of file IccTagBasic.cpp.

{
}

Member Function Documentation

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.

Definition at line 4263 of file IccTagBasic.cpp.

{
  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 code, and icExampleCicpCodes.

GetClassName()

virtual const icChar * CIccTagCicp::GetClassName ( ) const

inlinevirtual

Reimplemented from CIccTag.

Reimplemented in CIccTagXmlCicp.

Definition at line 755 of file IccTagBasic.h.

{ return "CIccTagCicp"; }

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

Definition at line 4309 of file IccTagBasic.cpp.

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

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.

Definition at line 754 of file IccTagBasic.h.

{ return icSigCicpType; }

References icSigCicpType.

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.

Definition at line 751 of file IccTagBasic.h.

{ return new CIccTagCicp(*this); }

operator=()

CIccTagCicp & CIccTagCicp::operator=

(

const CIccTagCicp &

cicpTag

)

Name: CIccTagCicp::operator=.

Purpose: Copy Operator

Args: cicpTag = The CIccTagCicp object to be copied

Definition at line 4127 of file IccTagBasic.cpp.

{
  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()

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.

Definition at line 4168 of file IccTagBasic.cpp.

{
  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 CIccIO::Read32(), CIccIO::Read8(), and sig.

Here is the call graph for this function:

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

Definition at line 4331 of file IccTagBasic.cpp.

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

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.

Definition at line 4358 of file IccTagBasic.cpp.

{
  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 CIccInfo::GetSigPathName(), icMaxStatus(), icMsgValidateNonCompliant, icSigRgbData, icSigXYZData, icSigYCbCrData, icValidateNonCompliant, 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.

Definition at line 4210 of file IccTagBasic.cpp.

{
  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 sig, CIccIO::Write32(), and CIccIO::Write8().

Here is the call graph for this function:

Member Data Documentation

m_nColorPrimaries

icUInt8Number CIccTagCicp::m_nColorPrimaries

protected

Definition at line 775 of file IccTagBasic.h.

Referenced by operator=().

m_nMatrixCoefficients

icUInt8Number CIccTagCicp::m_nMatrixCoefficients

protected

Definition at line 777 of file IccTagBasic.h.

Referenced by operator=().

m_nTransferCharacteristics

icUInt8Number CIccTagCicp::m_nTransferCharacteristics

protected

Definition at line 776 of file IccTagBasic.h.

Referenced by operator=().

m_nVideoFullRangeFlag

icUInt8Number CIccTagCicp::m_nVideoFullRangeFlag

protected

Definition at line 778 of file IccTagBasic.h.

Referenced by operator=().

---

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

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