sample: drivers: video: capture: add support for the video shell

Modify the capture sample to only run the video shell when the user
enables it with -DCONFIG_VIDEO_SHELL=y, as an alternative way to trigger
captures.

Signed-off-by: Josuah Demangeon <[email protected]>

Author: josuah

samples/drivers/video/capture/README.rst

@@ -83,10 +83,29 @@ using the :ref:`dvp_20pin_ov7670` and :ref:`lcd_par_s035` connected to the board
    :goals: build
    :compact:
 
+For :ref:`native_sim`, build this sample application with the following commands:
+
+.. zephyr-app-commands::
+   :zephyr-app: samples/drivers/video/capture
+   :board: native_sim
+   :goals: build
+   :compact:
+
 For testing purpose without the need of any real video capture and/or display hardwares,
 a video software pattern generator is supported by the above build commands without
 specifying the shields.
 
+For controlling the camera device using shell commands instead of continuously capturing the data,
+append ``-DCONFIG_VIDEO_SHELL=y`` to the build command:
+
+.. zephyr-app-commands::
+   :zephyr-app: samples/drivers/video/capture
+   :board: mimxrt1064_evk
+   :shield: dvp_fpc24_mt9m114,rk043fn66hs_ctg
+   :gen-args: -DCONFIG_VIDEO_SHELL=y
+   :goals: build
+   :compact:
+
 Sample Output
 =============
 
@@ -118,6 +137,28 @@ Sample Output
 
    <repeats endlessly>
 
+If using the shell, the capture would not start, and instead it is possible to access the shell
+
+.. code-block:: console
+
+   uart:~$ video
+   video - Video driver commands
+   Subcommands:
+     start    : Start a video device and its sources
+                Usage: video start <device>
+     stop     : Stop a video device and its sources
+                Usage: video stop <device>
+     capture  : Capture a given number of frames from a device
+                Usage: video capture <device> <num-frames>
+     format   : Query or set the video format of a device
+                Usage: video format <device> <ep> [<fourcc> <width>x<height>]
+     frmival  : Query or set the video frame rate/interval of a device
+                Usage: video frmival <device> <ep> [<n>fps|<n>ms|<n>us]
+     ctrl     : Query or set video controls of a device
+                Usage: video ctrl <device> [<ctrl> <value>]
+   uart:~$
+
+
 References
 **********
 

samples/drivers/video/capture/sample.yaml

@@ -36,3 +36,21 @@ tests:
     integration_platforms:
       - mimxrt1064_evk
       - mimxrt1170_evk/mimxrt1176/cm7
+  sample.video.capture.shell:
+    tags:
+      - video
+      - samples
+      - shell
+    extra_configs:
+      - CONFIG_VIDEO_SHELL=y
+      - CONFIG_FPU=y
+      - CONFIG_DISPLAY=n
+    harness: console
+    harness_config:
+      type: one_line
+      regex:
+        - "Letting the user control the device with the video shell"
+    platform_allow:
+      - native_sim/native/64
+    integration_platforms:
+      - native_sim/native/64

samples/drivers/video/capture/src/main.c

@@ -199,10 +199,16 @@ int main(void)
 		video_set_ctrl(video_dev, &ctrl);
 	}
 
-#ifdef CONFIG_TEST
-	ctrl.id = VIDEO_CID_TEST_PATTERN;
-	video_set_ctrl(video_dev, &ctrl);
-#endif
+	if (IS_ENABLED(CONFIG_TEST)) {
+		ctrl.id = VIDEO_CID_TEST_PATTERN;
+		video_set_ctrl(video_dev, &ctrl);
+	}
+
+	/* When the video shell is enabled, do not run the capture loop */
+	if (IS_ENABLED(CONFIG_VIDEO_SHELL)) {
+		LOG_INF("Letting the user control the device with the video shell");
+		return 0;
+	}
 
 #if DT_HAS_CHOSEN(zephyr_display)
 	const struct device *const display_dev = DEVICE_DT_GET(DT_CHOSEN(zephyr_display));