Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 81f50685 authored by Weilin Xu's avatar Weilin Xu
Browse files

Update RadioTuner APIs for AIDL HAL migration 

APIs in RadioTuner were updated to adopt broadcast radio HAL
migration to AIDL:
- New APIs seek and onConfigFlagUpdated were added since corresponding
  new interface methods were introduced in broadcast radio AIDL HAL.
- APIs only used in HIDL 1.x broadcast radio HAL were deprecated.
- The use of deprecated onError callback was replaced by onTuneFailed
  in tune, seek, scan and step APIs. Corresponding result types were
  also defined in RadioTuner.
- Multi-user behaviors for RadioTuner APIs were specified.
Meanwhile, a new DAB radio primary identifier was added, which was
extended to 44 bits to support Digital Multimedia Broadcasting (DMB)
radio.
The integer annotations in radio APIs were also improved.

Bug: 257337458
Test: atest com.android.server.broadcastradio
Test: atest android.hardware.radio.tests.unittests
Test: atest android.broadcastradio.cts
Change-Id: I46f0bdfae238de072e46f6561fa3f17c73dd45c8
parent a13d8ed4

core/api/system-current.txt

+38 −27
Original line number Diff line number Diff line
@@ -5267,11 +5267,12 @@ package android.hardware.radio { 
    method public void writeToParcel(android.os.Parcel, int);

    field @NonNull public static final android.os.Parcelable.Creator<android.hardware.radio.ProgramSelector> CREATOR;

    field public static final int IDENTIFIER_TYPE_AMFM_FREQUENCY = 1; // 0x1

    field public static final int IDENTIFIER_TYPE_DAB_DMB_SID_EXT = 14; // 0xe

    field public static final int IDENTIFIER_TYPE_DAB_ENSEMBLE = 6; // 0x6

    field public static final int IDENTIFIER_TYPE_DAB_FREQUENCY = 8; // 0x8

    field public static final int IDENTIFIER_TYPE_DAB_SCID = 7; // 0x7

    field public static final int IDENTIFIER_TYPE_DAB_SIDECC = 5; // 0x5

    field public static final int IDENTIFIER_TYPE_DAB_SID_EXT = 5; // 0x5

    field @Deprecated public static final int IDENTIFIER_TYPE_DAB_SIDECC = 5; // 0x5

    field @Deprecated public static final int IDENTIFIER_TYPE_DAB_SID_EXT = 5; // 0x5

    field public static final int IDENTIFIER_TYPE_DRMO_FREQUENCY = 10; // 0xa

    field @Deprecated public static final int IDENTIFIER_TYPE_DRMO_MODULATION = 11; // 0xb

    field public static final int IDENTIFIER_TYPE_DRMO_SERVICE_ID = 9; // 0x9
@@ -5308,7 +5309,7 @@ package android.hardware.radio { 
    field @NonNull public static final android.os.Parcelable.Creator<android.hardware.radio.ProgramSelector.Identifier> CREATOR;

  }













  @IntDef(prefix={"IDENTIFIER_TYPE_"}, value={android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_INVALID, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_AMFM_FREQUENCY, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_RDS_PI, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_HD_STATION_ID_EXT, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_HD_SUBCHANNEL, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_HD_STATION_NAME, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_DAB_SID_EXT, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_DAB_SIDECC, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_DAB_ENSEMBLE, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_DAB_SCID, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_DAB_FREQUENCY, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_DRMO_SERVICE_ID, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_DRMO_FREQUENCY, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_DRMO_MODULATION, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_SXM_SERVICE_ID, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_SXM_CHANNEL}) @IntRange(from=android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_VENDOR_START, to=android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_VENDOR_END) @java.lang.annotation.Retention(java.lang.annotation.RetentionPolicy.SOURCE) public static @interface ProgramSelector.IdentifierType {













  @IntDef(prefix={"IDENTIFIER_TYPE_"}, value={android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_INVALID, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_AMFM_FREQUENCY, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_RDS_PI, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_HD_STATION_ID_EXT, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_HD_SUBCHANNEL, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_HD_STATION_NAME, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_DAB_SID_EXT, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_DAB_SIDECC, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_DAB_ENSEMBLE, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_DAB_SCID, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_DAB_FREQUENCY, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_DRMO_SERVICE_ID, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_DRMO_FREQUENCY, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_DRMO_MODULATION, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_SXM_SERVICE_ID, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_SXM_CHANNEL, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_DAB_DMB_SID_EXT}) @IntRange(from=android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_VENDOR_START, to=android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_VENDOR_END) @java.lang.annotation.Retention(java.lang.annotation.RetentionPolicy.SOURCE) public static @interface ProgramSelector.IdentifierType {















  }





























  @Deprecated @IntDef(prefix={"PROGRAM_TYPE_"}, value={android.hardware.radio.ProgramSelector.PROGRAM_TYPE_INVALID, android.hardware.radio.ProgramSelector.PROGRAM_TYPE_AM, android.hardware.radio.ProgramSelector.PROGRAM_TYPE_FM, android.hardware.radio.ProgramSelector.PROGRAM_TYPE_AM_HD, android.hardware.radio.ProgramSelector.PROGRAM_TYPE_FM_HD, android.hardware.radio.ProgramSelector.PROGRAM_TYPE_DAB, android.hardware.radio.ProgramSelector.PROGRAM_TYPE_DRMO, android.hardware.radio.ProgramSelector.PROGRAM_TYPE_SXM}) @IntRange(from=android.hardware.radio.ProgramSelector.PROGRAM_TYPE_VENDOR_START, to=android.hardware.radio.ProgramSelector.PROGRAM_TYPE_VENDOR_END) @java.lang.annotation.Retention(java.lang.annotation.RetentionPolicy.SOURCE) public static @interface ProgramSelector.ProgramType {










@@ -5523,30 +5524,31 @@ package android.hardware.radio {



























  public abstract class RadioTuner {















    ctor public RadioTuner();













    method public abstract int cancel();













    method public abstract void cancelAnnouncement();













    method public abstract void close();













    method @Deprecated public abstract int getConfiguration(android.hardware.radio.RadioManager.BandConfig[]);













    method @Nullable public android.hardware.radio.ProgramList getDynamicProgramList(@Nullable android.hardware.radio.ProgramList.Filter);













    method public abstract boolean getMute();













    method @NonNull public java.util.Map<java.lang.String,java.lang.String> getParameters(@NonNull java.util.List<java.lang.String>);













    method @Deprecated public abstract int getProgramInformation(android.hardware.radio.RadioManager.ProgramInfo[]);













    method @Deprecated @NonNull public abstract java.util.List<android.hardware.radio.RadioManager.ProgramInfo> getProgramList(@Nullable java.util.Map<java.lang.String,java.lang.String>);













    method public abstract boolean hasControl();













    method @Deprecated public abstract boolean isAnalogForced();













    method @Deprecated public abstract boolean isAntennaConnected();













    method public boolean isConfigFlagSet(int);













    method public boolean isConfigFlagSupported(int);













    method public abstract int scan(int, boolean);













    method @Deprecated public abstract void setAnalogForced(boolean);













    method public void setConfigFlag(int, boolean);













    method @Deprecated public abstract int setConfiguration(android.hardware.radio.RadioManager.BandConfig);













    method public abstract int setMute(boolean);













    method @NonNull public java.util.Map<java.lang.String,java.lang.String> setParameters(@NonNull java.util.Map<java.lang.String,java.lang.String>);













    method public abstract boolean startBackgroundScan();













    method public abstract int step(int, boolean);













    method @Deprecated public abstract int tune(int, int);













    method public abstract void tune(@NonNull android.hardware.radio.ProgramSelector);













    method @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public abstract int cancel();













    method @Deprecated @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public abstract void cancelAnnouncement();













    method @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public abstract void close();













    method @Deprecated @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public abstract int getConfiguration(android.hardware.radio.RadioManager.BandConfig[]);













    method @Nullable @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public android.hardware.radio.ProgramList getDynamicProgramList(@Nullable android.hardware.radio.ProgramList.Filter);













    method @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public abstract boolean getMute();













    method @NonNull @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public java.util.Map<java.lang.String,java.lang.String> getParameters(@NonNull java.util.List<java.lang.String>);













    method @Deprecated @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public abstract int getProgramInformation(android.hardware.radio.RadioManager.ProgramInfo[]);













    method @Deprecated @NonNull @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public abstract java.util.List<android.hardware.radio.RadioManager.ProgramInfo> getProgramList(@Nullable java.util.Map<java.lang.String,java.lang.String>);













    method @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public abstract boolean hasControl();













    method @Deprecated @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public abstract boolean isAnalogForced();













    method @Deprecated @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public abstract boolean isAntennaConnected();













    method @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public boolean isConfigFlagSet(int);













    method @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public boolean isConfigFlagSupported(int);













    method @Deprecated @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public abstract int scan(int, boolean);













    method @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public int seek(int, boolean);













    method @Deprecated @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public abstract void setAnalogForced(boolean);













    method @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public void setConfigFlag(int, boolean);













    method @Deprecated @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public abstract int setConfiguration(android.hardware.radio.RadioManager.BandConfig);













    method @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public abstract int setMute(boolean);













    method @NonNull @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public java.util.Map<java.lang.String,java.lang.String> setParameters(@NonNull java.util.Map<java.lang.String,java.lang.String>);













    method @Deprecated @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public abstract boolean startBackgroundScan();













    method @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public abstract int step(int, boolean);













    method @Deprecated @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public abstract int tune(int, int);













    method @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RADIO) public abstract void tune(@NonNull android.hardware.radio.ProgramSelector);















    field public static final int DIRECTION_DOWN = 1; // 0x1















    field public static final int DIRECTION_UP = 0; // 0x0















    field @Deprecated public static final int ERROR_BACKGROUND_SCAN_FAILED = 6; // 0x6









@@ -5556,6 +5558,14 @@ package android.hardware.radio {













    field @Deprecated public static final int ERROR_HARDWARE_FAILURE = 0; // 0x0















    field @Deprecated public static final int ERROR_SCAN_TIMEOUT = 3; // 0x3















    field @Deprecated public static final int ERROR_SERVER_DIED = 1; // 0x1













    field public static final int TUNER_RESULT_CANCELED = 6; // 0x6













    field public static final int TUNER_RESULT_INTERNAL_ERROR = 1; // 0x1













    field public static final int TUNER_RESULT_INVALID_ARGUMENTS = 2; // 0x2













    field public static final int TUNER_RESULT_INVALID_STATE = 3; // 0x3













    field public static final int TUNER_RESULT_NOT_SUPPORTED = 4; // 0x4













    field public static final int TUNER_RESULT_OK = 0; // 0x0













    field public static final int TUNER_RESULT_TIMEOUT = 5; // 0x5













    field public static final int TUNER_RESULT_UNKNOWN_ERROR = 7; // 0x7















  }





























  public abstract static class RadioTuner.Callback {









@@ -5563,6 +5573,7 @@ package android.hardware.radio {













    method public void onAntennaState(boolean);















    method public void onBackgroundScanAvailabilityChange(boolean);















    method public void onBackgroundScanComplete();













    method public void onConfigFlagUpdated(int, boolean);















    method @Deprecated public void onConfigurationChanged(android.hardware.radio.RadioManager.BandConfig);















    method public void onControlChanged(boolean);















    method public void onEmergencyAnnouncement(boolean);

























core/java/android/hardware/radio/ITuner.aidl



+1
−1




























Original line number
Diff line number
Diff line








@@ -49,7 +49,7 @@ interface ITuner {













    /**















     * @throws IllegalStateException if called out of sequence















     */













    void scan(boolean directionDown, boolean skipSubChannel);













    void seek(boolean directionDown, boolean skipSubChannel);































    /**















     * @throws IllegalArgumentException if invalid arguments are passed

































core/java/android/hardware/radio/ITunerCallback.aidl



+19
−0




























Original line number
Diff line number
Diff line








@@ -24,6 +24,13 @@ import android.hardware.radio.RadioMetadata;













/** {@hide} */















oneway interface ITunerCallback {















    void onError(int status);



























    /**













     * Callback called when tuning operations, such as tune, step, seek, failed.













     *













     * @param result Tuning result of {@link RadioTuner#TunerResultType} type.













     * @param selector Program selector used for the tuning operation.













     */















    void onTuneFailed(int result, in ProgramSelector selector);















    void onConfigurationChanged(in RadioManager.BandConfig config);















    void onCurrentProgramInfoChanged(in RadioManager.ProgramInfo info);









@@ -36,6 +43,18 @@ oneway interface ITunerCallback {













    void onProgramListUpdated(in ProgramList.Chunk chunk);































    /**













     * Callback for passing updates to config flags from {@link IRadioService} to













     * {@link RadioTuner}.













     *













     * @param flag Config flag (defined in {@link RadioManager.ConfigFlag}) updated













     * @param value Updated value for the config flag













     */













    void onConfigFlagUpdated(int flag, boolean value);



























    /**













     * Callback for passing updates to vendor-specific parameter values from













     * {@link IRadioService} to {@link RadioTuner}.













     *















     * @param parameters Vendor-specific key-value pairs















     */















    void onParametersUpdated(in Map<String, String> parameters);

































core/java/android/hardware/radio/ProgramSelector.java



+28
−4




























Original line number
Diff line number
Diff line








@@ -167,7 +167,10 @@ public final class ProgramSelector implements Parcelable {













    public static final int IDENTIFIER_TYPE_HD_STATION_NAME = 10004;















    /**















     * @see {@link IDENTIFIER_TYPE_DAB_SID_EXT}













     *













     * @deprecated use {@link #IDENTIFIER_TYPE_DAB_DMB_SID_EXT} instead















     */













    @Deprecated















    public static final int IDENTIFIER_TYPE_DAB_SIDECC = 5;















    /**















     * 28bit compound primary identifier for Digital Audio Broadcasting.









@@ -183,7 +186,10 @@ public final class ProgramSelector implements Parcelable {













     *















     * The remaining bits should be set to zeros when writing on the chip side















     * and ignored when read.













     *













     * @deprecated use {@link #IDENTIFIER_TYPE_DAB_DMB_SID_EXT} instead















     */













    @Deprecated















    public static final int IDENTIFIER_TYPE_DAB_SID_EXT = IDENTIFIER_TYPE_DAB_SIDECC;















    /** 16bit */















    public static final int IDENTIFIER_TYPE_DAB_ENSEMBLE = 6;









@@ -197,7 +203,7 @@ public final class ProgramSelector implements Parcelable {













    public static final int IDENTIFIER_TYPE_DRMO_FREQUENCY = 10;















    /**















     * 1: AM, 2:FM













     * @deprecated use {@link IDENTIFIER_TYPE_DRMO_FREQUENCY} instead













     * @deprecated use {@link #IDENTIFIER_TYPE_DRMO_FREQUENCY} instead















     */















    @Deprecated















    public static final int IDENTIFIER_TYPE_DRMO_MODULATION = 11;









@@ -205,6 +211,23 @@ public final class ProgramSelector implements Parcelable {













    public static final int IDENTIFIER_TYPE_SXM_SERVICE_ID = 12;















    /** 0-999 range */















    public static final int IDENTIFIER_TYPE_SXM_CHANNEL = 13;













    /**













     * 44bit compound primary identifier for Digital Audio Broadcasting and













     * Digital Multimedia Broadcasting.













     *













     * <p>Consists of (from the LSB):













     * - 32bit: SId;













     * - 8bit: ECC code;













     * - 4bit: SCIdS.













     *













     * <p>SCIdS (Service Component Identifier within the Service) value













     * of 0 represents the main service, while 1 and above represents













     * secondary services.













     *













     * The remaining bits should be set to zeros when writing on the chip side













     * and ignored when read.













     */













    public static final int IDENTIFIER_TYPE_DAB_DMB_SID_EXT = 14;















    /**















     * Primary identifier for vendor-specific radio technology.















     * The value format is determined by a vendor.









@@ -219,12 +242,12 @@ public final class ProgramSelector implements Parcelable {













     */















    public static final int IDENTIFIER_TYPE_VENDOR_END = PROGRAM_TYPE_VENDOR_END;















    /**













     * @deprecated use {@link IDENTIFIER_TYPE_VENDOR_START} instead













     * @deprecated use {@link #IDENTIFIER_TYPE_VENDOR_START} instead















     */















    @Deprecated















    public static final int IDENTIFIER_TYPE_VENDOR_PRIMARY_START = IDENTIFIER_TYPE_VENDOR_START;















    /**













     * @deprecated use {@link IDENTIFIER_TYPE_VENDOR_END} instead













     * @deprecated use {@link #IDENTIFIER_TYPE_VENDOR_END} instead















     */















    @Deprecated















    public static final int IDENTIFIER_TYPE_VENDOR_PRIMARY_END = IDENTIFIER_TYPE_VENDOR_END;









@@ -245,6 +268,7 @@ public final class ProgramSelector implements Parcelable {













        IDENTIFIER_TYPE_DRMO_MODULATION,















        IDENTIFIER_TYPE_SXM_SERVICE_ID,















        IDENTIFIER_TYPE_SXM_CHANNEL,













        IDENTIFIER_TYPE_DAB_DMB_SID_EXT,















    })















    @IntRange(from = IDENTIFIER_TYPE_VENDOR_START, to = IDENTIFIER_TYPE_VENDOR_END)















    @Retention(RetentionPolicy.SOURCE)










@@ -285,7 +309,7 @@ public final class ProgramSelector implements Parcelable {













     * Type of a radio technology.















     *















     * @return program type.













     * @deprecated use {@link getPrimaryId} instead













     * @deprecated use {@link #getPrimaryId} instead















     */















    @Deprecated















    public @ProgramType int getProgramType() {

































core/java/android/hardware/radio/RadioManager.java



+20
−0




























Original line number
Diff line number
Diff line








@@ -82,6 +82,24 @@ public class RadioManager {













    /** Method return status: time out before operation completion */















    public static final int STATUS_TIMED_OUT = -110;





























    /**













     *  Radio operation status types













     *













     * @hide













     */













    @IntDef(prefix = { "STATUS_" }, value = {













            STATUS_OK,













            STATUS_ERROR,













            STATUS_PERMISSION_DENIED,













            STATUS_NO_INIT,













            STATUS_BAD_VALUE,













            STATUS_DEAD_OBJECT,













            STATUS_INVALID_OPERATION,













            STATUS_TIMED_OUT,













    })













    @Retention(RetentionPolicy.SOURCE)













    public @interface RadioStatusType{}













































    // keep in sync with radio_class_t in /system/core/incluse/system/radio.h















    /** Radio module class supporting FM (including HD radio) and AM */










@@ -330,6 +348,7 @@ public class RadioManager {













         * program list.















         * @return the number of audio sources available.















         */













        @RadioStatusType















        public int getNumAudioSources() {















            return mNumAudioSources;















        }










@@ -1724,6 +1743,7 @@ public class RadioManager {













     * </ul>















     */















    @RequiresPermission(Manifest.permission.ACCESS_BROADCAST_RADIO)













    @RadioStatusType















    public int listModules(List<ModuleProperties> modules) {















        if (modules == null) {















            Log.e(TAG, "the output list must not be empty");