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 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
extern crate ffmpeg_next as ffmpeg;
use std::path::{Path, PathBuf};
use ffmpeg::codec::packet::Packet as AvPacket;
use ffmpeg::ffi::AV_TIME_BASE_Q;
use ffmpeg::format::context::{Input as AvInput, Output as AvOutput};
use ffmpeg::media::Type as AvMediaType;
use ffmpeg::Error as AvError;
use crate::ffi;
use crate::options::Options;
use crate::{Error, Packet, StreamInfo};
type Result<T> = std::result::Result<T, Error>;
/// Re-export `url::Url` since it is an input type for callers of the API.
pub use url::Url;
/// Video reader that can read from files.
pub struct Reader {
pub source: Locator,
pub input: AvInput,
}
impl Reader {
/// Create a new video file reader on a given source (path, URL, etc.).
///
/// # Arguments
///
/// * `source` - Source to read from.
pub fn new(source: &Locator) -> Result<Self> {
let input = ffmpeg::format::input(&source.resolve())?;
Ok(Self {
source: source.clone(),
input,
})
}
/// Create a new video file reader with options for the backend.
///
/// # Arguments
///
/// * `source` - Source to read from.
/// * `options` - Options to pass on.
///
/// # Examples
///
/// ```ignore
/// let mut options = HashMap::new();
/// options.insert(
/// "rtsp_transport".to_string(),
/// "tcp".to_string(),
/// );
///
/// let mut reader = Reader::new(
/// &PathBuf::from("my_file.mp4").into(),
/// &options.into()
/// )
/// .unwrap();
/// ```
pub fn new_with_options(source: &Locator, options: &Options) -> Result<Self> {
let input = ffmpeg::format::input_with_dictionary(&source.resolve(), options.to_dict())?;
Ok(Self {
source: source.clone(),
input,
})
}
/// Read a single packet from the source video file.
///
/// # Arguments
///
/// * `stream_index` - Index of stream to read from.
///
/// # Examples
///
/// Read a single packet.
///
/// ```ignore
/// let mut reader = Reader(&PathBuf::from("my_video.mp4").into()).unwrap();
/// let stream = reader.best_video_stream_index().unwrap();
/// let mut packet = reader.read(stream).unwrap();
/// ```
pub fn read(&mut self, stream_index: usize) -> Result<Packet> {
let mut error_count = 0;
loop {
match self.input.packets().next() {
Some((stream, packet)) => {
if stream.index() == stream_index {
return Ok(Packet::new(packet, stream.time_base()));
}
}
None => {
error_count += 1;
if error_count > 3 {
return Err(Error::ReadExhausted);
}
}
}
}
}
/// Retrieve stream information for a stream. Stream information can be used to set up a
/// corresponding stream for transmuxing or transcoding.
///
/// # Arguments
///
/// * `stream_index` - Index of stream to produce information for.
pub fn stream_info(&self, stream_index: usize) -> Result<StreamInfo> {
StreamInfo::from_reader(self, stream_index)
}
/// Seek in reader. This will change the reader head so that it points to a location within one
/// second of the target timestamp or it will return an error.
///
/// # Arguments
///
/// * `timestamp_milliseconds` - Number of millisecond from start of video to seek to.
pub fn seek(&mut self, timestamp_milliseconds: i64) -> Result<()> {
// Conversion factor from timestamp in milliseconds to `TIME_BASE` units.
const CONVERSION_FACTOR: i64 = (AV_TIME_BASE_Q.den / 1000) as i64;
// One second left and right leeway when seeking.
const LEEWAY: i64 = AV_TIME_BASE_Q.den as i64;
let timestamp = CONVERSION_FACTOR * timestamp_milliseconds;
let range = timestamp - LEEWAY..timestamp + LEEWAY;
self.input
.seek(timestamp, range)
.map_err(Error::BackendError)
}
/// Seek to start of reader. This function performs best effort seeking to the start of the
/// file.
pub fn seek_to_start(&mut self) -> Result<()> {
self.input
.seek(i64::min_value(), ..)
.map_err(Error::BackendError)
}
/// Find the best video stream and return the index.
pub fn best_video_stream_index(&self) -> Result<usize> {
Ok(self
.input
.streams()
.best(AvMediaType::Video)
.ok_or(AvError::StreamNotFound)?
.index())
}
}
unsafe impl Send for Reader {}
unsafe impl Sync for Reader {}
/// Any type that implements this can write video packets.
pub trait Write: private::Write + private::Output {}
/// File writer for video files.
pub struct Writer {
pub dest: Locator,
pub(crate) output: AvOutput,
}
impl Writer {
/// Create a new file writer for video files.
///
/// # Arguments
///
/// * `dest` - Where to write to.
pub fn new(dest: &Locator) -> Result<Self> {
let output = ffmpeg::format::output(&dest.resolve())?;
Ok(Self {
dest: dest.clone(),
output,
})
}
/// Create a new file writer for video files with a custom format specifier.
///
/// # Arguments
///
/// * `dest` - Where to write to.
/// * `format` - Container format to use.
pub fn new_with_format(dest: &Locator, format: &str) -> Result<Self> {
let output = ffmpeg::format::output_as(&dest.resolve(), format)?;
Ok(Self {
dest: dest.clone(),
output,
})
}
/// Create a new file writer for video files with custom options for the ffmpeg backend.
///
/// # Arguments
///
/// * `dest` - Where to write to.
/// * `options` - Options to pass on.
///
/// # Examples
///
/// Create a video writer that produces fragmented MP4.
///
/// ```ignore
/// let mut options = HashMap::new();
/// options.insert(
/// "movflags".to_string(),
/// "frag_keyframe+empty_moov".to_string(),
/// );
///
/// let mut writer = FileWriter::new(
/// &PathBuf::from("my_file.mp4").into(),
/// &options.into(),
/// )
/// .unwrap();
/// ```
pub fn new_with_options(dest: &Locator, options: &Options) -> Result<Self> {
let output = ffmpeg::format::output_with(&dest.resolve(), options.to_dict())?;
Ok(Self {
dest: dest.clone(),
output,
})
}
/// Create a new file writer for video files with a custom format specifier and custom options
/// for the ffmpeg backend.
///
/// # Arguments
///
/// * `dest` - Where to write to.
/// * `format` - Container format to use.
/// * `options` - Options to pass on.
pub fn new_with_format_and_options(
dest: &Locator,
format: &str,
options: &Options,
) -> Result<Self> {
let output = ffmpeg::format::output_as_with(&dest.resolve(), format, options.to_dict())?;
Ok(Self {
dest: dest.clone(),
output,
})
}
}
impl Write for Writer {}
unsafe impl Send for Writer {}
unsafe impl Sync for Writer {}
/// Type alias for a byte buffer.
pub type Buf = Vec<u8>;
/// Type alias for multiple buffers.
pub type Bufs = Vec<Buf>;
/// Video writer that writes to a buffer.
pub struct BufWriter {
pub(crate) output: AvOutput,
options: Options<'static>,
}
impl BufWriter {
/// Create a video writer that writes to a buffer and returns the resulting bytes.
///
/// # Arguments
///
/// * `format` - Container format to use.
///
/// # Examples
///
/// ```ignore
/// let mut writer = BufWriter::new("mp4").unwrap();
/// let bytes = writer.write_header()?;
/// ```
pub fn new(format: &str) -> Result<Self> {
Self::new_with(format, Default::default())
}
/// Create a video writer that writes to a buffer and returns the resulting bytes. This
/// constructor also allows for passing options for the ffmpeg backend.
///
/// # Arguments
///
/// * `format` - Container format to use.
/// * `options` - Options to pass on to ffmpeg.
pub fn new_with(format: &str, options: Options<'static>) -> Result<Self> {
let output = ffi::output_raw(format)?;
Ok(Self { output, options })
}
fn begin_write(&mut self) {
ffi::output_raw_buf_start(&mut self.output);
}
fn end_write(&mut self) -> Buf {
ffi::output_raw_buf_end(&mut self.output)
}
}
impl Write for BufWriter {}
impl Drop for BufWriter {
fn drop(&mut self) {
// Make sure to close the buffer properly before dropping the object or `avio_close` will
// get confused and double free. We can simply ignore the resulting buffer.
let _ = ffi::output_raw_buf_end(&mut self.output);
}
}
unsafe impl Send for BufWriter {}
unsafe impl Sync for BufWriter {}
/// Video writer that writes to a packetized buffer.
pub struct PacketizedBufWriter {
pub(crate) output: AvOutput,
options: Options<'static>,
buffers: Bufs,
}
impl PacketizedBufWriter {
/// Actual packet size. Value should be below MTU.
const PACKET_SIZE: usize = 1024;
/// Create a video writer that writes multiple packets to a buffer and returns the resulting
/// bytes for each packet.
///
/// # Arguments
///
/// * `format` - Container format to use.
///
/// # Examples
///
/// ```ignore
/// let mut writer = BufPacketizedWriter::new("rtp").unwrap();
/// let bytes = writer.write_header()?;
/// ```
pub fn new(format: &str) -> Result<Self> {
Self::new_with(format, Default::default())
}
/// Create a video writer that writes multiple packets to a buffer and returns the resulting
/// bytes for each packet. This constructor also allows for passing options for the ffmpeg
/// backend.
///
/// # Arguments
///
/// * `format` - Container format to use.
/// * `options` - Options to pass on to ffmpeg.
pub fn new_with(format: &str, options: Options<'static>) -> Result<Self> {
let output = ffi::output_raw(format)?;
Ok(Self {
output,
options,
buffers: Vec::new(),
})
}
fn begin_write(&mut self) {
ffi::output_raw_packetized_buf_start(
&mut self.output,
// Note: `ffi::output_raw_packetized_bug_start` requires that this value lives until
// `ffi::output_raw_packetized_buf_end`. This is guaranteed by the fact that
// `begin_write` is always followed by an invocation of `end_write` in the same function
// (see the implementation) of `Write` for `PacketizedBufWriter`.
&mut self.buffers,
Self::PACKET_SIZE,
);
}
fn end_write(&mut self) {
ffi::output_raw_packetized_buf_end(&mut self.output);
}
#[inline]
fn take_buffers(&mut self) -> Bufs {
// We take the buffers here and replace them with an empty `Vec`.
std::mem::take(&mut self.buffers)
}
}
impl Write for PacketizedBufWriter {}
unsafe impl Send for PacketizedBufWriter {}
unsafe impl Sync for PacketizedBufWriter {}
/// Wrapper type for any valid video source. Currently, this could be a URI, file path or any other
/// input the backend will accept. Later, we might add some scaffolding to have stricter typing.
#[derive(Clone)]
pub enum Locator {
Path(PathBuf),
Url(Url),
}
impl Locator {
/// Resolves the locator into a `PathBuf` for usage with `ffmpeg-next`.
fn resolve(&self) -> &Path {
match self {
Locator::Path(path) => path.as_path(),
Locator::Url(url) => Path::new(url.as_str()),
}
}
}
/// Allow conversion from path to `Locator`.
impl From<PathBuf> for Locator {
fn from(path: PathBuf) -> Locator {
Locator::Path(path)
}
}
/// Allow conversion from `Url` to `Locator`.
impl From<Url> for Locator {
fn from(url: Url) -> Locator {
Locator::Url(url)
}
}
/// Allow conversion to string and display for locator types.
impl std::fmt::Display for Locator {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Locator::Path(ref path) => write!(f, "{}", path.display()),
Locator::Url(ref url) => write!(f, "{url}"),
}
}
}
pub(crate) mod private {
use super::*;
type Result<T> = std::result::Result<T, Error>;
pub trait Write {
type Out;
/// Write the container header.
fn write_header(&mut self) -> Result<Self::Out>;
/// Write a packet into the container.
///
/// # Arguments
///
/// * `packet` - Packet to write.
fn write(&mut self, packet: &mut AvPacket) -> Result<Self::Out>;
/// Write a packet into the container and take care of interleaving.
///
/// # Arguments
///
/// * `packet` - Packet to write.
fn write_interleaved(&mut self, packet: &mut AvPacket) -> Result<Self::Out>;
/// Write the container trailer.
fn write_trailer(&mut self) -> Result<Self::Out>;
}
impl Write for Writer {
type Out = ();
fn write_header(&mut self) -> Result<()> {
Ok(self.output.write_header()?)
}
fn write(&mut self, packet: &mut AvPacket) -> Result<()> {
packet.write(&mut self.output)?;
Ok(())
}
fn write_interleaved(&mut self, packet: &mut AvPacket) -> Result<()> {
packet.write_interleaved(&mut self.output)?;
Ok(())
}
fn write_trailer(&mut self) -> Result<()> {
Ok(self.output.write_trailer()?)
}
}
impl Write for BufWriter {
type Out = Buf;
fn write_header(&mut self) -> Result<Buf> {
self.begin_write();
self.output.write_header_with(self.options.to_dict())?;
Ok(self.end_write())
}
fn write(&mut self, packet: &mut AvPacket) -> Result<Buf> {
self.begin_write();
packet.write(&mut self.output)?;
ffi::flush_output(&mut self.output)?;
Ok(self.end_write())
}
fn write_interleaved(&mut self, packet: &mut AvPacket) -> Result<Buf> {
self.begin_write();
packet.write_interleaved(&mut self.output)?;
ffi::flush_output(&mut self.output)?;
Ok(self.end_write())
}
fn write_trailer(&mut self) -> Result<Buf> {
self.begin_write();
self.output.write_trailer()?;
Ok(self.end_write())
}
}
impl Write for PacketizedBufWriter {
type Out = Bufs;
fn write_header(&mut self) -> Result<Bufs> {
self.begin_write();
self.output.write_header_with(self.options.to_dict())?;
self.end_write();
Ok(self.take_buffers())
}
fn write(&mut self, packet: &mut AvPacket) -> Result<Bufs> {
self.begin_write();
packet.write(&mut self.output)?;
ffi::flush_output(&mut self.output)?;
self.end_write();
Ok(self.take_buffers())
}
fn write_interleaved(&mut self, packet: &mut AvPacket) -> Result<Bufs> {
self.begin_write();
packet.write_interleaved(&mut self.output)?;
ffi::flush_output(&mut self.output)?;
self.end_write();
Ok(self.take_buffers())
}
fn write_trailer(&mut self) -> Result<Bufs> {
self.begin_write();
self.output.write_trailer()?;
self.end_write();
Ok(self.take_buffers())
}
}
pub trait Output {
/// Obtain reference to output context.
fn output(&self) -> &AvOutput;
/// Obtain mutable reference to output context.
fn output_mut(&mut self) -> &mut AvOutput;
}
impl Output for Writer {
fn output(&self) -> &AvOutput {
&self.output
}
fn output_mut(&mut self) -> &mut AvOutput {
&mut self.output
}
}
impl Output for BufWriter {
fn output(&self) -> &AvOutput {
&self.output
}
fn output_mut(&mut self) -> &mut AvOutput {
&mut self.output
}
}
impl Output for PacketizedBufWriter {
fn output(&self) -> &AvOutput {
&self.output
}
fn output_mut(&mut self) -> &mut AvOutput {
&mut self.output
}
}
}