]> git.sesse.net Git - casparcg/blobdiff - core/frame/frame.cpp
[general] Abstracted the concept of a key only frame so that readers of const_frame...
[casparcg] / core / frame / frame.cpp
index 497fc1e137a2ae452677cd32f0f7b12242201887..f2c5fa01a4b0108794895f0a02ec7de1ebae1ed4 100644 (file)
-/*\r
-* Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>\r
-*\r
-* This file is part of CasparCG (www.casparcg.com).\r
-*\r
-* CasparCG is free software: you can redistribute it and/or modify\r
-* it under the terms of the GNU General Public License as published by\r
-* the Free Software Foundation, either version 3 of the License, or\r
-* (at your option) any later version.\r
-*\r
-* CasparCG is distributed in the hope that it will be useful,\r
-* but WITHOUT ANY WARRANTY; without even the implied warranty of\r
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
-* GNU General Public License for more details.\r
-*\r
-* You should have received a copy of the GNU General Public License\r
-* along with CasparCG. If not, see <http://www.gnu.org/licenses/>.\r
-*\r
-* Author: Robert Nagy, ronag89@gmail.com\r
-*/\r
-\r
-#include "../stdafx.h"\r
-\r
-#include "frame.h"\r
-\r
-#include <common/except.h>\r
-#include <common/array.h>\r
-\r
-#include <core/frame/frame_visitor.h>\r
-#include <core/frame/pixel_format.h>\r
-\r
-#include <boost/lexical_cast.hpp>\r
-#include <boost/thread/future.hpp>\r
-\r
-namespace caspar { namespace core {\r
-               \r
-struct mutable_frame::impl : boost::noncopyable\r
-{                      \r
-       std::vector<array<std::uint8_t>>                                        buffers_;\r
-       core::audio_buffer                                                      audio_data_;\r
-       const core::pixel_format_desc                           desc_;\r
-       const void*                                                                     tag_;\r
-       double                                                                          frame_rate_;\r
-       core::field_mode                                                        field_mode_;\r
-       \r
-       impl(std::vector<array<std::uint8_t>> buffers, audio_buffer audio_buffer, const void* tag, const core::pixel_format_desc& desc, double frame_rate, core::field_mode field_mode) \r
-               : buffers_(std::move(buffers))\r
-               , audio_data_(std::move(audio_buffer))\r
-               , desc_(desc)\r
-               , tag_(tag)\r
-               , frame_rate_(frame_rate)\r
-               , field_mode_(field_mode)\r
-       {\r
-               BOOST_FOREACH(auto& buffer, buffers_)\r
-                       if(!buffer.data())\r
-                               BOOST_THROW_EXCEPTION(invalid_argument() << msg_info("mutable_frame: null argument"));\r
-       }\r
-};\r
-       \r
-mutable_frame::mutable_frame(std::vector<array<std::uint8_t>> image_buffers, audio_buffer audio_buffer, const void* tag, const core::pixel_format_desc& desc, double frame_rate, core::field_mode field_mode) \r
-       : impl_(new impl(std::move(image_buffers), std::move(audio_buffer), tag, desc, frame_rate, field_mode)){}\r
-mutable_frame::~mutable_frame(){}\r
-mutable_frame::mutable_frame(mutable_frame&& other) : impl_(std::move(other.impl_)){}\r
-mutable_frame& mutable_frame::operator=(mutable_frame&& other)\r
-{\r
-       impl_ = std::move(other.impl_);\r
-       return *this;\r
-}\r
-void mutable_frame::swap(mutable_frame& other){impl_.swap(other.impl_);}\r
-const core::pixel_format_desc& mutable_frame::pixel_format_desc() const{return impl_->desc_;}\r
-const array<std::uint8_t>& mutable_frame::image_data(std::size_t index) const{return impl_->buffers_.at(index);}\r
-const core::audio_buffer& mutable_frame::audio_data() const{return impl_->audio_data_;}\r
-array<std::uint8_t>& mutable_frame::image_data(std::size_t index){return impl_->buffers_.at(index);}\r
-core::audio_buffer& mutable_frame::audio_data(){return impl_->audio_data_;}\r
-double mutable_frame::frame_rate() const{return impl_->frame_rate_;}\r
-core::field_mode mutable_frame::field_mode() const{return impl_->field_mode_;}\r
-std::size_t mutable_frame::width() const{return impl_->desc_.planes.at(0).width;}\r
-std::size_t mutable_frame::height() const{return impl_->desc_.planes.at(0).height;}                                            \r
-const void* mutable_frame::tag() const{return impl_->tag_;}    \r
-\r
-\r
-const const_frame& const_frame::empty()\r
-{\r
-       static int dummy;\r
-       static const_frame empty(&dummy);\r
-       return empty;\r
-}\r
-\r
-struct const_frame::impl : boost::noncopyable\r
-{                      \r
-       mutable std::vector<boost::shared_future<array<const std::uint8_t>>>    future_buffers_;\r
-       int                                                                                     id_;\r
-       core::audio_buffer                                                      audio_data_;\r
-       const core::pixel_format_desc                           desc_;\r
-       const void*                                                                     tag_;\r
-       double                                                                          frame_rate_;\r
-       core::field_mode                                                        field_mode_;\r
-\r
-       impl(const void* tag)\r
-               : desc_(core::pixel_format::invalid)\r
-               , tag_(tag)     \r
-               , id_(0)\r
-               , field_mode_(core::field_mode::empty)\r
-       {\r
-       }\r
-       \r
-       impl(boost::shared_future<array<const std::uint8_t>> image, audio_buffer audio_buffer, const void* tag, const core::pixel_format_desc& desc, double frame_rate, core::field_mode field_mode) \r
-               : audio_data_(std::move(audio_buffer))\r
-               , desc_(desc)\r
-               , tag_(tag)\r
-               , id_(reinterpret_cast<int>(this))\r
-               , frame_rate_(frame_rate)\r
-               , field_mode_(field_mode)\r
-       {\r
-               if(desc.format != core::pixel_format::bgra)\r
-                       BOOST_THROW_EXCEPTION(not_implemented());\r
-               \r
-               future_buffers_.push_back(std::move(image));\r
-       }\r
-\r
-       impl(mutable_frame&& other)\r
-               : audio_data_(other.audio_data())\r
-               , desc_(other.pixel_format_desc())\r
-               , tag_(other.tag())\r
-               , id_(reinterpret_cast<int>(this))\r
-               , frame_rate_(other.frame_rate())\r
-               , field_mode_(other.field_mode())\r
-       {\r
-               for(std::size_t n = 0; n < desc_.planes.size(); ++n)\r
-               {\r
-                       boost::promise<array<const std::uint8_t>> p;\r
-                       p.set_value(std::move(other.image_data(n)));\r
-                       future_buffers_.push_back(p.get_future());\r
-               }\r
-       }\r
-\r
-       array<const std::uint8_t> image_data(int index) const\r
-       {\r
-               return tag_ != empty().tag() ? future_buffers_.at(index).get() : array<const std::uint8_t>(nullptr, 0, true, 0);\r
-       }\r
-\r
-       std::size_t width() const\r
-       {\r
-               return tag_ != empty().tag() ? desc_.planes.at(0).width : 0;\r
-       }\r
-\r
-       std::size_t height() const\r
-       {\r
-               return tag_ != empty().tag() ? desc_.planes.at(0).height : 0;\r
-       }\r
-\r
-       std::size_t size() const\r
-       {\r
-               return tag_ != empty().tag() ? desc_.planes.at(0).size : 0;\r
-       }\r
-\r
-       bool operator==(const impl& other)\r
-       {\r
-               return tag_ == other.tag_ && id_ == other.id_;\r
-       }\r
-};\r
-       \r
-const_frame::const_frame(const void* tag) : impl_(new impl(tag)){}\r
-const_frame::const_frame(boost::shared_future<array<const std::uint8_t>> image, audio_buffer audio_buffer, const void* tag, const core::pixel_format_desc& desc, double frame_rate, core::field_mode field_mode) \r
-       : impl_(new impl(std::move(image), std::move(audio_buffer), tag, desc, frame_rate, field_mode)){}\r
-const_frame::const_frame(mutable_frame&& other) : impl_(new impl(std::move(other))){}\r
-const_frame::~const_frame(){}\r
-const_frame::const_frame(const_frame&& other) : impl_(std::move(other.impl_)){}\r
-const_frame& const_frame::operator=(const_frame&& other)\r
-{\r
-       impl_ = std::move(other.impl_);\r
-       return *this;\r
-}\r
-const_frame::const_frame(const const_frame& other) : impl_(other.impl_){}\r
-const_frame& const_frame::operator=(const const_frame& other)\r
-{\r
-       impl_ = other.impl_;\r
-       return *this;\r
-}\r
-bool const_frame::operator==(const const_frame& other){return *impl_ == *other.impl_;}\r
-bool const_frame::operator!=(const const_frame& other){return !(*this == other);}\r
-const core::pixel_format_desc& const_frame::pixel_format_desc()const{return impl_->desc_;}\r
-array<const std::uint8_t> const_frame::image_data(int index)const{return impl_->image_data(index);}\r
-const core::audio_buffer& const_frame::audio_data()const{return impl_->audio_data_;}\r
-double const_frame::frame_rate()const{return impl_->frame_rate_;}\r
-core::field_mode const_frame::field_mode()const{return impl_->field_mode_;}\r
-std::size_t const_frame::width()const{return impl_->width();}\r
-std::size_t const_frame::height()const{return impl_->height();}        \r
-std::size_t const_frame::size()const{return impl_->size();}                                            \r
-const void* const_frame::tag()const{return impl_->tag_;}       \r
-\r
-}}
\ No newline at end of file
+/*
+* Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
+*
+* This file is part of CasparCG (www.casparcg.com).
+*
+* CasparCG is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published by
+* the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* CasparCG is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with CasparCG. If not, see <http://www.gnu.org/licenses/>.
+*
+* Author: Robert Nagy, ronag89@gmail.com
+*/
+
+#include "../StdAfx.h"
+
+#include "frame.h"
+
+#include <common/except.h>
+#include <common/array.h>
+#include <common/future.h>
+#include <common/timer.h>
+#include <common/memshfl.h>
+
+#include <core/frame/frame_visitor.h>
+#include <core/frame/pixel_format.h>
+#include <core/frame/geometry.h>
+#include <core/frame/audio_channel_layout.h>
+
+#include <cstdint>
+#include <vector>
+
+#include <boost/lexical_cast.hpp>
+#include <boost/thread/future.hpp>
+
+namespace caspar { namespace core {
+
+struct mutable_frame::impl : boost::noncopyable
+{
+       std::vector<array<std::uint8_t>>                        buffers_;
+       core::mutable_audio_buffer                                      audio_data_;
+       const core::pixel_format_desc                           desc_;
+       const core::audio_channel_layout                        channel_layout_;
+       const void*                                                                     tag_;
+       core::frame_geometry                                            geometry_                               = frame_geometry::get_default();
+       caspar::timer                                                           since_created_timer_;
+
+       impl(
+                       std::vector<array<std::uint8_t>> buffers,
+                       mutable_audio_buffer audio_data,
+                       const void* tag,
+                       const core::pixel_format_desc& desc,
+                       const core::audio_channel_layout& channel_layout)
+               : buffers_(std::move(buffers))
+               , audio_data_(std::move(audio_data))
+               , desc_(desc)
+               , channel_layout_(channel_layout)
+               , tag_(tag)
+       {
+               for (auto& buffer : buffers_)
+                       if(!buffer.data())
+                               CASPAR_THROW_EXCEPTION(invalid_argument() << msg_info("mutable_frame: null argument"));
+       }
+};
+
+mutable_frame::mutable_frame(
+               std::vector<array<std::uint8_t>> image_buffers,
+               mutable_audio_buffer audio_data,
+               const void* tag,
+               const core::pixel_format_desc& desc,
+               const core::audio_channel_layout& channel_layout)
+       : impl_(new impl(std::move(image_buffers), std::move(audio_data), tag, desc, channel_layout)){}
+mutable_frame::~mutable_frame(){}
+mutable_frame::mutable_frame(mutable_frame&& other) : impl_(std::move(other.impl_)){}
+mutable_frame& mutable_frame::operator=(mutable_frame&& other)
+{
+       impl_ = std::move(other.impl_);
+       return *this;
+}
+void mutable_frame::swap(mutable_frame& other){impl_.swap(other.impl_);}
+const core::pixel_format_desc& mutable_frame::pixel_format_desc() const{return impl_->desc_;}
+const core::audio_channel_layout& mutable_frame::audio_channel_layout() const { return impl_->channel_layout_; }
+const array<std::uint8_t>& mutable_frame::image_data(std::size_t index) const{return impl_->buffers_.at(index);}
+const core::mutable_audio_buffer& mutable_frame::audio_data() const{return impl_->audio_data_;}
+array<std::uint8_t>& mutable_frame::image_data(std::size_t index){return impl_->buffers_.at(index);}
+core::mutable_audio_buffer& mutable_frame::audio_data(){return impl_->audio_data_;}
+std::size_t mutable_frame::width() const{return impl_->desc_.planes.at(0).width;}
+std::size_t mutable_frame::height() const{return impl_->desc_.planes.at(0).height;}
+const void* mutable_frame::stream_tag()const{return impl_->tag_;}
+const frame_geometry& mutable_frame::geometry() const { return impl_->geometry_; }
+void mutable_frame::set_geometry(const frame_geometry& g) { impl_->geometry_ = g; }
+caspar::timer mutable_frame::since_created() const { return impl_->since_created_timer_; }
+
+const const_frame& const_frame::empty()
+{
+       static int dummy;
+       static const_frame empty(&dummy);
+       return empty;
+}
+
+struct const_frame::impl : boost::noncopyable
+{
+       mutable std::vector<std::shared_future<array<const std::uint8_t>>>      future_buffers_;
+       mutable core::audio_buffer                                                                                      audio_data_;
+       const core::pixel_format_desc                                                                           desc_;
+       const core::audio_channel_layout                                                                        channel_layout_;
+       const void*                                                                                                                     tag_;
+       core::frame_geometry                                                                                            geometry_;
+       caspar::timer                                                                                                           since_created_timer_;
+       bool                                                                                                                            should_record_age_;
+       mutable tbb::atomic<int64_t>                                                                            recorded_age_;
+       std::shared_future<array<const std::uint8_t>>                                           key_only_on_demand_;
+
+       impl(const void* tag)
+               : audio_data_(0, 0, true, 0)
+               , desc_(core::pixel_format::invalid)
+               , channel_layout_(audio_channel_layout::invalid())
+               , tag_(tag)
+               , geometry_(frame_geometry::get_default())
+               , should_record_age_(true)
+       {
+               recorded_age_ = 0;
+       }
+
+       impl(
+                       std::shared_future<array<const std::uint8_t>> image,
+                       audio_buffer audio_data,
+                       const void* tag,
+                       const core::pixel_format_desc& desc,
+                       const core::audio_channel_layout& channel_layout,
+                       caspar::timer since_created_timer = caspar::timer())
+               : audio_data_(std::move(audio_data))
+               , desc_(desc)
+               , channel_layout_(channel_layout)
+               , tag_(tag)
+               , geometry_(frame_geometry::get_default())
+               , since_created_timer_(std::move(since_created_timer))
+               , should_record_age_(false)
+       {
+               if (desc.format != core::pixel_format::bgra)
+                       CASPAR_THROW_EXCEPTION(not_implemented());
+
+               future_buffers_.push_back(image);
+
+               key_only_on_demand_ = std::async(std::launch::deferred, [image]
+               {
+                       auto fill       = image.get();
+                       auto key        = cache_aligned_vector<std::uint8_t>(fill.size());
+
+                       aligned_memshfl(key.data(), fill.data(), fill.size(), 0x0F0F0F0F, 0x0B0B0B0B, 0x07070707, 0x03030303);
+
+                       return array<const std::uint8_t>(key.data(), key.size(), false, std::move(key));
+               }).share();
+       }
+
+       impl(mutable_frame&& other)
+               : audio_data_(0, 0, true, 0) // Complex init done in body instead.
+               , desc_(other.pixel_format_desc())
+               , channel_layout_(other.audio_channel_layout())
+               , tag_(other.stream_tag())
+               , geometry_(other.geometry())
+               , since_created_timer_(other.since_created())
+               , should_record_age_(true)
+       {
+               spl::shared_ptr<mutable_audio_buffer> shared_audio_data(new mutable_audio_buffer(std::move(other.audio_data())));
+               // pointer returned by vector::data() should be the same after move, but just to be safe.
+               audio_data_ = audio_buffer(shared_audio_data->data(), shared_audio_data->size(), true, std::move(shared_audio_data));
+
+               for (std::size_t n = 0; n < desc_.planes.size(); ++n)
+               {
+                       future_buffers_.push_back(make_ready_future<array<const std::uint8_t>>(std::move(other.image_data(n))).share());
+               }
+
+               recorded_age_ = -1;
+       }
+
+       array<const std::uint8_t> image_data(int index) const
+       {
+               return tag_ != empty().stream_tag() ? future_buffers_.at(index).get() : array<const std::uint8_t>(nullptr, 0, true, 0);
+       }
+
+       spl::shared_ptr<impl> key_only() const
+       {
+               return spl::make_shared<impl>(key_only_on_demand_, audio_data_, tag_, desc_, channel_layout_, since_created_timer_);
+       }
+
+       std::size_t width() const
+       {
+               return tag_ != empty().stream_tag() ? desc_.planes.at(0).width : 0;
+       }
+
+       std::size_t height() const
+       {
+               return tag_ != empty().stream_tag() ? desc_.planes.at(0).height : 0;
+       }
+
+       std::size_t size() const
+       {
+               return tag_ != empty().stream_tag() ? desc_.planes.at(0).size : 0;
+       }
+
+       int64_t get_age_millis() const
+       {
+               if (should_record_age_)
+               {
+                       if (recorded_age_ == -1)
+                               recorded_age_ = static_cast<int64_t>(since_created_timer_.elapsed() * 1000.0);
+
+                       return recorded_age_;
+               }
+               else
+                       return static_cast<int64_t>(since_created_timer_.elapsed() * 1000.0);
+       }
+};
+
+const_frame::const_frame(const void* tag) : impl_(new impl(tag)){}
+const_frame::const_frame(
+               std::shared_future<array<const std::uint8_t>> image,
+               audio_buffer audio_data,
+               const void* tag,
+               const core::pixel_format_desc& desc,
+               const core::audio_channel_layout& channel_layout)
+       : impl_(new impl(std::move(image), std::move(audio_data), tag, desc, channel_layout)){}
+const_frame::const_frame(mutable_frame&& other) : impl_(new impl(std::move(other))){}
+const_frame::~const_frame(){}
+const_frame::const_frame(const_frame&& other) : impl_(std::move(other.impl_)){}
+const_frame& const_frame::operator=(const_frame&& other)
+{
+       impl_ = std::move(other.impl_);
+       return *this;
+}
+const_frame::const_frame(const const_frame& other) : impl_(other.impl_){}
+const_frame& const_frame::operator=(const const_frame& other)
+{
+       impl_ = other.impl_;
+       return *this;
+}
+bool const_frame::operator==(const const_frame& other){return impl_ == other.impl_;}
+bool const_frame::operator!=(const const_frame& other){return !(*this == other);}
+bool const_frame::operator<(const const_frame& other){return impl_ < other.impl_;}
+bool const_frame::operator>(const const_frame& other){return impl_ > other.impl_;}
+const core::pixel_format_desc& const_frame::pixel_format_desc()const{return impl_->desc_;}
+const core::audio_channel_layout& const_frame::audio_channel_layout()const { return impl_->channel_layout_; }
+array<const std::uint8_t> const_frame::image_data(int index)const{return impl_->image_data(index);}
+const core::audio_buffer& const_frame::audio_data()const{return impl_->audio_data_;}
+std::size_t const_frame::width()const{return impl_->width();}
+std::size_t const_frame::height()const{return impl_->height();}
+std::size_t const_frame::size()const{return impl_->size();}
+const void* const_frame::stream_tag()const{return impl_->tag_;}
+const frame_geometry& const_frame::geometry() const { return impl_->geometry_; }
+void const_frame::set_geometry(const frame_geometry& g) { impl_->geometry_ = g; }
+int64_t const_frame::get_age_millis() const { return impl_->get_age_millis(); }
+const_frame const_frame::key_only() const
+{
+       auto result             = const_frame();
+       result.impl_    = impl_->key_only();
+
+       return result;
+}
+
+}}