Set tempo sections to the exact pulse when snapped to a musical grid.
[ardour.git] / libs / ardour / ardour / buffer.h
index fd943602262572704cfde72ba156a3200b8c75b6..8293a22beb5dc475621c6095d3d970a735143558 100644 (file)
@@ -1,16 +1,16 @@
 /*
-    Copyright (C) 2006 Paul Davis 
-    
+    Copyright (C) 2006 Paul Davis
+
     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
     Software Foundation; either version 2 of the License, or (at your option)
     any later version.
-    
+
     This program is distributed in the hope that it will be useful, but WITHOUT
     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
     for more details.
-    
+
     You should have received a copy of the GNU General Public License along
     with this program; if not, write to the Free Software Foundation, Inc.,
     675 Mass Ave, Cambridge, MA 02139, USA.
 #ifndef __ardour_buffer_h__
 #define __ardour_buffer_h__
 
-#include <cstdlib>
-#include <cassert>
-#include <iostream>
+#include <stddef.h>
+
 #include <boost/utility.hpp>
-#include <ardour/types.h>
-#include <ardour/data_type.h>
-#include <ardour/runtime_functions.h>
+
+#include "ardour/libardour_visibility.h"
+#include "ardour/types.h"
+#include "ardour/data_type.h"
 
 namespace ARDOUR {
 
@@ -36,10 +36,10 @@ namespace ARDOUR {
  * methods to actually access the data).  This provides a way for code that
  * doesn't care about the data type to still deal with buffers (which is
  * why the base class can't be a template).
- * 
+ *
  * To actually read/write buffer contents, use the appropriate derived class.
  */
-class Buffer : public boost::noncopyable
+class LIBARDOUR_API Buffer : public boost::noncopyable
 {
 public:
        virtual ~Buffer() {}
@@ -47,43 +47,39 @@ public:
        /** 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. */
+       /** Maximum capacity of buffer. */
        size_t capacity() const { return _capacity; }
 
-       /** Amount of valid data in buffer.  Use this over capacity almost always. */
-       size_t size() const { return _size; }
-
        /** Type of this buffer.
         * Based on this you can static cast a Buffer* to the desired type. */
        DataType type() const { return _type; }
 
        bool silent() const { return _silent; }
-       
+
        /** Reallocate the buffer used internally to handle at least @a size_t units of data.
         *
         * The buffer is not silent after this operation. the @a capacity argument
         * passed to the constructor must have been non-zero.
         */
-       virtual void resize(size_t) = 0;
+       virtual void resize (size_t) = 0;
+
+       /** Clear (eg zero, or empty) buffer */
+       virtual void silence (framecnt_t len, framecnt_t offset = 0) = 0;
 
-       /** Clear (eg zero, or empty) buffer starting at TIME @a offset */
-       virtual void silence(nframes_t len, nframes_t offset=0) = 0;
-       
        /** Clear the entire buffer */
        virtual void clear() { silence(_capacity, 0); }
 
-       virtual void read_from(const Buffer& src, nframes_t offset, nframes_t len) = 0;
+       virtual void read_from (const Buffer& src, framecnt_t len, framecnt_t dst_offset = 0, framecnt_t src_offset = 0) = 0;
+       virtual void merge_from (const Buffer& src, framecnt_t len, framecnt_t dst_offset = 0, framecnt_t src_offset = 0) = 0;
 
-protected:
-       Buffer(DataType type, size_t capacity)
-       : _type(type), _capacity(capacity), _size(0), _silent(true)
+  protected:
+       Buffer(DataType type)
+               : _type(type), _capacity(0), _silent (true)
        {}
 
-       DataType _type;
-       size_t   _capacity;
-       size_t   _size;
-       bool     _silent;
+       DataType  _type;
+       pframes_t _capacity;
+       bool      _silent;
 };