cec: make the vendor name available on the interface
[deb_libcec.git] / src / lib / devices / CECBusDevice.cpp
CommitLineData
e9de9629
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 "CECBusDevice.h"
eafa9d46
LOK
34#include "../CECProcessor.h"
35#include "../implementations/ANCommandHandler.h"
36#include "../implementations/CECCommandHandler.h"
37#include "../implementations/SLCommandHandler.h"
38#include "../platform/timeutils.h"
e9de9629
LOK
39
40using namespace CEC;
41
42CCECBusDevice::CCECBusDevice(CCECProcessor *processor, cec_logical_address iLogicalAddress, uint16_t iPhysicalAddress) :
43 m_iPhysicalAddress(iPhysicalAddress),
44 m_iLogicalAddress(iLogicalAddress),
e55f3f70 45 m_powerStatus(CEC_POWER_STATUS_UNKNOWN),
e9de9629 46 m_processor(processor),
0ab58650 47 m_iVendorClass(CEC_VENDOR_UNKNOWN),
6a1c0009
LOK
48 m_iLastActive(0),
49 m_cecVersion(CEC_VERSION_UNKNOWN)
e9de9629
LOK
50{
51 m_handler = new CCECCommandHandler(this);
a3269a0a
LOK
52 for (unsigned int iPtr = 0; iPtr < 4; iPtr++)
53 m_menuLanguage.language[iPtr] = '?';
54 m_menuLanguage.language[3] = 0;
55 m_menuLanguage.device = iLogicalAddress;
0500da96 56 m_vendor.vendor = CEC_VENDOR_UNKNOWN;
e9de9629
LOK
57}
58
59CCECBusDevice::~CCECBusDevice(void)
60{
6a1c0009 61 m_condition.Broadcast();
e9de9629
LOK
62 delete m_handler;
63}
64
65cec_logical_address CCECBusDevice::GetMyLogicalAddress(void) const
66{
67 return m_processor->GetLogicalAddress();
68}
69
70uint16_t CCECBusDevice::GetMyPhysicalAddress(void) const
71{
72 return m_processor->GetPhysicalAddress();
73}
74
75void CCECBusDevice::AddLog(cec_log_level level, const CStdString &strMessage)
76{
77 m_processor->AddLog(level, strMessage);
78}
79
a3269a0a
LOK
80void CCECBusDevice::SetMenuLanguage(const cec_menu_language &language)
81{
82 if (language.device == m_iLogicalAddress)
83 {
84 CStdString strLog;
85 strLog.Format("device %d menu language set to '%s'", m_iLogicalAddress, language.language);
86 m_processor->AddLog(CEC_LOG_DEBUG, strLog);
87 m_menuLanguage = language;
88 }
89}
90
e55f3f70 91void CCECBusDevice::SetCecVersion(const cec_version newVersion)
6a1c0009
LOK
92{
93 CStdString strLog;
94 m_cecVersion = newVersion;
95
96 switch (newVersion)
97 {
98 case CEC_VERSION_1_2:
99 strLog.Format("device %d reports CEC version 1.2", m_iLogicalAddress);
100 break;
101 case CEC_VERSION_1_2A:
102 strLog.Format("device %d reports CEC version 1.2a", m_iLogicalAddress);
103 break;
104 case CEC_VERSION_1_3:
105 strLog.Format("device %d reports CEC version 1.3", m_iLogicalAddress);
106 break;
107 case CEC_VERSION_1_3A:
108 strLog.Format("device %d reports CEC version 1.3a", m_iLogicalAddress);
109 break;
110 default:
111 strLog.Format("device %d reports an unknown CEC version", m_iLogicalAddress);
112 m_cecVersion = CEC_VERSION_UNKNOWN;
113 break;
114 }
115 AddLog(CEC_LOG_DEBUG, strLog);
116}
117
e55f3f70
LOK
118void CCECBusDevice::SetPowerStatus(const cec_power_status powerStatus)
119{
120 CStdString strLog;
121 strLog.Format("device %d power status changed from %2x to %2x", m_iLogicalAddress, m_powerStatus, powerStatus);
122 m_processor->AddLog(CEC_LOG_DEBUG, strLog);
123 m_powerStatus = powerStatus;
124}
125
0f23c85c
LOK
126void CCECBusDevice::SetVendorId(const cec_datapacket &data)
127{
128 if (data.size < 3)
129 {
130 AddLog(CEC_LOG_WARNING, "invalid vendor ID received");
131 return;
132 }
133
134 uint64_t iVendorId = ((uint64_t)data[0] << 3) +
135 ((uint64_t)data[1] << 2) +
136 (uint64_t)data[2];
137
138 SetVendorId(iVendorId, data.size >= 4 ? data[3] : 0);
139}
140
2cd8b5d0 141void CCECBusDevice::SetVendorId(uint64_t iVendorId, uint8_t iVendorClass /* = 0 */)
e9de9629 142{
0500da96 143 m_vendor.vendor = (cec_vendor_id)iVendorId;
e9de9629
LOK
144 m_iVendorClass = iVendorClass;
145
146 switch (iVendorId)
147 {
148 case CEC_VENDOR_SAMSUNG:
0ab58650
LOK
149 if (m_handler->GetVendorId() != CEC_VENDOR_SAMSUNG)
150 {
151 delete m_handler;
152 m_handler = new CANCommandHandler(this);
153 }
e9de9629
LOK
154 break;
155 case CEC_VENDOR_LG:
0ab58650
LOK
156 if (m_handler->GetVendorId() != CEC_VENDOR_LG)
157 {
158 delete m_handler;
159 m_handler = new CSLCommandHandler(this);
160 }
e9de9629
LOK
161 break;
162 default:
0ab58650
LOK
163 if (m_handler->GetVendorId() != CEC_VENDOR_UNKNOWN)
164 {
165 delete m_handler;
166 m_handler = new CCECCommandHandler(this);
167 }
e9de9629
LOK
168 break;
169 }
170
171 CStdString strLog;
0f23c85c 172 strLog.Format("device %d: vendor = %s (%06x) class = %2x", m_iLogicalAddress, GetVendorName(), GetVendorId(), GetVendorClass());
e9de9629
LOK
173 m_processor->AddLog(CEC_LOG_DEBUG, strLog.c_str());
174}
175
176bool CCECBusDevice::HandleCommand(const cec_command &command)
177{
178 CLockObject lock(&m_mutex);
0ab58650 179 m_iLastActive = GetTimeMs();
e9de9629 180 m_handler->HandleCommand(command);
6a1c0009 181 m_condition.Signal();
e9de9629
LOK
182 return true;
183}
184
0500da96 185const cec_vendor &CCECBusDevice::GetVendor(void)
44c74256 186{
0500da96 187 if (m_vendor.vendor == CEC_VENDOR_UNKNOWN)
44c74256
LOK
188 {
189 AddLog(CEC_LOG_NOTICE, "<< requesting vendor ID");
190 cec_command command;
191 cec_command::format(command, GetMyLogicalAddress(), GetLogicalAddress(), CEC_OPCODE_GIVE_DEVICE_VENDOR_ID);
192 CLockObject lock(&m_mutex);
193
194 if (m_processor->Transmit(command))
195 m_condition.Wait(&m_mutex, 1000);
196 }
197
0500da96 198 return m_vendor;
44c74256
LOK
199}
200
0ab58650
LOK
201void CCECBusDevice::PollVendorId(void)
202{
203 CLockObject lock(&m_mutex);
0f23c85c 204 if (m_iLastActive > 0 && m_iLogicalAddress != CECDEVICE_BROADCAST &&
0500da96 205 m_vendor.vendor == CEC_VENDOR_UNKNOWN &&
0ab58650
LOK
206 GetTimeMs() - m_iLastActive > 5000)
207 {
208 m_iLastActive = GetTimeMs();
209
210 cec_command command;
211 cec_command::format(command, GetMyLogicalAddress(), GetLogicalAddress(), CEC_OPCODE_GIVE_DEVICE_VENDOR_ID);
8d84e2c0
LOK
212 command.ack_timeout = 0;
213 m_processor->Transmit(command);
0ab58650
LOK
214 }
215}
216
4e4be5cf
LOK
217void CCECBusDevice::SetPhysicalAddress(uint16_t iNewAddress, uint16_t iOldAddress /* = 0 */)
218{
5eb9e3af
LOK
219 if (iNewAddress > 0)
220 {
221 CStdString strLog;
222 strLog.Format(">> %i changed physical address from %04x to %04x", GetLogicalAddress(), m_iPhysicalAddress, iNewAddress);
223 AddLog(CEC_LOG_DEBUG, strLog.c_str());
4e4be5cf 224
5eb9e3af
LOK
225 m_iPhysicalAddress = iNewAddress;
226 }
4e4be5cf
LOK
227}
228
0f23c85c
LOK
229bool CCECBusDevice::PowerOn(void)
230{
231 CStdString strLog;
232 strLog.Format("<< powering on device with logical address %d", (int8_t)m_iLogicalAddress);
233 AddLog(CEC_LOG_DEBUG, strLog.c_str());
234
235 cec_command command;
236 cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_IMAGE_VIEW_ON);
237
238 return m_processor->Transmit(command);
239}
240
241bool CCECBusDevice::Standby(void)
242{
243 CStdString strLog;
244 strLog.Format("<< putting device with logical address %d in standby mode", (int8_t)m_iLogicalAddress);
245 AddLog(CEC_LOG_DEBUG, strLog.c_str());
246
247 cec_command command;
248 cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_STANDBY);
249
250 return m_processor->Transmit(command);
251}
252
253bool CCECBusDevice::SetOSDString(cec_display_control duration, const char *strMessage)
254{
255 CStdString strLog;
256 strLog.Format("<< display message '%s'", strMessage);
257 AddLog(CEC_LOG_NOTICE, strLog.c_str());
258
259 cec_command command;
260 cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_SET_OSD_STRING);
261 command.parameters.push_back((uint8_t)duration);
262
263 for (unsigned int iPtr = 0; iPtr < strlen(strMessage); iPtr++)
264 command.parameters.push_back(strMessage[iPtr]);
265
266 return m_processor->Transmit(command);
267}
268
269bool CCECBusDevice::ReportCECVersion(void)
270{
271 AddLog(CEC_LOG_NOTICE, "<< reporting CEC version as 1.3a");
272
273 cec_command command;
274 cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_CEC_VERSION);
275 command.parameters.push_back(CEC_VERSION_1_3A);
276
277 return m_processor->Transmit(command);
278}
279
280bool CCECBusDevice::ReportDeckStatus(void)
281{
282 // need to support opcodes play and deck control before doing anything with this
283 AddLog(CEC_LOG_NOTICE, "<< deck status requested, feature abort");
284 m_processor->TransmitAbort(m_iLogicalAddress, CEC_OPCODE_GIVE_DEVICE_VENDOR_ID);
285 return false;
286}
287
288bool CCECBusDevice::ReportMenuState(bool bActive /* = true */)
289{
290 if (bActive)
291 AddLog(CEC_LOG_NOTICE, "<< reporting menu state as active");
292 else
293 AddLog(CEC_LOG_NOTICE, "<< reporting menu state as inactive");
294
295 cec_command command;
296 cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_MENU_STATUS);
297 command.parameters.push_back(bActive ? (uint8_t) CEC_MENU_STATE_ACTIVATED : (uint8_t) CEC_MENU_STATE_DEACTIVATED);
298
299 return m_processor->Transmit(command);
300}
301
302bool CCECBusDevice::ReportOSDName(void)
303{
304 const char *osdname = m_processor->GetDeviceName().c_str();
305 CStdString strLog;
306 strLog.Format("<< reporting OSD name as %s", osdname);
307 AddLog(CEC_LOG_NOTICE, strLog.c_str());
308
309 cec_command command;
310 cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_SET_OSD_NAME);
311 for (unsigned int iPtr = 0; iPtr < strlen(osdname); iPtr++)
312 command.parameters.push_back(osdname[iPtr]);
313
314 return m_processor->Transmit(command);
315}
316
317bool CCECBusDevice::ReportPowerState(bool bOn /* = true */)
318{
319 if (bOn)
320 AddLog(CEC_LOG_NOTICE, "<< reporting \"On\" power status");
321 else
322 AddLog(CEC_LOG_NOTICE, "<< reporting \"Off\" power status");
323
324 cec_command command;
325 cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_REPORT_POWER_STATUS);
326 command.parameters.push_back(bOn ? (uint8_t) CEC_POWER_STATUS_ON : (uint8_t) CEC_POWER_STATUS_STANDBY);
327
328 return m_processor->Transmit(command);
329}
330
331bool CCECBusDevice::ReportVendorID(void)
332{
333 AddLog(CEC_LOG_NOTICE, "<< vendor ID requested, feature abort");
334 m_processor->TransmitAbort(m_iLogicalAddress, CEC_OPCODE_GIVE_DEVICE_VENDOR_ID);
335 return false;
336}
337
338bool CCECBusDevice::BroadcastActiveView(void)
339{
340 AddLog(CEC_LOG_DEBUG, "<< setting active view");
341
342 cec_command command;
82b6ff53 343 cec_command::format(command, GetMyLogicalAddress(), CECDEVICE_BROADCAST, CEC_OPCODE_ACTIVE_SOURCE);
0f23c85c
LOK
344 command.parameters.push_back((m_iPhysicalAddress >> 8) & 0xFF);
345 command.parameters.push_back(m_iPhysicalAddress & 0xFF);
346
347 return m_processor->Transmit(command);
348}
349
350bool CCECBusDevice::BroadcastInactiveView(void)
351{
352 AddLog(CEC_LOG_DEBUG, "<< setting inactive view");
353
354 cec_command command;
82b6ff53 355 cec_command::format(command, GetMyLogicalAddress(), CECDEVICE_BROADCAST, CEC_OPCODE_INACTIVE_SOURCE);
0f23c85c
LOK
356 command.parameters.push_back((m_iPhysicalAddress >> 8) & 0xFF);
357 command.parameters.push_back(m_iPhysicalAddress & 0xFF);
358
359 return m_processor->Transmit(command);
360}
361
362bool CCECBusDevice::BroadcastPhysicalAddress(void)
363{
364 CStdString strLog;
365 strLog.Format("<< reporting physical address as %04x", m_iPhysicalAddress);
366 AddLog(CEC_LOG_NOTICE, strLog.c_str());
367
368 cec_command command;
82b6ff53 369 cec_command::format(command, GetMyLogicalAddress(), CECDEVICE_BROADCAST, CEC_OPCODE_REPORT_PHYSICAL_ADDRESS);
0f23c85c
LOK
370 command.parameters.push_back((uint8_t) ((m_iPhysicalAddress >> 8) & 0xFF));
371 command.parameters.push_back((uint8_t) (m_iPhysicalAddress & 0xFF));
372 command.parameters.push_back((uint8_t) (CEC_DEVICE_TYPE_PLAYBACK_DEVICE));
373
374 return m_processor->Transmit(command);
375}
376
377bool CCECBusDevice::BroadcastActiveSource(void)
378{
379 AddLog(CEC_LOG_NOTICE, "<< broadcasting active source");
380
381 cec_command command;
82b6ff53 382 cec_command::format(command, GetMyLogicalAddress(), CECDEVICE_BROADCAST, CEC_OPCODE_ACTIVE_SOURCE);
0f23c85c
LOK
383 command.parameters.push_back((uint8_t) ((m_iPhysicalAddress >> 8) & 0xFF));
384 command.parameters.push_back((uint8_t) (m_iPhysicalAddress & 0xFF));
385
386 return m_processor->Transmit(command);
387}
388
6a1c0009
LOK
389cec_version CCECBusDevice::GetCecVersion(void)
390{
391 if (m_cecVersion == CEC_VERSION_UNKNOWN)
392 {
393 AddLog(CEC_LOG_NOTICE, "<< requesting CEC version");
394 cec_command command;
395 cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_GET_CEC_VERSION);
396 CLockObject lock(&m_mutex);
397 if (m_processor->Transmit(command))
398 m_condition.Wait(&m_mutex, 1000);
399 }
400
401 return m_cecVersion;
402}
403
a3269a0a
LOK
404cec_menu_language &CCECBusDevice::GetMenuLanguage(void)
405{
406 if (!strcmp(m_menuLanguage.language, "???"))
407 {
408 AddLog(CEC_LOG_NOTICE, "<< requesting menu language");
409 cec_command command;
410 cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_GET_MENU_LANGUAGE);
411 CLockObject lock(&m_mutex);
412 if (m_processor->Transmit(command))
413 m_condition.Wait(&m_mutex, 1000);
414 }
415
416 return m_menuLanguage;
417}
418
e55f3f70
LOK
419cec_power_status CCECBusDevice::GetPowerStatus(void)
420{
421 if (m_powerStatus == CEC_POWER_STATUS_UNKNOWN)
422 {
423 AddLog(CEC_LOG_NOTICE, "<< requesting power status");
424 cec_command command;
425 cec_command::format(command, GetMyLogicalAddress(), m_iLogicalAddress, CEC_OPCODE_GIVE_DEVICE_POWER_STATUS);
426 CLockObject lock(&m_mutex);
427 if (m_processor->Transmit(command))
428 m_condition.Wait(&m_mutex, 1000);
429 }
430
431 return m_powerStatus;
432}