oyIM Module

Collaboration diagram for oyIM Module:

Functions
int	oyIMProfileCanHandle (oyCMMQUERY_e type, uint32_t value)
	inform about icTagTypeSignature capabilities More...
oyStructList_s *	oyIMProfileTag_GetValues (oyProfileTag_s *tag)
	Get values from ICC profile tags. More...
int	oyIMProfileTag_Create (oyProfileTag_s *tag, oyStructList_s *list, icTagTypeSignature tag_type, uint32_t version OY_UNUSED)
	Creates a ICC profile tag. More...

Variables
oyCMMapi3_s_	oyIM_api3
	oyIM oyCMMapi3_s implementations More...

Detailed Description

Function Documentation

int oyIMProfileCanHandle	(	oyCMMQUERY_e	type,
		uint32_t	value
	)

inform about icTagTypeSignature capabilities

oyIMProfileCanHandle

Version

Oyranos: 0.1.8

Since

2008/01/03 (Oyranos: 0.1.8)

Date

2008/05/23

References oyQUERY_OYRANOS_COMPATIBILITY, oyQUERY_PROFILE_FORMAT, oyQUERY_PROFILE_TAG_TYPE_READ, oyQUERY_PROFILE_TAG_TYPE_WRITE, and OYRANOS_VERSION.

int oyIMProfileTag_Create	(	oyProfileTag_s *	tag,
		oyStructList_s *	list,
		icTagTypeSignature	tag_type,
		uint32_t version	OY_UNUSED
	)

Creates a ICC profile tag.

oyIMProfileTag_Create() This is a module function. It implements oyCMMProfileTag_Create_f oyCMMProfileTag_Create.

See Also

oyProfileTag_Create()

The output depends on the tag type signature and arguments in list:

• icSigProfileSequenceIdentifierType:
  • since Oyranos 0.1.8 (API 0.1.8)
  • list: should contain only profiles
  • version: is not honoured; note 'psid' is known after ICC v4.2
• icSigMultiLocalizedUnicodeType:
  • since Oyranos 0.1.8 (API 0.9.7)
  • list: should contain only strings from oyStructList_AddName()
    • oyNAME_NAME is considered to hold the name
    • oyNAME_LC is required to hold i18n specifier, e.g. "en_GB"
    • the frist oyNAME_LC can have no i18n specifier as a default
  • version: is not honoured; note 'mluc' is known since ICC v4
• icSigTextType:
  • since Oyranos 0.1.8 (API 0.9.7)
  • list: should contain only string from oyStructList_AddName()
    • oyNAME_NAME is considered to hold the name
• icSigNamedColor2Type:
  • since Oyranos 0.9.5 (API 0.9.7)
  • list: should contain the objects to create the tag
    • oyNamedColors_s
• non supported types
  • the oyProfileTag_s::status_ field will be set to oyUNDEFINED
• function description
  • set the tag argument to zero
  • provide a empty list to fill in with oyName_s' each matching a tag_type
    • oyNAME_NICK contains the module info, e.g. 'oyIM'
    • oyNAME_NAME contains the tag_type, e.g. 'icSigMultiLocalizedUnicodeType' or 'mluc'
    • oyNAME_DESCRIPTION contains text as in above documentation
  • dont copy the list as content may be statically allocated

Parameters

[in,out]	tag	the profile tag
[in,out]	list	parameters
[in]	tag_type	the ICC tag type
[in]	version	version as supported

Returns

oySTATUS_e status

Version

Oyranos: 0.9.7

Date

2017/10/24

Since

2008/01/08 (Oyranos: 0.1.8)

References oyDOUBLE, oyEDITING_LAB, oyIMProfileTag_Create(), oyIMProfileTag_GetValues(), oyNAME_LC, oyNAME_NAME, oyNAME_NICK, oyNamedColor_s::oyNamedColor_GetChannelsConst(), oyNamedColor_s::oyNamedColor_GetColorStd(), oyNamedColor_s::oyNamedColor_GetName(), oyNamedColor_s::oyNamedColor_GetSpaceRef(), oyNamedColor_s::oyNamedColor_Release(), oyNamedColors_s::oyNamedColors_Count(), oyNamedColors_s::oyNamedColors_Get(), oyNamedColors_s::oyNamedColors_GetPrefix(), oyNamedColors_s::oyNamedColors_GetSuffix(), oyOBJECT_NAME_S, oyOBJECT_NAMED_COLORS_S, oyOBJECT_PROFILE_S, oyOBJECT_PROFILE_TAG_S, oyProfile_s::oyProfile_Equal(), oyProfile_s::oyProfile_GetChannelsCount(), oyProfile_s::oyProfile_GetMem(), oyProfile_s::oyProfile_GetTagById(), oyProfile_s::oyProfile_Release(), oyProfileGetMD5(), oyProfileTag_s::oyProfileTag_GetBlock(), oyProfileTag_s::oyProfileTag_GetSize(), oyProfileTag_s::oyProfileTag_GetStatus(), oyProfileTag_s::oyProfileTag_GetType(), oyProfileTag_s::oyProfileTag_GetUse(), oyProfileTag_s::oyProfileTag_Release(), oyProfileTag_s::oyProfileTag_Set(), oyProfileTag_s::oyProfileTag_SetLastCMM(), oyProfileTag_s::oyProfileTag_SetStatus(), oyStructList_s::oyStructList_Count(), oyStructList_s::oyStructList_GetName(), oyStructList_s::oyStructList_GetRefType(), oyStructList_s::oyStructList_MoveIn(), oyStructList_s::oyStructList_New(), oyStructList_s::oyStructList_Release(), oyValueUInt16(), and oyValueUInt32().

Referenced by oyIMProfileTag_Create().

oyStructList_s* oyIMProfileTag_GetValues

(

oyProfileTag_s *

tag

)

Get values from ICC profile tags.

oyIMProfileTag_GetValues() The function implements oyCMMProfileTag_GetValues_t for oyCMMapi3_s::oyCMMProfileTag_GetValues.

See Also

oyProfileTag_Get()

• function description are obtained by following steps:
  • set the tag argument to zero
  • the returned list will be filled in with oyName_s' each matching a tag_type
    • oyNAME_NICK contains the module info, e.g. 'oyIM'
    • oyNAME_NAME contains the tag_type, e.g. 'icSigMultiLocalizedUnicodeType' or 'mluc'
    • oyNAME_DESCRIPTION contains text as in above documentation
  • do not reference the list as content may be statically allocated

The output depends on the tags type signature in tag->tag_type_ as follows:

• icSigColorantOrderType and :
  • since Oyranos 0.1.12 (API 0.9.7)
  • returns: text list
    • the number of channels
    • the position of the normal channel names as strings 1 + i
• icSigColorantTableType:
  • since Oyranos 0.1.12 (API 0.9.7)
  • The PCS values are integers in the range of 0-65535.
  • The PCS value interpretation depends on the profiles PCS header field.
    • the short channel name as string in 1 + 2 * i
    • PCS representation as three space separated integers in 1 + 2 * i + 1
• icSigCurveType:
  • since Oyranos 0.3.1 (API 0.3.1)
  • returns:
    • a string describing the curve
    • a option containing doubles
      • first entry : count with zero means idendity, one means gamma
      • more doubles means a segmented curve
      • second entry : values start
• icSigTextType and icSigWCSProfileTag:
  • since Oyranos 0.1.8 (API 0.9.7)
  • returns one string
• icSigParametricCurveType:
  • since Oyranos 0.3.1 (API 0.3.1)
  • returns
    • position 0 : the type of the curve as of ICC spec 10.15\
    • position 1 : count of parameters - param_n\
    • position 2 : first paramter for the parametric formula\
    • position 2 + param_n : the number of a segmented curve - seg_count\
    • position 2 + param_n + 1 : the curves value for 0.0\
    • position 2 + param_n + 1 + seg_count - 1 : the curves value for 1.0
• icSigTextDescriptionType:
  • since Oyranos 0.1.8 (API 0.9.7)
  • returns one string
• icSigMultiLocalizedUnicodeType:
  • since Oyranos 0.1.8 (API 0.9.7)
  • list: should contain only strings from oyStructList_GetName()\
    • oyNAME_NAME is considered to hold the name\
    • oyNAME_LC is required to hold i18n specifier, e.g. "en_GB"\
• icSigSignatureType:
  • since Oyranos 0.1.8 (API 0.9.7)
  • returns one string
  • for the value see oyICCTechnologyDescription
• icSigDescriptiveNameValueMuArrayType_:
  • since Oyranos 0.1.10 (API 0.9.7)
  • returns
    • introduction text
    • ascii string with the number (i) of the found elements
    • a key string in 2 + i * 2
    • a value string in in 2 + i * 2 + 1
• icSigLutAtoBType
• icSigMakeAndModelType:
  • since Oyranos 0.1.8 (API 0.9.7)
  • returns eigth strings, uneven is descriptive, even from a uint32_t
    • manufacturer id
    • model id
    • serialNumber id
    • manufacturer date id
• icSigNativeDisplayInfoType:
  • since Oyranos 0.1.11 (API 0.9.7)
  • returns a list of strings, uneven is descriptive, even contains values
• icSigNamedColor2Type:
  • since Oyranos 0.9.5 (API 0.9.7)
  • list: should contain the objects to create the tag
  • a string describing the tag
    • oyNamedColors_s
• icSigDictType:
  • since Oyranos 0.1.10 (API 0.9.7)
  • returns four strings each originating from a uint32_t
    • the size of components (c) as ascii string (2 - key/value pairs; 3 - key/value pairs + key UI translations, 3 - key/value pairs + key UI translations + value UI translations)
    • the number (i) of the found elements as ascii string
    • key string in 2 + i * c
    • value string in 2 + i * c + 1
    • oyStructList_s with language strings in 2 + i * c + 2
    • oyStructList_s with language strings in 2 + i * c + 3
• icSigProfileSequenceDescType:
  • since Oyranos 0.1.8 (API 0.9.7)
  • returns
    • first string as ascii the number (i) of the found elements
    • a profile anounce string in 1 + i * 7
    • the translated "Manufacturer:" string in 1 + i * 7 + 1
    • the manufacturer string in 1 + i * 7 + 2, the full lenght or 4 byte
    • the translated "Model:" string in 1 + i * 7 + 3
    • the model string in 1 + i * 7 + 4, the full lenght or 4 byte one
    • the translated "Technology:" string in 1 + i * 7 + 5
    • the tech string in 1 + i * 7 + 6, see oyICCTechnologyDescription
• icSigProfileSequenceIdentifierType:
  • since Oyranos 0.1.8 (API 0.9.7)
  • returns
    • first string as ascii the number (i) of the found elements
    • a profile anounce string in 1 + i * 5
    • the string "md5id:" in in 1 + i * 5 + 1
    • the low letter hexadecimal hash value in 1 + i * 5 + 2
    • mluc translated by oyICCTagDescription in 1 + i * 5 + 3
    • the icSigProfileDescriptionTag according to language in 1 + i * 5 + 4
• icSigDeviceSettingsType:
  • since Oyranos 0.1.10 (API 0.9.7)
  • returns
    • version announce string
    • string version
    • announce string
    • device serial
    • announce string
    • driver name
    • announce string
    • driver version
    • announce string
    • driver signature/encoding
    • announce string
    • priority (0-255)
    • announce string
    • oyBlob_s data blob

icSigXYZType:

• since Oyranos 0.9.0 (API 0.9.7)
  • a string describing the values
  • a option containing doubles
    • first entry : CIE *X
    • second entry: CIE *Y
    • third entry : CIE *Z

Version

Oyranos: 0.9.7

Date

2017/10/24

Since

2008/01/02 (Oyranos: 0.1.8)

References oy_debug, OY_PROFILE_NONE, oyBlob_s::oyBlob_New(), oyBlob_s::oyBlob_SetFromData(), oyDOUBLE, oyEDITING_LAB, oyICCGetColorSpaceWithChannelCount(), oyICCTagDescription(), oyICCTagName(), oyICCTagTypeName(), oyICCTechnologyDescription(), oyIMIconv(), oyIMProfileTag_GetValues(), oyNAME_LC, oyNAME_NAME, oyNamedColor_s::oyNamedColor_CreateWithName(), oyNamedColor_s::oyNamedColor_SetChannels(), oyNamedColor_s::oyNamedColor_SetColorStd(), oyNamedColors_s::oyNamedColors_MoveIn(), oyNamedColors_s::oyNamedColors_New(), oyNamedColors_s::oyNamedColors_SetPrefix(), oyNamedColors_s::oyNamedColors_SetSuffix(), oyOBJECT_NAME_S, oyOption_s::oyOption_FromRegistration(), oyOption_s::oyOption_GetValueDouble(), oyOption_s::oyOption_SetFromDouble(), oyProfile_s::oyProfile_FromSignature(), oyProfile_s::oyProfile_Release(), oyProfiles_s::oyProfiles_Create(), oyProfiles_s::oyProfiles_Get(), oyProfiles_s::oyProfiles_MoveIn(), oyProfiles_s::oyProfiles_New(), oyProfiles_s::oyProfiles_Release(), oyProfileTag_s::oyProfileTag_GetBlock(), oyProfileTag_s::oyProfileTag_GetSize(), oyProfileTag_s::oyProfileTag_GetSizeCheck(), oyProfileTag_s::oyProfileTag_GetStatus(), oyProfileTag_s::oyProfileTag_GetType(), oyProfileTag_s::oyProfileTag_New(), oyProfileTag_s::oyProfileTag_Release(), oyProfileTag_s::oyProfileTag_Set(), oyProfileTag_s::oyProfileTag_SetSizeCheck(), oySIGNATURE_COLOR_SPACE, oyStringAddPrintf(), oyStringCopy(), oyStructList_s::oyStructList_AddName(), oyStructList_s::oyStructList_Count(), oyStructList_s::oyStructList_GetName(), oyStructList_s::oyStructList_MoveIn(), oyStructList_s::oyStructList_MoveInName(), oyStructList_s::oyStructList_New(), oyStructList_s::oyStructList_Release(), oyValueInt32(), oyValueUInt16(), and oyValueUInt32().

Referenced by oyIMProfileTag_Create(), and oyIMProfileTag_GetValues().

Variable Documentation

oyCMMapi3_s_ oyIM_api3

Initial value:

= {

  oyOBJECT_CMM_API3_S,
  0,0,0,
  (oyCMMapi_s*) & oyIM_api5_meta_c,
  
  oyIMCMMInit,
  oyIMCMMMessageFuncSet,

  CMM_BASE_REG CMM_NICK,     
  {OYRANOS_VERSION_A,OYRANOS_VERSION_B,OYRANOS_VERSION_C},
  {0,9,7},                  
  0,                         

  oyIMProfileCanHandle,

  oyIMProfileTag_GetValues,
  oyIMProfileTag_Create
}

oyIM oyCMMapi3_s implementations

oyIM_api3

Version

Oyranos: 0.1.8

Since

2008/01/02 (Oyranos: 0.1.8)

Date

2008/01/02