src/cec-config/cec-config.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 "../../include/cec.h"
  34
  35 #include <cstdio>
  36 #include <fcntl.h>
  37 #include <iostream>
  38 #include <fstream>
  39 #include <string>
  40 #include <sstream>
  41 #include "../lib/platform/threads/mutex.h"
  42 #include "../lib/platform/util/timeutils.h"
  43 #include "../lib/implementations/CECCommandHandler.h"
  44
  45 using namespace CEC;
  46 using namespace std;
  47 using namespace PLATFORM;
  48
  49 #include <cecloader.h>
  50
  51 CMutex                g_outputMutex;
  52
  53 CEvent                g_responseEvent;
  54 cec_opcode            g_lastCommand = CEC_OPCODE_NONE;
  55
  56 CEvent                g_keyEvent;
  57 cec_user_control_code g_lastKey = CEC_USER_CONTROL_CODE_UNKNOWN;
  58
  59 ICECCallbacks         g_callbacks;
  60 libcec_configuration  g_config;
  61 ICECAdapter *         g_parser;
  62 cec_logical_address   g_primaryAddress;
  63
  64 inline void PrintToStdOut(const char *strFormat, ...)
  65 {
  66   CStdString strLog;
  67
  68   va_list argList;
  69   va_start(argList, strFormat);
  70   strLog.FormatV(strFormat, argList);
  71   va_end(argList);
  72
  73   CLockObject lock(g_outputMutex);
  74   cout << strLog << endl;
  75 }
  76
  77 //get the first word (separated by whitespace) from string data and place that in word
  78 //then remove that word from string data
  79 bool GetWord(string& data, string& word)
  80 {
  81   stringstream datastream(data);
  82   string end;
  83
  84   datastream >> word;
  85   if (datastream.fail())
  86   {
  87     data.clear();
  88     return false;
  89   }
  90
  91   size_t pos = data.find(word) + word.length();
  92
  93   if (pos >= data.length())
  94   {
  95     data.clear();
  96     return true;
  97   }
  98
  99   data = data.substr(pos);
 100
 101   datastream.clear();
 102   datastream.str(data);
 103
 104   datastream >> end;
 105   if (datastream.fail())
 106     data.clear();
 107
 108   return true;
 109 }
 110
 111 int CecLogMessage(void *UNUSED(cbParam), const cec_log_message &message)
 112 {
 113   switch (message.level)
 114   {
 115   case CEC_LOG_ERROR:
 116     PrintToStdOut("ERROR:\t%s", message.message);
 117     break;
 118   case CEC_LOG_WARNING:
 119     PrintToStdOut("ERROR:\t%s", message.message);
 120     break;
 121   default:
 122     break;
 123   }
 124
 125   return 0;
 126 }
 127
 128 int CecKeyPress(void *UNUSED(cbParam), const cec_keypress &key)
 129 {
 130   g_lastKey = key.keycode;
 131   g_keyEvent.Signal();
 132   return 0;
 133 }
 134
 135 int CecCommand(void *UNUSED(cbParam), const cec_command &command)
 136 {
 137   g_lastCommand = command.opcode;
 138   g_responseEvent.Signal();
 139   return 0;
 140 }
 141
 142 void EnableCallbacks(ICECAdapter *adapter)
 143 {
 144   g_callbacks.CBCecLogMessage = &CecLogMessage;
 145   g_callbacks.CBCecKeyPress   = &CecKeyPress;
 146   g_callbacks.CBCecCommand    = &CecCommand;
 147   g_callbacks.CBCecConfigurationChanged = NULL;
 148   adapter->EnableCallbacks(NULL, &g_callbacks);
 149 }
 150
 151 ICECAdapter *CreateParser(cec_device_type_list typeList)
 152 {
 153   ICECAdapter *parser = LibCecInit("ButtonConfig", typeList);
 154   if (!parser)
 155   {
 156   #ifdef __WINDOWS__
 157     PrintToStdOut("Cannot load libcec.dll");
 158   #else
 159     PrintToStdOut("Cannot load libcec.so");
 160   #endif
 161     return NULL;
 162   }
 163
 164   PrintToStdOut("CEC Parser created - libcec version %d.%d", parser->GetLibVersionMajor(), parser->GetLibVersionMinor());
 165
 166   return parser;
 167 }
 168
 169 bool ProcessConsoleCommand(string &input)
 170 {
 171   if (!input.empty())
 172   {
 173     string command;
 174     if (GetWord(input, command))
 175     {
 176       if (command == "q" || command == "quit")
 177         return false;
 178     }
 179   }
 180   return true;
 181 }
 182
 183 bool OpenConnection(cec_device_type type = CEC_DEVICE_TYPE_RECORDING_DEVICE)
 184 {
 185   g_config.Clear();
 186   snprintf(g_config.strDeviceName, 13, "CEC-config");
 187   g_config.callbackParam      = NULL;
 188   g_config.clientVersion      = (uint32_t)CEC_CLIENT_VERSION_1_5_0;
 189   g_callbacks.CBCecLogMessage = &CecLogMessage;
 190   g_callbacks.CBCecKeyPress   = &CecKeyPress;
 191   g_callbacks.CBCecCommand    = &CecCommand;
 192   g_config.callbacks          = &g_callbacks;
 193
 194   g_config.deviceTypes.add(type);
 195
 196   g_parser = LibCecInitialise(&g_config);
 197   if (!g_parser)
 198     return false;
 199
 200   CStdString strPort;
 201   cec_adapter devices[10];
 202   uint8_t iDevicesFound = g_parser->FindAdapters(devices, 10, NULL);
 203   if (iDevicesFound <= 0)
 204   {
 205     PrintToStdOut("autodetect FAILED");
 206     UnloadLibCec(g_parser);
 207     return false;
 208   }
 209   else
 210   {
 211     strPort = devices[0].comm;
 212   }
 213
 214   PrintToStdOut("opening a connection to the CEC adapter...");
 215   if (!g_parser->Open(strPort.c_str()))
 216   {
 217     PrintToStdOut("unable to open the device on port %s", strPort.c_str());
 218     UnloadLibCec(g_parser);
 219     return false;
 220   }
 221
 222   cec_logical_addresses addr = g_parser->GetLogicalAddresses();
 223   g_primaryAddress = addr.primary;
 224
 225   PrintToStdOut("cec device opened. using logical address %X", g_primaryAddress);
 226   return true;
 227 }
 228
 229 int8_t FindPhysicalAddressPortNumber(void)
 230 {
 231   PrintToStdOut("Enter the HDMI port number to which you connected your CEC adapter, followed by <enter>. Valid ports are in the range 1-15. Anything else will cancel this wizard.");
 232   string input;
 233   getline(cin, input);
 234   cin.clear();
 235   if (input.empty())
 236     return -1;
 237
 238   int hdmiport = atoi(input.c_str());
 239   return (hdmiport < 1 || hdmiport > 15) ? -1 : (int8_t)hdmiport;
 240 }
 241
 242 cec_logical_address FindPhysicalAddressBaseDevice(void)
 243 {
 244   PrintToStdOut("Press 1 if your CEC adapter is connected to your TV or\npress 2 if it's connected to an AVR, followed by <enter>. Anything else will cancel this wizard.");
 245
 246   string input;
 247   getline(cin, input);
 248   cin.clear();
 249   if (input.empty() || (input != "1" && input != "2"))
 250   {
 251     PrintToStdOut("Exiting...");
 252     return CECDEVICE_UNKNOWN;
 253   }
 254   return (input == "2") ?
 255     CECDEVICE_AUDIOSYSTEM :
 256     CECDEVICE_TV;
 257 }
 258
 259 uint16_t FindPhysicalAddress(void)
 260 {
 261   PrintToStdOut("=== Physical Address Configuration ===\n");
 262   uint16_t iAddress(0xFFFF);
 263
 264   PrintToStdOut("Do you want to let libCEC try to autodetect the address (y/n)?");
 265   string input;
 266   getline(cin, input);
 267   cin.clear();
 268   if (input == "y" || input == "Y")
 269   {
 270     cec_logical_address baseDevice = FindPhysicalAddressBaseDevice();
 271     if (baseDevice == CECDEVICE_UNKNOWN)
 272       return iAddress;
 273
 274     int8_t iPortNumber = FindPhysicalAddressPortNumber();
 275     if (iPortNumber == -1)
 276       return iAddress;
 277
 278     PrintToStdOut("Trying to detect the physical address...");
 279     if (!g_parser->SetHDMIPort(baseDevice, iPortNumber))
 280       PrintToStdOut("Failed. Please enter the address manually, or restart this wizard and use different settings.");
 281     else
 282     {
 283       iAddress = g_parser->GetDevicePhysicalAddress(g_primaryAddress);
 284       if (iAddress == 0 || iAddress == 0xFFFF)
 285         PrintToStdOut("Failed. Please enter the address manually, or restart this wizard and use different settings.");
 286     }
 287   }
 288
 289   if (iAddress == 0 || iAddress == 0xFFFF)
 290   {
 291     PrintToStdOut("Please enter the physical address (0000 - FFFF), followed by <enter>.");
 292     getline(cin, input);
 293     cin.clear();
 294
 295     int iAddressTmp;
 296     if (sscanf(input.c_str(), "%x", &iAddressTmp) == 1)
 297     {
 298       if (iAddressTmp < 0 || iAddressTmp > 0xFFFF)
 299         iAddressTmp = 0xFFFF;
 300       iAddress = (uint16_t)iAddressTmp;
 301     }
 302   }
 303
 304   if (iAddress != 0)
 305   {
 306     g_parser->SetPhysicalAddress(iAddress);
 307     g_parser->SetActiveSource(g_config.deviceTypes[0]);
 308   }
 309
 310   return iAddress;
 311 }
 312
 313 bool PowerOnTV(uint64_t iTimeout = 60000)
 314 {
 315   cec_power_status currentTvPower(CEC_POWER_STATUS_UNKNOWN);
 316   uint64_t iNow = GetTimeMs();
 317   uint64_t iTarget = iNow + iTimeout;
 318
 319   if (currentTvPower != CEC_POWER_STATUS_ON)
 320   {
 321     currentTvPower = g_parser->GetDevicePowerStatus(CECDEVICE_TV);
 322     if (currentTvPower != CEC_POWER_STATUS_ON)
 323     {
 324       PrintToStdOut("Sending 'power on' command to the TV\n=== Please wait ===");
 325       g_parser->PowerOnDevices(CECDEVICE_TV);
 326       while (iTarget > iNow)
 327       {
 328         g_responseEvent.Wait((uint32_t)(iTarget - iNow));
 329         if (g_lastCommand == CEC_OPCODE_REQUEST_ACTIVE_SOURCE)
 330           break;
 331         iNow = GetTimeMs();
 332       }
 333     }
 334   }
 335
 336   currentTvPower = g_parser->GetDevicePowerStatus(CECDEVICE_TV);
 337
 338   if (currentTvPower != CEC_POWER_STATUS_ON)
 339     PrintToStdOut("Failed to power on the TV, or the TV does not respond properly");
 340
 341   return currentTvPower == CEC_POWER_STATUS_ON;
 342 }
 343
 344 int main (int UNUSED(argc), char *UNUSED(argv[]))
 345 {
 346   PrintToStdOut("=== USB-CEC Adapter Configuration ===\n");
 347   if (!OpenConnection())
 348     return 1;
 349
 350   if (!PowerOnTV())
 351     return 1;
 352
 353   bool bAddressOk(false);
 354   while (!bAddressOk)
 355   {
 356     uint16_t iAddress = FindPhysicalAddress();
 357
 358     PrintToStdOut("Physical address: %4X", iAddress);
 359     PrintToStdOut("Is this correct (y/n)?");
 360     string input;
 361     getline(cin, input);
 362     cin.clear();
 363     bAddressOk = (input == "y" || input == "Y");
 364   }
 365
 366   g_parser->GetCurrentConfiguration(&g_config);
 367
 368   {
 369     cec_menu_language lang;
 370     if (g_parser->GetDeviceMenuLanguage(CECDEVICE_TV, &lang))
 371     {
 372       PrintToStdOut("TV menu language: %s", lang.language);
 373       PrintToStdOut("Do you want the application to use the menu language of the TV (y/n)?");
 374       string input;
 375       getline(cin, input);
 376       cin.clear();
 377       g_config.bUseTVMenuLanguage = (input == "y" || input == "Y") ? 1 : 0;
 378     }
 379     else
 380     {
 381       PrintToStdOut("The TV did not respond properly to the menu language request.");
 382     }
 383   }
 384
 385   {
 386     PrintToStdOut("Do you want to make the CEC adapter the active source when starting the application (y/n)?");
 387     string input;
 388     getline(cin, input);
 389     cin.clear();
 390     g_config.bActivateSource = (input == "y" || input == "Y") ? 1 : 0;
 391   }
 392
 393   {
 394     PrintToStdOut("Do you want to power off CEC devices when closing the application (y/n)?");
 395     string input;
 396     getline(cin, input);
 397     cin.clear();
 398     if (input == "y" || input == "Y")
 399       g_config.powerOffDevices.Set(CECDEVICE_BROADCAST);
 400   }
 401
 402   {
 403     PrintToStdOut("Do you want to power off CEC devices when the screensaver is activated (y/n)?");
 404     string input;
 405     getline(cin, input);
 406     cin.clear();
 407     g_config.bPowerOffScreensaver = (input == "y" || input == "Y") ? 1 : 0;
 408   }
 409
 410   {
 411     PrintToStdOut("Do you want to put the PC in standby when the TV is put in standby mode (y/n)?");
 412     string input;
 413     getline(cin, input);
 414     cin.clear();
 415     g_config.bPowerOffOnStandby = (input == "y" || input == "Y") ? 1 : 0;
 416   }
 417
 418   {
 419     PrintToStdOut("Do you want to send an inactive source message when stopping the application (y/n)?");
 420     string input;
 421     getline(cin, input);
 422     cin.clear();
 423     g_config.bSendInactiveSource = (input == "y" || input == "Y") ? 1 : 0;
 424   }
 425
 426   PrintToStdOut("\n\n=== USB-CEC Adapter Configuration Summary ===");
 427   PrintToStdOut("HDMI port number:                                        %d", g_config.iHDMIPort);
 428   PrintToStdOut("Connected to HDMI device:                                %X", (uint8_t)g_config.baseDevice);
 429   PrintToStdOut("Physical address:                                        %4X", g_config.iPhysicalAddress);
 430   PrintToStdOut("Use the TV's language setting:                           %s", g_config.bUseTVMenuLanguage ? "yes" : "no");
 431   PrintToStdOut("Make the adapter the active source when starting XBMC:   %s", g_config.bActivateSource ? "yes" : "no");
 432   PrintToStdOut("Power off devices when stopping XBMC:                    %s", g_config.powerOffDevices.IsSet(CECDEVICE_BROADCAST) ? "yes" : "no");
 433   PrintToStdOut("Put devices in standby mode when activating screensaver: %s", g_config.bPowerOffScreensaver ? "yes" : "no");
 434   PrintToStdOut("Put this PC in standby mode when the TV is switched off: %s", g_config.bPowerOffOnStandby ? "yes" : "no");
 435   PrintToStdOut("Seend an inactive source message when stopping XBMC:     %s\n\n", g_config.bSendInactiveSource ? "yes" : "no");
 436
 437   if (g_parser->CanPersistConfiguration())
 438   {
 439     PrintToStdOut("Do you want to store these settings in the adapter (y/n)?");
 440     string input;
 441     getline(cin, input);
 442     cin.clear();
 443     if (input == "y" || input == "Y")
 444     {
 445       PrintToStdOut("Storing settings ...");
 446       if (g_parser->PersistConfiguration(&g_config))
 447         PrintToStdOut("Settings stored.");
 448       else
 449         PrintToStdOut("The settings could not be stored");
 450     }
 451   }
 452   else
 453   {
 454     PrintToStdOut("This adapter doesn't support settings persistence. Please set up these settings in your media player application.");
 455
 456     ofstream configOutput;
 457     configOutput.open("usb_2548_1001.xml");
 458     if (configOutput.is_open())
 459     {
 460       CStdString strWakeDevices;
 461       for (uint8_t iPtr = 0; iPtr < 16; iPtr++)
 462         if (g_config.wakeDevices[iPtr])
 463           strWakeDevices.AppendFormat(" %d" + iPtr);
 464       CStdString strStandbyDevices;
 465       for (uint8_t iPtr = 0; iPtr < 16; iPtr++)
 466         if (g_config.powerOffDevices[iPtr])
 467           strStandbyDevices.AppendFormat(" %d" + iPtr);
 468
 469       configOutput <<
 470         "<settings>\n" <<
 471           "\t<setting id=\"enabled\" value=\"1\" />\n" <<
 472           "\t<setting id=\"activate_source\" value=\"" << (int)g_config.bActivateSource << "\" />\n" <<
 473           "\t<setting id=\"wake_devices\" value=\"" << strWakeDevices.c_str() << "\" />\n" <<
 474           "\t<setting id=\"standby_devices\" value=\"" << strStandbyDevices.c_str() << "\" />\n" <<
 475           "\t<setting id=\"cec_standby_screensaver\" value=\"" << (int)g_config.bPowerOffScreensaver << "\" />\n" <<
 476           "\t<setting id=\"standby_pc_on_tv_standby\" value=\"" << (int)g_config.bPowerOffOnStandby << "\" />\n" <<
 477           "\t<setting id=\"use_tv_menu_language\" value=\"" << (int)g_config.bUseTVMenuLanguage << "\" />\n" <<
 478           "\t<setting id=\"physical_address\" value=\"" << hex << g_config.iPhysicalAddress << "\" />\n" <<
 479           "\t<setting id=\"cec_hdmi_port\" value=\"" << g_config.iHDMIPort << "\" />\n" <<
 480           "\t<setting id=\"connected_device\" value=\"" << (int)g_config.baseDevice << "\" />\n" <<
 481           "\t<setting id=\"port\" value=\"\" />\n" <<
 482           "\t<setting id=\"send_inactive_source\" value=\"" << (int)g_config.bSendInactiveSource << "\" />\n" <<
 483         "</settings>";
 484       configOutput.close();
 485
 486       PrintToStdOut("The configuration has been stored in 'usb_2548_1001.xml'. Copy this file to ~/.userdata/peripheral_data to use it in XBMC");
 487     }
 488   }
 489
 490   g_parser->StandbyDevices();
 491   g_parser->Close();
 492   UnloadLibCec(g_parser);
 493
 494   PrintToStdOut("Press enter to close this wizard.");
 495   string input;
 496   getline(cin, input);
 497   return 0;
 498 }