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