Data processing node. More...

#include <oyCMMapi7_s.h>

Inheritance diagram for oyCMMapi7_s:

Collaboration diagram for oyCMMapi7_s:

Public Types
typedef int(*	oyCMMFilterPlug_Run_f) (oyFilterPlug_s plug, oyPixelAccess_s pixel_access)
	get a pixel or channel from the previous filter 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 oyCMMapi7_s *OYEXPORT	oyCMMapi7_New (oyObject_s object)
	allocate a new CMMapi7 object More...

OYAPI oyCMMapi7_s *OYEXPORT	oyCMMapi7_Copy (oyCMMapi7_s *cmmapi7, oyObject_s object)
	Copy or Reference a CMMapi7 object. More...

OYAPI int OYEXPORT	oyCMMapi7_Release (oyCMMapi7_s **cmmapi7)
	release and possibly deallocate a oyCMMapi7_s object More...

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

OYAPI oyPointer_s *OYEXPORT	oyCMMapi7_GetBackendContext (oyCMMapi7_s *api)
	get filter type specific runtime data More...

OYAPI oyCMMapi7_s *OYEXPORT	oyCMMapi7_Create (oyCMMInit_f init, oyCMMReset_f reset, oyCMMMessageFuncSet_f msg_set, const char registration, int32_t version[3], int32_t module_api[3], const char context_type, oyCMMFilterPlug_Run_f run, oyConnector_s plugs, uint32_t plugs_n, uint32_t plugs_last_add, oyConnector_s sockets, uint32_t sockets_n, uint32_t sockets_last_add, const char **properties, oyObject_s object)
	Create a oyCMMapi7_s filter object. More...

void	oyCMMapi7_Release__Members (oyCMMapi7_s_ *cmmapi7)
	Custom CMMapi7 destructor. More...

int	oyCMMapi7_Init__Members (oyCMMapi7_s_ *cmmapi7 OY_UNUSED)
	Custom CMMapi7 constructor. More...

int	oyCMMapi7_Copy__Members (oyCMMapi7_s_ dst, oyCMMapi7_s_ src)
	Custom CMMapi7 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

Data processing node.

The structure forms a node element in a directed acyclic graph. It's connectors allow to communicate cababilities and semantics. This node type acts mostly on data processing.

The node can be inserted inside oyConversion_CreateBasicPixelsFromBuffers() or used directly with oyFilterNode_NewWith() and oyFilterNode_Connect().

It is possible to delegate parameter or context creation to other specialised filter types. The filter context can be stored in oyFilterNode_s::backend_data if the oyCMMapi7_s::context_type is filled with a understood format hint. The registration should provide keywords to select the processing function.

(in CM jargon - interpolator)

Version: Oyranos: 0.1.10

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

Date: 2008/12/27

Examples:: oyranos_cmm_oJPG.c.

Member Function Documentation

◆ oyCMMapi7_Copy()

OYAPI oyCMMapi7_s *OYEXPORT oyCMMapi7_Copy	(	oyCMMapi7_s *	cmmapi7,
		oyObject_s	object
	)

Copy or Reference a CMMapi7 object.

Function oyCMMapi7_Copy

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

Parameters

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

◆ oyCMMapi7_Copy__Members()

int oyCMMapi7_Copy__Members	(	oyCMMapi7_s_ *	dst,
		oyCMMapi7_s_ *	src
	)

Custom CMMapi7 copy constructor.

Function oyCMMapi7_Copy__Members

◆ oyCMMapi7_Create()

OYAPI oyCMMapi7_s *OYEXPORT oyCMMapi7_Create	(	oyCMMInit_f	init,
		oyCMMReset_f	reset,
		oyCMMMessageFuncSet_f	msg_set,
		const char *	registration,
		int32_t	version[3],
		int32_t	module_api[3],
		const char *	context_type,
		oyCMMFilterPlug_Run_f	run,
		oyConnector_s **	plugs,
		uint32_t	plugs_n,
		uint32_t	plugs_last_add,
		oyConnector_s **	sockets,
		uint32_t	sockets_n,
		uint32_t	sockets_last_add,
		const char **	properties,
		oyObject_s	object
	)

Create a oyCMMapi7_s filter object.

Function oyCMMapi7_Create

Parameters

init	custom initialisation
reset	custom deinitialisation
msg_set	message function setter
registration	the modules Registration string,
version	module version 0: major - should be stable for the live time of a filter 1: minor - mark new features 2: patch version - correct errors
module_api	tell compatibility with Oyranos API 0: last major Oyranos version during development time, e.g. 0 1: last minor Oyranos version during development time, e.g. 9 2: last Oyranos patch version during development time, e.g. 5
context_type	four byte identifier if a context is needed A additional oyCMMapi6_s module can, then be provided to convert between context formats, registred by this identifier.
run	the filter function
plugs	a zero terminated list of connectors
plugs_n	the number of plugs in 'plugs'
plugs_last_add	the number of accepted repeats of the last plug
sockets	a zero terminated list of connectors
sockets_n	the number of sockets in 'sockets'
sockets_last_add	the number of accepted repeats of the last socket
properties	A zero terminated list of strings. The semantics are plugin defined. e.g.: {"key1=value1","key2=value2",0}
object	Oyranos object (optional)

See also: oyCMMapi_s::oyCMMapi_Set()

Version: Oyranos: 0.9.7

Date: 2019/09/03

Since: 2013/07/11 (Oyranos: 0.9.5)

Examples:: oyranos_cmm_oJPG.c.

◆ oyCMMapi7_GetBackendContext()

OYAPI oyPointer_s *OYEXPORT oyCMMapi7_GetBackendContext ( oyCMMapi7_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)

◆ oyCMMapi7_Init__Members()

int oyCMMapi7_Init__Members ( oyCMMapi7_s_ *cmmapi7 OY_UNUSED )

Custom CMMapi7 constructor.

Function oyCMMapi7_Init__Members

◆ oyCMMapi7_New()

OYAPI oyCMMapi7_s *OYEXPORT oyCMMapi7_New ( oyObject_s object )

allocate a new CMMapi7 object

Function oyCMMapi7_New

◆ oyCMMapi7_Release()

OYAPI int OYEXPORT oyCMMapi7_Release ( oyCMMapi7_s ** cmmapi7 )

release and possibly deallocate a oyCMMapi7_s object

Function oyCMMapi7_Release

Parameters

[in,out] cmmapi7 CMMapi7 struct object

◆ oyCMMapi7_Release__Members()

void oyCMMapi7_Release__Members ( oyCMMapi7_s_ * cmmapi7 )

Custom CMMapi7 destructor.

Function oyCMMapi7_Release__Members

◆ oyCMMapi7_SetBackendContext()

OYAPI int OYEXPORT oyCMMapi7_SetBackendContext	(	oyCMMapi7_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 oyCMMapi7_s::copy

Copy function.

◆ oy_

oyObject_s oyCMMapi7_s::oy_

Oyranos internal object.

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

Examples:: oyranos_cmm_oJPG.c.

◆ release

oyStruct_Release_f oyCMMapi7_s::release

Release function.

◆ type_

const oyOBJECT_e oyCMMapi7_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

◆ oyCMMapi7_Copy()

◆ oyCMMapi7_Copy__Members()

◆ oyCMMapi7_Create()

◆ oyCMMapi7_GetBackendContext()

◆ oyCMMapi7_Init__Members()

◆ oyCMMapi7_New()

◆ oyCMMapi7_Release()

◆ oyCMMapi7_Release__Members()

◆ oyCMMapi7_SetBackendContext()

Field Documentation

◆ copy

◆ oy_

◆ release

◆ type_