| /* |
| * Copyright (c) 2015 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 WEBRTC_API_VIDEO_VIDEO_FRAME_BUFFER_H_ |
| #define WEBRTC_API_VIDEO_VIDEO_FRAME_BUFFER_H_ |
| |
| #include <stdint.h> |
| |
| #include "webrtc/base/refcount.h" |
| #include "webrtc/base/scoped_ref_ptr.h" |
| |
| namespace webrtc { |
| |
| class PlanarYuvBuffer; |
| |
| // Base class for frame buffers of different types of pixel format and storage. |
| // The tag in type() indicates how the data is represented, and each type is |
| // implemented as a subclass. To access the pixel data, call the appropriate |
| // GetXXX() function, where XXX represents the type. There is also a function |
| // ToI420() that returns a frame buffer in I420 format, converting from the |
| // underlying representation if necessary. I420 is the most widely accepted |
| // format and serves as a fallback for video sinks that can only handle I420, |
| // e.g. the internal WebRTC software encoders. A special enum value 'kNative' is |
| // provided for external clients to implement their own frame buffer |
| // representations, e.g. as textures. The external client can produce such |
| // native frame buffers from custom video sources, and then cast it back to the |
| // correct subclass in custom video sinks. The purpose of this is to improve |
| // performance by providing an optimized path without intermediate conversions. |
| // Frame metadata such as rotation and timestamp are stored in |
| // webrtc::VideoFrame, and not here. |
| class VideoFrameBuffer : public rtc::RefCountInterface { |
| public: |
| // New frame buffer types will be added conservatively when there is an |
| // opportunity to optimize the path between some pair of video source and |
| // video sink. |
| enum class Type { |
| kNative, |
| kI420, |
| kI444, |
| }; |
| |
| // This function specifies in what pixel format the data is stored in. |
| virtual Type type() const; |
| |
| // The resolution of the frame in pixels. For formats where some planes are |
| // subsampled, this is the highest-resolution plane. |
| virtual int width() const = 0; |
| virtual int height() const = 0; |
| |
| // Returns a memory-backed frame buffer in I420 format. If the pixel data is |
| // in another format, a conversion will take place. All implementations must |
| // provide a fallback to I420 for compatibility with e.g. the internal WebRTC |
| // software encoders. |
| virtual rtc::scoped_refptr<PlanarYuvBuffer> ToI420(); |
| |
| // These functions should only be called if type() is of the correct type. |
| // Calling with a different type will result in a crash. |
| rtc::scoped_refptr<PlanarYuvBuffer> GetI420(); |
| rtc::scoped_refptr<PlanarYuvBuffer> GetI444(); |
| |
| // Deprecated - use ToI420() first instead. |
| // Returns pointer to the pixel data for a given plane. The memory is owned by |
| // the VideoFrameBuffer object and must not be freed by the caller. |
| virtual const uint8_t* DataY() const; |
| virtual const uint8_t* DataU() const; |
| virtual const uint8_t* DataV() const; |
| // Returns the number of bytes between successive rows for a given plane. |
| virtual int StrideY() const; |
| virtual int StrideU() const; |
| virtual int StrideV() const; |
| |
| // Deprecated - use type() to determine if the stored data is kNative, and |
| // then cast into the appropriate type. |
| // Return the handle of the underlying video frame. This is used when the |
| // frame is backed by a texture. |
| virtual void* native_handle() const; |
| |
| // Deprecated - use ToI420() instead. |
| virtual rtc::scoped_refptr<VideoFrameBuffer> NativeToI420Buffer(); |
| |
| protected: |
| ~VideoFrameBuffer() override {} |
| }; |
| |
| // This interface represents Type::kI420 and Type::kI444. |
| class PlanarYuvBuffer : public VideoFrameBuffer { |
| public: |
| int ChromaWidth() const; |
| int ChromaHeight() const; |
| |
| // Returns pointer to the pixel data for a given plane. The memory is owned by |
| // the VideoFrameBuffer object and must not be freed by the caller. |
| const uint8_t* DataY() const override = 0; |
| const uint8_t* DataU() const override = 0; |
| const uint8_t* DataV() const override = 0; |
| |
| // Returns the number of bytes between successive rows for a given plane. |
| int StrideY() const override = 0; |
| int StrideU() const override = 0; |
| int StrideV() const override = 0; |
| |
| rtc::scoped_refptr<PlanarYuvBuffer> ToI420() override; |
| |
| protected: |
| ~PlanarYuvBuffer() override {} |
| }; |
| |
| } // namespace webrtc |
| |
| #endif // WEBRTC_API_VIDEO_VIDEO_FRAME_BUFFER_H_ |