namespace ARDOUR {
+/** Buffer containing audio data. */
class AudioBuffer : public Buffer
{
public:
_written = true;
}
- /** Acumulate (add) @a len frames @a src starting at @a src_offset into self starting at @ dst_offset*/
+ /** Acumulate (add) @a len frames @a src starting at @a src_offset into self starting at @a dst_offset */
void merge_from (const Buffer& src, framecnt_t len, framecnt_t dst_offset = 0, framecnt_t src_offset = 0) {
const AudioBuffer* ab = dynamic_cast<const AudioBuffer*>(&src);
assert (ab);
accumulate_from (*ab, len, dst_offset, src_offset);
}
- /** Acumulate (add) @a len frames @a src starting at @a src_offset into self starting at @ dst_offset*/
+ /** Acumulate (add) @a len frames @a src starting at @a src_offset into self starting at @a dst_offset */
void accumulate_from (const AudioBuffer& src, framecnt_t len, framecnt_t dst_offset = 0, framecnt_t src_offset = 0) {
assert(_capacity > 0);
assert(len <= _capacity);
_written = true;
}
- /** Acumulate (add) @a len frames @a src starting at @a src_offset into self starting at @ dst_offset
+ /** Acumulate (add) @a len frames @a src starting at @a src_offset into self starting at @dst_offset
* scaling by @a gain_coeff */
void accumulate_with_gain_from (const AudioBuffer& src, framecnt_t len, gain_t gain_coeff, framecnt_t dst_offset = 0, framecnt_t src_offset = 0) {
class Session;
class Route;
-/* A mixer strip element - plugin, send, meter, etc.
- */
+/** A mixer strip element - plugin, send, meter, etc */
class Processor : public SessionObject, public Automatable, public Latent
{
public:
virtual int set_block_size (pframes_t /*nframes*/) { return 0; }
virtual bool requires_fixed_sized_buffers() const { return false; }
- /** @param result_required true if, on return from this method, bufs is required to contain valid data;
- * if false, the method need not bother writing to bufs if it doesn't want to.
+ /** @param result_required true if, on return from this method, @a bufs is required to contain valid data;
+ * if false, the method need not bother writing to @a bufs if it doesn't want to.
*/
virtual void run (BufferSet& /*bufs*/, framepos_t /*start_frame*/, framepos_t /*end_frame*/, pframes_t /*nframes*/, bool /*result_required*/) {}
virtual void silence (framecnt_t /*nframes*/) {}
ChanCount _configured_input;
ChanCount _configured_output;
bool _display_to_user;
- bool _pre_fader;
+ bool _pre_fader; ///< true if this processor is currently placed before the Amp, otherwise false
void* _ui_pointer;
};
return 0;
}
-/** Caller must hold process lock */
+/** @pre Caller must hold process lock */
bool
Processor::configure_io (ChanCount in, ChanCount out)
{