#include <textsubtitleparser.h>

Inheritance diagram for TextSubtitles:

Collaboration diagram for TextSubtitles:

Signals
void	TextSubtitlesUpdated ()

Public Member Functions
	TextSubtitles ()

	~TextSubtitles () override

bool	HasSubtitleChanged (uint64_t timecode) const
	Returns true in case the subtitle to display has changed since the last GetSubtitles() call. More...

QStringList	GetSubtitles (uint64_t timecode)
	Returns the subtitles to display at the given timecode. More...

bool	IsFrameBasedTiming (void) const
	Returns true in case the subtitle timing data is frame-based. More...

void	SetFrameBasedTiming (bool frameBasedTiming)

void	SetFilename (const QString &fileName)

void	AddSubtitle (const text_subtitle_t &newSub)

void	Clear (void)

void	SetLastLoaded (void)

void	SetByteCount (off_t count)

off_t	GetByteCount (void) const

void	SetInProgress (bool isInProgress)

void	SetHasSubtitles (bool hasSubs)

int	GetSubtitleCount (void) const

void	Lock (void)

void	Unlock (void)

Private Attributes
TextSubtitleList	m_subtitles

text_subtitle_t	m_lastReturnedSubtitle

bool	m_frameBasedTiming {false}

QString	m_fileName

QDateTime	m_lastLoaded

off_t	m_byteCount {0}

bool	m_isInProgress {false}

bool	m_hasSubtitles {false}

QRecursiveMutex	m_lock

Detailed Description

Definition at line 36 of file textsubtitleparser.h.

Constructor & Destructor Documentation

◆ TextSubtitles()

TextSubtitles::TextSubtitles ( )

inline

Definition at line 44 of file textsubtitleparser.h.

◆ ~TextSubtitles()

TextSubtitles::~TextSubtitles ( )

override

Definition at line 152 of file textsubtitleparser.cpp.

Member Function Documentation

◆ TextSubtitlesUpdated

void TextSubtitles::TextSubtitlesUpdated ( )

signal

Referenced by SetLastLoaded(), and SubtitleReader::SubtitleReader().

◆ HasSubtitleChanged()

bool TextSubtitles::HasSubtitleChanged ( uint64_t timecode ) const

Returns true in case the subtitle to display has changed since the last GetSubtitles() call.

This is used to avoid redisplaying subtitles that are already displaying.

Parameters

timecode The timecode (frame number or time stamp) of the current video position.

Returns: True in case new subtitles should be displayed.

Definition at line 167 of file textsubtitleparser.cpp.

Referenced by SubtitleScreen::DisplayTextSubtitles().

◆ GetSubtitles()

QStringList TextSubtitles::GetSubtitles ( uint64_t timecode )

Returns the subtitles to display at the given timecode.

Parameters

timecode The timecode (frame number or time stamp) of the current video position.

Returns: The subtitles as a list of strings.

Definition at line 180 of file textsubtitleparser.cpp.

Referenced by SubtitleScreen::DisplayTextSubtitles().

◆ IsFrameBasedTiming()

TextSubtitles::IsFrameBasedTiming ( void ) const

inline

Returns true in case the subtitle timing data is frame-based.

If the timing is frame-based, the client should use frame counts as timecodes for the HasSubtitleChanged() and GetSubtitles() methods, otherwise the timecode is milliseconds from the video start.

Definition at line 62 of file textsubtitleparser.h.

Referenced by SubtitleScreen::DisplayTextSubtitles(), GetSubtitles(), and TextSubtitleParser::LoadSubtitles().