RAVENNA Advanced Pages User Guide V2

This guide applies to:

• Merging Anubis firmware v2.0 (and above)

• Merging Hapi MkII firmware v2.0 (and above)

• Merging Hapi MkIII firmware v2.0 (and above)

• Neumann MT 48 firmware v2.0 (and above)

Horus, Hapi, Hapi MKII, Hapi MKIII, Anubis and Neumann MT 48 running firmware prior to 2.0, please download the Legacy User Guide PDF.

The DANTE Advanced Pages User Guide is available on this page.

How to access the Advanced pages

1. With the device IP address :

   1. Hapi MKII / Hapi MKIII / Anubis / MT 48
      In your browser, enter the device IP address followed by /advanced/index.html
      E.g: 169.254.80.179/advanced/index.html

   2. VAD / ASIO/MAD, CoreAudio, ALSA)
      In your browser, enter the device IP address followed by :9090
      E.g: 169.254.80.179:9090

2. Through MT Discovery :
   Right click on your device and select Open Advanced (Hardware devices : Horus, Hapi,...) or Open (Software devices : MassCore, ASIO, Alsa,....)

3. Through ANEMAN : 
   Right click on your device and select Web Services : Advanced (or RAVENNA if Advanced is not available)

4. Through Merging Audio Device panel (Windows) - Virtual Audio Device Panel (Mac)
   Right click on your device and select Open Advanced

STATUS TOP BAR

• Identify me : Provides visual feedback on the unit to allow the user to quickly identify a unit 
  When ticking the checkbox :

  • Anubis displays its Device Name on TFT and flashes its Home button (Merging logo).

  • MT 48 displays its Device Name on TFT and flashes its Home button (Neumann logo).

  • HapiMkII & MKIII flashes its front panel Merging logo.

• Device Name: Unique zeroconf device name
  Hovering the mouse cursor on the Device Name will display the Host Name.

• Access other Merging RAVENNA/AES67 devices detected on the current network.
   

• Sample Rate, Frame Size, PTP Domain, IP Address
  Current status of the device. Those settings can be modified in the General Settings menu.

• Product, Company, Serial, Version
  Device information.
   

• App Settings
  

  • Size: App display size (60-120%)

  • Routing Grid Orientation: changes the routing matrixes axis (Sources/Sinks - Sinks/Sources) (Left to Top - Top to Left)

  • Stream Labels: Sources-Sinks numbering (Stream ID - Channel ID)

• System Menu

  • Configuration File: Download / Upload : Save / Load device configuration (preset file).

  • Commands

    • Reboot : restart the device

    • Reboot to Factory : restore all settings to factory default, and restart the device

    • Restart : Restart the device

    • Save : save the current configuration.
      Note: Some commands might not display depending on the device.

• Debug

  • Get Report : generates a debug report, and saves it on the local computer.  
    If the report is not saved automatically, make sure your web browser did not block the download.

  • Get Device Status : displays the device status (SysLog)

  • Get Device Engine Status : displays the device engine - ZMAN-based devices only

  • Toggle Transparency check : (Merging RAVENNA ASIO driver / Merging Audio Device driver only) : send a transparency check signal on the first output channel (Channel0)

• Advanced Pages Documentation 
  Link to this page.

GENERAL

Device

• Name: This is the unique zeroconf device name.  Other devices see this device name. 
  Reboot is not required for the change to apply. 
  Merging recommends to not exceed 32 characters (The device name is translated to UTF8, which support max 63 bytes.

• User Defined: Toggles between user defined name and Default device name.

• Location: information text (64 characters max)

Audio Configuration 

• Sample Rate : current sample rate (44100-48000- 88200-96000-176400-192000-352800-384000)

• Frame size (@1Fs) :current frame size (64 - AES67/48 - 32 -16 - 12 -6).
  Note that available frame size values may not be available or differ according to the device and/or firmware.

Session Sinks Global

• Safety Playout Delay: additional playout delay.  The value is always described at 1Fs (44.1-48 kHz) in samples.
  For example, if the value is 48, the additional playout delay will be 96 at 2Fs (88.2-96 kHz), 192 at 4FS (176.4-192 kHz),...

• SSM: Source-Specific Multicast. (requires IGMP v3)
  If you activate this option, make sure your network switch supports and is configured for IGMP V3.

Network

• Multi-interface mode : Activate / deactivate ST2022-7 mode - only applicable to Merging devices supporting such feature.

• Link Color : status Up (Green) / Down (Red)

• Configuration : defines the type of IP V4 address used (AutoIP- DHCP - Static)

• Address - NetMask - Gateway - DNS : only accessible if Configuration is set to Static.
  Reboot is required for changes to apply.
  
  Note: Changing the network configuration requires a reboot. The user will be automatically prompted when required.
  

PTP

General

• Status:

  • Green: Locked

  • Orange: Locking

  • Red: Unlocked

• Type: Information only

• PTP Domain : allow to define a specific PTP domain, usually when several PTP masters are required in the same network (default value is 0).

• DSCP : PTP DSCP (46-EF : PTP AES67 / 48-CS6 : PTP RAVENNA / 56-CS7)

Graph

• The graph is only active for slave devices.

• Not available for ASIO (MAD) device.

• Blue curve : shows the network delta against the current Master PTP clock, before the device regulation algorithm

• The PTP Graph can be Pinned or Unpinned

  •   Pinned

  •  Unpinned

Master

• Priority 1 is the main priority value.

• Class : Device class.  This value should not be modified.

• Accuracy : cant be modified.

• Priority 2 is only used if the other parameters do not allow to elect a PTP master.

• GMID : Current GrandMasterID (PTP Master)

• Slave only  : forces the Merging device to always be PTP slave.

• Delay Mech.:  PTP Profile related - E2E or P2P

• Announce : PTP Profile related - PTP announcement interval (0.125 - 0.25 - 0.5 - 1 - 2 - 4 - 8 -16 seconds)

• Sync : PTP Profile related (0.0625 - 0.125 - 0.25 - 0.5 seconds)

Status

• ASIOClock Host : Master ASIO Clock device IP address (only displayed for Merging RAVENNA ASIO device).

• GMID : Current GrandMasterID (PTP Master) 

• Lock : shows if the device is locked to PTP (Locked -Locking - Unlocked)

• Interface 1-2 :
  Note : depending on the device and firmware, only Interface 1 might be available.
  PTP status : 
  Master : Device is Master 
  Slave : Device is Slave
  Listening : The interface is not used for synchronization.
  Disabled : The interface is not connected (and the device cannot be Master, e.g. MassCore device)

ASIO CLOCK

• Multicast Clock : Auto / On / Off the Multicast ASIO Clock (Same setting as the ASIO Clock in Setup > System menu for Hapi MKII / MKIII and in Settings > Clock  for Anubis / MT 48)
  Auto will only activate the ASIO clock on the Master PTP device.

• Address : Multicast address of the ASIO Multicast Clock

• DSCP : allows you to set the ASIO Multicast Clock DSCP between 34, 46, 48 and 54.
  If you use a switch, please make sure that the ASIO Clock DSCP has a high value in the switch DSCP to Queue table.
   

SOURCES & SINKS SELECTION

• When clicking on a Source or a Sink, it will be pinned.

• Pinned Source or Sink are displayed with a solid background color

  • Pinned

  • Unpinned

• When pinning several Sources or Sinks, those are added below the current ones.

• Holding CTRL while clicking on a Sink or Source will only show the selected Source or Sink.

SOURCES

• Create new source button

• Delete all sources - Delete selected sources button

•  Source Status and name

•  Channels routing Compact view

•  Channels routing Expanded view

•  Delete current Source

Source Configuration

• Source Status and name

• Show Session Description Protocol information (useful for specific third party devices if manual SDP has to be provided).
  Note: Some browsers may ask you to enable the SDP popup window to display it.
  Note: Devices in 2022-7 mode will produce a 2022-7 SDP, containing both interfaces session parameters.  
  If you load such SDP in a non-2022-7 device, only the session parameters from interface1 will be used.

• Enable button: enables the selected source (active by default)

• IO : select the physical input (when applicable)

• Name : Source name (63 characters max)

• Description : information text (64 characters max)

• Channel Count: Number of channels in the stream. 

• From: Device channel numbers

• Output Interface(s) : select the Source output Primary network, Secondary or Redundant (ST_2022-7)
  Note : depending on the device and firmware, only Primary might be available.

• Auto-unicast (retrieve unicast address+port from sink (RTSP) : automatically retrieve the sink (listener) IP address for unicast connection. 
  This feature only applies to Merging Technologies devices. See Appendix - See this page for further details

• Adresses : stream multicast address for the selected Output Interface
  Note : specific destination port can be manually set in the address field (for example: 239.1.66.25:9000 )
  More details in the Appendix section.
  Note: If only Primary Interface is available, the Secondary field is disabled.

• Manual button : allow to manually enter or modify the multicast IP address. 
  Note : Manual checkbox is activated automatically when entering a multicast address manually.

• TTL : Time to Live (also called Hop Limit)  - this value should not be modified

• Payload type : RTP Payload type - this value should not be modified

• Codec : L24 - L16 - DSD64 - DSD64_32 - DSD128 - DSD128_32 - DSD256 (bit rate).  Note that those values are sampling rate dependent.

• Frame size (samples) : frame size of the current source.

• DSCP : audio DSCP (34: RTP AES67 / 46: RTP Ravenna)

• RefClk PTP traceable: This feature is useful when you want to connect a stream through Internet (e.g. with two PTP Masters (GPS) at each locations), it allows to make connections with devices locked to different traceable PTP Masters.
  See also Ignore refclk GMID - accept source locked to any PTP master on the Session Sinks section below.

Channels

• Routing Matrix: Select IOs to route in the Source.
  Note: Not applicable to driver devices (MAD ASIO, VAD CoreAudio, MassCore)

SINKS

• Create new sink button

• Delete all sinks - Delete selected sources button

•  Sink Status and name

•  Channels routing Compact view

•  Channels routing Expanded view

•  Delete current Sink

Sink Configuration

• Enable button: enables the selected sink (active by default)

• IO : select the physical output (when applicable)

• Label : Sink name

• Description : information text (64 characters max)

• Channel Count: Number of channels in the stream. 

• From: Device channel numbers

• Source : drop down menu to select a source (both sap and bonjour advertised sources are listed).

• Manual : allow to manually enter a SDP

• Playout Delay: playback delay in samples.

  • Automatic delay (automatic delay works for Merging Technologies devices).
    For non-Merging devices, if set to 0, the playout delay is calculated based on the SDP a=framecount value. 
    In any case, the frames must be time aligned; all devices must run an integer number frames from time zero (epoch).

  • 192(2ms) - 288(3ms) - 384(4ms) - 480 (5ms) - 1024(10.67ms) - 2048(21.33ms)

  • Values can be manually entered as well

• Relaxed check: accept source with lower channel count : allow to connect to a source that have less channels.

• Ignore Reference Clock

  • GMID: accept source locked to any PTP master :  This feature is useful when you want to connect a stream through Internet (e.g. with two PTP Masters (GPS) at each locations), it allows to make connections with devices locked to different traceable PTP Masters.
    See also RefClk PTP traceable on the Session Sources page.

  • Domain: accept source locked from any PTP master :  This feature is useful when you want to connect a stream through Internet, it allows to make connections with devices locked to different PTP domains.

• SDP : display detailed SDP information on the current stream.

Channels

• Routing Matrix: Select IOs to route in the Source.
  Note: Not applicable to driver devices (MAD ASIO, VAD CoreAudio, MassCore)

Statistics

• The graph displays the ahead time (in μs) of the selected Sink

Session Info

• Session Status

  • Initializing : The Sink has been created, and waiting for the Source information to connect.

  • Started: The Sink is trying to connect to the Source.

  • Connected: The Sink is connected to the Source.

  • Muted: The Sink is muted - see possible errors below

• Global RTP Status :
  In 2022.7 Mode, the Global RTP Status displays the status for both interfaces.
  In non 2022.7 Mode, the Global RTP Status will be the same as the interface status.

  • Receiving : Currently receiving

  • Muted: The Stream is muted, see Interface RTP Status for further details.

  • Degraded: 2022.7 Mode only - one of the interface is not receiving RTP packets properly.

• Session name : defined in SDP (usually the same as the source name)

• Playout Delay : current playout delay on the selected sink in samples (and ms).

• RTSP Host : connected source IP

• Interface 1-2 
  Note : depending on the device and firmware, only Interface 1 might be available.

  • RTP Status : connection status (interface level)
    Receiving RTP packets
    Wrong RTP sequence id
    Wrong RTP SSRC
    Wrong RTP SAC
    Wrong RTP payload type
    Stream has been muted 
    All Streams have been muted (i.e. ST2022-7)
    Some Streams have been muted (i.e. ST2022-7)
    See possible errors below

  • Clock domain : PTP clock type and domain

  • Address : Multicast IP address of the selected sink

  • Payload : Payload / Codec / Sampling Rate / Number of channels

IO ROUTER

Allows to connect I/Os in the Internal device router.

The IO Router can be pinned or unpinned

•  Pinned

•  Unpinned

Note: Groups with fewer than 8 channels cannot be collapsed

NMOS

NMOS General Settings

• Enable : enable or disable the NMOS client, following the Port and Registration server configuration.
  Note : NMOS must be disabled to access the settings.

• Port : Device NMOS communication port 
  Note: Some ports are used by Merging devices, therefore those ports cannot be used for NMOS.
  Anubis, Hapi MKII, Hapi MKIII, MT48: 80,81,8080
  Merging Audio Device (ASIO Windows), Virtual Audio Device (CoreAudio MacOS), ALSA (Linux) : 9090
  MassCore: 8080

• Flush streamer address on disable : clears the streamer address when the stream is disable.  This option might be useful with some NMOS servers.

• Set UUID from Names : Unique ID created from name.  A device restart is required when the name/UUID is changed.

Registration Server

• Mode : Registration Server communication modes :
  mDNS (Bonjour): Automatic communication to a Registration Server, using Bonjour service (The server needs to advertise with Bonjour Service)
  Search domain: A search domain needs to be supplied. 
  The search domain associated with the primary network interface is shown as Suggested. 
  This mode is not yet supported on embedded devices
  Static Address: The registration server is found using the address given in the “Address” field. 
  This is currently the preferred and most common way to establish communication with a NMOS Registration Server.  (Sony NMOS CPP, Riedel NMOS,...)
  Registry Less: Activate the NMOS node for the device, without NMOS Registration Server.

• Address : When Mode is set to Static Address, allows to enter the server IP address and port (<ip address>:<port number>).

• Search Domain : When Mode is set to Search Domain, allows to enter a domain (Unicast DNS).
  In other modes, this field only displays information when the communication is established.

• IS-04 Version : V1.2 - V1.3.

Registration Server Status

• Server Name / Host : provided by the Server (with DNS or mDNS).  Note that this field may remain empty when mode is set to static 

• Address / Port : Server IP address and Port.

• Registered : True If a registration server can be reached.

HOME

• Home Server: NATS server address (alternatively, the Home Server IP address and port can also be entered).
  Note : Home must be disabled to access the settings.

• Enable: enable or disable the Home client, following the Home Server address.

• Server address found: Server address found according to the Home Server field.

• Registered: Current connection status
   

STATIC DEVICES LIST

eg. [{"IP":"192.168.1.99", "port":80},{"IP":"192.168.1.124", "port":80}]

Appendixes

PTP Priority value

Auto-Unicast feature

• Horus - Hapi : firmware v3.9.2

• Anubis : firmware v1.0

• MassCore : Pyramix v12.0 / Ovation v8.0

• Ravenna ASIO : v12.0

• Merging Audio Device : v1.0

• ALSA : v1.0

• CoreAudio / Virtual Audio Device : v2.0.40016

Connections Color Convention

• White: Physical to Physical connection

• Yellow: Physical input to Source

• Turquoise: Sink to Physical output

• Khaki: Source to Sink

Session Sources error codes

Session Sinks error codes