A group delimiter is a line starting with a ':' as the very first character, followed by arbitrary text. Example:
:First group
Group delimiters may also be used to specify the number of the next channel. To do this, the character '@' and a number must immediately follow the ':', as in
:@201 First group
The given number must be larger than the number of any previous channel (otherwise it is silently ignored).
A group delimiter can also be used to just set the next channel's number, without an explicit delimiter text, as in
:@201
Such a delimiter will not appear in the Channels menu.
A channel definition is a line with channel data, where the fields are separated by ':' characters. Example:
RTL Television,RTL;RTL World:12187:hC34M2O0S0:S19.2E:27500:163=2:104=deu;106=deu:105:0:12003:1:1089:0
The line number of a channel definition (not counting group separators, and based on a possible previous '@...' parameter) defines the channel's number in OSD menus and the timers.conf file.
The fields in a channel definition have the following meaning (from left to right):
RTL Television,RTL:...
If the short name itself would contain a comma, it is replaced with a '.'. Note that some long channel names may contain a comma, so the delimiting comma is always the rightmost one.
If present, the name of the service provider or "bouquet" is appended to the channel name, separated by a semicolon, as in
RTL Television,RTL;RTL World:...
| B | Bandwidth (6, 7, 8) |
| C | Code rate high priority (0, 12, 23, 34, 35, 45, 56, 67, 78, 89, 910) |
| D | coDe rate low priority (0, 12, 23, 34, 35, 45, 56, 67, 78, 89, 910) |
| G | Guard interval (4, 8, 16, 32) |
| H | Horizontal polarization |
| I | Inversion (0, 1) |
| L | Left circular polarization |
| M | Modulation (2, 5, 6, 10, 11, 16, 32, 64, 128, 256, 998) |
| O | rollOff (0, 20, 25, 35) |
| R | Right circular polarization |
| S | delivery System (0, 1) |
| T | Transmission mode (2, 8) |
| V | Vertical polarization |
| Y | hierarchY (0, 1, 2, 4) |
Bandwidth: The bandwidth of the channel in MHz (DVB-T only).
Code rate high priority: Forward Error Correction (FEC) of the high priority stream (DVB-T). For DVB-S/DVB-S2 this parameter specifies the inner FEC scheme. 12 = 1/2, 23 = 2/3, 34 = 3/4, ...
Code rate low priority: Forward Error Correction (FEC) of the low priority stream (DVB-T only). If no hierarchy is used, set to 0.
Guard interval: The guard interval value (DVB-T only): 4 = 1/4, 8 = 1/8, 16 = 1/16, 32 = 1/32.
Inversion: Specifies whether the DVB frontend needs spectral inversion (DVB-T and DVB-C only). This is frontend specific, if in doubt, omit.
Modulation: Specifies the modulation/constellation of the channel as follows:
| 2 | QPSK (DVB-S, DVB-S2, DVB-T) |
| 5 | 8PSK (DVB-S2) |
| 6 | 16APSK (DVB-S2) |
| 10 | VSB8 (ATSC aerial) |
| 11 | VSB16 (ATSC aerial) |
| 16 | QAM16 (DVB-T) |
| 64 | QAM64 (DVB-C, DVB-T) |
| 128 | QAM128 (DVB-C) |
| 256 | QAM256 (DVB-C) |
Rolloff: The Nyquist filter rolloff factor for DVB-S (35) and DVB-S2 (35, 25, 20), 35 = 0.35, 25 = 0.25, 20 = 0.20, DVB-S/DVB-S2 default value is 0.35
Transmission mode: Number of DVB-T OFDM carriers, 8 = 8k, 2 = 2k. If in doubt, try 8k.
Hierarchy: If set to 1, this transponder uses two streams, high priority and low priority. If in doubt, try 0 (off). (DVB-T only).
Delivery System: The satellite delivery system (0 = DVB-S, 1 = DVB-S2).
Polarization: Satellite antenna polarization. H = horizontal, V = vertical, R = circular right, L = circular left.
The polarization parameters have no integer numbers following them. This is for compatibility with files from older versions and also to keep the DVB-S entries as simple as possible.
The special value 999 is used for "automatic", which means the driver will automatically determine the proper value (if possible).
An example of a parameter field for a DVB-T channel might look like this: B8C23D12G8M16T8Y0
An example of a parameter field for a DVB-C channel might look like this: C0M64
An example of a parameter field for a DVB-S channel might look like this: hC56M2O35S0
An example of a parameter field for a DVB-S2 channel might look like this: hC910M2O35S1
Plugins that implement devices that need their own set of parameters may store those in the parameters string in arbitrary format (not necessarily the "character/number" format listed above). The only condition is that the string may not contain colons (':') or newline characters.
...:164+17:...
If this channel has a video mode other than 0, the mode follows the pids, separated by an '=' sign, as in
...:164+17=27:...
...:101,102;103,104:...
If certain audio PIDs broadcast in specific languages, the language codes for these can be appended to the individual audio or Dolby PID, separated by an '=' sign, as in
...:101=deu,102=eng;103=deu,104=eng:...
Some channels broadcast two different languages in the two stereo channels, which can be indicated by adding a second language code, delimited by a '+' sign, as in
...:101=deu,102=eng+spa;103=deu,104=eng:...
The audio type is appended with a separating '@' character, as in
...:101=deu@4,102=eng+spa@4,105=@4:...
Note that if there is no language code, there still is the separating '=' if there is an audio type.
| 0000 | Free To Air |
| 0001...000F | explicitly requires the device with the given number |
| 0010...00FF | reserved for user defined assignments |
| 0100...FFFF | specific decryption methods as broadcast in the data stream |
...:1702,1722,1801:...
The values are in hex because that's the way they are defined in the "ETR 162" document. Leading zeros may be omitted.
A particular channel can be uniquely identified by its channel ID, which is a string that looks like this:
S19.2E-1-1089-12003-0
The components of this string are the Source (S19.2E), NID
(1), TID (1089), SID (12003) and RID (0) as defined above.
The last part can be omitted if it is 0,
so the above example could also be written as S19.2E-1-1089-12003).
The channel ID is used in the timers.conf and epg.data
files to properly identify the channels.
If a channel has both NID and TID set to 0, the channel ID will use the Frequency instead of the TID. For satellite channels an additional offset of 100000, 200000, 300000 or 400000 is added to that number, depending on the Polarization (H, V, L or R, respectively). This is necessary because on some satellites the same frequency is used for two different transponders, with opposite polarization.
1:10:-T-----:2058:2150:50:5:Quarks & Co:
The fields in a timer definition have the following meaning (from left to right):
| 1 | the timer is active (and will record if it hits) |
| 2 | this is an instant recording timer |
| 4 | this timer uses VPS |
| 8 | this timer is currently recording (may only be up-to-date with SVDRP) |
All other bits are reserved for future use.
If this is a `single-shot' timer, this is the date on which this timer shall record, given in ISO notation (YYYY-MM-DD), as in:
2005-03-19
For compatibility with earlier versions of VDR this may also be just the day of month on which this timer shall record (must be in the range 1...31).
In case of a `repeating' timer this is a string consisting of exactly seven characters, where each character position corresponds to one day of the week (with Monday being the first day). The character '-' at a certain position means that the timer shall not record on that day. Any other character will cause the timer to record on that day. Example:
MTWTF--
will define a timer that records on Monday through Friday and does not record on weekends. Note that only letters may be used here, no digits. For compatibility with timers created with earlier versions of VDR, the same result could be achieved with ABCDE-- (which was used to allow setting the days with language specific characters). Since version 1.5.3 VDR can use UTF-8 characters to present data to the user, but the weekday encoding in the timers.conf file always uses single byte characters.
The day definition of a `repeating' timer may be followed by the date when that timer shall hit for the first time. The format for this is @YYYY-MM-DD, so a complete definition could look like this:
which would implement a timer that records Monday through Friday, and will hit for the first time on or after February 18, 2002. This first day feature can be used to disable a repeating timer for a couple of days, or for instance to define a new Mon...Fri timer on Wednesday, which actually starts "Monday next week". The first day date given need not be that of a day when the timer would actually hit.
This value is also stored with the recording and is later used to decide which recording to remove from disk in order to free space for a new recording. If the disk runs full and a new recording needs more space, an existing recording with the lowest priority (and which has exceeded its guaranteed lifetime) will be removed.
If all available DVB cards are currently occupied, a timer with a higher priority will interrupt the timer with the lowest priority in order to start recording.
The special keywords TITLE and EPISODE, if present, will be replaced by the title and episode information from the EPG data at the time of recording (if that data is available). If at the time of recording either of these cannot be determined, TITLE will default to the channel name, and EPISODE will default to a blank.
S19.2E Astra 1
Anything after (and including) a '#' character is comment.
The first character of the code must be one of
| A | ATSC |
| C | Cable |
| S | Satellite |
| T | Terrestrial |
and is followed by further data pertaining to that particular source. In case of Satellite this is the orbital position in degrees, followed by E for east or W for west. Plugins may define additional sources, using other characters in the range 'A'...'Z'.
S19.2E 11700 V 9750 t v W15 [E0 10 38 F0] W15 A W15 t
Anything after (and including) a '#' character is comment.
The first word in a parameter line must be one of the codes defined in the file sources.conf and tells which satellite this line applies to.
Following is the "switch frequency" of the LNB (slof), which is the transponder frequency up to which this entry shall be used; the first entry with an slof greater than the actual transponder frequency will be used. Typically there is only one slof per LNB, but the syntax allows any number of frequency ranges to be defined. Note that there should be a last entry with the value 99999 for each satellite, which covers the upper frequency range.
The third parameter defines the polarization to which this entry applies. It can be either H for horizontal or V for vertical.
The fourth parameter specifies the "local oscillator frequency" (lof) of the LNB to use for the given frequency range. This number will be subtracted from the actual transponder frequency when tuning to the channel.
The rest of the line holds the actual sequence of DiSEqC actions to be taken. The code letters used here are
| t | 22kHz tone off |
| T | 22kHz tone on |
| v | voltage low (13V) |
| V | voltage high (18V) |
| A | mini A |
| B | mini B |
| Wnn | wait nn milliseconds (nn may be any positive integer number) |
| [xx ...] | hex code sequence (max. 6) |
By default it is assumed that every DVB-S device can receive every satellite. If this is not the case in a particular setup, lines of the form
1 2 4:
may be inserted in the diseqc.conf file, defining the devices that are able to receive the satellites following thereafter. In this case, only the devices 1, 2 and 4 would be able to receive any satellites following this line and up to the next such line, or the end of the file. Devices may be listed more than once.
name.key code
where name is the name of the remote control (for instance KBD for the PC keyboard, RCU for the home-built "Remote Control Unit", or LIRC for the "Linux Infrared Remote Control"), key is the name of the key that is defined (like Up, Down, Menu etc.), and code is a character string that this remote control delivers when the given key is pressed.
macrokey [@plugin] key1 key2 key3...
where macrokey is the key that shall initiate execution of this macro and can be one of Up, Down, Ok, Back, Left, Right, Red, Green, Yellow, Blue, 0...9 or User1...User9. The rest of the line consists of a set of keys, which will be executed just as if they had been pressed in the given sequence. The optional @plugin can be used to automatically select the given plugin. plugin is the name of the plugin, exactly as given in the -P option when starting VDR. There can be only one @plugin per key macro. For instance
User1 @abc Down Down Ok
would call the main menu function of the "abc" plugin and execute two "Down"
key presses, followed by "Ok".
Note that the color keys will only execute their macro function
in "normal viewing" mode (i.e. when no other menu or player is active). The
User1...User9 keys will always execute their macro function.
There may be up to 15 keys in such a key sequence.
Example:
Daily {
News
Soaps
}
Archive {
Movies
Sports
Sci-Fi {
Star Trek
U.F.O.
}
}
Comedy
Science
Note that these folder definitions are only used to set the file name under which a timer will store its recording. Changing these definitions in any way has no effect on existing timers or recordings.
title : command
where title is the string that will be displayed in the "Commands" menu, and command is the actual command string that will be executed when this option is selected. The delimiting ':' may be surrounded by any number of white space characters. If title ends with the character '?', there will be a confirmation prompt before actually executing the command. This can be used for commands that might have serious results (like deleting files etc) to make sure they are not executed inadvertently.
Everything following (and including) a '#' character is considered to be comment.
You can have nested layers of command menus by surrounding a sequence of commands with '{'...'}' and giving it a title, as in
My Commands {
First list {
Do something: some command
Do something else: another command
}
Second list {
Even more: yet another command
So much more: and yet another one
}
}
Command lists can be nested to any depth.
By default the menu entries in the "Commands" menu will be numbered '1'...'9' to make them selectable by pressing the corresponding number key. If you want to use your own numbering scheme (maybe to skip certain numbers), just precede the titles with the numbers of your choice. vdr will suppress its automatic numbering if the first entry in commands.conf starts with a digit in the range '1'...'9', followed by a blank.
In order to avoid error messages to the console, every command should have stderr redirected to stdout. Everything the command prints to stdout will be displayed in a result window, with title as its title.
Examples:
Check for new mail?: /usr/local/bin/checkmail 2>&1
CPU status: /usr/local/bin/cpustatus 2>&1
Disk space: df -h | grep '/video' | awk '{ print 100 - $5 "% free"; }'
Calendar: date;echo;cal
Note that the commands 'checkmail' and 'cpustatus' are only examples!
Don't send emails to the author asking where to find these ;-)
The '?' at the end of the "Check for new mail?" entry will prompt the user
whether this command shall really be executed.
IP-Address[/Netmask]
where IP-Address is the address of a host or a network in the usual dot separated notation (as in 192.168.100.1). If the optional Netmask is given only the given number of bits of IP-Address are taken into account. This allows you to grant SVDRP access to all hosts of an entire network. Netmask can be any integer from 1 to 32. The special value of 0 is only accepted if the IP-Address is 0.0.0.0, because this will give access to any host (USE THIS WITH CARE!).
Everything following (and including) a '#' character is considered to be comment.
Examples:
127.0.0.1 # always accept localhost
192.168.100.0/24 # any host on the local net
204.152.189.113 # a specific host
0.0.0.0/0 # any host on any net (USE WITH CARE!)
The definitions in a theme file are either colors or a description.
Colors are in the form
clrTitle = FF123456
where the name (clrTitle) is one of the names defined in the source code of the skin that uses this theme, through the THEME_CLR() macro. The value (FF123456) is an eight digit hex number that consist of four bytes, representing alpha (transparency), red, green and blue component of the color. An alpha value of 00 means the color will be completely transparent, while FF means it will be opaque. An RGB value of 000000 results in black, while FFFFFF is white.
A description can be given as
Description = Shades of blue
and will be used in the Setup/OSD menu to select a theme for a given skin. The description should give the user an idea what this theme will be like (for instance, in the given example it would use various shades of blue), and shouldn't be too long to make sure it fits on the Setup screen. The default description always should be given in English. If you want, you can provide language specific descriptions as
Description.eng = Shades of blue
Description.ger = Blautöne
where the language code is added to the keyword "Description", separated by a dot. You can enter as many language specific descriptions as you like, but only those that have a corresponding locale messages file will be actually used. If a theme file doesn't contain a Description, the name of the theme (as given in the theme's file name) will be used.
In addition to the tags used in the epg.data file, the following tag characters are defined:
| F | <frame rate> |
| L | <lifetime> |
| P | <priority> |
| @ | <auxiliary data> |
The following tag characters are defined:
| I | <offset into the file index> |
hh:mm:ss.ff comment
where hh:mm:ss.ff is a frame position within the recording, given as "hours, minutes, seconds and (optional) frame number". comment can be any string and may be used to describe this mark. If present, comment must be separated from the frame position by at least one blank.
The lines in this file need not necessarily appear in the correct temporal sequence, they will be automatically sorted by time index.
CURRENT RESTRICTIONS:
- the comment is currently not used by VDR
- marks must have a frame number, and that frame MUST be an I-frame (this
means that only marks generated by VDR itself can be used, since they
will always be guaranteed to mark I-frames).
The following tag characters are defined:
| C | <channel id> <channel name> |
| E | <event id> <start time> <duration> <table id> <version> |
| T | <title> |
| S | <short text> |
| D | <description> |
| G | <genre> <genre>... |
| R | <parental rating> |
| X | <stream> <type> <language> <descr> |
| V | <vps time> |
| e | |
| c |
Lowercase characters mark the end of a sequence that was started by the corresponding uppercase character. The outer frame consists of a sequence of one or more C...c (Channel) entries. Inside these any number of E...e (Event) entries are allowed. All other tags are optional (although every event should at least have a T entry).
There may be several X tags, depending on the number of tracks (video, audio etc.) the event provides.
| <channel id> | is the "channel ID", made up from the parameters defined in 'channels.conf' |
| <channel name> | is the "name" as in 'channels.conf' (for information only, may be left out) |
| <event id> | is a 32 bit unsigned int, uniquely identifying this event |
| <start time> | is the time (as a time_t integer) in UTC when this event starts |
| <duration> | is the time (in seconds) that this event will take |
| <table id> | is a hex number that indicates the table this event is contained in (if this is left empty or 0 this event will not be overwritten or modified by data that comes from the DVB stream) |
| <version> | is a hex number that indicates the event's version number inside its table (optional, ignored when reading EPG data) |
| <title> | is the title of the event |
| <short text> | is the short text of the event (typically the name of the episode etc.) |
| <description> | is the description of the event (any '|' characters will be interpreted as newlines) |
| <genre> | is a two digit hex code, as defined in ETSI EN 300 468, table 28 (up to 4 genre codes are supported) |
| <parental rating> | is the minimum age of the intended audience |
| <stream> | is the stream content (1 = video, 2 = audio, 3 = subtitles, 4 = AC3) |
| <type> | is the stream type according to ETSI EN 300 468 |
| <language> | is the three letter language code (optionally two codes, separated by '+') |
| <descr> | is the description of this stream component |
| <vps time> | is the Video Programming Service time of this event |
This file will be read at program startup in order to restore the results of previous EPG scans.
Note that the event id that comes from the DVB data stream is actually just 16 bit wide. The internal representation in VDR allows for 32 bit to be used, so that external tools can generate EPG data that is guaranteed not to collide with the ids of existing data.
This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.