]> git.sesse.net Git - casparcg/blob - modules/psd/psd_scene_producer.cpp
* psd: support for extracting scaling-data of text-layer, and extracting sheet-color...
[casparcg] / modules / psd / psd_scene_producer.cpp
1 /*
2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
3 *
4 * This file is part of CasparCG (www.casparcg.com).
5 *
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.
10 *
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.
15 *
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/>.
18 *
19 * Author: Niklas P Andersson, niklas.p.andersson@svt.se
20 */
21
22 #include "psd_scene_producer.h"
23 #include "layer.h"
24 #include "doc.h"
25
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_producer.h>
32 #include <core/producer/scene/const_producer.h>
33 #include <core/producer/scene/hotswap_producer.h>
34 #include <core/frame/draw_frame.h>
35
36 #include <common/env.h>
37 #include <common/memory.h>
38 #include <common/log.h>
39
40 #include <boost/filesystem.hpp>
41 #include <boost/foreach.hpp>
42 #include <boost/thread/future.hpp>
43 #include <boost/algorithm/string.hpp>
44 #include <boost/rational.hpp>
45
46 namespace caspar { namespace psd {
47
48 void init()
49 {
50         core::register_producer_factory(create_psd_scene_producer);
51 }
52
53 core::text::text_info get_text_info(const boost::property_tree::wptree& ptree)
54 {
55         core::text::text_info result;
56         int font_index = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.Font", 0);
57         result.size = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.FontSize", 30.0f);
58         //result.leading = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.Leading", 0);
59         //result.tracking = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.Tracking", 0);
60         //result.baselineshift = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.BaselineShift", 0);
61         //result.kerning = ptree.get(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.Kerning", 0);
62
63         int child_index = 0;
64         auto color_node = ptree.get_child(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.FillColor.Values");
65         for(auto it = color_node.begin(); it != color_node.end(); ++it, ++child_index)
66         {
67                 auto& value_node = (*it).second;
68                 float value = value_node.get_value(0.0f);
69                 switch(child_index)
70                 {
71                 case 0: result.color.a = value; break;
72                 case 1: result.color.r = value; break;
73                 case 2: result.color.g = value; break;
74                 case 3: result.color.b = value; break;
75                 }
76         }
77
78         //find fontname
79         child_index = 0;
80         auto fontset_node = ptree.get_child(L"ResourceDict.FontSet");
81         for(auto it = fontset_node.begin(); it != fontset_node.end(); ++it, ++child_index)
82         {
83                 auto& font_node = (*it).second;
84                 if(child_index == font_index)
85                 {
86                         result.font = font_node.get(L"Name", L"");
87                         break;
88                 }
89         }
90
91         return result;
92 }
93
94         class layer_link_constructor
95         {
96                 struct linked_layer_record
97                 {
98                         caspar::core::scene::layer* layer;
99                         int link_id;
100                         bool is_master;
101                         double adjustment_x;
102                         double adjustment_y;
103                 };
104
105                 std::vector<linked_layer_record> layers;
106                 std::vector<linked_layer_record> masters;
107
108         public:
109                 void add(caspar::core::scene::layer* layer, int link_group, bool master, double adjustment_x, double adjustment_y)
110                 {
111                         linked_layer_record rec;
112                         rec.layer = layer;
113                         rec.link_id = link_group;
114                         rec.is_master = master;
115                         rec.adjustment_x = adjustment_x;
116                         rec.adjustment_y = adjustment_y;
117                         layers.push_back(rec);
118
119                         if(rec.is_master)
120                         {
121                                 auto it = std::find_if(masters.begin(), masters.end(), [=](linked_layer_record const &r){ return r.link_id == link_group; });
122                                 if(it == masters.end())
123                                         masters.push_back(rec);
124                                 else
125                                         masters.erase(it);      //ambigous, two linked layers with locked position
126                         }
127                 }
128
129                 void calculate()
130                 {
131                         for(auto it = masters.begin(); it != masters.end(); ++it)
132                         {
133                                 auto& master = (*it);
134                                 //std::for_each(layers.begin(), layers.end(), [&master](linked_layer_record &r) mutable { 
135                                 BOOST_FOREACH(auto &r, layers) {
136                                         if(r.link_id == master.link_id && r.layer != master.layer)
137                                         {
138                                                 {       //x-coords
139                                                         double slave_left = r.layer->position.x.get() + r.adjustment_x;
140                                                         double slave_right = slave_left + r.layer->producer.get()->pixel_constraints().width.get();
141
142                                                         double master_left = master.layer->position.x.get() + master.adjustment_x;
143                                                         double master_right = master_left + master.layer->producer.get()->pixel_constraints().width.get();
144
145                                                         if((slave_left >= master_left && slave_right <= master_right) || (slave_left <= master_left && slave_right >= master_right))
146                                                         {
147                                                                 //change width of slave
148                                                                 r.layer->position.x.bind(master.layer->position.x - r.adjustment_x + master.adjustment_x + (slave_left - master_left));
149                                                                 r.layer->producer.get()->pixel_constraints().width.bind(master.layer->producer.get()->pixel_constraints().width + (slave_right - slave_left - master_right + master_left)); 
150                                                         }
151                                                         else if(slave_left >= master_right)
152                                                         {
153                                                                 //push slave ahead of master
154                                                                 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));
155                                                         }
156                                                         else if(slave_right <= master_left)
157                                                         {
158                                                                 r.layer->position.x.bind(master.layer->position.x - r.adjustment_x + master.adjustment_x - (master_left - slave_left));
159                                                         }
160                                                 }
161
162                                                 {       //y-coords
163                                                         double slave_top = r.layer->position.y.get() + r.adjustment_y;
164                                                         double slave_bottom = slave_top + r.layer->producer.get()->pixel_constraints().height.get();
165
166                                                         double master_top = master.layer->position.y.get() + master.adjustment_y;
167                                                         double master_bottom = master_top + master.layer->producer.get()->pixel_constraints().height.get();
168
169                                                         if((slave_top >= master_top && slave_bottom <= master_bottom) || (slave_top <= master_top && slave_bottom >= master_bottom))
170                                                         {
171                                                                 //change height of slave
172                                                                 r.layer->position.y.bind(master.layer->position.y - r.adjustment_y + master.adjustment_y + (slave_top - master_top));
173                                                                 r.layer->producer.get()->pixel_constraints().height.bind(master.layer->producer.get()->pixel_constraints().height + (slave_bottom - slave_top - master_bottom + master_top)); 
174                                                         }
175                                                         else if(slave_top >= master_bottom)
176                                                         {
177                                                                 //push slave ahead of master
178                                                                 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));
179                                                         }
180                                                         else if(slave_bottom <= master_top)
181                                                         {
182                                                                 r.layer->position.y.bind(master.layer->position.y - r.adjustment_y + master.adjustment_y - (master_top - slave_top));
183                                                         }
184                                                 }
185
186                                         }
187                                 }
188                         }
189                 }
190         };
191
192 int64_t get_frame_number(
193                 const core::video_format_desc& format_desc,
194                 const boost::rational<int>& at_second)
195 {
196         return static_cast<int64_t>(
197                         boost::rational_cast<double>(at_second) * format_desc.fps);
198 }
199
200 boost::rational<int> get_rational(const boost::property_tree::wptree& node)
201 {
202         return boost::rational<int>(
203                         node.get<int>(L"numerator"), node.get<int>(L"denominator"));
204 }
205
206 void create_timelines(
207                 const spl::shared_ptr<core::scene::scene_producer>& scene,
208                 const core::video_format_desc& format_desc,
209                 core::scene::layer& layer,
210                 const layer_ptr& psd_layer,
211                 double adjustment_x,
212                 double adjustment_y)
213 {
214         auto timeline = psd_layer->timeline_data();
215         auto start = get_rational(timeline.get_child(L"timeScope.Strt"));
216         auto end_offset = get_rational(timeline.get_child(L"timeScope.outTime"));
217         auto end = start + end_offset;
218         auto start_frame = get_frame_number(format_desc, start);
219         auto end_frame = get_frame_number(format_desc, end);
220
221         layer.hidden = scene->frame() < start_frame || scene->frame() > end_frame;
222
223         auto tracklist = timeline.get_child_optional(L"trackList");
224
225         if (!tracklist)
226                 return;
227
228         double original_pos_x = psd_layer->location().x;
229         double original_pos_y = psd_layer->location().y;
230
231         BOOST_FOREACH(auto& track, *tracklist)
232         {
233                 auto track_id = track.second.get<std::wstring>(L"stdTrackID");
234
235                 if (track_id == L"sheetPositionTrack")
236                 {
237                         BOOST_FOREACH(auto& key, track.second.get_child(L"keyList"))
238                         {
239                                 bool tween = key.second.get<std::wstring>(L"animInterpStyle")
240                                                 == L"Lnr ";
241                                 auto time = get_rational(key.second.get_child(L"time"));
242                                 auto hrzn = key.second.get<double>(L"animKey.Hrzn");
243                                 auto vrtc = key.second.get<double>(L"animKey.Vrtc");
244                                 auto x = original_pos_x + hrzn + adjustment_x;
245                                 auto y = original_pos_y + vrtc + adjustment_y;
246                                 auto frame = get_frame_number(format_desc, time);
247
248                                 if (frame == 0) // Consider as initial value (rewind)
249                                 {
250                                         layer.position.x.set(x);
251                                         layer.position.y.set(y);
252                                 }
253
254                                 frame = start_frame + frame; // translate to global timeline
255
256                                 if (tween)
257                                 {
258                                         scene->add_keyframe(layer.position.x, x, frame, L"easeOutSine");
259                                         scene->add_keyframe(layer.position.y, y, frame, L"easeOutSine");
260                                 }
261                                 else
262                                 {
263                                         scene->add_keyframe(layer.position.x, x, frame);
264                                         scene->add_keyframe(layer.position.y, y, frame);
265                                 }
266                         }
267                 }
268                 else if (track_id == L"opacityTrack")
269                 {
270                         auto& opacity = layer.adjustments.opacity;
271
272                         BOOST_FOREACH(auto& key, track.second.get_child(L"keyList"))
273                         {
274                                 bool tween = key.second.get<std::wstring>(L"animInterpStyle")
275                                                 == L"Lnr ";
276                                 auto time = get_rational(key.second.get_child(L"time"));
277                                 auto opct = key.second.get<double>(L"animKey.Opct.#Prc") / 100.0;
278                                 auto frame = get_frame_number(format_desc, time);
279
280                                 if (frame == 0) // Consider as initial value (rewind)
281                                         opacity.set(opct);
282
283                                 frame = start_frame + frame; // translate to global timeline
284
285                                 if (tween)
286                                         scene->add_keyframe(opacity, opct, frame, L"easeOutSine");
287                                 else
288                                         scene->add_keyframe(opacity, opct, frame);
289                         }
290                 }
291         }
292 }
293
294 spl::shared_ptr<core::frame_producer> create_psd_scene_producer(const spl::shared_ptr<core::frame_factory>& frame_factory, const core::video_format_desc& format_desc, const std::vector<std::wstring>& params)
295 {
296         std::wstring filename = env::media_folder() + L"\\" + params[0] + L".psd";
297         if(!boost::filesystem::is_regular_file(boost::filesystem::path(filename)))
298                 return core::frame_producer::empty();
299
300         psd_document doc;
301         if(!doc.parse(filename))
302                 return core::frame_producer::empty();
303
304         spl::shared_ptr<core::scene::scene_producer> root(spl::make_shared<core::scene::scene_producer>(doc.width(), doc.height()));
305
306         layer_link_constructor link_constructor;
307
308         std::vector<std::pair<std::wstring, spl::shared_ptr<core::text_producer>>> text_producers_by_layer_name;
309
310         auto layers_end = doc.layers().end();
311         for(auto it = doc.layers().begin(); it != layers_end; ++it)
312         {
313                 if((*it)->is_visible())
314                 {
315                         if((*it)->is_text())
316                         {
317                                 std::wstring str = (*it)->text_data().get(L"EngineDict.Editor.Text", L"");
318                         
319                                 core::text::text_info text_info(std::move(get_text_info((*it)->text_data())));
320                                 auto text_producer = core::text_producer::create(frame_factory, 0, 0, str, text_info, doc.width(), doc.height());
321                         
322                                 core::text::string_metrics metrics = text_producer->measure_string(str);
323                         
324                                 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
325                                 auto adjustment_y = metrics.bearingY;
326                                 auto& new_layer = root->create_layer(text_producer, (*it)->location().x + adjustment_x, (*it)->location().y + adjustment_y, (*it)->name());     
327                                 new_layer.adjustments.opacity.set((*it)->opacity() / 255.0);
328                                 new_layer.hidden.set(!(*it)->is_visible());
329
330                                 if ((*it)->has_timeline())
331                                         create_timelines(root, format_desc, new_layer, (*it), adjustment_x, adjustment_y);
332
333                                 if((*it)->link_group_id() != 0)
334                                         link_constructor.add(&new_layer, (*it)->link_group_id(), (*it)->is_position_protected(), -adjustment_x, -adjustment_y);
335
336                                 text_producers_by_layer_name.push_back(std::make_pair((*it)->name(), text_producer));
337                         }
338                         else
339                         {
340                                 std::wstring layer_name = (*it)->name();
341                                 std::shared_ptr<core::frame_producer> layer_producer;
342                                 if((*it)->is_solid())
343                                 {
344                                         layer_producer = layer_producer = core::create_const_producer(core::create_color_frame(it->get(), frame_factory, (*it)->solid_color().to_uint32()), (*it)->bitmap()->width(), (*it)->bitmap()->height());
345                                 }
346                                 else if((*it)->bitmap())
347                                 {
348                                         /*if (boost::algorithm::istarts_with(layer_name, L"[producer]"))
349                                         {
350                                                 auto hotswap = std::make_shared<core::hotswap_producer>((*it)->rect().width(), (*it)->rect().height());
351                                                 hotswap->producer().set(core::create_producer(frame_factory, format_desc, layer_name.substr(10)));
352                                                 layer_producer = hotswap;
353                                         }
354                                         else*/
355                                         {
356                                                 core::pixel_format_desc pfd(core::pixel_format::bgra);
357                                                 pfd.planes.push_back(core::pixel_format_desc::plane((*it)->bitmap()->width(), (*it)->bitmap()->height(), 4));
358
359                                                 auto frame = frame_factory->create_frame(it->get(), pfd);
360                                                 memcpy(frame.image_data().data(), (*it)->bitmap()->data(), frame.image_data().size());
361
362                                                 layer_producer = core::create_const_producer(core::draw_frame(std::move(frame)), (*it)->bitmap()->width(), (*it)->bitmap()->height());
363                                         }
364                                 }
365
366                                 if(layer_producer)
367                                 {
368                                         auto& new_layer = root->create_layer(spl::make_shared_ptr(layer_producer), (*it)->location().x, (*it)->location().y, (*it)->name());
369                                         new_layer.adjustments.opacity.set((*it)->opacity() / 255.0);
370                                         new_layer.hidden.set(!(*it)->is_visible());
371
372                                         if ((*it)->has_timeline())
373                                                 create_timelines(root, format_desc, new_layer, (*it), 0, 0);
374
375                                         if((*it)->link_group_id() != 0)
376                                                 link_constructor.add(&new_layer, (*it)->link_group_id(), (*it)->is_position_protected(), 0, 0);
377                                 }
378                         }
379                 }
380         }
381
382         link_constructor.calculate();
383
384         // Reset all dynamic text fields to empty strings and expose them as a scene parameter.
385         BOOST_FOREACH(auto& text_layer, text_producers_by_layer_name)
386                 text_layer.second->text().bind(root->create_variable<std::wstring>(boost::to_lower_copy(text_layer.first), true, L""));
387
388         auto params2 = params;
389         params2.erase(params2.cbegin());
390
391         root->call(params2);
392
393         return root;
394 }
395
396 }}