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 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 #include <stdbool.h>
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 namespace CEC {
  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 typedef enum
  60 {
  61   CEC_ABORT_REASON_UNRECOGNIZED_OPCODE = 0,
  62   CEC_ABORT_REASON_NOT_IN_CORRECT_MODE_TO_RESPOND = 1,
  63   CEC_ABORT_REASON_CANNOT_PROVIDE_SOURCE = 2,
  64   CEC_ABORT_REASON_INVALID_OPERAND = 3,
  65   CEC_ABORT_REASON_REFUSED = 4
  66 } ECecAbortReason;
  67
  68 typedef enum
  69 {
  70   CEC_ANALOGUE_BROADCAST_TYPE_CABLE = 0x00,
  71   CEC_ANALOGUE_BROADCAST_TYPE_SATELLITE = 0x01,
  72   CEC_ANALOGUE_BROADCAST_TYPE_TERRESTIAL = 0x02
  73 } ECecAnalogueBroadcastType;
  74
  75 typedef enum
  76 {
  77   CEC_AUDIO_RATE_RATE_CONTROL_OFF = 0,
  78   CEC_AUDIO_RATE_STANDARD_RATE_100 = 1,
  79   CEC_AUDIO_RATE_FAST_RATE_MAX_101 = 2,
  80   CEC_AUDIO_RATE_SLOW_RATE_MIN_99 = 3,
  81   CEC_AUDIO_RATE_STANDARD_RATE_100_0 = 4,
  82   CEC_AUDIO_RATE_FAST_RATE_MAX_100_1 = 5,
  83   CEC_AUDIO_RATE_SLOW_RATE_MIN_99_9 = 6
  84 } ECecAudioRate;
  85
  86 typedef enum
  87 {
  88   CEC_AUDIO_MUTE_STATUS_MASK = 0x80,
  89   CEC_AUDIO_VOLUME_STATUS_MASK = 0x7F,
  90   CEC_AUDIO_VOLUME_MIN = 0x00,
  91   CEC_AUDIO_VOLUME_MAX = 0x64,
  92   CEC_AUDIO_VOLUME_STATUS_UNKNOWN = 0x7F
  93 } ECecAudioStatus;
  94
  95 typedef enum
  96 {
  97   CEC_FALSE = 0,
  98   CEC_TRUE = 1
  99 } ECecBoolean;
 100
 101 typedef enum
 102 {
 103   CEC_VERSION_1_2 = 0x01,
 104   CEC_VERSION_1_2A = 0x02,
 105   CEC_VERSION_1_3 = 0x03,
 106   CEC_VERSION_1_3A = 0x04
 107 } ECecVersion;
 108
 109 typedef enum
 110 {
 111   CEC_CHANNEL_NUMBER_FORMAT_MASK = 0xFC000000,
 112   CEC_1_PART_CHANNEL_NUMBER = 0x04000000,
 113   CEC_2_PART_CHANNEL_NUMBER = 0x08000000,
 114   CEC_MAJOR_CHANNEL_NUMBER_MASK = 0x3FF0000,
 115   CEC_MINOR_CHANNEL_NUMBER_MASK = 0xFFFF
 116 } ECecChannelIdentifier;
 117
 118 typedef enum
 119 {
 120   CEC_DESK_CONTROL_MODE_SKIP_FORWARD_WIND = 1,
 121   CEC_DESK_CONTROL_MODE_SKIP_REVERSE_REWIND = 2,
 122   CEC_DESK_CONTROL_MODE_STOP = 3,
 123   CEC_DESK_CONTROL_MODE_EJECT = 4
 124 } ECecDeskControlMode;
 125
 126 typedef enum
 127 {
 128   CEC_DECK_INFO_PLAY = 0x11,
 129   CEC_DECK_INFO_RECORD = 0x12,
 130   CEC_DECK_INFO_PLAY_REVERSE = 0x13,
 131   CEC_DECK_INFO_STILL = 0x14,
 132   CEC_DECK_INFO_SLOW = 0x15,
 133   CEC_DECK_INFO_SLOW_REVERSE = 0x16,
 134   CEC_DECK_INFO_FAST_FORWARD = 0x17,
 135   CEC_DECK_INFO_FAST_REVERSE = 0x18,
 136   CEC_DECK_INFO_NO_MEDIA = 0x19,
 137   CEC_DECK_INFO_STOP = 0x1A,
 138   CEC_DECK_INFO_SKIP_FORWARD_WIND = 0x1B,
 139   CEC_DECK_INFO_SKIP_REVERSE_REWIND = 0x1C,
 140   CEC_DECK_INFO_INDEX_SEARCH_FORWARD = 0x1D,
 141   CEC_DECK_INFO_INDEX_SEARCH_REVERSE = 0x1E,
 142   CEC_DECK_INFO_OTHER_STATUS = 0x1F
 143 } ECecDeckInfo;
 144
 145 typedef enum
 146 {
 147   CEC_DEVICE_TYPE_TV = 0,
 148   CEC_DEVICE_TYPE_RECORDING_DEVICE = 1,
 149   CEC_DEVICE_TYPE_RESERVED = 2,
 150   CEC_DEVICE_TYPE_TUNER = 3,
 151   CEC_DEVICE_TYPE_PLAYBACK_DEVICE = 4,
 152   CEC_DEVICE_TYPE_AUDIO_SYSTEM = 5
 153 } ECecDeviceType;
 154
 155 typedef enum
 156 {
 157   CEC_DISPLAY_CONTROL_DISPLAY_FOR_DEFAULT_TIME = 0x00,
 158   CEC_DISPLAY_CONTROL_DISPLAY_UNTIL_CLEARED = 0x40,
 159   CEC_DISPLAY_CONTROL_CLEAR_PREVIOUS_MESSAGE = 0x80,
 160   CEC_DISPLAY_CONTROL_RESERVED_FOR_FUTURE_USE = 0xC0
 161 } ECecDisplayControl;
 162
 163 typedef enum
 164 {
 165   CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PLUG = 4,
 166   CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PHYSICAL_ADDRESS = 5
 167 } ECecExternalSourceSpecifier;
 168
 169 typedef enum
 170 {
 171   CEC_MENU_REQUEST_TYPE_ACTIVATE = 0,
 172   CEC_MENU_REQUEST_TYPE_DEACTIVATE = 1,
 173   CEC_MENU_REQUEST_TYPE_QUERY = 2
 174 } ECecMenuRequestType;
 175
 176 typedef enum
 177 {
 178   CEC_MENU_STATE_ACTIVATED = 0,
 179   CEC_MENU_STATE_DEACTIVATED = 1
 180 } ECecMenuState;
 181
 182 typedef enum
 183 {
 184   CEC_PLAY_MODE_PLAY_FORWARD = 0x24,
 185   CEC_PLAY_MODE_PLAY_REVERSE = 0x20,
 186   CEC_PLAY_MODE_PLAY_STILL = 0x25,
 187   CEC_PLAY_MODE_FAST_FORWARD_MIN_SPEED = 0x05,
 188   CEC_PLAY_MODE_FAST_FORWARD_MEDIUM_SPEED = 0x06,
 189   CEC_PLAY_MODE_FAST_FORWARD_MAX_SPEED = 0x07,
 190   CEC_PLAY_MODE_FAST_REVERSE_MIN_SPEED = 0x09,
 191   CEC_PLAY_MODE_FAST_REVERSE_MEDIUM_SPEED = 0x0A,
 192   CEC_PLAY_MODE_FAST_REVERSE_MAX_SPEED = 0x0B,
 193   CEC_PLAY_MODE_SLOW_FORWARD_MIN_SPEED = 0x15,
 194   CEC_PLAY_MODE_SLOW_FORWARD_MEDIUM_SPEED = 0x16,
 195   CEC_PLAY_MODE_SLOW_FORWARD_MAX_SPEED = 0x17,
 196   CEC_PLAY_MODE_SLOW_REVERSE_MIN_SPEED = 0x19,
 197   CEC_PLAY_MODE_SLOW_REVERSE_MEDIUM_SPEED = 0x1A,
 198   CEC_PLAY_MODE_SLOW_REVERSE_MAX_SPEED = 0x1B
 199 } ECecPlayMode;
 200
 201 typedef enum
 202 {
 203   CEC_POWER_STATUS_ON = 0x00,
 204   CEC_POWER_STATUS_STANDBY = 0x01,
 205   CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON = 0x02,
 206   CEC_POWER_STATUS_IN_TRANSITION_ON_TO_STANDBY = 0x03
 207 } ECecPowerStatus;
 208
 209 typedef enum
 210 {
 211   CEC_RECORD_SOURCE_TYPE_OWN_SOURCE = 1,
 212   CEC_RECORD_SOURCE_TYPE_DIGITAL_SERVICE = 2,
 213   CEC_RECORD_SOURCE_TYPE_ANALOGUE_SERVICE = 3,
 214   CEC_RECORD_SOURCE_TYPE_EXTERNAL_PLUS = 4,
 215   CEC_RECORD_SOURCE_TYPE_EXTERNAL_PHYSICAL_ADDRESS = 5
 216 } ECecRecordSourceType;
 217
 218 typedef enum
 219 {
 220   CEC_RECORD_STATUS_INFO_RECORDING_CURRENTLY_SELECTED_SOURCE = 0x01,
 221   CEC_RECORD_STATUS_INFO_RECORDING_DIGITAL_SERVICE = 0x02,
 222   CEC_RECORD_STATUS_INFO_RECORDING_ANALOGUE_SERVICE = 0x03,
 223   CEC_RECORD_STATUS_INFO_RECORDING_EXTERNAL_INPUT = 0x04,
 224   CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_DIGITAL_SERVICE = 0x05,
 225   CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_ANALOGUE_SERVICE = 0x06,
 226   CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_SELECT_REQUIRED_SERVICE = 0x07,
 227   CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_PLUG_NUMBER = 0x09,
 228   CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_ADDRESS = 0x0A,
 229   CEC_RECORD_STATUS_INFO_NO_RECORDING_CA_SYSTEM_NOT_SUPPORTED = 0x0B,
 230   CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_OR_INSUFFICIENT_ENTITLEMENTS = 0x0C,
 231   CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ALLOWED_TO_COPY_SOURCE = 0x0D,
 232   CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_FURTHER_COPIES_ALLOWED = 0x0E,
 233   CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_MEDIA = 0x10,
 234   CEC_RECORD_STATUS_INFO_NO_RECORDING_PLAYING = 0x11,
 235   CEC_RECORD_STATUS_INFO_NO_RECORDING_ALREADY_RECORDING = 0x12,
 236   CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROTECTED = 0x13,
 237   CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_SOURCE_SIGNAL = 0x14,
 238   CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROBLEM = 0x15,
 239   CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ENOUGH_SPACE_AVAILABLE = 0x16,
 240   CEC_RECORD_STATUS_INFO_NO_RECORDING_PARENTAL_LOCK_ON = 0x17,
 241   CEC_RECORD_STATUS_INFO_RECORDING_TERMINATED_NORMALLY = 0x1A,
 242   CEC_RECORD_STATUS_INFO_RECORDING_HAS_ALREADY_TERMINATED = 0x1B,
 243   CEC_RECORD_STATUS_INFO_NO_RECORDING_OTHER_REASON = 0x1F
 244 } ECecRecordStatusInfo;
 245
 246 typedef enum
 247 {
 248   CEC_RECORDING_SEQUENCE_SUNDAY = 0x01,
 249   CEC_RECORDING_SEQUENCE_MONDAY = 0x02,
 250   CEC_RECORDING_SEQUENCE_TUESDAY = 0x04,
 251   CEC_RECORDING_SEQUENCE_WEDNESDAY = 0x08,
 252   CEC_RECORDING_SEQUENCE_THURSDAY = 0x10,
 253   CEC_RECORDING_SEQUENCE_FRIDAY = 0x20,
 254   CEC_RECORDING_SEQUENCE_SATURDAY = 0x40,
 255   CEC_RECORDING_SEQUENCE_ONCE_ONLY = 0x00
 256 } ECecRecordingSequence;
 257
 258 typedef enum
 259 {
 260   CEC_STATUS_REQUEST_ON = 1,
 261   CEC_STATUS_REQUEST_OFF = 2,
 262   CEC_STATUS_REQUEST_ONCE = 3
 263 } ECecStatusRequest;
 264
 265 typedef enum
 266 {
 267   CEC_SYSTEM_AUDIO_STATUS_OFF = 0,
 268   CEC_SYSTEM_AUDIO_STATUS_ON = 1
 269 } ECecSystemAudioStatus;
 270
 271 typedef enum
 272 {
 273   CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_RECORDING = 0x00,
 274   CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_MATCHING = 0x01,
 275   CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_INF0_AVAILABLE = 0x02,
 276   CEC_TIMER_CLEARED_STATUS_DATA_TIMER_CLEARED = 0x80
 277 } ECecTimerClearedStatusData;
 278
 279 typedef enum
 280 {
 281   CEC_TIMER_OVERLAP_WARNING_NO_OVERLAP = 0,
 282   CEC_TIMER_OVERLAP_WARNING_TIMER_BLOCKS_OVERLAP = 1
 283 } ECecTimerOverlapWarning;
 284
 285 typedef enum
 286 {
 287   CEC_MEDIA_INFO_MEDIA_PRESENT_AND_NOT_PROTECTED = 0x00,
 288   CEC_MEDIA_INFO_MEDIA_PRESENT_BUT_PROTECTED = 0x01,
 289   CEC_MEDIA_INFO_MEDIA_NOT_PRESENT = 0x02,
 290   CEC_MEDIA_INFO_FUTURE_USE = 0x03
 291 } ECecMediaInfo;
 292
 293 typedef enum
 294 {
 295   CEC_PROGRAMMED_INDICATOR_NOT_PROGRAMMED = 0,
 296   CEC_PROGRAMMED_INDICATOR_PROGRAMMED = 1
 297 } ECecProgrammedIndicator;
 298
 299 typedef enum
 300 {
 301   CEC_PROGRAMMED_INFO_FUTURE_USE = 0x0,
 302   CEC_PROGRAMMED_INFO_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING = 0x08,
 303   CEC_PROGRAMMED_INFO_NOT_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING = 0x09,
 304   CEC_PROGRAMMED_INFO_MAY_NOT_BE_ENOUGH_SPACE_AVAILABLE = 0x0B,
 305   CEC_PROGRAMMED_INFO_NO_MEDIA_INFO_AVAILABLE = 0x0A
 306 } ECecProgrammedInfo;
 307
 308 typedef enum
 309 {
 310   CEC_NOT_PROGRAMMED_ERROR_INFO_FUTURE_USE = 0x0,
 311   CEC_NOT_PROGRAMMED_ERROR_INFO_NO_FREE_TIMER_AVAILABLE = 0x01,
 312   CEC_NOT_PROGRAMMED_ERROR_INFO_DATE_OUT_OF_RANGE = 0x02,
 313   CEC_NOT_PROGRAMMED_ERROR_INFO_RECORDING_SEQUENCE_ERROR = 0x03,
 314   CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PLUG_NUMBER = 0x04,
 315   CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PHYSICAL_ADDRESS = 0x05,
 316   CEC_NOT_PROGRAMMED_ERROR_INFO_CA_SYSTEM_NOT_SUPPORTED = 0x06,
 317   CEC_NOT_PROGRAMMED_ERROR_INFO_NO_OR_INSUFFICIENT_CA_ENTITLEMENTS = 0x07,
 318   CEC_NOT_PROGRAMMED_ERROR_INFO_DOES_NOT_SUPPORT_RESOLUTION = 0x08,
 319   CEC_NOT_PROGRAMMED_ERROR_INFO_PARENTAL_LOCK_ON = 0x09,
 320   CEC_NOT_PROGRAMMED_ERROR_INFO_CLOCK_FAILURE = 0x0A,
 321   CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_START = 0x0B,
 322   CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_END = 0x0D,
 323   CEC_NOT_PROGRAMMED_ERROR_INFO_DUPLICATE_ALREADY_PROGRAMMED = 0x0E
 324 } ECecNotProgrammedErrorInfo;
 325
 326 typedef enum
 327 {
 328   CEC_RECORDING_FLAG_NOT_BEING_USED_FOR_RECORDING = 0,
 329   CEC_RECORDING_FLAG_BEING_USED_FOR_RECORDING = 1
 330 } ECecRecordingFlag;
 331
 332 typedef enum
 333 {
 334   CEC_TUNER_DISPLAY_INFO_DISPLAYING_DIGITAL_TUNER = 0,
 335   CEC_TUNER_DISPLAY_INFO_NOT_DISPLAYING_TUNER = 1,
 336   CEC_TUNER_DISPLAY_INFO_DISPLAYING_ANALOGUE_TUNER = 2
 337 } ECecTunerDisplayInfo;
 338
 339
 340 typedef enum
 341 {
 342   CEC_BROADCAST_SYSTEM_PAL_B_G = 0,
 343   CEC_BROADCAST_SYSTEM_SECAM_L1 = 1,
 344   CEC_BROADCAST_SYSTEM_PAL_M = 2,
 345   CEC_BROADCAST_SYSTEM_NTSC_M = 3,
 346   CEC_BROADCAST_SYSTEM_PAL_I = 4,
 347   CEC_BROADCAST_SYSTEM_SECAM_DK = 5,
 348   CEC_BROADCAST_SYSTEM_SECAM_B_G = 6,
 349   CEC_BROADCAST_SYSTEM_SECAM_L2 = 7,
 350   CEC_BROADCAST_SYSTEM_PAL_DK = 8,
 351   CEC_BROADCAST_SYSTEM_OTHER_SYSTEM = 30
 352 } ECecBroadcastSystem;
 353
 354 typedef enum cec_user_control_code
 355 {
 356   CEC_USER_CONTROL_CODE_SELECT = 0x00,
 357   CEC_USER_CONTROL_CODE_UP = 0x01,
 358   CEC_USER_CONTROL_CODE_DOWN = 0x02,
 359   CEC_USER_CONTROL_CODE_LEFT = 0x03,
 360   CEC_USER_CONTROL_CODE_RIGHT = 0x04,
 361   CEC_USER_CONTROL_CODE_RIGHT_UP = 0x05,
 362   CEC_USER_CONTROL_CODE_RIGHT_DOWN = 0x06,
 363   CEC_USER_CONTROL_CODE_LEFT_UP = 0x07,
 364   CEC_USER_CONTROL_CODE_LEFT_DOWN = 0x08,
 365   CEC_USER_CONTROL_CODE_ROOT_MENU = 0x09,
 366   CEC_USER_CONTROL_CODE_SETUP_MENU = 0x0A,
 367   CEC_USER_CONTROL_CODE_CONTENTS_MENU = 0x0B,
 368   CEC_USER_CONTROL_CODE_FAVORITE_MENU = 0x0C,
 369   CEC_USER_CONTROL_CODE_EXIT = 0x0D,
 370   CEC_USER_CONTROL_CODE_NUMBER0 = 0x20,
 371   CEC_USER_CONTROL_CODE_NUMBER1 = 0x21,
 372   CEC_USER_CONTROL_CODE_NUMBER2 = 0x22,
 373   CEC_USER_CONTROL_CODE_NUMBER3 = 0x23,
 374   CEC_USER_CONTROL_CODE_NUMBER4 = 0x24,
 375   CEC_USER_CONTROL_CODE_NUMBER5 = 0x25,
 376   CEC_USER_CONTROL_CODE_NUMBER6 = 0x26,
 377   CEC_USER_CONTROL_CODE_NUMBER7 = 0x27,
 378   CEC_USER_CONTROL_CODE_NUMBER8 = 0x28,
 379   CEC_USER_CONTROL_CODE_NUMBER9 = 0x29,
 380   CEC_USER_CONTROL_CODE_DOT = 0x2A,
 381   CEC_USER_CONTROL_CODE_ENTER = 0x2B,
 382   CEC_USER_CONTROL_CODE_CLEAR = 0x2C,
 383   CEC_USER_CONTROL_CODE_NEXT_FAVORITE = 0x2F,
 384   CEC_USER_CONTROL_CODE_CHANNEL_UP = 0x30,
 385   CEC_USER_CONTROL_CODE_CHANNEL_DOWN = 0x31,
 386   CEC_USER_CONTROL_CODE_PREVIOUS_CHANNEL = 0x32,
 387   CEC_USER_CONTROL_CODE_SOUND_SELECT = 0x33,
 388   CEC_USER_CONTROL_CODE_INPUT_SELECT = 0x34,
 389   CEC_USER_CONTROL_CODE_DISPLAY_INFORMATION = 0x35,
 390   CEC_USER_CONTROL_CODE_HELP = 0x36,
 391   CEC_USER_CONTROL_CODE_PAGE_UP = 0x37,
 392   CEC_USER_CONTROL_CODE_PAGE_DOWN = 0x38,
 393   CEC_USER_CONTROL_CODE_POWER = 0x40,
 394   CEC_USER_CONTROL_CODE_VOLUME_UP = 0x41,
 395   CEC_USER_CONTROL_CODE_VOLUME_DOWN = 0x42,
 396   CEC_USER_CONTROL_CODE_MUTE = 0x43,
 397   CEC_USER_CONTROL_CODE_PLAY = 0x44,
 398   CEC_USER_CONTROL_CODE_STOP = 0x45,
 399   CEC_USER_CONTROL_CODE_PAUSE = 0x46,
 400   CEC_USER_CONTROL_CODE_RECORD = 0x47,
 401   CEC_USER_CONTROL_CODE_REWIND = 0x48,
 402   CEC_USER_CONTROL_CODE_FAST_FORWARD = 0x49,
 403   CEC_USER_CONTROL_CODE_EJECT = 0x4A,
 404   CEC_USER_CONTROL_CODE_FORWARD = 0x4B,
 405   CEC_USER_CONTROL_CODE_BACKWARD = 0x4C,
 406   CEC_USER_CONTROL_CODE_STOP_RECORD = 0x4D,
 407   CEC_USER_CONTROL_CODE_PAUSE_RECORD = 0x4E,
 408   CEC_USER_CONTROL_CODE_ANGLE = 0x50,
 409   CEC_USER_CONTROL_CODE_SUB_PICTURE = 0x51,
 410   CEC_USER_CONTROL_CODE_VIDEO_ON_DEMAND = 0x52,
 411   CEC_USER_CONTROL_CODE_ELECTRONIC_PROGRAM_GUIDE = 0x53,
 412   CEC_USER_CONTROL_CODE_TIMER_PROGRAMMING = 0x54,
 413   CEC_USER_CONTROL_CODE_INITIAL_CONFIGURATION = 0x55,
 414   CEC_USER_CONTROL_CODE_PLAY_FUNCTION = 0x60,
 415   CEC_USER_CONTROL_CODE_PAUSE_PLAY_FUNCTION = 0x61,
 416   CEC_USER_CONTROL_CODE_RECORD_FUNCTION = 0x62,
 417   CEC_USER_CONTROL_CODE_PAUSE_RECORD_FUNCTION = 0x63,
 418   CEC_USER_CONTROL_CODE_STOP_FUNCTION = 0x64,
 419   CEC_USER_CONTROL_CODE_MUTE_FUNCTION = 0x65,
 420   CEC_USER_CONTROL_CODE_RESTORE_VOLUME_FUNCTION = 0x66,
 421   CEC_USER_CONTROL_CODE_TUNE_FUNCTION = 0x67,
 422   CEC_USER_CONTROL_CODE_SELECT_MEDIA_FUNCTION = 0x68,
 423   CEC_USER_CONTROL_CODE_SELECT_AV_INPUT_FUNCTION = 0x69,
 424   CEC_USER_CONTROL_CODE_SELECT_AUDIO_INPUT_FUNCTION = 0x6A,
 425   CEC_USER_CONTROL_CODE_POWER_TOGGLE_FUNCTION = 0x6B,
 426   CEC_USER_CONTROL_CODE_POWER_OFF_FUNCTION = 0x6C,
 427   CEC_USER_CONTROL_CODE_POWER_ON_FUNCTION = 0x6D,
 428   CEC_USER_CONTROL_CODE_F1_BLUE = 0x71,
 429   CEC_USER_CONTROL_CODE_F2_RED = 0X72,
 430   CEC_USER_CONTROL_CODE_F3_GREEN = 0x73,
 431   CEC_USER_CONTROL_CODE_F4_YELLOW = 0x74,
 432   CEC_USER_CONTROL_CODE_F5 = 0x75,
 433   CEC_USER_CONTROL_CODE_DATA = 0x76,
 434   CEC_USER_CONTROL_CODE_MAX = 0x76,
 435   CEC_USER_CONTROL_CODE_UNKNOWN
 436 } cec_user_control_code;
 437
 438 typedef enum cec_logical_address
 439 {
 440   CECDEVICE_UNKNOWN = -1, //not a valid logical address
 441   CECDEVICE_TV,
 442   CECDEVICE_RECORDINGDEVICE1,
 443   CECDEVICE_RECORDINGDEVICE2,
 444   CECDEVICE_TUNER1,
 445   CECDEVICE_PLAYBACKDEVICE1,
 446   CECDEVICE_AUDIOSYSTEM,
 447   CECDEVICE_TUNER2,
 448   CECDEVICE_TUNER3,
 449   CECDEVICE_PLAYBACKDEVICE2,
 450   CECDEVICE_RECORDINGDEVICE3,
 451   CECDEVICE_TUNER4,
 452   CECDEVICE_PLAYBACKDEVICE3,
 453   CECDEVICE_RESERVED1,
 454   CECDEVICE_RESERVED2,
 455   CECDEVICE_FREEUSE,
 456   CECDEVICE_UNREGISTERED = 15,
 457   CECDEVICE_BROADCAST = 15
 458 } cec_logical_address;
 459
 460 typedef enum cec_opcode
 461 {
 462   CEC_OPCODE_ACTIVE_SOURCE = 0x82,
 463   CEC_OPCODE_IMAGE_VIEW_ON = 0x04,
 464   CEC_OPCODE_TEXT_VIEW_ON = 0x0D,
 465   CEC_OPCODE_INACTIVE_SOURCE = 0x9D,
 466   CEC_OPCODE_REQUEST_ACTIVE_SOURCE = 0x85,
 467   CEC_OPCODE_ROUTING_CHANGE = 0x80,
 468   CEC_OPCODE_ROUTING_INFORMATION = 0x81,
 469   CEC_OPCODE_SET_STREAM_PATH = 0x86,
 470   CEC_OPCODE_STANDBY = 0x36,
 471   CEC_OPCODE_RECORD_OFF = 0x0B,
 472   CEC_OPCODE_RECORD_ON = 0x09,
 473   CEC_OPCODE_RECORD_STATUS = 0x0A,
 474   CEC_OPCODE_RECORD_TV_SCREEN = 0x0F,
 475   CEC_OPCODE_CLEAR_ANALOGUE_TIMER = 0x33,
 476   CEC_OPCODE_CLEAR_DIGITAL_TIMER = 0x99,
 477   CEC_OPCODE_CLEAR_EXTERNAL_TIMER = 0xA1,
 478   CEC_OPCODE_SET_ANALOGUE_TIMER = 0x34,
 479   CEC_OPCODE_SET_DIGITAL_TIMER = 0x97,
 480   CEC_OPCODE_SET_EXTERNAL_TIMER = 0xA2,
 481   CEC_OPCODE_SET_TIMER_PROGRAM_TITLE = 0x67,
 482   CEC_OPCODE_TIMER_CLEARED_STATUS = 0x43,
 483   CEC_OPCODE_TIMER_STATUS = 0x35,
 484   CEC_OPCODE_CEC_VERSION = 0x9E,
 485   CEC_OPCODE_GET_CEC_VERSION = 0x9F,
 486   CEC_OPCODE_GIVE_PHYSICAL_ADDRESS = 0x83,
 487   CEC_OPCODE_GET_MENU_LANGUAGE = 0x91,
 488   CEC_OPCODE_REPORT_PHYSICAL_ADDRESS = 0x84,
 489   CEC_OPCODE_SET_MENU_LANGUAGE = 0x32,
 490   CEC_OPCODE_DECK_CONTROL = 0x42,
 491   CEC_OPCODE_DECK_STATUS = 0x1B,
 492   CEC_OPCODE_GIVE_DECK_STATUS = 0x1A,
 493   CEC_OPCODE_PLAY = 0x41,
 494   CEC_OPCODE_GIVE_TUNER_DEVICE_STATUS = 0x08,
 495   CEC_OPCODE_SELECT_ANALOGUE_SERVICE = 0x92,
 496   CEC_OPCODE_SELECT_DIGITAL_SERVICE = 0x93,
 497   CEC_OPCODE_TUNER_DEVICE_STATUS = 0x07,
 498   CEC_OPCODE_TUNER_STEP_DECREMENT = 0x06,
 499   CEC_OPCODE_TUNER_STEP_INCREMENT = 0x05,
 500   CEC_OPCODE_DEVICE_VENDOR_ID = 0x87,
 501   CEC_OPCODE_GIVE_DEVICE_VENDOR_ID = 0x8C,
 502   CEC_OPCODE_VENDOR_COMMAND = 0x89,
 503   CEC_OPCODE_VENDOR_COMMAND_WITH_ID = 0xA0,
 504   CEC_OPCODE_VENDOR_REMOTE_BUTTON_DOWN = 0x8A,
 505   CEC_OPCODE_VENDOR_REMOTE_BUTTON_UP = 0x8B,
 506   CEC_OPCODE_SET_OSD_STRING = 0x64,
 507   CEC_OPCODE_GIVE_OSD_NAME = 0x46,
 508   CEC_OPCODE_SET_OSD_NAME = 0x47,
 509   CEC_OPCODE_MENU_REQUEST = 0x8D,
 510   CEC_OPCODE_MENU_STATUS = 0x8E,
 511   CEC_OPCODE_USER_CONTROL_PRESSED = 0x44,
 512   CEC_OPCODE_USER_CONTROL_RELEASE = 0x45,
 513   CEC_OPCODE_GIVE_DEVICE_POWER_STATUS = 0x8F,
 514   CEC_OPCODE_REPORT_POWER_STATUS = 0x90,
 515   CEC_OPCODE_FEATURE_ABORT = 0x00,
 516   CEC_OPCODE_ABORT = 0xFF,
 517   CEC_OPCODE_GIVE_AUDIO_STATUS = 0x71,
 518   CEC_OPCODE_GIVE_SYSTEM_AUDIO_MODE_STATUS = 0x7D,
 519   CEC_OPCODE_REPORT_AUDIO_STATUS = 0x7A,
 520   CEC_OPCODE_SET_SYSTEM_AUDIO_MODE = 0x72,
 521   CEC_OPCODE_SYSTEM_AUDIO_MODE_REQUEST = 0x70,
 522   CEC_OPCODE_SYSTEM_AUDIO_MODE_STATUS = 0x7E,
 523   CEC_OPCODE_SET_AUDIO_RATE = 0x9A
 524 } cec_opcode;
 525
 526 typedef enum cec_log_level
 527 {
 528   CEC_LOG_DEBUG = 0,
 529   CEC_LOG_NOTICE,
 530   CEC_LOG_WARNING,
 531   CEC_LOG_ERROR
 532 } cec_log_level;
 533
 534 typedef struct cec_log_message
 535 {
 536   char          message[1024];
 537   cec_log_level level;
 538   int64_t       time;
 539 } cec_log_message;
 540
 541 typedef struct cec_keypress
 542 {
 543   cec_user_control_code keycode;
 544   unsigned int          duration;
 545 } cec_keypress;
 546
 547 typedef struct cec_adapter
 548 {
 549   char path[1024];
 550   char comm[1024];
 551 } cec_adapter;
 552
 553 typedef enum cec_adapter_messagecode
 554 {
 555   MSGCODE_NOTHING = 0,
 556   MSGCODE_PING,
 557   MSGCODE_TIMEOUT_ERROR,
 558   MSGCODE_HIGH_ERROR,
 559   MSGCODE_LOW_ERROR,
 560   MSGCODE_FRAME_START,
 561   MSGCODE_FRAME_DATA,
 562   MSGCODE_RECEIVE_FAILED,
 563   MSGCODE_COMMAND_ACCEPTED,
 564   MSGCODE_COMMAND_REJECTED,
 565   MSGCODE_SET_ACK_MASK,
 566   MSGCODE_TRANSMIT,
 567   MSGCODE_TRANSMIT_EOM,
 568   MSGCODE_TRANSMIT_IDLETIME,
 569   MSGCODE_TRANSMIT_ACK_POLARITY,
 570   MSGCODE_TRANSMIT_LINE_TIMEOUT,
 571   MSGCODE_TRANSMIT_SUCCEEDED,
 572   MSGCODE_TRANSMIT_FAILED_LINE,
 573   MSGCODE_TRANSMIT_FAILED_ACK,
 574   MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA,
 575   MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE,
 576   MSGCODE_FIRMWARE_VERSION,
 577   MSGCODE_START_BOOTLOADER,
 578   MSGCODE_FRAME_EOM = 0x80,
 579   MSGCODE_FRAME_ACK = 0x40,
 580 } cec_adapter_messagecode;
 581
 582 typedef struct cec_datapacket
 583 {
 584   uint8_t data[100];
 585   uint8_t size;
 586
 587 #ifdef __cplusplus
 588   bool    empty(void) const             { return size == 0; }
 589   bool    full(void) const              { return size == 100; }
 590   uint8_t operator[](uint8_t pos) const { return pos < size ? data[pos] : 0; }
 591   uint8_t at(uint8_t pos) const         { return pos < size ? data[pos] : 0; }
 592
 593   void shift(uint8_t iShiftBy)
 594   {
 595     if (iShiftBy >= size)
 596     {
 597       clear();
 598     }
 599     else
 600     {
 601       for (uint8_t iPtr = 0; iPtr < size; iPtr++)
 602         data[iPtr] = (iPtr + iShiftBy < size) ? data[iPtr + iShiftBy] : 0;
 603       size = (uint8_t) (size - iShiftBy);
 604     }
 605   }
 606
 607   void push_back(uint8_t add)
 608   {
 609     if (size < 100)
 610       data[size++] = add;
 611   }
 612
 613   void clear(void)
 614   {
 615     memset(data, 0, sizeof(data));
 616     size = 0;
 617   }
 618 #endif
 619
 620 } cec_datapacket;
 621
 622 typedef struct cec_adapter_message
 623 {
 624   cec_datapacket packet;
 625
 626 #ifdef __cplusplus
 627   bool                    empty(void) const             { return packet.empty(); }
 628   uint8_t                 operator[](uint8_t pos) const { return packet[pos]; }
 629   uint8_t                 at(uint8_t pos) const         { return packet[pos]; }
 630   uint8_t                 size(void) const              { return packet.size; }
 631   void                    clear(void)                   { packet.clear(); }
 632   void                    shift(uint8_t iShiftBy)       { packet.shift(iShiftBy); }
 633   void                    push_back(uint8_t add)        { packet.push_back(add); }
 634   cec_adapter_messagecode message(void) const           { return packet.size >= 1 ? (cec_adapter_messagecode) (packet.at(0) & ~(MSGCODE_FRAME_EOM | MSGCODE_FRAME_ACK))  : MSGCODE_NOTHING; }
 635   bool                    eom(void) const               { return packet.size >= 1 ? (packet.at(0) & MSGCODE_FRAME_EOM) != 0 : false; }
 636   bool                    ack(void) const               { return packet.size >= 1 ? (packet.at(0) & MSGCODE_FRAME_ACK) != 0 : false; }
 637   cec_logical_address     initiator(void) const         { return packet.size >= 2 ? (cec_logical_address) (packet.at(1) >> 4)  : CECDEVICE_UNKNOWN; };
 638   cec_logical_address     destination(void) const       { return packet.size >= 2 ? (cec_logical_address) (packet.at(1) & 0xF) : CECDEVICE_UNKNOWN; };
 639 #endif
 640 } cec_adapter_message;
 641
 642 typedef struct cec_command
 643 {
 644   cec_logical_address initiator;
 645   cec_logical_address destination;
 646   bool                ack;
 647   bool                eom;
 648   cec_opcode          opcode;
 649   cec_datapacket      parameters;
 650   bool                opcode_set;
 651
 652 #ifdef __cplusplus
 653   static void format(cec_command &command, cec_logical_address initiator, cec_logical_address destination, cec_opcode opcode)
 654   {
 655     command.clear();
 656     command.initiator   = initiator;
 657     command.destination = destination;
 658     command.opcode      = opcode;
 659     command.opcode_set  = true;
 660   }
 661
 662   void push_back(uint8_t data)
 663   {
 664     if (!opcode_set)
 665     {
 666       opcode_set = true;
 667       opcode = (cec_opcode) data;
 668     }
 669     else
 670       parameters.push_back(data);
 671   }
 672
 673   void clear(void)
 674   {
 675     initiator   = CECDEVICE_UNKNOWN;
 676     destination = CECDEVICE_UNKNOWN;
 677     ack         = false;
 678     eom         = false;
 679     opcode_set  = false;
 680     opcode      = CEC_OPCODE_FEATURE_ABORT;
 681     parameters.clear();
 682   };
 683 #endif
 684 } cec_command;
 685
 686 typedef enum cec_vendor_id
 687 {
 688   CEC_VENDOR_SAMSUNG = 240,
 689   CEC_VENDOR_UNKNOWN = 0
 690 } vendor_id;
 691
 692 //default physical address 1.0.0.0
 693 #define CEC_DEFAULT_PHYSICAL_ADDRESS 0x1000
 694 #define MSGSTART                     0xFF
 695 #define MSGEND                       0xFE
 696 #define MSGESC                       0xFD
 697 #define ESCOFFSET                    3
 698 #define CEC_MIN_VERSION              6
 699 #define CEC_LIB_VERSION              7
 700 #define CEC_SETTLE_DOWN_TIME         1500
 701 #define CEC_BUTTON_TIMEOUT           500
 702
 703 #ifdef __cplusplus
 704 };
 705 };
 706 #endif
 707
 708 #endif /* CECTYPES_H_ */