IS-14 support

Development/cmake/NmosCppLibraries.cmake

@@ -834,6 +834,90 @@ target_include_directories(nmos_is12_schemas PUBLIC
 list(APPEND NMOS_CPP_TARGETS nmos_is12_schemas)
 add_library(nmos-cpp::nmos_is12_schemas ALIAS nmos_is12_schemas)
 
+# nmos_is14_schemas library
+
+set(NMOS_IS14_SCHEMAS_HEADERS
+    nmos/is14_schemas/is14_schemas.h
+    )
+
+set(NMOS_IS14_V1_0_TAG v1.0.x)
+
+set(NMOS_IS14_V1_0_SCHEMAS_JSON
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/base.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/bulkProperties-get-response.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/bulkProperties-set-request.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/bulkProperties-set-response.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/bulkProperties-validate-request.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/bulkProperties-validate-response.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/descriptor-get.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/method-patch-request.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/method-patch-response.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/methods-base.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/ms05-error.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/properties-base.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/property.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/property-descriptor.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/property-value-get.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/property-value-put-request.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/property-value-put-response.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/rolePath.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/rolePaths-base.json
+    )
+
+set(NMOS_IS14_SCHEMAS_JSON_MATCH "third_party/is-14/([^/]+)/APIs/schemas/([^;]+)\\.json")
+set(NMOS_IS14_SCHEMAS_SOURCE_REPLACE "${CMAKE_CURRENT_BINARY_DIR_REPLACE}/nmos/is14_schemas/\\1/\\2.cpp")
+string(REGEX REPLACE "${NMOS_IS14_SCHEMAS_JSON_MATCH}(;|$)" "${NMOS_IS14_SCHEMAS_SOURCE_REPLACE}\\3" NMOS_IS14_V1_0_SCHEMAS_SOURCES "${NMOS_IS14_V1_0_SCHEMAS_JSON}")
+
+foreach(JSON ${NMOS_IS14_V1_0_SCHEMAS_JSON})
+    string(REGEX REPLACE "${NMOS_IS14_SCHEMAS_JSON_MATCH}" "${NMOS_IS14_SCHEMAS_SOURCE_REPLACE}" SOURCE "${JSON}")
+    string(REGEX REPLACE "${NMOS_IS14_SCHEMAS_JSON_MATCH}" "\\1" NS "${JSON}")
+    string(REGEX REPLACE "${NMOS_IS14_SCHEMAS_JSON_MATCH}" "\\2" VAR "${JSON}")
+    string(MAKE_C_IDENTIFIER "${NS}" NS)
+    string(MAKE_C_IDENTIFIER "${VAR}" VAR)
+
+    file(WRITE "${SOURCE}.in" "\
+// Auto-generated from: ${JSON}\n\
+\n\
+namespace nmos\n\
+{\n\
+    namespace is14_schemas\n\
+    {\n\
+        namespace ${NS}\n\
+        {\n\
+            const char* ${VAR} = R\"-auto-generated-(")
+
+    file(READ "${JSON}" RAW)
+    file(APPEND "${SOURCE}.in" "${RAW}")
+
+    file(APPEND "${SOURCE}.in" ")-auto-generated-\";\n\
+        }\n\
+    }\n\
+}\n")
+
+    configure_file("${SOURCE}.in" "${SOURCE}" COPYONLY)
+endforeach()
+
+add_library(
+    nmos_is14_schemas STATIC
+    ${NMOS_IS14_SCHEMAS_HEADERS}
+    ${NMOS_IS14_V1_0_SCHEMAS_SOURCES}
+    )
+
+source_group("nmos\\is14_schemas\\Header Files" FILES ${NMOS_IS14_SCHEMAS_HEADERS})
+source_group("nmos\\is14_schemas\\${NMOS_IS14_V1_0_TAG}\\Source Files" FILES ${NMOS_IS14_V1_0_SCHEMAS_SOURCES})
+
+target_link_libraries(
+    nmos_is14_schemas PRIVATE
+    nmos-cpp::compile-settings
+    )
+target_include_directories(nmos_is14_schemas PUBLIC
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
+    $<INSTALL_INTERFACE:${NMOS_CPP_INSTALL_INCLUDEDIR}>
+    )
+
+list(APPEND NMOS_CPP_TARGETS nmos_is14_schemas)
+add_library(nmos-cpp::nmos_is14_schemas ALIAS nmos_is14_schemas)
+
 # nmos-cpp library
 
 set(NMOS_CPP_BST_SOURCES
@@ -921,6 +1005,7 @@ set(NMOS_CPP_NMOS_SOURCES
     nmos/channels.cpp
     nmos/client_utils.cpp
     nmos/components.cpp
+    nmos/configuration_api.cpp
     nmos/connection_activation.cpp
     nmos/connection_api.cpp
     nmos/connection_events_activation.cpp
@@ -1014,6 +1099,7 @@ set(NMOS_CPP_NMOS_HEADERS
     nmos/colorspace.h
     nmos/components.h
     nmos/copyable_atomic.h
+    nmos/configuration_api.h
     nmos/connection_activation.h
     nmos/connection_api.h
     nmos/connection_events_activation.h
@@ -1048,6 +1134,7 @@ set(NMOS_CPP_NMOS_HEADERS
     nmos/is09_versions.h
     nmos/is10_versions.h
     nmos/is12_versions.h
+    nmos/is14_versions.h
     nmos/issuers.h
     nmos/json_fields.h
     nmos/json_schema.h
@@ -1198,6 +1285,7 @@ target_link_libraries(
     nmos-cpp::nmos_is09_schemas
     nmos-cpp::nmos_is10_schemas
     nmos-cpp::nmos_is12_schemas
+    nmos-cpp::nmos_is14_schemas
     nmos-cpp::mdns
     nmos-cpp::slog
     nmos-cpp::OpenSSL

Development/nmos-cpp-node/node_implementation.cpp

@@ -1008,31 +1008,31 @@ void node_implementation_init(nmos::node_model& model, nmos::experimental::contr
                 nmos::experimental::make_control_class_property_descriptor(U("Example object sequence property"), { 3, 14 }, object_sequence, U("ExampleDataType"), false, false, true)
             };
 
-            auto example_method_with_no_args = [](nmos::resources& resources, const nmos::resource& resource, int32_t handle, const web::json::value& arguments, bool is_deprecated, slog::base_gate& gate)
+            auto example_method_with_no_args = [](nmos::resources& resources, const nmos::resource& resource, const web::json::value& arguments, bool is_deprecated, slog::base_gate& gate)
             {
                 // note, model mutex is already locked by the outer function, so access to control_protocol_resources is OK...
 
                 slog::log<slog::severities::more_info>(gate, SLOG_FLF) << "Executing the example method with no arguments";
 
-                return nmos::make_control_protocol_message_response(handle, { is_deprecated ? nmos::nc_method_status::method_deprecated : nmos::nc_method_status::ok });
+                return nmos::details::make_nc_method_result({ is_deprecated ? nmos::nc_method_status::method_deprecated : nmos::nc_method_status::ok });
             };
-            auto example_method_with_simple_args = [](nmos::resources& resources, const nmos::resource& resource, int32_t handle, const web::json::value& arguments, bool is_deprecated, slog::base_gate& gate)
+            auto example_method_with_simple_args = [](nmos::resources& resources, const nmos::resource& resource, const web::json::value& arguments, bool is_deprecated, slog::base_gate& gate)
             {
                 // note, model mutex is already locked by the outer function, so access to control_protocol_resources is OK...
                 // and the method parameters constriants has already been validated by the outer function
 
                 slog::log<slog::severities::more_info>(gate, SLOG_FLF) << "Executing the example method with simple arguments: " << arguments.serialize();
 
-                return nmos::make_control_protocol_message_response(handle, { is_deprecated ? nmos::nc_method_status::method_deprecated : nmos::nc_method_status::ok });
+                return nmos::details::make_nc_method_result({ is_deprecated ? nmos::nc_method_status::method_deprecated : nmos::nc_method_status::ok });
             };
-            auto example_method_with_object_args = [](nmos::resources& resources, const nmos::resource& resource, int32_t handle, const web::json::value& arguments, bool is_deprecated, slog::base_gate& gate)
+            auto example_method_with_object_args = [](nmos::resources& resources, const nmos::resource& resource, const web::json::value& arguments, bool is_deprecated, slog::base_gate& gate)
             {
                 // note, model mutex is already locked by the outer function, so access to control_protocol_resources is OK...
                 // and the method parameters constriants has already been validated by the outer function
 
                 slog::log<slog::severities::more_info>(gate, SLOG_FLF) << "Executing the example method with object argument: " << arguments.serialize();
 
-                return nmos::make_control_protocol_message_response(handle, { is_deprecated ? nmos::nc_method_status::method_deprecated : nmos::nc_method_status::ok });
+                return nmos::details::make_nc_method_result({ is_deprecated ? nmos::nc_method_status::method_deprecated : nmos::nc_method_status::ok });
             };
             // Example control class method descriptors
             std::vector<nmos::experimental::method> example_control_method_descriptors =
@@ -1113,7 +1113,7 @@ void node_implementation_init(nmos::node_model& model, nmos::experimental::contr
         // helper function to create Example control instance
         auto make_example_control = [&](nmos::nc_oid oid, nmos::nc_oid owner, const utility::string_t& role, const utility::string_t& user_label, const utility::string_t& description, const value& touchpoints,
             const value& runtime_property_constraints,  // level 2: runtime constraints. See https://specs.amwa.tv/ms-05-02/branches/v1.0.x/docs/Constraints.html
-                                                                        // use of make_nc_property_constraints_string and make_nc_property_constraints_number to create runtime constraints
+                                                        // use of make_nc_property_constraints_string and make_nc_property_constraints_number to create runtime constraints
             example_enum enum_property_,
             const utility::string_t& string_property_,
             uint64_t number_property_,

Development/nmos/api_utils.h

@@ -57,6 +57,8 @@ namespace nmos
         const route_pattern channelmapping_api = make_route_pattern(U("api"), U("channelmapping"));
         // IS-09 System API (originally specified in JT-NM TR-1001-1:2018 Annex A)
         const route_pattern system_api = make_route_pattern(U("api"), U("system"));
+        // IS-14 Configuration API
+        const route_pattern configuration_api = make_route_pattern(U("api"), U("configuration"));
 
         // API version pattern
         const route_pattern version = make_route_pattern(U("version"), U("v[0-9]+\\.[0-9]+"));
@@ -87,6 +89,11 @@ namespace nmos
         const route_pattern outputSubroute = make_route_pattern(U("outputSubroute"), U("properties|sourceid|channels|caps"));
         const route_pattern activationId = make_route_pattern(U("activationId"), U("[a-zA-Z0-9\\-_]+"));
 
+        // Configuration API
+        const route_pattern rolePath = make_route_pattern(U("rolePath"), U("root|root\\.[a-zA-Z0-9\\-_\\.]+"));
+        const route_pattern propertyId = make_route_pattern(U("propertyId"), U("[0-9]+p[0-9]+"));
+        const route_pattern methodId = make_route_pattern(U("methodId"), U("[0-9]+m[0-9]+"));
+
         // Common patterns
         const route_pattern resourceId = make_route_pattern(U("resourceId"), U("[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}"));
     }