Release 2.2.0
[deb_libcec.git] / include / cectypes.h
CommitLineData
acec5f48
LOK
1#pragma once
2/*
3 * This file is part of the libCEC(R) library.
4 *
16f47961 5 * libCEC(R) is Copyright (C) 2011-2013 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
96692e30
LOK
64/*!
65 * default physical address 1.0.0.0, HDMI port 1
66 */
5ae8fa48 67#define CEC_DEFAULT_PHYSICAL_ADDRESS 0x1000
96692e30
LOK
68/*!
69 * default HDMI port to which the adapter is connected, port 1
70 */
16b1e052 71#define CEC_DEFAULT_HDMI_PORT 1
96692e30
LOK
72/*!
73 * default logical address of the device to which the adapter is connected, TV
74 */
d2f1c157 75#define CEC_DEFAULT_BASE_DEVICE 0
96692e30
LOK
76
77/*!
78 * timeout in milliseconds to send a key release event after receiving a key press
79 */
5ae8fa48 80#define CEC_BUTTON_TIMEOUT 500
96692e30 81
dbf90acf 82/*!
8d84f8b3
LOK
83 * don't send the same key twice within this timeout in units of 50 milliseconds
84 * 4 = 200ms
dbf90acf 85 */
5d7960cb
LOK
86#define CEC_DOUBLE_TAP_TIMEOUT_50_MS 4
87#define CEC_DOUBLE_TAP_TIMEOUT_MS_OLD 200
dbf90acf 88
96692e30
LOK
89/*!
90 * don't query the power state for the same device within this timeout in milliseconds
91 */
2efa39b7 92#define CEC_POWER_STATE_REFRESH_TIME 30000
96692e30
LOK
93
94/*!
95 * unknown firmware version value
96 */
1fc16cfd 97#define CEC_FW_VERSION_UNKNOWN 0xFFFF
96692e30
LOK
98
99/*!
100 * unknown build date value
101 */
d2d1660c 102#define CEC_FW_BUILD_UNKNOWN 0
96692e30
LOK
103
104/*!
105 * maximum number of retries when opening a connection
106 */
3b5e433a 107#define CEC_CONNECT_TRIES 3
64ec6e79 108
96692e30
LOK
109/*!
110 * physical address of the TV
111 */
b32ffd87 112#define CEC_PHYSICAL_ADDRESS_TV 0
96692e30
LOK
113
114/*!
115 * minimum physical address for the adapter
116 */
d2d1660c 117#define CEC_MIN_PHYSICAL_ADDRESS 0x1000
96692e30
LOK
118
119/*!
120 * maximum physical address for the adapter
121 */
b32ffd87 122#define CEC_MAX_PHYSICAL_ADDRESS 0xFFFE
96692e30
LOK
123
124/*!
125 * invalid physical address value
126 */
b32ffd87 127#define CEC_INVALID_PHYSICAL_ADDRESS 0xFFFF
5ae8fa48 128
96692e30
LOK
129/*!
130 * minimum vendor ID value
131 */
64ec6e79 132#define CEC_MIN_VENDORID 1
96692e30
LOK
133
134/*!
135 * maximum vendor ID value
136 */
64ec6e79 137#define CEC_MAX_VENDORID 0xFFFFFE
96692e30
LOK
138
139/*!
140 * invalid vendor ID value
141 */
64ec6e79
LOK
142#define CEC_INVALID_VENDORID 0xFFFFFF
143
96692e30
LOK
144/*!
145 * minimum HDMI port number value
146 */
64ec6e79 147#define CEC_MIN_HDMI_PORTNUMBER 1
96692e30
LOK
148
149/*!
150 * maximum HDMI port number value
151 */
64ec6e79 152#define CEC_MAX_HDMI_PORTNUMBER 15
96692e30
LOK
153
154/*!
155 * invalid HDMI port number value
156 */
d2d1660c 157#define CEC_HDMI_PORTNUMBER_NONE 0
64ec6e79 158
96692e30
LOK
159/*!
160 * default value for settings "use tv menu language"
161 */
7f274e72 162#define CEC_DEFAULT_SETTING_USE_TV_MENU_LANGUAGE 1
96692e30
LOK
163
164/*!
165 * default value for settings "activate source"
166 */
7f274e72 167#define CEC_DEFAULT_SETTING_ACTIVATE_SOURCE 1
96692e30
LOK
168
169/*!
170 * default value for settings "power off on shutdown"
171 */
7f274e72 172#define CEC_DEFAULT_SETTING_POWER_OFF_SHUTDOWN 1
96692e30
LOK
173
174/*!
175 * default value for settings "power off when activating the screensaver"
176 */
7f274e72 177#define CEC_DEFAULT_SETTING_POWER_OFF_SCREENSAVER 1
96692e30 178
d18ea27b
JM
179/*!
180 * default value for settings "wake up when deactivating the screensaver"
181 */
182#define CEC_DEFAULT_SETTING_POWER_ON_SCREENSAVER 1
183
96692e30
LOK
184/*!
185 * default value for settings "power off on standby"
186 */
7f274e72 187#define CEC_DEFAULT_SETTING_POWER_OFF_ON_STANDBY 1
96692e30
LOK
188
189/*!
190 * default value for settings "shutdown on standby"
191 */
7f274e72 192#define CEC_DEFAULT_SETTING_SHUTDOWN_ON_STANDBY 0
96692e30
LOK
193
194/*!
195 * default value for settings "send inactive source when stopping"
196 */
7f274e72 197#define CEC_DEFAULT_SETTING_SEND_INACTIVE_SOURCE 1
96692e30
LOK
198
199/*!
200 * default value for settings "power off devices when going to standby"
201 */
b98fc43d 202#define CEC_DEFAULT_SETTING_POWER_OFF_DEVICES_STANDBY 1
96692e30
LOK
203
204/*!
205 * default value for settings "device menu language"
206 */
7f274e72 207#define CEC_DEFAULT_DEVICE_LANGUAGE "eng"
96692e30
LOK
208
209/*!
210 * default value for settings "autodetect physical address"
211 */
20be20ea 212#define CEC_DEFAULT_SETTING_AUTODETECT_ADDRESS 0
96692e30
LOK
213
214/*!
215 * default value for settings "get settings from ROM"
216 */
64ec6e79 217#define CEC_DEFAULT_SETTING_GET_SETTINGS_FROM_ROM 0
96692e30
LOK
218
219/*!
220 * default value for settings "libCEC CEC version"
221 */
2b44051c 222#define CEC_DEFAULT_SETTING_CEC_VERSION 0x05
224ea877 223
96692e30
LOK
224/*!
225 * wait this amount of milliseconds before retrying to send a failed message
226 */
4478bc79 227#define CEC_DEFAULT_TRANSMIT_RETRY_WAIT 500
96692e30
LOK
228
229/*!
230 * transmission fails when not acked within this amount of milliseconds after sending the initial packet
231 */
4478bc79 232#define CEC_DEFAULT_TRANSMIT_TIMEOUT 1000
96692e30
LOK
233
234/*!
235 * wait this amount of milliseconds for an ack
236 */
d2d1660c 237#define CEC_DEFAULT_TRANSMIT_WAIT 1000
96692e30
LOK
238
239/*!
240 * default number of retries
241 */
4478bc79 242#define CEC_DEFAULT_TRANSMIT_RETRIES 1
ae693aaa 243
96692e30
LOK
244/*!
245 * default connection timeout in milliseconds
246 */
b32ffd87 247#define CEC_DEFAULT_CONNECT_TIMEOUT 10000
96692e30
LOK
248
249/*!
250 * wait this amount of milliseconds before retrying when failing to connect
251 */
b32ffd87 252#define CEC_DEFAULT_CONNECT_RETRY_WAIT 1000
96692e30
LOK
253
254/*!
255 * default serial baudrate
256 */
b32ffd87 257#define CEC_SERIAL_DEFAULT_BAUDRATE 38400
96692e30
LOK
258
259/*!
260 * maximum time to wait when clearing input
261 */
b32ffd87
LOK
262#define CEC_CLEAR_INPUT_DEFAULT_WAIT 1000
263
96692e30
LOK
264/*!
265 * wait this amount of milliseconds before retrying when libCEC failed to make itself the active source
266 */
b8599733 267#define CEC_ACTIVE_SOURCE_SWITCH_RETRY_TIME_MS 1000
96692e30
LOK
268
269/*!
270 * don't forward any power off command to the client application for this amount of milliseconds after sending a power off command
271 */
55c18d43 272#define CEC_FORWARD_STANDBY_MIN_INTERVAL 10000
aa4c0d34 273
ac3f9901
LOK
274/*!
275 * default timeout in milliseconds for combo keys
276 */
277#define CEC_DEFAULT_COMBO_TIMEOUT_MS 1000
278
96692e30
LOK
279/*!
280 * the virtual device path to use for the Raspberry Pi's CEC wire
281 */
2b44051c 282#define CEC_RPI_VIRTUAL_PATH "Raspberry Pi"
96692e30
LOK
283
284/*!
285 * the name of the virtual COM port to use for the Raspberry Pi's CEC wire
286 */
2b44051c
LOK
287#define CEC_RPI_VIRTUAL_COM "RPI"
288
90b7066f
LOK
289/*!
290 * the path to use for the TDA995x's CEC wire
291 */
51b611bc 292#define CEC_TDA995x_PATH "/dev/hdmicec"
90b7066f
LOK
293
294/*!
295 * the name of the virtual COM port to use for the TDA995x's CEC wire
296 */
51b611bc 297#define CEC_TDA995x_VIRTUAL_COM "CuBox"
4d3a7562 298
5b6d8032
VM
299/*!
300 * the path to use for the Exynos HDMI CEC device
301 */
302#define CEC_EXYNOS_PATH "/dev/CEC"
303
304/*!
305 * the name of the virtual COM port to use for the EXYNOS' CEC wire
306 */
307#define CEC_EXYNOS_VIRTUAL_COM "Exynos"
308
96692e30
LOK
309/*!
310 * Mimimum client version
311 */
312#define CEC_MIN_LIB_VERSION 2
313
314/*!
315 * libCEC's major version number
316 */
317#define CEC_LIB_VERSION_MAJOR 2
318
319/*!
320 * libCEC's major version number as string
321 */
322#define CEC_LIB_VERSION_MAJOR_STR "2"
323
324/*!
325 * libCEC's minor version number
326 */
b5d801b8 327#define CEC_LIB_VERSION_MINOR 2
96692e30
LOK
328
329#define MSGSTART 0xFF
330#define MSGEND 0xFE
331#define MSGESC 0xFD
332#define ESCOFFSET 3
5ae8fa48 333
8d84f8b3
LOK
334#define DOUBLE_TAP_TIMEOUT_UNIT_SIZE (50)
335
ac3f9901
LOK
336// defines to make compile time checks for certain features easy
337#define CEC_FEATURE_CONFIGURABLE_COMBO_KEY 1
5ae8fa48 338
c727331e 339typedef enum cec_abort_reason
acec5f48 340{
96692e30
LOK
341 CEC_ABORT_REASON_UNRECOGNIZED_OPCODE = 0,//!< CEC_ABORT_REASON_UNRECOGNIZED_OPCODE
342 CEC_ABORT_REASON_NOT_IN_CORRECT_MODE_TO_RESPOND = 1,//!< CEC_ABORT_REASON_NOT_IN_CORRECT_MODE_TO_RESPOND
343 CEC_ABORT_REASON_CANNOT_PROVIDE_SOURCE = 2,//!< CEC_ABORT_REASON_CANNOT_PROVIDE_SOURCE
344 CEC_ABORT_REASON_INVALID_OPERAND = 3,//!< CEC_ABORT_REASON_INVALID_OPERAND
345 CEC_ABORT_REASON_REFUSED = 4 //!< CEC_ABORT_REASON_REFUSED
c727331e 346} cec_abort_reason;
acec5f48 347
c727331e 348typedef enum cec_analogue_broadcast_type
acec5f48 349{
5ae8fa48
LOK
350 CEC_ANALOGUE_BROADCAST_TYPE_CABLE = 0x00,
351 CEC_ANALOGUE_BROADCAST_TYPE_SATELLITE = 0x01,
acec5f48 352 CEC_ANALOGUE_BROADCAST_TYPE_TERRESTIAL = 0x02
c727331e 353} cec_analogue_broadcast_type;
acec5f48 354
c727331e 355typedef enum cec_audio_rate
acec5f48 356{
5ae8fa48
LOK
357 CEC_AUDIO_RATE_RATE_CONTROL_OFF = 0,
358 CEC_AUDIO_RATE_STANDARD_RATE_100 = 1,
359 CEC_AUDIO_RATE_FAST_RATE_MAX_101 = 2,
360 CEC_AUDIO_RATE_SLOW_RATE_MIN_99 = 3,
acec5f48
LOK
361 CEC_AUDIO_RATE_STANDARD_RATE_100_0 = 4,
362 CEC_AUDIO_RATE_FAST_RATE_MAX_100_1 = 5,
5ae8fa48 363 CEC_AUDIO_RATE_SLOW_RATE_MIN_99_9 = 6
c727331e 364} cec_audio_rate;
acec5f48 365
e5e86c76 366typedef enum cec_audio_status
acec5f48 367{
5ae8fa48
LOK
368 CEC_AUDIO_MUTE_STATUS_MASK = 0x80,
369 CEC_AUDIO_VOLUME_STATUS_MASK = 0x7F,
370 CEC_AUDIO_VOLUME_MIN = 0x00,
371 CEC_AUDIO_VOLUME_MAX = 0x64,
acec5f48 372 CEC_AUDIO_VOLUME_STATUS_UNKNOWN = 0x7F
e5e86c76 373} cec_audio_status;
acec5f48 374
c727331e 375typedef enum cec_boolean
acec5f48
LOK
376{
377 CEC_FALSE = 0,
5ae8fa48 378 CEC_TRUE = 1
c727331e 379} cec_boolean;
acec5f48 380
6a1c0009 381typedef enum cec_version
acec5f48 382{
6a1c0009
LOK
383 CEC_VERSION_UNKNOWN = 0x00,
384 CEC_VERSION_1_2 = 0x01,
385 CEC_VERSION_1_2A = 0x02,
386 CEC_VERSION_1_3 = 0x03,
c4098482
LOK
387 CEC_VERSION_1_3A = 0x04,
388 CEC_VERSION_1_4 = 0x05
6a1c0009 389} cec_version;
acec5f48 390
c727331e 391typedef enum cec_channel_identifier
acec5f48
LOK
392{
393 CEC_CHANNEL_NUMBER_FORMAT_MASK = 0xFC000000,
5ae8fa48
LOK
394 CEC_1_PART_CHANNEL_NUMBER = 0x04000000,
395 CEC_2_PART_CHANNEL_NUMBER = 0x08000000,
396 CEC_MAJOR_CHANNEL_NUMBER_MASK = 0x3FF0000,
397 CEC_MINOR_CHANNEL_NUMBER_MASK = 0xFFFF
c727331e 398} cec_channel_identifier;
acec5f48 399
8ac9c610 400typedef enum cec_deck_control_mode
acec5f48 401{
5ae8fa48 402 CEC_DECK_CONTROL_MODE_SKIP_FORWARD_WIND = 1,
a9232a79 403 CEC_DECK_CONTROL_MODE_SKIP_REVERSE_REWIND = 2,
5ae8fa48
LOK
404 CEC_DECK_CONTROL_MODE_STOP = 3,
405 CEC_DECK_CONTROL_MODE_EJECT = 4
8ac9c610 406} cec_deck_control_mode;
acec5f48 407
8ac9c610 408typedef enum cec_deck_info
acec5f48 409{
5ae8fa48
LOK
410 CEC_DECK_INFO_PLAY = 0x11,
411 CEC_DECK_INFO_RECORD = 0x12,
412 CEC_DECK_INFO_PLAY_REVERSE = 0x13,
413 CEC_DECK_INFO_STILL = 0x14,
414 CEC_DECK_INFO_SLOW = 0x15,
415 CEC_DECK_INFO_SLOW_REVERSE = 0x16,
416 CEC_DECK_INFO_FAST_FORWARD = 0x17,
417 CEC_DECK_INFO_FAST_REVERSE = 0x18,
418 CEC_DECK_INFO_NO_MEDIA = 0x19,
419 CEC_DECK_INFO_STOP = 0x1A,
420 CEC_DECK_INFO_SKIP_FORWARD_WIND = 0x1B,
421 CEC_DECK_INFO_SKIP_REVERSE_REWIND = 0x1C,
acec5f48
LOK
422 CEC_DECK_INFO_INDEX_SEARCH_FORWARD = 0x1D,
423 CEC_DECK_INFO_INDEX_SEARCH_REVERSE = 0x1E,
8d915412
LOK
424 CEC_DECK_INFO_OTHER_STATUS = 0x1F,
425 CEC_DECK_INFO_OTHER_STATUS_LG = 0x20
8ac9c610 426} cec_deck_info;
acec5f48 427
f8513317 428typedef enum cec_device_type
acec5f48 429{
5ae8fa48 430 CEC_DEVICE_TYPE_TV = 0,
acec5f48 431 CEC_DEVICE_TYPE_RECORDING_DEVICE = 1,
5ae8fa48
LOK
432 CEC_DEVICE_TYPE_RESERVED = 2,
433 CEC_DEVICE_TYPE_TUNER = 3,
434 CEC_DEVICE_TYPE_PLAYBACK_DEVICE = 4,
435 CEC_DEVICE_TYPE_AUDIO_SYSTEM = 5
f8513317
LOK
436} cec_device_type;
437
1969b140 438typedef enum cec_display_control
acec5f48
LOK
439{
440 CEC_DISPLAY_CONTROL_DISPLAY_FOR_DEFAULT_TIME = 0x00,
5ae8fa48
LOK
441 CEC_DISPLAY_CONTROL_DISPLAY_UNTIL_CLEARED = 0x40,
442 CEC_DISPLAY_CONTROL_CLEAR_PREVIOUS_MESSAGE = 0x80,
443 CEC_DISPLAY_CONTROL_RESERVED_FOR_FUTURE_USE = 0xC0
1969b140 444} cec_display_control;
acec5f48 445
c727331e 446typedef enum cec_external_source_specifier
acec5f48 447{
5ae8fa48 448 CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PLUG = 4,
acec5f48 449 CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PHYSICAL_ADDRESS = 5
c727331e 450} cec_external_source_specifier;
acec5f48 451
c727331e 452typedef enum cec_menu_request_type
acec5f48 453{
5ae8fa48 454 CEC_MENU_REQUEST_TYPE_ACTIVATE = 0,
acec5f48 455 CEC_MENU_REQUEST_TYPE_DEACTIVATE = 1,
5ae8fa48 456 CEC_MENU_REQUEST_TYPE_QUERY = 2
c727331e 457} cec_menu_request_type;
acec5f48 458
c727331e 459typedef enum cec_menu_state
acec5f48 460{
5ae8fa48 461 CEC_MENU_STATE_ACTIVATED = 0,
acec5f48 462 CEC_MENU_STATE_DEACTIVATED = 1
c727331e 463} cec_menu_state;
acec5f48 464
c727331e 465typedef enum cec_play_mode
acec5f48 466{
5ae8fa48
LOK
467 CEC_PLAY_MODE_PLAY_FORWARD = 0x24,
468 CEC_PLAY_MODE_PLAY_REVERSE = 0x20,
469 CEC_PLAY_MODE_PLAY_STILL = 0x25,
470 CEC_PLAY_MODE_FAST_FORWARD_MIN_SPEED = 0x05,
acec5f48 471 CEC_PLAY_MODE_FAST_FORWARD_MEDIUM_SPEED = 0x06,
5ae8fa48
LOK
472 CEC_PLAY_MODE_FAST_FORWARD_MAX_SPEED = 0x07,
473 CEC_PLAY_MODE_FAST_REVERSE_MIN_SPEED = 0x09,
acec5f48 474 CEC_PLAY_MODE_FAST_REVERSE_MEDIUM_SPEED = 0x0A,
5ae8fa48
LOK
475 CEC_PLAY_MODE_FAST_REVERSE_MAX_SPEED = 0x0B,
476 CEC_PLAY_MODE_SLOW_FORWARD_MIN_SPEED = 0x15,
acec5f48 477 CEC_PLAY_MODE_SLOW_FORWARD_MEDIUM_SPEED = 0x16,
5ae8fa48
LOK
478 CEC_PLAY_MODE_SLOW_FORWARD_MAX_SPEED = 0x17,
479 CEC_PLAY_MODE_SLOW_REVERSE_MIN_SPEED = 0x19,
acec5f48 480 CEC_PLAY_MODE_SLOW_REVERSE_MEDIUM_SPEED = 0x1A,
5ae8fa48 481 CEC_PLAY_MODE_SLOW_REVERSE_MAX_SPEED = 0x1B
c727331e 482} cec_play_mode;
acec5f48 483
e55f3f70 484typedef enum cec_power_status
acec5f48 485{
5ae8fa48
LOK
486 CEC_POWER_STATUS_ON = 0x00,
487 CEC_POWER_STATUS_STANDBY = 0x01,
acec5f48 488 CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON = 0x02,
e55f3f70 489 CEC_POWER_STATUS_IN_TRANSITION_ON_TO_STANDBY = 0x03,
5ae8fa48 490 CEC_POWER_STATUS_UNKNOWN = 0x99
e55f3f70 491} cec_power_status;
acec5f48 492
c727331e 493typedef enum cec_record_source_type
acec5f48 494{
5ae8fa48
LOK
495 CEC_RECORD_SOURCE_TYPE_OWN_SOURCE = 1,
496 CEC_RECORD_SOURCE_TYPE_DIGITAL_SERVICE = 2,
497 CEC_RECORD_SOURCE_TYPE_ANALOGUE_SERVICE = 3,
498 CEC_RECORD_SOURCE_TYPE_EXTERNAL_PLUS = 4,
acec5f48 499 CEC_RECORD_SOURCE_TYPE_EXTERNAL_PHYSICAL_ADDRESS = 5
c727331e 500} cec_record_source_type;
acec5f48 501
c727331e 502typedef enum cec_record_status_info
acec5f48 503{
5ae8fa48
LOK
504 CEC_RECORD_STATUS_INFO_RECORDING_CURRENTLY_SELECTED_SOURCE = 0x01,
505 CEC_RECORD_STATUS_INFO_RECORDING_DIGITAL_SERVICE = 0x02,
506 CEC_RECORD_STATUS_INFO_RECORDING_ANALOGUE_SERVICE = 0x03,
507 CEC_RECORD_STATUS_INFO_RECORDING_EXTERNAL_INPUT = 0x04,
508 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_DIGITAL_SERVICE = 0x05,
acec5f48
LOK
509 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_ANALOGUE_SERVICE = 0x06,
510 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_SELECT_REQUIRED_SERVICE = 0x07,
5ae8fa48
LOK
511 CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_PLUG_NUMBER = 0x09,
512 CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_ADDRESS = 0x0A,
513 CEC_RECORD_STATUS_INFO_NO_RECORDING_CA_SYSTEM_NOT_SUPPORTED = 0x0B,
514 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_OR_INSUFFICIENT_ENTITLEMENTS = 0x0C,
515 CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ALLOWED_TO_COPY_SOURCE = 0x0D,
516 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_FURTHER_COPIES_ALLOWED = 0x0E,
517 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_MEDIA = 0x10,
518 CEC_RECORD_STATUS_INFO_NO_RECORDING_PLAYING = 0x11,
519 CEC_RECORD_STATUS_INFO_NO_RECORDING_ALREADY_RECORDING = 0x12,
520 CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROTECTED = 0x13,
521 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_SOURCE_SIGNAL = 0x14,
522 CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROBLEM = 0x15,
523 CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ENOUGH_SPACE_AVAILABLE = 0x16,
524 CEC_RECORD_STATUS_INFO_NO_RECORDING_PARENTAL_LOCK_ON = 0x17,
525 CEC_RECORD_STATUS_INFO_RECORDING_TERMINATED_NORMALLY = 0x1A,
526 CEC_RECORD_STATUS_INFO_RECORDING_HAS_ALREADY_TERMINATED = 0x1B,
527 CEC_RECORD_STATUS_INFO_NO_RECORDING_OTHER_REASON = 0x1F
c727331e 528} cec_record_status_info;
acec5f48 529
c727331e 530typedef enum cec_recording_sequence
acec5f48 531{
5ae8fa48
LOK
532 CEC_RECORDING_SEQUENCE_SUNDAY = 0x01,
533 CEC_RECORDING_SEQUENCE_MONDAY = 0x02,
534 CEC_RECORDING_SEQUENCE_TUESDAY = 0x04,
acec5f48 535 CEC_RECORDING_SEQUENCE_WEDNESDAY = 0x08,
5ae8fa48
LOK
536 CEC_RECORDING_SEQUENCE_THURSDAY = 0x10,
537 CEC_RECORDING_SEQUENCE_FRIDAY = 0x20,
538 CEC_RECORDING_SEQUENCE_SATURDAY = 0x40,
acec5f48 539 CEC_RECORDING_SEQUENCE_ONCE_ONLY = 0x00
c727331e 540} cec_recording_sequence;
acec5f48 541
c727331e 542typedef enum cec_status_request
acec5f48 543{
5ae8fa48
LOK
544 CEC_STATUS_REQUEST_ON = 1,
545 CEC_STATUS_REQUEST_OFF = 2,
acec5f48 546 CEC_STATUS_REQUEST_ONCE = 3
c727331e 547} cec_status_request;
acec5f48 548
e5e86c76 549typedef enum cec_system_audio_status
acec5f48
LOK
550{
551 CEC_SYSTEM_AUDIO_STATUS_OFF = 0,
5ae8fa48 552 CEC_SYSTEM_AUDIO_STATUS_ON = 1
e5e86c76 553} cec_system_audio_status;
acec5f48 554
c727331e 555typedef enum cec_timer_cleared_status_data
acec5f48 556{
5ae8fa48
LOK
557 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_RECORDING = 0x00,
558 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_MATCHING = 0x01,
acec5f48 559 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_INF0_AVAILABLE = 0x02,
5ae8fa48 560 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_CLEARED = 0x80
c727331e 561} cec_timer_cleared_status_data;
acec5f48 562
c727331e 563typedef enum cec_timer_overlap_warning
acec5f48 564{
5ae8fa48 565 CEC_TIMER_OVERLAP_WARNING_NO_OVERLAP = 0,
acec5f48 566 CEC_TIMER_OVERLAP_WARNING_TIMER_BLOCKS_OVERLAP = 1
c727331e 567} cec_timer_overlap_warning;
acec5f48 568
c727331e 569typedef enum cec_media_info
acec5f48
LOK
570{
571 CEC_MEDIA_INFO_MEDIA_PRESENT_AND_NOT_PROTECTED = 0x00,
5ae8fa48
LOK
572 CEC_MEDIA_INFO_MEDIA_PRESENT_BUT_PROTECTED = 0x01,
573 CEC_MEDIA_INFO_MEDIA_NOT_PRESENT = 0x02,
574 CEC_MEDIA_INFO_FUTURE_USE = 0x03
c727331e 575} cec_media_info;
acec5f48 576
c727331e 577typedef enum cec_programmed_indicator
acec5f48
LOK
578{
579 CEC_PROGRAMMED_INDICATOR_NOT_PROGRAMMED = 0,
5ae8fa48 580 CEC_PROGRAMMED_INDICATOR_PROGRAMMED = 1
c727331e 581} cec_programmed_indicator;
acec5f48 582
c727331e 583typedef enum cec_programmed_info
acec5f48 584{
5ae8fa48
LOK
585 CEC_PROGRAMMED_INFO_FUTURE_USE = 0x0,
586 CEC_PROGRAMMED_INFO_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING = 0x08,
acec5f48 587 CEC_PROGRAMMED_INFO_NOT_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING = 0x09,
5ae8fa48
LOK
588 CEC_PROGRAMMED_INFO_MAY_NOT_BE_ENOUGH_SPACE_AVAILABLE = 0x0B,
589 CEC_PROGRAMMED_INFO_NO_MEDIA_INFO_AVAILABLE = 0x0A
c727331e 590} cec_programmed_info;
acec5f48 591
c727331e 592typedef enum cec_not_programmed_error_info
acec5f48 593{
5ae8fa48
LOK
594 CEC_NOT_PROGRAMMED_ERROR_INFO_FUTURE_USE = 0x0,
595 CEC_NOT_PROGRAMMED_ERROR_INFO_NO_FREE_TIMER_AVAILABLE = 0x01,
596 CEC_NOT_PROGRAMMED_ERROR_INFO_DATE_OUT_OF_RANGE = 0x02,
597 CEC_NOT_PROGRAMMED_ERROR_INFO_RECORDING_SEQUENCE_ERROR = 0x03,
598 CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PLUG_NUMBER = 0x04,
599 CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PHYSICAL_ADDRESS = 0x05,
600 CEC_NOT_PROGRAMMED_ERROR_INFO_CA_SYSTEM_NOT_SUPPORTED = 0x06,
acec5f48 601 CEC_NOT_PROGRAMMED_ERROR_INFO_NO_OR_INSUFFICIENT_CA_ENTITLEMENTS = 0x07,
5ae8fa48
LOK
602 CEC_NOT_PROGRAMMED_ERROR_INFO_DOES_NOT_SUPPORT_RESOLUTION = 0x08,
603 CEC_NOT_PROGRAMMED_ERROR_INFO_PARENTAL_LOCK_ON = 0x09,
604 CEC_NOT_PROGRAMMED_ERROR_INFO_CLOCK_FAILURE = 0x0A,
605 CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_START = 0x0B,
606 CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_END = 0x0D,
607 CEC_NOT_PROGRAMMED_ERROR_INFO_DUPLICATE_ALREADY_PROGRAMMED = 0x0E
c727331e 608} cec_not_programmed_error_info;
acec5f48 609
c727331e 610typedef enum cec_recording_flag
acec5f48
LOK
611{
612 CEC_RECORDING_FLAG_NOT_BEING_USED_FOR_RECORDING = 0,
5ae8fa48 613 CEC_RECORDING_FLAG_BEING_USED_FOR_RECORDING = 1
c727331e 614} cec_recording_flag;
acec5f48 615
c727331e 616typedef enum cec_tuner_display_info
acec5f48 617{
5ae8fa48
LOK
618 CEC_TUNER_DISPLAY_INFO_DISPLAYING_DIGITAL_TUNER = 0,
619 CEC_TUNER_DISPLAY_INFO_NOT_DISPLAYING_TUNER = 1,
acec5f48 620 CEC_TUNER_DISPLAY_INFO_DISPLAYING_ANALOGUE_TUNER = 2
c727331e 621} cec_tuner_display_info;
acec5f48 622
c727331e 623typedef enum cec_broadcast_system
acec5f48 624{
5ae8fa48
LOK
625 CEC_BROADCAST_SYSTEM_PAL_B_G = 0,
626 CEC_BROADCAST_SYSTEM_SECAM_L1 = 1,
627 CEC_BROADCAST_SYSTEM_PAL_M = 2,
628 CEC_BROADCAST_SYSTEM_NTSC_M = 3,
629 CEC_BROADCAST_SYSTEM_PAL_I = 4,
630 CEC_BROADCAST_SYSTEM_SECAM_DK = 5,
631 CEC_BROADCAST_SYSTEM_SECAM_B_G = 6,
632 CEC_BROADCAST_SYSTEM_SECAM_L2 = 7,
633 CEC_BROADCAST_SYSTEM_PAL_DK = 8,
acec5f48 634 CEC_BROADCAST_SYSTEM_OTHER_SYSTEM = 30
c727331e 635} cec_broadcast_system;
acec5f48
LOK
636
637typedef enum cec_user_control_code
638{
5ae8fa48
LOK
639 CEC_USER_CONTROL_CODE_SELECT = 0x00,
640 CEC_USER_CONTROL_CODE_UP = 0x01,
641 CEC_USER_CONTROL_CODE_DOWN = 0x02,
642 CEC_USER_CONTROL_CODE_LEFT = 0x03,
643 CEC_USER_CONTROL_CODE_RIGHT = 0x04,
644 CEC_USER_CONTROL_CODE_RIGHT_UP = 0x05,
645 CEC_USER_CONTROL_CODE_RIGHT_DOWN = 0x06,
646 CEC_USER_CONTROL_CODE_LEFT_UP = 0x07,
647 CEC_USER_CONTROL_CODE_LEFT_DOWN = 0x08,
648 CEC_USER_CONTROL_CODE_ROOT_MENU = 0x09,
649 CEC_USER_CONTROL_CODE_SETUP_MENU = 0x0A,
650 CEC_USER_CONTROL_CODE_CONTENTS_MENU = 0x0B,
651 CEC_USER_CONTROL_CODE_FAVORITE_MENU = 0x0C,
652 CEC_USER_CONTROL_CODE_EXIT = 0x0D,
bc258169
KS
653 // reserved: 0x0E, 0x0F
654 CEC_USER_CONTROL_CODE_TOP_MENU = 0x10,
655 CEC_USER_CONTROL_CODE_DVD_MENU = 0x11,
656 // reserved: 0x12 ... 0x1C
657 CEC_USER_CONTROL_CODE_NUMBER_ENTRY_MODE = 0x1D,
658 CEC_USER_CONTROL_CODE_NUMBER11 = 0x1E,
659 CEC_USER_CONTROL_CODE_NUMBER12 = 0x1F,
5ae8fa48
LOK
660 CEC_USER_CONTROL_CODE_NUMBER0 = 0x20,
661 CEC_USER_CONTROL_CODE_NUMBER1 = 0x21,
662 CEC_USER_CONTROL_CODE_NUMBER2 = 0x22,
663 CEC_USER_CONTROL_CODE_NUMBER3 = 0x23,
664 CEC_USER_CONTROL_CODE_NUMBER4 = 0x24,
665 CEC_USER_CONTROL_CODE_NUMBER5 = 0x25,
666 CEC_USER_CONTROL_CODE_NUMBER6 = 0x26,
667 CEC_USER_CONTROL_CODE_NUMBER7 = 0x27,
668 CEC_USER_CONTROL_CODE_NUMBER8 = 0x28,
669 CEC_USER_CONTROL_CODE_NUMBER9 = 0x29,
670 CEC_USER_CONTROL_CODE_DOT = 0x2A,
671 CEC_USER_CONTROL_CODE_ENTER = 0x2B,
672 CEC_USER_CONTROL_CODE_CLEAR = 0x2C,
673 CEC_USER_CONTROL_CODE_NEXT_FAVORITE = 0x2F,
674 CEC_USER_CONTROL_CODE_CHANNEL_UP = 0x30,
675 CEC_USER_CONTROL_CODE_CHANNEL_DOWN = 0x31,
676 CEC_USER_CONTROL_CODE_PREVIOUS_CHANNEL = 0x32,
677 CEC_USER_CONTROL_CODE_SOUND_SELECT = 0x33,
678 CEC_USER_CONTROL_CODE_INPUT_SELECT = 0x34,
679 CEC_USER_CONTROL_CODE_DISPLAY_INFORMATION = 0x35,
680 CEC_USER_CONTROL_CODE_HELP = 0x36,
681 CEC_USER_CONTROL_CODE_PAGE_UP = 0x37,
682 CEC_USER_CONTROL_CODE_PAGE_DOWN = 0x38,
bc258169 683 // reserved: 0x39 ... 0x3F
5ae8fa48
LOK
684 CEC_USER_CONTROL_CODE_POWER = 0x40,
685 CEC_USER_CONTROL_CODE_VOLUME_UP = 0x41,
686 CEC_USER_CONTROL_CODE_VOLUME_DOWN = 0x42,
687 CEC_USER_CONTROL_CODE_MUTE = 0x43,
688 CEC_USER_CONTROL_CODE_PLAY = 0x44,
689 CEC_USER_CONTROL_CODE_STOP = 0x45,
690 CEC_USER_CONTROL_CODE_PAUSE = 0x46,
691 CEC_USER_CONTROL_CODE_RECORD = 0x47,
692 CEC_USER_CONTROL_CODE_REWIND = 0x48,
693 CEC_USER_CONTROL_CODE_FAST_FORWARD = 0x49,
694 CEC_USER_CONTROL_CODE_EJECT = 0x4A,
695 CEC_USER_CONTROL_CODE_FORWARD = 0x4B,
696 CEC_USER_CONTROL_CODE_BACKWARD = 0x4C,
697 CEC_USER_CONTROL_CODE_STOP_RECORD = 0x4D,
698 CEC_USER_CONTROL_CODE_PAUSE_RECORD = 0x4E,
bc258169 699 // reserved: 0x4F
5ae8fa48
LOK
700 CEC_USER_CONTROL_CODE_ANGLE = 0x50,
701 CEC_USER_CONTROL_CODE_SUB_PICTURE = 0x51,
702 CEC_USER_CONTROL_CODE_VIDEO_ON_DEMAND = 0x52,
703 CEC_USER_CONTROL_CODE_ELECTRONIC_PROGRAM_GUIDE = 0x53,
704 CEC_USER_CONTROL_CODE_TIMER_PROGRAMMING = 0x54,
705 CEC_USER_CONTROL_CODE_INITIAL_CONFIGURATION = 0x55,
bc258169
KS
706 CEC_USER_CONTROL_CODE_SELECT_BROADCAST_TYPE = 0x56,
707 CEC_USER_CONTROL_CODE_SELECT_SOUND_PRESENTATION = 0x57,
708 // reserved: 0x58 ... 0x5F
5ae8fa48
LOK
709 CEC_USER_CONTROL_CODE_PLAY_FUNCTION = 0x60,
710 CEC_USER_CONTROL_CODE_PAUSE_PLAY_FUNCTION = 0x61,
711 CEC_USER_CONTROL_CODE_RECORD_FUNCTION = 0x62,
712 CEC_USER_CONTROL_CODE_PAUSE_RECORD_FUNCTION = 0x63,
713 CEC_USER_CONTROL_CODE_STOP_FUNCTION = 0x64,
714 CEC_USER_CONTROL_CODE_MUTE_FUNCTION = 0x65,
715 CEC_USER_CONTROL_CODE_RESTORE_VOLUME_FUNCTION = 0x66,
716 CEC_USER_CONTROL_CODE_TUNE_FUNCTION = 0x67,
717 CEC_USER_CONTROL_CODE_SELECT_MEDIA_FUNCTION = 0x68,
718 CEC_USER_CONTROL_CODE_SELECT_AV_INPUT_FUNCTION = 0x69,
acec5f48 719 CEC_USER_CONTROL_CODE_SELECT_AUDIO_INPUT_FUNCTION = 0x6A,
5ae8fa48
LOK
720 CEC_USER_CONTROL_CODE_POWER_TOGGLE_FUNCTION = 0x6B,
721 CEC_USER_CONTROL_CODE_POWER_OFF_FUNCTION = 0x6C,
722 CEC_USER_CONTROL_CODE_POWER_ON_FUNCTION = 0x6D,
bc258169 723 // reserved: 0x6E ... 0x70
5ae8fa48
LOK
724 CEC_USER_CONTROL_CODE_F1_BLUE = 0x71,
725 CEC_USER_CONTROL_CODE_F2_RED = 0X72,
726 CEC_USER_CONTROL_CODE_F3_GREEN = 0x73,
727 CEC_USER_CONTROL_CODE_F4_YELLOW = 0x74,
728 CEC_USER_CONTROL_CODE_F5 = 0x75,
729 CEC_USER_CONTROL_CODE_DATA = 0x76,
bc258169
KS
730 // reserved: 0x77 ... 0xFF
731 CEC_USER_CONTROL_CODE_AN_RETURN = 0x91, // return (Samsung)
732 CEC_USER_CONTROL_CODE_AN_CHANNELS_LIST = 0x96, // channels list (Samsung)
340ce76c 733 CEC_USER_CONTROL_CODE_MAX = 0x96,
ac3f9901 734 CEC_USER_CONTROL_CODE_UNKNOWN = 0xFF
acec5f48
LOK
735} cec_user_control_code;
736
737typedef enum cec_logical_address
738{
5ae8fa48
LOK
739 CECDEVICE_UNKNOWN = -1, //not a valid logical address
740 CECDEVICE_TV = 0,
741 CECDEVICE_RECORDINGDEVICE1 = 1,
742 CECDEVICE_RECORDINGDEVICE2 = 2,
743 CECDEVICE_TUNER1 = 3,
744 CECDEVICE_PLAYBACKDEVICE1 = 4,
745 CECDEVICE_AUDIOSYSTEM = 5,
746 CECDEVICE_TUNER2 = 6,
747 CECDEVICE_TUNER3 = 7,
748 CECDEVICE_PLAYBACKDEVICE2 = 8,
749 CECDEVICE_RECORDINGDEVICE3 = 9,
750 CECDEVICE_TUNER4 = 10,
751 CECDEVICE_PLAYBACKDEVICE3 = 11,
752 CECDEVICE_RESERVED1 = 12,
753 CECDEVICE_RESERVED2 = 13,
754 CECDEVICE_FREEUSE = 14,
755 CECDEVICE_UNREGISTERED = 15,
756 CECDEVICE_BROADCAST = 15
acec5f48
LOK
757} cec_logical_address;
758
759typedef enum cec_opcode
760{
5ae8fa48
LOK
761 CEC_OPCODE_ACTIVE_SOURCE = 0x82,
762 CEC_OPCODE_IMAGE_VIEW_ON = 0x04,
763 CEC_OPCODE_TEXT_VIEW_ON = 0x0D,
764 CEC_OPCODE_INACTIVE_SOURCE = 0x9D,
765 CEC_OPCODE_REQUEST_ACTIVE_SOURCE = 0x85,
766 CEC_OPCODE_ROUTING_CHANGE = 0x80,
767 CEC_OPCODE_ROUTING_INFORMATION = 0x81,
768 CEC_OPCODE_SET_STREAM_PATH = 0x86,
769 CEC_OPCODE_STANDBY = 0x36,
770 CEC_OPCODE_RECORD_OFF = 0x0B,
771 CEC_OPCODE_RECORD_ON = 0x09,
772 CEC_OPCODE_RECORD_STATUS = 0x0A,
773 CEC_OPCODE_RECORD_TV_SCREEN = 0x0F,
774 CEC_OPCODE_CLEAR_ANALOGUE_TIMER = 0x33,
775 CEC_OPCODE_CLEAR_DIGITAL_TIMER = 0x99,
776 CEC_OPCODE_CLEAR_EXTERNAL_TIMER = 0xA1,
777 CEC_OPCODE_SET_ANALOGUE_TIMER = 0x34,
778 CEC_OPCODE_SET_DIGITAL_TIMER = 0x97,
779 CEC_OPCODE_SET_EXTERNAL_TIMER = 0xA2,
780 CEC_OPCODE_SET_TIMER_PROGRAM_TITLE = 0x67,
781 CEC_OPCODE_TIMER_CLEARED_STATUS = 0x43,
782 CEC_OPCODE_TIMER_STATUS = 0x35,
783 CEC_OPCODE_CEC_VERSION = 0x9E,
784 CEC_OPCODE_GET_CEC_VERSION = 0x9F,
785 CEC_OPCODE_GIVE_PHYSICAL_ADDRESS = 0x83,
786 CEC_OPCODE_GET_MENU_LANGUAGE = 0x91,
787 CEC_OPCODE_REPORT_PHYSICAL_ADDRESS = 0x84,
788 CEC_OPCODE_SET_MENU_LANGUAGE = 0x32,
789 CEC_OPCODE_DECK_CONTROL = 0x42,
790 CEC_OPCODE_DECK_STATUS = 0x1B,
791 CEC_OPCODE_GIVE_DECK_STATUS = 0x1A,
792 CEC_OPCODE_PLAY = 0x41,
793 CEC_OPCODE_GIVE_TUNER_DEVICE_STATUS = 0x08,
794 CEC_OPCODE_SELECT_ANALOGUE_SERVICE = 0x92,
795 CEC_OPCODE_SELECT_DIGITAL_SERVICE = 0x93,
796 CEC_OPCODE_TUNER_DEVICE_STATUS = 0x07,
797 CEC_OPCODE_TUNER_STEP_DECREMENT = 0x06,
798 CEC_OPCODE_TUNER_STEP_INCREMENT = 0x05,
799 CEC_OPCODE_DEVICE_VENDOR_ID = 0x87,
800 CEC_OPCODE_GIVE_DEVICE_VENDOR_ID = 0x8C,
801 CEC_OPCODE_VENDOR_COMMAND = 0x89,
802 CEC_OPCODE_VENDOR_COMMAND_WITH_ID = 0xA0,
803 CEC_OPCODE_VENDOR_REMOTE_BUTTON_DOWN = 0x8A,
804 CEC_OPCODE_VENDOR_REMOTE_BUTTON_UP = 0x8B,
805 CEC_OPCODE_SET_OSD_STRING = 0x64,
806 CEC_OPCODE_GIVE_OSD_NAME = 0x46,
807 CEC_OPCODE_SET_OSD_NAME = 0x47,
808 CEC_OPCODE_MENU_REQUEST = 0x8D,
809 CEC_OPCODE_MENU_STATUS = 0x8E,
810 CEC_OPCODE_USER_CONTROL_PRESSED = 0x44,
811 CEC_OPCODE_USER_CONTROL_RELEASE = 0x45,
812 CEC_OPCODE_GIVE_DEVICE_POWER_STATUS = 0x8F,
813 CEC_OPCODE_REPORT_POWER_STATUS = 0x90,
814 CEC_OPCODE_FEATURE_ABORT = 0x00,
815 CEC_OPCODE_ABORT = 0xFF,
816 CEC_OPCODE_GIVE_AUDIO_STATUS = 0x71,
acec5f48 817 CEC_OPCODE_GIVE_SYSTEM_AUDIO_MODE_STATUS = 0x7D,
5ae8fa48
LOK
818 CEC_OPCODE_REPORT_AUDIO_STATUS = 0x7A,
819 CEC_OPCODE_SET_SYSTEM_AUDIO_MODE = 0x72,
820 CEC_OPCODE_SYSTEM_AUDIO_MODE_REQUEST = 0x70,
821 CEC_OPCODE_SYSTEM_AUDIO_MODE_STATUS = 0x7E,
822 CEC_OPCODE_SET_AUDIO_RATE = 0x9A,
38ba806c
LOK
823
824 /* CEC 1.4 */
825 CEC_OPCODE_START_ARC = 0xC0,
826 CEC_OPCODE_REPORT_ARC_STARTED = 0xC1,
827 CEC_OPCODE_REPORT_ARC_ENDED = 0xC2,
828 CEC_OPCODE_REQUEST_ARC_START = 0xC3,
829 CEC_OPCODE_REQUEST_ARC_END = 0xC4,
830 CEC_OPCODE_END_ARC = 0xC5,
831 CEC_OPCODE_CDC = 0xF8,
5ae8fa48
LOK
832 /* when this opcode is set, no opcode will be sent to the device. this is one of the reserved numbers */
833 CEC_OPCODE_NONE = 0xFD
acec5f48
LOK
834} cec_opcode;
835
836typedef enum cec_log_level
837{
941c58b9
LOK
838 CEC_LOG_ERROR = 1,
839 CEC_LOG_WARNING = 2,
840 CEC_LOG_NOTICE = 4,
841 CEC_LOG_TRAFFIC = 8,
842 CEC_LOG_DEBUG = 16,
843 CEC_LOG_ALL = 31
acec5f48
LOK
844} cec_log_level;
845
f8ae3295
LOK
846typedef enum cec_bus_device_status
847{
848 CEC_DEVICE_STATUS_UNKNOWN,
849 CEC_DEVICE_STATUS_PRESENT,
850 CEC_DEVICE_STATUS_NOT_PRESENT,
851 CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC
852} cec_bus_device_status;
853
5ae8fa48
LOK
854typedef enum cec_vendor_id
855{
4f504673
KS
856 CEC_VENDOR_TOSHIBA = 0x000039,
857 CEC_VENDOR_SAMSUNG = 0x0000F0,
858 CEC_VENDOR_DENON = 0x0005CD,
859 CEC_VENDOR_MARANTZ = 0x000678,
860 CEC_VENDOR_LOEWE = 0x000982,
861 CEC_VENDOR_ONKYO = 0x0009B0,
862 CEC_VENDOR_MEDION = 0x000CB8,
863 CEC_VENDOR_TOSHIBA2 = 0x000CE7,
864 CEC_VENDOR_PULSE_EIGHT = 0x001582,
865 CEC_VENDOR_HARMAN_KARDON2 = 0x001950,
866 CEC_VENDOR_AKAI = 0x0020C7,
867 CEC_VENDOR_AOC = 0x002467,
868 CEC_VENDOR_PANASONIC = 0x008045,
869 CEC_VENDOR_PHILIPS = 0x00903E,
870 CEC_VENDOR_DAEWOO = 0x009053,
871 CEC_VENDOR_YAMAHA = 0x00A0DE,
872 CEC_VENDOR_GRUNDIG = 0x00D0D5,
873 CEC_VENDOR_PIONEER = 0x00E036,
874 CEC_VENDOR_LG = 0x00E091,
875 CEC_VENDOR_SHARP = 0x08001F,
876 CEC_VENDOR_SONY = 0x080046,
877 CEC_VENDOR_BROADCOM = 0x18C086,
878 CEC_VENDOR_VIZIO = 0x6B746D,
879 CEC_VENDOR_BENQ = 0x8065E9,
880 CEC_VENDOR_HARMAN_KARDON = 0x9C645E,
881 CEC_VENDOR_UNKNOWN = 0
5ae8fa48
LOK
882} cec_vendor_id;
883
2d418322
LOK
884typedef enum cec_adapter_type
885{
886 ADAPTERTYPE_UNKNOWN = 0,
887 ADAPTERTYPE_P8_EXTERNAL = 0x1,
888 ADAPTERTYPE_P8_DAUGHTERBOARD = 0x2,
4d3a7562 889 ADAPTERTYPE_RPI = 0x100,
5b6d8032
VM
890 ADAPTERTYPE_TDA995x = 0x200,
891 ADAPTERTYPE_EXYNOS = 0x300
2d418322
LOK
892} cec_adapter_type;
893
5ae8fa48
LOK
894typedef struct cec_menu_language
895{
b453e1b8 896 char language[4]; /**< the iso language code. @bug the language code is only 3 chars long, not 4. will be changed in v2.0, because changing it now would break backwards compat */
8d901fdb 897 cec_logical_address device; /**< the logical address of the device */
5ae8fa48
LOK
898} cec_menu_language;
899
ed21be2a
LOK
900typedef struct cec_osd_name
901{
8d901fdb
LOK
902 char name[14]; /**< the name of the device */
903 cec_logical_address device; /**< the logical address of the device */
ed21be2a
LOK
904} cec_osd_name;
905
5ae8fa48
LOK
906typedef struct cec_log_message
907{
8d901fdb
LOK
908 char message[1024]; /**< the actual message */
909 cec_log_level level; /**< log level of the message */
910 int64_t time; /**< the timestamp of this message */
5ae8fa48
LOK
911} cec_log_message;
912
913typedef struct cec_keypress
914{
8d901fdb
LOK
915 cec_user_control_code keycode; /**< the keycode */
916 unsigned int duration; /**< the duration of the keypress */
5ae8fa48
LOK
917} cec_keypress;
918
919typedef struct cec_adapter
920{
8d901fdb
LOK
921 char path[1024]; /**< the path to the com port */
922 char comm[1024]; /**< the name of the com port */
5ae8fa48
LOK
923} cec_adapter;
924
e7fd53c8
LOK
925typedef struct cec_adapter_descriptor
926{
927 char strComPath[1024]; /**< the path to the com port */
928 char strComName[1024]; /**< the name of the com port */
929 uint16_t iVendorId;
930 uint16_t iProductId;
931 uint16_t iFirmwareVersion;
932 uint16_t iPhysicalAddress;
933 uint32_t iFirmwareBuildDate;
934 cec_adapter_type adapterType;
935} cec_adapter_descriptor;
936
acec5f48
LOK
937typedef struct cec_datapacket
938{
8d901fdb
LOK
939 uint8_t data[100]; /**< the actual data */
940 uint8_t size; /**< the size of the data */
acec5f48
LOK
941
942#ifdef __cplusplus
60a245d1
LOK
943 cec_datapacket &operator =(const struct cec_datapacket &packet)
944 {
ab1469a0 945 Clear();
60a245d1 946 for (uint8_t iPtr = 0; iPtr < packet.size; iPtr++)
ab1469a0 947 PushBack(packet[iPtr]);
60a245d1
LOK
948
949 return *this;
950 }
951
6b4d1b3a
LOK
952 bool operator ==(const struct cec_datapacket& packet) const
953 {
954 if (size != packet.size)
955 return false;
956 for (uint8_t iPtr = 0; iPtr < size; iPtr++)
957 if (packet.data[iPtr] != data[iPtr])
958 return false;
959 return true;
960 }
961
f1f91c81
LOK
962 bool IsEmpty(void) const { return size == 0; } /**< @return True when this packet is empty, false otherwise. */
963 bool IsFull(void) const { return size == 100; } /**< @return True when this packet is false, false otherwise. */
964
965 /*!
966 * @brief Get the byte at the requested position.
967 * @param pos The position.
968 * @return The byte, or 0 when out of bounds.
969 */
acec5f48 970 uint8_t operator[](uint8_t pos) const { return pos < size ? data[pos] : 0; }
f1f91c81
LOK
971 /*!
972 * @brief Get the byte at the requested position.
973 * @param pos The position.
974 * @return The byte, or 0 when out of bounds.
975 */
ab1469a0 976 uint8_t At(uint8_t pos) const { return pos < size ? data[pos] : 0; }
acec5f48 977
f1f91c81
LOK
978 /*!
979 * @brief Shift the contents of this packet.
980 * @param iShiftBy The number of positions to shift.
981 */
ab1469a0 982 void Shift(uint8_t iShiftBy)
acec5f48
LOK
983 {
984 if (iShiftBy >= size)
985 {
ab1469a0 986 Clear();
acec5f48
LOK
987 }
988 else
989 {
990 for (uint8_t iPtr = 0; iPtr < size; iPtr++)
991 data[iPtr] = (iPtr + iShiftBy < size) ? data[iPtr + iShiftBy] : 0;
992 size = (uint8_t) (size - iShiftBy);
993 }
994 }
995
f1f91c81
LOK
996 /*!
997 * @brief Push a byte to the end of this packet.
998 * @param add The byte to add.
999 */
ab1469a0 1000 void PushBack(uint8_t add)
acec5f48
LOK
1001 {
1002 if (size < 100)
1003 data[size++] = add;
1004 }
1005
f1f91c81
LOK
1006 /*!
1007 * @brief Clear this packet.
1008 */
ab1469a0 1009 void Clear(void)
acec5f48
LOK
1010 {
1011 memset(data, 0, sizeof(data));
1012 size = 0;
1013 }
1014#endif
1015
1016} cec_datapacket;
1017
acec5f48
LOK
1018typedef struct cec_command
1019{
8d901fdb
LOK
1020 cec_logical_address initiator; /**< the logical address of the initiator of this message */
1021 cec_logical_address destination; /**< the logical address of the destination of this message */
1022 int8_t ack; /**< 1 when the ACK bit is set, 0 otherwise */
1023 int8_t eom; /**< 1 when the EOM bit is set, 0 otherwise */
1024 cec_opcode opcode; /**< the opcode of this message */
1025 cec_datapacket parameters; /**< the parameters attached to this message */
1026 int8_t opcode_set; /**< 1 when an opcode is set, 0 otherwise (POLL message) */
1027 int32_t transmit_timeout; /**< the timeout to use in ms */
acec5f48
LOK
1028
1029#ifdef __cplusplus
2d4e263c
LOK
1030 cec_command(void)
1031 {
1032 Clear();
1033 }
a928fcdc 1034
60a245d1
LOK
1035 cec_command &operator =(const struct cec_command &command)
1036 {
1037 initiator = command.initiator;
1038 destination = command.destination;
1039 ack = command.ack;
1040 eom = command.eom;
1041 opcode = command.opcode;
1042 opcode_set = command.opcode_set;
1043 transmit_timeout = command.transmit_timeout;
1044 parameters = command.parameters;
1045
1046 return *this;
1047 }
1048
f1f91c81
LOK
1049 /*!
1050 * @brief Formats a cec_command.
1051 * @param command The command to format.
1052 * @param initiator The logical address of the initiator.
1053 * @param destination The logical addres of the destination.
1054 * @param opcode The opcode of the command.
1055 * @param timeout The transmission timeout.
1056 */
ae693aaa 1057 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 1058 {
ab1469a0 1059 command.Clear();
caaf64d7
LOK
1060 command.initiator = initiator;
1061 command.destination = destination;
1062 command.transmit_timeout = timeout;
57f45e6c
LOK
1063 if (opcode != CEC_OPCODE_NONE)
1064 {
1065 command.opcode = opcode;
1066 command.opcode_set = 1;
1067 }
acec5f48
LOK
1068 }
1069
f1f91c81
LOK
1070 /*!
1071 * @brief Push a byte to the back of this command.
1072 * @param data The byte to push.
1073 */
ab1469a0 1074 void PushBack(uint8_t data)
acec5f48 1075 {
b2da2768
LOK
1076 if (initiator == CECDEVICE_UNKNOWN && destination == CECDEVICE_UNKNOWN)
1077 {
1078 initiator = (cec_logical_address) (data >> 4);
1079 destination = (cec_logical_address) (data & 0xF);
1080 }
1081 else if (!opcode_set)
acec5f48 1082 {
02ee2c68 1083 opcode_set = 1;
acec5f48
LOK
1084 opcode = (cec_opcode) data;
1085 }
1086 else
ab1469a0 1087 parameters.PushBack(data);
acec5f48
LOK
1088 }
1089
f1f91c81
LOK
1090 /*!
1091 * @brief Clear this command, resetting everything to the default values.
1092 */
ab1469a0 1093 void Clear(void)
acec5f48 1094 {
1f0e9e0f
LOK
1095 initiator = CECDEVICE_UNKNOWN;
1096 destination = CECDEVICE_UNKNOWN;
1097 ack = 0;
1098 eom = 0;
1099 opcode_set = 0;
1100 opcode = CEC_OPCODE_FEATURE_ABORT;
ae693aaa 1101 transmit_timeout = CEC_DEFAULT_TRANSMIT_TIMEOUT;
ab1469a0 1102 parameters.Clear();
acec5f48 1103 };
24d82513
LOK
1104
1105 static cec_opcode GetResponseOpcode(cec_opcode opcode)
1106 {
1107 switch (opcode)
1108 {
1109 case CEC_OPCODE_REQUEST_ACTIVE_SOURCE:
1110 return CEC_OPCODE_ACTIVE_SOURCE;
1111 case CEC_OPCODE_GET_CEC_VERSION:
1112 return CEC_OPCODE_CEC_VERSION;
1113 case CEC_OPCODE_GIVE_PHYSICAL_ADDRESS:
1114 return CEC_OPCODE_REPORT_PHYSICAL_ADDRESS;
1115 case CEC_OPCODE_GET_MENU_LANGUAGE:
1116 return CEC_OPCODE_SET_MENU_LANGUAGE;
1117 case CEC_OPCODE_GIVE_DECK_STATUS:
1118 return CEC_OPCODE_DECK_STATUS;
1119 case CEC_OPCODE_GIVE_TUNER_DEVICE_STATUS:
1120 return CEC_OPCODE_TUNER_DEVICE_STATUS;
1121 case CEC_OPCODE_GIVE_DEVICE_VENDOR_ID:
1122 return CEC_OPCODE_DEVICE_VENDOR_ID;
1123 case CEC_OPCODE_GIVE_OSD_NAME:
4fde2fd0 1124 return CEC_OPCODE_SET_OSD_NAME;
24d82513
LOK
1125 case CEC_OPCODE_MENU_REQUEST:
1126 return CEC_OPCODE_MENU_STATUS;
1127 case CEC_OPCODE_GIVE_DEVICE_POWER_STATUS:
1128 return CEC_OPCODE_REPORT_POWER_STATUS;
1129 case CEC_OPCODE_GIVE_AUDIO_STATUS:
1130 return CEC_OPCODE_REPORT_AUDIO_STATUS;
1131 case CEC_OPCODE_GIVE_SYSTEM_AUDIO_MODE_STATUS:
1132 return CEC_OPCODE_SYSTEM_AUDIO_MODE_STATUS;
1133 case CEC_OPCODE_SYSTEM_AUDIO_MODE_REQUEST:
1134 return CEC_OPCODE_SET_SYSTEM_AUDIO_MODE;
1135 default:
1136 break;
1137 }
1138
4fde2fd0 1139 return CEC_OPCODE_NONE;
24d82513 1140 }
0b7822f9
LOK
1141
1142 void PushArray(size_t len, uint8_t *data)
1143 {
1144 for (size_t iPtr = 0; iPtr < len; iPtr++)
1145 PushBack(data[iPtr]);
1146 }
acec5f48
LOK
1147#endif
1148} cec_command;
1149
5ae8fa48 1150typedef struct cec_device_type_list
acec5f48 1151{
8d901fdb 1152 cec_device_type types[5]; /**< the list of device types */
0500da96 1153
5ae8fa48 1154#ifdef __cplusplus
f1f91c81
LOK
1155 /*!
1156 * @brief Clear this list.
1157 */
c23380e7 1158 void Clear(void)
5ae8fa48
LOK
1159 {
1160 for (unsigned int iPtr = 0; iPtr < 5; iPtr++)
1161 types[iPtr] = CEC_DEVICE_TYPE_RESERVED;
1162 }
eafd9bed 1163
f1f91c81
LOK
1164 /*!
1165 * @brief Add a type to this list.
1166 * @param type The type to add.
1167 */
c23380e7 1168 void Add(const cec_device_type type)
5ae8fa48
LOK
1169 {
1170 for (unsigned int iPtr = 0; iPtr < 5; iPtr++)
1171 {
1172 if (types[iPtr] == CEC_DEVICE_TYPE_RESERVED)
1173 {
1174 types[iPtr] = type;
1175 break;
1176 }
1177 }
1178 }
1179
f1f91c81
LOK
1180 /*!
1181 * @brief Check whether a type is set in this list.
1182 * @param type The type to check.
1183 * @return True when set, false otherwise.
1184 */
c30acafa 1185 bool IsSet(cec_device_type type)
5ae8fa48
LOK
1186 {
1187 bool bReturn(false);
1188 for (unsigned int iPtr = 0; !bReturn && iPtr < 5; iPtr++)
1189 {
1190 if (types[iPtr] == type)
1191 bReturn = true;
1192 }
1193 return bReturn;
1194 }
1195
f1f91c81
LOK
1196 /*!
1197 * @return True when this list is empty, false otherwise.
1198 */
7c5c5bf4 1199 bool IsEmpty() const
5ae8fa48
LOK
1200 {
1201 bool bReturn(true);
1202 for (unsigned int iPtr = 0; bReturn && iPtr < 5; iPtr++)
1203 {
1204 if (types[iPtr] != CEC_DEVICE_TYPE_RESERVED)
1205 bReturn = false;
1206 }
1207 return bReturn;
1208 }
1209
f1f91c81
LOK
1210 /*!
1211 * @brief Get the type at the requested position.
1212 * @param pos The position.
1213 * @return The type, or CEC_DEVICE_TYPE_RESERVED when out of bounds.
1214 */
5ae8fa48 1215 cec_device_type operator[](uint8_t pos) const { return pos < 5 ? types[pos] : CEC_DEVICE_TYPE_RESERVED; }
f1f91c81 1216
30b4aac0
LOK
1217 bool operator==(const cec_device_type_list &other) const
1218 {
1219 bool bEqual(true);
1220 for (uint8_t iPtr = 0; iPtr < 5; iPtr++)
1221 bEqual &= (types[iPtr] == other[iPtr]);
1222 return bEqual;
1223 }
1224
1225 bool operator!=(const cec_device_type_list &other) const
1226 {
1227 return !(*this == other);
1228 }
5ae8fa48
LOK
1229#endif
1230} cec_device_type_list;
1231
1232typedef struct cec_logical_addresses
1233{
8d901fdb
LOK
1234 cec_logical_address primary; /**< the primary logical address to use */
1235 int addresses[16]; /**< the list of addresses */
5ae8fa48
LOK
1236
1237#ifdef __cplusplus
f1f91c81
LOK
1238 /*!
1239 * @brief Clear this list.
1240 */
5ae8fa48
LOK
1241 void Clear(void)
1242 {
004b8382 1243 primary = CECDEVICE_UNREGISTERED;
5ae8fa48
LOK
1244 for (unsigned int iPtr = 0; iPtr < 16; iPtr++)
1245 addresses[iPtr] = 0;
1246 }
1247
f1f91c81
LOK
1248 /*!
1249 * @return True when empty, false otherwise.
1250 */
5ae8fa48
LOK
1251 bool IsEmpty(void) const
1252 {
004b8382 1253 return primary == CECDEVICE_UNREGISTERED;
5ae8fa48
LOK
1254 }
1255
f1f91c81
LOK
1256 /*!
1257 * @brief Calculate the ack-mask for this list, the mask to use when determining whether to send an ack message or not.
1258 * @return The ack-mask.
1259 */
5ae8fa48
LOK
1260 uint16_t AckMask(void) const
1261 {
1262 uint16_t mask = 0;
1263 for (unsigned int iPtr = 0; iPtr < 16; iPtr++)
1264 if (addresses[iPtr] == 1)
1265 mask |= 0x1 << iPtr;
1266 return mask;
1267 }
1268
f1f91c81
LOK
1269 /*!
1270 * @brief Mark a logical address as 'set'
1271 * @param address The logical address to add to this list.
1272 */
5ae8fa48
LOK
1273 void Set(cec_logical_address address)
1274 {
004b8382 1275 if (primary == CECDEVICE_UNREGISTERED)
5ae8fa48
LOK
1276 primary = address;
1277
1278 addresses[(int) address] = 1;
1279 }
1280
f1f91c81
LOK
1281 /*!
1282 * @brief Mark a logical address as 'unset'
1283 * @param address The logical address to remove from this list.
1284 */
004b8382 1285 void Unset(const cec_logical_address address)
5ae8fa48
LOK
1286 {
1287 if (primary == address)
004b8382 1288 primary = CECDEVICE_UNREGISTERED;
5ae8fa48
LOK
1289
1290 addresses[(int) address] = 0;
1291 }
1292
f1f91c81
LOK
1293 /*!
1294 * @brief Check whether an address is set in this list.
1295 * @param address The address to check.
1296 * @return True when set, false otherwise.
1297 */
c30acafa 1298 bool IsSet(cec_logical_address address) const { return addresses[(int) address] == 1; }
f1f91c81
LOK
1299
1300 /*!
1301 * @brief Check whether an address is set in this list.
1302 * @param pos The address to check.
1303 * @return True when set, false otherwise.
1304 */
5ae8fa48 1305 bool operator[](uint8_t pos) const { return pos < 16 ? IsSet((cec_logical_address) pos) : false; }
30b4aac0
LOK
1306
1307 bool operator==(const cec_logical_addresses &other) const
1308 {
1309 bool bEqual(true);
1310 for (uint8_t iPtr = 0; iPtr < 16; iPtr++)
1311 bEqual &= ((addresses[(int)iPtr] == 1) == other[iPtr]);
1312 return bEqual;
1313 }
1314
1315 bool operator!=(const cec_logical_addresses &other) const
1316 {
1317 return !(*this == other);
1318 }
5ae8fa48
LOK
1319#endif
1320} cec_logical_addresses;
acec5f48 1321
5ee37222
MK
1322typedef enum libcec_alert
1323{
b1c47f9d 1324 CEC_ALERT_SERVICE_DEVICE,
7068f331
LOK
1325 CEC_ALERT_CONNECTION_LOST,
1326 CEC_ALERT_PERMISSION_ERROR,
7e312a79 1327 CEC_ALERT_PORT_BUSY,
237d091c
LOK
1328 CEC_ALERT_PHYSICAL_ADDRESS_ERROR,
1329 CEC_ALERT_TV_POLL_FAILED
5ee37222
MK
1330} libcec_alert;
1331
1332typedef enum libcec_parameter_type
1333{
5daed059
LOK
1334 CEC_PARAMETER_TYPE_STRING,
1335 CEC_PARAMETER_TYPE_UNKOWN
5ee37222
MK
1336} libcec_parameter_type;
1337
dbe84b6e 1338typedef struct libcec_parameter
5ee37222 1339{
8d901fdb
LOK
1340 libcec_parameter_type paramType; /**< the type of this parameter */
1341 void* paramData; /**< the value of this parameter */
dbe84b6e 1342} libcec_parameter;
5ee37222 1343
dbe84b6e 1344typedef struct libcec_configuration libcec_configuration;
32403cc3 1345
3ad0aa0a
LOK
1346typedef int (CEC_CDECL* CBCecLogMessageType)(void*, const cec_log_message);
1347typedef int (CEC_CDECL* CBCecKeyPressType)(void*, const cec_keypress);
1348typedef int (CEC_CDECL* CBCecCommandType)(void*, const cec_command);
1349typedef int (CEC_CDECL* CBCecConfigurationChangedType)(void*, const libcec_configuration);
1350typedef int (CEC_CDECL* CBCecAlertType)(void*, const libcec_alert, const libcec_parameter);
1351typedef int (CEC_CDECL* CBCecMenuStateChangedType)(void*, const cec_menu_state);
1352typedef void (CEC_CDECL* CBCecSourceActivatedType)(void*, const cec_logical_address, const uint8_t);
c3039d2e
LOK
1353
1354typedef struct ICECCallbacks
fa4798bd
LOK
1355{
1356 /*!
1357 * @brief Transfer a log message from libCEC to the client.
1358 * @param message The message to transfer.
1359 * @return 1 when ok, 0 otherwise.
1360 */
c3039d2e 1361 CBCecLogMessageType CBCecLogMessage;
fa4798bd
LOK
1362
1363 /*!
1364 * @brief Transfer a keypress from libCEC to the client.
1365 * @param key The keypress to transfer.
1366 * @return 1 when ok, 0 otherwise.
1367 */
c3039d2e 1368 CBCecKeyPressType CBCecKeyPress;
fa4798bd
LOK
1369
1370 /*!
1371 * @brief Transfer a CEC command from libCEC to the client.
1372 * @param command The command to transfer.
1373 * @return 1 when ok, 0 otherwise.
1374 */
c3039d2e 1375 CBCecCommandType CBCecCommand;
32403cc3
LOK
1376
1377 /*!
1378 * @brief Transfer a changed configuration from libCEC to the client
1379 * @param configuration The configuration to transfer
1380 * @return 1 when ok, 0 otherwise
1381 */
1382 CBCecConfigurationChangedType CBCecConfigurationChanged;
5ee37222
MK
1383
1384 /*!
8d901fdb
LOK
1385 * @brief Transfer a libcec alert message from libCEC to the client
1386 * @param alert The alert type transfer.
1387 * @param data Misc. additional information.
5ee37222
MK
1388 * @return 1 when ok, 0 otherwise
1389 */
1390 CBCecAlertType CBCecAlert;
e1804a4e
LOK
1391
1392 /*!
c3ce6b47
LOK
1393 * @brief Transfer a menu state change to the client.
1394 * Transfer a menu state change to the client. If the command returns 1, then the change will be processed by
e1804a4e 1395 * the busdevice. If 0, then the state of the busdevice won't be changed, and will always be kept 'activated',
6ad51ff5 1396 * @warning CEC does not allow the player to suppress the menu state change on the TV, so the menu on the TV will always be displayed, whatever the return value of this method is.
e1804a4e
LOK
1397 * so keypresses are always routed.
1398 * @param newVal The new value.
6ad51ff5 1399 * @return 1 when libCEC should use this new value, 0 otherwise.
e1804a4e 1400 */
c3ce6b47 1401 CBCecMenuStateChangedType CBCecMenuStateChanged;
e1804a4e 1402
29d5198c
LOK
1403 /*!
1404 * @brief Called when a source that's handled by this client is activated.
1405 * @param logicalAddress The address that was just activated.
1406 * @param bActivated 1 when activated, 0 when deactivated.
1407 */
1408 CBCecSourceActivatedType CBCecSourceActivated;
1409
e1804a4e 1410#ifdef __cplusplus
2d4e263c
LOK
1411 ICECCallbacks(void) { Clear(); }
1412 ~ICECCallbacks(void) { Clear(); };
e1804a4e
LOK
1413
1414 void Clear(void)
1415 {
1416 CBCecLogMessage = NULL;
1417 CBCecKeyPress = NULL;
1418 CBCecCommand = NULL;
1419 CBCecConfigurationChanged = NULL;
1420 CBCecAlert = NULL;
c3ce6b47 1421 CBCecMenuStateChanged = NULL;
29d5198c 1422 CBCecSourceActivated = NULL;
e1804a4e
LOK
1423 }
1424#endif
c3039d2e 1425} ICECCallbacks;
fa4798bd 1426
caca2d81
LOK
1427typedef enum cec_client_version
1428{
1429 CEC_CLIENT_VERSION_PRE_1_5 = 0,
41e3372a 1430 CEC_CLIENT_VERSION_1_5_0 = 0x1500,
2e82cff0 1431 CEC_CLIENT_VERSION_1_5_1 = 0x1501,
dd18e809
LOK
1432 CEC_CLIENT_VERSION_1_5_2 = 0x1502,
1433 CEC_CLIENT_VERSION_1_5_3 = 0x1503,
e4a7396c 1434 CEC_CLIENT_VERSION_1_6_0 = 0x1600,
3ef17606 1435 CEC_CLIENT_VERSION_1_6_1 = 0x1601,
5f2f3609 1436 CEC_CLIENT_VERSION_1_6_2 = 0x1602,
0a61dc24 1437 CEC_CLIENT_VERSION_1_6_3 = 0x1603,
92eea1e7 1438 CEC_CLIENT_VERSION_1_7_0 = 0x1700,
2b44051c
LOK
1439 CEC_CLIENT_VERSION_1_7_1 = 0x1701,
1440 CEC_CLIENT_VERSION_1_7_2 = 0x1702,
7e316a2f 1441 CEC_CLIENT_VERSION_1_8_0 = 0x1800,
2d418322 1442 CEC_CLIENT_VERSION_1_8_1 = 0x1801,
1664420d 1443 CEC_CLIENT_VERSION_1_8_2 = 0x1802,
f81c0652
LOK
1444 CEC_CLIENT_VERSION_1_9_0 = 0x1900,
1445 CEC_CLIENT_VERSION_1_99_0 = 0x1990,
999665e3 1446 CEC_CLIENT_VERSION_2_0_0 = 0x2000,
20fd14a9 1447 CEC_CLIENT_VERSION_2_0_1 = 0x2001,
784a6a79 1448 CEC_CLIENT_VERSION_2_0_2 = 0x2002,
83715833 1449 CEC_CLIENT_VERSION_2_0_3 = 0x2003,
0c271bd0 1450 CEC_CLIENT_VERSION_2_0_4 = 0x2004,
ac3f9901 1451 CEC_CLIENT_VERSION_2_0_5 = 0x2005,
9b56a19a 1452 CEC_CLIENT_VERSION_2_1_0 = 0x2100,
331d659e 1453 CEC_CLIENT_VERSION_2_1_1 = 0x2101,
b53bfc2d
LOK
1454 CEC_CLIENT_VERSION_2_1_2 = 0x2102,
1455 CEC_CLIENT_VERSION_2_1_3 = 0x2103,
7cb1f563 1456 CEC_CLIENT_VERSION_2_1_4 = 0x2104,
b5d801b8
LOK
1457 CEC_CLIENT_VERSION_2_2_0 = 0x2200,
1458 CEC_CLIENT_VERSION_CURRENT = 0x2200
caca2d81
LOK
1459} cec_client_version;
1460
3efda01a
LOK
1461typedef enum cec_server_version
1462{
1463 CEC_SERVER_VERSION_PRE_1_5 = 0,
41e3372a 1464 CEC_SERVER_VERSION_1_5_0 = 0x1500,
2e82cff0 1465 CEC_SERVER_VERSION_1_5_1 = 0x1501,
dd18e809 1466 CEC_SERVER_VERSION_1_5_2 = 0x1502,
e69d8f19 1467 CEC_SERVER_VERSION_1_5_3 = 0x1503,
e4a7396c 1468 CEC_SERVER_VERSION_1_6_0 = 0x1600,
0b714871 1469 CEC_SERVER_VERSION_1_6_1 = 0x1601,
5f2f3609 1470 CEC_SERVER_VERSION_1_6_2 = 0x1602,
0a61dc24 1471 CEC_SERVER_VERSION_1_6_3 = 0x1603,
92eea1e7 1472 CEC_SERVER_VERSION_1_7_0 = 0x1700,
2b44051c
LOK
1473 CEC_SERVER_VERSION_1_7_1 = 0x1701,
1474 CEC_SERVER_VERSION_1_7_2 = 0x1702,
7e316a2f 1475 CEC_SERVER_VERSION_1_8_0 = 0x1800,
2d418322 1476 CEC_SERVER_VERSION_1_8_1 = 0x1801,
1664420d 1477 CEC_SERVER_VERSION_1_8_2 = 0x1802,
f81c0652
LOK
1478 CEC_SERVER_VERSION_1_9_0 = 0x1900,
1479 CEC_SERVER_VERSION_1_99_0 = 0x1990,
999665e3 1480 CEC_SERVER_VERSION_2_0_0 = 0x2000,
20fd14a9 1481 CEC_SERVER_VERSION_2_0_1 = 0x2001,
784a6a79 1482 CEC_SERVER_VERSION_2_0_2 = 0x2002,
83715833 1483 CEC_SERVER_VERSION_2_0_3 = 0x2003,
0c271bd0 1484 CEC_SERVER_VERSION_2_0_4 = 0x2004,
ac3f9901 1485 CEC_SERVER_VERSION_2_0_5 = 0x2005,
9b56a19a 1486 CEC_SERVER_VERSION_2_1_0 = 0x2100,
331d659e 1487 CEC_SERVER_VERSION_2_1_1 = 0x2101,
b53bfc2d
LOK
1488 CEC_SERVER_VERSION_2_1_2 = 0x2102,
1489 CEC_SERVER_VERSION_2_1_3 = 0x2103,
7cb1f563 1490 CEC_SERVER_VERSION_2_1_4 = 0x2104,
b5d801b8 1491 CEC_SERVER_VERSION_2_2_0 = 0x2200,
35c541bc 1492 CEC_SERVER_VERSION_CURRENT = 0x2200
3efda01a
LOK
1493} cec_server_version;
1494
dbe84b6e 1495struct libcec_configuration
caca2d81 1496{
3efda01a 1497 uint32_t clientVersion; /*!< the version of the client that is connecting */
f81c0652
LOK
1498 char strDeviceName[13]; /*!< the device name to use on the CEC bus */
1499 cec_device_type_list deviceTypes; /*!< the device type(s) to use on the CEC bus for libCEC */
20be20ea 1500 uint8_t bAutodetectAddress; /*!< (read only) set to 1 by libCEC when the physical address was autodetected */
f81c0652
LOK
1501 uint16_t iPhysicalAddress; /*!< the physical address of the CEC adapter */
1502 cec_logical_address baseDevice; /*!< the logical address of the device to which the adapter is connected. only used when iPhysicalAddress = 0 or when the adapter doesn't support autodetection */
1503 uint8_t iHDMIPort; /*!< the HDMI port to which the adapter is connected. only used when iPhysicalAddress = 0 or when the adapter doesn't support autodetection */
3efda01a 1504 uint64_t tvVendor; /*!< override the vendor ID of the TV. leave this untouched to autodetect */
f81c0652
LOK
1505 cec_logical_addresses wakeDevices; /*!< list of devices to wake when initialising libCEC or when calling PowerOnDevices() without any parameter. */
1506 cec_logical_addresses powerOffDevices; /*!< list of devices to power off when calling StandbyDevices() without any parameter. */
224ea877 1507
c9549d35 1508 uint32_t serverVersion; /*!< the version number of the server. read-only */
3efda01a 1509
224ea877 1510 // player specific settings
d068b3d4
LOK
1511 uint8_t bGetSettingsFromROM; /*!< true to get the settings from the ROM (if set, and a v2 ROM is present), false to use these settings. */
1512 uint8_t bUseTVMenuLanguage; /*!< use the menu language of the TV in the player application */
ca27e6cf 1513 uint8_t bActivateSource; /*!< make libCEC the active source on the bus when starting the player application */
d068b3d4 1514 uint8_t bPowerOffScreensaver; /*!< put devices in standby mode when activating the screensaver */
d18ea27b 1515 uint8_t bPowerOnScreensaver; /*!< wake devices when deactivating the screensaver */
fa4b80df 1516 uint8_t bPowerOffOnStandby; /*!< put this PC in standby mode when the TV is switched off. only used when bShutdownOnStandby = 0 */
41e3372a 1517 uint8_t bSendInactiveSource; /*!< send an 'inactive source' message when stopping the player. added in 1.5.1 */
caca2d81 1518
d068b3d4
LOK
1519 void * callbackParam; /*!< the object to pass along with a call of the callback methods. NULL to ignore */
1520 ICECCallbacks * callbacks; /*!< the callback methods to use. set this to NULL when not using callbacks */
caca2d81 1521
20be20ea
LOK
1522 cec_logical_addresses logicalAddresses; /*!< (read-only) the current logical addresses. added in 1.5.3 */
1523 uint16_t iFirmwareVersion; /*!< (read-only) the firmware version of the adapter. added in 1.6.0 */
b98fc43d 1524 uint8_t bPowerOffDevicesOnStandby; /*!< put devices in standby when the PC/player is put in standby. added in 1.6.0 */
fa4b80df 1525 uint8_t bShutdownOnStandby; /*!< shutdown this PC when the TV is switched off. only used when bPowerOffOnStandby = 0. added in 1.6.0 */
7f274e72 1526 char strDeviceLanguage[3]; /*!< the menu language used by the client. 3 character ISO 639-2 country code. see http://http://www.loc.gov/standards/iso639-2/ added in 1.6.2 */
20be20ea 1527 uint32_t iFirmwareBuildDate; /*!< (read-only) the build date of the firmware, in seconds since epoch. if not available, this value will be set to 0. added in 1.6.2 */
5f2f3609 1528 uint8_t bMonitorOnly; /*!< won't allocate a CCECClient when starting the connection when set (same as monitor mode). added in 1.6.3 */
2b44051c 1529 cec_version cecVersion; /*!< CEC spec version to use by libCEC. defaults to v1.4. added in 1.8.0 */
2d418322 1530 cec_adapter_type adapterType; /*!< type of the CEC adapter that we're connected to. added in 1.8.2 */
5d7960cb 1531 uint8_t iDoubleTapTimeout50Ms; /*!< prevent double taps withing this timeout, in units of 50ms. defaults to 200ms (value: 4). added in 2.0.0,
8d84f8b3 1532 XXX changed meaning in 2.2.0 to not break binary compatibility. next major (3.0) release will fix it in a nicer way */
ac3f9901
LOK
1533 cec_user_control_code comboKey; /*!< key code that initiates combo keys. defaults to CEC_USER_CONTROL_CODE_F1_BLUE. CEC_USER_CONTROL_CODE_UNKNOWN to disable. added in 2.0.5 */
1534 uint32_t iComboKeyTimeoutMs; /*!< timeout until the combo key is sent as normal keypress */
dd18e809 1535
caca2d81 1536#ifdef __cplusplus
2d4e263c
LOK
1537 libcec_configuration(void) { Clear(); }
1538 ~libcec_configuration(void) { Clear(); }
e1804a4e 1539
b9dd18f9
LOK
1540 bool operator==(const libcec_configuration &other) const
1541 {
89be86b1
LOK
1542 return ( clientVersion == other.clientVersion &&
1543 !strncmp(strDeviceName, other.strDeviceName, 13) &&
709adc4b
LOK
1544 deviceTypes == other.deviceTypes &&
1545 bAutodetectAddress == other.bAutodetectAddress &&
1546 iPhysicalAddress == other.iPhysicalAddress &&
1547 baseDevice == other.baseDevice &&
1548 iHDMIPort == other.iHDMIPort &&
1549 tvVendor == other.tvVendor &&
1550 wakeDevices == other.wakeDevices &&
1551 powerOffDevices == other.powerOffDevices &&
1552 serverVersion == other.serverVersion &&
1553 bGetSettingsFromROM == other.bGetSettingsFromROM &&
1554 bUseTVMenuLanguage == other.bUseTVMenuLanguage &&
1555 bActivateSource == other.bActivateSource &&
1556 bPowerOffScreensaver == other.bPowerOffScreensaver &&
1557 bPowerOffOnStandby == other.bPowerOffOnStandby &&
1558 bSendInactiveSource == other.bSendInactiveSource &&
1559 logicalAddresses == other.logicalAddresses &&
1560 iFirmwareVersion == other.iFirmwareVersion &&
1561 bPowerOffDevicesOnStandby == other.bPowerOffDevicesOnStandby &&
1562 bShutdownOnStandby == other.bShutdownOnStandby &&
89be86b1 1563 !strncmp(strDeviceLanguage, other.strDeviceLanguage, 3) &&
709adc4b
LOK
1564 iFirmwareBuildDate == other.iFirmwareBuildDate &&
1565 bMonitorOnly == other.bMonitorOnly &&
1566 cecVersion == other.cecVersion &&
1567 adapterType == other.adapterType &&
5d7960cb 1568 iDoubleTapTimeout50Ms == other.iDoubleTapTimeout50Ms &&
709adc4b
LOK
1569 (other.clientVersion <= CEC_CLIENT_VERSION_2_0_4 || comboKey == other.comboKey) &&
1570 (other.clientVersion <= CEC_CLIENT_VERSION_2_0_4 || iComboKeyTimeoutMs == other.iComboKeyTimeoutMs) &&
1571 (other.clientVersion < CEC_CLIENT_VERSION_2_1_0 || bPowerOnScreensaver == other.bPowerOnScreensaver));
b9dd18f9
LOK
1572 }
1573
1574 bool operator!=(const libcec_configuration &other) const
1575 {
1576 return !(*this == other);
1577 }
1578
f1f91c81
LOK
1579 /*!
1580 * @brief Reset this configution struct to the default values.
1581 */
caca2d81
LOK
1582 void Clear(void)
1583 {
d2d1660c 1584 iPhysicalAddress = CEC_PHYSICAL_ADDRESS_TV;
7f274e72
LOK
1585 baseDevice = (cec_logical_address)CEC_DEFAULT_BASE_DEVICE;
1586 iHDMIPort = CEC_DEFAULT_HDMI_PORT;
1587 tvVendor = (uint64_t)CEC_VENDOR_UNKNOWN;
ac3f9901
LOK
1588 clientVersion = (uint32_t)CEC_CLIENT_VERSION_CURRENT;
1589 serverVersion = (uint32_t)CEC_SERVER_VERSION_CURRENT;
20be20ea 1590 bAutodetectAddress = 0;
64ec6e79 1591 bGetSettingsFromROM = CEC_DEFAULT_SETTING_GET_SETTINGS_FROM_ROM;
7f274e72
LOK
1592 bUseTVMenuLanguage = CEC_DEFAULT_SETTING_USE_TV_MENU_LANGUAGE;
1593 bActivateSource = CEC_DEFAULT_SETTING_ACTIVATE_SOURCE;
1594 bPowerOffScreensaver = CEC_DEFAULT_SETTING_POWER_OFF_SCREENSAVER;
d18ea27b 1595 bPowerOnScreensaver = CEC_DEFAULT_SETTING_POWER_ON_SCREENSAVER;
7f274e72
LOK
1596 bPowerOffOnStandby = CEC_DEFAULT_SETTING_POWER_OFF_ON_STANDBY;
1597 bShutdownOnStandby = CEC_DEFAULT_SETTING_SHUTDOWN_ON_STANDBY;
1598 bSendInactiveSource = CEC_DEFAULT_SETTING_SEND_INACTIVE_SOURCE;
1599 iFirmwareVersion = CEC_FW_VERSION_UNKNOWN;
1600 bPowerOffDevicesOnStandby = CEC_DEFAULT_SETTING_POWER_OFF_DEVICES_STANDBY;
1601 memcpy(strDeviceLanguage, CEC_DEFAULT_DEVICE_LANGUAGE, 3);
d2d1660c 1602 iFirmwareBuildDate = CEC_FW_BUILD_UNKNOWN;
5f2f3609 1603 bMonitorOnly = 0;
2b44051c 1604 cecVersion = (cec_version)CEC_DEFAULT_SETTING_CEC_VERSION;
2d418322 1605 adapterType = ADAPTERTYPE_UNKNOWN;
5d7960cb 1606 iDoubleTapTimeout50Ms = CEC_DOUBLE_TAP_TIMEOUT_50_MS;
ac3f9901
LOK
1607 comboKey = CEC_USER_CONTROL_CODE_STOP;
1608 iComboKeyTimeoutMs = CEC_DEFAULT_COMBO_TIMEOUT_MS;
7f274e72 1609
caca2d81 1610 memset(strDeviceName, 0, 13);
2d4e263c 1611 deviceTypes.Clear();
7f274e72 1612 logicalAddresses.Clear();
d068b3d4 1613 wakeDevices.Clear();
ca27e6cf 1614 powerOffDevices.Clear();
224ea877 1615
ca27e6cf
LOK
1616 #if CEC_DEFAULT_SETTING_POWER_OFF_SHUTDOWN == 1
1617 powerOffDevices.Set(CECDEVICE_BROADCAST);
1618 #endif
41e3372a
LOK
1619 #if CEC_DEFAULT_SETTING_ACTIVATE_SOURCE == 1
1620 wakeDevices.Set(CECDEVICE_TV);
1621 #endif
224ea877 1622
7f274e72
LOK
1623 callbackParam = NULL;
1624 callbacks = NULL;
caca2d81
LOK
1625 }
1626#endif
dbe84b6e 1627};
caca2d81 1628
acec5f48
LOK
1629#ifdef __cplusplus
1630};
1631};
1632#endif
1633
1634#endif /* CECTYPES_H_ */