Skip to main content

alpha2_model/
lib.rs

1//! Versioned, host-independent project model for alpha2.
2//!
3//! This crate describes intent only. It contains no decoder handles, GPU
4//! resources, filesystem paths, or application-specific types.
5
6mod animation;
7mod audio;
8mod audio_load;
9mod bounded;
10mod caption;
11mod caption_import;
12mod checks;
13mod composition;
14mod data;
15mod data_places;
16#[cfg(test)]
17mod data_tests;
18mod domain;
19mod easing;
20mod effect;
21mod effect_spec;
22mod error;
23mod fingerprint;
24mod generator;
25mod ids;
26mod layout;
27mod layout_values;
28mod lint;
29mod mask;
30mod project;
31mod provider;
32mod resource;
33#[cfg(feature = "schema")]
34mod schema;
35mod shapes;
36mod source;
37#[cfg(test)]
38pub(crate) mod tests;
39mod text;
40mod text_animation;
41mod time_bound;
42mod time_map;
43mod timeline;
44mod timeline_values;
45
46pub use animation::{
47    Animated, AnimatedPoint, AnimatedValue, Interpolation, Keyframe, MAX_KEYFRAMES, PointKeyframe,
48    Vec2, VisualProperties,
49};
50pub use audio::{
51    AUDIO_EFFECT_STATE_MARGIN_MS, AudioEffect, AudioProperties, Ducking, EQ_FREQUENCY_RANGE_HZ,
52    EQ_Q_RANGE, EqBand, EqBandKind, FadeShape, Limiter, MAX_AUDIO_DELAY_MS, MAX_AUDIO_EFFECTS,
53    MAX_CHAIN_EFFECTS, MAX_COMPRESSOR_RATIO, MAX_ENVELOPE_MS, MAX_EQ_BANDS, MAX_EQ_GAIN_DB,
54    MAX_GAIN, MAX_LOOKAHEAD_MS, MAX_SELECTED_CHANNELS, MIN_LEVEL_DB, MasterAudio, REVERB_DELAY_MS,
55    TrackAudio,
56};
57pub use audio_load::AudioEffectLoad;
58pub use caption::{
59    CaptionCue, Captions, MAX_CAPTION_FONT_SIZE, MAX_CAPTION_NAME_BYTES, MAX_CAPTION_STYLES,
60    MAX_DERIVED_CUES, TextStylePatch, WORD_PAUSE_TICKS, clip_runs, end_cues_where_the_next_starts,
61    group_words,
62};
63pub use caption_import::{
64    CaptionImportError, ImportNotes, ImportedCaptions, MAX_CAPTION_FILE_BYTES,
65    MAX_CAPTION_FILE_CUES, caption_rows, parse_srt, parse_webvtt,
66};
67pub use composition::{
68    ClipComposition, Composition, CompositionControl, CompositionNode, CompositionReads,
69    MAX_COMPOSITION_CONTROLS, MAX_COMPOSITION_DEPTH, MAX_COMPOSITION_NODES, MAX_COMPOSITIONS,
70    MAX_EFFECT_INPUTS, MAX_FRAME_INLINED_NODES, MAX_GROUP_INPUTS, MAX_INLINED_NODES,
71    MAX_MERGE_LAYERS, MergeLayer, NodeInput, NodeOp, TimeScale,
72};
73pub use data::{
74    BindingProblem, CaptionsFromWords, CorrectionRef, DataAnchor, DataBinding, DataInterpolation,
75    DataInterval, DataKind, DataProblem, DataRemap, DataSamples, DataSet, DataSpace, DataValues,
76    DataVia, DataWord, MAX_DATA_CHANNELS, MAX_DATA_COORDINATE, MAX_DATA_ID_BYTES,
77    MAX_DATA_INTERVALS, MAX_DATA_LABEL_BYTES, MAX_DATA_ROTATION_DEGREES, MAX_DATA_SCALAR,
78    MAX_DATA_SCALE, MAX_DATA_SETS, MAX_DATA_VALUES, MAX_DATA_WORDS, MAX_FOLLOW_DEPTH, MadeBy,
79    MadeByPlugin, SIMILARITY_ARITY, valid_interval, valid_word, value_in_bounds,
80};
81pub use domain::Domain;
82pub use easing::{CubicBezier, Easing};
83pub use effect::{ClipBlendMode, ClipEffect, EffectValue};
84pub use effect_spec::{
85    BUILTIN_EFFECT_PREFIX, EffectKind, EffectParamSpec, EffectParamType, EffectParamUnit,
86    EffectProblem, EffectSpec, builtin_effect, builtin_effects, builtin_effects_json,
87    check_builtin_effect,
88};
89pub use error::{
90    DataOwner, EffectOwner, ErrorSubject, ModelError, ProjectLoadError, ProjectWriteError,
91    ShapeOwner,
92};
93pub use fingerprint::{AudioStreamShape, MediaFingerprint, StreamTopology, VideoStreamShape};
94pub use generator::{Generator, GradientStop, MAX_GRADIENT_STOPS, Paint, Rgba, Spread};
95pub use ids::{ClipId, CompositionId, DataSetId, EffectResourceId, NodeId, ProjectId, TrackId};
96pub use layout::{
97    ASPECT_RATIO_RANGE, AlignContent, AlignItems, Display, FlexDirection, FlexWrap, GeneratorIssue,
98    GridAutoFlow, JustifyContent, LAYOUT_TEXT_DEFAULTS, LayoutBorder, LayoutFontSizeFit,
99    LayoutInset, LayoutIssue, LayoutNode, LayoutProblem, LayoutShape, LayoutTextStyle,
100    MAX_FLEX_FACTOR, MAX_GRID_TRACKS, MAX_LAYOUT_DEPTH, MAX_LAYOUT_FONT_SIZE, MAX_LAYOUT_ISOLATED,
101    MAX_LAYOUT_NODES, MAX_LAYOUT_TEXTS, Overflow, Position,
102};
103pub use layout_values::{
104    GridEdge, GridPlacement, Insets, LayoutLength, LayoutOffset, LayoutSize, MAX_LAYOUT_FRACTION,
105    MAX_LAYOUT_PERCENT, MAX_LAYOUT_PX, RepeatCount, TrackBreadth, TrackComponent, TrackList,
106    TrackSize,
107};
108pub use lint::{LintEdge, LintIssue, LintOwner, ShapeLintOwner};
109pub use mask::{MAX_CLIP_MASKS, MaskMode, Matte, MatteMode, ShapeMask};
110pub use project::{
111    BlendSpace, CURRENT_SCHEMA_VERSION, ColorPipeline, HDR_PEAK_NITS_RANGE, HdrSources,
112    MAX_CANVAS_DIMENSION, MAX_CANVAS_PIXELS, MAX_CLIPS, MAX_CLIPS_PER_TRACK, MAX_EFFECT_RESOURCES,
113    MAX_PROJECT_JSON_BYTES, MAX_TRACKS, MAX_TRANSITIONS_PER_TRACK, Project, ProjectSettings, Rgb,
114    SAMPLE_RATE_RANGE,
115};
116pub use provider::{
117    LinearPrimaries, MAX_LATEX_BYTES, MAX_LATEX_FONT_SIZE, MAX_LOTTIE_DOCUMENT_BYTES,
118    MAX_PDF_DOCUMENT_BYTES, MAX_PDF_PAGES, MAX_PROVIDER_DOCUMENT_BYTES, MAX_SEQUENCE_FRAMES,
119    MAX_SVG_DOCUMENT_BYTES, MissingFrames, ProviderSource,
120};
121pub use resource::{EffectResource, EffectResourceKind};
122#[cfg(feature = "schema")]
123pub use schema::{PROJECT_SCHEMA_ID, finish_json_schema, project_json_schema, project_limits_json};
124pub use shapes::{
125    Dash, EllipseGeometry, FillRule, LineCap, LineJoin, MAX_DASH_ENTRIES, MAX_PATH_SUBPATHS,
126    MAX_PATH_VERTICES, MAX_POLYSTAR_POINTS, MAX_SHAPE_DEPTH, MAX_SHAPE_ITEMS, MIN_POLYSTAR_POINTS,
127    Path, PathGeometry, PathVertex, PolystarGeometry, PolystarKind, RectangleGeometry,
128    ShapeGeometry, ShapeIssue, ShapeItem, ShapeProblem, ShapeTransform, StrokeItem, Subpath,
129    TrimItem, TrimMode, validate_shape_items,
130};
131pub use source::{MediaKind, MediaSource};
132pub use text::{
133    BlockEllipsis, FONT_SIZE_FIT_STEPS, FONT_WEIGHT_RANGE, FontSizeFit, LETTER_SPACING_RANGE,
134    LINE_HEIGHT_RANGE, LineClamp, MAX_BLOCK_ELLIPSIS_BYTES, MAX_FONT_FAMILY_BYTES,
135    MAX_TEXT_CONTENT_BYTES, MAX_TEXT_GENERATOR_FONT_SIZE, MAX_TEXT_PADDING, MAX_TEXT_POSITION,
136    MAX_TEXT_SHADOW_BLUR, MAX_TEXT_SHADOW_OFFSET, MAX_TEXT_SHADOWS, MAX_TEXT_STROKE_EXTENT,
137    MAX_TEXT_STROKES, TextAlign, TextBackground, TextShadow, TextStroke, TextStyle,
138};
139pub use text_animation::{
140    ANIMATOR_SCALE_RANGE, MAX_ANIMATOR_OFFSET, MAX_CLASS_NAME_BYTES, MAX_RANGE_INDEX,
141    MAX_RUN_CLASSES, MAX_TEXT_ANIMATORS, MAX_TEXT_RUNS, RANGE_PERCENT, RangeShape, RangeUnits,
142    RunState, RunTime, TextAnimator, TextAnimatorProperties, TextContent, TextRun, TextSelector,
143    TextUnit, valid_class_name,
144};
145pub use time_map::{LOOP_FADE_SECONDS, LoopMode, MAX_LOOP_PASSES, TimeMap, loop_passes};
146pub use timeline::{CacheIntent, Clip, ClipTransition, Timeline, Track, TrackKind};
147pub use timeline_values::{ClipReference, TimelineOwner, TimelineValue, TimelineVisit};