Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Language and conciseness updates #5

Open
wants to merge 2 commits into
base: v1.0-dev
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 13 additions & 9 deletions docs/NMOS With MPEG TS.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ _(c) AMWA 2024, CC Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)_

SMPTE [ST 2022-2][ST-2022-2] defines the Unidirectional Transport of Constant Bit Rate MPEG-2 Transport Streams using RTP on IP Networks.

This document outlines how devices capable of MPEG TS transports can be managed through NMOS IS-04 and IS-05.

This BCP allows for the use of all transport types defined in the [Transports][Transports-Registry] registry that can carry media type `video/MP2T`.

## Use of Normative Language
Expand Down Expand Up @@ -39,24 +41,24 @@ Source resources can be associated with many Flows at the same time.
The Source is therefore unaffected by the use of MPEG TS or the encapsulated content.

### Flows
The Flow resource **MUST** indicate `video/MP2T` in the `media_type` attribute, and `urn:x-nmos:format:mux` for the `format`.
The Flow resource **MUST** indicate `video/MP2T` in the `media_type` attribute, and `urn:x-nmos:format:mux` for the `format`, as defined in the [IS-04 Flow Mux Schema][Flow-Mux-Schema]

An example Flow resource is provided in the [Examples](../examples/).

## MPEG TS IS-04 Senders and Receivers
IS-04 Senders and Receivers **MUST** use transports defined in the [Transports][Transports-Registry] parameter registry.
IS-04 MPEG TS capable Senders and Receivers **MUST** use transports defined in the [Transports][Transports-Registry] parameter registry.

### Senders
For Nodes implementing IS-04 v1.3 or higher, the following additional attributes defined in the [sender attributes register][Sender-Attributes] of the NMOS Parameter Registers are used for MPEG TS:

- [Bit Rate][Sender-Transport-Bit-Rate]
This attribute **MUST** be present as defined in equipment where the bit rate is known.

The SDP file published at the `manifest_href` end-point **MUST** comply with the IS-05 usage guidelines for the specific transport and [RFC 4566][RFC-4566]
For transports requiring an SDP, the sender **MUST** publish this at the `manifest_href` end-point and **MUST** comply with the IS-05 usage guidelines for the specific transport and [RFC 4566][RFC-4566]

An example Sender resource is provided in the [Examples](../examples/).
## Receivers
Nodes capable of receiving MPEG TS streams **MUST** have a Receiver resource in the IS-04 Node API, which lists `video/MP2T` in the `media_types` array within the `caps` object.
Nodes capable of receiving MPEG TS streams **MUST** have a Receiver resource in the IS-04 Node API, which lists `video/MP2T` in the `media_types` array within the `caps` object, and **MUST** signal `urn:x-nmos:format:mux` as `format`, as defined in the [IS-04 Receiver Mux Schema][Receiver-Mux-Schema].

If the Receiver has limitations on or preferences regarding the MPEG TS streams that it supports, the Receiver resource **MUST** indicate constraints in accordance with the [BCP 004-01][BCP-004-01] Receiver Capabilities specification.

Expand All @@ -70,14 +72,14 @@ The following parameter constraints **MAY** be used to express limitations on MP
- [Transport Bit Rate][Cap-Transport-Bit-Rate]

An example Receiver resource is provided in the [Examples](../examples/).

## MPEG TS IS-05 Senders and Receivers
All transport types capable of carrying MPEG TS streams **MAY** be used. Connection Management follows IS-05 for the indicated transport type.

Connection Management follows IS-05 for the transport type.
For example, RTP **MUST** signal `urn:x-nmos:transport:rtp` as transport type, and **MUST** provide all manadatory elements of the IS-05 [RTP Transport Schema][RTP-Transport-Schema], or as defined in the transports registry.

Any SDP file published at the **/transportfile** end-point **MUST** comply with the IS-05 usage guidelines for the RTP transport and [RFC 4566][RFC-4566].
For transports requiring an SDP, such as RTP, the sender **MUST** publish this at the **/transportfile** end-point and **MUST** comply with the IS-05 usage guidelines for the specific transport and [RFC 4566][RFC-4566]

An example SDP file is provided in the [Examples](../examples/).
An example SDP is provided in the [Examples](../examples/).

## Controllers

Expand All @@ -97,5 +99,7 @@ Controllers **MUST** support the BCP-004-01 Receiver Capabilities mechanism and
[Sender-Transport-Bit-Rate]: https://specs.amwa.tv/nmos-parameter-registers/branches/main/sender-attributes/#bit-rate "Sender Transport Bit Rate"
[Cap-Transport-Bit-Rate]: https://specs.amwa.tv/nmos-parameter-registers/branches/main/capabilities/#transport-bit-rate "Transport Bit Rate"
[Transports-Registry]: https://specs.amwa.tv/nmos-parameter-registers/branches/main/transports "Transports"

[Receiver-Mux-Schema]: https://specs.amwa.tv/is-04/releases/v1.3.3/APIs/schemas/with-refs/receiver_mux.html "IS-04 Receiver Mux Schema"
[Flow-Mux-Schema]: https://specs.amwa.tv/is-04/releases/v1.3.3/APIs/schemas/with-refs/flow_mux.html "IS-04 Flow Mux Schema"
[RTP-Transport-Schema]: https://specs.amwa.tv/is-05/releases/v1.1.2/APIs/schemas/with-refs/sender_transport_params_rtp.html "RTP Transport Schema"