removed thedoc's colors because of broken network setup

[enigma2.git] / lib / service / iservice.h

diff --git a/lib/service/iservice.h b/lib/service/iservice.h
index 9eeb07c8ba5be48b9312a98a11e2099e2e01a63a..4a19378c5dba74fe9d82d39b73f15f563bac22f6 100644 (file)
--- a/lib/service/iservice.h
+++ b/lib/service/iservice.h
@@ -1,8 +1,9 @@
 #ifndef __lib_dvb_iservice_h
 #define __lib_dvb_iservice_h
 
+#include <lib/python/swig.h>
 #include <lib/base/object.h>
-#include <lib/base/estring.h>
+#include <string>
 #include <connection.h>
 #include <list>
 
@@ -41,7 +42,7 @@ public:
        inline int getSortKey() const { return (flags & hasSortKey) ? data[3] : ((flags & sort1) ? 1 : 0); }
 
        int data[8];
-       eString path;
+       std::string path;
 
        eServiceReference()
                : type(idInvalid), flags(0)
@@ -93,13 +94,13 @@ public:
                data[3]=data3;
                data[4]=data4;
        }
-       eServiceReference(int type, int flags, const eString &path)
+       eServiceReference(int type, int flags, const std::string &path)
                : type(type), flags(flags), path(path)
        {
                memset(data, 0, sizeof(data));
        }
-       eServiceReference(const eString &string);
-       eString toString() const;
+       eServiceReference(const std::string &string);
+       std::string toString() const;
        bool operator==(const eServiceReference &c) const
        {
                if (type != c.type)
@@ -134,54 +135,114 @@ public:
        }
 };
 
-class iServiceInformation: public virtual iObject
+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! */
+class iStaticServiceInformation: public iObject
+{
+public:
+       virtual RESULT getName(const eServiceReference &ref, std::string &name)=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<iStaticServiceInformation>, iStaticServiceInformationPtr);
+
+class eServiceEvent;
+
+class iServiceInformation: public iObject
 {
 public:
-       virtual RESULT getName(eString &name)=0;
+       virtual RESULT getName(std::string &name)=0;
+               // FOR SWIG
+       std::string getName() { std::string temp; getName(temp); return temp; }
+       virtual RESULT getEvent(ePtr<eServiceEvent> &evt, int nownext);
 };
 
-class iPauseableService: public virtual iObject
+TEMPLATE_TYPEDEF(ePtr<iServiceInformation>, iServiceInformationPtr);
+
+class iPauseableService: public iObject
 {
 public:
        virtual RESULT pause()=0;
        virtual RESULT unpause()=0;
 };
 
-class iPlayableService: public virtual iObject
+TEMPLATE_TYPEDEF(ePtr<iPauseableService>, 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<iSeekableService>, iSeekableServicePtr);
+
+class iPlayableService: public iObject
 {
        friend class iServiceHandler;
 public:
        enum
        {
                evStart,
-               evEnd
+               evEnd,
+               
+               // when iServiceInformation is implemented:
+               evUpdatedEventInfo
        };
        virtual RESULT connectEvent(const Slot2<void,iPlayableService*,int> &event, ePtr<eConnection> &connection)=0;
        virtual RESULT start()=0;
        virtual RESULT stop()=0;
-       virtual RESULT getIPausableService(ePtr<iPauseableService> &ptr)=0;
-       virtual RESULT getIServiceInformation(ePtr<iServiceInformation> &ptr)=0;
+       virtual RESULT seek(ePtr<iSeekableService> &ptr)=0;
+       virtual RESULT pause(ePtr<iPauseableService> &ptr)=0;
+       virtual RESULT info(ePtr<iServiceInformation> &ptr)=0;
 };
 
-class iRecordableService: public virtual iObject
+TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
+
+class iRecordableService: public iObject
 {
 public:
+       virtual RESULT prepare()=0;
        virtual RESULT start()=0;
        virtual RESULT stop()=0;
 };
 
-class iListableService: public virtual iObject
+TEMPLATE_TYPEDEF(ePtr<iRecordableService>, iRecordableServicePtr);
+
+// TEMPLATE_TYPEDEF(std::list<eServiceReference>, eServiceReferenceList);
+
+class iListableService: public iObject
 {
 public:
+               /* legacy interface: get a list */
        virtual RESULT getContent(std::list<eServiceReference> &list)=0;
+       
+               /* new, shiny interface: streaming. */
+       virtual RESULT getNext(eServiceReference &ptr)=0;
 };
 
-class iServiceHandler: public virtual iObject
+TEMPLATE_TYPEDEF(ePtr<iListableService>, iListableServicePtr);
+
+class iServiceHandler: public iObject
 {
 public:
        virtual RESULT play(const eServiceReference &, ePtr<iPlayableService> &ptr)=0;
        virtual RESULT record(const eServiceReference &, ePtr<iRecordableService> &ptr)=0;
        virtual RESULT list(const eServiceReference &, ePtr<iListableService> &ptr)=0;
+       virtual RESULT info(const eServiceReference &, ePtr<iStaticServiceInformation> &ptr);
 };
 
+TEMPLATE_TYPEDEF(ePtr<iServiceHandler>, iServiceHandlerPtr);
+
 #endif