summaryrefslogtreecommitdiff
path: root/libs
diff options
context:
space:
mode:
authorPaul Davis <paul@linuxaudiosystems.com>2020-05-12 11:31:36 -0600
committerPaul Davis <paul@linuxaudiosystems.com>2020-05-12 11:34:38 -0600
commitaf46adc110cdccec7a8d981e9ab47e9f4ff4085b (patch)
treed9c1b0885a3eaaf7f23a5e63712e9bb72e867127 /libs
parentf5064fa1ca952becd294766f9277c47aa868a205 (diff)
NO-OP: expand comments for DiskReader::audio_read() parameters
Diffstat (limited to 'libs')
-rw-r--r--libs/ardour/disk_reader.cc10
1 files changed, 8 insertions, 2 deletions
diff --git a/libs/ardour/disk_reader.cc b/libs/ardour/disk_reader.cc
index 731655eda7..c4a8717065 100644
--- a/libs/ardour/disk_reader.cc
+++ b/libs/ardour/disk_reader.cc
@@ -951,12 +951,18 @@ swap_by_ptr (Sample* first, Sample* last)
}
/** Read some data for 1 channel from our playlist into a buffer.
- * @param buf Buffer to write to.
+ *
+ * @param sum_buf sample-containing buffer to write to. Must be contiguous.
+ * @param mixdown_buffer sample-containing buffer that will be used to mix layers
+ * @param gain_buffer ptr to a buffer used to hold any necessary gain (automation) data
* @param start Session sample to start reading from; updated to where we end up
- * after the read.
+ * after the read. Global timeline position.
* @param cnt Count of samples to read.
+ * @param rci ptr to ReaderChannelInfo for the channel we're reading
+ * @param channel the number of the channel we're reading (0..N)
* @param reversed true if we are running backwards, otherwise false.
*/
+
samplecnt_t
DiskReader::audio_read (Sample* sum_buffer,
Sample* mixdown_buffer,