]> git.sesse.net Git - vlc/blobdiff - modules/audio_filter/equalizer.c
Fix memleak in audio equalizer.
[vlc] / modules / audio_filter / equalizer.c
index ad099b15608d51d759d1edb85ea01a9e8a180905..a05c34a10217b825c40a884eb9388487e3e673b9 100644 (file)
@@ -1,7 +1,7 @@
 /*****************************************************************************
  * equalizer.c:
  *****************************************************************************
- * Copyright (C) 2004 VideoLAN
+ * Copyright (C) 2004, 2006 the VideoLAN team
  * $Id$
  *
  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 /*****************************************************************************
  * Preamble
  *****************************************************************************/
-#include <stdlib.h>                                      /* malloc(), free() */
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
 #include <math.h>
 
-#include <vlc/vlc.h>
+#include <vlc_common.h>
+#include <vlc_plugin.h>
 
-#include <vlc/aout.h>
-#include "aout_internal.h"
+#include "vlc_aout.h"
 
+#include "equalizer_presets.h"
 /* TODO:
  *  - add tables for other rates ( 22500, 11250, ...)
  *  - optimize a bit (you can hardly do slower ;)
@@ -49,41 +54,37 @@ static int  Open ( vlc_object_t * );
 static void Close( vlc_object_t * );
 
 #define PRESET_TEXT N_( "Equalizer preset" )
-#define PRESET_LONGTEXT PRESET_TEXT
+#define PRESET_LONGTEXT N_("Preset to use for the equalizer." )
 
 #define BANDS_TEXT N_( "Bands gain")
-#define BANDS_LONGTEXT N_( "Override preset bands gain in dB (-20 ... 20)" )
+#define BANDS_LONGTEXT N_( \
+         "Don't use presets, but manually specified bands. You need to " \
+         "provide 10 values between -20dB and 20dB, separated by spaces, " \
+         "e.g. \"0 2 4 2 0 -2 -4 -2 0\"." )
 
 #define TWOPASS_TEXT N_( "Two pass" )
-#define TWOPASS_LONGTEXT N_( "Filter twice the audio" )
+#define TWOPASS_LONGTEXT N_( "Filter the audio twice. This provides a more "  \
+         "intense effect.")
 
 #define PREAMP_TEXT N_("Global gain" )
-#define PREAMP_LONGTEXT N_("Set the global gain in dB (-20 ... 20)" )
-
-static char *preset_list[] = {
-    "flat", "classical", "club", "dance", "fullbass", "fullbasstreeble",
-    "fulltreeble", "headphones","largehall", "live", "party", "pop", "reggae",
-    "rock", "ska", "soft", "softrock", "techno"
-};
-static char *preset_list_text[] = {
-    N_("Flat"), N_("Classical"), N_("Club"), N_("Dance"), N_("Full bass"),
-    N_("Full bass and treeble"), N_("Full treeble"), N_("Headphones"),
-    N_("Large Hall"), N_("Live"), N_("Party"), N_("Pop"), N_("Reggae"),
-    N_("Rock"), N_("Ska"), N_("Soft"), N_("Soft rock"), N_("Techno"),
-};
+#define PREAMP_LONGTEXT N_("Set the global gain in dB (-20 ... 20)." )
 
 vlc_module_begin();
-    set_description( _("Equalizer 10 bands") );
+    set_description( N_("Equalizer with 10 bands") );
+    set_shortname( N_("Equalizer" ) );
     set_capability( "audio filter", 0 );
+    set_category( CAT_AUDIO );
+    set_subcategory( SUBCAT_AUDIO_AFILTER );
+
     add_string( "equalizer-preset", "flat", NULL, PRESET_TEXT,
-                PRESET_LONGTEXT, VLC_TRUE );
+                PRESET_LONGTEXT, false );
         change_string_list( preset_list, preset_list_text, 0 );
     add_string( "equalizer-bands", NULL, NULL, BANDS_TEXT,
-                BANDS_LONGTEXT, VLC_TRUE );
+                BANDS_LONGTEXT, true );
     add_bool( "equalizer-2pass", 0, NULL, TWOPASS_TEXT,
-              TWOPASS_LONGTEXT, VLC_TRUE );
-    add_float( "equalizer-preamp", 0.0, NULL, PREAMP_TEXT,
-               PREAMP_LONGTEXT, VLC_TRUE );
+              TWOPASS_LONGTEXT, true );
+    add_float( "equalizer-preamp", 12.0, NULL, PREAMP_TEXT,
+               PREAMP_LONGTEXT, true );
     set_callbacks( Open, Close );
     add_shortcut( "equalizer" );
 vlc_module_end();
@@ -91,7 +92,6 @@ vlc_module_end();
 /*****************************************************************************
  * Local prototypes
  *****************************************************************************/
-#define EQZ_BANDS_MAX 10
 typedef struct aout_filter_sys_t
 {
     /* Filter static config */
@@ -102,12 +102,12 @@ typedef struct aout_filter_sys_t
 
     float f_newpreamp;
     char *psz_newbands;
-    vlc_bool_t b_first;
+    bool b_first;
 
     /* Filter dyn config */
     float *f_amp;   /* Per band amp */
     float f_gamp;   /* Global preamp */
-    vlc_bool_t b_2eqz;
+    bool b_2eqz;
 
     /* Filter state */
     float x[32][2];
@@ -124,7 +124,7 @@ static void DoWork( aout_instance_t *, aout_filter_t *,
 
 #define EQZ_IN_FACTOR (0.25)
 static int  EqzInit( aout_filter_t *, int );
-static void EqzFilter( aout_instance_t *,aout_filter_t *, float *, float *,
+static void EqzFilter( aout_filter_t *, float *, float *,
                         int, int );
 static void EqzClean( aout_filter_t * );
 
@@ -144,21 +144,31 @@ static int Open( vlc_object_t *p_this )
 {
     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
     aout_filter_sys_t *p_sys;
+    bool         b_fit = true;
 
     if( p_filter->input.i_format != VLC_FOURCC('f','l','3','2' ) ||
         p_filter->output.i_format != VLC_FOURCC('f','l','3','2') )
     {
-        msg_Warn( p_filter, "Bad input or output format" );
-        return VLC_EGENERIC;
+        b_fit = false;
+        p_filter->input.i_format = VLC_FOURCC('f','l','3','2');
+        p_filter->output.i_format = VLC_FOURCC('f','l','3','2');
+        msg_Warn( p_filter, "bad input or output format" );
     }
     if ( !AOUT_FMTS_SIMILAR( &p_filter->input, &p_filter->output ) )
     {
+        b_fit = false;
+        memcpy( &p_filter->output, &p_filter->input,
+                sizeof(audio_sample_format_t) );
         msg_Warn( p_filter, "input and output formats are not similar" );
+    }
+
+    if ( ! b_fit )
+    {
         return VLC_EGENERIC;
     }
 
     p_filter->pf_do_work = DoWork;
-    p_filter->b_in_place = VLC_TRUE;
+    p_filter->b_in_place = true;
 
     /* Allocate structure */
     p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );
@@ -189,10 +199,11 @@ static void Close( vlc_object_t *p_this )
 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
                     aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
 {
+    VLC_UNUSED(p_aout);
     p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
     p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes;
 
-    EqzFilter( p_aout, p_filter, (float*)p_out_buf->p_buffer,
+    EqzFilter( p_filter, (float*)p_out_buf->p_buffer,
                (float*)p_in_buf->p_buffer, p_in_buf->i_nb_samples,
                aout_FormatNbChannels( &p_filter->input ) );
 }
@@ -248,130 +259,6 @@ static const eqz_config_t eqz_config_48000_10b =
     }
 };
 
-typedef struct
-{
-    char *psz_name;
-    int  i_band;
-    float f_preamp;
-    float f_amp[EQZ_BANDS_MAX];
-} eqz_preset_t;
-
-static const eqz_preset_t eqz_preset_flat_10b=
-{
-    "flat", 10, 12.0,
-    { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 },
-};
-static const eqz_preset_t eqz_preset_classical_10b=
-{
-    "classical", 10, 12.0,
-    { -1.11022e-15, -1.11022e-15, -1.11022e-15, -1.11022e-15, -1.11022e-15, -1.11022e-15, -7.2, -7.2, -7.2, -9.6 }
-};
-static const eqz_preset_t eqz_preset_club_10b=
-{
-    "club", 10, 6.0,
-    { -1.11022e-15, -1.11022e-15, 8, 5.6, 5.6, 5.6, 3.2, -1.11022e-15, -1.11022e-15, -1.11022e-15 }
-};
-static const eqz_preset_t eqz_preset_dance_10b=
-{
-    "dance", 10, 5.0,
-    { 9.6, 7.2, 2.4, -1.11022e-15, -1.11022e-15, -5.6, -7.2, -7.2, -1.11022e-15, -1.11022e-15 }
-};
-static const eqz_preset_t eqz_preset_fullbass_10b=
-{
-    "fullbass", 10, 5.0,
-    { -8, 9.6, 9.6, 5.6, 1.6, -4, -8, -10.4, -11.2, -11.2  }
-};
-static const eqz_preset_t eqz_preset_fullbasstreeble_10b=
-{
-    "fullbasstreeble", 10, 4.0,
-    { 7.2, 5.6, -1.11022e-15, -7.2, -4.8, 1.6, 8, 11.2, 12, 12 }
-};
-
-static const eqz_preset_t eqz_preset_fulltreeble_10b=
-{
-    "fulltreeble", 10, 3.0,
-    { -9.6, -9.6, -9.6, -4, 2.4, 11.2, 16, 16, 16, 16.8 }
-};
-static const eqz_preset_t eqz_preset_headphones_10b=
-{
-    "headphones", 10, 4.0,
-    { 4.8, 11.2, 5.6, -3.2, -2.4, 1.6, 4.8, 9.6, 12.8, 14.4 }
-};
-static const eqz_preset_t eqz_preset_largehall_10b=
-{
-    "largehall", 10, 5.0,
-    { 10.4, 10.4, 5.6, 5.6, -1.11022e-15, -4.8, -4.8, -4.8, -1.11022e-15, -1.11022e-15 }
-};
-static const eqz_preset_t eqz_preset_live_10b=
-{
-    "live", 10, 7.0,
-    { -4.8, -1.11022e-15, 4, 5.6, 5.6, 5.6, 4, 2.4, 2.4, 2.4 }
-};
-static const eqz_preset_t eqz_preset_party_10b=
-{
-    "party", 10, 6.0,
-    { 7.2, 7.2, -1.11022e-15, -1.11022e-15, -1.11022e-15, -1.11022e-15, -1.11022e-15, -1.11022e-15, 7.2, 7.2 }
-};
-static const eqz_preset_t eqz_preset_pop_10b=
-{
-    "pop", 10, 6.0,
-    { -1.6, 4.8, 7.2, 8, 5.6, -1.11022e-15, -2.4, -2.4, -1.6, -1.6 }
-};
-static const eqz_preset_t eqz_preset_reggae_10b=
-{
-    "reggae", 10, 8.0,
-    { -1.11022e-15, -1.11022e-15, -1.11022e-15, -5.6, -1.11022e-15, 6.4, 6.4, -1.11022e-15, -1.11022e-15, -1.11022e-15 }
-};
-static const eqz_preset_t eqz_preset_rock_10b=
-{
-    "rock", 10, 5.0,
-    { 8, 4.8, -5.6, -8, -3.2, 4, 8.8, 11.2, 11.2, 11.2 }
-};
-static const eqz_preset_t eqz_preset_ska_10b=
-{
-    "ska", 10, 6.0,
-    { -2.4, -4.8, -4, -1.11022e-15, 4, 5.6, 8.8, 9.6, 11.2, 9.6 }
-};
-static const eqz_preset_t eqz_preset_soft_10b=
-{
-    "soft", 10, 5.0,
-    { 4.8, 1.6, -1.11022e-15, -2.4, -1.11022e-15, 4, 8, 9.6, 11.2, 12 }
-};
-static const eqz_preset_t eqz_preset_softrock_10b=
-{
-    "softrock", 10, 7.0,
-    { 4, 4, 2.4, -1.11022e-15, -4, -5.6, -3.2, -1.11022e-15, 2.4, 8.8 }
-};
-static const eqz_preset_t eqz_preset_techno_10b=
-{
-    "techno", 10, 5.0,
-    { 8, 5.6, -1.11022e-15, -5.6, -4.8, -1.11022e-15, 8, 9.6, 9.6, 8.8 }
-};
-
-static const eqz_preset_t *eqz_preset_10b[] =
-{
-    &eqz_preset_flat_10b,
-    &eqz_preset_classical_10b,
-    &eqz_preset_club_10b,
-    &eqz_preset_dance_10b,
-    &eqz_preset_fullbass_10b,
-    &eqz_preset_fullbasstreeble_10b,
-    &eqz_preset_fulltreeble_10b,
-    &eqz_preset_headphones_10b,
-    &eqz_preset_largehall_10b,
-    &eqz_preset_live_10b,
-    &eqz_preset_party_10b,
-    &eqz_preset_pop_10b,
-    &eqz_preset_reggae_10b,
-    &eqz_preset_rock_10b,
-    &eqz_preset_ska_10b,
-    &eqz_preset_soft_10b,
-    &eqz_preset_softrock_10b,
-    &eqz_preset_techno_10b,
-    NULL
-};
-
-
 static inline float EqzConvertdB( float db )
 {
     /* Map it to gain,
@@ -409,7 +296,7 @@ static int EqzInit( aout_filter_t *p_filter, int i_rate )
     else
     {
         /* TODO compute the coeffs on the fly */
-        msg_Err( p_filter, "unsupported rate" );
+        msg_Err( p_filter, "rate not supported" );
         return VLC_EGENERIC;
     }
 
@@ -426,7 +313,7 @@ static int EqzInit( aout_filter_t *p_filter, int i_rate )
     }
 
     /* Filter dyn config */
-    p_sys->b_2eqz = VLC_FALSE;
+    p_sys->b_2eqz = false;
     p_sys->f_gamp = 1.0;
     p_sys->f_amp   = malloc( p_sys->i_band * sizeof(float) );
     for( i = 0; i < p_sys->i_band; i++ )
@@ -451,8 +338,10 @@ static int EqzInit( aout_filter_t *p_filter, int i_rate )
         }
     }
 
-    var_CreateGetString( p_aout,"equalizer-bands" );
-    var_CreateGetString( p_aout, "equalizer-preset" );
+    char *psz_tmp = var_CreateGetString( p_aout,"equalizer-bands" );
+    free( psz_tmp );
+    psz_tmp = var_CreateGetString( p_aout, "equalizer-preset" );
+    free( psz_tmp );
 
     p_sys->b_2eqz = var_CreateGetBool( p_aout, "equalizer-2pass" );
 
@@ -463,11 +352,11 @@ static int EqzInit( aout_filter_t *p_filter, int i_rate )
     var_Get( p_aout, "equalizer-bands", &val2 );
     var_Get( p_aout, "equalizer-preamp", &val3 );
 
-    p_sys->b_first = VLC_TRUE;
+    p_sys->b_first = true;
     PresetCallback( VLC_OBJECT( p_aout ), NULL, val1, val1, p_sys );
     BandsCallback(  VLC_OBJECT( p_aout ), NULL, val2, val2, p_sys );
     PreampCallback( VLC_OBJECT( p_aout ), NULL, val3, val3, p_sys );
-    p_sys->b_first = VLC_FALSE;
+    p_sys->b_first = false;
 
     /* Register preset bands (for intf) if : */
     /* We have no bands info --> the preset info must be given to the intf */
@@ -481,7 +370,8 @@ static int EqzInit( aout_filter_t *p_filter, int i_rate )
         strstr( p_sys->psz_newbands, val2.psz_string ) ) || !*val2.psz_string )
     {
         var_SetString( p_aout, "equalizer-bands", p_sys->psz_newbands );
-        var_SetFloat( p_aout, "equalizer-preamp", p_sys->f_newpreamp );
+        if( p_sys->f_newpreamp == p_sys->f_gamp )
+            var_SetFloat( p_aout, "equalizer-preamp", p_sys->f_newpreamp );
     }
 
     /* Add our own callbacks */
@@ -500,8 +390,7 @@ static int EqzInit( aout_filter_t *p_filter, int i_rate )
     return VLC_SUCCESS;
 }
 
-static void EqzFilter( aout_instance_t *p_aout,
-                       aout_filter_t *p_filter, float *out, float *in,
+static void EqzFilter( aout_filter_t *p_filter, float *out, float *in,
                        int i_samples, int i_channels )
 {
     aout_filter_sys_t *p_sys = p_filter->p_sys;
@@ -584,6 +473,7 @@ static void EqzClean( aout_filter_t *p_filter )
 static int PresetCallback( vlc_object_t *p_this, char const *psz_cmd,
                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 {
+    VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
     aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
     aout_instance_t *p_aout = (aout_instance_t *)p_this;
 
@@ -604,12 +494,15 @@ static int PresetCallback( vlc_object_t *p_this, char const *psz_cmd,
                 p_sys->f_gamp *= pow( 10, eqz_preset_10b[i]->f_preamp / 20.0 );
                 for( j = 0; j < p_sys->i_band; j++ )
                 {
+                    lldiv_t div;
                     p_sys->f_amp[j] = EqzConvertdB(
                                         eqz_preset_10b[i]->f_amp[j] );
-                    sprintf( psz_newbands, "%s %f", psz_newbands,
-                                         eqz_preset_10b[i]->f_amp[j] );
+                    div = lldiv( eqz_preset_10b[i]->f_amp[j] * 10000000,
+                                 10000000 );
+                    sprintf( psz_newbands, "%s %"PRId64".%07u", psz_newbands,
+                                      (int64_t)div.quot, (unsigned int) div.rem );
                 }
-                if( p_sys->b_first == VLC_FALSE )
+                if( p_sys->b_first == false )
                 {
                     var_SetString( p_aout, "equalizer-bands", psz_newbands );
                     var_SetFloat( p_aout, "equalizer-preamp",
@@ -637,6 +530,7 @@ static int PresetCallback( vlc_object_t *p_this, char const *psz_cmd,
 static int PreampCallback( vlc_object_t *p_this, char const *psz_cmd,
                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 {
+    VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
     aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
 
     if( newval.f_float < -20.0 )
@@ -651,31 +545,36 @@ static int PreampCallback( vlc_object_t *p_this, char const *psz_cmd,
 static int BandsCallback( vlc_object_t *p_this, char const *psz_cmd,
                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 {
+    VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
     aout_filter_sys_t *p_sys = (aout_filter_sys_t *)p_data;
     char *psz_bands = newval.psz_string;
+    char *psz_next;
+    char *p = psz_bands;
+    int i;
 
     /* Same thing for bands */
-    if( *psz_bands )
+    for( i = 0; i < p_sys->i_band; i++ )
     {
-        char *p = psz_bands, *p_next;
-        int i;
+        float f;
 
-        for( i = 0; i < p_sys->i_band; i++ )
-        {
-            /* Read dB -20/20 */
+        if( *psz_bands == '\0' )
+            break;
+
+        /* Read dB -20/20 */
 #ifdef HAVE_STRTOF
-            float f = strtof( p, &p_next );
+        f = strtof( p, &psz_next );
 #else
-            float f = (float) strtod( p, &p_next );
+        f = (float)strtod( p, &psz_next );
 #endif
-            if( !p_next || p_next == p ) break; /* strtof() failed */
+        if( psz_next == p )
+            break; /* no conversion */
 
-            p_sys->f_amp[i] = EqzConvertdB( f );
+        p_sys->f_amp[i] = EqzConvertdB( f );
 
-            if( !*p ) break; /* end of line */
-            p=p_next+1;
-        }
+        if( *psz_next == '\0' )
+            break; /* end of line */
+        p = &psz_next[1];
     }
-
     return VLC_SUCCESS;
 }
+