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)
43 crop.lower_right.x.bind(producer.get()->pixel_constraints().width);
44 crop.lower_right.y.bind(producer.get()->pixel_constraints().height);
45 perspective.upper_right.x.bind(producer.get()->pixel_constraints().width);
46 perspective.lower_right.x.bind(producer.get()->pixel_constraints().width);
47 perspective.lower_right.y.bind(producer.get()->pixel_constraints().height);
48 perspective.lower_left.y.bind(producer.get()->pixel_constraints().height);
51 adjustments::adjustments()
70 std::map<int64_t, keyframe> keyframes;
72 void on_frame(int64_t frame)
74 auto before = --keyframes.upper_bound(frame);
75 bool found_before = before != keyframes.end() && before->first < frame;
76 auto after = keyframes.upper_bound(frame);
77 bool found_after = after != keyframes.end() && after->first > frame;
78 auto exact_frame = keyframes.find(frame);
79 bool found_exact_frame = exact_frame != keyframes.end();
81 if (found_exact_frame)
83 exact_frame->second.on_destination_frame();
85 auto next_frame = ++exact_frame;
87 if (next_frame != keyframes.end() && next_frame->second.on_start_animate)
88 next_frame->second.on_start_animate();
92 int64_t start_frame = 0;
96 start_frame = before->first;
99 if (after->second.on_start_animate && frame == 0)
100 after->second.on_start_animate();
101 else if (after->second.on_animate_to)
102 after->second.on_animate_to(start_frame, frame);
107 mark_action get_mark_action(const std::wstring& name)
109 if (name == L"start")
110 return mark_action::start;
111 else if (name == L"stop")
112 return mark_action::stop;
113 else if (name == L"jump_to")
114 return mark_action::jump_to;
115 else if (name == L"remove")
116 return mark_action::remove;
118 CASPAR_THROW_EXCEPTION(user_error() << msg_info(L"Invalid mark_action " + name));
124 std::wstring label_argument;
126 marker(mark_action action, const std::wstring& label_argument)
128 , label_argument(label_argument)
133 struct scene_producer::impl
135 std::wstring producer_name_;
136 std::wstring template_name_;
137 constraints pixel_constraints_;
138 video_format_desc format_desc_;
139 std::list<layer> layers_;
140 interaction_aggregator aggregator_;
141 binding<double> frame_number_;
142 binding<int64_t> timeline_frame_number_;
143 binding<double> speed_;
144 mutable tbb::atomic<int64_t> m_x_;
145 mutable tbb::atomic<int64_t> m_y_;
146 binding<int64_t> mouse_x_;
147 binding<int64_t> mouse_y_;
148 double frame_fraction_ = 0.0;
149 std::map<void*, timeline> timelines_;
150 std::map<std::wstring, std::shared_ptr<core::variable>> variables_;
151 std::vector<std::wstring> variable_names_;
152 std::multimap<int64_t, marker> markers_by_frame_;
153 std::vector<std::shared_ptr<void>> task_subscriptions_;
154 monitor::subject monitor_subject_;
156 bool removed_ = false;
157 bool going_to_mark_ = false;
160 std::wstring producer_name,
161 std::wstring template_name,
164 const video_format_desc& format_desc)
165 : producer_name_(std::move(producer_name))
166 , template_name_(std::move(template_name))
167 , format_desc_(format_desc)
168 , aggregator_([=] (double x, double y) { return collission_detect(x, y); })
170 auto speed_variable = std::make_shared<core::variable_impl<double>>(L"1.0", true, 1.0);
171 store_variable(L"scene_speed", speed_variable);
172 speed_ = speed_variable->value();
174 auto frame_variable = std::make_shared<core::variable_impl<double>>(L"-1", true, -1);
175 store_variable(L"frame", frame_variable);
176 frame_number_ = frame_variable->value();
178 auto fps = format_desc_.fps * format_desc_.field_count;
179 auto fps_variable = std::make_shared<core::variable_impl<double>>(boost::lexical_cast<std::wstring>(fps), false, fps);
180 store_variable(L"fps", fps_variable);
182 auto timeline_frame_variable = std::make_shared<core::variable_impl<int64_t>>(L"-1", false, -1);
183 store_variable(L"timeline_frame", timeline_frame_variable);
184 timeline_frame_number_ = timeline_frame_variable->value();
186 auto mouse_x_variable = std::make_shared<core::variable_impl<int64_t>>(L"0", false, 0);
187 auto mouse_y_variable = std::make_shared<core::variable_impl<int64_t>>(L"0", false, 0);
188 store_variable(L"mouse_x", mouse_x_variable);
189 store_variable(L"mouse_y", mouse_y_variable);
190 mouse_x_ = mouse_x_variable->value();
191 mouse_y_ = mouse_y_variable->value();
195 auto scene_width = std::make_shared<core::variable_impl<double>>(boost::lexical_cast<std::wstring>(width), false, width);
196 auto scene_height = std::make_shared<core::variable_impl<double>>(boost::lexical_cast<std::wstring>(height), false, height);
197 store_variable(L"scene_width", scene_width);
198 store_variable(L"scene_height", scene_height);
199 pixel_constraints_.width = scene_width->value();
200 pixel_constraints_.height = scene_height->value();
204 const spl::shared_ptr<frame_producer>& producer, int x, int y, const std::wstring& name)
206 layer layer(name, producer);
208 layer.position.x.set(x);
209 layer.position.y.set(y);
210 layer.clip.lower_right.x.bind(pixel_constraints_.width);
211 layer.clip.lower_right.y.bind(pixel_constraints_.height);
213 layers_.push_back(layer);
215 return layers_.back();
218 void reverse_layers() {
222 layer& get_layer(const std::wstring& name)
224 for (auto& layer : layers_)
225 if (layer.name.get() == name)
228 CASPAR_THROW_EXCEPTION(user_error() << msg_info(name + L" not found in scene"));
231 void store_keyframe(void* timeline_identity, const keyframe& k)
233 timelines_[timeline_identity].keyframes.insert(std::make_pair(k.destination_frame, k));
237 const std::wstring& name, const std::shared_ptr<core::variable>& var)
239 variables_.insert(std::make_pair(name, var));
240 variable_names_.push_back(name);
243 void add_mark(int64_t frame, mark_action action, const std::wstring& label)
245 markers_by_frame_.insert(std::make_pair(frame, marker(action, label)));
248 void add_task(binding<bool> when, std::function<void ()> task)
250 auto subscription = when.on_change([=]
260 CASPAR_LOG_CURRENT_EXCEPTION_AT_LEVEL(debug);
261 CASPAR_LOG(error) << print() << " Error when invoking scene task. Turn on log level debug for stacktrace.";
266 task_subscriptions_.push_back(std::move(subscription));
269 core::variable& get_variable(const std::wstring& name)
271 auto found = variables_.find(name);
273 if (found == variables_.end())
274 CASPAR_THROW_EXCEPTION(user_error() << msg_info(name + L" not found in scene"));
276 return *found->second;
279 const std::vector<std::wstring>& get_variables() const
281 return variable_names_;
284 binding<int64_t> timeline_frame()
286 return timeline_frame_number_;
289 frame_transform get_transform(const layer& layer) const
291 frame_transform transform;
293 auto& anchor = transform.image_transform.anchor;
294 auto& pos = transform.image_transform.fill_translation;
295 auto& scale = transform.image_transform.fill_scale;
296 auto& clip_pos = transform.image_transform.clip_translation;
297 auto& clip_scale = transform.image_transform.clip_scale;
298 auto& angle = transform.image_transform.angle;
299 auto& crop = transform.image_transform.crop;
300 auto& pers = transform.image_transform.perspective;
301 auto& levels = transform.image_transform.levels;
303 anchor[0] = layer.anchor.x.get() / layer.producer.get()->pixel_constraints().width.get();
304 anchor[1] = layer.anchor.y.get() / layer.producer.get()->pixel_constraints().height.get();
306 pos[0] = layer.position.x.get() / pixel_constraints_.width.get();
307 pos[1] = layer.position.y.get() / pixel_constraints_.height.get();
308 scale[0] = layer.producer.get()->pixel_constraints().width.get() / pixel_constraints_.width.get();
309 scale[1] = layer.producer.get()->pixel_constraints().height.get() / pixel_constraints_.height.get();
311 clip_pos[0] = layer.clip.upper_left.x.get() / pixel_constraints_.width.get();
312 clip_pos[1] = layer.clip.upper_left.y.get() / pixel_constraints_.height.get();
313 clip_scale[0] = layer.clip.lower_right.x.get() / pixel_constraints_.width.get() - clip_pos[0];
314 clip_scale[1] = layer.clip.lower_right.y.get() / pixel_constraints_.height.get() - clip_pos[1];
316 crop.ul[0] = layer.crop.upper_left.x.get() / layer.producer.get()->pixel_constraints().width.get();
317 crop.ul[1] = layer.crop.upper_left.y.get() / layer.producer.get()->pixel_constraints().height.get();
318 crop.lr[0] = layer.crop.lower_right.x.get() / layer.producer.get()->pixel_constraints().width.get();
319 crop.lr[1] = layer.crop.lower_right.y.get() / layer.producer.get()->pixel_constraints().height.get();
321 pers.ul[0] = layer.perspective.upper_left.x.get() / layer.producer.get()->pixel_constraints().width.get();
322 pers.ul[1] = layer.perspective.upper_left.y.get() / layer.producer.get()->pixel_constraints().height.get();
323 pers.ur[0] = layer.perspective.upper_right.x.get() / layer.producer.get()->pixel_constraints().width.get();
324 pers.ur[1] = layer.perspective.upper_right.y.get() / layer.producer.get()->pixel_constraints().height.get();
325 pers.lr[0] = layer.perspective.lower_right.x.get() / layer.producer.get()->pixel_constraints().width.get();
326 pers.lr[1] = layer.perspective.lower_right.y.get() / layer.producer.get()->pixel_constraints().height.get();
327 pers.ll[0] = layer.perspective.lower_left.x.get() / layer.producer.get()->pixel_constraints().width.get();
328 pers.ll[1] = layer.perspective.lower_left.y.get() / layer.producer.get()->pixel_constraints().height.get();
330 static const double PI = 3.141592653589793;
332 angle = layer.rotation.get() * PI / 180.0;
334 levels.min_input = layer.levels.min_input.get();
335 levels.max_input = layer.levels.max_input.get();
336 levels.gamma = layer.levels.gamma.get();
337 levels.min_output = layer.levels.min_output.get();
338 levels.max_output = layer.levels.max_output.get();
340 transform.image_transform.opacity = layer.adjustments.opacity.get();
341 transform.image_transform.contrast = layer.adjustments.contrast.get();
342 transform.image_transform.saturation = layer.adjustments.saturation.get();
343 transform.image_transform.brightness = layer.adjustments.brightness.get();
344 transform.image_transform.is_key = layer.is_key.get();
345 transform.image_transform.use_mipmap = layer.use_mipmap.get();
346 transform.image_transform.blend_mode = layer.blend_mode.get();
348 transform.image_transform.chroma.enable = layer.chroma_key.enable.get();
349 transform.image_transform.chroma.target_hue = layer.chroma_key.target_hue.get();
350 transform.image_transform.chroma.hue_width = layer.chroma_key.hue_width.get();
351 transform.image_transform.chroma.min_saturation = layer.chroma_key.min_saturation.get();
352 transform.image_transform.chroma.min_brightness = layer.chroma_key.min_brightness.get();
353 transform.image_transform.chroma.softness = layer.chroma_key.softness.get();
354 transform.image_transform.chroma.spill_suppress = layer.chroma_key.spill_suppress.get();
355 transform.image_transform.chroma.spill_suppress_saturation = layer.chroma_key.spill_suppress_saturation.get();
357 transform.audio_transform.volume = layer.volume.get();
359 // Mark as sublayer, so it will be composited separately by the mixer.
360 transform.image_transform.layer_depth = 1;
365 boost::optional<std::pair<int64_t, marker>> find_first_stop_or_jump_or_remove(int64_t start_frame, int64_t end_frame)
367 auto lower = markers_by_frame_.lower_bound(start_frame);
368 auto upper = markers_by_frame_.upper_bound(end_frame);
370 if (lower == markers_by_frame_.end())
373 for (auto iter = lower; iter != upper; ++iter)
375 auto action = iter->second.action;
377 if (action == mark_action::stop || action == mark_action::jump_to || action == mark_action::remove)
378 return std::make_pair(iter->first, iter->second);
384 boost::optional<std::pair<int64_t, marker>> find_first_start(int64_t start_frame)
386 auto lower = markers_by_frame_.lower_bound(start_frame);
388 if (lower == markers_by_frame_.end())
391 for (auto iter = lower; iter != markers_by_frame_.end(); ++iter)
393 auto action = iter->second.action;
395 if (action == mark_action::start)
396 return std::make_pair(iter->first, iter->second);
402 draw_frame render_frame()
404 if (format_desc_.field_count == 1)
405 return render_progressive_frame();
409 timer.tick_millis(0);
411 auto field1 = render_progressive_frame();
413 timer.tick(0.5 / format_desc_.fps);
415 auto field2 = render_progressive_frame();
417 return draw_frame::interlace(field1, field2, format_desc_.field_mode);
423 frame_fraction_ += speed_.get();
425 if (std::abs(frame_fraction_) >= 1.0)
427 int64_t delta = static_cast<int64_t>(frame_fraction_);
428 auto previous_frame = timeline_frame_number_.get();
429 auto next_frame = timeline_frame_number_.get() + delta;
430 auto marker = find_first_stop_or_jump_or_remove(previous_frame + 1, next_frame);
432 if (marker && marker->second.action == mark_action::remove)
436 if (marker && !going_to_mark_)
438 if (marker->second.action == mark_action::stop)
440 timeline_frame_number_.set(marker->first);
441 frame_fraction_ = 0.0;
444 else if (marker->second.action == mark_action::jump_to)
446 go_to_marker(marker->second.label_argument, 0);
451 timeline_frame_number_.set(next_frame);
452 frame_fraction_ -= delta;
455 going_to_mark_ = false;
459 draw_frame render_progressive_frame()
462 return draw_frame::empty();
470 frame_number_.set(frame_number_.get() + speed_.get());
472 for (auto& timeline : timelines_)
473 timeline.second.on_frame(timeline_frame_number_.get());
475 std::vector<draw_frame> frames;
477 for (auto& layer : layers_)
479 if (layer.hidden.get())
482 draw_frame frame(layer.producer.get()->receive());
483 frame.transform() = get_transform(layer);
484 frames.push_back(frame);
487 return draw_frame(frames);
490 void on_interaction(const interaction_event::ptr& event)
492 aggregator_.translate_and_send(event);
495 bool collides(double x, double y) const
497 m_x_ = static_cast<int64_t>(x * pixel_constraints_.width.get());
498 m_y_ = static_cast<int64_t>(y * pixel_constraints_.height.get());
500 return static_cast<bool>((collission_detect(x, y)));
503 boost::optional<interaction_target> collission_detect(double x, double y) const
505 for (auto& layer : layers_ | boost::adaptors::reversed)
507 if (layer.hidden.get())
510 auto transform = get_transform(layer);
511 auto translated = translate(x, y, transform);
513 if (translated.first >= 0.0
514 && translated.first <= 1.0
515 && translated.second >= 0.0
516 && translated.second <= 1.0
517 && layer.producer.get()->collides(translated.first, translated.second))
519 return std::make_pair(transform, static_cast<interaction_sink*>(layer.producer.get().get()));
523 return boost::optional<interaction_target>();
526 std::future<std::wstring> call(const std::vector<std::wstring>& params)
528 if (!params.empty() && boost::ends_with(params.at(0), L"()"))
529 return make_ready_future(handle_call(params));
531 return make_ready_future(handle_variable_set(params));
534 std::wstring handle_variable_set(const std::vector<std::wstring>& params)
536 for (int i = 0; i + 1 < params.size(); i += 2)
538 auto found = variables_.find(boost::to_lower_copy(params.at(i)));
540 if (found != variables_.end() && found->second->is_public())
541 found->second->from_string(params.at(i + 1));
547 std::wstring handle_call(const std::vector<std::wstring>& params)
549 auto call = params.at(0);
551 if (call == L"play()")
552 go_to_marker(params.at(1), -1);
553 else if (call == L"remove()")
555 else if (call == L"next()")
558 CASPAR_THROW_EXCEPTION(user_error() << msg_info(L"Unknown call " + call));
571 auto marker = find_first_start(timeline_frame_number_.get() + 1);
575 timeline_frame_number_.set(marker->first - 1);
576 frame_fraction_ = 0.0;
578 going_to_mark_ = true;
586 void go_to_marker(const std::wstring& marker_name, int64_t offset)
588 for (auto& marker : markers_by_frame_)
590 if (marker.second.label_argument == marker_name && marker.second.action == mark_action::start)
592 timeline_frame_number_.set(marker.first + offset);
593 frame_fraction_ = 0.0;
595 going_to_mark_ = true;
601 if (marker_name == L"intro")
603 timeline_frame_number_.set(offset);
604 frame_fraction_ = 0.0;
606 going_to_mark_ = true;
608 else if (marker_name == L"outro")
613 CASPAR_LOG(info) << print() << L" no marker called " << marker_name << " found";
616 std::wstring print() const
618 return L"scene[type=" + name() + L" template=" + template_name_ + L"]";
621 std::wstring name() const
623 return producer_name_;
626 boost::property_tree::wptree info() const
628 boost::property_tree::wptree info;
629 info.add(L"type", L"scene");
630 info.add(L"producer-name", name());
631 info.add(L"template-name", template_name_);
632 info.add(L"frame-number", frame_number_.get());
633 info.add(L"timeline-frame-number", timeline_frame_number_.get());
635 for (auto& var : variables_)
637 boost::property_tree::wptree variable_info;
639 variable_info.add(L"name", var.first);
640 variable_info.add(L"public", var.second->is_public());
641 variable_info.add(L"value", var.second->to_string());
643 info.add_child(L"variables.variable", variable_info);
646 for (auto& layer : layers_)
648 boost::property_tree::wptree layer_info;
650 layer_info.add(L"name", layer.name.get());
651 layer_info.add_child(L"producer", layer.producer.get()->info());
652 layer_info.add(L"x", layer.position.x.get());
653 layer_info.add(L"y", layer.position.y.get());
654 layer_info.add(L"width", layer.producer.get()->pixel_constraints().width.get());
655 layer_info.add(L"height", layer.producer.get()->pixel_constraints().height.get());
657 info.add_child(L"layers.layer", layer_info);
663 monitor::subject& monitor_output()
665 return monitor_subject_;
669 scene_producer::scene_producer(std::wstring producer_name, std::wstring template_name, int width, int height, const video_format_desc& format_desc)
670 : impl_(new impl(std::move(producer_name), std::move(template_name), width, height, format_desc))
674 scene_producer::~scene_producer()
678 layer& scene_producer::create_layer(
679 const spl::shared_ptr<frame_producer>& producer, int x, int y, const std::wstring& name)
681 return impl_->create_layer(producer, x, y, name);
684 layer& scene_producer::create_layer(
685 const spl::shared_ptr<frame_producer>& producer, const std::wstring& name)
687 return impl_->create_layer(producer, 0, 0, name);
690 void scene_producer::reverse_layers()
692 impl_->reverse_layers();
695 layer& scene_producer::get_layer(const std::wstring& name)
697 return impl_->get_layer(name);
700 binding<int64_t> scene_producer::timeline_frame()
702 return impl_->timeline_frame();
705 draw_frame scene_producer::receive_impl()
707 return impl_->render_frame();
710 constraints& scene_producer::pixel_constraints() { return impl_->pixel_constraints_; }
712 void scene_producer::on_interaction(const interaction_event::ptr& event)
714 impl_->on_interaction(event);
717 bool scene_producer::collides(double x, double y) const
719 return impl_->collides(x, y);
722 std::wstring scene_producer::print() const
724 return impl_->print();
727 std::wstring scene_producer::name() const
729 return impl_->name();
732 boost::property_tree::wptree scene_producer::info() const
734 return impl_->info();
737 std::future<std::wstring> scene_producer::call(const std::vector<std::wstring>& params)
739 return impl_->call(params);
742 monitor::subject& scene_producer::monitor_output()
744 return impl_->monitor_output();
747 void scene_producer::store_keyframe(void* timeline_identity, const keyframe& k)
749 impl_->store_keyframe(timeline_identity, k);
752 void scene_producer::store_variable(
753 const std::wstring& name, const std::shared_ptr<core::variable>& var)
755 impl_->store_variable(name, var);
758 void scene_producer::add_mark(int64_t frame, mark_action action, const std::wstring& label)
760 impl_->add_mark(frame, action, label);
763 void scene_producer::add_task(binding<bool> when, std::function<void ()> task)
765 impl_->add_task(std::move(when), std::move(task));
768 core::variable& scene_producer::get_variable(const std::wstring& name)
770 return impl_->get_variable(name);
773 const std::vector<std::wstring>& scene_producer::get_variables() const
775 return impl_->get_variables();