cec: store the status of a bus device: present, not present or handled by libcec
[deb_libcec.git] / src / lib / LibCEC.cpp
CommitLineData
2abe74eb
LOK
1/*
2 * This file is part of the libCEC(R) library.
3 *
4 * libCEC(R) is Copyright (C) 2011 Pulse-Eight Limited. All rights reserved.
5 * libCEC(R) is an original work, containing original code.
6 *
7 * libCEC(R) is a trademark of Pulse-Eight Limited.
8 *
9 * This program is dual-licensed; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 *
23 *
24 * Alternatively, you can license this library under a commercial license,
25 * please contact Pulse-Eight Licensing for more information.
26 *
27 * For more information contact:
28 * Pulse-Eight Licensing <license@pulse-eight.com>
29 * http://www.pulse-eight.com/
30 * http://www.pulse-eight.net/
31 */
32
33#include "LibCEC.h"
34
35#include "AdapterCommunication.h"
36#include "AdapterDetection.h"
37#include "CECProcessor.h"
0f23c85c 38#include "devices/CECBusDevice.h"
2abe74eb 39#include "util/StdString.h"
b9187cc6 40#include "platform/timeutils.h"
2abe74eb
LOK
41
42using namespace std;
43using namespace CEC;
44
f8513317
LOK
45CLibCEC::CLibCEC(const char *strDeviceName, cec_device_type_list types) :
46 m_iStartTime(GetTimeMs()),
47 m_iCurrentButton(CEC_USER_CONTROL_CODE_UNKNOWN),
48 m_buttontime(0)
49{
50 m_comm = new CAdapterCommunication(this);
51 m_cec = new CCECProcessor(this, m_comm, strDeviceName, types);
52}
53
2b4d8297 54CLibCEC::CLibCEC(const char *strDeviceName, cec_logical_address iLogicalAddress /* = CECDEVICE_PLAYBACKDEVICE1 */, uint16_t iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS */) :
40339852 55 m_iStartTime(GetTimeMs()),
2abe74eb
LOK
56 m_iCurrentButton(CEC_USER_CONTROL_CODE_UNKNOWN),
57 m_buttontime(0)
58{
59 m_comm = new CAdapterCommunication(this);
60 m_cec = new CCECProcessor(this, m_comm, strDeviceName, iLogicalAddress, iPhysicalAddress);
61}
62
63CLibCEC::~CLibCEC(void)
64{
12027dbe 65 Close();
2abe74eb 66 delete m_cec;
2abe74eb 67 delete m_comm;
2abe74eb
LOK
68}
69
25701fa6 70bool CLibCEC::Open(const char *strPort, uint32_t iTimeoutMs /* = 10000 */)
2abe74eb
LOK
71{
72 if (!m_comm)
12027dbe
LOK
73 {
74 AddLog(CEC_LOG_ERROR, "no comm port");
2abe74eb 75 return false;
12027dbe 76 }
2abe74eb
LOK
77
78 if (m_comm->IsOpen())
79 {
80 AddLog(CEC_LOG_ERROR, "connection already open");
81 return false;
82 }
83
a11148b7
LOK
84 int64_t iNow = GetTimeMs();
85 int64_t iTarget = iNow + iTimeoutMs;
86
87 bool bOpened(false);
88 while (!bOpened && iNow < iTarget)
89 {
90 bOpened = m_comm->Open(strPort, 38400, iTimeoutMs);
91 iNow = GetTimeMs();
92 }
93
94 if (!bOpened)
2abe74eb
LOK
95 {
96 AddLog(CEC_LOG_ERROR, "could not open a connection");
97 return false;
98 }
99
100 if (!m_cec->Start())
101 {
102 AddLog(CEC_LOG_ERROR, "could not start CEC communications");
103 return false;
104 }
105
106 return true;
107}
108
109void CLibCEC::Close(void)
110{
25701fa6
LOK
111 if (m_cec)
112 m_cec->StopThread();
13fd6a66
LOK
113 if (m_comm)
114 m_comm->Close();
2abe74eb
LOK
115}
116
25701fa6 117int8_t CLibCEC::FindAdapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath /* = NULL */)
2abe74eb
LOK
118{
119 CStdString strDebug;
120 if (strDevicePath)
121 strDebug.Format("trying to autodetect the com port for device path '%s'", strDevicePath);
122 else
123 strDebug.Format("trying to autodetect all CEC adapters");
124 AddLog(CEC_LOG_DEBUG, strDebug);
125
25701fa6 126 return CAdapterDetection::FindAdapters(deviceList, iBufSize, strDevicePath);
2abe74eb
LOK
127}
128
129bool CLibCEC::PingAdapter(void)
130{
131 return m_comm ? m_comm->PingAdapter() : false;
132}
133
134bool CLibCEC::StartBootloader(void)
135{
136 return m_comm ? m_comm->StartBootloader() : false;
137}
138
2abe74eb
LOK
139bool CLibCEC::GetNextLogMessage(cec_log_message *message)
140{
25701fa6 141 return (m_logBuffer.Pop(*message));
2abe74eb
LOK
142}
143
144bool CLibCEC::GetNextKeypress(cec_keypress *key)
145{
146 return m_keyBuffer.Pop(*key);
147}
148
149bool CLibCEC::GetNextCommand(cec_command *command)
150{
151 return m_commandBuffer.Pop(*command);
152}
153
8d84e2c0 154bool CLibCEC::Transmit(const cec_command &data)
2abe74eb 155{
8d84e2c0 156 return m_cec ? m_cec->Transmit(data) : false;
2abe74eb
LOK
157}
158
159bool CLibCEC::SetLogicalAddress(cec_logical_address iLogicalAddress)
160{
161 return m_cec ? m_cec->SetLogicalAddress(iLogicalAddress) : false;
162}
163
2492216a
LOK
164bool CLibCEC::SetPhysicalAddress(uint16_t iPhysicalAddress)
165{
166 return m_cec ? m_cec->SetPhysicalAddress(iPhysicalAddress) : false;
167}
168
2abe74eb
LOK
169bool CLibCEC::PowerOnDevices(cec_logical_address address /* = CECDEVICE_TV */)
170{
0f23c85c 171 return m_cec && address >= CECDEVICE_TV && address <= CECDEVICE_BROADCAST ? m_cec->m_busDevices[(uint8_t)address]->PowerOn() : false;
2abe74eb
LOK
172}
173
174bool CLibCEC::StandbyDevices(cec_logical_address address /* = CECDEVICE_BROADCAST */)
175{
0f23c85c 176 return m_cec && address >= CECDEVICE_TV && address <= CECDEVICE_BROADCAST ? m_cec->m_busDevices[(uint8_t)address]->Standby() : false;
2abe74eb
LOK
177}
178
18203d17
LOK
179bool CLibCEC::SetActiveSource(cec_device_type type /* = CEC_DEVICE_TYPE_RESERVED */)
180{
181 return m_cec ? m_cec->SetActiveSource(type) : false;
182}
183
2abe74eb
LOK
184bool CLibCEC::SetActiveView(void)
185{
186 return m_cec ? m_cec->SetActiveView() : false;
187}
188
28fa6c97 189bool CLibCEC::SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate /* = true */)
a9232a79 190{
28fa6c97 191 return m_cec ? m_cec->SetDeckControlMode(mode, bSendUpdate) : false;
a9232a79
LOK
192}
193
28fa6c97 194bool CLibCEC::SetDeckInfo(cec_deck_info info, bool bSendUpdate /* = true */)
a9232a79 195{
28fa6c97 196 return m_cec ? m_cec->SetDeckInfo(info, bSendUpdate) : false;
a9232a79
LOK
197}
198
2abe74eb
LOK
199bool CLibCEC::SetInactiveView(void)
200{
201 return m_cec ? m_cec->SetInactiveView() : false;
202}
203
28fa6c97
LOK
204bool CLibCEC::SetMenuState(cec_menu_state state, bool bSendUpdate /* = true */)
205{
206 return m_cec ? m_cec->SetMenuState(state, bSendUpdate) : false;
207}
208
1969b140
LOK
209bool CLibCEC::SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage)
210{
38bdb943
LOK
211 return m_cec && iLogicalAddress >= CECDEVICE_TV && iLogicalAddress <= CECDEVICE_BROADCAST ?
212 m_cec->m_busDevices[m_cec->GetLogicalAddress()]->TransmitOSDString(iLogicalAddress, duration, strMessage) :
213 false;
1969b140
LOK
214}
215
8b7e5ff6
LOK
216bool CLibCEC::SwitchMonitoring(bool bEnable)
217{
218 return m_cec ? m_cec->SwitchMonitoring(bEnable) : false;
219}
220
6a1c0009
LOK
221cec_version CLibCEC::GetDeviceCecVersion(cec_logical_address iAddress)
222{
223 if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
224 return m_cec->GetDeviceCecVersion(iAddress);
225 return CEC_VERSION_UNKNOWN;
226}
227
a3269a0a
LOK
228bool CLibCEC::GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language)
229{
230 if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
231 return m_cec->GetDeviceMenuLanguage(iAddress, language);
232 return false;
233}
234
44c74256
LOK
235uint64_t CLibCEC::GetDeviceVendorId(cec_logical_address iAddress)
236{
237 if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
238 return m_cec->GetDeviceVendorId(iAddress);
239 return 0;
240}
241
e55f3f70
LOK
242cec_power_status CLibCEC::GetDevicePowerStatus(cec_logical_address iAddress)
243{
244 if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
245 return m_cec->GetDevicePowerStatus(iAddress);
246 return CEC_POWER_STATUS_UNKNOWN;
247}
44c74256 248
57f45e6c
LOK
249bool CLibCEC::PollDevice(cec_logical_address iAddress)
250{
251 if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
252 return m_cec->PollDevice(iAddress);
253 return false;
254}
255
2abe74eb
LOK
256void CLibCEC::AddLog(cec_log_level level, const string &strMessage)
257{
13fd6a66 258 if (m_cec)
25701fa6
LOK
259 {
260 cec_log_message message;
261 message.level = level;
40339852 262 message.time = GetTimeMs() - m_iStartTime;
25701fa6
LOK
263 snprintf(message.message, sizeof(message.message), "%s", strMessage.c_str());
264 m_logBuffer.Push(message);
265 }
2abe74eb
LOK
266}
267
95ba7a09
LOK
268void CLibCEC::AddKey(cec_keypress &key)
269{
270 m_keyBuffer.Push(key);
271 m_iCurrentButton = CEC_USER_CONTROL_CODE_UNKNOWN;
272 m_buttontime = 0;
273}
274
2abe74eb
LOK
275void CLibCEC::AddKey(void)
276{
13fd6a66 277 if (m_iCurrentButton != CEC_USER_CONTROL_CODE_UNKNOWN)
2abe74eb
LOK
278 {
279 cec_keypress key;
25701fa6 280
2abe74eb
LOK
281 key.duration = (unsigned int) (GetTimeMs() - m_buttontime);
282 key.keycode = m_iCurrentButton;
283 m_keyBuffer.Push(key);
284 m_iCurrentButton = CEC_USER_CONTROL_CODE_UNKNOWN;
2abe74eb 285 }
56aa08d0 286 m_buttontime = 0;
2abe74eb
LOK
287}
288
e9de9629 289void CLibCEC::AddCommand(const cec_command &command)
2abe74eb 290{
2abe74eb
LOK
291 if (m_commandBuffer.Push(command))
292 {
293 CStdString strDebug;
9dee1670 294 strDebug.Format("stored command '%2x' in the command buffer. buffer size = %d", command.opcode, m_commandBuffer.Size());
2abe74eb
LOK
295 AddLog(CEC_LOG_DEBUG, strDebug);
296 }
297 else
298 {
299 AddLog(CEC_LOG_WARNING, "command buffer is full");
300 }
301}
302
303void CLibCEC::CheckKeypressTimeout(void)
304{
305 if (m_iCurrentButton != CEC_USER_CONTROL_CODE_UNKNOWN && GetTimeMs() - m_buttontime > CEC_BUTTON_TIMEOUT)
306 {
307 AddKey();
308 m_iCurrentButton = CEC_USER_CONTROL_CODE_UNKNOWN;
309 }
310}
311
312void CLibCEC::SetCurrentButton(cec_user_control_code iButtonCode)
313{
314 m_iCurrentButton = iButtonCode;
315 m_buttontime = GetTimeMs();
6710d300
LOK
316
317 /* push keypress to the keybuffer with 0 duration.
318 push another press to the keybuffer with the duration set when the button is released */
319 cec_keypress key;
320 key.duration = 0;
321 key.keycode = m_iCurrentButton;
322 m_keyBuffer.Push(key);
2abe74eb
LOK
323}
324
25701fa6 325void * CECCreate(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress /*= CEC::CECDEVICE_PLAYBACKDEVICE1 */, uint16_t iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS */)
2abe74eb
LOK
326{
327 return static_cast< void* > (new CLibCEC(strDeviceName, iLogicalAddress, iPhysicalAddress));
328}
25701fa6 329
f8513317
LOK
330void * CECInit(const char *strDeviceName, CEC::cec_device_type_list types)
331{
332 return static_cast< void* > (new CLibCEC(strDeviceName, types));
333}
334
25701fa6
LOK
335void CECDestroy(CEC::ICECAdapter *instance)
336{
337 CLibCEC *lib = static_cast< CLibCEC* > (instance);
338 if (lib)
339 delete lib;
340}