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