2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
4 * This file is part of CasparCG (www.casparcg.com).
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.
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.
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/>.
19 * Author: Helge Norberg, helge.norberg@svt.se
24 #include "thumbnail_generator.h"
31 #include <boost/thread.hpp>
32 #include <boost/algorithm/string/predicate.hpp>
33 #include <boost/filesystem.hpp>
35 #include <tbb/atomic.h>
37 #include <common/diagnostics/graph.h>
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 "frame/audio_channel_layout.h"
48 #include "producer/media_info/media_info.h"
49 #include "producer/media_info/media_info_repository.h"
51 namespace caspar { namespace core {
53 std::wstring get_relative_without_extension(
54 const boost::filesystem::path& file,
55 const boost::filesystem::path& relative_to)
57 auto result = file.stem();
59 boost::filesystem::path current_path = file;
63 current_path = current_path.parent_path();
65 if (boost::filesystem::equivalent(current_path, relative_to))
68 if (current_path.empty())
69 throw std::runtime_error("File not relative to folder");
71 result = current_path.filename() / result;
74 return result.wstring();
77 struct thumbnail_output
79 tbb::atomic<int> sleep_millis;
80 std::function<void (const_frame)> on_send;
82 thumbnail_output(int sleep_millis)
84 this->sleep_millis = sleep_millis;
87 void send(const_frame frame, std::shared_ptr<void> frame_and_ticket)
89 int current_sleep = sleep_millis;
91 if (current_sleep > 0)
92 boost::this_thread::sleep_for(boost::chrono::milliseconds(current_sleep));
94 on_send(std::move(frame));
99 struct thumbnail_generator::impl
102 boost::filesystem::path media_path_;
103 boost::filesystem::path thumbnails_path_;
106 spl::shared_ptr<image_mixer> image_mixer_;
107 spl::shared_ptr<diagnostics::graph> graph_;
108 video_format_desc format_desc_;
109 spl::unique_ptr<thumbnail_output> output_;
111 thumbnail_creator thumbnail_creator_;
112 spl::shared_ptr<media_info_repository> media_info_repo_;
113 spl::shared_ptr<const frame_producer_registry> producer_registry_;
115 filesystem_monitor::ptr monitor_;
118 filesystem_monitor_factory& monitor_factory,
119 const boost::filesystem::path& media_path,
120 const boost::filesystem::path& thumbnails_path,
123 const video_format_desc& render_video_mode,
124 std::unique_ptr<image_mixer> image_mixer,
125 int generate_delay_millis,
126 const thumbnail_creator& thumbnail_creator,
127 spl::shared_ptr<media_info_repository> media_info_repo,
128 spl::shared_ptr<const frame_producer_registry> producer_registry,
130 : media_path_(media_path)
131 , thumbnails_path_(thumbnails_path)
134 , image_mixer_(std::move(image_mixer))
135 , format_desc_(render_video_mode)
136 , output_(spl::make_unique<thumbnail_output>(generate_delay_millis))
137 , mixer_(0, graph_, image_mixer_)
138 , thumbnail_creator_(thumbnail_creator)
139 , media_info_repo_(std::move(media_info_repo))
140 , producer_registry_(std::move(producer_registry))
141 , monitor_(monitor_factory.create(
143 filesystem_event::ALL,
145 [this] (filesystem_event event, const boost::filesystem::path& file)
147 this->on_file_event(event, file);
149 [this] (const std::set<boost::filesystem::path>& initial_files)
151 this->on_initial_files(initial_files);
154 graph_->set_text(L"thumbnail-channel");
155 graph_->auto_reset();
156 diagnostics::register_graph(graph_);
157 //monitor_->initial_scan_completion().get();
158 //output_->sleep_millis = 2000;
161 void on_initial_files(const std::set<boost::filesystem::path>& initial_files)
163 using namespace boost::filesystem;
165 std::set<std::wstring> relative_without_extensions;
168 std::insert_iterator<std::set<std::wstring>>(
169 relative_without_extensions,
170 relative_without_extensions.end()),
171 boost::bind(&get_relative_without_extension, _1, media_path_));
173 for (boost::filesystem::wrecursive_directory_iterator iter(thumbnails_path_); iter != boost::filesystem::wrecursive_directory_iterator(); ++iter)
175 auto& path = iter->path();
177 if (!is_regular_file(path))
180 auto relative_without_extension = get_relative_without_extension(path, thumbnails_path_);
181 bool no_corresponding_media_file = relative_without_extensions.find(relative_without_extension)
182 == relative_without_extensions.end();
184 if (no_corresponding_media_file)
185 remove(thumbnails_path_ / (relative_without_extension + L".png"));
189 void generate(const std::wstring& media_file)
191 using namespace boost::filesystem;
192 auto base_file = media_path_ / media_file;
193 auto folder = base_file.parent_path();
195 for (boost::filesystem::directory_iterator iter(folder); iter != boost::filesystem::directory_iterator(); ++iter)
197 auto stem = iter->path().stem();
199 if (boost::iequals(stem.wstring(), base_file.filename().wstring()))
200 monitor_->reemmit(iter->path());
206 monitor_->reemmit_all();
209 void on_file_event(filesystem_event event, const boost::filesystem::path& file)
213 case filesystem_event::CREATED:
214 if (needs_to_be_generated(file))
215 generate_thumbnail(file);
218 case filesystem_event::MODIFIED:
219 generate_thumbnail(file);
222 case filesystem_event::REMOVED:
223 auto relative_without_extension = get_relative_without_extension(file, media_path_);
224 boost::filesystem::remove(thumbnails_path_ / (relative_without_extension + L".png"));
225 media_info_repo_->remove(file.wstring());
231 bool needs_to_be_generated(const boost::filesystem::path& file)
233 using namespace boost::filesystem;
235 auto png_file = thumbnails_path_ / (get_relative_without_extension(file, media_path_) + L".png");
237 if (!exists(png_file))
240 std::time_t media_file_mtime;
244 media_file_mtime = last_write_time(file);
254 return media_file_mtime != last_write_time(png_file);
258 // thumbnail probably removed.
263 void generate_thumbnail(const boost::filesystem::path& file)
265 auto media_file = get_relative_without_extension(file, media_path_);
266 auto png_file = thumbnails_path_ / (media_file + L".png");
267 std::promise<void> thumbnail_ready;
270 auto producer = frame_producer::empty();
274 producer = producer_registry_->create_thumbnail_producer(
275 frame_producer_dependencies(image_mixer_, { }, format_desc_, producer_registry_),
278 catch (const boost::thread_interrupted&)
284 CASPAR_LOG(debug) << L"Thumbnail producer failed to initialize for " << media_file;
288 if (producer == frame_producer::empty())
290 CASPAR_LOG(trace) << L"No appropriate thumbnail producer found for " << media_file;
294 boost::filesystem::create_directories(png_file.parent_path());
295 output_->on_send = [this, &png_file] (const_frame frame)
297 thumbnail_creator_(frame, format_desc_, png_file, width_, height_);
300 std::map<int, draw_frame> frames;
301 auto raw_frame = draw_frame::empty();
305 raw_frame = producer->create_thumbnail_frame();
306 media_info_repo_->remove(file.wstring());
307 media_info_repo_->get(file.wstring());
309 catch (const boost::thread_interrupted&)
315 CASPAR_LOG(debug) << L"Thumbnail producer failed to create thumbnail for " << media_file;
319 if (raw_frame == draw_frame::empty()
320 || raw_frame == draw_frame::late())
322 CASPAR_LOG(debug) << L"No thumbnail generated for " << media_file;
326 auto transformed_frame = draw_frame(raw_frame);
327 transformed_frame.transform().image_transform.fill_scale[0] = static_cast<double>(width_) / format_desc_.width;
328 transformed_frame.transform().image_transform.fill_scale[1] = static_cast<double>(height_) / format_desc_.height;
329 transformed_frame.transform().image_transform.use_mipmap = mipmap_;
330 frames.insert(std::make_pair(0, transformed_frame));
332 std::shared_ptr<void> ticket(nullptr, [&thumbnail_ready](void*) { thumbnail_ready.set_value(); });
334 auto mixed_frame = mixer_(std::move(frames), format_desc_, audio_channel_layout(2, L"stereo", L""));
336 output_->send(std::move(mixed_frame), ticket);
339 thumbnail_ready.get_future().get();
341 if (boost::filesystem::exists(png_file))
343 // Adjust timestamp to match source file.
346 boost::filesystem::last_write_time(png_file, boost::filesystem::last_write_time(file));
347 CASPAR_LOG(debug) << L"Generated thumbnail for " << media_file;
351 // One of the files was removed before the call to last_write_time.
355 CASPAR_LOG(debug) << L"No thumbnail generated for " << media_file;
359 thumbnail_generator::thumbnail_generator(
360 filesystem_monitor_factory& monitor_factory,
361 const boost::filesystem::path& media_path,
362 const boost::filesystem::path& thumbnails_path,
365 const video_format_desc& render_video_mode,
366 std::unique_ptr<image_mixer> image_mixer,
367 int generate_delay_millis,
368 const thumbnail_creator& thumbnail_creator,
369 spl::shared_ptr<media_info_repository> media_info_repo,
370 spl::shared_ptr<const frame_producer_registry> producer_registry,
378 std::move(image_mixer),
379 generate_delay_millis,
387 thumbnail_generator::~thumbnail_generator()
391 void thumbnail_generator::generate(const std::wstring& media_file)
393 impl_->generate(media_file);
396 void thumbnail_generator::generate_all()
398 impl_->generate_all();