1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
//! This crate providers ready-made decoders for use with the rust-av ecosystem.
//! Each decoder will output structs from the `v_frame` crate.
//!
//! Only the y4m decoder is enabled by default.
//! Others must be enabled via Cargo features, since they require external dependencies.
use crateFfmpegDecoder;
use crateVapoursynthDecoder;
use HashMap;
use File;
use ;
use Path;
use Frame;
use ;
use Node;
use Environment;
use Decoder as Y4mDecoder;
pub use DecoderError;
pub use Rational32;
pub use v_frame;
const Y4M_EXTENSIONS: & = &;
/// Video metadata and configuration details.
///
/// This struct contains essential information about a video stream that is needed
/// for proper decoding and frame processing. All decoders will populate this
/// information when initialized.
/// A unified video decoder that can handle multiple video formats and sources.
///
/// The `Decoder` provides a consistent interface for decoding video frames from various
/// sources and formats. It automatically selects the most appropriate decoding backend
/// based on the input format and available features.
///
/// ## Supported Formats
///
/// - **Y4M files** (always available): Raw Y4M format files with `.y4m` or `.yuv` extensions
/// - **General video files** (requires `ffmpeg` feature): Most common video formats via FFmpeg
/// - **Advanced video processing** (requires `vapoursynth` feature): Enhanced format support via VapourSynth
///
/// ## Backend Priority
///
/// The decoder automatically selects backends in this order of preference:
/// 1. **Y4M parser** - Used for Y4M files (fastest, lowest overhead)
/// 2. **VapourSynth** - Used when available (best metadata accuracy and seeking)
/// 3. **FFmpeg** - Used as fallback for general video files
///
/// ## Examples
///
/// ```no_run
/// use av_decoders::{from_file, from_stdin};
///
/// // Decode from a file
/// let mut decoder = from_file("video.y4m")?;
/// let details = decoder.get_video_details();
/// println!("Video: {}x{} @ {} fps", details.width, details.height, details.frame_rate);
///
/// // Read frames
/// while let Ok(frame) = decoder.read_video_frame::<u8>() {
/// // Process the frame...
/// }
///
/// // Decode from stdin
/// let mut stdin_decoder = from_stdin()?;
/// let frame = stdin_decoder.read_video_frame::<u8>()?;
/// # Ok::<(), av_decoders::DecoderError>(())
/// ```
/// Creates a new decoder from a file path.
///
/// This method automatically detects the input format and selects the most appropriate
/// decoder backend. It will prioritize Y4M files for performance, then VapourSynth
/// for accuracy, and finally FFmpeg for broad format support.
///
/// # Arguments
///
/// * `input` - A path to the video file. Can be any type that implements `AsRef<Path>`,
/// such as `&str`, `String`, `Path`, or `PathBuf`.
///
/// # Returns
///
/// Returns a `Result` containing:
/// - `Ok(Decoder<BufReader<File>>)` - A successfully initialized decoder
/// - `Err(DecoderError)` - An error if the file cannot be read or decoded
///
/// # Errors
///
/// This method will return an error if:
/// - The file cannot be opened or read (`DecoderError::FileReadError`)
/// - No suitable decoder backend is available (`DecoderError::NoDecoder`)
/// - The file format is not supported or corrupted (`DecoderError::GenericDecodeError`)
/// - Required features are not enabled for the file format
///
/// # Examples
///
/// ```no_run
/// use av_decoders::from_file;
/// use std::path::Path;
///
/// // From string path
/// let decoder = from_file("video.y4m")?;
///
/// // From Path
/// let path = Path::new("video.mp4");
/// let decoder = from_file(path)?;
///
/// // From PathBuf
/// let pathbuf = std::env::current_dir()?.join("video.mkv");
/// let decoder = from_file(pathbuf)?;
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
/// Creates a new decoder from a VapourSynth script.
///
/// This method allows you to create a decoder by providing a VapourSynth script directly
/// as a string, rather than reading from a file. This is useful for dynamic video processing
/// pipelines, custom filtering operations, or when you need to apply VapourSynth's advanced
/// video processing capabilities programmatically.
///
/// VapourSynth scripts can include complex video processing operations, filters, and
/// transformations that are not available through simple file-based decoders. This method
/// provides access to the full power of the VapourSynth ecosystem.
///
/// # Requirements
///
/// This function is only available when the `vapoursynth` feature is enabled.
///
/// # Arguments
///
/// * `script` - A VapourSynth script as a string. The script should define a video node
/// that will be used as the source for decoding. The script must be valid VapourSynth
/// Python code that produces a video clip.
///
/// * `arguments` - Optional script arguments as key-value pairs. These will be passed
/// to the VapourSynth environment and can be accessed within the script using
/// `vs.get_output()` or similar mechanisms. Pass `None` if no arguments are needed.
///
/// # Returns
///
/// Returns a `Result` containing:
/// - `Ok(Decoder<BufReader<File>>)` - A successfully initialized decoder using the script
/// - `Err(DecoderError)` - An error if the script cannot be executed or produces invalid output
///
/// # Errors
///
/// This method will return an error if:
/// - The VapourSynth script contains syntax errors (`DecoderError::GenericDecodeError`)
/// - The script fails to execute or raises exceptions
/// - The script does not produce a valid video output
/// - Required VapourSynth plugins are not available
/// - The VapourSynth environment cannot be initialized
/// - The arguments cannot be set (`DecoderError::GenericDecodeError`)
///
/// # Examples
///
/// ```no_run
/// use av_decoders::from_script;
/// use std::collections::HashMap;
///
/// // Simple script that loads a video file
/// let script = r#"
/// import vapoursynth as vs
/// core = vs.core
/// clip = core.ffms2.Source("input.mkv")
/// clip.set_output()
/// "#;
///
/// let decoder = from_script(script, None)?;
/// let details = decoder.get_video_details();
/// println!("Video: {}x{} @ {} fps", details.width, details.height, details.frame_rate);
///
/// // Script with arguments for dynamic processing
/// let script_with_args = r#"
/// import vapoursynth as vs
/// core = vs.core
///
/// # Get arguments passed from Rust
/// filename = vs.get_output().get("filename", "default.mkv")
/// resize_width = int(vs.get_output().get("width", "1920"))
///
/// clip = core.ffms2.Source(filename)
/// clip = core.resize.Bicubic(clip, width=resize_width, height=clip.height * resize_width // clip.width)
/// clip.set_output()
/// "#;
///
/// let mut arguments = HashMap::new();
/// arguments.insert("filename".to_string(), "video.mp4".to_string());
/// arguments.insert("width".to_string(), "1280".to_string());
///
/// let mut decoder = from_script(script_with_args, Some(arguments))?;
///
/// // Read frames from the processed video
/// while let Ok(frame) = decoder.read_video_frame::<u8>() {
/// // Process the filtered frame...
/// }
/// # Ok::<(), av_decoders::DecoderError>(())
/// ```
///
/// ## Advanced Usage
///
/// VapourSynth scripts can include complex filtering pipelines:
///
/// ```no_run
/// # use av_decoders::from_script;
/// let advanced_script = r#"
/// import vapoursynth as vs
/// core = vs.core
///
/// # Load source
/// clip = core.ffms2.Source("input.mkv")
///
/// # Apply denoising
/// clip = core.bm3d.BM3D(clip, sigma=3.0)
///
/// # Upscale using AI
/// clip = core.waifu2x.Waifu2x(clip, noise=1, scale=2)
///
/// # Color correction
/// clip = core.std.Levels(clip, min_in=16, max_in=235, min_out=0, max_out=255)
///
/// clip.set_output()
/// "#;
///
/// let decoder = from_script(advanced_script, None)?;
/// # Ok::<(), av_decoders::DecoderError>(())
/// ```
/// Creates a new decoder that reads from standard input (stdin).
///
/// This method is useful for processing video data in pipelines or when the video
/// data is being streamed. Currently, only Y4M format is supported for stdin input.
///
/// # Returns
///
/// Returns a `Result` containing:
/// - `Ok(Decoder<BufReader<Stdin>>)` - A successfully initialized decoder reading from stdin
/// - `Err(DecoderError)` - An error if stdin cannot be read or the data is not valid Y4M
///
/// # Errors
///
/// This method will return an error if:
/// - The input stream is not in Y4M format
/// - The Y4M header is malformed or missing (`DecoderError::GenericDecodeError`)
/// - End of file is reached immediately (`DecoderError::EndOfFile`)
///
/// # Examples
///
/// ```no_run
/// use av_decoders::from_stdin;
///
/// // Read Y4M data from stdin
/// let mut decoder = from_stdin()?;
///
/// // Process frames as they arrive
/// loop {
/// match decoder.read_video_frame::<u8>() {
/// Ok(frame) => {
/// // Process the frame
/// println!("Received frame: {}x{}", frame.planes[0].cfg.width, frame.planes[0].cfg.height);
/// }
/// Err(av_decoders::DecoderError::EndOfFile) => break,
/// Err(e) => return Err(e),
/// }
/// }
/// # Ok::<(), av_decoders::DecoderError>(())
/// ```
///
/// ## Command Line Usage
///
/// This is commonly used with command-line pipelines:
/// ```bash
/// # Pipe Y4M data to your application
/// ffmpeg -i input.mp4 -f yuv4mpegpipe - | your_app
///
/// # Or directly from Y4M files
/// cat video.y4m | your_app
/// ```