-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[PROPOSAL] Khronos Avatar Extensions - Phase 1 #2512
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
Kjakubzak
wants to merge
49
commits into
KhronosGroup:main
Choose a base branch
from
Kjakubzak:kjakubzak/avatar_ext
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+2,126
−0
Draft
Changes from 7 commits
Commits
Show all changes
49 commits
Select commit
Hold shift + click to select a range
ff1b7c9
First iteration of proposal draft to introduce khr avatar extensions
Kjakubzak 1413d20
Updated Contributes list as requested
Kjakubzak 7b4723e
Addressing some comments
Kjakubzak de2169f
Update README.md
Kjakubzak de03ddb
Update README.md
Kjakubzak 4a1f58a
Grammar am bad
Kjakubzak 685b1c3
Updated KHR_avatar_skeleton_biped readme to be more prescriptive
Kjakubzak 5effdee
Update the expressions extension descriptions to be more descriptive
Kjakubzak 22b69b9
Updating the mapping extensions
Kjakubzak f89a0e3
Addressing minor self-nit
Kjakubzak a520102
Changing namespaces to KHR_character and KHR_character_avatar
Kjakubzak dd2159a
Small updates
Kjakubzak 55bd217
More minor updates
Kjakubzak c461bab
Add virtual joint example for non-rotation-respecting virtual joint
Kjakubzak 3822282
Update typed expression extensions to reflect a centralized expressio…
Kjakubzak 085360f
Fit nits with last commit
Kjakubzak 59993b8
Iterated on KHR_character_expression_procedural
Kjakubzak 18d2d88
Testing mesh annotation refactor
Kjakubzak 2ec0909
Changed virtual joints to virtual transforms
Kjakubzak c321afa
Minor nit fixes
Kjakubzak 985455a
More implementation notes
Kjakubzak f560e6e
Update extensions/2.0/Khronos/KHR_character_virtual_transforms/README.md
Kjakubzak 639579c
Minor nits and moving virtual transform to KHR
Kjakubzak 3b34038
Update README.md
Kjakubzak 527faa9
Merge branch 'kjakubzak/avatar_ext_mesh_annotation_consolidated' into…
Kjakubzak de83236
Update README.md
Kjakubzak 9e54e51
Update extensions/2.0/Khronos/KHR_character_skeleton_biped/README.md
Kjakubzak 522371b
Update extensions/2.0/Khronos/KHR_character_skeleton_biped/README.md
Kjakubzak e5c010d
Updates to bindpose, mapping, and virtual transform extension readmes
Kjakubzak 7994f0e
Initial Draft Schemas
Kjakubzak 8a09213
Update khr_mesh_annotation readme
Kjakubzak 99861a3
Fixed readme typo
Kjakubzak d2e7cca
Addressing bad copy/paste and stale documentation
Kjakubzak f13ade3
Minor formatting consistency fixes
Kjakubzak c7ae046
Fixes to khr_character_expression_mapping
Kjakubzak 53935f5
Change KHR_character_skeleton_biped README to be clearer
Kjakubzak df66d5f
Fixing KHR_character_expression_morphtarget inconsistencies
Kjakubzak 1812744
Delaying KHR_character_avatar until we have more specific use-cases.
Kjakubzak 3e4bff5
Delaying KHR_mesh_annotation
Kjakubzak 8caa030
Delaying KHR_mesh_annotation_renderview
Kjakubzak 1e93bfa
Delaying KHR_character_skeleton_biped
Kjakubzak 56868be
Updated KHR_character_expression_morphtarget to explicitly depend on …
Kjakubzak 34c6689
KHR_character_skeleton_bindpose update
Kjakubzak 9dcf075
Update KHR_character to use rootNode instead of sceneIndex
Kjakubzak 607430e
Individual Contributor ->Independent Contributor
Kjakubzak 1c91e28
Updating README contributor lists with new TSG contributors
Kjakubzak 3eb2b6d
KHR_character_skeleton_mapping - Inverted key/value pairs to align wi…
Kjakubzak f3f2c90
Updated schema references to https://json-schema.org/draft/2020-12/sc…
Kjakubzak ee572d4
Update KHR_character_expression.KHR_character_expression_procedural.s…
Kjakubzak File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| # KHR_avatar | ||
|
|
||
| ## Contributors | ||
|
|
||
| - Ken Jakubzak, Meta | ||
| - Hideaki Eguchi / VirtualCast, Inc. | ||
| - K. S. Ernest (iFire) Lee, Individual Contributor / https://github.com/fire | ||
| - Shinnosuke Iwaki / VirtualCast, Inc. | ||
| - 0b5vr / pixiv Inc. | ||
| - Leonard Daly, Individual Contributor | ||
| - Nick Burkard, Meta | ||
|
|
||
| ## Status | ||
|
|
||
| **Draft** – This extension is not yet ratified by the Khronos Group and is subject to change. | ||
|
|
||
| ## Dependencies | ||
|
|
||
| Written against the glTF 2.0 specification. | ||
|
|
||
| Dependencies: `KHR_xmp_json_ld` | ||
| This extension also leverages the `KHR_xmp_json_ld` pattern for attaching extensible metadata as JSON-LD blocks within glTF assets. For background on this approach, see: | ||
| [KHR_xmp_json_ld](https://github.com/KhronosGroup/glTF/tree/main/extensions/2.0/Khronos/KHR_xmp_json_ld) | ||
|
|
||
| ## Overview | ||
|
|
||
| The `KHR_avatar` extension designates a glTF asset as representing an avatar. This top-level marker enables tools and runtimes to interpret the asset as containing avatar-specific content such as rigging, blendshapes, animation retargeting, or metadata. | ||
|
|
||
| This extension does not define avatar features directly but acts as a root declaration that avatar-related extensions may be present, and that consumers should treat the asset using avatar-specific logic and pipelines. It's part of the wider set of KHR avatar extensions that are meant to be building blocks to represent a contract stating functionality and data requirements between a given model and an endpoint. | ||
|
|
||
| The extension supports referencing the source `scene` that represents the avatar and optionally includes structured metadata through the `KHR_xmp_json_ld` mechanism. | ||
|
|
||
| ## Extension Schema | ||
|
|
||
| ```json | ||
| { | ||
| "extensions": { | ||
| "KHR_avatar": { | ||
| "sceneIndex": 0 | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Properties | ||
|
|
||
| | Property | Type | Description | | ||
| |--------------|---------|-----------------------------------------------------------------------------| | ||
| | `sceneIndex` | integer | Index of the glTF `scene` representing the avatar. Used to distinguish the avatar root when multiple scenes exist. | | ||
|
|
||
| ## Metadata Attachment: KHR_xmp_json_ld | ||
|
|
||
| Avatar metadata should be expressed using the `KHR_xmp_json_ld` format, a structured mechanism for attaching JSON-LD metadata blocks to glTF files. In the context of `KHR_avatar`, this allows consistent expression of avatar provenance, licensing, creator, versioning, and intended use, among others. | ||
|
|
||
| The `KHR_xmp_json_ld` block is placed at the root level of the glTF asset as part of the defined extension usage. Metadata keys and structures are defined in the shared Khronos Avatar Metadata schema (TBD). | ||
|
|
||
| | DC/XMP_JSON_LD Property | Why | Required | | ||
| | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------- | | ||
| | dc:title | | Yes | | ||
| | dc:creator | | Yes | | ||
| | dc:license | | No | | ||
| | dc:rights | | No | | ||
| | dc:created | Date on which the asset was created | No | | ||
| | dc:publisher | Identifies the entity responsible for making the resource available; important for understanding the source and authority of the content. | No | | ||
| | dc:description | Context and a summary of the content | No | | ||
| | dc:subject | Can potentially be used for content tagging/association | No | | ||
| | dc:source | Important for tracing the provenance and ensuring proper attribution. | Yes | | ||
| | khr:version | | No | | ||
| | khr:thumbnailImage | | No | | ||
|
|
||
| ## Example | ||
|
|
||
| ```json | ||
| { | ||
| "asset": { | ||
| "version": "2.0", | ||
| "extensions": { | ||
| "KHR_xmp_json_ld": { | ||
| "packet": 0 | ||
| } | ||
| } | ||
| }, | ||
| "scene": 0, | ||
| "scenes": [ | ||
| { | ||
| "nodes": [0] | ||
| } | ||
| ], | ||
| "nodes": [ | ||
| { | ||
| "name": "AvatarRoot" | ||
| } | ||
| ], | ||
| "extensionsUsed": ["KHR_avatar", "KHR_xmp_json_ld"], | ||
| "extensions": { | ||
| "KHR_avatar": { | ||
| "sceneIndex": 0 | ||
| }, | ||
|
|
||
| "KHR_xmp_json_ld": { | ||
| "packets": [ | ||
| { | ||
| "@context": { | ||
| "dc": "http://purl.org/dc/elements/1.1/", | ||
| "vrm": "https://github.com/vrm-c/vrm-specification/blob/master/specification/VRMC_vrm-1.0/meta.md" | ||
| }, | ||
| "dc:title": "Example Model", | ||
| "dc:creator": { | ||
| "@list": [ | ||
| "Author1", | ||
| "AuthorEmail1@email.com", | ||
| "Author2", | ||
| "AuthorEmail2@email.com" | ||
| ] | ||
| }, | ||
| "dc:license": { | ||
| "@list": [ | ||
| "https://vrm.dev/licenses/1.0/", | ||
| "https://example.com/third-party-license" | ||
| ] | ||
| }, | ||
| "dc:created": "2023-05-05", | ||
| "dc:rights": "Copyright information about the model", | ||
| "dc:publisher": "Imaginary Corporation A, LLC", | ||
| "dc:description": "A sentence, or paragraph describing the avatar at hand", | ||
| "dc:subject": { | ||
| "@list": ["Example trait", "Another example trait"] | ||
| }, | ||
| "dc:source": "imaginaryCompany.com/avatarl", | ||
| "khr:version": "1.0", | ||
| "khr:thumbnailImage": 0 | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Implementation Notes | ||
|
|
||
| - `sceneIndex` is required, representing the index of the glTF `scene` corresponding to the avatar. Used to distinguish the avatar root when multiple scenes exist. | ||
| - Consumers should use this marker as a signal to search for additional avatar-related extensions, including skeletal, expression, and other khronos avatar extensions. | ||
| - Support for `KHR_xmp_json_ld` is encouraged to ensure interoperable metadata across tools and runtimes. | ||
|
|
||
| ## Known Implementations | ||
|
|
||
| ## License | ||
|
|
||
| This extension specification is licensed under the Khronos Group Extension License. | ||
| See: https://www.khronos.org/registry/gltf/license.html | ||
102 changes: 102 additions & 0 deletions
102
extensions/2.0/Khronos/KHR_avatar_expression_joint/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| # KHR_avatar_expression_joint | ||
|
|
||
| ## Contributors | ||
|
|
||
| - Ken Jakubzak, Meta | ||
| - Hideaki Eguchi / VirtualCast, Inc. | ||
| - K. S. Ernest (iFire) Lee, Individual Contributor / https://github.com/fire | ||
| - Shinnosuke Iwaki / VirtualCast, Inc. | ||
| - 0b5vr / pixiv Inc. | ||
| - Leonard Daly, Individual Contributor | ||
| - Nick Burkard, Meta | ||
|
|
||
| ## Status | ||
|
|
||
| **Draft** – This extension is not yet ratified by the Khronos Group and is subject to change. | ||
|
|
||
| ## Dependencies | ||
|
|
||
| Written against the glTF 2.0 specification. | ||
| Dependent on: `KHR_avatar` | ||
| Typically used in conjunction with: `KHR_avatar_expression_mapping` | ||
|
|
||
| ## Overview | ||
|
|
||
| The `KHR_avatar_expression_joint` extension provides a semantic mapping between facial expressions and joint transformations in the glTF node hierarchy. It enables tools and runtimes to associate expressions like `blink`, `smile`, or `jawOpen` with specific nodes whose transforms are animated using standard glTF animation channels. | ||
|
|
||
| This extension is purely descriptive: it does not define or store animation data itself. | ||
|
|
||
| ## Reference Expression Categories/Vocabularies | ||
|
|
||
| Expression types include: | ||
|
|
||
| - **Emotions** (e.g. `happy`, `angry`, `surprised`) | ||
| - **Visemes** (e.g. `aa`, `oo`, `th`) | ||
| - **Modifiers** (e.g. `left`, `right`, `upper`, `lower`) | ||
| - **Gestures and Actions** (e.g. `blink`, `smile`, `jawOpen`) | ||
|
|
||
| Optionally, these may be aligned with industry standards, such as [Facial Action Coding System (FACS)](https://en.wikipedia.org/wiki/Facial_Action_Coding_System). | ||
|
|
||
| ## Extension Schema | ||
|
|
||
| ```json | ||
| { | ||
| "extensions": { | ||
| "KHR_avatar_expression_joint": { | ||
| "expressions": [ | ||
| { | ||
| "expression": "smile", | ||
| "animation": 0, | ||
| "channels": [0, 1, 2] | ||
Kjakubzak marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| }, | ||
| { | ||
| "expression": "frown", | ||
| "animation": 1, | ||
| "channels": [0, 1] | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Properties | ||
|
|
||
| | Property | Type | Description | | ||
| | ------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `expressions` | array | Array of mappings between animation/channels and expression labels. | | ||
| | `animation` | integer | Index into the glTF `animations[]` array representing an expression animation. | | ||
| | `expression` | string | Expression name this joint contributes to. | | ||
| | `channels` | array | array representing channels that must correspond to either `"rotation"`, `"translation"`, or `"scale"`; indicates transform types. | | ||
|
|
||
| ## Animation Integration | ||
|
|
||
| - Expression timing, blending, and control must use glTF `animations` channels. | ||
| - Animations targeting expression-driven `rotation`, `translation`, or `scale` must conform to glTF 2.0's animation model. | ||
| - This ensures consistency, ease of implementation, and interoperability across runtimes. | ||
|
|
||
| Each animation channel used to drive an expression should operate within a **normalized 0-to-1 range**, where: | ||
|
|
||
| - `0.0` indicates the expression is fully inactive. | ||
| - `1.0` indicates the expression is fully active. | ||
|
|
||
| The transformation values themselves (e.g., degree of rotation or distance of translation) should scale proportionally with the normalized input range. | ||
|
|
||
| This approach simplifies avatar implementation by centralizing expression playback in the glTF animation system and unifying runtime logic for blending and prioritization. | ||
|
|
||
| ### Recommended Interpolation for Binary Expressions | ||
|
|
||
| For expressions that represent binary or toggle states (such as `blinkLeft`, `blinkRight`, or `jawOpen`), the use of glTF animation channels with `"interpolation": "STEP"` is strongly recommended. | ||
|
|
||
| STEP interpolation ensures that an expression toggles cleanly between fully off (`0.0`) and fully on (`1.0`) states, providing crisp visual transitions and avoiding interpolation artifacts that could occur with `LINEAR` interpolation in binary scenarios. | ||
|
|
||
| ## Implementation Notes | ||
|
|
||
| - Multiple joints may be assigned to the same expression. | ||
| - Expression states should be normalized to the [0.0–1.0] range for consistent runtime interpretation. | ||
| - This extension does not conflict with standard rigging or skinning systems. | ||
|
|
||
| ## License | ||
|
|
||
| This extension is licensed under the Khronos Group Extension License. | ||
| See: https://www.khronos.org/registry/gltf/license.html | ||
98 changes: 98 additions & 0 deletions
98
extensions/2.0/Khronos/KHR_avatar_expression_mapping/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| # KHR_avatar_expression_mapping | ||
|
|
||
| ## Contributors | ||
|
|
||
| - Ken Jakubzak, Meta | ||
| - Hideaki Eguchi / VirtualCast, Inc. | ||
| - K. S. Ernest (iFire) Lee, Individual Contributor / https://github.com/fire | ||
| - Shinnosuke Iwaki / VirtualCast, Inc. | ||
| - 0b5vr / pixiv Inc. | ||
| - Leonard Daly, Individual Contributor | ||
| - Nick Burkard, Meta | ||
|
|
||
| ## Status | ||
|
|
||
| **Draft** – This extension is not yet ratified by the Khronos Group and is subject to change. | ||
|
|
||
| ## Dependencies | ||
|
|
||
| Written against the glTF 2.0 specification. | ||
| Dependent on: `KHR_avatar` | ||
| Can be used alongside: `KHR_avatar_expression_morphtargets` or other expression sources | ||
|
|
||
| ## Overview | ||
|
|
||
| ## Reference Expression Categories/Vocabularies | ||
|
|
||
| Expression names may be grouped into categories including: | ||
|
|
||
| - **Emotions** (e.g. `happy`, `angry`, `surprised`) | ||
| - **Visemes** (e.g. `aa`, `oo`, `th`) | ||
| - **Modifiers** (e.g. `left`, `right`, `upper`, `lower`) | ||
| - **Gestures and Actions** (e.g. `blink`, `smile`, `jawOpen`) | ||
|
|
||
| The `KHR_avatar_expression_mapping` extension provides a general-purpose mechanism for mapping expression names used in an avatar to a known expression vocabulary. This allows different authoring pipelines or runtimes to translate between heterogeneous expression sets. | ||
|
|
||
| ## Extension Schema | ||
|
|
||
| ```json | ||
| { | ||
| "extensions": { | ||
| "KHR_avatar_expression_mapping": { | ||
| "mappings": { | ||
| "smileLeft": [ | ||
| { "target": "Smile", "weight": 0.8 }, | ||
| { "target": "LeftCheekRaise", "weight": 0.2 } | ||
| ], | ||
| "jawOpen": [{ "target": "MouthOpen", "weight": 1.0 }] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Properties | ||
|
|
||
| | Property | Type | Description | | ||
| | ---------- | ------ | ------------------------------------------------------------------ | | ||
| | `mappings` | object | Dictionary mapping expression names to reference vocabulary terms. | | ||
| | `target` | string | Name of the expression in the target vocabulary. | | ||
| | `weight` | number | Influence of this target. Must sum to 1.0 per expression key. | | ||
|
|
||
| ### Mapping Types | ||
|
|
||
| This extension supports both one-to-one and one-to-many mappings: | ||
|
|
||
| - **One-to-one**: An expression maps directly to a single reference vocabulary term with weight 1.0. | ||
| - **One-to-many**: An expression is composed from multiple reference terms, blended using assigned weights. | ||
|
|
||
| This allows developers to bridge between custom expression sets and shared vocabularies. | ||
|
|
||
| ## Implementation Notes | ||
|
|
||
| - This extension is typically used at the top level of the glTF file. | ||
| - Expression names should match those used in `KHR_avatar_expression_morphtargets`, animation tracks, or tracking pipelines. | ||
| - Tools can interpret this mapping to apply automatic translation between expression sets. | ||
|
|
||
| ## Example | ||
|
|
||
| ```json | ||
| { | ||
| "extensionsUsed": ["KHR_avatar_expression_mapping"], | ||
| "extensions": { | ||
| "KHR_avatar_expression_mapping": { | ||
| "mappings": { | ||
| "smileLeft": [ | ||
| { "target": "Smile", "weight": 0.8 }, | ||
| { "target": "LeftCheekRaise", "weight": 0.2 } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| This extension specification is licensed under the Khronos Group Extension License. | ||
| See: https://www.khronos.org/registry/gltf/license.html |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.