yt-dlp 2.7.2

🎬️ A Rust library (with auto dependencies installation) for Youtube downloading
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
use std::fmt;
use std::path::PathBuf;
use std::time::Duration;

use crate::download::DownloadPriority;
use crate::model::Video;
use crate::model::chapter::Chapter;
use crate::model::format::Format;
use crate::model::playlist::Playlist;

/// The method used for live recording.
#[cfg(feature = "live-recording")]
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize)]
pub enum RecordingMethod {
    /// Pure Rust recording via reqwest HLS segment fetching
    Native,
    /// FFmpeg-based recording (fallback)
    Fallback,
}

/// Represents all possible events that can occur during download operations
#[derive(Debug, Clone, serde::Serialize)]
#[allow(clippy::large_enum_variant)]
pub enum DownloadEvent {
    /// Video metadata has been fetched from the URL
    VideoFetched {
        url: String,
        video: Box<Video>,
        duration: Duration,
    },

    /// Video metadata fetch failed
    VideoFetchFailed {
        url: String,
        error: String,
        duration: Duration,
    },

    /// Download has been queued in the download manager
    DownloadQueued {
        download_id: u64,
        url: String,
        priority: DownloadPriority,
        output_path: PathBuf,
    },

    /// Download has started processing
    DownloadStarted {
        download_id: u64,
        url: String,
        total_bytes: u64,
        format_id: Option<String>,
    },

    /// Download progress update
    DownloadProgress {
        download_id: u64,
        downloaded_bytes: u64,
        total_bytes: u64,
        speed_bytes_per_sec: f64,
        eta_seconds: Option<u64>,
    },

    /// Download has been paused
    DownloadPaused { download_id: u64, reason: String },

    /// Download has been resumed
    DownloadResumed { download_id: u64 },

    /// Download completed successfully
    DownloadCompleted {
        download_id: u64,
        url: String,
        output_path: PathBuf,
        duration: Duration,
        total_bytes: u64,
    },

    /// Download failed with error
    DownloadFailed {
        download_id: u64,
        url: String,
        error: String,
        retry_count: u32,
    },

    /// Download was canceled
    DownloadCanceled { download_id: u64, reason: String },

    /// Format has been selected for download
    FormatSelected {
        video_id: String,
        format: Format,
        quality: String,
    },

    /// Metadata has been applied to a file
    MetadataApplied { path: PathBuf, metadata_type: MetadataType },

    /// Chapters have been embedded into a file
    ChaptersEmbedded { path: PathBuf, chapters: Vec<Chapter> },

    /// Post-processing has started
    PostProcessStarted {
        input_path: PathBuf,
        operation: PostProcessOperation,
    },

    /// Post-processing completed successfully
    PostProcessCompleted {
        input_path: PathBuf,
        output_path: PathBuf,
        operation: PostProcessOperation,
        duration: Duration,
    },

    /// Post-processing failed
    PostProcessFailed {
        input_path: PathBuf,
        operation: PostProcessOperation,
        error: String,
    },

    /// Playlist metadata has been fetched
    PlaylistFetched {
        url: String,
        playlist: Playlist,
        duration: Duration,
    },

    /// Playlist metadata fetch failed
    PlaylistFetchFailed {
        url: String,
        error: String,
        duration: Duration,
    },

    /// Playlist item download has started
    PlaylistItemStarted {
        playlist_id: String,
        index: usize,
        total: usize,
        video_id: String,
    },

    /// Playlist item download completed
    PlaylistItemCompleted {
        playlist_id: String,
        index: usize,
        total: usize,
        video_id: String,
        output_path: PathBuf,
    },

    /// Playlist item download failed
    PlaylistItemFailed {
        playlist_id: String,
        index: usize,
        total: usize,
        video_id: String,
        error: String,
    },

    /// Entire playlist download completed
    PlaylistCompleted {
        playlist_id: String,
        total_items: usize,
        successful: usize,
        failed: usize,
        duration: Duration,
    },

    /// Segment download started (for parallel downloads)
    SegmentStarted {
        download_id: u64,
        segment_index: usize,
        total_segments: usize,
    },

    /// Segment download completed
    SegmentCompleted {
        download_id: u64,
        segment_index: usize,
        total_segments: usize,
        bytes: u64,
    },

    /// Live recording has started
    #[cfg(feature = "live-recording")]
    LiveRecordingStarted {
        video_id: String,
        url: String,
        quality: String,
        method: RecordingMethod,
    },

    /// Live recording progress update
    #[cfg(feature = "live-recording")]
    LiveRecordingProgress {
        video_id: String,
        elapsed: Duration,
        bytes_written: u64,
        segments: u64,
        bitrate_bps: f64,
    },

    /// Live recording stopped (graceful)
    #[cfg(feature = "live-recording")]
    LiveRecordingStopped {
        video_id: String,
        reason: String,
        output_path: PathBuf,
        total_bytes: u64,
        total_duration: Duration,
    },

    /// Live recording failed
    #[cfg(feature = "live-recording")]
    LiveRecordingFailed { video_id: String, error: String },

    /// Live fragment streaming started
    #[cfg(feature = "live-streaming")]
    LiveStreamStarted {
        video_id: String,
        url: String,
        quality: String,
    },

    /// Live fragment streaming progress update
    #[cfg(feature = "live-streaming")]
    LiveStreamProgress {
        video_id: String,
        elapsed: Duration,
        bytes_received: u64,
        segments: u64,
        bitrate_bps: f64,
    },

    /// Live fragment streaming stopped
    #[cfg(feature = "live-streaming")]
    LiveStreamStopped {
        video_id: String,
        reason: String,
        total_bytes: u64,
        total_duration: Duration,
    },

    /// Live fragment streaming failed
    #[cfg(feature = "live-streaming")]
    LiveStreamFailed { video_id: String, error: String },
}

/// Types of metadata that can be applied
#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq, serde::Serialize)]
pub enum MetadataType {
    /// MP3 ID3 tags
    Mp3,
    /// MP4/M4A metadata
    Mp4,
    /// FFmpeg metadata
    Ffmpeg,
}

impl fmt::Display for MetadataType {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Mp3 => f.write_str("Mp3"),
            Self::Mp4 => f.write_str("Mp4"),
            Self::Ffmpeg => f.write_str("Ffmpeg"),
        }
    }
}

/// Post-processing operations
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize)]
pub enum PostProcessOperation {
    /// Combining audio and video streams
    CombineStreams { audio_path: PathBuf, video_path: PathBuf },
    /// Converting audio format
    ConvertAudio { target_format: String },
    /// Embedding subtitles
    EmbedSubtitles { subtitle_path: PathBuf },
    /// Embedding thumbnail
    EmbedThumbnail { thumbnail_path: PathBuf },
    /// Custom FFmpeg operation
    Custom { description: String },
    /// Splitting a video into individual chapter files
    SplitChapters { source_path: PathBuf, chapter_count: usize },
}

impl fmt::Display for PostProcessOperation {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::CombineStreams { .. } => f.write_str("CombineStreams"),
            Self::ConvertAudio { target_format } => {
                write!(f, "ConvertAudio(format={})", target_format)
            }
            Self::EmbedSubtitles { .. } => f.write_str("EmbedSubtitles"),
            Self::EmbedThumbnail { .. } => f.write_str("EmbedThumbnail"),
            Self::Custom { description } => write!(f, "Custom(description={})", description),
            Self::SplitChapters { chapter_count, .. } => write!(f, "SplitChapters(chapters={})", chapter_count),
        }
    }
}

#[cfg(feature = "live-recording")]
impl fmt::Display for RecordingMethod {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Native => f.write_str("Native"),
            Self::Fallback => f.write_str("Fallback"),
        }
    }
}

impl DownloadEvent {
    /// Returns the download ID if this event is associated with a specific download
    pub fn download_id(&self) -> Option<u64> {
        match self {
            Self::DownloadQueued { download_id, .. }
            | Self::DownloadStarted { download_id, .. }
            | Self::DownloadProgress { download_id, .. }
            | Self::DownloadPaused { download_id, .. }
            | Self::DownloadResumed { download_id, .. }
            | Self::DownloadCompleted { download_id, .. }
            | Self::DownloadFailed { download_id, .. }
            | Self::DownloadCanceled { download_id, .. }
            | Self::SegmentStarted { download_id, .. }
            | Self::SegmentCompleted { download_id, .. } => Some(*download_id),
            _ => None,
        }
    }

    /// Returns true if this is a terminal event (download completed, failed, or canceled)
    pub fn is_terminal(&self) -> bool {
        matches!(
            self,
            Self::DownloadCompleted { .. } | Self::DownloadFailed { .. } | Self::DownloadCanceled { .. }
        )
    }

    /// Returns true if this is a progress event
    pub fn is_progress(&self) -> bool {
        match self {
            Self::DownloadProgress { .. } => true,
            #[cfg(feature = "live-recording")]
            Self::LiveRecordingProgress { .. } => true,
            #[cfg(feature = "live-streaming")]
            Self::LiveStreamProgress { .. } => true,
            _ => false,
        }
    }

    /// Returns a human-readable event type name
    pub fn event_type(&self) -> &'static str {
        match self {
            Self::VideoFetched { .. } => "video_fetched",
            Self::VideoFetchFailed { .. } => "video_fetch_failed",
            Self::DownloadQueued { .. } => "download_queued",
            Self::DownloadStarted { .. } => "download_started",
            Self::DownloadProgress { .. } => "download_progress",
            Self::DownloadPaused { .. } => "download_paused",
            Self::DownloadResumed { .. } => "download_resumed",
            Self::DownloadCompleted { .. } => "download_completed",
            Self::DownloadFailed { .. } => "download_failed",
            Self::DownloadCanceled { .. } => "download_canceled",
            Self::FormatSelected { .. } => "format_selected",
            Self::MetadataApplied { .. } => "metadata_applied",
            Self::ChaptersEmbedded { .. } => "chapters_embedded",
            Self::PostProcessStarted { .. } => "post_process_started",
            Self::PostProcessCompleted { .. } => "post_process_completed",
            Self::PostProcessFailed { .. } => "post_process_failed",
            Self::PlaylistFetched { .. } => "playlist_fetched",
            Self::PlaylistFetchFailed { .. } => "playlist_fetch_failed",
            Self::PlaylistItemStarted { .. } => "playlist_item_started",
            Self::PlaylistItemCompleted { .. } => "playlist_item_completed",
            Self::PlaylistItemFailed { .. } => "playlist_item_failed",
            Self::PlaylistCompleted { .. } => "playlist_completed",
            Self::SegmentStarted { .. } => "segment_started",
            Self::SegmentCompleted { .. } => "segment_completed",
            #[cfg(feature = "live-recording")]
            Self::LiveRecordingStarted { .. } => "live_recording_started",
            #[cfg(feature = "live-recording")]
            Self::LiveRecordingProgress { .. } => "live_recording_progress",
            #[cfg(feature = "live-recording")]
            Self::LiveRecordingStopped { .. } => "live_recording_stopped",
            #[cfg(feature = "live-recording")]
            Self::LiveRecordingFailed { .. } => "live_recording_failed",
            #[cfg(feature = "live-streaming")]
            Self::LiveStreamStarted { .. } => "live_stream_started",
            #[cfg(feature = "live-streaming")]
            Self::LiveStreamProgress { .. } => "live_stream_progress",
            #[cfg(feature = "live-streaming")]
            Self::LiveStreamStopped { .. } => "live_stream_stopped",
            #[cfg(feature = "live-streaming")]
            Self::LiveStreamFailed { .. } => "live_stream_failed",
        }
    }
}

impl fmt::Display for DownloadEvent {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::DownloadProgress {
                download_id,
                downloaded_bytes,
                total_bytes,
                ..
            } => {
                write!(
                    f,
                    "DownloadProgress(id={}, downloaded={}, total={})",
                    download_id, downloaded_bytes, total_bytes
                )
            }
            _ => {
                let event_type = self.event_type();
                if let Some(id) = self.download_id() {
                    write!(f, "{}(id={})", event_type, id)
                } else {
                    f.write_str(event_type)
                }
            }
        }
    }
}