This is the abstract base class for supporting recorder hardware. More...

#include <libmythtv/recorders/recorderbase.h>

Inheritance diagram for RecorderBase:

Collaboration diagram for RecorderBase:

Public Types
enum	AspectRatio { ASPECT_UNKNOWN = 0x00 , ASPECT_1_1 = 0x01 , ASPECT_4_3 = 0x02 , ASPECT_16_9 = 0x03 , ASPECT_2_21_1 = 0x04 , ASPECT_CUSTOM = 0x05 }

Public Member Functions
	RecorderBase (TVRec *rec)

	~RecorderBase () override

void	SetFrameRate (double rate)
	Sets the video frame rate. More...

void	SetRecording (const RecordingInfo *pginfo)
	Changes the Recording from the one set initially with SetOptionsFromProfile(). More...

void	SetRingBuffer (MythMediaBuffer *Buffer)
	Tells recorder to use an externally created ringbuffer. More...

virtual void	SetOption (const QString &name, const QString &value)
	Set an specific option. More...

virtual void	SetOption (const QString &name, int value)
	Set an specific integer option. More...

void	SetBoolOption (const QString &name, bool value)
	Set an specific boolean option. More...

virtual void	SetVideoFilters (QString &filters)=0
	Tells recorder which filters to use. More...

virtual void	SetOptionsFromProfile (RecordingProfile *profile, const QString &videodev, const QString &audiodev, const QString &vbidev)=0
	Sets basic recorder options. More...

void	SetNextRecording (const RecordingInfo ri, MythMediaBuffer Buffer)
	Sets next recording info, to be applied as soon as practical. More...

virtual void	Initialize (void)=0
	This is called between SetOptionsFromProfile() and run() to initialize any devices, etc. More...

void	run (void) override=0
	run() starts the recording process, and does not exit until the recording is complete. More...

virtual void	Reset (void)=0
	Reset the recorder to the startup state. More...

virtual bool	IsErrored (void)=0
	Tells us whether an unrecoverable error has been encountered. More...

virtual long long	GetFramesWritten (void)=0
	Returns number of frames written to disk. More...

virtual int	GetVideoFd (void)=0
	Returns file descriptor of recorder device. More...

long long	GetKeyframePosition (long long desired) const
	Returns closest keyframe position before the desired frame. More...

bool	GetKeyframePositions (long long start, long long end, frm_pos_map_t &map) const

bool	GetKeyframeDurations (long long start, long long end, frm_pos_map_t &map) const

virtual void	StopRecording (void)
	StopRecording() signals to the recorder that it should stop recording and exit cleanly. More...

virtual bool	IsRecording (void)
	Tells whether the StartRecorder() loop is running. More...

virtual bool	IsRecordingRequested (void)
	Tells us if StopRecording() has been called. More...

virtual RecordingQuality *	GetRecordingQuality (const RecordingInfo *ri) const
	Returns a report about the current recordings quality. More...

virtual void	Pause (bool clear=true)
	Pause tells recorder to pause, it should not block. More...

virtual void	Unpause (void)
	Unpause tells recorder to unpause. More...

virtual bool	IsPaused (bool holding_lock=false) const
	Returns true iff recorder is paused. More...

virtual bool	WaitForPause (std::chrono::milliseconds timeout=1s)
	WaitForPause blocks until recorder is actually paused, or timeout milliseconds elapse. More...

double	GetFrameRate (void) const
	Returns the latest frame rate. More...

virtual bool	CheckForRingBufferSwitch (void)
	If requested, switch to new RingBuffer/ProgramInfo objects. More...

void	SavePositionMap (bool force=false, bool finished=false)
	Save the seektable to the DB. More...

Static Public Member Functions
static RecorderBase *	CreateRecorder (TVRec tvrec, ChannelBase channel, RecordingProfile &profile, const GeneralDBOptions &genOpt)

Protected Member Functions
void	SetIntOption (RecordingProfile *profile, const QString &name)
	Convenience function used to set integer options from a profile. More...

void	SetStrOption (RecordingProfile *profile, const QString &name)
	Convenience function used to set QString options from a profile. More...

virtual bool	PauseAndWait (std::chrono::milliseconds timeout=100ms)
	If m_requestPause is true, sets pause and blocks up to timeout milliseconds or until unpaused, whichever is sooner. More...

virtual void	ResetForNewFile (void)=0

virtual void	SetRecordingStatus (RecStatus::Type status, const QString &file, int line)

virtual void	ClearStatistics (void)

virtual void	FinishRecording (void)

virtual void	StartNewFile (void)

void	SetPositionMapType (MarkTypes type)
	Set seektable type. More...

void	AspectChange (uint aspect, long long frame)
	Note a change in aspect ratio in the recordedmark table. More...

void	ResolutionChange (uint width, uint height, long long frame)
	Note a change in video size in the recordedmark table. More...

void	FrameRateChange (uint framerate, uint64_t frame)
	Note a change in video frame rate in the recordedmark table. More...

void	VideoScanChange (SCAN_t scan, uint64_t frame)
	Note a change in video scan type in the recordedmark table. More...

void	VideoCodecChange (AVCodecID vCodec)
	Note a change in video codec. More...

void	AudioCodecChange (AVCodecID aCodec)
	Note a change in audio codec. More...

void	SetDuration (std::chrono::milliseconds duration)
	Note the total duration in the recordedmark table. More...

void	SetTotalFrames (uint64_t total_frames)
	Note the total frames in the recordedmark table. More...

void	TryWriteProgStartMark (const frm_pos_map_t &durationDeltaCopy)

Protected Attributes
TVRec *	m_tvrec {nullptr}

MythMediaBuffer *	m_ringBuffer {nullptr}

bool	m_weMadeBuffer {true}

AVContainer	m_containerFormat {formatUnknown}

AVCodecID	m_primaryVideoCodec {AV_CODEC_ID_NONE}

AVCodecID	m_primaryAudioCodec {AV_CODEC_ID_NONE}

QString	m_videocodec {"rtjpeg"}

QString	m_videodevice

bool	m_ntsc {true}

bool	m_ntscFrameRate {true}

double	m_videoFrameRate {29.97}

uint	m_videoAspect {0}

uint	m_videoHeight {0}

uint	m_videoWidth {0}

MythAVRational	m_frameRate {0}

RecordingInfo *	m_curRecording {nullptr}

QMutex	m_pauseLock

bool	m_requestPause {false}

bool	m_paused {false}

QWaitCondition	m_pauseWait

QWaitCondition	m_unpauseWait

bool	m_requestRecording {false}
	True if API call has requested a recording be [re]started. More...

bool	m_recording {false}
	True while recording is actually being performed. More...

QWaitCondition	m_recordingWait

QMutex	m_nextRingBufferLock

MythMediaBuffer *	m_nextRingBuffer {nullptr}

RecordingInfo *	m_nextRecording {nullptr}

MythTimer	m_ringBufferCheckTimer

MarkTypes	m_positionMapType {MARK_GOP_BYFRAME}

QMutex	m_positionMapLock

frm_pos_map_t	m_positionMap

frm_pos_map_t	m_positionMapDelta

frm_pos_map_t	m_durationMap

frm_pos_map_t	m_durationMapDelta

MythTimer	m_positionMapTimer

qint64	m_estimatedProgStartMS {0}

long long	m_lastSavedKeyframe {0}

long long	m_lastSavedDuration {0}

QMutex	m_statisticsLock

QAtomicInt	m_timeOfFirstDataIsSet

QDateTime	m_timeOfFirstData

QAtomicInt	m_timeOfLatestDataCount

QAtomicInt	m_timeOfLatestDataPacketInterval

QDateTime	m_timeOfLatestData

MythTimer	m_timeOfLatestDataTimer

RecordingGaps	m_recordingGaps

Static Protected Attributes
static constexpr std::chrono::milliseconds	kTimeOfLatestDataIntervalTarget { 5s }
	timeOfLatest update interval target in milliseconds. More...

Friends
class	Transcode

Detailed Description

This is the abstract base class for supporting recorder hardware.

For a digital streams specialization, see the DTVRecorder. For a specialization for MPEG hardware encoded analog streams, see MpegRecorder.

See also: TVRec

Definition at line 50 of file recorderbase.h.

Member Enumeration Documentation

◆ AspectRatio

enum RecorderBase::AspectRatio

Enumerator
ASPECT_UNKNOWN
ASPECT_1_1
ASPECT_4_3
ASPECT_16_9
ASPECT_2_21_1
ASPECT_CUSTOM

Definition at line 220 of file recorderbase.h.

Constructor & Destructor Documentation

◆ RecorderBase()

RecorderBase::RecorderBase ( TVRec * rec )

explicit

Definition at line 47 of file recorderbase.cpp.

◆ ~RecorderBase()

RecorderBase::~RecorderBase ( void )

override

Definition at line 53 of file recorderbase.cpp.

Member Function Documentation

◆ AspectChange()

void RecorderBase::AspectChange	(	uint	aspect,
		long long	frame
	)

protected

Note a change in aspect ratio in the recordedmark table.

Definition at line 749 of file recorderbase.cpp.

Referenced by DTVRecorder::FindH2645Keyframes(), DTVRecorder::FindMPEG2Keyframes(), and DTVRecorder::FindPSKeyFrames().

◆ AudioCodecChange()

void RecorderBase::AudioCodecChange ( AVCodecID aCodec )

protected

Note a change in audio codec.

Definition at line 846 of file recorderbase.cpp.

Referenced by DTVRecorder::HandleSingleProgramPMT().

◆ CheckForRingBufferSwitch()

bool RecorderBase::CheckForRingBufferSwitch ( void )

virtual

If requested, switch to new RingBuffer/ProgramInfo objects.

Definition at line 356 of file recorderbase.cpp.

Referenced by DTVRecorder::HandleH2645Keyframe(), DTVRecorder::HandleKeyframe(), SavePositionMap(), and TVRec::SwitchLiveTVRingBuffer().

◆ ClearStatistics()

void RecorderBase::ClearStatistics ( void )

protectedvirtual

Reimplemented in DTVRecorder.

Definition at line 430 of file recorderbase.cpp.

Referenced by DTVRecorder::ClearStatistics(), and RecorderBase().

◆ CreateRecorder()

RecorderBase * RecorderBase::CreateRecorder	(	TVRec *	tvrec,
		ChannelBase *	channel,
		RecordingProfile &	profile,
		const GeneralDBOptions &	genOpt
	)

static

Definition at line 868 of file recorderbase.cpp.

Referenced by TVRec::TuningNewRecorderReal().

◆ FinishRecording()

void RecorderBase::FinishRecording ( void )

protectedvirtual

Reimplemented in DTVRecorder.

Definition at line 441 of file recorderbase.cpp.

Referenced by CheckForRingBufferSwitch(), and DTVRecorder::FinishRecording().

◆ FrameRateChange()

void RecorderBase::FrameRateChange	(	uint	framerate,
		uint64_t	frame
	)

protected

Note a change in video frame rate in the recordedmark table.

Definition at line 816 of file recorderbase.cpp.

Referenced by DTVRecorder::FindH2645Keyframes(), DTVRecorder::FindMPEG2Keyframes(), and DTVRecorder::FindPSKeyFrames().

◆ GetFrameRate()

double RecorderBase::GetFrameRate ( void ) const

inline

Returns the latest frame rate.

Definition at line 210 of file recorderbase.h.

Referenced by FinishRecording(), and TVRec::GetFramerate().

◆ GetFramesWritten()

virtual long long RecorderBase::GetFramesWritten ( void )

pure virtual

Returns number of frames written to disk.

It is not always safe to seek up to this frame in a player because frames may not be written in display order.

Implemented in DTVRecorder, and ImportRecorder.

Referenced by TVRec::GetFramesWritten().

◆ GetKeyframeDurations()

bool RecorderBase::GetKeyframeDurations	(	long long	start,
		long long	end,
		frm_pos_map_t &	map
	)		const

Definition at line 570 of file recorderbase.cpp.

Referenced by TVRec::GetKeyframeDurations().

◆ GetKeyframePosition()

long long RecorderBase::GetKeyframePosition ( long long desired ) const

Returns closest keyframe position before the desired frame.

This returns -1 if a keyframe position cannot be found for a frame. This could be true if the keyframe has not yet been seen by the recorder(unlikely), or if a keyframe map does not exist or is not up to date. The latter can happen because the video is an external video, because the database is corrupted, or because this is a live recording and it is being read by a remote frontend faster than the keyframes can be saved to the database.

Returns: Closest prior keyframe, or -1 if there is no prior known keyframe.

Definition at line 527 of file recorderbase.cpp.

Referenced by TVRec::GetKeyframePosition().

◆ GetKeyframePositions()

bool RecorderBase::GetKeyframePositions	(	long long	start,
		long long	end,
		frm_pos_map_t &	map
	)		const

Definition at line 548 of file recorderbase.cpp.

Referenced by TVRec::GetKeyframePositions().

◆ GetRecordingQuality()

RecordingQuality * RecorderBase::GetRecordingQuality ( const RecordingInfo * ri ) const

virtual

Returns a report about the current recordings quality.

Reimplemented in ImportRecorder, and DTVRecorder.

Definition at line 512 of file recorderbase.cpp.

Referenced by CheckForRingBufferSwitch(), DTVRecorder::GetRecordingQuality(), and TVRec::TeardownRecorder().

◆ GetVideoFd()

virtual int RecorderBase::GetVideoFd ( void )

pure virtual

Returns file descriptor of recorder device.

This is used by channel when only one open file descriptor is allowed on a device node. This is the case with video4linux devices and similar devices in BSD. It is not needed by newer drivers, such as those used for DVB.

Implemented in DTVRecorder, and MpegRecorder.

Referenced by TVRec::TuningNewRecorderReal(), and TVRec::TuningRestartRecorder().

◆ Initialize()

virtual void RecorderBase::Initialize ( void )

pure virtual

This is called between SetOptionsFromProfile() and run() to initialize any devices, etc.

Implemented in DTVRecorder, and MpegRecorder.

Referenced by TVRec::TuningNewRecorderReal().

◆ IsErrored()

virtual bool RecorderBase::IsErrored ( void )

pure virtual

Tells us whether an unrecoverable error has been encountered.

Implemented in DTVRecorder.

Referenced by TVRec::run(), and TVRec::TuningNewRecorderReal().

◆ IsPaused()

bool RecorderBase::IsPaused ( bool holding_lock = false ) const

virtual

Returns true iff recorder is paused.

Definition at line 286 of file recorderbase.cpp.

Referenced by TVRec::HandleTuning(), PauseAndWait(), CetonRecorder::PauseAndWait(), DVBRecorder::PauseAndWait(), ExternalRecorder::PauseAndWait(), FirewireRecorder::PauseAndWait(), HDHRRecorder::PauseAndWait(), IPTVRecorder::PauseAndWait(), MpegRecorder::PauseAndWait(), SatIPRecorder::PauseAndWait(), V4L2encRecorder::PauseAndWait(), IPTVRecorder::SetStreamData(), and WaitForPause().

◆ IsRecording()

bool RecorderBase::IsRecording ( void )

virtual

Tells whether the StartRecorder() loop is running.

Reimplemented in MpegRecorder.

Definition at line 248 of file recorderbase.cpp.

Referenced by TVRec::IsReallyRecording(), and TVRec::TuningNewRecorderReal().

◆ IsRecordingRequested()

bool RecorderBase::IsRecordingRequested ( void )

virtual

Tells us if StopRecording() has been called.

Definition at line 255 of file recorderbase.cpp.

Referenced by ASIRecorder::run(), CetonRecorder::run(), DVBRecorder::run(), ExternalRecorder::run(), FirewireRecorder::run(), HDHRRecorder::run(), ImportRecorder::run(), IPTVRecorder::run(), MpegRecorder::run(), SatIPRecorder::run(), and V4L2encRecorder::run().

◆ Pause()

void RecorderBase::Pause ( bool clear = true )

virtual

Pause tells recorder to pause, it should not block.

Once paused the recorder calls m_tvrec->RecorderPaused().

Parameters

clear if true any generated timecodes should be reset.

See also: Unpause(), WaitForPause()

Reimplemented in MpegRecorder.

Definition at line 268 of file recorderbase.cpp.

Referenced by TVRec::PauseRecorder().

◆ PauseAndWait()

bool RecorderBase::PauseAndWait ( std::chrono::milliseconds timeout = 100ms )

protectedvirtual

If m_requestPause is true, sets pause and blocks up to timeout milliseconds or until unpaused, whichever is sooner.

This is the where we actually do the pausing. For most recorders that need to do something special on pause, this is the method to overide.

Parameters

timeout number of milliseconds to wait defaults to 100.

Returns: true if recorder is paused.

Reimplemented in CetonRecorder, DVBRecorder, ExternalRecorder, FirewireRecorder, HDHRRecorder, IPTVRecorder, MpegRecorder, SatIPRecorder, and V4L2encRecorder.

Definition at line 331 of file recorderbase.cpp.

Referenced by ASIRecorder::run(), and V4LRecorder::RunVBIDevice().

◆ Reset()

virtual void RecorderBase::Reset ( void )

pure virtual

Reset the recorder to the startup state.

This is used after Pause(bool), WaitForPause() and after the RingBuffer's StopReads() method has been called.

Implemented in DTVRecorder, and MpegRecorder.

Referenced by TVRec::TuningRestartRecorder().

◆ ResetForNewFile()

virtual void RecorderBase::ResetForNewFile ( void )

protectedpure virtual

Implemented in DTVRecorder.

Referenced by CheckForRingBufferSwitch().

◆ ResolutionChange()

void RecorderBase::ResolutionChange	(	uint	width,
		uint	height,
		long long	frame
	)

protected

Note a change in video size in the recordedmark table.

Definition at line 800 of file recorderbase.cpp.

Referenced by DTVRecorder::FindH2645Keyframes(), DTVRecorder::FindMPEG2Keyframes(), and DTVRecorder::FindPSKeyFrames().

◆ run()

void RecorderBase::run ( void )

overridepure virtual

run() starts the recording process, and does not exit until the recording is complete.

See also: StopRecording()

Implemented in ASIRecorder, CetonRecorder, DVBRecorder, ExternalRecorder, FirewireRecorder, HDHRRecorder, ImportRecorder, IPTVRecorder, MpegRecorder, SatIPRecorder, and V4L2encRecorder.

◆ SavePositionMap()

void RecorderBase::SavePositionMap	(	bool	force = `false`,
		bool	finished = `false`
	)

Save the seektable to the DB.

This saves the position map delta to the database if force is true or there are 30 frames in the map or there are five frames in the map with less than 30 frames in the non-delta position map.

Parameters

force	If true this forces a DB sync.
finished	Is this a finished recording?

Definition at line 600 of file recorderbase.cpp.

Referenced by FinishRecording(), TVRec::run(), and SetNextRecording().

◆ SetBoolOption()

void RecorderBase::SetBoolOption	(	const QString &	name,
		bool	value
	)

inline

Set an specific boolean option.

This is a helper function to enforce type checking.

Definition at line 103 of file recorderbase.h.

◆ SetDuration()

void RecorderBase::SetDuration ( std::chrono::milliseconds duration )

protected

Note the total duration in the recordedmark table.

Definition at line 855 of file recorderbase.cpp.

Referenced by DTVRecorder::FinishRecording().

◆ SetFrameRate()

void RecorderBase::SetFrameRate ( double rate )

inline

Sets the video frame rate.

Definition at line 59 of file recorderbase.h.

Referenced by SetOption().

◆ SetIntOption()

void RecorderBase::SetIntOption	(	RecordingProfile *	profile,
		const QString &	name
	)

protected

Convenience function used to set integer options from a profile.

See also: SetOption(const QString&, int)

Definition at line 204 of file recorderbase.cpp.

Referenced by ASIRecorder::SetOptionsFromProfile(), and DTVRecorder::SetOptionsFromProfile().

◆ SetNextRecording()

void RecorderBase::SetNextRecording	(	const RecordingInfo *	ri,
		MythMediaBuffer *	Buffer
	)

Sets next recording info, to be applied as soon as practical.

This should not lose any frames on the switchover, and should initialize the RingBuffer stream with headers as appropriate.

The switch does not have to happen immediately, but should happen soon. (i.e. it can wait for a key frame..)

This calls TVRec::RingBufferChanged() when the switch happens.

Definition at line 125 of file recorderbase.cpp.

Referenced by TVRec::SwitchLiveTVRingBuffer(), and TVRec::SwitchRecordingRingBuffer().

◆ SetOption() [1/2]

void RecorderBase::SetOption	(	const QString &	name,
		const QString &	value
	)

virtual

Set an specific option.

Base options include: codec, videodevice, tvformat (ntsc,ntsc-jp,pal-m), vbiformat ("none","pal teletext","ntsc").

Reimplemented in DTVRecorder, V4LRecorder, and MpegRecorder.

Definition at line 154 of file recorderbase.cpp.

Referenced by SetIntOption(), DTVRecorder::SetOption(), and SetStrOption().

◆ SetOption() [2/2]

void RecorderBase::SetOption	(	const QString &	name,
		int	value
	)

virtual

Set an specific integer option.

There are no integer options in RecorderBase.

Reimplemented in DTVRecorder, V4LRecorder, and MpegRecorder.

Definition at line 197 of file recorderbase.cpp.

◆ SetOptionsFromProfile()

virtual void RecorderBase::SetOptionsFromProfile	(	RecordingProfile *	profile,
		const QString &	videodev,
		const QString &	audiodev,
		const QString &	vbidev
	)

pure virtual

Sets basic recorder options.

SetOptionsFromProfile is used to tell the recorder about the recording profile as well as the devices to use.

Implemented in ASIRecorder, DTVRecorder, FirewireRecorder, ImportRecorder, MpegRecorder, and V4L2encRecorder.

◆ SetPositionMapType()

void RecorderBase::SetPositionMapType ( MarkTypes type )

inlineprotected

Set seektable type.

Definition at line 255 of file recorderbase.h.

Referenced by DTVRecorder::DTVRecorder().

◆ SetRecording()

void RecorderBase::SetRecording ( const RecordingInfo * pginfo )

Changes the Recording from the one set initially with SetOptionsFromProfile().

This method is useful for LiveTV, when we do not want to pause the recorder for a SetOptionsFromProfile() call just because a new program is comming on.

See also: ChannelNameChanged(const QString&)

Definition at line 88 of file recorderbase.cpp.

Referenced by CheckForRingBufferSwitch(), TVRec::TuningNewRecorderReal(), TVRec::TuningRestartRecorder(), and ~RecorderBase().

◆ SetRecordingStatus()

void RecorderBase::SetRecordingStatus	(	RecStatus::Type	status,
		const QString &	file,
		int	line
	)

protectedvirtual

Definition at line 400 of file recorderbase.cpp.

Referenced by DTVRecorder::BufferedWrite(), DTVRecorder::HandleTimestamps(), ExternalRecorder::run(), ImportRecorder::run(), MpegRecorder::run(), and V4L2encRecorder::run().

◆ SetRingBuffer()

void RecorderBase::SetRingBuffer ( MythMediaBuffer * Buffer )

Tells recorder to use an externally created ringbuffer.

If this an external RingBuffer is set, it should be before any Initialize(), Open(), or StartRecorder() calls. Externally created RingBuffers are not deleted in the Recorder's destructor.

Definition at line 74 of file recorderbase.cpp.

Referenced by CheckForRingBufferSwitch(), TVRec::TuningFrequency(), TVRec::TuningNewRecorderReal(), and TVRec::TuningRestartRecorder().

◆ SetStrOption()

void RecorderBase::SetStrOption	(	RecordingProfile *	profile,
		const QString &	name
	)

protected

Convenience function used to set QString options from a profile.

See also: SetOption(const QString&, const QString&)

Definition at line 214 of file recorderbase.cpp.

Referenced by DTVRecorder::SetOptionsFromProfile().

◆ SetTotalFrames()

void RecorderBase::SetTotalFrames ( uint64_t total_frames )

protected

Note the total frames in the recordedmark table.

Definition at line 861 of file recorderbase.cpp.

Referenced by DTVRecorder::FinishRecording().

◆ SetVideoFilters()

virtual void RecorderBase::SetVideoFilters ( QString & filters )

pure virtual

Tells recorder which filters to use.

These filters are used by frame grabber encoders to lower the bitrate while keeping quality good. They must execute quickly so that frames are not lost by the recorder.

Implemented in DTVRecorder, and MpegRecorder.

Referenced by TVRec::SetVideoFiltersForChannel().

◆ StartNewFile()

virtual void RecorderBase::StartNewFile ( void )

inlineprotectedvirtual

Reimplemented in ASIRecorder, CetonRecorder, DVBRecorder, ExternalRecorder, HDHRRecorder, IPTVRecorder, SatIPRecorder, and V4L2encRecorder.

Definition at line 251 of file recorderbase.h.

Referenced by CheckForRingBufferSwitch().

◆ StopRecording()

void RecorderBase::StopRecording ( void )

virtual

StopRecording() signals to the recorder that it should stop recording and exit cleanly.

This function should block until recorder has finished up.

Reimplemented in V4LRecorder.

Definition at line 229 of file recorderbase.cpp.

Referenced by V4LRecorder::StopRecording(), TVRec::TeardownRecorder(), DTVRecorder::~DTVRecorder(), and IPTVRecorder::~IPTVRecorder().

◆ TryWriteProgStartMark()

void RecorderBase::TryWriteProgStartMark ( const frm_pos_map_t & durationDeltaCopy )

protected

Definition at line 666 of file recorderbase.cpp.

Referenced by SavePositionMap().

◆ Unpause()

void RecorderBase::Unpause ( void )

virtual

Unpause tells recorder to unpause.

This is an asynchronous call it should not wait block waiting for the command to be processed.

Definition at line 278 of file recorderbase.cpp.

Referenced by TVRec::TuningRestartRecorder().

◆ VideoCodecChange()

void RecorderBase::VideoCodecChange ( AVCodecID vCodec )

protected

Note a change in video codec.

Definition at line 837 of file recorderbase.cpp.

Referenced by DTVRecorder::HandleSingleProgramPMT().

◆ VideoScanChange()

void RecorderBase::VideoScanChange	(	SCAN_t	scan,
		uint64_t	frame
	)

protected

Note a change in video scan type in the recordedmark table.

Definition at line 831 of file recorderbase.cpp.

Referenced by DTVRecorder::FindH2645Keyframes().

◆ WaitForPause()

bool RecorderBase::WaitForPause ( std::chrono::milliseconds timeout = 1s )

virtual

WaitForPause blocks until recorder is actually paused, or timeout milliseconds elapse.

Parameters

timeout number of milliseconds to wait defaults to 1000.

Returns: true iff pause happened within timeout period.

Definition at line 303 of file recorderbase.cpp.

Friends And Related Function Documentation

◆ Transcode

friend class Transcode

friend

Definition at line 52 of file recorderbase.h.

Member Data Documentation

◆ kTimeOfLatestDataIntervalTarget

constexpr std::chrono::milliseconds RecorderBase::kTimeOfLatestDataIntervalTarget { 5s }

staticconstexprprotected

timeOfLatest update interval target in milliseconds.

Definition at line 360 of file recorderbase.h.

Referenced by DTVRecorder::BufferedWrite().

◆ m_containerFormat

AVContainer RecorderBase::m_containerFormat {formatUnknown}

protected

Definition at line 295 of file recorderbase.h.

Referenced by DTVRecorder::DTVRecorder(), FinishRecording(), MpegRecorder::SetOption(), and SetRecording().

◆ m_curRecording

RecordingInfo* RecorderBase::m_curRecording {nullptr}

protected

◆ m_durationMap

frm_pos_map_t RecorderBase::m_durationMap

protected

Definition at line 337 of file recorderbase.h.

Referenced by GetKeyframeDurations(), DTVRecorder::HandleH2645Keyframe(), DTVRecorder::HandleKeyframe(), and DTVRecorder::ResetForNewFile().

◆ m_durationMapDelta

frm_pos_map_t RecorderBase::m_durationMapDelta

protected

Definition at line 338 of file recorderbase.h.

Referenced by DTVRecorder::HandleH2645Keyframe(), DTVRecorder::HandleKeyframe(), DTVRecorder::ResetForNewFile(), and SavePositionMap().

◆ m_estimatedProgStartMS

qint64 RecorderBase::m_estimatedProgStartMS {0}

protected

Definition at line 342 of file recorderbase.h.

Referenced by SetRecording(), and TryWriteProgStartMark().

◆ m_frameRate

MythAVRational RecorderBase::m_frameRate {0}

protected

Definition at line 309 of file recorderbase.h.

Referenced by CheckForRingBufferSwitch(), DTVRecorder::FindH2645Keyframes(), DTVRecorder::FindMPEG2Keyframes(), DTVRecorder::FindPSKeyFrames(), and DTVRecorder::UpdateFramesWritten().

◆ m_lastSavedDuration

long long RecorderBase::m_lastSavedDuration {0}

protected

Definition at line 344 of file recorderbase.h.

Referenced by TryWriteProgStartMark().

◆ m_lastSavedKeyframe

long long RecorderBase::m_lastSavedKeyframe {0}

protected

Definition at line 343 of file recorderbase.h.

Referenced by TryWriteProgStartMark().

◆ m_nextRecording

RecordingInfo* RecorderBase::m_nextRecording {nullptr}

protected

Definition at line 329 of file recorderbase.h.

Referenced by CheckForRingBufferSwitch(), SetNextRecording(), and ~RecorderBase().

◆ m_nextRingBuffer

MythMediaBuffer* RecorderBase::m_nextRingBuffer {nullptr}

protected

Definition at line 328 of file recorderbase.h.

Referenced by CheckForRingBufferSwitch(), SetNextRecording(), and ~RecorderBase().

◆ m_nextRingBufferLock

QMutex RecorderBase::m_nextRingBufferLock

protected

Definition at line 327 of file recorderbase.h.

Referenced by CheckForRingBufferSwitch(), SetNextRecording(), and ~RecorderBase().

◆ m_ntsc

bool RecorderBase::m_ntsc {true}

protected

Definition at line 301 of file recorderbase.h.

Referenced by SetOption().

◆ m_ntscFrameRate

bool RecorderBase::m_ntscFrameRate {true}

protected

Definition at line 302 of file recorderbase.h.

◆ m_paused

bool RecorderBase::m_paused {false}

protected

Definition at line 316 of file recorderbase.h.

Referenced by IsPaused(), MpegRecorder::Pause(), PauseAndWait(), CetonRecorder::PauseAndWait(), DVBRecorder::PauseAndWait(), ExternalRecorder::PauseAndWait(), FirewireRecorder::PauseAndWait(), HDHRRecorder::PauseAndWait(), IPTVRecorder::PauseAndWait(), MpegRecorder::PauseAndWait(), SatIPRecorder::PauseAndWait(), and V4L2encRecorder::PauseAndWait().

◆ m_pauseLock

QMutex RecorderBase::m_pauseLock

mutableprotected

◆ m_pauseWait

QWaitCondition RecorderBase::m_pauseWait

protected

Definition at line 317 of file recorderbase.h.

Referenced by PauseAndWait(), CetonRecorder::PauseAndWait(), DVBRecorder::PauseAndWait(), ExternalRecorder::PauseAndWait(), FirewireRecorder::PauseAndWait(), HDHRRecorder::PauseAndWait(), IPTVRecorder::PauseAndWait(), MpegRecorder::PauseAndWait(), SatIPRecorder::PauseAndWait(), V4L2encRecorder::PauseAndWait(), MpegRecorder::ReaderPaused(), and WaitForPause().

◆ m_positionMap

frm_pos_map_t RecorderBase::m_positionMap

protected

Definition at line 335 of file recorderbase.h.

Referenced by GetKeyframePosition(), GetKeyframePositions(), DTVRecorder::HandleH2645Keyframe(), DTVRecorder::HandleKeyframe(), DTVRecorder::ResetForNewFile(), and SavePositionMap().

◆ m_positionMapDelta

frm_pos_map_t RecorderBase::m_positionMapDelta

protected

Definition at line 336 of file recorderbase.h.

Referenced by DTVRecorder::HandleH2645Keyframe(), DTVRecorder::HandleKeyframe(), DTVRecorder::ResetForNewFile(), and SavePositionMap().

◆ m_positionMapLock

QMutex RecorderBase::m_positionMapLock

mutableprotected

Definition at line 334 of file recorderbase.h.

Referenced by GetKeyframeDurations(), GetKeyframePosition(), GetKeyframePositions(), DTVRecorder::HandleH2645Keyframe(), DTVRecorder::HandleKeyframe(), DTVRecorder::ResetForNewFile(), and SavePositionMap().

◆ m_positionMapTimer

MythTimer RecorderBase::m_positionMapTimer

protected

Definition at line 339 of file recorderbase.h.

Referenced by SavePositionMap().

◆ m_positionMapType

MarkTypes RecorderBase::m_positionMapType {MARK_GOP_BYFRAME}

protected

Definition at line 333 of file recorderbase.h.

Referenced by SavePositionMap().

◆ m_primaryAudioCodec

AVCodecID RecorderBase::m_primaryAudioCodec {AV_CODEC_ID_NONE}

protected

Definition at line 297 of file recorderbase.h.

Referenced by FinishRecording(), DTVRecorder::HandleSingleProgramPMT(), and DTVRecorder::ResetForNewFile().

◆ m_primaryVideoCodec

AVCodecID RecorderBase::m_primaryVideoCodec {AV_CODEC_ID_NONE}

protected

Definition at line 296 of file recorderbase.h.

Referenced by FinishRecording(), DTVRecorder::HandleSingleProgramPMT(), and DTVRecorder::ResetForNewFile().

◆ m_recording

bool RecorderBase::m_recording {false}

protected

True while recording is actually being performed.

Definition at line 322 of file recorderbase.h.

Referenced by IsRecording(), MpegRecorder::IsRecording(), ASIRecorder::run(), CetonRecorder::run(), DVBRecorder::run(), ExternalRecorder::run(), FirewireRecorder::run(), HDHRRecorder::run(), ImportRecorder::run(), IPTVRecorder::run(), MpegRecorder::run(), SatIPRecorder::run(), V4L2encRecorder::run(), and StopRecording().

◆ m_recordingGaps

RecordingGaps RecorderBase::m_recordingGaps

protected

Definition at line 358 of file recorderbase.h.

Referenced by ClearStatistics(), GetRecordingQuality(), DTVRecorder::HandleTimestamps(), and MpegRecorder::run().

◆ m_recordingWait

QWaitCondition RecorderBase::m_recordingWait

protected

Definition at line 323 of file recorderbase.h.

Referenced by ASIRecorder::run(), CetonRecorder::run(), DVBRecorder::run(), ExternalRecorder::run(), FirewireRecorder::run(), HDHRRecorder::run(), ImportRecorder::run(), IPTVRecorder::run(), MpegRecorder::run(), SatIPRecorder::run(), V4L2encRecorder::run(), and StopRecording().

◆ m_requestPause

bool RecorderBase::m_requestPause {false}

protected

◆ m_requestRecording

bool RecorderBase::m_requestRecording {false}

protected

True if API call has requested a recording be [re]started.

Definition at line 320 of file recorderbase.h.

Referenced by V4LRecorder::IsHelperRequested(), IsRecordingRequested(), ASIRecorder::run(), CetonRecorder::run(), DVBRecorder::run(), ExternalRecorder::run(), FirewireRecorder::run(), HDHRRecorder::run(), ImportRecorder::run(), IPTVRecorder::run(), MpegRecorder::run(), SatIPRecorder::run(), V4L2encRecorder::run(), and StopRecording().

◆ m_ringBuffer

MythMediaBuffer* RecorderBase::m_ringBuffer {nullptr}

protected

Definition at line 292 of file recorderbase.h.

Referenced by DTVRecorder::BufferedWrite(), CheckForRingBufferSwitch(), DTVRecorder::FindAudioKeyframes(), DTVRecorder::FindH2645Keyframes(), DTVRecorder::FindMPEG2Keyframes(), DTVRecorder::FindOtherKeyframes(), DTVRecorder::FindPSKeyFrames(), FinishRecording(), DTVRecorder::FinishRecording(), DTVRecorder::HandleKeyframe(), DTVRecorder::HandleSingleProgramPAT(), DTVRecorder::HandleSingleProgramPMT(), DTVRecorder::ProcessAudioTSPacket(), DTVRecorder::ProcessVideoTSPacket(), ASIRecorder::run(), DVBRecorder::run(), HDHRRecorder::run(), ImportRecorder::run(), SatIPRecorder::run(), SavePositionMap(), SetNextRecording(), SetRingBuffer(), ASIRecorder::StartNewFile(), DVBRecorder::StartNewFile(), HDHRRecorder::StartNewFile(), SatIPRecorder::StartNewFile(), ImportRecorder::UpdateRecSize(), and ~RecorderBase().

◆ m_ringBufferCheckTimer

MythTimer RecorderBase::m_ringBufferCheckTimer

protected

Definition at line 330 of file recorderbase.h.

Referenced by CheckForRingBufferSwitch(), and SavePositionMap().

◆ m_statisticsLock

QMutex RecorderBase::m_statisticsLock

mutableprotected

Definition at line 351 of file recorderbase.h.

Referenced by DTVRecorder::BufferedWrite(), ClearStatistics(), GetRecordingQuality(), DTVRecorder::HandleTimestamps(), and MpegRecorder::run().

◆ m_timeOfFirstData

QDateTime RecorderBase::m_timeOfFirstData

protected

Definition at line 353 of file recorderbase.h.

Referenced by DTVRecorder::BufferedWrite(), ClearStatistics(), and GetRecordingQuality().

◆ m_timeOfFirstDataIsSet

QAtomicInt RecorderBase::m_timeOfFirstDataIsSet

protected

Definition at line 352 of file recorderbase.h.

Referenced by DTVRecorder::BufferedWrite(), and ClearStatistics().

◆ m_timeOfLatestData

QDateTime RecorderBase::m_timeOfLatestData

protected

Definition at line 356 of file recorderbase.h.

Referenced by DTVRecorder::BufferedWrite(), ClearStatistics(), and GetRecordingQuality().

◆ m_timeOfLatestDataCount

QAtomicInt RecorderBase::m_timeOfLatestDataCount

protected

Definition at line 354 of file recorderbase.h.

Referenced by DTVRecorder::BufferedWrite(), and ClearStatistics().

◆ m_timeOfLatestDataPacketInterval

QAtomicInt RecorderBase::m_timeOfLatestDataPacketInterval

protected

Definition at line 355 of file recorderbase.h.

Referenced by DTVRecorder::BufferedWrite(), and ClearStatistics().

◆ m_timeOfLatestDataTimer

MythTimer RecorderBase::m_timeOfLatestDataTimer

protected

Definition at line 357 of file recorderbase.h.

Referenced by DTVRecorder::BufferedWrite().

◆ m_tvrec

◆ m_unpauseWait

QWaitCondition RecorderBase::m_unpauseWait

protected

◆ m_videoAspect

uint RecorderBase::m_videoAspect {0}

protected

Definition at line 305 of file recorderbase.h.

Referenced by AspectChange(), CheckForRingBufferSwitch(), DTVRecorder::FindH2645Keyframes(), DTVRecorder::FindMPEG2Keyframes(), DTVRecorder::FindPSKeyFrames(), and FinishRecording().

◆ m_videocodec

QString RecorderBase::m_videocodec {"rtjpeg"}

protected

Definition at line 298 of file recorderbase.h.

Referenced by SetOption().

◆ m_videodevice

QString RecorderBase::m_videodevice

protected

Definition at line 299 of file recorderbase.h.

Referenced by DVBRecorder::DVBRecorder(), DVBRecorder::Open(), ImportRecorder::Open(), MpegRecorder::OpenMpegFileAsInput(), MpegRecorder::OpenV4L2DeviceAsInput(), MpegRecorder::run(), SetOption(), and MpegRecorder::StartEncoding().

◆ m_videoFrameRate

double RecorderBase::m_videoFrameRate {29.97}

protected

Definition at line 303 of file recorderbase.h.

Referenced by DTVRecorder::FindAudioKeyframes().

◆ m_videoHeight

uint RecorderBase::m_videoHeight {0}

protected

Definition at line 307 of file recorderbase.h.

Referenced by AspectChange(), CheckForRingBufferSwitch(), DTVRecorder::FindH2645Keyframes(), DTVRecorder::FindMPEG2Keyframes(), DTVRecorder::FindPSKeyFrames(), and FinishRecording().

◆ m_videoWidth

uint RecorderBase::m_videoWidth {0}

protected

Definition at line 308 of file recorderbase.h.

Referenced by AspectChange(), CheckForRingBufferSwitch(), DTVRecorder::FindH2645Keyframes(), DTVRecorder::FindMPEG2Keyframes(), DTVRecorder::FindPSKeyFrames(), and FinishRecording().

◆ m_weMadeBuffer

bool RecorderBase::m_weMadeBuffer {true}

protected

Definition at line 293 of file recorderbase.h.

Referenced by SetRingBuffer(), and ~RecorderBase().

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

mythtv/libs/libmythtv/recorders/recorderbase.h
mythtv/libs/libmythtv/recorders/recorderbase.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ AspectRatio

Constructor & Destructor Documentation

◆ RecorderBase()

◆ ~RecorderBase()

Member Function Documentation

◆ AspectChange()

◆ AudioCodecChange()

◆ CheckForRingBufferSwitch()

◆ ClearStatistics()

◆ CreateRecorder()

◆ FinishRecording()

◆ FrameRateChange()

◆ GetFrameRate()

◆ GetFramesWritten()

◆ GetKeyframeDurations()

◆ GetKeyframePosition()

◆ GetKeyframePositions()

◆ GetRecordingQuality()

◆ GetVideoFd()

◆ Initialize()

◆ IsErrored()

◆ IsPaused()

◆ IsRecording()

◆ IsRecordingRequested()

◆ Pause()

◆ PauseAndWait()

◆ Reset()

◆ ResetForNewFile()

◆ ResolutionChange()

◆ run()

◆ SavePositionMap()

◆ SetBoolOption()

◆ SetDuration()

◆ SetFrameRate()

◆ SetIntOption()

◆ SetNextRecording()

◆ SetOption() [1/2]

◆ SetOption() [2/2]

◆ SetOptionsFromProfile()

◆ SetPositionMapType()

◆ SetRecording()

◆ SetRecordingStatus()

◆ SetRingBuffer()

◆ SetStrOption()

◆ SetTotalFrames()

◆ SetVideoFilters()

◆ StartNewFile()

◆ StopRecording()

◆ TryWriteProgStartMark()

◆ Unpause()

◆ VideoCodecChange()

◆ VideoScanChange()

◆ WaitForPause()

Friends And Related Function Documentation

◆ Transcode

Member Data Documentation

◆ kTimeOfLatestDataIntervalTarget

◆ m_containerFormat

◆ m_curRecording

◆ m_durationMap

◆ m_durationMapDelta

◆ m_estimatedProgStartMS

◆ m_frameRate

◆ m_lastSavedDuration

◆ m_lastSavedKeyframe

◆ m_nextRecording

◆ m_nextRingBuffer

◆ m_nextRingBufferLock

◆ m_ntsc

◆ m_ntscFrameRate

◆ m_paused