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