vdr  2.0.7
dvbdevice.h
Go to the documentation of this file.
1 /*
2  * dvbdevice.h: The DVB device tuner interface
3  *
4  * See the main source file 'vdr.c' for copyright information and
5  * how to reach the author.
6  *
7  * $Id: dvbdevice.h 2.29.1.1 2013/04/09 13:43:33 kls Exp $
8  */
9 
10 #ifndef __DVBDEVICE_H
11 #define __DVBDEVICE_H
12 
13 #include <linux/dvb/frontend.h>
14 #include <linux/dvb/version.h>
15 #include "device.h"
16 
17 #define DVBAPIVERSION (DVB_API_VERSION << 8 | DVB_API_VERSION_MINOR)
18 
19 #if DVBAPIVERSION < 0x0500
20 #error VDR requires Linux DVB driver API version 5.0 or higher!
21 #endif
22 
23 // --- Definitions for older DVB API versions --------------------------------
24 
25 #if DVBAPIVERSION < 0x0501
26 enum {
27  FE_CAN_2G_MODULATION = 0x10000000,
28  };
29 enum {
30  TRANSMISSION_MODE_4K = TRANSMISSION_MODE_AUTO + 1,
31  };
32 #endif
33 
34 #if DVBAPIVERSION < 0x0502
35 enum {
36  FE_CAN_TURBO_FEC = 0x8000000,
37  };
38 #endif
39 
40 #if DVBAPIVERSION < 0x0503
41 enum {
45  };
46 enum {
47  GUARD_INTERVAL_1_128 = GUARD_INTERVAL_AUTO + 1,
50  };
51 enum {
52  SYS_DVBT2 = SYS_DAB + 1,
53  };
54 #endif
55 
56 #if DVBAPIVERSION < 0x0505
57 #define DTV_ENUM_DELSYS 44
58 #endif
59 
60 #if DVBAPIVERSION < 0x0508
61 enum {
62  FE_CAN_MULTISTREAM = 0x4000000,
63  };
64 #define DTV_STREAM_ID 42
65 #define DTV_DVBT2_PLP_ID_LEGACY 43
66 #endif
67 
68 // --- End of definitions for older DVB API versions -------------------------
69 
70 #define MAXDVBDEVICES 8
71 #define MAXDELIVERYSYSTEMS 8
72 
73 #define DEV_VIDEO "/dev/video"
74 #define DEV_DVB_BASE "/dev/dvb"
75 #define DEV_DVB_ADAPTER "adapter"
76 #define DEV_DVB_OSD "osd"
77 #define DEV_DVB_FRONTEND "frontend"
78 #define DEV_DVB_DVR "dvr"
79 #define DEV_DVB_DEMUX "demux"
80 #define DEV_DVB_VIDEO "video"
81 #define DEV_DVB_AUDIO "audio"
82 #define DEV_DVB_CA "ca"
83 
85  int userValue;
87  const char *userString;
88  };
89 
90 const char *MapToUserString(int Value, const tDvbParameterMap *Map);
91 int MapToUser(int Value, const tDvbParameterMap *Map, const char **String = NULL);
92 int MapToDriver(int Value, const tDvbParameterMap *Map);
93 int UserIndex(int Value, const tDvbParameterMap *Map);
94 int DriverIndex(int Value, const tDvbParameterMap *Map);
95 
96 extern const tDvbParameterMap InversionValues[];
97 extern const tDvbParameterMap BandwidthValues[];
98 extern const tDvbParameterMap CoderateValues[];
99 extern const tDvbParameterMap ModulationValues[];
100 extern const tDvbParameterMap SystemValuesSat[];
101 extern const tDvbParameterMap SystemValuesTerr[];
102 extern const tDvbParameterMap TransmissionValues[];
103 extern const tDvbParameterMap GuardValues[];
104 extern const tDvbParameterMap HierarchyValues[];
105 extern const tDvbParameterMap RollOffValues[];
106 
108 friend class cDvbSourceParam;
109 private:
116  int system;
118  int guard;
120  int rollOff;
121  int streamId;
122  int PrintParameter(char *p, char Name, int Value) const;
123  const char *ParseParameter(const char *s, int &Value, const tDvbParameterMap *Map = NULL);
124 public:
125  cDvbTransponderParameters(const char *Parameters = NULL);
126  char Polarization(void) const { return polarization; }
127  int Inversion(void) const { return inversion; }
128  int Bandwidth(void) const { return bandwidth; }
129  int CoderateH(void) const { return coderateH; }
130  int CoderateL(void) const { return coderateL; }
131  int Modulation(void) const { return modulation; }
132  int System(void) const { return system; }
133  int Transmission(void) const { return transmission; }
134  int Guard(void) const { return guard; }
135  int Hierarchy(void) const { return hierarchy; }
136  int RollOff(void) const { return rollOff; }
137  int StreamId(void) const { return streamId; }
138  void SetPolarization(char Polarization) { polarization = Polarization; }
139  void SetInversion(int Inversion) { inversion = Inversion; }
140  void SetBandwidth(int Bandwidth) { bandwidth = Bandwidth; }
141  void SetCoderateH(int CoderateH) { coderateH = CoderateH; }
142  void SetCoderateL(int CoderateL) { coderateL = CoderateL; }
143  void SetModulation(int Modulation) { modulation = Modulation; }
144  void SetSystem(int System) { system = System; }
145  void SetTransmission(int Transmission) { transmission = Transmission; }
146  void SetGuard(int Guard) { guard = Guard; }
147  void SetHierarchy(int Hierarchy) { hierarchy = Hierarchy; }
148  void SetRollOff(int RollOff) { rollOff = RollOff; }
149  void SetStreamId(int StreamId) { streamId = StreamId; }
150  cString ToString(char Type) const;
151  bool Parse(const char *s);
152  };
153 
154 class cDvbTuner;
155 
157 
158 class cDvbDevice : public cDevice {
159 protected:
160  static cString DvbName(const char *Name, int Adapter, int Frontend);
161  static int DvbOpen(const char *Name, int Adapter, int Frontend, int Mode, bool ReportError = false);
162 private:
163  static bool Exists(int Adapter, int Frontend);
165  static bool Probe(int Adapter, int Frontend);
167 public:
168  static bool Initialize(void);
172 protected:
174 private:
175  dvb_frontend_info frontendInfo;
179  int fd_dvr, fd_ca;
183  bool QueryDeliverySystems(int fd_frontend);
184 public:
185  cDvbDevice(int Adapter, int Frontend);
186  virtual ~cDvbDevice();
187  int Adapter(void) const { return adapter; }
188  int Frontend(void) const { return frontend; }
189  virtual bool Ready(void);
190  virtual cString DeviceType(void) const;
191  virtual cString DeviceName(void) const;
192  static bool BondDevices(const char *Bondings);
198  static void UnBondDevices(void);
200  bool Bond(cDvbDevice *Device);
208  void UnBond(void);
212  bool BondingOk(const cChannel *Channel, bool ConsiderOccupied = false) const;
219 
220 // Common Interface facilities:
221 
222 private:
224 
225 // Channel facilities
226 
227 private:
229 public:
230  virtual bool ProvidesDeliverySystem(int DeliverySystem) const;
231  virtual bool ProvidesSource(int Source) const;
232  virtual bool ProvidesTransponder(const cChannel *Channel) const;
233  virtual bool ProvidesChannel(const cChannel *Channel, int Priority = IDLEPRIORITY, bool *NeedsDetachReceivers = NULL) const;
234  virtual bool ProvidesEIT(void) const;
235  virtual int NumProvidedSystems(void) const;
236  virtual int SignalStrength(void) const;
237  virtual int SignalQuality(void) const;
238  virtual const cChannel *GetCurrentlyTunedTransponder(void) const;
239  virtual bool IsTunedToTransponder(const cChannel *Channel) const;
240  virtual bool MaySwitchTransponder(const cChannel *Channel) const;
241 protected:
242  virtual bool SetChannelDevice(const cChannel *Channel, bool LiveView);
243 public:
244  virtual bool HasLock(int TimeoutMs = 0) const;
245 
246 // PID handle facilities
247 
248 protected:
249  virtual bool SetPid(cPidHandle *Handle, int Type, bool On);
250 
251 // Section filter facilities
252 
253 protected:
254  virtual int OpenFilter(u_short Pid, u_char Tid, u_char Mask);
255  virtual void CloseFilter(int Handle);
256 
257 // Common Interface facilities:
258 
259 public:
260  virtual bool HasCi(void);
261 
262 // Audio facilities
263 
264 protected:
266 public:
267  static void SetTransferModeForDolbyDigital(int Mode); // needs to be here for backwards compatibility
273 
274 // Receiver facilities
275 
276 private:
278 protected:
279  virtual bool OpenDvr(void);
280  virtual void CloseDvr(void);
281  virtual bool GetTSPacket(uchar *&Data);
282  virtual void DetachAllReceivers(void);
283  };
284 
285 // A plugin that implements a DVB device derived from cDvbDevice needs to create
286 // a cDvbDeviceProbe derived object on the heap in order to have its Probe()
287 // function called, where it can actually create the appropriate device.
288 // The cDvbDeviceProbe object must be created in the plugin's constructor,
289 // and deleted in its destructor.
290 
291 class cDvbDeviceProbe : public cListObject {
292 public:
293  cDvbDeviceProbe(void);
294  virtual ~cDvbDeviceProbe();
295  static uint32_t GetSubsystemId(int Adapter, int Frontend);
296  virtual bool Probe(int Adapter, int Frontend) = 0;
300  };
301 
303 
304 #endif //__DVBDEVICE_H
virtual ~cDvbDeviceProbe()
Definition: dvbdevice.c:1632
cDvbTransponderParameters(const char *Parameters=NULL)
Definition: dvbdevice.c:195
unsigned char uchar
Definition: tools.h:30
virtual ~cDvbDevice()
Definition: dvbdevice.c:1051
const tDvbParameterMap GuardValues[]
Definition: dvbdevice.c:115
virtual bool ProvidesSource(int Source) const
Returns true if this device can provide the given source.
Definition: dvbdevice.c:1448
int PrintParameter(char *p, char Name, int Value) const
Definition: dvbdevice.c:212
virtual cString DeviceType(void) const
Returns a string identifying the type of this device (like "DVB-S").
Definition: dvbdevice.c:1105
static bool Exists(int Adapter, int Frontend)
Checks whether the given adapter/frontend exists.
Definition: dvbdevice.c:1075
void SetTransmission(int Transmission)
Definition: dvbdevice.h:145
void SetPolarization(char Polarization)
Definition: dvbdevice.h:138
const tDvbParameterMap HierarchyValues[]
Definition: dvbdevice.c:127
const char * ParseParameter(const char *s, int &Value, const tDvbParameterMap *Map=NULL)
Definition: dvbdevice.c:238
virtual bool IsTunedToTransponder(const cChannel *Channel) const
Returns true if this device is currently tuned to the given Channel's transponder.
Definition: dvbdevice.c:1557
static bool Initialize(void)
Initializes the DVB devices.
Definition: dvbdevice.c:1121
virtual bool GetTSPacket(uchar *&Data)
Gets exactly one TS packet from the DVR of this device and returns a pointer to it in Data...
Definition: dvbdevice.c:1603
cDvbTuner * dvbTuner
Definition: dvbdevice.h:228
int fd_dvr
Definition: dvbdevice.h:179
void UnBond(void)
Removes this device from any bonding it might have with other devices.
Definition: dvbdevice.c:1340
cTSBuffer * tsBuffer
< Controls how the DVB device handles Transfer Mode when replaying Dolby Digital audio.
Definition: dvbdevice.h:277
virtual int SignalQuality(void) const
Returns the "quality" of the currently received signal.
Definition: dvbdevice.c:1547
int Adapter(void) const
Definition: dvbdevice.h:187
cDvbDeviceProbe(void)
Definition: dvbdevice.c:1627
static uint32_t GetSubsystemId(int Adapter, int Frontend)
Definition: dvbdevice.c:1637
bool Parse(const char *s)
Definition: dvbdevice.c:254
virtual bool SetChannelDevice(const cChannel *Channel, bool LiveView)
Sets the device to the given channel (actual physical setup).
Definition: dvbdevice.c:1567
int DriverIndex(int Value, const tDvbParameterMap *Map)
Definition: dvbdevice.c:155
Definition: tools.h:479
const tDvbParameterMap InversionValues[]
Definition: dvbdevice.c:39
int UserIndex(int Value, const tDvbParameterMap *Map)
Definition: dvbdevice.c:144
int Guard(void) const
Definition: dvbdevice.h:134
const tDvbParameterMap ModulationValues[]
Definition: dvbdevice.c:72
int MapToDriver(int Value, const tDvbParameterMap *Map)
Definition: dvbdevice.c:185
int Bandwidth(void) const
Definition: dvbdevice.h:128
cString ToString(char Type) const
Definition: dvbdevice.c:217
bool QueryDeliverySystems(int fd_frontend)
Definition: dvbdevice.c:1176
void SetCoderateH(int CoderateH)
Definition: dvbdevice.h:141
bool needsDetachBondedReceivers
Definition: dvbdevice.h:182
void SetRollOff(int RollOff)
Definition: dvbdevice.h:148
const tDvbParameterMap BandwidthValues[]
Definition: dvbdevice.c:46
int frontend
Definition: dvbdevice.h:173
int Modulation(void) const
Definition: dvbdevice.h:131
const tDvbParameterMap RollOffValues[]
Definition: dvbdevice.c:136
#define IDLEPRIORITY
Definition: config.h:45
int Frontend(void) const
Definition: dvbdevice.h:188
cCiAdapter * ciAdapter
Definition: dvbdevice.h:223
char Polarization(void) const
Definition: dvbdevice.h:126
const tDvbParameterMap CoderateValues[]
Definition: dvbdevice.c:56
static bool BondDevices(const char *Bondings)
Bonds the devices as defined in the given Bondings string.
Definition: dvbdevice.c:1267
static bool Probe(int Adapter, int Frontend)
Probes for existing DVB devices.
Definition: dvbdevice.c:1092
virtual bool SetPid(cPidHandle *Handle, int Type, bool On)
Does the actual PID setting on this device.
Definition: dvbdevice.c:1370
int numModulations
Definition: dvbdevice.h:178
void SetSystem(int System)
Definition: dvbdevice.h:144
#define MAXDELIVERYSYSTEMS
Definition: dvbdevice.h:71
const tDvbParameterMap TransmissionValues[]
Definition: dvbdevice.c:104
cDvbDevice * bondedDevice
Definition: dvbdevice.h:181
virtual bool Probe(int Adapter, int Frontend)=0
Probes for a DVB device at the given Adapter and creates the appropriate object derived from cDvbDevi...
static cMutex bondMutex
Definition: dvbdevice.h:180
virtual cString DeviceName(void) const
Returns a string identifying the name of this device.
Definition: dvbdevice.c:1116
Definition: ci.h:79
virtual bool Ready(void)
Returns true if this device is ready.
Definition: dvbdevice.c:1260
virtual void CloseDvr(void)
Shuts down the DVR.
Definition: dvbdevice.c:1593
int StreamId(void) const
Definition: dvbdevice.h:137
int RollOff(void) const
Definition: dvbdevice.h:136
virtual void CloseFilter(int Handle)
Closes a file handle that has previously been opened by OpenFilter().
Definition: dvbdevice.c:1434
int adapter
Definition: dvbdevice.h:173
cList< cDvbDeviceProbe > DvbDeviceProbes
Definition: dvbdevice.c:1625
int deliverySystems[MAXDELIVERYSYSTEMS]
Definition: dvbdevice.h:176
Definition: thread.h:63
virtual bool OpenDvr(void)
Opens the DVR of this device and prepares it to deliver a Transport Stream for use in a cReceiver...
Definition: dvbdevice.c:1584
virtual void DetachAllReceivers(void)
Detaches all receivers from this device.
Definition: dvbdevice.c:1612
static void UnBondDevices(void)
Unbonds all devices.
Definition: dvbdevice.c:1308
virtual const cChannel * GetCurrentlyTunedTransponder(void) const
Returns a pointer to the currently tuned transponder.
Definition: dvbdevice.c:1552
virtual bool HasCi(void)
Returns true if this device has a Common Interface.
Definition: dvbdevice.c:1365
int Priority(void) const
Returns the priority of the current receiving session (-MAXPRIORITY..MAXPRIORITY), or IDLEPRIORITY if no receiver is currently active.
Definition: device.c:1557
virtual bool HasLock(int TimeoutMs=0) const
Returns true if the device has a lock on the requested transponder.
Definition: dvbdevice.c:1574
virtual int NumProvidedSystems(void) const
Returns the number of individual "delivery systems" this device provides.
Definition: dvbdevice.c:1537
dvb_frontend_info frontendInfo
Definition: dvbdevice.h:175
const tDvbParameterMap SystemValuesSat[]
Definition: dvbdevice.c:92
const char * MapToUserString(int Value, const tDvbParameterMap *Map)
Definition: dvbdevice.c:177
int Transmission(void) const
Definition: dvbdevice.h:133
virtual bool ProvidesDeliverySystem(int DeliverySystem) const
Definition: dvbdevice.c:1439
static int setTransferModeForDolbyDigital
Definition: dvbdevice.h:265
int MapToUser(int Value, const tDvbParameterMap *Map, const char **String=NULL)
Definition: dvbdevice.c:166
unsigned char u_char
Definition: headers.h:24
bool Bond(cDvbDevice *Device)
Bonds this device with the given Device, making both of them use the same satellite cable and LNB...
Definition: dvbdevice.c:1316
int Inversion(void) const
Definition: dvbdevice.h:127
virtual bool ProvidesTransponder(const cChannel *Channel) const
Returns true if this device can provide the transponder of the given Channel (which implies that it c...
Definition: dvbdevice.c:1458
void SetStreamId(int StreamId)
Definition: dvbdevice.h:149
void SetHierarchy(int Hierarchy)
Definition: dvbdevice.h:147
virtual bool ProvidesChannel(const cChannel *Channel, int Priority=IDLEPRIORITY, bool *NeedsDetachReceivers=NULL) const
Returns true if this device can provide the given channel.
Definition: dvbdevice.c:1482
int CoderateH(void) const
Definition: dvbdevice.h:129
The cDvbDevice implements a DVB device which can be accessed through the Linux DVB driver API...
Definition: dvbdevice.h:158
void SetGuard(int Guard)
Definition: dvbdevice.h:146
void SetCoderateL(int CoderateL)
Definition: dvbdevice.h:142
bool BondingOk(const cChannel *Channel, bool ConsiderOccupied=false) const
Returns true if this device is either not bonded to any other device, or the given Channel is on the ...
Definition: dvbdevice.c:1357
int System(void) const
Definition: dvbdevice.h:132
Derived cDevice classes that can receive channels will have to provide Transport Stream (TS) packets ...
Definition: device.h:816
virtual int OpenFilter(u_short Pid, u_char Tid, u_char Mask)
Opens a file handle for the given filter data.
Definition: dvbdevice.c:1410
void SetInversion(int Inversion)
Definition: dvbdevice.h:139
cDvbDevice(int Adapter, int Frontend)
Definition: dvbdevice.c:1013
int numDeliverySystems
Definition: dvbdevice.h:177
virtual int SignalStrength(void) const
Returns the "strength" of the currently received signal.
Definition: dvbdevice.c:1542
int CoderateL(void) const
Definition: dvbdevice.h:130
const char * userString
Definition: dvbdevice.h:87
virtual bool MaySwitchTransponder(const cChannel *Channel) const
Returns true if it is ok to switch to the Channel's transponder on this device, without disturbing an...
Definition: dvbdevice.c:1562
static cString DvbName(const char *Name, int Adapter, int Frontend)
Definition: dvbdevice.c:1061
The cDevice class is the base from which actual devices can be derived.
Definition: device.h:104
Definition: tools.h:166
static int DvbOpen(const char *Name, int Adapter, int Frontend, int Mode, bool ReportError=false)
Definition: dvbdevice.c:1066
static void SetTransferModeForDolbyDigital(int Mode)
Definition: dvbdevice.c:1579
int Hierarchy(void) const
Definition: dvbdevice.h:135
const tDvbParameterMap SystemValuesTerr[]
Definition: dvbdevice.c:98
virtual bool ProvidesEIT(void) const
Returns true if this device provides EIT data and thus wants to be tuned to the channels it can recei...
Definition: dvbdevice.c:1532
void SetBandwidth(int Bandwidth)
Definition: dvbdevice.h:140
void SetModulation(int Modulation)
Definition: dvbdevice.h:143