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