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/producer/frame_producer.h>
29 #include <core/producer/color/color_producer.h>
30 #include <core/producer/text/text_producer.h>
31 #include <core/producer/scene/scene_cg_proxy.h>
32 #include <core/producer/scene/scene_producer.h>
33 #include <core/producer/scene/const_producer.h>
34 #include <core/producer/scene/hotswap_producer.h>
35 #include <core/producer/media_info/media_info.h>
36 #include <core/frame/draw_frame.h>
37 #include <core/help/help_repository.h>
38 #include <core/help/help_sink.h>
40 #include <common/env.h>
41 #include <common/memory.h>
42 #include <common/log.h>
43 #include <common/os/filesystem.h>
45 #include <boost/filesystem.hpp>
46 #include <boost/thread/future.hpp>
47 #include <boost/algorithm/string.hpp>
48 #include <boost/rational.hpp>
52 namespace caspar { namespace psd {
54 core::text::text_info get_text_info(const boost::property_tree::wptree& ptree)
56 core::text::text_info result;
57 int font_index = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.Font", 0);
58 result.size = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.FontSize", 30.0f);
59 //result.leading = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.Leading", 0);
60 result.tracking = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.Tracking", 0);
61 result.baseline_shift = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.BaselineShift", 0);
62 //result.kerning = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.Kerning", 0);
65 auto color_node = ptree.get_child(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.FillColor.Values");
66 for(auto it = color_node.begin(); it != color_node.end(); ++it, ++child_index)
68 auto& value_node = (*it).second;
69 float value = value_node.get_value(0.0f);
72 case 0: result.color.a = value; break;
73 case 1: result.color.r = value; break;
74 case 2: result.color.g = value; break;
75 case 3: result.color.b = value; break;
81 auto fontset_node = ptree.get_child(L"ResourceDict.FontSet");
82 for(auto it = fontset_node.begin(); it != fontset_node.end(); ++it, ++child_index)
84 auto& font_node = (*it).second;
85 if(child_index == font_index)
87 result.font = font_node.get(L"Name", L"");
96 class layer_link_constructor
98 struct linked_layer_record
100 caspar::core::scene::layer* layer;
107 std::vector<linked_layer_record> layers;
108 std::vector<linked_layer_record> masters;
111 void add(caspar::core::scene::layer* layer, int link_group, bool master, double adjustment_x, double adjustment_y)
113 linked_layer_record rec;
115 rec.link_id = link_group;
116 rec.is_master = master;
117 rec.adjustment_x = adjustment_x;
118 rec.adjustment_y = adjustment_y;
119 layers.push_back(rec);
123 auto it = std::find_if(masters.begin(), masters.end(), [=](linked_layer_record const &r){ return r.link_id == link_group; });
124 if(it == masters.end())
125 masters.push_back(rec);
127 masters.erase(it); //ambigous, two linked layers with locked position
133 for(auto it = masters.begin(); it != masters.end(); ++it)
135 auto& master = (*it);
136 //std::for_each(layers.begin(), layers.end(), [&master](linked_layer_record &r) mutable {
137 for (auto &r : layers) {
138 if(r.link_id == master.link_id && r.layer != master.layer)
141 double slave_left = r.layer->position.x.get() + r.adjustment_x;
142 double slave_right = slave_left + r.layer->producer.get()->pixel_constraints().width.get();
144 double master_left = master.layer->position.x.get() + master.adjustment_x;
145 double master_right = master_left + master.layer->producer.get()->pixel_constraints().width.get();
147 if((slave_left >= master_left && slave_right <= master_right) || (slave_left <= master_left && slave_right >= master_right))
149 //change width of slave
150 r.layer->position.x.bind(master.layer->position.x - r.adjustment_x + master.adjustment_x + (slave_left - master_left));
151 r.layer->producer.get()->pixel_constraints().width.bind(master.layer->producer.get()->pixel_constraints().width + (slave_right - slave_left - master_right + master_left));
153 else if(slave_left >= master_right)
155 //push slave ahead of master
156 r.layer->position.x.bind(master.layer->position.x - r.adjustment_x + master.adjustment_x + master.layer->producer.get()->pixel_constraints().width + (slave_left - master_right));
158 else if(slave_right <= master_left)
160 r.layer->position.x.bind(master.layer->position.x - r.adjustment_x + master.adjustment_x - (master_left - slave_left));
165 double slave_top = r.layer->position.y.get() + r.adjustment_y;
166 double slave_bottom = slave_top + r.layer->producer.get()->pixel_constraints().height.get();
168 double master_top = master.layer->position.y.get() + master.adjustment_y;
169 double master_bottom = master_top + master.layer->producer.get()->pixel_constraints().height.get();
171 if((slave_top >= master_top && slave_bottom <= master_bottom) || (slave_top <= master_top && slave_bottom >= master_bottom))
173 //change height of slave
174 r.layer->position.y.bind(master.layer->position.y - r.adjustment_y + master.adjustment_y + (slave_top - master_top));
175 r.layer->producer.get()->pixel_constraints().height.bind(master.layer->producer.get()->pixel_constraints().height + (slave_bottom - slave_top - master_bottom + master_top));
177 else if(slave_top >= master_bottom)
179 //push slave ahead of master
180 r.layer->position.y.bind(master.layer->position.y - r.adjustment_y + master.adjustment_y + master.layer->producer.get()->pixel_constraints().height + (slave_top - master_bottom));
182 else if(slave_bottom <= master_top)
184 r.layer->position.y.bind(master.layer->position.y - r.adjustment_y + master.adjustment_y - (master_top - slave_top));
194 int64_t get_frame_number(
195 const core::video_format_desc& format_desc,
196 const boost::rational<int>& at_second)
198 return static_cast<int64_t>(
199 boost::rational_cast<double>(at_second) * format_desc.fps);
202 boost::rational<int> get_rational(const boost::property_tree::wptree& node)
204 return boost::rational<int>(
205 node.get<int>(L"numerator"), node.get<int>(L"denominator"));
208 void create_marks_from_comments(
209 const spl::shared_ptr<core::scene::scene_producer>& scene,
210 const core::video_format_desc& format_desc,
211 const boost::property_tree::wptree& comment_track)
213 auto keylist = comment_track.get_child_optional(L"keyList");
218 for (auto& key : *keylist)
220 auto time = get_rational(key.second.get_child(L"time"));
221 auto frame = get_frame_number(format_desc, time);
222 auto text = key.second.get<std::wstring>(L"animKey.Vl ");
223 std::vector<std::wstring> marks;
224 boost::split(marks, text, boost::is_any_of(","));
226 for (auto& mark : marks)
228 boost::trim_if(mark, [](wchar_t c) { return isspace(c) || c == 0; });
230 std::vector<std::wstring> args;
231 boost::split(args, mark, boost::is_any_of(" \t"), boost::algorithm::token_compress_on);
233 scene->add_mark(frame, core::scene::get_mark_action(args.at(0)), args.size() == 1 ? L"" : args.at(1));
239 const spl::shared_ptr<core::scene::scene_producer>& scene,
240 const core::video_format_desc& format_desc,
241 const boost::property_tree::wptree& global_timeline)
243 auto time = get_rational(global_timeline.get_child(L"duration"));
244 auto remove_at_frame = get_frame_number(format_desc, time);
246 scene->add_mark(remove_at_frame, core::scene::mark_action::remove, L"");
248 auto tracklist = global_timeline.get_child_optional(L"globalTrackList");
253 for (auto& track : *tracklist)
255 auto track_id = track.second.get<std::wstring>(L"stdTrackID");
257 if (track_id == L"globalCommentTrack")
258 create_marks_from_comments(scene, format_desc, track.second);
262 void create_timelines(
263 const spl::shared_ptr<core::scene::scene_producer>& scene,
264 const core::video_format_desc& format_desc,
265 core::scene::layer& layer,
266 const layer_ptr& psd_layer,
270 auto timeline = psd_layer->timeline_data();
271 auto start = get_rational(timeline.get_child(L"timeScope.Strt"));
272 auto end_offset = get_rational(timeline.get_child(L"timeScope.outTime"));
273 auto end = start + end_offset;
274 auto start_frame = get_frame_number(format_desc, start);
275 auto end_frame = get_frame_number(format_desc, end);
277 layer.hidden = scene->frame() < start_frame || scene->frame() > end_frame;
279 auto tracklist = timeline.get_child_optional(L"trackList");
284 double original_pos_x = psd_layer->location().x;
285 double original_pos_y = psd_layer->location().y;
287 for (auto& track : *tracklist)
289 auto track_id = track.second.get<std::wstring>(L"stdTrackID");
291 if (track_id == L"sheetPositionTrack")
293 for (auto& key : track.second.get_child(L"keyList"))
295 bool tween = key.second.get<std::wstring>(L"animInterpStyle")
297 auto time = get_rational(key.second.get_child(L"time"));
298 auto hrzn = key.second.get<double>(L"animKey.Hrzn");
299 auto vrtc = key.second.get<double>(L"animKey.Vrtc");
300 auto x = original_pos_x + hrzn + adjustment_x;
301 auto y = original_pos_y + vrtc + adjustment_y;
302 auto frame = get_frame_number(format_desc, time);
304 if (frame == 0) // Consider as initial value (rewind)
306 layer.position.x.set(x);
307 layer.position.y.set(y);
310 frame = start_frame + frame; // translate to global timeline
314 scene->add_keyframe(layer.position.x, x, frame, L"easeOutSine");
315 scene->add_keyframe(layer.position.y, y, frame, L"easeOutSine");
319 scene->add_keyframe(layer.position.x, x, frame);
320 scene->add_keyframe(layer.position.y, y, frame);
324 else if (track_id == L"opacityTrack")
326 auto& opacity = layer.adjustments.opacity;
328 for (auto& key : track.second.get_child(L"keyList"))
330 bool tween = key.second.get<std::wstring>(L"animInterpStyle")
332 auto time = get_rational(key.second.get_child(L"time"));
333 auto opct = key.second.get<double>(L"animKey.Opct.#Prc") / 100.0;
334 auto frame = get_frame_number(format_desc, time);
336 if (frame == 0) // Consider as initial value (rewind)
339 frame = start_frame + frame; // translate to global timeline
342 scene->add_keyframe(opacity, opct, frame, L"easeOutSine");
344 scene->add_keyframe(opacity, opct, frame);
350 spl::shared_ptr<core::frame_producer> create_psd_scene_producer(const core::frame_producer_dependencies& dependencies, const std::vector<std::wstring>& params)
352 std::wstring filename = env::template_folder() + params.at(0) + L".psd";
353 auto found_file = find_case_insensitive(filename);
356 return core::frame_producer::empty();
359 doc.parse(*found_file);
361 spl::shared_ptr<core::scene::scene_producer> root(spl::make_shared<core::scene::scene_producer>(doc.width(), doc.height(), dependencies.format_desc));
363 layer_link_constructor link_constructor;
365 std::vector<std::pair<std::wstring, spl::shared_ptr<core::text_producer>>> text_producers_by_layer_name;
367 auto layers_end = doc.layers().end();
368 for(auto it = doc.layers().begin(); it != layers_end; ++it)
370 if((*it)->is_visible())
372 if((*it)->is_text() && (*it)->sheet_color() == 4)
374 std::wstring str = (*it)->text_data().get(L"EngineDict.Editor.Text", L"");
376 core::text::text_info text_info(std::move(get_text_info((*it)->text_data())));
377 text_info.size *= (*it)->text_scale();
379 auto text_producer = core::text_producer::create(dependencies.frame_factory, 0, 0, str, text_info, doc.width(), doc.height());
381 core::text::string_metrics metrics = text_producer->measure_string(str);
383 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
384 auto adjustment_y = metrics.bearingY;
385 auto& new_layer = root->create_layer(text_producer, (*it)->location().x + adjustment_x, (*it)->location().y + adjustment_y, (*it)->name());
386 new_layer.adjustments.opacity.set((*it)->opacity() / 255.0);
387 new_layer.hidden.set(!(*it)->is_visible());
389 if ((*it)->has_timeline())
390 create_timelines(root, dependencies.format_desc, new_layer, (*it), adjustment_x, adjustment_y);
392 if((*it)->link_group_id() != 0)
393 link_constructor.add(&new_layer, (*it)->link_group_id(), (*it)->is_position_protected(), -adjustment_x, -adjustment_y);
395 text_producers_by_layer_name.push_back(std::make_pair((*it)->name(), text_producer));
399 std::wstring layer_name = (*it)->name();
400 std::shared_ptr<core::frame_producer> layer_producer;
401 if((*it)->is_solid())
403 layer_producer = core::create_const_producer(core::create_color_frame(it->get(), dependencies.frame_factory, (*it)->solid_color().to_uint32()), (*it)->bitmap()->width(), (*it)->bitmap()->height());
405 else if((*it)->bitmap())
407 if (boost::algorithm::istarts_with(layer_name, L"[producer]"))
409 auto hotswap = std::make_shared<core::hotswap_producer>((*it)->bitmap()->width(), (*it)->bitmap()->height());
410 hotswap->producer().set(dependencies.producer_registry->create_producer(dependencies, layer_name.substr(10)));
411 layer_producer = hotswap;
415 core::pixel_format_desc pfd(core::pixel_format::bgra);
416 pfd.planes.push_back(core::pixel_format_desc::plane((*it)->bitmap()->width(), (*it)->bitmap()->height(), 4));
418 auto frame = dependencies.frame_factory->create_frame(it->get(), pfd);
419 memcpy(frame.image_data().data(), (*it)->bitmap()->data(), frame.image_data().size());
421 layer_producer = core::create_const_producer(core::draw_frame(std::move(frame)), (*it)->bitmap()->width(), (*it)->bitmap()->height());
427 auto& new_layer = root->create_layer(spl::make_shared_ptr(layer_producer), (*it)->location().x, (*it)->location().y, (*it)->name());
428 new_layer.adjustments.opacity.set((*it)->opacity() / 255.0);
429 new_layer.hidden.set(!(*it)->is_visible());
431 if ((*it)->has_timeline())
432 create_timelines(root, dependencies.format_desc, new_layer, (*it), 0, 0);
434 if((*it)->link_group_id() != 0)
435 link_constructor.add(&new_layer, (*it)->link_group_id(), (*it)->is_position_protected(), 0, 0);
441 link_constructor.calculate();
443 // Reset all dynamic text fields to empty strings and expose them as a scene parameter.
444 for (auto& text_layer : text_producers_by_layer_name)
445 text_layer.second->text().bind(root->create_variable<std::wstring>(boost::to_lower_copy(text_layer.first), true, L""));
447 if (doc.has_timeline())
448 create_marks(root, dependencies.format_desc, doc.timeline());
450 auto params2 = params;
451 params2.erase(params2.begin());
458 void init(core::module_dependencies dependencies)
460 dependencies.cg_registry->register_cg_producer(
463 [](const std::wstring& filename) { return ""; },
464 [](const spl::shared_ptr<core::frame_producer>& producer)
466 return spl::make_shared<core::scene::scene_cg_proxy>(producer);
469 const core::frame_producer_dependencies& dependencies,
470 const std::wstring& filename)
472 return create_psd_scene_producer(dependencies, { filename });