• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2006 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package android.media;
18 
19 
20 /* IF YOU CHANGE ANY OF THE CONSTANTS IN THIS FILE, DO NOT FORGET
21  * TO UPDATE THE CORRESPONDING NATIVE GLUE AND AudioManager.java.
22  * THANK YOU FOR YOUR COOPERATION.
23  */
24 
25 /**
26  * @hide
27  */
28 public class AudioSystem
29 {
30     /* These values must be kept in sync with AudioSystem.h */
31     /*
32      * If these are modified, please also update Settings.System.VOLUME_SETTINGS
33      * and attrs.xml and AudioManager.java.
34      */
35     /* The audio stream for phone calls */
36     public static final int STREAM_VOICE_CALL = 0;
37     /* The audio stream for system sounds */
38     public static final int STREAM_SYSTEM = 1;
39     /* The audio stream for the phone ring and message alerts */
40     public static final int STREAM_RING = 2;
41     /* The audio stream for music playback */
42     public static final int STREAM_MUSIC = 3;
43     /* The audio stream for alarms */
44     public static final int STREAM_ALARM = 4;
45     /* The audio stream for notifications */
46     public static final int STREAM_NOTIFICATION = 5;
47     /* @hide The audio stream for phone calls when connected on bluetooth */
48     public static final int STREAM_BLUETOOTH_SCO = 6;
49     /* @hide The audio stream for enforced system sounds in certain countries (e.g camera in Japan) */
50     public static final int STREAM_SYSTEM_ENFORCED = 7;
51     /* @hide The audio stream for DTMF tones */
52     public static final int STREAM_DTMF = 8;
53     /* @hide The audio stream for text to speech (TTS) */
54     public static final int STREAM_TTS = 9;
55     /**
56      * @deprecated Use {@link #numStreamTypes() instead}
57      */
58     public static final int NUM_STREAMS = 5;
59 
60     // Expose only the getter method publicly so we can change it in the future
61     private static final int NUM_STREAM_TYPES = 10;
getNumStreamTypes()62     public static final int getNumStreamTypes() { return NUM_STREAM_TYPES; }
63 
64     /*
65      * Sets the microphone mute on or off.
66      *
67      * @param on set <var>true</var> to mute the microphone;
68      *           <var>false</var> to turn mute off
69      * @return command completion status see AUDIO_STATUS_OK, see AUDIO_STATUS_ERROR
70      */
muteMicrophone(boolean on)71     public static native int muteMicrophone(boolean on);
72 
73     /*
74      * Checks whether the microphone mute is on or off.
75      *
76      * @return true if microphone is muted, false if it's not
77      */
isMicrophoneMuted()78     public static native boolean isMicrophoneMuted();
79 
80     /* modes for setPhoneState, must match AudioSystem.h audio_mode */
81     public static final int MODE_INVALID            = -2;
82     public static final int MODE_CURRENT            = -1;
83     public static final int MODE_NORMAL             = 0;
84     public static final int MODE_RINGTONE           = 1;
85     public static final int MODE_IN_CALL            = 2;
86     public static final int MODE_IN_COMMUNICATION   = 3;
87     public static final int NUM_MODES               = 4;
88 
89 
90     /* Routing bits for the former setRouting/getRouting API */
91     /** @deprecated */
92     @Deprecated public static final int ROUTE_EARPIECE          = (1 << 0);
93     /** @deprecated */
94     @Deprecated public static final int ROUTE_SPEAKER           = (1 << 1);
95     /** @deprecated use {@link #ROUTE_BLUETOOTH_SCO} */
96     @Deprecated public static final int ROUTE_BLUETOOTH = (1 << 2);
97     /** @deprecated */
98     @Deprecated public static final int ROUTE_BLUETOOTH_SCO     = (1 << 2);
99     /** @deprecated */
100     @Deprecated public static final int ROUTE_HEADSET           = (1 << 3);
101     /** @deprecated */
102     @Deprecated public static final int ROUTE_BLUETOOTH_A2DP    = (1 << 4);
103     /** @deprecated */
104     @Deprecated public static final int ROUTE_ALL               = 0xFFFFFFFF;
105 
106     /*
107      * Checks whether the specified stream type is active.
108      *
109      * return true if any track playing on this stream is active.
110      */
isStreamActive(int stream, int inPastMs)111     public static native boolean isStreamActive(int stream, int inPastMs);
112 
113     /*
114      * Checks whether the specified stream type is active on a remotely connected device. The notion
115      * of what constitutes a remote device is enforced by the audio policy manager of the platform.
116      *
117      * return true if any track playing on this stream is active on a remote device.
118      */
isStreamActiveRemotely(int stream, int inPastMs)119     public static native boolean isStreamActiveRemotely(int stream, int inPastMs);
120 
121     /*
122      * Checks whether the specified audio source is active.
123      *
124      * return true if any recorder using this source is currently recording
125      */
isSourceActive(int source)126     public static native boolean isSourceActive(int source);
127 
128     /*
129      * Sets a group generic audio configuration parameters. The use of these parameters
130      * are platform dependent, see libaudio
131      *
132      * param keyValuePairs  list of parameters key value pairs in the form:
133      *    key1=value1;key2=value2;...
134      */
setParameters(String keyValuePairs)135     public static native int setParameters(String keyValuePairs);
136 
137     /*
138      * Gets a group generic audio configuration parameters. The use of these parameters
139      * are platform dependent, see libaudio
140      *
141      * param keys  list of parameters
142      * return value: list of parameters key value pairs in the form:
143      *    key1=value1;key2=value2;...
144      */
getParameters(String keys)145     public static native String getParameters(String keys);
146 
147     // These match the enum AudioError in frameworks/base/core/jni/android_media_AudioSystem.cpp
148     /* Command sucessful or Media server restarted. see ErrorCallback */
149     public static final int AUDIO_STATUS_OK = 0;
150     /* Command failed or unspecified audio error.  see ErrorCallback */
151     public static final int AUDIO_STATUS_ERROR = 1;
152     /* Media server died. see ErrorCallback */
153     public static final int AUDIO_STATUS_SERVER_DIED = 100;
154 
155     private static ErrorCallback mErrorCallback;
156 
157     /*
158      * Handles the audio error callback.
159      */
160     public interface ErrorCallback
161     {
162         /*
163          * Callback for audio server errors.
164          * param error   error code:
165          * - AUDIO_STATUS_OK
166          * - AUDIO_STATUS_SERVER_DIED
167          * - AUDIO_STATUS_ERROR
168          */
onError(int error)169         void onError(int error);
170     };
171 
172     /*
173      * Registers a callback to be invoked when an error occurs.
174      * @param cb the callback to run
175      */
setErrorCallback(ErrorCallback cb)176     public static void setErrorCallback(ErrorCallback cb)
177     {
178         synchronized (AudioSystem.class) {
179             mErrorCallback = cb;
180         }
181         // Calling a method on AudioFlinger here makes sure that we bind to IAudioFlinger
182         // binder interface death. Not doing that would result in not being notified of
183         // media_server process death if no other method is called on AudioSystem that reaches
184         // to AudioFlinger.
185         isMicrophoneMuted();
186     }
187 
errorCallbackFromNative(int error)188     private static void errorCallbackFromNative(int error)
189     {
190         ErrorCallback errorCallback = null;
191         synchronized (AudioSystem.class) {
192             if (mErrorCallback != null) {
193                 errorCallback = mErrorCallback;
194             }
195         }
196         if (errorCallback != null) {
197             errorCallback.onError(error);
198         }
199     }
200 
201 
202     /*
203      * AudioPolicyService methods
204      */
205 
206     //
207     // audio device definitions: must be kept in sync with values in system/core/audio.h
208     //
209 
210     // reserved bits
211     public static final int DEVICE_BIT_IN = 0x80000000;
212     public static final int DEVICE_BIT_DEFAULT = 0x40000000;
213     // output devices, be sure to update AudioManager.java also
214     public static final int DEVICE_OUT_EARPIECE = 0x1;
215     public static final int DEVICE_OUT_SPEAKER = 0x2;
216     public static final int DEVICE_OUT_WIRED_HEADSET = 0x4;
217     public static final int DEVICE_OUT_WIRED_HEADPHONE = 0x8;
218     public static final int DEVICE_OUT_BLUETOOTH_SCO = 0x10;
219     public static final int DEVICE_OUT_BLUETOOTH_SCO_HEADSET = 0x20;
220     public static final int DEVICE_OUT_BLUETOOTH_SCO_CARKIT = 0x40;
221     public static final int DEVICE_OUT_BLUETOOTH_A2DP = 0x80;
222     public static final int DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES = 0x100;
223     public static final int DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER = 0x200;
224     public static final int DEVICE_OUT_AUX_DIGITAL = 0x400;
225     public static final int DEVICE_OUT_ANLG_DOCK_HEADSET = 0x800;
226     public static final int DEVICE_OUT_DGTL_DOCK_HEADSET = 0x1000;
227     public static final int DEVICE_OUT_USB_ACCESSORY = 0x2000;
228     public static final int DEVICE_OUT_USB_DEVICE = 0x4000;
229     public static final int DEVICE_OUT_REMOTE_SUBMIX = 0x8000;
230 
231     public static final int DEVICE_OUT_DEFAULT = DEVICE_BIT_DEFAULT;
232 
233     public static final int DEVICE_OUT_ALL = (DEVICE_OUT_EARPIECE |
234                                               DEVICE_OUT_SPEAKER |
235                                               DEVICE_OUT_WIRED_HEADSET |
236                                               DEVICE_OUT_WIRED_HEADPHONE |
237                                               DEVICE_OUT_BLUETOOTH_SCO |
238                                               DEVICE_OUT_BLUETOOTH_SCO_HEADSET |
239                                               DEVICE_OUT_BLUETOOTH_SCO_CARKIT |
240                                               DEVICE_OUT_BLUETOOTH_A2DP |
241                                               DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES |
242                                               DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER |
243                                               DEVICE_OUT_AUX_DIGITAL |
244                                               DEVICE_OUT_ANLG_DOCK_HEADSET |
245                                               DEVICE_OUT_DGTL_DOCK_HEADSET |
246                                               DEVICE_OUT_USB_ACCESSORY |
247                                               DEVICE_OUT_USB_DEVICE |
248                                               DEVICE_OUT_REMOTE_SUBMIX |
249                                               DEVICE_OUT_DEFAULT);
250     public static final int DEVICE_OUT_ALL_A2DP = (DEVICE_OUT_BLUETOOTH_A2DP |
251                                                    DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES |
252                                                    DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER);
253     public static final int DEVICE_OUT_ALL_SCO = (DEVICE_OUT_BLUETOOTH_SCO |
254                                                   DEVICE_OUT_BLUETOOTH_SCO_HEADSET |
255                                                   DEVICE_OUT_BLUETOOTH_SCO_CARKIT);
256     public static final int DEVICE_OUT_ALL_USB = (DEVICE_OUT_USB_ACCESSORY |
257                                                   DEVICE_OUT_USB_DEVICE);
258 
259     // input devices
260     public static final int DEVICE_IN_COMMUNICATION = DEVICE_BIT_IN | 0x1;
261     public static final int DEVICE_IN_AMBIENT = DEVICE_BIT_IN | 0x2;
262     public static final int DEVICE_IN_BUILTIN_MIC = DEVICE_BIT_IN | 0x4;
263     public static final int DEVICE_IN_BLUETOOTH_SCO_HEADSET = DEVICE_BIT_IN | 0x8;
264     public static final int DEVICE_IN_WIRED_HEADSET = DEVICE_BIT_IN | 0x10;
265     public static final int DEVICE_IN_AUX_DIGITAL = DEVICE_BIT_IN | 0x20;
266     public static final int DEVICE_IN_VOICE_CALL = DEVICE_BIT_IN | 0x40;
267     public static final int DEVICE_IN_BACK_MIC = DEVICE_BIT_IN | 0x80;
268     public static final int DEVICE_IN_REMOTE_SUBMIX = DEVICE_BIT_IN | 0x100;
269     public static final int DEVICE_IN_ANLG_DOCK_HEADSET = DEVICE_BIT_IN | 0x200;
270     public static final int DEVICE_IN_DGTL_DOCK_HEADSET = DEVICE_BIT_IN | 0x400;
271     public static final int DEVICE_IN_USB_ACCESSORY = DEVICE_BIT_IN | 0x800;
272     public static final int DEVICE_IN_USB_DEVICE = DEVICE_BIT_IN | 0x1000;
273     public static final int DEVICE_IN_DEFAULT = DEVICE_BIT_IN | DEVICE_BIT_DEFAULT;
274 
275     public static final int DEVICE_IN_ALL = (DEVICE_IN_COMMUNICATION |
276                                              DEVICE_IN_AMBIENT |
277                                              DEVICE_IN_BUILTIN_MIC |
278                                              DEVICE_IN_BLUETOOTH_SCO_HEADSET |
279                                              DEVICE_IN_WIRED_HEADSET |
280                                              DEVICE_IN_AUX_DIGITAL |
281                                              DEVICE_IN_VOICE_CALL |
282                                              DEVICE_IN_BACK_MIC |
283                                              DEVICE_IN_REMOTE_SUBMIX |
284                                              DEVICE_IN_ANLG_DOCK_HEADSET |
285                                              DEVICE_IN_DGTL_DOCK_HEADSET |
286                                              DEVICE_IN_USB_ACCESSORY |
287                                              DEVICE_IN_USB_DEVICE |
288                                              DEVICE_IN_DEFAULT);
289     public static final int DEVICE_IN_ALL_SCO = DEVICE_IN_BLUETOOTH_SCO_HEADSET;
290 
291     // device states, must match AudioSystem::device_connection_state
292     public static final int DEVICE_STATE_UNAVAILABLE = 0;
293     public static final int DEVICE_STATE_AVAILABLE = 1;
294     private static final int NUM_DEVICE_STATES = 1;
295 
296     public static final String DEVICE_OUT_EARPIECE_NAME = "earpiece";
297     public static final String DEVICE_OUT_SPEAKER_NAME = "speaker";
298     public static final String DEVICE_OUT_WIRED_HEADSET_NAME = "headset";
299     public static final String DEVICE_OUT_WIRED_HEADPHONE_NAME = "headphone";
300     public static final String DEVICE_OUT_BLUETOOTH_SCO_NAME = "bt_sco";
301     public static final String DEVICE_OUT_BLUETOOTH_SCO_HEADSET_NAME = "bt_sco_hs";
302     public static final String DEVICE_OUT_BLUETOOTH_SCO_CARKIT_NAME = "bt_sco_carkit";
303     public static final String DEVICE_OUT_BLUETOOTH_A2DP_NAME = "bt_a2dp";
304     public static final String DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES_NAME = "bt_a2dp_hp";
305     public static final String DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER_NAME = "bt_a2dp_spk";
306     public static final String DEVICE_OUT_AUX_DIGITAL_NAME = "aux_digital";
307     public static final String DEVICE_OUT_ANLG_DOCK_HEADSET_NAME = "analog_dock";
308     public static final String DEVICE_OUT_DGTL_DOCK_HEADSET_NAME = "digital_dock";
309     public static final String DEVICE_OUT_USB_ACCESSORY_NAME = "usb_accessory";
310     public static final String DEVICE_OUT_USB_DEVICE_NAME = "usb_device";
311     public static final String DEVICE_OUT_REMOTE_SUBMIX_NAME = "remote_submix";
312 
getDeviceName(int device)313     public static String getDeviceName(int device)
314     {
315         switch(device) {
316         case DEVICE_OUT_EARPIECE:
317             return DEVICE_OUT_EARPIECE_NAME;
318         case DEVICE_OUT_SPEAKER:
319             return DEVICE_OUT_SPEAKER_NAME;
320         case DEVICE_OUT_WIRED_HEADSET:
321             return DEVICE_OUT_WIRED_HEADSET_NAME;
322         case DEVICE_OUT_WIRED_HEADPHONE:
323             return DEVICE_OUT_WIRED_HEADPHONE_NAME;
324         case DEVICE_OUT_BLUETOOTH_SCO:
325             return DEVICE_OUT_BLUETOOTH_SCO_NAME;
326         case DEVICE_OUT_BLUETOOTH_SCO_HEADSET:
327             return DEVICE_OUT_BLUETOOTH_SCO_HEADSET_NAME;
328         case DEVICE_OUT_BLUETOOTH_SCO_CARKIT:
329             return DEVICE_OUT_BLUETOOTH_SCO_CARKIT_NAME;
330         case DEVICE_OUT_BLUETOOTH_A2DP:
331             return DEVICE_OUT_BLUETOOTH_A2DP_NAME;
332         case DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES:
333             return DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES_NAME;
334         case DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER:
335             return DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER_NAME;
336         case DEVICE_OUT_AUX_DIGITAL:
337             return DEVICE_OUT_AUX_DIGITAL_NAME;
338         case DEVICE_OUT_ANLG_DOCK_HEADSET:
339             return DEVICE_OUT_ANLG_DOCK_HEADSET_NAME;
340         case DEVICE_OUT_DGTL_DOCK_HEADSET:
341             return DEVICE_OUT_DGTL_DOCK_HEADSET_NAME;
342         case DEVICE_OUT_USB_ACCESSORY:
343             return DEVICE_OUT_USB_ACCESSORY_NAME;
344         case DEVICE_OUT_USB_DEVICE:
345             return DEVICE_OUT_USB_DEVICE_NAME;
346         case DEVICE_OUT_REMOTE_SUBMIX:
347             return DEVICE_OUT_REMOTE_SUBMIX_NAME;
348         case DEVICE_OUT_DEFAULT:
349         default:
350             return "";
351         }
352     }
353 
354     // phone state, match audio_mode???
355     public static final int PHONE_STATE_OFFCALL = 0;
356     public static final int PHONE_STATE_RINGING = 1;
357     public static final int PHONE_STATE_INCALL = 2;
358 
359     // device categories config for setForceUse, must match AudioSystem::forced_config
360     public static final int FORCE_NONE = 0;
361     public static final int FORCE_SPEAKER = 1;
362     public static final int FORCE_HEADPHONES = 2;
363     public static final int FORCE_BT_SCO = 3;
364     public static final int FORCE_BT_A2DP = 4;
365     public static final int FORCE_WIRED_ACCESSORY = 5;
366     public static final int FORCE_BT_CAR_DOCK = 6;
367     public static final int FORCE_BT_DESK_DOCK = 7;
368     public static final int FORCE_ANALOG_DOCK = 8;
369     public static final int FORCE_DIGITAL_DOCK = 9;
370     public static final int FORCE_NO_BT_A2DP = 10;
371     public static final int FORCE_SYSTEM_ENFORCED = 11;
372     private static final int NUM_FORCE_CONFIG = 12;
373     public static final int FORCE_DEFAULT = FORCE_NONE;
374 
375     // usage for setForceUse, must match AudioSystem::force_use
376     public static final int FOR_COMMUNICATION = 0;
377     public static final int FOR_MEDIA = 1;
378     public static final int FOR_RECORD = 2;
379     public static final int FOR_DOCK = 3;
380     public static final int FOR_SYSTEM = 4;
381     private static final int NUM_FORCE_USE = 5;
382 
383     // usage for AudioRecord.startRecordingSync(), must match AudioSystem::sync_event_t
384     public static final int SYNC_EVENT_NONE = 0;
385     public static final int SYNC_EVENT_PRESENTATION_COMPLETE = 1;
386 
setDeviceConnectionState(int device, int state, String device_address)387     public static native int setDeviceConnectionState(int device, int state, String device_address);
getDeviceConnectionState(int device, String device_address)388     public static native int getDeviceConnectionState(int device, String device_address);
setPhoneState(int state)389     public static native int setPhoneState(int state);
setForceUse(int usage, int config)390     public static native int setForceUse(int usage, int config);
getForceUse(int usage)391     public static native int getForceUse(int usage);
initStreamVolume(int stream, int indexMin, int indexMax)392     public static native int initStreamVolume(int stream, int indexMin, int indexMax);
setStreamVolumeIndex(int stream, int index, int device)393     public static native int setStreamVolumeIndex(int stream, int index, int device);
getStreamVolumeIndex(int stream, int device)394     public static native int getStreamVolumeIndex(int stream, int device);
setMasterVolume(float value)395     public static native int setMasterVolume(float value);
getMasterVolume()396     public static native float getMasterVolume();
setMasterMute(boolean mute)397     public static native int setMasterMute(boolean mute);
getMasterMute()398     public static native boolean getMasterMute();
getDevicesForStream(int stream)399     public static native int getDevicesForStream(int stream);
400 
401     // helpers for android.media.AudioManager.getProperty(), see description there for meaning
getPrimaryOutputSamplingRate()402     public static native int getPrimaryOutputSamplingRate();
getPrimaryOutputFrameCount()403     public static native int getPrimaryOutputFrameCount();
getOutputLatency(int stream)404     public static native int getOutputLatency(int stream);
405 
406 }
407