also use refcounting for eTimers
[enigma2.git] / lib / dvb / epgcache.h
1 #ifndef __epgcache_h_
2 #define __epgcache_h_
3
4 #define ENABLE_PRIVATE_EPG 1
5 //#define ENABLE_MHW_EPG 1
6
7 #ifndef SWIG
8
9 #include <vector>
10 #include <list>
11 #include <ext/hash_map>
12 #include <ext/hash_set>
13
14 #include <errno.h>
15
16 #include <lib/dvb/eit.h>
17 #include <lib/dvb/lowlevel/eit.h>
18 #ifdef ENABLE_MHW_EPG
19 #include <lib/dvb/lowlevel/mhw.h>
20 #endif
21 #include <lib/dvb/idvb.h>
22 #include <lib/dvb/demux.h>
23 #include <lib/dvb/dvbtime.h>
24 #include <lib/base/ebase.h>
25 #include <lib/base/thread.h>
26 #include <lib/base/message.h>
27 #include <lib/service/event.h>
28 #include <lib/python/python.h>
29
30 #define CLEAN_INTERVAL 60000    //  1 min
31 #define UPDATE_INTERVAL 3600000  // 60 min
32 #define ZAP_DELAY 2000          // 2 sek
33
34 #define HILO(x) (x##_hi << 8 | x##_lo)
35
36 class eventData;
37 class eServiceReferenceDVB;
38 class eDVBServicePMTHandler;
39
40 struct uniqueEPGKey
41 {
42         int sid, onid, tsid;
43         uniqueEPGKey( const eServiceReference &ref )
44                 :sid( ref.type != eServiceReference::idInvalid ? ((eServiceReferenceDVB&)ref).getServiceID().get() : -1 )
45                 ,onid( ref.type != eServiceReference::idInvalid ? ((eServiceReferenceDVB&)ref).getOriginalNetworkID().get() : -1 )
46                 ,tsid( ref.type != eServiceReference::idInvalid ? ((eServiceReferenceDVB&)ref).getTransportStreamID().get() : -1 )
47         {
48         }
49         uniqueEPGKey()
50                 :sid(-1), onid(-1), tsid(-1)
51         {
52         }
53         uniqueEPGKey( int sid, int onid, int tsid )
54                 :sid(sid), onid(onid), tsid(tsid)
55         {
56         }
57         bool operator <(const uniqueEPGKey &a) const
58         {
59                 return memcmp( &sid, &a.sid, sizeof(int)*3)<0;
60         }
61         operator bool() const
62         { 
63                 return !(sid == -1 && onid == -1 && tsid == -1); 
64         }
65         bool operator==(const uniqueEPGKey &a) const
66         {
67                 return !memcmp( &sid, &a.sid, sizeof(int)*3);
68         }
69         struct equal
70         {
71                 bool operator()(const uniqueEPGKey &a, const uniqueEPGKey &b) const
72                 {
73                         return !memcmp( &a.sid, &b.sid, sizeof(int)*3);
74                 }
75         };
76 };
77
78 //eventMap is sorted by event_id
79 #define eventMap std::map<__u16, eventData*>
80 //timeMap is sorted by beginTime
81 #define timeMap std::map<time_t, eventData*>
82
83 #define channelMapIterator std::map<iDVBChannel*, channel_data*>::iterator
84 #define updateMap std::map<eDVBChannelID, time_t>
85
86 struct hash_uniqueEPGKey
87 {
88         inline size_t operator()( const uniqueEPGKey &x) const
89         {
90                 return (x.onid << 16) | x.tsid;
91         }
92 };
93
94 #define tidMap std::set<__u32>
95 #if defined(__GNUC__) && ((__GNUC__ == 3 && __GNUC_MINOR__ >= 1) || __GNUC__ == 4 )  // check if gcc version >= 3.1
96         #define eventCache __gnu_cxx::hash_map<uniqueEPGKey, std::pair<eventMap, timeMap>, hash_uniqueEPGKey, uniqueEPGKey::equal>
97         #ifdef ENABLE_PRIVATE_EPG
98                 #define contentTimeMap __gnu_cxx::hash_map<time_t, std::pair<time_t, __u16> >
99                 #define contentMap __gnu_cxx::hash_map<int, contentTimeMap >
100                 #define contentMaps __gnu_cxx::hash_map<uniqueEPGKey, contentMap, hash_uniqueEPGKey, uniqueEPGKey::equal >
101         #endif
102 #else // for older gcc use following
103         #define eventCache std::hash_map<uniqueEPGKey, std::pair<eventMap, timeMap>, hash_uniqueEPGKey, uniqueEPGKey::equal >
104         #ifdef ENABLE_PRIVATE_EPG
105                 #define contentTimeMap std::hash_map<time_t, std::pair<time_t, __u16> >
106                 #define contentMap std::hash_map<int, contentTimeMap >
107                 #define contentMaps std::hash_map<uniqueEPGKey, contentMap, hash_uniqueEPGKey, uniqueEPGKey::equal>
108         #endif
109 #endif
110
111 #define descriptorPair std::pair<int,__u8*>
112 #define descriptorMap std::map<__u32, descriptorPair >
113
114 class eventData
115 {
116         friend class eEPGCache;
117 private:
118         __u8* EITdata;
119         __u8 ByteSize;
120         __u8 type;
121         static descriptorMap descriptors;
122         static __u8 data[4108];
123         static int CacheSize;
124         static void load(FILE *);
125         static void save(FILE *);
126 public:
127         eventData(const eit_event_struct* e=NULL, int size=0, int type=0);
128         ~eventData();
129         const eit_event_struct* get() const;
130         operator const eit_event_struct*() const
131         {
132                 return get();
133         }
134         int getEventID()
135         {
136                 return (EITdata[0] << 8) | EITdata[1];
137         }
138         time_t getStartTime()
139         {
140                 return parseDVBtime(EITdata[2], EITdata[3], EITdata[4], EITdata[5], EITdata[6]);
141         }
142         int getDuration()
143         {
144                 return fromBCD(EITdata[7])*3600+fromBCD(EITdata[8])*60+fromBCD(EITdata[9]);
145         }
146 };
147 #endif
148
149 class eEPGCache: public eMainloop, private eThread, public Object
150 {
151 #ifndef SWIG
152         DECLARE_REF(eEPGCache)
153         struct channel_data: public Object
154         {
155                 pthread_mutex_t channel_active;
156                 channel_data(eEPGCache*);
157                 eEPGCache *cache;
158                 ePtr<eTimer> abortTimer, zapTimer;
159                 int prevChannelState;
160                 __u8 state, isRunning, haveData;
161                 ePtr<eDVBChannel> channel;
162                 ePtr<eConnection> m_stateChangedConn, m_NowNextConn, m_ScheduleConn, m_ScheduleOtherConn;
163                 ePtr<iDVBSectionReader> m_NowNextReader, m_ScheduleReader, m_ScheduleOtherReader;
164                 tidMap seenSections[3], calcedSections[3];
165 #ifdef ENABLE_PRIVATE_EPG
166                 ePtr<eTimer> startPrivateTimer;
167                 int m_PrevVersion;
168                 int m_PrivatePid;
169                 uniqueEPGKey m_PrivateService;
170                 ePtr<eConnection> m_PrivateConn;
171                 ePtr<iDVBSectionReader> m_PrivateReader;
172                 std::set<__u8> seenPrivateSections;
173                 void readPrivateData(const __u8 *data);
174                 void startPrivateReader();
175 #endif
176 #ifdef ENABLE_MHW_EPG
177                 std::vector<mhw_channel_name_t> m_channels;
178                 std::map<__u8, mhw_theme_name_t> m_themes;
179                 std::map<__u32, mhw_title_t> m_titles;
180                 std::multimap<__u32, __u32> m_program_ids;
181                 ePtr<eConnection> m_MHWConn, m_MHWConn2;
182                 ePtr<iDVBSectionReader> m_MHWReader, m_MHWReader2;
183                 eDVBSectionFilterMask m_MHWFilterMask, m_MHWFilterMask2;
184                 ePtr<eTimer> m_MHWTimeoutTimer;
185                 bool m_MHWTimeoutet;
186                 void MHWTimeout() { m_MHWTimeoutet=true; }
187                 void readMHWData(const __u8 *data);
188                 void readMHWData2(const __u8 *data);
189                 void startMHWReader(__u16 pid, __u8 tid);
190                 void startMHWReader2(__u16 pid, __u8 tid, int ext=-1);
191                 void startTimeout(int msek);
192                 bool checkTimeout() { return m_MHWTimeoutet; }
193                 void cleanup();
194                 __u8 *delimitName( __u8 *in, __u8 *out, int len_in );
195                 void timeMHW2DVB( u_char hours, u_char minutes, u_char *return_time);
196                 void timeMHW2DVB( int minutes, u_char *return_time);
197                 void timeMHW2DVB( u_char day, u_char hours, u_char minutes, u_char *return_time);
198                 void storeTitle(std::map<__u32, mhw_title_t>::iterator itTitle, std::string sumText, const __u8 *data);
199 #endif
200                 void readData(const __u8 *data);
201                 void startChannel();
202                 void startEPG();
203                 bool finishEPG();
204                 void abortEPG();
205                 void abortNonAvail();
206         };
207         bool FixOverlapping(std::pair<eventMap,timeMap> &servicemap, time_t TM, int duration, const timeMap::iterator &tm_it, const uniqueEPGKey &service);
208 public:
209         enum {PRIVATE=0, NOWNEXT=1, SCHEDULE=2, SCHEDULE_OTHER=4
210 #ifdef ENABLE_MHW_EPG
211         ,MHW=8
212 #endif
213         };
214         struct Message
215         {
216                 enum
217                 {
218                         flush,
219                         startChannel,
220                         leaveChannel,
221                         quit,
222                         got_private_pid,
223                         timeChanged
224                 };
225                 int type;
226                 iDVBChannel *channel;
227                 uniqueEPGKey service;
228                 union {
229                         int err;
230                         time_t time;
231                         bool avail;
232                         int pid;
233                 };
234                 Message()
235                         :type(0), time(0) {}
236                 Message(int type)
237                         :type(type) {}
238                 Message(int type, bool b)
239                         :type(type), avail(b) {}
240                 Message(int type, iDVBChannel *channel, int err=0)
241                         :type(type), channel(channel), err(err) {}
242                 Message(int type, const eServiceReference& service, int err=0)
243                         :type(type), service(service), err(err) {}
244                 Message(int type, time_t time)
245                         :type(type), time(time) {}
246         };
247         eFixedMessagePump<Message> messages;
248 private:
249         friend class channel_data;
250         static eEPGCache *instance;
251
252         ePtr<eTimer> cleanTimer;
253         std::map<iDVBChannel*, channel_data*> m_knownChannels;
254         ePtr<eConnection> m_chanAddedConn;
255
256         eventCache eventDB;
257         updateMap channelLastUpdated;
258         static pthread_mutex_t cache_lock, channel_map_lock;
259
260 #ifdef ENABLE_PRIVATE_EPG
261         contentMaps content_time_tables;
262 #endif
263
264         void thread();  // thread function
265
266 // called from epgcache thread
267         void save();
268         void load();
269 #ifdef ENABLE_PRIVATE_EPG
270         void privateSectionRead(const uniqueEPGKey &, const __u8 *);
271 #endif
272         void sectionRead(const __u8 *data, int source, channel_data *channel);
273         void gotMessage(const Message &message);
274         void flushEPG(const uniqueEPGKey & s=uniqueEPGKey());
275         void cleanLoop();
276
277 // called from main thread
278         void timeUpdated();
279         void DVBChannelAdded(eDVBChannel*);
280         void DVBChannelStateChanged(iDVBChannel*);
281         void DVBChannelRunning(iDVBChannel *);
282
283         timeMap::iterator m_timemap_cursor, m_timemap_end;
284         int currentQueryTsidOnid; // needed for getNextTimeEntry.. only valid until next startTimeQuery call
285 #else
286         eEPGCache();
287         ~eEPGCache();
288 #endif // SWIG
289 public:
290         static eEPGCache *getInstance() { return instance; }
291 #ifndef SWIG
292         eEPGCache();
293         ~eEPGCache();
294
295 #ifdef ENABLE_PRIVATE_EPG
296         void PMTready(eDVBServicePMTHandler *pmthandler);
297 #else
298         void PMTready(eDVBServicePMTHandler *pmthandler) {}
299 #endif
300
301 #endif
302         // called from main thread
303         inline void Lock();
304         inline void Unlock();
305
306         // at moment just for one service..
307         RESULT startTimeQuery(const eServiceReference &service, time_t begin=-1, int minutes=-1);
308
309 #ifndef SWIG
310         // eventData's are plain entrys out of the cache.. it's not safe to use them after cache unlock
311         // but its faster in use... its not allowed to delete this pointers via delete or free..
312         RESULT lookupEventId(const eServiceReference &service, int event_id, const eventData *&);
313         RESULT lookupEventTime(const eServiceReference &service, time_t, const eventData *&, int direction=0);
314         RESULT getNextTimeEntry(const eventData *&);
315
316         // eit_event_struct's are plain dvb eit_events .. it's not safe to use them after cache unlock
317         // its not allowed to delete this pointers via delete or free..
318         RESULT lookupEventId(const eServiceReference &service, int event_id, const eit_event_struct *&);
319         RESULT lookupEventTime(const eServiceReference &service, time_t , const eit_event_struct *&, int direction=0);
320         RESULT getNextTimeEntry(const eit_event_struct *&);
321
322         // Event's are parsed epg events.. it's safe to use them after cache unlock
323         // after use this Events must be deleted (memleaks)
324         RESULT lookupEventId(const eServiceReference &service, int event_id, Event* &);
325         RESULT lookupEventTime(const eServiceReference &service, time_t, Event* &, int direction=0);
326         RESULT getNextTimeEntry(Event *&);
327 #endif
328         enum {
329                 SIMILAR_BROADCASTINGS_SEARCH,
330                 EXAKT_TITLE_SEARCH,
331                 PARTIAL_TITLE_SEARCH
332         };
333         enum {
334                 CASE_CHECK,
335                 NO_CASE_CHECK
336         };
337         PyObject *lookupEvent(SWIG_PYOBJECT(ePyObject) list, SWIG_PYOBJECT(ePyObject) convertFunc=(PyObject*)0);
338         PyObject *search(SWIG_PYOBJECT(ePyObject));
339
340         // eServiceEvent are parsed epg events.. it's safe to use them after cache unlock
341         // for use from python ( members: m_start_time, m_duration, m_short_description, m_extended_description )
342         SWIG_VOID(RESULT) lookupEventId(const eServiceReference &service, int event_id, ePtr<eServiceEvent> &SWIG_OUTPUT);
343         SWIG_VOID(RESULT) lookupEventTime(const eServiceReference &service, time_t, ePtr<eServiceEvent> &SWIG_OUTPUT, int direction=0);
344         SWIG_VOID(RESULT) getNextTimeEntry(ePtr<eServiceEvent> &SWIG_OUTPUT);
345 };
346
347 #ifndef SWIG
348 inline void eEPGCache::Lock()
349 {
350         pthread_mutex_lock(&cache_lock);
351 }
352
353 inline void eEPGCache::Unlock()
354 {
355         pthread_mutex_unlock(&cache_lock);
356 }
357 #endif
358
359 #endif