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
187 typedef long long pts_t;
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! */
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.
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.
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,
208 Hide the result only if there is another way to check for failure! */
210 TEMPLATE_TYPEDEF(ePtr<eServiceEvent>, eServiceEventPtr);
212 class iStaticServiceInformation: public iObject
215 iStaticServiceInformation();
216 ~iStaticServiceInformation();
219 virtual SWIG_VOID(RESULT) getName(const eServiceReference &ref, std::string &SWIG_OUTPUT)=0;
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);
227 virtual int getInfo(const eServiceReference &ref, int w);
228 virtual std::string getInfoString(const eServiceReference &ref,int w);
231 TEMPLATE_TYPEDEF(ePtr<iStaticServiceInformation>, iStaticServiceInformationPtr);
233 class iServiceInformation: public iObject
236 iServiceInformation();
237 ~iServiceInformation();
240 virtual SWIG_VOID(RESULT) getName(std::string &SWIG_OUTPUT)=0;
241 virtual SWIG_VOID(RESULT) getEvent(ePtr<eServiceEvent> &SWIG_OUTPUT, int nownext);
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) */
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.
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!
270 sTimeCreate, // unix time or string
279 sVideoType, // MPEG2 MPEG4
281 sTags, /* space seperated list of tags */
283 enum { resNA = -1, resIsString = -2, resIsPyObject = -3 };
285 virtual int getInfo(int w);
286 virtual std::string getInfoString(int w);
287 virtual PyObject *getInfoObject(int w);
290 TEMPLATE_TYPEDEF(ePtr<iServiceInformation>, iServiceInformationPtr);
292 class iFrontendInformation: public iObject
295 iFrontendInformation();
296 ~iFrontendInformation();
307 virtual int getFrontendInfo(int w)=0;
308 virtual PyObject *getFrontendData(bool original=false)=0;
311 TEMPLATE_TYPEDEF(ePtr<iFrontendInformation>, iFrontendInformationPtr);
313 class iPauseableService: public iObject
320 virtual RESULT pause()=0;
321 virtual RESULT unpause()=0;
324 virtual RESULT setSlowMotion(int ratio=0)=0;
325 virtual RESULT setFastForward(int ratio=0)=0;
328 TEMPLATE_TYPEDEF(ePtr<iPauseableService>, iPauseableServicePtr);
330 class iSeekableService: public iObject
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;
348 TEMPLATE_TYPEDEF(ePtr<iSeekableService>, iSeekableServicePtr);
350 struct iAudioTrackInfo
353 std::string m_description;
354 std::string m_language; /* iso639 */
356 std::string getDescription() { return m_description; }
357 std::string getLanguage() { return m_language; }
360 SWIG_ALLOW_OUTPUT_SIMPLE(iAudioTrackInfo);
362 class iAudioTrackSelection: public iObject
365 iAudioTrackSelection();
366 ~iAudioTrackSelection();
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;
374 TEMPLATE_TYPEDEF(ePtr<iAudioTrackSelection>, iAudioTrackSelectionPtr);
376 class iAudioChannelSelection: public iObject
379 iAudioChannelSelection();
380 ~iAudioChannelSelection();
383 enum { LEFT, STEREO, RIGHT };
384 virtual int getCurrentChannel()=0;
385 virtual RESULT selectChannel(int i)=0;
388 TEMPLATE_TYPEDEF(ePtr<iAudioChannelSelection>, iAudioChannelSelectionPtr);
390 class iAudioDelay: public iObject
397 virtual int getAC3Delay()=0;
398 virtual int getPCMDelay()=0;
399 virtual void setAC3Delay(int)=0;
400 virtual void setPCMDelay(int)=0;
403 TEMPLATE_TYPEDEF(ePtr<iAudioDelay>, iAudioDelayPtr);
405 class iRadioText: public iObject
412 virtual std::string getRadioText(int x=0)=0;
415 TEMPLATE_TYPEDEF(ePtr<iRadioText>, iRadioTextPtr);
417 class iSubserviceList: public iObject
424 virtual int getNumberOfSubservices()=0;
425 virtual SWIG_VOID(RESULT) getSubservice(eServiceReference &SWIG_OUTPUT, unsigned int n)=0;
428 TEMPLATE_TYPEDEF(ePtr<iSubserviceList>, iSubserviceListPtr);
430 class iTimeshiftService: public iObject
434 ~iTimeshiftService();
437 virtual RESULT startTimeshift()=0;
438 virtual RESULT stopTimeshift()=0;
440 virtual int isTimeshiftActive()=0;
441 /* this essentially seeks to the relative end of the timeshift buffer */
442 virtual RESULT activateTimeshift()=0;
445 TEMPLATE_TYPEDEF(ePtr<iTimeshiftService>, iTimeshiftServicePtr);
447 /* not related to eCueSheet */
448 class iCueSheet: public iObject
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 };
462 TEMPLATE_TYPEDEF(ePtr<iCueSheet>, iCueSheetPtr);
467 class iSubtitleOutput: public iObject
470 virtual RESULT enableSubtitles(eWidget *parent, PyObject *entry)=0;
471 virtual RESULT disableSubtitles(eWidget *parent)=0;
472 virtual PyObject *getSubtitleList()=0;
475 TEMPLATE_TYPEDEF(ePtr<iSubtitleOutput>, iSubtitleOutputPtr);
477 class iPlayableService: public iObject
483 friend class iServiceHandler;
487 /* these first two events are magical, and should only
488 be generated if you know what you're doing. */
493 // when iServiceInformation is implemented:
497 /* when seek() is implemented: */
498 evSeekableStatusChanged, /* for example when timeshifting */
501 evSOF, /* bounced against start of file (when seeking backwards) */
503 /* only when cueSheet is implemented */
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;
527 TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
529 class iRecordableService: public iObject
532 iRecordableService();
533 ~iRecordableService();
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;
542 TEMPLATE_TYPEDEF(ePtr<iRecordableService>, iRecordableServicePtr);
544 // TEMPLATE_TYPEDEF(std::list<eServiceReference>, eServiceReferenceList);
546 class iMutableServiceList: public iObject
549 iMutableServiceList();
550 ~iMutableServiceList();
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;
566 TEMPLATE_TYPEDEF(ePtr<iMutableServiceList>, iMutableServiceListPtr);
568 class iListableService: public iObject
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;
579 /* new, shiny interface: streaming. */
580 virtual SWIG_VOID(RESULT) getNext(eServiceReference &SWIG_OUTPUT)=0;
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.
587 virtual int compareLessEqual(const eServiceReference &, const eServiceReference &)=0;
589 virtual SWIG_VOID(RESULT) startEdit(ePtr<iMutableServiceList> &SWIG_OUTPUT)=0;
592 TEMPLATE_TYPEDEF(ePtr<iListableService>, iListableServicePtr);
595 /* a helper class which can be used as argument to stl's sort(). */
596 class iListableServiceCompare
598 ePtr<iListableService> m_list;
600 iListableServiceCompare(iListableService *list): m_list(list) { }
601 bool operator()(const eServiceReference &a, const eServiceReference &b)
603 return m_list->compareLessEqual(a, b);
608 class iServiceOfflineOperations: public iObject
611 iServiceOfflineOperations();
612 ~iServiceOfflineOperations();
615 /* to delete a service, forever. */
616 virtual RESULT deleteFromDisk(int simulate=1)=0;
618 /* for transferring a service... */
619 virtual SWIG_VOID(RESULT) getListOfFilenames(std::list<std::string> &SWIG_OUTPUT)=0;
621 // TODO: additional stuff, like a conversion interface?
624 TEMPLATE_TYPEDEF(ePtr<iServiceOfflineOperations>, iServiceOfflineOperationsPtr);
626 class iServiceHandler: public iObject
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;
640 TEMPLATE_TYPEDEF(ePtr<iServiceHandler>, iServiceHandlerPtr);