Hog 4 Connection


Introduction

The hog 4 family connection logs playback actions by a Hog 4 family console creating hog stamps whenever an OSC address pattern prefixed with /hog/playback/ is received. A hog 4 connection utilises the OSC API provided by High End Systems and requires to a varying degree setup at the console for messages to be successfully sent to Stamp. Whilst working with a hog 4 family connection we recommend you also refer to HES's Hog 4 OS User Manual, specifically the Open Sound Control (OSC) section.

When a hog 4 family connection receives a playback message from a hog 4 family console it will create a hog stamp assigning the cue list, cue number, scene or macro values accordingly.


Which Connection Protocol?

Before getting started, be sure to understand which connection protocol (TCP or UDP) you aim to use.

TL;DR: TCP is slower but reliable, UDP is faster but unreliable. Realistically in a small, closed and stable network typical for a live production, speed is negligible so we would recommend using TCP for the key points that it is both quicker and easier to set up. Feel free to read this blog post written by our founder for a more in depth look at the differences.


TCP

OSC Versions

When using OSC via TCP it is important to distinguish that there are two versions of the OSC protocol in circulation. TCP is a stream of data and so there is a requirement when parsing OSC data to understand the end of one packet or "message" and the beginning of the next. This is done by packet framing. In OSC 1.0 a packet length header is used to determine the length of each packet where as in 1.1 the more robust double END SLIP (RFC 1055) protocol is used that uses a special character to identify the end of a packet.

Ultimately both stamp and hog 4 consoles can work with both versions but a distinction needs to be made by you as to which version you want to use and should be set accordingly in both the settings of the hog 4 console and the hog 4 connection within stamp.

Hog 4 Settings

  1. From the Network Window navigate your way through Settings to the Open Sound Control pane and enable both OSC In and OSC Out.

  2. Set the Output IP address to the IP address of the mac running Stamp with a port number of your choice e.g 7001.

  3. Set the Protocol to the TCP framing of your desired OSC version.

Stamp Settings

  1. Input the IP address of the hog 4 console.

  2. Input the port number you set on your hog 4 console as the port for the connection.

  3. Select the same OSC version as the one being used by the hog 4 console.

  4. Check Connect via TCP

  5. Click Save


UDP

Hog 4 Settings

  1. From the Network Window navigate your way through Settings to the Open Sound Control pane and enable both OSC In and OSC Out.

  2. A transmit and receive port number should be chosen e.g. 7001 and 7002, then input into the input port and output port fields respectively.

  3. Input the IP address for the mac running Stamp into the output IP address field.

  4. Set the Protocol to UDP.

Stamp Settings

  1. Input the IP address of the hog 4 console.

  2. Uncheck Connect via TCP

  3. Input the input port you set on your hog 4 console as the transmit port for the connection.

  4. Input the output port you set on your hog 4 console as the receive port for the connection.

  5. Click Save

Note: Make sure to swap the transmit/output and receive/input port numbers between the hog 4 console and the connection in Stamp. It is a common mistake to have the port numbers for both transmit and receive as the same.

Cue Lists

A hog 4 family connection can either listen and log cues fired from all cue lists or a selection. The input for multiple lists should be separated by a comma. For example, to listen and log cues that are from cue lists 1, 2 and 999:

1,2,999