MythTV  master
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
FirewireChannel Class Reference

FirewireChannel Copyright (c) 2005 by Jim Westfall and Dave Abrahams Distributed as part of MythTV under GPL v2 and later. More...

#include <firewirechannel.h>

Inheritance diagram for FirewireChannel:
Inheritance graph
[legend]
Collaboration diagram for FirewireChannel:
Collaboration graph
[legend]

Public Member Functions

 FirewireChannel (TVRec *parent, QString videodevice, FireWireDBOptions firewire_opts)
 
 ~FirewireChannel () override
 
 FirewireChannel (const FirewireChannel &)=delete
 
FirewireChanneloperator= (const FirewireChannel &)=delete
 
bool Open (void) override
 Opens the channel changing hardware for use. More...
 
void Close (void) override
 Closes the channel changing hardware to use. More...
 
bool Tune (const DTVMultiplex &) override
 This performs the actual frequency tuning and in some cases input switching. More...
 
bool Tune (const QString &freqid, int finetune) override
 
bool Retune (void) override
 
virtual bool SetPowerState (bool on)
 
bool IsOpen (void) const override
 Reports whether channel is already open. More...
 
QString GetDevice (void) const override
 Returns String representing device, useful for debugging. More...
 
virtual bool Tune (const DTVMultiplex &tuning)=0
 This performs the actual frequency tuning and in some cases input switching. More...
 
virtual bool Tune (const IPTVTuningData &, bool)
 Performs IPTV Tuning. Only implemented by IPTVChannel. More...
 
virtual bool Tune (const QString &)
 Leave it up to the implementation to map the channnum appropriately. More...
 
bool Tune ([[maybe_unused]] const QString &freqid,[[maybe_unused]] int finetune) override
 This tunes on the frequency Identification parameter for hardware that supports it. More...
 
virtual bool Tune ([[maybe_unused]] uint64_t frequency)
 
- Public Member Functions inherited from DTVChannel
 DTVChannel (TVRec *parent)
 
 ~DTVChannel () override
 
bool SetChannelByString (const QString &chan) override
 
void SetFormat (const QString &format) override
 
QString GetFormat (void)
 
virtual bool TuneMultiplex (uint mplexid, const QString &inputname)
 To be used by the channel scanner and possibly the EIT scanner. More...
 
virtual bool Tune (const IPTVTuningData &, bool)
 Performs IPTV Tuning. Only implemented by IPTVChannel. More...
 
virtual bool Tune (const QString &)
 Leave it up to the implementation to map the channnum appropriately. More...
 
virtual bool EnterPowerSavingMode (void)
 Enters power saving mode if the card supports it. More...
 
bool Tune ([[maybe_unused]] const QString &freqid, [[maybe_unused]] int finetune) override
 This tunes on the frequency Identification parameter for hardware that supports it. More...
 
virtual bool Tune ([[maybe_unused]] uint64_t frequency)
 
int GetProgramNumber (void) const
 Returns program number in PAT, -1 if unknown. More...
 
uint GetMajorChannel (void) const
 Returns major channel, 0 if unknown. More...
 
uint GetMinorChannel (void) const
 Returns minor channel, 0 if unknown. More...
 
uint GetOriginalNetworkID (void) const
 Returns DVB original_network_id, 0 if unknown. More...
 
uint GetTransportID (void) const
 Returns DVB transport_stream_id, 0 if unknown. More...
 
QString GetSIStandard (void) const
 Returns PSIP table standard: MPEG, DVB, ATSC, or OpenCable. More...
 
QString GetSuggestedTuningMode (bool is_live_tv) const
 Returns suggested tuning mode: "mpeg", "dvb", or "atsc". More...
 
QString GetTuningMode (void) const
 Returns tuning mode last set by SetTuningMode(). More...
 
virtual std::vector< DTVTunerTypeGetTunerTypes (void) const
 Returns a vector of supported tuning types. More...
 
void GetCachedPids (pid_cache_t &pid_cache) const
 Returns cached MPEG PIDs for last tuned channel. More...
 
void RegisterForMaster (const QString &key)
 
void DeregisterForMaster (const QString &key)
 
virtual bool IsMaster (void) const
 Returns true if this is the first of a number of multi-rec devs. More...
 
virtual bool IsPIDTuningSupported (void) const
 
virtual bool IsIPTV (void) const
 
bool HasGeneratedPAT (void) const
 
bool HasGeneratedPMT (void) const
 
const ProgramAssociationTableGetGeneratedPAT (void) const
 
const ProgramMapTableGetGeneratedPMT (void) const
 
void SetTuningMode (const QString &tuning_mode)
 Sets tuning mode: "mpeg", "dvb", "atsc", etc. More...
 
void SaveCachedPids (const pid_cache_t &pid_cache) const
 Saves MPEG PIDs to cache to database. More...
 
- Public Member Functions inherited from ChannelBase
 ChannelBase (TVRec *parent)
 
virtual ~ChannelBase (void)
 
virtual bool Init (QString &startchannel, bool setchan)
 
virtual bool IsTunable (const QString &channum) const
 
virtual int SetFreqTable (const QString &)
 
virtual void SetFd (int fd)
 Sets file descriptor. More...
 
virtual int GetFd (void) const
 Returns file descriptor, -1 if it does not exist. More...
 
virtual bool IsExternalChannelChangeInUse (void)
 
virtual uint GetNextChannel (uint chanid, ChannelChangeDirection direction) const
 
virtual uint GetNextChannel (const QString &channum, ChannelChangeDirection direction) const
 
virtual QString GetChannelName (void) const
 
virtual int GetChanID (void) const
 
virtual int GetInputID (void) const
 
virtual QString GetInputName (void) const
 
virtual uint GetSourceID (void) const
 
bool IsCommercialFree (void) const
 Returns true iff commercial detection is not required. More...
 
virtual void Renumber (uint sourceid, const QString &oldChanNum, const QString &newChanNum)
 Changes a channum if we have it cached anywhere. More...
 
virtual bool InitializeInput (void)
 Fills in input map from DB. More...
 
virtual void StoreInputChannels (void)
 Saves current channel as the default channel for the current input. More...
 
virtual bool InitPictureAttributes (void)
 
virtual int GetPictureAttribute (PictureAttribute) const
 
virtual int ChangePictureAttribute (PictureAdjustType, PictureAttribute, bool)
 
bool CheckChannel (const QString &channum) const
 
void SetInputID (uint _inputid)
 
int GetMajorID (void)
 

Protected Member Functions

bool IsExternalChannelChangeSupported (void) override
 
- Protected Member Functions inherited from DTVChannel
void SetSIStandard (const QString &si_std)
 Sets PSIP table standard: MPEG, DVB, ATSC, or OpenCable. More...
 
void SetDTVInfo (uint atsc_major, uint atsc_minor, uint dvb_orig_netid, uint mpeg_tsid, int mpeg_pnum)
 
void ClearDTVInfo (void)
 
virtual void CheckOptions (DTVMultiplex &) const
 Checks tuning for problems, and tries to fix them. More...
 
void HandleScriptEnd (bool ok) override
 
- Protected Member Functions inherited from ChannelBase
virtual bool IsInputAvailable (uint &mplexid_restriction, uint &chanid_restriction) const
 Switches to another input on hardware, and sets the channel is setstarting is true. More...
 
bool KillScript (void)
 
void HandleScript (const QString &freqid)
 
uint GetScriptStatus (bool holding_lock=false)
 
bool ChangeExternalChannel (const QString &changer, const QString &freqid)
 
bool ChangeInternalChannel (const QString &freqid, uint cardinputid) const
 

Protected Attributes

QString m_videodevice
 
FireWireDBOptions m_fwOpts
 
FirewireDevicem_device {nullptr}
 
uint m_currentChannel {0}
 
bool m_isopen {false}
 
- Protected Attributes inherited from DTVChannel
QMutex m_dtvinfoLock
 
DTVTunerType m_tunerType {DTVTunerType::kTunerTypeUnknown}
 
QString m_sistandard {"mpeg"}
 PSIP table standard: MPEG, DVB, ATSC, OpenCable. More...
 
QString m_tuningMode
 
QString m_tvFormat
 
int m_currentProgramNum {-1}
 
uint m_currentATSCMajorChannel {0}
 
uint m_currentATSCMinorChannel {0}
 
uint m_currentTransportID {0}
 
uint m_currentOriginalNetworkID {0}
 
ProgramAssociationTablem_genPAT {nullptr}
 This is a generated PAT for RAW pid tuning. More...
 
ProgramMapTablem_genPMT {nullptr}
 This is a generated PMT for RAW pid tuning. More...
 
- Protected Attributes inherited from ChannelBase
TVRecm_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
 channels across all inputs More...
 
QMutex m_systemLock
 
MythSystemLegacym_system {nullptr}
 
uint m_systemStatus {0}
 These get mapped from the GENERIC_EXIT_* to these values for use with the signalmonitor code. More...
 

Private Member Functions

virtual FirewireDevice::PowerState GetPowerState (void) const
 
virtual FirewireDeviceGetFirewireDevice (void)
 

Friends

class FirewireSignalMonitor
 
class FirewireRecorder
 

Additional Inherited Members

- Public Types inherited from DTVChannel
using DTVChannelP = DTVChannel *
 
- Static Public Member Functions inherited from DTVChannel
static DTVChannelGetMasterLock (const QString &key)
 
static void ReturnMasterLock (DTVChannelP &chan)
 
- Static Public Member Functions inherited from ChannelBase
static ChannelBaseCreateChannel (TVRec *tvrec, const GeneralDBOptions &genOpt, const DVBDBOptions &dvbOpt, const FireWireDBOptions &fwOpt, const QString &startchannel, bool enter_power_save_mode, QString &rbFileExt, bool setchan)
 
- Protected Types inherited from DTVChannel
using MasterMap = QMap< QString, QList< DTVChannel * > >
 
- Static Protected Attributes inherited from DTVChannel
static QReadWriteLock s_master_map_lock
 
static MasterMap s_master_map
 

Detailed Description

FirewireChannel Copyright (c) 2005 by Jim Westfall and Dave Abrahams Distributed as part of MythTV under GPL v2 and later.

Definition at line 14 of file firewirechannel.h.

Constructor & Destructor Documentation

◆ FirewireChannel() [1/2]

FirewireChannel::FirewireChannel ( TVRec parent,
QString  videodevice,
FireWireDBOptions  firewire_opts 
)

Definition at line 21 of file firewirechannel.cpp.

◆ ~FirewireChannel()

FirewireChannel::~FirewireChannel ( )
override

Definition at line 41 of file firewirechannel.cpp.

◆ FirewireChannel() [2/2]

FirewireChannel::FirewireChannel ( const FirewireChannel )
delete

Member Function Documentation

◆ operator=()

FirewireChannel& FirewireChannel::operator= ( const FirewireChannel )
delete

◆ Open()

bool FirewireChannel::Open ( void  )
overridevirtual

Opens the channel changing hardware for use.

Implements ChannelBase.

Definition at line 47 of file firewirechannel.cpp.

◆ Close()

void FirewireChannel::Close ( void  )
overridevirtual

Closes the channel changing hardware to use.

Implements ChannelBase.

Definition at line 80 of file firewirechannel.cpp.

Referenced by ~FirewireChannel().

◆ Tune() [1/7]

bool FirewireChannel::Tune ( const DTVMultiplex tuning)
inlineoverridevirtual

This performs the actual frequency tuning and in some cases input switching.

In rare cases such as ASI this does nothing since all the channels are in the same MPTS stream on the same input. But generally you will need to implement this when adding support for new hardware.

Implements DTVChannel.

Definition at line 32 of file firewirechannel.h.

Referenced by Retune().

◆ Tune() [2/7]

bool FirewireChannel::Tune ( const QString &  freqid,
int  finetune 
)
overridevirtual

Reimplemented from ChannelBase.

Definition at line 142 of file firewirechannel.cpp.

◆ Retune()

bool FirewireChannel::Retune ( void  )
overridevirtual

Reimplemented from ChannelBase.

Definition at line 121 of file firewirechannel.cpp.

◆ SetPowerState()

bool FirewireChannel::SetPowerState ( bool  on)
virtual

Definition at line 95 of file firewirechannel.cpp.

◆ IsOpen()

bool FirewireChannel::IsOpen ( void  ) const
inlineoverridevirtual

Reports whether channel is already open.

Implements ChannelBase.

Definition at line 41 of file firewirechannel.h.

◆ GetDevice()

QString FirewireChannel::GetDevice ( void  ) const
overridevirtual

Returns String representing device, useful for debugging.

Reimplemented from ChannelBase.

Definition at line 90 of file firewirechannel.cpp.

◆ IsExternalChannelChangeSupported()

bool FirewireChannel::IsExternalChannelChangeSupported ( void  )
inlineoverrideprotectedvirtual

Reimplemented from ChannelBase.

Definition at line 46 of file firewirechannel.h.

◆ GetPowerState()

FirewireDevice::PowerState FirewireChannel::GetPowerState ( void  ) const
privatevirtual

◆ GetFirewireDevice()

virtual FirewireDevice* FirewireChannel::GetFirewireDevice ( void  )
inlineprivatevirtual

◆ Tune() [3/7]

virtual bool DTVChannel::Tune

This performs the actual frequency tuning and in some cases input switching.

In rare cases such as ASI this does nothing since all the channels are in the same MPTS stream on the same input. But generally you will need to implement this when adding support for new hardware.

◆ Tune() [4/7]

virtual bool DTVChannel::Tune
inline

Performs IPTV Tuning. Only implemented by IPTVChannel.

Definition at line 58 of file dtvchannel.h.

◆ Tune() [5/7]

virtual bool DTVChannel::Tune
inline

Leave it up to the implementation to map the channnum appropriately.

Used by the ExternalRecorder.

Definition at line 63 of file dtvchannel.h.

◆ Tune() [6/7]

bool DTVChannel::Tune
inlineoverride

This tunes on the frequency Identification parameter for hardware that supports it.

This is only called when there is no frequency set. This is used to implement "Channel Numbers" in analog tuning scenarios and to implement "Virtual Channels" in the OCUR and Firewire tuners.

Definition at line 75 of file dtvchannel.h.

◆ Tune() [7/7]

virtual bool DTVChannel::Tune
inline

Definition at line 81 of file dtvchannel.h.

Friends And Related Function Documentation

◆ FirewireSignalMonitor

friend class FirewireSignalMonitor
friend

Definition at line 16 of file firewirechannel.h.

◆ FirewireRecorder

friend class FirewireRecorder
friend

Definition at line 17 of file firewirechannel.h.

Member Data Documentation

◆ m_videodevice

QString FirewireChannel::m_videodevice
protected

Definition at line 54 of file firewirechannel.h.

Referenced by FirewireChannel(), and GetDevice().

◆ m_fwOpts

FireWireDBOptions FirewireChannel::m_fwOpts
protected

Definition at line 55 of file firewirechannel.h.

Referenced by FirewireChannel(), Open(), and Tune().

◆ m_device

FirewireDevice* FirewireChannel::m_device {nullptr}
protected

◆ m_currentChannel

uint FirewireChannel::m_currentChannel {0}
protected

Definition at line 57 of file firewirechannel.h.

Referenced by Retune(), and Tune().

◆ m_isopen

bool FirewireChannel::m_isopen {false}
protected

Definition at line 58 of file firewirechannel.h.

Referenced by Close(), GetPowerState(), IsOpen(), Open(), and SetPowerState().


The documentation for this class was generated from the following files: