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         enum { resNA = -1, resIsString = -2 };
 257
 258         virtual int getInfo(int w);
 259         virtual std::string getInfoString(int w);
 260 };
 261
 262 TEMPLATE_TYPEDEF(ePtr<iServiceInformation>, iServiceInformationPtr);
 263
 264 class iFrontendStatusInformation: public iObject
 265 {
 266 #ifdef SWIG
 267         iFrontendStatusInformation();
 268         ~iFrontendStatusInformation();
 269 #endif
 270 public:
 271         enum {
 272                 bitErrorRate,
 273                 signalPower,
 274                 signalQuality,
 275                 LockState,
 276                 SyncState
 277         };
 278         virtual int getFrontendInfo(int w)=0;
 279         virtual PyObject *getFrontendData(bool original=false)=0;
 280 };
 281
 282 TEMPLATE_TYPEDEF(ePtr<iFrontendStatusInformation>, iFrontendStatusInformationPtr);
 283
 284 class iPauseableService: public iObject
 285 {
 286 #ifdef SWIG
 287         iPausableService();
 288         ~iPausableService();
 289 #endif
 290 public:
 291         virtual RESULT pause()=0;
 292         virtual RESULT unpause()=0;
 293
 294                 /* hm. */
 295         virtual RESULT setSlowMotion(int ratio=0)=0;
 296         virtual RESULT setFastForward(int ratio=0)=0;
 297 };
 298
 299 TEMPLATE_TYPEDEF(ePtr<iPauseableService>, iPauseableServicePtr);
 300
 301 class iSeekableService: public iObject
 302 {
 303 #ifdef SWIG
 304         iSeekableService();
 305         ~iSeekableService();
 306 #endif
 307 public:
 308         virtual RESULT getLength(pts_t &SWIG_OUTPUT)=0;
 309         virtual RESULT seekTo(pts_t to)=0;
 310         enum { dirForward = +1, dirBackward = -1 };
 311         virtual RESULT seekRelative(int direction, pts_t to)=0;
 312         virtual RESULT getPlayPosition(pts_t &SWIG_OUTPUT)=0;
 313                 /* if you want to do several seeks in a row, you can enable the trickmode.
 314                    audio will be switched off, sync will be disabled etc. */
 315         virtual RESULT setTrickmode(int trick=0)=0;
 316         virtual RESULT isCurrentlySeekable()=0;
 317 };
 318
 319 TEMPLATE_TYPEDEF(ePtr<iSeekableService>, iSeekableServicePtr);
 320
 321 struct iAudioTrackInfo
 322 {
 323 #ifdef SWIG
 324 private:
 325         iAudioTrackInfo();
 326         ~iAudioTrackInfo();
 327 public:
 328 #endif
 329 #ifndef SWIG
 330         std::string m_description;
 331         std::string m_language; /* iso639 */
 332 #endif
 333         std::string getDescription() { return m_description; }
 334         std::string getLanguage() { return m_language; }
 335 };
 336
 337 SWIG_ALLOW_OUTPUT_SIMPLE(iAudioTrackInfo);
 338
 339 class iAudioTrackSelection: public iObject
 340 {
 341 #ifdef SWIG
 342         iAudioTrackSelection();
 343         ~iAudioTrackSelection();
 344 #endif
 345 public:
 346         virtual int getNumberOfTracks()=0;
 347         virtual RESULT selectTrack(unsigned int i)=0;
 348         virtual SWIG_VOID(RESULT) getTrackInfo(struct iAudioTrackInfo &SWIG_OUTPUT, unsigned int n)=0;
 349 };
 350
 351 TEMPLATE_TYPEDEF(ePtr<iAudioTrackSelection>, iAudioTrackSelectionPtr);
 352
 353 class iSubserviceList: public iObject
 354 {
 355 #ifdef SWIG
 356         iSubserviceList();
 357         ~iSubserviceList();
 358 #endif
 359 public:
 360         virtual int getNumberOfSubservices()=0;
 361         virtual SWIG_VOID(RESULT) getSubservice(eServiceReference &SWIG_OUTPUT, unsigned int n)=0;
 362 };
 363
 364 TEMPLATE_TYPEDEF(ePtr<iSubserviceList>, iSubserviceListPtr);
 365
 366 class iTimeshiftService: public iObject
 367 {
 368 #ifdef SWIG
 369         iTimeshiftService();
 370         ~iTimeshiftService();
 371 #endif
 372 public:
 373         virtual RESULT startTimeshift()=0;
 374         virtual RESULT stopTimeshift()=0;
 375
 376         virtual int isTimeshiftActive()=0;
 377                         /* this essentially seeks to the relative end of the timeshift buffer */
 378         virtual RESULT activateTimeshift()=0;
 379 };
 380
 381 TEMPLATE_TYPEDEF(ePtr<iTimeshiftService>, iTimeshiftServicePtr);
 382
 383         /* not related to eCueSheet */
 384 class iCueSheet: public iObject
 385 {
 386 #ifdef SWIG
 387         iCueSheet();
 388         ~iCueSheet();
 389 #endif
 390 public:
 391                         /* returns a list of (pts, what)-tuples */
 392         virtual PyObject *getCutList() = 0;
 393         virtual void setCutList(PyObject *list) = 0;
 394         virtual void setCutListEnable(int enable) = 0;
 395         enum { cutIn = 0, cutOut = 1, cutMark = 2 };
 396 };
 397
 398 TEMPLATE_TYPEDEF(ePtr<iCueSheet>, iCueSheetPtr);
 399
 400 class iPlayableService: public iObject
 401 {
 402 #ifdef SWIG
 403         iPlayableService();
 404         ~iPlaybleService();
 405 #endif
 406         friend class iServiceHandler;
 407 public:
 408         enum
 409         {
 410                         /* these first two events are magical, and should only
 411                            be generated if you know what you're doing. */
 412                 evStart,
 413                 evEnd,
 414
 415                 evTuneFailed,
 416                         // when iServiceInformation is implemented:
 417                 evUpdatedEventInfo,
 418                 evUpdatedInfo,
 419
 420                         /* when seek() is implemented: */
 421                 evSeekableStatusChanged, /* for example when timeshifting */
 422
 423                 evEOF,
 424                 evSOF, /* bounced against start of file (when seeking backwards) */
 425
 426                         /* only when cueSheet is implemented */
 427                 evCuesheetChanged,
 428         };
 429         virtual RESULT connectEvent(const Slot2<void,iPlayableService*,int> &event, ePtr<eConnection> &connection)=0;
 430         virtual RESULT start()=0;
 431         virtual RESULT stop()=0;
 432         virtual SWIG_VOID(RESULT) seek(ePtr<iSeekableService> &SWIG_OUTPUT)=0;
 433         virtual SWIG_VOID(RESULT) pause(ePtr<iPauseableService> &SWIG_OUTPUT)=0;
 434         virtual SWIG_VOID(RESULT) info(ePtr<iServiceInformation> &SWIG_OUTPUT)=0;
 435         virtual SWIG_VOID(RESULT) audioTracks(ePtr<iAudioTrackSelection> &SWIG_OUTPUT)=0;
 436         virtual SWIG_VOID(RESULT) subServices(ePtr<iSubserviceList> &SWIG_OUTPUT)=0;
 437         virtual SWIG_VOID(RESULT) frontendStatusInfo(ePtr<iFrontendStatusInformation> &SWIG_OUTPUT)=0;
 438         virtual SWIG_VOID(RESULT) timeshift(ePtr<iTimeshiftService> &SWIG_OUTPUT)=0;
 439         virtual SWIG_VOID(RESULT) cueSheet(ePtr<iCueSheet> &SWIG_OUTPUT)=0;
 440 };
 441
 442 TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
 443
 444 class iRecordableService: public iObject
 445 {
 446 #ifdef SWIG
 447         iRecordableService();
 448         ~iRecordableService();
 449 #endif
 450 public:
 451         virtual RESULT prepare(const char *filename, time_t begTime=-1, time_t endTime=-1, int eit_event_id=-1)=0;
 452         virtual RESULT start()=0;
 453         virtual RESULT stop()=0;
 454 };
 455
 456 TEMPLATE_TYPEDEF(ePtr<iRecordableService>, iRecordableServicePtr);
 457
 458 // TEMPLATE_TYPEDEF(std::list<eServiceReference>, eServiceReferenceList);
 459
 460 class iMutableServiceList: public iObject
 461 {
 462 #ifdef SWIG
 463         iMutableServiceList();
 464         ~iMutableServiceList();
 465 #endif
 466 public:
 467                 /* flush changes */
 468         virtual RESULT flushChanges()=0;
 469                 /* adds a service to a list */
 470         virtual RESULT addService(eServiceReference &ref)=0;
 471                 /* removes a service from a list */
 472         virtual RESULT removeService(eServiceReference &ref)=0;
 473                 /* moves a service in a list, only if list suppports a specific sort method. */
 474                 /* pos is the new, absolute position from 0..size-1 */
 475         virtual RESULT moveService(eServiceReference &ref, int pos)=0;
 476                 /* set name of list, for bouquets this is the visible bouquet name */
 477         virtual RESULT setListName(const std::string &name)=0;
 478 };
 479
 480 TEMPLATE_TYPEDEF(ePtr<iMutableServiceList>, iMutableServiceListPtr);
 481
 482 class iListableService: public iObject
 483 {
 484 #ifdef SWIG
 485         iListableService();
 486         ~iListableService();
 487 #endif
 488 public:
 489                 /* legacy interface: get a list */
 490         virtual RESULT getContent(std::list<eServiceReference> &list, bool sorted=false)=0;
 491         virtual RESULT getContent(PyObject *list, bool sorted=false)=0;
 492
 493                 /* new, shiny interface: streaming. */
 494         virtual SWIG_VOID(RESULT) getNext(eServiceReference &SWIG_OUTPUT)=0;
 495
 496                 /* use this for sorting. output is not sorted because of either
 497                  - performance reasons: the whole list must be buffered or
 498                  - the interface would be restricted to a list. streaming
 499                    (as well as a future "active" extension) won't be possible.
 500                 */
 501         virtual int compareLessEqual(const eServiceReference &, const eServiceReference &)=0;
 502
 503         virtual SWIG_VOID(RESULT) startEdit(ePtr<iMutableServiceList> &SWIG_OUTPUT)=0;
 504 };
 505
 506 TEMPLATE_TYPEDEF(ePtr<iListableService>, iListableServicePtr);
 507
 508 #ifndef SWIG
 509         /* a helper class which can be used as argument to stl's sort(). */
 510 class iListableServiceCompare
 511 {
 512         ePtr<iListableService> m_list;
 513 public:
 514         iListableServiceCompare(iListableService *list): m_list(list) { }
 515         bool operator()(const eServiceReference &a, const eServiceReference &b)
 516         {
 517                 return m_list->compareLessEqual(a, b);
 518         }
 519 };
 520 #endif
 521
 522 class iServiceOfflineOperations: public iObject
 523 {
 524 #ifdef SWIG
 525         iServiceOfflineOperations();
 526         ~iServiceOfflineOperations();
 527 #endif
 528 public:
 529                 /* to delete a service, forever. */
 530         virtual RESULT deleteFromDisk(int simulate=1)=0;
 531
 532                 /* for transferring a service... */
 533         virtual SWIG_VOID(RESULT) getListOfFilenames(std::list<std::string> &SWIG_OUTPUT)=0;
 534
 535                 // TODO: additional stuff, like a conversion interface?
 536 };
 537
 538 TEMPLATE_TYPEDEF(ePtr<iServiceOfflineOperations>, iServiceOfflineOperationsPtr);
 539
 540 class iServiceHandler: public iObject
 541 {
 542 #ifdef SWIG
 543         iServiceHandler();
 544         ~iServiceHandler();
 545 #endif
 546 public:
 547         virtual SWIG_VOID(RESULT) play(const eServiceReference &, ePtr<iPlayableService> &SWIG_OUTPUT)=0;
 548         virtual SWIG_VOID(RESULT) record(const eServiceReference &, ePtr<iRecordableService> &SWIG_OUTPUT)=0;
 549         virtual SWIG_VOID(RESULT) list(const eServiceReference &, ePtr<iListableService> &SWIG_OUTPUT)=0;
 550         virtual SWIG_VOID(RESULT) info(const eServiceReference &, ePtr<iStaticServiceInformation> &SWIG_OUTPUT)=0;
 551         virtual SWIG_VOID(RESULT) offlineOperations(const eServiceReference &, ePtr<iServiceOfflineOperations> &SWIG_OUTPUT)=0;
 552 };
 553
 554 TEMPLATE_TYPEDEF(ePtr<iServiceHandler>, iServiceHandlerPtr);
 555
 556 #endif