2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
4 * This file is part of CasparCG (www.casparcg.com).
6 * CasparCG is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * CasparCG is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with CasparCG. If not, see <http://www.gnu.org/licenses/>.
19 * Author: Helge Norberg, helge.norberg@svt.se
22 #include "../../StdAfx.h"
24 #include <common/future.h>
25 #include <common/prec_timer.h>
27 #include <boost/algorithm/string/split.hpp>
28 #include <boost/algorithm/string.hpp>
30 #include "scene_producer.h"
32 #include "../../frame/draw_frame.h"
33 #include "../../interaction/interaction_aggregator.h"
34 #include "../text/text_producer.h"
36 namespace caspar { namespace core { namespace scene {
38 layer::layer(const std::wstring& name, const spl::shared_ptr<frame_producer>& producer)
39 : name(name), producer(producer)
41 crop.lower_right.x.bind(producer.get()->pixel_constraints().width);
42 crop.lower_right.y.bind(producer.get()->pixel_constraints().height);
43 perspective.upper_right.x.bind(producer.get()->pixel_constraints().width);
44 perspective.lower_right.x.bind(producer.get()->pixel_constraints().width);
45 perspective.lower_right.y.bind(producer.get()->pixel_constraints().height);
46 perspective.lower_left.y.bind(producer.get()->pixel_constraints().height);
49 adjustments::adjustments()
56 std::map<int64_t, keyframe> keyframes;
58 void on_frame(int64_t frame)
60 auto before = --keyframes.upper_bound(frame);
61 bool found_before = before != keyframes.end() && before->first < frame;
62 auto after = keyframes.upper_bound(frame);
63 bool found_after = after != keyframes.end() && after->first > frame;
64 auto exact_frame = keyframes.find(frame);
65 bool found_exact_frame = exact_frame != keyframes.end();
67 if (found_exact_frame)
69 exact_frame->second.on_destination_frame();
71 auto next_frame = ++exact_frame;
73 if (next_frame != keyframes.end() && next_frame->second.on_start_animate)
74 next_frame->second.on_start_animate();
78 int64_t start_frame = 0;
82 start_frame = before->first;
85 if (after->second.on_start_animate && frame == 0)
86 after->second.on_start_animate();
87 else if (after->second.on_animate_to)
88 after->second.on_animate_to(start_frame, frame);
93 mark_action get_mark_action(const std::wstring& name)
96 return mark_action::start;
97 else if (name == L"stop")
98 return mark_action::stop;
99 else if (name == L"jump_to")
100 return mark_action::jump_to;
101 else if (name == L"remove")
102 return mark_action::remove;
104 CASPAR_THROW_EXCEPTION(user_error() << msg_info(L"Invalid mark_action " + name));
110 std::wstring label_argument;
112 marker(mark_action action, const std::wstring& label_argument)
114 , label_argument(label_argument)
119 struct scene_producer::impl
121 std::wstring producer_name_;
122 constraints pixel_constraints_;
123 video_format_desc format_desc_;
124 std::list<layer> layers_;
125 interaction_aggregator aggregator_;
126 binding<double> frame_number_;
127 binding<int64_t> timeline_frame_number_;
128 binding<double> speed_;
129 mutable tbb::atomic<int64_t> m_x_;
130 mutable tbb::atomic<int64_t> m_y_;
131 binding<int64_t> mouse_x_;
132 binding<int64_t> mouse_y_;
133 double frame_fraction_ = 0.0;
134 std::map<void*, timeline> timelines_;
135 std::map<std::wstring, std::shared_ptr<core::variable>> variables_;
136 std::vector<std::wstring> variable_names_;
137 std::multimap<int64_t, marker> markers_by_frame_;
138 monitor::subject monitor_subject_;
140 bool removed_ = false;
141 bool going_to_mark_ = false;
143 impl(std::wstring producer_name, int width, int height, const video_format_desc& format_desc)
144 : producer_name_(std::move(producer_name))
145 , pixel_constraints_(width, height)
146 , format_desc_(format_desc)
147 , aggregator_([=] (double x, double y) { return collission_detect(x, y); })
149 auto speed_variable = std::make_shared<core::variable_impl<double>>(L"1.0", true, 1.0);
150 store_variable(L"scene_speed", speed_variable);
151 speed_ = speed_variable->value();
153 auto frame_variable = std::make_shared<core::variable_impl<double>>(L"-1", true, -1);
154 store_variable(L"frame", frame_variable);
155 frame_number_ = frame_variable->value();
157 auto timeline_frame_variable = std::make_shared<core::variable_impl<int64_t>>(L"-1", false, -1);
158 store_variable(L"timeline_frame", timeline_frame_variable);
159 timeline_frame_number_ = timeline_frame_variable->value();
161 auto mouse_x_variable = std::make_shared<core::variable_impl<int64_t>>(L"0", false, 0);
162 auto mouse_y_variable = std::make_shared<core::variable_impl<int64_t>>(L"0", false, 0);
163 store_variable(L"mouse_x", mouse_x_variable);
164 store_variable(L"mouse_y", mouse_y_variable);
165 mouse_x_ = mouse_x_variable->value();
166 mouse_y_ = mouse_y_variable->value();
172 const spl::shared_ptr<frame_producer>& producer, int x, int y, const std::wstring& name)
174 layer layer(name, producer);
176 layer.position.x.set(x);
177 layer.position.y.set(y);
179 layers_.push_back(layer);
181 return layers_.back();
184 void reverse_layers() {
188 void store_keyframe(void* timeline_identity, const keyframe& k)
190 timelines_[timeline_identity].keyframes.insert(std::make_pair(k.destination_frame, k));
194 const std::wstring& name, const std::shared_ptr<core::variable>& var)
196 variables_.insert(std::make_pair(name, var));
197 variable_names_.push_back(name);
200 void add_mark(int64_t frame, mark_action action, const std::wstring& label)
202 markers_by_frame_.insert(std::make_pair(frame, marker(action, label)));
205 core::variable& get_variable(const std::wstring& name)
207 auto found = variables_.find(name);
209 if (found == variables_.end())
210 CASPAR_THROW_EXCEPTION(user_error() << msg_info(name + L" not found in scene"));
212 return *found->second;
215 const std::vector<std::wstring>& get_variables() const
217 return variable_names_;
220 binding<int64_t> timeline_frame()
222 return timeline_frame_number_;
225 frame_transform get_transform(const layer& layer) const
227 frame_transform transform;
229 auto& anchor = transform.image_transform.anchor;
230 auto& pos = transform.image_transform.fill_translation;
231 auto& scale = transform.image_transform.fill_scale;
232 auto& angle = transform.image_transform.angle;
233 auto& crop = transform.image_transform.crop;
234 auto& pers = transform.image_transform.perspective;
236 anchor[0] = layer.anchor.x.get() / layer.producer.get()->pixel_constraints().width.get();
237 anchor[1] = layer.anchor.y.get() / layer.producer.get()->pixel_constraints().height.get();
238 pos[0] = layer.position.x.get() / pixel_constraints_.width.get();
239 pos[1] = layer.position.y.get() / pixel_constraints_.height.get();
240 scale[0] = layer.producer.get()->pixel_constraints().width.get() / pixel_constraints_.width.get();
241 scale[1] = layer.producer.get()->pixel_constraints().height.get() / pixel_constraints_.height.get();
242 crop.ul[0] = layer.crop.upper_left.x.get() / layer.producer.get()->pixel_constraints().width.get();
243 crop.ul[1] = layer.crop.upper_left.y.get() / layer.producer.get()->pixel_constraints().height.get();
244 crop.lr[0] = layer.crop.lower_right.x.get() / layer.producer.get()->pixel_constraints().width.get();
245 crop.lr[1] = layer.crop.lower_right.y.get() / layer.producer.get()->pixel_constraints().height.get();
246 pers.ul[0] = layer.perspective.upper_left.x.get() / layer.producer.get()->pixel_constraints().width.get();
247 pers.ul[1] = layer.perspective.upper_left.y.get() / layer.producer.get()->pixel_constraints().height.get();
248 pers.ur[0] = layer.perspective.upper_right.x.get() / layer.producer.get()->pixel_constraints().width.get();
249 pers.ur[1] = layer.perspective.upper_right.y.get() / layer.producer.get()->pixel_constraints().height.get();
250 pers.lr[0] = layer.perspective.lower_right.x.get() / layer.producer.get()->pixel_constraints().width.get();
251 pers.lr[1] = layer.perspective.lower_right.y.get() / layer.producer.get()->pixel_constraints().height.get();
252 pers.ll[0] = layer.perspective.lower_left.x.get() / layer.producer.get()->pixel_constraints().width.get();
253 pers.ll[1] = layer.perspective.lower_left.y.get() / layer.producer.get()->pixel_constraints().height.get();
255 static const double PI = 3.141592653589793;
257 angle = layer.rotation.get() * PI / 180.0;
259 transform.image_transform.opacity = layer.adjustments.opacity.get();
260 transform.image_transform.is_key = layer.is_key.get();
261 transform.image_transform.use_mipmap = layer.use_mipmap.get();
262 transform.image_transform.blend_mode = layer.blend_mode.get();
263 transform.image_transform.chroma.key = layer.chroma_key.key.get();
264 transform.image_transform.chroma.threshold = layer.chroma_key.threshold.get();
265 transform.image_transform.chroma.softness = layer.chroma_key.softness.get();
266 transform.image_transform.chroma.spill = layer.chroma_key.spill.get();
268 // Mark as sublayer, so it will be composited separately by the mixer.
269 transform.image_transform.layer_depth = 1;
274 boost::optional<std::pair<int64_t, marker>> find_first_stop_or_jump_or_remove(int64_t start_frame, int64_t end_frame)
276 auto lower = markers_by_frame_.lower_bound(start_frame);
277 auto upper = markers_by_frame_.upper_bound(end_frame);
279 if (lower == markers_by_frame_.end())
282 for (auto iter = lower; iter != upper; ++iter)
284 auto action = iter->second.action;
286 if (action == mark_action::stop || action == mark_action::jump_to || action == mark_action::remove)
287 return std::make_pair(iter->first, iter->second);
293 boost::optional<std::pair<int64_t, marker>> find_first_start(int64_t start_frame)
295 auto lower = markers_by_frame_.lower_bound(start_frame);
297 if (lower == markers_by_frame_.end())
300 for (auto iter = lower; iter != markers_by_frame_.end(); ++iter)
302 auto action = iter->second.action;
304 if (action == mark_action::start)
305 return std::make_pair(iter->first, iter->second);
311 draw_frame render_frame()
313 if (format_desc_.field_count == 1)
314 return render_progressive_frame();
318 timer.tick_millis(0);
320 auto field1 = render_progressive_frame();
322 timer.tick(0.5 / format_desc_.fps);
324 auto field2 = render_progressive_frame();
326 return draw_frame::interlace(field1, field2, format_desc_.field_mode);
332 frame_fraction_ += speed_.get();
334 if (std::abs(frame_fraction_) >= 1.0)
336 int64_t delta = static_cast<int64_t>(frame_fraction_);
337 auto previous_frame = timeline_frame_number_.get();
338 auto next_frame = timeline_frame_number_.get() + delta;
339 auto marker = find_first_stop_or_jump_or_remove(previous_frame + 1, next_frame);
341 if (marker && marker->second.action == mark_action::remove)
345 if (marker && !going_to_mark_)
347 if (marker->second.action == mark_action::stop)
349 timeline_frame_number_.set(marker->first);
350 frame_fraction_ = 0.0;
353 else if (marker->second.action == mark_action::jump_to)
355 go_to_marker(marker->second.label_argument, 0);
360 timeline_frame_number_.set(next_frame);
361 frame_fraction_ -= delta;
364 going_to_mark_ = false;
368 draw_frame render_progressive_frame()
371 return draw_frame::empty();
379 frame_number_.set(frame_number_.get() + speed_.get());
381 for (auto& timeline : timelines_)
382 timeline.second.on_frame(timeline_frame_number_.get());
384 std::vector<draw_frame> frames;
386 for (auto& layer : layers_)
388 if (layer.hidden.get())
391 draw_frame frame(layer.producer.get()->receive());
392 frame.transform() = get_transform(layer);
393 frames.push_back(frame);
396 return draw_frame(frames);
399 void on_interaction(const interaction_event::ptr& event)
401 aggregator_.translate_and_send(event);
404 bool collides(double x, double y) const
406 m_x_ = static_cast<int64_t>(x * pixel_constraints_.width.get());
407 m_y_ = static_cast<int64_t>(y * pixel_constraints_.height.get());
409 return static_cast<bool>((collission_detect(x, y)));
412 boost::optional<interaction_target> collission_detect(double x, double y) const
414 for (auto& layer : layers_ | boost::adaptors::reversed)
416 if (layer.hidden.get())
419 auto transform = get_transform(layer);
420 auto translated = translate(x, y, transform);
422 if (translated.first >= 0.0
423 && translated.first <= 1.0
424 && translated.second >= 0.0
425 && translated.second <= 1.0
426 && layer.producer.get()->collides(translated.first, translated.second))
428 return std::make_pair(transform, static_cast<interaction_sink*>(layer.producer.get().get()));
432 return boost::optional<interaction_target>();
435 std::future<std::wstring> call(const std::vector<std::wstring>& params)
437 if (!params.empty() && boost::ends_with(params.at(0), L"()"))
438 return make_ready_future(handle_call(params));
440 return make_ready_future(handle_variable_set(params));
443 std::wstring handle_variable_set(const std::vector<std::wstring>& params)
445 for (int i = 0; i + 1 < params.size(); i += 2)
447 auto found = variables_.find(boost::to_lower_copy(params.at(i)));
449 if (found != variables_.end() && found->second->is_public())
450 found->second->from_string(params.at(i + 1));
456 std::wstring handle_call(const std::vector<std::wstring>& params)
458 auto call = params.at(0);
460 if (call == L"play()")
461 go_to_marker(params.at(1), -1);
462 else if (call == L"remove()")
464 else if (call == L"next()")
467 CASPAR_THROW_EXCEPTION(user_error() << msg_info(L"Unknown call " + call));
480 auto marker = find_first_start(timeline_frame_number_.get() + 1);
484 timeline_frame_number_.set(marker->first - 1);
485 frame_fraction_ = 0.0;
487 going_to_mark_ = true;
495 void go_to_marker(const std::wstring& marker_name, int64_t offset)
497 for (auto& marker : markers_by_frame_)
499 if (marker.second.label_argument == marker_name && marker.second.action == mark_action::start)
501 timeline_frame_number_.set(marker.first + offset);
502 frame_fraction_ = 0.0;
504 going_to_mark_ = true;
510 if (marker_name == L"intro")
512 timeline_frame_number_.set(offset);
513 frame_fraction_ = 0.0;
515 going_to_mark_ = true;
517 else if (marker_name == L"outro")
522 CASPAR_LOG(info) << print() << L" no marker called " << marker_name << " found";
525 std::wstring print() const
527 return L"scene[type=" + name() + L"]";
530 std::wstring name() const
532 return producer_name_;
535 boost::property_tree::wptree info() const
537 boost::property_tree::wptree info;
538 info.add(L"type", L"scene");
539 info.add(L"producer-name", name());
540 info.add(L"frame-number", frame_number_.get());
541 info.add(L"timeline-frame-number", timeline_frame_number_.get());
543 for (auto& var : variables_)
545 boost::property_tree::wptree variable_info;
547 variable_info.add(L"name", var.first);
548 variable_info.add(L"public", var.second->is_public());
549 variable_info.add(L"value", var.second->to_string());
551 info.add_child(L"variables.variable", variable_info);
554 for (auto& layer : layers_)
556 boost::property_tree::wptree layer_info;
558 layer_info.add(L"name", layer.name.get());
559 layer_info.add_child(L"producer", layer.producer.get()->info());
560 layer_info.add(L"x", layer.position.x.get());
561 layer_info.add(L"y", layer.position.y.get());
562 layer_info.add(L"width", layer.producer.get()->pixel_constraints().width.get());
563 layer_info.add(L"height", layer.producer.get()->pixel_constraints().height.get());
565 info.add_child(L"layers.layer", layer_info);
571 monitor::subject& monitor_output()
573 return monitor_subject_;
577 scene_producer::scene_producer(std::wstring producer_name, int width, int height, const video_format_desc& format_desc)
578 : impl_(new impl(std::move(producer_name), width, height, format_desc))
582 scene_producer::~scene_producer()
586 layer& scene_producer::create_layer(
587 const spl::shared_ptr<frame_producer>& producer, int x, int y, const std::wstring& name)
589 return impl_->create_layer(producer, x, y, name);
592 layer& scene_producer::create_layer(
593 const spl::shared_ptr<frame_producer>& producer, const std::wstring& name)
595 return impl_->create_layer(producer, 0, 0, name);
598 void scene_producer::reverse_layers() {
599 impl_->reverse_layers();
602 binding<int64_t> scene_producer::timeline_frame()
604 return impl_->timeline_frame();
607 draw_frame scene_producer::receive_impl()
609 return impl_->render_frame();
612 constraints& scene_producer::pixel_constraints() { return impl_->pixel_constraints_; }
614 void scene_producer::on_interaction(const interaction_event::ptr& event)
616 impl_->on_interaction(event);
619 bool scene_producer::collides(double x, double y) const
621 return impl_->collides(x, y);
624 std::wstring scene_producer::print() const
626 return impl_->print();
629 std::wstring scene_producer::name() const
631 return impl_->name();
634 boost::property_tree::wptree scene_producer::info() const
636 return impl_->info();
639 std::future<std::wstring> scene_producer::call(const std::vector<std::wstring>& params)
641 return impl_->call(params);
644 monitor::subject& scene_producer::monitor_output()
646 return impl_->monitor_output();
649 void scene_producer::store_keyframe(void* timeline_identity, const keyframe& k)
651 impl_->store_keyframe(timeline_identity, k);
654 void scene_producer::store_variable(
655 const std::wstring& name, const std::shared_ptr<core::variable>& var)
657 impl_->store_variable(name, var);
660 void scene_producer::add_mark(int64_t frame, mark_action action, const std::wstring& label)
662 impl_->add_mark(frame, action, label);
665 core::variable& scene_producer::get_variable(const std::wstring& name)
667 return impl_->get_variable(name);
670 const std::vector<std::wstring>& scene_producer::get_variables() const
672 return impl_->get_variables();