MythTV  master
Public Types | Public Member Functions | Static Public Attributes | List of all members
FrameAnalyzer Class Referenceabstract

#include <mythcommflag/FrameAnalyzer.h>

Inheritance diagram for FrameAnalyzer:
[legend]

Public Types

enum  analyzeFrameResult : std::uint8_t { ANALYZE_OK, ANALYZE_ERROR, ANALYZE_FINISHED, ANALYZE_FATAL }
 
using FrameMap = QMap< long long, long long >
 

Public Member Functions

virtual ~FrameAnalyzer (void)=default
 
virtual const char * name (void) const =0
 
virtual enum analyzeFrameResult MythPlayerInited ([[maybe_unused]] MythPlayer *player, [[maybe_unused]] long long nframes)
 
virtual enum analyzeFrameResult analyzeFrame (const MythVideoFrame *frame, long long frameno, long long *pNextFrame)=0
 
virtual int finished ([[maybe_unused]] long long nframes, [[maybe_unused]] bool final)
 
virtual int reportTime (void) const
 
virtual FrameMap GetMap (unsigned int) const =0
 

Static Public Attributes

static const long long kAnyFrame = LLONG_MAX
 
static const long long kNextFrame = -1
 

Detailed Description

Definition at line 28 of file FrameAnalyzer.h.

Member Typedef Documentation

◆ FrameMap

using FrameAnalyzer::FrameMap = QMap<long long, long long>

Definition at line 45 of file FrameAnalyzer.h.

Member Enumeration Documentation

◆ analyzeFrameResult

enum FrameAnalyzer::analyzeFrameResult : std::uint8_t
Enumerator
ANALYZE_OK 
ANALYZE_ERROR 
ANALYZE_FINISHED 
ANALYZE_FATAL 

Definition at line 36 of file FrameAnalyzer.h.

Constructor & Destructor Documentation

◆ ~FrameAnalyzer()

virtual FrameAnalyzer::~FrameAnalyzer ( void  )
virtualdefault

Member Function Documentation

◆ name()

virtual const char* FrameAnalyzer::name ( void  ) const
pure virtual

◆ MythPlayerInited()

virtual enum analyzeFrameResult FrameAnalyzer::MythPlayerInited ( [[maybe_unused] ] MythPlayer player,
[[maybe_unused] ] long long  nframes 
)
inlinevirtual

Definition at line 47 of file FrameAnalyzer.h.

◆ analyzeFrame()

virtual enum analyzeFrameResult FrameAnalyzer::analyzeFrame ( const MythVideoFrame frame,
long long  frameno,
long long *  pNextFrame 
)
pure virtual

◆ finished()

virtual int FrameAnalyzer::finished ( [[maybe_unused] ] long long  nframes,
[[maybe_unused] ] bool  final 
)
inlinevirtual

Definition at line 63 of file FrameAnalyzer.h.

◆ reportTime()

virtual int FrameAnalyzer::reportTime ( void  ) const
inlinevirtual

Reimplemented in TemplateFinder, TemplateMatcher, SceneChangeDetector, and BlankFrameDetector.

Definition at line 68 of file FrameAnalyzer.h.

◆ GetMap()

virtual FrameMap FrameAnalyzer::GetMap ( unsigned int  ) const
pure virtual

Member Data Documentation

◆ kAnyFrame

const long long FrameAnalyzer::kAnyFrame = LLONG_MAX
static

◆ kNextFrame

const long long FrameAnalyzer::kNextFrame = -1
static

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