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