fix convertDVBUTF8 default table (0 is now iso6397 but we want iso8859-1)
[enigma2.git] / lib / service / iservice.h
1 #ifndef __lib_dvb_iservice_h
2 #define __lib_dvb_iservice_h
3
4 #include <lib/python/swig.h>
5 #include <lib/python/python.h>
6 #include <lib/base/object.h>
7 #include <string>
8 #include <connection.h>
9 #include <list>
10
11 class eServiceEvent;
12
13 class eServiceReference
14 {
15 public:
16         enum
17         {
18                 idInvalid=-1,
19                 idStructure,    // service_id == 0 is root
20                 idDVB,
21                 idFile,
22                 idUser=0x1000
23         };
24         int type;
25
26         enum
27         {
28                 isDirectory=1,          // SHOULD enter  (implies mustDescent)
29                 mustDescent=2,          // cannot be played directly - often used with "isDirectory" (implies canDescent)
30                 /*
31                         for example:
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)
36                 */
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
42                 isMarker=64,                    // Marker
43                 isGroup=128                     // is a group of services
44         };
45         int flags; // flags will NOT be compared.
46
47         inline int getSortKey() const { return (flags & hasSortKey) ? data[3] : ((flags & sort1) ? 1 : 0); }
48
49 #ifndef SWIG
50         int data[8];
51         std::string path;
52 #endif
53         std::string getPath() { return path; }
54         void setPath( const std::string &n ) { path=n; }
55
56         unsigned int getUnsignedData(unsigned int num) const
57         {
58                 if ( num < sizeof(data)/sizeof(int) )
59                         return data[num];
60                 return 0;
61         }
62
63         int getData(unsigned int num) const
64         {
65                 if ( num < sizeof(data)/sizeof(int) )
66                         return data[num];
67                 return 0;
68         }
69
70         void setUnsignedData(unsigned int num, unsigned int val)
71         {
72                 if ( num < sizeof(data)/sizeof(int) )
73                         data[num] = val;
74         }
75
76         void setData(unsigned int num, int val)
77         {
78                 if ( num < sizeof(data)/sizeof(int) )
79                         data[num] = val;
80         }
81
82 // only for override service names in bouquets or to give servicerefs a name which not have a
83 // real existing service ( for dvb eServiceDVB )
84 #ifndef SWIG
85         std::string name;
86 #endif
87         std::string getName() const { return name; }
88         void setName( const std::string &n ) { name=n; }
89
90         eServiceReference()
91                 : type(idInvalid), flags(0)
92         {
93                 memset(data, 0, sizeof(data));
94         }
95 #ifndef SWIG
96         eServiceReference(int type, int flags)
97                 : type(type), flags(flags)
98         {
99                 memset(data, 0, sizeof(data));
100         }
101         eServiceReference(int type, int flags, int data0)
102                 : type(type), flags(flags)
103         {
104                 memset(data, 0, sizeof(data));
105                 data[0]=data0;
106         }
107         eServiceReference(int type, int flags, int data0, int data1)
108                 : type(type), flags(flags)
109         {
110                 memset(data, 0, sizeof(data));
111                 data[0]=data0;
112                 data[1]=data1;
113         }
114         eServiceReference(int type, int flags, int data0, int data1, int data2)
115                 : type(type), flags(flags)
116         {
117                 memset(data, 0, sizeof(data));
118                 data[0]=data0;
119                 data[1]=data1;
120                 data[2]=data2;
121         }
122         eServiceReference(int type, int flags, int data0, int data1, int data2, int data3)
123                 : type(type), flags(flags)
124         {
125                 memset(data, 0, sizeof(data));
126                 data[0]=data0;
127                 data[1]=data1;
128                 data[2]=data2;
129                 data[3]=data3;
130         }
131         eServiceReference(int type, int flags, int data0, int data1, int data2, int data3, int data4)
132                 : type(type), flags(flags)
133         {
134                 memset(data, 0, sizeof(data));
135                 data[0]=data0;
136                 data[1]=data1;
137                 data[2]=data2;
138                 data[3]=data3;
139                 data[4]=data4;
140         }
141         operator bool() const
142         {
143                 return valid();
144         }
145 #endif
146         eServiceReference(int type, int flags, const std::string &path)
147                 : type(type), flags(flags), path(path)
148         {
149                 memset(data, 0, sizeof(data));
150         }
151         eServiceReference(const std::string &string);
152         std::string toString() const;
153         std::string toCompareString() const;
154         bool operator==(const eServiceReference &c) const
155         {
156                 if (type != c.type)
157                         return 0;
158                 return (memcmp(data, c.data, sizeof(int)*8)==0) && (path == c.path);
159         }
160         bool operator!=(const eServiceReference &c) const
161         {
162                 return !(*this == c);
163         }
164         bool operator<(const eServiceReference &c) const
165         {
166                 if (type < c.type)
167                         return 1;
168
169                 if (type > c.type)
170                         return 0;
171
172                 int r=memcmp(data, c.data, sizeof(int)*8);
173                 if (r)
174                         return r < 0;
175                 return path < c.path;
176         }
177         
178         int valid() const
179         {
180                 return type != idInvalid;
181         }
182 };
183
184 SWIG_ALLOW_OUTPUT_SIMPLE(eServiceReference);
185
186 extern PyObject *New_eServiceReference(const eServiceReference &ref); // defined in enigma_python.i
187
188 #ifndef SWIG
189 #ifdef PYTHON_REFCOUNT_DEBUG
190 inline ePyObject Impl_New_eServiceReference(const char* file, int line, const eServiceReference &ref)
191 {
192         return ePyObject(New_eServiceReference(ref), file, line);
193 }
194 #define NEW_eServiceReference(ref) Impl_New_eServiceReference(__FILE__, __LINE__, ref)
195 #else
196 inline ePyObject Impl_New_eServiceReference(const eServiceReference &ref)
197 {
198         return New_eServiceReference(ref);
199 }
200 #define NEW_eServiceReference(ref) Impl_New_eServiceReference(ref)
201 #endif
202 #endif // SWIG
203
204 typedef long long pts_t;
205
206         /* the reason we have the servicereference as additional argument is
207            that we don't have to create one object for every entry in a possibly
208            large list, provided that no state information is nessesary to deliver
209            the required information. Anyway - ref *must* be the same as the argument
210            to the info() or getIServiceInformation call! */
211
212         /* About the usage of SWIG_VOID:
213            SWIG_VOID(real_returntype_t) hides a return value from swig. This is used for
214            the "superflouus" RESULT return values.
215            
216            Python code has to check the returned pointer against 0. This works,
217            as all functions returning instances in smartpointers AND having a 
218            RESULT have to BOTH return non-zero AND set the pointer to zero.
219            
220            Python code thus can't check for the reason, but the reason isn't
221            user-servicable anyway. If you want to return a real reason which
222            goes beyong "it just doesn't work", use extra variables for this,
223            not the RESULT.
224            
225            Hide the result only if there is another way to check for failure! */
226            
227 class eServiceEvent;
228
229 SWIG_IGNORE(iStaticServiceInformation);
230 class iStaticServiceInformation: public iObject
231 {
232 #ifdef SWIG
233         iStaticServiceInformation();
234         ~iStaticServiceInformation();
235 #endif
236 public:
237         virtual SWIG_VOID(RESULT) getName(const eServiceReference &ref, std::string &SWIG_OUTPUT)=0;
238
239                 // doesn't need to be implemented, should return -1 then.
240         virtual int getLength(const eServiceReference &ref);
241         virtual SWIG_VOID(RESULT) getEvent(const eServiceReference &ref, ePtr<eServiceEvent> &SWIG_OUTPUT, time_t start_time=-1);
242                 // returns true when not implemented
243         virtual int isPlayable(const eServiceReference &ref, const eServiceReference &ignore, bool simulate=false);
244
245         virtual int getInfo(const eServiceReference &ref, int w);
246         virtual std::string getInfoString(const eServiceReference &ref,int w);
247         virtual PyObject *getInfoObject(const eServiceReference &ref, int w);
248
249         virtual int setInfo(const eServiceReference &ref, int w, int v);
250         virtual int setInfoString(const eServiceReference &ref, int w, const char *v);
251 };
252 SWIG_TEMPLATE_TYPEDEF(ePtr<iStaticServiceInformation>, iStaticServiceInformationPtr);
253
254 class iServiceInformation_ENUMS
255 {
256 #ifdef SWIG
257         iServiceInformation_ENUMS();
258         ~iServiceInformation_ENUMS();
259 #endif
260 public:
261         enum {
262                 sIsCrypted,             /* is encrypted (no indication if decrypt was possible) */
263                 sAspect,                /* aspect ratio: 0=4:3, 1=16:9, 2=whatever we need */
264                 sFrameRate,                     /* frame rate */
265                 sProgressive,           /* 0 = interlaced, 1 = progressive */
266                 sIsMultichannel,        /* multichannel *available* (probably not selected) */
267
268                         /* "user serviceable info" - they are not reliable. Don't use them for anything except the service menu!
269                            that's also the reason why they are so globally defined.
270                            again - if somebody EVER tries to use this information for anything else than simply displaying it,
271                            i will change this to return a user-readable text like "zero x zero three three" (and change the
272                            exact spelling in every version) to stop that! */
273
274                 sVideoPID,
275                 sAudioPID,
276                 sPCRPID,
277                 sPMTPID,
278                 sTXTPID,
279
280                 sSID,
281                 sONID,
282                 sTSID,
283                 sNamespace,
284                 sProvider,
285
286                 sDescription,
287                 sServiceref,
288                 sTimeCreate,            /* unix time or string */
289                 sFileSize,
290
291                 sCAIDs,
292                 sVideoType,             /* MPEG2 MPEG4 */
293
294                 sTags,                          /* space seperated list of tags */
295
296                 sDVBState,                      /* states as defined in pmt handler (as events there) */
297
298                 sVideoHeight,
299                 sVideoWidth,
300
301                 sTransponderData,       /* transponderdata as python dict */
302
303                 sCurrentChapter,
304                 sCurrentTitle,
305                 sTotalChapters,
306                 sTotalTitles,
307
308                 sTagTitle,
309                 sTagTitleSortname,
310                 sTagArtist,
311                 sTagArtistSortname,
312                 sTagAlbum,
313                 sTagAlbumSortname,
314                 sTagComposer,
315                 sTagDate,
316                 sTagGenre,
317                 sTagComment,
318                 sTagExtendedComment,
319                 sTagTrackNumber,
320                 sTagTrackCount,
321                 sTagAlbumVolumeNumber,
322                 sTagAlbumVolumeCount,
323                 sTagLocation,
324                 sTagHomepage,
325                 sTagDescription,
326                 sTagVersion,
327                 sTagISRC,
328                 sTagOrganization,
329                 sTagCopyright,
330                 sTagCopyrightURI,
331                 sTagContact,
332                 sTagLicense,
333                 sTagLicenseURI,
334                 sTagPerformer,
335                 sTagCodec,
336                 sTagVideoCodec,
337                 sTagAudioCodec,
338                 sTagBitrate,
339                 sTagNominalBitrate,
340                 sTagMinimumBitrate,
341                 sTagMaximumBitrate,
342                 sTagSerial,
343                 sTagEncoder,
344                 sTagEncoderVersion,
345                 sTagTrackGain,
346                 sTagTrackPeak,
347                 sTagAlbumGain,
348                 sTagAlbumPeak,
349                 sTagReferenceLevel,
350                 sTagLanguageCode,
351                 sTagImage,
352                 sTagPreviewImage,
353                 sTagAttachment,
354                 sTagBeatsPerMinute,
355                 sTagKeywords,
356                 sTagCRC,
357                 sTagChannelMode,
358
359                 sUser = 0x100
360         };
361         enum {
362                 resNA = -1,
363                 resIsString = -2,
364                 resIsPyObject = -3
365         };
366 };
367
368 /* some words to structs like struct iServiceInformation_ENUMS
369 For some classes we need in python just the SmartPointer Variants.
370 So we prevent building wrapper classes for the non smart pointer classes with the SWIG_IGNORE makro.
371 But now we have the problem that swig do not export enums for smart pointer classes (i dont know why).
372 So we move all enum's to own classes (with _ENUMS as name ending) and let our real
373 class inherit from the *_ENUMS class. This *_ENUMS classes are normally exportet via swig to python.
374 But in the python code we doesn't like to write iServiceInformation_ENUMS.sVideoType....
375 we like to write iServiceInformation.sVideoType.
376 So until swig have no Solution for this Problem we call in lib/python/Makefile.am a python script named
377 enigma_py_patcher.py to remove the "_ENUMS" strings in enigma.py at all needed locations. */
378
379 SWIG_IGNORE(iServiceInformation);
380 class iServiceInformation: public iServiceInformation_ENUMS, public iObject
381 {
382 #ifdef SWIG
383         iServiceInformation();
384         ~iServiceInformation();
385 #endif
386 public:
387         virtual SWIG_VOID(RESULT) getName(std::string &SWIG_OUTPUT)=0;
388         virtual SWIG_VOID(RESULT) getEvent(ePtr<eServiceEvent> &SWIG_OUTPUT, int nownext);
389
390         virtual int getInfo(int w);
391         virtual std::string getInfoString(int w);
392         virtual PyObject *getInfoObject(int w);
393
394         virtual int setInfo(int w, int v);
395         virtual int setInfoString(int w, const char *v);
396 };
397 SWIG_TEMPLATE_TYPEDEF(ePtr<iServiceInformation>, iServiceInformationPtr);
398
399 class iFrontendInformation_ENUMS
400 {
401 #ifdef SWIG
402         iFrontendInformation_ENUMS();
403         ~iFrontendInformation_ENUMS();
404 #endif
405 public:
406         enum {
407                 bitErrorRate,
408                 signalPower,
409                 signalQuality,
410                 lockState,
411                 syncState,
412                 frontendNumber,
413                 signalQualitydB,
414         };
415 };
416
417 SWIG_IGNORE(iFrontendInformation);
418 class iFrontendInformation: public iFrontendInformation_ENUMS, public iObject
419 {
420 #ifdef SWIG
421         iFrontendInformation();
422         ~iFrontendInformation();
423 #endif
424 public:
425         virtual int getFrontendInfo(int w)=0;
426         virtual PyObject *getFrontendData()=0;
427         virtual PyObject *getFrontendStatus()=0;
428         virtual PyObject *getTransponderData(bool original)=0;
429         virtual PyObject *getAll(bool original)=0; // a sum of getFrontendData/Status/TransponderData
430 };
431 SWIG_TEMPLATE_TYPEDEF(ePtr<iFrontendInformation>, iFrontendInformationPtr);
432
433 SWIG_IGNORE(iPauseableService);
434 class iPauseableService: public iObject
435 {
436 #ifdef SWIG
437         iPausableService();
438         ~iPausableService();
439 #endif
440 public:
441
442                 /* this will set the *state* directly. So just call a SINGLE function of those at a time. */
443         virtual RESULT pause()=0;
444         virtual RESULT unpause()=0;
445
446                 /* hm. */
447         virtual RESULT setSlowMotion(int ratio=0)=0;
448         virtual RESULT setFastForward(int ratio=0)=0;
449 };
450 SWIG_TEMPLATE_TYPEDEF(ePtr<iPauseableService>, iPauseableServicePtr);
451
452 class iSeekableService_ENUMS
453 {
454 #ifdef SWIG
455         iSeekableService_ENUMS();
456         ~iSeekableService_ENUMS();
457 #endif
458 public:
459         enum { dirForward = +1, dirBackward = -1 };
460 };
461
462 SWIG_IGNORE(iSeekableService);
463 class iSeekableService: public iSeekableService_ENUMS, public iObject
464 {
465 #ifdef SWIG
466         iSeekableService();
467         ~iSeekableService();
468 #endif
469 public:
470         virtual RESULT getLength(pts_t &SWIG_OUTPUT)=0;
471         virtual RESULT seekTo(pts_t to)=0;
472         virtual RESULT seekRelative(int direction, pts_t to)=0;
473         virtual RESULT getPlayPosition(pts_t &SWIG_OUTPUT)=0;
474                 /* if you want to do several seeks in a row, you can enable the trickmode.
475                    audio will be switched off, sync will be disabled etc. */
476         virtual RESULT setTrickmode(int trick=0)=0;
477         virtual RESULT isCurrentlySeekable()=0;
478         virtual RESULT seekChapter(int) { return -1; }
479         virtual RESULT seekTitle(int) { return -1; }
480 };
481 SWIG_TEMPLATE_TYPEDEF(ePtr<iSeekableService>, iSeekableServicePtr);
482
483 struct iAudioTrackInfo
484 {
485 #ifndef SWIG
486         std::string m_description;
487         std::string m_language; /* iso639 */
488         int m_pid; /* for association with the stream. */
489 #endif
490         std::string getDescription() { return m_description; }
491         std::string getLanguage() { return m_language; }
492         int getPID() { return m_pid; }
493 };
494 SWIG_ALLOW_OUTPUT_SIMPLE(iAudioTrackInfo);
495
496 SWIG_IGNORE(iAudioTrackSelection);
497 class iAudioTrackSelection: public iObject
498 {
499 #ifdef SWIG
500         iAudioTrackSelection();
501         ~iAudioTrackSelection();
502 #endif
503 public:
504         virtual int getNumberOfTracks()=0;
505         virtual RESULT selectTrack(unsigned int i)=0;
506         virtual SWIG_VOID(RESULT) getTrackInfo(struct iAudioTrackInfo &SWIG_OUTPUT, unsigned int n)=0;
507         virtual int getCurrentTrack()=0;
508 };
509 SWIG_TEMPLATE_TYPEDEF(ePtr<iAudioTrackSelection>, iAudioTrackSelectionPtr);
510
511 class iAudioChannelSelection_ENUMS
512 {
513 #ifdef SWIG
514         iAudioChannelSelection_ENUMS();
515         ~iAudioChannelSelection_ENUMS();
516 #endif
517 public:
518         enum { LEFT, STEREO, RIGHT };
519 };
520
521 SWIG_IGNORE(iAudioChannelSelection);
522 class iAudioChannelSelection: public iAudioChannelSelection_ENUMS, public iObject
523 {
524 #ifdef SWIG
525         iAudioChannelSelection();
526         ~iAudioChannelSelection();
527 #endif
528 public:
529         virtual int getCurrentChannel()=0;
530         virtual RESULT selectChannel(int i)=0;
531 };
532 SWIG_TEMPLATE_TYPEDEF(ePtr<iAudioChannelSelection>, iAudioChannelSelectionPtr);
533
534 SWIG_IGNORE(iAudioDelay);
535 class iAudioDelay: public iObject
536 {
537 #ifdef SWIG
538         iAudioDelay();
539         ~iAudioDelay();
540 #endif
541 public:
542         virtual int getAC3Delay()=0;
543         virtual int getPCMDelay()=0;
544         virtual void setAC3Delay(int)=0;
545         virtual void setPCMDelay(int)=0;
546 };
547 SWIG_TEMPLATE_TYPEDEF(ePtr<iAudioDelay>, iAudioDelayPtr);
548
549 class iRdsDecoder_ENUMS
550 {
551 #ifdef SWIG
552         iRdsDecoder_ENUMS();
553         ~iRdsDecoder_ENUMS();
554 #endif
555 public:
556         enum { RadioText, RtpText };
557 };
558
559 SWIG_IGNORE(iRdsDecoder);
560 class iRdsDecoder: public iObject, public iRdsDecoder_ENUMS
561 {
562 #ifdef SWIG
563         iRdsDecoder();
564         ~iRdsDecoder();
565 #endif
566 public:
567         virtual std::string getText(int x=RadioText)=0;
568         virtual void showRassSlidePicture()=0;
569         virtual void showRassInteractivePic(int page, int subpage)=0;
570         virtual SWIG_PYOBJECT(ePyObject) getRassInteractiveMask()=0;
571 };
572 SWIG_TEMPLATE_TYPEDEF(ePtr<iRdsDecoder>, iRdsDecoderPtr);
573
574 SWIG_IGNORE(iSubserviceList);
575 class iSubserviceList: public iObject
576 {
577 #ifdef SWIG
578         iSubserviceList();
579         ~iSubserviceList();
580 #endif
581 public:
582         virtual int getNumberOfSubservices()=0;
583         virtual SWIG_VOID(RESULT) getSubservice(eServiceReference &SWIG_OUTPUT, unsigned int n)=0;
584 };
585 SWIG_TEMPLATE_TYPEDEF(ePtr<iSubserviceList>, iSubserviceListPtr);
586
587 SWIG_IGNORE(iTimeshiftService);
588 class iTimeshiftService: public iObject
589 {
590 #ifdef SWIG
591         iTimeshiftService();
592         ~iTimeshiftService();
593 #endif
594 public:
595         virtual RESULT startTimeshift()=0;
596         virtual RESULT stopTimeshift()=0;
597
598         virtual int isTimeshiftActive()=0;
599                         /* this essentially seeks to the relative end of the timeshift buffer */
600         virtual RESULT activateTimeshift()=0;
601 };
602 SWIG_TEMPLATE_TYPEDEF(ePtr<iTimeshiftService>, iTimeshiftServicePtr);
603
604         /* not related to eCueSheet */
605
606 class iCueSheet_ENUMS
607 {
608 #ifdef SWIG
609         iCueSheet_ENUMS();
610         ~iCueSheet_ENUMS();
611 #endif
612 public:
613         enum { cutIn = 0, cutOut = 1, cutMark = 2 };
614 };
615
616 SWIG_IGNORE(iCueSheet);
617 class iCueSheet: public iCueSheet_ENUMS, public iObject
618 {
619 #ifdef SWIG
620         iCueSheet();
621         ~iCueSheet();
622 #endif
623 public:
624         /* returns a list of (pts, what)-tuples */
625         virtual PyObject *getCutList() = 0;
626         virtual void setCutList(SWIG_PYOBJECT(ePyObject) list) = 0;
627         virtual void setCutListEnable(int enable) = 0;
628 };
629 SWIG_TEMPLATE_TYPEDEF(ePtr<iCueSheet>, iCueSheetPtr);
630
631 class eWidget;
632 class PyList;
633
634 SWIG_IGNORE(iSubtitleOutput);
635 class iSubtitleOutput: public iObject
636 {
637 public:
638         virtual RESULT enableSubtitles(eWidget *parent, SWIG_PYOBJECT(ePyObject) entry)=0;
639         virtual RESULT disableSubtitles(eWidget *parent)=0;
640         virtual PyObject *getSubtitleList()=0;
641         virtual PyObject *getCachedSubtitle()=0;
642 };
643 SWIG_TEMPLATE_TYPEDEF(ePtr<iSubtitleOutput>, iSubtitleOutputPtr);
644
645 SWIG_IGNORE(iMutableServiceList);
646 class iMutableServiceList: public iObject
647 {
648 #ifdef SWIG
649         iMutableServiceList();
650         ~iMutableServiceList();
651 #endif
652 public:
653                 /* flush changes */
654         virtual RESULT flushChanges()=0;
655                 /* adds a service to a list */
656         virtual RESULT addService(eServiceReference &ref, eServiceReference before=eServiceReference())=0;
657                 /* removes a service from a list */
658         virtual RESULT removeService(eServiceReference &ref)=0;
659                 /* moves a service in a list, only if list suppports a specific sort method. */
660                 /* pos is the new, absolute position from 0..size-1 */
661         virtual RESULT moveService(eServiceReference &ref, int pos)=0;
662                 /* set name of list, for bouquets this is the visible bouquet name */
663         virtual RESULT setListName(const std::string &name)=0;
664 };
665 SWIG_TEMPLATE_TYPEDEF(ePtr<iMutableServiceList>, iMutableServiceListPtr);
666
667 SWIG_IGNORE(iListableService);
668 class iListableService: public iObject
669 {
670 #ifdef SWIG
671         iListableService();
672         ~iListableService();
673 #endif
674 public:
675 #ifndef SWIG
676                 /* legacy interface: get a list */
677         virtual RESULT getContent(std::list<eServiceReference> &list, bool sorted=false)=0;
678 #endif
679         virtual PyObject *getContent(const char* format, bool sorted=false)=0;
680
681                 /* new, shiny interface: streaming. */
682         virtual SWIG_VOID(RESULT) getNext(eServiceReference &SWIG_OUTPUT)=0;
683
684                 /* use this for sorting. output is not sorted because of either
685                  - performance reasons: the whole list must be buffered or
686                  - the interface would be restricted to a list. streaming
687                    (as well as a future "active" extension) won't be possible.
688                 */
689         virtual int compareLessEqual(const eServiceReference &, const eServiceReference &)=0;
690
691         virtual SWIG_VOID(RESULT) startEdit(ePtr<iMutableServiceList> &SWIG_OUTPUT)=0;
692 };
693 SWIG_TEMPLATE_TYPEDEF(ePtr<iListableService>, iListableServicePtr);
694
695 #ifndef SWIG
696         /* a helper class which can be used as argument to stl's sort(). */
697 class iListableServiceCompare
698 {
699         ePtr<iListableService> m_list;
700 public:
701         iListableServiceCompare(iListableService *list): m_list(list) { }
702         bool operator()(const eServiceReference &a, const eServiceReference &b)
703         {
704                 return m_list->compareLessEqual(a, b);
705         }
706 };
707 #endif
708
709 SWIG_IGNORE(iServiceOfflineOperations);
710 class iServiceOfflineOperations: public iObject
711 {
712 #ifdef SWIG
713         iServiceOfflineOperations();
714         ~iServiceOfflineOperations();
715 #endif
716 public:
717                 /* to delete a service, forever. */
718         virtual RESULT deleteFromDisk(int simulate=1)=0;
719
720                 /* for transferring a service... */
721         virtual SWIG_VOID(RESULT) getListOfFilenames(std::list<std::string> &SWIG_OUTPUT)=0;
722
723                 // TODO: additional stuff, like a conversion interface?
724 };
725 SWIG_TEMPLATE_TYPEDEF(ePtr<iServiceOfflineOperations>, iServiceOfflineOperationsPtr);
726
727 SWIG_IGNORE(iStreamableService);
728 class iStreamableService: public iObject
729 {
730 #ifdef SWIG
731         iStreamableService();
732         ~iStreamableService();
733 #endif
734 public:
735                 /* returns a dict:
736                         { "demux": <n>,
737                           "pids": [(x,type),(y,type),(z,type),..],
738                           ...
739                         }
740                         with type being "video", "audio", "pmt", "pat"...
741                 */
742         virtual PyObject *getStreamingData()=0;
743 };
744 SWIG_TEMPLATE_TYPEDEF(ePtr<iStreamableService>, iStreamableServicePtr);
745
746 SWIG_IGNORE(iStreamedService);
747 class iStreamedService: public iObject
748 {
749 #ifdef SWIG
750         iStreamedService();
751         ~iStreamedService();
752 #endif
753 public:
754         virtual PyObject *getBufferCharge()=0;
755         virtual int setBufferSize(int size)=0;
756 };
757 SWIG_TEMPLATE_TYPEDEF(ePtr<iStreamedService>, iStreamedServicePtr);
758
759 class iServiceKeys_ENUMS
760 {
761 #ifdef SWIG
762         iServiceKeys_ENUMS();
763         ~iServiceKeys_ENUMS();
764 #endif
765 public:
766         enum {
767                 keyLeft,
768                 keyRight,
769                 keyUp,
770                 keyDown,
771                 keyOk,
772                 keyUser = 0x100
773         };
774 };
775
776 SWIG_IGNORE(iServiceKeys);
777 class iServiceKeys: public iServiceKeys_ENUMS, public iObject
778 {
779 #ifdef SWIG
780         iServiceKeys();
781         ~iServiceKeys();
782 #endif
783 public:
784         virtual SWIG_VOID(RESULT) keyPressed(int key)=0;
785 };
786 SWIG_TEMPLATE_TYPEDEF(ePtr<iServiceKeys>, iServiceKeysPtr);
787
788 class iPlayableService_ENUMS
789 {
790 #ifdef SWIG
791         iPlayableService_ENUMS();
792         ~iPlayableService_ENUMS();
793 #endif
794 public:
795         enum {
796                         /* these first two events are magical, and should only
797                            be generated if you know what you're doing. */
798                 evStart,
799                 evEnd,
800
801                 evTunedIn,
802                 evTuneFailed,
803
804                         /* when iServiceInformation is implemented:*/
805                 evUpdatedEventInfo,
806                 evUpdatedInfo,
807
808                         /* when seek() is implemented: */
809                 evSeekableStatusChanged, /* for example when timeshifting */
810
811                 evEOF,
812                 evSOF, /* bounced against start of file (when seeking backwards) */
813
814                         /* when cueSheet is implemented */
815                 evCuesheetChanged,
816
817                         /* when rdsDecoder is implemented */
818                 evUpdatedRadioText,
819                 evUpdatedRtpText,
820
821                         /* Radio Screenshow Support */
822                 evUpdatedRassSlidePic,
823                 evUpdatedRassInteractivePicMask,
824
825                 evVideoSizeChanged,
826                 evVideoFramerateChanged,
827                 evVideoProgressiveChanged,
828
829                 evBuffering,
830
831                 evStopped,
832
833                 evUser = 0x100
834         };
835 };
836
837 SWIG_IGNORE(iPlayableService);
838 class iPlayableService: public iPlayableService_ENUMS, public iObject
839 {
840 #ifdef SWIG
841         iPlayableService();
842         ~iPlaybleService();
843 #endif
844         friend class iServiceHandler;
845 public:
846 #ifndef SWIG
847         virtual RESULT connectEvent(const Slot2<void,iPlayableService*,int> &event, ePtr<eConnection> &connection)=0;
848 #endif
849         virtual RESULT start()=0;
850         virtual RESULT stop()=0;
851                         /* might have to be changed... */
852         virtual RESULT setTarget(int target)=0;
853         virtual SWIG_VOID(RESULT) seek(ePtr<iSeekableService> &SWIG_OUTPUT)=0;
854         virtual SWIG_VOID(RESULT) pause(ePtr<iPauseableService> &SWIG_OUTPUT)=0;
855         virtual SWIG_VOID(RESULT) info(ePtr<iServiceInformation> &SWIG_OUTPUT)=0;
856         virtual SWIG_VOID(RESULT) audioTracks(ePtr<iAudioTrackSelection> &SWIG_OUTPUT)=0;
857         virtual SWIG_VOID(RESULT) audioChannel(ePtr<iAudioChannelSelection> &SWIG_OUTPUT)=0;
858         virtual SWIG_VOID(RESULT) subServices(ePtr<iSubserviceList> &SWIG_OUTPUT)=0;
859         virtual SWIG_VOID(RESULT) frontendInfo(ePtr<iFrontendInformation> &SWIG_OUTPUT)=0;
860         virtual SWIG_VOID(RESULT) timeshift(ePtr<iTimeshiftService> &SWIG_OUTPUT)=0;
861         virtual SWIG_VOID(RESULT) cueSheet(ePtr<iCueSheet> &SWIG_OUTPUT)=0;
862         virtual SWIG_VOID(RESULT) subtitle(ePtr<iSubtitleOutput> &SWIG_OUTPUT)=0;
863         virtual SWIG_VOID(RESULT) audioDelay(ePtr<iAudioDelay> &SWIG_OUTPUT)=0;
864         virtual SWIG_VOID(RESULT) rdsDecoder(ePtr<iRdsDecoder> &SWIG_OUTPUT)=0;
865         virtual SWIG_VOID(RESULT) stream(ePtr<iStreamableService> &SWIG_OUTPUT)=0;
866         virtual SWIG_VOID(RESULT) streamed(ePtr<iStreamedService> &SWIG_OUTPUT)=0;
867         virtual SWIG_VOID(RESULT) keys(ePtr<iServiceKeys> &SWIG_OUTPUT)=0;
868 };
869 SWIG_TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
870
871 class iRecordableService_ENUMS
872 {
873 #ifdef SWIG
874         iRecordableService_ENUMS();
875         ~iRecordableService_ENUMS();
876 #endif
877 public:
878         enum {
879                 evStart,
880                 evEnd,
881                 evTunedIn,
882                 evTuneFailed,
883                 evRecordRunning,
884                 evRecordStopped,
885                 evNewProgramInfo,
886                 evRecordFailed,
887                 evRecordWriteError,
888                 evNewEventInfo
889         };
890         enum {
891                 NoError=0,
892                 errOpenRecordFile=-1,
893                 errNoDemuxAvailable=-2,
894                 errNoTsRecorderAvailable=-3,
895                 errDiskFull=-4,
896                 errTuneFailed=-255,
897                 errMisconfiguration = -256,
898                 errNoResources = -257,
899         };
900 };
901
902 SWIG_IGNORE(iRecordableService);
903 class iRecordableService: public iRecordableService_ENUMS, public iObject
904 {
905 #ifdef SWIG
906         iRecordableService();
907         ~iRecordableService();
908 #endif
909 public:
910 #ifndef SWIG
911         virtual RESULT connectEvent(const Slot2<void,iRecordableService*,int> &event, ePtr<eConnection> &connection)=0;
912 #endif
913         virtual SWIG_VOID(RESULT) getError(int &SWIG_OUTPUT)=0;
914         virtual RESULT prepare(const char *filename, time_t begTime=-1, time_t endTime=-1, int eit_event_id=-1, const char *name=0, const char *descr=0, const char *tags=0)=0;
915         virtual RESULT prepareStreaming()=0;
916         virtual RESULT start(bool simulate=false)=0;
917         virtual RESULT stop()=0;
918         virtual SWIG_VOID(RESULT) frontendInfo(ePtr<iFrontendInformation> &SWIG_OUTPUT)=0;
919         virtual SWIG_VOID(RESULT) stream(ePtr<iStreamableService> &SWIG_OUTPUT)=0;
920         virtual SWIG_VOID(RESULT) subServices(ePtr<iSubserviceList> &SWIG_OUTPUT)=0;
921 };
922 SWIG_TEMPLATE_TYPEDEF(ePtr<iRecordableService>, iRecordableServicePtr);
923
924 extern PyObject *New_iRecordableServicePtr(const ePtr<iRecordableService> &ref); // defined in enigma_python.i
925
926 inline PyObject *PyFrom(ePtr<iRecordableService> &c)
927 {
928         return New_iRecordableServicePtr(c);
929 }
930
931 #ifndef SWIG
932 #ifdef PYTHON_REFCOUNT_DEBUG
933 inline ePyObject Impl_New_iRecordableServicePtr(const char* file, int line, const ePtr<iRecordableService> &ptr)
934 {
935         return ePyObject(New_iRecordableServicePtr(ptr), file, line);
936 }
937 #define NEW_iRecordableServicePtr(ptr) Impl_New_iRecordableServicePtr(__FILE__, __LINE__, ptr)
938 #else
939 inline ePyObject Impl_New_iRecordableServicePtr(const ePtr<iRecordableService> &ptr)
940 {
941         return New_iRecordableServicePtr(ptr);
942 }
943 #define NEW_iRecordableServicePtr(ptr) Impl_New_iRecordableServicePtr(ptr)
944 #endif
945 #endif // SWIG
946
947 SWIG_IGNORE(iServiceHandler);
948 class iServiceHandler: public iObject
949 {
950 #ifdef SWIG
951         iServiceHandler();
952         ~iServiceHandler();
953 #endif
954 public:
955         virtual SWIG_VOID(RESULT) play(const eServiceReference &, ePtr<iPlayableService> &SWIG_OUTPUT)=0;
956         virtual SWIG_VOID(RESULT) record(const eServiceReference &, ePtr<iRecordableService> &SWIG_OUTPUT)=0;
957         virtual SWIG_VOID(RESULT) list(const eServiceReference &, ePtr<iListableService> &SWIG_OUTPUT)=0;
958         virtual SWIG_VOID(RESULT) info(const eServiceReference &, ePtr<iStaticServiceInformation> &SWIG_OUTPUT)=0;
959         virtual SWIG_VOID(RESULT) offlineOperations(const eServiceReference &, ePtr<iServiceOfflineOperations> &SWIG_OUTPUT)=0;
960 };
961 SWIG_TEMPLATE_TYPEDEF(ePtr<iServiceHandler>, iServiceHandlerPtr);
962
963 #endif