Add radio API for HD radio and program list
Added radio APIs to improve HD radio support, and allow multiple DAB
radio stations with the same primary identifiers in program list.
Bug: 280300929
Test: atest CtsBroadcastRadioTestCases
Change-Id: I2e772cba88c4ffaeba09f74351a978adf3e85f13
diff --git a/core/api/system-current.txt b/core/api/system-current.txt
index a99eeb0..3bcae6a 100644
--- a/core/api/system-current.txt
+++ b/core/api/system-current.txt
@@ -5581,7 +5581,8 @@
method public void addOnCompleteListener(@NonNull java.util.concurrent.Executor, @NonNull android.hardware.radio.ProgramList.OnCompleteListener);
method public void addOnCompleteListener(@NonNull android.hardware.radio.ProgramList.OnCompleteListener);
method public void close();
- method @Nullable public android.hardware.radio.RadioManager.ProgramInfo get(@NonNull android.hardware.radio.ProgramSelector.Identifier);
+ method @Deprecated @Nullable public android.hardware.radio.RadioManager.ProgramInfo get(@NonNull android.hardware.radio.ProgramSelector.Identifier);
+ method @FlaggedApi("android.hardware.radio.hd_radio_improved") @NonNull public java.util.List<android.hardware.radio.RadioManager.ProgramInfo> getProgramInfos(@NonNull android.hardware.radio.ProgramSelector.Identifier);
method public void registerListCallback(@NonNull java.util.concurrent.Executor, @NonNull android.hardware.radio.ProgramList.ListCallback);
method public void registerListCallback(@NonNull android.hardware.radio.ProgramList.ListCallback);
method public void removeOnCompleteListener(@NonNull android.hardware.radio.ProgramList.OnCompleteListener);
@@ -5635,12 +5636,13 @@
field @Deprecated public static final int IDENTIFIER_TYPE_DRMO_MODULATION = 11; // 0xb
field public static final int IDENTIFIER_TYPE_DRMO_SERVICE_ID = 9; // 0x9
field public static final int IDENTIFIER_TYPE_HD_STATION_ID_EXT = 3; // 0x3
+ field @FlaggedApi("android.hardware.radio.hd_radio_improved") public static final int IDENTIFIER_TYPE_HD_STATION_LOCATION = 15; // 0xf
field public static final int IDENTIFIER_TYPE_HD_STATION_NAME = 10004; // 0x2714
field @Deprecated public static final int IDENTIFIER_TYPE_HD_SUBCHANNEL = 4; // 0x4
field public static final int IDENTIFIER_TYPE_INVALID = 0; // 0x0
field public static final int IDENTIFIER_TYPE_RDS_PI = 2; // 0x2
- field public static final int IDENTIFIER_TYPE_SXM_CHANNEL = 13; // 0xd
- field public static final int IDENTIFIER_TYPE_SXM_SERVICE_ID = 12; // 0xc
+ field @Deprecated public static final int IDENTIFIER_TYPE_SXM_CHANNEL = 13; // 0xd
+ field @Deprecated public static final int IDENTIFIER_TYPE_SXM_SERVICE_ID = 12; // 0xc
field public static final int IDENTIFIER_TYPE_VENDOR_END = 1999; // 0x7cf
field @Deprecated public static final int IDENTIFIER_TYPE_VENDOR_PRIMARY_END = 1999; // 0x7cf
field @Deprecated public static final int IDENTIFIER_TYPE_VENDOR_PRIMARY_START = 1000; // 0x3e8
@@ -5655,6 +5657,14 @@
field @Deprecated public static final int PROGRAM_TYPE_SXM = 7; // 0x7
field @Deprecated public static final int PROGRAM_TYPE_VENDOR_END = 1999; // 0x7cf
field @Deprecated public static final int PROGRAM_TYPE_VENDOR_START = 1000; // 0x3e8
+ field @FlaggedApi("android.hardware.radio.hd_radio_improved") public static final int SUB_CHANNEL_HD_1 = 1; // 0x1
+ field @FlaggedApi("android.hardware.radio.hd_radio_improved") public static final int SUB_CHANNEL_HD_2 = 2; // 0x2
+ field @FlaggedApi("android.hardware.radio.hd_radio_improved") public static final int SUB_CHANNEL_HD_3 = 4; // 0x4
+ field @FlaggedApi("android.hardware.radio.hd_radio_improved") public static final int SUB_CHANNEL_HD_4 = 8; // 0x8
+ field @FlaggedApi("android.hardware.radio.hd_radio_improved") public static final int SUB_CHANNEL_HD_5 = 16; // 0x10
+ field @FlaggedApi("android.hardware.radio.hd_radio_improved") public static final int SUB_CHANNEL_HD_6 = 32; // 0x20
+ field @FlaggedApi("android.hardware.radio.hd_radio_improved") public static final int SUB_CHANNEL_HD_7 = 64; // 0x40
+ field @FlaggedApi("android.hardware.radio.hd_radio_improved") public static final int SUB_CHANNEL_HD_8 = 128; // 0x80
}
public static final class ProgramSelector.Identifier implements android.os.Parcelable {
@@ -5667,7 +5677,7 @@
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, 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 {
+ @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, android.hardware.radio.ProgramSelector.IDENTIFIER_TYPE_HD_STATION_LOCATION}) @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 {
@@ -5691,7 +5701,9 @@
field public static final int CONFIG_DAB_DAB_SOFT_LINKING = 8; // 0x8
field public static final int CONFIG_DAB_FM_LINKING = 7; // 0x7
field public static final int CONFIG_DAB_FM_SOFT_LINKING = 9; // 0x9
- field public static final int CONFIG_FORCE_ANALOG = 2; // 0x2
+ field @Deprecated public static final int CONFIG_FORCE_ANALOG = 2; // 0x2
+ field @FlaggedApi("android.hardware.radio.hd_radio_improved") public static final int CONFIG_FORCE_ANALOG_AM = 11; // 0xb
+ field @FlaggedApi("android.hardware.radio.hd_radio_improved") public static final int CONFIG_FORCE_ANALOG_FM = 10; // 0xa
field public static final int CONFIG_FORCE_DIGITAL = 3; // 0x3
field public static final int CONFIG_FORCE_MONO = 1; // 0x1
field public static final int CONFIG_RDS_AF = 4; // 0x4
@@ -5819,8 +5831,11 @@
method @Deprecated public int getSubChannel();
method @NonNull public java.util.Map<java.lang.String,java.lang.String> getVendorInfo();
method @Deprecated public boolean isDigital();
+ method @FlaggedApi("android.hardware.radio.hd_radio_improved") public boolean isHdAudioAvailable();
+ method @FlaggedApi("android.hardware.radio.hd_radio_improved") public boolean isHdSisAvailable();
method public boolean isLive();
method public boolean isMuted();
+ method @FlaggedApi("android.hardware.radio.hd_radio_improved") public boolean isSignalAcquired();
method public boolean isStereo();
method public boolean isTrafficAnnouncementActive();
method public boolean isTrafficProgram();
@@ -5836,6 +5851,7 @@
method public android.hardware.radio.RadioMetadata.Clock getClock(String);
method public int getInt(String);
method public String getString(String);
+ method @FlaggedApi("android.hardware.radio.hd_radio_improved") @NonNull public String[] getStringArray(@NonNull String);
method public java.util.Set<java.lang.String> keySet();
method public int size();
method public void writeToParcel(android.os.Parcel, int);
@@ -5844,6 +5860,9 @@
field public static final String METADATA_KEY_ART = "android.hardware.radio.metadata.ART";
field public static final String METADATA_KEY_ARTIST = "android.hardware.radio.metadata.ARTIST";
field public static final String METADATA_KEY_CLOCK = "android.hardware.radio.metadata.CLOCK";
+ field @FlaggedApi("android.hardware.radio.hd_radio_improved") public static final String METADATA_KEY_COMMENT_ACTUAL_TEXT = "android.hardware.radio.metadata.COMMENT_ACTUAL_TEXT";
+ field @FlaggedApi("android.hardware.radio.hd_radio_improved") public static final String METADATA_KEY_COMMENT_SHORT_DESCRIPTION = "android.hardware.radio.metadata.COMMENT_SHORT_DESCRIPTION";
+ field @FlaggedApi("android.hardware.radio.hd_radio_improved") public static final String METADATA_KEY_COMMERCIAL = "android.hardware.radio.metadata.COMMERCIAL";
field public static final String METADATA_KEY_DAB_COMPONENT_NAME = "android.hardware.radio.metadata.DAB_COMPONENT_NAME";
field public static final String METADATA_KEY_DAB_COMPONENT_NAME_SHORT = "android.hardware.radio.metadata.DAB_COMPONENT_NAME_SHORT";
field public static final String METADATA_KEY_DAB_ENSEMBLE_NAME = "android.hardware.radio.metadata.DAB_ENSEMBLE_NAME";
@@ -5851,6 +5870,9 @@
field public static final String METADATA_KEY_DAB_SERVICE_NAME = "android.hardware.radio.metadata.DAB_SERVICE_NAME";
field public static final String METADATA_KEY_DAB_SERVICE_NAME_SHORT = "android.hardware.radio.metadata.DAB_SERVICE_NAME_SHORT";
field public static final String METADATA_KEY_GENRE = "android.hardware.radio.metadata.GENRE";
+ field @FlaggedApi("android.hardware.radio.hd_radio_improved") public static final String METADATA_KEY_HD_STATION_NAME_LONG = "android.hardware.radio.metadata.HD_STATION_NAME_LONG";
+ field @FlaggedApi("android.hardware.radio.hd_radio_improved") public static final String METADATA_KEY_HD_STATION_NAME_SHORT = "android.hardware.radio.metadata.HD_STATION_NAME_SHORT";
+ field @FlaggedApi("android.hardware.radio.hd_radio_improved") public static final String METADATA_KEY_HD_SUBCHANNELS_AVAILABLE = "android.hardware.radio.metadata.HD_SUBCHANNELS_AVAILABLE";
field public static final String METADATA_KEY_ICON = "android.hardware.radio.metadata.ICON";
field public static final String METADATA_KEY_PROGRAM_NAME = "android.hardware.radio.metadata.PROGRAM_NAME";
field public static final String METADATA_KEY_RBDS_PTY = "android.hardware.radio.metadata.RBDS_PTY";
@@ -5859,6 +5881,7 @@
field public static final String METADATA_KEY_RDS_PTY = "android.hardware.radio.metadata.RDS_PTY";
field public static final String METADATA_KEY_RDS_RT = "android.hardware.radio.metadata.RDS_RT";
field public static final String METADATA_KEY_TITLE = "android.hardware.radio.metadata.TITLE";
+ field @FlaggedApi("android.hardware.radio.hd_radio_improved") public static final String METADATA_KEY_UFIDS = "android.hardware.radio.metadata.UFIDS";
}
public static final class RadioMetadata.Builder {
@@ -5869,6 +5892,7 @@
method public android.hardware.radio.RadioMetadata.Builder putClock(String, long, int);
method public android.hardware.radio.RadioMetadata.Builder putInt(String, int);
method public android.hardware.radio.RadioMetadata.Builder putString(String, String);
+ method @FlaggedApi("android.hardware.radio.hd_radio_improved") @NonNull public android.hardware.radio.RadioMetadata.Builder putStringArray(@NonNull String, @NonNull String[]);
}
public static final class RadioMetadata.Clock implements android.os.Parcelable {
diff --git a/core/java/android/hardware/radio/ProgramList.java b/core/java/android/hardware/radio/ProgramList.java
index 4f07acf..c5167db 100644
--- a/core/java/android/hardware/radio/ProgramList.java
+++ b/core/java/android/hardware/radio/ProgramList.java
@@ -17,6 +17,7 @@
package android.hardware.radio;
import android.annotation.CallbackExecutor;
+import android.annotation.FlaggedApi;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.SystemApi;
@@ -45,7 +46,7 @@
private final Object mLock = new Object();
@GuardedBy("mLock")
- private final Map<ProgramSelector.Identifier, Map<UniqueProgramIdentifier,
+ private final ArrayMap<ProgramSelector.Identifier, ArrayMap<UniqueProgramIdentifier,
RadioManager.ProgramInfo>> mPrograms = new ArrayMap<>();
@GuardedBy("mLock")
@@ -203,11 +204,11 @@
listCallbacksCopied = new ArrayList<>(mListCallbacks);
if (chunk.isPurge()) {
- Iterator<Map.Entry<ProgramSelector.Identifier, Map<UniqueProgramIdentifier,
- RadioManager.ProgramInfo>>> programsIterator =
- mPrograms.entrySet().iterator();
+ Iterator<Map.Entry<ProgramSelector.Identifier,
+ ArrayMap<UniqueProgramIdentifier, RadioManager.ProgramInfo>>>
+ programsIterator = mPrograms.entrySet().iterator();
while (programsIterator.hasNext()) {
- Map.Entry<ProgramSelector.Identifier, Map<UniqueProgramIdentifier,
+ Map.Entry<ProgramSelector.Identifier, ArrayMap<UniqueProgramIdentifier,
RadioManager.ProgramInfo>> removed = programsIterator.next();
if (removed.getValue() != null) {
removedList.add(removed.getKey());
@@ -270,8 +271,7 @@
if (!mPrograms.containsKey(primaryKey)) {
return;
}
- Map<UniqueProgramIdentifier, RadioManager.ProgramInfo> entries = mPrograms
- .get(primaryKey);
+ Map<UniqueProgramIdentifier, RadioManager.ProgramInfo> entries = mPrograms.get(primaryKey);
RadioManager.ProgramInfo removed = entries.remove(Objects.requireNonNull(key));
if (removed == null) return;
if (entries.size() == 0) {
@@ -287,15 +287,10 @@
public @NonNull List<RadioManager.ProgramInfo> toList() {
List<RadioManager.ProgramInfo> list = new ArrayList<>();
synchronized (mLock) {
- Iterator<Map.Entry<ProgramSelector.Identifier, Map<UniqueProgramIdentifier,
- RadioManager.ProgramInfo>>> listIterator = mPrograms.entrySet().iterator();
- while (listIterator.hasNext()) {
- Iterator<Map.Entry<UniqueProgramIdentifier,
- RadioManager.ProgramInfo>> prorgramsIterator = listIterator.next()
- .getValue().entrySet().iterator();
- while (prorgramsIterator.hasNext()) {
- list.add(prorgramsIterator.next().getValue());
- }
+ for (int index = 0; index < mPrograms.size(); index++) {
+ ArrayMap<UniqueProgramIdentifier, RadioManager.ProgramInfo> entries =
+ mPrograms.valueAt(index);
+ list.addAll(entries.values());
}
}
return list;
@@ -304,9 +299,16 @@
/**
* Returns the program with a specified primary identifier.
*
+ * <p>This method only returns the first program from the list return from
+ * {@link #getProgramInfos}
+ *
* @param id primary identifier of a program to fetch
* @return the program info, or null if there is no such program on the list
+ *
+ * @deprecated Use {@link #getProgramInfos(ProgramSelector.Identifier)} to get all programs
+ * with the given primary identifier
*/
+ @Deprecated
public @Nullable RadioManager.ProgramInfo get(@NonNull ProgramSelector.Identifier id) {
Map<UniqueProgramIdentifier, RadioManager.ProgramInfo> entries;
synchronized (mLock) {
@@ -320,6 +322,29 @@
}
/**
+ * Returns the program list with a specified primary identifier.
+ *
+ * @param id primary identifier of a program to fetch
+ * @return the program info list with the primary identifier, or empty list if there is no such
+ * program identifier on the list
+ * @throws NullPointerException if primary identifier is {@code null}
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public @NonNull List<RadioManager.ProgramInfo> getProgramInfos(
+ @NonNull ProgramSelector.Identifier id) {
+ Objects.requireNonNull(id, "Primary identifier can not be null");
+ ArrayMap<UniqueProgramIdentifier, RadioManager.ProgramInfo> entries;
+ synchronized (mLock) {
+ entries = mPrograms.get(id);
+ }
+
+ if (entries == null) {
+ return new ArrayList<>();
+ }
+ return new ArrayList<>(entries.values());
+ }
+
+ /**
* Filter for the program list.
*/
public static final class Filter implements Parcelable {
diff --git a/core/java/android/hardware/radio/ProgramSelector.java b/core/java/android/hardware/radio/ProgramSelector.java
index 12442ba..c7ec052 100644
--- a/core/java/android/hardware/radio/ProgramSelector.java
+++ b/core/java/android/hardware/radio/ProgramSelector.java
@@ -16,6 +16,7 @@
package android.hardware.radio;
+import android.annotation.FlaggedApi;
import android.annotation.IntDef;
import android.annotation.IntRange;
import android.annotation.NonNull;
@@ -124,6 +125,86 @@
@Retention(RetentionPolicy.SOURCE)
public @interface ProgramType {}
+ /**
+ * Bitmask for HD radio subchannel 1
+ *
+ * <p>There are at most 8 HD radio subchannels of 1-based om HD radio standard. It is
+ * converted to 0-based index. 0 is the index of main program service (MPS). 1 to 7 are
+ * indexes of additional supplemental program services (SPS).
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public static final int SUB_CHANNEL_HD_1 = 1 << 0;
+
+ /**
+ * Bitmask for HD radio subchannel 2
+ *
+ * <p>For further reference, see {@link #SUB_CHANNEL_HD_1}
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public static final int SUB_CHANNEL_HD_2 = 1 << 1;
+
+ /**
+ * Bitmask for HD radio subchannel 3
+ *
+ * <p>For further reference, see {@link #SUB_CHANNEL_HD_1}
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public static final int SUB_CHANNEL_HD_3 = 1 << 2;
+
+ /**
+ * Bitmask for HD radio subchannel 4
+ *
+ * <p>For further reference, see {@link #SUB_CHANNEL_HD_1}
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public static final int SUB_CHANNEL_HD_4 = 1 << 3;
+
+ /**
+ * Bitmask for HD radio subchannel 5
+ *
+ * <p>For further reference, see {@link #SUB_CHANNEL_HD_1}
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public static final int SUB_CHANNEL_HD_5 = 1 << 4;
+
+ /**
+ * Bitmask for HD radio subchannel 6
+ *
+ * <p>For further reference, see {@link #SUB_CHANNEL_HD_1}
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public static final int SUB_CHANNEL_HD_6 = 1 << 5;
+
+ /**
+ * Bitmask for HD radio subchannel 7
+ *
+ * <p>For further reference, see {@link #SUB_CHANNEL_HD_1}
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public static final int SUB_CHANNEL_HD_7 = 1 << 6;
+
+ /**
+ * Bitmask for HD radio subchannel 8
+ *
+ * <p>For further reference, see {@link #SUB_CHANNEL_HD_1}
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public static final int SUB_CHANNEL_HD_8 = 1 << 7;
+
+ /** @hide */
+ @IntDef(prefix = { "SUB_CHANNEL_HD_" }, value = {
+ SUB_CHANNEL_HD_1,
+ SUB_CHANNEL_HD_2,
+ SUB_CHANNEL_HD_3,
+ SUB_CHANNEL_HD_4,
+ SUB_CHANNEL_HD_5,
+ SUB_CHANNEL_HD_6,
+ SUB_CHANNEL_HD_7,
+ SUB_CHANNEL_HD_8,
+ })
+ @Retention(RetentionPolicy.SOURCE)
+ public @interface HdSubChannel {}
+
public static final int IDENTIFIER_TYPE_INVALID = 0;
/**
* Primary identifier for analog (without RDS) AM/FM stations:
@@ -147,19 +228,15 @@
*
* <p>Consists of (from the LSB):
* <li>
- * <ul>32bit: Station ID number.
- * <ul>4bit: HD_SUBCHANNEL.
- * <ul>18bit: AMFM_FREQUENCY.
+ * <ul>32bit: Station ID number.</ul>
+ * <ul>4bit: HD subchannel, see {@link #SUB_CHANNEL_HD_1}.</ul>
+ * <ul>18bit: AMFM_FREQUENCY.</ul>
* </li>
*
* <p>While station ID number should be unique globally, it sometimes gets
* abused by broadcasters (i.e. not being set at all). To ensure local
* uniqueness, AMFM_FREQUENCY_KHZ was added here. Global uniqueness is
- * a best-effort - see {@link IDENTIFIER_TYPE_HD_STATION_NAME}.
- *
- * <p>HD Radio subchannel is a value in range of 0-7.
- * This index is 0-based (where 0 is MPS and 1..7 are SPS),
- * as opposed to HD Radio standard (where it's 1-based).
+ * a best-effort - see {@link #IDENTIFIER_TYPE_HD_STATION_NAME}.
*
* <p>The remaining bits should be set to zeros when writing on the chip side
* and ignored when read.
@@ -202,9 +279,9 @@
*
* <p>Consists of (from the LSB):
* <li>
- * <ul>16bit: SId.
- * <ul>8bit: ECC code.
- * <ul>4bit: SCIdS.
+ * <ul>16bit: SId.</ul>
+ * <ul>8bit: ECC code.</ul>
+ * <ul>4bit: SCIdS.</ul>
* </li>
*
* <p>SCIdS (Service Component Identifier within the Service) value
@@ -238,18 +315,26 @@
public static final int IDENTIFIER_TYPE_DRMO_MODULATION = 11;
/**
* 32bit primary identifier for SiriusXM Satellite Radio.
+ *
+ * @deprecated SiriusXM Satellite Radio is not supported
*/
public static final int IDENTIFIER_TYPE_SXM_SERVICE_ID = 12;
- /** 0-999 range */
+ /**
+ * 0-999 range
+ *
+ * @deprecated SiriusXM Satellite Radio is not supported
+ */
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.
+ * <li>
+ * <ul>32bit: SId;</ul>
+ * <ul>8bit: ECC code;</ul>
+ * <ul>4bit: SCIdS.</ul>
+ * </li>
*
* <p>SCIdS (Service Component Identifier within the Service) value
* of 0 represents the main service, while 1 and above represents
@@ -260,6 +345,36 @@
*/
public static final int IDENTIFIER_TYPE_DAB_DMB_SID_EXT = 14;
/**
+ * 64bit additional identifier for HD Radio representing station location.
+ *
+ * <p>Consists of (from the LSB):
+ * <li>
+ * <ul>4 bit: Bits 0:3 of altitude</ul>
+ * <ul>13 bit: Fractional bits of longitude</ul>
+ * <ul>8 bit: Integer bits of longitude</ul>
+ * <ul>1 bit: 0 for east and 1 for west for longitude</ul>
+ * <ul>1 bit: 0, representing longitude</ul>
+ * <ul>5 bit: pad of zeros separating longitude and latitude</ul>
+ * <ul>4 bit: Bits 4:7 of altitude</ul>
+ * <ul>13 bit: Fractional bits of latitude</ul>
+ * <ul>8 bit: Integer bits of latitude</ul>
+ * <ul>1 bit: 0 for north and 1 for south for latitude</ul>
+ * <ul>1 bit: 1, representing latitude</ul>
+ * <ul>5 bit: pad of zeros</ul>
+ * </li>
+ *
+ * <p>This format is defined in NRSC-5-C document: SY_IDD_1020s.
+ *
+ * <p>Due to Station ID abuse, some
+ * {@link #IDENTIFIER_TYPE_HD_STATION_ID_EXT} identifiers may be not
+ * globally unique. To provide a best-effort solution, the station’s
+ * broadcast antenna containing the latitude and longitude may be
+ * carried as additional identifier and may be used by the tuner hardware
+ * to double-check tuning.
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public static final int IDENTIFIER_TYPE_HD_STATION_LOCATION = 15;
+ /**
* Primary identifier for vendor-specific radio technology.
* The value format is determined by a vendor.
*
@@ -300,6 +415,7 @@
IDENTIFIER_TYPE_SXM_SERVICE_ID,
IDENTIFIER_TYPE_SXM_CHANNEL,
IDENTIFIER_TYPE_DAB_DMB_SID_EXT,
+ IDENTIFIER_TYPE_HD_STATION_LOCATION,
})
@IntRange(from = IDENTIFIER_TYPE_VENDOR_START, to = IDENTIFIER_TYPE_VENDOR_END)
@Retention(RetentionPolicy.SOURCE)
diff --git a/core/java/android/hardware/radio/RadioManager.java b/core/java/android/hardware/radio/RadioManager.java
index 8c6083c..237ec01 100644
--- a/core/java/android/hardware/radio/RadioManager.java
+++ b/core/java/android/hardware/radio/RadioManager.java
@@ -18,6 +18,7 @@
import android.Manifest;
import android.annotation.CallbackExecutor;
+import android.annotation.FlaggedApi;
import android.annotation.IntDef;
import android.annotation.NonNull;
import android.annotation.Nullable;
@@ -159,12 +160,17 @@
/**
* Forces the analog playback for the supporting radio technology.
*
- * User may disable digital playback for FM HD Radio or hybrid FM/DAB with
- * this option. This is purely user choice, ie. does not reflect digital-
+ * <p>User may disable digital playback for FM HD Radio or hybrid FM/DAB with
+ * this option. This is purely user choice, i.e. does not reflect digital-
* analog handover state managed from the HAL implementation side.
*
- * Some radio technologies may not support this, ie. DAB.
+ * <p>Some radio technologies may not support this, i.e. DAB.
+ *
+ * @deprecated Use {@link #CONFIG_FORCE_ANALOG_FM} instead. If {@link #CONFIG_FORCE_ANALOG_FM}
+ * is supported in HAL, {@link RadioTuner#setConfigFlag} and {@link RadioTuner#isConfigFlagSet}
+ * with CONFIG_FORCE_ANALOG will set/get the value of {@link #CONFIG_FORCE_ANALOG_FM}.
*/
+ @Deprecated
public static final int CONFIG_FORCE_ANALOG = 2;
/**
* Forces the digital playback for the supporting radio technology.
@@ -199,6 +205,30 @@
/** Enables DAB-FM soft-linking (related content). */
public static final int CONFIG_DAB_FM_SOFT_LINKING = 9;
+ /**
+ * Forces the FM analog playback for the supporting radio technology.
+ *
+ * <p>User may disable FM digital playback for FM HD Radio or hybrid FM/DAB
+ * with this option. This is purely user choice, i.e. does not reflect
+ * digital-analog handover state managed from the HAL implementation side.
+ *
+ * <p>Some radio technologies may not support this, i.e. DAB.
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public static final int CONFIG_FORCE_ANALOG_FM = 10;
+
+ /**
+ * Forces the AM analog playback for the supporting radio technology.
+ *
+ * <p>User may disable FM digital playback for AM HD Radio or hybrid AM/DAB
+ * with this option. This is purely user choice, i.e. does not reflect
+ * digital-analog handover state managed from the HAL implementation side.
+ *
+ * <p>Some radio technologies may not support this, i.e. DAB.
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public static final int CONFIG_FORCE_ANALOG_AM = 11;
+
/** @hide */
@IntDef(prefix = { "CONFIG_" }, value = {
CONFIG_FORCE_MONO,
@@ -210,6 +240,8 @@
CONFIG_DAB_FM_LINKING,
CONFIG_DAB_DAB_SOFT_LINKING,
CONFIG_DAB_FM_SOFT_LINKING,
+ CONFIG_FORCE_ANALOG_FM,
+ CONFIG_FORCE_ANALOG_AM,
})
@Retention(RetentionPolicy.SOURCE)
public @interface ConfigFlag {}
@@ -1441,6 +1473,9 @@
private static final int FLAG_TRAFFIC_ANNOUNCEMENT = 1 << 3;
private static final int FLAG_TUNED = 1 << 4;
private static final int FLAG_STEREO = 1 << 5;
+ private static final int FLAG_SIGNAL_ACQUIRED = 1 << 6;
+ private static final int FLAG_HD_SIS_ACQUIRED = 1 << 7;
+ private static final int FLAG_HD_AUDIO_ACQUIRED = 1 << 8;
@NonNull private final ProgramSelector mSelector;
@Nullable private final ProgramSelector.Identifier mLogicallyTunedTo;
@@ -1595,7 +1630,7 @@
}
/**
- * {@code true} if radio stream is not playing, ie. due to bad reception
+ * {@code true} if radio stream is not playing, i.e. due to bad reception
* conditions or buffering. In this state volume knob MAY be disabled to
* prevent user increasing volume too much.
* It does NOT mean the user has muted audio.
@@ -1621,6 +1656,28 @@
}
/**
+ * @return {@code true} if the signal has been acquired.
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public boolean isSignalAcquired() {
+ return (mInfoFlags & FLAG_SIGNAL_ACQUIRED) != 0;
+ }
+ /**
+ * @return {@code true} if HD Station Information Service (SIS) information is available.
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public boolean isHdSisAvailable() {
+ return (mInfoFlags & FLAG_HD_SIS_ACQUIRED) != 0;
+ }
+ /**
+ * @return {@code true} if HD audio is available.
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public boolean isHdAudioAvailable() {
+ return (mInfoFlags & FLAG_HD_AUDIO_ACQUIRED) != 0;
+ }
+
+ /**
* Signal quality (as opposed to the name) indication from 0 (no signal)
* to 100 (excellent)
* @return the signal quality indication.
diff --git a/core/java/android/hardware/radio/RadioMetadata.java b/core/java/android/hardware/radio/RadioMetadata.java
index b7bf783..db14c08 100644
--- a/core/java/android/hardware/radio/RadioMetadata.java
+++ b/core/java/android/hardware/radio/RadioMetadata.java
@@ -15,6 +15,7 @@
*/
package android.hardware.radio;
+import android.annotation.FlaggedApi;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.SystemApi;
@@ -30,6 +31,7 @@
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
+import java.util.Objects;
import java.util.Set;
/**
@@ -142,12 +144,84 @@
public static final String METADATA_KEY_DAB_COMPONENT_NAME_SHORT =
"android.hardware.radio.metadata.DAB_COMPONENT_NAME_SHORT";
+ /**
+ * Short context description of comment
+ *
+ * <p>Comment could relate to the current audio program content, or it might
+ * be unrelated information that the station chooses to send. It is composed
+ * of short content description and actual text (see NRSC-G200-A and id3v2.3.0
+ * for more info).
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public static final String METADATA_KEY_COMMENT_SHORT_DESCRIPTION =
+ "android.hardware.radio.metadata.COMMENT_SHORT_DESCRIPTION";
+
+ /**
+ * Actual text of comment
+ *
+ * @see #METADATA_KEY_COMMENT_SHORT_DESCRIPTION
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public static final String METADATA_KEY_COMMENT_ACTUAL_TEXT =
+ "android.hardware.radio.metadata.COMMENT_ACTUAL_TEXT";
+
+ /**
+ * Commercial
+ *
+ * <p>Commercial is application specific and generally used to facilitate the
+ * sale of products and services (see NRSC-G200-A and id3v2.3.0 for more info).
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public static final String METADATA_KEY_COMMERCIAL =
+ "android.hardware.radio.metadata.COMMERCIAL";
+
+ /**
+ * Array of Unique File Identifiers
+ *
+ * <p>Unique File Identifier (UFID) can be used to transmit an alphanumeric
+ * identifier of the current content, or of an advertised product or
+ * service (see NRSC-G200-A and id3v2.3.0 for more info).
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public static final String METADATA_KEY_UFIDS = "android.hardware.radio.metadata.UFIDS";
+
+ /**
+ * HD short station name or HD universal short station name
+ *
+ * <p>It can be up to 12 characters (see SY_IDD_1020s for more info).
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public static final String METADATA_KEY_HD_STATION_NAME_SHORT =
+ "android.hardware.radio.metadata.HD_STATION_NAME_SHORT";
+
+ /**
+ * HD long station name, HD station slogan or HD station message
+ *
+ * <p>(see SY_IDD_1020s for more info)
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public static final String METADATA_KEY_HD_STATION_NAME_LONG =
+ "android.hardware.radio.metadata.HD_STATION_NAME_LONG";
+
+ /**
+ * Bit mask of all HD Radio subchannels available
+ *
+ * <p>Bit {@link ProgramSelector#SUB_CHANNEL_HD_1} from LSB represents the
+ * availability of HD-1 subchannel (main program service, MPS). Bits
+ * {@link ProgramSelector#SUB_CHANNEL_HD_2} to {@link ProgramSelector#SUB_CHANNEL_HD_8}
+ * from LSB represent HD-2 to HD-8 subchannel (supplemental program services, SPS)
+ * respectively.
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ public static final String METADATA_KEY_HD_SUBCHANNELS_AVAILABLE =
+ "android.hardware.radio.metadata.HD_SUBCHANNELS_AVAILABLE";
private static final int METADATA_TYPE_INVALID = -1;
private static final int METADATA_TYPE_INT = 0;
private static final int METADATA_TYPE_TEXT = 1;
private static final int METADATA_TYPE_BITMAP = 2;
private static final int METADATA_TYPE_CLOCK = 3;
+ private static final int METADATA_TYPE_TEXT_ARRAY = 4;
private static final ArrayMap<String, Integer> METADATA_KEYS_TYPE;
@@ -172,6 +246,13 @@
METADATA_KEYS_TYPE.put(METADATA_KEY_DAB_SERVICE_NAME_SHORT, METADATA_TYPE_TEXT);
METADATA_KEYS_TYPE.put(METADATA_KEY_DAB_COMPONENT_NAME, METADATA_TYPE_TEXT);
METADATA_KEYS_TYPE.put(METADATA_KEY_DAB_COMPONENT_NAME_SHORT, METADATA_TYPE_TEXT);
+ METADATA_KEYS_TYPE.put(METADATA_KEY_COMMENT_SHORT_DESCRIPTION, METADATA_TYPE_TEXT);
+ METADATA_KEYS_TYPE.put(METADATA_KEY_COMMENT_ACTUAL_TEXT, METADATA_TYPE_TEXT);
+ METADATA_KEYS_TYPE.put(METADATA_KEY_COMMERCIAL, METADATA_TYPE_TEXT);
+ METADATA_KEYS_TYPE.put(METADATA_KEY_UFIDS, METADATA_TYPE_TEXT_ARRAY);
+ METADATA_KEYS_TYPE.put(METADATA_KEY_HD_STATION_NAME_SHORT, METADATA_TYPE_TEXT);
+ METADATA_KEYS_TYPE.put(METADATA_KEY_HD_STATION_NAME_LONG, METADATA_TYPE_TEXT);
+ METADATA_KEYS_TYPE.put(METADATA_KEY_HD_SUBCHANNELS_AVAILABLE, METADATA_TYPE_INT);
}
// keep in sync with: system/media/radio/include/system/radio_metadata.h
@@ -288,9 +369,12 @@
return false;
}
for (String key : mBundle.keySet()) {
- // This logic will return a false negative if we ever put Bundles into mBundle. As of
- // 2019-04-09, we only put ints, Strings, and Parcelables in, so it's fine for now.
- if (!mBundle.get(key).equals(otherBundle.get(key))) {
+ if (Flags.hdRadioImproved() && Objects.equals(METADATA_KEYS_TYPE.get(key),
+ METADATA_TYPE_TEXT_ARRAY)) {
+ if (!Arrays.equals(mBundle.getStringArray(key), otherBundle.getStringArray(key))) {
+ return false;
+ }
+ } else if (!Objects.equals(mBundle.get(key), otherBundle.get(key))) {
return false;
}
}
@@ -326,7 +410,21 @@
sb.append(keyDisp);
sb.append('=');
- sb.append(mBundle.get(key));
+ if (Flags.hdRadioImproved() && Objects.equals(METADATA_KEYS_TYPE.get(key),
+ METADATA_TYPE_TEXT_ARRAY)) {
+ String[] stringArrayValue = mBundle.getStringArray(key);
+ sb.append('[');
+ for (int i = 0; i < stringArrayValue.length; i++) {
+ if (i != 0) {
+ sb.append(',');
+ }
+ sb.append(stringArrayValue[i]);
+ }
+ sb.append(']');
+ } else {
+ sb.append(mBundle.get(key));
+ }
+
}
sb.append("]");
@@ -427,6 +525,36 @@
return clock;
}
+ /**
+ * Gets the string array value associated with the given key as a string
+ * array.
+ *
+ * <p>Only string array keys may be used with this method:
+ * <ul>
+ * <li>{@link #METADATA_KEY_UFIDS}</li>
+ * </ul>
+ *
+ * @param key The key the value is stored under
+ * @return String array of the given string-array-type key
+ * @throws NullPointerException if metadata key is {@code null}
+ * @throws IllegalArgumentException if the metadata with the key is not found in
+ * metadata or the key is not of string-array type
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ @NonNull
+ public String[] getStringArray(@NonNull String key) {
+ Objects.requireNonNull(key, "Metadata key can not be null");
+ if (!Objects.equals(METADATA_KEYS_TYPE.get(key), METADATA_TYPE_TEXT_ARRAY)) {
+ throw new IllegalArgumentException("Failed to retrieve key " + key
+ + " as string array");
+ }
+ String[] stringArrayValue = mBundle.getStringArray(key);
+ if (stringArrayValue == null) {
+ throw new IllegalArgumentException("Key " + key + " is not found in metadata");
+ }
+ return stringArrayValue;
+ }
+
@Override
public int describeContents() {
return 0;
@@ -539,6 +667,11 @@
* <li>{@link #METADATA_KEY_ARTIST}</li>
* <li>{@link #METADATA_KEY_ALBUM}</li>
* <li>{@link #METADATA_KEY_GENRE}</li>
+ * <li>{@link #METADATA_KEY_COMMENT_SHORT_DESCRIPTION}</li>
+ * <li>{@link #METADATA_KEY_COMMENT_ACTUAL_TEXT}</li>
+ * <li>{@link #METADATA_KEY_COMMERCIAL}</li>
+ * <li>{@link #METADATA_KEY_HD_STATION_NAME_SHORT}</li>
+ * <li>{@link #METADATA_KEY_HD_STATION_NAME_LONG}</li>
* </ul>
*
* @param key The key for referencing this value
@@ -563,6 +696,7 @@
* <li>{@link #METADATA_KEY_RDS_PI}</li>
* <li>{@link #METADATA_KEY_RDS_PTY}</li>
* <li>{@link #METADATA_KEY_RBDS_PTY}</li>
+ * <li>{@link #METADATA_KEY_HD_SUBCHANNELS_AVAILABLE}</li>
* </ul>
* or any bitmap represented by its identifier.
*
@@ -621,6 +755,35 @@
}
/**
+ * Put a String array into the meta data. Custom keys may be used, but if
+ * the METADATA_KEYs defined in this class are used they may only be one
+ * of the following:
+ * <ul>
+ * <li>{@link #METADATA_KEY_UFIDS}</li>
+ * </ul>
+ *
+ * @param key The key for referencing this value
+ * @param value The String value to store
+ * @return the same Builder instance
+ * @throws NullPointerException if key or value is null
+ * @throws IllegalArgumentException if the key is not string-array-type key
+ */
+ @FlaggedApi(Flags.FLAG_HD_RADIO_IMPROVED)
+ @NonNull
+ public Builder putStringArray(@NonNull String key, @NonNull String[] value) {
+ Objects.requireNonNull(key, "Key can not be null");
+ Objects.requireNonNull(value, "Value can not be null");
+ if (!METADATA_KEYS_TYPE.containsKey(key)
+ || !Objects.equals(METADATA_KEYS_TYPE.get(key), METADATA_TYPE_TEXT_ARRAY)) {
+ throw new IllegalArgumentException("The " + key
+ + " key cannot be used to put a RadioMetadata String Array.");
+ }
+ mBundle.putStringArray(key, value);
+ return this;
+ }
+
+
+ /**
* Creates a {@link RadioMetadata} instance with the specified fields.
*
* @return a new {@link RadioMetadata} object
diff --git a/core/java/android/hardware/radio/TunerAdapter.java b/core/java/android/hardware/radio/TunerAdapter.java
index bdbca91..ba31ca3 100644
--- a/core/java/android/hardware/radio/TunerAdapter.java
+++ b/core/java/android/hardware/radio/TunerAdapter.java
@@ -363,7 +363,7 @@
@Override
public boolean isConfigFlagSet(@RadioManager.ConfigFlag int flag) {
try {
- return mTuner.isConfigFlagSet(flag);
+ return mTuner.isConfigFlagSet(convertForceAnalogConfigFlag(flag));
} catch (RemoteException e) {
throw new RuntimeException("Service died", e);
}
@@ -372,7 +372,7 @@
@Override
public void setConfigFlag(@RadioManager.ConfigFlag int flag, boolean value) {
try {
- mTuner.setConfigFlag(flag, value);
+ mTuner.setConfigFlag(convertForceAnalogConfigFlag(flag), value);
} catch (RemoteException e) {
throw new RuntimeException("Service died", e);
}
@@ -411,4 +411,13 @@
return false;
}
}
+
+ private @RadioManager.ConfigFlag int convertForceAnalogConfigFlag(
+ @RadioManager.ConfigFlag int flag) throws RemoteException {
+ if (Flags.hdRadioImproved() && flag == RadioManager.CONFIG_FORCE_ANALOG
+ && mTuner.isConfigFlagSupported(RadioManager.CONFIG_FORCE_ANALOG_FM)) {
+ flag = RadioManager.CONFIG_FORCE_ANALOG_FM;
+ }
+ return flag;
+ }
}
