X-Git-Url: https://git.cweiske.de/enigma2.git/blobdiff_plain/fe813cde98c0c550137b47dd7a75ec2d4d9e6f34..14ae9c7897eaefad5caa0cecda762b0a8a9e9d72:/lib/service/iservice.h diff --git a/lib/service/iservice.h b/lib/service/iservice.h index 61695a91..b7b34fe2 100644 --- a/lib/service/iservice.h +++ b/lib/service/iservice.h @@ -1,6 +1,7 @@ #ifndef __lib_dvb_iservice_h #define __lib_dvb_iservice_h +#include #include #include #include @@ -43,6 +44,10 @@ public: int data[8]; std::string path; +// only for override service names in bouquets or to give servicerefs a name which not have a +// real existing service ( for dvb eServiceDVB ) + std::string name; + eServiceReference() : type(idInvalid), flags(0) { @@ -104,7 +109,7 @@ public: { if (type != c.type) return 0; - return /* (flags == c.flags) && */ (memcmp(data, c.data, sizeof(int)*8)==0) && (path == c.path); + return (memcmp(data, c.data, sizeof(int)*8)==0) && (path == c.path); } bool operator!=(const eServiceReference &c) const { @@ -117,11 +122,6 @@ public: if (type > c.type) return 0; - -/* if (flags < c.flags) - return 1; - if (flags > c.flags) - return 0; */ int r=memcmp(data, c.data, sizeof(int)*8); if (r) @@ -129,41 +129,61 @@ public: return path < c.path; } operator bool() const + { + return valid(); + } + + int valid() const { return type != idInvalid; } }; -typedef unsigned long long pts_t; +SWIG_ALLOW_OUTPUT_SIMPLE(eServiceReference); + +typedef 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 RESULT getName(const eServiceReference &ref, std::string &name)=0; + 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; - - // FOR SWIG - std::string getName(const eServiceReference &ref) { std::string temp; getName(ref, temp); return temp; } }; TEMPLATE_TYPEDEF(ePtr, iStaticServiceInformationPtr); class eServiceEvent; +TEMPLATE_TYPEDEF(ePtr, eServiceEventPtr); + class iServiceInformation: public iObject { public: - virtual RESULT getName(std::string &name)=0; - // FOR SWIG - std::string getName() { std::string temp; getName(temp); return temp; } - virtual RESULT getEvent(ePtr &evt, int nownext); + virtual SWIG_VOID(RESULT) getName(std::string &SWIG_OUTPUT)=0; + virtual SWIG_VOID(RESULT) getEvent(ePtr &SWIG_OUTPUT, int nownext); }; TEMPLATE_TYPEDEF(ePtr, iServiceInformationPtr); @@ -177,6 +197,36 @@ public: TEMPLATE_TYPEDEF(ePtr, iPauseableServicePtr); +class iSeekableService: public iObject +{ +public: + virtual RESULT getLength(pts_t &SWIG_OUTPUT)=0; + virtual RESULT seekTo(pts_t to)=0; + enum { dirForward = +1, dirBackward = -1 }; + virtual RESULT seekRelative(int direction, pts_t to)=0; + virtual RESULT getPlayPosition(pts_t &SWIG_OUTPUT)=0; +}; + +TEMPLATE_TYPEDEF(ePtr, iSeekableServicePtr); + +struct iAudioTrackInfo +{ + std::string m_description; + std::string getDescription() { return m_description; } +}; + +SWIG_ALLOW_OUTPUT_SIMPLE(iAudioTrackInfo); + +class iAudioTrackSelection: public iObject +{ +public: + virtual int getNumberOfTracks()=0; + virtual RESULT selectTrack(unsigned int i)=0; + virtual SWIG_VOID(RESULT) getTrackInfo(struct iAudioTrackInfo &SWIG_OUTPUT, unsigned int n)=0; +}; + +TEMPLATE_TYPEDEF(ePtr, iAudioTrackSelectionPtr); + class iPlayableService: public iObject { friend class iServiceHandler; @@ -186,14 +236,17 @@ public: evStart, evEnd, + evTuneFailed, // when iServiceInformation is implemented: evUpdatedEventInfo }; virtual RESULT connectEvent(const Slot2 &event, ePtr &connection)=0; virtual RESULT start()=0; virtual RESULT stop()=0; - virtual RESULT pause(ePtr &ptr)=0; - virtual RESULT info(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; + virtual SWIG_VOID(RESULT) audioTracks(ePtr &SWIG_OUTPUT)=0; }; TEMPLATE_TYPEDEF(ePtr, iPlayableServicePtr); @@ -201,7 +254,7 @@ TEMPLATE_TYPEDEF(ePtr, iPlayableServicePtr); class iRecordableService: public iObject { public: - virtual RESULT prepare()=0; + virtual RESULT prepare(const char *filename)=0; virtual RESULT start()=0; virtual RESULT stop()=0; }; @@ -210,6 +263,22 @@ TEMPLATE_TYPEDEF(ePtr, iRecordableServicePtr); // TEMPLATE_TYPEDEF(std::list, eServiceReferenceList); +class iMutableServiceList: public iObject +{ +public: + /* flush changes */ + virtual RESULT flushChanges()=0; + /* adds a service to a list */ + virtual RESULT addService(eServiceReference &ref)=0; + /* removes a service from a list */ + virtual RESULT removeService(eServiceReference &ref)=0; + /* moves a service in a list, only if list suppports a specific sort method. */ + /* pos is the new, absolute position from 0..size-1 */ + virtual RESULT moveService(eServiceReference &ref, int pos)=0; +}; + +TEMPLATE_TYPEDEF(ePtr, iMutableServiceListPtr); + class iListableService: public iObject { public: @@ -217,18 +286,54 @@ public: virtual RESULT getContent(std::list &list)=0; /* new, shiny interface: streaming. */ - virtual RESULT getNext(eServiceReference &ptr)=0; + virtual SWIG_VOID(RESULT) getNext(eServiceReference &SWIG_OUTPUT)=0; + + /* use this for sorting. output is not sorted because of either + - performance reasons: the whole list must be buffered or + - the interface would be restricted to a list. streaming + (as well as a future "active" extension) won't be possible. + */ + virtual int compareLessEqual(const eServiceReference &, const eServiceReference &)=0; + + virtual SWIG_VOID(RESULT) startEdit(ePtr &SWIG_OUTPUT)=0; }; TEMPLATE_TYPEDEF(ePtr, iListableServicePtr); + /* a helper class which can be used as argument to stl's sort(). */ +class iListableServiceCompare +{ + ePtr m_list; +public: + iListableServiceCompare(iListableService *list): m_list(list) { } + bool operator()(const eServiceReference &a, const eServiceReference &b) + { + return m_list->compareLessEqual(a, b); + } +}; + +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? +}; + +TEMPLATE_TYPEDEF(ePtr, iServiceOfflineOperationsPtr); + 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 RESULT info(const eServiceReference &, ePtr &ptr); + 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; }; TEMPLATE_TYPEDEF(ePtr, iServiceHandlerPtr);