NekoCWD/libcamera
NekoCWD/libcamera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 7 Wiki Activity Actions

libcamera: camera: Rename name() to id()

Browse source 
Rename Camera::name() to camera::id() to better describe what it
represents, a unique and stable ID for the camera. While at it improve
the documentation for the camera ID to describe it needs to be stable
for a camera between resets of the system.

Signed-off-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
This commit is contained in:
Niklas Söderlund 2020-08-02 23:57:17 +02:00
parent 53d38b19ed
commit 2e7c80a4f9
17 changed files with 91 additions and 70 deletions
Download patch file Download diff file Expand all files Collapse all files

6
include/libcamera/camera.h
View file

@ -71,13 +71,13 @@ class Camera final : public Object, public std::enable_shared_from_this<Camera>
{
public:
static std::shared_ptr<Camera> create(PipelineHandler *pipe,
const std::string &name,
const std::string &id,
const std::set<Stream *> &streams);
Camera(const Camera &) = delete;
Camera &operator=(const Camera &) = delete;
const std::string &name() const;
const std::string &id() const;
Signal<Request *, FrameBuffer *> bufferCompleted;
Signal<Request *> requestCompleted;
@ -100,7 +100,7 @@ public:
int stop();
private:
Camera(PipelineHandler *pipe, const std::string &name,
Camera(PipelineHandler *pipe, const std::string &id,
const std::set<Stream *> &streams);
~Camera();

4
src/android/camera_device.cpp
View file

@ -1108,7 +1108,7 @@ int CameraDevice::configureStreams(camera3_stream_configuration_t *stream_list)
int ret = camera_->configure(config_.get());
if (ret) {
LOG(HAL, Error) << "Failed to configure camera '"
<< camera_->name() << "'";
<< camera_->id() << "'";
return ret;
}
@ -1276,7 +1276,7 @@ void CameraDevice::requestComplete(Request *request)
std::string CameraDevice::logPrefix() const
{
return "'" + camera_->name() + "'";
return "'" + camera_->id() + "'";
}
void CameraDevice::notifyShutter(uint32_t frameNumber, uint64_t timestamp)

10
src/cam/main.cpp
View file

@ -117,7 +117,7 @@ int CamApp::init(int argc, char **argv)
return -EINVAL;
}
std::cout << "Using camera " << camera_->name() << std::endl;
std::cout << "Using camera " << camera_->id() << std::endl;
ret = prepareConfig();
if (ret) {
@ -174,7 +174,7 @@ int CamApp::parseOptions(int argc, char *argv[])
OptionsParser parser;
parser.addOption(OptCamera, OptionString,
"Specify which camera to operate on, by name or by index", "camera",
"Specify which camera to operate on, by id or by index", "camera",
ArgumentRequired, "camera");
parser.addOption(OptCapture, OptionInteger,
"Capture until interrupted by user or until <count> frames captured",
@ -323,12 +323,12 @@ int CamApp::infoConfiguration()
void CamApp::cameraAdded(std::shared_ptr<Camera> cam)
{
std::cout << "Camera Added: " << cam->name() << std::endl;
std::cout << "Camera Added: " << cam->id() << std::endl;
}
void CamApp::cameraRemoved(std::shared_ptr<Camera> cam)
{
std::cout << "Camera Removed: " << cam->name() << std::endl;
std::cout << "Camera Removed: " << cam->id() << std::endl;
}
int CamApp::run()
@ -340,7 +340,7 @@ int CamApp::run()
unsigned int index = 1;
for (const std::shared_ptr<Camera> &cam : cm_->cameras()) {
std::cout << index << ": " << cam->name() << std::endl;
std::cout << index << ": " << cam->id() << std::endl;
index++;
}
}

4
src/gstreamer/gstlibcameraprovider.cpp
View file

@ -127,7 +127,7 @@ static GstDevice *
gst_libcamera_device_new(const std::shared_ptr<Camera> &camera)
{
g_autoptr(GstCaps) caps = gst_caps_new_empty();
const gchar *name = camera->name().c_str();
const gchar *name = camera->id().c_str();
StreamRoles roles;
roles.push_back(StreamRole::VideoRecording);
@ -189,7 +189,7 @@ gst_libcamera_provider_probe(GstDeviceProvider *provider)
}
for (const std::shared_ptr<Camera> &camera : cm->cameras()) {
GST_INFO_OBJECT(self, "Found camera '%s'", camera->name().c_str());
GST_INFO_OBJECT(self, "Found camera '%s'", camera->id().c_str());
devices = g_list_append(devices,
g_object_ref_sink(gst_libcamera_device_new(camera)));
}

6
src/gstreamer/gstlibcamerasrc.cpp
View file

@ -241,12 +241,12 @@ gst_libcamera_src_open(GstLibcameraSrc *self)
cam = cm->cameras()[0];
}
GST_INFO_OBJECT(self, "Using camera named '%s'", cam->name().c_str());
GST_INFO_OBJECT(self, "Using camera '%s'", cam->id().c_str());
ret = cam->acquire();
if (ret) {
GST_ELEMENT_ERROR(self, RESOURCE, BUSY,
("Camera name '%s' is already in use.", cam->name().c_str()),
("Camera '%s' is already in use.", cam->id().c_str()),
("libcamera::Camera::acquire() failed: %s", g_strerror(ret)));
return false;
}
@ -495,7 +495,7 @@ gst_libcamera_src_close(GstLibcameraSrc *self)
ret = state->cam_->release();
if (ret) {
GST_ELEMENT_WARNING(self, RESOURCE, BUSY,
("Camera name '%s' is still in use.", state->cam_->name().c_str()),
("Camera '%s' is still in use.", state->cam_->id().c_str()),
("libcamera::Camera.release() failed: %s", g_strerror(-ret)));
}

51
src/libcamera/camera.cpp
View file

@ -265,7 +265,7 @@ public:
CameraRunning,
};
Private(PipelineHandler *pipe, const std::string &name,
Private(PipelineHandler *pipe, const std::string &id,
const std::set<Stream *> &streams);
~Private();
@ -277,7 +277,7 @@ public:
void setState(State state);
std::shared_ptr<PipelineHandler> pipe_;
std::string name_;
std::string id_;
std::set<Stream *> streams_;
std::set<Stream *> activeStreams_;
@ -286,9 +286,9 @@ private:
std::atomic<State> state_;
};
Camera::Private::Private(PipelineHandler *pipe, const std::string &name,
Camera::Private::Private(PipelineHandler *pipe, const std::string &id,
const std::set<Stream *> &streams)
: pipe_(pipe->shared_from_this()), name_(name), streams_(streams),
: pipe_(pipe->shared_from_this()), id_(id), streams_(streams),
disconnected_(false), state_(CameraAvailable)
{
}
@ -450,15 +450,21 @@ void Camera::Private::setState(State state)
/**
* \brief Create a camera instance
* \param[in] pipe The pipeline handler responsible for the camera device
* \param[in] name The name of the camera device
* \param[in] id The ID of the camera device
* \param[in] streams Array of streams the camera provides
*
* The caller is responsible for guaranteeing unicity of the camera name.
* The caller is responsible for guaranteeing a stable and unique camera ID
* matching the constraints described by Camera::id(). Parameters that are
* allocated dynamically at system startup, such as bus numbers that may be
* enumerated differently, are therefore not suitable to use in the ID.
*
* Pipeline handlers that use a CameraSensor may use the CameraSensor::id() to
* generate an ID that satisfies the criteria of a stable and unique camera ID.
*
* \return A shared pointer to the newly created camera object
*/
std::shared_ptr<Camera> Camera::create(PipelineHandler *pipe,
const std::string &name,
const std::string &id,
const std::set<Stream *> &streams)
{
struct Deleter : std::default_delete<Camera> {
@ -468,19 +474,34 @@ std::shared_ptr<Camera> Camera::create(PipelineHandler *pipe,
}
};
Camera *camera = new Camera(pipe, name, streams);
Camera *camera = new Camera(pipe, id, streams);
return std::shared_ptr<Camera>(camera, Deleter());
}
/**
* \brief Retrieve the name of the camera
* \brief Retrieve the ID of the camera
*
* The camera ID is a free-form string that identifies a camera in the system.
* IDs are guaranteed to be unique and stable: the same camera, when connected
* to the system in the same way (e.g. in the same USB port), will have the same
* ID across both unplug/replug and system reboots.
*
* Applications may store the camera ID and use it later to acquire the same
* camera. They shall treat the ID as an opaque identifier, without interpreting
* its value.
*
* Camera IDs may change when the system hardware or firmware is modified, for
* instance when replacing a PCI USB controller or moving it to another PCI
* slot, or updating the ACPI tables or Device Tree.
*
* \context This function is \threadsafe.
* \return Name of the camera device
*
* \return ID of the camera device
*/
const std::string &Camera::name() const
const std::string &Camera::id() const
{
return p_->name_;
return p_->id_;
}
/**
@ -506,9 +527,9 @@ const std::string &Camera::name() const
* application API calls by returning errors immediately.
*/
Camera::Camera(PipelineHandler *pipe, const std::string &name,
Camera::Camera(PipelineHandler *pipe, const std::string &id,
const std::set<Stream *> &streams)
: p_(new Private(pipe, name, streams))
: p_(new Private(pipe, id, streams))
{
}
@ -530,7 +551,7 @@ Camera::~Camera()
*/
void Camera::disconnect()
{
LOG(Camera, Debug) << "Disconnecting camera " << name();
LOG(Camera, Debug) << "Disconnecting camera " << id();
p_->disconnect();
disconnected.emit(this);

2
src/libcamera/camera_controls.cpp
View file

@ -36,7 +36,7 @@ CameraControlValidator::CameraControlValidator(Camera *camera)
const std::string &CameraControlValidator::name() const
{
return camera_->name();
return camera_->id();
}
/**

16
src/libcamera/camera_manager.cpp
View file

@ -181,10 +181,10 @@ void CameraManager::Private::addCamera(std::shared_ptr<Camera> camera,
MutexLocker locker(mutex_);
for (std::shared_ptr<Camera> c : cameras_) {
if (c->name() == camera->name()) {
if (c->id() == camera->id()) {
LOG(Camera, Warning)
<< "Registering camera with duplicate name '"
<< camera->name() << "'";
<< "Registering camera with duplicate ID '"
<< camera->id() << "'";
break;
}
}
@ -208,7 +208,7 @@ void CameraManager::Private::removeCamera(Camera *camera)
return;
LOG(Camera, Debug)
<< "Unregistering camera '" << camera->name() << "'";
<< "Unregistering camera '" << camera->id() << "'";
auto iter_d = std::find_if(camerasByDevnum_.begin(), camerasByDevnum_.end(),
[camera](const std::pair<dev_t, std::weak_ptr<Camera>> &p) {
@ -329,8 +329,8 @@ std::vector<std::shared_ptr<Camera>> CameraManager::cameras() const
}
/**
* \brief Get a camera based on name
* \param[in] name Name of camera to get
* \brief Get a camera based on ID
* \param[in] id ID of camera to get
*
* Before calling this function the caller is responsible for ensuring that
* the camera manager is running.
@ -339,12 +339,12 @@ std::vector<std::shared_ptr<Camera>> CameraManager::cameras() const
*
* \return Shared pointer to Camera object or nullptr if camera not found
*/
std::shared_ptr<Camera> CameraManager::get(const std::string &name)
std::shared_ptr<Camera> CameraManager::get(const std::string &id)
{
MutexLocker locker(p_->mutex_);
for (std::shared_ptr<Camera> camera : p_->cameras_) {
if (camera->name() == name)
if (camera->id() == id)
return camera;
}

2
src/libcamera/framebuffer_allocator.cpp
View file

@ -95,7 +95,7 @@ int FrameBufferAllocator::allocate(Stream *stream)
int ret = camera_->exportFrameBuffers(stream, &buffers_[stream]);
if (ret == -EINVAL)
LOG(Allocator, Error)
<< "Stream is not part of " << camera_->name()
<< "Stream is not part of " << camera_->id()
<< " active configuration";
return ret;
}

5
src/libcamera/pipeline/ipu3/ipu3.cpp
View file

@ -629,7 +629,7 @@ int PipelineHandlerIPU3::start(Camera *camera)
error:
freeBuffers(camera);
LOG(IPU3, Error) << "Failed to start camera " << camera->name();
LOG(IPU3, Error) << "Failed to start camera " << camera->id();
return ret;
}
@ -642,8 +642,7 @@ void PipelineHandlerIPU3::stop(Camera *camera)
ret |= data->imgu_->stop();
ret |= data->cio2_.stop();
if (ret)
LOG(IPU3, Warning) << "Failed to stop camera "
<< camera->name();
LOG(IPU3, Warning) << "Failed to stop camera " << camera->id();
freeBuffers(camera);
}

4
src/libcamera/pipeline/raspberrypi/raspberrypi.cpp
View file

@ -643,7 +643,7 @@ int PipelineHandlerRPi::configure(Camera *camera, CameraConfiguration *config)
if (ret)
return ret;
LOG(RPI, Info) << "Sensor: " << camera->name()
LOG(RPI, Info) << "Sensor: " << camera->id()
<< " - Selected mode: " << sensorFormat.toString();
/*
@ -793,7 +793,7 @@ int PipelineHandlerRPi::start(Camera *camera)
ret = data->ipa_->start();
if (ret) {
LOG(RPI, Error)
<< "Failed to start IPA for " << camera->name();
<< "Failed to start IPA for " << camera->id();
stop(camera);
return ret;
}

14
src/libcamera/pipeline/rkisp1/rkisp1.cpp
View file

@ -798,7 +798,7 @@ int PipelineHandlerRkISP1::start(Camera *camera)
if (ret) {
freeBuffers(camera);
LOG(RkISP1, Error)
<< "Failed to start IPA " << camera->name();
<< "Failed to start IPA " << camera->id();
return ret;
}
@ -809,7 +809,7 @@ int PipelineHandlerRkISP1::start(Camera *camera)
data->ipa_->stop();
freeBuffers(camera);
LOG(RkISP1, Error)
<< "Failed to start parameters " << camera->name();
<< "Failed to start parameters " << camera->id();
return ret;
}
@ -819,7 +819,7 @@ int PipelineHandlerRkISP1::start(Camera *camera)
data->ipa_->stop();
freeBuffers(camera);
LOG(RkISP1, Error)
<< "Failed to start statistics " << camera->name();
<< "Failed to start statistics " << camera->id();
return ret;
}
@ -831,7 +831,7 @@ int PipelineHandlerRkISP1::start(Camera *camera)
freeBuffers(camera);
LOG(RkISP1, Error)
<< "Failed to start camera " << camera->name();
<< "Failed to start camera " << camera->id();
}
activeCamera_ = camera;
@ -870,17 +870,17 @@ void PipelineHandlerRkISP1::stop(Camera *camera)
ret = video_->streamOff();
if (ret)
LOG(RkISP1, Warning)
<< "Failed to stop camera " << camera->name();
<< "Failed to stop camera " << camera->id();
ret = stat_->streamOff();
if (ret)
LOG(RkISP1, Warning)
<< "Failed to stop statistics " << camera->name();
<< "Failed to stop statistics " << camera->id();
ret = param_->streamOff();
if (ret)
LOG(RkISP1, Warning)
<< "Failed to stop parameters " << camera->name();
<< "Failed to stop parameters " << camera->id();
data->ipa_->stop();

5
src/qcam/dng_writer.cpp
View file

@ -386,8 +386,9 @@ int DNGWriter::write(const char *filename, const Camera *camera,
TIFFSetField(tif, TIFFTAG_DNGBACKWARDVERSION, version);
TIFFSetField(tif, TIFFTAG_FILLORDER, FILLORDER_MSB2LSB);
TIFFSetField(tif, TIFFTAG_MAKE, "libcamera");
TIFFSetField(tif, TIFFTAG_MODEL, camera->name().c_str());
TIFFSetField(tif, TIFFTAG_UNIQUECAMERAMODEL, camera->name().c_str());
/* \todo Report a real model string instead of id. */
TIFFSetField(tif, TIFFTAG_MODEL, camera->id().c_str());
TIFFSetField(tif, TIFFTAG_UNIQUECAMERAMODEL, camera->id().c_str());
TIFFSetField(tif, TIFFTAG_SOFTWARE, "qcam");
TIFFSetField(tif, TIFFTAG_ORIENTATION, ORIENTATION_TOPLEFT);

26
src/qcam/main_window.cpp
View file

@ -169,7 +169,7 @@ int MainWindow::createToolbars()
this, &MainWindow::switchCamera);
for (const std::shared_ptr<Camera> &cam : cm_->cameras())
cameraCombo_->addItem(QString::fromStdString(cam->name()));
cameraCombo_->addItem(QString::fromStdString(cam->id()));
toolbar_->addWidget(cameraCombo_);
@ -241,11 +241,11 @@ void MainWindow::switchCamera(int index)
const std::shared_ptr<Camera> &cam = cameras[index];
if (cam->acquire()) {
qInfo() << "Failed to acquire camera" << cam->name().c_str();
qInfo() << "Failed to acquire camera" << cam->id().c_str();
return;
}
qInfo() << "Switching to camera" << cam->name().c_str();
qInfo() << "Switching to camera" << cam->id().c_str();
/*
* Stop the capture session, release the current camera, replace it with
@ -266,19 +266,19 @@ std::string MainWindow::chooseCamera()
/* If only one camera is available, use it automatically. */
if (cm_->cameras().size() == 1)
return cm_->cameras()[0]->name();
return cm_->cameras()[0]->id();
/* Present a dialog box to pick a camera. */
for (const std::shared_ptr<Camera> &cam : cm_->cameras())
cameras.append(QString::fromStdString(cam->name()));
cameras.append(QString::fromStdString(cam->id()));
QString name = QInputDialog::getItem(this, "Select Camera",
"Camera:", cameras, 0,
false, &result);
QString id = QInputDialog::getItem(this, "Select Camera",
"Camera:", cameras, 0,
false, &result);
if (!result)
return std::string();
return name.toStdString();
return id.toStdString();
}
int MainWindow::openCamera()
@ -582,7 +582,7 @@ void MainWindow::processHotplug(HotplugEvent *e)
HotplugEvent::PlugEvent event = e->hotplugEvent();
if (event == HotplugEvent::HotPlug) {
cameraCombo_->addItem(QString::fromStdString(camera->name()));
cameraCombo_->addItem(QString::fromStdString(camera->id()));
} else if (event == HotplugEvent::HotUnplug) {
/* Check if the currently-streaming camera is removed. */
if (camera == camera_.get()) {
@ -592,14 +592,14 @@ void MainWindow::processHotplug(HotplugEvent *e)
cameraCombo_->setCurrentIndex(0);
}
int camIndex = cameraCombo_->findText(QString::fromStdString(camera->name()));
int camIndex = cameraCombo_->findText(QString::fromStdString(camera->id()));
cameraCombo_->removeItem(camIndex);
}
}
void MainWindow::addCamera(std::shared_ptr<Camera> camera)
{
qInfo() << "Adding new camera:" << camera->name().c_str();
qInfo() << "Adding new camera:" << camera->id().c_str();
QCoreApplication::postEvent(this,
new HotplugEvent(std::move(camera),
HotplugEvent::HotPlug));
@ -607,7 +607,7 @@ void MainWindow::addCamera(std::shared_ptr<Camera> camera)
void MainWindow::removeCamera(std::shared_ptr<Camera> camera)
{
qInfo() << "Removing camera:" << camera->name().c_str();
qInfo() << "Removing camera:" << camera->id().c_str();
QCoreApplication::postEvent(this,
new HotplugEvent(std::move(camera),
HotplugEvent::HotUnplug));

2
src/v4l2/v4l2_camera_proxy.cpp
View file

@ -189,7 +189,7 @@ void V4L2CameraProxy::querycap(std::shared_ptr<Camera> camera)
utils::strlcpy(reinterpret_cast<char *>(capabilities_.driver), driver.c_str(),
sizeof(capabilities_.driver));
utils::strlcpy(reinterpret_cast<char *>(capabilities_.card), camera->name().c_str(),
utils::strlcpy(reinterpret_cast<char *>(capabilities_.card), camera->id().c_str(),
sizeof(capabilities_.card));
utils::strlcpy(reinterpret_cast<char *>(capabilities_.bus_info), bus_info.c_str(),
sizeof(capabilities_.bus_info));

2
test/pipeline/ipu3/ipu3_pipeline_test.cpp
View file

@ -106,7 +106,7 @@ int IPU3PipelineTest::run()
{
auto cameras = cameraManager_->cameras();
for (const std::shared_ptr<Camera> &cam : cameras)
cout << "Found camera '" << cam->name() << "'" << endl;
cout << "Found camera '" << cam->id() << "'" << endl;
if (cameras.size() != sensors_) {
cerr << cameras.size() << " cameras registered, but " << sensors_

2
test/pipeline/rkisp1/rkisp1_pipeline_test.cpp
View file

@ -95,7 +95,7 @@ int RKISP1PipelineTest::run()
{
auto cameras = cameraManager_->cameras();
for (const std::shared_ptr<Camera> &cam : cameras)
cout << "Found camera '" << cam->name() << "'" << endl;
cout << "Found camera '" << cam->id() << "'" << endl;
if (cameras.size() != sensors_) {
cerr << cameras.size() << " cameras registered, but " << sensors_