File: video_frame_pool.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (71 lines) | stat: -rw-r--r-- 2,664 bytes parent folder | download | duplicates (11)
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
// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_VIZ_SERVICE_FRAME_SINKS_VIDEO_CAPTURE_VIDEO_FRAME_POOL_H_
#define COMPONENTS_VIZ_SERVICE_FRAME_SINKS_VIDEO_CAPTURE_VIDEO_FRAME_POOL_H_

#include "base/memory/scoped_refptr.h"
#include "components/viz/service/viz_service_export.h"
#include "media/base/video_types.h"
#include "media/capture/mojom/video_capture_buffer.mojom.h"
#include "ui/gfx/geometry/size.h"

namespace media {
class VideoFrame;
}

namespace viz {

// A pool of VideoFrames that can be transported efficiently across mojo service
// boundaries. The underlying backing for VideoFrames depends on the concrete
// implementation.
class VIZ_SERVICE_EXPORT VideoFramePool {
 public:
  VideoFramePool(const VideoFramePool&) = delete;
  VideoFramePool(VideoFramePool&&) = delete;
  VideoFramePool& operator=(const VideoFramePool&) = delete;
  VideoFramePool& operator=(VideoFramePool&&) = delete;

  virtual ~VideoFramePool();

  // Reserves a buffer from the pool and creates a VideoFrame backed by it.
  // When the ref-count of the returned VideoFrame goes to zero, the
  // reservation is released and the frame becomes available for reuse. Returns
  // null if the pool is fully utilized or if the frame couldn't have been
  // created for another reason.
  virtual scoped_refptr<media::VideoFrame> ReserveVideoFrame(
      media::VideoPixelFormat format,
      const gfx::Size& size) = 0;

  // Returns a handle to |frame|'s backing. Note that the client should
  // not allow the ref-count of the passed-in VideoFrame to reach zero until
  // downstream consumers are finished using it, as this would allow the
  // underlying backing to be reused.
  virtual media::mojom::VideoBufferHandlePtr CloneHandleForDelivery(
      const media::VideoFrame& frame) = 0;

  // Returns the current pool utilization, based on the number of VideoFrames
  // being held by the client.
  float GetUtilization() const;

  // Returns the number of frames that are currently reserved (and thus still
  // owned by the caller of |ReserveVideoFrame()|).
  virtual size_t GetNumberOfReservedFrames() const = 0;

  size_t capacity() const { return capacity_; }

 protected:
  // |capacity| is the maximum number of pooled VideoFrames; but they can be of
  // any byte size.
  explicit VideoFramePool(int capacity);

 private:
  // The maximum number of buffers. However, the buffers themselves can be of
  // any byte size.
  const size_t capacity_;
};

}  // namespace viz

#endif  // COMPONENTS_VIZ_SERVICE_FRAME_SINKS_VIDEO_CAPTURE_VIDEO_FRAME_POOL_H_