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