Merge pull request #12 from mondain/draft-18

Draft 18

Author: mondain

.gitignore

@@ -6,8 +6,19 @@
 
 # CMake
 CMakeUserPresets.json
+CMakeCache.txt
+CMakeFiles/
+CTestTestfile.cmake
+DartConfiguration.tcl
+Makefile
+cmake_install.cmake
 Testing/
 
+# In-source build binaries
+/openmoq-publisher
+/openmoq-publisher-*-tests
+/libopenmoq_publisher_lib.a
+
 # Editors
 .DS_Store
 .idea/

CMakeLists.txt

@@ -61,7 +61,7 @@ if(OPENMOQ_ENABLE_PICOQUIC AND EXISTS "${OPENMOQ_PICOQUIC_SOURCE_DIR}/CMakeLists
             # all of which compile sources that transitively include picotls.h.
             include_directories(BEFORE "${OPENMOQ_PICOTLS_SOURCE_DIR}/picotlsvs/picotls")
         endif()
-        if(APPLE)
+        if(NOT WIN32)
             # picotls appends literal "(" and ")" list items when Brotli is
             # discovered via pkg-config. On macOS, CMake rejects the resulting
             # malformed source-prefixed link directories during generate. Scope
@@ -73,7 +73,7 @@ if(OPENMOQ_ENABLE_PICOQUIC AND EXISTS "${OPENMOQ_PICOQUIC_SOURCE_DIR}/CMakeLists
             file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/openmoq-empty-pkgconfig")
         endif()
         add_subdirectory("${OPENMOQ_PICOQUIC_SOURCE_DIR}" "${CMAKE_CURRENT_BINARY_DIR}/picoquic")
-        if(APPLE)
+        if(NOT WIN32)
             set(ENV{PKG_CONFIG_LIBDIR} "${_openmoq_saved_pkg_config_libdir}")
             set(ENV{PKG_CONFIG_PATH} "${_openmoq_saved_pkg_config_path}")
             unset(_openmoq_saved_pkg_config_libdir)
@@ -199,6 +199,12 @@ if(OPENMOQ_BUILD_TESTS)
     target_link_libraries(openmoq-publisher-api-tests PRIVATE openmoq_publisher_lib)
     add_test(NAME openmoq-publisher-api-tests COMMAND openmoq-publisher-api-tests)
 
+    add_executable(openmoq-publisher-control-message-tests
+        tests/moqt_control_messages_test.cpp
+    )
+    target_link_libraries(openmoq-publisher-control-message-tests PRIVATE openmoq_publisher_lib)
+    add_test(NAME openmoq-publisher-control-message-tests COMMAND openmoq-publisher-control-message-tests)
+
     if(OPENMOQ_HAS_PICOQUIC AND OPENMOQ_RUN_PICOQUIC_SMOKE_TESTS)
         add_executable(openmoq-publisher-picoquic-smoke-tests
             tests/picoquic_smoke_test.cpp

README.md

@@ -2,7 +2,7 @@
 
 `moqxr` is a C++20 OpenMOQ publisher contribution project for Linux, macOS, and Windows.
 
-It packages MP4 input into CMSF-style publishable objects, supports MOQT draft-specific framing for drafts 14 and 16, and can either inspect the generated publish plan locally or publish it over a picoquic-backed transport when local `picoquic` and `picotls` checkouts are available.
+It packages MP4 input into CMSF-style publishable objects, supports MOQT draft-specific framing for drafts 14, 16, and 18, and can either inspect the generated publish plan locally or publish it over a picoquic-backed transport when local `picoquic` and `picotls` checkouts are available.
 
 ## Overview
 
@@ -42,6 +42,7 @@ This keeps the project aligned with CMAF-style publication while reusing the sam
 
 - `draft-ietf-moq-transport-14` is the primary target
 - `draft-ietf-moq-transport-16` is represented as a secondary compatibility profile
+- `draft-ietf-moq-transport-18` support is implemented for version selection, setup/request framing codec paths, and request-stream response correlation; interop hardening is still in progress
 - draft-specific assumptions are documented in [docs/protocol-mapping.md](docs/protocol-mapping.md)
 
 ## Repository layout
@@ -51,6 +52,7 @@ This keeps the project aligned with CMAF-style publication while reusing the sam
 - `tests`: CTest-based unit coverage
 - `docs`: protocol notes and design references
 - `docs/publisher-api.md`: step-by-step application integration guide for the C++ publisher API
+- `docs/draft18-implementation-plan.md`: implementation plan for draft-18 transport support
 - `docs/transport-plan.md`: picoquic integration plan and implementation checklist
 - `.github/workflows/ci.yml`: GitHub Actions build and test workflow for Linux, macOS, and Windows
 - `.github/workflows/release.yml`: GitHub Actions release-build workflow that uploads Linux, macOS, and Windows archives

docs/draft18-implementation-plan.md

@@ -0,0 +1,131 @@
+# Draft-18 Implementation Plan
+
+This plan tracks adding `draft-ietf-moq-transport-18` support to `moqxr`.
+
+Reference reviewed: <https://datatracker.ietf.org/doc/html/draft-ietf-moq-transport-18> (12 May 2026).
+
+## Goals
+
+1. Add draft-18 as a selectable profile in CLI and API.
+2. Preserve existing draft-14 and draft-16 behavior.
+3. Incrementally introduce draft-18 wire semantics with tests at each phase.
+
+## Current Status
+
+- Completed:
+  - Phase A: version plumbing (`kDraft18`, CLI/API selection, ALPN defaults).
+  - Phase B: draft-18 codec support in control messages:
+    - `SETUP` (`0x2F00`) handling.
+    - setup options parsing/encoding for `PATH` and `AUTHORITY`.
+    - draft-18 `REQUEST_OK` / `REQUEST_ERROR` parsing support.
+    - dedicated control-message tests.
+  - Phase C (partial): request-stream semantics in session layer:
+    - per-request bidirectional stream request/response flow for namespace/publish paths.
+    - strict response correlation on request streams, including:
+      - unexpected response type rejection
+      - GOAWAY rejection on request stream
+      - duplicate terminal response rejection
+    - legacy (draft-14/16) shared-control-stream publish response ID validation hardening.
+- Remaining:
+  - Complete Phase C across all request categories used by this publisher.
+  - Phase D data-stream/object framing alignment and additional draft-18 conformance checks.
+  - Phase E interop and production hardening.
+
+## Phase A: Version Plumbing (Low Risk)
+
+Files:
+
+- `include/openmoq/publisher/moq_draft.h`
+- `src/moq_draft.cpp`
+- `src/cli_options.cpp`
+- `src/publisher_api.cpp`
+- `tests/cli_options_test.cpp`
+
+Deliverables:
+
+1. `kDraft18` enum value and string conversion.
+2. ALPN default selection for raw QUIC (`moqt-18`).
+3. CLI accepts `--draft 18`.
+4. API maps WebTransport protocol offer for draft-18.
+5. Basic tests for draft parsing.
+
+## Phase B: Control Message Codec for Draft-18
+
+Primary files:
+
+- `include/openmoq/publisher/transport/moqt_control_messages.h`
+- `src/transport/moqt_control_messages.cpp`
+
+Work:
+
+1. Add draft-18 message constants:
+   - `SETUP` message type `0x2F00`.
+2. Implement draft-18 `SETUP` option KVP handling:
+   - `PATH (0x01)`
+   - `AUTHORITY (0x05)`
+   - Option parsing model that ignores unknown setup options.
+3. Add draft-18 `REQUEST_OK (0x07)` and `REQUEST_ERROR (0x05)` codec support.
+4. Introduce tests for message length/parsing and parameter handling.
+
+## Phase C: Session Request-Stream Semantics
+
+Primary file:
+
+- `src/transport/moqt_session.cpp`
+
+Work:
+
+1. Add draft-18 request stream lifecycle:
+   - one bidirectional stream per request type (`PUBLISH`, `SUBSCRIBE_NAMESPACE`, etc.).
+2. Read responses (`REQUEST_OK` / `REQUEST_ERROR`) on matching request stream.
+3. Keep existing control stream behavior for draft-14/16.
+4. Add per-request state bookkeeping and robust stream-close handling.
+
+Status:
+
+- Implemented for publish namespace and publish-track handshake paths.
+- Includes strict request-stream response validation and duplicate-response rejection.
+- Remaining stream choreography work is focused on full request coverage and expanded state tracking.
+
+## Phase D: Data Stream/Object Framing Alignment
+
+Primary files:
+
+- `src/transport/moqt_control_messages.cpp`
+- `src/transport/moqt_session.cpp`
+
+Work:
+
+1. Validate/align subgroup header flags for draft-18 (`0b0XX1XXXX` family).
+2. Add explicit handling for `FIRST_OBJECT` semantics.
+3. Confirm object ID delta handling and end-of-group behavior.
+4. Add regression tests with malformed inputs and expected protocol errors.
+
+## Phase E: Interop + Hardening
+
+Work:
+
+1. Add an interop checklist document for at least one draft-18 relay target.
+2. Capture failure taxonomy and map to existing `TransportStatus` messages.
+3. Confirm no regressions in:
+   - draft-14 test flows
+   - draft-16 test flows
+   - WebTransport connect flows
+
+## Test Strategy
+
+1. Unit tests for codec and message validation in `moqt_control_messages`.
+2. Session-level tests in `tests/moqt_session_test.cpp` for request-stream choreography.
+3. End-to-end sanity using existing build + ctest workflow.
+
+## Risks
+
+1. Architectural mismatch: current request ID flow vs draft-18 per-request streams.
+2. Parameter parsing strictness causing interop breakage if not version-gated.
+3. Unintended regressions to draft-14/draft-16 behavior.
+
+## Mitigations
+
+1. Strict version gates around all draft-18-only behavior.
+2. Land in small commits with tests per step.
+3. Preserve legacy paths untouched where practical.