[{"id":123,"web_url":"https://patchwork.libcamera.org/comment/123/","msgid":"<20181230095644.xygzdlhjkg4na4gt@uno.localdomain>","date":"2018-12-30T09:56:44","subject":"Re: [libcamera-devel] [PATCH v2 01/12] libcamera: Add Camera class","submitter":{"id":3,"url":"https://patchwork.libcamera.org/api/people/3/","name":"Jacopo Mondi","email":"jacopo@jmondi.org"},"content":"Hi Niklas,\n thanks for the patch\n\nOn Sat, Dec 29, 2018 at 04:28:44AM +0100, Niklas Söderlund wrote:\n> Provide a Camera class which represents our main interface to handling\n> camera devices. This is a rework of Kieran's initial proposal and\n> Laurent's documentation of the file changed to fit the device\n> enumerators needs.\n>\n\nMy comments on v1 should be discarded. This class WILL grow, and we\ncan keep methods implementation in the cpp file. However, I have two\nquestions,\n\n> Signed-off-by: Niklas Söderlund \n> Reviewed-by: Laurent Pinchart \n>\n> ---\n> * Changes v1\n> - Fix missing /* namespace libcamera */ comment, thanks Jacopo.\n> - Removed Debug messages from Camera class constructor and destructor.\n> - Reworded documentation for Camera::get() and Camera::put(), thanks\n> Laurent.\n> ---\n> include/libcamera/camera.h | 31 ++++++++++++\n> include/libcamera/libcamera.h | 2 +\n> include/libcamera/meson.build | 1 +\n> src/libcamera/camera.cpp | 89 +++++++++++++++++++++++++++++++++++\n> src/libcamera/meson.build | 1 +\n> 5 files changed, 124 insertions(+)\n> create mode 100644 include/libcamera/camera.h\n> create mode 100644 src/libcamera/camera.cpp\n>\n> diff --git a/include/libcamera/camera.h b/include/libcamera/camera.h\n> new file mode 100644\n> index 0000000000000000..9a7579d61fa331ee\n> --- /dev/null\n> +++ b/include/libcamera/camera.h\n> @@ -0,0 +1,31 @@\n> +/* SPDX-License-Identifier: LGPL-2.1-or-later */\n> +/*\n> + * Copyright (C) 2018, Google Inc.\n> + *\n> + * camera.h - Camera object interface\n> + */\n> +#ifndef __LIBCAMERA_CAMERA_H__\n> +#define __LIBCAMERA_CAMERA_H__\n> +\n> +#include \n> +\n> +namespace libcamera {\n> +\n> +class Camera\n> +{\n> +public:\n> +\tCamera(const std::string &name);\n> +\n> +\tconst std::string &name() const;\n> +\tvoid get();\n> +\tvoid put();\n> +\n> +private:\n> +\tvirtual ~Camera() { };\n> +\tint ref_;\n> +\tstd::string name_;\n> +};\n> +\n> +} /* namespace libcamera */\n> +\n> +#endif /* __LIBCAMERA_CAMERA_H__ */\n> diff --git a/include/libcamera/libcamera.h b/include/libcamera/libcamera.h\n> index 790771b61e41e123..44c094d92feed5ba 100644\n> --- a/include/libcamera/libcamera.h\n> +++ b/include/libcamera/libcamera.h\n> @@ -7,6 +7,8 @@\n> #ifndef __LIBCAMERA_LIBCAMERA_H__\n> #define __LIBCAMERA_LIBCAMERA_H__\n>\n> +#include \n> +\n> namespace libcamera {\n>\n> class libcamera\n> diff --git a/include/libcamera/meson.build b/include/libcamera/meson.build\n> index 8c82675a25d29913..9b266ad926681db9 100644\n> --- a/include/libcamera/meson.build\n> +++ b/include/libcamera/meson.build\n> @@ -1,4 +1,5 @@\n> libcamera_api = files([\n> + 'camera.h',\n> 'libcamera.h',\n> ])\n>\n> diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp\n> new file mode 100644\n> index 0000000000000000..6da2b20137d45da2\n> --- /dev/null\n> +++ b/src/libcamera/camera.cpp\n> @@ -0,0 +1,89 @@\n> +/* SPDX-License-Identifier: LGPL-2.1-or-later */\n> +/*\n> + * Copyright (C) 2018, Google Inc.\n> + *\n> + * camera.cpp - Camera device\n> + */\n> +\n> +#include \n> +\n> +#include \"log.h\"\n> +\n> +/**\n> + * \\file camera.h\n> + * \\brief Camera device handling\n> + *\n> + * At the core of libcamera is the camera device, combining one image source\n> + * with processing hardware able to provide one or multiple image streams. The\n> + * Camera class represents a camera device.\n> + *\n> + * A camera device contains a single image source, and separate camera device\n> + * instances relate to different image sources. For instance, a phone containing\n> + * front and back image sensors will be modelled with two camera devices, one\n> + * for each sensor. When multiple streams can be produced from the same image\n> + * source, all those streams are guaranteed to be part of the same camera\n> + * device.\n> + *\n> + * While not sharing image sources, separate camera devices can share other\n> + * system resources, such as an ISP. For this reason camera device instances may\n> + * not be fully independent, in which case usage restrictions may apply. For\n> + * instance, a phone with a front and a back camera device may not allow usage\n> + * of the two devices simultaneously.\n> + */\n> +\n> +namespace libcamera {\n> +\n> +/**\n> + * \\class Camera\n> + * \\brief Camera device\n> + *\n> + * The Camera class models a camera capable of producing one or more image\n> + * streams from a single image source. It provides the main interface to\n> + * configuring and controlling the device, and capturing image streams. It is\n> + * the central object exposed by libcamera.\n> + */\n> +\n> +/**\n> + * \\brief Construct a named camera device\n> + *\n> + * \\param[in] name The name to set on the camera device\n> + *\n> + * The caller is responsible for guaranteeing unicity of the camera\n> + * device name.\n> + */\n> +Camera::Camera(const std::string &name)\n> +\t: ref_(1), name_(name)\n> +{\n> +}\n> +\n> +/**\n> + * \\brief Retrieve the name of the camera\n> + *\n> + * \\return Name of the camera device\n> + */\n> +const std::string &Camera::name() const\n> +{\n> +\treturn name_;\n> +}\n> +\n> +/**\n> + * \\brief Acquire a reference to the camera\n> + */\n> +void Camera::get()\n> +{\n> +\tref_++;\n> +}\n> +\n> +/**\n> + * \\brief Release a reference to the camera\n> + *\n> + * When the last reference is released the camera device is deleted. Callers\n> + * shall not access the camera device after calling this function.\n> + */\n> +void Camera::put()\n> +{\n> +\tif (--ref_ == 0)\n\nShould this be protected to make sure ref_ does not become negative or\nis this fine?\n\n\n> +\t\tdelete this;\n> +}\n> +\n> +} /* namespace libcamera */\n> diff --git a/src/libcamera/meson.build b/src/libcamera/meson.build\n> index f632eb5dd7791ad2..46591069aa5f8beb 100644\n> --- a/src/libcamera/meson.build\n> +++ b/src/libcamera/meson.build\n> @@ -1,4 +1,5 @@\n> libcamera_sources = files([\n> + 'camera.cpp',\n> 'log.cpp',\n> 'main.cpp',\n> ])\n> --\n\nShould we had headers to the 'libcamera_headers' vector? I see it is\nused for generating documentation.\n\nWith or without these two addressed\nReviewed-by: Jacopo Mondi \n\nThanks\n j\n\n> 2.20.1\n>\n> _______________________________________________\n> libcamera-devel mailing list\n> libcamera-devel@lists.libcamera.org\n> https://lists.libcamera.org/listinfo/libcamera-devel","headers":{"Return-Path":"","Received":["from relay3-d.mail.gandi.net (relay3-d.mail.gandi.net\n\t[217.70.183.195])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 2A83E60B31\n\tfor ;\n\tSun, 30 Dec 2018 10:56:43 +0100 (CET)","from uno.localdomain (unknown [37.176.180.32])\n\t(Authenticated sender: jacopo@jmondi.org)\n\tby relay3-d.mail.gandi.net (Postfix) with ESMTPSA id 8E04A60006;\n\tSun, 30 Dec 2018 09:56:42 +0000 (UTC)"],"X-Originating-IP":"37.176.180.32","Date":"Sun, 30 Dec 2018 10:56:44 +0100","From":"Jacopo Mondi ","To":"Niklas =?utf-8?q?S=C3=B6derlund?= ","Cc":"libcamera-devel@lists.libcamera.org","Message-ID":"<20181230095644.xygzdlhjkg4na4gt@uno.localdomain>","References":"<20181229032855.26249-1-niklas.soderlund@ragnatech.se>\n\t<20181229032855.26249-2-niklas.soderlund@ragnatech.se>","MIME-Version":"1.0","Content-Type":"multipart/signed; micalg=pgp-sha256;\n\tprotocol=\"application/pgp-signature\"; boundary=\"gc7hqcumfkyd2n3r\"","Content-Disposition":"inline","In-Reply-To":"<20181229032855.26249-2-niklas.soderlund@ragnatech.se>","User-Agent":"NeoMutt/20180716","Subject":"Re: [libcamera-devel] [PATCH v2 01/12] libcamera: Add Camera class","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.23","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","X-List-Received-Date":"Sun, 30 Dec 2018 09:56:43 -0000"}},{"id":131,"web_url":"https://patchwork.libcamera.org/comment/131/","msgid":"<20181230195708.GA31866@bigcity.dyn.berto.se>","date":"2018-12-30T19:57:08","subject":"Re: [libcamera-devel] [PATCH v2 01/12] libcamera: Add Camera class","submitter":{"id":5,"url":"https://patchwork.libcamera.org/api/people/5/","name":"Niklas Söderlund","email":"niklas.soderlund@ragnatech.se"},"content":"Hi Jacopo,\n\nThanks for your feedback.\n\nOn 2018-12-30 10:56:44 +0100, Jacopo Mondi wrote:\n> Hi Niklas,\n> thanks for the patch\n> \n> On Sat, Dec 29, 2018 at 04:28:44AM +0100, Niklas Söderlund wrote:\n> > Provide a Camera class which represents our main interface to handling\n> > camera devices. This is a rework of Kieran's initial proposal and\n> > Laurent's documentation of the file changed to fit the device\n> > enumerators needs.\n> >\n> \n> My comments on v1 should be discarded. This class WILL grow, and we\n> can keep methods implementation in the cpp file. However, I have two\n> questions,\n> \n> > Signed-off-by: Niklas Söderlund \n> > Reviewed-by: Laurent Pinchart \n> >\n> > ---\n> > * Changes v1\n> > - Fix missing /* namespace libcamera */ comment, thanks Jacopo.\n> > - Removed Debug messages from Camera class constructor and destructor.\n> > - Reworded documentation for Camera::get() and Camera::put(), thanks\n> > Laurent.\n> > ---\n> > include/libcamera/camera.h | 31 ++++++++++++\n> > include/libcamera/libcamera.h | 2 +\n> > include/libcamera/meson.build | 1 +\n> > src/libcamera/camera.cpp | 89 +++++++++++++++++++++++++++++++++++\n> > src/libcamera/meson.build | 1 +\n> > 5 files changed, 124 insertions(+)\n> > create mode 100644 include/libcamera/camera.h\n> > create mode 100644 src/libcamera/camera.cpp\n> >\n> > diff --git a/include/libcamera/camera.h b/include/libcamera/camera.h\n> > new file mode 100644\n> > index 0000000000000000..9a7579d61fa331ee\n> > --- /dev/null\n> > +++ b/include/libcamera/camera.h\n> > @@ -0,0 +1,31 @@\n> > +/* SPDX-License-Identifier: LGPL-2.1-or-later */\n> > +/*\n> > + * Copyright (C) 2018, Google Inc.\n> > + *\n> > + * camera.h - Camera object interface\n> > + */\n> > +#ifndef __LIBCAMERA_CAMERA_H__\n> > +#define __LIBCAMERA_CAMERA_H__\n> > +\n> > +#include \n> > +\n> > +namespace libcamera {\n> > +\n> > +class Camera\n> > +{\n> > +public:\n> > +\tCamera(const std::string &name);\n> > +\n> > +\tconst std::string &name() const;\n> > +\tvoid get();\n> > +\tvoid put();\n> > +\n> > +private:\n> > +\tvirtual ~Camera() { };\n> > +\tint ref_;\n> > +\tstd::string name_;\n> > +};\n> > +\n> > +} /* namespace libcamera */\n> > +\n> > +#endif /* __LIBCAMERA_CAMERA_H__ */\n> > diff --git a/include/libcamera/libcamera.h b/include/libcamera/libcamera.h\n> > index 790771b61e41e123..44c094d92feed5ba 100644\n> > --- a/include/libcamera/libcamera.h\n> > +++ b/include/libcamera/libcamera.h\n> > @@ -7,6 +7,8 @@\n> > #ifndef __LIBCAMERA_LIBCAMERA_H__\n> > #define __LIBCAMERA_LIBCAMERA_H__\n> >\n> > +#include \n> > +\n> > namespace libcamera {\n> >\n> > class libcamera\n> > diff --git a/include/libcamera/meson.build b/include/libcamera/meson.build\n> > index 8c82675a25d29913..9b266ad926681db9 100644\n> > --- a/include/libcamera/meson.build\n> > +++ b/include/libcamera/meson.build\n> > @@ -1,4 +1,5 @@\n> > libcamera_api = files([\n> > + 'camera.h',\n> > 'libcamera.h',\n> > ])\n> >\n> > diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp\n> > new file mode 100644\n> > index 0000000000000000..6da2b20137d45da2\n> > --- /dev/null\n> > +++ b/src/libcamera/camera.cpp\n> > @@ -0,0 +1,89 @@\n> > +/* SPDX-License-Identifier: LGPL-2.1-or-later */\n> > +/*\n> > + * Copyright (C) 2018, Google Inc.\n> > + *\n> > + * camera.cpp - Camera device\n> > + */\n> > +\n> > +#include \n> > +\n> > +#include \"log.h\"\n> > +\n> > +/**\n> > + * \\file camera.h\n> > + * \\brief Camera device handling\n> > + *\n> > + * At the core of libcamera is the camera device, combining one image source\n> > + * with processing hardware able to provide one or multiple image streams. The\n> > + * Camera class represents a camera device.\n> > + *\n> > + * A camera device contains a single image source, and separate camera device\n> > + * instances relate to different image sources. For instance, a phone containing\n> > + * front and back image sensors will be modelled with two camera devices, one\n> > + * for each sensor. When multiple streams can be produced from the same image\n> > + * source, all those streams are guaranteed to be part of the same camera\n> > + * device.\n> > + *\n> > + * While not sharing image sources, separate camera devices can share other\n> > + * system resources, such as an ISP. For this reason camera device instances may\n> > + * not be fully independent, in which case usage restrictions may apply. For\n> > + * instance, a phone with a front and a back camera device may not allow usage\n> > + * of the two devices simultaneously.\n> > + */\n> > +\n> > +namespace libcamera {\n> > +\n> > +/**\n> > + * \\class Camera\n> > + * \\brief Camera device\n> > + *\n> > + * The Camera class models a camera capable of producing one or more image\n> > + * streams from a single image source. It provides the main interface to\n> > + * configuring and controlling the device, and capturing image streams. It is\n> > + * the central object exposed by libcamera.\n> > + */\n> > +\n> > +/**\n> > + * \\brief Construct a named camera device\n> > + *\n> > + * \\param[in] name The name to set on the camera device\n> > + *\n> > + * The caller is responsible for guaranteeing unicity of the camera\n> > + * device name.\n> > + */\n> > +Camera::Camera(const std::string &name)\n> > +\t: ref_(1), name_(name)\n> > +{\n> > +}\n> > +\n> > +/**\n> > + * \\brief Retrieve the name of the camera\n> > + *\n> > + * \\return Name of the camera device\n> > + */\n> > +const std::string &Camera::name() const\n> > +{\n> > +\treturn name_;\n> > +}\n> > +\n> > +/**\n> > + * \\brief Acquire a reference to the camera\n> > + */\n> > +void Camera::get()\n> > +{\n> > +\tref_++;\n> > +}\n> > +\n> > +/**\n> > + * \\brief Release a reference to the camera\n> > + *\n> > + * When the last reference is released the camera device is deleted. Callers\n> > + * shall not access the camera device after calling this function.\n> > + */\n> > +void Camera::put()\n> > +{\n> > +\tif (--ref_ == 0)\n> \n> Should this be protected to make sure ref_ does not become negative or\n> is this fine?\n\nNo. The user of the library must be able to call cam->put() once it's \ndone using a camera.\n\n> \n> \n> > +\t\tdelete this;\n> > +}\n> > +\n> > +} /* namespace libcamera */\n> > diff --git a/src/libcamera/meson.build b/src/libcamera/meson.build\n> > index f632eb5dd7791ad2..46591069aa5f8beb 100644\n> > --- a/src/libcamera/meson.build\n> > +++ b/src/libcamera/meson.build\n> > @@ -1,4 +1,5 @@\n> > libcamera_sources = files([\n> > + 'camera.cpp',\n> > 'log.cpp',\n> > 'main.cpp',\n> > ])\n> > --\n> \n> Should we had headers to the 'libcamera_headers' vector? I see it is\n> used for generating documentation.\n\nPublic headers (like camera.h) are added to 'libcamera_api' which like \n'libcamera_headers' for private headers are used to generate the Doxygen \ndocumentation.\n\n> \n> With or without these two addressed\n> Reviewed-by: Jacopo Mondi \n\nThanks.\n\n> \n> Thanks\n> j\n> \n> > 2.20.1\n> >\n> > _______________________________________________\n> > libcamera-devel mailing list\n> > libcamera-devel@lists.libcamera.org\n> > https://lists.libcamera.org/listinfo/libcamera-devel","headers":{"Return-Path":"","Received":["from mail-lj1-x244.google.com (mail-lj1-x244.google.com\n\t[IPv6:2a00:1450:4864:20::244])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id B9957600CC\n\tfor ;\n\tSun, 30 Dec 2018 20:57:26 +0100 (CET)","by mail-lj1-x244.google.com with SMTP id n18-v6so22481822lji.7\n\tfor ;\n\tSun, 30 Dec 2018 11:57:26 -0800 (PST)","from localhost (89-233-230-99.cust.bredband2.com. [89.233.230.99])\n\tby smtp.gmail.com with ESMTPSA id\n\tb25-v6sm9943394lji.94.2018.12.30.11.57.09\n\t(version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256);\n\tSun, 30 Dec 2018 11:57:09 -0800 (PST)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=ragnatech-se.20150623.gappssmtp.com; s=20150623;\n\th=date:from:to:cc:subject:message-id:references:mime-version\n\t:content-disposition:content-transfer-encoding:in-reply-to\n\t:user-agent; bh=hOFcmnc3G+uUBzpMQHaKOdv2ekxm1nsOfFyTSlzKNkc=;\n\tb=Xkgc8i9PJcTRwtC3zySl7mNgnt0nv89GUFkiK6FenI3QLEF2zUV8tSBNz/5a6wbcf6\n\tVauRbVMl9jWa1Zy2cHJnKcHRHEk91pJa0nQIlqIvauA8psP/XBCthZ1LjdbbLM+FWxEg\n\teYMt6N5edLcybrr+HCs/VecQo5CNQ9N3iwE03grNPTsp8dMrLZCowOgjeTzmpmo6cTHw\n\tbNMqEVEt7KGVhwepWuK9NW6JlV057wA2GxrFoEGWuBOCoXRKUxuLAucaLHc/q8TociIz\n\ttX88y6XwOGgDy3f2vpEzzeO16lWQjY3ae6ZflaW1tT3T3gzsTRcMv2ZA3ivKUuSRDOxB\n\tnpgg==","X-Google-DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=1e100.net; s=20161025;\n\th=x-gm-message-state:date:from:to:cc:subject:message-id:references\n\t:mime-version:content-disposition:content-transfer-encoding\n\t:in-reply-to:user-agent;\n\tbh=hOFcmnc3G+uUBzpMQHaKOdv2ekxm1nsOfFyTSlzKNkc=;\n\tb=M0SJCmxwusTY1R6/erlujMNoNBXU/xn0h7VfWmJaoviDmysCnZ0vIOOdeSBc0hq4rE\n\tzxnti/4eOxPQeAx75PdO3NzlGGADtV4BCCcg7QVcNiwUiZeT57h48UyHQlG+I+2+DZ5i\n\tzvxzgHd8zsYwSeM6RR1D3CAgsiMt34FOF1v5r6vgyMBVX5BTGlIiPb7zsfqRRmK0Bki4\n\tx/4AtHoHZwAG19JwF8ItJoYcjOHydi1MDdm2I2vVoDSRdoI5JN4ZIdPok8nCSVVIABAX\n\thHA3xjLMYYOL9CMG4MRf+BD1jxXRGVIVBpxnnHA68ALlHbPCHwz6htpl+Ihc1UZd7olB\n\ta9Uw==","X-Gm-Message-State":"AJcUuke31ZofSkMPr/FayI2cKC0UbhYZJrxHoFqe0dKB2++oBrz2VJ5H\n\tv3Nhd3AiRHccArf4byrTeJjk3Q==","X-Google-Smtp-Source":"ALg8bN441xoTAKxVlDCFpzwqCsV5NXXpLGoPnBmDQ4pQanQfaZkUsH4HdtQGKdJFX7JTMycgSyaqFQ==","X-Received":"by 2002:a2e:a202:: with SMTP id\n\th2-v6mr19799303ljm.72.1546199830550; \n\tSun, 30 Dec 2018 11:57:10 -0800 (PST)","Date":"Sun, 30 Dec 2018 20:57:08 +0100","From":"Niklas =?iso-8859-1?q?S=F6derlund?= ","To":"Jacopo Mondi ","Cc":"libcamera-devel@lists.libcamera.org","Message-ID":"<20181230195708.GA31866@bigcity.dyn.berto.se>","References":"<20181229032855.26249-1-niklas.soderlund@ragnatech.se>\n\t<20181229032855.26249-2-niklas.soderlund@ragnatech.se>\n\t<20181230095644.xygzdlhjkg4na4gt@uno.localdomain>","MIME-Version":"1.0","Content-Type":"text/plain; charset=iso-8859-1","Content-Disposition":"inline","Content-Transfer-Encoding":"8bit","In-Reply-To":"<20181230095644.xygzdlhjkg4na4gt@uno.localdomain>","User-Agent":"Mutt/1.10.1 (2018-07-13)","Subject":"Re: [libcamera-devel] [PATCH v2 01/12] libcamera: Add Camera class","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.23","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","X-List-Received-Date":"Sun, 30 Dec 2018 19:57:27 -0000"}}]