2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
\r
4 * This file is part of CasparCG (www.casparcg.com).
\r
6 * CasparCG is free software: you can redistribute it and/or modify
\r
7 * it under the terms of the GNU General Public License as published by
\r
8 * the Free Software Foundation, either version 3 of the License, or
\r
9 * (at your option) any later version.
\r
11 * CasparCG is distributed in the hope that it will be useful,
\r
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
\r
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
\r
14 * GNU General Public License for more details.
\r
16 * You should have received a copy of the GNU General Public License
\r
17 * along with CasparCG. If not, see <http://www.gnu.org/licenses/>.
\r
19 * Author: Robert Nagy, ronag89@gmail.com
\r
22 #include "../StdAfx.h"
\r
24 #include "../ffmpeg_error.h"
\r
26 #include "ffmpeg_consumer.h"
\r
28 #include <core/mixer/read_frame.h>
\r
29 #include <core/mixer/audio/audio_util.h>
\r
30 #include <core/consumer/frame_consumer.h>
\r
31 #include <core/video_format.h>
\r
33 #include <common/concurrency/executor.h>
\r
34 #include <common/diagnostics/graph.h>
\r
35 #include <common/env.h>
\r
36 #include <common/utility/string.h>
\r
37 #include <common/utility/param.h>
\r
39 #include <boost/algorithm/string.hpp>
\r
40 #include <boost/timer.hpp>
\r
41 #include <boost/property_tree/ptree.hpp>
\r
43 #include <tbb/cache_aligned_allocator.h>
\r
44 #include <tbb/parallel_invoke.h>
\r
48 #if defined(_MSC_VER)
\r
49 #pragma warning (push)
\r
50 #pragma warning (disable : 4244)
\r
54 #define __STDC_CONSTANT_MACROS
\r
55 #define __STDC_LIMIT_MACROS
\r
56 #include <libavformat/avformat.h>
\r
57 #include <libswscale/swscale.h>
\r
58 #include <libavutil/opt.h>
\r
59 #include <libavutil/pixdesc.h>
\r
61 #if defined(_MSC_VER)
\r
62 #pragma warning (pop)
\r
65 namespace caspar { namespace ffmpeg {
\r
72 option(std::string name, std::string value)
\r
73 : name(std::move(name))
\r
74 , value(std::move(value))
\r
79 void set_format(AVOutputFormat*& format, const std::string& value)
\r
81 format = av_guess_format(value.c_str(), nullptr, nullptr);
\r
83 if(format == nullptr)
\r
84 BOOST_THROW_EXCEPTION(invalid_argument() << arg_name_info("f"));
\r
87 bool parse_format(AVOutputFormat*& format, std::vector<option>& options)
\r
89 auto format_it = std::find_if(options.begin(), options.end(), [](const option& o)
\r
91 return o.name == "f" || o.name == "format";
\r
94 if(format_it == options.end())
\r
97 set_format(format, format_it->value);
\r
99 options.erase(format_it);
\r
104 void set_vcodec(CodecID& vcodec, const std::string& value)
\r
106 vcodec = avcodec_find_encoder_by_name(value.c_str())->id;
\r
107 if(vcodec == CODEC_ID_NONE)
\r
108 BOOST_THROW_EXCEPTION(invalid_argument() << arg_name_info("vcodec"));
\r
111 bool parse_vcodec(CodecID& vcodec, std::vector<option>& options)
\r
113 auto vcodec_it = std::find_if(options.begin(), options.end(), [](const option& o)
\r
115 return o.name == "vcodec";
\r
118 if(vcodec_it == options.end())
\r
121 set_vcodec(vcodec, vcodec_it->value);
\r
123 options.erase(vcodec_it);
\r
128 void set_pix_fmt(AVCodecContext* vcodec, const std::string& value)
\r
130 auto pix_fmt = av_get_pix_fmt(value.c_str());
\r
131 if(pix_fmt == PIX_FMT_NONE)
\r
132 BOOST_THROW_EXCEPTION(invalid_argument() << arg_name_info("pix_fmt"));
\r
134 vcodec->pix_fmt = pix_fmt;
\r
137 bool parse_pix_fmt(AVCodecContext* vcodec, std::vector<option>& options)
\r
139 auto pix_fmt_it = std::find_if(options.begin(), options.end(), [](const option& o)
\r
141 return o.name == "pix_fmt" || o.name == "pixel_format";
\r
144 if(pix_fmt_it == options.end())
\r
147 set_pix_fmt(vcodec, pix_fmt_it->value);
\r
149 options.erase(pix_fmt_it);
\r
154 struct ffmpeg_consumer : boost::noncopyable
\r
156 const std::string filename_;
\r
158 const std::shared_ptr<AVFormatContext> oc_;
\r
159 const core::video_format_desc format_desc_;
\r
161 const safe_ptr<diagnostics::graph> graph_;
\r
162 boost::timer frame_timer_;
\r
163 boost::timer write_timer_;
\r
165 executor executor_;
\r
166 executor file_write_executor_;
\r
169 std::shared_ptr<AVStream> audio_st_;
\r
172 std::shared_ptr<AVStream> video_st_;
\r
174 std::vector<uint8_t> video_outbuf_;
\r
175 std::vector<uint8_t> picture_buf_;
\r
176 std::shared_ptr<SwsContext> sws_;
\r
178 int64_t frame_number_;
\r
181 ffmpeg_consumer(const std::string& filename, const core::video_format_desc& format_desc, std::vector<option> options)
\r
182 : filename_(filename)
\r
183 , video_outbuf_(1920*1080*8)
\r
184 , oc_(avformat_alloc_context(), av_free)
\r
185 , format_desc_(format_desc)
\r
186 , executor_(print())
\r
187 , file_write_executor_(print() + L"/output")
\r
190 // TODO: Ask stakeholders about case where file already exists.
\r
191 boost::filesystem2::remove(boost::filesystem2::wpath(env::media_folder() + widen(filename))); // Delete the file if it exists
\r
193 graph_->set_color("frame-time", diagnostics::color(0.1f, 1.0f, 0.1f));
\r
194 graph_->set_color("write-time", diagnostics::color(0.5f, 0.5f, 0.1f));
\r
195 graph_->set_text(print());
\r
196 diagnostics::register_graph(graph_);
\r
198 executor_.set_capacity(8);
\r
199 file_write_executor_.set_capacity(8);
\r
201 oc_->oformat = av_guess_format(nullptr, filename_.c_str(), nullptr);
\r
203 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info("Could not find suitable output format."));
\r
205 parse_format(oc_->oformat, options);
\r
207 auto vcodec = oc_->oformat->video_codec;
\r
208 parse_vcodec(vcodec, options);
\r
210 THROW_ON_ERROR2(av_set_parameters(oc_.get(), nullptr), "[ffmpeg_consumer]");
\r
212 strcpy_s(oc_->filename, filename_.c_str());
\r
214 // Add the audio and video streams using the default format codecs and initialize the codecs .
\r
215 video_st_ = add_video_stream(vcodec, options);
\r
216 audio_st_ = add_audio_stream();
\r
218 dump_format(oc_.get(), 0, filename_.c_str(), 1);
\r
220 // Open the output ffmpeg, if needed.
\r
221 if (!(oc_->oformat->flags & AVFMT_NOFILE))
\r
222 THROW_ON_ERROR2(avio_open(&oc_->pb, filename_.c_str(), URL_WRONLY), "[ffmpeg_consumer]");
\r
224 THROW_ON_ERROR2(av_write_header(oc_.get()), "[ffmpeg_consumer]");
\r
226 CASPAR_LOG(info) << print() << L" Successfully Initialized.";
\r
234 file_write_executor_.stop();
\r
235 file_write_executor_.join();
\r
237 LOG_ON_ERROR2(av_write_trailer(oc_.get()), "[ffmpeg_consumer]");
\r
242 if (!(oc_->oformat->flags & AVFMT_NOFILE))
\r
243 LOG_ON_ERROR2(avio_close(oc_->pb), "[ffmpeg_consumer]"); // Close the output ffmpeg.
\r
245 CASPAR_LOG(info) << print() << L" Successfully Uninitialized.";
\r
248 std::wstring print() const
\r
250 return L"ffmpeg[" + widen(filename_) + L"]";
\r
253 std::shared_ptr<AVStream> add_video_stream(CodecID vcodec, std::vector<option>& options)
\r
255 auto st = av_new_stream(oc_.get(), 0);
\r
257 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info("Could not allocate video-stream") << boost::errinfo_api_function("av_new_stream"));
\r
259 auto encoder = avcodec_find_encoder(vcodec);
\r
261 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info("codec not found"));
\r
263 auto c = st->codec;
\r
265 avcodec_get_context_defaults3(c, encoder);
\r
267 c->codec_id = vcodec;
\r
268 c->codec_type = AVMEDIA_TYPE_VIDEO;
\r
269 c->width = format_desc_.width;
\r
270 c->height = format_desc_.height;
\r
271 c->time_base.den = format_desc_.time_scale;
\r
272 c->time_base.num = format_desc_.duration;
\r
274 c->flags |= format_desc_.field_mode == core::field_mode::progressive ? 0 : (CODEC_FLAG_INTERLACED_ME | CODEC_FLAG_INTERLACED_DCT);
\r
276 if(c->codec_id == CODEC_ID_PRORES)
\r
278 c->bit_rate = format_desc_.width < 1280 ? 63*1000000 : 220*1000000;
\r
279 c->pix_fmt = PIX_FMT_YUV422P10;
\r
281 else if(c->codec_id == CODEC_ID_DNXHD)
\r
283 if(format_desc_.width < 1280 || format_desc_.height < 720)
\r
284 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info("unsupported dimension"));
\r
286 c->bit_rate = 220*1000000;
\r
287 c->pix_fmt = PIX_FMT_YUV422P;
\r
289 else if(c->codec_id == CODEC_ID_DVVIDEO)
\r
291 c->bit_rate = format_desc_.width < 1280 ? 50*1000000 : 100*1000000;
\r
292 c->width = format_desc_.height == 1280 ? 960 : c->width;
\r
294 if(format_desc_.format == core::video_format::ntsc)
\r
295 c->pix_fmt = PIX_FMT_YUV411P;
\r
296 else if(format_desc_.format == core::video_format::pal)
\r
297 c->pix_fmt = PIX_FMT_YUV420P;
\r
299 if(c->bit_rate >= 50*1000000) // dv50
\r
300 c->pix_fmt = PIX_FMT_YUV422P;
\r
302 if(format_desc_.duration == 1001)
\r
303 c->width = format_desc_.height == 1080 ? 1280 : c->width;
\r
305 c->width = format_desc_.height == 1080 ? 1440 : c->width;
\r
307 else if(c->codec_id == CODEC_ID_H264)
\r
309 c->pix_fmt = PIX_FMT_YUV420P;
\r
310 if(options.empty())
\r
312 av_opt_set(c->priv_data, "preset", "ultrafast", 0);
\r
313 av_opt_set(c->priv_data, "tune", "fastdecode", 0);
\r
314 av_opt_set(c->priv_data, "crf", "5", 0);
\r
317 else if(c->codec_id == CODEC_ID_QTRLE)
\r
319 c->pix_fmt = PIX_FMT_ARGB;
\r
323 BOOST_THROW_EXCEPTION(invalid_argument() << msg_info("Unsupported output parameters."));
\r
326 parse_pix_fmt(c, options);
\r
328 c->max_b_frames = 0; // b-frames not supported.
\r
330 BOOST_FOREACH(auto& option, options)
\r
331 THROW_ON_ERROR2(av_opt_set(c, option.name.c_str(), option.value.c_str(), AV_OPT_SEARCH_CHILDREN), "[ffmpeg_consumer]");
\r
333 if(oc_->oformat->flags & AVFMT_GLOBALHEADER)
\r
334 c->flags |= CODEC_FLAG_GLOBAL_HEADER;
\r
336 c->thread_count = boost::thread::hardware_concurrency();
\r
337 THROW_ON_ERROR2(avcodec_open(c, encoder), "[ffmpeg_consumer]");
\r
339 return std::shared_ptr<AVStream>(st, [](AVStream* st)
\r
341 LOG_ON_ERROR2(avcodec_close(st->codec), "[ffmpeg_consumer]");
\r
342 av_freep(&st->codec);
\r
347 std::shared_ptr<AVStream> add_audio_stream()
\r
349 auto st = av_new_stream(oc_.get(), 1);
\r
351 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info("Could not allocate audio-stream") << boost::errinfo_api_function("av_new_stream"));
\r
353 st->codec->codec_id = CODEC_ID_PCM_S16LE;
\r
354 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
\r
355 st->codec->sample_rate = 48000;
\r
356 st->codec->channels = 2;
\r
357 st->codec->sample_fmt = SAMPLE_FMT_S16;
\r
359 if(oc_->oformat->flags & AVFMT_GLOBALHEADER)
\r
360 st->codec->flags |= CODEC_FLAG_GLOBAL_HEADER;
\r
362 auto codec = avcodec_find_encoder(st->codec->codec_id);
\r
364 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info("codec not found"));
\r
366 THROW_ON_ERROR2(avcodec_open(st->codec, codec), "[ffmpeg_consumer]");
\r
368 return std::shared_ptr<AVStream>(st, [](AVStream* st)
\r
370 LOG_ON_ERROR2(avcodec_close(st->codec), "[ffmpeg_consumer]");;
\r
371 av_freep(&st->codec);
\r
376 std::shared_ptr<AVFrame> convert_video_frame(const safe_ptr<core::read_frame>& frame, AVCodecContext* c)
\r
380 sws_.reset(sws_getContext(format_desc_.width, format_desc_.height, PIX_FMT_BGRA, c->width, c->height, c->pix_fmt, SWS_BICUBIC, nullptr, nullptr, nullptr), sws_freeContext);
\r
381 if (sws_ == nullptr)
\r
382 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info("Cannot initialize the conversion context"));
\r
385 std::shared_ptr<AVFrame> av_frame(avcodec_alloc_frame(), av_free);
\r
386 avpicture_fill(reinterpret_cast<AVPicture*>(av_frame.get()), const_cast<uint8_t*>(frame->image_data().begin()), PIX_FMT_BGRA, format_desc_.width, format_desc_.height);
\r
388 std::shared_ptr<AVFrame> local_av_frame(avcodec_alloc_frame(), av_free);
\r
389 picture_buf_.resize(avpicture_get_size(c->pix_fmt, format_desc_.width, format_desc_.height));
\r
390 avpicture_fill(reinterpret_cast<AVPicture*>(local_av_frame.get()), picture_buf_.data(), c->pix_fmt, format_desc_.width, format_desc_.height);
\r
392 sws_scale(sws_.get(), av_frame->data, av_frame->linesize, 0, c->height, local_av_frame->data, local_av_frame->linesize);
\r
394 return local_av_frame;
\r
397 std::shared_ptr<AVPacket> encode_video_frame(const safe_ptr<core::read_frame>& frame)
\r
399 auto c = video_st_->codec;
\r
401 auto av_frame = convert_video_frame(frame, c);
\r
402 av_frame->interlaced_frame = format_desc_.field_mode != core::field_mode::progressive;
\r
403 av_frame->top_field_first = format_desc_.field_mode == core::field_mode::upper;
\r
404 av_frame->pts = frame_number_++;
\r
406 int out_size = THROW_ON_ERROR2(avcodec_encode_video(c, video_outbuf_.data(), video_outbuf_.size(), av_frame.get()), "[ffmpeg_consumer]");
\r
409 safe_ptr<AVPacket> pkt(new AVPacket, [](AVPacket* p)
\r
414 av_init_packet(pkt.get());
\r
416 if (c->coded_frame->pts != AV_NOPTS_VALUE)
\r
417 pkt->pts = av_rescale_q(c->coded_frame->pts, c->time_base, video_st_->time_base);
\r
419 if(c->coded_frame->key_frame)
\r
420 pkt->flags |= AV_PKT_FLAG_KEY;
\r
422 pkt->stream_index = video_st_->index;
\r
423 pkt->data = video_outbuf_.data();
\r
424 pkt->size = out_size;
\r
426 av_dup_packet(pkt.get());
\r
432 std::shared_ptr<AVPacket> encode_audio_frame(const safe_ptr<core::read_frame>& frame)
\r
434 auto c = audio_st_->codec;
\r
436 auto audio_data = core::audio_32_to_16(frame->audio_data());
\r
438 safe_ptr<AVPacket> pkt(new AVPacket, [](AVPacket* p)
\r
443 av_init_packet(pkt.get());
\r
445 if (c->coded_frame && c->coded_frame->pts != AV_NOPTS_VALUE)
\r
446 pkt->pts = av_rescale_q(c->coded_frame->pts, c->time_base, audio_st_->time_base);
\r
448 pkt->flags |= AV_PKT_FLAG_KEY;
\r
449 pkt->stream_index = audio_st_->index;
\r
450 pkt->size = audio_data.size()*2;
\r
451 pkt->data = reinterpret_cast<uint8_t*>(audio_data.data());
\r
453 av_dup_packet(pkt.get());
\r
457 void send(const safe_ptr<core::read_frame>& frame)
\r
459 executor_.begin_invoke([=]
\r
461 frame_timer_.restart();
\r
463 auto video = encode_video_frame(frame);
\r
464 auto audio = encode_audio_frame(frame);
\r
466 graph_->set_value("frame-time", frame_timer_.elapsed()*format_desc_.fps*0.5);
\r
468 file_write_executor_.begin_invoke([=]
\r
470 write_timer_.restart();
\r
473 av_write_frame(oc_.get(), video.get());
\r
475 av_write_frame(oc_.get(), audio.get());
\r
477 graph_->set_value("write-time", write_timer_.elapsed()*format_desc_.fps*0.5);
\r
483 struct ffmpeg_consumer_proxy : public core::frame_consumer
\r
485 const std::wstring filename_;
\r
486 const std::vector<option> options_;
\r
488 std::unique_ptr<ffmpeg_consumer> consumer_;
\r
492 ffmpeg_consumer_proxy(const std::wstring& filename, const std::vector<option>& options)
\r
493 : filename_(filename)
\r
494 , options_(options)
\r
498 virtual void initialize(const core::video_format_desc& format_desc, int)
\r
501 consumer_.reset(new ffmpeg_consumer(narrow(filename_), format_desc, options_));
\r
504 virtual bool send(const safe_ptr<core::read_frame>& frame) override
\r
506 consumer_->send(frame);
\r
510 virtual std::wstring print() const override
\r
512 return consumer_ ? consumer_->print() : L"[ffmpeg_consumer]";
\r
515 virtual boost::property_tree::wptree info() const override
\r
517 boost::property_tree::wptree info;
\r
518 info.add(L"type", L"ffmpeg-consumer");
\r
519 info.add(L"filename", filename_);
\r
523 virtual bool has_synchronization_clock() const override
\r
528 virtual size_t buffer_depth() const override
\r
533 virtual int index() const override
\r
539 safe_ptr<core::frame_consumer> create_consumer(const std::vector<std::wstring>& params)
\r
541 if(params.size() < 1 || params[0] != L"FILE")
\r
542 return core::frame_consumer::empty();
\r
544 auto filename = (params.size() > 1 ? params[1] : L"");
\r
546 std::vector<option> options;
\r
548 if(params.size() >= 3)
\r
550 for(auto opt_it = params.begin()+2; opt_it != params.end();)
\r
552 auto name = narrow(boost::trim_copy(boost::to_lower_copy(*opt_it++))).substr(1);
\r
553 auto value = narrow(boost::trim_copy(boost::to_lower_copy(*opt_it++)));
\r
555 if(value == "h264")
\r
557 else if(value == "dvcpro")
\r
560 options.push_back(option(name, value));
\r
564 return make_safe<ffmpeg_consumer_proxy>(env::media_folder() + filename, options);
\r
567 safe_ptr<core::frame_consumer> create_consumer(const boost::property_tree::wptree& ptree)
\r
569 auto filename = ptree.get<std::wstring>(L"path");
\r
570 auto codec = ptree.get(L"vcodec", L"libx264");
\r
572 std::vector<option> options;
\r
573 options.push_back(option("vcodec", narrow(codec)));
\r
575 return make_safe<ffmpeg_consumer_proxy>(env::media_folder() + filename, options);
\r