add SeekRelative stuff
[enigma2.git] / lib / service / iservice.h
index c58421e..15631fd 100644 (file)
@@ -1,6 +1,7 @@
 #ifndef __lib_dvb_iservice_h
 #define __lib_dvb_iservice_h
 
+#include <lib/python/swig.h>
 #include <lib/base/object.h>
 #include <string>
 #include <connection.h>
@@ -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)
        {
@@ -130,29 +135,60 @@ 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 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;
 };
 
 TEMPLATE_TYPEDEF(ePtr<iStaticServiceInformation>, iStaticServiceInformationPtr);
 
 class eServiceEvent;
 
-class iServiceInformation: public iStaticServiceInformation
+TEMPLATE_TYPEDEF(ePtr<eServiceEvent>, eServiceEventPtr);
+
+class iServiceInformation: public iObject
 {
 public:
-       virtual RESULT getEvent(ePtr<eServiceEvent> &evt, int nownext);
+       virtual SWIG_VOID(RESULT) getName(std::string &SWIG_OUTPUT)=0;
+       virtual SWIG_VOID(RESULT) getEvent(ePtr<eServiceEvent> &SWIG_OUTPUT, int nownext);
 };
 
 TEMPLATE_TYPEDEF(ePtr<iServiceInformation>, iServiceInformationPtr);
@@ -166,6 +202,18 @@ public:
 
 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;
+       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<iSeekableService>, iSeekableServicePtr);
+
 class iPlayableService: public iObject
 {
        friend class iServiceHandler;
@@ -175,14 +223,16 @@ public:
                evStart,
                evEnd,
                
+               evTuneFailed,
                // 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 pause(ePtr<iPauseableService> &ptr)=0;
-       virtual RESULT info(ePtr<iServiceInformation> &ptr)=0;
+       virtual SWIG_VOID(RESULT) seek(ePtr<iSeekableService> &SWIG_OUTPUT)=0;
+       virtual SWIG_VOID(RESULT) pause(ePtr<iPauseableService> &SWIG_OUTPUT)=0;
+       virtual SWIG_VOID(RESULT) info(ePtr<iServiceInformation> &SWIG_OUTPUT)=0;
 };
 
 TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
@@ -190,6 +240,7 @@ TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
 class iRecordableService: public iObject
 {
 public:
+       virtual RESULT prepare(const char *filename)=0;
        virtual RESULT start()=0;
        virtual RESULT stop()=0;
 };
@@ -201,18 +252,56 @@ TEMPLATE_TYPEDEF(ePtr<iRecordableService>, iRecordableServicePtr);
 class iListableService: public iObject
 {
 public:
+               /* legacy interface: get a list */
        virtual RESULT getContent(std::list<eServiceReference> &list)=0;
+       
+               /* new, shiny interface: streaming. */
+       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;
 };
 
 TEMPLATE_TYPEDEF(ePtr<iListableService>, iListableServicePtr);
 
+       /* a helper class which can be used as argument to stl's sort(). */
+class iListableServiceCompare
+{
+       ePtr<iListableService> 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<std::string> &SWIG_OUTPUT)=0;
+       
+               // TODO: additional stuff, like a conversion interface?
+};
+
+TEMPLATE_TYPEDEF(ePtr<iServiceOfflineOperations>, iServiceOfflineOperationsPtr);
+
 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);
+       virtual SWIG_VOID(RESULT) play(const eServiceReference &, ePtr<iPlayableService> &SWIG_OUTPUT)=0;
+       virtual SWIG_VOID(RESULT) record(const eServiceReference &, ePtr<iRecordableService> &SWIG_OUTPUT)=0;
+       virtual SWIG_VOID(RESULT) list(const eServiceReference &, ePtr<iListableService> &SWIG_OUTPUT)=0;
+       virtual SWIG_VOID(RESULT) info(const eServiceReference &, ePtr<iStaticServiceInformation> &SWIG_OUTPUT)=0;
+       virtual SWIG_VOID(RESULT) offlineOperations(const eServiceReference &, ePtr<iServiceOfflineOperations> &SWIG_OUTPUT)=0;
 };
 
 TEMPLATE_TYPEDEF(ePtr<iServiceHandler>, iServiceHandlerPtr);