mirror of
https://github.com/scottlamb/moonfire-nvr.git
synced 2025-02-04 02:16:00 -05:00
ae502200c0
This stops using parking_lot entirely. Since Rust 1.62, the std implementations on Linux are direct futexes, not the boxed pthread mutexes they used to be. No real reason to use parking_lot anymore, so shed this dependency.
517 lines
19 KiB
Rust
517 lines
19 KiB
Rust
// This file is part of Moonfire NVR, a security camera network video recorder.
|
|
// Copyright (C) 2020 The Moonfire NVR Authors; see AUTHORS and LICENSE.txt.
|
|
// SPDX-License-Identifier: GPL-v3.0-or-later WITH GPL-3.0-linking-exception.
|
|
|
|
use crate::stream;
|
|
use base::clock::{Clocks, TimerGuard};
|
|
use db::{dir, recording, writer, Camera, Database, Stream};
|
|
use failure::{bail, format_err, Error};
|
|
use log::{debug, info, trace, warn};
|
|
use std::result::Result;
|
|
use std::str::FromStr;
|
|
use std::sync::Arc;
|
|
use url::Url;
|
|
|
|
pub static ROTATE_INTERVAL_SEC: i64 = 60;
|
|
|
|
/// Common state that can be used by multiple `Streamer` instances.
|
|
pub struct Environment<'a, 'tmp, C>
|
|
where
|
|
C: Clocks + Clone,
|
|
{
|
|
pub opener: &'a dyn stream::Opener,
|
|
pub db: &'tmp Arc<Database<C>>,
|
|
pub shutdown_rx: &'tmp base::shutdown::Receiver,
|
|
}
|
|
|
|
/// Connects to a given RTSP stream and writes recordings to the database via [`writer::Writer`].
|
|
/// Streamer is meant to be long-lived; it will sleep and retry after each failure.
|
|
pub struct Streamer<'a, C>
|
|
where
|
|
C: Clocks + Clone,
|
|
{
|
|
shutdown_rx: base::shutdown::Receiver,
|
|
|
|
// State below is only used by the thread in Run.
|
|
rotate_offset_sec: i64,
|
|
rotate_interval_sec: i64,
|
|
db: Arc<Database<C>>,
|
|
dir: Arc<dir::SampleFileDir>,
|
|
syncer_channel: writer::SyncerChannel<::std::fs::File>,
|
|
opener: &'a dyn stream::Opener,
|
|
transport: retina::client::Transport,
|
|
stream_id: i32,
|
|
session_group: Arc<retina::client::SessionGroup>,
|
|
short_name: String,
|
|
url: Url,
|
|
username: String,
|
|
password: String,
|
|
}
|
|
|
|
impl<'a, C> Streamer<'a, C>
|
|
where
|
|
C: 'a + Clocks + Clone,
|
|
{
|
|
pub fn new<'tmp>(
|
|
env: &Environment<'a, 'tmp, C>,
|
|
dir: Arc<dir::SampleFileDir>,
|
|
syncer_channel: writer::SyncerChannel<::std::fs::File>,
|
|
stream_id: i32,
|
|
c: &Camera,
|
|
s: &Stream,
|
|
session_group: Arc<retina::client::SessionGroup>,
|
|
rotate_offset_sec: i64,
|
|
rotate_interval_sec: i64,
|
|
) -> Result<Self, Error> {
|
|
let url = s
|
|
.config
|
|
.url
|
|
.as_ref()
|
|
.ok_or_else(|| format_err!("Stream has no RTSP URL"))?;
|
|
if !url.username().is_empty() || url.password().is_some() {
|
|
bail!("RTSP URL shouldn't include credentials");
|
|
}
|
|
let stream_transport = if s.config.rtsp_transport.is_empty() {
|
|
None
|
|
} else {
|
|
match retina::client::Transport::from_str(&s.config.rtsp_transport) {
|
|
Ok(t) => Some(t),
|
|
Err(_) => {
|
|
log::warn!(
|
|
"Unable to parse configured transport {:?} for {}/{}; ignoring.",
|
|
&s.config.rtsp_transport,
|
|
&c.short_name,
|
|
s.type_
|
|
);
|
|
None
|
|
}
|
|
}
|
|
};
|
|
Ok(Streamer {
|
|
shutdown_rx: env.shutdown_rx.clone(),
|
|
rotate_offset_sec,
|
|
rotate_interval_sec,
|
|
db: env.db.clone(),
|
|
dir,
|
|
syncer_channel,
|
|
opener: env.opener,
|
|
transport: stream_transport.unwrap_or_default(),
|
|
stream_id,
|
|
session_group,
|
|
short_name: format!("{}-{}", c.short_name, s.type_.as_str()),
|
|
url: url.clone(),
|
|
username: c.config.username.clone(),
|
|
password: c.config.password.clone(),
|
|
})
|
|
}
|
|
|
|
pub fn short_name(&self) -> &str {
|
|
&self.short_name
|
|
}
|
|
|
|
/// Runs the streamer; blocks.
|
|
///
|
|
/// Note: despite the blocking interface, this expects to be called from
|
|
/// the context of a multithreaded tokio runtime with IO and time enabled.
|
|
pub fn run(&mut self) {
|
|
while self.shutdown_rx.check().is_ok() {
|
|
if let Err(e) = self.run_once() {
|
|
let sleep_time = time::Duration::seconds(1);
|
|
warn!(
|
|
"{}: sleeping for {} after error: {}",
|
|
self.short_name,
|
|
sleep_time,
|
|
base::prettify_failure(&e)
|
|
);
|
|
self.db.clocks().sleep(sleep_time);
|
|
}
|
|
}
|
|
info!("{}: shutting down", self.short_name);
|
|
}
|
|
|
|
fn run_once(&mut self) -> Result<(), Error> {
|
|
info!("{}: Opening input: {}", self.short_name, self.url.as_str());
|
|
let clocks = self.db.clocks();
|
|
|
|
let handle = tokio::runtime::Handle::current();
|
|
let mut waited = false;
|
|
loop {
|
|
let status = self.session_group.stale_sessions();
|
|
if let Some(max_expires) = status.max_expires {
|
|
log::info!(
|
|
"{}: waiting up to {:?} for TEARDOWN or expiration of {} stale sessions",
|
|
&self.short_name,
|
|
max_expires.saturating_duration_since(tokio::time::Instant::now()),
|
|
status.num_sessions
|
|
);
|
|
handle.block_on(async {
|
|
tokio::select! {
|
|
_ = self.session_group.await_stale_sessions(&status) => Ok(()),
|
|
_ = self.shutdown_rx.as_future() => Err(base::shutdown::ShutdownError),
|
|
}
|
|
})?;
|
|
waited = true;
|
|
} else {
|
|
if waited {
|
|
log::info!("{}: done waiting; no more stale sessions", &self.short_name);
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
|
|
let mut stream = {
|
|
let _t = TimerGuard::new(&clocks, || format!("opening {}", self.url.as_str()));
|
|
let options = stream::Options {
|
|
session: retina::client::SessionOptions::default()
|
|
.creds(if self.username.is_empty() {
|
|
None
|
|
} else {
|
|
Some(retina::client::Credentials {
|
|
username: self.username.clone(),
|
|
password: self.password.clone(),
|
|
})
|
|
})
|
|
.session_group(self.session_group.clone()),
|
|
setup: retina::client::SetupOptions::default().transport(self.transport.clone()),
|
|
};
|
|
self.opener
|
|
.open(self.short_name.clone(), self.url.clone(), options)?
|
|
};
|
|
let realtime_offset = self.db.clocks().realtime() - clocks.monotonic();
|
|
let mut video_sample_entry_id = {
|
|
let _t = TimerGuard::new(&clocks, || "inserting video sample entry");
|
|
self.db
|
|
.lock()
|
|
.insert_video_sample_entry(stream.video_sample_entry().clone())?
|
|
};
|
|
let mut seen_key_frame = false;
|
|
|
|
// Seconds since epoch at which to next rotate. See comment at start
|
|
// of while loop.
|
|
let mut rotate: Option<i64> = None;
|
|
let mut w = writer::Writer::new(&self.dir, &self.db, &self.syncer_channel, self.stream_id);
|
|
while self.shutdown_rx.check().is_ok() {
|
|
// `rotate` should now be set iff `w` has an open recording.
|
|
|
|
let frame = {
|
|
let _t = TimerGuard::new(&clocks, || "getting next packet");
|
|
stream.next()
|
|
};
|
|
let frame = match frame {
|
|
Ok(f) => f,
|
|
Err(e) => {
|
|
let _ = w.close(None, Some(e.to_string()));
|
|
return Err(e);
|
|
}
|
|
};
|
|
if !seen_key_frame && !frame.is_key {
|
|
continue;
|
|
} else if !seen_key_frame {
|
|
debug!("{}: have first key frame", self.short_name);
|
|
seen_key_frame = true;
|
|
}
|
|
let frame_realtime = clocks.monotonic() + realtime_offset;
|
|
let local_time = recording::Time::new(frame_realtime);
|
|
rotate = if let Some(r) = rotate {
|
|
if frame_realtime.sec > r && frame.is_key {
|
|
trace!("{}: close on normal rotation", self.short_name);
|
|
let _t = TimerGuard::new(&clocks, || "closing writer");
|
|
w.close(Some(frame.pts), None)?;
|
|
None
|
|
} else if frame.new_video_sample_entry {
|
|
if !frame.is_key {
|
|
bail!("parameter change on non-key frame");
|
|
}
|
|
trace!("{}: close on parameter change", self.short_name);
|
|
video_sample_entry_id = {
|
|
let _t = TimerGuard::new(&clocks, || "inserting video sample entry");
|
|
self.db
|
|
.lock()
|
|
.insert_video_sample_entry(stream.video_sample_entry().clone())?
|
|
};
|
|
let _t = TimerGuard::new(&clocks, || "closing writer");
|
|
w.close(Some(frame.pts), None)?;
|
|
None
|
|
} else {
|
|
Some(r)
|
|
}
|
|
} else {
|
|
None
|
|
};
|
|
let r = match rotate {
|
|
Some(r) => r,
|
|
None => {
|
|
let sec = frame_realtime.sec;
|
|
let r = sec - (sec % self.rotate_interval_sec) + self.rotate_offset_sec;
|
|
let r = r + if r <= sec {
|
|
self.rotate_interval_sec
|
|
} else {
|
|
0
|
|
};
|
|
|
|
// On the first recording, set rotate time to not the next rotate offset, but
|
|
// the one after, so that it's longer than usual rather than shorter than
|
|
// usual. This ensures there's plenty of frame times to use when calculating
|
|
// the start time.
|
|
let r = r + if w.previously_opened()? {
|
|
0
|
|
} else {
|
|
self.rotate_interval_sec
|
|
};
|
|
let _t = TimerGuard::new(&clocks, || "creating writer");
|
|
r
|
|
}
|
|
};
|
|
let _t = TimerGuard::new(&clocks, || format!("writing {} bytes", frame.data.len()));
|
|
w.write(
|
|
&mut self.shutdown_rx,
|
|
&frame.data[..],
|
|
local_time,
|
|
frame.pts,
|
|
frame.is_key,
|
|
video_sample_entry_id,
|
|
)?;
|
|
rotate = Some(r);
|
|
}
|
|
if rotate.is_some() {
|
|
let _t = TimerGuard::new(&clocks, || "closing writer");
|
|
w.close(None, Some("NVR shutdown".to_owned()))?;
|
|
}
|
|
Ok(())
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use crate::stream::{self, Stream};
|
|
use base::clock::{self, Clocks};
|
|
use db::{recording, testutil, CompositeId};
|
|
use failure::{bail, Error};
|
|
use log::trace;
|
|
use std::cmp;
|
|
use std::convert::TryFrom;
|
|
use std::sync::Arc;
|
|
use std::sync::Mutex;
|
|
use time;
|
|
|
|
struct ProxyingStream {
|
|
clocks: clock::SimulatedClocks,
|
|
inner: Box<dyn stream::Stream>,
|
|
buffered: time::Duration,
|
|
slept: time::Duration,
|
|
ts_offset: i64,
|
|
ts_offset_pkts_left: u32,
|
|
pkts_left: u32,
|
|
}
|
|
|
|
impl ProxyingStream {
|
|
fn new(
|
|
clocks: clock::SimulatedClocks,
|
|
buffered: time::Duration,
|
|
inner: Box<dyn stream::Stream>,
|
|
) -> ProxyingStream {
|
|
clocks.sleep(buffered);
|
|
ProxyingStream {
|
|
clocks,
|
|
inner,
|
|
buffered,
|
|
slept: time::Duration::seconds(0),
|
|
ts_offset: 0,
|
|
ts_offset_pkts_left: 0,
|
|
pkts_left: 0,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Stream for ProxyingStream {
|
|
fn tool(&self) -> Option<&retina::client::Tool> {
|
|
self.inner.tool()
|
|
}
|
|
|
|
fn video_sample_entry(&self) -> &db::VideoSampleEntryToInsert {
|
|
self.inner.video_sample_entry()
|
|
}
|
|
|
|
fn next(&mut self) -> Result<stream::VideoFrame, Error> {
|
|
if self.pkts_left == 0 {
|
|
bail!("end of stream");
|
|
}
|
|
self.pkts_left -= 1;
|
|
|
|
let mut frame = self.inner.next()?;
|
|
|
|
// XXX: comment wrong.
|
|
// Emulate the behavior of real cameras that send some pre-buffered frames immediately
|
|
// on connect. After that, advance clock to the end of this frame.
|
|
// Avoid accumulating conversion error by tracking the total amount to sleep and how
|
|
// much we've already slept, rather than considering each frame in isolation.
|
|
{
|
|
let goal = frame.pts + i64::from(frame.duration);
|
|
let goal = time::Duration::nanoseconds(
|
|
goal * 1_000_000_000 / recording::TIME_UNITS_PER_SEC,
|
|
);
|
|
let duration = goal - self.slept;
|
|
let buf_part = cmp::min(self.buffered, duration);
|
|
self.buffered = self.buffered - buf_part;
|
|
self.clocks.sleep(duration - buf_part);
|
|
self.slept = goal;
|
|
}
|
|
|
|
if self.ts_offset_pkts_left > 0 {
|
|
self.ts_offset_pkts_left -= 1;
|
|
frame.pts += self.ts_offset;
|
|
|
|
// In a real rtsp stream, the duration of a packet is not known until the
|
|
// next packet. ffmpeg's duration is an unreliable estimate. Set it to something
|
|
// ridiculous.
|
|
frame.duration = i32::try_from(3600 * recording::TIME_UNITS_PER_SEC).unwrap();
|
|
}
|
|
|
|
Ok(frame)
|
|
}
|
|
}
|
|
|
|
struct MockOpener {
|
|
expected_url: url::Url,
|
|
streams: Mutex<Vec<Box<dyn stream::Stream>>>,
|
|
shutdown_tx: Mutex<Option<base::shutdown::Sender>>,
|
|
}
|
|
|
|
impl stream::Opener for MockOpener {
|
|
fn open(
|
|
&self,
|
|
_label: String,
|
|
url: url::Url,
|
|
_options: stream::Options,
|
|
) -> Result<Box<dyn stream::Stream>, Error> {
|
|
assert_eq!(&url, &self.expected_url);
|
|
let mut l = self.streams.lock().unwrap();
|
|
match l.pop() {
|
|
Some(stream) => {
|
|
trace!("MockOpener returning next stream");
|
|
Ok(stream)
|
|
}
|
|
None => {
|
|
trace!("MockOpener shutting down");
|
|
self.shutdown_tx.lock().unwrap().take();
|
|
bail!("done")
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Debug, Eq, PartialEq)]
|
|
struct Frame {
|
|
start_90k: i32,
|
|
duration_90k: i32,
|
|
is_key: bool,
|
|
}
|
|
|
|
fn get_frames(db: &db::LockedDatabase, id: CompositeId) -> Vec<Frame> {
|
|
db.with_recording_playback(id, &mut |rec| {
|
|
let mut it = recording::SampleIndexIterator::default();
|
|
let mut frames = Vec::new();
|
|
while it.next(&rec.video_index).unwrap() {
|
|
frames.push(Frame {
|
|
start_90k: it.start_90k,
|
|
duration_90k: it.duration_90k,
|
|
is_key: it.is_key(),
|
|
});
|
|
}
|
|
Ok(frames)
|
|
})
|
|
.unwrap()
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn basic() {
|
|
testutil::init();
|
|
// 2015-04-25 00:00:00 UTC
|
|
let clocks = clock::SimulatedClocks::new(time::Timespec::new(1429920000, 0));
|
|
clocks.sleep(time::Duration::seconds(86400)); // to 2015-04-26 00:00:00 UTC
|
|
|
|
let stream = stream::testutil::Mp4Stream::open("src/testdata/clip.mp4").unwrap();
|
|
let mut stream =
|
|
ProxyingStream::new(clocks.clone(), time::Duration::seconds(2), Box::new(stream));
|
|
stream.ts_offset = 123456; // starting pts of the input should be irrelevant
|
|
stream.ts_offset_pkts_left = u32::max_value();
|
|
stream.pkts_left = u32::max_value();
|
|
let (shutdown_tx, shutdown_rx) = base::shutdown::channel();
|
|
let opener = MockOpener {
|
|
expected_url: url::Url::parse("rtsp://test-camera/main").unwrap(),
|
|
streams: Mutex::new(vec![Box::new(stream)]),
|
|
shutdown_tx: Mutex::new(Some(shutdown_tx)),
|
|
};
|
|
let db = testutil::TestDb::new(clocks.clone());
|
|
let env = super::Environment {
|
|
opener: &opener,
|
|
db: &db.db,
|
|
shutdown_rx: &shutdown_rx,
|
|
};
|
|
let mut stream;
|
|
{
|
|
let l = db.db.lock();
|
|
let camera = l.cameras_by_id().get(&testutil::TEST_CAMERA_ID).unwrap();
|
|
let s = l.streams_by_id().get(&testutil::TEST_STREAM_ID).unwrap();
|
|
let dir = db
|
|
.dirs_by_stream_id
|
|
.get(&testutil::TEST_STREAM_ID)
|
|
.unwrap()
|
|
.clone();
|
|
stream = super::Streamer::new(
|
|
&env,
|
|
dir,
|
|
db.syncer_channel.clone(),
|
|
testutil::TEST_STREAM_ID,
|
|
camera,
|
|
s,
|
|
Arc::new(retina::client::SessionGroup::default()),
|
|
0,
|
|
3,
|
|
)
|
|
.unwrap();
|
|
}
|
|
stream.run();
|
|
assert!(opener.streams.lock().unwrap().is_empty());
|
|
db.syncer_channel.flush();
|
|
let db = db.db.lock();
|
|
|
|
// Compare frame-by-frame. Note below that while the rotation is scheduled to happen near
|
|
// 3-second boundaries (such as 2016-04-26 00:00:03), rotation happens somewhat later:
|
|
// * the first rotation is always skipped
|
|
// * the second rotation is deferred until a key frame.
|
|
#[rustfmt::skip]
|
|
assert_eq!(get_frames(&db, CompositeId::new(testutil::TEST_STREAM_ID, 0)), &[
|
|
Frame { start_90k: 0, duration_90k: 90379, is_key: true },
|
|
Frame { start_90k: 90379, duration_90k: 89884, is_key: false },
|
|
Frame { start_90k: 180263, duration_90k: 89749, is_key: false },
|
|
Frame { start_90k: 270012, duration_90k: 89981, is_key: false }, // pts_time 3.0001...
|
|
Frame { start_90k: 359993, duration_90k: 90055, is_key: true },
|
|
Frame { start_90k: 450048, duration_90k: 89967, is_key: false },
|
|
Frame { start_90k: 540015, duration_90k: 90021, is_key: false }, // pts_time 6.0001...
|
|
Frame { start_90k: 630036, duration_90k: 89958, is_key: false },
|
|
]);
|
|
#[rustfmt::skip]
|
|
assert_eq!(get_frames(&db, CompositeId::new(testutil::TEST_STREAM_ID, 1)), &[
|
|
Frame { start_90k: 0, duration_90k: 90011, is_key: true },
|
|
Frame { start_90k: 90011, duration_90k: 0, is_key: false },
|
|
]);
|
|
let mut recordings = Vec::new();
|
|
db.list_recordings_by_id(testutil::TEST_STREAM_ID, 0..2, &mut |r| {
|
|
recordings.push(r);
|
|
Ok(())
|
|
})
|
|
.unwrap();
|
|
assert_eq!(2, recordings.len());
|
|
assert_eq!(0, recordings[0].id.recording());
|
|
assert_eq!(recording::Time(128700575999999), recordings[0].start);
|
|
assert_eq!(0, recordings[0].flags);
|
|
assert_eq!(1, recordings[1].id.recording());
|
|
assert_eq!(recording::Time(128700576719993), recordings[1].start);
|
|
assert_eq!(db::RecordingFlags::TrailingZero as i32, recordings[1].flags);
|
|
|
|
drop(env);
|
|
drop(opener);
|
|
}
|
|
}
|