Show a cover letter.

GET /api/1.1/covers/13465/?format=api
HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 13465,
    "url": "https://patchwork.libcamera.org/api/1.1/covers/13465/?format=api",
    "web_url": "https://patchwork.libcamera.org/cover/13465/",
    "project": {
        "id": 1,
        "url": "https://patchwork.libcamera.org/api/1.1/projects/1/?format=api",
        "name": "libcamera",
        "link_name": "libcamera",
        "list_id": "libcamera_core",
        "list_email": "libcamera-devel@lists.libcamera.org",
        "web_url": "",
        "scm_url": "",
        "webscm_url": ""
    },
    "msgid": "<20210824195636.1110845-1-nfraprado@collabora.com>",
    "date": "2021-08-24T19:56:19",
    "name": "[libcamera-devel,v8,00/17] lc-compliance: Add test to queue more requests than hardware depth",
    "submitter": {
        "id": 84,
        "url": "https://patchwork.libcamera.org/api/1.1/people/84/?format=api",
        "name": "Nícolas F. R. A. Prado",
        "email": "nfraprado@collabora.com"
    },
    "mbox": "https://patchwork.libcamera.org/cover/13465/mbox/",
    "series": [
        {
            "id": 2389,
            "url": "https://patchwork.libcamera.org/api/1.1/series/2389/?format=api",
            "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=2389",
            "date": "2021-08-24T19:56:19",
            "name": "lc-compliance: Add test to queue more requests than hardware depth",
            "version": 8,
            "mbox": "https://patchwork.libcamera.org/series/2389/mbox/"
        }
    ],
    "comments": "https://patchwork.libcamera.org/api/covers/13465/comments/",
    "headers": {
        "Return-Path": "<libcamera-devel-bounces@lists.libcamera.org>",
        "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 9B9CFBD87D\n\tfor <parsemail@patchwork.libcamera.org>;\n\tTue, 24 Aug 2021 19:57:21 +0000 (UTC)",
            "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id AF383688A5;\n\tTue, 24 Aug 2021 21:57:19 +0200 (CEST)",
            "from bhuna.collabora.co.uk (bhuna.collabora.co.uk [46.235.227.227])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 0EBF860505\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 24 Aug 2021 21:57:18 +0200 (CEST)",
            "from [127.0.0.1] (localhost [127.0.0.1])\n\t(Authenticated sender: nfraprado) with ESMTPSA id 60E3E1F432FF"
        ],
        "From": "=?utf-8?b?TsOtY29sYXMgRi4gUi4gQS4gUHJhZG8=?= <nfraprado@collabora.com>",
        "To": "libcamera-devel@lists.libcamera.org",
        "Date": "Tue, 24 Aug 2021 16:56:19 -0300",
        "Message-Id": "<20210824195636.1110845-1-nfraprado@collabora.com>",
        "X-Mailer": "git-send-email 2.33.0",
        "MIME-Version": "1.0",
        "Content-Type": "text/plain; charset=UTF-8",
        "Content-Transfer-Encoding": "8bit",
        "Subject": "[libcamera-devel] [PATCH v8 00/17] lc-compliance: Add test to queue\n\tmore requests than hardware depth",
        "X-BeenThere": "libcamera-devel@lists.libcamera.org",
        "X-Mailman-Version": "2.1.29",
        "Precedence": "list",
        "List-Id": "<libcamera-devel.lists.libcamera.org>",
        "List-Unsubscribe": "<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>",
        "List-Archive": "<https://lists.libcamera.org/pipermail/libcamera-devel/>",
        "List-Post": "<mailto:libcamera-devel@lists.libcamera.org>",
        "List-Help": "<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>",
        "List-Subscribe": "<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>",
        "Cc": "kernel@collabora.com, =?utf-8?q?Andr=C3=A9_Almeida?=\n\t<andrealmeid@collabora.com>",
        "Errors-To": "libcamera-devel-bounces@lists.libcamera.org",
        "Sender": "\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"
    },
    "content": "The purpose of this series is to add a new test to lc-compliance that tests\nqueuing a lot of requests at once in order to ensure that pipeline handlers are\nable to handle more requests than they have resources for (like internal buffers\nand V4L2 buffer slots) [1].\n\n[1] https://bugs.libcamera.org/show_bug.cgi?id=24\n\nIn order to achieve this, the FrameBufferAllocator had to be adapted to allow an\narbitrary number of buffers to be allocated. But there's also the issue of\nreporting the minimum number of requests required by the pipeline handler, which\nwas solved by creating a new MinimumRequests property.\n\nBriefly, patches 1 through 9 rework the core and pipeline handlers to use\nMinimumRequests and remove bufferCount, while patches 10 through 17 rework\nlc-compliance to add the new test and an additional test for MinimumRequests.\n\nPatch 1 adds the new MinimumRequests property to report the minimum number of\nrequests needed by the pipeline handler.\n\nPatch 2 adds a count argument to allocate() so that the number of buffers to\nallocate needs to be specified, as it is no longer assumed through bufferCount.\n\nPatches 3-7 decouple the number of internal buffers and V4L2 buffer slots from\nbufferCount in each pipeline handler.\n\nPatch 8 reworks the V4L2 compatibility layer to not depend on bufferCount.\n\nPatch 9 removes bufferCount from the StreamConfiguration and everywhere it was\nstill used, as it is no longer needed.\n\nPatch 10 fixes a file ordering issue in lc-compliance's meson.build.\n\nPatches 11-14 does some refactoring in lc-compliance in order to reduce code\nduplication.\n\nPatch 15 adds the test to lc-compliance.\n\nPatch 16 adds checks in lc-compliance to ensure that requests which failed to be\nenqueued are reported as test failure.\n\nPatch 17 adds another, very short, test to lc-compliance to make sure that the\nMinimumRequests property is set in the pipeline handler.\n\nI've run this new lc-compliance test on the raspberrypi, rkisp1, uvcvideo and\nvimc pipelines. raspberrypi already handles it well, while the other three run\nsuccessfully after applying the series in [2]. The ipu3 should run fine as well\nsince the series in [2] was based on the internal queue already present there.\nA patch for the simple pipeline is still pending.\n\n[2] https://lists.libcamera.org/pipermail/libcamera-devel/2021-July/022508.html\n\nThe number of buffers to allocate in the lc-compliance test (patch 15) was\nhardcoded to 8 since more than that would cause errors when allocating.\n\nv7: https://lists.libcamera.org/pipermail/libcamera-devel/2021-July/022577.html\nv6: https://lists.libcamera.org/pipermail/libcamera-devel/2021-July/022356.html\nv5: https://lists.libcamera.org/pipermail/libcamera-devel/2021-July/022098.html\nv4: https://lists.libcamera.org/pipermail/libcamera-devel/2021-May/020150.html\nv3: https://lists.libcamera.org/pipermail/libcamera-devel/2021-April/019613.html\nv2: https://lists.libcamera.org/pipermail/libcamera-devel/2021-April/019398.html\nv1: https://lists.libcamera.org/pipermail/libcamera-devel/2021-April/019139.html\n\nChanges in v8:\n(thanks to Laurent and Kieran)\n- Changed internal buffer count constants for pipeline handlers to better values\n- Reordered patches to group non-lc-compliance changes together\n- Split buffer allocation changes into separate commits for each pipeline\n  handler (patches 3-7)\n- Changed the MinimumRequests property meaning to require that frames aren't\n  dropped\n- Set MinimumRequests on SimplePipeline depending on device and usage of\n  converter\n- Undid definition of default MinimumRequests on CameraSensor constructor\n- Updated application-developer and pipeline-handler guides with new allocate()\n  API and MinimumRequests property\n- Added handling for when allocate() returns less buffers than needed in cam and\n  the capture unit test\n- Reworked buffer allocation handling in the raspberrypi pipeline handler\n- Moved V4L2 compatibility layer changes to separate commit\n- Added patch 10 to fix wrong file order in lc-compliance's meson.build\n- Added requests_ member to SimpleCapture to hold ownership of queued\n  requests during capture\n- Moved CameraHolder to new test_base.{cpp,h} files\n- Fixed issue in UnbalancedStop test where requests cancelled due to stop() call\n  were failing the test\n- Moved RequiredProperties test to property_test.cpp\n- Moved CameraTests to new test_base.{cpp,h} files\n\nChanges in v7:\n(thanks to Kieran and Jacopo)\n- Renamed property from MinNumRequests to MinimumRequests\n- Changed MinimumRequests property's description\n- Added patch 11 to test if MinimumRequests is valid\n\nChanges in v6:\n(thanks to Naushir)\n- Fixed style issues\n- Changed static_cast to unsigned int when comparing buffer count in\n  lc-compliance\n- Added pipeline prefix to INTERNAL_BUFFER_COUNT and BUFFER_SLOT_COUNT constants\n- Removed comment from Raspberrypi MinNumRequests setting\n- Switched queueRequests()'s 'buffers' and 'requests' parameters order, since\n  'requests' is an output variable\n- Added comment to runCaptureSession()\n\nChanges in v5:\n- Rebased on master (now that lc-compliance was refactored to use Googletest)\n- Added patches 3, 5, 6 and 8\n- Fixed qcam to use at least two buffers\n- Made sure that qcam allocates at least 2 buffers\n\nChanges in v4:\n(thanks to Laurent and Niklas)\n- Renamed QueueDepth property to MinNumRequests and better documented it\n- Changed patch 6 to also remove bufferCount from android\n- Added patch 3 to factor common code in lc-compliance\n- Added patch 5 to remove pipeline dependency on bufferCount\n\nChanges in v3:\n- Added patches 1 and 4 to add the QueueDepth property and remove bufferCount\n- Made the count argument required in patch 2\n- Added previously missing changes to the gstreamer and V4L2 compatibility\n  layers\n\nChanges in v2:\n- Renamed and reworded commits and series\n- Dropped patches 2 and 3, which were hacks to test, and added patch 1 to add\n  count to FrameBufferAllocator\n- Thanks to Niklas:\n  - Created new standalone test instead of looping over the other tests\n\nNícolas F. R. A. Prado (17):\n  libcamera: property: Add MinimumRequests property\n  libcamera: framebuffer_allocator: Make allocate() require count\n  libcamera: pipeline: raspberrypi: Don't rely on bufferCount\n  libcamera: pipeline: ipu3: Don't rely on bufferCount\n  libcamera: pipeline: simple: Don't rely on bufferCount\n  libcamera: pipeline: rkisp1: Don't rely on bufferCount\n  libcamera: pipeline: vimc, uvcvideo: Don't rely on bufferCount\n  v4l2: Allocate buffers based on requested count and MinimumRequests\n  libcamera: stream: Remove bufferCount\n  lc-compliance: Fix source file ordering in meson.build\n  lc-compliance: Move buffer allocation to separate function\n  lc-compliance: Factor common capture code into SimpleCapture\n  lc-compliance: Move camera setup to CameraHolder class\n  lc-compliance: Move role to string conversion to its own function\n  lc-compliance: Add test to queue more requests than hardware depth\n  lc-compliance: Check that requests complete successfully\n  lc-compliance: Add test to ensure MinimumRequests is valid\n\n .../guides/application-developer.rst          |   9 +-\n Documentation/guides/pipeline-handler.rst     |  40 +++--\n include/libcamera/camera.h                    |   2 +-\n include/libcamera/framebuffer_allocator.h     |   2 +-\n include/libcamera/internal/pipeline_handler.h |   2 +-\n include/libcamera/stream.h                    |   2 -\n src/android/camera_stream.cpp                 |   7 +-\n src/cam/camera_session.cpp                    |  12 +-\n src/gstreamer/gstlibcameraallocator.cpp       |   4 +-\n src/lc-compliance/capture_test.cpp            |  90 ++++++++---\n src/lc-compliance/meson.build                 |   4 +-\n src/lc-compliance/property_test.cpp           |  24 +++\n src/lc-compliance/simple_capture.cpp          | 147 ++++++++++++------\n src/lc-compliance/simple_capture.h            |  26 +++-\n src/lc-compliance/test_base.cpp               |  38 +++++\n src/lc-compliance/test_base.h                 |  31 ++++\n src/libcamera/camera.cpp                      |   4 +-\n src/libcamera/framebuffer_allocator.cpp       |   9 +-\n src/libcamera/pipeline/ipu3/cio2.cpp          |   7 +-\n src/libcamera/pipeline/ipu3/cio2.h            |  20 ++-\n src/libcamera/pipeline/ipu3/imgu.cpp          |  12 +-\n src/libcamera/pipeline/ipu3/imgu.h            |  15 +-\n src/libcamera/pipeline/ipu3/ipu3.cpp          |  34 ++--\n .../pipeline/raspberrypi/raspberrypi.cpp      |  57 +++----\n .../pipeline/raspberrypi/rpi_stream.cpp       |  28 +++-\n .../pipeline/raspberrypi/rpi_stream.h         |  24 ++-\n src/libcamera/pipeline/rkisp1/rkisp1.cpp      |  25 +--\n src/libcamera/pipeline/rkisp1/rkisp1_path.cpp |   5 +-\n src/libcamera/pipeline/rkisp1/rkisp1_path.h   |   4 +-\n src/libcamera/pipeline/simple/converter.cpp   |  15 +-\n src/libcamera/pipeline/simple/converter.h     |   9 +-\n src/libcamera/pipeline/simple/simple.cpp      |  70 +++++++--\n src/libcamera/pipeline/uvcvideo/uvcvideo.cpp  |  17 +-\n src/libcamera/pipeline/vimc/vimc.cpp          |  17 +-\n src/libcamera/pipeline_handler.cpp            |   1 +\n src/libcamera/property_ids.yaml               |  21 +++\n src/libcamera/stream.cpp                      |  12 +-\n src/qcam/main_window.cpp                      |   9 +-\n src/v4l2/v4l2_camera.cpp                      |  22 ++-\n src/v4l2/v4l2_camera.h                        |   5 +-\n src/v4l2/v4l2_camera_proxy.cpp                |  11 +-\n test/camera/buffer_import.cpp                 |  10 +-\n test/camera/camera_reconfigure.cpp            |   4 +-\n test/camera/capture.cpp                       |   6 +-\n test/camera/statemachine.cpp                  |   4 +-\n test/libtest/buffer_source.cpp                |   4 +-\n test/libtest/buffer_source.h                  |   2 +-\n test/mapped-buffer.cpp                        |   4 +-\n test/v4l2_videodevice/buffer_cache.cpp        |   3 +-\n 49 files changed, 655 insertions(+), 275 deletions(-)\n create mode 100644 src/lc-compliance/property_test.cpp\n create mode 100644 src/lc-compliance/test_base.cpp\n create mode 100644 src/lc-compliance/test_base.h"
}