git.maemo.org Git - pierogi/blob - protocols/pirprotocol.cpp

   1 #include "pirprotocol.h"
   2
   3 #include <QMutex>
   4 #include <QMetaType>
   5
   6 #include <time.h>
   7 #include <sstream>
   8 #include <errno.h>
   9 #include "pirexception.h"
  10
  11 // A flag for communicating with the main thread:
  12 extern bool stopRepeatingFlag;
  13 extern QMutex stopRepeatingMutex;
  14
  15 // Total of all running commands
  16 extern bool commandInFlight;
  17 extern QMutex commandIFMutex;
  18
  19 // From what I understand (mostly from reading LIRC config files), NEC
  20 // protocol based remotes mostly use a frequency of 38000 units and a
  21 // duty cycle of 50%.  They'll be set to these defaults here, and overridden
  22 // as needed by child classes.
  23
  24 PIRProtocol::PIRProtocol(
  25   QObject *guiObject,
  26   unsigned int index,
  27   unsigned int gSpace,
  28   bool iclflag)
  29   : carrierFrequency(38000),
  30     dutyCycle(50),
  31     isConstantLength(iclflag),
  32     gap(gSpace),
  33     minimumRepetitions(0),
  34     id(index)
  35 {
  36   qRegisterMetaType<PIRKeyName>("PIRKeyName");
  37
  38   QObject::connect(
  39     guiObject,
  40     SIGNAL(buttonPressed(unsigned int, PIRKeyName)),
  41     this,
  42     SLOT(startSendingCommand(unsigned int, PIRKeyName)),
  43     Qt::QueuedConnection);
  44
  45   QObject::connect(
  46     this,
  47     SIGNAL(commandFailed(const char *)),
  48     guiObject,
  49     SLOT(receivedExternalWarning(const char *)),
  50     Qt::QueuedConnection);
  51 }
  52
  53
  54 void PIRProtocol::addKey(
  55   PIRKeyName key,
  56   unsigned long command,
  57   unsigned int size)
  58 {
  59   // First, if key already exists, clear it out:
  60   PIRKeyBits *pkb = 0;
  61   KeycodeCollection::iterator i = keycodes.find(key);
  62   if (i != keycodes.end())
  63   {
  64     pkb = &(i->second);
  65     pkb->firstCode.clear();
  66   }
  67   else
  68   {
  69     pkb = &(keycodes[key]);
  70   }
  71
  72   appendToBitSeq(pkb->firstCode, command, size);
  73 }
  74
  75
  76 void PIRProtocol::addSIRCKey(
  77   PIRKeyName key,
  78   unsigned int addressData,
  79   unsigned int size,
  80   unsigned int commandData)
  81 {
  82   // First, if key already exists, clear it out:
  83   PIRKeyBits *pkb = 0;
  84   KeycodeCollection::iterator i = keycodes.find(key);
  85   if (i != keycodes.end())
  86   {
  87     pkb = &(i->second);
  88     pkb->firstCode.clear();
  89     pkb->secondCode.clear();
  90     pkb->thirdCode.clear();
  91   }
  92   else
  93   {
  94     pkb = &(keycodes[key]);
  95   }
  96
  97   // First, append the address data:
  98   appendToBitSeq(pkb->firstCode, addressData, size);
  99
 100   // Next, the command data.  The size is always 7 bits:
 101   appendToBitSeq(pkb->secondCode, commandData, 7);
 102 }
 103
 104
 105 void PIRProtocol::addSIRC20Key(
 106   PIRKeyName key,
 107   unsigned int secondaryAddressData,
 108   unsigned int primaryAddressData,
 109   unsigned int commandData)
 110 {
 111   // First, if key already exists, clear it out:
 112   PIRKeyBits *pkb = 0;
 113   KeycodeCollection::iterator i = keycodes.find(key);
 114   if (i != keycodes.end())
 115   {
 116     pkb = &(i->second);
 117     pkb->firstCode.clear();
 118     pkb->secondCode.clear();
 119     pkb->thirdCode.clear();
 120   }
 121   else
 122   {
 123     pkb = &(keycodes[key]);
 124   }
 125
 126   // First, append the secondary address data:
 127   appendToBitSeq(pkb->firstCode, secondaryAddressData, 8);
 128
 129   // Next, the primary address data:
 130   appendToBitSeq(pkb->secondCode, primaryAddressData, 5);
 131
 132   // Next, the command data.  The size is always 7 bits:
 133   appendToBitSeq(pkb->thirdCode, commandData, 7);
 134 }
 135
 136
 137 void PIRProtocol::addSharpKey(
 138   PIRKeyName key,
 139   unsigned int addressData,
 140   unsigned int commandData)
 141 {
 142   // First, if key already exists, clear it out:
 143   PIRKeyBits *pkb = 0;
 144   KeycodeCollection::iterator i = keycodes.find(key);
 145   if (i != keycodes.end())
 146   {
 147     pkb = &(i->second);
 148     pkb->firstCode.clear();
 149     pkb->secondCode.clear();
 150   }
 151   else
 152   {
 153     pkb = &(keycodes[key]);
 154   }
 155
 156   // Sharp commands are all 5 bit address, 8 bit command:
 157   appendToBitSeq(pkb->firstCode, addressData, 5);
 158   appendToBitSeq(pkb->secondCode, commandData, 8);
 159 }
 160
 161
 162 void PIRProtocol::addNECKey(
 163   PIRKeyName key,
 164   unsigned int addressData,
 165   unsigned int commandData)
 166 {
 167   PIRKeyBits *pkb = 0;
 168   KeycodeCollection::iterator i = keycodes.find(key);
 169   if (i != keycodes.end())
 170   {
 171     pkb = &(i->second);
 172     pkb->firstCode.clear();
 173     pkb->secondCode.clear();
 174     pkb->thirdCode.clear();
 175     pkb->fourthCode.clear();
 176   }
 177   else
 178   {
 179     pkb = &(keycodes[key]);
 180   }
 181
 182   // NEC commands should always be 8 bits address, 8 bits command:
 183   appendToBitSeq(pkb->firstCode, addressData, 8);
 184   appendToBitSeq(pkb->secondCode, commandData, 8);
 185 }
 186
 187
 188 // Most Pioneer keys use the NEC key format, but some are pairs of
 189 // NEC keys sent together:
 190 void PIRProtocol::addPioneerKey(
 191   PIRKeyName key,
 192   unsigned int firstAddress,
 193   unsigned int firstCommand,
 194   unsigned int secondAddress,
 195   unsigned int secondCommand)
 196 {
 197   PIRKeyBits *pkb = 0;
 198   KeycodeCollection::iterator i = keycodes.find(key);
 199   if (i != keycodes.end())
 200   {
 201     pkb = &(i->second);
 202     pkb->firstCode.clear();
 203     pkb->secondCode.clear();
 204     pkb->thirdCode.clear();
 205     pkb->fourthCode.clear();
 206   }
 207   else
 208   {
 209     pkb = &(keycodes[key]);
 210   }
 211
 212   // All four codes should be 8 bits in length:
 213   appendToBitSeq(pkb->firstCode, firstAddress, 8);
 214   appendToBitSeq(pkb->secondCode, firstCommand, 8);
 215   appendToBitSeq(pkb->thirdCode, secondAddress, 8);
 216   appendToBitSeq(pkb->fourthCode, secondCommand, 8);
 217 }
 218
 219
 220 /*
 221 void PIRProtocol::addRCAKey(
 222   PIRKeyName key,
 223   unsigned int addressData,
 224   unsigned int commandData)
 225 {
 226   PIRKeyBits *pkb = 0;
 227   KeycodeCollection::iterator i = keycodes.find(key);
 228   if (i != keycodes.end())
 229   {
 230     pkb = &(i->second);
 231     pkb->firstcode.clear();
 232     pkb->secondCode.clear();
 233   }
 234   else
 235   {
 236     pkb = &(keycodes[key]);
 237   }
 238
 239   // Address is 4 bits, command is 8 bits:
 240   appendToBitSeq(pkb->firstCode, addressData, 4);
 241   appendToBitSeq(pkb->secondCode, commandData, 8);
 242 }
 243 */
 244
 245
 246 void PIRProtocol::addKaseikyoKey(
 247   PIRKeyName key,
 248   unsigned int addressData,
 249   unsigned int commandData)
 250 {
 251   PIRKeyBits *pkb = 0;
 252   KeycodeCollection::iterator i = keycodes.find(key);
 253   if (i != keycodes.end())
 254   {
 255     pkb = &(i->second);
 256     pkb->firstCode.clear();
 257     pkb->secondCode.clear();
 258   }
 259   else
 260   {
 261     pkb = &(keycodes[key]);
 262   }
 263
 264   appendToBitSeq(pkb->firstCode, addressData, 12);
 265   appendToBitSeq(pkb->secondCode, commandData, 8);
 266 }
 267
 268
 269 void PIRProtocol::addDishKey(
 270   PIRKeyName key,
 271   unsigned int firstCommand,
 272   unsigned int secondCommand)
 273 {
 274   PIRKeyBits *pkb = 0;
 275   KeycodeCollection::iterator i = keycodes.find(key);
 276   if (i != keycodes.end())
 277   {
 278     pkb = &(i->second);
 279     pkb->firstCode.clear();
 280     pkb->secondCode.clear();
 281   }
 282   else
 283   {
 284     pkb = &(keycodes[key]);
 285   }
 286
 287   appendToBitSeq(pkb->firstCode, firstCommand, 6);
 288   appendToBitSeq(pkb->secondCode, secondCommand, 5);
 289 }
 290
 291
 292 void PIRProtocol::addXMPKey(
 293   PIRKeyName key,
 294   unsigned int firstCommand,
 295   unsigned int secondCommand)
 296 {
 297   PIRKeyBits *pkb = 0;
 298   KeycodeCollection::iterator i = keycodes.find(key);
 299   if (i != keycodes.end())
 300   {
 301     pkb = &(i->second);
 302     pkb->firstCode.clear();
 303     pkb->secondCode.clear();
 304   }
 305   else
 306   {
 307     pkb = &(keycodes[key]);
 308   }
 309
 310   appendToBitSeq(pkb->firstCode, firstCommand, 8);
 311   appendToBitSeq(pkb->secondCode, secondCommand, 8);
 312 }
 313
 314
 315 void PIRProtocol::setCarrierFrequency(
 316   unsigned int freq)
 317 {
 318   carrierFrequency = freq;
 319 }
 320
 321
 322 void PIRProtocol::setDutyCycle(
 323   unsigned int dc)
 324 {
 325   dutyCycle = dc;
 326 }
 327
 328
 329 void PIRProtocol::setMinimumRepetitions(
 330   unsigned int minrep)
 331 {
 332   minimumRepetitions = minrep;
 333 }
 334
 335
 336 void PIRProtocol::setPreData(
 337   unsigned long data,
 338   unsigned int bits)
 339 {
 340   // If the container is not empty, first clear it out:
 341   if (!preData.empty())
 342   {
 343     preData.clear();
 344   }
 345
 346   appendToBitSeq(preData, data, bits);
 347 }
 348
 349
 350 void PIRProtocol::setPostData(
 351   unsigned long data,
 352   unsigned int bits)
 353 {
 354   // If the container is not empty, first clear it out:
 355   if (!postData.empty())
 356   {
 357     postData.clear();
 358   }
 359
 360   appendToBitSeq(postData, data, bits);
 361 }
 362
 363
 364 bool PIRProtocol::isCommandSupported(
 365   PIRKeyName command)
 366 {
 367   return (keycodes.find(command) != keycodes.end());
 368 }
 369
 370
 371 void PIRProtocol::appendToBitSeq(
 372   CommandSequence &sequence,
 373   unsigned int bits,
 374   int size)
 375 {
 376   if (size == 0)
 377   {
 378     // This is bad, but just return silently for now...
 379     return;
 380   }
 381
 382   // For each bit in the char, append a 1 or a 0 into the sequence.
 383   // Starting with the largest bit, move forward one bit at a time:
 384   unsigned int currentBit = 1 << (size - 1);
 385
 386   do
 387   {
 388     if (bits & currentBit)
 389     {
 390       sequence.push_back(1);
 391     }
 392     else
 393     {
 394       sequence.push_back(0);
 395     }
 396
 397     currentBit = currentBit >> 1;
 398   }
 399   while (currentBit > 0);
 400 }
 401
 402
 403 void PIRProtocol::clearRepeatFlag()
 404 {
 405   QMutexLocker locker(&stopRepeatingMutex);
 406   stopRepeatingFlag = false;
 407 }
 408
 409
 410 bool PIRProtocol::checkRepeatFlag()
 411 {
 412   QMutexLocker locker(&stopRepeatingMutex);
 413   return stopRepeatingFlag;
 414 }
 415
 416
 417 // Note that the following routine blindly sleeps for the amount of time
 418 // specified by the LIRC config file.  The extra overhead of processing
 419 // each command will mean that repeated commands will overshoot the config
 420 // time by some amount.  We could improve accuracy by waiting a little less
 421 // than the specified time, if we could get a good handle on how long the
 422 // overhead is delaying the command...
 423 #define PIEROGI_OVERHEAD_HACK 13260
 424
 425 void PIRProtocol::sleepUntilRepeat(
 426   int commandDuration)
 427 {
 428   int microseconds;
 429
 430   // If the LIRC config file specifies the flag "CONST_LENGTH", that means
 431   // the "gap" value is the exact amount of time to wait between kicking off
 432   // each command.  If not, then the "gap" needs to be added on to the total
 433   // time of the previous command to see how long to sleep.
 434
 435   if (isConstantLength)
 436   {
 437     microseconds = (gap - commandDuration) - PIEROGI_OVERHEAD_HACK;
 438   }
 439   else
 440   {
 441     microseconds = gap - PIEROGI_OVERHEAD_HACK;
 442   }
 443
 444 /*
 445   // Don't even bother sleeping if there's only a few microseconds:
 446   if (microseconds < 1000)
 447   {
 448     return;
 449   }
 450 */
 451   // For now, I'm going to enforce a minimum sleep of 10 ms, so that we
 452   // don't get runaway commands:
 453   if (microseconds < 10000)
 454   {
 455     microseconds = 10000;
 456   }
 457
 458   timespec sleeptime;
 459   sleeptime.tv_sec = 0;
 460   sleeptime.tv_nsec = microseconds * 1000;
 461
 462   timespec remainingtime;
 463
 464   if (nanosleep(&sleeptime, &remainingtime) == -1)
 465   {
 466     std::stringstream ss;
 467     ss << "Problem while sleeping.\n";
 468     ss << "Trying to sleep for: " << microseconds << "\n";
 469     ss << "Nanosleep returned error: " << strerror(errno) << "\n";
 470     throw PIRException(ss.str());
 471   }
 472 }
 473
 474
 475 void PIRProtocol::setGapSize(
 476   int gapSize,
 477   bool iclFlag)
 478 {
 479   gap = gapSize;
 480   isConstantLength = iclFlag;
 481 }