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/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>
  40
  41 #include <common/env.h>
  42 #include <common/memory.h>
  43 #include <common/log.h>
  44 #include <common/os/filesystem.h>
  45
  46 #include <boost/filesystem.hpp>
  47 #include <boost/thread/future.hpp>
  48 #include <boost/algorithm/string.hpp>
  49 #include <boost/rational.hpp>
  50
  51 #include <future>
  52
  53 namespace caspar { namespace psd {
  54
  55 core::text::text_info get_text_info(const boost::property_tree::wptree& ptree)
  56 {
  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);
  64
  65         int child_index = 0;
  66         auto color_node = ptree.get_child_optional(L"EngineDict.StyleRun.RunArray..StyleSheet.StyleSheetData.FillColor.Values");
  67
  68         if (color_node)
  69         {
  70                 for(auto it = color_node->begin(); it != color_node->end(); ++it, ++child_index)
  71                 {
  72                         auto& value_node = (*it).second;
  73                         float value = value_node.get_value(0.0f);
  74                         switch(child_index)
  75                         {
  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;
  80                         }
  81                 }
  82         }
  83
  84         //find fontname
  85         child_index = 0;
  86         auto fontset_node = ptree.get_child(L"ResourceDict.FontSet");
  87         for(auto it = fontset_node.begin(); it != fontset_node.end(); ++it, ++child_index)
  88         {
  89                 auto& font_node = (*it).second;
  90                 if(child_index == font_index)
  91                 {
  92                         result.font = font_node.get(L"Name", L"");
  93                         break;
  94                 }
  95         }
  96
  97         return result;
  98 }
  99
 100
 101         class layer_link_constructor
 102         {
 103                 struct linked_layer_record
 104                 {
 105                         caspar::core::scene::layer* layer;
 106                         int link_id;
 107                         bool is_master;
 108                         double adjustment_x;
 109                         double adjustment_y;
 110                 };
 111
 112                 std::vector<linked_layer_record> layers;
 113                 std::vector<linked_layer_record> masters;
 114
 115         public:
 116                 void add(caspar::core::scene::layer* layer, int link_group, bool master, double adjustment_x, double adjustment_y)
 117                 {
 118                         linked_layer_record rec;
 119                         rec.layer = layer;
 120                         rec.link_id = link_group;
 121                         rec.is_master = master;
 122                         rec.adjustment_x = adjustment_x;
 123                         rec.adjustment_y = adjustment_y;
 124                         layers.push_back(rec);
 125
 126                         if(rec.is_master)
 127                         {
 128                                 auto it = std::find_if(masters.begin(), masters.end(), [=](linked_layer_record const &r){ return r.link_id == link_group; });
 129                                 if(it == masters.end())
 130                                         masters.push_back(rec);
 131                                 else
 132                                         masters.erase(it);      //ambigous, two linked layers with locked position
 133                         }
 134                 }
 135
 136                 void calculate()
 137                 {
 138                         for(auto it = masters.begin(); it != masters.end(); ++it)
 139                         {
 140                                 auto& master = (*it);
 141                                 //std::for_each(layers.begin(), layers.end(), [&master](linked_layer_record &r) mutable {
 142                                 for (auto &r : layers) {
 143                                         if(r.link_id == master.link_id && r.layer != master.layer)
 144                                         {
 145                                                 {       //x-coords
 146                                                         double slave_left = r.layer->position.x.get() + r.adjustment_x;
 147                                                         double slave_right = slave_left + r.layer->producer.get()->pixel_constraints().width.get();
 148
 149                                                         double master_left = master.layer->position.x.get() + master.adjustment_x;
 150                                                         double master_right = master_left + master.layer->producer.get()->pixel_constraints().width.get();
 151
 152                                                         if((slave_left >= master_left && slave_right <= master_right) || (slave_left <= master_left && slave_right >= master_right))
 153                                                         {
 154                                                                 //change width of slave
 155                                                                 r.layer->position.x.bind(master.layer->position.x - r.adjustment_x + master.adjustment_x + (slave_left - master_left));
 156                                                                 r.layer->producer.get()->pixel_constraints().width.bind(master.layer->producer.get()->pixel_constraints().width + (slave_right - slave_left - master_right + master_left));
 157                                                         }
 158                                                         else if(slave_left >= master_right)
 159                                                         {
 160                                                                 //push slave ahead of master
 161                                                                 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));
 162                                                         }
 163                                                         else if(slave_right <= master_left)
 164                                                         {
 165                                                                 r.layer->position.x.bind(master.layer->position.x - r.adjustment_x + master.adjustment_x - (master_left - slave_left));
 166                                                         }
 167                                                 }
 168
 169                                                 {       //y-coords
 170                                                         double slave_top = r.layer->position.y.get() + r.adjustment_y;
 171                                                         double slave_bottom = slave_top + r.layer->producer.get()->pixel_constraints().height.get();
 172
 173                                                         double master_top = master.layer->position.y.get() + master.adjustment_y;
 174                                                         double master_bottom = master_top + master.layer->producer.get()->pixel_constraints().height.get();
 175
 176                                                         if((slave_top >= master_top && slave_bottom <= master_bottom) || (slave_top <= master_top && slave_bottom >= master_bottom))
 177                                                         {
 178                                                                 //change height of slave
 179                                                                 r.layer->position.y.bind(master.layer->position.y - r.adjustment_y + master.adjustment_y + (slave_top - master_top));
 180                                                                 r.layer->producer.get()->pixel_constraints().height.bind(master.layer->producer.get()->pixel_constraints().height + (slave_bottom - slave_top - master_bottom + master_top));
 181                                                         }
 182                                                         else if(slave_top >= master_bottom)
 183                                                         {
 184                                                                 //push slave ahead of master
 185                                                                 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));
 186                                                         }
 187                                                         else if(slave_bottom <= master_top)
 188                                                         {
 189                                                                 r.layer->position.y.bind(master.layer->position.y - r.adjustment_y + master.adjustment_y - (master_top - slave_top));
 190                                                         }
 191                                                 }
 192
 193                                         }
 194                                 }
 195                         }
 196                 }
 197         };
 198
 199 int64_t get_frame_number(
 200                 const core::video_format_desc& format_desc,
 201                 const boost::rational<int>& at_second)
 202 {
 203         return static_cast<int64_t>(
 204                         boost::rational_cast<double>(at_second) * format_desc.fps);
 205 }
 206
 207 boost::rational<int> get_rational(const boost::property_tree::wptree& node)
 208 {
 209         return boost::rational<int>(
 210                         node.get<int>(L"numerator"), node.get<int>(L"denominator"));
 211 }
 212
 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)
 217 {
 218         auto keylist = comment_track.get_child_optional(L"keyList");
 219
 220         if (!keylist)
 221                 return;
 222
 223         for (auto& key : *keylist)
 224         {
 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(","));
 230
 231                 for (auto& mark : marks)
 232                 {
 233                         boost::trim_if(mark, [](wchar_t c) { return isspace(c) || c == 0; });
 234
 235                         std::vector<std::wstring> args;
 236                         boost::split(args, mark, boost::is_any_of(" \t"), boost::algorithm::token_compress_on);
 237
 238                         scene->add_mark(frame, core::scene::get_mark_action(args.at(0)), args.size() == 1 ? L"" : args.at(1));
 239                 }
 240         }
 241 }
 242
 243 void create_marks(
 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)
 247 {
 248         auto time = get_rational(global_timeline.get_child(L"duration"));
 249         auto remove_at_frame = get_frame_number(format_desc, time);
 250
 251         scene->add_mark(remove_at_frame, core::scene::mark_action::remove, L"");
 252
 253         auto tracklist = global_timeline.get_child_optional(L"globalTrackList");
 254
 255         if (!tracklist)
 256                 return;
 257
 258         for (auto& track : *tracklist)
 259         {
 260                 auto track_id = track.second.get<std::wstring>(L"stdTrackID");
 261
 262                 if (track_id == L"globalCommentTrack")
 263                         create_marks_from_comments(scene, format_desc, track.second);
 264         }
 265 }
 266
 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,
 272                 double adjustment_x,
 273                 double adjustment_y)
 274 {
 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);
 281
 282         layer.hidden = scene->frame() < start_frame || scene->frame() > end_frame;
 283
 284         auto tracklist = timeline.get_child_optional(L"trackList");
 285
 286         if (!tracklist)
 287                 return;
 288
 289         double original_pos_x = psd_layer->location().x;
 290         double original_pos_y = psd_layer->location().y;
 291
 292         for (auto& track : *tracklist)
 293         {
 294                 auto track_id = track.second.get<std::wstring>(L"stdTrackID");
 295
 296                 if (track_id == L"sheetPositionTrack")
 297                 {
 298                         for (auto& key : track.second.get_child(L"keyList"))
 299                         {
 300                                 bool tween = key.second.get<std::wstring>(L"animInterpStyle")
 301                                                 == L"Lnr ";
 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);
 308
 309                                 if (frame == 0) // Consider as initial value (rewind)
 310                                 {
 311                                         layer.position.x.set(x);
 312                                         layer.position.y.set(y);
 313                                 }
 314
 315                                 frame = start_frame + frame; // translate to global timeline
 316
 317                                 if (tween)
 318                                 {
 319                                         scene->add_keyframe(layer.position.x, x, frame, L"easeOutSine");
 320                                         scene->add_keyframe(layer.position.y, y, frame, L"easeOutSine");
 321                                 }
 322                                 else
 323                                 {
 324                                         scene->add_keyframe(layer.position.x, x, frame);
 325                                         scene->add_keyframe(layer.position.y, y, frame);
 326                                 }
 327                         }
 328                 }
 329                 else if (track_id == L"opacityTrack")
 330                 {
 331                         auto& opacity = layer.adjustments.opacity;
 332
 333                         for (auto& key : track.second.get_child(L"keyList"))
 334                         {
 335                                 bool tween = key.second.get<std::wstring>(L"animInterpStyle")
 336                                                 == L"Lnr ";
 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);
 340
 341                                 if (frame == 0) // Consider as initial value (rewind)
 342                                         opacity.set(opct);
 343
 344                                 frame = start_frame + frame; // translate to global timeline
 345
 346                                 if (tween)
 347                                         scene->add_keyframe(opacity, opct, frame, L"easeOutSine");
 348                                 else
 349                                         scene->add_keyframe(opacity, opct, frame);
 350                         }
 351                 }
 352         }
 353 }
 354
 355 spl::shared_ptr<core::frame_producer> create_psd_scene_producer(const core::frame_producer_dependencies& dependencies, const std::vector<std::wstring>& params)
 356 {
 357         std::wstring filename = env::template_folder() + params.at(0) + L".psd";
 358         auto found_file = find_case_insensitive(filename);
 359
 360         if (!found_file)
 361                 return core::frame_producer::empty();
 362
 363         psd_document doc;
 364         doc.parse(*found_file);
 365
 366         auto root = spl::make_shared<core::scene::scene_producer>(L"psd", doc.width(), doc.height(), dependencies.format_desc);
 367
 368         layer_link_constructor link_constructor;
 369
 370         std::vector<std::pair<std::wstring, spl::shared_ptr<core::text_producer>>> text_producers_by_layer_name;
 371
 372         auto layers_end = doc.layers().end();
 373         for(auto it = doc.layers().begin(); it != layers_end; ++it)
 374         {
 375                 if((*it)->is_visible())
 376                 {
 377                         bool is_text = (*it)->is_text();
 378                         bool is_marked_as_dynamic = (*it)->sheet_color() == 4;
 379                         std::wstring layer_name = (*it)->name();
 380                         if(is_text && is_marked_as_dynamic)
 381                         {
 382                                 std::wstring str = (*it)->text_data().get(L"EngineDict.Editor.Text", L"");
 383
 384                                 core::text::text_info text_info(std::move(get_text_info((*it)->text_data())));
 385                                 text_info.size *= (*it)->text_scale();
 386
 387                                 auto text_producer = core::text_producer::create(dependencies.frame_factory, 0, 0, str, text_info, doc.width(), doc.height());
 388
 389                                 core::text::string_metrics metrics = text_producer->measure_string(str);
 390
 391                                 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
 392                                 auto adjustment_y = metrics.bearingY;
 393                                 auto& new_layer = root->create_layer(text_producer, (*it)->location().x + adjustment_x, (*it)->location().y + adjustment_y, (*it)->name());
 394                                 new_layer.adjustments.opacity.set((*it)->opacity() / 255.0);
 395                                 new_layer.hidden.set(!(*it)->is_visible());
 396
 397                                 if ((*it)->has_timeline())
 398                                         create_timelines(root, dependencies.format_desc, new_layer, (*it), adjustment_x, adjustment_y);
 399
 400                                 if((*it)->link_group_id() != 0)
 401                                         link_constructor.add(&new_layer, (*it)->link_group_id(), (*it)->is_position_protected(), -adjustment_x, -adjustment_y);
 402
 403                                 text_producers_by_layer_name.push_back(std::make_pair(layer_name, text_producer));
 404                         }
 405                         else
 406                         {
 407                                 std::shared_ptr<core::frame_producer> layer_producer;
 408                                 if((*it)->is_solid())
 409                                 {
 410                                         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());
 411                                 }
 412                                 else if((*it)->bitmap())
 413                                 {
 414                                         if (boost::algorithm::istarts_with(layer_name, L"[producer]"))
 415                                         {
 416                                                 auto hotswap = std::make_shared<core::hotswap_producer>((*it)->bitmap()->width(), (*it)->bitmap()->height());
 417                                                 hotswap->producer().set(dependencies.producer_registry->create_producer(dependencies, layer_name.substr(10)));
 418                                                 layer_producer = hotswap;
 419                                         }
 420                                         else
 421                                         {
 422                                                 core::pixel_format_desc pfd(core::pixel_format::bgra);
 423                                                 pfd.planes.push_back(core::pixel_format_desc::plane((*it)->bitmap()->width(), (*it)->bitmap()->height(), 4));
 424
 425                                                 auto frame = dependencies.frame_factory->create_frame(it->get(), pfd, core::audio_channel_layout::invalid());
 426                                                 auto destination = frame.image_data().data();
 427                                                 auto source = (*it)->bitmap()->data();
 428                                                 memcpy(destination, source, frame.image_data().size());
 429
 430                                                 layer_producer = core::create_const_producer(core::draw_frame(std::move(frame)), (*it)->bitmap()->width(), (*it)->bitmap()->height());
 431                                         }
 432                                 }
 433
 434                                 if(layer_producer)
 435                                 {
 436                                         auto& new_layer = root->create_layer(spl::make_shared_ptr(layer_producer), (*it)->location().x, (*it)->location().y, (*it)->name());
 437                                         new_layer.adjustments.opacity.set((*it)->opacity() / 255.0);
 438                                         new_layer.hidden.set(!(*it)->is_visible());
 439
 440                                         if ((*it)->has_timeline())
 441                                                 create_timelines(root, dependencies.format_desc, new_layer, (*it), 0, 0);
 442
 443                                         if((*it)->link_group_id() != 0)
 444                                                 link_constructor.add(&new_layer, (*it)->link_group_id(), (*it)->is_position_protected(), 0, 0);
 445                                 }
 446                         }
 447                 }
 448         }
 449
 450         link_constructor.calculate();
 451
 452         // Reset all dynamic text fields to empty strings and expose them as a scene parameter.
 453         for (auto& text_layer : text_producers_by_layer_name)
 454                 text_layer.second->text().bind(root->create_variable<std::wstring>(boost::to_lower_copy(text_layer.first), true, L""));
 455
 456         if (doc.has_timeline())
 457                 create_marks(root, dependencies.format_desc, doc.timeline());
 458
 459         auto params2 = params;
 460         params2.erase(params2.begin());
 461
 462         root->call(params2);
 463
 464         return root;
 465 }
 466
 467 void init(core::module_dependencies dependencies)
 468 {
 469         dependencies.cg_registry->register_cg_producer(
 470                         L"psd",
 471                         { L".psd" },
 472                         [](const std::wstring& filename) { return ""; },
 473                         [](const spl::shared_ptr<core::frame_producer>& producer)
 474                         {
 475                                 return spl::make_shared<core::scene::scene_cg_proxy>(producer);
 476                         },
 477                         [](
 478                                         const core::frame_producer_dependencies& dependencies,
 479                                         const std::wstring& filename)
 480                         {
 481                                 return create_psd_scene_producer(dependencies, { filename });
 482                         },
 483                         false);
 484 }
 485
 486 }}