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
278 enum { resNA = -1, resIsString = -2, resIsPyObject = -3 };
280 virtual int getInfo(int w);
281 virtual std::string getInfoString(int w);
282 virtual PyObject *getInfoObject(int w);
285 TEMPLATE_TYPEDEF(ePtr<iServiceInformation>, iServiceInformationPtr);
287 class iFrontendStatusInformation: public iObject
290 iFrontendStatusInformation();
291 ~iFrontendStatusInformation();
301 virtual int getFrontendInfo(int w)=0;
302 virtual PyObject *getFrontendData(bool original=false)=0;
305 TEMPLATE_TYPEDEF(ePtr<iFrontendStatusInformation>, iFrontendStatusInformationPtr);
307 class iPauseableService: public iObject
314 virtual RESULT pause()=0;
315 virtual RESULT unpause()=0;
318 virtual RESULT setSlowMotion(int ratio=0)=0;
319 virtual RESULT setFastForward(int ratio=0)=0;
322 TEMPLATE_TYPEDEF(ePtr<iPauseableService>, iPauseableServicePtr);
324 class iSeekableService: public iObject
331 virtual RESULT getLength(pts_t &SWIG_OUTPUT)=0;
332 virtual RESULT seekTo(pts_t to)=0;
333 enum { dirForward = +1, dirBackward = -1 };
334 virtual RESULT seekRelative(int direction, pts_t to)=0;
335 virtual RESULT getPlayPosition(pts_t &SWIG_OUTPUT)=0;
336 /* if you want to do several seeks in a row, you can enable the trickmode.
337 audio will be switched off, sync will be disabled etc. */
338 virtual RESULT setTrickmode(int trick=0)=0;
339 virtual RESULT isCurrentlySeekable()=0;
342 TEMPLATE_TYPEDEF(ePtr<iSeekableService>, iSeekableServicePtr);
344 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 iSubserviceList: public iObject
383 virtual int getNumberOfSubservices()=0;
384 virtual SWIG_VOID(RESULT) getSubservice(eServiceReference &SWIG_OUTPUT, unsigned int n)=0;
387 TEMPLATE_TYPEDEF(ePtr<iSubserviceList>, iSubserviceListPtr);
389 class iTimeshiftService: public iObject
393 ~iTimeshiftService();
396 virtual RESULT startTimeshift()=0;
397 virtual RESULT stopTimeshift()=0;
399 virtual int isTimeshiftActive()=0;
400 /* this essentially seeks to the relative end of the timeshift buffer */
401 virtual RESULT activateTimeshift()=0;
404 TEMPLATE_TYPEDEF(ePtr<iTimeshiftService>, iTimeshiftServicePtr);
406 /* not related to eCueSheet */
407 class iCueSheet: public iObject
414 /* returns a list of (pts, what)-tuples */
415 virtual PyObject *getCutList() = 0;
416 virtual void setCutList(PyObject *list) = 0;
417 virtual void setCutListEnable(int enable) = 0;
418 enum { cutIn = 0, cutOut = 1, cutMark = 2 };
421 TEMPLATE_TYPEDEF(ePtr<iCueSheet>, iCueSheetPtr);
423 class iPlayableService: public iObject
429 friend class iServiceHandler;
433 /* these first two events are magical, and should only
434 be generated if you know what you're doing. */
439 // when iServiceInformation is implemented:
443 /* when seek() is implemented: */
444 evSeekableStatusChanged, /* for example when timeshifting */
447 evSOF, /* bounced against start of file (when seeking backwards) */
449 /* only when cueSheet is implemented */
452 virtual RESULT connectEvent(const Slot2<void,iPlayableService*,int> &event, ePtr<eConnection> &connection)=0;
453 virtual RESULT start()=0;
454 virtual RESULT stop()=0;
455 /* might have to be changed... */
456 virtual RESULT setTarget(int target)=0;
457 virtual SWIG_VOID(RESULT) seek(ePtr<iSeekableService> &SWIG_OUTPUT)=0;
458 virtual SWIG_VOID(RESULT) pause(ePtr<iPauseableService> &SWIG_OUTPUT)=0;
459 virtual SWIG_VOID(RESULT) info(ePtr<iServiceInformation> &SWIG_OUTPUT)=0;
460 virtual SWIG_VOID(RESULT) audioTracks(ePtr<iAudioTrackSelection> &SWIG_OUTPUT)=0;
461 virtual SWIG_VOID(RESULT) subServices(ePtr<iSubserviceList> &SWIG_OUTPUT)=0;
462 virtual SWIG_VOID(RESULT) frontendStatusInfo(ePtr<iFrontendStatusInformation> &SWIG_OUTPUT)=0;
463 virtual SWIG_VOID(RESULT) timeshift(ePtr<iTimeshiftService> &SWIG_OUTPUT)=0;
464 virtual SWIG_VOID(RESULT) cueSheet(ePtr<iCueSheet> &SWIG_OUTPUT)=0;
467 TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
469 class iRecordableService: public iObject
472 iRecordableService();
473 ~iRecordableService();
476 virtual RESULT prepare(const char *filename, time_t begTime=-1, time_t endTime=-1, int eit_event_id=-1)=0;
477 virtual RESULT start()=0;
478 virtual RESULT stop()=0;
481 TEMPLATE_TYPEDEF(ePtr<iRecordableService>, iRecordableServicePtr);
483 // TEMPLATE_TYPEDEF(std::list<eServiceReference>, eServiceReferenceList);
485 class iMutableServiceList: public iObject
488 iMutableServiceList();
489 ~iMutableServiceList();
493 virtual RESULT flushChanges()=0;
494 /* adds a service to a list */
495 virtual RESULT addService(eServiceReference &ref)=0;
496 /* removes a service from a list */
497 virtual RESULT removeService(eServiceReference &ref)=0;
498 /* moves a service in a list, only if list suppports a specific sort method. */
499 /* pos is the new, absolute position from 0..size-1 */
500 virtual RESULT moveService(eServiceReference &ref, int pos)=0;
501 /* set name of list, for bouquets this is the visible bouquet name */
502 virtual RESULT setListName(const std::string &name)=0;
505 TEMPLATE_TYPEDEF(ePtr<iMutableServiceList>, iMutableServiceListPtr);
507 class iListableService: public iObject
514 /* legacy interface: get a list */
515 virtual RESULT getContent(std::list<eServiceReference> &list, bool sorted=false)=0;
516 virtual RESULT getContent(PyObject *list, bool sorted=false)=0;
518 /* new, shiny interface: streaming. */
519 virtual SWIG_VOID(RESULT) getNext(eServiceReference &SWIG_OUTPUT)=0;
521 /* use this for sorting. output is not sorted because of either
522 - performance reasons: the whole list must be buffered or
523 - the interface would be restricted to a list. streaming
524 (as well as a future "active" extension) won't be possible.
526 virtual int compareLessEqual(const eServiceReference &, const eServiceReference &)=0;
528 virtual SWIG_VOID(RESULT) startEdit(ePtr<iMutableServiceList> &SWIG_OUTPUT)=0;
531 TEMPLATE_TYPEDEF(ePtr<iListableService>, iListableServicePtr);
534 /* a helper class which can be used as argument to stl's sort(). */
535 class iListableServiceCompare
537 ePtr<iListableService> m_list;
539 iListableServiceCompare(iListableService *list): m_list(list) { }
540 bool operator()(const eServiceReference &a, const eServiceReference &b)
542 return m_list->compareLessEqual(a, b);
547 class iServiceOfflineOperations: public iObject
550 iServiceOfflineOperations();
551 ~iServiceOfflineOperations();
554 /* to delete a service, forever. */
555 virtual RESULT deleteFromDisk(int simulate=1)=0;
557 /* for transferring a service... */
558 virtual SWIG_VOID(RESULT) getListOfFilenames(std::list<std::string> &SWIG_OUTPUT)=0;
560 // TODO: additional stuff, like a conversion interface?
563 TEMPLATE_TYPEDEF(ePtr<iServiceOfflineOperations>, iServiceOfflineOperationsPtr);
565 class iServiceHandler: public iObject
572 virtual SWIG_VOID(RESULT) play(const eServiceReference &, ePtr<iPlayableService> &SWIG_OUTPUT)=0;
573 virtual SWIG_VOID(RESULT) record(const eServiceReference &, ePtr<iRecordableService> &SWIG_OUTPUT)=0;
574 virtual SWIG_VOID(RESULT) list(const eServiceReference &, ePtr<iListableService> &SWIG_OUTPUT)=0;
575 virtual SWIG_VOID(RESULT) info(const eServiceReference &, ePtr<iStaticServiceInformation> &SWIG_OUTPUT)=0;
576 virtual SWIG_VOID(RESULT) offlineOperations(const eServiceReference &, ePtr<iServiceOfflineOperations> &SWIG_OUTPUT)=0;
579 TEMPLATE_TYPEDEF(ePtr<iServiceHandler>, iServiceHandlerPtr);