include/cectypes.h

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