summaryrefslogtreecommitdiffstats
path: root/third_party/libwebrtc/api/frame_transformer_interface.h
diff options
context:
space:
mode:
Diffstat (limited to 'third_party/libwebrtc/api/frame_transformer_interface.h')
-rw-r--r--third_party/libwebrtc/api/frame_transformer_interface.h115
1 files changed, 115 insertions, 0 deletions
diff --git a/third_party/libwebrtc/api/frame_transformer_interface.h b/third_party/libwebrtc/api/frame_transformer_interface.h
new file mode 100644
index 0000000000..fba09d5ff0
--- /dev/null
+++ b/third_party/libwebrtc/api/frame_transformer_interface.h
@@ -0,0 +1,115 @@
+/*
+ * Copyright 2020 The WebRTC project authors. All Rights Reserved.
+ *
+ * Use of this source code is governed by a BSD-style license
+ * that can be found in the LICENSE file in the root of the source
+ * tree. An additional intellectual property rights grant can be found
+ * in the file PATENTS. All contributing project authors may
+ * be found in the AUTHORS file in the root of the source tree.
+ */
+
+#ifndef API_FRAME_TRANSFORMER_INTERFACE_H_
+#define API_FRAME_TRANSFORMER_INTERFACE_H_
+
+#include <memory>
+#include <vector>
+
+#include "api/scoped_refptr.h"
+#include "api/video/encoded_frame.h"
+#include "api/video/video_frame_metadata.h"
+#include "rtc_base/ref_count.h"
+
+namespace webrtc {
+
+// Owns the frame payload data.
+class TransformableFrameInterface {
+ public:
+ virtual ~TransformableFrameInterface() = default;
+
+ // Returns the frame payload data. The data is valid until the next non-const
+ // method call.
+ virtual rtc::ArrayView<const uint8_t> GetData() const = 0;
+
+ // Copies `data` into the owned frame payload data.
+ virtual void SetData(rtc::ArrayView<const uint8_t> data) = 0;
+
+ virtual uint8_t GetPayloadType() const = 0;
+ virtual uint32_t GetSsrc() const = 0;
+ virtual uint32_t GetTimestamp() const = 0;
+
+ enum class Direction {
+ kUnknown,
+ kReceiver,
+ kSender,
+ };
+ // TODO(crbug.com/1250638): Remove this distinction between receiver and
+ // sender frames to allow received frames to be directly re-transmitted on
+ // other PeerConnectionss.
+ virtual Direction GetDirection() const { return Direction::kUnknown; }
+};
+
+class TransformableVideoFrameInterface : public TransformableFrameInterface {
+ public:
+ virtual ~TransformableVideoFrameInterface() = default;
+ virtual bool IsKeyFrame() const = 0;
+
+ // Returns data needed in the frame transformation logic; for example,
+ // when the transformation applied to the frame is encryption/decryption, the
+ // additional data holds the serialized generic frame descriptor extension
+ // calculated in webrtc::RtpDescriptorAuthentication.
+ // TODO(bugs.webrtc.org/11380) remove from interface once
+ // webrtc::RtpDescriptorAuthentication is exposed in api/.
+ virtual std::vector<uint8_t> GetAdditionalData() const = 0;
+
+ virtual const VideoFrameMetadata& GetMetadata() const = 0;
+ // TODO(https://crbug.com/webrtc/14709): Make pure virtual when Chromium MOCK
+ // has implemented this.
+ virtual void SetMetadata(const VideoFrameMetadata&) {}
+};
+
+// Extends the TransformableFrameInterface to expose audio-specific information.
+class TransformableAudioFrameInterface : public TransformableFrameInterface {
+ public:
+ virtual ~TransformableAudioFrameInterface() = default;
+
+ // Exposes the frame header, enabling the interface clients to use the
+ // information in the header as needed, for example to compile the list of
+ // csrcs.
+ virtual const RTPHeader& GetHeader() const = 0;
+
+ virtual rtc::ArrayView<const uint32_t> GetContributingSources() const = 0;
+};
+
+// Objects implement this interface to be notified with the transformed frame.
+class TransformedFrameCallback : public rtc::RefCountInterface {
+ public:
+ virtual void OnTransformedFrame(
+ std::unique_ptr<TransformableFrameInterface> frame) = 0;
+
+ protected:
+ ~TransformedFrameCallback() override = default;
+};
+
+// Transforms encoded frames. The transformed frame is sent in a callback using
+// the TransformedFrameCallback interface (see above).
+class FrameTransformerInterface : public rtc::RefCountInterface {
+ public:
+ // Transforms `frame` using the implementing class' processing logic.
+ virtual void Transform(
+ std::unique_ptr<TransformableFrameInterface> transformable_frame) = 0;
+
+ virtual void RegisterTransformedFrameCallback(
+ rtc::scoped_refptr<TransformedFrameCallback>) {}
+ virtual void RegisterTransformedFrameSinkCallback(
+ rtc::scoped_refptr<TransformedFrameCallback>,
+ uint32_t ssrc) {}
+ virtual void UnregisterTransformedFrameCallback() {}
+ virtual void UnregisterTransformedFrameSinkCallback(uint32_t ssrc) {}
+
+ protected:
+ ~FrameTransformerInterface() override = default;
+};
+
+} // namespace webrtc
+
+#endif // API_FRAME_TRANSFORMER_INTERFACE_H_