git.sesse.net Git - casparcg/blob - core/thumbnail_generator.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: Helge Norberg, helge.norberg@svt.se
  20 */
  21
  22 #include "StdAfx.h"
  23
  24 #include "thumbnail_generator.h"
  25
  26 #include <iostream>
  27 #include <iterator>
  28 #include <set>
  29 #include <future>
  30
  31 #include <boost/thread.hpp>
  32 #include <boost/algorithm/string/predicate.hpp>
  33 #include <boost/filesystem.hpp>
  34
  35 #include <tbb/atomic.h>
  36
  37 #include <common/diagnostics/graph.h>
  38
  39 #include "producer/frame_producer.h"
  40 #include "consumer/frame_consumer.h"
  41 #include "mixer/mixer.h"
  42 #include "mixer/image/image_mixer.h"
  43 #include "video_format.h"
  44 #include "frame/frame.h"
  45 #include "frame/draw_frame.h"
  46 #include "frame/frame_transform.h"
  47 #include "producer/media_info/media_info.h"
  48 #include "producer/media_info/media_info_repository.h"
  49
  50 namespace caspar { namespace core {
  51
  52 std::wstring get_relative_without_extension(
  53                 const boost::filesystem::path& file,
  54                 const boost::filesystem::path& relative_to)
  55 {
  56         auto result = file.stem();
  57
  58         boost::filesystem::path current_path = file;
  59
  60         while (true)
  61         {
  62                 current_path = current_path.parent_path();
  63
  64                 if (boost::filesystem::equivalent(current_path, relative_to))
  65                         break;
  66
  67                 if (current_path.empty())
  68                         throw std::runtime_error("File not relative to folder");
  69
  70                 result = current_path.filename() / result;
  71         }
  72
  73         return result.wstring();
  74 }
  75
  76 struct thumbnail_output
  77 {
  78         tbb::atomic<int> sleep_millis;
  79         std::function<void (const_frame)> on_send;
  80
  81         thumbnail_output(int sleep_millis)
  82         {
  83                 this->sleep_millis = sleep_millis;
  84         }
  85
  86         void send(const_frame frame, std::shared_ptr<void> frame_and_ticket)
  87         {
  88                 int current_sleep = sleep_millis;
  89
  90                 if (current_sleep > 0)
  91                         boost::this_thread::sleep_for(boost::chrono::milliseconds(current_sleep));
  92
  93                 on_send(std::move(frame));
  94                 on_send = nullptr;
  95         }
  96 };
  97
  98 struct thumbnail_generator::impl
  99 {
 100 private:
 101         boost::filesystem::path                                                 media_path_;
 102         boost::filesystem::path                                                 thumbnails_path_;
 103         int                                                                                             width_;
 104         int                                                                                             height_;
 105         spl::shared_ptr<image_mixer>                                    image_mixer_;
 106         spl::shared_ptr<diagnostics::graph>                             graph_;
 107         video_format_desc                                                               format_desc_;
 108         spl::unique_ptr<thumbnail_output>                               output_;
 109         mixer                                                                                   mixer_;
 110         thumbnail_creator                                                               thumbnail_creator_;
 111         spl::shared_ptr<media_info_repository>                  media_info_repo_;
 112         spl::shared_ptr<const frame_producer_registry>  producer_registry_;
 113         bool                                                                                    mipmap_;
 114         filesystem_monitor::ptr                                                 monitor_;
 115 public:
 116         impl(
 117                         filesystem_monitor_factory& monitor_factory,
 118                         const boost::filesystem::path& media_path,
 119                         const boost::filesystem::path& thumbnails_path,
 120                         int width,
 121                         int height,
 122                         const video_format_desc& render_video_mode,
 123                         std::unique_ptr<image_mixer> image_mixer,
 124                         int generate_delay_millis,
 125                         const thumbnail_creator& thumbnail_creator,
 126                         spl::shared_ptr<media_info_repository> media_info_repo,
 127                         spl::shared_ptr<const frame_producer_registry> producer_registry,
 128                         bool mipmap)
 129                 : media_path_(media_path)
 130                 , thumbnails_path_(thumbnails_path)
 131                 , width_(width)
 132                 , height_(height)
 133                 , image_mixer_(std::move(image_mixer))
 134                 , format_desc_(render_video_mode)
 135                 , output_(spl::make_unique<thumbnail_output>(generate_delay_millis))
 136                 , mixer_(0, graph_, image_mixer_)
 137                 , thumbnail_creator_(thumbnail_creator)
 138                 , media_info_repo_(std::move(media_info_repo))
 139                 , producer_registry_(std::move(producer_registry))
 140                 , monitor_(monitor_factory.create(
 141                                 media_path,
 142                                 filesystem_event::ALL,
 143                                 true,
 144                                 [this] (filesystem_event event, const boost::filesystem::path& file)
 145                                 {
 146                                         this->on_file_event(event, file);
 147                                 },
 148                                 [this] (const std::set<boost::filesystem::path>& initial_files)
 149                                 {
 150                                         this->on_initial_files(initial_files);
 151                                 }))
 152         {
 153                 graph_->set_text(L"thumbnail-channel");
 154                 graph_->auto_reset();
 155                 diagnostics::register_graph(graph_);
 156                 //monitor_->initial_scan_completion().get();
 157                 //output_->sleep_millis = 2000;
 158         }
 159
 160         void on_initial_files(const std::set<boost::filesystem::path>& initial_files)
 161         {
 162                 using namespace boost::filesystem;
 163
 164                 std::set<std::wstring> relative_without_extensions;
 165                 boost::transform(
 166                                 initial_files,
 167                                 std::insert_iterator<std::set<std::wstring>>(
 168                                                 relative_without_extensions,
 169                                                 relative_without_extensions.end()),
 170                                 boost::bind(&get_relative_without_extension, _1, media_path_));
 171
 172                 for (boost::filesystem::wrecursive_directory_iterator iter(thumbnails_path_); iter != boost::filesystem::wrecursive_directory_iterator(); ++iter)
 173                 {
 174                         auto& path = iter->path();
 175
 176                         if (!is_regular_file(path))
 177                                 continue;
 178
 179                         auto relative_without_extension = get_relative_without_extension(path, thumbnails_path_);
 180                         bool no_corresponding_media_file = relative_without_extensions.find(relative_without_extension)
 181                                         == relative_without_extensions.end();
 182
 183                         if (no_corresponding_media_file)
 184                                 remove(thumbnails_path_ / (relative_without_extension + L".png"));
 185                 }
 186         }
 187
 188         void generate(const std::wstring& media_file)
 189         {
 190                 using namespace boost::filesystem;
 191                 auto base_file = media_path_ / media_file;
 192                 auto folder = base_file.parent_path();
 193
 194                 for (boost::filesystem::directory_iterator iter(folder); iter != boost::filesystem::directory_iterator(); ++iter)
 195                 {
 196                         auto stem = iter->path().stem();
 197
 198                         if (boost::iequals(stem.wstring(), base_file.filename().wstring()))
 199                                 monitor_->reemmit(iter->path());
 200                 }
 201         }
 202
 203         void generate_all()
 204         {
 205                 monitor_->reemmit_all();
 206         }
 207
 208         void on_file_event(filesystem_event event, const boost::filesystem::path& file)
 209         {
 210                 switch (event)
 211                 {
 212                 case filesystem_event::CREATED:
 213                         if (needs_to_be_generated(file))
 214                                 generate_thumbnail(file);
 215
 216                         break;
 217                 case filesystem_event::MODIFIED:
 218                         generate_thumbnail(file);
 219
 220                         break;
 221                 case filesystem_event::REMOVED:
 222                         auto relative_without_extension = get_relative_without_extension(file, media_path_);
 223                         boost::filesystem::remove(thumbnails_path_ / (relative_without_extension + L".png"));
 224                         media_info_repo_->remove(file.wstring());
 225
 226                         break;
 227                 }
 228         }
 229
 230         bool needs_to_be_generated(const boost::filesystem::path& file)
 231         {
 232                 using namespace boost::filesystem;
 233
 234                 auto png_file = thumbnails_path_ / (get_relative_without_extension(file, media_path_) + L".png");
 235
 236                 if (!exists(png_file))
 237                         return true;
 238
 239                 std::time_t media_file_mtime;
 240
 241                 try
 242                 {
 243                         media_file_mtime = last_write_time(file);
 244                 }
 245                 catch (...)
 246                 {
 247                         // Probably removed.
 248                         return false;
 249                 }
 250
 251                 try
 252                 {
 253                         return media_file_mtime != last_write_time(png_file);
 254                 }
 255                 catch (...)
 256                 {
 257                         // thumbnail probably removed.
 258                         return true;
 259                 }
 260         }
 261
 262         void generate_thumbnail(const boost::filesystem::path& file)
 263         {
 264                 auto media_file = get_relative_without_extension(file, media_path_);
 265                 auto png_file = thumbnails_path_ / (media_file + L".png");
 266                 std::promise<void> thumbnail_ready;
 267
 268                 {
 269                         auto producer = frame_producer::empty();
 270
 271                         try
 272                         {
 273                                 producer = producer_registry_->create_thumbnail_producer(
 274                                                 frame_producer_dependencies(image_mixer_, { }, format_desc_, producer_registry_),
 275                                                 media_file);
 276                         }
 277                         catch (const boost::thread_interrupted&)
 278                         {
 279                                 throw;
 280                         }
 281                         catch (...)
 282                         {
 283                                 CASPAR_LOG(debug) << L"Thumbnail producer failed to initialize for " << media_file;
 284                                 return;
 285                         }
 286
 287                         if (producer == frame_producer::empty())
 288                         {
 289                                 CASPAR_LOG(trace) << L"No appropriate thumbnail producer found for " << media_file;
 290                                 return;
 291                         }
 292
 293                         boost::filesystem::create_directories(png_file.parent_path());
 294                         output_->on_send = [this, &png_file] (const_frame frame)
 295                         {
 296                                 thumbnail_creator_(frame, format_desc_, png_file, width_, height_);
 297                         };
 298
 299                         std::map<int, draw_frame> frames;
 300                         auto raw_frame = draw_frame::empty();
 301
 302                         try
 303                         {
 304                                 raw_frame = producer->create_thumbnail_frame();
 305                                 media_info_repo_->remove(file.wstring());
 306                                 media_info_repo_->get(file.wstring());
 307                         }
 308                         catch (const boost::thread_interrupted&)
 309                         {
 310                                 throw;
 311                         }
 312                         catch (...)
 313                         {
 314                                 CASPAR_LOG(debug) << L"Thumbnail producer failed to create thumbnail for " << media_file;
 315                                 return;
 316                         }
 317
 318                         if (raw_frame == draw_frame::empty()
 319                                         || raw_frame == draw_frame::late())
 320                         {
 321                                 CASPAR_LOG(debug) << L"No thumbnail generated for " << media_file;
 322                                 return;
 323                         }
 324
 325                         auto transformed_frame = draw_frame(raw_frame);
 326                         transformed_frame.transform().image_transform.fill_scale[0] = static_cast<double>(width_) / format_desc_.width;
 327                         transformed_frame.transform().image_transform.fill_scale[1] = static_cast<double>(height_) / format_desc_.height;
 328                         transformed_frame.transform().image_transform.use_mipmap = mipmap_;
 329                         frames.insert(std::make_pair(0, transformed_frame));
 330
 331                         std::shared_ptr<void> ticket(nullptr, [&thumbnail_ready](void*) { thumbnail_ready.set_value(); });
 332
 333                         auto mixed_frame = mixer_(std::move(frames), format_desc_);
 334
 335                         output_->send(std::move(mixed_frame), ticket);
 336                         ticket.reset();
 337                 }
 338                 thumbnail_ready.get_future().get();
 339
 340                 if (boost::filesystem::exists(png_file))
 341                 {
 342                         // Adjust timestamp to match source file.
 343                         try
 344                         {
 345                                 boost::filesystem::last_write_time(png_file, boost::filesystem::last_write_time(file));
 346                                 CASPAR_LOG(debug) << L"Generated thumbnail for " << media_file;
 347                         }
 348                         catch (...)
 349                         {
 350                                 // One of the files was removed before the call to last_write_time.
 351                         }
 352                 }
 353                 else
 354                         CASPAR_LOG(debug) << L"No thumbnail generated for " << media_file;
 355         }
 356 };
 357
 358 thumbnail_generator::thumbnail_generator(
 359                 filesystem_monitor_factory& monitor_factory,
 360                 const boost::filesystem::path& media_path,
 361                 const boost::filesystem::path& thumbnails_path,
 362                 int width,
 363                 int height,
 364                 const video_format_desc& render_video_mode,
 365                 std::unique_ptr<image_mixer> image_mixer,
 366                 int generate_delay_millis,
 367                 const thumbnail_creator& thumbnail_creator,
 368                 spl::shared_ptr<media_info_repository> media_info_repo,
 369                 spl::shared_ptr<const frame_producer_registry> producer_registry,
 370                 bool mipmap)
 371                 : impl_(new impl(
 372                                 monitor_factory,
 373                                 media_path,
 374                                 thumbnails_path,
 375                                 width, height,
 376                                 render_video_mode,
 377                                 std::move(image_mixer),
 378                                 generate_delay_millis,
 379                                 thumbnail_creator,
 380                                 media_info_repo,
 381                                 producer_registry,
 382                                 mipmap))
 383 {
 384 }
 385
 386 thumbnail_generator::~thumbnail_generator()
 387 {
 388 }
 389
 390 void thumbnail_generator::generate(const std::wstring& media_file)
 391 {
 392         impl_->generate(media_file);
 393 }
 394
 395 void thumbnail_generator::generate_all()
 396 {
 397         impl_->generate_all();
 398 }
 399
 400 }}