pixi-effects 0.16.0 → 0.16.1

package/dist/index.d.cts

@@ -536,6 +536,23 @@ declare function react(env: AudioEnvelope, options: ReactOptions): Keyframe[];
  */
 declare function musicEnvelope(music: MusicOptions, options?: EnvelopeOptions): Promise<AudioEnvelope>;
 
+/**
+ * The sound of `music` as a Web Audio `AudioBuffer` you can play yourself (a music box page, a jingle on a button, your own player):
+ *
+ * ```js
+ * const buffer = await musicBuffer({ bpm: 96, tracks: [{ inst: 'keys', notes: 'Cmaj7:4 Am7:4' }] });
+ * const src = audioContext.createBufferSource(); src.buffer = buffer; src.connect(audioContext.destination); src.start();
+ * ```
+ *
+ * `sampleRate` defaults to 44100; `duration` (seconds) cuts it or, with `loop: true`, repeats the music up to it. Warnings are printed
+ * like for an audio layer; throws, saying why, when the score cannot play (no `bpm`, no notes). Async: the synthesiser is its own chunk.
+ */
+declare function musicBuffer(music: MusicOptions, options?: {
+    sampleRate?: number;
+    duration?: number;
+    loop?: boolean;
+}): Promise<AudioBuffer>;
+
 interface DeckPage {
     /** The page's name: shown by the Presenter, and in the stops list. */
     name?: string;
@@ -667,4 +684,4 @@ interface WithFadeOptions {
  */
 declare function withFade<T extends SequenceCommon>(spec: T, opts: WithFadeOptions): T;
 
-export { type AnimateTextOptions, type AnimateTextTween, type AudioEnvelope, type AudioEnvelopeSource, 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, computeEnvelope, deck, followPath, kenBurns, measureText, musicEnvelope, noise, orbit, particles, rand, random, react, registerSequenceType, splitText, stagger, wiggle, withFade };
+export { type AnimateTextOptions, type AnimateTextTween, type AudioEnvelope, type AudioEnvelopeSource, 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, computeEnvelope, deck, followPath, kenBurns, measureText, musicBuffer, musicEnvelope, noise, orbit, particles, rand, random, react, registerSequenceType, splitText, stagger, wiggle, withFade };

package/dist/index.d.ts

@@ -536,6 +536,23 @@ declare function react(env: AudioEnvelope, options: ReactOptions): Keyframe[];
  */
 declare function musicEnvelope(music: MusicOptions, options?: EnvelopeOptions): Promise<AudioEnvelope>;
 
+/**
+ * The sound of `music` as a Web Audio `AudioBuffer` you can play yourself (a music box page, a jingle on a button, your own player):
+ *
+ * ```js
+ * const buffer = await musicBuffer({ bpm: 96, tracks: [{ inst: 'keys', notes: 'Cmaj7:4 Am7:4' }] });
+ * const src = audioContext.createBufferSource(); src.buffer = buffer; src.connect(audioContext.destination); src.start();
+ * ```
+ *
+ * `sampleRate` defaults to 44100; `duration` (seconds) cuts it or, with `loop: true`, repeats the music up to it. Warnings are printed
+ * like for an audio layer; throws, saying why, when the score cannot play (no `bpm`, no notes). Async: the synthesiser is its own chunk.
+ */
+declare function musicBuffer(music: MusicOptions, options?: {
+    sampleRate?: number;
+    duration?: number;
+    loop?: boolean;
+}): Promise<AudioBuffer>;
+
 interface DeckPage {
     /** The page's name: shown by the Presenter, and in the stops list. */
     name?: string;
@@ -667,4 +684,4 @@ interface WithFadeOptions {
  */
 declare function withFade<T extends SequenceCommon>(spec: T, opts: WithFadeOptions): T;
 
-export { type AnimateTextOptions, type AnimateTextTween, type AudioEnvelope, type AudioEnvelopeSource, 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, computeEnvelope, deck, followPath, kenBurns, measureText, musicEnvelope, noise, orbit, particles, rand, random, react, registerSequenceType, splitText, stagger, wiggle, withFade };
+export { type AnimateTextOptions, type AnimateTextTween, type AudioEnvelope, type AudioEnvelopeSource, 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, computeEnvelope, deck, followPath, kenBurns, measureText, musicBuffer, musicEnvelope, noise, orbit, particles, rand, random, react, registerSequenceType, splitText, stagger, wiggle, withFade };

package/dist/index.js

@@ -3249,6 +3249,23 @@ async function musicEnvelope(music, options = {}) {
   return { ...env, beats: musicBeatTimes(m, env.duration), bpm: Math.round(new TempoMap(m.tempo).bpmAt(0) * 100) / 100 };
 }
 
+// src/audio/musicBuffer.ts
+async function musicBuffer(music, options = {}) {
+  const { resolveMusic, renderMusic, musicLength } = await import('./music-4HDFULNR.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"}`);
+  for (const msg of messages) console.warn(msg);
+  const sampleRate = options.sampleRate ?? 44100;
+  const length = options.duration ?? musicLength(m);
+  if (!(Number.isFinite(length) && length > 0)) throw new Error(`pixi-effects: musicBuffer(): duration must be a positive number of seconds, got ${String(options.duration)}`);
+  const [left, right] = renderMusic(m, sampleRate, length, !!options.loop);
+  const buffer = typeof AudioBuffer === "function" ? new AudioBuffer({ length: left.length, sampleRate, numberOfChannels: 2 }) : new OfflineAudioContext(2, left.length, sampleRate).createBuffer(2, left.length, sampleRate);
+  buffer.copyToChannel(left, 0);
+  buffer.copyToChannel(right, 1);
+  return buffer;
+}
+
 // 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"];
@@ -3330,6 +3347,6 @@ function withFade(spec, opts) {
   return spec;
 }
 
-export { Movie, animateText, audioEnvelope, bpmEnvelope, computeEnvelope, deck, dismissLoader, failLoader, followPath, kenBurns, measureText, musicEnvelope, normalizeStops, orbit, particles, pictureStops, react, resolveLoader, splitText, stagger, wiggle, withFade };
+export { Movie, animateText, audioEnvelope, bpmEnvelope, computeEnvelope, deck, dismissLoader, failLoader, followPath, kenBurns, measureText, musicBuffer, musicEnvelope, normalizeStops, orbit, particles, pictureStops, react, resolveLoader, splitText, stagger, wiggle, withFade };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map