626172a16b
Source files in libcamera start by a comment block header, which
includes the file name and a one-line description of the file contents.
While the latter is useful to get a quick overview of the file contents
at a glance, the former is mostly a source of inconvenience. The name in
the comments can easily get out of sync with the file name when files
are renamed, and copy & paste during development have often lead to
incorrect names being used to start with.
Readers of the source code are expected to know which file they're
looking it. Drop the file name from the header comment block.
The change was generated with the following script:
----------------------------------------
dirs="include/libcamera src test utils"
declare -rA patterns=(
['c']=' \* '
['cpp']=' \* '
['h']=' \* '
['py']='# '
['sh']='# '
)
for ext in ${!patterns[@]} ; do
files=$(for dir in $dirs ; do find $dir -name "*.${ext}" ; done)
pattern=${patterns[${ext}]}
for file in $files ; do
name=$(basename ${file})
sed -i "s/^\(${pattern}\)${name} - /\1/" "$file"
done
done
----------------------------------------
This misses several files that are out of sync with the comment block
header. Those will be addressed separately and manually.
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Daniel Scally <dan.scally@ideasonboard.com>
87 lines
1.8 KiB
C++
87 lines
1.8 KiB
C++
/* SPDX-License-Identifier: LGPL-2.1-or-later */
|
|
/*
|
|
* Copyright (C) 2019, Google Inc.
|
|
*
|
|
* Byte stream buffer
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
#include <type_traits>
|
|
|
|
#include <libcamera/base/class.h>
|
|
#include <libcamera/base/span.h>
|
|
|
|
namespace libcamera {
|
|
|
|
class ByteStreamBuffer
|
|
{
|
|
public:
|
|
ByteStreamBuffer(const uint8_t *base, size_t size);
|
|
ByteStreamBuffer(uint8_t *base, size_t size);
|
|
ByteStreamBuffer(ByteStreamBuffer &&other);
|
|
ByteStreamBuffer &operator=(ByteStreamBuffer &&other);
|
|
|
|
const uint8_t *base() const { return base_; }
|
|
uint32_t offset() const { return (write_ ? write_ : read_) - base_; }
|
|
size_t size() const { return size_; }
|
|
bool overflow() const { return overflow_; }
|
|
|
|
ByteStreamBuffer carveOut(size_t size);
|
|
int skip(size_t size);
|
|
|
|
template<typename T>
|
|
int read(T *t)
|
|
{
|
|
return read(reinterpret_cast<uint8_t *>(t), sizeof(*t));
|
|
}
|
|
|
|
template<typename T>
|
|
int read(const Span<T> &data)
|
|
{
|
|
return read(reinterpret_cast<uint8_t *>(data.data()),
|
|
data.size_bytes());
|
|
}
|
|
|
|
template<typename T>
|
|
const std::remove_reference_t<T> *read(size_t count = 1)
|
|
{
|
|
using return_type = const std::remove_reference_t<T> *;
|
|
return reinterpret_cast<return_type>(read(sizeof(T), count));
|
|
}
|
|
|
|
template<typename T>
|
|
int write(const T *t)
|
|
{
|
|
return write(reinterpret_cast<const uint8_t *>(t), sizeof(*t));
|
|
}
|
|
|
|
template<typename T>
|
|
int write(const Span<T> &data)
|
|
{
|
|
return write(reinterpret_cast<const uint8_t *>(data.data()),
|
|
data.size_bytes());
|
|
}
|
|
|
|
private:
|
|
LIBCAMERA_DISABLE_COPY(ByteStreamBuffer)
|
|
|
|
void setOverflow();
|
|
|
|
int read(uint8_t *data, size_t size);
|
|
const uint8_t *read(size_t size, size_t count);
|
|
int write(const uint8_t *data, size_t size);
|
|
|
|
ByteStreamBuffer *parent_;
|
|
|
|
const uint8_t *base_;
|
|
size_t size_;
|
|
bool overflow_;
|
|
|
|
const uint8_t *read_;
|
|
uint8_t *write_;
|
|
};
|
|
|
|
} /* namespace libcamera */
|