X-Git-Url: http://code.vuplus.com/gitweb/?p=vuplus_dvbapp;a=blobdiff_plain;f=lib%2Fservice%2Fiservice.h;h=54d7b11f29d494aa76b90ab6bc541dde00f10ce5;hp=766d850eb748d3607b7d10c71e00ad00b7ff4ef6;hb=2a6cdce89409dc0275e23523c3807972a82f2cf7;hpb=ba02fb4aced5868d047a5bffbd2ed87583daee4d diff --git a/lib/service/iservice.h b/lib/service/iservice.h index 766d850..54d7b11 100644 --- a/lib/service/iservice.h +++ b/lib/service/iservice.h @@ -1,19 +1,12 @@ #ifndef __lib_dvb_iservice_h #define __lib_dvb_iservice_h +#include #include #include #include #include -#ifdef SWIG -#define TEMPLATE_TYPEDEF(x, y) \ -%template(y) x; \ -typedef x y -#else -#define TEMPLATE_TYPEDEF(x, y) typedef x y -#endif - class eServiceReference { public: @@ -138,17 +131,63 @@ public: } operator bool() const { + return valid(); + } + + int valid() const + { return type != idInvalid; } }; +SWIG_ALLOW_OUTPUT_SIMPLE(eServiceReference); + +typedef unsigned long long pts_t; + + /* the reason we have the servicereference as additional argument is + that we don't have to create one object for every entry in a possibly + large list, provided that no state information is nessesary to deliver + the required information. Anyway - ref *must* be the same as the argument + to the info() or getIServiceInformation call! */ + + /* About the usage of SWIG_VOID: + SWIG_VOID(real_returntype_t) hides a return value from swig. This is used for + the "superflouus" RESULT return values. + + Python code has to check the returned pointer against 0. This works, + as all functions returning instances in smartpointers AND having a + RESULT have to BOTH return non-zero AND set the pointer to zero. + + Python code thus can't check for the reason, but the reason isn't + user-servicable anyway. If you want to return a real reason which + goes beyong "it just doesn't work", use extra variables for this, + not the RESULT. + + Hide the result only if there is another way to check for failure! */ + +class iStaticServiceInformation: public iObject +{ +public: + virtual SWIG_VOID(RESULT) getName(const eServiceReference &ref, std::string &SWIG_OUTPUT)=0; + + // doesn't need to be implemented, should return -1 then. + virtual int getLength(const eServiceReference &ref)=0; +}; + +TEMPLATE_TYPEDEF(ePtr, iStaticServiceInformationPtr); + +class eServiceEvent; + +TEMPLATE_TYPEDEF(ePtr, eServiceEventPtr); + class iServiceInformation: public iObject { public: - virtual RESULT getName(std::string &name)=0; + virtual SWIG_VOID(RESULT) getName(std::string &SWIG_OUTPUT)=0; + virtual SWIG_VOID(RESULT) getEvent(ePtr &SWIG_OUTPUT, int nownext); }; -typedef ePtr iServiceInformationPtr; +TEMPLATE_TYPEDEF(ePtr, iServiceInformationPtr); class iPauseableService: public iObject { @@ -157,7 +196,17 @@ public: virtual RESULT unpause()=0; }; -typedef ePtr iPauseableServicePtr; +TEMPLATE_TYPEDEF(ePtr, iPauseableServicePtr); + +class iSeekableService: public iObject +{ +public: + virtual RESULT getLength(pts_t &SWIG_OUTPUT)=0; + virtual RESULT seekTo(pts_t to)=0; + virtual RESULT getPlayPosition(pts_t &SWIG_OUTPUT)=0; +}; + +TEMPLATE_TYPEDEF(ePtr, iSeekableServicePtr); class iPlayableService: public iObject { @@ -166,13 +215,17 @@ public: enum { evStart, - evEnd + evEnd, + + // when iServiceInformation is implemented: + evUpdatedEventInfo }; virtual RESULT connectEvent(const Slot2 &event, ePtr &connection)=0; virtual RESULT start()=0; virtual RESULT stop()=0; - virtual RESULT getIPausableService(ePtr &ptr)=0; - virtual RESULT getIServiceInformation(ePtr &ptr)=0; + virtual SWIG_VOID(RESULT) seek(ePtr &SWIG_OUTPUT)=0; + virtual SWIG_VOID(RESULT) pause(ePtr &SWIG_OUTPUT)=0; + virtual SWIG_VOID(RESULT) info(ePtr &SWIG_OUTPUT)=0; }; TEMPLATE_TYPEDEF(ePtr, iPlayableServicePtr); @@ -180,31 +233,49 @@ TEMPLATE_TYPEDEF(ePtr, iPlayableServicePtr); class iRecordableService: public iObject { public: + virtual RESULT prepare()=0; virtual RESULT start()=0; virtual RESULT stop()=0; }; -typedef ePtr iRecordableServicePtr; +TEMPLATE_TYPEDEF(ePtr, iRecordableServicePtr); // TEMPLATE_TYPEDEF(std::list, eServiceReferenceList); -typedef std::list eServiceReferenceList; class iListableService: public iObject { public: + /* legacy interface: get a list */ virtual RESULT getContent(std::list &list)=0; + + /* new, shiny interface: streaming. */ + virtual SWIG_VOID(RESULT) getNext(eServiceReference &SWIG_OUTPUT)=0; }; TEMPLATE_TYPEDEF(ePtr, iListableServicePtr); +class iServiceOfflineOperations: public iObject +{ +public: + /* to delete a service, forever. */ + virtual RESULT deleteFromDisk(int simulate=1)=0; + + /* for transferring a service... */ + virtual SWIG_VOID(RESULT) getListOfFilenames(std::list &SWIG_OUTPUT)=0; + + // TODO: additional stuff, like a conversion interface? +}; + class iServiceHandler: public iObject { public: - virtual RESULT play(const eServiceReference &, ePtr &ptr)=0; - virtual RESULT record(const eServiceReference &, ePtr &ptr)=0; - virtual RESULT list(const eServiceReference &, ePtr &ptr)=0; + virtual SWIG_VOID(RESULT) play(const eServiceReference &, ePtr &SWIG_OUTPUT)=0; + virtual SWIG_VOID(RESULT) record(const eServiceReference &, ePtr &SWIG_OUTPUT)=0; + virtual SWIG_VOID(RESULT) list(const eServiceReference &, ePtr &SWIG_OUTPUT)=0; + virtual SWIG_VOID(RESULT) info(const eServiceReference &, ePtr &SWIG_OUTPUT)=0; + virtual SWIG_VOID(RESULT) offlineOperations(const eServiceReference &, ePtr &SWIG_OUTPUT)=0; }; -typedef ePtr iServiceHandlerPtr; +TEMPLATE_TYPEDEF(ePtr, iServiceHandlerPtr); #endif