Expand description
π¬οΈ A Rust library (with auto dependencies installation) for YouTube downloading
Β§ποΈ Why using external Python app ?
Originally, to download videos from YouTube, I used the rustube crate, written in pure Rust and without any external dependencies.
However, I quickly realized that due to frequent breaking changes on the YouTube website, the crate was outdated and no longer functional.
After few tests and researches, I concluded that the python app yt-dlp was the best compromise, thanks to its regular updates and massive community.
His standalone binaries and his ability to output the fetched data in JSON format make it a most imperfect candidate for a Rust wrapper.
Using an external program is not ideal, but it is the most reliable and maintained solution for now.
Β§π₯ How to get it
Add the following to your Cargo.toml file:
[dependencies]
yt-dlp = "1.4.7"A new release is automatically published every two weeks, to keep up to date with dependencies and features. Make sure to check the releases page to see the latest version of the crate.
Β§π Optional features
This library puts a lot of functionality behind optional features in order to optimize compile time for the most common use cases. The following features are available.
cache(enabled by default) - Enables video metadata, files and thumbnails cachingtracing(enabled by default) βEnables profiling with the
tracingcrate. When this feature is enabled, the library will output span events at log levelstraceanddebug, depending on the importance of the called function.rustls- Enables therustls-tlsfeature in thereqwestcrate. This enables building the application without openssl or other system sourced SSL libraries.
Β§π Profiling with tracing (enabled by default):
The crate supports the tracing feature to enable profiling, which can be useful for debugging.
You can enable it by adding the following to your Cargo.toml file:
[dependencies]
yt-dlp = { version = "1.4.7", features = ["tracing"], default-features = false }Β§π Documentation
The documentation is available on docs.rs.
Β§π Examples
use yt_dlp::Youtube;
use std::path::PathBuf;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let executables_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let fetcher = Youtube::with_new_binaries(executables_dir, output_dir).await?;
Ok(())
}- π¦ Installing the
yt-dlpbinary only:
use yt_dlp::client::deps::LibraryInstaller;
use std::path::PathBuf;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let destination = PathBuf::from("libs");
let installer = LibraryInstaller::new(destination);
let youtube = installer.install_youtube(None).await.unwrap();
Ok(())
}- π¦ Installing the
ffmpegbinary only:
use yt_dlp::client::deps::LibraryInstaller;
use std::path::PathBuf;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let destination = PathBuf::from("libs");
let installer = LibraryInstaller::new(destination);
let ffmpeg = installer.install_ffmpeg(None).await.unwrap();
Ok(())
}- π Updating the
yt-dlpbinary:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
fetcher.update_downloader().await?;
Ok(())
}- π₯ Fetching a video (with its audio) and downloading it:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
let video_path = fetcher.download_video_from_url(url, "my-video.mp4").await?;
Ok(())
}- β¨ Using the fluent API with custom quality preferences:
use yt_dlp::Youtube;
use yt_dlp::model::selector::{VideoQuality, AudioQuality, VideoCodecPreference};
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
// Use the fluent download builder API
let video_path = fetcher.download(url, "my-video.mp4")
.video_quality(VideoQuality::Q1080p)
.video_codec(VideoCodecPreference::H264)
.audio_quality(AudioQuality::Best)
.execute()
.await?;
Ok(())
}- π¬ Fetching a video (without its audio) and downloading it:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
fetcher.download_video_stream_from_url(url, "video.mp4").await?;
Ok(())
}- π΅ Fetching an audio and downloading it:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
fetcher.download_audio_stream_from_url(url, "audio.mp3").await?;
Ok(())
}- π Fetching a specific format and downloading it:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
let video = fetcher.fetch_video_infos(url).await?;
println!("Video title: {}", video.title);
let video_format = video.best_video_format().unwrap();
let format_path = fetcher.download_format(&video_format, "my-video-stream.mp4").await?;
let audio_format = video.worst_audio_format().unwrap();
let audio_path = fetcher.download_format(&audio_format, "my-audio-stream.mp3").await?;
Ok(())
}- βοΈ Combining an audio and a video file into a single file:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
let video = fetcher.fetch_video_infos(url).await?;
let audio_format = video.best_audio_format().unwrap();
let audio_path = fetcher.download_format(&audio_format, "audio-stream.mp3").await?;
let video_format = video.worst_video_format().unwrap();
let video_path = fetcher.download_format(&video_format, "video-stream.mp4").await?;
let output_path = fetcher.combine_audio_and_video("audio-stream.mp3", "video-stream.mp4", "my-output.mp4").await?;
Ok(())
}- πΈ Fetching a thumbnail and downloading it:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
let thumbnail_path = fetcher.download_thumbnail_from_url(url, "thumbnail.jpg").await?;
Ok(())
}- π₯ Download with download manager and priority:
use yt_dlp::Youtube;
use yt_dlp::download::manager::{ManagerConfig, DownloadPriority};
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
// Custom download manager configuration using builder methods
let config = ManagerConfig::default()
.with_max_concurrent_downloads(5) // Maximum 5 concurrent downloads
.with_segment_size(1024 * 1024 * 10) // 10 MB per segment
.with_parallel_segments(8) // 8 parallel segments per download
.with_retry_attempts(5) // 5 retry attempts on failure
.with_max_buffer_size(1024 * 1024 * 20); // 20 MB maximum buffer
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
// Create a fetcher with custom configuration
let fetcher = Youtube::with_download_manager_config(libraries, output_dir, config)?;
// Download a video with high priority
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
let video = fetcher.fetch_video_infos(url).await?;
let download_id = fetcher.download_video_with_priority(
&video,
"video-high-priority.mp4",
Some(DownloadPriority::High)
).await?;
// Wait for download completion
let status = fetcher.wait_for_download(download_id).await;
println!("Final download status: {:?}", status);
Ok(())
}- π Download with progress tracking:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
let video = fetcher.fetch_video_infos(url).await?;
// Download with progress callback
let download_id = fetcher.download_video_with_progress(
&video,
"video-with-progress.mp4",
|downloaded, total| {
let percentage = if total > 0 {
(downloaded as f64 / total as f64 * 100.0) as u64
} else {
0
};
println!("Progress: {}/{} bytes ({}%)", downloaded, total, percentage);
}
).await?;
// Wait for download completion
fetcher.wait_for_download(download_id).await;
Ok(())
}- π Canceling a download:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
let video = fetcher.fetch_video_infos(url).await?;
// Start a download
let download_id = fetcher.download_video_with_priority(
&video,
"video-to-cancel.mp4",
None
).await?;
// Check status
let status = fetcher.get_download_status(download_id).await;
println!("Download status: {:?}", status);
// Cancel the download
let canceled = fetcher.cancel_download(download_id).await;
println!("Download canceled: {}", canceled);
Ok(())
}Β§ποΈ Format Selection
The library provides a powerful format selection system that allows you to download videos and audio with specific quality and codec preferences.
Β§π¬ Video Quality Options
VideoQuality::Best- Selects the highest quality video format availableVideoQuality::High- Targets 1080p resolutionVideoQuality::Medium- Targets 720p resolutionVideoQuality::Low- Targets 480p resolutionVideoQuality::Worst- Selects the lowest quality video format availableVideoQuality::CustomHeight(u32)- Targets a specific height (e.g.,CustomHeight(1440)for 1440p)VideoQuality::CustomWidth(u32)- Targets a specific width (e.g.,CustomWidth(1920)for 1920px width)
Β§π΅ Audio Quality Options
AudioQuality::Best- Selects the highest quality audio format availableAudioQuality::High- Targets 192kbps bitrateAudioQuality::Medium- Targets 128kbps bitrateAudioQuality::Low- Targets 96kbps bitrateAudioQuality::Worst- Selects the lowest quality audio format availableAudioQuality::CustomBitrate(u32)- Targets a specific bitrate in kbps (e.g.,CustomBitrate(256)for 256kbps)
Β§ποΈ Codec Preferences
Β§πΉ Video Codecs
VideoCodecPreference::VP9- Prefer VP9 codecVideoCodecPreference::AVC1- Prefer AVC1/H.264 codecVideoCodecPreference::AV1- Prefer AV01/AV1 codecVideoCodecPreference::Custom(String)- Prefer a custom codecVideoCodecPreference::Any- No codec preference
Β§π Audio Codecs
AudioCodecPreference::Opus- Prefer Opus codecAudioCodecPreference::AAC- Prefer AAC codecAudioCodecPreference::MP3- Prefer MP3 codecAudioCodecPreference::Custom(String)- Prefer a custom codecAudioCodecPreference::Any- No codec preference
Β§π§ͺ Example: Downloading with Quality and Codec Preferences
use yt_dlp::Youtube;
use yt_dlp::model::selector::{VideoQuality, VideoCodecPreference, AudioQuality, AudioCodecPreference};
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
// Download a high quality video with VP9 codec and high quality audio with Opus codec
let video_path = fetcher.download_video_with_quality(
url.clone(),
"complete-video.mp4",
VideoQuality::High,
VideoCodecPreference::VP9,
AudioQuality::High,
AudioCodecPreference::Opus
).await?;
// Download just the video stream with medium quality and AVC1 codec
let video_stream_path = fetcher.download_video_stream_with_quality(
url.clone(),
"video-only.mp4",
VideoQuality::Medium,
VideoCodecPreference::AVC1
).await?;
// Download just the audio stream with high quality and AAC codec
let audio_stream_path = fetcher.download_audio_stream_with_quality(
url,
"audio-only.m4a",
AudioQuality::High,
AudioCodecPreference::AAC
).await?;
println!("Downloaded files:");
println!("Complete video: {}", video_path.display());
println!("Video stream: {}", video_stream_path.display());
println!("Audio stream: {}", audio_stream_path.display());
Ok(())
}Β§π Metadata
The project supports automatic addition of metadata to downloaded files in several formats:
- MP3: Title, artist, comment, genre (from tags), release year
- M4A: Title, artist, comment, genre (from tags), release year
- MP4: All basic metadata, plus technical information (resolution, FPS, video codec, video bitrate, audio codec, audio bitrate, audio channels, sample rate)
- WebM: All basic metadata (via Matroska format), plus technical information as with MP4
Metadata is added automatically during download, without requiring any additional action from the user.
Β§π§ Intelligent Metadata Management
The system intelligently manages the application of metadata based on the file type and intended use:
- For standalone files (audio or audio+video), metadata is applied immediately during download.
- For separate audio and video streams that will be combined later, metadata is not applied to individual files to avoid redundant work.
- When combining audio and video streams with
combine_audio_and_video(), complete metadata is applied to the final file, including information from both streams.
This optimized approach ensures that metadata is always present in the final file, while avoiding unnecessary processing of temporary files.
Β§π Chapters
Videos may contain chapters that divide the content into logical segments. The library provides easy access to chapter information and automatically embeds chapters into downloaded video files (MP4/MKV/WebM):
- π Accessing video chapters:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
let video = fetcher.fetch_video_infos(url).await?;
// Check if video has chapters
if video.has_chapters() {
println!("Video has {} chapters", video.get_chapters().len());
// Iterate over all chapters
for chapter in video.get_chapters() {
println!(
"Chapter: {} ({:.2}s - {:.2}s)",
chapter.title.as_deref().unwrap_or("Untitled"),
chapter.start_time,
chapter.end_time
);
}
}
Ok(())
}- π Finding a chapter at a specific timestamp:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
let video = fetcher.fetch_video_infos(url).await?;
// Find chapter at 120 seconds (2 minutes)
if let Some(chapter) = video.get_chapter_at_time(120.0) {
println!(
"At 2:00, you're in chapter: {}",
chapter.title.as_deref().unwrap_or("Untitled")
);
println!("Chapter duration: {:.2}s", chapter.duration());
}
Ok(())
}Note: When downloading videos using download_video() or download_video_from_url(), chapters are automatically embedded into the video file metadata. Media players like VLC, MPV, and others will be able to navigate using the chapters!
Β§π₯ Heatmap
Heatmap data (also known as βMost Replayedβ segments) shows viewer engagement across different parts of a video. This feature allows you to identify which segments are most popular:
- π₯ Accessing heatmap data:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
let video = fetcher.fetch_video_infos(url).await?;
// Check if video has heatmap data
if video.has_heatmap() {
if let Some(heatmap) = video.get_heatmap() {
println!("Video has {} heatmap segments", heatmap.points.len());
// Find the most replayed segment
if let Some(most_replayed) = heatmap.most_engaged_segment() {
println!(
"Most replayed segment: {:.2}s - {:.2}s (engagement: {:.2})",
most_replayed.start_time,
most_replayed.end_time,
most_replayed.value
);
}
}
}
Ok(())
}- π Analyzing engagement by threshold:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
let video = fetcher.fetch_video_infos(url).await?;
if let Some(heatmap) = video.get_heatmap() {
// Get segments with high engagement (> 0.7)
let highly_engaged = heatmap.get_highly_engaged_segments(0.7);
println!("Found {} highly engaged segments", highly_engaged.len());
for segment in highly_engaged {
println!(
"High engagement: {:.2}s - {:.2}s (value: {:.2})",
segment.start_time,
segment.end_time,
segment.value
);
}
// Get engagement at specific timestamp
if let Some(point) = heatmap.get_point_at_time(120.0) {
println!(
"Engagement at 2:00 is {:.2}",
point.value
);
}
}
Ok(())
}Β§π Subtitles
The library provides comprehensive subtitle support, including downloading, language selection, and embedding subtitles into videos:
- π Listing available subtitle languages:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
let video = fetcher.fetch_video_infos(url).await?;
// List all available subtitle languages
let languages = fetcher.list_subtitle_languages(&video);
println!("Available subtitle languages: {:?}", languages);
// Check if specific language is available
if fetcher.has_subtitle_language(&video, "en") {
println!("English subtitles are available");
}
Ok(())
}- π₯ Downloading a specific subtitle:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
let video = fetcher.fetch_video_infos(url).await?;
// Download English subtitles
let subtitle_path = fetcher
.download_subtitle(&video, "en", "subtitle_en.srt")
.await?;
println!("Subtitle downloaded to: {:?}", subtitle_path);
Ok(())
}- π₯ Downloading all available subtitles:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
let video = fetcher.fetch_video_infos(url).await?;
// Download all available subtitles
let subtitle_paths = fetcher
.download_all_subtitles(&video, &output_dir)
.await?;
println!("Downloaded {} subtitle files", subtitle_paths.len());
Ok(())
}- π¬ Embedding subtitles into a video:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
let video = fetcher.fetch_video_infos(url).await?;
// Download video
let video_path = fetcher.download_video(&video, "video.mp4").await?;
// Download subtitles
let en_subtitle = fetcher
.download_subtitle(&video, "en", "subtitle_en.srt")
.await?;
let fr_subtitle = fetcher
.download_subtitle(&video, "fr", "subtitle_fr.srt")
.await?;
// Embed subtitles into video
let video_with_subs = fetcher
.embed_subtitles_in_video(
&video_path,
&[en_subtitle, fr_subtitle],
"video_with_subtitles.mp4",
)
.await?;
println!("Video with embedded subtitles: {:?}", video_with_subs);
Ok(())
}- π Working with automatic captions:
use yt_dlp::Youtube;
use yt_dlp::model::caption::Subtitle;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
let video = fetcher.fetch_video_infos(url).await?;
// Iterate over subtitles and filter automatic ones
for (lang_code, subtitles) in &video.subtitles {
for subtitle in subtitles {
if subtitle.is_automatic {
println!(
"Auto-generated subtitle: {} ({})",
subtitle.language_name
.as_deref()
.unwrap_or(lang_code),
subtitle.file_extension()
);
}
}
}
// Convert automatic captions to Subtitle struct
for (lang_code, auto_captions) in &video.automatic_captions {
if let Some(caption) = auto_captions.first() {
let subtitle = Subtitle::from_automatic_caption(
caption,
lang_code.clone(),
);
println!("Converted: {}", subtitle);
}
}
Ok(())
}Β§π Playlists
The library provides full playlist support, including fetching playlist metadata and downloading videos with various selection options:
- π Fetching playlist information:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let playlist_url = String::from("https://www.youtube.com/playlist?list=PLrAXtmErZgOeiKm4sgNOknGvNjby9efdf");
let playlist = fetcher.fetch_playlist_infos(playlist_url).await?;
println!("Playlist: {}", playlist.title);
println!("Videos: {}", playlist.entry_count());
println!("Uploader: {}", playlist.uploader);
// List all videos in the playlist
for entry in &playlist.entries {
println!(
"[{}] {} ({})",
entry.index.unwrap_or(0),
entry.title,
entry.id
);
}
Ok(())
}- π₯ Downloading entire playlist:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let playlist_url = String::from("https://www.youtube.com/playlist?list=PLrAXtmErZgOeiKm4sgNOknGvNjby9efdf");
let playlist = fetcher.fetch_playlist_infos(playlist_url).await?;
// Download all videos with a pattern
// Use %(playlist_index)s for index, %(title)s for title, %(id)s for video ID
let video_paths = fetcher
.download_playlist(&playlist, "%(playlist_index)s - %(title)s.mp4")
.await?;
println!("Downloaded {} videos", video_paths.len());
Ok(())
}- π― Downloading specific videos by index:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let playlist_url = String::from("https://www.youtube.com/playlist?list=PLrAXtmErZgOeiKm4sgNOknGvNjby9efdf");
let playlist = fetcher.fetch_playlist_infos(playlist_url).await?;
// Download specific videos by index (0-based)
let indices = vec![0, 2, 5, 10]; // Videos at positions 1, 3, 6, and 11
let video_paths = fetcher
.download_playlist_items(&playlist, &indices, "%(playlist_index)s - %(title)s.mp4")
.await?;
println!("Downloaded {} specific videos", video_paths.len());
Ok(())
}- π Downloading a range of videos:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let playlist_url = String::from("https://www.youtube.com/playlist?list=PLrAXtmErZgOeiKm4sgNOknGvNjby9efdf");
let playlist = fetcher.fetch_playlist_infos(playlist_url).await?;
// Download videos 5-15 (0-based, inclusive)
let video_paths = fetcher
.download_playlist_range(&playlist, 5, 15, "%(playlist_index)s - %(title)s.mp4")
.await?;
println!("Downloaded {} videos from range", video_paths.len());
Ok(())
}- π Filtering and analyzing playlists:
use yt_dlp::Youtube;
use std::path::PathBuf;
use yt_dlp::client::deps::Libraries;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let youtube = libraries_dir.join("yt-dlp");
let ffmpeg = libraries_dir.join("ffmpeg");
let libraries = Libraries::new(youtube, ffmpeg);
let fetcher = Youtube::new(libraries, output_dir)?;
let playlist_url = String::from("https://www.youtube.com/playlist?list=PLrAXtmErZgOeiKm4sgNOknGvNjby9efdf");
let playlist = fetcher.fetch_playlist_infos(playlist_url).await?;
// Check if playlist is complete
if playlist.is_complete() {
println!("All playlist videos have been fetched");
}
// Get only available videos
let available = playlist.available_entries();
println!("Available videos: {}/{}", available.len(), playlist.entry_count());
// Get specific entry
if let Some(first_video) = playlist.get_entry_by_index(0) {
println!("First video: {}", first_video.title);
if let Some(duration) = first_video.duration_minutes() {
println!("Duration: {:.2} minutes", duration);
}
}
// Get entries in a range
let range = playlist.get_entries_in_range(0, 10);
println!("First 11 videos: {}", range.len());
Ok(())
}Β§π Advanced Features
Β§π Proxy Support
The library supports HTTP, HTTPS, and SOCKS5 proxies for both yt-dlp and reqwest downloads:
use yt_dlp::Youtube;
use yt_dlp::client::proxy::{ProxyConfig, ProxyType};
use yt_dlp::client::deps::Libraries;
use std::path::PathBuf;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let libraries = Libraries::new(
libraries_dir.join("yt-dlp"),
libraries_dir.join("ffmpeg")
);
// Configure proxy with authentication
let proxy = ProxyConfig::new(ProxyType::Http, "http://proxy.example.com:8080")
.with_auth("username", "password")
.with_no_proxy(vec!["localhost".to_string(), "127.0.0.1".to_string()]);
// Build Youtube client with proxy
let youtube = Youtube::builder(libraries, output_dir)
.with_proxy(proxy)
.build()
.await?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
let video = youtube.fetch_video_infos(url).await?;
// All downloads (video, audio, thumbnails) will use the proxy
youtube.download_video(&video, "video.mp4").await?;
Ok(())
}Supported proxy types:
- HTTP/HTTPS: Standard HTTP proxies
- SOCKS5: SOCKS5 proxies for more flexibility
- Authentication: Username/password authentication
- No-proxy list: Exclude specific domains from proxying
Β§βοΈ Partial Download
Download only specific parts of a video using time ranges or chapters:
Β§Time-based partial download
use yt_dlp::Youtube;
use yt_dlp::download::partial::PartialRange;
use yt_dlp::client::deps::Libraries;
use std::path::PathBuf;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let libraries = Libraries::new(
libraries_dir.join("yt-dlp"),
libraries_dir.join("ffmpeg")
);
let youtube = Youtube::builder(libraries, output_dir).build().await?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
let video = youtube.fetch_video_infos(url).await?;
// Download from 1:30 to 5:00 (90 to 300 seconds)
let range = PartialRange::time_range(90.0, 300.0);
youtube.download_video_partial(&video, &range, "partial.mp4").await?;
Ok(())
}Β§Chapter-based partial download
use yt_dlp::Youtube;
use yt_dlp::download::partial::PartialRange;
use yt_dlp::client::deps::Libraries;
use std::path::PathBuf;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let libraries = Libraries::new(
libraries_dir.join("yt-dlp"),
libraries_dir.join("ffmpeg")
);
let youtube = Youtube::builder(libraries, output_dir).build().await?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
let video = youtube.fetch_video_infos(url).await?;
// Download a single chapter (0-based index)
let single_chapter = PartialRange::single_chapter(2);
youtube.download_video_partial(&video, &single_chapter, "chapter2.mp4").await?;
// Download chapters 2 through 5
let chapter_range = PartialRange::chapter_range(2, 5);
youtube.download_video_partial(&video, &chapter_range, "chapters2-5.mp4").await?;
Ok(())
}Β§Using DownloadBuilder for partial downloads
use yt_dlp::Youtube;
use yt_dlp::client::deps::Libraries;
use std::path::PathBuf;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let libraries = Libraries::new(
libraries_dir.join("yt-dlp"),
libraries_dir.join("ffmpeg")
);
let youtube = Youtube::builder(libraries, output_dir).build().await?;
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
// Download with fluent API
youtube.download(url.clone(), "partial.mp4")
.time_range(90.0, 300.0) // Download from 1:30 to 5:00
.execute()
.await?;
Ok(())
}Implementation details:
- Uses
yt-dlpβs--download-sectionsfeature as primary method - Automatically falls back to FFmpeg extraction if
yt-dlpfails - Chapters are automatically converted to time ranges
- Works with all video formats
Β§π¨ Post-Processing Options
Apply advanced post-processing to videos using FFmpeg:
Β§Basic codec conversion
use yt_dlp::Youtube;
use yt_dlp::download::postprocess::{PostProcessConfig, VideoCodec, AudioCodec};
use yt_dlp::client::deps::Libraries;
use std::path::PathBuf;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let libraries = Libraries::new(
libraries_dir.join("yt-dlp"),
libraries_dir.join("ffmpeg")
);
let youtube = Youtube::builder(libraries, output_dir).build().await?;
// Configure post-processing
let config = PostProcessConfig::new()
.with_video_codec(VideoCodec::H264)
.with_audio_codec(AudioCodec::AAC)
.with_video_bitrate("2M")
.with_audio_bitrate("192k");
// Apply to existing video
youtube.postprocess_video("input.mp4", "output.mp4", config).await?;
Ok(())
}Β§Advanced post-processing with filters
use yt_dlp::Youtube;
use yt_dlp::download::postprocess::{
PostProcessConfig, VideoCodec, Resolution, EncodingPreset,
FfmpegFilter, WatermarkPosition
};
use yt_dlp::client::deps::Libraries;
use std::path::PathBuf;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let libraries = Libraries::new(
libraries_dir.join("yt-dlp"),
libraries_dir.join("ffmpeg")
);
let youtube = Youtube::builder(libraries, output_dir).build().await?;
// Advanced configuration with filters
let config = PostProcessConfig::new()
.with_video_codec(VideoCodec::H265)
.with_resolution(Resolution::HD)
.with_framerate(30)
.with_preset(EncodingPreset::Medium)
.add_filter(FfmpegFilter::Brightness { value: 0.1 })
.add_filter(FfmpegFilter::Contrast { value: 1.2 })
.add_filter(FfmpegFilter::Watermark {
path: "logo.png".to_string(),
position: WatermarkPosition::BottomRight,
});
youtube.postprocess_video("input.mp4", "processed.mp4", config).await?;
Ok(())
}Β§Available post-processing options
Video Codecs:
- H.264 (libx264) - Most compatible
- H.265 (libx265) - Better compression
- VP9 (libvpx-vp9) - Open format
- AV1 (libaom-av1) - Next-gen codec
- Copy - No re-encoding
Audio Codecs:
- AAC - High quality, widely supported
- MP3 (libmp3lame) - Universal compatibility
- Opus - Best quality/size ratio
- Vorbis - Open format
- Copy - No re-encoding
Resolutions:
- UHD8K (7680x4320)
- UHD4K (3840x2160)
- QHD (2560x1440)
- FullHD (1920x1080)
- HD (1280x720)
- SD (854x480)
- Low (640x360)
- Custom { width, height }
Encoding Presets:
- UltraFast, SuperFast, VeryFast, Fast
- Medium (balanced)
- Slow, Slower, VerySlow (best quality)
Video Filters:
- Crop:
Crop { width, height, x, y } - Rotate:
Rotate { angle }(in degrees) - Watermark:
Watermark { path, position } - Brightness:
Brightness { value }(-1.0 to 1.0) - Contrast:
Contrast { value }(0.0 to 4.0) - Saturation:
Saturation { value }(0.0 to 3.0) - Blur:
Blur { radius } - FlipHorizontal, FlipVertical
- Denoise, Sharpen
- Custom:
Custom { filter }- Any FFmpeg filter string
Β§β‘ Speed Profiles
The library includes an intelligent speed optimization system that automatically configures download parameters based on your internet connection speed. This feature significantly improves download performance for both individual videos and playlists.
Β§Available Speed Profiles
Three pre-configured profiles are available:
π’ Conservative (for connections < 50 Mbps)
- 3 concurrent downloads
- 4-8 parallel segments per file
- 5 MB segment size
- 10 MB buffer
- 2 concurrent playlist downloads
- Best for: Standard internet, avoiding network congestion, limited bandwidth
βοΈ Balanced (for connections 50-500 Mbps) - Default
- 5 concurrent downloads
- 8-16 parallel segments per file
- 8 MB segment size
- 20 MB buffer
- 3 concurrent playlist downloads
- Best for: Most modern internet connections, general use
π Aggressive (for connections > 500 Mbps)
- 8 concurrent downloads
- 16-32 parallel segments per file
- 10 MB segment size
- 30 MB buffer
- 5 concurrent playlist downloads
- Best for: High-bandwidth connections (fiber, gigabit), maximum speed
Β§Using Speed Profiles
use yt_dlp::{Youtube, YoutubeBuilder};
use yt_dlp::download::SpeedProfile;
use yt_dlp::client::deps::Libraries;
use std::path::PathBuf;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let libraries = Libraries::new(
libraries_dir.join("yt-dlp"),
libraries_dir.join("ffmpeg")
);
// Use the Aggressive profile for maximum speed
let youtube = YoutubeBuilder::new(libraries, output_dir)
.with_speed_profile(SpeedProfile::Aggressive)
.build()
.await?;
// All downloads will now use optimized settings
let url = String::from("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
youtube.download_video_from_url(url, "video.mp4").await?;
Ok(())
}Β§Manual Configuration (Advanced)
You can also manually configure download parameters if you need fine-grained control:
use yt_dlp::{Youtube, YoutubeBuilder};
use yt_dlp::download::ManagerConfig;
use yt_dlp::client::deps::Libraries;
use std::path::PathBuf;
#[tokio::main]
pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
let libraries_dir = PathBuf::from("libs");
let output_dir = PathBuf::from("output");
let libraries = Libraries::new(
libraries_dir.join("yt-dlp"),
libraries_dir.join("ffmpeg")
);
// Create a custom configuration
let config = ManagerConfig::default()
.with_max_concurrent_downloads(10) // 10 concurrent downloads
.with_segment_size(15 * 1024 * 1024) // 15 MB segments
.with_parallel_segments(16); // 16 parallel segments
let youtube = YoutubeBuilder::new(libraries, output_dir)
.with_download_manager_config(config)
.build()
.await?;
Ok(())
}Β§Performance Improvements
The speed optimization system includes several advanced features:
- HTTP/2 Support: Automatically enabled for better connection multiplexing
- Parallel Playlist Downloads: Playlists are downloaded in parallel by default (previously sequential)
- Dynamic Segment Allocation: Automatically adjusts the number of parallel segments based on file size
- Connection Pooling: Reuses HTTP connections for better performance
- Intelligent Buffering: Optimized buffer sizes based on your profile
Expected Performance Gains:
For individual videos:
- Conservative: ~30% faster (HTTP/2)
- Balanced: ~100% faster (2x segments + HTTP/2)
- Aggressive: ~200% faster (3x segments + HTTP/2)
For playlists:
- Conservative: ~150% faster (2 videos in parallel)
- Balanced: ~200% faster (3 videos in parallel)
- Aggressive: ~400% faster (5 videos in parallel)
Note: Actual performance gains depend on your internet speed, server limitations, and network conditions.
Β§π‘Features coming soon
- Live streams serving, through a local server
-
Live streams recording, with
ffmpegorreqwest - Notifications and alerts on download events
- Webhooks, Rust hooks and callbacks on download events, errors and progress
- Support all extractors from yt-dlp
- Statistics and analytics on downloads and fetches
- Benchmark pure yt-dlp vs this library performance
Re-exportsΒ§
pub use metadata::PlaylistMetadata;pub use model::utils::AllTraits;pub use model::utils::CommonTraits;pub use client::DownloadBuilder;pub use client::YoutubeBuilder;pub use download::DownloadManager;pub use download::DownloadPriority;pub use download::DownloadStatus;
ModulesΒ§
- cache
- Cache module for storing video metadata and downloaded files.
- client
- Youtube client module.
- download
- Download orchestration module.
- error
- Error types with enhanced context and structured information.
- executor
- Command execution module.
- macros
- Convenience macros for common operations.
- metadata
- Metadata management module for downloaded files.
- model
- The models used to represent the data fetched by βyt-dlpβ.
- prelude
- Prelude module for convenient imports.
- utils
- Utility functions and types used throughout the application.
MacrosΒ§
- download_
audio - Quick audio download macro.
- download_
video - Quick video download macro.
- install_
libraries - Create a Libraries instance with automatic binary installation.
- ternary
- A macro to mimic the ternary operator in Rust.
- youtube
- Create a Youtube instance with sensible defaults.
- ytdlp_
args - Configure yt-dlp arguments easily.
StructsΒ§
- Youtube
- A YouTube video fetcher that uses yt-dlp to fetch video information and download it.