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