Sync IS-11 Status with the spec

Development/nmos/connection_api.cpp

@@ -465,7 +465,7 @@ namespace nmos
                     auto streamcompatibility_resource = find_resource(model.streamcompatibility_resources, id_type);
                     if (model.streamcompatibility_resources.end() != streamcompatibility_resource)
                     {
-                        auto resource_state = nmos::fields::state(nmos::fields::status(nmos::fields::endpoint_status(streamcompatibility_resource->data)));
+                        auto resource_state = nmos::fields::state(nmos::fields::status(streamcompatibility_resource->data));
 
                         if (resource_state == nmos::sender_states::active_constraints_violation.name || resource_state == nmos::receiver_states::non_compliant_stream.name)
                         {

Development/nmos/json_fields.h

@@ -251,10 +251,9 @@ namespace nmos
         const web::json::field_as_array parameter_constraints{ U("parameter_constraints") };
 
         // for status
-        const web::json::field_as_value endpoint_status{ U("endpoint_status") }; // object
-        const web::json::field_as_string signal_state{ U("signal_state") };
         const web::json::field_as_value status{ U("status") }; // object
         const web::json::field_as_string state{ U("state") };
+        const web::json::field_as_string debug{ U("debug") };
 
         // for EDID endpoints
         const web::json::field_as_value_or endpoint_base_edid{ U("endpoint_base_edid"), {} }; // object

Development/nmos/streamcompatibility_api.cpp

@@ -388,7 +388,7 @@ namespace nmos
                         throw std::logic_error("matching IS-04 resource not found");
                     }
 
-                    set_reply(res, status_codes::OK, nmos::fields::status(nmos::fields::endpoint_status(resource->data)));
+                    set_reply(res, status_codes::OK, nmos::fields::status(resource->data));
                 }
                 else if (nmos::details::is_erased_resource(resources, id_type))
                 {

Development/nmos/streamcompatibility_behaviour.cpp

@@ -170,10 +170,10 @@ namespace nmos
                             auto connection_sender = find_resource(connection_resources, sender_id_type);
                             if (connection_resources.end() == connection_sender) throw std::logic_error("Matching IS-05 Sender not found");
 
-                            nmos::signal_state signal_state(nmos::fields::signal_state(nmos::fields::endpoint_status(streamcompatibility_sender->data)));
-                            nmos::sender_state sender_state(signal_state.name);
+                            nmos::sender_state sender_state(nmos::fields::state(nmos::fields::status(streamcompatibility_sender->data)));
 
-                            if (signal_state == nmos::signal_states::signal_is_present)
+                            // Setting the State to any value except for "no_essence" or "awaiting_essence" triggers Active Constraints validation
+                            if (sender_state != nmos::sender_states::no_essence && sender_state != nmos::sender_states::awaiting_essence)
                             {
                                 const auto& constraint_sets = nmos::fields::constraint_sets(nmos::fields::active_constraint_sets(nmos::fields::endpoint_active_constraints(streamcompatibility_sender->data))).as_array();
                                 auto& transport_file = nmos::fields::endpoint_transportfile(connection_sender->data);
@@ -182,13 +182,13 @@ namespace nmos
                                 sender_state = validate_sender_resources(transport_file, flow->data, source->data, constraint_sets);
                             }
 
-                            if (nmos::fields::state(nmos::fields::status(nmos::fields::endpoint_status(streamcompatibility_sender->data))) != sender_state.name)
+                            if (nmos::fields::state(nmos::fields::status(streamcompatibility_sender->data)) != sender_state.name)
                             {
                                 utility::string_t updated_timestamp;
 
                                 modify_resource(streamcompatibility_resources, sender_id, [&sender_state, &updated_timestamp, &gate](nmos::resource& sender)
                                 {
-                                    nmos::fields::status(nmos::fields::endpoint_status(sender.data))[nmos::fields::state] = web::json::value::string(sender_state.name);
+                                    nmos::fields::status(sender.data)[nmos::fields::state] = web::json::value::string(sender_state.name);
 
                                     updated_timestamp = nmos::make_version();
                                     sender.data[nmos::fields::version] = web::json::value::string(updated_timestamp);
@@ -254,13 +254,13 @@ namespace nmos
 
                             receiver_state = validate_receiver_resources(transport_file, receiver->data);
 
-                            if (nmos::fields::state(nmos::fields::status(nmos::fields::endpoint_status(streamcompatibility_receiver->data))) != receiver_state.name)
+                            if (nmos::fields::state(nmos::fields::status(streamcompatibility_receiver->data)) != receiver_state.name)
                             {
                                 utility::string_t updated_timestamp;
 
                                 modify_resource(streamcompatibility_resources, receiver_id, [&receiver_state, &updated_timestamp, &gate](nmos::resource& receiver)
                                 {
-                                    nmos::fields::status(nmos::fields::endpoint_status(receiver.data))[nmos::fields::state] = web::json::value::string(receiver_state.name);
+                                    nmos::fields::status(receiver.data)[nmos::fields::state] = web::json::value::string(receiver_state.name);
 
                                     updated_timestamp = nmos::make_version();
                                     receiver.data[nmos::fields::version] = web::json::value::string(updated_timestamp);

Development/nmos/streamcompatibility_resources.cpp

@@ -24,20 +24,6 @@ namespace nmos
             });
         }
 
-        web::json::value make_streamcompatibility_sender_status_endpoint(nmos::sender_state sender_state, nmos::signal_state signal_state)
-        {
-            using web::json::value_of;
-
-            auto sender_status = value_of({
-                { nmos::fields::state, sender_state.name },
-            });
-
-            return value_of({
-                { nmos::fields::status, sender_status },
-                { nmos::fields::signal_state, signal_state.name },
-            });
-        }
-
         nmos::resource make_streamcompatibility_sender(const nmos::id& id, const std::vector<nmos::id>& inputs, const std::vector<utility::string_t>& param_constraints)
         {
             using web::json::value;
@@ -73,7 +59,7 @@ namespace nmos
                 { nmos::fields::endpoint_active_constraints, make_streamcompatibility_active_constraints_endpoint(value::array()) },
                 { nmos::fields::inputs, value_from_elements(inputs) },
                 { nmos::fields::supported_param_constraints, supported_param_constraints },
-                { nmos::fields::endpoint_status, make_streamcompatibility_sender_status_endpoint(nmos::sender_states::unconstrained, nmos::signal_states::signal_is_present) },
+                { nmos::fields::status, value_of({ { nmos::fields::state, nmos::sender_states::unconstrained.name } }) },
             });
 
             return{ is11_versions::v1_0, types::sender, std::move(data), id, false };
@@ -84,19 +70,11 @@ namespace nmos
             using web::json::value_of;
             using web::json::value_from_elements;
 
-            auto receiver_status = value_of({
-                { nmos::fields::state, nmos::receiver_states::unknown.name },
-            });
-
-            auto endpoint_status = value_of({
-                { nmos::fields::status, receiver_status },
-            });
-
             auto data = value_of({
                 { nmos::fields::id, id },
                 { nmos::fields::device_id, U("these are not the droids you are looking for") },
                 { nmos::fields::outputs, value_from_elements(outputs) },
-                { nmos::fields::endpoint_status, endpoint_status },
+                { nmos::fields::status, value_of({ { nmos::fields::state, nmos::receiver_states::unknown.name } }) },
             });
 
             return{ is11_versions::v1_0, types::receiver, std::move(data), id, false };
@@ -146,16 +124,19 @@ namespace nmos
         nmos::resource make_streamcompatibility_input(const nmos::id& id, bool connected, const std::vector<nmos::id>& senders, const nmos::settings& settings)
         {
             using web::json::value_from_elements;
+            using web::json::value_of;
 
             auto data = make_streamcompatibility_input_output_base(id, connected, false, settings);
             data[nmos::fields::senders] = value_from_elements(senders);
+            data[nmos::fields::status] = value_of({ { nmos::fields::state, nmos::input_states::signal_present.name } });
 
             return{ is11_versions::v1_0, types::input, std::move(data), id, false };
         }
 
         nmos::resource make_streamcompatibility_input(const nmos::id& id, bool connected, bool base_edid_changeable, const boost::variant<utility::string_t, web::uri>& effective_edid, const bst::optional<web::json::value>& effective_edid_properties, const std::vector<nmos::id>& senders, const nmos::settings& settings)
         {
             using web::json::value_from_elements;
+            using web::json::value_of;
 
             auto data = make_streamcompatibility_input_output_base(id, connected, true, settings);
 
@@ -172,26 +153,31 @@ namespace nmos
             }
 
             data[nmos::fields::senders] = value_from_elements(senders);
+            data[nmos::fields::status] = value_of({ { nmos::fields::state, nmos::input_states::signal_present.name } });
 
             return{ is11_versions::v1_0, types::input, std::move(data), id, false };
         }
 
         nmos::resource make_streamcompatibility_output(const nmos::id& id, bool connected, const std::vector<nmos::id>& receivers, const nmos::settings& settings)
         {
             using web::json::value_from_elements;
+            using web::json::value_of;
 
             auto data = make_streamcompatibility_input_output_base(id, connected, false, settings);
             data[nmos::fields::receivers] = value_from_elements(receivers);
+            data[nmos::fields::status] = value_of({ { nmos::fields::state, nmos::output_states::signal_present.name } });
 
             return{ is11_versions::v1_0, types::output, std::move(data), id, false };
         }
 
         nmos::resource make_streamcompatibility_output(const nmos::id& id, bool connected, const bst::optional<boost::variant<utility::string_t, web::uri>>& edid, const bst::optional<web::json::value>& edid_properties, const std::vector<nmos::id>& receivers, const nmos::settings& settings)
         {
             using web::json::value_from_elements;
+            using web::json::value_of;
 
             auto data = make_streamcompatibility_input_output_base(id, connected, true, settings);
             data[nmos::fields::receivers] = value_from_elements(receivers);
+            data[nmos::fields::status] = value_of({ { nmos::fields::state, nmos::output_states::signal_present.name } });
 
             if (edid)
             {

Development/nmos/streamcompatibility_state.h

@@ -5,30 +5,42 @@
 
 namespace nmos
 {
+    // Stream Compatibility Input states
+    // See https://specs.amwa.tv/is-11/branches/v1.0-dev/docs/Behaviour_-_Server_Side.html#status-of-input
+    // and https://specs.amwa.tv/is-11/branches/v1.0-dev/APIs/schemas/with-refs/input.html
+    DEFINE_STRING_ENUM(input_state)
+    namespace input_states
+    {
+        const input_state no_signal{ U("no_signal") };
+        const input_state awaiting_signal{ U("awaiting_signal") };
+        const input_state signal_present{ U("signal_present") };
+    }
+
+    // Stream Compatibility Output states
+    // See https://specs.amwa.tv/is-11/branches/v1.0-dev/docs/Behaviour_-_Server_Side.html#status-of-output
+    // and https://specs.amwa.tv/is-11/branches/v1.0-dev/APIs/schemas/with-refs/output.html
+    DEFINE_STRING_ENUM(output_state)
+    namespace output_states
+    {
+        const output_state no_signal{ U("no_signal") };
+        const output_state signal_present{ U("signal_present") };
+    }
+
     // Stream Compatibility Sender states
-    // See https://specs.amwa.tv/is-11/branches/v1.0-dev/docs/Behaviour_-_Server_Side.html#state-of-sender
+    // See https://specs.amwa.tv/is-11/branches/v1.0-dev/docs/Behaviour_-_Server_Side.html#status-of-sender
     // and https://specs.amwa.tv/is-11/branches/v1.0-dev/APIs/schemas/with-refs/sender-status.html
     DEFINE_STRING_ENUM(sender_state)
     namespace sender_states
     {
-        const sender_state no_signal{ U("no_signal") };
-        const sender_state awaiting_signal{ U("awaiting_signal") };
+        const sender_state no_essence{ U("no_essence") };
+        const sender_state awaiting_essence{ U("awaiting_essence") };
         const sender_state unconstrained{ U("unconstrained") };
         const sender_state constrained{ U("constrained") };
         const sender_state active_constraints_violation{ U("active_constraints_violation") };
     }
 
-    // State of the signal coming into a Sender from its Inputs. It is used to set Sender Status properly.
-    DEFINE_STRING_ENUM(signal_state)
-    namespace signal_states
-    {
-        const sender_state no_signal{ U("no_signal") };
-        const sender_state awaiting_signal{ U("awaiting_signal") };
-        const signal_state signal_is_present{ U("signal_is_present") };
-    }
-
     // Stream Compatibility Receiver states
-    // See https://specs.amwa.tv/is-11/branches/v1.0-dev/docs/Behaviour_-_Server_Side.html#state-of-receiver
+    // See https://specs.amwa.tv/is-11/branches/v1.0-dev/docs/Behaviour_-_Server_Side.html#status-of-receiver
     // and https://specs.amwa.tv/is-11/branches/v1.0-dev/APIs/schemas/with-refs/receiver-status.html
     DEFINE_STRING_ENUM(receiver_state)
     namespace receiver_states