ns/lv2core/lv2.h

Go to the documentation of this file.

/*
  LV2 - An audio plugin interface specification.
  Copyright 2006-2011 Steve Harris, David Robillard.

  Based on LADSPA, Copyright 2000-2002 Richard W.E. Furse,
  Paul Barton-Davis, Stefan Westerfeld.
 
  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_H_INCLUDED
#define LV2_H_INCLUDED

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef void * LV2_Handle;

typedef struct _LV2_Feature {
    const char * URI;

    void * data;
} LV2_Feature;

typedef struct _LV2_Descriptor {
    const char * URI;

    LV2_Handle (*instantiate)(const struct _LV2_Descriptor * descriptor,
                              double                         sample_rate,
                              const char *                   bundle_path,
                              const LV2_Feature *const *     features);

    void (*connect_port)(LV2_Handle instance,
                         uint32_t   port,
                         void *     data_location);

    void (*activate)(LV2_Handle instance);

    void (*run)(LV2_Handle instance,
                uint32_t   sample_count);

    void (*deactivate)(LV2_Handle instance);

    void (*cleanup)(LV2_Handle instance);

    const void * (*extension_data)(const char * uri);
} LV2_Descriptor;

const LV2_Descriptor * lv2_descriptor(uint32_t index);

typedef const LV2_Descriptor *
(*LV2_Descriptor_Function)(uint32_t index);

#ifdef WIN32
#define LV2_SYMBOL_EXPORT __declspec(dllexport)
#else
#define LV2_SYMBOL_EXPORT
#endif

#ifdef __cplusplus
}
#endif

#endif /* LV2_H_INCLUDED */