blob: d5648976568f80545f535b6291fcd6bae5121aa0 [file] [log] [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.
#ifndef MEDIA_BASE_BYTE_QUEUE_H_
#define MEDIA_BASE_BYTE_QUEUE_H_
#include <stddef.h>
#include <stdint.h>
#include <memory>
#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(const uint8_t* data, int size);
// 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);
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_