725f8f1e68
- Fixes #10003. Stumbled on https://github.com/espressif/esp-idf/issues/11425 bug while testing. It causes the left and right channels to be swapped randomly on play, which was very confusing. Worked around by forcing a deinit/init on each play. Also got confused because board.A0 and board.A1 are not consistently assigned to left/right channels. Added a documentation warning about this.
263 lines
11 KiB
C
263 lines
11 KiB
C
// This file is part of the CircuitPython project: https://circuitpython.org
|
|
//
|
|
// SPDX-FileCopyrightText: Copyright (c) 2017 Scott Shawcroft for Adafruit Industries
|
|
//
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
#include <stdint.h>
|
|
|
|
#include "shared/runtime/context_manager_helpers.h"
|
|
#include "py/binary.h"
|
|
#include "py/objproperty.h"
|
|
#include "py/runtime.h"
|
|
#include "shared-bindings/microcontroller/Pin.h"
|
|
#include "shared-bindings/audioio/AudioOut.h"
|
|
#include "shared-bindings/audiocore/RawSample.h"
|
|
#include "shared-bindings/util.h"
|
|
|
|
//| class AudioOut:
|
|
//| """Output an analog audio signal"""
|
|
//|
|
|
//| def __init__(
|
|
//| self,
|
|
//| left_channel: microcontroller.Pin,
|
|
//| *,
|
|
//| right_channel: Optional[microcontroller.Pin] = None,
|
|
//| quiescent_value: int = 0x8000,
|
|
//| ) -> None:
|
|
//| """Create a AudioOut object associated with the given pin(s). This allows you to
|
|
//| play audio signals out on the given pin(s).
|
|
//|
|
|
//| :param ~microcontroller.Pin left_channel: Output left channel data to this pin
|
|
//| :param ~microcontroller.Pin right_channel: Output right channel data to this pin. May be ``None``.
|
|
//| :param int quiescent_value: The output value when no signal is present. Samples should start
|
|
//| and end with this value to prevent audible popping.
|
|
//|
|
|
//| .. note:: On ESP32 and ESP32-S2, the DAC channels are usually designated
|
|
//| as ``DAC_1`` (right stereo channel) and DAC_2 (left stereo channel).
|
|
//| These pins are sometimes labelled as ``A0`` and ``A1``, but they may be assigned
|
|
//| in either order. Check your board's pinout to verify which pin is which channel.
|
|
//|
|
|
//| Simple 8ksps 440 Hz sin wave::
|
|
//|
|
|
//| import audiocore
|
|
//| import audioio
|
|
//| import board
|
|
//| import array
|
|
//| import time
|
|
//| import math
|
|
//|
|
|
//| # Generate one period of sine wav.
|
|
//| length = 8000 // 440
|
|
//| sine_wave = array.array("H", [0] * length)
|
|
//| for i in range(length):
|
|
//| sine_wave[i] = int(math.sin(math.pi * 2 * i / length) * (2 ** 15) + 2 ** 15)
|
|
//|
|
|
//| dac = audioio.AudioOut(board.SPEAKER)
|
|
//| sine_wave = audiocore.RawSample(sine_wave, sample_rate=8000)
|
|
//| dac.play(sine_wave, loop=True)
|
|
//| time.sleep(1)
|
|
//| dac.stop()
|
|
//|
|
|
//| Playing a wave file from flash::
|
|
//|
|
|
//| import board
|
|
//| import audioio
|
|
//| import digitalio
|
|
//|
|
|
//| # Required for CircuitPlayground Express
|
|
//| speaker_enable = digitalio.DigitalInOut(board.SPEAKER_ENABLE)
|
|
//| speaker_enable.switch_to_output(value=True)
|
|
//|
|
|
//| data = open("cplay-5.1-16bit-16khz.wav", "rb")
|
|
//| wav = audiocore.WaveFile(data)
|
|
//| a = audioio.AudioOut(board.A0)
|
|
//|
|
|
//| print("playing")
|
|
//| a.play(wav)
|
|
//| while a.playing:
|
|
//| pass
|
|
//| print("stopped")"""
|
|
//| ...
|
|
//|
|
|
static mp_obj_t audioio_audioout_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
|
|
enum { ARG_left_channel, ARG_right_channel, ARG_quiescent_value };
|
|
static const mp_arg_t allowed_args[] = {
|
|
{ MP_QSTR_left_channel, MP_ARG_OBJ | MP_ARG_REQUIRED },
|
|
{ MP_QSTR_right_channel, MP_ARG_OBJ | MP_ARG_KW_ONLY, {.u_rom_obj = mp_const_none} },
|
|
{ MP_QSTR_quiescent_value, MP_ARG_INT | MP_ARG_KW_ONLY, {.u_int = 0x8000} },
|
|
};
|
|
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
|
|
mp_arg_parse_all_kw_array(n_args, n_kw, all_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
|
|
|
|
const mcu_pin_obj_t *left_channel_pin =
|
|
validate_obj_is_free_pin(args[ARG_left_channel].u_obj, MP_QSTR_left_channel);
|
|
const mcu_pin_obj_t *right_channel_pin =
|
|
validate_obj_is_free_pin_or_none(args[ARG_right_channel].u_obj, MP_QSTR_right_channel);
|
|
|
|
// Can't use the same pin for both left and right channels.
|
|
if (left_channel_pin == right_channel_pin) {
|
|
mp_raise_ValueError_varg(MP_ERROR_TEXT("%q and %q must be different"),
|
|
MP_QSTR_left_channel, MP_QSTR_right_channel);
|
|
}
|
|
|
|
// create AudioOut object from the given pin
|
|
audioio_audioout_obj_t *self = mp_obj_malloc_with_finaliser(audioio_audioout_obj_t, &audioio_audioout_type);
|
|
common_hal_audioio_audioout_construct(self, left_channel_pin, right_channel_pin, args[ARG_quiescent_value].u_int);
|
|
|
|
return MP_OBJ_FROM_PTR(self);
|
|
}
|
|
|
|
//| def deinit(self) -> None:
|
|
//| """Deinitialises the AudioOut and releases any hardware resources for reuse."""
|
|
//| ...
|
|
//|
|
|
static mp_obj_t audioio_audioout_deinit(mp_obj_t self_in) {
|
|
audioio_audioout_obj_t *self = MP_OBJ_TO_PTR(self_in);
|
|
common_hal_audioio_audioout_deinit(self);
|
|
return mp_const_none;
|
|
}
|
|
static MP_DEFINE_CONST_FUN_OBJ_1(audioio_audioout_deinit_obj, audioio_audioout_deinit);
|
|
|
|
static void check_for_deinit(audioio_audioout_obj_t *self) {
|
|
if (common_hal_audioio_audioout_deinited(self)) {
|
|
raise_deinited_error();
|
|
}
|
|
}
|
|
//| def __enter__(self) -> AudioOut:
|
|
//| """No-op used by Context Managers."""
|
|
//| ...
|
|
//|
|
|
// Provided by context manager helper.
|
|
|
|
//| def __exit__(self) -> None:
|
|
//| """Automatically deinitializes the hardware when exiting a context. See
|
|
//| :ref:`lifetime-and-contextmanagers` for more info."""
|
|
//| ...
|
|
//|
|
|
// Provided by context manager helper.
|
|
|
|
//| 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.
|
|
//|
|
|
//| Sample must be an `audiocore.WaveFile`, `audiocore.RawSample`, `audiomixer.Mixer` or `audiomp3.MP3Decoder`.
|
|
//|
|
|
//| The sample itself should consist of 16 bit samples. Microcontrollers with a lower output
|
|
//| resolution will use the highest order bits to output. For example, the SAMD21 has a 10 bit
|
|
//| DAC that ignores the lowest 6 bits when playing 16 bit samples."""
|
|
//| ...
|
|
//|
|
|
static mp_obj_t audioio_audioout_obj_play(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
|
|
enum { ARG_sample, ARG_loop };
|
|
static const mp_arg_t allowed_args[] = {
|
|
{ MP_QSTR_sample, MP_ARG_OBJ | MP_ARG_REQUIRED },
|
|
{ MP_QSTR_loop, MP_ARG_BOOL | MP_ARG_KW_ONLY, {.u_bool = false} },
|
|
};
|
|
audioio_audioout_obj_t *self = MP_OBJ_TO_PTR(pos_args[0]);
|
|
check_for_deinit(self);
|
|
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
|
|
mp_arg_parse_all(n_args - 1, pos_args + 1, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
|
|
|
|
mp_obj_t sample = args[ARG_sample].u_obj;
|
|
common_hal_audioio_audioout_play(self, sample, args[ARG_loop].u_bool);
|
|
|
|
return mp_const_none;
|
|
}
|
|
MP_DEFINE_CONST_FUN_OBJ_KW(audioio_audioout_play_obj, 1, audioio_audioout_obj_play);
|
|
|
|
//| def stop(self) -> None:
|
|
//| """Stops playback and resets to the start of the sample."""
|
|
//| ...
|
|
//|
|
|
static mp_obj_t audioio_audioout_obj_stop(mp_obj_t self_in) {
|
|
audioio_audioout_obj_t *self = MP_OBJ_TO_PTR(self_in);
|
|
check_for_deinit(self);
|
|
common_hal_audioio_audioout_stop(self);
|
|
return mp_const_none;
|
|
}
|
|
MP_DEFINE_CONST_FUN_OBJ_1(audioio_audioout_stop_obj, audioio_audioout_obj_stop);
|
|
|
|
//| playing: bool
|
|
//| """True when an audio sample is being output even if `paused`. (read-only)"""
|
|
//|
|
|
static mp_obj_t audioio_audioout_obj_get_playing(mp_obj_t self_in) {
|
|
audioio_audioout_obj_t *self = MP_OBJ_TO_PTR(self_in);
|
|
check_for_deinit(self);
|
|
return mp_obj_new_bool(common_hal_audioio_audioout_get_playing(self));
|
|
}
|
|
MP_DEFINE_CONST_FUN_OBJ_1(audioio_audioout_get_playing_obj, audioio_audioout_obj_get_playing);
|
|
|
|
MP_PROPERTY_GETTER(audioio_audioout_playing_obj,
|
|
(mp_obj_t)&audioio_audioout_get_playing_obj);
|
|
|
|
//| def pause(self) -> None:
|
|
//| """Stops playback temporarily while remembering the position. Use `resume` to resume playback."""
|
|
//| ...
|
|
//|
|
|
static mp_obj_t audioio_audioout_obj_pause(mp_obj_t self_in) {
|
|
audioio_audioout_obj_t *self = MP_OBJ_TO_PTR(self_in);
|
|
check_for_deinit(self);
|
|
|
|
if (!common_hal_audioio_audioout_get_playing(self)) {
|
|
mp_raise_RuntimeError(MP_ERROR_TEXT("Not playing"));
|
|
}
|
|
common_hal_audioio_audioout_pause(self);
|
|
return mp_const_none;
|
|
}
|
|
MP_DEFINE_CONST_FUN_OBJ_1(audioio_audioout_pause_obj, audioio_audioout_obj_pause);
|
|
|
|
//| def resume(self) -> None:
|
|
//| """Resumes sample playback after :py:func:`pause`."""
|
|
//| ...
|
|
//|
|
|
static mp_obj_t audioio_audioout_obj_resume(mp_obj_t self_in) {
|
|
audioio_audioout_obj_t *self = MP_OBJ_TO_PTR(self_in);
|
|
check_for_deinit(self);
|
|
|
|
if (common_hal_audioio_audioout_get_paused(self)) {
|
|
common_hal_audioio_audioout_resume(self);
|
|
}
|
|
|
|
return mp_const_none;
|
|
}
|
|
MP_DEFINE_CONST_FUN_OBJ_1(audioio_audioout_resume_obj, audioio_audioout_obj_resume);
|
|
|
|
//| paused: bool
|
|
//| """True when playback is paused. (read-only)"""
|
|
//|
|
|
//|
|
|
static mp_obj_t audioio_audioout_obj_get_paused(mp_obj_t self_in) {
|
|
audioio_audioout_obj_t *self = MP_OBJ_TO_PTR(self_in);
|
|
check_for_deinit(self);
|
|
return mp_obj_new_bool(common_hal_audioio_audioout_get_paused(self));
|
|
}
|
|
MP_DEFINE_CONST_FUN_OBJ_1(audioio_audioout_get_paused_obj, audioio_audioout_obj_get_paused);
|
|
|
|
MP_PROPERTY_GETTER(audioio_audioout_paused_obj,
|
|
(mp_obj_t)&audioio_audioout_get_paused_obj);
|
|
|
|
static const mp_rom_map_elem_t audioio_audioout_locals_dict_table[] = {
|
|
// Methods
|
|
{ MP_ROM_QSTR(MP_QSTR___del__), MP_ROM_PTR(&audioio_audioout_deinit_obj) },
|
|
{ MP_ROM_QSTR(MP_QSTR_deinit), MP_ROM_PTR(&audioio_audioout_deinit_obj) },
|
|
{ MP_ROM_QSTR(MP_QSTR___enter__), MP_ROM_PTR(&default___enter___obj) },
|
|
{ MP_ROM_QSTR(MP_QSTR___exit__), MP_ROM_PTR(&default___exit___obj) },
|
|
{ MP_ROM_QSTR(MP_QSTR_play), MP_ROM_PTR(&audioio_audioout_play_obj) },
|
|
{ MP_ROM_QSTR(MP_QSTR_stop), MP_ROM_PTR(&audioio_audioout_stop_obj) },
|
|
{ MP_ROM_QSTR(MP_QSTR_pause), MP_ROM_PTR(&audioio_audioout_pause_obj) },
|
|
{ MP_ROM_QSTR(MP_QSTR_resume), MP_ROM_PTR(&audioio_audioout_resume_obj) },
|
|
|
|
// Properties
|
|
{ MP_ROM_QSTR(MP_QSTR_playing), MP_ROM_PTR(&audioio_audioout_playing_obj) },
|
|
{ MP_ROM_QSTR(MP_QSTR_paused), MP_ROM_PTR(&audioio_audioout_paused_obj) },
|
|
};
|
|
static MP_DEFINE_CONST_DICT(audioio_audioout_locals_dict, audioio_audioout_locals_dict_table);
|
|
|
|
MP_DEFINE_CONST_OBJ_TYPE(
|
|
audioio_audioout_type,
|
|
MP_QSTR_AudioOut,
|
|
MP_TYPE_FLAG_HAS_SPECIAL_ACCESSORS,
|
|
make_new, audioio_audioout_make_new,
|
|
locals_dict, &audioio_audioout_locals_dict
|
|
);
|