feat(avi_player): support multiple instances

Author: lijunru-hub

components/avi_player/CHANGELOG.md

@@ -1,5 +1,9 @@
 # ChangeLog
 
+## v2.0.0 - 2025-06-09
+
+* Support multiple instances.
+
 ## v1.0.0 - 2024-8-15
 
 * publish official version

components/avi_player/avi_player.c

@@ -68,19 +68,19 @@ static int strl_parser(avi_typedef *AVI_file, const uint8_t *buffer, uint32_t le
     }
 #ifdef CONFIG_AVI_PLAYER_DEBUG_INFO
     printf("-----strh info------\r\n");
-    printf("fourcc_type:0x%x\r\n", strh->fourcc_type);
-    printf("fourcc_codec:0x%x\r\n", strh->fourcc_codec);
-    printf("flags:%d\r\n", strh->flags);
+    printf("fourcc_type:0x%lx\r\n", strh->fourcc_type);
+    printf("fourcc_codec:0x%"PRIx32"\r\n", strh->fourcc_codec);
+    printf("flags:%"PRIu32"\r\n", strh->flags);
     printf("Priority:%d\r\n", strh->priority);
     printf("Language:%d\r\n", strh->language);
-    printf("InitFrames:%d\r\n", strh->init_frames);
-    printf("Scale:%d\r\n", strh->scale);
-    printf("Rate:%d\r\n", strh->rate);
-    printf("Start:%d\r\n", strh->start);
-    printf("Length:%d\r\n", strh->length);
-    printf("RefBufSize:%d\r\n", strh->suggest_buff_size);
-    printf("Quality:%d\r\n", strh->quality);
-    printf("SampleSize:%d\r\n", strh->sample_size);
+    printf("InitFrames:%"PRIu32"\r\n", strh->init_frames);
+    printf("Scale:%"PRIu32"\r\n", strh->scale);
+    printf("Rate:%"PRIu32"\r\n", strh->rate);
+    printf("Start:%"PRIu32"\r\n", strh->start);
+    printf("Length:%"PRIu32"\r\n", strh->length);
+    printf("RefBufSize:%"PRIu32"\r\n", strh->suggest_buff_size);
+    printf("Quality:%"PRIu32"\r\n", strh->quality);
+    printf("SampleSize:%"PRIu32"\r\n", strh->sample_size);
     printf("FrameLeft:%d\r\n", strh->rcFrame.left);
     printf("FrameTop:%d\r\n", strh->rcFrame.top);
     printf("FrameRight:%d\r\n", strh->rcFrame.right);
@@ -104,17 +104,17 @@ static int strl_parser(avi_typedef *AVI_file, const uint8_t *buffer, uint32_t le
         }
 #ifdef CONFIG_AVI_PLAYER_DEBUG_INFO
         printf("-----video strf info------\r\n");
-        printf("Size of this structure:%d\r\n", strf->size1);
-        printf("Width of image:%d\r\n", strf->width);
-        printf("Height of image:%d\r\n", strf->height);
+        printf("Size of this structure:%"PRIu32"\r\n", strf->size1);
+        printf("Width of image:%"PRIu32"\r\n", strf->width);
+        printf("Height of image:%"PRIu32"\r\n", strf->height);
         printf("Number of planes:%d\r\n", strf->planes);
         printf("Number of bits per pixel:%d\r\n", strf->bitcount);
-        printf("Compression type:0x%x\r\n", strf->fourcc_compression);
-        printf("Image size:%d\r\n", strf->image_size);
-        printf("Horizontal resolution:%d\r\n", strf->x_pixels_per_meter);
-        printf("Vertical resolution:%d\r\n", strf->y_pixels_per_meter);
-        printf("Number of colors in palette:%d\r\n", strf->num_colors);
-        printf("Number of important colors:%d\r\n\n", strf->imp_colors);
+        printf("Compression type:0x%"PRIx32"\r\n", strf->fourcc_compression);
+        printf("Image size:%"PRIu32"\r\n", strf->image_size);
+        printf("Horizontal resolution:%"PRIu32"\r\n", strf->x_pixels_per_meter);
+        printf("Vertical resolution:%"PRIu32"\r\n", strf->y_pixels_per_meter);
+        printf("Number of colors in palette:%"PRIu32"\r\n", strf->num_colors);
+        printf("Number of important colors:%"PRIu32"\r\n\n", strf->imp_colors);
 #endif
         AVI_file->vids_fps = strh->rate / strh->scale;
         AVI_file->vids_width = strf->width;
@@ -132,10 +132,10 @@ static int strl_parser(avi_typedef *AVI_file, const uint8_t *buffer, uint32_t le
         printf("strf data block info(audio stream):");
         printf("format tag:%d\r\n", strf->format_tag);
         printf("number of channels:%d\r\n", strf->channels);
-        printf("sampling rate:%d\r\n", strf->samples_per_sec);
-        printf("bitrate:%d\r\n", strf->avg_bytes_per_sec);
+        printf("sampling rate:%"PRIu32"\r\n", strf->samples_per_sec);
+        printf("bitrate:%"PRIu32"\r\n", strf->avg_bytes_per_sec);
         printf("block align:%d\r\n", strf->block_align);
-        printf("sample size:%d\r\n\n", strf->bits_per_sample);
+        printf("sample size:%"PRIu32"\r\n\n", strf->bits_per_sample);
 #endif
         AVI_file->auds_channels = strf->channels;
         AVI_file->auds_sample_rate = strf->samples_per_sec;
@@ -176,16 +176,16 @@ int avi_parser(avi_typedef *AVI_file, const uint8_t *buffer, uint32_t length)
 
 #ifdef CONFIG_AVI_PLAYER_DEBUG_INFO
     printf("-----avih info------\r\n");
-    printf("us_per_frame:%d\r\n", avih->us_per_frame);
-    printf("max_bytes_per_sec:%d\r\n", avih->max_bytes_per_sec);
-    printf("padding:%d\r\n", avih->padding);
-    printf("flags:%d\r\n", avih->flags);
-    printf("total_frames:%d\r\n", avih->total_frames);
-    printf("init_frames:%d\r\n", avih->init_frames);
-    printf("streams:%d\r\n", avih->streams);
-    printf("suggest_buff_size:%d\r\n", avih->suggest_buff_size);
-    printf("Width:%d\r\n", avih->width);
-    printf("Height:%d\r\n\n", avih->height);
+    printf("us_per_frame:%"PRIu32"\r\n", avih->us_per_frame);
+    printf("max_bytes_per_sec:%"PRIu32"\r\n", avih->max_bytes_per_sec);
+    printf("padding:%"PRIu32"\r\n", avih->padding);
+    printf("flags:%"PRIu32"\r\n", avih->flags);
+    printf("total_frames:%"PRIu32"\r\n", avih->total_frames);
+    printf("init_frames:%"PRIu32"\r\n", avih->init_frames);
+    printf("streams:%"PRIu32"\r\n", avih->streams);
+    printf("suggest_buff_size:%"PRIu32"\r\n", avih->suggest_buff_size);
+    printf("Width:%"PRIu32"\r\n", avih->width);
+    printf("Height:%"PRIu32"\r\n\n", avih->height);
 #endif
 
     pdata += sizeof(AVI_AVIH_CHUNK);

components/avi_player/avifile.c

@@ -1,12 +1,12 @@
-version: "1.0.0"
+dependencies:
+  espressif/cmake_utilities: "*"
+  idf: '>=4.4'
 description: Parse the video stream and audio stream of an AVI video file.
-url: https://github.com/espressif/esp-iot-solution/tree/master/components/avi_player
 documentation: https://docs.espressif.com/projects/esp-iot-solution/en/latest/multimedia/avi_player.html
 issues: https://github.com/espressif/esp-iot-solution/issues
-repository: https://github.com/espressif/esp-iot-solution.git
-dependencies:
-  idf: ">=4.4"
-  cmake_utilities: "0.*"
-sbom:
-  supplier: 'Organization: Espressif Systems (Shanghai) CO LTD'
-  originator: 'Organization: Espressif Systems (Shanghai) CO LTD'
+repository: git://github.com/espressif/esp-iot-solution.git
+repository_info:
+  commit_sha: a4fdf46f42e57aa20521159dab5146fc511142a4
+  path: components/avi_player
+url: https://github.com/espressif/esp-iot-solution/tree/master/components/avi_player
+version: 2.0.0

components/avi_player/idf_component.yml

@@ -8,6 +8,7 @@
 
 #include "esp_err.h"
 #include "freertos/FreeRTOS.h"
+#include "esp_idf_version.h"
 
 #ifdef __cplusplus
 extern "C" {
@@ -83,6 +84,8 @@ typedef void (*audio_write_cb)(frame_data_t *data, void *arg);
 typedef void (*audio_set_clock_cb)(uint32_t rate, uint32_t bits_cfg, uint32_t ch, void *arg);
 typedef void (*avi_play_end_cb)(void *arg);
 
+typedef void *avi_player_handle_t;
+
 /**
  * @brief avi player config
  *
@@ -96,32 +99,39 @@ typedef struct {
     UBaseType_t priority;                    /*!< FreeRTOS task priority */
     BaseType_t coreID;                       /*!< ESP32 core ID */
     void *user_data;                         /*!< User data */
+    int stack_size;                          /*!< Stack size for the player task */
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 1, 0)
+    bool stack_in_psram;                     /*!< If you read file/data from flash, do not set true*/
+#endif
 } avi_player_config_t;
 
 /**
  * @brief Plays an AVI file from memory. The buffer of the AVI will be passed through the set callback function.
  *
  * This function initializes and plays an AVI file from a memory buffer.
  *
- * @param avi_data Pointer to the AVI file data in memory.
- * @param avi_size Size of the AVI file data in bytes.
+ * @param[in] handle AVI player handle
+ * @param[in] avi_data Pointer to the AVI file data in memory.
+ * @param[in] avi_size Size of the AVI file data in bytes.
  * @return esp_err_t ESP_OK if successful, otherwise an error code.
  */
-esp_err_t avi_player_play_from_memory(uint8_t *avi_data, size_t avi_size);
+esp_err_t avi_player_play_from_memory(avi_player_handle_t handle, uint8_t *avi_data, size_t avi_size);
 
 /**
  * @brief Plays an AVI file from the filesystem. The buffer of the AVI will be passed through the set callback function.
  *
  * This function initializes and plays an AVI file from the filesystem using its filename.
  *
- * @param filename Path to the AVI file on the filesystem.
+ * @param[in] handle AVI player handle
+ * @param[in] filename Path to the AVI file on the filesystem.
  * @return esp_err_t ESP_OK if successful, otherwise an error code.
  */
-esp_err_t avi_player_play_from_file(const char *filename);
+esp_err_t avi_player_play_from_file(avi_player_handle_t handle, const char *filename);
 
 /**
  * @brief Get one video frame from AVI stream
  *
+ * @param[in] handle AVI player handle
  * @param[out] buffer        Pointer to external buffer to hold one frame
  * @param[in,out] buffer_size Size of external buffer
  * @param[out] info          Information of the video frame
@@ -133,11 +143,12 @@ esp_err_t avi_player_play_from_file(const char *filename);
  *      - ESP_ERR_INVALID_ARG  NULL arguments
  *      - ESP_ERR_NO_MEM  External buffer not enough
  */
-esp_err_t avi_player_get_video_buffer(void **buffer, size_t *buffer_size, video_frame_info_t *info, TickType_t ticks_to_wait);
+esp_err_t avi_player_get_video_buffer(avi_player_handle_t handle, void **buffer, size_t *buffer_size, video_frame_info_t *info, TickType_t ticks_to_wait);
 
 /**
  * @brief Get the audio buffer from AVI file
  *
+ * @param[in] handle AVI player handle
  * @param[out] buffer pointer to the audio buffer
  * @param[in] buffer_size size of the audio buffer
  * @param[out] info audio frame information
@@ -149,37 +160,40 @@ esp_err_t avi_player_get_video_buffer(void **buffer, size_t *buffer_size, video_
  *      - ESP_ERR_INVALID_ARG if buffer or info is NULL or buffer_size is zero
  *      - ESP_ERR_NO_MEM if buffer size is not enough
  */
-esp_err_t avi_player_get_audio_buffer(void **buffer, size_t *buffer_size, audio_frame_info_t *info, TickType_t ticks_to_wait);
+esp_err_t avi_player_get_audio_buffer(avi_player_handle_t handle, void **buffer, size_t *buffer_size, audio_frame_info_t *info, TickType_t ticks_to_wait);
 
 /**
  * @brief Stop AVI player
  *
+ * @param[in] handle AVI player handle
  * @return
  *      - ESP_OK: Stop AVI player successfully
  *      - ESP_ERR_INVALID_STATE: AVI player not playing
  */
-esp_err_t avi_player_play_stop(void);
+esp_err_t avi_player_play_stop(avi_player_handle_t handle);
 
 /**
  * @brief Initialize the AVI player
  *
  * @param[in] config Configuration of AVI player
+ * @param[out] handle Pointer to store the AVI player handle
  *
  * @return
  *      - ESP_OK: succeed
  *      - ESP_ERR_NO_MEM: Cannot allocate memory for AVI player
  *      - ESP_ERR_INVALID_STATE: AVI player has already been initialized
  */
-esp_err_t avi_player_init(avi_player_config_t config);
+esp_err_t avi_player_init(avi_player_config_t config, avi_player_handle_t *handle);
 
 /**
  * @brief Deinitializes the AVI player.
  *
  * This function deinitializes and cleans up resources used by the AVI player.
  *
+ * @param[in] handle AVI player handle
  * @return esp_err_t ESP_OK if successful, otherwise an error code.
  */
-esp_err_t avi_player_deinit(void);
+esp_err_t avi_player_deinit(avi_player_handle_t handle);
 
 #ifdef __cplusplus
 }

components/avi_player/include/avi_player.h

@@ -12,6 +12,7 @@
 #include "esp_heap_caps.h"
 #include "esp_log.h"
 #include "esp_timer.h"
+#include "esp_idf_version.h"
 #include "esp_spiffs.h"
 #include "avi_player.h"
 
@@ -54,16 +55,22 @@ TEST_CASE("avi_player_test", "[avi_player]")
         .video_cb = video_write,
         .audio_set_clock_cb = audio_set_clock,
         .avi_play_end_cb = avi_play_end,
+        .stack_size = 4096,
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 1, 0)
+        // It must not be set to `true` when reading data from flash.
+        .stack_in_psram = false,
+#endif
     };
 
-    avi_player_init(config);
+    avi_player_handle_t handle;
+    avi_player_init(config, &handle);
 
-    avi_player_play_from_file("/spiffs/p4_introduce.avi");
+    avi_player_play_from_file(handle, "/spiffs/p4_introduce.avi");
 
     while (!end_play) {
         vTaskDelay(500 / portTICK_PERIOD_MS);
     }
-    avi_player_deinit();
+    avi_player_deinit(handle);
     vTaskDelay(500 / portTICK_PERIOD_MS);
 }
 

components/avi_player/test_apps/main/avi_player_test.c

@@ -1,4 +1,4 @@
-version: 0.1.0
+version: 0.2.0
 targets:
   - esp32s2
   - esp32s3
@@ -12,7 +12,7 @@ dependencies:
     version: "1.1.*"
     override_path: "../../../../../components/usb/usb_device_uvc"
   avi_player:
-    version: "1.*"
+    version: "2.*"
     override_path: "../../../../../components/avi_player"
   lvgl/lvgl: #temp to workaround bsp issue
     version: "9.2.0"

examples/usb/device/usb_dual_uvc_device/main/idf_component.yml

@@ -18,12 +18,13 @@
 static const char *TAG = "usb_cam1";
 static uvc_fb_t s_fb;
 static bool running = false;
+static avi_player_handle_t avi_handle;
 
 static void camera_stop_cb(void *cb_ctx)
 {
     (void)cb_ctx;
     if (running) {
-        avi_player_play_stop();
+        avi_player_play_stop(avi_handle);
         running = false;
     }
     ESP_LOGI(TAG, "Camera:%"PRIu32" Stop", (uint32_t)cb_ctx);
@@ -36,7 +37,7 @@ static esp_err_t camera_start_cb(uvc_format_t format, int width, int height, int
     ESP_LOGI(TAG, "Format: %d, width: %d, height: %d, rate: %d", format, width, height, rate);
 
     running = true;
-    avi_player_play_from_file("/spiffs/p4_introduce.avi");
+    avi_player_play_from_file(avi_handle, "/spiffs/p4_introduce.avi");
 
     return ESP_OK;
 }
@@ -46,7 +47,7 @@ static uvc_fb_t* camera_fb_get_cb(void *cb_ctx)
     (void)cb_ctx;
     video_frame_info_t info;
     size_t buf_size = UVC_MAX_FRAMESIZE_SIZE;
-    avi_player_get_video_buffer((void **)&s_fb.buf, &buf_size, &info, pdMS_TO_TICKS(200));
+    avi_player_get_video_buffer(avi_handle, (void **)&s_fb.buf, &buf_size, &info, pdMS_TO_TICKS(200));
     ESP_LOGD(TAG, "Camera buf_size: %d", buf_size);
     uint64_t us = (uint64_t)esp_timer_get_time();
     s_fb.timestamp.tv_sec = us / 1000000UL;
@@ -77,7 +78,7 @@ static void camera_fb_return_cb(uvc_fb_t *fb, void *cb_ctx)
 static void avi_end_cb(void *arg)
 {
     if (running) {
-        avi_player_play_from_file("/spiffs/p4_introduce.avi");
+        avi_player_play_from_file(avi_handle, "/spiffs/p4_introduce.avi");
     }
 }
 
@@ -88,7 +89,7 @@ esp_err_t usb_cam1_init(void)
         .buffer_size = UVC_MAX_FRAMESIZE_SIZE,
     };
 
-    avi_player_init(avi_cfg);
+    avi_player_init(avi_cfg, &avi_handle);
 
     s_fb.buf = (uint8_t *)malloc(UVC_MAX_FRAMESIZE_SIZE);
     if (s_fb.buf == NULL) {