Abstract base class for post processors. More...

#include <PostProcessor.hh>

Inheritance diagram for openmsx::PostProcessor:

[legend]

Collaboration diagram for openmsx::PostProcessor:

[legend]

Public Member Functions
	~PostProcessor () override

virtual std::unique_ptr< RawFrame >	rotateFrames (std::unique_ptr< RawFrame > finishedFrame, EmuTime::param time)
	Sets up the "abcdFrame" variables for a new frame. More...

void	setSuperimposeVideoFrame (const RawFrame *videoSource)
	Set the Video frame on which to superimpose the 'normal' output of this PostProcessor. More...

void	setSuperimposeVdpFrame (const FrameSource *vdpSource)
	Set the VDP frame on which to superimpose the 'normal' output of this PostProcessor. More...

void	setRecorder (AviRecorder *recorder_)
	Start/stop recording. More...

bool	isRecording () const
	Is recording active. More...

unsigned	getBpp () const
	Get the number of bits per pixel for the pixels in these frames. More...

FrameSource *	getPaintFrame () const
	Get the frame that would be displayed. More...

void	takeRawScreenShot (unsigned height, const std::string &filename) override
	Create a raw (=non-post-processed) screenshot. More...

CliComm &	getCliComm ()

Public Member Functions inherited from openmsx::VideoLayer
	VideoLayer (const VideoLayer &)=delete

VideoLayer &	operator= (const VideoLayer &)=delete

int	getVideoSource () const
	Returns the ID for this VideoLayer. More...

int	getVideoSourceSetting () const

virtual void	takeRawScreenShot (unsigned height, const std::string &filename)=0
	Create a raw (=non-post-processed) screenshot. More...

void	setVideo9000Active (int video9000Source_, Video9000Active active)

bool	needRender () const

bool	needRecord () const

Public Member Functions inherited from openmsx::Layer
virtual	~Layer ()=default

virtual void	paint (OutputSurface &output)=0
	Paint this layer. More...

ZIndex	getZ () const
	Query the Z-index of this layer. More...

bool	isActive () const

Coverage	getCoverage () const
	Query the coverage of this layer. More...

void	setDisplay (LayerListener &display_)
	Store pointer to Display. More...

Protected Member Functions
	PostProcessor (MSXMotherBoard &motherBoard, Display &display, OutputSurface &screen, const std::string &videoSource, unsigned maxWidth, unsigned height, bool canDoInterlace)

Protected Member Functions inherited from openmsx::VideoLayer
	VideoLayer (MSXMotherBoard &motherBoard, const std::string &videoSource)

	~VideoLayer () override

void	update (const Setting &setting) noexcept override

Protected Member Functions inherited from openmsx::Layer
	Layer (Coverage coverage_=COVER_NONE, ZIndex z_=Z_DUMMY)
	Construct a layer. More...

void	setCoverage (Coverage coverage_)
	Changes the current coverage of this layer. More...

void	setZ (ZIndex z)
	Changes the current Z-index of this layer. More...

Protected Member Functions inherited from openmsx::Observer< Setting >
	Observer ()=default

	~Observer ()=default

	Observer (const Observer &)=delete

Observer &	operator= (const Observer &)=delete

virtual void	update (const Setting &subject) noexcept=0

virtual void	subjectDeleted (const Setting &)

Static Protected Member Functions
static unsigned	getLineWidth (FrameSource *frame, unsigned y, unsigned step)
	Returns the maximum width for lines [y..y+step). More...

Protected Attributes
RenderSettings &	renderSettings
	Render settings. More...

OutputSurface &	screen
	The surface which is visible to the user. More...

std::array< std::unique_ptr< RawFrame >, 4 >	lastFrames
	The last 4 fully rendered (unscaled) MSX frames. More...

std::unique_ptr< DeinterlacedFrame >	deinterlacedFrame
	Combined the last two frames in a deinterlaced frame. More...

std::unique_ptr< DoubledFrame >	interlacedFrame
	Each line of the last frame twice, to get double vertical resolution. More...

std::unique_ptr< Deflicker >	deflicker
	Combine the last 4 frames into one 'flicker-free' frame. More...

std::unique_ptr< SuperImposedFrame >	superImposedFrame
	Result of superimposing 2 frames. More...

FrameSource *	paintFrame = nullptr
	Represents a frame as it should be displayed. More...

AviRecorder *	recorder = nullptr
	Video recorder, nullptr when not recording. More...

const RawFrame *	superImposeVideoFrame = nullptr
	Video frame on which to superimpose the (VDP) output. More...

const FrameSource *	superImposeVdpFrame = nullptr

int	interleaveCount = 0

int	lastFramesCount = 0

unsigned	maxWidth

unsigned	height

Additional Inherited Members
Public Types inherited from openmsx::VideoLayer
enum	Video9000Active { INACTIVE , ACTIVE_FRONT , ACTIVE_BACK }

Public Types inherited from openmsx::Layer
enum	ZIndex { Z_DUMMY = -1 , Z_BACKGROUND = 0 , Z_MSX_PASSIVE = 30 , Z_MSX_ACTIVE = 40 , Z_OSDGUI = 50 , Z_CONSOLE = 100 }
	Determines stacking order of layers: layers with higher Z-indices are closer to the viewer. More...

enum	Coverage { COVER_FULL , COVER_PARTIAL , COVER_NONE }
	Describes how much of the screen is currently covered by a particular layer. More...

Detailed Description

Abstract base class for post processors.

A post processor builds the frame that is displayed from the MSX frame, while applying effects such as scalers, noise etc. TODO: With some refactoring, it would be possible to move much or even all of the post processing code here instead of in the subclasses.

Definition at line 30 of file PostProcessor.hh.

Constructor & Destructor Documentation

◆ ~PostProcessor()

openmsx::PostProcessor::~PostProcessor ( )

override

Definition at line 63 of file PostProcessor.cc.

References getCliComm(), openmsx::CliComm::printWarning(), recorder, and openmsx::AviRecorder::stop().

◆ PostProcessor()

openmsx::PostProcessor::PostProcessor	(	MSXMotherBoard &	motherBoard,
		Display &	display,
		OutputSurface &	screen,
		const std::string &	videoSource,
		unsigned	maxWidth,
		unsigned	height,
		bool	canDoInterlace
	)

protected

Definition at line 31 of file PostProcessor.cc.

References openmsx::SuperImposedFrame::create(), openmsx::Deflicker::create(), deflicker, deinterlacedFrame, openmsx::OutputSurface::getPixelFormat(), interlacedFrame, lastFrames, screen, and superImposedFrame.

Member Function Documentation

◆ getBpp()

unsigned openmsx::PostProcessor::getBpp ( ) const

Get the number of bits per pixel for the pixels in these frames.

Returns: Possible values are 15, 16 or 32

Definition at line 267 of file PostProcessor.cc.

References openmsx::PixelFormat::getBpp(), openmsx::OutputSurface::getPixelFormat(), and screen.

Referenced by takeRawScreenShot().

◆ getCliComm()

CliComm & openmsx::PostProcessor::getCliComm ( )

Definition at line 74 of file PostProcessor.cc.

References openmsx::Display::getCliComm().

Referenced by rotateFrames(), and ~PostProcessor().

◆ getLineWidth()

unsigned openmsx::PostProcessor::getLineWidth	(	FrameSource *	frame,
		unsigned	y,
		unsigned	step
	)

staticprotected

Returns the maximum width for lines [y..y+step).

Definition at line 79 of file PostProcessor.cc.

◆ getPaintFrame()

FrameSource * openmsx::PostProcessor::getPaintFrame ( ) const

inline

Get the frame that would be displayed.

E.g. so that it can be superimposed over the output of another PostProcessor, see setSuperimposeVdpFrame().

Definition at line 88 of file PostProcessor.hh.

References paintFrame.

◆ isRecording()

bool openmsx::PostProcessor::isRecording ( ) const

inline

Is recording active.

ATM used to keep frameskip constant during recording.

Definition at line 77 of file PostProcessor.hh.

References recorder.

◆ rotateFrames()

std::unique_ptr< RawFrame > openmsx::PostProcessor::rotateFrames	(	std::unique_ptr< RawFrame >	finishedFrame,
		EmuTime::param	time
	)

virtual

Sets up the "abcdFrame" variables for a new frame.

TODO: The point of passing the finished frame in and the new workFrame out is to be able to split off the scaler application as a separate class.

Parameters

finishedFrame	Frame that has just become available.
time	The moment in time the frame becomes available. Used to calculate the framerate for recording (depends on PAL/NTSC, frameskip).

Returns: RawFrame object that can be used for building the next frame.

Reimplemented in openmsx::FBPostProcessor< Pixel >, and openmsx::GLPostProcessor.

Definition at line 85 of file PostProcessor.cc.

References openmsx::AviRecorder::addImage(), deflicker, deinterlacedFrame, Math::e, openmsx::FrameSource::FIELD_NONINTERLACED, openmsx::FrameSource::FIELD_ODD, openmsx::get(), getCliComm(), openmsx::RenderSettings::getDeflicker(), openmsx::RenderSettings::getDeinterlace(), openmsx::RenderSettings::getInterleaveBlackFrame(), openmsx::OutputSurface::getPixelFormat(), height, interlacedFrame, lastFrames, lastFramesCount, maxWidth, openmsx::VideoLayer::needRecord(), paintFrame, openmsx::CliComm::printWarning(), recorder, renderSettings, screen, openmsx::Schedulable::setSyncPoint(), openmsx::AviRecorder::stop(), superImposedFrame, and superImposeVdpFrame.

Referenced by openmsx::FBPostProcessor< Pixel >::rotateFrames(), and openmsx::GLPostProcessor::rotateFrames().

◆ setRecorder()

void openmsx::PostProcessor::setRecorder ( AviRecorder * recorder_ )

inline

Start/stop recording.

Parameters

recorder_ Finished frames should be pushed to this AviRecorder. Can also be nullptr, meaning recording is stopped.

Definition at line 72 of file PostProcessor.hh.

References recorder.

◆ setSuperimposeVdpFrame()

void openmsx::PostProcessor::setSuperimposeVdpFrame ( const FrameSource * vdpSource )

inline

Set the VDP frame on which to superimpose the 'normal' output of this PostProcessor.

This is similar to the method above, except that now the superimposing is done before scaling. IOW both frames get scaled.

Definition at line 63 of file PostProcessor.hh.

References superImposeVdpFrame.

◆ setSuperimposeVideoFrame()

void openmsx::PostProcessor::setSuperimposeVideoFrame ( const RawFrame * videoSource )

inline

Set the Video frame on which to superimpose the 'normal' output of this PostProcessor.

Superimpose is done (preferably) after the normal output is scaled. IOW the video frame is (preferably) left unchanged, though exceptions are e.g. scalers that render scanlines, those are preferably also visible in the video frame.

Definition at line 54 of file PostProcessor.hh.

References superImposeVideoFrame.

◆ takeRawScreenShot()

void openmsx::PostProcessor::takeRawScreenShot	(	unsigned	height,
		const std::string &	filename
	)

overridevirtual

Create a raw (=non-post-processed) screenshot.

The 'height' parameter should be either '240' or '480'. The current image will be scaled to '320x240' or '640x480' and written to a png file.

Implements openmsx::VideoLayer.

Definition at line 254 of file PostProcessor.cc.

References getBpp(), openmsx::FrameSource::getPixelFormat(), paintFrame, and VLA.

Member Data Documentation

◆ deflicker

std::unique_ptr<Deflicker> openmsx::PostProcessor::deflicker

protected

Combine the last 4 frames into one 'flicker-free' frame.

Definition at line 122 of file PostProcessor.hh.

Referenced by PostProcessor(), and rotateFrames().

◆ deinterlacedFrame

std::unique_ptr<DeinterlacedFrame> openmsx::PostProcessor::deinterlacedFrame

protected

Combined the last two frames in a deinterlaced frame.

Definition at line 116 of file PostProcessor.hh.

Referenced by PostProcessor(), and rotateFrames().

◆ height

unsigned openmsx::PostProcessor::height

protected

Definition at line 144 of file PostProcessor.hh.

Referenced by rotateFrames().

◆ interlacedFrame

std::unique_ptr<DoubledFrame> openmsx::PostProcessor::interlacedFrame

protected

Each line of the last frame twice, to get double vertical resolution.

Definition at line 119 of file PostProcessor.hh.

Referenced by PostProcessor(), and rotateFrames().

◆ interleaveCount

int openmsx::PostProcessor::interleaveCount = 0

protected

Definition at line 141 of file PostProcessor.hh.

Referenced by openmsx::GLPostProcessor::paint().

◆ lastFrames

std::array<std::unique_ptr<RawFrame>, 4> openmsx::PostProcessor::lastFrames

protected

The last 4 fully rendered (unscaled) MSX frames.

Definition at line 113 of file PostProcessor.hh.

Referenced by PostProcessor(), and rotateFrames().

◆ lastFramesCount

int openmsx::PostProcessor::lastFramesCount = 0

protected

Definition at line 142 of file PostProcessor.hh.

Referenced by rotateFrames().

◆ maxWidth

unsigned openmsx::PostProcessor::maxWidth

protected

Definition at line 143 of file PostProcessor.hh.

Referenced by rotateFrames().

◆ paintFrame

FrameSource* openmsx::PostProcessor::paintFrame = nullptr

protected

Represents a frame as it should be displayed.

This can be simply a RawFrame or two RawFrames combined in a DeinterlacedFrame or DoubledFrame.

Definition at line 131 of file PostProcessor.hh.

Referenced by getPaintFrame(), openmsx::GLPostProcessor::paint(), rotateFrames(), and takeRawScreenShot().

◆ recorder

AviRecorder* openmsx::PostProcessor::recorder = nullptr

protected

Video recorder, nullptr when not recording.

Definition at line 134 of file PostProcessor.hh.

Referenced by isRecording(), rotateFrames(), setRecorder(), and ~PostProcessor().

◆ renderSettings

RenderSettings& openmsx::PostProcessor::renderSettings

protected

Render settings.

Definition at line 107 of file PostProcessor.hh.

Referenced by openmsx::FBPostProcessor< Pixel >::FBPostProcessor(), openmsx::GLPostProcessor::GLPostProcessor(), openmsx::GLPostProcessor::paint(), rotateFrames(), and openmsx::GLPostProcessor::~GLPostProcessor().

◆ screen

OutputSurface& openmsx::PostProcessor::screen

protected

The surface which is visible to the user.

Definition at line 110 of file PostProcessor.hh.

Referenced by openmsx::FBPostProcessor< Pixel >::FBPostProcessor(), getBpp(), openmsx::GLPostProcessor::GLPostProcessor(), openmsx::GLPostProcessor::paint(), PostProcessor(), and rotateFrames().

◆ superImposedFrame

std::unique_ptr<SuperImposedFrame> openmsx::PostProcessor::superImposedFrame

protected

Result of superimposing 2 frames.

Definition at line 125 of file PostProcessor.hh.

Referenced by PostProcessor(), and rotateFrames().

◆ superImposeVdpFrame

const FrameSource* openmsx::PostProcessor::superImposeVdpFrame = nullptr

protected

Definition at line 139 of file PostProcessor.hh.

Referenced by rotateFrames(), and setSuperimposeVdpFrame().

◆ superImposeVideoFrame

const RawFrame* openmsx::PostProcessor::superImposeVideoFrame = nullptr

protected

Video frame on which to superimpose the (VDP) output.

nullptr when not superimposing.

Definition at line 138 of file PostProcessor.hh.

Referenced by openmsx::GLPostProcessor::paint(), and setSuperimposeVideoFrame().

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

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~PostProcessor()

◆ PostProcessor()

Member Function Documentation

◆ getBpp()

◆ getCliComm()

◆ getLineWidth()

◆ getPaintFrame()

◆ isRecording()

◆ rotateFrames()

◆ setRecorder()

◆ setSuperimposeVdpFrame()

◆ setSuperimposeVideoFrame()

◆ takeRawScreenShot()

Member Data Documentation

◆ deflicker

◆ deinterlacedFrame

◆ height

◆ interlacedFrame

◆ interleaveCount

◆ lastFrames

◆ lastFramesCount

◆ maxWidth

◆ paintFrame

◆ recorder

◆ renderSettings

◆ screen

◆ superImposedFrame

◆ superImposeVdpFrame

◆ superImposeVideoFrame