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