Added support for user control codes TOP_MENU, DVD_MENU, SELECT_BROADCAST_TYPE, SELEC...
[deb_libcec.git] / include / cectypes.h
index 58c7f6c15f32c4ca224af8f455bc5304da4280a9..a220d6c551801e4963c970d6842d3f26cc863a90 100644 (file)
@@ -2,7 +2,7 @@
 /*
  * This file is part of the libCEC(R) library.
  *
- * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited.  All rights reserved.
+ * libCEC(R) is Copyright (C) 2011-2013 Pulse-Eight Limited.  All rights reserved.
  * libCEC(R) is an original work, containing original code.
  *
  * libCEC(R) is a trademark of Pulse-Eight Limited.
@@ -636,6 +636,13 @@ typedef enum cec_user_control_code
   CEC_USER_CONTROL_CODE_CONTENTS_MENU               = 0x0B,
   CEC_USER_CONTROL_CODE_FAVORITE_MENU               = 0x0C,
   CEC_USER_CONTROL_CODE_EXIT                        = 0x0D,
+  // reserved: 0x0E, 0x0F
+  CEC_USER_CONTROL_CODE_TOP_MENU                    = 0x10,
+  CEC_USER_CONTROL_CODE_DVD_MENU                    = 0x11,
+  // reserved: 0x12 ... 0x1C
+  CEC_USER_CONTROL_CODE_NUMBER_ENTRY_MODE           = 0x1D,
+  CEC_USER_CONTROL_CODE_NUMBER11                    = 0x1E,
+  CEC_USER_CONTROL_CODE_NUMBER12                    = 0x1F,
   CEC_USER_CONTROL_CODE_NUMBER0                     = 0x20,
   CEC_USER_CONTROL_CODE_NUMBER1                     = 0x21,
   CEC_USER_CONTROL_CODE_NUMBER2                     = 0x22,
@@ -659,6 +666,7 @@ typedef enum cec_user_control_code
   CEC_USER_CONTROL_CODE_HELP                        = 0x36,
   CEC_USER_CONTROL_CODE_PAGE_UP                     = 0x37,
   CEC_USER_CONTROL_CODE_PAGE_DOWN                   = 0x38,
+  // reserved: 0x39 ... 0x3F
   CEC_USER_CONTROL_CODE_POWER                       = 0x40,
   CEC_USER_CONTROL_CODE_VOLUME_UP                   = 0x41,
   CEC_USER_CONTROL_CODE_VOLUME_DOWN                 = 0x42,
@@ -674,12 +682,16 @@ typedef enum cec_user_control_code
   CEC_USER_CONTROL_CODE_BACKWARD                    = 0x4C,
   CEC_USER_CONTROL_CODE_STOP_RECORD                 = 0x4D,
   CEC_USER_CONTROL_CODE_PAUSE_RECORD                = 0x4E,
+  // reserved: 0x4F
   CEC_USER_CONTROL_CODE_ANGLE                       = 0x50,
   CEC_USER_CONTROL_CODE_SUB_PICTURE                 = 0x51,
   CEC_USER_CONTROL_CODE_VIDEO_ON_DEMAND             = 0x52,
   CEC_USER_CONTROL_CODE_ELECTRONIC_PROGRAM_GUIDE    = 0x53,
   CEC_USER_CONTROL_CODE_TIMER_PROGRAMMING           = 0x54,
   CEC_USER_CONTROL_CODE_INITIAL_CONFIGURATION       = 0x55,
+  CEC_USER_CONTROL_CODE_SELECT_BROADCAST_TYPE       = 0x56,
+  CEC_USER_CONTROL_CODE_SELECT_SOUND_PRESENTATION   = 0x57,
+  // reserved: 0x58 ... 0x5F
   CEC_USER_CONTROL_CODE_PLAY_FUNCTION               = 0x60,
   CEC_USER_CONTROL_CODE_PAUSE_PLAY_FUNCTION         = 0x61,
   CEC_USER_CONTROL_CODE_RECORD_FUNCTION             = 0x62,
@@ -694,14 +706,16 @@ typedef enum cec_user_control_code
   CEC_USER_CONTROL_CODE_POWER_TOGGLE_FUNCTION       = 0x6B,
   CEC_USER_CONTROL_CODE_POWER_OFF_FUNCTION          = 0x6C,
   CEC_USER_CONTROL_CODE_POWER_ON_FUNCTION           = 0x6D,
+  // reserved: 0x6E ... 0x70
   CEC_USER_CONTROL_CODE_F1_BLUE                     = 0x71,
   CEC_USER_CONTROL_CODE_F2_RED                      = 0X72,
   CEC_USER_CONTROL_CODE_F3_GREEN                    = 0x73,
   CEC_USER_CONTROL_CODE_F4_YELLOW                   = 0x74,
   CEC_USER_CONTROL_CODE_F5                          = 0x75,
   CEC_USER_CONTROL_CODE_DATA                        = 0x76,
-  CEC_USER_CONTROL_CODE_AN_RETURN                   = 0x91,
-  CEC_USER_CONTROL_CODE_AN_CHANNELS_LIST            = 0x96,
+  // reserved: 0x77 ... 0xFF
+  CEC_USER_CONTROL_CODE_AN_RETURN                   = 0x91, // return (Samsung)
+  CEC_USER_CONTROL_CODE_AN_CHANNELS_LIST            = 0x96, // channels list (Samsung)
   CEC_USER_CONTROL_CODE_MAX                         = 0x96,
   CEC_USER_CONTROL_CODE_UNKNOWN                     = 0xFF
 } cec_user_control_code;
@@ -825,27 +839,31 @@ typedef enum cec_bus_device_status
 
 typedef enum cec_vendor_id
 {
-  CEC_VENDOR_TOSHIBA   = 0x000039,
-  CEC_VENDOR_SAMSUNG   = 0x0000F0,
-  CEC_VENDOR_DENON     = 0x0005CD,
-  CEC_VENDOR_LOEWE     = 0x000982,
-  CEC_VENDOR_ONKYO     = 0x0009B0,
-  CEC_VENDOR_MEDION    = 0x000CB8,
-  CEC_VENDOR_AKAI      = 0x0020C7,
-  CEC_VENDOR_AOC       = 0x002467,
-  CEC_VENDOR_PANASONIC = 0x008045,
-  CEC_VENDOR_PHILIPS   = 0x00903E,
-  CEC_VENDOR_DAEWOO    = 0x009053,
-  CEC_VENDOR_YAMAHA    = 0x00A0DE,
-  CEC_VENDOR_GRUNDIG   = 0x00D0D5,
-  CEC_VENDOR_PIONEER   = 0x00E036,
-  CEC_VENDOR_LG        = 0x00E091,
-  CEC_VENDOR_SHARP     = 0x08001F,
-  CEC_VENDOR_SONY      = 0x080046,
-  CEC_VENDOR_BROADCOM  = 0x18C086,
-  CEC_VENDOR_VIZIO     = 0x6B746D,
-  CEC_VENDOR_BENQ      = 0x8065E9,
-  CEC_VENDOR_UNKNOWN   = 0
+  CEC_VENDOR_TOSHIBA       = 0x000039,
+  CEC_VENDOR_SAMSUNG       = 0x0000F0,
+  CEC_VENDOR_DENON         = 0x0005CD,
+  CEC_VENDOR_MARANTZ       = 0x000678,
+  CEC_VENDOR_LOEWE         = 0x000982,
+  CEC_VENDOR_ONKYO         = 0x0009B0,
+  CEC_VENDOR_MEDION        = 0x000CB8,
+  CEC_VENDOR_TOSHIBA2      = 0x000CE7,
+  CEC_VENDOR_PULSE_EIGHT   = 0x001582,
+  CEC_VENDOR_AKAI          = 0x0020C7,
+  CEC_VENDOR_AOC           = 0x002467,
+  CEC_VENDOR_PANASONIC     = 0x008045,
+  CEC_VENDOR_PHILIPS       = 0x00903E,
+  CEC_VENDOR_DAEWOO        = 0x009053,
+  CEC_VENDOR_YAMAHA        = 0x00A0DE,
+  CEC_VENDOR_GRUNDIG       = 0x00D0D5,
+  CEC_VENDOR_PIONEER       = 0x00E036,
+  CEC_VENDOR_LG            = 0x00E091,
+  CEC_VENDOR_SHARP         = 0x08001F,
+  CEC_VENDOR_SONY          = 0x080046,
+  CEC_VENDOR_BROADCOM      = 0x18C086,
+  CEC_VENDOR_VIZIO         = 0x6B746D,
+  CEC_VENDOR_BENQ          = 0x8065E9,
+  CEC_VENDOR_HARMAN_KARDON = 0x9C645E,
+  CEC_VENDOR_UNKNOWN       = 0
 } cec_vendor_id;
 
 typedef enum cec_adapter_type
@@ -915,6 +933,16 @@ typedef struct cec_datapacket
     return *this;
   }
 
+  bool operator ==(const struct cec_datapacket& packet) const
+  {
+    if (size != packet.size)
+      return false;
+    for (uint8_t iPtr = 0; iPtr < size; iPtr++)
+      if (packet.data[iPtr] != data[iPtr])
+        return false;
+    return true;
+  }
+
   bool    IsEmpty(void) const             { return size == 0; }   /**< @return True when this packet is empty, false otherwise. */
   bool    IsFull(void) const              { return size == 100; } /**< @return True when this packet is false, false otherwise. */
 
@@ -1281,7 +1309,8 @@ typedef enum libcec_alert
   CEC_ALERT_CONNECTION_LOST,
   CEC_ALERT_PERMISSION_ERROR,
   CEC_ALERT_PORT_BUSY,
-  CEC_ALERT_PHYSICAL_ADDRESS_ERROR
+  CEC_ALERT_PHYSICAL_ADDRESS_ERROR,
+  CEC_ALERT_TV_POLL_FAILED
 } libcec_alert;
 
 typedef enum libcec_parameter_type
@@ -1405,7 +1434,11 @@ typedef enum cec_client_version
   CEC_CLIENT_VERSION_2_0_4   = 0x2004,
   CEC_CLIENT_VERSION_2_0_5   = 0x2005,
   CEC_CLIENT_VERSION_2_1_0   = 0x2100,
-  CEC_CLIENT_VERSION_CURRENT = 0x2100
+  CEC_CLIENT_VERSION_2_1_1   = 0x2101,
+  CEC_CLIENT_VERSION_2_1_2   = 0x2102,
+  CEC_CLIENT_VERSION_2_1_3   = 0x2103,
+  CEC_CLIENT_VERSION_2_1_4   = 0x2104,
+  CEC_CLIENT_VERSION_CURRENT = 0x2104
 } cec_client_version;
 
 typedef enum cec_server_version
@@ -1434,7 +1467,11 @@ typedef enum cec_server_version
   CEC_SERVER_VERSION_2_0_4   = 0x2004,
   CEC_SERVER_VERSION_2_0_5   = 0x2005,
   CEC_SERVER_VERSION_2_1_0   = 0x2100,
-  CEC_SERVER_VERSION_CURRENT = 0x2100
+  CEC_SERVER_VERSION_2_1_1   = 0x2101,
+  CEC_SERVER_VERSION_2_1_2   = 0x2102,
+  CEC_SERVER_VERSION_2_1_3   = 0x2103,
+  CEC_SERVER_VERSION_2_1_4   = 0x2104,
+  CEC_SERVER_VERSION_CURRENT = 0x2104
 } cec_server_version;
 
 struct libcec_configuration