vdr  2.4.7
menu.h
Go to the documentation of this file.
1 /*
2  * menu.h: The actual menu implementations
3  *
4  * See the main source file 'vdr.c' for copyright information and
5  * how to reach the author.
6  *
7  * $Id: menu.h 4.8 2018/04/14 10:24:41 kls Exp $
8  */
9 
10 #ifndef __MENU_H
11 #define __MENU_H
12 
13 #include "ci.h"
14 #include "device.h"
15 #include "epg.h"
16 #include "osdbase.h"
17 #include "dvbplayer.h"
18 #include "menuitems.h"
19 #include "recorder.h"
20 #include "skins.h"
21 
22 class cMenuText : public cOsdMenu {
23 private:
24  char *text;
26 public:
27  cMenuText(const char *Title, const char *Text, eDvbFont Font = fontOsd);
28  virtual ~cMenuText();
29  void SetText(const char *Text);
30  virtual void Display(void);
31  virtual eOSState ProcessKey(eKeys Key);
32  };
33 
34 class cMenuFolder : public cOsdMenu {
35 private:
40  bool editing;
41  int helpKeys;
42  void SetHelpKeys(void);
43  void Set(const char *CurrentFolder = NULL);
44  void DescendPath(const char *Path);
45  eOSState SetFolder(void);
46  eOSState Select(bool Open);
47  eOSState New(void);
48  eOSState Delete(void);
49  eOSState Edit(void);
50  cMenuFolder(const char *Title, cList<cNestedItem> *List, cNestedItemList *NestedItemList, const char *Dir, const char *Path = NULL);
51 public:
52  cMenuFolder(const char *Title, cNestedItemList *NestedItemList, const char *Path = NULL);
53  cString GetFolder(void);
54  virtual eOSState ProcessKey(eKeys Key);
55  };
56 
57 class cMenuCommands : public cOsdMenu {
58 private:
63  bool confirm;
64  char *result;
65  bool Parse(const char *s);
66  eOSState Execute(void);
67 public:
68  cMenuCommands(const char *Title, cList<cNestedItem> *Commands, const char *Parameters = NULL);
69  virtual ~cMenuCommands();
70  virtual eOSState ProcessKey(eKeys Key);
71  };
72 
73 class cMenuEditTimer : public cOsdMenu {
74 private:
75  static const cTimer *addedTimer;
78  int channel;
81  char remote[HOST_NAME_MAX];
85  eOSState SetFolder(void);
86  void SetFirstDayItem(void);
87  void SetHelpKeys(void);
88 public:
89  cMenuEditTimer(cTimer *Timer, bool New = false);
90  virtual ~cMenuEditTimer();
91  virtual eOSState ProcessKey(eKeys Key);
92  static const cTimer *AddedTimer(void);
93  };
94 
95 class cMenuEvent : public cOsdMenu {
96 private:
97  const cEvent *event;
98 public:
99  cMenuEvent(const cTimers *Timers, const cChannels *Channels, const cEvent *Event, bool CanSwitch = false, bool Buttons = false);
100  virtual void Display(void);
101  virtual eOSState ProcessKey(eKeys Key);
102  };
103 
104 class cMenuMain : public cOsdMenu {
105 private:
106  bool replaying;
112  void Set(void);
113  bool Update(bool Force = false);
114 public:
115  cMenuMain(eOSState State = osUnknown, bool OpenSubMenus = false);
116  virtual eOSState ProcessKey(eKeys Key);
117  static cOsdObject *PluginOsdObject(void);
118  };
119 
120 class cDisplayChannel : public cOsdObject {
121 private:
123  int group;
124  bool withInfo;
126  int number;
127  bool timeout;
128  int osdState;
134  void DisplayChannel(void);
135  void DisplayInfo(void);
136  void Refresh(void);
137  const cChannel *NextAvailableChannel(const cChannel *Channel, int Direction);
138 public:
139  cDisplayChannel(int Number, bool Switched);
140  cDisplayChannel(eKeys FirstKey);
141  virtual ~cDisplayChannel();
142  virtual eOSState ProcessKey(eKeys Key);
143  static bool IsOpen(void) { return currentDisplayChannel != NULL; }
144  };
145 
146 class cDisplayVolume : public cOsdObject {
147 private:
151  virtual void Show(void);
152  cDisplayVolume(void);
153 public:
154  virtual ~cDisplayVolume();
155  static cDisplayVolume *Create(void);
156  static void Process(eKeys Key);
158  };
159 
160 class cDisplayTracks : public cOsdObject {
161 private:
165  char *descriptions[ttMaxTrackTypes + 1]; // list is NULL terminated
168  virtual void Show(void);
169  cDisplayTracks(void);
170 public:
171  virtual ~cDisplayTracks();
172  static bool IsOpen(void) { return currentDisplayTracks != NULL; }
173  static cDisplayTracks *Create(void);
174  static void Process(eKeys Key);
176  };
177 
179 private:
183  char *descriptions[ttMaxTrackTypes + 1]; // list is NULL terminated
186  virtual void Show(void);
188 public:
189  virtual ~cDisplaySubtitleTracks();
190  static bool IsOpen(void) { return currentDisplayTracks != NULL; }
191  static cDisplaySubtitleTracks *Create(void);
192  static void Process(eKeys Key);
194  };
195 
196 cOsdObject *CamControl(void);
197 bool CamMenuActive(void);
198 
200 public:
201  virtual ~cRecordingFilter(void) {};
202  virtual bool Filter(const cRecording *Recording) const = 0;
204  };
205 
206 class cMenuRecordingItem;
207 
208 class cMenuRecordings : public cOsdMenu {
209 private:
210  char *base;
211  int level;
213  int helpKeys;
215  static cString path;
217  void SetHelpKeys(void);
218  void Set(bool Refresh = false);
219  bool Open(bool OpenSubMenus = false);
220  eOSState Play(void);
221  eOSState Rewind(void);
222  eOSState Delete(void);
223  eOSState Info(void);
224  eOSState Sort(void);
225  eOSState Commands(eKeys Key = kNone);
226 protected:
227  cString DirectoryName(void);
228 public:
229  cMenuRecordings(const char *Base = NULL, int Level = 0, bool OpenSubMenus = false, const cRecordingFilter *Filter = NULL);
231  virtual eOSState ProcessKey(eKeys Key);
232  static void SetPath(const char *Path);
233  static void SetRecording(const char *FileName);
234  };
235 
237 private:
241  const cEvent *event;
243  char *fileName;
244  bool GetEvent(void);
245 public:
246  cRecordControl(cDevice *Device, cTimers *Timers, cTimer *Timer = NULL, bool Pause = false);
247  virtual ~cRecordControl();
248  bool Process(time_t t);
249  cDevice *Device(void) { return device; }
250  void Stop(bool ExecuteUserCommand = true);
251  const char *InstantId(void) { return instantId; }
252  const char *FileName(void) { return fileName; }
253  cTimer *Timer(void) { return timer; }
254  };
255 
257 private:
259  static int state;
260 public:
261  static bool Start(cTimers *Timers, cTimer *Timer, bool Pause = false);
262  static bool Start(bool Pause = false);
263  static void Stop(const char *InstantId);
264  static void Stop(cTimer *Timer);
265  static bool PauseLiveVideo(void);
266  static const char *GetInstantId(const char *LastInstantId);
267  static cRecordControl *GetRecordControl(const char *FileName);
268  static cRecordControl *GetRecordControl(const cTimer *Timer);
271  static bool Process(cTimers *Timers, time_t t);
272  static void ChannelDataModified(const cChannel *Channel);
273  static bool Active(void);
274  static void Shutdown(void);
275  static void ChangeState(void) { state++; }
276  static bool StateChanged(int &State);
277  };
278 
280 private:
286 public:
287  cAdaptiveSkipper(void);
288  void Initialize(int *InitialValue, double FramesPerSecond);
289  int GetValue(eKeys Key);
290  };
291 
293 private:
302  time_t timeoutShow;
306  void TimeSearchDisplay(void);
307  void TimeSearchProcess(eKeys Key);
308  void TimeSearch(void);
309  void ShowTimed(int Seconds = 0);
312  void ShowMode(void);
313  bool ShowProgress(bool Initial);
314  void MarkToggle(void);
315  void MarkJump(bool Forward);
316  void MarkMove(int Frames, bool MarkRequired);
317  void EditCut(void);
318  void EditTest(void);
319 public:
320  cReplayControl(bool PauseLive = false);
321  virtual ~cReplayControl();
322  void Stop(void);
323  virtual cOsdObject *GetInfo(void);
324  virtual const cRecording *GetRecording(void);
325  virtual eOSState ProcessKey(eKeys Key);
326  virtual void Show(void);
327  virtual void Hide(void);
328  bool Visible(void) { return visible; }
329  virtual void ClearEditingMarks(void);
330  static void SetRecording(const char *FileName);
331  static const char *NowReplaying(void);
332  static const char *LastReplayed(void);
333  static void ClearLastReplayed(const char *FileName);
334  };
335 
336 #endif //__MENU_H
double framesPerSecond
Definition: menu.h:283
cTimeMs timeout
Definition: menu.h:285
cAdaptiveSkipper(void)
Definition: menu.c:5658
eKeys lastKey
Definition: menu.h:284
void Initialize(int *InitialValue, double FramesPerSecond)
Definition: menu.c:5666
int * initialValue
Definition: menu.h:281
int currentValue
Definition: menu.h:282
int GetValue(eKeys Key)
Definition: menu.c:5673
cTimeMs lastTime
Definition: menu.h:125
const cChannel * channel
Definition: menu.h:130
static bool IsOpen(void)
Definition: menu.h:143
const cEvent * lastPresent
Definition: menu.h:131
void DisplayChannel(void)
Definition: menu.c:4785
virtual ~cDisplayChannel()
Definition: menu.c:4778
const cEvent * lastFollowing
Definition: menu.h:132
bool timeout
Definition: menu.h:127
cSkinDisplayChannel * displayChannel
Definition: menu.h:122
bool withInfo
Definition: menu.h:124
void Refresh(void)
Definition: menu.c:4812
int number
Definition: menu.h:126
int osdState
Definition: menu.h:128
const cPositioner * positioner
Definition: menu.h:129
static cDisplayChannel * currentDisplayChannel
Definition: menu.h:133
void DisplayInfo(void)
Definition: menu.c:4793
virtual eOSState ProcessKey(eKeys Key)
Definition: menu.c:4835
cDisplayChannel(int Number, bool Switched)
Definition: menu.c:4731
const cChannel * NextAvailableChannel(const cChannel *Channel, int Direction)
Definition: menu.c:4818
cSkinDisplayTracks * displayTracks
Definition: menu.h:180
cDisplaySubtitleTracks(void)
Definition: menu.c:5218
static void Process(eKeys Key)
Definition: menu.c:5271
char * descriptions[ttMaxTrackTypes+1]
Definition: menu.h:183
eTrackType types[ttMaxTrackTypes]
Definition: menu.h:182
static bool IsOpen(void)
Definition: menu.h:190
virtual void Show(void)
Definition: menu.c:5253
static cDisplaySubtitleTracks * currentDisplayTracks
Definition: menu.h:185
virtual ~cDisplaySubtitleTracks()
Definition: menu.c:5244
static cDisplaySubtitleTracks * Create(void)
Definition: menu.c:5260
eOSState ProcessKey(eKeys Key)
Definition: menu.c:5277
char * descriptions[ttMaxTrackTypes+1]
Definition: menu.h:165
static cDisplayTracks * Create(void)
Definition: menu.c:5142
int track
Definition: menu.h:166
cDisplayTracks(void)
Definition: menu.c:5098
cTimeMs timeout
Definition: menu.h:163
virtual void Show(void)
Definition: menu.c:5132
virtual ~cDisplayTracks()
Definition: menu.c:5123
eOSState ProcessKey(eKeys Key)
Definition: menu.c:5159
static cDisplayTracks * currentDisplayTracks
Definition: menu.h:167
cSkinDisplayTracks * displayTracks
Definition: menu.h:162
int numTracks
Definition: menu.h:166
int audioChannel
Definition: menu.h:166
static void Process(eKeys Key)
Definition: menu.c:5153
static bool IsOpen(void)
Definition: menu.h:172
eTrackType types[ttMaxTrackTypes]
Definition: menu.h:164
static cDisplayVolume * Create(void)
Definition: menu.c:5052
cSkinDisplayVolume * displayVolume
Definition: menu.h:148
virtual ~cDisplayVolume()
Definition: menu.c:5041
eOSState ProcessKey(eKeys Key)
Definition: menu.c:5065
cTimeMs timeout
Definition: menu.h:149
static void Process(eKeys Key)
Definition: menu.c:5059
virtual void Show(void)
Definition: menu.c:5047
cDisplayVolume(void)
Definition: menu.c:5032
static cDisplayVolume * currentDisplayVolume
Definition: menu.h:150
void Forward(void)
Definition: dvbplayer.c:1023
Definition: epg.h:71
eOSState Execute(void)
Definition: menu.c:2180
cList< cNestedItem > * commands
Definition: menu.h:59
bool confirm
Definition: menu.h:63
cMenuCommands(const char *Title, cList< cNestedItem > *Commands, const char *Parameters=NULL)
Definition: menu.c:2135
virtual ~cMenuCommands()
Definition: menu.c:2152
cString title
Definition: menu.h:61
cString command
Definition: menu.h:62
virtual eOSState ProcessKey(eKeys Key)
Definition: menu.c:2227
bool Parse(const char *s)
Definition: menu.c:2157
char * result
Definition: menu.h:64
cString parameters
Definition: menu.h:60
bool addIfConfirmed
Definition: menu.h:79
virtual eOSState ProcessKey(eKeys Key)
Definition: menu.c:1101
eOSState SetFolder(void)
Definition: menu.c:1066
cMenuEditDateItem * firstday
Definition: menu.h:84
static const cTimer * addedTimer
Definition: menu.h:75
int channel
Definition: menu.h:78
cTimer data
Definition: menu.h:77
void SetHelpKeys(void)
Definition: menu.c:1048
cMenuEditStrItem * file
Definition: menu.h:82
cMenuEditDateItem * day
Definition: menu.h:83
static const cTimer * AddedTimer(void)
Definition: menu.c:1041
cTimer * timer
Definition: menu.h:76
cMenuEditTimer(cTimer *Timer, bool New=false)
Definition: menu.c:998
void SetFirstDayItem(void)
Definition: menu.c:1053
char remote[HOST_NAME_MAX]
Definition: menu.h:81
cStringList svdrpServerNames
Definition: menu.h:80
virtual ~cMenuEditTimer()
Definition: menu.c:1035
const cEvent * event
Definition: menu.h:97
virtual eOSState ProcessKey(eKeys Key)
Definition: menu.c:1464
virtual void Display(void)
Definition: menu.c:1456
cMenuEvent(const cTimers *Timers, const cChannels *Channels, const cEvent *Event, bool CanSwitch=false, bool Buttons=false)
Definition: menu.c:1439
cMenuFolder(const char *Title, cList< cNestedItem > *List, cNestedItemList *NestedItemList, const char *Dir, const char *Path=NULL)
Definition: menu.c:792
virtual eOSState ProcessKey(eKeys Key)
Definition: menu.c:972
eOSState Delete(void)
Definition: menu.c:920
int helpKeys
Definition: menu.h:41
eOSState New(void)
Definition: menu.c:914
cNestedItemList * nestedItemList
Definition: menu.h:36
cList< cNestedItem > * list
Definition: menu.h:37
eOSState SetFolder(void)
Definition: menu.c:948
cString dir
Definition: menu.h:38
void Set(const char *CurrentFolder=NULL)
Definition: menu.c:856
void DescendPath(const char *Path)
Definition: menu.c:881
cOsdItem * firstFolder
Definition: menu.h:39
eOSState Edit(void)
Definition: menu.c:936
eOSState Select(bool Open)
Definition: menu.c:898
bool editing
Definition: menu.h:40
cString GetFolder(void)
Definition: menu.c:959
void SetHelpKeys(void)
Definition: menu.c:808
cOsdItem * cancelEditingItem
Definition: menu.h:108
cOsdItem * stopRecordingItem
Definition: menu.h:109
void Set(void)
Definition: menu.c:4485
int recordControlsState
Definition: menu.h:110
bool replaying
Definition: menu.h:106
cOsdItem * stopReplayItem
Definition: menu.h:107
bool Update(bool Force=false)
Definition: menu.c:4522
virtual eOSState ProcessKey(eKeys Key)
Definition: menu.c:4580
cMenuMain(eOSState State=osUnknown, bool OpenSubMenus=false)
Definition: menu.c:4439
static cOsdObject * pluginOsdObject
Definition: menu.h:111
static cOsdObject * PluginOsdObject(void)
Definition: menu.c:4478
static cString path
Definition: menu.h:215
void Set(bool Refresh=false)
Definition: menu.c:3066
bool Open(bool OpenSubMenus=false)
Definition: menu.c:3146
eOSState Sort(void)
Definition: menu.c:3317
static void SetRecording(const char *FileName)
Definition: menu.c:3130
eOSState Info(void)
Definition: menu.c:3289
eOSState Play(void)
Definition: menu.c:3162
const cRecordingFilter * filter
Definition: menu.h:214
static cString fileName
Definition: menu.h:216
char * base
Definition: menu.h:210
int helpKeys
Definition: menu.h:213
eOSState Rewind(void)
Definition: menu.c:3176
static void SetPath(const char *Path)
Definition: menu.c:3125
cStateKey recordingsStateKey
Definition: menu.h:212
cMenuRecordings(const char *Base=NULL, int Level=0, bool OpenSubMenus=false, const cRecordingFilter *Filter=NULL)
Definition: menu.c:3014
virtual eOSState ProcessKey(eKeys Key)
Definition: menu.c:3329
eOSState Commands(eKeys Key=kNone)
Definition: menu.c:3302
cString DirectoryName(void)
Definition: menu.c:3135
~cMenuRecordings()
Definition: menu.c:3036
void SetHelpKeys(void)
Definition: menu.c:3045
eOSState Delete(void)
Definition: menu.c:3242
Definition: menu.h:22
eDvbFont font
Definition: menu.h:25
void SetText(const char *Text)
Definition: menu.c:629
virtual void Display(void)
Definition: menu.c:635
cMenuText(const char *Title, const char *Text, eDvbFont Font=fontOsd)
Definition: menu.c:615
virtual ~cMenuText()
Definition: menu.c:624
char * text
Definition: menu.h:24
virtual eOSState ProcessKey(eKeys Key)
Definition: menu.c:643
const char * Title(void)
Definition: osdbase.h:112
A steerable satellite dish generally points to the south on the northern hemisphere,...
Definition: positioner.h:31
cDevice * Device(void)
Definition: menu.h:249
virtual ~cRecordControl()
Definition: menu.c:5397
void Stop(bool ExecuteUserCommand=true)
Definition: menu.c:5429
cDevice * device
Definition: menu.h:238
cTimer * timer
Definition: menu.h:239
bool GetEvent(void)
Definition: menu.c:5405
char * fileName
Definition: menu.h:243
const char * InstantId(void)
Definition: menu.h:251
cRecorder * recorder
Definition: menu.h:240
const char * FileName(void)
Definition: menu.h:252
cTimer * Timer(void)
Definition: menu.h:253
cRecordControl(cDevice *Device, cTimers *Timers, cTimer *Timer=NULL, bool Pause=false)
Definition: menu.c:5315
const cEvent * event
Definition: menu.h:241
bool Process(time_t t)
Definition: menu.c:5442
cString instantId
Definition: menu.h:242
static bool StateChanged(int &State)
Definition: menu.c:5648
static const char * GetInstantId(const char *LastInstantId)
Definition: menu.c:5567
static void ChannelDataModified(const cChannel *Channel)
Definition: menu.c:5615
static bool Process(cTimers *Timers, time_t t)
Definition: menu.c:5600
static bool PauseLiveVideo(void)
Definition: menu.c:5552
static void Shutdown(void)
Definition: menu.c:5641
static bool Start(cTimers *Timers, cTimer *Timer, bool Pause=false)
Definition: menu.c:5457
static cRecordControl * RecordControls[]
Definition: menu.h:258
static bool Active(void)
Definition: menu.c:5632
static void Stop(const char *InstantId)
Definition: menu.c:5519
static cRecordControl * GetRecordControl(const char *FileName)
Definition: menu.c:5580
static int state
Definition: menu.h:259
static void ChangeState(void)
Definition: menu.h:275
virtual bool Filter(const cRecording *Recording) const =0
Returns true if the given Recording shall be displayed in the Recordings menu.
virtual ~cRecordingFilter(void)
Definition: menu.h:201
static void SetRecording(const char *FileName)
Definition: menu.c:5784
static const char * LastReplayed(void)
Definition: menu.c:5794
void MarkToggle(void)
Definition: menu.c:5999
static cString fileName
Definition: menu.h:311
void TimeSearchDisplay(void)
Definition: menu.c:5909
static void ClearLastReplayed(const char *FileName)
Definition: menu.c:5802
int lastTotal
Definition: menu.h:299
void MarkMove(int Frames, bool MarkRequired)
Definition: menu.c:6049
static cReplayControl * currentReplayControl
Definition: menu.h:310
virtual eOSState ProcessKey(eKeys Key)
Definition: menu.c:6141
bool timeSearchHide
Definition: menu.h:304
void TimeSearchProcess(eKeys Key)
Definition: menu.c:5927
void MarkJump(bool Forward)
Definition: menu.c:6024
cMarks marks
Definition: menu.h:296
void EditCut(void)
Definition: menu.c:6087
int timeSearchTime
Definition: menu.h:305
bool Visible(void)
Definition: menu.h:328
cSkinDisplayReplay * displayReplay
Definition: menu.h:294
void Stop(void)
Definition: menu.c:5728
void ShowTimed(int Seconds=0)
Definition: menu.c:5808
virtual const cRecording * GetRecording(void)
Returns the cRecording that is currently being replayed, or NULL if this player is not playing a cRec...
Definition: menu.c:6133
virtual void ClearEditingMarks(void)
Clears any editing marks this player might be showing.
Definition: menu.c:5774
bool lastForward
Definition: menu.h:300
bool displayFrames
Definition: menu.h:298
bool shown
Definition: menu.h:298
time_t timeoutShow
Definition: menu.h:302
void EditTest(void)
Definition: menu.c:6109
bool timeSearchActive
Definition: menu.h:304
virtual void Hide(void)
Definition: menu.c:5825
bool ShowProgress(bool Initial)
Definition: menu.c:5869
bool marksModified
Definition: menu.h:297
int lastSpeed
Definition: menu.h:301
cAdaptiveSkipper adaptiveSkipper
Definition: menu.h:295
bool lastPlay
Definition: menu.h:300
int timeSearchPos
Definition: menu.h:305
virtual cOsdObject * GetInfo(void)
Returns an OSD object that displays information about the currently played programme.
Definition: menu.c:6125
void ShowMode(void)
Definition: menu.c:5844
virtual ~cReplayControl()
Definition: menu.c:5720
virtual void Show(void)
Definition: menu.c:5820
cTimeMs updateTimer
Definition: menu.h:303
void TimeSearch(void)
Definition: menu.c:5981
bool visible
Definition: menu.h:298
bool modeOnly
Definition: menu.h:298
static const char * NowReplaying(void)
Definition: menu.c:5789
cReplayControl(bool PauseLive=false)
Definition: menu.c:5697
int lastCurrent
Definition: menu.h:299
Definition: tools.h:174
Definition: tools.h:367
Definition: timers.h:27
cNestedItemList Commands
Definition: config.c:275
eTrackType
Definition: device.h:63
@ ttMaxTrackTypes
Definition: device.h:73
eDvbFont
Definition: font.h:21
@ fontOsd
Definition: font.h:22
eKeys
Definition: keys.h:16
@ kNone
Definition: keys.h:55
bool CamMenuActive(void)
Definition: menu.c:2439
cOsdObject * CamControl(void)
Definition: menu.c:2430
eOSState
Definition: osdbase.h:18
@ osUnknown
Definition: osdbase.h:18
static const cCursesFont Font
Definition: skincurses.c:31
Definition: runvdr.c:107