3 * This file is part of the libCEC(R) library.
5 * libCEC(R) is Copyright (C) 2011-2013 Pulse-Eight Limited. All rights reserved.
6 * libCEC(R) is an original work, containing original code.
8 * libCEC(R) is a trademark of Pulse-Eight Limited.
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.
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.
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.
25 * Alternatively, you can license this library under a commercial license,
26 * please contact Pulse-Eight Licensing for more information.
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/
40 typedef enum cec_adapter_message_state
42 ADAPTER_MESSAGE_STATE_UNKNOWN
= 0, /**< the initial state */
43 ADAPTER_MESSAGE_STATE_WAITING_TO_BE_SENT
, /**< waiting in the send queue of the adapter, or timed out */
44 ADAPTER_MESSAGE_STATE_SENT
, /**< sent and waiting on an ACK */
45 ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED
, /**< sent, but failed to ACK */
46 ADAPTER_MESSAGE_STATE_SENT_ACKED
, /**< sent, and ACK received */
47 ADAPTER_MESSAGE_STATE_INCOMING
, /**< received from another device */
48 ADAPTER_MESSAGE_STATE_ERROR
/**< an error occured */
49 } cec_adapter_message_state
;
51 class IAdapterCommunicationCallback
54 IAdapterCommunicationCallback(void) {}
55 virtual ~IAdapterCommunicationCallback(void) {}
58 * @brief Callback method for IAdapterCommunication, called when a new cec_command is received
59 * @param command The command that has been received
60 * @return True when it was handled by this listener, false otherwise.
62 virtual bool OnCommandReceived(const cec_command
&command
) = 0;
65 * @brief Callback method for IAdapterCommunication, called when a poll was received.
66 * @param initiator The initiator that sent the poll.
67 * @param destination The destination of the poll message.
69 virtual void HandlePoll(cec_logical_address initiator
, cec_logical_address destination
) = 0;
72 * @brief Callback method for IAdapterCommunication, called when a receive failed message was received.
73 * @param initiator The initiator that sent the receive failed message.
74 * @return True when this is an error, false otherwise.
76 virtual bool HandleReceiveFailed(cec_logical_address initiator
) = 0;
79 * @brief Callback method for IAdapterCommunication, called when a logical address that libCEC uses was taken by another device.
80 * @param oldAddress The logical address that was taken by another device.
82 virtual void HandleLogicalAddressLost(cec_logical_address oldAddress
) = 0;
85 * @brief Callback method for IAdapterCommunication, called when the physical address changed.
86 * @param iNewAddress The new physical address.
88 virtual void HandlePhysicalAddressChanged(uint16_t iNewAddress
) = 0;
90 virtual CLibCEC
*GetLib(void) const = 0;
93 class IAdapterCommunication
97 * @param callback The callback struct. if set to NULL, the Read() method has to be used to read commands. if set, OnCommandReceived() will be called for each command that was received
99 IAdapterCommunication(IAdapterCommunicationCallback
*callback
) :
100 m_callback(callback
) {}
101 virtual ~IAdapterCommunication(void) {}
104 * @brief Open a connection to the CEC adapter
105 * @param iTimeoutMs Connection timeout in ms
106 * @param bSkipChecks Skips all initial checks of the adapter, and starts the reader/writer threads directly after connecting.
107 * @param bStartListening Start a listener thread when true. False to just open a connection, read the device info, and close the connection.
108 * @return True when connected, false otherwise
110 virtual bool Open(uint32_t iTimeoutMs
= CEC_DEFAULT_CONNECT_TIMEOUT
, bool bSkipChecks
= false, bool bStartListening
= true) = 0;
113 * @brief Close an open connection
115 virtual void Close(void) = 0;
118 * @return True when the connection is open, false otherwise
120 virtual bool IsOpen(void) = 0;
123 * @return The last error message, or an empty string if there was none
125 virtual std::string
GetError(void) const = 0;
128 * @brief Write a cec_command to the adapter
129 * @param data The command to write
130 * @param bRetry The command can be retried
131 * @param iLineTimeout The line timeout to be used
132 * @param bIsReply True when this message is a reply, false otherwise
133 * @return The last state of the transmitted command
135 virtual cec_adapter_message_state
Write(const cec_command
&data
, bool &bRetry
, uint8_t iLineTimeout
, bool bIsReply
) = 0;
138 * @brief Change the current line timeout on the CEC bus
139 * @param iTimeout The new timeout
140 * @return True when set, false otherwise
142 virtual bool SetLineTimeout(uint8_t iTimeout
) = 0;
145 * @brief Put the device in bootloader mode (which will disrupt CEC communication when it succeeds)
146 * @return True when the bootloader command has been sent, false otherwise.
148 virtual bool StartBootloader(void) = 0;
150 virtual bool SetLogicalAddresses(const cec_logical_addresses
&addresses
) = 0;
151 virtual cec_logical_addresses
GetLogicalAddresses(void) = 0;
154 * @brief Check whether the CEC adapter responds
155 * @return True when the ping was sent and acked, false otherwise.
157 virtual bool PingAdapter(void) = 0;
160 * @return The firmware version of this CEC adapter, or 0 if it's unknown.
162 virtual uint16_t GetFirmwareVersion(void) = 0;
165 * @return The build date in seconds since epoch, or 0 when no (valid) reply was received.
167 virtual uint32_t GetFirmwareBuildDate(void) = 0;
170 * @return True when this adapter is using the latest firmware build, or when the latest firmware build for this adapter type is unknown. False otherwise.
172 virtual bool IsRunningLatestFirmware(void) = 0;
175 * @return True when the control mode has been set, false otherwise.
177 virtual bool SetControlledMode(bool controlled
) = 0;
180 * @brief Persist the given configuration in adapter (if supported)
181 * @brief The configuration to store.
182 * @return True when the configuration was persisted, false otherwise.
184 virtual bool PersistConfiguration(const libcec_configuration
&configuration
) = 0;
187 * @brief Get the persisted configuration from the adapter (if supported)
188 * @param configuration The updated configuration.
189 * @return True when the configuration was updated, false otherwise.
191 virtual bool GetConfiguration(libcec_configuration
&configuration
) = 0;
194 * @return The name of the port
196 virtual std::string
GetPortName(void) = 0;
199 * @return The physical address, if the adapter supports this. 0 otherwise.
201 virtual uint16_t GetPhysicalAddress(void) = 0;
204 * @return The vendor id for this device
206 virtual cec_vendor_id
GetVendorId(void) = 0;
209 * @brief Checks whether a logical address is supported by the adapter.
210 * @param address The address to check.
211 * @return True when supported, false otherwise.
213 virtual bool SupportsSourceLogicalAddress(const cec_logical_address address
) = 0;
216 * @return The type of adapter that this instance is connected to.
218 virtual cec_adapter_type
GetAdapterType(void) = 0;
221 * @return The (virtual) USB vendor id
223 virtual uint16_t GetAdapterVendorId(void) const = 0;
226 * @return The (virtual) USB product id
228 virtual uint16_t GetAdapterProductId(void) const = 0;
231 * @brief Marks the adapter as active or inactive source
232 * @param bSetTo True to mark as active source, false to mark as inactive source
233 * @param bClientUnregistered True when the client was unregistered, false when the device was explicitly marked as (in)active source
235 virtual void SetActiveSource(bool bSetTo
, bool bClientUnregistered
) = 0;
237 IAdapterCommunicationCallback
*m_callback
;