Oyranos
git-devel
Oyranos is a full featured Color Management System
|
Image Manipulation by a Graph (DAG) More...
#include <oyConversion_s.h>
Public Member Functions | |
OYAPI oyConversion_s *OYEXPORT | oyConversion_New (oyObject_s object) |
allocate a new Conversion object More... | |
OYAPI oyConversion_s *OYEXPORT | oyConversion_Copy (oyConversion_s *conversion, oyObject_s object) |
Copy or Reference a Conversion object. More... | |
OYAPI int OYEXPORT | oyConversion_Release (oyConversion_s **conversion) |
release and possibly deallocate a oyConversion_s object More... | |
int | oyConversion_Correct (oyConversion_s *conversion, const char *registration, uint32_t flags, oyOptions_s *options) |
Check for correctly adhering to policies. More... | |
oyConversion_s * | oyConversion_CreateBasicPixels (oyImage_s *input, oyImage_s *output, oyOptions_s *options, oyObject_s object) |
Allocate and initialise a basic oyConversion_s object. More... | |
oyConversion_s * | oyConversion_CreateBasicPixelsFromBuffers (oyProfile_s *p_in, oyPointer buf_in, oyPixel_t buf_type_in, oyProfile_s *p_out, oyPointer buf_out, oyPixel_t buf_type_out, oyOptions_s *options, int count) |
One dimensional color conversion context. More... | |
oyConversion_s * | oyConversion_CreateFromImage (oyImage_s *image_in, oyOptions_s *module_options, oyProfile_s *output_profile, oyDATATYPE_e buf_type_out, uint32_t flags, oyObject_s obj) |
generate a Oyranos graph from a image file name More... | |
oyFilterGraph_s * | oyConversion_GetGraph (oyConversion_s *conversion) |
Get the filter graph from a conversion context. More... | |
oyImage_s * | oyConversion_GetImage (oyConversion_s *conversion, uint32_t flags) |
Get a image copy at the desired position. More... | |
oyFilterNode_s * | oyConversion_GetNode (oyConversion_s *conversion, uint32_t flags) |
Get the filter node copy. More... | |
int | oyConversion_GetOnePixel (oyConversion_s *conversion, double x, double y, oyPixelAccess_s *pixel_access) |
Compute one pixel at the given position. More... | |
int | oyConversion_RunPixels (oyConversion_s *conversion, oyPixelAccess_s *pixel_access) |
Process a pixel conversion graph. More... | |
int | oyConversion_Set (oyConversion_s *conversion, oyFilterNode_s *input, oyFilterNode_s *output) |
Set input and output of a conversion graph. More... | |
char * | oyConversion_ToText (oyConversion_s *conversion, const char *head_line, int reserved, oyAlloc_f allocateFunc) |
Text description of a conversion graph. More... | |
void | oyConversion_Release__Members (oyConversion_s_ *conversion) |
Custom Conversion destructor. More... | |
int | oyConversion_Init__Members (oyConversion_s_ *conversion OY_UNUSED) |
Custom Conversion constructor. More... | |
int | oyConversion_Copy__Members (oyConversion_s_ *dst, oyConversion_s_ *src) |
Custom Conversion 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 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... | |
Image Manipulation by a Graph (DAG)
The main and most simple entry points are oyConversion_CreateBasicPixels(), oyConversion_Correct() and oyConversion_RunPixels(). More details can be read in Graph Live Cycle.
Order of filters matters. The processing direction is a bit like raytracing as nodes request their parent.
The graph is allowed to be a directed graph without cycles.
oyConversion_s shall provide access to the graph and help in processing and managing nodes.
Creating Graphs:
Most simple is to use the oyConversion_CreateBasicPixels() function to create a profile to profile and possible image buffer to image buffer linear graph.
The other possibility is to create a non linear graph. The input member can be accessed for this directly.
While it would be possible to have several open ends in a graph, there are two endpoints considered as special. The input member prepresents the top most required node to be provided in a oyConversion_s graph. The input node is accessible for user manipulation. The other one is the out_ member. It is the closing node in the graph. It will be set by Oyranos during closing the graph.
Configuring Graphs:
Image graphs for displayable result should in most cases be synced with user and system settings. Image graphs are typically used in three categories:
Using Graphs:
To obtain the data the oyConversion_RunPixels() and oyConversion_GetOnePixel() functions are available.
Releasing Graphs:
Giving memory back is simple as oyConversion_Release()
OYAPI oyConversion_s *OYEXPORT oyConversion_Copy | ( | oyConversion_s * | conversion, |
oyObject_s | object | ||
) |
Copy or Reference a Conversion object.
Function oyConversion_Copy
The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.
[in] | conversion | Conversion struct object |
object | NULL - means reference, the optional object triggers a real copy |
int oyConversion_Copy__Members | ( | oyConversion_s_ * | dst, |
oyConversion_s_ * | src | ||
) |
Custom Conversion copy constructor.
Function oyConversion_Copy__Members
int oyConversion_Correct | ( | oyConversion_s * | conversion, |
const char * | registration, | ||
uint32_t | flags, | ||
oyOptions_s * | options | ||
) |
Check for correctly adhering to policies.
Function oyConversion_Correct
Without any options the module selected with the Registration policy filter shall perform graph analysis and correct the graph.
TODO: display and selection of policy modules
conversion | the to be checked configuration | |
registration | the to be used policy module | |
[in] | flags | select particular options:
|
options | options to the policy module |
oyConversion_s * oyConversion_CreateBasicPixels | ( | oyImage_s * | input, |
oyImage_s * | output, | ||
oyOptions_s * | options, | ||
oyObject_s | object | ||
) |
Allocate and initialise a basic oyConversion_s object.
Function oyConversion_CreateBasicPixels
Provided options will be passed to oyFilterNode_NewWith(). There for no options defaults will be selected.
[in] | input | the input image data |
[in] | output | the output image data |
[in] | options | options to be passed to oyFilterCore_s Each option should be carefully named to be correctly selected by the intented filter (root, icc and output). The available options are particial defined by plugable policy modules, e.g. "oicc", and a filters own options. OY_DEFAULT_CMM_CONTEXT and OY_DEFAULT_CMM_RENDERER can contain a string to explicitely select the icc module. |
object | the optional object |
oyConversion_s * oyConversion_CreateBasicPixelsFromBuffers | ( | oyProfile_s * | p_in, |
oyPointer | buf_in, | ||
oyPixel_t | buf_type_in, | ||
oyProfile_s * | p_out, | ||
oyPointer | buf_out, | ||
oyPixel_t | buf_type_out, | ||
oyOptions_s * | options, | ||
int | count | ||
) |
One dimensional color conversion context.
Function oyConversion_CreateBasicPixelsFromBuffers
The options are passed to oyConversion_CreateBasicPixels(); The function does the lookups for the profiles and the modules contexts in the Oyranos cache on the fly.
[in] | p_in | the input profile |
[in] | buf_in | the input channels |
[in] | buf_type_in | the input pixel type; channel count can be omitted |
[in] | p_out | the output profile |
[in] | buf_out | the output channels |
[in] | buf_type_out | the output pixel type; channel count can be omitted |
[in] | options | see the same option in oyConversion_CreateBasicPixels() |
[in] | count | the pixel count to convert in buf_in and buf_out |
oyConversion_s * oyConversion_CreateFromImage | ( | oyImage_s * | image_in, |
oyOptions_s * | module_options, | ||
oyProfile_s * | output_profile, | ||
oyDATATYPE_e | buf_type_out, | ||
uint32_t | flags, | ||
oyObject_s | obj | ||
) |
generate a Oyranos graph from a image file name
Function oyConversion_CreateFromImage
[in] | image_in | input |
[in] | module_options | options for icc node |
[in] | output_profile | profile to convert colors to; |
[in] | buf_type_out | the desired data type for output |
[in] | flags | select particular options:
|
[in] | obj | Oyranos object (optional) |
oyFilterGraph_s * oyConversion_GetGraph | ( | oyConversion_s * | conversion | ) |
Get the filter graph from a conversion context.
Function oyConversion_GetGraph
[in,out] | conversion | conversion object |
References oyFilterGraph_s::oyFilterGraph_FromNode().
oyImage_s * oyConversion_GetImage | ( | oyConversion_s * | conversion, |
uint32_t | flags | ||
) |
Get a image copy at the desired position.
Function oyConversion_GetImage
[in,out] | conversion | conversion object |
[in] | flags | OY_INPUT or OY_OUTPUT |
oyFilterNode_s * oyConversion_GetNode | ( | oyConversion_s * | conversion, |
uint32_t | flags | ||
) |
Get the filter node copy.
Function oyConversion_GetNode
[in,out] | conversion | conversion object |
[in] | flags | OY_INPUT or OY_OUTPUT |
int oyConversion_GetOnePixel | ( | oyConversion_s * | conversion, |
double | x, | ||
double | y, | ||
oyPixelAccess_s * | pixel_access | ||
) |
Compute one pixel at the given position.
Function oyConversion_GetOnePixel
[in,out] | conversion | conversion object |
[in] | x | position x |
[in] | y | position y |
[in,out] | pixel_access | pixel iterator configuration |
int oyConversion_Init__Members | ( | oyConversion_s_ *conversion | OY_UNUSED | ) |
Custom Conversion constructor.
Function oyConversion_Init__Members
OYAPI oyConversion_s *OYEXPORT oyConversion_New | ( | oyObject_s | object | ) |
allocate a new Conversion object
Function oyConversion_New
OYAPI int OYEXPORT oyConversion_Release | ( | oyConversion_s ** | conversion | ) |
release and possibly deallocate a oyConversion_s object
Function oyConversion_Release
[in,out] | conversion | Conversion struct object |
void oyConversion_Release__Members | ( | oyConversion_s_ * | conversion | ) |
Custom Conversion destructor.
Function oyConversion_Release__Members
int oyConversion_RunPixels | ( | oyConversion_s * | conversion, |
oyPixelAccess_s * | pixel_access | ||
) |
Process a pixel conversion graph.
Function oyConversion_RunPixels
[in,out] | conversion | conversion object |
[in,out] | pixel_access | optional custom pixel iterator configuration; The ticket can be passed in for specifying only regions of the source data. |
Here a very basic code snippet:
Here a example from test2.cpp for creating a job ticket from the DAG:
oyFilterGraph_PrepareContexts() uses the internal oyFilterNode_SetContext_() for automatic resources resolving during DAG processing. Both oyCMMapi4_s and oyCMMapi7_s contexts are checked for if declared by oyCMMapi4_Create() context_type argument.
The function creates a very simple pixel iterator if no job ticket is passed in as pixel_access.
Write the pixel data possibly to the output image.
The oyPixelAccess_s job ticket contains a oyArray2d_s object called array holding the in memory data. After the job is done the output images pixel_data pointer is compared with the job tickets array pointer. If they are the same it is assumed that a observer of the output image will see the same processed data, otherwise oyPixelAccess_s::array must be copied to the output image. Here a example from test2.cpp for a optimisation by setting the same array in the DAG output image and the ticket:
While the design of having whatever data storage in a oyImage_s is very flexible, the oyPixelAccess_s::array's in memory buffer is not. Users with very large data sets have to process the data in chunks and the oyPixelAccess_s::array allocation can remain constant.
int oyConversion_Set | ( | oyConversion_s * | conversion, |
oyFilterNode_s * | input, | ||
oyFilterNode_s * | output | ||
) |
Set input and output of a conversion graph.
Function oyConversion_Set
[in,out] | conversion | conversion object |
[in] | input | input node |
[in] | output | output node |
char * oyConversion_ToText | ( | oyConversion_s * | conversion, |
const char * | head_line, | ||
int | reserved, | ||
oyAlloc_f | allocateFunc | ||
) |
Text description of a conversion graph.
Function oyConversion_ToText
[in] | conversion | conversion object |
[in] | head_line | text for inclusion |
[in] | reserved | future format selector (dot, xml ...) |
[in] | allocateFunc | allocation function |
oyStruct_Copy_f oyConversion_s::copy |
Copy function.
oyObject_s oyConversion_s::oy_ |
Oyranos internal object.
Features name and hash. Do not change during object life time.
oyStruct_Release_f oyConversion_s::release |
Release function.
const oyOBJECT_e oyConversion_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.