camera-rs-android 0.5.0

Android USB permission and JNI adapter for camera
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
//! Android JNI layer that invokes Java APIs directly.
//!
//! Uses JNI reflection for the Android USB APIs to keep the Java layer small.

use std::os::fd::OwnedFd;
use std::sync::OnceLock;

use jni::objects::{AutoLocal, GlobalRef, JObject, JString};
use jni::{AttachGuard, JavaVM};

use crate::error::{CameraError, Result};
use crate::UsbDeviceInfo as CameraDeviceInfo;

// UVC interface class and subclass constants.
const INTERFACE_CLASS_VIDEO: u8 = 14; // CC_VIDEO
const INTERFACE_SUBCLASS_VIDEO_CONTROL: u8 = 1; // SC_VIDEOCONTROL
const INTERFACE_SUBCLASS_VIDEO_STREAMING: u8 = 2; // SC_VIDEOSTREAMING

/// Android state containing the JavaVM and Android Context.
static ANDROID_CONTEXT: OnceLock<AndroidContext> = OnceLock::new();

pub(crate) struct AndroidContext {
    java_vm: JavaVM,
    context_jobject: GlobalRef,
}

impl AndroidContext {
    pub fn vm(&self) -> &JavaVM {
        &self.java_vm
    }

    pub fn context(&self) -> GlobalRef {
        self.context_jobject.clone()
    }
}

/// Initializes the Android context.
pub fn init_android_context(vm: JavaVM, context: GlobalRef) {
    let android_context = AndroidContext {
        java_vm: vm,
        context_jobject: context,
    };

    if ANDROID_CONTEXT.set(android_context).is_ok() {
        log::info!("Android context initialized");
    } else {
        log::warn!("Android context already initialized; ignoring duplicate init");
    }
}

/// Returns the Android context.
pub(crate) fn get_android_context() -> Result<&'static AndroidContext> {
    ANDROID_CONTEXT.get().ok_or_else(|| {
        CameraError::adapter(
            camera::CameraErrorKind::InvalidState,
            "Android context not initialized",
        )
    })
}

/// Extracts a string from a Java object.
fn get_string(env: &mut AttachGuard, object: &JObject, method: &str) -> Result<Option<String>> {
    let string_ret = match env.call_method(object, method, "()Ljava/lang/String;", &[]) {
        Ok(ret) => ret,
        Err(e) => {
            log::debug!("Error on call get string {method}: {e}");
            if env.exception_check()? {
                env.exception_clear()?;
            }
            return Err(CameraError::adapter(
                camera::CameraErrorKind::BackendFailure,
                format!("JNI call failed: {e}"),
            ));
        }
    };

    let string = string_ret.l()?;
    let string: AutoLocal<JString> = env.auto_local(string.into());

    if string.is_null() {
        Ok(None)
    } else {
        Ok(Some(env.get_string(&string)?.into()))
    }
}

/// Scans for USB camera devices.
///
/// Invokes the Android UsbManager API through JNI.
pub fn usb_manager_scan() -> Result<Vec<CameraDeviceInfo>> {
    let ctx = get_android_context()?;

    let context = ctx.context();
    let vm = ctx.vm();
    let mut env = vm.attach_current_thread()?;

    let class_ctx = env.find_class("android/content/Context")?;
    let usb_service = &env.get_static_field(class_ctx, "USB_SERVICE", "Ljava/lang/String;")?;

    let usb_manager = env
        .call_method(
            context.as_obj(),
            "getSystemService",
            "(Ljava/lang/String;)Ljava/lang/Object;",
            &[usb_service.into()],
        )?
        .l()?;
    let usb_manager = env.auto_local(usb_manager);

    let device_hashmap = env
        .call_method(&usb_manager, "getDeviceList", "()Ljava/util/HashMap;", &[])?
        .l()?;
    let device_hashmap = env.auto_local(device_hashmap);

    let device_values = env
        .call_method(&device_hashmap, "values", "()Ljava/util/Collection;", &[])?
        .l()?;
    let device_values = env.auto_local(device_values);

    let device_values_iterator = env
        .call_method(&device_values, "iterator", "()Ljava/util/Iterator;", &[])?
        .l()?;
    let device_values_iterator = env.auto_local(device_values_iterator);

    let mut result = Vec::new();

    while env
        .call_method(&device_values_iterator, "hasNext", "()Z", &[])?
        .z()?
    {
        let item = env
            .call_method(&device_values_iterator, "next", "()Ljava/lang/Object;", &[])?
            .l()?;
        let device_next = env.auto_local(item);

        if device_next.is_null() {
            break;
        }

        let vid = env
            .call_method(&device_next, "getVendorId", "()I", &[])?
            .i()? as u16;

        let pid = env
            .call_method(&device_next, "getProductId", "()I", &[])?
            .i()? as u16;

        // Check whether this is a UVC device.
        if !scan_uvc_interface(&mut env, &device_next)? {
            continue;
        }

        // Read device details.
        // getProductName may return null.
        let product_name = get_string(&mut env, &device_next, "getProductName")?;

        // getManufacturerName may return null and requires Android 5.0 or newer.
        let manufacturer = get_string(&mut env, &device_next, "getManufacturerName")?;

        // getSerialNumber may return null and requires USB permission.
        let serial_number = get_string(&mut env, &device_next, "getSerialNumber")
            .ok()
            .flatten();

        // getDeviceName returns a path such as /dev/bus/usb/001/002.
        let device_path = get_string(&mut env, &device_next, "getDeviceName")?.unwrap_or_default();

        // getVersion is available on Android 13 and newer.
        let usb_version = get_string(&mut env, &device_next, "getVersion")
            .ok()
            .flatten();

        // Prefer the product name, then manufacturer plus VID:PID.
        let display_name = if let Some(ref name) = product_name {
            if !name.is_empty() {
                name.clone()
            } else if let Some(ref mfr) = manufacturer {
                format!("{} Camera", mfr)
            } else {
                format!("USB Camera {:04X}:{:04X}", vid, pid)
            }
        } else if let Some(ref mfr) = manufacturer {
            format!("{} Camera", mfr)
        } else {
            format!("USB Camera {:04X}:{:04X}", vid, pid)
        };

        log::debug!(
            "Found UVC device: {} (VID:{:04X} PID:{:04X}, Manufacturer: {:?}, Serial: {:?}, USB: {:?})",
            display_name, vid, pid, manufacturer, serial_number, usb_version
        );

        result.push(CameraDeviceInfo {
            index: result.len() as u32,
            name: display_name.clone(),
            description: format!("USB Camera VID:{:04X} PID:{:04X}", vid, pid),
            vendor_id: Some(vid),
            product_id: Some(pid),
            serial_number,
            device_path: Some(device_path),
        });
    }

    log::info!("Found {} UVC cameras", result.len());
    Ok(result)
}

/// Scans device interfaces to identify a UVC camera.
fn scan_uvc_interface(env: &mut AttachGuard, device: &JObject) -> Result<bool> {
    let interface_count = env
        .call_method(device, "getInterfaceCount", "()I", &[])?
        .i()?;

    for i in 0..interface_count {
        let interface = env
            .call_method(
                device,
                "getInterface",
                "(I)Landroid/hardware/usb/UsbInterface;",
                &[i.into()],
            )?
            .l()?;
        let interface = env.auto_local(interface);

        let interface_class = env
            .call_method(&interface, "getInterfaceClass", "()I", &[])?
            .i()? as u8;

        if interface_class != INTERFACE_CLASS_VIDEO {
            continue;
        }

        let interface_sub_class = env
            .call_method(&interface, "getInterfaceSubclass", "()I", &[])?
            .i()? as u8;

        if interface_sub_class == INTERFACE_SUBCLASS_VIDEO_CONTROL
            || interface_sub_class == INTERFACE_SUBCLASS_VIDEO_STREAMING
        {
            return Ok(true);
        }
    }

    Ok(false)
}

/// Checks whether USB permission has already been granted.
pub fn usb_device_has_permission(device_path: &str) -> Result<bool> {
    let ctx = get_android_context()?;

    let context = ctx.context();
    let vm = ctx.vm();
    let mut env = vm.attach_current_thread()?;

    let class_ctx = env.find_class("android/content/Context")?;
    let usb_service = &env.get_static_field(class_ctx, "USB_SERVICE", "Ljava/lang/String;")?;

    let usb_manager = env
        .call_method(
            context.as_obj(),
            "getSystemService",
            "(Ljava/lang/String;)Ljava/lang/Object;",
            &[usb_service.into()],
        )?
        .l()?;
    let usb_manager = env.auto_local(usb_manager);

    let device_hashmap = env
        .call_method(&usb_manager, "getDeviceList", "()Ljava/util/HashMap;", &[])?
        .l()?;
    let device_hashmap = env.auto_local(device_hashmap);

    let device_name: JObject = env.new_string(device_path)?.into();
    let device_name = env.auto_local(device_name);

    let device = env
        .call_method(
            &device_hashmap,
            "get",
            "(Ljava/lang/Object;)Ljava/lang/Object;",
            &[(&device_name).into()],
        )?
        .l()?;
    let device = env.auto_local(device);

    if device.is_null() {
        return Err(
            camera::CameraError::device_not_found(device_path.to_string())
                .with_backend(camera::BackendId::UVC)
                .with_stage(camera::OperationStage::Enumeration)
                .into(),
        );
    }

    let has_permission = env
        .call_method(
            &usb_manager,
            "hasPermission",
            "(Landroid/hardware/usb/UsbDevice;)Z",
            &[(&device).into()],
        )?
        .z()?;

    Ok(has_permission)
}

/// Requests permission for a USB device.
pub fn usb_device_request_permission(device_path: &str) -> Result<()> {
    let ctx = get_android_context()?;

    let context = ctx.context();
    let vm = ctx.vm();
    let mut env = vm.attach_current_thread()?;

    let class_ctx = env.find_class("android/content/Context")?;
    let usb_service = &env.get_static_field(class_ctx, "USB_SERVICE", "Ljava/lang/String;")?;

    let usb_manager = env
        .call_method(
            context.as_obj(),
            "getSystemService",
            "(Ljava/lang/String;)Ljava/lang/Object;",
            &[usb_service.into()],
        )?
        .l()?;
    let usb_manager = env.auto_local(usb_manager);

    let device_hashmap = env
        .call_method(&usb_manager, "getDeviceList", "()Ljava/util/HashMap;", &[])?
        .l()?;
    let device_hashmap = env.auto_local(device_hashmap);

    let device_name: JObject = env.new_string(device_path)?.into();
    let device_name = env.auto_local(device_name);

    let device = env
        .call_method(
            &device_hashmap,
            "get",
            "(Ljava/lang/Object;)Ljava/lang/Object;",
            &[(&device_name).into()],
        )?
        .l()?;
    let device = env.auto_local(device);

    if device.is_null() {
        return Err(
            camera::CameraError::device_not_found(device_path.to_string())
                .with_backend(camera::BackendId::UVC)
                .with_stage(camera::OperationStage::Enumeration)
                .into(),
        );
    }

    // Create the PendingIntent.
    let permission = "com.medivh.camera.USB_PERMISSION";
    let permission_str: JObject = env.new_string(permission)?.into();
    let permission_str = env.auto_local(permission_str);

    let class_intent = env.find_class("android/content/Intent")?;
    let intent = env.new_object(
        &class_intent,
        "(Ljava/lang/String;)V",
        &[(&permission_str).into()],
    )?;

    // Android 12 and newer require the Intent package for broadcast delivery.
    let package_name = env
        .call_method(
            context.as_obj(),
            "getPackageName",
            "()Ljava/lang/String;",
            &[],
        )?
        .l()?;
    env.call_method(
        &intent,
        "setPackage",
        "(Ljava/lang/String;)Landroid/content/Intent;",
        &[(&package_name).into()],
    )?;
    let intent = env.auto_local(intent);

    let class_pending_intent = env.find_class("android/app/PendingIntent")?;

    // Android 12 and newer require FLAG_MUTABLE or FLAG_IMMUTABLE.
    // FLAG_MUTABLE = 0x02000000
    let flags = 0x02000000i32; // FLAG_MUTABLE

    let permission_intent = env
        .call_static_method(
            &class_pending_intent,
            "getBroadcast",
            "(Landroid/content/Context;ILandroid/content/Intent;I)Landroid/app/PendingIntent;",
            &[
                ctx.context().as_obj().into(),
                0.into(),
                (&intent).into(),
                flags.into(),
            ],
        )?
        .l()?;
    let permission_intent = env.auto_local(permission_intent);

    env.call_method(
        &usb_manager,
        "requestPermission",
        "(Landroid/hardware/usb/UsbDevice;Landroid/app/PendingIntent;)V",
        &[(&device).into(), (&permission_intent).into()],
    )?;

    log::info!("USB permission requested for device: {}", device_path);
    Ok(())
}

/// Opens a USB device and returns its file descriptor.
///
/// This is the primary Android entry point for opening a UVC camera.
/// Returns an owned duplicate of the USB fd. The caller must close it.
/// The temporary Java UsbDeviceConnection is closed before returning.
pub fn usb_device_open(device_path: &str) -> Result<OwnedFd> {
    let ctx = get_android_context()?;

    let context = ctx.context();
    let vm = ctx.vm();
    let mut env = vm.attach_current_thread()?;

    let class_ctx = env.find_class("android/content/Context")?;
    let usb_service = &env.get_static_field(class_ctx, "USB_SERVICE", "Ljava/lang/String;")?;

    let usb_manager = env
        .call_method(
            context.as_obj(),
            "getSystemService",
            "(Ljava/lang/String;)Ljava/lang/Object;",
            &[usb_service.into()],
        )?
        .l()?;
    let usb_manager = env.auto_local(usb_manager);

    let device_hashmap = env
        .call_method(&usb_manager, "getDeviceList", "()Ljava/util/HashMap;", &[])?
        .l()?;
    let device_hashmap = env.auto_local(device_hashmap);

    let device_name: JObject = env.new_string(device_path)?.into();
    let device_name = env.auto_local(device_name);

    let device = env
        .call_method(
            &device_hashmap,
            "get",
            "(Ljava/lang/Object;)Ljava/lang/Object;",
            &[(&device_name).into()],
        )?
        .l()?;
    let device = env.auto_local(device);

    if device.is_null() {
        return Err(
            camera::CameraError::device_not_found(device_path.to_string())
                .with_backend(camera::BackendId::UVC)
                .with_stage(camera::OperationStage::Open)
                .into(),
        );
    }

    // Check USB permission.
    let has_permission = env
        .call_method(
            &usb_manager,
            "hasPermission",
            "(Landroid/hardware/usb/UsbDevice;)Z",
            &[(&device).into()],
        )?
        .z()?;

    if !has_permission {
        log::warn!("No permission for USB device: {}", device_path);
        // Request permission.
        usb_device_request_permission_internal(&mut env, &usb_manager, &device, ctx)?;
        return Err(
            camera::CameraError::permission_denied(device_path.to_string())
                .with_backend(camera::BackendId::UVC)
                .with_stage(camera::OperationStage::Open)
                .into(),
        );
    }

    // Open the device.
    let usb_connection = env
        .call_method(
            &usb_manager,
            "openDevice",
            "(Landroid/hardware/usb/UsbDevice;)Landroid/hardware/usb/UsbDeviceConnection;",
            &[(&device).into()],
        )?
        .l()?;
    let usb_connection = env.auto_local(usb_connection);

    if usb_connection.is_null() {
        return Err(
            camera::CameraError::device_open_failed("Failed to open USB device".into())
                .with_backend(camera::BackendId::UVC)
                .with_stage(camera::OperationStage::Open)
                .into(),
        );
    }

    // Duplicate while Java still owns the original descriptor. Always close
    // the temporary connection, including descriptor/duplication failures.
    let owned = env
        .call_method(&usb_connection, "getFileDescriptor", "()I", &[])
        .and_then(|v| v.i())
        .map_err(CameraError::from)
        .and_then(crate::owned_fd::duplicate);
    let closed = env.call_method(&usb_connection, "close", "()V", &[]);
    let owned = owned?;
    closed?;
    Ok(owned)
}

/// Internal permission request helper.
fn usb_device_request_permission_internal<'a>(
    env: &mut AttachGuard<'a>,
    usb_manager: &JObject<'a>,
    device: &JObject<'a>,
    ctx: &AndroidContext,
) -> Result<()> {
    let permission = "com.medivh.camera.USB_PERMISSION";
    let permission_str: JObject = env.new_string(permission)?.into();
    let permission_str = env.auto_local(permission_str);

    let class_intent = env.find_class("android/content/Intent")?;
    let intent = env.new_object(
        &class_intent,
        "(Ljava/lang/String;)V",
        &[(&permission_str).into()],
    )?;

    // Android 12 and newer require the Intent package for broadcast delivery.
    let package_name = env
        .call_method(
            ctx.context().as_obj(),
            "getPackageName",
            "()Ljava/lang/String;",
            &[],
        )?
        .l()?;
    env.call_method(
        &intent,
        "setPackage",
        "(Ljava/lang/String;)Landroid/content/Intent;",
        &[(&package_name).into()],
    )?;
    let intent = env.auto_local(intent);

    let class_pending_intent = env.find_class("android/app/PendingIntent")?;
    let flags = 0x02000000i32;

    let permission_intent = env
        .call_static_method(
            &class_pending_intent,
            "getBroadcast",
            "(Landroid/content/Context;ILandroid/content/Intent;I)Landroid/app/PendingIntent;",
            &[
                ctx.context().as_obj().into(),
                0.into(),
                (&intent).into(),
                flags.into(),
            ],
        )?
        .l()?;
    let permission_intent = env.auto_local(permission_intent);

    env.call_method(
        usb_manager,
        "requestPermission",
        "(Landroid/hardware/usb/UsbDevice;Landroid/app/PendingIntent;)V",
        &[device.into(), (&permission_intent).into()],
    )?;

    Ok(())
}

/// Opens a device by VID and PID.
pub fn usb_device_open_by_vid_pid(vid: u16, pid: u16) -> Result<OwnedFd> {
    let devices = usb_manager_scan()?;

    for device in devices {
        if device.vendor_id == Some(vid) && device.product_id == Some(pid) {
            if let Some(path) = &device.device_path {
                return usb_device_open(path);
            }
        }
    }

    Err(
        camera::CameraError::device_not_found(format!("VID:{vid:04x} PID:{pid:04x}"))
            .with_backend(camera::BackendId::UVC)
            .with_stage(camera::OperationStage::Open)
            .into(),
    )
}

/// Opens a device by index.
pub fn usb_device_open_by_index(index: u32) -> Result<OwnedFd> {
    let devices = usb_manager_scan()?;

    if let Some(device) = devices.get(index as usize) {
        if let Some(path) = &device.device_path {
            return usb_device_open(path);
        }
    }

    Err(
        camera::CameraError::device_not_found(format!("Device index {index}"))
            .with_backend(camera::BackendId::UVC)
            .with_stage(camera::OperationStage::Open)
            .into(),
    )
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn get_android_context_returns_error_before_init() {
        let result = get_android_context();

        assert!(matches!(
            result,
            Err(error) if error.kind() == camera::CameraErrorKind::InvalidState
                && error.to_string().contains("not initialized")
        ));
    }
}