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