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