lv_buffer.h

/* Libvisual - The audio visualisation framework.
 *
 * Copyright (C) 2012      Libvisual team
 *               2004-2006 Dennis Smit
 *
 * Authors: Chong Kai Xiong <kaixiong@codeleft.sg>
 *          Dennis Smit <ds@nerds-incorporated.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1
 * 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

#ifndef _LV_BUFFER_H
#define _LV_BUFFER_H

#include <libvisual/lvconfig.h>
#include <libvisual/lv_defines.h>
#include <libvisual/lv_types.h>

#ifdef __cplusplus

#include <libvisual/lv_intrusive_ptr.hpp>
#include <memory>
#include <cstdlib>

namespace LV {

  class Buffer;

  typedef IntrusivePtr<Buffer> BufferPtr;
  typedef IntrusivePtr<Buffer const> BufferConstPtr;

  class LV_API Buffer
  {
  public:

      Buffer (Buffer const&) = delete;

      Buffer& operator= (Buffer const&) = delete;

      static BufferPtr create ();

      static BufferPtr wrap (void *data, std::size_t size, bool own = true);

      static BufferPtr create (std::size_t size);

      ~Buffer ();

      void destroy_content ();

      void set (void* data, std::size_t size);

      void set_size (std::size_t size);

      void set_data (void* data);

      void allocate (std::size_t size);

      void* get_data () const;

      void* get_data (std::size_t offset) const;

      std::size_t get_size () const;

      bool is_allocated () const;

      void copy (BufferConstPtr const& src);

      void copy_to (BufferPtr const& dest);

      void copy_to (void *dest, std::size_t size);

      void put (BufferConstPtr const& src, std::size_t offset);

      void put (void const* data, std::size_t size, std::size_t offset);

      void fill (uint8_t value);

      void fill_with_pattern (void const* data, std::size_t size);

  private:

      friend void intrusive_ptr_add_ref (Buffer const* buffer);
      friend void intrusive_ptr_release (Buffer const* buffer);

      class Impl;
      const std::unique_ptr<Impl> m_impl;

      mutable unsigned int m_ref_count;

      Buffer ();
  };

  inline void intrusive_ptr_add_ref (Buffer const* buffer)
  {
      buffer->m_ref_count++;
  }

  inline void intrusive_ptr_release (Buffer const* buffer)
  {
      if (--buffer->m_ref_count == 0) {
          delete buffer;
      }
  }

} // LV namespace

#endif /* __cplusplus */

#ifdef __cplusplus
typedef LV::Buffer VisBuffer;
#else
typedef struct _VisBuffer VisBuffer;
struct _VisBuffer;
#endif

LV_BEGIN_DECLS

LV_API VisBuffer *visual_buffer_new (void);
LV_API VisBuffer *visual_buffer_new_wrap_data (void *data, visual_size_t size, int own);
LV_API VisBuffer *visual_buffer_new_allocate  (visual_size_t size);
LV_API VisBuffer *visual_buffer_clone (VisBuffer *source);

LV_API void  visual_buffer_set_data_pair (VisBuffer *buffer, void *data, visual_size_t size);
LV_API void  visual_buffer_set_data (VisBuffer *buffer, void *data);
LV_API void *visual_buffer_get_data (VisBuffer *buffer);
LV_API void *visual_buffer_get_data_offset (VisBuffer *buffer, visual_size_t offset);

LV_API void          visual_buffer_set_size (VisBuffer *buffer, visual_size_t size);
LV_API visual_size_t visual_buffer_get_size (VisBuffer *buffer);

LV_API int  visual_buffer_is_allocated    (VisBuffer *buffer);
LV_API void visual_buffer_allocate        (VisBuffer *buffer, visual_size_t size);
LV_API void visual_buffer_destroy_content (VisBuffer *buffer);

LV_API void visual_buffer_copy_to (VisBuffer *src, VisBuffer *dest);
LV_API void visual_buffer_copy_to_data (VisBuffer *src, void *dest, visual_size_t size);

LV_API void visual_buffer_put      (VisBuffer *dest, VisBuffer *src, visual_size_t offset);
LV_API void visual_buffer_put_data (VisBuffer *dest, const void *data, visual_size_t size, visual_size_t offset);

LV_API void visual_buffer_fill (VisBuffer *buffer, uint8_t value);
LV_API void visual_buffer_fill_with_pattern (VisBuffer *buffer, const void *data, visual_size_t size);

LV_API void visual_buffer_ref   (VisBuffer *buffer);
LV_API void visual_buffer_unref (VisBuffer *buffer);

LV_END_DECLS

#endif /* _LV_BUFFER_H */