make eDVBResourceManager accessible from python (needed for allocate a raw iDVBChannel)
[enigma2.git] / lib / dvb / idvb.h
index da626866d6ec44d51c5dc0172697925dfa2722fd..a6a19fff1bac47bad472aff53ab90dc8df6c8c5f 100644 (file)
@@ -1,7 +1,8 @@
 #ifndef __dvb_idvb_h
 #define __dvb_idvb_h
 
-#include <config.h>
+#ifndef SWIG
+
 #if HAVE_DVB_API_VERSION < 3
 #include <ost/frontend.h>
 #define FRONTENDPARAMETERS FrontendParameters
 #include <linux/dvb/frontend.h>
 #define FRONTENDPARAMETERS struct dvb_frontend_parameters
 #endif
+#include <lib/dvb/frontendparms.h>
 #include <lib/base/object.h>
 #include <lib/base/ebase.h>
+#include <lib/base/elock.h>
 #include <lib/service/service.h>
 #include <libsig_comp.h>
 #include <connection.h>
 
-               // bitte KEINE operator int() definieren, sonst bringt das ganze nix!
+struct eBouquet
+{
+       std::string m_bouquet_name;
+       std::string m_filename;  // without path.. just name
+       typedef std::list<eServiceReference> list;
+       list m_services;
+// the following five methods are implemented in db.cpp
+       RESULT flushChanges();
+       RESULT addService(const eServiceReference &);
+       RESULT removeService(const eServiceReference &);
+       RESULT moveService(const eServiceReference &, unsigned int);
+       RESULT setListName(const std::string &name);
+};
+
+               /* these structures have by intention no operator int() defined.
+                  the reason of these structures is to avoid mixing for example
+                  a onid and a tsid (as there's no general order for them).
+                  
+                  defining an operator int() would implicitely convert values
+                  between them over the constructor with the int argument.
+                  
+                  'explicit' doesn't here - eTransportStreamID(eOriginalNetworkID(n)) 
+                  would still work. */
+
 struct eTransportStreamID
 {
 private:
@@ -77,6 +103,14 @@ struct eDVBChannelID
        eDVBNamespace dvbnamespace;
        eTransportStreamID transport_stream_id;
        eOriginalNetworkID original_network_id;
+       
+       bool operator==(const eDVBChannelID &c) const
+       {
+               return dvbnamespace == c.dvbnamespace &&
+                       transport_stream_id == c.transport_stream_id &&
+                       original_network_id == c.original_network_id;
+       }
+       
        bool operator<(const eDVBChannelID &c) const
        {
                if (dvbnamespace < c.dvbnamespace)
@@ -122,6 +156,12 @@ struct eServiceReferenceDVB: public eServiceReference
        eDVBNamespace getDVBNamespace() const { return eDVBNamespace(data[4]); }
        void setDVBNamespace(eDVBNamespace dvbnamespace) { data[4]=dvbnamespace.get(); }
 
+       eServiceID getParentServiceID() const { return eServiceID(data[5]); }
+       void setParentServiceID( eServiceID sid ) { data[5]=sid.get(); }
+
+       eTransportStreamID getParentTransportStreamID() const { return eTransportStreamID(data[6]); }
+       void setParentTransportStreamID( eTransportStreamID tsid ) { data[6]=tsid.get(); }
+
        eServiceReferenceDVB(eDVBNamespace dvbnamespace, eTransportStreamID transport_stream_id, eOriginalNetworkID original_network_id, eServiceID service_id, int service_type)
                :eServiceReference(eServiceReference::idDVB, 0)
        {
@@ -148,6 +188,11 @@ struct eServiceReferenceDVB: public eServiceReference
                :eServiceReference(eServiceReference::idDVB, 0)
        {
        }
+
+       eServiceReferenceDVB(const std::string &string)
+               :eServiceReference(string)
+       {
+       }
 };
 
 
@@ -162,10 +207,22 @@ class eDVBService: public iStaticServiceInformation
 {
        DECLARE_REF(eDVBService);
 public:
+       enum cacheID
+       {
+               cVPID, cAPID, cTPID, cPCRPID, cAC3PID, cacheMax
+       };
+
+       int getCachePID(cacheID);
+       void setCachePID(cacheID, int);
+       bool cacheEmpty() { return m_cache.empty(); }
+
        eDVBService();
-       std::string m_service_name;
+               /* m_service_name_sort is uppercase, with special chars removed, to increase sort performance. */
+       std::string m_service_name, m_service_name_sort;
        std::string m_provider_name;
        
+       void genSortName();
+       
        int m_flags;
        std::set<int> m_ca;
        std::map<int,int> m_cache;
@@ -175,8 +232,10 @@ public:
        
        // iStaticServiceInformation
        RESULT getName(const eServiceReference &ref, std::string &name);
-       
-       // for filtering:
+       RESULT getEvent(const eServiceReference &ref, ePtr<eServiceEvent> &ptr, time_t start_time);
+       bool isPlayable(const eServiceReference &ref, const eServiceReference &ignore);
+
+               /* for filtering: */
        int checkFilter(const eServiceReferenceDVB &ref, const eDVBChannelQuery &query);
 };
 
@@ -190,6 +249,7 @@ class iDVBChannelListQuery: public iObject
 {
 public:
        virtual RESULT getNextResult(eServiceReferenceDVB &ref)=0;
+       virtual int compareLessEqual(const eServiceReferenceDVB &a, const eServiceReferenceDVB &b)=0;
 };
 
 class eDVBChannelQuery: public iObject
@@ -215,6 +275,10 @@ public:
        int m_int;
        eDVBChannelID m_channelid;
        
+               /* sort is only valid in root, and must be from the enum above. */
+       int m_sort;
+       std::string m_bouquet_name;
+       
        static RESULT compile(ePtr<eDVBChannelQuery> &res, std::string query);
        
        ePtr<eDVBChannelQuery> m_p1, m_p2;
@@ -230,92 +294,49 @@ public:
        
        virtual RESULT addService(const eServiceReferenceDVB &service, eDVBService *service)=0;
        virtual RESULT getService(const eServiceReferenceDVB &reference, ePtr<eDVBService> &service)=0;
+       virtual RESULT flush()=0;
 
-       virtual RESULT startQuery(ePtr<iDVBChannelListQuery> &query, eDVBChannelQuery *query)=0;
-};
+       virtual RESULT getBouquet(const eServiceReference &ref,  eBouquet* &bouquet)=0;
 
-class iDVBResourceManager: public iObject
-{
-public:
-       /*
-                       solange rumloopen bis eine resource gefunden wurde, die eine frequenz
-                       tunen will
-                       
-                       wenn natuerlich sowas schon vorhanden ist, dann einfach ne ref darauf
-                       geben. (zwei services auf dem gleichen transponder teilen sich einen
-                       channel)
-       */
-       virtual RESULT setChannelList(iDVBChannelList *list)=0;
-       virtual RESULT getChannelList(ePtr<iDVBChannelList> &list)=0;
-       virtual RESULT allocateChannel(const eDVBChannelID &channel, ePtr<iDVBChannel> &channel)=0;
-       virtual RESULT allocateRawChannel(ePtr<iDVBChannel> &channel)=0;
-       virtual RESULT allocatePVRChannel(int caps)=0;
+       virtual RESULT startQuery(ePtr<iDVBChannelListQuery> &query, eDVBChannelQuery *query, const eServiceReference &source)=0;
 };
 
-class SatelliteDeliverySystemDescriptor;
-class CableDeliverySystemDescriptor;
-class TerrestrialDeliverySystemDescriptor;
-
-struct eDVBFrontendParametersSatellite
-{
-       struct Polarisation
-       {
-               enum {
-                       Horizontal, Vertical, CircularLeft, CircularRight
-               };
-       };
-       struct Inversion
-       {
-               enum {
-                       On, Off, Unknown
-               };
-       };
-       struct FEC
-       {
-               enum {
-                       fNone, f1_2, f2_3, f3_4, f5_6, f7_8, fAuto
-               };
-       };
-       unsigned int frequency, symbol_rate;
-       int polarisation, fec, inversion, orbital_position;
-       
-       void set(const SatelliteDeliverySystemDescriptor  &);
-};
-
-struct eDVBFrontendParametersCable
-{
-       unsigned int frequency, symbol_rate;
-       int modulation, inversion, fec_inner;
-       void set(const CableDeliverySystemDescriptor  &);
-};
-
-struct eDVBFrontendParametersTerrestrial
-{
-       int unknown;
-       void set(const TerrestrialDeliverySystemDescriptor  &);
-};
+#endif  // SWIG
 
 class iDVBFrontendParameters: public iObject
 {
+#ifdef SWIG
+       iDVBFrontendParameters();
+       ~iDVBFrontendParameters();
+#endif
 public:
-       virtual RESULT getSystem(int &type) const = 0;
-       virtual RESULT getDVBS(eDVBFrontendParametersSatellite &p) const = 0;
-       virtual RESULT getDVBC(eDVBFrontendParametersCable &p) const = 0;
-       virtual RESULT getDVBT(eDVBFrontendParametersTerrestrial &p) const = 0;
+       virtual RESULT getSystem(int &SWIG_OUTPUT) const = 0;
+       virtual RESULT getDVBS(eDVBFrontendParametersSatellite &SWIG_OUTPUT) const = 0;
+       virtual RESULT getDVBC(eDVBFrontendParametersCable &SWIG_OUTPUT) const = 0;
+       virtual RESULT getDVBT(eDVBFrontendParametersTerrestrial &SWIG_OUTPUT) const = 0;
        
-       virtual RESULT calculateDifference(const iDVBFrontendParameters *parm, int &diff) const = 0;
-       virtual RESULT getHash(unsigned long &hash) const = 0;
+       virtual RESULT calculateDifference(const iDVBFrontendParameters *parm, int &SWIG_OUTPUT) const = 0;
+       virtual RESULT getHash(unsigned long &SWIG_OUTPUT) const = 0;
 };
 
 #define MAX_DISEQC_LENGTH  16
 
-struct eDVBDiseqcCommand
+class eDVBDiseqcCommand
 {
+public:
        int len;
+#ifndef SWIG
        __u8 data[MAX_DISEQC_LENGTH];
+#if HAVE_DVB_API_VERSION < 3
+       int tone;
+       int voltage;
+#endif
+#endif //SWIG
+       void setData(const char *str);
 };
 
 class iDVBSatelliteEquipmentControl;
+class eSecCommandList;
 
 class iDVBFrontend: public iObject
 {
@@ -325,36 +346,60 @@ public:
        };
        virtual RESULT getFrontendType(int &type)=0;
        virtual RESULT tune(const iDVBFrontendParameters &where)=0;
+#ifndef SWIG
        virtual RESULT connectStateChange(const Slot1<void,iDVBFrontend*> &stateChange, ePtr<eConnection> &connection)=0;
+#endif
        enum {
                stateIdle = 0,
                stateTuning = 1,
                stateFailed = 2,
-               stateLock = 3
+               stateLock = 3,
+               stateLostLock = 4,
        };
        virtual RESULT getState(int &state)=0;
        enum {
-               toneOn, toneOff
+               toneOff, toneOn
        };
        virtual RESULT setTone(int tone)=0;
        enum {
-               voltageOff, voltage13, voltage18
+               voltageOff, voltage13, voltage18, voltage13_5, voltage18_5
        };
        virtual RESULT setVoltage(int voltage)=0;
        virtual RESULT sendDiseqc(const eDVBDiseqcCommand &diseqc)=0;
+       virtual RESULT sendToneburst(int burst)=0;
+#ifndef SWIG
        virtual RESULT setSEC(iDVBSatelliteEquipmentControl *sec)=0;
+       virtual RESULT setSecSequence(const eSecCommandList &list)=0;
+#endif
+       enum {
+               bitErrorRate, signalPower, signalQuality, Locked, Synced
+       };
+       virtual int readFrontendData(int type)=0;
+       virtual PyObject *readTransponderData(bool original)=0;
+
+#ifndef SWIG
+       virtual RESULT getData(int num, int &data)=0;
+       virtual RESULT setData(int num, int val)=0;
+               /* 0 means: not compatible. other values are a priority. */
+       virtual int isCompatibleWith(ePtr<iDVBFrontendParameters> &feparm)=0;
+#endif
 };
+TEMPLATE_TYPEDEF(ePtr<iDVBFrontend>, iDVBFrontendPtr);
 
+#ifndef SWIG
 class iDVBSatelliteEquipmentControl: public iObject
 {
 public:
-       virtual RESULT prepare(iDVBFrontend &frontend, FRONTENDPARAMETERS &parm, eDVBFrontendParametersSatellite &sat)=0;
+       virtual RESULT prepare(iDVBFrontend &frontend, FRONTENDPARAMETERS &parm, const eDVBFrontendParametersSatellite &sat, int frontend_id)=0;
+       virtual int canTune(const eDVBFrontendParametersSatellite &feparm, iDVBFrontend *fe, int frontend_id)=0;
+       virtual void setRotorMoving(bool)=0;
 };
 
 struct eDVBCIRouting
 {
        int enabled;
 };
+#endif // SWIG
 
 class iDVBChannel: public iObject
 {
@@ -363,31 +408,125 @@ public:
        {
                state_idle,        /* not yet tuned */
                state_tuning,      /* currently tuning (first time) */
+               state_failed,      /* tuning failed. */
                state_unavailable, /* currently unavailable, will be back without further interaction */
-               state_ok           /* ok */
+               state_ok,          /* ok */
+               state_last_instance, /* just one reference to this channel is left */
+               state_release      /* channel is being shut down. */
+       };
+       virtual RESULT getState(int &state)=0;  
+
+               /* direct frontend access for raw channels and/or status inquiries. */
+       virtual RESULT getFrontend(ePtr<iDVBFrontend> &frontend)=0;
+
+#ifndef SWIG
+       virtual RESULT getCurrentFrontendParameters(ePtr<iDVBFrontendParameters> &)=0;
+       enum 
+       {
+               evtEOF, evtSOF, evtFailed
        };
        virtual RESULT connectStateChange(const Slot1<void,iDVBChannel*> &stateChange, ePtr<eConnection> &connection)=0;
-       virtual RESULT getState(int &state)=0;
+       virtual RESULT connectEvent(const Slot2<void,iDVBChannel*,int> &eventChange, ePtr<eConnection> &connection)=0;
+
+               /* demux capabilities */
        enum
        {
-               cap_decode,
-               cap_ci
+               capDecode = 1,
+               /* capCI = 2 */
        };
        virtual RESULT setCIRouting(const eDVBCIRouting &routing)=0;
-       virtual RESULT getDemux(ePtr<iDVBDemux> &demux)=0;
+       virtual RESULT getDemux(ePtr<iDVBDemux> &demux, int cap=0)=0;
        
-               /* direct frontend access for raw channels and/or status inquiries. */
-       virtual RESULT getFrontend(ePtr<iDVBFrontend> &frontend)=0;
+               /* use count handling */
+       virtual void AddUse() = 0;
+       virtual void ReleaseUse() = 0;
+#endif
+};
+TEMPLATE_TYPEDEF(ePtr<iDVBChannel>, iDVBChannelPtr);
+
+#ifndef SWIG
+
+       /* signed, so we can express deltas. */
+       
+typedef long long pts_t;
+
+class iFilePushScatterGather;
+class iTSMPEGDecoder;
+
+       /* note that a cue sheet describes the logical positions. thus 
+          everything is specified in pts and not file positions */
+
+       /* implemented in dvb.cpp */
+class eCueSheet: public iObject, public Object
+{
+       DECLARE_REF(eCueSheet);
+public:
+       eCueSheet();
+       
+                       /* frontend */
+       void seekTo(int relative, const pts_t &pts);
+       
+       void clear();
+       void addSourceSpan(const pts_t &begin, const pts_t &end);
+       void commitSpans();
+       
+       void setSkipmode(const pts_t &ratio); /* 90000 is 1:1 */
+       void setDecodingDemux(iDVBDemux *demux, iTSMPEGDecoder *decoder);
+       
+                       /* frontend and backend */
+       eSingleLock m_lock;
+       
+                       /* backend */
+       enum { evtSeek, evtSkipmode, evtSpanChanged };
+       RESULT connectEvent(const Slot1<void, int> &event, ePtr<eConnection> &connection);
+
+       std::list<std::pair<pts_t,pts_t> > m_spans;     /* begin, end */
+       std::list<std::pair<int, pts_t> > m_seek_requests; /* relative, delta */
+       pts_t m_skipmode_ratio;
+       Signal1<void,int> m_event;
+       ePtr<iDVBDemux> m_decoding_demux;
+       ePtr<iTSMPEGDecoder> m_decoder;
+};
+
+class iDVBPVRChannel: public iDVBChannel
+{
+public:
+       enum
+       {
+               state_eof = state_release + 1  /* end-of-file reached. */
+       };
+       
+               /* FIXME: there are some very ugly buffer-end and ... related problems */
+               /* so this is VERY UGLY. 
+               
+                  ok, it's going to get better. but still...*/
+       virtual RESULT playFile(const char *file) = 0;
+       virtual void stopFile() = 0;
+       
+       virtual void setCueSheet(eCueSheet *cuesheet) = 0;
+       
+       virtual RESULT getLength(pts_t &pts) = 0;
+       
+               /* we explicitely ask for the decoding demux here because a channel
+                  can be shared between multiple decoders.
+               */
+       virtual RESULT getCurrentPosition(iDVBDemux *decoding_demux, pts_t &pos, int mode) = 0;
+               /* skipping must be done with a cue sheet */
 };
 
 class iDVBSectionReader;
+class iDVBTSRecorder;
 class iTSMPEGDecoder;
 
 class iDVBDemux: public iObject
 {
 public:
        virtual RESULT createSectionReader(eMainloop *context, ePtr<iDVBSectionReader> &reader)=0;
+       virtual RESULT createTSRecorder(ePtr<iDVBTSRecorder> &recorder)=0;
        virtual RESULT getMPEGDecoder(ePtr<iTSMPEGDecoder> &reader)=0;
+       virtual RESULT getSTC(pts_t &pts, int num=0)=0;
+       virtual RESULT getCADemuxID(uint8_t &id)=0;
+       virtual RESULT flush()=0;
 };
 
 class iTSMPEGDecoder: public iObject
@@ -401,12 +540,15 @@ public:
                /** Set Displayed Audio PID and type */
        virtual RESULT setAudioPID(int apid, int type)=0;
 
+               /** Set Displayed Videotext PID */
+       virtual RESULT setTextPID(int vpid)=0;
+
                /** Set Sync mode to PCR */
        virtual RESULT setSyncPCR(int pcrpid)=0;
        enum { sm_Audio, sm_Video };
                /** Set Sync mode to either audio or video master */
        virtual RESULT setSyncMaster(int who)=0;
-       
+
                /** Apply settings */
        virtual RESULT start()=0;
        
@@ -415,6 +557,9 @@ public:
                /** Continue after freeze. */
        virtual RESULT unfreeze()=0;
        
+               /** fast forward by skipping frames. 0 is disabled, 2 is twice-the-speed, ... */
+       virtual RESULT setFastForward(int skip=0)=0;
+       
                // stop on .. Picture
        enum { spm_I, spm_Ref, spm_Any };
                /** Stop on specific decoded picture. For I-Frame display. */
@@ -430,6 +575,11 @@ public:
        enum { zoom_Normal, zoom_PanScan, zoom_Letterbox, zoom_Fullscreen };
                /** Set Zoom. mode *must* be fitting. */
        virtual RESULT setZoom(int what)=0;
+       
+       virtual RESULT setTrickmode(int what) = 0;
+       
+       virtual RESULT getPTS(int what, pts_t &pts) = 0;
 };
 
+#endif //SWIG
 #endif