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


media / base / byte_queue.h [blame]

// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/40285824): Remove this and convert code to safer constructs.
#pragma allow_unsafe_buffers
#endif

#ifndef MEDIA_BASE_BYTE_QUEUE_H_
#define MEDIA_BASE_BYTE_QUEUE_H_

#include <stddef.h>
#include <stdint.h>

#include <memory>

#include "base/containers/span.h"
#include "base/process/memory.h"
#include "media/base/media_export.h"

namespace media {

// Represents a queue of bytes. Data is added to the end of the queue via an
// Push() call and removed via Pop(). The contents of the queue can be observed
// via the Peek() method.
//
// This class manages the underlying storage of the queue and tries to minimize
// the number of buffer copies when data is appended and removed.
class MEDIA_EXPORT ByteQueue {
 public:
  ByteQueue();

  ByteQueue(const ByteQueue&) = delete;
  ByteQueue& operator=(const ByteQueue&) = delete;

  ~ByteQueue();

  // Reset the queue to the empty state.
  void Reset();

  // Appends new bytes onto the end of the queue. If allocation failure occurs,
  // then the append of `data` is not done and returns false. Otherwise, returns
  // true.
  [[nodiscard]] bool Push(base::span<const uint8_t> data);

  // Get a pointer to the front of the queue and the queue size. These values
  // are only valid until the next Push() or Pop() call.
  void Peek(const uint8_t** data, int* size) const;

  // Remove |count| bytes from the front of the queue.
  void Pop(int count);

  // Get a read-only span view of the data. This is only valid until the next
  // Push() or Pop() call.
  base::span<const uint8_t> Data() {
    return {Front(), base::checked_cast<size_t>(used_)};
  }

 private:
  // Default starting size for the queue.
  enum { kDefaultQueueSize = 1024 };

  // Returns a pointer to the front of the queue.
  uint8_t* Front() const;

  // Size of |buffer_|.
  size_t size_ = kDefaultQueueSize;

  // Offset from the start of |buffer_| that marks the front of the queue.
  size_t offset_ = 0u;

  // Number of bytes stored in |buffer_|.
  int used_ = 0;

  std::unique_ptr<uint8_t, base::UncheckedFreeDeleter> buffer_;
};

}  // namespace media

#endif  // MEDIA_BASE_BYTE_QUEUE_H_