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
use std::convert::TryInto;
use std::time::Duration;
use std::{io, mem, sync::Arc};
use crate::buffer::{Metadata, Type};
use crate::device::{Device, Handle};
use crate::io::mmap::arena::Arena;
use crate::io::traits::{CaptureStream, OutputStream, Stream as StreamTrait};
use crate::memory::Memory;
use crate::v4l2;
use crate::v4l_sys::*;
/// Stream of mapped buffers
///
/// An arena instance is used internally for buffer handling.
pub struct Stream<'a> {
handle: Arc<Handle>,
arena: Arena<'a>,
arena_index: usize,
buf_type: Type,
buf_meta: Vec<Metadata>,
timeout: Option<i32>,
active: bool,
}
impl<'a> Stream<'a> {
/// Returns a stream for frame capturing
///
/// # Arguments
///
/// * `dev` - Capture device ref to get its file descriptor
/// * `buf_type` - Type of the buffers
///
/// # Example
///
/// ```
/// use v4l::buffer::Type;
/// use v4l::device::Device;
/// use v4l::io::mmap::Stream;
///
/// let dev = Device::new(0);
/// if let Ok(dev) = dev {
/// let stream = Stream::new(&dev, Type::VideoCapture);
/// }
/// ```
pub fn new(dev: &Device, buf_type: Type) -> io::Result<Self> {
Stream::with_buffers(dev, buf_type, 4)
}
pub fn with_buffers(dev: &Device, buf_type: Type, buf_count: u32) -> io::Result<Self> {
let mut arena = Arena::new(dev.handle(), buf_type);
let count = arena.allocate(buf_count)?;
let mut buf_meta = Vec::new();
buf_meta.resize(count as usize, Metadata::default());
Ok(Stream {
handle: dev.handle(),
arena,
arena_index: 0,
buf_type,
buf_meta,
active: false,
timeout: None,
})
}
/// Returns the raw device handle
pub fn handle(&self) -> Arc<Handle> {
self.handle.clone()
}
/// Sets a timeout of the v4l file handle.
pub fn set_timeout(&mut self, duration: Duration) {
self.timeout = Some(duration.as_millis().try_into().unwrap());
}
/// Clears the timeout of the v4l file handle.
pub fn clear_timeout(&mut self) {
self.timeout = None;
}
fn buffer_desc(&self) -> v4l2_buffer {
v4l2_buffer {
type_: self.buf_type as u32,
memory: Memory::Mmap as u32,
..unsafe { mem::zeroed() }
}
}
}
impl<'a> Drop for Stream<'a> {
fn drop(&mut self) {
if let Err(e) = self.stop() {
if let Some(code) = e.raw_os_error() {
// ENODEV means the file descriptor wrapped in the handle became invalid, most
// likely because the device was unplugged or the connection (USB, PCI, ..)
// broke down. Handle this case gracefully by ignoring it.
if code == 19 {
/* ignore */
return;
}
}
panic!("{:?}", e)
}
}
}
impl<'a> StreamTrait for Stream<'a> {
type Item = [u8];
fn start(&mut self) -> io::Result<()> {
unsafe {
let mut typ = self.buf_type as u32;
v4l2::ioctl(
self.handle.fd(),
v4l2::vidioc::VIDIOC_STREAMON,
&mut typ as *mut _ as *mut std::os::raw::c_void,
)?;
}
self.active = true;
Ok(())
}
fn stop(&mut self) -> io::Result<()> {
unsafe {
let mut typ = self.buf_type as u32;
v4l2::ioctl(
self.handle.fd(),
v4l2::vidioc::VIDIOC_STREAMOFF,
&mut typ as *mut _ as *mut std::os::raw::c_void,
)?;
}
self.active = false;
Ok(())
}
}
impl<'a, 'b> CaptureStream<'b> for Stream<'a> {
fn queue(&mut self, index: usize) -> io::Result<()> {
let mut v4l2_buf = v4l2_buffer {
index: index as u32,
..self.buffer_desc()
};
unsafe {
v4l2::ioctl(
self.handle.fd(),
v4l2::vidioc::VIDIOC_QBUF,
&mut v4l2_buf as *mut _ as *mut std::os::raw::c_void,
)?;
}
Ok(())
}
fn dequeue(&mut self) -> io::Result<usize> {
let mut v4l2_buf = self.buffer_desc();
if self.handle.poll(libc::POLLIN, self.timeout.unwrap_or(-1))? == 0 {
// This condition can only happen if there was a timeout.
// A timeout is only possible if the `timeout` value is non-zero, meaning we should
// propagate it to the caller.
return Err(io::Error::new(io::ErrorKind::TimedOut, "VIDIOC_DQBUF"));
}
unsafe {
v4l2::ioctl(
self.handle.fd(),
v4l2::vidioc::VIDIOC_DQBUF,
&mut v4l2_buf as *mut _ as *mut std::os::raw::c_void,
)?;
}
self.arena_index = v4l2_buf.index as usize;
self.buf_meta[self.arena_index] = Metadata {
bytesused: v4l2_buf.bytesused,
flags: v4l2_buf.flags.into(),
field: v4l2_buf.field,
timestamp: v4l2_buf.timestamp.into(),
sequence: v4l2_buf.sequence,
};
Ok(self.arena_index)
}
fn next(&'b mut self) -> io::Result<(&Self::Item, &Metadata, bool)> {
if !self.active {
// Enqueue all buffers once on stream start
for index in 0..self.arena.bufs.len() {
CaptureStream::queue(self, index)?;
}
self.start()?;
} else {
CaptureStream::queue(self, self.arena_index)?;
}
self.arena_index = CaptureStream::dequeue(self)?;
// The index used to access the buffer elements is given to us by v4l2, so we assume it
// will always be valid.
let bytes = &self.arena.bufs[self.arena_index];
let meta = &self.buf_meta[self.arena_index];
Ok((bytes, meta, false))
}
}
impl<'a, 'b> OutputStream<'b> for Stream<'a> {
fn queue(&mut self, index: usize) -> io::Result<()> {
let mut v4l2_buf = v4l2_buffer {
index: index as u32,
..self.buffer_desc()
};
unsafe {
// output settings
//
// MetaData.bytesused is initialized to 0. For an output device, when bytesused is
// set to 0 v4l2 will set it to the size of the plane:
// https://www.kernel.org/doc/html/v4.15/media/uapi/v4l/buffer.html#struct-v4l2-plane
v4l2_buf.bytesused = self.buf_meta[index].bytesused;
v4l2_buf.field = self.buf_meta[index].field;
if self
.handle
.poll(libc::POLLOUT, self.timeout.unwrap_or(-1))?
== 0
{
// This condition can only happen if there was a timeout.
// A timeout is only possible if the `timeout` value is non-zero, meaning we should
// propagate it to the caller.
return Err(io::Error::new(io::ErrorKind::TimedOut, "VIDIOC_QBUF"));
}
v4l2::ioctl(
self.handle.fd(),
v4l2::vidioc::VIDIOC_QBUF,
&mut v4l2_buf as *mut _ as *mut std::os::raw::c_void,
)
}
}
fn dequeue(&mut self) -> io::Result<usize> {
let mut v4l2_buf = self.buffer_desc();
unsafe {
v4l2::ioctl(
self.handle.fd(),
v4l2::vidioc::VIDIOC_DQBUF,
&mut v4l2_buf as *mut _ as *mut std::os::raw::c_void,
)?;
}
self.arena_index = v4l2_buf.index as usize;
self.buf_meta[self.arena_index] = Metadata {
bytesused: v4l2_buf.bytesused,
flags: v4l2_buf.flags.into(),
field: v4l2_buf.field,
timestamp: v4l2_buf.timestamp.into(),
sequence: v4l2_buf.sequence,
};
Ok(self.arena_index)
}
fn next(&'b mut self) -> io::Result<(&mut Self::Item, &mut Metadata)> {
let init = !self.active;
if !self.active {
self.start()?;
}
// Only queue and dequeue once the buffer has been filled at the call site. The initial
// call to this function from the call site will happen just after the buffers have been
// allocated, meaning we need to return the empty buffer initially so it can be filled.
if !init {
OutputStream::queue(self, self.arena_index)?;
self.arena_index = OutputStream::dequeue(self)?;
}
// The index used to access the buffer elements is given to us by v4l2, so we assume it
// will always be valid.
let bytes = &mut self.arena.bufs[self.arena_index];
let meta = &mut self.buf_meta[self.arena_index];
Ok((bytes, meta))
}
}