vcs.maemo.org Git - pierogi/blob - protocols/pirprotocol.h

   1 #ifndef PIRPROTOCOL_H
   2 #define PIRPROTOCOL_H
   3
   4 // The generic remote controller.
   5
   6 #include <QObject>
   7 #include "pirkeynames.h"
   8
   9 #include <map>
  10 #include <deque>
  11
  12 // We'll define a maximum number of repetitions, regardless of how long the
  13 // user presses the button.  (This is just in case we miss the point at which
  14 // he stops pressing it...)  500 should be plenty.
  15 #define MAX_REPEAT_COUNT 500
  16
  17 typedef std::deque<bool> CommandSequence;
  18
  19 // As I've learned more about IR protocols, the concept of what a specific
  20 // key is gets more and more complex.  To deal with this, I'm going to allow
  21 // a key to have more than one command sequence associated with it.  (I need
  22 // up to three codes for Sony keys, and as many as four to define an
  23 // individual Pioneer key.)
  24 class PIRKeyBits
  25 {
  26 public:
  27   CommandSequence firstCode;
  28   CommandSequence secondCode;
  29   CommandSequence thirdCode;
  30   CommandSequence fourthCode;
  31 };
  32
  33 // I'll go ahead and use associative arrays to build up lists of keycodes.
  34 typedef std::map<int, PIRKeyBits> KeycodeCollection;
  35
  36
  37 // Right now, the only reason for this object to inherit from QObject is
  38 // so it can participate in Qt-style threading.  Note that it has no
  39 // event loop, and no access to the GUI, so don't go trying to communicate
  40 // with the user here...
  41 class PIRProtocol: public QObject
  42 {
  43   Q_OBJECT
  44
  45 public:
  46   PIRProtocol(
  47     QObject *guiObject,
  48     unsigned int index,
  49     unsigned int gSpace,
  50     bool iclflag);
  51
  52   void addKey(
  53     PIRKeyName key,
  54     unsigned long data,
  55     unsigned int size);
  56
  57   // A special addKey used for Sony's SIRC protocol:
  58   void addSIRCKey(
  59     PIRKeyName key,
  60     unsigned int addressData,
  61     unsigned int size,
  62     unsigned int commandData);
  63
  64   void addSIRC20Key(
  65     PIRKeyName key,
  66     unsigned int secondaryAddressData,
  67     unsigned int primaryAddressData,
  68     unsigned int commandData);
  69
  70   void addSharpKey(
  71     PIRKeyName key,
  72     unsigned int addressData,
  73     unsigned int commandData);
  74
  75   void addNECKey(
  76     PIRKeyName key,
  77     unsigned int addressData,
  78     unsigned int commandData);
  79
  80   void addPioneerKey(
  81     PIRKeyName key,
  82     unsigned int firstAddress,
  83     unsigned int firstCommand,
  84     unsigned int secondAddress,
  85     unsigned int secondCommand);
  86
  87 /*
  88   void addRCAKey(
  89     PIRKeyName key,
  90     unsigned int addressData,
  91     unsigned int commandData);
  92 */
  93
  94   void addKaseikyoKey(
  95     PIRKeyName key,
  96     unsigned int addressData,
  97     unsigned int commandData);
  98
  99   void setCarrierFrequency(
 100     unsigned int freq);
 101
 102   void setDutyCycle(
 103     unsigned int dc);
 104
 105   void setMinimumRepetitions(
 106     unsigned int minrep);
 107
 108   void setPreData(
 109     unsigned long data,
 110     unsigned int bits);
 111
 112   void setPostData(
 113     unsigned long data,
 114     unsigned int bits);
 115
 116 public slots:
 117   virtual void startSendingCommand(
 118     unsigned int threadableID,
 119     PIRKeyName command) = 0;
 120
 121 signals:
 122   void commandFailed(
 123     const char *errString);
 124
 125 protected:
 126   bool isCommandSupported(
 127     PIRKeyName command);
 128
 129   void clearRepeatFlag();
 130   bool checkRepeatFlag();
 131
 132   unsigned int carrierFrequency;
 133   unsigned int dutyCycle;
 134
 135   void appendToBitSeq(
 136     CommandSequence &bits,
 137     unsigned int code,
 138     int size);
 139
 140   KeycodeCollection keycodes;
 141
 142   // A sleep function for all protocols:
 143   void sleepUntilRepeat(
 144     int commandDuration);
 145
 146   // The "gap" parameter from LIRC.  If the commands are "variable-length",
 147   // this indicates the amount of time between the last pulse of one
 148   // command and the first pulse of the next.  If "constant-length", it is
 149   // the time between the _first_ pulse of one command and the first pulse
 150   // of the next.
 151
 152   bool isConstantLength;
 153   int gap;
 154
 155   // More administrative data wrapped around the actual command:
 156   CommandSequence preData;
 157   CommandSequence postData;
 158
 159   // Some remotes require a minimum number of repetitions:
 160   // Note: thinking about removing this -- don't know if it is needed
 161   int minimumRepetitions;
 162
 163   unsigned int id;
 164 };
 165
 166 #endif // PIRPROTOCOL_H