channelbase.h

Go to the documentation of this file.

// -*- Mode: c++ -*-
 
#ifndef CHANNELBASE_H
#define CHANNELBASE_H
 
// Qt headers
#include <QWaitCondition>
#include <QStringList>
#include <QMutex>
 
// MythTV headers
#include "libmythbase/mythsystemlegacy.h"
#include "channelinfo.h"
#include "tv.h"
#include "videoouttypes.h" // for PictureAttribute
 
class FireWireDBOptions;
class GeneralDBOptions;
class DVBDBOptions;
class ChannelBase;
class TVRec;
 
class ChannelBase
{
    friend class SignalMonitor;
 
  public:
    explicit ChannelBase(TVRec *parent);
    virtual ~ChannelBase(void);
 
    virtual bool Init(QString &startchannel, bool setchan);
    virtual bool IsTunable(const QString &channum) const;
 
    // Methods that must be implemented.
    virtual bool Open(void) = 0;
    virtual void Close(void) = 0;
    virtual bool IsOpen(void) const = 0;
    virtual bool SetChannelByString(const QString &chan) = 0;
 
    // Methods that one might want to specialize
    virtual void SetFormat(const QString &/*format*/) {}
    virtual int SetFreqTable(const QString &/*tablename*/) { return 0; }
    virtual void SetFd(int fd) { (void)fd; };
    virtual int GetFd(void) const { return -1; };
    virtual bool Tune(const QString &/*freqid*/, int /*finetune*/) { return true; }
    virtual bool IsExternalChannelChangeInUse(void);
 
    // Gets
    virtual uint GetNextChannel(uint chanid, ChannelChangeDirection direction) const;
    virtual uint GetNextChannel(const QString &channum, ChannelChangeDirection direction) const;
    virtual QString GetChannelName(void) const
        { return m_curChannelName; }
    virtual int GetChanID(void) const;
    virtual int GetInputID(void) const
        { return m_inputId; }
    virtual QString GetInputName(void) const
        { return m_name; }
    virtual uint GetSourceID(void) const
        { return m_sourceId; }
 
    //         on current channel, for BBC, CBC, etc.
    bool IsCommercialFree(void) const { return m_commFree; }
    virtual QString GetDevice(void) const { return ""; }
 
    // Sets
    virtual void Renumber(uint sourceid, const QString &oldChanNum,
                          const QString &newChanNum);
 
    virtual bool InitializeInput(void);
 
    // Misc. Commands
    virtual bool Retune(void) { return false; }
 
    virtual void StoreInputChannels(void);
 
    // Picture attribute settings
    virtual bool InitPictureAttributes(void) { return false; }
    virtual int  GetPictureAttribute(PictureAttribute /*attr*/) const { return -1; }
    virtual int  ChangePictureAttribute(
        PictureAdjustType /*type*/, PictureAttribute /*attr*/, bool /*direction*/) { return -1; }
 
    bool CheckChannel(const QString &channum) const;
 
    // \brief Set inputid for scanning
    void SetInputID(uint _inputid) { m_inputId = _inputid; }
 
    // \brief Get major input ID
    int GetMajorID(void);
 
    static ChannelBase *CreateChannel(
        TVRec                    *tvrec,
        const GeneralDBOptions   &genOpt,
        const DVBDBOptions       &dvbOpt,
        const FireWireDBOptions  &fwOpt,
        const QString            &startchannel,
        bool                      enter_power_save_mode,
        QString                  &rbFileExt,
        bool                      setchan);
 
  protected:
    virtual bool IsInputAvailable(uint &mplexid_restriction,
                                  uint &chanid_restriction) const;
    virtual bool IsExternalChannelChangeSupported(void) { return false; }
 
  protected:
    bool KillScript(void);
    void HandleScript(const QString &freqid);
    virtual void HandleScriptEnd(bool ok);
    uint GetScriptStatus(bool holding_lock = false);
 
    bool ChangeExternalChannel(const QString &changer,
                               const QString &freqid);
    bool ChangeInternalChannel(const QString &freqid,
                               uint cardinputid) const;
 
    TVRec            *m_pParent        {nullptr};
    QString           m_curChannelName;
    bool              m_commFree       {false};
    uint              m_inputId        {0};
    uint              m_sourceId       {0};
    QString           m_name;
    QString           m_startChanNum;
    QString           m_externalChanger;
    QString           m_tuneToChannel;
    ChannelInfoList   m_channels; 
 
    QMutex            m_systemLock;
    MythSystemLegacy *m_system         {nullptr};
    uint              m_systemStatus  {0};
};
 
 
#endif