Crate yt_dlp

Expand description

🎬️ A Rust library (with auto dependencies installation) for video downloading from 1,800+ websites

This library is a Rust asynchronous wrapper around the yt-dlp command line tool, a feature-rich audio/video downloader supporting YouTube, Vimeo, TikTok, Instagram, Twitter, and 1,800+ other sites.

The crate is designed to download audio and video from various websites. You don't need to care about dependencies, yt-dlp and ffmpeg will be downloaded automatically.

⚠️ The project is still in development, so if you encounter any bugs or have any feature requests, please open an issue or a discussion.

Report a Bug · Request a Feature · Ask a Question

Statistics

§💭️ 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.10"

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 caching
tracing (enabled by default) — Enables profiling with the tracing crate. When this feature is enabled, the library will output span events at log levels trace and debug, depending on the importance of the called function.
rustls - Enables the rustls-tls feature in the reqwest crate. This enables building the application without openssl or other system sourced SSL libraries.
hooks - Enables Rust hooks and callbacks for download events. Allows registering async functions that will be called when events occur.
webhooks - Enables HTTP webhooks delivery for download events. Allows sending events to external HTTP endpoints with retry logic.

§📝 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.10", features = ["tracing"], default-features = false }

§📖 Documentation

The documentation is available on docs.rs.

§🏗️ Multi-Extractor Architecture

This library now supports downloading from 1,800+ websites through a flexible extractor system:

Downloader (formerly Youtube) - Universal client supporting all sites via the Generic extractor
extractor::Youtube - Highly optimized YouTube extractor with platform-specific features:
- Player client selection (Android, iOS, Web, TvEmbedded) for bypassing restrictions
- Format presets (Best, Premium, High, Medium, Low, AudioOnly, ModernCodecs)
- YouTube-specific methods: search(), fetch_channel(), fetch_user(), fetch_playlist_paginated()
extractor::Generic - Universal extractor for all other sites with authentication support

§Usage Patterns

For YouTube with optimizations:

use yt_dlp::Downloader;
use yt_dlp::client::deps::Libraries;

let libraries = Libraries::new("libs/yt-dlp", "libs/ffmpeg");
let downloader = Downloader::for_youtube(libraries, "output").await?;

// Access YouTube-specific features
if let Some(youtube) = downloader.youtube_extractor() {
    let results = youtube.search("rust programming", 10).await?;
    let channel = youtube.fetch_channel("UCaYhcUwRBNscFNUKTjgPFiA").await?;
}

For any website (YouTube, Vimeo, TikTok, etc.):

use yt_dlp::Downloader;
use yt_dlp::client::deps::Libraries;

let libraries = Libraries::new("libs/yt-dlp", "libs/ffmpeg");
let downloader = Downloader::new(libraries, "output").await?;

// Works with any supported site
let video = downloader.download_video_from_url(
    "https://vimeo.com/123456789",
    "output.mp4"
).await?;

Backwards compatibility: The library maintains backwards compatibility by re-exporting Downloader as Youtube in the prelude, so existing code continues to work.

§📚 Examples

📦 Installing the yt-dlp and ffmpeg binaries:

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-dlp binary 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 ffmpeg binary 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-dlp binary:

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(())
}

📁 Downloading a video to a specific path (ignoring output_dir):

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");
    
    // Download to an absolute path — the file is written directly to the given path,
    // bypassing the configured output_dir.
    let path = PathBuf::from("/Users/me/Videos/my-video.mp4");
    let video_path = fetcher.download_video_from_url_to_path(url, &path).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 available
VideoQuality::High - Targets 1080p resolution
VideoQuality::Medium - Targets 720p resolution
VideoQuality::Low - Targets 480p resolution
VideoQuality::Worst - Selects the lowest quality video format available
VideoQuality::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 available
AudioQuality::High - Targets 192kbps bitrate
AudioQuality::Medium - Targets 128kbps bitrate
AudioQuality::Low - Targets 96kbps bitrate
AudioQuality::Worst - Selects the lowest quality audio format available
AudioQuality::CustomBitrate(u32) - Targets a specific bitrate in kbps (e.g., CustomBitrate(256) for 256kbps)

§🎞️ Codec Preferences

§📹 Video Codecs

VideoCodecPreference::VP9 - Prefer VP9 codec
VideoCodecPreference::AVC1 - Prefer AVC1/H.264 codec
VideoCodecPreference::AV1 - Prefer AV01/AV1 codec
VideoCodecPreference::Custom(String) - Prefer a custom codec
VideoCodecPreference::Any - No codec preference

§🔊 Audio Codecs

AudioCodecPreference::Opus - Prefer Opus codec
AudioCodecPreference::AAC - Prefer AAC codec
AudioCodecPreference::MP3 - Prefer MP3 codec
AudioCodecPreference::Custom(String) - Prefer a custom codec
AudioCodecPreference::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-sections feature as primary method
Automatically falls back to FFmpeg extraction if yt-dlp fails
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.

§🔔 Events, Hooks & Webhooks

The library provides a comprehensive event system to monitor download lifecycle and react to events through Rust hooks or HTTP webhooks.

§Event System

All download operations emit events that you can subscribe to:

use yt_dlp::Youtube;
use tokio_stream::StreamExt;

let youtube = Youtube::builder(libraries, "output").build().await?;
let mut stream = youtube.event_stream();

while let Some(Ok(event)) = stream.next().await {
    println!("Event: {} - {:?}", event.event_type(), event);
}

§Available Events

The library emits 22 different event types covering the entire download lifecycle:

Download Lifecycle:

VideoFetched - Video metadata retrieved
DownloadQueued - Download added to queue
DownloadStarted - Download begins
DownloadProgress - Progress updates (bytes downloaded, speed, ETA)
DownloadPaused / DownloadResumed - Pause/resume events
DownloadCompleted - Download finished successfully
DownloadFailed - Download failed with error
DownloadCanceled - Download was canceled

Format & Metadata:

FormatSelected - Video/audio format chosen
MetadataApplied - Metadata tags written
ChaptersEmbedded - Chapters added to file

Post-Processing:

PostProcessStarted / PostProcessCompleted / PostProcessFailed - FFmpeg operations

Playlist Operations:

PlaylistFetched - Playlist metadata retrieved
PlaylistItemStarted / PlaylistItemCompleted / PlaylistItemFailed - Per-item events
PlaylistCompleted - Entire playlist finished

Advanced:

SegmentStarted / SegmentCompleted - Parallel segment downloads

§Rust Hooks (Feature: `hooks`)

Register async functions to be called when events occur:

[dependencies]
yt-dlp = { version = "1.4.3", features = ["hooks"] }

use yt_dlp::events::{EventHook, EventFilter, DownloadEvent, HookResult};
use async_trait::async_trait;

struct MyHook;

#[async_trait]
impl EventHook for MyHook {
    async fn on_event(&self, event: &DownloadEvent) -> HookResult {
        match event {
            DownloadEvent::DownloadCompleted { download_id, output_path, .. } => {
                println!("Download {} completed: {:?}", download_id, output_path);
            }
            DownloadEvent::DownloadFailed { download_id, error, .. } => {
                eprintln!("Download {} failed: {}", download_id, error);
            }
            _ => {}
        }
        Ok(())
    }

    fn filter(&self) -> EventFilter {
        // Only receive terminal events (completed, failed, canceled)
        EventFilter::only_terminal()
    }
}

let mut youtube = Youtube::builder(libraries, "output").build().await?;
youtube.register_hook(MyHook).await;

Hook Features:

Async execution
Event filtering (by type, download ID, custom predicates)
Parallel or sequential execution
Automatic timeout protection (30s)
Error isolation (hook failures don’t stop downloads)

Event Filters:

// Only completed downloads
EventFilter::only_completed()

// Only failed downloads
EventFilter::only_failed()

// Progress updates only
EventFilter::only_progress()

// Exclude progress events
EventFilter::all().exclude_progress()

// Specific download ID
EventFilter::download_id(123)

// Terminal events (completed, failed, canceled)
EventFilter::only_terminal()

// Chain filters
EventFilter::download_id(123).and_then(|e| e.is_terminal())

// Custom filter
EventFilter::all().and_then(|event| {
    // Your custom logic
    true
})

§HTTP Webhooks (Feature: `webhooks`)

Send events to external HTTP endpoints with automatic retry:

[dependencies]
yt-dlp = { version = "1.4.3", features = ["webhooks"] }

use yt_dlp::events::{WebhookConfig, WebhookMethod, EventFilter};

let webhook = WebhookConfig::new("https://example.com/webhook")
    .with_method(WebhookMethod::Post)
    .with_header("Authorization", "Bearer your-token")
    .with_filter(EventFilter::only_completed())
    .with_timeout(Duration::from_secs(10));

let mut youtube = Youtube::builder(libraries, "output").build().await?;
youtube.register_webhook(webhook).await;

Webhook Features:

HTTP POST/PUT/PATCH methods
Custom headers (authentication, etc.)
Event filtering (same as hooks)
Automatic retry with exponential backoff (3 attempts by default)
Configurable timeouts
JSON payload with event data
Environment variable configuration

Environment Variables:

export YTDLP_WEBHOOK_URL="https://example.com/webhook"
export YTDLP_WEBHOOK_METHOD="POST"  # Optional, default: POST
export YTDLP_WEBHOOK_TIMEOUT="10"   # Optional, default: 10 seconds

// Load webhook from environment variables
if let Some(webhook) = WebhookConfig::from_env() {
    youtube.register_webhook(webhook).await;
}

Webhook Payload:

{
  "event_type": "download_completed",
  "download_id": 123,
  "timestamp": "2025-01-21T10:30:00Z",
  "data": {
    "download_id": 123,
    "output_path": "/path/to/video.mp4",
    "duration": 45.2,
    "total_bytes": 104857600
  }
}

Retry Strategy:

use yt_dlp::events::RetryStrategy;

// Exponential backoff (default)
let strategy = RetryStrategy::exponential(
    3,                              // max attempts
    Duration::from_secs(1),         // initial delay
    Duration::from_secs(30)         // max delay
);

// Linear backoff
let strategy = RetryStrategy::linear(
    3,                              // max attempts
    Duration::from_secs(5)          // fixed delay
);

// No retries
let strategy = RetryStrategy::none();

§Combining Features

Use both hooks and webhooks together:

use yt_dlp::Youtube;
use yt_dlp::events::{EventHook, WebhookConfig, EventFilter};

let mut youtube = Youtube::builder(libraries, "output").build().await?;

// Register Rust hook for immediate in-process handling
youtube.register_hook(MyLocalHook).await;

// Register webhook for external notifications
let webhook = WebhookConfig::new("https://example.com/webhook")
    .with_filter(EventFilter::only_completed());
youtube.register_webhook(webhook).await;

// Start downloads - both hooks and webhooks will receive events
let video = youtube.fetch_video_infos("https://youtube.com/watch?v=...").await?;
youtube.download_video(&video, "video.mp4").await?;

§🌍 Multi-Site Support

This library supports all 1,800+ extractors from yt-dlp!

While the examples focus on YouTube (the most common use case), the library works seamlessly with any site supported by yt-dlp. Simply pass the URL - yt-dlp automatically detects the correct extractor.

§Supported Sites Include:

Video platforms: YouTube, Vimeo, Dailymotion, Twitch
Social media: Instagram, TikTok, Twitter/X, Facebook
Streaming services: Netflix, Disney+, Crunchyroll (may require authentication)
Music platforms: Spotify, SoundCloud, Bandcamp
News outlets: CNN, BBC, Fox News
And 1,800+ more…

For the complete list, see yt-dlp’s supported sites.

§Examples

Vimeo:

let url = "https://vimeo.com/148751763".to_string();
let video = fetcher.fetch_video_infos(url).await?;
fetcher.download_video(&video, "vimeo-video.mp4").await?;

TikTok:

let url = "https://www.tiktok.com/@user/video/123".to_string();
let video = fetcher.fetch_video_infos(url).await?;
fetcher.download_video(&video, "tiktok-video.mp4").await?;

Instagram:

// Note: May require cookies for authentication
let url = "https://www.instagram.com/p/ABC123/".to_string();
let video = fetcher.fetch_video_infos(url).await?;

Check which extractor handles a URL:

let extractor = fetcher.detect_extractor("https://vimeo.com/123").await?;
println!("This URL uses the '{}' extractor", extractor);

For detailed documentation, examples, and authentication instructions, see the extractors module documentation.

§💡Features coming soon

Live streams serving, through a local server
Live streams recording, with ffmpeg or reqwest
Support all extractors from yt-dlp ✅ Implemented!
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: Downloader client module.
download: Download orchestration module.
error: Error types with enhanced context and structured information.
events: Event system for download lifecycle notifications
executor: Command execution module.
extractor: Video extractor system for multi-site support.
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.
simple_hook: Helper macro for creating simple hooks from closures
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§

Downloader: Universal video downloader supporting 1,800+ sites via yt-dlp.

Crate yt_dlp

Crate yt_dlp Copy item path

🎬️ A Rust library (with auto dependencies installation) for video downloading from 1,800+ websites

§💭️ Why using external Python app ?

§📥 How to get it

§🔌 Optional features

§📝 Profiling with tracing (enabled by default):

§📖 Documentation

§🏗️ Multi-Extractor Architecture

§Usage Patterns

§📚 Examples

§🎛️ Format Selection

§🎬 Video Quality Options

§🎵 Audio Quality Options

§🎞️ Codec Preferences

§📹 Video Codecs

§🔊 Audio Codecs

§🧪 Example: Downloading with Quality and Codec Preferences

§📋 Metadata

§🧠 Intelligent Metadata Management

§📖 Chapters

§🔥 Heatmap

§📝 Subtitles

§📂 Playlists

§🚀 Advanced Features

§🔐 Proxy Support

§✂️ Partial Download

§Time-based partial download

§Chapter-based partial download

§Using DownloadBuilder for partial downloads

§🎨 Post-Processing Options

§Basic codec conversion

§Advanced post-processing with filters

§Available post-processing options

§⚡ Speed Profiles

§Available Speed Profiles

§Using Speed Profiles

§Manual Configuration (Advanced)

§Performance Improvements

§🔔 Events, Hooks & Webhooks

§Event System

§Available Events

§Rust Hooks (Feature: hooks)

§HTTP Webhooks (Feature: webhooks)

§Combining Features

§🌍 Multi-Site Support

§Supported Sites Include:

§Examples

§💡Features coming soon

Re-exports§

Modules§

Macros§

Structs§

Crate yt_dlp

§📝 Profiling with `tracing` (enabled by default):

§Rust Hooks (Feature: `hooks`)

§HTTP Webhooks (Feature: `webhooks`)