cec: removed unused local variable
[deb_libcec.git] / src / lib / LibCEC.cpp
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"
38 #include "devices/CECBusDevice.h"
39 #include "util/StdString.h"
40 #include "platform/timeutils.h"
41
42 using namespace std;
43 using namespace CEC;
44
45 CLibCEC::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
54 CLibCEC::CLibCEC(const char *strDeviceName, cec_logical_address iLogicalAddress /* = CECDEVICE_PLAYBACKDEVICE1 */, uint16_t iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS */) :
55 m_iStartTime(GetTimeMs()),
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
63 CLibCEC::~CLibCEC(void)
64 {
65 Close();
66 delete m_cec;
67 delete m_comm;
68 }
69
70 bool CLibCEC::Open(const char *strPort, uint32_t iTimeoutMs /* = 10000 */)
71 {
72 if (!m_comm)
73 {
74 AddLog(CEC_LOG_ERROR, "no comm port");
75 return false;
76 }
77
78 if (m_comm->IsOpen())
79 {
80 AddLog(CEC_LOG_ERROR, "connection already open");
81 return false;
82 }
83
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)
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
109 void CLibCEC::Close(void)
110 {
111 if (m_cec)
112 m_cec->StopThread();
113 if (m_comm)
114 m_comm->Close();
115 }
116
117 int8_t CLibCEC::FindAdapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath /* = NULL */)
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
126 return CAdapterDetection::FindAdapters(deviceList, iBufSize, strDevicePath);
127 }
128
129 bool CLibCEC::PingAdapter(void)
130 {
131 return m_comm ? m_comm->PingAdapter() : false;
132 }
133
134 bool CLibCEC::StartBootloader(void)
135 {
136 return m_comm ? m_comm->StartBootloader() : false;
137 }
138
139 bool CLibCEC::GetNextLogMessage(cec_log_message *message)
140 {
141 return (m_logBuffer.Pop(*message));
142 }
143
144 bool CLibCEC::GetNextKeypress(cec_keypress *key)
145 {
146 return m_keyBuffer.Pop(*key);
147 }
148
149 bool CLibCEC::GetNextCommand(cec_command *command)
150 {
151 return m_commandBuffer.Pop(*command);
152 }
153
154 bool CLibCEC::Transmit(const cec_command &data)
155 {
156 return m_cec ? m_cec->Transmit(data) : false;
157 }
158
159 bool CLibCEC::SetLogicalAddress(cec_logical_address iLogicalAddress)
160 {
161 return m_cec ? m_cec->SetLogicalAddress(iLogicalAddress) : false;
162 }
163
164 bool CLibCEC::SetPhysicalAddress(uint16_t iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS */)
165 {
166 return m_cec ? m_cec->SetPhysicalAddress(iPhysicalAddress) : false;
167 }
168
169 bool CLibCEC::SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort /* = CEC_DEFAULT_HDMI_PORT */)
170 {
171 return m_cec ? m_cec->SetHDMIPort(iBaseDevice, iPort) : false;
172 }
173
174 bool CLibCEC::EnablePhysicalAddressDetection(void)
175 {
176 return m_cec ? m_cec->EnablePhysicalAddressDetection() : false;
177 }
178
179 bool CLibCEC::PowerOnDevices(cec_logical_address address /* = CECDEVICE_TV */)
180 {
181 return m_cec && address >= CECDEVICE_TV && address <= CECDEVICE_BROADCAST ? m_cec->m_busDevices[(uint8_t)address]->PowerOn() : false;
182 }
183
184 bool CLibCEC::StandbyDevices(cec_logical_address address /* = CECDEVICE_BROADCAST */)
185 {
186 return m_cec && address >= CECDEVICE_TV && address <= CECDEVICE_BROADCAST ? m_cec->m_busDevices[(uint8_t)address]->Standby() : false;
187 }
188
189 bool CLibCEC::SetActiveSource(cec_device_type type /* = CEC_DEVICE_TYPE_RESERVED */)
190 {
191 return m_cec ? m_cec->SetActiveSource(type) : false;
192 }
193
194 bool CLibCEC::SetActiveView(void)
195 {
196 return m_cec ? m_cec->SetActiveView() : false;
197 }
198
199 bool CLibCEC::SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate /* = true */)
200 {
201 return m_cec ? m_cec->SetDeckControlMode(mode, bSendUpdate) : false;
202 }
203
204 bool CLibCEC::SetDeckInfo(cec_deck_info info, bool bSendUpdate /* = true */)
205 {
206 return m_cec ? m_cec->SetDeckInfo(info, bSendUpdate) : false;
207 }
208
209 bool CLibCEC::SetInactiveView(void)
210 {
211 return m_cec ? m_cec->TransmitInactiveSource() : false;
212 }
213
214 bool CLibCEC::SetMenuState(cec_menu_state state, bool bSendUpdate /* = true */)
215 {
216 return m_cec ? m_cec->SetMenuState(state, bSendUpdate) : false;
217 }
218
219 bool CLibCEC::SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage)
220 {
221 return m_cec && iLogicalAddress >= CECDEVICE_TV && iLogicalAddress <= CECDEVICE_BROADCAST ?
222 m_cec->m_busDevices[m_cec->GetLogicalAddress()]->TransmitOSDString(iLogicalAddress, duration, strMessage) :
223 false;
224 }
225
226 bool CLibCEC::SwitchMonitoring(bool bEnable)
227 {
228 return m_cec ? m_cec->SwitchMonitoring(bEnable) : false;
229 }
230
231 cec_version CLibCEC::GetDeviceCecVersion(cec_logical_address iAddress)
232 {
233 if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
234 return m_cec->GetDeviceCecVersion(iAddress);
235 return CEC_VERSION_UNKNOWN;
236 }
237
238 bool CLibCEC::GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language)
239 {
240 if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
241 return m_cec->GetDeviceMenuLanguage(iAddress, language);
242 return false;
243 }
244
245 uint64_t CLibCEC::GetDeviceVendorId(cec_logical_address iAddress)
246 {
247 if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
248 return m_cec->GetDeviceVendorId(iAddress);
249 return 0;
250 }
251
252 cec_power_status CLibCEC::GetDevicePowerStatus(cec_logical_address iAddress)
253 {
254 if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
255 return m_cec->GetDevicePowerStatus(iAddress);
256 return CEC_POWER_STATUS_UNKNOWN;
257 }
258
259 bool CLibCEC::PollDevice(cec_logical_address iAddress)
260 {
261 if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
262 return m_cec->PollDevice(iAddress);
263 return false;
264 }
265
266 cec_logical_addresses CLibCEC::GetActiveDevices(void)
267 {
268 cec_logical_addresses addresses;
269 addresses.Clear();
270 if (m_cec)
271 addresses = m_cec->GetActiveDevices();
272 return addresses;
273 }
274
275 bool CLibCEC::IsActiveDevice(cec_logical_address iAddress)
276 {
277 if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
278 return m_cec->IsActiveDevice(iAddress);
279 return false;
280 }
281
282 bool CLibCEC::IsActiveDeviceType(cec_device_type type)
283 {
284 if (m_cec && type >= CEC_DEVICE_TYPE_TV && type <= CEC_DEVICE_TYPE_AUDIO_SYSTEM)
285 return m_cec->IsActiveDeviceType(type);
286 return false;
287 }
288
289 uint8_t CLibCEC::VolumeUp(bool bWait /* = true */)
290 {
291 if (m_cec)
292 return m_cec->VolumeUp(bWait);
293 return 0;
294 }
295
296 uint8_t CLibCEC::VolumeDown(bool bWait /* = true */)
297 {
298 if (m_cec)
299 return m_cec->VolumeDown(bWait);
300 return 0;
301 }
302
303
304 uint8_t CLibCEC::MuteAudio(bool bWait /* = true */)
305 {
306 if (m_cec)
307 return m_cec->MuteAudio(bWait);
308 return 0;
309 }
310
311 bool CLibCEC::SendKeypress(cec_logical_address iDestination, cec_user_control_code key, bool bWait /* = false */)
312 {
313 if (m_cec)
314 return m_cec->SendKeypress(iDestination, key, bWait);
315 return false;
316 }
317
318 bool CLibCEC::SendKeyRelease(cec_logical_address iDestination, bool bWait /* = false */)
319 {
320 if (m_cec)
321 return m_cec->SendKeyRelease(iDestination, bWait);
322 return false;
323 }
324
325 cec_osd_name CLibCEC::GetOSDName(cec_logical_address iAddress)
326 {
327 cec_osd_name retVal;
328 retVal.device = iAddress;
329 retVal.name[0] = 0;
330
331 if (m_cec)
332 retVal = m_cec->GetDeviceOSDName(iAddress);
333
334 return retVal;
335 }
336
337 void CLibCEC::AddLog(cec_log_level level, const string &strMessage)
338 {
339 if (m_cec)
340 {
341 cec_log_message message;
342 message.level = level;
343 message.time = GetTimeMs() - m_iStartTime;
344 snprintf(message.message, sizeof(message.message), "%s", strMessage.c_str());
345 m_logBuffer.Push(message);
346 }
347 }
348
349 void CLibCEC::AddKey(cec_keypress &key)
350 {
351 m_keyBuffer.Push(key);
352 m_iCurrentButton = CEC_USER_CONTROL_CODE_UNKNOWN;
353 m_buttontime = 0;
354 }
355
356 void CLibCEC::AddKey(void)
357 {
358 if (m_iCurrentButton != CEC_USER_CONTROL_CODE_UNKNOWN)
359 {
360 cec_keypress key;
361
362 key.duration = (unsigned int) (GetTimeMs() - m_buttontime);
363 key.keycode = m_iCurrentButton;
364 m_keyBuffer.Push(key);
365 m_iCurrentButton = CEC_USER_CONTROL_CODE_UNKNOWN;
366 }
367 m_buttontime = 0;
368 }
369
370 void CLibCEC::AddCommand(const cec_command &command)
371 {
372 if (m_commandBuffer.Push(command))
373 {
374 CStdString strDebug;
375 strDebug.Format("stored command '%2x' in the command buffer. buffer size = %d", command.opcode, m_commandBuffer.Size());
376 AddLog(CEC_LOG_DEBUG, strDebug);
377 }
378 else
379 {
380 AddLog(CEC_LOG_WARNING, "command buffer is full");
381 }
382 }
383
384 void CLibCEC::CheckKeypressTimeout(void)
385 {
386 if (m_iCurrentButton != CEC_USER_CONTROL_CODE_UNKNOWN && GetTimeMs() - m_buttontime > CEC_BUTTON_TIMEOUT)
387 {
388 AddKey();
389 m_iCurrentButton = CEC_USER_CONTROL_CODE_UNKNOWN;
390 }
391 }
392
393 void CLibCEC::SetCurrentButton(cec_user_control_code iButtonCode)
394 {
395 m_iCurrentButton = iButtonCode;
396 m_buttontime = GetTimeMs();
397
398 /* push keypress to the keybuffer with 0 duration.
399 push another press to the keybuffer with the duration set when the button is released */
400 cec_keypress key;
401 key.duration = 0;
402 key.keycode = m_iCurrentButton;
403 m_keyBuffer.Push(key);
404 }
405
406 void * CECCreate(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress /*= CEC::CECDEVICE_PLAYBACKDEVICE1 */, uint16_t iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS */)
407 {
408 return static_cast< void* > (new CLibCEC(strDeviceName, iLogicalAddress, iPhysicalAddress));
409 }
410
411 void * CECInit(const char *strDeviceName, CEC::cec_device_type_list types)
412 {
413 return static_cast< void* > (new CLibCEC(strDeviceName, types));
414 }
415
416 void CECDestroy(CEC::ICECAdapter *instance)
417 {
418 CLibCEC *lib = static_cast< CLibCEC* > (instance);
419 if (lib)
420 delete lib;
421 }
422
423 const char *CLibCEC::ToString(const cec_menu_state state)
424 {
425 return m_cec->ToString(state);
426 }
427
428 const char *CLibCEC::ToString(const cec_version version)
429 {
430 return m_cec->ToString(version);
431 }
432
433 const char *CLibCEC::ToString(const cec_power_status status)
434 {
435 return m_cec->ToString(status);
436 }
437
438 const char *CLibCEC::ToString(const cec_logical_address address)
439 {
440 return m_cec->ToString(address);
441 }
442
443 const char *CLibCEC::ToString(const cec_deck_control_mode mode)
444 {
445 return m_cec->ToString(mode);
446 }
447
448 const char *CLibCEC::ToString(const cec_deck_info status)
449 {
450 return m_cec->ToString(status);
451 }
452
453 const char *CLibCEC::ToString(const cec_opcode opcode)
454 {
455 return m_cec->ToString(opcode);
456 }
457
458 const char *CLibCEC::ToString(const cec_system_audio_status mode)
459 {
460 return m_cec->ToString(mode);
461 }
462
463 const char *CLibCEC::ToString(const cec_audio_status status)
464 {
465 return m_cec->ToString(status);
466 }
467
468 const char *CLibCEC::ToString(const cec_vendor_id vendor)
469 {
470 return m_cec->ToString(vendor);
471 }