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