Use PBD::copy_file in Session::create() to copy the template file.
[ardour.git] / libs / ardour / ardour / buffer.h
index 6604e5533bad1b9a35ccc608cf3d8438b0833ed9..b890afbb03dcf5f5a9e5c618cc0fc082f9f39488 100644 (file)
@@ -1,6 +1,5 @@
 /*
     Copyright (C) 2006 Paul Davis 
-    Written by Dave Robillard, 2006
     
     This program is free software; you can redistribute it and/or modify it
     under the terms of the GNU General Public License as published by the Free
 #ifndef __ardour_buffer_h__
 #define __ardour_buffer_h__
 
-#define _XOPEN_SOURCE 600
-#include <cstdlib> // for posix_memalign
+#include <cstdlib>
 #include <cassert>
+#include <iostream>
 #include <ardour/types.h>
-#include <jack/jack.h>
+#include <ardour/data_type.h>
+#include <ardour/runtime_functions.h>
 
 namespace ARDOUR {
 
 
-/* Yes, this is a bit of a mess right now.  I'll clean it up when everything
- * using it works out.. */
-
-
 /** A buffer of recordable/playable data.
  *
  * This is a datatype-agnostic base class for all buffers (there are no
@@ -45,12 +41,11 @@ namespace ARDOUR {
 class Buffer
 {
 public:
-       Buffer(DataType type, size_t capacity)
-       : _type(type), _capacity(capacity), _size(0) 
-       {}
-
        virtual ~Buffer() {}
 
+       /** Factory function */
+       static Buffer* create(DataType type, size_t capacity);
+
        /** Maximum capacity of buffer.
         * Note in some cases the entire buffer may not contain valid data, use size. */
        size_t capacity() const { return _capacity; }
@@ -60,49 +55,32 @@ public:
 
        /** Type of this buffer.
         * Based on this you can static cast a Buffer* to the desired type. */
-       virtual DataType type() const { return _type; }
-
-       /** Jack type (eg JACK_DEFAULT_AUDIO_TYPE) */
-       const char* jack_type() const { return type_to_jack_type(type()); }
-       
-       /** String type as saved in session XML files (eg "audio" or "midi") */
-       const char* type_string() const { return type_to_string(type()); }
+       DataType type() const { return _type; }
 
-       /* The below static methods need to be separate from the above methods
-        * because the conversion is needed in places where there's no Buffer.
-        * These should probably live somewhere else...
-        */
+       bool silent() const { return _silent; }
 
-       static const char* type_to_jack_type(DataType t) {
-               switch (t) {
-                       case AUDIO: return JACK_DEFAULT_AUDIO_TYPE;
-                       case MIDI:  return JACK_DEFAULT_MIDI_TYPE;
-                       default:    return "";
-               }
-       }
+       /** Clear (eg zero, or empty) buffer starting at TIME @a offset */
+       virtual void silence(nframes_t len, nframes_t offset=0) = 0;
        
-       static const char* type_to_string(DataType t) {
-               switch (t) {
-                       case AUDIO: return "audio";
-                       case MIDI:  return "midi";
-                       default:    return "unknown"; // reeeally shouldn't ever happen
-               }
-       }
+       /** Clear the entire buffer */
+       virtual void clear() { silence(_capacity, 0); }
 
-       /** Used for loading from XML (route default types etc) */
-       static DataType type_from_string(const string& str) {
-               if (str == "audio")
-                       return AUDIO;
-               else if (str == "midi")
-                       return MIDI;
-               else
-                       return NIL;
-       }
+       virtual void read_from(const Buffer& src, nframes_t offset, nframes_t len) = 0;
 
 protected:
+       Buffer(DataType type, size_t capacity)
+       : _type(type), _capacity(capacity), _size(0), _silent(true)
+       {}
+
        DataType _type;
        size_t   _capacity;
        size_t   _size;
+       bool     _silent;
+
+private:
+       // Prevent copies (undefined)
+       Buffer(const Buffer& copy);
+       void operator=(const Buffer& other);
 };
 
 
@@ -113,32 +91,140 @@ protected:
 class AudioBuffer : public Buffer
 {
 public:
-       AudioBuffer(size_t capacity)
-               : Buffer(AUDIO, capacity)
-               , _data(NULL)
+       AudioBuffer(size_t capacity);
+       
+       ~AudioBuffer();
+
+       void silence(nframes_t len, nframes_t offset=0)
+       {
+               if (!_silent) {
+                       assert(_capacity > 0);
+                       assert(offset + len <= _capacity);
+                       memset(_data + offset, 0, sizeof (Sample) * len);
+                       if (offset == 0 && len == _capacity) {
+                               _silent = true;
+                       }
+               }
+       }
+       
+       /** Read @a len frames FROM THE START OF @a src into self at @a offset */
+       void read_from(const Buffer& src, nframes_t len, nframes_t offset)
+       {
+               assert(_capacity > 0);
+               assert(src.type() == _type == DataType::AUDIO);
+               assert(offset + len <= _capacity);
+               memcpy(_data + offset, ((AudioBuffer&)src).data(), sizeof(Sample) * len);
+               _silent = src.silent();
+       }
+       
+       /** Accumulate (add)@a len frames FROM THE START OF @a src into self at @a offset */
+       void accumulate_from(const AudioBuffer& src, nframes_t len, nframes_t offset)
+       {
+               assert(_capacity > 0);
+               assert(offset + len <= _capacity);
+
+               Sample*       const dst_raw = _data + offset;
+               const Sample* const src_raw = src.data();
+
+               for (nframes_t n = 0; n < len; ++n) {
+                       dst_raw[n] += src_raw[n];
+               }
+
+               _silent = (src.silent() && _silent);
+       }
+       
+       /** Accumulate (add) @a len frames FROM THE START OF @a src into self at @a offset
+        * scaling by @a gain_coeff */
+       void accumulate_with_gain_from(const AudioBuffer& src, nframes_t len, nframes_t offset, gain_t gain_coeff)
        {
-               _size = capacity; // For audio buffers, size = capacity (always)
-#ifdef NO_POSIX_MEMALIGN
-               b =  (Sample *) malloc(sizeof(Sample) * capacity);
-#else
-               posix_memalign((void**)_data, 16, sizeof(Sample) * capacity);
-#endif 
-               assert(_data);
-               memset(_data, 0, sizeof(Sample) * capacity);
+               assert(_capacity > 0);
+               assert(offset + len <= _capacity);
+
+               Sample*       const dst_raw = _data + offset;
+               const Sample* const src_raw = src.data();
+
+               mix_buffers_with_gain (dst_raw, src_raw, len, gain_coeff);
+
+               _silent = ( (src.silent() && _silent) || (_silent && gain_coeff == 0) );
+       }
+       
+       void apply_gain(gain_t gain, nframes_t len, nframes_t offset=0) {
+               apply_gain_to_buffer (_data + offset, len, gain);
        }
 
-       const Sample* data() const { return _data; }
-       Sample*       data()       { return _data; }
+       /** Set the data contained by this buffer manually (for setting directly to jack buffer).
+        * 
+        * Constructor MUST have been passed capacity=0 or this will die (to prevent mem leaks).
+        */
+       void set_data(Sample* data, size_t size)
+       {
+               assert(!_owns_data); // prevent leaks
+               _capacity = size;
+               _size = size;
+               _data = data;
+               _silent = false;
+       }
+
+       const Sample* data () const { return _data; }
+       Sample* data () { return _data; }
+
+       const Sample* data(nframes_t nframes, nframes_t offset) const
+               { assert(offset + nframes <= _capacity); return _data + offset; }
+
+       Sample* data (nframes_t nframes, nframes_t offset)
+               { assert(offset + nframes <= _capacity); return _data + offset; }
 
 private:
        // These are undefined (prevent copies)
        AudioBuffer(const AudioBuffer& copy);            
        AudioBuffer& operator=(const AudioBuffer& copy);
 
-       Sample* const _data; ///< Actual buffer contents
+       bool    _owns_data;
+       Sample* _data; ///< Actual buffer contents
 };
 
 
+
+/** Buffer containing 8-bit unsigned char (MIDI) data. */
+class MidiBuffer : public Buffer
+{
+public:
+       MidiBuffer(size_t capacity);
+       
+       ~MidiBuffer();
+
+       void silence(nframes_t dur, nframes_t offset=0);
+       
+       void read_from(const Buffer& src, nframes_t nframes, nframes_t offset);
+
+       bool push_back(const MidiEvent& event);
+       
+       const MidiEvent& operator[](size_t i) const { assert(i < _size); return _events[i]; }
+       MidiEvent& operator[](size_t i) { assert(i < _size); return _events[i]; }
+
+       static size_t max_event_size() { return MAX_EVENT_SIZE; }
+
+       //void set_size(size_t size) { _size = size; }
+
+       //const RawMidi* data() const { return _data; }
+       //RawMidi*       data()       { return _data; }
+
+private:
+       // These are undefined (prevent copies)
+       MidiBuffer(const MidiBuffer& copy);            
+       MidiBuffer& operator=(const MidiBuffer& copy);
+
+       // FIXME: Jack needs to tell us this
+       static const size_t MAX_EVENT_SIZE = 4; // bytes
+       
+       /* We use _size as "number of events", so the size of _data is
+        * (_size * MAX_EVENT_SIZE)
+        */
+
+       MidiEvent* _events;     ///< Event structs that point to offsets in _data
+       RawMidi*   _data;       ///< MIDI, straight up.  No time stamps.
+};
+
 } // namespace ARDOUR
 
 #endif // __ardour_buffer_h__