@pulsefield/protocol 0.0.1 → 0.0.3

package/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "[]"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/PROTOCOL_GUIDELINES.md

@@ -0,0 +1,123 @@
+# Protocol Guidelines
+
+## Intent
+
+This package defines the shared protobuf contract for Pulsefield clients and model services. The goal is to keep the protocol easy to evolve while avoiding accidental wire-format breakage.
+
+## Change Policy
+
+During early `0.x` development, breaking changes are allowed when all known consumers are updated in the same release.
+
+Once the protocol is used by independently updated clients, prefer additive changes:
+
+- Add new fields with fresh numbers.
+- Add new enum values with fresh numbers.
+- Add new `Envelope.payload` variants with fresh numbers.
+
+Avoid reusing field numbers from published schemas. If a field was removed after publication, reserve its old number and name when practical.
+
+Moving a message to another `.proto` file can preserve its fully qualified protobuf type name and binary wire compatibility, but it changes generated module/file boundaries in languages such as Python. Treat those moves as generated API breaks during `0.x`, document the import migration, and update known consumers in the same release.
+
+## Source Of Truth
+
+- `.proto` files under `proto/` are the source of truth.
+- Keep transport, graph/core vocabulary, inference, and opaque mapper token events in separate source files when the concepts can evolve independently.
+- Breaking-change checks use package-level compatibility so source files can be reorganized without treating stable fully qualified type moves as wire breaks.
+- Generated code under `gen/` is committed for Swift/Python consumers.
+- WebSocket payloads should use binary protobuf `Envelope`.
+
+## Responsibility Boundary
+
+This package should contain stable, cross-process protocol contracts:
+
+- Node graph identity, roles, and capability announcements for host, player client, model service, hardware, and debug-tool processes.
+- Inference endpoint messages and lifecycle states.
+- Machine-readable enums and error codes shared by Swift, Python, and npm consumers.
+- Opaque token-stream events tagged with the token-contract version needed by Swift/model-side decoders.
+- Generated artifacts that prove those contracts are stable.
+
+Keep implementation details in their owning repositories:
+
+- Model training, Torch runtime, checkpoint loading, mel/control features, grammar decoding, and timing fitting algorithms stay in `Pulsefield-model`.
+- Token decoding, decoded Mania4K/domain state, SwiftUI view state, AVFoundation clocks, input routing, rendering, judgement, scoring, and local-library/recognition integrations stay in `Pulsefield`.
+- Full `.osu` import/export behavior stays outside this protocol.
+
+## Inference Lifecycle
+
+The v1 endpoint lifecycle is:
+
+```text
+ready -> audio_preparing -> audio_ready -> streaming -> stopped
+                                      \-> failed
+```
+
+Use `StatusEvent` when a service sends lifecycle transitions over the protocol. The current model endpoint logs `ws_status`; new protobuf consumers should prefer `StatusEvent`.
+
+## Token Contract
+
+The protobuf layer treats mapper tokens as opaque ids plus `token_contract_version`. Token decoding tables, lane actions, quantization rules, and reducer/domain state belong in the Swift and model repositories that share the token-stream transport definitions.
+
+## Comments
+
+Comments should explain protocol meaning, not restate the field name.
+
+Add comments when:
+
+- A message represents a wire-level event or request.
+- A field has units, clock source, ordering semantics, or lifecycle assumptions.
+- A field is optional and absence has a distinct meaning.
+- An enum value is non-obvious.
+- A value is experimental or temporary.
+- A field exists for compatibility with a specific consumer.
+
+Prefer comments like:
+
+```proto
+// Sent by the client to request beatmap inference for an audio source.
+message AudioRequest {
+  // Local or sandbox-relative path understood by the receiving model service.
+  string audio_path = 1;
+
+  // Duration of the selected audio in milliseconds, when known by the client.
+  optional uint32 audio_length_ms = 2;
+}
+```
+
+Avoid comments like:
+
+```proto
+// The audio path.
+string audio_path = 1;
+```
+
+## Naming And Units
+
+- Use `snake_case` field names.
+- Include units in names when they clarify meaning, such as `_ms`, `_unix_ms`, `_count`, or `_id`.
+- Use `*_UNSPECIFIED = 0` for enum defaults.
+- Prefer enums for machine-readable state.
+- Use strings for human-facing or debug messages.
+
+## Validation
+
+The schema defines shape. Runtime code still validates behavior:
+
+- Payload is present.
+- `session_id` is known.
+- `sequence` ordering is acceptable.
+- Time values are in expected ranges.
+- State transitions make sense.
+
+## Workflow
+
+Use local npm scripts:
+
+```sh
+npm run generate
+npm run proto:format
+npm run proto:lint
+npm run generated:check
+npm run check
+```
+
+Generated Swift/Python files must be updated in the same change as proto edits. `npm run generated:check` compares committed outputs with fresh Buf generation and checks that Python stubs and Swift generated code expose the same proto surface.

package/Package.swift

@@ -0,0 +1,34 @@
+// swift-tools-version: 6.0
+
+import PackageDescription
+
+let package = Package(
+    name: "PulsefieldProtocol",
+    products: [
+        .library(
+            name: "PulsefieldProtocol",
+            targets: ["PulsefieldProtocol"]
+        )
+    ],
+    dependencies: [
+        .package(
+            url: "https://github.com/apple/swift-protobuf.git",
+            from: "1.38.0"
+        )
+    ],
+    targets: [
+        .target(
+            name: "PulsefieldProtocol",
+            dependencies: [
+                .product(name: "SwiftProtobuf", package: "swift-protobuf")
+            ],
+            path: "gen/swift",
+            sources: [
+                "pulsefield/protocol/v1/core.pb.swift",
+                "pulsefield/protocol/v1/envelope.pb.swift",
+                "pulsefield/protocol/v1/inference.pb.swift",
+                "pulsefield/protocol/v1/mapper.pb.swift",
+            ]
+        )
+    ]
+)

package/README.md

@@ -0,0 +1,128 @@
+# Pulsefield Protocol
+
+Shared protocol package for projects under [github.com/Pulsefield](https://github.com/Pulsefield).
+
+## Repository Layout
+
+```text
+proto/              Protocol Buffers source of truth.
+gen/swift/          Generated SwiftProtobuf code, committed and shipped.
+gen/python/         Generated Python protobuf code and type stubs, committed and shipped.
+docs/               Protocol notes shipped with the npm package.
+tools/              Local generation and drift-check scripts.
+Package.swift       SwiftPM manifest for Swift/Xcode consumers.
+pyproject.toml      Python package metadata for wheel/sdist consumers.
+buf.yaml            Proto lint and breaking-change configuration.
+buf.gen.yaml        Swift and Python generation configuration.
+```
+
+The Swift app and Python model consume generated code from `gen/`. The `.proto` files remain the protocol source of truth. WebSocket payloads should be binary protobuf `Envelope` messages. JSON is reserved for debug and logs.
+
+See [Protocol Guidelines](./PROTOCOL_GUIDELINES.md) for schema evolution, naming, and comment conventions. See [Session Scope](./docs/session-scope.md) for `Envelope.session_id` requirements by payload.
+
+The v1 protobuf source is split by responsibility:
+
+```text
+proto/pulsefield/protocol/v1/core.proto
+  Node identity, roles, and advertised capabilities.
+
+proto/pulsefield/protocol/v1/envelope.proto
+  Transport envelope, routing metadata, correlation ids, and payload union.
+
+proto/pulsefield/protocol/v1/inference.proto
+  Inference requests, lifecycle status, errors, and end-of-stream events.
+
+proto/pulsefield/protocol/v1/mapper.proto
+  Opaque mapper token events.
+```
+
+## Current Scope
+
+This package owns the stable cross-language contract between Pulsefield clients, the Python model endpoint, and npm consumers:
+
+- Node graph identity for host, player client, model service, hardware, and debug-tool processes.
+- Inference WebSocket envelopes: ready, audio, reference time, stop, status, error, hitobject token, and end-of-stream.
+- Opaque mapper token stream events tagged with a token-contract version.
+
+This package does not own token decoding, decoded Mania4K/domain state, model inference internals, Torch checkpoints, timing fitting algorithms, SwiftUI state, rendering, judgement, input routing, audio clock implementations, or full `.osu` parsing/export.
+
+## Distribution Surfaces
+
+This repository publishes the same protocol contract through multiple language-native surfaces. Downstream Swift and Python projects do not need their own `package.json`.
+
+### npm
+
+The npm package remains useful for Node tooling, registry-backed tarballs, and consumers that want direct access to `proto/` and `gen/`:
+
+```sh
+npm install @pulsefield/protocol
+```
+
+### SwiftPM
+
+Swift/Xcode consumers should depend on this Git repository directly:
+
+```swift
+.package(
+    url: "https://github.com/Pulsefield/protocol.git",
+    from: "0.0.3"
+)
+```
+
+Then add the product to a target:
+
+```swift
+.product(name: "PulsefieldProtocol", package: "protocol")
+```
+
+SwiftPM publication is Git-tag based. Create and push a semver tag such as `0.0.3`; no central Swift registry is required for this bootstrap path.
+
+### Python
+
+Python consumers should eventually use the PyPI package:
+
+```sh
+pip install pulsefield-protocol==0.0.3
+```
+
+The local bootstrap build is:
+
+```sh
+python3 -m pip install build
+python3 -m build --sdist --wheel --outdir dist/
+python3 -m pip install dist/*.whl
+python3 -c "from pulsefield.protocol.v1 import envelope_pb2; envelope_pb2.Envelope()"
+```
+
+Generated Python classes live in the module for their source `.proto` file. For example, import `Envelope` from `envelope_pb2`, inference messages from `inference_pb2`, mapper token messages from `mapper_pb2`, and node graph messages from `core_pb2`.
+
+The `Publish Python package` GitHub workflow is manual and expects PyPI trusted publishing to be configured for the repository/environment before it is run.
+
+## Development Tools
+
+- Node.js package manager: `npm@11.12.1`, recorded in `package.json`.
+- Runtime floor: Node.js `>=22.0.0`.
+- Protobuf workflow: local npm binaries, not global installs.
+- Proto lint/generation: `@bufbuild/buf`.
+- Swift generation: Buf remote plugin `buf.build/apple/swift`.
+- Python generation: Buf remote plugins `buf.build/protocolbuffers/python` and `buf.build/protocolbuffers/pyi`.
+- Formatting: `prettier`.
+
+## Commands
+
+```sh
+npm run generate
+npm run proto:lint
+npm run proto:generate
+npm run generated:check
+npm run check
+npm run python:check
+npm run swift:build
+npm run bootstrap:check
+```
+
+`npm run generated:check` regenerates Swift and Python outputs in a temporary directory and compares them byte-for-byte with `gen/`. It also verifies that the generated Python stubs and Swift file expose the same message, enum, and field surface declared by the proto.
+
+## License
+
+Licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE).

package/buf.gen.yaml

@@ -0,0 +1,13 @@
+version: v2
+clean: true
+inputs:
+  - directory: proto
+plugins:
+  - remote: buf.build/apple/swift:v1.38.0
+    out: gen/swift
+    opt:
+      - Visibility=Public
+  - remote: buf.build/protocolbuffers/python:v26.1
+    out: gen/python
+  - remote: buf.build/protocolbuffers/pyi:v26.1
+    out: gen/python

package/buf.yaml

@@ -0,0 +1,9 @@
+version: v2
+modules:
+  - path: proto
+lint:
+  use:
+    - STANDARD
+breaking:
+  use:
+    - PACKAGE

package/docs/session-scope.md

@@ -0,0 +1,27 @@
+# Session Scope
+
+`Envelope.session_id` defines the session scope for the envelope payload. Payload
+messages do not duplicate `session_id`; receivers validate the payload against the
+session id carried by the envelope.
+
+## Rules
+
+| Payload                | `Envelope.session_id`                                                                     |
+| ---------------------- | ----------------------------------------------------------------------------------------- |
+| `NodeHello`            | MUST be empty                                                                             |
+| `ReadyRequest`         | SHOULD be empty                                                                           |
+| `AudioRequest`         | MUST be non-empty                                                                         |
+| `ReferenceTimeRequest` | MUST be non-empty                                                                         |
+| `HitObjectTokenEvent`  | MUST be non-empty                                                                         |
+| `StopSessionRequest`   | MUST be non-empty                                                                         |
+| `StatusEvent`          | MAY be empty for endpoint/node-scoped status; MUST be non-empty for session-scoped status |
+
+`StopSessionRequest` intentionally has no `session_id` field. It targets the
+active session identified by `Envelope.session_id`; therefore an envelope with
+`payload.stop_session` and an empty `Envelope.session_id` is invalid.
+
+`StatusEvent` is the only payload in this list that can validly cross the
+session boundary. Endpoint-level statuses such as cold startup or readiness can
+use an empty `Envelope.session_id`. Statuses describing an active session, a
+missing session, or a session transition use the relevant non-empty
+`Envelope.session_id`.

package/gen/python/pulsefield/protocol/py.typed

@@ -0,0 +1 @@
+

package/gen/python/pulsefield/protocol/v1/core_pb2.py

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: pulsefield/protocol/v1/core.proto
+# Protobuf Python Version: 5.26.1
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n!pulsefield/protocol/v1/core.proto\x12\x16pulsefield.protocol.v1\"\xcd\x01\n\x0eNodeCapability\x12>\n\x04kind\x18\x01 \x01(\x0e\x32*.pulsefield.protocol.v1.NodeCapabilityKindR\x04kind\x12\x12\n\x04name\x18\x02 \x01(\tR\x04name\x12\x18\n\x07version\x18\x03 \x01(\tR\x07version\x12M\n\tdirection\x18\x04 \x01(\x0e\x32/.pulsefield.protocol.v1.NodeCapabilityDirectionR\tdirection\"\xe8\x01\n\tNodeHello\x12\x17\n\x07node_id\x18\x01 \x01(\tR\x06nodeId\x12\x34\n\x04role\x18\x02 \x01(\x0e\x32 .pulsefield.protocol.v1.NodeRoleR\x04role\x12J\n\x0c\x63\x61pabilities\x18\x03 \x03(\x0b\x32&.pulsefield.protocol.v1.NodeCapabilityR\x0c\x63\x61pabilities\x12)\n\x10protocol_version\x18\x04 \x01(\tR\x0fprotocolVersion\x12\x15\n\x06\x61pp_id\x18\x05 \x01(\tR\x05\x61ppId*\xa5\x01\n\x08NodeRole\x12\x19\n\x15NODE_ROLE_UNSPECIFIED\x10\x00\x12\x12\n\x0eNODE_ROLE_HOST\x10\x01\x12\x1b\n\x17NODE_ROLE_PLAYER_CLIENT\x10\x02\x12\x1b\n\x17NODE_ROLE_MODEL_SERVICE\x10\x03\x12\x16\n\x12NODE_ROLE_HARDWARE\x10\x04\x12\x18\n\x14NODE_ROLE_DEBUG_TOOL\x10\x05*\x8d\x02\n\x12NodeCapabilityKind\x12$\n NODE_CAPABILITY_KIND_UNSPECIFIED\x10\x00\x12$\n NODE_CAPABILITY_KIND_RECOGNITION\x10\x01\x12\x1f\n\x1bNODE_CAPABILITY_KIND_TIMING\x10\x02\x12\x1f\n\x1bNODE_CAPABILITY_KIND_MAPPER\x10\x03\x12&\n\"NODE_CAPABILITY_KIND_PLAYER_STREAM\x10\x04\x12!\n\x1dNODE_CAPABILITY_KIND_HARDWARE\x10\x05\x12\x1e\n\x1aNODE_CAPABILITY_KIND_DEBUG\x10\x06*\xc1\x01\n\x17NodeCapabilityDirection\x12)\n%NODE_CAPABILITY_DIRECTION_UNSPECIFIED\x10\x00\x12&\n\"NODE_CAPABILITY_DIRECTION_PRODUCER\x10\x01\x12&\n\"NODE_CAPABILITY_DIRECTION_CONSUMER\x10\x02\x12+\n\'NODE_CAPABILITY_DIRECTION_BIDIRECTIONAL\x10\x03\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'pulsefield.protocol.v1.core_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  DESCRIPTOR._loaded_options = None
+  _globals['_NODEROLE']._serialized_start=505
+  _globals['_NODEROLE']._serialized_end=670
+  _globals['_NODECAPABILITYKIND']._serialized_start=673
+  _globals['_NODECAPABILITYKIND']._serialized_end=942
+  _globals['_NODECAPABILITYDIRECTION']._serialized_start=945
+  _globals['_NODECAPABILITYDIRECTION']._serialized_end=1138
+  _globals['_NODECAPABILITY']._serialized_start=62
+  _globals['_NODECAPABILITY']._serialized_end=267
+  _globals['_NODEHELLO']._serialized_start=270
+  _globals['_NODEHELLO']._serialized_end=502
+# @@protoc_insertion_point(module_scope)

package/gen/python/pulsefield/protocol/v1/core_pb2.pyi

@@ -0,0 +1,76 @@
+from google.protobuf.internal import containers as _containers
+from google.protobuf.internal import enum_type_wrapper as _enum_type_wrapper
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import message as _message
+from typing import ClassVar as _ClassVar, Iterable as _Iterable, Mapping as _Mapping, Optional as _Optional, Union as _Union
+
+DESCRIPTOR: _descriptor.FileDescriptor
+
+class NodeRole(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
+    __slots__ = ()
+    NODE_ROLE_UNSPECIFIED: _ClassVar[NodeRole]
+    NODE_ROLE_HOST: _ClassVar[NodeRole]
+    NODE_ROLE_PLAYER_CLIENT: _ClassVar[NodeRole]
+    NODE_ROLE_MODEL_SERVICE: _ClassVar[NodeRole]
+    NODE_ROLE_HARDWARE: _ClassVar[NodeRole]
+    NODE_ROLE_DEBUG_TOOL: _ClassVar[NodeRole]
+
+class NodeCapabilityKind(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
+    __slots__ = ()
+    NODE_CAPABILITY_KIND_UNSPECIFIED: _ClassVar[NodeCapabilityKind]
+    NODE_CAPABILITY_KIND_RECOGNITION: _ClassVar[NodeCapabilityKind]
+    NODE_CAPABILITY_KIND_TIMING: _ClassVar[NodeCapabilityKind]
+    NODE_CAPABILITY_KIND_MAPPER: _ClassVar[NodeCapabilityKind]
+    NODE_CAPABILITY_KIND_PLAYER_STREAM: _ClassVar[NodeCapabilityKind]
+    NODE_CAPABILITY_KIND_HARDWARE: _ClassVar[NodeCapabilityKind]
+    NODE_CAPABILITY_KIND_DEBUG: _ClassVar[NodeCapabilityKind]
+
+class NodeCapabilityDirection(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
+    __slots__ = ()
+    NODE_CAPABILITY_DIRECTION_UNSPECIFIED: _ClassVar[NodeCapabilityDirection]
+    NODE_CAPABILITY_DIRECTION_PRODUCER: _ClassVar[NodeCapabilityDirection]
+    NODE_CAPABILITY_DIRECTION_CONSUMER: _ClassVar[NodeCapabilityDirection]
+    NODE_CAPABILITY_DIRECTION_BIDIRECTIONAL: _ClassVar[NodeCapabilityDirection]
+NODE_ROLE_UNSPECIFIED: NodeRole
+NODE_ROLE_HOST: NodeRole
+NODE_ROLE_PLAYER_CLIENT: NodeRole
+NODE_ROLE_MODEL_SERVICE: NodeRole
+NODE_ROLE_HARDWARE: NodeRole
+NODE_ROLE_DEBUG_TOOL: NodeRole
+NODE_CAPABILITY_KIND_UNSPECIFIED: NodeCapabilityKind
+NODE_CAPABILITY_KIND_RECOGNITION: NodeCapabilityKind
+NODE_CAPABILITY_KIND_TIMING: NodeCapabilityKind
+NODE_CAPABILITY_KIND_MAPPER: NodeCapabilityKind
+NODE_CAPABILITY_KIND_PLAYER_STREAM: NodeCapabilityKind
+NODE_CAPABILITY_KIND_HARDWARE: NodeCapabilityKind
+NODE_CAPABILITY_KIND_DEBUG: NodeCapabilityKind
+NODE_CAPABILITY_DIRECTION_UNSPECIFIED: NodeCapabilityDirection
+NODE_CAPABILITY_DIRECTION_PRODUCER: NodeCapabilityDirection
+NODE_CAPABILITY_DIRECTION_CONSUMER: NodeCapabilityDirection
+NODE_CAPABILITY_DIRECTION_BIDIRECTIONAL: NodeCapabilityDirection
+
+class NodeCapability(_message.Message):
+    __slots__ = ("kind", "name", "version", "direction")
+    KIND_FIELD_NUMBER: _ClassVar[int]
+    NAME_FIELD_NUMBER: _ClassVar[int]
+    VERSION_FIELD_NUMBER: _ClassVar[int]
+    DIRECTION_FIELD_NUMBER: _ClassVar[int]
+    kind: NodeCapabilityKind
+    name: str
+    version: str
+    direction: NodeCapabilityDirection
+    def __init__(self, kind: _Optional[_Union[NodeCapabilityKind, str]] = ..., name: _Optional[str] = ..., version: _Optional[str] = ..., direction: _Optional[_Union[NodeCapabilityDirection, str]] = ...) -> None: ...
+
+class NodeHello(_message.Message):
+    __slots__ = ("node_id", "role", "capabilities", "protocol_version", "app_id")
+    NODE_ID_FIELD_NUMBER: _ClassVar[int]
+    ROLE_FIELD_NUMBER: _ClassVar[int]
+    CAPABILITIES_FIELD_NUMBER: _ClassVar[int]
+    PROTOCOL_VERSION_FIELD_NUMBER: _ClassVar[int]
+    APP_ID_FIELD_NUMBER: _ClassVar[int]
+    node_id: str
+    role: NodeRole
+    capabilities: _containers.RepeatedCompositeFieldContainer[NodeCapability]
+    protocol_version: str
+    app_id: str
+    def __init__(self, node_id: _Optional[str] = ..., role: _Optional[_Union[NodeRole, str]] = ..., capabilities: _Optional[_Iterable[_Union[NodeCapability, _Mapping]]] = ..., protocol_version: _Optional[str] = ..., app_id: _Optional[str] = ...) -> None: ...