| 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 Change the deck control mode, if this adapter is registered as playback device. |
| 168 | * @param mode The new control mode. |
| 169 | * @param bSendUpdate True to send the status over the CEC line. |
| 170 | * @return True if set, false otherwise. |
| 171 | */ |
| 172 | virtual bool SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate = true) = 0; |
| 173 | |
| 174 | /*! |
| 175 | * @brief Change the deck info, if this adapter is a playback device. |
| 176 | * @param info The new deck info. |
| 177 | * @return True if set, false otherwise. |
| 178 | */ |
| 179 | virtual bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true) = 0; |
| 180 | |
| 181 | /*! |
| 182 | * @brief Broadcast a message that notifies connected CEC capable devices that this device is no longer the active source. |
| 183 | * @return True when the command was sent succesfully, false otherwise. |
| 184 | */ |
| 185 | virtual bool SetInactiveView(void) = 0; |
| 186 | |
| 187 | /*! |
| 188 | * @brief Change the menu state. |
| 189 | * @param state The new true. |
| 190 | * @param bSendUpdate True to send the status over the CEC line. |
| 191 | * @return True if set, false otherwise. |
| 192 | */ |
| 193 | virtual bool SetMenuState(cec_menu_state state, bool bSendUpdate = true) = 0; |
| 194 | |
| 195 | /*! |
| 196 | * @brief Display a message on the device with the given logical address. |
| 197 | * @param iLogicalAddres The device to display the message on. |
| 198 | * @param duration The duration of the message |
| 199 | * @param strMessage The message to display. |
| 200 | * @return True when the command was sent, false otherwise. |
| 201 | */ |
| 202 | virtual bool SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage) = 0; |
| 203 | |
| 204 | /*! |
| 205 | * @brief Enable or disable monitoring mode. |
| 206 | * @param bEnable True to enable, false to disable. |
| 207 | * @return True when switched successfully, false otherwise. |
| 208 | */ |
| 209 | virtual bool SwitchMonitoring(bool bEnable) = 0; |
| 210 | |
| 211 | /*! |
| 212 | * @brief Get the CEC version of the device with the given logical address |
| 213 | * @param iLogicalAddress The device to get the CEC version for. |
| 214 | * @return The version or CEC_VERSION_UNKNOWN when the version couldn't be fetched. |
| 215 | */ |
| 216 | virtual cec_version GetDeviceCecVersion(cec_logical_address iAddress) = 0; |
| 217 | |
| 218 | /*! |
| 219 | * @brief Get the menu language of the device with the given logical address |
| 220 | * @param iLogicalAddress The device to get the menu language for. |
| 221 | * @param language The requested menu language. |
| 222 | * @return True when fetched succesfully, false otherwise. |
| 223 | */ |
| 224 | virtual bool GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language) = 0; |
| 225 | |
| 226 | /*! |
| 227 | * @brief Get the vendor ID of the device with the given logical address. |
| 228 | * @param iLogicalAddress The device to get the vendor id for. |
| 229 | * @return The vendor ID or 0 if it wasn't found. |
| 230 | */ |
| 231 | virtual uint64_t GetDeviceVendorId(cec_logical_address iAddress) = 0; |
| 232 | |
| 233 | /*! |
| 234 | * @brief Get the power status of the device with the given logical address. |
| 235 | * @param iLogicalAddress The device to get the power status for. |
| 236 | * @return The power status or CEC_POWER_STATUS_UNKNOWN if it wasn't found. |
| 237 | */ |
| 238 | virtual cec_power_status GetDevicePowerStatus(cec_logical_address iAddress) = 0; |
| 239 | |
| 240 | /*! |
| 241 | * @brief Sends a POLL message to a device. |
| 242 | * @param iAddress The device to send the message to. |
| 243 | * @return True if the POLL was acked, false otherwise. |
| 244 | */ |
| 245 | virtual bool PollDevice(cec_logical_address iAddress) = 0; |
| 246 | |
| 247 | /*! |
| 248 | * @return The devices that are active on the bus and not handled by libcec. |
| 249 | */ |
| 250 | virtual cec_logical_addresses GetActiveDevices(void) = 0; |
| 251 | |
| 252 | /*! |
| 253 | * @brief Check whether a device is active on the bus. |
| 254 | * @param iAddress The address to check. |
| 255 | * @return True when active, false otherwise. |
| 256 | */ |
| 257 | virtual bool IsActiveDevice(cec_logical_address iAddress) = 0; |
| 258 | |
| 259 | /*! |
| 260 | * @brief Check whether a device of the given type is active on the bus. |
| 261 | * @param type The type to check. |
| 262 | * @return True when active, false otherwise. |
| 263 | */ |
| 264 | virtual bool IsActiveDeviceType(cec_device_type type) = 0; |
| 265 | |
| 266 | /*! |
| 267 | * @brief Changes the active HDMI port. |
| 268 | * @param iPort The new port number. |
| 269 | * @return True when changed, false otherwise. |
| 270 | */ |
| 271 | virtual bool SetHDMIPort(uint8_t iPort) = 0; |
| 272 | |
| 273 | /*! |
| 274 | * @brief Sends a volume up keypress to an audiosystem if it's present. |
| 275 | * @param bWait Wait for the response of the audiosystem when true. |
| 276 | * @return The new audio status. |
| 277 | */ |
| 278 | virtual uint8_t VolumeUp(bool bWait = true) = 0; |
| 279 | |
| 280 | /*! |
| 281 | * @brief Sends a volume down keypress to an audiosystem if it's present. |
| 282 | * @param bWait Wait for the response of the audiosystem when true. |
| 283 | * @return The new audio status. |
| 284 | */ |
| 285 | virtual uint8_t VolumeDown(bool bWait = true) = 0; |
| 286 | |
| 287 | /*! |
| 288 | * @brief Sends a mute keypress to an audiosystem if it's present. |
| 289 | * @param bWait Wait for the response of the audiosystem when true. |
| 290 | * @return The new audio status. |
| 291 | */ |
| 292 | virtual uint8_t MuteAudio(bool bWait = true) = 0; |
| 293 | |
| 294 | /*! |
| 295 | * @brief Send a keypress to a device on the CEC bus. |
| 296 | * @param iDestination The address to send the message to. |
| 297 | * @param key The key to send. |
| 298 | * @param bWait True to wait for a response, false otherwise. |
| 299 | * @return True when the keypress was acked, false otherwise. |
| 300 | */ |
| 301 | virtual bool SendKeypress(cec_logical_address iDestination, cec_user_control_code key, bool bWait = false) = 0; |
| 302 | |
| 303 | /*! |
| 304 | * @brief Send a key release to a device on the CEC bus. |
| 305 | * @param iDestination The address to send the message to. |
| 306 | * @param bWait True to wait for a response, false otherwise. |
| 307 | * @return True when the keypress was acked, false otherwise. |
| 308 | */ |
| 309 | virtual bool SendKeyRelease(cec_logical_address iDestination, bool bWait = false) = 0; |
| 310 | |
| 311 | /*! |
| 312 | * @brief Get the OSD name of a device on the CEC bus. |
| 313 | * @param iAddress The device to get the OSD name for. |
| 314 | * @return The OSD name. |
| 315 | */ |
| 316 | virtual cec_osd_name GetOSDName(cec_logical_address iAddress) = 0; |
| 317 | }; |
| 318 | }; |
| 319 | |
| 320 | /*! |
| 321 | * @brief Load the CEC adapter library. |
| 322 | * @param strDeviceName How to present this device to other devices. |
| 323 | * @param deviceTypes The device types to use on the CEC bus. |
| 324 | * @return An instance of ICECAdapter or NULL on error. |
| 325 | */ |
| 326 | extern "C" DECLSPEC void * CECInit(const char *strDeviceName, CEC::cec_device_type_list devicesTypes); |
| 327 | |
| 328 | /*! |
| 329 | * @deprecated Please use CECInit() instead |
| 330 | * @brief Load the CEC adapter library. |
| 331 | * @param strDeviceName How to present this device to other devices. |
| 332 | * @param iLogicalAddress The logical of this device. PLAYBACKDEVICE1 by default. |
| 333 | * @param iPhysicalAddress The physical address of this device. 0x1000 by default. |
| 334 | * @return An instance of ICECAdapter or NULL on error. |
| 335 | */ |
| 336 | extern "C" DECLSPEC void * CECCreate(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS); |
| 337 | |
| 338 | /*! |
| 339 | * @brief Unload the CEC adapter library. |
| 340 | */ |
| 341 | extern "C" DECLSPEC void CECDestroy(CEC::ICECAdapter *instance); |
| 342 | |
| 343 | #endif /* CECEXPORTS_H_ */ |