src/lib/implementations/SLCommandHandler.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 "SLCommandHandler.h"
  34 #include "../devices/CECBusDevice.h"
  35 #include "../devices/CECPlaybackDevice.h"
  36 #include "../CECProcessor.h"
  37 #include "../LibCEC.h"
  38
  39 using namespace CEC;
  40 using namespace PLATFORM;
  41
  42 #define SL_COMMAND_UNKNOWN_01           0x01
  43 #define SL_COMMAND_UNKNOWN_02           0x02
  44 #define SL_COMMAND_UNKNOWN_03           0x05
  45
  46 #define SL_COMMAND_REQUEST_POWER_STATUS 0xa0
  47 #define SL_COMMAND_POWER_ON             0x03
  48 #define SL_COMMAND_CONNECT_REQUEST      0x04
  49 #define SL_COMMAND_SET_DEVICE_MODE      0x05
  50
  51 CSLCommandHandler::CSLCommandHandler(CCECBusDevice *busDevice) :
  52     CCECCommandHandler(busDevice),
  53     m_bSLEnabled(false),
  54     m_bActiveSourceSent(false)
  55 {
  56   m_vendorId = CEC_VENDOR_LG;
  57   CCECBusDevice *primary = m_processor->GetPrimaryDevice();
  58
  59   /* imitate LG devices */
  60   if (primary && m_busDevice->GetLogicalAddress() != primary->GetLogicalAddress())
  61   {
  62     primary->SetVendorId(CEC_VENDOR_LG);
  63     primary->ReplaceHandler(false);
  64   }
  65
  66   /* LG TVs don't always reply to CEC version requests, so just set it to 1.3a */
  67   if (m_busDevice->GetLogicalAddress() == CECDEVICE_TV)
  68     m_busDevice->SetCecVersion(CEC_VERSION_1_3A);
  69
  70   /* LG devices always return "korean" as language */
  71   cec_menu_language lang;
  72   lang.device = m_busDevice->GetLogicalAddress();
  73   snprintf(lang.language, 4, "eng");
  74   m_busDevice->SetMenuLanguage(lang);
  75 }
  76
  77 bool CSLCommandHandler::InitHandler(void)
  78 {
  79   if (m_bHandlerInited)
  80     return true;
  81   m_bHandlerInited = true;
  82
  83   if (m_busDevice->GetLogicalAddress() == CECDEVICE_TV)
  84   {
  85     CCECBusDevice *primary = m_processor->GetPrimaryDevice();
  86
  87     /* start as 'in transition standby->on' */
  88     primary->SetPowerStatus(CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON);
  89     primary->TransmitPowerState(CECDEVICE_TV);
  90
  91     /* send the vendor id */
  92     primary->TransmitVendorID(CECDEVICE_BROADCAST);
  93   }
  94
  95   return true;
  96 }
  97
  98 bool CSLCommandHandler::ActivateSource(void)
  99 {
 100   if (!SLInitialised())
 101   {
 102     CLibCEC::AddLog(CEC_LOG_NOTICE, "not activating the source until SL has been initialised");
 103     return true;
 104   }
 105
 106   {
 107     CLockObject lock(m_SLMutex);
 108     if (m_bActiveSourceSent)
 109       return true;
 110     m_bActiveSourceSent = true;
 111   }
 112
 113   CCECBusDevice *primary = m_processor->GetPrimaryDevice();
 114   primary->SetActiveSource();
 115   primary->TransmitActiveSource();
 116   return true;
 117 }
 118
 119 bool CSLCommandHandler::HandleActiveSource(const cec_command &command)
 120 {
 121   if (command.parameters.size == 2)
 122   {
 123     uint16_t iAddress = ((uint16_t)command.parameters[0] << 8) | ((uint16_t)command.parameters[1]);
 124     if (iAddress != m_busDevice->GetPhysicalAddress(false))
 125     {
 126       ResetSLState();
 127     }
 128     return m_processor->SetActiveSource(iAddress);
 129   }
 130
 131   return true;
 132 }
 133
 134 bool CSLCommandHandler::HandleDeviceVendorId(const cec_command &command)
 135 {
 136   SetVendorId(command);
 137
 138   if (!SLInitialised() && command.initiator == CECDEVICE_TV)
 139   {
 140     cec_command response;
 141     cec_command::Format(response, m_processor->GetLogicalAddress(), command.initiator, CEC_OPCODE_FEATURE_ABORT);
 142     return Transmit(response);
 143   }
 144   return true;
 145 }
 146
 147 bool CSLCommandHandler::HandleGivePhysicalAddress(const cec_command &command)
 148 {
 149   if (m_processor->IsRunning() && m_busDevice->MyLogicalAddressContains(command.destination))
 150   {
 151     CCECBusDevice *device = GetDevice(command.destination);
 152     if (device)
 153       return device->TransmitPhysicalAddress(); // only the physical address, don't send image view on
 154   }
 155
 156   return false;
 157 }
 158
 159 bool CSLCommandHandler::HandleVendorCommand(const cec_command &command)
 160 {
 161   if (command.parameters.size == 1 &&
 162       command.parameters[0] == SL_COMMAND_UNKNOWN_01)
 163   {
 164     HandleVendorCommand01(command);
 165     return true;
 166   }
 167   else if (command.parameters.size == 2 &&
 168       command.parameters[0] == SL_COMMAND_POWER_ON)
 169   {
 170     HandleVendorCommandPowerOn(command);
 171     return true;
 172   }
 173   else if (command.parameters.size == 2 &&
 174       command.parameters[0] == SL_COMMAND_CONNECT_REQUEST)
 175   {
 176     HandleVendorCommandSLConnect(command);
 177     return true;
 178   }
 179   else if (command.parameters.size == 1 &&
 180       command.parameters[0] == SL_COMMAND_REQUEST_POWER_STATUS)
 181   {
 182     HandleVendorCommandPowerOnStatus(command);
 183     return true;
 184   }
 185
 186   return false;
 187 }
 188
 189 void CSLCommandHandler::HandleVendorCommand01(const cec_command &command)
 190 {
 191   m_processor->GetPrimaryDevice()->SetPowerStatus(CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON);
 192   TransmitVendorCommand0205(command.destination, command.initiator);
 193 }
 194
 195 void CSLCommandHandler::TransmitVendorCommand0205(const cec_logical_address iSource, const cec_logical_address iDestination)
 196 {
 197   cec_command response;
 198   cec_command::Format(response, iSource, iDestination, CEC_OPCODE_VENDOR_COMMAND);
 199   response.PushBack(SL_COMMAND_UNKNOWN_02);
 200   response.PushBack(SL_COMMAND_UNKNOWN_03);
 201
 202   Transmit(response, false);
 203 }
 204
 205 void CSLCommandHandler::HandleVendorCommandPowerOn(const cec_command &command)
 206 {
 207   if (command.initiator != CECDEVICE_TV)
 208     return;
 209
 210   CCECBusDevice *device = m_processor->GetPrimaryDevice();
 211   if (device)
 212   {
 213     SetSLInitialised();
 214
 215     device->SetPowerStatus(CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON); //XXX
 216     device->TransmitPowerState(command.initiator);
 217     device->SetPowerStatus(CEC_POWER_STATUS_ON);
 218
 219     device->SetActiveSource();
 220     TransmitImageViewOn(device->GetLogicalAddress(), command.initiator);
 221   }
 222 }
 223 void CSLCommandHandler::HandleVendorCommandPowerOnStatus(const cec_command &command)
 224 {
 225   if (command.destination != CECDEVICE_BROADCAST)
 226   {
 227     CCECBusDevice *device = m_processor->m_busDevices[m_processor->GetLogicalAddresses().primary];
 228     device->SetPowerStatus(CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON);
 229     device->TransmitPowerState(command.initiator);
 230     device->SetPowerStatus(CEC_POWER_STATUS_ON);
 231   }
 232 }
 233
 234 void CSLCommandHandler::HandleVendorCommandSLConnect(const cec_command &command)
 235 {
 236   SetSLInitialised();
 237   TransmitVendorCommandSetDeviceMode(m_processor->GetLogicalAddress(), command.initiator, CEC_DEVICE_TYPE_RECORDING_DEVICE);
 238
 239   ActivateSource();
 240 }
 241
 242 void CSLCommandHandler::TransmitVendorCommandSetDeviceMode(const cec_logical_address iSource, const cec_logical_address iDestination, const cec_device_type type)
 243 {
 244   cec_command response;
 245   cec_command::Format(response, iSource, iDestination, CEC_OPCODE_VENDOR_COMMAND);
 246   response.PushBack(SL_COMMAND_SET_DEVICE_MODE);
 247   response.PushBack((uint8_t)type);
 248   Transmit(response, false);
 249 }
 250
 251 bool CSLCommandHandler::HandleGiveDeckStatus(const cec_command &command)
 252 {
 253   if (m_processor->IsRunning() && m_busDevice->MyLogicalAddressContains(command.destination))
 254   {
 255     CCECBusDevice *device = GetDevice(command.destination);
 256     if (device && (device->GetType() == CEC_DEVICE_TYPE_PLAYBACK_DEVICE || device->GetType() == CEC_DEVICE_TYPE_RECORDING_DEVICE))
 257     {
 258       if (command.parameters.size > 0)
 259       {
 260         if (command.parameters[0] == CEC_STATUS_REQUEST_ON)
 261         {
 262           ((CCECPlaybackDevice *) device)->SetDeckStatus(CEC_DECK_INFO_STOP);
 263           return ((CCECPlaybackDevice *) device)->TransmitDeckStatus(command.initiator) &&
 264               device->TransmitImageViewOn() &&
 265               device->TransmitPhysicalAddress();
 266         }
 267         else if (command.parameters[0] == CEC_STATUS_REQUEST_ONCE)
 268         {
 269           ((CCECPlaybackDevice *) device)->SetDeckStatus(CEC_DECK_INFO_OTHER_STATUS_LG);
 270           return ((CCECPlaybackDevice *) device)->TransmitDeckStatus(command.initiator);
 271         }
 272       }
 273     }
 274     return CCECCommandHandler::HandleGiveDeckStatus(command);
 275   }
 276
 277   return false;
 278 }
 279
 280 bool CSLCommandHandler::HandleGiveDevicePowerStatus(const cec_command &command)
 281 {
 282   bool bReturn(false);
 283   if (m_processor->IsRunning() && m_busDevice->MyLogicalAddressContains(command.destination) && command.initiator == CECDEVICE_TV)
 284   {
 285     CCECBusDevice *device = GetDevice(command.destination);
 286     if (device && device->GetPowerStatus(false) != CEC_POWER_STATUS_ON)
 287     {
 288       bReturn = device->TransmitPowerState(command.initiator);
 289       device->SetPowerStatus(CEC_POWER_STATUS_ON);
 290     }
 291     else
 292     {
 293       if (!ActiveSourceSent())
 294       {
 295         device->SetPowerStatus(CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON);
 296         bReturn = device->TransmitPowerState(command.initiator);
 297         ActivateSource();
 298       }
 299       else if (m_resetPowerState.IsSet() && m_resetPowerState.TimeLeft() > 0)
 300       {
 301         /* assume that we've bugged out */
 302         CLibCEC::AddLog(CEC_LOG_NOTICE, "LG seems to have bugged out. resetting to 'in transition standby to on'");
 303         {
 304           CLockObject lock(m_SLMutex);
 305           m_bActiveSourceSent = false;
 306         }
 307         device->SetPowerStatus(CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON);
 308         bReturn = device->TransmitPowerState(command.initiator);
 309         device->SetPowerStatus(CEC_POWER_STATUS_ON);
 310         m_resetPowerState.Init(5000);
 311       }
 312       else
 313       {
 314         bReturn = device->TransmitPowerState(command.initiator);
 315         m_resetPowerState.Init(5000);
 316       }
 317     }
 318   }
 319
 320   return bReturn;
 321 }
 322
 323 bool CSLCommandHandler::HandleRequestActiveSource(const cec_command &command)
 324 {
 325   if (m_processor->IsRunning())
 326   {
 327     CLibCEC::AddLog(CEC_LOG_DEBUG, ">> %i requests active source, ignored", (uint8_t) command.initiator);
 328     return true;
 329   }
 330   return false;
 331 }
 332
 333 bool CSLCommandHandler::HandleFeatureAbort(const cec_command &command)
 334 {
 335   if (command.parameters.size == 0 && m_processor->GetPrimaryDevice()->GetPowerStatus() == CEC_POWER_STATUS_ON && !SLInitialised() &&
 336       command.initiator == CECDEVICE_TV)
 337   {
 338     m_processor->GetPrimaryDevice()->TransmitPowerState(command.initiator);
 339     m_processor->GetPrimaryDevice()->TransmitVendorID(CECDEVICE_BROADCAST, false);
 340   }
 341
 342   return CCECCommandHandler::HandleFeatureAbort(command);
 343 }
 344
 345 bool CSLCommandHandler::HandleStandby(const cec_command &command)
 346 {
 347   if (command.initiator == CECDEVICE_TV)
 348     ResetSLState();
 349
 350   return CCECCommandHandler::HandleStandby(command);
 351 }
 352
 353 void CSLCommandHandler::ResetSLState(void)
 354 {
 355   CLibCEC::AddLog(CEC_LOG_NOTICE, "resetting SL initialised state");
 356   CLockObject lock(m_SLMutex);
 357   m_bSLEnabled = false;
 358   m_bActiveSourceSent = false;
 359   m_processor->GetPrimaryDevice()->SetPowerStatus(CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON);
 360 }
 361
 362 void CSLCommandHandler::SetSLInitialised(void)
 363 {
 364   CLibCEC::AddLog(CEC_LOG_NOTICE, "SL initialised");
 365   CLockObject lock(m_SLMutex);
 366   m_bSLEnabled = true;
 367 }
 368
 369 bool CSLCommandHandler::SLInitialised(void)
 370 {
 371   CLockObject lock(m_SLMutex);
 372   return m_bSLEnabled;
 373 }
 374
 375 bool CSLCommandHandler::ActiveSourceSent(void)
 376 {
 377   CLockObject lock(m_SLMutex);
 378   return m_bActiveSourceSent;
 379 }
 380
 381 bool CSLCommandHandler::PowerOn(const cec_logical_address iInitiator, const cec_logical_address iDestination)
 382 {
 383   if (iDestination != CECDEVICE_TV)
 384   {
 385     cec_command command;
 386     cec_command::Format(command, CECDEVICE_TV, iDestination, CEC_OPCODE_VENDOR_COMMAND);
 387     command.PushBack(SL_COMMAND_POWER_ON);
 388     command.PushBack(0);
 389     return Transmit(command);
 390   }
 391
 392   return CCECCommandHandler::PowerOn(iInitiator, iDestination);
 393 }