Home | History | Annotate | Download | only in media
      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;
     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      */
     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      */
     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      */
    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      */
    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      */
    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      */
    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      */
    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          */
    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      */
    176     public static void setErrorCallback(ErrorCallback cb)
    177     {
    178         synchronized (AudioSystem.class) {
    179             mErrorCallback = cb;
    180             if (cb != null) {
    181                 cb.onError(checkAudioFlinger());
    182             }
    183         }
    184     }
    185 
    186     private static void errorCallbackFromNative(int error)
    187     {
    188         ErrorCallback errorCallback = null;
    189         synchronized (AudioSystem.class) {
    190             if (mErrorCallback != null) {
    191                 errorCallback = mErrorCallback;
    192             }
    193         }
    194         if (errorCallback != null) {
    195             errorCallback.onError(error);
    196         }
    197     }
    198 
    199 
    200     /*
    201      * AudioPolicyService methods
    202      */
    203 
    204     //
    205     // audio device definitions: must be kept in sync with values in system/core/audio.h
    206     //
    207 
    208     // reserved bits
    209     public static final int DEVICE_BIT_IN = 0x80000000;
    210     public static final int DEVICE_BIT_DEFAULT = 0x40000000;
    211     // output devices, be sure to update AudioManager.java also
    212     public static final int DEVICE_OUT_EARPIECE = 0x1;
    213     public static final int DEVICE_OUT_SPEAKER = 0x2;
    214     public static final int DEVICE_OUT_WIRED_HEADSET = 0x4;
    215     public static final int DEVICE_OUT_WIRED_HEADPHONE = 0x8;
    216     public static final int DEVICE_OUT_BLUETOOTH_SCO = 0x10;
    217     public static final int DEVICE_OUT_BLUETOOTH_SCO_HEADSET = 0x20;
    218     public static final int DEVICE_OUT_BLUETOOTH_SCO_CARKIT = 0x40;
    219     public static final int DEVICE_OUT_BLUETOOTH_A2DP = 0x80;
    220     public static final int DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES = 0x100;
    221     public static final int DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER = 0x200;
    222     public static final int DEVICE_OUT_AUX_DIGITAL = 0x400;
    223     public static final int DEVICE_OUT_ANLG_DOCK_HEADSET = 0x800;
    224     public static final int DEVICE_OUT_DGTL_DOCK_HEADSET = 0x1000;
    225     public static final int DEVICE_OUT_USB_ACCESSORY = 0x2000;
    226     public static final int DEVICE_OUT_USB_DEVICE = 0x4000;
    227     public static final int DEVICE_OUT_REMOTE_SUBMIX = 0x8000;
    228 
    229     public static final int DEVICE_OUT_DEFAULT = DEVICE_BIT_DEFAULT;
    230 
    231     public static final int DEVICE_OUT_ALL = (DEVICE_OUT_EARPIECE |
    232                                               DEVICE_OUT_SPEAKER |
    233                                               DEVICE_OUT_WIRED_HEADSET |
    234                                               DEVICE_OUT_WIRED_HEADPHONE |
    235                                               DEVICE_OUT_BLUETOOTH_SCO |
    236                                               DEVICE_OUT_BLUETOOTH_SCO_HEADSET |
    237                                               DEVICE_OUT_BLUETOOTH_SCO_CARKIT |
    238                                               DEVICE_OUT_BLUETOOTH_A2DP |
    239                                               DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES |
    240                                               DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER |
    241                                               DEVICE_OUT_AUX_DIGITAL |
    242                                               DEVICE_OUT_ANLG_DOCK_HEADSET |
    243                                               DEVICE_OUT_DGTL_DOCK_HEADSET |
    244                                               DEVICE_OUT_USB_ACCESSORY |
    245                                               DEVICE_OUT_USB_DEVICE |
    246                                               DEVICE_OUT_REMOTE_SUBMIX |
    247                                               DEVICE_OUT_DEFAULT);
    248     public static final int DEVICE_OUT_ALL_A2DP = (DEVICE_OUT_BLUETOOTH_A2DP |
    249                                                    DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES |
    250                                                    DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER);
    251     public static final int DEVICE_OUT_ALL_SCO = (DEVICE_OUT_BLUETOOTH_SCO |
    252                                                   DEVICE_OUT_BLUETOOTH_SCO_HEADSET |
    253                                                   DEVICE_OUT_BLUETOOTH_SCO_CARKIT);
    254     public static final int DEVICE_OUT_ALL_USB = (DEVICE_OUT_USB_ACCESSORY |
    255                                                   DEVICE_OUT_USB_DEVICE);
    256 
    257     // input devices
    258     public static final int DEVICE_IN_COMMUNICATION = DEVICE_BIT_IN | 0x1;
    259     public static final int DEVICE_IN_AMBIENT = DEVICE_BIT_IN | 0x2;
    260     public static final int DEVICE_IN_BUILTIN_MIC = DEVICE_BIT_IN | 0x4;
    261     public static final int DEVICE_IN_BLUETOOTH_SCO_HEADSET = DEVICE_BIT_IN | 0x8;
    262     public static final int DEVICE_IN_WIRED_HEADSET = DEVICE_BIT_IN | 0x10;
    263     public static final int DEVICE_IN_AUX_DIGITAL = DEVICE_BIT_IN | 0x20;
    264     public static final int DEVICE_IN_VOICE_CALL = DEVICE_BIT_IN | 0x40;
    265     public static final int DEVICE_IN_BACK_MIC = DEVICE_BIT_IN | 0x80;
    266     public static final int DEVICE_IN_REMOTE_SUBMIX = DEVICE_BIT_IN | 0x100;
    267     public static final int DEVICE_IN_ANLG_DOCK_HEADSET = DEVICE_BIT_IN | 0x200;
    268     public static final int DEVICE_IN_DGTL_DOCK_HEADSET = DEVICE_BIT_IN | 0x400;
    269     public static final int DEVICE_IN_USB_ACCESSORY = DEVICE_BIT_IN | 0x800;
    270     public static final int DEVICE_IN_USB_DEVICE = DEVICE_BIT_IN | 0x1000;
    271     public static final int DEVICE_IN_DEFAULT = DEVICE_BIT_IN | DEVICE_BIT_DEFAULT;
    272 
    273     public static final int DEVICE_IN_ALL = (DEVICE_IN_COMMUNICATION |
    274                                              DEVICE_IN_AMBIENT |
    275                                              DEVICE_IN_BUILTIN_MIC |
    276                                              DEVICE_IN_BLUETOOTH_SCO_HEADSET |
    277                                              DEVICE_IN_WIRED_HEADSET |
    278                                              DEVICE_IN_AUX_DIGITAL |
    279                                              DEVICE_IN_VOICE_CALL |
    280                                              DEVICE_IN_BACK_MIC |
    281                                              DEVICE_IN_REMOTE_SUBMIX |
    282                                              DEVICE_IN_ANLG_DOCK_HEADSET |
    283                                              DEVICE_IN_DGTL_DOCK_HEADSET |
    284                                              DEVICE_IN_USB_ACCESSORY |
    285                                              DEVICE_IN_USB_DEVICE |
    286                                              DEVICE_IN_DEFAULT);
    287     public static final int DEVICE_IN_ALL_SCO = DEVICE_IN_BLUETOOTH_SCO_HEADSET;
    288 
    289     // device states, must match AudioSystem::device_connection_state
    290     public static final int DEVICE_STATE_UNAVAILABLE = 0;
    291     public static final int DEVICE_STATE_AVAILABLE = 1;
    292     private static final int NUM_DEVICE_STATES = 1;
    293 
    294     public static final String DEVICE_OUT_EARPIECE_NAME = "earpiece";
    295     public static final String DEVICE_OUT_SPEAKER_NAME = "speaker";
    296     public static final String DEVICE_OUT_WIRED_HEADSET_NAME = "headset";
    297     public static final String DEVICE_OUT_WIRED_HEADPHONE_NAME = "headphone";
    298     public static final String DEVICE_OUT_BLUETOOTH_SCO_NAME = "bt_sco";
    299     public static final String DEVICE_OUT_BLUETOOTH_SCO_HEADSET_NAME = "bt_sco_hs";
    300     public static final String DEVICE_OUT_BLUETOOTH_SCO_CARKIT_NAME = "bt_sco_carkit";
    301     public static final String DEVICE_OUT_BLUETOOTH_A2DP_NAME = "bt_a2dp";
    302     public static final String DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES_NAME = "bt_a2dp_hp";
    303     public static final String DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER_NAME = "bt_a2dp_spk";
    304     public static final String DEVICE_OUT_AUX_DIGITAL_NAME = "aux_digital";
    305     public static final String DEVICE_OUT_ANLG_DOCK_HEADSET_NAME = "analog_dock";
    306     public static final String DEVICE_OUT_DGTL_DOCK_HEADSET_NAME = "digital_dock";
    307     public static final String DEVICE_OUT_USB_ACCESSORY_NAME = "usb_accessory";
    308     public static final String DEVICE_OUT_USB_DEVICE_NAME = "usb_device";
    309     public static final String DEVICE_OUT_REMOTE_SUBMIX_NAME = "remote_submix";
    310 
    311     public static String getDeviceName(int device)
    312     {
    313         switch(device) {
    314         case DEVICE_OUT_EARPIECE:
    315             return DEVICE_OUT_EARPIECE_NAME;
    316         case DEVICE_OUT_SPEAKER:
    317             return DEVICE_OUT_SPEAKER_NAME;
    318         case DEVICE_OUT_WIRED_HEADSET:
    319             return DEVICE_OUT_WIRED_HEADSET_NAME;
    320         case DEVICE_OUT_WIRED_HEADPHONE:
    321             return DEVICE_OUT_WIRED_HEADPHONE_NAME;
    322         case DEVICE_OUT_BLUETOOTH_SCO:
    323             return DEVICE_OUT_BLUETOOTH_SCO_NAME;
    324         case DEVICE_OUT_BLUETOOTH_SCO_HEADSET:
    325             return DEVICE_OUT_BLUETOOTH_SCO_HEADSET_NAME;
    326         case DEVICE_OUT_BLUETOOTH_SCO_CARKIT:
    327             return DEVICE_OUT_BLUETOOTH_SCO_CARKIT_NAME;
    328         case DEVICE_OUT_BLUETOOTH_A2DP:
    329             return DEVICE_OUT_BLUETOOTH_A2DP_NAME;
    330         case DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES:
    331             return DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES_NAME;
    332         case DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER:
    333             return DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER_NAME;
    334         case DEVICE_OUT_AUX_DIGITAL:
    335             return DEVICE_OUT_AUX_DIGITAL_NAME;
    336         case DEVICE_OUT_ANLG_DOCK_HEADSET:
    337             return DEVICE_OUT_ANLG_DOCK_HEADSET_NAME;
    338         case DEVICE_OUT_DGTL_DOCK_HEADSET:
    339             return DEVICE_OUT_DGTL_DOCK_HEADSET_NAME;
    340         case DEVICE_OUT_USB_ACCESSORY:
    341             return DEVICE_OUT_USB_ACCESSORY_NAME;
    342         case DEVICE_OUT_USB_DEVICE:
    343             return DEVICE_OUT_USB_DEVICE_NAME;
    344         case DEVICE_OUT_REMOTE_SUBMIX:
    345             return DEVICE_OUT_REMOTE_SUBMIX_NAME;
    346         case DEVICE_OUT_DEFAULT:
    347         default:
    348             return "";
    349         }
    350     }
    351 
    352     // phone state, match audio_mode???
    353     public static final int PHONE_STATE_OFFCALL = 0;
    354     public static final int PHONE_STATE_RINGING = 1;
    355     public static final int PHONE_STATE_INCALL = 2;
    356 
    357     // device categories config for setForceUse, must match AudioSystem::forced_config
    358     public static final int FORCE_NONE = 0;
    359     public static final int FORCE_SPEAKER = 1;
    360     public static final int FORCE_HEADPHONES = 2;
    361     public static final int FORCE_BT_SCO = 3;
    362     public static final int FORCE_BT_A2DP = 4;
    363     public static final int FORCE_WIRED_ACCESSORY = 5;
    364     public static final int FORCE_BT_CAR_DOCK = 6;
    365     public static final int FORCE_BT_DESK_DOCK = 7;
    366     public static final int FORCE_ANALOG_DOCK = 8;
    367     public static final int FORCE_DIGITAL_DOCK = 9;
    368     public static final int FORCE_NO_BT_A2DP = 10;
    369     public static final int FORCE_SYSTEM_ENFORCED = 11;
    370     private static final int NUM_FORCE_CONFIG = 12;
    371     public static final int FORCE_DEFAULT = FORCE_NONE;
    372 
    373     // usage for setForceUse, must match AudioSystem::force_use
    374     public static final int FOR_COMMUNICATION = 0;
    375     public static final int FOR_MEDIA = 1;
    376     public static final int FOR_RECORD = 2;
    377     public static final int FOR_DOCK = 3;
    378     public static final int FOR_SYSTEM = 4;
    379     private static final int NUM_FORCE_USE = 5;
    380 
    381     // usage for AudioRecord.startRecordingSync(), must match AudioSystem::sync_event_t
    382     public static final int SYNC_EVENT_NONE = 0;
    383     public static final int SYNC_EVENT_PRESENTATION_COMPLETE = 1;
    384 
    385     public static native int setDeviceConnectionState(int device, int state, String device_address);
    386     public static native int getDeviceConnectionState(int device, String device_address);
    387     public static native int setPhoneState(int state);
    388     public static native int setForceUse(int usage, int config);
    389     public static native int getForceUse(int usage);
    390     public static native int initStreamVolume(int stream, int indexMin, int indexMax);
    391     public static native int setStreamVolumeIndex(int stream, int index, int device);
    392     public static native int getStreamVolumeIndex(int stream, int device);
    393     public static native int setMasterVolume(float value);
    394     public static native float getMasterVolume();
    395     public static native int setMasterMute(boolean mute);
    396     public static native boolean getMasterMute();
    397     public static native int getDevicesForStream(int stream);
    398 
    399     // helpers for android.media.AudioManager.getProperty(), see description there for meaning
    400     public static native int getPrimaryOutputSamplingRate();
    401     public static native int getPrimaryOutputFrameCount();
    402     public static native int getOutputLatency(int stream);
    403 
    404     public static native int setLowRamDevice(boolean isLowRamDevice);
    405     public static native int checkAudioFlinger();
    406 }
    407