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