[libcamera-devel,v4,5/5] android: camera_hal_manager: Support camera hotplug

Message ID 20200821144601.67860-6-email@uajain.com
State Accepted
Headers show
Series
  • android: Camera hotplug support
Related show

Commit Message

Umang Jain Aug. 21, 2020, 2:46 p.m. UTC
Extend the support for camera hotplug from libcamera's CameraManager
to CameraHalManager. Use camera module callbacks to let the framework
know about the hotplug events and change the status of cameras being
hotplugged or unplugged via camera_device_status_change().

Introduce a map camerasMap_ which book-keeps all cameras seen in the
past by the CameraHalManager. If the camera is seen for the first time,
a new id is assigned to it. If the camera has been seen before by the
manager, its old id is reused. IDs for internal cameras start with
'0' and for external cameras, they start with '1000'. Accesses to
camerasMap_ and cameras_ are protected by a mutex.

Signed-off-by: Umang Jain <email@uajain.com>
---
 src/android/camera_hal_manager.cpp | 171 +++++++++++++++++++++++++----
 src/android/camera_hal_manager.h   |  20 ++++
 2 files changed, 168 insertions(+), 23 deletions(-)

Comments

Laurent Pinchart Aug. 22, 2020, 9:23 p.m. UTC | #1
Hi Umang,

Thank you for the patch.

On Fri, Aug 21, 2020 at 02:46:11PM +0000, Umang Jain wrote:
> Extend the support for camera hotplug from libcamera's CameraManager
> to CameraHalManager. Use camera module callbacks to let the framework
> know about the hotplug events and change the status of cameras being
> hotplugged or unplugged via camera_device_status_change().
> 
> Introduce a map camerasMap_ which book-keeps all cameras seen in the

s/camerasMap_/cameraIdsMap_/

> past by the CameraHalManager. If the camera is seen for the first time,
> a new id is assigned to it. If the camera has been seen before by the
> manager, its old id is reused. IDs for internal cameras start with
> '0' and for external cameras, they start with '1000'. Accesses to
> camerasMap_ and cameras_ are protected by a mutex.

s/camerasMap_/cameraIdsMap_/

> 
> Signed-off-by: Umang Jain <email@uajain.com>
> ---
>  src/android/camera_hal_manager.cpp | 171 +++++++++++++++++++++++++----
>  src/android/camera_hal_manager.h   |  20 ++++
>  2 files changed, 168 insertions(+), 23 deletions(-)
> 
> diff --git a/src/android/camera_hal_manager.cpp b/src/android/camera_hal_manager.cpp
> index 3a744af..4b32c4f 100644
> --- a/src/android/camera_hal_manager.cpp
> +++ b/src/android/camera_hal_manager.cpp
> @@ -8,6 +8,7 @@
>  #include "camera_hal_manager.h"
>  
>  #include <libcamera/camera.h>
> +#include <libcamera/property_ids.h>
>  
>  #include "libcamera/internal/log.h"
>  
> @@ -28,7 +29,7 @@ LOG_DECLARE_CATEGORY(HAL);
>   */
>  
>  CameraHalManager::CameraHalManager()
> -	: cameraManager_(nullptr)
> +	: cameraManager_(nullptr), numInternalCameras_(0), nextExternalCameraId_(1000)

1000 is used a few times below. A static constexpr member variable would
be nice to avoid repeating the constant.

>  {
>  }
>  
> @@ -47,6 +48,10 @@ int CameraHalManager::init()
>  {
>  	cameraManager_ = new CameraManager();
>  
> +	/* Support camera hotplug. */
> +	cameraManager_->cameraAdded.connect(this, &CameraHalManager::cameraAdded);
> +	cameraManager_->cameraRemoved.connect(this, &CameraHalManager::cameraRemoved);
> +
>  	int ret = cameraManager_->start();
>  	if (ret) {
>  		LOG(HAL, Error) << "Failed to start camera manager: "
> @@ -56,35 +61,22 @@ int CameraHalManager::init()
>  		return ret;
>  	}
>  
> -	/*
> -	 * For each Camera registered in the system, a CameraDevice
> -	 * gets created here to wraps a libcamera Camera instance.
> -	 *
> -	 * \todo Support camera hotplug.
> -	 */
> -	unsigned int index = 0;
> -	for (auto &cam : cameraManager_->cameras()) {
> -		std::shared_ptr<CameraDevice> camera = CameraDevice::create(index, cam);
> -		ret = camera->initialize();
> -		if (ret)
> -			continue;
> -
> -		cameras_.emplace_back(std::move(camera));
> -		++index;
> -	}
> -
>  	return 0;
>  }
>  
>  CameraDevice *CameraHalManager::open(unsigned int id,
>  				     const hw_module_t *hardwareModule)
>  {
> -	if (id >= numCameras()) {
> +	MutexLocker locker(mutex_);
> +
> +	auto iter = cameraDeviceFromHALId(id);
> +	if (iter == cameras_.end()) {
>  		LOG(HAL, Error) << "Invalid camera id '" << id << "'";
>  		return nullptr;
>  	}
>  
> -	CameraDevice *camera = cameras_[id].get();
> +	CameraDevice *camera = iter->get();
> +
>  	if (camera->open(hardwareModule))
>  		return nullptr;
>  
> @@ -93,9 +85,118 @@ CameraDevice *CameraHalManager::open(unsigned int id,
>  	return camera;
>  }
>  
> +void CameraHalManager::cameraAdded(std::shared_ptr<Camera> cam)
> +{
> +	unsigned int id;
> +	bool isCameraExternal = false;
> +	bool isCameraNew = false;
> +
> +	MutexLocker locker(mutex_);
> +
> +	/*
> +	 * Each camera is assigned a unique integer ID when it is seen for the
> +	 * first time. If the camera has been seen before, the previous ID is
> +	 * re-used.
> +	 *
> +	 * IDs starts from '0' for internal cameras and '1000' for external
> +	 * cameras.
> +	 */
> +	auto iter = cameraIdsMap_.find(cam->id());
> +	if (iter != cameraIdsMap_.end()) {
> +		id = iter->second;
> +	} else {
> +		isCameraNew = true;
> +
> +		/*
> +		 * Now check if this is an external camera and assign
> +		 * its id accordingly.
> +		 */
> +		if (cameraLocation(cam.get()) == properties::CameraLocationExternal) {
> +			isCameraExternal = true;
> +			id = nextExternalCameraId_;
> +		} else {
> +			id = numInternalCameras_;
> +		}
> +	}
> +
> +	/* Create a CameraDevice instance to wrap the libcamera Camera. */
> +	std::shared_ptr<CameraDevice> camera = CameraDevice::create(id, std::move(cam));
> +	int ret = camera->initialize();
> +	if (ret) {
> +		LOG(HAL, Error) << "Failed to initialize camera: " << cam->id();
> +		return;
> +	}
> +
> +	if (isCameraNew) {
> +		cameraIdsMap_.emplace(cam->id(), id);
> +
> +		if (isCameraExternal)
> +			nextExternalCameraId_++;
> +		else
> +			numInternalCameras_++;
> +	}
> +
> +	cameras_.emplace_back(std::move(camera));
> +
> +	if (callbacks_)
> +		callbacks_->camera_device_status_change(callbacks_, id,
> +							CAMERA_DEVICE_STATUS_PRESENT);
> +
> +	LOG(HAL, Debug) << "Camera ID: " << id << " added successfully.";
> +}
> +
> +void CameraHalManager::cameraRemoved(std::shared_ptr<Camera> cam)
> +{
> +	MutexLocker locker(mutex_);
> +
> +	auto iter = cameraDeviceFromCamera(cam.get());
> +	if (iter == cameras_.end())
> +		return;
> +
> +	/* CAMERA_DEVICE_STATUS_NOT_PRESENT should be set for external cameras only. */
> +	unsigned int id = (*iter)->id();
> +	if (id >= 1000)
> +		callbacks_->camera_device_status_change(callbacks_, id,
> +							CAMERA_DEVICE_STATUS_NOT_PRESENT);
> +
> +	/*
> +	 * \todo Check if the camera is already open and running.
> +	 * Inform the framework about its absence before deleting its
> +	 * reference here.
> +	 */
> +	cameras_.erase(iter);
> +
> +	LOG(HAL, Debug) << "Camera ID: " << id << " removed successfully.";
> +}
> +
> +int32_t CameraHalManager::cameraLocation(const Camera *cam)
> +{
> +	const ControlList &properties = cam->properties();
> +	if (!properties.contains(properties::Location))
> +		return -1;
> +
> +	return properties.get(properties::Location);
> +}
> +
> +CameraHalManager::cameraDeviceIter CameraHalManager::cameraDeviceFromHALId(unsigned int id)
> +{
> +	return std::find_if(cameras_.begin(), cameras_.end(),
> +			    [id](std::shared_ptr<CameraDevice> &camera) {
> +				return camera->id() == id;
> +			    });

How about returning a CameraDevice * instead of an iterator ? That would
simplify the caller a little bit.

CameraDevice *CameraHalManager::cameraDeviceFromHalId(unsigned int id)
{
	auto iter = std::find_if(cameras_.begin(), cameras_.end(),
				 [id](std::shared_ptr<CameraDevice> &camera) {
					 return camera->id() == id;
				 });
	if (iter == cameras_.end())
		return nullptr;

	return iter->get();
}

> +}
> +
> +CameraHalManager::cameraDeviceIter CameraHalManager::cameraDeviceFromCamera(Camera *cam)
> +{
> +	return std::find_if(cameras_.begin(), cameras_.end(),
> +			    [cam](std::shared_ptr<CameraDevice> &camera) {
> +				return cam == camera->camera();
> +			    });
> +}

If you inlined this function in its single caller, you could get rid of
the cameraDeviceIter type. Otherwise it should be CameraDeviceIter. I
think I'd prefer dropping it, it would be simpler.

> +
>  unsigned int CameraHalManager::numCameras() const
>  {
> -	return cameraManager_->cameras().size();
> +	return numInternalCameras_;
>  }
>  
>  int CameraHalManager::getCameraInfo(unsigned int id, struct camera_info *info)
> @@ -103,12 +204,15 @@ int CameraHalManager::getCameraInfo(unsigned int id, struct camera_info *info)
>  	if (!info)
>  		return -EINVAL;
>  
> -	if (id >= numCameras()) {
> +	MutexLocker locker(mutex_);
> +
> +	auto iter = cameraDeviceFromHALId(id);
> +	if (iter == cameras_.end()) {
>  		LOG(HAL, Error) << "Invalid camera id '" << id << "'";
>  		return -EINVAL;
>  	}
>  
> -	CameraDevice *camera = cameras_[id].get();
> +	CameraDevice *camera = iter->get();
>  
>  	info->facing = camera->facing();
>  	info->orientation = camera->orientation();
> @@ -124,4 +228,25 @@ int CameraHalManager::getCameraInfo(unsigned int id, struct camera_info *info)
>  void CameraHalManager::setCallbacks(const camera_module_callbacks_t *callbacks)
>  {
>  	callbacks_ = callbacks;
> +
> +	MutexLocker locker(mutex_);
> +
> +	/*
> +	 * Some external cameras may have been identified before the
> +	 * callbacks_ were set. Iterate all existing external cameras
> +	 * and mark them as CAMERA_DEVICE_STATUS_PRESENT explicitly.
> +	 *
> +	 * Internal cameras are already assumed to be present at module
> +	 * load time by the Android framework.
> +	 */
> +	for (std::shared_ptr<CameraDevice> &camera : cameras_) {
> +		const Camera *cam = camera->camera();
> +		unsigned int id = camera->id();
> +		if (id < 1000)
> +			continue;
> +
> +		if (cameraLocation(cam) == properties::CameraLocationExternal)

Do we need both checks, aren't they equivalent ?

> +			callbacks_->camera_device_status_change(callbacks_, id,
> +								CAMERA_DEVICE_STATUS_PRESENT);
> +	}
>  }
> diff --git a/src/android/camera_hal_manager.h b/src/android/camera_hal_manager.h
> index 3e34d63..3fecaa5 100644
> --- a/src/android/camera_hal_manager.h
> +++ b/src/android/camera_hal_manager.h
> @@ -7,6 +7,8 @@
>  #ifndef __ANDROID_CAMERA_MANAGER_H__
>  #define __ANDROID_CAMERA_MANAGER_H__
>  
> +#include <map>
> +#include <mutex>
>  #include <stddef.h>
>  #include <vector>
>  
> @@ -18,12 +20,17 @@
>  
>  class CameraDevice;
>  
> +using Mutex = std::mutex;
> +using MutexLocker = std::unique_lock<std::mutex>;
> +

I'd make these private class member, to avoid polluting the global
namespace.

>  class CameraHalManager
>  {
>  public:
>  	CameraHalManager();
>  	~CameraHalManager();
>  
> +	using cameraDeviceIter = std::vector<std::shared_ptr<CameraDevice>>::iterator;
> +
>  	int init();
>  
>  	CameraDevice *open(unsigned int id, const hw_module_t *module);
> @@ -33,10 +40,23 @@ public:
>  	void setCallbacks(const camera_module_callbacks_t *callbacks);
>  
>  private:
> +	static int32_t cameraLocation(const libcamera::Camera *cam);
> +
> +	void cameraAdded(std::shared_ptr<libcamera::Camera> cam);
> +	void cameraRemoved(std::shared_ptr<libcamera::Camera> cam);
> +
> +	cameraDeviceIter cameraDeviceFromHALId(unsigned int id);

I'd name this cameraDeviceFromHalId to match CameraHalManager (sorry
about the incorrect suggestion in reply to v3).

With these small issues address,

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

I'd applied these changes locally to test compilation before sending
this review. I'll thus post the patch as v4.1 to avoid duplicating work.
If you're fine with it please let me know, and I'll apply the whole
series without a need to resubmit it. It would be nice if you could test
it though.

> +	cameraDeviceIter cameraDeviceFromCamera(libcamera::Camera *cam);
> +
>  	libcamera::CameraManager *cameraManager_;
>  
>  	const camera_module_callbacks_t *callbacks_;
>  	std::vector<std::shared_ptr<CameraDevice>> cameras_;
> +	std::map<std::string, unsigned int> cameraIdsMap_;
> +	Mutex mutex_;
> +
> +	unsigned int numInternalCameras_;
> +	unsigned int nextExternalCameraId_;
>  };
>  
>  #endif /* __ANDROID_CAMERA_MANAGER_H__ */

Patch

diff --git a/src/android/camera_hal_manager.cpp b/src/android/camera_hal_manager.cpp
index 3a744af..4b32c4f 100644
--- a/src/android/camera_hal_manager.cpp
+++ b/src/android/camera_hal_manager.cpp
@@ -8,6 +8,7 @@ 
 #include "camera_hal_manager.h"
 
 #include <libcamera/camera.h>
+#include <libcamera/property_ids.h>
 
 #include "libcamera/internal/log.h"
 
@@ -28,7 +29,7 @@  LOG_DECLARE_CATEGORY(HAL);
  */
 
 CameraHalManager::CameraHalManager()
-	: cameraManager_(nullptr)
+	: cameraManager_(nullptr), numInternalCameras_(0), nextExternalCameraId_(1000)
 {
 }
 
@@ -47,6 +48,10 @@  int CameraHalManager::init()
 {
 	cameraManager_ = new CameraManager();
 
+	/* Support camera hotplug. */
+	cameraManager_->cameraAdded.connect(this, &CameraHalManager::cameraAdded);
+	cameraManager_->cameraRemoved.connect(this, &CameraHalManager::cameraRemoved);
+
 	int ret = cameraManager_->start();
 	if (ret) {
 		LOG(HAL, Error) << "Failed to start camera manager: "
@@ -56,35 +61,22 @@  int CameraHalManager::init()
 		return ret;
 	}
 
-	/*
-	 * For each Camera registered in the system, a CameraDevice
-	 * gets created here to wraps a libcamera Camera instance.
-	 *
-	 * \todo Support camera hotplug.
-	 */
-	unsigned int index = 0;
-	for (auto &cam : cameraManager_->cameras()) {
-		std::shared_ptr<CameraDevice> camera = CameraDevice::create(index, cam);
-		ret = camera->initialize();
-		if (ret)
-			continue;
-
-		cameras_.emplace_back(std::move(camera));
-		++index;
-	}
-
 	return 0;
 }
 
 CameraDevice *CameraHalManager::open(unsigned int id,
 				     const hw_module_t *hardwareModule)
 {
-	if (id >= numCameras()) {
+	MutexLocker locker(mutex_);
+
+	auto iter = cameraDeviceFromHALId(id);
+	if (iter == cameras_.end()) {
 		LOG(HAL, Error) << "Invalid camera id '" << id << "'";
 		return nullptr;
 	}
 
-	CameraDevice *camera = cameras_[id].get();
+	CameraDevice *camera = iter->get();
+
 	if (camera->open(hardwareModule))
 		return nullptr;
 
@@ -93,9 +85,118 @@  CameraDevice *CameraHalManager::open(unsigned int id,
 	return camera;
 }
 
+void CameraHalManager::cameraAdded(std::shared_ptr<Camera> cam)
+{
+	unsigned int id;
+	bool isCameraExternal = false;
+	bool isCameraNew = false;
+
+	MutexLocker locker(mutex_);
+
+	/*
+	 * Each camera is assigned a unique integer ID when it is seen for the
+	 * first time. If the camera has been seen before, the previous ID is
+	 * re-used.
+	 *
+	 * IDs starts from '0' for internal cameras and '1000' for external
+	 * cameras.
+	 */
+	auto iter = cameraIdsMap_.find(cam->id());
+	if (iter != cameraIdsMap_.end()) {
+		id = iter->second;
+	} else {
+		isCameraNew = true;
+
+		/*
+		 * Now check if this is an external camera and assign
+		 * its id accordingly.
+		 */
+		if (cameraLocation(cam.get()) == properties::CameraLocationExternal) {
+			isCameraExternal = true;
+			id = nextExternalCameraId_;
+		} else {
+			id = numInternalCameras_;
+		}
+	}
+
+	/* Create a CameraDevice instance to wrap the libcamera Camera. */
+	std::shared_ptr<CameraDevice> camera = CameraDevice::create(id, std::move(cam));
+	int ret = camera->initialize();
+	if (ret) {
+		LOG(HAL, Error) << "Failed to initialize camera: " << cam->id();
+		return;
+	}
+
+	if (isCameraNew) {
+		cameraIdsMap_.emplace(cam->id(), id);
+
+		if (isCameraExternal)
+			nextExternalCameraId_++;
+		else
+			numInternalCameras_++;
+	}
+
+	cameras_.emplace_back(std::move(camera));
+
+	if (callbacks_)
+		callbacks_->camera_device_status_change(callbacks_, id,
+							CAMERA_DEVICE_STATUS_PRESENT);
+
+	LOG(HAL, Debug) << "Camera ID: " << id << " added successfully.";
+}
+
+void CameraHalManager::cameraRemoved(std::shared_ptr<Camera> cam)
+{
+	MutexLocker locker(mutex_);
+
+	auto iter = cameraDeviceFromCamera(cam.get());
+	if (iter == cameras_.end())
+		return;
+
+	/* CAMERA_DEVICE_STATUS_NOT_PRESENT should be set for external cameras only. */
+	unsigned int id = (*iter)->id();
+	if (id >= 1000)
+		callbacks_->camera_device_status_change(callbacks_, id,
+							CAMERA_DEVICE_STATUS_NOT_PRESENT);
+
+	/*
+	 * \todo Check if the camera is already open and running.
+	 * Inform the framework about its absence before deleting its
+	 * reference here.
+	 */
+	cameras_.erase(iter);
+
+	LOG(HAL, Debug) << "Camera ID: " << id << " removed successfully.";
+}
+
+int32_t CameraHalManager::cameraLocation(const Camera *cam)
+{
+	const ControlList &properties = cam->properties();
+	if (!properties.contains(properties::Location))
+		return -1;
+
+	return properties.get(properties::Location);
+}
+
+CameraHalManager::cameraDeviceIter CameraHalManager::cameraDeviceFromHALId(unsigned int id)
+{
+	return std::find_if(cameras_.begin(), cameras_.end(),
+			    [id](std::shared_ptr<CameraDevice> &camera) {
+				return camera->id() == id;
+			    });
+}
+
+CameraHalManager::cameraDeviceIter CameraHalManager::cameraDeviceFromCamera(Camera *cam)
+{
+	return std::find_if(cameras_.begin(), cameras_.end(),
+			    [cam](std::shared_ptr<CameraDevice> &camera) {
+				return cam == camera->camera();
+			    });
+}
+
 unsigned int CameraHalManager::numCameras() const
 {
-	return cameraManager_->cameras().size();
+	return numInternalCameras_;
 }
 
 int CameraHalManager::getCameraInfo(unsigned int id, struct camera_info *info)
@@ -103,12 +204,15 @@  int CameraHalManager::getCameraInfo(unsigned int id, struct camera_info *info)
 	if (!info)
 		return -EINVAL;
 
-	if (id >= numCameras()) {
+	MutexLocker locker(mutex_);
+
+	auto iter = cameraDeviceFromHALId(id);
+	if (iter == cameras_.end()) {
 		LOG(HAL, Error) << "Invalid camera id '" << id << "'";
 		return -EINVAL;
 	}
 
-	CameraDevice *camera = cameras_[id].get();
+	CameraDevice *camera = iter->get();
 
 	info->facing = camera->facing();
 	info->orientation = camera->orientation();
@@ -124,4 +228,25 @@  int CameraHalManager::getCameraInfo(unsigned int id, struct camera_info *info)
 void CameraHalManager::setCallbacks(const camera_module_callbacks_t *callbacks)
 {
 	callbacks_ = callbacks;
+
+	MutexLocker locker(mutex_);
+
+	/*
+	 * Some external cameras may have been identified before the
+	 * callbacks_ were set. Iterate all existing external cameras
+	 * and mark them as CAMERA_DEVICE_STATUS_PRESENT explicitly.
+	 *
+	 * Internal cameras are already assumed to be present at module
+	 * load time by the Android framework.
+	 */
+	for (std::shared_ptr<CameraDevice> &camera : cameras_) {
+		const Camera *cam = camera->camera();
+		unsigned int id = camera->id();
+		if (id < 1000)
+			continue;
+
+		if (cameraLocation(cam) == properties::CameraLocationExternal)
+			callbacks_->camera_device_status_change(callbacks_, id,
+								CAMERA_DEVICE_STATUS_PRESENT);
+	}
 }
diff --git a/src/android/camera_hal_manager.h b/src/android/camera_hal_manager.h
index 3e34d63..3fecaa5 100644
--- a/src/android/camera_hal_manager.h
+++ b/src/android/camera_hal_manager.h
@@ -7,6 +7,8 @@ 
 #ifndef __ANDROID_CAMERA_MANAGER_H__
 #define __ANDROID_CAMERA_MANAGER_H__
 
+#include <map>
+#include <mutex>
 #include <stddef.h>
 #include <vector>
 
@@ -18,12 +20,17 @@ 
 
 class CameraDevice;
 
+using Mutex = std::mutex;
+using MutexLocker = std::unique_lock<std::mutex>;
+
 class CameraHalManager
 {
 public:
 	CameraHalManager();
 	~CameraHalManager();
 
+	using cameraDeviceIter = std::vector<std::shared_ptr<CameraDevice>>::iterator;
+
 	int init();
 
 	CameraDevice *open(unsigned int id, const hw_module_t *module);
@@ -33,10 +40,23 @@  public:
 	void setCallbacks(const camera_module_callbacks_t *callbacks);
 
 private:
+	static int32_t cameraLocation(const libcamera::Camera *cam);
+
+	void cameraAdded(std::shared_ptr<libcamera::Camera> cam);
+	void cameraRemoved(std::shared_ptr<libcamera::Camera> cam);
+
+	cameraDeviceIter cameraDeviceFromHALId(unsigned int id);
+	cameraDeviceIter cameraDeviceFromCamera(libcamera::Camera *cam);
+
 	libcamera::CameraManager *cameraManager_;
 
 	const camera_module_callbacks_t *callbacks_;
 	std::vector<std::shared_ptr<CameraDevice>> cameras_;
+	std::map<std::string, unsigned int> cameraIdsMap_;
+	Mutex mutex_;
+
+	unsigned int numInternalCameras_;
+	unsigned int nextExternalCameraId_;
 };
 
 #endif /* __ANDROID_CAMERA_MANAGER_H__ */