1 #ifndef __lib_dvb_iservice_h
2 #define __lib_dvb_iservice_h
4 #include <lib/python/swig.h>
5 #include <lib/base/object.h>
7 #include <connection.h>
12 class eServiceReference
18 idStructure, // service_id == 0 is root
25 int flags; // flags will NOT be compared.
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 inline int getSortKey() const { return (flags & hasSortKey) ? data[3] : ((flags & sort1) ? 1 : 0); }
48 std::string getPath() { return path; }
50 int getData(unsigned int num) const
52 if ( num < sizeof(data)/sizeof(int) )
57 void setData(unsigned int num, int val)
59 if ( num < sizeof(data)/sizeof(int) )
63 // only for override service names in bouquets or to give servicerefs a name which not have a
64 // real existing service ( for dvb eServiceDVB )
66 std::string getName() { return name; }
68 void setName( const std::string &n ) { name=n; }
71 : type(idInvalid), flags(0)
73 memset(data, 0, sizeof(data));
75 eServiceReference(int type, int flags)
76 : type(type), flags(flags)
78 memset(data, 0, sizeof(data));
80 eServiceReference(int type, int flags, int data0)
81 : type(type), flags(flags)
83 memset(data, 0, sizeof(data));
86 eServiceReference(int type, int flags, int data0, int data1)
87 : type(type), flags(flags)
89 memset(data, 0, sizeof(data));
93 eServiceReference(int type, int flags, int data0, int data1, int data2)
94 : type(type), flags(flags)
96 memset(data, 0, sizeof(data));
101 eServiceReference(int type, int flags, int data0, int data1, int data2, int data3)
102 : type(type), flags(flags)
104 memset(data, 0, sizeof(data));
110 eServiceReference(int type, int flags, int data0, int data1, int data2, int data3, int data4)
111 : type(type), flags(flags)
113 memset(data, 0, sizeof(data));
120 eServiceReference(int type, int flags, const std::string &path)
121 : type(type), flags(flags), path(path)
123 memset(data, 0, sizeof(data));
125 eServiceReference(const std::string &string);
126 std::string toString() const;
127 bool operator==(const eServiceReference &c) const
131 return (memcmp(data, c.data, sizeof(int)*8)==0) && (path == c.path);
133 bool operator!=(const eServiceReference &c) const
135 return !(*this == c);
137 bool operator<(const eServiceReference &c) const
145 int r=memcmp(data, c.data, sizeof(int)*8);
148 return path < c.path;
150 operator bool() const
157 return type != idInvalid;
161 SWIG_ALLOW_OUTPUT_SIMPLE(eServiceReference);
163 typedef long long pts_t;
165 /* the reason we have the servicereference as additional argument is
166 that we don't have to create one object for every entry in a possibly
167 large list, provided that no state information is nessesary to deliver
168 the required information. Anyway - ref *must* be the same as the argument
169 to the info() or getIServiceInformation call! */
171 /* About the usage of SWIG_VOID:
172 SWIG_VOID(real_returntype_t) hides a return value from swig. This is used for
173 the "superflouus" RESULT return values.
175 Python code has to check the returned pointer against 0. This works,
176 as all functions returning instances in smartpointers AND having a
177 RESULT have to BOTH return non-zero AND set the pointer to zero.
179 Python code thus can't check for the reason, but the reason isn't
180 user-servicable anyway. If you want to return a real reason which
181 goes beyong "it just doesn't work", use extra variables for this,
184 Hide the result only if there is another way to check for failure! */
186 class iStaticServiceInformation: public iObject
189 virtual SWIG_VOID(RESULT) getName(const eServiceReference &ref, std::string &SWIG_OUTPUT)=0;
191 // doesn't need to be implemented, should return -1 then.
192 virtual int getLength(const eServiceReference &ref);
193 virtual SWIG_VOID(RESULT) getEvent(const eServiceReference &ref, ePtr<eServiceEvent> &SWIG_OUTPUT, time_t start_time=0);
194 // returns true when not implemented
195 virtual bool isPlayable(const eServiceReference &ref, const eServiceReference &ignore);
197 virtual int getInfo(const eServiceReference &ref, int w);
198 virtual std::string getInfoString(const eServiceReference &ref,int w);
201 TEMPLATE_TYPEDEF(ePtr<iStaticServiceInformation>, iStaticServiceInformationPtr);
203 TEMPLATE_TYPEDEF(ePtr<eServiceEvent>, eServiceEventPtr);
205 class iServiceInformation: public iObject
208 virtual SWIG_VOID(RESULT) getName(std::string &SWIG_OUTPUT)=0;
209 virtual SWIG_VOID(RESULT) getEvent(ePtr<eServiceEvent> &SWIG_OUTPUT, int nownext);
212 sIsCrypted, /* is encrypted (no indication if decrypt was possible) */
213 sAspect, /* aspect ratio: 0=4:3, 1=16:9, 2=whatever we need */
214 sIsMultichannel, /* multichannel *available* (probably not selected) */
216 /* "user serviceable info" - they are not reliable. Don't use them for anything except the service menu!
217 that's also the reason why they are so globally defined.
220 again - if somebody EVER tries to use this information for anything else than simply displaying it,
221 i will change this to return a user-readable text like "zero x zero three three" (and change the
222 exact spelling in every version) to stop that!
237 sTimeCreate, // unix time or string
239 enum { resNA = -1, resIsString = -2 };
241 virtual int getInfo(int w);
242 virtual std::string getInfoString(int w);
245 TEMPLATE_TYPEDEF(ePtr<iServiceInformation>, iServiceInformationPtr);
247 class iFrontendStatusInformation: public iObject
255 virtual int getFrontendInfo(int w)=0;
258 TEMPLATE_TYPEDEF(ePtr<iFrontendStatusInformation>, iFrontendStatusInformationPtr);
260 class iPauseableService: public iObject
263 virtual RESULT pause()=0;
264 virtual RESULT unpause()=0;
267 virtual RESULT setSlowMotion(int ratio=0)=0;
268 virtual RESULT setFastForward(int ratio=0)=0;
271 TEMPLATE_TYPEDEF(ePtr<iPauseableService>, iPauseableServicePtr);
273 class iSeekableService: public iObject
276 virtual RESULT getLength(pts_t &SWIG_OUTPUT)=0;
277 virtual RESULT seekTo(pts_t to)=0;
278 enum { dirForward = +1, dirBackward = -1 };
279 virtual RESULT seekRelative(int direction, pts_t to)=0;
280 virtual RESULT getPlayPosition(pts_t &SWIG_OUTPUT)=0;
281 /* if you want to do several seeks in a row, you can enable the trickmode.
282 audio will be switched off, sync will be disabled etc. */
283 virtual RESULT setTrickmode(int trick=0)=0;
286 TEMPLATE_TYPEDEF(ePtr<iSeekableService>, iSeekableServicePtr);
288 struct iAudioTrackInfo
290 std::string m_description;
291 std::string m_language; /* iso639 */
293 std::string getDescription() { return m_description; }
294 std::string getLanguage() { return m_language; }
297 SWIG_ALLOW_OUTPUT_SIMPLE(iAudioTrackInfo);
299 class iAudioTrackSelection: public iObject
302 virtual int getNumberOfTracks()=0;
303 virtual RESULT selectTrack(unsigned int i)=0;
304 virtual SWIG_VOID(RESULT) getTrackInfo(struct iAudioTrackInfo &SWIG_OUTPUT, unsigned int n)=0;
307 TEMPLATE_TYPEDEF(ePtr<iAudioTrackSelection>, iAudioTrackSelectionPtr);
309 class iSubserviceList: public iObject
312 virtual int getNumberOfSubservices()=0;
313 virtual SWIG_VOID(RESULT) getSubservice(eServiceReference &SWIG_OUTPUT, unsigned int n)=0;
316 TEMPLATE_TYPEDEF(ePtr<iSubserviceList>, iSubserviceListPtr);
318 class iTimeshiftService: public iObject
321 virtual RESULT startTimeshift()=0;
322 virtual RESULT stopTimeshift()=0;
325 TEMPLATE_TYPEDEF(ePtr<iTimeshiftService>, iTimeshiftServicePtr);
327 class iPlayableService: public iObject
329 friend class iServiceHandler;
337 // when iServiceInformation is implemented:
341 virtual RESULT connectEvent(const Slot2<void,iPlayableService*,int> &event, ePtr<eConnection> &connection)=0;
342 virtual RESULT start()=0;
343 virtual RESULT stop()=0;
344 virtual SWIG_VOID(RESULT) seek(ePtr<iSeekableService> &SWIG_OUTPUT)=0;
345 virtual SWIG_VOID(RESULT) pause(ePtr<iPauseableService> &SWIG_OUTPUT)=0;
346 virtual SWIG_VOID(RESULT) info(ePtr<iServiceInformation> &SWIG_OUTPUT)=0;
347 virtual SWIG_VOID(RESULT) audioTracks(ePtr<iAudioTrackSelection> &SWIG_OUTPUT)=0;
348 virtual SWIG_VOID(RESULT) subServices(ePtr<iSubserviceList> &SWIG_OUTPUT)=0;
349 virtual SWIG_VOID(RESULT) frontendStatusInfo(ePtr<iFrontendStatusInformation> &SWIG_OUTPUT)=0;
350 virtual SWIG_VOID(RESULT) timeshift(ePtr<iTimeshiftService> &SWIG_OUTPUT)=0;
353 TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
355 class iRecordableService: public iObject
358 virtual RESULT prepare(const char *filename)=0;
359 virtual RESULT start()=0;
360 virtual RESULT stop()=0;
363 TEMPLATE_TYPEDEF(ePtr<iRecordableService>, iRecordableServicePtr);
365 // TEMPLATE_TYPEDEF(std::list<eServiceReference>, eServiceReferenceList);
367 class iMutableServiceList: public iObject
371 virtual RESULT flushChanges()=0;
372 /* adds a service to a list */
373 virtual RESULT addService(eServiceReference &ref)=0;
374 /* removes a service from a list */
375 virtual RESULT removeService(eServiceReference &ref)=0;
376 /* moves a service in a list, only if list suppports a specific sort method. */
377 /* pos is the new, absolute position from 0..size-1 */
378 virtual RESULT moveService(eServiceReference &ref, int pos)=0;
381 TEMPLATE_TYPEDEF(ePtr<iMutableServiceList>, iMutableServiceListPtr);
383 class iListableService: public iObject
386 /* legacy interface: get a list */
387 virtual RESULT getContent(std::list<eServiceReference> &list)=0;
389 /* new, shiny interface: streaming. */
390 virtual SWIG_VOID(RESULT) getNext(eServiceReference &SWIG_OUTPUT)=0;
392 /* use this for sorting. output is not sorted because of either
393 - performance reasons: the whole list must be buffered or
394 - the interface would be restricted to a list. streaming
395 (as well as a future "active" extension) won't be possible.
397 virtual int compareLessEqual(const eServiceReference &, const eServiceReference &)=0;
399 virtual SWIG_VOID(RESULT) startEdit(ePtr<iMutableServiceList> &SWIG_OUTPUT)=0;
402 TEMPLATE_TYPEDEF(ePtr<iListableService>, iListableServicePtr);
404 /* a helper class which can be used as argument to stl's sort(). */
405 class iListableServiceCompare
407 ePtr<iListableService> m_list;
409 iListableServiceCompare(iListableService *list): m_list(list) { }
410 bool operator()(const eServiceReference &a, const eServiceReference &b)
412 return m_list->compareLessEqual(a, b);
416 class iServiceOfflineOperations: public iObject
419 /* to delete a service, forever. */
420 virtual RESULT deleteFromDisk(int simulate=1)=0;
422 /* for transferring a service... */
423 virtual SWIG_VOID(RESULT) getListOfFilenames(std::list<std::string> &SWIG_OUTPUT)=0;
425 // TODO: additional stuff, like a conversion interface?
428 TEMPLATE_TYPEDEF(ePtr<iServiceOfflineOperations>, iServiceOfflineOperationsPtr);
430 class iServiceHandler: public iObject
433 virtual SWIG_VOID(RESULT) play(const eServiceReference &, ePtr<iPlayableService> &SWIG_OUTPUT)=0;
434 virtual SWIG_VOID(RESULT) record(const eServiceReference &, ePtr<iRecordableService> &SWIG_OUTPUT)=0;
435 virtual SWIG_VOID(RESULT) list(const eServiceReference &, ePtr<iListableService> &SWIG_OUTPUT)=0;
436 virtual SWIG_VOID(RESULT) info(const eServiceReference &, ePtr<iStaticServiceInformation> &SWIG_OUTPUT)=0;
437 virtual SWIG_VOID(RESULT) offlineOperations(const eServiceReference &, ePtr<iServiceOfflineOperations> &SWIG_OUTPUT)=0;
440 TEMPLATE_TYPEDEF(ePtr<iServiceHandler>, iServiceHandlerPtr);