update ca, sv language
[enigma2.git] / lib / service / iservice.h
index 962e4a95399978909156f11758be6a5b8487868e..71c82ab052775a6f8d6d10b66a48abeedddcfc5e 100644 (file)
@@ -2,6 +2,7 @@
 #define __lib_dvb_iservice_h
 
 #include <lib/python/swig.h>
+#include <lib/python/python.h>
 #include <lib/base/object.h>
 #include <string>
 #include <connection.h>
@@ -22,7 +23,6 @@ public:
        };
        int type;
 
-       int flags; // flags will NOT be compared.
        enum
        {
                isDirectory=1,          // SHOULD enter  (implies mustDescent)
@@ -38,20 +38,52 @@ public:
                flagDirectory=isDirectory|mustDescent|canDescent,
                shouldSort=8,                   // should be ASCII-sorted according to service_name. great for directories.
                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
+               sort1=32,                                       // sort key is 1 instead of 0
+               isMarker=64                     // Marker
        };
+       int flags; // flags will NOT be compared.
 
        inline int getSortKey() const { return (flags & hasSortKey) ? data[3] : ((flags & sort1) ? 1 : 0); }
 
+#ifndef SWIG
        int data[8];
        std::string path;
+#endif
        std::string getPath() { return path; }
+       void setPath( const std::string &n ) { path=n; }
+
+       unsigned int getUnsignedData(unsigned int num) const
+       {
+               if ( num < sizeof(data)/sizeof(int) )
+                       return data[num];
+               return 0;
+       }
+
+       int getData(unsigned int num) const
+       {
+               if ( num < sizeof(data)/sizeof(int) )
+                       return data[num];
+               return 0;
+       }
+
+       void setUnsignedData(unsigned int num, unsigned int val)
+       {
+               if ( num < sizeof(data)/sizeof(int) )
+                       data[num] = val;
+       }
+
+       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 )
+#ifndef SWIG
        std::string name;
+#endif
        std::string getName() { return name; }
-
        void setName( const std::string &n ) { name=n; }
 
        eServiceReference()
@@ -59,6 +91,7 @@ public:
        {
                memset(data, 0, sizeof(data));
        }
+#ifndef SWIG
        eServiceReference(int type, int flags)
                : type(type), flags(flags)
        {
@@ -109,8 +142,10 @@ public:
        {
                memset(data, 0, sizeof(data));
        }
+#endif
        eServiceReference(const std::string &string);
        std::string toString() const;
+       std::string toCompareString() const;
        bool operator==(const eServiceReference &c) const
        {
                if (type != c.type)
@@ -147,6 +182,8 @@ public:
 
 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
@@ -170,29 +207,43 @@ typedef long long pts_t;
           
           Hide the result only if there is another way to check for failure! */
           
+TEMPLATE_TYPEDEF(ePtr<eServiceEvent>, eServiceEventPtr);
+       
 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);
-       virtual SWIG_VOID(RESULT) getEvent(const eServiceReference &ref, ePtr<eServiceEvent> &SWIG_OUTPUT, time_t start_time=0);
+       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);
+
+       virtual int getInfo(const eServiceReference &ref, int w);
+       virtual std::string getInfoString(const eServiceReference &ref,int w);
+
+       virtual int setInfo(const eServiceReference &ref, int w, int v);
+       virtual int setInfoString(const eServiceReference &ref, int w, const char *v);
 };
 
 TEMPLATE_TYPEDEF(ePtr<iStaticServiceInformation>, iStaticServiceInformationPtr);
 
-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);
 
-       enum { 
+       enum {
                sIsCrypted,  /* is encrypted (no indication if decrypt was possible) */
                sAspect,     /* aspect ratio: 0=4:3, 1=16:9, 2=whatever we need */
                sIsMultichannel, /* multichannel *available* (probably not selected) */
@@ -216,30 +267,61 @@ public:
                sTSID,
                sNamespace,
                sProvider,
+               
+               sDescription,
+               sServiceref,
+               sTimeCreate,    // unix time or string
+               
+               sTitle,
+               sArtist,
+               sAlbum,
+               sComment,
+               sTracknumber,
+               sGenre,
+               sCAIDs,
+               sVideoType,  // MPEG2 MPEG4
+               
+               sTags,  /* space seperated list of tags */
        };
-       enum { resNA = -1, resIsString = -2 };
+       enum { resNA = -1, resIsString = -2, resIsPyObject = -3 };
 
        virtual int getInfo(int w);
        virtual std::string getInfoString(int w);
+       virtual PyObject *getInfoObject(int w);
+       
+       virtual int setInfo(int w, int v);
+       virtual int setInfoString(int w, const char *v);
 };
 
 TEMPLATE_TYPEDEF(ePtr<iServiceInformation>, iServiceInformationPtr);
 
-class iFrontendStatusInformation: public iObject
+class iFrontendInformation: public iObject
 {
+#ifdef SWIG
+       iFrontendInformation();
+       ~iFrontendInformation();
+#endif
 public:
        enum {
                bitErrorRate,
                signalPower,
-               signalQuality
+               signalQuality,
+               lockState,
+               syncState,
+               frontendNumber
        };
        virtual int getFrontendInfo(int w)=0;
+       virtual PyObject *getFrontendData(bool original=false)=0;
 };
 
-TEMPLATE_TYPEDEF(ePtr<iFrontendStatusInformation>, iFrontendStatusInformationPtr);
+TEMPLATE_TYPEDEF(ePtr<iFrontendInformation>, iFrontendInformationPtr);
 
 class iPauseableService: public iObject
 {
+#ifdef SWIG
+       iPausableService();
+       ~iPausableService();
+#endif
 public:
        virtual RESULT pause()=0;
        virtual RESULT unpause()=0;
@@ -253,21 +335,30 @@ 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;
+               /* 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
 {
+#ifndef SWIG
        std::string m_description;
        std::string m_language; /* iso639 */
-       
+#endif
        std::string getDescription() { return m_description; }
        std::string getLanguage() { return m_language; }
 };
@@ -276,6 +367,10 @@ SWIG_ALLOW_OUTPUT_SIMPLE(iAudioTrackInfo);
 
 class iAudioTrackSelection: public iObject
 {
+#ifdef SWIG
+       iAudioTrackSelection();
+       ~iAudioTrackSelection();
+#endif
 public:
        virtual int getNumberOfTracks()=0;
        virtual RESULT selectTrack(unsigned int i)=0;
@@ -284,8 +379,53 @@ public:
 
 TEMPLATE_TYPEDEF(ePtr<iAudioTrackSelection>, iAudioTrackSelectionPtr);
 
+class iAudioChannelSelection: public iObject
+{
+#ifdef SWIG
+       iAudioChannelSelection();
+       ~iAudioChannelSelection();
+#endif
+public:
+       enum { LEFT, STEREO, RIGHT };
+       virtual int getCurrentChannel()=0;
+       virtual RESULT selectChannel(int i)=0;
+};
+
+TEMPLATE_TYPEDEF(ePtr<iAudioChannelSelection>, iAudioChannelSelectionPtr);
+
+class iAudioDelay: public iObject
+{
+#ifdef SWIG
+       iAudioDelay();
+       ~iAudioDelay();
+#endif
+public:
+       virtual int getAC3Delay()=0;
+       virtual int getPCMDelay()=0;
+       virtual void setAC3Delay(int)=0;
+       virtual void setPCMDelay(int)=0;
+};
+
+TEMPLATE_TYPEDEF(ePtr<iAudioDelay>, iAudioDelayPtr);
+
+class iRadioText: public iObject
+{
+#ifdef SWIG
+       iRadioText();
+       ~iRadioText();
+#endif
+public:
+       virtual std::string getRadioText(int x=0)=0;
+};
+
+TEMPLATE_TYPEDEF(ePtr<iRadioText>, iRadioTextPtr);
+
 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;
@@ -293,12 +433,66 @@ public:
 
 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 eWidget;
+class PyList;
+
+class iSubtitleOutput: public iObject
+{
+public:
+       virtual RESULT enableSubtitles(eWidget *parent, PyObject *entry)=0;
+       virtual RESULT disableSubtitles(eWidget *parent)=0;
+       virtual PyObject *getSubtitleList()=0;
+       virtual PyObject *getCachedSubtitle()=0;
+};
+
+TEMPLATE_TYPEDEF(ePtr<iSubtitleOutput>, iSubtitleOutputPtr);
+
 class iPlayableService: public iObject
 {
+#ifdef SWIG
+       iPlayableService();
+       ~iPlaybleService();
+#endif
        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,
                
@@ -306,26 +500,50 @@ public:
                        // 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,
+
+               evUpdatedRadioText
        };
        virtual RESULT connectEvent(const Slot2<void,iPlayableService*,int> &event, ePtr<eConnection> &connection)=0;
        virtual RESULT start()=0;
        virtual RESULT stop()=0;
+                       /* might have to be changed... */
+       virtual RESULT setTarget(int target)=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;
        virtual SWIG_VOID(RESULT) audioTracks(ePtr<iAudioTrackSelection> &SWIG_OUTPUT)=0;
+       virtual SWIG_VOID(RESULT) audioChannel(ePtr<iAudioChannelSelection> &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) frontendInfo(ePtr<iFrontendInformation> &SWIG_OUTPUT)=0;
+       virtual SWIG_VOID(RESULT) timeshift(ePtr<iTimeshiftService> &SWIG_OUTPUT)=0;
+       virtual SWIG_VOID(RESULT) cueSheet(ePtr<iCueSheet> &SWIG_OUTPUT)=0;
+       virtual SWIG_VOID(RESULT) subtitle(ePtr<iSubtitleOutput> &SWIG_OUTPUT)=0;
+       virtual SWIG_VOID(RESULT) audioDelay(ePtr<iAudioDelay> &SWIG_OUTPUT)=0;
+       virtual SWIG_VOID(RESULT) radioText(ePtr<iRadioText> &SWIG_OUTPUT)=0;
 };
 
 TEMPLATE_TYPEDEF(ePtr<iPlayableService>, iPlayableServicePtr);
 
 class iRecordableService: public iObject
 {
+#ifdef SWIG
+       iRecordableService();
+       ~iRecordableService();
+#endif
 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 SWIG_VOID(RESULT) frontendInfo(ePtr<iFrontendInformation> &SWIG_OUTPUT)=0;
 };
 
 TEMPLATE_TYPEDEF(ePtr<iRecordableService>, iRecordableServicePtr);
@@ -334,26 +552,37 @@ TEMPLATE_TYPEDEF(ePtr<iRecordableService>, iRecordableServicePtr);
 
 class iMutableServiceList: public iObject
 {
+#ifdef SWIG
+       iMutableServiceList();
+       ~iMutableServiceList();
+#endif
 public:
                /* flush changes */
        virtual RESULT flushChanges()=0;
                /* adds a service to a list */
-       virtual RESULT addService(eServiceReference &ref)=0;
+       virtual RESULT addService(eServiceReference &ref, eServiceReference before=eServiceReference())=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;
+               /* 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
 {
+#ifdef SWIG
+       iListableService();
+       ~iListableService();
+#endif
 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 PyObject *getContent(const char* format, bool sorted=false)=0;
+
                /* new, shiny interface: streaming. */
        virtual SWIG_VOID(RESULT) getNext(eServiceReference &SWIG_OUTPUT)=0;
        
@@ -369,6 +598,7 @@ public:
 
 TEMPLATE_TYPEDEF(ePtr<iListableService>, iListableServicePtr);
 
+#ifndef SWIG
        /* a helper class which can be used as argument to stl's sort(). */
 class iListableServiceCompare
 {
@@ -380,9 +610,14 @@ public:
                return m_list->compareLessEqual(a, b);
        }
 };
+#endif
 
 class iServiceOfflineOperations: public iObject
 {
+#ifdef SWIG
+       iServiceOfflineOperations();
+       ~iServiceOfflineOperations();
+#endif
 public:
                /* to delete a service, forever. */
        virtual RESULT deleteFromDisk(int simulate=1)=0;
@@ -397,6 +632,10 @@ TEMPLATE_TYPEDEF(ePtr<iServiceOfflineOperations>, iServiceOfflineOperationsPtr);
 
 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;