Conversion API's
[Alpha API's]

Collaboration diagram for Conversion API's:

Data Structures

struct  oyConnector_s
 a filter connection description structureThis structure holds informations about the connection capabilities. It holds common structure members of oyFilterPlug_s and oyFilterSocket_s. More...
struct  oyFilterSocket_s
 a filter connection structureThe passive output version of a oyConnector_s. More...
struct  oyFilterPlug_s
 a filter connection structureThe active input version of a oyConnector_s. Each plug can connect to exact one socket. More...
struct  oyFilterPlugs_s
 a FilterPlugs list More...
struct  oyFilter_s
 a filter to manipulate a imageThis is the Oyranos filter object. Filters are categorised into basic classes of filters described in the filter_type_ member. Filters implement a container for data and options. Filters can be manipulated by changing their options or data set. More...
struct  oyFilters_s
 a Filters list More...
struct  oyFilterNode_s
 a FilterNode objectFilter nodes chain filters into a oyConversion_s graph. The filter nodes use plugs and sockets for creating connections. Each plug can only connect to one socket. More...
struct  oyPixelAccess_s
 control pixel access orderA struct to control pixel access. It is a kind of flexible pixel iterator. The order or pattern of access is defined by the array_xy and start_[x,y] variables. More...
struct  oyConversion_s
 a filter chain or graph to manipulate a imageOrder of filters matters. The processing direction is a bit like raytracing as nodes request their parent. More...

Enumerations

enum  oyFILTER_REG_e { ,
  oyFILTER_REG_TOP, oyFILTER_REG_DOMAIN, oyFILTER_REG_TYPE, oyFILTER_REG_APPLICATION,
  oyFILTER_REG_OPTION
}
enum  oyFILTER_TYPE_e {
  oyFILTER_TYPE_NONE, oyFILTER_TYPE_COLOUR, oyFILTER_TYPE_TONEMAP, oyFILTER_TYPE_IMAGE,
  oyFILTER_TYPE_GENERIC
}
 

basic filter classes

These types are basic ones and valid to Oyranos and its usage as CMM framework.

More...
enum  oyCONNECTOR_e {
  oyCONNECTOR_MANIPULATOR, oyCONNECTOR_GENERATOR, oyCONNECTOR_IMAGE, oyCONNECTOR_OBSERVER,
  oyCONNECTOR_SPLITTER, oyCONNECTOR_COMPOSITOR, oyCONNECTOR_CONVERTOR_PIXELDATA, oyCONNECTOR_CONVERTOR_PIXELDATA_LOSSY,
  oyCONNECTOR_COMPOSITOR_CHANNEL, oyCONNECTOR_SPLITTER_CHANNEL, oyCONNECTOR_ANALYSIS
}
 

basic connector classes

More...
enum  oyCONNECTOR_EVENT_e {
  oyCONNECTOR_EVENT_OK, oyCONNECTOR_EVENT_CONNECTED, oyCONNECTOR_EVENT_RELEASED, oyCONNECTOR_EVENT_IMAGE_DATA_CHANGED,
  oyCONNECTOR_EVENT_IMAGE_STORAGE_CHANGED, oyCONNECTOR_EVENT_INCOMPATIBLE_IMAGE, oyCONNECTOR_EVENT_INCOMPATIBLE_PROFILE, oyCONNECTOR_EVENT_INCOMPLETE_GRAPH
}
 

connector events types

More...

Functions

const char * oyFilterTypeToText (oyFILTER_TYPE_e filter_type, oyNAME_e type)
 oyFILTER_TYPE_e to small text
oyFILTER_TYPE_e oyFilterRegistrationToType (const char *registration)
 analyse registration string
char * oyFilterRegistrationToText (const char *registration, oyFILTER_REG_e type, oyAlloc_f allocateFunc)
 analyse registration string
int oyFilterRegistrationMatch (const char *registration, const char *pattern)
 analyse registration string and compare with a given pattern
OYAPI oyConnector_s *OYEXPORT oyConnector_s::oyConnector_New (oyObject_s object)
 allocate a new Connector object
OYAPI oyConnector_s *OYEXPORT oyConnector_s::oyConnector_Copy (oyConnector_s *obj, oyObject_s object)
 copy or reference a Connector object
OYAPI int OYEXPORT oyConnector_s::oyConnector_Release (oyConnector_s **obj)
 release and possibly deallocate a Connector object
OYAPI int OYEXPORT oyFilterSocket_s::oyFilterSocket_Callback (oyFilterSocket_s *c, oyCONNECTOR_EVENT_e e)
 tell about a oyConversion_s event
OYAPI int OYEXPORT oyFilterPlug_s::oyFilterPlug_Callback (oyFilterPlug_s *c, oyCONNECTOR_EVENT_e e)
 tell about a oyConversion_s event
OYAPI oyFilterSocket_s *OYEXPORT oyFilterSocket_s::oyFilterSocket_New (oyObject_s object)
 allocate a new FilterSocket object
OYAPI oyFilterSocket_s *OYEXPORT oyFilterSocket_s::oyFilterSocket_Copy (oyFilterSocket_s *obj, oyObject_s object)
 copy or reference a FilterSocket object
OYAPI int OYEXPORT oyFilterSocket_s::oyFilterSocket_Release (oyFilterSocket_s **obj)
 release and possibly deallocate a FilterSocket object
OYAPI int OYEXPORT oyFilterPlug_s::oyFilterPlug_ConnectIntoSocket (oyFilterPlug_s **p, oyFilterSocket_s **s)
 connect a oyFilterPlug_s with a oyFilterSocket_s
OYAPI oyFilterPlug_s *OYEXPORT oyFilterPlug_s::oyFilterPlug_New (oyObject_s object)
 allocate a new FilterPlug object
OYAPI oyFilterPlug_s *OYEXPORT oyFilterPlug_s::oyFilterPlug_Copy (oyFilterPlug_s *obj, oyObject_s object)
 copy or reference a FilterPlug object
OYAPI int OYEXPORT oyFilterPlug_s::oyFilterPlug_Release (oyFilterPlug_s **obj)
 release and possibly deallocate a FilterPlug object
OYAPI oyFilterPlugs_s *OYEXPORT oyFilterPlugs_s::oyFilterPlugs_New (oyObject_s object)
 allocate a new FilterPlugs list
OYAPI oyFilterPlugs_s *OYEXPORT oyFilterPlugs_s::oyFilterPlugs_Copy (oyFilterPlugs_s *obj, oyObject_s object)
 copy or reference a FilterPlugs list
OYAPI int OYEXPORT oyFilterPlugs_s::oyFilterPlugs_Release (oyFilterPlugs_s **obj)
 release and possibly deallocate a FilterPlugs list
OYAPI oyFilterPlugs_s *OYEXPORT oyFilterPlugs_s::oyFilterPlugs_MoveIn (oyFilterPlugs_s *list, oyFilterPlug_s **obj, int pos)
 add a element to a FilterPlugs list
OYAPI int OYEXPORT oyFilterPlugs_s::oyFilterPlugs_ReleaseAt (oyFilterPlugs_s *list, int pos)
 release a element from a FilterPlugs list
OYAPI oyFilterPlug_s *OYEXPORT oyFilterPlugs_s::oyFilterPlugs_Get (oyFilterPlugs_s *list, int pos)
 get a element of a FilterPlugs list
OYAPI int OYEXPORT oyFilterPlugs_s::oyFilterPlugs_Count (oyFilterPlugs_s *list)
 count the elements in a FilterPlugs list
oyFilter_soyFilter_s::oyFilter_New (oyFILTER_TYPE_e filter_type, const char *registration, const char *cmm_required, oyOptions_s *options, oyObject_s object)
 lookup and initialise a new filter object
oyFilter_soyFilter_s::oyFilter_Copy (oyFilter_s *filter, oyObject_s object)
 copy or reference a filter object
int oyFilter_s::oyFilter_Release (oyFilter_s **obj)
 release and zero a filter object
const char * oyFilter_s::oyFilter_GetText (oyFilter_s *filter, oyNAME_e name_type)
 get text
const char * oyFilter_s::oyFilter_GetName (oyFilter_s *filter, oyNAME_e name_type)
 get name
const char * oyFilter_s::oyFilter_CategoryGet (oyFilter_s *filter, int nontranslated)
 get category string
oyOptions_soyFilter_s::oyFilter_OptionsGet (oyFilter_s *filter, int flags)
 get filter options
OYAPI oyConnector_s *OYEXPORT oyFilter_s::oyFilter_ShowConnector (oyFilter_s *filter, int as_pos, int is_plug)
 get a connector description from a filter backend
OYAPI int OYEXPORT oyFilter_s::oyFilter_ShowConnectorCount (oyFilter_s *filter, int is_plug, uint32_t *last_adds)
 get the connector count from a filter backend
OYAPI oyFilters_s *OYEXPORT oyFilters_s::oyFilters_New (oyObject_s object)
 allocate a new Filters list
OYAPI oyFilters_s *OYEXPORT oyFilters_s::oyFilters_Copy (oyFilters_s *obj, oyObject_s object)
 copy or reference a Filters list
OYAPI int OYEXPORT oyFilters_s::oyFilters_Release (oyFilters_s **obj)
 release and possibly deallocate a Filters list
OYAPI oyFilters_s *OYEXPORT oyFilters_s::oyFilters_MoveIn (oyFilters_s *list, oyFilter_s **obj, int pos)
 add a element to a Filters list
OYAPI int OYEXPORT oyFilters_s::oyFilters_ReleaseAt (oyFilters_s *list, int pos)
 release a element from a Filters list
OYAPI oyFilter_s *OYEXPORT oyFilters_s::oyFilters_Get (oyFilters_s *list, int pos)
 get a element of a Filters list
OYAPI int OYEXPORT oyFilters_s::oyFilters_Count (oyFilters_s *list)
 count the elements in a Filters list
oyFilterNode_soyFilterNode_s::oyFilterNode_New (oyObject_s object)
 allocate and initialise a new filter node object
oyFilterNode_soyFilterNode_s::oyFilterNode_Create (oyFilter_s *filter, oyObject_s object)
 initialise a new filter node object properly
oyFilterNode_soyFilterNode_s::oyFilterNode_Copy (oyFilterNode_s *node, oyObject_s object)
 copy or reference a filter node object
int oyFilterNode_s::oyFilterNode_Release (oyFilterNode_s **obj)
 release and zero a filter node object
OYAPI int OYEXPORT oyFilterNode_s::oyFilterNode_ConnectorMatch (oyFilterNode_s *node_first, int pos_first, oyConnector_s *connector_second)
 check if a connector match to a FilterNode
OYAPI oyFilterSocket_s *OYEXPORT oyFilterNode_s::oyFilterNode_GetSocket (oyFilterNode_s *node, int pos)
 get a oyFilterSocket_s of type from a FilterNode
OYAPI oyFilterPlug_s *OYEXPORT oyFilterNode_s::oyFilterNode_GetPlug (oyFilterNode_s *node, int pos)
 get a oyFilterPlug_s of type from a FilterNode
const char * oyFilterNode_s::oyFilterNode_GetText (oyFilterNode_s *node, oyNAME_e name_type)
 serialise filter node to text
oyPointer oyFilterNode_s::oyFilterNode_TextToInfo (oyFilterNode_s *node, size_t *size, oyAlloc_f allocateFunc)
 serialise filter node to binary
oyPixelAccess_soyPixelAccess_s::oyPixelAccess_Create (int32_t start_x, int32_t start_y, oyFilterSocket_s *sock, oyPIXEL_ACCESS_TYPE_e type, oyObject_s object)
 allocate iand initialise a basic oyPixelAccess_s object
oyPixelAccess_soyPixelAccess_s::oyPixelAccess_Copy (oyPixelAccess_s *obj, oyObject_s object)
 copy or reference a oyPixelAccess_s object
int oyPixelAccess_s::oyPixelAccess_Release (oyPixelAccess_s **obj)
 release and zero a oyPixelAccess_s object
int oyPixelAccess_s::oyPixelAccess_CalculateNextStartPixel (oyPixelAccess_s *obj, oyFilterPlug_s *requestor_plug)
 predict the next start position
oyConversion_soyConversion_s::oyConversion_CreateBasic (oyImage_s *input, oyImage_s *output, oyOptions_s *options, oyObject_s object)
 allocate initialise a basic oyConversion_s object
oyConversion_soyConversion_s::oyConversion_CreateInput (oyImage_s *input, oyObject_s object)
 initialise from a input image for later adding more filters
oyConversion_soyConversion_s::oyConversion_Copy (oyConversion_s *conversion, oyObject_s object)
 copy or reference a oyConversion_s object
int oyConversion_s::oyConversion_Release (oyConversion_s **obj)
 release and zero a conversion object
int oyConversion_s::oyConversion_FilterAdd (oyConversion_s *conversion, oyFilter_s *filter)
 add a filter to a oyConversion_s filter list
int oyConversion_s::oyConversion_OutputAdd (oyConversion_s *conversion, oyImage_s *output)
 close a oyConversion_s with a target image
int oyConversion_s::oyConversion_Run (oyConversion_s *conversion, oyPixelAccess_s *pixel_access, oyRegion_s *region)
 iterate over a conversion graph
oyPointer * oyConversion_s::oyConversion_GetOnePixel (oyConversion_s *conversion, int32_t x, int32_t y, int32_t *feedback)
 compute one pixel at the given position
int ** oyConversion_s::oyConversion_GetAdjazenzlist (oyConversion_s *conversion, oyAlloc_f allocateFunc)
 adjazenzliste of a conversion graph
char * oyConversion_s::oyConversion_ToText (oyConversion_s *conversion, const char *head_line, int reserved, oyAlloc_f allocateFunc)
 text description of a conversion graph

Detailed Description

Colour conversion front end API's.

Colour conversions are realised by structures called acyclic graphs.

About Graphs:
The top object a user will handle is of type oyConversion_s. This contains oyFilterNode_s objects, which describe the connections of each processing element, such as images with attached data and profile, and the filters. The Oyranos node connection concept is splitted into various structures.

inline_dotgraph_1.dot

Connectors have tree missions:

Routing:
The connector output, called socket, side is primarily passive. The data stream is requested or viewed by the input side, called plug. Changes are propagated by events (?). This turns the acyclic graph into a looped one. The event use the same graph just in the other direction. Events and data requests are distingt. A plug local to the filter or filter node can be connected to a remote socket connector and vice versa.

inline_dotgraph_2.dot

Status information can be passed from the input side to the output side by callbacks.

inline_dotgraph_3.dot

The data flows from the socket to the plug.

inline_dotgraph_4.dot

A oyFilterNode_s can have various oyFilterPlug_s ' to obtain data from different sources. The required number is described in the oyCMMapi4_s structure, which is part of oyFilter_s. But each plug can only connect to one socket.

inline_dotgraph_5.dot

oyFilterSocket_s is designed to accept arbitrary numbers of connections to allow for viewing on a filters data output or observe its state changes.

inline_dotgraph_6.dot

Enumeration Type Documentation

basic connector classes

Version:
Oyranos: 0.1.8
Since:
2008/00/00 (Oyranos: 0.1.8)
Date:
2008/00/00
Enumerator:
oyCONNECTOR_MANIPULATOR 

a data manipulator. e.g. a normal filter

oyCONNECTOR_GENERATOR 

a data generator, e.g. checkerboard, gradient

oyCONNECTOR_IMAGE 

a pixel data provider, e.g. oyFILTER_TYPE_IMAGE

oyCONNECTOR_OBSERVER 

observer, a endpoint, only input, e.g. text log, thumbnail viewer

oyCONNECTOR_SPLITTER 

a routing element, without data altering

oyCONNECTOR_COMPOSITOR 

combines or splits image data, e.g. blending

oyCONNECTOR_CONVERTOR_PIXELDATA 

converts pixel layout to other formats

oyCONNECTOR_CONVERTOR_PIXELDATA_LOSSY 

converts pixel layout to other formats, with precission loss, e.g. float -> uint8_t, only relevant for output connectors

oyCONNECTOR_COMPOSITOR_CHANNEL 

combines gray channels, e.g. from colour

oyCONNECTOR_SPLITTER_CHANNEL 

provides gray scale views of channels

oyCONNECTOR_ANALYSIS 

provides values or text, only output

connector events types

Version:
Oyranos: 0.1.8
Since:
2008/00/00 (Oyranos: 0.1.8)
Date:
2008/00/00
Enumerator:
oyCONNECTOR_EVENT_OK 

kind of ping

oyCONNECTOR_EVENT_CONNECTED 

connection established

oyCONNECTOR_EVENT_RELEASED 

released the connection

oyCONNECTOR_EVENT_IMAGE_DATA_CHANGED 

call to update image views

oyCONNECTOR_EVENT_IMAGE_STORAGE_CHANGED 

new data accessors

oyCONNECTOR_EVENT_INCOMPATIBLE_IMAGE 

can not process image

oyCONNECTOR_EVENT_INCOMPATIBLE_PROFILE 

can not handle profile

oyCONNECTOR_EVENT_INCOMPLETE_GRAPH 

can not completely process

see:http://lists.freedesktop.org/archives/openicc/2008q4/001724.html

Enumerator:
oyFILTER_REG_TOP 

e.g. "sw" for filters

oyFILTER_REG_DOMAIN 

e.g. "oyranos.org"

oyFILTER_REG_TYPE 

oyFilterTypeToText/oyFILTER_TYPE_e, e.g. "generic" filter group

oyFILTER_REG_APPLICATION 

e.g. "scale" filter name

oyFILTER_REG_OPTION 

e.g. "x" filter option

basic filter classesThese types are basic ones and valid to Oyranos and its usage as CMM framework.

Version:
Oyranos: 0.1.8
Since:
2008/00/00 (Oyranos: 0.1.8)
Date:
2008/00/00
Enumerator:
oyFILTER_TYPE_NONE 

nothing

oyFILTER_TYPE_COLOUR 

colour

oyFILTER_TYPE_TONEMAP 

contrast or tone mapping

oyFILTER_TYPE_IMAGE 

image storage

oyFILTER_TYPE_GENERIC 

generic


Function Documentation

OYAPI oyConnector_s *OYEXPORT oyConnector_Copy ( oyConnector_s obj,
oyObject_s  object 
) [related, inherited]

copy or reference a Connector object

Function oyConnector_Copy

Parameters:
[in] obj struct object
object the optional object
Version:
Oyranos: 0.1.8
Since:
2008/07/27 (Oyranos: 0.1.8)
Date:
2008/07/27

References oyConnector_s::oy_, and oyObject_s::oyObject_Copy().

Referenced by oyConnector_s::oyConnector_New(), and oyFilter_s::oyFilter_ShowConnector().

OYAPI oyConnector_s *OYEXPORT oyConnector_New ( oyObject_s  object  )  [related, inherited]

allocate a new Connector object

Function oyConnector_New

Version:
Oyranos: 0.1.8
Since:
2008/07/27 (Oyranos: 0.1.8)
Date:
2008/07/27

References oyConnector_s::oyConnector_Copy(), oyConnector_s::oyConnector_Release(), oyOBJECT_CONNECTOR_S, oyObject_s::oyObject_NewFrom(), oyObject_s::oyObject_SetParent(), and oyConnector_s::release.

OYAPI int OYEXPORT oyConnector_Release ( oyConnector_s **  obj  )  [related, inherited]
oyConversion_s * oyConversion_Copy ( oyConversion_s conversion,
oyObject_s  object 
) [related, inherited]

copy or reference a oyConversion_s object

Function: oyConversion_Copy

Parameters:
[in] conversion conversion object
object the optional object
Version:
Oyranos: 0.1.8
Since:
2008/06/26 (Oyranos: 0.1.8)
Date:
2008/06/26

References oyConversion_s::oy_, and oyObject_s::oyObject_Copy().

oyConversion_s * oyConversion_CreateBasic ( oyImage_s input,
oyImage_s output,
oyOptions_s options,
oyObject_s  object 
) [related, inherited]

allocate initialise a basic oyConversion_s object

Function: oyConversion_CreateBasic

Version:
Oyranos: 0.1.8
Date:
2008/06/26
Since:
2008/06/26 (Oyranos: 0.1.8)

References oyConversion_s::oyConversion_CreateInput(), oyConversion_s::oyConversion_FilterAdd(), oyConversion_s::oyConversion_OutputAdd(), oyConversion_s::oyConversion_Release(), oyFilter_s::oyFilter_New(), and oyFILTER_TYPE_COLOUR.

oyConversion_s * oyConversion_CreateInput ( oyImage_s input,
oyObject_s  object 
) [related, inherited]

initialise from a input image for later adding more filters

Function: oyConversion_CreateInput

Version:
Oyranos: 0.1.8
Date:
2008/07/07
Since:
2008/07/07 (Oyranos: 0.1.8)

References oyFilterSocket_s::data, oyConversion_s::input, oyConversion_s::oy_, oyConversion_s::oyConversion_Release(), oyFilter_s::oyFilter_New(), oyFilter_s::oyFilter_Release(), oyFILTER_TYPE_IMAGE, oyFilterNode_s::oyFilterNode_Create(), oyFilterNode_s::oyFilterNode_GetSocket(), and oyImage_s::oyImage_Copy().

Referenced by oyConversion_s::oyConversion_CreateBasic().

int oyConversion_FilterAdd ( oyConversion_s conversion,
oyFilter_s filter 
) [related, inherited]
int ** oyConversion_GetAdjazenzlist ( oyConversion_s conversion,
oyAlloc_f  allocateFunc 
) [related, inherited]

adjazenzliste of a conversion graph

Function: oyConversion_GetAdjazenzlist

Parameters:
[in] conversion conversion object
[in] allocateFunc allocation function
Returns:
the adjazenzlist
Version:
Oyranos: 0.1.8
Since:
2008/07/09 (Oyranos: 0.1.8)
Date:
2008/07/09
oyPointer * oyConversion_GetOnePixel ( oyConversion_s conversion,
int32_t  x,
int32_t  y,
int32_t *  feedback 
) [related, inherited]

compute one pixel at the given position

Function: oyConversion_GetOnePixel

Parameters:
[in,out] conversion conversion object
[in] x position x
[in] y position y
[out] feedback -1 end; 0 on success; error > 1
Returns:
the pixel pointer
Version:
Oyranos: 0.1.8
Since:
2008/07/14 (Oyranos: 0.1.8)
Date:
2008/07/14

References oyFilter_s::api4_, oyFilterNode_s::filter, oyFilterSocket_s::node, oyConversion_s::out_, oyPIXEL_ACCESS_POINT, oyPixelAccess_s::oyPixelAccess_Create(), oyFilterPlug_s::remote_socket_, and oyFilterNode_s::sockets.

int oyConversion_OutputAdd ( oyConversion_s conversion,
oyImage_s output 
) [related, inherited]

close a oyConversion_s with a target image

Function oyConversion_OutputAdd

Internally the image will be attached to the socket at which the last node points through a plug.

Parameters:
[in,out] conversion conversion object
[in] output output image
Returns:
error
Version:
Oyranos: 0.1.8
Since:
2008/07/06 (Oyranos: 0.1.8)
Date:
2008/07/06

References oyFilterSocket_s::data, oyFilterNode_s::filter, oyFilter_s::filter_type_, oyConversion_s::input, oyConversion_s::out_, oyConversion_s::oyConversion_FilterAdd(), oyFilter_s::oyFilter_New(), oyFILTER_TYPE_COLOUR, oyFILTER_TYPE_IMAGE, oyFilterNode_s::oyFilterNode_Copy(), oyFilterNode_s::oyFilterNode_GetPlug(), oyFilterNode_s::oyFilterNode_Release(), oyImage_s::oyImage_Copy(), oyImage_s::oyImage_Release(), and oyFilterPlug_s::remote_socket_.

Referenced by oyConversion_s::oyConversion_CreateBasic().

int oyConversion_Release ( oyConversion_s **  obj  )  [related, inherited]

release and zero a conversion object

Function: oyConversion_Release

Todo:
complete the implementation
Parameters:
[in,out] obj conversion object
Version:
Oyranos: 0.1.8
Since:
2008/06/24 (Oyranos: 0.1.8)
Date:
2008/06/25

References oyConversion_s::input, oyConversion_s::out_, oyConversion_s::oy_, oyFilterNode_s::oyFilterNode_Release(), oyOBJECT_CONVERSION_S, oyObject_s::oyObject_Release(), and oyConversion_s::type_.

Referenced by oyConversion_s::oyConversion_CreateBasic(), and oyConversion_s::oyConversion_CreateInput().

int oyConversion_Run ( oyConversion_s conversion,
oyPixelAccess_s pixel_access,
oyRegion_s region 
) [related, inherited]

iterate over a conversion graph

Function: oyConversion_Run

Parameters:
[in,out] conversion conversion object
[in,out] pixel_access pixel iterator configuration
[in] region the region relative to the output image viewport to render
Returns:
0 on success, else error
Version:
Oyranos: 0.1.8
Since:
2008/07/06 (Oyranos: 0.1.8)
Date:
2008/10/02

References oyFilter_s::api4_, oyFilterSocket_s::data, oyFilterNode_s::filter, oyConversion_s::out_, oyImage_s::oyImage_FillArray(), oyFilterNode_s::plugs, and oyFilterPlug_s::remote_socket_.

char * oyConversion_ToText ( oyConversion_s conversion,
const char *  head_line,
int  reserved,
oyAlloc_f  allocateFunc 
) [related, inherited]

text description of a conversion graph

Function: oyConversion_ToText

Todo:
Should this function generate XFORMS compatible output? How?
Parameters:
[in] conversion conversion object
[in] head_line text for inclusion
[in] reserved future format selector (dot, xml ...)
[in] allocateFunc allocation function
Returns:
the adjazenzlist
Version:
Oyranos: 0.1.8
Since:
2008/10/04 (Oyranos: 0.1.8)
Date:
2008/10/04

References oyConversion_s::input, oyOBJECT_CONVERSION_S, and oyConversion_s::type_.

const char * oyFilter_CategoryGet ( oyFilter_s filter,
int  nontranslated 
) [related, inherited]

get category string

Function oyFilter_CategoryGet

Parameters:
[in,out] filter filter object
nontranslated switch for translation
Version:
Oyranos: 0.1.8
Since:
2008/06/26 (Oyranos: 0.1.8)
Date:
2008/06/26

References oyFilter_s::category_.

oyFilter_s * oyFilter_Copy ( oyFilter_s filter,
oyObject_s  object 
) [related, inherited]

copy or reference a filter object

Function oyFilter_Copy

Parameters:
[in] filter filter object
object the optional object
Version:
Oyranos: 0.1.8
Since:
2008/06/24 (Oyranos: 0.1.8)
Date:
2008/06/25

References oyFilter_s::oy_, and oyObject_s::oyObject_Copy().

Referenced by oyFilterNode_s::oyFilterNode_Create().

const char * oyFilter_GetName ( oyFilter_s filter,
oyNAME_e  name_type 
) [related, inherited]

get name

Function oyFilter_GetName

provides the original filter names

Parameters:
[in,out] filter filter object
name_type type of name
Version:
Oyranos: 0.1.8
Since:
2008/06/26 (Oyranos: 0.1.8)
Date:
2008/06/26

References oyFilter_s::name_.

Referenced by oyConversion_s::oyConversion_FilterAdd().

const char * oyFilter_GetText ( oyFilter_s filter,
oyNAME_e  name_type 
) [related, inherited]

get text

Function oyFilter_GetText

oyNAME_NAME provides a XML element with child elements and attributes

Parameters:
[in,out] filter filter object
name_type type of name
Version:
Oyranos: 0.1.8
Since:
2008/07/18 (Oyranos: 0.1.8)
Date:
2008/07/18

References oyFilter_s::api4_, oyFilter_s::category_, oyFilter_s::oy_, oyNAME_NAME, oyObject_s::oyObject_GetName(), oyObject_s::oyObject_SetName(), oyProfile_s::oyProfile_GetText(), oyProfiles_s::oyProfiles_Count(), oyProfiles_s::oyProfiles_Get(), and oyFilter_s::registration_.

Referenced by oyFilterNode_s::oyFilterNode_GetText().

oyFilter_s * oyFilter_New ( oyFILTER_TYPE_e  filter_type,
const char *  registration,
const char *  cmm_required,
oyOptions_s options,
oyObject_s  object 
) [related, inherited]
oyOptions_s * oyFilter_OptionsGet ( oyFilter_s filter,
int  flags 
) [related, inherited]

get filter options

Function: oyFilter_OptionsGet

Parameters:
[in,out] filter filter object
flags possible: OY_FILTER_GET_DEFAULT | oyOPTIONSOURCE_FILTER | oyOPTIONATTRIBUTE_ADVANCED
Version:
Oyranos: 0.1.8
Since:
2008/06/26 (Oyranos: 0.1.8)
Date:
2008/06/26

References oyFilter_s::options_, oyFilter_s::oy_, oyOptions_s::oyOptions_Copy(), and oyOptions_s::oyOptions_ForFilter_().

int oyFilter_Release ( oyFilter_s **  obj  )  [related, inherited]

release and zero a filter object

Function oyFilter_Release

Todo:
complete the implementation
Parameters:
[in,out] obj filter object
Version:
Oyranos: 0.1.8
Since:
2008/06/24 (Oyranos: 0.1.8)
Date:
2008/06/25

References oyFilter_s::category_, oyFilter_s::oy_, oyOBJECT_FILTER_S, oyObject_s::oyObject_Release(), oyFilter_s::registration_, and oyFilter_s::type_.

Referenced by oyConversion_s::oyConversion_CreateInput(), oyFilter_s::oyFilter_New(), and oyOptions_s::oyOptions_ForFilter().

OYAPI oyConnector_s *OYEXPORT oyFilter_ShowConnector ( oyFilter_s filter,
int  as_pos,
int  is_plug 
) [related, inherited]

get a connector description from a filter backend

Function: oyFilter_ShowConnector

The path to obtain a new connector. The filter can say it has more connectors to provide for a certain kind of static connector eigther described in oyCMMapi4_s::inputs or oyCMMapi4_s::outputs.

Parameters:
[in] filter the backend filter
[in] as_pos the according oyConnector_s
[in] is_plug select from 0 - plugs or 1 - sockets
Returns:
the new oyConnector_s
Version:
Oyranos: 0.1.8
Since:
2008/07/28 (Oyranos: 0.1.8)
Date:
2008/07/28

References oyFilter_s::api4_, oyConnector_s::oyConnector_Copy(), oyOBJECT_FILTER_S, oyObject_s::oyObject_New(), oyObject_s::oyObject_Release(), and oyFilter_s::type_.

Referenced by oyFilterNode_s::oyFilterNode_ConnectorMatch(), oyFilterNode_s::oyFilterNode_GetPlug(), and oyFilterNode_s::oyFilterNode_GetSocket().

OYAPI int OYEXPORT oyFilter_ShowConnectorCount ( oyFilter_s filter,
int  is_plug,
uint32_t *  last_adds 
) [related, inherited]

get the connector count from a filter backend

Function: oyFilter_ShowConnectorCount

The path to obtain a new connector. The filter can say it has more connectors to provide for a certain kind of static connector eigther described in oyCMMapi4_s::inputs or oyCMMapi4_s::outputs.

Parameters:
filter the backend filter
is_plug select from 0 - plugs or 1 - sockets
[out] last_adds maximal copies of last connector as suggested by the filter backend
Returns:
count of static connectors
Version:
Oyranos: 0.1.8
Since:
2008/07/28 (Oyranos: 0.1.8)
Date:
2008/07/28

References oyFilter_s::api4_, oyOBJECT_FILTER_S, and oyFilter_s::type_.

OYAPI int OYEXPORT oyFilterNode_ConnectorMatch ( oyFilterNode_s node_first,
int  pos_first,
oyConnector_s connector_second 
) [related, inherited]

check if a connector match to a FilterNode

Function: oyFilterNode_ConnectorMatch

Parameters:
node_first first node
pos_first position of connector from first filter
connector_second second connector
Version:
Oyranos: 0.1.8
Since:
2008/07/29 (Oyranos: 0.1.8)
Date:
2008/07/29

References oyImage_s::channel_layout, oyFilterSocket_s::data, oyFilterNode_s::filter, oyImage_s::layout_, oyConnector_s::oyConnector_Release(), oyFilter_s::oyFilter_ShowConnector(), oyFilterNode_s::oyFilterNode_GetSocket(), oyImage_s::oyImage_Copy(), oyImage_s::oyImage_Release(), oyOBJECT_CONNECTOR_S, oyOBJECT_FILTER_NODE_S, oyProfile_s::oyProfile_GetChannelsCount(), oyImage_s::profile_, oyImage_s::sub_positioning, oyConnector_s::type_, and oyFilterNode_s::type_.

Referenced by oyConversion_s::oyConversion_FilterAdd().

oyFilterNode_s * oyFilterNode_Copy ( oyFilterNode_s node,
oyObject_s  object 
) [related, inherited]

copy or reference a filter node object

Function: oyFilterNode_Copy

Parameters:
[in] node node object
object the optional object
Version:
Oyranos: 0.1.8
Since:
2008/07/07 (Oyranos: 0.1.8)
Date:
2008/07/07

References oyFilterNode_s::oy_, and oyObject_s::oyObject_Copy().

Referenced by oyConversion_s::oyConversion_OutputAdd(), oyFilterNode_s::oyFilterNode_GetPlug(), oyFilterNode_s::oyFilterNode_GetSocket(), and oyFilterNode_s::oyFilterNode_New().

oyFilterNode_s * oyFilterNode_Create ( oyFilter_s filter,
oyObject_s  object 
) [related, inherited]

initialise a new filter node object properly

Function: oyFilterNode_Create

Parameters:
filter the mandatory filter
object the optional object
Version:
Oyranos: 0.1.8
Since:
2008/07/30 (Oyranos: 0.1.8)
Date:
2008/07/30

References oyFilter_s::api4_, oyFilter_s::category_, oyFilterNode_s::filter, oyFilter_s::oy_, oyFilterNode_s::oy_, oyFilter_s::oyFilter_Copy(), oyFilterNode_s::oyFilterNode_New(), oyObject_s::oyObject_GetId(), oyFilterNode_s::plugs, oyFilterNode_s::relatives_, and oyFilterNode_s::sockets.

Referenced by oyConversion_s::oyConversion_CreateInput(), and oyConversion_s::oyConversion_FilterAdd().

OYAPI oyFilterPlug_s *OYEXPORT oyFilterNode_GetPlug ( oyFilterNode_s node,
int  pos 
) [related, inherited]

get a oyFilterPlug_s of type from a FilterNode

Function: oyFilterNode_GetPlug

Parameters:
node filter node
pos position of connector from filter
Returns:
the plug - no copy
Version:
Oyranos: 0.1.8
Since:
2008/07/30 (Oyranos: 0.1.8)
Date:
2008/07/30

References oyFilter_s::api4_, oyFilterNode_s::filter, oyFilterPlug_s::node, oyFilterNode_s::oy_, oyFilter_s::oyFilter_ShowConnector(), oyFilterNode_s::oyFilterNode_Copy(), oyFilterPlug_s::oyFilterPlug_New(), oyOBJECT_FILTER_NODE_S, oyFilterPlug_s::pattern, oyFilterNode_s::plugs, oyFilterNode_s::relatives_, oyFilterPlug_s::relatives_, and oyFilterNode_s::type_.

Referenced by oyConversion_s::oyConversion_FilterAdd(), and oyConversion_s::oyConversion_OutputAdd().

OYAPI oyFilterSocket_s *OYEXPORT oyFilterNode_GetSocket ( oyFilterNode_s node,
int  pos 
) [related, inherited]
const char * oyFilterNode_GetText ( oyFilterNode_s node,
oyNAME_e  name_type 
) [related, inherited]

serialise filter node to text

Function oyFilterNode_GetText

Serialise into:

  • oyNAME_NICK: XML ID
  • oyNAME_NAME: XML
  • oyNAME_DESCRIPTION: ??
Parameters:
[in,out] node filter node
[out] name_type the type
Returns:
the text
Version:
Oyranos: 0.1.8
Since:
2008/07/17 (Oyranos: 0.1.8)
Date:
2008/07/18

References oyFilterNode_s::filter, oyFilter_s::options_, oyFilterNode_s::oy_, oyFilter_s::oyFilter_GetText(), oyNAME_NAME, oyNAME_NICK, oyObject_s::oyObject_GetName(), and oyObject_s::oyObject_SetName().

Referenced by oyFilterNode_s::oyFilterNode_TextToInfo().

oyFilterNode_s * oyFilterNode_New ( oyObject_s  object  )  [related, inherited]

allocate and initialise a new filter node object

Function: oyFilterNode_New

Parameters:
object the optional object
Version:
Oyranos: 0.1.8
Since:
2008/07/07 (Oyranos: 0.1.8)
Date:
2008/07/07

References oyFilterNode_s::oyFilterNode_Copy(), oyFilterNode_s::oyFilterNode_Release(), oyOBJECT_FILTER_NODE_S, oyObject_s::oyObject_NewFrom(), oyObject_s::oyObject_SetParent(), and oyFilterNode_s::release.

Referenced by oyFilterNode_s::oyFilterNode_Create().

int oyFilterNode_Release ( oyFilterNode_s **  obj  )  [related, inherited]
oyPointer oyFilterNode_TextToInfo ( oyFilterNode_s node,
size_t *  size,
oyAlloc_f  allocateFunc 
) [related, inherited]

serialise filter node to binary

Function oyFilterNode_TextToInfo

Serialise into a Oyranos specific ICC profile containers "Info" text tag. Not useable for binary contexts.

Parameters:
[in,out] node filter node
[out] size output size
[in] allocateFunc memory allocator
Returns:
the profile container
Version:
Oyranos: 0.1.8
Since:
2008/07/17 (Oyranos: 0.1.8)
Date:
2008/07/18

References oyFilterNode_s::oyFilterNode_GetText(), and oyNAME_NAME.

OYAPI int OYEXPORT oyFilterPlug_Callback ( oyFilterPlug_s c,
oyCONNECTOR_EVENT_e  e 
) [related, inherited]

tell about a oyConversion_s event

Function oyFilterPlug_Callback

Parameters:
[in,out] c the connector
e the event type
Version:
Oyranos: 0.1.8
Since:
2008/07/28 (Oyranos: 0.1.8)
Date:
2008/07/28

References oyFilterPlug_s::oy_, and oyObject_s::oyObject_GetId().

Referenced by oyFilterSocket_s::oyFilterSocket_Release().

OYAPI int OYEXPORT oyFilterPlug_ConnectIntoSocket ( oyFilterPlug_s **  p,
oyFilterSocket_s **  s 
) [related, inherited]
OYAPI oyFilterPlug_s *OYEXPORT oyFilterPlug_Copy ( oyFilterPlug_s obj,
oyObject_s  object 
) [related, inherited]

copy or reference a FilterPlug object

Function oyFilterPlug_Copy

Parameters:
[in] obj struct object
object the optional object
Version:
Oyranos: 0.1.8
Since:
2008/07/27 (Oyranos: 0.1.8)
Date:
2008/07/27

References oyFilterPlug_s::oy_, oyObject_s::oyObject_Copy(), oyOBJECT_FILTER_PLUG_S, and oyFilterPlug_s::type_.

Referenced by oyFilterPlug_s::oyFilterPlug_New().

OYAPI oyFilterPlug_s *OYEXPORT oyFilterPlug_New ( oyObject_s  object  )  [related, inherited]

allocate a new FilterPlug object

Function oyFilterPlug_New

Version:
Oyranos: 0.1.8
Since:
2008/07/27 (Oyranos: 0.1.8)
Date:
2008/07/27

References oyFilterPlug_s::oyFilterPlug_Copy(), oyFilterPlug_s::oyFilterPlug_Release(), oyOBJECT_FILTER_PLUG_S, oyObject_s::oyObject_NewFrom(), oyObject_s::oyObject_SetParent(), and oyFilterPlug_s::release.

Referenced by oyFilterNode_s::oyFilterNode_GetPlug().

OYAPI int OYEXPORT oyFilterPlug_Release ( oyFilterPlug_s **  obj  )  [related, inherited]
OYAPI oyFilterPlugs_s *OYEXPORT oyFilterPlugs_Copy ( oyFilterPlugs_s obj,
oyObject_s  object 
) [related, inherited]

copy or reference a FilterPlugs list

Function oyFilterPlugs_Copy

Parameters:
[in] obj struct object
object the optional object
Version:
Oyranos: 0.1.8
Since:
2008/07/29 (Oyranos: 0.1.8)
Date:
2008/07/29

References oyFilterPlugs_s::oy_, and oyObject_s::oyObject_Copy().

Referenced by oyFilterPlugs_s::oyFilterPlugs_New().

OYAPI int OYEXPORT oyFilterPlugs_Count ( oyFilterPlugs_s list  )  [related, inherited]

count the elements in a FilterPlugs list

Function oyFilterPlugs_Count

Parameters:
[in,out] list the list
Returns:
element count
Version:
Oyranos: 0.1.8
Since:
2008/07/29 (Oyranos: 0.1.8)
Date:
2008/07/29

References oyFilterPlugs_s::list_, and oyStructList_Count().

Referenced by oyFilterSocket_s::oyFilterSocket_Release().

OYAPI oyFilterPlug_s *OYEXPORT oyFilterPlugs_Get ( oyFilterPlugs_s list,
int  pos 
) [related, inherited]

get a element of a FilterPlugs list

Function oyFilterPlugs_Get

Parameters:
[in,out] list the list
pos position
Version:
Oyranos: 0.1.8
Since:
2008/07/29 (Oyranos: 0.1.8)
Date:
2008/07/29

References oyFilterPlugs_s::list_, oyOBJECT_FILTER_PLUG_S, oyOBJECT_FILTER_PLUGS_S, oyStructList_GetRefType(), and oyFilterPlugs_s::type_.

Referenced by oyFilterSocket_s::oyFilterSocket_Release().

OYAPI oyFilterPlugs_s *OYEXPORT oyFilterPlugs_MoveIn ( oyFilterPlugs_s list,
oyFilterPlug_s **  obj,
int  pos 
) [related, inherited]

add a element to a FilterPlugs list

Function oyFilterPlugs_MoveIn

Parameters:
[in] list list
[in,out] obj list element
pos position
Version:
Oyranos: 0.1.8
Since:
2008/07/29 (Oyranos: 0.1.8)
Date:
2008/07/29

References oyFilterPlugs_s::list_, oyFilterPlugs_s::oyFilterPlugs_New(), oyOBJECT_FILTER_PLUG_S, oyOBJECT_FILTER_PLUGS_S, oyFilterPlug_s::type_, and oyFilterPlugs_s::type_.

Referenced by oyFilterPlug_s::oyFilterPlug_ConnectIntoSocket().

OYAPI oyFilterPlugs_s *OYEXPORT oyFilterPlugs_New ( oyObject_s  object  )  [related, inherited]

allocate a new FilterPlugs list

Function oyFilterPlugs_New

Version:
Oyranos: 0.1.8
Since:
2008/07/29 (Oyranos: 0.1.8)
Date:
2008/07/29

References oyFilterPlugs_s::oyFilterPlugs_Copy(), oyFilterPlugs_s::oyFilterPlugs_Release(), oyOBJECT_FILTER_PLUGS_S, oyObject_s::oyObject_NewFrom(), oyObject_s::oyObject_SetParent(), and oyFilterPlugs_s::release.

Referenced by oyFilterPlugs_s::oyFilterPlugs_MoveIn().

OYAPI int OYEXPORT oyFilterPlugs_Release ( oyFilterPlugs_s **  obj  )  [related, inherited]

release and possibly deallocate a FilterPlugs list

Function oyFilterPlugs_Release

Parameters:
[in,out] obj struct object
Version:
Oyranos: 0.1.8
Since:
2008/07/29 (Oyranos: 0.1.8)
Date:
2008/07/29

References oyFilterPlugs_s::list_, oyFilterPlugs_s::oy_, oyOBJECT_FILTER_PLUGS_S, oyObject_s::oyObject_Release(), and oyFilterPlugs_s::type_.

Referenced by oyFilterPlugs_s::oyFilterPlugs_New().

OYAPI int OYEXPORT oyFilterPlugs_ReleaseAt ( oyFilterPlugs_s list,
int  pos 
) [related, inherited]

release a element from a FilterPlugs list

Function oyFilterPlugs_ReleaseAt

Parameters:
[in,out] list the list
pos position
Version:
Oyranos: 0.1.8
Since:
2008/07/29 (Oyranos: 0.1.8)
Date:
2008/07/29

References oyFilterPlugs_s::list_, oyOBJECT_FILTER_PLUGS_S, and oyFilterPlugs_s::type_.

int oyFilterRegistrationMatch ( const char *  registration,
const char *  pattern 
)

analyse registration string and compare with a given pattern

Function oyFilterRegistrationMatch

Parameters:
registration registration string to analise
[in] pattern pattern to compare with
Version:
Oyranos: 0.1.8
Since:
2008/06/26 (Oyranos: 0.1.8)
Date:
2008/06/26
char* oyFilterRegistrationToText ( const char *  registration,
oyFILTER_REG_e  type,
oyAlloc_f  allocateFunc 
)

analyse registration string

Function oyFilterRegistrationToText

Parameters:
registration registration string to analyse
[in] type kind of answere in return
[in] allocateFunc use this or Oyranos standard allocator
Version:
Oyranos: 0.1.9
Since:
2008/06/26 (Oyranos: 0.1.8)
Date:
2008/11/17

References oyFILTER_REG_APPLICATION, oyFILTER_REG_DOMAIN, oyFILTER_REG_OPTION, oyFILTER_REG_TOP, and oyFILTER_REG_TYPE.

Referenced by oyOptions_s::oyOptions_Add(), oyOptions_s::oyOptions_DoFilter(), oyOptions_s::oyOptions_Find(), oyOptions_s::oyOptions_FindString(), oyOptions_s::oyOptions_ForFilter_(), and oyOptions_s::oyOptions_FromBoolean().

oyFILTER_TYPE_e oyFilterRegistrationToType ( const char *  registration  ) 

analyse registration string

Function oyFilterRegistrationToType

Parameters:
registration registration string to analyse
Returns:
filter type
Version:
Oyranos: 0.1.9
Since:
2008/11/17 (Oyranos: 0.1.9)
Date:
2008/11/17

References oyFILTER_REG_TYPE, oyFILTER_TYPE_COLOUR, oyFILTER_TYPE_GENERIC, oyFILTER_TYPE_IMAGE, oyFILTER_TYPE_NONE, and oyFILTER_TYPE_TONEMAP.

Referenced by oyOptions_s::oyOptions_ForFilter().

OYAPI oyFilters_s *OYEXPORT oyFilters_Copy ( oyFilters_s obj,
oyObject_s  object 
) [related, inherited]

copy or reference a Filters list

Function: oyFilters_Copy

Parameters:
[in] obj struct object
object the optional object
Version:
Oyranos: 0.1.8
Since:
2008/07/08 (Oyranos: 0.1.8)
Date:
2008/07/08

References oyFilters_s::oy_, and oyObject_s::oyObject_Copy().

Referenced by oyFilters_s::oyFilters_New().

OYAPI int OYEXPORT oyFilters_Count ( oyFilters_s list  )  [related, inherited]

count the elements in a Filters list

Function: oyFilters_Count

Parameters:
[in,out] list the list
Returns:
element count
Version:
Oyranos: 0.1.8
Since:
2008/07/08 (Oyranos: 0.1.8)
Date:
2008/07/08

References oyFilters_s::list_, and oyStructList_Count().

OYAPI oyFilter_s *OYEXPORT oyFilters_Get ( oyFilters_s list,
int  pos 
) [related, inherited]

get a element of a Filters list

Function: oyFilters_Get

Parameters:
[in,out] list the list
pos position
Version:
Oyranos: 0.1.8
Since:
2008/07/08 (Oyranos: 0.1.8)
Date:
2008/07/08

References oyFilters_s::list_, oyOBJECT_FILTER_S, oyOBJECT_FILTERS_S, oyStructList_GetRefType(), and oyFilters_s::type_.

OYAPI oyFilters_s *OYEXPORT oyFilters_MoveIn ( oyFilters_s list,
oyFilter_s **  obj,
int  pos 
) [related, inherited]

add a element to a Filters list

Function: oyFilters_MoveIn

Parameters:
[in] list list
[in,out] obj list element
pos position
Version:
Oyranos: 0.1.8
Since:
2008/07/08 (Oyranos: 0.1.8)
Date:
2008/07/08

References oyFilters_s::list_, oyFilters_s::oyFilters_New(), oyOBJECT_FILTER_S, oyOBJECT_FILTERS_S, oyFilter_s::type_, and oyFilters_s::type_.

OYAPI oyFilters_s *OYEXPORT oyFilters_New ( oyObject_s  object  )  [related, inherited]

allocate a new Filters list

Function: oyFilters_New

Version:
Oyranos: 0.1.8
Since:
2008/07/08 (Oyranos: 0.1.8)
Date:
2008/07/08

References oyFilters_s::oyFilters_Copy(), oyFilters_s::oyFilters_Release(), oyOBJECT_FILTERS_S, oyObject_s::oyObject_NewFrom(), oyObject_s::oyObject_SetParent(), and oyFilters_s::release.

Referenced by oyFilters_s::oyFilters_MoveIn().

OYAPI int OYEXPORT oyFilters_Release ( oyFilters_s **  obj  )  [related, inherited]

release and possibly deallocate a Filters list

Function: oyFilters_Release

Parameters:
[in,out] obj struct object
Version:
Oyranos: 0.1.8
Since:
2008/07/08 (Oyranos: 0.1.8)
Date:
2008/07/08

References oyFilters_s::list_, oyFilters_s::oy_, oyOBJECT_FILTERS_S, oyObject_s::oyObject_Release(), and oyFilters_s::type_.

Referenced by oyFilters_s::oyFilters_New().

OYAPI int OYEXPORT oyFilters_ReleaseAt ( oyFilters_s list,
int  pos 
) [related, inherited]

release a element from a Filters list

Function: oyFilters_ReleaseAt

Parameters:
[in,out] list the list
pos position
Version:
Oyranos: 0.1.8
Since:
2008/07/08 (Oyranos: 0.1.8)
Date:
2008/07/08

References oyFilters_s::list_, oyOBJECT_FILTERS_S, and oyFilters_s::type_.

OYAPI int OYEXPORT oyFilterSocket_Callback ( oyFilterSocket_s c,
oyCONNECTOR_EVENT_e  e 
) [related, inherited]

tell about a oyConversion_s event

Function oyFilterSocket_Callback

Parameters:
[in,out] c the connector
e the event type
Version:
Oyranos: 0.1.8
Since:
2008/07/28 (Oyranos: 0.1.8)
Date:
2008/07/28

References oyFilterSocket_s::oy_, and oyObject_s::oyObject_GetId().

Referenced by oyFilterPlug_s::oyFilterPlug_ConnectIntoSocket(), and oyFilterPlug_s::oyFilterPlug_Release().

OYAPI oyFilterSocket_s *OYEXPORT oyFilterSocket_Copy ( oyFilterSocket_s obj,
oyObject_s  object 
) [related, inherited]

copy or reference a FilterSocket object

Function oyFilterSocket_Copy

Parameters:
[in] obj struct object
object the optional object
Version:
Oyranos: 0.1.8
Since:
2008/07/27 (Oyranos: 0.1.8)
Date:
2008/07/27

References oyFilterSocket_s::oy_, oyObject_s::oyObject_Copy(), oyOBJECT_FILTER_SOCKET_S, and oyFilterSocket_s::type_.

Referenced by oyFilterSocket_s::oyFilterSocket_New().

OYAPI oyFilterSocket_s *OYEXPORT oyFilterSocket_New ( oyObject_s  object  )  [related, inherited]

allocate a new FilterSocket object

Function oyFilterSocket_New

Version:
Oyranos: 0.1.8
Since:
2008/07/27 (Oyranos: 0.1.8)
Date:
2008/07/27

References oyFilterSocket_s::oyFilterSocket_Copy(), oyFilterSocket_s::oyFilterSocket_Release(), oyOBJECT_FILTER_SOCKET_S, oyObject_s::oyObject_NewFrom(), oyObject_s::oyObject_SetParent(), and oyFilterSocket_s::release.

Referenced by oyFilterNode_s::oyFilterNode_GetSocket().

OYAPI int OYEXPORT oyFilterSocket_Release ( oyFilterSocket_s **  obj  )  [related, inherited]
const char* oyFilterTypeToText ( oyFILTER_TYPE_e  filter_type,
oyNAME_e  type 
)

oyFILTER_TYPE_e to small text

Function oyFilterTypeToText

Version:
Oyranos: 0.1.8
Since:
2008/06/24 (Oyranos: 0.1.8)
Date:
2008/06/24

References oyFILTER_TYPE_COLOUR, oyFILTER_TYPE_GENERIC, oyFILTER_TYPE_IMAGE, oyFILTER_TYPE_TONEMAP, oyNAME_NAME, and oyNAME_NICK.

int oyPixelAccess_CalculateNextStartPixel ( oyPixelAccess_s obj,
oyFilterPlug_s requestor_plug 
) [related, inherited]

predict the next start position

Function: oyPixelAccess_CalculateNextStartPixel

Parameters:
[in,out] obj oyPixelAccess_s object
[in,out] requestor_plug plug
Version:
Oyranos: 0.1.8
Since:
2008/10/21 (Oyranos: 0.1.8)
Date:
2008/10/21

References oyPixelAccess_s::array_n, oyPixelAccess_s::array_xy, oyFilterSocket_s::data, oyImage_s::height, oyPixelAccess_s::pixels_n, oyFilterPlug_s::remote_socket_, oyPixelAccess_s::start_xy, and oyImage_s::width.

oyPixelAccess_s * oyPixelAccess_Copy ( oyPixelAccess_s obj,
oyObject_s  object 
) [related, inherited]

copy or reference a oyPixelAccess_s object

Function: oyPixelAccess_Copy

Parameters:
[in] obj oyPixelAccess_s object
object the optional object
Version:
Oyranos: 0.1.8
Since:
2008/07/07 (Oyranos: 0.1.8)
Date:
2008/07/07

References oyPixelAccess_s::oy_, and oyObject_s::oyObject_Copy().

oyPixelAccess_s * oyPixelAccess_Create ( int32_t  start_x,
int32_t  start_y,
oyFilterSocket_s sock,
oyPIXEL_ACCESS_TYPE_e  type,
oyObject_s  object 
) [related, inherited]

allocate iand initialise a basic oyPixelAccess_s object

Function: oyPixelAccess_Create

Version:
Oyranos: 0.1.8
Date:
2008/07/07
Since:
2008/07/07 (Oyranos: 0.1.8)

Todo:
how can we know about the various backend capabilities
  • back report the processed number of pixels in the passed pointer
  • restrict for a line interface only, would fit to oyArray2D_s
  • + handle inside an to be created function oyConversion_Run()

References oyPixelAccess_s::array_n, oyPixelAccess_s::array_xy, oyFilterSocket_s::data, oyPixelAccess_s::oy_, oyPIXEL_ACCESS_LINE, oyPIXEL_ACCESS_POINT, oyPixelAccess_s::oyPixelAccess_Release(), oyPixelAccess_s::pixels_n, oyPixelAccess_s::start_xy, oyPixelAccess_s::start_xy_old, and oyImage_s::width.

Referenced by oyConversion_s::oyConversion_GetOnePixel().

int oyPixelAccess_Release ( oyPixelAccess_s **  obj  )  [related, inherited]

release and zero a oyPixelAccess_s object

Function: oyPixelAccess_Release

Parameters:
[in,out] obj oyPixelAccess_s object
Version:
Oyranos: 0.1.8
Since:
2008/07/07 (Oyranos: 0.1.8)
Date:
2008/07/07

References oyPixelAccess_s::array_xy, oyPixelAccess_s::oy_, oyOBJECT_PIXEL_ACCESS_S, oyObject_s::oyObject_Release(), and oyPixelAccess_s::type.

Referenced by oyPixelAccess_s::oyPixelAccess_Create().


Generated on 19 Feb 2010 for Oyranos by  doxygen 1.6.1