libcamera/include/libcamera/framebuffer.h
Laurent Pinchart d6d4710d04 libcamera: framebuffer: Make FrameBuffer class Extensible
Implement the D-Pointer design pattern in the FrameBuffer class to allow
changing internal data without affecting the public ABI.

Move the request_ field and the setRequest() function to the
FrameBuffer::Private class. This allows hiding the setRequest() function
from the public API, removing one todo item. More fields may be moved
later.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>
Reviewed-by: Umang Jain <umang.jain@ideasonboard.com>
Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
2021-07-12 19:59:22 +03:00

74 lines
1.4 KiB
C++

/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
* Copyright (C) 2019, Google Inc.
*
* framebuffer.h - Frame buffer handling
*/
#ifndef __LIBCAMERA_FRAMEBUFFER_H__
#define __LIBCAMERA_FRAMEBUFFER_H__
#include <stdint.h>
#include <vector>
#include <libcamera/base/class.h>
#include <libcamera/file_descriptor.h>
namespace libcamera {
class Request;
struct FrameMetadata {
enum Status {
FrameSuccess,
FrameError,
FrameCancelled,
};
struct Plane {
unsigned int bytesused;
};
Status status;
unsigned int sequence;
uint64_t timestamp;
std::vector<Plane> planes;
};
class FrameBuffer final : public Extensible
{
LIBCAMERA_DECLARE_PRIVATE()
public:
struct Plane {
FileDescriptor fd;
unsigned int length;
};
FrameBuffer(const std::vector<Plane> &planes, unsigned int cookie = 0);
const std::vector<Plane> &planes() const { return planes_; }
Request *request() const;
const FrameMetadata &metadata() const { return metadata_; }
unsigned int cookie() const { return cookie_; }
void setCookie(unsigned int cookie) { cookie_ = cookie; }
void cancel() { metadata_.status = FrameMetadata::FrameCancelled; }
private:
LIBCAMERA_DISABLE_COPY_AND_MOVE(FrameBuffer)
friend class V4L2VideoDevice; /* Needed to update metadata_. */
std::vector<Plane> planes_;
FrameMetadata metadata_;
unsigned int cookie_;
};
} /* namespace libcamera */
#endif /* __LIBCAMERA_FRAMEBUFFER_H__ */