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: Niklas P Andersson, niklas.p.andersson@svt.se
22 #include "psd_scene_producer.h"
23 #include "psd_document.h"
26 #include <core/frame/pixel_format.h>
27 #include <core/frame/frame_factory.h>
28 #include <core/frame/audio_channel_layout.h>
29 #include <core/producer/frame_producer.h>
30 #include <core/producer/color/color_producer.h>
31 #include <core/producer/text/text_producer.h>
32 #include <core/producer/scene/scene_cg_proxy.h>
33 #include <core/producer/scene/scene_producer.h>
34 #include <core/producer/scene/const_producer.h>
35 #include <core/producer/scene/hotswap_producer.h>
36 #include <core/producer/media_info/media_info.h>
37 #include <core/frame/draw_frame.h>
38 #include <core/help/help_repository.h>
39 #include <core/help/help_sink.h>
41 #include <common/env.h>
42 #include <common/memory.h>
43 #include <common/log.h>
44 #include <common/os/filesystem.h>
46 #include <boost/filesystem.hpp>
47 #include <boost/thread/future.hpp>
48 #include <boost/algorithm/string.hpp>
49 #include <boost/rational.hpp>
53 namespace caspar { namespace psd {
55 core::text::text_info get_text_info(const boost::property_tree::wptree& ptree)
57 core::text::text_info result;
58 int font_index = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.Font", 0);
59 result.size = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.FontSize", 30.0f);
60 //result.leading = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.Leading", 0);
61 result.tracking = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.Tracking", 0);
62 result.baseline_shift = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.BaselineShift", 0);
63 //result.kerning = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.Kerning", 0);
66 auto color_node = ptree.get_child_optional(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.FillColor.Values");
70 for(auto it = color_node->begin(); it != color_node->end(); ++it, ++child_index)
72 auto& value_node = (*it).second;
73 float value = value_node.get_value(0.0f);
76 case 0: result.color.a = value; break;
77 case 1: result.color.r = value; break;
78 case 2: result.color.g = value; break;
79 case 3: result.color.b = value; break;
86 auto fontset_node = ptree.get_child(L"ResourceDict.FontSet");
87 for(auto it = fontset_node.begin(); it != fontset_node.end(); ++it, ++child_index)
89 auto& font_node = (*it).second;
90 if(child_index == font_index)
92 result.font = font_node.get(L"Name", L"");
101 class dependency_resolver
105 layer_record() : layer(nullptr), tags(layer_tag::none), adjustment_x(0), adjustment_y(0)
108 caspar::core::scene::layer* layer;
114 std::list<layer_record> layers;
117 spl::shared_ptr<core::scene::scene_producer> scene_;
121 dependency_resolver(const spl::shared_ptr<core::scene::scene_producer>& s) :
122 scene_(s), is_root_(false)
124 dependency_resolver(const spl::shared_ptr<core::scene::scene_producer>& s, bool root) :
125 scene_(s), is_root_(root)
128 spl::shared_ptr<core::scene::scene_producer> scene() { return scene_; }
130 void add(caspar::core::scene::layer* layer, layer_tag tags, double adjustment_x, double adjustment_y)
135 rec.adjustment_x = adjustment_x;
136 rec.adjustment_y = adjustment_y;
137 layers.push_back(rec);
139 //if the layer is either explicitly tagged as dynamic or at least not tagged as static/rasterized we should try to set it as master
140 if((rec.tags & layer_tag::explicit_dynamic) == layer_tag::explicit_dynamic || (rec.tags & layer_tag::rasterized) == layer_tag::none)
142 //if we don't have a master already, just assign this
143 if (master.layer == nullptr)
145 else if ((rec.tags & layer_tag::explicit_dynamic) == layer_tag::explicit_dynamic)
147 if((master.tags & layer_tag::explicit_dynamic) == layer_tag::none)
149 //if we have a master that's not explicitly tagged as dynamic but this layer is; use this as master
153 //we have multiple layers that're tagged as dynamic, warn that the first one will be used
154 CASPAR_LOG(warning) << "Multiple explicitly dynamic layers in the same group. The first one will be used";
162 if (layers.size() == 0)
165 if (master.layer == nullptr) {
166 CASPAR_LOG(warning) << "Dependent layers without any dynamic layer";
170 for (auto &r : layers)
172 if (r.layer != master.layer)
175 double slave_left = r.layer->position.x.get();
176 double master_left = master.layer->position.x.get();
177 double slave_right = slave_left + r.layer->producer.get()->pixel_constraints().width.get();
178 double master_right = master_left + master.layer->producer.get()->pixel_constraints().width.get();
180 double slave_width = slave_right - slave_left;
181 double master_width = master_right - master_left;
183 double offset_start_x = slave_left - master_left;
184 double offset_end_x = slave_left - master_right;
186 if((r.tags & layer_tag::moveable) == layer_tag::moveable)
187 r.layer->position.x.bind(master.layer->position.x + master.layer->producer.get()->pixel_constraints().width + offset_end_x + r.adjustment_x);
188 else if ((r.tags & layer_tag::resizable) == layer_tag::resizable) {
189 r.layer->position.x.bind(master.layer->position.x + offset_start_x + r.adjustment_x);
190 r.layer->producer.get()->pixel_constraints().width.bind(master.layer->producer.get()->pixel_constraints().width + (slave_width - master_width));
193 //no support for changes in the y-direction yet
199 int64_t get_frame_number(
200 const core::video_format_desc& format_desc,
201 const boost::rational<int>& at_second)
203 return static_cast<int64_t>(
204 boost::rational_cast<double>(at_second) * format_desc.fps);
207 boost::rational<int> get_rational(const boost::property_tree::wptree& node)
209 return boost::rational<int>(
210 node.get<int>(L"numerator"), node.get<int>(L"denominator"));
213 void create_marks_from_comments(
214 const spl::shared_ptr<core::scene::scene_producer>& scene,
215 const core::video_format_desc& format_desc,
216 const boost::property_tree::wptree& comment_track)
218 auto keylist = comment_track.get_child_optional(L"keyList");
223 for (auto& key : *keylist)
225 auto time = get_rational(key.second.get_child(L"time"));
226 auto frame = get_frame_number(format_desc, time);
227 auto text = key.second.get<std::wstring>(L"animKey.Vl ");
228 std::vector<std::wstring> marks;
229 boost::split(marks, text, boost::is_any_of(","));
231 for (auto& mark : marks)
233 boost::trim_if(mark, [](wchar_t c) { return isspace(c) || c == 0; });
235 std::vector<std::wstring> args;
236 boost::split(args, mark, boost::is_any_of(" \t"), boost::algorithm::token_compress_on);
238 scene->add_mark(frame, core::scene::get_mark_action(args.at(0)), args.size() == 1 ? L"" : args.at(1));
244 const spl::shared_ptr<core::scene::scene_producer>& scene,
245 const core::video_format_desc& format_desc,
246 const boost::property_tree::wptree& global_timeline)
248 auto time = get_rational(global_timeline.get_child(L"duration"));
249 auto remove_at_frame = get_frame_number(format_desc, time);
251 scene->add_mark(remove_at_frame, core::scene::mark_action::remove, L"");
253 auto tracklist = global_timeline.get_child_optional(L"globalTrackList");
258 for (auto& track : *tracklist)
260 auto track_id = track.second.get<std::wstring>(L"stdTrackID");
262 if (track_id == L"globalCommentTrack")
263 create_marks_from_comments(scene, format_desc, track.second);
267 void create_timelines(
268 const spl::shared_ptr<core::scene::scene_producer>& scene,
269 const core::video_format_desc& format_desc,
270 core::scene::layer& layer,
271 const layer_ptr& psd_layer,
275 auto timeline = psd_layer->timeline_data();
276 auto start = get_rational(timeline.get_child(L"timeScope.Strt"));
277 auto end_offset = get_rational(timeline.get_child(L"timeScope.outTime"));
278 auto end = start + end_offset;
279 auto start_frame = get_frame_number(format_desc, start);
280 auto end_frame = get_frame_number(format_desc, end);
282 layer.hidden = scene->frame() < start_frame || scene->frame() > end_frame;
284 auto tracklist = timeline.get_child_optional(L"trackList");
289 double original_pos_x = psd_layer->location().x;
290 double original_pos_y = psd_layer->location().y;
292 for (auto& track : *tracklist)
294 auto track_id = track.second.get<std::wstring>(L"stdTrackID");
296 if (track_id == L"sheetPositionTrack")
298 for (auto& key : track.second.get_child(L"keyList"))
300 bool tween = key.second.get<std::wstring>(L"animInterpStyle")
302 auto time = get_rational(key.second.get_child(L"time"));
303 auto hrzn = key.second.get<double>(L"animKey.Hrzn");
304 auto vrtc = key.second.get<double>(L"animKey.Vrtc");
305 auto x = original_pos_x + hrzn + adjustment_x;
306 auto y = original_pos_y + vrtc + adjustment_y;
307 auto frame = get_frame_number(format_desc, time);
309 if (frame == 0) // Consider as initial value (rewind)
311 layer.position.x.set(x);
312 layer.position.y.set(y);
315 frame = start_frame + frame; // translate to global timeline
319 scene->add_keyframe(layer.position.x, x, frame, L"easeOutSine");
320 scene->add_keyframe(layer.position.y, y, frame, L"easeOutSine");
324 scene->add_keyframe(layer.position.x, x, frame);
325 scene->add_keyframe(layer.position.y, y, frame);
329 else if (track_id == L"opacityTrack")
331 auto& opacity = layer.adjustments.opacity;
333 for (auto& key : track.second.get_child(L"keyList"))
335 bool tween = key.second.get<std::wstring>(L"animInterpStyle")
337 auto time = get_rational(key.second.get_child(L"time"));
338 auto opct = key.second.get<double>(L"animKey.Opct.#Prc") / 100.0;
339 auto frame = get_frame_number(format_desc, time);
341 if (frame == 0) // Consider as initial value (rewind)
344 frame = start_frame + frame; // translate to global timeline
347 scene->add_keyframe(opacity, opct, frame, L"easeOutSine");
349 scene->add_keyframe(opacity, opct, frame);
355 spl::shared_ptr<core::frame_producer> create_psd_scene_producer(const core::frame_producer_dependencies& dependencies, const std::vector<std::wstring>& params)
357 std::wstring filename = env::template_folder() + params.at(0) + L".psd";
358 auto found_file = find_case_insensitive(filename);
361 return core::frame_producer::empty();
364 doc.parse(*found_file);
366 auto root = spl::make_shared<core::scene::scene_producer>(L"psd", doc.width(), doc.height(), dependencies.format_desc);
368 std::vector<std::pair<std::wstring, spl::shared_ptr<core::text_producer>>> text_producers_by_layer_name;
370 std::stack<dependency_resolver> scene_stack;
371 scene_stack.push(dependency_resolver{ root, true });
373 auto layers_end = doc.layers().rend();
374 for(auto it = doc.layers().rbegin(); it != layers_end; ++it)
376 auto& psd_layer = (*it);
377 auto& current = scene_stack.top();
379 if (psd_layer->group_mode() == layer_type::group) {
380 //we've found a group. Create a new scene and add it to the scene-stack
382 auto group = spl::make_shared<core::scene::scene_producer>(psd_layer->name(), doc.width(), doc.height(), dependencies.format_desc);
384 auto& scene_layer = current.scene()->create_layer(group, psd_layer->location().x, psd_layer->location().y, psd_layer->name());
385 scene_layer.adjustments.opacity.set(psd_layer->opacity() / 255.0);
386 scene_layer.hidden.set(!psd_layer->is_visible());
388 if (psd_layer->has_timeline())
389 create_timelines(root, dependencies.format_desc, scene_layer, psd_layer, 0, 0);
391 if (psd_layer->is_movable())
392 current.add(&scene_layer, psd_layer->tags(), 0, 0);
394 if (psd_layer->is_resizable())
395 CASPAR_LOG(warning) << "Groups doesn't support the \"resizable\"-tag.";
397 if (psd_layer->is_explicit_dynamic())
398 CASPAR_LOG(warning) << "Groups doesn't support the \"dynamic\"-tag.";
400 scene_stack.push(group);
403 else if (psd_layer->group_mode() == layer_type::group_delimiter) {
404 //a group-terminator. Finish the scene
405 current.scene()->reverse_layers();
411 if(psd_layer->is_visible())
413 auto layer_name = psd_layer->name();
415 if(psd_layer->is_text() && !psd_layer->is_static())
417 std::wstring str = psd_layer->text_data().get(L"EngineDict.Editor.Text", L"");
419 core::text::text_info text_info(std::move(get_text_info(psd_layer->text_data())));
420 text_info.size *= psd_layer->text_scale();
422 auto text_producer = core::text_producer::create(dependencies.frame_factory, 0, 0, str, text_info, doc.width(), doc.height());
423 text_producer->pixel_constraints().width.set(psd_layer->size().width);
424 text_producer->pixel_constraints().height.set(psd_layer->size().height);
425 core::text::string_metrics metrics = text_producer->measure_string(str);
427 auto adjustment_x = -2; //the 2 offset is just a hack for now. don't know why our text is rendered 2 px to the right of that in photoshop
428 auto adjustment_y = metrics.bearingY;
429 auto& scene_layer = current.scene()->create_layer(text_producer, psd_layer->location().x + adjustment_x, psd_layer->location().y + adjustment_y, layer_name);
430 scene_layer.adjustments.opacity.set(psd_layer->opacity() / 255.0);
431 scene_layer.hidden.set(!psd_layer->is_visible());
433 if (psd_layer->has_timeline())
434 create_timelines(root, dependencies.format_desc, scene_layer, psd_layer, adjustment_x, adjustment_y);
436 current.add(&scene_layer, psd_layer->tags(), -adjustment_x, -adjustment_y);
437 text_producers_by_layer_name.push_back(std::make_pair(layer_name, text_producer));
441 std::shared_ptr<core::frame_producer> layer_producer;
442 if(psd_layer->is_solid())
444 layer_producer = core::create_const_producer(core::create_color_frame(it->get(), dependencies.frame_factory, psd_layer->solid_color().to_uint32()), psd_layer->bitmap()->width(), psd_layer->bitmap()->height());
446 else if(psd_layer->bitmap())
448 if (psd_layer->is_placeholder())
450 auto hotswap = std::make_shared<core::hotswap_producer>(psd_layer->bitmap()->width(), psd_layer->bitmap()->height());
451 hotswap->producer().set(dependencies.producer_registry->create_producer(dependencies, layer_name));
452 layer_producer = hotswap;
456 core::pixel_format_desc pfd(core::pixel_format::bgra);
457 pfd.planes.push_back(core::pixel_format_desc::plane(psd_layer->bitmap()->width(), psd_layer->bitmap()->height(), 4));
459 auto frame = dependencies.frame_factory->create_frame(it->get(), pfd, core::audio_channel_layout::invalid());
460 auto destination = frame.image_data().data();
461 auto source = psd_layer->bitmap()->data();
462 memcpy(destination, source, frame.image_data().size());
464 layer_producer = core::create_const_producer(core::draw_frame(std::move(frame)), psd_layer->bitmap()->width(), psd_layer->bitmap()->height());
470 auto& scene_layer = current.scene()->create_layer(spl::make_shared_ptr(layer_producer), psd_layer->location().x, psd_layer->location().y, psd_layer->name());
471 scene_layer.adjustments.opacity.set(psd_layer->opacity() / 255.0);
472 scene_layer.hidden.set(!psd_layer->is_visible());
474 if (psd_layer->has_timeline())
475 create_timelines(root, dependencies.format_desc, scene_layer, psd_layer, 0, 0);
477 if(psd_layer->is_movable() || psd_layer->is_resizable())
478 current.add(&scene_layer, psd_layer->tags(), 0, 0);
483 if (scene_stack.size() != 1) {
486 root->reverse_layers();
487 scene_stack.top().calculate();
490 // Reset all dynamic text fields to empty strings and expose them as a scene parameter.
491 for (auto& text_layer : text_producers_by_layer_name)
492 text_layer.second->text().bind(root->create_variable<std::wstring>(boost::to_lower_copy(text_layer.first), true, L""));
494 if (doc.has_timeline())
495 create_marks(root, dependencies.format_desc, doc.timeline());
497 auto params2 = params;
498 params2.erase(params2.begin());
505 void init(core::module_dependencies dependencies)
507 dependencies.cg_registry->register_cg_producer(
510 [](const std::wstring& filename) { return ""; },
511 [](const spl::shared_ptr<core::frame_producer>& producer)
513 return spl::make_shared<core::scene::scene_cg_proxy>(producer);
516 const core::frame_producer_dependencies& dependencies,
517 const std::wstring& filename)
519 return create_psd_scene_producer(dependencies, { filename });