c6ef09cbe2125257a6dc07c004b9402f11b750fd
[goodguy/cinelerra.git] / cinelerra-5.1 / cinelerra / pluginlv2.C
1 #ifdef HAVE_LV2
2
3 #include "bctrace.h"
4 #include "bcwindowbase.h"
5 #include "pluginlv2.h"
6 #include "samples.h"
7
8 #include <sys/shm.h>
9 #include <sys/mman.h>
10
11 PluginLV2::PluginLV2()
12 {
13         shm_bfr = 0;
14         use_shm = 1;
15         shmid = -1;
16         in_buffers = 0;   iport = 0;
17         out_buffers = 0;  oport = 0;
18         nb_inputs = 0;
19         nb_outputs = 0;
20         max_bufsz = 0;
21         ui_features = 0;
22
23         samplerate = 44100;
24         refreshrate = 30.;
25         min_block_length = 1;
26         block_length = 4096;
27         midi_buf_size = 8192;
28
29         world = 0;
30         lilv = 0;
31         lilv_uis = 0;
32         inst = 0;
33         sinst = 0;
34         ui_host = 0;
35
36         lv2_InputPort = 0;
37         lv2_OutputPort = 0;
38         lv2_AudioPort = 0;
39         lv2_ControlPort = 0;
40         lv2_CVPort = 0;
41         lv2_Optional = 0;
42         atom_AtomPort = 0;
43         atom_Sequence = 0;
44         powerOf2BlockLength = 0;
45         fixedBlockLength = 0;
46         boundedBlockLength = 0;
47         seq_out = 0;
48
49         worker_thread = 0;
50         memset(&schedule, 0, sizeof(schedule));
51         schedule.handle = (LV2_Worker_Schedule_Handle)this;
52         schedule.schedule_work = lv2_worker_schedule;
53         worker_iface = 0;  worker_done = -1;
54         pthread_mutex_init(&worker_lock, 0);
55         pthread_mutex_init(&startup_lock, 0);
56         pthread_mutex_lock(&startup_lock);
57         pthread_cond_init(&worker_ready, 0);
58         work_avail = 0;   work_input = 0;
59         work_output = 0;  work_tail = &work_output;
60 }
61
62 PluginLV2::~PluginLV2()
63 {
64         reset_lv2();
65         if( world )     lilv_world_free(world);
66         pthread_mutex_destroy(&worker_lock);
67         pthread_cond_destroy(&worker_ready);
68 }
69
70 void PluginLV2::reset_lv2()
71 {
72         worker_stop();
73         if( inst ) lilv_instance_deactivate(inst);
74         lilv_instance_free(inst);             inst = 0;
75         lilv_uis_free(lilv_uis);              lilv_uis = 0;
76
77         lilv_node_free(lv2_InputPort);        lv2_InputPort = 0;
78         lilv_node_free(lv2_OutputPort);       lv2_OutputPort = 0;
79         lilv_node_free(lv2_AudioPort);        lv2_AudioPort = 0;
80         lilv_node_free(lv2_ControlPort);      lv2_ControlPort = 0;
81         lilv_node_free(lv2_CVPort);           lv2_CVPort = 0;
82
83         lilv_node_free(lv2_Optional);         lv2_Optional = 0;
84         lilv_node_free(atom_AtomPort);        atom_AtomPort = 0;
85         lilv_node_free(atom_Sequence);        atom_Sequence = 0;
86         lilv_node_free(boundedBlockLength);   boundedBlockLength = 0;
87         lilv_node_free(fixedBlockLength);     fixedBlockLength = 0;
88         lilv_node_free(powerOf2BlockLength);  powerOf2BlockLength = 0;
89
90         delete [] (char *)seq_out;            seq_out = 0;
91         uri_table.remove_all_objects();
92         features.remove_all_objects();        ui_features = 0;
93         del_buffer();
94 }
95
96
97 int PluginLV2::load_lv2(const char *path, char *title)
98 {
99         if( !world ) {
100                 world = lilv_world_new();
101                 if( !world ) {
102                         printf("lv2: lilv_world_new failed\n");
103                         return 1;
104                 }
105                 lilv_world_load_all(world);
106         }
107
108         LilvNode *uri = lilv_new_uri(world, path);
109         if( !uri ) {
110                 printf("lv2: lilv_new_uri(%s) failed\n", path);
111                 return 1;
112         }
113
114         const LilvPlugins *all_plugins = lilv_world_get_all_plugins(world);
115         lilv = lilv_plugins_get_by_uri(all_plugins, uri);
116         lilv_node_free(uri);
117         if( !lilv ) {
118                 printf("lv2: lilv_plugins_get_by_uri (%s) failed\n", path);
119                 return 1;
120         }
121
122         if( title ) {
123                 LilvNode *name = lilv_plugin_get_name(lilv);
124                 const char *nm = lilv_node_as_string(name);
125                 sprintf(title, "L2_%s", nm);
126                 lilv_node_free(name);
127         }
128         return 0;
129 }
130
131 int PluginLV2::init_lv2(PluginLV2ClientConfig &conf, int sample_rate, int bfrsz)
132 {
133         reset_lv2();
134         double bps = 2. * sample_rate / bfrsz;
135         if( bps > refreshrate ) refreshrate = bps;
136
137         lv2_AudioPort       = lilv_new_uri(world, LV2_CORE__AudioPort);
138         lv2_ControlPort     = lilv_new_uri(world, LV2_CORE__ControlPort);
139         lv2_CVPort          = lilv_new_uri(world, LV2_CORE__CVPort);
140         lv2_InputPort       = lilv_new_uri(world, LV2_CORE__InputPort);
141         lv2_OutputPort      = lilv_new_uri(world, LV2_CORE__OutputPort);
142         lv2_Optional        = lilv_new_uri(world, LV2_CORE__connectionOptional);
143         atom_AtomPort       = lilv_new_uri(world, LV2_ATOM__AtomPort);
144         atom_Sequence       = lilv_new_uri(world, LV2_ATOM__Sequence);
145         powerOf2BlockLength = lilv_new_uri(world, LV2_BUF_SIZE__powerOf2BlockLength);
146         fixedBlockLength    = lilv_new_uri(world, LV2_BUF_SIZE__fixedBlockLength);
147         boundedBlockLength  = lilv_new_uri(world, LV2_BUF_SIZE__boundedBlockLength);
148         seq_out = (LV2_Atom_Sequence *) new char[sizeof(LV2_Atom_Sequence) + LV2_SEQ_SIZE];
149
150         conf.init_lv2(lilv, this);
151         nb_inputs = nb_outputs = 0;
152
153         for( int i=0; i<conf.nb_ports; ++i ) {
154                 const LilvPort *lp = lilv_plugin_get_port_by_index(lilv, i);
155                 if( !lp ) continue;
156                 int is_input = lilv_port_is_a(lilv, lp, lv2_InputPort);
157                 if( !is_input && !lilv_port_is_a(lilv, lp, lv2_OutputPort) &&
158                     !lilv_port_has_property(lilv, lp, lv2_Optional) ) {
159                         printf("lv2: not input, not output, and not optional: %s\n", conf.names[i]);
160                         continue;
161                 }
162                 if( is_input && lilv_port_is_a(lilv, lp, lv2_ControlPort) ) {
163                         conf.append(new PluginLV2Client_Opt(&conf, i));
164                         continue;
165                 }
166                 if( lilv_port_is_a(lilv, lp, lv2_AudioPort) ||
167                     lilv_port_is_a(lilv, lp, lv2_CVPort ) ) {
168                         if( is_input ) ++nb_inputs; else ++nb_outputs;
169                         continue;
170                 }
171         }
172
173         uri_map.handle = (LV2_URID_Map_Handle)this;
174         uri_map.map = map_uri;
175         features.append(new Lv2Feature(LV2_URID__map, &uri_map));
176         uri_unmap.handle = (LV2_URID_Unmap_Handle)this;
177         uri_unmap.unmap = unmap_uri;
178         features.append(new Lv2Feature(LV2_URID__unmap, &uri_unmap));
179         features.append(new Lv2Feature(LV2_BUF_SIZE__powerOf2BlockLength, 0));
180         features.append(new Lv2Feature(LV2_BUF_SIZE__fixedBlockLength,    0));
181         features.append(new Lv2Feature(LV2_BUF_SIZE__boundedBlockLength,  0));
182         features.append(new Lv2Feature(LV2_WORKER__schedule, &schedule));
183
184         if( sample_rate < 64 ) sample_rate = samplerate;
185
186         atom_int   = uri_table.map(LV2_ATOM__Int);
187         atom_float = uri_table.map(LV2_ATOM__Float);
188         param_sampleRate = uri_table.map(LV2_PARAMETERS__sampleRate);
189         bufsz_minBlockLength =  uri_table.map(LV2_BUF_SIZE__minBlockLength);
190         bufsz_maxBlockLength = uri_table.map(LV2_BUF_SIZE__maxBlockLength);
191         bufsz_sequenceSize =  uri_table.map(LV2_BUF_SIZE__sequenceSize);
192         ui_updateRate = uri_table.map(LV2_UI__updateRate);
193
194         samplerate = sample_rate;
195         options.add(param_sampleRate, sizeof(float), atom_float, &samplerate);
196         if( min_block_length > bfrsz ) min_block_length = bfrsz;
197         options.add(bufsz_minBlockLength, sizeof(int), atom_int, &min_block_length);
198         block_length = bfrsz;
199         options.add(bufsz_maxBlockLength, sizeof(int), atom_int, &block_length);
200         options.add(bufsz_sequenceSize, sizeof(int), atom_int, &midi_buf_size);
201         options.add(ui_updateRate, sizeof(float),  atom_float, &refreshrate);
202         options.add(0, 0, 0, 0);
203
204         features.append(new Lv2Feature(LV2_OPTIONS__options,  &options[0]));
205         features.append(0);
206
207         inst = lilv_plugin_instantiate(lilv, sample_rate, features);
208         if( !inst ) {
209                 printf("lv2: lilv_plugin_instantiate failed\n");
210                 return 1;
211         }
212
213         const LV2_Descriptor *lilv_desc = inst->lv2_descriptor;
214         worker_iface = !lilv_desc->extension_data ? 0 :
215                 (LV2_Worker_Interface*)lilv_desc->extension_data(LV2_WORKER__interface);
216         if( worker_iface )
217                 worker_start();
218
219         lilv_instance_activate(inst);
220 // not sure what to do with these
221         max_bufsz = nb_inputs &&
222                 (lilv_plugin_has_feature(lilv, powerOf2BlockLength) ||
223                  lilv_plugin_has_feature(lilv, fixedBlockLength) ||
224                  lilv_plugin_has_feature(lilv, boundedBlockLength)) ? 4096 : 0;
225         init_buffer(bfrsz);
226         return 0;
227 }
228
229 uint32_t PluginLV2::map_uri(LV2_URID_Map_Handle handle, const char *uri)
230 {
231         PluginLV2 *the = (PluginLV2 *)handle;
232         return the->uri_table.map(uri);
233 }
234
235 const char *PluginLV2::unmap_uri(LV2_URID_Unmap_Handle handle, LV2_URID urid)
236 {
237         PluginLV2 *the = (PluginLV2 *)handle;
238         return the->uri_table.unmap(urid);
239 }
240
241 void PluginLV2::connect_ports(PluginLV2ClientConfig &conf, int ports)
242 {
243         int ich = 0, och = 0;
244         for( int i=0; i<conf.nb_ports; ++i ) {
245                 const LilvPort *lp = lilv_plugin_get_port_by_index(lilv, i);
246                 if( !lp ) continue;
247                 int port = conf.ports[i];
248                 if( !(port & ports) ) continue;
249                 if( (port & PORTS_CONTROL) ) {
250                         lilv_instance_connect_port(inst, i, &conf.ctls[i]);
251                         continue;
252                 }
253                 if( (port & PORTS_AUDIO) ) {
254                         if( (port & PORTS_INPUT) ) {
255                                 lilv_instance_connect_port(inst, i, in_buffers[ich]);
256                                 iport[ich++] = i;
257                         }
258                         else if( (port & PORTS_OUTPUT) ) {
259                                 lilv_instance_connect_port(inst, i, out_buffers[och]);
260                                 oport[och++] = i;
261                         }
262                         continue;
263                 }
264                 if( (port & PORTS_ATOM) ) {
265                         if( (port & PORTS_INPUT) )
266                                 lilv_instance_connect_port(inst, i, &seq_in);
267                         else
268                                 lilv_instance_connect_port(inst, i, seq_out);
269                         continue;
270                 }
271         }
272
273         seq_in[0].atom.size = sizeof(LV2_Atom_Sequence_Body);
274         seq_in[0].atom.type = uri_table.map(LV2_ATOM__Sequence);
275         seq_in[1].atom.size = 0;
276         seq_in[1].atom.type = 0;
277         seq_out->atom.size  = LV2_SEQ_SIZE;
278         seq_out->atom.type  = uri_table.map(LV2_ATOM__Chunk);
279 }
280
281 void PluginLV2::del_buffer()
282 {
283         if( shmid >= 0 )
284                 shm_buffer(-1);
285
286         delete [] in_buffers;  in_buffers = 0;
287         delete [] out_buffers;  out_buffers = 0;
288 }
289
290 void PluginLV2::new_buffer(int64_t sz)
291 {
292         uint8_t *bp = 0;
293         if( use_shm ) {  // currently, always uses shm
294                 shmid = shmget(IPC_PRIVATE, sz, IPC_CREAT | 0777);
295                 if( shmid >= 0 ) {
296                         bp = (unsigned char*)shmat(shmid, NULL, 0);
297                         if( bp == (void *) -1 ) { perror("shmat"); bp = 0; }
298                         shmctl(shmid, IPC_RMID, 0); // delete when last ref gone
299                 }
300                 else {
301                         perror("PluginLV2::allocate_buffer: shmget failed\n");
302                         BC_Trace::dump_shm_stats(stdout);
303                 }
304         }
305
306         shm_bfr = (shm_bfr_t *) bp;
307         if( shm_bfr ) shm_bfr->sz = sz;
308 }
309
310 shm_bfr_t *PluginLV2::shm_buffer(int shmid)
311 {
312         if( this->shmid != shmid ) {
313                 if( this->shmid >= 0 ) {
314                         shmdt(shm_bfr);  this->shmid = -1;
315                         shm_bfr = 0;
316                 }
317                 if( shmid >= 0 ) {
318                         shm_bfr = (shm_bfr_t *)shmat(shmid, NULL, 0);
319                         if( shm_bfr == (void *)-1 ) { perror("shmat");  shm_bfr = 0; }
320                         this->shmid = shm_bfr ? shmid : -1;
321                 }
322         }
323         return shm_bfr;
324 }
325
326 void PluginLV2::init_buffer(int samples)
327 {
328         int64_t sz = sizeof(shm_bfr_t) +
329                 sizeof(iport[0])*nb_inputs + sizeof(oport[0])*nb_outputs +
330                 sizeof(*in_buffers[0]) *samples * nb_inputs +
331                 sizeof(*out_buffers[0])*samples * nb_outputs;
332
333         if( shm_bfr ) {
334                 if( shm_bfr->sz < sz ||
335                     shm_bfr->nb_inputs != nb_inputs ||
336                     shm_bfr->nb_outputs != nb_outputs )
337                         del_buffer();
338         }
339
340         if( !shm_bfr )
341                 new_buffer(sz);
342
343         shm_bfr->samples = samples;
344         shm_bfr->done = 0;
345         shm_bfr->nb_inputs = nb_inputs;
346         shm_bfr->nb_outputs = nb_outputs;
347
348         map_buffer();
349 }
350
351 // shm_bfr layout:
352 // struct shm_bfr {
353 //   int64_t sz;
354 //   int samples, done;
355 //   int nb_inputs, nb_outputs;
356 //   int iport[nb_inputs], 
357 //   float in_buffers[samples][nb_inputs];
358 //   int oport[nb_outputs];
359 //   float out_buffers[samples][nb_outputs];
360 // };
361
362 void PluginLV2::map_buffer()
363 {
364         uint8_t *bp = (uint8_t *)(shm_bfr + 1);
365
366         nb_inputs = shm_bfr->nb_inputs;
367         iport = (int *)bp;
368         bp += sizeof(iport[0])*nb_inputs;
369         in_buffers = new float*[nb_inputs];
370         int samples = shm_bfr->samples;
371         for(int i=0; i<nb_inputs; ++i ) {
372                 in_buffers[i] = (float *)bp;
373                 bp += sizeof(*in_buffers[0])*samples;
374         }
375
376         nb_outputs = shm_bfr->nb_outputs;
377         oport = (int *)bp;
378         bp += sizeof(oport[0])*nb_outputs;
379         out_buffers = new float*[nb_outputs];
380         for( int i=0; i<nb_outputs; ++i ) {
381                 out_buffers[i] = (float *)bp;
382                 bp += sizeof(*out_buffers[0])*samples;
383         }
384 }
385
386
387 // LV2 Worker
388
389 PluginLV2Work::PluginLV2Work()
390 {
391         next = 0;
392         alloc = used = 0;
393         data = 0;
394 }
395
396 PluginLV2Work::~PluginLV2Work()
397 {
398         delete [] data;
399 }
400
401 void PluginLV2Work::load(const void *vp, unsigned size)
402 {
403         if( alloc < size ) {
404                 delete [] data;
405                 data = new char[alloc=size];
406         }
407         memcpy(data, vp, used=size);
408 }
409
410 PluginLV2Work *PluginLV2::get_work()
411 {
412 // must hold worker_lock
413         if( !work_avail ) return new PluginLV2Work();
414         PluginLV2Work *wp = work_avail;
415         work_avail = wp->next;  wp->next = 0;
416         return wp;
417 }
418
419 void *PluginLV2::worker_func()
420 {
421         pthread_mutex_lock(&worker_lock);
422         pthread_mutex_unlock(&startup_lock);
423         for(;;) {
424                 while( !worker_done && !work_input )
425                         pthread_cond_wait(&worker_ready, &worker_lock);
426                 if( worker_done ) break;
427                 PluginLV2Work *wp = work_input;  work_input = wp->next;
428
429                 pthread_mutex_unlock(&worker_lock);
430                 worker_iface->work(inst, lv2_worker_respond, this, wp->used, wp->data);
431                 pthread_mutex_lock(&worker_lock);
432                 wp->next = work_avail;  work_avail = wp;
433         }
434         pthread_mutex_unlock(&worker_lock);
435         return NULL;
436 }
437 void *PluginLV2::worker_func(void* vp)
438 {
439         PluginLV2 *the = (PluginLV2 *)vp;
440         return the->worker_func();
441 }
442
443 void PluginLV2::worker_start()
444 {
445         pthread_create(&worker_thread, 0, worker_func, this);
446         pthread_mutex_lock(&startup_lock);
447 }
448
449 void PluginLV2::worker_stop()
450 {
451         if( !worker_done ) {
452                 worker_done = 1;
453                 pthread_mutex_lock(&worker_lock);
454                 pthread_cond_signal(&worker_ready);
455                 pthread_mutex_unlock(&worker_lock);
456                 pthread_join(worker_thread, 0);
457                 worker_thread = 0;
458         }
459         work_stop(work_avail);
460         work_stop(work_input);
461         work_stop(work_output);
462         work_tail = &work_output;
463 }
464
465 void PluginLV2::work_stop(PluginLV2Work *&work)
466 {
467         while( work ) {
468                 PluginLV2Work *wp = work;
469                 work = wp->next;
470                 delete wp;
471         }
472 }
473
474 LV2_Worker_Status PluginLV2::worker_schedule(uint32_t inp_size, const void *inp_data)
475 {
476         if( is_forked() ) {
477                 if( !pthread_mutex_trylock(&worker_lock) ) {
478                         PluginLV2Work *wp = get_work();
479                         wp->load(inp_data, inp_size);
480                         wp->next = work_input;  work_input = wp;
481                         pthread_cond_signal(&worker_ready);
482                         pthread_mutex_unlock(&worker_lock);
483                 }
484         }
485         else if( worker_iface )
486                 worker_iface->work(inst, lv2_worker_respond, this, inp_size, inp_data);
487         return LV2_WORKER_SUCCESS;
488 }
489 LV2_Worker_Status PluginLV2::lv2_worker_schedule(LV2_Worker_Schedule_Handle vp,
490                     uint32_t inp_size, const void *inp_data)
491 {
492         PluginLV2 *the = (PluginLV2 *)vp;
493         return the->worker_schedule(inp_size, inp_data);
494 }
495
496 LV2_Worker_Status PluginLV2::worker_respond(uint32_t out_size, const void *out_data)
497 {
498         pthread_mutex_lock(&worker_lock);
499         PluginLV2Work *wp = get_work();
500         wp->load(out_data, out_size);
501         *work_tail = wp;  work_tail = &wp->next;
502         pthread_mutex_unlock(&worker_lock);
503         return LV2_WORKER_SUCCESS;
504 }
505 LV2_Worker_Status PluginLV2::lv2_worker_respond(LV2_Worker_Respond_Handle vp,
506                 uint32_t out_size, const void *out_data)
507 {
508         PluginLV2 *the = (PluginLV2 *)vp;
509         return the->worker_respond(out_size, out_data);
510 }
511
512 void PluginLV2::worker_responses()
513 {
514         pthread_mutex_lock(&worker_lock);
515         while( work_output ) {
516                 PluginLV2Work *rp = work_output;
517                 if( !(work_output=rp->next) ) work_tail = &work_output;
518                 pthread_mutex_unlock(&worker_lock);
519                 worker_iface->work_response(inst, rp->used, rp->data);
520                 pthread_mutex_lock(&worker_lock);
521                 rp->next = work_avail;  work_avail = rp;
522         }
523         pthread_mutex_unlock(&worker_lock);
524 }
525
526 #include "file.h"
527 #include "pluginlv2ui.h"
528
529 PluginLV2ChildUI::PluginLV2ChildUI()
530 {
531         ac = 0;
532         av = 0;
533         gui = 0;
534         hidden = 1;
535 }
536
537 PluginLV2ChildUI::~PluginLV2ChildUI()
538 {
539         delete gui;
540 }
541
542 void PluginLV2ChildUI::run()
543 {
544         ArrayList<char *> av;
545         av.set_array_delete();
546         char arg[BCTEXTLEN];
547         const char *exec_path = File::get_cinlib_path();
548         snprintf(arg, sizeof(arg), "%s/%s", exec_path, "lv2ui");
549         av.append(cstrdup(arg));
550         sprintf(arg, "%d", child_fd);
551         av.append(cstrdup(arg));
552         sprintf(arg, "%d", parent_fd);
553         av.append(cstrdup(arg));
554         sprintf(arg, "%d", ppid);
555         av.append(cstrdup(arg));
556         av.append(0);
557         execv(av[0], &av.values[0]);
558         fprintf(stderr, "execv failed: %s\n %m\n", av.values[0]);
559         av.remove_all_objects();
560         _exit(1);
561 }
562
563 #define LV2_EXTERNAL_UI_URI__KX__Widget "http://kxstudio.sf.net/ns/lv2ext/external-ui#Widget"
564
565 PluginLV2UI::PluginLV2UI()
566 {
567         lilv_ui = 0;
568         lilv_type = 0;
569
570         done = -1;
571         running = 0;
572         updates = 0;
573         hidden = 1;
574         title[0] = 0;
575
576         memset(&uri_map, 0, sizeof(uri_map));
577         memset(&uri_unmap, 0, sizeof(uri_unmap));
578         memset(&extui_host, 0, sizeof(extui_host));
579         wgt_type = LV2_EXTERNAL_UI_URI__KX__Widget;
580         gtk_type = LV2_UI__GtkUI;
581         ui_type = 0;
582 }
583
584 PluginLV2UI::~PluginLV2UI ()
585 {
586 }
587
588 #endif