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