MythTV master
Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Private Attributes | List of all members
ChannelImporter Class Reference

#include <libmythtv/channelscan/channelimporter.h>

Inheritance diagram for ChannelImporter:
[legend]
Collaboration diagram for ChannelImporter:
[legend]

Public Member Functions

 ChannelImporter (bool gui, bool interactive, bool _delete, bool insert, bool save, bool fta_only, bool lcn_only, bool complete_only, bool full_channel_search, bool remove_duplicates, ServiceRequirements service_requirements, bool success=false)
 
void Process (const ScanDTVTransportList &_transports, int sourceid=-1)
 

Protected Types

enum  DeleteAction : std::uint8_t { kDeleteAll , kDeleteManual , kDeleteIgnoreAll , kDeleteInvisibleAll }
 
enum  InsertAction : std::uint8_t { kInsertAll , kInsertManual , kInsertIgnoreAll }
 
enum  UpdateAction : std::uint8_t { kUpdateAll , kUpdateManual , kUpdateIgnoreAll }
 
enum  ChannelType : std::uint8_t {
  kChannelTypeFirst = 0 , kChannelTypeNonConflictingFirst = kChannelTypeFirst , kATSCNonConflicting = kChannelTypeFirst , kDVBNonConflicting = 1 ,
  kSCTENonConflicting = 2 , kMPEGNonConflicting = 3 , kNTSCNonConflicting = 4 , kChannelTypeNonConflictingLast = kNTSCNonConflicting ,
  kChannelTypeConflictingFirst = 5 , kATSCConflicting = kChannelTypeConflictingFirst , kDVBConflicting = 6 , kSCTEConflicting = 7 ,
  kMPEGConflicting = 8 , kNTSCConflicting = 9 , kChannelTypeConflictingLast = kNTSCConflicting , kChannelTypeLast = kChannelTypeConflictingLast
}
 

Protected Member Functions

void FilterServices (ScanDTVTransportList &transports) const
 
void ChannelNumbers (ScanDTVTransportList &transports) const
 
ScanDTVTransportList GetDBTransports (uint sourceid, ScanDTVTransportList &transports) const
 Adds found channel info to transports list, returns channels in DB which were not found in scan in another transport list. More...
 
uint DeleteChannels (ScanDTVTransportList &transports)
 
uint DeleteUnusedTransports (uint sourceid)
 
void InsertChannels (const ScanDTVTransportList &transports, const ChannelImporterBasicStats &info)
 
ScanDTVTransportList InsertChannels (const ScanDTVTransportList &transports, const ChannelImporterBasicStats &info, InsertAction action, ChannelType type, ScanDTVTransportList &inserted, ScanDTVTransportList &skipped)
 
ScanDTVTransportList UpdateChannels (const ScanDTVTransportList &transports, const ChannelImporterBasicStats &info, UpdateAction action, ChannelType type, ScanDTVTransportList &updated, ScanDTVTransportList &skipped) const
 
DeleteAction QueryUserDelete (const QString &msg)
 For multiple channels. More...
 
InsertAction QueryUserInsert (const QString &msg)
 For multiple channels. More...
 
UpdateAction QueryUserUpdate (const QString &msg)
 For multiple channels. More...
 
OkCancelType QueryUserResolve (const ScanDTVTransport &transport, ChannelInsertInfo &chan)
 For a single channel. More...
 
OkCancelType QueryUserInsert (const ScanDTVTransport &transport, ChannelInsertInfo &chan)
 For a single channel. More...
 
OkCancelType ShowManualChannelPopup (const QString &title, const QString &message, QString &text)
 
OkCancelType ShowResolveChannelPopup (const QString &title, const QString &message, QString &text)
 

Static Protected Member Functions

static QString toString (ChannelType type)
 
static void MergeSameFrequency (ScanDTVTransportList &transports)
 
static void RemoveDuplicates (ScanDTVTransportList &transports, ScanDTVTransportList &duplicates)
 
static void FilterRelocatedServices (ScanDTVTransportList &transports)
 
static QString ComputeSuggestedChannelNum (const ChannelInsertInfo &chan)
 Compute a suggested channel number that is unique in the video source. More...
 
static void FixUpOpenCable (ScanDTVTransportList &transports)
 
static ChannelImporterBasicStats CollectStats (const ScanDTVTransportList &transports)
 
static ChannelImporterUniquenessStats CollectUniquenessStats (const ScanDTVTransportList &transports, const ChannelImporterBasicStats &info)
 
static QString FormatChannels (const ScanDTVTransportList &transports, const ChannelImporterBasicStats *info=nullptr)
 
static QString FormatChannel (const ScanDTVTransport &transport, const ChannelInsertInfo &chan, const ChannelImporterBasicStats *info=nullptr)
 
static QString SimpleFormatChannel (const ScanDTVTransport &transport, const ChannelInsertInfo &chan)
 Format channel information into a simple string. More...
 
static QString FormatTransport (const ScanDTVTransport &transport)
 
static QString FormatTransports (const ScanDTVTransportList &transports_in)
 
static QString GetSummary (const ChannelImporterBasicStats &info, const ChannelImporterUniquenessStats &stats)
 
static bool IsType (const ChannelImporterBasicStats &info, const ChannelInsertInfo &chan, ChannelType type)
 
static void CountChannels (const ScanDTVTransportList &transports, const ChannelImporterBasicStats &info, ChannelType type, uint &new_chan, uint &old_chan)
 
static int SimpleCountChannels (const ScanDTVTransportList &transports)
 
static bool CheckChannelNumber (const QString &num, const ChannelInsertInfo &chan)
 
static void AddChanToCopy (ScanDTVTransport &transport_copy, const ScanDTVTransport &transport, const ChannelInsertInfo &chan)
 

Private Attributes

bool m_useGui
 
bool m_isInteractive
 
bool m_useWeb {false}
 
bool m_doDelete
 
bool m_doInsert
 
bool m_doSave
 
bool m_doLcn {true}
 
bool m_doScn {true}
 
bool m_ftaOnly {true}
 
bool m_lcnOnly {false}
 
bool m_completeOnly {true}
 
bool m_keepChannelNumbers {true}
 
bool m_fullChannelSearch {false}
 
bool m_removeDuplicates {false}
 
bool m_success {false}
 
int m_lcnOffset {0}
 
int m_functorRetval {0}
 
ChannelScannerWeb * m_pWeb {nullptr}
 
ServiceRequirements m_serviceRequirements
 
QEventLoop m_eventLoop
 

Detailed Description

Definition at line 71 of file channelimporter.h.

Member Enumeration Documentation

◆ ChannelType

enum ChannelImporter::ChannelType : std::uint8_t
protected
Enumerator
kChannelTypeFirst 
kChannelTypeNonConflictingFirst 
kATSCNonConflicting 
kDVBNonConflicting 
kSCTENonConflicting 
kMPEGNonConflicting 
kNTSCNonConflicting 
kChannelTypeNonConflictingLast 
kChannelTypeConflictingFirst 
kATSCConflicting 
kDVBConflicting 
kSCTEConflicting 
kMPEGConflicting 
kNTSCConflicting 
kChannelTypeConflictingLast 
kChannelTypeLast 

Definition at line 107 of file channelimporter.h.

◆ DeleteAction

enum ChannelImporter::DeleteAction : std::uint8_t
protected
Enumerator
kDeleteAll 
kDeleteManual 
kDeleteIgnoreAll 
kDeleteInvisibleAll 

Definition at line 87 of file channelimporter.h.

◆ InsertAction

enum ChannelImporter::InsertAction : std::uint8_t
protected
Enumerator
kInsertAll 
kInsertManual 
kInsertIgnoreAll 

Definition at line 94 of file channelimporter.h.

◆ UpdateAction

enum ChannelImporter::UpdateAction : std::uint8_t
protected
Enumerator
kUpdateAll 
kUpdateManual 
kUpdateIgnoreAll 

Definition at line 100 of file channelimporter.h.

Constructor & Destructor Documentation

◆ ChannelImporter()

ChannelImporter::ChannelImporter ( bool  gui,
bool  interactive,
bool  _delete,
bool  insert,
bool  save,
bool  fta_only,
bool  lcn_only,
bool  complete_only,
bool  full_channel_search,
bool  remove_duplicates,
ServiceRequirements  service_requirements,
bool  success = false 
)

Definition at line 76 of file channelimporter.cpp.

Member Function Documentation

◆ AddChanToCopy()

void ChannelImporter::AddChanToCopy ( ScanDTVTransport &  transport_copy,
const ScanDTVTransport &  transport,
const ChannelInsertInfo &  chan 
)
staticprotected

Definition at line 944 of file channelimporter.cpp.

Referenced by DeleteChannels(), InsertChannels(), and UpdateChannels().

◆ ChannelNumbers()

void ChannelImporter::ChannelNumbers ( ScanDTVTransportList &  transports) const
protected

Definition at line 1203 of file channelimporter.cpp.

Referenced by Process().

◆ CheckChannelNumber()

bool ChannelImporter::CheckChannelNumber ( const QString &  num,
const ChannelInsertInfo &  chan 
)
staticprotected

Definition at line 2529 of file channelimporter.cpp.

Referenced by InsertChannels(), QueryUserInsert(), and QueryUserResolve().

◆ CollectStats()

ChannelImporterBasicStats ChannelImporter::CollectStats ( const ScanDTVTransportList &  transports)
staticprotected

Definition at line 1470 of file channelimporter.cpp.

Referenced by DeleteChannels(), InsertChannels(), and Process().

◆ CollectUniquenessStats()

ChannelImporterUniquenessStats ChannelImporter::CollectUniquenessStats ( const ScanDTVTransportList &  transports,
const ChannelImporterBasicStats &  info 
)
staticprotected

Definition at line 1509 of file channelimporter.cpp.

Referenced by InsertChannels(), and Process().

◆ ComputeSuggestedChannelNum()

QString ChannelImporter::ComputeSuggestedChannelNum ( const ChannelInsertInfo &  chan)
staticprotected

Compute a suggested channel number that is unique in the video source.

Check first to see if the existing channel number conflicts with an existing channel number. If so, try adding a suffix starting with 'A' to make the number unique while still being recognizable. For instance, the second "7-2" channel will be called "7-2A". If this fails then fall back to incrementing a per-source number to find an unused value.

Parameters
chanInfo describing a channel
Returns
Returns a simple name for the channel.

Definition at line 1876 of file channelimporter.cpp.

Referenced by InsertChannels(), QueryUserInsert(), and QueryUserResolve().

◆ CountChannels()

void ChannelImporter::CountChannels ( const ScanDTVTransportList &  transports,
const ChannelImporterBasicStats &  info,
ChannelType  type,
uint &  new_chan,
uint &  old_chan 
)
staticprotected

Definition at line 1832 of file channelimporter.cpp.

Referenced by InsertChannels().

◆ DeleteChannels()

uint ChannelImporter::DeleteChannels ( ScanDTVTransportList &  transports)
protected

Definition at line 314 of file channelimporter.cpp.

Referenced by Process().

◆ DeleteUnusedTransports()

uint ChannelImporter::DeleteUnusedTransports ( uint  sourceid)
protected

Definition at line 413 of file channelimporter.cpp.

Referenced by Process().

◆ FilterRelocatedServices()

void ChannelImporter::FilterRelocatedServices ( ScanDTVTransportList &  transports)
staticprotected

Definition at line 1166 of file channelimporter.cpp.

Referenced by Process().

◆ FilterServices()

void ChannelImporter::FilterServices ( ScanDTVTransportList &  transports) const
protected

Definition at line 1090 of file channelimporter.cpp.

Referenced by Process().

◆ FixUpOpenCable()

void ChannelImporter::FixUpOpenCable ( ScanDTVTransportList &  transports)
staticprotected

Definition at line 1454 of file channelimporter.cpp.

Referenced by Process().

◆ FormatChannel()

QString ChannelImporter::FormatChannel ( const ScanDTVTransport &  transport,
const ChannelInsertInfo &  chan,
const ChannelImporterBasicStats *  info = nullptr 
)
staticprotected

Definition at line 1545 of file channelimporter.cpp.

Referenced by FilterRelocatedServices(), FilterServices(), and FormatChannels().

◆ FormatChannels()

QString ChannelImporter::FormatChannels ( const ScanDTVTransportList &  transports,
const ChannelImporterBasicStats *  info = nullptr 
)
staticprotected

Definition at line 1685 of file channelimporter.cpp.

Referenced by DeleteChannels(), InsertChannels(), and Process().

◆ FormatTransport()

QString ChannelImporter::FormatTransport ( const ScanDTVTransport &  transport)
staticprotected

Definition at line 1713 of file channelimporter.cpp.

Referenced by FormatTransports(), MergeSameFrequency(), and RemoveDuplicates().

◆ FormatTransports()

QString ChannelImporter::FormatTransports ( const ScanDTVTransportList &  transports_in)
staticprotected

Definition at line 1725 of file channelimporter.cpp.

Referenced by InsertChannels(), and Process().

◆ GetDBTransports()

ScanDTVTransportList ChannelImporter::GetDBTransports ( uint  sourceid,
ScanDTVTransportList &  transports 
) const
protected

Adds found channel info to transports list, returns channels in DB which were not found in scan in another transport list.

This can be the same transport if e.g. one channel is in the DB but not in the scan, but it can also contain transports that are not found in the scan.

Definition at line 1304 of file channelimporter.cpp.

Referenced by Process().

◆ GetSummary()

QString ChannelImporter::GetSummary ( const ChannelImporterBasicStats &  info,
const ChannelImporterUniquenessStats &  stats 
)
staticprotected

Definition at line 1745 of file channelimporter.cpp.

Referenced by InsertChannels(), and Process().

◆ InsertChannels() [1/2]

void ChannelImporter::InsertChannels ( const ScanDTVTransportList &  transports,
const ChannelImporterBasicStats &  info 
)
protected

Definition at line 468 of file channelimporter.cpp.

Referenced by InsertChannels(), and Process().

◆ InsertChannels() [2/2]

ScanDTVTransportList ChannelImporter::InsertChannels ( const ScanDTVTransportList &  transports,
const ChannelImporterBasicStats &  info,
InsertAction  action,
ChannelType  type,
ScanDTVTransportList &  inserted,
ScanDTVTransportList &  skipped 
)
protected

Definition at line 604 of file channelimporter.cpp.

◆ IsType()

bool ChannelImporter::IsType ( const ChannelImporterBasicStats &  info,
const ChannelInsertInfo &  chan,
ChannelType  type 
)
staticprotected

Definition at line 1777 of file channelimporter.cpp.

Referenced by CountChannels(), InsertChannels(), and UpdateChannels().

◆ MergeSameFrequency()

void ChannelImporter::MergeSameFrequency ( ScanDTVTransportList &  transports)
staticprotected

Definition at line 963 of file channelimporter.cpp.

Referenced by Process().

◆ Process()

void ChannelImporter::Process ( const ScanDTVTransportList &  _transports,
int  sourceid = -1 
)

Definition at line 103 of file channelimporter.cpp.

Referenced by ChannelScannerWeb::HandleEvent(), main(), ChannelScannerCLI::Process(), ChannelScannerGUI::Process(), ChannelScannerWeb::Process(), and ScanWizard::Scan().

◆ QueryUserDelete()

ChannelImporter::DeleteAction ChannelImporter::QueryUserDelete ( const QString &  msg)
protected

For multiple channels.

Definition at line 1910 of file channelimporter.cpp.

Referenced by DeleteChannels(), and DeleteUnusedTransports().

◆ QueryUserInsert() [1/2]

ChannelImporter::InsertAction ChannelImporter::QueryUserInsert ( const QString &  msg)
protected

For multiple channels.

Definition at line 1998 of file channelimporter.cpp.

Referenced by InsertChannels().

◆ QueryUserInsert() [2/2]

OkCancelType ChannelImporter::QueryUserInsert ( const ScanDTVTransport &  transport,
ChannelInsertInfo &  chan 
)
protected

For a single channel.

Definition at line 2445 of file channelimporter.cpp.

◆ QueryUserResolve()

OkCancelType ChannelImporter::QueryUserResolve ( const ScanDTVTransport &  transport,
ChannelInsertInfo &  chan 
)
protected

For a single channel.

Definition at line 2367 of file channelimporter.cpp.

Referenced by InsertChannels().

◆ QueryUserUpdate()

ChannelImporter::UpdateAction ChannelImporter::QueryUserUpdate ( const QString &  msg)
protected

For multiple channels.

Definition at line 2083 of file channelimporter.cpp.

Referenced by InsertChannels().

◆ RemoveDuplicates()

void ChannelImporter::RemoveDuplicates ( ScanDTVTransportList &  transports,
ScanDTVTransportList &  duplicates 
)
staticprotected

Definition at line 1026 of file channelimporter.cpp.

Referenced by Process().

◆ ShowManualChannelPopup()

OkCancelType ChannelImporter::ShowManualChannelPopup ( const QString &  title,
const QString &  message,
QString &  text 
)
protected

Definition at line 2164 of file channelimporter.cpp.

Referenced by QueryUserInsert().

◆ ShowResolveChannelPopup()

OkCancelType ChannelImporter::ShowResolveChannelPopup ( const QString &  title,
const QString &  message,
QString &  text 
)
protected

Definition at line 2264 of file channelimporter.cpp.

Referenced by QueryUserResolve().

◆ SimpleCountChannels()

int ChannelImporter::SimpleCountChannels ( const ScanDTVTransportList &  transports)
staticprotected

Definition at line 1853 of file channelimporter.cpp.

Referenced by DeleteChannels(), InsertChannels(), and Process().

◆ SimpleFormatChannel()

QString ChannelImporter::SimpleFormatChannel ( const ScanDTVTransport &  transport,
const ChannelInsertInfo &  chan 
)
staticprotected

Format channel information into a simple string.

The format of this string will depend on the type of standard used for the channels (atsc/scte/opencable/dvb).

Parameters
transportUnused.
chanInfo describing a channel
Returns
Returns a simple name for the channel.

Definition at line 1628 of file channelimporter.cpp.

Referenced by QueryUserInsert(), and QueryUserResolve().

◆ toString()

QString ChannelImporter::toString ( ChannelType  type)
staticprotected

Definition at line 292 of file channelimporter.cpp.

Referenced by InsertChannels().

◆ UpdateChannels()

ScanDTVTransportList ChannelImporter::UpdateChannels ( const ScanDTVTransportList &  transports,
const ChannelImporterBasicStats &  info,
UpdateAction  action,
ChannelType  type,
ScanDTVTransportList &  updated,
ScanDTVTransportList &  skipped 
) const
protected

Definition at line 806 of file channelimporter.cpp.

Referenced by InsertChannels().

Member Data Documentation

◆ m_completeOnly

bool ChannelImporter::m_completeOnly {true}
private

Definition at line 256 of file channelimporter.h.

Referenced by FilterServices(), and Process().

◆ m_doDelete

bool ChannelImporter::m_doDelete
private

Definition at line 249 of file channelimporter.h.

Referenced by Process().

◆ m_doInsert

bool ChannelImporter::m_doInsert
private

Definition at line 250 of file channelimporter.h.

Referenced by Process().

◆ m_doLcn

bool ChannelImporter::m_doLcn {true}
private

Definition at line 252 of file channelimporter.h.

Referenced by Process().

◆ m_doSave

bool ChannelImporter::m_doSave
private

Definition at line 251 of file channelimporter.h.

Referenced by Process().

◆ m_doScn

bool ChannelImporter::m_doScn {true}
private

Definition at line 253 of file channelimporter.h.

Referenced by ChannelNumbers().

◆ m_eventLoop

QEventLoop ChannelImporter::m_eventLoop
private

Definition at line 266 of file channelimporter.h.

Referenced by QueryUserDelete(), QueryUserInsert(), QueryUserUpdate(), ShowManualChannelPopup(), and ShowResolveChannelPopup().

◆ m_ftaOnly

bool ChannelImporter::m_ftaOnly {true}
private

Definition at line 254 of file channelimporter.h.

Referenced by FilterServices(), and Process().

◆ m_fullChannelSearch

bool ChannelImporter::m_fullChannelSearch {false}
private

Definition at line 258 of file channelimporter.h.

Referenced by GetDBTransports(), and Process().

◆ m_functorRetval

int ChannelImporter::m_functorRetval {0}
private

Definition at line 262 of file channelimporter.h.

Referenced by QueryUserDelete(), QueryUserInsert(), QueryUserUpdate(), ShowManualChannelPopup(), and ShowResolveChannelPopup().

◆ m_isInteractive

bool ChannelImporter::m_isInteractive
private

Definition at line 247 of file channelimporter.h.

Referenced by InsertChannels(), QueryUserDelete(), QueryUserInsert(), QueryUserResolve(), and QueryUserUpdate().

◆ m_keepChannelNumbers

bool ChannelImporter::m_keepChannelNumbers {true}
private

Definition at line 257 of file channelimporter.h.

Referenced by UpdateChannels().

◆ m_lcnOffset

int ChannelImporter::m_lcnOffset {0}
private

Definition at line 261 of file channelimporter.h.

Referenced by ChannelNumbers(), and Process().

◆ m_lcnOnly

bool ChannelImporter::m_lcnOnly {false}
private

Definition at line 255 of file channelimporter.h.

Referenced by FilterServices(), and Process().

◆ m_pWeb

ChannelScannerWeb* ChannelImporter::m_pWeb {nullptr}
private

Definition at line 263 of file channelimporter.h.

Referenced by ChannelImporter(), DeleteChannels(), DeleteUnusedTransports(), Process(), QueryUserDelete(), QueryUserInsert(), QueryUserUpdate(), ShowManualChannelPopup(), and ShowResolveChannelPopup().

◆ m_removeDuplicates

bool ChannelImporter::m_removeDuplicates {false}
private

Definition at line 259 of file channelimporter.h.

Referenced by Process().

◆ m_serviceRequirements

ServiceRequirements ChannelImporter::m_serviceRequirements
private

Definition at line 265 of file channelimporter.h.

Referenced by FilterServices(), and Process().

◆ m_success

bool ChannelImporter::m_success {false}
private

Definition at line 260 of file channelimporter.h.

Referenced by Process().

◆ m_useGui

bool ChannelImporter::m_useGui
private

Definition at line 246 of file channelimporter.h.

Referenced by ChannelImporter(), Process(), QueryUserDelete(), QueryUserInsert(), QueryUserResolve(), and QueryUserUpdate().

◆ m_useWeb

bool ChannelImporter::m_useWeb {false}
private

Definition at line 248 of file channelimporter.h.

Referenced by ChannelImporter(), DeleteChannels(), DeleteUnusedTransports(), Process(), QueryUserDelete(), QueryUserInsert(), QueryUserUpdate(), ShowManualChannelPopup(), and ShowResolveChannelPopup().

The documentation for this class was generated from the following files:
Generated on Sun Oct 19 2025 03:17:04 for MythTV by doxygen 1.9.4