@omnimedia/omnitool 1.1.0-104 → 1.1.0-105

package/README.md

@@ -56,6 +56,17 @@ const timeline = omni.timeline(o => {
 })
 ```
 
+You can label your items:
+
+```ts
+const visual = o.sequence(
+	"Main sequence",
+	o.video(clip, {label: "Intro"}),
+	o.transition.fade(500, {label: "Fade"}),
+	o.text("Hello world", {label: "Title"})
+)
+```
+
 Declarative helper style (no explicit `o` in timeline declarations):
 
 ```ts

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@omnimedia/omnitool",
-	"version": "1.1.0-104",
+	"version": "1.1.0-105",
 	"description": "open source video processing tools",
 	"license": "MIT",
 	"author": "Przemysław Gałęzki",

package/s/timeline/parts/captions.ts

@@ -5,6 +5,7 @@ import {TransformOptions, Vec2} from "../types.js"
 import {Transcription, TranscriptSegment} from "../../features/speech/transcribe/types.js"
 
 export type CaptionOptions = {
+	label?: string
 	itemId?: Item.Caption["itemId"]
 	start?: number
 	duration?: number

package/s/timeline/parts/item.ts

@@ -26,6 +26,10 @@ export enum Kind {
 	Image
 }
 
+export type ItemMeta = {
+	label?: string
+}
+
 export namespace Item {
 	export type TextStyle = {
 		id: Id
@@ -60,7 +64,7 @@ export namespace Item {
 		id: Id
 		kind: Kind.Gap
 		duration: number
-	}
+	} & ItemMeta
 
 	export type Sequence = {
 		id: Id
@@ -68,7 +72,7 @@ export namespace Item {
 		childrenIds: Id[]
 		spatialId?: Id
 		filterIds?: Id[]
-	}
+	} & ItemMeta
 
 	export type Stack = {
 		id: Id
@@ -76,7 +80,7 @@ export namespace Item {
 		childrenIds: Id[]
 		spatialId?: Id
 		filterIds?: Id[]
-	}
+	} & ItemMeta
 
 	export type Video = {
 		id: Id
@@ -87,7 +91,7 @@ export namespace Item {
 		spatialId?: Id
 		animationIds?: Id[]
 		filterIds?: Id[]
-	}
+	} & ItemMeta
 
 	export type Image = {
 		id: Id
@@ -97,7 +101,7 @@ export namespace Item {
 		spatialId?: Id
 		animationIds?: Id[]
 		filterIds?: Id[]
-	}
+	} & ItemMeta
 
 	export type Audio = {
 		id: Id
@@ -106,7 +110,7 @@ export namespace Item {
 		start: number
 		duration: number
 		gain?: number
-	}
+	} & ItemMeta
 
 	export type Text = {
 		id: Id
@@ -117,7 +121,7 @@ export namespace Item {
 		animationIds?: Id[]
 		styleId?: Id
 		filterIds?: Id[]
-	}
+	} & ItemMeta
 
 
 	export type Caption = {
@@ -134,14 +138,14 @@ export namespace Item {
 		animationIds?: Id[]
 		styleId?: Id
 		filterIds?: Id[]
-	}
+	} & ItemMeta
 
 	export type Transition = {
 		id: Id
 		kind: Kind.Transition
 		name: TransitionName
 		duration: number
-	}
+	} & ItemMeta
 
 	export type Any = (
 		| Sequence

package/s/timeline/parts/transitions.ts

@@ -1,4 +1,4 @@
-import type {Item} from "./item.js"
+import type {Item, ItemMeta} from "./item.js"
 
 export const transitionNames = [
 	"Bounce",
@@ -78,7 +78,7 @@ export type Transition = {
 }
 
 export interface TransitionAction {
-	(duration: number): Item.Transition
+	(duration: number, options?: ItemMeta): Item.Transition
 }
 
 export type TransitionActions = {

package/s/timeline/sugar/helpers.ts

@@ -10,7 +10,7 @@ import {filters, FilterParams, FilterType} from "../parts/filters.js"
 import {CaptionOptions, CaptionSourceItem} from "../parts/captions.js"
 import {Transcription} from "../../features/speech/transcribe/types.js"
 import {AnimationPreset, PresetOptions} from "../parts/animations/types.js"
-import {Crop, FilterableItem, Item, VisualAnimatableItem} from "../parts/item.js"
+import {Crop, FilterableItem, Item, ItemMeta, VisualAnimatableItem} from "../parts/item.js"
 import {animationPresets, visualAnimations} from "../parts/animations/registry.js"
 import {Anim, AnimateAction, Interpolation, Keyframes, TrackTransform, Transform, Vec2, VisualAnimationInput, VisualAnimations} from "../types.js"
 
@@ -22,8 +22,9 @@ type BuildPresetAnimateActions = {
 	[TKey in AnimationPreset]: BuildPresetAnimateAction
 }
 type BuildTransitionActions = {
-	[TKey in TransitionName]: (duration: number) => Build<Item.Transition>
+	[TKey in TransitionName]: (duration: number, options?: ItemMeta) => Build<Item.Transition>
 }
+type ContainerInput = [label: string, ...items: Build[]] | Build[]
 
 function createTimeline(): TimelineFile {
 	return {
@@ -42,12 +43,24 @@ export function timeline(root: Build): TimelineFile {
 	return o.timeline
 }
 
-export function sequence(...items: Build[]): Build<Item.Sequence> {
-	return o => o.sequence(...items.map(item => item(o)))
+export function sequence(...input: ContainerInput): Build<Item.Sequence> {
+	const [first, ...rest] = input
+	const label = typeof first === "string" ? first : undefined
+	const items = (label ? rest : input) as Build[]
+	return o => {
+		const built = items.map(item => item(o))
+		return label ? o.sequence(label, ...built) : o.sequence(...built)
+	}
 }
 
-export function stack(...items: Build[]): Build<Item.Stack> {
-	return o => o.stack(...items.map(item => item(o)))
+export function stack(...input: ContainerInput): Build<Item.Stack> {
+	const [first, ...rest] = input
+	const label = typeof first === "string" ? first : undefined
+	const items = (label ? rest : input) as Build[]
+	return o => {
+		const built = items.map(item => item(o))
+		return label ? o.stack(label, ...built) : o.stack(...built)
+	}
 }
 
 export function video(
@@ -55,6 +68,7 @@ export function video(
 	options?: {
 		start?: number,
 		duration?: number
+		label?: string
 	}
 ): Build<Item.Video> {
 	return o => o.video(media, options)
@@ -64,6 +78,7 @@ export function image(
 	media: Media,
 	options?: {
 		duration?: number
+		label?: string
 	}
 ): Build<Item.Image> {
 	return o => o.image(media, options)
@@ -75,6 +90,7 @@ export function audio(
 		start?: number,
 		duration?: number,
 		gain?: number
+		label?: string
 	}
 ): Build<Item.Audio> {
 	return o => o.audio(media, options)
@@ -85,6 +101,7 @@ export function text(
 	options?: {
 		duration?: number,
 		styles?: TextStyleOptions
+		label?: string
 	}
 ): Build<Item.Text> {
 	return o => o.text(content, options)
@@ -98,8 +115,8 @@ export function captions(
 	return o => o.captions(item(o), transcript, options)
 }
 
-export function gap(duration: number): Build<Item.Gap> {
-	return o => o.gap(duration)
+export function gap(duration: number, options?: ItemMeta): Build<Item.Gap> {
+	return o => o.gap(duration, options)
 }
 
 export function spatial(transform?: Transform, crop?: Crop): Build<Item.Spatial> {
@@ -232,7 +249,7 @@ export function textStyle(style: TextStyleOptions): Build<Item.TextStyle> {
 
 function makeTransitionActions(): BuildTransitionActions {
 	const entries = Object.keys(transitions)
-		.map(key => [key, (duration: number) => (o: O) => o.transition[key as TransitionName](duration)])
+		.map(key => [key, (duration: number, options?: ItemMeta) => (o: O) => o.transition[key as TransitionName](duration, options)])
 	return Object.fromEntries(entries) as BuildTransitionActions
 }
 

package/s/timeline/sugar/o.ts

@@ -6,7 +6,7 @@ import {Id, TimelineFile} from "../parts/basics.js"
 import {FilterAction, FilterActions} from "../parts/filters.js"
 import {filters, FilterParams, FilterType} from "../parts/filters.js"
 import {Transcription} from "../../features/speech/transcribe/types.js"
-import {Crop, FilterableItem, Item, Kind, VisualAnimatableItem} from "../parts/item.js"
+import {Crop, FilterableItem, Item, ItemMeta, Kind, VisualAnimatableItem} from "../parts/item.js"
 import {animationPresets, makeAnimationPresets, visualAnimations} from "../parts/animations/registry.js"
 import {TransitionAction, TransitionActions, transitions, TransitionName} from "../parts/transitions.js"
 import {AnimationPreset, PresetAnimateAction, PresetAnimateActions, PresetAnimation, PresetOptions} from "../parts/animations/types.js"
@@ -17,6 +17,8 @@ type VisualAnimateActions = {
 	[TKey in keyof VisualAnimations]-?: AnimateAction<TKey>
 }
 
+type ContainerInput = [label: string, ...items: Item.Any[]] | Item.Any[]
+
 export class O {
 	constructor(public state: {timeline: TimelineFile}) {}
 
@@ -229,20 +231,28 @@ export class O {
 		presets: this.#makePresetAnimateActions(),
 	}
 
-	sequence = (...items: Item.Any[]): Item.Sequence => {
+	sequence = (...input: ContainerInput): Item.Sequence => {
+		const [first, ...rest] = input
+		const label = typeof first === "string" ? first : undefined
+		const items = (label ? rest : input) as Item.Any[]
 		const item =  {
 			id: this.getId(),
 			kind: Kind.Sequence,
+			label,
 			childrenIds: items.map(item => item.id)
 		} as Item.Sequence
 		this.register(item)
 		return item
 	}
 
-	stack = (...items: Item.Any[]): Item.Stack => {
+	stack = (...input: ContainerInput): Item.Stack => {
+		const [first, ...rest] = input
+		const label = typeof first === "string" ? first : undefined
+		const items = (label ? rest : input) as Item.Any[]
 		const item = {
 			kind: Kind.Stack,
 			id: this.getId(),
+			label,
 			childrenIds: items.map(item => item.id)
 		} as Item.Stack
 		this.register(item)
@@ -254,6 +264,7 @@ export class O {
 		options?: {
 			start?: number,
 			duration?: number
+			label?: string
 		}): Item.Video => {
 
 		if(!media.hasVideo)
@@ -262,6 +273,7 @@ export class O {
 		const item: Item.Video = {
 			kind: Kind.Video,
 			id: this.getId(),
+			label: options?.label,
 			mediaHash: media.datafile.checksum.hash,
 			start: options?.start ?? 0,
 			duration: options?.duration ?? media.duration
@@ -274,6 +286,7 @@ export class O {
 		media: Media,
 		options?: {
 			duration?: number
+			label?: string
 		}): Item.Image => {
 
 		if(!media.isImage)
@@ -282,6 +295,7 @@ export class O {
 		const item: Item.Image = {
 			kind: Kind.Image,
 			id: this.getId(),
+			label: options?.label,
 			mediaHash: media.datafile.checksum.hash,
 			duration: options?.duration ?? 2000
 		}
@@ -295,6 +309,7 @@ export class O {
 			start?: number,
 			duration?: number,
 			gain?: number
+			label?: string
 		}): Item.Audio => {
 
 		if(!media.hasAudio)
@@ -303,6 +318,7 @@ export class O {
 		const item: Item.Audio = {
 			kind: Kind.Audio,
 			id: this.getId(),
+			label: options?.label,
 			mediaHash: media.datafile.checksum.hash,
 			start: options?.start ?? 0,
 			duration: options?.duration ?? media.duration,
@@ -315,10 +331,12 @@ export class O {
 	text = (content: string, options?: {
 			duration?: number,
 			styles?: TextStyleOptions
+			label?: string
 		}): Item.Text => {
 
 		const item = {
 			id: this.getId(),
+			label: options?.label,
 			content,
 			kind: Kind.Text,
 			duration: options?.duration ?? 2000
@@ -341,6 +359,7 @@ export class O {
 		const item: Item.Caption = {
 			id: this.getId(),
 			kind: Kind.Caption,
+			label: options?.label,
 			transcript,
 			itemId: options?.itemId,
 			start,
@@ -386,10 +405,11 @@ export class O {
 		{presets: this.#makeCaptionPresetActions()}
 	) as CaptionActions
 
-	gap = (duration: number): Item.Gap => {
+	gap = (duration: number, options?: ItemMeta): Item.Gap => {
 		const item = {
 			id: this.getId(),
 			kind: Kind.Gap,
+			label: options?.label,
 			duration
 		} as Item.Gap
 		this.register(item)
@@ -397,10 +417,11 @@ export class O {
 	}
 
 	#makeTransition = (key: TransitionName): TransitionAction => {
-		return (duration: number): Item.Transition => {
+		return (duration: number, options?: ItemMeta): Item.Transition => {
 			const item: Item.Transition = {
 				id: this.getId(),
 				kind: Kind.Transition,
+				label: options?.label,
 				name: transitions[key].name,
 				duration,
 			}