libaf/af_sub.c

   1 /*
   2  * Copyright (C) 2002 Anders Johansson ajh@watri.uwa.edu.au
   3  *
   4  * This file is part of MPlayer.
   5  *
   6  * MPlayer 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  * MPlayer 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 along
  17  * with MPlayer; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19  */
  20
  21 /* This filter adds a sub-woofer channels to the audio stream by
  22    averaging the left and right channel and low-pass filter them. The
  23    low-pass filter is implemented as a 4th order IIR Butterworth
  24    filter, with a variable cutoff frequency between 10 and 300 Hz. The
  25    filter gives 24dB/octave attenuation. There are two runtime
  26    controls one for setting which channel to insert the sub-audio into
  27    called AF_CONTROL_SUB_CH and one for setting the cutoff frequency
  28    called AF_CONTROL_SUB_FC.
  29 */
  30
  31 #include <stdio.h>
  32 #include <stdlib.h>
  33 #include <string.h>
  34
  35 #include "af.h"
  36 #include "dsp.h"
  37
  38 // Q value for low-pass filter
  39 #define Q 1.0
  40
  41 // Analog domain biquad section
  42 typedef struct{
  43   float a[3];           // Numerator coefficients
  44   float b[3];           // Denominator coefficients
  45 } biquad_t;
  46
  47 // S-parameters for designing 4th order Butterworth filter
  48 static biquad_t sp[2] = {{{1.0,0.0,0.0},{1.0,0.765367,1.0}},
  49                          {{1.0,0.0,0.0},{1.0,1.847759,1.0}}};
  50
  51 // Data for specific instances of this filter
  52 typedef struct af_sub_s
  53 {
  54   float w[2][4];        // Filter taps for low-pass filter
  55   float q[2][2];        // Circular queues
  56   float fc;             // Cutoff frequency [Hz] for low-pass filter
  57   float k;              // Filter gain;
  58   int ch;               // Channel number which to insert the filtered data
  59
  60 }af_sub_t;
  61
  62 // Initialization and runtime control
  63 static int control(struct af_instance_s* af, int cmd, void* arg)
  64 {
  65   af_sub_t* s   = af->setup;
  66
  67   switch(cmd){
  68   case AF_CONTROL_REINIT:{
  69     // Sanity check
  70     if(!arg) return AF_ERROR;
  71
  72     af->data->rate   = ((af_data_t*)arg)->rate;
  73     af->data->nch    = max(s->ch+1,((af_data_t*)arg)->nch);
  74     af->data->format = AF_FORMAT_FLOAT_NE;
  75     af->data->bps    = 4;
  76
  77     // Design low-pass filter
  78     s->k = 1.0;
  79     if((-1 == af_filter_szxform(sp[0].a, sp[0].b, Q, s->fc,
  80        (float)af->data->rate, &s->k, s->w[0])) ||
  81        (-1 == af_filter_szxform(sp[1].a, sp[1].b, Q, s->fc,
  82        (float)af->data->rate, &s->k, s->w[1])))
  83       return AF_ERROR;
  84     return af_test_output(af,(af_data_t*)arg);
  85   }
  86   case AF_CONTROL_COMMAND_LINE:{
  87     int   ch=5;
  88     float fc=60.0;
  89     sscanf(arg,"%f:%i", &fc , &ch);
  90     if(AF_OK != control(af,AF_CONTROL_SUB_CH | AF_CONTROL_SET, &ch))
  91       return AF_ERROR;
  92     return control(af,AF_CONTROL_SUB_FC | AF_CONTROL_SET, &fc);
  93   }
  94   case AF_CONTROL_SUB_CH | AF_CONTROL_SET: // Requires reinit
  95     // Sanity check
  96     if((*(int*)arg >= AF_NCH) || (*(int*)arg < 0)){
  97       mp_msg(MSGT_AFILTER, MSGL_ERR, "[sub] Subwoofer channel number must be between "
  98              " 0 and %i current value is %i\n", AF_NCH-1, *(int*)arg);
  99       return AF_ERROR;
 100     }
 101     s->ch = *(int*)arg;
 102     return AF_OK;
 103   case AF_CONTROL_SUB_CH | AF_CONTROL_GET:
 104     *(int*)arg = s->ch;
 105     return AF_OK;
 106   case AF_CONTROL_SUB_FC | AF_CONTROL_SET: // Requires reinit
 107     // Sanity check
 108     if((*(float*)arg > 300) || (*(float*)arg < 20)){
 109       mp_msg(MSGT_AFILTER, MSGL_ERR, "[sub] Cutoff frequency must be between 20Hz and"
 110              " 300Hz current value is %0.2f",*(float*)arg);
 111       return AF_ERROR;
 112     }
 113     // Set cutoff frequency
 114     s->fc = *(float*)arg;
 115     return AF_OK;
 116   case AF_CONTROL_SUB_FC | AF_CONTROL_GET:
 117     *(float*)arg = s->fc;
 118     return AF_OK;
 119   }
 120   return AF_UNKNOWN;
 121 }
 122
 123 // Deallocate memory
 124 static void uninit(struct af_instance_s* af)
 125 {
 126   if(af->data)
 127     free(af->data);
 128   if(af->setup)
 129     free(af->setup);
 130 }
 131
 132 #ifndef IIR
 133 #define IIR(in,w,q,out) { \
 134   float h0 = (q)[0]; \
 135   float h1 = (q)[1]; \
 136   float hn = (in) - h0 * (w)[0] - h1 * (w)[1];  \
 137   out = hn + h0 * (w)[2] + h1 * (w)[3];  \
 138   (q)[1] = h0; \
 139   (q)[0] = hn; \
 140 }
 141 #endif
 142
 143 // Filter data through filter
 144 static af_data_t* play(struct af_instance_s* af, af_data_t* data)
 145 {
 146   af_data_t*    c   = data;      // Current working data
 147   af_sub_t*     s   = af->setup; // Setup for this instance
 148   float*        a   = c->audio;  // Audio data
 149   int           len = c->len/4;  // Number of samples in current audio block
 150   int           nch = c->nch;    // Number of channels
 151   int           ch  = s->ch;     // Channel in which to insert the sub audio
 152   register int  i;
 153
 154   // Run filter
 155   for(i=0;i<len;i+=nch){
 156     // Average left and right
 157     register float x = 0.5 * (a[i] + a[i+1]);
 158     IIR(x * s->k, s->w[0], s->q[0], x);
 159     IIR(x , s->w[1], s->q[1], a[i+ch]);
 160   }
 161
 162   return c;
 163 }
 164
 165 // Allocate memory and set function pointers
 166 static int af_open(af_instance_t* af){
 167   af_sub_t* s;
 168   af->control=control;
 169   af->uninit=uninit;
 170   af->play=play;
 171   af->mul=1;
 172   af->data=calloc(1,sizeof(af_data_t));
 173   af->setup=s=calloc(1,sizeof(af_sub_t));
 174   if(af->data == NULL || af->setup == NULL)
 175     return AF_ERROR;
 176   // Set default values
 177   s->ch = 5;     // Channel nr 6
 178   s->fc = 60;    // Cutoff frequency 60Hz
 179   return AF_OK;
 180 }
 181
 182 // Description of this filter
 183 af_info_t af_info_sub = {
 184     "Audio filter for adding a sub-base channel",
 185     "sub",
 186     "Anders",
 187     "",
 188     AF_FLAGS_NOT_REENTRANT,
 189     af_open
 190 };