114 |
115 |
116 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright {yyyy} {name of copyright owner}
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
203 |
--------------------------------------------------------------------------------
/app/src/main/java/com/serenegiant/uvcpermissiontest/MainActivity.kt:
--------------------------------------------------------------------------------
1 | package com.serenegiant.uvcpermissiontest
2 |
3 | import android.Manifest
4 | import android.app.PendingIntent
5 | import android.content.BroadcastReceiver
6 | import android.content.Context
7 | import android.content.Intent
8 | import android.content.IntentFilter
9 | import android.content.pm.PackageManager
10 | import android.hardware.usb.UsbConstants
11 | import android.hardware.usb.UsbDevice
12 | import android.hardware.usb.UsbManager
13 | import android.os.Build
14 | import android.os.Bundle
15 | import android.text.TextUtils
16 | import android.util.Log
17 | import android.view.View
18 | import android.widget.ScrollView
19 | import android.widget.TextView
20 | import androidx.appcompat.app.AppCompatActivity
21 | import androidx.core.app.ActivityCompat
22 | import com.google.android.material.snackbar.Snackbar
23 | import kotlin.math.min
24 |
25 | class MainActivity : AppCompatActivity() {
26 |
27 | private lateinit var mainFrame: View
28 | private lateinit var mLogScrollView: ScrollView
29 | private lateinit var logTv: TextView
30 |
31 | override fun onCreate(savedInstanceState: Bundle?) {
32 | super.onCreate(savedInstanceState)
33 |
34 | if (DEBUG) Log.v(TAG, "onCreate:")
35 | setContentView(R.layout.activity_main)
36 | this.title = "targetSDK${applicationInfo.targetSdkVersion}"
37 | mainFrame = findViewById(R.id.main_frame)
38 | mLogScrollView = findViewById(R.id.log_scrollview)
39 | logTv = findViewById(R.id.log_textview)
40 |
41 | // output information to screen
42 | var msg = "targetSDKVersion=${applicationInfo.targetSdkVersion}"
43 | if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
44 | msg = "${msg}\n minSDKVersion=${applicationInfo.minSdkVersion}"
45 | }
46 | msg = "${msg}\n SDK_INT=${Build.VERSION.SDK_INT}\n" +
47 | " BOARD=${Build.BOARD}\n" +
48 | " BOOTLOADER=${Build.BOOTLOADER}\n" +
49 | " BRAND=${Build.BRAND}\n" +
50 | " DEVICE=${Build.DEVICE}\n" +
51 | " DISPLAY=${Build.DISPLAY}\n" +
52 | " HARDWARE=${Build.HARDWARE}\n" +
53 | " ID=${Build.ID}\n" +
54 | " MANUFACTURER=${Build.MANUFACTURER}\n" +
55 | " PRODUCT=${Build.PRODUCT}\n" +
56 | " TAGS=${Build.TAGS}\n" +
57 | " VERSION.MODEL=${Build.MODEL}\n"
58 | log("Info", msg)
59 |
60 | // check CAMERA permission
61 | val hasPermission= ActivityCompat.checkSelfPermission(this,
62 | Manifest.permission.CAMERA) == PackageManager.PERMISSION_GRANTED
63 | if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
64 | // Android 9 and later needs CAMERA permission to access UVC devices
65 | if (hasPermission) {
66 | log("CAMERA permission", "already granted")
67 | } else {
68 | requestCameraPermission()
69 | }
70 | } else {
71 | log("CAMERA permission", "before Android 9,CAMERA permission=$hasPermission")
72 | }
73 | }
74 |
75 | override fun onNewIntent(intent: Intent?) {
76 | super.onNewIntent(intent)
77 | if (DEBUG) Log.v(TAG, "onNewIntent:$intent")
78 | if (intent != null) {
79 | runOnUiThread {
80 | handleIntent(intent)
81 | }
82 | }
83 | }
84 |
85 | override fun onStart() {
86 | super.onStart()
87 | if (DEBUG) Log.v(TAG, "onStart:")
88 | // Register BroadcastReceiver to receive USB related events
89 | val filter = IntentFilter(ACTION_USB_PERMISSION)
90 | filter.addAction(UsbManager.ACTION_USB_DEVICE_ATTACHED)
91 | filter.addAction(UsbManager.ACTION_USB_DEVICE_DETACHED)
92 | registerReceiver(mBroadcastReceiver, filter)
93 | log("BroadcastReceiver", "register")
94 | if (intent != null) {
95 | runOnUiThread {
96 | handleIntent(intent)
97 | }
98 | }
99 | }
100 |
101 | override fun onStop() {
102 | if (DEBUG) Log.v(TAG, "onStop:")
103 | unregisterReceiver(mBroadcastReceiver)
104 | log("BroadcastReceiver", "unregister")
105 | super.onStop()
106 | }
107 |
108 | override fun onDestroy() {
109 | if (DEBUG) Log.v(TAG, "onDestroy:")
110 | super.onDestroy()
111 | }
112 |
113 | //--------------------------------------------------------------------------------
114 | /**
115 | * When received result of permission request
116 | */
117 | override fun onRequestPermissionsResult(
118 | requestCode: Int, permissions: Array, grantResults: IntArray) {
119 | super.onRequestPermissionsResult(requestCode, permissions, grantResults)
120 | val n = min(permissions.size, grantResults.size)
121 | for (i in 0 until n) {
122 | handlePermissionResult(permissions[i],
123 | grantResults[i] == PackageManager.PERMISSION_GRANTED)
124 | }
125 | }
126 |
127 | private fun handlePermissionResult(permission: String, result: Boolean) {
128 | if (result) {
129 | if (permission == Manifest.permission.CAMERA) {
130 | log("CAMERA permission", "granted")
131 | Snackbar.make(mainFrame,
132 | R.string.camera_permission_granted, Snackbar.LENGTH_SHORT
133 | ).show()
134 | scanAttachedDevice()
135 | }
136 | } else {
137 | log("CAMERA permission", "denied")
138 | Snackbar.make(mainFrame,
139 | R.string.camera_permission_denied, Snackbar.LENGTH_SHORT
140 | ).show()
141 | }
142 | }
143 |
144 | //--------------------------------------------------------------------------------
145 | /**
146 | * request CAMERA permission
147 | * Android 9 and later needs CAMERA permission to access UVC devices
148 | */
149 | private fun requestCameraPermission() {
150 | if (DEBUG) Log.v(TAG, "requestCameraPermission:")
151 | if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.CAMERA)) {
152 | Snackbar.make(mainFrame,
153 | R.string.camera_access_required, Snackbar.LENGTH_INDEFINITE)
154 | .setAction(android.R.string.ok) {
155 | // Request the permission
156 | log("CAMERA permission", "request")
157 | ActivityCompat.requestPermissions(
158 | this@MainActivity,
159 | arrayOf(Manifest.permission.CAMERA),
160 | REQ_PERMISSION_CAMERA
161 | )
162 | }
163 | .show()
164 | } else {
165 | Snackbar.make(mainFrame,
166 | R.string.camera_unavailable, Snackbar.LENGTH_SHORT
167 | ).show()
168 | log("CAMERA permission", "request")
169 | ActivityCompat.requestPermissions(
170 | this@MainActivity,
171 | arrayOf(Manifest.permission.CAMERA),
172 | REQ_PERMISSION_CAMERA
173 | )
174 | }
175 | }
176 |
177 | //--------------------------------------------------------------------------------
178 | /**
179 | * BroadcastReceiver to receive USB related events
180 | */
181 | private val mBroadcastReceiver = object : BroadcastReceiver() {
182 | override fun onReceive(context: Context?, intent: Intent?) {
183 | if (intent != null) {
184 | handleIntent(intent)
185 | }
186 | }
187 | }
188 |
189 | /**
190 | * Handle received Intent
191 | */
192 | private fun handleIntent(intent: Intent) {
193 | if (DEBUG) Log.v(TAG, "handleIntent:$intent")
194 | when (intent.action) {
195 | UsbManager.ACTION_USB_DEVICE_ATTACHED
196 | -> handleActionOnAttachDevice(intent)
197 | UsbManager.ACTION_USB_DEVICE_DETACHED
198 | -> handleActionOnDetachDevice(intent)
199 | ACTION_USB_PERMISSION
200 | -> handleActionUsbPermission(intent)
201 | Intent.ACTION_MAIN
202 | -> scanAttachedDevice() // app launched by user
203 | else -> {
204 | log("Unknown intent", "action=" + intent.action)
205 | }
206 | }
207 | }
208 |
209 | /**
210 | * when app received attach event of USB device
211 | */
212 | private fun handleActionOnAttachDevice(intent: Intent) {
213 | if (DEBUG) Log.v(TAG, "handleActionOnAttachDevice:$intent")
214 | val manager = getSystemService(Context.USB_SERVICE) as UsbManager
215 | val device = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
216 | intent.getParcelableExtra(UsbManager.EXTRA_DEVICE, UsbDevice::class.java)
217 | } else {
218 | intent.getParcelableExtra(UsbManager.EXTRA_DEVICE)
219 | }
220 | var hasPermission = intent.getBooleanExtra(UsbManager.EXTRA_PERMISSION_GRANTED, false)
221 | if (device != null) {
222 | hasPermission = hasPermission || manager.hasPermission(device)
223 | log("USB_DEVICE_ATTACHED", "hasPermission=$hasPermission\n ${deviceName(device)}")
224 | if (!hasPermission) {
225 | requestUsbPermission(manager, device)
226 | } else {
227 | log("USB permission", "already has permission:\n ${deviceName(device)}")
228 | }
229 | } else {
230 | log("USB_DEVICE_ATTACHED", "device is null")
231 | }
232 | }
233 |
234 | /**
235 | * when app received detach event of USB device
236 | */
237 | private fun handleActionOnDetachDevice(intent: Intent) {
238 | if (DEBUG) Log.v(TAG, "handleActionOnDetachDevice:$intent")
239 | val device = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
240 | intent.getParcelableExtra(UsbManager.EXTRA_DEVICE, UsbDevice::class.java)
241 | } else {
242 | intent.getParcelableExtra(UsbManager.EXTRA_DEVICE)
243 | }
244 | log("USB_DEVICE_DETACHED", deviceName(device))
245 | }
246 |
247 | /**
248 | * when app received the result of requesting USB access permission.
249 | */
250 | private fun handleActionUsbPermission(intent: Intent) {
251 | if (DEBUG) Log.v(TAG, "handleActionUsbPermission:$intent")
252 | val device = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
253 | intent.getParcelableExtra(UsbManager.EXTRA_DEVICE, UsbDevice::class.java)
254 | } else {
255 | intent.getParcelableExtra(UsbManager.EXTRA_DEVICE)
256 | }
257 | val hasPermission = intent.getBooleanExtra(UsbManager.EXTRA_PERMISSION_GRANTED, false)
258 | log("Result", "hasPermission=$hasPermission\n ${deviceName(device)}")
259 | }
260 |
261 | //--------------------------------------------------------------------------------
262 | /**
263 | * scan attached usb devices and request permission for first found device that has no permission
264 | */
265 | private fun scanAttachedDevice() {
266 | if (DEBUG) Log.v(TAG, "scanAttachedDevice:")
267 | log("SCAN", "start")
268 | val manager = getSystemService(Context.USB_SERVICE) as UsbManager
269 | val devices = manager.deviceList
270 | run loop@ {
271 | devices.values.forEach {
272 | if (isUVC(it)) {
273 | if (!manager.hasPermission(it)) {
274 | requestUsbPermission(manager, it)
275 | // XXX only request permission for first found device now
276 | return@loop
277 | } else {
278 | log("USB permission", "already has permission:\n ${deviceName(it)}")
279 | }
280 | }
281 | }
282 | }
283 | log("SCAN", "finished")
284 | }
285 |
286 | /**
287 | * request USB permission for specific device
288 | */
289 | private fun requestUsbPermission(manager: UsbManager, device: UsbDevice) {
290 | log("USB permission", "request\n ${deviceName(device)}")
291 | runOnUiThread {
292 | var flags = 0
293 | if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) {
294 | flags = flags or PendingIntent.FLAG_MUTABLE
295 | }
296 | val permissionIntent = PendingIntent.getBroadcast(this, REQ_PERMISSION_USB,
297 | Intent(ACTION_USB_PERMISSION)
298 | .setPackage(packageName),
299 | flags)
300 | manager.requestPermission(device, permissionIntent)
301 | }
302 | }
303 |
304 | /**
305 | * check whether the specific device or one of its interfaces is VIDEO class
306 | */
307 | private fun isUVC(device: UsbDevice?): Boolean {
308 | var result = false
309 | if (device != null) {
310 | if (device.deviceClass == UsbConstants.USB_CLASS_VIDEO) {
311 | result = true
312 | } else {
313 | loop@ for (i in 0..device.interfaceCount) {
314 | val iface = device.getInterface(i)
315 | if (iface.interfaceClass == UsbConstants.USB_CLASS_VIDEO) {
316 | result = true
317 | break@loop
318 | }
319 | }
320 | }
321 | }
322 | return result
323 | }
324 |
325 | /**
326 | * get device name of specific UsbDevice
327 | * return productName if it is available else return deviceName
328 | */
329 | private fun deviceName(device: UsbDevice?): String {
330 | var result = "device is null"
331 | if (device != null) {
332 | result = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
333 | if (!TextUtils.isEmpty(device.productName)) device.productName!! else device.deviceName
334 | } else {
335 | device.deviceName
336 | }
337 | }
338 | return result
339 | }
340 |
341 | //--------------------------------------------------------------------------------
342 | /**
343 | * add message to TextView
344 | */
345 | private fun log(tag: String, msg: String) {
346 | runOnUiThread {
347 | logTv.append("$tag:\n $msg\n")
348 | mLogScrollView.scrollTo(0, logTv.bottom)
349 | }
350 | }
351 |
352 | //--------------------------------------------------------------------------------
353 | companion object {
354 | private const val DEBUG = true
355 | private val TAG = MainActivity::class.simpleName
356 | private const val ACTION_USB_PERMISSION = "ACTION_USB_PERMISSION"
357 | private const val REQ_PERMISSION_USB = 16
358 | private const val REQ_PERMISSION_CAMERA = 18
359 | }
360 | }
361 |
--------------------------------------------------------------------------------