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 // only for override service names in bouquets or to give servicerefs a name which not have a
51 // real existing service ( for dvb eServiceDVB )
53 std::string getName() { return name; }
56 : type(idInvalid), flags(0)
58 memset(data, 0, sizeof(data));
60 eServiceReference(int type, int flags)
61 : type(type), flags(flags)
63 memset(data, 0, sizeof(data));
65 eServiceReference(int type, int flags, int data0)
66 : type(type), flags(flags)
68 memset(data, 0, sizeof(data));
71 eServiceReference(int type, int flags, int data0, int data1)
72 : type(type), flags(flags)
74 memset(data, 0, sizeof(data));
78 eServiceReference(int type, int flags, int data0, int data1, int data2)
79 : type(type), flags(flags)
81 memset(data, 0, sizeof(data));
86 eServiceReference(int type, int flags, int data0, int data1, int data2, int data3)
87 : type(type), flags(flags)
89 memset(data, 0, sizeof(data));
95 eServiceReference(int type, int flags, int data0, int data1, int data2, int data3, int data4)
96 : type(type), flags(flags)
98 memset(data, 0, sizeof(data));
105 eServiceReference(int type, int flags, const std::string &path)
106 : type(type), flags(flags), path(path)
108 memset(data, 0, sizeof(data));
110 eServiceReference(const std::string &string);
111 std::string toString() const;
112 bool operator==(const eServiceReference &c) const
116 return (memcmp(data, c.data, sizeof(int)*8)==0) && (path == c.path);
118 bool operator!=(const eServiceReference &c) const
120 return !(*this == c);
122 bool operator<(const eServiceReference &c) const
130 int r=memcmp(data, c.data, sizeof(int)*8);
133 return path < c.path;
135 operator bool() const
142 return type != idInvalid;
146 SWIG_ALLOW_OUTPUT_SIMPLE(eServiceReference);
148 typedef long long pts_t;
150 /* the reason we have the servicereference as additional argument is
151 that we don't have to create one object for every entry in a possibly
152 large list, provided that no state information is nessesary to deliver
153 the required information. Anyway - ref *must* be the same as the argument
154 to the info() or getIServiceInformation call! */
156 /* About the usage of SWIG_VOID:
157 SWIG_VOID(real_returntype_t) hides a return value from swig. This is used for
158 the "superflouus" RESULT return values.
160 Python code has to check the returned pointer against 0. This works,
161 as all functions returning instances in smartpointers AND having a
162 RESULT have to BOTH return non-zero AND set the pointer to zero.
164 Python code thus can't check for the reason, but the reason isn't
165 user-servicable anyway. If you want to return a real reason which
166 goes beyong "it just doesn't work", use extra variables for this,
169 Hide the result only if there is another way to check for failure! */
171 class iStaticServiceInformation: public iObject
174 virtual SWIG_VOID(RESULT) getName(const eServiceReference &ref, std::string &SWIG_OUTPUT)=0;
176 // doesn't need to be implemented, should return -1 then.
177 virtual int getLength(const eServiceReference &ref);
178 virtual SWIG_VOID(RESULT) getEvent(const eServiceReference &ref, ePtr<eServiceEvent> &SWIG_OUTPUT);
179 // returns true when not implemented
180 virtual bool isPlayable(const eServiceReference &ref, const eServiceReference &ignore);
183 TEMPLATE_TYPEDEF(ePtr<iStaticServiceInformation>, iStaticServiceInformationPtr);
185 TEMPLATE_TYPEDEF(ePtr<eServiceEvent>, eServiceEventPtr);
187 class iServiceInformation: public iObject
190 virtual SWIG_VOID(RESULT) getName(std::string &SWIG_OUTPUT)=0;
191 virtual SWIG_VOID(RESULT) getEvent(ePtr<eServiceEvent> &SWIG_OUTPUT, int nownext);
194 sIsCrypted, /* is encrypted (no indication if decrypt was possible) */
195 sAspect, /* aspect ratio: 0=4:3, 1=16:9, 2=whatever we need */
196 sIsMultichannel, /* multichannel *available* (probably not selected) */
198 /* "user serviceable info" - they are not reliable. Don't use them for anything except the service menu!
199 that's also the reason why they are so globally defined.
202 again - if somebody EVER tries to use this information for anything else than simply displaying it,
203 i will change this to return a user-readable text like "zero x zero three three" (and change the
204 exact spelling in every version) to stop that!
218 enum { resNA = -1, resIsString = -2 };
220 virtual int getInfo(int w);
221 virtual std::string getInfoString(int w);
224 TEMPLATE_TYPEDEF(ePtr<iServiceInformation>, iServiceInformationPtr);
226 class iFrontendStatusInformation: public iObject
234 virtual int getFrontendInfo(int w)=0;
237 TEMPLATE_TYPEDEF(ePtr<iFrontendStatusInformation>, iFrontendStatusInformationPtr);
239 class iPauseableService: public iObject
242 virtual RESULT pause()=0;
243 virtual RESULT unpause()=0;
246 TEMPLATE_TYPEDEF(ePtr<iPauseableService>, iPauseableServicePtr);
248 class iSeekableService: public iObject
251 virtual RESULT getLength(pts_t &SWIG_OUTPUT)=0;
252 virtual RESULT seekTo(pts_t to)=0;
253 enum { dirForward = +1, dirBackward = -1 };
254 virtual RESULT seekRelative(int direction, pts_t to)=0;
255 virtual RESULT getPlayPosition(pts_t &SWIG_OUTPUT)=0;
258 TEMPLATE_TYPEDEF(ePtr<iSeekableService>, iSeekableServicePtr);
260 struct iAudioTrackInfo
262 std::string m_description;
263 std::string m_language; /* iso639 */
265 std::string getDescription() { return m_description; }
266 std::string getLanguage() { return m_language; }
269 SWIG_ALLOW_OUTPUT_SIMPLE(iAudioTrackInfo);
271 class iAudioTrackSelection: public iObject
274 virtual int getNumberOfTracks()=0;
275 virtual RESULT selectTrack(unsigned int i)=0;
276 virtual SWIG_VOID(RESULT) getTrackInfo(struct iAudioTrackInfo &SWIG_OUTPUT, unsigned int n)=0;
279 TEMPLATE_TYPEDEF(ePtr<iAudioTrackSelection>, iAudioTrackSelectionPtr);
281 class iSubserviceList: public iObject
284 virtual int getNumberOfSubservices()=0;
285 virtual SWIG_VOID(RESULT) getSubservice(eServiceReference &SWIG_OUTPUT, unsigned int n)=0;
288 TEMPLATE_TYPEDEF(ePtr<iSubserviceList>, iSubserviceListPtr);
290 class iPlayableService: public iObject
292 friend class iServiceHandler;
300 // when iServiceInformation is implemented:
304 virtual RESULT connectEvent(const Slot2<void,iPlayableService*,int> &event, ePtr<eConnection> &connection)=0;
305 virtual RESULT start()=0;
306 virtual RESULT stop()=0;
307 virtual SWIG_VOID(RESULT) seek(ePtr<iSeekableService> &SWIG_OUTPUT)=0;
308 virtual SWIG_VOID(RESULT) pause(ePtr<iPauseableService> &SWIG_OUTPUT)=0;
309 virtual SWIG_VOID(RESULT) info(ePtr<iServiceInformation> &SWIG_OUTPUT)=0;
310 virtual SWIG_VOID(RESULT) audioTracks(ePtr<iAudioTrackSelection> &SWIG_OUTPUT)=0;
311 virtual SWIG_VOID(RESULT) subServices(ePtr<iSubserviceList> &SWIG_OUTPUT)=0;
312 virtual SWIG_VOID(RESULT) frontendStatusInfo(ePtr<iFrontendStatusInformation> &SWIG_OUTPUT)=0;
315 TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
317 class iRecordableService: public iObject
320 virtual RESULT prepare(const char *filename)=0;
321 virtual RESULT start()=0;
322 virtual RESULT stop()=0;
325 TEMPLATE_TYPEDEF(ePtr<iRecordableService>, iRecordableServicePtr);
327 // TEMPLATE_TYPEDEF(std::list<eServiceReference>, eServiceReferenceList);
329 class iMutableServiceList: public iObject
333 virtual RESULT flushChanges()=0;
334 /* adds a service to a list */
335 virtual RESULT addService(eServiceReference &ref)=0;
336 /* removes a service from a list */
337 virtual RESULT removeService(eServiceReference &ref)=0;
338 /* moves a service in a list, only if list suppports a specific sort method. */
339 /* pos is the new, absolute position from 0..size-1 */
340 virtual RESULT moveService(eServiceReference &ref, int pos)=0;
343 TEMPLATE_TYPEDEF(ePtr<iMutableServiceList>, iMutableServiceListPtr);
345 class iListableService: public iObject
348 /* legacy interface: get a list */
349 virtual RESULT getContent(std::list<eServiceReference> &list)=0;
351 /* new, shiny interface: streaming. */
352 virtual SWIG_VOID(RESULT) getNext(eServiceReference &SWIG_OUTPUT)=0;
354 /* use this for sorting. output is not sorted because of either
355 - performance reasons: the whole list must be buffered or
356 - the interface would be restricted to a list. streaming
357 (as well as a future "active" extension) won't be possible.
359 virtual int compareLessEqual(const eServiceReference &, const eServiceReference &)=0;
361 virtual SWIG_VOID(RESULT) startEdit(ePtr<iMutableServiceList> &SWIG_OUTPUT)=0;
364 TEMPLATE_TYPEDEF(ePtr<iListableService>, iListableServicePtr);
366 /* a helper class which can be used as argument to stl's sort(). */
367 class iListableServiceCompare
369 ePtr<iListableService> m_list;
371 iListableServiceCompare(iListableService *list): m_list(list) { }
372 bool operator()(const eServiceReference &a, const eServiceReference &b)
374 return m_list->compareLessEqual(a, b);
378 class iServiceOfflineOperations: public iObject
381 /* to delete a service, forever. */
382 virtual RESULT deleteFromDisk(int simulate=1)=0;
384 /* for transferring a service... */
385 virtual SWIG_VOID(RESULT) getListOfFilenames(std::list<std::string> &SWIG_OUTPUT)=0;
387 // TODO: additional stuff, like a conversion interface?
390 TEMPLATE_TYPEDEF(ePtr<iServiceOfflineOperations>, iServiceOfflineOperationsPtr);
392 class iServiceHandler: public iObject
395 virtual SWIG_VOID(RESULT) play(const eServiceReference &, ePtr<iPlayableService> &SWIG_OUTPUT)=0;
396 virtual SWIG_VOID(RESULT) record(const eServiceReference &, ePtr<iRecordableService> &SWIG_OUTPUT)=0;
397 virtual SWIG_VOID(RESULT) list(const eServiceReference &, ePtr<iListableService> &SWIG_OUTPUT)=0;
398 virtual SWIG_VOID(RESULT) info(const eServiceReference &, ePtr<iStaticServiceInformation> &SWIG_OUTPUT)=0;
399 virtual SWIG_VOID(RESULT) offlineOperations(const eServiceReference &, ePtr<iServiceOfflineOperations> &SWIG_OUTPUT)=0;
402 TEMPLATE_TYPEDEF(ePtr<iServiceHandler>, iServiceHandlerPtr);