pixi-effects 0.27.2 → 0.28.0

package/dist/index.d.cts

@@ -1,7 +1,7 @@
-export { A as AudioInspectOptions, a as AudioReport, b as AudioSourceReport, C as ContactSheetOptions, F as FontReport, c as FrameEvent, I as InspectOptions, d as InspectReport, e as IssueGroup, L as LayerInfo, f as LoadProgressState, g as LoadStage, h as LoaderOption, M as MotionBlurOptions, i as MotionBlurSpec, j as Movie, k as MovieErrorEvent, l as MovieOptions, O as OnionSkinOptions, P as ProgressEvent, R as RenderOptions, m as ReviewOptions, n as ReviewReport, S as SnapshotOptions, o as SoundMeasure, p as StopEvent, q as StopImage, r as StopImagesOptions, T as TimelineData, s as TimelineHtmlOptions, t as TimelineRow, u as TimelineSvgOptions, v as TimelineTransition, V as VolumeEvent, w as dismissLoader, x as failLoader, y as resolveLoader } from './Movie-CbYwTs6U.cjs';
-import { S as SequenceSpec, C as CompositionShape, I as ImageSequenceSpec, a as CameraSequenceSpec, K as Keyframe, T as TextSequenceSpec, M as MusicOptions, P as Props, b as TransitionSpec, c as CompositionSpec, d as SequenceCommon } from './types-BNVsBBZf.cjs';
-export { A as ArcShapeSpec, e as AssetSpec, f as AudioAssetSpec, g as AudioMusicSpec, h as AudioSequenceSpec, i as AudioSfxSpec, B as BlendModeName, j as ChromaKeyFilterSpec, k as CircleShapeSpec, l as CompositionSequenceSpec, m as CrossfadeTransition, n as CustomFilterSpec, D as DipTransition, o as DissolveTransition, E as EllipseShapeSpec, p as Expr, F as FilterSpec, G as GradientSpec, q as IrisTransition, L as LightSequenceSpec, r as LineShapeSpec, s as LumaTransition, t as MaskRefSpec, u as MatteRefSpec, v as MusicDrum, w as MusicDrums, x as MusicInstrument, y as MusicLevel, z as MusicTrack, N as NullSequenceSpec, H as PathShapeSpec, J as PolygonShapeSpec, O as PropValue, R as RectShapeSpec, Q as SfxKnobs, U as SfxOptions, V as SfxPreset, W as SfxVoice, X as ShaderSequenceSpec, Y as ShapeSequenceSpec, Z as SlideTransition, _ as Stop, $ as StopSpec, a0 as TransitionCommon, a1 as VideoSequenceSpec, a2 as WipeTransition, a3 as ZoomTransition, a4 as normalizeStops, a5 as pictureStops } from './types-BNVsBBZf.cjs';
-import { S as Sequence } from './Base-DjhdL8B1.cjs';
+export { A as AudioInspectOptions, a as AudioReport, b as AudioSourceReport, C as ContactSheetOptions, F as FontReport, c as FrameEvent, I as InspectOptions, d as InspectReport, e as IssueGroup, L as LayerInfo, f as LoadProgressState, g as LoadStage, h as LoaderOption, M as MotionBlurOptions, i as MotionBlurSpec, j as Movie, k as MovieErrorEvent, l as MovieOptions, O as OnionSkinOptions, P as ProgressEvent, R as RenderOptions, m as ReviewOptions, n as ReviewReport, S as SnapshotOptions, o as SoundMeasure, p as StopEvent, q as StopImage, r as StopImagesOptions, T as TimelineData, s as TimelineHtmlOptions, t as TimelineRow, u as TimelineSvgOptions, v as TimelineTransition, V as VolumeEvent, w as dismissLoader, x as failLoader, y as resolveLoader } from './Movie-Cx5ozUGb.cjs';
+import { S as SequenceSpec, C as CompositionShape, I as ImageSequenceSpec, a as CameraSequenceSpec, K as Keyframe, T as TextSequenceSpec, M as MusicOptions, b as MusicEvents, P as Props, c as TransitionSpec, d as CompositionSpec, e as SequenceCommon } from './types-DpK1vwcl.cjs';
+export { A as ArcShapeSpec, f as AssetSpec, g as AudioAssetSpec, h as AudioMusicSpec, i as AudioSequenceSpec, j as AudioSfxSpec, B as BlendModeName, k as ChromaKeyFilterSpec, l as CircleShapeSpec, m as CompositionSequenceSpec, n as CrossfadeTransition, o as CustomFilterSpec, D as DipTransition, p as DissolveTransition, E as EllipseShapeSpec, q as Expr, F as FilterSpec, G as GradientSpec, r as IrisTransition, L as LightSequenceSpec, s as LineShapeSpec, t as LumaTransition, u as MaskRefSpec, v as MatteRefSpec, w as MusicDrum, x as MusicDrumEvents, y as MusicDrumHit, z as MusicDrums, H as MusicInstrument, J as MusicLevel, N as MusicNote, O as MusicSummary, Q as MusicTrack, R as MusicTrackEvents, U as NullSequenceSpec, V as PathShapeSpec, W as PolygonShapeSpec, X as PropValue, Y as RectShapeSpec, Z as SfxKnobs, _ as SfxOptions, $ as SfxPreset, a0 as SfxVoice, a1 as ShaderSequenceSpec, a2 as ShapeSequenceSpec, a3 as SlideTransition, a4 as Stop, a5 as StopSpec, a6 as TransitionCommon, a7 as VideoSequenceSpec, a8 as WipeTransition, a9 as ZoomTransition, aa as normalizeStops, ab as pictureStops } from './types-DpK1vwcl.cjs';
+import { S as Sequence } from './Base-DI1FCGcH.cjs';
 import 'pixi.js';
 
 /** A text style as written in a `text` layer's `style` (numbers, not expressions, for the fields that size the text). */
@@ -587,6 +587,20 @@ declare function musicBuffer(music: MusicOptions, options?: {
     loop?: boolean;
 }): Promise<AudioBuffer>;
 
+/**
+ * What a `music` score plays, as data: every note and chord with its beat, time, bar, pitches and name, and every drum hit. Use it to make the
+ * picture follow the score (light the keys that sound, show the chord name, flash on the snare) without analysing the audio. Do it before
+ * `movie.init`, with the same `music` object the layer uses:
+ *
+ * ```js
+ * const ev = await musicEvents(music);
+ * ev.tracks[0].notes;      // [{ beat: 0, time: 0, duration: 4, bar: 1, name: 'Am7', midi: [57, 60, 64, 67], ... }, ...]
+ * ev.drums[0].hits;        // [{ beat: 0, time: 0, ... }]  (kind: 'kick')
+ * ```
+ * Swing and humanize are not applied: the times are the written ones. A score that cannot play throws, with the reason.
+ */
+declare function musicEvents(music: MusicOptions): Promise<MusicEvents>;
+
 interface DeckPage {
     /** The page's name: shown by the Presenter, and in the stops list. */
     name?: string;
@@ -718,4 +732,4 @@ interface WithFadeOptions {
  */
 declare function withFade<T extends SequenceCommon>(spec: T, opts: WithFadeOptions): T;
 
-export { type AnimateTextOptions, type AnimateTextTween, type AudioEnvelope, type AudioEnvelopeSource, type CameraPathOptions, CameraSequenceSpec, CompositionSpec, type DeckOptions, type DeckPage, type DeckResult, type DeckTransition, type EnvelopeOptions, type FollowPathOptions, ImageSequenceSpec, type KenBurnsOptions, Keyframe, type MeasureStyle, MusicOptions, type OrbitOptions, type ParticlesOptions, Props, type ReactOptions, type ReactProp, SequenceCommon, type SequenceCtor, SequenceSpec, type SplitOptions, type StaggerOptions, type TextPiece, type TextPreset, TextSequenceSpec, type TextSize, TransitionSpec, type WiggleOptions, type WiggleProp, type WithFadeOptions, animateText, audioEnvelope, bpmEnvelope, cameraPath, computeEnvelope, deck, parseEase as ease, followPath, kenBurns, measureText, musicBuffer, musicEnvelope, noise, orbit, particles, rand, random, react, registerSequenceType, splitText, stagger, wiggle, withFade };
+export { type AnimateTextOptions, type AnimateTextTween, type AudioEnvelope, type AudioEnvelopeSource, type CameraPathOptions, CameraSequenceSpec, CompositionShape, CompositionSpec, type DeckOptions, type DeckPage, type DeckResult, type DeckTransition, type EnvelopeOptions, type FollowPathOptions, ImageSequenceSpec, type KenBurnsOptions, Keyframe, type MeasureStyle, MusicEvents, MusicOptions, type OrbitOptions, type ParticlesOptions, Props, type ReactOptions, type ReactProp, Sequence, SequenceCommon, type SequenceCtor, SequenceSpec, type SplitOptions, type StaggerOptions, type TextPiece, type TextPreset, TextSequenceSpec, type TextSize, TransitionSpec, type WiggleOptions, type WiggleProp, type WithFadeOptions, animateText, audioEnvelope, bpmEnvelope, cameraPath, computeEnvelope, deck, parseEase as ease, followPath, kenBurns, measureText, musicBuffer, musicEnvelope, musicEvents, noise, orbit, particles, rand, random, react, registerSequenceType, splitText, stagger, wiggle, withFade };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-export { A as AudioInspectOptions, a as AudioReport, b as AudioSourceReport, C as ContactSheetOptions, F as FontReport, c as FrameEvent, I as InspectOptions, d as InspectReport, e as IssueGroup, L as LayerInfo, f as LoadProgressState, g as LoadStage, h as LoaderOption, M as MotionBlurOptions, i as MotionBlurSpec, j as Movie, k as MovieErrorEvent, l as MovieOptions, O as OnionSkinOptions, P as ProgressEvent, R as RenderOptions, m as ReviewOptions, n as ReviewReport, S as SnapshotOptions, o as SoundMeasure, p as StopEvent, q as StopImage, r as StopImagesOptions, T as TimelineData, s as TimelineHtmlOptions, t as TimelineRow, u as TimelineSvgOptions, v as TimelineTransition, V as VolumeEvent, w as dismissLoader, x as failLoader, y as resolveLoader } from './Movie-ILKq2fw_.js';
-import { S as SequenceSpec, C as CompositionShape, I as ImageSequenceSpec, a as CameraSequenceSpec, K as Keyframe, T as TextSequenceSpec, M as MusicOptions, P as Props, b as TransitionSpec, c as CompositionSpec, d as SequenceCommon } from './types-BNVsBBZf.js';
-export { A as ArcShapeSpec, e as AssetSpec, f as AudioAssetSpec, g as AudioMusicSpec, h as AudioSequenceSpec, i as AudioSfxSpec, B as BlendModeName, j as ChromaKeyFilterSpec, k as CircleShapeSpec, l as CompositionSequenceSpec, m as CrossfadeTransition, n as CustomFilterSpec, D as DipTransition, o as DissolveTransition, E as EllipseShapeSpec, p as Expr, F as FilterSpec, G as GradientSpec, q as IrisTransition, L as LightSequenceSpec, r as LineShapeSpec, s as LumaTransition, t as MaskRefSpec, u as MatteRefSpec, v as MusicDrum, w as MusicDrums, x as MusicInstrument, y as MusicLevel, z as MusicTrack, N as NullSequenceSpec, H as PathShapeSpec, J as PolygonShapeSpec, O as PropValue, R as RectShapeSpec, Q as SfxKnobs, U as SfxOptions, V as SfxPreset, W as SfxVoice, X as ShaderSequenceSpec, Y as ShapeSequenceSpec, Z as SlideTransition, _ as Stop, $ as StopSpec, a0 as TransitionCommon, a1 as VideoSequenceSpec, a2 as WipeTransition, a3 as ZoomTransition, a4 as normalizeStops, a5 as pictureStops } from './types-BNVsBBZf.js';
-import { S as Sequence } from './Base-CKGl6jCo.js';
+export { A as AudioInspectOptions, a as AudioReport, b as AudioSourceReport, C as ContactSheetOptions, F as FontReport, c as FrameEvent, I as InspectOptions, d as InspectReport, e as IssueGroup, L as LayerInfo, f as LoadProgressState, g as LoadStage, h as LoaderOption, M as MotionBlurOptions, i as MotionBlurSpec, j as Movie, k as MovieErrorEvent, l as MovieOptions, O as OnionSkinOptions, P as ProgressEvent, R as RenderOptions, m as ReviewOptions, n as ReviewReport, S as SnapshotOptions, o as SoundMeasure, p as StopEvent, q as StopImage, r as StopImagesOptions, T as TimelineData, s as TimelineHtmlOptions, t as TimelineRow, u as TimelineSvgOptions, v as TimelineTransition, V as VolumeEvent, w as dismissLoader, x as failLoader, y as resolveLoader } from './Movie-CHcM8HNB.js';
+import { S as SequenceSpec, C as CompositionShape, I as ImageSequenceSpec, a as CameraSequenceSpec, K as Keyframe, T as TextSequenceSpec, M as MusicOptions, b as MusicEvents, P as Props, c as TransitionSpec, d as CompositionSpec, e as SequenceCommon } from './types-DpK1vwcl.js';
+export { A as ArcShapeSpec, f as AssetSpec, g as AudioAssetSpec, h as AudioMusicSpec, i as AudioSequenceSpec, j as AudioSfxSpec, B as BlendModeName, k as ChromaKeyFilterSpec, l as CircleShapeSpec, m as CompositionSequenceSpec, n as CrossfadeTransition, o as CustomFilterSpec, D as DipTransition, p as DissolveTransition, E as EllipseShapeSpec, q as Expr, F as FilterSpec, G as GradientSpec, r as IrisTransition, L as LightSequenceSpec, s as LineShapeSpec, t as LumaTransition, u as MaskRefSpec, v as MatteRefSpec, w as MusicDrum, x as MusicDrumEvents, y as MusicDrumHit, z as MusicDrums, H as MusicInstrument, J as MusicLevel, N as MusicNote, O as MusicSummary, Q as MusicTrack, R as MusicTrackEvents, U as NullSequenceSpec, V as PathShapeSpec, W as PolygonShapeSpec, X as PropValue, Y as RectShapeSpec, Z as SfxKnobs, _ as SfxOptions, $ as SfxPreset, a0 as SfxVoice, a1 as ShaderSequenceSpec, a2 as ShapeSequenceSpec, a3 as SlideTransition, a4 as Stop, a5 as StopSpec, a6 as TransitionCommon, a7 as VideoSequenceSpec, a8 as WipeTransition, a9 as ZoomTransition, aa as normalizeStops, ab as pictureStops } from './types-DpK1vwcl.js';
+import { S as Sequence } from './Base-C6f0fE8j.js';
 import 'pixi.js';
 
 /** A text style as written in a `text` layer's `style` (numbers, not expressions, for the fields that size the text). */
@@ -587,6 +587,20 @@ declare function musicBuffer(music: MusicOptions, options?: {
     loop?: boolean;
 }): Promise<AudioBuffer>;
 
+/**
+ * What a `music` score plays, as data: every note and chord with its beat, time, bar, pitches and name, and every drum hit. Use it to make the
+ * picture follow the score (light the keys that sound, show the chord name, flash on the snare) without analysing the audio. Do it before
+ * `movie.init`, with the same `music` object the layer uses:
+ *
+ * ```js
+ * const ev = await musicEvents(music);
+ * ev.tracks[0].notes;      // [{ beat: 0, time: 0, duration: 4, bar: 1, name: 'Am7', midi: [57, 60, 64, 67], ... }, ...]
+ * ev.drums[0].hits;        // [{ beat: 0, time: 0, ... }]  (kind: 'kick')
+ * ```
+ * Swing and humanize are not applied: the times are the written ones. A score that cannot play throws, with the reason.
+ */
+declare function musicEvents(music: MusicOptions): Promise<MusicEvents>;
+
 interface DeckPage {
     /** The page's name: shown by the Presenter, and in the stops list. */
     name?: string;
@@ -718,4 +732,4 @@ interface WithFadeOptions {
  */
 declare function withFade<T extends SequenceCommon>(spec: T, opts: WithFadeOptions): T;
 
-export { type AnimateTextOptions, type AnimateTextTween, type AudioEnvelope, type AudioEnvelopeSource, type CameraPathOptions, CameraSequenceSpec, CompositionSpec, type DeckOptions, type DeckPage, type DeckResult, type DeckTransition, type EnvelopeOptions, type FollowPathOptions, ImageSequenceSpec, type KenBurnsOptions, Keyframe, type MeasureStyle, MusicOptions, type OrbitOptions, type ParticlesOptions, Props, type ReactOptions, type ReactProp, SequenceCommon, type SequenceCtor, SequenceSpec, type SplitOptions, type StaggerOptions, type TextPiece, type TextPreset, TextSequenceSpec, type TextSize, TransitionSpec, type WiggleOptions, type WiggleProp, type WithFadeOptions, animateText, audioEnvelope, bpmEnvelope, cameraPath, computeEnvelope, deck, parseEase as ease, followPath, kenBurns, measureText, musicBuffer, musicEnvelope, noise, orbit, particles, rand, random, react, registerSequenceType, splitText, stagger, wiggle, withFade };
+export { type AnimateTextOptions, type AnimateTextTween, type AudioEnvelope, type AudioEnvelopeSource, type CameraPathOptions, CameraSequenceSpec, CompositionShape, CompositionSpec, type DeckOptions, type DeckPage, type DeckResult, type DeckTransition, type EnvelopeOptions, type FollowPathOptions, ImageSequenceSpec, type KenBurnsOptions, Keyframe, type MeasureStyle, MusicEvents, MusicOptions, type OrbitOptions, type ParticlesOptions, Props, type ReactOptions, type ReactProp, Sequence, SequenceCommon, type SequenceCtor, SequenceSpec, type SplitOptions, type StaggerOptions, type TextPiece, type TextPreset, TextSequenceSpec, type TextSize, TransitionSpec, type WiggleOptions, type WiggleProp, type WithFadeOptions, animateText, audioEnvelope, bpmEnvelope, cameraPath, computeEnvelope, deck, parseEase as ease, followPath, kenBurns, measureText, musicBuffer, musicEnvelope, musicEvents, noise, orbit, particles, rand, random, react, registerSequenceType, splitText, stagger, wiggle, withFade };

package/dist/index.js

@@ -1,6 +1,6 @@
-import { CompositionSequence, maskSourceOf } from './chunk-K3F2YKL4.js';
-import { createTimeline, lengthen, ensureFilterLibrary, checkEase, parseEase, homeDistance, DEFAULT_FOV, random, noise, flattenSvgPath, rand, DEG, timeRemapOf, contentLength, resolveAt } from './chunk-BQNNZEAX.js';
-export { noise, rand, random, registerSequenceType } from './chunk-BQNNZEAX.js';
+import { CompositionSequence, maskSourceOf } from './chunk-WEJAQAFX.js';
+import { createTimeline, lengthen, ensureFilterLibrary, checkEase, parseEase, homeDistance, DEFAULT_FOV, random, noise, flattenSvgPath, rand, DEG, timeRemapOf, contentLength, resolveAt } from './chunk-AK54FIWM.js';
+export { Sequence, noise, rand, random, registerSequenceType } from './chunk-AK54FIWM.js';
 import { usesAdvancedBlend, enableAdvancedBlend } from './chunk-TYWFKCPY.js';
 import { collectPropKeys } from './chunk-45QKLD6M.js';
 import { warnUnknownOptions, suggestName } from './chunk-BXOCEZ4U.js';
@@ -498,7 +498,7 @@ function analyzeAudio(mix, sources, stats, movieDuration, opts = {}) {
         issues.push(`${layer} (${source}) is cut off by the end of the movie at ${movieDuration}s (it runs to ${s.end.toFixed(2)}s)`);
       }
     }
-    return { layer, source, start: s.start, end: s.end, peakDb, sound };
+    return { layer, source, start: s.start, end: s.end, peakDb, sound, ...s.music ? { music: s.music } : {} };
   });
   const whole = measureLoudness(chans, sr);
   const silences = findSilences(chans, sr, { minLength: 1 });
@@ -4332,7 +4332,7 @@ async function audioEnvelope(source, options = {}) {
 
 // src/audio/musicEnvelope.ts
 async function musicEnvelope(music, options = {}) {
-  const { resolveMusic, renderMusic, musicLength, musicBeatTimes, TempoMap } = await import('./music-72YJAMXH.js');
+  const { resolveMusic, renderMusic, musicLength, musicBeatTimes, TempoMap } = await import('./music-JKOM5YK6.js');
   const messages = [];
   const m = resolveMusic(music, "musicEnvelope()", (msg) => messages.push(msg));
   if (!m) throw new Error(`pixi-effects: musicEnvelope(): ${messages.join(" ") || "the music has nothing to play"}`);
@@ -4345,7 +4345,7 @@ async function musicEnvelope(music, options = {}) {
 
 // src/audio/musicBuffer.ts
 async function musicBuffer(music, options = {}) {
-  const { resolveMusic, renderMusic, musicLength } = await import('./music-72YJAMXH.js');
+  const { resolveMusic, renderMusic, musicLength } = await import('./music-JKOM5YK6.js');
   const messages = [];
   const m = resolveMusic(music, "musicBuffer()", (msg) => messages.push(msg));
   if (!m) throw new Error(`pixi-effects: musicBuffer(): ${messages.join(" ") || "the music has nothing to play"}`);
@@ -4360,6 +4360,17 @@ async function musicBuffer(music, options = {}) {
   return buffer;
 }
 
+// src/audio/musicEvents.ts
+async function musicEvents(music) {
+  const { resolveMusic } = await import('./music-JKOM5YK6.js');
+  const { describeEvents } = await import('./events-KXBWR4IV.js');
+  const messages = [];
+  const m = resolveMusic(music, "musicEvents()", (msg) => messages.push(msg));
+  if (!m) throw new Error(`pixi-effects: musicEvents(): ${messages.join(" ") || "the music has nothing to play"}`);
+  for (const msg of messages) console.warn(msg);
+  return describeEvents(m);
+}
+
 // src/presets/deck.ts
 var PAGE_KEYS = ["name", "duration", "sequences", "stops", "notes", "advance", "initial", "keyframes", "filters", "filterArea", "blendMode", "mask", "maskInverted"];
 var DECK_KEYS = ["pages", "transition", "width", "height", "frameRate", "background", "canvas", "assets", "poster", "motionBlur", "loader"];
@@ -4441,6 +4452,6 @@ function withFade(spec, opts) {
   return spec;
 }
 
-export { Movie, animateText, audioEnvelope, bpmEnvelope, cameraPath, computeEnvelope, deck, dismissLoader, parseEase2 as ease, failLoader, followPath, kenBurns, measureText, musicBuffer, musicEnvelope, normalizeStops, orbit, particles, pictureStops, react, resolveLoader, splitText, stagger, wiggle, withFade };
+export { Movie, animateText, audioEnvelope, bpmEnvelope, cameraPath, computeEnvelope, deck, dismissLoader, parseEase2 as ease, failLoader, followPath, kenBurns, measureText, musicBuffer, musicEnvelope, musicEvents, normalizeStops, orbit, particles, pictureStops, react, resolveLoader, splitText, stagger, wiggle, withFade };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map