cyber-mawonaj/oki-podcast-reader
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor audio to use custom listener stores

Browse Source
This commit is contained in:
Ollie Taylor
2023-02-25 14:16:19 +00:00
parent acbdd46fe3
commit 42c27b2469
13 changed files with 259 additions and 313 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/lib/audio/_private.ts
-17
View File
@@ -1,17 +0,0 @@
import type { AudioMetadata, AudioPlayerElement } from '$lib/types';
import { writable } from 'svelte/store';
// readonly - stores will update when bindings change
export const _current_time = writable<number>(0);
export const _element = writable<AudioPlayerElement>();
export const _duration = writable<number>(0);
export const _ended = writable<boolean>(false);
export const _loading = writable<boolean>(false);
export const _paused = writable<boolean>(true);
// handlers - when store value changes, the binding will update the audio element
export const _start_at = writable<number>(0);
export const _autoplay = writable<boolean>(false);
export const _muted = writable<boolean>(false);
export const _src = writable<string>('');
export const _metadata = writable<AudioMetadata | null>(null);
src/lib/audio/audio-element.ts
+25
View File
@@ -0,0 +1,25 @@
import { browser } from '$app/environment';
import { onMount } from 'svelte';
import { readable } from 'svelte/store';
export const audio_element = readable<HTMLAudioElement | null>(null, (set) => {
if (!browser) return;
const ID = 'svelte-podcast-generated-audio-element';
onMount(() => {
const el = document.createElement('audio');
el.id = ID;
el.setAttribute('preload', 'metadata');
el.muted = false;
el.autoplay = true;
el.controls = true;
document.body.appendChild(el);
set(el);
});
return () => {
const element = document.getElementById(ID);
element ? element.remove() : null;
};
});
export type AudioElementStore = typeof audio_element;
src/lib/audio/audio-loader.svelte
+9 -72
View File
@@ -1,76 +1,13 @@
<script lang="ts"> <script lang="ts">
import { import { audio_element } from '$lib/audio/audio-element';
_autoplay, import { load_podcast_state } from '$lib/utility';
_current_time, import { info } from '$lib/utility/package/log';
_duration,
_element,
_ended,
_loading,
_muted,
_paused,
_src,
_start_at,
} from '$lib/audio/_private';
import { podcast_preferences } from '$lib/preferences';
import type { AudioPlayerElement } from '$lib/types';
import { load_podcast_state } from '$lib/utility/use-state';
import { onMount } from 'svelte'; import { onMount } from 'svelte';
// readonly values onMount(() => {
let element: AudioPlayerElement; load_podcast_state();
let current_time = $_start_at; return audio_element.subscribe((el) => {
let duration = 0; info('loaded audio :: ', el);
let ended = true; });
let paused = false; });
// handler values
let volume = $podcast_preferences.volume;
let playbackRate = $podcast_preferences.playback_rate;
let muted = false;
// readonly - stores will update when bindings change
$: _element.set(element);
$: _current_time.set(current_time);
$: _duration.set(duration);
$: _ended.set(ended);
$: _paused.set(paused);
// handlers - when store value changes, the binding will update the audio element
$: volume = $podcast_preferences.volume;
$: playbackRate = $podcast_preferences.playback_rate;
$: muted = $_muted;
$: current_time = $_start_at;
onMount(load_podcast_state);
</script> </script>
<audio
bind:this={element}
src={$_src}
autoplay={$_autoplay}
bind:currentTime={current_time}
bind:muted
bind:duration
bind:paused
bind:playbackRate
bind:volume
bind:ended
preload="metadata"
controls={false}
on:canplay={(e) => false && console.log('canplay', e)}
on:canplaythrough={(e) => false && console.log('canplaythrough', e)}
on:timeupdate={(e) => false && console.log('progress', e)}
on:loadedmetadata={(e) => false && console.log('loadedmetadata', e)}
on:suspend={(e) => false && console.log('suspend', e)}
on:seeked={(e) => false && console.log('seeked', e)}
on:play={(e) => false && console.log('play', e)}
on:waiting={(e) => console.log('waiting', e)}
on:stalled={(e) => console.log('stalled', e)}
on:load={(e) => console.log('load', e)}
on:emptied={() => {
// TODO: reset player state
// console.log('emptied', e);
}}
on:loadeddata={() => _loading.set(false)}
on:loadstart={() => _loading.set(true)}
/>
src/lib/audio/episode-data.ts
+140
View File
@@ -0,0 +1,140 @@
import { audio_element, type AudioElementStore } from '$lib/audio/audio-element';
import {
episode_details,
type EpisodeDetails,
type EpisodeDetailsStore,
} from '$lib/audio/episode-details';
import { podcast_preferences } from '$lib/preferences';
import { podcast_progress } from '$lib/progress';
import { warn } from '$lib/utility/package/log';
import clamp from 'just-clamp';
import { derived, get } from 'svelte/store';
type EpisodeAttributes = {
will_autoplay: boolean;
is_muted: boolean;
duration: number;
src: string;
start_at: number;
details: EpisodeDetails;
};
const default_episode_attributes = {
will_autoplay: false,
is_muted: false,
duration: 0,
start_at: 0,
details: null,
} satisfies Omit<EpisodeAttributes, 'src'>;
const episode_attributes = derived<
[AudioElementStore, EpisodeDetailsStore],
EpisodeAttributes | null
>([audio_element, episode_details], ([$audio, $details], set) => {
if (!$audio) return set(null);
function set_value() {
if (!$audio?.src) return null;
set({
...default_episode_attributes,
src: $audio.src,
duration: $audio.duration,
details: $details,
});
}
$audio.addEventListener('loadeddata', () => set_value());
return () => $audio.removeEventListener('loadeddata', () => set_value());
});
type HandleType = 'toggle' | 'set';
const no_element = (action: string) => warn(`could not ${action} :: no audio element exists yet`);
export const episode_audio = {
subscribe: episode_attributes.subscribe,
load: (src: string, details: EpisodeDetails) => {
podcast_progress.stash();
const el = get(audio_element);
if (!el) return no_element('load');
const progress = podcast_progress.get(src);
el.src = src;
console.log('progress', progress);
console.log('src', src);
console.log('podcast_progress', podcast_progress.data);
el.currentTime = progress?.start_at || 0;
const preferences = get(podcast_preferences);
el.playbackRate = preferences.playback_rate;
el.volume = preferences.volume;
episode_details.set(details);
},
unload: () => {
podcast_progress.stash();
const el = get(audio_element);
if (!el) return no_element('unload');
el.src = '';
episode_details.set(null);
},
play: (t?: HandleType) => {
const el = get(audio_element);
if (!el) return no_element('play');
if (t === 'toggle') {
el.paused ? el.play() : el.pause();
} else {
el.play();
}
},
pause: (t?: HandleType) => {
podcast_progress.stash();
const el = get(audio_element);
if (!el) return no_element('pause');
if (t === 'toggle') {
el.paused ? el.play() : el.pause();
} else {
el.pause();
}
},
mute: (t?: HandleType) => {
const el = get(audio_element);
if (!el) return no_element('mute');
if (t === 'toggle') {
el.muted = !el.muted;
} else {
el.muted = true;
}
},
unmute: (t?: HandleType) => {
const el = get(audio_element);
if (!el) return no_element('unmute');
if (t === 'toggle') {
el.muted = !el.muted;
} else {
el.muted = false;
}
},
seek(seconds: number, from: 'from-start' | 'from-end' = 'from-start') {
const el = get(audio_element);
if (!el) return no_element('seek');
if (from === 'from-end') {
el.currentTime = clamp(0, el.duration, el.duration - seconds);
} else {
el.currentTime = clamp(0, el.duration, seconds);
}
},
skip(seconds: number, type: 'forward' | 'backward' = 'forward') {
const el = get(audio_element);
if (!el) return no_element('skip');
if (type === 'backward') {
el.currentTime = clamp(0, el.duration, el.currentTime - seconds);
} else {
el.currentTime = clamp(0, el.duration, el.currentTime + seconds);
}
},
};
src/lib/audio/episode-details.ts
+5
View File
@@ -0,0 +1,5 @@
import { writable } from 'svelte/store';
export type EpisodeDetails = Record<string, string | number | boolean> | null;
export const episode_details = writable<EpisodeDetails>(null);
export type EpisodeDetailsStore = typeof episode_details;
src/lib/audio/episode-progress.ts
+30
View File
@@ -0,0 +1,30 @@
import { audio_element, type AudioElementStore } from '$lib/audio/audio-element';
import { secondsToTimestamp } from '$lib/utility';
import { derived } from 'svelte/store';
type EpisodeProgress = { current_time: number; timestamp: string; has_ended: boolean };
const default_episode_progress = {
current_time: 0,
timestamp: '00:00',
has_ended: false,
} satisfies EpisodeProgress;
export const episode_progress = derived<AudioElementStore, EpisodeProgress>(
audio_element,
($audio, set) => {
if (!$audio) return set(default_episode_progress);
function set_value() {
if (!$audio) return;
set({
current_time: $audio.currentTime,
timestamp: secondsToTimestamp($audio.currentTime),
has_ended: $audio.ended,
});
}
$audio.addEventListener('timeupdate', () => set_value());
return () => $audio.removeEventListener('timeupdate', () => set_value());
},
);
src/lib/audio/index.ts
+3 -144
View File
@@ -1,145 +1,4 @@
import {
_autoplay,
_current_time,
_duration,
_element,
_ended,
_loading,
_metadata,
_muted,
_paused,
_src,
_start_at,
} from '$lib/audio/_private';
import { podcast_progress } from '$lib/progress';
import type { AudioLoadData, AudioLoadOptions } from '$lib/types';
import { secondsToTimestamp } from '$lib/utility/seconds-to-timestamp';
import { info, warn } from '$pkg/log';
import clamp from 'just-clamp';
import { derived, type Readable } from 'svelte/store';
export { default as AudioLoader } from '$lib/audio/audio-loader.svelte'; export { default as AudioLoader } from '$lib/audio/audio-loader.svelte';
export * from '$lib/audio/episode-data';
export const podcast_time = derived([_current_time, _ended], ([$seconds, $ended]) => ({ export * from '$lib/audio/episode-details';
current_time: $seconds, export * from '$lib/audio/episode-progress';
timestamp: secondsToTimestamp($seconds),
ended: $ended,
}));
export const podcast_data: Readable<AudioLoadData> = derived(
[_src, _metadata],
([$src, $metadata]) => ({
...$metadata,
src: $src,
}),
);
export const podcast_options: Readable<AudioLoadOptions> = derived(
[_start_at, _autoplay],
([$start_at, $autoplay]) => ({
start_at: $start_at,
autoplay: $autoplay,
}),
);
export const podcast_duration = { subscribe: _duration.subscribe };
export const podcast_loading = { subscribe: _loading.subscribe };
export const podcast_paused = { subscribe: _paused.subscribe };
export const podcast_muted = { subscribe: _muted.subscribe };
type HandleType = 'toggle' | 'set';
export const podcast_audio = {
play(type: HandleType = 'set') {
info('play: ', type);
return _element.subscribe((el) => {
if (!el) return warn('no audio element');
if (type === 'toggle') {
el.paused ? el.play() : el.pause();
} else {
el.play();
}
})();
},
pause(type: HandleType = 'set') {
info('pause: ', type);
return _element.subscribe((el) => {
if (!el) return warn('no audio element');
if (type === 'toggle') {
el.paused ? el.play() : el.pause();
} else {
el.pause();
}
})();
},
mute(type: HandleType = 'set') {
info('mute: ', type);
if (type === 'toggle') {
_muted.update((muted) => !muted);
} else {
_muted.set(true);
}
},
unmute(type: HandleType = 'set') {
info('unmute: ', type);
if (type === 'toggle') {
_muted.update((muted) => !muted);
} else {
_muted.set(false);
}
},
load(data: AudioLoadData, opts: AudioLoadOptions) {
podcast_progress.stash();
const { src, ...meta } = data;
const progress = podcast_progress.use(src);
const start_at = progress?.start_at || opts.start_at || 0;
console.log('progress', progress);
info('load: ', src);
_autoplay.set(opts.autoplay);
_src.set(src);
_metadata.set(meta);
_start_at.set(start_at);
// opts.current_time ? seek(opts.current_time) : null;
//opts.autoplay && play();
},
unload() {
podcast_progress.stash();
info('unload: ');
_element.subscribe((el) => {
if (!el) return warn('no audio element');
el.pause();
})();
_autoplay.set(false);
_src.set('');
_metadata.set(null);
_start_at.set(0);
},
seek(seconds: number, from: 'from-start' | 'from-end' = 'from-start') {
info('seek: ', seconds, from);
return _element.subscribe((el) => {
if (!el) return warn('no audio element');
if (from === 'from-end') {
el.currentTime = clamp(0, el.duration, el.duration - seconds);
} else {
el.currentTime = clamp(0, el.duration, seconds);
}
})();
},
skip(seconds: number, type: 'forward' | 'backward' = 'forward') {
info('skip: ', seconds, type);
return _element.subscribe((el) => {
if (!el) return warn('no audio element');
if (type === 'backward') {
el.currentTime = clamp(0, el.duration, el.currentTime - seconds);
} else {
el.currentTime = clamp(0, el.duration, el.currentTime + seconds);
}
})();
},
};
src/lib/progress/index.ts
+16 -16
View File
@@ -1,27 +1,27 @@
import { _current_time, _src } from '$lib/audio/_private'; import { episode_audio, episode_progress } from '$lib/audio';
import { _episode_progress_map } from '$lib/progress/_private'; import { _episode_progress_map } from '$lib/progress/_private';
import type { AudioLoadOptions } from '$lib/types'; import type { AudioLoadOptions } from '$lib/types';
import { info } from '$lib/utility/package/log'; import { info } from '$lib/utility/package/log';
import { get } from 'svelte/store'; import { get } from 'svelte/store';
import { load_all, save_all } from './local-storage'; import { load_all, save_all } from './local-storage';
const get_src_pathname = (src: string) => {
if (src.startsWith('http')) return new URL(src).pathname;
else return new URL(src, 'https://svelte.dev').pathname;
};
export const podcast_progress = { export const podcast_progress = {
episodes: { data: _episode_progress_map,
set: (src: string, current_time: number) => _episode_progress_map.set(src, current_time),
get: _episode_progress_map.get,
includes: _episode_progress_map.has,
forEach: _episode_progress_map.forEach,
count: _episode_progress_map.size,
data: [..._episode_progress_map],
},
stash() { stash() {
const src = get(_src); const audio = get(episode_audio);
if (!src) return; console.log('audio', audio);
info('saving progress: ', src); if (!audio?.src) return;
podcast_progress.episodes.set(src, get(_current_time)); info('saving progress: ', audio.src);
const pathname = get_src_pathname(audio.src);
_episode_progress_map.set(pathname, get(episode_progress).current_time);
save_all(); save_all();
}, },
use(src: string): Pick<AudioLoadOptions, 'start_at'> | null { get(src: string): Pick<AudioLoadOptions, 'start_at'> | null {
const start_at = _episode_progress_map.get(src); const start_at = _episode_progress_map.get(src);
if (!start_at) return null; if (!start_at) return null;
@@ -30,8 +30,8 @@ export const podcast_progress = {
return { start_at: start_at }; return { start_at: start_at };
}, },
save_all, save: save_all,
load_all, load: load_all,
clear_all() { clear_all() {
_episode_progress_map.clear(); _episode_progress_map.clear();
save_all(); save_all();
src/lib/progress/local-storage.ts
+2
View File
@@ -12,6 +12,8 @@ export function save_all() {
} }
const items = [..._episode_progress_map]; const items = [..._episode_progress_map];
console.log('items', items);
const episodes = items.reduce((prev, [src, current_time]) => { const episodes = items.reduce((prev, [src, current_time]) => {
return [...prev, { src, current_time }]; return [...prev, { src, current_time }];
}, [] as SavedEpisodeProgress[]); }, [] as SavedEpisodeProgress[]);
src/lib/utility/use-state.ts
+2 -2
View File
@@ -2,11 +2,11 @@ import { podcast_preferences } from '$lib/preferences';
import { podcast_progress } from '$lib/progress'; import { podcast_progress } from '$lib/progress';
export function save_podcast_state() { export function save_podcast_state() {
podcast_progress.save_all(); podcast_progress.save();
podcast_preferences.save(); podcast_preferences.save();
} }
export function load_podcast_state() { export function load_podcast_state() {
podcast_progress.load_all(); podcast_progress.load();
podcast_preferences.load(); podcast_preferences.load();
} }
src/routes/+layout.svelte
+1 -1
View File
@@ -1,5 +1,5 @@
<script lang="ts"> <script lang="ts">
import { AudioLoader } from '$lib'; import { AudioLoader } from '$lib/audio';
</script> </script>
<AudioLoader /> <AudioLoader />
src/routes/+page.svelte
+23 -43
View File
@@ -1,18 +1,6 @@
<script lang="ts"> <script lang="ts">
import { import { podcast_preferences, podcast_progress, save_podcast_state } from '$lib';
podcast_audio, import { episode_audio, episode_progress } from '$lib/audio';
podcast_data,
podcast_duration,
podcast_loading,
podcast_muted,
podcast_options,
podcast_paused,
podcast_preferences,
podcast_progress,
podcast_time,
save_podcast_state,
} from '$lib';
import type { AudioLoadData } from '$lib/types';
const sources = { const sources = {
syntax: { syntax: {
@@ -25,23 +13,17 @@
title: `Empowerment starts with letting go of control`, title: `Empowerment starts with letting go of control`,
artwork: `https://ssl-static.libsyn.com/p/assets/f/a/8/d/fa8d56d5226884335f2e77a3093c12a1/ep-6.png`, artwork: `https://ssl-static.libsyn.com/p/assets/f/a/8/d/fa8d56d5226884335f2e77a3093c12a1/ep-6.png`,
}, },
} satisfies Record<string, AudioLoadData>; } as const;
let current_time = 0; let current_time = 0;
$: current_time = $podcast_time.current_time; $: current_time = $episode_progress.current_time;
</script> </script>
<pre>{JSON.stringify( <pre>{JSON.stringify(
{ {
podcast_time, $episode_audio,
podcast_data, $episode_progress,
podcast_options, $podcast_preferences,
podcast_duration,
podcast_loading,
podcast_paused,
podcast_muted,
podcast_preferences,
podcast_progress,
}, },
null, null,
3, 3,
@@ -49,51 +31,49 @@
<h1>Demo</h1> <h1>Demo</h1>
<a href="/another-page">Another Page</a> <a href="/another-page">Another Page</a>
<button type="button" on:click={podcast_progress.save_all}>Save progress</button> <button type="button" on:click={podcast_progress.save}>Save progress</button>
<button type="button" on:click={podcast_preferences.save}>Save preferences</button> <button type="button" on:click={podcast_preferences.save}>Save preferences</button>
<button type="button" on:click={save_podcast_state}>Save state (all)</button> <button type="button" on:click={save_podcast_state}>Save state (all)</button>
<h5>Load Audio</h5> <h5>Load Audio</h5>
<button <button type="button" on:click={() => episode_audio.load(sources['syntax'].src, sources['knomii'])}
type="button"
on:click={() => podcast_audio.load(sources['syntax'], { autoplay: true, start_at: 45 })}
>Syntax</button >Syntax</button
> >
<button type="button" on:click={() => podcast_audio.load(sources['knomii'], { autoplay: false })} <button type="button" on:click={() => episode_audio.load(sources['knomii'].src, sources['knomii'])}
>Knomii</button >Knomii</button
> >
<button type="button" on:click={() => podcast_audio.unload()}>None</button> <button type="button" on:click={() => episode_audio.unload()}>None</button>
<h5>Custom audio controls</h5> <h5>Custom audio controls</h5>
<h6>Play / Pause Actions</h6> <h6>Play / Pause Actions</h6>
<button type="button" on:click={() => podcast_audio.play()}>Play</button> <button type="button" on:click={() => episode_audio.play()}>Play</button>
<button type="button" on:click={() => podcast_audio.pause()}>Pause</button> <button type="button" on:click={() => episode_audio.pause()}>Pause</button>
<button type="button" on:click={() => podcast_audio.pause('toggle')}>Toggle</button> <button type="button" on:click={() => episode_audio.pause('toggle')}>Toggle</button>
<h6>Audio Actions</h6> <h6>Audio Actions</h6>
<button type="button" on:click={() => podcast_audio.mute()}>Mute</button> <button type="button" on:click={() => episode_audio.mute()}>Mute</button>
<button type="button" on:click={() => podcast_audio.unmute()}>Unmute</button> <button type="button" on:click={() => episode_audio.unmute()}>Unmute</button>
<button type="button" on:click={() => podcast_audio.mute('toggle')}>Toggle</button> <button type="button" on:click={() => episode_audio.mute('toggle')}>Toggle</button>
<h6>Seeking</h6> <h6>Seeking</h6>
<input <input
type="range" type="range"
min={0} min={0}
max={$podcast_duration} max={$episode_audio?.duration}
style="width:100%" style="width:100%"
bind:value={current_time} bind:value={current_time}
on:change={(e) => podcast_audio.seek(parseInt(e.currentTarget.value))} on:change={(e) => episode_audio.seek(parseInt(e.currentTarget.value))}
/> />
<button type="button" on:click={() => podcast_audio.seek(30)}>Go to 30s from start </button> <button type="button" on:click={() => episode_audio.seek(30)}>Go to 30s from start </button>
<button type="button" on:click={() => podcast_audio.seek(30, 'from-end')}>Go to 30s from end</button <button type="button" on:click={() => episode_audio.seek(30, 'from-end')}>Go to 30s from end</button
> >
<button type="button" on:click={() => podcast_audio.skip(10, 'forward')}>Skip 10s</button> <button type="button" on:click={() => episode_audio.skip(10, 'forward')}>Skip 10s</button>
<button type="button" on:click={() => podcast_audio.skip(10, 'backward')}>Rewind 10s</button> <button type="button" on:click={() => episode_audio.skip(10, 'backward')}>Rewind 10s</button>
<h6>Playback Rate</h6> <h6>Playback Rate</h6>
src/routes/another-page/+page.svelte
+3 -18
View File
@@ -1,14 +1,5 @@
<script lang="ts"> <script lang="ts">
import { import { episode_audio, episode_progress } from '$lib/audio';
podcast_data,
podcast_duration,
podcast_loading,
podcast_muted,
podcast_options,
podcast_paused,
podcast_preferences,
podcast_time,
} from '$lib';
</script> </script>
<h1>Demo</h1> <h1>Demo</h1>
@@ -17,14 +8,8 @@
<pre>{JSON.stringify( <pre>{JSON.stringify(
{ {
podcast_time, $episode_audio,
podcast_data, $episode_progress,
podcast_options,
podcast_duration,
podcast_loading,
podcast_paused,
podcast_muted,
podcast_preferences,
}, },
null, null,
3, 3,