Streamware Workbench Release

Transcription

1 Streamware Workbench Release

2 Introduction Streamware Workbench is a software suite for generating, receiving, measuring, and stress testing IEEE Std 802.1AS gptp time synchronization and statically configured IEEE 1722a audio streams. Key features: Workbench Controller: o Send and receive class C audio streams at a packet rate of 750 Hz o Send and receive class A audio streams at a packet rate of 8,000 Hz o IEEE 1722a clock reference streams o PTP Grandmaster fault injection o PTP Follower fault detection o Remotely controllable via TCP/IP Audio Patchbay: o Route audio signals to and from any Windows audio device and the AVB network o Record listener streams AVB virtual sound card with ASIO 2.3 support use third-party audio software for playing and recording audio Streamware Workbench runs on a Windows PC equipped with AVB-capable Ethernet hardware. System Requirements Microsoft Windows 7 with Service Pack 1 (32-bit or 64-bit) Microsoft Windows 8 (32-bit or 64-bit) Microsoft Windows 8.1 (32-bit or 64-bit) Microsoft Windows 10 (32-bit or 64-bit) AVB-capable Ethernet adapter o Streamware NIC-1 PCIe network adapter o Streamware Analyzer GbE o Streamware Analyzer BR Windows is a registered trademark of Microsoft Corporation in the United States and other countries. Streamware Copyright 2015 Echo Digital Audio Corporation 2

3 Installation Streamware Workbench uses the Pace license management system. If necessary, register for an ilok account at ilok.com, then download and install the ilok License Manager. Please note that for Streamware Analyzers, the License Manager and Workbench have been installed and activated by Echo. Streamware Workbench does not require an ilok USB device to be connected; the license may be deposited directly on the machine. Once the License Manager is installed, run the Streamware Workbench installer. Streamware Copyright 2015 Echo Digital Audio Corporation 3

4 Workbench Controller The Workbench Controller sets up the gptp configuration and IEEE 1722a Talker and Listener audio streams. From the Start menu, select Streamware Workbench from the Echo Streamware folder. Talker streams are shown on the right-hand side of the window, with Listener streams shown on the left. The current PTP time and lock status is shown in the upper right corner. For Workbench, a Talker stream is defined as a stream being transmitted by the computer and being received by an external device. Each Talker stream may be individually configured using the controls on the right side of the window. For each stream, set the stream ID and multicast address. For audio streams, set the channel count. If this is a clock reference stream, check the Clock reference box. Streamware Copyright 2015 Echo Digital Audio Corporation 4

5 Once the stream is configured, click the Start button. If the Start button is disabled, Workbench is waiting for PTP lock. Once the stream is running, click the information icon to the left of the stream ID for performance metrics. Please note that the Talker stream configuration must exactly match the configuration of the external listener. Streamware Copyright 2015 Echo Digital Audio Corporation 5

6 Listener streams For Workbench, a Listener stream is defined as a stream being transmitted by an external device and being received by the computer. Each Listener stream may be individually configured using the controls on the left side of the window. For each stream, set the stream ID and multicast address. For audio streams, the channel count should be set to match the channels_per_frame value of the talker. If this is a clock reference stream, check the "Clock reference" box. Please note that the listener stream configuration must exactly match the configuration of any external talker. If a Listener stream is designated as the clock reference stream, Workbench will use that stream as the media clock master for all Workbench Talker streams. Once the stream is configured, click the Start button. If the Start button is disabled, Workbench is waiting for PTP lock. Once the stream is running, click the information icon to the left of the stream ID for performance metrics. Streamware Copyright 2015 Echo Digital Audio Corporation 6

7 Listener stream fault logging Workbench 2.3 features extensive validation and logging options for listener streams. Each AVTP Listener packet is logged, showing the stream ID, AVTP timestamp, as well as the differences in presentation and ingress times between sucessive packets. AVTP receive packets are logged in light blue. If Workbench detects a fault, the error is logged, showing the stream ID, AVTP timestamp of the offending packet, and any relevant information specific to the particular fault. For example, here Workbench has found a difference in AVTP timestamps that is out of range. Workbench also inspects the AVTP stream header to check for invalid values. Here, Workbench has found an error in the channels_per_frame field: Since Workbench is designed to work with misbehaving devices and streams, it makes very few assumptions about the contents of incoming 1722a stream packets. Workbench requires that stream packets have a valid destination address and the correct IEEE 1722 ethertype. Beyond that, Workbench will check each field in the stream packet and compare the received values with the user-configured settings for the stream. Streamware Copyright 2015 Echo Digital Audio Corporation 7

8 Depending on the type of stream, Workbench will log an error if one of the following conditions is met: AVTP audio format error conditions packet length is too short cd (control/data) indicator is set Subtype not equal to 2 sv (stream valid) bit is clear Clock reference stream error conditions packet length is too short cd (control/data) indicator is set Subtype not equal to 0x7D sv (stream valid) bit is clear version field not equal to 0 version field not equal to 0 tv (avtp_timestamp_valid) bit is clear tv (avtp_timestamp_valid) bit is set difference between AVTP timestamps is out of range reserved field not equal to 0 format field not equal to 4 type field not equal to 1 reserved field not equal to 0 nominal_frequency field not equal to 7 nominal_sample_rate field not equal to 5 timestamp_interval not equal to 64 bit_depth field not equal to 16 difference between audio_timestamps is out of range stream_data_length is incorrect M3 bit is set M2 bit is set M1 bit is set M0 bit is set evt field is not zero channels_per_frame field is incorrect Streamware Copyright 2015 Echo Digital Audio Corporation 8

9 IEEE Std 802.1AS gptp Workbench supports IEEE 802.1AS gptp. Workbench can act as either a gptp grandmaster clock or follower. Workbench may be manually or automatically configured as one of the following roles: Statically configured gptp grandmaster clock Statically configured gptp clock follower Automatic role selection using the 802.1AS best master clock algorithm (BMCA) Streamware Copyright 2015 Echo Digital Audio Corporation 9

10 Static gptp Grandmaster To configure Workbench to act as the PTP grandmaster, select PTP Grandmaster from the top of the Time page or from the Settings page. In the PTP Grandmaster section, Workbench keeps track of how many Sync and Followup packets have been sent, and allows manual adjustment of the PTP start time if desired. Streamware Copyright 2015 Echo Digital Audio Corporation 10

11 The Delay Measurement section shows how many Delay Request, Delay Response, and Delay Followup packets have been sent and received. Streamware Copyright 2015 Echo Digital Audio Corporation 11

12 PTP Grandmaster Fault Injection The PTP Grandmaster Fault Injection section controls the intentional insertion of errors into the PTP grandmaster Sync and Follow_Up messages. Faults may be sent for a single message, or groups of messages. Faults may be sent once, or for a specific number of iterations, or repeated indefinitely. To start fault injection, choose a field to modify and enter the corrupted value. For example, the messagetype value for Sync packets is normally 0; to change the messagetype to some other incorrect value, click the enable button to the left of the field name: This enables editing the field to a new value, within the limits of the field s size. For example, messagetype is a 4-bit field, so it can have values ranging from 0 to f. Values are specified in hexadecimal (base 16). Set the messagetype to 9, which will cause the endpoint on the other end of the link to not recognize the Sync message and act as if the Sync message is missing. Clicking the circular arrow will reset the field to the default value. Streamware Copyright 2015 Echo Digital Audio Corporation 12

13 Next, specify the number of invalid Sync and Follow_Up messages to be sent, as well as the number of times that group of invalid messages will be repeated. This allows Workbench to create various, predictable patterns of valid and invalid messages that can be used to test endpoints. For example, to send 900 corrupted messages once, set the controls as follows: Once the 900 messages have been sent, fault injection will stop, the Sync and Follow_Up messages will return to normal. Workbench can also alternate between groups of corrupted and uncorrupted packets. This example will send 50 corrupted packets, then 60 good packets. That cycle will repeat itself 5 times, after which fault injection will stop. To continuously inject faults into a batch of packets, select the Repeat continuously every option from the menu. Note that while fault injection is enabled, any changes to the fault injection controls will happen in real time. When fault injection is enabled, a warning symbol will be displayed at the top of Workbench window. Streamware Copyright 2015 Echo Digital Audio Corporation 13

14 Injected faults are displayed in the log, specifying the packet type and the sequence ID of the faulty packet. Streamware Copyright 2015 Echo Digital Audio Corporation 14

15 PTP Follower The Workbench Controller has a different set of controls for Follower mode. The PTP Follower section keeps track of how many Sync and Follow_Up packets have been received. Streamware Copyright 2015 Echo Digital Audio Corporation 15

16 The Delay Measurement section keeps track of how many PDelay_Req, PDelay_Resp, and PDelay_Followup messages have been sent and received, along configuring how frequently PDelay_Req messages are sent. Streamware Copyright 2015 Echo Digital Audio Corporation 16

17 Fault Detection In the PTP Follower Fault Detection section, Workbench keeps track of what types of faults have been detected. These counters can be individually reset by clicking the reset button next to them, or all the fields can be reset at once by clicking the Reset All button. When faults are detected, Workbench will also display a blinking warning at the top of the program. Click the warning to remove it. When a PTP fault is detected, it will also show up in the log. Streamware Copyright 2015 Echo Digital Audio Corporation 17

18 Adapter The adapter tab contains information about the AVB network adapter: Streamware Copyright 2015 Echo Digital Audio Corporation 18

19 Audio driver The AVB audio driver provides a standard API for applications to access the audio within the streams. The audio driver presents the streams as a unified set of 64 channels. Channels are mapped between the streams and the audio driver as follows: Audio driver output channels Talker stream channels Output channel 1 Talker stream 1, channel 1 Output channel 2 Talker stream 1, channel 2 Output channel 3 Talker stream 1, channel 3 Output channel 4 Talker stream 1, channel 4 Output channel 5 Talker stream 1, channel 5 Output channel 6 Talker stream 1, channel 6 Output channel 7 Talker stream 1, channel 7 Output channel 8 Talker stream 1, channel 8 Output channel 9 Talker stream 2, channel 1 Output channel 56 Talker stream 7, channel 8 Output channel 57 Talker stream 8, channel 1 Output channel 58 Talker stream 8, channel 2 Output channel 59 Talker stream 8, channel 3 Output channel 60 Talker stream 8, channel 4 Output channel 61 Talker stream 8, channel 5 Output channel 62 Talker stream 8, channel 6 Output channel 63 Talker stream 8, channel 7 Output channel 64 Talker stream 8, channel 8 Streamware Copyright 2015 Echo Digital Audio Corporation 19

20 Listener streams are similarly mapped to audio driver input channels. If a stream is configured for fewer than 8 channels, the audio driver ignores the extra channels. Audio data for unused output channels is discarded, and unused input channels are filled with silence. Clock reference streams are counted as having zero audio channels. Audio Patchbay The Audio Patchbay allows routing audio signals between the AVB streams and any other audio input or output connected to the computer. The Audio Patchbay is also capable of generating individual test tones for each audio channel. Example- Streaming audio between two computers In this example, there are two computers running Workbench. One computer (the Talker) is transmitting two streams, while the second computer (the Listener) is receiving the two streams and routing the audio to built-in speakers on the second computer. First, configure the Talker on the Settings page of the Workbench Controller: In this example, the Talker is set up as the PTP grandmaster. Streamware Copyright 2015 Echo Digital Audio Corporation 20

21 Set both the audio launch time offset and the CRS launch time offset to 10 milliseconds. Configure the Listener as a PTP Follower. As with the Talker, set both the audio launch time offset and the CRS launch time offset to 10 milliseconds. The PTP time on both computers should synchronize. Next, set up the Talker streams on the Talker computer: The Talker is set up to send a single 4-channel audio stream along with a clock reference stream. Click the Start button for both streams to begin transmitting. Streamware Copyright 2015 Echo Digital Audio Corporation 21

22 On the Talker computer, open the Audio Patchbay. Since the Talker computer is only concerned with audio output, open the settings menu and select ASIO Streamware for Audio Device 1. Streamware Copyright 2015 Echo Digital Audio Corporation 22

23 The Audio Patchbay can now fill the Talker streams with audio data. In this example, the 4-channel audio stream is set up so that each individual channel has a different test tone at a different frequency and different amplitude. Streamware Copyright 2015 Echo Digital Audio Corporation 23

24 Next, configure the Listener computer to receive the streams from the Talker. Notice that the configuration here is a mirror of the Talker computer; the stream IDs, multicast addresses, channel count, and clock reference selections all match. Click Start for both streams to begin receiving. Streamware Copyright 2015 Echo Digital Audio Corporation 24

25 Open the Audio PatchBay on the Listener computer. The Listener computer needs to use AVB for audio input, so for this example, select "ASIO Streamware as the Audio Device 1, and set it to have four input channels. This particular computer has an AudioFire 2 as its sound card, so it is set as Audio Device 2 for the audio patchbay in the example below. By changing the source selection for Output channel 1, the individual channels for the incoming stream may be sent to the speakers, allowing the user to hear the differences in frequency and amplitude, audibly verifying the incoming stream is correct. Streamware Copyright 2015 Echo Digital Audio Corporation 25

26 Remote Protocol Streamware Workbench supports remote control for both the Workbench Controller and the Audio Patchbay using a custom socket protocol. Documentation regarding the remote protocol, along with an example program, can be found here: Streamware Copyright 2015 Echo Digital Audio Corporation 26

27 Streamware Workbench Version History Version Added remote protocol support for PTP fault injection Fixed packet receive issue with SDK and IOL Violett Version Removed support for 1772a draft 14 Added support for 1722a draft 16 Fixed receiving 1722 packets if the network adapter is configured to not strip the VLAN header New SDK APIs for setting PTP message intervals Fixed a bug with setting the PTP sync interval to one second or more New SDK APIs for querying the available Ethernet modes for Analyzer BR Minor bug fix for SDK sample code Fixed an issue with changing PTP modes when using the SDK Made the SDK work better for cards not authorized for IOL Violett Version Fixed audio offsets for draft 6 talker format functions Reduced minimum packet size to 60 bytes Auto-set maximum number of channels for stream based on format & stream class Added support for choosing between 16 and 32 bit streams Added in support for PTP VLAN tagging Version Pace copy protection has been removed from Workbench Version Audio driver ASIO driver thread timeout now based on ASIO buffer size Audio Patchbay Fixed several issues with sample rate conversion Added the ability to set the resampler s offset in parts per million Added device statistics dialog box Streamware Copyright 2015 Echo Digital Audio Corporation 27

28 Version Workbench now supports 1722a Draft 14 Reduced max talker safety offset to 10 milliseconds Version 2.6 User-selectable VLAN for talker streams Added talker safety offset control for talker streams Version Fixed some incorrect PTP flags being set Extended max static stream multicast address to 91-e0-f0-01-ff-ff Version Fixed several issues with auto-starting streams Added in more options for delay and sync packet intervals Version Fixed performance issues with driver PTP real-time thread consuming excessive CPU time Fixed issues with disk logging not displaying or resetting correctly Version Disk logging no longer uses memory mapped files to avoid consuming excessive kernel memory Fixed PTP resume on link down/link up PTP flags now match 802.1AS corrigendum Fixed false positive PTP sync message sequence ID error detection Fixed log export event index range auto-select Version Workaround for packet transmit race condition protocol driver detects duplicate egress timestamp and retries the read. Version Switched to Broadcom miniport version to fix duplicate egress timestamps Version 2.5 New features include much improved event logging, an improved audio patchbay, along with PTP and AVTP fixes and updates. Streamware Copyright 2015 Echo Digital Audio Corporation 28

29 AVTP PTP VLAN PCP field can now be set for Talker streams (see IEEE 802.1Q section 9.6) Media clock can now be set independently from PTP grandmaster clock Clock reference streams can now have multiple timestamps per packet Fixed a race condition that caused missing stream packets Audio stream timestamps are now offset from clock reference stream timestamps to comply with IEEE 1722a, sections 11.4 and 11.5 Listener packets with invalid presentation time offsets are logged and discarded Maximum listener and talker presentation time offset is now 40 milliseconds Fixed an issue switching between audio and experimental stream formats for UNH IOL VIOLETT support Incoming PTP messages are now discarded if the transportspecific field is not equal to 1 to comply with 802.1AS Corrigendum 1, section change. Initial rate of Sync/Follow_Up messages is now configurable Fixed a bug with correctionfield for received Sync messages twostepflag is no longer incorrectly set for PDelay_Resp messages Event Logging Event logging now supports a virtually unlimited number of events to be logged, disk space permitting. Logs can be exported to either CSV or compressed CSV format. Logs may be exported either in their entirety or from a range of event indices. Log now shows time of day instead of relative time index The log can be toggled between continuous logging, or to stop logging once the log is full Streamware Copyright 2015 Echo Digital Audio Corporation 29

30 Remote Protocol New Workbench command, GetPTPInfo, which sends the current PTP and PTP fault injection settings Workbench Controller Onscreen indicator that the link state has changed Fixed an problem with detecting that the BroadR-Reach link was incorrectly configured for autonegotiate Audio Patchbay User interface improvements Better sample rate converter with lower CPU usage and flat frequency response Removed wave file record feature Streamware Copyright 2015 Echo Digital Audio Corporation 30

31 Version 2.4 New features include PTP fault injection and detection, streams auto-start, and remote control over TCP/IP. PTP Grandmaster fault injection Inject faults into sync/followup packets field by field Customizable rate of fault injection Follower fault detection Detects missing sync/followup packets Checks all sync/followup packet fields for errors Checks the sequence IDs of sync/followup packets User interface Cleaned up stream metrics display Added menu commands o Stop all streams o Swap talker and listener stream configurations Fixed a bug where the AVB link could be in half-duplex mode but was shown as fullduplex AVTP Stream auto-start on PTP sync Separate presentation time offsets for talker and listener streams Discard audio and clock reference packets for listener streams if the timestamp offset is negative or twice the expected offset Fixed a bug where the min/max reference time could be incorrectly displayed for out of range differences Fixed a bug where talker streams would not start with variable rate PTP sync/followup packets Fixed a bug initializing listener stream packet lengths on startup Fixed a bug with calculating the audio buffer position for listener stream packets that caused occasional audio glitches Remote protocol Streamware Copyright 2015 Echo Digital Audio Corporation 31

32 Workbench now supports remote control via sending and receiving JSON-formatted strings. More information can be found here: Workbench settings can now be controlled over remote protocol AVB link state notifications link up/down, link speed, BroadR-Reach/Ethernet mode Send S/PDIF lock/unlock change notification for Analyzer BR Minor bug fixes Audio Patchbay Patchbay now detects if Workbench is running Patchbay can now record listener stream audio to wave files Streamware Copyright 2015 Echo Digital Audio Corporation 32

33 Version This release fixes several bugs. Fixed an audio talker stream packet scheduling error that could potentially occur if a listener clock reference stream is rapidly stopped and restarted. Fixed an incorrect message in the event log (event log would show "AVTP launch error") if the ethernet link goes down while one or more talker streams are active Version This release adds in a new page to Workbench to show the network adapter s status and any receive or transmit errors it has detected. Workbench can now work with a network tap. Corrected a bug where PTP packets could be sent with duplicate egress timestamps Added a new page to Workbench showing the network adapter status and errors "Tap" mode - Workbench can run on a computer connected to the output of a network tap. To do so, just disable sending PDelay_Req messages from the Settings page, and set PTP Follower mode. Workbench can then passively receive PTP sync/followup messages and listener streams. Changed a register setting in the BR PHY as a workaround for a Broadcom errata Version PTP signaling can now be enabled and disabled from the Settings page Increased the maximum transit time for talker streams to 20 milliseconds Added a new setting: manual timestamp offset for listener streams. Streamware Copyright 2015 Echo Digital Audio Corporation 33

34 Version Several new features and bug fixes in this release, adding in PTP signaling support and updating the PTP user interface. Fixed a problem where the clock reference stream timestamps were set too far ahead Fixed a problem with the BroadR-Reach PHY configuration that could cause the link to spontaneously disconnect Added support for PTP signaling with variable grandmaster sync/followup message rate Moved PTP operations from separate deferred procedure calls to a single real-time thread New PTP user interface The user can now manually set the PTP time Added support for configuring how often Workbench sends PDelay_Req messages PDelay_Req message transmit can now be enabled or disabled Version This update is mainly bug fixes combined with some updates to how the controls function, along with updates to how the remote protocol handles commands. Listener audio streams now mute the audio when receiving packets with the wrong channel count Fixed a bug where the media clock would not be recovered correctly from incoming clock reference stream due to a buffer overflow; the packet buffer is now reset properly, so the audio driver can recover a valid media clock Fixed a minor bug where stream ID and destination address control values were not saved on shutdown if they had keyboard focus Fixed a bug where certain settings would be configured incorrectly if the user selected "Load file", then selected cancel on the load file dialog Fixed a bug with PTP follow-up validation, where the software would log an invalid follower event in grandmaster mode Several fixes to the remote protocol: o Workbench now rejects stream control changes while streaming o Workbench now rejects subtype change while any stream is active o Workbench now sends subtype change notifications for all streams when the clock reference stream is selected o Patchbay now reports the version number with the System property For the Workbench Remote application, the CRS button is now correctly disabled and enabled when streams start and stop Streamware Copyright 2015 Echo Digital Audio Corporation 34

35 Version Workbench and the Audio Patchbay are now both capable of saving and loading settings, and the Audio Patchbay now supports remote control via the same protocol as Workbench. Workbench controller can now save and load settings (.workbench file) Audio Patchbay can now save and load settings (.patchbay file) Audio Patchbay now supports remote control Workbench controller now generates fault notification events over remote control Version Support for class A streams has been added, along with some user interface updates and a bug fix regarding timestamp synchronization. Mismatch stream IDs are logged as errors On-screen link status indicator Fixed issue with synchronizing the timestamps for listener audio streams if Workbench was acting as the media clock master. Added support for class A streams (default is still class C) 64-bit hex values are now displayed in the log with a dot in the middle for readability (0x abcdef0) Streamware Copyright 2015 Echo Digital Audio Corporation 35