add option no_rotor_command_on_tune to eDVBFrontendParameters.setDVBS to disable

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

diff --git a/lib/service/iservice.h b/lib/service/iservice.h
index 232e66f2872fbae8749d3e7d38abec4dfd291455..822910f9ae4798642e42125b38c245b7627b67f8 100644 (file)
--- a/lib/service/iservice.h
+++ b/lib/service/iservice.h
@@ -2,12 +2,14 @@
 #define __lib_dvb_iservice_h
 
 #include <lib/python/swig.h>
 #define __lib_dvb_iservice_h
 
 #include <lib/python/swig.h>

+#include <lib/python/python.h>

 #include <lib/base/object.h>
 #include <lib/base/object.h>

-#include <lib/service/event.h>

 #include <string>
 #include <connection.h>
 #include <list>
 
 #include <string>
 #include <connection.h>
 #include <list>
 

+class eServiceEvent;
+

 class eServiceReference
 {
 public:
 class eServiceReference
 {
 public:


@@ -21,7 +23,6 @@ public:
        };
        int type;
 
        };
        int type;
 

-       int flags; // flags will NOT be compared.

        enum
        {
                isDirectory=1,          // SHOULD enter  (implies mustDescent)
        enum
        {
                isDirectory=1,          // SHOULD enter  (implies mustDescent)


@@ -39,23 +40,44 @@ public:
                hasSortKey=16,          // has a sort key in data[3]. not having a sort key implies 0.
                sort1=32                                        // sort key is 1 instead of 0
        };
                hasSortKey=16,          // has a sort key in data[3]. not having a sort key implies 0.
                sort1=32                                        // sort key is 1 instead of 0
        };

+       int flags; // flags will NOT be compared.

 
        inline int getSortKey() const { return (flags & hasSortKey) ? data[3] : ((flags & sort1) ? 1 : 0); }
 
 
        inline int getSortKey() const { return (flags & hasSortKey) ? data[3] : ((flags & sort1) ? 1 : 0); }
 

+#ifndef SWIG

        int data[8];
        std::string path;
        int data[8];
        std::string path;

+#endif

        std::string getPath() { return path; }
        std::string getPath() { return path; }

+       void setPath( const std::string &n ) { path=n; }
+
+       int getData(unsigned int num) const
+       {
+               if ( num < sizeof(data)/sizeof(int) )
+                       return data[num];
+               return 0;
+       }
+
+       void setData(unsigned int num, int val)
+       {
+               if ( num < sizeof(data)/sizeof(int) )
+                       data[num] = val;
+       }

 
 // only for override service names in bouquets or to give servicerefs a name which not have a
 // real existing service ( for dvb eServiceDVB )
 
 // only for override service names in bouquets or to give servicerefs a name which not have a
 // real existing service ( for dvb eServiceDVB )

+#ifndef SWIG

        std::string name;
        std::string name;

+#endif

        std::string getName() { return name; }
        std::string getName() { return name; }

+       void setName( const std::string &n ) { name=n; }

 
        eServiceReference()
                : type(idInvalid), flags(0)
        {
 
        eServiceReference()
                : type(idInvalid), flags(0)
        {

+               memset(data, 0, sizeof(data));

        }
        }

-
+#ifndef SWIG

        eServiceReference(int type, int flags)
                : type(type), flags(flags)
        {
        eServiceReference(int type, int flags)
                : type(type), flags(flags)
        {


@@ -106,6 +128,7 @@ public:
        {
                memset(data, 0, sizeof(data));
        }
        {
                memset(data, 0, sizeof(data));
        }

+#endif

        eServiceReference(const std::string &string);
        std::string toString() const;
        bool operator==(const eServiceReference &c) const
        eServiceReference(const std::string &string);
        std::string toString() const;
        bool operator==(const eServiceReference &c) const


@@ -144,6 +167,8 @@ public:
 
 SWIG_ALLOW_OUTPUT_SIMPLE(eServiceReference);
 
 
 SWIG_ALLOW_OUTPUT_SIMPLE(eServiceReference);
 

+extern PyObject *New_eServiceReference(const eServiceReference &ref); // defined in enigma_python.i
+

 typedef long long pts_t;
 
        /* the reason we have the servicereference as additional argument is
 typedef long long pts_t;
 
        /* the reason we have the servicereference as additional argument is


@@ -169,24 +194,33 @@ typedef long long pts_t;
           
 class iStaticServiceInformation: public iObject
 {
           
 class iStaticServiceInformation: public iObject
 {

+#ifdef SWIG
+       iStaticServiceInformation();
+       ~iStaticServiceInformation();
+#endif

 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);
 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);

-       virtual SWIG_VOID(RESULT) getEvent(const eServiceReference &ref, ePtr<eServiceEvent> &SWIG_OUTPUT);
+       virtual SWIG_VOID(RESULT) getEvent(const eServiceReference &ref, ePtr<eServiceEvent> &SWIG_OUTPUT, time_t start_time=-1);

                // returns true when not implemented
        virtual bool isPlayable(const eServiceReference &ref, const eServiceReference &ignore);
                // returns true when not implemented
        virtual bool isPlayable(const eServiceReference &ref, const eServiceReference &ignore);

+
+       virtual int getInfo(const eServiceReference &ref, int w);
+       virtual std::string getInfoString(const eServiceReference &ref,int w);

 };
 
 TEMPLATE_TYPEDEF(ePtr<iStaticServiceInformation>, iStaticServiceInformationPtr);
 
 };
 
 TEMPLATE_TYPEDEF(ePtr<iStaticServiceInformation>, iStaticServiceInformationPtr);
 

-class eServiceEvent;
-

 TEMPLATE_TYPEDEF(ePtr<eServiceEvent>, eServiceEventPtr);
 
 class iServiceInformation: public iObject
 {
 TEMPLATE_TYPEDEF(ePtr<eServiceEvent>, eServiceEventPtr);
 
 class iServiceInformation: public iObject
 {

+#ifdef SWIG
+       iServiceInformation();
+       ~iServiceInformation();
+#endif

 public:
        virtual SWIG_VOID(RESULT) getName(std::string &SWIG_OUTPUT)=0;
        virtual SWIG_VOID(RESULT) getEvent(ePtr<eServiceEvent> &SWIG_OUTPUT, int nownext);
 public:
        virtual SWIG_VOID(RESULT) getName(std::string &SWIG_OUTPUT)=0;
        virtual SWIG_VOID(RESULT) getEvent(ePtr<eServiceEvent> &SWIG_OUTPUT, int nownext);


@@ -215,6 +249,17 @@ public:
                sTSID,
                sNamespace,
                sProvider,
                sTSID,
                sNamespace,
                sProvider,

+               
+               sDescription,
+               sServiceref,
+               sTimeCreate,    // unix time or string
+               
+               sTitle,
+               sArtist,
+               sAlbum,
+               sComment,
+               sTracknumber,
+               sGenre,

        };
        enum { resNA = -1, resIsString = -2 };
 
        };
        enum { resNA = -1, resIsString = -2 };
 


@@ -224,32 +269,75 @@ public:
 
 TEMPLATE_TYPEDEF(ePtr<iServiceInformation>, iServiceInformationPtr);
 
 
 TEMPLATE_TYPEDEF(ePtr<iServiceInformation>, iServiceInformationPtr);
 

+class iFrontendStatusInformation: public iObject
+{
+#ifdef SWIG
+       iFrontendStatusInformation();
+       ~iFrontendStatusInformation();
+#endif
+public:
+       enum {
+               bitErrorRate,
+               signalPower,
+               signalQuality,
+               LockState,
+               SyncState
+       };
+       virtual int getFrontendInfo(int w)=0;
+       virtual PyObject *getFrontendData(bool original=false)=0;
+};
+
+TEMPLATE_TYPEDEF(ePtr<iFrontendStatusInformation>, iFrontendStatusInformationPtr);
+

 class iPauseableService: public iObject
 {
 class iPauseableService: public iObject
 {

+#ifdef SWIG
+       iPausableService();
+       ~iPausableService();
+#endif

 public:
        virtual RESULT pause()=0;
        virtual RESULT unpause()=0;
 public:
        virtual RESULT pause()=0;
        virtual RESULT unpause()=0;

+       
+               /* hm. */
+       virtual RESULT setSlowMotion(int ratio=0)=0;
+       virtual RESULT setFastForward(int ratio=0)=0;

 };
 
 TEMPLATE_TYPEDEF(ePtr<iPauseableService>, iPauseableServicePtr);
 
 class iSeekableService: public iObject
 {
 };
 
 TEMPLATE_TYPEDEF(ePtr<iPauseableService>, iPauseableServicePtr);
 
 class iSeekableService: public iObject
 {

+#ifdef SWIG
+       iSeekableService();
+       ~iSeekableService();
+#endif

 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;
 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;

+               /* if you want to do several seeks in a row, you can enable the trickmode. 
+                  audio will be switched off, sync will be disabled etc. */
+       virtual RESULT setTrickmode(int trick=0)=0;
+       virtual RESULT isCurrentlySeekable()=0;

 };
 
 TEMPLATE_TYPEDEF(ePtr<iSeekableService>, iSeekableServicePtr);
 
 struct iAudioTrackInfo
 {
 };
 
 TEMPLATE_TYPEDEF(ePtr<iSeekableService>, iSeekableServicePtr);
 
 struct iAudioTrackInfo
 {

+#ifdef SWIG
+private:
+       iAudioTrackInfo();
+       ~iAudioTrackInfo();
+public:
+#endif
+#ifndef SWIG

        std::string m_description;
        std::string m_language; /* iso639 */
        std::string m_description;
        std::string m_language; /* iso639 */

-       
+#endif

        std::string getDescription() { return m_description; }
        std::string getLanguage() { return m_language; }
 };
        std::string getDescription() { return m_description; }
        std::string getLanguage() { return m_language; }
 };


@@ -258,6 +346,10 @@ SWIG_ALLOW_OUTPUT_SIMPLE(iAudioTrackInfo);
 
 class iAudioTrackSelection: public iObject
 {
 
 class iAudioTrackSelection: public iObject
 {

+#ifdef SWIG
+       iAudioTrackSelection();
+       ~iAudioTrackSelection();
+#endif

 public:
        virtual int getNumberOfTracks()=0;
        virtual RESULT selectTrack(unsigned int i)=0;
 public:
        virtual int getNumberOfTracks()=0;
        virtual RESULT selectTrack(unsigned int i)=0;


@@ -266,12 +358,65 @@ public:
 
 TEMPLATE_TYPEDEF(ePtr<iAudioTrackSelection>, iAudioTrackSelectionPtr);
 
 
 TEMPLATE_TYPEDEF(ePtr<iAudioTrackSelection>, iAudioTrackSelectionPtr);
 

+class iSubserviceList: public iObject
+{
+#ifdef SWIG
+       iSubserviceList();
+       ~iSubserviceList();
+#endif
+public:
+       virtual int getNumberOfSubservices()=0;
+       virtual SWIG_VOID(RESULT) getSubservice(eServiceReference &SWIG_OUTPUT, unsigned int n)=0;
+};
+
+TEMPLATE_TYPEDEF(ePtr<iSubserviceList>, iSubserviceListPtr);
+
+class iTimeshiftService: public iObject
+{
+#ifdef SWIG
+       iTimeshiftService();
+       ~iTimeshiftService();
+#endif
+public:
+       virtual RESULT startTimeshift()=0;
+       virtual RESULT stopTimeshift()=0;
+       
+       virtual int isTimeshiftActive()=0;
+                       /* this essentially seeks to the relative end of the timeshift buffer */
+       virtual RESULT activateTimeshift()=0;
+};
+
+TEMPLATE_TYPEDEF(ePtr<iTimeshiftService>, iTimeshiftServicePtr);
+
+       /* not related to eCueSheet */
+class iCueSheet: public iObject
+{
+#ifdef SWIG
+       iCueSheet();
+       ~iCueSheet();
+#endif
+public:
+                       /* returns a list of (pts, what)-tuples */
+       virtual PyObject *getCutList() = 0;
+       virtual void setCutList(PyObject *list) = 0;
+       virtual void setCutListEnable(int enable) = 0;
+       enum { cutIn = 0, cutOut = 1, cutMark = 2 };
+};
+
+TEMPLATE_TYPEDEF(ePtr<iCueSheet>, iCueSheetPtr);
+

 class iPlayableService: public iObject
 {
 class iPlayableService: public iObject
 {

+#ifdef SWIG
+       iPlayableService();
+       ~iPlaybleService();
+#endif

        friend class iServiceHandler;
 public:
        enum
        {
        friend class iServiceHandler;
 public:
        enum
        {

+                       /* these first two events are magical, and should only
+                          be generated if you know what you're doing. */

                evStart,
                evEnd,
                
                evStart,
                evEnd,
                


@@ -279,6 +424,15 @@ public:
                        // when iServiceInformation is implemented:
                evUpdatedEventInfo,
                evUpdatedInfo,
                        // when iServiceInformation is implemented:
                evUpdatedEventInfo,
                evUpdatedInfo,

+
+                       /* when seek() is implemented: */               
+               evSeekableStatusChanged, /* for example when timeshifting */
+               
+               evEOF,
+               evSOF, /* bounced against start of file (when seeking backwards) */
+               
+                       /* only when cueSheet is implemented */
+               evCuesheetChanged,

        };
        virtual RESULT connectEvent(const Slot2<void,iPlayableService*,int> &event, ePtr<eConnection> &connection)=0;
        virtual RESULT start()=0;
        };
        virtual RESULT connectEvent(const Slot2<void,iPlayableService*,int> &event, ePtr<eConnection> &connection)=0;
        virtual RESULT start()=0;


@@ -287,14 +441,22 @@ public:
        virtual SWIG_VOID(RESULT) pause(ePtr<iPauseableService> &SWIG_OUTPUT)=0;
        virtual SWIG_VOID(RESULT) info(ePtr<iServiceInformation> &SWIG_OUTPUT)=0;
        virtual SWIG_VOID(RESULT) audioTracks(ePtr<iAudioTrackSelection> &SWIG_OUTPUT)=0;
        virtual SWIG_VOID(RESULT) pause(ePtr<iPauseableService> &SWIG_OUTPUT)=0;
        virtual SWIG_VOID(RESULT) info(ePtr<iServiceInformation> &SWIG_OUTPUT)=0;
        virtual SWIG_VOID(RESULT) audioTracks(ePtr<iAudioTrackSelection> &SWIG_OUTPUT)=0;

+       virtual SWIG_VOID(RESULT) subServices(ePtr<iSubserviceList> &SWIG_OUTPUT)=0;
+       virtual SWIG_VOID(RESULT) frontendStatusInfo(ePtr<iFrontendStatusInformation> &SWIG_OUTPUT)=0;
+       virtual SWIG_VOID(RESULT) timeshift(ePtr<iTimeshiftService> &SWIG_OUTPUT)=0;
+       virtual SWIG_VOID(RESULT) cueSheet(ePtr<iCueSheet> &SWIG_OUTPUT)=0;

 };
 
 TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
 
 class iRecordableService: public iObject
 {
 };
 
 TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
 
 class iRecordableService: public iObject
 {

+#ifdef SWIG
+       iRecordableService();
+       ~iRecordableService();
+#endif

 public:
 public:

-       virtual RESULT prepare(const char *filename)=0;
+       virtual RESULT prepare(const char *filename, time_t begTime=-1, time_t endTime=-1, int eit_event_id=-1)=0;

        virtual RESULT start()=0;
        virtual RESULT stop()=0;
 };
        virtual RESULT start()=0;
        virtual RESULT stop()=0;
 };


@@ -305,6 +467,10 @@ TEMPLATE_TYPEDEF(ePtr<iRecordableService>, iRecordableServicePtr);
 
 class iMutableServiceList: public iObject
 {
 
 class iMutableServiceList: public iObject
 {

+#ifdef SWIG
+       iMutableServiceList();
+       ~iMutableServiceList();
+#endif

 public:
                /* flush changes */
        virtual RESULT flushChanges()=0;
 public:
                /* flush changes */
        virtual RESULT flushChanges()=0;


@@ -315,16 +481,23 @@ public:
                /* 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;
                /* 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;

+               /* set name of list, for bouquets this is the visible bouquet name */
+       virtual RESULT setListName(const std::string &name)=0;

 };
 
 TEMPLATE_TYPEDEF(ePtr<iMutableServiceList>, iMutableServiceListPtr);
 
 class iListableService: public iObject
 {
 };
 
 TEMPLATE_TYPEDEF(ePtr<iMutableServiceList>, iMutableServiceListPtr);
 
 class iListableService: public iObject
 {

+#ifdef SWIG
+       iListableService();
+       ~iListableService();
+#endif

 public:
                /* legacy interface: get a list */
 public:
                /* legacy interface: get a list */

-       virtual RESULT getContent(std::list<eServiceReference> &list)=0;
-       
+       virtual RESULT getContent(std::list<eServiceReference> &list, bool sorted=false)=0;
+       virtual RESULT getContent(PyObject *list, bool sorted=false)=0;
+

                /* new, shiny interface: streaming. */
        virtual SWIG_VOID(RESULT) getNext(eServiceReference &SWIG_OUTPUT)=0;
        
                /* new, shiny interface: streaming. */
        virtual SWIG_VOID(RESULT) getNext(eServiceReference &SWIG_OUTPUT)=0;
        


@@ -340,6 +513,7 @@ public:
 
 TEMPLATE_TYPEDEF(ePtr<iListableService>, iListableServicePtr);
 
 
 TEMPLATE_TYPEDEF(ePtr<iListableService>, iListableServicePtr);
 

+#ifndef SWIG

        /* a helper class which can be used as argument to stl's sort(). */
 class iListableServiceCompare
 {
        /* a helper class which can be used as argument to stl's sort(). */
 class iListableServiceCompare
 {


@@ -351,9 +525,14 @@ public:
                return m_list->compareLessEqual(a, b);
        }
 };
                return m_list->compareLessEqual(a, b);
        }
 };

+#endif

 
 class iServiceOfflineOperations: public iObject
 {
 
 class iServiceOfflineOperations: public iObject
 {

+#ifdef SWIG
+       iServiceOfflineOperations();
+       ~iServiceOfflineOperations();
+#endif

 public:
                /* to delete a service, forever. */
        virtual RESULT deleteFromDisk(int simulate=1)=0;
 public:
                /* to delete a service, forever. */
        virtual RESULT deleteFromDisk(int simulate=1)=0;


@@ -368,6 +547,10 @@ TEMPLATE_TYPEDEF(ePtr<iServiceOfflineOperations>, iServiceOfflineOperationsPtr);
 
 class iServiceHandler: public iObject
 {
 
 class iServiceHandler: public iObject
 {

+#ifdef SWIG
+       iServiceHandler();
+       ~iServiceHandler();
+#endif

 public:
        virtual SWIG_VOID(RESULT) play(const eServiceReference &, ePtr<iPlayableService> &SWIG_OUTPUT)=0;
        virtual SWIG_VOID(RESULT) record(const eServiceReference &, ePtr<iRecordableService> &SWIG_OUTPUT)=0;
 public:
        virtual SWIG_VOID(RESULT) play(const eServiceReference &, ePtr<iPlayableService> &SWIG_OUTPUT)=0;
        virtual SWIG_VOID(RESULT) record(const eServiceReference &, ePtr<iRecordableService> &SWIG_OUTPUT)=0;