cec: renamed the last few enums
[deb_libcec.git] / include / cec.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 #ifndef CECEXPORTS_H_
35 #define CECEXPORTS_H_
36
37 #include <cectypes.h>
38
39 namespace CEC
40 {
41 class ICECAdapter
42 {
43 public:
44 virtual ~ICECAdapter() {};
45 /*! @name Adapter methods */
46 //@{
47
48 /*!
49 * @brief Open a connection to the CEC adapter.
50 * @param strPort The path to the port.
51 * @param iTimeout Connection timeout in ms.
52 * @return True when connected, false otherwise.
53 */
54 virtual bool Open(const char *strPort, uint32_t iTimeoutMs = 10000) = 0;
55
56 /*!
57 * @brief Close the connection to the CEC adapter.
58 */
59 virtual void Close(void) = 0;
60
61 /*!
62 * @brief Try to find all connected CEC adapters. Only implemented on Linux at the moment.
63 * @param deviceList The vector to store device descriptors in.
64 * @param iBufSize The size of the deviceList buffer.
65 * @param strDevicePath Optional device path. Only adds device descriptors that match the given device path.
66 * @return The number of devices that were found, or -1 when an error occured.
67 */
68 virtual int8_t FindAdapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath = NULL) = 0;
69
70 /*!
71 * @brief Ping the CEC adapter.
72 * @return True when the ping was succesful, false otherwise.
73 */
74 virtual bool PingAdapter(void) = 0;
75
76 /*!
77 * @brief Start the bootloader of the CEC adapter.
78 * @return True when the command was sent succesfully, false otherwise.
79 */
80 virtual bool StartBootloader(void) = 0;
81 //@}
82
83 /*!
84 * @return Get the minimal version of libcec that this version of libcec can interface with.
85 */
86 virtual int8_t GetMinLibVersion(void) const = 0;
87
88 /*!
89 * @return Get the major version of libcec.
90 */
91 virtual int8_t GetLibVersionMajor(void) const = 0;
92
93 /*!
94 * @return Get the minor version of libcec.
95 */
96 virtual int8_t GetLibVersionMinor(void) const = 0;
97
98 /*!
99 * @brief Get the next log message in the queue, if there is one.
100 * @param message The next message.
101 * @return True if a message was passed, false otherwise.
102 */
103 virtual bool GetNextLogMessage(cec_log_message *message) = 0;
104
105 /*!
106 * @brief Get the next keypress in the queue, if there is one.
107 * @param key The next keypress.
108 * @return True if a key was passed, false otherwise.
109 */
110 virtual bool GetNextKeypress(cec_keypress *key) = 0;
111
112 /*!
113 * @brief Get the next CEC command that was received by the adapter.
114 * @param action The next command.
115 * @return True when a command was passed, false otherwise.
116 */
117 virtual bool GetNextCommand(cec_command *command) = 0;
118
119 /*!
120 * @brief Transmit a command over the CEC line.
121 * @param data The command to send.
122 * @return True when the data was sent and acked, false otherwise.
123 */
124 virtual bool Transmit(const cec_command &data) = 0;
125
126 /*!
127 * @brief Change the logical address of the CEC adapter.
128 * @param iLogicalAddress The CEC adapter's new logical address.
129 * @return True when the logical address was set successfully, false otherwise.
130 */
131 virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1) = 0;
132
133 /*!
134 * @brief Change the physical address (HDMI port) of the CEC adapter.
135 * @param iPhysicalAddress The CEC adapter's new physical address.
136 * @brief True when the physical address was set successfully, false otherwise.
137 */
138 virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS) = 0;
139
140 /*!
141 * @brief Power on the connected CEC capable devices.
142 * @param address The logical address to power on.
143 * @return True when the command was sent succesfully, false otherwise.
144 */
145 virtual bool PowerOnDevices(cec_logical_address address = CECDEVICE_TV) = 0;
146
147 /*!
148 * @brief Put connected CEC capable devices in standby mode.
149 * @brief address The logical address of the device to put in standby.
150 * @return True when the command was sent succesfully, false otherwise.
151 */
152 virtual bool StandbyDevices(cec_logical_address address = CECDEVICE_BROADCAST) = 0;
153
154 /*!
155 * @brief Change the active source.
156 * @param type The new active source. Leave empty to use the primary type
157 * @return True when the command was sent succesfully, false otherwise.
158 */
159 virtual bool SetActiveSource(cec_device_type type = CEC_DEVICE_TYPE_RESERVED) = 0;
160
161 /*!
162 * @deprecated Use SetActiveSource() instead
163 */
164 virtual bool SetActiveView(void) = 0;
165
166 /*!
167 * @brief Broadcast a message that notifies connected CEC capable devices that this device is no longer the active source.
168 * @return True when the command was sent succesfully, false otherwise.
169 */
170 virtual bool SetInactiveView(void) = 0;
171
172 /*!
173 * @brief Display a message on the device with the given logical address.
174 * @param iLogicalAddres The device to display the message on.
175 * @param duration The duration of the message
176 * @param strMessage The message to display.
177 * @return True when the command was sent, false otherwise.
178 */
179 virtual bool SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage) = 0;
180
181 /*!
182 * @brief Enable or disable monitoring mode.
183 * @param bEnable True to enable, false to disable.
184 * @return True when switched successfully, false otherwise.
185 */
186 virtual bool SwitchMonitoring(bool bEnable) = 0;
187
188 /*!
189 * @brief Get the CEC version of the device with the given logical address
190 * @param iLogicalAddress The device to get the CEC version for.
191 * @return The version or CEC_VERSION_UNKNOWN when the version couldn't be fetched.
192 */
193 virtual cec_version GetDeviceCecVersion(cec_logical_address iAddress) = 0;
194
195 /*!
196 * @brief Get the menu language of the device with the given logical address
197 * @param iLogicalAddress The device to get the menu language for.
198 * @param language The requested menu language.
199 * @return True when fetched succesfully, false otherwise.
200 */
201 virtual bool GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language) = 0;
202
203 /*!
204 * @brief Get the vendor ID of the device with the given logical address.
205 * @param iLogicalAddress The device to get the vendor id for.
206 * @return The vendor ID or 0 if it wasn't found.
207 */
208 virtual uint64_t GetDeviceVendorId(cec_logical_address iAddress) = 0;
209
210 /*!
211 * @brief Get the power status of the device with the given logical address.
212 * @param iLogicalAddress The device to get the power status for.
213 * @return The power status or CEC_POWER_STATUS_UNKNOWN if it wasn't found.
214 */
215 virtual cec_power_status GetDevicePowerStatus(cec_logical_address iAddress) = 0;
216
217 /*!
218 * @brief Sends a POLL message to a device.
219 * @param iAddress The device to send the message to.
220 * @return True if the POLL was acked, false otherwise.
221 */
222 virtual bool PollDevice(cec_logical_address iAddress) = 0;
223 };
224 };
225
226 /*!
227 * @brief Load the CEC adapter library.
228 * @param strDeviceName How to present this device to other devices.
229 * @param deviceTypes The device types to use on the CEC bus.
230 * @return An instance of ICECAdapter or NULL on error.
231 */
232 extern "C" DECLSPEC void * CECInit(const char *strDeviceName, CEC::cec_device_type_list devicesTypes);
233
234 /*!
235 * @deprecated Please use CECInit() instead
236 * @brief Load the CEC adapter library.
237 * @param strDeviceName How to present this device to other devices.
238 * @param iLogicalAddress The logical of this device. PLAYBACKDEVICE1 by default.
239 * @param iPhysicalAddress The physical address of this device. 0x1000 by default.
240 * @return An instance of ICECAdapter or NULL on error.
241 */
242 extern "C" DECLSPEC void * CECCreate(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
243
244 /*!
245 * @brief Unload the CEC adapter library.
246 */
247 extern "C" DECLSPEC void CECDestroy(CEC::ICECAdapter *instance);
248
249 #endif /* CECEXPORTS_H_ */