[{"id":23162,"web_url":"https://patchwork.libcamera.org/comment/23162/","msgid":"","date":"2022-05-26T15:31:01","subject":"Re: [libcamera-devel] [PATCH v2 07/19] py: Move MappedFrameBuffer\n\tto libcamera.utils","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Tomi,\n\nThank you for the patch.\n\nOn Tue, May 24, 2022 at 02:45:58PM +0300, Tomi Valkeinen wrote:\n> Move MappedFrameBuffer to libcamera.utils, instead of extending\n> FrameBuffer class with a new mmap() method. This keeps us more aligned\n> to the C++ API.\n\n\"utils\" is a name we use in libcamera/base/utils.h already, for an\nentirely different purpose, but I don't think it will create too much\nconfusion as Python users should not see the C++ utils.h API. We can\nalways bikeshed this naming question later if needed.\n\nReviewed-by: Laurent Pinchart \n\n> Signed-off-by: Tomi Valkeinen \n> ---\n> src/py/cam/cam.py | 5 +-\n> src/py/cam/cam_qt.py | 3 +-\n> src/py/libcamera/__init__.py | 80 -------------------\n> src/py/libcamera/meson.build | 4 +\n> .../MappedFrameBuffer.py} | 10 ---\n> src/py/libcamera/utils/__init__.py | 4 +\n> 6 files changed, 13 insertions(+), 93 deletions(-)\n> copy src/py/libcamera/{__init__.py => utils/MappedFrameBuffer.py} (93%)\n> create mode 100644 src/py/libcamera/utils/__init__.py\n> \n> diff --git a/src/py/cam/cam.py b/src/py/cam/cam.py\n> index 66df18bf..64f67e86 100755\n> --- a/src/py/cam/cam.py\n> +++ b/src/py/cam/cam.py\n> @@ -9,6 +9,7 @@\n> import argparse\n> import binascii\n> import libcamera as libcam\n> +import libcamera.utils\n> import sys\n> import traceback\n> \n> @@ -327,7 +328,7 @@ def request_handler(state, ctx, req):\n> \n> crcs = []\n> if ctx['opt-crc']:\n> - with fb.mmap() as mfb:\n> + with libcamera.utils.MappedFrameBuffer(fb) as mfb:\n> plane_crcs = [binascii.crc32(p) for p in mfb.planes]\n> crcs.append(plane_crcs)\n> \n> @@ -345,7 +346,7 @@ def request_handler(state, ctx, req):\n> print(f'\\t{ctrl} = {val}')\n> \n> if ctx['opt-save-frames']:\n> - with fb.mmap() as mfb:\n> + with libcamera.utils.MappedFrameBuffer(fb) as mfb:\n> filename = 'frame-{}-{}-{}.data'.format(ctx['id'], stream_name, ctx['reqs-completed'])\n> with open(filename, 'wb') as f:\n> for p in mfb.planes:\n> diff --git a/src/py/cam/cam_qt.py b/src/py/cam/cam_qt.py\n> index bff1175b..70bdb7bb 100644\n> --- a/src/py/cam/cam_qt.py\n> +++ b/src/py/cam/cam_qt.py\n> @@ -9,6 +9,7 @@ from PIL import Image\n> from PIL.ImageQt import ImageQt\n> from PyQt5 import QtCore, QtGui, QtWidgets\n> import libcamera as libcam\n> +import libcamera.utils\n> import numpy as np\n> import sys\n> \n> @@ -285,7 +286,7 @@ class MainWindow(QtWidgets.QWidget):\n> controlsLayout.addStretch()\n> \n> def buf_to_qpixmap(self, stream, fb):\n> - with fb.mmap() as mfb:\n> + with libcamera.utils.MappedFrameBuffer(fb) as mfb:\n> cfg = stream.configuration\n> \n> if cfg.pixel_format == libcam.formats.MJPEG:\n> diff --git a/src/py/libcamera/__init__.py b/src/py/libcamera/__init__.py\n> index 0d7da9e2..e234a5e4 100644\n> --- a/src/py/libcamera/__init__.py\n> +++ b/src/py/libcamera/__init__.py\n> @@ -2,83 +2,3 @@\n> # Copyright (C) 2022, Tomi Valkeinen \n> \n> from ._libcamera import *\n> -\n> -\n> -class MappedFrameBuffer:\n> - def __init__(self, fb):\n> - self.__fb = fb\n> -\n> - def __enter__(self):\n> - import os\n> - import mmap\n> -\n> - fb = self.__fb\n> -\n> - # Collect information about the buffers\n> -\n> - bufinfos = {}\n> -\n> - for i in range(fb.num_planes):\n> - fd = fb.fd(i)\n> -\n> - if fd not in bufinfos:\n> - buflen = os.lseek(fd, 0, os.SEEK_END)\n> - bufinfos[fd] = {'maplen': 0, 'buflen': buflen}\n> - else:\n> - buflen = bufinfos[fd]['buflen']\n> -\n> - if fb.offset(i) > buflen or fb.offset(i) + fb.length(i) > buflen:\n> - raise RuntimeError(f'plane is out of buffer: buffer length={buflen}, ' +\n> - f'plane offset={fb.offset(i)}, plane length={fb.length(i)}')\n> -\n> - bufinfos[fd]['maplen'] = max(bufinfos[fd]['maplen'], fb.offset(i) + fb.length(i))\n> -\n> - # mmap the buffers\n> -\n> - maps = []\n> -\n> - for fd, info in bufinfos.items():\n> - map = mmap.mmap(fd, info['maplen'], mmap.MAP_SHARED, mmap.PROT_READ | mmap.PROT_WRITE)\n> - info['map'] = map\n> - maps.append(map)\n> -\n> - self.__maps = tuple(maps)\n> -\n> - # Create memoryviews for the planes\n> -\n> - planes = []\n> -\n> - for i in range(fb.num_planes):\n> - fd = fb.fd(i)\n> - info = bufinfos[fd]\n> -\n> - mv = memoryview(info['map'])\n> -\n> - start = fb.offset(i)\n> - end = fb.offset(i) + fb.length(i)\n> -\n> - mv = mv[start:end]\n> -\n> - planes.append(mv)\n> -\n> - self.__planes = tuple(planes)\n> -\n> - return self\n> -\n> - def __exit__(self, exc_type, exc_value, exc_traceback):\n> - for p in self.__planes:\n> - p.release()\n> -\n> - for mm in self.__maps:\n> - mm.close()\n> -\n> - @property\n> - def planes(self):\n> - return self.__planes\n> -\n> -\n> -def __FrameBuffer__mmap(self):\n> - return MappedFrameBuffer(self)\n> -\n> -\n> -FrameBuffer.mmap = __FrameBuffer__mmap\n> diff --git a/src/py/libcamera/meson.build b/src/py/libcamera/meson.build\n> index 0a7b65f3..b705ac1f 100644\n> --- a/src/py/libcamera/meson.build\n> +++ b/src/py/libcamera/meson.build\n> @@ -72,6 +72,10 @@ run_command('ln', '-fsT', files('__init__.py'),\n> meson.current_build_dir() / '__init__.py',\n> check: true)\n> \n> +run_command('ln', '-fsT', meson.current_source_dir() / 'utils',\n> + meson.current_build_dir() / 'utils',\n> + check: true)\n> +\n> install_data(['__init__.py'], install_dir : destdir)\n> \n> # \\todo Generate stubs when building. See https://peps.python.org/pep-0484/#stub-files\n> diff --git a/src/py/libcamera/__init__.py b/src/py/libcamera/utils/MappedFrameBuffer.py\n> similarity index 93%\n> copy from src/py/libcamera/__init__.py\n> copy to src/py/libcamera/utils/MappedFrameBuffer.py\n> index 0d7da9e2..e7dd16ec 100644\n> --- a/src/py/libcamera/__init__.py\n> +++ b/src/py/libcamera/utils/MappedFrameBuffer.py\n> @@ -1,9 +1,6 @@\n> # SPDX-License-Identifier: LGPL-2.1-or-later\n> # Copyright (C) 2022, Tomi Valkeinen \n> \n> -from ._libcamera import *\n> -\n> -\n> class MappedFrameBuffer:\n> def __init__(self, fb):\n> self.__fb = fb\n> @@ -75,10 +72,3 @@ class MappedFrameBuffer:\n> @property\n> def planes(self):\n> return self.__planes\n> -\n> -\n> -def __FrameBuffer__mmap(self):\n> - return MappedFrameBuffer(self)\n> -\n> -\n> -FrameBuffer.mmap = __FrameBuffer__mmap\n> diff --git a/src/py/libcamera/utils/__init__.py b/src/py/libcamera/utils/__init__.py\n> new file mode 100644\n> index 00000000..4a23ce36\n> --- /dev/null\n> +++ b/src/py/libcamera/utils/__init__.py\n> @@ -0,0 +1,4 @@\n> +# SPDX-License-Identifier: LGPL-2.1-or-later\n> +# Copyright (C) 2022, Tomi Valkeinen \n> +\n> +from .MappedFrameBuffer import MappedFrameBuffer","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 8DEB2BD160\n\tfor ;\n\tThu, 26 May 2022 15:31:10 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id DD7A4611C1;\n\tThu, 26 May 2022 17:31:09 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 8F77A60DB0\n\tfor ;\n\tThu, 26 May 2022 17:31:08 +0200 (CEST)","from pendragon.ideasonboard.com (unknown [37.120.212.14])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id B10E832A;\n\tThu, 26 May 2022 17:31:07 +0200 (CEST)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1653579069;\n\tbh=fQWKu4lLHltfsJRvUiCi4DIQvzmxITIgXbbAJyj8UYI=;\n\th=Date:To:References:In-Reply-To:Subject:List-Id:List-Unsubscribe:\n\tList-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:Cc:\n\tFrom;\n\tb=HI/LatodkaDcTopGI/S+VwNyrsYEAgLUEORLIMdySzbpbKwzKNbsYUeTTl7LfURdn\n\tp50DuTByAAZeZuctf4kZox8g6uP88gTkyiUpP4GHb/ya+hlI0GRQXlB+jvwr5tI2U+\n\tbpyKgKaTla8vaCNKj5ALae3sdU2+FqnI3pEdOpJGcuNe3Gvt57aJSRYavx7eNzZPkz\n\tkicNOdiaRh4rI3vk68I+MePR0ZZTgemEoQOFgbDNTlTVkmBpS+emKzHT6GEPl8F/GE\n\t+aYhUAdSPpCcvvVoPQIoAhuZ/18/hN+6lOFrFBr5JZjztZoeVCWd19Bm+YH70qB2Bd\n\tp4OZ+3oIf9MPg==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1653579068;\n\tbh=fQWKu4lLHltfsJRvUiCi4DIQvzmxITIgXbbAJyj8UYI=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=GlXwq0J3bsj8PqcXm0CMN4YJWGg0vD8LdT0GVtJTnF8sNqWghNhdvKXhTZBn06bM2\n\tXm8z1wbKUMZZv2SRaWrnezjFzpvfICrFdmHaAupbIYwBIxx4IElb+MHyz+1UgAdA0D\n\tOqNa+qfVvXwZ0WhMRLYaCdll4wgvOgjygB7jUUnA="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"GlXwq0J3\"; dkim-atps=neutral","Date":"Thu, 26 May 2022 18:31:01 +0300","To":"Tomi Valkeinen ","Message-ID":"","References":"<20220524114610.41848-1-tomi.valkeinen@ideasonboard.com>\n\t<20220524114610.41848-8-tomi.valkeinen@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20220524114610.41848-8-tomi.valkeinen@ideasonboard.com>","Subject":"Re: [libcamera-devel] [PATCH v2 07/19] py: Move MappedFrameBuffer\n\tto libcamera.utils","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","From":"Laurent Pinchart via libcamera-devel\n\t","Reply-To":"Laurent Pinchart ","Cc":"libcamera-devel@lists.libcamera.org","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]