OpenShot Library | libopenshot 0.4.0
Loading...
Searching...
No Matches
Timeline.h
Go to the documentation of this file.
1
9// Copyright (c) 2008-2019 OpenShot Studios, LLC
10//
11// SPDX-License-Identifier: LGPL-3.0-or-later
12
13#ifndef OPENSHOT_TIMELINE_H
14#define OPENSHOT_TIMELINE_H
15
16#include <list>
17#include <memory>
18#include <mutex>
19#include <set>
20#include <QtGui/QImage>
21#include <QtGui/QPainter>
22#include <QtCore/QRegularExpression>
23
24#include "TimelineBase.h"
25#include "ReaderBase.h"
26
27#include "Color.h"
28#include "Clip.h"
29#include "EffectBase.h"
30#include "Fraction.h"
31#include "Frame.h"
32#include "KeyFrame.h"
33#ifdef USE_OPENCV
34#include "TrackedObjectBBox.h"
35#endif
36#include "TrackedObjectBase.h"
37
38
39
40namespace openshot {
41
42 // Forward decls
43 class FrameMapper;
44 class CacheBase;
45
51 if( lhs->Layer() < rhs->Layer() ) return true;
52 if( lhs->Layer() == rhs->Layer() && lhs->Position() <= rhs->Position() ) return true;
53 return false;
54 }};
55
61 if( lhs->Layer() < rhs->Layer() ) return true;
62 if( lhs->Layer() == rhs->Layer() && lhs->Position() < rhs->Position() ) return true;
63 if( lhs->Layer() == rhs->Layer() && lhs->Position() == rhs->Position() && lhs->Order() > rhs->Order() ) return true;
64 return false;
65 }};
66
70 bool operator()(const openshot::Clip* lhs, const openshot::Clip* rhs) {
71 return (lhs->Position() + lhs->Duration()) <= (rhs->Position() + rhs->Duration());
72 }};
73
77 return (lhs->Position() + lhs->Duration()) <= (rhs->Position() + rhs->Duration());
78 }};
79
149 private:
150 bool is_open;
151 bool auto_map_clips;
152 std::list<openshot::Clip*> clips;
153 std::list<openshot::Clip*> closing_clips;
154 std::map<openshot::Clip*, openshot::Clip*> open_clips;
155 std::set<openshot::Clip*> allocated_clips;
156 std::list<openshot::EffectBase*> effects;
157 std::set<openshot::EffectBase*> allocated_effects;
158 openshot::CacheBase *final_cache;
159 std::set<openshot::FrameMapper*> allocated_frame_mappers;
160 bool managed_cache;
161 std::string path;
162 int max_concurrent_frames;
163 double max_time;
164 double min_time;
165
166 std::map<std::string, std::shared_ptr<openshot::TrackedObjectBase>> tracked_objects;
167
169 void add_layer(std::shared_ptr<openshot::Frame> new_frame, openshot::Clip* source_clip, int64_t clip_frame_number, bool is_top_clip, float max_volume);
170
172 void apply_mapper_to_clip(openshot::Clip* clip);
173
174 // Apply JSON Diffs to various objects contained in this timeline
175 void apply_json_to_clips(Json::Value change);
176 void apply_json_to_effects(Json::Value change);
177 void apply_json_to_effects(Json::Value change, openshot::EffectBase* existing_effect);
178 void apply_json_to_timeline(Json::Value change);
179
181 void calculate_max_duration();
182
184 double calculate_time(int64_t number, openshot::Fraction rate);
185
192 std::vector<openshot::Clip*> find_intersecting_clips(int64_t requested_frame, int number_of_frames, bool include);
193
195 std::shared_ptr<openshot::Frame> GetOrCreateFrame(std::shared_ptr<Frame> background_frame, openshot::Clip* clip, int64_t number, openshot::TimelineInfoStruct* options);
196
198 bool isEqual(double a, double b);
199
201 void sort_clips();
202
204 void sort_effects();
205
207 void update_open_clips(openshot::Clip *clip, bool does_clip_intersect);
208
209 public:
210
218 Timeline(int width, int height, openshot::Fraction fps, int sample_rate, int channels, openshot::ChannelLayout channel_layout);
219
223
231 Timeline(const std::string& projectPath, bool convert_absolute_paths);
232
233 virtual ~Timeline();
234
236 void AddTrackedObject(std::shared_ptr<openshot::TrackedObjectBase> trackedObject);
238 std::shared_ptr<openshot::TrackedObjectBase> GetTrackedObject(std::string id) const;
240 std::list<std::string> GetTrackedObjectsIds() const;
242 #ifdef USE_OPENCV
243 std::string GetTrackedObjectValues(std::string id, int64_t frame_number) const;
244 #endif
245
249
252 void AddEffect(openshot::EffectBase* effect);
253
255 std::shared_ptr<openshot::Frame> apply_effects(std::shared_ptr<openshot::Frame> frame, int64_t timeline_frame_number, int layer, TimelineInfoStruct* options);
256
258 void ApplyMapperToClips();
259
261 bool AutoMapClips() { return auto_map_clips; };
262
264 void AutoMapClips(bool auto_map) { auto_map_clips = auto_map; };
265
267 void Clear();
268
271 void ClearAllCache(bool deep=false);
272
274 std::list<openshot::Clip*> Clips() override { return clips; };
275
277 openshot::Clip* GetClip(const std::string& id);
278
280 openshot::EffectBase* GetClipEffect(const std::string& id);
281
283 openshot::EffectBase* GetEffect(const std::string& id);
284
286 double GetMaxTime();
288 int64_t GetMaxFrame();
289
291 double GetMinTime();
293 int64_t GetMinFrame();
294
296 void Close() override;
297
299 std::list<openshot::EffectBase*> Effects() { return effects; };
300
302 std::list<openshot::EffectBase*> ClipEffects() const;
303
305 openshot::CacheBase* GetCache() override { return final_cache; };
306
309 void SetCache(openshot::CacheBase* new_cache);
310
315 std::shared_ptr<openshot::Frame> GetFrame(int64_t requested_frame) override;
316
317 // Curves for the viewport
321
322 // Background color
324
326 bool IsOpen() override { return is_open; };
327
329 std::string Name() override { return "Timeline"; };
330
331 // Get and Set JSON methods
332 std::string Json() const override;
333 void SetJson(const std::string value) override;
334 Json::Value JsonValue() const override;
335 void SetJsonValue(const Json::Value root) override;
336
339 void SetMaxSize(int width, int height);
340
345 void ApplyJsonDiff(std::string value);
346
348 void Open() override;
349
353
357
360 void SortTimeline() { sort_clips(); sort_effects(); }
361 };
362
363}
364
365#endif // OPENSHOT_TIMELINE_H
Header file for Clip class.
Header file for Color class.
Header file for EffectBase class.
Header file for Fraction class.
Header file for Frame class.
Header file for the Keyframe class.
Header file for ReaderBase class.
Header file for Timeline class.
Header file for the TrackedObjectBBox class.
Header file for the TrackedObjectBase class.
All cache managers in libopenshot are based on this CacheBase class.
Definition CacheBase.h:35
float Duration() const
Get the length of this clip (in seconds)
Definition ClipBase.h:90
int Layer() const
Get layer of clip on timeline (lower number is covered by higher numbers)
Definition ClipBase.h:87
float Position() const
Get position on timeline (in seconds)
Definition ClipBase.h:86
This class represents a clip (used to arrange readers on the timeline)
Definition Clip.h:89
This class represents a color (used on the timeline and clips)
Definition Color.h:27
This abstract class is the base class, used by all effects in libopenshot.
Definition EffectBase.h:54
int Order() const
Get the order that this effect should be executed.
Definition EffectBase.h:116
This class represents a fraction.
Definition Fraction.h:30
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
Definition KeyFrame.h:53
This abstract class is the base class, used by all readers in libopenshot.
Definition ReaderBase.h:76
openshot::ReaderInfo info
Information about the current media file.
Definition ReaderBase.h:88
openshot::ClipBase * clip
Pointer to the parent clip instance (if any)
Definition ReaderBase.h:80
This class represents a timeline (used for building generic timeline implementations)
This class represents a timeline.
Definition Timeline.h:148
void AddTrackedObject(std::shared_ptr< openshot::TrackedObjectBase > trackedObject)
Add to the tracked_objects map a pointer to a tracked object (TrackedObjectBBox)
Definition Timeline.cpp:223
Json::Value JsonValue() const override
Generate Json::Value for this object.
std::string Name() override
Return the type name of the class.
Definition Timeline.h:329
openshot::Keyframe viewport_scale
Curve representing the scale of the viewport (0 to 100)
Definition Timeline.h:318
void ApplyJsonDiff(std::string value)
Apply a special formatted JSON object, which represents a change to the timeline (add,...
openshot::EffectBase * GetClipEffect(const std::string &id)
Look up a clip effect by ID.
Definition Timeline.cpp:431
void AddClip(openshot::Clip *clip)
Add an openshot::Clip to the timeline.
Definition Timeline.cpp:332
virtual ~Timeline()
Definition Timeline.cpp:206
std::list< openshot::EffectBase * > ClipEffects() const
Return the list of effects on all clips.
Definition Timeline.cpp:444
void AutoMapClips(bool auto_map)
Automatically map all clips to the timeline's framerate and samplerate.
Definition Timeline.h:264
std::list< std::string > GetTrackedObjectsIds() const
Return the ID's of the tracked objects as a list of strings.
Definition Timeline.cpp:258
std::string Json() const override
Generate JSON string of this object.
std::list< openshot::EffectBase * > Effects()
Return the list of effects on the timeline.
Definition Timeline.h:299
int64_t GetMaxFrame()
Look up the end frame number of the latest element on the timeline.
Definition Timeline.cpp:469
double GetMinTime()
Look up the position/start time of the first timeline element.
Definition Timeline.cpp:476
std::shared_ptr< openshot::Frame > GetFrame(int64_t requested_frame) override
Definition Timeline.cpp:931
bool AutoMapClips()
Determine if clips are automatically mapped to the timeline's framerate and samplerate.
Definition Timeline.h:261
void ApplyMapperToClips()
Apply the timeline's framerate and samplerate to all clips.
Definition Timeline.cpp:515
void SortTimeline()
Sort all clips and effects on timeline - which affects the internal order of clips and effects arrays...
Definition Timeline.h:360
openshot::Color color
Background color of timeline canvas.
Definition Timeline.h:323
std::string GetTrackedObjectValues(std::string id, int64_t frame_number) const
Return the trackedObject's properties as a JSON string.
Definition Timeline.cpp:274
std::shared_ptr< openshot::TrackedObjectBase > GetTrackedObject(std::string id) const
Return tracked object pointer by it's id.
Definition Timeline.cpp:241
int64_t GetMinFrame()
Look up the start frame number of the first element on the timeline (first frame is 1)
Definition Timeline.cpp:482
openshot::EffectBase * GetEffect(const std::string &id)
Look up a timeline effect by ID.
Definition Timeline.cpp:420
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
openshot::Clip * GetClip(const std::string &id)
Look up a single clip by ID.
Definition Timeline.cpp:408
void ClearAllCache(bool deep=false)
void AddEffect(openshot::EffectBase *effect)
Add an effect to the timeline.
Definition Timeline.cpp:358
std::list< openshot::Clip * > Clips() override
Return a list of clips on the timeline.
Definition Timeline.h:274
void SetCache(openshot::CacheBase *new_cache)
bool IsOpen() override
Determine if reader is open or closed.
Definition Timeline.h:326
openshot::CacheBase * GetCache() override
Get the cache object used by this reader.
Definition Timeline.h:305
void Clear()
Clear all clips, effects, and frame mappers from timeline (and free memory)
Definition Timeline.cpp:851
openshot::Keyframe viewport_x
Curve representing the x coordinate for the viewport.
Definition Timeline.h:319
void RemoveClip(openshot::Clip *clip)
Remove an openshot::Clip from the timeline.
Definition Timeline.cpp:388
void SetMaxSize(int width, int height)
double GetMaxTime()
Look up the end time of the latest timeline element.
Definition Timeline.cpp:463
void RemoveEffect(openshot::EffectBase *effect)
Remove an effect from the timeline.
Definition Timeline.cpp:371
std::shared_ptr< openshot::Frame > apply_effects(std::shared_ptr< openshot::Frame > frame, int64_t timeline_frame_number, int layer, TimelineInfoStruct *options)
Apply global/timeline effects to the source frame (if any)
Definition Timeline.cpp:539
void Open() override
Open the reader (and start consuming resources)
Definition Timeline.cpp:919
void SetJson(const std::string value) override
Load JSON string into this object.
openshot::Keyframe viewport_y
Curve representing the y coordinate for the viewport.
Definition Timeline.h:320
void Close() override
Close the timeline reader (and any resources it was consuming)
Definition Timeline.cpp:897
This namespace is the default namespace for all code in the openshot library.
Definition Compressor.h:29
ChannelLayout
This enumeration determines the audio channel layout (such as stereo, mono, 5 point surround,...
bool operator()(const openshot::Clip *lhs, const openshot::Clip *rhs)
Definition Timeline.h:70
bool operator()(openshot::Clip *lhs, openshot::Clip *rhs)
Definition Timeline.h:50
Like CompareClipEndFrames, but for effects.
Definition Timeline.h:75
bool operator()(const openshot::EffectBase *lhs, const openshot::EffectBase *rhs)
Definition Timeline.h:76
bool operator()(openshot::EffectBase *lhs, openshot::EffectBase *rhs)
Definition Timeline.h:60
This struct contains info about a media file, such as height, width, frames per second,...
Definition ReaderBase.h:39
This struct contains info about the current Timeline clip instance.