[{"id":18300,"web_url":"https://patchwork.libcamera.org/comment/18300/","msgid":"<YPu5f0lrdHTg0Q4V@oden.dyn.berto.se>","date":"2021-07-24T06:55:59","subject":"Re: [libcamera-devel] [RFC PATCH 04/17] libcamera: frame_buffer:\n\tDocument the FrameBuffer::Private class","submitter":{"id":5,"url":"https://patchwork.libcamera.org/api/people/5/","name":"Niklas Söderlund","email":"niklas.soderlund@ragnatech.se"},"content":"Hi Laurent,\n\nThanks for your patch.\n\nOn 2021-07-23 07:00:23 +0300, Laurent Pinchart wrote:\n> The FrameBuffer::Private class is exposed to pipeline handlers, and is\n> thus part of the internal libcamera API. As such, it should be\n> documented.\n> \n> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n\nReviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>\n\n> ---\n>  src/libcamera/framebuffer.cpp | 10 ++++++++++\n>  1 file changed, 10 insertions(+)\n> \n> diff --git a/src/libcamera/framebuffer.cpp b/src/libcamera/framebuffer.cpp\n> index 48d14b31f68d..a59e93fbdf91 100644\n> --- a/src/libcamera/framebuffer.cpp\n> +++ b/src/libcamera/framebuffer.cpp\n> @@ -100,6 +100,16 @@ LOG_DEFINE_CATEGORY(Buffer)\n>   * \\brief Array of per-plane metadata\n>   */\n>  \n> +/**\n> + * \\class FrameBuffer::Private\n> + * \\brief Base class for FrameBuffer private data\n> + *\n> + * The FrameBuffer::Private class stores all private data associated with a\n> + * framebuffer. It implements the d-pointer design pattern to hide core\n> + * FrameBuffer data from the public API, and exposes utility functions to\n> + * pipeline handlers.\n> + */\n> +\n>  FrameBuffer::Private::Private()\n>  \t: request_(nullptr)\n>  {\n> -- \n> Regards,\n> \n> Laurent Pinchart\n>","headers":{"Return-Path":"<libcamera-devel-bounces@lists.libcamera.org>","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 18240C322C\n\tfor <parsemail@patchwork.libcamera.org>;\n\tSat, 24 Jul 2021 06:56:03 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id C540A60273;\n\tSat, 24 Jul 2021 08:56:02 +0200 (CEST)","from mail-lf1-x136.google.com (mail-lf1-x136.google.com\n\t[IPv6:2a00:1450:4864:20::136])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id B791660273\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tSat, 24 Jul 2021 08:56:00 +0200 (CEST)","by mail-lf1-x136.google.com with SMTP id m13so5718283lfg.13\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri, 23 Jul 2021 23:56:00 -0700 (PDT)","from localhost (h-46-59-88-219.A463.priv.bahnhof.se.\n\t[46.59.88.219]) by smtp.gmail.com with ESMTPSA id\n\ts21sm3558531lji.57.2021.07.23.23.55.59\n\t(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n\tFri, 23 Jul 2021 23:55:59 -0700 (PDT)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (2048-bit key;\n\tunprotected) header.d=ragnatech-se.20150623.gappssmtp.com\n\theader.i=@ragnatech-se.20150623.gappssmtp.com\n\theader.b=\"VnR84tQO\"; 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=fEAXPyx6JNWPRUgABT8xGSqkqGQiwjG3z8kk9cHVzms=;\n\tb=VnR84tQOj1FeQuKITfpmXPHS3uyEX/0/OMM6YV3purBLJr1mPoxq3moUOFHWPqsx2H\n\ty7Wk35aZPhGMp9kSv61mnRMsrJlEBDToSytlCsHNCqZ2HeQr3m/IFyeVJZoupEfCkxnT\n\tlQyv7lvj2/+Mv3zPR1kZeFIU8q9ahUoiBeHqPPlWHjuygDQb/F4SMXm6YzoYE/dXraF/\n\thvQ3TPBeebfiTQbYrPvsEbWiW0VhXLj5FxfgDPxZT6D63bzogIasBBEhXwqweEILNny1\n\tULPY4OQm3+v7vOoSbrXNKxtsXDOoSY5sDm4h2qKD2W6eJ7YG5h4CP/DhiZe3dy/bQaS8\n\t0d6Q==","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=fEAXPyx6JNWPRUgABT8xGSqkqGQiwjG3z8kk9cHVzms=;\n\tb=PTqVXTx0w/Dbq34Fq/giuM893LmmwgYKS+VW09B9v8jzwxClLCiJdbfVlfFj9gYbrk\n\ttIsvTP+pLgDqmlV7+4SXYgStTf69EysfS9ate7upi6BILFiuBgbOtZlUXZkdTsv2WxGX\n\t9ge6bILiJnE4SZHpn6cDMhg2RMRlQ+OVSw/zRv6s0QHp7HVlFxxd5OyWwpMuE9munaNC\n\tPaWLqL6PmtzEs/HcielvaTMHV2I0l0y4ISEYmi8RppETgx2gDnEcnSs5QeXgr+4zBDGt\n\tFGENNAyWe4WHeb451GJq22ydPM3P0mczHVpR7fUECNgn8v3nG031tJjizZUFXn86n95f\n\tthzA==","X-Gm-Message-State":"AOAM531fHjMJpGRUBdpe7o28GI7JuJ6ULM/tJx/ICbHgV09sAMOaEPOG\n\txAX2GeFC3byfqlYbwyOsj6mXZ2O/8asACA==","X-Google-Smtp-Source":"ABdhPJyk/lfo18J7TTkUfsZMVfBUrPZMm44DZkn0s/o+JFJYGY7upjOc/nxp9sgecuXnNuoXY12Clg==","X-Received":"by 2002:ac2:4859:: with SMTP id 25mr5163930lfy.402.1627109760167;\n\tFri, 23 Jul 2021 23:56:00 -0700 (PDT)","Date":"Sat, 24 Jul 2021 08:55:59 +0200","From":"Niklas =?iso-8859-1?q?S=F6derlund?= <niklas.soderlund@ragnatech.se>","To":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","Message-ID":"<YPu5f0lrdHTg0Q4V@oden.dyn.berto.se>","References":"<20210723040036.32346-1-laurent.pinchart@ideasonboard.com>\n\t<20210723040036.32346-5-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=iso-8859-1","Content-Disposition":"inline","Content-Transfer-Encoding":"8bit","In-Reply-To":"<20210723040036.32346-5-laurent.pinchart@ideasonboard.com>","Subject":"Re: [libcamera-devel] [RFC PATCH 04/17] libcamera: frame_buffer:\n\tDocument the FrameBuffer::Private class","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","Cc":"libcamera-devel@lists.libcamera.org","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"}},{"id":18425,"web_url":"https://patchwork.libcamera.org/comment/18425/","msgid":"<20210729203357.i76yliu3iryosrid@uno.localdomain>","date":"2021-07-29T20:33:57","subject":"Re: [libcamera-devel] [RFC PATCH 04/17] libcamera: frame_buffer:\n\tDocument the FrameBuffer::Private class","submitter":{"id":3,"url":"https://patchwork.libcamera.org/api/people/3/","name":"Jacopo Mondi","email":"jacopo@jmondi.org"},"content":"Hi Laurent\n\nOn Fri, Jul 23, 2021 at 07:00:23AM +0300, Laurent Pinchart wrote:\n> The FrameBuffer::Private class is exposed to pipeline handlers, and is\n> thus part of the internal libcamera API. As such, it should be\n> documented.\n>\n> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n> ---\n>  src/libcamera/framebuffer.cpp | 10 ++++++++++\n>  1 file changed, 10 insertions(+)\n>\n> diff --git a/src/libcamera/framebuffer.cpp b/src/libcamera/framebuffer.cpp\n> index 48d14b31f68d..a59e93fbdf91 100644\n> --- a/src/libcamera/framebuffer.cpp\n> +++ b/src/libcamera/framebuffer.cpp\n> @@ -100,6 +100,16 @@ LOG_DEFINE_CATEGORY(Buffer)\n>   * \\brief Array of per-plane metadata\n>   */\n>\n> +/**\n> + * \\class FrameBuffer::Private\n> + * \\brief Base class for FrameBuffer private data\n> + *\n> + * The FrameBuffer::Private class stores all private data associated with a\n> + * framebuffer. It implements the d-pointer design pattern to hide core\n> + * FrameBuffer data from the public API, and exposes utility functions to\n> + * pipeline handlers.\n\nA single function, actually, but they can grow.\n\nAnyway, that's what's interesting and a bit scary about this pattern.\nIt is meant to allow changes to the internal API not to be reflected\non the public one, but it also create a 'private' interface available\nto selected components, in our case the internal ones that have access\nto the libcamera/internal headers.\n\nAnyway...\n\nReviewed-by: Jacopo Mondi <jacopo@jmondi.org>\n\nthanks\n   j\n\n> + */\n> +\n>  FrameBuffer::Private::Private()\n>  \t: request_(nullptr)\n>  {\n> --\n> Regards,\n>\n> Laurent Pinchart\n>","headers":{"Return-Path":"<libcamera-devel-bounces@lists.libcamera.org>","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 333D3C322E\n\tfor <parsemail@patchwork.libcamera.org>;\n\tThu, 29 Jul 2021 20:33:14 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 92D81687BF;\n\tThu, 29 Jul 2021 22:33:13 +0200 (CEST)","from relay2-d.mail.gandi.net (relay2-d.mail.gandi.net\n\t[217.70.183.194])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 126CA687BA\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tThu, 29 Jul 2021 22:33:12 +0200 (CEST)","(Authenticated sender: jacopo@jmondi.org)\n\tby relay2-d.mail.gandi.net (Postfix) with ESMTPSA id 183C240007;\n\tThu, 29 Jul 2021 20:33:10 +0000 (UTC)"],"Date":"Thu, 29 Jul 2021 22:33:57 +0200","From":"Jacopo Mondi <jacopo@jmondi.org>","To":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","Message-ID":"<20210729203357.i76yliu3iryosrid@uno.localdomain>","References":"<20210723040036.32346-1-laurent.pinchart@ideasonboard.com>\n\t<20210723040036.32346-5-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20210723040036.32346-5-laurent.pinchart@ideasonboard.com>","Subject":"Re: [libcamera-devel] [RFC PATCH 04/17] libcamera: frame_buffer:\n\tDocument the FrameBuffer::Private class","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","Cc":"libcamera-devel@lists.libcamera.org","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"}},{"id":18434,"web_url":"https://patchwork.libcamera.org/comment/18434/","msgid":"<YQNlQ/kdTB4QmwKZ@pendragon.ideasonboard.com>","date":"2021-07-30T02:34:43","subject":"Re: [libcamera-devel] [RFC PATCH 04/17] libcamera: frame_buffer:\n\tDocument the FrameBuffer::Private class","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Jacopo,\n\nOn Thu, Jul 29, 2021 at 10:33:57PM +0200, Jacopo Mondi wrote:\n> On Fri, Jul 23, 2021 at 07:00:23AM +0300, Laurent Pinchart wrote:\n> > The FrameBuffer::Private class is exposed to pipeline handlers, and is\n> > thus part of the internal libcamera API. As such, it should be\n> > documented.\n> >\n> > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n> > ---\n> >  src/libcamera/framebuffer.cpp | 10 ++++++++++\n> >  1 file changed, 10 insertions(+)\n> >\n> > diff --git a/src/libcamera/framebuffer.cpp b/src/libcamera/framebuffer.cpp\n> > index 48d14b31f68d..a59e93fbdf91 100644\n> > --- a/src/libcamera/framebuffer.cpp\n> > +++ b/src/libcamera/framebuffer.cpp\n> > @@ -100,6 +100,16 @@ LOG_DEFINE_CATEGORY(Buffer)\n> >   * \\brief Array of per-plane metadata\n> >   */\n> >\n> > +/**\n> > + * \\class FrameBuffer::Private\n> > + * \\brief Base class for FrameBuffer private data\n> > + *\n> > + * The FrameBuffer::Private class stores all private data associated with a\n> > + * framebuffer. It implements the d-pointer design pattern to hide core\n> > + * FrameBuffer data from the public API, and exposes utility functions to\n> > + * pipeline handlers.\n> \n> A single function, actually, but they can grow.\n> \n> Anyway, that's what's interesting and a bit scary about this pattern.\n> It is meant to allow changes to the internal API not to be reflected\n> on the public one, but it also create a 'private' interface available\n> to selected components, in our case the internal ones that have access\n> to the libcamera/internal headers.\n\nAbsolutely, that's what I really like about it :-) It helps with ABI\ncompatibility, but also with removing functions from the public API.\n\n> Anyway...\n> \n> Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>\n> \n> > + */\n> > +\n> >  FrameBuffer::Private::Private()\n> >  \t: request_(nullptr)\n> >  {","headers":{"Return-Path":"<libcamera-devel-bounces@lists.libcamera.org>","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 1C0F0C3230\n\tfor <parsemail@patchwork.libcamera.org>;\n\tFri, 30 Jul 2021 02:34:53 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id C98C4687C8;\n\tFri, 30 Jul 2021 04:34:52 +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 6B7A8687BD\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri, 30 Jul 2021 04:34:51 +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 F1B3989B;\n\tFri, 30 Jul 2021 04:34:50 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"DQgJTOo5\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1627612491;\n\tbh=T5PLPmurvJB7AudqLtTXSS7pnL/9mKTxV2y1a/vHIBA=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=DQgJTOo5kf2Bl1echB/asjEB+TmXF/seZJK1TSinIcgQcGedlSeAndaMzYAr4CrqP\n\t9Fg+fyToHXANCLXPc/SH23gUaVCx2DTVApX03GH733AyFVNJbJLqPUw+5Tr231k9za\n\tpKjkp6NhHHzyUWF91cBLWCbBklyfQJbfy4p2b4lQ=","Date":"Fri, 30 Jul 2021 05:34:43 +0300","From":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","To":"Jacopo Mondi <jacopo@jmondi.org>","Message-ID":"<YQNlQ/kdTB4QmwKZ@pendragon.ideasonboard.com>","References":"<20210723040036.32346-1-laurent.pinchart@ideasonboard.com>\n\t<20210723040036.32346-5-laurent.pinchart@ideasonboard.com>\n\t<20210729203357.i76yliu3iryosrid@uno.localdomain>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20210729203357.i76yliu3iryosrid@uno.localdomain>","Subject":"Re: [libcamera-devel] [RFC PATCH 04/17] libcamera: frame_buffer:\n\tDocument the FrameBuffer::Private class","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","Cc":"libcamera-devel@lists.libcamera.org","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"}}]