include/CECExportsCpp.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 namespace CEC
  35 {
  36   class ICECAdapter
  37   {
  38   public:
  39     virtual ~ICECAdapter() {};
  40     /*! @name Adapter methods */
  41     //@{
  42     /*!
  43      * @see cec_open
  44      */
  45     virtual bool Open(const char *strPort, uint32_t iTimeoutMs = 10000) = 0;
  46
  47     /*!
  48      * @see cec_close
  49      */
  50     virtual void Close(void) = 0;
  51
  52     /*!
  53      * @see cec_find_adapters
  54      */
  55     virtual int8_t FindAdapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath = NULL) = 0;
  56
  57     /*!
  58      * @see cec_ping_adapters
  59      */
  60     virtual bool PingAdapter(void) = 0;
  61
  62     /*!
  63      * @see cec_start_bootloader
  64      */
  65     virtual bool StartBootloader(void) = 0;
  66     //@}
  67
  68     /*!
  69      * @see cec_get_min_version
  70      */
  71     virtual int8_t GetMinVersion(void) = 0;
  72
  73     /*!
  74      * @see cec_get_lib_version
  75      */
  76     virtual int8_t GetLibVersion(void) = 0;
  77
  78     /*!
  79      * @see cec_get_next_log_message
  80      */
  81     virtual bool GetNextLogMessage(cec_log_message *message) = 0;
  82
  83     /*!
  84      * @see cec_get_next_keypress
  85      */
  86     virtual bool GetNextKeypress(cec_keypress *key) = 0;
  87
  88     /*!
  89      * @see cec_get_next_command
  90      */
  91     virtual bool GetNextCommand(cec_command *command) = 0;
  92
  93     /*!
  94      * @see cec_transmit
  95      */
  96     virtual bool Transmit(const cec_frame &data, bool bWaitForAck = true) = 0;
  97
  98     /*!
  99      * @see cec_set_logical_address
 100      */
 101     virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress) = 0;
 102
 103     /*!
 104      * @see cec_power_on_devices
 105      */
 106     virtual bool PowerOnDevices(cec_logical_address address = CECDEVICE_TV) = 0;
 107
 108     /*!
 109      * @see cec_standby_devices
 110      */
 111     virtual bool StandbyDevices(cec_logical_address address = CECDEVICE_BROADCAST) = 0;
 112
 113     /*!
 114      * @see cec_set_active_view
 115      */
 116     virtual bool SetActiveView(void) = 0;
 117
 118     /*!
 119      * @see cec_set_inactive_view
 120      */
 121     virtual bool SetInactiveView(void) = 0;
 122
 123   };
 124 };
 125
 126 extern DECLSPEC void * CECCreate(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
 127
 128 extern DECLSPEC void CECDestroy(CEC::ICECAdapter *instance);
 129
 130 #if !defined(DLL_EXPORT)
 131 #if defined(_WIN32) || defined(_WIN64)
 132 #include <windows.h>
 133 #include <conio.h>
 134
 135 static HINSTANCE g_libCEC = NULL;
 136 static int g_iLibCECInstanceCount = 0;
 137
 138 /*!
 139  * @see cec_init
 140  */
 141 inline CEC::ICECAdapter *LoadLibCec(const char *strName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS)
 142 {
 143   typedef void* (__cdecl*_CreateLibCec)(const char *, uint8_t, uint16_t);
 144   _CreateLibCec CreateLibCec;
 145
 146   if (!g_libCEC)
 147     g_libCEC = LoadLibrary("libcec.dll");
 148   if (!g_libCEC)
 149     return NULL;
 150
 151   ++g_iLibCECInstanceCount;
 152   CreateLibCec = (_CreateLibCec) (GetProcAddress(g_libCEC, "CECCreate"));
 153   if (!CreateLibCec)
 154     return NULL;
 155   return static_cast< CEC::ICECAdapter* > (CreateLibCec(strName, (uint8_t) iLogicalAddress, iPhysicalAddress));
 156 }
 157
 158 /*!
 159  * @brief Unload the given libcec instance.
 160  * @param device The instance to unload.
 161  */
 162 inline void UnloadLibCec(CEC::ICECAdapter *device)
 163 {
 164   typedef void (__cdecl*_DestroyLibCec)(void * device);
 165   _DestroyLibCec DestroyLibCec;
 166   DestroyLibCec = (_DestroyLibCec) (GetProcAddress(g_libCEC, "CECDestroy"));
 167   if (DestroyLibCec)
 168     DestroyLibCec(device);
 169
 170   if (--g_iLibCECInstanceCount == 0)
 171   {
 172     FreeLibrary(g_libCEC);
 173     g_libCEC = NULL;
 174   }
 175 };
 176
 177 #else
 178
 179 /*!
 180  * @see cec_init
 181  */
 182 inline CEC::ICECAdapter *LoadLibCec(const char *strName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS)
 183 {
 184   return (CEC::ICECAdapter*) CECCreate(strName, iLogicalAddress, iPhysicalAddress);
 185 };
 186
 187 /*!
 188  * @brief Unload the given libcec instance.
 189  * @param device The instance to unload.
 190  */
 191 inline void UnloadLibCec(CEC::ICECAdapter *device)
 192 {
 193   device->Close();
 194   CECDestroy(device);
 195 };
 196 #endif
 197
 198 #endif