1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
|
/*
File: CMDeviceIntegration.h
Contains: Color Management Device Interfaces
Version: QuickTime 7.3
Copyright: (c) 2007 (c) 2000-2001 by Apple Computer, Inc., all rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __CMDEVICEINTEGRATION__
#define __CMDEVICEINTEGRATION__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __CFSTRING__
#include <CFString.h>
#endif
#ifndef __CMAPPLICATION__
#include <CMApplication.h>
#endif
#ifndef __CMICCPROFILE__
#include <CMICCProfile.h>
#endif
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#if PRAGMA_IMPORT
#pragma import on
#endif
#if PRAGMA_STRUCT_ALIGN
#pragma options align=mac68k
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(push, 2)
#elif PRAGMA_STRUCT_PACK
#pragma pack(2)
#endif
/*
The current versions of the data structure
containing information on registered devices.
*/
enum {
cmDeviceInfoVersion1 = 0x00010000,
cmDeviceProfileInfoVersion1 = 0x00010000,
cmDeviceProfileInfoVersion2 = 0x00020000
};
enum {
cmCurrentDeviceInfoVersion = cmDeviceInfoVersion1,
cmCurrentProfileInfoVersion = cmDeviceProfileInfoVersion1
};
/*
Certain APIs require a device ID or profile ID.
In some cases, a "default ID" can be used.
*/
enum {
cmDefaultDeviceID = 0,
cmDefaultProfileID = 0
};
/*
Possible values for device states accessible by the
CMGetDeviceState() and CMSetDeviceState() APIs.
*/
enum {
cmDeviceStateDefault = 0x00000000,
cmDeviceStateOffline = 0x00000001,
cmDeviceStateBusy = 0x00000002,
cmDeviceStateForceNotify = (long)0x80000000,
cmDeviceStateDeviceRsvdBits = 0x00FF0000,
cmDeviceStateAppleRsvdBits = (long)0xFF00FFFF
};
/*
Possible values for flags passed to the
CMIterateDeviceProfiles() API.
"Factory" profiles are registered via the
CMSetDeviceFactoryProfiles() API.
"Custom" profiles are those which are meant to take
the place of the factory profiles, as a result of
customization or calibration. These profiles are
registered via the CMSetDeviceProfiles() API.
To retrieve all of the the former for all devices,
use cmIterateFactoryDeviceProfiles as the flags
value when calling CMIterateDeviceProfiles().
To retrieve only the latter for all devices, use
the cmIterateCustomDeviceProfiles, as the flags
value when calling CMIterateDeviceProfiles().
To get the profiles in use for all devices, use
cmIterateCurrentDeviceProfiles as the flags value.
This will replace the factory profiles with any
overrides, yielding the currently used set.
To get all profiles, without replacement, use
cmIterateAllDeviceProfiles.
*/
enum {
cmIterateFactoryDeviceProfiles = 0x00000001,
cmIterateCustomDeviceProfiles = 0x00000002,
cmIterateCurrentDeviceProfiles = 0x00000003,
cmIterateAllDeviceProfiles = 0x00000004,
cmIterateDeviceProfilesMask = 0x0000000F
};
/*
Errors returned by CMDeviceIntegration APIs
*/
enum {
cmDeviceDBNotFoundErr = -4227, /* Prefs not found/loaded */
cmDeviceAlreadyRegistered = -4228, /* Re-registration of device */
cmDeviceNotRegistered = -4229, /* Device not found */
cmDeviceProfilesNotFound = -4230, /* Profiles not found */
cmInternalCFErr = -4231 /* CoreFoundation failure */
};
/*
Clients can register for notifications of device evolutions:
DeviceRegistered A new device was registered
DeviceUnregistered A device was unregistered
DeviceOnline Change to Online as a result of CMSetDeviceState
DeviceOffline Change to Offline as a result of CMSetDeviceState
DeviceState Any change to a device state
DefaultDevice A default device for any device class changed
DeviceProfiles Any change to any device's profiles
DefaultDeviceProfile The default profile for any device changed
*/
#define kCMDeviceRegisteredNotification CFSTR("CMDeviceRegisteredNotification")
#define kCMDeviceUnregisteredNotification CFSTR("CMDeviceUnregisteredNotification")
#define kCMDeviceOnlineNotification CFSTR("CMDeviceOnlineNotification")
#define kCMDeviceOfflineNotification CFSTR("CMDeviceOfflineNotification")
#define kCMDeviceStateNotification CFSTR("CMDeviceStateNotification")
#define kCMDefaultDeviceNotification CFSTR("CMDefaultDeviceNotification")
#define kCMDeviceProfilesNotification CFSTR("CMDeviceProfilesNotification")
#define kCMDefaultDeviceProfileNotification CFSTR("CMDefaultDeviceProfileNotification")
/*
Device state data.
*/
typedef UInt32 CMDeviceState;
/*
A CMDeviceID must be unique within a device's class.
*/
typedef UInt32 CMDeviceID;
/*
A CMDeviceProfileID must only be unique per device.
*/
typedef UInt32 CMDeviceProfileID;
/*
DeviceClass type.
*/
enum {
cmScannerDeviceClass = FOUR_CHAR_CODE('scnr'),
cmCameraDeviceClass = FOUR_CHAR_CODE('cmra'),
cmDisplayDeviceClass = FOUR_CHAR_CODE('mntr'),
cmPrinterDeviceClass = FOUR_CHAR_CODE('prtr'),
cmProofDeviceClass = FOUR_CHAR_CODE('pruf')
};
typedef OSType CMDeviceClass;
/*
CMDeviceScope
Structure specifying a device's or a device setting's scope.
*/
struct CMDeviceScope {
CFStringRef deviceUser; /* kCFPreferencesCurrentUser | _AnyUser */
CFStringRef deviceHost; /* kCFPreferencesCurrentHost | _AnyHost */
};
typedef struct CMDeviceScope CMDeviceScope;
typedef CMDeviceScope CMDeviceProfileScope;
/*
CMDeviceInfo
Structure containing information on a given device.
*/
struct CMDeviceInfo {
UInt32 dataVersion; /* cmDeviceInfoVersion1 */
CMDeviceClass deviceClass; /* device class */
CMDeviceID deviceID; /* device ID */
CMDeviceScope deviceScope; /* device's scope */
CMDeviceState deviceState; /* Device State flags */
CMDeviceProfileID defaultProfileID; /* Can change */
CFDictionaryRef * deviceName; /* Ptr to storage for CFDictionary of */
/* localized device names (could be nil) */
UInt32 profileCount; /* Count of registered profiles */
UInt32 reserved; /* Reserved for use by ColorSync */
};
typedef struct CMDeviceInfo CMDeviceInfo;
typedef CMDeviceInfo * CMDeviceInfoPtr;
/*
CMDeviceProfileInfo
Structure containing information on a device profile.
*/
struct CMDeviceProfileInfo {
UInt32 dataVersion; /* cmDeviceProfileInfoVersion1 */
CMDeviceProfileID profileID; /* The identifier for this profile */
CMProfileLocation profileLoc; /* The profile's location */
CFDictionaryRef profileName; /* CFDictionary of localized profile names */
UInt32 reserved; /* Reserved for use by ColorSync */
};
typedef struct CMDeviceProfileInfo CMDeviceProfileInfo;
struct NCMDeviceProfileInfo {
UInt32 dataVersion; /* cmDeviceProfileInfoVersion2 */
CMDeviceProfileID profileID; /* The identifier for this profile */
CMProfileLocation profileLoc; /* The profile's location */
CFDictionaryRef profileName; /* CFDictionary of localized profile names */
CMDeviceProfileScope profileScope; /* The scope this profile applies to */
UInt32 reserved; /* Reserved for use by ColorSync */
};
typedef struct NCMDeviceProfileInfo NCMDeviceProfileInfo;
/*
CMDeviceProfileArray
Structure containing the profiles for a device.
*/
struct CMDeviceProfileArray {
UInt32 profileCount; /* Count of profiles in array */
CMDeviceProfileInfo profiles[1]; /* The profile info records */
};
typedef struct CMDeviceProfileArray CMDeviceProfileArray;
typedef CMDeviceProfileArray * CMDeviceProfileArrayPtr;
/*
Caller-supplied iterator functions
*/
typedef CALLBACK_API_C( OSErr , CMIterateDeviceInfoProcPtr )(const CMDeviceInfo *deviceInfo, void *refCon);
typedef CALLBACK_API_C( OSErr , CMIterateDeviceProfileProcPtr )(const CMDeviceInfo *deviceInfo, const NCMDeviceProfileInfo *profileInfo, void *refCon);
/*
Device Registration
*/
/*
* CMRegisterColorDevice()
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: not available
* Mac OS X: in version 10.1 and later
*/
EXTERN_API( CMError )
CMRegisterColorDevice(
CMDeviceClass deviceClass,
CMDeviceID deviceID,
CFDictionaryRef deviceName,
const CMDeviceScope * deviceScope);
/*
* CMUnregisterColorDevice()
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: not available
* Mac OS X: in version 10.1 and later
*/
EXTERN_API( CMError )
CMUnregisterColorDevice(
CMDeviceClass deviceClass,
CMDeviceID deviceID);
/*
Default Device accessors
*/
/*
* CMSetDefaultDevice()
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: not available
* Mac OS X: in version 10.1 and later
*/
EXTERN_API( CMError )
CMSetDefaultDevice(
CMDeviceClass deviceClass,
CMDeviceID deviceID);
/*
* CMGetDefaultDevice()
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: not available
* Mac OS X: in version 10.1 and later
*/
EXTERN_API( CMError )
CMGetDefaultDevice(
CMDeviceClass deviceClass,
CMDeviceID * deviceID);
/*
Device Profile Registration & Access
*/
/*
* CMSetDeviceFactoryProfiles()
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: not available
* Mac OS X: in version 10.1 and later
*/
EXTERN_API( CMError )
CMSetDeviceFactoryProfiles(
CMDeviceClass deviceClass,
CMDeviceID deviceID,
CMDeviceProfileID defaultProfID,
const CMDeviceProfileArray * deviceProfiles);
/*
* CMGetDeviceFactoryProfiles()
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: not available
* Mac OS X: in version 10.1 and later
*/
EXTERN_API( CMError )
CMGetDeviceFactoryProfiles(
CMDeviceClass deviceClass,
CMDeviceID deviceID,
CMDeviceProfileID * defaultProfID,
UInt32 * arraySize,
CMDeviceProfileArray * deviceProfiles);
/*
* CMSetDeviceProfiles()
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: not available
* Mac OS X: in version 10.1 and later
*/
EXTERN_API( CMError )
CMSetDeviceProfiles(
CMDeviceClass deviceClass,
CMDeviceID deviceID,
const CMDeviceProfileScope * profileScope,
const CMDeviceProfileArray * deviceProfiles);
/*
* CMGetDeviceProfiles()
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: not available
* Mac OS X: in version 10.1 and later
*/
EXTERN_API( CMError )
CMGetDeviceProfiles(
CMDeviceClass deviceClass,
CMDeviceID deviceID,
UInt32 * arraySize,
CMDeviceProfileArray * deviceProfiles);
/*
* CMSetDeviceDefaultProfileID()
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: not available
* Mac OS X: in version 10.1 and later
*/
EXTERN_API( CMError )
CMSetDeviceDefaultProfileID(
CMDeviceClass deviceClass,
CMDeviceID deviceID,
CMDeviceProfileID defaultProfID);
/*
* CMGetDeviceDefaultProfileID()
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: not available
* Mac OS X: in version 10.1 and later
*/
EXTERN_API( CMError )
CMGetDeviceDefaultProfileID(
CMDeviceClass deviceClass,
CMDeviceID deviceID,
CMDeviceProfileID * defaultProfID);
/*
* CMGetDeviceProfile()
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: not available
* Mac OS X: in version 10.1 and later
*/
EXTERN_API( CMError )
CMGetDeviceProfile(
CMDeviceClass deviceClass,
CMDeviceID deviceID,
CMDeviceProfileID profileID,
CMProfileLocation * deviceProfLoc);
/*
* CMSetDeviceProfile()
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: not available
* Mac OS X: in version 10.1 and later
*/
EXTERN_API( CMError )
CMSetDeviceProfile(
CMDeviceClass deviceClass,
CMDeviceID deviceID,
const CMDeviceProfileScope * profileScope,
CMDeviceProfileID profileID,
const CMProfileLocation * deviceProfLoc);
/*
Other Device State/Info accessors
*/
/*
* CMSetDeviceState()
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: not available
* Mac OS X: in version 10.1 and later
*/
EXTERN_API( CMError )
CMSetDeviceState(
CMDeviceClass deviceClass,
CMDeviceID deviceID,
CMDeviceState deviceState);
/*
* CMGetDeviceState()
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: not available
* Mac OS X: in version 10.1 and later
*/
EXTERN_API( CMError )
CMGetDeviceState(
CMDeviceClass deviceClass,
CMDeviceID deviceID,
CMDeviceState * deviceState);
/*
* CMGetDeviceInfo()
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: not available
* Mac OS X: in version 10.1 and later
*/
EXTERN_API( CMError )
CMGetDeviceInfo(
CMDeviceClass deviceClass,
CMDeviceID deviceID,
CMDeviceInfo * deviceInfo);
/*
Device Info & Profile Iterators
*/
/*
* CMIterateColorDevices()
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: not available
* Mac OS X: in version 10.1 and later
*/
EXTERN_API( CMError )
CMIterateColorDevices(
CMIterateDeviceInfoProcPtr proc,
UInt32 * seed,
UInt32 * count,
void * refCon);
/*
* CMIterateDeviceProfiles()
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: not available
* Mac OS X: in version 10.1 and later
*/
EXTERN_API( CMError )
CMIterateDeviceProfiles(
CMIterateDeviceProfileProcPtr proc,
UInt32 * seed,
UInt32 * count,
UInt32 flags,
void * refCon);
#if PRAGMA_STRUCT_ALIGN
#pragma options align=reset
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(pop)
#elif PRAGMA_STRUCT_PACK
#pragma pack()
#endif
#ifdef PRAGMA_IMPORT_OFF
#pragma import off
#elif PRAGMA_IMPORT
#pragma import reset
#endif
#ifdef __cplusplus
}
#endif
#endif /* __CMDEVICEINTEGRATION__ */
|