From patchwork Wed Nov 4 18:48:48 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sebastian Fricke X-Patchwork-Id: 10336 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 1139ABE080 for ; Wed, 4 Nov 2020 18:48:56 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 4D5B062C8E; Wed, 4 Nov 2020 19:48:55 +0100 (CET) Authentication-Results: lancelot.ideasonboard.com; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b="loiW+Oih"; dkim-atps=neutral Received: from mail-wr1-x42f.google.com (mail-wr1-x42f.google.com [IPv6:2a00:1450:4864:20::42f]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 0C4AC62C74 for ; Wed, 4 Nov 2020 19:48:54 +0100 (CET) Received: by mail-wr1-x42f.google.com with SMTP id c17so3829886wrc.11 for ; Wed, 04 Nov 2020 10:48:54 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=e96h3O9ARWVneucbqMgb+tEg2sKJjQkNczYT9NFHSqQ=; b=loiW+OihnEUA9M5Man8N7gWKtvcY4SuqiOkRgXfd/M4VWxL23bIQIxsub4yA/N5YrJ B/ktCAXXwdJAjYv8+S0dY3OhN4bjyjsGp2j0+8XbOfrwdNvKwCeLEYTNkfrpz/nYDtVe sDhsumvUbFNf5LdqCTegnZ9Iynue6lUPyKxjLZA1eq6n/thVmjdQBLCjT+2huHk4iC2g dLAyeQKSp99KQvGUgrw2Va7cclutLy0mS6UWAbcdYEphiS+IOzJiTL19vV+QvaZi9QzL plyY+cI30gtRrEUmQdpeuHzEPMqedfD6bWpoeiMhSj4DNvD+qQYpztORVqnsLePwmbMb SaDA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=e96h3O9ARWVneucbqMgb+tEg2sKJjQkNczYT9NFHSqQ=; b=XPFJlpfuUP8uw3qJwY1ng6XKwu2E2g2VuhebX+3iDmnGEt4BaebGuN61n6/cbviMK6 mq7dg/CVNswJKiRjZlEwcmpDlPjiW35o5e4d14A8l+kxZD4pkUCbGGlzKFxLwXuwVr6D EGPwXUMWI9vSPEKlthpLH3uEcognjGSDgujdw/iMvbFKJecm4zelcZVPSXYh8XCZdycp dRSC3dC9Yo3msPlHfmFCNAxO52RRwFIt+x2M1xUjj584gzyURRw2lvA5K+hS/yVcTmTI LeHoqco2nu2f9XxlgsWhAFSONBYyIdH8z7wWizzVudLJN3B3w+KIEFBar62zmpeT/xN8 tFbQ== X-Gm-Message-State: AOAM531YtyqZul22yjFdX9hUb2M/bSO4tdIq+HQrNAaUyEnyM6VZHTsR ZhFTJbnzMUg0HpDizLbvDVrDbkVDZQI= X-Google-Smtp-Source: ABdhPJyxYox32RVcYvJtytk4ueSCW2phYhRj8UMooLb7uqdW81ROCWD0iyIVjjYB3g+HDMLGtoBjGw== X-Received: by 2002:a5d:404f:: with SMTP id w15mr35511440wrp.39.1604515733066; Wed, 04 Nov 2020 10:48:53 -0800 (PST) Received: from basti.fritz.box (p200300d1ff00cb008c3fbf8c28455671.dip0.t-ipconnect.de. [2003:d1:ff00:cb00:8c3f:bf8c:2845:5671]) by smtp.gmail.com with ESMTPSA id l3sm4266013wmg.32.2020.11.04.10.48.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 04 Nov 2020 10:48:51 -0800 (PST) From: Sebastian Fricke To: libcamera-devel@lists.libcamera.org Date: Wed, 4 Nov 2020 19:48:48 +0100 Message-Id: <20201104184848.14235-1-sebastian.fricke.linux@gmail.com> X-Mailer: git-send-email 2.20.1 MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH v3] Documentation: Add descriptions for env. variables 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" Describe the environment variables used in libcamera, excluded variables are `LIBCAMERA_IPA_FORCE_C_API` and `LIBCAMERA_IPA_PROXY_PATH`, the former because it is likely to be removed and the later because it has no current use-case. Add a brief explanation for the IPA configuration and IPA modules. List all the available Log levels and categories and add a short guide for how to use them for debugging. Signed-off-by: Sebastian Fricke Reviewed-by: Jacopo Mondi --- Changes since V2: * replace bullet point list with definition list * Remove the category list as it is too difficult to maintain, instead explain how the categories are set with the LOG_DECLARE_CATEGORY & LOG_DEFINE_CATEGORY macros * Remove the short summary for the IPA module, as it can be misleading and probably not accurate enough * Improve the notes for debugging part by linking to a full explaination while extending the description in the documentation as well * Add an example for the Log level setting * Remove the documentation from guides and add it to the documentation base path Changes since V1: * abandon the usage of tables as they are too clunky and difficult to maintain * Fix a wrong example that does not work on most distributions and setups * Improve structure of log categories --- Documentation/environment_variables.rst | 129 ++++++++++++++++++++++++ Documentation/index.rst | 1 + Documentation/meson.build | 1 + 3 files changed, 131 insertions(+) create mode 100644 Documentation/environment_variables.rst diff --git a/Documentation/environment_variables.rst b/Documentation/environment_variables.rst new file mode 100644 index 0000000..a03412b --- /dev/null +++ b/Documentation/environment_variables.rst @@ -0,0 +1,129 @@ +Environment variables +===================== + +List of variables +----------------- + +LIBCAMERA_LOG_FILE + The custom destination for log output. + + Example value: ``/home/{user}/camera_log.log`` + +LIBCAMERA_LOG_LEVELS + Configure the verbosity of log messages for different categories (`more <#log-levels>`__) + + Example value: ``*:DEBUG`` + +LIBCAMERA_IPA_CONFIG_PATH + Define custom search locations for IPA configurations (`more <#ipa-configuration>`__) + + Example value: ``/usr/path/one:/tmp/path/two`` + +LIBCAMERA_IPA_MODULE_PATH + Define custom search locations for IPA modules (`more <#ipa-module>`__) + + Example value: ``/usr/path/one:/tmp/path/two`` + +Further details +--------------- + +Notes about debugging +~~~~~~~~~~~~~~~~~~~~~ + +The environment variables `LIBCAMERA_LOG_FILE` and `LIBCAMERA_LOG_LEVELS` +are used to modify the destination and verbosity of messages provided by +the libcamera API. + +The `LIBCAMERA_LOG_LEVELS` variable expects a comma-separated list of +'category:level' pairs. The `level <#log-levels>`__ part can either be given +as the index or the name in uppercase letters. +While `category <#log-categories>`__ should either be the exact name of the +category, the '*' wildcard symbol or no value, which targets every category. + + +For more information refer to the `API-documentation `__ + +Examples: + +Enable full debug output to a separate file, for every `category <#log-categories>`__ +within a local environment: + +.. code:: bash + + :~$ LIBCAMERA_LOG_FILE='/tmp/example_log.log' \ + LIBCAMERA_LOG_LEVELS=0 \ + cam --list + +Enable full debug output for the categories Camera & V4L2 within a +global environment: + +.. code:: bash + + :~$ export LIBCAMERA_LOG_LEVELS='Camera:DEBUG,V4L2:DEBUG' + :~$ cam --list + +Log levels +~~~~~~~~~~~ + +This is the list of available log levels, notice that all levels below +the chosen one are printed, while those above are discarded. + +- DEBUG (0) +- INFO (1) +- WARN (2) +- ERROR (3) +- FATAL (4) + +Example: +If you choose WARN (2), you will be able to see WARN (2), ERROR (3) & FATAL (4) +but not DEBUG (0) & INFO (1). + +Log categories +~~~~~~~~~~~~~~~ + +Every category represent a specific area of the libcamera codebase, +the names can be located within the source code, for example: +`src/libcamera/camera_manager.cpp `__ + +.. code:: bash + + LOG_DEFINE_CATEGORY(Camera) + +There are 2 available macros used to assign a category name to a part of the +libcamera API: + +LOG_DEFINE_CATEGORY + This macro is required, in order to use the `LOGC` macro for a + particular category. It can only be used once for each category. + If you want to create log messages within multiple compilation + units for the same category utilize the `LOG_DECLARE_CATEGORY` macro, + in every file except the definition file. +LOG_DECLARE_CATEGORY + Used for sharing an already defined category in between multiple + separately compiled files. + +Both macros have to be used within the namespace part of the C++ source code. + + +IPA configuration +~~~~~~~~~~~~~~~~~~ + +The format and contents of the configuration file are specific to the +IPA (Image Processing Algorithm). It usually contains data that optimize +the behavior of the algorithms stored in JSON format. The +`LIBCAMERA_IPA_CONFIG_PATH` variable can be used to specify custom +storage locations to search for those configuration files. + +`Examples `__ + +IPA module +~~~~~~~~~~~ + +In order to locate the correct IPA module for your hardware, libcamera gathers +existing IPA modules from multiple locations. The default locations for this +operation are the installed system path (for example on Debian: +``/usr/local/x86_64-pc-linux-gnu/libcamera``) and the build directory. +With the `LIBCAMERA_IPA_MODULE_PATH`, you can specify a non-default +location to search for IPA modules. + +`Examples for existing IPA modules `__ diff --git a/Documentation/index.rst b/Documentation/index.rst index ff697d4..c49db18 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -17,3 +17,4 @@ Application Writer's Guide Pipeline Handler Writer's Guide Tracing guide + Environment variables diff --git a/Documentation/meson.build b/Documentation/meson.build index 26a12fc..8086abf 100644 --- a/Documentation/meson.build +++ b/Documentation/meson.build @@ -53,6 +53,7 @@ if sphinx.found() 'contributing.rst', 'docs.rst', 'index.rst', + 'environment_variables.rst', 'guides/introduction.rst', 'guides/application-developer.rst', 'guides/pipeline-handler.rst',