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
43 int flags; // flags will NOT be compared.
45 inline int getSortKey() const { return (flags & hasSortKey) ? data[3] : ((flags & sort1) ? 1 : 0); }
51 std::string getPath() { return path; }
52 void setPath( const std::string &n ) { path=n; }
54 unsigned int getUnsignedData(unsigned int num) const
56 if ( num < sizeof(data)/sizeof(int) )
61 int getData(unsigned int num) const
63 if ( num < sizeof(data)/sizeof(int) )
68 void setUnsignedData(unsigned int num, unsigned int val)
70 if ( num < sizeof(data)/sizeof(int) )
74 void setData(unsigned int num, int val)
76 if ( num < sizeof(data)/sizeof(int) )
80 // only for override service names in bouquets or to give servicerefs a name which not have a
81 // real existing service ( for dvb eServiceDVB )
85 std::string getName() { return name; }
86 void setName( const std::string &n ) { name=n; }
89 : type(idInvalid), flags(0)
91 memset(data, 0, sizeof(data));
94 eServiceReference(int type, int flags)
95 : type(type), flags(flags)
97 memset(data, 0, sizeof(data));
99 eServiceReference(int type, int flags, int data0)
100 : type(type), flags(flags)
102 memset(data, 0, sizeof(data));
105 eServiceReference(int type, int flags, int data0, int data1)
106 : type(type), flags(flags)
108 memset(data, 0, sizeof(data));
112 eServiceReference(int type, int flags, int data0, int data1, int data2)
113 : type(type), flags(flags)
115 memset(data, 0, sizeof(data));
120 eServiceReference(int type, int flags, int data0, int data1, int data2, int data3)
121 : type(type), flags(flags)
123 memset(data, 0, sizeof(data));
129 eServiceReference(int type, int flags, int data0, int data1, int data2, int data3, int data4)
130 : type(type), flags(flags)
132 memset(data, 0, sizeof(data));
139 eServiceReference(int type, int flags, const std::string &path)
140 : type(type), flags(flags), path(path)
142 memset(data, 0, sizeof(data));
145 eServiceReference(const std::string &string);
146 std::string toString() const;
147 bool operator==(const eServiceReference &c) const
151 return (memcmp(data, c.data, sizeof(int)*8)==0) && (path == c.path);
153 bool operator!=(const eServiceReference &c) const
155 return !(*this == c);
157 bool operator<(const eServiceReference &c) const
165 int r=memcmp(data, c.data, sizeof(int)*8);
168 return path < c.path;
170 operator bool() const
177 return type != idInvalid;
181 SWIG_ALLOW_OUTPUT_SIMPLE(eServiceReference);
183 extern PyObject *New_eServiceReference(const eServiceReference &ref); // defined in enigma_python.i
185 typedef long long pts_t;
187 /* the reason we have the servicereference as additional argument is
188 that we don't have to create one object for every entry in a possibly
189 large list, provided that no state information is nessesary to deliver
190 the required information. Anyway - ref *must* be the same as the argument
191 to the info() or getIServiceInformation call! */
193 /* About the usage of SWIG_VOID:
194 SWIG_VOID(real_returntype_t) hides a return value from swig. This is used for
195 the "superflouus" RESULT return values.
197 Python code has to check the returned pointer against 0. This works,
198 as all functions returning instances in smartpointers AND having a
199 RESULT have to BOTH return non-zero AND set the pointer to zero.
201 Python code thus can't check for the reason, but the reason isn't
202 user-servicable anyway. If you want to return a real reason which
203 goes beyong "it just doesn't work", use extra variables for this,
206 Hide the result only if there is another way to check for failure! */
208 class iStaticServiceInformation: public iObject
211 iStaticServiceInformation();
212 ~iStaticServiceInformation();
215 virtual SWIG_VOID(RESULT) getName(const eServiceReference &ref, std::string &SWIG_OUTPUT)=0;
217 // doesn't need to be implemented, should return -1 then.
218 virtual int getLength(const eServiceReference &ref);
219 virtual SWIG_VOID(RESULT) getEvent(const eServiceReference &ref, ePtr<eServiceEvent> &SWIG_OUTPUT, time_t start_time=-1);
220 // returns true when not implemented
221 virtual bool isPlayable(const eServiceReference &ref, const eServiceReference &ignore);
223 virtual int getInfo(const eServiceReference &ref, int w);
224 virtual std::string getInfoString(const eServiceReference &ref,int w);
227 TEMPLATE_TYPEDEF(ePtr<iStaticServiceInformation>, iStaticServiceInformationPtr);
229 TEMPLATE_TYPEDEF(ePtr<eServiceEvent>, eServiceEventPtr);
231 class iServiceInformation: public iObject
234 iServiceInformation();
235 ~iServiceInformation();
238 virtual SWIG_VOID(RESULT) getName(std::string &SWIG_OUTPUT)=0;
239 virtual SWIG_VOID(RESULT) getEvent(ePtr<eServiceEvent> &SWIG_OUTPUT, int nownext);
242 sIsCrypted, /* is encrypted (no indication if decrypt was possible) */
243 sAspect, /* aspect ratio: 0=4:3, 1=16:9, 2=whatever we need */
244 sIsMultichannel, /* multichannel *available* (probably not selected) */
246 /* "user serviceable info" - they are not reliable. Don't use them for anything except the service menu!
247 that's also the reason why they are so globally defined.
250 again - if somebody EVER tries to use this information for anything else than simply displaying it,
251 i will change this to return a user-readable text like "zero x zero three three" (and change the
252 exact spelling in every version) to stop that!
268 sTimeCreate, // unix time or string
277 sVideoType // MPEG2 MPEG4
279 enum { resNA = -1, resIsString = -2, resIsPyObject = -3 };
281 virtual int getInfo(int w);
282 virtual std::string getInfoString(int w);
283 virtual PyObject *getInfoObject(int w);
286 TEMPLATE_TYPEDEF(ePtr<iServiceInformation>, iServiceInformationPtr);
288 class iFrontendStatusInformation: public iObject
291 iFrontendStatusInformation();
292 ~iFrontendStatusInformation();
302 virtual int getFrontendInfo(int w)=0;
303 virtual PyObject *getFrontendData(bool original=false)=0;
306 TEMPLATE_TYPEDEF(ePtr<iFrontendStatusInformation>, iFrontendStatusInformationPtr);
308 class iPauseableService: public iObject
315 virtual RESULT pause()=0;
316 virtual RESULT unpause()=0;
319 virtual RESULT setSlowMotion(int ratio=0)=0;
320 virtual RESULT setFastForward(int ratio=0)=0;
323 TEMPLATE_TYPEDEF(ePtr<iPauseableService>, iPauseableServicePtr);
325 class iSeekableService: public iObject
332 virtual RESULT getLength(pts_t &SWIG_OUTPUT)=0;
333 virtual RESULT seekTo(pts_t to)=0;
334 enum { dirForward = +1, dirBackward = -1 };
335 virtual RESULT seekRelative(int direction, pts_t to)=0;
336 virtual RESULT getPlayPosition(pts_t &SWIG_OUTPUT)=0;
337 /* if you want to do several seeks in a row, you can enable the trickmode.
338 audio will be switched off, sync will be disabled etc. */
339 virtual RESULT setTrickmode(int trick=0)=0;
340 virtual RESULT isCurrentlySeekable()=0;
343 TEMPLATE_TYPEDEF(ePtr<iSeekableService>, iSeekableServicePtr);
345 struct iAudioTrackInfo
354 std::string m_description;
355 std::string m_language; /* iso639 */
357 std::string getDescription() { return m_description; }
358 std::string getLanguage() { return m_language; }
361 SWIG_ALLOW_OUTPUT_SIMPLE(iAudioTrackInfo);
363 class iAudioTrackSelection: public iObject
366 iAudioTrackSelection();
367 ~iAudioTrackSelection();
370 virtual int getNumberOfTracks()=0;
371 virtual RESULT selectTrack(unsigned int i)=0;
372 virtual SWIG_VOID(RESULT) getTrackInfo(struct iAudioTrackInfo &SWIG_OUTPUT, unsigned int n)=0;
375 TEMPLATE_TYPEDEF(ePtr<iAudioTrackSelection>, iAudioTrackSelectionPtr);
377 class iAudioChannelSelection: public iObject
380 iAudioChannelSelection();
381 ~iAudioChannelSelection();
384 enum { LEFT, STEREO, RIGHT };
385 virtual int getCurrentChannel()=0;
386 virtual RESULT selectChannel(int i)=0;
389 TEMPLATE_TYPEDEF(ePtr<iAudioChannelSelection>, iAudioChannelSelectionPtr);
391 class iSubserviceList: public iObject
398 virtual int getNumberOfSubservices()=0;
399 virtual SWIG_VOID(RESULT) getSubservice(eServiceReference &SWIG_OUTPUT, unsigned int n)=0;
402 TEMPLATE_TYPEDEF(ePtr<iSubserviceList>, iSubserviceListPtr);
404 class iTimeshiftService: public iObject
408 ~iTimeshiftService();
411 virtual RESULT startTimeshift()=0;
412 virtual RESULT stopTimeshift()=0;
414 virtual int isTimeshiftActive()=0;
415 /* this essentially seeks to the relative end of the timeshift buffer */
416 virtual RESULT activateTimeshift()=0;
419 TEMPLATE_TYPEDEF(ePtr<iTimeshiftService>, iTimeshiftServicePtr);
421 /* not related to eCueSheet */
422 class iCueSheet: public iObject
429 /* returns a list of (pts, what)-tuples */
430 virtual PyObject *getCutList() = 0;
431 virtual void setCutList(PyObject *list) = 0;
432 virtual void setCutListEnable(int enable) = 0;
433 enum { cutIn = 0, cutOut = 1, cutMark = 2 };
436 TEMPLATE_TYPEDEF(ePtr<iCueSheet>, iCueSheetPtr);
438 class iPlayableService: public iObject
444 friend class iServiceHandler;
448 /* these first two events are magical, and should only
449 be generated if you know what you're doing. */
454 // when iServiceInformation is implemented:
458 /* when seek() is implemented: */
459 evSeekableStatusChanged, /* for example when timeshifting */
462 evSOF, /* bounced against start of file (when seeking backwards) */
464 /* only when cueSheet is implemented */
467 virtual RESULT connectEvent(const Slot2<void,iPlayableService*,int> &event, ePtr<eConnection> &connection)=0;
468 virtual RESULT start()=0;
469 virtual RESULT stop()=0;
470 /* might have to be changed... */
471 virtual RESULT setTarget(int target)=0;
472 virtual SWIG_VOID(RESULT) seek(ePtr<iSeekableService> &SWIG_OUTPUT)=0;
473 virtual SWIG_VOID(RESULT) pause(ePtr<iPauseableService> &SWIG_OUTPUT)=0;
474 virtual SWIG_VOID(RESULT) info(ePtr<iServiceInformation> &SWIG_OUTPUT)=0;
475 virtual SWIG_VOID(RESULT) audioTracks(ePtr<iAudioTrackSelection> &SWIG_OUTPUT)=0;
476 virtual SWIG_VOID(RESULT) audioChannel(ePtr<iAudioChannelSelection> &SWIG_OUTPUT)=0;
477 virtual SWIG_VOID(RESULT) subServices(ePtr<iSubserviceList> &SWIG_OUTPUT)=0;
478 virtual SWIG_VOID(RESULT) frontendStatusInfo(ePtr<iFrontendStatusInformation> &SWIG_OUTPUT)=0;
479 virtual SWIG_VOID(RESULT) timeshift(ePtr<iTimeshiftService> &SWIG_OUTPUT)=0;
480 virtual SWIG_VOID(RESULT) cueSheet(ePtr<iCueSheet> &SWIG_OUTPUT)=0;
483 TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
485 class iRecordableService: public iObject
488 iRecordableService();
489 ~iRecordableService();
492 virtual RESULT prepare(const char *filename, time_t begTime=-1, time_t endTime=-1, int eit_event_id=-1)=0;
493 virtual RESULT start()=0;
494 virtual RESULT stop()=0;
497 TEMPLATE_TYPEDEF(ePtr<iRecordableService>, iRecordableServicePtr);
499 // TEMPLATE_TYPEDEF(std::list<eServiceReference>, eServiceReferenceList);
501 class iMutableServiceList: public iObject
504 iMutableServiceList();
505 ~iMutableServiceList();
509 virtual RESULT flushChanges()=0;
510 /* adds a service to a list */
511 virtual RESULT addService(eServiceReference &ref)=0;
512 /* removes a service from a list */
513 virtual RESULT removeService(eServiceReference &ref)=0;
514 /* moves a service in a list, only if list suppports a specific sort method. */
515 /* pos is the new, absolute position from 0..size-1 */
516 virtual RESULT moveService(eServiceReference &ref, int pos)=0;
517 /* set name of list, for bouquets this is the visible bouquet name */
518 virtual RESULT setListName(const std::string &name)=0;
521 TEMPLATE_TYPEDEF(ePtr<iMutableServiceList>, iMutableServiceListPtr);
523 class iListableService: public iObject
530 /* legacy interface: get a list */
531 virtual RESULT getContent(std::list<eServiceReference> &list, bool sorted=false)=0;
532 virtual PyObject *getContent(const char* format, bool sorted=false)=0;
534 /* new, shiny interface: streaming. */
535 virtual SWIG_VOID(RESULT) getNext(eServiceReference &SWIG_OUTPUT)=0;
537 /* use this for sorting. output is not sorted because of either
538 - performance reasons: the whole list must be buffered or
539 - the interface would be restricted to a list. streaming
540 (as well as a future "active" extension) won't be possible.
542 virtual int compareLessEqual(const eServiceReference &, const eServiceReference &)=0;
544 virtual SWIG_VOID(RESULT) startEdit(ePtr<iMutableServiceList> &SWIG_OUTPUT)=0;
547 TEMPLATE_TYPEDEF(ePtr<iListableService>, iListableServicePtr);
550 /* a helper class which can be used as argument to stl's sort(). */
551 class iListableServiceCompare
553 ePtr<iListableService> m_list;
555 iListableServiceCompare(iListableService *list): m_list(list) { }
556 bool operator()(const eServiceReference &a, const eServiceReference &b)
558 return m_list->compareLessEqual(a, b);
563 class iServiceOfflineOperations: public iObject
566 iServiceOfflineOperations();
567 ~iServiceOfflineOperations();
570 /* to delete a service, forever. */
571 virtual RESULT deleteFromDisk(int simulate=1)=0;
573 /* for transferring a service... */
574 virtual SWIG_VOID(RESULT) getListOfFilenames(std::list<std::string> &SWIG_OUTPUT)=0;
576 // TODO: additional stuff, like a conversion interface?
579 TEMPLATE_TYPEDEF(ePtr<iServiceOfflineOperations>, iServiceOfflineOperationsPtr);
581 class iServiceHandler: public iObject
588 virtual SWIG_VOID(RESULT) play(const eServiceReference &, ePtr<iPlayableService> &SWIG_OUTPUT)=0;
589 virtual SWIG_VOID(RESULT) record(const eServiceReference &, ePtr<iRecordableService> &SWIG_OUTPUT)=0;
590 virtual SWIG_VOID(RESULT) list(const eServiceReference &, ePtr<iListableService> &SWIG_OUTPUT)=0;
591 virtual SWIG_VOID(RESULT) info(const eServiceReference &, ePtr<iStaticServiceInformation> &SWIG_OUTPUT)=0;
592 virtual SWIG_VOID(RESULT) offlineOperations(const eServiceReference &, ePtr<iServiceOfflineOperations> &SWIG_OUTPUT)=0;
595 TEMPLATE_TYPEDEF(ePtr<iServiceHandler>, iServiceHandlerPtr);