Applies a 3D LUT (.cube) color transform to each frame. More...

#include <effects/ColorMap.h>

Inheritance diagram for openshot::ColorMap:

Collaboration diagram for openshot::ColorMap:

Public Member Functions
	ColorMap ()
	Blank constructor (used by JSON loader) More...

	ColorMap (const std::string &path, const Keyframe &i=Keyframe(1.0), const Keyframe &iR=Keyframe(1.0), const Keyframe &iG=Keyframe(1.0), const Keyframe &iB=Keyframe(1.0))
	Constructor with LUT path and per‐channel intensities. More...

std::shared_ptr< openshot::Frame >	GetFrame (int64_t frame_number) override
	Apply effect to a new frame. More...

std::shared_ptr< openshot::Frame >	GetFrame (std::shared_ptr< openshot::Frame > frame, int64_t frame_number) override
	Apply effect to an existing frame. More...

std::string	Json () const override
	Generate JSON string of this object. More...

Json::Value	JsonValue () const override
	Generate Json::Value for this object. More...

std::string	PropertiesJSON (int64_t requested_frame) const override
	Expose properties (for UI) More...

void	SetJson (const std::string value) override
	Load JSON string into this object. More...

void	SetJsonValue (const Json::Value root) override
	Load Json::Value into this object. More...

Public Member Functions inherited from openshot::EffectBase
Json::Value	BasePropertiesJSON (int64_t requested_frame) const
	Generate JSON object of base properties (recommended to be used by all effects) More...

int	constrain (int color_value)
	Constrain a color value from 0 to 255. More...

void	DisplayInfo (std::ostream *out=&std::cout)
	Display effect information in the standard output stream (stdout) More...

virtual std::string	GetVisibleObjects (int64_t frame_number) const
	Get the indexes and IDs of all visible objects in the given frame. More...

void	InitEffectInfo ()

virtual std::string	Json (int64_t requested_frame) const

Json::Value	JsonInfo () const
	Generate JSON object of meta data / info. More...

int	Order () const
	Get the order that this effect should be executed. More...

void	Order (int new_order)
	Set the order that this effect should be executed. More...

openshot::ClipBase *	ParentClip ()
	Parent clip object of this effect (which can be unparented and NULL) More...

void	ParentClip (openshot::ClipBase *new_clip)
	Set parent clip object of this effect. More...

std::string	ParentClipId () const
	Return the ID of this effect's parent clip. More...

virtual void	SetJson (int64_t requested_frame, const std::string value)

void	SetParentEffect (std::string parentEffect_id)
	Set the parent effect from which this properties will be set to. More...

virtual	~EffectBase ()=default

Public Member Functions inherited from openshot::ClipBase
	ClipBase ()
	Constructor for the base clip. More...

virtual void	End (float value)
	Set end position (in seconds) of clip (trim end of video) More...

void	Id (std::string value)

void	Layer (int value)
	Set layer of clip on timeline (lower number is covered by higher numbers) More...

bool	operator< (ClipBase &a)

bool	operator<= (ClipBase &a)

bool	operator> (ClipBase &a)

bool	operator>= (ClipBase &a)

void	Position (float value)
	Set the Id of this clip object More...

void	Start (float value)
	Set start position (in seconds) of clip (trim start of video) More...

virtual	~ClipBase ()=default

Public Attributes
Keyframe	intensity
	Overall intensity 0–1 (affects all channels) More...

Keyframe	intensity_b
	Blend 0–1 for blue channel. More...

Keyframe	intensity_g
	Blend 0–1 for green channel. More...

Keyframe	intensity_r
	Blend 0–1 for red channel. More...

Public Attributes inherited from openshot::EffectBase
EffectInfoStruct	info
	Information about the current effect. More...

EffectBase *	parentEffect
	Parent effect (which properties will set this effect properties) More...

std::map< int, std::shared_ptr< openshot::TrackedObjectBase > >	trackedObjects
	Map of Tracked Object's by their indices (used by Effects that track objects on clips) More...

Additional Inherited Members
Protected Member Functions inherited from openshot::ClipBase
Json::Value	add_property_choice_json (std::string name, int value, int selected_value) const
	Generate JSON choice for a property (dropdown properties) More...

Json::Value	add_property_json (std::string name, float value, std::string type, std::string memo, const Keyframe *keyframe, float min_value, float max_value, bool readonly, int64_t requested_frame) const
	Generate JSON for a property. More...

Protected Attributes inherited from openshot::EffectBase
openshot::ClipBase *	clip
	Pointer to the parent clip instance (if any) More...

Protected Attributes inherited from openshot::ClipBase
float	end
	The position in seconds to end playing (used to trim the ending of a clip) More...

std::string	id
	ID Property for all derived Clip and Effect classes. More...

int	layer
	The layer this clip is on. Lower clips are covered up by higher clips. More...

float	position
	The position on the timeline where this clip should start playing. More...

std::string	previous_properties
	This string contains the previous JSON properties. More...

float	start
	The position in seconds to start playing (used to trim the beginning of a clip) More...

openshot::TimelineBase *	timeline
	Pointer to the parent timeline instance (if any) More...

Detailed Description

Applies a 3D LUT (.cube) color transform to each frame.

Loads a .cube file (LUT_3D_SIZE N × N × N) into memory, then for each pixel uses nearest‐neighbor lookup and blends the result by keyframable per‐channel intensities.

Definition at line 34 of file ColorMap.h.

Constructor & Destructor Documentation

◆ ColorMap() [1/2]

ColorMap::ColorMap ( )

Blank constructor (used by JSON loader)

Definition at line 103 of file ColorMap.cpp.

◆ ColorMap() [2/2]

ColorMap::ColorMap	(	const std::string &	path,
		const Keyframe &	i = `Keyframe(1.0)`,
		const Keyframe &	iR = `Keyframe(1.0)`,
		const Keyframe &	iG = `Keyframe(1.0)`,
		const Keyframe &	iB = `Keyframe(1.0)`
	)

Constructor with LUT path and per‐channel intensities.

Parameters

path	Filesystem path to .cube file
i	Keyframe for overall intensity (0–1)
iR	Keyframe for red blend (0–1)
iG	Keyframe for green blend (0–1)
iB	Keyframe for blue blend (0–1)

Definition at line 111 of file ColorMap.cpp.

Member Function Documentation

◆ GetFrame() [1/2]

std::shared_ptr<openshot::Frame> openshot::ColorMap::GetFrame ( int64_t frame_number )

inlineoverridevirtual

Apply effect to a new frame.

Implements openshot::ClipBase.

Definition at line 74 of file ColorMap.h.

◆ GetFrame() [2/2]

std::shared_ptr< openshot::Frame > ColorMap::GetFrame	(	std::shared_ptr< openshot::Frame >	frame,
		int64_t	frame_number
	)

overridevirtual

Apply effect to an existing frame.

Implements openshot::ClipBase.

Definition at line 129 of file ColorMap.cpp.

◆ Json()

std::string ColorMap::Json ( ) const

overridevirtual

Generate JSON string of this object.

Reimplemented from openshot::EffectBase.

Definition at line 233 of file ColorMap.cpp.

◆ JsonValue()

Json::Value ColorMap::JsonValue ( ) const

overridevirtual

Generate Json::Value for this object.

Reimplemented from openshot::EffectBase.

Definition at line 238 of file ColorMap.cpp.

Referenced by Json().

◆ PropertiesJSON()

std::string ColorMap::PropertiesJSON ( int64_t requested_frame ) const

overridevirtual

Expose properties (for UI)

Implements openshot::ClipBase.

Definition at line 279 of file ColorMap.cpp.

◆ SetJson()

void ColorMap::SetJson ( const std::string value )

overridevirtual

Load JSON string into this object.

Reimplemented from openshot::EffectBase.

Definition at line 250 of file ColorMap.cpp.

◆ SetJsonValue()

void ColorMap::SetJsonValue ( const Json::Value root )

overridevirtual

Load Json::Value into this object.

Reimplemented from openshot::EffectBase.

Definition at line 261 of file ColorMap.cpp.

Referenced by SetJson().

Member Data Documentation

◆ intensity

Keyframe openshot::ColorMap::intensity

Overall intensity 0–1 (affects all channels)

Definition at line 49 of file ColorMap.h.

Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().

◆ intensity_b

Keyframe openshot::ColorMap::intensity_b

Blend 0–1 for blue channel.

Definition at line 52 of file ColorMap.h.

Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().

◆ intensity_g

Keyframe openshot::ColorMap::intensity_g

Blend 0–1 for green channel.

Definition at line 51 of file ColorMap.h.

Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().

◆ intensity_r

Keyframe openshot::ColorMap::intensity_r

Blend 0–1 for red channel.

Definition at line 50 of file ColorMap.h.

Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().

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

effects/ColorMap.h
effects/ColorMap.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ColorMap() [1/2]

◆ ColorMap() [2/2]

Member Function Documentation

◆ GetFrame() [1/2]

◆ GetFrame() [2/2]

◆ Json()

◆ JsonValue()

◆ PropertiesJSON()

◆ SetJson()

◆ SetJsonValue()

Member Data Documentation

◆ intensity

◆ intensity_b

◆ intensity_g

◆ intensity_r