This chapter describes management and usage of the licensing system based on CodeMeter from WIBU Systems available in Viz Engine 3.10 and later. It replaces the previous VALID/Sentinel/Hardlock Dongle licensing system and allows Viz Engine to be used without a physical dongle on each machine, by allocating licenses from a license server on the network.

This section contains the following information:

Important Pre-installation Information

The WIBU licensing system requires the installation of the CodeMeter Runtime Software (included in the Bundle installer):

When the license should be retrieved from a dedicated license server, it must be configured in the Vizrt Licensing Service (see Client Configuration page in the License Server Setup and Administration section of the Vizrt Licensing Administrator Guide) or the CodeMeter WebAdmin.

Key Features and Workflow of the New Licensing System

•  The VALID/Sentinel/Hardlock Dongle is no longer supported for Viz Engine 4.0.0 and later versions.

• Dongle-less operation on clients with monitoring and logging capabilities.

• Grace periods for allocated licenses to avoid immediate expiration on network or service interruptions.

  • In Viz Engine 4.0.0/3.14.1 or newer license errors are logged to the Graphic Hub journal (see here how to enable E-Mails).

    • Logs license errors (any grace state or if expired) to the Graphic Hub journal as dedicated log messages with level 820.

    • Logs warnings two weeks and every hour prior to license expiration as dedicated Graphic Hub journal message with level 920.

• Configurable WIBU license container location (any local container, any network container or a dedicated container).

• Configurable licenses to consume.

• Viz Artist/Viz Engine startup was changed and no startup helpers are needed anymore (.cmd files, started executables). 

• When a core license cannot be allocated on startup Viz Engine starts in configuration mode.

• When an additional license fails to allocate on startup an error is logged and the required feature keeps disabled on startup.

Limitations and Known Issues

• All additional licenses consumable to a core license must come from the same container as the core license.

• Matrox DSX.Core installer corrupts an existing CodeMeter Runtime installation and causes a crash on Viz Engine startup.

  • Uninstall any CodeMeter Runtime prior to installing Matrox DSX.Core. Install DSX.Core and afterwards install Viz Engine and the newer CodeMeter Runtime.

• For a preview in TRIO and Pilot as Engine Core, a DVI OUT license is needed.

• Configuration of licenses requires to start Viz Engine in configuration mode with the configuration UI.

• In Viz Engine 3.12.1 and newer, the configuration UI works without a valid license and can be configured through the configuration UI.

  • In Viz Engine 3.12.0 and older, the configuration UI only works with a valid license, which depends on the configuration. If no proper license is available then a manual edit of the corresponding configuration entries is required. See Configuration Entries in the Viz Engine Configuration File.

  • By default, the WIBU licensing system with Engine Core license (ENG_ENG_CORE) is used when no configuration exists. 

• File-based local WIBU licenses on server operating systems (terminal server) cannot be used via remote desktop connections. For example, if you have installed Windows 10 the access via remote desktop connection works but not, for example, with a Windows Server 2016 system.

• Viz Engine Startup may take long when network communication has high latency or bandwidth is limited. Workaround for now is to use a license server on a local network.

• Security groups respective Firewalls on Cloud providers might need to be configured to allow UDP traffic on port22350 to reach and consume licenses from a license server.

Basic Set-up

To set up Viz Artist/Viz Engine licensing with WIBU:

1. Install Viz Artist/Viz Engine with the bundle installer (see Viz Artist and Viz Engine Installation).

2. Configure CodeMeter with the Vizrt Licensing Service or the CodeMeter WebAdmin (can be opened from the CodeMeter Control Center).

3. Configure the license system in Viz Engine by starting in configuration mode and navigate to Viz Licenses.

   

   1. When using any WIBU network container (license server):

      1. Open the CodeMeter WebAdmin and add the license server to the server search list:

         

      2. In the configuration UI under Viz Licenses set Container to 0,0 Any Network Container or in the Viz Engine configuration file set License_Containers = 0,0,1.

      3. Configure the core license and any additional licenses. In the configuration UI under Viz Licenses configure Core License and Additional Licenses or in the Viz Engine configuration file configure License_Core and Additional_Licenses.

   2. When using any local WIBU container (dongle, file):

      1. In the configuration UI under Viz Licenses, set License Location to 0,0 Any Local Container or in the Viz Engine configuration file set License_Containers = 0,0,0

      2. Configure the core license and any additional licenses. In the configuration UI under Viz Licenses, configure Core License and Additional Licensesor in the Viz Engine configuration file configure License_Core and Additional_Licenses.

   3. When using a dedicated WIBU container (with full container identifier):

      1. In the configuration UI under Viz Licenses, set License Location to a specific container (for example, 130,3910158968 Network license) or in the Viz Engine configuration file set License_Containers = 13 0,3910158968,1

      2. Configure the core license and any additional licenses. In the configuration UI under Viz Licenses, configure Core License and Additional Licenses or in the Viz Engine configuration file configure License_Core and Additional_Licenses.

4. Start Viz Engine.

Configuration Settings

Why Do We Need to Configure the Licenses?

• Prevent license theft by instances on other nodes or instances on the same node. Licenses are in one container and have a count.

• Several licenses may enable the same feature. There is no one to one mapping of application feature to a single license possible. For example, with multiple instances on one node (Trio One Box), it is important which instance consumes which license for proper operation (first needs SDI OUT, SDI IN and 2nd DVI HD).

• A license may enable multiple internal application features.

Configuring the License System in the Viz Engine Configuration UI

See Viz License Configuration.

Configuration Entries in the Viz Engine Configuration File

Entries changed in 4.0.0 and later: Legacy_Licensing (removed), License_Location (removed, was replaced by License_Containers)

• License_Containers: WIBU license source. Determines where WIBU should search for license containers and allocate licenses from.

  • Can be set to one of the following values:

    • 0,0,0 - Any Local container. Searches exclusively for containers located on the same PC or allocated to the same VM (for example, dongle, file).

    • 0,0,1 - Any Network container. License is to be sought in the network (LAN, WAN), CodeMeter License Server activated as network server or CmWAN.

    • X,Y,1 - A dedicated container, where X is the container mask (for example, 130) and Y is the container serial (for example, 3910158968)

  • Default: 0,0,1

• License_Core: WIBU core license, which determines also the available additional licenses.

  • For WIBU license details, see WIBU Licenses and their Effect.

  • Can be set to one of the following values:

    • ENG_ENG_CORE - Engine Core

    • ENG_PRV_CORE - Preview Core

    • ENG_FRAMESERVER_CORE - Frameserver Core

    • ART_ARTIST_FREE - Free Viz Artist

  • and for OEM (see Note on Shared Licenses)

    • VIZLIB_LIBERO_CORE - Viz Libero Core

    • VIZARE_VIZARENA_CORE - Viz Arena Camera Tracking Engine

    • VIZECL_VIZECLIPSE_CORE - Viz Eclipse Core

• Additional_Licenses: WIBU additional licenses that are additionally consumed and determined by the core license.

  • For WIBU license details, see WIBU Licenses and their Effect.

WIBU Additional Licenses for Engine Core License ENG_ENG_CORE

WIBU Additional Licenses for Core License ENG_PRV_CORE

WIBU Additional Licenses for Core License ENG_FRAMESERVER_CORE

WIBU Additional Licenses for Viz Libero Core License

• Viz Engine DNxHD Codec Support

WIBU Additional Licenses for Viz Arena Core License

• Viz Engine DNxHD Codec Support

WIBU Additional Licenses for Viz Eclipse Core License

• Viz Engine DNxHD Codec Support

WIBU License System

Summary of Key Concepts in the Licensing System

• Core- and additional licenses exist.

• OUT based channel counting for NDI/SDI/IP

• IN and OUT channels are resolution independent up to 3G HD

  • <=2K size of render output

• Preview channels (preview/clean feed OUT) are co-enabled with every OUT channel license.

• MezzIP applies to all compressed streams:

  • Included: RTP/UDP/WebRTC

  • Excluded (requires SDI/IP licenses): SMTPE ST2022-06, ST2022-07, ST2110; ASPEN.

• Multiple licenses may enable the same application feature! 

• Licenses are consumed by multiple processes and license share mode influences possible consumption (see WIBU License Share Status).

WIBU License Share Status

Refers to a WIBU license and how its usage is counted when it is allocated/consumed.

• Exclusive: Allocation can only be performed once on a node (=machine).

• User Limit: Each allocation is counted, independent of instance and node.

• Shared: Each allocation is counted once per node. Multiple allocations on the same node allocate only a single license.

• No User Limit: Only checked for existence, no counting is performed.

WIBU Core License Summary

The following table represents which features are included in one of the Core features and what additional feature might need to be configured.

WIBU Licenses and Their Effect

A WIBU license is a dedicated license (application ID) in the WIBU license system.

Notes

Colors used in License Overview

The following color schema is used in Viz Engine to display the status of the license:

Starting Viz Engine with WIBU License System

• User configured in Viz Engine configuration which license(s) should be used/consumed.

• A core license is required to start Viz Engine.

• To enable higher resolutions for postrendering (>2K) then use:

  • ENG_ING_4KVIDEO for up to <=4K width/height.

  • ENG_OUT_DVI_MAX for unlimited resolution.

Starting Viz Engine with DVI OUT

• User configured DVI OUT in Viz Engine configuration file: No Videoout, onair_vga_preview=1 or VGA version, startup in Engine or Artist mode.

• The following licenses need to be available in WIBU license system: 

  • ENG_CF_DVI (resolution limited to <=2K width/height).

  • OR ENG_OUT_DVI_MAX (no resolution restriction).

• When configuration is changed at runtime and violates the license restriction, the resolution is limited to the allowed resolution (for example, 2K width/height).

• DVI OUT is required for local preview in external applications (for example, Viz Trio, Pilot Template Wizard, Pilot Director).

• When resolution is higher than 2K the startup fails for ENG_ENG_CORE without a proper ENG_ING_4KVIDEO or ENG_OUT_DVI_MAX license. 

Starting Viz Engine with MezzIP OUT and/or 1xMezzIP IN

• Without the ENG_ING_4KVIDEO license the output is limited to <=2K width/height.

• When running Viz Engine with RTP/UDP IN/OUT or Service Host with WebRTC OUT the following licenses need to be available in the WIBU license system:

  • OUT: ENG_CF_MEZZIP OR ENG_OUT_MEZZIP_MAX

  • IN: ENG_IN_MEZZIP_MAX

• To enable resolutions >2K and <= 4K then ENG_ING_4KVIDEO is required.

• See Note on Shared Licenses.

Starting Viz Engine with NDI OUT and/or NDI IN

• When running Viz Engine with NDI IN and/or NDI OUT the following licenses need to be available in the WIBU license system:

  • OUT: ENG_CF_NDI OR ENG_OUT_NDI

  • IN: ENG_IN_NDI_MAX

• To enable resolutions >2K and <= 4K then ENG_ING_4KVIDEO is required. 

Starting Viz Engine with Frameserver Functionality (MUX Ports)

• When running Viz Engine as a frameserver (for example, for NLE clients or Viz Story) the following licenses need to be available in the WIBU license system:

  • ENG_CF_FS to start one frameserver instance per node

  • OR ENG_OUT_FS_MAX to start multiple frameserver instances per node

• To enable higher resolutions frameserver snapshots (>2K) then use:

  • ENG_ING_4KVIDEO for frameserver snapshots of up to <=4K width/height.

  • ENG_OUT_DVI_MAX for unlimited resolution frameserver snapshots.

Starting Viz Engine with SDI/IP OUT or SDI/IP IN

• When running Viz Engine with SDI/IP IN and/or SDI/IP OUT the following licenses need to be available in the WIBU license system:

  • OUT: ENG_OUT_SDIIP per output one license is consumed

  • IN: ENG_ING_SDIIP_MAX

• To enable higher resolutions SDI/IP OUT/IN (>2K) use:

  • ENG_ING_4KVIDEO for up to <=4K width/height. 

Starting Viz Engine with Viz Artist

• When running Viz Engine with Viz Artist the following licenses need to be available in the WIBU license system:

  • ENG_ENG_CORE and ENG_ARTIST

  • OR ENG_PRV_CORE and ENG_PRV_ARTIST

  • OR ART_ARTIST_FREE

Starting Viz Engine with Unreal Integration (Vizrt Media for Unreal Engine)

• When running Viz Engine with Unreal Integration (Vizrt Media for Unreal Engine) the following licenses need to be available in the WIBU license system:

  • ENG_ENG_CORE, ENG_ING_SDIIP_MAX, ENG_OUT_SDIIP, ENG_PLUG_CHROMAFX and ENG_UE4_RENDER_BLADE_CORE

  • OR ENG_PRV_CORE and ENG_UE4_RENDER_BLADE_CORE

• Configuration details can be found in Integration with Unreal Engine under Third Party Applications and Files in the Viz Artist User Guide.

Using DSX Core Licenses

DSX Core licenses can only be used on machines without Matrox hardware. Enabling DSX core on Matrox Topology driver based installations can lead into unintended behavior.

Permanent Licenses

Permanent Licenses need to have a end date set (typically 99 years). Any permanent license without an end-date is listed as "invalid date" and should be renewed by Vizrt. If this is the case, please contact Vizrt Support.

Setup Graphic Hub Journal-based E-Mail Notifications

• Configure e-mail sending in Graphic Hub Terminal Options E-Mail settings.

• Configure e-mail addresses and notification options for specific alerts in Graphic Hub Manager Alert settings.

• Viz Engine directly logs to the Journal of the connected Graphic Hub and triggers e-mail messages for the following alert levels:

  • Level 820: Viz Engine WARNING: License, Warnings reported by Viz Engine related to licensing. 

  • Level 920: Viz Engine ERROR: License, Errors reported by Viz Engine related to licensing.

Setup Redundancy for a WIBU License Server

Setting up WIBU license server redundancy is described below. See License Server Redundancy in the Vizrt Licensing Administrator Guide for additional details.

Set Up Redundancy for a WIBU License Server

1. Make sure two hosts (A & B) have VizrtLicensingInstaller.exe installed and select use as network license server during installation. See License Server Activation in the Vizrt Licensing Administrator Guide.

2. Connect one WIBU dongle to 'A' and import a key with licenses.

3. From WIBU web admin UI of 'A', make sure the container exist and all the added features are listed.

4. On the client configure 'A' as first license server, and 'B' as second one (in the search list of the local CodeMeter web admin).

Test License Server Failover

1. Set the license configuration in Viz Engine.

2. Start Viz Engine.

3. From CodeMeter web admin UI of 'A', verify that the licenses are allocated and used by the client.

4. Disconnect the network cable of 'A' or shut down the machine.

5. Wait until the Viz Engine(s) starts writing 'License Server not found..' and the grace status for the configured features is 'grace_state=2/VL_GRACE_GRACE, '.

6. Move the WIBU dongle from 'A' to 'B'.

7. Viz Engine recovers and re-obtains the license from 'B'.

Recover First License Server

1. Recover license server ‘A’.

2. Disconnected the failover license server from network or shut it down.

3. Waited until the Viz Engine(s) enter grace period.

4. Moved WIBU dongle back to the original license server ‘A’.

5. Viz Engine recovers and re-obtains the license from 'A'.

Notes

• The license must be in the same container to recover. A second license server with a different container does not work.

• Not started Viz Engines which are configured the same, can start and obtain the license from 'B'.

• An arbitrary number of servers can be added to the server search list of CodeMeter, even when Viz Engine is running. It is possible to add a failover server after the original license server failed.

See Also

• Vizrt Licensing Administrator Guide

• Graphic Hub Administrator Guide

• Third Party Applications and Files > Integration with Unreal Engine in the Viz Artist User Guide.