diff options
author | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2019-02-28 17:45:58 +0200 |
---|---|---|
committer | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2019-03-01 15:45:09 +0200 |
commit | fca7602c3c88e804d1fbb5ae1372e2e6e841a4ee (patch) | |
tree | 8235a7b82e9cb989c07442cea09601f87e251ab7 /src/libcamera/buffer.cpp | |
parent | b581b9576abd6cfde9c703b48ba1ab1e48985e6d (diff) |
libcamera: buffer: Add buffer completion status
Add a new field to the Buffer class to report its completion status,
with a new cancel() method to mark the buffer as cancelled.
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
Diffstat (limited to 'src/libcamera/buffer.cpp')
-rw-r--r-- | src/libcamera/buffer.cpp | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp index 80dd9c85..524eb47d 100644 --- a/src/libcamera/buffer.cpp +++ b/src/libcamera/buffer.cpp @@ -181,6 +181,20 @@ void *Plane::mem() * objects if the image format is multi-planar. */ +/** + * \enum Buffer::Status + * Buffer completion status + * \var Buffer::BufferSuccess + * The buffer has completed with success and contains valid data. All its other + * metadata (such as bytesused(), timestamp() or sequence() number) are valid. + * \var Buffer::BufferError + * The buffer has completed with an error and doesn't contain valid data. Its + * other metadata are valid. + * \var Buffer::BufferCancelled + * The buffer has been cancelled due to capture stop. Its other metadata are + * invalid and shall not be used. + */ + Buffer::Buffer() : index_(-1) { @@ -230,6 +244,27 @@ Buffer::Buffer() */ /** + * \fn Buffer::status() + * \brief Retrieve the buffer status + * + * The buffer status reports whether the buffer has completed successfully + * (BufferSuccess) or if an error occurred (BufferError). + * + * \return The buffer status + */ + +/** + * \brief Mark a buffer as cancel by setting its status to BufferCancelled + */ +void Buffer::cancel() +{ + bytesused_ = 0; + timestamp_ = 0; + sequence_ = 0; + status_ = BufferCancelled; +} + +/** * \class BufferPool * \brief A pool of buffers * |