2 * This file is part of the libCEC(R) library.
4 * libCEC(R) is Copyright (C) 2011 Pulse-Eight Limited. All rights reserved.
5 * libCEC(R) is an original work, containing original code.
7 * libCEC(R) is a trademark of Pulse-Eight Limited.
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.
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.
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.
24 * Alternatively, you can license this library under a commercial license,
25 * please contact Pulse-Eight Licensing for more information.
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/
33 #include "CECProcessor.h"
35 #include "AdapterCommunication.h"
36 #include "devices/CECBusDevice.h"
37 #include "devices/CECAudioSystem.h"
38 #include "devices/CECPlaybackDevice.h"
39 #include "devices/CECRecordingDevice.h"
40 #include "devices/CECTuner.h"
41 #include "devices/CECTV.h"
42 #include "implementations/CECCommandHandler.h"
44 #include "util/StdString.h"
45 #include "platform/timeutils.h"
50 CCECProcessor::CCECProcessor(CLibCEC
*controller
, CAdapterCommunication
*serComm
, const char *strDeviceName
, cec_logical_address iLogicalAddress
/* = CECDEVICE_PLAYBACKDEVICE1 */, uint16_t iPhysicalAddress
/* = CEC_DEFAULT_PHYSICAL_ADDRESS*/) :
52 m_strDeviceName(strDeviceName
),
53 m_communication(serComm
),
54 m_controller(controller
),
57 m_logicalAddresses
.Clear();
58 m_logicalAddresses
.Set(iLogicalAddress
);
60 for (int iPtr
= 0; iPtr
<= 16; iPtr
++)
61 m_busDevices
[iPtr
] = new CCECBusDevice(this, (cec_logical_address
) iPtr
, iPtr
== iLogicalAddress
? iPhysicalAddress
: 0);
64 CCECProcessor::CCECProcessor(CLibCEC
*controller
, CAdapterCommunication
*serComm
, const char *strDeviceName
, const cec_device_type_list
&types
) :
66 m_strDeviceName(strDeviceName
),
68 m_communication(serComm
),
69 m_controller(controller
),
72 m_logicalAddresses
.Clear();
73 for (int iPtr
= 0; iPtr
< 16; iPtr
++)
77 case CECDEVICE_AUDIOSYSTEM
:
78 m_busDevices
[iPtr
] = new CCECAudioSystem(this, (cec_logical_address
) iPtr
, 0xFFFF);
80 case CECDEVICE_PLAYBACKDEVICE1
:
81 case CECDEVICE_PLAYBACKDEVICE2
:
82 case CECDEVICE_PLAYBACKDEVICE3
:
83 m_busDevices
[iPtr
] = new CCECPlaybackDevice(this, (cec_logical_address
) iPtr
, 0xFFFF);
85 case CECDEVICE_RECORDINGDEVICE1
:
86 case CECDEVICE_RECORDINGDEVICE2
:
87 case CECDEVICE_RECORDINGDEVICE3
:
88 m_busDevices
[iPtr
] = new CCECRecordingDevice(this, (cec_logical_address
) iPtr
, 0xFFFF);
90 case CECDEVICE_TUNER1
:
91 case CECDEVICE_TUNER2
:
92 case CECDEVICE_TUNER3
:
93 case CECDEVICE_TUNER4
:
94 m_busDevices
[iPtr
] = new CCECTuner(this, (cec_logical_address
) iPtr
, 0xFFFF);
97 m_busDevices
[iPtr
] = new CCECTV(this, (cec_logical_address
) iPtr
, 0);
100 m_busDevices
[iPtr
] = new CCECBusDevice(this, (cec_logical_address
) iPtr
, 0xFFFF);
106 CCECProcessor::~CCECProcessor(void)
108 m_startCondition
.Broadcast();
110 m_communication
= NULL
;
112 for (unsigned int iPtr
= 0; iPtr
< 16; iPtr
++)
113 delete m_busDevices
[iPtr
];
116 bool CCECProcessor::Start(void)
118 CLockObject
lock(&m_mutex
);
119 if (!m_communication
|| !m_communication
->IsOpen())
121 m_controller
->AddLog(CEC_LOG_ERROR
, "connection is closed");
127 if (!m_startCondition
.Wait(&m_mutex
) || !m_bStarted
)
129 m_controller
->AddLog(CEC_LOG_ERROR
, "could not create a processor thread");
135 m_controller
->AddLog(CEC_LOG_ERROR
, "could not create a processor thread");
140 bool CCECProcessor::TryLogicalAddress(cec_logical_address address
, unsigned int iIndex
)
142 const char *strLabel
= CCECCommandHandler::ToString(address
);
144 strLog
.Format("trying logical address '%s'", strLabel
);
145 AddLog(CEC_LOG_DEBUG
, strLog
);
147 SetAckMask(0x1 << address
);
148 if (!m_busDevices
[address
]->TransmitPoll(address
))
150 strLog
.Format("using logical address '%s'", strLabel
);
151 AddLog(CEC_LOG_NOTICE
, strLog
);
153 /* only set our OSD name and active source for the primary device */
154 if (m_logicalAddresses
.IsEmpty())
156 m_busDevices
[address
]->m_strDeviceName
= m_strDeviceName
;
157 m_busDevices
[address
]->m_bActiveSource
= true;
159 m_busDevices
[address
]->m_powerStatus
= CEC_POWER_STATUS_STANDBY
;
160 m_busDevices
[address
]->m_cecVersion
= CEC_VERSION_1_3A
;
162 m_logicalAddresses
.Set(address
);
165 m_busDevices
[address
]->SetPhysicalAddress((uint16_t)CEC_DEFAULT_PHYSICAL_ADDRESS
+ ((uint16_t)iIndex
* 0x100));
170 strLog
.Format("logical address '%s' already taken", strLabel
);
171 AddLog(CEC_LOG_DEBUG
, strLog
);
175 bool CCECProcessor::FindLogicalAddressRecordingDevice(unsigned int iIndex
)
177 AddLog(CEC_LOG_DEBUG
, "detecting logical address for type 'recording device'");
178 return TryLogicalAddress(CECDEVICE_RECORDINGDEVICE1
, iIndex
) ||
179 TryLogicalAddress(CECDEVICE_RECORDINGDEVICE2
, iIndex
) ||
180 TryLogicalAddress(CECDEVICE_RECORDINGDEVICE3
, iIndex
);
183 bool CCECProcessor::FindLogicalAddressTuner(unsigned int iIndex
)
185 AddLog(CEC_LOG_DEBUG
, "detecting logical address for type 'tuner'");
186 return TryLogicalAddress(CECDEVICE_TUNER1
, iIndex
) ||
187 TryLogicalAddress(CECDEVICE_TUNER2
, iIndex
) ||
188 TryLogicalAddress(CECDEVICE_TUNER3
, iIndex
) ||
189 TryLogicalAddress(CECDEVICE_TUNER4
, iIndex
);
192 bool CCECProcessor::FindLogicalAddressPlaybackDevice(unsigned int iIndex
)
194 AddLog(CEC_LOG_DEBUG
, "detecting logical address for type 'playback device'");
195 return TryLogicalAddress(CECDEVICE_PLAYBACKDEVICE1
, iIndex
) ||
196 TryLogicalAddress(CECDEVICE_PLAYBACKDEVICE2
, iIndex
) ||
197 TryLogicalAddress(CECDEVICE_PLAYBACKDEVICE3
, iIndex
);
200 bool CCECProcessor::FindLogicalAddressAudioSystem(unsigned int iIndex
)
202 AddLog(CEC_LOG_DEBUG
, "detecting logical address for type 'audio'");
203 return TryLogicalAddress(CECDEVICE_AUDIOSYSTEM
, iIndex
);
206 bool CCECProcessor::FindLogicalAddresses(void)
209 m_logicalAddresses
.Clear();
212 for (unsigned int iPtr
= 0; iPtr
< 5; iPtr
++)
214 if (m_types
.types
[iPtr
] == CEC_DEVICE_TYPE_RESERVED
)
217 strLog
.Format("%s - device %d: type %d", __FUNCTION__
, iPtr
, m_types
.types
[iPtr
]);
218 AddLog(CEC_LOG_DEBUG
, strLog
);
220 if (m_types
.types
[iPtr
] == CEC_DEVICE_TYPE_RECORDING_DEVICE
)
221 bReturn
&= FindLogicalAddressRecordingDevice(iPtr
);
222 if (m_types
.types
[iPtr
] == CEC_DEVICE_TYPE_TUNER
)
223 bReturn
&= FindLogicalAddressTuner(iPtr
);
224 if (m_types
.types
[iPtr
] == CEC_DEVICE_TYPE_PLAYBACK_DEVICE
)
225 bReturn
&= FindLogicalAddressPlaybackDevice(iPtr
);
226 if (m_types
.types
[iPtr
] == CEC_DEVICE_TYPE_AUDIO_SYSTEM
)
227 bReturn
&= FindLogicalAddressAudioSystem(iPtr
);
233 void *CCECProcessor::Process(void)
235 bool bParseFrame(false);
237 CCECAdapterMessage msg
;
240 if (m_logicalAddresses
.IsEmpty() && !FindLogicalAddresses())
242 CLockObject
lock(&m_mutex
);
243 m_controller
->AddLog(CEC_LOG_ERROR
, "could not detect our logical addressed");
244 m_startCondition
.Signal();
248 SetAckMask(m_logicalAddresses
.AckMask());
251 CLockObject
lock(&m_mutex
);
252 m_controller
->AddLog(CEC_LOG_DEBUG
, "processor thread started");
254 m_startCondition
.Signal();
264 CLockObject
lock(&m_mutex
);
265 if (m_commandBuffer
.Pop(command
))
269 else if (m_communication
->IsOpen() && m_communication
->Read(msg
, 50))
271 m_controller
->AddLog(msg
.is_error() ? CEC_LOG_WARNING
: CEC_LOG_DEBUG
, msg
.ToString());
272 if ((bParseFrame
= (ParseMessage(msg
) && !IsStopped())) == true)
273 command
= m_currentframe
;
278 ParseCommand(command
);
283 m_controller
->CheckKeypressTimeout();
285 for (unsigned int iDevicePtr
= 0; iDevicePtr
< 16; iDevicePtr
++)
286 m_busDevices
[iDevicePtr
]->PollVendorId();
294 bool CCECProcessor::SetActiveSource(cec_device_type type
/* = CEC_DEVICE_TYPE_RESERVED */)
301 cec_logical_address addr
= m_logicalAddresses
.primary
;
303 if (type
!= CEC_DEVICE_TYPE_RESERVED
)
305 for (uint8_t iPtr
= 0; iPtr
< 16; iPtr
++)
307 if (m_logicalAddresses
[iPtr
] && m_busDevices
[iPtr
]->m_type
== type
)
309 addr
= (cec_logical_address
) iPtr
;
315 return SetStreamPath(m_busDevices
[addr
]->GetPhysicalAddress()) &&
316 m_busDevices
[addr
]->TransmitActiveSource();
319 bool CCECProcessor::SetActiveView(void)
321 return SetActiveSource(m_types
.IsEmpty() ? CEC_DEVICE_TYPE_RESERVED
: m_types
[0]);
324 bool CCECProcessor::SetDeckControlMode(cec_deck_control_mode mode
, bool bSendUpdate
/* = true */)
328 CCECBusDevice
*device
= GetDeviceByType(CEC_DEVICE_TYPE_PLAYBACK_DEVICE
);
331 ((CCECPlaybackDevice
*) device
)->SetDeckControlMode(mode
);
333 ((CCECPlaybackDevice
*) device
)->TransmitDeckStatus(CECDEVICE_TV
);
340 bool CCECProcessor::SetDeckInfo(cec_deck_info info
, bool bSendUpdate
/* = true */)
344 CCECBusDevice
*device
= GetDeviceByType(CEC_DEVICE_TYPE_PLAYBACK_DEVICE
);
347 ((CCECPlaybackDevice
*) device
)->SetDeckStatus(info
);
349 ((CCECPlaybackDevice
*) device
)->TransmitDeckStatus(CECDEVICE_TV
);
356 bool CCECProcessor::SetStreamPath(uint16_t iStreamPath
)
360 CCECBusDevice
*device
= GetDeviceByPhysicalAddress(iStreamPath
);
363 device
->SetActiveDevice();
370 bool CCECProcessor::SetInactiveView(void)
375 if (!m_logicalAddresses
.IsEmpty() && m_busDevices
[m_logicalAddresses
.primary
])
376 return m_busDevices
[m_logicalAddresses
.primary
]->TransmitInactiveView();
380 void CCECProcessor::LogOutput(const cec_command
&data
)
383 strTx
.Format("<< %02x", ((uint8_t)data
.initiator
<< 4) + (uint8_t)data
.destination
);
385 strTx
.AppendFormat(":%02x", (uint8_t)data
.opcode
);
387 for (uint8_t iPtr
= 0; iPtr
< data
.parameters
.size
; iPtr
++)
388 strTx
.AppendFormat(":%02x", data
.parameters
[iPtr
]);
389 m_controller
->AddLog(CEC_LOG_TRAFFIC
, strTx
.c_str());
392 bool CCECProcessor::SetLogicalAddress(cec_logical_address iLogicalAddress
)
394 if (m_logicalAddresses
.primary
!= iLogicalAddress
)
397 strLog
.Format("<< setting primary logical address to %1x", iLogicalAddress
);
398 m_controller
->AddLog(CEC_LOG_NOTICE
, strLog
.c_str());
399 m_logicalAddresses
.primary
= iLogicalAddress
;
400 m_logicalAddresses
.Set(iLogicalAddress
);
401 return SetAckMask(m_logicalAddresses
.AckMask());
407 bool CCECProcessor::SetMenuState(cec_menu_state state
, bool bSendUpdate
/* = true */)
409 for (uint8_t iPtr
= 0; iPtr
< 16; iPtr
++)
411 if (m_logicalAddresses
[iPtr
])
412 m_busDevices
[iPtr
]->SetMenuState(state
);
416 m_busDevices
[m_logicalAddresses
.primary
]->TransmitMenuState(CECDEVICE_TV
);
421 bool CCECProcessor::SetPhysicalAddress(uint16_t iPhysicalAddress
)
423 if (!m_logicalAddresses
.IsEmpty() && m_busDevices
[m_logicalAddresses
.primary
])
425 m_busDevices
[m_logicalAddresses
.primary
]->SetPhysicalAddress(iPhysicalAddress
);
426 return SetActiveView();
431 bool CCECProcessor::SwitchMonitoring(bool bEnable
)
434 strLog
.Format("== %s monitoring mode ==", bEnable
? "enabling" : "disabling");
435 m_controller
->AddLog(CEC_LOG_NOTICE
, strLog
.c_str());
437 m_bMonitor
= bEnable
;
439 return SetAckMask(0);
441 return SetAckMask(m_logicalAddresses
.AckMask());
444 bool CCECProcessor::PollDevice(cec_logical_address iAddress
)
446 if (iAddress
!= CECDEVICE_UNKNOWN
&& m_busDevices
[iAddress
])
447 return m_busDevices
[m_logicalAddresses
.primary
]->TransmitPoll(iAddress
);
451 CCECBusDevice
*CCECProcessor::GetDeviceByPhysicalAddress(uint16_t iPhysicalAddress
) const
453 CCECBusDevice
*device
= NULL
;
455 for (unsigned int iPtr
= 0; iPtr
< 16; iPtr
++)
457 if (m_busDevices
[iPtr
]->GetPhysicalAddress() == iPhysicalAddress
)
459 device
= m_busDevices
[iPtr
];
467 CCECBusDevice
*CCECProcessor::GetDeviceByType(cec_device_type type
) const
469 CCECBusDevice
*device
= NULL
;
471 for (unsigned int iPtr
= 0; iPtr
< 16; iPtr
++)
473 if (m_busDevices
[iPtr
]->m_type
== type
)
475 device
= m_busDevices
[iPtr
];
483 cec_version
CCECProcessor::GetDeviceCecVersion(cec_logical_address iAddress
)
485 return m_busDevices
[iAddress
]->GetCecVersion();
488 bool CCECProcessor::GetDeviceMenuLanguage(cec_logical_address iAddress
, cec_menu_language
*language
)
490 if (m_busDevices
[iAddress
])
492 *language
= m_busDevices
[iAddress
]->GetMenuLanguage();
493 return (strcmp(language
->language
, "???") != 0);
498 uint64_t CCECProcessor::GetDeviceVendorId(cec_logical_address iAddress
)
500 if (m_busDevices
[iAddress
])
501 return m_busDevices
[iAddress
]->GetVendorId();
505 cec_power_status
CCECProcessor::GetDevicePowerStatus(cec_logical_address iAddress
)
507 if (m_busDevices
[iAddress
])
508 return m_busDevices
[iAddress
]->GetPowerStatus();
509 return CEC_POWER_STATUS_UNKNOWN
;
512 bool CCECProcessor::Transmit(const cec_command
&data
)
517 CCECAdapterMessage
*output
= new CCECAdapterMessage(data
);
518 bReturn
= Transmit(output
);
524 bool CCECProcessor::Transmit(CCECAdapterMessage
*output
)
527 CLockObject
lock(&m_mutex
);
529 CLockObject
msgLock(&output
->mutex
);
530 if (!m_communication
|| !m_communication
->Write(output
))
534 output
->condition
.Wait(&output
->mutex
);
535 if (output
->state
!= ADAPTER_MESSAGE_STATE_SENT
)
537 m_controller
->AddLog(CEC_LOG_ERROR
, "command was not sent");
542 if (output
->transmit_timeout
> 0)
544 if ((bReturn
= WaitForTransmitSucceeded(output
->size(), output
->transmit_timeout
)) == false)
545 m_controller
->AddLog(CEC_LOG_DEBUG
, "did not receive ack");
554 void CCECProcessor::TransmitAbort(cec_logical_address address
, cec_opcode opcode
, cec_abort_reason reason
/* = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE */)
556 m_controller
->AddLog(CEC_LOG_DEBUG
, "<< transmitting abort message");
560 cec_command::Format(command
, m_logicalAddresses
.primary
, address
, CEC_OPCODE_FEATURE_ABORT
);
561 command
.parameters
.PushBack((uint8_t)opcode
);
562 command
.parameters
.PushBack((uint8_t)reason
);
567 bool CCECProcessor::WaitForTransmitSucceeded(uint8_t iLength
, uint32_t iTimeout
/* = 1000 */)
570 bool bTransmitSucceeded(false);
571 uint8_t iPacketsLeft(iLength
/ 4);
573 int64_t iNow
= GetTimeMs();
574 int64_t iTargetTime
= iNow
+ (uint64_t) iTimeout
;
576 while (!bTransmitSucceeded
&& !bError
&& (iTimeout
== 0 || iNow
< iTargetTime
))
578 CCECAdapterMessage msg
;
580 if (!m_communication
->Read(msg
, iTimeout
> 0 ? (int32_t)(iTargetTime
- iNow
) : 1000))
586 if ((bError
= msg
.is_error()) == false)
588 m_controller
->AddLog(bError
? CEC_LOG_WARNING
: CEC_LOG_DEBUG
, msg
.ToString());
590 switch(msg
.message())
592 case MSGCODE_COMMAND_ACCEPTED
:
593 if (iPacketsLeft
> 0)
596 case MSGCODE_TRANSMIT_SUCCEEDED
:
597 bTransmitSucceeded
= (iPacketsLeft
== 0);
598 bError
= !bTransmitSucceeded
;
601 if (ParseMessage(msg
))
602 m_commandBuffer
.Push(m_currentframe
);
609 return bTransmitSucceeded
&& !bError
;
612 bool CCECProcessor::ParseMessage(const CCECAdapterMessage
&msg
)
619 switch(msg
.message())
621 case MSGCODE_FRAME_START
:
623 m_currentframe
.Clear();
626 m_currentframe
.initiator
= msg
.initiator();
627 m_currentframe
.destination
= msg
.destination();
628 m_currentframe
.ack
= msg
.ack();
629 m_currentframe
.eom
= msg
.eom();
633 case MSGCODE_FRAME_DATA
:
637 m_currentframe
.PushBack(msg
[1]);
638 m_currentframe
.eom
= msg
.eom();
650 void CCECProcessor::ParseCommand(cec_command
&command
)
653 dataStr
.Format(">> %1x%1x:%02x", command
.initiator
, command
.destination
, command
.opcode
);
654 for (uint8_t iPtr
= 0; iPtr
< command
.parameters
.size
; iPtr
++)
655 dataStr
.AppendFormat(":%02x", (unsigned int)command
.parameters
[iPtr
]);
656 m_controller
->AddLog(CEC_LOG_TRAFFIC
, dataStr
.c_str());
658 if (!m_bMonitor
&& command
.initiator
>= CECDEVICE_TV
&& command
.initiator
<= CECDEVICE_BROADCAST
)
659 m_busDevices
[(uint8_t)command
.initiator
]->HandleCommand(command
);
662 uint16_t CCECProcessor::GetPhysicalAddress(void) const
664 if (!m_logicalAddresses
.IsEmpty() && m_busDevices
[m_logicalAddresses
.primary
])
665 return m_busDevices
[m_logicalAddresses
.primary
]->GetPhysicalAddress();
669 void CCECProcessor::SetCurrentButton(cec_user_control_code iButtonCode
)
671 m_controller
->SetCurrentButton(iButtonCode
);
674 void CCECProcessor::AddCommand(const cec_command
&command
)
676 m_controller
->AddCommand(command
);
679 void CCECProcessor::AddKey(cec_keypress
&key
)
681 m_controller
->AddKey(key
);
684 void CCECProcessor::AddKey(void)
686 m_controller
->AddKey();
689 void CCECProcessor::AddLog(cec_log_level level
, const CStdString
&strMessage
)
691 m_controller
->AddLog(level
, strMessage
);
694 bool CCECProcessor::SetAckMask(uint16_t iMask
)
698 strLog
.Format("setting ackmask to %2x", iMask
);
699 m_controller
->AddLog(CEC_LOG_DEBUG
, strLog
.c_str());
701 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
703 output
->push_back(MSGSTART
);
704 output
->push_escaped(MSGCODE_SET_ACK_MASK
);
705 output
->push_escaped(iMask
>> 8);
706 output
->push_escaped((uint8_t)iMask
);
707 output
->push_back(MSGEND
);
709 if ((bReturn
= Transmit(output
)) == false)
710 m_controller
->AddLog(CEC_LOG_ERROR
, "could not set the ackmask");