Update types and documentation regarding events

Signed-off-by: Paul Guyot <pguyot@kallisys.net>

nifs/atomvm_esp_adf_aac_decoder.c

@@ -8,11 +8,12 @@
 #pragma GCC diagnostic push
 #pragma GCC diagnostic ignored "-Wpedantic"
 
-#include <aac_decoder.h>
 #include <esp_attr.h>
 #include <esp_log.h>
 #include <esp_system.h>
 
+#include <aac_decoder.h>
+
 #pragma GCC diagnostic pop
 
 #include <context.h>

src/esp_adf_aac_decoder.erl

@@ -6,6 +6,6 @@
 %% @doc Create a handle to an AAC decoder audio element.
 %% @param Cfg configuration
 %% @return an audio element resource
--spec init([]) -> esp_adf_audio_element:audio_element().
+-spec init([esp_adf_audio_element:audio_element_opt()]) -> esp_adf_audio_element:audio_element().
 init(_Cfg) ->
     erlang:nif_error(undefined).

src/esp_adf_audio_element.erl

@@ -83,7 +83,7 @@
     | codec_fmt
     | {position, [audio_element_position_prop()]}.
 
-%% @doc Set read callback to read a given binary
+%% @doc Set read callback to read a given binary.
 %% If binary is reference counted, it is not copied.
 %% @param AudioElement element to set read callback to
 %% @param Binary binary to read

src/esp_adf_audio_pipeline.erl

@@ -68,8 +68,8 @@ stop(_AudioPipeline) ->
     erlang:nif_error(undefined).
 
 %% @doc Wait for the pipeline to stop. This function is a dirty nif, i.e. it
-%% blocks the scheduler until the pipeline is stopped. So users should use
-%% events (yet to be ported) to only call it when the pipeline is stopped.
+%% blocks the scheduler until the pipeline is stopped. So users should only
+%% call it when the pipeline is stopped.
 %% @param AudioPipeline pipeline to wait to be stopped
 %% @return ok
 -spec wait_for_stop(audio_pipeline()) -> ok.

src/esp_adf_i2s_output.erl

@@ -4,7 +4,8 @@
 -export([init/1]).
 
 -type i2s_output_option() ::
-    {rate, pos_integer()}
+    esp_adf_audio_element:audio_element_opt()
+    | {rate, pos_integer()}
     | {bits, 8 | 16 | 24 | 32}
     | {channels, 1 | 2}
     | {gpio_mclk, -1 | non_neg_integer()}

src/esp_adf_mp3_decoder.erl

@@ -6,6 +6,6 @@
 %% @doc Create a handle to an MP3 decoder audio element.
 %% @param Cfg configuration
 %% @return an audio element resource
--spec init([]) -> esp_adf_audio_element:audio_element().
+-spec init([esp_adf_audio_element:audio_element_opt()]) -> esp_adf_audio_element:audio_element().
 init(_Cfg) ->
     erlang:nif_error(undefined).