Fix for command overrun
[pierogi] / pirprotocol.h
1 #ifndef PIRPROTOCOL_H
2 #define PIRPROTOCOL_H
3
4 // The generic remote controller.
5
6 #include <QObject>
7 //#include <QMutex>
8 #include "pirkeynames.h"
9 //#include "pirdevice.h"
10
11 #include <map>
12 #include <deque>
13
14 // We'll define a maximum number of repetitions, regardless of how long the
15 // user presses the button.  (This is just in case we miss the point at which
16 // he stops pressing it...)  500 should be plenty.
17 #define MAX_REPEAT_COUNT 500
18
19 typedef std::deque<bool> CommandSequence;
20
21 // I'll go ahead and use associative arrays to build up lists of keycodes.
22 typedef std::map<int, CommandSequence> KeycodeCollection;
23
24
25 // Right now, the only reason for this object to inherit from QObject is
26 // so it can participate in Qt-style threading.  Note that it has no
27 // event loop, and no access to the GUI, so don't go trying to communicate
28 // with the user here...
29 class PIRProtocol: public QObject
30 {
31   Q_OBJECT
32
33 public:
34   PIRProtocol(
35     QObject *guiObject,
36     unsigned int index,
37     unsigned int gSpace,
38     bool iclflag);
39
40   void addKey(
41     PIRKeyName key,
42     unsigned long data,
43     unsigned int bits);
44
45   void setCarrierFrequency(
46     unsigned int freq);
47
48   void setDutyCycle(
49     unsigned int dc);
50
51   void setMinimumRepetitions(
52     unsigned int minrep);
53
54 public slots:
55   virtual void startSendingCommand(
56     unsigned int threadableID,
57     PIRKeyName command) = 0;
58
59 signals:
60   void commandFailed(
61     const char *errString);
62
63 protected:
64   bool isCommandSupported(
65     PIRKeyName command);
66
67   void clearRepeatFlag();
68   bool checkRepeatFlag();
69
70   unsigned int carrierFrequency;
71   unsigned int dutyCycle;
72
73   // "appendToBitSeq" really doesn't belong in this class...
74   void appendToBitSeq(
75     CommandSequence &sequence,
76     unsigned int bits,
77     int significantBits);
78
79   KeycodeCollection keycodes;
80
81   // A sleep function for all protocols:
82   void sleepUntilRepeat(
83     int commandDuration);
84
85   // The "gap" parameter from LIRC.  If the commands are "variable-length",
86   // this indicates the amount of time between the last pulse of one
87   // command and the first pulse of the next.  If "constant-length", it is
88   // the time between the _first_ pulse of one command and the first pulse
89   // of the next.
90
91   bool isConstantLength;
92   int gap;
93
94   // Some remotes require a minimum number of repetitions:
95   int minimumRepetitions;
96
97   unsigned int id;
98 };
99
100 #endif // PIRPROTOCOL_H