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/frame/data_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/env.h>
\r
34 #include <common/concurrency/executor.h>
\r
35 #include <common/diagnostics/graph.h>
\r
36 #include <common/spl/memory.h>
\r
37 #include <common/utf.h>
\r
38 #include <common/param.h>
\r
40 #include <boost/algorithm/string.hpp>
\r
41 #include <boost/timer.hpp>
\r
42 #include <boost/property_tree/ptree.hpp>
\r
43 #include <boost/filesystem.hpp>
\r
45 #if defined(_MSC_VER)
\r
46 #pragma warning (push)
\r
47 #pragma warning (disable : 4244)
\r
51 #define __STDC_CONSTANT_MACROS
\r
52 #define __STDC_LIMIT_MACROS
\r
53 #include <libavformat/avformat.h>
\r
54 #include <libswscale/swscale.h>
\r
55 #include <libavutil/opt.h>
\r
57 #if defined(_MSC_VER)
\r
58 #pragma warning (pop)
\r
61 namespace caspar { namespace ffmpeg {
\r
68 option(std::string name, std::string value)
\r
69 : name(std::move(name))
\r
70 , value(std::move(value))
\r
75 void set_format(AVOutputFormat*& format, const std::string& value)
\r
77 format = av_guess_format(value.c_str(), nullptr, nullptr);
\r
79 if(format == nullptr)
\r
80 BOOST_THROW_EXCEPTION(invalid_argument() << arg_name_info("f"));
\r
83 bool parse_format(AVOutputFormat*& format, std::vector<option>& options)
\r
85 auto format_it = std::find_if(options.begin(), options.end(), [](const option& o)
\r
87 return o.name == "f" || o.name == "format";
\r
90 if(format_it == options.end())
\r
93 set_format(format, format_it->value);
\r
95 options.erase(format_it);
\r
100 void set_vcodec(CodecID& vcodec, const std::string& value)
\r
102 vcodec = avcodec_find_encoder_by_name(value.c_str())->id;
\r
103 if(vcodec == CODEC_ID_NONE)
\r
104 BOOST_THROW_EXCEPTION(invalid_argument() << arg_name_info("vcodec"));
\r
107 bool parse_vcodec(CodecID& vcodec, std::vector<option>& options)
\r
109 auto vcodec_it = std::find_if(options.begin(), options.end(), [](const option& o)
\r
111 return o.name == "vcodec";
\r
114 if(vcodec_it == options.end())
\r
117 set_vcodec(vcodec, vcodec_it->value);
\r
119 options.erase(vcodec_it);
\r
124 void set_pix_fmt(AVCodecContext* vcodec, const std::string& value)
\r
126 auto pix_fmt = av_get_pix_fmt(value.c_str());
\r
127 if(pix_fmt == PIX_FMT_NONE)
\r
128 BOOST_THROW_EXCEPTION(invalid_argument() << arg_name_info("pix_fmt"));
\r
130 vcodec->pix_fmt = pix_fmt;
\r
133 bool parse_pix_fmt(AVCodecContext* vcodec, std::vector<option>& options)
\r
135 auto pix_fmt_it = std::find_if(options.begin(), options.end(), [](const option& o)
\r
137 return o.name == "pix_fmt" || o.name == "pixel_format";
\r
140 if(pix_fmt_it == options.end())
\r
143 set_pix_fmt(vcodec, pix_fmt_it->value);
\r
145 options.erase(pix_fmt_it);
\r
150 struct ffmpeg_consumer : boost::noncopyable
\r
152 const std::string filename_;
\r
154 const std::shared_ptr<AVFormatContext> oc_;
\r
155 const core::video_format_desc format_desc_;
\r
157 const spl::shared_ptr<diagnostics::graph> graph_;
\r
158 boost::timer frame_timer_;
\r
159 boost::timer write_timer_;
\r
161 executor executor_;
\r
162 executor file_write_executor_;
\r
165 std::shared_ptr<AVStream> audio_st_;
\r
168 std::shared_ptr<AVStream> video_st_;
\r
170 std::vector<uint8_t> video_outbuf_;
\r
171 std::vector<uint8_t> picture_buf_;
\r
172 std::shared_ptr<SwsContext> sws_;
\r
174 int64_t frame_number_;
\r
177 ffmpeg_consumer(const std::string& filename, const core::video_format_desc& format_desc, std::vector<option> options)
\r
178 : filename_(filename)
\r
179 , video_outbuf_(1920*1080*8)
\r
180 , oc_(avformat_alloc_context(), av_free)
\r
181 , format_desc_(format_desc)
\r
182 , executor_(print())
\r
183 , file_write_executor_(print() + L"/output")
\r
186 // TODO: Ask stakeholders about case where file already exists.
\r
187 boost::filesystem::remove(boost::filesystem::path(env::media_folder() + u16(filename))); // Delete the file if it exists
\r
189 graph_->set_color("frame-time", diagnostics::color(0.1f, 1.0f, 0.1f));
\r
190 graph_->set_color("write-time", diagnostics::color(0.5f, 0.5f, 0.1f));
\r
191 graph_->set_text(print());
\r
192 diagnostics::register_graph(graph_);
\r
194 executor_.set_capacity(8);
\r
195 file_write_executor_.set_capacity(8);
\r
197 oc_->oformat = av_guess_format(nullptr, filename_.c_str(), nullptr);
\r
199 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info("Could not find suitable output format."));
\r
201 parse_format(oc_->oformat, options);
\r
203 auto vcodec = oc_->oformat->video_codec;
\r
204 parse_vcodec(vcodec, options);
\r
206 THROW_ON_ERROR2(av_set_parameters(oc_.get(), nullptr), "[ffmpeg_consumer]");
\r
208 strcpy_s(oc_->filename, filename_.c_str());
\r
210 // Add the audio and video streams using the default format codecs and initialize the codecs .
\r
211 video_st_ = add_video_stream(vcodec, options);
\r
212 audio_st_ = add_audio_stream();
\r
214 dump_format(oc_.get(), 0, filename_.c_str(), 1);
\r
216 // Open the output ffmpeg, if needed.
\r
217 if (!(oc_->oformat->flags & AVFMT_NOFILE))
\r
218 THROW_ON_ERROR2(avio_open(&oc_->pb, filename_.c_str(), URL_WRONLY), "[ffmpeg_consumer]");
\r
220 THROW_ON_ERROR2(av_write_header(oc_.get()), "[ffmpeg_consumer]");
\r
222 CASPAR_LOG(info) << print() << L" Successfully Initialized.";
\r
230 file_write_executor_.stop();
\r
231 file_write_executor_.join();
\r
233 LOG_ON_ERROR2(av_write_trailer(oc_.get()), "[ffmpeg_consumer]");
\r
238 if (!(oc_->oformat->flags & AVFMT_NOFILE))
\r
239 LOG_ON_ERROR2(avio_close(oc_->pb), "[ffmpeg_consumer]"); // Close the output ffmpeg.
\r
241 CASPAR_LOG(info) << print() << L" Successfully Uninitialized.";
\r
244 std::wstring print() const
\r
246 return L"ffmpeg[" + u16(filename_) + L"]";
\r
249 std::shared_ptr<AVStream> add_video_stream(CodecID vcodec, std::vector<option>& options)
\r
251 auto st = av_new_stream(oc_.get(), 0);
\r
253 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info("Could not allocate video-stream") << boost::errinfo_api_function("av_new_stream"));
\r
255 auto encoder = avcodec_find_encoder(vcodec);
\r
257 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info("codec not found"));
\r
259 auto c = st->codec;
\r
261 avcodec_get_context_defaults3(c, encoder);
\r
263 c->codec_id = vcodec;
\r
264 c->codec_type = AVMEDIA_TYPE_VIDEO;
\r
265 c->width = format_desc_.width;
\r
266 c->height = format_desc_.height;
\r
267 c->time_base.den = format_desc_.time_scale;
\r
268 c->time_base.num = format_desc_.duration;
\r
270 c->flags |= format_desc_.field_mode == core::field_mode::progressive ? 0 : (CODEC_FLAG_INTERLACED_ME | CODEC_FLAG_INTERLACED_DCT);
\r
272 if(c->codec_id == CODEC_ID_PRORES)
\r
274 c->bit_rate = format_desc_.width < 1280 ? 63*1000000 : 220*1000000;
\r
275 c->pix_fmt = PIX_FMT_YUV422P10;
\r
277 else if(c->codec_id == CODEC_ID_DNXHD)
\r
279 if(format_desc_.width < 1280 || format_desc_.height < 720)
\r
280 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info("unsupported dimension"));
\r
282 c->bit_rate = 220*1000000;
\r
283 c->pix_fmt = PIX_FMT_YUV422P;
\r
285 else if(c->codec_id == CODEC_ID_DVVIDEO)
\r
287 c->bit_rate = format_desc_.width < 1280 ? 50*1000000 : 100*1000000;
\r
288 c->width = format_desc_.height == 1280 ? 960 : c->width;
\r
290 if(format_desc_.format == core::video_format::ntsc)
\r
291 c->pix_fmt = PIX_FMT_YUV411P;
\r
292 else if(format_desc_.format == core::video_format::pal)
\r
293 c->pix_fmt = PIX_FMT_YUV420P;
\r
295 if(c->bit_rate >= 50*1000000) // dv50
\r
296 c->pix_fmt = PIX_FMT_YUV422P;
\r
298 if(format_desc_.duration == 1001)
\r
299 c->width = format_desc_.height == 1080 ? 1280 : c->width;
\r
301 c->width = format_desc_.height == 1080 ? 1440 : c->width;
\r
303 else if(c->codec_id == CODEC_ID_H264)
\r
305 c->pix_fmt = PIX_FMT_YUV420P;
\r
306 if(options.empty())
\r
308 av_opt_set(c->priv_data, "preset", "ultrafast", 0);
\r
309 av_opt_set(c->priv_data, "tune", "fastdecode", 0);
\r
310 av_opt_set(c->priv_data, "crf", "5", 0);
\r
313 else if(c->codec_id == CODEC_ID_QTRLE)
\r
315 c->pix_fmt = PIX_FMT_ARGB;
\r
319 BOOST_THROW_EXCEPTION(invalid_argument() << msg_info("Unsupported output parameters."));
\r
322 parse_pix_fmt(c, options);
\r
324 c->max_b_frames = 0; // b-frames not supported.
\r
326 BOOST_FOREACH(auto& option, options)
\r
327 THROW_ON_ERROR2(av_opt_set(c, option.name.c_str(), option.value.c_str(), AV_OPT_SEARCH_CHILDREN), "[ffmpeg_consumer]");
\r
329 if(oc_->oformat->flags & AVFMT_GLOBALHEADER)
\r
330 c->flags |= CODEC_FLAG_GLOBAL_HEADER;
\r
332 c->thread_count = boost::thread::hardware_concurrency();
\r
333 THROW_ON_ERROR2(avcodec_open(c, encoder), "[ffmpeg_consumer]");
\r
335 return std::shared_ptr<AVStream>(st, [](AVStream* st)
\r
337 LOG_ON_ERROR2(avcodec_close(st->codec), "[ffmpeg_consumer]");
\r
338 av_freep(&st->codec);
\r
343 std::shared_ptr<AVStream> add_audio_stream()
\r
345 auto st = av_new_stream(oc_.get(), 1);
\r
347 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info("Could not allocate audio-stream") << boost::errinfo_api_function("av_new_stream"));
\r
349 st->codec->codec_id = CODEC_ID_PCM_S16LE;
\r
350 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
\r
351 st->codec->sample_rate = 48000;
\r
352 st->codec->channels = 2;
\r
353 st->codec->sample_fmt = SAMPLE_FMT_S16;
\r
355 if(oc_->oformat->flags & AVFMT_GLOBALHEADER)
\r
356 st->codec->flags |= CODEC_FLAG_GLOBAL_HEADER;
\r
358 auto codec = avcodec_find_encoder(st->codec->codec_id);
\r
360 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info("codec not found"));
\r
362 THROW_ON_ERROR2(avcodec_open(st->codec, codec), "[ffmpeg_consumer]");
\r
364 return std::shared_ptr<AVStream>(st, [](AVStream* st)
\r
366 LOG_ON_ERROR2(avcodec_close(st->codec), "[ffmpeg_consumer]");;
\r
367 av_freep(&st->codec);
\r
372 std::shared_ptr<AVFrame> convert_video_frame(const spl::shared_ptr<const core::data_frame>& frame, AVCodecContext* c)
\r
376 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
377 if (sws_ == nullptr)
\r
378 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info("Cannot initialize the conversion context"));
\r
381 std::shared_ptr<AVFrame> av_frame(avcodec_alloc_frame(), av_free);
\r
382 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
384 std::shared_ptr<AVFrame> local_av_frame(avcodec_alloc_frame(), av_free);
\r
385 picture_buf_.resize(avpicture_get_size(c->pix_fmt, format_desc_.width, format_desc_.height));
\r
386 avpicture_fill(reinterpret_cast<AVPicture*>(local_av_frame.get()), picture_buf_.data(), c->pix_fmt, format_desc_.width, format_desc_.height);
\r
388 sws_scale(sws_.get(), av_frame->data, av_frame->linesize, 0, c->height, local_av_frame->data, local_av_frame->linesize);
\r
390 return local_av_frame;
\r
393 std::shared_ptr<AVPacket> encode_video_frame(const spl::shared_ptr<const core::data_frame>& frame)
\r
395 auto c = video_st_->codec;
\r
397 auto av_frame = convert_video_frame(frame, c);
\r
398 av_frame->interlaced_frame = format_desc_.field_mode != core::field_mode::progressive;
\r
399 av_frame->top_field_first = format_desc_.field_mode == core::field_mode::upper;
\r
400 av_frame->pts = frame_number_++;
\r
402 int out_size = THROW_ON_ERROR2(avcodec_encode_video(c, video_outbuf_.data(), static_cast<int>(video_outbuf_.size()), av_frame.get()), "[ffmpeg_consumer]");
\r
405 spl::shared_ptr<AVPacket> pkt(new AVPacket, [](AVPacket* p)
\r
410 av_init_packet(pkt.get());
\r
412 if (c->coded_frame->pts != AV_NOPTS_VALUE)
\r
413 pkt->pts = av_rescale_q(c->coded_frame->pts, c->time_base, video_st_->time_base);
\r
415 if(c->coded_frame->key_frame)
\r
416 pkt->flags |= AV_PKT_FLAG_KEY;
\r
418 pkt->stream_index = video_st_->index;
\r
419 pkt->data = video_outbuf_.data();
\r
420 pkt->size = out_size;
\r
422 av_dup_packet(pkt.get());
\r
428 std::shared_ptr<AVPacket> encode_audio_frame(const spl::shared_ptr<const core::data_frame>& frame)
\r
430 auto c = audio_st_->codec;
\r
432 auto audio_data = core::audio_32_to_16(frame->audio_data());
\r
434 spl::shared_ptr<AVPacket> pkt(new AVPacket, [](AVPacket* p)
\r
439 av_init_packet(pkt.get());
\r
441 if (c->coded_frame && c->coded_frame->pts != AV_NOPTS_VALUE)
\r
442 pkt->pts = av_rescale_q(c->coded_frame->pts, c->time_base, audio_st_->time_base);
\r
444 pkt->flags |= AV_PKT_FLAG_KEY;
\r
445 pkt->stream_index = audio_st_->index;
\r
446 pkt->size = static_cast<int>(audio_data.size()*2);
\r
447 pkt->data = reinterpret_cast<uint8_t*>(audio_data.data());
\r
449 av_dup_packet(pkt.get());
\r
453 void send(const spl::shared_ptr<const core::data_frame>& frame)
\r
455 executor_.begin_invoke([=]
\r
457 frame_timer_.restart();
\r
459 auto video = encode_video_frame(frame);
\r
460 auto audio = encode_audio_frame(frame);
\r
462 graph_->set_value("frame-time", frame_timer_.elapsed()*format_desc_.fps*0.5);
\r
464 file_write_executor_.begin_invoke([=]
\r
466 write_timer_.restart();
\r
469 av_write_frame(oc_.get(), video.get());
\r
471 av_write_frame(oc_.get(), audio.get());
\r
473 graph_->set_value("write-time", write_timer_.elapsed()*format_desc_.fps*0.5);
\r
479 struct ffmpeg_consumer_proxy : public core::frame_consumer
\r
481 const std::wstring filename_;
\r
482 const std::vector<option> options_;
\r
484 std::unique_ptr<ffmpeg_consumer> consumer_;
\r
488 ffmpeg_consumer_proxy(const std::wstring& filename, const std::vector<option>& options)
\r
489 : filename_(filename)
\r
490 , options_(options)
\r
494 virtual void initialize(const core::video_format_desc& format_desc, int)
\r
497 consumer_.reset(new ffmpeg_consumer(u8(filename_), format_desc, options_));
\r
500 virtual bool send(const spl::shared_ptr<const core::data_frame>& frame) override
\r
502 consumer_->send(frame);
\r
506 virtual std::wstring print() const override
\r
508 return consumer_ ? consumer_->print() : L"[ffmpeg_consumer]";
\r
511 virtual std::wstring name() const override
\r
516 virtual boost::property_tree::wptree info() const override
\r
518 boost::property_tree::wptree info;
\r
519 info.add(L"type", L"file");
\r
520 info.add(L"filename", filename_);
\r
524 virtual bool has_synchronization_clock() const override
\r
529 virtual int buffer_depth() const override
\r
534 virtual int index() const override
\r
540 spl::shared_ptr<core::frame_consumer> create_consumer(const std::vector<std::wstring>& params)
\r
542 if(params.size() < 1 || params[0] != L"FILE")
\r
543 return core::frame_consumer::empty();
\r
545 auto filename = (params.size() > 1 ? params[1] : L"");
\r
547 std::vector<option> options;
\r
549 if(params.size() >= 3)
\r
551 for(auto opt_it = params.begin()+2; opt_it != params.end();)
\r
553 auto name = u8(boost::trim_copy(boost::to_lower_copy(*opt_it++))).substr(1);
\r
554 auto value = u8(boost::trim_copy(boost::to_lower_copy(*opt_it++)));
\r
556 if(value == "h264")
\r
558 else if(value == "dvcpro")
\r
561 options.push_back(option(name, value));
\r
565 return spl::make_shared<ffmpeg_consumer_proxy>(env::media_folder() + filename, options);
\r
568 spl::shared_ptr<core::frame_consumer> create_consumer(const boost::property_tree::wptree& ptree)
\r
570 auto filename = ptree.get<std::wstring>(L"path");
\r
571 auto codec = ptree.get(L"vcodec", L"libx264");
\r
573 std::vector<option> options;
\r
574 options.push_back(option("vcodec", u8(codec)));
\r
576 return spl::make_shared<ffmpeg_consumer_proxy>(env::media_folder() + filename, options);
\r