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         };
  43         int flags; // flags will NOT be compared.
  44
  45         inline int getSortKey() const { return (flags & hasSortKey) ? data[3] : ((flags & sort1) ? 1 : 0); }
  46
  47 #ifndef SWIG
  48         int data[8];
  49         std::string path;
  50 #endif
  51         std::string getPath() { return path; }
  52         void setPath( const std::string &n ) { path=n; }
  53
  54         int getData(unsigned int num) const
  55         {
  56                 if ( num < sizeof(data)/sizeof(int) )
  57                         return data[num];
  58                 return 0;
  59         }
  60
  61         void setData(unsigned int num, int val)
  62         {
  63                 if ( num < sizeof(data)/sizeof(int) )
  64                         data[num] = val;
  65         }
  66
  67 // only for override service names in bouquets or to give servicerefs a name which not have a
  68 // real existing service ( for dvb eServiceDVB )
  69 #ifndef SWIG
  70         std::string name;
  71 #endif
  72         std::string getName() { return name; }
  73         void setName( const std::string &n ) { name=n; }
  74
  75         eServiceReference()
  76                 : type(idInvalid), flags(0)
  77         {
  78                 memset(data, 0, sizeof(data));
  79         }
  80 #ifndef SWIG
  81         eServiceReference(int type, int flags)
  82                 : type(type), flags(flags)
  83         {
  84                 memset(data, 0, sizeof(data));
  85         }
  86         eServiceReference(int type, int flags, int data0)
  87                 : type(type), flags(flags)
  88         {
  89                 memset(data, 0, sizeof(data));
  90                 data[0]=data0;
  91         }
  92         eServiceReference(int type, int flags, int data0, int data1)
  93                 : type(type), flags(flags)
  94         {
  95                 memset(data, 0, sizeof(data));
  96                 data[0]=data0;
  97                 data[1]=data1;
  98         }
  99         eServiceReference(int type, int flags, int data0, int data1, int data2)
 100                 : type(type), flags(flags)
 101         {
 102                 memset(data, 0, sizeof(data));
 103                 data[0]=data0;
 104                 data[1]=data1;
 105                 data[2]=data2;
 106         }
 107         eServiceReference(int type, int flags, int data0, int data1, int data2, int data3)
 108                 : type(type), flags(flags)
 109         {
 110                 memset(data, 0, sizeof(data));
 111                 data[0]=data0;
 112                 data[1]=data1;
 113                 data[2]=data2;
 114                 data[3]=data3;
 115         }
 116         eServiceReference(int type, int flags, int data0, int data1, int data2, int data3, int data4)
 117                 : type(type), flags(flags)
 118         {
 119                 memset(data, 0, sizeof(data));
 120                 data[0]=data0;
 121                 data[1]=data1;
 122                 data[2]=data2;
 123                 data[3]=data3;
 124                 data[4]=data4;
 125         }
 126         eServiceReference(int type, int flags, const std::string &path)
 127                 : type(type), flags(flags), path(path)
 128         {
 129                 memset(data, 0, sizeof(data));
 130         }
 131 #endif
 132         eServiceReference(const std::string &string);
 133         std::string toString() const;
 134         bool operator==(const eServiceReference &c) const
 135         {
 136                 if (type != c.type)
 137                         return 0;
 138                 return (memcmp(data, c.data, sizeof(int)*8)==0) && (path == c.path);
 139         }
 140         bool operator!=(const eServiceReference &c) const
 141         {
 142                 return !(*this == c);
 143         }
 144         bool operator<(const eServiceReference &c) const
 145         {
 146                 if (type < c.type)
 147                         return 1;
 148
 149                 if (type > c.type)
 150                         return 0;
 151
 152                 int r=memcmp(data, c.data, sizeof(int)*8);
 153                 if (r)
 154                         return r < 0;
 155                 return path < c.path;
 156         }
 157         operator bool() const
 158         {
 159                 return valid();
 160         }
 161
 162         int valid() const
 163         {
 164                 return type != idInvalid;
 165         }
 166 };
 167
 168 SWIG_ALLOW_OUTPUT_SIMPLE(eServiceReference);
 169
 170 extern PyObject *New_eServiceReference(const eServiceReference &ref); // defined in enigma_python.i
 171
 172 typedef long long pts_t;
 173
 174         /* the reason we have the servicereference as additional argument is
 175            that we don't have to create one object for every entry in a possibly
 176            large list, provided that no state information is nessesary to deliver
 177            the required information. Anyway - ref *must* be the same as the argument
 178            to the info() or getIServiceInformation call! */
 179
 180         /* About the usage of SWIG_VOID:
 181            SWIG_VOID(real_returntype_t) hides a return value from swig. This is used for
 182            the "superflouus" RESULT return values.
 183
 184            Python code has to check the returned pointer against 0. This works,
 185            as all functions returning instances in smartpointers AND having a
 186            RESULT have to BOTH return non-zero AND set the pointer to zero.
 187
 188            Python code thus can't check for the reason, but the reason isn't
 189            user-servicable anyway. If you want to return a real reason which
 190            goes beyong "it just doesn't work", use extra variables for this,
 191            not the RESULT.
 192
 193            Hide the result only if there is another way to check for failure! */
 194
 195 class iStaticServiceInformation: public iObject
 196 {
 197 #ifdef SWIG
 198         iStaticServiceInformation();
 199         ~iStaticServiceInformation();
 200 #endif
 201 public:
 202         virtual SWIG_VOID(RESULT) getName(const eServiceReference &ref, std::string &SWIG_OUTPUT)=0;
 203
 204                 // doesn't need to be implemented, should return -1 then.
 205         virtual int getLength(const eServiceReference &ref);
 206         virtual SWIG_VOID(RESULT) getEvent(const eServiceReference &ref, ePtr<eServiceEvent> &SWIG_OUTPUT, time_t start_time=-1);
 207                 // returns true when not implemented
 208         virtual bool isPlayable(const eServiceReference &ref, const eServiceReference &ignore);
 209
 210         virtual int getInfo(const eServiceReference &ref, int w);
 211         virtual std::string getInfoString(const eServiceReference &ref,int w);
 212 };
 213
 214 TEMPLATE_TYPEDEF(ePtr<iStaticServiceInformation>, iStaticServiceInformationPtr);
 215
 216 TEMPLATE_TYPEDEF(ePtr<eServiceEvent>, eServiceEventPtr);
 217
 218 class iServiceInformation: public iObject
 219 {
 220 #ifdef SWIG
 221         iServiceInformation();
 222         ~iServiceInformation();
 223 #endif
 224 public:
 225         virtual SWIG_VOID(RESULT) getName(std::string &SWIG_OUTPUT)=0;
 226         virtual SWIG_VOID(RESULT) getEvent(ePtr<eServiceEvent> &SWIG_OUTPUT, int nownext);
 227
 228         enum {
 229                 sIsCrypted,  /* is encrypted (no indication if decrypt was possible) */
 230                 sAspect,     /* aspect ratio: 0=4:3, 1=16:9, 2=whatever we need */
 231                 sIsMultichannel, /* multichannel *available* (probably not selected) */
 232
 233                         /* "user serviceable info" - they are not reliable. Don't use them for anything except the service menu!
 234                            that's also the reason why they are so globally defined.
 235
 236
 237                            again - if somebody EVER tries to use this information for anything else than simply displaying it,
 238                            i will change this to return a user-readable text like "zero x zero three three" (and change the
 239                            exact spelling in every version) to stop that!
 240                         */
 241                 sVideoPID,
 242                 sAudioPID,
 243                 sPCRPID,
 244                 sPMTPID,
 245                 sTXTPID,
 246
 247                 sSID,
 248                 sONID,
 249                 sTSID,
 250                 sNamespace,
 251                 sProvider,
 252
 253                 sDescription,
 254                 sTimeCreate,    // unix time or string
 255
 256                 sTitle,
 257                 sArtist,
 258                 sAlbum,
 259                 sComment,
 260                 sTracknumber,
 261                 sGenre,
 262         };
 263         enum { resNA = -1, resIsString = -2 };
 264
 265         virtual int getInfo(int w);
 266         virtual std::string getInfoString(int w);
 267 };
 268
 269 TEMPLATE_TYPEDEF(ePtr<iServiceInformation>, iServiceInformationPtr);
 270
 271 class iFrontendStatusInformation: public iObject
 272 {
 273 #ifdef SWIG
 274         iFrontendStatusInformation();
 275         ~iFrontendStatusInformation();
 276 #endif
 277 public:
 278         enum {
 279                 bitErrorRate,
 280                 signalPower,
 281                 signalQuality,
 282                 LockState,
 283                 SyncState
 284         };
 285         virtual int getFrontendInfo(int w)=0;
 286         virtual PyObject *getFrontendData(bool original=false)=0;
 287 };
 288
 289 TEMPLATE_TYPEDEF(ePtr<iFrontendStatusInformation>, iFrontendStatusInformationPtr);
 290
 291 class iPauseableService: public iObject
 292 {
 293 #ifdef SWIG
 294         iPausableService();
 295         ~iPausableService();
 296 #endif
 297 public:
 298         virtual RESULT pause()=0;
 299         virtual RESULT unpause()=0;
 300
 301                 /* hm. */
 302         virtual RESULT setSlowMotion(int ratio=0)=0;
 303         virtual RESULT setFastForward(int ratio=0)=0;
 304 };
 305
 306 TEMPLATE_TYPEDEF(ePtr<iPauseableService>, iPauseableServicePtr);
 307
 308 class iSeekableService: public iObject
 309 {
 310 #ifdef SWIG
 311         iSeekableService();
 312         ~iSeekableService();
 313 #endif
 314 public:
 315         virtual RESULT getLength(pts_t &SWIG_OUTPUT)=0;
 316         virtual RESULT seekTo(pts_t to)=0;
 317         enum { dirForward = +1, dirBackward = -1 };
 318         virtual RESULT seekRelative(int direction, pts_t to)=0;
 319         virtual RESULT getPlayPosition(pts_t &SWIG_OUTPUT)=0;
 320                 /* if you want to do several seeks in a row, you can enable the trickmode.
 321                    audio will be switched off, sync will be disabled etc. */
 322         virtual RESULT setTrickmode(int trick=0)=0;
 323         virtual RESULT isCurrentlySeekable()=0;
 324 };
 325
 326 TEMPLATE_TYPEDEF(ePtr<iSeekableService>, iSeekableServicePtr);
 327
 328 struct iAudioTrackInfo
 329 {
 330 #ifdef SWIG
 331 private:
 332         iAudioTrackInfo();
 333         ~iAudioTrackInfo();
 334 public:
 335 #endif
 336 #ifndef SWIG
 337         std::string m_description;
 338         std::string m_language; /* iso639 */
 339 #endif
 340         std::string getDescription() { return m_description; }
 341         std::string getLanguage() { return m_language; }
 342 };
 343
 344 SWIG_ALLOW_OUTPUT_SIMPLE(iAudioTrackInfo);
 345
 346 class iAudioTrackSelection: public iObject
 347 {
 348 #ifdef SWIG
 349         iAudioTrackSelection();
 350         ~iAudioTrackSelection();
 351 #endif
 352 public:
 353         virtual int getNumberOfTracks()=0;
 354         virtual RESULT selectTrack(unsigned int i)=0;
 355         virtual SWIG_VOID(RESULT) getTrackInfo(struct iAudioTrackInfo &SWIG_OUTPUT, unsigned int n)=0;
 356 };
 357
 358 TEMPLATE_TYPEDEF(ePtr<iAudioTrackSelection>, iAudioTrackSelectionPtr);
 359
 360 class iSubserviceList: public iObject
 361 {
 362 #ifdef SWIG
 363         iSubserviceList();
 364         ~iSubserviceList();
 365 #endif
 366 public:
 367         virtual int getNumberOfSubservices()=0;
 368         virtual SWIG_VOID(RESULT) getSubservice(eServiceReference &SWIG_OUTPUT, unsigned int n)=0;
 369 };
 370
 371 TEMPLATE_TYPEDEF(ePtr<iSubserviceList>, iSubserviceListPtr);
 372
 373 class iTimeshiftService: public iObject
 374 {
 375 #ifdef SWIG
 376         iTimeshiftService();
 377         ~iTimeshiftService();
 378 #endif
 379 public:
 380         virtual RESULT startTimeshift()=0;
 381         virtual RESULT stopTimeshift()=0;
 382
 383         virtual int isTimeshiftActive()=0;
 384                         /* this essentially seeks to the relative end of the timeshift buffer */
 385         virtual RESULT activateTimeshift()=0;
 386 };
 387
 388 TEMPLATE_TYPEDEF(ePtr<iTimeshiftService>, iTimeshiftServicePtr);
 389
 390         /* not related to eCueSheet */
 391 class iCueSheet: public iObject
 392 {
 393 #ifdef SWIG
 394         iCueSheet();
 395         ~iCueSheet();
 396 #endif
 397 public:
 398                         /* returns a list of (pts, what)-tuples */
 399         virtual PyObject *getCutList() = 0;
 400         virtual void setCutList(PyObject *list) = 0;
 401         virtual void setCutListEnable(int enable) = 0;
 402         enum { cutIn = 0, cutOut = 1, cutMark = 2 };
 403 };
 404
 405 TEMPLATE_TYPEDEF(ePtr<iCueSheet>, iCueSheetPtr);
 406
 407 class iPlayableService: public iObject
 408 {
 409 #ifdef SWIG
 410         iPlayableService();
 411         ~iPlaybleService();
 412 #endif
 413         friend class iServiceHandler;
 414 public:
 415         enum
 416         {
 417                         /* these first two events are magical, and should only
 418                            be generated if you know what you're doing. */
 419                 evStart,
 420                 evEnd,
 421
 422                 evTuneFailed,
 423                         // when iServiceInformation is implemented:
 424                 evUpdatedEventInfo,
 425                 evUpdatedInfo,
 426
 427                         /* when seek() is implemented: */
 428                 evSeekableStatusChanged, /* for example when timeshifting */
 429
 430                 evEOF,
 431                 evSOF, /* bounced against start of file (when seeking backwards) */
 432
 433                         /* only when cueSheet is implemented */
 434                 evCuesheetChanged,
 435         };
 436         virtual RESULT connectEvent(const Slot2<void,iPlayableService*,int> &event, ePtr<eConnection> &connection)=0;
 437         virtual RESULT start()=0;
 438         virtual RESULT stop()=0;
 439         virtual SWIG_VOID(RESULT) seek(ePtr<iSeekableService> &SWIG_OUTPUT)=0;
 440         virtual SWIG_VOID(RESULT) pause(ePtr<iPauseableService> &SWIG_OUTPUT)=0;
 441         virtual SWIG_VOID(RESULT) info(ePtr<iServiceInformation> &SWIG_OUTPUT)=0;
 442         virtual SWIG_VOID(RESULT) audioTracks(ePtr<iAudioTrackSelection> &SWIG_OUTPUT)=0;
 443         virtual SWIG_VOID(RESULT) subServices(ePtr<iSubserviceList> &SWIG_OUTPUT)=0;
 444         virtual SWIG_VOID(RESULT) frontendStatusInfo(ePtr<iFrontendStatusInformation> &SWIG_OUTPUT)=0;
 445         virtual SWIG_VOID(RESULT) timeshift(ePtr<iTimeshiftService> &SWIG_OUTPUT)=0;
 446         virtual SWIG_VOID(RESULT) cueSheet(ePtr<iCueSheet> &SWIG_OUTPUT)=0;
 447 };
 448
 449 TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
 450
 451 class iRecordableService: public iObject
 452 {
 453 #ifdef SWIG
 454         iRecordableService();
 455         ~iRecordableService();
 456 #endif
 457 public:
 458         virtual RESULT prepare(const char *filename, time_t begTime=-1, time_t endTime=-1, int eit_event_id=-1)=0;
 459         virtual RESULT start()=0;
 460         virtual RESULT stop()=0;
 461 };
 462
 463 TEMPLATE_TYPEDEF(ePtr<iRecordableService>, iRecordableServicePtr);
 464
 465 // TEMPLATE_TYPEDEF(std::list<eServiceReference>, eServiceReferenceList);
 466
 467 class iMutableServiceList: public iObject
 468 {
 469 #ifdef SWIG
 470         iMutableServiceList();
 471         ~iMutableServiceList();
 472 #endif
 473 public:
 474                 /* flush changes */
 475         virtual RESULT flushChanges()=0;
 476                 /* adds a service to a list */
 477         virtual RESULT addService(eServiceReference &ref)=0;
 478                 /* removes a service from a list */
 479         virtual RESULT removeService(eServiceReference &ref)=0;
 480                 /* moves a service in a list, only if list suppports a specific sort method. */
 481                 /* pos is the new, absolute position from 0..size-1 */
 482         virtual RESULT moveService(eServiceReference &ref, int pos)=0;
 483                 /* set name of list, for bouquets this is the visible bouquet name */
 484         virtual RESULT setListName(const std::string &name)=0;
 485 };
 486
 487 TEMPLATE_TYPEDEF(ePtr<iMutableServiceList>, iMutableServiceListPtr);
 488
 489 class iListableService: public iObject
 490 {
 491 #ifdef SWIG
 492         iListableService();
 493         ~iListableService();
 494 #endif
 495 public:
 496                 /* legacy interface: get a list */
 497         virtual RESULT getContent(std::list<eServiceReference> &list, bool sorted=false)=0;
 498         virtual RESULT getContent(PyObject *list, bool sorted=false)=0;
 499
 500                 /* new, shiny interface: streaming. */
 501         virtual SWIG_VOID(RESULT) getNext(eServiceReference &SWIG_OUTPUT)=0;
 502
 503                 /* use this for sorting. output is not sorted because of either
 504                  - performance reasons: the whole list must be buffered or
 505                  - the interface would be restricted to a list. streaming
 506                    (as well as a future "active" extension) won't be possible.
 507                 */
 508         virtual int compareLessEqual(const eServiceReference &, const eServiceReference &)=0;
 509
 510         virtual SWIG_VOID(RESULT) startEdit(ePtr<iMutableServiceList> &SWIG_OUTPUT)=0;
 511 };
 512
 513 TEMPLATE_TYPEDEF(ePtr<iListableService>, iListableServicePtr);
 514
 515 #ifndef SWIG
 516         /* a helper class which can be used as argument to stl's sort(). */
 517 class iListableServiceCompare
 518 {
 519         ePtr<iListableService> m_list;
 520 public:
 521         iListableServiceCompare(iListableService *list): m_list(list) { }
 522         bool operator()(const eServiceReference &a, const eServiceReference &b)
 523         {
 524                 return m_list->compareLessEqual(a, b);
 525         }
 526 };
 527 #endif
 528
 529 class iServiceOfflineOperations: public iObject
 530 {
 531 #ifdef SWIG
 532         iServiceOfflineOperations();
 533         ~iServiceOfflineOperations();
 534 #endif
 535 public:
 536                 /* to delete a service, forever. */
 537         virtual RESULT deleteFromDisk(int simulate=1)=0;
 538
 539                 /* for transferring a service... */
 540         virtual SWIG_VOID(RESULT) getListOfFilenames(std::list<std::string> &SWIG_OUTPUT)=0;
 541
 542                 // TODO: additional stuff, like a conversion interface?
 543 };
 544
 545 TEMPLATE_TYPEDEF(ePtr<iServiceOfflineOperations>, iServiceOfflineOperationsPtr);
 546
 547 class iServiceHandler: public iObject
 548 {
 549 #ifdef SWIG
 550         iServiceHandler();
 551         ~iServiceHandler();
 552 #endif
 553 public:
 554         virtual SWIG_VOID(RESULT) play(const eServiceReference &, ePtr<iPlayableService> &SWIG_OUTPUT)=0;
 555         virtual SWIG_VOID(RESULT) record(const eServiceReference &, ePtr<iRecordableService> &SWIG_OUTPUT)=0;
 556         virtual SWIG_VOID(RESULT) list(const eServiceReference &, ePtr<iListableService> &SWIG_OUTPUT)=0;
 557         virtual SWIG_VOID(RESULT) info(const eServiceReference &, ePtr<iStaticServiceInformation> &SWIG_OUTPUT)=0;
 558         virtual SWIG_VOID(RESULT) offlineOperations(const eServiceReference &, ePtr<iServiceOfflineOperations> &SWIG_OUTPUT)=0;
 559 };
 560
 561 TEMPLATE_TYPEDEF(ePtr<iServiceHandler>, iServiceHandlerPtr);
 562
 563 #endif