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 #include <stdint.h>
  35 #include <vector>
  36 #include <string>
  37 #include "CECExports.h"
  38
  39 typedef enum
  40 {
  41   CEC_ABORT_REASON_UNRECOGNIZED_OPCODE = 0,
  42   CEC_ABORT_REASON_NOT_IN_CORRECT_MODE_TO_RESPOND = 1,
  43   CEC_ABORT_REASON_CANNOT_PROVIDE_SOURCE = 2,
  44   CEC_ABORT_REASON_INVALID_OPERAND = 3,
  45   CEC_ABORT_REASON_REFUSED = 4
  46 } ECecAbortReason;
  47
  48 typedef enum
  49 {
  50   CEC_ANALOGUE_BROADCAST_TYPE_CABLE = 0x00,
  51   CEC_ANALOGUE_BROADCAST_TYPE_SATELLITE = 0x01,
  52   CEC_ANALOGUE_BROADCAST_TYPE_TERRESTIAL = 0x02
  53 } ECecAnalogueBroadcastType;
  54
  55 typedef enum
  56 {
  57   CEC_AUDIO_RATE_RATE_CONTROL_OFF = 0,
  58   CEC_AUDIO_RATE_STANDARD_RATE_100 = 1,
  59   CEC_AUDIO_RATE_FAST_RATE_MAX_101 = 2,
  60   CEC_AUDIO_RATE_SLOW_RATE_MIN_99 = 3,
  61   CEC_AUDIO_RATE_STANDARD_RATE_100_0 = 4,
  62   CEC_AUDIO_RATE_FAST_RATE_MAX_100_1 = 5,
  63   CEC_AUDIO_RATE_SLOW_RATE_MIN_99_9 = 6
  64 } ECecAudioRate;
  65
  66 typedef enum
  67 {
  68   CEC_AUDIO_MUTE_STATUS_MASK = 0x80,
  69   CEC_AUDIO_VOLUME_STATUS_MASK = 0x7F,
  70   CEC_AUDIO_VOLUME_MIN = 0x00,
  71   CEC_AUDIO_VOLUME_MAX = 0x64,
  72   CEC_AUDIO_VOLUME_STATUS_UNKNOWN = 0x7F
  73 } ECecAudioStatus;
  74
  75 typedef enum
  76 {
  77   CEC_FALSE = 0,
  78   CEC_TRUE = 1
  79 } ECecBoolean;
  80
  81 typedef enum
  82 {
  83   CEC_VERSION_1_2 = 0x01,
  84   CEC_VERSION_1_2A = 0x02,
  85   CEC_VERSION_1_3 = 0x03,
  86   CEC_VERSION_1_3A = 0x04
  87 } ECecVersion;
  88
  89 typedef enum
  90 {
  91   CEC_CHANNEL_NUMBER_FORMAT_MASK = 0xFC000000,
  92   CEC_1_PART_CHANNEL_NUMBER = 0x04000000,
  93   CEC_2_PART_CHANNEL_NUMBER = 0x08000000,
  94   CEC_MAJOR_CHANNEL_NUMBER_MASK = 0x3FF0000,
  95   CEC_MINOR_CHANNEL_NUMBER_MASK = 0xFFFF
  96 } ECecChannelIdentifier;
  97
  98 typedef enum
  99 {
 100   CEC_DESK_CONTROL_MODE_SKIP_FORWARD_WIND = 1,
 101   CEC_DESK_CONTROL_MODE_SKIP_REVERSE_REWIND = 2,
 102   CEC_DESK_CONTROL_MODE_STOP = 3,
 103   CEC_DESK_CONTROL_MODE_EJECT = 4
 104 } ECecDeskControlMode;
 105
 106 typedef enum
 107 {
 108   CEC_DECK_INFO_PLAY = 0x11,
 109   CEC_DECK_INFO_RECORD = 0x12,
 110   CEC_DECK_INFO_PLAY_REVERSE = 0x13,
 111   CEC_DECK_INFO_STILL = 0x14,
 112   CEC_DECK_INFO_SLOW = 0x15,
 113   CEC_DECK_INFO_SLOW_REVERSE = 0x16,
 114   CEC_DECK_INFO_FAST_FORWARD = 0x17,
 115   CEC_DECK_INFO_FAST_REVERSE = 0x18,
 116   CEC_DECK_INFO_NO_MEDIA = 0x19,
 117   CEC_DECK_INFO_STOP = 0x1A,
 118   CEC_DECK_INFO_SKIP_FORWARD_WIND = 0x1B,
 119   CEC_DECK_INFO_SKIP_REVERSE_REWIND = 0x1C,
 120   CEC_DECK_INFO_INDEX_SEARCH_FORWARD = 0x1D,
 121   CEC_DECK_INFO_INDEX_SEARCH_REVERSE = 0x1E,
 122   CEC_DECK_INFO_OTHER_STATUS = 0x1F
 123 } ECecDeckInfo;
 124
 125 typedef enum
 126 {
 127   CEC_DEVICE_TYPE_TV = 0,
 128   CEC_DEVICE_TYPE_RECORDING_DEVICE = 1,
 129   CEC_DEVICE_TYPE_RESERVED = 2,
 130   CEC_DEVICE_TYPE_TUNER = 3,
 131   CEC_DEVICE_TYPE_PLAYBACK_DEVICE = 4,
 132   CEC_DEVICE_TYPE_AUDIO_SYSTEM = 5
 133 } ECecDeviceType;
 134
 135 typedef enum
 136 {
 137   CEC_DISPLAY_CONTROL_DISPLAY_FOR_DEFAULT_TIME = 0x00,
 138   CEC_DISPLAY_CONTROL_DISPLAY_UNTIL_CLEARED = 0x40,
 139   CEC_DISPLAY_CONTROL_CLEAR_PREVIOUS_MESSAGE = 0x80,
 140   CEC_DISPLAY_CONTROL_RESERVED_FOR_FUTURE_USE = 0xC0
 141 } ECecDisplayControl;
 142
 143 typedef enum
 144 {
 145   CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PLUG = 4,
 146   CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PHYSICAL_ADDRESS = 5
 147 } ECecExternalSourceSpecifier;
 148
 149 typedef enum
 150 {
 151   CEC_MENU_REQUEST_TYPE_ACTIVATE = 0,
 152   CEC_MENU_REQUEST_TYPE_DEACTIVATE = 1,
 153   CEC_MENU_REQUEST_TYPE_QUERY = 2
 154 } ECecMenuRequestType;
 155
 156 typedef enum
 157 {
 158   CEC_MENU_STATE_ACTIVATED = 0,
 159   CEC_MENU_STATE_DEACTIVATED = 1
 160 } ECecMenuState;
 161
 162 typedef enum
 163 {
 164   CEC_PLAY_MODE_PLAY_FORWARD = 0x24,
 165   CEC_PLAY_MODE_PLAY_REVERSE = 0x20,
 166   CEC_PLAY_MODE_PLAY_STILL = 0x25,
 167   CEC_PLAY_MODE_FAST_FORWARD_MIN_SPEED = 0x05,
 168   CEC_PLAY_MODE_FAST_FORWARD_MEDIUM_SPEED = 0x06,
 169   CEC_PLAY_MODE_FAST_FORWARD_MAX_SPEED = 0x07,
 170   CEC_PLAY_MODE_FAST_REVERSE_MIN_SPEED = 0x09,
 171   CEC_PLAY_MODE_FAST_REVERSE_MEDIUM_SPEED = 0x0A,
 172   CEC_PLAY_MODE_FAST_REVERSE_MAX_SPEED = 0x0B,
 173   CEC_PLAY_MODE_SLOW_FORWARD_MIN_SPEED = 0x15,
 174   CEC_PLAY_MODE_SLOW_FORWARD_MEDIUM_SPEED = 0x16,
 175   CEC_PLAY_MODE_SLOW_FORWARD_MAX_SPEED = 0x17,
 176   CEC_PLAY_MODE_SLOW_REVERSE_MIN_SPEED = 0x19,
 177   CEC_PLAY_MODE_SLOW_REVERSE_MEDIUM_SPEED = 0x1A,
 178   CEC_PLAY_MODE_SLOW_REVERSE_MAX_SPEED = 0x1B
 179 } ECecPlayMode;
 180
 181 typedef enum
 182 {
 183   CEC_POWER_STATUS_ON = 0x00,
 184   CEC_POWER_STATUS_STANDBY = 0x01,
 185   CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON = 0x02,
 186   CEC_POWER_STATUS_IN_TRANSITION_ON_TO_STANDBY = 0x03
 187 } ECecPowerStatus;
 188
 189 typedef enum
 190 {
 191   CEC_RECORD_SOURCE_TYPE_OWN_SOURCE = 1,
 192   CEC_RECORD_SOURCE_TYPE_DIGITAL_SERVICE = 2,
 193   CEC_RECORD_SOURCE_TYPE_ANALOGUE_SERVICE = 3,
 194   CEC_RECORD_SOURCE_TYPE_EXTERNAL_PLUS = 4,
 195   CEC_RECORD_SOURCE_TYPE_EXTERNAL_PHYSICAL_ADDRESS = 5
 196 } ECecRecordSourceType;
 197
 198 typedef enum
 199 {
 200   CEC_RECORD_STATUS_INFO_RECORDING_CURRENTLY_SELECTED_SOURCE = 0x01,
 201   CEC_RECORD_STATUS_INFO_RECORDING_DIGITAL_SERVICE = 0x02,
 202   CEC_RECORD_STATUS_INFO_RECORDING_ANALOGUE_SERVICE = 0x03,
 203   CEC_RECORD_STATUS_INFO_RECORDING_EXTERNAL_INPUT = 0x04,
 204   CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_DIGITAL_SERVICE = 0x05,
 205   CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_ANALOGUE_SERVICE = 0x06,
 206   CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_SELECT_REQUIRED_SERVICE = 0x07,
 207   CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_PLUG_NUMBER = 0x09,
 208   CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_ADDRESS = 0x0A,
 209   CEC_RECORD_STATUS_INFO_NO_RECORDING_CA_SYSTEM_NOT_SUPPORTED = 0x0B,
 210   CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_OR_INSUFFICIENT_ENTITLEMENTS = 0x0C,
 211   CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ALLOWED_TO_COPY_SOURCE = 0x0D,
 212   CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_FURTHER_COPIES_ALLOWED = 0x0E,
 213   CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_MEDIA = 0x10,
 214   CEC_RECORD_STATUS_INFO_NO_RECORDING_PLAYING = 0x11,
 215   CEC_RECORD_STATUS_INFO_NO_RECORDING_ALREADY_RECORDING = 0x12,
 216   CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROTECTED = 0x13,
 217   CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_SOURCE_SIGNAL = 0x14,
 218   CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROBLEM = 0x15,
 219   CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ENOUGH_SPACE_AVAILABLE = 0x16,
 220   CEC_RECORD_STATUS_INFO_NO_RECORDING_PARENTAL_LOCK_ON = 0x17,
 221   CEC_RECORD_STATUS_INFO_RECORDING_TERMINATED_NORMALLY = 0x1A,
 222   CEC_RECORD_STATUS_INFO_RECORDING_HAS_ALREADY_TERMINATED = 0x1B,
 223   CEC_RECORD_STATUS_INFO_NO_RECORDING_OTHER_REASON = 0x1F
 224 } ECecRecordStatusInfo;
 225
 226 typedef enum
 227 {
 228   CEC_RECORDING_SEQUENCE_SUNDAY = 0x01,
 229   CEC_RECORDING_SEQUENCE_MONDAY = 0x02,
 230   CEC_RECORDING_SEQUENCE_TUESDAY = 0x04,
 231   CEC_RECORDING_SEQUENCE_WEDNESDAY = 0x08,
 232   CEC_RECORDING_SEQUENCE_THURSDAY = 0x10,
 233   CEC_RECORDING_SEQUENCE_FRIDAY = 0x20,
 234   CEC_RECORDING_SEQUENCE_SATURDAY = 0x40,
 235   CEC_RECORDING_SEQUENCE_ONCE_ONLY = 0x00
 236 } ECecRecordingSequence;
 237
 238 typedef enum
 239 {
 240   CEC_STATUS_REQUEST_ON = 1,
 241   CEC_STATUS_REQUEST_OFF = 2,
 242   CEC_STATUS_REQUEST_ONCE = 3
 243 } ECecStatusRequest;
 244
 245 typedef enum
 246 {
 247   CEC_SYSTEM_AUDIO_STATUS_OFF = 0,
 248   CEC_SYSTEM_AUDIO_STATUS_ON = 1
 249 } ECecSystemAudioStatus;
 250
 251 typedef enum
 252 {
 253   CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_RECORDING = 0x00,
 254   CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_MATCHING = 0x01,
 255   CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_INF0_AVAILABLE = 0x02,
 256   CEC_TIMER_CLEARED_STATUS_DATA_TIMER_CLEARED = 0x80
 257 } ECecTimerClearedStatusData;
 258
 259 typedef enum
 260 {
 261   CEC_TIMER_OVERLAP_WARNING_NO_OVERLAP = 0,
 262   CEC_TIMER_OVERLAP_WARNING_TIMER_BLOCKS_OVERLAP = 1
 263 } ECecTimerOverlapWarning;
 264
 265 typedef enum
 266 {
 267   CEC_MEDIA_INFO_MEDIA_PRESENT_AND_NOT_PROTECTED = 0x00,
 268   CEC_MEDIA_INFO_MEDIA_PRESENT_BUT_PROTECTED = 0x01,
 269   CEC_MEDIA_INFO_MEDIA_NOT_PRESENT = 0x02,
 270   CEC_MEDIA_INFO_FUTURE_USE = 0x03
 271 } ECecMediaInfo;
 272
 273 typedef enum
 274 {
 275   CEC_PROGRAMMED_INDICATOR_NOT_PROGRAMMED = 0,
 276   CEC_PROGRAMMED_INDICATOR_PROGRAMMED = 1
 277 } ECecProgrammedIndicator;
 278
 279 typedef enum
 280 {
 281   CEC_PROGRAMMED_INFO_FUTURE_USE = 0x0,
 282   CEC_PROGRAMMED_INFO_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING = 0x08,
 283   CEC_PROGRAMMED_INFO_NOT_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING = 0x09,
 284   CEC_PROGRAMMED_INFO_MAY_NOT_BE_ENOUGH_SPACE_AVAILABLE = 0x0B,
 285   CEC_PROGRAMMED_INFO_NO_MEDIA_INFO_AVAILABLE = 0x0A
 286 } ECecProgrammedInfo;
 287
 288 typedef enum
 289 {
 290   CEC_NOT_PROGRAMMED_ERROR_INFO_FUTURE_USE = 0x0,
 291   CEC_NOT_PROGRAMMED_ERROR_INFO_NO_FREE_TIMER_AVAILABLE = 0x01,
 292   CEC_NOT_PROGRAMMED_ERROR_INFO_DATE_OUT_OF_RANGE = 0x02,
 293   CEC_NOT_PROGRAMMED_ERROR_INFO_RECORDING_SEQUENCE_ERROR = 0x03,
 294   CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PLUG_NUMBER = 0x04,
 295   CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PHYSICAL_ADDRESS = 0x05,
 296   CEC_NOT_PROGRAMMED_ERROR_INFO_CA_SYSTEM_NOT_SUPPORTED = 0x06,
 297   CEC_NOT_PROGRAMMED_ERROR_INFO_NO_OR_INSUFFICIENT_CA_ENTITLEMENTS = 0x07,
 298   CEC_NOT_PROGRAMMED_ERROR_INFO_DOES_NOT_SUPPORT_RESOLUTION = 0x08,
 299   CEC_NOT_PROGRAMMED_ERROR_INFO_PARENTAL_LOCK_ON = 0x09,
 300   CEC_NOT_PROGRAMMED_ERROR_INFO_CLOCK_FAILURE = 0x0A,
 301   CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_START = 0x0B,
 302   CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_END = 0x0D,
 303   CEC_NOT_PROGRAMMED_ERROR_INFO_DUPLICATE_ALREADY_PROGRAMMED = 0x0E
 304 } ECecNotProgrammedErrorInfo;
 305
 306 typedef enum
 307 {
 308   CEC_RECORDING_FLAG_NOT_BEING_USED_FOR_RECORDING = 0,
 309   CEC_RECORDING_FLAG_BEING_USED_FOR_RECORDING = 1
 310 } ECecRecordingFlag;
 311
 312 typedef enum
 313 {
 314   CEC_TUNER_DISPLAY_INFO_DISPLAYING_DIGITAL_TUNER = 0,
 315   CEC_TUNER_DISPLAY_INFO_NOT_DISPLAYING_TUNER = 1,
 316   CEC_TUNER_DISPLAY_INFO_DISPLAYING_ANALOGUE_TUNER = 2
 317 } ECecTunerDisplayInfo;
 318
 319
 320 typedef enum
 321 {
 322   CEC_BROADCAST_SYSTEM_PAL_B_G = 0,
 323   CEC_BROADCAST_SYSTEM_SECAM_L1 = 1,
 324   CEC_BROADCAST_SYSTEM_PAL_M = 2,
 325   CEC_BROADCAST_SYSTEM_NTSC_M = 3,
 326   CEC_BROADCAST_SYSTEM_PAL_I = 4,
 327   CEC_BROADCAST_SYSTEM_SECAM_DK = 5,
 328   CEC_BROADCAST_SYSTEM_SECAM_B_G = 6,
 329   CEC_BROADCAST_SYSTEM_SECAM_L2 = 7,
 330   CEC_BROADCAST_SYSTEM_PAL_DK = 8,
 331   CEC_BROADCAST_SYSTEM_OTHER_SYSTEM = 30
 332 } ECecBroadcastSystem;
 333
 334 typedef enum
 335 {
 336   MSGCODE_NOTHING = 0,
 337   MSGCODE_PING,
 338   MSGCODE_TIMEOUT_ERROR,
 339   MSGCODE_HIGH_ERROR,
 340   MSGCODE_LOW_ERROR,
 341   MSGCODE_FRAME_START,
 342   MSGCODE_FRAME_DATA,
 343   MSGCODE_RECEIVE_FAILED,
 344   MSGCODE_COMMAND_ACCEPTED,
 345   MSGCODE_COMMAND_REJECTED,
 346   MSGCODE_SET_ACK_MASK,
 347   MSGCODE_TRANSMIT,
 348   MSGCODE_TRANSMIT_EOM,
 349   MSGCODE_TRANSMIT_IDLETIME,
 350   MSGCODE_TRANSMIT_ACK_POLARITY,
 351   MSGCODE_TRANSMIT_LINE_TIMEOUT,
 352   MSGCODE_TRANSMIT_SUCCEEDED,
 353   MSGCODE_TRANSMIT_FAILED_LINE,
 354   MSGCODE_TRANSMIT_FAILED_ACK,
 355   MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA,
 356   MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE,
 357   MSGCODE_FIRMWARE_VERSION,
 358   MSGCODE_START_BOOTLOADER,
 359   MSGCODE_FRAME_EOM = 0x80,
 360   MSGCODE_FRAME_ACK = 0x40,
 361 } ECecMessageCode;
 362
 363 #define MSGSTART                     0xFF
 364 #define MSGEND                       0xFE
 365 #define MSGESC                       0xFD
 366 #define ESCOFFSET                    3