@@ -30,6 +30,7 @@ defined names and types without the need of prefixing them.
#include <thread>
#include <libcamera/libcamera.h>
+ #include <libcamera/property_ids.h>
using namespace libcamera;
using namespace std::chrono_literals;
@@ -272,7 +273,10 @@ Using the libcamera ``FrameBufferAllocator``
Applications create a ``FrameBufferAllocator`` for a Camera and use it
to allocate buffers for streams of a ``CameraConfiguration`` with the
-``allocate()`` function.
+``allocate()`` function. The number of buffers to be allocated needs to be
+specified, and should be at least equal to the value of the ``MinimumRequests``
+property in order for the pipeline to have enough requests to be able to
+capture without frame drops.
The list of allocated buffers can be retrieved using the ``Stream`` instance
as the parameter of the ``FrameBufferAllocator::buffers()`` function.
@@ -280,9 +284,10 @@ as the parameter of the ``FrameBufferAllocator::buffers()`` function.
.. code:: cpp
FrameBufferAllocator *allocator = new FrameBufferAllocator(camera);
+ unsigned int bufferCount = camera->properties().get(properties::MinimumRequests);
for (StreamConfiguration &cfg : *config) {
- int ret = allocator->allocate(cfg.stream());
+ int ret = allocator->allocate(cfg.stream(), bufferCount);
if (ret < 0) {
std::cerr << "Can't allocate buffers" << std::endl;
return -ENOMEM;
@@ -206,7 +206,7 @@ implementations for the overridden class members.
const StreamRoles &roles) override;
int configure(Camera *camera, CameraConfiguration *config) override;
- int exportFrameBuffers(Camera *camera, Stream *stream,
+ int exportFrameBuffers(Camera *camera, Stream *stream, unsigned int count,
std::vector<std::unique_ptr<FrameBuffer>> *buffers) override;
int start(Camera *camera, const ControlList *controls) override;
@@ -1185,7 +1185,6 @@ handle this:
.. code-block:: cpp
- unsigned int count = stream->configuration().bufferCount;
VividCameraData *data = cameraData(camera);
return data->video_->exportBuffers(count, buffers);
@@ -126,7 +126,7 @@ private:
void requestComplete(Request *request);
friend class FrameBufferAllocator;
- int exportFrameBuffers(Stream *stream,
+ int exportFrameBuffers(Stream *stream, unsigned int count,
std::vector<std::unique_ptr<FrameBuffer>> *buffers);
};
@@ -25,7 +25,7 @@ public:
FrameBufferAllocator(std::shared_ptr<Camera> camera);
~FrameBufferAllocator();
- int allocate(Stream *stream);
+ int allocate(Stream *stream, unsigned int count);
int free(Stream *stream);
bool allocated() const { return !buffers_.empty(); }
@@ -52,7 +52,7 @@ public:
const StreamRoles &roles) = 0;
virtual int configure(Camera *camera, CameraConfiguration *config) = 0;
- virtual int exportFrameBuffers(Camera *camera, Stream *stream,
+ virtual int exportFrameBuffers(Camera *camera, Stream *stream, unsigned int count,
std::vector<std::unique_ptr<FrameBuffer>> *buffers) = 0;
virtual int start(Camera *camera, const ControlList *controls) = 0;
@@ -253,17 +253,22 @@ int CameraSession::startCapture()
{
int ret;
- /* Identify the stream with the least number of buffers. */
- unsigned int nbuffers = UINT_MAX;
+ unsigned int nbuffers =
+ camera_->properties().get(properties::MinimumRequests).value();
+
for (StreamConfiguration &cfg : *config_) {
- ret = allocator_->allocate(cfg.stream());
+ ret = allocator_->allocate(cfg.stream(), nbuffers);
if (ret < 0) {
std::cerr << "Can't allocate buffers" << std::endl;
return -ENOMEM;
}
unsigned int allocated = allocator_->buffers(cfg.stream()).size();
- nbuffers = std::min(nbuffers, allocated);
+ if (allocated < nbuffers) {
+ std::cerr << "Unable to allocate enough buffers"
+ << std::endl;
+ return -ENOMEM;
+ }
}
/*
@@ -7,6 +7,8 @@
#include <gtest/gtest.h>
+#include <libcamera/property_ids.h>
+
#include "simple_capture.h"
using namespace libcamera;
@@ -44,11 +46,13 @@ void SimpleCapture::configure(StreamRole role)
void SimpleCapture::start()
{
+ unsigned int bufferCount =
+ camera_->properties().get(properties::MinimumRequests).value();
Stream *stream = config_->at(0).stream();
- int count = allocator_->allocate(stream);
+ int count = allocator_->allocate(stream, bufferCount);
ASSERT_GE(count, 0) << "Failed to allocate buffers";
- EXPECT_EQ(count, config_->at(0).bufferCount) << "Allocated less buffers than expected";
+ EXPECT_EQ(count, bufferCount) << "Allocated less buffers than expected";
camera_->requestCompleted.connect(this, &SimpleCapture::requestComplete);
@@ -12,6 +12,7 @@
#include <string>
#include <libcamera/camera_manager.h>
+#include <libcamera/property_ids.h>
#include <libcamera/version.h>
#include <QCoreApplication>
@@ -464,7 +465,14 @@ int MainWindow::startCapture()
for (StreamConfiguration &config : *config_) {
Stream *stream = config.stream();
- ret = allocator_->allocate(stream);
+ /*
+ * We hold on to a buffer for display, so need one extra from
+ * the minimum required for capture.
+ */
+ unsigned int bufferCount =
+ camera_->properties().get(properties::MinimumRequests).value() + 1;
+
+ ret = allocator_->allocate(stream, bufferCount);
if (ret < 0) {
qWarning() << "Failed to allocate capture buffers";
goto error;
@@ -10,6 +10,7 @@
#include <libcamera/camera.h>
#include <libcamera/framebuffer_allocator.h>
+#include <libcamera/property_ids.h>
#include <libcamera/stream.h>
#include "gstlibcamera-utils.h"
@@ -193,13 +194,15 @@ gst_libcamera_allocator_new(std::shared_ptr<Camera> camera,
{
auto *self = GST_LIBCAMERA_ALLOCATOR(g_object_new(GST_TYPE_LIBCAMERA_ALLOCATOR,
nullptr));
+ unsigned int bufferCount =
+ camera->properties().get(properties::MinimumRequests).value();
self->fb_allocator = new FrameBufferAllocator(camera);
for (StreamConfiguration &streamCfg : *config_) {
Stream *stream = streamCfg.stream();
gint ret;
- ret = self->fb_allocator->allocate(stream);
+ ret = self->fb_allocator->allocate(stream, bufferCount);
if (ret == 0)
return nullptr;
@@ -779,7 +779,7 @@ void Camera::disconnect()
disconnected.emit();
}
-int Camera::exportFrameBuffers(Stream *stream,
+int Camera::exportFrameBuffers(Stream *stream, unsigned int count,
std::vector<std::unique_ptr<FrameBuffer>> *buffers)
{
Private *const d = _d();
@@ -796,7 +796,7 @@ int Camera::exportFrameBuffers(Stream *stream,
return d->pipe_->invokeMethod(&PipelineHandler::exportFrameBuffers,
ConnectionTypeBlocking, this, stream,
- buffers);
+ count, buffers);
}
/**
@@ -71,6 +71,7 @@ FrameBufferAllocator::~FrameBufferAllocator()
/**
* \brief Allocate buffers for a configured stream
* \param[in] stream The stream to allocate buffers for
+ * \param[in] count The number of buffers to allocate
*
* Allocate buffers suitable for capturing frames from the \a stream. The Camera
* shall have been previously configured with Camera::configure() and shall be
@@ -79,6 +80,10 @@ FrameBufferAllocator::~FrameBufferAllocator()
* Upon successful allocation, the allocated buffers can be retrieved with the
* buffers() function.
*
+ * This function may allocate less buffers than requested, due to memory and
+ * other system constraints. The caller shall always check the return value to
+ * verify if the number of allocate buffers matches its needs.
+ *
* \return The number of allocated buffers on success or a negative error code
* otherwise
* \retval -EACCES The camera is not in a state where buffers can be allocated
@@ -86,7 +91,7 @@ FrameBufferAllocator::~FrameBufferAllocator()
* not part of the active camera configuration
* \retval -EBUSY Buffers are already allocated for the \a stream
*/
-int FrameBufferAllocator::allocate(Stream *stream)
+int FrameBufferAllocator::allocate(Stream *stream, unsigned int count)
{
const auto &[it, inserted] = buffers_.try_emplace(stream);
@@ -95,7 +100,7 @@ int FrameBufferAllocator::allocate(Stream *stream)
return -EBUSY;
}
- int ret = camera_->exportFrameBuffers(stream, &it->second);
+ int ret = camera_->exportFrameBuffers(stream, count, &it->second);
if (ret == -EINVAL)
LOG(Allocator, Error)
<< "Stream is not part of " << camera_->id()
@@ -116,7 +116,7 @@ public:
generateConfiguration(Camera *camera, const StreamRoles &roles) override;
int configure(Camera *camera, CameraConfiguration *config) override;
- int exportFrameBuffers(Camera *camera, Stream *stream,
+ int exportFrameBuffers(Camera *camera, Stream *stream, unsigned int count,
std::vector<std::unique_ptr<FrameBuffer>> *buffers) override;
int start(Camera *camera, const ControlList *controls) override;
@@ -805,10 +805,9 @@ int PipelineHandlerISI::configure(Camera *camera, CameraConfiguration *c)
return 0;
}
-int PipelineHandlerISI::exportFrameBuffers(Camera *camera, Stream *stream,
+int PipelineHandlerISI::exportFrameBuffers(Camera *camera, Stream *stream, unsigned int count,
std::vector<std::unique_ptr<FrameBuffer>> *buffers)
{
- unsigned int count = stream->configuration().bufferCount;
Pipe *pipe = pipeFromStream(camera, stream);
return pipe->capture->exportBuffers(count, buffers);
@@ -140,7 +140,7 @@ public:
const StreamRoles &roles) override;
int configure(Camera *camera, CameraConfiguration *config) override;
- int exportFrameBuffers(Camera *camera, Stream *stream,
+ int exportFrameBuffers(Camera *camera, Stream *stream, unsigned int count,
std::vector<std::unique_ptr<FrameBuffer>> *buffers) override;
int start(Camera *camera, const ControlList *controls) override;
@@ -689,10 +689,10 @@ int PipelineHandlerIPU3::configure(Camera *camera, CameraConfiguration *c)
}
int PipelineHandlerIPU3::exportFrameBuffers(Camera *camera, Stream *stream,
+ unsigned int count,
std::vector<std::unique_ptr<FrameBuffer>> *buffers)
{
IPU3CameraData *data = cameraData(camera);
- unsigned int count = stream->configuration().bufferCount;
if (stream == &data->outStream_)
return data->imgu_->output_->exportBuffers(count, buffers);
@@ -328,7 +328,7 @@ public:
const StreamRoles &roles) override;
int configure(Camera *camera, CameraConfiguration *config) override;
- int exportFrameBuffers(Camera *camera, Stream *stream,
+ int exportFrameBuffers(Camera *camera, Stream *stream, unsigned int count,
std::vector<std::unique_ptr<FrameBuffer>> *buffers) override;
int start(Camera *camera, const ControlList *controls) override;
@@ -1005,10 +1005,10 @@ int PipelineHandlerRPi::configure(Camera *camera, CameraConfiguration *config)
}
int PipelineHandlerRPi::exportFrameBuffers([[maybe_unused]] Camera *camera, Stream *stream,
+ unsigned int count,
std::vector<std::unique_ptr<FrameBuffer>> *buffers)
{
RPi::Stream *s = static_cast<RPi::Stream *>(stream);
- unsigned int count = stream->configuration().bufferCount;
int ret = s->dev()->exportBuffers(count, buffers);
s->setExportedBuffers(buffers);
@@ -149,7 +149,7 @@ public:
const StreamRoles &roles) override;
int configure(Camera *camera, CameraConfiguration *config) override;
- int exportFrameBuffers(Camera *camera, Stream *stream,
+ int exportFrameBuffers(Camera *camera, Stream *stream, unsigned int count,
std::vector<std::unique_ptr<FrameBuffer>> *buffers) override;
int start(Camera *camera, const ControlList *controls) override;
@@ -817,10 +817,10 @@ int PipelineHandlerRkISP1::configure(Camera *camera, CameraConfiguration *c)
}
int PipelineHandlerRkISP1::exportFrameBuffers([[maybe_unused]] Camera *camera, Stream *stream,
+ unsigned int count,
std::vector<std::unique_ptr<FrameBuffer>> *buffers)
{
RkISP1CameraData *data = cameraData(camera);
- unsigned int count = stream->configuration().bufferCount;
if (stream == &data->mainPathStream_)
return mainPath_.exportBuffers(count, buffers);
@@ -322,7 +322,7 @@ public:
const StreamRoles &roles) override;
int configure(Camera *camera, CameraConfiguration *config) override;
- int exportFrameBuffers(Camera *camera, Stream *stream,
+ int exportFrameBuffers(Camera *camera, Stream *stream, unsigned int count,
std::vector<std::unique_ptr<FrameBuffer>> *buffers) override;
int start(Camera *camera, const ControlList *controls) override;
@@ -1202,10 +1202,10 @@ int SimplePipelineHandler::configure(Camera *camera, CameraConfiguration *c)
}
int SimplePipelineHandler::exportFrameBuffers(Camera *camera, Stream *stream,
+ unsigned int count,
std::vector<std::unique_ptr<FrameBuffer>> *buffers)
{
SimpleCameraData *data = cameraData(camera);
- unsigned int count = stream->configuration().bufferCount;
/*
* Export buffers on the converter or capture video node, depending on
@@ -78,7 +78,7 @@ public:
const StreamRoles &roles) override;
int configure(Camera *camera, CameraConfiguration *config) override;
- int exportFrameBuffers(Camera *camera, Stream *stream,
+ int exportFrameBuffers(Camera *camera, Stream *stream, unsigned int count,
std::vector<std::unique_ptr<FrameBuffer>> *buffers) override;
int start(Camera *camera, const ControlList *controls) override;
@@ -226,11 +226,12 @@ int PipelineHandlerUVC::configure(Camera *camera, CameraConfiguration *config)
return 0;
}
-int PipelineHandlerUVC::exportFrameBuffers(Camera *camera, Stream *stream,
+int PipelineHandlerUVC::exportFrameBuffers(Camera *camera,
+ [[maybe_unused]] Stream *stream,
+ unsigned int count,
std::vector<std::unique_ptr<FrameBuffer>> *buffers)
{
UVCCameraData *data = cameraData(camera);
- unsigned int count = stream->configuration().bufferCount;
return data->video_->exportBuffers(count, buffers);
}
@@ -89,7 +89,7 @@ public:
const StreamRoles &roles) override;
int configure(Camera *camera, CameraConfiguration *config) override;
- int exportFrameBuffers(Camera *camera, Stream *stream,
+ int exportFrameBuffers(Camera *camera, Stream *stream, unsigned int count,
std::vector<std::unique_ptr<FrameBuffer>> *buffers) override;
int start(Camera *camera, const ControlList *controls) override;
@@ -321,11 +321,12 @@ int PipelineHandlerVimc::configure(Camera *camera, CameraConfiguration *config)
return 0;
}
-int PipelineHandlerVimc::exportFrameBuffers(Camera *camera, Stream *stream,
+int PipelineHandlerVimc::exportFrameBuffers(Camera *camera,
+ [[maybe_unused]] Stream *stream,
+ unsigned int count,
std::vector<std::unique_ptr<FrameBuffer>> *buffers)
{
VimcCameraData *data = cameraData(camera);
- unsigned int count = stream->configuration().bufferCount;
return data->video_->exportBuffers(count, buffers);
}
@@ -280,6 +280,7 @@ void PipelineHandler::unlockMediaDevices()
* \brief Allocate and export buffers for \a stream
* \param[in] camera The camera
* \param[in] stream The stream to allocate buffers for
+ * \param[in] count The number of buffers to allocate
* \param[out] buffers Array of buffers successfully allocated
*
* This function allocates buffers for the \a stream from the devices associated
@@ -160,7 +160,7 @@ int V4L2Camera::allocBuffers(unsigned int count)
{
Stream *stream = config_->at(0).stream();
- int ret = bufferAllocator_->allocate(stream);
+ int ret = bufferAllocator_->allocate(stream, count);
if (ret < 0)
return ret;
@@ -17,6 +17,7 @@
#include <libcamera/base/timer.h>
#include <libcamera/framebuffer_allocator.h>
+#include <libcamera/property_ids.h>
#include "camera_test.h"
#include "test.h"
@@ -78,7 +79,9 @@ private:
* same buffer allocation for each run.
*/
if (!allocated_) {
- int ret = allocator_->allocate(stream);
+ unsigned int bufferCount =
+ camera_->properties().get(properties::MinimumRequests).value();
+ int ret = allocator_->allocate(stream, bufferCount);
if (ret < 0) {
cerr << "Failed to allocate buffers" << endl;
return TestFail;
@@ -7,12 +7,13 @@
#include <iostream>
-#include <libcamera/framebuffer_allocator.h>
-
#include <libcamera/base/event_dispatcher.h>
#include <libcamera/base/thread.h>
#include <libcamera/base/timer.h>
+#include <libcamera/framebuffer_allocator.h>
+#include <libcamera/property_ids.h>
+
#include "camera_test.h"
#include "test.h"
@@ -98,8 +99,10 @@ protected:
Stream *stream = cfg.stream();
- int ret = allocator_->allocate(stream);
- if (ret < 0)
+ unsigned int bufferCount =
+ camera_->properties().get(properties::MinimumRequests).value();
+ int ret = allocator_->allocate(stream, bufferCount);
+ if (ret < static_cast<int>(bufferCount))
return TestFail;
for (const std::unique_ptr<FrameBuffer> &buffer : allocator_->buffers(stream)) {
@@ -8,6 +8,7 @@
#include <iostream>
#include <libcamera/framebuffer_allocator.h>
+#include <libcamera/property_ids.h>
#include "camera_test.h"
#include "test.h"
@@ -120,7 +121,9 @@ protected:
/* Use internally allocated buffers. */
allocator_ = new FrameBufferAllocator(camera_);
Stream *stream = *camera_->streams().begin();
- if (allocator_->allocate(stream) < 0)
+ unsigned int bufferCount =
+ camera_->properties().get(properties::MinimumRequests).value();
+ if (allocator_->allocate(stream, bufferCount) < 0)
return TestFail;
if (camera_->start())
@@ -18,6 +18,7 @@
#include <libcamera/fence.h>
#include <libcamera/framebuffer_allocator.h>
+#include <libcamera/property_ids.h>
#include "camera_test.h"
#include "test.h"
@@ -117,8 +118,11 @@ int FenceTest::init()
StreamConfiguration &cfg = config_->at(0);
stream_ = cfg.stream();
+ unsigned int bufferCount =
+ camera_->properties().get(properties::MinimumRequests).value();
+
allocator_ = std::make_unique<FrameBufferAllocator>(camera_);
- if (allocator_->allocate(stream_) < 0)
+ if (allocator_->allocate(stream_, bufferCount) < 0)
return TestFail;
nbuffers_ = allocator_->buffers(stream_).size();
@@ -8,6 +8,7 @@
#include <iostream>
#include <libcamera/framebuffer_allocator.h>
+#include <libcamera/property_ids.h>
#include "libcamera/internal/mapped_framebuffer.h"
@@ -55,7 +56,9 @@ protected:
stream_ = cfg.stream();
- int ret = allocator_->allocate(stream_);
+ unsigned int bufferCount =
+ camera_->properties().get(properties::MinimumRequests).value();
+ int ret = allocator_->allocate(stream_, bufferCount);
if (ret < 0)
return TestFail;