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-2013 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 /*!
  65  * default physical address 1.0.0.0, HDMI port 1
  66  */
  67 #define CEC_DEFAULT_PHYSICAL_ADDRESS 0x1000
  68 /*!
  69  * default HDMI port to which the adapter is connected, port 1
  70  */
  71 #define CEC_DEFAULT_HDMI_PORT        1
  72 /*!
  73  * default logical address of the device to which the adapter is connected, TV
  74  */
  75 #define CEC_DEFAULT_BASE_DEVICE      0
  76
  77 /*!
  78  * timeout in milliseconds to send a key release event after receiving a key press
  79  */
  80 #define CEC_BUTTON_TIMEOUT           500
  81
  82 /*!
  83  * don't send the same key twice within this timeout in milliseconds
  84  */
  85 #define CEC_DOUBLE_TAP_TIMEOUT_MS    250
  86
  87 /*!
  88  * don't query the power state for the same device within this timeout in milliseconds
  89  */
  90 #define CEC_POWER_STATE_REFRESH_TIME 30000
  91
  92 /*!
  93  * unknown firmware version value
  94  */
  95 #define CEC_FW_VERSION_UNKNOWN       0xFFFF
  96
  97 /*!
  98  * unknown build date value
  99  */
 100 #define CEC_FW_BUILD_UNKNOWN         0
 101
 102 /*!
 103  * maximum number of retries when opening a connection
 104  */
 105 #define CEC_CONNECT_TRIES            3
 106
 107 /*!
 108  * physical address of the TV
 109  */
 110 #define CEC_PHYSICAL_ADDRESS_TV      0
 111
 112 /*!
 113  * minimum physical address for the adapter
 114  */
 115 #define CEC_MIN_PHYSICAL_ADDRESS     0x1000
 116
 117 /*!
 118  * maximum physical address for the adapter
 119  */
 120 #define CEC_MAX_PHYSICAL_ADDRESS     0xFFFE
 121
 122 /*!
 123  * invalid physical address value
 124  */
 125 #define CEC_INVALID_PHYSICAL_ADDRESS 0xFFFF
 126
 127 /*!
 128  * minimum vendor ID value
 129  */
 130 #define CEC_MIN_VENDORID             1
 131
 132 /*!
 133  * maximum vendor ID value
 134  */
 135 #define CEC_MAX_VENDORID             0xFFFFFE
 136
 137 /*!
 138  * invalid vendor ID value
 139  */
 140 #define CEC_INVALID_VENDORID         0xFFFFFF
 141
 142 /*!
 143  * minimum HDMI port number value
 144  */
 145 #define CEC_MIN_HDMI_PORTNUMBER      1
 146
 147 /*!
 148  * maximum HDMI port number value
 149  */
 150 #define CEC_MAX_HDMI_PORTNUMBER      15
 151
 152 /*!
 153  * invalid HDMI port number value
 154  */
 155 #define CEC_HDMI_PORTNUMBER_NONE     0
 156
 157 /*!
 158  * default value for settings "use tv menu language"
 159  */
 160 #define CEC_DEFAULT_SETTING_USE_TV_MENU_LANGUAGE      1
 161
 162 /*!
 163  * default value for settings "activate source"
 164  */
 165 #define CEC_DEFAULT_SETTING_ACTIVATE_SOURCE           1
 166
 167 /*!
 168  * default value for settings "power off on shutdown"
 169  */
 170 #define CEC_DEFAULT_SETTING_POWER_OFF_SHUTDOWN        1
 171
 172 /*!
 173  * default value for settings "power off when activating the screensaver"
 174  */
 175 #define CEC_DEFAULT_SETTING_POWER_OFF_SCREENSAVER     1
 176
 177 /*!
 178  * default value for settings "wake up when deactivating the screensaver"
 179  */
 180 #define CEC_DEFAULT_SETTING_POWER_ON_SCREENSAVER      1
 181
 182 /*!
 183  * default value for settings "power off on standby"
 184  */
 185 #define CEC_DEFAULT_SETTING_POWER_OFF_ON_STANDBY      1
 186
 187 /*!
 188  * default value for settings "shutdown on standby"
 189  */
 190 #define CEC_DEFAULT_SETTING_SHUTDOWN_ON_STANDBY       0
 191
 192 /*!
 193  * default value for settings "send inactive source when stopping"
 194  */
 195 #define CEC_DEFAULT_SETTING_SEND_INACTIVE_SOURCE      1
 196
 197 /*!
 198  * default value for settings "power off devices when going to standby"
 199  */
 200 #define CEC_DEFAULT_SETTING_POWER_OFF_DEVICES_STANDBY 1
 201
 202 /*!
 203  * default value for settings "device menu language"
 204  */
 205 #define CEC_DEFAULT_DEVICE_LANGUAGE                   "eng"
 206
 207 /*!
 208  * default value for settings "autodetect physical address"
 209  */
 210 #define CEC_DEFAULT_SETTING_AUTODETECT_ADDRESS        0
 211
 212 /*!
 213  * default value for settings "get settings from ROM"
 214  */
 215 #define CEC_DEFAULT_SETTING_GET_SETTINGS_FROM_ROM     0
 216
 217 /*!
 218  * default value for settings "libCEC CEC version"
 219  */
 220 #define CEC_DEFAULT_SETTING_CEC_VERSION               0x05
 221
 222 /*!
 223  * wait this amount of milliseconds before retrying to send a failed message
 224  */
 225 #define CEC_DEFAULT_TRANSMIT_RETRY_WAIT 500
 226
 227 /*!
 228  * transmission fails when not acked within this amount of milliseconds after sending the initial packet
 229  */
 230 #define CEC_DEFAULT_TRANSMIT_TIMEOUT    1000
 231
 232 /*!
 233  * wait this amount of milliseconds for an ack
 234  */
 235 #define CEC_DEFAULT_TRANSMIT_WAIT       1000
 236
 237 /*!
 238  * default number of retries
 239  */
 240 #define CEC_DEFAULT_TRANSMIT_RETRIES    1
 241
 242 /*!
 243  * default connection timeout in milliseconds
 244  */
 245 #define CEC_DEFAULT_CONNECT_TIMEOUT     10000
 246
 247 /*!
 248  * wait this amount of milliseconds before retrying when failing to connect
 249  */
 250 #define CEC_DEFAULT_CONNECT_RETRY_WAIT  1000
 251
 252 /*!
 253  * default serial baudrate
 254  */
 255 #define CEC_SERIAL_DEFAULT_BAUDRATE     38400
 256
 257 /*!
 258  * maximum time to wait when clearing input
 259  */
 260 #define CEC_CLEAR_INPUT_DEFAULT_WAIT    1000
 261
 262 /*!
 263  * wait this amount of milliseconds before retrying when libCEC failed to make itself the active source
 264  */
 265 #define CEC_ACTIVE_SOURCE_SWITCH_RETRY_TIME_MS 1000
 266
 267 /*!
 268  * don't forward any power off command to the client application for this amount of milliseconds after sending a power off command
 269  */
 270 #define CEC_FORWARD_STANDBY_MIN_INTERVAL 10000
 271
 272 /*!
 273  * default timeout in milliseconds for combo keys
 274  */
 275 #define CEC_DEFAULT_COMBO_TIMEOUT_MS 1000
 276
 277 /*!
 278  * the virtual device path to use for the Raspberry Pi's CEC wire
 279  */
 280 #define CEC_RPI_VIRTUAL_PATH           "Raspberry Pi"
 281
 282 /*!
 283  * the name of the virtual COM port to use for the Raspberry Pi's CEC wire
 284  */
 285 #define CEC_RPI_VIRTUAL_COM            "RPI"
 286
 287 /*!
 288  * the path to use for the TDA995x's CEC wire
 289  */
 290 #define CEC_TDA995x_PATH                "/dev/hdmicec"
 291
 292 /*!
 293  * the name of the virtual COM port to use for the TDA995x's CEC wire
 294  */
 295 #define CEC_TDA995x_VIRTUAL_COM         "CuBox"
 296
 297 /*!
 298  * the path to use for the Exynos HDMI CEC device
 299  */
 300 #define CEC_EXYNOS_PATH         "/dev/CEC"
 301
 302 /*!
 303  * the name of the virtual COM port to use for the EXYNOS' CEC wire
 304  */
 305 #define CEC_EXYNOS_VIRTUAL_COM          "Exynos"
 306
 307 /*!
 308  * Mimimum client version
 309  */
 310 #define CEC_MIN_LIB_VERSION          2
 311
 312 /*!
 313  * libCEC's major version number
 314  */
 315 #define CEC_LIB_VERSION_MAJOR        2
 316
 317 /*!
 318  * libCEC's major version number as string
 319  */
 320 #define CEC_LIB_VERSION_MAJOR_STR    "2"
 321
 322 /*!
 323  * libCEC's minor version number
 324  */
 325 #define CEC_LIB_VERSION_MINOR        1
 326
 327 #define MSGSTART                     0xFF
 328 #define MSGEND                       0xFE
 329 #define MSGESC                       0xFD
 330 #define ESCOFFSET                    3
 331
 332 // defines to make compile time checks for certain features easy
 333 #define CEC_FEATURE_CONFIGURABLE_COMBO_KEY 1
 334
 335 typedef enum cec_abort_reason
 336 {
 337   CEC_ABORT_REASON_UNRECOGNIZED_OPCODE            = 0,//!< CEC_ABORT_REASON_UNRECOGNIZED_OPCODE
 338   CEC_ABORT_REASON_NOT_IN_CORRECT_MODE_TO_RESPOND = 1,//!< CEC_ABORT_REASON_NOT_IN_CORRECT_MODE_TO_RESPOND
 339   CEC_ABORT_REASON_CANNOT_PROVIDE_SOURCE          = 2,//!< CEC_ABORT_REASON_CANNOT_PROVIDE_SOURCE
 340   CEC_ABORT_REASON_INVALID_OPERAND                = 3,//!< CEC_ABORT_REASON_INVALID_OPERAND
 341   CEC_ABORT_REASON_REFUSED                        = 4 //!< CEC_ABORT_REASON_REFUSED
 342 } cec_abort_reason;
 343
 344 typedef enum cec_analogue_broadcast_type
 345 {
 346   CEC_ANALOGUE_BROADCAST_TYPE_CABLE      = 0x00,
 347   CEC_ANALOGUE_BROADCAST_TYPE_SATELLITE  = 0x01,
 348   CEC_ANALOGUE_BROADCAST_TYPE_TERRESTIAL = 0x02
 349 } cec_analogue_broadcast_type;
 350
 351 typedef enum cec_audio_rate
 352 {
 353   CEC_AUDIO_RATE_RATE_CONTROL_OFF    = 0,
 354   CEC_AUDIO_RATE_STANDARD_RATE_100   = 1,
 355   CEC_AUDIO_RATE_FAST_RATE_MAX_101   = 2,
 356   CEC_AUDIO_RATE_SLOW_RATE_MIN_99    = 3,
 357   CEC_AUDIO_RATE_STANDARD_RATE_100_0 = 4,
 358   CEC_AUDIO_RATE_FAST_RATE_MAX_100_1 = 5,
 359   CEC_AUDIO_RATE_SLOW_RATE_MIN_99_9  = 6
 360 } cec_audio_rate;
 361
 362 typedef enum cec_audio_status
 363 {
 364   CEC_AUDIO_MUTE_STATUS_MASK      = 0x80,
 365   CEC_AUDIO_VOLUME_STATUS_MASK    = 0x7F,
 366   CEC_AUDIO_VOLUME_MIN            = 0x00,
 367   CEC_AUDIO_VOLUME_MAX            = 0x64,
 368   CEC_AUDIO_VOLUME_STATUS_UNKNOWN = 0x7F
 369 } cec_audio_status;
 370
 371 typedef enum cec_boolean
 372 {
 373   CEC_FALSE = 0,
 374   CEC_TRUE  = 1
 375 } cec_boolean;
 376
 377 typedef enum cec_version
 378 {
 379   CEC_VERSION_UNKNOWN = 0x00,
 380   CEC_VERSION_1_2     = 0x01,
 381   CEC_VERSION_1_2A    = 0x02,
 382   CEC_VERSION_1_3     = 0x03,
 383   CEC_VERSION_1_3A    = 0x04,
 384   CEC_VERSION_1_4     = 0x05
 385 } cec_version;
 386
 387 typedef enum cec_channel_identifier
 388 {
 389   CEC_CHANNEL_NUMBER_FORMAT_MASK = 0xFC000000,
 390   CEC_1_PART_CHANNEL_NUMBER      = 0x04000000,
 391   CEC_2_PART_CHANNEL_NUMBER      = 0x08000000,
 392   CEC_MAJOR_CHANNEL_NUMBER_MASK  = 0x3FF0000,
 393   CEC_MINOR_CHANNEL_NUMBER_MASK  = 0xFFFF
 394 } cec_channel_identifier;
 395
 396 typedef enum cec_deck_control_mode
 397 {
 398   CEC_DECK_CONTROL_MODE_SKIP_FORWARD_WIND   = 1,
 399   CEC_DECK_CONTROL_MODE_SKIP_REVERSE_REWIND = 2,
 400   CEC_DECK_CONTROL_MODE_STOP                = 3,
 401   CEC_DECK_CONTROL_MODE_EJECT               = 4
 402 } cec_deck_control_mode;
 403
 404 typedef enum cec_deck_info
 405 {
 406   CEC_DECK_INFO_PLAY                 = 0x11,
 407   CEC_DECK_INFO_RECORD               = 0x12,
 408   CEC_DECK_INFO_PLAY_REVERSE         = 0x13,
 409   CEC_DECK_INFO_STILL                = 0x14,
 410   CEC_DECK_INFO_SLOW                 = 0x15,
 411   CEC_DECK_INFO_SLOW_REVERSE         = 0x16,
 412   CEC_DECK_INFO_FAST_FORWARD         = 0x17,
 413   CEC_DECK_INFO_FAST_REVERSE         = 0x18,
 414   CEC_DECK_INFO_NO_MEDIA             = 0x19,
 415   CEC_DECK_INFO_STOP                 = 0x1A,
 416   CEC_DECK_INFO_SKIP_FORWARD_WIND    = 0x1B,
 417   CEC_DECK_INFO_SKIP_REVERSE_REWIND  = 0x1C,
 418   CEC_DECK_INFO_INDEX_SEARCH_FORWARD = 0x1D,
 419   CEC_DECK_INFO_INDEX_SEARCH_REVERSE = 0x1E,
 420   CEC_DECK_INFO_OTHER_STATUS         = 0x1F,
 421   CEC_DECK_INFO_OTHER_STATUS_LG      = 0x20
 422 } cec_deck_info;
 423
 424 typedef enum cec_device_type
 425 {
 426   CEC_DEVICE_TYPE_TV               = 0,
 427   CEC_DEVICE_TYPE_RECORDING_DEVICE = 1,
 428   CEC_DEVICE_TYPE_RESERVED         = 2,
 429   CEC_DEVICE_TYPE_TUNER            = 3,
 430   CEC_DEVICE_TYPE_PLAYBACK_DEVICE  = 4,
 431   CEC_DEVICE_TYPE_AUDIO_SYSTEM     = 5
 432 } cec_device_type;
 433
 434 typedef enum cec_display_control
 435 {
 436   CEC_DISPLAY_CONTROL_DISPLAY_FOR_DEFAULT_TIME = 0x00,
 437   CEC_DISPLAY_CONTROL_DISPLAY_UNTIL_CLEARED    = 0x40,
 438   CEC_DISPLAY_CONTROL_CLEAR_PREVIOUS_MESSAGE   = 0x80,
 439   CEC_DISPLAY_CONTROL_RESERVED_FOR_FUTURE_USE  = 0xC0
 440 } cec_display_control;
 441
 442 typedef enum cec_external_source_specifier
 443 {
 444   CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PLUG             = 4,
 445   CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PHYSICAL_ADDRESS = 5
 446 } cec_external_source_specifier;
 447
 448 typedef enum cec_menu_request_type
 449 {
 450   CEC_MENU_REQUEST_TYPE_ACTIVATE   = 0,
 451   CEC_MENU_REQUEST_TYPE_DEACTIVATE = 1,
 452   CEC_MENU_REQUEST_TYPE_QUERY      = 2
 453 } cec_menu_request_type;
 454
 455 typedef enum cec_menu_state
 456 {
 457   CEC_MENU_STATE_ACTIVATED   = 0,
 458   CEC_MENU_STATE_DEACTIVATED = 1
 459 } cec_menu_state;
 460
 461 typedef enum cec_play_mode
 462 {
 463   CEC_PLAY_MODE_PLAY_FORWARD              = 0x24,
 464   CEC_PLAY_MODE_PLAY_REVERSE              = 0x20,
 465   CEC_PLAY_MODE_PLAY_STILL                = 0x25,
 466   CEC_PLAY_MODE_FAST_FORWARD_MIN_SPEED    = 0x05,
 467   CEC_PLAY_MODE_FAST_FORWARD_MEDIUM_SPEED = 0x06,
 468   CEC_PLAY_MODE_FAST_FORWARD_MAX_SPEED    = 0x07,
 469   CEC_PLAY_MODE_FAST_REVERSE_MIN_SPEED    = 0x09,
 470   CEC_PLAY_MODE_FAST_REVERSE_MEDIUM_SPEED = 0x0A,
 471   CEC_PLAY_MODE_FAST_REVERSE_MAX_SPEED    = 0x0B,
 472   CEC_PLAY_MODE_SLOW_FORWARD_MIN_SPEED    = 0x15,
 473   CEC_PLAY_MODE_SLOW_FORWARD_MEDIUM_SPEED = 0x16,
 474   CEC_PLAY_MODE_SLOW_FORWARD_MAX_SPEED    = 0x17,
 475   CEC_PLAY_MODE_SLOW_REVERSE_MIN_SPEED    = 0x19,
 476   CEC_PLAY_MODE_SLOW_REVERSE_MEDIUM_SPEED = 0x1A,
 477   CEC_PLAY_MODE_SLOW_REVERSE_MAX_SPEED    = 0x1B
 478 } cec_play_mode;
 479
 480 typedef enum cec_power_status
 481 {
 482   CEC_POWER_STATUS_ON                          = 0x00,
 483   CEC_POWER_STATUS_STANDBY                     = 0x01,
 484   CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON = 0x02,
 485   CEC_POWER_STATUS_IN_TRANSITION_ON_TO_STANDBY = 0x03,
 486   CEC_POWER_STATUS_UNKNOWN                     = 0x99
 487 } cec_power_status;
 488
 489 typedef enum cec_record_source_type
 490 {
 491   CEC_RECORD_SOURCE_TYPE_OWN_SOURCE                = 1,
 492   CEC_RECORD_SOURCE_TYPE_DIGITAL_SERVICE           = 2,
 493   CEC_RECORD_SOURCE_TYPE_ANALOGUE_SERVICE          = 3,
 494   CEC_RECORD_SOURCE_TYPE_EXTERNAL_PLUS             = 4,
 495   CEC_RECORD_SOURCE_TYPE_EXTERNAL_PHYSICAL_ADDRESS = 5
 496 } cec_record_source_type;
 497
 498 typedef enum cec_record_status_info
 499 {
 500   CEC_RECORD_STATUS_INFO_RECORDING_CURRENTLY_SELECTED_SOURCE            = 0x01,
 501   CEC_RECORD_STATUS_INFO_RECORDING_DIGITAL_SERVICE                      = 0x02,
 502   CEC_RECORD_STATUS_INFO_RECORDING_ANALOGUE_SERVICE                     = 0x03,
 503   CEC_RECORD_STATUS_INFO_RECORDING_EXTERNAL_INPUT                       = 0x04,
 504   CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_DIGITAL_SERVICE  = 0x05,
 505   CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_ANALOGUE_SERVICE = 0x06,
 506   CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_SELECT_REQUIRED_SERVICE = 0x07,
 507   CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_PLUG_NUMBER      = 0x09,
 508   CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_ADDRESS          = 0x0A,
 509   CEC_RECORD_STATUS_INFO_NO_RECORDING_CA_SYSTEM_NOT_SUPPORTED           = 0x0B,
 510   CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_OR_INSUFFICIENT_ENTITLEMENTS   = 0x0C,
 511   CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ALLOWED_TO_COPY_SOURCE        = 0x0D,
 512   CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_FURTHER_COPIES_ALLOWED         = 0x0E,
 513   CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_MEDIA                          = 0x10,
 514   CEC_RECORD_STATUS_INFO_NO_RECORDING_PLAYING                           = 0x11,
 515   CEC_RECORD_STATUS_INFO_NO_RECORDING_ALREADY_RECORDING                 = 0x12,
 516   CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROTECTED                   = 0x13,
 517   CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_SOURCE_SIGNAL                  = 0x14,
 518   CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROBLEM                     = 0x15,
 519   CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ENOUGH_SPACE_AVAILABLE        = 0x16,
 520   CEC_RECORD_STATUS_INFO_NO_RECORDING_PARENTAL_LOCK_ON                  = 0x17,
 521   CEC_RECORD_STATUS_INFO_RECORDING_TERMINATED_NORMALLY                  = 0x1A,
 522   CEC_RECORD_STATUS_INFO_RECORDING_HAS_ALREADY_TERMINATED               = 0x1B,
 523   CEC_RECORD_STATUS_INFO_NO_RECORDING_OTHER_REASON                      = 0x1F
 524 } cec_record_status_info;
 525
 526 typedef enum cec_recording_sequence
 527 {
 528   CEC_RECORDING_SEQUENCE_SUNDAY    = 0x01,
 529   CEC_RECORDING_SEQUENCE_MONDAY    = 0x02,
 530   CEC_RECORDING_SEQUENCE_TUESDAY   = 0x04,
 531   CEC_RECORDING_SEQUENCE_WEDNESDAY = 0x08,
 532   CEC_RECORDING_SEQUENCE_THURSDAY  = 0x10,
 533   CEC_RECORDING_SEQUENCE_FRIDAY    = 0x20,
 534   CEC_RECORDING_SEQUENCE_SATURDAY  = 0x40,
 535   CEC_RECORDING_SEQUENCE_ONCE_ONLY = 0x00
 536 } cec_recording_sequence;
 537
 538 typedef enum cec_status_request
 539 {
 540   CEC_STATUS_REQUEST_ON   = 1,
 541   CEC_STATUS_REQUEST_OFF  = 2,
 542   CEC_STATUS_REQUEST_ONCE = 3
 543 } cec_status_request;
 544
 545 typedef enum cec_system_audio_status
 546 {
 547   CEC_SYSTEM_AUDIO_STATUS_OFF = 0,
 548   CEC_SYSTEM_AUDIO_STATUS_ON  = 1
 549 } cec_system_audio_status;
 550
 551 typedef enum cec_timer_cleared_status_data
 552 {
 553   CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_RECORDING         = 0x00,
 554   CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_MATCHING       = 0x01,
 555   CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_INF0_AVAILABLE = 0x02,
 556   CEC_TIMER_CLEARED_STATUS_DATA_TIMER_CLEARED                       = 0x80
 557 } cec_timer_cleared_status_data;
 558
 559 typedef enum cec_timer_overlap_warning
 560 {
 561   CEC_TIMER_OVERLAP_WARNING_NO_OVERLAP           = 0,
 562   CEC_TIMER_OVERLAP_WARNING_TIMER_BLOCKS_OVERLAP = 1
 563 } cec_timer_overlap_warning;
 564
 565 typedef enum cec_media_info
 566 {
 567   CEC_MEDIA_INFO_MEDIA_PRESENT_AND_NOT_PROTECTED = 0x00,
 568   CEC_MEDIA_INFO_MEDIA_PRESENT_BUT_PROTECTED     = 0x01,
 569   CEC_MEDIA_INFO_MEDIA_NOT_PRESENT               = 0x02,
 570   CEC_MEDIA_INFO_FUTURE_USE                      = 0x03
 571 } cec_media_info;
 572
 573 typedef enum cec_programmed_indicator
 574 {
 575   CEC_PROGRAMMED_INDICATOR_NOT_PROGRAMMED = 0,
 576   CEC_PROGRAMMED_INDICATOR_PROGRAMMED     = 1
 577 } cec_programmed_indicator;
 578
 579 typedef enum cec_programmed_info
 580 {
 581   CEC_PROGRAMMED_INFO_FUTURE_USE                               = 0x0,
 582   CEC_PROGRAMMED_INFO_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING     = 0x08,
 583   CEC_PROGRAMMED_INFO_NOT_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING = 0x09,
 584   CEC_PROGRAMMED_INFO_MAY_NOT_BE_ENOUGH_SPACE_AVAILABLE        = 0x0B,
 585   CEC_PROGRAMMED_INFO_NO_MEDIA_INFO_AVAILABLE                  = 0x0A
 586 } cec_programmed_info;
 587
 588 typedef enum cec_not_programmed_error_info
 589 {
 590   CEC_NOT_PROGRAMMED_ERROR_INFO_FUTURE_USE                         = 0x0,
 591   CEC_NOT_PROGRAMMED_ERROR_INFO_NO_FREE_TIMER_AVAILABLE            = 0x01,
 592   CEC_NOT_PROGRAMMED_ERROR_INFO_DATE_OUT_OF_RANGE                  = 0x02,
 593   CEC_NOT_PROGRAMMED_ERROR_INFO_RECORDING_SEQUENCE_ERROR           = 0x03,
 594   CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PLUG_NUMBER       = 0x04,
 595   CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PHYSICAL_ADDRESS  = 0x05,
 596   CEC_NOT_PROGRAMMED_ERROR_INFO_CA_SYSTEM_NOT_SUPPORTED            = 0x06,
 597   CEC_NOT_PROGRAMMED_ERROR_INFO_NO_OR_INSUFFICIENT_CA_ENTITLEMENTS = 0x07,
 598   CEC_NOT_PROGRAMMED_ERROR_INFO_DOES_NOT_SUPPORT_RESOLUTION        = 0x08,
 599   CEC_NOT_PROGRAMMED_ERROR_INFO_PARENTAL_LOCK_ON                   = 0x09,
 600   CEC_NOT_PROGRAMMED_ERROR_INFO_CLOCK_FAILURE                      = 0x0A,
 601   CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_START      = 0x0B,
 602   CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_END        = 0x0D,
 603   CEC_NOT_PROGRAMMED_ERROR_INFO_DUPLICATE_ALREADY_PROGRAMMED       = 0x0E
 604 } cec_not_programmed_error_info;
 605
 606 typedef enum cec_recording_flag
 607 {
 608   CEC_RECORDING_FLAG_NOT_BEING_USED_FOR_RECORDING = 0,
 609   CEC_RECORDING_FLAG_BEING_USED_FOR_RECORDING     = 1
 610 } cec_recording_flag;
 611
 612 typedef enum cec_tuner_display_info
 613 {
 614   CEC_TUNER_DISPLAY_INFO_DISPLAYING_DIGITAL_TUNER  = 0,
 615   CEC_TUNER_DISPLAY_INFO_NOT_DISPLAYING_TUNER      = 1,
 616   CEC_TUNER_DISPLAY_INFO_DISPLAYING_ANALOGUE_TUNER = 2
 617 } cec_tuner_display_info;
 618
 619 typedef enum cec_broadcast_system
 620 {
 621   CEC_BROADCAST_SYSTEM_PAL_B_G      = 0,
 622   CEC_BROADCAST_SYSTEM_SECAM_L1     = 1,
 623   CEC_BROADCAST_SYSTEM_PAL_M        = 2,
 624   CEC_BROADCAST_SYSTEM_NTSC_M       = 3,
 625   CEC_BROADCAST_SYSTEM_PAL_I        = 4,
 626   CEC_BROADCAST_SYSTEM_SECAM_DK     = 5,
 627   CEC_BROADCAST_SYSTEM_SECAM_B_G    = 6,
 628   CEC_BROADCAST_SYSTEM_SECAM_L2     = 7,
 629   CEC_BROADCAST_SYSTEM_PAL_DK       = 8,
 630   CEC_BROADCAST_SYSTEM_OTHER_SYSTEM = 30
 631 } cec_broadcast_system;
 632
 633 typedef enum cec_user_control_code
 634 {
 635   CEC_USER_CONTROL_CODE_SELECT                      = 0x00,
 636   CEC_USER_CONTROL_CODE_UP                          = 0x01,
 637   CEC_USER_CONTROL_CODE_DOWN                        = 0x02,
 638   CEC_USER_CONTROL_CODE_LEFT                        = 0x03,
 639   CEC_USER_CONTROL_CODE_RIGHT                       = 0x04,
 640   CEC_USER_CONTROL_CODE_RIGHT_UP                    = 0x05,
 641   CEC_USER_CONTROL_CODE_RIGHT_DOWN                  = 0x06,
 642   CEC_USER_CONTROL_CODE_LEFT_UP                     = 0x07,
 643   CEC_USER_CONTROL_CODE_LEFT_DOWN                   = 0x08,
 644   CEC_USER_CONTROL_CODE_ROOT_MENU                   = 0x09,
 645   CEC_USER_CONTROL_CODE_SETUP_MENU                  = 0x0A,
 646   CEC_USER_CONTROL_CODE_CONTENTS_MENU               = 0x0B,
 647   CEC_USER_CONTROL_CODE_FAVORITE_MENU               = 0x0C,
 648   CEC_USER_CONTROL_CODE_EXIT                        = 0x0D,
 649   // reserved: 0x0E, 0x0F
 650   CEC_USER_CONTROL_CODE_TOP_MENU                    = 0x10,
 651   CEC_USER_CONTROL_CODE_DVD_MENU                    = 0x11,
 652   // reserved: 0x12 ... 0x1C
 653   CEC_USER_CONTROL_CODE_NUMBER_ENTRY_MODE           = 0x1D,
 654   CEC_USER_CONTROL_CODE_NUMBER11                    = 0x1E,
 655   CEC_USER_CONTROL_CODE_NUMBER12                    = 0x1F,
 656   CEC_USER_CONTROL_CODE_NUMBER0                     = 0x20,
 657   CEC_USER_CONTROL_CODE_NUMBER1                     = 0x21,
 658   CEC_USER_CONTROL_CODE_NUMBER2                     = 0x22,
 659   CEC_USER_CONTROL_CODE_NUMBER3                     = 0x23,
 660   CEC_USER_CONTROL_CODE_NUMBER4                     = 0x24,
 661   CEC_USER_CONTROL_CODE_NUMBER5                     = 0x25,
 662   CEC_USER_CONTROL_CODE_NUMBER6                     = 0x26,
 663   CEC_USER_CONTROL_CODE_NUMBER7                     = 0x27,
 664   CEC_USER_CONTROL_CODE_NUMBER8                     = 0x28,
 665   CEC_USER_CONTROL_CODE_NUMBER9                     = 0x29,
 666   CEC_USER_CONTROL_CODE_DOT                         = 0x2A,
 667   CEC_USER_CONTROL_CODE_ENTER                       = 0x2B,
 668   CEC_USER_CONTROL_CODE_CLEAR                       = 0x2C,
 669   CEC_USER_CONTROL_CODE_NEXT_FAVORITE               = 0x2F,
 670   CEC_USER_CONTROL_CODE_CHANNEL_UP                  = 0x30,
 671   CEC_USER_CONTROL_CODE_CHANNEL_DOWN                = 0x31,
 672   CEC_USER_CONTROL_CODE_PREVIOUS_CHANNEL            = 0x32,
 673   CEC_USER_CONTROL_CODE_SOUND_SELECT                = 0x33,
 674   CEC_USER_CONTROL_CODE_INPUT_SELECT                = 0x34,
 675   CEC_USER_CONTROL_CODE_DISPLAY_INFORMATION         = 0x35,
 676   CEC_USER_CONTROL_CODE_HELP                        = 0x36,
 677   CEC_USER_CONTROL_CODE_PAGE_UP                     = 0x37,
 678   CEC_USER_CONTROL_CODE_PAGE_DOWN                   = 0x38,
 679   // reserved: 0x39 ... 0x3F
 680   CEC_USER_CONTROL_CODE_POWER                       = 0x40,
 681   CEC_USER_CONTROL_CODE_VOLUME_UP                   = 0x41,
 682   CEC_USER_CONTROL_CODE_VOLUME_DOWN                 = 0x42,
 683   CEC_USER_CONTROL_CODE_MUTE                        = 0x43,
 684   CEC_USER_CONTROL_CODE_PLAY                        = 0x44,
 685   CEC_USER_CONTROL_CODE_STOP                        = 0x45,
 686   CEC_USER_CONTROL_CODE_PAUSE                       = 0x46,
 687   CEC_USER_CONTROL_CODE_RECORD                      = 0x47,
 688   CEC_USER_CONTROL_CODE_REWIND                      = 0x48,
 689   CEC_USER_CONTROL_CODE_FAST_FORWARD                = 0x49,
 690   CEC_USER_CONTROL_CODE_EJECT                       = 0x4A,
 691   CEC_USER_CONTROL_CODE_FORWARD                     = 0x4B,
 692   CEC_USER_CONTROL_CODE_BACKWARD                    = 0x4C,
 693   CEC_USER_CONTROL_CODE_STOP_RECORD                 = 0x4D,
 694   CEC_USER_CONTROL_CODE_PAUSE_RECORD                = 0x4E,
 695   // reserved: 0x4F
 696   CEC_USER_CONTROL_CODE_ANGLE                       = 0x50,
 697   CEC_USER_CONTROL_CODE_SUB_PICTURE                 = 0x51,
 698   CEC_USER_CONTROL_CODE_VIDEO_ON_DEMAND             = 0x52,
 699   CEC_USER_CONTROL_CODE_ELECTRONIC_PROGRAM_GUIDE    = 0x53,
 700   CEC_USER_CONTROL_CODE_TIMER_PROGRAMMING           = 0x54,
 701   CEC_USER_CONTROL_CODE_INITIAL_CONFIGURATION       = 0x55,
 702   CEC_USER_CONTROL_CODE_SELECT_BROADCAST_TYPE       = 0x56,
 703   CEC_USER_CONTROL_CODE_SELECT_SOUND_PRESENTATION   = 0x57,
 704   // reserved: 0x58 ... 0x5F
 705   CEC_USER_CONTROL_CODE_PLAY_FUNCTION               = 0x60,
 706   CEC_USER_CONTROL_CODE_PAUSE_PLAY_FUNCTION         = 0x61,
 707   CEC_USER_CONTROL_CODE_RECORD_FUNCTION             = 0x62,
 708   CEC_USER_CONTROL_CODE_PAUSE_RECORD_FUNCTION       = 0x63,
 709   CEC_USER_CONTROL_CODE_STOP_FUNCTION               = 0x64,
 710   CEC_USER_CONTROL_CODE_MUTE_FUNCTION               = 0x65,
 711   CEC_USER_CONTROL_CODE_RESTORE_VOLUME_FUNCTION     = 0x66,
 712   CEC_USER_CONTROL_CODE_TUNE_FUNCTION               = 0x67,
 713   CEC_USER_CONTROL_CODE_SELECT_MEDIA_FUNCTION       = 0x68,
 714   CEC_USER_CONTROL_CODE_SELECT_AV_INPUT_FUNCTION    = 0x69,
 715   CEC_USER_CONTROL_CODE_SELECT_AUDIO_INPUT_FUNCTION = 0x6A,
 716   CEC_USER_CONTROL_CODE_POWER_TOGGLE_FUNCTION       = 0x6B,
 717   CEC_USER_CONTROL_CODE_POWER_OFF_FUNCTION          = 0x6C,
 718   CEC_USER_CONTROL_CODE_POWER_ON_FUNCTION           = 0x6D,
 719   // reserved: 0x6E ... 0x70
 720   CEC_USER_CONTROL_CODE_F1_BLUE                     = 0x71,
 721   CEC_USER_CONTROL_CODE_F2_RED                      = 0X72,
 722   CEC_USER_CONTROL_CODE_F3_GREEN                    = 0x73,
 723   CEC_USER_CONTROL_CODE_F4_YELLOW                   = 0x74,
 724   CEC_USER_CONTROL_CODE_F5                          = 0x75,
 725   CEC_USER_CONTROL_CODE_DATA                        = 0x76,
 726   // reserved: 0x77 ... 0xFF
 727   CEC_USER_CONTROL_CODE_AN_RETURN                   = 0x91, // return (Samsung)
 728   CEC_USER_CONTROL_CODE_AN_CHANNELS_LIST            = 0x96, // channels list (Samsung)
 729   CEC_USER_CONTROL_CODE_MAX                         = 0x96,
 730   CEC_USER_CONTROL_CODE_UNKNOWN                     = 0xFF
 731 } cec_user_control_code;
 732
 733 typedef enum cec_logical_address
 734 {
 735   CECDEVICE_UNKNOWN          = -1, //not a valid logical address
 736   CECDEVICE_TV               = 0,
 737   CECDEVICE_RECORDINGDEVICE1 = 1,
 738   CECDEVICE_RECORDINGDEVICE2 = 2,
 739   CECDEVICE_TUNER1           = 3,
 740   CECDEVICE_PLAYBACKDEVICE1  = 4,
 741   CECDEVICE_AUDIOSYSTEM      = 5,
 742   CECDEVICE_TUNER2           = 6,
 743   CECDEVICE_TUNER3           = 7,
 744   CECDEVICE_PLAYBACKDEVICE2  = 8,
 745   CECDEVICE_RECORDINGDEVICE3 = 9,
 746   CECDEVICE_TUNER4           = 10,
 747   CECDEVICE_PLAYBACKDEVICE3  = 11,
 748   CECDEVICE_RESERVED1        = 12,
 749   CECDEVICE_RESERVED2        = 13,
 750   CECDEVICE_FREEUSE          = 14,
 751   CECDEVICE_UNREGISTERED     = 15,
 752   CECDEVICE_BROADCAST        = 15
 753 } cec_logical_address;
 754
 755 typedef enum cec_opcode
 756 {
 757   CEC_OPCODE_ACTIVE_SOURCE                 = 0x82,
 758   CEC_OPCODE_IMAGE_VIEW_ON                 = 0x04,
 759   CEC_OPCODE_TEXT_VIEW_ON                  = 0x0D,
 760   CEC_OPCODE_INACTIVE_SOURCE               = 0x9D,
 761   CEC_OPCODE_REQUEST_ACTIVE_SOURCE         = 0x85,
 762   CEC_OPCODE_ROUTING_CHANGE                = 0x80,
 763   CEC_OPCODE_ROUTING_INFORMATION           = 0x81,
 764   CEC_OPCODE_SET_STREAM_PATH               = 0x86,
 765   CEC_OPCODE_STANDBY                       = 0x36,
 766   CEC_OPCODE_RECORD_OFF                    = 0x0B,
 767   CEC_OPCODE_RECORD_ON                     = 0x09,
 768   CEC_OPCODE_RECORD_STATUS                 = 0x0A,
 769   CEC_OPCODE_RECORD_TV_SCREEN              = 0x0F,
 770   CEC_OPCODE_CLEAR_ANALOGUE_TIMER          = 0x33,
 771   CEC_OPCODE_CLEAR_DIGITAL_TIMER           = 0x99,
 772   CEC_OPCODE_CLEAR_EXTERNAL_TIMER          = 0xA1,
 773   CEC_OPCODE_SET_ANALOGUE_TIMER            = 0x34,
 774   CEC_OPCODE_SET_DIGITAL_TIMER             = 0x97,
 775   CEC_OPCODE_SET_EXTERNAL_TIMER            = 0xA2,
 776   CEC_OPCODE_SET_TIMER_PROGRAM_TITLE       = 0x67,
 777   CEC_OPCODE_TIMER_CLEARED_STATUS          = 0x43,
 778   CEC_OPCODE_TIMER_STATUS                  = 0x35,
 779   CEC_OPCODE_CEC_VERSION                   = 0x9E,
 780   CEC_OPCODE_GET_CEC_VERSION               = 0x9F,
 781   CEC_OPCODE_GIVE_PHYSICAL_ADDRESS         = 0x83,
 782   CEC_OPCODE_GET_MENU_LANGUAGE             = 0x91,
 783   CEC_OPCODE_REPORT_PHYSICAL_ADDRESS       = 0x84,
 784   CEC_OPCODE_SET_MENU_LANGUAGE             = 0x32,
 785   CEC_OPCODE_DECK_CONTROL                  = 0x42,
 786   CEC_OPCODE_DECK_STATUS                   = 0x1B,
 787   CEC_OPCODE_GIVE_DECK_STATUS              = 0x1A,
 788   CEC_OPCODE_PLAY                          = 0x41,
 789   CEC_OPCODE_GIVE_TUNER_DEVICE_STATUS      = 0x08,
 790   CEC_OPCODE_SELECT_ANALOGUE_SERVICE       = 0x92,
 791   CEC_OPCODE_SELECT_DIGITAL_SERVICE        = 0x93,
 792   CEC_OPCODE_TUNER_DEVICE_STATUS           = 0x07,
 793   CEC_OPCODE_TUNER_STEP_DECREMENT          = 0x06,
 794   CEC_OPCODE_TUNER_STEP_INCREMENT          = 0x05,
 795   CEC_OPCODE_DEVICE_VENDOR_ID              = 0x87,
 796   CEC_OPCODE_GIVE_DEVICE_VENDOR_ID         = 0x8C,
 797   CEC_OPCODE_VENDOR_COMMAND                = 0x89,
 798   CEC_OPCODE_VENDOR_COMMAND_WITH_ID        = 0xA0,
 799   CEC_OPCODE_VENDOR_REMOTE_BUTTON_DOWN     = 0x8A,
 800   CEC_OPCODE_VENDOR_REMOTE_BUTTON_UP       = 0x8B,
 801   CEC_OPCODE_SET_OSD_STRING                = 0x64,
 802   CEC_OPCODE_GIVE_OSD_NAME                 = 0x46,
 803   CEC_OPCODE_SET_OSD_NAME                  = 0x47,
 804   CEC_OPCODE_MENU_REQUEST                  = 0x8D,
 805   CEC_OPCODE_MENU_STATUS                   = 0x8E,
 806   CEC_OPCODE_USER_CONTROL_PRESSED          = 0x44,
 807   CEC_OPCODE_USER_CONTROL_RELEASE          = 0x45,
 808   CEC_OPCODE_GIVE_DEVICE_POWER_STATUS      = 0x8F,
 809   CEC_OPCODE_REPORT_POWER_STATUS           = 0x90,
 810   CEC_OPCODE_FEATURE_ABORT                 = 0x00,
 811   CEC_OPCODE_ABORT                         = 0xFF,
 812   CEC_OPCODE_GIVE_AUDIO_STATUS             = 0x71,
 813   CEC_OPCODE_GIVE_SYSTEM_AUDIO_MODE_STATUS = 0x7D,
 814   CEC_OPCODE_REPORT_AUDIO_STATUS           = 0x7A,
 815   CEC_OPCODE_SET_SYSTEM_AUDIO_MODE         = 0x72,
 816   CEC_OPCODE_SYSTEM_AUDIO_MODE_REQUEST     = 0x70,
 817   CEC_OPCODE_SYSTEM_AUDIO_MODE_STATUS      = 0x7E,
 818   CEC_OPCODE_SET_AUDIO_RATE                = 0x9A,
 819
 820   /* CEC 1.4 */
 821   CEC_OPCODE_START_ARC                     = 0xC0,
 822   CEC_OPCODE_REPORT_ARC_STARTED            = 0xC1,
 823   CEC_OPCODE_REPORT_ARC_ENDED              = 0xC2,
 824   CEC_OPCODE_REQUEST_ARC_START             = 0xC3,
 825   CEC_OPCODE_REQUEST_ARC_END               = 0xC4,
 826   CEC_OPCODE_END_ARC                       = 0xC5,
 827   CEC_OPCODE_CDC                           = 0xF8,
 828   /* when this opcode is set, no opcode will be sent to the device. this is one of the reserved numbers */
 829   CEC_OPCODE_NONE                          = 0xFD
 830 } cec_opcode;
 831
 832 typedef enum cec_log_level
 833 {
 834   CEC_LOG_ERROR   = 1,
 835   CEC_LOG_WARNING = 2,
 836   CEC_LOG_NOTICE  = 4,
 837   CEC_LOG_TRAFFIC = 8,
 838   CEC_LOG_DEBUG   = 16,
 839   CEC_LOG_ALL     = 31
 840 } cec_log_level;
 841
 842 typedef enum cec_bus_device_status
 843 {
 844   CEC_DEVICE_STATUS_UNKNOWN,
 845   CEC_DEVICE_STATUS_PRESENT,
 846   CEC_DEVICE_STATUS_NOT_PRESENT,
 847   CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC
 848 } cec_bus_device_status;
 849
 850 typedef enum cec_vendor_id
 851 {
 852   CEC_VENDOR_TOSHIBA        = 0x000039,
 853   CEC_VENDOR_SAMSUNG        = 0x0000F0,
 854   CEC_VENDOR_DENON          = 0x0005CD,
 855   CEC_VENDOR_MARANTZ        = 0x000678,
 856   CEC_VENDOR_LOEWE          = 0x000982,
 857   CEC_VENDOR_ONKYO          = 0x0009B0,
 858   CEC_VENDOR_MEDION         = 0x000CB8,
 859   CEC_VENDOR_TOSHIBA2       = 0x000CE7,
 860   CEC_VENDOR_PULSE_EIGHT    = 0x001582,
 861   CEC_VENDOR_HARMAN_KARDON2 = 0x001950,
 862   CEC_VENDOR_AKAI           = 0x0020C7,
 863   CEC_VENDOR_AOC            = 0x002467,
 864   CEC_VENDOR_PANASONIC      = 0x008045,
 865   CEC_VENDOR_PHILIPS        = 0x00903E,
 866   CEC_VENDOR_DAEWOO         = 0x009053,
 867   CEC_VENDOR_YAMAHA         = 0x00A0DE,
 868   CEC_VENDOR_GRUNDIG        = 0x00D0D5,
 869   CEC_VENDOR_PIONEER        = 0x00E036,
 870   CEC_VENDOR_LG             = 0x00E091,
 871   CEC_VENDOR_SHARP          = 0x08001F,
 872   CEC_VENDOR_SONY           = 0x080046,
 873   CEC_VENDOR_BROADCOM       = 0x18C086,
 874   CEC_VENDOR_VIZIO          = 0x6B746D,
 875   CEC_VENDOR_BENQ           = 0x8065E9,
 876   CEC_VENDOR_HARMAN_KARDON  = 0x9C645E,
 877   CEC_VENDOR_UNKNOWN        = 0
 878 } cec_vendor_id;
 879
 880 typedef enum cec_adapter_type
 881 {
 882   ADAPTERTYPE_UNKNOWN          = 0,
 883   ADAPTERTYPE_P8_EXTERNAL      = 0x1,
 884   ADAPTERTYPE_P8_DAUGHTERBOARD = 0x2,
 885   ADAPTERTYPE_RPI              = 0x100,
 886   ADAPTERTYPE_TDA995x          = 0x200,
 887   ADAPTERTYPE_EXYNOS           = 0x300
 888 } cec_adapter_type;
 889
 890 typedef struct cec_menu_language
 891 {
 892   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 */
 893   cec_logical_address device;      /**< the logical address of the device */
 894 } cec_menu_language;
 895
 896 typedef struct cec_osd_name
 897 {
 898   char                name[14]; /**< the name of the device */
 899   cec_logical_address device;   /**< the logical address of the device */
 900 } cec_osd_name;
 901
 902 typedef struct cec_log_message
 903 {
 904   char          message[1024]; /**< the actual message */
 905   cec_log_level level;         /**< log level of the message */
 906   int64_t       time;          /**< the timestamp of this message */
 907 } cec_log_message;
 908
 909 typedef struct cec_keypress
 910 {
 911   cec_user_control_code keycode;  /**< the keycode */
 912   unsigned int          duration; /**< the duration of the keypress */
 913 } cec_keypress;
 914
 915 typedef struct cec_adapter
 916 {
 917   char path[1024]; /**< the path to the com port */
 918   char comm[1024]; /**< the name of the com port */
 919 } cec_adapter;
 920
 921 typedef struct cec_adapter_descriptor
 922 {
 923   char             strComPath[1024]; /**< the path to the com port */
 924   char             strComName[1024]; /**< the name of the com port */
 925   uint16_t         iVendorId;
 926   uint16_t         iProductId;
 927   uint16_t         iFirmwareVersion;
 928   uint16_t         iPhysicalAddress;
 929   uint32_t         iFirmwareBuildDate;
 930   cec_adapter_type adapterType;
 931 } cec_adapter_descriptor;
 932
 933 typedef struct cec_datapacket
 934 {
 935   uint8_t data[100]; /**< the actual data */
 936   uint8_t size;      /**< the size of the data */
 937
 938 #ifdef __cplusplus
 939   cec_datapacket &operator =(const struct cec_datapacket &packet)
 940   {
 941     Clear();
 942     for (uint8_t iPtr = 0; iPtr < packet.size; iPtr++)
 943       PushBack(packet[iPtr]);
 944
 945     return *this;
 946   }
 947
 948   bool operator ==(const struct cec_datapacket& packet) const
 949   {
 950     if (size != packet.size)
 951       return false;
 952     for (uint8_t iPtr = 0; iPtr < size; iPtr++)
 953       if (packet.data[iPtr] != data[iPtr])
 954         return false;
 955     return true;
 956   }
 957
 958   bool    IsEmpty(void) const             { return size == 0; }   /**< @return True when this packet is empty, false otherwise. */
 959   bool    IsFull(void) const              { return size == 100; } /**< @return True when this packet is false, false otherwise. */
 960
 961   /*!
 962    * @brief Get the byte at the requested position.
 963    * @param pos The position.
 964    * @return The byte, or 0 when out of bounds.
 965    */
 966   uint8_t operator[](uint8_t pos) const { return pos < size ? data[pos] : 0; }
 967   /*!
 968    * @brief Get the byte at the requested position.
 969    * @param pos The position.
 970    * @return The byte, or 0 when out of bounds.
 971    */
 972   uint8_t At(uint8_t pos) const         { return pos < size ? data[pos] : 0; }
 973
 974   /*!
 975    * @brief Shift the contents of this packet.
 976    * @param iShiftBy The number of positions to shift.
 977    */
 978   void Shift(uint8_t iShiftBy)
 979   {
 980     if (iShiftBy >= size)
 981     {
 982       Clear();
 983     }
 984     else
 985     {
 986       for (uint8_t iPtr = 0; iPtr < size; iPtr++)
 987         data[iPtr] = (iPtr + iShiftBy < size) ? data[iPtr + iShiftBy] : 0;
 988       size = (uint8_t) (size - iShiftBy);
 989     }
 990   }
 991
 992   /*!
 993    * @brief Push a byte to the end of this packet.
 994    * @param add The byte to add.
 995    */
 996   void PushBack(uint8_t add)
 997   {
 998     if (size < 100)
 999       data[size++] = add;
1000   }
1001
1002   /*!
1003    * @brief Clear this packet.
1004    */
1005   void Clear(void)
1006   {
1007     memset(data, 0, sizeof(data));
1008     size = 0;
1009   }
1010 #endif
1011
1012 } cec_datapacket;
1013
1014 typedef struct cec_command
1015 {
1016   cec_logical_address initiator;        /**< the logical address of the initiator of this message */
1017   cec_logical_address destination;      /**< the logical address of the destination of this message */
1018   int8_t              ack;              /**< 1 when the ACK bit is set, 0 otherwise */
1019   int8_t              eom;              /**< 1 when the EOM bit is set, 0 otherwise */
1020   cec_opcode          opcode;           /**< the opcode of this message */
1021   cec_datapacket      parameters;       /**< the parameters attached to this message */
1022   int8_t              opcode_set;       /**< 1 when an opcode is set, 0 otherwise (POLL message) */
1023   int32_t             transmit_timeout; /**< the timeout to use in ms */
1024
1025 #ifdef __cplusplus
1026   cec_command(void)
1027   {
1028     Clear();
1029   }
1030
1031   cec_command &operator =(const struct cec_command &command)
1032   {
1033     initiator        = command.initiator;
1034     destination      = command.destination;
1035     ack              = command.ack;
1036     eom              = command.eom;
1037     opcode           = command.opcode;
1038     opcode_set       = command.opcode_set;
1039     transmit_timeout = command.transmit_timeout;
1040     parameters       = command.parameters;
1041
1042     return *this;
1043   }
1044
1045   /*!
1046    * @brief Formats a cec_command.
1047    * @param command The command to format.
1048    * @param initiator The logical address of the initiator.
1049    * @param destination The logical addres of the destination.
1050    * @param opcode The opcode of the command.
1051    * @param timeout The transmission timeout.
1052    */
1053   static void Format(cec_command &command, cec_logical_address initiator, cec_logical_address destination, cec_opcode opcode, int32_t timeout = CEC_DEFAULT_TRANSMIT_TIMEOUT)
1054   {
1055     command.Clear();
1056     command.initiator        = initiator;
1057     command.destination      = destination;
1058     command.transmit_timeout = timeout;
1059     if (opcode != CEC_OPCODE_NONE)
1060     {
1061       command.opcode     = opcode;
1062       command.opcode_set = 1;
1063     }
1064   }
1065
1066   /*!
1067    * @brief Push a byte to the back of this command.
1068    * @param data The byte to push.
1069    */
1070   void PushBack(uint8_t data)
1071   {
1072     if (initiator == CECDEVICE_UNKNOWN && destination == CECDEVICE_UNKNOWN)
1073     {
1074       initiator   = (cec_logical_address) (data >> 4);
1075       destination = (cec_logical_address) (data & 0xF);
1076     }
1077     else if (!opcode_set)
1078     {
1079       opcode_set = 1;
1080       opcode = (cec_opcode) data;
1081     }
1082     else
1083       parameters.PushBack(data);
1084   }
1085
1086   /*!
1087    * @brief Clear this command, resetting everything to the default values.
1088    */
1089   void Clear(void)
1090   {
1091     initiator        = CECDEVICE_UNKNOWN;
1092     destination      = CECDEVICE_UNKNOWN;
1093     ack              = 0;
1094     eom              = 0;
1095     opcode_set       = 0;
1096     opcode           = CEC_OPCODE_FEATURE_ABORT;
1097     transmit_timeout = CEC_DEFAULT_TRANSMIT_TIMEOUT;
1098     parameters.Clear();
1099   };
1100
1101   static cec_opcode GetResponseOpcode(cec_opcode opcode)
1102   {
1103     switch (opcode)
1104     {
1105     case CEC_OPCODE_REQUEST_ACTIVE_SOURCE:
1106       return CEC_OPCODE_ACTIVE_SOURCE;
1107     case CEC_OPCODE_GET_CEC_VERSION:
1108       return CEC_OPCODE_CEC_VERSION;
1109     case CEC_OPCODE_GIVE_PHYSICAL_ADDRESS:
1110       return CEC_OPCODE_REPORT_PHYSICAL_ADDRESS;
1111     case CEC_OPCODE_GET_MENU_LANGUAGE:
1112       return CEC_OPCODE_SET_MENU_LANGUAGE;
1113     case CEC_OPCODE_GIVE_DECK_STATUS:
1114       return CEC_OPCODE_DECK_STATUS;
1115     case CEC_OPCODE_GIVE_TUNER_DEVICE_STATUS:
1116       return CEC_OPCODE_TUNER_DEVICE_STATUS;
1117     case CEC_OPCODE_GIVE_DEVICE_VENDOR_ID:
1118       return CEC_OPCODE_DEVICE_VENDOR_ID;
1119     case CEC_OPCODE_GIVE_OSD_NAME:
1120       return CEC_OPCODE_SET_OSD_NAME;
1121     case CEC_OPCODE_MENU_REQUEST:
1122       return CEC_OPCODE_MENU_STATUS;
1123     case CEC_OPCODE_GIVE_DEVICE_POWER_STATUS:
1124       return CEC_OPCODE_REPORT_POWER_STATUS;
1125     case CEC_OPCODE_GIVE_AUDIO_STATUS:
1126       return CEC_OPCODE_REPORT_AUDIO_STATUS;
1127     case CEC_OPCODE_GIVE_SYSTEM_AUDIO_MODE_STATUS:
1128       return CEC_OPCODE_SYSTEM_AUDIO_MODE_STATUS;
1129     case CEC_OPCODE_SYSTEM_AUDIO_MODE_REQUEST:
1130       return CEC_OPCODE_SET_SYSTEM_AUDIO_MODE;
1131     default:
1132       break;
1133     }
1134
1135     return CEC_OPCODE_NONE;
1136   }
1137
1138   void PushArray(size_t len, uint8_t *data)
1139   {
1140     for (size_t iPtr = 0; iPtr < len; iPtr++)
1141       PushBack(data[iPtr]);
1142   }
1143 #endif
1144 } cec_command;
1145
1146 typedef struct cec_device_type_list
1147 {
1148   cec_device_type types[5]; /**< the list of device types */
1149
1150 #ifdef __cplusplus
1151   /*!
1152    * @brief Clear this list.
1153    */
1154   void Clear(void)
1155   {
1156     for (unsigned int iPtr = 0; iPtr < 5; iPtr++)
1157      types[iPtr] = CEC_DEVICE_TYPE_RESERVED;
1158   }
1159
1160   /*!
1161    * @brief Add a type to this list.
1162    * @param type The type to add.
1163    */
1164   void Add(const cec_device_type type)
1165   {
1166     for (unsigned int iPtr = 0; iPtr < 5; iPtr++)
1167     {
1168       if (types[iPtr] == CEC_DEVICE_TYPE_RESERVED)
1169       {
1170         types[iPtr] = type;
1171         break;
1172       }
1173     }
1174   }
1175
1176   /*!
1177    * @brief Check whether a type is set in this list.
1178    * @param type The type to check.
1179    * @return True when set, false otherwise.
1180    */
1181   bool IsSet(cec_device_type type)
1182   {
1183     bool bReturn(false);
1184     for (unsigned int iPtr = 0; !bReturn && iPtr < 5; iPtr++)
1185     {
1186       if (types[iPtr] == type)
1187         bReturn = true;
1188     }
1189     return bReturn;
1190   }
1191
1192   /*!
1193    * @return True when this list is empty, false otherwise.
1194    */
1195   bool IsEmpty() const
1196   {
1197     bool bReturn(true);
1198     for (unsigned int iPtr = 0; bReturn && iPtr < 5; iPtr++)
1199     {
1200       if (types[iPtr] != CEC_DEVICE_TYPE_RESERVED)
1201         bReturn = false;
1202     }
1203     return bReturn;
1204   }
1205
1206   /*!
1207    * @brief Get the type at the requested position.
1208    * @param pos The position.
1209    * @return The type, or CEC_DEVICE_TYPE_RESERVED when out of bounds.
1210    */
1211   cec_device_type operator[](uint8_t pos) const { return pos < 5 ? types[pos] : CEC_DEVICE_TYPE_RESERVED; }
1212
1213   bool operator==(const cec_device_type_list &other) const
1214   {
1215     bool bEqual(true);
1216     for (uint8_t iPtr = 0; iPtr < 5; iPtr++)
1217       bEqual &= (types[iPtr] == other[iPtr]);
1218     return bEqual;
1219   }
1220
1221   bool operator!=(const cec_device_type_list &other) const
1222   {
1223     return !(*this == other);
1224   }
1225 #endif
1226 } cec_device_type_list;
1227
1228 typedef struct cec_logical_addresses
1229 {
1230   cec_logical_address primary;       /**< the primary logical address to use */
1231   int                 addresses[16]; /**< the list of addresses */
1232
1233 #ifdef __cplusplus
1234   /*!
1235    * @brief Clear this list.
1236    */
1237   void Clear(void)
1238   {
1239     primary = CECDEVICE_UNREGISTERED;
1240     for (unsigned int iPtr = 0; iPtr < 16; iPtr++)
1241       addresses[iPtr] = 0;
1242   }
1243
1244   /*!
1245    * @return True when empty, false otherwise.
1246    */
1247   bool IsEmpty(void) const
1248   {
1249     return primary == CECDEVICE_UNREGISTERED;
1250   }
1251
1252   /*!
1253    * @brief Calculate the ack-mask for this list, the mask to use when determining whether to send an ack message or not.
1254    * @return The ack-mask.
1255    */
1256   uint16_t AckMask(void) const
1257   {
1258     uint16_t mask = 0;
1259     for (unsigned int iPtr = 0; iPtr < 16; iPtr++)
1260       if (addresses[iPtr] == 1)
1261         mask |= 0x1 << iPtr;
1262     return mask;
1263   }
1264
1265   /*!
1266    * @brief Mark a logical address as 'set'
1267    * @param address The logical address to add to this list.
1268    */
1269   void Set(cec_logical_address address)
1270   {
1271     if (primary == CECDEVICE_UNREGISTERED)
1272       primary = address;
1273
1274     addresses[(int) address] = 1;
1275   }
1276
1277   /*!
1278    * @brief Mark a logical address as 'unset'
1279    * @param address The logical address to remove from this list.
1280    */
1281   void Unset(const cec_logical_address address)
1282   {
1283     if (primary == address)
1284       primary = CECDEVICE_UNREGISTERED;
1285
1286     addresses[(int) address] = 0;
1287   }
1288
1289   /*!
1290    * @brief Check whether an address is set in this list.
1291    * @param address The address to check.
1292    * @return True when set, false otherwise.
1293    */
1294   bool IsSet(cec_logical_address address) const { return addresses[(int) address] == 1; }
1295
1296   /*!
1297    * @brief Check whether an address is set in this list.
1298    * @param pos The address to check.
1299    * @return True when set, false otherwise.
1300    */
1301   bool operator[](uint8_t pos) const { return pos < 16 ? IsSet((cec_logical_address) pos) : false; }
1302
1303   bool operator==(const cec_logical_addresses &other) const
1304   {
1305     bool bEqual(true);
1306     for (uint8_t iPtr = 0; iPtr < 16; iPtr++)
1307       bEqual &= ((addresses[(int)iPtr] == 1) == other[iPtr]);
1308     return bEqual;
1309   }
1310
1311   bool operator!=(const cec_logical_addresses &other) const
1312   {
1313     return !(*this == other);
1314   }
1315 #endif
1316 } cec_logical_addresses;
1317
1318 typedef enum libcec_alert
1319 {
1320   CEC_ALERT_SERVICE_DEVICE,
1321   CEC_ALERT_CONNECTION_LOST,
1322   CEC_ALERT_PERMISSION_ERROR,
1323   CEC_ALERT_PORT_BUSY,
1324   CEC_ALERT_PHYSICAL_ADDRESS_ERROR,
1325   CEC_ALERT_TV_POLL_FAILED
1326 } libcec_alert;
1327
1328 typedef enum libcec_parameter_type
1329 {
1330   CEC_PARAMETER_TYPE_STRING,
1331   CEC_PARAMETER_TYPE_UNKOWN
1332 } libcec_parameter_type;
1333
1334 typedef struct libcec_parameter
1335 {
1336   libcec_parameter_type paramType; /**< the type of this parameter */
1337   void*                 paramData; /**< the value of this parameter */
1338 } libcec_parameter;
1339
1340 typedef struct libcec_configuration libcec_configuration;
1341
1342 typedef int (CEC_CDECL* CBCecLogMessageType)(void*, const cec_log_message);
1343 typedef int (CEC_CDECL* CBCecKeyPressType)(void*, const cec_keypress);
1344 typedef int (CEC_CDECL* CBCecCommandType)(void*, const cec_command);
1345 typedef int (CEC_CDECL* CBCecConfigurationChangedType)(void*, const libcec_configuration);
1346 typedef int (CEC_CDECL* CBCecAlertType)(void*, const libcec_alert, const libcec_parameter);
1347 typedef int (CEC_CDECL* CBCecMenuStateChangedType)(void*, const cec_menu_state);
1348 typedef void (CEC_CDECL* CBCecSourceActivatedType)(void*, const cec_logical_address, const uint8_t);
1349
1350 typedef struct ICECCallbacks
1351 {
1352   /*!
1353    * @brief Transfer a log message from libCEC to the client.
1354    * @param message The message to transfer.
1355    * @return 1 when ok, 0 otherwise.
1356    */
1357   CBCecLogMessageType CBCecLogMessage;
1358
1359   /*!
1360    * @brief Transfer a keypress from libCEC to the client.
1361    * @param key The keypress to transfer.
1362    * @return 1 when ok, 0 otherwise.
1363    */
1364   CBCecKeyPressType CBCecKeyPress;
1365
1366   /*!
1367    * @brief Transfer a CEC command from libCEC to the client.
1368    * @param command The command to transfer.
1369    * @return 1 when ok, 0 otherwise.
1370    */
1371   CBCecCommandType CBCecCommand;
1372
1373   /*!
1374    * @brief Transfer a changed configuration from libCEC to the client
1375    * @param configuration The configuration to transfer
1376    * @return 1 when ok, 0 otherwise
1377    */
1378   CBCecConfigurationChangedType CBCecConfigurationChanged;
1379
1380   /*!
1381    * @brief Transfer a libcec alert message from libCEC to the client
1382    * @param alert The alert type transfer.
1383    * @param data  Misc. additional information.
1384    * @return 1 when ok, 0 otherwise
1385    */
1386   CBCecAlertType CBCecAlert;
1387
1388   /*!
1389    * @brief Transfer a menu state change to the client.
1390    * Transfer a menu state change to the client. If the command returns 1, then the change will be processed by
1391    * the busdevice. If 0, then the state of the busdevice won't be changed, and will always be kept 'activated',
1392    * @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.
1393    * so keypresses are always routed.
1394    * @param newVal The new value.
1395    * @return 1 when libCEC should use this new value, 0 otherwise.
1396    */
1397   CBCecMenuStateChangedType CBCecMenuStateChanged;
1398
1399   /*!
1400    * @brief Called when a source that's handled by this client is activated.
1401    * @param logicalAddress The address that was just activated.
1402    * @param bActivated 1 when activated, 0 when deactivated.
1403    */
1404   CBCecSourceActivatedType CBCecSourceActivated;
1405
1406 #ifdef __cplusplus
1407    ICECCallbacks(void) { Clear(); }
1408   ~ICECCallbacks(void) { Clear(); };
1409
1410   void Clear(void)
1411   {
1412     CBCecLogMessage           = NULL;
1413     CBCecKeyPress             = NULL;
1414     CBCecCommand              = NULL;
1415     CBCecConfigurationChanged = NULL;
1416     CBCecAlert                = NULL;
1417     CBCecMenuStateChanged     = NULL;
1418     CBCecSourceActivated      = NULL;
1419   }
1420 #endif
1421 } ICECCallbacks;
1422
1423 typedef enum cec_client_version
1424 {
1425   CEC_CLIENT_VERSION_PRE_1_5 = 0,
1426   CEC_CLIENT_VERSION_1_5_0   = 0x1500,
1427   CEC_CLIENT_VERSION_1_5_1   = 0x1501,
1428   CEC_CLIENT_VERSION_1_5_2   = 0x1502,
1429   CEC_CLIENT_VERSION_1_5_3   = 0x1503,
1430   CEC_CLIENT_VERSION_1_6_0   = 0x1600,
1431   CEC_CLIENT_VERSION_1_6_1   = 0x1601,
1432   CEC_CLIENT_VERSION_1_6_2   = 0x1602,
1433   CEC_CLIENT_VERSION_1_6_3   = 0x1603,
1434   CEC_CLIENT_VERSION_1_7_0   = 0x1700,
1435   CEC_CLIENT_VERSION_1_7_1   = 0x1701,
1436   CEC_CLIENT_VERSION_1_7_2   = 0x1702,
1437   CEC_CLIENT_VERSION_1_8_0   = 0x1800,
1438   CEC_CLIENT_VERSION_1_8_1   = 0x1801,
1439   CEC_CLIENT_VERSION_1_8_2   = 0x1802,
1440   CEC_CLIENT_VERSION_1_9_0   = 0x1900,
1441   CEC_CLIENT_VERSION_1_99_0  = 0x1990,
1442   CEC_CLIENT_VERSION_2_0_0   = 0x2000,
1443   CEC_CLIENT_VERSION_2_0_1   = 0x2001,
1444   CEC_CLIENT_VERSION_2_0_2   = 0x2002,
1445   CEC_CLIENT_VERSION_2_0_3   = 0x2003,
1446   CEC_CLIENT_VERSION_2_0_4   = 0x2004,
1447   CEC_CLIENT_VERSION_2_0_5   = 0x2005,
1448   CEC_CLIENT_VERSION_2_1_0   = 0x2100,
1449   CEC_CLIENT_VERSION_2_1_1   = 0x2101,
1450   CEC_CLIENT_VERSION_2_1_2   = 0x2102,
1451   CEC_CLIENT_VERSION_2_1_3   = 0x2103,
1452   CEC_CLIENT_VERSION_2_1_4   = 0x2104,
1453   CEC_CLIENT_VERSION_CURRENT = 0x2104
1454 } cec_client_version;
1455
1456 typedef enum cec_server_version
1457 {
1458   CEC_SERVER_VERSION_PRE_1_5 = 0,
1459   CEC_SERVER_VERSION_1_5_0   = 0x1500,
1460   CEC_SERVER_VERSION_1_5_1   = 0x1501,
1461   CEC_SERVER_VERSION_1_5_2   = 0x1502,
1462   CEC_SERVER_VERSION_1_5_3   = 0x1503,
1463   CEC_SERVER_VERSION_1_6_0   = 0x1600,
1464   CEC_SERVER_VERSION_1_6_1   = 0x1601,
1465   CEC_SERVER_VERSION_1_6_2   = 0x1602,
1466   CEC_SERVER_VERSION_1_6_3   = 0x1603,
1467   CEC_SERVER_VERSION_1_7_0   = 0x1700,
1468   CEC_SERVER_VERSION_1_7_1   = 0x1701,
1469   CEC_SERVER_VERSION_1_7_2   = 0x1702,
1470   CEC_SERVER_VERSION_1_8_0   = 0x1800,
1471   CEC_SERVER_VERSION_1_8_1   = 0x1801,
1472   CEC_SERVER_VERSION_1_8_2   = 0x1802,
1473   CEC_SERVER_VERSION_1_9_0   = 0x1900,
1474   CEC_SERVER_VERSION_1_99_0  = 0x1990,
1475   CEC_SERVER_VERSION_2_0_0   = 0x2000,
1476   CEC_SERVER_VERSION_2_0_1   = 0x2001,
1477   CEC_SERVER_VERSION_2_0_2   = 0x2002,
1478   CEC_SERVER_VERSION_2_0_3   = 0x2003,
1479   CEC_SERVER_VERSION_2_0_4   = 0x2004,
1480   CEC_SERVER_VERSION_2_0_5   = 0x2005,
1481   CEC_SERVER_VERSION_2_1_0   = 0x2100,
1482   CEC_SERVER_VERSION_2_1_1   = 0x2101,
1483   CEC_SERVER_VERSION_2_1_2   = 0x2102,
1484   CEC_SERVER_VERSION_2_1_3   = 0x2103,
1485   CEC_SERVER_VERSION_2_1_4   = 0x2104,
1486   CEC_SERVER_VERSION_CURRENT = 0x2104
1487 } cec_server_version;
1488
1489 struct libcec_configuration
1490 {
1491   uint32_t              clientVersion;        /*!< the version of the client that is connecting */
1492   char                  strDeviceName[13];    /*!< the device name to use on the CEC bus */
1493   cec_device_type_list  deviceTypes;          /*!< the device type(s) to use on the CEC bus for libCEC */
1494   uint8_t               bAutodetectAddress;   /*!< (read only) set to 1 by libCEC when the physical address was autodetected */
1495   uint16_t              iPhysicalAddress;     /*!< the physical address of the CEC adapter */
1496   cec_logical_address   baseDevice;           /*!< the logical address of the device to which the adapter is connected. only used when iPhysicalAddress = 0 or when the adapter doesn't support autodetection */
1497   uint8_t               iHDMIPort;            /*!< the HDMI port to which the adapter is connected. only used when iPhysicalAddress = 0 or when the adapter doesn't support autodetection */
1498   uint64_t              tvVendor;             /*!< override the vendor ID of the TV. leave this untouched to autodetect */
1499   cec_logical_addresses wakeDevices;          /*!< list of devices to wake when initialising libCEC or when calling PowerOnDevices() without any parameter. */
1500   cec_logical_addresses powerOffDevices;      /*!< list of devices to power off when calling StandbyDevices() without any parameter. */
1501
1502   uint32_t              serverVersion;        /*!< the version number of the server. read-only */
1503
1504   // player specific settings
1505   uint8_t               bGetSettingsFromROM;  /*!< true to get the settings from the ROM (if set, and a v2 ROM is present), false to use these settings. */
1506   uint8_t               bUseTVMenuLanguage;   /*!< use the menu language of the TV in the player application */
1507   uint8_t               bActivateSource;      /*!< make libCEC the active source on the bus when starting the player application */
1508   uint8_t               bPowerOffScreensaver; /*!< put devices in standby mode when activating the screensaver */
1509   uint8_t               bPowerOnScreensaver;  /*!< wake devices when deactivating the screensaver */
1510   uint8_t               bPowerOffOnStandby;   /*!< put this PC in standby mode when the TV is switched off. only used when bShutdownOnStandby = 0  */
1511   uint8_t               bSendInactiveSource;  /*!< send an 'inactive source' message when stopping the player. added in 1.5.1 */
1512
1513   void *                callbackParam;        /*!< the object to pass along with a call of the callback methods. NULL to ignore */
1514   ICECCallbacks *       callbacks;            /*!< the callback methods to use. set this to NULL when not using callbacks */
1515
1516   cec_logical_addresses logicalAddresses;     /*!< (read-only) the current logical addresses. added in 1.5.3 */
1517   uint16_t              iFirmwareVersion;     /*!< (read-only) the firmware version of the adapter. added in 1.6.0 */
1518   uint8_t               bPowerOffDevicesOnStandby; /*!< put devices in standby when the PC/player is put in standby. added in 1.6.0 */
1519   uint8_t               bShutdownOnStandby;   /*!< shutdown this PC when the TV is switched off. only used when bPowerOffOnStandby = 0. added in 1.6.0 */
1520   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 */
1521   uint32_t              iFirmwareBuildDate;   /*!< (read-only) 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 */
1522   uint8_t               bMonitorOnly;         /*!< won't allocate a CCECClient when starting the connection when set (same as monitor mode). added in 1.6.3 */
1523   cec_version           cecVersion;           /*!< CEC spec version to use by libCEC. defaults to v1.4. added in 1.8.0 */
1524   cec_adapter_type      adapterType;          /*!< type of the CEC adapter that we're connected to. added in 1.8.2 */
1525   uint8_t               iDoubleTapTimeoutMs;  /*!< prevent double taps withing this timeout. defaults to 200ms. added in 2.0.0 */
1526   cec_user_control_code comboKey;             /*!< key code that initiates combo keys. defaults to CEC_USER_CONTROL_CODE_F1_BLUE. CEC_USER_CONTROL_CODE_UNKNOWN to disable. added in 2.0.5 */
1527   uint32_t              iComboKeyTimeoutMs;   /*!< timeout until the combo key is sent as normal keypress */
1528
1529 #ifdef __cplusplus
1530    libcec_configuration(void) { Clear(); }
1531   ~libcec_configuration(void) { Clear(); }
1532
1533   bool operator==(const libcec_configuration &other) const
1534   {
1535     return (     clientVersion             == other.clientVersion &&
1536         !strncmp(strDeviceName,               other.strDeviceName, 13) &&
1537                   deviceTypes               == other.deviceTypes &&
1538                   bAutodetectAddress        == other.bAutodetectAddress &&
1539                   iPhysicalAddress          == other.iPhysicalAddress &&
1540                   baseDevice                == other.baseDevice &&
1541                   iHDMIPort                 == other.iHDMIPort &&
1542                   tvVendor                  == other.tvVendor &&
1543                   wakeDevices               == other.wakeDevices &&
1544                   powerOffDevices           == other.powerOffDevices &&
1545                   serverVersion             == other.serverVersion &&
1546                   bGetSettingsFromROM       == other.bGetSettingsFromROM &&
1547                   bUseTVMenuLanguage        == other.bUseTVMenuLanguage &&
1548                   bActivateSource           == other.bActivateSource &&
1549                   bPowerOffScreensaver      == other.bPowerOffScreensaver &&
1550                   bPowerOffOnStandby        == other.bPowerOffOnStandby &&
1551                   bSendInactiveSource       == other.bSendInactiveSource &&
1552                   logicalAddresses          == other.logicalAddresses &&
1553                   iFirmwareVersion          == other.iFirmwareVersion &&
1554                   bPowerOffDevicesOnStandby == other.bPowerOffDevicesOnStandby &&
1555                   bShutdownOnStandby        == other.bShutdownOnStandby &&
1556         !strncmp(strDeviceLanguage,           other.strDeviceLanguage, 3) &&
1557                   iFirmwareBuildDate        == other.iFirmwareBuildDate &&
1558                   bMonitorOnly              == other.bMonitorOnly &&
1559                   cecVersion                == other.cecVersion &&
1560                   adapterType               == other.adapterType &&
1561                   iDoubleTapTimeoutMs       == other.iDoubleTapTimeoutMs &&
1562                   (other.clientVersion <= CEC_CLIENT_VERSION_2_0_4 || comboKey            == other.comboKey) &&
1563                   (other.clientVersion <= CEC_CLIENT_VERSION_2_0_4 || iComboKeyTimeoutMs  == other.iComboKeyTimeoutMs) &&
1564                   (other.clientVersion <  CEC_CLIENT_VERSION_2_1_0 || bPowerOnScreensaver == other.bPowerOnScreensaver));
1565   }
1566
1567   bool operator!=(const libcec_configuration &other) const
1568   {
1569     return !(*this == other);
1570   }
1571
1572   /*!
1573    * @brief Reset this configution struct to the default values.
1574    */
1575   void Clear(void)
1576   {
1577     iPhysicalAddress =                CEC_PHYSICAL_ADDRESS_TV;
1578     baseDevice = (cec_logical_address)CEC_DEFAULT_BASE_DEVICE;
1579     iHDMIPort =                       CEC_DEFAULT_HDMI_PORT;
1580     tvVendor =              (uint64_t)CEC_VENDOR_UNKNOWN;
1581     clientVersion =         (uint32_t)CEC_CLIENT_VERSION_CURRENT;
1582     serverVersion =         (uint32_t)CEC_SERVER_VERSION_CURRENT;
1583     bAutodetectAddress =              0;
1584     bGetSettingsFromROM =             CEC_DEFAULT_SETTING_GET_SETTINGS_FROM_ROM;
1585     bUseTVMenuLanguage =              CEC_DEFAULT_SETTING_USE_TV_MENU_LANGUAGE;
1586     bActivateSource =                 CEC_DEFAULT_SETTING_ACTIVATE_SOURCE;
1587     bPowerOffScreensaver =            CEC_DEFAULT_SETTING_POWER_OFF_SCREENSAVER;
1588     bPowerOnScreensaver =             CEC_DEFAULT_SETTING_POWER_ON_SCREENSAVER;
1589     bPowerOffOnStandby =              CEC_DEFAULT_SETTING_POWER_OFF_ON_STANDBY;
1590     bShutdownOnStandby =              CEC_DEFAULT_SETTING_SHUTDOWN_ON_STANDBY;
1591     bSendInactiveSource =             CEC_DEFAULT_SETTING_SEND_INACTIVE_SOURCE;
1592     iFirmwareVersion =                CEC_FW_VERSION_UNKNOWN;
1593     bPowerOffDevicesOnStandby =       CEC_DEFAULT_SETTING_POWER_OFF_DEVICES_STANDBY;
1594     memcpy(strDeviceLanguage,         CEC_DEFAULT_DEVICE_LANGUAGE, 3);
1595     iFirmwareBuildDate =              CEC_FW_BUILD_UNKNOWN;
1596     bMonitorOnly =                    0;
1597     cecVersion =         (cec_version)CEC_DEFAULT_SETTING_CEC_VERSION;
1598     adapterType =                     ADAPTERTYPE_UNKNOWN;
1599     iDoubleTapTimeoutMs =             CEC_DOUBLE_TAP_TIMEOUT_MS;
1600     comboKey =                        CEC_USER_CONTROL_CODE_STOP;
1601     iComboKeyTimeoutMs =              CEC_DEFAULT_COMBO_TIMEOUT_MS;
1602
1603     memset(strDeviceName, 0, 13);
1604     deviceTypes.Clear();
1605     logicalAddresses.Clear();
1606     wakeDevices.Clear();
1607     powerOffDevices.Clear();
1608
1609     #if CEC_DEFAULT_SETTING_POWER_OFF_SHUTDOWN == 1
1610     powerOffDevices.Set(CECDEVICE_BROADCAST);
1611     #endif
1612     #if CEC_DEFAULT_SETTING_ACTIVATE_SOURCE == 1
1613     wakeDevices.Set(CECDEVICE_TV);
1614     #endif
1615
1616     callbackParam = NULL;
1617     callbacks     = NULL;
1618   }
1619 #endif
1620 };
1621
1622 #ifdef __cplusplus
1623 };
1624 };
1625 #endif
1626
1627 #endif /* CECTYPES_H_ */