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