vdr  2.6.9
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 5.2 2024/06/25 19:00:06 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];
86  eOSState SetFolder(void);
87  void SetFirstDayItem(void);
88  void SetPatternItem(bool Initial = false);
89  void SetHelpKeys(void);
90 public:
91  cMenuEditTimer(cTimer *Timer, bool New = false);
92  virtual ~cMenuEditTimer();
93  virtual eOSState ProcessKey(eKeys Key);
94  static const cTimer *AddedTimer(void);
95  };
96 
97 class cMenuEvent : public cOsdMenu {
98 private:
99  const cEvent *event;
100 public:
101  cMenuEvent(const cTimers *Timers, const cChannels *Channels, const cEvent *Event, bool CanSwitch = false, bool Buttons = false);
102  virtual void Display(void);
103  virtual eOSState ProcessKey(eKeys Key);
104  };
105 
106 class cMenuMain : public cOsdMenu {
107 private:
108  bool replaying;
114  void Set(void);
115  bool Update(bool Force = false);
116 public:
117  cMenuMain(eOSState State = osUnknown, bool OpenSubMenus = false);
118  virtual eOSState ProcessKey(eKeys Key);
119  static cOsdObject *PluginOsdObject(void);
120  };
121 
122 class cDisplayChannel : public cOsdObject {
123 private:
125  int group;
126  bool withInfo;
128  int number;
129  bool timeout;
130  int osdState;
136  void DisplayChannel(void);
137  void DisplayInfo(void);
138  void Refresh(void);
139  const cChannel *NextAvailableChannel(const cChannel *Channel, int Direction);
140 public:
141  cDisplayChannel(int Number, bool Switched);
142  cDisplayChannel(eKeys FirstKey);
143  virtual ~cDisplayChannel();
144  virtual eOSState ProcessKey(eKeys Key);
145  static bool IsOpen(void) { return currentDisplayChannel != NULL; }
146  };
147 
148 class cDisplayVolume : public cOsdObject {
149 private:
153  virtual void Show(void);
154  cDisplayVolume(void);
155 public:
156  virtual ~cDisplayVolume();
157  static cDisplayVolume *Create(void);
158  static void Process(eKeys Key);
160  };
161 
162 class cDisplayTracks : public cOsdObject {
163 private:
167  char *descriptions[ttMaxTrackTypes + 1]; // list is NULL terminated
170  virtual void Show(void);
171  cDisplayTracks(void);
172 public:
173  virtual ~cDisplayTracks();
174  static bool IsOpen(void) { return currentDisplayTracks != NULL; }
175  static cDisplayTracks *Create(void);
176  static void Process(eKeys Key);
178  };
179 
181 private:
185  char *descriptions[ttMaxTrackTypes + 1]; // list is NULL terminated
188  virtual void Show(void);
190 public:
191  virtual ~cDisplaySubtitleTracks();
192  static bool IsOpen(void) { return currentDisplayTracks != NULL; }
193  static cDisplaySubtitleTracks *Create(void);
194  static void Process(eKeys Key);
196  };
197 
198 cOsdObject *CamControl(void);
199 bool CamMenuActive(void);
200 
202 public:
203  virtual ~cRecordingFilter(void) {};
204  virtual bool Filter(const cRecording *Recording) const = 0;
206  };
207 
208 class cMenuRecordingItem;
209 
210 class cMenuRecordings : public cOsdMenu {
211 private:
212  char *base;
213  int level;
215  int helpKeys;
217  static cString path;
219  void SetHelpKeys(void);
220  void Set(bool Refresh = false);
221  bool Open(bool OpenSubMenus = false);
222  eOSState Play(void);
223  eOSState Rewind(void);
224  eOSState Delete(void);
225  eOSState Info(void);
226  eOSState Sort(void);
227  eOSState Commands(eKeys Key = kNone);
228 protected:
229  cString DirectoryName(void);
230 public:
231  cMenuRecordings(const char *Base = NULL, int Level = 0, bool OpenSubMenus = false, const cRecordingFilter *Filter = NULL);
233  virtual eOSState ProcessKey(eKeys Key);
234  static void SetRecording(const char *FileName);
235  };
236 
238 private:
242  const cEvent *event;
244  char *fileName;
245  bool GetEvent(void);
246 public:
247  cRecordControl(cDevice *Device, cTimers *Timers, cTimer *Timer = NULL, bool Pause = false);
248  virtual ~cRecordControl();
249  bool Process(time_t t);
250  cDevice *Device(void) { return device; }
251  void Stop(bool ExecuteUserCommand = true);
252  const char *InstantId(void) { return instantId; }
253  const char *FileName(void) { return fileName; }
254  cTimer *Timer(void) { return timer; }
255  };
256 
258 private:
260  static int state;
261 public:
262  static bool Start(cTimers *Timers, cTimer *Timer, bool Pause = false);
263  static bool Start(bool Pause = false);
264  static void Stop(const char *InstantId);
265  static void Stop(cTimer *Timer);
266  static bool PauseLiveVideo(void);
267  static const char *GetInstantId(const char *LastInstantId);
268  static cRecordControl *GetRecordControl(const char *FileName);
269  static cRecordControl *GetRecordControl(const cTimer *Timer);
272  static bool Process(cTimers *Timers, time_t t);
273  static void ChannelDataModified(const cChannel *Channel);
274  static bool Active(void);
275  static void Shutdown(void);
276  static void ChangeState(void) { state++; }
277  static bool StateChanged(int &State);
278  };
279 
281 private:
287 public:
288  cAdaptiveSkipper(void);
289  void Initialize(int *InitialValue, double FramesPerSecond);
290  int GetValue(eKeys Key);
291  };
292 
294 private:
303  time_t timeoutShow;
307  void TimeSearchDisplay(void);
308  void TimeSearchProcess(eKeys Key);
309  void TimeSearch(void);
310  void ShowTimed(int Seconds = 0);
313  void ShowMode(void);
314  bool ShowProgress(bool Initial);
315  void MarkToggle(void);
316  void MarkJump(bool Forward);
317  void MarkMove(int Frames, bool MarkRequired);
318  void EditCut(void);
319  void EditTest(void);
320 public:
321  cReplayControl(bool PauseLive = false);
322  virtual ~cReplayControl();
323  void Stop(void);
324  virtual cOsdObject *GetInfo(void);
325  virtual const cRecording *GetRecording(void);
326  virtual eOSState ProcessKey(eKeys Key);
327  virtual void Show(void);
328  virtual void Hide(void);
329  bool Visible(void) { return visible; }
330  virtual void ClearEditingMarks(void);
331  static void SetRecording(const char *FileName);
332  static const char *NowReplaying(void);
333  static const char *LastReplayed(void);
334  static void ClearLastReplayed(const char *FileName);
335  };
336 
337 #endif //__MENU_H
double framesPerSecond
Definition: menu.h:284
cTimeMs timeout
Definition: menu.h:286
cAdaptiveSkipper(void)
Definition: menu.c:5750
eKeys lastKey
Definition: menu.h:285
void Initialize(int *InitialValue, double FramesPerSecond)
Definition: menu.c:5758
int * initialValue
Definition: menu.h:282
int currentValue
Definition: menu.h:283
int GetValue(eKeys Key)
Definition: menu.c:5765
cTimeMs lastTime
Definition: menu.h:127
const cChannel * channel
Definition: menu.h:132
static bool IsOpen(void)
Definition: menu.h:145
const cEvent * lastPresent
Definition: menu.h:133
void DisplayChannel(void)
Definition: menu.c:4868
virtual ~cDisplayChannel()
Definition: menu.c:4861
const cEvent * lastFollowing
Definition: menu.h:134
bool timeout
Definition: menu.h:129
cSkinDisplayChannel * displayChannel
Definition: menu.h:124
bool withInfo
Definition: menu.h:126
void Refresh(void)
Definition: menu.c:4895
int number
Definition: menu.h:128
int osdState
Definition: menu.h:130
const cPositioner * positioner
Definition: menu.h:131
static cDisplayChannel * currentDisplayChannel
Definition: menu.h:135
void DisplayInfo(void)
Definition: menu.c:4876
virtual eOSState ProcessKey(eKeys Key)
Definition: menu.c:4918
cDisplayChannel(int Number, bool Switched)
Definition: menu.c:4814
const cChannel * NextAvailableChannel(const cChannel *Channel, int Direction)
Definition: menu.c:4901
cSkinDisplayTracks * displayTracks
Definition: menu.h:182
cDisplaySubtitleTracks(void)
Definition: menu.c:5301
static void Process(eKeys Key)
Definition: menu.c:5354
char * descriptions[ttMaxTrackTypes+1]
Definition: menu.h:185
eTrackType types[ttMaxTrackTypes]
Definition: menu.h:184
static bool IsOpen(void)
Definition: menu.h:192
virtual void Show(void)
Definition: menu.c:5336
static cDisplaySubtitleTracks * currentDisplayTracks
Definition: menu.h:187
virtual ~cDisplaySubtitleTracks()
Definition: menu.c:5327
static cDisplaySubtitleTracks * Create(void)
Definition: menu.c:5343
eOSState ProcessKey(eKeys Key)
Definition: menu.c:5360
char * descriptions[ttMaxTrackTypes+1]
Definition: menu.h:167
static cDisplayTracks * Create(void)
Definition: menu.c:5225
int track
Definition: menu.h:168
cDisplayTracks(void)
Definition: menu.c:5181
cTimeMs timeout
Definition: menu.h:165
virtual void Show(void)
Definition: menu.c:5215
virtual ~cDisplayTracks()
Definition: menu.c:5206
eOSState ProcessKey(eKeys Key)
Definition: menu.c:5242
static cDisplayTracks * currentDisplayTracks
Definition: menu.h:169
cSkinDisplayTracks * displayTracks
Definition: menu.h:164
int numTracks
Definition: menu.h:168
int audioChannel
Definition: menu.h:168
static void Process(eKeys Key)
Definition: menu.c:5236
static bool IsOpen(void)
Definition: menu.h:174
eTrackType types[ttMaxTrackTypes]
Definition: menu.h:166
static cDisplayVolume * Create(void)
Definition: menu.c:5135
cSkinDisplayVolume * displayVolume
Definition: menu.h:150
virtual ~cDisplayVolume()
Definition: menu.c:5124
eOSState ProcessKey(eKeys Key)
Definition: menu.c:5148
cTimeMs timeout
Definition: menu.h:151
static void Process(eKeys Key)
Definition: menu.c:5142
virtual void Show(void)
Definition: menu.c:5130
cDisplayVolume(void)
Definition: menu.c:5115
static cDisplayVolume * currentDisplayVolume
Definition: menu.h:152
void Forward(void)
Definition: dvbplayer.c:1025
Definition: epg.h:73
eOSState Execute(void)
Definition: menu.c:2240
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:2195
virtual ~cMenuCommands()
Definition: menu.c:2212
cString title
Definition: menu.h:61
cString command
Definition: menu.h:62
virtual eOSState ProcessKey(eKeys Key)
Definition: menu.c:2287
bool Parse(const char *s)
Definition: menu.c:2217
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:1146
eOSState SetFolder(void)
Definition: menu.c:1115
cMenuEditDateItem * firstday
Definition: menu.h:85
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:1067
cMenuEditStrItem * file
Definition: menu.h:83
cMenuEditStrItem * pattern
Definition: menu.h:82
cMenuEditDateItem * day
Definition: menu.h:84
static const cTimer * AddedTimer(void)
Definition: menu.c:1060
cTimer * timer
Definition: menu.h:76
cMenuEditTimer(cTimer *Timer, bool New=false)
Definition: menu.c:1015
void SetFirstDayItem(void)
Definition: menu.c:1072
char remote[HOST_NAME_MAX]
Definition: menu.h:81
cStringList svdrpServerNames
Definition: menu.h:80
void SetPatternItem(bool Initial=false)
Definition: menu.c:1085
virtual ~cMenuEditTimer()
Definition: menu.c:1054
const cEvent * event
Definition: menu.h:99
virtual eOSState ProcessKey(eKeys Key)
Definition: menu.c:1522
virtual void Display(void)
Definition: menu.c:1514
cMenuEvent(const cTimers *Timers, const cChannels *Channels, const cEvent *Event, bool CanSwitch=false, bool Buttons=false)
Definition: menu.c:1497
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:110
cOsdItem * stopRecordingItem
Definition: menu.h:111
void Set(void)
Definition: menu.c:4568
int recordControlsState
Definition: menu.h:112
bool replaying
Definition: menu.h:108
cOsdItem * stopReplayItem
Definition: menu.h:109
bool Update(bool Force=false)
Definition: menu.c:4605
virtual eOSState ProcessKey(eKeys Key)
Definition: menu.c:4663
cMenuMain(eOSState State=osUnknown, bool OpenSubMenus=false)
Definition: menu.c:4521
static cOsdObject * pluginOsdObject
Definition: menu.h:113
static cOsdObject * PluginOsdObject(void)
Definition: menu.c:4561
static cString path
Definition: menu.h:217
void Set(bool Refresh=false)
Definition: menu.c:3144
bool Open(bool OpenSubMenus=false)
Definition: menu.c:3219
eOSState Sort(void)
Definition: menu.c:3390
static void SetRecording(const char *FileName)
Definition: menu.c:3203
eOSState Info(void)
Definition: menu.c:3362
eOSState Play(void)
Definition: menu.c:3235
const cRecordingFilter * filter
Definition: menu.h:216
static cString fileName
Definition: menu.h:218
char * base
Definition: menu.h:212
int helpKeys
Definition: menu.h:215
eOSState Rewind(void)
Definition: menu.c:3249
cStateKey recordingsStateKey
Definition: menu.h:214
cMenuRecordings(const char *Base=NULL, int Level=0, bool OpenSubMenus=false, const cRecordingFilter *Filter=NULL)
Definition: menu.c:3093
virtual eOSState ProcessKey(eKeys Key)
Definition: menu.c:3402
eOSState Commands(eKeys Key=kNone)
Definition: menu.c:3375
cString DirectoryName(void)
Definition: menu.c:3208
~cMenuRecordings()
Definition: menu.c:3114
void SetHelpKeys(void)
Definition: menu.c:3123
eOSState Delete(void)
Definition: menu.c:3315
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:250
virtual ~cRecordControl()
Definition: menu.c:5480
void Stop(bool ExecuteUserCommand=true)
Definition: menu.c:5512
cDevice * device
Definition: menu.h:239
cTimer * timer
Definition: menu.h:240
bool GetEvent(void)
Definition: menu.c:5488
char * fileName
Definition: menu.h:244
const char * InstantId(void)
Definition: menu.h:252
cRecorder * recorder
Definition: menu.h:241
const char * FileName(void)
Definition: menu.h:253
cTimer * Timer(void)
Definition: menu.h:254
cRecordControl(cDevice *Device, cTimers *Timers, cTimer *Timer=NULL, bool Pause=false)
Definition: menu.c:5398
const cEvent * event
Definition: menu.h:242
bool Process(time_t t)
Definition: menu.c:5534
cString instantId
Definition: menu.h:243
static bool StateChanged(int &State)
Definition: menu.c:5740
static const char * GetInstantId(const char *LastInstantId)
Definition: menu.c:5659
static void ChannelDataModified(const cChannel *Channel)
Definition: menu.c:5707
static bool Process(cTimers *Timers, time_t t)
Definition: menu.c:5692
static bool PauseLiveVideo(void)
Definition: menu.c:5644
static void Shutdown(void)
Definition: menu.c:5733
static bool Start(cTimers *Timers, cTimer *Timer, bool Pause=false)
Definition: menu.c:5549
static cRecordControl * RecordControls[]
Definition: menu.h:259
static bool Active(void)
Definition: menu.c:5724
static void Stop(const char *InstantId)
Definition: menu.c:5611
static cRecordControl * GetRecordControl(const char *FileName)
Definition: menu.c:5672
static int state
Definition: menu.h:260
static void ChangeState(void)
Definition: menu.h:276
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:203
static void SetRecording(const char *FileName)
Definition: menu.c:5876
static const char * LastReplayed(void)
Definition: menu.c:5886
void MarkToggle(void)
Definition: menu.c:6091
static cString fileName
Definition: menu.h:312
void TimeSearchDisplay(void)
Definition: menu.c:6001
static void ClearLastReplayed(const char *FileName)
Definition: menu.c:5894
int lastTotal
Definition: menu.h:300
void MarkMove(int Frames, bool MarkRequired)
Definition: menu.c:6141
static cReplayControl * currentReplayControl
Definition: menu.h:311
virtual eOSState ProcessKey(eKeys Key)
Definition: menu.c:6235
bool timeSearchHide
Definition: menu.h:305
void TimeSearchProcess(eKeys Key)
Definition: menu.c:6019
void MarkJump(bool Forward)
Definition: menu.c:6116
cMarks marks
Definition: menu.h:297
void EditCut(void)
Definition: menu.c:6179
int timeSearchTime
Definition: menu.h:306
bool Visible(void)
Definition: menu.h:329
cSkinDisplayReplay * displayReplay
Definition: menu.h:295
void Stop(void)
Definition: menu.c:5820
void ShowTimed(int Seconds=0)
Definition: menu.c:5900
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:6227
virtual void ClearEditingMarks(void)
Clears any editing marks this player might be showing.
Definition: menu.c:5866
bool lastForward
Definition: menu.h:301
bool displayFrames
Definition: menu.h:299
bool shown
Definition: menu.h:299
time_t timeoutShow
Definition: menu.h:303
void EditTest(void)
Definition: menu.c:6203
bool timeSearchActive
Definition: menu.h:305
virtual void Hide(void)
Definition: menu.c:5917
bool ShowProgress(bool Initial)
Definition: menu.c:5961
bool marksModified
Definition: menu.h:298
int lastSpeed
Definition: menu.h:302
cAdaptiveSkipper adaptiveSkipper
Definition: menu.h:296
bool lastPlay
Definition: menu.h:301
int timeSearchPos
Definition: menu.h:306
virtual cOsdObject * GetInfo(void)
Returns an OSD object that displays information about the currently played programme.
Definition: menu.c:6219
void ShowMode(void)
Definition: menu.c:5936
virtual ~cReplayControl()
Definition: menu.c:5812
virtual void Show(void)
Definition: menu.c:5912
cTimeMs updateTimer
Definition: menu.h:304
void TimeSearch(void)
Definition: menu.c:6073
bool visible
Definition: menu.h:299
bool modeOnly
Definition: menu.h:299
static const char * NowReplaying(void)
Definition: menu.c:5881
cReplayControl(bool PauseLive=false)
Definition: menu.c:5789
int lastCurrent
Definition: menu.h:300
Definition: tools.h:178
Definition: tools.h:404
Definition: timers.h:31
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:2499
cOsdObject * CamControl(void)
Definition: menu.c:2490
eOSState
Definition: osdbase.h:18
@ osUnknown
Definition: osdbase.h:18
static const cCursesFont Font
Definition: skincurses.c:31
Definition: runvdr.c:107