eteroj-lv2/eteroj.lv2-0.10.0/eteroj_ninja.c

/*
 * Copyright (c) 2016-2021 Hanspeter Portner (dev@open-music-kontrollers.ch)
 *
 * This is free software: you can redistribute it and/or modify
 * it under the terms of the Artistic License 2.0 as published by
 * The Perl Foundation.
 *
 * This source 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
 * Artistic License 2.0 for more details.
 *
 * You should have received a copy of the Artistic License 2.0
 * along the source as a COPYING file. If not, obtain it from
 * http://www.perlfoundation.org/artistic_license_2_0.
 */

#include <stdio.h>
#include <stdlib.h>

#include <eteroj.h>
#include <varchunk.h>
#include <osc.lv2/util.h>
#include <osc.lv2/forge.h>
#include <props.h>

#define NETATOM_IMPLEMENTATION
#include <netatom.lv2/netatom.h>

#define NS_RDF "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
#define BUF_SIZE 8192

#define MAX_NPROPS 1

typedef struct _atom_ser_t atom_ser_t;
typedef struct _plughandle_t plughandle_t;
typedef struct _plugstate_t plugstate_t;

struct _atom_ser_t {
	uint32_t size;
	uint8_t *buf;
	uint32_t offset;
};

struct _plugstate_t {
	int32_t synchronous;
};

struct _plughandle_t {
	LV2_URID_Map *map;
	LV2_URID_Unmap *unmap;
	LV2_Worker_Schedule *sched;
	LV2_Log_Log *log;
	LV2_Log_Logger logger;

	atom_ser_t ser;

	const LV2_Atom_Sequence *event_in;
	LV2_Atom_Sequence *event_out;
	LV2_Atom_Forge forge;
	LV2_OSC_URID osc_urid;

	struct {
		LV2_Atom_Forge *forge;
		LV2_Atom_Forge_Ref *ref;
		int64_t frames;
	} unroll;

	netatom_t *netatom;

	varchunk_t *to_worker;
	varchunk_t *from_worker;

	PROPS_T(props, MAX_NPROPS);
	plugstate_t state;
	plugstate_t stash;

	uint8_t buf [BUF_SIZE];
};

static const char *base_path = "/ninja";

static inline LV2_Atom_Forge_Ref
_sink(LV2_Atom_Forge_Sink_Handle handle, const void *buf, uint32_t size)
{
	atom_ser_t *ser = handle;

	const LV2_Atom_Forge_Ref ref = ser->offset + 1;

	const uint32_t new_offset = ser->offset + size;
	if(new_offset > ser->size)
	{
		uint32_t new_size = ser->size << 1;
		while(new_offset > new_size)
			new_size <<= 1;

		if(!(ser->buf = realloc(ser->buf, new_size)))
			return 0; // realloc failed

		ser->size = new_size;
	}

	memcpy(ser->buf + ser->offset, buf, size);
	ser->offset = new_offset;

	return ref;
}

static inline LV2_Atom *
_deref(LV2_Atom_Forge_Sink_Handle handle, LV2_Atom_Forge_Ref ref)
{
	atom_ser_t *ser = handle;

	const uint32_t offset = ref - 1;

	return (LV2_Atom *)(ser->buf + offset);
}

static const props_def_t defs [MAX_NPROPS] = {
	{
		.property = ETEROJ_URI"#ninja_synchronous",
		.offset = offsetof(plugstate_t, synchronous),
		.type = LV2_ATOM__Bool
	}
};

static LV2_Handle
instantiate(const LV2_Descriptor* descriptor, double rate,
	const char *bundle_path, const LV2_Feature *const *features)
{
	plughandle_t *handle = calloc(1, sizeof(plughandle_t));
	if(!handle)
		return NULL;
	mlock(handle, sizeof(plughandle_t));

	for(unsigned i=0; features[i]; i++)
	{
		if(!strcmp(features[i]->URI, LV2_URID__map))
			handle->map = features[i]->data;
		else if(!strcmp(features[i]->URI, LV2_URID__unmap))
			handle->unmap = features[i]->data;
		else if(!strcmp(features[i]->URI, LV2_WORKER__schedule))
			handle->sched= features[i]->data;
		else if(!strcmp(features[i]->URI, LV2_LOG__log))
			handle->log = features[i]->data;
	}

	if(!handle->map)
	{
		fprintf(stderr, "%s: Host does not support urid:map\n", descriptor->URI);
		free(handle);
		return NULL;
	}
	if(!handle->unmap)
	{
		fprintf(stderr, "%s: Host does not support urid:unmap\n", descriptor->URI);
		free(handle);
		return NULL;
	}
	if(!handle->sched)
	{
		fprintf(stderr, "%s: Host does not support work:schedule\n", descriptor->URI);
		free(handle);
		return NULL;
	}

	lv2_atom_forge_init(&handle->forge, handle->map);
	lv2_osc_urid_init(&handle->osc_urid, handle->map);

	if(handle->log)
	{
		lv2_log_logger_init(&handle->logger, handle->map, handle->log);
	}

	if(!props_init(&handle->props, descriptor->URI,
		defs, MAX_NPROPS, &handle->state, &handle->stash,
		handle->map, handle))
	{
		free(handle);
		return NULL;
	}

	handle->netatom= netatom_new(handle->map, handle->unmap, true);
	if(!handle->netatom)
	{
		netatom_free(handle->netatom);
		free(handle);
		return NULL;
	}

	handle->to_worker = varchunk_new(BUF_SIZE, true);
	handle->from_worker = varchunk_new(BUF_SIZE, true);

	if(!handle->to_worker || !handle->from_worker)
	{
		free(handle);
		return NULL;
	}

	handle->ser.size = 2018;
	handle->ser.offset = 0;
	handle->ser.buf = malloc(handle->ser.size); //TODO check

	return handle;
}

static void
connect_port(LV2_Handle instance, uint32_t port, void *data)
{
	plughandle_t *handle = (plughandle_t *)instance;

	switch(port)
	{
		case 0:
			handle->event_in = (const LV2_Atom_Sequence *)data;
			break;
		case 1:
			handle->event_out = (LV2_Atom_Sequence *)data;
			break;
		default:
			break;
	}
}

static void
_unroll(const char *path, const LV2_Atom_Tuple *arguments, void *data)
{
	plughandle_t *handle = data;
	LV2_Atom_Forge *forge = handle->unroll.forge;

	if(strcmp(path, base_path))
		return;

	const LV2_Atom *itr = lv2_atom_tuple_begin(arguments);
	if(itr->type != forge->Chunk)
		return;

	memcpy(handle->buf, LV2_ATOM_BODY(itr), itr->size);

	const LV2_Atom *atom = netatom_deserialize(handle->netatom,
		handle->buf, itr->size);
	if(atom)
	{
		if(*handle->unroll.ref)
			*handle->unroll.ref = lv2_atom_forge_frame_time(forge, handle->unroll.frames);
		if(*handle->unroll.ref)
			*handle->unroll.ref = lv2_atom_forge_write(forge, atom, lv2_atom_total_size(atom));
	}
	else if(handle->log)
	{
		lv2_log_trace(&handle->logger, "%s: failed to deserialize\n", __func__);
	}
}

static void
_convert_seq(plughandle_t *handle, LV2_Atom_Forge *forge, const LV2_Atom_Sequence *seq,
	LV2_Atom_Forge_Ref *ref)
{
	LV2_OSC_URID *osc_urid = &handle->osc_urid;

	LV2_ATOM_SEQUENCE_FOREACH(seq, ev)
	{
		const LV2_Atom *atom = &ev->body;
		const LV2_Atom_Object *obj = (const LV2_Atom_Object *)&ev->body;

		if(lv2_osc_is_message_or_bundle_type(osc_urid, obj->body.otype))
		{
			handle->unroll.frames = ev->time.frames;
			handle->unroll.ref = ref;
			handle->unroll.forge = forge;

			lv2_osc_unroll(osc_urid, obj, _unroll, handle);
		}
		else
		{
			memcpy(handle->buf, atom, lv2_atom_total_size(atom)); //FIXME check < BUF_SIZE

			size_t sz;
			const uint8_t *buf = netatom_serialize(handle->netatom, (LV2_Atom *)handle->buf, BUF_SIZE, &sz);
			if(buf)
			{
				if(*ref)
					*ref = lv2_atom_forge_frame_time(forge, ev->time.frames);
				if(*ref)
					*ref = lv2_osc_forge_message_vararg(forge, osc_urid, base_path, "b", sz, buf);
			}
			else if(handle->log)
			{
				lv2_log_trace(&handle->logger, "%s: failed to serialize\n", __func__);
			}
		}
	}
}

static void
run(LV2_Handle instance, uint32_t nsamples)
{
	plughandle_t *handle = (plughandle_t *)instance;

	// prepare osc atom forge
	const uint32_t capacity = handle->event_out->atom.size;
	lv2_atom_forge_set_buffer(&handle->forge, (uint8_t *)handle->event_out, capacity);
	LV2_Atom_Forge_Frame frame;
	LV2_Atom_Forge_Ref ref = lv2_atom_forge_sequence_head(&handle->forge, &frame, 0);

	props_idle(&handle->props, &handle->forge, 0, &ref);

	LV2_ATOM_SEQUENCE_FOREACH(handle->event_in, ev)
	{
		const LV2_Atom_Object *obj = (const LV2_Atom_Object *)&ev->body;

		props_advance(&handle->props, &handle->forge, 0, obj, &ref); //NOTE 0!
	}

	if(handle->state.synchronous)
	{
		_convert_seq(handle, &handle->forge, handle->event_in, &ref);
	}
	else // asynchronous
	{
		// move input events to worker thread
		if(handle->event_in->atom.size > sizeof(LV2_Atom_Sequence_Body))
		{
			const size_t size = lv2_atom_total_size(&handle->event_in->atom);
			LV2_Atom_Sequence *seq;
			if((seq = varchunk_write_request(handle->to_worker, size)))
			{
				memcpy(seq, handle->event_in, size);
				varchunk_write_advance(handle->to_worker, size);

				const int32_t dummy;
				handle->sched->schedule_work(handle->sched->handle, sizeof(int32_t), &dummy);
			}
			else if(handle->log)
			{
				lv2_log_trace(&handle->logger, "%s: ringbuffer overflow\n", __func__);
			}
		}

		{
			// move output events from worker thread
			size_t size;
			const LV2_Atom_Sequence *seq;
			if((seq = varchunk_read_request(handle->from_worker, &size)))
			{
				LV2_ATOM_SEQUENCE_FOREACH(seq, ev)
				{
					if(ref)
						ref = lv2_atom_forge_frame_time(&handle->forge, ev->time.frames);
					if(ref)
						ref = lv2_atom_forge_write(&handle->forge, &ev->body, lv2_atom_total_size(&ev->body));
				}
				varchunk_read_advance(handle->from_worker);
			}
		}
	}

	if(ref)
		lv2_atom_forge_pop(&handle->forge, &frame);
	else
		lv2_atom_sequence_clear(handle->event_out);
}

static void
cleanup(LV2_Handle instance)
{
	plughandle_t *handle = (plughandle_t *)instance;

	if(handle->ser.buf)
		free(handle->ser.buf);
	if(handle->to_worker)
		varchunk_free(handle->to_worker);
	if(handle->from_worker)
		varchunk_free(handle->from_worker);
	netatom_free(handle->netatom);
	munlock(handle, sizeof(plughandle_t));
	free(handle);
}

// non-rt thread
static LV2_Worker_Status
_work(LV2_Handle instance,
	LV2_Worker_Respond_Function respond,
	LV2_Worker_Respond_Handle target,
	uint32_t size,
	const void *body)
{
	plughandle_t *handle = instance;
	LV2_Atom_Forge forge = handle->forge; // clone forge
	LV2_OSC_URID *osc_urid = &handle->osc_urid;

	(void)respond;
	(void)target;
	(void)size;
	(void)body;

	size_t _size;
	const LV2_Atom_Sequence *seq;
	while((seq = varchunk_read_request(handle->to_worker, &_size)))
	{
		handle->ser.offset = 0;
		lv2_atom_forge_set_sink(&forge, _sink, _deref, &handle->ser);
		LV2_Atom_Forge_Frame frame;
		LV2_Atom_Forge_Ref ref = lv2_atom_forge_sequence_head(&forge, &frame, 0);

		_convert_seq(handle, &forge, seq, &ref);

		if(ref)
		{
			lv2_atom_forge_pop(&forge, &frame);
		}
		else if(handle->log)
		{
			lv2_log_trace(&handle->logger, "%s: failed to forge\n", __func__);
		}

		seq = (const LV2_Atom_Sequence *)handle->ser.buf;
		if(seq->atom.size > sizeof(LV2_Atom_Sequence_Body))
		{
			const size_t len = lv2_atom_total_size(&seq->atom);
			LV2_Atom_Sequence *dst;
			if((dst = varchunk_write_request(handle->from_worker, len)))
			{
				memcpy(dst, seq, len);
				varchunk_write_advance(handle->from_worker, len);
			}
			else if(handle->log)
			{
				lv2_log_trace(&handle->logger, "%s: ringbuffer overflow\n", __func__);
			}
		}

		varchunk_read_advance(handle->to_worker);
	}

	return LV2_WORKER_SUCCESS;
}

// rt-thread
static LV2_Worker_Status
_work_response(LV2_Handle instance, uint32_t size, const void *body)
{
	// do nothing

	return LV2_WORKER_SUCCESS;
}

// rt-thread
static LV2_Worker_Status
_end_run(LV2_Handle instance)
{
	// do nothing

	return LV2_WORKER_SUCCESS;
}

static const LV2_Worker_Interface work_iface = {
	.work = _work,
	.work_response = _work_response,
	.end_run = _end_run
};

static LV2_State_Status
_state_save(LV2_Handle instance, LV2_State_Store_Function store,
	LV2_State_Handle state, uint32_t flags,
	const LV2_Feature *const *features)
{
	plughandle_t *handle = (plughandle_t *)instance;

	return props_save(&handle->props, store, state, flags, features);
}

static LV2_State_Status
_state_restore(LV2_Handle instance, LV2_State_Retrieve_Function retrieve,
	LV2_State_Handle state, uint32_t flags,
	const LV2_Feature *const *features)
{
	plughandle_t *handle = (plughandle_t *)instance;

	return props_restore(&handle->props, retrieve, state, flags, features);
}

static const LV2_State_Interface state_iface = {
	.save = _state_save,
	.restore = _state_restore
};

static const void*
extension_data(const char* uri)
{
	if(!strcmp(uri, LV2_WORKER__interface))
		return &work_iface;
	else if(!strcmp(uri, LV2_STATE__interface))
		return &state_iface;

	return NULL;
}

const LV2_Descriptor eteroj_ninja = {
	.URI						= ETEROJ_NINJA_URI,
	.instantiate		= instantiate,
	.connect_port		= connect_port,
	.activate				= NULL,
	.run						= run,
	.deactivate			= NULL,
	.cleanup				= cleanup,
	.extension_data	= extension_data
};