buffer.h

Go to the documentation of this file.

/*
    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 <stddef.h>

#include <boost/utility.hpp>

#include "ardour/libardour_visibility.h"
#include "ardour/types.h"
#include "ardour/data_type.h"

namespace ARDOUR {


class LIBARDOUR_API Buffer : public boost::noncopyable
{
public:
        virtual ~Buffer() {}

        static Buffer* create(DataType type, size_t capacity);

        size_t capacity() const { return _capacity; }

        DataType type() const { return _type; }

        bool silent() const { return _silent; }

        virtual void resize (size_t) = 0;

        virtual void silence (framecnt_t len, framecnt_t offset = 0) = 0;

        virtual void clear() { silence(_capacity, 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)
                : _type(type), _capacity(0), _silent (true)
        {}

        DataType  _type;
        pframes_t _capacity;
        bool      _silent;
};


} // namespace ARDOUR

#endif // __ardour_buffer_h__