OpenShot Library | libopenshot  0.3.3
Public Member Functions | Public Attributes | List of all members
openshot::Tracker Class Reference

This class tracks a given object through the clip, draws a box around it and allow the user to attach another clip (image or video) to the tracked object. More...

#include <effects/Tracker.h>

Inheritance diagram for openshot::Tracker:
[legend]
Collaboration diagram for openshot::Tracker:
[legend]

Public Member Functions

std::shared_ptr< openshot::FrameGetFrame (int64_t frame_number) override
 This method is required for all derived classes of ClipBase, and returns a new openshot::Frame object. All Clip keyframes and effects are resolved into pixels. More...
 
std::shared_ptr< FrameGetFrame (std::shared_ptr< Frame > frame, int64_t frame_number) override
 Apply this effect to an openshot::Frame. More...
 
std::string GetVisibleObjects (int64_t frame_number) const override
 Get the indexes and IDs of all visible objects in the given 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
 
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...
 
 Tracker ()
 Default constructor. More...
 
 Tracker (std::string clipTrackerDataPath)
 Blank constructor, useful when using Json to load the effect properties. 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...
 
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::ClipBaseParentClip ()
 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...
 
virtual std::shared_ptr< openshot::FrameGetFrame (std::shared_ptr< openshot::Frame > frame, int64_t frame_number)=0
 This method is required for all derived classes of ClipBase, and returns a modified openshot::Frame object. 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

std::string protobuf_data_path
 Path to the protobuf file that holds the bounding-box data. More...
 
std::shared_ptr< TrackedObjectBBoxtrackedData
 Pointer to an object that holds the bounding-box data and it's Keyframes. More...
 
- Public Attributes inherited from openshot::EffectBase
EffectInfoStruct info
 Information about the current effect. More...
 
EffectBaseparentEffect
 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::ClipBaseclip
 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::TimelineBasetimeline
 Pointer to the parent timeline instance (if any) More...
 

Detailed Description

This class tracks a given object through the clip, draws a box around it and allow the user to attach another clip (image or video) to the tracked object.

Tracking is useful to better visualize, follow the movement of an object through video and attach an image or video to it.

Definition at line 41 of file Tracker.h.

Constructor & Destructor Documentation

◆ Tracker() [1/2]

Tracker::Tracker ( )

Default constructor.

Definition at line 53 of file Tracker.cpp.

◆ Tracker() [2/2]

Tracker::Tracker ( std::string  clipTrackerDataPath)

Blank constructor, useful when using Json to load the effect properties.

Definition at line 36 of file Tracker.cpp.

Member Function Documentation

◆ GetFrame() [1/2]

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

This method is required for all derived classes of ClipBase, and returns a new openshot::Frame object. All Clip keyframes and effects are resolved into pixels.

Returns
A new openshot::Frame object
Parameters
frame_numberThe frame number (starting at 1) of the clip or effect on the timeline.

Implements openshot::ClipBase.

Definition at line 67 of file Tracker.h.

◆ GetFrame() [2/2]

std::shared_ptr< Frame > Tracker::GetFrame ( std::shared_ptr< Frame frame,
int64_t  frame_number 
)
override

Apply this effect to an openshot::Frame.

Returns
The modified openshot::Frame object
Parameters
frameThe frame object that needs the effect applied to it
frame_numberThe frame number (starting at 1) of the effect on the timeline.

Definition at line 87 of file Tracker.cpp.

Referenced by GetFrame().

◆ GetVisibleObjects()

std::string Tracker::GetVisibleObjects ( int64_t  frame_number) const
overridevirtual

Get the indexes and IDs of all visible objects in the given frame.

Reimplemented from openshot::EffectBase.

Definition at line 139 of file Tracker.cpp.

◆ Json()

std::string Tracker::Json ( ) const
overridevirtual

Generate JSON string of this object.

Reimplemented from openshot::EffectBase.

Definition at line 161 of file Tracker.cpp.

◆ JsonValue()

Json::Value Tracker::JsonValue ( ) const
overridevirtual

Generate Json::Value for this object.

Reimplemented from openshot::EffectBase.

Definition at line 168 of file Tracker.cpp.

◆ PropertiesJSON()

std::string Tracker::PropertiesJSON ( int64_t  requested_frame) const
overridevirtual

Get all properties for a specific frame

(perfect for a UI to display the current state of all properties at any time)

Implements openshot::ClipBase.

Definition at line 265 of file Tracker.cpp.

◆ SetJson()

void Tracker::SetJson ( const std::string  value)
overridevirtual

Load JSON string into this object.

Reimplemented from openshot::EffectBase.

Definition at line 194 of file Tracker.cpp.

◆ SetJsonValue()

void Tracker::SetJsonValue ( const Json::Value  root)
overridevirtual

Load Json::Value into this object.

Reimplemented from openshot::EffectBase.

Definition at line 212 of file Tracker.cpp.

Member Data Documentation

◆ protobuf_data_path

std::string openshot::Tracker::protobuf_data_path

Path to the protobuf file that holds the bounding-box data.

Definition at line 51 of file Tracker.h.

◆ trackedData

std::shared_ptr<TrackedObjectBBox> openshot::Tracker::trackedData

Pointer to an object that holds the bounding-box data and it's Keyframes.

Definition at line 52 of file Tracker.h.


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