cinelerra-5.0/plugins/reverb/reverb.C

   1
   2 /*
   3  * CINELERRA
   4  * Copyright (C) 2008 Adam Williams <broadcast at earthling dot net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  */
  21
  22 #include "clip.h"
  23 #include "confirmsave.h"
  24 #include "bchash.h"
  25 #include "bcsignals.h"
  26 #include "errorbox.h"
  27 #include "filexml.h"
  28 #include "format.inc"
  29 #include "language.h"
  30 #include "reverb.h"
  31 #include "reverbwindow.h"
  32 #include "samples.h"
  33 #include "units.h"
  34
  35 #include "vframe.h"
  36
  37 #include <math.h>
  38 #include <string.h>
  39 #include <time.h>
  40 #include <unistd.h>
  41
  42
  43
  44 PluginClient* new_plugin(PluginServer *server)
  45 {
  46         return new Reverb(server);
  47 }
  48
  49
  50
  51 Reverb::Reverb(PluginServer *server)
  52  : PluginAClient(server)
  53 {
  54         srand(time(0));
  55         redo_buffers = 1;       // set to redo buffers before the first render
  56         dsp_in_length = 0;
  57         ref_channels = 0;
  58         ref_offsets = 0;
  59         ref_levels = 0;
  60         ref_lowpass = 0;
  61         dsp_in = 0;
  62         lowpass_in1 = 0;
  63         lowpass_in2 = 0;
  64         initialized = 0;
  65
  66 }
  67
  68 Reverb::~Reverb()
  69 {
  70
  71
  72         if(initialized)
  73         {
  74                 for(int i = 0; i < total_in_buffers; i++)
  75                 {
  76                         delete [] dsp_in[i];
  77                         delete [] ref_channels[i];
  78                         delete [] ref_offsets[i];
  79                         delete [] ref_levels[i];
  80                         delete [] ref_lowpass[i];
  81                         delete [] lowpass_in1[i];
  82                         delete [] lowpass_in2[i];
  83                 }
  84
  85                 delete [] dsp_in;
  86                 delete [] ref_channels;
  87                 delete [] ref_offsets;
  88                 delete [] ref_levels;
  89                 delete [] ref_lowpass;
  90                 delete [] lowpass_in1;
  91                 delete [] lowpass_in2;
  92
  93                 for(int i = 0; i < (smp + 1); i++)
  94                 {
  95                         delete engine[i];
  96                 }
  97                 delete [] engine;
  98                 initialized = 0;
  99         }
 100 }
 101
 102 const char* Reverb::plugin_title() { return _("Reverb"); }
 103 int Reverb::is_realtime() { return 1; }
 104 int Reverb::is_multichannel() { return 1; }
 105 int Reverb::is_synthesis() { return 1; }
 106
 107 int Reverb::process_realtime(int64_t size,
 108         Samples **input_ptr,
 109         Samples **output_ptr)
 110 {
 111         int64_t new_dsp_length, i, j;
 112         main_in = new double*[total_in_buffers];
 113         main_out = new double*[total_in_buffers];
 114
 115         for(i = 0; i < total_in_buffers; i++)
 116         {
 117                 main_in[i] = input_ptr[i]->get_data();
 118                 main_out[i] = output_ptr[i]->get_data();
 119         }
 120
 121 //printf("Reverb::process_realtime 1\n");
 122         redo_buffers |= load_configuration();
 123
 124 //printf("Reverb::process_realtime 1\n");
 125         if(!config.ref_total)
 126         {
 127                 delete [] main_in;
 128                 delete [] main_out;
 129                 return 0;
 130         }
 131
 132
 133         if(!initialized)
 134         {
 135                 dsp_in = new double*[total_in_buffers];
 136                 ref_channels = new int64_t*[total_in_buffers];
 137                 ref_offsets = new int64_t*[total_in_buffers];
 138                 ref_levels = new double*[total_in_buffers];
 139                 ref_lowpass = new int64_t*[total_in_buffers];
 140                 lowpass_in1 = new double*[total_in_buffers];
 141                 lowpass_in2 = new double*[total_in_buffers];
 142
 143
 144
 145                 for(i = 0; i < total_in_buffers; i++)
 146                 {
 147                         dsp_in[i] = new double[1];
 148                         ref_channels[i] = new int64_t[1];
 149                         ref_offsets[i] = new int64_t[1];
 150                         ref_levels[i] = new double[1];
 151                         ref_lowpass[i] = new int64_t[1];
 152                         lowpass_in1[i] = new double[1];
 153                         lowpass_in2[i] = new double[1];
 154                 }
 155
 156                 engine = new ReverbEngine*[(smp + 1)];
 157                 for(i = 0; i < (smp + 1); i++)
 158                 {
 159                         engine[i] = new ReverbEngine(this);
 160 //printf("Reverb::start_realtime %d\n", Thread::calculate_realtime());
 161 // Realtime priority moved to sound driver
 162 //              engine[i]->set_realtime(realtime_priority);
 163                         engine[i]->start();
 164                 }
 165                 initialized = 1;
 166                 redo_buffers = 1;
 167         }
 168
 169         new_dsp_length = size +
 170                 ((int64_t)config.delay_init + config.ref_length) * project_sample_rate / 1000 + 1;
 171
 172         if(redo_buffers || new_dsp_length != dsp_in_length)
 173         {
 174                 for(i = 0; i < total_in_buffers; i++)
 175                 {
 176                         double *old_dsp = dsp_in[i];
 177                         double *new_dsp = new double[new_dsp_length];
 178                         for(j = 0; j < dsp_in_length && j < new_dsp_length; j++)
 179                                 new_dsp[j] = old_dsp[j];
 180
 181
 182                         for( ; j < new_dsp_length; j++) new_dsp[j] = 0;
 183                         delete [] old_dsp;
 184                         dsp_in[i] = new_dsp;
 185                 }
 186
 187                 dsp_in_length = new_dsp_length;
 188                 redo_buffers = 1;
 189         }
 190 //printf("Reverb::process_realtime 1\n");
 191
 192         if(redo_buffers)
 193         {
 194                 for(i = 0; i < total_in_buffers; i++)
 195                 {
 196                         delete [] ref_channels[i];
 197                         delete [] ref_offsets[i];
 198                         delete [] ref_lowpass[i];
 199                         delete [] ref_levels[i];
 200                         delete [] lowpass_in1[i];
 201                         delete [] lowpass_in2[i];
 202
 203                         ref_channels[i] = new int64_t[config.ref_total + 1];
 204                         ref_offsets[i] = new int64_t[config.ref_total + 1];
 205                         ref_lowpass[i] = new int64_t[config.ref_total + 1];
 206                         ref_levels[i] = new double[config.ref_total + 1];
 207                         lowpass_in1[i] = new double[config.ref_total + 1];
 208                         lowpass_in2[i] = new double[config.ref_total + 1];
 209
 210 // set channels
 211                         ref_channels[i][0] = i;         // primary noise
 212                         ref_channels[i][1] = i;         // first reflection
 213 // set offsets
 214                         ref_offsets[i][0] = 0;
 215                         ref_offsets[i][1] = config.delay_init * project_sample_rate / 1000;
 216 // set levels
 217                         ref_levels[i][0] = db.fromdb(config.level_init);
 218                         ref_levels[i][1] = db.fromdb(config.ref_level1);
 219 // set lowpass
 220                         ref_lowpass[i][0] = -1;     // ignore first noise
 221                         ref_lowpass[i][1] = config.lowpass1;
 222                         lowpass_in1[i][0] = 0;
 223                         lowpass_in2[i][0] = 0;
 224                         lowpass_in1[i][1] = 0;
 225                         lowpass_in2[i][1] = 0;
 226
 227                         int64_t ref_division = config.ref_length * project_sample_rate / 1000 / (config.ref_total + 1);
 228                         for(j = 2; j < config.ref_total + 1; j++)
 229                         {
 230 // set random channels for remaining reflections
 231                                 ref_channels[i][j] = rand() % total_in_buffers;
 232
 233 // set random offsets after first reflection
 234                                 ref_offsets[i][j] = ref_offsets[i][1];
 235                                 ref_offsets[i][j] += ref_division * j - (rand() % ref_division) / 2;
 236
 237 // set changing levels
 238                                 ref_levels[i][j] = db.fromdb(config.ref_level1 + (config.ref_level2 - config.ref_level1) / (config.ref_total - 1) * (j - 2));
 239                                 //ref_levels[i][j] /= 100;
 240
 241 // set changing lowpass as linear
 242                                 ref_lowpass[i][j] = (int64_t)(config.lowpass1 + (double)(config.lowpass2 - config.lowpass1) / (config.ref_total - 1) * (j - 2));
 243                                 lowpass_in1[i][j] = 0;
 244                                 lowpass_in2[i][j] = 0;
 245                         }
 246                 }
 247
 248                 redo_buffers = 0;
 249         }
 250 //printf("Reverb::process_realtime 1\n");
 251
 252         for(i = 0; i < total_in_buffers; )
 253         {
 254                 for(j = 0; j < (smp + 1) && (i + j) < total_in_buffers; j++)
 255                 {
 256                         engine[j]->process_overlays(i + j, size);
 257                 }
 258
 259                 for(j = 0; j < (smp + 1) && i < total_in_buffers; j++, i++)
 260                 {
 261                         engine[j]->wait_process_overlays();
 262                 }
 263         }
 264 //printf("Reverb::process_realtime 2 %d %d\n", total_in_buffers, size);
 265
 266         for(i = 0; i < total_in_buffers; i++)
 267         {
 268                 double *current_out = main_out[i];
 269                 double *current_in = dsp_in[i];
 270
 271                 for(j = 0; j < size; j++) current_out[j] = current_in[j];
 272
 273                 int64_t k;
 274                 for(k = 0; j < dsp_in_length; j++, k++) current_in[k] = current_in[j];
 275
 276                 for(; k < dsp_in_length; k++) current_in[k] = 0;
 277         }
 278 //printf("Reverb::process_realtime 2 %d %d\n", total_in_buffers, size);
 279
 280
 281         delete [] main_in;
 282         delete [] main_out;
 283         return 0;
 284 }
 285
 286
 287 NEW_WINDOW_MACRO(Reverb, ReverbWindow)
 288
 289
 290 LOAD_CONFIGURATION_MACRO(Reverb, ReverbConfig)
 291
 292
 293 void Reverb::save_data(KeyFrame *keyframe)
 294 {
 295 //printf("Reverb::save_data 1\n");
 296         FileXML output;
 297 //printf("Reverb::save_data 1\n");
 298
 299 // cause xml file to store data directly in text
 300         output.set_shared_output(keyframe->get_data(), MESSAGESIZE);
 301 //printf("Reverb::save_data 1\n");
 302
 303         output.tag.set_title("REVERB");
 304         output.tag.set_property("LEVELINIT", config.level_init);
 305         output.tag.set_property("DELAY_INIT", config.delay_init);
 306         output.tag.set_property("REF_LEVEL1", config.ref_level1);
 307         output.tag.set_property("REF_LEVEL2", config.ref_level2);
 308         output.tag.set_property("REF_TOTAL", config.ref_total);
 309 //printf("Reverb::save_data 1\n");
 310         output.tag.set_property("REF_LENGTH", config.ref_length);
 311         output.tag.set_property("LOWPASS1", config.lowpass1);
 312         output.tag.set_property("LOWPASS2", config.lowpass2);
 313 //printf("Reverb::save_data config.ref_level2 %f\n", config.ref_level2);
 314         output.append_tag();
 315         output.tag.set_title("/REVERB");
 316         output.append_tag();
 317         output.append_newline();
 318         output.terminate_string();
 319 //printf("Reverb::save_data 2\n");
 320 }
 321
 322 void Reverb::read_data(KeyFrame *keyframe)
 323 {
 324         FileXML input;
 325 // cause xml file to read directly from text
 326         input.set_shared_input(keyframe->get_data(), strlen(keyframe->get_data()));
 327         int result = 0;
 328
 329         result = input.read_tag();
 330
 331         if(!result)
 332         {
 333                 if(input.tag.title_is("REVERB"))
 334                 {
 335                         config.level_init = input.tag.get_property("LEVELINIT", config.level_init);
 336                         config.delay_init = input.tag.get_property("DELAY_INIT", config.delay_init);
 337                         config.ref_level1 = input.tag.get_property("REF_LEVEL1", config.ref_level1);
 338                         config.ref_level2 = input.tag.get_property("REF_LEVEL2", config.ref_level2);
 339                         config.ref_total = input.tag.get_property("REF_TOTAL", config.ref_total);
 340                         config.ref_length = input.tag.get_property("REF_LENGTH", config.ref_length);
 341                         config.lowpass1 = input.tag.get_property("LOWPASS1", config.lowpass1);
 342                         config.lowpass2 = input.tag.get_property("LOWPASS2", config.lowpass2);
 343                 }
 344         }
 345
 346         config.boundaries();
 347 }
 348
 349 void Reverb::update_gui()
 350 {
 351         if(thread)
 352         {
 353                 thread->window->lock_window();
 354                 ((ReverbWindow*)thread->window)->level_init->update(config.level_init);
 355                 ((ReverbWindow*)thread->window)->delay_init->update(config.delay_init);
 356                 ((ReverbWindow*)thread->window)->ref_level1->update(config.ref_level1);
 357                 ((ReverbWindow*)thread->window)->ref_level2->update(config.ref_level2);
 358                 ((ReverbWindow*)thread->window)->ref_total->update(config.ref_total);
 359                 ((ReverbWindow*)thread->window)->ref_length->update(config.ref_length);
 360                 ((ReverbWindow*)thread->window)->lowpass1->update(config.lowpass1);
 361                 ((ReverbWindow*)thread->window)->lowpass2->update(config.lowpass2);
 362                 thread->window->unlock_window();
 363         }
 364 }
 365
 366
 367
 368
 369 int Reverb::load_from_file(char *path)
 370 {
 371         int result = 0;
 372         int length;
 373         char string[1024];
 374
 375         FILE *in = fopen(path, "rb");
 376         if( in )
 377         {
 378                 fseek(in, 0, SEEK_END);
 379                 length = ftell(in);
 380                 fseek(in, 0, SEEK_SET);
 381                 (void)fread(string, length, 1, in);
 382                 fclose(in);
 383 //              read_data(string);
 384         }
 385         else
 386         {
 387                 perror("fopen:");
 388 // failed
 389                 ErrorBox errorbox("");
 390                 char string[1024];
 391                 sprintf(string, _("Couldn't open %s."), path);
 392                 errorbox.create_objects(string);
 393                 errorbox.run_window();
 394                 result = 1;
 395         }
 396
 397         return result;
 398 }
 399
 400 int Reverb::save_to_file(char *path)
 401 {
 402         int result = 0;
 403         char string[1024];
 404
 405         {
 406 //              ConfirmSave confirm;
 407 //              result = confirm.test_file("", path);
 408         }
 409
 410         if(!result)
 411         {
 412                 FILE *out = fopen(path, "wb");
 413                 if( out )
 414                 {
 415 //                      save_data(string);
 416                         fwrite(string, strlen(string), 1, out);
 417                         fclose(out);
 418                 }
 419                 else
 420                 {
 421                         result = 1;
 422 // failed
 423                         ErrorBox errorbox("");
 424                         char string[1024];
 425                         sprintf(string, _("Couldn't save %s."), path);
 426                         errorbox.create_objects(string);
 427                         errorbox.run_window();
 428                         result = 1;
 429                 }
 430         }
 431
 432         return result;
 433 }
 434
 435 ReverbEngine::ReverbEngine(Reverb *plugin)
 436  : Thread(1, 0, 0)
 437 {
 438         this->plugin = plugin;
 439         completed = 0;
 440         input_lock.lock();
 441         output_lock.lock();
 442 }
 443
 444 ReverbEngine::~ReverbEngine()
 445 {
 446         completed = 1;
 447         input_lock.unlock();
 448         join();
 449 }
 450
 451 int ReverbEngine::process_overlays(int output_buffer, int64_t size)
 452 {
 453         this->output_buffer = output_buffer;
 454         this->size = size;
 455         input_lock.unlock();
 456         return 0;
 457 }
 458
 459 int ReverbEngine::wait_process_overlays()
 460 {
 461         output_lock.lock();
 462         return 0;
 463 }
 464
 465 int ReverbEngine::process_overlay(double *in, double *out, double &out1, double &out2, double level, int64_t lowpass, int64_t samplerate, int64_t size)
 466 {
 467 // Modern niquist frequency is 44khz but pot limit is 20khz so can't use
 468 // niquist
 469         if(lowpass == -1 || lowpass >= 20000)
 470         {
 471 // no lowpass filter
 472                 for(int i = 0; i < size; i++) out[i] += in[i] * level;
 473         }
 474         else
 475         {
 476                 double coef = 0.25 * 2.0 * M_PI * (double)lowpass / (double)plugin->project_sample_rate;
 477                 double a = coef * 0.25;
 478                 double b = coef * 0.50;
 479
 480                 for(int i = 0; i < size; i++)
 481                 {
 482                         out2 += a * (3 * out1 + in[i] - out2);
 483                         out2 += b * (out1 + in[i] - out2);
 484                         out2 += a * (out1 + 3 * in[i] - out2);
 485                         out2 += coef * (in[i] - out2);
 486                         out1 = in[i];
 487                         out[i] += out2 * level;
 488                 }
 489         }
 490         return 0;
 491 }
 492
 493 void ReverbEngine::run()
 494 {
 495         int j, i;
 496 //printf("ReverbEngine::run 1 %d\n", calculate_realtime());
 497         while(1)
 498         {
 499                 input_lock.lock();
 500                 if(completed) return;
 501
 502 // Process reverb
 503                 for(i = 0; i < plugin->total_in_buffers; i++)
 504                 {
 505                         for(j = 0; j < plugin->config.ref_total + 1; j++)
 506                         {
 507                                 if(plugin->ref_channels[i][j] == output_buffer)
 508                                         process_overlay(plugin->main_in[i],
 509                                                                 &(plugin->dsp_in[plugin->ref_channels[i][j]][plugin->ref_offsets[i][j]]),
 510                                                                 plugin->lowpass_in1[i][j],
 511                                                                 plugin->lowpass_in2[i][j],
 512                                                                 plugin->ref_levels[i][j],
 513                                                                 plugin->ref_lowpass[i][j],
 514                                                                 plugin->project_sample_rate,
 515                                                                 size);
 516                         }
 517                 }
 518
 519                 output_lock.unlock();
 520         }
 521 }
 522
 523
 524
 525
 526
 527
 528
 529 ReverbConfig::ReverbConfig()
 530 {
 531         level_init = 0;
 532         delay_init = 0;
 533         ref_level1 = -20;
 534         ref_level2 = INFINITYGAIN;
 535         ref_total = 100;
 536         ref_length = 600;
 537         lowpass1 = Freq::tofreq(TOTALFREQS);
 538         lowpass2 = Freq::tofreq(TOTALFREQS);
 539
 540 }
 541
 542 int ReverbConfig::equivalent(ReverbConfig &that)
 543 {
 544         return (EQUIV(level_init, that.level_init) &&
 545                 delay_init == that.delay_init &&
 546                 EQUIV(ref_level1, that.ref_level1) &&
 547                 EQUIV(ref_level2, that.ref_level2) &&
 548                 ref_total == that.ref_total &&
 549                 ref_length == that.ref_length &&
 550                 lowpass1 == that.lowpass1 &&
 551                 lowpass2 == that.lowpass2);
 552 }
 553
 554 void ReverbConfig::copy_from(ReverbConfig &that)
 555 {
 556         level_init = that.level_init;
 557         delay_init = that.delay_init;
 558         ref_level1 = that.ref_level1;
 559         ref_level2 = that.ref_level2;
 560         ref_total = that.ref_total;
 561         ref_length = that.ref_length;
 562         lowpass1 = that.lowpass1;
 563         lowpass2 = that.lowpass2;
 564 }
 565
 566 void ReverbConfig::interpolate(ReverbConfig &prev,
 567         ReverbConfig &next,
 568         int64_t prev_frame,
 569         int64_t next_frame,
 570         int64_t current_frame)
 571 {
 572         level_init = prev.level_init;
 573         delay_init = prev.delay_init;
 574         ref_level1 = prev.ref_level1;
 575         ref_level2 = prev.ref_level2;
 576         ref_total = prev.ref_total;
 577         ref_length = prev.ref_length;
 578         lowpass1 = prev.lowpass1;
 579         lowpass2 = prev.lowpass2;
 580 }
 581
 582 void ReverbConfig::boundaries()
 583 {
 584
 585         CLAMP(level_init, INFINITYGAIN, 0);
 586         CLAMP(delay_init, 0, MAX_DELAY_INIT);
 587         CLAMP(ref_level1, INFINITYGAIN, 0);
 588         CLAMP(ref_level2, INFINITYGAIN, 0);
 589         CLAMP(ref_total, MIN_REFLECTIONS, MAX_REFLECTIONS);
 590         CLAMP(ref_length, 0, MAX_REFLENGTH);
 591         CLAMP(lowpass1, 0, Freq::tofreq(TOTALFREQS));
 592         CLAMP(lowpass2, 0, Freq::tofreq(TOTALFREQS));
 593 }
 594
 595 void ReverbConfig::dump()
 596 {
 597         printf("ReverbConfig::dump %f %jd %f %f %jd %jd %jd %jd\n",
 598                 level_init, delay_init, ref_level1, ref_level2,
 599                 ref_total, ref_length, lowpass1, lowpass2);
 600 }
 601
 602