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 TEMPLATE_TYPEDEF(ePtr<eServiceEvent>, eServiceEventPtr);
229 class iStaticServiceInformation: public iObject
232 iStaticServiceInformation();
233 ~iStaticServiceInformation();
236 virtual SWIG_VOID(RESULT) getName(const eServiceReference &ref, std::string &SWIG_OUTPUT)=0;
238 // doesn't need to be implemented, should return -1 then.
239 virtual int getLength(const eServiceReference &ref);
240 virtual SWIG_VOID(RESULT) getEvent(const eServiceReference &ref, ePtr<eServiceEvent> &SWIG_OUTPUT, time_t start_time=-1);
241 // returns true when not implemented
242 virtual int isPlayable(const eServiceReference &ref, const eServiceReference &ignore);
244 virtual int getInfo(const eServiceReference &ref, int w);
245 virtual std::string getInfoString(const eServiceReference &ref,int w);
246 virtual PyObject *getInfoObject(const eServiceReference &ref, int w);
248 virtual int setInfo(const eServiceReference &ref, int w, int v);
249 virtual int setInfoString(const eServiceReference &ref, int w, const char *v);
252 TEMPLATE_TYPEDEF(ePtr<iStaticServiceInformation>, iStaticServiceInformationPtr);
254 class iServiceInformation: public iObject
257 iServiceInformation();
258 ~iServiceInformation();
261 virtual SWIG_VOID(RESULT) getName(std::string &SWIG_OUTPUT)=0;
262 virtual SWIG_VOID(RESULT) getEvent(ePtr<eServiceEvent> &SWIG_OUTPUT, int nownext);
265 sIsCrypted, /* is encrypted (no indication if decrypt was possible) */
266 sAspect, /* aspect ratio: 0=4:3, 1=16:9, 2=whatever we need */
267 sIsMultichannel, /* multichannel *available* (probably not selected) */
269 /* "user serviceable info" - they are not reliable. Don't use them for anything except the service menu!
270 that's also the reason why they are so globally defined.
273 again - if somebody EVER tries to use this information for anything else than simply displaying it,
274 i will change this to return a user-readable text like "zero x zero three three" (and change the
275 exact spelling in every version) to stop that!
291 sTimeCreate, // unix time or string
300 sVideoType, // MPEG2 MPEG4
302 sTags, /* space seperated list of tags */
304 sDVBState, /* states as defined in pmt handler (as events there) */
309 sTransponderData /* transponderdata as python dict */
311 enum { resNA = -1, resIsString = -2, resIsPyObject = -3 };
313 virtual int getInfo(int w);
314 virtual std::string getInfoString(int w);
315 virtual PyObject *getInfoObject(int w);
317 virtual int setInfo(int w, int v);
318 virtual int setInfoString(int w, const char *v);
321 TEMPLATE_TYPEDEF(ePtr<iServiceInformation>, iServiceInformationPtr);
323 class iFrontendInformation: public iObject
326 iFrontendInformation();
327 ~iFrontendInformation();
338 virtual int getFrontendInfo(int w)=0;
339 virtual PyObject *getFrontendData(bool original=false)=0;
342 TEMPLATE_TYPEDEF(ePtr<iFrontendInformation>, iFrontendInformationPtr);
344 class iPauseableService: public iObject
351 virtual RESULT pause()=0;
352 virtual RESULT unpause()=0;
355 virtual RESULT setSlowMotion(int ratio=0)=0;
356 virtual RESULT setFastForward(int ratio=0)=0;
359 TEMPLATE_TYPEDEF(ePtr<iPauseableService>, iPauseableServicePtr);
361 class iSeekableService: public iObject
368 virtual RESULT getLength(pts_t &SWIG_OUTPUT)=0;
369 virtual RESULT seekTo(pts_t to)=0;
370 enum { dirForward = +1, dirBackward = -1 };
371 virtual RESULT seekRelative(int direction, pts_t to)=0;
372 virtual RESULT getPlayPosition(pts_t &SWIG_OUTPUT)=0;
373 /* if you want to do several seeks in a row, you can enable the trickmode.
374 audio will be switched off, sync will be disabled etc. */
375 virtual RESULT setTrickmode(int trick=0)=0;
376 virtual RESULT isCurrentlySeekable()=0;
379 TEMPLATE_TYPEDEF(ePtr<iSeekableService>, iSeekableServicePtr);
381 struct iAudioTrackInfo
384 std::string m_description;
385 std::string m_language; /* iso639 */
387 std::string getDescription() { return m_description; }
388 std::string getLanguage() { return m_language; }
391 SWIG_ALLOW_OUTPUT_SIMPLE(iAudioTrackInfo);
393 class iAudioTrackSelection: public iObject
396 iAudioTrackSelection();
397 ~iAudioTrackSelection();
400 virtual int getNumberOfTracks()=0;
401 virtual RESULT selectTrack(unsigned int i)=0;
402 virtual SWIG_VOID(RESULT) getTrackInfo(struct iAudioTrackInfo &SWIG_OUTPUT, unsigned int n)=0;
405 TEMPLATE_TYPEDEF(ePtr<iAudioTrackSelection>, iAudioTrackSelectionPtr);
407 class iAudioChannelSelection: public iObject
410 iAudioChannelSelection();
411 ~iAudioChannelSelection();
414 enum { LEFT, STEREO, RIGHT };
415 virtual int getCurrentChannel()=0;
416 virtual RESULT selectChannel(int i)=0;
419 TEMPLATE_TYPEDEF(ePtr<iAudioChannelSelection>, iAudioChannelSelectionPtr);
421 class iAudioDelay: public iObject
428 virtual int getAC3Delay()=0;
429 virtual int getPCMDelay()=0;
430 virtual void setAC3Delay(int)=0;
431 virtual void setPCMDelay(int)=0;
434 TEMPLATE_TYPEDEF(ePtr<iAudioDelay>, iAudioDelayPtr);
436 class iRadioText: public iObject
443 virtual std::string getRadioText(int x=0)=0;
446 TEMPLATE_TYPEDEF(ePtr<iRadioText>, iRadioTextPtr);
448 class iSubserviceList: public iObject
455 virtual int getNumberOfSubservices()=0;
456 virtual SWIG_VOID(RESULT) getSubservice(eServiceReference &SWIG_OUTPUT, unsigned int n)=0;
459 TEMPLATE_TYPEDEF(ePtr<iSubserviceList>, iSubserviceListPtr);
461 class iTimeshiftService: public iObject
465 ~iTimeshiftService();
468 virtual RESULT startTimeshift()=0;
469 virtual RESULT stopTimeshift()=0;
471 virtual int isTimeshiftActive()=0;
472 /* this essentially seeks to the relative end of the timeshift buffer */
473 virtual RESULT activateTimeshift()=0;
476 TEMPLATE_TYPEDEF(ePtr<iTimeshiftService>, iTimeshiftServicePtr);
478 /* not related to eCueSheet */
479 class iCueSheet: public iObject
486 /* returns a list of (pts, what)-tuples */
487 virtual PyObject *getCutList() = 0;
488 virtual void setCutList(SWIG_PYOBJECT(ePyObject) list) = 0;
489 virtual void setCutListEnable(int enable) = 0;
490 enum { cutIn = 0, cutOut = 1, cutMark = 2 };
493 TEMPLATE_TYPEDEF(ePtr<iCueSheet>, iCueSheetPtr);
498 class iSubtitleOutput: public iObject
501 virtual RESULT enableSubtitles(eWidget *parent, SWIG_PYOBJECT(ePyObject) entry)=0;
502 virtual RESULT disableSubtitles(eWidget *parent)=0;
503 virtual PyObject *getSubtitleList()=0;
504 virtual PyObject *getCachedSubtitle()=0;
507 TEMPLATE_TYPEDEF(ePtr<iSubtitleOutput>, iSubtitleOutputPtr);
509 class iPlayableService: public iObject
515 friend class iServiceHandler;
519 /* these first two events are magical, and should only
520 be generated if you know what you're doing. */
525 // when iServiceInformation is implemented:
529 /* when seek() is implemented: */
530 evSeekableStatusChanged, /* for example when timeshifting */
533 evSOF, /* bounced against start of file (when seeking backwards) */
535 /* only when cueSheet is implemented */
543 virtual RESULT connectEvent(const Slot2<void,iPlayableService*,int> &event, ePtr<eConnection> &connection)=0;
545 virtual RESULT start()=0;
546 virtual RESULT stop()=0;
547 /* might have to be changed... */
548 virtual RESULT setTarget(int target)=0;
549 virtual SWIG_VOID(RESULT) seek(ePtr<iSeekableService> &SWIG_OUTPUT)=0;
550 virtual SWIG_VOID(RESULT) pause(ePtr<iPauseableService> &SWIG_OUTPUT)=0;
551 virtual SWIG_VOID(RESULT) info(ePtr<iServiceInformation> &SWIG_OUTPUT)=0;
552 virtual SWIG_VOID(RESULT) audioTracks(ePtr<iAudioTrackSelection> &SWIG_OUTPUT)=0;
553 virtual SWIG_VOID(RESULT) audioChannel(ePtr<iAudioChannelSelection> &SWIG_OUTPUT)=0;
554 virtual SWIG_VOID(RESULT) subServices(ePtr<iSubserviceList> &SWIG_OUTPUT)=0;
555 virtual SWIG_VOID(RESULT) frontendInfo(ePtr<iFrontendInformation> &SWIG_OUTPUT)=0;
556 virtual SWIG_VOID(RESULT) timeshift(ePtr<iTimeshiftService> &SWIG_OUTPUT)=0;
557 virtual SWIG_VOID(RESULT) cueSheet(ePtr<iCueSheet> &SWIG_OUTPUT)=0;
558 virtual SWIG_VOID(RESULT) subtitle(ePtr<iSubtitleOutput> &SWIG_OUTPUT)=0;
559 virtual SWIG_VOID(RESULT) audioDelay(ePtr<iAudioDelay> &SWIG_OUTPUT)=0;
560 virtual SWIG_VOID(RESULT) radioText(ePtr<iRadioText> &SWIG_OUTPUT)=0;
563 TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
565 class iRecordableService: public iObject
568 iRecordableService();
569 ~iRecordableService();
587 errOpenRecordFile=-1,
588 errNoDemuxAvailable=-2,
589 errNoTsRecorderAvailable=-3,
594 virtual RESULT connectEvent(const Slot2<void,iRecordableService*,int> &event, ePtr<eConnection> &connection)=0;
596 virtual RESULT getError(int &)=0;
597 virtual RESULT prepare(const char *filename, time_t begTime=-1, time_t endTime=-1, int eit_event_id=-1)=0;
598 virtual RESULT start()=0;
599 virtual RESULT stop()=0;
600 virtual SWIG_VOID(RESULT) frontendInfo(ePtr<iFrontendInformation> &SWIG_OUTPUT)=0;
603 TEMPLATE_TYPEDEF(ePtr<iRecordableService>, iRecordableServicePtr);
605 extern PyObject *New_iRecordableServicePtr(const ePtr<iRecordableService> &ref); // defined in enigma_python.i
607 inline PyObject *PyFrom(ePtr<iRecordableService> &c)
609 return New_iRecordableServicePtr(c);
613 #ifdef PYTHON_REFCOUNT_DEBUG
614 inline ePyObject Impl_New_iRecordableServicePtr(const char* file, int line, const ePtr<iRecordableService> &ptr)
616 return ePyObject(New_iRecordableServicePtr(ptr), file, line);
618 #define NEW_iRecordableServicePtr(ptr) Impl_New_iRecordableServicePtr(__FILE__, __LINE__, ptr)
620 inline ePyObject Impl_New_iRecordableServicePtr(const ePtr<iRecordableService> &ptr)
622 return New_iRecordableServicePtr(ptr);
624 #define NEW_iRecordableServicePtr(ptr) Impl_New_iRecordableServicePtr(ptr)
628 // TEMPLATE_TYPEDEF(std::list<eServiceReference>, eServiceReferenceList);
630 class iMutableServiceList: public iObject
633 iMutableServiceList();
634 ~iMutableServiceList();
638 virtual RESULT flushChanges()=0;
639 /* adds a service to a list */
640 virtual RESULT addService(eServiceReference &ref, eServiceReference before=eServiceReference())=0;
641 /* removes a service from a list */
642 virtual RESULT removeService(eServiceReference &ref)=0;
643 /* moves a service in a list, only if list suppports a specific sort method. */
644 /* pos is the new, absolute position from 0..size-1 */
645 virtual RESULT moveService(eServiceReference &ref, int pos)=0;
646 /* set name of list, for bouquets this is the visible bouquet name */
647 virtual RESULT setListName(const std::string &name)=0;
650 TEMPLATE_TYPEDEF(ePtr<iMutableServiceList>, iMutableServiceListPtr);
652 class iListableService: public iObject
660 /* legacy interface: get a list */
661 virtual RESULT getContent(std::list<eServiceReference> &list, bool sorted=false)=0;
663 virtual PyObject *getContent(const char* format, bool sorted=false)=0;
665 /* new, shiny interface: streaming. */
666 virtual SWIG_VOID(RESULT) getNext(eServiceReference &SWIG_OUTPUT)=0;
668 /* use this for sorting. output is not sorted because of either
669 - performance reasons: the whole list must be buffered or
670 - the interface would be restricted to a list. streaming
671 (as well as a future "active" extension) won't be possible.
673 virtual int compareLessEqual(const eServiceReference &, const eServiceReference &)=0;
675 virtual SWIG_VOID(RESULT) startEdit(ePtr<iMutableServiceList> &SWIG_OUTPUT)=0;
678 TEMPLATE_TYPEDEF(ePtr<iListableService>, iListableServicePtr);
681 /* a helper class which can be used as argument to stl's sort(). */
682 class iListableServiceCompare
684 ePtr<iListableService> m_list;
686 iListableServiceCompare(iListableService *list): m_list(list) { }
687 bool operator()(const eServiceReference &a, const eServiceReference &b)
689 return m_list->compareLessEqual(a, b);
694 class iServiceOfflineOperations: public iObject
697 iServiceOfflineOperations();
698 ~iServiceOfflineOperations();
701 /* to delete a service, forever. */
702 virtual RESULT deleteFromDisk(int simulate=1)=0;
704 /* for transferring a service... */
705 virtual SWIG_VOID(RESULT) getListOfFilenames(std::list<std::string> &SWIG_OUTPUT)=0;
707 // TODO: additional stuff, like a conversion interface?
710 TEMPLATE_TYPEDEF(ePtr<iServiceOfflineOperations>, iServiceOfflineOperationsPtr);
712 class iServiceHandler: public iObject
719 virtual SWIG_VOID(RESULT) play(const eServiceReference &, ePtr<iPlayableService> &SWIG_OUTPUT)=0;
720 virtual SWIG_VOID(RESULT) record(const eServiceReference &, ePtr<iRecordableService> &SWIG_OUTPUT)=0;
721 virtual SWIG_VOID(RESULT) list(const eServiceReference &, ePtr<iListableService> &SWIG_OUTPUT)=0;
722 virtual SWIG_VOID(RESULT) info(const eServiceReference &, ePtr<iStaticServiceInformation> &SWIG_OUTPUT)=0;
723 virtual SWIG_VOID(RESULT) offlineOperations(const eServiceReference &, ePtr<iServiceOfflineOperations> &SWIG_OUTPUT)=0;
726 TEMPLATE_TYPEDEF(ePtr<iServiceHandler>, iServiceHandlerPtr);