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