@banou/media-player 0.10.0 → 0.10.1

package/README.md

@@ -150,10 +150,39 @@ chrome at once.
 
 ## What it does
 
-Play and pause, seek with a preview thumbnail and a keyframe-accurate scrub, volume on a log curve,
-mute, playback speed, audio track selection, subtitle track selection, picture in picture, fullscreen,
-and keyboard shortcuts. Nothing is persisted: volume, speed and track choices start at their defaults
-every load.
+Play and pause, seek with a preview thumbnail and a keyframe-accurate scrub, chapters on the seekbar,
+an offer to skip an opening or ending, volume on a log curve, mute, playback speed, audio track
+selection, subtitle track selection, picture in picture, fullscreen, and keyboard shortcuts. Nothing
+is persisted: volume, speed and track choices start at their defaults every load.
+
+### Chapters
+
+Chapters come from the container, and the seekbar draws them as segments with a break at each
+boundary. Hovering one lifts it above its neighbours and names it beside the time in the preview.
+
+Pass `chapters` to supply them yourself, on either arm, and they win over whatever the file declared:
+
+```tsx
+<MediaPlayer {...source} chapters={[{ start: 0, end: 88, title: 'Opening' }]} />
+```
+
+They are `{ start, end, title }` in seconds, ordered and non-overlapping, and they need not cover the
+whole duration. A local file gets them from libav automatically, so this is for a source that knows
+chapters the container does not.
+
+### Skip Opening and Skip Ending
+
+When a chapter looks like an opening or an ending, a button offers to jump past it, appearing a
+second before the chapter and staying six seconds. It never skips on its own, so a wrong guess costs
+a button nobody presses rather than a jump out of the episode.
+
+The guess is made from the chapter title, against the names releases actually use (`OP`, `Opening`,
+`ED`, `Ending`, `Credits`, and the same names carrying a song), and it defers across the whole file:
+`Intro` is the opening where nothing else claims to be, and the cold open where an `OP` follows it.
+A file whose chapters carry no usable name at all falls back to shape, where a chapter of about
+ninety seconds in each half of the runtime is the opening and the ending. Nothing shorter than
+fifteen seconds is ever offered, and a disc that is mostly themes offers nothing, because there the
+themes are what is being watched.
 
 ### Picture in picture keeps the subtitles
 

package/dist/engine/index.d.ts

@@ -1,5 +1,5 @@
 export { startPlayback, terminateRemuxer, MediaElementError, isMediaElementError, DEFAULT_BUFFER_SIZE } from './playback';
-export type { PlaybackOptions, PlaybackController, MediaIndex, AudioStream } from './playback';
+export type { PlaybackOptions, PlaybackController, MediaIndex, MediaChapter, AudioStream } from './playback';
 export { createSubtitleRenderer, SUBTITLES_OFF } from './subtitles';
 export type { SubtitleRenderer, SubtitleRendererOptions, SubtitleStream } from './subtitles';
 export { createThumbnailGenerator } from './thumbnails';

package/dist/engine/index.js

@@ -1,2 +1,2 @@
-import { a as e, c as t, d as n, f as r, i, l as a, n as o, o as s, r as c, s as l, t as u, u as d } from "../engine-YeMWShCv.js";
+import { a as e, c as t, d as n, f as r, i, l as a, n as o, o as s, r as c, s as l, t as u, u as d } from "../engine-b5_5HscR.js";
 export { i as DEFAULT_BUFFER_SIZE, e as MediaElementError, a as SUBTITLES_OFF, u as createPictureInPicture, d as createSubtitleRenderer, c as createThumbnailGenerator, n as getTimeRanges, s as isMediaElementError, o as pictureInPictureMode, l as startPlayback, t as terminateRemuxer, r as updateSourceBuffer };

package/dist/engine/playback.d.ts

@@ -6,6 +6,21 @@ export type MediaIndex = {
     pos: number;
     timestamp: number;
 };
+/**
+ * One named span of the timeline, in SECONDS.
+ *
+ * Chapters are not required to tile the duration: a container routinely declares a last chapter that
+ * ends fractionally before the file does, and nothing guarantees the first starts at zero. Anything
+ * drawing them has to treat the gaps as ordinary un-named time rather than assume full cover.
+ *
+ * libav also reports an `index`, dropped here the way `MediaIndex` drops it: array position already
+ * carries it, and a caller supplying their own chapters should not have to number them.
+ */
+export type MediaChapter = {
+    start: number;
+    end: number;
+    title: string;
+};
 export type PlaybackOptions = {
     videoElement: HTMLVideoElement;
     /**
@@ -49,6 +64,8 @@ export type PlaybackController = {
     selectSubtitleStream: (streamIndex: number | undefined) => void;
     /** Keyframe index of the input, which is what maps a downloaded byte range onto the timeline. */
     indexes: MediaIndex[];
+    /** Named spans the container declared, empty when it declared none. */
+    chapters: MediaChapter[];
     duration: number;
     videoMimeType: string;
     audioMimeType: string;

package/dist/{engine-YeMWShCv.js → engine-b5_5HscR.js}

@@ -374,6 +374,7 @@ var i = (e) => Array(e.buffered.length).fill(void 0).map((t, n) => ({
 			videoElement: n,
 			selectSubtitleStream: (e) => s.selectStream(e),
 			indexes: e.indexes ?? [],
+			chapters: e.chapters ?? [],
 			duration: e.info.input.duration,
 			videoMimeType: e.info.output.videoMimeType,
 			audioMimeType: e.info.output.audioMimeType

package/dist/index.d.ts

@@ -10,5 +10,5 @@ export { useSeekThumbnails } from './react/hooks/use-thumbnails';
 export { usePictureInPicture } from './react/hooks/use-picture-in-picture';
 export { inputToRemuxerInput } from './utils/source';
 export type { RemuxerInput } from './utils/source';
-export type { AudioStream, MediaIndex, PictureInPictureController, PlaybackController, PlaybackOptions, SubtitleStream, ThumbnailImage, } from './engine';
+export type { AudioStream, MediaChapter, MediaIndex, PictureInPictureController, PlaybackController, PlaybackOptions, SubtitleStream, ThumbnailImage, } from './engine';
 export { startPlayback, createThumbnailGenerator, createSubtitleRenderer, createPictureInPicture, SUBTITLES_OFF, } from './engine';