{"id":23724,"url":"https://patchwork.libcamera.org/api/1.1/patches/23724/?format=json","web_url":"https://patchwork.libcamera.org/patch/23724/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20250702131032.47654-9-mzamazal@redhat.com>","date":"2025-07-02T13:10:27","name":"[v12,08/12] config: Add global configuration file documentation","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"57f272898528e70a75a970833c7970ea477e47cf","submitter":{"id":177,"url":"https://patchwork.libcamera.org/api/1.1/people/177/?format=json","name":"Milan Zamazal","email":"mzamazal@redhat.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/23724/mbox/","series":[{"id":5265,"url":"https://patchwork.libcamera.org/api/1.1/series/5265/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=5265","date":"2025-07-02T13:10:19","name":"Add global configuration file","version":12,"mbox":"https://patchwork.libcamera.org/series/5265/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/23724/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/23724/checks/","tags":{},"headers":{"Return-Path":"","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 244D2C3237\n\tfor ;\n\tWed, 2 Jul 2025 13:11:06 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id C74EE68E52;\n\tWed, 2 Jul 2025 15:11:05 +0200 (CEST)","from us-smtp-delivery-124.mimecast.com\n\t(us-smtp-delivery-124.mimecast.com [170.10.129.124])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 2444768E42\n\tfor ;\n\tWed, 2 Jul 2025 15:11:03 +0200 (CEST)","from mx-prod-mc-08.mail-002.prod.us-west-2.aws.redhat.com\n\t(ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97])\n\tby relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3,\n\tcipher=TLS_AES_256_GCM_SHA384) id us-mta-627-FtzR3qsNN9CoN8OYsNSUgw-1;\n\tWed, 02 Jul 2025 09:10:59 -0400","from mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com\n\t(mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com\n\t[10.30.177.40])\n\t(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)\n\tkey-exchange X25519 server-signature RSA-PSS (2048 bits)\n\tserver-digest SHA256) (No client certificate requested)\n\tby mx-prod-mc-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix)\n\twith ESMTPS id 70AAF18011CD; Wed, 2 Jul 2025 13:10:58 +0000 (UTC)","from mzamazal-thinkpadp1gen7.tpbc.com (unknown [10.44.33.1])\n\tby mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix)\n\twith ESMTP id 6120419560AB; Wed, 2 Jul 2025 13:10:56 +0000 (UTC)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=redhat.com header.i=@redhat.com\n\theader.b=\"VC0ZGUR3\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;\n\ts=mimecast20190719; t=1751461862;\n\th=from:from:reply-to:subject:subject:date:date:message-id:message-id:\n\tto:to:cc:cc:mime-version:mime-version:content-type:content-type:\n\tcontent-transfer-encoding:content-transfer-encoding:\n\tin-reply-to:in-reply-to:references:references;\n\tbh=eP55KB2qscLu0knHKJyUZPA0jJnSgp9HNN6guAAm+x4=;\n\tb=VC0ZGUR3rsPgYmJsszTRtq/qa4gshPtaeKco53J8lvsHqcJYPxhuikehxkz06d+F1hZBD9\n\tcoSVmFMG05ap94ysWPFTwCG2TgvPhSwgOlOc/rAGlbSiyPEx6XUrVt/8EV0n9aB/nSgE/0\n\tY1mlC1fszu93JSqYZlMuRWYTnlLW6vY=","X-MC-Unique":"FtzR3qsNN9CoN8OYsNSUgw-1","X-Mimecast-MFC-AGG-ID":"FtzR3qsNN9CoN8OYsNSUgw_1751461858","From":"Milan Zamazal ","To":"libcamera-devel@lists.libcamera.org","Cc":"Milan Zamazal , Kieran Bingham\n\t, =?utf-8?q?Barnab=C3=A1s_P=C5=91cze?=\n\t, Laurent Pinchart\n\t","Subject":"[PATCH v12 08/12] config: Add global configuration file\n\tdocumentation","Date":"Wed, 2 Jul 2025 15:10:27 +0200","Message-ID":"<20250702131032.47654-9-mzamazal@redhat.com>","In-Reply-To":"<20250702131032.47654-1-mzamazal@redhat.com>","References":"<20250702131032.47654-1-mzamazal@redhat.com>","MIME-Version":"1.0","X-Scanned-By":"MIMEDefang 3.0 on 10.30.177.40","X-Mimecast-Spam-Score":"0","X-Mimecast-MFC-PROC-ID":"wVTUQoAudOJzIzsPKu_Y5rcq4ZmEHhhcNmGOHmdiUtY_1751461858","X-Mimecast-Originator":"redhat.com","Content-Transfer-Encoding":"8bit","content-type":"text/plain; charset=\"US-ASCII\"; x-default=true","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"Extend (and rename) the documentation of environment variables with\ninformation about the configuration file.\n\nSigned-off-by: Milan Zamazal \n---\n Documentation/documentation-contents.rst | 2 +-\n Documentation/index.rst | 2 +-\n Documentation/meson.build | 2 +-\n ...ariables.rst => runtime_configuration.rst} | 105 ++++++++++++++++--\n 4 files changed, 99 insertions(+), 12 deletions(-)\n rename Documentation/{environment_variables.rst => runtime_configuration.rst} (66%)","diff":"diff --git a/Documentation/documentation-contents.rst b/Documentation/documentation-contents.rst\nindex 5c1118493..4be3729cf 100644\n--- a/Documentation/documentation-contents.rst\n+++ b/Documentation/documentation-contents.rst\n@@ -7,7 +7,7 @@\n * :doc:`/feature_requirements`\n * :doc:`/guides/application-developer`\n * :doc:`/python-bindings`\n- * :doc:`/environment_variables`\n+ * :doc:`/runtime_configuration`\n * :doc:`/api-html/index`\n * :doc:`/code-of-conduct`\n * |\ndiff --git a/Documentation/index.rst b/Documentation/index.rst\nindex 251112fbd..200de6f67 100644\n--- a/Documentation/index.rst\n+++ b/Documentation/index.rst\n@@ -12,13 +12,13 @@\n \n Application Writer's Guide \n Camera Sensor Model \n- Environment variables \n Feature Requirements \n IPA Writer's guide \n Lens driver requirements \n libcamera Architecture \n Pipeline Handler Writer's Guide \n Python Bindings \n+ Runtime configuration \n Sensor driver requirements \n SoftwareISP Benchmarking \n Tracing guide \ndiff --git a/Documentation/meson.build b/Documentation/meson.build\nindex 0fc5909d0..6d5af0f62 100644\n--- a/Documentation/meson.build\n+++ b/Documentation/meson.build\n@@ -128,7 +128,6 @@ if sphinx.found()\n 'contributing.rst',\n 'design/ae.rst',\n 'documentation-contents.rst',\n- 'environment_variables.rst',\n 'feature_requirements.rst',\n 'guides/application-developer.rst',\n 'guides/ipa.rst',\n@@ -140,6 +139,7 @@ if sphinx.found()\n 'libcamera_architecture.rst',\n 'mali-c55.dot',\n 'python-bindings.rst',\n+ 'runtime_configuration.rst',\n 'sensor_driver_requirements.rst',\n 'software-isp-benchmarking.rst',\n '../README.rst',\ndiff --git a/Documentation/environment_variables.rst b/Documentation/runtime_configuration.rst\nsimilarity index 66%\nrename from Documentation/environment_variables.rst\nrename to Documentation/runtime_configuration.rst\nindex 6f1235587..f1fea1c1c 100644\n--- a/Documentation/environment_variables.rst\n+++ b/Documentation/runtime_configuration.rst\n@@ -2,15 +2,98 @@\n \n .. include:: documentation-contents.rst\n \n-Environment variables\n+Runtime configuration\n =====================\n \n-The libcamera behaviour can be tuned through environment variables. This\n-document lists all the available variables and describes their usage.\n+The libcamera behaviour can be tuned through a configuration file or\n+environment variables. This document lists all the configuration options\n+and describes their usage.\n+\n+General rules\n+-------------\n+\n+The configuration file is looked up in the following locations, in this\n+order:\n+\n+- $XDG_CONFIG_HOME/libcamera/configuration.yaml\n+- LIBCAMERA_SYSCONF_DIR/configuration.yaml\n+- /etc/libcamera/configuration.yaml\n+\n+The first configuration file found wins, contingent configuration files\n+in other locations are ignored.\n+\n+Settings in environment variables take precedence over settings in\n+configuration files. This allows overriding behaviour temporarily\n+without the need to modify configuration files.\n+\n+Configuration options\n+---------------------\n+\n+Here is an overview of the available configuration options, in the YAML\n+file structure:\n+\n+::\n+\n+ configuration:\n+ ipa:\n+ config_paths: # full paths to directories, separated by colons\n+ force_isolation: # true/false\n+ module_paths: # full paths to directories, separated by colons\n+ ipas:\n+ rkisp1:\n+ tuning_file: # full path\n+ rpi:\n+ tuning_file: # full path\n+ pipelines_match_list: # pipeline names, separated by commas\n+ pipelines:\n+ rpi:\n+ target: TARGET\n+ pipeline_handler:\n+ ...\n+ simple:\n+ supported_devices:\n+ - driver: # driver name, e.g. `mxc-isi`\n+ software_isp: # true/false\n+\n+Configuration file example\n+--------------------------\n+\n+::\n+\n+ ---\n+ version: 1\n+ configuration:\n+ ipa:\n+ config_paths:\n+ - /home/user/.libcamera/share/ipa\n+ - /opt/libcamera/vendor/share/ipa\n+ module_paths:\n+ - /home/user/.libcamera/lib\n+ - /opt/libcamera/vendor/lib\n+ proxy_paths:\n+ - /home/user/.libcamera/proxy/worker\n+ - /opt/libcamera/vendor/proxy/worker\n+ force_isolation: true\n+ ipas:\n+ rpi:\n+ tuning_file: /home/pi/imx283.json\n+ pipelines_match_list: rkisp1,simple\n+ pipelines:\n+ rpi:\n+ target: bcm2835\n+ pipeline_handler:\n+ min_unicam_buffers: 2\n+ min_total_unicam_buffers: 2\n+ simple:\n+ supported_devices:\n+ - driver: mxc-isi\n+ software_isp: true\n \n List of variables\n -----------------\n \n+The corresponding configuration file paths, if available, are listed in parentheses.\n+\n LIBCAMERA_LOG_FILE\n The custom destination for log output.\n \n@@ -24,27 +107,27 @@ LIBCAMERA_LOG_LEVELS\n LIBCAMERA_LOG_NO_COLOR\n Disable coloring of log messages (`more `__).\n \n-LIBCAMERA_IPA_CONFIG_PATH\n+LIBCAMERA_IPA_CONFIG_PATH (ipa.config_paths)\n Define custom search locations for IPA configurations (`more `__).\n \n Example value: ``${HOME}/.libcamera/share/ipa:/opt/libcamera/vendor/share/ipa``\n \n-LIBCAMERA_IPA_FORCE_ISOLATION\n+LIBCAMERA_IPA_FORCE_ISOLATION (ipa.force_isolation)\n When set to a non-empty string, force process isolation of all IPA modules.\n \n Example value: ``1``\n \n-LIBCAMERA_IPA_MODULE_PATH\n+LIBCAMERA_IPA_MODULE_PATH (ipa.module_paths)\n Define custom search locations for IPA modules (`more `__).\n \n Example value: ``${HOME}/.libcamera/lib:/opt/libcamera/vendor/lib``\n \n-LIBCAMERA_IPA_PROXY_PATH\n+LIBCAMERA_IPA_PROXY_PATH (ipa.proxy_paths)\n Define custom full path for a proxy worker for a given executable name.\n \n Example value: ``${HOME}/.libcamera/proxy/worker:/opt/libcamera/vendor/proxy/worker``\n \n-LIBCAMERA_PIPELINES_MATCH_LIST\n+LIBCAMERA_PIPELINES_MATCH_LIST (pipelines_match_list)\n Define an ordered list of pipeline names to be used to match the media\n devices in the system. The pipeline handler names used to populate the\n variable are the ones passed to the REGISTER_PIPELINE_HANDLER() macro in the\n@@ -55,6 +138,10 @@ LIBCAMERA_PIPELINES_MATCH_LIST\n LIBCAMERA_RPI_CONFIG_FILE\n Define a custom configuration file to use in the Raspberry Pi pipeline handler.\n \n+ Instead of using a separate configuration file, the whole\n+ configuration can be put directly to the global configuration file as\n+ outlined above.\n+\n Example value: ``/usr/local/share/libcamera/pipeline/rpi/vc4/minimal_mem.yaml``\n \n LIBCAMERA__TUNING_FILE\n@@ -156,7 +243,7 @@ code.\n IPA configuration\n ~~~~~~~~~~~~~~~~~\n \n-IPA modules use configuration files to store parameters. The format and\n+IPA modules use their own configuration files to store parameters. The format and\n contents of the configuration files is specific to the IPA module. They usually\n contain tuning parameters for the algorithms, in JSON format.\n \n","prefixes":["v12","08/12"]}