initial commit
[goodguy/history.git] / cinelerra-5.0 / plugins / denoise / denoise.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 "bcdisplayinfo.h"
23 #include "clip.h"
24 #include "bchash.h"
25 #include "filexml.h"
26 #include "denoise.h"
27 #include "language.h"
28 #include "samples.h"
29 #include "units.h"
30 #include "vframe.h"
31
32 #include <math.h>
33 #include <string.h>
34
35
36
37
38 #define WINDOW_BORDER (window_size / 2)
39 #define SGN(x) (x<0 ? -1: 1)
40
41
42 REGISTER_PLUGIN(DenoiseEffect)
43
44
45
46
47
48 DenoiseEffect::DenoiseEffect(PluginServer *server)
49  : PluginAClient(server)
50 {
51         reset();
52         
53 }
54
55 DenoiseEffect::~DenoiseEffect()
56 {
57         
58         delete_dsp();
59 }
60
61
62 LOAD_CONFIGURATION_MACRO(DenoiseEffect, DenoiseConfig)
63
64 NEW_WINDOW_MACRO(DenoiseEffect, DenoiseWindow)
65
66 void DenoiseEffect::delete_dsp()
67 {
68         if(ex_coeff_d) delete ex_coeff_d;
69         if(ex_coeff_r) delete ex_coeff_r;
70         if(ex_coeff_rn) delete ex_coeff_rn;
71         if(wave_coeff_d) delete wave_coeff_d;
72         if(wave_coeff_r) delete wave_coeff_r;
73         if(decomp_filter) delete decomp_filter;
74         if(recon_filter) delete recon_filter;
75         if(input_buffer) delete [] input_buffer;
76         if(output_buffer) delete [] output_buffer;
77         if(dsp_in) delete [] dsp_in;
78         if(dsp_out) delete [] dsp_out;
79         if(dsp_iteration) delete [] dsp_iteration;
80
81         ex_coeff_d = 0;
82         ex_coeff_r = 0;
83         ex_coeff_rn = 0;
84         wave_coeff_d = 0;
85         wave_coeff_r = 0;
86         decomp_filter = 0;
87         recon_filter = 0;
88         input_buffer = 0;
89         output_buffer = 0;
90         dsp_in = 0;
91         dsp_out = 0;
92         dsp_iteration = 0;
93 }
94
95
96 void DenoiseEffect::reset()
97 {
98         first_window = 1;
99         thread = 0;
100         ex_coeff_d = 0;
101         ex_coeff_r = 0;
102         ex_coeff_rn = 0;
103         wave_coeff_d = 0;
104         wave_coeff_r = 0;
105         decomp_filter = 0;
106         recon_filter = 0;
107         input_buffer = 0;
108         output_buffer = 0;
109         input_size = 0;
110         output_size = 0;
111         input_allocation = 0;
112         output_allocation = 0;
113         dsp_iteration = 0;
114         in_scale = 0;
115         out_scale = 0;
116         dsp_in = 0;
117         dsp_out = 0;
118         initialized = 0;
119
120
121         alpha = 1.359803732;
122         beta = -0.782106385;
123         window_size = 4096;
124         output_level = 1.0;
125         levels = 1;
126         iterations = 1;
127 }
128
129 const char* DenoiseEffect::plugin_title() { return N_("Denoise"); }
130 int DenoiseEffect::is_realtime() { return 1; }
131
132
133
134 void DenoiseEffect::read_data(KeyFrame *keyframe)
135 {
136         FileXML input;
137         input.set_shared_input(keyframe->get_data(), strlen(keyframe->get_data()));
138
139         int result = 0;
140         while(!result)
141         {
142                 result = input.read_tag();
143
144                 if(!result)
145                 {
146                         if(input.tag.title_is("DENOISE"))
147                         {
148                                 config.level = input.tag.get_property("LEVEL", config.level);
149                         }
150                 }
151         }
152 }
153
154 void DenoiseEffect::save_data(KeyFrame *keyframe)
155 {
156         FileXML output;
157         output.set_shared_output(keyframe->get_data(), MESSAGESIZE);
158
159         output.tag.set_title("DENOISE");
160         output.tag.set_property("LEVEL", config.level);
161         output.append_tag();
162         output.append_newline();
163
164         output.terminate_string();
165 }
166
167
168 void DenoiseEffect::update_gui()
169 {
170         if(thread)
171         {
172                 ((DenoiseWindow*)thread->window)->lock_window();
173                 ((DenoiseWindow*)thread->window)->update();
174                 ((DenoiseWindow*)thread->window)->unlock_window();
175         }
176 }
177
178
179
180 double DenoiseEffect::dot_product(double *data, double *filter, char filtlen)
181 {
182         static int i;
183         static double sum;
184
185         sum = 0.0;
186         for(i = 0; i < filtlen; i++) sum += *data-- * *filter++;
187         return sum;
188 }
189
190 int DenoiseEffect::convolve_dec_2(double *input_sequence, 
191         int64_t length,
192         double *filter, 
193         int filtlen, 
194         double *output_sequence)
195 {
196 // convolve the input sequence with the filter and decimate by two
197         int i, shortlen, offset;
198         int64_t lengthp4 = length + 4;
199         int64_t lengthm4 = length - 4;
200         int64_t lengthp5 = length + 5;
201         int64_t lengthp8 = length + 8;
202
203         for(i = 0; (i <= lengthp8) && ((i - filtlen) <= lengthp8); i += 2)
204         {
205                 if(i < filtlen)
206                         *output_sequence++ = dot_product(input_sequence + i, filter, i + 1);
207                 else 
208                 if(i > lengthp5)
209                 {
210                         offset = i - lengthm4;
211                         shortlen = filtlen - offset;
212                         *output_sequence++ = dot_product(input_sequence + lengthp4,
213                                                                 filter + offset, shortlen);
214                 }
215                 else
216                         *output_sequence++ = dot_product(input_sequence + i, filter, filtlen);
217         }
218         return 0;
219 }
220
221 int64_t DenoiseEffect::decompose_branches(double *in_data, 
222         int64_t length, 
223         WaveletFilters *decomp_filter, 
224         double *out_low, 
225         double *out_high)
226 {
227 // Take input data and filters and form two branches of half the
228 // original length. Length of branches is returned.
229         convolve_dec_2(in_data, length, decomp_filter->h, decomp_filter->length, out_low);
230         convolve_dec_2(in_data, length, decomp_filter->g, decomp_filter->length, out_high);
231         return (length / 2);
232 }
233
234 int DenoiseEffect::wavelet_decomposition(double *in_data, 
235         int64_t in_length, 
236         double **out_data)
237 {
238         for(int i = 0; i < levels; i++)
239         {
240                 in_length = decompose_branches(in_data, 
241                         in_length, 
242                         decomp_filter, 
243                         out_data[2 * i], 
244                         out_data[(2 * i) + 1]);
245
246                 in_data = out_data[2 * i];
247         }
248         return 0;
249 }
250
251 int DenoiseEffect::tree_copy(double **output, 
252         double **input, 
253         int length, 
254         int levels)
255 {
256         register int i, j, k, l, m;
257
258         for(i = 0, k = 1; k < levels; i++, k++)
259         {
260                 length /= 2;
261                 l = 2 * i;
262                 m = l + 1;
263
264                 for(j = 0; j < length + 5; j++)
265                 {
266                         output[l][j] = 0.0;
267                         output[m][j] = input[m][j];
268                 }
269         }
270
271         length /= 2;
272         l = 2 * i;
273         m = l + 1;
274
275         for(j = 0; j < length + 5; j++)
276         {
277                 output[l][j] = input[l][j];
278                 output[m][j] = input[m][j];
279         }
280         return 0;
281 }
282
283 int DenoiseEffect::threshold(int window_size, double gammas, int levels)
284 {
285         int i, j;
286         double threshold, cv, cvb, abs_coeff_r;
287         double *coeff_r, *coeff_l;
288         int length;
289
290         for(i = 0; i < levels; i++) 
291         {
292                 length = (window_size >> (i + 1)) + 5;
293                 threshold = sqrt(2 * log(length) / log(2)) * gammas / sqrt(length);
294
295                 for(j = 0; j < length; j++) 
296                 {
297                         coeff_r = &(ex_coeff_r->values[(2 * i) + 1][j]);
298                         coeff_l = &(ex_coeff_rn->values[(2 * i) + 1][j]);
299
300                         cv = SGN(*coeff_r);
301                         abs_coeff_r = fabs(*coeff_r);
302                         cvb = abs_coeff_r - threshold;
303                         cv *= cvb;
304
305                         if(abs_coeff_r > threshold) 
306                         {
307                                 *coeff_r = cv;
308                                 *coeff_l = 0.0;
309                         }
310                         else 
311                         {
312                                 *coeff_l = *coeff_r;
313                                 *coeff_r = 0.0;
314                         }
315                 }
316         }
317         return 0;
318 }
319
320
321 double DenoiseEffect::dot_product_even(double *data, double *filter, int filtlen)
322 {
323         static int i;
324         static double sum;
325
326         sum = 0.0;
327         for(i = 0; i < filtlen; i += 2) sum += *data-- * filter[i];
328         return sum;
329 }
330
331
332 double DenoiseEffect::dot_product_odd(double *data, double *filter, int filtlen)
333 {
334         static int i;
335         static double sum;
336
337         sum = 0.0;
338         for(i = 1; i < filtlen; i += 2) sum += *data-- * filter[i];
339         return sum;
340 }
341
342 int DenoiseEffect::convolve_int_2(double *input_sequence, 
343         int64_t length, 
344         double *filter, 
345         int filtlen, 
346         int sum_output, 
347         double *output_sequence)
348 // insert zeros between each element of the input sequence and
349 // convolve with the filter to interpolate the data
350 {
351         register int i, j;
352         int endpoint = length + filtlen - 2;
353
354         if (sum_output)
355         {
356 // summation with previous convolution
357 // every other dot product interpolates the data
358                 for(i = (filtlen / 2) - 1, j = (filtlen / 2); i < endpoint; i++, j++)
359                 {
360                         *output_sequence++ += dot_product_odd(input_sequence + i, filter, filtlen);
361                         *output_sequence++ += dot_product_even(input_sequence + j, filter, filtlen);
362                 }
363
364                 *output_sequence++ += dot_product_odd(input_sequence + i, filter, filtlen);
365         }
366         else
367         {
368 // first convolution of pair
369 // every other dot product interpolates the data
370                 for(i = (filtlen / 2) - 1, j = (filtlen / 2); i < endpoint; i++, j++)
371                 {
372                         *output_sequence++ = dot_product_odd(input_sequence + i, filter, filtlen);
373                         *output_sequence++ = dot_product_even(input_sequence + j, filter, filtlen);
374                 }
375
376                 *output_sequence++ = dot_product_odd(input_sequence + i, filter, filtlen);
377         }
378         return 0;
379 }
380
381
382 int64_t DenoiseEffect::reconstruct_branches(double *in_low, 
383         double *in_high, 
384         int64_t in_length,
385         WaveletFilters *recon_filter, 
386         double *output)
387 {
388 // take input data and filters and form two branches of half the
389 // original length. length of branches is returned
390         convolve_int_2(in_low, in_length, recon_filter->h, 
391                                         recon_filter->length, 0, output);
392         convolve_int_2(in_high, in_length, recon_filter->g, 
393                                         recon_filter->length, 1, output);
394         return in_length * 2;
395 }
396
397 int DenoiseEffect::wavelet_reconstruction(double **in_data, 
398         int64_t in_length, 
399         double *out_data)
400 {
401         double *output;
402         int i;
403
404         in_length = in_length >> levels;
405 // destination of all but last branch reconstruction is the next
406 // higher intermediate approximation
407         for(i = levels - 1; i > 0; i--)
408         {
409                 output = in_data[2 * (i - 1)];
410                 in_length = reconstruct_branches(in_data[2 * i], 
411                         in_data[(2 * i) + 1],
412                         in_length, 
413                         recon_filter, 
414                         output);
415         }
416
417 // destination of the last branch reconstruction is the output data
418         reconstruct_branches(in_data[0], 
419                 in_data[1], 
420                 in_length, 
421                 recon_filter, 
422                 out_data);
423
424         return 0;
425 }
426
427 void DenoiseEffect::process_window()
428 {
429         int i, j;
430         for(j = 0; j < iterations; j++)
431         {
432                 wavelet_decomposition(dsp_in, window_size, ex_coeff_d->values);
433
434                 tree_copy(ex_coeff_r->values, ex_coeff_d->values, window_size, levels);
435                 tree_copy(ex_coeff_rn->values, ex_coeff_d->values, window_size, levels);
436
437 // qualify coeffs
438 //printf("DenoiseEffect::process_window %f\n", config.level);
439                 threshold(window_size, config.level * 10.0, levels);
440
441                 wavelet_reconstruction(ex_coeff_r->values, window_size, dsp_iteration);
442                 wavelet_reconstruction(ex_coeff_rn->values, window_size, dsp_in);
443
444                 for(i = 0; i < window_size; i++)
445                         dsp_out[i] += dsp_iteration[i];
446         }
447 }
448
449
450
451
452 int DenoiseEffect::process_realtime(int64_t size, Samples *input_ptr, Samples *output_ptr)
453 {
454         load_configuration();
455
456         if(!initialized)
457         {
458                 int64_t size_factor = (int)(pow(2, levels));
459                 dsp_in = new double[window_size * size_factor];
460                 dsp_out = new double[window_size * 2];
461                 dsp_iteration = new double[window_size * 2];
462
463
464                 ex_coeff_d = new Tree(window_size, levels);
465                 ex_coeff_r = new Tree(window_size, levels);
466                 ex_coeff_rn = new Tree(window_size, levels);
467                 wave_coeff_d = new WaveletCoeffs(alpha, beta);
468                 wave_coeff_r = new WaveletCoeffs(alpha, beta);
469                 decomp_filter = new WaveletFilters(wave_coeff_d, DECOMP);
470                 recon_filter = new WaveletFilters(wave_coeff_r, RECON);
471                 in_scale = 65535 / sqrt(window_size) / iterations;
472                 out_scale = output_level / 65535 * sqrt(window_size);
473                 initialized = 1;
474         }
475         
476 // Append input buffer
477         if(input_size + size > input_allocation)
478         {
479                 double *new_input = new double[input_size + size];
480                 if(input_buffer)
481                 {
482                         memcpy(new_input, input_buffer, sizeof(double) * input_size);
483                         delete [] input_buffer;
484                 }
485                 input_buffer = new_input;
486                 input_allocation = input_size + size;
487         }
488         memcpy(input_buffer + input_size, 
489                 input_ptr->get_data(), 
490                 size * sizeof(double));
491         input_size += size;
492
493
494 // Have enough to do some windows
495         while(input_size >= window_size)
496         {
497 // Load dsp_in
498                 for(int i = 0; i < window_size; i++)
499                 {
500                         dsp_in[i] = input_buffer[i] * in_scale;
501                 }
502                 bzero(dsp_out, sizeof(double) * window_size);
503
504
505
506
507
508
509 // First window produces garbage
510                 if(!first_window)
511                         process_window();
512                 first_window = 0;
513
514
515
516
517
518
519 // Crossfade into the output buffer
520                 int64_t new_allocation = output_size + window_size;
521                 if(new_allocation > output_allocation)
522                 {
523                         double *new_output = new double[new_allocation];
524
525                         if(output_buffer)
526                         {
527                                 memcpy(new_output, output_buffer, sizeof(double) * output_size);
528 //printf("CrossfadeFFT::process_fifo 1 %p\n", output_buffer);
529                                 delete [] output_buffer;
530 //printf("CrossfadeFFT::process_fifo 2\n");
531                         }
532                         output_buffer = new_output;
533                         output_allocation = new_allocation;
534                 }
535
536                 if(output_size >= WINDOW_BORDER)
537                 {
538                         for(int i = 0, j = output_size - WINDOW_BORDER; 
539                                 i < WINDOW_BORDER; 
540                                 i++, j++)
541                         {
542                                 double src_level = (double)i / WINDOW_BORDER;
543                                 double dst_level = (double)(WINDOW_BORDER - i) / WINDOW_BORDER;
544                                 output_buffer[j] = output_buffer[j] * dst_level + out_scale * dsp_out[i] * src_level;
545                         }
546
547                         for(int i = 0; i < window_size - WINDOW_BORDER; i++)
548                                 output_buffer[output_size + i] = dsp_out[WINDOW_BORDER + i] * out_scale;
549                         output_size += window_size - WINDOW_BORDER;
550                 }
551                 else
552                 {
553 // First buffer has no crossfade
554                         memcpy(output_buffer + output_size, 
555                                 dsp_out, 
556                                 sizeof(double) * window_size);
557                         output_size += window_size;
558                 }
559
560
561 // Shift input buffer forward
562                 for(int i = window_size - WINDOW_BORDER, j = 0; 
563                         i < input_size; 
564                         i++, j++)
565                         input_buffer[j] = input_buffer[i];
566                 input_size -= window_size - WINDOW_BORDER;
567         }
568
569
570 // Have enough to send to output
571         if(output_size - WINDOW_BORDER >= size)
572         {
573                 memcpy(output_ptr->get_data(), output_buffer, sizeof(double) * size);
574                 for(int i = size, j = 0; i < output_size; i++, j++)
575                         output_buffer[j] = output_buffer[i];
576                 output_size -= size;
577         }
578         else
579         {
580 //printf("DenoiseEffect::process_realtime 1\n");
581                 bzero(output_ptr->get_data(), sizeof(double) * size);
582         }
583
584         return 0;
585 }
586
587
588
589
590
591
592
593 Tree::Tree(int input_length, int levels)
594 {
595         this->input_length = input_length;
596         this->levels = levels;
597         int i, j;
598
599 // create decomposition tree
600         values = new double*[2 * levels];
601         j = input_length;
602         for (i = 0; i < levels; i++)
603         {
604                 j /= 2;
605                 if (j == 0)
606                 {
607                         levels = i;
608                         continue;
609                 }
610                 values[2 * i] = new double[j + 5];
611                 values[2 * i + 1] = new double[j + 5];
612         }
613 }
614
615 Tree::~Tree()
616 {
617         int i;
618
619         for (i = 2 * levels - 1; i >= 0; i--)
620                 delete values[i];
621
622         delete values;
623 }
624
625 WaveletCoeffs::WaveletCoeffs(double alpha, double beta)
626 {
627         int i;
628         double tcosa = cos(alpha);
629         double tcosb = cos(beta);
630         double tsina = sin(alpha);
631         double tsinb = sin(beta);
632
633 // calculate first two wavelet coefficients  a = a(-2) and b = a(-1)
634         values[0] = ((1.0 + tcosa + tsina) * (1.0 - tcosb - tsinb)
635                                         + 2.0 * tsinb * tcosa) / 4.0;
636         values[1] = ((1.0 - tcosa + tsina) * (1.0 + tcosb - tsinb)
637                                         - 2.0 * tsinb * tcosa) / 4.0;
638
639         tcosa = cos(alpha - beta);
640         tsina = sin(alpha - beta);
641
642 // calculate last four wavelet coefficients  c = a(0), d = a(1), 
643 // e = a(2), and f = a(3)
644         values[2]  = (1.0 + tcosa + tsina) / 2.0;
645         values[3]  = (1.0 + tcosa - tsina) / 2.0;
646         values[4]  = 1 - values[0] - values[2];
647         values[5]  = 1 - values[1] - values[3];
648
649 // zero out very small coefficient values caused by truncation error
650         for (i = 0; i < 6; i++)
651         {
652                 if (fabs(values[i]) < 1.0e-15) values[i] = 0.0;
653         }
654 }
655
656 WaveletCoeffs::~WaveletCoeffs()
657 {
658 }
659
660
661 WaveletFilters::WaveletFilters(WaveletCoeffs *wave_coeffs, wavetype transform)
662 {
663         int i, j, k;
664
665 // find the first non-zero wavelet coefficient
666         i = 0;
667         while(wave_coeffs->values[i] == 0.0) i++;
668
669 // find the last non-zero wavelet coefficient
670         j = 5;
671         while(wave_coeffs->values[j] == 0.0) j--;
672
673 // Form the decomposition filters h~ and g~ or the reconstruction
674 // filters h and g.  The division by 2 in the construction
675 // of the decomposition filters is for normalization.
676         length = j - i + 1;
677         for(k = 0; k < length; ++i, --j, ++k)
678         {
679                 if (transform == DECOMP)
680                 {
681                         h[k] = wave_coeffs->values[j] / 2.0;
682                         g[k] = (double) (((i & 0x01) * 2) - 1) * wave_coeffs->values[i] / 2.0;
683                 }
684                 else
685                 {
686                         h[k] = wave_coeffs->values[i];
687                         g[k] = (double) (((j & 0x01) * 2) - 1) * wave_coeffs->values[j];
688                 }
689         }
690
691 // clear out the additional array locations, if any
692         while (k < 6)
693         {
694                 h[k] = g[k] = 0.0;
695                 ++k;
696         }
697 }
698
699 WaveletFilters::~WaveletFilters()
700 {
701 }
702
703
704
705
706
707
708
709
710
711 DenoiseConfig::DenoiseConfig()
712 {
713         level = 1.0;
714 }
715
716 void DenoiseConfig::copy_from(DenoiseConfig &that)
717 {
718         level = that.level;
719 }
720
721 int DenoiseConfig::equivalent(DenoiseConfig &that)
722 {
723         return EQUIV(level, that.level);
724 }
725
726 void DenoiseConfig::interpolate(DenoiseConfig &prev, 
727         DenoiseConfig &next, 
728         int64_t prev_frame, 
729         int64_t next_frame, 
730         int64_t current_frame)
731 {
732         double next_scale = (double)(current_frame - prev_frame) / (next_frame - prev_frame);
733         double prev_scale = (double)(next_frame - current_frame) / (next_frame - prev_frame);
734         this->level = prev.level * prev_scale + next.level * next_scale;
735 }
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755 DenoiseWindow::DenoiseWindow(DenoiseEffect *plugin)
756  : PluginClientWindow(plugin, 
757         150, 
758         50, 
759         150, 
760         50,
761         0)
762 {
763         this->plugin = plugin;
764 }
765
766 void DenoiseWindow::create_objects()
767 {
768         int x = 10, y = 10;
769         
770         add_subwindow(new BC_Title(x, y, _("Level:")));
771         x += 70;
772         add_subwindow(scale = new DenoiseLevel(plugin, x, y));
773         show_window();
774         flush();
775 }
776
777
778
779 void DenoiseWindow::update()
780 {
781         scale->update(plugin->config.level);
782 }
783
784
785
786
787
788
789
790
791
792
793
794
795 DenoiseLevel::DenoiseLevel(DenoiseEffect *plugin, int x, int y)
796  : BC_FPot(x, y, (float)plugin->config.level, 0, 1.0)
797 {
798         this->plugin = plugin;
799         set_precision(0.01);
800 }
801
802 int DenoiseLevel::handle_event()
803 {
804         plugin->config.level = get_value();
805         plugin->send_configure_change();
806         return 1;
807 }
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823