src/lib/CECProcessor.cpp

   1 /*
   2  * This file is part of the libCEC(R) library.
   3  *
   4  * libCEC(R) is Copyright (C) 2011-2012 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 "CECProcessor.h"
  34
  35 #include "adapter/USBCECAdapterCommunication.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"
  43 #include "LibCEC.h"
  44 #include "CECClient.h"
  45 #include "CECTypeUtils.h"
  46 #include "platform/util/timeutils.h"
  47 #include "platform/util/util.h"
  48
  49 using namespace CEC;
  50 using namespace std;
  51 using namespace PLATFORM;
  52
  53 #define CEC_PROCESSOR_SIGNAL_WAIT_TIME 1000
  54 #define ACTIVE_SOURCE_CHECK_TIMEOUT    10000
  55
  56 #define ToString(x) CCECTypeUtils::ToString(x)
  57
  58 CCECProcessor::CCECProcessor(CLibCEC *libcec) :
  59     m_bInitialised(false),
  60     m_communication(NULL),
  61     m_libcec(libcec),
  62     m_iStandardLineTimeout(3),
  63     m_iRetryLineTimeout(3),
  64     m_iLastTransmission(0)
  65 {
  66   m_busDevices = new CCECDeviceMap(this);
  67 }
  68
  69 CCECProcessor::~CCECProcessor(void)
  70 {
  71   Close();
  72   DELETE_AND_NULL(m_busDevices);
  73 }
  74
  75 bool CCECProcessor::Start(const char *strPort, uint16_t iBaudRate /* = CEC_SERIAL_DEFAULT_BAUDRATE */, uint32_t iTimeoutMs /* = CEC_DEFAULT_CONNECT_TIMEOUT */)
  76 {
  77   CLockObject lock(m_mutex);
  78   // open a connection
  79   if (!OpenConnection(strPort, iBaudRate, iTimeoutMs))
  80     return false;
  81
  82   // create the processor thread
  83   if (!IsRunning())
  84   {
  85     if (!CreateThread())
  86     {
  87       m_libcec->AddLog(CEC_LOG_ERROR, "could not create a processor thread");
  88       return false;
  89     }
  90   }
  91
  92   return true;
  93 }
  94
  95 void CCECProcessor::Close(void)
  96 {
  97   // mark as uninitialised
  98   SetCECInitialised(false);
  99
 100   // stop the processor
 101   StopThread();
 102
 103   // close the connection
 104   DELETE_AND_NULL(m_communication);
 105 }
 106
 107 void CCECProcessor::ResetMembers(void)
 108 {
 109   // close the connection
 110   DELETE_AND_NULL(m_communication);
 111
 112   // reset the other members to the initial state
 113   m_iStandardLineTimeout = 3;
 114   m_iRetryLineTimeout = 3;
 115   m_iLastTransmission = 0;
 116   m_busDevices->ResetDeviceStatus();
 117 }
 118
 119 bool CCECProcessor::OpenConnection(const char *strPort, uint16_t iBaudRate, uint32_t iTimeoutMs, bool bStartListening /* = true */)
 120 {
 121   bool bReturn(false);
 122   CTimeout timeout(iTimeoutMs > 0 ? iTimeoutMs : CEC_DEFAULT_TRANSMIT_WAIT);
 123
 124   // ensure that a previous connection is closed
 125   Close();
 126
 127   // reset all member to the initial state
 128   ResetMembers();
 129
 130   // check whether the Close() method deleted any previous connection
 131   if (m_communication)
 132   {
 133     m_libcec->AddLog(CEC_LOG_ERROR, "previous connection could not be closed");
 134     return bReturn;
 135   }
 136
 137   // create a new connection
 138   m_communication = new CUSBCECAdapterCommunication(this, strPort, iBaudRate);
 139
 140   // open a new connection
 141   unsigned iConnectTry(0);
 142   while (timeout.TimeLeft() > 0 && (bReturn = m_communication->Open((timeout.TimeLeft() / CEC_CONNECT_TRIES), false, bStartListening)) == false)
 143   {
 144     m_libcec->AddLog(CEC_LOG_ERROR, "could not open a connection (try %d)", ++iConnectTry);
 145     m_communication->Close();
 146     CEvent::Sleep(CEC_DEFAULT_CONNECT_RETRY_WAIT);
 147   }
 148
 149   m_libcec->AddLog(CEC_LOG_NOTICE, "connection opened");
 150
 151   // always start by setting the ackmask to 0, to clear previous values
 152   SetAckMask(0);
 153
 154   // mark as initialised
 155   SetCECInitialised(true);
 156
 157   return bReturn;
 158 }
 159
 160 bool CCECProcessor::CECInitialised(void)
 161 {
 162   CLockObject lock(m_threadMutex);
 163   return m_bInitialised;
 164 }
 165
 166 void CCECProcessor::SetCECInitialised(bool bSetTo /* = true */)
 167 {
 168   {
 169     CLockObject lock(m_mutex);
 170     m_bInitialised = bSetTo;
 171   }
 172   if (!bSetTo)
 173     UnregisterClients();
 174 }
 175
 176 bool CCECProcessor::TryLogicalAddress(cec_logical_address address)
 177 {
 178   // find the device
 179   CCECBusDevice *device = m_busDevices->At(address);
 180   if (device)
 181   {
 182     // check if it's already marked as present or used
 183     if (device->IsPresent() || device->IsHandledByLibCEC())
 184       return false;
 185
 186     // poll the LA if not
 187     SetAckMask(0);
 188     return device->TryLogicalAddress();
 189   }
 190
 191   return false;
 192 }
 193
 194 void CCECProcessor::ReplaceHandlers(void)
 195 {
 196   if (!CECInitialised())
 197     return;
 198
 199   // check each device
 200   for (CECDEVICEMAP::iterator it = m_busDevices->Begin(); it != m_busDevices->End(); it++)
 201     it->second->ReplaceHandler(true);
 202 }
 203
 204 void CCECProcessor::CheckPendingActiveSource(void)
 205 {
 206   if (!CECInitialised())
 207     return;
 208
 209   // check each device
 210   for (CECDEVICEMAP::iterator it = m_busDevices->Begin(); it != m_busDevices->End(); it++)
 211   {
 212     if (it->second->GetHandler()->ActiveSourcePending())
 213       it->second->ActivateSource();
 214   }
 215 }
 216
 217 bool CCECProcessor::OnCommandReceived(const cec_command &command)
 218 {
 219   return m_inBuffer.Push(command);
 220 }
 221
 222 void *CCECProcessor::Process(void)
 223 {
 224   m_libcec->AddLog(CEC_LOG_DEBUG, "processor thread started");
 225
 226   cec_command command;
 227   CTimeout activeSourceCheck(ACTIVE_SOURCE_CHECK_TIMEOUT);
 228
 229   // as long as we're not being stopped and the connection is open
 230   while (!IsStopped() && m_communication->IsOpen())
 231   {
 232     // wait for a new incoming command, and process it
 233     if (m_inBuffer.Pop(command, CEC_PROCESSOR_SIGNAL_WAIT_TIME))
 234       ProcessCommand(command);
 235
 236     if (CECInitialised())
 237     {
 238       // check clients for keypress timeouts
 239       m_libcec->CheckKeypressTimeout();
 240
 241       // check if we need to replace handlers
 242       ReplaceHandlers();
 243
 244       // check whether we need to activate a source, if it failed before
 245       if (activeSourceCheck.TimeLeft() == 0)
 246       {
 247         CheckPendingActiveSource();
 248         activeSourceCheck.Init(ACTIVE_SOURCE_CHECK_TIMEOUT);
 249       }
 250     }
 251   }
 252
 253   return NULL;
 254 }
 255
 256 bool CCECProcessor::ActivateSource(uint16_t iStreamPath)
 257 {
 258   bool bReturn(false);
 259
 260   // find the device with the given PA
 261   CCECBusDevice *device = GetDeviceByPhysicalAddress(iStreamPath);
 262   // and make it the active source when found
 263   if (device)
 264     bReturn = device->ActivateSource();
 265   else
 266     m_libcec->AddLog(CEC_LOG_DEBUG, "device with PA '%04x' not found", iStreamPath);
 267
 268   return bReturn;
 269 }
 270
 271 void CCECProcessor::SetStandardLineTimeout(uint8_t iTimeout)
 272 {
 273   CLockObject lock(m_mutex);
 274   m_iStandardLineTimeout = iTimeout;
 275 }
 276
 277 uint8_t CCECProcessor::GetStandardLineTimeout(void)
 278 {
 279   CLockObject lock(m_mutex);
 280   return m_iStandardLineTimeout;
 281 }
 282
 283 void CCECProcessor::SetRetryLineTimeout(uint8_t iTimeout)
 284 {
 285   CLockObject lock(m_mutex);
 286   m_iRetryLineTimeout = iTimeout;
 287 }
 288
 289 uint8_t CCECProcessor::GetRetryLineTimeout(void)
 290 {
 291   CLockObject lock(m_mutex);
 292   return m_iRetryLineTimeout;
 293 }
 294
 295 bool CCECProcessor::PhysicalAddressInUse(uint16_t iPhysicalAddress)
 296 {
 297   CCECBusDevice *device = GetDeviceByPhysicalAddress(iPhysicalAddress);
 298   return device != NULL;
 299 }
 300
 301 void CCECProcessor::LogOutput(const cec_command &data)
 302 {
 303   CStdString strTx;
 304
 305   // initiator and destination
 306   strTx.Format("<< %02x", ((uint8_t)data.initiator << 4) + (uint8_t)data.destination);
 307
 308   // append the opcode
 309   if (data.opcode_set)
 310       strTx.AppendFormat(":%02x", (uint8_t)data.opcode);
 311
 312   // append the parameters
 313   for (uint8_t iPtr = 0; iPtr < data.parameters.size; iPtr++)
 314     strTx.AppendFormat(":%02x", data.parameters[iPtr]);
 315
 316   // and log it
 317   m_libcec->AddLog(CEC_LOG_TRAFFIC, strTx.c_str());
 318 }
 319
 320 bool CCECProcessor::PollDevice(cec_logical_address iAddress)
 321 {
 322   // try to find the primary device
 323   CCECBusDevice *primary = GetPrimaryDevice();
 324   // poll the destination, with the primary as source
 325   if (primary)
 326     return primary->TransmitPoll(iAddress);
 327
 328   // try to find the destination
 329   CCECBusDevice *device = m_busDevices->At(iAddress);
 330   // and poll the destination, with the same LA as source
 331   if (device)
 332     return device->TransmitPoll(iAddress);
 333
 334   return false;
 335 }
 336
 337 CCECBusDevice *CCECProcessor::GetDeviceByPhysicalAddress(uint16_t iPhysicalAddress, bool bSuppressUpdate /* = true */)
 338 {
 339   return m_busDevices ?
 340       m_busDevices->GetDeviceByPhysicalAddress(iPhysicalAddress, bSuppressUpdate) :
 341       NULL;
 342 }
 343
 344 CCECBusDevice *CCECProcessor::GetDevice(cec_logical_address address) const
 345 {
 346   return m_busDevices ?
 347       m_busDevices->At(address) :
 348       NULL;
 349 }
 350
 351 cec_logical_address CCECProcessor::GetActiveSource(bool bRequestActiveSource /* = true */)
 352 {
 353   // get the device that is marked as active source from the device map
 354   CCECBusDevice *activeSource = m_busDevices->GetActiveSource();
 355   if (activeSource)
 356     return activeSource->GetLogicalAddress();
 357
 358   if (bRequestActiveSource)
 359   {
 360     // request the active source from the bus
 361     CCECBusDevice *primary = GetPrimaryDevice();
 362     if (primary)
 363     {
 364       primary->RequestActiveSource();
 365       return GetActiveSource(false);
 366     }
 367   }
 368
 369   // unknown or none
 370   return CECDEVICE_UNKNOWN;
 371 }
 372
 373 bool CCECProcessor::IsActiveSource(cec_logical_address iAddress)
 374 {
 375   CCECBusDevice *device = m_busDevices->At(iAddress);
 376   return device && device->IsActiveSource();
 377 }
 378
 379 bool CCECProcessor::Transmit(const cec_command &data)
 380 {
 381   uint8_t iMaxTries(0);
 382   bool bRetry(true);
 383   uint8_t iTries(0);
 384
 385   // get the current timeout setting
 386   uint8_t iLineTimeout(GetStandardLineTimeout());
 387
 388   // reset the state of this message to 'unknown'
 389   cec_adapter_message_state adapterState = ADAPTER_MESSAGE_STATE_UNKNOWN;
 390
 391   LogOutput(data);
 392
 393   // find the initiator device
 394   CCECBusDevice *initiator = m_busDevices->At(data.initiator);
 395   if (!initiator)
 396   {
 397     m_libcec->AddLog(CEC_LOG_WARNING, "invalid initiator");
 398     return false;
 399   }
 400
 401   // find the destination device, if it's not the broadcast address
 402   if (data.destination != CECDEVICE_BROADCAST)
 403   {
 404     // check if the device is marked as handled by libCEC
 405     CCECBusDevice *destination = m_busDevices->At(data.destination);
 406     if (destination && destination->IsHandledByLibCEC())
 407     {
 408       // and reject the command if it's trying to send data to a device that is handled by libCEC
 409       m_libcec->AddLog(CEC_LOG_WARNING, "not sending data to myself!");
 410       return false;
 411     }
 412   }
 413
 414   {
 415     CLockObject lock(m_mutex);
 416     m_iLastTransmission = GetTimeMs();
 417     // set the number of tries
 418     iMaxTries = initiator->GetHandler()->GetTransmitRetries() + 1;
 419   }
 420
 421   // and try to send the command
 422   while (bRetry && ++iTries < iMaxTries)
 423   {
 424     if (initiator->IsUnsupportedFeature(data.opcode))
 425       return false;
 426
 427     adapterState = !IsStopped() && m_communication && m_communication->IsOpen() ?
 428         m_communication->Write(data, bRetry, iLineTimeout) :
 429         ADAPTER_MESSAGE_STATE_ERROR;
 430     iLineTimeout = m_iRetryLineTimeout;
 431   }
 432
 433   return adapterState == ADAPTER_MESSAGE_STATE_SENT_ACKED;
 434 }
 435
 436 void CCECProcessor::TransmitAbort(cec_logical_address source, cec_logical_address destination, cec_opcode opcode, cec_abort_reason reason /* = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE */)
 437 {
 438   m_libcec->AddLog(CEC_LOG_DEBUG, "<< transmitting abort message");
 439
 440   cec_command command;
 441   cec_command::Format(command, source, destination, CEC_OPCODE_FEATURE_ABORT);
 442   command.parameters.PushBack((uint8_t)opcode);
 443   command.parameters.PushBack((uint8_t)reason);
 444
 445   Transmit(command);
 446 }
 447
 448 void CCECProcessor::ProcessCommand(const cec_command &command)
 449 {
 450   // log the command
 451   CStdString dataStr;
 452   dataStr.Format(">> %1x%1x", command.initiator, command.destination);
 453   if (command.opcode_set == 1)
 454     dataStr.AppendFormat(":%02x", command.opcode);
 455   for (uint8_t iPtr = 0; iPtr < command.parameters.size; iPtr++)
 456     dataStr.AppendFormat(":%02x", (unsigned int)command.parameters[iPtr]);
 457   m_libcec->AddLog(CEC_LOG_TRAFFIC, dataStr.c_str());
 458
 459   // find the initiator
 460   CCECBusDevice *device = m_busDevices->At(command.initiator);
 461
 462   if (device)
 463     device->HandleCommand(command);
 464 }
 465
 466 bool CCECProcessor::IsPresentDevice(cec_logical_address address)
 467 {
 468   CCECBusDevice *device = m_busDevices->At(address);
 469   return device && device->GetStatus() == CEC_DEVICE_STATUS_PRESENT;
 470 }
 471
 472 bool CCECProcessor::IsPresentDeviceType(cec_device_type type)
 473 {
 474   CECDEVICEVEC devices;
 475   m_busDevices->GetByType(type, devices);
 476   CCECDeviceMap::FilterActive(devices);
 477   return !devices.empty();
 478 }
 479
 480 uint16_t CCECProcessor::GetDetectedPhysicalAddress(void) const
 481 {
 482   return m_communication ? m_communication->GetPhysicalAddress() : CEC_INVALID_PHYSICAL_ADDRESS;
 483 }
 484
 485 bool CCECProcessor::SetAckMask(uint16_t iMask)
 486 {
 487   return m_communication ? m_communication->SetAckMask(iMask) : false;
 488 }
 489
 490 bool CCECProcessor::StandbyDevices(const cec_logical_address initiator, const CECDEVICEVEC &devices)
 491 {
 492   bool bReturn(true);
 493   for (CECDEVICEVEC::const_iterator it = devices.begin(); it != devices.end(); it++)
 494     bReturn &= (*it)->Standby(initiator);
 495   return bReturn;
 496 }
 497
 498 bool CCECProcessor::StandbyDevice(const cec_logical_address initiator, cec_logical_address address)
 499 {
 500   CCECBusDevice *device = m_busDevices->At(address);
 501   return device ? device->Standby(initiator) : false;
 502 }
 503
 504 bool CCECProcessor::PowerOnDevices(const cec_logical_address initiator, const CECDEVICEVEC &devices)
 505 {
 506   bool bReturn(true);
 507   for (CECDEVICEVEC::const_iterator it = devices.begin(); it != devices.end(); it++)
 508     bReturn &= (*it)->PowerOn(initiator);
 509   return bReturn;
 510 }
 511
 512 bool CCECProcessor::PowerOnDevice(const cec_logical_address initiator, cec_logical_address address)
 513 {
 514   CCECBusDevice *device = m_busDevices->At(address);
 515   return device ? device->PowerOn(initiator) : false;
 516 }
 517
 518 bool CCECProcessor::StartBootloader(const char *strPort /* = NULL */)
 519 {
 520   bool bReturn(false);
 521   // open a connection if no connection has been opened
 522   if (!m_communication && strPort)
 523   {
 524     IAdapterCommunication *comm = new CUSBCECAdapterCommunication(this, strPort);
 525     CTimeout timeout(CEC_DEFAULT_CONNECT_TIMEOUT);
 526     int iConnectTry(0);
 527     while (timeout.TimeLeft() > 0 && (bReturn = comm->Open(timeout.TimeLeft() / CEC_CONNECT_TRIES, true)) == false)
 528     {
 529       m_libcec->AddLog(CEC_LOG_ERROR, "could not open a connection (try %d)", ++iConnectTry);
 530       comm->Close();
 531       Sleep(CEC_DEFAULT_TRANSMIT_RETRY_WAIT);
 532     }
 533     if (comm->IsOpen())
 534     {
 535       bReturn = comm->StartBootloader();
 536       DELETE_AND_NULL(comm);
 537     }
 538     return bReturn;
 539   }
 540   else
 541   {
 542     m_communication->StartBootloader();
 543     Close();
 544     bReturn = true;
 545   }
 546
 547   return bReturn;
 548 }
 549
 550 bool CCECProcessor::PingAdapter(void)
 551 {
 552   return m_communication->PingAdapter();
 553 }
 554
 555 void CCECProcessor::HandlePoll(cec_logical_address initiator, cec_logical_address destination)
 556 {
 557   CCECBusDevice *device = m_busDevices->At(destination);
 558   if (device)
 559     device->HandlePollFrom(initiator);
 560 }
 561
 562 bool CCECProcessor::HandleReceiveFailed(cec_logical_address initiator)
 563 {
 564   CCECBusDevice *device = m_busDevices->At(initiator);
 565   return !device || !device->HandleReceiveFailed();
 566 }
 567
 568 bool CCECProcessor::SetStreamPath(uint16_t iPhysicalAddress)
 569 {
 570   // stream path changes are sent by the TV
 571   return GetTV()->GetHandler()->TransmitSetStreamPath(iPhysicalAddress);
 572 }
 573
 574 bool CCECProcessor::CanPersistConfiguration(void)
 575 {
 576   return m_communication ? m_communication->GetFirmwareVersion() >= 2 : false;
 577 }
 578
 579 bool CCECProcessor::PersistConfiguration(const libcec_configuration &configuration)
 580 {
 581   return m_communication ? m_communication->PersistConfiguration(configuration) : false;
 582 }
 583
 584 void CCECProcessor::RescanActiveDevices(void)
 585 {
 586   for (CECDEVICEMAP::iterator it = m_busDevices->Begin(); it != m_busDevices->End(); it++)
 587     it->second->GetStatus(true);
 588 }
 589
 590 bool CCECProcessor::GetDeviceInformation(const char *strPort, libcec_configuration *config, uint32_t iTimeoutMs /* = CEC_DEFAULT_CONNECT_TIMEOUT */)
 591 {
 592   if (!OpenConnection(strPort, CEC_SERIAL_DEFAULT_BAUDRATE, iTimeoutMs, false))
 593     return false;
 594
 595   config->iFirmwareVersion   = m_communication->GetFirmwareVersion();
 596   config->iPhysicalAddress   = m_communication->GetPhysicalAddress();
 597   config->iFirmwareBuildDate = m_communication->GetFirmwareBuildDate();
 598
 599   return true;
 600 }
 601
 602 bool CCECProcessor::TransmitPendingActiveSourceCommands(void)
 603 {
 604   bool bReturn(true);
 605   for (CECDEVICEMAP::iterator it = m_busDevices->Begin(); it != m_busDevices->End(); it++)
 606     bReturn &= it->second->TransmitPendingActiveSourceCommands();
 607   return bReturn;
 608 }
 609
 610 CCECTV *CCECProcessor::GetTV(void) const
 611 {
 612   return CCECBusDevice::AsTV(m_busDevices->At(CECDEVICE_TV));
 613 }
 614
 615 CCECAudioSystem *CCECProcessor::GetAudioSystem(void) const
 616 {
 617   return CCECBusDevice::AsAudioSystem(m_busDevices->At(CECDEVICE_AUDIOSYSTEM));
 618 }
 619
 620 CCECPlaybackDevice *CCECProcessor::GetPlaybackDevice(cec_logical_address address) const
 621 {
 622   return CCECBusDevice::AsPlaybackDevice(m_busDevices->At(address));
 623 }
 624
 625 CCECRecordingDevice *CCECProcessor::GetRecordingDevice(cec_logical_address address) const
 626 {
 627   return CCECBusDevice::AsRecordingDevice(m_busDevices->At(address));
 628 }
 629
 630 CCECTuner *CCECProcessor::GetTuner(cec_logical_address address) const
 631 {
 632   return CCECBusDevice::AsTuner(m_busDevices->At(address));
 633 }
 634
 635 bool CCECProcessor::RegisterClient(CCECClient *client)
 636 {
 637   if (!client)
 638     return false;
 639
 640   libcec_configuration &configuration = *client->GetConfiguration();
 641
 642   if (configuration.clientVersion >= CEC_CLIENT_VERSION_1_6_3 && configuration.bMonitorOnly == 1)
 643     return true;
 644
 645   if (!CECInitialised())
 646   {
 647     m_libcec->AddLog(CEC_LOG_ERROR, "failed to register a new CEC client: CEC processor is not initialised");
 648     return false;
 649   }
 650
 651   // unregister the client first if it's already been marked as registered
 652   if (client->IsRegistered())
 653     UnregisterClient(client);
 654
 655   // get the configuration from the client
 656   m_libcec->AddLog(CEC_LOG_NOTICE, "registering new CEC client - v%s", ToString((cec_client_version)configuration.clientVersion));
 657
 658   // mark as uninitialised and unregistered
 659   client->SetRegistered(false);
 660   client->SetInitialised(false);
 661
 662   // get the current ackmask, so we can restore it if polling fails
 663   uint16_t iPreviousMask(m_communication->GetAckMask());
 664
 665   // find logical addresses for this client
 666   if (!client->AllocateLogicalAddresses())
 667   {
 668     m_libcec->AddLog(CEC_LOG_ERROR, "failed to register the new CEC client - cannot allocate the requested device types");
 669     SetAckMask(iPreviousMask);
 670     return false;
 671   }
 672
 673   // register this client on the new addresses
 674   CECDEVICEVEC devices;
 675   m_busDevices->GetByLogicalAddresses(devices, configuration.logicalAddresses);
 676   for (CECDEVICEVEC::const_iterator it = devices.begin(); it != devices.end(); it++)
 677   {
 678     // replace a previous client
 679     CLockObject lock(m_mutex);
 680     m_clients.erase((*it)->GetLogicalAddress());
 681     m_clients.insert(make_pair<cec_logical_address, CCECClient *>((*it)->GetLogicalAddress(), client));
 682   }
 683
 684   // get the settings from the rom
 685   if (configuration.bGetSettingsFromROM == 1)
 686   {
 687     libcec_configuration config;
 688     m_communication->GetConfiguration(config);
 689
 690     CLockObject lock(m_mutex);
 691     if (!config.deviceTypes.IsEmpty())
 692       configuration.deviceTypes = config.deviceTypes;
 693     if (CLibCEC::IsValidPhysicalAddress(config.iPhysicalAddress))
 694       configuration.iPhysicalAddress = config.iPhysicalAddress;
 695     snprintf(configuration.strDeviceName, 13, "%s", config.strDeviceName);
 696   }
 697
 698   // set the firmware version and build date
 699   configuration.serverVersion      = LIBCEC_VERSION_CURRENT;
 700   configuration.iFirmwareVersion   = m_communication->GetFirmwareVersion();
 701   configuration.iFirmwareBuildDate = m_communication->GetFirmwareBuildDate();
 702
 703   // mark the client as registered
 704   client->SetRegistered(true);
 705
 706   // set the new ack mask
 707   bool bReturn = SetAckMask(GetLogicalAddresses().AckMask()) &&
 708       // and initialise the client
 709       client->OnRegister();
 710
 711   // log the new registration
 712   CStdString strLog;
 713   strLog.Format("%s: %s", bReturn ? "CEC client registered" : "failed to register the CEC client", client->GetConnectionInfo().c_str());
 714   m_libcec->AddLog(bReturn ? CEC_LOG_NOTICE : CEC_LOG_ERROR, strLog);
 715
 716   // display a warning if the firmware can be upgraded
 717   if (bReturn && !IsRunningLatestFirmware())
 718   {
 719     const char *strUpgradeMessage = "The firmware of this adapter can be upgraded. Please visit http://blog.pulse-eight.com/ for more information.";
 720     m_libcec->AddLog(CEC_LOG_WARNING, strUpgradeMessage);
 721     libcec_parameter param;
 722     param.paramData = (void*)strUpgradeMessage; param.paramType = CEC_PARAMETER_TYPE_STRING;
 723     client->Alert(CEC_ALERT_SERVICE_DEVICE, param);
 724   }
 725
 726   return bReturn;
 727 }
 728
 729 bool CCECProcessor::UnregisterClient(CCECClient *client)
 730 {
 731   if (!client)
 732     return false;
 733
 734   if (client->IsRegistered())
 735     m_libcec->AddLog(CEC_LOG_NOTICE, "unregistering client: %s", client->GetConnectionInfo().c_str());
 736
 737   // notify the client that it will be unregistered
 738   client->OnUnregister();
 739
 740   {
 741     CLockObject lock(m_mutex);
 742     // find all devices that match the LA's of this client
 743     CECDEVICEVEC devices;
 744     m_busDevices->GetByLogicalAddresses(devices, client->GetConfiguration()->logicalAddresses);
 745     for (CECDEVICEVEC::const_iterator it = devices.begin(); it != devices.end(); it++)
 746     {
 747       // find the client
 748       map<cec_logical_address, CCECClient *>::iterator entry = m_clients.find((*it)->GetLogicalAddress());
 749       // unregister the client
 750       if (entry != m_clients.end())
 751         m_clients.erase(entry);
 752
 753       // reset the device status
 754       (*it)->ResetDeviceStatus();
 755     }
 756   }
 757
 758   // set the new ackmask
 759   return SetAckMask(GetLogicalAddresses().AckMask());
 760 }
 761
 762 void CCECProcessor::UnregisterClients(void)
 763 {
 764   m_libcec->AddLog(CEC_LOG_NOTICE, "unregistering all CEC clients");
 765
 766   vector<CCECClient *> clients = m_libcec->GetClients();
 767   for (vector<CCECClient *>::iterator client = clients.begin(); client != clients.end(); client++)
 768     UnregisterClient(*client);
 769
 770   CLockObject lock(m_mutex);
 771   m_clients.clear();
 772 }
 773
 774 CCECClient *CCECProcessor::GetClient(const cec_logical_address address)
 775 {
 776   CLockObject lock(m_mutex);
 777   map<cec_logical_address, CCECClient *>::const_iterator client = m_clients.find(address);
 778   if (client != m_clients.end())
 779     return client->second;
 780   return NULL;
 781 }
 782
 783 CCECClient *CCECProcessor::GetPrimaryClient(void)
 784 {
 785   CLockObject lock(m_mutex);
 786   map<cec_logical_address, CCECClient *>::const_iterator client = m_clients.begin();
 787   if (client != m_clients.end())
 788     return client->second;
 789   return NULL;
 790 }
 791
 792 CCECBusDevice *CCECProcessor::GetPrimaryDevice(void)
 793 {
 794   return m_busDevices->At(GetLogicalAddress());
 795 }
 796
 797 cec_logical_address CCECProcessor::GetLogicalAddress(void)
 798 {
 799   cec_logical_addresses addresses = GetLogicalAddresses();
 800   return addresses.primary;
 801 }
 802
 803 cec_logical_addresses CCECProcessor::GetLogicalAddresses(void)
 804 {
 805   CLockObject lock(m_mutex);
 806   cec_logical_addresses addresses;
 807   addresses.Clear();
 808   for (map<cec_logical_address, CCECClient *>::const_iterator client = m_clients.begin(); client != m_clients.end(); client++)
 809     addresses.Set(client->first);
 810
 811   return addresses;
 812 }
 813
 814 bool CCECProcessor::IsHandledByLibCEC(const cec_logical_address address) const
 815 {
 816   CCECBusDevice *device = GetDevice(address);
 817   return device && device->IsHandledByLibCEC();
 818 }
 819
 820 bool CCECProcessor::IsRunningLatestFirmware(void)
 821 {
 822   return m_communication && m_communication->IsOpen() ?
 823       m_communication->IsRunningLatestFirmware() :
 824       true;
 825 }