suno-core 0.36.2

Engine for a download-only Suno.ai library tool: feed selection, sync reconciliation, and audio tagging.
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
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
use super::*;

#[test]
fn cover_falls_back_when_large_image_is_missing() {
    let c = art_clip("e");
    let d = desired(c.clone(), AudioFormat::Mp3);
    let plan = Plan {
        actions: vec![Action::Download {
            clip: c.clone(),
            lineage: LineageContext::own_root(&c),
            path: d.path.clone(),
            format: AudioFormat::Mp3,
        }],
    };
    let http = ScriptedHttp::new()
        .route("e.mp3", Reply::ok(b"body".to_vec()))
        .route("e/large.jpg", Reply::status(404))
        .route("e/small.jpg", Reply::ok(b"the-art".to_vec()));
    let fs = MemFs::new();
    let mut manifest = Manifest::new();

    let outcome = run(
        &plan,
        &mut manifest,
        &[d],
        &http,
        &fs,
        &StubFfmpeg::flac(),
        &RecordingClock::new(),
        &ExecOptions::default(),
    );

    assert_eq!(outcome.downloaded, 1);
    let calls = http.calls();
    let large = calls
        .iter()
        .position(|u| u.contains("e/large.jpg"))
        .unwrap();
    let small = calls
        .iter()
        .position(|u| u.contains("e/small.jpg"))
        .unwrap();
    assert!(large < small, "large art tried before small");
}

#[test]
fn download_reuses_the_embedded_cover_for_the_jpg_sidecar() {
    // The embedded tag and the `.jpg` sidecar want the same cover URL; it is
    // fetched once and the bytes serve both.
    let c = art_clip("a");
    let d = desired(c.clone(), AudioFormat::Mp3);
    let plan = Plan {
        actions: vec![
            Action::Download {
                clip: c.clone(),
                lineage: LineageContext::own_root(&c),
                path: d.path.clone(),
                format: AudioFormat::Mp3,
            },
            Action::WriteArtifact {
                kind: ArtifactKind::CoverJpg,
                path: "a/cover.jpg".to_owned(),
                source_url: c.selected_image_url().unwrap().to_owned(),
                hash: "art".to_owned(),
                owner_id: "a".to_owned(),
                content: None,
            },
        ],
    };
    let http = ScriptedHttp::new()
        .route("a.mp3", Reply::ok(b"mp3-body".to_vec()))
        .route("a/large.jpg", Reply::ok(b"the-art".to_vec()));
    let fs = MemFs::new();
    let mut manifest = Manifest::new();

    let outcome = run(
        &plan,
        &mut manifest,
        &[d],
        &http,
        &fs,
        &StubFfmpeg::flac(),
        &RecordingClock::new(),
        &ExecOptions::default(),
    );

    assert_eq!(outcome.downloaded, 1);
    assert_eq!(outcome.artifacts_written, 1);
    assert_eq!(outcome.failed(), 0);
    // Fetched once, not twice.
    assert_eq!(http.count("a/large.jpg"), 1);
    // The sidecar carries the fetched bytes, and the audio was tagged.
    assert_eq!(fs.read_file("a/cover.jpg").unwrap(), b"the-art");
    assert_eq!(&fs.read_file("a.mp3").unwrap()[..3], b"ID3");
}

#[test]
fn concurrent_downloads_reuse_each_clips_own_cover() {
    // Two clips render concurrently; each `.jpg` sidecar gets its own cover
    // (no cross-contamination) and each cover URL is fetched exactly once.
    let a = art_clip("a");
    let b = art_clip("b");
    let da = desired(a.clone(), AudioFormat::Mp3);
    let db = desired(b.clone(), AudioFormat::Mp3);
    let plan = Plan {
        actions: vec![
            Action::Download {
                clip: a.clone(),
                lineage: LineageContext::own_root(&a),
                path: da.path.clone(),
                format: AudioFormat::Mp3,
            },
            Action::WriteArtifact {
                kind: ArtifactKind::CoverJpg,
                path: "a/cover.jpg".to_owned(),
                source_url: a.selected_image_url().unwrap().to_owned(),
                hash: "art".to_owned(),
                owner_id: "a".to_owned(),
                content: None,
            },
            Action::Download {
                clip: b.clone(),
                lineage: LineageContext::own_root(&b),
                path: db.path.clone(),
                format: AudioFormat::Mp3,
            },
            Action::WriteArtifact {
                kind: ArtifactKind::CoverJpg,
                path: "b/cover.jpg".to_owned(),
                source_url: b.selected_image_url().unwrap().to_owned(),
                hash: "art".to_owned(),
                owner_id: "b".to_owned(),
                content: None,
            },
        ],
    };
    let http = ScriptedHttp::new()
        .route("a.mp3", Reply::ok(b"a-mp3".to_vec()))
        .route("b.mp3", Reply::ok(b"b-mp3".to_vec()))
        .route("a/large.jpg", Reply::ok(b"art-a".to_vec()))
        .route("b/large.jpg", Reply::ok(b"art-b".to_vec()));
    let fs = MemFs::new();
    let mut manifest = Manifest::new();

    let outcome = run(
        &plan,
        &mut manifest,
        &[da, db],
        &http,
        &fs,
        &StubFfmpeg::flac(),
        &RecordingClock::new(),
        &small_poll(),
    );

    assert_eq!(outcome.downloaded, 2);
    assert_eq!(outcome.artifacts_written, 2);
    assert_eq!(http.count("a/large.jpg"), 1);
    assert_eq!(http.count("b/large.jpg"), 1);
    assert_eq!(fs.read_file("a/cover.jpg").unwrap(), b"art-a");
    assert_eq!(fs.read_file("b/cover.jpg").unwrap(), b"art-b");
}

#[test]
fn cover_sidecar_refetches_when_embed_fell_back_to_another_url() {
    // The large image 404s so the embed falls back to the small image; the
    // sidecar still wants the (dead) large URL and must NOT be handed the
    // small bytes. Reuse is keyed on the exact URL, so nothing is cached and
    // the sidecar fetches the large URL itself (then fails on the 404).
    let c = art_clip("e");
    let d = desired(c.clone(), AudioFormat::Mp3);
    let plan = Plan {
        actions: vec![
            Action::Download {
                clip: c.clone(),
                lineage: LineageContext::own_root(&c),
                path: d.path.clone(),
                format: AudioFormat::Mp3,
            },
            Action::WriteArtifact {
                kind: ArtifactKind::CoverJpg,
                path: "e/cover.jpg".to_owned(),
                source_url: "https://art.suno.ai/e/large.jpg".to_owned(),
                hash: "art".to_owned(),
                owner_id: "e".to_owned(),
                content: None,
            },
        ],
    };
    let http = ScriptedHttp::new()
        .route("e.mp3", Reply::ok(b"body".to_vec()))
        .route("e/large.jpg", Reply::status(404))
        .route("e/small.jpg", Reply::ok(b"small-art".to_vec()));
    let fs = MemFs::new();
    let mut manifest = Manifest::new();

    let outcome = run(
        &plan,
        &mut manifest,
        &[d],
        &http,
        &fs,
        &StubFfmpeg::flac(),
        &RecordingClock::new(),
        &ExecOptions::default(),
    );

    assert_eq!(outcome.downloaded, 1);
    // The small image was fetched once (the embed fallback) and never reused
    // for the large-keyed sidecar; the sidecar went to the network itself.
    assert_eq!(http.count("e/small.jpg"), 1);
    assert!(
        http.count("e/large.jpg") >= 2,
        "sidecar refetched the large URL"
    );
    assert_eq!(manifest.get("e").unwrap().cover_jpg, None);
    assert!(!fs.exists("e/cover.jpg"));
}

#[test]
fn flac_render_retries_a_rate_limited_wav_lookup() {
    let c = clip("rl");
    let d = desired(c.clone(), AudioFormat::Flac);
    let plan = Plan {
        actions: vec![Action::Download {
            clip: c.clone(),
            lineage: LineageContext::own_root(&c),
            path: d.path.clone(),
            format: AudioFormat::Flac,
        }],
    };
    let http = ScriptedHttp::new()
        .with_auth()
        .route_seq(
            "/wav_file/",
            vec![
                Reply::status(429),
                Reply::json(r#"{"wav_file_url": "https://cdn1.suno.ai/rl.wav"}"#),
            ],
        )
        .route("rl.wav", Reply::ok(b"wav".to_vec()));
    let clock = RecordingClock::new();
    let mut manifest = Manifest::new();

    let outcome = run(
        &plan,
        &mut manifest,
        &[d],
        &http,
        &fs_new(),
        &StubFfmpeg::flac(),
        &clock,
        &small_poll(),
    );

    assert_eq!(outcome.downloaded, 1);
    assert_eq!(outcome.failed(), 0);
    // The render was ready on retry, so no fresh convert_wav was needed.
    assert_eq!(http.count("/convert_wav/"), 0);
    // One transient backoff (1s base), not the 5s poll interval.
    assert_eq!(clock.sleeps(), vec![Duration::from_secs(1)]);
}

#[test]
fn download_embeds_animated_webp_cover_when_enabled() {
    // With animated covers on and a video preview present, the audio embeds
    // the transcoded WebP (image/webp) as its front cover, not the static JPEG.
    let c = Clip {
        video_cover_url: "https://cdn.suno.ai/a/video.mp4".to_owned(),
        ..art_clip("a")
    };
    let d = desired(c.clone(), AudioFormat::Mp3);
    let plan = Plan {
        actions: vec![Action::Download {
            clip: c.clone(),
            lineage: LineageContext::own_root(&c),
            path: d.path.clone(),
            format: AudioFormat::Mp3,
        }],
    };
    let http = ScriptedHttp::new()
        .route("a.mp3", Reply::ok(b"mp3-body".to_vec()))
        .route("a/video.mp4", Reply::ok(b"mp4-bytes".to_vec()))
        .route("a/large.jpg", Reply::ok(b"static-jpg".to_vec()));
    let fs = MemFs::new();
    let opts = ExecOptions {
        embed_animated_cover: true,
        ..ExecOptions::default()
    };
    let mut manifest = Manifest::new();

    let outcome = run(
        &plan,
        &mut manifest,
        &[d],
        &http,
        &fs,
        &StubFfmpeg::flac(),
        &RecordingClock::new(),
        &opts,
    );

    assert_eq!(outcome.downloaded, 1);
    assert_eq!(outcome.failed(), 0);
    let written = fs.read_file("a.mp3").unwrap();
    let tag = id3::Tag::read_from2(std::io::Cursor::new(&written)).unwrap();
    let pic = tag.pictures().next().expect("embedded cover");
    assert_eq!(pic.mime_type, "image/webp");
    assert!(
        pic.data.starts_with(b"RIFF"),
        "the embedded cover is the transcoded WebP"
    );
    // The MP4 preview was fetched and transcoded; the static JPEG was not needed.
    assert_eq!(http.count("a/video.mp4"), 1);
    assert_eq!(http.count("a/large.jpg"), 0);
}

#[test]
fn download_keeps_static_jpeg_cover_when_embed_disabled() {
    // With the feature off (default), even a clip with a video preview embeds
    // the static JPEG and never fetches or transcodes the MP4.
    let c = Clip {
        video_cover_url: "https://cdn.suno.ai/a/video.mp4".to_owned(),
        ..art_clip("a")
    };
    let d = desired(c.clone(), AudioFormat::Mp3);
    let plan = Plan {
        actions: vec![Action::Download {
            clip: c.clone(),
            lineage: LineageContext::own_root(&c),
            path: d.path.clone(),
            format: AudioFormat::Mp3,
        }],
    };
    let http = ScriptedHttp::new()
        .route("a.mp3", Reply::ok(b"mp3-body".to_vec()))
        .route("a/large.jpg", Reply::ok(b"static-jpg".to_vec()));
    let fs = MemFs::new();
    let mut manifest = Manifest::new();

    let outcome = run(
        &plan,
        &mut manifest,
        &[d],
        &http,
        &fs,
        &StubFfmpeg::flac(),
        &RecordingClock::new(),
        &ExecOptions::default(),
    );

    assert_eq!(outcome.failed(), 0);
    let written = fs.read_file("a.mp3").unwrap();
    let tag = id3::Tag::read_from2(std::io::Cursor::new(&written)).unwrap();
    let pic = tag.pictures().next().expect("embedded cover");
    assert_eq!(pic.mime_type, "image/jpeg");
    assert_eq!(pic.data, b"static-jpg");
    assert_eq!(http.count("a/video.mp4"), 0);
}

#[test]
fn oversized_animated_cover_falls_back_to_jpeg_embed() {
    // A transcoded WebP that would overflow the FLAC picture cap is not
    // embedded; the audio falls back to the static JPEG so the file stays
    // valid (and no re-tag loop, since the intent hash is unchanged).
    let c = Clip {
        video_cover_url: "https://cdn.suno.ai/a/video.mp4".to_owned(),
        ..art_clip("a")
    };
    let d = desired(c.clone(), AudioFormat::Mp3);
    let plan = Plan {
        actions: vec![Action::Download {
            clip: c.clone(),
            lineage: LineageContext::own_root(&c),
            path: d.path.clone(),
            format: AudioFormat::Mp3,
        }],
    };
    let http = ScriptedHttp::new()
        .route("a.mp3", Reply::ok(b"mp3-body".to_vec()))
        .route("a/video.mp4", Reply::ok(b"mp4-bytes".to_vec()))
        .route("a/large.jpg", Reply::ok(b"static-jpg".to_vec()));
    let fs = MemFs::new();
    let oversize = vec![b'R'; flac_picture_data_budget("image/webp") + 1];
    let ffmpeg = StubFfmpeg::flac().with_webp(oversize);
    let opts = ExecOptions {
        embed_animated_cover: true,
        ..ExecOptions::default()
    };
    let mut manifest = Manifest::new();

    let outcome = run(
        &plan,
        &mut manifest,
        &[d],
        &http,
        &fs,
        &ffmpeg,
        &RecordingClock::new(),
        &opts,
    );

    assert_eq!(outcome.failed(), 0);
    let written = fs.read_file("a.mp3").unwrap();
    let tag = id3::Tag::read_from2(std::io::Cursor::new(&written)).unwrap();
    let pic = tag.pictures().next().expect("embedded cover");
    assert_eq!(pic.mime_type, "image/jpeg");
    assert_eq!(pic.data, b"static-jpg");
}

#[test]
fn cover_transcode_failure_falls_back_to_jpeg_embed() {
    // A non-systemic MP4 fetch/transcode failure never fails the audio: the
    // embed falls back to the static JPEG, best-effort like a failed cover
    // fetch, and the run completes.
    let c = Clip {
        video_cover_url: "https://cdn.suno.ai/a/video.mp4".to_owned(),
        ..art_clip("a")
    };
    let d = desired(c.clone(), AudioFormat::Mp3);
    let plan = Plan {
        actions: vec![Action::Download {
            clip: c.clone(),
            lineage: LineageContext::own_root(&c),
            path: d.path.clone(),
            format: AudioFormat::Mp3,
        }],
    };
    let http = ScriptedHttp::new()
        .route("a.mp3", Reply::ok(b"mp3-body".to_vec()))
        .route("a/video.mp4", Reply::ok(b"mp4-bytes".to_vec()))
        .route("a/large.jpg", Reply::ok(b"static-jpg".to_vec()));
    let fs = MemFs::new();
    let opts = ExecOptions {
        embed_animated_cover: true,
        ..ExecOptions::default()
    };
    let mut manifest = Manifest::new();

    let outcome = run(
        &plan,
        &mut manifest,
        &[d],
        &http,
        &fs,
        &StubFfmpeg::failing(),
        &RecordingClock::new(),
        &opts,
    );

    assert_eq!(outcome.status, RunStatus::Completed);
    assert_eq!(outcome.failed(), 0);
    let written = fs.read_file("a.mp3").unwrap();
    let tag = id3::Tag::read_from2(std::io::Cursor::new(&written)).unwrap();
    assert_eq!(tag.pictures().next().unwrap().mime_type, "image/jpeg");
}

#[test]
fn disk_full_cover_transcode_aborts_the_run() {
    // A full scratch disk during the cover transcode is systemic: it aborts
    // the run (exit 9) rather than silently skipping the cover.
    let c = Clip {
        video_cover_url: "https://cdn.suno.ai/a/video.mp4".to_owned(),
        ..art_clip("a")
    };
    let d = desired(c.clone(), AudioFormat::Mp3);
    let plan = Plan {
        actions: vec![Action::Download {
            clip: c.clone(),
            lineage: LineageContext::own_root(&c),
            path: d.path.clone(),
            format: AudioFormat::Mp3,
        }],
    };
    let http = ScriptedHttp::new()
        .route("a.mp3", Reply::ok(b"mp3-body".to_vec()))
        .route("a/video.mp4", Reply::ok(b"mp4-bytes".to_vec()));
    let fs = MemFs::new();
    let opts = ExecOptions {
        embed_animated_cover: true,
        ..ExecOptions::default()
    };
    let mut manifest = Manifest::new();

    let outcome = run(
        &plan,
        &mut manifest,
        &[d],
        &http,
        &fs,
        &StubFfmpeg::out_of_space(),
        &RecordingClock::new(),
        &opts,
    );

    assert_eq!(outcome.status, RunStatus::DiskFull);
}

#[test]
fn video_only_clip_never_embeds_the_mp4_as_a_cover() {
    // A clip with a video preview but no static image must never embed the
    // MP4 bytes as a picture: when the WebP transcode fails and there is no
    // static image to fall back to, the audio is written with no cover.
    let c = Clip {
        video_cover_url: "https://cdn.suno.ai/a/video.mp4".to_owned(),
        ..clip("a")
    };
    let d = desired(c.clone(), AudioFormat::Mp3);
    let plan = Plan {
        actions: vec![Action::Download {
            clip: c.clone(),
            lineage: LineageContext::own_root(&c),
            path: d.path.clone(),
            format: AudioFormat::Mp3,
        }],
    };
    let http = ScriptedHttp::new()
        .route("a.mp3", Reply::ok(b"mp3-body".to_vec()))
        .route("a/video.mp4", Reply::ok(b"mp4-bytes".to_vec()));
    let fs = MemFs::new();
    let opts = ExecOptions {
        embed_animated_cover: true,
        ..ExecOptions::default()
    };
    let mut manifest = Manifest::new();

    let outcome = run(
        &plan,
        &mut manifest,
        &[d],
        &http,
        &fs,
        &StubFfmpeg::failing(),
        &RecordingClock::new(),
        &opts,
    );

    assert_eq!(outcome.failed(), 0);
    let written = fs.read_file("a.mp3").unwrap();
    let tag = id3::Tag::read_from2(std::io::Cursor::new(&written)).unwrap();
    assert!(
        tag.pictures().next().is_none(),
        "no cover embedded, never the MP4"
    );
    assert!(
        !written
            .windows(b"mp4-bytes".len())
            .any(|w| w == b"mp4-bytes"),
        "the MP4 bytes must not be embedded as artwork"
    );
}

#[test]
fn embed_uses_configured_webp_settings() {
    use std::sync::{Arc, Mutex};

    struct RecordingWebpFfmpeg {
        seen: Arc<Mutex<Vec<WebpEncodeSettings>>>,
    }

    impl Ffmpeg for RecordingWebpFfmpeg {
        async fn wav_to_lossless(
            &self,
            _wav: &[u8],
            _format: AudioFormat,
        ) -> Result<Vec<u8>, crate::ffmpeg::FfmpegError> {
            Ok(Vec::new())
        }

        async fn mp4_to_webp(
            &self,
            _mp4: &[u8],
            settings: WebpEncodeSettings,
        ) -> Result<Vec<u8>, crate::ffmpeg::FfmpegError> {
            let seen = Arc::clone(&self.seen);
            seen.lock().unwrap().push(settings);
            Ok(b"RIFF\x00\x00\x00\x00WEBP".to_vec())
        }
    }

    let c = Clip {
        video_cover_url: "https://cdn.suno.ai/a/video.mp4".to_owned(),
        ..art_clip("a")
    };
    let d = desired(c.clone(), AudioFormat::Mp3);
    let plan = Plan {
        actions: vec![Action::Download {
            clip: c.clone(),
            lineage: LineageContext::own_root(&c),
            path: d.path.clone(),
            format: AudioFormat::Mp3,
        }],
    };
    let seen = Arc::new(Mutex::new(Vec::new()));
    let ffmpeg = RecordingWebpFfmpeg {
        seen: Arc::clone(&seen),
    };
    let opts = ExecOptions {
        embed_animated_cover: true,
        cover_webp: WebpEncodeSettings {
            quality: 88,
            max_fps: 12,
            max_width: Some(720),
            lossless: false,
            compression_level: 4,
        },
        ..ExecOptions::default()
    };

    let _ = run(
        &plan,
        &mut Manifest::new(),
        &[d],
        &ScriptedHttp::new()
            .route("a.mp3", Reply::ok(b"mp3-body".to_vec()))
            .route("a/video.mp4", Reply::ok(b"mp4-bytes".to_vec())),
        &MemFs::new(),
        &ffmpeg,
        &RecordingClock::new(),
        &opts,
    );

    assert_eq!(
        seen.lock().unwrap().as_slice(),
        &[WebpEncodeSettings {
            quality: 88,
            max_fps: 12,
            max_width: Some(720),
            lossless: false,
            compression_level: 4,
        }]
    );
}