cec: added optional logical and physical address parameters to LoadLibCec()/cec_init...

diff --git a/include/CECExports.h b/include/CECExports.h
index 3a72aea13252f468bbd91919eee29c2b5fdeb586..c25757052c4715e6d278cd5317d3a3f8343ff770 100644 (file)
--- a/include/CECExports.h
+++ b/include/CECExports.h
@@ -56,7 +56,7 @@ extern "C" {
 namespace CEC {
 #endif
   #define CEC_MIN_VERSION      1
-  #define CEC_LIB_VERSION      1
+  #define CEC_LIB_VERSION      2
   #define CEC_SETTLE_DOWN_TIME 1000
 
   typedef std::vector<uint8_t> cec_frame;
@@ -192,9 +192,13 @@ namespace CEC {
     std::string path;
     std::string comm;
   } cec_device;
-};
+
+  //default physical address 1.0.0.0
+  #define CEC_DEFAULT_PHYSICAL_ADDRESS 0x1000
 
 #ifdef __cplusplus
+};
+
 #include "CECExportsCpp.h"
 #include "CECExportsC.h"
 };

diff --git a/include/CECExportsC.h b/include/CECExportsC.h
index 04ce11a61e35e71c0fbbe0fd4c315d3333181ed1..79409b7fed9a4990b3aa459a06a9bf074400bdb8 100644 (file)
--- a/include/CECExportsC.h
+++ b/include/CECExportsC.h
@@ -39,14 +39,21 @@ extern "C" {
 #endif
 
 /*!
- * @brief Initialise the cec device.
+ * @brief Load the CEC adapter library.
  * @param strDeviceName How to present this device to other devices.
+ * @param iLogicalAddress The logical of this device. PLAYBACKDEVICE1 by default.
+ * @param iPhysicalAddress The physical address of this device. 0x1000 by default.
  * @return True when initialised, false otherwise.
  */
-extern DECLSPEC bool cec_init(const char *strDeviceName);
+
+#ifdef __cplusplus
+extern DECLSPEC bool cec_init(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, int iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
+#else
+extern DECLSPEC bool cec_init(const char *strDeviceName, cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1, int iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
+#endif
 
 /*!
- * @brief Close the cec device.
+ * @brief Close the CEC adapter connection.
  * @return True when the device was closed, false otherwise.
  */
 extern DECLSPEC bool cec_close(void);
@@ -73,6 +80,7 @@ extern DECLSPEC bool cec_start_bootloader(void);
 
 /*!
  * @brief Power off connected CEC capable devices.
+ * @param address The logical address to power off.
  * @return True when the command was sent succesfully, false otherwise.
  */
 #ifdef __cplusplus
@@ -83,6 +91,7 @@ extern DECLSPEC bool cec_power_off_devices(cec_logical_address address = CECDEVI
 
 /*!
  * @brief Power on the connected CEC capable devices.
+ * @param address The logical address to power on.
  * @return True when the command was sent succesfully, false otherwise.
  */
 #ifdef __cplusplus
@@ -93,6 +102,7 @@ extern DECLSPEC bool cec_power_on_devices(cec_logical_address address = CECDEVIC
 
 /*!
  * @brief Put connected CEC capable devices in standby mode.
+ * @brief address The logical address of the device to put in standby.
  * @return True when the command was sent succesfully, false otherwise.
  */
 #ifdef __cplusplus
@@ -102,13 +112,13 @@ extern DECLSPEC bool cec_standby_devices(cec_logical_address address = CECDEVICE
 #endif
 
 /*!
- * @brief Set this device as the active source on connected CEC capable devices.
+ * @brief Broadcast a message that notifies connected CEC capable devices that this device is the active source.
  * @return True when the command was sent succesfully, false otherwise.
  */
 extern DECLSPEC bool cec_set_active_view(void);
 
 /*!
- * @brief Mark this device as inactive on connected CEC capable devices.
+ * @brief Broadcast a message that notifies connected CEC capable devices that this device is no longer the active source.
  * @return True when the command was sent succesfully, false otherwise.
  */
 extern DECLSPEC bool cec_set_inactive_view(void);
@@ -126,7 +136,7 @@ extern DECLSPEC bool cec_get_next_log_message(cec_log_message *message);
 
 /*!
  * @brief Get the next keypress in the queue, if there is one.
- * @param key The next keypress
+ * @param key The next keypress.
  * @return True if a key was passed, false otherwise.
  */
 #ifdef __cplusplus
@@ -136,8 +146,10 @@ extern DECLSPEC bool cec_get_next_keypress(cec_keypress *key);
 #endif
 
 /*!
- * @brief Transmit a frame and wait for ACK.
+ * @brief Transmit a frame on the CEC line.
  * @param data The frame to send.
+ * @param bWaitForAck Wait for an ACK message for 1 second after this frame has been sent.
+ * @param iTimeout Timeout if the message could not be sent for this amount of ms. Does not influence the timeout of the wait for the ACK message. That timeout is specified by the CEC standard.
  * @return True when the data was sent and acked, false otherwise.
  */
 #ifdef __cplusplus
@@ -153,9 +165,22 @@ extern DECLSPEC bool cec_transmit(const cec_frame &data, bool bWaitForAck = true
  */
 extern DECLSPEC bool cec_set_ack_mask(uint16_t ackmask);
 
+/*!
+ * @return Get the minimal version of libcec that this version of libcec can interface with.
+ */
 extern DECLSPEC int cec_get_min_version(void);
+
+/*!
+ * @return Get the version of libcec.
+ */
 extern DECLSPEC int cec_get_lib_version(void);
 
+/*!
+ * @brief Try to find all connected CEC adapters. Only implemented on Linux at the moment.
+ * @param deviceList The vector to store device descriptors in.
+ * @param strDevicePath Optional device path. Only adds device descriptors that match the given device path.
+ * @return The number of devices that were found, or -1 when an error occured.
+ */
 #ifdef __cplusplus
 extern DECLSPEC int cec_find_devices(std::vector<CEC::cec_device> &deviceList, const char *strDevicePath = NULL);
 #else

diff --git a/include/CECExportsCpp.h b/include/CECExportsCpp.h
index 195ddf5c2a49a36636b0f5a37649751717f3a220..b49b1abdce050b02f7e52f8b93b4a0f34895018d 100644 (file)
--- a/include/CECExportsCpp.h
+++ b/include/CECExportsCpp.h
@@ -101,12 +101,19 @@ namespace CEC
      */
     virtual bool SetAckMask(cec_logical_address ackmask) = 0;
 
+    /*!
+     * @see cec_get_min_version
+     */
     virtual int GetMinVersion(void) = 0;
+
+    /*!
+     * @see cec_get_lib_version
+     */
     virtual int GetLibVersion(void) = 0;
   };
 };
 
-extern DECLSPEC void * CECCreate(const char *strDeviceName);
+extern DECLSPEC void * CECCreate(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, int iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
 
 #if !defined(DLL_EXPORT)
 #if defined(_WIN32) || defined(_WIN64)
@@ -114,32 +121,57 @@ extern DECLSPEC void * CECCreate(const char *strDeviceName);
 #include <conio.h>
 
 static HINSTANCE g_libCEC = NULL;
-inline CEC::ICECDevice *LoadLibCec(const char *strName)
+static int g_iLibCECInstanceCount = 0;
+
+/*!
+ * @see cec_init
+ */
+inline CEC::ICECDevice *LoadLibCec(const char *strName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, int iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS)
 {
   typedef void* (__cdecl*_CreateLibCec)(const char *);
   _CreateLibCec CreateLibCec;
 
-  g_libCEC = LoadLibrary("libcec.dll");
+  if (!g_libCEC)
+    g_libCEC = LoadLibrary("libcec.dll");
   if (!g_libCEC)
     return NULL;
+
+  ++g_iLibCECInstanceCount;
   CreateLibCec = (_CreateLibCec) (GetProcAddress(g_libCEC, "CECCreate"));
   if (!CreateLibCec)
     return NULL;
-  return static_cast< CEC::ICECDevice* > (CreateLibCec(strName));
+  return static_cast< CEC::ICECDevice* > (CreateLibCec(strName, iLogicalAddress, iPhysicalAddress));
 }
 
+/*!
+ * @brief Unload the given libcec instance.
+ * @param device The instance to unload.
+ */
 inline void UnloadLibCec(CEC::ICECDevice *device)
 {
   delete device;
-  FreeLibrary(g_libCEC);
+
+  if (--g_iLibCECInstanceCount == 0)
+  {
+    FreeLibrary(g_libCEC);
+    g_libCEC = NULL;
+  }
 };
 
 #else
-inline CEC::ICECDevice *LoadLibCec(const char *strName)
+
+/*!
+ * @see cec_init
+ */
+inline CEC::ICECDevice *LoadLibCec(const char *strName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, int iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS)
 {
-  return (CEC::ICECDevice*) CECCreate(strName);
+  return (CEC::ICECDevice*) CECCreate(strName, iLogicalAddress, iPhysicalAddress);
 };
 
+/*!
+ * @brief Unload the given libcec instance.
+ * @param device The instance to unload.
+ */
 inline void UnloadLibCec(CEC::ICECDevice *device)
 {
   delete device;

diff --git a/include/CECTypes.h b/include/CECTypes.h
index dcc4c72d63b34b6bf2a421b2fd26fe6cba06cd29..5b8ef2b5f10a8b2ed70b6b009b75315f3a842122 100644 (file)
--- a/include/CECTypes.h
+++ b/include/CECTypes.h
@@ -426,8 +426,6 @@ typedef enum
   MSGCODE_FRAME_ACK = 0x40,
 } ECecMessageCode;
 
-//default physical address 1.0.0.0
-#define CEC_DEFAULT_PHYSICAL_ADDRESS 0x1000
 #define MSGSTART                     0xFF
 #define MSGEND                       0xFE
 #define MSGESC                       0xFD

diff --git a/src/lib/CECParser.cpp b/src/lib/CECParser.cpp
index 06a1715baf777fabe30907972440809893e10924..af86abe0d83ab98b4a6eaa2802ab0f8bb3f9825d 100644 (file)
--- a/src/lib/CECParser.cpp
+++ b/src/lib/CECParser.cpp
@@ -52,13 +52,13 @@ using namespace std;
  * ICECDevice implementation
  */
 //@{
-CCECParser::CCECParser(const char *strDeviceName) :
+CCECParser::CCECParser(const char *strDeviceName, cec_logical_address iLogicalAddress /* = CECDEVICE_PLAYBACKDEVICE1 */, int iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS*/) :
     m_inbuf(NULL),
     m_iInbufSize(0),
     m_iInbufUsed(0),
     m_iCurrentButton(CEC_USER_CONTROL_CODE_UNKNOWN),
-    m_physicaladdress(CEC_DEFAULT_PHYSICAL_ADDRESS),
-    m_iLogicalAddress(CECDEVICE_PLAYBACKDEVICE1),
+    m_physicaladdress(iPhysicalAddress),
+    m_iLogicalAddress(iLogicalAddress),
     m_strDeviceName(strDeviceName),
     m_bRunning(false)
 {
@@ -866,7 +866,7 @@ int CCECParser::FindDevices(std::vector<cec_device> &deviceList, const char *str
   return CCECDetect::FindDevices(deviceList, strDevicePath);
 }
 
-DECLSPEC void * CECCreate(const char *strDeviceName)
+DECLSPEC void * CECCreate(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress /* = CEC::CECDEVICE_PLAYBACKDEVICE1 */, int iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS */)
 {
-  return static_cast< void* > (new CCECParser(strDeviceName));
+  return static_cast< void* > (new CCECParser(strDeviceName, iLogicalAddress, iPhysicalAddress));
 }

diff --git a/src/lib/CECParser.h b/src/lib/CECParser.h
index 3ad6cf0e3c86cefee7a9ed34eb3548a31208ef35..6f0caa4ff3c03da3ea498d4a11a6ebdea36396cc 100644 (file)
--- a/src/lib/CECParser.h
+++ b/src/lib/CECParser.h
@@ -48,7 +48,7 @@ namespace CEC
      * ICECDevice implementation
      */
     //@{
-      CCECParser(const char *strDeviceName);
+      CCECParser(const char *strDeviceName, cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1, int iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
       virtual ~CCECParser(void);
 
       virtual bool Open(const char *strPort, int iTimeout = 10000);

diff --git a/src/lib/CECParserC.cpp b/src/lib/CECParserC.cpp
index 84d54105b09e343573c77d1ff3d4003838d1bc3b..1aae849a7815f47550ee9784d726b0afeb1c32ba 100644 (file)
--- a/src/lib/CECParserC.cpp
+++ b/src/lib/CECParserC.cpp
@@ -41,9 +41,9 @@ using namespace std;
 //@{
 ICECDevice *cec_parser;
 
-bool cec_init(const char *strDeviceName)
+bool cec_init(const char *strDeviceName, cec_logical_address iLogicalAddress /* = CECDEVICE_PLAYBACKDEVICE1 */, int iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS */)
 {
-  cec_parser = (ICECDevice *) CECCreate(strDeviceName);
+  cec_parser = (ICECDevice *) CECCreate(strDeviceName, iLogicalAddress, iPhysicalAddress);
   return (cec_parser != NULL);
 }