OpenShot Library | libopenshot  0.3.3
TrackedObjectBBox.h
Go to the documentation of this file.
1 
10 // Copyright (c) 2008-2019 OpenShot Studios, LLC
11 //
12 // SPDX-License-Identifier: LGPL-3.0-or-later
13 
14 #ifndef OPENSHOT_TRACKEDOBJECTBBOX_H
15 #define OPENSHOT_TRACKEDOBJECTBBOX_H
16 
17 #include "TrackedObjectBase.h"
18 
19 #include "Color.h"
20 #include "Exceptions.h"
21 #include "Fraction.h"
22 #include "Json.h"
23 #include "KeyFrame.h"
24 
25 namespace openshot
26 {
37  struct BBox
38  {
39  float cx = -1;
40  float cy = -1;
41  float width = -1;
42  float height = -1;
43  float angle = -1;
44 
46  BBox() {}
47 
54  BBox(float _cx, float _cy, float _width, float _height, float _angle)
55  {
56  cx = _cx;
57  cy = _cy;
58  width = _width;
59  height = _height;
60  angle = _angle;
61  }
62 
63 
65  std::string Json() const
66  {
67  return JsonValue().toStyledString();
68  }
69 
71  Json::Value JsonValue() const
72  {
73  Json::Value root;
74  root["cx"] = cx;
75  root["cy"] = cy;
76  root["width"] = width;
77  root["height"] = height;
78  root["angle"] = angle;
79 
80  return root;
81  }
82 
84  void SetJson(const std::string value)
85  {
86  // Parse JSON string into JSON objects
87  try
88  {
89  const Json::Value root = openshot::stringToJson(value);
90  // Set all values that match
91  SetJsonValue(root);
92  }
93  catch (const std::exception &e)
94  {
95  // Error parsing JSON (or missing keys)
96  throw InvalidJSON("JSON is invalid (missing keys or invalid data types)");
97  }
98  }
99 
101  void SetJsonValue(const Json::Value root)
102  {
103 
104  // Set data from Json (if key is found)
105  if (!root["cx"].isNull())
106  cx = root["cx"].asDouble();
107  if (!root["cy"].isNull())
108  cy = root["cy"].asDouble();
109  if (!root["width"].isNull())
110  width = root["width"].asDouble();
111  if (!root["height"].isNull())
112  height = root["height"].asDouble();
113  if (!root["angle"].isNull())
114  angle = root["angle"].asDouble();
115  }
116  };
117 
131  {
132  private:
133  Fraction BaseFps;
134  double TimeScale;
135 
136  public:
137  std::map<double, BBox> BoxVec;
149 
150  std::string protobufDataPath;
151 
154  TrackedObjectBBox(int Red, int Green, int Blue, int Alfa);
155 
157  void AddBox(int64_t _frame_num, float _cx, float _cy, float _width, float _height, float _angle) override;
158 
160  void SetBaseFPS(Fraction fps);
161 
164 
166  void ScalePoints(double scale) override;
167 
169  bool Contains(int64_t frame_number) const;
171  bool ExactlyContains(int64_t frame_number) const override;
172 
174  int64_t GetLength() const;
175 
177  void RemoveBox(int64_t frame_number);
178 
180  BBox GetBox(int64_t frame_number);
182  BBox GetBox(int64_t frame_number) const
183  {
184  return const_cast<TrackedObjectBBox *>(this)->GetBox(frame_number);
185  }
186 
188  bool LoadBoxData(std::string inputFilePath);
189 
191  double FrameNToTime(int64_t frame_number, double time_scale) const;
192 
194  BBox InterpolateBoxes(double t1, double t2, BBox left, BBox right, double target);
195 
197  void clear();
198 
200  std::string Json() const override;
201  Json::Value JsonValue() const override;
202  void SetJson(const std::string value) override;
203  void SetJsonValue(const Json::Value root) override;
204 
207  Json::Value PropertiesJSON(int64_t requested_frame) const override;
208 
209  // Generate JSON for a property
210  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;
211 
213  std::map<std::string, float> GetBoxValues(int64_t frame_number) const override;
214  };
215 } // namespace openshot
216 
217 #endif
Header file for Color class.
Header file for all Exception classes.
Header file for Fraction class.
Header file for JSON class.
Header file for the Keyframe class.
Header file for the TrackedObjectBase class.
This class represents a color (used on the timeline and clips)
Definition: Color.h:27
This class represents a fraction.
Definition: Fraction.h:30
Exception for invalid JSON.
Definition: Exceptions.h:218
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
Definition: KeyFrame.h:53
This class contains the properties of a tracked object and functions to manipulate it.
Keyframe delta_x
X-direction displacement Keyframe.
bool LoadBoxData(std::string inputFilePath)
Load the bounding-boxes information from the protobuf file.
Color stroke
Border line color.
Keyframe rotation
Rotation Keyframe.
int64_t GetLength() const
Get the size of BoxVec map.
Keyframe stroke_width
Thickness of border line.
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
void AddBox(int64_t _frame_num, float _cx, float _cy, float _width, float _height, float _angle) override
Add a BBox to the BoxVec map.
TrackedObjectBBox()
Default Constructor.
void SetBaseFPS(Fraction fps)
Update object's BaseFps.
void SetJson(const std::string value) override
Load JSON string into this object.
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
void clear()
Clear the BoxVec map.
Keyframe delta_y
Y-direction displacement Keyframe.
Color background
Background fill color.
BBox GetBox(int64_t frame_number) const
Const-cast of the GetBox function, so that it can be called inside other cont function.
std::map< double, BBox > BoxVec
Index the bounding-box by time of each frame.
std::string Json() const override
Get and Set JSON methods.
bool ExactlyContains(int64_t frame_number) const override
Check if there is a bounding-box in the exact frame number.
void ScalePoints(double scale) override
Update the TimeScale member variable.
BBox InterpolateBoxes(double t1, double t2, BBox left, BBox right, double target)
Interpolate the bouding-boxes properties.
Fraction GetBaseFPS()
Return the object's BaseFps.
Json::Value PropertiesJSON(int64_t requested_frame) const override
Keyframe background_alpha
Background box opacity.
void RemoveBox(int64_t frame_number)
Remove a bounding-box from the BoxVec map.
bool Contains(int64_t frame_number) const
Check if there is a bounding-box in the given frame.
std::map< std::string, float > GetBoxValues(int64_t frame_number) const override
Return a map that contains the bounding box properties and it's keyframes indexed by their names.
Json::Value JsonValue() const override
Generate Json::Value for this object.
Keyframe scale_y
Y-direction scale Keyframe.
std::string protobufDataPath
Path to the protobuf file that holds the bounding box points across the frames.
Keyframe stroke_alpha
Stroke box opacity.
double FrameNToTime(int64_t frame_number, double time_scale) const
Get the time of the given frame.
Keyframe scale_x
X-direction scale Keyframe.
BBox GetBox(int64_t frame_number)
Return a bounding-box from BoxVec with it's properties adjusted by the Keyframes.
Keyframe background_corner
Radius of rounded corners.
This abstract class is the base class of all Tracked Objects.
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:29
const Json::Value stringToJson(const std::string value)
Definition: Json.cpp:16
This struct holds the information of a bounding-box.
float cy
y-coordinate of the bounding box center
float height
bounding box height
float cx
x-coordinate of the bounding box center
std::string Json() const
Generate JSON string of this object.
void SetJson(const std::string value)
Load JSON string into this object.
Json::Value JsonValue() const
Generate Json::Value for this object.
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
BBox(float _cx, float _cy, float _width, float _height, float _angle)
BBox()
Blank constructor.
float width
bounding box width
float angle
bounding box rotation angle [degrees]