Doc and error messaging changes

Author: gamblor21

locale/circuitpython.pot

@@ -1957,19 +1957,7 @@ msgid "The length of rgb_pins must be 6, 12, 18, 24, or 30"
 msgstr ""
 
 #: shared-module/audiodelays/Echo.c shared-module/audiomixer/MixerVoice.c
-msgid "The sample's bits_per_sample does not match"
-msgstr ""
-
-#: shared-module/audiodelays/Echo.c shared-module/audiomixer/MixerVoice.c
-msgid "The sample's channel count does not match"
-msgstr ""
-
-#: shared-module/audiodelays/Echo.c shared-module/audiomixer/MixerVoice.c
-msgid "The sample's sample rate does not match"
-msgstr ""
-
-#: shared-module/audiodelays/Echo.c shared-module/audiomixer/MixerVoice.c
-msgid "The sample's signedness does not match"
+msgid "The sample's %q does not match"
 msgstr ""
 
 #: supervisor/shared/safe_mode.c

shared-bindings/audiodelays/Echo.c

@@ -14,6 +14,7 @@
 #include "py/objproperty.h"
 #include "py/runtime.h"
 #include "shared-bindings/util.h"
+#include "shared-module/synthio/block.h"
 
 #define DECAY_DEFAULT 0.7f
 #define MIX_DEFAULT 0.5f
@@ -39,7 +40,7 @@
 //|         :param BlockInput delay_ms: The current echo delay
 //|         :param BlockInput decay: The rate the echo fades. 0.0 = instant; 1.0 = never.
 //|         :param BlockInput mix: The mix as a ratio of the sample (0.0) to the effect (1.0).
-//|         :param int buffer_size: The total size in bytes of the buffers to use
+//|         :param int buffer_size: The total size in bytes of each of the two playback buffers to use
 //|         :param int sample_rate: The sample rate to be used
 //|         :param int channel_count: The number of channels the source samples contain. 1 = mono; 2 = stereo.
 //|         :param int bits_per_sample: The bits per sample of the effect
@@ -225,9 +226,7 @@ MP_DEFINE_CONST_FUN_OBJ_1(audiodelays_echo_get_playing_obj, audiodelays_echo_obj
 MP_PROPERTY_GETTER(audiodelays_echo_playing_obj,
     (mp_obj_t)&audiodelays_echo_get_playing_obj);
 
-//|     def play(
-//|         self, sample: circuitpython_typing.AudioSample, *, voice: int = 0, loop: bool = False
-//|     ) -> None:
+//|     def play(self, sample: circuitpython_typing.AudioSample, *, loop: bool = False) -> None:
 //|         """Plays the sample once when loop=False and continuously when loop=True.
 //|         Does not block. Use `playing` to block.
 //|

shared-module/audiodelays/Echo.c

@@ -187,21 +187,21 @@ void common_hal_audiodelays_echo_play(audiodelays_echo_obj_t *self, mp_obj_t sam
     // The get_buffer function will actually process that data
 
     if (audiosample_sample_rate(sample) != self->sample_rate) {
-        mp_raise_ValueError(MP_ERROR_TEXT("The sample's sample rate does not match"));
+        mp_raise_ValueError_varg(MP_ERROR_TEXT("The sample's %q does not match"), MP_QSTR_sample_rate);
     }
     if (audiosample_channel_count(sample) != self->channel_count) {
-        mp_raise_ValueError(MP_ERROR_TEXT("The sample's channel count does not match"));
+        mp_raise_ValueError_varg(MP_ERROR_TEXT("The sample's %q does not match"), MP_QSTR_channel_count);
     }
     if (audiosample_bits_per_sample(sample) != self->bits_per_sample) {
-        mp_raise_ValueError(MP_ERROR_TEXT("The sample's bits_per_sample does not match"));
+        mp_raise_ValueError_varg(MP_ERROR_TEXT("The sample's %q does not match"), MP_QSTR_bits_per_sample);
     }
     bool single_buffer;
     bool samples_signed;
     uint32_t max_buffer_length;
     uint8_t spacing;
     audiosample_get_buffer_structure(sample, false, &single_buffer, &samples_signed, &max_buffer_length, &spacing);
     if (samples_signed != self->samples_signed) {
-        mp_raise_ValueError(MP_ERROR_TEXT("The sample's signedness does not match"));
+        mp_raise_ValueError_varg(MP_ERROR_TEXT("The sample's %q does not match"), MP_QSTR_signedness);
     }
 
     self->sample = sample;

shared-module/audiomixer/MixerVoice.c

@@ -32,13 +32,13 @@ void common_hal_audiomixer_mixervoice_set_level(audiomixer_mixervoice_obj_t *sel
 
 void common_hal_audiomixer_mixervoice_play(audiomixer_mixervoice_obj_t *self, mp_obj_t sample, bool loop) {
     if (audiosample_sample_rate(sample) != self->parent->sample_rate) {
-        mp_raise_ValueError(MP_ERROR_TEXT("The sample's sample rate does not match"));
+        mp_raise_ValueError_varg(MP_ERROR_TEXT("The sample's %q does not match"), MP_QSTR_sample_rate);
     }
     if (audiosample_channel_count(sample) != self->parent->channel_count) {
-        mp_raise_ValueError(MP_ERROR_TEXT("The sample's channel count does not match"));
+        mp_raise_ValueError_varg(MP_ERROR_TEXT("The sample's %q does not match"), MP_QSTR_channel_count);
     }
     if (audiosample_bits_per_sample(sample) != self->parent->bits_per_sample) {
-        mp_raise_ValueError(MP_ERROR_TEXT("The sample's bits_per_sample does not match"));
+        mp_raise_ValueError_varg(MP_ERROR_TEXT("The sample's %q does not match"), MP_QSTR_bits_per_sample);
     }
     bool single_buffer;
     bool samples_signed;
@@ -47,7 +47,7 @@ void common_hal_audiomixer_mixervoice_play(audiomixer_mixervoice_obj_t *self, mp
     audiosample_get_buffer_structure(sample, false, &single_buffer, &samples_signed,
         &max_buffer_length, &spacing);
     if (samples_signed != self->parent->samples_signed) {
-        mp_raise_ValueError(MP_ERROR_TEXT("The sample's signedness does not match"));
+        mp_raise_ValueError_varg(MP_ERROR_TEXT("The sample's %q does not match"), MP_QSTR_signedness);
     }
     self->sample = sample;
     self->loop = loop;