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
// Copyright 2022-2023 Andrew D. Straw.
use std::path::PathBuf;
use color_eyre::{
eyre::{self as anyhow},
Result,
};
use basic_frame::DynamicFrame;
pub mod pv_tiff_stack;
use pv_tiff_stack::TiffImage;
pub mod fmf_source;
mod h264_annexb_splitter;
pub mod h264_source;
pub mod mp4_source;
pub mod strand_cam_mkv_source;
mod ntp_timestamp;
#[cfg(test)]
mod test_timestamps;
/// A source of FrameData
///
/// The `frame0_time` method return value is an `Option` because we want to be
/// able to parse sources without an absolute time for the first frame, such as
/// normal MP4 video files. Similarly, we do not have a `len` method indicating
/// number of frames because some sources (e.g. an .h264 file) do not store how
/// many frames they have but rather must be parsed from beginning to end.
pub trait FrameDataSource {
/// Get the width of the source images, in pixels.
fn width(&self) -> u32;
/// Get the height of the source images, in pixels.
fn height(&self) -> u32;
fn camera_name(&self) -> Option<&str> {
None
}
fn gamma(&self) -> Option<f32> {
None
}
/// Get the timestamp of the first frame.
///
/// Note that (in case they can differ), this is the time
/// of the first frame rather than the creation time
/// in the metadata.
fn frame0_time(&self) -> Option<chrono::DateTime<chrono::FixedOffset>>;
/// Set source to skip the first N frames.
///
/// Note that this resets frame0_time accordingly.
fn skip_n_frames(&mut self, n_frames: usize) -> Result<()>;
/// Scan over the input images and estimate the luminance range
///
/// Returns Ok<(min, max)> when successful.
fn estimate_luminance_range(&mut self) -> Result<(u16, u16)>;
/// Whether timestamps are available.
///
/// If no timestamp is available, the frame "timestamp" with contain a
/// fraction of completeness.
fn has_timestamps(&self) -> bool;
/// A string describing the source of the timestamp data
fn timestamp_source(&self) -> &str;
/// Get an iterator over all frames.
fn iter<'a>(&'a mut self) -> Box<dyn Iterator<Item = Result<FrameData>> + 'a>;
}
/// A single frame of data, including `image` and `timestamp` fields.
#[derive(PartialEq, Debug)]
pub struct FrameData {
/// This is often called "PTS" (presentation time stamp).
timestamp: Timestamp,
image: ImageData,
buf_len: usize,
/// The number of the frame in the source
///
/// Starts with 0
idx: usize,
}
#[derive(PartialEq, Debug, Clone, Copy)]
pub enum Timestamp {
/// The timestamp, measured as the duration elapsed since the track onset
/// until the exposure started.
Duration(std::time::Duration),
/// In cases where no time is available, the fraction done.
Fraction(f32),
}
impl Timestamp {
pub fn unwrap_duration(&self) -> std::time::Duration {
match self {
Timestamp::Duration(d) => *d,
Timestamp::Fraction(_) => {
panic!("expected duration");
}
}
}
}
impl FrameData {
/// Get the timestamp, measured as the duration elapsed since the track onset
/// until the exposure started.
///
/// This is often called "PTS" (presentation time stamp).
pub fn timestamp(&self) -> Timestamp {
self.timestamp
}
/// Get the image data
pub fn image(&self) -> &ImageData {
&self.image
}
/// Get the image data
pub fn into_image(self) -> ImageData {
self.image
}
/// Get the number of the bytes used in the source.
pub fn num_bytes(&self) -> usize {
self.buf_len
}
/// Get the number of the frame in the source.
///
/// Starts with 0.
pub fn idx(&self) -> usize {
self.idx
}
pub fn decoded(&self) -> Option<&DynamicFrame> {
match &self.image {
ImageData::Decoded(frame) => Some(frame),
_ => None,
}
}
pub fn take_decoded(self) -> Option<DynamicFrame> {
match self.image {
ImageData::Decoded(frame) => Some(frame),
_ => None,
}
}
}
/// The image data
#[derive(Clone, PartialEq)]
pub enum ImageData {
Decoded(DynamicFrame),
Tiff(TiffImage),
EncodedH264(EncodedH264),
}
impl std::fmt::Debug for ImageData {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
match self {
ImageData::Decoded(_) => {
write!(f, "ImageData::Decoded")
}
ImageData::Tiff(_) => {
write!(f, "ImageData::Tiff")
}
ImageData::EncodedH264(_) => {
write!(f, "ImageData::EncodedH264")
}
}
}
}
#[derive(Clone, PartialEq)]
pub enum H264EncodingVariant {
/// single large buffer with Annex B headers
AnnexB(Vec<u8>),
/// single large buffer with AVCC headers
Avcc(Vec<u8>),
/// multiple buffers with just NAL unit data
RawEbsp(Vec<Vec<u8>>),
}
impl std::fmt::Debug for H264EncodingVariant {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
match self {
Self::AnnexB(buf) => write!(f, "H264EncodingVariant::AnnexB({} bytes)", buf.len()),
Self::Avcc(buf) => write!(f, "H264EncodingVariant::Avcc({} bytes)", buf.len()),
Self::RawEbsp(bufs) => {
write!(f, "H264EncodingVariant::RawEbsp({} buffers)", bufs.len())
}
}
}
}
#[derive(Clone, PartialEq, Debug)]
pub struct EncodedH264 {
pub data: H264EncodingVariant,
pub has_precision_timestamp: bool,
}
#[derive(Debug, Clone, PartialEq)]
pub enum TimestampSource {
BestGuess,
FrameInfoRecvTime,
Mp4Pts,
MispMicrosectime,
}
trait MyAsStr {
fn as_str(&self) -> &'static str;
}
impl MyAsStr for Option<TimestampSource> {
fn as_str(&self) -> &'static str {
use TimestampSource::*;
match self {
Some(BestGuess) => "(best guess)",
Some(FrameInfoRecvTime) => "FrameInfo receive time",
Some(Mp4Pts) => "MP4 PTS",
Some(MispMicrosectime) => "MISPmicrosectime",
None => "(no timestamps)",
}
}
}
/// Create a [FrameDataSource] from a path.
///
/// The `do_decode_h264` argument specifies that an H264 source will be decoded
/// (e.g. to extract individual images).
pub fn from_path<P: AsRef<std::path::Path>>(
input: P,
do_decode_h264: bool,
) -> Result<Box<dyn FrameDataSource>> {
from_path_with_timestamp_source(input, do_decode_h264, TimestampSource::BestGuess)
}
/// Create a [FrameDataSource] from a path with defined timestamp source
///
/// The `do_decode_h264` argument specifies that an H264 source will be decoded
/// (e.g. to extract individual images).
pub fn from_path_with_timestamp_source<P: AsRef<std::path::Path>>(
input: P,
do_decode_h264: bool,
timestamp_source: TimestampSource,
) -> Result<Box<dyn FrameDataSource>> {
let input_path = PathBuf::from(input.as_ref());
let is_file = std::fs::metadata(input.as_ref())?.is_file();
if is_file {
if let Some(extension) = input_path.extension() {
match extension.to_str() {
Some("mkv") => {
let mkv_video = strand_cam_mkv_source::from_path_with_timestamp_source(
&input,
do_decode_h264,
timestamp_source,
)?;
return Ok(Box::new(mkv_video));
}
Some("mp4") => {
let mp4_video = mp4_source::from_path_with_timestamp_source(
&input,
do_decode_h264,
timestamp_source,
)?;
return Ok(Box::new(mp4_video));
}
Some("h264") => {
let h264_video = h264_source::from_annexb_path_with_timestamp_source(
&input,
do_decode_h264,
timestamp_source,
)?;
return Ok(Box::new(h264_video));
}
_ => {}
}
}
let fname_lower = input_path.to_string_lossy().to_lowercase();
if fname_lower.ends_with(".fmf") || fname_lower.ends_with(".fmf.gz") {
let fmf_video = fmf_source::from_path(&input)?;
return Ok(Box::new(fmf_video));
}
anyhow::bail!(
"input {} is a file, but the extension was not recognized.",
input.as_ref().display()
);
} else {
let dirname = input_path;
if !std::fs::metadata(&dirname)?.is_dir() {
anyhow::bail!("Attempting to open \"{}\" as directory with TIFF stack failed because it is not a directory.", dirname.display());
}
let pattern = dirname.join("*.tif");
let stack = pv_tiff_stack::from_path_pattern(pattern.to_str().unwrap())?;
Ok(Box::new(stack))
}
}