cec: add a void* parameter to the callback methods, that can be set when enabling...
[deb_libcec.git] / include / cectypes.h
1 #pragma once
2 /*
3 * This file is part of the libCEC(R) library.
4 *
5 * libCEC(R) is Copyright (C) 2011 Pulse-Eight Limited. All rights reserved.
6 * libCEC(R) is an original work, containing original code.
7 *
8 * libCEC(R) is a trademark of Pulse-Eight Limited.
9 *
10 * This program is dual-licensed; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 *
24 *
25 * Alternatively, you can license this library under a commercial license,
26 * please contact Pulse-Eight Licensing for more information.
27 *
28 * For more information contact:
29 * Pulse-Eight Licensing <license@pulse-eight.com>
30 * http://www.pulse-eight.com/
31 * http://www.pulse-eight.net/
32 */
33
34 #ifndef CECTYPES_H_
35 #define CECTYPES_H_
36
37 #include <stdint.h>
38 #include <string.h>
39
40 #if defined(_WIN32) || defined(_WIN64)
41 #define CDECL __cdecl
42 #else
43 #define CDECL
44 #endif
45
46 #if !defined(DECLSPEC)
47 #if defined(_WIN32) || defined(_WIN64)
48 #include <windows.h>
49 #define CDECL __cdecl
50 #if defined DLL_EXPORT
51 #define DECLSPEC __declspec(dllexport)
52 #else
53 #define DECLSPEC __declspec(dllimport)
54 #endif
55 #else
56 #define DECLSPEC
57 #endif
58 #endif
59
60 #ifdef __cplusplus
61 extern "C" {
62 namespace CEC {
63 #endif
64
65 //default physical address 1.0.0.0, HDMI port 1
66 #define CEC_DEFAULT_PHYSICAL_ADDRESS 0x1000
67 #define CEC_DEFAULT_HDMI_PORT 1
68 #define CEC_DEFAULT_BASE_DEVICE 0
69 #define MSGSTART 0xFF
70 #define MSGEND 0xFE
71 #define MSGESC 0xFD
72 #define ESCOFFSET 3
73 #define CEC_BUTTON_TIMEOUT 500
74 #define CEC_POWER_STATE_REFRESH_TIME 30000
75
76 #define CEC_DEFAULT_TRANSMIT_TIMEOUT 1000
77 #define CEC_DEFAULT_TRANSMIT_WAIT 2000
78 #define CEC_DEFAULT_TRANSMIT_RETRIES 1
79
80 #define CEC_MIN_LIB_VERSION 1
81 #define CEC_LIB_VERSION_MAJOR 1
82 #define CEC_LIB_VERSION_MINOR 3
83
84 typedef enum cec_abort_reason
85 {
86 CEC_ABORT_REASON_UNRECOGNIZED_OPCODE = 0,
87 CEC_ABORT_REASON_NOT_IN_CORRECT_MODE_TO_RESPOND = 1,
88 CEC_ABORT_REASON_CANNOT_PROVIDE_SOURCE = 2,
89 CEC_ABORT_REASON_INVALID_OPERAND = 3,
90 CEC_ABORT_REASON_REFUSED = 4
91 } cec_abort_reason;
92
93 typedef enum cec_analogue_broadcast_type
94 {
95 CEC_ANALOGUE_BROADCAST_TYPE_CABLE = 0x00,
96 CEC_ANALOGUE_BROADCAST_TYPE_SATELLITE = 0x01,
97 CEC_ANALOGUE_BROADCAST_TYPE_TERRESTIAL = 0x02
98 } cec_analogue_broadcast_type;
99
100 typedef enum cec_audio_rate
101 {
102 CEC_AUDIO_RATE_RATE_CONTROL_OFF = 0,
103 CEC_AUDIO_RATE_STANDARD_RATE_100 = 1,
104 CEC_AUDIO_RATE_FAST_RATE_MAX_101 = 2,
105 CEC_AUDIO_RATE_SLOW_RATE_MIN_99 = 3,
106 CEC_AUDIO_RATE_STANDARD_RATE_100_0 = 4,
107 CEC_AUDIO_RATE_FAST_RATE_MAX_100_1 = 5,
108 CEC_AUDIO_RATE_SLOW_RATE_MIN_99_9 = 6
109 } cec_audio_rate;
110
111 typedef enum cec_audio_status
112 {
113 CEC_AUDIO_MUTE_STATUS_MASK = 0x80,
114 CEC_AUDIO_VOLUME_STATUS_MASK = 0x7F,
115 CEC_AUDIO_VOLUME_MIN = 0x00,
116 CEC_AUDIO_VOLUME_MAX = 0x64,
117 CEC_AUDIO_VOLUME_STATUS_UNKNOWN = 0x7F
118 } cec_audio_status;
119
120 typedef enum cec_boolean
121 {
122 CEC_FALSE = 0,
123 CEC_TRUE = 1
124 } cec_boolean;
125
126 typedef enum cec_version
127 {
128 CEC_VERSION_UNKNOWN = 0x00,
129 CEC_VERSION_1_2 = 0x01,
130 CEC_VERSION_1_2A = 0x02,
131 CEC_VERSION_1_3 = 0x03,
132 CEC_VERSION_1_3A = 0x04,
133 CEC_VERSION_1_4 = 0x05
134 } cec_version;
135
136 typedef enum cec_channel_identifier
137 {
138 CEC_CHANNEL_NUMBER_FORMAT_MASK = 0xFC000000,
139 CEC_1_PART_CHANNEL_NUMBER = 0x04000000,
140 CEC_2_PART_CHANNEL_NUMBER = 0x08000000,
141 CEC_MAJOR_CHANNEL_NUMBER_MASK = 0x3FF0000,
142 CEC_MINOR_CHANNEL_NUMBER_MASK = 0xFFFF
143 } cec_channel_identifier;
144
145 typedef enum cec_deck_control_mode
146 {
147 CEC_DECK_CONTROL_MODE_SKIP_FORWARD_WIND = 1,
148 CEC_DECK_CONTROL_MODE_SKIP_REVERSE_REWIND = 2,
149 CEC_DECK_CONTROL_MODE_STOP = 3,
150 CEC_DECK_CONTROL_MODE_EJECT = 4
151 } cec_deck_control_mode;
152
153 typedef enum cec_deck_info
154 {
155 CEC_DECK_INFO_PLAY = 0x11,
156 CEC_DECK_INFO_RECORD = 0x12,
157 CEC_DECK_INFO_PLAY_REVERSE = 0x13,
158 CEC_DECK_INFO_STILL = 0x14,
159 CEC_DECK_INFO_SLOW = 0x15,
160 CEC_DECK_INFO_SLOW_REVERSE = 0x16,
161 CEC_DECK_INFO_FAST_FORWARD = 0x17,
162 CEC_DECK_INFO_FAST_REVERSE = 0x18,
163 CEC_DECK_INFO_NO_MEDIA = 0x19,
164 CEC_DECK_INFO_STOP = 0x1A,
165 CEC_DECK_INFO_SKIP_FORWARD_WIND = 0x1B,
166 CEC_DECK_INFO_SKIP_REVERSE_REWIND = 0x1C,
167 CEC_DECK_INFO_INDEX_SEARCH_FORWARD = 0x1D,
168 CEC_DECK_INFO_INDEX_SEARCH_REVERSE = 0x1E,
169 CEC_DECK_INFO_OTHER_STATUS = 0x1F,
170 CEC_DECK_INFO_OTHER_STATUS_LG = 0x20
171 } cec_deck_info;
172
173 typedef enum cec_device_type
174 {
175 CEC_DEVICE_TYPE_TV = 0,
176 CEC_DEVICE_TYPE_RECORDING_DEVICE = 1,
177 CEC_DEVICE_TYPE_RESERVED = 2,
178 CEC_DEVICE_TYPE_TUNER = 3,
179 CEC_DEVICE_TYPE_PLAYBACK_DEVICE = 4,
180 CEC_DEVICE_TYPE_AUDIO_SYSTEM = 5
181 } cec_device_type;
182
183 typedef enum cec_display_control
184 {
185 CEC_DISPLAY_CONTROL_DISPLAY_FOR_DEFAULT_TIME = 0x00,
186 CEC_DISPLAY_CONTROL_DISPLAY_UNTIL_CLEARED = 0x40,
187 CEC_DISPLAY_CONTROL_CLEAR_PREVIOUS_MESSAGE = 0x80,
188 CEC_DISPLAY_CONTROL_RESERVED_FOR_FUTURE_USE = 0xC0
189 } cec_display_control;
190
191 typedef enum cec_external_source_specifier
192 {
193 CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PLUG = 4,
194 CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PHYSICAL_ADDRESS = 5
195 } cec_external_source_specifier;
196
197 typedef enum cec_menu_request_type
198 {
199 CEC_MENU_REQUEST_TYPE_ACTIVATE = 0,
200 CEC_MENU_REQUEST_TYPE_DEACTIVATE = 1,
201 CEC_MENU_REQUEST_TYPE_QUERY = 2
202 } cec_menu_request_type;
203
204 typedef enum cec_menu_state
205 {
206 CEC_MENU_STATE_ACTIVATED = 0,
207 CEC_MENU_STATE_DEACTIVATED = 1
208 } cec_menu_state;
209
210 typedef enum cec_play_mode
211 {
212 CEC_PLAY_MODE_PLAY_FORWARD = 0x24,
213 CEC_PLAY_MODE_PLAY_REVERSE = 0x20,
214 CEC_PLAY_MODE_PLAY_STILL = 0x25,
215 CEC_PLAY_MODE_FAST_FORWARD_MIN_SPEED = 0x05,
216 CEC_PLAY_MODE_FAST_FORWARD_MEDIUM_SPEED = 0x06,
217 CEC_PLAY_MODE_FAST_FORWARD_MAX_SPEED = 0x07,
218 CEC_PLAY_MODE_FAST_REVERSE_MIN_SPEED = 0x09,
219 CEC_PLAY_MODE_FAST_REVERSE_MEDIUM_SPEED = 0x0A,
220 CEC_PLAY_MODE_FAST_REVERSE_MAX_SPEED = 0x0B,
221 CEC_PLAY_MODE_SLOW_FORWARD_MIN_SPEED = 0x15,
222 CEC_PLAY_MODE_SLOW_FORWARD_MEDIUM_SPEED = 0x16,
223 CEC_PLAY_MODE_SLOW_FORWARD_MAX_SPEED = 0x17,
224 CEC_PLAY_MODE_SLOW_REVERSE_MIN_SPEED = 0x19,
225 CEC_PLAY_MODE_SLOW_REVERSE_MEDIUM_SPEED = 0x1A,
226 CEC_PLAY_MODE_SLOW_REVERSE_MAX_SPEED = 0x1B
227 } cec_play_mode;
228
229 typedef enum cec_power_status
230 {
231 CEC_POWER_STATUS_ON = 0x00,
232 CEC_POWER_STATUS_STANDBY = 0x01,
233 CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON = 0x02,
234 CEC_POWER_STATUS_IN_TRANSITION_ON_TO_STANDBY = 0x03,
235 CEC_POWER_STATUS_UNKNOWN = 0x99
236 } cec_power_status;
237
238 typedef enum cec_record_source_type
239 {
240 CEC_RECORD_SOURCE_TYPE_OWN_SOURCE = 1,
241 CEC_RECORD_SOURCE_TYPE_DIGITAL_SERVICE = 2,
242 CEC_RECORD_SOURCE_TYPE_ANALOGUE_SERVICE = 3,
243 CEC_RECORD_SOURCE_TYPE_EXTERNAL_PLUS = 4,
244 CEC_RECORD_SOURCE_TYPE_EXTERNAL_PHYSICAL_ADDRESS = 5
245 } cec_record_source_type;
246
247 typedef enum cec_record_status_info
248 {
249 CEC_RECORD_STATUS_INFO_RECORDING_CURRENTLY_SELECTED_SOURCE = 0x01,
250 CEC_RECORD_STATUS_INFO_RECORDING_DIGITAL_SERVICE = 0x02,
251 CEC_RECORD_STATUS_INFO_RECORDING_ANALOGUE_SERVICE = 0x03,
252 CEC_RECORD_STATUS_INFO_RECORDING_EXTERNAL_INPUT = 0x04,
253 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_DIGITAL_SERVICE = 0x05,
254 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_ANALOGUE_SERVICE = 0x06,
255 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_SELECT_REQUIRED_SERVICE = 0x07,
256 CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_PLUG_NUMBER = 0x09,
257 CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_ADDRESS = 0x0A,
258 CEC_RECORD_STATUS_INFO_NO_RECORDING_CA_SYSTEM_NOT_SUPPORTED = 0x0B,
259 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_OR_INSUFFICIENT_ENTITLEMENTS = 0x0C,
260 CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ALLOWED_TO_COPY_SOURCE = 0x0D,
261 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_FURTHER_COPIES_ALLOWED = 0x0E,
262 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_MEDIA = 0x10,
263 CEC_RECORD_STATUS_INFO_NO_RECORDING_PLAYING = 0x11,
264 CEC_RECORD_STATUS_INFO_NO_RECORDING_ALREADY_RECORDING = 0x12,
265 CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROTECTED = 0x13,
266 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_SOURCE_SIGNAL = 0x14,
267 CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROBLEM = 0x15,
268 CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ENOUGH_SPACE_AVAILABLE = 0x16,
269 CEC_RECORD_STATUS_INFO_NO_RECORDING_PARENTAL_LOCK_ON = 0x17,
270 CEC_RECORD_STATUS_INFO_RECORDING_TERMINATED_NORMALLY = 0x1A,
271 CEC_RECORD_STATUS_INFO_RECORDING_HAS_ALREADY_TERMINATED = 0x1B,
272 CEC_RECORD_STATUS_INFO_NO_RECORDING_OTHER_REASON = 0x1F
273 } cec_record_status_info;
274
275 typedef enum cec_recording_sequence
276 {
277 CEC_RECORDING_SEQUENCE_SUNDAY = 0x01,
278 CEC_RECORDING_SEQUENCE_MONDAY = 0x02,
279 CEC_RECORDING_SEQUENCE_TUESDAY = 0x04,
280 CEC_RECORDING_SEQUENCE_WEDNESDAY = 0x08,
281 CEC_RECORDING_SEQUENCE_THURSDAY = 0x10,
282 CEC_RECORDING_SEQUENCE_FRIDAY = 0x20,
283 CEC_RECORDING_SEQUENCE_SATURDAY = 0x40,
284 CEC_RECORDING_SEQUENCE_ONCE_ONLY = 0x00
285 } cec_recording_sequence;
286
287 typedef enum cec_status_request
288 {
289 CEC_STATUS_REQUEST_ON = 1,
290 CEC_STATUS_REQUEST_OFF = 2,
291 CEC_STATUS_REQUEST_ONCE = 3
292 } cec_status_request;
293
294 typedef enum cec_system_audio_status
295 {
296 CEC_SYSTEM_AUDIO_STATUS_OFF = 0,
297 CEC_SYSTEM_AUDIO_STATUS_ON = 1
298 } cec_system_audio_status;
299
300 typedef enum cec_timer_cleared_status_data
301 {
302 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_RECORDING = 0x00,
303 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_MATCHING = 0x01,
304 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_INF0_AVAILABLE = 0x02,
305 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_CLEARED = 0x80
306 } cec_timer_cleared_status_data;
307
308 typedef enum cec_timer_overlap_warning
309 {
310 CEC_TIMER_OVERLAP_WARNING_NO_OVERLAP = 0,
311 CEC_TIMER_OVERLAP_WARNING_TIMER_BLOCKS_OVERLAP = 1
312 } cec_timer_overlap_warning;
313
314 typedef enum cec_media_info
315 {
316 CEC_MEDIA_INFO_MEDIA_PRESENT_AND_NOT_PROTECTED = 0x00,
317 CEC_MEDIA_INFO_MEDIA_PRESENT_BUT_PROTECTED = 0x01,
318 CEC_MEDIA_INFO_MEDIA_NOT_PRESENT = 0x02,
319 CEC_MEDIA_INFO_FUTURE_USE = 0x03
320 } cec_media_info;
321
322 typedef enum cec_programmed_indicator
323 {
324 CEC_PROGRAMMED_INDICATOR_NOT_PROGRAMMED = 0,
325 CEC_PROGRAMMED_INDICATOR_PROGRAMMED = 1
326 } cec_programmed_indicator;
327
328 typedef enum cec_programmed_info
329 {
330 CEC_PROGRAMMED_INFO_FUTURE_USE = 0x0,
331 CEC_PROGRAMMED_INFO_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING = 0x08,
332 CEC_PROGRAMMED_INFO_NOT_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING = 0x09,
333 CEC_PROGRAMMED_INFO_MAY_NOT_BE_ENOUGH_SPACE_AVAILABLE = 0x0B,
334 CEC_PROGRAMMED_INFO_NO_MEDIA_INFO_AVAILABLE = 0x0A
335 } cec_programmed_info;
336
337 typedef enum cec_not_programmed_error_info
338 {
339 CEC_NOT_PROGRAMMED_ERROR_INFO_FUTURE_USE = 0x0,
340 CEC_NOT_PROGRAMMED_ERROR_INFO_NO_FREE_TIMER_AVAILABLE = 0x01,
341 CEC_NOT_PROGRAMMED_ERROR_INFO_DATE_OUT_OF_RANGE = 0x02,
342 CEC_NOT_PROGRAMMED_ERROR_INFO_RECORDING_SEQUENCE_ERROR = 0x03,
343 CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PLUG_NUMBER = 0x04,
344 CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PHYSICAL_ADDRESS = 0x05,
345 CEC_NOT_PROGRAMMED_ERROR_INFO_CA_SYSTEM_NOT_SUPPORTED = 0x06,
346 CEC_NOT_PROGRAMMED_ERROR_INFO_NO_OR_INSUFFICIENT_CA_ENTITLEMENTS = 0x07,
347 CEC_NOT_PROGRAMMED_ERROR_INFO_DOES_NOT_SUPPORT_RESOLUTION = 0x08,
348 CEC_NOT_PROGRAMMED_ERROR_INFO_PARENTAL_LOCK_ON = 0x09,
349 CEC_NOT_PROGRAMMED_ERROR_INFO_CLOCK_FAILURE = 0x0A,
350 CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_START = 0x0B,
351 CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_END = 0x0D,
352 CEC_NOT_PROGRAMMED_ERROR_INFO_DUPLICATE_ALREADY_PROGRAMMED = 0x0E
353 } cec_not_programmed_error_info;
354
355 typedef enum cec_recording_flag
356 {
357 CEC_RECORDING_FLAG_NOT_BEING_USED_FOR_RECORDING = 0,
358 CEC_RECORDING_FLAG_BEING_USED_FOR_RECORDING = 1
359 } cec_recording_flag;
360
361 typedef enum cec_tuner_display_info
362 {
363 CEC_TUNER_DISPLAY_INFO_DISPLAYING_DIGITAL_TUNER = 0,
364 CEC_TUNER_DISPLAY_INFO_NOT_DISPLAYING_TUNER = 1,
365 CEC_TUNER_DISPLAY_INFO_DISPLAYING_ANALOGUE_TUNER = 2
366 } cec_tuner_display_info;
367
368 typedef enum cec_broadcast_system
369 {
370 CEC_BROADCAST_SYSTEM_PAL_B_G = 0,
371 CEC_BROADCAST_SYSTEM_SECAM_L1 = 1,
372 CEC_BROADCAST_SYSTEM_PAL_M = 2,
373 CEC_BROADCAST_SYSTEM_NTSC_M = 3,
374 CEC_BROADCAST_SYSTEM_PAL_I = 4,
375 CEC_BROADCAST_SYSTEM_SECAM_DK = 5,
376 CEC_BROADCAST_SYSTEM_SECAM_B_G = 6,
377 CEC_BROADCAST_SYSTEM_SECAM_L2 = 7,
378 CEC_BROADCAST_SYSTEM_PAL_DK = 8,
379 CEC_BROADCAST_SYSTEM_OTHER_SYSTEM = 30
380 } cec_broadcast_system;
381
382 typedef enum cec_user_control_code
383 {
384 CEC_USER_CONTROL_CODE_SELECT = 0x00,
385 CEC_USER_CONTROL_CODE_UP = 0x01,
386 CEC_USER_CONTROL_CODE_DOWN = 0x02,
387 CEC_USER_CONTROL_CODE_LEFT = 0x03,
388 CEC_USER_CONTROL_CODE_RIGHT = 0x04,
389 CEC_USER_CONTROL_CODE_RIGHT_UP = 0x05,
390 CEC_USER_CONTROL_CODE_RIGHT_DOWN = 0x06,
391 CEC_USER_CONTROL_CODE_LEFT_UP = 0x07,
392 CEC_USER_CONTROL_CODE_LEFT_DOWN = 0x08,
393 CEC_USER_CONTROL_CODE_ROOT_MENU = 0x09,
394 CEC_USER_CONTROL_CODE_SETUP_MENU = 0x0A,
395 CEC_USER_CONTROL_CODE_CONTENTS_MENU = 0x0B,
396 CEC_USER_CONTROL_CODE_FAVORITE_MENU = 0x0C,
397 CEC_USER_CONTROL_CODE_EXIT = 0x0D,
398 CEC_USER_CONTROL_CODE_NUMBER0 = 0x20,
399 CEC_USER_CONTROL_CODE_NUMBER1 = 0x21,
400 CEC_USER_CONTROL_CODE_NUMBER2 = 0x22,
401 CEC_USER_CONTROL_CODE_NUMBER3 = 0x23,
402 CEC_USER_CONTROL_CODE_NUMBER4 = 0x24,
403 CEC_USER_CONTROL_CODE_NUMBER5 = 0x25,
404 CEC_USER_CONTROL_CODE_NUMBER6 = 0x26,
405 CEC_USER_CONTROL_CODE_NUMBER7 = 0x27,
406 CEC_USER_CONTROL_CODE_NUMBER8 = 0x28,
407 CEC_USER_CONTROL_CODE_NUMBER9 = 0x29,
408 CEC_USER_CONTROL_CODE_DOT = 0x2A,
409 CEC_USER_CONTROL_CODE_ENTER = 0x2B,
410 CEC_USER_CONTROL_CODE_CLEAR = 0x2C,
411 CEC_USER_CONTROL_CODE_NEXT_FAVORITE = 0x2F,
412 CEC_USER_CONTROL_CODE_CHANNEL_UP = 0x30,
413 CEC_USER_CONTROL_CODE_CHANNEL_DOWN = 0x31,
414 CEC_USER_CONTROL_CODE_PREVIOUS_CHANNEL = 0x32,
415 CEC_USER_CONTROL_CODE_SOUND_SELECT = 0x33,
416 CEC_USER_CONTROL_CODE_INPUT_SELECT = 0x34,
417 CEC_USER_CONTROL_CODE_DISPLAY_INFORMATION = 0x35,
418 CEC_USER_CONTROL_CODE_HELP = 0x36,
419 CEC_USER_CONTROL_CODE_PAGE_UP = 0x37,
420 CEC_USER_CONTROL_CODE_PAGE_DOWN = 0x38,
421 CEC_USER_CONTROL_CODE_POWER = 0x40,
422 CEC_USER_CONTROL_CODE_VOLUME_UP = 0x41,
423 CEC_USER_CONTROL_CODE_VOLUME_DOWN = 0x42,
424 CEC_USER_CONTROL_CODE_MUTE = 0x43,
425 CEC_USER_CONTROL_CODE_PLAY = 0x44,
426 CEC_USER_CONTROL_CODE_STOP = 0x45,
427 CEC_USER_CONTROL_CODE_PAUSE = 0x46,
428 CEC_USER_CONTROL_CODE_RECORD = 0x47,
429 CEC_USER_CONTROL_CODE_REWIND = 0x48,
430 CEC_USER_CONTROL_CODE_FAST_FORWARD = 0x49,
431 CEC_USER_CONTROL_CODE_EJECT = 0x4A,
432 CEC_USER_CONTROL_CODE_FORWARD = 0x4B,
433 CEC_USER_CONTROL_CODE_BACKWARD = 0x4C,
434 CEC_USER_CONTROL_CODE_STOP_RECORD = 0x4D,
435 CEC_USER_CONTROL_CODE_PAUSE_RECORD = 0x4E,
436 CEC_USER_CONTROL_CODE_ANGLE = 0x50,
437 CEC_USER_CONTROL_CODE_SUB_PICTURE = 0x51,
438 CEC_USER_CONTROL_CODE_VIDEO_ON_DEMAND = 0x52,
439 CEC_USER_CONTROL_CODE_ELECTRONIC_PROGRAM_GUIDE = 0x53,
440 CEC_USER_CONTROL_CODE_TIMER_PROGRAMMING = 0x54,
441 CEC_USER_CONTROL_CODE_INITIAL_CONFIGURATION = 0x55,
442 CEC_USER_CONTROL_CODE_PLAY_FUNCTION = 0x60,
443 CEC_USER_CONTROL_CODE_PAUSE_PLAY_FUNCTION = 0x61,
444 CEC_USER_CONTROL_CODE_RECORD_FUNCTION = 0x62,
445 CEC_USER_CONTROL_CODE_PAUSE_RECORD_FUNCTION = 0x63,
446 CEC_USER_CONTROL_CODE_STOP_FUNCTION = 0x64,
447 CEC_USER_CONTROL_CODE_MUTE_FUNCTION = 0x65,
448 CEC_USER_CONTROL_CODE_RESTORE_VOLUME_FUNCTION = 0x66,
449 CEC_USER_CONTROL_CODE_TUNE_FUNCTION = 0x67,
450 CEC_USER_CONTROL_CODE_SELECT_MEDIA_FUNCTION = 0x68,
451 CEC_USER_CONTROL_CODE_SELECT_AV_INPUT_FUNCTION = 0x69,
452 CEC_USER_CONTROL_CODE_SELECT_AUDIO_INPUT_FUNCTION = 0x6A,
453 CEC_USER_CONTROL_CODE_POWER_TOGGLE_FUNCTION = 0x6B,
454 CEC_USER_CONTROL_CODE_POWER_OFF_FUNCTION = 0x6C,
455 CEC_USER_CONTROL_CODE_POWER_ON_FUNCTION = 0x6D,
456 CEC_USER_CONTROL_CODE_F1_BLUE = 0x71,
457 CEC_USER_CONTROL_CODE_F2_RED = 0X72,
458 CEC_USER_CONTROL_CODE_F3_GREEN = 0x73,
459 CEC_USER_CONTROL_CODE_F4_YELLOW = 0x74,
460 CEC_USER_CONTROL_CODE_F5 = 0x75,
461 CEC_USER_CONTROL_CODE_DATA = 0x76,
462 CEC_USER_CONTROL_CODE_MAX = 0x76,
463 CEC_USER_CONTROL_CODE_UNKNOWN
464 } cec_user_control_code;
465
466 typedef enum cec_an_user_control_code
467 {
468 CEC_AN_USER_CONTROL_CODE_RETURN = 0x91
469 } cec_an_user_control_code;
470
471 typedef enum cec_logical_address
472 {
473 CECDEVICE_UNKNOWN = -1, //not a valid logical address
474 CECDEVICE_TV = 0,
475 CECDEVICE_RECORDINGDEVICE1 = 1,
476 CECDEVICE_RECORDINGDEVICE2 = 2,
477 CECDEVICE_TUNER1 = 3,
478 CECDEVICE_PLAYBACKDEVICE1 = 4,
479 CECDEVICE_AUDIOSYSTEM = 5,
480 CECDEVICE_TUNER2 = 6,
481 CECDEVICE_TUNER3 = 7,
482 CECDEVICE_PLAYBACKDEVICE2 = 8,
483 CECDEVICE_RECORDINGDEVICE3 = 9,
484 CECDEVICE_TUNER4 = 10,
485 CECDEVICE_PLAYBACKDEVICE3 = 11,
486 CECDEVICE_RESERVED1 = 12,
487 CECDEVICE_RESERVED2 = 13,
488 CECDEVICE_FREEUSE = 14,
489 CECDEVICE_UNREGISTERED = 15,
490 CECDEVICE_BROADCAST = 15
491 } cec_logical_address;
492
493 typedef enum cec_opcode
494 {
495 CEC_OPCODE_ACTIVE_SOURCE = 0x82,
496 CEC_OPCODE_IMAGE_VIEW_ON = 0x04,
497 CEC_OPCODE_TEXT_VIEW_ON = 0x0D,
498 CEC_OPCODE_INACTIVE_SOURCE = 0x9D,
499 CEC_OPCODE_REQUEST_ACTIVE_SOURCE = 0x85,
500 CEC_OPCODE_ROUTING_CHANGE = 0x80,
501 CEC_OPCODE_ROUTING_INFORMATION = 0x81,
502 CEC_OPCODE_SET_STREAM_PATH = 0x86,
503 CEC_OPCODE_STANDBY = 0x36,
504 CEC_OPCODE_RECORD_OFF = 0x0B,
505 CEC_OPCODE_RECORD_ON = 0x09,
506 CEC_OPCODE_RECORD_STATUS = 0x0A,
507 CEC_OPCODE_RECORD_TV_SCREEN = 0x0F,
508 CEC_OPCODE_CLEAR_ANALOGUE_TIMER = 0x33,
509 CEC_OPCODE_CLEAR_DIGITAL_TIMER = 0x99,
510 CEC_OPCODE_CLEAR_EXTERNAL_TIMER = 0xA1,
511 CEC_OPCODE_SET_ANALOGUE_TIMER = 0x34,
512 CEC_OPCODE_SET_DIGITAL_TIMER = 0x97,
513 CEC_OPCODE_SET_EXTERNAL_TIMER = 0xA2,
514 CEC_OPCODE_SET_TIMER_PROGRAM_TITLE = 0x67,
515 CEC_OPCODE_TIMER_CLEARED_STATUS = 0x43,
516 CEC_OPCODE_TIMER_STATUS = 0x35,
517 CEC_OPCODE_CEC_VERSION = 0x9E,
518 CEC_OPCODE_GET_CEC_VERSION = 0x9F,
519 CEC_OPCODE_GIVE_PHYSICAL_ADDRESS = 0x83,
520 CEC_OPCODE_GET_MENU_LANGUAGE = 0x91,
521 CEC_OPCODE_REPORT_PHYSICAL_ADDRESS = 0x84,
522 CEC_OPCODE_SET_MENU_LANGUAGE = 0x32,
523 CEC_OPCODE_DECK_CONTROL = 0x42,
524 CEC_OPCODE_DECK_STATUS = 0x1B,
525 CEC_OPCODE_GIVE_DECK_STATUS = 0x1A,
526 CEC_OPCODE_PLAY = 0x41,
527 CEC_OPCODE_GIVE_TUNER_DEVICE_STATUS = 0x08,
528 CEC_OPCODE_SELECT_ANALOGUE_SERVICE = 0x92,
529 CEC_OPCODE_SELECT_DIGITAL_SERVICE = 0x93,
530 CEC_OPCODE_TUNER_DEVICE_STATUS = 0x07,
531 CEC_OPCODE_TUNER_STEP_DECREMENT = 0x06,
532 CEC_OPCODE_TUNER_STEP_INCREMENT = 0x05,
533 CEC_OPCODE_DEVICE_VENDOR_ID = 0x87,
534 CEC_OPCODE_GIVE_DEVICE_VENDOR_ID = 0x8C,
535 CEC_OPCODE_VENDOR_COMMAND = 0x89,
536 CEC_OPCODE_VENDOR_COMMAND_WITH_ID = 0xA0,
537 CEC_OPCODE_VENDOR_REMOTE_BUTTON_DOWN = 0x8A,
538 CEC_OPCODE_VENDOR_REMOTE_BUTTON_UP = 0x8B,
539 CEC_OPCODE_SET_OSD_STRING = 0x64,
540 CEC_OPCODE_GIVE_OSD_NAME = 0x46,
541 CEC_OPCODE_SET_OSD_NAME = 0x47,
542 CEC_OPCODE_MENU_REQUEST = 0x8D,
543 CEC_OPCODE_MENU_STATUS = 0x8E,
544 CEC_OPCODE_USER_CONTROL_PRESSED = 0x44,
545 CEC_OPCODE_USER_CONTROL_RELEASE = 0x45,
546 CEC_OPCODE_GIVE_DEVICE_POWER_STATUS = 0x8F,
547 CEC_OPCODE_REPORT_POWER_STATUS = 0x90,
548 CEC_OPCODE_FEATURE_ABORT = 0x00,
549 CEC_OPCODE_ABORT = 0xFF,
550 CEC_OPCODE_GIVE_AUDIO_STATUS = 0x71,
551 CEC_OPCODE_GIVE_SYSTEM_AUDIO_MODE_STATUS = 0x7D,
552 CEC_OPCODE_REPORT_AUDIO_STATUS = 0x7A,
553 CEC_OPCODE_SET_SYSTEM_AUDIO_MODE = 0x72,
554 CEC_OPCODE_SYSTEM_AUDIO_MODE_REQUEST = 0x70,
555 CEC_OPCODE_SYSTEM_AUDIO_MODE_STATUS = 0x7E,
556 CEC_OPCODE_SET_AUDIO_RATE = 0x9A,
557 /* when this opcode is set, no opcode will be sent to the device. this is one of the reserved numbers */
558 CEC_OPCODE_NONE = 0xFD
559 } cec_opcode;
560
561 typedef enum cec_log_level
562 {
563 CEC_LOG_ERROR = 1,
564 CEC_LOG_WARNING = 2,
565 CEC_LOG_NOTICE = 4,
566 CEC_LOG_TRAFFIC = 8,
567 CEC_LOG_DEBUG = 16,
568 CEC_LOG_ALL = 31
569 } cec_log_level;
570
571 typedef enum cec_adapter_messagecode
572 {
573 MSGCODE_NOTHING = 0,
574 MSGCODE_PING,
575 MSGCODE_TIMEOUT_ERROR,
576 MSGCODE_HIGH_ERROR,
577 MSGCODE_LOW_ERROR,
578 MSGCODE_FRAME_START,
579 MSGCODE_FRAME_DATA,
580 MSGCODE_RECEIVE_FAILED,
581 MSGCODE_COMMAND_ACCEPTED,
582 MSGCODE_COMMAND_REJECTED,
583 MSGCODE_SET_ACK_MASK,
584 MSGCODE_TRANSMIT,
585 MSGCODE_TRANSMIT_EOM,
586 MSGCODE_TRANSMIT_IDLETIME,
587 MSGCODE_TRANSMIT_ACK_POLARITY,
588 MSGCODE_TRANSMIT_LINE_TIMEOUT,
589 MSGCODE_TRANSMIT_SUCCEEDED,
590 MSGCODE_TRANSMIT_FAILED_LINE,
591 MSGCODE_TRANSMIT_FAILED_ACK,
592 MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA,
593 MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE,
594 MSGCODE_FIRMWARE_VERSION,
595 MSGCODE_START_BOOTLOADER,
596 MSGCODE_FRAME_EOM = 0x80,
597 MSGCODE_FRAME_ACK = 0x40,
598 } cec_adapter_messagecode;
599
600 typedef enum cec_bus_device_status
601 {
602 CEC_DEVICE_STATUS_UNKNOWN,
603 CEC_DEVICE_STATUS_PRESENT,
604 CEC_DEVICE_STATUS_NOT_PRESENT,
605 CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC
606 } cec_bus_device_status;
607
608 typedef enum cec_vendor_id
609 {
610 CEC_VENDOR_SAMSUNG = 0x0000F0,
611 CEC_VENDOR_LG = 0x00E091,
612 CEC_VENDOR_PANASONIC = 0x008045,
613 CEC_VENDOR_PIONEER = 0x00E036,
614 CEC_VENDOR_ONKYO = 0x0009B0,
615 CEC_VENDOR_YAMAHA = 0x00A0DE,
616 CEC_VENDOR_PHILIPS = 0x00903E,
617 CEC_VENDOR_SONY = 0x080046,
618 CEC_VENDOR_UNKNOWN = 0
619 } cec_vendor_id;
620
621 typedef struct cec_menu_language
622 {
623 char language[4];
624 cec_logical_address device;
625 } cec_menu_language;
626
627 typedef struct cec_osd_name
628 {
629 char name[14];
630 cec_logical_address device;
631 } cec_osd_name;
632
633 typedef struct cec_log_message
634 {
635 char message[1024];
636 cec_log_level level;
637 int64_t time;
638 } cec_log_message;
639
640 typedef struct cec_keypress
641 {
642 cec_user_control_code keycode;
643 unsigned int duration;
644 } cec_keypress;
645
646 typedef struct cec_adapter
647 {
648 char path[1024];
649 char comm[1024];
650 } cec_adapter;
651
652 typedef struct cec_datapacket
653 {
654 uint8_t data[100];
655 uint8_t size;
656
657 #ifdef __cplusplus
658 cec_datapacket &operator =(const struct cec_datapacket &packet)
659 {
660 Clear();
661 for (uint8_t iPtr = 0; iPtr < packet.size; iPtr++)
662 PushBack(packet[iPtr]);
663
664 return *this;
665 }
666
667 bool IsEmpty(void) const { return size == 0; }
668 bool IsFull(void) const { return size == 100; }
669 uint8_t operator[](uint8_t pos) const { return pos < size ? data[pos] : 0; }
670 uint8_t At(uint8_t pos) const { return pos < size ? data[pos] : 0; }
671
672 void Shift(uint8_t iShiftBy)
673 {
674 if (iShiftBy >= size)
675 {
676 Clear();
677 }
678 else
679 {
680 for (uint8_t iPtr = 0; iPtr < size; iPtr++)
681 data[iPtr] = (iPtr + iShiftBy < size) ? data[iPtr + iShiftBy] : 0;
682 size = (uint8_t) (size - iShiftBy);
683 }
684 }
685
686 void PushBack(uint8_t add)
687 {
688 if (size < 100)
689 data[size++] = add;
690 }
691
692 void Clear(void)
693 {
694 memset(data, 0, sizeof(data));
695 size = 0;
696 }
697 #endif
698
699 } cec_datapacket;
700
701 typedef struct cec_command
702 {
703 cec_logical_address initiator;
704 cec_logical_address destination;
705 int8_t ack;
706 int8_t eom;
707 cec_opcode opcode;
708 cec_datapacket parameters;
709 int8_t opcode_set;
710 int32_t transmit_timeout;
711
712 #ifdef __cplusplus
713 cec_command &operator =(const struct cec_command &command)
714 {
715 initiator = command.initiator;
716 destination = command.destination;
717 ack = command.ack;
718 eom = command.eom;
719 opcode = command.opcode;
720 opcode_set = command.opcode_set;
721 transmit_timeout = command.transmit_timeout;
722 parameters = command.parameters;
723
724 return *this;
725 }
726
727 static void Format(cec_command &command, cec_logical_address initiator, cec_logical_address destination, cec_opcode opcode, int32_t timeout = CEC_DEFAULT_TRANSMIT_TIMEOUT)
728 {
729 command.Clear();
730 command.initiator = initiator;
731 command.destination = destination;
732 command.transmit_timeout = timeout;
733 if (opcode != CEC_OPCODE_NONE)
734 {
735 command.opcode = opcode;
736 command.opcode_set = 1;
737 }
738 }
739
740 void PushBack(uint8_t data)
741 {
742 if (initiator == CECDEVICE_UNKNOWN && destination == CECDEVICE_UNKNOWN)
743 {
744 initiator = (cec_logical_address) (data >> 4);
745 destination = (cec_logical_address) (data & 0xF);
746 }
747 else if (!opcode_set)
748 {
749 opcode_set = 1;
750 opcode = (cec_opcode) data;
751 }
752 else
753 parameters.PushBack(data);
754 }
755
756 void Clear(void)
757 {
758 initiator = CECDEVICE_UNKNOWN;
759 destination = CECDEVICE_UNKNOWN;
760 ack = 0;
761 eom = 0;
762 opcode_set = 0;
763 opcode = CEC_OPCODE_FEATURE_ABORT;
764 transmit_timeout = CEC_DEFAULT_TRANSMIT_TIMEOUT;
765 parameters.Clear();
766 };
767 #endif
768 } cec_command;
769
770 typedef struct cec_device_type_list
771 {
772 cec_device_type types[5];
773
774 #ifdef __cplusplus
775 /*!
776 * @deprecated
777 */
778 void clear(void) { Clear(); }
779 /*!
780 * @deprecated
781 */
782 void add(const cec_device_type type) { Add(type); }
783
784 void Clear(void)
785 {
786 for (unsigned int iPtr = 0; iPtr < 5; iPtr++)
787 types[iPtr] = CEC_DEVICE_TYPE_RESERVED;
788 }
789
790 void Add(const cec_device_type type)
791 {
792 for (unsigned int iPtr = 0; iPtr < 5; iPtr++)
793 {
794 if (types[iPtr] == CEC_DEVICE_TYPE_RESERVED)
795 {
796 types[iPtr] = type;
797 break;
798 }
799 }
800 }
801
802 bool IsSet(cec_device_type type)
803 {
804 bool bReturn(false);
805 for (unsigned int iPtr = 0; !bReturn && iPtr < 5; iPtr++)
806 {
807 if (types[iPtr] == type)
808 bReturn = true;
809 }
810 return bReturn;
811 }
812
813 bool IsEmpty()
814 {
815 bool bReturn(true);
816 for (unsigned int iPtr = 0; bReturn && iPtr < 5; iPtr++)
817 {
818 if (types[iPtr] != CEC_DEVICE_TYPE_RESERVED)
819 bReturn = false;
820 }
821 return bReturn;
822 }
823
824 cec_device_type operator[](uint8_t pos) const { return pos < 5 ? types[pos] : CEC_DEVICE_TYPE_RESERVED; }
825 #endif
826 } cec_device_type_list;
827
828 typedef struct cec_logical_addresses
829 {
830 cec_logical_address primary;
831 int addresses[16];
832
833 #ifdef __cplusplus
834 void Clear(void)
835 {
836 primary = CECDEVICE_UNKNOWN;
837 for (unsigned int iPtr = 0; iPtr < 16; iPtr++)
838 addresses[iPtr] = 0;
839 }
840
841 bool IsEmpty(void) const
842 {
843 return primary == CECDEVICE_UNKNOWN;
844 }
845
846 uint16_t AckMask(void) const
847 {
848 uint16_t mask = 0;
849 for (unsigned int iPtr = 0; iPtr < 16; iPtr++)
850 if (addresses[iPtr] == 1)
851 mask |= 0x1 << iPtr;
852 return mask;
853 }
854
855 void Set(cec_logical_address address)
856 {
857 if (primary == CECDEVICE_UNKNOWN)
858 primary = address;
859
860 addresses[(int) address] = 1;
861 }
862
863 void Unset(cec_logical_address address)
864 {
865 if (primary == address)
866 primary = CECDEVICE_UNKNOWN;
867
868 addresses[(int) address] = 0;
869 }
870
871 bool IsSet(cec_logical_address address) const { return addresses[(int) address] == 1; }
872 bool operator[](uint8_t pos) const { return pos < 16 ? IsSet((cec_logical_address) pos) : false; }
873 #endif
874 } cec_logical_addresses;
875
876
877 typedef int (CDECL* CBCecLogMessageType)(void *param, const CEC::cec_log_message &);
878 typedef int (CDECL* CBCecKeyPressType)(void *param, const cec_keypress &key);
879 typedef int (CDECL* CBCecCommandType)(void *param, const cec_command &command);
880
881 typedef struct ICECCallbacks
882 {
883 /*!
884 * @brief Transfer a log message from libCEC to the client.
885 * @param message The message to transfer.
886 * @return 1 when ok, 0 otherwise.
887 */
888 CBCecLogMessageType CBCecLogMessage;
889
890 /*!
891 * @brief Transfer a keypress from libCEC to the client.
892 * @param key The keypress to transfer.
893 * @return 1 when ok, 0 otherwise.
894 */
895 CBCecKeyPressType CBCecKeyPress;
896
897 /*!
898 * @brief Transfer a CEC command from libCEC to the client.
899 * @param command The command to transfer.
900 * @return 1 when ok, 0 otherwise.
901 */
902 CBCecCommandType CBCecCommand;
903 } ICECCallbacks;
904
905 #ifdef UNUSED
906 #elif defined(__GNUC__)
907 #define UNUSED(x) UNUSED_ ## x __attribute__((unused))
908 #elif defined(__LCLINT__)
909 #define UNUSED(x) /*@unused@*/ x
910 #else
911 #define UNUSED(x) x
912 #endif
913
914 #ifdef __cplusplus
915 };
916 };
917 #endif
918
919 #endif /* CECTYPES_H_ */