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 int getData(unsigned int num) const
56 if ( num < sizeof(data)/sizeof(int) )
61 void setData(unsigned int num, int val)
63 if ( num < sizeof(data)/sizeof(int) )
67 // only for override service names in bouquets or to give servicerefs a name which not have a
68 // real existing service ( for dvb eServiceDVB )
72 std::string getName() { return name; }
73 void setName( const std::string &n ) { name=n; }
76 : type(idInvalid), flags(0)
78 memset(data, 0, sizeof(data));
81 eServiceReference(int type, int flags)
82 : type(type), flags(flags)
84 memset(data, 0, sizeof(data));
86 eServiceReference(int type, int flags, int data0)
87 : type(type), flags(flags)
89 memset(data, 0, sizeof(data));
92 eServiceReference(int type, int flags, int data0, int data1)
93 : type(type), flags(flags)
95 memset(data, 0, sizeof(data));
99 eServiceReference(int type, int flags, int data0, int data1, int data2)
100 : type(type), flags(flags)
102 memset(data, 0, sizeof(data));
107 eServiceReference(int type, int flags, int data0, int data1, int data2, int data3)
108 : type(type), flags(flags)
110 memset(data, 0, sizeof(data));
116 eServiceReference(int type, int flags, int data0, int data1, int data2, int data3, int data4)
117 : type(type), flags(flags)
119 memset(data, 0, sizeof(data));
126 eServiceReference(int type, int flags, const std::string &path)
127 : type(type), flags(flags), path(path)
129 memset(data, 0, sizeof(data));
132 eServiceReference(const std::string &string);
133 std::string toString() const;
134 bool operator==(const eServiceReference &c) const
138 return (memcmp(data, c.data, sizeof(int)*8)==0) && (path == c.path);
140 bool operator!=(const eServiceReference &c) const
142 return !(*this == c);
144 bool operator<(const eServiceReference &c) const
152 int r=memcmp(data, c.data, sizeof(int)*8);
155 return path < c.path;
157 operator bool() const
164 return type != idInvalid;
168 SWIG_ALLOW_OUTPUT_SIMPLE(eServiceReference);
170 extern PyObject *New_eServiceReference(const eServiceReference &ref); // defined in enigma_python.i
172 typedef long long pts_t;
174 /* the reason we have the servicereference as additional argument is
175 that we don't have to create one object for every entry in a possibly
176 large list, provided that no state information is nessesary to deliver
177 the required information. Anyway - ref *must* be the same as the argument
178 to the info() or getIServiceInformation call! */
180 /* About the usage of SWIG_VOID:
181 SWIG_VOID(real_returntype_t) hides a return value from swig. This is used for
182 the "superflouus" RESULT return values.
184 Python code has to check the returned pointer against 0. This works,
185 as all functions returning instances in smartpointers AND having a
186 RESULT have to BOTH return non-zero AND set the pointer to zero.
188 Python code thus can't check for the reason, but the reason isn't
189 user-servicable anyway. If you want to return a real reason which
190 goes beyong "it just doesn't work", use extra variables for this,
193 Hide the result only if there is another way to check for failure! */
195 class iStaticServiceInformation: public iObject
198 iStaticServiceInformation();
199 ~iStaticServiceInformation();
202 virtual SWIG_VOID(RESULT) getName(const eServiceReference &ref, std::string &SWIG_OUTPUT)=0;
204 // doesn't need to be implemented, should return -1 then.
205 virtual int getLength(const eServiceReference &ref);
206 virtual SWIG_VOID(RESULT) getEvent(const eServiceReference &ref, ePtr<eServiceEvent> &SWIG_OUTPUT, time_t start_time=-1);
207 // returns true when not implemented
208 virtual bool isPlayable(const eServiceReference &ref, const eServiceReference &ignore);
210 virtual int getInfo(const eServiceReference &ref, int w);
211 virtual std::string getInfoString(const eServiceReference &ref,int w);
214 TEMPLATE_TYPEDEF(ePtr<iStaticServiceInformation>, iStaticServiceInformationPtr);
216 TEMPLATE_TYPEDEF(ePtr<eServiceEvent>, eServiceEventPtr);
218 class iServiceInformation: public iObject
221 iServiceInformation();
222 ~iServiceInformation();
225 virtual SWIG_VOID(RESULT) getName(std::string &SWIG_OUTPUT)=0;
226 virtual SWIG_VOID(RESULT) getEvent(ePtr<eServiceEvent> &SWIG_OUTPUT, int nownext);
229 sIsCrypted, /* is encrypted (no indication if decrypt was possible) */
230 sAspect, /* aspect ratio: 0=4:3, 1=16:9, 2=whatever we need */
231 sIsMultichannel, /* multichannel *available* (probably not selected) */
233 /* "user serviceable info" - they are not reliable. Don't use them for anything except the service menu!
234 that's also the reason why they are so globally defined.
237 again - if somebody EVER tries to use this information for anything else than simply displaying it,
238 i will change this to return a user-readable text like "zero x zero three three" (and change the
239 exact spelling in every version) to stop that!
254 sTimeCreate, // unix time or string
256 enum { resNA = -1, resIsString = -2 };
258 virtual int getInfo(int w);
259 virtual std::string getInfoString(int w);
262 TEMPLATE_TYPEDEF(ePtr<iServiceInformation>, iServiceInformationPtr);
264 class iFrontendStatusInformation: public iObject
267 iFrontendStatusInformation();
268 ~iFrontendStatusInformation();
276 virtual int getFrontendInfo(int w)=0;
279 TEMPLATE_TYPEDEF(ePtr<iFrontendStatusInformation>, iFrontendStatusInformationPtr);
281 class iPauseableService: public iObject
288 virtual RESULT pause()=0;
289 virtual RESULT unpause()=0;
292 virtual RESULT setSlowMotion(int ratio=0)=0;
293 virtual RESULT setFastForward(int ratio=0)=0;
296 TEMPLATE_TYPEDEF(ePtr<iPauseableService>, iPauseableServicePtr);
298 class iSeekableService: public iObject
305 virtual RESULT getLength(pts_t &SWIG_OUTPUT)=0;
306 virtual RESULT seekTo(pts_t to)=0;
307 enum { dirForward = +1, dirBackward = -1 };
308 virtual RESULT seekRelative(int direction, pts_t to)=0;
309 virtual RESULT getPlayPosition(pts_t &SWIG_OUTPUT)=0;
310 /* if you want to do several seeks in a row, you can enable the trickmode.
311 audio will be switched off, sync will be disabled etc. */
312 virtual RESULT setTrickmode(int trick=0)=0;
315 TEMPLATE_TYPEDEF(ePtr<iSeekableService>, iSeekableServicePtr);
317 struct iAudioTrackInfo
326 std::string m_description;
327 std::string m_language; /* iso639 */
329 std::string getDescription() { return m_description; }
330 std::string getLanguage() { return m_language; }
333 SWIG_ALLOW_OUTPUT_SIMPLE(iAudioTrackInfo);
335 class iAudioTrackSelection: public iObject
338 iAudioTrackSelection();
339 ~iAudioTrackSelection();
342 virtual int getNumberOfTracks()=0;
343 virtual RESULT selectTrack(unsigned int i)=0;
344 virtual SWIG_VOID(RESULT) getTrackInfo(struct iAudioTrackInfo &SWIG_OUTPUT, unsigned int n)=0;
347 TEMPLATE_TYPEDEF(ePtr<iAudioTrackSelection>, iAudioTrackSelectionPtr);
349 class iSubserviceList: public iObject
356 virtual int getNumberOfSubservices()=0;
357 virtual SWIG_VOID(RESULT) getSubservice(eServiceReference &SWIG_OUTPUT, unsigned int n)=0;
360 TEMPLATE_TYPEDEF(ePtr<iSubserviceList>, iSubserviceListPtr);
362 class iTimeshiftService: public iObject
366 ~iTimeshiftService();
369 virtual RESULT startTimeshift()=0;
370 virtual RESULT stopTimeshift()=0;
372 virtual int isTimeshiftActive()=0;
373 /* this essentially seeks to the relative end of the timeshift buffer */
374 virtual RESULT activateTimeshift()=0;
377 TEMPLATE_TYPEDEF(ePtr<iTimeshiftService>, iTimeshiftServicePtr);
379 class iPlayableService: public iObject
385 friend class iServiceHandler;
389 /* these first two events are magical, and should only
390 be generated if you know what you're doing. */
395 // when iServiceInformation is implemented:
399 /* when seek() is implemented: */
400 evSeekableStatusChanged, /* for example when timeshifting */
403 evSOF, /* bounced against start of file (when seeking backwards) */
405 virtual RESULT connectEvent(const Slot2<void,iPlayableService*,int> &event, ePtr<eConnection> &connection)=0;
406 virtual RESULT start()=0;
407 virtual RESULT stop()=0;
408 virtual SWIG_VOID(RESULT) seek(ePtr<iSeekableService> &SWIG_OUTPUT)=0;
409 virtual SWIG_VOID(RESULT) pause(ePtr<iPauseableService> &SWIG_OUTPUT)=0;
410 virtual SWIG_VOID(RESULT) info(ePtr<iServiceInformation> &SWIG_OUTPUT)=0;
411 virtual SWIG_VOID(RESULT) audioTracks(ePtr<iAudioTrackSelection> &SWIG_OUTPUT)=0;
412 virtual SWIG_VOID(RESULT) subServices(ePtr<iSubserviceList> &SWIG_OUTPUT)=0;
413 virtual SWIG_VOID(RESULT) frontendStatusInfo(ePtr<iFrontendStatusInformation> &SWIG_OUTPUT)=0;
414 virtual SWIG_VOID(RESULT) timeshift(ePtr<iTimeshiftService> &SWIG_OUTPUT)=0;
417 TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
419 class iRecordableService: public iObject
422 iRecordableService();
423 ~iRecordableService();
426 virtual RESULT prepare(const char *filename)=0;
427 virtual RESULT start()=0;
428 virtual RESULT stop()=0;
431 TEMPLATE_TYPEDEF(ePtr<iRecordableService>, iRecordableServicePtr);
433 // TEMPLATE_TYPEDEF(std::list<eServiceReference>, eServiceReferenceList);
435 class iMutableServiceList: public iObject
438 iMutableServiceList();
439 ~iMutableServiceList();
443 virtual RESULT flushChanges()=0;
444 /* adds a service to a list */
445 virtual RESULT addService(eServiceReference &ref)=0;
446 /* removes a service from a list */
447 virtual RESULT removeService(eServiceReference &ref)=0;
448 /* moves a service in a list, only if list suppports a specific sort method. */
449 /* pos is the new, absolute position from 0..size-1 */
450 virtual RESULT moveService(eServiceReference &ref, int pos)=0;
451 /* set name of list, for bouquets this is the visible bouquet name */
452 virtual RESULT setListName(const std::string &name)=0;
455 TEMPLATE_TYPEDEF(ePtr<iMutableServiceList>, iMutableServiceListPtr);
457 class iListableService: public iObject
464 /* legacy interface: get a list */
465 virtual RESULT getContent(std::list<eServiceReference> &list, bool sorted=false)=0;
466 virtual RESULT getContent(PyObject *list, bool sorted=false)=0;
468 /* new, shiny interface: streaming. */
469 virtual SWIG_VOID(RESULT) getNext(eServiceReference &SWIG_OUTPUT)=0;
471 /* use this for sorting. output is not sorted because of either
472 - performance reasons: the whole list must be buffered or
473 - the interface would be restricted to a list. streaming
474 (as well as a future "active" extension) won't be possible.
476 virtual int compareLessEqual(const eServiceReference &, const eServiceReference &)=0;
478 virtual SWIG_VOID(RESULT) startEdit(ePtr<iMutableServiceList> &SWIG_OUTPUT)=0;
481 TEMPLATE_TYPEDEF(ePtr<iListableService>, iListableServicePtr);
484 /* a helper class which can be used as argument to stl's sort(). */
485 class iListableServiceCompare
487 ePtr<iListableService> m_list;
489 iListableServiceCompare(iListableService *list): m_list(list) { }
490 bool operator()(const eServiceReference &a, const eServiceReference &b)
492 return m_list->compareLessEqual(a, b);
497 class iServiceOfflineOperations: public iObject
500 iServiceOfflineOperations();
501 ~iServiceOfflineOperations();
504 /* to delete a service, forever. */
505 virtual RESULT deleteFromDisk(int simulate=1)=0;
507 /* for transferring a service... */
508 virtual SWIG_VOID(RESULT) getListOfFilenames(std::list<std::string> &SWIG_OUTPUT)=0;
510 // TODO: additional stuff, like a conversion interface?
513 TEMPLATE_TYPEDEF(ePtr<iServiceOfflineOperations>, iServiceOfflineOperationsPtr);
515 class iServiceHandler: public iObject
522 virtual SWIG_VOID(RESULT) play(const eServiceReference &, ePtr<iPlayableService> &SWIG_OUTPUT)=0;
523 virtual SWIG_VOID(RESULT) record(const eServiceReference &, ePtr<iRecordableService> &SWIG_OUTPUT)=0;
524 virtual SWIG_VOID(RESULT) list(const eServiceReference &, ePtr<iListableService> &SWIG_OUTPUT)=0;
525 virtual SWIG_VOID(RESULT) info(const eServiceReference &, ePtr<iStaticServiceInformation> &SWIG_OUTPUT)=0;
526 virtual SWIG_VOID(RESULT) offlineOperations(const eServiceReference &, ePtr<iServiceOfflineOperations> &SWIG_OUTPUT)=0;
529 TEMPLATE_TYPEDEF(ePtr<iServiceHandler>, iServiceHandlerPtr);