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