# NMOS Flow Attributes
{:.no_toc}

This Flow Attributes parameter register contains extensible attributes and their permitted values which may be used in Flow resources within the [AMWA IS-04 NMOS Discovery and Registration Specification](https://specs.amwa.tv/is-04).

- A markdown unordered list which will be replaced with the ToC, excluding the "Contents header" from above
{:toc}

## Criteria

- Each entry MUST be associated with an existing defined [NMOS Format](../formats), and MAY additionally relate to a specific `media_type`.
- Each entry MUST define or refer to an existing unique attribute name within the scope of a Flow.
- Each entry MUST have a short description.
- Each entry MUST identify any AMWA Specifications and versions from which it is valid.
- Each entry MUST define all permitted values for the attribute, either via an explicit list, well-defined references or both.
- Entries MAY be used to expand the set of permitted values associated with an existing extensible attribute.
- Each entry MUST link to a schema definition held within this repository (unless covered by a schema within the original specification).
- Additions and updates to this parameter register are to be submitted via a Pull Request (PR) according to the [General Procedures and Criteria](../common/).

As noted in [IS-04 v1.3](https://specs.amwa.tv/is-04/v1.3.2/docs/Behaviour_-_Nodes.html#all-resources), new Flow attributes may be defined here as opposed to requiring a new version of the specification.

Query APIs and their clients which support v1.3 of IS-04 or operate in a mixed-version environment MUST be tolerant to the presence of Flow attributes and values which may be added at a later date. This is further detailed in the [IS-04 Upgrade Path](https://specs.amwa.tv/is-04/v1.3.1/docs/6.0._Upgrade_Path.html) document.

## Attributes

Note: JSON schemas supporting validation of all the attributes defined in this register are available as **[flow_video_register.json](flow_video_register.json)** and **[flow_audio_register.json](flow_audio_register.json)**.
These MAY be used in addition to the schemas, such as _flow_video.json_ and _flow_audio.json_, found in the AMWA IS-04 specification.

### Bit Rate
- **Name:** `bit_rate`
- **Description:** Target bit rate of the codestream/bitstream, in kilobits/second.
- **Specification:** [AMWA BCP-006-01](https://specs.amwa.tv/bcp-006-01/v1.0), [AMWA BCP-006-02](https://specs.amwa.tv/bcp-006-02/v1.0), [AMWA BCP-006-03](https://specs.amwa.tv/bcp-006-03/v1.0)
- **Applicability:** `urn:x-nmos:format:video` or `urn:x-nmos:format:audio`
- **Permitted Values:**
  - Since AMWA IS-04 v1.3, integer values expressed in units of 1000 bits per second, rounding up

### Constant Bit Rate
- **Name:** `constant_bit_rate`
- **Description:**  Indicates that the Flow is constant or variable bit rate.
- **Specification:** [AMWA BCP-006-02](https://specs.amwa.tv/bcp-006-02/v1.0), [AMWA BCP-006-03](https://specs.amwa.tv/bcp-006-03/v1.0)
- **Applicability:** `urn:x-nmos:format:video` or `urn:x-nmos:format:audio`
- **Permitted Values:**
  - Since AMWA IS-04 v1.3, boolean values true or false.

### Colorspace
- **Name:** `colorspace`
- **Description:** Colorspace used for the video.
- **Specification:** [AMWA IS-04 v1.1](https://specs.amwa.tv/is-04/v1.1)
- **Applicability:** `urn:x-nmos:format:video`
- **Permitted Values:**
  - Since AMWA IS-04 v1.1, values complying with the IS-04 schema
    - `BT601`
    - `BT709`
    - `BT2020`
    - `BT2100`
  - Since AMWA IS-04 v1.3, values defined for the colorimetry format-specific parameter in any published revision of SMPTE ST 2110-20
  - Since ST 2110-20:2017
    - `ST2065-1`
    - `ST2065-3`
    - `UNSPECIFIED` (when no other value applies)
    - `XYZ`
  - Since ST 2110-20:2022
    - `ALPHA`

### Components
- **Name:** `components`
- **Description:** Array of objects describing the components of the video.
- **Specification:** [AMWA IS-04 v1.1](https://specs.amwa.tv/is-04/v1.1) for raw video Flows, extended for [AMWA BCP-006-01](https://specs.amwa.tv/bcp-006-01/v1.0) to coded video Flows since IS-04 v1.3
- **Applicability:** `urn:x-nmos:format:video`
- **Permitted Values:**
  - For raw video Flows, since AMWA IS-04 v1.1, values complying with the IS-04 schema
  - For coded video Flows, since AMWA IS-04 v1.3, values complying with the schema accompanying this register
  - For example:  
    ```json
    "components": [
      { "name": "Y",  "width": 1280, "height": 720, "bit_depth": 10 },
      { "name": "Cb", "width": 640,  "height": 720, "bit_depth": 10 },
      { "name": "Cr", "width": 640,  "height": 720, "bit_depth": 10 }
    ]
    ```

### Level
- **Name:** `level`
- **Description:** Indicates constraints on parameters of the coding tools that are in use, as defined for the Flow media type.
- **Specification:** [AMWA BCP-006-01](https://specs.amwa.tv/bcp-006-01/v1.0), [AMWA BCP-006-02](https://specs.amwa.tv/bcp-006-02/v1.0), [AMWA BCP-006-03](https://specs.amwa.tv/bcp-006-03/v1.0)
- **Applicability:** `urn:x-nmos:format:video` or `urn:x-nmos:format:audio`
- **Permitted Values:**
  - Since AMWA IS-04 v1.3, string values defined for the Flow media type, as enumerated in the schema accompanying this register
  - For `video/jxsv`, the values are the level names defined by ISO/IEC 21122-2, with any white space Unicode characters omitted as per [RFC 9134][RFC-9134]
    - For example
      - `1k-1`
  - For `video/H264`, the values are the level names defined by Rec. ITU-T H.264 Annex A.
    - For example
      - `5.1`
  - For `video/H265`, the values are the level names defined Rec. ITU-T H.265 Annex A where the tier name prefixes the level number.
    - For example
      - `Main-5.1`

### Profile
- **Name:** `profile`
- **Description:** Indicates the subset of coding tools that are in use, as defined for the Flow media type.
- **Specification:** [AMWA BCP-006-01](https://specs.amwa.tv/bcp-006-01/v1.0),  [AMWA BCP-006-02](https://specs.amwa.tv/bcp-006-02/v1.0), [AMWA BCP-006-03](https://specs.amwa.tv/bcp-006-03/v1.0)
- **Applicability:** `urn:x-nmos:format:video` or `urn:x-nmos:format:audio`
- **Permitted Values:**
  - Since AMWA IS-04 v1.3, string values defined for the Flow media type, as enumerated in the schema accompanying this register
  - For `video/jxsv`, the values are the profile names defined by ISO/IEC 21122-2, with any white space Unicode characters omitted as per [RFC 9134][RFC-9134]
    - For example
      - `Main444.12`
  - For `video/H264`, the values are the profile names defined by Rec. ITU-T H.264 Annex A, with whitespace omitted, the sampling mode always positioned at the end of the string, preceded by a '-' and the terms High and Baseline positioned at the beginning of the string.
    - For example
      - `High-422`
  - For `video/H265`, the values are the profile names defined by Rec. ITU-T H.265 Annex A, with whitespace omitted and the sampling mode always positioned at the end of the string, preceded by a '-'.
    - For example
      - `Main12-422`

### Sublevel
- **Name:** `sublevel`
- **Description:** Indicates additional constraints on parameters of the coding tools that are in use, as defined for the Flow media type.
- **Specification:** [AMWA BCP-006-01](https://specs.amwa.tv/bcp-006-01/v1.0)
- **Applicability:** `urn:x-nmos:format:video`
- **Permitted Values:**
  - Since AMWA IS-04 v1.3, string values defined for the Flow media type, as enumerated in the schema accompanying this register
  - For `video/jxsv`, the values are the sublevel names defined by ISO/IEC 21122-2, with any white space Unicode characters omitted as per [RFC 9134][RFC-9134]
  - For example
    - `Sublev3bpp`

### Transfer Characteristic
- **Name:** `transfer_characteristic`
- **Description:** Transfer characteristic.
- **Specification:** [AMWA IS-04 v1.1](https://specs.amwa.tv/is-04/v1.1)
- **Applicability:** `urn:x-nmos:format:video`
- **Permitted Values:**
  - Since AMWA IS-04 v1.1, values complying with the IS-04 schema
    - `SDR`
    - `HLG`
    - `PQ`
  - Since AMWA IS-04 v1.3, values defined for the TCS format-specific parameter in any published revision of SMPTE ST 2110-20
  - Since ST 2110-20:2017
    - `LINEAR`
    - `BT2100LINPQ`
    - `BT2100LINHLG`
    - `ST2065-1`
    - `ST428-1`
    - `DENSITY`
    - `UNSPECIFIED` (when no other value applies)
  - Since ST 2110-20:2022
    - `ST2115LOGS3`

[RFC-9134]: https://tools.ietf.org/html/rfc9134 "RTP Payload Format for ISO/IEC 21122 (JPEG XS)"
