From patchwork Thu Aug 20 13:47:48 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kieran Bingham X-Patchwork-Id: 9337 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 82F2BBE173 for ; Thu, 20 Aug 2020 13:47:58 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id BCA7D61F61; Thu, 20 Aug 2020 15:47:57 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=fail reason="signature verification failed" (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="GsZILi9N"; 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 F2DE560381 for ; Thu, 20 Aug 2020 15:47:56 +0200 (CEST) Received: from Q.local (cpc89244-aztw30-2-0-cust3082.18-1.cable.virginm.net [86.31.172.11]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 3B06B23D; Thu, 20 Aug 2020 15:47:56 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1597931276; bh=Bv3QLuaeqIAtZ7E0qMsZ8fEEP2BZvSElY0qQjC9UVeU=; h=From:To:Cc:Subject:Date:From; b=GsZILi9NqtxoQMBoHs+NFQaFCLFmYsq8r1C4rC5oHy+0Or91Nuc8AS2jfatXAWrAI RzpYxmvJ8bSscBGdqyh6RE9YBsOU1nTJvCMm3oB6uILZVN+JiADbeKkRTWGMfl4nOg nfkXqYYfviVinhFzhXqMb+p6nLQNKmGOkVaJ3oGI= From: Kieran Bingham To: libcamera devel , Chris Ward , Jacopo Mondi Date: Thu, 20 Aug 2020 14:47:48 +0100 Message-Id: <20200820134751.278033-1-kieran.bingham@ideasonboard.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH v4 0/3] Developer Guides 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" Hi All, Here is the culmination of work from Chris, Jacopo and Myself preparing some developer guides for libcamera. This is marked as v4, as they are based upon earlier versions of work previously posted by Chris. These three guides aim to cover detail across the areas that a developer wanting to make use of libcamera would look at, including a dedicated walkthrough of the steps of creating a new pipeline handler, or a user application which will make use of libcamera to capture frames. The guides start with an introduction and overview, which replicates quite a bit from the existing "Docs" page, but forms part of refactoring that documentation. The Pipeline handler guide walks through the creation of a new pipeline handler from scratch, implementing a PipelineHandlerVivid for the virtual video test driver provided by the kernel. The aim of this guide is to provide readers with a full walkthrough of the various functions which must be impelmented when writing a new pipeline handler, and can be followed without having a real device available (however the 'vivid' module must be provided by your kernel or distribution). The Application writers guide discusses key aspects as the reader implements a basic application to use the CameraManager to obtain a camera, configure it, and capture frames. An IPA writers guide is expected in the near future, but due to the current activity and changes ongoing with the IPA API, that will be provided after the current work activity with IPC has settled. These guides are not yet built by the libcamera.org website (further refactoring and organising will happen first), but are integrated into any local build which can be generated with Sphinx during the normal libcamera build process. Further expansion to all of these documents is also likely, but I hope to integrate these in their current form and build on top. Chris Chinchilla (3): Documentation: Guides: Developers Guide to Libcamera Documentation: Guides: Pipeline Handler Writers Guide Documentation: Guides: Application Writers Guide .../guides/application-developer.rst | 644 +++++++ Documentation/guides/introduction.rst | 319 ++++ Documentation/guides/pipeline-handler.rst | 1473 +++++++++++++++++ Documentation/index.rst | 4 + Documentation/meson.build | 3 + 5 files changed, 2443 insertions(+) create mode 100644 Documentation/guides/application-developer.rst create mode 100644 Documentation/guides/introduction.rst create mode 100644 Documentation/guides/pipeline-handler.rst