![]() |
Oyranos Color Management System API - Version 0.9.6 |
Provide logical and UI support for Color Matching Module selection. More...
![]() |
Macros | |
#define | oyNAME_MODULE (oyNAME_DESCRIPTION + 2) |
the system specific module name; e.g. a library name | |
#define | oyNAME_REGISTRATION (oyNAME_DESCRIPTION + 3) |
the logical name for selection | |
#define | oyNAME_PATTERN (oyNAME_DESCRIPTION + 4) |
a logical name for registration search | |
#define | oyNAME_JSON (oyNAME_DESCRIPTION + 5) |
a logical name for registration search | |
#define | oySOURCE_FILTER 0x02 |
use inbuild values | |
#define | oySOURCE_DATA 0x04 |
use persistenly stored DB values |
Enumerations | |
enum | oyCMM_e { , oyCMM_CONTEXT, oyCMM_RENDERER, oyCMM_CONTEXT_FALLBACK, oyCMM_RENDERER_FALLBACK, oyCMM_END } |
CMM Types. More... |
Functions | |
uint32_t | oyICCProfileSelectionFlagsFromOptions (const char *db_base_key, const char *base_pattern, oyOptions_s *options, int select_core) |
Get valid profile selection flags from node options and fallbacks. | |
char ** | oyGetCMMs (oyCMM_e type, int name_type, uint32_t flags, oyAlloc_f allocate_func) |
Get a CMM list as strings. | |
char * | oyCMMRegistrationToName (const char *registration, oyCMM_e type, int name_type, uint32_t flags, oyAlloc_f allocate_func) |
Get a CMM string. | |
char * | oyCMMNameToRegistration (const char *name, oyCMM_e type, int name_type, uint32_t flags, oyAlloc_f allocate_func) |
Get a CMM registration from UI string. | |
char * | oyGetCMMPattern (oyCMM_e type, uint32_t flags, oyAlloc_f allocate_func) |
Get a default CMM. | |
int | oySetCMMPattern (oyCMM_e type, uint32_t flags, oySCOPE_e scope, const char *pattern) |
set a CMM as default | |
uint32_t | oyICCProfileSelectionFlagsFromRegistration (const char *registration) |
Get flags for oyProfile_FromFile() and friends. |
Provide logical and UI support for Color Matching Module selection.
CMMs are modules, which do color calculations. The core part is responsible to do profile concatenation into one single color transform according to the provided options. It is loaded as a oyCMMapi4_s module. A policy module, implemented as a oyCMMapi9_s module, ensures the options follow the user and system settings. The renderer CMM (oyCMMapi7_s) module does the actual color transform, which is expressed as a device link for data exchange. So different core and renderer modules can easily be combined.
#define oyNAME_JSON (oyNAME_DESCRIPTION + 5) |
a logical name for registration search
Referenced by oyOptions_s::oyOptions_GetText().
#define oyNAME_MODULE (oyNAME_DESCRIPTION + 2) |
the system specific module name; e.g. a library name
#define oyNAME_PATTERN (oyNAME_DESCRIPTION + 4) |
a logical name for registration search
Referenced by oyConfig_s::oyConfig_Find(), oyConfig_s::oyConfig_Has(), oyDeviceSelectSimiliar(), oyFilterGraph_s::oyFilterGraph_PrepareContexts(), oyFilterNode_s::oyFilterNode_FromOptions(), oyOptions_s::oyOptions_Add(), oyOptions_s::oyOptions_DoFilter(), oyOptions_s::oyOptions_Find(), oyOptions_s::oyOptions_FindData(), oyOptions_s::oyOptions_FindDouble(), oyOptions_s::oyOptions_FindInt(), oyOptions_s::oyOptions_FindString(), oyOptions_s::oyOptions_ForFilter_(), oyOptions_s::oyOptions_MoveInStruct(), oyOptions_s::oyOptions_SetFromData(), oyOptions_s::oyOptions_SetFromDouble(), oyOptions_s::oyOptions_SetFromInt(), and oyOptions_s::oyOptions_SetFromText().
#define oyNAME_REGISTRATION (oyNAME_DESCRIPTION + 3) |
the logical name for selection
Referenced by oyOptions_s::oyOptions_Find(), oyObserver_s::oyStruct_DisableSignalSend(), oyObserver_s::oyStruct_EnableSignalSend(), and oyObserver_s::oyStruct_ObserverSignal().
#define oySOURCE_DATA 0x04 |
use persistenly stored DB values
Referenced by oyDeviceSetup(), oyDeviceUnset(), and oyGetFilterNodeRegFromDB().
#define oySOURCE_FILTER 0x02 |
use inbuild values
enum oyCMM_e |
CMM Types.
char* oyCMMNameToRegistration | ( | const char * | name, |
oyCMM_e | type, | ||
int | name_type, | ||
uint32_t | flags, | ||
oyAlloc_f | allocate_func | ||
) |
Get a CMM registration from UI string.
Function oyCMMNameToRegistration Useful for matching UI strings to registration in e.g. oySetCMMRegistration().
name | a UI string |
type | the CMM type to set |
name_type | oyNAME_e or oyNAME_REGISTRATION or oyNAME_MODULE or oyNAME_PATTERN |
flags | unused |
allocate_func | user allocator |
char* oyCMMRegistrationToName | ( | const char * | registration, |
oyCMM_e | type, | ||
int | name_type, | ||
uint32_t | flags, | ||
oyAlloc_f | allocate_func | ||
) |
Get a CMM string.
Function oyCMMRegistrationToName Useful for displaying UI strings.
registration | a registration string to match a existing CMM |
type | the CMM type to set |
name_type | oyNAME_e or oyNAME_PATTERN or oyNAME_REGISTRATION or oyNAME_MODULE |
flags | unused |
allocate_func | user allocator |
Get a default CMM.
Function oyGetCMMPattern The stored value will contain a registration pattern string.
type | the CMM type to set |
flags | oySOURCE_DATA for persistent DB only settings, oySOURCE_FILTER for Oyranos inbuild default |
allocate_func | user allocator |
Get a CMM list as strings.
Function oyGetCMMs Useful for displaying UI strings.
type | the CMM type to set |
name_type | oyNAME_e or oyNAME_REGISTRATION or oyNAME_MODULE |
flags | unused |
allocate_func | user allocator |
uint32_t oyICCProfileSelectionFlagsFromOptions | ( | const char * | db_base_key, |
const char * | base_pattern, | ||
oyOptions_s * | options, | ||
int | select_core | ||
) |
Get valid profile selection flags from node options and fallbacks.
Function oyICCProfileSelectionFlagsFromOptions A convenience function for oyFilterNode_FromOptions() .
db_base_key | the Oyranos DB basic key, which will appended by "context" and "renderer"; optional |
base_pattern | the basic pattern to search in the options and to be used as fallback |
options | the options to search in for the base_pattern and get "context" and "renderer" keys; optional |
select_core | 0 - select node, 1 - select core |
References oyFilterNode_s::oyFilterNode_FromOptions(), oyFilterNode_s::oyFilterNode_GetRegistration(), oyFilterNode_s::oyFilterNode_Release(), and oyICCProfileSelectionFlagsFromRegistration().
uint32_t oyICCProfileSelectionFlagsFromRegistration | ( | const char * | registration | ) |
Get flags for oyProfile_FromFile() and friends.
supported are "icc_version_2" - OY_ICC_VERSION_2 and "icc_version_4" - OY_ICC_VERSION_4 .
registration | plain module registration; oyNAME_REGISTRATION |
Referenced by oyICCProfileSelectionFlagsFromOptions().
set a CMM as default
Function oySetCMMPattern The stored value will contain a registration pattern string, which shall fit a installed module registration string. However the caller has to check the existence of the CMM itself.
type | the CMM type to set |
flags | unused |
scope | oySCOPE_USER and oySCOPE_SYS are possible |
pattern | a registration pattern to match a installed CMM registration |