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
use std::ffi::CString;
use std::os::unix::ffi::OsStrExt;
use std::{io, path::Path};
use crate::v4l2::vidioc;
#[cfg(feature = "v4l-sys")]
mod detail {
use crate::v4l2::vidioc;
use crate::v4l_sys::*;
use std::convert::TryInto;
pub unsafe fn open(path: *const std::os::raw::c_char, flags: i32) -> std::os::raw::c_int {
v4l2_open(path, flags)
}
pub unsafe fn close(fd: std::os::raw::c_int) -> std::os::raw::c_int {
v4l2_close(fd)
}
pub unsafe fn ioctl(
fd: std::os::raw::c_int,
request: vidioc::_IOC_TYPE,
argp: *mut std::os::raw::c_void,
) -> std::os::raw::c_int {
// libv4l expects `request` to be a u64, but this is not guaranteed on all platforms.
// For the default CI platform (x86_64) clippy will complain about a useless conversion.
#![allow(clippy::useless_conversion)]
v4l2_ioctl(
fd,
request.try_into().expect("vidioc::_IOC_TYPE -> u64 failed"),
argp,
)
}
pub unsafe fn mmap(
start: *mut std::os::raw::c_void,
length: usize,
prot: std::os::raw::c_int,
flags: std::os::raw::c_int,
fd: std::os::raw::c_int,
offset: libc::off_t,
) -> *mut std::os::raw::c_void {
// libv4l expects `request` to be a u64, but this is not guaranteed on all platforms.
// For the default CI platform (x86_64) clippy will complain about a useless conversion.
#![allow(clippy::useless_conversion)]
v4l2_mmap(
start,
length.try_into().expect("usize -> c size_t failed"),
prot,
flags,
fd,
offset as i64,
)
}
pub unsafe fn munmap(start: *mut std::os::raw::c_void, length: usize) -> std::os::raw::c_int {
v4l2_munmap(start, length.try_into().expect("usize -> c size_t failed"))
}
}
#[cfg(feature = "v4l2-sys")]
mod detail {
use crate::v4l2::vidioc;
pub unsafe fn open(path: *const std::os::raw::c_char, flags: i32) -> std::os::raw::c_int {
libc::open(path, flags)
}
pub unsafe fn close(fd: std::os::raw::c_int) -> std::os::raw::c_int {
libc::close(fd)
}
pub unsafe fn ioctl(
fd: std::os::raw::c_int,
request: vidioc::_IOC_TYPE,
argp: *mut std::os::raw::c_void,
) -> std::os::raw::c_int {
/*
* It turns out the libc crate (and libc itself!) defines ioctl() with
* different, incompatible argument types on different platforms. To
* hack around this without conditional compilation, use syscall()
* instead as a drop-in replacement. Details:
* https://github.com/rust-lang/libc/issues/1036
*/
libc::syscall(libc::SYS_ioctl, fd, request, argp) as std::os::raw::c_int
}
pub unsafe fn mmap(
start: *mut std::os::raw::c_void,
length: usize,
prot: std::os::raw::c_int,
flags: std::os::raw::c_int,
fd: std::os::raw::c_int,
offset: libc::off_t,
) -> *mut std::os::raw::c_void {
libc::mmap(start, length, prot, flags, fd, offset)
}
pub unsafe fn munmap(start: *mut std::os::raw::c_void, length: usize) -> std::os::raw::c_int {
libc::munmap(start, length)
}
}
/// A convenience wrapper around v4l2_open.
///
/// Returns the file descriptor on success.
/// In case of errors, the last OS error will be reported, aka errno on Linux.
///
/// # Arguments
///
/// * `path` - Path to the device node
/// * `flags` - Open flags
///
/// # Example
///
/// ```
/// extern crate v4l;
///
/// use v4l::v4l2;
///
/// let fd = v4l2::open("/dev/video0", libc::O_RDWR);
/// ```
pub fn open<P: AsRef<Path>>(path: P, flags: i32) -> io::Result<std::os::raw::c_int> {
let fd: std::os::raw::c_int;
let c_path = CString::new(path.as_ref().as_os_str().as_bytes()).unwrap();
unsafe {
fd = detail::open(c_path.as_ptr(), flags);
}
if fd == -1 {
Err(io::Error::last_os_error())
} else {
Ok(fd)
}
}
/// A convenience wrapper around v4l2_close.
///
/// In case of errors, the last OS error will be reported, aka errno on Linux.
///
/// # Arguments
///
/// * `fd` - File descriptor of a previously opened device
///
/// # Example
///
/// ```
/// extern crate v4l;
///
/// use v4l::v4l2;
///
/// let fd = v4l2::open("/dev/video0", libc::O_RDWR);
/// if let Ok(fd) = fd {
/// v4l2::close(fd).unwrap();
/// }
/// ```
pub fn close(fd: std::os::raw::c_int) -> io::Result<()> {
let ret: std::os::raw::c_int;
unsafe {
ret = detail::close(fd);
}
if ret == -1 {
Err(io::Error::last_os_error())
} else {
Ok(())
}
}
/// A convenience wrapper around v4l2_ioctl.
///
/// In case of errors, the last OS error will be reported, aka errno on Linux.
///
/// # Arguments
///
/// * `fd` - File descriptor
/// * `request` - IO control code (see [`vidioc`])
/// * `argp` - Pointer to memory region holding the argument type
///
/// # Safety
///
/// For maximum flexibility, argp must be a raw pointer. Thus, the entire function is unsafe.
///
/// # Example
///
/// ```
/// extern crate v4l;
///
/// use std::mem;
///
/// use v4l::v4l_sys::*;
/// use v4l::v4l2;
///
/// let fd = v4l2::open("/dev/video0", libc::O_RDWR);
/// let mut v4l2_caps: v4l2_capability;
/// unsafe {
/// v4l2_caps = mem::zeroed();
/// }
///
/// if let Ok(fd) = fd {
/// unsafe {
/// v4l2::ioctl(fd, v4l2::vidioc::VIDIOC_QUERYCAP,
/// &mut v4l2_caps as *mut _ as *mut std::os::raw::c_void);
/// }
/// }
/// ```
pub unsafe fn ioctl(
fd: std::os::raw::c_int,
request: vidioc::_IOC_TYPE,
argp: *mut std::os::raw::c_void,
) -> io::Result<()> {
let ret = detail::ioctl(fd, request, argp);
if ret == -1 {
Err(io::Error::last_os_error())
} else {
Ok(())
}
}
/// A convenience wrapper around v4l2_mmap.
///
/// In case of errors, the last OS error will be reported, aka errno on Linux.
///
/// # Arguments
///
/// * `start` - Starting address of the new mapping, usually NULL
/// * `length` - Length of the mapped region
/// * `prot` - Desired memory protection of the mapped region
/// * `flags` - Mapping flags
/// * `fd` - File descriptor representing an opened device
/// * `offset` - Offset in the source region, usually 0
///
/// # Safety
///
/// Start must be a raw pointer. Thus, the entire function is unsafe.
///
/// # Example
///
/// ```
/// extern crate v4l;
///
/// use std::ptr;
/// use v4l::v4l2;
///
/// let fd = v4l2::open("/dev/video0", libc::O_RDWR);
/// if let Ok(fd) = fd {
/// /* VIDIOC_REQBUFS */
/// /* VIDIOC_QUERYBUF */
/// let mapping_length: usize = 1000;
///
/// unsafe {
/// let mapping = v4l2::mmap(ptr::null_mut(), mapping_length,
/// libc::PROT_READ | libc::PROT_WRITE,
/// libc::MAP_SHARED, fd, 0);
/// }
/// v4l2::close(fd).unwrap();
/// }
/// ```
pub unsafe fn mmap(
start: *mut std::os::raw::c_void,
length: usize,
prot: std::os::raw::c_int,
flags: std::os::raw::c_int,
fd: std::os::raw::c_int,
offset: libc::off_t,
) -> io::Result<*mut std::os::raw::c_void> {
let ret = detail::mmap(start, length, prot, flags, fd, offset);
if ret as usize == std::usize::MAX {
Err(io::Error::last_os_error())
} else {
Ok(ret)
}
}
/// A convenience wrapper around v4l2_munmap.
///
/// In case of errors, the last OS error will be reported, aka errno on Linux.
///
/// # Arguments
///
/// * `start` - Starting address of the mapping
/// * `length` - Length of the mapped region
///
/// # Safety
///
/// Start must be a raw pointer. Thus, the entire function is unsafe.
///
/// # Example
///
/// ```
/// extern crate v4l;
///
/// use std::ptr;
/// use v4l::v4l2;
///
/// let fd = v4l2::open("/dev/video0", libc::O_RDWR);
/// if let Ok(fd) = fd {
/// /* VIDIOC_REQBUFS */
/// /* VIDIOC_QUERYBUF */
/// let mapping_length: usize = 1000;
///
/// unsafe {
/// let mapping = v4l2::mmap(ptr::null_mut(), mapping_length,
/// libc::PROT_READ | libc::PROT_WRITE,
/// libc::MAP_SHARED, fd, 0);
/// if let Ok(mapping) = mapping {
/// v4l2::munmap(mapping, mapping_length).unwrap();
/// }
/// }
/// v4l2::close(fd).unwrap();
/// }
/// ```
pub unsafe fn munmap(start: *mut std::os::raw::c_void, length: usize) -> io::Result<()> {
let ret = detail::munmap(start, length);
if ret == -1 {
Err(io::Error::last_os_error())
} else {
Ok(())
}
}