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