Why Do We Need to Configure the Licenses?

• Avoid license stealing 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 OUT from the combination feature).

• A license may enable multiple internal application features.

Configuring the License System in the Viz Engine Configuration UI

See Viz License Configuration.

Monitor the License System in the Viz Engine Configuration UI

See Viz License Information.

Configuration Entries in the Viz Engine Configuration File

• Legacy_Licensing: Determines which license system should be used.

  • Set this to 1 to use the VALID/Sentinel/Hardlock license system and 0 to use the WIBU license system.

  • Default: When configuration exists on startup: 1, and when not 0.

• License_Location: WIBU license source. Determines where WIBU should search for license containers.

  • Can be set to one of the following values:

    • VL_L_LOCAL - Local license. Searches exclusively for licenses located on the same PC or allocated to the same VM (e.g. dongle, file).

    • VL_L_NETWORK - Network license. License is to be sought in the network (LAN, WAN), i.e.CodeMeter License Server activated as network server or CmWAN.

  • Only used when license system is WIBU.

  • Default: VL_L_NETWORK

• 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

• ART_ARTIST_FREE - Artist Free

• and for OEM

  • 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.

    Note: When a license is configured it is consumed, even when it has no effect. If licenses are configured that are not allowed, an error occurs on startup.

  • WIBU additional licenses for core license ENG_ENG_CORE:

    • Combination Feature (only one can be configured at a time):

      • ENG_CF(APP_DVI) - Combination Feature DVI

      • ENG_CF(APP_NDI) - Combination Feature NDI

      • ENG_CF(APP_MEZZ_IP) - Combination Feature MEZZ_IP

      • ENG_CF(APP_MUX_PORTS) - Combination Feature Frameserver

    • ENG_ARTIST - Artist

    • ENG_ING_SDIIP_MAX - SDI/IP Video Input Enablement (max)

    • ENG_IN_NDI_MAX - NDI IN Upgrade (max)

    • ENG_IN_MEZZIP_MAX - MezzIP IN Upgrade (max)

    • ENG_OUT_SDIIP - SDI/IP OUT Channel

    • ENG_OUT_NDI - NDI OUT Channel

    • ENG_OUT_MEZZIP_MAX - MezzIP OUT Upgrade (max)

    • ENG_ING_4KVIDEO - 4K Video Enablement

    • ENG_OUT_DVI_MAX - DVI OUT Max Resolution

    • ENG_OUT_FS_MAX - Multiple Frameservers (max)

    • ENG_PLUG_CHROMAFX - Chroma FX

    • ENG_PLUG_GI - Global Illumination FX

    • ENG_PLUG_MULTITOUCH - Vizrt Multi-touch Plug-in Package

    • ENG_PLUG_MOCAPREAD - Bone&Skin Live Motion Capture

    • ENG_PLROY_CINEMA4D - Cinema 4D Import

    • ENG_PLROY_DOLBYDEC - Dolby E Decoder License

    • ENG_PLROY_DOLBYENC - Dolby E Encoder License

    • ENG_PLROY_DNXHD - Viz Engine DNxHD Codec Support

    • ENG_PLROY_RTTFX - RTT Shaders FX

    • ENG_PLROY_SUBSAUTH - Substance FX Authoring

    • ENG_PLROY_EZGALLERY - ezGallery

    • ENG_PLROY_EZPOSTFX - ezPostFx

    • ENG_PLROY_EZSHADERS - ezShaders

    • ENG_PLROY_EZMESH - ezMesh

    • ENG_PLROY_EZDEFORM - ezDeform

    • ENG_PLROY_EZCOMPOSER - ezComposer

    • ENG_PLROY_EZLOGIC - ezLogic

    • ENG_PLROY_EZLINK - ezLink

    • ENG_PLROY_EZTUBULAR - ezTubular

    • ENG_PLROY_EZJSPRO - ezJavascript (Pro)

    • ENG_PLROY_DORNA_MTAP - DornaMT APP

    • ENG_PLROY_DORNA_MTPL - DornaMT Plug-in

  • WIBU additional licenses for core license ENG_PRV_CORE:

    • ENG_PRV_ARTIST - Artist Preview

    • ENG_PLROY_CINEMA4D - Cinema 4D Import

    • ENG_PLROY_DOLBYDEC - Dolby E Decoder License

    • ENG_PLROY_DOLBYENC - Dolby E Encoder License

    • ENG_PLROY_DNXHD - Viz Engine DNxHD Codec Support

    • ENG_PLROY_RTTFX - RTT Shaders FX

    • ENG_PLROY_SUBSAUTH - Substance FX Authoring

    • ENG_PLROY_EZGALLERY - ezGallery

    • ENG_PLROY_EZPOSTFX - ezPostFx

    • ENG_PLROY_EZSHADERS - ezShaders

    • ENG_PLROY_EZMESH - ezMesh

    • ENG_PLROY_EZDEFORM - ezDeform

    • ENG_PLROY_EZCOMPOSER - ezComposer

    • ENG_PLROY_EZLOGIC - ezLogic

    • ENG_PLROY_EZLINK - ezLink

    • ENG_PLROY_EZTUBULAR - ezTubular

    • ENG_PLROY_EZJSPRO - ezJavascript (Pro)

    • ENG_PLROY_DORNA_MTAP - DornaMT APP

    • ENG_PLROY_DORNA_MTPL - DornaMT Plug-in

  • WIBU additional licenses for core license ART_ARTIST_FREE: NONE

  • WIBU additional licenses for core license VIZLIB_LIBERO_CORE: NONE

  • WIBU additional licenses for core license VIZARE_VIZARENA_CORE: NONE

  • WIBU additional licenses for core license VIZECL_VIZECLIPSE_CORE: NONE

Introduction

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.

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 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 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(APP_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 (e.g. 2K width/height).

• DVI OUT is required for local preview in external applications (e.g. 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 input/putput is limited to <=2K width/height.

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

  • OUT: ENG_CF(APP_MEZZ_IP) OR ENG_OUT_MEZZIP_MAX

  • IN: ENG_IN_MEZZIP_MAX

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

• ENG_CF is limited when ServiceHost WebRTC is used. This happens because the license is consumed by the ServiceHost and cannot be consumed anymore by the Viz Engine, because of the exclusive license share status. The ENG_CF is consumed together with ENG_SVCHOST_COR .

• In short:

  • When RTP/UDP IN/OUT (2K) is used then the ENG_CF on the Engine is sufficient.

  • When WebRTC OUT (2K) is enabled through the ENG_CF on the ServiceHost then ENG_IN_MEZZIP_MAX is required on the Engine for MezzIP IN (2K).

  • When MezzIP IN (2K) is enabled through the ENG_CF on the Engine then ENG_OUT_MEZZIP_MAX is required on the ServiceHost for MezzIP OUT (2K) with WebRTC.

Starting Viz Engine with Frameserver Functionality (MUX Ports)

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

  • ENG_CF(APP_MUX_PORTS) 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 framesever snapshots of up to <=4K width/height.

  • ENG_OUT_DVI_MAX for unlimited resolution frameserver snapshots.

    Note: The Multiplexer Ports are only opened if a default renderer is active. Therefore, please make sure create_default_renderer = 1 is set in the config file.

    Note:The preview port (typically 50010) is not part of the Multiplexer ports. It is not restricted by any license.

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

• When running 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 Artist

• When running Engine with 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 Transition License - WIBU License Bound to VALID/Sentinel Dongle ID

• Transition license has a special flag in the core license and is bound to the old VALID/Sentinel dongle ID.

• This license is node bound. It should not be added to an license server, else it cannot be distinguished from other licenses and may be allocated at the wrong node or instance.

• The dongle ID in the WIBU license must match to the dongle ID of the VALID/Sentinel dongle to enable the WIBU license and to start Viz Engine.

• Only WIBU licenses are used. Features on the old VALID/Sentinel dongle are completely ignored.

• When VALID/Sentinel dongle is unplugged or expires then WIBU license expires too.

• Plug-ins that query the VALID/Sentinel ID get a Zero-ID, since WIBU is used.

Steps to Setup Redundancy for a WIBU License Server

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

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

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

• 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

• Set the license configuration in the Engine.

• Start the engine.

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

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

• Wait until the Engines starts writing 'License Server not found..' and the grace status for the configured features is 'grace_state=2/VL_GRACE_GRACE, '.

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

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

Recover First License Server

• Recover license server ‘A’.

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

• Waited until Engines enter grace period.

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

• 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 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 the Engine is running. It is possible to add a failover server after the original license server failed.

See Also

• Vizrt Licensing Administrator Guide