]> git.sesse.net Git - vlc/blobdiff - src/audio_output/filters.c
Do not include vlc_modules.h in vlc_common.h
[vlc] / src / audio_output / filters.c
index 7afe654444a3c85cfd1f35addea0ac8660cebe06..b5ceb86b96b23a9be9c26466a2524308e9f1d31a 100644 (file)
@@ -1,8 +1,8 @@
 /*****************************************************************************
  * filters.c : audio output filters management
  *****************************************************************************
- * Copyright (C) 2002 VideoLAN
- * $Id: filters.c,v 1.4 2002/08/14 00:23:59 massiot Exp $
+ * Copyright (C) 2002-2007 the VideoLAN team
+ * $Id$
  *
  * Authors: Christophe Massiot <massiot@via.ecp.fr>
  *
@@ -10,7 +10,7 @@
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
- * 
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  *
  * 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>                            /* calloc(), malloc(), free() */
-#include <string.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
 
-#include <vlc/vlc.h>
+#include <assert.h>
 
-#ifdef HAVE_ALLOCA_H
-#   include <alloca.h> 
-#endif
+#include <vlc_common.h>
+#include <vlc_dialog.h>
+#include <vlc_modules.h>
 
-#include "audio_output.h"
+#include <vlc_aout.h>
+#include <vlc_filter.h>
 #include "aout_internal.h"
+#include <libvlc.h>
+
+block_t *aout_FilterBufferNew( filter_t *p_filter, int size )
+{
+    (void) p_filter;
+    return block_Alloc( size );
+}
+
+/*****************************************************************************
+ * FindFilter: find an audio filter for a specific transformation
+ *****************************************************************************/
+static filter_t * FindFilter( aout_instance_t * p_aout,
+                              const audio_sample_format_t * p_input_format,
+                              const audio_sample_format_t * p_output_format )
+{
+    static const char typename[] = "audio filter";
+    filter_t * p_filter;
+
+    p_filter = vlc_custom_create( p_aout, sizeof(*p_filter),
+                                  VLC_OBJECT_GENERIC, typename );
+
+    if ( p_filter == NULL ) return NULL;
+    vlc_object_attach( p_filter, p_aout );
+
+    memcpy( &p_filter->fmt_in.audio, p_input_format,
+            sizeof(audio_sample_format_t) );
+    p_filter->fmt_in.i_codec = p_input_format->i_format;
+    memcpy( &p_filter->fmt_out.audio, p_output_format,
+            sizeof(audio_sample_format_t) );
+    p_filter->fmt_out.i_codec = p_output_format->i_format;
+    p_filter->pf_audio_buffer_new = aout_FilterBufferNew;
+
+    p_filter->p_module = module_need( p_filter, "audio filter", NULL, false );
+    if ( p_filter->p_module == NULL )
+    {
+        vlc_object_release( p_filter );
+        return NULL;
+    }
+
+    assert( p_filter->pf_audio_filter );
+    return p_filter;
+}
+
+/*****************************************************************************
+ * SplitConversion: split a conversion in two parts
+ *****************************************************************************
+ * Returns the number of conversions required by the first part - 0 if only
+ * one conversion was asked.
+ * Beware : p_output_format can be modified during this function if the
+ * developer passed SplitConversion( toto, titi, titi, ... ). That is legal.
+ * SplitConversion( toto, titi, toto, ... ) isn't.
+ *****************************************************************************/
+static int SplitConversion( const audio_sample_format_t * p_input_format,
+                            const audio_sample_format_t * p_output_format,
+                            audio_sample_format_t * p_middle_format )
+{
+    bool b_format =
+             (p_input_format->i_format != p_output_format->i_format);
+    bool b_rate = (p_input_format->i_rate != p_output_format->i_rate);
+    bool b_channels =
+        (p_input_format->i_physical_channels
+          != p_output_format->i_physical_channels)
+     || (p_input_format->i_original_channels
+          != p_output_format->i_original_channels);
+    int i_nb_conversions = b_format + b_rate + b_channels;
+
+    if ( i_nb_conversions <= 1 ) return 0;
+
+    memcpy( p_middle_format, p_output_format, sizeof(audio_sample_format_t) );
+
+    if ( i_nb_conversions == 2 )
+    {
+        if ( !b_format || !b_channels )
+        {
+            p_middle_format->i_rate = p_input_format->i_rate;
+            aout_FormatPrepare( p_middle_format );
+            return 1;
+        }
+
+        /* !b_rate */
+        p_middle_format->i_physical_channels
+             = p_input_format->i_physical_channels;
+        p_middle_format->i_original_channels
+             = p_input_format->i_original_channels;
+        aout_FormatPrepare( p_middle_format );
+        return 1;
+    }
+
+    /* i_nb_conversion == 3 */
+    p_middle_format->i_rate = p_input_format->i_rate;
+    aout_FormatPrepare( p_middle_format );
+    return 2;
+}
+
+static void ReleaseFilter( filter_t * p_filter )
+{
+    module_unneed( p_filter, p_filter->p_module );
+    vlc_object_release( p_filter );
+}
 
 /*****************************************************************************
  * aout_FiltersCreatePipeline: create a filters pipeline to transform a sample
  *                             format to another
  *****************************************************************************
- * TODO : allow the user to add/remove specific filters
+ * pi_nb_filters must be initialized before calling this function
  *****************************************************************************/
 int aout_FiltersCreatePipeline( aout_instance_t * p_aout,
-                                aout_filter_t ** pp_filters,
+                                filter_t ** pp_filters_start,
                                 int * pi_nb_filters,
-                                audio_sample_format_t * p_input_format,
-                                audio_sample_format_t * p_output_format )
+                                const audio_sample_format_t * p_input_format,
+                                const audio_sample_format_t * p_output_format )
 {
+    filter_t** pp_filters = pp_filters_start + *pi_nb_filters;
+    audio_sample_format_t temp_format;
+    int i_nb_conversions;
+
     if ( AOUT_FMTS_IDENTICAL( p_input_format, p_output_format ) )
     {
         msg_Dbg( p_aout, "no need for any filter" );
-        *pi_nb_filters = 0;
         return 0;
     }
 
-    pp_filters[0] = vlc_object_create( p_aout, sizeof(aout_filter_t) );
-    if ( pp_filters[0] == NULL )
+    aout_FormatsPrint( p_aout, "filter(s)", p_input_format, p_output_format );
+
+    if( *pi_nb_filters + 1 > AOUT_MAX_FILTERS )
     {
+        msg_Err( p_aout, "max filter reached (%d)", AOUT_MAX_FILTERS );
+        dialog_Fatal( p_aout, _("Audio filtering failed"),
+                      _("The maximum number of filters (%d) was reached."),
+                      AOUT_MAX_FILTERS );
         return -1;
     }
-    vlc_object_attach( pp_filters[0], p_aout );
 
     /* Try to find a filter to do the whole conversion. */
-    memcpy( &pp_filters[0]->input, p_input_format,
-            sizeof(audio_sample_format_t) );
-    memcpy( &pp_filters[0]->output, p_output_format,
-            sizeof(audio_sample_format_t) );
-    pp_filters[0]->p_module = module_Need( pp_filters[0], "audio filter",
-                                           NULL );
-    if ( pp_filters[0]->p_module != NULL )
+    pp_filters[0] = FindFilter( p_aout, p_input_format, p_output_format );
+    if ( pp_filters[0] != NULL )
     {
         msg_Dbg( p_aout, "found a filter for the whole conversion" );
-        *pi_nb_filters = 1;
+        ++*pi_nb_filters;
         return 0;
     }
 
-    /* Split the conversion : format | rate, or rate | format. */
-    pp_filters[0]->output.i_format = pp_filters[0]->input.i_format;
-    pp_filters[0]->p_module = module_Need( pp_filters[0], "audio filter",
-                                           NULL );
-    if ( pp_filters[0]->p_module == NULL )
+    /* We'll have to split the conversion. We always do the downmixing
+     * before the resampling, because the audio decoder can probably do it
+     * for us. */
+    i_nb_conversions = SplitConversion( p_input_format,
+                                        p_output_format, &temp_format );
+    if ( !i_nb_conversions )
     {
-        /* Then, start with the format conversion. */
-        memcpy( &pp_filters[0]->output, p_output_format,
-                sizeof(audio_sample_format_t) );
-        pp_filters[0]->output.i_rate = pp_filters[0]->input.i_rate;
-        pp_filters[0]->p_module = module_Need( pp_filters[0], "audio filter",
-                                               NULL );
-        if ( pp_filters[0]->p_module == NULL )
-        {
-            msg_Err( p_aout, "couldn't find a filter for any conversion" );
-            vlc_object_detach( pp_filters[0] );
-            vlc_object_destroy( pp_filters[0] );
-            return -1;
-        }
+        /* There was only one conversion to do, and we already failed. */
+        msg_Err( p_aout, "couldn't find a filter for the conversion "
+                "%4.4s -> %4.4s",
+                &p_input_format->i_format, &p_output_format->i_format );
+        return -1;
     }
 
-    /* Find a filter for the rest. */
-    pp_filters[1] = vlc_object_create( p_aout, sizeof(aout_filter_t) );
-    if ( pp_filters[1] == NULL )
+    pp_filters[0] = FindFilter( p_aout, p_input_format, &temp_format );
+    if ( pp_filters[0] == NULL && i_nb_conversions == 2 )
     {
-        vlc_object_detach( pp_filters[0] );
-        vlc_object_destroy( pp_filters[0] );
+        /* Try with only one conversion. */
+        SplitConversion( p_input_format, &temp_format, &temp_format );
+        pp_filters[0] = FindFilter( p_aout, p_input_format, &temp_format );
+    }
+    if ( pp_filters[0] == NULL )
+    {
+        msg_Err( p_aout,
+              "couldn't find a filter for the first part of the conversion" );
         return -1;
     }
-    vlc_object_attach( pp_filters[1], p_aout );
 
-    memcpy( &pp_filters[1]->input, &pp_filters[0]->output,
-            sizeof(audio_sample_format_t) );
-    memcpy( &pp_filters[1]->output, p_output_format,
-            sizeof(audio_sample_format_t) );
-    pp_filters[1]->p_module = module_Need( pp_filters[1], "audio filter",
-                                           NULL );
-    if ( pp_filters[1]->p_module == NULL )
+    /* We have the first stage of the conversion. Find a filter for
+     * the rest. */
+    if( *pi_nb_filters + 2 > AOUT_MAX_FILTERS )
     {
-        msg_Err( p_aout,
-                 "couldn't find a filter for the 2nd part of the conversion" );
-        vlc_object_detach( pp_filters[0] );
-        vlc_object_destroy( pp_filters[0] );
-        vlc_object_detach( pp_filters[1] );
-        vlc_object_destroy( pp_filters[1] );
+        ReleaseFilter( pp_filters[0] );
+        msg_Err( p_aout, "max filter reached (%d)", AOUT_MAX_FILTERS );
+        dialog_Fatal( p_aout, _("Audio filtering failed"),
+                      _("The maximum number of filters (%d) was reached."),
+                      AOUT_MAX_FILTERS );
         return -1;
     }
+    pp_filters[1] = FindFilter( p_aout, &pp_filters[0]->fmt_out.audio,
+                                p_output_format );
+    if ( pp_filters[1] == NULL )
+    {
+        /* Try to split the conversion. */
+        i_nb_conversions = SplitConversion( &pp_filters[0]->fmt_out.audio,
+                                           p_output_format, &temp_format );
+        if ( !i_nb_conversions )
+        {
+            ReleaseFilter( pp_filters[0] );
+            msg_Err( p_aout,
+              "couldn't find a filter for the second part of the conversion" );
+            return -1;
+        }
+        if( *pi_nb_filters + 3 > AOUT_MAX_FILTERS )
+        {
+            ReleaseFilter( pp_filters[0] );
+            msg_Err( p_aout, "max filter reached (%d)", AOUT_MAX_FILTERS );
+            dialog_Fatal( p_aout, _("Audio filtering failed"),
+                          _("The maximum number of filters (%d) was reached."),
+                          AOUT_MAX_FILTERS );
+            return -1;
+        }
+        pp_filters[1] = FindFilter( p_aout, &pp_filters[0]->fmt_out.audio,
+                                    &temp_format );
+        pp_filters[2] = FindFilter( p_aout, &temp_format,
+                                    p_output_format );
 
-    msg_Dbg( p_aout, "filter pipeline made of two filters" );
-    *pi_nb_filters = 2;
+        if ( pp_filters[1] == NULL || pp_filters[2] == NULL )
+        {
+            ReleaseFilter( pp_filters[0] );
+            if ( pp_filters[1] != NULL )
+            {
+                ReleaseFilter( pp_filters[1] );
+            }
+            if ( pp_filters[2] != NULL )
+            {
+                ReleaseFilter( pp_filters[2] );
+            }
+            msg_Err( p_aout,
+               "couldn't find filters for the second part of the conversion" );
+            return -1;
+        }
+        *pi_nb_filters += 3;
+        msg_Dbg( p_aout, "found 3 filters for the whole conversion" );
+    }
+    else
+    {
+        *pi_nb_filters += 2;
+        msg_Dbg( p_aout, "found 2 filters for the whole conversion" );
+    }
 
     return 0;
 }
@@ -134,16 +277,19 @@ int aout_FiltersCreatePipeline( aout_instance_t * p_aout,
  * aout_FiltersDestroyPipeline: deallocate a filters pipeline
  *****************************************************************************/
 void aout_FiltersDestroyPipeline( aout_instance_t * p_aout,
-                                  aout_filter_t ** pp_filters,
+                                  filter_t ** pp_filters,
                                   int i_nb_filters )
 {
     int i;
+    (void)p_aout;
 
     for ( i = 0; i < i_nb_filters; i++ )
     {
-        module_Unneed( pp_filters[i], pp_filters[i]->p_module );
-        vlc_object_detach( pp_filters[i] );
-        vlc_object_destroy( pp_filters[i] );
+        filter_t *p_filter = pp_filters[i];
+
+        module_unneed( p_filter, p_filter->p_module );
+        free( p_filter->p_owner );
+        vlc_object_release( p_filter );
     }
 }
 
@@ -152,72 +298,48 @@ void aout_FiltersDestroyPipeline( aout_instance_t * p_aout,
  *                          buffer allocations
  *****************************************************************************/
 void aout_FiltersHintBuffers( aout_instance_t * p_aout,
-                              aout_filter_t ** pp_filters,
+                              filter_t ** pp_filters,
                               int i_nb_filters, aout_alloc_t * p_first_alloc )
 {
     int i;
 
+    (void)p_aout; /* unused */
+
     for ( i = i_nb_filters - 1; i >= 0; i-- )
     {
-        aout_filter_t * p_filter = pp_filters[i];
-
-        int i_output_size = aout_FormatToByterate( &p_filter->output );
-        int i_input_size = aout_FormatToByterate( &p_filter->input );
+        filter_t * p_filter = pp_filters[i];
 
-        p_first_alloc->i_bytes_per_sec = __MAX( p_first_alloc->i_bytes_per_sec,
-                                                i_output_size );
+        int i_output_size = p_filter->fmt_out.audio.i_bytes_per_frame
+                         * p_filter->fmt_out.audio.i_rate * AOUT_MAX_INPUT_RATE
+                         / p_filter->fmt_out.audio.i_frame_length;
+        int i_input_size = p_filter->fmt_in.audio.i_bytes_per_frame
+                         * p_filter->fmt_in.audio.i_rate * AOUT_MAX_INPUT_RATE
+                         / p_filter->fmt_in.audio.i_frame_length;
 
-        if ( p_filter->b_in_place )
-        {
-            p_first_alloc->i_bytes_per_sec = __MAX(
-                                         p_first_alloc->i_bytes_per_sec,
-                                         i_input_size );
-        }
-        else
-        {
-            /* We're gonna need a buffer allocation. */
-            memcpy( &p_filter->output_alloc, p_first_alloc,
-                    sizeof(aout_alloc_t) );
-            p_first_alloc->i_alloc_type = AOUT_ALLOC_STACK;
+        if( i_output_size > p_first_alloc->i_bytes_per_sec )
+            p_first_alloc->i_bytes_per_sec = i_output_size;
+        if( i_input_size > p_first_alloc->i_bytes_per_sec )
             p_first_alloc->i_bytes_per_sec = i_input_size;
-        }
     }
 }
 
 /*****************************************************************************
  * aout_FiltersPlay: play a buffer
  *****************************************************************************/
-void aout_FiltersPlay( aout_instance_t * p_aout,
-                       aout_filter_t ** pp_filters,
-                       int i_nb_filters, aout_buffer_t ** pp_input_buffer )
+void aout_FiltersPlay( filter_t ** pp_filters,
+                       unsigned i_nb_filters, block_t ** pp_block )
 {
-    int i;
+    block_t *p_block = *pp_block;
 
-    for ( i = 0; i < i_nb_filters; i++ )
+    /* TODO: use filter chain */
+    for( unsigned i = 0; i < i_nb_filters; i++ )
     {
-        aout_filter_t * p_filter = pp_filters[i];
-        aout_buffer_t * p_output_buffer;
-
-        aout_BufferAlloc( &p_filter->output_alloc,
-                          (u64)((*pp_input_buffer)->i_nb_samples * 1000000)
-                            / p_filter->output.i_rate, *pp_input_buffer,
-                          p_output_buffer );
-        if ( p_output_buffer == NULL )
-        {
-            msg_Err( p_aout, "out of memory" );
-            return;
-        }
-        /* Please note that p_output_buffer->i_nb_samples & i_nb_bytes
-         * shall be set by the filter plug-in. */
-
-        p_filter->pf_do_work( p_aout, p_filter, *pp_input_buffer,
-                              p_output_buffer );
+        filter_t * p_filter = pp_filters[i];
 
-        if ( !p_filter->b_in_place )
-        {
-            aout_BufferFree( *pp_input_buffer );
-            *pp_input_buffer = p_output_buffer;
-        }
+        /* Please note that p_block->i_nb_samples & i_buffer
+         * shall be set by the filter plug-in. */
+        p_block = p_filter->pf_audio_filter( p_filter, p_block );
     }
+    *pp_block = p_block;
 }