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