Oyranos Color Management System API - Version 0.9.6
Macros
oyranos_definitions.h File Reference

The macro header to include in your application without using any Oyranos function. More...

Macros

#define OY_PROFILE_PATH_USER_DEFAULT   "~/.color/icc"
 
#define OY_USER_PATH   "~/.local"
 from OpenICC directory proposal needs additional 'color' and the usage 'icc/cmms/...' More...
 
#define OY_PROFILE_PATH_SYSTEM_DEFAULT   "/usr/share/color/icc"
 
#define OY_SYS_PATH1   "/usr"
 
#define OY_DEBUG   "OY_DEBUG"
 Oyranos debug environment variable. More...
 
#define OY_DEBUG_MEMORY   "OY_DEBUG_MEMORY"
 Oyranos debug environment variable. More...
 
#define OY_DEBUG_OBJECTS   "OY_DEBUG_OBJECTS"
 Oyranos debug environment variable. More...
 
#define OY_DEBUG_SIGNALS   "OY_DEBUG_SIGNALS"
 Oyranos debug environment variable. More...
 
#define OY_BACKTRACE   "OY_BACKTRACE"
 Oyranos debug environment variable. More...
 
#define OY_MODULE_PATH   "OY_MODULE_PATH"
 Oyranos modules/CMM's environment variable. More...
 
#define OY_MODULE_NAME   "_cmm_module"
 Oyranos modules/CMM's suffix after the four byte CMM ID. More...
 
#define OY_MODULE_NICK   "oyIM"
 Oyranos CMM ID. More...
 
#define OY_PROFILE_NONE   _("[none]")
 none profile More...
 
#define OY_SLASH   "/"
 
#define OY_SLASH_C   '/'
 
#define OY_TOP_SHARED   "org"
 
#define OY_TOP_INTERNAL   "org"
 
#define OY_DOMAIN_STD   "freedesktop"
 
#define OY_DOMAIN_INTERNAL   "oyranos"
 
#define OY_TYPE_STD   "openicc"
 
#define OY_STD   OY_TOP_SHARED OY_SLASH OY_DOMAIN_STD OY_SLASH OY_TYPE_STD
 
#define OY_INTERNAL   OY_TOP_INTERNAL OY_SLASH OY_DOMAIN_INTERNAL OY_SLASH OY_TYPE_STD
 
#define OY_PROFILE_STD   OY_STD OY_SLASH "profile"
 
#define OY_BEHAVIOUR_STD   OY_STD OY_SLASH "behaviour"
 
#define OY_CMM_STD   OY_STD OY_SLASH "icc_color"
 
#define OY_REGISTRED_PROFILES   OY_STD OY_SLASH "device_profiles"
 
#define OY_SYS   "system/"
 
#define OY_USER   "user/"
 
#define MAX_PATH   1024
 
#define OY_DEFAULT_EDITING_RGB_PROFILE   OY_PROFILE_STD OY_SLASH "editing_rgb"
 
#define OY_DEFAULT_EDITING_CMYK_PROFILE   OY_PROFILE_STD OY_SLASH "editing_cmyk"
 
#define OY_DEFAULT_EDITING_XYZ_PROFILE   OY_PROFILE_STD OY_SLASH "editing_xyz"
 
#define OY_DEFAULT_EDITING_LAB_PROFILE   OY_PROFILE_STD OY_SLASH "editing_lab"
 
#define OY_DEFAULT_EDITING_GRAY_PROFILE   OY_PROFILE_STD OY_SLASH "editing_gray"
 
#define OY_DEFAULT_ASSUMED_XYZ_PROFILE   OY_PROFILE_STD OY_SLASH "assumed_xyz"
 
#define OY_DEFAULT_ASSUMED_LAB_PROFILE   OY_PROFILE_STD OY_SLASH "assumed_lab"
 
#define OY_DEFAULT_ASSUMED_RGB_PROFILE   OY_PROFILE_STD OY_SLASH "assumed_rgb"
 
#define OY_DEFAULT_ASSUMED_WEB_PROFILE   OY_PROFILE_STD OY_SLASH "assumed_web" /* static_profile */
 
#define OY_DEFAULT_ASSUMED_CMYK_PROFILE   OY_PROFILE_STD OY_SLASH "assumed_cmyk"
 
#define OY_DEFAULT_ASSUMED_GRAY_PROFILE   OY_PROFILE_STD OY_SLASH "assumed_gray"
 
#define OY_DEFAULT_PROOF_PROFILE   OY_PROFILE_STD OY_SLASH "proof"
 
#define OY_DEFAULT_EFFECT_PROFILE   OY_PROFILE_STD OY_SLASH "effect"
 
#define OY_ACTION_UNTAGGED_ASSIGN   OY_BEHAVIOUR_STD OY_SLASH "action_untagged_assign"
 
#define OY_ACTION_MISMATCH_RGB   OY_BEHAVIOUR_STD OY_SLASH "action_missmatch_rgb"
 
#define OY_ACTION_MISMATCH_CMYK   OY_BEHAVIOUR_STD OY_SLASH "action_missmatch_cmyk"
 
#define OY_CONVERT_MIXED_COLOR_SPACE_PRINT_DOCUMENT   OY_BEHAVIOUR_STD OY_SLASH "mixed_color_spaces_print_doc_convert"
 
#define OY_CONVERT_MIXED_COLOR_SPACE_SCREEN_DOCUMENT   OY_BEHAVIOUR_STD OY_SLASH "mixed_color_spaces_screen_doc_convert"
 
#define OY_DEFAULT_RENDERING_INTENT   OY_BEHAVIOUR_STD OY_SLASH "rendering_intent"
 
#define OY_DEFAULT_RENDERING_BPC   OY_BEHAVIOUR_STD OY_SLASH "rendering_bpc"
 
#define OY_DEFAULT_RENDERING_INTENT_PROOF   OY_BEHAVIOUR_STD OY_SLASH "rendering_intent_proof"
 
#define OY_DEFAULT_RENDERING_GAMUT_WARNING   OY_BEHAVIOUR_STD OY_SLASH "rendering_gamut_warning"
 
#define OY_DEFAULT_PROOF_SOFT   OY_BEHAVIOUR_STD OY_SLASH "proof_soft"
 
#define OY_DEFAULT_PROOF_HARD   OY_BEHAVIOUR_STD OY_SLASH "proof_hard"
 
#define OY_DEFAULT_EFFECT   OY_BEHAVIOUR_STD OY_SLASH "effect_switch"
 
#define OY_DEFAULT_CMM_CONTEXT   OY_CMM_STD OY_SLASH "context"
 
#define OY_DEFAULT_CMM_RENDERER   OY_CMM_STD OY_SLASH "renderer"
 
#define OY_DEFAULT_CMM_CONTEXT_FALLBACK   OY_CMM_STD OY_SLASH "context_fallback"
 
#define OY_DEFAULT_CMM_RENDERER_FALLBACK   OY_CMM_STD OY_SLASH "renderer_fallback"
 
#define OY_PROFILES_SIMULATION   OY_PROFILE_STD OY_SLASH "profiles_simulation"
 
#define OY_PROFILES_EFFECT   OY_PROFILE_STD OY_SLASH "profiles_effect"
 

Detailed Description

The macro header to include in your application without using any Oyranos function.

macros and definitions

This file contains all macros which are relevant to the Oyranos API using the Elektra library as configuration engine.
For the Oyranos API see

Oyranos is an open source Color Management System

Copyright:
2004-2014 (C) Kai-Uwe Behrmann
Author
Kai-Uwe Behrmann ku.b@.nosp@m.gmx..nosp@m.de
License:
MIT http://www.opensource.org/licenses/mit-license.php
Since
2004/11/25

Macro Definition Documentation

#define MAX_PATH   1024

maximal path lenght, if not allready defined elsewhere

#define OY_ACTION_MISMATCH_CMYK   OY_BEHAVIOUR_STD OY_SLASH "action_missmatch_cmyk"

key name for the cmyk profile mismatch action

#define OY_ACTION_MISMATCH_RGB   OY_BEHAVIOUR_STD OY_SLASH "action_missmatch_rgb"

key name for the rgb profile mismatch action

#define OY_ACTION_UNTAGGED_ASSIGN   OY_BEHAVIOUR_STD OY_SLASH "action_untagged_assign"

key name for the non profile tagged content action [ dont assign | assign assumed Profile | promt ]

#define OY_BACKTRACE   "OY_BACKTRACE"

Oyranos debug environment variable.

Since
0.9.0
#define OY_BEHAVIOUR_STD   OY_STD OY_SLASH "behaviour"

Type path for standard settings

#define OY_CMM_STD   OY_STD OY_SLASH "icc_color"
#define OY_CONVERT_MIXED_COLOR_SPACE_PRINT_DOCUMENT   OY_BEHAVIOUR_STD OY_SLASH "mixed_color_spaces_print_doc_convert"

key name for the allow mixed color space switch

#define OY_CONVERT_MIXED_COLOR_SPACE_SCREEN_DOCUMENT   OY_BEHAVIOUR_STD OY_SLASH "mixed_color_spaces_screen_doc_convert"

key name for generating a mixed color space for internet warning

#define OY_DEBUG   "OY_DEBUG"

Oyranos debug environment variable.

Since
0.9.0
#define OY_DEBUG_MEMORY   "OY_DEBUG_MEMORY"

Oyranos debug environment variable.

Since
0.9.0
#define OY_DEBUG_OBJECTS   "OY_DEBUG_OBJECTS"

Oyranos debug environment variable.

Since
0.9.6

Referenced by oyObject_GetId().

#define OY_DEBUG_SIGNALS   "OY_DEBUG_SIGNALS"

Oyranos debug environment variable.

Since
0.9.0
#define OY_DEFAULT_ASSUMED_CMYK_PROFILE   OY_PROFILE_STD OY_SLASH "assumed_cmyk"

key name for the untagged data assumed source Cmyk profile

#define OY_DEFAULT_ASSUMED_GRAY_PROFILE   OY_PROFILE_STD OY_SLASH "assumed_gray"

key name for the untagged data assumed source Gray profile

#define OY_DEFAULT_ASSUMED_LAB_PROFILE   OY_PROFILE_STD OY_SLASH "assumed_lab"

key name for the untagged data assumed source Lab profile

#define OY_DEFAULT_ASSUMED_RGB_PROFILE   OY_PROFILE_STD OY_SLASH "assumed_rgb"

key name for the untagged data assumed source RGB profile

#define OY_DEFAULT_ASSUMED_WEB_PROFILE   OY_PROFILE_STD OY_SLASH "assumed_web" /* static_profile */

name for the untagged data assumed source profile for www content

#define OY_DEFAULT_ASSUMED_XYZ_PROFILE   OY_PROFILE_STD OY_SLASH "assumed_xyz"

key name for the untagged data assumed source XYZ profile

#define OY_DEFAULT_CMM_CONTEXT   OY_CMM_STD OY_SLASH "context"

key name for context CMM

Since
0.9.6
Examples:
image_display.cpp.

Referenced by oyOptions_s::oyOptions_ForFilter_().

#define OY_DEFAULT_CMM_CONTEXT_FALLBACK   OY_CMM_STD OY_SLASH "context_fallback"

key name for context CMM fallback

Since
0.9.6
#define OY_DEFAULT_CMM_RENDERER   OY_CMM_STD OY_SLASH "renderer"

key name for renderer CMM

Since
0.9.6

Referenced by oyOptions_s::oyOptions_ForFilter_().

#define OY_DEFAULT_CMM_RENDERER_FALLBACK   OY_CMM_STD OY_SLASH "renderer_fallback"

key name for renderer CMM fallback

Since
0.9.6
#define OY_DEFAULT_EDITING_CMYK_PROFILE   OY_PROFILE_STD OY_SLASH "editing_cmyk"

key name for the default Editing profile

#define OY_DEFAULT_EDITING_GRAY_PROFILE   OY_PROFILE_STD OY_SLASH "editing_gray"

key name for the default Editing profile

#define OY_DEFAULT_EDITING_LAB_PROFILE   OY_PROFILE_STD OY_SLASH "editing_lab"

key name for the default Editing profile

#define OY_DEFAULT_EDITING_RGB_PROFILE   OY_PROFILE_STD OY_SLASH "editing_rgb"

key name for the default Editing profile

#define OY_DEFAULT_EDITING_XYZ_PROFILE   OY_PROFILE_STD OY_SLASH "editing_xyz"

key name for the default Editing profile

#define OY_DEFAULT_EFFECT   OY_BEHAVIOUR_STD OY_SLASH "effect_switch"

key name for effect profile by default

Examples:
image_display.cpp.
#define OY_DEFAULT_EFFECT_PROFILE   OY_PROFILE_STD OY_SLASH "effect"

key name for a standard proofing profile

Since
0.9.6
#define OY_DEFAULT_PROOF_HARD   OY_BEHAVIOUR_STD OY_SLASH "proof_hard"

key name for hard proofing by default

#define OY_DEFAULT_PROOF_PROFILE   OY_PROFILE_STD OY_SLASH "proof"

key name for a standard proofing profile

#define OY_DEFAULT_PROOF_SOFT   OY_BEHAVIOUR_STD OY_SLASH "proof_soft"

key name for soft proofing by default

#define OY_DEFAULT_RENDERING_BPC   OY_BEHAVIOUR_STD OY_SLASH "rendering_bpc"

key name for the default rendering with BPC

#define OY_DEFAULT_RENDERING_GAMUT_WARNING   OY_BEHAVIOUR_STD OY_SLASH "rendering_gamut_warning"

key name for the default gamut warning

#define OY_DEFAULT_RENDERING_INTENT   OY_BEHAVIOUR_STD OY_SLASH "rendering_intent"

key name for the default rendering intent

#define OY_DEFAULT_RENDERING_INTENT_PROOF   OY_BEHAVIOUR_STD OY_SLASH "rendering_intent_proof"

key name for the default proofing rendering intent

#define OY_DOMAIN_INTERNAL   "oyranos"

Domain path for Oyranos specific settings

Examples:
oyranos_cmm_oJPG.c.
#define OY_DOMAIN_STD   "freedesktop"

Domain path for standard settings

Oyranos internal key path in the data base

Examples:
image_display.cpp.
#define OY_MODULE_NAME   "_cmm_module"

Oyranos modules/CMM's suffix after the four byte CMM ID.

for instance LittleCMS has ID lcms, thus we get lcms_cmm_module

Since
0.1.8
#define OY_MODULE_NICK   "oyIM"

Oyranos CMM ID.

It is the id of the internal module and the creator id of profiles

Version
Oyranos: 0.1.8
Date
2008/02/01
Since
2008/02/01 (Oyranos: 0.1.8)
#define OY_MODULE_PATH   "OY_MODULE_PATH"

Oyranos modules/CMM's environment variable.

Since
0.1.8
#define OY_PROFILE_NONE   _("[none]")

none profile

The name of a non existent profile.

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

Referenced by oyProfile_s::oyProfile_FromMD5(), oyProfile_s::oyProfile_GetFileName(), and oyProfiles_s::oyProfiles_Create().

#define OY_PROFILE_PATH_SYSTEM_DEFAULT   "/usr/share/color/icc"

default global search path

Todo:
add installation dir
#define OY_PROFILE_PATH_USER_DEFAULT   "~/.color/icc"
Deprecated:
default local search path
#define OY_PROFILE_STD   OY_STD OY_SLASH "profile"

Type path for standard settings

#define OY_PROFILES_EFFECT   OY_PROFILE_STD OY_SLASH "profiles_effect"

key name for effect profiles in a filter node; like for sepia or b/w etc.

Since
0.9.6
Examples:
image_display.cpp.
#define OY_PROFILES_SIMULATION   OY_PROFILE_STD OY_SLASH "profiles_simulation"

key name for simulation profiles in a filter node; like for proofing

Since
0.9.6
#define OY_REGISTRED_PROFILES   OY_STD OY_SLASH "device_profiles"

Oyranos default profiles key path in the data base

#define OY_SLASH   "/"
#define OY_SLASH_C   '/'

Oyranos general key path in the data base

Examples:
tutorial_json_options.c.

Referenced by oyDeviceFromJSON(), oyDeviceSetup(), oyDeviceUnset(), and oyGetPersistentString().

#define OY_SYS   "system/"

system keys

#define OY_SYS_PATH1   "/usr"

OpenICC directory proposal needs additional 'share,lib' and 'color' and purpose 'icc,cmms,...'

Since
0.1.8
#define OY_TOP_INTERNAL   "org"
Deprecated:
use this path for non standardised filters and applications
#define OY_TOP_SHARED   "org"

Top path for standard settings

Examples:
oyranos_cmm_oJPG.c.
#define OY_TYPE_STD   "openicc"
#define OY_USER   "user/"

user keys

#define OY_USER_PATH   "~/.local"

from OpenICC directory proposal needs additional 'color' and the usage 'icc/cmms/...'

Since
0.1.8