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