:mod:`audioio`
==============

.. py:module:: audioio

.. autoapi-nested-parse::

   Support for audio output

   The `audioio` module contains classes to provide access to audio IO.

   All classes change hardware state and should be deinitialized when they
   are no longer needed if the program continues after use. To do so, either
   call :py:meth:`!deinit` or use a context manager. See
   :ref:`lifetime-and-contextmanagers` for more info.

   Since CircuitPython 5, `RawSample` and `WaveFile` are moved
   to :mod:`audiocore`, and `Mixer` is moved to :mod:`audiomixer`.

   For compatibility with CircuitPython 4.x, some builds allow the items in
   `audiocore` to be imported from `audioio`.  This will be removed for all
   boards in a future build of CircuitPython.



.. raw:: html

    <p>
    <details>
    <summary>Available on these boards</summary>
    <ul>
    <li> Adafruit BLM Badge
    <li> Adafruit Circuit Playground Express 4-H
    <li> Adafruit CircuitPlayground Express
    <li> Adafruit CircuitPlayground Express with Crickit libraries
    <li> Adafruit CircuitPlayground Express with displayio
    <li> Adafruit EdgeBadge
    <li> Adafruit Feather M0 Express
    <li> Adafruit Feather M0 Express with Crickit libraries
    <li> Adafruit Feather M4 CAN
    <li> Adafruit Feather M4 Express
    <li> Adafruit Grand Central M4 Express
    <li> Adafruit Hallowing M4 Express
    <li> Adafruit ItsyBitsy M0 Express
    <li> Adafruit ItsyBitsy M4 Express
    <li> Adafruit Matrix Portal M4
    <li> Adafruit Metro M0 Express
    <li> Adafruit Metro M4 Airlift Lite
    <li> Adafruit Metro M4 Express
    <li> Adafruit Monster M4SK
    <li> Adafruit PyGamer
    <li> Adafruit PyPortal
    <li> Adafruit PyPortal Pynt
    <li> Adafruit PyPortal Titano
    <li> Adafruit Pybadge
    <li> Adafruit QT Py M0 Haxpress
    <li> Adafruit Trellis M4 Express
    <li> AloriumTech Evo M51
    <li> BDMICRO VINA-D21
    <li> BDMICRO VINA-D51
    <li> CP32-M4
    <li> Capable Robot Programmable USB Hub
    <li> Cedar Grove StringCar M0 Express
    <li> Circuit Playground Express Digi-Key PyCon 2019
    <li> CircuitBrains Basic
    <li> CircuitBrains Deluxe
    <li> DynOSSAT-EDU-EPS
    <li> DynOSSAT-EDU-OBC
    <li> Electronic Cats Hunter Cat NFC
    <li> Hacked Feather M0 Express with 8Mbyte SPI flash
    <li> HalloWing M0 Express
    <li> Mini SAM M4
    <li> PewPew M4
    <li> PyCubedv04
    <li> PyCubedv04-MRAM
    <li> PyCubedv05
    <li> PyCubedv05-MRAM
    <li> Robo HAT MM1 M4
    <li> SAM E54 Xplained Pro
    <li> SAM32v26
    <li> Seeeduino Wio Terminal
    <li> Serpente
    <li> Silicognition LLC M4-Shim
    <li> SparkFun MicroMod SAMD51 Processor
    <li> SparkFun RedBoard Turbo
    <li> SparkFun Thing Plus - SAMD51
    <li> StackRduino M0 PRO
    <li> TG-Boards' Datalore IP M4
    <li> The Open Book Feather
    <li> Trinket M0 Haxpress
    <li> UARTLogger II
    <li> Winterbloom Big Honking Button
    <li> keithp.com snekboard
    <li> uGame10
    </ul>
    </details>
    </p>




.. py:class:: AudioOut(left_channel: microcontroller.Pin, *, right_channel: Optional[microcontroller.Pin] = None, quiescent_value: int = 32768)

   Output an analog audio signal

   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: The pin to output the left channel to
   :param ~microcontroller.Pin right_channel: The pin to output the right channel to
   :param int quiescent_value: The output value when no signal is present. Samples should start
       and end with this value to prevent audible popping.

   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")

   .. py:attribute:: playing
      :annotation: :bool

      True when an audio sample is being output even if `paused`. (read-only)


   .. py:attribute:: paused
      :annotation: :bool

      True when playback is paused. (read-only)


   .. py:method:: deinit() -> None

      Deinitialises the AudioOut and releases any hardware resources for reuse.


   .. py:method:: __enter__() -> AudioOut

      No-op used by Context Managers.


   .. py:method:: __exit__() -> None

      Automatically deinitializes the hardware when exiting a context. See
      :ref:`lifetime-and-contextmanagers` for more info.


   .. py:method:: play(sample: _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.


   .. py:method:: stop() -> None

      Stops playback and resets to the start of the sample.


   .. py:method:: pause() -> None

      Stops playback temporarily while remembering the position. Use `resume` to resume playback.


   .. py:method:: resume() -> None

      Resumes sample playback after :py:func:`pause`.