From patchwork Fri Dec 6 16:07:40 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jacopo Mondi X-Patchwork-Id: 22228 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 65522BE173 for ; Fri, 6 Dec 2024 16:08:03 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id A450367E1F; Fri, 6 Dec 2024 17:07:58 +0100 (CET) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="ZQn3tRkR"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 8902A67E12 for ; Fri, 6 Dec 2024 17:07:55 +0100 (CET) Received: from ideasonboard.com (93-61-96-190.ip145.fastwebnet.it [93.61.96.190]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id D6944B2B; Fri, 6 Dec 2024 17:07:25 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1733501246; bh=ZQxSVQC7JkMBGUIxuY7w04owyYOBD5nSfjYjQQ69qEk=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=ZQn3tRkRCBEqgzvR2GZffHsSdJOWk903xG78oZV+70beq/faH59tZr7Q55YbOHfFJ EdKno5Fwg7I21c0eYioabcITwnIjjQQxbLbgeKaOCd6QY4NxtIgFDhSrbScHEX2o8T hH9dTvuhRF2WY6njhN0ojOaWUXStYQfQZRjhM3ps= From: Jacopo Mondi To: libcamera-devel@lists.libcamera.org Cc: Jacopo Mondi , Harvey Yang , Han-Lin Chen Subject: [PATCH 2/8] guides: application: Document Camera::metadataAvailable Date: Fri, 6 Dec 2024 17:07:40 +0100 Message-ID: <20241206160747.97176-3-jacopo.mondi@ideasonboard.com> X-Mailer: git-send-email 2.47.1 In-Reply-To: <20241206160747.97176-1-jacopo.mondi@ideasonboard.com> References: <20241206160747.97176-1-jacopo.mondi@ideasonboard.com> MIME-Version: 1.0 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: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" Document the Camera::metadataAvailable signal in the application developer guide as an opt-in feature to receive early metadata notifications. Signed-off-by: Jacopo Mondi --- Documentation/guides/application-developer.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/Documentation/guides/application-developer.rst b/Documentation/guides/application-developer.rst index 25beb55d99a3..560bb4464497 100644 --- a/Documentation/guides/application-developer.rst +++ b/Documentation/guides/application-developer.rst @@ -357,6 +357,14 @@ Signals and Slots`_) to connect events with callbacks to handle them. The ``Camera`` device emits two signals that applications can connect to in order to execute callbacks on frame completion events. +The ``Camera::metadataAvailable`` signal notifies applications of the +availability of metadata results before a request completes. Receiving +notification about metadata availability allows application to fast-track +handling of metadata results before all the image buffers in a request are +ready. The full list of metadata results associated with a Request is anyway +available at request complete time, and receiving notifications for early +metadata availability is an optional feature for applications. + The ``Camera::bufferCompleted`` signal notifies applications that a buffer with image data is available. Receiving notifications about the single buffer completion event allows applications to implement partial request completion