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);
247 virtual int setInfo(const eServiceReference &ref, int w, int v);
248 virtual int setInfoString(const eServiceReference &ref, int w, const char *v);
251 TEMPLATE_TYPEDEF(ePtr<iStaticServiceInformation>, iStaticServiceInformationPtr);
253 class iServiceInformation: public iObject
256 iServiceInformation();
257 ~iServiceInformation();
260 virtual SWIG_VOID(RESULT) getName(std::string &SWIG_OUTPUT)=0;
261 virtual SWIG_VOID(RESULT) getEvent(ePtr<eServiceEvent> &SWIG_OUTPUT, int nownext);
264 sIsCrypted, /* is encrypted (no indication if decrypt was possible) */
265 sAspect, /* aspect ratio: 0=4:3, 1=16:9, 2=whatever we need */
266 sIsMultichannel, /* multichannel *available* (probably not selected) */
268 /* "user serviceable info" - they are not reliable. Don't use them for anything except the service menu!
269 that's also the reason why they are so globally defined.
272 again - if somebody EVER tries to use this information for anything else than simply displaying it,
273 i will change this to return a user-readable text like "zero x zero three three" (and change the
274 exact spelling in every version) to stop that!
290 sTimeCreate, // unix time or string
299 sVideoType, // MPEG2 MPEG4
301 sTags, /* space seperated list of tags */
303 sDVBState, /* states as defined in pmt handler (as events there) */
308 enum { resNA = -1, resIsString = -2, resIsPyObject = -3 };
310 virtual int getInfo(int w);
311 virtual std::string getInfoString(int w);
312 virtual PyObject *getInfoObject(int w);
314 virtual int setInfo(int w, int v);
315 virtual int setInfoString(int w, const char *v);
318 TEMPLATE_TYPEDEF(ePtr<iServiceInformation>, iServiceInformationPtr);
320 class iFrontendInformation: public iObject
323 iFrontendInformation();
324 ~iFrontendInformation();
335 virtual int getFrontendInfo(int w)=0;
336 virtual PyObject *getFrontendData(bool original=false)=0;
339 TEMPLATE_TYPEDEF(ePtr<iFrontendInformation>, iFrontendInformationPtr);
341 class iPauseableService: public iObject
348 virtual RESULT pause()=0;
349 virtual RESULT unpause()=0;
352 virtual RESULT setSlowMotion(int ratio=0)=0;
353 virtual RESULT setFastForward(int ratio=0)=0;
356 TEMPLATE_TYPEDEF(ePtr<iPauseableService>, iPauseableServicePtr);
358 class iSeekableService: public iObject
365 virtual RESULT getLength(pts_t &SWIG_OUTPUT)=0;
366 virtual RESULT seekTo(pts_t to)=0;
367 enum { dirForward = +1, dirBackward = -1 };
368 virtual RESULT seekRelative(int direction, pts_t to)=0;
369 virtual RESULT getPlayPosition(pts_t &SWIG_OUTPUT)=0;
370 /* if you want to do several seeks in a row, you can enable the trickmode.
371 audio will be switched off, sync will be disabled etc. */
372 virtual RESULT setTrickmode(int trick=0)=0;
373 virtual RESULT isCurrentlySeekable()=0;
376 TEMPLATE_TYPEDEF(ePtr<iSeekableService>, iSeekableServicePtr);
378 struct iAudioTrackInfo
381 std::string m_description;
382 std::string m_language; /* iso639 */
384 std::string getDescription() { return m_description; }
385 std::string getLanguage() { return m_language; }
388 SWIG_ALLOW_OUTPUT_SIMPLE(iAudioTrackInfo);
390 class iAudioTrackSelection: public iObject
393 iAudioTrackSelection();
394 ~iAudioTrackSelection();
397 virtual int getNumberOfTracks()=0;
398 virtual RESULT selectTrack(unsigned int i)=0;
399 virtual SWIG_VOID(RESULT) getTrackInfo(struct iAudioTrackInfo &SWIG_OUTPUT, unsigned int n)=0;
402 TEMPLATE_TYPEDEF(ePtr<iAudioTrackSelection>, iAudioTrackSelectionPtr);
404 class iAudioChannelSelection: public iObject
407 iAudioChannelSelection();
408 ~iAudioChannelSelection();
411 enum { LEFT, STEREO, RIGHT };
412 virtual int getCurrentChannel()=0;
413 virtual RESULT selectChannel(int i)=0;
416 TEMPLATE_TYPEDEF(ePtr<iAudioChannelSelection>, iAudioChannelSelectionPtr);
418 class iAudioDelay: public iObject
425 virtual int getAC3Delay()=0;
426 virtual int getPCMDelay()=0;
427 virtual void setAC3Delay(int)=0;
428 virtual void setPCMDelay(int)=0;
431 TEMPLATE_TYPEDEF(ePtr<iAudioDelay>, iAudioDelayPtr);
433 class iRadioText: public iObject
440 virtual std::string getRadioText(int x=0)=0;
443 TEMPLATE_TYPEDEF(ePtr<iRadioText>, iRadioTextPtr);
445 class iSubserviceList: public iObject
452 virtual int getNumberOfSubservices()=0;
453 virtual SWIG_VOID(RESULT) getSubservice(eServiceReference &SWIG_OUTPUT, unsigned int n)=0;
456 TEMPLATE_TYPEDEF(ePtr<iSubserviceList>, iSubserviceListPtr);
458 class iTimeshiftService: public iObject
462 ~iTimeshiftService();
465 virtual RESULT startTimeshift()=0;
466 virtual RESULT stopTimeshift()=0;
468 virtual int isTimeshiftActive()=0;
469 /* this essentially seeks to the relative end of the timeshift buffer */
470 virtual RESULT activateTimeshift()=0;
473 TEMPLATE_TYPEDEF(ePtr<iTimeshiftService>, iTimeshiftServicePtr);
475 /* not related to eCueSheet */
476 class iCueSheet: public iObject
483 /* returns a list of (pts, what)-tuples */
484 virtual PyObject *getCutList() = 0;
485 virtual void setCutList(SWIG_PYOBJECT(ePyObject) list) = 0;
486 virtual void setCutListEnable(int enable) = 0;
487 enum { cutIn = 0, cutOut = 1, cutMark = 2 };
490 TEMPLATE_TYPEDEF(ePtr<iCueSheet>, iCueSheetPtr);
495 class iSubtitleOutput: public iObject
498 virtual RESULT enableSubtitles(eWidget *parent, SWIG_PYOBJECT(ePyObject) entry)=0;
499 virtual RESULT disableSubtitles(eWidget *parent)=0;
500 virtual PyObject *getSubtitleList()=0;
501 virtual PyObject *getCachedSubtitle()=0;
504 TEMPLATE_TYPEDEF(ePtr<iSubtitleOutput>, iSubtitleOutputPtr);
506 class iPlayableService: public iObject
512 friend class iServiceHandler;
516 /* these first two events are magical, and should only
517 be generated if you know what you're doing. */
522 // when iServiceInformation is implemented:
526 /* when seek() is implemented: */
527 evSeekableStatusChanged, /* for example when timeshifting */
530 evSOF, /* bounced against start of file (when seeking backwards) */
532 /* only when cueSheet is implemented */
540 virtual RESULT connectEvent(const Slot2<void,iPlayableService*,int> &event, ePtr<eConnection> &connection)=0;
542 virtual RESULT start()=0;
543 virtual RESULT stop()=0;
544 /* might have to be changed... */
545 virtual RESULT setTarget(int target)=0;
546 virtual SWIG_VOID(RESULT) seek(ePtr<iSeekableService> &SWIG_OUTPUT)=0;
547 virtual SWIG_VOID(RESULT) pause(ePtr<iPauseableService> &SWIG_OUTPUT)=0;
548 virtual SWIG_VOID(RESULT) info(ePtr<iServiceInformation> &SWIG_OUTPUT)=0;
549 virtual SWIG_VOID(RESULT) audioTracks(ePtr<iAudioTrackSelection> &SWIG_OUTPUT)=0;
550 virtual SWIG_VOID(RESULT) audioChannel(ePtr<iAudioChannelSelection> &SWIG_OUTPUT)=0;
551 virtual SWIG_VOID(RESULT) subServices(ePtr<iSubserviceList> &SWIG_OUTPUT)=0;
552 virtual SWIG_VOID(RESULT) frontendInfo(ePtr<iFrontendInformation> &SWIG_OUTPUT)=0;
553 virtual SWIG_VOID(RESULT) timeshift(ePtr<iTimeshiftService> &SWIG_OUTPUT)=0;
554 virtual SWIG_VOID(RESULT) cueSheet(ePtr<iCueSheet> &SWIG_OUTPUT)=0;
555 virtual SWIG_VOID(RESULT) subtitle(ePtr<iSubtitleOutput> &SWIG_OUTPUT)=0;
556 virtual SWIG_VOID(RESULT) audioDelay(ePtr<iAudioDelay> &SWIG_OUTPUT)=0;
557 virtual SWIG_VOID(RESULT) radioText(ePtr<iRadioText> &SWIG_OUTPUT)=0;
560 TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
562 class iRecordableService: public iObject
565 iRecordableService();
566 ~iRecordableService();
584 errOpenRecordFile=-1,
585 errNoDemuxAvailable=-2,
586 errNoTsRecorderAvailable=-3,
591 virtual RESULT connectEvent(const Slot2<void,iRecordableService*,int> &event, ePtr<eConnection> &connection)=0;
593 virtual RESULT getError(int &)=0;
594 virtual RESULT prepare(const char *filename, time_t begTime=-1, time_t endTime=-1, int eit_event_id=-1)=0;
595 virtual RESULT start()=0;
596 virtual RESULT stop()=0;
597 virtual SWIG_VOID(RESULT) frontendInfo(ePtr<iFrontendInformation> &SWIG_OUTPUT)=0;
600 TEMPLATE_TYPEDEF(ePtr<iRecordableService>, iRecordableServicePtr);
602 extern PyObject *New_iRecordableServicePtr(const ePtr<iRecordableService> &ref); // defined in enigma_python.i
604 inline PyObject *PyFrom(ePtr<iRecordableService> &c)
606 return New_iRecordableServicePtr(c);
610 #ifdef PYTHON_REFCOUNT_DEBUG
611 inline ePyObject Impl_New_iRecordableServicePtr(const char* file, int line, const ePtr<iRecordableService> &ptr)
613 return ePyObject(New_iRecordableServicePtr(ptr), file, line);
615 #define NEW_iRecordableServicePtr(ptr) Impl_New_iRecordableServicePtr(__FILE__, __LINE__, ptr)
617 inline ePyObject Impl_New_iRecordableServicePtr(const ePtr<iRecordableService> &ptr)
619 return New_iRecordableServicePtr(ptr);
621 #define NEW_iRecordableServicePtr(ptr) Impl_New_iRecordableServicePtr(ptr)
625 // TEMPLATE_TYPEDEF(std::list<eServiceReference>, eServiceReferenceList);
627 class iMutableServiceList: public iObject
630 iMutableServiceList();
631 ~iMutableServiceList();
635 virtual RESULT flushChanges()=0;
636 /* adds a service to a list */
637 virtual RESULT addService(eServiceReference &ref, eServiceReference before=eServiceReference())=0;
638 /* removes a service from a list */
639 virtual RESULT removeService(eServiceReference &ref)=0;
640 /* moves a service in a list, only if list suppports a specific sort method. */
641 /* pos is the new, absolute position from 0..size-1 */
642 virtual RESULT moveService(eServiceReference &ref, int pos)=0;
643 /* set name of list, for bouquets this is the visible bouquet name */
644 virtual RESULT setListName(const std::string &name)=0;
647 TEMPLATE_TYPEDEF(ePtr<iMutableServiceList>, iMutableServiceListPtr);
649 class iListableService: public iObject
657 /* legacy interface: get a list */
658 virtual RESULT getContent(std::list<eServiceReference> &list, bool sorted=false)=0;
660 virtual PyObject *getContent(const char* format, bool sorted=false)=0;
662 /* new, shiny interface: streaming. */
663 virtual SWIG_VOID(RESULT) getNext(eServiceReference &SWIG_OUTPUT)=0;
665 /* use this for sorting. output is not sorted because of either
666 - performance reasons: the whole list must be buffered or
667 - the interface would be restricted to a list. streaming
668 (as well as a future "active" extension) won't be possible.
670 virtual int compareLessEqual(const eServiceReference &, const eServiceReference &)=0;
672 virtual SWIG_VOID(RESULT) startEdit(ePtr<iMutableServiceList> &SWIG_OUTPUT)=0;
675 TEMPLATE_TYPEDEF(ePtr<iListableService>, iListableServicePtr);
678 /* a helper class which can be used as argument to stl's sort(). */
679 class iListableServiceCompare
681 ePtr<iListableService> m_list;
683 iListableServiceCompare(iListableService *list): m_list(list) { }
684 bool operator()(const eServiceReference &a, const eServiceReference &b)
686 return m_list->compareLessEqual(a, b);
691 class iServiceOfflineOperations: public iObject
694 iServiceOfflineOperations();
695 ~iServiceOfflineOperations();
698 /* to delete a service, forever. */
699 virtual RESULT deleteFromDisk(int simulate=1)=0;
701 /* for transferring a service... */
702 virtual SWIG_VOID(RESULT) getListOfFilenames(std::list<std::string> &SWIG_OUTPUT)=0;
704 // TODO: additional stuff, like a conversion interface?
707 TEMPLATE_TYPEDEF(ePtr<iServiceOfflineOperations>, iServiceOfflineOperationsPtr);
709 class iServiceHandler: public iObject
716 virtual SWIG_VOID(RESULT) play(const eServiceReference &, ePtr<iPlayableService> &SWIG_OUTPUT)=0;
717 virtual SWIG_VOID(RESULT) record(const eServiceReference &, ePtr<iRecordableService> &SWIG_OUTPUT)=0;
718 virtual SWIG_VOID(RESULT) list(const eServiceReference &, ePtr<iListableService> &SWIG_OUTPUT)=0;
719 virtual SWIG_VOID(RESULT) info(const eServiceReference &, ePtr<iStaticServiceInformation> &SWIG_OUTPUT)=0;
720 virtual SWIG_VOID(RESULT) offlineOperations(const eServiceReference &, ePtr<iServiceOfflineOperations> &SWIG_OUTPUT)=0;
723 TEMPLATE_TYPEDEF(ePtr<iServiceHandler>, iServiceHandlerPtr);