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>
67 lines
1.6 KiB
C++
67 lines
1.6 KiB
C++
/* SPDX-License-Identifier: LGPL-2.1-or-later */
|
|
/*
|
|
* Copyright (C) 2019, Google Inc.
|
|
*
|
|
* libcamera image formats
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <array>
|
|
#include <map>
|
|
#include <vector>
|
|
|
|
#include <libcamera/geometry.h>
|
|
#include <libcamera/pixel_format.h>
|
|
|
|
#include "libcamera/internal/v4l2_pixelformat.h"
|
|
|
|
namespace libcamera {
|
|
|
|
class PixelFormatInfo
|
|
{
|
|
public:
|
|
enum ColourEncoding {
|
|
ColourEncodingRGB,
|
|
ColourEncodingYUV,
|
|
ColourEncodingRAW,
|
|
};
|
|
|
|
struct Plane {
|
|
unsigned int bytesPerGroup;
|
|
unsigned int verticalSubSampling;
|
|
};
|
|
|
|
bool isValid() const { return format.isValid(); }
|
|
|
|
static const PixelFormatInfo &info(const PixelFormat &format);
|
|
static const PixelFormatInfo &info(const V4L2PixelFormat &format);
|
|
static const PixelFormatInfo &info(const std::string &name);
|
|
|
|
unsigned int stride(unsigned int width, unsigned int plane,
|
|
unsigned int align = 1) const;
|
|
unsigned int planeSize(const Size &size, unsigned int plane,
|
|
unsigned int align = 1) const;
|
|
unsigned int planeSize(unsigned int height, unsigned int plane,
|
|
unsigned int stride) const;
|
|
unsigned int frameSize(const Size &size, unsigned int align = 1) const;
|
|
unsigned int frameSize(const Size &size,
|
|
const std::array<unsigned int, 3> &strides) const;
|
|
|
|
unsigned int numPlanes() const;
|
|
|
|
/* \todo Add support for non-contiguous memory planes */
|
|
const char *name;
|
|
PixelFormat format;
|
|
std::vector<V4L2PixelFormat> v4l2Formats;
|
|
unsigned int bitsPerPixel;
|
|
enum ColourEncoding colourEncoding;
|
|
bool packed;
|
|
|
|
unsigned int pixelsPerGroup;
|
|
|
|
std::array<Plane, 3> planes;
|
|
};
|
|
|
|
} /* namespace libcamera */
|