Merge "Public API for peak and RMS monitoring through the Visualizer effect" into klp-dev
diff --git a/api/current.txt b/api/current.txt
index fd9f0be..5e9844c 100644
--- a/api/current.txt
+++ b/api/current.txt
@@ -13823,6 +13823,8 @@
method public boolean getEnabled();
method public int getFft(byte[]) throws java.lang.IllegalStateException;
method public static int getMaxCaptureRate();
+ method public int getMeasurementMode() throws java.lang.IllegalStateException;
+ method public int getMeasurementPeakRms(android.media.audiofx.Visualizer.MeasurementPeakRms);
method public int getSamplingRate() throws java.lang.IllegalStateException;
method public int getScalingMode() throws java.lang.IllegalStateException;
method public int getWaveForm(byte[]) throws java.lang.IllegalStateException;
@@ -13830,6 +13832,7 @@
method public int setCaptureSize(int) throws java.lang.IllegalStateException;
method public int setDataCaptureListener(android.media.audiofx.Visualizer.OnDataCaptureListener, int, boolean, boolean);
method public int setEnabled(boolean) throws java.lang.IllegalStateException;
+ method public int setMeasurementMode(int) throws java.lang.IllegalStateException;
method public int setScalingMode(int) throws java.lang.IllegalStateException;
field public static final int ALREADY_EXISTS = -2; // 0xfffffffe
field public static final int ERROR = -1; // 0xffffffff
@@ -13838,6 +13841,8 @@
field public static final int ERROR_INVALID_OPERATION = -5; // 0xfffffffb
field public static final int ERROR_NO_INIT = -3; // 0xfffffffd
field public static final int ERROR_NO_MEMORY = -6; // 0xfffffffa
+ field public static final int MEASUREMENT_MODE_NONE = 0; // 0x0
+ field public static final int MEASUREMENT_MODE_PEAK_RMS = 1; // 0x1
field public static final int SCALING_MODE_AS_PLAYED = 1; // 0x1
field public static final int SCALING_MODE_NORMALIZED = 0; // 0x0
field public static final int STATE_ENABLED = 2; // 0x2
@@ -13846,6 +13851,12 @@
field public static final int SUCCESS = 0; // 0x0
}
+ public static final class Visualizer.MeasurementPeakRms {
+ ctor public Visualizer.MeasurementPeakRms();
+ field public int mPeak;
+ field public int mRms;
+ }
+
public static abstract interface Visualizer.OnDataCaptureListener {
method public abstract void onFftDataCapture(android.media.audiofx.Visualizer, byte[], int);
method public abstract void onWaveFormDataCapture(android.media.audiofx.Visualizer, byte[], int);
diff --git a/media/java/android/media/audiofx/Visualizer.java b/media/java/android/media/audiofx/Visualizer.java
index 580a4f9..fb7f718 100644
--- a/media/java/android/media/audiofx/Visualizer.java
+++ b/media/java/android/media/audiofx/Visualizer.java
@@ -57,6 +57,11 @@
* anymore to free up native resources associated to the Visualizer instance.
* <p>Creating a Visualizer on the output mix (audio session 0) requires permission
* {@link android.Manifest.permission#MODIFY_AUDIO_SETTINGS}
+ * <p>The Visualizer class can also be used to perform measurements on the audio being played back.
+ * The measurements to perform are defined by setting a mask of the requested measurement modes with
+ * {@link #setMeasurementMode(int)}. Supported values are {@link #MEASUREMENT_MODE_NONE} to cancel
+ * any measurement, and {@link #MEASUREMENT_MODE_PEAK_RMS} for peak and RMS monitoring.
+ * Measurements can be retrieved through {@link #getMeasurementPeakRms(MeasurementPeakRms)}.
*/
public class Visualizer {
@@ -94,20 +99,15 @@
public static final int SCALING_MODE_AS_PLAYED = 1;
/**
- * @hide
- * CANDIDATE FOR PUBLIC API
- * Defines a measurement mode with no requested measurement.
+ * Defines a measurement mode in which no measurements are performed.
*/
public static final int MEASUREMENT_MODE_NONE = 0;
/**
- * @hide
- * CANDIDATE FOR PUBLIC API
* Defines a measurement mode which computes the peak and RMS value in mB, where 0mB is the
* maximum sample value, and -9600mB is the minimum value.
- * Values for peak and RMS can be retrieved with {@link #getIntMeasurements(int, int[])}, where
- * the array holds the peak value at index {@link #MEASUREMENT_INDEX_PEAK} in the measurement
- * array, and the RMS value at index {@link #MEASUREMENT_INDEX_RMS}.
+ * Values for peak and RMS can be retrieved with
+ * {@link #getMeasurementPeakRms(MeasurementPeakRms)}.
*/
public static final int MEASUREMENT_MODE_PEAK_RMS = 1 << 0;
@@ -368,8 +368,6 @@
}
/**
- * @hide
- * CANDIDATE FOR PUBLIC API
* Sets the combination of measurement modes to be performed by this audio effect.
* @param mode a mask of the measurements to perform. The valid values are
* {@link #MEASUREMENT_MODE_NONE} (to cancel any measurement)
@@ -389,8 +387,6 @@
}
/**
- * @hide
- * CANDIDATE FOR PUBLIC API
* Returns the current measurement modes performed by this audio effect
* @return the mask of the measurements,
* {@link #MEASUREMENT_MODE_NONE} (when no measurements are performed)
@@ -497,30 +493,25 @@
}
/**
- * @hide
- * CANDIDATE FOR PUBLIC API
* A class to store peak and RMS values.
* Peak and RMS are expressed in mB, as described in the
* {@link Visualizer#MEASUREMENT_MODE_PEAK_RMS} measurement mode.
*/
public static final class MeasurementPeakRms {
/**
- * @hide
- * CANDIDATE FOR PUBLIC API
+ * The peak value in mB.
*/
public int mPeak;
/**
- * @hide
- * CANDIDATE FOR PUBLIC API
+ * The RMS value in mB.
*/
public int mRms;
}
/**
- * @hide
* Retrieves the latest peak and RMS measurement.
- * Sets the peak and RMS fields of the {@link Visualizer.MeasurementPeakRms} to the latest
- * measured values.
+ * Sets the peak and RMS fields of the supplied {@link Visualizer.MeasurementPeakRms} to the
+ * latest measured values.
* @param measurement a non-null {@link Visualizer.MeasurementPeakRms} instance to store
* the measurement values.
* @return {@link #SUCCESS} in case of success, {@link #ERROR_BAD_VALUE},