add writeback of metadata
[enigma2.git] / lib / service / iservice.h
1 #ifndef __lib_dvb_iservice_h
2 #define __lib_dvb_iservice_h
3
4 #include <lib/python/swig.h>
5 #include <lib/python/python.h>
6 #include <lib/base/object.h>
7 #include <string>
8 #include <connection.h>
9 #include <list>
10
11 class eServiceEvent;
12
13 class eServiceReference
14 {
15 public:
16         enum
17         {
18                 idInvalid=-1,
19                 idStructure,    // service_id == 0 is root
20                 idDVB,
21                 idFile,
22                 idUser=0x1000
23         };
24         int type;
25
26         enum
27         {
28                 isDirectory=1,          // SHOULD enter  (implies mustDescent)
29                 mustDescent=2,          // cannot be played directly - often used with "isDirectory" (implies canDescent)
30                 /*
31                         for example:
32                                 normal services have none of them - they can be fed directly into the "play"-handler.
33                                 normal directories have both of them set - you cannot play a directory directly and the UI should descent into it.
34                                 playlists have "mustDescent", but not "isDirectory" - you don't want the user to browse inside the playlist (unless he really wants)
35                                 services with sub-services have none of them, instead the have the "canDecsent" flag (as all of the above)
36                 */
37                 canDescent=4,                   // supports enterDirectory/leaveDirectory
38                 flagDirectory=isDirectory|mustDescent|canDescent,
39                 shouldSort=8,                   // should be ASCII-sorted according to service_name. great for directories.
40                 hasSortKey=16,          // has a sort key in data[3]. not having a sort key implies 0.
41                 sort1=32,                                       // sort key is 1 instead of 0
42                 isMarker=64                     // Marker
43         };
44         int flags; // flags will NOT be compared.
45
46         inline int getSortKey() const { return (flags & hasSortKey) ? data[3] : ((flags & sort1) ? 1 : 0); }
47
48 #ifndef SWIG
49         int data[8];
50         std::string path;
51 #endif
52         std::string getPath() { return path; }
53         void setPath( const std::string &n ) { path=n; }
54
55         unsigned int getUnsignedData(unsigned int num) const
56         {
57                 if ( num < sizeof(data)/sizeof(int) )
58                         return data[num];
59                 return 0;
60         }
61
62         int getData(unsigned int num) const
63         {
64                 if ( num < sizeof(data)/sizeof(int) )
65                         return data[num];
66                 return 0;
67         }
68
69         void setUnsignedData(unsigned int num, unsigned int val)
70         {
71                 if ( num < sizeof(data)/sizeof(int) )
72                         data[num] = val;
73         }
74
75         void setData(unsigned int num, int val)
76         {
77                 if ( num < sizeof(data)/sizeof(int) )
78                         data[num] = val;
79         }
80
81 // only for override service names in bouquets or to give servicerefs a name which not have a
82 // real existing service ( for dvb eServiceDVB )
83 #ifndef SWIG
84         std::string name;
85 #endif
86         std::string getName() { return name; }
87         void setName( const std::string &n ) { name=n; }
88
89         eServiceReference()
90                 : type(idInvalid), flags(0)
91         {
92                 memset(data, 0, sizeof(data));
93         }
94 #ifndef SWIG
95         eServiceReference(int type, int flags)
96                 : type(type), flags(flags)
97         {
98                 memset(data, 0, sizeof(data));
99         }
100         eServiceReference(int type, int flags, int data0)
101                 : type(type), flags(flags)
102         {
103                 memset(data, 0, sizeof(data));
104                 data[0]=data0;
105         }
106         eServiceReference(int type, int flags, int data0, int data1)
107                 : type(type), flags(flags)
108         {
109                 memset(data, 0, sizeof(data));
110                 data[0]=data0;
111                 data[1]=data1;
112         }
113         eServiceReference(int type, int flags, int data0, int data1, int data2)
114                 : type(type), flags(flags)
115         {
116                 memset(data, 0, sizeof(data));
117                 data[0]=data0;
118                 data[1]=data1;
119                 data[2]=data2;
120         }
121         eServiceReference(int type, int flags, int data0, int data1, int data2, int data3)
122                 : type(type), flags(flags)
123         {
124                 memset(data, 0, sizeof(data));
125                 data[0]=data0;
126                 data[1]=data1;
127                 data[2]=data2;
128                 data[3]=data3;
129         }
130         eServiceReference(int type, int flags, int data0, int data1, int data2, int data3, int data4)
131                 : type(type), flags(flags)
132         {
133                 memset(data, 0, sizeof(data));
134                 data[0]=data0;
135                 data[1]=data1;
136                 data[2]=data2;
137                 data[3]=data3;
138                 data[4]=data4;
139         }
140         eServiceReference(int type, int flags, const std::string &path)
141                 : type(type), flags(flags), path(path)
142         {
143                 memset(data, 0, sizeof(data));
144         }
145 #endif
146         eServiceReference(const std::string &string);
147         std::string toString() const;
148         std::string toCompareString() const;
149         bool operator==(const eServiceReference &c) const
150         {
151                 if (type != c.type)
152                         return 0;
153                 return (memcmp(data, c.data, sizeof(int)*8)==0) && (path == c.path);
154         }
155         bool operator!=(const eServiceReference &c) const
156         {
157                 return !(*this == c);
158         }
159         bool operator<(const eServiceReference &c) const
160         {
161                 if (type < c.type)
162                         return 1;
163
164                 if (type > c.type)
165                         return 0;
166
167                 int r=memcmp(data, c.data, sizeof(int)*8);
168                 if (r)
169                         return r < 0;
170                 return path < c.path;
171         }
172         operator bool() const
173         {
174                 return valid();
175         }
176         
177         int valid() const
178         {
179                 return type != idInvalid;
180         }
181 };
182
183 SWIG_ALLOW_OUTPUT_SIMPLE(eServiceReference);
184
185 extern PyObject *New_eServiceReference(const eServiceReference &ref); // defined in enigma_python.i
186
187 typedef long long pts_t;
188
189         /* the reason we have the servicereference as additional argument is
190            that we don't have to create one object for every entry in a possibly
191            large list, provided that no state information is nessesary to deliver
192            the required information. Anyway - ref *must* be the same as the argument
193            to the info() or getIServiceInformation call! */
194
195         /* About the usage of SWIG_VOID:
196            SWIG_VOID(real_returntype_t) hides a return value from swig. This is used for
197            the "superflouus" RESULT return values.
198            
199            Python code has to check the returned pointer against 0. This works,
200            as all functions returning instances in smartpointers AND having a 
201            RESULT have to BOTH return non-zero AND set the pointer to zero.
202            
203            Python code thus can't check for the reason, but the reason isn't
204            user-servicable anyway. If you want to return a real reason which
205            goes beyong "it just doesn't work", use extra variables for this,
206            not the RESULT.
207            
208            Hide the result only if there is another way to check for failure! */
209            
210 TEMPLATE_TYPEDEF(ePtr<eServiceEvent>, eServiceEventPtr);
211         
212 class iStaticServiceInformation: public iObject
213 {
214 #ifdef SWIG
215         iStaticServiceInformation();
216         ~iStaticServiceInformation();
217 #endif
218 public:
219         virtual SWIG_VOID(RESULT) getName(const eServiceReference &ref, std::string &SWIG_OUTPUT)=0;
220         
221                 // doesn't need to be implemented, should return -1 then.
222         virtual int getLength(const eServiceReference &ref);
223         virtual SWIG_VOID(RESULT) getEvent(const eServiceReference &ref, ePtr<eServiceEvent> &SWIG_OUTPUT, time_t start_time=-1);
224                 // returns true when not implemented
225         virtual bool isPlayable(const eServiceReference &ref, const eServiceReference &ignore);
226
227         virtual int getInfo(const eServiceReference &ref, int w);
228         virtual std::string getInfoString(const eServiceReference &ref,int w);
229 };
230
231 TEMPLATE_TYPEDEF(ePtr<iStaticServiceInformation>, iStaticServiceInformationPtr);
232
233 class iServiceInformation: public iObject
234 {
235 #ifdef SWIG
236         iServiceInformation();
237         ~iServiceInformation();
238 #endif
239 public:
240         virtual SWIG_VOID(RESULT) getName(std::string &SWIG_OUTPUT)=0;
241         virtual SWIG_VOID(RESULT) getEvent(ePtr<eServiceEvent> &SWIG_OUTPUT, int nownext);
242
243         enum {
244                 sIsCrypted,  /* is encrypted (no indication if decrypt was possible) */
245                 sAspect,     /* aspect ratio: 0=4:3, 1=16:9, 2=whatever we need */
246                 sIsMultichannel, /* multichannel *available* (probably not selected) */
247                 
248                         /* "user serviceable info" - they are not reliable. Don't use them for anything except the service menu!
249                            that's also the reason why they are so globally defined. 
250                            
251                            
252                            again - if somebody EVER tries to use this information for anything else than simply displaying it,
253                            i will change this to return a user-readable text like "zero x zero three three" (and change the
254                            exact spelling in every version) to stop that!
255                         */
256                 sVideoPID,
257                 sAudioPID,
258                 sPCRPID,
259                 sPMTPID,
260                 sTXTPID,
261                 
262                 sSID,
263                 sONID,
264                 sTSID,
265                 sNamespace,
266                 sProvider,
267                 
268                 sDescription,
269                 sServiceref,
270                 sTimeCreate,    // unix time or string
271                 
272                 sTitle,
273                 sArtist,
274                 sAlbum,
275                 sComment,
276                 sTracknumber,
277                 sGenre,
278                 sCAIDs,
279                 sVideoType,  // MPEG2 MPEG4
280                 
281                 sTags,  /* space seperated list of tags */
282         };
283         enum { resNA = -1, resIsString = -2, resIsPyObject = -3 };
284
285         virtual int getInfo(int w);
286         virtual std::string getInfoString(int w);
287         virtual PyObject *getInfoObject(int w);
288 };
289
290 TEMPLATE_TYPEDEF(ePtr<iServiceInformation>, iServiceInformationPtr);
291
292 class iFrontendInformation: public iObject
293 {
294 #ifdef SWIG
295         iFrontendInformation();
296         ~iFrontendInformation();
297 #endif
298 public:
299         enum {
300                 bitErrorRate,
301                 signalPower,
302                 signalQuality,
303                 lockState,
304                 syncState,
305                 frontendNumber
306         };
307         virtual int getFrontendInfo(int w)=0;
308         virtual PyObject *getFrontendData(bool original=false)=0;
309 };
310
311 TEMPLATE_TYPEDEF(ePtr<iFrontendInformation>, iFrontendInformationPtr);
312
313 class iPauseableService: public iObject
314 {
315 #ifdef SWIG
316         iPausableService();
317         ~iPausableService();
318 #endif
319 public:
320         virtual RESULT pause()=0;
321         virtual RESULT unpause()=0;
322         
323                 /* hm. */
324         virtual RESULT setSlowMotion(int ratio=0)=0;
325         virtual RESULT setFastForward(int ratio=0)=0;
326 };
327
328 TEMPLATE_TYPEDEF(ePtr<iPauseableService>, iPauseableServicePtr);
329
330 class iSeekableService: public iObject
331 {
332 #ifdef SWIG
333         iSeekableService();
334         ~iSeekableService();
335 #endif
336 public:
337         virtual RESULT getLength(pts_t &SWIG_OUTPUT)=0;
338         virtual RESULT seekTo(pts_t to)=0;
339         enum { dirForward = +1, dirBackward = -1 };
340         virtual RESULT seekRelative(int direction, pts_t to)=0;
341         virtual RESULT getPlayPosition(pts_t &SWIG_OUTPUT)=0;
342                 /* if you want to do several seeks in a row, you can enable the trickmode. 
343                    audio will be switched off, sync will be disabled etc. */
344         virtual RESULT setTrickmode(int trick=0)=0;
345         virtual RESULT isCurrentlySeekable()=0;
346 };
347
348 TEMPLATE_TYPEDEF(ePtr<iSeekableService>, iSeekableServicePtr);
349
350 struct iAudioTrackInfo
351 {
352 #ifndef SWIG
353         std::string m_description;
354         std::string m_language; /* iso639 */
355 #endif
356         std::string getDescription() { return m_description; }
357         std::string getLanguage() { return m_language; }
358 };
359
360 SWIG_ALLOW_OUTPUT_SIMPLE(iAudioTrackInfo);
361
362 class iAudioTrackSelection: public iObject
363 {
364 #ifdef SWIG
365         iAudioTrackSelection();
366         ~iAudioTrackSelection();
367 #endif
368 public:
369         virtual int getNumberOfTracks()=0;
370         virtual RESULT selectTrack(unsigned int i)=0;
371         virtual SWIG_VOID(RESULT) getTrackInfo(struct iAudioTrackInfo &SWIG_OUTPUT, unsigned int n)=0;
372 };
373
374 TEMPLATE_TYPEDEF(ePtr<iAudioTrackSelection>, iAudioTrackSelectionPtr);
375
376 class iAudioChannelSelection: public iObject
377 {
378 #ifdef SWIG
379         iAudioChannelSelection();
380         ~iAudioChannelSelection();
381 #endif
382 public:
383         enum { LEFT, STEREO, RIGHT };
384         virtual int getCurrentChannel()=0;
385         virtual RESULT selectChannel(int i)=0;
386 };
387
388 TEMPLATE_TYPEDEF(ePtr<iAudioChannelSelection>, iAudioChannelSelectionPtr);
389
390 class iAudioDelay: public iObject
391 {
392 #ifdef SWIG
393         iAudioDelay();
394         ~iAudioDelay();
395 #endif
396 public:
397         virtual int getAC3Delay()=0;
398         virtual int getPCMDelay()=0;
399         virtual void setAC3Delay(int)=0;
400         virtual void setPCMDelay(int)=0;
401 };
402
403 TEMPLATE_TYPEDEF(ePtr<iAudioDelay>, iAudioDelayPtr);
404
405 class iRadioText: public iObject
406 {
407 #ifdef SWIG
408         iRadioText();
409         ~iRadioText();
410 #endif
411 public:
412         virtual std::string getRadioText(int x=0)=0;
413 };
414
415 TEMPLATE_TYPEDEF(ePtr<iRadioText>, iRadioTextPtr);
416
417 class iSubserviceList: public iObject
418 {
419 #ifdef SWIG
420         iSubserviceList();
421         ~iSubserviceList();
422 #endif
423 public:
424         virtual int getNumberOfSubservices()=0;
425         virtual SWIG_VOID(RESULT) getSubservice(eServiceReference &SWIG_OUTPUT, unsigned int n)=0;
426 };
427
428 TEMPLATE_TYPEDEF(ePtr<iSubserviceList>, iSubserviceListPtr);
429
430 class iTimeshiftService: public iObject
431 {
432 #ifdef SWIG
433         iTimeshiftService();
434         ~iTimeshiftService();
435 #endif
436 public:
437         virtual RESULT startTimeshift()=0;
438         virtual RESULT stopTimeshift()=0;
439         
440         virtual int isTimeshiftActive()=0;
441                         /* this essentially seeks to the relative end of the timeshift buffer */
442         virtual RESULT activateTimeshift()=0;
443 };
444
445 TEMPLATE_TYPEDEF(ePtr<iTimeshiftService>, iTimeshiftServicePtr);
446
447         /* not related to eCueSheet */
448 class iCueSheet: public iObject
449 {
450 #ifdef SWIG
451         iCueSheet();
452         ~iCueSheet();
453 #endif
454 public:
455                         /* returns a list of (pts, what)-tuples */
456         virtual PyObject *getCutList() = 0;
457         virtual void setCutList(PyObject *list) = 0;
458         virtual void setCutListEnable(int enable) = 0;
459         enum { cutIn = 0, cutOut = 1, cutMark = 2 };
460 };
461
462 TEMPLATE_TYPEDEF(ePtr<iCueSheet>, iCueSheetPtr);
463
464 class eWidget;
465 class PyList;
466
467 class iSubtitleOutput: public iObject
468 {
469 public:
470         virtual RESULT enableSubtitles(eWidget *parent, PyObject *entry)=0;
471         virtual RESULT disableSubtitles(eWidget *parent)=0;
472         virtual PyObject *getSubtitleList()=0;
473 };
474
475 TEMPLATE_TYPEDEF(ePtr<iSubtitleOutput>, iSubtitleOutputPtr);
476
477 class iPlayableService: public iObject
478 {
479 #ifdef SWIG
480         iPlayableService();
481         ~iPlaybleService();
482 #endif
483         friend class iServiceHandler;
484 public:
485         enum
486         {
487                         /* these first two events are magical, and should only
488                            be generated if you know what you're doing. */
489                 evStart,
490                 evEnd,
491                 
492                 evTuneFailed,
493                         // when iServiceInformation is implemented:
494                 evUpdatedEventInfo,
495                 evUpdatedInfo,
496
497                         /* when seek() is implemented: */               
498                 evSeekableStatusChanged, /* for example when timeshifting */
499                 
500                 evEOF,
501                 evSOF, /* bounced against start of file (when seeking backwards) */
502                 
503                         /* only when cueSheet is implemented */
504                 evCuesheetChanged,
505
506                 evUpdatedRadioText
507         };
508         virtual RESULT connectEvent(const Slot2<void,iPlayableService*,int> &event, ePtr<eConnection> &connection)=0;
509         virtual RESULT start()=0;
510         virtual RESULT stop()=0;
511                         /* might have to be changed... */
512         virtual RESULT setTarget(int target)=0;
513         virtual SWIG_VOID(RESULT) seek(ePtr<iSeekableService> &SWIG_OUTPUT)=0;
514         virtual SWIG_VOID(RESULT) pause(ePtr<iPauseableService> &SWIG_OUTPUT)=0;
515         virtual SWIG_VOID(RESULT) info(ePtr<iServiceInformation> &SWIG_OUTPUT)=0;
516         virtual SWIG_VOID(RESULT) audioTracks(ePtr<iAudioTrackSelection> &SWIG_OUTPUT)=0;
517         virtual SWIG_VOID(RESULT) audioChannel(ePtr<iAudioChannelSelection> &SWIG_OUTPUT)=0;
518         virtual SWIG_VOID(RESULT) subServices(ePtr<iSubserviceList> &SWIG_OUTPUT)=0;
519         virtual SWIG_VOID(RESULT) frontendInfo(ePtr<iFrontendInformation> &SWIG_OUTPUT)=0;
520         virtual SWIG_VOID(RESULT) timeshift(ePtr<iTimeshiftService> &SWIG_OUTPUT)=0;
521         virtual SWIG_VOID(RESULT) cueSheet(ePtr<iCueSheet> &SWIG_OUTPUT)=0;
522         virtual SWIG_VOID(RESULT) subtitle(ePtr<iSubtitleOutput> &SWIG_OUTPUT)=0;
523         virtual SWIG_VOID(RESULT) audioDelay(ePtr<iAudioDelay> &SWIG_OUTPUT)=0;
524         virtual SWIG_VOID(RESULT) radioText(ePtr<iRadioText> &SWIG_OUTPUT)=0;
525 };
526
527 TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
528
529 class iRecordableService: public iObject
530 {
531 #ifdef SWIG
532         iRecordableService();
533         ~iRecordableService();
534 #endif
535 public:
536         virtual RESULT prepare(const char *filename, time_t begTime=-1, time_t endTime=-1, int eit_event_id=-1)=0;
537         virtual RESULT start()=0;
538         virtual RESULT stop()=0;
539         virtual SWIG_VOID(RESULT) frontendInfo(ePtr<iFrontendInformation> &SWIG_OUTPUT)=0;
540 };
541
542 TEMPLATE_TYPEDEF(ePtr<iRecordableService>, iRecordableServicePtr);
543
544 // TEMPLATE_TYPEDEF(std::list<eServiceReference>, eServiceReferenceList);
545
546 class iMutableServiceList: public iObject
547 {
548 #ifdef SWIG
549         iMutableServiceList();
550         ~iMutableServiceList();
551 #endif
552 public:
553                 /* flush changes */
554         virtual RESULT flushChanges()=0;
555                 /* adds a service to a list */
556         virtual RESULT addService(eServiceReference &ref, eServiceReference before=eServiceReference())=0;
557                 /* removes a service from a list */
558         virtual RESULT removeService(eServiceReference &ref)=0;
559                 /* moves a service in a list, only if list suppports a specific sort method. */
560                 /* pos is the new, absolute position from 0..size-1 */
561         virtual RESULT moveService(eServiceReference &ref, int pos)=0;
562                 /* set name of list, for bouquets this is the visible bouquet name */
563         virtual RESULT setListName(const std::string &name)=0;
564 };
565
566 TEMPLATE_TYPEDEF(ePtr<iMutableServiceList>, iMutableServiceListPtr);
567
568 class iListableService: public iObject
569 {
570 #ifdef SWIG
571         iListableService();
572         ~iListableService();
573 #endif
574 public:
575                 /* legacy interface: get a list */
576         virtual RESULT getContent(std::list<eServiceReference> &list, bool sorted=false)=0;
577         virtual PyObject *getContent(const char* format, bool sorted=false)=0;
578
579                 /* new, shiny interface: streaming. */
580         virtual SWIG_VOID(RESULT) getNext(eServiceReference &SWIG_OUTPUT)=0;
581         
582                 /* use this for sorting. output is not sorted because of either
583                  - performance reasons: the whole list must be buffered or
584                  - the interface would be restricted to a list. streaming
585                    (as well as a future "active" extension) won't be possible.
586                 */
587         virtual int compareLessEqual(const eServiceReference &, const eServiceReference &)=0;
588         
589         virtual SWIG_VOID(RESULT) startEdit(ePtr<iMutableServiceList> &SWIG_OUTPUT)=0;
590 };
591
592 TEMPLATE_TYPEDEF(ePtr<iListableService>, iListableServicePtr);
593
594 #ifndef SWIG
595         /* a helper class which can be used as argument to stl's sort(). */
596 class iListableServiceCompare
597 {
598         ePtr<iListableService> m_list;
599 public:
600         iListableServiceCompare(iListableService *list): m_list(list) { }
601         bool operator()(const eServiceReference &a, const eServiceReference &b)
602         {
603                 return m_list->compareLessEqual(a, b);
604         }
605 };
606 #endif
607
608 class iServiceOfflineOperations: public iObject
609 {
610 #ifdef SWIG
611         iServiceOfflineOperations();
612         ~iServiceOfflineOperations();
613 #endif
614 public:
615                 /* to delete a service, forever. */
616         virtual RESULT deleteFromDisk(int simulate=1)=0;
617         
618                 /* for transferring a service... */
619         virtual SWIG_VOID(RESULT) getListOfFilenames(std::list<std::string> &SWIG_OUTPUT)=0;
620         
621                 // TODO: additional stuff, like a conversion interface?
622 };
623
624 TEMPLATE_TYPEDEF(ePtr<iServiceOfflineOperations>, iServiceOfflineOperationsPtr);
625
626 class iServiceHandler: public iObject
627 {
628 #ifdef SWIG
629         iServiceHandler();
630         ~iServiceHandler();
631 #endif
632 public:
633         virtual SWIG_VOID(RESULT) play(const eServiceReference &, ePtr<iPlayableService> &SWIG_OUTPUT)=0;
634         virtual SWIG_VOID(RESULT) record(const eServiceReference &, ePtr<iRecordableService> &SWIG_OUTPUT)=0;
635         virtual SWIG_VOID(RESULT) list(const eServiceReference &, ePtr<iListableService> &SWIG_OUTPUT)=0;
636         virtual SWIG_VOID(RESULT) info(const eServiceReference &, ePtr<iStaticServiceInformation> &SWIG_OUTPUT)=0;
637         virtual SWIG_VOID(RESULT) offlineOperations(const eServiceReference &, ePtr<iServiceOfflineOperations> &SWIG_OUTPUT)=0;
638 };
639
640 TEMPLATE_TYPEDEF(ePtr<iServiceHandler>, iServiceHandlerPtr);
641
642 #endif