Home-Integration/dmx/DMX.pm

#!/usr/bin/perl
use strict;
use warnings;
use POSIX qw(strftime);
use File::Temp;
use IO::Select;
use IO::Socket::UNIX;

# Package name
package DMX;

# Debug
my $DEBUG = 0;
if ($ENV{'DEBUG'}) {
	$DEBUG = 1;
}

# Config
my $SOCK_TIMEOUT = 5;
my $MAX_CMD_LEN  = 2048;
my $TEMP_DIR     = `getconf DARWIN_USER_TEMP_DIR`;
chomp($TEMP_DIR);
my $DATA_DIR    = $TEMP_DIR . 'plexMonitor/';
my $DMX_SOCK    = 'DMX';
my $SUB_SOCK    = 'STATE';
my $SPEAK_SOCK  = undef();
my %CHANNEL_ADJ = (
	'13' => 1.00,
	'14' => 1.14,
	'15' => 1.19,
	'21' => 1.19,
	'22' => 1.23,
	'23' => 1.00,
);

# Sanity check
if (!-d $DATA_DIR) {
	die('Data directory not available: ' . $DATA_DIR . "\n");
}

# State
my $DMX_FH = undef();
my $SELECT = undef();

# Data directory
sub dataDir() {
	return $DATA_DIR;
}

# Maximum command length
sub maxCmdLen() {
	return $MAX_CMD_LEN;
}

# Generic client socket
sub clientSock($) {
	my ($path) = @_;
	$path = $DATA_DIR . $path . '.socket';
	my $sock = IO::Socket::UNIX->new(
		'Peer'    => $path,
		'Type'    => IO::Socket::UNIX::SOCK_DGRAM,
		'Timeout' => $SOCK_TIMEOUT,
	) or die('Unable to open client socket: ' . $path . ": ${@}\n");
	return $sock;
}

# Generic server socket
sub serverSock($) {
	my ($path) = @_;
	$path = $DATA_DIR . $path . '.socket';

	if (-e $path) {
		unlink($path);
	}

	my $sock = IO::Socket::UNIX->new(
		'Local' => $path,
		'Type'  => IO::Socket::UNIX::SOCK_DGRAM,
	) or die('Unable to open server socket: ' . $path . ": ${@}\n");
	return $sock;
}

# Select on a server socket
sub selectSock($) {
	my ($path) = @_;

	my $sock = serverSock($path);

	my $sel = IO::Select->new($sock)
	  or die('Unable to select socket: ' . $path . ": ${!}\n");
	return $sel;
}

# DMX socket init
sub dmxSock() {
	if (!defined($DMX_FH)) {
		$DMX_FH = clientSock($DMX_SOCK);
	}
	return $DMX_FH;
}

# Subscribe to state updates
sub stateSubscribe($) {
	my ($STATE_SOCK) = @_;

	my $sub_fh = clientSock($SUB_SOCK);
	$sub_fh->send($STATE_SOCK)
	  or die('Unable to subscribe: ' . $! . "\n");
	shutdown($sub_fh, 2);
	undef($sub_fh);
}

# Alias for selectSock() that also sets the global $SELECT pointer
sub stateSocket($) {
	my ($STATE_SOCK) = @_;
	$SELECT = selectSock($STATE_SOCK);
	return $SELECT;
}

# Parse the state->client comm string
sub parseState($$$) {
	my ($text, $exists, $mtime) = @_;
	my $cmdState = undef();
	if (!defined($exists)) {
		my %tmp = ();
		$exists = \%tmp;
	}
	if (!defined($mtime)) {
		my %tmp = ();
		$mtime = \%tmp;
	}

	# Parse the string
	%{$exists} = ();
	%{$mtime}  = ();
	my @lines = split("\n", $text);
	$cmdState = shift(@lines);
	if (!defined($cmdState)) {
		print STDERR 'State parse error: ' . $text . "\n";
		next;
	}
	if (scalar(@lines)) {
		foreach my $line (@lines) {
			my ($name, $value, $time) = $line =~ /(\w+)\|([^|]*)\|(\d*)/;
			if (!defined($name) || !defined($value) || !defined($time)) {
				print STDERR 'State parse error (exists): ' . $text . "\n";
				next;
			}
			$exists->{$name} = $value ? $value : 0;
			$mtime->{$name}  = $time  ? $time  : 0;
		}
	}
	if ($DEBUG) {
		my @exists_tmp = ();
		foreach my $key (sort(keys(%{$exists}))) {
			push(@exists_tmp,
				$key . ":\t" . $exists->{$key} . ' @ ' . POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime($mtime->{$key})));
		}
		print STDERR 'Got state: ' . $cmdState . "\n" . join("\n", @exists_tmp) . "\n";
	}

	# Translate INIT to OFF
	if ($cmdState eq 'INIT') {
		$cmdState = 'OFF';
	}

	# Return
	return $cmdState;
}

sub dim($) {
	my ($args) = @_;
	if (!defined($args->{'delay'})) {
		$args->{'delay'} = 0;
	}
	if (!defined($args->{'channel'}) || !defined($args->{'time'}) || !defined($args->{'value'})) {
		die('Invalid command for socket: ' . join(', ', keys(%{$args})) . ': ' . join(', ', values(%{$args})) . "\n");
	}

	# Silently skip invalid channels
	if ($args->{'channel'} < 0) {
		return;
	}

	# Adjust for the color curve (for channels where we have such data)
	my $value = $args->{'value'};
	if ($CHANNEL_ADJ{ $args->{'channel'} }) {
		$value *= $CHANNEL_ADJ{ $args->{'channel'} };
	}

	# 8-bit values
	$value = int($value);
	if ($value > 255) {
		$value = 255;
	} elsif ($value < 0) {
		$value = 0;
	}

	# We only deal in ints
	my $time  = int($args->{'time'});
	my $delay = int($args->{'delay'});

	my $cmd = join(':', $args->{'channel'}, $time, $value, $delay);

	dmxSock();
	$DMX_FH->send($cmd)
	  or die('Unable to write command to DMX socket: ' . $cmd . ": ${!}\n");
}

sub printDataset($) {
	my ($data_set) = @_;

	my $sum = 0;
	foreach my $data (@{$data_set}) {
		$sum += $data->{'value'};
		my $str = $data->{'channel'} . ' => ' . int($data->{'value'}) . ' @ ' . $data->{'time'};
		if ($data->{'delay'}) {
			$str .= ' (Delay: ' . $data->{'delay'} . ')';
		}
		print STDERR "\t" . $str . "\n";
	}
	print STDERR "\tTotal: " . int($sum) . "\n";
}

sub applyDataset($$$) {
	my ($data_set, $state, $file) = @_;
	if (!defined($state)) {
		$state = 'NULL';
	}

	# Debug
	if ($DEBUG) {
		print STDERR 'State: ' . $state . "\n";
		printDataset($data_set);
	}

	# Send the dim command
	my @values = ();
	foreach my $data (@{$data_set}) {
		dim($data);
		my $str = $data->{'channel'} . ' => ' . $data->{'value'} . ' @ ' . $data->{'time'};
		if ($data->{'delay'}) {
			$str .= ' (Delay: ' . $data->{'delay'} . ')';
		}
		push(@values, $str);
	}

	# Save the state and value to disk
	if (length($file)) {
		my ($fh, $tmp) = File::Temp::tempfile($file . '.XXXXXXXX', 'UNLINK' => 0);
		print $fh 'State: ' . $state . "\n" . join("\n", @values) . "\n";
		close($fh);
		rename($tmp, $file);
	}
}

sub readState($$$$) {
	my ($delay, $exists, $mtime, $valid) = @_;
	my $cmdState = undef();

	# Wait for state updates
	my @ready_clients = $SELECT->can_read($delay);
	foreach my $fh (@ready_clients) {

		# Ensure we won't block on recv()
		$fh->blocking(0);

		# Grab the inbound text
		while (defined($fh->recv(my $text, $MAX_CMD_LEN))) {

			# Save the old data, in case the new stuff is bad
			my %existsOld = ();
			my %mtimeOld  = ();
			if ($exists) {
				%existsOld = %{$exists};
			}
			if ($mtime) {
				%mtimeOld = %{$mtime};
			}

			# Parse the string
			my $state = parseState($text, $exists, $mtime);

			# Ignore invalid states
			if (defined($valid)) {
				if (!defined($valid->{$state})) {
					if ($DEBUG) {
						print STDERR 'Invalid state: ' . $state . "\n";
					}
					next;
				}
			}

			# Restore the old data, if the new stuff is bad
			if (scalar(keys(%{$exists})) < 1) {
				%{$exists} = ();
				%{$mtime}  = ();
				foreach my $key (keys(%existsOld)) {
					$exists->{$key} = $existsOld{$key};
				}
				foreach my $key (keys(%mtimeOld)) {
					$mtime->{$key} = $mtimeOld{$key};
				}
			}

			# Propogate valid states
			if ($state) {
				$cmdState = $state;
			}
		}
	}

	# Return the final valid state
	return $cmdState;
}

# Speak
sub say($) {
	my ($str) = @_;
	if ($DEBUG) {
		print STDERR 'Say: ' . $str . "\n";
	}

	if (!$SPEAK_SOCK) {
		$SPEAK_SOCK = DMX::clientSock('SPEAK');
	}

	$SPEAK_SOCK->send($str)
	  or die('Unable to write command to socket: SPEAK: ' . $str . ": ${!}\n");
}

# Allow programatic debug control
sub debug($) {
	($DEBUG) = @_;
}

# Always return true
1;