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 , format_desc_(format_desc)
146 , aggregator_([=] (double x, double y) { return collission_detect(x, y); })
148 auto speed_variable = std::make_shared<core::variable_impl<double>>(L"1.0", true, 1.0);
149 store_variable(L"scene_speed", speed_variable);
150 speed_ = speed_variable->value();
152 auto frame_variable = std::make_shared<core::variable_impl<double>>(L"-1", true, -1);
153 store_variable(L"frame", frame_variable);
154 frame_number_ = frame_variable->value();
156 auto timeline_frame_variable = std::make_shared<core::variable_impl<int64_t>>(L"-1", false, -1);
157 store_variable(L"timeline_frame", timeline_frame_variable);
158 timeline_frame_number_ = timeline_frame_variable->value();
160 auto mouse_x_variable = std::make_shared<core::variable_impl<int64_t>>(L"0", false, 0);
161 auto mouse_y_variable = std::make_shared<core::variable_impl<int64_t>>(L"0", false, 0);
162 store_variable(L"mouse_x", mouse_x_variable);
163 store_variable(L"mouse_y", mouse_y_variable);
164 mouse_x_ = mouse_x_variable->value();
165 mouse_y_ = mouse_y_variable->value();
169 auto scene_width = std::make_shared<core::variable_impl<double>>(boost::lexical_cast<std::wstring>(width), false, width);
170 auto scene_height = std::make_shared<core::variable_impl<double>>(boost::lexical_cast<std::wstring>(height), false, height);
171 store_variable(L"scene_width", scene_width);
172 store_variable(L"scene_height", scene_height);
173 pixel_constraints_.width = scene_width->value();
174 pixel_constraints_.height = scene_height->value();
178 const spl::shared_ptr<frame_producer>& producer, int x, int y, const std::wstring& name)
180 layer layer(name, producer);
182 layer.position.x.set(x);
183 layer.position.y.set(y);
185 layers_.push_back(layer);
187 return layers_.back();
190 void reverse_layers() {
194 void store_keyframe(void* timeline_identity, const keyframe& k)
196 timelines_[timeline_identity].keyframes.insert(std::make_pair(k.destination_frame, k));
200 const std::wstring& name, const std::shared_ptr<core::variable>& var)
202 variables_.insert(std::make_pair(name, var));
203 variable_names_.push_back(name);
206 void add_mark(int64_t frame, mark_action action, const std::wstring& label)
208 markers_by_frame_.insert(std::make_pair(frame, marker(action, label)));
211 core::variable& get_variable(const std::wstring& name)
213 auto found = variables_.find(name);
215 if (found == variables_.end())
216 CASPAR_THROW_EXCEPTION(user_error() << msg_info(name + L" not found in scene"));
218 return *found->second;
221 const std::vector<std::wstring>& get_variables() const
223 return variable_names_;
226 binding<int64_t> timeline_frame()
228 return timeline_frame_number_;
231 frame_transform get_transform(const layer& layer) const
233 frame_transform transform;
235 auto& anchor = transform.image_transform.anchor;
236 auto& pos = transform.image_transform.fill_translation;
237 auto& scale = transform.image_transform.fill_scale;
238 auto& angle = transform.image_transform.angle;
239 auto& crop = transform.image_transform.crop;
240 auto& pers = transform.image_transform.perspective;
242 anchor[0] = layer.anchor.x.get() / layer.producer.get()->pixel_constraints().width.get();
243 anchor[1] = layer.anchor.y.get() / layer.producer.get()->pixel_constraints().height.get();
244 pos[0] = layer.position.x.get() / pixel_constraints_.width.get();
245 pos[1] = layer.position.y.get() / pixel_constraints_.height.get();
246 scale[0] = layer.producer.get()->pixel_constraints().width.get() / pixel_constraints_.width.get();
247 scale[1] = layer.producer.get()->pixel_constraints().height.get() / pixel_constraints_.height.get();
248 crop.ul[0] = layer.crop.upper_left.x.get() / layer.producer.get()->pixel_constraints().width.get();
249 crop.ul[1] = layer.crop.upper_left.y.get() / layer.producer.get()->pixel_constraints().height.get();
250 crop.lr[0] = layer.crop.lower_right.x.get() / layer.producer.get()->pixel_constraints().width.get();
251 crop.lr[1] = layer.crop.lower_right.y.get() / layer.producer.get()->pixel_constraints().height.get();
252 pers.ul[0] = layer.perspective.upper_left.x.get() / layer.producer.get()->pixel_constraints().width.get();
253 pers.ul[1] = layer.perspective.upper_left.y.get() / layer.producer.get()->pixel_constraints().height.get();
254 pers.ur[0] = layer.perspective.upper_right.x.get() / layer.producer.get()->pixel_constraints().width.get();
255 pers.ur[1] = layer.perspective.upper_right.y.get() / layer.producer.get()->pixel_constraints().height.get();
256 pers.lr[0] = layer.perspective.lower_right.x.get() / layer.producer.get()->pixel_constraints().width.get();
257 pers.lr[1] = layer.perspective.lower_right.y.get() / layer.producer.get()->pixel_constraints().height.get();
258 pers.ll[0] = layer.perspective.lower_left.x.get() / layer.producer.get()->pixel_constraints().width.get();
259 pers.ll[1] = layer.perspective.lower_left.y.get() / layer.producer.get()->pixel_constraints().height.get();
261 static const double PI = 3.141592653589793;
263 angle = layer.rotation.get() * PI / 180.0;
265 transform.image_transform.opacity = layer.adjustments.opacity.get();
266 transform.image_transform.is_key = layer.is_key.get();
267 transform.image_transform.use_mipmap = layer.use_mipmap.get();
268 transform.image_transform.blend_mode = layer.blend_mode.get();
269 transform.image_transform.chroma.enable = layer.chroma_key.enable.get();
270 transform.image_transform.chroma.target_hue = layer.chroma_key.target_hue.get();
271 transform.image_transform.chroma.hue_width = layer.chroma_key.hue_width.get();
272 transform.image_transform.chroma.min_saturation = layer.chroma_key.min_saturation.get();
273 transform.image_transform.chroma.min_brightness = layer.chroma_key.min_brightness.get();
274 transform.image_transform.chroma.softness = layer.chroma_key.softness.get();
275 transform.image_transform.chroma.spill = layer.chroma_key.spill.get();
276 transform.image_transform.chroma.spill_darken = layer.chroma_key.spill_darken.get();
278 // Mark as sublayer, so it will be composited separately by the mixer.
279 transform.image_transform.layer_depth = 1;
284 boost::optional<std::pair<int64_t, marker>> find_first_stop_or_jump_or_remove(int64_t start_frame, int64_t end_frame)
286 auto lower = markers_by_frame_.lower_bound(start_frame);
287 auto upper = markers_by_frame_.upper_bound(end_frame);
289 if (lower == markers_by_frame_.end())
292 for (auto iter = lower; iter != upper; ++iter)
294 auto action = iter->second.action;
296 if (action == mark_action::stop || action == mark_action::jump_to || action == mark_action::remove)
297 return std::make_pair(iter->first, iter->second);
303 boost::optional<std::pair<int64_t, marker>> find_first_start(int64_t start_frame)
305 auto lower = markers_by_frame_.lower_bound(start_frame);
307 if (lower == markers_by_frame_.end())
310 for (auto iter = lower; iter != markers_by_frame_.end(); ++iter)
312 auto action = iter->second.action;
314 if (action == mark_action::start)
315 return std::make_pair(iter->first, iter->second);
321 draw_frame render_frame()
323 if (format_desc_.field_count == 1)
324 return render_progressive_frame();
328 timer.tick_millis(0);
330 auto field1 = render_progressive_frame();
332 timer.tick(0.5 / format_desc_.fps);
334 auto field2 = render_progressive_frame();
336 return draw_frame::interlace(field1, field2, format_desc_.field_mode);
342 frame_fraction_ += speed_.get();
344 if (std::abs(frame_fraction_) >= 1.0)
346 int64_t delta = static_cast<int64_t>(frame_fraction_);
347 auto previous_frame = timeline_frame_number_.get();
348 auto next_frame = timeline_frame_number_.get() + delta;
349 auto marker = find_first_stop_or_jump_or_remove(previous_frame + 1, next_frame);
351 if (marker && marker->second.action == mark_action::remove)
355 if (marker && !going_to_mark_)
357 if (marker->second.action == mark_action::stop)
359 timeline_frame_number_.set(marker->first);
360 frame_fraction_ = 0.0;
363 else if (marker->second.action == mark_action::jump_to)
365 go_to_marker(marker->second.label_argument, 0);
370 timeline_frame_number_.set(next_frame);
371 frame_fraction_ -= delta;
374 going_to_mark_ = false;
378 draw_frame render_progressive_frame()
381 return draw_frame::empty();
389 frame_number_.set(frame_number_.get() + speed_.get());
391 for (auto& timeline : timelines_)
392 timeline.second.on_frame(timeline_frame_number_.get());
394 std::vector<draw_frame> frames;
396 for (auto& layer : layers_)
398 if (layer.hidden.get())
401 draw_frame frame(layer.producer.get()->receive());
402 frame.transform() = get_transform(layer);
403 frames.push_back(frame);
406 return draw_frame(frames);
409 void on_interaction(const interaction_event::ptr& event)
411 aggregator_.translate_and_send(event);
414 bool collides(double x, double y) const
416 m_x_ = static_cast<int64_t>(x * pixel_constraints_.width.get());
417 m_y_ = static_cast<int64_t>(y * pixel_constraints_.height.get());
419 return static_cast<bool>((collission_detect(x, y)));
422 boost::optional<interaction_target> collission_detect(double x, double y) const
424 for (auto& layer : layers_ | boost::adaptors::reversed)
426 if (layer.hidden.get())
429 auto transform = get_transform(layer);
430 auto translated = translate(x, y, transform);
432 if (translated.first >= 0.0
433 && translated.first <= 1.0
434 && translated.second >= 0.0
435 && translated.second <= 1.0
436 && layer.producer.get()->collides(translated.first, translated.second))
438 return std::make_pair(transform, static_cast<interaction_sink*>(layer.producer.get().get()));
442 return boost::optional<interaction_target>();
445 std::future<std::wstring> call(const std::vector<std::wstring>& params)
447 if (!params.empty() && boost::ends_with(params.at(0), L"()"))
448 return make_ready_future(handle_call(params));
450 return make_ready_future(handle_variable_set(params));
453 std::wstring handle_variable_set(const std::vector<std::wstring>& params)
455 for (int i = 0; i + 1 < params.size(); i += 2)
457 auto found = variables_.find(boost::to_lower_copy(params.at(i)));
459 if (found != variables_.end() && found->second->is_public())
460 found->second->from_string(params.at(i + 1));
466 std::wstring handle_call(const std::vector<std::wstring>& params)
468 auto call = params.at(0);
470 if (call == L"play()")
471 go_to_marker(params.at(1), -1);
472 else if (call == L"remove()")
474 else if (call == L"next()")
477 CASPAR_THROW_EXCEPTION(user_error() << msg_info(L"Unknown call " + call));
490 auto marker = find_first_start(timeline_frame_number_.get() + 1);
494 timeline_frame_number_.set(marker->first - 1);
495 frame_fraction_ = 0.0;
497 going_to_mark_ = true;
505 void go_to_marker(const std::wstring& marker_name, int64_t offset)
507 for (auto& marker : markers_by_frame_)
509 if (marker.second.label_argument == marker_name && marker.second.action == mark_action::start)
511 timeline_frame_number_.set(marker.first + offset);
512 frame_fraction_ = 0.0;
514 going_to_mark_ = true;
520 if (marker_name == L"intro")
522 timeline_frame_number_.set(offset);
523 frame_fraction_ = 0.0;
525 going_to_mark_ = true;
527 else if (marker_name == L"outro")
532 CASPAR_LOG(info) << print() << L" no marker called " << marker_name << " found";
535 std::wstring print() const
537 return L"scene[type=" + name() + L"]";
540 std::wstring name() const
542 return producer_name_;
545 boost::property_tree::wptree info() const
547 boost::property_tree::wptree info;
548 info.add(L"type", L"scene");
549 info.add(L"producer-name", name());
550 info.add(L"frame-number", frame_number_.get());
551 info.add(L"timeline-frame-number", timeline_frame_number_.get());
553 for (auto& var : variables_)
555 boost::property_tree::wptree variable_info;
557 variable_info.add(L"name", var.first);
558 variable_info.add(L"public", var.second->is_public());
559 variable_info.add(L"value", var.second->to_string());
561 info.add_child(L"variables.variable", variable_info);
564 for (auto& layer : layers_)
566 boost::property_tree::wptree layer_info;
568 layer_info.add(L"name", layer.name.get());
569 layer_info.add_child(L"producer", layer.producer.get()->info());
570 layer_info.add(L"x", layer.position.x.get());
571 layer_info.add(L"y", layer.position.y.get());
572 layer_info.add(L"width", layer.producer.get()->pixel_constraints().width.get());
573 layer_info.add(L"height", layer.producer.get()->pixel_constraints().height.get());
575 info.add_child(L"layers.layer", layer_info);
581 monitor::subject& monitor_output()
583 return monitor_subject_;
587 scene_producer::scene_producer(std::wstring producer_name, int width, int height, const video_format_desc& format_desc)
588 : impl_(new impl(std::move(producer_name), width, height, format_desc))
592 scene_producer::~scene_producer()
596 layer& scene_producer::create_layer(
597 const spl::shared_ptr<frame_producer>& producer, int x, int y, const std::wstring& name)
599 return impl_->create_layer(producer, x, y, name);
602 layer& scene_producer::create_layer(
603 const spl::shared_ptr<frame_producer>& producer, const std::wstring& name)
605 return impl_->create_layer(producer, 0, 0, name);
608 void scene_producer::reverse_layers() {
609 impl_->reverse_layers();
612 binding<int64_t> scene_producer::timeline_frame()
614 return impl_->timeline_frame();
617 draw_frame scene_producer::receive_impl()
619 return impl_->render_frame();
622 constraints& scene_producer::pixel_constraints() { return impl_->pixel_constraints_; }
624 void scene_producer::on_interaction(const interaction_event::ptr& event)
626 impl_->on_interaction(event);
629 bool scene_producer::collides(double x, double y) const
631 return impl_->collides(x, y);
634 std::wstring scene_producer::print() const
636 return impl_->print();
639 std::wstring scene_producer::name() const
641 return impl_->name();
644 boost::property_tree::wptree scene_producer::info() const
646 return impl_->info();
649 std::future<std::wstring> scene_producer::call(const std::vector<std::wstring>& params)
651 return impl_->call(params);
654 monitor::subject& scene_producer::monitor_output()
656 return impl_->monitor_output();
659 void scene_producer::store_keyframe(void* timeline_identity, const keyframe& k)
661 impl_->store_keyframe(timeline_identity, k);
664 void scene_producer::store_variable(
665 const std::wstring& name, const std::shared_ptr<core::variable>& var)
667 impl_->store_variable(name, var);
670 void scene_producer::add_mark(int64_t frame, mark_action action, const std::wstring& label)
672 impl_->add_mark(frame, action, label);
675 core::variable& scene_producer::get_variable(const std::wstring& name)
677 return impl_->get_variable(name);
680 const std::vector<std::wstring>& scene_producer::get_variables() const
682 return impl_->get_variables();