From patchwork Sun Jun 4 08:55:08 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 18699 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 5163FC3200 for ; Sun, 4 Jun 2023 08:55:11 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id AA3FC6287E; Sun, 4 Jun 2023 10:55:10 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org; s=mail; t=1685868910; bh=JxCJUsFsCnVr7FfgjTOmuIIhjyFWqmdjEbqq9ILBSf0=; h=To:Date:Subject:List-Id:List-Unsubscribe:List-Archive:List-Post: List-Help:List-Subscribe:From:Reply-To:From; b=lv2l1IkPIVqvBOyqiF6LsMAIOp86oV3d3uW3/cIKbvqjFho6jwhN26buhwQt9jPDW uSuCWRBI7pxlmGVQ0hFpMpxz2sRL7BCMToz2WdXbyjYvBeggmxCJgYjNW6ic5VoHW+ 08aj+hHB/Vb4RG55n4/v77X5P1O0hev3WRU/jSnOGUdggfhcBJgdZAKBIAdTXncwVw BnvbjoHqY41xb/ZMo8f2ZQEAwodf3ZCtx6Axz2iTW3wNz2QHqfPpWx9TR0A6Zs6HcD K+QfA5eRmQ//U2ubT7McRey7ZlQAiRvATEsEFFEqUQ8BqnBBCiNl1rkAbonq5hRMvZ 33kVRcspPVjFQ== Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 0015062722 for ; Sun, 4 Jun 2023 10:55:08 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="go2F2pQN"; dkim-atps=neutral Received: from pendragon.ideasonboard.com (om126166129043.28.openmobile.ne.jp [126.166.129.43]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 2377B2B6; Sun, 4 Jun 2023 10:54:43 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1685868885; bh=JxCJUsFsCnVr7FfgjTOmuIIhjyFWqmdjEbqq9ILBSf0=; h=From:To:Cc:Subject:Date:From; b=go2F2pQN9Kxfy+zuG6C0q0U/ny8xkg6gsU5P85o+U4FMOk5ZNxQd5SBZjCpipnR+k bsaFnjyNjCOC17SYyg5pgxPoNlazn7EHaqZKoeQGCGo4wa26EDyhVIpoJKtaqrWDTW 09pri/JQYY6QYz/hBTpr2dB5ztVyh7aKzBVE0Gz8= To: libcamera-devel@lists.libcamera.org Date: Sun, 4 Jun 2023 11:55:08 +0300 Message-Id: <20230604085508.1751-1-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.39.3 MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH v2] libcamera: controls: Drop reference to IPA in controls documentation X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Laurent Pinchart via libcamera-devel From: Laurent Pinchart Reply-To: Laurent Pinchart Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" The controls relates to the public API, which doesn't expose IPA modules as they are internal to libcamera. Replace the mention of "IPA" in the controls documentation. While at it, fix a small text reflow issue. Signed-off-by: Laurent Pinchart Reviewed-by: Naushir Patuck Reviewed-by: Kieran Bingham --- Changes since v1: - Drop IPA reference from FocusFoM documentation (thanks Naush) --- src/libcamera/control_ids.yaml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/src/libcamera/control_ids.yaml b/src/libcamera/control_ids.yaml index adea5f90acc5..a0fbb772de64 100644 --- a/src/libcamera/control_ids.yaml +++ b/src/libcamera/control_ids.yaml @@ -275,12 +275,12 @@ controls: type: int32_t description: | Reports a Figure of Merit (FoM) to indicate how in-focus the frame is. - A larger FocusFoM value indicates a more in-focus frame. This control - depends on the IPA to gather ISP statistics from the defined focus - region, and combine them in a suitable way to generate a FocusFoM value. - In this respect, it is not necessarily aimed at providing a way to - implement a focus algorithm by the application, rather an indication of - how in-focus a frame is. + A larger FocusFoM value indicates a more in-focus frame. This singular + value may be based on a combination of statistics gathered from + multiple focus regions within an image. The number of focus regions and + method of combination is platform dependent. In this respect, it is not + necessarily aimed at providing a way to implement a focus algorithm by + the application, rather an indication of how in-focus a frame is. - ColourCorrectionMatrix: type: float @@ -333,8 +333,8 @@ controls: - FrameDurationLimits: type: int64_t description: | - The minimum and maximum (in that order) frame duration, - expressed in microseconds. + The minimum and maximum (in that order) frame duration, expressed in + microseconds. When provided by applications, the control specifies the sensor frame duration interval the pipeline has to use. This limits the largest @@ -343,7 +343,7 @@ controls: the sensor will not be able to raise the exposure time above 33ms. A fixed frame duration is achieved by setting the minimum and maximum values to be the same. Setting both values to 0 reverts to using the - IPA provided defaults. + camera defaults. The maximum frame duration provides the absolute limit to the shutter speed computed by the AE algorithm and it overrides any exposure mode