vdr  2.6.1
timers.h
Go to the documentation of this file.
1 /*
2  * timers.h: Timer handling
3  *
4  * See the main source file 'vdr.c' for copyright information and
5  * how to reach the author.
6  *
7  * $Id: timers.h 5.8 2021/04/20 13:22:37 kls Exp $
8  */
9 
10 #ifndef __TIMERS_H
11 #define __TIMERS_H
12 
13 #include "channels.h"
14 #include "config.h"
15 #include "epg.h"
16 #include "tools.h"
17 
18 enum eTimerFlags { tfNone = 0x0000,
19  tfActive = 0x0001,
20  tfInstant = 0x0002,
21  tfVps = 0x0004,
22  tfRecording = 0x0008,
23  tfSpawned = 0x0010,
24  tfAvoid = 0x0020,
25  tfAll = 0xFFFF,
26  };
28 
29 class cTimers;
30 
31 class cTimer : public cListObject {
32  friend class cMenuEditTimer;
33 private:
34  int id;
35  mutable time_t startTime, stopTime;
39  mutable time_t deferred;
41  uint flags;
42  const cChannel *channel;
43  mutable time_t day;
44  int weekdays;
45  int start;
46  int stop;
47  int priority;
48  int lifetime;
49  mutable char pattern[NAME_MAX * 2 + 1]; // same size as 'file', to be able to initially fill 'pattern' with 'file' in the 'Edit timer' menu
50  mutable char file[NAME_MAX * 2 + 1]; // *2 to be able to hold 'title' and 'episode', which can each be up to 255 characters long
51  char *aux;
52  char *remote;
53  const cEvent *event;
54 public:
55  cTimer(bool Instant = false, bool Pause = false, const cChannel *Channel = NULL);
56  cTimer(const cEvent *Event, const char *FileName = NULL, const cTimer *PatternTimer = NULL);
57  cTimer(const cTimer &Timer);
58  virtual ~cTimer();
59  cTimer& operator= (const cTimer &Timer);
60  void CalcMargins(int &MarginStart, int &MarginStop, const cEvent *Event);
61  virtual int Compare(const cListObject &ListObject) const;
62  int Id(void) const { return id; }
63  bool Recording(void) const { return HasFlags(tfRecording); }
64  bool Pending(void) const { return pending; }
65  bool InVpsMargin(void) const { return inVpsMargin; }
66  uint Flags(void) const { return flags; }
67  const cChannel *Channel(void) const { return channel; }
68  time_t Day(void) const { return day; }
69  int WeekDays(void) const { return weekdays; }
70  int Start(void) const { return start; }
71  int Stop(void) const { return stop; }
72  int Priority(void) const { return priority; }
73  int Lifetime(void) const { return lifetime; }
74  const char *Pattern(void) const { return pattern; }
75  const char *File(void) const { return file; }
76  time_t FirstDay(void) const { return weekdays ? day : 0; }
77  const char *Aux(void) const { return aux; }
78  const char *Remote(void) const { return remote; }
79  bool Local(void) const { return !remote; } // convenience
80  time_t Deferred(void) const { return deferred; }
81  cString PatternAndFile(void) const;
82  cString ToText(bool UseChannelID = false) const;
83  cString ToDescr(void) const;
84  const cEvent *Event(void) const { return event; }
85  bool Parse(const char *s);
86  bool Save(FILE *f);
87  bool IsSingleEvent(void) const;
88  static int GetMDay(time_t t);
89  static int GetWDay(time_t t);
90  bool DayMatches(time_t t) const;
91  static time_t IncDay(time_t t, int Days);
92  static time_t SetTime(time_t t, int SecondsFromMidnight);
93  void SetPattern(const char *Pattern);
94  void SetFile(const char *File);
95  bool IsPatternTimer(void) const { return *pattern; }
96  bool Matches(time_t t = 0, bool Directly = false, int Margin = 0) const;
97  eTimerMatch Matches(const cEvent *Event, int *Overlap = NULL) const;
98  bool Expired(void) const;
99  time_t StartTime(void) const;
100  time_t StopTime(void) const;
101  time_t StartTimeEvent(void) const;
102  time_t StopTimeEvent(void) const;
103  void SetId(int Id);
104  cTimer *SpawnPatternTimer(const cEvent *Event, cTimers *Timers);
105  bool SpawnPatternTimers(const cSchedules *Schedules, cTimers *Timers);
106  bool AdjustSpawnedTimer(void);
107  void TriggerRespawn(void);
108  bool SetEventFromSchedule(const cSchedules *Schedules);
109  bool SetEvent(const cEvent *Event);
110  void SetRecording(bool Recording);
111  void SetPending(bool Pending);
112  void SetInVpsMargin(bool InVpsMargin);
113  void SetDay(time_t Day);
114  void SetWeekDays(int WeekDays);
115  void SetStart(int Start);
116  void SetStop(int Stop);
117  void SetPriority(int Priority);
118  void SetLifetime(int Lifetime);
119  void SetAux(const char *Aux);
120  void SetRemote(const char *Remote);
121  void SetDeferred(int Seconds);
122  void SetFlags(uint Flags);
123  void ClrFlags(uint Flags);
124  void InvFlags(uint Flags);
125  bool HasFlags(uint Flags) const;
126  void Skip(void);
127  void OnOff(void);
128  cString PrintFirstDay(void) const;
129  static int TimeToInt(int t);
130  static bool ParseDay(const char *s, time_t &Day, int &WeekDays);
131  static cString PrintDay(time_t Day, int WeekDays, bool SingleByteChars);
132  };
133 
134 class cTimers : public cConfig<cTimer> {
135 private:
136  static cTimers timers;
137  static int lastTimerId;
139 public:
140  cTimers(void);
141  static const cTimers *GetTimersRead(cStateKey &StateKey, int TimeoutMs = 0);
163  static cTimers *GetTimersWrite(cStateKey &StateKey, int TimeoutMs = 0);
187  static bool Load(const char *FileName);
188  static int NewTimerId(void);
189  const cTimer *GetById(int Id, const char *Remote = NULL) const;
190  cTimer *GetById(int Id, const char *Remote = NULL) { return const_cast<cTimer *>(static_cast<const cTimers *>(this)->GetById(Id, Remote)); };
191  const cTimer *GetTimer(const cTimer *Timer) const;
192  cTimer *GetTimer(const cTimer *Timer) { return const_cast<cTimer *>(static_cast<const cTimers *>(this)->GetTimer(Timer)); };
193  const cTimer *GetMatch(time_t t) const;
194  cTimer *GetMatch(time_t t) { return const_cast<cTimer *>(static_cast<const cTimers *>(this)->GetMatch(t)); };
195  const cTimer *GetMatch(const cEvent *Event, eTimerMatch *Match = NULL) const;
196  cTimer *GetMatch(const cEvent *Event, eTimerMatch *Match = NULL) { return const_cast<cTimer *>(static_cast<const cTimers *>(this)->GetMatch(Event, Match)); }
197  const cTimer *GetTimerForEvent(const cEvent *Event, eTimerFlags Flags = tfNone);
198  int GetMaxPriority(void) const;
201  const cTimer *GetNextActiveTimer(void) const;
202  const cTimer *UsesChannel(const cChannel *Channel) const;
203  bool SetEvents(const cSchedules *Schedules);
204  bool SpawnPatternTimers(const cSchedules *Schedules);
205  bool AdjustSpawnedTimers(void);
206  bool DeleteExpired(bool Force);
207  void Add(cTimer *Timer, cTimer *After = NULL);
208  void Ins(cTimer *Timer, cTimer *Before = NULL);
209  void Del(cTimer *Timer, bool DeleteObject = true);
210  bool StoreRemoteTimers(const char *ServerName = NULL, const cStringList *RemoteTimers = NULL);
218  };
219 
220 bool HandleRemoteTimerModifications(cTimer *NewTimer, cTimer *OldTimer = NULL, cString *Msg = NULL);
235 
236 // Provide lock controlled access to the list:
237 
239 
240 // These macros provide a convenient way of locking the global timers list
241 // and making sure the lock is released as soon as the current scope is left
242 // (note that these macros wait forever to obtain the lock!):
243 
244 #define LOCK_TIMERS_READ USE_LIST_LOCK_READ(Timers)
245 #define LOCK_TIMERS_WRITE USE_LIST_LOCK_WRITE(Timers)
246 
247 class cSortedTimers : public cVector<const cTimer *> {
248 public:
249  cSortedTimers(const cTimers *Timers);
250  };
251 
252 #endif //__TIMERS_H
const char * FileName(void)
Definition: config.h:126
Definition: epg.h:73
cSortedTimers(const cTimers *Timers)
Definition: timers.c:1448
Definition: tools.h:178
Definition: timers.h:31
int Stop(void) const
Definition: timers.h:71
void SetAux(const char *Aux)
Definition: timers.c:977
time_t stopTime
the time_t value calculated from 'day', 'start' and 'stop'
Definition: timers.h:35
void OnOff(void)
Definition: timers.c:1022
void SetLifetime(int Lifetime)
Definition: timers.c:972
cString PrintFirstDay(void) const
Definition: timers.c:424
char * aux
Definition: timers.h:51
time_t Deferred(void) const
Definition: timers.h:80
time_t day
midnight of the day this timer shall hit, or of the first day it shall hit in case of a repeating tim...
Definition: timers.h:43
int weekdays
bitmask, lowest bits: SSFTWTM (the 'M' is the LSB)
Definition: timers.h:44
bool IsSingleEvent(void) const
Definition: timers.c:501
void SetPending(bool Pending)
Definition: timers.c:935
const char * Remote(void) const
Definition: timers.h:78
cTimer(bool Instant=false, bool Pause=false, const cChannel *Channel=NULL)
Definition: timers.c:26
time_t StopTime(void) const
the stop time as given by the user
Definition: timers.c:712
time_t FirstDay(void) const
Definition: timers.h:76
cString PatternAndFile(void) const
Definition: timers.c:304
bool Recording(void) const
Definition: timers.h:63
void SetStart(int Start)
Definition: timers.c:957
static time_t SetTime(time_t t, int SecondsFromMidnight)
Definition: timers.c:536
int priority
Definition: timers.h:47
bool Expired(void) const
Definition: timers.c:694
void ClrFlags(uint Flags)
Definition: timers.c:1000
char file[NAME_MAX *2+1]
Definition: timers.h:50
virtual int Compare(const cListObject &ListObject) const
Must return 0 if this object is equal to ListObject, a positive value if it is "greater",...
Definition: timers.c:285
void SetFile(const char *File)
Definition: timers.c:552
void SetFlags(uint Flags)
Definition: timers.c:995
int Start(void) const
Definition: timers.h:70
virtual ~cTimer()
Definition: timers.c:232
int id
Definition: timers.h:34
int start
the start and stop time of this timer as given by the user,
Definition: timers.h:45
void SetPriority(int Priority)
Definition: timers.c:967
void SetDeferred(int Seconds)
Definition: timers.c:989
void SetId(int Id)
Definition: timers.c:744
time_t StopTimeEvent(void) const
or by the user (for normal timers)
Definition: timers.c:730
bool AdjustSpawnedTimer(void)
Definition: timers.c:808
void SetInVpsMargin(bool InVpsMargin)
Definition: timers.c:940
bool Save(FILE *f)
Definition: timers.c:494
bool IsPatternTimer(void) const
Definition: timers.h:95
static int GetWDay(time_t t)
Definition: timers.c:512
int WeekDays(void) const
Definition: timers.h:69
static cString PrintDay(time_t Day, int WeekDays, bool SingleByteChars)
Definition: timers.c:390
void TriggerRespawn(void)
Definition: timers.c:843
bool DayMatches(time_t t) const
Definition: timers.c:519
time_t Day(void) const
Definition: timers.h:68
void SetDay(time_t Day)
Definition: timers.c:947
void SetRemote(const char *Remote)
Definition: timers.c:983
bool InVpsMargin(void) const
Definition: timers.h:65
char * remote
Definition: timers.h:52
const char * Aux(void) const
Definition: timers.h:77
bool SetEvent(const cEvent *Event)
Definition: timers.c:906
const cChannel * channel
Definition: timers.h:42
void InvFlags(uint Flags)
Definition: timers.c:1005
void SetStop(int Stop)
Definition: timers.c:962
int stop
in the form hhmm, with hh (00..23) and mm (00..59) added as hh*100+mm
Definition: timers.h:46
bool Local(void) const
Definition: timers.h:79
int scheduleStateSpawn
Definition: timers.h:37
static bool ParseDay(const char *s, time_t &Day, int &WeekDays)
Definition: timers.c:331
uint Flags(void) const
Definition: timers.h:66
void Skip(void)
Definition: timers.c:1015
const char * File(void) const
Definition: timers.h:75
cTimer * SpawnPatternTimer(const cEvent *Event, cTimers *Timers)
Definition: timers.c:749
const cEvent * event
Definition: timers.h:53
time_t StartTime(void) const
the start time as given by the user
Definition: timers.c:705
bool Pending(void) const
Definition: timers.h:64
void CalcMargins(int &MarginStart, int &MarginStop, const cEvent *Event)
Definition: timers.c:273
cString ToDescr(void) const
Definition: timers.c:321
int scheduleStateSet
Definition: timers.h:36
const char * Pattern(void) const
Definition: timers.h:74
int scheduleStateAdjust
Definition: timers.h:38
bool SetEventFromSchedule(const cSchedules *Schedules)
Definition: timers.c:857
int Priority(void) const
Definition: timers.h:72
void SetRecording(bool Recording)
Definition: timers.c:926
time_t StartTimeEvent(void) const
the start/stop times as given by the event (for VPS timers), by event plus margins (for spawned non-V...
Definition: timers.c:719
void SetPattern(const char *Pattern)
Definition: timers.c:547
const cEvent * Event(void) const
Definition: timers.h:84
char pattern[NAME_MAX *2+1]
Definition: timers.h:49
bool pending
Definition: timers.h:40
time_t startTime
Definition: timers.h:35
static int TimeToInt(int t)
Definition: timers.c:326
time_t deferred
Matches(time_t, ...) will return false if the current time is before this value.
Definition: timers.h:39
static int GetMDay(time_t t)
Definition: timers.c:506
bool HasFlags(uint Flags) const
Definition: timers.c:1010
cTimer & operator=(const cTimer &Timer)
Definition: timers.c:240
void SetWeekDays(int WeekDays)
Definition: timers.c:952
bool inVpsMargin
Definition: timers.h:40
int lifetime
Definition: timers.h:48
int Id(void) const
Definition: timers.h:62
bool Matches(time_t t=0, bool Directly=false, int Margin=0) const
Definition: timers.c:560
int Lifetime(void) const
Definition: timers.h:73
bool Parse(const char *s)
Definition: timers.c:434
uint flags
Definition: timers.h:41
cString ToText(bool UseChannelID=false) const
Definition: timers.c:311
const cChannel * Channel(void) const
Definition: timers.h:67
static time_t IncDay(time_t t, int Days)
Definition: timers.c:524
bool SpawnPatternTimers(const cSchedules *Schedules, cTimers *Timers)
Definition: timers.c:762
static cTimers timers
Definition: timers.h:136
static bool Load(const char *FileName)
Definition: timers.c:1051
int GetMaxPriority(void) const
Returns the maximum priority of all local timers that are currently recording.
Definition: timers.c:1145
const cTimer * UsesChannel(const cChannel *Channel) const
Definition: timers.c:1198
bool StoreRemoteTimers(const char *ServerName=NULL, const cStringList *RemoteTimers=NULL)
Stores the given list of RemoteTimers, which come from the VDR ServerName, in this list.
Definition: timers.c:1264
const cTimer * GetTimerForEvent(const cEvent *Event, eTimerFlags Flags=tfNone)
Definition: timers.c:1134
const cTimer * GetById(int Id, const char *Remote=NULL) const
Definition: timers.c:1071
void Add(cTimer *Timer, cTimer *After=NULL)
Definition: timers.c:1178
static cTimers * GetTimersWrite(cStateKey &StateKey, int TimeoutMs=0)
Gets the list of timers for write access.
Definition: timers.c:1173
cTimer * GetMatch(const cEvent *Event, eTimerMatch *Match=NULL)
Definition: timers.h:196
cTimer * GetMatch(time_t t)
Definition: timers.h:194
void Del(cTimer *Timer, bool DeleteObject=true)
Definition: timers.c:1192
static const cTimers * GetTimersRead(cStateKey &StateKey, int TimeoutMs=0)
Gets the list of timers for read access.
Definition: timers.c:1168
const cTimer * GetTimer(const cTimer *Timer) const
Definition: timers.c:1082
const cTimer * GetMatch(time_t t) const
Definition: timers.c:1095
static int lastTimerId
Definition: timers.h:137
cTimer * GetTimer(const cTimer *Timer)
Definition: timers.h:192
void Ins(cTimer *Timer, cTimer *Before=NULL)
Definition: timers.c:1186
time_t lastDeleteExpired
Definition: timers.h:138
bool SpawnPatternTimers(const cSchedules *Schedules)
Definition: timers.c:1217
const cTimer * GetNextActiveTimer(void) const
Definition: timers.c:1155
bool DeleteExpired(bool Force)
Definition: timers.c:1243
bool SetEvents(const cSchedules *Schedules)
Definition: timers.c:1207
bool AdjustSpawnedTimers(void)
Definition: timers.c:1229
static int NewTimerId(void)
Definition: timers.c:1066
cTimer * GetById(int Id, const char *Remote=NULL)
Definition: timers.h:190
cTimers(void)
Definition: timers.c:1045
Definition: tools.h:711
DEF_LIST_LOCK(Timers)
bool HandleRemoteTimerModifications(cTimer *NewTimer, cTimer *OldTimer=NULL, cString *Msg=NULL)
Performs any operations necessary to synchronize changes to a timer between peer VDR machines.
Definition: timers.c:1382
eTimerFlags
Definition: timers.h:18
@ tfNone
Definition: timers.h:18
@ tfAvoid
Definition: timers.h:24
@ tfInstant
Definition: timers.h:20
@ tfActive
Definition: timers.h:19
@ tfVps
Definition: timers.h:21
@ tfRecording
Definition: timers.h:22
@ tfAll
Definition: timers.h:25
@ tfSpawned
Definition: timers.h:23
eTimerMatch
Definition: timers.h:27
@ tmPartial
Definition: timers.h:27
@ tmFull
Definition: timers.h:27
@ tmNone
Definition: timers.h:27