From 855255d89fe0a14abe796355bebb64031ec6ff47 Mon Sep 17 00:00:00 2001 From: Eric Laurent Date: Mon, 9 Apr 2012 14:25:48 -0700 Subject: audio preprocessing: added static factory method Added static methods to check availability and create audio preprocessing effects. Change-Id: I945e97fe41912ff8880befacaba162a08b5a1267 --- .../media/audiofx/AcousticEchoCanceler.java | 46 ++++++++++++++++---- media/java/android/media/audiofx/AudioEffect.java | 16 +++++++ .../media/audiofx/AutomaticGainControl.java | 48 +++++++++++++++++---- .../android/media/audiofx/NoiseSuppressor.java | 49 ++++++++++++++++++---- 4 files changed, 136 insertions(+), 23 deletions(-) diff --git a/media/java/android/media/audiofx/AcousticEchoCanceler.java b/media/java/android/media/audiofx/AcousticEchoCanceler.java index 7197dd2fc768..e31f84c0e7cc 100644 --- a/media/java/android/media/audiofx/AcousticEchoCanceler.java +++ b/media/java/android/media/audiofx/AcousticEchoCanceler.java @@ -16,6 +16,8 @@ package android.media.audiofx; +import android.util.Log; + /** * Acoustic Echo Canceler (AEC). *

Acoustic Echo Canceler (AEC) is an audio pre-processing which removes the contribution of the @@ -26,14 +28,13 @@ package android.media.audiofx; *

An application creates an AcousticEchoCanceler object to instantiate and control an AEC * engine in the audio capture path. *

To attach the AcousticEchoCanceler to a particular {@link android.media.AudioRecord}, - * specify the audio session ID of this AudioRecord when constructing the AcousticEchoCanceler. + * specify the audio session ID of this AudioRecord when creating the AcousticEchoCanceler. * The audio session is retrieved by calling * {@link android.media.AudioRecord#getAudioSessionId()} on the AudioRecord instance. *

On some devices, an AEC can be inserted by default in the capture path by the platform - * according to the {@link android.media.MediaRecorder.AudioSource} used. The application can - * query which pre-processings are currently applied to an AudioRecord instance by calling - * {@link android.media.audiofx.AudioEffect#queryPreProcessings(int)} with the audio session of the - * AudioRecord. + * according to the {@link android.media.MediaRecorder.AudioSource} used. The application should + * call AcousticEchoCanceler.getEnable() after creating the AEC to check the default AEC activation + * state on a particular AudioRecord session. *

See {@link android.media.audiofx.AudioEffect} class for more details on * controlling audio effects. * @hide @@ -43,14 +44,44 @@ public class AcousticEchoCanceler extends AudioEffect { private final static String TAG = "AcousticEchoCanceler"; + /** + * Checks if the device implements acoustic echo cancellation. + * @return true if the device implements acoustic echo cancellation, false otherwise. + */ + public static boolean isAvailable() { + return AudioEffect.isEffectTypeAvailable(AudioEffect.EFFECT_TYPE_AEC); + } + + /** + * Creates an AcousticEchoCanceler and attaches it to the AudioRecord on the audio + * session specified. + * @param audioSession system wide unique audio session identifier. The AcousticEchoCanceler + * will be applied to the AudioRecord with the same audio session. + * @return AcousticEchoCanceler created or null if the device does not implement AEC. + */ + public static AcousticEchoCanceler create(int audioSession) { + AcousticEchoCanceler aec = null; + try { + aec = new AcousticEchoCanceler(audioSession); + } catch (IllegalArgumentException e) { + Log.w(TAG, "not implemented on this device"+ aec); + } catch (UnsupportedOperationException e) { + Log.w(TAG, "not enough resources"); + } catch (RuntimeException e) { + Log.w(TAG, "not enough memory"); + } finally { + return aec; + } + } + /** * Class constructor. - *

The application must catch exceptions when creating an AcousticEchoCanceler as the - * constructor is not guarantied to succeed: + *

The constructor is not guarantied to succeed and throws the following exceptions: *

* * @param audioSession system wide unique audio session identifier. The AcousticEchoCanceler @@ -59,6 +90,7 @@ public class AcousticEchoCanceler extends AudioEffect { * @throws java.lang.IllegalArgumentException * @throws java.lang.UnsupportedOperationException * @throws java.lang.RuntimeException + * @hide */ public AcousticEchoCanceler(int audioSession) throws IllegalArgumentException, UnsupportedOperationException, RuntimeException { diff --git a/media/java/android/media/audiofx/AudioEffect.java b/media/java/android/media/audiofx/AudioEffect.java index 85be26733023..68a09de83543 100644 --- a/media/java/android/media/audiofx/AudioEffect.java +++ b/media/java/android/media/audiofx/AudioEffect.java @@ -452,6 +452,22 @@ public class AudioEffect { return (Descriptor[]) native_query_pre_processing(audioSession); } + /** + * Checks if the device implements the specified effect type. + * @param type the requested effect type. + * @return true if the device implements the specified effect type, false otherwise. + * @hide + */ + public static boolean isEffectTypeAvailable(UUID type) { + AudioEffect.Descriptor[] desc = AudioEffect.queryEffects(); + for (int i = 0; i < desc.length; i++) { + if (desc[i].type.equals(type)) { + return true; + } + } + return false; + } + // -------------------------------------------------------------------------- // Control methods // -------------------- diff --git a/media/java/android/media/audiofx/AutomaticGainControl.java b/media/java/android/media/audiofx/AutomaticGainControl.java index 44574f06f857..eca7eec618d8 100644 --- a/media/java/android/media/audiofx/AutomaticGainControl.java +++ b/media/java/android/media/audiofx/AutomaticGainControl.java @@ -16,24 +16,25 @@ package android.media.audiofx; +import android.util.Log; + /** * Automatic Gain Control (AGC). *

Automatic Gain Control (AGC) is an audio pre-processing which automatically normalizes the * output of the captured signal by boosting or lowering input from the microphone to match a preset - * level so that that the output signal level is virtually constant. + * level so that the output signal level is virtually constant. * AGC can be used by applications where the input signal dynamic range is not important but where * a constant strong capture level is desired. *

An application creates a AutomaticGainControl object to instantiate and control an AGC * engine in the audio framework. *

To attach the AutomaticGainControl to a particular {@link android.media.AudioRecord}, - * specify the audio session ID of this AudioRecord when constructing the AutomaticGainControl. + * specify the audio session ID of this AudioRecord when creating the AutomaticGainControl. * The audio session is retrieved by calling * {@link android.media.AudioRecord#getAudioSessionId()} on the AudioRecord instance. *

On some devices, an AGC can be inserted by default in the capture path by the platform - * according to the {@link android.media.MediaRecorder.AudioSource} used. The application can - * query which pre-processings are currently applied to an AudioRecord instance by calling - * {@link android.media.audiofx.AudioEffect#queryPreProcessings(int)} with the audio session of the - * AudioRecord. + * according to the {@link android.media.MediaRecorder.AudioSource} used. The application should + * call AutomaticGainControl.getEnable() after creating the AGC to check the default AGC activation + * state on a particular AudioRecord session. *

See {@link android.media.audiofx.AudioEffect} class for more details on * controlling audio effects. * @hide @@ -43,14 +44,44 @@ public class AutomaticGainControl extends AudioEffect { private final static String TAG = "AutomaticGainControl"; + /** + * Checks if the device implements automatic gain control. + * @return true if the device implements automatic gain control, false otherwise. + */ + public static boolean isAvailable() { + return AudioEffect.isEffectTypeAvailable(AudioEffect.EFFECT_TYPE_AGC); + } + + /** + * Creates an AutomaticGainControl and attaches it to the AudioRecord on the audio + * session specified. + * @param audioSession system wide unique audio session identifier. The AutomaticGainControl + * will be applied to the AudioRecord with the same audio session. + * @return AutomaticGainControl created or null if the device does not implement AGC. + */ + public static AutomaticGainControl create(int audioSession) { + AutomaticGainControl agc = null; + try { + agc = new AutomaticGainControl(audioSession); + } catch (IllegalArgumentException e) { + Log.w(TAG, "not implemented on this device "+agc); + } catch (UnsupportedOperationException e) { + Log.w(TAG, "not enough resources"); + } catch (RuntimeException e) { + Log.w(TAG, "not enough memory"); + } finally { + return agc; + } + } + /** * Class constructor. - *

The application must catch exceptions when creating an AutomaticGainControl as the - * constructor is not guarantied to succeed: + *

The constructor is not guarantied to succeed and throws the following exceptions: *

* * @param audioSession system wide unique audio session identifier. The AutomaticGainControl @@ -59,6 +90,7 @@ public class AutomaticGainControl extends AudioEffect { * @throws java.lang.IllegalArgumentException * @throws java.lang.UnsupportedOperationException * @throws java.lang.RuntimeException + * @hide */ public AutomaticGainControl(int audioSession) throws IllegalArgumentException, UnsupportedOperationException, RuntimeException { diff --git a/media/java/android/media/audiofx/NoiseSuppressor.java b/media/java/android/media/audiofx/NoiseSuppressor.java index 4e7a8b6ef07f..a2d3386c0841 100644 --- a/media/java/android/media/audiofx/NoiseSuppressor.java +++ b/media/java/android/media/audiofx/NoiseSuppressor.java @@ -16,6 +16,8 @@ package android.media.audiofx; +import android.util.Log; + /** * Noise Suppressor (NS). *

Noise suppression (NS) is an audio pre-processing which removes background noise from the @@ -27,14 +29,13 @@ package android.media.audiofx; *

An application creates a NoiseSuppressor object to instantiate and control an NS * engine in the audio framework. *

To attach the NoiseSuppressor to a particular {@link android.media.AudioRecord}, - * specify the audio session ID of this AudioRecord when constructing the NoiseSuppressor. + * specify the audio session ID of this AudioRecord when creating the NoiseSuppressor. * The audio session is retrieved by calling * {@link android.media.AudioRecord#getAudioSessionId()} on the AudioRecord instance. *

On some devices, NS can be inserted by default in the capture path by the platform - * according to the {@link android.media.MediaRecorder.AudioSource} used. The application can - * query which pre-processings are currently applied to an AudioRecord instance by calling - * {@link android.media.audiofx.AudioEffect#queryPreProcessings(int)} with the audio session of the - * AudioRecord. + * according to the {@link android.media.MediaRecorder.AudioSource} used. The application should + * call NoiseSuppressor.getEnable() after creating the NS to check the default NS activation + * state on a particular AudioRecord session. *

See {@link android.media.audiofx.AudioEffect} class for more details on * controlling audio effects. * @hide @@ -44,14 +45,45 @@ public class NoiseSuppressor extends AudioEffect { private final static String TAG = "NoiseSuppressor"; + /** + * Checks if the device implements noise suppression. + * @return true if the device implements noise suppression, false otherwise. + */ + public static boolean isAvailable() { + return AudioEffect.isEffectTypeAvailable(AudioEffect.EFFECT_TYPE_NS); + } + + /** + * Creates a NoiseSuppressor and attaches it to the AudioRecord on the audio + * session specified. + * @param audioSession system wide unique audio session identifier. The NoiseSuppressor + * will be applied to the AudioRecord with the same audio session. + * @return NoiseSuppressor created or null if the device does not implement noise + * suppression. + */ + public static NoiseSuppressor create(int audioSession) { + NoiseSuppressor ns = null; + try { + ns = new NoiseSuppressor(audioSession); + } catch (IllegalArgumentException e) { + Log.w(TAG, "not implemented on this device "+ns); + } catch (UnsupportedOperationException e) { + Log.w(TAG, "not enough resources"); + } catch (RuntimeException e) { + Log.w(TAG, "not enough memory"); + } finally { + return ns; + } + } + /** * Class constructor. - *

The application must catch exceptions when creating an NoiseSuppressor as the - * constructor is not guarantied to succeed: + *

The constructor is not guarantied to succeed and throws the following exceptions: *

* * @param audioSession system wide unique audio session identifier. The NoiseSuppressor @@ -60,8 +92,9 @@ public class NoiseSuppressor extends AudioEffect { * @throws java.lang.IllegalArgumentException * @throws java.lang.UnsupportedOperationException * @throws java.lang.RuntimeException + * @hide */ - public NoiseSuppressor(int audioSession) + private NoiseSuppressor(int audioSession) throws IllegalArgumentException, UnsupportedOperationException, RuntimeException { super(EFFECT_TYPE_NS, EFFECT_TYPE_NULL, 0, audioSession); } -- cgit v1.2.3-59-g8ed1b