[{"id":13165,"web_url":"https://patchwork.libcamera.org/comment/13165/","msgid":"<20201011233308.GH3944@pendragon.ideasonboard.com>","date":"2020-10-11T23:33:08","subject":"Re: [libcamera-devel] [PATCH v2 3/3] android: camera_stream: Add\n\tdocumentation","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Jacopo,\n\nThank you for the patch.\n\nOn Sat, Oct 10, 2020 at 11:58:30AM +0200, Jacopo Mondi wrote:\n> Add a brief documentation block to the CameraStream class.\n> \n> Signed-off-by: Jacopo Mondi \n> ---\n> src/android/camera_stream.cpp | 21 +++++++++++++++++++++\n> src/android/camera_stream.h | 5 -----\n> 2 files changed, 21 insertions(+), 5 deletions(-)\n> \n> diff --git a/src/android/camera_stream.cpp b/src/android/camera_stream.cpp\n> index eac1480530f8..d8e45c2a274d 100644\n> --- a/src/android/camera_stream.cpp\n> +++ b/src/android/camera_stream.cpp\n> @@ -17,6 +17,27 @@ using namespace libcamera;\n> \n> LOG_DECLARE_CATEGORY(HAL);\n> \n> +/*\n\n/* or /** ? It doesn't matter much in practice as src/android/ is not\nparsed by doxygen.\n\n> + * \\class CameraStream\n> + * \\brief Map a camera3_stream_t to a StreamConfiguration\n> + *\n> + * The CameraStream class maps a camera3_stream_t provided by Android\n> + * camera framework to a libcamera::StreamConfiguration.\n> + *\n> + * The StreamConfiguration is represented by its index as recorded in the\n> + * CameraConfiguration and not by pointer as StreamConfiguration is subject to\n> + * relocation.\n> + *\n> + * A single StreamConfiguration may be used to deliver one or more streams to\n> + * the Android framework. The mapping type between a camera3 stream to a\n> + * StreamConfiguration is described by the CameraStream::Type.\n> + *\n> + * CameraStream handles all the aspects of producing a stream with the size\n> + * and format requested by the camera3 stream from the data produced by\n> + * the associated libcamera::Stream, including the creation of the encoder\n> + * and buffer allocation.\n> + */\n> +\n\nA useful addition for readers who are not familiar with the code.\n\nReviewed-by: Laurent Pinchart \n\n> CameraStream::CameraStream(CameraDevice *cameraDevice, Type type,\n> \t\t\t camera3_stream_t *camera3Stream, unsigned int index)\n> \t: cameraDevice_(cameraDevice), type_(type),\n> diff --git a/src/android/camera_stream.h b/src/android/camera_stream.h\n> index 8df0101c403c..47f3fc61ac2c 100644\n> --- a/src/android/camera_stream.h\n> +++ b/src/android/camera_stream.h\n> @@ -128,11 +128,6 @@ private:\n> \tlibcamera::CameraConfiguration *config_;\n> \tType type_;\n> \tcamera3_stream_t *camera3Stream_;\n> -\t/*\n> -\t * The index of the libcamera StreamConfiguration as added during\n> -\t * configureStreams(). A single libcamera Stream may be used to deliver\n> -\t * one or more streams to the Android framework.\n> -\t */\n> \tunsigned int index_;\n> \n> \tstd::unique_ptr encoder_;","headers":{"Return-Path":"","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id C1AFEBEEDF\n\tfor ;\n\tSun, 11 Oct 2020 23:33:56 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 6150460730;\n\tMon, 12 Oct 2020 01:33:56 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 51D1460357\n\tfor ;\n\tMon, 12 Oct 2020 01:33:54 +0200 (CEST)","from pendragon.ideasonboard.com (62-78-145-57.bb.dnainternet.fi\n\t[62.78.145.57])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id B222B308;\n\tMon, 12 Oct 2020 01:33:53 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"UQ6EOe6r\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1602459233;\n\tbh=u12uwHgf62GMnHbSS0GRDTgfCtotgkzEfIBljFgf+ws=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=UQ6EOe6rgQJ+E/MG+sE9xorwqaFaiW0VR4qpupIVoqLRuqKb7hn0xONDdqoWyBrV8\n\tiCoMtUpIrQngzAD0DFhXmW+xORvJVBOt7xlopK3F6Zvo+pr9ku4JxQtlyXZzYxl3Sr\n\tDguojV0hcqH6AawwPQ93KqJ+2ylF5m8MxBw5iFi0=","Date":"Mon, 12 Oct 2020 02:33:08 +0300","From":"Laurent Pinchart ","To":"Jacopo Mondi ","Message-ID":"<20201011233308.GH3944@pendragon.ideasonboard.com>","References":"<20201010095830.134084-1-jacopo@jmondi.org>\n\t<20201010095830.134084-4-jacopo@jmondi.org>","MIME-Version":"1.0","Content-Disposition":"inline","In-Reply-To":"<20201010095830.134084-4-jacopo@jmondi.org>","Subject":"Re: [libcamera-devel] [PATCH v2 3/3] android: camera_stream: Add\n\tdocumentation","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Cc":"libcamera-devel@lists.libcamera.org","Content-Type":"text/plain; charset=\"us-ascii\"","Content-Transfer-Encoding":"7bit","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}},{"id":13194,"web_url":"https://patchwork.libcamera.org/comment/13194/","msgid":"<20201014120701.hh5jcbzhnaczsjex@oden.dyn.berto.se>","date":"2020-10-14T12:07:01","subject":"Re: [libcamera-devel] [PATCH v2 3/3] android: camera_stream: Add\n\tdocumentation","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 work.\n\nOn 2020-10-10 11:58:30 +0200, Jacopo Mondi wrote:\n> Add a brief documentation block to the CameraStream class.\n> \n> Signed-off-by: Jacopo Mondi \n\nReviewed-by: Niklas Söderlund \n\n> ---\n> src/android/camera_stream.cpp | 21 +++++++++++++++++++++\n> src/android/camera_stream.h | 5 -----\n> 2 files changed, 21 insertions(+), 5 deletions(-)\n> \n> diff --git a/src/android/camera_stream.cpp b/src/android/camera_stream.cpp\n> index eac1480530f8..d8e45c2a274d 100644\n> --- a/src/android/camera_stream.cpp\n> +++ b/src/android/camera_stream.cpp\n> @@ -17,6 +17,27 @@ using namespace libcamera;\n> \n> LOG_DECLARE_CATEGORY(HAL);\n> \n> +/*\n> + * \\class CameraStream\n> + * \\brief Map a camera3_stream_t to a StreamConfiguration\n> + *\n> + * The CameraStream class maps a camera3_stream_t provided by Android\n> + * camera framework to a libcamera::StreamConfiguration.\n> + *\n> + * The StreamConfiguration is represented by its index as recorded in the\n> + * CameraConfiguration and not by pointer as StreamConfiguration is subject to\n> + * relocation.\n> + *\n> + * A single StreamConfiguration may be used to deliver one or more streams to\n> + * the Android framework. The mapping type between a camera3 stream to a\n> + * StreamConfiguration is described by the CameraStream::Type.\n> + *\n> + * CameraStream handles all the aspects of producing a stream with the size\n> + * and format requested by the camera3 stream from the data produced by\n> + * the associated libcamera::Stream, including the creation of the encoder\n> + * and buffer allocation.\n> + */\n> +\n> CameraStream::CameraStream(CameraDevice *cameraDevice, Type type,\n> \t\t\t camera3_stream_t *camera3Stream, unsigned int index)\n> \t: cameraDevice_(cameraDevice), type_(type),\n> diff --git a/src/android/camera_stream.h b/src/android/camera_stream.h\n> index 8df0101c403c..47f3fc61ac2c 100644\n> --- a/src/android/camera_stream.h\n> +++ b/src/android/camera_stream.h\n> @@ -128,11 +128,6 @@ private:\n> \tlibcamera::CameraConfiguration *config_;\n> \tType type_;\n> \tcamera3_stream_t *camera3Stream_;\n> -\t/*\n> -\t * The index of the libcamera StreamConfiguration as added during\n> -\t * configureStreams(). A single libcamera Stream may be used to deliver\n> -\t * one or more streams to the Android framework.\n> -\t */\n> \tunsigned int index_;\n> \n> \tstd::unique_ptr encoder_;\n> -- \n> 2.28.0\n> \n> _______________________________________________\n> libcamera-devel mailing list\n> libcamera-devel@lists.libcamera.org\n> https://lists.libcamera.org/listinfo/libcamera-devel","headers":{"Return-Path":"","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 7FFDEBEEE0\n\tfor ;\n\tWed, 14 Oct 2020 12:07:05 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 1966E60E79;\n\tWed, 14 Oct 2020 14:07:05 +0200 (CEST)","from mail-lj1-x236.google.com (mail-lj1-x236.google.com\n\t[IPv6:2a00:1450:4864:20::236])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 908DE60354\n\tfor ;\n\tWed, 14 Oct 2020 14:07:03 +0200 (CEST)","by mail-lj1-x236.google.com with SMTP id i2so2921478ljg.4\n\tfor ;\n\tWed, 14 Oct 2020 05:07:03 -0700 (PDT)","from localhost (h-209-203.A463.priv.bahnhof.se. [155.4.209.203])\n\tby smtp.gmail.com with ESMTPSA id\n\te14sm1063774lfn.165.2020.10.14.05.07.01\n\t(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n\tWed, 14 Oct 2020 05:07:02 -0700 (PDT)"],"Authentication-Results":"lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (2048-bit key;\n\tunprotected) header.d=ragnatech-se.20150623.gappssmtp.com\n\theader.i=@ragnatech-se.20150623.gappssmtp.com\n\theader.b=\"OV8P9LCv\"; dkim-atps=neutral","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\tbh=2Peya3NTwAu+b6dqMZL6NqXZLOMpzCbMW4PTu4FTEqI=;\n\tb=OV8P9LCvtA2Hux1uCedoIOU/W/kExqyKHxdSyS95nf5jl+SgKorx+X+OS9UrjLiwJm\n\tYL4V09C2p8nmP26lDQbwCt3XSpvm/mF8aMZNT3K3KaAP6U2tqb3s6InHxM4s9WUL0uBV\n\to5oorioLfeiecP+7XbBxJpJF3u7NwoMX6ma81P3chn5s1qNBapI9wbib9sq8jLABACzt\n\tEqRs8+c27wUV7tfODB+j5inzJtcURbFBoROg8FxztqSPl0/ff2PCJW7CThtHYfcPG2Yu\n\tKtthKlX2gkGq2tUGeoYo5Rb55wzLVTvORcjJPA+V1BB+l7T3xIGzWsRoh0jzTlZyrrru\n\tWzww==","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;\n\tbh=2Peya3NTwAu+b6dqMZL6NqXZLOMpzCbMW4PTu4FTEqI=;\n\tb=eVRctmIp+Rq9S3wCUHXBThV6iM9YM3BDrKBv4Cwoj/pOX33n3FNZWd/Xbk1dOgBg98\n\tNPSMwgOF/+lfXbxOCzWFJH6iHbMtoUSFfkQv31NMe/r+vfmigPkCaP0Wm3LhP8WKVXK5\n\tzt3EcOCMYx6K84Pey3bxi5h+MB9YWe/NuBQ45itFyPF89tHoAm8WE6tsCxFTuH8SVzWj\n\tMn83E45EyW7Fp8AB+ChF39sN+AxtAdzoryXeVbYMMOtYr+TzWDf+CCMnWpqLs3PBKPAI\n\tEE6duw5MJJN/CPtgtRRtEgwUyiGjwuXr7KHuKJvNvO5LaQoXqoUFb4jiEvkgHoFfv8rR\n\t67rQ==","X-Gm-Message-State":"AOAM532GSoME2L+rTlBPnAe2HR0Y22z54p/r/AfQPWB1CoXKkrI3HPLk\n\tBLlrnnZe8yOVILzywsm6gpktliynYMCHuw==","X-Google-Smtp-Source":"ABdhPJzN+AdAIGtvpEnS7UU533t38hvEa2iALxRmsGFVu/Knou5+lr/nGbsqly1++dozhqDOiqWL+g==","X-Received":"by 2002:a2e:89cf:: with SMTP id\n\tc15mr1607498ljk.290.1602677222959; \n\tWed, 14 Oct 2020 05:07:02 -0700 (PDT)","Date":"Wed, 14 Oct 2020 14:07:01 +0200","From":"Niklas =?utf-8?q?S=C3=B6derlund?= ","To":"Jacopo Mondi ","Message-ID":"<20201014120701.hh5jcbzhnaczsjex@oden.dyn.berto.se>","References":"<20201010095830.134084-1-jacopo@jmondi.org>\n\t<20201010095830.134084-4-jacopo@jmondi.org>","MIME-Version":"1.0","Content-Disposition":"inline","In-Reply-To":"<20201010095830.134084-4-jacopo@jmondi.org>","Subject":"Re: [libcamera-devel] [PATCH v2 3/3] android: camera_stream: Add\n\tdocumentation","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Cc":"libcamera-devel@lists.libcamera.org","Content-Type":"text/plain; charset=\"iso-8859-1\"","Content-Transfer-Encoding":"quoted-printable","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}},{"id":13207,"web_url":"https://patchwork.libcamera.org/comment/13207/","msgid":"<20201014181244.guezxz6njgql4w7j@uno.localdomain>","date":"2020-10-14T18:12:44","subject":"Re: [libcamera-devel] [PATCH v2 3/3] android: camera_stream: Add\n\tdocumentation","submitter":{"id":3,"url":"https://patchwork.libcamera.org/api/people/3/","name":"Jacopo Mondi","email":"jacopo@jmondi.org"},"content":"Hi Laurent,\n\nOn Mon, Oct 12, 2020 at 02:33:08AM +0300, Laurent Pinchart wrote:\n> Hi Jacopo,\n>\n> Thank you for the patch.\n>\n> On Sat, Oct 10, 2020 at 11:58:30AM +0200, Jacopo Mondi wrote:\n> > Add a brief documentation block to the CameraStream class.\n> >\n> > Signed-off-by: Jacopo Mondi \n> > ---\n> > src/android/camera_stream.cpp | 21 +++++++++++++++++++++\n> > src/android/camera_stream.h | 5 -----\n> > 2 files changed, 21 insertions(+), 5 deletions(-)\n> >\n> > diff --git a/src/android/camera_stream.cpp b/src/android/camera_stream.cpp\n> > index eac1480530f8..d8e45c2a274d 100644\n> > --- a/src/android/camera_stream.cpp\n> > +++ b/src/android/camera_stream.cpp\n> > @@ -17,6 +17,27 @@ using namespace libcamera;\n> >\n> > LOG_DECLARE_CATEGORY(HAL);\n> >\n> > +/*\n>\n> /* or /** ? It doesn't matter much in practice as src/android/ is not\n> parsed by doxygen.\n>\n\nIf I'm not mistaken we use /* in the HAL as, even if we retain the\ndoxygen syntax, it is not actually parsed by it.\n\n> > + * \\class CameraStream\n> > + * \\brief Map a camera3_stream_t to a StreamConfiguration\n> > + *\n> > + * The CameraStream class maps a camera3_stream_t provided by Android\n> > + * camera framework to a libcamera::StreamConfiguration.\n> > + *\n> > + * The StreamConfiguration is represented by its index as recorded in the\n> > + * CameraConfiguration and not by pointer as StreamConfiguration is subject to\n> > + * relocation.\n> > + *\n> > + * A single StreamConfiguration may be used to deliver one or more streams to\n> > + * the Android framework. The mapping type between a camera3 stream to a\n> > + * StreamConfiguration is described by the CameraStream::Type.\n> > + *\n> > + * CameraStream handles all the aspects of producing a stream with the size\n> > + * and format requested by the camera3 stream from the data produced by\n> > + * the associated libcamera::Stream, including the creation of the encoder\n> > + * and buffer allocation.\n> > + */\n> > +\n>\n> A useful addition for readers who are not familiar with the code.\n>\n> Reviewed-by: Laurent Pinchart \n>\n> > CameraStream::CameraStream(CameraDevice *cameraDevice, Type type,\n> > \t\t\t camera3_stream_t *camera3Stream, unsigned int index)\n> > \t: cameraDevice_(cameraDevice), type_(type),\n> > diff --git a/src/android/camera_stream.h b/src/android/camera_stream.h\n> > index 8df0101c403c..47f3fc61ac2c 100644\n> > --- a/src/android/camera_stream.h\n> > +++ b/src/android/camera_stream.h\n> > @@ -128,11 +128,6 @@ private:\n> > \tlibcamera::CameraConfiguration *config_;\n> > \tType type_;\n> > \tcamera3_stream_t *camera3Stream_;\n> > -\t/*\n> > -\t * The index of the libcamera StreamConfiguration as added during\n> > -\t * configureStreams(). A single libcamera Stream may be used to deliver\n> > -\t * one or more streams to the Android framework.\n> > -\t */\n> > \tunsigned int index_;\n> >\n> > \tstd::unique_ptr encoder_;\n>\n> --\n> Regards,\n>\n> Laurent Pinchart","headers":{"Return-Path":"","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id E6485BEEDF\n\tfor ;\n\tWed, 14 Oct 2020 16:13:02 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 73AB160E36;\n\tWed, 14 Oct 2020 18:13:02 +0200 (CEST)","from relay11.mail.gandi.net (relay11.mail.gandi.net\n\t[217.70.178.231])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id D6194603C1\n\tfor ;\n\tWed, 14 Oct 2020 18:13:00 +0200 (CEST)","from uno.localdomain (93-34-118-233.ip49.fastwebnet.it\n\t[93.34.118.233]) (Authenticated sender: jacopo@jmondi.org)\n\tby relay11.mail.gandi.net (Postfix) with ESMTPSA id 66B37100002;\n\tWed, 14 Oct 2020 16:13:00 +0000 (UTC)"],"Date":"Wed, 14 Oct 2020 20:12:44 +0200","From":"Jacopo Mondi ","To":"Laurent Pinchart ","Message-ID":"<20201014181244.guezxz6njgql4w7j@uno.localdomain>","References":"<20201010095830.134084-1-jacopo@jmondi.org>\n\t<20201010095830.134084-4-jacopo@jmondi.org>\n\t<20201011233308.GH3944@pendragon.ideasonboard.com>","MIME-Version":"1.0","Content-Disposition":"inline","In-Reply-To":"<20201011233308.GH3944@pendragon.ideasonboard.com>","Subject":"Re: [libcamera-devel] [PATCH v2 3/3] android: camera_stream: Add\n\tdocumentation","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Cc":"libcamera-devel@lists.libcamera.org","Content-Type":"text/plain; charset=\"us-ascii\"","Content-Transfer-Encoding":"7bit","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]