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