comparison include/Utilities.h @ 179:f1012082f142

Added audioReadFrame() and audioWriteFrame(). Closes #1519

 
 #if 1
 // Note: pinMode(), analogWrite() and digitalWrite() should be able to be called from setup()
 // Likewise, thread launch should be able to be called from setup()
 // Also, make volume change functions callable from render() thread -- as an aux task?
+
+/**
+ * \brief Read an audio input, specifying the frame number (when to read) and the channel.
+ *
+ * This function returns the value of an audio input, at the time indicated by \c frame.
+ * The returned value ranges from -1 to 1.
+ *
+ * \param context The I/O data structure which is passed by BeagleRT to render().
+ * \param frame Which frame (i.e. what time) to read the audio input. Valid values range
+ * from 0 to (context->audioFrames - 1).
+ * \param channel Which audio input to read. Valid values are between 0 and
+ * (context->audioChannels - 1), typically 0 to 1 by default.
+ * \return Value of the analog input, range  to 1.
+ */
+float audioReadFrame(BeagleRTContext *context, int frame, int channel);
+
+/**
+ * \brief Write an audio output, specifying the frame number (when to write) and the channel.
+ *
+ * This function sets the value of an audio output, at the time indicated by \c frame. Valid
+ * values are between -1 and 1.
+ *
+ * \param context The I/O data structure which is passed by BeagleRT to render().
+ * \param frame Which frame (i.e. what time) to write the audio output. Valid values range
+ * from 0 to (context->audioFrames - 1).
+ * \param channel Which analog output to write. Valid values are between 0 and
+ * (context->audioChannels - 1), typically 0 to 1 by default.
+ * \param value Value to write to the output, range -1 to 1.
+ */
+void audioWriteFrame(BeagleRTContext *context, int frame, int channel, float value);
 
 /**
  * \brief Read an analog input, specifying the frame number (when to read) and the channel.
  *
  * This function returns the value of an analog input, at the time indicated by \c frame.