input.h

   1 /*
   2     Copyright 2004-2020 Chris Tallon
   3
   4     This file is part of VOMP.
   5
   6     VOMP is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     VOMP is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with VOMP.  If not, see <https://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef INPUT_H
  21 #define INPUT_H
  22
  23 #include <string>
  24 #include <map>
  25
  26 #include "defines.h"
  27 #include "abstractoption.h"
  28
  29 #ifdef WIN32
  30 #define HWC_TYPE ULLONG
  31 #else
  32 #define HWC_TYPE int
  33 #endif
  34
  35
  36 class VDR;
  37
  38 typedef std::map<HWC_TYPE, UCHAR> RemoteTranslationList;
  39
  40 class Input: public AbstractOption
  41 {
  42   public:
  43     virtual ~Input() {}
  44
  45     virtual bool start() { return false; }
  46     virtual void stop() {}
  47
  48     // Abstract Option interface
  49     virtual bool loadOptionsFromServer(VDR* vdr);
  50     virtual bool saveOptionstoServer();
  51
  52     static void sendInputKey(int key);
  53
  54     void setHWCtoCommand(HWC_TYPE hcw, UCHAR command);
  55     void unsetHWC(HWC_TYPE hcw);
  56     void LoadKeysConfig(VDR* vdr, const char* keynum);
  57     void SaveKeysConfig();
  58
  59     virtual bool init()=0;
  60     virtual void shutdown()=0;
  61
  62     virtual bool handlesVolume() {return false;};
  63     virtual void volumeUp() {};
  64     virtual void volumeDown() {};
  65     virtual void volumeMute() {};
  66     virtual void changePowerState(bool /* poweron */) {}; //informs the remote control, that about vomp's power state, this is important e.g. for cec
  67
  68     virtual void InitHWCListwithDefaults()=0;
  69     std::string getAllHardwareKeyNamesAssignedToVompKey(UCHAR vompKey);
  70     char* CommandTranslateStr(UCHAR command);
  71     void EnterLearnMode(UCHAR /* command */ ) {}; // Override and set lernMode to command
  72     void cancelLearnMode() { learnMode = NOLEARNMODE; }
  73     void ResetToDefault();
  74     virtual std::string getHardwareKeyName(HWC_TYPE hardwareKey) = 0;
  75
  76
  77     const static ULONG NOLEARNMODE = 256;
  78     // Not buttons
  79     const static UCHAR NA_LEARN    = 101;
  80     const static UCHAR NA_NONE     = 98;
  81     const static UCHAR NA_UNKNOWN  = 99;
  82
  83     // Problem common buttons
  84     const static UCHAR VOLUMEUP    = 16;
  85     const static UCHAR VOLUMEDOWN  = 17;
  86     const static UCHAR CHANNELUP   = 32;
  87     const static UCHAR CHANNELDOWN = 33;
  88
  89     // Common buttons
  90     const static UCHAR ZERO        = 0;
  91     const static UCHAR ONE         = 1;
  92     const static UCHAR TWO         = 2;
  93     const static UCHAR THREE       = 3;
  94     const static UCHAR FOUR        = 4;
  95     const static UCHAR FIVE        = 5;
  96     const static UCHAR SIX         = 6;
  97     const static UCHAR SEVEN       = 7;
  98     const static UCHAR EIGHT       = 8;
  99     const static UCHAR NINE        = 9;
 100     const static UCHAR POWER       = 61;
 101     const static UCHAR GO          = 59;
 102     const static UCHAR BACK        = 31;
 103     const static UCHAR MENU        = 13;
 104     const static UCHAR RED         = 11;
 105     const static UCHAR GREEN       = 46;
 106     const static UCHAR YELLOW      = 56;
 107     const static UCHAR BLUE        = 41;
 108     const static UCHAR MUTE        = 15;
 109     const static UCHAR RADIO       = 12; // The unlabelled button on old
 110     const static UCHAR REVERSE     = 50;
 111     const static UCHAR PLAY        = 53;
 112     const static UCHAR FORWARD     = 52;
 113     const static UCHAR RECORD      = 55;
 114     const static UCHAR STOP        = 54;
 115     const static UCHAR PAUSE       = 48;
 116     const static UCHAR SKIPBACK    = 36;
 117     const static UCHAR SKIPFORWARD = 30;
 118     const static UCHAR OK          = 37;
 119
 120     // Old remote only
 121     const static UCHAR FULL        = 60;
 122
 123     // New remote only
 124     const static UCHAR TV          = 28;
 125     const static UCHAR VIDEOS      = 24;
 126     const static UCHAR MUSIC       = 25;
 127     const static UCHAR PICTURES    = 26;
 128     const static UCHAR GUIDE       = 27;
 129     const static UCHAR UP          = 20;
 130     const static UCHAR DOWN        = 21;
 131     const static UCHAR LEFT        = 22;
 132     const static UCHAR RIGHT       = 23;
 133     const static UCHAR PREVCHANNEL = 18;
 134     const static UCHAR STAR        = 10;
 135     const static UCHAR HASH        = 14;
 136
 137     // Android only
 138     const static UCHAR PLAYPAUSE   = 201;
 139     // cec only
 140     const static UCHAR POWERON     = 202;
 141     const static UCHAR POWEROFF    = 203;
 142
 143   protected:
 144     virtual const char* modName()=0;
 145     RemoteTranslationList translist;
 146     int learnMode{NOLEARNMODE};
 147
 148     virtual UCHAR TranslateHWCFixed(HWC_TYPE code) = 0;
 149     UCHAR TranslateHWCList(HWC_TYPE code);
 150     UCHAR TranslateHWC(HWC_TYPE code);
 151 };
 152
 153 #endif