Return number of samples recorded.

Author: relic-se

ports/raspberrypi/common-hal/audiobusio/I2S.c

@@ -166,7 +166,7 @@ void common_hal_audiobusio_i2s_deinit(audiobusio_i2s_obj_t *self) {
 
 // output_buffer may be a byte buffer or a halfword buffer.
 // output_buffer_length is the number of slots, not the number of bytes.
-void common_hal_audiobusio_i2s_record_to_buffer(audiobusio_i2s_obj_t *self,
+uint32_t common_hal_audiobusio_i2s_record_to_buffer(audiobusio_i2s_obj_t *self,
     int16_t *output_buffer, uint32_t output_buffer_length) {
     if (!self->state_machine.in) {
         mp_raise_RuntimeError(MP_ERROR_TEXT("No data in"));
@@ -199,6 +199,8 @@ void common_hal_audiobusio_i2s_record_to_buffer(audiobusio_i2s_obj_t *self,
 
         output_count += buffer_length;
     }
+
+    return output_count;
 }
 
 void common_hal_audiobusio_i2s_play(audiobusio_i2s_obj_t *self,

shared-bindings/audiobusio/I2S.c

@@ -179,7 +179,7 @@ static mp_obj_t audiobusio_i2s_obj___exit__(size_t n_args, const mp_obj_t *args)
 }
 static MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(audiobusio_i2s___exit___obj, 4, 4, audiobusio_i2s_obj___exit__);
 
-//|     def record(self, destination: WriteableBuffer, destination_length: int) -> None:
+//|     def record(self, destination: WriteableBuffer, destination_length: int) -> int:
 //|         """Records destination_length bytes of samples to destination. This is
 //|         blocking.
 //|
@@ -210,7 +210,9 @@ static mp_obj_t audiobusio_i2s_obj_record(mp_obj_t self_obj, mp_obj_t destinatio
             mp_raise_ValueError(MP_ERROR_TEXT("destination buffer must be a bytearray or array of type 'B' for bit_depth = 8"));
         }
         // length is the buffer length in slots, not bytes.
-        common_hal_audiobusio_i2s_record_to_buffer(self, bufinfo.buf, length);
+        uint32_t length_written =
+            common_hal_audiobusio_i2s_record_to_buffer(self, bufinfo.buf, length);
+        return MP_OBJ_NEW_SMALL_INT(length_written);
     }
     return mp_const_none;
 }

shared-bindings/audiobusio/I2S.h

@@ -23,7 +23,7 @@ void common_hal_audiobusio_i2s_construct(audiobusio_i2s_obj_t *self,
 void common_hal_audiobusio_i2s_deinit(audiobusio_i2s_obj_t *self);
 bool common_hal_audiobusio_i2s_deinited(audiobusio_i2s_obj_t *self);
 
-void common_hal_audiobusio_i2s_record_to_buffer(audiobusio_i2s_obj_t *self,
+uint32_t common_hal_audiobusio_i2s_record_to_buffer(audiobusio_i2s_obj_t *self,
     int16_t *buffer, uint32_t length);
 
 void common_hal_audiobusio_i2s_play(audiobusio_i2s_obj_t *self, mp_obj_t sample, bool loop);