cec: fixed - report physical address sends 3 parameters, not 2. check whether the...
[deb_libcec.git] / src / lib / devices / CECBusDevice.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 "CECBusDevice.h"
34 #include "../CECProcessor.h"
35 #include "../implementations/ANCommandHandler.h"
36 #include "../implementations/CECCommandHandler.h"
37 #include "../implementations/SLCommandHandler.h"
38 #include "../implementations/VLCommandHandler.h"
39 #include "../platform/timeutils.h"
40
41 using namespace CEC;
42
43 #define ToString(p) CCECCommandHandler::ToString(p)
44
45 CCECBusDevice::CCECBusDevice(CCECProcessor *processor, cec_logical_address iLogicalAddress, uint16_t iPhysicalAddress) :
46 m_type(CEC_DEVICE_TYPE_RESERVED),
47 m_iPhysicalAddress(iPhysicalAddress),
48 m_iStreamPath(0),
49 m_iLogicalAddress(iLogicalAddress),
50 m_powerStatus(CEC_POWER_STATUS_UNKNOWN),
51 m_processor(processor),
52 m_vendor(CEC_VENDOR_UNKNOWN),
53 m_menuState(CEC_MENU_STATE_ACTIVATED),
54 m_bActiveSource(false),
55 m_iLastCommandSent(0),
56 m_iLastActive(0),
57 m_cecVersion(CEC_VERSION_UNKNOWN)
58 {
59 m_handler = new CCECCommandHandler(this);
60
61 for (unsigned int iPtr = 0; iPtr < 4; iPtr++)
62 m_menuLanguage.language[iPtr] = '?';
63 m_menuLanguage.language[3] = 0;
64 m_menuLanguage.device = iLogicalAddress;
65
66 m_strDeviceName = ToString(m_iLogicalAddress);
67 }
68
69 CCECBusDevice::~CCECBusDevice(void)
70 {
71 m_condition.Broadcast();
72 delete m_handler;
73 }
74
75 void CCECBusDevice::AddLog(cec_log_level level, const CStdString &strMessage)
76 {
77 m_processor->AddLog(level, strMessage);
78 }
79
80 bool CCECBusDevice::HandleCommand(const cec_command &command)
81 {
82 CLockObject lock(&m_transmitMutex);
83 m_iLastActive = GetTimeMs();
84 m_handler->HandleCommand(command);
85 m_condition.Signal();
86 return true;
87 }
88
89 void CCECBusDevice::PollVendorId(void)
90 {
91 CLockObject lock(&m_transmitMutex);
92 if (m_iLastActive > 0 && m_iLogicalAddress != CECDEVICE_BROADCAST &&
93 m_vendor == CEC_VENDOR_UNKNOWN &&
94 GetTimeMs() - m_iLastCommandSent > 5000 &&
95 !m_processor->IsMonitoring())
96 {
97 CStdString strLog;
98 strLog.Format("<< requesting vendor ID of '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
99 AddLog(CEC_LOG_NOTICE, strLog);
100 m_iLastCommandSent = GetTimeMs();
101
102 cec_command command;
103 cec_command::Format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_GIVE_DEVICE_VENDOR_ID);
104 if (m_processor->Transmit(command))
105 m_condition.Wait(&m_transmitMutex, 1000);
106 }
107 }
108
109 bool CCECBusDevice::PowerOn(void)
110 {
111 cec_power_status current = GetPowerStatus();
112 if (current != CEC_POWER_STATUS_ON &&
113 current != CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON)
114 {
115 CStdString strLog;
116 strLog.Format("<< powering on '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
117 AddLog(CEC_LOG_DEBUG, strLog.c_str());
118
119 SetPowerStatus(CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON);
120
121 cec_command command;
122 cec_command::Format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_IMAGE_VIEW_ON);
123
124 return m_processor->Transmit(command);
125 }
126
127 return true;
128 }
129
130 bool CCECBusDevice::Standby(void)
131 {
132 CStdString strLog;
133 strLog.Format("<< putting '%s' (%X) in standby mode", GetLogicalAddressName(), m_iLogicalAddress);
134 AddLog(CEC_LOG_DEBUG, strLog.c_str());
135
136 cec_command command;
137 cec_command::Format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_STANDBY);
138
139 return m_processor->Transmit(command);
140 }
141
142 /** @name Getters */
143 //@{
144 cec_version CCECBusDevice::GetCecVersion(void)
145 {
146 if (!MyLogicalAddressContains(m_iLogicalAddress))
147 {
148 CStdString strLog;
149 strLog.Format("<< requesting CEC version of '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
150 AddLog(CEC_LOG_NOTICE, strLog);
151 cec_command command;
152 cec_command::Format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_GET_CEC_VERSION);
153 CLockObject lock(&m_transmitMutex);
154 if (m_processor->Transmit(command))
155 m_condition.Wait(&m_transmitMutex, 1000);
156 }
157
158 CLockObject lock(&m_mutex);
159 return m_cecVersion;
160 }
161
162 const char* CCECBusDevice::GetLogicalAddressName(void) const
163 {
164 return ToString(m_iLogicalAddress);
165 }
166
167 cec_menu_language &CCECBusDevice::GetMenuLanguage(void)
168 {
169 if (!MyLogicalAddressContains(m_iLogicalAddress))
170 {
171 CStdString strLog;
172 strLog.Format("<< requesting menu language of '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
173 AddLog(CEC_LOG_NOTICE, strLog);
174 cec_command command;
175 cec_command::Format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_GET_MENU_LANGUAGE);
176 CLockObject lock(&m_transmitMutex);
177 if (m_processor->Transmit(command))
178 m_condition.Wait(&m_transmitMutex, 1000);
179 }
180
181 CLockObject lock(&m_mutex);
182 return m_menuLanguage;
183 }
184
185 cec_logical_address CCECBusDevice::GetMyLogicalAddress(void) const
186 {
187 return m_processor->GetLogicalAddress();
188 }
189
190 uint16_t CCECBusDevice::GetMyPhysicalAddress(void) const
191 {
192 return m_processor->GetPhysicalAddress();
193 }
194
195 cec_power_status CCECBusDevice::GetPowerStatus(void)
196 {
197 if (!MyLogicalAddressContains(m_iLogicalAddress))
198 {
199 CStdString strLog;
200 strLog.Format("<< requesting power status of '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
201 AddLog(CEC_LOG_NOTICE, strLog);
202 cec_command command;
203 cec_command::Format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_GIVE_DEVICE_POWER_STATUS);
204 CLockObject lock(&m_transmitMutex);
205 if (m_processor->Transmit(command))
206 m_condition.Wait(&m_transmitMutex, 1000);
207 }
208
209 CLockObject lock(&m_mutex);
210 return m_powerStatus;
211 }
212
213 cec_vendor_id CCECBusDevice::GetVendorId(void)
214 {
215 if (!MyLogicalAddressContains(m_iLogicalAddress))
216 {
217 CStdString strLog;
218 strLog.Format("<< requesting vendor ID of '%s' (%X)", GetLogicalAddressName(), m_iLogicalAddress);
219 AddLog(CEC_LOG_NOTICE, strLog);
220 cec_command command;
221 cec_command::Format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_GIVE_DEVICE_VENDOR_ID);
222 CLockObject lock(&m_transmitMutex);
223
224 if (m_processor->Transmit(command))
225 m_condition.Wait(&m_transmitMutex, 1000);
226 }
227
228 CLockObject lock(&m_mutex);
229 return m_vendor;
230 }
231
232 const char *CCECBusDevice::GetVendorName(void)
233 {
234 CLockObject lock(&m_mutex);
235 return ToString(m_vendor);
236 }
237
238 bool CCECBusDevice::MyLogicalAddressContains(cec_logical_address address) const
239 {
240 return m_processor->HasLogicalAddress(address);
241 }
242
243 //@}
244
245 /** @name Setters */
246 //@{
247 void CCECBusDevice::SetCecVersion(const cec_version newVersion)
248 {
249 m_cecVersion = newVersion;
250
251 CStdString strLog;
252 strLog.Format("%s (%X): CEC version %s", GetLogicalAddressName(), m_iLogicalAddress, ToString(newVersion));
253 AddLog(CEC_LOG_DEBUG, strLog);
254 }
255
256 void CCECBusDevice::SetMenuLanguage(const cec_menu_language &language)
257 {
258 CLockObject lock(&m_mutex);
259 if (language.device == m_iLogicalAddress)
260 {
261 CStdString strLog;
262 strLog.Format(">> %s (%X): menu language set to '%s'", GetLogicalAddressName(), m_iLogicalAddress, language.language);
263 m_processor->AddLog(CEC_LOG_DEBUG, strLog);
264 m_menuLanguage = language;
265 }
266 }
267
268 void CCECBusDevice::SetMenuState(const cec_menu_state state)
269 {
270 CLockObject lock(&m_mutex);
271 if (m_menuState != state)
272 {
273 CStdString strLog;
274 strLog.Format(">> %s (%X): menu state set to '%s'", GetLogicalAddressName(), m_iLogicalAddress, ToString(m_menuState));
275 m_processor->AddLog(CEC_LOG_DEBUG, strLog);
276 m_menuState = state;
277 }
278 }
279
280 void CCECBusDevice::SetInactiveDevice(void)
281 {
282 CLockObject lock(&m_mutex);
283 m_bActiveSource = false;
284 }
285
286 void CCECBusDevice::SetActiveDevice(void)
287 {
288 CLockObject lock(&m_mutex);
289
290 for (int iPtr = 0; iPtr < 16; iPtr++)
291 if (iPtr != m_iLogicalAddress)
292 m_processor->m_busDevices[iPtr]->SetInactiveDevice();
293
294 m_bActiveSource = true;
295 m_powerStatus = CEC_POWER_STATUS_ON;
296 }
297
298 void CCECBusDevice::SetPhysicalAddress(uint16_t iNewAddress)
299 {
300 CLockObject lock(&m_mutex);
301 if (iNewAddress > 0)
302 {
303 CStdString strLog;
304 strLog.Format(">> %s (%X): physical address changed from %04x to %04x", GetLogicalAddressName(), m_iLogicalAddress, m_iPhysicalAddress, iNewAddress);
305 AddLog(CEC_LOG_DEBUG, strLog.c_str());
306
307 m_iPhysicalAddress = iNewAddress;
308 }
309 }
310
311 void CCECBusDevice::SetStreamPath(uint16_t iNewAddress, uint16_t iOldAddress /* = 0 */)
312 {
313 CLockObject lock(&m_mutex);
314 if (iNewAddress > 0)
315 {
316 CStdString strLog;
317 strLog.Format(">> %s (%X): stream path changed from %04x to %04x", GetLogicalAddressName(), m_iLogicalAddress, iOldAddress, iNewAddress);
318 AddLog(CEC_LOG_DEBUG, strLog.c_str());
319
320 m_iStreamPath = iNewAddress;
321
322 if (iNewAddress > 0)
323 {
324 lock.Leave();
325 SetPowerStatus(CEC_POWER_STATUS_ON);
326 }
327 }
328 }
329
330 void CCECBusDevice::SetPowerStatus(const cec_power_status powerStatus)
331 {
332 CLockObject lock(&m_mutex);
333 if (m_powerStatus != powerStatus)
334 {
335 CStdString strLog;
336 strLog.Format(">> %s (%X): power status changed from '%s' to '%s'", GetLogicalAddressName(), m_iLogicalAddress, ToString(m_powerStatus), ToString(powerStatus));
337 m_processor->AddLog(CEC_LOG_DEBUG, strLog);
338 m_powerStatus = powerStatus;
339 }
340 }
341
342 void CCECBusDevice::SetVendorId(uint64_t iVendorId)
343 {
344 {
345 CLockObject lock(&m_mutex);
346 m_vendor = (cec_vendor_id)iVendorId;
347
348 switch (iVendorId)
349 {
350 case CEC_VENDOR_SAMSUNG:
351 if (m_handler->GetVendorId() != CEC_VENDOR_SAMSUNG)
352 {
353 delete m_handler;
354 m_handler = new CANCommandHandler(this);
355 }
356 break;
357 case CEC_VENDOR_LG:
358 if (m_handler->GetVendorId() != CEC_VENDOR_LG)
359 {
360 delete m_handler;
361 m_handler = new CSLCommandHandler(this);
362 }
363 break;
364 case CEC_VENDOR_PANASONIC:
365 if (m_handler->GetVendorId() != CEC_VENDOR_PANASONIC)
366 {
367 delete m_handler;
368 m_handler = new CVLCommandHandler(this);
369 }
370 break;
371 default:
372 if (m_handler->GetVendorId() != CEC_VENDOR_UNKNOWN)
373 {
374 delete m_handler;
375 m_handler = new CCECCommandHandler(this);
376 }
377 break;
378 }
379 }
380
381 CStdString strLog;
382 strLog.Format("%s (%X): vendor = %s (%06x)", GetLogicalAddressName(), m_iLogicalAddress, GetVendorName(), m_vendor);
383 m_processor->AddLog(CEC_LOG_DEBUG, strLog.c_str());
384 }
385 //@}
386
387 /** @name Transmit methods */
388 //@{
389 bool CCECBusDevice::TransmitActiveSource(void)
390 {
391 CLockObject lock(&m_mutex);
392 if (m_powerStatus != CEC_POWER_STATUS_ON)
393 {
394 CStdString strLog;
395 strLog.Format("<< %s (%X) is not powered on", GetLogicalAddressName(), m_iLogicalAddress);
396 AddLog(CEC_LOG_DEBUG, strLog);
397 }
398 else if (m_bActiveSource)
399 {
400 CStdString strLog;
401 strLog.Format("<< %s (%X) -> broadcast (F): active source (%4x)", GetLogicalAddressName(), m_iLogicalAddress, m_iPhysicalAddress);
402 AddLog(CEC_LOG_NOTICE, strLog);
403
404 cec_command command;
405 cec_command::Format(command, m_iLogicalAddress, CECDEVICE_BROADCAST, CEC_OPCODE_ACTIVE_SOURCE);
406 command.parameters.PushBack((uint8_t) ((m_iPhysicalAddress >> 8) & 0xFF));
407 command.parameters.PushBack((uint8_t) (m_iPhysicalAddress & 0xFF));
408
409 lock.Leave();
410 return m_processor->Transmit(command);
411 }
412 else
413 {
414 CStdString strLog;
415 strLog.Format("<< %s (%X) is not the active source", GetLogicalAddressName(), m_iLogicalAddress);
416 AddLog(CEC_LOG_DEBUG, strLog);
417 }
418
419 return false;
420 }
421
422 bool CCECBusDevice::TransmitCECVersion(cec_logical_address dest)
423 {
424 CLockObject lock(&m_mutex);
425 CStdString strLog;
426 strLog.Format("<< %s (%X) -> %s (%X): cec version %s", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, ToString(m_cecVersion));
427 AddLog(CEC_LOG_NOTICE, strLog);
428
429 cec_command command;
430 cec_command::Format(command, m_iLogicalAddress, dest, CEC_OPCODE_CEC_VERSION);
431 command.parameters.PushBack((uint8_t)m_cecVersion);
432
433 lock.Leave();
434 return m_processor->Transmit(command);
435 }
436
437 bool CCECBusDevice::TransmitInactiveView(void)
438 {
439 CStdString strLog;
440 strLog.Format("<< %s (%X) -> broadcast (F): inactive view", GetLogicalAddressName(), m_iLogicalAddress);
441 AddLog(CEC_LOG_NOTICE, strLog);
442
443 cec_command command;
444 cec_command::Format(command, m_iLogicalAddress, CECDEVICE_BROADCAST, CEC_OPCODE_INACTIVE_SOURCE);
445 command.parameters.PushBack((m_iPhysicalAddress >> 8) & 0xFF);
446 command.parameters.PushBack(m_iPhysicalAddress & 0xFF);
447
448 return m_processor->Transmit(command);
449 }
450
451 bool CCECBusDevice::TransmitMenuState(cec_logical_address dest)
452 {
453 CStdString strLog;
454 strLog.Format("<< %s (%X) -> %s (%X): menu state '%s'", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, ToString(m_menuState));
455 AddLog(CEC_LOG_NOTICE, strLog);
456
457 cec_command command;
458 cec_command::Format(command, m_iLogicalAddress, dest, CEC_OPCODE_MENU_STATUS);
459 command.parameters.PushBack((uint8_t)m_menuState);
460
461 return m_processor->Transmit(command);
462 }
463
464 bool CCECBusDevice::TransmitOSDName(cec_logical_address dest)
465 {
466 CLockObject lock(&m_mutex);
467 CStdString strLog;
468 strLog.Format("<< %s (%X) -> %s (%X): OSD name '%s'", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, m_strDeviceName.c_str());
469 AddLog(CEC_LOG_NOTICE, strLog.c_str());
470
471 cec_command command;
472 cec_command::Format(command, m_iLogicalAddress, dest, CEC_OPCODE_SET_OSD_NAME);
473 for (unsigned int iPtr = 0; iPtr < m_strDeviceName.length(); iPtr++)
474 command.parameters.PushBack(m_strDeviceName.at(iPtr));
475
476 lock.Leave();
477 return m_processor->Transmit(command);
478 }
479
480 bool CCECBusDevice::TransmitOSDString(cec_logical_address dest, cec_display_control duration, const char *strMessage)
481 {
482 CLockObject lock(&m_mutex);
483 CStdString strLog;
484 strLog.Format("<< %s (%X) -> %s (%X): display OSD message '%s'", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, strMessage);
485 AddLog(CEC_LOG_NOTICE, strLog.c_str());
486
487 cec_command command;
488 cec_command::Format(command, m_iLogicalAddress, dest, CEC_OPCODE_SET_OSD_STRING);
489 command.parameters.PushBack((uint8_t)duration);
490
491 unsigned int iLen = strlen(strMessage);
492 if (iLen > 13) iLen = 13;
493
494 for (unsigned int iPtr = 0; iPtr < iLen; iPtr++)
495 command.parameters.PushBack(strMessage[iPtr]);
496
497 lock.Leave();
498 return m_processor->Transmit(command);
499 }
500
501 bool CCECBusDevice::TransmitPhysicalAddress(void)
502 {
503 CLockObject lock(&m_mutex);
504 CStdString strLog;
505 strLog.Format("<< %s (%X) -> broadcast (F): physical adddress %4x", GetLogicalAddressName(), m_iLogicalAddress, m_iPhysicalAddress);
506 AddLog(CEC_LOG_NOTICE, strLog.c_str());
507
508 cec_command command;
509 cec_command::Format(command, m_iLogicalAddress, CECDEVICE_BROADCAST, CEC_OPCODE_REPORT_PHYSICAL_ADDRESS);
510 command.parameters.PushBack((uint8_t) ((m_iPhysicalAddress >> 8) & 0xFF));
511 command.parameters.PushBack((uint8_t) (m_iPhysicalAddress & 0xFF));
512 command.parameters.PushBack((uint8_t) (m_type));
513
514 lock.Leave();
515 return m_processor->Transmit(command);
516 }
517
518 bool CCECBusDevice::TransmitPoll(cec_logical_address dest)
519 {
520 bool bReturn(false);
521 if (dest == CECDEVICE_UNKNOWN)
522 dest = m_iLogicalAddress;
523
524 CStdString strLog;
525 strLog.Format("<< %s (%X) -> %s (%X): POLL", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest);
526 AddLog(CEC_LOG_NOTICE, strLog.c_str());
527
528 cec_command command;
529 cec_command::Format(command, m_iLogicalAddress, dest, CEC_OPCODE_NONE);
530 CLockObject lock(&m_transmitMutex);
531
532 bReturn = m_processor->Transmit(command);
533 AddLog(CEC_LOG_DEBUG, bReturn ? ">> POLL sent" : ">> POLL not sent");
534 return bReturn;
535 }
536
537 bool CCECBusDevice::TransmitPowerState(cec_logical_address dest)
538 {
539 CLockObject lock(&m_mutex);
540 CStdString strLog;
541 strLog.Format("<< %s (%X) -> %s (%X): %s", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, ToString(m_powerStatus));
542 AddLog(CEC_LOG_NOTICE, strLog.c_str());
543
544 cec_command command;
545 cec_command::Format(command, m_iLogicalAddress, dest, CEC_OPCODE_REPORT_POWER_STATUS);
546 command.parameters.PushBack((uint8_t) m_powerStatus);
547
548 lock.Leave();
549 return m_processor->Transmit(command);
550 }
551
552 bool CCECBusDevice::TransmitVendorID(cec_logical_address dest)
553 {
554 CLockObject lock(&m_mutex);
555 if (m_vendor == CEC_VENDOR_UNKNOWN)
556 {
557 CStdString strLog;
558 strLog.Format("<< %s (%X) -> %s (%X): vendor id feature abort", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest);
559 AddLog(CEC_LOG_NOTICE, strLog);
560
561 lock.Leave();
562 m_processor->TransmitAbort(dest, CEC_OPCODE_GIVE_DEVICE_VENDOR_ID);
563 return false;
564 }
565 else
566 {
567 CStdString strLog;
568 strLog.Format("<< %s (%X) -> %s (%X): vendor id %s (%x)", GetLogicalAddressName(), m_iLogicalAddress, ToString(dest), dest, ToString(m_vendor), (uint64_t)m_vendor);
569 AddLog(CEC_LOG_NOTICE, strLog);
570
571 cec_command command;
572 cec_command::Format(command, m_iLogicalAddress, CECDEVICE_BROADCAST, CEC_OPCODE_DEVICE_VENDOR_ID);
573
574 command.parameters.PushBack((uint8_t) (((uint64_t)m_vendor >> 16) & 0xFF));
575 command.parameters.PushBack((uint8_t) (((uint64_t)m_vendor >> 8) & 0xFF));
576 command.parameters.PushBack((uint8_t) ((uint64_t)m_vendor & 0xFF));
577
578 lock.Leave();
579 return m_processor->Transmit(command);
580 }
581 }
582 //@}