lv2_evbuf.h

Go to the documentation of this file.

/*
  Copyright 2008-2012 David Robillard <http://drobilla.net>

  Permission to use, copy, modify, and/or distribute this software for any
  purpose with or without fee is hereby granted, provided that the above
  copyright notice and this permission notice appear in all copies.

  THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/

#ifndef LV2_EVBUF_H
#define LV2_EVBUF_H

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#else
#include <stdbool.h>
#endif

typedef enum {
        LV2_EVBUF_EVENT,

        LV2_EVBUF_ATOM
} LV2_Evbuf_Type;

typedef struct LV2_Evbuf_Impl LV2_Evbuf;

typedef struct {
        LV2_Evbuf* evbuf;
        uint32_t   offset;
} LV2_Evbuf_Iterator;

LV2_Evbuf*
lv2_evbuf_new(uint32_t       capacity,
              LV2_Evbuf_Type type,
              uint32_t       atom_Chunk,
              uint32_t       atom_Sequence);

void
lv2_evbuf_free(LV2_Evbuf* evbuf);

void
lv2_evbuf_set_type(LV2_Evbuf* evbuf, LV2_Evbuf_Type type);

void
lv2_evbuf_reset(LV2_Evbuf* evbuf, bool input);

uint32_t
lv2_evbuf_get_size(LV2_Evbuf* evbuf);

uint32_t
lv2_evbuf_get_capacity(LV2_Evbuf* evbuf);

void*
lv2_evbuf_get_buffer(LV2_Evbuf* evbuf);

LV2_Evbuf_Iterator
lv2_evbuf_begin(LV2_Evbuf* evbuf);

LV2_Evbuf_Iterator
lv2_evbuf_end(LV2_Evbuf* evbuf);

bool
lv2_evbuf_is_valid(LV2_Evbuf_Iterator iter);

LV2_Evbuf_Iterator
lv2_evbuf_next(LV2_Evbuf_Iterator iter);

bool
lv2_evbuf_get(LV2_Evbuf_Iterator iter,
              uint32_t*          frames,
              uint32_t*          subframes,
              uint32_t*          type,
              uint32_t*          size,
              uint8_t**          data);

bool
lv2_evbuf_write(LV2_Evbuf_Iterator* iter,
                uint32_t            frames,
                uint32_t            subframes,
                uint32_t            type,
                uint32_t            size,
                const uint8_t*      data);

#ifdef __cplusplus
}
#endif

#endif /* LV2_EVBUF_H */