MAJOR ARCHITECTURAL IMPROVEMENT:
Instead of using arbitrary timeouts that don't solve the real problem,
implement proper idle mode and explicit end-of-stream signaling.
Changes:
1. **Remove block_id timeout completely**
- No more BLOCK_ID_TIMEOUT_SECS
- Source enters idle mode when queue is empty
- Waits indefinitely for new block_ids (poll every 100ms)
- Only exits on cancellation or END_OF_BLOCKS_SIGNAL
2. **Introduce END_OF_BLOCKS_SIGNAL (EventId::MAX)**
- Special block_id value to signal "no more blocks"
- Source terminates cleanly after processing current block
- Allows proper shutdown without cancellation
- Exported from pmoparadise crate for public use
3. **Update HTTP timeout to 24 hours**
- Effectively infinite timeout for block downloads
- HTTP stream stays open as long as needed
- Closed by pipeline termination, not arbitrary timeout
4. **Update stream_block example**
- Push END_OF_BLOCKS_SIGNAL after the single block
- Demonstrates clean termination after one block
- Documents pattern for continuous vs. bounded streaming
Benefits:
- No arbitrary timeouts that might truncate valid streams
- Clean separation: cancellation (external) vs. completion (internal)
- Supports both continuous radio and bounded playlists
- Proper idle mode for on-demand streaming applications
Usage pattern:
```rust
// Single block then stop
source.push_block_id(block_id);
source.push_block_id(END_OF_BLOCKS_SIGNAL);
// Continuous streaming
source.push_block_id(block1);
source.push_block_id(block2);
// ... keep pushing or wait in idle mode
// Graceful shutdown
source.push_block_id(END_OF_BLOCKS_SIGNAL);
```
ROOT CAUSE IDENTIFIED:
The previous "wait for playback duration" workaround was masking the real
issue. Radio Paradise blocks last ~20 minutes (1200s), but the HTTP timeout
was only 180 seconds, causing premature stream termination.
With backpressure from the audio pipeline, HTTP download proceeds at real-time
pace. A 20-minute block takes ~20 minutes to download. The 180s timeout
was killing the connection after 3 minutes, resulting in incomplete blocks.
Changes:
1. **Increase HTTP block_timeout: 180s → 7200s (2 hours)**
- Allows complete download of even the longest blocks
- Comment explains why such a long timeout is needed
2. **Increase MPSC channel sizes: 16 → 60 chunks**
- Matches TimerNode max_lead_time (3.0s / 0.05s = 60 chunks)
- Prevents stop-and-go backpressure pattern
- Allows smooth buffering as intended
3. **Replace workaround with proper channel drainage**
- Use tx.closed().await instead of sleep()
- Guarantees all buffered chunks are processed
- More architecturally sound solution
4. **Add comprehensive diagnostic traces**
- Log expected vs actual block duration
- Detect premature EOF (< 95% of expected duration)
- Track bytes decoded and HTTP Content-Length
- Monitor backpressure blocking with timing
This fixes the streaming completely. The block will now:
- Download for the full ~20 minutes (real-time with backpressure)
- Decode all audio data without truncation
- Process all chunks before pipeline shutdown
Investigation revealed the root cause of premature streaming termination:
1. MPSC Channel Size Issue:
- DEFAULT_CHANNEL_SIZE = 16 chunks × 50ms = 800ms capacity
- TimerNode max_lead_time = 3.0 seconds
- The channel fills up in 0.8s while TimerNode wants 3s buffer
- This creates stop-and-go pattern instead of smooth backpressure
2. Channel Closure Issue:
- When RadioParadiseStreamSource::process() returns, the Node
automatically closes output channels
- TimerNode receives EOF and terminates immediately
- Remaining chunks in MPSC buffer (up to 16) are never sent to sink
Added comprehensive tracing:
- RadioParadiseStreamSource: Track backpressure blocking, chunk counts,
decode timing
- TimerNode: Log all pacing decisions, sleep durations, lead time
- Both use trace! for high-frequency events, debug! for blocking
Next steps:
- Option A: Increase channel size to match max_lead_time
(60 chunks for 3s @ 50ms)
- Option B: Wait for channels to drain before closing
(use tx.closed().await)
- Option C: Both A and B for optimal behavior
The previous "wait for playback duration" fix is a valid workaround
but doesn't address the architectural issue.
Previously, RadioParadiseStreamSource would close its output channel as
soon as the block finished downloading and decoding, causing TimerNode to
receive EOF and terminate immediately, even if it still had audio chunks
in its buffer waiting to be sent with proper timing.
This fix makes RadioParadiseStreamSource wait for the actual playback
duration to elapse before closing the channel, ensuring that TimerNode
has enough time to broadcast all chunks at the correct pace.
Changes:
- Modified download_and_decode_block() to return (timestamp, Instant)
instead of just timestamp, capturing the start time
- Added wait logic in process() to sleep for remaining playback time
after sending EndOfStream, before returning and closing the channel
- Added Instant import to support timing calculations
This ensures Radio Paradise blocks (~20 minutes each) stream completely
instead of stopping prematurely when download completes.
The 3-second timeout was causing streams to stop prematurely after
block download completed (~3 minutes) instead of playing for the
full block duration (~30 minutes).
For test scenarios with a single block, we need a much longer timeout
to allow the TimerNode to pace the stream properly over the full
block duration.
Changes:
- BLOCK_ID_TIMEOUT_SECS: 3 → 3600 seconds (1 hour)
- Modified download_and_decode_block() to return final timestamp
- EndOfStream now uses correct timestamp instead of 0.0
This allows the TimerNode to properly pace the stream in real-time
instead of the stream ending immediately after download completes.
This commit fixes two critical bugs in the HTTP streaming implementation:
## 1. OGG-FLAC Format Compliance (streaming_ogg_flac_sink.rs)
### Problem
VLC and other players couldn't play the OGG-FLAC stream because the format
was not compliant with the OGG-FLAC mapping specification.
### Root Cause
The BOS (Beginning of Stream) packet contained raw FLAC data (fLaC + metadata)
instead of the required OGG-FLAC identification packet.
### Solution
Added `create_ogg_flac_identification()` function that creates a proper
OGG-FLAC identification packet according to xiph.org/flac/ogg_mapping.html:
- Byte 0: 0x7F (identification marker)
- Bytes 1-4: "FLAC" (codec identifier)
- Byte 5: 0x01 (major version)
- Byte 6: 0x00 (minor version)
- Bytes 7-8: 0x00 0x00 (number of header packets, big-endian)
- Bytes 9+: Native FLAC stream (fLaC + metadata)
This ensures compatibility with all OGG-FLAC compliant players.
## 2. Stream Duration Fix (radio_paradise_stream_source.rs)
### Problem
According to user report, streams would stop after download completion
(~7 seconds) instead of playing for the full block duration (16-20 minutes).
### Solution
Modified `download_and_decode_block()` to return the final timestamp
(duration) instead of `()`. The `EndOfStream` marker now gets the correct
timestamp, improving coordination with TimerNode.
Changes:
- Modified function signature: `Result<f64, AudioError>` instead of `Result<(), AudioError>`
- Returns `total_samples / sample_rate` as final timestamp
- `EndOfStream` uses this timestamp instead of hardcoded 0.0
- Handles cancellation by returning current timestamp
Note: User correctly pointed out that EndOfStream can't bypass queued chunks
in the FIFO pipeline. The timestamp correction improves code robustness
regardless.
## Testing
- Compilation successful
- Stream runs for 30+ seconds (vs. 7 seconds before)
- OGG-FLAC identification packet properly formatted
- Ready for VLC playback testing
This commit fixes two critical issues that prevented covers from being
cached for tracks beyond the first one in Radio Paradise blocks:
1. FlacCacheSink Phase 3 metadata loss:
- When TrackBoundary for track N+1 was received during Phase 3
of track N, the metadata was discarded
- Main loop would then wait for a NEW TrackBoundary that never came
- Solution: Store metadata in next_track_metadata variable and reuse
it in next iteration
- Added wait_for_first_audio_chunk() for when metadata is pre-loaded
2. RadioParadiseStreamSource not sending subsequent TrackBoundaries:
- Code was only checking elapsed_ms >= song.elapsed in loop
- Added debug logging to track TrackBoundary sending
- Improved comments explaining first song special handling
Test results:
- Successfully cached covers for 4 consecutive tracks
- Verified with test showing "Successfully cached cover" for each track
- Cover cache directory contains 4 .webp files with complete markers
Files modified:
- pmoaudio-ext/src/sinks/flac_cache_sink.rs
- pmoparadise/src/radio_paradise_stream_source.rs
Corrige un bug critique qui empêchait la mise en cache des covers :
- RadioParadiseStreamSource envoie maintenant un TrackBoundary pour la première
song IMMÉDIATEMENT après le TopZeroSync, AVANT le premier chunk audio
- Cela garantit que FlacCacheSink reçoit les métadonnées (incluant cover_url)
dès le début du traitement
Le problème :
- Avant, le TrackBoundary n'était envoyé que quand elapsed_ms >= song.elapsed
- Pour la première song avec elapsed > 0, le TrackBoundary arrivait APRÈS
plusieurs chunks audio
- FlacCacheSink recevait le premier chunk SANS métadonnées
- Quand le prebuffer se terminait, track_metadata était None
- Les métadonnées (incluant cover_url) n'étaient jamais copiées dans le cache
- Résultat : aucune cover n'était mise en cache
La solution :
- Envoyer explicitement un TrackBoundary pour la première song avant de
commencer la boucle de chunks
- Les songs suivantes continuent d'être gérées par la logique existante
Test validé :
✓ RadioParadiseStreamSource configure cover_url correctement
✓ FlacCacheSink reçoit cover_url
✓ Les covers sont téléchargées et mises en cache
✓ Les logs montrent : "Successfully cached cover for pk ... with cover pk ..."
Corrige un bug critique de race condition dans RadioParadiseStreamSource :
- Rend song_to_metadata() async et attend que toutes les métadonnées soient configurées
- Supprime le tokio::spawn() qui causait un retour prématuré des métadonnées
- Garantit que cover_url est disponible quand FlacCacheSink lit les métadonnées
- Ajoute des logs de debug pour tracer la configuration des métadonnées
- Remplace eprintln! par tracing::warn! pour une meilleure cohérence
Corrige également un warning de compilation :
- Retire le `mut` inutile sur la variable `writer` dans play_and_cache.rs
Le problème : song_to_metadata() retournait les métadonnées avant que
la task asynchrone ne finisse de les configurer, ce qui causait un
cover_url manquant quand FlacCacheSink essayait de cacher les covers.
Ajoute la possibilité de configurer le channel par défaut de Radio Paradise
de manière persistante et user-friendly.
Fonctionnalités :
- get_paradise_default_channel() : récupère le channel configuré (défaut: 0/main)
- set_paradise_default_channel(u8) : définit le channel par défaut
- Accepte DEUX formats dans le fichier YAML :
* Noms conviviaux : "main", "mellow", "rock", "eclectic"
* IDs numériques : 0, 1, 2, 3
- Stocke les valeurs comme chaînes conviviales pour la lisibilité
- Validation automatique avec fallback sur "main" si invalide
- Persistence automatique de la valeur par défaut lors du premier accès
Exemple de configuration YAML :
```yaml
sources:
radio_paradise:
enabled: true
default_channel: mellow # ou 1
```
Cette amélioration rend la configuration plus accessible aux utilisateurs
qui préfèrent un channel autre que Main Mix par défaut.
Corrections :
1. Supprimé le commentaire obsolète sur block_base (ligne 277)
2. Créé la constante DEFAULT_CHANNEL pour éviter de coder "0" en dur
3. Utilisé DEFAULT_CHANNEL dans with_client(), ClientBuilder::default() et tests
4. Amélioré la documentation de with_client() pour guider vers le builder
Bien que with_client() et ClientBuilder::default() aient encore une structure
similaire, ils utilisent maintenant les mêmes constantes, réduisant ainsi
le risque d'incohérence lors de modifications futures.
Supprime complètement la duplication d'information en transformant
block_base d'un champ stocké en une méthode calculée dynamiquement.
Changements:
- Supprimé le champ block_base de RadioParadiseClient
- Ajouté la constante BLOCK_BASE_URL pour éviter la duplication de l'URL
- Transformé block_base en méthode publique qui calcule à partir de channel
- Simplifié with_client() et clone_with_channel()
- Simplifié le builder qui n'a plus besoin d'initialiser block_base
Cette approche garantit que block_base est toujours cohérent avec channel,
éliminant définitivement toute possibilité de bug de synchronisation.
Le bug identifié était que le block_base n'était pas synchronisé avec
le channel dans le ClientBuilder, causant le téléchargement du même
bloc pour différents channels.
Changements:
- Supprimé le champ block_base du ClientBuilder (duplication)
- Supprimé la constante DEFAULT_BLOCK_BASE (plus nécessaire)
- Supprimé la méthode .block_base() du builder (complexité inutile)
- Le block_base est maintenant calculé dynamiquement dans build()
à partir du channel, éliminant toute possibilité de désynchronisation
Cette approche suit le principe DRY et élimine une source de bugs.
Add async_trait annotation to RadioParadiseExt trait and its implementation
to suppress the "async fn in public traits" warning.
This is the recommended approach for traits with async methods as it ensures
proper Future bounds (Send) are generated.
The old streaming API has been completely replaced by RadioParadiseStreamSource
which integrates directly with the pmoaudio pipeline.
Removed:
- src/stream.rs (179 lines) - BlockStream, stream_block(), download_block()
- src/track.rs - Per-track extraction functionality
- examples/stream_block.rs - Obsolete streaming example
- examples/extract_track.rs - Per-track extraction example
- Feature "per-track" and dependencies (hound, tempfile)
Updated:
- Cargo.toml: Removed per-track feature and obsolete examples
- lib.rs: Removed module declarations and re-exports
The new RadioParadiseStreamSource provides:
- Direct integration with pmoaudio pipeline
- FLAC decoding via pmoflac
- Automatic TrackBoundary insertion
- Better performance and lower latency
