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() { 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 #endif
 142         eServiceReference(int type, int flags, const std::string &path)
 143                 : type(type), flags(flags), path(path)
 144         {
 145                 memset(data, 0, sizeof(data));
 146         }
 147         eServiceReference(const std::string &string);
 148         std::string toString() const;
 149         std::string toCompareString() const;
 150         bool operator==(const eServiceReference &c) const
 151         {
 152                 if (type != c.type)
 153                         return 0;
 154                 return (memcmp(data, c.data, sizeof(int)*8)==0) && (path == c.path);
 155         }
 156         bool operator!=(const eServiceReference &c) const
 157         {
 158                 return !(*this == c);
 159         }
 160         bool operator<(const eServiceReference &c) const
 161         {
 162                 if (type < c.type)
 163                         return 1;
 164
 165                 if (type > c.type)
 166                         return 0;
 167
 168                 int r=memcmp(data, c.data, sizeof(int)*8);
 169                 if (r)
 170                         return r < 0;
 171                 return path < c.path;
 172         }
 173         operator bool() const
 174         {
 175                 return valid();
 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);
 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                 sIsMultichannel,        /* multichannel *available* (probably not selected) */
 265
 266                         /* "user serviceable info" - they are not reliable. Don't use them for anything except the service menu!
 267                            that's also the reason why they are so globally defined.
 268                            again - if somebody EVER tries to use this information for anything else than simply displaying it,
 269                            i will change this to return a user-readable text like "zero x zero three three" (and change the
 270                            exact spelling in every version) to stop that! */
 271
 272                 sVideoPID,
 273                 sAudioPID,
 274                 sPCRPID,
 275                 sPMTPID,
 276                 sTXTPID,
 277
 278                 sSID,
 279                 sONID,
 280                 sTSID,
 281                 sNamespace,
 282                 sProvider,
 283
 284                 sDescription,
 285                 sServiceref,
 286                 sTimeCreate,            /* unix time or string */
 287
 288                 sTitle,
 289                 sArtist,
 290                 sAlbum,
 291                 sComment,
 292                 sTracknumber,
 293                 sGenre,
 294                 sCAIDs,
 295                 sVideoType,             /* MPEG2 MPEG4 */
 296
 297                 sTags,                          /* space seperated list of tags */
 298
 299                 sDVBState,                      /* states as defined in pmt handler (as events there) */
 300
 301                 sVideoHeight,
 302                 sVideoWidth,
 303
 304                 sTransponderData        /* transponderdata as python dict */
 305         };
 306         enum {
 307                 resNA = -1,
 308                 resIsString = -2,
 309                 resIsPyObject = -3
 310         };
 311 };
 312
 313 /* some words to structs like struct iServiceInformation_ENUMS
 314 For some classes we need in python just the SmartPointer Variants.
 315 So we prevent building wrapper classes for the non smart pointer classes with the SWIG_IGNORE makro.
 316 But now we have the problem that swig do not export enums for smart pointer classes (i dont know why).
 317 So we move all enum's to own classes (with _ENUMS as name ending) and let our real
 318 class inherit from the *_ENUMS class. This *_ENUMS classes are normally exportet via swig to python.
 319 But in the python code we doesn't like to write iServiceInformation_ENUMS.sVideoType....
 320 we like to write iServiceInformation.sVideoType.
 321 So until swig have no Solution for this Problem we call in lib/python/Makefile.am a python script named
 322 enigma_py_patcher.py to remove the "_ENUMS" strings in enigma.py at all needed locations. */
 323
 324 SWIG_IGNORE(iServiceInformation);
 325 class iServiceInformation: public iServiceInformation_ENUMS, public iObject
 326 {
 327 #ifdef SWIG
 328         iServiceInformation();
 329         ~iServiceInformation();
 330 #endif
 331 public:
 332         virtual SWIG_VOID(RESULT) getName(std::string &SWIG_OUTPUT)=0;
 333         virtual SWIG_VOID(RESULT) getEvent(ePtr<eServiceEvent> &SWIG_OUTPUT, int nownext);
 334
 335         virtual int getInfo(int w);
 336         virtual std::string getInfoString(int w);
 337         virtual PyObject *getInfoObject(int w);
 338
 339         virtual int setInfo(int w, int v);
 340         virtual int setInfoString(int w, const char *v);
 341 };
 342 SWIG_TEMPLATE_TYPEDEF(ePtr<iServiceInformation>, iServiceInformationPtr);
 343
 344 class iFrontendInformation_ENUMS
 345 {
 346 #ifdef SWIG
 347         iFrontendInformation_ENUMS();
 348         ~iFrontendInformation_ENUMS();
 349 #endif
 350 public:
 351         enum {
 352                 bitErrorRate,
 353                 signalPower,
 354                 signalQuality,
 355                 lockState,
 356                 syncState,
 357                 frontendNumber,
 358                 signalPowerdB,
 359         };
 360 };
 361
 362 SWIG_IGNORE(iFrontendInformation);
 363 class iFrontendInformation: public iFrontendInformation_ENUMS, public iObject
 364 {
 365 #ifdef SWIG
 366         iFrontendInformation();
 367         ~iFrontendInformation();
 368 #endif
 369 public:
 370         virtual int getFrontendInfo(int w)=0;
 371         virtual PyObject *getFrontendData()=0;
 372         virtual PyObject *getFrontendStatus()=0;
 373         virtual PyObject *getTransponderData(bool original)=0;
 374         virtual PyObject *getAll(bool original)=0; // a sum of getFrontendData/Status/TransponderData
 375 };
 376 SWIG_TEMPLATE_TYPEDEF(ePtr<iFrontendInformation>, iFrontendInformationPtr);
 377
 378 SWIG_IGNORE(iPauseableService);
 379 class iPauseableService: public iObject
 380 {
 381 #ifdef SWIG
 382         iPausableService();
 383         ~iPausableService();
 384 #endif
 385 public:
 386         virtual RESULT pause()=0;
 387         virtual RESULT unpause()=0;
 388
 389                 /* hm. */
 390         virtual RESULT setSlowMotion(int ratio=0)=0;
 391         virtual RESULT setFastForward(int ratio=0)=0;
 392 };
 393 SWIG_TEMPLATE_TYPEDEF(ePtr<iPauseableService>, iPauseableServicePtr);
 394
 395 class iSeekableService_ENUMS
 396 {
 397 #ifdef SWIG
 398         iSeekableService_ENUMS();
 399         ~iSeekableService_ENUMS();
 400 #endif
 401 public:
 402         enum { dirForward = +1, dirBackward = -1 };
 403 };
 404
 405 SWIG_IGNORE(iSeekableService);
 406 class iSeekableService: public iSeekableService_ENUMS, public iObject
 407 {
 408 #ifdef SWIG
 409         iSeekableService();
 410         ~iSeekableService();
 411 #endif
 412 public:
 413         virtual RESULT getLength(pts_t &SWIG_OUTPUT)=0;
 414         virtual RESULT seekTo(pts_t to)=0;
 415         virtual RESULT seekRelative(int direction, pts_t to)=0;
 416         virtual RESULT getPlayPosition(pts_t &SWIG_OUTPUT)=0;
 417                 /* if you want to do several seeks in a row, you can enable the trickmode.
 418                    audio will be switched off, sync will be disabled etc. */
 419         virtual RESULT setTrickmode(int trick=0)=0;
 420         virtual RESULT isCurrentlySeekable()=0;
 421 };
 422 SWIG_TEMPLATE_TYPEDEF(ePtr<iSeekableService>, iSeekableServicePtr);
 423
 424 struct iAudioTrackInfo
 425 {
 426 #ifndef SWIG
 427         std::string m_description;
 428         std::string m_language; /* iso639 */
 429 #endif
 430         std::string getDescription() { return m_description; }
 431         std::string getLanguage() { return m_language; }
 432 };
 433 SWIG_ALLOW_OUTPUT_SIMPLE(iAudioTrackInfo);
 434
 435 SWIG_IGNORE(iAudioTrackSelection);
 436 class iAudioTrackSelection: public iObject
 437 {
 438 #ifdef SWIG
 439         iAudioTrackSelection();
 440         ~iAudioTrackSelection();
 441 #endif
 442 public:
 443         virtual int getNumberOfTracks()=0;
 444         virtual RESULT selectTrack(unsigned int i)=0;
 445         virtual SWIG_VOID(RESULT) getTrackInfo(struct iAudioTrackInfo &SWIG_OUTPUT, unsigned int n)=0;
 446 };
 447 SWIG_TEMPLATE_TYPEDEF(ePtr<iAudioTrackSelection>, iAudioTrackSelectionPtr);
 448
 449 class iAudioChannelSelection_ENUMS
 450 {
 451 #ifdef SWIG
 452         iAudioChannelSelection_ENUMS();
 453         ~iAudioChannelSelection_ENUMS();
 454 #endif
 455 public:
 456         enum { LEFT, STEREO, RIGHT };
 457 };
 458
 459 SWIG_IGNORE(iAudioChannelSelection);
 460 class iAudioChannelSelection: public iAudioChannelSelection_ENUMS, public iObject
 461 {
 462 #ifdef SWIG
 463         iAudioChannelSelection();
 464         ~iAudioChannelSelection();
 465 #endif
 466 public:
 467         virtual int getCurrentChannel()=0;
 468         virtual RESULT selectChannel(int i)=0;
 469 };
 470 SWIG_TEMPLATE_TYPEDEF(ePtr<iAudioChannelSelection>, iAudioChannelSelectionPtr);
 471
 472 SWIG_IGNORE(iAudioDelay);
 473 class iAudioDelay: public iObject
 474 {
 475 #ifdef SWIG
 476         iAudioDelay();
 477         ~iAudioDelay();
 478 #endif
 479 public:
 480         virtual int getAC3Delay()=0;
 481         virtual int getPCMDelay()=0;
 482         virtual void setAC3Delay(int)=0;
 483         virtual void setPCMDelay(int)=0;
 484 };
 485 SWIG_TEMPLATE_TYPEDEF(ePtr<iAudioDelay>, iAudioDelayPtr);
 486
 487 class iRdsDecoder_ENUMS
 488 {
 489 #ifdef SWIG
 490         iRdsDecoder_ENUMS();
 491         ~iRdsDecoder_ENUMS();
 492 #endif
 493 public:
 494         enum { RadioText, RtpText };
 495 };
 496
 497 SWIG_IGNORE(iRdsDecoder);
 498 class iRdsDecoder: public iObject, public iRdsDecoder_ENUMS
 499 {
 500 #ifdef SWIG
 501         iRdsDecoder();
 502         ~iRdsDecoder();
 503 #endif
 504 public:
 505         virtual std::string getText(int x=RadioText)=0;
 506         virtual void showRassSlidePicture()=0;
 507         virtual void showRassInteractivePic(int page, int subpage)=0;
 508         virtual SWIG_PYOBJECT(ePyObject) getRassInteractiveMask()=0;
 509 };
 510 SWIG_TEMPLATE_TYPEDEF(ePtr<iRdsDecoder>, iRdsDecoderPtr);
 511
 512 SWIG_IGNORE(iSubserviceList);
 513 class iSubserviceList: public iObject
 514 {
 515 #ifdef SWIG
 516         iSubserviceList();
 517         ~iSubserviceList();
 518 #endif
 519 public:
 520         virtual int getNumberOfSubservices()=0;
 521         virtual SWIG_VOID(RESULT) getSubservice(eServiceReference &SWIG_OUTPUT, unsigned int n)=0;
 522 };
 523 SWIG_TEMPLATE_TYPEDEF(ePtr<iSubserviceList>, iSubserviceListPtr);
 524
 525 SWIG_IGNORE(iTimeshiftService);
 526 class iTimeshiftService: public iObject
 527 {
 528 #ifdef SWIG
 529         iTimeshiftService();
 530         ~iTimeshiftService();
 531 #endif
 532 public:
 533         virtual RESULT startTimeshift()=0;
 534         virtual RESULT stopTimeshift()=0;
 535
 536         virtual int isTimeshiftActive()=0;
 537                         /* this essentially seeks to the relative end of the timeshift buffer */
 538         virtual RESULT activateTimeshift()=0;
 539 };
 540 SWIG_TEMPLATE_TYPEDEF(ePtr<iTimeshiftService>, iTimeshiftServicePtr);
 541
 542         /* not related to eCueSheet */
 543
 544 class iCueSheet_ENUMS
 545 {
 546 #ifdef SWIG
 547         iCueSheet_ENUMS();
 548         ~iCueSheet_ENUMS();
 549 #endif
 550 public:
 551         enum { cutIn = 0, cutOut = 1, cutMark = 2 };
 552 };
 553
 554 SWIG_IGNORE(iCueSheet);
 555 class iCueSheet: public iCueSheet_ENUMS, public iObject
 556 {
 557 #ifdef SWIG
 558         iCueSheet();
 559         ~iCueSheet();
 560 #endif
 561 public:
 562         /* returns a list of (pts, what)-tuples */
 563         virtual PyObject *getCutList() = 0;
 564         virtual void setCutList(SWIG_PYOBJECT(ePyObject) list) = 0;
 565         virtual void setCutListEnable(int enable) = 0;
 566 };
 567 SWIG_TEMPLATE_TYPEDEF(ePtr<iCueSheet>, iCueSheetPtr);
 568
 569 class eWidget;
 570 class PyList;
 571
 572 SWIG_IGNORE(iSubtitleOutput);
 573 class iSubtitleOutput: public iObject
 574 {
 575 public:
 576         virtual RESULT enableSubtitles(eWidget *parent, SWIG_PYOBJECT(ePyObject) entry)=0;
 577         virtual RESULT disableSubtitles(eWidget *parent)=0;
 578         virtual PyObject *getSubtitleList()=0;
 579         virtual PyObject *getCachedSubtitle()=0;
 580 };
 581 SWIG_TEMPLATE_TYPEDEF(ePtr<iSubtitleOutput>, iSubtitleOutputPtr);
 582
 583 SWIG_IGNORE(iMutableServiceList);
 584 class iMutableServiceList: public iObject
 585 {
 586 #ifdef SWIG
 587         iMutableServiceList();
 588         ~iMutableServiceList();
 589 #endif
 590 public:
 591                 /* flush changes */
 592         virtual RESULT flushChanges()=0;
 593                 /* adds a service to a list */
 594         virtual RESULT addService(eServiceReference &ref, eServiceReference before=eServiceReference())=0;
 595                 /* removes a service from a list */
 596         virtual RESULT removeService(eServiceReference &ref)=0;
 597                 /* moves a service in a list, only if list suppports a specific sort method. */
 598                 /* pos is the new, absolute position from 0..size-1 */
 599         virtual RESULT moveService(eServiceReference &ref, int pos)=0;
 600                 /* set name of list, for bouquets this is the visible bouquet name */
 601         virtual RESULT setListName(const std::string &name)=0;
 602 };
 603 SWIG_TEMPLATE_TYPEDEF(ePtr<iMutableServiceList>, iMutableServiceListPtr);
 604
 605 SWIG_IGNORE(iListableService);
 606 class iListableService: public iObject
 607 {
 608 #ifdef SWIG
 609         iListableService();
 610         ~iListableService();
 611 #endif
 612 public:
 613 #ifndef SWIG
 614                 /* legacy interface: get a list */
 615         virtual RESULT getContent(std::list<eServiceReference> &list, bool sorted=false)=0;
 616 #endif
 617         virtual PyObject *getContent(const char* format, bool sorted=false)=0;
 618
 619                 /* new, shiny interface: streaming. */
 620         virtual SWIG_VOID(RESULT) getNext(eServiceReference &SWIG_OUTPUT)=0;
 621
 622                 /* use this for sorting. output is not sorted because of either
 623                  - performance reasons: the whole list must be buffered or
 624                  - the interface would be restricted to a list. streaming
 625                    (as well as a future "active" extension) won't be possible.
 626                 */
 627         virtual int compareLessEqual(const eServiceReference &, const eServiceReference &)=0;
 628
 629         virtual SWIG_VOID(RESULT) startEdit(ePtr<iMutableServiceList> &SWIG_OUTPUT)=0;
 630 };
 631 SWIG_TEMPLATE_TYPEDEF(ePtr<iListableService>, iListableServicePtr);
 632
 633 #ifndef SWIG
 634         /* a helper class which can be used as argument to stl's sort(). */
 635 class iListableServiceCompare
 636 {
 637         ePtr<iListableService> m_list;
 638 public:
 639         iListableServiceCompare(iListableService *list): m_list(list) { }
 640         bool operator()(const eServiceReference &a, const eServiceReference &b)
 641         {
 642                 return m_list->compareLessEqual(a, b);
 643         }
 644 };
 645 #endif
 646
 647 SWIG_IGNORE(iServiceOfflineOperations);
 648 class iServiceOfflineOperations: public iObject
 649 {
 650 #ifdef SWIG
 651         iServiceOfflineOperations();
 652         ~iServiceOfflineOperations();
 653 #endif
 654 public:
 655                 /* to delete a service, forever. */
 656         virtual RESULT deleteFromDisk(int simulate=1)=0;
 657
 658                 /* for transferring a service... */
 659         virtual SWIG_VOID(RESULT) getListOfFilenames(std::list<std::string> &SWIG_OUTPUT)=0;
 660
 661                 // TODO: additional stuff, like a conversion interface?
 662 };
 663 SWIG_TEMPLATE_TYPEDEF(ePtr<iServiceOfflineOperations>, iServiceOfflineOperationsPtr);
 664
 665 class iPlayableService_ENUMS
 666 {
 667 #ifdef SWIG
 668         iPlayableService_ENUMS();
 669         ~iPlayableService_ENUMS();
 670 #endif
 671 public:
 672         enum {
 673                         /* these first two events are magical, and should only
 674                            be generated if you know what you're doing. */
 675                 evStart,
 676                 evEnd,
 677
 678                 evTuneFailed,
 679
 680                         /* when iServiceInformation is implemented:*/
 681                 evUpdatedEventInfo,
 682                 evUpdatedInfo,
 683
 684                         /* when seek() is implemented: */
 685                 evSeekableStatusChanged, /* for example when timeshifting */
 686
 687                 evEOF,
 688                 evSOF, /* bounced against start of file (when seeking backwards) */
 689
 690                         /* when cueSheet is implemented */
 691                 evCuesheetChanged,
 692
 693                         /* when rdsDecoder is implemented */
 694                 evUpdatedRadioText,
 695                 evUpdatedRtpText,
 696
 697                         /* Radio Screenshow Support */
 698                 evUpdatedRassSlidePic,
 699                 evUpdatedRassInteractivePicMask,
 700
 701                 evVideoSizeChanged,
 702
 703                 evStopped
 704         };
 705 };
 706
 707 class iStreamableService;
 708
 709 SWIG_IGNORE(iPlayableService);
 710 class iPlayableService: public iPlayableService_ENUMS, public iObject
 711 {
 712 #ifdef SWIG
 713         iPlayableService();
 714         ~iPlaybleService();
 715 #endif
 716         friend class iServiceHandler;
 717 public:
 718 #ifndef SWIG
 719         virtual RESULT connectEvent(const Slot2<void,iPlayableService*,int> &event, ePtr<eConnection> &connection)=0;
 720 #endif
 721         virtual RESULT start()=0;
 722         virtual RESULT stop()=0;
 723                         /* might have to be changed... */
 724         virtual RESULT setTarget(int target)=0;
 725         virtual SWIG_VOID(RESULT) seek(ePtr<iSeekableService> &SWIG_OUTPUT)=0;
 726         virtual SWIG_VOID(RESULT) pause(ePtr<iPauseableService> &SWIG_OUTPUT)=0;
 727         virtual SWIG_VOID(RESULT) info(ePtr<iServiceInformation> &SWIG_OUTPUT)=0;
 728         virtual SWIG_VOID(RESULT) audioTracks(ePtr<iAudioTrackSelection> &SWIG_OUTPUT)=0;
 729         virtual SWIG_VOID(RESULT) audioChannel(ePtr<iAudioChannelSelection> &SWIG_OUTPUT)=0;
 730         virtual SWIG_VOID(RESULT) subServices(ePtr<iSubserviceList> &SWIG_OUTPUT)=0;
 731         virtual SWIG_VOID(RESULT) frontendInfo(ePtr<iFrontendInformation> &SWIG_OUTPUT)=0;
 732         virtual SWIG_VOID(RESULT) timeshift(ePtr<iTimeshiftService> &SWIG_OUTPUT)=0;
 733         virtual SWIG_VOID(RESULT) cueSheet(ePtr<iCueSheet> &SWIG_OUTPUT)=0;
 734         virtual SWIG_VOID(RESULT) subtitle(ePtr<iSubtitleOutput> &SWIG_OUTPUT)=0;
 735         virtual SWIG_VOID(RESULT) audioDelay(ePtr<iAudioDelay> &SWIG_OUTPUT)=0;
 736         virtual SWIG_VOID(RESULT) rdsDecoder(ePtr<iRdsDecoder> &SWIG_OUTPUT)=0;
 737         virtual SWIG_VOID(RESULT) stream(ePtr<iStreamableService> &SWIG_OUTPUT)=0;
 738 };
 739 SWIG_TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
 740
 741 SWIG_IGNORE(iStreamableService);
 742 class iStreamableService: public iObject
 743 {
 744 #ifdef SWIG
 745         iStreamableService();
 746         ~iStreamableService();
 747 #endif
 748 public:
 749                 /* returns a dict:
 750                         { "demux": <n>,
 751                           "pids": [(x,type),(y,type),(z,type),..],
 752                           ...
 753                         }
 754                         with type being "video", "audio", "pmt", "pat"...
 755                 */
 756         virtual PyObject *getStreamingData()=0;
 757 };
 758 SWIG_TEMPLATE_TYPEDEF(ePtr<iStreamableService>, iStreamableServicePtr);
 759
 760 class iRecordableService_ENUMS
 761 {
 762 #ifdef SWIG
 763         iRecordableService_ENUMS();
 764         ~iRecordableService_ENUMS();
 765 #endif
 766 public:
 767         enum {
 768                 evStart,
 769                 evEnd,
 770                 evTunedIn,
 771                 evTuneFailed,
 772                 evRecordRunning,
 773                 evRecordStopped,
 774                 evNewProgramInfo,
 775                 evRecordFailed,
 776                 evRecordWriteError
 777         };
 778         enum {
 779                 NoError=0,
 780                 errOpenRecordFile=-1,
 781                 errNoDemuxAvailable=-2,
 782                 errNoTsRecorderAvailable=-3,
 783                 errDiskFull=-4,
 784                 errTuneFailed=-255
 785         };
 786 };
 787
 788 SWIG_IGNORE(iRecordableService);
 789 class iRecordableService: public iRecordableService_ENUMS, public iObject
 790 {
 791 #ifdef SWIG
 792         iRecordableService();
 793         ~iRecordableService();
 794 #endif
 795 public:
 796 #ifndef SWIG
 797         virtual RESULT connectEvent(const Slot2<void,iRecordableService*,int> &event, ePtr<eConnection> &connection)=0;
 798 #endif
 799         virtual SWIG_VOID(RESULT) getError(int &SWIG_OUTPUT)=0;
 800         virtual RESULT prepare(const char *filename, time_t begTime=-1, time_t endTime=-1, int eit_event_id=-1)=0;
 801         virtual RESULT prepareStreaming()=0;
 802         virtual RESULT start()=0;
 803         virtual RESULT stop()=0;
 804         virtual SWIG_VOID(RESULT) frontendInfo(ePtr<iFrontendInformation> &SWIG_OUTPUT)=0;
 805         virtual SWIG_VOID(RESULT) stream(ePtr<iStreamableService> &SWIG_OUTPUT)=0;
 806 };
 807 SWIG_TEMPLATE_TYPEDEF(ePtr<iRecordableService>, iRecordableServicePtr);
 808
 809 extern PyObject *New_iRecordableServicePtr(const ePtr<iRecordableService> &ref); // defined in enigma_python.i
 810
 811 inline PyObject *PyFrom(ePtr<iRecordableService> &c)
 812 {
 813         return New_iRecordableServicePtr(c);
 814 }
 815
 816 #ifndef SWIG
 817 #ifdef PYTHON_REFCOUNT_DEBUG
 818 inline ePyObject Impl_New_iRecordableServicePtr(const char* file, int line, const ePtr<iRecordableService> &ptr)
 819 {
 820         return ePyObject(New_iRecordableServicePtr(ptr), file, line);
 821 }
 822 #define NEW_iRecordableServicePtr(ptr) Impl_New_iRecordableServicePtr(__FILE__, __LINE__, ptr)
 823 #else
 824 inline ePyObject Impl_New_iRecordableServicePtr(const ePtr<iRecordableService> &ptr)
 825 {
 826         return New_iRecordableServicePtr(ptr);
 827 }
 828 #define NEW_iRecordableServicePtr(ptr) Impl_New_iRecordableServicePtr(ptr)
 829 #endif
 830 #endif // SWIG
 831
 832 SWIG_IGNORE(iServiceHandler);
 833 class iServiceHandler: public iObject
 834 {
 835 #ifdef SWIG
 836         iServiceHandler();
 837         ~iServiceHandler();
 838 #endif
 839 public:
 840         virtual SWIG_VOID(RESULT) play(const eServiceReference &, ePtr<iPlayableService> &SWIG_OUTPUT)=0;
 841         virtual SWIG_VOID(RESULT) record(const eServiceReference &, ePtr<iRecordableService> &SWIG_OUTPUT)=0;
 842         virtual SWIG_VOID(RESULT) list(const eServiceReference &, ePtr<iListableService> &SWIG_OUTPUT)=0;
 843         virtual SWIG_VOID(RESULT) info(const eServiceReference &, ePtr<iStaticServiceInformation> &SWIG_OUTPUT)=0;
 844         virtual SWIG_VOID(RESULT) offlineOperations(const eServiceReference &, ePtr<iServiceOfflineOperations> &SWIG_OUTPUT)=0;
 845 };
 846 SWIG_TEMPLATE_TYPEDEF(ePtr<iServiceHandler>, iServiceHandlerPtr);
 847
 848 #endif