Context convertor. More...

#include <oyCMMapi6_s.h>

Inheritance diagram for oyCMMapi6_s:

Collaboration diagram for oyCMMapi6_s:

Public Types
typedef int(*	oyModuleData_Convert_f) (oyPointer_s data_in, oyPointer_s data_out, oyFilterNode_s *node)
	convert between data formats More...

Public Types inherited from oyCMMapi_s
typedef int(*	oyCMMInit_f) (oyStruct_s *filter)
	optional CMM init function More...

typedef int(*	oyCMMReset_f) (oyStruct_s *filter)
	optional CMM reset function More...

typedef int(*	oyCMMMessageFuncSet_f) (oyMessage_f message_func)
	optionaly sets a CMM message function More...

typedef int(*	oyCMMCanHandle_f) (oyCMMQUERY_e type, uint32_t value)
	CMM feature declaration function. More...

typedef int(*	oyCMMOptions_Check_f) (oyOptions_s *validate)
	a function to check options More...

typedef const char (	oyCMMGetText_f) (const char select, oyNAME_e type, oyStruct_s context)
	get strings from a CMM More...

Public Member Functions
OYAPI oyCMMapi6_s *OYEXPORT	oyCMMapi6_New (oyObject_s object)
	allocate a new CMMapi6 object More...

OYAPI oyCMMapi6_s *OYEXPORT	oyCMMapi6_Copy (oyCMMapi6_s *cmmapi6, oyObject_s object)
	Copy or Reference a CMMapi6 object. More...

OYAPI int OYEXPORT	oyCMMapi6_Release (oyCMMapi6_s **cmmapi6)
	release and possibly deallocate a oyCMMapi6_s object More...

OYAPI int OYEXPORT	oyCMMapi6_SetBackendContext (oyCMMapi6_s api, oyPointer_s ptr)
	set filter type specific runtime data More...

OYAPI oyPointer_s *OYEXPORT	oyCMMapi6_GetBackendContext (oyCMMapi6_s *api)
	get filter type specific runtime data More...

const char *	oyCMMapi6_GetDataType (oyCMMapi6_s *api, int out_direction)
	Get data type identifier. More...

oyModuleData_Convert_f	oyCMMapi6_GetConvertF (oyCMMapi6_s *api)
	Get data conversion function. More...

void	oyCMMapi6_Release__Members (oyCMMapi6_s_ *cmmapi6)
	Custom CMMapi6 destructor. More...

int	oyCMMapi6_Init__Members (oyCMMapi6_s_ *cmmapi6 OY_UNUSED)
	Custom CMMapi6 constructor. More...

int	oyCMMapi6_Copy__Members (oyCMMapi6_s_ dst, oyCMMapi6_s_ src)
	Custom CMMapi6 copy constructor. More...

Public Member Functions inherited from oyCMMapiFilter_s
OYAPI oyCMMapiFilter_s *OYEXPORT	oyCMMapiFilter_New (oyObject_s object)
	allocate a new CMMapiFilter object More...

OYAPI oyCMMapiFilter_s *OYEXPORT	oyCMMapiFilter_Copy (oyCMMapiFilter_s *cmmapifilter, oyObject_s object)
	Copy or Reference a CMMapiFilter object. More...

OYAPI int OYEXPORT	oyCMMapiFilter_Release (oyCMMapiFilter_s **cmmapifilter)
	release and possibly deallocate a oyCMMapiFilter_s object More...

OYAPI int OYEXPORT	oyCMMapiFilter_SetBackendContext (oyCMMapiFilter_s api, oyPointer_s ptr)
	set filter type specific runtime data More...

OYAPI oyPointer_s *OYEXPORT	oyCMMapiFilter_GetBackendContext (oyCMMapiFilter_s *api)
	get filter type specific runtime data More...

void	oyCMMapiFilter_Release__Members (oyCMMapiFilter_s_ *cmmapifilter)
	Custom CMMapiFilter destructor. More...

int	oyCMMapiFilter_Init__Members (oyCMMapiFilter_s_ *cmmapifilter OY_UNUSED)
	Custom CMMapiFilter constructor. More...

int	oyCMMapiFilter_Copy__Members (oyCMMapiFilter_s_ dst, oyCMMapiFilter_s_ src)
	Custom CMMapiFilter copy constructor. More...

Public Member Functions inherited from oyCMMapi_s
OYAPI oyCMMapi_s *OYEXPORT	oyCMMapi_New (oyObject_s object)
	allocate a new CMMapi object More...

OYAPI oyCMMapi_s *OYEXPORT	oyCMMapi_Copy (oyCMMapi_s *cmmapi, oyObject_s object)
	Copy or Reference a CMMapi object. More...

OYAPI int OYEXPORT	oyCMMapi_Release (oyCMMapi_s **cmmapi)
	release and possibly deallocate a oyCMMapi_s object More...

void	oyCMMapi_Set (oyCMMapi_s api, oyCMMInit_f init, oyCMMReset_f reset, oyCMMMessageFuncSet_f msg_set, const char registration, int32_t version[3], int32_t module_api[3])
	CMMapi member setter. More...

void	oyCMMapi_SetNext (oyCMMapi_s api, oyCMMapi_s next)
	chain CMMapi's More...

oyCMMapi_s *	oyCMMapi_GetNext (oyCMMapi_s *api)
	get next CMMapi More...

void	oyCMMapi_Release__Members (oyCMMapi_s_ *cmmapi)
	Custom CMMapi destructor. More...

int	oyCMMapi_Init__Members (oyCMMapi_s_ *cmmapi OY_UNUSED)
	Custom CMMapi constructor. More...

int	oyCMMapi_Copy__Members (oyCMMapi_s_ dst, oyCMMapi_s_ src)
	Custom CMMapi copy constructor. More...

Public Member Functions inherited from oyStruct_s
const char *	oyStruct_GetTextFromModule (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
	get object infos from a module More...

const char *	oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
	Get a text dump. More...

int	oyStruct_RegisterStaticMessageFunc (int type, oyStruct_RegisterStaticMessageFunc_f msg, oyStruct_RegisterStaticFreeFunc_f free_func)
	register a function for verbosity More...

const char *	oyStruct_GetInfo (oyPointer context_object, oyNAME_e type, int flags)
	get a additional string from a object More...

const char *	oyStructTypeToText (oyOBJECT_e type)
	Objects type to small string. More...

Data Fields
const oyOBJECT_e	type_
	Type of object. More...

oyStruct_Copy_f	copy
	Copy function. More...

oyStruct_Release_f	release
	Release function. More...

oyObject_s	oy_
	Oyranos internal object. More...

Data Fields inherited from oyCMMapiFilter_s
const oyOBJECT_e	type_
	Type of object. More...

oyStruct_Copy_f	copy
	Copy function. More...

oyStruct_Release_f	release
	Release function. More...

oyObject_s	oy_
	Oyranos internal object. More...

Data Fields inherited from oyCMMapi_s
const oyOBJECT_e	type_
	Type of object. More...

oyStruct_Copy_f	copy
	Copy function. More...

oyStruct_Release_f	release
	Release function. More...

oyObject_s	oy_
	Oyranos internal object. More...

Data Fields inherited from oyStruct_s
const oyOBJECT_e	type_
	Type of object. More...

oyStruct_Copy_f	copy
	Copy function. More...

oyStruct_Release_f	release
	Release function. More...

oyObject_s	oy_
	Oyranos internal object. More...

Detailed Description

Context convertor.

The context provided by a filter can be exotic. The API provides the means to get him into a known format. With this format connector it is possible to interface otherwise divergine formats.

The context is set by calling into oyConversion_RunPixels(), which calls oyFilterGraph_PrepareContexts() as needed, that oyPointer_ConvertData() and then a suitable oyCMMapi6_s format connector. The result is cached in memory by higher than this layer.

Version: Oyranos: 0.1.10

Date: 2008/12/27

Since: 2008/12/15 (Oyranos: 0.1.9)

Member Function Documentation

◆ oyCMMapi6_Copy()

OYAPI oyCMMapi6_s *OYEXPORT oyCMMapi6_Copy	(	oyCMMapi6_s *	cmmapi6,
		oyObject_s	object
	)

Copy or Reference a CMMapi6 object.

Function oyCMMapi6_Copy

The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.

Parameters

[in]	cmmapi6	CMMapi6 struct object
	object	NULL - means reference, the optional object triggers a real copy

◆ oyCMMapi6_Copy__Members()

int oyCMMapi6_Copy__Members	(	oyCMMapi6_s_ *	dst,
		oyCMMapi6_s_ *	src
	)

Custom CMMapi6 copy constructor.

Function oyCMMapi6_Copy__Members

◆ oyCMMapi6_GetBackendContext()

OYAPI oyPointer_s *OYEXPORT oyCMMapi6_GetBackendContext ( oyCMMapi6_s * api )

get filter type specific runtime data

Runtime data can be used as context by a backend during execution.

That data is apart from a filter object, which can have lifetime data associated through a oyFilterNode_GetContext(). A filter connector can have its processing data associated through oyFilterNode_SetData().

Parameters

[in] api api object

Returns: the context needed to run the filter type

Version: Oyranos: 0.9.5

Date: 2013/12/19

Since: 2013/12/19 (Oyranos: 0.9.5)

◆ oyCMMapi6_GetConvertF()

oyModuleData_Convert_f oyCMMapi6_GetConvertF ( oyCMMapi6_s * api )

Get data conversion function.

Parameters

api object

Returns: the function

Version: Oyranos: 0.9.5

Since: 2014/01/10 (Oyranos: 0.9.5)

Date: 2014/01/10

◆ oyCMMapi6_GetDataType()

const char * oyCMMapi6_GetDataType	(	oyCMMapi6_s *	api,
		int	out_direction
	)

Get data type identifier.

Parameters

api	object
out_direction	0 - input data type 1 - output data type

Returns: the identifier string

Version: Oyranos: 0.9.5

Since: 2014/01/10 (Oyranos: 0.9.5)

Date: 2014/01/10

◆ oyCMMapi6_Init__Members()

int oyCMMapi6_Init__Members ( oyCMMapi6_s_ *cmmapi6 OY_UNUSED )

Custom CMMapi6 constructor.

Function oyCMMapi6_Init__Members

◆ oyCMMapi6_New()

OYAPI oyCMMapi6_s *OYEXPORT oyCMMapi6_New ( oyObject_s object )

allocate a new CMMapi6 object

Function oyCMMapi6_New

◆ oyCMMapi6_Release()

OYAPI int OYEXPORT oyCMMapi6_Release ( oyCMMapi6_s ** cmmapi6 )

release and possibly deallocate a oyCMMapi6_s object

Function oyCMMapi6_Release

Parameters

[in,out] cmmapi6 CMMapi6 struct object

◆ oyCMMapi6_Release__Members()

void oyCMMapi6_Release__Members ( oyCMMapi6_s_ * cmmapi6 )

Custom CMMapi6 destructor.

Function oyCMMapi6_Release__Members

◆ oyCMMapi6_SetBackendContext()

OYAPI int OYEXPORT oyCMMapi6_SetBackendContext	(	oyCMMapi6_s *	api,
		oyPointer_s *	ptr
	)

set filter type specific runtime data

Runtime data can be used as context by a backend during execution. The data is typical set during backend load.

That data is apart from a filter object, which can have lifetime data associated through a oyFilterNode_GetContext(). A filter connector can have its processing data associated through oyFilterNode_SetData().

Parameters

[in,out]	api	api object
[in]	ptr	the data needed to run the filter type

Returns: error

Version: Oyranos: 0.9.5

Date: 2013/12/19

Since: 2013/12/19 (Oyranos: 0.9.5)

Field Documentation

◆ copy

oyStruct_Copy_f oyCMMapi6_s::copy

Copy function.

◆ oy_

oyObject_s oyCMMapi6_s::oy_

Oyranos internal object.

Features name and hash. Do not change during object life time.

◆ release

oyStruct_Release_f oyCMMapi6_s::release

Release function.

◆ type_

const oyOBJECT_e oyCMMapi6_s::type_

Type of object.

The struct type tells Oyranos how to interprete hidden fields.

Public Types

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ oyCMMapi6_Copy()

◆ oyCMMapi6_Copy__Members()

◆ oyCMMapi6_GetBackendContext()

◆ oyCMMapi6_GetConvertF()

◆ oyCMMapi6_GetDataType()

◆ oyCMMapi6_Init__Members()

◆ oyCMMapi6_New()

◆ oyCMMapi6_Release()

◆ oyCMMapi6_Release__Members()

◆ oyCMMapi6_SetBackendContext()

Field Documentation

◆ copy

◆ oy_

◆ release

◆ type_