1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
|
/*
* Copyright (C) 2023 Igalia S.L
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* aint with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#include "config.h"
#include "VideoEncoderGStreamer.h"
#if ENABLE(VIDEO) && USE(GSTREAMER)
#include "GStreamerCommon.h"
#include "GStreamerElementHarness.h"
#include "GStreamerRegistryScanner.h"
#include "VideoEncoderPrivateGStreamer.h"
#include "VideoFrameGStreamer.h"
#include <wtf/NeverDestroyed.h>
#include <wtf/TZoneMallocInlines.h>
#include <wtf/ThreadSafeRefCounted.h>
#include <wtf/WorkQueue.h>
#include <wtf/text/MakeString.h>
#if USE(GSTREAMER_GL)
#include <gst/gl/gstglmemory.h>
#endif
namespace WebCore {
WTF_MAKE_TZONE_ALLOCATED_IMPL(GStreamerVideoEncoder);
GST_DEBUG_CATEGORY(webkit_video_encoder_debug);
#define GST_CAT_DEFAULT webkit_video_encoder_debug
static WorkQueue& gstEncoderWorkQueue()
{
static std::once_flag onceKey;
static LazyNeverDestroyed<Ref<WorkQueue>> queue;
std::call_once(onceKey, [] {
queue.construct(WorkQueue::create("GStreamer VideoEncoder queue"_s));
});
return queue.get();
}
class GStreamerInternalVideoEncoder : public ThreadSafeRefCountedAndCanMakeThreadSafeWeakPtr<GStreamerInternalVideoEncoder, WTF::DestructionThread::Main> {
WTF_MAKE_TZONE_ALLOCATED_INLINE(GStreamerInternalVideoEncoder);
WTF_MAKE_NONCOPYABLE(GStreamerInternalVideoEncoder);
public:
static Ref<GStreamerInternalVideoEncoder> create(const VideoEncoder::Config& config, VideoEncoder::DescriptionCallback&& descriptionCallback, VideoEncoder::OutputCallback&& outputCallback) { return adoptRef(*new GStreamerInternalVideoEncoder(config, WTFMove(descriptionCallback), WTFMove(outputCallback))); }
~GStreamerInternalVideoEncoder();
String initialize(const String& codecName);
bool encode(VideoEncoder::RawFrame&&, bool shouldGenerateKeyFrame);
void setRates(uint64_t bitRate, double frameRate);
void applyRates();
void flush();
void close() { m_isClosed = true; }
const RefPtr<GStreamerElementHarness> harness() const { return m_harness; }
bool isClosed() const { return m_isClosed; }
private:
GStreamerInternalVideoEncoder(const VideoEncoder::Config&, VideoEncoder::DescriptionCallback&&, VideoEncoder::OutputCallback&&);
VideoEncoder::Config m_config;
VideoEncoder::DescriptionCallback m_descriptionCallback;
VideoEncoder::OutputCallback m_outputCallback;
int64_t m_timestamp { 0 };
std::optional<uint64_t> m_duration;
bool m_isClosed { false };
bool m_isInitialized { false };
RefPtr<GStreamerElementHarness> m_harness;
GUniquePtr<GstVideoConverter> m_colorConvert;
GRefPtr<GstCaps> m_colorConvertInputCaps;
GRefPtr<GstCaps> m_colorConvertOutputCaps;
bool m_hasMultipleTemporalLayers { false };
};
void GStreamerVideoEncoder::create(const String& codecName, const VideoEncoder::Config& config, CreateCallback&& callback, DescriptionCallback&& descriptionCallback, OutputCallback&& outputCallback)
{
static std::once_flag debugRegisteredFlag;
std::call_once(debugRegisteredFlag, [] {
GST_DEBUG_CATEGORY_INIT(webkit_video_encoder_debug, "webkitvideoencoder", 0, "WebKit WebCodecs Video Encoder");
});
registerWebKitGStreamerVideoEncoder();
auto& scanner = GStreamerRegistryScanner::singleton();
if (!scanner.isCodecSupported(GStreamerRegistryScanner::Configuration::Encoding, codecName)) {
auto errorMessage = makeString("No GStreamer encoder found for codec "_s, codecName);
callback(makeUnexpected(WTFMove(errorMessage)));
return;
}
Ref encoder = adoptRef(*new GStreamerVideoEncoder(config, WTFMove(descriptionCallback), WTFMove(outputCallback)));
Ref internalEncoder = encoder->m_internalEncoder;
auto error = internalEncoder->initialize(codecName);
if (!error.isEmpty()) {
GST_WARNING("Error creating encoder: %s", error.ascii().data());
callback(makeUnexpected(makeString("GStreamer encoding initialization failed with error: "_s, error)));
return;
}
gstEncoderWorkQueue().dispatch([callback = WTFMove(callback), encoder = WTFMove(encoder)]() mutable {
auto internalEncoder = encoder->m_internalEncoder;
GST_DEBUG("Encoder created");
callback(Ref<VideoEncoder> { WTFMove(encoder) });
});
}
GStreamerVideoEncoder::GStreamerVideoEncoder(const VideoEncoder::Config& config, DescriptionCallback&& descriptionCallback, OutputCallback&& outputCallback)
: m_internalEncoder(GStreamerInternalVideoEncoder::create(config, WTFMove(descriptionCallback), WTFMove(outputCallback)))
{
}
GStreamerVideoEncoder::~GStreamerVideoEncoder()
{
GST_DEBUG_OBJECT(m_internalEncoder->harness()->element(), "Destroying");
close();
}
Ref<VideoEncoder::EncodePromise> GStreamerVideoEncoder::encode(RawFrame&& frame, bool shouldGenerateKeyFrame)
{
return invokeAsync(gstEncoderWorkQueue(), [frame = WTFMove(frame), shouldGenerateKeyFrame, encoder = m_internalEncoder]() mutable {
auto result = encoder->encode(WTFMove(frame), shouldGenerateKeyFrame);
if (!result)
return EncodePromise::createAndReject("Encoding failed"_s);
encoder->harness()->processOutputSamples();
return EncodePromise::createAndResolve();
});
}
Ref<GenericPromise> GStreamerVideoEncoder::flush()
{
return invokeAsync(gstEncoderWorkQueue(), [encoder = m_internalEncoder] {
encoder->flush();
return GenericPromise::createAndResolve();
});
}
Ref<GenericPromise> GStreamerVideoEncoder::setRates(uint64_t bitRate, double frameRate)
{
return invokeAsync(gstEncoderWorkQueue(), [encoder = m_internalEncoder, bitRate, frameRate] {
encoder->setRates(bitRate, frameRate);
return GenericPromise::createAndResolve();
});
}
void GStreamerVideoEncoder::reset()
{
GST_DEBUG_OBJECT(m_internalEncoder->harness()->element(), "Resetting");
m_internalEncoder->close();
}
void GStreamerVideoEncoder::close()
{
GST_DEBUG_OBJECT(m_internalEncoder->harness()->element(), "Closing");
m_internalEncoder->close();
}
static std::optional<unsigned> retrieveTemporalIndex(const GRefPtr<GstSample>& sample)
{
#if GST_CHECK_VERSION(1, 20, 0)
auto caps = gst_sample_get_caps(sample.get());
auto structure = gst_caps_get_structure(caps, 0);
auto buffer = gst_sample_get_buffer(sample.get());
if (gst_structure_has_name(structure, "video/x-vp8")) {
auto meta = gst_buffer_get_custom_meta(buffer, "GstVP8Meta");
if (!meta) {
GST_TRACE("VP8Meta not found in VP8 sample");
return { };
}
auto metaStructure = gst_custom_meta_get_structure(meta);
RELEASE_ASSERT(metaStructure);
GST_TRACE("Looking-up layer id in %" GST_PTR_FORMAT, metaStructure);
return gstStructureGet<unsigned>(metaStructure, "layer-id"_s);
}
#ifndef GST_DISABLE_GST_DEBUG
auto nameView = gstStructureGetName(structure);
auto name = nameView.utf8();
GST_TRACE("Retrieval of temporal index from encoded format %s is not yet supported.", name.data());
#endif
#endif
return { };
}
GStreamerInternalVideoEncoder::GStreamerInternalVideoEncoder(const VideoEncoder::Config& config, VideoEncoder::DescriptionCallback&& descriptionCallback, VideoEncoder::OutputCallback&& outputCallback)
: m_config(config)
, m_descriptionCallback(WTFMove(descriptionCallback))
, m_outputCallback(WTFMove(outputCallback))
{
GRefPtr<GstElement> element = gst_element_factory_make("webkitvideoencoder", nullptr);
auto pad = adoptGRef(gst_element_get_static_pad(element.get(), "src"));
g_signal_connect_data(pad.get(), "notify::caps", G_CALLBACK(+[](GObject* pad, GParamSpec*, gpointer userData) {
auto weakEncoder = static_cast<ThreadSafeWeakPtr<GStreamerInternalVideoEncoder>*>(userData);
auto encoder = weakEncoder->get();
if (!encoder)
return;
GRefPtr<GstCaps> caps;
g_object_get(pad, "caps", &caps.outPtr(), nullptr);
if (!caps)
return;
VideoEncoder::ActiveConfiguration configuration;
configuration.colorSpace = videoColorSpaceFromCaps(caps.get());
auto structure = gst_caps_get_structure(caps.get(), 0);
GstBuffer* header = nullptr;
if (auto streamHeader = gst_structure_get_value(structure, "streamheader")) {
RELEASE_ASSERT(GST_VALUE_HOLDS_ARRAY(streamHeader));
auto firstValue = gst_value_array_get_value(streamHeader, 0);
RELEASE_ASSERT(GST_VALUE_HOLDS_BUFFER(firstValue));
header = gst_value_get_buffer(firstValue);
} else if (auto codecData = gst_structure_get_value(structure, "codec_data")) {
RELEASE_ASSERT(GST_VALUE_HOLDS_BUFFER(codecData));
header = gst_value_get_buffer(codecData);
}
if (header) {
GstMappedBuffer buffer(header, GST_MAP_READ);
configuration.description = buffer.createVector();
}
encoder->m_descriptionCallback(WTFMove(configuration));
}), new ThreadSafeWeakPtr { *this }, [](void* data, GClosure*) {
delete static_cast<ThreadSafeWeakPtr<GStreamerInternalVideoEncoder>*>(data);
}, static_cast<GConnectFlags>(0));
m_harness = GStreamerElementHarness::create(WTFMove(element), [weakThis = ThreadSafeWeakPtr { *this }, this](auto&, GRefPtr<GstSample>&& outputSample) {
RefPtr protectedThis = weakThis.get();
if (!protectedThis)
return;
if (m_isClosed)
return;
static std::once_flag onceFlag;
std::call_once(onceFlag, [this] {
m_harness->dumpGraph("video-encoder"_s);
});
std::optional<unsigned> temporalIndex;
if (m_hasMultipleTemporalLayers)
temporalIndex = retrieveTemporalIndex(outputSample);
auto outputBuffer = gst_sample_get_buffer(outputSample.get());
bool isKeyFrame = !GST_BUFFER_FLAG_IS_SET(outputBuffer, GST_BUFFER_FLAG_DELTA_UNIT);
GST_TRACE_OBJECT(m_harness->element(), "Notifying encoded%s frame", isKeyFrame ? " key" : "");
GstMappedBuffer encodedImage(outputBuffer, GST_MAP_READ);
VideoEncoder::EncodedFrame encodedFrame { encodedImage.createVector(), isKeyFrame, m_timestamp, m_duration, temporalIndex };
m_outputCallback({ WTFMove(encodedFrame) });
});
}
GStreamerInternalVideoEncoder::~GStreamerInternalVideoEncoder()
{
if (!m_harness)
return;
auto pad = adoptGRef(gst_element_get_static_pad(m_harness->element(), "src"));
g_signal_handlers_disconnect_by_data(pad.get(), this);
}
String GStreamerInternalVideoEncoder::initialize(const String& codecName)
{
GST_DEBUG_OBJECT(m_harness->element(), "Initializing encoder for codec %s", codecName.ascii().data());
IntSize size { static_cast<int>(m_config.width), static_cast<int>(m_config.height) };
if (!videoEncoderSetCodec(WEBKIT_VIDEO_ENCODER(m_harness->element()), codecName, { size }))
return "Unable to set encoder format"_s;
applyRates();
m_isInitialized = true;
return emptyString();
}
bool GStreamerInternalVideoEncoder::encode(VideoEncoder::RawFrame&& rawFrame, bool shouldGenerateKeyFrame)
{
if (!m_isInitialized) {
GST_WARNING_OBJECT(m_harness->element(), "Encoder not initialized");
return true;
}
m_timestamp = rawFrame.timestamp;
m_duration = rawFrame.duration;
if (shouldGenerateKeyFrame) {
GST_INFO_OBJECT(m_harness->element(), "Requesting key-frame!");
m_harness->pushEvent(gst_video_event_new_downstream_force_key_unit(GST_CLOCK_TIME_NONE, GST_CLOCK_TIME_NONE, GST_CLOCK_TIME_NONE, FALSE, 1));
}
auto& gstVideoFrame = downcast<VideoFrameGStreamer>(rawFrame.frame.get());
return m_harness->pushSample(gstVideoFrame.sample());
}
void GStreamerInternalVideoEncoder::setRates(uint64_t bitRate, double frameRate)
{
m_config.bitRate = bitRate;
m_config.frameRate = frameRate;
applyRates();
}
void GStreamerInternalVideoEncoder::applyRates()
{
// FIXME: Propagate m_config.frameRate to caps?
if (m_config.bitRate > 1000)
g_object_set(m_harness->element(), "bitrate", static_cast<uint32_t>(m_config.bitRate / 1000), nullptr);
auto bitRateAllocation = WebKitVideoEncoderBitRateAllocation::create(m_config.scalabilityMode);
auto totalBitRate = m_config.bitRate ? m_config.bitRate : 3 * m_config.width * m_config.height;
switch (m_config.scalabilityMode) {
case VideoEncoder::ScalabilityMode::L1T1:
bitRateAllocation->setBitRate(0, 0, totalBitRate);
break;
case VideoEncoder::ScalabilityMode::L1T2:
m_hasMultipleTemporalLayers = true;
bitRateAllocation->setBitRate(0, 0, totalBitRate * 0.6);
bitRateAllocation->setBitRate(0, 1, totalBitRate * 0.4);
break;
case VideoEncoder::ScalabilityMode::L1T3:
m_hasMultipleTemporalLayers = true;
bitRateAllocation->setBitRate(0, 0, totalBitRate * 0.5);
bitRateAllocation->setBitRate(0, 1, totalBitRate * 0.3);
bitRateAllocation->setBitRate(0, 2, totalBitRate * 0.2);
break;
}
videoEncoderSetBitRateAllocation(WEBKIT_VIDEO_ENCODER(m_harness->element()), WTFMove(bitRateAllocation));
}
void GStreamerInternalVideoEncoder::flush()
{
m_harness->flush();
}
#undef GST_CAT_DEFAULT
} // namespace WebCore
#endif // ENABLE(VIDEO) && USE(GSTREAMER)
|