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
42 isMarker=64, // Marker
43 isGroup=128 // is a group of services
45 int flags; // flags will NOT be compared.
47 inline int getSortKey() const { return (flags & hasSortKey) ? data[3] : ((flags & sort1) ? 1 : 0); }
53 std::string getPath() { return path; }
54 void setPath( const std::string &n ) { path=n; }
56 unsigned int getUnsignedData(unsigned int num) const
58 if ( num < sizeof(data)/sizeof(int) )
63 int getData(unsigned int num) const
65 if ( num < sizeof(data)/sizeof(int) )
70 void setUnsignedData(unsigned int num, unsigned int val)
72 if ( num < sizeof(data)/sizeof(int) )
76 void setData(unsigned int num, int val)
78 if ( num < sizeof(data)/sizeof(int) )
82 // only for override service names in bouquets or to give servicerefs a name which not have a
83 // real existing service ( for dvb eServiceDVB )
87 std::string getName() { return name; }
88 void setName( const std::string &n ) { name=n; }
91 : type(idInvalid), flags(0)
93 memset(data, 0, sizeof(data));
96 eServiceReference(int type, int flags)
97 : type(type), flags(flags)
99 memset(data, 0, sizeof(data));
101 eServiceReference(int type, int flags, int data0)
102 : type(type), flags(flags)
104 memset(data, 0, sizeof(data));
107 eServiceReference(int type, int flags, int data0, int data1)
108 : type(type), flags(flags)
110 memset(data, 0, sizeof(data));
114 eServiceReference(int type, int flags, int data0, int data1, int data2)
115 : type(type), flags(flags)
117 memset(data, 0, sizeof(data));
122 eServiceReference(int type, int flags, int data0, int data1, int data2, int data3)
123 : type(type), flags(flags)
125 memset(data, 0, sizeof(data));
131 eServiceReference(int type, int flags, int data0, int data1, int data2, int data3, int data4)
132 : type(type), flags(flags)
134 memset(data, 0, sizeof(data));
142 eServiceReference(int type, int flags, const std::string &path)
143 : type(type), flags(flags), path(path)
145 memset(data, 0, sizeof(data));
147 eServiceReference(const std::string &string);
148 std::string toString() const;
149 std::string toCompareString() const;
150 bool operator==(const eServiceReference &c) const
154 return (memcmp(data, c.data, sizeof(int)*8)==0) && (path == c.path);
156 bool operator!=(const eServiceReference &c) const
158 return !(*this == c);
160 bool operator<(const eServiceReference &c) const
168 int r=memcmp(data, c.data, sizeof(int)*8);
171 return path < c.path;
173 operator bool() const
180 return type != idInvalid;
184 SWIG_ALLOW_OUTPUT_SIMPLE(eServiceReference);
186 extern PyObject *New_eServiceReference(const eServiceReference &ref); // defined in enigma_python.i
189 #ifdef PYTHON_REFCOUNT_DEBUG
190 inline ePyObject Impl_New_eServiceReference(const char* file, int line, const eServiceReference &ref)
192 return ePyObject(New_eServiceReference(ref), file, line);
194 #define NEW_eServiceReference(ref) Impl_New_eServiceReference(__FILE__, __LINE__, ref)
196 inline ePyObject Impl_New_eServiceReference(const eServiceReference &ref)
198 return New_eServiceReference(ref);
200 #define NEW_eServiceReference(ref) Impl_New_eServiceReference(ref)
204 typedef long long pts_t;
206 /* the reason we have the servicereference as additional argument is
207 that we don't have to create one object for every entry in a possibly
208 large list, provided that no state information is nessesary to deliver
209 the required information. Anyway - ref *must* be the same as the argument
210 to the info() or getIServiceInformation call! */
212 /* About the usage of SWIG_VOID:
213 SWIG_VOID(real_returntype_t) hides a return value from swig. This is used for
214 the "superflouus" RESULT return values.
216 Python code has to check the returned pointer against 0. This works,
217 as all functions returning instances in smartpointers AND having a
218 RESULT have to BOTH return non-zero AND set the pointer to zero.
220 Python code thus can't check for the reason, but the reason isn't
221 user-servicable anyway. If you want to return a real reason which
222 goes beyong "it just doesn't work", use extra variables for this,
225 Hide the result only if there is another way to check for failure! */
227 SWIG_TEMPLATE_TYPEDEF(ePtr<eServiceEvent>, eServiceEventPtr);
229 SWIG_IGNORE(iStaticServiceInformation);
230 class iStaticServiceInformation: public iObject
233 iStaticServiceInformation();
234 ~iStaticServiceInformation();
237 virtual SWIG_VOID(RESULT) getName(const eServiceReference &ref, std::string &SWIG_OUTPUT)=0;
239 // doesn't need to be implemented, should return -1 then.
240 virtual int getLength(const eServiceReference &ref);
241 virtual SWIG_VOID(RESULT) getEvent(const eServiceReference &ref, ePtr<eServiceEvent> &SWIG_OUTPUT, time_t start_time=-1);
242 // returns true when not implemented
243 virtual int isPlayable(const eServiceReference &ref, const eServiceReference &ignore);
245 virtual int getInfo(const eServiceReference &ref, int w);
246 virtual std::string getInfoString(const eServiceReference &ref,int w);
247 virtual PyObject *getInfoObject(const eServiceReference &ref, int w);
249 virtual int setInfo(const eServiceReference &ref, int w, int v);
250 virtual int setInfoString(const eServiceReference &ref, int w, const char *v);
252 SWIG_TEMPLATE_TYPEDEF(ePtr<iStaticServiceInformation>, iStaticServiceInformationPtr);
254 class iServiceInformation_ENUMS
257 iServiceInformation_ENUMS();
258 ~iServiceInformation_ENUMS();
262 sIsCrypted, /* is encrypted (no indication if decrypt was possible) */
263 sAspect, /* aspect ratio: 0=4:3, 1=16:9, 2=whatever we need */
264 sIsMultichannel, /* multichannel *available* (probably not selected) */
266 /* "user serviceable info" - they are not reliable. Don't use them for anything except the service menu!
267 that's also the reason why they are so globally defined.
268 again - if somebody EVER tries to use this information for anything else than simply displaying it,
269 i will change this to return a user-readable text like "zero x zero three three" (and change the
270 exact spelling in every version) to stop that! */
286 sTimeCreate, /* unix time or string */
295 sVideoType, /* MPEG2 MPEG4 */
297 sTags, /* space seperated list of tags */
299 sDVBState, /* states as defined in pmt handler (as events there) */
304 sTransponderData /* transponderdata as python dict */
313 /* some words to structs like struct iServiceInformation_ENUMS
314 For some classes we need in python just the SmartPointer Variants.
315 So we prevent building wrapper classes for the non smart pointer classes with the SWIG_IGNORE makro.
316 But now we have the problem that swig do not export enums for smart pointer classes (i dont know why).
317 So we move all enum's to own classes (with _ENUMS as name ending) and let our real
318 class inherit from the *_ENUMS class. This *_ENUMS classes are normally exportet via swig to python.
319 But in the python code we doesn't like to write iServiceInformation_ENUMS.sVideoType....
320 we like to write iServiceInformation.sVideoType.
321 So until swig have no Solution for this Problem we call in lib/python/Makefile.am a python script named
322 enigma_py_patcher.py to remove the "_ENUMS" strings in enigma.py at all needed locations. */
324 SWIG_IGNORE(iServiceInformation);
325 class iServiceInformation: public iServiceInformation_ENUMS, public iObject
328 iServiceInformation();
329 ~iServiceInformation();
332 virtual SWIG_VOID(RESULT) getName(std::string &SWIG_OUTPUT)=0;
333 virtual SWIG_VOID(RESULT) getEvent(ePtr<eServiceEvent> &SWIG_OUTPUT, int nownext);
335 virtual int getInfo(int w);
336 virtual std::string getInfoString(int w);
337 virtual PyObject *getInfoObject(int w);
339 virtual int setInfo(int w, int v);
340 virtual int setInfoString(int w, const char *v);
342 SWIG_TEMPLATE_TYPEDEF(ePtr<iServiceInformation>, iServiceInformationPtr);
344 class iFrontendInformation_ENUMS
347 iFrontendInformation_ENUMS();
348 ~iFrontendInformation_ENUMS();
361 SWIG_IGNORE(iFrontendInformation);
362 class iFrontendInformation: public iFrontendInformation_ENUMS, public iObject
365 iFrontendInformation();
366 ~iFrontendInformation();
369 virtual int getFrontendInfo(int w)=0;
370 virtual PyObject *getFrontendData(bool original=false)=0;
372 SWIG_TEMPLATE_TYPEDEF(ePtr<iFrontendInformation>, iFrontendInformationPtr);
374 SWIG_IGNORE(iPauseableService);
375 class iPauseableService: public iObject
382 virtual RESULT pause()=0;
383 virtual RESULT unpause()=0;
386 virtual RESULT setSlowMotion(int ratio=0)=0;
387 virtual RESULT setFastForward(int ratio=0)=0;
389 SWIG_TEMPLATE_TYPEDEF(ePtr<iPauseableService>, iPauseableServicePtr);
391 class iSeekableService_ENUMS
394 iSeekableService_ENUMS();
395 ~iSeekableService_ENUMS();
398 enum { dirForward = +1, dirBackward = -1 };
401 SWIG_IGNORE(iSeekableService);
402 class iSeekableService: public iSeekableService_ENUMS, public iObject
409 virtual RESULT getLength(pts_t &SWIG_OUTPUT)=0;
410 virtual RESULT seekTo(pts_t to)=0;
411 virtual RESULT seekRelative(int direction, pts_t to)=0;
412 virtual RESULT getPlayPosition(pts_t &SWIG_OUTPUT)=0;
413 /* if you want to do several seeks in a row, you can enable the trickmode.
414 audio will be switched off, sync will be disabled etc. */
415 virtual RESULT setTrickmode(int trick=0)=0;
416 virtual RESULT isCurrentlySeekable()=0;
418 SWIG_TEMPLATE_TYPEDEF(ePtr<iSeekableService>, iSeekableServicePtr);
420 struct iAudioTrackInfo
423 std::string m_description;
424 std::string m_language; /* iso639 */
426 std::string getDescription() { return m_description; }
427 std::string getLanguage() { return m_language; }
429 SWIG_ALLOW_OUTPUT_SIMPLE(iAudioTrackInfo);
431 SWIG_IGNORE(iAudioTrackSelection);
432 class iAudioTrackSelection: public iObject
435 iAudioTrackSelection();
436 ~iAudioTrackSelection();
439 virtual int getNumberOfTracks()=0;
440 virtual RESULT selectTrack(unsigned int i)=0;
441 virtual SWIG_VOID(RESULT) getTrackInfo(struct iAudioTrackInfo &SWIG_OUTPUT, unsigned int n)=0;
443 SWIG_TEMPLATE_TYPEDEF(ePtr<iAudioTrackSelection>, iAudioTrackSelectionPtr);
445 class iAudioChannelSelection_ENUMS
448 iAudioChannelSelection_ENUMS();
449 ~iAudioChannelSelection_ENUMS();
452 enum { LEFT, STEREO, RIGHT };
455 SWIG_IGNORE(iAudioChannelSelection);
456 class iAudioChannelSelection: public iAudioChannelSelection_ENUMS, public iObject
459 iAudioChannelSelection();
460 ~iAudioChannelSelection();
463 virtual int getCurrentChannel()=0;
464 virtual RESULT selectChannel(int i)=0;
466 SWIG_TEMPLATE_TYPEDEF(ePtr<iAudioChannelSelection>, iAudioChannelSelectionPtr);
468 SWIG_IGNORE(iAudioDelay);
469 class iAudioDelay: public iObject
476 virtual int getAC3Delay()=0;
477 virtual int getPCMDelay()=0;
478 virtual void setAC3Delay(int)=0;
479 virtual void setPCMDelay(int)=0;
481 SWIG_TEMPLATE_TYPEDEF(ePtr<iAudioDelay>, iAudioDelayPtr);
483 SWIG_IGNORE(iRadioText);
484 class iRadioText: public iObject
491 virtual std::string getRadioText(int x=0)=0;
493 SWIG_TEMPLATE_TYPEDEF(ePtr<iRadioText>, iRadioTextPtr);
495 SWIG_IGNORE(iSubserviceList);
496 class iSubserviceList: public iObject
503 virtual int getNumberOfSubservices()=0;
504 virtual SWIG_VOID(RESULT) getSubservice(eServiceReference &SWIG_OUTPUT, unsigned int n)=0;
506 SWIG_TEMPLATE_TYPEDEF(ePtr<iSubserviceList>, iSubserviceListPtr);
508 SWIG_IGNORE(iTimeshiftService);
509 class iTimeshiftService: public iObject
513 ~iTimeshiftService();
516 virtual RESULT startTimeshift()=0;
517 virtual RESULT stopTimeshift()=0;
519 virtual int isTimeshiftActive()=0;
520 /* this essentially seeks to the relative end of the timeshift buffer */
521 virtual RESULT activateTimeshift()=0;
523 SWIG_TEMPLATE_TYPEDEF(ePtr<iTimeshiftService>, iTimeshiftServicePtr);
525 /* not related to eCueSheet */
527 class iCueSheet_ENUMS
534 enum { cutIn = 0, cutOut = 1, cutMark = 2 };
537 SWIG_IGNORE(iCueSheet);
538 class iCueSheet: public iCueSheet_ENUMS, public iObject
545 /* returns a list of (pts, what)-tuples */
546 virtual PyObject *getCutList() = 0;
547 virtual void setCutList(SWIG_PYOBJECT(ePyObject) list) = 0;
548 virtual void setCutListEnable(int enable) = 0;
550 SWIG_TEMPLATE_TYPEDEF(ePtr<iCueSheet>, iCueSheetPtr);
555 SWIG_IGNORE(iSubtitleOutput);
556 class iSubtitleOutput: public iObject
559 virtual RESULT enableSubtitles(eWidget *parent, SWIG_PYOBJECT(ePyObject) entry)=0;
560 virtual RESULT disableSubtitles(eWidget *parent)=0;
561 virtual PyObject *getSubtitleList()=0;
562 virtual PyObject *getCachedSubtitle()=0;
564 SWIG_TEMPLATE_TYPEDEF(ePtr<iSubtitleOutput>, iSubtitleOutputPtr);
566 SWIG_IGNORE(iMutableServiceList);
567 class iMutableServiceList: public iObject
570 iMutableServiceList();
571 ~iMutableServiceList();
575 virtual RESULT flushChanges()=0;
576 /* adds a service to a list */
577 virtual RESULT addService(eServiceReference &ref, eServiceReference before=eServiceReference())=0;
578 /* removes a service from a list */
579 virtual RESULT removeService(eServiceReference &ref)=0;
580 /* moves a service in a list, only if list suppports a specific sort method. */
581 /* pos is the new, absolute position from 0..size-1 */
582 virtual RESULT moveService(eServiceReference &ref, int pos)=0;
583 /* set name of list, for bouquets this is the visible bouquet name */
584 virtual RESULT setListName(const std::string &name)=0;
586 SWIG_TEMPLATE_TYPEDEF(ePtr<iMutableServiceList>, iMutableServiceListPtr);
588 SWIG_IGNORE(iListableService);
589 class iListableService: public iObject
597 /* legacy interface: get a list */
598 virtual RESULT getContent(std::list<eServiceReference> &list, bool sorted=false)=0;
600 virtual PyObject *getContent(const char* format, bool sorted=false)=0;
602 /* new, shiny interface: streaming. */
603 virtual SWIG_VOID(RESULT) getNext(eServiceReference &SWIG_OUTPUT)=0;
605 /* use this for sorting. output is not sorted because of either
606 - performance reasons: the whole list must be buffered or
607 - the interface would be restricted to a list. streaming
608 (as well as a future "active" extension) won't be possible.
610 virtual int compareLessEqual(const eServiceReference &, const eServiceReference &)=0;
612 virtual SWIG_VOID(RESULT) startEdit(ePtr<iMutableServiceList> &SWIG_OUTPUT)=0;
614 SWIG_TEMPLATE_TYPEDEF(ePtr<iListableService>, iListableServicePtr);
617 /* a helper class which can be used as argument to stl's sort(). */
618 class iListableServiceCompare
620 ePtr<iListableService> m_list;
622 iListableServiceCompare(iListableService *list): m_list(list) { }
623 bool operator()(const eServiceReference &a, const eServiceReference &b)
625 return m_list->compareLessEqual(a, b);
630 SWIG_IGNORE(iServiceOfflineOperations);
631 class iServiceOfflineOperations: public iObject
634 iServiceOfflineOperations();
635 ~iServiceOfflineOperations();
638 /* to delete a service, forever. */
639 virtual RESULT deleteFromDisk(int simulate=1)=0;
641 /* for transferring a service... */
642 virtual SWIG_VOID(RESULT) getListOfFilenames(std::list<std::string> &SWIG_OUTPUT)=0;
644 // TODO: additional stuff, like a conversion interface?
646 SWIG_TEMPLATE_TYPEDEF(ePtr<iServiceOfflineOperations>, iServiceOfflineOperationsPtr);
648 class iPlayableService_ENUMS
651 iPlayableService_ENUMS();
652 ~iPlayableService_ENUMS();
656 /* these first two events are magical, and should only
657 be generated if you know what you're doing. */
663 /* when iServiceInformation is implemented:*/
667 /* when seek() is implemented: */
668 evSeekableStatusChanged, /* for example when timeshifting */
671 evSOF, /* bounced against start of file (when seeking backwards) */
673 /* when cueSheet is implemented */
676 /* when radioText is implemented */
683 SWIG_IGNORE(iPlayableService);
684 class iPlayableService: public iPlayableService_ENUMS, public iObject
690 friend class iServiceHandler;
693 virtual RESULT connectEvent(const Slot2<void,iPlayableService*,int> &event, ePtr<eConnection> &connection)=0;
695 virtual RESULT start()=0;
696 virtual RESULT stop()=0;
697 /* might have to be changed... */
698 virtual RESULT setTarget(int target)=0;
699 virtual SWIG_VOID(RESULT) seek(ePtr<iSeekableService> &SWIG_OUTPUT)=0;
700 virtual SWIG_VOID(RESULT) pause(ePtr<iPauseableService> &SWIG_OUTPUT)=0;
701 virtual SWIG_VOID(RESULT) info(ePtr<iServiceInformation> &SWIG_OUTPUT)=0;
702 virtual SWIG_VOID(RESULT) audioTracks(ePtr<iAudioTrackSelection> &SWIG_OUTPUT)=0;
703 virtual SWIG_VOID(RESULT) audioChannel(ePtr<iAudioChannelSelection> &SWIG_OUTPUT)=0;
704 virtual SWIG_VOID(RESULT) subServices(ePtr<iSubserviceList> &SWIG_OUTPUT)=0;
705 virtual SWIG_VOID(RESULT) frontendInfo(ePtr<iFrontendInformation> &SWIG_OUTPUT)=0;
706 virtual SWIG_VOID(RESULT) timeshift(ePtr<iTimeshiftService> &SWIG_OUTPUT)=0;
707 virtual SWIG_VOID(RESULT) cueSheet(ePtr<iCueSheet> &SWIG_OUTPUT)=0;
708 virtual SWIG_VOID(RESULT) subtitle(ePtr<iSubtitleOutput> &SWIG_OUTPUT)=0;
709 virtual SWIG_VOID(RESULT) audioDelay(ePtr<iAudioDelay> &SWIG_OUTPUT)=0;
710 virtual SWIG_VOID(RESULT) radioText(ePtr<iRadioText> &SWIG_OUTPUT)=0;
712 SWIG_TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
714 class iRecordableService_ENUMS
717 iRecordableService_ENUMS();
718 ~iRecordableService_ENUMS();
734 errOpenRecordFile=-1,
735 errNoDemuxAvailable=-2,
736 errNoTsRecorderAvailable=-3,
742 SWIG_IGNORE(iRecordableService);
743 class iRecordableService: public iRecordableService_ENUMS, public iObject
746 iRecordableService();
747 ~iRecordableService();
751 virtual RESULT connectEvent(const Slot2<void,iRecordableService*,int> &event, ePtr<eConnection> &connection)=0;
753 virtual RESULT getError(int &)=0;
754 virtual RESULT prepare(const char *filename, time_t begTime=-1, time_t endTime=-1, int eit_event_id=-1)=0;
755 virtual RESULT start()=0;
756 virtual RESULT stop()=0;
757 virtual SWIG_VOID(RESULT) frontendInfo(ePtr<iFrontendInformation> &SWIG_OUTPUT)=0;
759 SWIG_TEMPLATE_TYPEDEF(ePtr<iRecordableService>, iRecordableServicePtr);
761 extern PyObject *New_iRecordableServicePtr(const ePtr<iRecordableService> &ref); // defined in enigma_python.i
763 inline PyObject *PyFrom(ePtr<iRecordableService> &c)
765 return New_iRecordableServicePtr(c);
769 #ifdef PYTHON_REFCOUNT_DEBUG
770 inline ePyObject Impl_New_iRecordableServicePtr(const char* file, int line, const ePtr<iRecordableService> &ptr)
772 return ePyObject(New_iRecordableServicePtr(ptr), file, line);
774 #define NEW_iRecordableServicePtr(ptr) Impl_New_iRecordableServicePtr(__FILE__, __LINE__, ptr)
776 inline ePyObject Impl_New_iRecordableServicePtr(const ePtr<iRecordableService> &ptr)
778 return New_iRecordableServicePtr(ptr);
780 #define NEW_iRecordableServicePtr(ptr) Impl_New_iRecordableServicePtr(ptr)
784 SWIG_IGNORE(iServiceHandler);
785 class iServiceHandler: public iObject
792 virtual SWIG_VOID(RESULT) play(const eServiceReference &, ePtr<iPlayableService> &SWIG_OUTPUT)=0;
793 virtual SWIG_VOID(RESULT) record(const eServiceReference &, ePtr<iRecordableService> &SWIG_OUTPUT)=0;
794 virtual SWIG_VOID(RESULT) list(const eServiceReference &, ePtr<iListableService> &SWIG_OUTPUT)=0;
795 virtual SWIG_VOID(RESULT) info(const eServiceReference &, ePtr<iStaticServiceInformation> &SWIG_OUTPUT)=0;
796 virtual SWIG_VOID(RESULT) offlineOperations(const eServiceReference &, ePtr<iServiceOfflineOperations> &SWIG_OUTPUT)=0;
798 SWIG_TEMPLATE_TYPEDEF(ePtr<iServiceHandler>, iServiceHandlerPtr);