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