Debian Codegraph @

doc/website/faq.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <title>colord - Frequently Asked Questions</title>
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
6 <link rel="stylesheet" href="style.css" type="text/css" media="screen"/>
7 <link rel="shortcut icon" href="favicon.ico"/>
8 </head>
9 <body>
10
11 <p>Back to the <a href="index.html">main page</a></p>
12
13 <h1>Frequently asked questions</h1>
14
15 <h2>Table Of Contents</h2>
16 <ul>
17 <li><a href="#spelling">Can I type colord with leading upper case 'C'?</a></li>
18 <li><a href="#versions">What do the version numbers mean?</a></li>
19 <li><a href="#gcm">How does colord interface with the session?</a></li>
20 <li><a href="#XRandR13">Are XRandR 1.2 devices still supported?</a></li>
21 <li><a href="#imageloading">Does colord or GNOME Color Manager convert my image?</a></li>
22 <li><a href="#whydbnotxml">Why are the mappings stored in a database, not readable XML files?</a></li>
23 <li><a href="#nvidia-driver">Does calibration work with the NVIDIA binary driver?</a></li>
24 <li><a href="#cmm-cmf-cms">What is the difference between a CMM, CMF and a CMS?</a></li>
25 <li><a href="#sensors">What is a native sensor?</a></li>
26 <li><a href="#application">How would an application like Simple Scan use colord?</a></li>
27 <li><a href="#qualifiers">What is a qualifier used for?</a></li>
28 <li><a href="#daemon">How do system daemons add devices and profiles?</a></li>
29 <li><a href="#cups">How would a system daemon like CUPS use colord?</a></li>
30 <li><a href="#translation">How do I translate colord?</a></li>
31 <li><a href="#corporate-sponsor">Is there an organization sponsoring development of colord?</a></li>
32 <li><a href="#oyranos">What's the difference between colord and Oyranos?</a></li>
33 <li><a href="#why-root">Does the daemon run as root?</a></li>
34 <li><a href="#application-support">What desktop applications support color management?</a></li>
35 <li><a href="#help">>How can I help??</a></li>
36 </ul>
37
38 <hr/>
39 <h3><a name="spelling">Can I type colord with leading upper case 'C'</a></h3>
40 <p>
41 No.
42 </p>
43
44 <hr/>
45 <h3><a name="versions">What do the version numbers mean</a></h3>
46 <p>
47 Version numbers are of the form <b>${major}</b>.<b>${minor}</b>.<b>${micro}</b>.
48 </p>
49 <center>
50 <table cellpadding="5px">
51 <tr><th>Git Branch</th><th>Version Numbers</th><th>Maintained Status</th></tr>
52 <tr><td><code>colord-0-1</code></td><td><code>0.1.*</code></td><td><code>obsolete</code></td></tr>
53 <tr><td><code>colord-1-0</code></td><td><code>1.0.*</code></td><td><code>stable</code>, getting backported fixes</td></tr>
54 <tr><td><code>master</code></td><td><code>1.1.*</code></td><td><code>unstable</code>, getting fixes and new features</td></tr>
55 </table>
56 </center>
57 <p>
58 Branches with the status <code>stable</code> are suitable for distributions like SLED
59 and RHEL and are 100% ABI and API stable. Translatable source strings will not be
60 added or modified and dependency versions will not be updated.
61 Tarball releases from this branch should be considered safe to push to users as
62 normal updates.
63 </p>
64 <p>
65 Branches with the status <code>unstable</code> are suitable for distributions like Fedora
66 or jhbuild and are potentially ABI and API unstable and will contain new
67 features, refactoring or new translatable strings where required.
68 Tarball releases from this branch should be QA'd before pushing to users
69 as test updates.
70 </p>
71 <p>
72 Branches with the status <code>obsolete</code> do not get backported fixes,
73 although may get security fixes backported if it is practical to do so.
74 </p>
75 <p>
76 Every 6 months (roughly aligned to the GNOME release schedule) we will branch
77 a new minor version from master, so the new stable version is 1.(n+1).0
78 and the new unstable version is 1.(n+2).0.
79 This means that even minor versions are stable, odd are unstable.
80 </p>
81 <p>
82
83 <hr/>
84 <h3><a name="gcm">How does colord interface with the session?</a></h3>
85 <p>
86 At start-up either gnome-settings-daemon or colord-kde has to create profiles
87 and devices and otherwise act as the helper agent for colord in the user session.
88 The session client has to do the following 6 things:
89 </p>
90 <ul>
91 <li>
92 Call <code>CreateDevice</code> for each connected XRandR screen and
93 watch for changes to the screen.
94 </li>
95 <li>
96 Create an ICC profile file for each XRandR device using the EDID
97 primary information and store it in the home directory.
98 </li>
99 <li>
100 Call <code>CreateProfile</code> for each profile found in the home
101 directory.</li>
102 <li>
103 For each <code>::profile-added</code> event check if the
104 <code>EDID_md5</code> metadata matches any XRandR devices.
105 If it does, then it needs to call <code>Device.AddProfile()</code>
106 </li>
107 <li>
108 For each <code>::device-added</code> event check if the device
109 <code>modified</code> property is beyond a set threshold.
110 If it is, show a notification that the user should calibrate the device.
111 </li>
112 <li>
113 For each <code>::device-added</code> event from a XRandR device,
114 get the default profile and push the gamma ramp to the X output.
115 </li>
116 </ul>
117
118
119 <hr/>
120 <h3><a name="XRandR13">Are XRandR 1.2 devices still supported?</a></h3>
121 <p>
122 No. XRandR 1.3 is required to do per-output gamma correction.
123 </p>
124
125 <hr/>
126 <h3><a name="imageloading">Does colord or GNOME Color Manager convert my image?</a></h3>
127 <p>
128 You can use the <a href="https://github.com/hughsie/colord/blob/master/lib/colord/cd-transform.c#L22">CdTransform</a>
129 object in <a href="https://www.freedesktop.org/software/colord/gtk-doc/">libcolord</a>
130 for simple RGB->RGB transforms.
131 You need to use a pixel conversion library, for instance
132 <a href="http://www.littlecms.com/">lcms2</a> for anything more complicated.
133 </p>
134
135 <hr/>
136 <h3><a name="whydbnotxml">Why are the mappings stored in a database, not readable XML files?</a></h3>
137 <p>
138 If you have a registry that more than one program is changing, you
139 <b>need</b> locking.
140 Locking with plain files is neither fun nor reliable.
141 From a raw performance point of view, it's two orders of magnitude
142 faster to mmap a single 20k sqlite .db file than it is to read 200
143 small XML files from the file system.
144 </p>
145 <p>
146 The session needs to <b>query</b> things like <i>give me all the
147 profiles for device $foo</i> and <i>find all the devices that use
148 profile $bar</i> which is why we should be using a database, rather than
149 searching discrete files on the file system every time the session asks
150 for data.
151 </p>
152 <p>
153 If we're <i>exchanging</i> files between users, then single files do
154 start to make sense.
155 I don't personally see a use case where I want to exchange low level
156 device->profile settings data with somebody else.
157 A chain of settings from document to printer would be a very useful
158 thing, but this is what you generate for a process and ship, rather
159 than copy from the file system unchanged.
160 </p>
161 <p>
162 Having power users <i>tweaking</i> the mapping is something that does
163 not make good design.
164 These people can use the <code>colormgr</code> command line client to
165 add and remove mappings, and to append qualifiers to certain profiles in
166 a safe abstracted way.
167 </p>
168
169 <hr/>
170 <h3><a name="nvidia-driver">Does calibration work with the NVIDIA binary driver?</a></h3>
171 <p>
172 The binary driver from NVIDIA only supports XRandR 1.2, which means that
173 it does not support per-monitor gamma tables.
174 This means we can only send gamma correction tables to the screen, which
175 means multiple monitor would not be supported.
176 </p>
177 <p>
178 As the driver has no source code, we can't fix this and have to wait for
179 NVIDIA to release a fixed version of their driver.
180 Nowadays the open source nouveau driver provides a much better
181 experience for NVIDIA hardware, and gnome-color-manager of course works
182 flawlessly with all of the open source drivers.
183 </p>
184
185 <hr/>
186 <h3><a name="cmm-cmf-cms">What is the difference between a CMM, CMF and a CMS?</a></h3>
187 <p>
188 A CMM (Color Management Module) is the software component that takes the
189 pixels in an image and converts them from one colorspace to another.
190 There are several CMM engines in existence, both free and proprietary.
191 Free CMM engines include ArgyllCMS and lcms2, of which the latter is
192 used heavily by colord and both are used by gnome-color-manager.
193 </p>
194 <p>
195 A CMF (Color Management Framework) is a software component that allows
196 applications to register devices and profiles, and also allows
197 applications to query what profiles to use for a device.
198 A CMF is a higher logical layer component to a CMM engine -- in this
199 way, colord aims to be primarily a CMF, and is not a full featured CMM.
200 </p>
201 <p>
202 It is the authors opinion that the abbreviation CMS is a heavily
203 overloaded term (in that ArgyllCMS and L[ittle]CMS include them in their
204 name), but do not actually provide a system framework for other
205 applications to use.
206 In casual usage, both LCMS and colord exhibit some parts of a complete
207 CMS, and in this way CMS is often used as a general term for both a
208 CMM and a CMF.
209 </p>
210
211 <hr/>
212 <h3><a name="sensors">What is a native sensor?</a></h3>
213 <p>
214 A native sensor is a calibration device such as a colorimeter or
215 photospectrometer that colord knows how to interface with.
216 </p>
217 <p>
218 Many sensor makes and models are recognised, and are available to be used
219 by programs such as <a href="http://www.argyllcms.com/">ArgyllCMS</a>.
220 The following sensors have native drivers and do not need to spawn ArgyllCMS to
221 take readings:
222 </p>
223 <ul>
224 <li><a href="http://www.pantone.co.uk/pages/products/product.aspx?pid=562">Pantone Huey</a></li>
225 <li>Hughski ColorHug (<a href="https://blogs.gnome.org/hughsie/2018/02/01/no-new-batches-of-colorhug2/">no longer produced</a>)</li>
226 <li><a href="http://www.xrite.com/product_overview.aspx?Action=support&ID=730">XRite DTP94</a></li>
227 </ul>
228 </p>
229 <p>
230 A native driver allows colord to lock the device, read a sample from the
231 sensors (or from the ambient light sensor) and unlock the device.
232 A native device allows client programs to get samples from the device
233 trivially using either raw D-Bus or libcolord without relying on external
234 programs.
235 </p>
236
237 <hr/>
238 <h3><a name="qualifiers">What is a qualifier used for?</a></h3>
239 <p>
240 A qualifier is a single string with three sub-strings joined with dots.
241 For example, <code>RGB.Glossy.300dpi</code> would be the qualifier on
242 a profile for a RGB device, printing on glossy paper and at 300 dots-per-inch.
243 </p>
244 <p>
245 Qualifiers are assigned to a profile either by CUPS itself or by the user
246 and this allows CUPS to choose the correct profile for a given print job.
247 The sub-strings are tried in preference order, so that for a print job
248 of type <code>RGB.Glossy.300dpi</code> the following fallbacks would be
249 used:
250 </p>
251 <ol>
252 <li><code>RGB.Glossy.300dpi</code></li>
253 <li><code>RGB.Glossy.*</code></li>
254 <li><code>RGB.*.300dpi</code></li>
255 <li><code>RGB.*.*</code></li>
256 <li><code>*</code></li>
257 </ol>
258 <p>
259 The fallback scheme allows one profile to potentially match lots of
260 different print conditions, as very few users will have more than
261 a couple of different printer profiles.
262 </p>
263 <p>
264 The tri-dotted notation was chosen in preference to JSON or XML as it
265 is <a href="http://www.cups.org/documentation.php/doc-1.4/spec-ppd.html#cupsICCProfile">
266 already being used by CUPS</a> in the <code>cupsICCProfile</code> PPD
267 Extensions format.
268 </p>
269
270 <hr/>
271 <h3><a name="application">How would an application like Simple Scan use colord?</a></h3>
272 <p>
273 It's actually really easy.
274 Simple Scan already knows the <code>SANE_Device</code> object of the
275 scanner that it wants to use.
276 From the <code>SANE_Device</code> object we can easily get the
277 <i>device_id</i> for the color managed device in colord.
278 To do this, refer to the <a href="git://github.com/hughsie/colord.git/blobs/master/doc/device-and-profile-naming-spec.txt">
279 device and profile specification</a> for scanner devices.
280 This specifies the <i>device_id</i> for a sane device is made up from
281 <code>"sane_" + sane_device->model</code>.
282 </p>
283 <p>
284 We can now query colord using <a href="http://colord.hughsie.com/api/">
285 libcolord</a> for the device that matches this ID:
286 </p>
287 <pre>
288 CdClient *client = NULL;
289 CdDevice *device = NULL;
290 CdProfile *profile = NULL;
291 GError *error = NULL;
292
293 /* create a connection to colord */
294 client = cd_client_new ();
295
296 /* find the device for a specific ID */
297 device = cd_client_find_device_sync (client, device_id, NULL, &amp;error);
298 if (device == NULL) {
299 g_warning ("failed to find a device in colord: %s,
300 error->message);
301 g_error_free (error);
302 goto out;
303 }
304
305 /* get the default profile for this device */
306 profile = cd_device_get_default_profile (device);
307 if (profile == NULL)
308 goto out;
309
310 /* TODO: use lcms to convert the scanned image */
311 g_message ("need to use: %s", cd_profile_get_filename (profile));
312 out:
313 if (profile != NULL)
314 g_object_unref (profile);
315 if (device != NULL)
316 g_object_unref (device);
317 g_object_unref (client);
318 </pre>
319 <p>
320 If you're not happy gaining an additional dependency of libcolord, then
321 it's also pretty easy to use raw D-Bus calls to do the same thing.
322 See the <a href="git://github.com/hughsie/colord.git/trees/master/examples">
323 examples</a> folder for some code samples.
324 </p>
325
326 <hr/>
327 <h3><a name="daemon">How do system daemons add devices and profiles?</a></h3>
328 <p>
329 Like this:
330 </p>
331 <pre>
332 for device in self.devices:
333 o = CreateDevice(device.name)
334 for profile in device.profiles:
335 p = AddProfile(profile.id)
336 if profile.icc_filename:
337 p.SetFilename(profile.icc_filename)
338 p.SetQualifier(profile.qualifier)
339 o.AddProfile(p)
340 </pre>
341
342 <hr/>
343 <h3><a name="cups">How would a system daemon like CUPS use colord?</a></h3>
344 <p>
345 Like this:
346 </p>
347 <pre>
348 d = FindDeviceById(device.name)
349 if d:
350 p = d.GetProfileForQualifier(qualifier)
351 if p:
352 p.Use()
353 </pre>
354
355 <hr/>
356 <h3><a name="translation">How do I translate colord?</a></h3>
357 <p>
358 See the <a href="https://www.transifex.com/projects/p/colord/">colord Transifex</a>
359 pages for how to contribute to localisation.
360 </p>
361
362 <hr/>
363 <h3><a name="corporate-sponsor">Is there an organization or corporation sponsoring development of colord?</a></h3>
364 <p>
365 colord is not sponsored by anyone, although
366 <a href="http://www.redhat.com">Red Hat</a> gives me the time to
367 work on random open source projects. Thanks!
368 </p>
369
370 <hr/>
371 <h3><a name="oyranos">What's the difference between colord and Oyranos?</a></h3>
372 <p>
373 On the surface, <a href="http://www.oyranos.org/">Oyranos</a> and colord
374 look like similar projects.
375 I'm not going to be able to write an unbiased comparison against colord and
376 Oyranos (as the author of the former) but I've supplied the table below which
377 hopefully helps.
378 </p>
379 <table class="noteinformation">
380 <tr><th></th><th>Oyranos</th><th>colord</th></tr>
381 <tr><td>Portability</td><td>Windows, Linux, OSX</td><td>Linux, FreeBSD<i>[1]</i></td></tr>
382 <tr>
383 <td>Desktop support</td>
384 <td>
385 <a href="http://www.fltk.org/">FLTK</a> (native) and
386 <a href="http://www.oyranos.org/kolormanager/">KDE</a>
387 </td>
388 <td>
389 <a href="http://www.gnome.org/">GNOME</a>,
390 <a href="https://dantti.wordpress.com/2012/03/12/coloring-you-desktop-with-colord-kde/">KDE</a>
391 and <a href="https://github.com/agalakhov/xiccd">XFCE, LXDE, MATE</a>
392 </td>
393 </tr>
394 <tr>
395 <td>Client access</td>
396 <td>C</td>
397 <td>
398 C, <a href="https://www.freedesktop.org/wiki/Software/dbus">DBus</a> (native),
399 all others via <a href="https://live.gnome.org/GObjectIntrospection">GObject Introspection</a>
400 </td>
401 </tr>
402 <tr><td>Client library</td><td>Synchronous, and not MT-safe</td><td>Synchronous, asynchronous and MT safe</td></tr>
403 <tr>
404 <td>Lines of code</td><td><a href="https://www.ohloh.net/p/oyranos">151k</a></td>
405 <td><a href="https://www.ohloh.net/p/colord">46k</a></td>
406 </tr>
407 <tr>
408 <td>Memory allocation</td>
409 <td>custom</td>
410 <td><a href="https://en.wikipedia.org/wiki/GLib">GLib</a></td>
411 </tr>
412 <tr>
413 <td>Object system</td>
414 <td>custom</td>
415 <td><a href="https://en.wikipedia.org/wiki/GObject">GObject</a></td>
416 </tr>
417 <tr><td>Build system</td><td>custom</td><td>automake</td></tr>
418 <tr>
419 <td>Settings store</td>
420 <td><a href="https://www.ohloh.net/p/7750">elektra</a> <i>[2]</i></td>
421 <td><a href="https://www.sqlite.org/">sqlite</a></td>
422 </tr>
423 <tr>
424 <td>Session presentation</td>
425 <td><i>photographer</i>, <i>prepress</i> and <i>designer</i></td>
426 <td>None <i>[3]</i></td>
427 </tr>
428 <tr>
429 <td>Full screen color management</td>
430 <td><a href="http://www.compiz.org/">Compiz</a>, using X atoms as IPC</td>
431 <td><a href="http://wayland.freedesktop.org/">Wayland</a> with subsurfaces used as opt-out areas (WIP)</td>
432 </tr>
433 <tr><td>Project age</td><td>9 years</td><td>3 years</td></tr>
434 <tr>
435 <td>Required by</td>
436 <td valign="top">
437 <ul>
438 <li><a href="http://www.oyranos.org/wiki/index.php?title=ICC_Examin">icc_examin</a></li>
439 <li><a href="http://www.oyranos.org/kolormanager/">Kolor Manager</a></li>
440 <li><a href="http://www.cinepaint.org/">CinePaint</a> (<a href="http://www.ohloh.net/p/cinepaint">obsolete</a>)</li>
441 </ul>
442 </td>
443 <td>
444 <ul>
445 <li><a href="http://www.cups.org/">CUPS</a></li>
446 <li><a href="https://en.wikipedia.org/wiki/Foomatic">Foomatic</a></li>
447 <li><a href="http://www.gtk.org/">GTK+</a></li>
448 <li><a href="https://dantti.wordpress.com/2012/03/12/coloring-you-desktop-with-colord-kde/">colord-kde</a></li>
449 <li><a href="http://www.gnome.org/">gnome-control-center</a></li>
450 <li><a href="http://www.gnome.org/">gnome-settings-daemon</a></li>
451 <li><a href="https://github.com/agalakhov/xiccd">xiccd</a></li>
452 <li><a href="https://mail.gnome.org/mailman/listinfo/gnome-color-manager-list">GNOME Color Manager</a></li>
453 <li><a href="https://lwn.net/Articles/377063/">Simple Scan</a></li>
454 <li><a href="http://jonls.dk/redshift/">redshift</a></li>
455 <li><a href="https://github.com/hughski/colorhug-client/">colorhug-client</a></li>
456 </ul>
457 </td>
458 </tr>
459 </table>
460 <p>
461 Notes:
462 </p>
463 <ol>
464 <li>
465 In my opinion, it is better to leverage the native color management
466 stack for each operating system, for instance, using Windows Color
467 System on win32, and ColorSync on OSX rather than try to install
468 alongside the existing frameworks.
469 </li>
470 <li>
471 Elektra <i>could</i> be replaced by another configuration engine.
472 </li>
473 <li>
474 This no user profile system in colord as users vary rarely sit into
475 well defined groups and putting profiles in the UI abstracts the
476 settings one stage further from what the desktop user is trying to
477 achieve.
478 </li>
479 </ol>
480 <p>
481 </p>
482 <p>
483 </p>
484
485 <hr/>
486 <h3><a name="why-root">Does the daemon run as root?</a></h3>
487 <p>
488 Since version 0.1.12 (released August 2011) colord runs as the
489 <i>colord</i> user, not <i>root</i> &#151; if you're still running this or
490 an older version please file a bug with your distribution to get it to
491 upgrade the package to something more modern!
492 </p>
493 <p>
494 The original reason for running as the root user was to check the PolicyKit
495 authorisation request, but PolicyKit 0.104 (released October 2011)
496 added functionality to allow non-root daemons to do this as well.
497 </p>
498
499 <hr/>
500 <h3><a name="application-support">What desktop applications support color management</a></h3>
501 <p>
502 Applications can query colord directly, or can use the per-session
503 <a href="http://www.oyranos.org/wiki/index.php?title=ICC_Profiles_in_X_Specification_0.4">
504 <code>_ICC_PROFILE</code> X atom</a>.
505 </p>
506 <table class="noteinformation">
507 <tr><th>Software</th><th>colord support</th><th>_ICC_PROFILE support</th><th>Notes</th></tr>
508 <tr><td><a href="http://www.gtk.org/">GTK+</a></td><td>Yes</td><td>No</td><td>Only the print dialog</td></tr>
509 <tr><td><a href="https://lwn.net/Articles/377063/">Simple Scan</a></td><td>Yes</td><td>No</td><td></td></tr>
510 <tr><td><a href="http://www.gimp.org/">GIMP</a></td><td>No</td><td>Yes</td><td>Need to enable it before use</td></tr>
511 <tr><td><a href="https://www.mozilla.org/en-US/">Firefox</a></td><td>No</td><td>Yes</td><td>Need to enable it before use</td></tr>
512 <tr><td><a href="http://projects.gnome.org/eog/">Eye of GNOME</a></td><td>No</td><td>Yes</td><td></td></tr>
513 <tr><td><a href="http://www.darktable.org/">Darktable</a></td><td>Yes</td><td>Yes</td><td></td></tr>
514 <tr><td><a href="http://krita.org/">Krita</a></td><td>No</td><td>Yes</td><td></td></tr>
515 <tr><td><a href="http://www.calligra-suite.org/">Calligra</a></td><td>No</td><td>Yes</td><td></td></tr>
516 <tr><td><a href="http://www.digikam.org/">Digikam</a></td><td>No</td><td>Yes</td><td>Need to enable it before use</td></tr>
517 <tr><td><a href="http://ufraw.sourceforge.net/">UFRaw</a></td><td>No</td><td>Yes</td><td></td></tr>
518 <tr><td><a href="http://inkscape.org/">Inkscape</a></td><td>No</td><td>Yes</td><td></td></tr>
519 <tr><td><a href="http://entangle-photo.org/">Entangle</a></td><td>No</td><td>Yes</td><td></td></tr>
520 </table>
521
522 <hr/>
523 <h3><a name="help">How can I help?</a></h3>
524 <p>
525 Anyone interested in colord development is invited to join the
526 channel <code>#gnome-color-manager</code> on <code>irc.gnome.org</code>.
527 We are a friendly bunch, and can answer questions on D-Bus interfaces,
528 general lcms questions or anything else colord related.
529 </p>
530
531 <p>Back to the <a href="index.html">main page</a></p>
532
533 <p class="footer">
534 Copyright <a href="mailto:[email protected]">Richard Hughes 2011 - 2013</a><br/>
535 <a href="http://validator.w3.org/check/referer">Optimized</a>
536 for <a href="http://www.w3.org/">standards</a>.
537 </p>
538
539 </body>
540 </html>
541