1 #ifndef __lib_dvb_iservice_h
2 #define __lib_dvb_iservice_h
4 #include <lib/python/swig.h>
5 #include <lib/base/object.h>
6 #include <lib/service/event.h>
8 #include <connection.h>
11 class eServiceReference
17 idStructure, // service_id == 0 is root
24 int flags; // flags will NOT be compared.
27 isDirectory=1, // SHOULD enter (implies mustDescent)
28 mustDescent=2, // cannot be played directly - often used with "isDirectory" (implies canDescent)
31 normal services have none of them - they can be fed directly into the "play"-handler.
32 normal directories have both of them set - you cannot play a directory directly and the UI should descent into it.
33 playlists have "mustDescent", but not "isDirectory" - you don't want the user to browse inside the playlist (unless he really wants)
34 services with sub-services have none of them, instead the have the "canDecsent" flag (as all of the above)
36 canDescent=4, // supports enterDirectory/leaveDirectory
37 flagDirectory=isDirectory|mustDescent|canDescent,
38 shouldSort=8, // should be ASCII-sorted according to service_name. great for directories.
39 hasSortKey=16, // has a sort key in data[3]. not having a sort key implies 0.
40 sort1=32 // sort key is 1 instead of 0
43 inline int getSortKey() const { return (flags & hasSortKey) ? data[3] : ((flags & sort1) ? 1 : 0); }
47 std::string getPath() { return path; }
49 // only for override service names in bouquets or to give servicerefs a name which not have a
50 // real existing service ( for dvb eServiceDVB )
52 std::string getName() { return name; }
55 : type(idInvalid), flags(0)
59 eServiceReference(int type, int flags)
60 : type(type), flags(flags)
62 memset(data, 0, sizeof(data));
64 eServiceReference(int type, int flags, int data0)
65 : type(type), flags(flags)
67 memset(data, 0, sizeof(data));
70 eServiceReference(int type, int flags, int data0, int data1)
71 : type(type), flags(flags)
73 memset(data, 0, sizeof(data));
77 eServiceReference(int type, int flags, int data0, int data1, int data2)
78 : type(type), flags(flags)
80 memset(data, 0, sizeof(data));
85 eServiceReference(int type, int flags, int data0, int data1, int data2, int data3)
86 : type(type), flags(flags)
88 memset(data, 0, sizeof(data));
94 eServiceReference(int type, int flags, int data0, int data1, int data2, int data3, int data4)
95 : type(type), flags(flags)
97 memset(data, 0, sizeof(data));
104 eServiceReference(int type, int flags, const std::string &path)
105 : type(type), flags(flags), path(path)
107 memset(data, 0, sizeof(data));
109 eServiceReference(const std::string &string);
110 std::string toString() const;
111 bool operator==(const eServiceReference &c) const
115 return (memcmp(data, c.data, sizeof(int)*8)==0) && (path == c.path);
117 bool operator!=(const eServiceReference &c) const
119 return !(*this == c);
121 bool operator<(const eServiceReference &c) const
129 int r=memcmp(data, c.data, sizeof(int)*8);
132 return path < c.path;
134 operator bool() const
141 return type != idInvalid;
145 SWIG_ALLOW_OUTPUT_SIMPLE(eServiceReference);
147 typedef long long pts_t;
149 /* the reason we have the servicereference as additional argument is
150 that we don't have to create one object for every entry in a possibly
151 large list, provided that no state information is nessesary to deliver
152 the required information. Anyway - ref *must* be the same as the argument
153 to the info() or getIServiceInformation call! */
155 /* About the usage of SWIG_VOID:
156 SWIG_VOID(real_returntype_t) hides a return value from swig. This is used for
157 the "superflouus" RESULT return values.
159 Python code has to check the returned pointer against 0. This works,
160 as all functions returning instances in smartpointers AND having a
161 RESULT have to BOTH return non-zero AND set the pointer to zero.
163 Python code thus can't check for the reason, but the reason isn't
164 user-servicable anyway. If you want to return a real reason which
165 goes beyong "it just doesn't work", use extra variables for this,
168 Hide the result only if there is another way to check for failure! */
170 class iStaticServiceInformation: public iObject
173 virtual SWIG_VOID(RESULT) getName(const eServiceReference &ref, std::string &SWIG_OUTPUT)=0;
175 // doesn't need to be implemented, should return -1 then.
176 virtual int getLength(const eServiceReference &ref);
177 virtual SWIG_VOID(RESULT) getEvent(const eServiceReference &ref, ePtr<eServiceEvent> &SWIG_OUTPUT);
178 // returns true when not implemented
179 virtual bool isPlayable(const eServiceReference &ref, const eServiceReference &ignore);
182 TEMPLATE_TYPEDEF(ePtr<iStaticServiceInformation>, iStaticServiceInformationPtr);
186 TEMPLATE_TYPEDEF(ePtr<eServiceEvent>, eServiceEventPtr);
188 class iServiceInformation: public iObject
191 virtual SWIG_VOID(RESULT) getName(std::string &SWIG_OUTPUT)=0;
192 virtual SWIG_VOID(RESULT) getEvent(ePtr<eServiceEvent> &SWIG_OUTPUT, int nownext);
195 sIsCrypted, /* is encrypted (no indication if decrypt was possible) */
196 sAspect, /* aspect ratio: 0=4:3, 1=16:9, 2=whatever we need */
197 sIsMultichannel, /* multichannel *available* (probably not selected) */
199 /* "user serviceable info" - they are not reliable. Don't use them for anything except the service menu!
200 that's also the reason why they are so globally defined.
203 again - if somebody EVER tries to use this information for anything else than simply displaying it,
204 i will change this to return a user-readable text like "zero x zero three three" (and change the
205 exact spelling in every version) to stop that!
219 enum { resNA = -1, resIsString = -2 };
221 virtual int getInfo(int w);
222 virtual std::string getInfoString(int w);
225 TEMPLATE_TYPEDEF(ePtr<iServiceInformation>, iServiceInformationPtr);
227 class iPauseableService: public iObject
230 virtual RESULT pause()=0;
231 virtual RESULT unpause()=0;
234 TEMPLATE_TYPEDEF(ePtr<iPauseableService>, iPauseableServicePtr);
236 class iSeekableService: public iObject
239 virtual RESULT getLength(pts_t &SWIG_OUTPUT)=0;
240 virtual RESULT seekTo(pts_t to)=0;
241 enum { dirForward = +1, dirBackward = -1 };
242 virtual RESULT seekRelative(int direction, pts_t to)=0;
243 virtual RESULT getPlayPosition(pts_t &SWIG_OUTPUT)=0;
246 TEMPLATE_TYPEDEF(ePtr<iSeekableService>, iSeekableServicePtr);
248 struct iAudioTrackInfo
250 std::string m_description;
251 std::string m_language; /* iso639 */
253 std::string getDescription() { return m_description; }
254 std::string getLanguage() { return m_language; }
257 SWIG_ALLOW_OUTPUT_SIMPLE(iAudioTrackInfo);
259 class iAudioTrackSelection: public iObject
262 virtual int getNumberOfTracks()=0;
263 virtual RESULT selectTrack(unsigned int i)=0;
264 virtual SWIG_VOID(RESULT) getTrackInfo(struct iAudioTrackInfo &SWIG_OUTPUT, unsigned int n)=0;
267 TEMPLATE_TYPEDEF(ePtr<iAudioTrackSelection>, iAudioTrackSelectionPtr);
269 class iPlayableService: public iObject
271 friend class iServiceHandler;
279 // when iServiceInformation is implemented:
283 virtual RESULT connectEvent(const Slot2<void,iPlayableService*,int> &event, ePtr<eConnection> &connection)=0;
284 virtual RESULT start()=0;
285 virtual RESULT stop()=0;
286 virtual SWIG_VOID(RESULT) seek(ePtr<iSeekableService> &SWIG_OUTPUT)=0;
287 virtual SWIG_VOID(RESULT) pause(ePtr<iPauseableService> &SWIG_OUTPUT)=0;
288 virtual SWIG_VOID(RESULT) info(ePtr<iServiceInformation> &SWIG_OUTPUT)=0;
289 virtual SWIG_VOID(RESULT) audioTracks(ePtr<iAudioTrackSelection> &SWIG_OUTPUT)=0;
292 TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
294 class iRecordableService: public iObject
297 virtual RESULT prepare(const char *filename)=0;
298 virtual RESULT start()=0;
299 virtual RESULT stop()=0;
302 TEMPLATE_TYPEDEF(ePtr<iRecordableService>, iRecordableServicePtr);
304 // TEMPLATE_TYPEDEF(std::list<eServiceReference>, eServiceReferenceList);
306 class iMutableServiceList: public iObject
310 virtual RESULT flushChanges()=0;
311 /* adds a service to a list */
312 virtual RESULT addService(eServiceReference &ref)=0;
313 /* removes a service from a list */
314 virtual RESULT removeService(eServiceReference &ref)=0;
315 /* moves a service in a list, only if list suppports a specific sort method. */
316 /* pos is the new, absolute position from 0..size-1 */
317 virtual RESULT moveService(eServiceReference &ref, int pos)=0;
320 TEMPLATE_TYPEDEF(ePtr<iMutableServiceList>, iMutableServiceListPtr);
322 class iListableService: public iObject
325 /* legacy interface: get a list */
326 virtual RESULT getContent(std::list<eServiceReference> &list)=0;
328 /* new, shiny interface: streaming. */
329 virtual SWIG_VOID(RESULT) getNext(eServiceReference &SWIG_OUTPUT)=0;
331 /* use this for sorting. output is not sorted because of either
332 - performance reasons: the whole list must be buffered or
333 - the interface would be restricted to a list. streaming
334 (as well as a future "active" extension) won't be possible.
336 virtual int compareLessEqual(const eServiceReference &, const eServiceReference &)=0;
338 virtual SWIG_VOID(RESULT) startEdit(ePtr<iMutableServiceList> &SWIG_OUTPUT)=0;
341 TEMPLATE_TYPEDEF(ePtr<iListableService>, iListableServicePtr);
343 /* a helper class which can be used as argument to stl's sort(). */
344 class iListableServiceCompare
346 ePtr<iListableService> m_list;
348 iListableServiceCompare(iListableService *list): m_list(list) { }
349 bool operator()(const eServiceReference &a, const eServiceReference &b)
351 return m_list->compareLessEqual(a, b);
355 class iServiceOfflineOperations: public iObject
358 /* to delete a service, forever. */
359 virtual RESULT deleteFromDisk(int simulate=1)=0;
361 /* for transferring a service... */
362 virtual SWIG_VOID(RESULT) getListOfFilenames(std::list<std::string> &SWIG_OUTPUT)=0;
364 // TODO: additional stuff, like a conversion interface?
367 TEMPLATE_TYPEDEF(ePtr<iServiceOfflineOperations>, iServiceOfflineOperationsPtr);
369 class iServiceHandler: public iObject
372 virtual SWIG_VOID(RESULT) play(const eServiceReference &, ePtr<iPlayableService> &SWIG_OUTPUT)=0;
373 virtual SWIG_VOID(RESULT) record(const eServiceReference &, ePtr<iRecordableService> &SWIG_OUTPUT)=0;
374 virtual SWIG_VOID(RESULT) list(const eServiceReference &, ePtr<iListableService> &SWIG_OUTPUT)=0;
375 virtual SWIG_VOID(RESULT) info(const eServiceReference &, ePtr<iStaticServiceInformation> &SWIG_OUTPUT)=0;
376 virtual SWIG_VOID(RESULT) offlineOperations(const eServiceReference &, ePtr<iServiceOfflineOperations> &SWIG_OUTPUT)=0;
379 TEMPLATE_TYPEDEF(ePtr<iServiceHandler>, iServiceHandlerPtr);