thomas/-Tally_light_blackmagic_WeMos
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Start

Browse Source 
Start
This commit is contained in:
Thomas
2022-01-24 19:59:50 +01:00
parent 6a0fd3c076
commit b9a3a5d2b6
15 changed files with 6681 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

116
AtemTail_v2/AtemTail_v2.ino Normal file
View File

@@ -0,0 +1,116 @@
/*****************
Tally light ESP32 for Blackmagic ATEM switcher
Version 2.0
A wireless (WiFi) tally light for Blackmagic Design
ATEM video switchers, based on the M5StickC ESP32 development
board and the Arduino IDE.
For more information, see:
https://oneguyoneblog.com/2020/06/13/tally-light-esp32-for-blackmagic-atem-switcher/
Based on the work of Kasper Skårhøj:
https://github.com/kasperskaarhoj/SKAARHOJ-Open-Engineering
******************/
#include <ESP8266WiFi.h>
#include <SkaarhojPgmspace.h>
#include <ATEMbase.h>
#include <ATEMstd.h>
IPAddress switcherIp(192, 168, 0, 101); // IP address of the ATEM switcher
ATEMstd AtemSwitcher;
// WiFi parameters
#define WLAN_SSID "atem"
#define WLAN_PASS "tuxiatem"
String newHostname = "CamTally_4";
// LED PIN DEFINE
#define LED_BUILTIN D4
#define ledPin1 D1
#define ledPin2 D2
int cameraNumber = 4;
//int LED_BUILTIN = 2;
//int ledPin1 = 4;
//int ledPin2 = 5;
int PreviewTallyPrevious = 1;
int ProgramTallyPrevious = 1;
void setup() {
Serial.begin(9600);
WiFi.mode(WIFI_STA);
pinMode(ledPin1, OUTPUT); // LED: 1 is on Program (Tally)
pinMode(ledPin2, OUTPUT); // LED: 2 is on Preview (Tally)
pinMode(LED_BUILTIN, OUTPUT); // LED: Status online
Serial.println(); Serial.println(); // Connect to WiFi access point.
delay(10);
Serial.print(F("Connecting to "));
Serial.println(WLAN_SSID);
WiFi.hostname(newHostname.c_str()); //Set new hostname
Serial.printf("New hostname: %s\n", WiFi.hostname().c_str()); //Get Current Hostname
WiFi.begin(WLAN_SSID, WLAN_PASS);
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.print(F("."));
}
Serial.println();
Serial.println(F("WiFi connected"));
Serial.print(F("IP address: "));
Serial.println(WiFi.localIP());
Serial.print("RRSI: ");
Serial.println(WiFi.RSSI());
digitalWrite(LED_BUILTIN, LOW); // ON
digitalWrite(ledPin1, HIGH); // off
digitalWrite(ledPin2, HIGH); // off
// Initialize a connection to the switcher:
AtemSwitcher.begin(switcherIp);
AtemSwitcher.serialOutput(0x80);
AtemSwitcher.connect();
}
void loop() {
// Check for packets, respond to them etc. Keeping the connection alive!
AtemSwitcher.runLoop();
int ProgramTally = AtemSwitcher.getProgramTally(cameraNumber);
int PreviewTally = AtemSwitcher.getPreviewTally(cameraNumber);
if ((ProgramTallyPrevious != ProgramTally) || (PreviewTallyPrevious != PreviewTally)) { // changed?
if ((ProgramTally && !PreviewTally) || (ProgramTally && PreviewTally) ) { // only program, or program AND preview
digitalWrite(ledPin1, HIGH);
digitalWrite(ledPin2, LOW);
} else if (PreviewTally && !ProgramTally) { // only preview
digitalWrite(ledPin2, LOW);
} else if (!PreviewTally || !ProgramTally) { // neither
digitalWrite(ledPin1, LOW);
digitalWrite(ledPin2, HIGH);
}
}
ProgramTallyPrevious = ProgramTally;
PreviewTallyPrevious = PreviewTally;
}
void drawLabel(unsigned long int screenColor, unsigned long int labelColor, bool ledValue) {
digitalWrite(ledPin1, ledValue);
digitalWrite(ledPin2, ledValue);
}

19
README.md
View File

@@ -1,2 +1,19 @@
# Tally_light_blackmagic_WeMos
Orginal Thingiverse: <br>
https://www.thingiverse.com/thing:4738103
<br>
Remake Thingiverse: <br>
https://
<br>
I have made a convertion from ESP32 to WeMos D1. <br>
I´m stile working on the code, but for now it´s working. <br>
#You will need:
1 WeMos D1 <br>
1 Red led 5mm <br>
1 Green led 5mm <br>
2 200Ohm resister <br>
#Schematic

926
libraries/ATEMbase/ATEMbase.cpp Normal file
View File

@@ -0,0 +1,926 @@
/*
Copyright 2012-2014 Kasper Skårhøj, SKAARHOJ K/S, kasper@skaarhoj.com
This file is part of the Blackmagic Design ATEM Client library for Arduino
The ATEM library is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.
The ATEM library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with the ATEM library. If not, see http://www.gnu.org/licenses/.
IMPORTANT: If you want to use this library in your own projects and/or products,
please play a fair game and heed the license rules! See our web page for a Q&A so
you can keep a clear conscience: http://skaarhoj.com/about/licenses/
*/
#include "ATEMbase.h"
/**
* Constructor
*/
ATEMbase::ATEMbase(){}
/**
* Setting up IP address for the switcher (and local port to send packets from)
* Using local port here is deprecated. Rather let the library pick a random one
*/
void ATEMbase::begin(const IPAddress ip){
begin(ip, random(50100,65300));
}
void ATEMbase::begin(const IPAddress ip, const uint16_t localPort){
neverConnected = true;
waitingForIncoming = false;
// Set up Udp communication object:
#ifdef ESP8266
WiFiUDP Udp;
#else
EthernetUDP Udp;
#endif
_Udp = Udp;
_switcherIP = ip; // Set switcher IP address
_localPort = localPort; // Set default local port
_lastContact = 0;
_serialOutput = 0;
resetCommandBundle();
}
/**
* Initiating connection handshake to the ATEM switcher
*/
void ATEMbase::connect() {
connect(false);
}
/**
* Initiating connection handshake to the ATEM switcher
* If useFixedPortNumber is true, the same port number will be used on subsequent connects, otherwise - and recommended - a new, random port number is used.
*/
void ATEMbase::connect(const boolean useFixedPortNumber) {
_localPacketIdCounter = 0; // Init localPacketIDCounter to 0;
_initPayloadSent = false; // Will be true after initial payload of data is delivered (regular 12-byte ping packages are transmitted.)
_hasInitialized = false; // Will be true after initial payload of data is resent and received well
_isConnected = false; // Will be true after the initial hello-package handshakes.
_sessionID = 0x53AB; // Temporary session ID - a new will be given back from ATEM.
_lastContact = millis(); // Setting this, because even though we haven't had contact, it constitutes an attempt that should be responded to at least
memset(_missedInitializationPackages, 0xFF, (ATEM_maxInitPackageCount+7)/8);
_initPayloadSentAtPacketId = ATEM_maxInitPackageCount; // The max value it can be
uint16_t portNumber = useFixedPortNumber ? _localPort : random(50100,65300);
_Udp.begin(portNumber);
// Send connectString to ATEM:
if (_serialOutput) {
Serial.print(F("Sending connect packet to ATEM switcher on IP "));
Serial.print(_switcherIP);
Serial.print(F(" from port "));
Serial.println(portNumber);
}
_wipeCleanPacketBuffer();
_createCommandHeader(ATEM_headerCmd_HelloPacket, 12+8);
_packetBuffer[12] = 0x01; // This seems to be what the client should send upon first request.
_packetBuffer[9] = 0x3a; // This seems to be what the client should send upon first request.
_sendPacketBuffer(20);
}
/**
* Keeps connection to the switcher alive
* Therefore: Call this in the Arduino loop() function and make sure it gets call at least 2 times a second
* Other recommendations might come up in the future.
*/
void ATEMbase::runLoop() {
runLoop(0);
}
void ATEMbase::runLoop(uint16_t delayTime) {
if (neverConnected) {
neverConnected = false;
connect();
// Serial.println("Connecting first time...");
}
unsigned long enterTime = millis();
do {
while(true) { // Iterate until UDP buffer is empty
uint16_t packetSize = _Udp.parsePacket();
if (_Udp.available()) {
_Udp.read(_packetBuffer,12); // Read header
_sessionID = word(_packetBuffer[2], _packetBuffer[3]);
uint8_t headerBitmask = _packetBuffer[0]>>3;
_lastRemotePacketID = word(_packetBuffer[10],_packetBuffer[11]);
if (_lastRemotePacketID < ATEM_maxInitPackageCount) {
_missedInitializationPackages[_lastRemotePacketID>>3] &= ~(B1<<(_lastRemotePacketID&0x07));
}
uint16_t packetLength = word(_packetBuffer[0] & B00000111, _packetBuffer[1]);
if (packetSize==packetLength) { // Just to make sure these are equal, they should be!
_lastContact = millis();
waitingForIncoming = false;
if (headerBitmask & ATEM_headerCmd_HelloPacket) { // Respond to "Hello" packages:
_isConnected = true;
// _packetBuffer[12] The ATEM will return a "2" in this return package of same length. If the ATEM returns "3" it means "fully booked" (no more clients can connect) and a "4" seems to be a kind of reconnect (seen when you drop the connection and the ATEM desperately tries to figure out what happened...)
// _packetBuffer[15] This number seems to increment with about 3 each time a new client tries to connect to ATEM. It may be used to judge how many client connections has been made during the up-time of the switcher?
_wipeCleanPacketBuffer();
_createCommandHeader(ATEM_headerCmd_Ack, 12);
_packetBuffer[9] = 0x03; // This seems to be what the client should send upon first request.
_sendPacketBuffer(12);
}
// If a packet is 12 bytes long it indicates that all the initial information
// has been delivered from the ATEM and we can begin to answer back on every request
// Currently we don't know any other way to decide if an answer should be sent back...
// The QT lib uses the "InCm" command to indicate this, but in the latest version of the firmware (2.14)
// all the camera control information comes AFTER this command, so it's not a clear ending token anymore.
// However, I'm not sure if I checked the _lastRemotePacketID of the packages with the additional camera control info - if it was a resend,
// "InCm" may still indicate the number of the last init-package and that's all I need to request the missing ones....
// BTW: It has been observed on an old 10Mbit hub that packages could arrive in a different order than sent and this may
// mess things up a bit on the initialization. So it's recommended to has as direct routes as possible.
if(!_initPayloadSent && packetSize == 12 && _lastRemotePacketID>1) {
_initPayloadSent = true;
_initPayloadSentAtPacketId = _lastRemotePacketID;
#if ATEM_debug
if (_serialOutput & 0x80) {
Serial.print(F("_initPayloadSent=TRUE @rpID "));
Serial.println(_initPayloadSentAtPacketId);
Serial.print(F("Session ID: "));
Serial.println(_sessionID, DEC);
}
#endif
}
if (_initPayloadSent && (headerBitmask & ATEM_headerCmd_AckRequest) && (_hasInitialized || !(headerBitmask & ATEM_headerCmd_Resend))) { // Respond to request for acknowledge (and to resends also, whatever...
_wipeCleanPacketBuffer();
_createCommandHeader(ATEM_headerCmd_Ack, 12, _lastRemotePacketID);
_sendPacketBuffer(12);
#if ATEM_debug
if (_serialOutput & 0x80) {
Serial.print(F("rpID: "));
Serial.print(_lastRemotePacketID, DEC);
Serial.print(F(", Head: 0x"));
Serial.print(headerBitmask, HEX);
Serial.print(F(", Len: "));
Serial.print(packetLength, DEC);
Serial.print(F(" bytes"));
Serial.println(F(" - ACK!"));
} else
#endif
if (_serialOutput>1) {
Serial.print(F("rpID: "));
Serial.print(_lastRemotePacketID, DEC);
Serial.println(F(" - ACK!"));
}
} else if(_initPayloadSent && (headerBitmask & ATEM_headerCmd_RequestNextAfter) && _hasInitialized) { // ATEM is requesting a previously sent package which must have dropped out of the order. We return an empty one so the ATEM doesnt' crash (which some models will, if it doesn't get an answer before another 63 commands gets sent from the controller.)
uint8_t b1 = _packetBuffer[6];
uint8_t b2 = _packetBuffer[7];
_wipeCleanPacketBuffer();
_createCommandHeader(ATEM_headerCmd_Ack, 12, 0);
_packetBuffer[0] = ATEM_headerCmd_AckRequest << 3; // Overruling this. A small trick because createCommandHeader shouldn't increment local package ID counter
_packetBuffer[10] = b1;
_packetBuffer[11] = b2;
_sendPacketBuffer(12);
if (_serialOutput>1) {
Serial.print(F("ATEM asking to resend "));
Serial.println((b1<<8)|b2, DEC);
}
} else {
#if ATEM_debug
if (_serialOutput & 0x80) {
Serial.print(F("rpID: "));
Serial.print(_lastRemotePacketID, DEC);
Serial.print(F(", Head: 0x"));
Serial.print(headerBitmask, HEX);
Serial.print(F(", Len: "));
Serial.print(packetLength, DEC);
Serial.println(F(" bytes"));
} else
#endif
if (_serialOutput>1) {
Serial.print(F("rpID: "));
Serial.println(_lastRemotePacketID, DEC);
}
}
if (!(headerBitmask & ATEM_headerCmd_HelloPacket) && packetLength>12) {
_parsePacket(packetLength);
}
} else {
#if ATEM_debug
if (_serialOutput & 0x80) {
Serial.print(F("ERROR: Packet size mismatch: "));
Serial.print(packetSize, DEC);
Serial.print(F(" != "));
Serial.println(packetLength, DEC);
}
#endif
// Flushing:
while(_Udp.available()) {
_Udp.read(_packetBuffer, ATEM_packetBufferLength);
}
}
} else break;
}
// After initialization, we check which packages were missed and ask for them:
if (!_hasInitialized && _initPayloadSent && !waitingForIncoming) {
for(uint8_t i=1; i<_initPayloadSentAtPacketId; i++) {
if(i <= ATEM_maxInitPackageCount) {
if (_missedInitializationPackages[i>>3] & (B1<<(i & 0x7))) {
#if ATEM_debug
if (_serialOutput & 0x80) {
Serial.print(F("Asking for package "));
Serial.println(i, DEC);
}
#endif
_wipeCleanPacketBuffer();
_createCommandHeader(ATEM_headerCmd_RequestNextAfter, 12);
_packetBuffer[6] = highByte(i-1); // Resend Packet ID, MSB
_packetBuffer[7] = lowByte(i-1); // Resend Packet ID, LSB
_packetBuffer[8] = 0x01;
_sendPacketBuffer(12);
waitingForIncoming = true;
break;
}
} else {
break;
}
}
if (!waitingForIncoming) {
_hasInitialized = true;
if (_serialOutput) {
Serial.println(F("ATEM _hasInitialized = TRUE"));
}
}
}
} while (delayTime>0 && !hasTimedOut(enterTime,delayTime));
// If connection is gone anyway, try to reconnect:
if (hasTimedOut(_lastContact, 5000)) {
if (_serialOutput) Serial.println(F("Connection to ATEM Switcher has timed out - reconnecting!"));
connect();
}
}
/**
* Returns last Remote Packet ID
*/
uint16_t ATEMbase::getATEM_lastRemotePacketId() {
return _lastRemotePacketID;
}
/**
* Get ATEM session ID
*/
uint16_t ATEMbase::getSessionID() {
return _sessionID;
}
/**
* If true, we had a response from the switcher when trying to send a hello packet.
*/
bool ATEMbase::isConnected() {
return _isConnected;
}
/**
* If true, the initial handshake and "stressful" information exchange has occured and now the switcher connection should be ready for operation.
*/
bool ATEMbase::hasInitialized() {
return _hasInitialized;
}
/**************
*
* Buffer work
*
**************/
void ATEMbase::_createCommandHeader(const uint8_t headerCmd, const uint16_t lengthOfData) {
_createCommandHeader(headerCmd, lengthOfData, 0);
}
void ATEMbase::_createCommandHeader(const uint8_t headerCmd, const uint16_t lengthOfData, const uint16_t remotePacketID) {
_packetBuffer[0] = (headerCmd << 3) | (highByte(lengthOfData) & 0x07); // Command bits + length MSB
_packetBuffer[1] = lowByte(lengthOfData); // length LSB
_packetBuffer[2] = highByte(_sessionID); // Session ID
_packetBuffer[3] = lowByte(_sessionID); // Session ID
_packetBuffer[4] = highByte(remotePacketID); // Remote Packet ID, MSB
_packetBuffer[5] = lowByte(remotePacketID); // Remote Packet ID, LSB
if(!(headerCmd & (ATEM_headerCmd_HelloPacket | ATEM_headerCmd_Ack | ATEM_headerCmd_RequestNextAfter))) {
_localPacketIdCounter++;
// if ((_localPacketIdCounter & 0xF) == 0xF) _localPacketIdCounter++; // Uncommenting this line will jump the local package ID counter every 15 command - thereby introducing a stress test of the robustness of the "resent package" function from the ATEM switcher.
_packetBuffer[10] = highByte(_localPacketIdCounter); // Local Packet ID, MSB
_packetBuffer[11] = lowByte(_localPacketIdCounter); // Local Packet ID, LSB
}
}
void ATEMbase::_sendPacketBuffer(uint8_t length) {
_Udp.beginPacket(_switcherIP, 9910);
_Udp.write(_packetBuffer,length);
_Udp.endPacket(); // TODO: Figure out why this may hang!!
}
/**
* Sets all zeros in packet buffer:
*/
void ATEMbase::_wipeCleanPacketBuffer() {
memset(_packetBuffer, 0, ATEM_packetBufferLength);
}
/**
* Reads from UDP channel to buffer. Will fill the buffer to the max or to the size of the current segment being parsed
* Returns false if there are no more bytes, otherwise true
*/
bool ATEMbase::_readToPacketBuffer() {
return _readToPacketBuffer(ATEM_packetBufferLength);
}
bool ATEMbase::_readToPacketBuffer(uint8_t maxBytes) {
maxBytes = maxBytes<=ATEM_packetBufferLength ? maxBytes : ATEM_packetBufferLength;
int remainingBytes = _cmdLength-8-_cmdPointer;
if (remainingBytes>0) {
if (remainingBytes <= maxBytes) {
_Udp.read(_packetBuffer, remainingBytes);
_cmdPointer+= remainingBytes;
return false; // Returns false if finished.
} else {
_Udp.read(_packetBuffer, maxBytes);
_cmdPointer+= maxBytes;
return true; // Returns true if there are still bytes to be read.
}
} else {
return false;
}
}
/**
* If a package longer than a normal acknowledgement is received from the ATEM Switcher we must read through the contents.
* Usually such a package contains updated state information about the mixer
* Selected information is extracted in this function and transferred to internal variables in this library.
*/
void ATEMbase::_parsePacket(uint16_t packetLength) {
// If packet is more than an ACK packet (= if its longer than 12 bytes header), lets parse it:
uint16_t indexPointer = 12; // 12 bytes has already been read from the packet...
while (indexPointer < packetLength) {
// Read the length of segment (first word):
_Udp.read(_packetBuffer, 8);
_cmdLength = word(_packetBuffer[0], _packetBuffer[1]);
_cmdPointer = 0;
// Get the "command string", basically this is the 4 char variable name in the ATEM memory holding the various state values of the system:
char cmdStr[] = {
_packetBuffer[4], _packetBuffer[5], _packetBuffer[6], _packetBuffer[7], '\0'};
// If length of segment larger than 8 (should always be...!)
if (_cmdLength>8) {
_parseGetCommands(cmdStr);
while (_readToPacketBuffer()) {} // Empty, if not done yet.
indexPointer+=_cmdLength;
} else {
indexPointer = 2000;
#if ATEM_debug
if (_serialOutput & 0x80) Serial.println(F("Bad CMD length, flushing..."));
#endif
// Flushing the buffer:
while(_Udp.available()) {
_Udp.read(_packetBuffer, ATEM_packetBufferLength);
}
}
}
}
/**
* This method should be overloaded in subclasses in order to handle specific get-commands
*/
void ATEMbase::_parseGetCommands(const char *cmdString) {
// uint8_t mE, keyer, mediaPlayer, aUXChannel, windowIndex, multiViewer, memory, colorGenerator, box;
// uint16_t audioSource, videoSource;
// long temp;
uint8_t numberOfReads=1;
while(_readToPacketBuffer()) {
numberOfReads++;
}
#if ATEM_debug
if (_serialOutput & 0x80) {
Serial.print(cmdString);
Serial.print(", len: ");
Serial.print(_cmdLength);
Serial.print(", rds: ");
Serial.println(numberOfReads);
}
#endif
}
void ATEMbase::_prepareCommandPacket(const char *cmdString, uint8_t cmdBytes, bool indexMatch) {
// First, in case of a command bundle, check if indexes are different OR if it's an entirely different command, then increase offset to accommodate new command:
if (_cBundle) {
if (_returnPacketLength>0 && (!indexMatch || strncmp_P((char *)(_packetBuffer+12+_cBBO+4), cmdString, 4))) {
_cBBO = _returnPacketLength-12;
}
} else {
_wipeCleanPacketBuffer(); // For command bundles, this is already done...
}
_returnPacketLength = 12+_cBBO+(4+4+cmdBytes);
// Because we increased length of command, we need to check for buffer overflow:
if (_returnPacketLength > ATEM_packetBufferLength) {
Serial.println(F("FATAL ERROR: Packet Buffer Overflow in the ATEM Library! Too long or too many commands bundled!\n HALT"));
while(true){} // STOP!
}
// Copy Command String:
if (strlen_P(cmdString)==4) {
strncpy_P((char *)(_packetBuffer+12+_cBBO+4), cmdString, 4);
}
#if ATEM_debug
else Serial.println(F("Command Length > 4 ERROR"));
#endif
// Command length:
_packetBuffer[12+_cBBO] = 0; // MSB - but it's always under 256, so....
_packetBuffer[12+1+_cBBO] = 4+4+cmdBytes; // LSB
}
void ATEMbase::_finishCommandPacket() {
if (!_cBundle) {
_createCommandHeader(ATEM_headerCmd_AckRequest, _returnPacketLength);
_sendPacketBuffer(_returnPacketLength);
_returnPacketLength = 0;
} else {
// Debugging info:
/* for(uint8_t a=0; a<_returnPacketLength; a++) {
if (_packetBuffer[a]<16) Serial.print("0");
Serial.print(_packetBuffer[a], HEX);
Serial.print(F("-"));
}
Serial.println();
*/
}
}
/**************
*
* Utilities from SkaarhojTools class:
*
**************/
/**
* Setter method: If _serialOutput is set, the library may use Serial.print() to give away information about its operation - mostly for debugging.
* 0= no output
* 1= normal output (info)
* 2= verbose
* &0x80 (bit 7 set): verbose initial connection information
*/
void ATEMbase::serialOutput(uint8_t level) {
_serialOutput = level;
}
/**
* Timeout check
*/
bool ATEMbase::hasTimedOut(unsigned long time, unsigned long timeout) {
if ((unsigned long)(time + timeout) <= (unsigned long)millis()) { // This should "wrap around" if time+timout is larger than the size of unsigned-longs, right?
return true;
}
else {
return false;
}
}
uint8_t ATEMbase::getATEMmodel() {
return _ATEMmodel;
}
float ATEMbase::audioWord2Db(uint16_t input) { // -48 to +6 output
// Formular: log10(input/128)*20-48;
if (input<=32) return -60;
//return (log10(input)-2.1072099696)*20-48;
// Better way?
//return log10(input >> 5) * 20.0 - 60.0;
return log10((float)input/(1<<11) / 16.0) * 20.0;
}
uint16_t ATEMbase::audioDb2Word(float input) { // -48 to +6 input
//return (float)pow(10,(input+48)/20)*128;
//return (uint16_t)pow(10, (input + 60.0) / 20.0) << 5;
return pow(10, input/20.0) * 16.0 * (1<<11);
}
uint8_t ATEMbase::getVideoSrcIndex(uint16_t videoSrc) {
switch(videoSrc){
case 0: // Black
return 0;
case 1: // Input 1
return 1;
case 2: // Input 2
return 2;
case 3: // Input 3
return 3;
case 4: // Input 4
return 4;
case 5: // Input 5
return 5;
case 6: // Input 6
return 6;
case 7: // Input 7
return 7;
case 8: // Input 8
return 8;
case 9: // Input 9
return 9;
case 10: // Input 10
return 10;
case 11: // Input 11
return 11;
case 12: // Input 12
return 12;
case 13: // Input 13
return 13;
case 14: // Input 14
return 14;
case 15: // Input 15
return 15;
case 16: // Input 16
return 16;
case 17: // Input 17
return 17;
case 18: // Input 18
return 18;
case 19: // Input 19
return 19;
case 20: // Input 20
return 20;
case 1000: // Color Bars
return 21;
case 2001: // Color 1
return 22;
case 2002: // Color 2
return 23;
case 3010: // Media Player 1
return 24;
case 3011: // Media Player 1 Key
return 25;
case 3020: // Media Player 2
return 26;
case 3021: // Media Player 2 Key
return 27;
case 4010: // Key 1 Mask
return 28;
case 4020: // Key 2 Mask
return 29;
case 4030: // Key 3 Mask
return 30;
case 4040: // Key 4 Mask
return 31;
case 5010: // DSK 1 Mask
return 32;
case 5020: // DSK 2 Mask
return 33;
case 6000: // Super Source
return 34;
case 7001: // Clean Feed 1
return 35;
case 7002: // Clean Feed 2
return 36;
case 8001: // Auxilary 1
return 37;
case 8002: // Auxilary 2
return 38;
case 8003: // Auxilary 3
return 39;
case 8004: // Auxilary 4
return 40;
case 8005: // Auxilary 5
return 41;
case 8006: // Auxilary 6
return 42;
case 10010: // ME 1 Prog
return 43;
case 10011: // ME 1 Prev
return 44;
case 10020: // ME 2 Prog
return 45;
case 10021: // ME 2 Prev
return 46;
default:
return 0;
}
}
uint8_t ATEMbase::getAudioSrcIndex(uint16_t audioSrc) {
switch(audioSrc){
case 1: // Input 1
return 0;
case 2: // Input 2
return 1;
case 3: // Input 3
return 2;
case 4: // Input 4
return 3;
case 5: // Input 5
return 4;
case 6: // Input 6
return 5;
case 7: // Input 7
return 6;
case 8: // Input 8
return 7;
case 9: // Input 9
return 8;
case 10: // Input 10
return 9;
case 11: // Input 11
return 10;
case 12: // Input 12
return 11;
case 13: // Input 13
return 12;
case 14: // Input 14
return 13;
case 15: // Input 15
return 14;
case 16: // Input 16
return 15;
case 17: // Input 17
return 16;
case 18: // Input 18
return 17;
case 19: // Input 19
return 18;
case 20: // Input 20
return 19;
case 1001: // XLR
return 20;
case 1101: // AES/EBU
return 21;
case 1201: // RCA
return 22;
case 2001: // MP1
return 23;
case 2002: // MP2
return 24;
default:
return 0;
}
}
/*
* Translating a index to a video source
*/
uint16_t ATEMbase::getVideoIndexSrc(uint8_t index) {
switch (index) {
case 0: // Black
return 0;
case 1: // Input 1
return 1;
case 2: // Input 2
return 2;
case 3: // Input 3
return 3;
case 4: // Input 4
return 4;
case 5: // Input 5
return 5;
case 6: // Input 6
return 6;
case 7: // Input 7
return 7;
case 8: // Input 8
return 8;
case 9: // Input 9
return 9;
case 10: // Input 10
return 10;
case 11: // Input 11
return 11;
case 12: // Input 12
return 12;
case 13: // Input 13
return 13;
case 14: // Input 14
return 14;
case 15: // Input 15
return 15;
case 16: // Input 16
return 16;
case 17: // Input 17
return 17;
case 18: // Input 18
return 18;
case 19: // Input 19
return 19;
case 20: // Input 20
return 20;
case 21: // Color Bars
return 1000;
case 22: // Color 1
return 2001;
case 23: // Color 2
return 2002;
case 24: // Media Player 1
return 3010;
case 25: // Media Player 1 Key
return 3011;
case 26: // Media Player 2
return 3020;
case 27: // Media Player 2 Key
return 3021;
case 28: // Key 1 Mask
return 4010;
case 29: // Key 2 Mask
return 4020;
case 30: // Key 3 Mask
return 4030;
case 31: // Key 4 Mask
return 4040;
case 32: // DSK 1 Mask
return 5010;
case 33: // DSK 2 Mask
return 5020;
case 34: // Super Source
return 6000;
case 35: // Clean Feed 1
return 7001;
case 36: // Clean Feed 2
return 7002;
case 37: // Auxilary 1
return 8001;
case 38: // Auxilary 2
return 8002;
case 39: // Auxilary 3
return 8003;
case 40: // Auxilary 4
return 8004;
case 41: // Auxilary 5
return 8005;
case 42: // Auxilary 6
return 8006;
case 43: // ME 1 Prog
return 10010;
case 44: // ME 1 Prev
return 10011;
case 45: // ME 2 Prog
return 10020;
case 46: // ME 2 Prev
return 10021;
default:
return 0;
}
}
/*
* Translating a index to a audio source
*/
uint16_t ATEMbase::getAudioIndexSrc(uint8_t index) {
switch (index) {
case 0: // Input 1
return 1;
case 1: // Input 2
return 2;
case 2: // Input 3
return 3;
case 3: // Input 4
return 4;
case 4: // Input 5
return 5;
case 5: // Input 6
return 6;
case 6: // Input 7
return 7;
case 7: // Input 8
return 8;
case 8: // Input 9
return 9;
case 9: // Input 10
return 10;
case 10: // Input 11
return 11;
case 11: // Input 12
return 12;
case 12: // Input 13
return 13;
case 13: // Input 14
return 14;
case 14: // Input 15
return 15;
case 15: // Input 16
return 16;
case 16: // Input 17
return 17;
case 17: // Input 18
return 18;
case 18: // Input 19
return 19;
case 19: // Input 20
return 20;
case 20: // XLR
return 1001;
case 21: // AES/EBU
return 1101;
case 22: // RCA
return 1201;
case 23: // MP1
return 2001;
case 24: // MP2
return 2002;
default:
return 0;
}
}
uint8_t ATEMbase::maxAtemSeriesVideoInputs() {
return 47; // For the largest ATEM switcher, this is the number of video inputs. The max "index" number from the list above
}
void ATEMbase::commandBundleStart() {
resetCommandBundle();
_wipeCleanPacketBuffer();
_cBundle = true;
}
void ATEMbase::commandBundleEnd() {
if (_cBundle && _returnPacketLength > 0) {
_createCommandHeader(ATEM_headerCmd_AckRequest, _returnPacketLength);
_sendPacketBuffer(_returnPacketLength);
_returnPacketLength = 0;
}
resetCommandBundle();
}
void ATEMbase::resetCommandBundle() {
_cBundle = false;
_cBBO = 0;
}

142
libraries/ATEMbase/ATEMbase.h Normal file
View File

@@ -0,0 +1,142 @@
/*
Copyright 2012-2014 Kasper Skårhøj, SKAARHOJ K/S, kasper@skaarhoj.com
This file is part of the Blackmagic Design ATEM Client library for Arduino
The ATEM library is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.
The ATEM library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with the ATEM library. If not, see http://www.gnu.org/licenses/.
IMPORTANT: If you want to use this library in your own projects and/or products,
please play a fair game and heed the license rules! See our web page for a Q&A so
you can keep a clear conscience: http://skaarhoj.com/about/licenses/
*/
#ifndef ATEMbase_h
#define ATEMbase_h
#include "Arduino.h"
#ifdef ESP8266
#include <WifiUDP.h>
#else
#include <EthernetUdp.h>
#endif
#include <SkaarhojPgmspace.h>
#define ATEM_headerCmd_AckRequest 0x1 // Please acknowledge reception of this package...
#define ATEM_headerCmd_HelloPacket 0x2
#define ATEM_headerCmd_Resend 0x4 // This is a resent information
#define ATEM_headerCmd_RequestNextAfter 0x8 // I'm requesting you to resend something to me.
#define ATEM_headerCmd_Ack 0x10 // This package is an acknowledge to package id (byte 4-5) ATEM_headerCmd_AckRequest
#define ATEM_maxInitPackageCount 40 // The maximum number of initialization packages. By observation on a 2M/E 4K can be up to (not fixed!) 32. We allocate a f more then...
#define ATEM_packetBufferLength 96 // Size of packet buffer
#define ATEM_debug 0 // If "1" (true), more debugging information may hit the serial monitor, in particular when _serialDebug = 0x80. Setting this to "0" is recommended for production environments since it saves on flash memory.
class ATEMbase
{
protected:
#ifdef ESP8266
WiFiUDP _Udp;
#else
EthernetUDP _Udp; // UDP object for communication, see constructor.
#endif
uint16_t _localPort; // Default local port to send from. Preferably it's chosen randomly inside the class.
IPAddress _switcherIP; // IP address of the switcher
uint8_t _serialOutput; // If set, the library will print status/debug information to the Serial object
// ATEM Connection Basics
uint16_t _localPacketIdCounter; // This is our counter for the command packages we might like to send to ATEM
boolean _initPayloadSent; // If true, the initial reception of the ATEM memory has passed and we can begin to respond during the runLoop()
uint8_t _initPayloadSentAtPacketId; // The Remote Package ID at which point the initialization payload was completed.
boolean _hasInitialized; // If true, all initial payload packets has been received during requests for resent - and we are completely ready to rock!
boolean _isConnected; // Set true if we have received a hello package from the switcher.
uint16_t _sessionID; // Session id of session, given by ATEM switcher
unsigned long _lastContact; // Last time (millis) the switcher sent a packet to us.
uint16_t _lastRemotePacketID; // The most recent Remote Packet Id from switcher
uint8_t _missedInitializationPackages[(ATEM_maxInitPackageCount+7)/8]; // Used to track which initialization packages have been missed
uint8_t _returnPacketLength;
// ATEM Buffer:
uint8_t _packetBuffer[ATEM_packetBufferLength]; // Buffer for storing segments of the packets from ATEM and creating answer packets.
uint16_t _cmdLength; // Used when parsing packets
uint16_t _cmdPointer; // Used when parsing packets
bool _cBundle; // If set, we are building a set-command bundle.
uint8_t _cBBO; // Bundle Buffer Offset; This is an offset if you want to add more commands.
uint8_t _ATEMmodel;
bool neverConnected;
bool waitingForIncoming;
public:
ATEMbase();
void begin(const IPAddress ip);
void begin(const IPAddress ip, const uint16_t localPort);
void connect();
void connect(const boolean useFixedPortNumber);
void runLoop();
void runLoop(uint16_t delayTime);
uint16_t getATEM_lastRemotePacketId();
uint16_t getSessionID();
bool isConnected();
bool hasInitialized();
void serialOutput(uint8_t level);
bool hasTimedOut(unsigned long time, unsigned long timeout);
float audioWord2Db(uint16_t input);
uint16_t audioDb2Word(float input);
uint8_t getVideoSrcIndex(uint16_t videoSrc);
uint8_t getAudioSrcIndex(uint16_t audioSrc);
uint16_t getVideoIndexSrc(uint8_t index);
uint16_t getAudioIndexSrc(uint8_t index);
uint8_t maxAtemSeriesVideoInputs();
void commandBundleStart();
void commandBundleEnd();
void resetCommandBundle();
uint8_t getATEMmodel();
protected:
void _createCommandHeader(const uint8_t headerCmd, const uint16_t lengthOfData);
void _createCommandHeader(const uint8_t headerCmd, const uint16_t lengthOfData, const uint16_t remotePacketID);
void _sendPacketBuffer(uint8_t length);
void _wipeCleanPacketBuffer();
void _parsePacket(uint16_t packetLength);
virtual void _parseGetCommands(const char *cmdString);
bool _readToPacketBuffer();
bool _readToPacketBuffer(uint8_t maxBytes);
void _prepareCommandPacket(const char *cmdString, uint8_t cmdBytes, bool indexMatch=true);
void _finishCommandPacket();
};
#endif

13
libraries/ATEMbase/README Normal file
View File

@@ -0,0 +1,13 @@
This library for Arduino is intended to provide functions for connecting to and controlling ATEM video switchers from Blackmagic Design (https://www.blackmagicdesign.com/products/atem/). They make awesome HD video switchers, really cheap ones too and they are controlled over IP! So while you can get away with using their nice Win/Mac app and switch video professionally, you can also shell out a lot of money on a hardware interface which the broadcast pros will prefer any day. Hey, it's a win for everyone!
Please check out http://skaarhoj.com/ for our products based on this library.
ATEMbase: This is the super class that just does connection basics. See sub libraries such as ATEMstd, ATEMmax, ATEMmin etc.
Please see the API documentation at http://skaarhoj.com/fileadmin/BMDPROTOCOL.html
GPL licensed:
The library is licensed under GNU GPL v3. It allows you to use the library for any project, even commercial ones, as long as you keep the code using the library open - and deliver a copy to your client. In other words, even though you might deliver a black box hardware device, you still must give your client a copy of the Arduino sketch you have uploaded to the board. And how knows; either they will improve your product, maybe do nothing at all - or mess it up so you can sell some support hours. :-)
- kasper

55
libraries/ATEMbase/examples/ATEMbaseConnectionTest/ATEMbaseConnectionTest.ino Normal file
View File

@@ -0,0 +1,55 @@
// Including libraries:
#include <SPI.h>
#include <Ethernet.h>
#include <Streaming.h>
#include <MemoryFree.h>
#include <SkaarhojPgmspace.h>
// MAC address and IP address for this *particular* Arduino / Ethernet Shield!
// The MAC address is printed on a label on the shield or on the back of your device
// The IP address should be an available address you choose on your subnet where the switcher is also present
byte mac[] = {
0x90, 0xA2, 0xDA, 0x0D, 0x6B, 0xB9 }; // <= SETUP! MAC address of the Arduino
IPAddress clientIp(192, 168, 10, 99); // <= SETUP! IP address of the Arduino
IPAddress switcherIp(192, 168, 10, 240); // <= SETUP! IP address of the ATEM Switcher
// Include ATEMbase library and make an instance:
// The port number is chosen randomly among high numbers.
#include <ATEMbase.h>
#include <ATEMmax.h>
ATEMmax AtemSwitcher;
unsigned long lastAutoFocus;
unsigned long lastAutoIris;
void setup() {
randomSeed(analogRead(5)); // For random port selection
// Start the Ethernet, Serial (debugging) and UDP:
Ethernet.begin(mac,clientIp);
Serial.begin(115200);
Serial << F("\n- - - - - - - -\nSerial Started\n");
// Initialize a connection to the switcher:
AtemSwitcher.begin(switcherIp);
AtemSwitcher.serialOutput(0x80);
AtemSwitcher.connect();
lastAutoFocus = millis();
lastAutoIris = millis() + 2500;
}
bool state = false;
void loop() {
AtemSwitcher.setCameraControlVideomode(1, 24, 6, 0);
AtemSwitcher.runLoop();
}

674
libraries/ATEMbase/license.txt Normal file
View File

@@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

3501
libraries/ATEMstd/ATEMstd.cpp Normal file
View File

File diff suppressed because it is too large Load Diff

373
libraries/ATEMstd/ATEMstd.h Normal file
View File

@@ -0,0 +1,373 @@
/*
Copyright 2012-2014 Kasper Skårhøj, SKAARHOJ K/S, kasper@skaarhoj.com
This file is part of the Blackmagic Design ATEM Client library for Arduino
The ATEM library is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.
The ATEM library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with the ATEM library. If not, see http://www.gnu.org/licenses/.
IMPORTANT: If you want to use this library in your own projects and/or products,
please play a fair game and heed the license rules! See our web page for a Q&A so
you can keep a clear conscience: http://skaarhoj.com/about/licenses/
*/
#ifndef ATEMstd_h
#define ATEMstd_h
#include "ATEMbase.h"
class ATEMstd : public ATEMbase
{
private:
// Special audio:
uint16_t _ATEM_AMLv_channel;
uint16_t atemAudioMixerLevelsMasterLeft;
uint16_t atemAudioMixerLevelsMasterRight;
uint16_t atemAudioMixerLevelsMonitor;
uint16_t atemAudioMixerLevelsSourceLeft;
uint16_t atemAudioMixerLevelsSourceRight;
public:
ATEMstd();
void delay(const unsigned int delayTimeMillis);
/********************************
* ATEM Switcher state methods
* Returns the most recent information we've
* got about the switchers state
********************************/
uint16_t getProgramInput();
uint16_t getPreviewInput();
boolean getProgramTally(uint8_t inputNumber);
boolean getPreviewTally(uint8_t inputNumber);
boolean getUpstreamKeyerStatus(uint8_t inputNumber);
boolean getUpstreamKeyerOnNextTransitionStatus(uint8_t inputNumber);
boolean getDownstreamKeyerStatus(uint8_t inputNumber);
uint16_t getTransitionPosition();
bool getTransitionPreview();
uint8_t getTransitionType();
uint8_t getTransitionMixTime();
boolean getFadeToBlackState();
uint8_t getFadeToBlackFrameCount();
uint8_t getFadeToBlackTime();
bool getDownstreamKeyTie(uint8_t keyer);
uint16_t getAuxState(uint8_t auxOutput);
uint8_t getMediaPlayerType(uint8_t mediaPlayer);
uint8_t getMediaPlayerStill(uint8_t mediaPlayer);
uint8_t getMediaPlayerClip(uint8_t mediaPlayer);
uint16_t getAudioLevels(uint8_t channel);
uint8_t getAudioChannelMode(uint16_t channelNumber);
/********************************
* ATEM Switcher Change methods
* Asks the switcher to changes something
********************************/
void changeProgramInput(uint16_t inputNumber);
void changePreviewInput(uint16_t inputNumber);
void doCut();
void doAuto();
void doAuto(uint8_t me);
void fadeToBlackActivate();
void changeTransitionPosition(word value);
void changeTransitionPositionDone();
void changeTransitionPreview(bool state);
void changeTransitionType(uint8_t type);
void changeTransitionMixTime(uint8_t frames);
void changeFadeToBlackTime(uint8_t frames);
void changeUpstreamKeyOn(uint8_t keyer, bool state);
void changeUpstreamKeyNextTransition(uint8_t keyer, bool state);
void changeDownstreamKeyOn(uint8_t keyer, bool state);
void changeDownstreamKeyTie(uint8_t keyer, bool state);
void doAutoDownstreamKeyer(uint8_t keyer);
void changeAuxState(uint8_t auxOutput, uint16_t inputNumber);
void settingsMemorySave();
void settingsMemoryClear();
void changeColorValue(uint8_t colorGenerator, uint16_t hue, uint16_t saturation, uint16_t lightness);
void mediaPlayerSelectSource(uint8_t mediaPlayer, boolean movieclip, uint8_t sourceIndex);
void mediaPlayerClipStart(uint8_t mediaPlayer);
void changeSwitcherVideoFormat(uint8_t format);
void changeDVESettingsTemp(unsigned long Xpos,unsigned long Ypos,unsigned long Xsize,unsigned long Ysize);
void changeDVEMaskTemp(unsigned long top,unsigned long bottom,unsigned long left,unsigned long right);
void changeDVEBorder(bool enableBorder);
void changeDVESettingsTemp_RunKeyFrame(uint8_t runType);
void changeDVESettingsTemp_Rate(uint8_t rateFrames);
void changeKeyerMask(uint16_t topMask, uint16_t bottomMask, uint16_t leftMask, uint16_t rightMask);
void changeKeyerMask(uint8_t keyer, uint16_t topMask, uint16_t bottomMask, uint16_t leftMask, uint16_t rightMask);
void changeDownstreamKeyMask(uint8_t keyer, uint16_t topMask, uint16_t bottomMask, uint16_t leftMask, uint16_t rightMask);
void changeUpstreamKeyFillSource(uint8_t keyer, uint16_t inputNumber);
void changeUpstreamKeyBlending(uint8_t keyer, bool preMultipliedAlpha, uint16_t clip, uint16_t gain, bool invKey);
void changeDownstreamKeyBlending(uint8_t keyer, bool preMultipliedAlpha, uint16_t clip, uint16_t gain, bool invKey);
void changeDownstreamKeyFillSource(uint8_t keyer, uint16_t inputNumber);
void changeDownstreamKeyKeySource(uint8_t keyer, uint16_t inputNumber);
void changeAudioChannelMode(uint16_t channelNumber, uint8_t mode);
void changeAudioChannelVolume(uint16_t channelNumber, uint16_t volume);
void changeAudioMasterVolume(uint16_t volume);
void sendAudioLevelNumbers(bool enable);
void setAudioLevelReadoutChannel(uint16_t AMLv);
void setWipeReverseDirection(bool reverse);
// Special Audio:
long getAudioMixerLevelsMasterLeft();
long getAudioMixerLevelsMasterRight();
long getAudioMixerLevelsMonitor();
long getAudioMixerLevelsSourceLeft();
long getAudioMixerLevelsSourceRight();
// *********************************
// **
// ** Implementations in ATEMstd.h:
// **
// *********************************
// *********************************
// **
// ** Implementations in ATEMstd.h:
// **
// *********************************
private:
void _parseGetCommands(const char *cmdStr);
// Private Variables in ATEM.h:
uint16_t atemProtocolVersionMajor;
uint16_t atemProtocolVersionMinor;
uint8_t atemVideoModeFormat;
uint16_t atemProgramInputVideoSource[2];
uint16_t atemPreviewInputVideoSource[2];
uint8_t atemTransitionStyle[2];
uint8_t atemTransitionNextTransition[2];
bool atemTransitionPreviewEnabled[2];
bool atemTransitionInTransition[2];
uint8_t atemTransitionFramesRemaining[2];
uint16_t atemTransitionPosition[2];
uint8_t atemTransitionMixRate[2];
bool atemKeyerOnAirEnabled[2][4];
bool atemDownstreamKeyerTie[2];
uint8_t atemDownstreamKeyerRate[2];
bool atemDownstreamKeyerPreMultiplied[2];
uint16_t atemDownstreamKeyerClip[2];
uint16_t atemDownstreamKeyerGain[2];
bool atemDownstreamKeyerInvertKey[2];
bool atemDownstreamKeyerMasked[2];
int16_t atemDownstreamKeyerTop[2];
int16_t atemDownstreamKeyerBottom[2];
int16_t atemDownstreamKeyerLeft[2];
int16_t atemDownstreamKeyerRight[2];
bool atemDownstreamKeyerOnAir[2];
bool atemDownstreamKeyerInTransition[2];
bool atemDownstreamKeyerIsAutoTransitioning[2];
uint8_t atemDownstreamKeyerFramesRemaining[2];
uint8_t atemFadeToBlackRate[2];
bool atemFadeToBlackStateFullyBlack[2];
bool atemFadeToBlackStateInTransition[2];
uint8_t atemFadeToBlackStateFramesRemaining[2];
uint16_t atemAuxSourceInput[6];
uint8_t atemMediaPlayerSourceType[2];
uint8_t atemMediaPlayerSourceStillIndex[2];
uint8_t atemMediaPlayerSourceClipIndex[2];
uint8_t atemMacroRunStatusState;
bool atemMacroRunStatusIsLooping;
uint16_t atemMacroRunStatusIndex;
bool atemMacroPropertiesIsUsed[10];
char atemMacroPropertiesName[10][11];
bool atemMacroRecordingStatusIsRecording;
uint16_t atemMacroRecordingStatusIndex;
uint8_t atemAudioMixerInputMixOption[25];
uint16_t atemAudioMixerInputVolume[25];
int16_t atemAudioMixerInputBalance[25];
uint16_t atemTallyByIndexSources;
uint8_t atemTallyByIndexTallyFlags[21];
public:
// Public Methods in ATEM.h:
uint16_t getProtocolVersionMajor();
uint16_t getProtocolVersionMinor();
uint8_t getVideoModeFormat();
void setVideoModeFormat(uint8_t format);
uint16_t getProgramInputVideoSource(uint8_t mE);
void setProgramInputVideoSource(uint8_t mE, uint16_t videoSource);
uint16_t getPreviewInputVideoSource(uint8_t mE);
void setPreviewInputVideoSource(uint8_t mE, uint16_t videoSource);
void performCutME(uint8_t mE);
void performAutoME(uint8_t mE);
uint8_t getTransitionStyle(uint8_t mE);
uint8_t getTransitionNextTransition(uint8_t mE);
void setTransitionStyle(uint8_t mE, uint8_t style);
void setTransitionNextTransition(uint8_t mE, uint8_t nextTransition);
bool getTransitionPreviewEnabled(uint8_t mE);
void setTransitionPreviewEnabled(uint8_t mE, bool enabled);
bool getTransitionInTransition(uint8_t mE);
uint8_t getTransitionFramesRemaining(uint8_t mE);
uint16_t getTransitionPosition(uint8_t mE);
void setTransitionPosition(uint8_t mE, uint16_t position);
uint8_t getTransitionMixRate(uint8_t mE);
void setTransitionMixRate(uint8_t mE, uint8_t rate);
void setTransitionWipeRate(uint8_t mE, uint8_t rate);
void setTransitionWipePattern(uint8_t mE, uint8_t pattern);
void setTransitionWipeWidth(uint8_t mE, uint16_t width);
void setTransitionWipeFillSource(uint8_t mE, uint16_t fillSource);
void setTransitionWipeSymmetry(uint8_t mE, uint16_t symmetry);
void setTransitionWipeSoftness(uint8_t mE, uint16_t softness);
void setTransitionWipePositionX(uint8_t mE, uint16_t positionX);
void setTransitionWipePositionY(uint8_t mE, uint16_t positionY);
void setTransitionWipeReverse(uint8_t mE, bool reverse);
void setTransitionWipeFlipFlop(uint8_t mE, bool flipFlop);
bool getKeyerOnAirEnabled(uint8_t mE, uint8_t keyer);
void setKeyerOnAirEnabled(uint8_t mE, uint8_t keyer, bool enabled);
void setKeyerMasked(uint8_t mE, uint8_t keyer, bool masked);
void setKeyerTop(uint8_t mE, uint8_t keyer, int16_t top);
void setKeyerBottom(uint8_t mE, uint8_t keyer, int16_t bottom);
void setKeyerLeft(uint8_t mE, uint8_t keyer, int16_t left);
void setKeyerRight(uint8_t mE, uint8_t keyer, int16_t right);
void setKeyerFillSource(uint8_t mE, uint8_t keyer, uint16_t fillSource);
void setKeyLumaPreMultiplied(uint8_t mE, uint8_t keyer, bool preMultiplied);
void setKeyLumaClip(uint8_t mE, uint8_t keyer, uint16_t clip);
void setKeyLumaGain(uint8_t mE, uint8_t keyer, uint16_t gain);
void setKeyLumaInvertKey(uint8_t mE, uint8_t keyer, bool invertKey);
void setKeyDVESizeX(uint8_t mE, uint8_t keyer, int32_t sizeX);
void setKeyDVESizeY(uint8_t mE, uint8_t keyer, int32_t sizeY);
void setKeyDVEPositionX(uint8_t mE, uint8_t keyer, int32_t positionX);
void setKeyDVEPositionY(uint8_t mE, uint8_t keyer, int32_t positionY);
void setKeyDVERotation(uint8_t mE, uint8_t keyer, int32_t rotation);
void setKeyDVEBorderEnabled(uint8_t mE, uint8_t keyer, bool borderEnabled);
void setKeyDVEShadow(uint8_t mE, uint8_t keyer, bool shadow);
void setKeyDVEBorderBevel(uint8_t mE, uint8_t keyer, uint8_t borderBevel);
void setKeyDVEBorderOuterWidth(uint8_t mE, uint8_t keyer, uint16_t borderOuterWidth);
void setKeyDVEBorderInnerWidth(uint8_t mE, uint8_t keyer, uint16_t borderInnerWidth);
void setKeyDVEBorderOuterSoftness(uint8_t mE, uint8_t keyer, uint8_t borderOuterSoftness);
void setKeyDVEBorderInnerSoftness(uint8_t mE, uint8_t keyer, uint8_t borderInnerSoftness);
void setKeyDVEBorderBevelSoftness(uint8_t mE, uint8_t keyer, uint8_t borderBevelSoftness);
void setKeyDVEBorderBevelPosition(uint8_t mE, uint8_t keyer, uint8_t borderBevelPosition);
void setKeyDVEBorderOpacity(uint8_t mE, uint8_t keyer, uint8_t borderOpacity);
void setKeyDVEBorderHue(uint8_t mE, uint8_t keyer, uint16_t borderHue);
void setKeyDVEBorderSaturation(uint8_t mE, uint8_t keyer, uint16_t borderSaturation);
void setKeyDVEBorderLuma(uint8_t mE, uint8_t keyer, uint16_t borderLuma);
void setKeyDVELightSourceDirection(uint8_t mE, uint8_t keyer, uint16_t lightSourceDirection);
void setKeyDVELightSourceAltitude(uint8_t mE, uint8_t keyer, uint8_t lightSourceAltitude);
void setKeyDVEMasked(uint8_t mE, uint8_t keyer, bool masked);
void setKeyDVETop(uint8_t mE, uint8_t keyer, int16_t top);
void setKeyDVEBottom(uint8_t mE, uint8_t keyer, int16_t bottom);
void setKeyDVELeft(uint8_t mE, uint8_t keyer, int16_t left);
void setKeyDVERight(uint8_t mE, uint8_t keyer, int16_t right);
void setKeyDVERate(uint8_t mE, uint8_t keyer, uint8_t rate);
void setRunFlyingKeyKeyFrame(uint8_t mE, uint8_t keyer, uint8_t keyFrame);
void setRunFlyingKeyRuntoInfiniteindex(uint8_t mE, uint8_t keyer, uint8_t runtoInfiniteindex);
void setDownstreamKeyerFillSource(uint8_t keyer, uint16_t fillSource);
void setDownstreamKeyerKeySource(uint8_t keyer, uint16_t keySource);
bool getDownstreamKeyerTie(uint8_t keyer);
uint8_t getDownstreamKeyerRate(uint8_t keyer);
bool getDownstreamKeyerPreMultiplied(uint8_t keyer);
uint16_t getDownstreamKeyerClip(uint8_t keyer);
uint16_t getDownstreamKeyerGain(uint8_t keyer);
bool getDownstreamKeyerInvertKey(uint8_t keyer);
bool getDownstreamKeyerMasked(uint8_t keyer);
int16_t getDownstreamKeyerTop(uint8_t keyer);
int16_t getDownstreamKeyerBottom(uint8_t keyer);
int16_t getDownstreamKeyerLeft(uint8_t keyer);
int16_t getDownstreamKeyerRight(uint8_t keyer);
void setDownstreamKeyerTie(uint8_t keyer, bool tie);
void setDownstreamKeyerPreMultiplied(uint8_t keyer, bool preMultiplied);
void setDownstreamKeyerClip(uint8_t keyer, uint16_t clip);
void setDownstreamKeyerGain(uint8_t keyer, uint16_t gain);
void setDownstreamKeyerInvertKey(uint8_t keyer, bool invertKey);
void setDownstreamKeyerMasked(uint8_t keyer, bool masked);
void setDownstreamKeyerTop(uint8_t keyer, int16_t top);
void setDownstreamKeyerBottom(uint8_t keyer, int16_t bottom);
void setDownstreamKeyerLeft(uint8_t keyer, int16_t left);
void setDownstreamKeyerRight(uint8_t keyer, int16_t right);
void performDownstreamKeyerAutoKeyer(uint8_t keyer);
bool getDownstreamKeyerOnAir(uint8_t keyer);
bool getDownstreamKeyerInTransition(uint8_t keyer);
bool getDownstreamKeyerIsAutoTransitioning(uint8_t keyer);
uint8_t getDownstreamKeyerFramesRemaining(uint8_t keyer);
void setDownstreamKeyerOnAir(uint8_t keyer, bool onAir);
uint8_t getFadeToBlackRate(uint8_t mE);
void setFadeToBlackRate(uint8_t mE, uint8_t rate);
bool getFadeToBlackStateFullyBlack(uint8_t mE);
bool getFadeToBlackStateInTransition(uint8_t mE);
uint8_t getFadeToBlackStateFramesRemaining(uint8_t mE);
void performFadeToBlackME(uint8_t mE);
void setColorGeneratorHue(uint8_t colorGenerator, uint16_t hue);
void setColorGeneratorSaturation(uint8_t colorGenerator, uint16_t saturation);
void setColorGeneratorLuma(uint8_t colorGenerator, uint16_t luma);
uint16_t getAuxSourceInput(uint8_t aUXChannel);
void setAuxSourceInput(uint8_t aUXChannel, uint16_t input);
void setClipPlayerPlaying(uint8_t mediaPlayer, bool playing);
void setClipPlayerLoop(uint8_t mediaPlayer, bool loop);
void setClipPlayerAtBeginning(uint8_t mediaPlayer, bool atBeginning);
void setClipPlayerClipFrame(uint8_t mediaPlayer, uint16_t clipFrame);
uint8_t getMediaPlayerSourceType(uint8_t mediaPlayer);
uint8_t getMediaPlayerSourceStillIndex(uint8_t mediaPlayer);
uint8_t getMediaPlayerSourceClipIndex(uint8_t mediaPlayer);
void setMediaPlayerSourceType(uint8_t mediaPlayer, uint8_t type);
void setMediaPlayerSourceStillIndex(uint8_t mediaPlayer, uint8_t stillIndex);
void setMediaPlayerSourceClipIndex(uint8_t mediaPlayer, uint8_t clipIndex);
uint8_t getMacroRunStatusState();
bool getMacroRunStatusIsLooping();
uint16_t getMacroRunStatusIndex();
void setMacroAction(uint16_t index, uint8_t action);
bool getMacroPropertiesIsUsed(uint8_t macroIndex);
char * getMacroPropertiesName(uint8_t macroIndex);
void setMacroAddPauseFrames(uint16_t frames);
bool getMacroRecordingStatusIsRecording();
uint16_t getMacroRecordingStatusIndex();
uint8_t getAudioMixerInputMixOption(uint16_t audioSource);
uint16_t getAudioMixerInputVolume(uint16_t audioSource);
int16_t getAudioMixerInputBalance(uint16_t audioSource);
void setAudioMixerInputMixOption(uint16_t audioSource, uint8_t mixOption);
void setAudioMixerInputVolume(uint16_t audioSource, uint16_t volume);
void setAudioMixerInputBalance(uint16_t audioSource, int16_t balance);
void setAudioMixerMasterVolume(uint16_t volume);
void setAudioLevelsEnable(bool enable);
uint16_t getTallyByIndexSources();
uint8_t getTallyByIndexTallyFlags(uint16_t sources);
};
#endif

13
libraries/ATEMstd/README Normal file
View File

@@ -0,0 +1,13 @@
This library for Arduino is intended to provide functions for connecting to and controlling ATEM video switchers from Blackmagic Design (https://www.blackmagicdesign.com/products/atem/). They make awesome HD video switchers, really cheap ones too and they are controlled over IP! So while you can get away with using their nice Win/Mac app and switch video professionally, you can also shell out a lot of money on a hardware interface which the broadcast pros will prefer any day. Hey, it's a win for everyone!
Please check out http://skaarhoj.com/ for our products based on this library.
ATEMstd: This version of the library is backwards compatible with the old "ATEM" library that has been around since early 2012. It has wrappers for the same methods that were found in the old library.
Please see the API documentation at http://skaarhoj.com/fileadmin/BMDPROTOCOL.html
GPL licensed:
The library is licensed under GNU GPL v3. It allows you to use the library for any project, even commercial ones, as long as you keep the code using the library open - and deliver a copy to your client. In other words, even though you might deliver a black box hardware device, you still must give your client a copy of the Arduino sketch you have uploaded to the board. And how knows; either they will improve your product, maybe do nothing at all - or mess it up so you can sell some support hours. :-)
- kasper

63
libraries/ATEMstd/examples/ATEMstdMonitor/ATEMstdMonitor.ino Normal file
View File

@@ -0,0 +1,63 @@
/*****************
* Basic ATEM Connection
* Connects to the Atem Switcher and outputs keep-alive package information
*
* - kasper
*/
/*****************
* TO MAKE THIS EXAMPLE WORK:
* - You must have an Arduino with Ethernet Shield (or compatible such as "Arduino Ethernet", http://arduino.cc/en/Main/ArduinoBoardEthernet)
* - You must have an Atem Switcher connected to the same network as the Arduino - and you should have it working with the desktop software
* - You must make specific set ups in the below lines where the comment "// SETUP" is found!
*/
// Including libraries:
#include <SPI.h>
#include <Ethernet.h>
#include <Streaming.h>
#include <MemoryFree.h>
#include <SkaarhojPgmspace.h>
// MAC address and IP address for this *particular* Arduino / Ethernet Shield!
// The MAC address is printed on a label on the shield or on the back of your device
// The IP address should be an available address you choose on your subnet where the switcher is also present
byte mac[] = {
0x90, 0xA2, 0xDA, 0x0D, 0x6B, 0xB9 }; // <= SETUP! MAC address of the Arduino
IPAddress clientIp(192, 168, 10, 99); // <= SETUP! IP address of the Arduino
IPAddress switcherIp(192, 168, 10, 240); // <= SETUP! IP address of the ATEM Switcher
// Include ATEMbase library and make an instance:
// The port number is chosen randomly among high numbers.
#include <ATEMbase.h>
#include <ATEMstd.h>
ATEMstd AtemSwitcher;
void setup() {
randomSeed(analogRead(5)); // For random port selection
// Start the Ethernet, Serial (debugging) and UDP:
Ethernet.begin(mac,clientIp);
Serial.begin(115200);
Serial << F("\n- - - - - - - -\nSerial Started\n");
// Initialize a connection to the switcher:
AtemSwitcher.begin(switcherIp);
AtemSwitcher.serialOutput(0x80);
AtemSwitcher.connect();
// Shows free memory:
Serial << F("freeMemory()=") << freeMemory() << "\n";
}
void loop() {
// Check for packets, respond to them etc. Keeping the connection alive!
// VERY important that this function is called all the time - otherwise connection might be lost because packets from the switcher is
// overlooked and not responded to.
AtemSwitcher.runLoop();
}

674
libraries/ATEMstd/license.txt Normal file
View File

@@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

17
libraries/SkaarhojPgmspace/SkaarhojPgmspace.h Normal file
View File

@@ -0,0 +1,17 @@
#ifdef __arm__ /* Arduino DUE */
#define PSTR(str) (str)
#define strcpy_P(dest, src) strcpy((dest), (src))
#define strncpy_P(dest, src, n) strncpy((dest), (src), (n))
#define strcmp_P(a, b) strcmp((a), (b))
#define strncmp_P(a, b, n) strncmp((a), (b), (n))
#define pgm_read_byte_near(a) *(a)
// #define strlen_P(a) strlen((a))
#else
#endif

BIN
schematic.JPG Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 67 KiB

96
tally-light-esp32-for-blackmagic-atem-switcher.ino Normal file
View File

@@ -0,0 +1,96 @@
/*****************
Tally light ESP32 for Blackmagic ATEM switcher
Version 2.0
A wireless (WiFi) tally light for Blackmagic Design
ATEM video switchers, based on the M5StickC ESP32 development
board and the Arduino IDE.
For more information, see:
https://oneguyoneblog.com/2020/06/13/tally-light-esp32-for-blackmagic-atem-switcher/
Based on the work of Kasper Skårhøj:
https://github.com/kasperskaarhoj/SKAARHOJ-Open-Engineering
******************/
#include <M5StickC.h>
#include <WiFi.h>
#include <SkaarhojPgmspace.h>
#include <ATEMbase.h>
#include <ATEMstd.h>
IPAddress clientIp(192, 168, 178, 170); // IP address of the ESP32
IPAddress switcherIp(192, 168, 178, 173); // IP address of the ATEM switcher
ATEMstd AtemSwitcher;
// http://www.barth-dev.de/online/rgb565-color-picker/
#define GRAY 0x0020 // 8 8 8
#define GREEN 0x0200 // 0 64 0
#define RED 0xF800 // 255 0 0
const char* ssid = "yournetwork";
const char* password = "yourpassword";
int cameraNumber = 4;
int ledPin = 10;
int PreviewTallyPrevious = 1;
int ProgramTallyPrevious = 1;
void setup() {
Serial.begin(9600);
// Start the Ethernet, Serial (debugging) and UDP:
WiFi.begin(ssid, password);
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.println("Connecting to WiFi..");
}
Serial.println("Connected to the WiFi network");
// initialize the M5StickC object
M5.begin();
pinMode(ledPin, OUTPUT); // LED: 1 is on Program (Tally)
digitalWrite(ledPin, HIGH); // off
// Initialize a connection to the switcher:
AtemSwitcher.begin(switcherIp);
AtemSwitcher.serialOutput(0x80);
AtemSwitcher.connect();
}
void loop() {
// Check for packets, respond to them etc. Keeping the connection alive!
AtemSwitcher.runLoop();
int ProgramTally = AtemSwitcher.getProgramTally(cameraNumber);
int PreviewTally = AtemSwitcher.getPreviewTally(cameraNumber);
if ((ProgramTallyPrevious != ProgramTally) || (PreviewTallyPrevious != PreviewTally)) { // changed?
if ((ProgramTally && !PreviewTally) || (ProgramTally && PreviewTally) ) { // only program, or program AND preview
drawLabel(RED, BLACK, LOW);
} else if (PreviewTally && !ProgramTally) { // only preview
drawLabel(GREEN, BLACK, HIGH);
} else if (!PreviewTally || !ProgramTally) { // neither
drawLabel(BLACK, GRAY, HIGH);
}
}
ProgramTallyPrevious = ProgramTally;
PreviewTallyPrevious = PreviewTally;
}
void drawLabel(unsigned long int screenColor, unsigned long int labelColor, bool ledValue) {
digitalWrite(ledPin, ledValue);
M5.Lcd.fillScreen(screenColor);
M5.Lcd.setTextColor(labelColor, screenColor);
M5.Lcd.drawString(String(cameraNumber), 15, 40, 8);
}