-
Notifications
You must be signed in to change notification settings - Fork 84
/
Copy pathnode_implementation.cpp
1916 lines (1679 loc) · 117 KB
/
node_implementation.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#include "node_implementation.h"
#include <boost/range/adaptor/filtered.hpp>
#include <boost/range/adaptor/transformed.hpp>
#include <boost/range/algorithm/find.hpp>
#include <boost/range/algorithm/find_first_of.hpp>
#include <boost/range/algorithm/find_if.hpp>
#include <boost/range/algorithm_ext/push_back.hpp>
#include <boost/range/irange.hpp>
#include <boost/range/join.hpp>
#include "pplx/pplx_utils.h" // for pplx::complete_after, etc.
#include "cpprest/host_utils.h"
#ifdef HAVE_LLDP
#include "lldp/lldp_manager.h"
#endif
#include "nmos/activation_mode.h"
#include "nmos/capabilities.h"
#include "nmos/channels.h"
#include "nmos/channelmapping_resources.h"
#include "nmos/clock_name.h"
#include "nmos/colorspace.h"
#include "nmos/connection_resources.h"
#include "nmos/connection_events_activation.h"
#include "nmos/control_protocol_resources.h"
#include "nmos/control_protocol_resource.h"
#include "nmos/control_protocol_state.h"
#include "nmos/control_protocol_utils.h"
#include "nmos/events_resources.h"
#include "nmos/format.h"
#include "nmos/group_hint.h"
#include "nmos/interlace_mode.h"
#include "nmos/is12_versions.h" // for IS-12 gain control
#ifdef HAVE_LLDP
#include "nmos/lldp_manager.h"
#endif
#include "nmos/media_type.h"
#include "nmos/model.h"
#include "nmos/node_interfaces.h"
#include "nmos/node_resource.h"
#include "nmos/node_resources.h"
#include "nmos/node_server.h"
#include "nmos/random.h"
#include "nmos/sdp_utils.h"
#include "nmos/slog.h"
#include "nmos/st2110_21_sender_type.h"
#include "nmos/system_resources.h"
#include "nmos/transfer_characteristic.h"
#include "nmos/transport.h"
#include "nmos/video_jxsv.h"
#include "sdp/sdp.h"
// example node implementation details
namespace impl
{
// custom logging category for the example node implementation thread
namespace categories
{
const nmos::category node_implementation{ "node_implementation" };
}
// custom settings for the example node implementation
namespace fields
{
// node_tags, device_tags: used in resource tags fields
// "Each tag has a single key, but MAY have multiple values."
// See https://specs.amwa.tv/is-04/releases/v1.3.2/docs/APIs_-_Common_Keys.html#tags
// {
// "tag_1": [ "tag_1_value_1", "tag_1_value_2" ],
// "tag_2": [ "tag_2_value_1" ]
// }
const web::json::field_as_value_or node_tags{ U("node_tags"), web::json::value::object() };
const web::json::field_as_value_or device_tags{ U("device_tags"), web::json::value::object() };
// how_many: provides for very basic testing of a node with many sub-resources of each type
const web::json::field_as_integer_or how_many{ U("how_many"), 1 };
// activate_senders: controls whether to activate senders on start up (true, default) or not (false)
const web::json::field_as_bool_or activate_senders{ U("activate_senders"), true };
// senders, receivers: controls which kinds of sender and receiver are instantiated by the example node
// the values must be an array of unique strings identifying the kinds of 'port', like ["v", "a", "d"], see impl::ports
// when omitted, all ports are instantiated
const web::json::field_as_value_or senders{ U("senders"), {} };
const web::json::field_as_value_or receivers{ U("receivers"), {} };
// frame_rate: controls the grain_rate of video, audio and ancillary data sources and flows
// and the equivalent parameter constraint on video receivers
// the value must be an object like { "numerator": 25, "denominator": 1 }
// hm, unfortunately can't use nmos::make_rational(nmos::rates::rate25) during static initialization
const web::json::field_as_value_or frame_rate{ U("frame_rate"), web::json::value_of({
{ nmos::fields::numerator, 25 },
{ nmos::fields::denominator, 1 }
}) };
// frame_width, frame_height: control the frame_width and frame_height of video flows
const web::json::field_as_integer_or frame_width{ U("frame_width"), 1920 };
const web::json::field_as_integer_or frame_height{ U("frame_height"), 1080 };
// interlace_mode: controls the interlace_mode of video flows, see nmos::interlace_mode
// when omitted, a default of "progressive" or "interlaced_tff" is used based on the frame_rate, etc.
const web::json::field_as_string interlace_mode{ U("interlace_mode") };
// colorspace: controls the colorspace of video flows, see nmos::colorspace
const web::json::field_as_string_or colorspace{ U("colorspace"), U("BT709") };
// transfer_characteristic: controls the transfer characteristic system of video flows, see nmos::transfer_characteristic
const web::json::field_as_string_or transfer_characteristic{ U("transfer_characteristic"), U("SDR") };
// color_sampling: controls the color (sub-)sampling mode of video flows, see sdp::sampling
const web::json::field_as_string_or color_sampling{ U("color_sampling"), U("YCbCr-4:2:2") };
// component_depth: controls the bits per component sample of video flows
const web::json::field_as_integer_or component_depth{ U("component_depth"), 10 };
// video_type: media type of video flows, e.g. "video/raw" or "video/jxsv", see nmos::media_types
const web::json::field_as_string_or video_type{ U("video_type"), U("video/raw") };
// channel_count: controls the number of channels in audio sources
const web::json::field_as_integer_or channel_count{ U("channel_count"), 4 };
// smpte2022_7: controls whether senders and receivers have one leg (false) or two legs (true, default)
const web::json::field_as_bool_or smpte2022_7{ U("smpte2022_7"), true };
}
nmos::interlace_mode get_interlace_mode(const nmos::settings& settings);
// the different kinds of 'port' (standing for the format/media type/event type) implemented by the example node
// each 'port' of the example node has a source, flow, sender and/or compatible receiver
DEFINE_STRING_ENUM(port)
namespace ports
{
// video/raw, video/jxsv, etc.
const port video{ U("v") };
// audio/L24
const port audio{ U("a") };
// video/smpte291
const port data{ U("d") };
// video/SMPTE2022-6
const port mux{ U("m") };
// example measurement event
const port temperature{ U("t") };
// example boolean event
const port burn{ U("b") };
// example string event
const port nonsense{ U("s") };
// example number/enum event
const port catcall{ U("c") };
const std::vector<port> rtp{ video, audio, data, mux };
const std::vector<port> ws{ temperature, burn, nonsense, catcall };
const std::vector<port> all{ boost::copy_range<std::vector<port>>(boost::range::join(rtp, ws)) };
}
bool is_rtp_port(const port& port);
bool is_ws_port(const port& port);
std::vector<port> parse_ports(const web::json::value& value);
const std::vector<nmos::channel> channels_repeat{
{ U("Left Channel"), nmos::channel_symbols::L },
{ U("Right Channel"), nmos::channel_symbols::R },
{ U("Center Channel"), nmos::channel_symbols::C },
{ U("Low Frequency Effects Channel"), nmos::channel_symbols::LFE }
};
// find interface with the specified address
std::vector<web::hosts::experimental::host_interface>::const_iterator find_interface(const std::vector<web::hosts::experimental::host_interface>& interfaces, const utility::string_t& address);
// generate repeatable ids for the example node's resources
nmos::id make_id(const nmos::id& seed_id, const nmos::type& type, const port& port = {}, int index = 0);
std::vector<nmos::id> make_ids(const nmos::id& seed_id, const nmos::type& type, const port& port, int how_many = 1);
std::vector<nmos::id> make_ids(const nmos::id& seed_id, const nmos::type& type, const std::vector<port>& ports, int how_many = 1);
std::vector<nmos::id> make_ids(const nmos::id& seed_id, const std::vector<nmos::type>& types, const std::vector<port>& ports, int how_many = 1);
// generate a repeatable source-specific multicast address for each leg of a sender
utility::string_t make_source_specific_multicast_address_v4(const nmos::id& id, int leg = 0);
// add a selection of parents to a source or flow
void insert_parents(nmos::resource& resource, const nmos::id& seed_id, const port& port, int index);
// add a helpful suffix to the label of a sub-resource for the example node
void set_label_description(nmos::resource& resource, const port& port, int index);
// add an example "natural grouping" hint to a sender or receiver
void insert_group_hint(nmos::resource& resource, const port& port, int index);
// specific event types used by the example node
const auto temperature_Celsius = nmos::event_types::measurement(U("temperature"), U("C"));
const auto temperature_wildcard = nmos::event_types::measurement(U("temperature"), nmos::event_types::wildcard);
const auto catcall = nmos::event_types::named_enum(nmos::event_types::number, U("caterwaul"));
}
// forward declarations for node_implementation_thread
void node_implementation_init(nmos::node_model& model, nmos::experimental::control_protocol_state& control_protocol_state, slog::base_gate& gate);
void node_implementation_run(nmos::node_model& model, slog::base_gate& gate);
nmos::connection_resource_auto_resolver make_node_implementation_auto_resolver(const nmos::settings& settings);
nmos::connection_sender_transportfile_setter make_node_implementation_transportfile_setter(const nmos::resources& node_resources, const nmos::settings& settings);
struct node_implementation_init_exception {};
// This is an example of how to integrate the nmos-cpp library with a device-specific underlying implementation.
// It constructs and inserts a node resource and some sub-resources into the model, based on the model settings,
// starts background tasks to emit regular events from the temperature event source, and then waits for shutdown.
void node_implementation_thread(nmos::node_model& model, nmos::experimental::control_protocol_state& control_protocol_state, slog::base_gate& gate_)
{
nmos::details::omanip_gate gate{ gate_, nmos::stash_category(impl::categories::node_implementation) };
try
{
node_implementation_init(model, control_protocol_state, gate);
node_implementation_run(model, gate);
}
catch (const node_implementation_init_exception&)
{
// node_implementation_init writes the log message
}
catch (const web::json::json_exception& e)
{
// most likely from incorrect value types in the command line settings
slog::log<slog::severities::error>(gate, SLOG_FLF) << "JSON error: " << e.what();
}
catch (const std::system_error& e)
{
slog::log<slog::severities::error>(gate, SLOG_FLF) << "System error: " << e.what() << " [" << e.code() << "]";
}
catch (const std::runtime_error& e)
{
slog::log<slog::severities::error>(gate, SLOG_FLF) << "Implementation error: " << e.what();
}
catch (const std::exception& e)
{
slog::log<slog::severities::error>(gate, SLOG_FLF) << "Unexpected exception: " << e.what();
}
catch (...)
{
slog::log<slog::severities::severe>(gate, SLOG_FLF) << "Unexpected unknown exception";
}
}
void node_implementation_init(nmos::node_model& model, nmos::experimental::control_protocol_state& control_protocol_state, slog::base_gate& gate)
{
using web::json::value;
using web::json::value_from_elements;
using web::json::value_of;
auto lock = model.write_lock(); // in order to update the resources
const auto seed_id = nmos::experimental::fields::seed_id(model.settings);
const auto node_id = impl::make_id(seed_id, nmos::types::node);
const auto device_id = impl::make_id(seed_id, nmos::types::device);
const auto how_many = impl::fields::how_many(model.settings);
const auto sender_ports = impl::parse_ports(impl::fields::senders(model.settings));
const auto rtp_sender_ports = boost::copy_range<std::vector<impl::port>>(sender_ports | boost::adaptors::filtered(impl::is_rtp_port));
const auto ws_sender_ports = boost::copy_range<std::vector<impl::port>>(sender_ports | boost::adaptors::filtered(impl::is_ws_port));
const auto receiver_ports = impl::parse_ports(impl::fields::receivers(model.settings));
const auto rtp_receiver_ports = boost::copy_range<std::vector<impl::port>>(receiver_ports | boost::adaptors::filtered(impl::is_rtp_port));
const auto ws_receiver_ports = boost::copy_range<std::vector<impl::port>>(receiver_ports | boost::adaptors::filtered(impl::is_ws_port));
const auto frame_rate = nmos::parse_rational(impl::fields::frame_rate(model.settings));
const auto frame_width = impl::fields::frame_width(model.settings);
const auto frame_height = impl::fields::frame_height(model.settings);
const auto interlace_mode = impl::get_interlace_mode(model.settings);
const auto colorspace = nmos::colorspace{ impl::fields::colorspace(model.settings) };
const auto transfer_characteristic = nmos::transfer_characteristic{ impl::fields::transfer_characteristic(model.settings) };
const auto sampling = sdp::sampling{ impl::fields::color_sampling(model.settings) };
const auto bit_depth = impl::fields::component_depth(model.settings);
const auto video_type = nmos::media_type{ impl::fields::video_type(model.settings) };
const auto channel_count = impl::fields::channel_count(model.settings);
const auto smpte2022_7 = impl::fields::smpte2022_7(model.settings);
// for now, some typical values for video/jxsv, based on VSF TR-08:2022
// see https://vsf.tv/download/technical_recommendations/VSF_TR-08_2022-04-20.pdf
const auto profile = nmos::profiles::High444_12;
const auto level = nmos::get_video_jxsv_level(frame_rate, frame_width, frame_height);
const auto sublevel = nmos::sublevels::Sublev3bpp;
const auto max_bits_per_pixel = 4.0; // min coding efficiency
const auto bits_per_pixel = 2.0;
const auto transport_bit_rate_factor = 1.05;
// any delay between updates to the model resources is unnecessary unless for debugging purposes
const unsigned int delay_millis{ 0 };
// it is important that the model be locked before inserting, updating or deleting a resource
// and that the the node behaviour thread be notified after doing so
const auto insert_resource_after = [&model, &lock](unsigned int milliseconds, nmos::resources& resources, nmos::resource&& resource, slog::base_gate& gate)
{
if (nmos::details::wait_for(model.shutdown_condition, lock, std::chrono::milliseconds(milliseconds), [&] { return model.shutdown; })) return false;
const std::pair<nmos::id, nmos::type> id_type{ resource.id, resource.type };
const bool success = insert_resource(resources, std::move(resource)).second;
if (success)
slog::log<slog::severities::info>(gate, SLOG_FLF) << "Updated model with " << id_type;
else
slog::log<slog::severities::severe>(gate, SLOG_FLF) << "Model update error: " << id_type;
slog::log<slog::severities::too_much_info>(gate, SLOG_FLF) << "Notifying node behaviour thread"; // and anyone else who cares...
model.notify();
return success;
};
// it is important that the model be locked before inserting, updating or deleting a resource
// and that the the node behaviour thread be notified after doing so
const auto insert_root_after = [&model, insert_resource_after](unsigned int milliseconds, nmos::control_protocol_resource& root, slog::base_gate& gate)
{
std::function<void(nmos::resources& resources, nmos::control_protocol_resource& resource)> insert_resources;
insert_resources = [&milliseconds, insert_resource_after, &insert_resources, &gate](nmos::resources& resources, nmos::control_protocol_resource& resource)
{
for (auto& resource_ : resource.resources)
{
insert_resources(resources, resource_);
if (!insert_resource_after(milliseconds, resources, std::move(resource_), gate)) throw node_implementation_init_exception();
}
};
auto& resources = model.control_protocol_resources;
insert_resources(resources, root);
if (!insert_resource_after(milliseconds, resources, std::move(root), gate)) throw node_implementation_init_exception();
};
const auto resolve_auto = make_node_implementation_auto_resolver(model.settings);
const auto set_transportfile = make_node_implementation_transportfile_setter(model.node_resources, model.settings);
const auto clocks = web::json::value_of({ nmos::make_internal_clock(nmos::clock_names::clk0) });
// filter network interfaces to those that correspond to the specified host_addresses
const auto host_interfaces = nmos::get_host_interfaces(model.settings);
const auto interfaces = nmos::experimental::node_interfaces(host_interfaces);
// example node
{
auto node = nmos::make_node(node_id, clocks, nmos::make_node_interfaces(interfaces), model.settings);
node.data[nmos::fields::tags] = impl::fields::node_tags(model.settings);
if (!insert_resource_after(delay_millis, model.node_resources, std::move(node), gate)) throw node_implementation_init_exception();
}
#ifdef HAVE_LLDP
// LLDP manager for advertising server identity, capabilities, and discovering neighbours on a local area network
slog::log<slog::severities::info>(gate, SLOG_FLF) << "Attempting to configure LLDP";
auto lldp_manager = nmos::experimental::make_lldp_manager(model, interfaces, true, gate);
// hm, open may potentially throw?
lldp::lldp_manager_guard lldp_manager_guard(lldp_manager);
#endif
// prepare interface bindings for all senders and receivers
const auto& host_address = nmos::fields::host_address(model.settings);
// the interface corresponding to the host address is used for the example node's WebSocket senders and receivers
const auto host_interface_ = impl::find_interface(host_interfaces, host_address);
if (host_interfaces.end() == host_interface_)
{
slog::log<slog::severities::severe>(gate, SLOG_FLF) << "No network interface corresponding to host_address?";
throw node_implementation_init_exception();
}
const auto& host_interface = *host_interface_;
// hmm, should probably add a custom setting to control the primary and secondary interfaces for the example node's RTP senders and receivers
// rather than just picking the one(s) corresponding to the first and last of the specified host addresses
const auto& primary_address = model.settings.has_field(nmos::fields::host_addresses) ? web::json::front(nmos::fields::host_addresses(model.settings)).as_string() : host_address;
const auto& secondary_address = model.settings.has_field(nmos::fields::host_addresses) ? web::json::back(nmos::fields::host_addresses(model.settings)).as_string() : host_address;
const auto primary_interface_ = impl::find_interface(host_interfaces, primary_address);
const auto secondary_interface_ = impl::find_interface(host_interfaces, secondary_address);
if (host_interfaces.end() == primary_interface_ || host_interfaces.end() == secondary_interface_)
{
slog::log<slog::severities::severe>(gate, SLOG_FLF) << "No network interface corresponding to one of the host_addresses?";
throw node_implementation_init_exception();
}
const auto& primary_interface = *primary_interface_;
const auto& secondary_interface = *secondary_interface_;
const auto interface_names = smpte2022_7
? std::vector<utility::string_t>{ primary_interface.name, secondary_interface.name }
: std::vector<utility::string_t>{ primary_interface.name };
// example device
{
auto sender_ids = impl::make_ids(seed_id, nmos::types::sender, rtp_sender_ports, how_many);
if (0 <= nmos::fields::events_port(model.settings)) boost::range::push_back(sender_ids, impl::make_ids(seed_id, nmos::types::sender, ws_sender_ports, how_many));
auto receiver_ids = impl::make_ids(seed_id, nmos::types::receiver, receiver_ports, how_many);
auto device = nmos::make_device(device_id, node_id, sender_ids, receiver_ids, model.settings);
device.data[nmos::fields::tags] = impl::fields::device_tags(model.settings);
if (!insert_resource_after(delay_millis, model.node_resources, std::move(device), gate)) throw node_implementation_init_exception();
}
// example sources, flows and senders
for (int index = 0; index < how_many; ++index)
{
for (const auto& port : rtp_sender_ports)
{
const auto source_id = impl::make_id(seed_id, nmos::types::source, port, index);
const auto flow_id = impl::make_id(seed_id, nmos::types::flow, port, index);
const auto sender_id = impl::make_id(seed_id, nmos::types::sender, port, index);
nmos::resource source;
if (impl::ports::video == port)
{
source = nmos::make_video_source(source_id, device_id, nmos::clock_names::clk0, frame_rate, model.settings);
}
else if (impl::ports::audio == port)
{
const auto channels = boost::copy_range<std::vector<nmos::channel>>(boost::irange(0, channel_count) | boost::adaptors::transformed([&](const int& index)
{
return impl::channels_repeat[index % (int)impl::channels_repeat.size()];
}));
source = nmos::make_audio_source(source_id, device_id, nmos::clock_names::clk0, frame_rate, channels, model.settings);
}
else if (impl::ports::data == port)
{
source = nmos::make_data_source(source_id, device_id, nmos::clock_names::clk0, frame_rate, model.settings);
}
else if (impl::ports::mux == port)
{
source = nmos::make_mux_source(source_id, device_id, nmos::clock_names::clk0, frame_rate, model.settings);
}
impl::insert_parents(source, seed_id, port, index);
impl::set_label_description(source, port, index);
nmos::resource flow;
if (impl::ports::video == port)
{
if (nmos::media_types::video_raw == video_type)
{
flow = nmos::make_raw_video_flow(
flow_id, source_id, device_id,
frame_rate,
frame_width, frame_height, interlace_mode,
colorspace, transfer_characteristic, sampling, bit_depth,
model.settings
);
}
else if (nmos::media_types::video_jxsv == video_type)
{
flow = nmos::make_video_jxsv_flow(
flow_id, source_id, device_id,
frame_rate,
frame_width, frame_height, interlace_mode,
colorspace, transfer_characteristic, sampling, bit_depth,
profile, level, sublevel, bits_per_pixel,
model.settings
);
}
else
{
flow = nmos::make_coded_video_flow(
flow_id, source_id, device_id,
frame_rate,
frame_width, frame_height, interlace_mode,
colorspace, transfer_characteristic, sampling, bit_depth,
video_type,
model.settings
);
}
}
else if (impl::ports::audio == port)
{
flow = nmos::make_raw_audio_flow(flow_id, source_id, device_id, 48000, 24, model.settings);
// add optional grain_rate
flow.data[nmos::fields::grain_rate] = nmos::make_rational(frame_rate);
}
else if (impl::ports::data == port)
{
nmos::did_sdid timecode{ 0x60, 0x60 };
flow = nmos::make_sdianc_data_flow(flow_id, source_id, device_id, { timecode }, model.settings);
// add optional grain_rate
flow.data[nmos::fields::grain_rate] = nmos::make_rational(frame_rate);
}
else if (impl::ports::mux == port)
{
flow = nmos::make_mux_flow(flow_id, source_id, device_id, model.settings);
// add optional grain_rate
flow.data[nmos::fields::grain_rate] = nmos::make_rational(frame_rate);
}
impl::insert_parents(flow, seed_id, port, index);
impl::set_label_description(flow, port, index);
// set_transportfile needs to find the matching source and flow for the sender, so insert these first
if (!insert_resource_after(delay_millis, model.node_resources, std::move(source), gate)) throw node_implementation_init_exception();
if (!insert_resource_after(delay_millis, model.node_resources, std::move(flow), gate)) throw node_implementation_init_exception();
const auto manifest_href = nmos::experimental::make_manifest_api_manifest(sender_id, model.settings);
auto sender = nmos::make_sender(sender_id, flow_id, nmos::transports::rtp, device_id, manifest_href.to_string(), interface_names, model.settings);
// hm, could add nmos::make_video_jxsv_sender to encapsulate this?
if (impl::ports::video == port && nmos::media_types::video_jxsv == video_type)
{
// additional attributes required by BCP-006-01
// see https://specs.amwa.tv/bcp-006-01/branches/v1.0-dev/docs/NMOS_With_JPEG_XS.html#senders
const auto format_bit_rate = nmos::get_video_jxsv_bit_rate(frame_rate, frame_width, frame_height, bits_per_pixel);
// round to nearest Megabit/second per examples in VSF TR-08:2022
const auto transport_bit_rate = uint64_t(transport_bit_rate_factor * format_bit_rate / 1e3 + 0.5) * 1000;
sender.data[nmos::fields::bit_rate] = value(transport_bit_rate);
sender.data[nmos::fields::st2110_21_sender_type] = value(nmos::st2110_21_sender_types::type_N.name);
}
impl::set_label_description(sender, port, index);
impl::insert_group_hint(sender, port, index);
auto connection_sender = nmos::make_connection_rtp_sender(sender_id, smpte2022_7);
// add some example constraints; these should be completed fully!
connection_sender.data[nmos::fields::endpoint_constraints][0][nmos::fields::source_ip] = value_of({
{ nmos::fields::constraint_enum, value_from_elements(primary_interface.addresses) }
});
if (smpte2022_7) connection_sender.data[nmos::fields::endpoint_constraints][1][nmos::fields::source_ip] = value_of({
{ nmos::fields::constraint_enum, value_from_elements(secondary_interface.addresses) }
});
if (impl::fields::activate_senders(model.settings))
{
// initialize this sender with a scheduled activation, e.g. to enable the IS-05-01 test suite to run immediately
auto& staged = connection_sender.data[nmos::fields::endpoint_staged];
staged[nmos::fields::master_enable] = value::boolean(true);
staged[nmos::fields::activation] = value_of({
{ nmos::fields::mode, nmos::activation_modes::activate_scheduled_relative.name },
{ nmos::fields::requested_time, U("0:0") },
{ nmos::fields::activation_time, nmos::make_version() }
});
}
if (!insert_resource_after(delay_millis, model.node_resources, std::move(sender), gate)) throw node_implementation_init_exception();
if (!insert_resource_after(delay_millis, model.connection_resources, std::move(connection_sender), gate)) throw node_implementation_init_exception();
}
}
// example receivers
for (int index = 0; index < how_many; ++index)
{
for (const auto& port : rtp_receiver_ports)
{
const auto receiver_id = impl::make_id(seed_id, nmos::types::receiver, port, index);
nmos::resource receiver;
if (impl::ports::video == port)
{
receiver = nmos::make_receiver(receiver_id, device_id, nmos::transports::rtp, interface_names, nmos::formats::video, { video_type }, model.settings);
// add an example constraint set; these should be completed fully!
if (nmos::media_types::video_raw == video_type)
{
const auto interlace_modes = nmos::interlace_modes::progressive != interlace_mode
? std::vector<utility::string_t>{ nmos::interlace_modes::interlaced_bff.name, nmos::interlace_modes::interlaced_tff.name, nmos::interlace_modes::interlaced_psf.name }
: std::vector<utility::string_t>{ nmos::interlace_modes::progressive.name };
receiver.data[nmos::fields::caps][nmos::fields::constraint_sets] = value_of({
value_of({
{ nmos::caps::format::grain_rate, nmos::make_caps_rational_constraint({ frame_rate }) },
{ nmos::caps::format::frame_width, nmos::make_caps_integer_constraint({ frame_width }) },
{ nmos::caps::format::frame_height, nmos::make_caps_integer_constraint({ frame_height }) },
{ nmos::caps::format::interlace_mode, nmos::make_caps_string_constraint(interlace_modes) },
{ nmos::caps::format::color_sampling, nmos::make_caps_string_constraint({ sampling.name }) }
})
});
}
else if (nmos::media_types::video_jxsv == video_type)
{
// some of the parameter constraints recommended by BCP-006-01
// see https://specs.amwa.tv/bcp-006-01/branches/v1.0-dev/docs/NMOS_With_JPEG_XS.html#receivers
const auto max_format_bit_rate = nmos::get_video_jxsv_bit_rate(frame_rate, frame_width, frame_height, max_bits_per_pixel);
// round to nearest Megabit/second per examples in VSF TR-08:2022
const auto max_transport_bit_rate = uint64_t(transport_bit_rate_factor * max_format_bit_rate / 1e3 + 0.5) * 1000;
receiver.data[nmos::fields::caps][nmos::fields::constraint_sets] = value_of({
value_of({
{ nmos::caps::format::profile, nmos::make_caps_string_constraint({ profile.name }) },
{ nmos::caps::format::level, nmos::make_caps_string_constraint({ level.name }) },
{ nmos::caps::format::sublevel, nmos::make_caps_string_constraint({ nmos::sublevels::Sublev3bpp.name, nmos::sublevels::Sublev4bpp.name }) },
{ nmos::caps::format::bit_rate, nmos::make_caps_integer_constraint({}, nmos::no_minimum<int64_t>(), (int64_t)max_format_bit_rate) },
{ nmos::caps::transport::bit_rate, nmos::make_caps_integer_constraint({}, nmos::no_minimum<int64_t>(), (int64_t)max_transport_bit_rate) },
{ nmos::caps::transport::packet_transmission_mode, nmos::make_caps_string_constraint({ nmos::packet_transmission_modes::codestream.name }) }
})
});
}
receiver.data[nmos::fields::version] = receiver.data[nmos::fields::caps][nmos::fields::version] = value(nmos::make_version());
}
else if (impl::ports::audio == port)
{
receiver = nmos::make_audio_receiver(receiver_id, device_id, nmos::transports::rtp, interface_names, 24, model.settings);
// add some example constraint sets; these should be completed fully!
receiver.data[nmos::fields::caps][nmos::fields::constraint_sets] = value_of({
value_of({
{ nmos::caps::format::channel_count, nmos::make_caps_integer_constraint({}, 1, channel_count) },
{ nmos::caps::format::sample_rate, nmos::make_caps_rational_constraint({ { 48000, 1 } }) },
{ nmos::caps::format::sample_depth, nmos::make_caps_integer_constraint({ 16, 24 }) },
{ nmos::caps::transport::packet_time, nmos::make_caps_number_constraint({ 0.125 }) }
}),
value_of({
{ nmos::caps::meta::preference, -1 },
{ nmos::caps::format::channel_count, nmos::make_caps_integer_constraint({}, 1, (std::min)(8, channel_count)) },
{ nmos::caps::format::sample_rate, nmos::make_caps_rational_constraint({ { 48000, 1 } }) },
{ nmos::caps::format::sample_depth, nmos::make_caps_integer_constraint({ 16, 24 }) },
{ nmos::caps::transport::packet_time, nmos::make_caps_number_constraint({ 1 }) }
})
});
receiver.data[nmos::fields::version] = receiver.data[nmos::fields::caps][nmos::fields::version] = value(nmos::make_version());
}
else if (impl::ports::data == port)
{
receiver = nmos::make_sdianc_data_receiver(receiver_id, device_id, nmos::transports::rtp, interface_names, model.settings);
// add an example constraint set; these should be completed fully!
receiver.data[nmos::fields::caps][nmos::fields::constraint_sets] = value_of({
value_of({
{ nmos::caps::format::grain_rate, nmos::make_caps_rational_constraint({ frame_rate }) }
})
});
receiver.data[nmos::fields::version] = receiver.data[nmos::fields::caps][nmos::fields::version] = value(nmos::make_version());
}
else if (impl::ports::mux == port)
{
receiver = nmos::make_mux_receiver(receiver_id, device_id, nmos::transports::rtp, interface_names, model.settings);
// add an example constraint set; these should be completed fully!
receiver.data[nmos::fields::caps][nmos::fields::constraint_sets] = value_of({
value_of({
{ nmos::caps::format::grain_rate, nmos::make_caps_rational_constraint({ frame_rate }) }
})
});
receiver.data[nmos::fields::version] = receiver.data[nmos::fields::caps][nmos::fields::version] = value(nmos::make_version());
}
impl::set_label_description(receiver, port, index);
impl::insert_group_hint(receiver, port, index);
auto connection_receiver = nmos::make_connection_rtp_receiver(receiver_id, smpte2022_7);
// add some example constraints; these should be completed fully!
connection_receiver.data[nmos::fields::endpoint_constraints][0][nmos::fields::interface_ip] = value_of({
{ nmos::fields::constraint_enum, value_from_elements(primary_interface.addresses) }
});
if (smpte2022_7) connection_receiver.data[nmos::fields::endpoint_constraints][1][nmos::fields::interface_ip] = value_of({
{ nmos::fields::constraint_enum, value_from_elements(secondary_interface.addresses) }
});
resolve_auto(receiver, connection_receiver, connection_receiver.data[nmos::fields::endpoint_active][nmos::fields::transport_params]);
if (!insert_resource_after(delay_millis, model.node_resources, std::move(receiver), gate)) throw node_implementation_init_exception();
if (!insert_resource_after(delay_millis, model.connection_resources, std::move(connection_receiver), gate)) throw node_implementation_init_exception();
}
}
// example event sources, flows and senders
for (int index = 0; 0 <= nmos::fields::events_port(model.settings) && index < how_many; ++index)
{
for (const auto& port : ws_sender_ports)
{
const auto source_id = impl::make_id(seed_id, nmos::types::source, port, index);
const auto flow_id = impl::make_id(seed_id, nmos::types::flow, port, index);
const auto sender_id = impl::make_id(seed_id, nmos::types::sender, port, index);
nmos::event_type event_type;
web::json::value events_type;
web::json::value events_state;
if (impl::ports::temperature == port)
{
event_type = impl::temperature_Celsius;
// see https://specs.amwa.tv/is-07/releases/v1.0.1/docs/3.0._Event_types.html#231-measurements
// and https://specs.amwa.tv/is-07/releases/v1.0.1/examples/eventsapi-type-number-measurement-get-200.html
// and https://specs.amwa.tv/is-07/releases/v1.0.1/examples/eventsapi-state-number-measurement-get-200.html
events_type = nmos::make_events_number_type({ -200, 10 }, { 1000, 10 }, { 1, 10 }, U("C"));
events_state = nmos::make_events_number_state({ source_id, flow_id }, { 201, 10 }, event_type);
}
else if (impl::ports::burn == port)
{
event_type = nmos::event_types::boolean;
// see https://specs.amwa.tv/is-07/releases/v1.0.1/docs/3.0._Event_types.html#21-boolean
events_type = nmos::make_events_boolean_type();
events_state = nmos::make_events_boolean_state({ source_id, flow_id }, false);
}
else if (impl::ports::nonsense == port)
{
event_type = nmos::event_types::string;
// see https://specs.amwa.tv/is-07/releases/v1.0.1/docs/3.0._Event_types.html#22-string
// and of course, https://en.wikipedia.org/wiki/Metasyntactic_variable
events_type = nmos::make_events_string_type(0, 0, U("^foo|bar|baz|qu+x$"));
events_state = nmos::make_events_string_state({ source_id, flow_id }, U("foo"));
}
else if (impl::ports::catcall == port)
{
event_type = impl::catcall;
// see https://specs.amwa.tv/is-07/releases/v1.0.1/docs/3.0._Event_types.html#3-enum
events_type = nmos::make_events_number_enum_type({
{ 1, { U("meow"), U("chatty") } },
{ 2, { U("purr"), U("happy") } },
{ 4, { U("hiss"), U("afraid") } },
{ 8, { U("yowl"), U("sonorous") } }
});
events_state = nmos::make_events_number_state({ source_id, flow_id }, 1, event_type);
}
// grain_rate is not set because these events are aperiodic
auto source = nmos::make_data_source(source_id, device_id, {}, event_type, model.settings);
impl::set_label_description(source, port, index);
auto events_source = nmos::make_events_source(source_id, events_state, events_type);
auto flow = nmos::make_json_data_flow(flow_id, source_id, device_id, event_type, model.settings);
impl::set_label_description(flow, port, index);
auto sender = nmos::make_sender(sender_id, flow_id, nmos::transports::websocket, device_id, {}, { host_interface.name }, model.settings);
impl::set_label_description(sender, port, index);
impl::insert_group_hint(sender, port, index);
// initialize this sender enabled, just to enable the IS-07-02 test suite to run immediately
auto connection_sender = nmos::make_connection_events_websocket_sender(sender_id, device_id, source_id, model.settings);
connection_sender.data[nmos::fields::endpoint_active][nmos::fields::master_enable] = connection_sender.data[nmos::fields::endpoint_staged][nmos::fields::master_enable] = value::boolean(true);
resolve_auto(sender, connection_sender, connection_sender.data[nmos::fields::endpoint_active][nmos::fields::transport_params]);
nmos::set_resource_subscription(sender, nmos::fields::master_enable(connection_sender.data[nmos::fields::endpoint_active]), {}, nmos::tai_now());
if (!insert_resource_after(delay_millis, model.node_resources, std::move(source), gate)) throw node_implementation_init_exception();
if (!insert_resource_after(delay_millis, model.node_resources, std::move(flow), gate)) throw node_implementation_init_exception();
if (!insert_resource_after(delay_millis, model.node_resources, std::move(sender), gate)) throw node_implementation_init_exception();
if (!insert_resource_after(delay_millis, model.connection_resources, std::move(connection_sender), gate)) throw node_implementation_init_exception();
if (!insert_resource_after(delay_millis, model.events_resources, std::move(events_source), gate)) throw node_implementation_init_exception();
}
}
// example event receivers
for (int index = 0; index < how_many; ++index)
{
for (const auto& port : ws_receiver_ports)
{
const auto receiver_id = impl::make_id(seed_id, nmos::types::receiver, port, index);
nmos::event_type event_type;
if (impl::ports::temperature == port)
{
// accept e.g. "number/temperature/F" or "number/temperature/K" as well as "number/temperature/C"
event_type = impl::temperature_wildcard;
}
else if (impl::ports::burn == port)
{
// accept any boolean
event_type = nmos::event_types::wildcard(nmos::event_types::boolean);
}
else if (impl::ports::nonsense == port)
{
// accept any string
event_type = nmos::event_types::wildcard(nmos::event_types::string);
}
else if (impl::ports::catcall == port)
{
// accept only a catcall
event_type = impl::catcall;
}
auto receiver = nmos::make_data_receiver(receiver_id, device_id, nmos::transports::websocket, { host_interface.name }, nmos::media_types::application_json, { event_type }, model.settings);
impl::set_label_description(receiver, port, index);
impl::insert_group_hint(receiver, port, index);
auto connection_receiver = nmos::make_connection_events_websocket_receiver(receiver_id, model.settings);
resolve_auto(receiver, connection_receiver, connection_receiver.data[nmos::fields::endpoint_active][nmos::fields::transport_params]);
if (!insert_resource_after(delay_millis, model.node_resources, std::move(receiver), gate)) throw node_implementation_init_exception();
if (!insert_resource_after(delay_millis, model.connection_resources, std::move(connection_receiver), gate)) throw node_implementation_init_exception();
}
}
// example channelmapping resources demonstrating a range of input/output capabilities
// see https://github.com/sony/nmos-cpp/issues/111#issuecomment-740613137
// example audio inputs
const bool channelmapping_receivers = 0 <= nmos::fields::channelmapping_port(model.settings) && rtp_receiver_ports.end() != boost::range::find(rtp_receiver_ports, impl::ports::audio);
for (int index = 0; channelmapping_receivers && index < how_many; ++index)
{
const auto stri = utility::conversions::details::to_string_t(index);
const auto id = U("input") + stri;
const auto name = U("IP Input ") + stri;
const auto description = U("SMPTE 2110-30 IP Input ") + stri;
const auto receiver_id = impl::make_id(seed_id, nmos::types::receiver, impl::ports::audio, index);
const auto parent = std::pair<nmos::id, nmos::type>(receiver_id, nmos::types::receiver);
const auto channel_labels = boost::copy_range<std::vector<utility::string_t>>(boost::irange(0, channel_count) | boost::adaptors::transformed([&](const int& index)
{
return impl::channels_repeat[index % (int)impl::channels_repeat.size()].label;
}));
// use default input capabilities to indicate no constraints
auto channelmapping_input = nmos::make_channelmapping_input(id, name, description, parent, channel_labels);
if (!insert_resource_after(delay_millis, model.channelmapping_resources, std::move(channelmapping_input), gate)) throw node_implementation_init_exception();
}
// example audio outputs
const bool channelmapping_senders = 0 <= nmos::fields::channelmapping_port(model.settings) && rtp_sender_ports.end() != boost::range::find(rtp_sender_ports, impl::ports::audio);
for (int index = 0; channelmapping_senders && index < how_many; ++index)
{
const auto stri = utility::conversions::details::to_string_t(index);
const auto id = U("output") + stri;
const auto name = U("IP Output ") + stri;
const auto description = U("SMPTE 2110-30 IP Output ") + stri;
const auto source_id = impl::make_id(seed_id, nmos::types::source, impl::ports::audio, index);
const auto channel_labels = boost::copy_range<std::vector<utility::string_t>>(boost::irange(0, channel_count) | boost::adaptors::transformed([&](const int& index)
{
return impl::channels_repeat[index % (int)impl::channels_repeat.size()].label;
}));
// omit routable inputs to indicate no restrictions
auto channelmapping_output = nmos::make_channelmapping_output(id, name, description, source_id, channel_labels);
if (!insert_resource_after(delay_millis, model.channelmapping_resources, std::move(channelmapping_output), gate)) throw node_implementation_init_exception();
}
const int input_block_size = 8;
const int input_block_count = 8;
// example non-IP audio input
if (0 <= nmos::fields::channelmapping_port(model.settings))
{
const auto id = U("inputA");
const auto name = U("MADI Input A");
const auto description = U("MADI Input A");
// non-IP audio inputs have no parent
const auto parent = std::pair<nmos::id, nmos::type>();
const auto channel_labels = boost::copy_range<std::vector<utility::string_t>>(boost::irange(0, input_block_size * input_block_count) | boost::adaptors::transformed([](const int& index)
{
return nmos::channel_symbols::Undefined(1 + index).name;
}));
// some example constraints; this input's channels can only be used in blocks and the channels cannot be reordered within each block
const auto reordering = false;
const auto block_size = input_block_size;
auto channelmapping_input = nmos::make_channelmapping_input(id, name, description, parent, channel_labels, reordering, block_size);
if (!insert_resource_after(delay_millis, model.channelmapping_resources, std::move(channelmapping_input), gate)) throw node_implementation_init_exception();
}
// example outputs to some audio gizmo
if (0 <= nmos::fields::channelmapping_port(model.settings))
{
const auto id = U("outputX");
const auto name = U("Gizmo Output X");
const auto description = U("Gizmo Output X");
const auto source_id = impl::make_id(seed_id, nmos::types::source, impl::ports::audio, how_many);
const auto channel_labels = boost::copy_range<std::vector<utility::string_t>>(boost::irange(0, input_block_size) | boost::adaptors::transformed([](const int& index)
{
return nmos::channel_symbols::Undefined(1 + index).name;
}));
// some example constraints; only allow inputs from the example non-IP audio input
auto routable_inputs = std::vector<nmos::channelmapping_id>{ U("inputA") };
// do not allow unrouted channels
// start with a valid active map
auto active_map = boost::copy_range<std::vector<std::pair<nmos::channelmapping_id, uint32_t>>>(boost::irange(0, input_block_size) | boost::adaptors::transformed([](const int& index)
{
return std::pair<nmos::channelmapping_id, uint32_t>{ U("inputA"), index };
}));
auto channelmapping_output = nmos::make_channelmapping_output(id, name, description, source_id, channel_labels, routable_inputs, active_map);
if (!insert_resource_after(delay_millis, model.channelmapping_resources, std::move(channelmapping_output), gate)) throw node_implementation_init_exception();
}
// example source for some audio gizmo
if (0 <= nmos::fields::channelmapping_port(model.settings))
{
const auto source_id = impl::make_id(seed_id, nmos::types::source, impl::ports::audio, how_many);
const auto channels = boost::copy_range<std::vector<nmos::channel>>(boost::irange(0, input_block_size) | boost::adaptors::transformed([](const int& index)
{
return nmos::channel{ {}, nmos::channel_symbols::Undefined(1 + index) };
}));
auto source = nmos::make_audio_source(source_id, device_id, nmos::clock_names::clk0, frame_rate, channels, model.settings);
impl::set_label_description(source, impl::ports::audio, how_many);
if (!insert_resource_after(delay_millis, model.node_resources, std::move(source), gate)) throw node_implementation_init_exception();
}
// example inputs from some audio gizmo
if (0 <= nmos::fields::channelmapping_port(model.settings))
{
const auto id = U("inputX");
const auto name = U("Gizmo Input X");
const auto description = U("Gizmo Input X");
// the audio gizmo is re-entrant
const auto source_id = impl::make_id(seed_id, nmos::types::source, impl::ports::audio, how_many);
const auto parent = std::pair<nmos::id, nmos::type>(source_id, nmos::types::source);
const auto channel_labels = boost::copy_range<std::vector<utility::string_t>>(boost::irange(0, input_block_size) | boost::adaptors::transformed([](const int& index)
{
return nmos::channel_symbols::Undefined(1 + index).name;
}));
// this input is weird, it is block-based but allows reordering of channels within a block
const auto reordering = true;
const auto block_size = 2;
auto channelmapping_input = nmos::make_channelmapping_input(id, name, description, parent, channel_labels, reordering, block_size);
if (!insert_resource_after(delay_millis, model.channelmapping_resources, std::move(channelmapping_input), gate)) throw node_implementation_init_exception();
}
// example non-ST 2110-30 audio output
if (0 <= nmos::fields::channelmapping_port(model.settings))
{
const auto id = U("outputB");
const auto name = U("AES Output B");
const auto description = U("AES Output B");
// non-IP audio outputs have no sourceid
const auto source_id = nmos::id();
const auto channel_labels = boost::copy_range<std::vector<utility::string_t>>(nmos::channel_symbols::ST | boost::adaptors::transformed([](const nmos::channel_symbol& symbol)
{
return symbol.name;
}));
// allow inputs from the audio gizmo
auto routable_inputs = std::vector<nmos::channelmapping_id>{ U("inputX") };
// allow unrouted channels
routable_inputs.push_back({});
auto channelmapping_output = nmos::make_channelmapping_output(id, name, description, source_id, channel_labels, routable_inputs);
if (!insert_resource_after(delay_millis, model.channelmapping_resources, std::move(channelmapping_output), gate)) throw node_implementation_init_exception();
}
// examples of using IS-12 control protocol
// they are based on the NC-DEVICE-MOCK
// See https://specs.amwa.tv/nmos-device-control-mock/#about-nc-device-mock
// See https://github.com/AMWA-TV/nmos-device-control-mock/blob/main/code/src/NCModel/Features.ts
if (0 <= nmos::fields::control_protocol_ws_port(model.settings))
{
// example to create a non-standard Gain control class
const auto gain_control_class_id = nmos::make_nc_class_id(nmos::nc_worker_class_id, 0, { 1 });
const web::json::field_as_number gain_value{ U("gainValue") };
{
// Gain control class property descriptors
std::vector<web::json::value> gain_control_property_descriptors = { nmos::experimental::make_control_class_property_descriptor(U("Gain value"), { 3, 1 }, gain_value, U("NcFloat32")) };
// create Gain control class descriptor
auto gain_control_class_descriptor = nmos::experimental::make_control_class_descriptor(U("Gain control class descriptor"), gain_control_class_id, U("GainControl"), gain_control_property_descriptors);
// insert Gain control class descriptor to global state, which will be used by the control_protocol_ws_message_handler to process incoming ws message
control_protocol_state.insert(gain_control_class_descriptor);
}
// helper function to create Gain control instance
auto make_gain_control = [&gain_value, &gain_control_class_id](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 web::json::value& touchpoints, const web::json::value& runtime_property_constraints, float gain)
{
auto data = nmos::details::make_nc_worker(gain_control_class_id, oid, true, owner, role, value::string(user_label), description, touchpoints, runtime_property_constraints, true);
data[gain_value] = value::number(gain);
return nmos::control_protocol_resource{ nmos::is12_versions::v1_0, nmos::types::nc_worker, std::move(data), true };
};
// example to create a non-standard Example control class
const auto example_control_class_id = nmos::make_nc_class_id(nmos::nc_worker_class_id, 0, { 2 });
const web::json::field_as_number enum_property{ U("enumProperty") };
const web::json::field_as_string string_property{ U("stringProperty") };
const web::json::field_as_number number_property{ U("numberProperty") };
const web::json::field_as_number deprecated_number_property{ U("deprecatedNumberProperty") };
const web::json::field_as_bool boolean_property{ U("booleanProperty") };
const web::json::field_as_value object_property{ U("objectProperty") };
const web::json::field_as_number method_no_args_count{ U("methodNoArgsCount") };
const web::json::field_as_number method_simple_args_count{ U("methodSimpleArgsCount") };
const web::json::field_as_number method_object_arg_count{ U("methodObjectArgCount") };
const web::json::field_as_array string_sequence{ U("stringSequence") };
const web::json::field_as_array boolean_sequence{ U("booleanSequence") };
const web::json::field_as_array enum_sequence{ U("enumSequence") };
const web::json::field_as_array number_sequence{ U("numberSequence") };
const web::json::field_as_array object_sequence{ U("objectSequence") };
const web::json::field_as_number enum_arg{ U("enumArg") };
const web::json::field_as_string string_arg{ U("stringArg") };
const web::json::field_as_number number_arg{ U("numberArg") };
const web::json::field_as_bool boolean_arg{ U("booleanArg") };
const web::json::field_as_value obj_arg{ U("objArg") };
enum example_enum
{
Undefined = 0,
Alpha = 1,
Beta = 2,
Gamma = 3
};
{
// following constraints are used for the example control class level 0 datatype, level 1 property constraints and the method parameters constraints
auto make_string_example_argument_constraints = []() {return nmos::details::make_nc_parameter_constraints_string(10, U("^[a-z]+$")); };
auto make_number_example_argument_constraints = []() {return nmos::details::make_nc_parameter_constraints_number(0, 1000, 1); };
// Example control class property descriptors
std::vector<web::json::value> example_control_property_descriptors = {
nmos::experimental::make_control_class_property_descriptor(U("Example enum property"), { 3, 1 }, enum_property, U("ExampleEnum")),
// create "Example string property" with level 1: property constraints, See https://specs.amwa.tv/ms-05-02/branches/v1.0.x/docs/Constraints.html
// use nmos::details::make_nc_parameter_constraints_string to create property constraints
nmos::experimental::make_control_class_property_descriptor(U("Example string property"), { 3, 2 }, string_property, U("NcString"), false, false, false, false, make_string_example_argument_constraints()),
// create "Example numeric property" with level 1: property constraints, See https://specs.amwa.tv/ms-05-02/branches/v1.0.x/docs/Constraints.html
// use nmos::details::make_nc_parameter_constraints_number to create property constraints
nmos::experimental::make_control_class_property_descriptor(U("Example numeric property"), { 3, 3 }, number_property, U("NcUint64"), false, false, false, false, make_number_example_argument_constraints()),
nmos::experimental::make_control_class_property_descriptor(U("Example deprecated numeric property"), { 3, 4 }, deprecated_number_property, U("NcUint64"), false, false, false, true, make_number_example_argument_constraints()),
nmos::experimental::make_control_class_property_descriptor(U("Example boolean property"), { 3, 5 }, boolean_property, U("NcBoolean")),
nmos::experimental::make_control_class_property_descriptor(U("Example object property"), { 3, 6 }, object_property, U("ExampleDataType")),
nmos::experimental::make_control_class_property_descriptor(U("Example method no args invoke counter"), { 3, 7 }, method_no_args_count, U("NcUint64"), true),
nmos::experimental::make_control_class_property_descriptor(U("Example method simple args invoke counter"), { 3, 8 }, method_simple_args_count, U("NcUint64"), true),
nmos::experimental::make_control_class_property_descriptor(U("Example method obj arg invoke counter"), { 3, 9 }, method_object_arg_count, U("NcUint64"), true),
// create "Example sequence string property" with level 1: property constraints, See https://specs.amwa.tv/ms-05-02/branches/v1.0.x/docs/Constraints.html