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/mixer/audio/audio_util.h>
32 #include <core/consumer/frame_consumer.h>
33 #include <core/video_format.h>
34 #include <core/help/help_repository.h>
35 #include <core/help/help_sink.h>
37 #include <common/array.h>
38 #include <common/env.h>
39 #include <common/except.h>
40 #include <common/executor.h>
41 #include <common/future.h>
42 #include <common/diagnostics/graph.h>
43 #include <common/lock.h>
44 #include <common/memory.h>
45 #include <common/param.h>
46 #include <common/utf.h>
47 #include <common/assert.h>
48 #include <common/memshfl.h>
49 #include <common/timer.h>
51 #include <boost/algorithm/string.hpp>
52 #include <boost/property_tree/ptree.hpp>
53 #include <boost/filesystem.hpp>
54 #include <boost/range/algorithm.hpp>
55 #include <boost/range/algorithm_ext.hpp>
56 #include <boost/lexical_cast.hpp>
58 #include <tbb/spin_mutex.h>
64 #pragma warning (push)
65 #pragma warning (disable : 4244)
69 #define __STDC_CONSTANT_MACROS
70 #define __STDC_LIMIT_MACROS
71 #include <libavformat/avformat.h>
72 #include <libswscale/swscale.h>
73 #include <libavutil/opt.h>
74 #include <libavutil/pixdesc.h>
75 #include <libavutil/parseutils.h>
76 #include <libavutil/samplefmt.h>
77 #include <libswresample/swresample.h>
83 namespace caspar { namespace ffmpeg {
85 int av_opt_set(void *obj, const char *name, const char *val, int search_flags)
87 AVClass* av_class = *(AVClass**)obj;
89 if((strcmp(name, "pix_fmt") == 0 || strcmp(name, "pixel_format") == 0) && strcmp(av_class->class_name, "AVCodecContext") == 0)
91 AVCodecContext* c = (AVCodecContext*)obj;
92 auto pix_fmt = av_get_pix_fmt(val);
93 if(pix_fmt == PIX_FMT_NONE)
98 //if((strcmp(name, "r") == 0 || strcmp(name, "frame_rate") == 0) && strcmp(av_class->class_name, "AVCodecContext") == 0)
100 // AVCodecContext* c = (AVCodecContext*)obj;
102 // if(c->codec_type != AVMEDIA_TYPE_VIDEO)
106 // int ret = av_parse_video_rate(&rate, val);
110 // c->time_base.num = rate.den;
111 // c->time_base.den = rate.num;
115 return ::av_opt_set(obj, name, val, search_flags);
123 option(std::string name, std::string value)
124 : name(std::move(name))
125 , value(std::move(value))
132 AVOutputFormat* format;
140 output_format(const core::video_format_desc& format_desc, const std::string& filename, std::vector<option>& options)
141 : format(av_guess_format(nullptr, filename.c_str(), nullptr))
142 , width(format_desc.width)
143 , height(format_desc.height)
144 , vcodec(CODEC_ID_NONE)
145 , acodec(CODEC_ID_NONE)
149 if(boost::iequals(boost::filesystem::path(filename).extension().string(), ".dv"))
152 boost::range::remove_erase_if(options, [&](const option& o)
154 return set_opt(o.name, o.value);
157 if(vcodec == CODEC_ID_NONE && format)
158 vcodec = format->video_codec;
160 if(acodec == CODEC_ID_NONE && format)
161 acodec = format->audio_codec;
163 if(vcodec == CODEC_ID_NONE)
164 vcodec = CODEC_ID_H264;
166 if(acodec == CODEC_ID_NONE)
167 acodec = CODEC_ID_PCM_S16LE;
170 bool set_opt(const std::string& name, const std::string& value)
172 //if(name == "target")
174 // enum { PAL, NTSC, FILM, UNKNOWN } norm = UNKNOWN;
176 // if(name.find("pal-") != std::string::npos)
178 // else if(name.find("ntsc-") != std::string::npos)
181 // if(norm == UNKNOWN)
182 // CASPAR_THROW_EXCEPTION(invalid_argument() << arg_name_info("target"));
184 // if (name.find("-dv") != std::string::npos)
186 // set_opt("f", "dv");
189 // set_opt("s", "720x576");
193 // set_opt("s", "720x480");
196 // set_opt("croptop", "2");
197 // set_opt("cropbot", "4");
200 // set_opt("s", norm == PAL ? "720x576" : "720x480");
208 format = av_guess_format(value.c_str(), nullptr, nullptr);
210 if(format == nullptr)
211 CASPAR_THROW_EXCEPTION(invalid_argument() << arg_name_info("f"));
215 else if(name == "vcodec" || name == "v:codec")
217 auto c = avcodec_find_encoder_by_name(value.c_str());
219 CASPAR_THROW_EXCEPTION(invalid_argument() << arg_name_info("vcodec"));
221 vcodec = avcodec_find_encoder_by_name(value.c_str())->id;
225 else if(name == "acodec" || name == "a:codec")
227 auto c = avcodec_find_encoder_by_name(value.c_str());
229 CASPAR_THROW_EXCEPTION(invalid_argument() << arg_name_info("acodec"));
231 acodec = avcodec_find_encoder_by_name(value.c_str())->id;
237 if(av_parse_video_size(&width, &height, value.c_str()) < 0)
238 CASPAR_THROW_EXCEPTION(invalid_argument() << arg_name_info("s"));
242 else if(name == "croptop")
244 croptop = boost::lexical_cast<int>(value);
248 else if(name == "cropbot")
250 cropbot = boost::lexical_cast<int>(value);
259 typedef cache_aligned_vector<uint8_t> byte_vector;
261 struct ffmpeg_consumer : boost::noncopyable
263 const spl::shared_ptr<diagnostics::graph> graph_;
264 const std::string filename_;
265 const std::shared_ptr<AVFormatContext> oc_ { avformat_alloc_context(), av_free };
266 const core::video_format_desc format_desc_;
268 core::monitor::subject monitor_subject_;
270 tbb::spin_mutex exception_mutex_;
271 std::exception_ptr exception_;
273 std::shared_ptr<AVStream> audio_st_;
274 std::shared_ptr<AVStream> video_st_;
276 byte_vector picture_buffer_;
277 byte_vector key_picture_buf_;
278 byte_vector audio_buffer_;
279 std::shared_ptr<SwrContext> swr_;
280 std::shared_ptr<SwsContext> sws_;
282 int64_t frame_number_ = 0;
284 output_format output_format_;
289 ffmpeg_consumer(const std::string& filename, const core::video_format_desc& format_desc, std::vector<option> options, bool key_only)
290 : filename_(filename)
291 , format_desc_(format_desc)
292 , output_format_(format_desc, filename, options)
293 , key_only_(key_only)
298 // TODO: Ask stakeholders about case where file already exists.
299 boost::filesystem::remove(boost::filesystem::path(env::media_folder() + u16(filename))); // Delete the file if it exists
301 graph_->set_color("frame-time", diagnostics::color(0.1f, 1.0f, 0.1f));
302 graph_->set_color("dropped-frame", diagnostics::color(0.3f, 0.6f, 0.3f));
303 graph_->set_text(print());
304 diagnostics::register_graph(graph_);
306 executor_.set_capacity(8);
308 oc_->oformat = output_format_.format;
310 std::strcpy(oc_->filename, filename_.c_str());
312 // Add the audio and video streams using the default format codecs and initialize the codecs.
313 video_st_ = add_video_stream(options);
316 audio_st_ = add_audio_stream(options);
318 av_dump_format(oc_.get(), 0, filename_.c_str(), 1);
320 // Open the output ffmpeg, if needed.
321 if (!(oc_->oformat->flags & AVFMT_NOFILE))
322 THROW_ON_ERROR2(avio_open(&oc_->pb, filename.c_str(), AVIO_FLAG_WRITE), "[ffmpeg_consumer]");
324 THROW_ON_ERROR2(avformat_write_header(oc_.get(), nullptr), "[ffmpeg_consumer]");
326 if(options.size() > 0)
328 for (auto& option : options)
329 CASPAR_LOG(warning) << L"Invalid option: -" << u16(option.name) << L" " << u16(option.value);
332 CASPAR_LOG(info) << print() << L" Successfully Initialized.";
343 CASPAR_LOG_CURRENT_EXCEPTION();
346 LOG_ON_ERROR2(av_write_trailer(oc_.get()), "[ffmpeg_consumer]");
353 if (!(oc_->oformat->flags & AVFMT_NOFILE))
354 LOG_ON_ERROR2(avio_close(oc_->pb), "[ffmpeg_consumer]");
356 CASPAR_LOG(info) << print() << L" Successfully Uninitialized.";
361 void send(core::const_frame& frame)
363 auto exception = lock(exception_mutex_, [&]
368 if(exception != nullptr)
369 std::rethrow_exception(exception);
371 executor_.begin_invoke([=]
377 bool ready_for_frame() const
379 return !executor_.is_full();
384 graph_->set_tag("dropped-frame");
387 std::wstring print() const
389 return L"ffmpeg[" + u16(filename_) + L"]";
392 core::monitor::subject& monitor_output()
394 return monitor_subject_;
398 std::shared_ptr<AVStream> add_video_stream(std::vector<option>& options)
400 if(output_format_.vcodec == CODEC_ID_NONE)
403 auto st = av_new_stream(oc_.get(), 0);
405 CASPAR_THROW_EXCEPTION(caspar_exception() << msg_info("Could not allocate video-stream.") << boost::errinfo_api_function("av_new_stream"));
407 auto encoder = avcodec_find_encoder(output_format_.vcodec);
409 CASPAR_THROW_EXCEPTION(caspar_exception() << msg_info("Codec not found."));
413 avcodec_get_context_defaults3(c, encoder);
415 c->codec_id = output_format_.vcodec;
416 c->codec_type = AVMEDIA_TYPE_VIDEO;
417 c->width = output_format_.width;
418 c->height = output_format_.height - output_format_.croptop - output_format_.cropbot;
419 c->time_base.den = format_desc_.time_scale;
420 c->time_base.num = format_desc_.duration;
422 c->flags |= format_desc_.field_mode == core::field_mode::progressive ? 0 : (CODEC_FLAG_INTERLACED_ME | CODEC_FLAG_INTERLACED_DCT);
423 c->pix_fmt = c->pix_fmt != PIX_FMT_NONE ? c->pix_fmt : PIX_FMT_YUV420P;
425 if(c->codec_id == CODEC_ID_PRORES)
427 c->bit_rate = output_format_.width < 1280 ? 63*1000000 : 220*1000000;
428 c->pix_fmt = PIX_FMT_YUV422P10;
430 else if(c->codec_id == CODEC_ID_DNXHD)
432 if(c->width < 1280 || c->height < 720)
433 CASPAR_THROW_EXCEPTION(caspar_exception() << msg_info("Unsupported video dimensions."));
435 c->bit_rate = 220*1000000;
436 c->pix_fmt = PIX_FMT_YUV422P;
438 else if(c->codec_id == CODEC_ID_DVVIDEO)
440 c->width = c->height == 1280 ? 960 : c->width;
442 if(format_desc_.format == core::video_format::ntsc)
444 c->pix_fmt = PIX_FMT_YUV411P;
445 output_format_.croptop = 2;
446 output_format_.cropbot = 4;
447 c->height = output_format_.height - output_format_.croptop - output_format_.cropbot;
449 else if(format_desc_.format == core::video_format::pal)
450 c->pix_fmt = PIX_FMT_YUV420P;
452 c->pix_fmt = PIX_FMT_YUV422P;
454 if(format_desc_.duration == 1001)
455 c->width = c->height == 1080 ? 1280 : c->width;
457 c->width = c->height == 1080 ? 1440 : c->width;
459 else if(c->codec_id == CODEC_ID_H264)
461 c->pix_fmt = PIX_FMT_YUV420P;
462 av_opt_set(c->priv_data, "preset", "ultrafast", 0);
463 av_opt_set(c->priv_data, "tune", "fastdecode", 0);
464 av_opt_set(c->priv_data, "crf", "5", 0);
466 else if(c->codec_id == CODEC_ID_QTRLE)
468 c->pix_fmt = PIX_FMT_ARGB;
471 boost::range::remove_erase_if(options, [&](const option& o)
473 return o.name.at(0) != 'a' && ffmpeg::av_opt_set(c, o.name.c_str(), o.value.c_str(), AV_OPT_SEARCH_CHILDREN) > -1;
476 if(output_format_.format->flags & AVFMT_GLOBALHEADER)
477 c->flags |= CODEC_FLAG_GLOBAL_HEADER;
479 THROW_ON_ERROR2(tbb_avcodec_open(c, encoder), "[ffmpeg_consumer]");
481 return std::shared_ptr<AVStream>(st, [](AVStream* st)
483 LOG_ON_ERROR2(tbb_avcodec_close(st->codec), "[ffmpeg_consumer]");
484 av_freep(&st->codec);
489 std::shared_ptr<AVStream> add_audio_stream(std::vector<option>& options)
491 if(output_format_.acodec == CODEC_ID_NONE)
494 auto st = av_new_stream(oc_.get(), 1);
496 CASPAR_THROW_EXCEPTION(caspar_exception() << msg_info("Could not allocate audio-stream") << boost::errinfo_api_function("av_new_stream"));
498 auto encoder = avcodec_find_encoder(output_format_.acodec);
500 CASPAR_THROW_EXCEPTION(caspar_exception() << msg_info("codec not found"));
504 avcodec_get_context_defaults3(c, encoder);
506 c->codec_id = output_format_.acodec;
507 c->codec_type = AVMEDIA_TYPE_AUDIO;
508 c->sample_rate = 48000;
510 c->sample_fmt = AV_SAMPLE_FMT_S16;
511 c->time_base.num = 1;
512 c->time_base.den = c->sample_rate;
514 if(output_format_.vcodec == CODEC_ID_FLV1)
515 c->sample_rate = 44100;
517 if(output_format_.format->flags & AVFMT_GLOBALHEADER)
518 c->flags |= CODEC_FLAG_GLOBAL_HEADER;
520 boost::range::remove_erase_if(options, [&](const option& o)
522 return ffmpeg::av_opt_set(c, o.name.c_str(), o.value.c_str(), AV_OPT_SEARCH_CHILDREN) > -1;
525 THROW_ON_ERROR2(avcodec_open2(c, encoder, nullptr), "[ffmpeg_consumer]");
527 return std::shared_ptr<AVStream>(st, [](AVStream* st)
529 LOG_ON_ERROR2(avcodec_close(st->codec), "[ffmpeg_consumer]");;
530 av_freep(&st->codec);
535 void encode_video_frame(core::const_frame frame)
540 auto enc = video_st_->codec;
542 auto av_frame = convert_video(frame, enc);
543 av_frame->interlaced_frame = format_desc_.field_mode != core::field_mode::progressive;
544 av_frame->top_field_first = format_desc_.field_mode == core::field_mode::upper;
545 av_frame->pts = frame_number_++;
547 monitor_subject_ << core::monitor::message("/frame")
548 % static_cast<int64_t>(frame_number_)
549 % static_cast<int64_t>(std::numeric_limits<int64_t>::max());
552 av_init_packet(&pkt);
557 THROW_ON_ERROR2(avcodec_encode_video2(enc, &pkt, av_frame.get(), &got_packet), "[ffmpeg_consumer]");
558 std::shared_ptr<AVPacket> guard(&pkt, av_free_packet);
563 if (pkt.pts != AV_NOPTS_VALUE)
564 pkt.pts = av_rescale_q(pkt.pts, enc->time_base, video_st_->time_base);
565 if (pkt.dts != AV_NOPTS_VALUE)
566 pkt.dts = av_rescale_q(pkt.dts, enc->time_base, video_st_->time_base);
568 pkt.stream_index = video_st_->index;
570 THROW_ON_ERROR2(av_interleaved_write_frame(oc_.get(), &pkt), "[ffmpeg_consumer]");
573 uint64_t get_channel_layout(AVCodecContext* dec)
575 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);
579 void encode_audio_frame(core::const_frame frame)
584 auto enc = audio_st_->codec;
586 boost::push_back(audio_buffer_, convert_audio(frame, enc));
588 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());
590 while(audio_buffer_.size() >= frame_size)
592 std::shared_ptr<AVFrame> av_frame(avcodec_alloc_frame(), av_free);
593 avcodec_get_frame_defaults(av_frame.get());
594 av_frame->nb_samples = frame_size / (enc->channels * av_get_bytes_per_sample(enc->sample_fmt));
597 av_init_packet(&pkt);
601 THROW_ON_ERROR2(avcodec_fill_audio_frame(av_frame.get(), enc->channels, enc->sample_fmt, audio_buffer_.data(), frame_size, 1), "[ffmpeg_consumer]");
604 THROW_ON_ERROR2(avcodec_encode_audio2(enc, &pkt, av_frame.get(), &got_packet), "[ffmpeg_consumer]");
605 std::shared_ptr<AVPacket> guard(&pkt, av_free_packet);
607 audio_buffer_.erase(audio_buffer_.begin(), audio_buffer_.begin() + frame_size);
612 if (pkt.pts != AV_NOPTS_VALUE)
613 pkt.pts = av_rescale_q(pkt.pts, enc->time_base, audio_st_->time_base);
614 if (pkt.dts != AV_NOPTS_VALUE)
615 pkt.dts = av_rescale_q(pkt.dts, enc->time_base, audio_st_->time_base);
616 if (pkt.duration > 0)
617 pkt.duration = static_cast<int>(av_rescale_q(pkt.duration, enc->time_base, audio_st_->time_base));
619 pkt.stream_index = audio_st_->index;
621 THROW_ON_ERROR2(av_interleaved_write_frame(oc_.get(), &pkt), "[ffmpeg_consumer]");
625 std::shared_ptr<AVFrame> convert_video(core::const_frame frame, AVCodecContext* c)
629 sws_.reset(sws_getContext(format_desc_.width,
630 format_desc_.height - output_format_.croptop - output_format_.cropbot,
635 SWS_BICUBIC, nullptr, nullptr, nullptr),
638 CASPAR_THROW_EXCEPTION(caspar_exception() << msg_info("Cannot initialize the conversion context"));
643 std::shared_ptr<AVFrame> in_frame(avcodec_alloc_frame(), av_free);
645 auto in_picture = reinterpret_cast<AVPicture*>(in_frame.get());
649 key_picture_buf_.resize(frame.image_data().size());
650 in_picture->linesize[0] = format_desc_.width * 4;
651 in_picture->data[0] = key_picture_buf_.data();
653 aligned_memshfl(in_picture->data[0], frame.image_data().begin(), frame.image_data().size(), 0x0F0F0F0F, 0x0B0B0B0B, 0x07070707, 0x03030303);
659 const_cast<uint8_t*>(frame.image_data().begin()),
662 format_desc_.height - output_format_.croptop - output_format_.cropbot);
667 for(int n = 0; n < 4; ++n)
668 in_frame->data[n] += in_frame->linesize[n] * output_format_.croptop;
672 std::shared_ptr<AVFrame> out_frame(avcodec_alloc_frame(), av_free);
674 av_image_fill_linesizes(out_frame->linesize, c->pix_fmt, c->width);
675 for(int n = 0; n < 4; ++n)
676 out_frame->linesize[n] += 32 - (out_frame->linesize[n] % 32); // align
678 picture_buffer_.resize(av_image_fill_pointers(out_frame->data, c->pix_fmt, c->height, nullptr, out_frame->linesize));
679 av_image_fill_pointers(out_frame->data, c->pix_fmt, c->height, picture_buffer_.data(), out_frame->linesize);
683 sws_scale(sws_.get(),
687 format_desc_.height - output_format_.cropbot - output_format_.croptop,
689 out_frame->linesize);
694 byte_vector convert_audio(core::const_frame& frame, AVCodecContext* c)
698 swr_ = std::shared_ptr<SwrContext>(swr_alloc_set_opts(nullptr,
699 get_channel_layout(c), c->sample_fmt, c->sample_rate,
700 av_get_default_channel_layout(format_desc_.audio_channels), AV_SAMPLE_FMT_S32, format_desc_.audio_sample_rate,
701 0, nullptr), [](SwrContext* p){swr_free(&p);});
704 CASPAR_THROW_EXCEPTION(bad_alloc());
706 THROW_ON_ERROR2(swr_init(swr_.get()), "[audio_decoder]");
709 byte_vector buffer(48000);
711 const uint8_t* in[] = {reinterpret_cast<const uint8_t*>(frame.audio_data().data())};
712 uint8_t* out[] = {buffer.data()};
714 auto channel_samples = swr_convert(swr_.get(),
715 out, static_cast<int>(buffer.size()) / c->channels / av_get_bytes_per_sample(c->sample_fmt),
716 in, static_cast<int>(frame.audio_data().size()/format_desc_.audio_channels));
718 buffer.resize(channel_samples * c->channels * av_get_bytes_per_sample(c->sample_fmt));
725 auto space = boost::filesystem::space(boost::filesystem::path(filename_).parent_path());
726 if(space.available < 512*1000000)
727 BOOST_THROW_EXCEPTION(file_write_error() << msg_info("out of space"));
730 void encode(const core::const_frame& frame)
734 if(frame_number_ % 25 == 0)
737 caspar::timer frame_timer;
739 encode_video_frame(frame);
740 encode_audio_frame(frame);
742 graph_->set_value("frame-time", frame_timer.elapsed()*format_desc_.fps*0.5);
746 lock(exception_mutex_, [&]
748 exception_ = std::current_exception();
754 struct ffmpeg_consumer_proxy : public core::frame_consumer
756 const std::wstring filename_;
757 const std::vector<option> options_;
758 const bool separate_key_;
760 std::unique_ptr<ffmpeg_consumer> consumer_;
761 std::unique_ptr<ffmpeg_consumer> key_only_consumer_;
765 ffmpeg_consumer_proxy(const std::wstring& filename, const std::vector<option>& options, bool separate_key)
766 : filename_(filename)
768 , separate_key_(separate_key_)
772 virtual void initialize(const core::video_format_desc& format_desc, int)
775 BOOST_THROW_EXCEPTION(invalid_operation() << msg_info("Cannot reinitialize ffmpeg-consumer."));
777 consumer_.reset(new ffmpeg_consumer(u8(filename_), format_desc, options_, false));
781 boost::filesystem::path fill_file(filename_);
782 auto without_extension = u16(fill_file.stem().string());
783 auto key_file = env::media_folder() + without_extension + L"_A" + u16(fill_file.extension().string());
785 key_only_consumer_.reset(new ffmpeg_consumer(u8(key_file), format_desc, options_, true));
789 std::future<bool> send(core::const_frame frame) override
791 bool ready_for_frame = consumer_->ready_for_frame();
793 if (ready_for_frame && separate_key_)
794 ready_for_frame = ready_for_frame && key_only_consumer_->ready_for_frame();
798 consumer_->send(frame);
801 key_only_consumer_->send(frame);
805 consumer_->mark_dropped();
808 key_only_consumer_->mark_dropped();
811 return make_ready_future(true);
814 std::wstring print() const override
816 return consumer_ ? consumer_->print() : L"[ffmpeg_consumer]";
819 std::wstring name() const override
824 boost::property_tree::wptree info() const override
826 boost::property_tree::wptree info;
827 info.add(L"type", L"file");
828 info.add(L"filename", filename_);
829 info.add(L"separate_key", separate_key_);
833 bool has_synchronization_clock() const override
838 int buffer_depth() const override
843 int index() const override
848 core::monitor::subject& monitor_output()
850 return consumer_->monitor_output();
854 void describe_consumer(core::help_sink& sink, const core::help_repository& repo)
856 sink.short_description(L"Can record a channel to a file supported by FFMpeg.");
857 sink.syntax(L"FILE [filename:string] {-[ffmpeg_param1:string] [value1:string] {-[ffmpeg_param2:string] [value2:string] {...}}} {[separate_key:SEPARATE_KEY]}");
858 sink.para()->text(L"Can record a channel to a file supported by FFMpeg.");
860 ->item(L"filename", L"The filename under the media folder including the extension (decides which kind of container format that will be used).")
861 ->item(L"ffmpeg_paramX", L"A parameter supported by FFMpeg. For example vcodec or acodec etc.")
862 ->item(L"separate_key", L"If defined will create two files simultaneously -- One for fill and one for key (_A will be appended).")
864 sink.para()->text(L"Examples:");
865 sink.example(L">> ADD 1 FILE output.mov -vcodec dnxhd");
866 sink.example(L">> ADD 1 FILE output.mov -vcodec prores");
867 sink.example(L">> ADD 1 FILE output.mov -vcodec dvvideo");
868 sink.example(L">> ADD 1 FILE output.mov - vcodec libx264 -preset ultrafast -tune fastdecode -crf 25");
869 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");
872 spl::shared_ptr<core::frame_consumer> create_consumer(
873 const std::vector<std::wstring>& params, core::interaction_sink*)
875 auto params2 = params;
876 auto separate_key_it = std::find_if(params2.begin(), params2.end(), param_comparer(L"SEPARATE_KEY"));
877 bool separate_key = false;
879 if (separate_key_it != params2.end())
882 params2.erase(separate_key_it);
885 auto str = std::accumulate(params2.begin(), params2.end(), std::wstring(), [](const std::wstring& lhs, const std::wstring& rhs) {return lhs + L" " + rhs;});
887 boost::wregex path_exp(LR"(\s*FILE(\s(?<PATH>.+\.[^\s]+))?.*)", boost::regex::icase);
890 if(!boost::regex_match(str, path, path_exp))
891 return core::frame_consumer::empty();
893 boost::wregex opt_exp(LR"(-((?<NAME>[^\s]+)\s+(?<VALUE>[^\s]+)))");
895 std::vector<option> options;
896 for(boost::wsregex_iterator it(str.begin(), str.end(), opt_exp); it != boost::wsregex_iterator(); ++it)
898 auto name = u8(boost::trim_copy(boost::to_lower_copy((*it)["NAME"].str())));
899 auto value = u8(boost::trim_copy(boost::to_lower_copy((*it)["VALUE"].str())));
903 else if(value == "dvcpro")
906 options.push_back(option(name, value));
909 return spl::make_shared<ffmpeg_consumer_proxy>(env::media_folder() + path["PATH"].str(), options, separate_key);
912 spl::shared_ptr<core::frame_consumer> create_preconfigured_consumer(
913 const boost::property_tree::wptree& ptree, core::interaction_sink*)
915 auto filename = ptree.get<std::wstring>(L"path");
916 auto codec = ptree.get(L"vcodec", L"libx264");
917 auto separate_key = ptree.get(L"separate-key", false);
919 std::vector<option> options;
920 options.push_back(option("vcodec", u8(codec)));
922 return spl::make_shared<ffmpeg_consumer_proxy>(env::media_folder() + filename, options, separate_key);