vdr 2.7.4
config.h
Go to the documentation of this file.
1/*
2 * config.h: Configuration file handling
3 *
4 * See the main source file 'vdr.c' for copyright information and
5 * how to reach the author.
6 *
7 * $Id: config.h 5.26 2025/02/26 10:35:03 kls Exp $
8 */
9
10#ifndef __CONFIG_H
11#define __CONFIG_H
12
13#include <arpa/inet.h>
14#include <stdio.h>
15#include <stdlib.h>
16#include <string.h>
17#include <time.h>
18#include <unistd.h>
19#include "i18n.h"
20#include "font.h"
21#include "tools.h"
22
23// VDR's own version number:
24
25#define VDRVERSION "2.7.4"
26#define VDRVERSNUM 20704 // Version * 10000 + Major * 100 + Minor
27
28// The plugin API's version number:
29
30#define APIVERSION "6"
31#define APIVERSNUM 30006
32
33// When loading plugins, VDR searches files by their APIVERSION, which
34// is different from VDRVERSION. APIVERSION is a plain number, incremented
35// only when there are changes to the plugin API. This allows compiled
36// plugins to work with newer versions of the core VDR as long as no
37// interfaces have changed. APIVERSNUM begins with "300.." for backwards
38
39// The MainMenuHook Patch's version number:
40#define MAINMENUHOOKSVERSION "1.0.1"
41#define MAINMENUHOOKSVERSNUM 10001 // Version * 10000 + Major * 100 + Minor
42// compatibility and can be used in #if preprocessor statements to handle
43// version dependent code.
44
45#define MAXPRIORITY 99
46#define MINPRIORITY (-MAXPRIORITY)
47#define LIVEPRIORITY 0 // priority used when selecting a device for live viewing
48#define TRANSFERPRIORITY (LIVEPRIORITY - 1) // priority used for actual local Transfer Mode
49#define IDLEPRIORITY (MINPRIORITY - 1) // priority of an idle device
50#define MAXLIFETIME 99
51#define DEFINSTRECTIME 180 // default instant recording time (minutes)
52
53#define TIMERMACRO_TITLE "TITLE"
54#define TIMERMACRO_EPISODE "EPISODE"
55#define TIMERMACRO_BEFORE "{<}"
56#define TIMERMACRO_MATCH "{=}"
57#define TIMERMACRO_AFTER "{>}"
58
59#define TIMERPATTERN_AVOID "@"
60#define TIMERPATTERN_BEGIN "^"
61#define TIMERPATTERN_END "$"
62
63#define MINOSDWIDTH 480
64#define MAXOSDWIDTH 1920
65#define MINOSDHEIGHT 324
66#define MAXOSDHEIGHT 1200
67
68#define MaxFileName NAME_MAX // obsolete - use NAME_MAX directly instead!
69#define MaxSkinName 16
70#define MaxThemeName 16
71
72// Basically VDR works according to the DVB standard, but there are countries/providers
73// that use other standards, which in some details deviate from the DVB standard.
74// This makes it necessary to handle things differently in some areas, depending on
75// which standard is actually used. The following macros are used to distinguish
76// these cases (make sure to adjust cMenuSetupDVB::standardComplianceTexts accordingly
77// when adding a new standard):
78
79#define STANDARD_DVB 0
80#define STANDARD_ANSISCTE 1
81#define STANDARD_NORDIG 2
82
83typedef uint32_t in_addr_t; //XXX from /usr/include/netinet/in.h (apparently this is not defined on systems with glibc < 2.2)
84
85class cSVDRPhost : public cListObject {
86private:
87 struct in_addr addr;
89public:
90 cSVDRPhost(void);
91 bool Parse(const char *s);
92 bool IsLocalhost(void);
93 bool Accepts(in_addr_t Address);
94 };
95
97private:
98 int size;
99 int *array;
100public:
101 cSatCableNumbers(int Size, const char *s = NULL);
103 int Size(void) const { return size; }
104 int *Array(void) { return array; }
105 bool FromString(const char *s);
106 cString ToString(void);
107 int FirstDeviceIndex(int DeviceIndex) const;
113 };
114
115template<class T> class cConfig : public cList<T> {
116private:
117 char *fileName;
119 void Clear(void)
120 {
121 free(fileName);
122 fileName = NULL;
124 }
125public:
126 cConfig(const char *NeedsLocking = NULL): cList<T>(NeedsLocking) { fileName = NULL; }
127 virtual ~cConfig() { free(fileName); }
128 const char *FileName(void) { return fileName; }
129 bool Load(const char *FileName = NULL, bool AllowComments = false, bool MustExist = false)
130 {
132 if (FileName) {
133 free(fileName);
134 fileName = strdup(FileName);
135 allowComments = AllowComments;
136 }
137 bool result = !MustExist;
138 if (fileName && access(fileName, F_OK) == 0) {
139 isyslog("loading %s", fileName);
140 FILE *f = fopen(fileName, "r");
141 if (f) {
142 char *s;
143 int line = 0;
144 cReadLine ReadLine;
145 result = true;
146 while ((s = ReadLine.Read(f)) != NULL) {
147 line++;
148 if (allowComments) {
149 char *p = strchr(s, '#');
150 if (p)
151 *p = 0;
152 }
153 stripspace(s);
154 if (!isempty(s)) {
155 T *l = new T;
156 if (l->Parse(s))
157 this->Add(l);
158 else {
159 esyslog("ERROR: error in %s, line %d", fileName, line);
160 delete l;
161 result = false;
162 }
163 }
164 }
165 fclose(f);
166 }
167 else {
169 result = false;
170 }
171 }
172 if (!result)
173 fprintf(stderr, "vdr: error while reading '%s'\n", fileName);
174 return result;
175 }
176 bool Save(void) const
177 {
178 bool result = true;
179 T *l = (T *)this->First();
181 if (f.Open()) {
182 while (l) {
183 if (!l->Save(f)) {
184 result = false;
185 break;
186 }
187 l = (T *)l->Next();
188 }
189 if (!f.Close())
190 result = false;
191 }
192 else
193 result = false;
194 return result;
195 }
196 };
197
198class cNestedItem : public cListObject {
199private:
200 char *text;
202public:
203 cNestedItem(const char *Text, bool WithSubItems = false);
204 virtual ~cNestedItem();
205 virtual int Compare(const cListObject &ListObject) const;
206 const char *Text(void) const { return text; }
208 void AddSubItem(cNestedItem *Item);
209 void SetText(const char *Text);
210 void SetSubItems(bool On);
211 };
212
213class cNestedItemList : public cList<cNestedItem> {
214private:
215 char *fileName;
216 bool Parse(FILE *f, cList<cNestedItem> *List, int &Line);
217 bool Write(FILE *f, cList<cNestedItem> *List, int Indent = 0);
218public:
219 cNestedItemList(void);
220 virtual ~cNestedItemList();
221 void Clear(void);
222 bool Load(const char *FileName);
223 bool Save(void);
224 };
225
226class cSVDRPhosts : public cConfig<cSVDRPhost> {
227public:
228 bool LocalhostOnly(void);
229 bool Acceptable(in_addr_t Address);
230 };
231
236
237class cSetupLine : public cListObject {
238private:
239 char *plugin;
240 char *name;
241 char *value;
242public:
243 cSetupLine(void);
244 cSetupLine(const char *Name, const char *Value, const char *Plugin = NULL);
245 virtual ~cSetupLine();
246 virtual int Compare(const cListObject &ListObject) const;
247 const char *Plugin(void) { return plugin; }
248 const char *Name(void) { return name; }
249 const char *Value(void) { return value; }
250 bool Parse(char *s);
251 bool Save(FILE *f);
252 };
253
254class cSetup : public cConfig<cSetupLine> {
255 friend class cPlugin; // needs to be able to call Store()
256private:
257 void StoreLanguages(const char *Name, int *Values);
258 bool ParseLanguages(const char *Value, int *Values);
259 bool Parse(const char *Name, const char *Value);
260 cSetupLine *Get(const char *Name, const char *Plugin = NULL);
261 void Store(const char *Name, const char *Value, const char *Plugin = NULL, bool AllowMultiple = false);
262 void Store(const char *Name, int Value, const char *Plugin = NULL);
263 void Store(const char *Name, double &Value, const char *Plugin = NULL);
264public:
265 // Also adjust cMenuSetup (menu.c) when adding parameters here!
277 char NameInstantRecord[NAME_MAX + 1];
307 char SVDRPHostName[HOST_NAME_MAX];
308 char SVDRPDefaultHost[HOST_NAME_MAX];
335 double OSDAspect;
380 cSetup(void);
381 cSetup& operator= (const cSetup &s);
382 bool Load(const char *FileName);
383 bool Save(void);
384 };
385
386extern cSetup Setup;
387
388#endif //__CONFIG_H
bool Save(void) const
Definition config.h:176
void Clear(void)
Definition config.h:119
cConfig(const char *NeedsLocking=NULL)
Definition config.h:126
char * fileName
Definition config.h:117
const char * FileName(void)
Definition config.h:128
virtual ~cConfig()
Definition config.h:127
bool allowComments
Definition config.h:118
bool Load(const char *FileName=NULL, bool AllowComments=false, bool MustExist=false)
Definition config.h:129
virtual void Clear(void)
Definition tools.c:2252
void Add(cListObject *Object, cListObject *After=NULL)
Definition tools.c:2175
cListObject(const cListObject &ListObject)
Definition tools.h:534
Definition tools.h:631
const T * First(void) const
Returns the first element in this list, or NULL if the list is empty.
Definition tools.h:643
cList(const char *NeedsLocking=NULL)
Sets up a new cList of the given type T.
Definition tools.h:633
bool Save(void)
Definition config.c:258
bool Write(FILE *f, cList< cNestedItem > *List, int Indent=0)
Definition config.c:213
void Clear(void)
Definition config.c:227
virtual ~cNestedItemList()
Definition config.c:179
bool Parse(FILE *f, cList< cNestedItem > *List, int &Line)
Definition config.c:184
bool Load(const char *FileName)
Definition config.c:234
char * fileName
Definition config.h:215
cNestedItemList(void)
Definition config.c:174
void SetText(const char *Text)
Definition config.c:156
virtual ~cNestedItem()
Definition config.c:137
char * text
Definition config.h:200
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 config.c:143
void AddSubItem(cNestedItem *Item)
Definition config.c:148
void SetSubItems(bool On)
Definition config.c:162
cNestedItem(const char *Text, bool WithSubItems=false)
Definition config.c:131
cList< cNestedItem > * SubItems(void)
Definition config.h:207
cList< cNestedItem > * subItems
Definition config.h:201
const char * Text(void) const
Definition config.h:206
char * Read(FILE *f)
Definition tools.c:1527
bool Parse(const char *s)
Definition config.c:34
in_addr_t mask
Definition config.h:88
bool IsLocalhost(void)
Definition config.c:57
cSVDRPhost(void)
Definition config.c:28
bool Accepts(in_addr_t Address)
Definition config.c:62
struct in_addr addr
Definition config.h:87
bool LocalhostOnly(void)
Definition config.c:282
bool Acceptable(in_addr_t Address)
Definition config.c:293
bool Open(void)
Definition tools.c:1759
bool Close(void)
Definition tools.c:1769
cSatCableNumbers(int Size, const char *s=NULL)
Definition config.c:69
int Size(void) const
Definition config.h:103
bool FromString(const char *s)
Definition config.c:81
int * Array(void)
Definition config.h:104
cString ToString(void)
Definition config.c:107
int FirstDeviceIndex(int DeviceIndex) const
Returns the first device index (starting at 0) that uses the same sat cable number as the device with...
Definition config.c:116
char * plugin
Definition config.h:239
const char * Name(void)
Definition config.h:248
cSetupLine(void)
Definition config.c:306
bool Save(FILE *f)
Definition config.c:365
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 config.c:325
const char * Plugin(void)
Definition config.h:247
const char * Value(void)
Definition config.h:249
virtual ~cSetupLine()
Definition config.c:318
bool Parse(char *s)
Definition config.c:340
char * value
Definition config.h:241
char * name
Definition config.h:240
int __EndData__
Definition config.h:377
int DefaultLifetime
Definition config.h:313
int VolumeSteps
Definition config.h:370
int EmergencyExit
Definition config.h:376
int SplitEditedFiles
Definition config.h:349
int RcRepeatDelay
Definition config.h:311
int ColorKey3
Definition config.h:326
int MenuScrollPage
Definition config.h:273
int EPGBugfixLevel
Definition config.h:303
int ColorKey2
Definition config.h:326
int VideoDisplayFormat
Definition config.h:327
int SubtitleFgTransparency
Definition config.h:298
int MinUserInactivity
Definition config.h:351
int CurrentVolume
Definition config.h:369
int AntiAlias
Definition config.h:338
int FontFixSize
Definition config.h:347
int ShowInfoOnChSwitch
Definition config.h:271
int SkipSecondsRepeat
Definition config.h:366
int StandardCompliance
Definition config.h:292
char SVDRPDefaultHost[HOST_NAME_MAX]
Definition config.h:308
int CurrentChannel
Definition config.h:368
bool Save(void)
Definition config.c:738
int TimeoutRequChInfo
Definition config.h:272
int ResumeID
Definition config.h:367
char OSDTheme[MaxThemeName]
Definition config.h:269
int SubtitleLanguages[I18N_MAX_LANGUAGES+1]
Definition config.h:296
int SVDRPTimeout
Definition config.h:305
int OSDHeight
Definition config.h:334
int LnbSLOF
Definition config.h:279
int EPGLanguages[I18N_MAX_LANGUAGES+1]
Definition config.h:299
char OSDSkin[MaxSkinName]
Definition config.h:268
int UsePositioner
Definition config.h:283
int AlwaysSortFoldersFirst
Definition config.h:322
int AdaptiveSkipInitial
Definition config.h:361
int RecSortingDirection
Definition config.h:324
int VpsMargin
Definition config.h:319
double OSDAspect
Definition config.h:335
char OSDLanguage[I18N_MAX_LOCALE_LEN]
Definition config.h:267
int ShowChannelNamesWithSource
Definition config.h:375
int DefaultPriority
Definition config.h:313
int ZapTimeout
Definition config.h:309
double OSDWidthP
Definition config.h:333
int RecordKeyHandling
Definition config.h:314
int PauseKeyHandling
Definition config.h:315
double OSDHeightP
Definition config.h:333
int PositionerSpeed
Definition config.h:286
cSetup & operator=(const cSetup &s)
Definition config.c:504
int MarginStart
Definition config.h:293
bool Parse(const char *Name, const char *Value)
Definition config.c:604
double FontOsdSizeP
Definition config.h:342
int PauseAtLastMark
Definition config.h:360
int AdaptiveSkipPrevNext
Definition config.h:364
int FontOsdSize
Definition config.h:345
int LnbFrequLo
Definition config.h:280
bool Load(const char *FileName)
Definition config.c:544
friend class cPlugin
Definition config.h:255
int EPGPauseAfterScan
Definition config.h:301
int FontSmlSize
Definition config.h:346
int UseSmallFont
Definition config.h:337
int SubtitleOffset
Definition config.h:297
int MarginStop
Definition config.h:293
cSetupLine * Get(const char *Name, const char *Plugin=NULL)
Definition config.c:512
int SVDRPPeering
Definition config.h:306
int ProgressDisplayTime
Definition config.h:356
int UpdateChannels
Definition config.h:329
int SkipSeconds
Definition config.h:365
int SubtitleBgTransparency
Definition config.h:298
int ColorKey0
Definition config.h:326
int FoldersInTimerMenu
Definition config.h:321
int MenuScrollWrap
Definition config.h:274
int EPGLinger
Definition config.h:304
int ShowReplayMode
Definition config.h:354
cSetup(void)
Definition config.c:374
int SiteLon
Definition config.h:285
int OSDTop
Definition config.h:334
int AdaptiveSkipAlternate
Definition config.h:363
int UseVps
Definition config.h:318
time_t NextWakeupTime
Definition config.h:352
void StoreLanguages(const char *Name, int *Values)
Definition config.c:569
int DisplaySubtitles
Definition config.h:295
bool ParseLanguages(const char *Value, int *Values)
Definition config.c:588
int ChannelInfoTime
Definition config.h:332
int SiteLat
Definition config.h:284
int VolumeLinearize
Definition config.h:371
int ChannelsWrap
Definition config.h:374
int EPGScanMaxChannel
Definition config.h:300
double FontFixSizeP
Definition config.h:344
int AudioLanguages[I18N_MAX_LANGUAGES+1]
Definition config.h:294
int OSDMessageTime
Definition config.h:336
int MarkInstantRecord
Definition config.h:276
double OSDLeftP
Definition config.h:333
int RecordingDirs
Definition config.h:320
int PausePriority
Definition config.h:316
double FontSmlSizeP
Definition config.h:343
int OSDLeft
Definition config.h:334
int AdaptiveSkipTimeout
Definition config.h:362
int MenuKeyCloses
Definition config.h:275
int DiSEqC
Definition config.h:282
char NameInstantRecord[NAME_MAX+1]
Definition config.h:277
char FontOsd[MAXFONTNAME]
Definition config.h:339
int UseSubtitle
Definition config.h:317
int OSDWidth
Definition config.h:334
int MinEventTimeout
Definition config.h:351
int ChannelInfoPos
Definition config.h:331
int LnbFrequHi
Definition config.h:281
void Store(const char *Name, const char *Value, const char *Plugin=NULL, bool AllowMultiple=false)
Definition config.c:523
char FontSml[MAXFONTNAME]
Definition config.h:340
int MultiSpeedMode
Definition config.h:353
int __BeginData__
Definition config.h:266
int EPGScanTimeout
Definition config.h:302
int TimeTransponder
Definition config.h:291
int VideoFormat
Definition config.h:328
int MaxVideoFileSize
Definition config.h:348
cString DeviceBondings
Definition config.h:379
int PositionerSwing
Definition config.h:287
double OSDTopP
Definition config.h:333
int PositionerLastLon
Definition config.h:288
int PauseOnMarkSet
Definition config.h:357
int DelTimeshiftRec
Definition config.h:350
int SetSystemTime
Definition config.h:289
int PrimaryDVB
Definition config.h:270
int ChannelEntryTimeout
Definition config.h:310
char FontFix[MAXFONTNAME]
Definition config.h:341
int TimeSource
Definition config.h:290
int UseDolbyDigital
Definition config.h:330
int PauseOnMarkJump
Definition config.h:358
int ColorKey1
Definition config.h:326
int ShowRemainingTime
Definition config.h:355
int CurrentDolby
Definition config.h:372
cString InitialChannel
Definition config.h:378
int DefaultSortModeRec
Definition config.h:323
char SVDRPHostName[HOST_NAME_MAX]
Definition config.h:307
int RcRepeatDelta
Definition config.h:312
int InstantRecordTime
Definition config.h:278
int NumberKeysForChars
Definition config.h:325
int SkipEdited
Definition config.h:359
int PauseLifetime
Definition config.h:316
int InitialVolume
Definition config.h:373
cNestedItemList Commands
Definition config.c:275
cSetup Setup
Definition config.c:372
cSVDRPhosts SVDRPhosts
Definition config.c:280
cNestedItemList Folders
Definition config.c:274
cNestedItemList RecordingCommands
Definition config.c:276
#define MaxSkinName
Definition config.h:69
uint32_t in_addr_t
Definition config.h:83
#define MaxThemeName
Definition config.h:70
#define MAXFONTNAME
Definition font.h:17
#define I18N_MAX_LOCALE_LEN
Definition i18n.h:17
#define I18N_MAX_LANGUAGES
Definition i18n.h:18
Definition runvdr.c:107
bool isempty(const char *s)
Definition tools.c:357
char * stripspace(char *s)
Definition tools.c:227
#define LOG_ERROR_STR(s)
Definition tools.h:40
#define esyslog(a...)
Definition tools.h:35
#define isyslog(a...)
Definition tools.h:36