[libcamera-devel] [PATCH] /src/libcamera/pipeline/raspberrypi/rpi_stream.h: modify the head file

[paul.elder at ideasonboard.com]

Hello Siyuan,

The patch title doesn't contribute any useful information. What about
the header are you modifying? You only have 75 characters, so you need
to be concise.

Also the prefix in this case can just be raspberrypi:. So an example of
an appropriate patch title would be:

raspberrypi: rpi_stream: include the proper ipa_interface header

There of course may be other acceptable variations.

On Mon, Mar 29, 2021 at 03:47:22PM +0800, Siyuan Fan wrote:
> From: Fan Siyuan <bixiaoshizhe at gmail.com>

This is only needed if the sender is different from the committer.

You also need a changelog here. A paragraph (or a sentence for a patch
this small) to describe why you are making what kind of change.

> Signed-off-by: Fan Siyuan <bixiaoshizhe at gmail.com>
> ---
>  src/libcamera/pipeline/raspberrypi/rpi_stream.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/src/libcamera/pipeline/raspberrypi/rpi_stream.h b/src/libcamera/pipeline/raspberrypi/rpi_stream.h
> index f1ac715f..0f002212 100644
> --- a/src/libcamera/pipeline/raspberrypi/rpi_stream.h
> +++ b/src/libcamera/pipeline/raspberrypi/rpi_stream.h
> @@ -13,7 +13,7 @@
>  #include <vector>
>  
>  #include <libcamera/ipa/raspberrypi.h>
> -#include <libcamera/ipa/raspberrypi_ipa_interface.h>
> +#include <libcamera/ipa/ipa_interface.h>

There is documentation on this, but it's still under review so it can
only be found on the mailing list [1].

The interface (including data structures and functions) between the
pipeline handler and the IPA is customizable, in mojom files under
include/libcamera/ipa/. For example, the raspberrypi IPA interface is
defined in include/libcamera/ipa/raspberrypi.mojom. At compile time,
this mojom file is processed and the IPA interface header is generated
(a few other files are generated as well). For raspberrypi, the
generated IPA interface header is raspberrypi_ipa_interface.h, which
will be generated in $BUILD_DIR/include/libcamera/ipa/. This header
includes the definition of the custom data structures and the
IPAInterface specification, according to the definition in the mojom
file. rpi_stream.h uses ipa::RPi::MaskID, which is defined in
raspberrypi.mojom, and will be present in raspberrypi_ipa_interface.h,
so rpi_stream.h needs to include raspberrypi_ipa_interface.h, not
ipa_interface.h.

Sorry for this being so mysterious. That's why I wanted to document
it...

[1] https://patchwork.libcamera.org/patch/11526/#patch


Paul

>  #include <libcamera/stream.h>
>  
>  #include "libcamera/internal/v4l2_videodevice.h"
> -- 
> 2.25.1
> 
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel at lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel