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: Robert Nagy, ronag89@gmail.com
22 #include "../StdAfx.h"
24 #include "../ffmpeg_error.h"
26 #include "ffmpeg_consumer.h"
28 #include "../producer/tbb_avcodec.h"
30 #include <core/frame/frame.h>
31 #include <core/frame/audio_channel_layout.h>
32 #include <core/mixer/audio/audio_util.h>
33 #include <core/consumer/frame_consumer.h>
34 #include <core/video_format.h>
35 #include <core/help/help_repository.h>
36 #include <core/help/help_sink.h>
38 #include <common/array.h>
39 #include <common/env.h>
40 #include <common/except.h>
41 #include <common/executor.h>
42 #include <common/future.h>
43 #include <common/diagnostics/graph.h>
44 #include <common/lock.h>
45 #include <common/memory.h>
46 #include <common/param.h>
47 #include <common/utf.h>
48 #include <common/assert.h>
49 #include <common/memshfl.h>
50 #include <common/timer.h>
51 #include <common/ptree.h>
53 #include <boost/algorithm/string.hpp>
54 #include <boost/property_tree/ptree.hpp>
55 #include <boost/filesystem.hpp>
56 #include <boost/range/algorithm.hpp>
57 #include <boost/range/algorithm_ext.hpp>
58 #include <boost/lexical_cast.hpp>
60 #include <tbb/spin_mutex.h>
66 #pragma warning (push)
67 #pragma warning (disable : 4244)
71 #define __STDC_CONSTANT_MACROS
72 #define __STDC_LIMIT_MACROS
73 #include <libavformat/avformat.h>
74 #include <libswscale/swscale.h>
75 #include <libavutil/opt.h>
76 #include <libavutil/pixdesc.h>
77 #include <libavutil/parseutils.h>
78 #include <libavutil/samplefmt.h>
79 #include <libswresample/swresample.h>
85 namespace caspar { namespace ffmpeg {
87 int av_opt_set(void *obj, const char *name, const char *val, int search_flags)
89 AVClass* av_class = *(AVClass**)obj;
91 if((strcmp(name, "pix_fmt") == 0 || strcmp(name, "pixel_format") == 0) && strcmp(av_class->class_name, "AVCodecContext") == 0)
93 AVCodecContext* c = (AVCodecContext*)obj;
94 auto pix_fmt = av_get_pix_fmt(val);
95 if(pix_fmt == PIX_FMT_NONE)
100 //if((strcmp(name, "r") == 0 || strcmp(name, "frame_rate") == 0) && strcmp(av_class->class_name, "AVCodecContext") == 0)
102 // AVCodecContext* c = (AVCodecContext*)obj;
104 // if(c->codec_type != AVMEDIA_TYPE_VIDEO)
108 // int ret = av_parse_video_rate(&rate, val);
112 // c->time_base.num = rate.den;
113 // c->time_base.den = rate.num;
117 return ::av_opt_set(obj, name, val, search_flags);
125 option(std::string name, std::string value)
126 : name(std::move(name))
127 , value(std::move(value))
134 AVOutputFormat* format;
142 output_format(const core::video_format_desc& format_desc, const std::string& filename, std::vector<option>& options)
143 : format(av_guess_format(nullptr, filename.c_str(), nullptr))
144 , width(format_desc.width)
145 , height(format_desc.height)
146 , vcodec(CODEC_ID_NONE)
147 , acodec(CODEC_ID_NONE)
151 if(boost::iequals(boost::filesystem::path(filename).extension().string(), ".dv"))
154 boost::range::remove_erase_if(options, [&](const option& o)
156 return set_opt(o.name, o.value);
159 if(vcodec == CODEC_ID_NONE && format)
160 vcodec = format->video_codec;
162 if(acodec == CODEC_ID_NONE && format)
163 acodec = format->audio_codec;
165 if(vcodec == CODEC_ID_NONE)
166 vcodec = CODEC_ID_H264;
168 if(acodec == CODEC_ID_NONE)
169 acodec = CODEC_ID_PCM_S16LE;
172 bool set_opt(const std::string& name, const std::string& value)
174 //if(name == "target")
176 // enum { PAL, NTSC, FILM, UNKNOWN } norm = UNKNOWN;
178 // if(name.find("pal-") != std::string::npos)
180 // else if(name.find("ntsc-") != std::string::npos)
183 // if(norm == UNKNOWN)
184 // CASPAR_THROW_EXCEPTION(invalid_argument() << arg_name_info("target"));
186 // if (name.find("-dv") != std::string::npos)
188 // set_opt("f", "dv");
191 // set_opt("s", "720x576");
195 // set_opt("s", "720x480");
198 // set_opt("croptop", "2");
199 // set_opt("cropbot", "4");
202 // set_opt("s", norm == PAL ? "720x576" : "720x480");
210 format = av_guess_format(value.c_str(), nullptr, nullptr);
212 if(format == nullptr)
213 CASPAR_THROW_EXCEPTION(user_error() << msg_info("Unknown format " + value));
217 else if(name == "vcodec" || name == "v:codec")
219 auto c = avcodec_find_encoder_by_name(value.c_str());
221 CASPAR_THROW_EXCEPTION(user_error() << msg_info("Unknown video codec " + value));
223 vcodec = avcodec_find_encoder_by_name(value.c_str())->id;
227 else if(name == "acodec" || name == "a:codec")
229 auto c = avcodec_find_encoder_by_name(value.c_str());
231 CASPAR_THROW_EXCEPTION(user_error() << msg_info("Unknown audio codec " + value));
233 acodec = avcodec_find_encoder_by_name(value.c_str())->id;
239 if(av_parse_video_size(&width, &height, value.c_str()) < 0)
240 CASPAR_THROW_EXCEPTION(user_error() << msg_info("Unknown video size " + value));
244 else if(name == "croptop")
246 croptop = boost::lexical_cast<int>(value);
250 else if(name == "cropbot")
252 cropbot = boost::lexical_cast<int>(value);
261 typedef cache_aligned_vector<uint8_t> byte_vector;
263 struct ffmpeg_consumer : boost::noncopyable
265 const spl::shared_ptr<diagnostics::graph> graph_;
266 const std::string filename_;
267 const std::string full_filename_ = u8(env::media_folder()) + filename_;
268 const std::shared_ptr<AVFormatContext> oc_ { avformat_alloc_context(), avformat_free_context };
269 const core::video_format_desc format_desc_;
270 const core::audio_channel_layout channel_layout_;
272 core::monitor::subject monitor_subject_;
274 tbb::spin_mutex exception_mutex_;
275 std::exception_ptr exception_;
277 std::shared_ptr<AVStream> audio_st_;
278 std::shared_ptr<AVStream> video_st_;
280 byte_vector picture_buffer_;
281 byte_vector key_picture_buf_;
282 byte_vector audio_buffer_;
283 std::shared_ptr<SwrContext> swr_;
284 std::shared_ptr<SwsContext> sws_;
286 int64_t frame_number_ = 0;
288 output_format output_format_;
290 tbb::atomic<int64_t> current_encoding_delay_;
295 const std::string& filename,
296 const core::video_format_desc& format_desc,
297 const core::audio_channel_layout& channel_layout,
298 std::vector<option> options,
300 : filename_(filename)
301 , format_desc_(format_desc)
302 , channel_layout_(channel_layout)
303 , output_format_(format_desc, full_filename_, options)
304 , key_only_(key_only)
307 current_encoding_delay_ = 0;
310 // TODO: Ask stakeholders about case where file already exists.
311 boost::filesystem::remove(boost::filesystem::path(full_filename_)); // Delete the file if it exists
313 graph_->set_color("frame-time", diagnostics::color(0.1f, 1.0f, 0.1f));
314 graph_->set_color("dropped-frame", diagnostics::color(0.3f, 0.6f, 0.3f));
315 graph_->set_text(print());
316 diagnostics::register_graph(graph_);
318 executor_.set_capacity(8);
320 oc_->oformat = output_format_.format;
322 std::strcpy(oc_->filename, full_filename_.c_str());
324 // Add the audio and video streams using the default format codecs and initialize the codecs.
325 video_st_ = add_video_stream(options);
328 audio_st_ = add_audio_stream(options);
330 av_dump_format(oc_.get(), 0, full_filename_.c_str(), 1);
332 // Open the output ffmpeg, if needed.
333 if (!(oc_->oformat->flags & AVFMT_NOFILE))
334 THROW_ON_ERROR2(avio_open(&oc_->pb, full_filename_.c_str(), AVIO_FLAG_WRITE), "[ffmpeg_consumer]");
336 THROW_ON_ERROR2(avformat_write_header(oc_.get(), nullptr), "[ffmpeg_consumer]");
338 if(options.size() > 0)
340 for (auto& option : options)
341 CASPAR_LOG(warning) << L"Invalid option: -" << u16(option.name) << L" " << u16(option.value);
353 CASPAR_LOG_CURRENT_EXCEPTION();
356 LOG_ON_ERROR2(av_write_trailer(oc_.get()), "[ffmpeg_consumer]");
363 if (!(oc_->oformat->flags & AVFMT_NOFILE))
364 LOG_ON_ERROR2(avio_close(oc_->pb), "[ffmpeg_consumer]");
369 void send(core::const_frame& frame)
371 auto exception = lock(exception_mutex_, [&]
376 if(exception != nullptr)
377 std::rethrow_exception(exception);
379 executor_.begin_invoke([=]
382 current_encoding_delay_ = frame.get_age_millis();
386 bool ready_for_frame() const
388 return !executor_.is_full();
393 graph_->set_tag(diagnostics::tag_severity::WARNING, "dropped-frame");
396 std::wstring print() const
398 return L"ffmpeg[" + u16(filename_) + L"]";
401 core::monitor::subject& monitor_output()
403 return monitor_subject_;
407 std::shared_ptr<AVStream> add_video_stream(std::vector<option>& options)
409 if(output_format_.vcodec == CODEC_ID_NONE)
412 auto st = avformat_new_stream(oc_.get(), 0);
414 CASPAR_THROW_EXCEPTION(caspar_exception() << msg_info("Could not allocate video-stream.") << boost::errinfo_api_function("av_new_stream"));
416 auto encoder = avcodec_find_encoder(output_format_.vcodec);
418 CASPAR_THROW_EXCEPTION(caspar_exception() << msg_info("Codec not found."));
422 avcodec_get_context_defaults3(c, encoder);
424 c->codec_id = output_format_.vcodec;
425 c->codec_type = AVMEDIA_TYPE_VIDEO;
426 c->width = output_format_.width;
427 c->height = output_format_.height - output_format_.croptop - output_format_.cropbot;
428 c->time_base.den = format_desc_.time_scale;
429 c->time_base.num = format_desc_.duration;
431 c->flags |= format_desc_.field_mode == core::field_mode::progressive ? 0 : (CODEC_FLAG_INTERLACED_ME | CODEC_FLAG_INTERLACED_DCT);
432 c->pix_fmt = c->pix_fmt != PIX_FMT_NONE ? c->pix_fmt : PIX_FMT_YUV420P;
434 if(c->codec_id == CODEC_ID_PRORES)
436 c->bit_rate = output_format_.width < 1280 ? 63*1000000 : 220*1000000;
437 c->pix_fmt = PIX_FMT_YUV422P10;
439 else if(c->codec_id == CODEC_ID_DNXHD)
441 if(c->width < 1280 || c->height < 720)
442 CASPAR_THROW_EXCEPTION(caspar_exception() << msg_info("Unsupported video dimensions."));
444 c->bit_rate = 220*1000000;
445 c->pix_fmt = PIX_FMT_YUV422P;
447 else if(c->codec_id == CODEC_ID_DVVIDEO)
449 c->width = c->height == 1280 ? 960 : c->width;
451 if(format_desc_.format == core::video_format::ntsc)
453 c->pix_fmt = PIX_FMT_YUV411P;
454 output_format_.croptop = 2;
455 output_format_.cropbot = 4;
456 c->height = output_format_.height - output_format_.croptop - output_format_.cropbot;
458 else if(format_desc_.format == core::video_format::pal)
459 c->pix_fmt = PIX_FMT_YUV420P;
461 c->pix_fmt = PIX_FMT_YUV422P;
463 if(format_desc_.duration == 1001)
464 c->width = c->height == 1080 ? 1280 : c->width;
466 c->width = c->height == 1080 ? 1440 : c->width;
468 else if(c->codec_id == CODEC_ID_H264)
470 c->pix_fmt = PIX_FMT_YUV420P;
471 av_opt_set(c->priv_data, "preset", "ultrafast", 0);
472 av_opt_set(c->priv_data, "tune", "fastdecode", 0);
473 av_opt_set(c->priv_data, "crf", "5", 0);
475 else if(c->codec_id == CODEC_ID_QTRLE)
477 c->pix_fmt = PIX_FMT_ARGB;
480 boost::range::remove_erase_if(options, [&](const option& o)
482 return o.name.at(0) != 'a' && ffmpeg::av_opt_set(c, o.name.c_str(), o.value.c_str(), AV_OPT_SEARCH_CHILDREN) > -1;
485 if(output_format_.format->flags & AVFMT_GLOBALHEADER)
486 c->flags |= CODEC_FLAG_GLOBAL_HEADER;
488 THROW_ON_ERROR2(tbb_avcodec_open(c, encoder, false), "[ffmpeg_consumer]");
490 return std::shared_ptr<AVStream>(st, [](AVStream* st)
492 LOG_ON_ERROR2(tbb_avcodec_close(st->codec), "[ffmpeg_consumer]");
496 std::shared_ptr<AVStream> add_audio_stream(std::vector<option>& options)
498 if(output_format_.acodec == CODEC_ID_NONE)
501 auto st = avformat_new_stream(oc_.get(), nullptr);
503 CASPAR_THROW_EXCEPTION(caspar_exception() << msg_info("Could not allocate audio-stream") << boost::errinfo_api_function("av_new_stream"));
505 auto encoder = avcodec_find_encoder(output_format_.acodec);
507 CASPAR_THROW_EXCEPTION(caspar_exception() << msg_info("codec not found"));
511 avcodec_get_context_defaults3(c, encoder);
513 c->codec_id = output_format_.acodec;
514 c->codec_type = AVMEDIA_TYPE_AUDIO;
515 c->sample_rate = 48000;
517 c->sample_fmt = AV_SAMPLE_FMT_S16;
518 c->time_base.num = 1;
519 c->time_base.den = c->sample_rate;
521 if(output_format_.vcodec == CODEC_ID_FLV1)
522 c->sample_rate = 44100;
524 if(output_format_.format->flags & AVFMT_GLOBALHEADER)
525 c->flags |= CODEC_FLAG_GLOBAL_HEADER;
527 boost::range::remove_erase_if(options, [&](const option& o)
529 return ffmpeg::av_opt_set(c, o.name.c_str(), o.value.c_str(), AV_OPT_SEARCH_CHILDREN) > -1;
532 THROW_ON_ERROR2(avcodec_open2(c, encoder, nullptr), "[ffmpeg_consumer]");
534 return std::shared_ptr<AVStream>(st, [](AVStream* st)
536 LOG_ON_ERROR2(avcodec_close(st->codec), "[ffmpeg_consumer]");
540 void encode_video_frame(core::const_frame frame)
545 auto enc = video_st_->codec;
547 auto av_frame = convert_video(frame, enc);
548 av_frame->interlaced_frame = format_desc_.field_mode != core::field_mode::progressive;
549 av_frame->top_field_first = format_desc_.field_mode == core::field_mode::upper;
550 av_frame->pts = frame_number_++;
553 << core::monitor::message("/frame") % static_cast<int64_t>(frame_number_)
554 << core::monitor::message("/path") % filename_
555 << core::monitor::message("/fps") % format_desc_.fps;
558 av_init_packet(&pkt);
563 THROW_ON_ERROR2(avcodec_encode_video2(enc, &pkt, av_frame.get(), &got_packet), "[ffmpeg_consumer]");
564 std::shared_ptr<AVPacket> guard(&pkt, av_free_packet);
569 if (pkt.pts != AV_NOPTS_VALUE)
570 pkt.pts = av_rescale_q(pkt.pts, enc->time_base, video_st_->time_base);
571 if (pkt.dts != AV_NOPTS_VALUE)
572 pkt.dts = av_rescale_q(pkt.dts, enc->time_base, video_st_->time_base);
574 pkt.stream_index = video_st_->index;
576 THROW_ON_ERROR2(av_interleaved_write_frame(oc_.get(), &pkt), "[ffmpeg_consumer]");
579 uint64_t get_channel_layout(AVCodecContext* dec)
581 auto layout = (dec->channel_layout && dec->channels == av_get_channel_layout_nb_channels(dec->channel_layout)) ? dec->channel_layout : av_get_default_channel_layout(dec->channels);
585 void encode_audio_frame(core::const_frame frame)
590 auto enc = audio_st_->codec;
592 boost::push_back(audio_buffer_, convert_audio(frame, enc));
594 auto frame_size = enc->frame_size != 0 ? enc->frame_size * enc->channels * av_get_bytes_per_sample(enc->sample_fmt) : static_cast<int>(audio_buffer_.size());
596 while(audio_buffer_.size() >= frame_size)
598 std::shared_ptr<AVFrame> av_frame(av_frame_alloc(), [=](AVFrame* p) { av_frame_free(&p); });
599 avcodec_get_frame_defaults(av_frame.get());
600 av_frame->nb_samples = frame_size / (enc->channels * av_get_bytes_per_sample(enc->sample_fmt));
603 av_init_packet(&pkt);
607 THROW_ON_ERROR2(avcodec_fill_audio_frame(av_frame.get(), enc->channels, enc->sample_fmt, audio_buffer_.data(), frame_size, 1), "[ffmpeg_consumer]");
610 THROW_ON_ERROR2(avcodec_encode_audio2(enc, &pkt, av_frame.get(), &got_packet), "[ffmpeg_consumer]");
611 std::shared_ptr<AVPacket> guard(&pkt, av_free_packet);
613 audio_buffer_.erase(audio_buffer_.begin(), audio_buffer_.begin() + frame_size);
618 if (pkt.pts != AV_NOPTS_VALUE)
619 pkt.pts = av_rescale_q(pkt.pts, enc->time_base, audio_st_->time_base);
620 if (pkt.dts != AV_NOPTS_VALUE)
621 pkt.dts = av_rescale_q(pkt.dts, enc->time_base, audio_st_->time_base);
622 if (pkt.duration > 0)
623 pkt.duration = static_cast<int>(av_rescale_q(pkt.duration, enc->time_base, audio_st_->time_base));
625 pkt.stream_index = audio_st_->index;
627 THROW_ON_ERROR2(av_interleaved_write_frame(oc_.get(), &pkt), "[ffmpeg_consumer]");
631 std::shared_ptr<AVFrame> convert_video(core::const_frame frame, AVCodecContext* c)
635 sws_.reset(sws_getContext(format_desc_.width,
636 format_desc_.height - output_format_.croptop - output_format_.cropbot,
641 SWS_BICUBIC, nullptr, nullptr, nullptr),
644 CASPAR_THROW_EXCEPTION(caspar_exception() << msg_info("Cannot initialize the conversion context"));
649 std::shared_ptr<AVFrame> in_frame(avcodec_alloc_frame(), av_free);
651 auto in_picture = reinterpret_cast<AVPicture*>(in_frame.get());
655 key_picture_buf_.resize(frame.image_data().size());
656 in_picture->linesize[0] = format_desc_.width * 4;
657 in_picture->data[0] = key_picture_buf_.data();
659 aligned_memshfl(in_picture->data[0], frame.image_data().begin(), frame.image_data().size(), 0x0F0F0F0F, 0x0B0B0B0B, 0x07070707, 0x03030303);
665 const_cast<uint8_t*>(frame.image_data().begin()),
668 format_desc_.height - output_format_.croptop - output_format_.cropbot);
673 for(int n = 0; n < 4; ++n)
674 in_frame->data[n] += in_frame->linesize[n] * output_format_.croptop;
678 std::shared_ptr<AVFrame> out_frame(avcodec_alloc_frame(), av_free);
680 av_image_fill_linesizes(out_frame->linesize, c->pix_fmt, c->width);
681 for(int n = 0; n < 4; ++n)
682 out_frame->linesize[n] += 32 - (out_frame->linesize[n] % 32); // align
684 picture_buffer_.resize(av_image_fill_pointers(out_frame->data, c->pix_fmt, c->height, nullptr, out_frame->linesize));
685 av_image_fill_pointers(out_frame->data, c->pix_fmt, c->height, picture_buffer_.data(), out_frame->linesize);
689 sws_scale(sws_.get(),
693 format_desc_.height - output_format_.cropbot - output_format_.croptop,
695 out_frame->linesize);
697 out_frame->format = c->pix_fmt;
698 out_frame->width = c->width;
699 out_frame->height = c->height;
704 byte_vector convert_audio(core::const_frame& frame, AVCodecContext* c)
708 swr_ = std::shared_ptr<SwrContext>(swr_alloc_set_opts(nullptr,
709 get_channel_layout(c), c->sample_fmt, c->sample_rate,
710 av_get_default_channel_layout(channel_layout_.num_channels), AV_SAMPLE_FMT_S32, format_desc_.audio_sample_rate,
711 0, nullptr), [](SwrContext* p){swr_free(&p);});
714 CASPAR_THROW_EXCEPTION(bad_alloc());
716 THROW_ON_ERROR2(swr_init(swr_.get()), "[audio_decoder]");
719 byte_vector buffer(48000);
721 const uint8_t* in[] = {reinterpret_cast<const uint8_t*>(frame.audio_data().data())};
722 uint8_t* out[] = {buffer.data()};
724 auto channel_samples = swr_convert(swr_.get(),
725 out, static_cast<int>(buffer.size()) / c->channels / av_get_bytes_per_sample(c->sample_fmt),
726 in, static_cast<int>(frame.audio_data().size()/channel_layout_.num_channels));
728 buffer.resize(channel_samples * c->channels * av_get_bytes_per_sample(c->sample_fmt));
735 auto space = boost::filesystem::space(boost::filesystem::path(full_filename_).parent_path());
736 if(space.available < 512*1000000)
737 CASPAR_THROW_EXCEPTION(file_write_error() << msg_info("out of space"));
740 void encode(const core::const_frame& frame)
744 if(frame_number_ % 25 == 0)
747 caspar::timer frame_timer;
749 encode_video_frame(frame);
750 encode_audio_frame(frame);
752 graph_->set_value("frame-time", frame_timer.elapsed()*format_desc_.fps*0.5);
756 lock(exception_mutex_, [&]
758 exception_ = std::current_exception();
764 struct ffmpeg_consumer_proxy : public core::frame_consumer
766 const std::wstring filename_;
767 const std::vector<option> options_;
768 const bool separate_key_;
770 std::unique_ptr<ffmpeg_consumer> consumer_;
771 std::unique_ptr<ffmpeg_consumer> key_only_consumer_;
775 ffmpeg_consumer_proxy(const std::wstring& filename, const std::vector<option>& options, bool separate_key)
776 : filename_(filename)
778 , separate_key_(separate_key)
782 void initialize(const core::video_format_desc& format_desc, const core::audio_channel_layout& channel_layout, int) override
785 CASPAR_THROW_EXCEPTION(invalid_operation() << msg_info("Cannot reinitialize ffmpeg-consumer."));
787 consumer_.reset(new ffmpeg_consumer(u8(filename_), format_desc, channel_layout, options_, false));
791 boost::filesystem::path fill_file(filename_);
792 auto without_extension = u16(fill_file.stem().string());
793 auto key_file = without_extension + L"_A" + u16(fill_file.extension().string());
795 key_only_consumer_.reset(new ffmpeg_consumer(u8(key_file), format_desc, channel_layout, options_, true));
799 int64_t presentation_frame_age_millis() const override
801 return consumer_ ? static_cast<int64_t>(consumer_->current_encoding_delay_) : 0;
804 std::future<bool> send(core::const_frame frame) override
806 bool ready_for_frame = consumer_->ready_for_frame();
808 if (ready_for_frame && separate_key_)
809 ready_for_frame = ready_for_frame && key_only_consumer_->ready_for_frame();
813 consumer_->send(frame);
816 key_only_consumer_->send(frame);
820 consumer_->mark_dropped();
823 key_only_consumer_->mark_dropped();
826 return make_ready_future(true);
829 std::wstring print() const override
831 return consumer_ ? consumer_->print() : L"[ffmpeg_consumer]";
834 std::wstring name() const override
839 boost::property_tree::wptree info() const override
841 boost::property_tree::wptree info;
842 info.add(L"type", L"file");
843 info.add(L"filename", filename_);
844 info.add(L"separate_key", separate_key_);
848 bool has_synchronization_clock() const override
853 int buffer_depth() const override
858 int index() const override
863 core::monitor::subject& monitor_output()
865 return consumer_->monitor_output();
869 void describe_consumer(core::help_sink& sink, const core::help_repository& repo)
871 sink.short_description(L"Can record a channel to a file supported by FFmpeg.");
872 sink.syntax(L"FILE [filename:string] {-[ffmpeg_param1:string] [value1:string] {-[ffmpeg_param2:string] [value2:string] {...}}} {[separate_key:SEPARATE_KEY]}");
873 sink.para()->text(L"Can record a channel to a file supported by FFmpeg.");
875 ->item(L"filename", L"The filename under the media folder including the extension (decides which kind of container format that will be used).")
876 ->item(L"ffmpeg_paramX", L"A parameter supported by FFmpeg. For example vcodec or acodec etc.")
877 ->item(L"separate_key", L"If defined will create two files simultaneously -- One for fill and one for key (_A will be appended).")
879 sink.para()->text(L"Examples:");
880 sink.example(L">> ADD 1 FILE output.mov -vcodec dnxhd");
881 sink.example(L">> ADD 1 FILE output.mov -vcodec prores");
882 sink.example(L">> ADD 1 FILE output.mov -vcodec dvvideo");
883 sink.example(L">> ADD 1 FILE output.mov -vcodec libx264 -preset ultrafast -tune fastdecode -crf 25");
884 sink.example(L">> ADD 1 FILE output.mov -vcodec dnxhd SEPARATE_KEY", L"for creating output.mov with fill and output_A.mov with key/alpha");
887 spl::shared_ptr<core::frame_consumer> create_consumer(
888 const std::vector<std::wstring>& params, core::interaction_sink*)
890 auto params2 = params;
891 auto separate_key_it = std::find_if(params2.begin(), params2.end(), param_comparer(L"SEPARATE_KEY"));
892 bool separate_key = false;
894 if (separate_key_it != params2.end())
897 params2.erase(separate_key_it);
900 auto str = std::accumulate(params2.begin(), params2.end(), std::wstring(), [](const std::wstring& lhs, const std::wstring& rhs) {return lhs + L" " + rhs;});
902 boost::wregex path_exp(LR"(\s*FILE(\s(?<PATH>.+\.[^\s]+))?.*)", boost::regex::icase);
905 if(!boost::regex_match(str, path, path_exp))
906 return core::frame_consumer::empty();
908 boost::wregex opt_exp(LR"(-((?<NAME>[^\s]+)\s+(?<VALUE>[^\s]+)))");
910 std::vector<option> options;
911 for(boost::wsregex_iterator it(str.begin(), str.end(), opt_exp); it != boost::wsregex_iterator(); ++it)
913 auto name = u8(boost::trim_copy(boost::to_lower_copy((*it)["NAME"].str())));
914 auto value = u8(boost::trim_copy(boost::to_lower_copy((*it)["VALUE"].str())));
918 else if(value == "dvcpro")
921 options.push_back(option(name, value));
924 return spl::make_shared<ffmpeg_consumer_proxy>(path["PATH"].str(), options, separate_key);
927 spl::shared_ptr<core::frame_consumer> create_preconfigured_consumer(
928 const boost::property_tree::wptree& ptree, core::interaction_sink*)
930 auto filename = ptree_get<std::wstring>(ptree, L"path");
931 auto codec = ptree.get(L"vcodec", L"libx264");
932 auto separate_key = ptree.get(L"separate-key", false);
934 std::vector<option> options;
935 options.push_back(option("vcodec", u8(codec)));
937 return spl::make_shared<ffmpeg_consumer_proxy>(filename, options, separate_key);