Oyranos Colour Management System API
Functions
oyranos.c File Reference

The API implementation. More...

#include "oyranos.h"
#include <sys/stat.h>
#include <unistd.h>
#include <langinfo.h>
#include <stdio.h>
#include <string.h>
#include "config.h"
#include "oyranos_check.h"
#include "oyranos_debug.h"
#include "oyranos_elektra.h"
#include "oyranos_helper.h"
#include "oyranos_internal.h"
#include "oyranos_io.h"
#include "oyranos_sentinel.h"
#include "oyranos_string.h"
#include "oyranos_texts.h"
#include "oyranos_xml.h"

Functions

oyWIDGET_eoyWidgetListGet (oyGROUP_e group, int *count, oyAlloc_f allocate_func)
 all widgets of a group
oyWIDGET_TYPE_e oyWidgetTitleGet (oyWIDGET_e option, const oyGROUP_e **categories, const char **name, const char **tooltip, int *flags)
 Get a special Options UI strings.
int oyOptionChoicesGet (oyWIDGET_e option, int *choices, const char ***choices_string_list, int *current)
 Get a Options choices UI strings.
void oyOptionChoicesFree (oyWIDGET_e option, char ***list, int size)
 delete list of choices from a option
int oySetBehaviour (oyBEHAVIOUR_e type, int choice)
int oyGetBehaviour (oyBEHAVIOUR_e type)
int oyPolicySaveActual (oyGROUP_e group, const char *name)
 save a options group to a file
char * oyPolicyToXML (oyGROUP_e group, int add_header, oyAlloc_f allocate_func)
int oyReadXMLPolicy (oyGROUP_e group, const char *xml)
int oyPolicyFileNameGet (const char *policy_name, char **full_name, oyAlloc_f allocateFunc)
 resolve the file name of a policy
int oyPolicySet (const char *policy_file, const char *full_name)
int oySetDefaultProfile (oyPROFILE_e type, const char *file_name)
int oySetDefaultProfileBlock (oyPROFILE_e type, const char *file_name, void *mem, size_t size)
char * oyGetDefaultProfileName (oyPROFILE_e type, oyAlloc_f allocate_func)
char ** oyProfileListGet (const char *coloursig, uint32_t *size, oyAlloc_f allocateFunc)
 get a list of profile filenames
int oyCheckProfile (const char *filename, const char *coloursig)
 check an file if it is a profile
int oyCheckProfileMem (const void *mem, size_t size, const char *coloursig)
 check an memory block if it is a profile
size_t oyGetProfileSize (const char *profilename)
 get the profiles size
void * oyGetProfileBlock (const char *profilename, size_t *size, oyAlloc_f allocate_func)
 obtain an memory block in the responsibility of the user
char * oyGetPathFromProfileName (const char *profile_name, oyAlloc_f allocate_func)
int oyProfileGetMD5 (void *buffer, size_t size, unsigned char *md5_return)
 calculate a md5 digest beginning after the header offset
char * oyGetDeviceProfile (oyDEVICETYP_e typ, const char *manufacturer, const char *model, const char *product_id, const char *host, const char *port, const char *attrib1, const char *attrib2, const char *attrib3, oyAlloc_f allocate_func)
 ask for a profile name by specifying device attributes
int oySetDeviceProfile (oyDEVICETYP_e typ, const char *manufacturer, const char *model, const char *product_id, const char *host, const char *port, const char *attrib1, const char *attrib2, const char *attrib3, const char *profileName, const void *mem, size_t size)
 set a profile name with specifying device attributes
int oyEraseDeviceProfile (oyDEVICETYP_e typ, const char *manufacturer, const char *model, const char *product_id, const char *host, const char *port, const char *attrib1, const char *attrib2, const char *attrib3)
 remove or deinstall the profile from the current path
void oyI18NSet (int active, int reserved)
 switch internationalisation of strings on or off

Detailed Description

The API implementation.

public Oyranos API's

This file contains functions implementing the Oyranos API.
For the Oyranos API see

Oyranos is an open source Colour Management System

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

Function Documentation

int oyEraseDeviceProfile ( oyDEVICETYP_e  typ,
const char *  manufacturer,
const char *  model,
const char *  product_id,
const char *  host,
const char *  port,
const char *  attrib1,
const char *  attrib2,
const char *  attrib3 
)

remove or deinstall the profile from the current path

char* oyGetDeviceProfile ( oyDEVICETYP_e  typ,
const char *  manufacturer,
const char *  model,
const char *  product_id,
const char *  host,
const char *  port,
const char *  attrib1,
const char *  attrib2,
const char *  attrib3,
oyAlloc_f  allocate_func 
)

ask for a profile name by specifying device attributes

Parameters:
typkind of device
manufacturerthe device manufacturer (EIZO)
modelthe model (LCD2100)
product_idthe ID reported during connection (ID_701200xx)
hostuseful for monitor identification (grafic:0.0)
portkind of connection (Matrox G650)
attrib1additional attribute
attrib2additional attribute
attrib3additional attribute
allocate_functhe users memory allocation function

simply pass 0 for not specified properties

   char* profile_name = oyGetDeviceProfile ("EIZO", "LCD2100",
                                            "ID 87-135.19",
                                            "grafic:0.0", "Matrox G650",
                                             "100lux", 0,
                                            "", allocate_func);
   if (profile_name)
   { char* ptr = NULL;
     ptr = oyGetProfileBlock (profile_name, allocate_func);
       // do something
     free (ptr);
   }
Returns:
allocated by oyAlloc_f
int oySetDeviceProfile ( oyDEVICETYP_e  typ,
const char *  manufacturer,
const char *  model,
const char *  product_id,
const char *  host,
const char *  port,
const char *  attrib1,
const char *  attrib2,
const char *  attrib3,
const char *  profileName,
const void *  mem,
size_t  size 
)

set a profile name with specifying device attributes

Parameters:
memremains in the users domain