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
use std::convert::TryFrom;
use std::path::Path;
use std::sync::Arc;
use std::{io, mem};
use libc;
use crate::capability::Capabilities;
use crate::control::{self, Control, Description};
use crate::v4l2;
use crate::v4l2::videodev::v4l2_ext_controls;
use crate::v4l_sys::*;
/// Linux capture device abstraction
pub struct Device {
/// Raw handle
handle: Arc<Handle>,
}
impl Device {
/// Returns a capture device by index
///
/// Devices are usually enumerated by the system.
/// An index of zero thus represents the first device the system got to know about.
///
/// # Arguments
///
/// * `index` - Index (0: first, 1: second, ..)
///
/// # Example
///
/// ```
/// use v4l::device::Device;
/// let dev = Device::new(0);
/// ```
pub fn new(index: usize) -> io::Result<Self> {
let path = format!("{}{}", "/dev/video", index);
let fd = v4l2::open(path, libc::O_RDWR | libc::O_NONBLOCK)?;
if fd == -1 {
return Err(io::Error::last_os_error());
}
Ok(Device {
handle: Arc::new(Handle::new(fd)),
})
}
/// Returns a capture device by path
///
/// Linux device nodes are usually found in /dev/videoX or /sys/class/video4linux/videoX.
///
/// # Arguments
///
/// * `path` - Path (e.g. "/dev/video0")
///
/// # Example
///
/// ```
/// use v4l::device::Device;
/// let dev = Device::with_path("/dev/video0");
/// ```
pub fn with_path<P: AsRef<Path>>(path: P) -> io::Result<Self> {
let fd = v4l2::open(&path, libc::O_RDWR | libc::O_NONBLOCK)?;
if fd == -1 {
return Err(io::Error::last_os_error());
}
Ok(Device {
handle: Arc::new(Handle::new(fd)),
})
}
/// Returns the raw device handle
pub fn handle(&self) -> Arc<Handle> {
self.handle.clone()
}
/// Returns video4linux framework defined information such as card, driver, etc.
pub fn query_caps(&self) -> io::Result<Capabilities> {
unsafe {
let mut v4l2_caps: v4l2_capability = mem::zeroed();
v4l2::ioctl(
self.handle().fd(),
v4l2::vidioc::VIDIOC_QUERYCAP,
&mut v4l2_caps as *mut _ as *mut std::os::raw::c_void,
)?;
Ok(Capabilities::from(v4l2_caps))
}
}
/// Returns the supported controls for a device such as gain, focus, white balance, etc.
pub fn query_controls(&self) -> io::Result<Vec<Description>> {
let mut controls = Vec::new();
unsafe {
let mut v4l2_ctrl: v4l2_query_ext_ctrl = mem::zeroed();
loop {
v4l2_ctrl.id |= V4L2_CTRL_FLAG_NEXT_CTRL;
v4l2_ctrl.id |= V4L2_CTRL_FLAG_NEXT_COMPOUND;
match v4l2::ioctl(
self.handle().fd(),
v4l2::vidioc::VIDIOC_QUERY_EXT_CTRL,
&mut v4l2_ctrl as *mut _ as *mut std::os::raw::c_void,
) {
Ok(_) => {
// get the basic control information
let mut control = Description::from(v4l2_ctrl);
// if this is a menu control, enumerate its items
if control.typ == control::Type::Menu
|| control.typ == control::Type::IntegerMenu
{
let mut items = Vec::new();
for i in (v4l2_ctrl.minimum..=v4l2_ctrl.maximum)
.step_by(v4l2_ctrl.step as usize)
{
let mut v4l2_menu = v4l2_querymenu {
id: v4l2_ctrl.id,
index: i as u32,
..mem::zeroed()
};
let res = v4l2::ioctl(
self.handle().fd(),
v4l2::vidioc::VIDIOC_QUERYMENU,
&mut v4l2_menu as *mut _ as *mut std::os::raw::c_void,
);
// BEWARE OF DRAGONS!
// The API docs [1] state VIDIOC_QUERYMENU should may return EINVAL
// for some indices between minimum and maximum when an item is not
// supported by a driver.
//
// I have no idea why it is advertised in the first place then, but
// have seen this happen with a Logitech C920 HD Pro webcam.
// In case of errors, let's just skip the offending index.
//
// [1] https://github.com/torvalds/linux/blob/master/Documentation/userspace-api/media/v4l/vidioc-queryctrl.rst#description
if res.is_err() {
continue;
}
let item =
control::MenuItem::try_from((control.typ, v4l2_menu)).unwrap();
items.push((v4l2_menu.index, item));
}
control.items = Some(items);
}
controls.push(control);
}
Err(e) => {
if controls.is_empty() || e.kind() != io::ErrorKind::InvalidInput {
return Err(e);
} else {
break;
}
}
}
}
}
Ok(controls)
}
/// Returns the current control value from its [`Description`]
///
/// # Arguments
///
/// * `desc` - Control description
pub fn control(&self, desc: &Description) -> io::Result<Control> {
unsafe {
// query the actual control value
let mut v4l2_ctrl = v4l2_ext_control {
id: desc.id,
..mem::zeroed()
};
let mut v4l2_ctrls = v4l2_ext_controls {
count: 1,
controls: &mut v4l2_ctrl,
..mem::zeroed()
};
v4l2::ioctl(
self.handle().fd(),
v4l2::vidioc::VIDIOC_G_EXT_CTRLS,
&mut v4l2_ctrls as *mut _ as *mut std::os::raw::c_void,
)?;
let value = match desc.typ {
control::Type::Integer64 => {
control::Value::Integer(v4l2_ctrl.__bindgen_anon_1.value64)
}
control::Type::Integer | control::Type::Menu => {
control::Value::Integer(v4l2_ctrl.__bindgen_anon_1.value as i64)
}
control::Type::Boolean => {
control::Value::Boolean(v4l2_ctrl.__bindgen_anon_1.value == 1)
}
_ => {
return Err(io::Error::new(
io::ErrorKind::Other,
"cannot handle control type",
))
}
};
Ok(Control { id: desc.id, value })
}
}
/// Modifies the control value
///
/// # Arguments
///
/// * `ctrl` - Control to be set
pub fn set_control(&self, ctrl: Control) -> io::Result<()> {
self.set_controls(vec![ctrl])
}
/// Modifies the control values atomically
///
/// # Arguments
///
/// * `ctrls` - Vec of the controls to be set
pub fn set_controls(&self, ctrls: Vec<Control>) -> io::Result<()> {
unsafe {
let mut control_list: Vec<v4l2_ext_control> = vec![];
let mut class: Option<u32> = None;
if ctrls.is_empty() {
return Err(io::Error::new(
io::ErrorKind::InvalidInput,
"ctrls cannot be empty",
));
}
for ref ctrl in ctrls {
let mut control = v4l2_ext_control {
id: ctrl.id,
..mem::zeroed()
};
class = match class {
Some(c) => {
if c != (control.id & 0xFFFF0000) {
return Err(io::Error::new(
io::ErrorKind::InvalidInput,
"All controls must be in the same class",
));
} else {
Some(c)
}
}
None => Some(control.id & 0xFFFF0000),
};
match ctrl.value {
control::Value::None => {}
control::Value::Integer(val) => {
control.__bindgen_anon_1.value64 = val;
control.size = 0;
}
control::Value::Boolean(val) => {
control.__bindgen_anon_1.value64 = val as i64;
control.size = 0;
}
control::Value::String(ref val) => {
control.__bindgen_anon_1.string = val.as_ptr() as *mut std::os::raw::c_char;
control.size = val.len() as u32;
}
control::Value::CompoundU8(ref val) => {
control.__bindgen_anon_1.p_u8 = val.as_ptr() as *mut u8;
control.size = (val.len() * std::mem::size_of::<u8>()) as u32;
}
control::Value::CompoundU16(ref val) => {
control.__bindgen_anon_1.p_u16 = val.as_ptr() as *mut u16;
control.size = (val.len() * std::mem::size_of::<u16>()) as u32;
}
control::Value::CompoundU32(ref val) => {
control.__bindgen_anon_1.p_u32 = val.as_ptr() as *mut u32;
control.size = (val.len() * std::mem::size_of::<u32>()) as u32;
}
control::Value::CompoundPtr(ref val) => {
control.__bindgen_anon_1.ptr = val.as_ptr() as *mut std::os::raw::c_void;
control.size = (val.len() * std::mem::size_of::<u8>()) as u32;
}
};
control_list.push(control);
}
let class = class.ok_or_else(|| {
io::Error::new(
io::ErrorKind::InvalidInput,
"failed to determine control class",
)
})?;
let mut controls = v4l2_ext_controls {
count: control_list.len() as u32,
controls: control_list.as_mut_ptr(),
which: class,
..mem::zeroed()
};
v4l2::ioctl(
self.handle().fd(),
v4l2::vidioc::VIDIOC_S_EXT_CTRLS,
&mut controls as *mut _ as *mut std::os::raw::c_void,
)
}
}
}
impl io::Read for Device {
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
unsafe {
let ret = libc::read(
self.handle().fd(),
buf.as_mut_ptr() as *mut std::os::raw::c_void,
buf.len(),
);
match ret {
-1 => Err(io::Error::last_os_error()),
ret => Ok(ret as usize),
}
}
}
}
impl io::Write for Device {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
unsafe {
let ret = libc::write(
self.handle().fd(),
buf.as_ptr() as *const std::os::raw::c_void,
buf.len(),
);
match ret {
-1 => Err(io::Error::last_os_error()),
ret => Ok(ret as usize),
}
}
}
fn flush(&mut self) -> io::Result<()> {
// write doesn't use a buffer, so it effectively flushes with each call
// therefore, we don't have anything to flush later
Ok(())
}
}
/// Device handle for low-level access.
///
/// Acquiring a handle facilitates (possibly mutating) interactions with the device.
pub struct Handle {
fd: std::os::raw::c_int,
}
impl Handle {
fn new(fd: std::os::raw::c_int) -> Self {
Self { fd }
}
/// Returns the raw file descriptor
pub fn fd(&self) -> std::os::raw::c_int {
self.fd
}
/// Polls the file descriptor for I/O events
///
/// # Arguments
///
/// * `events` - The events you are interested in (e.g. POLLIN)
///
/// * `timeout` - Timeout in milliseconds
/// A value of zero returns immedately, even if the fd is not ready.
/// A negative value means infinite timeout (blocking).
pub fn poll(&self, events: i16, timeout: i32) -> io::Result<i32> {
match unsafe {
libc::poll(
[libc::pollfd {
fd: self.fd,
events,
revents: 0,
}]
.as_mut_ptr(),
1,
timeout,
)
} {
-1 => Err(io::Error::last_os_error()),
ret => {
// A return value of zero means that we timed out. A positive value signifies the
// number of fds with non-zero revents fields (aka I/O activity).
assert!(ret == 0 || ret == 1);
Ok(ret)
}
}
}
}
impl Drop for Handle {
fn drop(&mut self) {
v4l2::close(self.fd).unwrap();
}
}