1 /* 2 * Copyright 2020 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.tv.tuner; 18 19 import android.annotation.FlaggedApi; 20 import android.annotation.IntDef; 21 import android.annotation.SystemApi; 22 import android.annotation.TestApi; 23 import android.media.tv.flags.Flags; 24 import android.util.Log; 25 26 import java.lang.annotation.Retention; 27 import java.lang.annotation.RetentionPolicy; 28 29 /** 30 * Utility class to check the currently running Tuner Hal implementation version. 31 * 32 * APIs that are not supported by the HAL implementation version would be no-op. 33 * 34 * @hide 35 */ 36 @SystemApi 37 public final class TunerVersionChecker { 38 private static final String TAG = "TunerVersionChecker"; 39 TunerVersionChecker()40 private TunerVersionChecker() {} 41 42 /** @hide */ 43 @IntDef(prefix = "TUNER_VERSION_", 44 value = {TUNER_VERSION_UNKNOWN, TUNER_VERSION_1_0, TUNER_VERSION_1_1, 45 TUNER_VERSION_2_0, TUNER_VERSION_3_0, TUNER_VERSION_4_0}) 46 @Retention(RetentionPolicy.SOURCE) 47 public @interface TunerVersion {} 48 /** 49 * Unknown Tuner version. 50 */ 51 public static final int TUNER_VERSION_UNKNOWN = 0; 52 /** 53 * Tuner version 1.0. 54 */ 55 public static final int TUNER_VERSION_1_0 = (1 << 16); 56 /** 57 * Tuner version 1.1. 58 */ 59 public static final int TUNER_VERSION_1_1 = ((1 << 16) | 1); 60 /** 61 * Tuner version 2.0. 62 */ 63 public static final int TUNER_VERSION_2_0 = (2 << 16); 64 /** 65 * Tuner version 3.0. 66 */ 67 public static final int TUNER_VERSION_3_0 = (3 << 16); 68 /** 69 * Tuner version 4.0. 70 */ 71 @FlaggedApi(Flags.FLAG_TUNER_W_APIS) 72 public static final int TUNER_VERSION_4_0 = (4 << 16); 73 74 /** 75 * Get the current running Tuner version. 76 * 77 * @return Tuner version. 78 */ 79 @TunerVersion getTunerVersion()80 public static int getTunerVersion() { 81 return Tuner.getTunerVersion(); 82 } 83 84 /** 85 * Check if the current running Tuner version supports the given version. 86 * 87 * <p>Note that we treat different major versions as unsupported among each other. If any 88 * feature could be supported across major versions, please use 89 * {@link #isHigherOrEqualVersionTo(int)} to check. 90 * 91 * @param version the version to support. 92 * 93 * @return true if the current version is under the same major version as the given version 94 * and has higher or the same minor version as the given version. 95 * @hide 96 */ 97 @TestApi supportTunerVersion(@unerVersion int version)98 public static boolean supportTunerVersion(@TunerVersion int version) { 99 int currentVersion = Tuner.getTunerVersion(); 100 return isHigherOrEqualVersionTo(version) 101 && (getMajorVersion(version) == getMajorVersion(currentVersion)); 102 } 103 104 /** 105 * Check if the current running Tuner version is higher than or equal to a given version. 106 * 107 * @param version the version to compare. 108 * 109 * @return true if the current version is higher or equal to the support version. 110 * @hide 111 */ 112 @TestApi isHigherOrEqualVersionTo(@unerVersion int version)113 public static boolean isHigherOrEqualVersionTo(@TunerVersion int version) { 114 int currentVersion = Tuner.getTunerVersion(); 115 return currentVersion >= version; 116 } 117 118 /** 119 * Get the major version from a version number. 120 * 121 * @param version the version to be checked. 122 * 123 * @return the major version number. 124 * @hide 125 */ 126 @TestApi getMajorVersion(@unerVersion int version)127 public static int getMajorVersion(@TunerVersion int version) { 128 return ((version & 0xFFFF0000) >>> 16); 129 } 130 131 /** 132 * Get the major version from a version number. 133 * 134 * @param version the version to be checked. 135 * 136 * @return the minor version number. 137 * @hide 138 */ 139 @TestApi getMinorVersion(@unerVersion int version)140 public static int getMinorVersion(@TunerVersion int version) { 141 return (version & 0xFFFF); 142 } 143 144 /** @hide */ checkHigherOrEqualVersionTo( @unerVersion int version, String methodName)145 public static boolean checkHigherOrEqualVersionTo( 146 @TunerVersion int version, String methodName) { 147 if (!TunerVersionChecker.isHigherOrEqualVersionTo(version)) { 148 Log.e(TAG, "Current Tuner version " 149 + TunerVersionChecker.getMajorVersion(Tuner.getTunerVersion()) + "." 150 + TunerVersionChecker.getMinorVersion(Tuner.getTunerVersion()) 151 + " does not support " + methodName + "."); 152 return false; 153 } 154 return true; 155 } 156 157 /** @hide */ checkSupportVersion(@unerVersion int version, String methodName)158 public static boolean checkSupportVersion(@TunerVersion int version, String methodName) { 159 if (!TunerVersionChecker.supportTunerVersion(version)) { 160 Log.e(TAG, "Current Tuner version " 161 + TunerVersionChecker.getMajorVersion(Tuner.getTunerVersion()) + "." 162 + TunerVersionChecker.getMinorVersion(Tuner.getTunerVersion()) 163 + " does not support " + methodName + "."); 164 return false; 165 } 166 return true; 167 } 168 } 169