1 #ifndef __lib_dvb_iservice_h
2 #define __lib_dvb_iservice_h
4 #include <lib/python/swig.h>
5 #include <lib/python/python.h>
6 #include <lib/base/object.h>
8 #include <connection.h>
13 class eServiceReference
19 idStructure, // service_id == 0 is root
28 isDirectory=1, // SHOULD enter (implies mustDescent)
29 mustDescent=2, // cannot be played directly - often used with "isDirectory" (implies canDescent)
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)
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
44 int flags; // flags will NOT be compared.
46 inline int getSortKey() const { return (flags & hasSortKey) ? data[3] : ((flags & sort1) ? 1 : 0); }
52 std::string getPath() { return path; }
53 void setPath( const std::string &n ) { path=n; }
55 unsigned int getUnsignedData(unsigned int num) const
57 if ( num < sizeof(data)/sizeof(int) )
62 int getData(unsigned int num) const
64 if ( num < sizeof(data)/sizeof(int) )
69 void setUnsignedData(unsigned int num, unsigned int val)
71 if ( num < sizeof(data)/sizeof(int) )
75 void setData(unsigned int num, int val)
77 if ( num < sizeof(data)/sizeof(int) )
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 )
86 std::string getName() { return name; }
87 void setName( const std::string &n ) { name=n; }
90 : type(idInvalid), flags(0)
92 memset(data, 0, sizeof(data));
95 eServiceReference(int type, int flags)
96 : type(type), flags(flags)
98 memset(data, 0, sizeof(data));
100 eServiceReference(int type, int flags, int data0)
101 : type(type), flags(flags)
103 memset(data, 0, sizeof(data));
106 eServiceReference(int type, int flags, int data0, int data1)
107 : type(type), flags(flags)
109 memset(data, 0, sizeof(data));
113 eServiceReference(int type, int flags, int data0, int data1, int data2)
114 : type(type), flags(flags)
116 memset(data, 0, sizeof(data));
121 eServiceReference(int type, int flags, int data0, int data1, int data2, int data3)
122 : type(type), flags(flags)
124 memset(data, 0, sizeof(data));
130 eServiceReference(int type, int flags, int data0, int data1, int data2, int data3, int data4)
131 : type(type), flags(flags)
133 memset(data, 0, sizeof(data));
140 eServiceReference(int type, int flags, const std::string &path)
141 : type(type), flags(flags), path(path)
143 memset(data, 0, sizeof(data));
146 eServiceReference(const std::string &string);
147 std::string toString() const;
148 std::string toCompareString() const;
149 bool operator==(const eServiceReference &c) const
153 return (memcmp(data, c.data, sizeof(int)*8)==0) && (path == c.path);
155 bool operator!=(const eServiceReference &c) const
157 return !(*this == c);
159 bool operator<(const eServiceReference &c) const
167 int r=memcmp(data, c.data, sizeof(int)*8);
170 return path < c.path;
172 operator bool() const
179 return type != idInvalid;
183 SWIG_ALLOW_OUTPUT_SIMPLE(eServiceReference);
185 extern PyObject *New_eServiceReference(const eServiceReference &ref); // defined in enigma_python.i
188 #ifdef PYTHON_REFCOUNT_DEBUG
189 inline ePyObject Impl_New_eServiceReference(const char* file, int line, const eServiceReference &ref)
191 return ePyObject(New_eServiceReference(ref), file, line);
193 #define NEW_eServiceReference(ref) Impl_New_eServiceReference(__FILE__, __LINE__, ref)
195 inline ePyObject Impl_New_eServiceReference(const eServiceReference &ref)
197 return New_eServiceReference(ref);
199 #define NEW_eServiceReference(ref) Impl_New_eServiceReference(ref)
203 typedef long long pts_t;
205 /* the reason we have the servicereference as additional argument is
206 that we don't have to create one object for every entry in a possibly
207 large list, provided that no state information is nessesary to deliver
208 the required information. Anyway - ref *must* be the same as the argument
209 to the info() or getIServiceInformation call! */
211 /* About the usage of SWIG_VOID:
212 SWIG_VOID(real_returntype_t) hides a return value from swig. This is used for
213 the "superflouus" RESULT return values.
215 Python code has to check the returned pointer against 0. This works,
216 as all functions returning instances in smartpointers AND having a
217 RESULT have to BOTH return non-zero AND set the pointer to zero.
219 Python code thus can't check for the reason, but the reason isn't
220 user-servicable anyway. If you want to return a real reason which
221 goes beyong "it just doesn't work", use extra variables for this,
224 Hide the result only if there is another way to check for failure! */
226 TEMPLATE_TYPEDEF(ePtr<eServiceEvent>, eServiceEventPtr);
228 class iStaticServiceInformation: public iObject
231 iStaticServiceInformation();
232 ~iStaticServiceInformation();
235 virtual SWIG_VOID(RESULT) getName(const eServiceReference &ref, std::string &SWIG_OUTPUT)=0;
237 // doesn't need to be implemented, should return -1 then.
238 virtual int getLength(const eServiceReference &ref);
239 virtual SWIG_VOID(RESULT) getEvent(const eServiceReference &ref, ePtr<eServiceEvent> &SWIG_OUTPUT, time_t start_time=-1);
240 // returns true when not implemented
241 virtual bool isPlayable(const eServiceReference &ref, const eServiceReference &ignore);
243 virtual int getInfo(const eServiceReference &ref, int w);
244 virtual std::string getInfoString(const eServiceReference &ref,int w);
246 virtual int setInfo(const eServiceReference &ref, int w, int v);
247 virtual int setInfoString(const eServiceReference &ref, int w, const char *v);
250 TEMPLATE_TYPEDEF(ePtr<iStaticServiceInformation>, iStaticServiceInformationPtr);
252 class iServiceInformation: public iObject
255 iServiceInformation();
256 ~iServiceInformation();
259 virtual SWIG_VOID(RESULT) getName(std::string &SWIG_OUTPUT)=0;
260 virtual SWIG_VOID(RESULT) getEvent(ePtr<eServiceEvent> &SWIG_OUTPUT, int nownext);
263 sIsCrypted, /* is encrypted (no indication if decrypt was possible) */
264 sAspect, /* aspect ratio: 0=4:3, 1=16:9, 2=whatever we need */
265 sIsMultichannel, /* multichannel *available* (probably not selected) */
267 /* "user serviceable info" - they are not reliable. Don't use them for anything except the service menu!
268 that's also the reason why they are so globally defined.
271 again - if somebody EVER tries to use this information for anything else than simply displaying it,
272 i will change this to return a user-readable text like "zero x zero three three" (and change the
273 exact spelling in every version) to stop that!
289 sTimeCreate, // unix time or string
298 sVideoType, // MPEG2 MPEG4
300 sTags, /* space seperated list of tags */
302 enum { resNA = -1, resIsString = -2, resIsPyObject = -3 };
304 virtual int getInfo(int w);
305 virtual std::string getInfoString(int w);
306 virtual PyObject *getInfoObject(int w);
308 virtual int setInfo(int w, int v);
309 virtual int setInfoString(int w, const char *v);
312 TEMPLATE_TYPEDEF(ePtr<iServiceInformation>, iServiceInformationPtr);
314 class iFrontendInformation: public iObject
317 iFrontendInformation();
318 ~iFrontendInformation();
329 virtual int getFrontendInfo(int w)=0;
330 virtual PyObject *getFrontendData(bool original=false)=0;
333 TEMPLATE_TYPEDEF(ePtr<iFrontendInformation>, iFrontendInformationPtr);
335 class iPauseableService: public iObject
342 virtual RESULT pause()=0;
343 virtual RESULT unpause()=0;
346 virtual RESULT setSlowMotion(int ratio=0)=0;
347 virtual RESULT setFastForward(int ratio=0)=0;
350 TEMPLATE_TYPEDEF(ePtr<iPauseableService>, iPauseableServicePtr);
352 class iSeekableService: public iObject
359 virtual RESULT getLength(pts_t &SWIG_OUTPUT)=0;
360 virtual RESULT seekTo(pts_t to)=0;
361 enum { dirForward = +1, dirBackward = -1 };
362 virtual RESULT seekRelative(int direction, pts_t to)=0;
363 virtual RESULT getPlayPosition(pts_t &SWIG_OUTPUT)=0;
364 /* if you want to do several seeks in a row, you can enable the trickmode.
365 audio will be switched off, sync will be disabled etc. */
366 virtual RESULT setTrickmode(int trick=0)=0;
367 virtual RESULT isCurrentlySeekable()=0;
370 TEMPLATE_TYPEDEF(ePtr<iSeekableService>, iSeekableServicePtr);
372 struct iAudioTrackInfo
375 std::string m_description;
376 std::string m_language; /* iso639 */
378 std::string getDescription() { return m_description; }
379 std::string getLanguage() { return m_language; }
382 SWIG_ALLOW_OUTPUT_SIMPLE(iAudioTrackInfo);
384 class iAudioTrackSelection: public iObject
387 iAudioTrackSelection();
388 ~iAudioTrackSelection();
391 virtual int getNumberOfTracks()=0;
392 virtual RESULT selectTrack(unsigned int i)=0;
393 virtual SWIG_VOID(RESULT) getTrackInfo(struct iAudioTrackInfo &SWIG_OUTPUT, unsigned int n)=0;
396 TEMPLATE_TYPEDEF(ePtr<iAudioTrackSelection>, iAudioTrackSelectionPtr);
398 class iAudioChannelSelection: public iObject
401 iAudioChannelSelection();
402 ~iAudioChannelSelection();
405 enum { LEFT, STEREO, RIGHT };
406 virtual int getCurrentChannel()=0;
407 virtual RESULT selectChannel(int i)=0;
410 TEMPLATE_TYPEDEF(ePtr<iAudioChannelSelection>, iAudioChannelSelectionPtr);
412 class iAudioDelay: public iObject
419 virtual int getAC3Delay()=0;
420 virtual int getPCMDelay()=0;
421 virtual void setAC3Delay(int)=0;
422 virtual void setPCMDelay(int)=0;
425 TEMPLATE_TYPEDEF(ePtr<iAudioDelay>, iAudioDelayPtr);
427 class iRadioText: public iObject
434 virtual std::string getRadioText(int x=0)=0;
437 TEMPLATE_TYPEDEF(ePtr<iRadioText>, iRadioTextPtr);
439 class iSubserviceList: public iObject
446 virtual int getNumberOfSubservices()=0;
447 virtual SWIG_VOID(RESULT) getSubservice(eServiceReference &SWIG_OUTPUT, unsigned int n)=0;
450 TEMPLATE_TYPEDEF(ePtr<iSubserviceList>, iSubserviceListPtr);
452 class iTimeshiftService: public iObject
456 ~iTimeshiftService();
459 virtual RESULT startTimeshift()=0;
460 virtual RESULT stopTimeshift()=0;
462 virtual int isTimeshiftActive()=0;
463 /* this essentially seeks to the relative end of the timeshift buffer */
464 virtual RESULT activateTimeshift()=0;
467 TEMPLATE_TYPEDEF(ePtr<iTimeshiftService>, iTimeshiftServicePtr);
469 /* not related to eCueSheet */
470 class iCueSheet: public iObject
477 /* returns a list of (pts, what)-tuples */
478 virtual PyObject *getCutList() = 0;
479 virtual void setCutList(SWIG_PYOBJECT(ePyObject) list) = 0;
480 virtual void setCutListEnable(int enable) = 0;
481 enum { cutIn = 0, cutOut = 1, cutMark = 2 };
484 TEMPLATE_TYPEDEF(ePtr<iCueSheet>, iCueSheetPtr);
489 class iSubtitleOutput: public iObject
492 virtual RESULT enableSubtitles(eWidget *parent, SWIG_PYOBJECT(ePyObject) entry)=0;
493 virtual RESULT disableSubtitles(eWidget *parent)=0;
494 virtual PyObject *getSubtitleList()=0;
495 virtual PyObject *getCachedSubtitle()=0;
498 TEMPLATE_TYPEDEF(ePtr<iSubtitleOutput>, iSubtitleOutputPtr);
500 class iPlayableService: public iObject
506 friend class iServiceHandler;
510 /* these first two events are magical, and should only
511 be generated if you know what you're doing. */
516 // when iServiceInformation is implemented:
520 /* when seek() is implemented: */
521 evSeekableStatusChanged, /* for example when timeshifting */
524 evSOF, /* bounced against start of file (when seeking backwards) */
526 /* only when cueSheet is implemented */
532 virtual RESULT connectEvent(const Slot2<void,iPlayableService*,int> &event, ePtr<eConnection> &connection)=0;
534 virtual RESULT start()=0;
535 virtual RESULT stop()=0;
536 /* might have to be changed... */
537 virtual RESULT setTarget(int target)=0;
538 virtual SWIG_VOID(RESULT) seek(ePtr<iSeekableService> &SWIG_OUTPUT)=0;
539 virtual SWIG_VOID(RESULT) pause(ePtr<iPauseableService> &SWIG_OUTPUT)=0;
540 virtual SWIG_VOID(RESULT) info(ePtr<iServiceInformation> &SWIG_OUTPUT)=0;
541 virtual SWIG_VOID(RESULT) audioTracks(ePtr<iAudioTrackSelection> &SWIG_OUTPUT)=0;
542 virtual SWIG_VOID(RESULT) audioChannel(ePtr<iAudioChannelSelection> &SWIG_OUTPUT)=0;
543 virtual SWIG_VOID(RESULT) subServices(ePtr<iSubserviceList> &SWIG_OUTPUT)=0;
544 virtual SWIG_VOID(RESULT) frontendInfo(ePtr<iFrontendInformation> &SWIG_OUTPUT)=0;
545 virtual SWIG_VOID(RESULT) timeshift(ePtr<iTimeshiftService> &SWIG_OUTPUT)=0;
546 virtual SWIG_VOID(RESULT) cueSheet(ePtr<iCueSheet> &SWIG_OUTPUT)=0;
547 virtual SWIG_VOID(RESULT) subtitle(ePtr<iSubtitleOutput> &SWIG_OUTPUT)=0;
548 virtual SWIG_VOID(RESULT) audioDelay(ePtr<iAudioDelay> &SWIG_OUTPUT)=0;
549 virtual SWIG_VOID(RESULT) radioText(ePtr<iRadioText> &SWIG_OUTPUT)=0;
552 TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
554 class iRecordableService: public iObject
557 iRecordableService();
558 ~iRecordableService();
576 errOpenRecordFile=-1,
577 errNoDemuxAvailable=-2,
578 errNoTsRecorderAvailable=-3,
583 virtual RESULT connectEvent(const Slot2<void,iRecordableService*,int> &event, ePtr<eConnection> &connection)=0;
585 virtual RESULT getError(int &)=0;
586 virtual RESULT prepare(const char *filename, time_t begTime=-1, time_t endTime=-1, int eit_event_id=-1)=0;
587 virtual RESULT start()=0;
588 virtual RESULT stop()=0;
589 virtual SWIG_VOID(RESULT) frontendInfo(ePtr<iFrontendInformation> &SWIG_OUTPUT)=0;
592 TEMPLATE_TYPEDEF(ePtr<iRecordableService>, iRecordableServicePtr);
594 extern PyObject *New_iRecordableServicePtr(const ePtr<iRecordableService> &ref); // defined in enigma_python.i
596 inline PyObject *PyFrom(ePtr<iRecordableService> &c)
598 return New_iRecordableServicePtr(c);
602 #ifdef PYTHON_REFCOUNT_DEBUG
603 inline ePyObject Impl_New_iRecordableServicePtr(const char* file, int line, const ePtr<iRecordableService> &ptr)
605 return ePyObject(New_iRecordableServicePtr(ptr), file, line);
607 #define NEW_iRecordableServicePtr(ptr) Impl_New_iRecordableServicePtr(__FILE__, __LINE__, ptr)
609 inline ePyObject Impl_New_iRecordableServicePtr(const ePtr<iRecordableService> &ptr)
611 return New_iRecordableServicePtr(ptr);
613 #define NEW_iRecordableServicePtr(ptr) Impl_New_iRecordableServicePtr(ptr)
617 // TEMPLATE_TYPEDEF(std::list<eServiceReference>, eServiceReferenceList);
619 class iMutableServiceList: public iObject
622 iMutableServiceList();
623 ~iMutableServiceList();
627 virtual RESULT flushChanges()=0;
628 /* adds a service to a list */
629 virtual RESULT addService(eServiceReference &ref, eServiceReference before=eServiceReference())=0;
630 /* removes a service from a list */
631 virtual RESULT removeService(eServiceReference &ref)=0;
632 /* moves a service in a list, only if list suppports a specific sort method. */
633 /* pos is the new, absolute position from 0..size-1 */
634 virtual RESULT moveService(eServiceReference &ref, int pos)=0;
635 /* set name of list, for bouquets this is the visible bouquet name */
636 virtual RESULT setListName(const std::string &name)=0;
639 TEMPLATE_TYPEDEF(ePtr<iMutableServiceList>, iMutableServiceListPtr);
641 class iListableService: public iObject
648 /* legacy interface: get a list */
649 virtual RESULT getContent(std::list<eServiceReference> &list, bool sorted=false)=0;
650 virtual PyObject *getContent(const char* format, bool sorted=false)=0;
652 /* new, shiny interface: streaming. */
653 virtual SWIG_VOID(RESULT) getNext(eServiceReference &SWIG_OUTPUT)=0;
655 /* use this for sorting. output is not sorted because of either
656 - performance reasons: the whole list must be buffered or
657 - the interface would be restricted to a list. streaming
658 (as well as a future "active" extension) won't be possible.
660 virtual int compareLessEqual(const eServiceReference &, const eServiceReference &)=0;
662 virtual SWIG_VOID(RESULT) startEdit(ePtr<iMutableServiceList> &SWIG_OUTPUT)=0;
665 TEMPLATE_TYPEDEF(ePtr<iListableService>, iListableServicePtr);
668 /* a helper class which can be used as argument to stl's sort(). */
669 class iListableServiceCompare
671 ePtr<iListableService> m_list;
673 iListableServiceCompare(iListableService *list): m_list(list) { }
674 bool operator()(const eServiceReference &a, const eServiceReference &b)
676 return m_list->compareLessEqual(a, b);
681 class iServiceOfflineOperations: public iObject
684 iServiceOfflineOperations();
685 ~iServiceOfflineOperations();
688 /* to delete a service, forever. */
689 virtual RESULT deleteFromDisk(int simulate=1)=0;
691 /* for transferring a service... */
692 virtual SWIG_VOID(RESULT) getListOfFilenames(std::list<std::string> &SWIG_OUTPUT)=0;
694 // TODO: additional stuff, like a conversion interface?
697 TEMPLATE_TYPEDEF(ePtr<iServiceOfflineOperations>, iServiceOfflineOperationsPtr);
699 class iServiceHandler: public iObject
706 virtual SWIG_VOID(RESULT) play(const eServiceReference &, ePtr<iPlayableService> &SWIG_OUTPUT)=0;
707 virtual SWIG_VOID(RESULT) record(const eServiceReference &, ePtr<iRecordableService> &SWIG_OUTPUT)=0;
708 virtual SWIG_VOID(RESULT) list(const eServiceReference &, ePtr<iListableService> &SWIG_OUTPUT)=0;
709 virtual SWIG_VOID(RESULT) info(const eServiceReference &, ePtr<iStaticServiceInformation> &SWIG_OUTPUT)=0;
710 virtual SWIG_VOID(RESULT) offlineOperations(const eServiceReference &, ePtr<iServiceOfflineOperations> &SWIG_OUTPUT)=0;
713 TEMPLATE_TYPEDEF(ePtr<iServiceHandler>, iServiceHandlerPtr);