docs: Primarily add proper copyright headers and minor editorializing.

Author: smokhov

tools/streamer_recorder/PracticalSocket.cpp

@@ -1,6 +1,8 @@
 /*
  *   C++ sockets on Unix and Windows
- *   Copyright (C) 2002
+ *   Copyright (C) 2002 Michael J. Donahoo and Kenneth L. Calvert
+ *   http://cs.ecs.baylor.edu/%7Edonahoo/practical/CSockets/practical/
+ *   Modified code forked from https://github.com/chenxiaoqino/udp-image-streaming
  *
  *   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
@@ -60,14 +62,14 @@ const char *SocketException::what() const throw() {
 }
 
 // Function to fill in address structure given an address and port
-static void fillAddr(const string &address, unsigned short port, 
+static void fillAddr(const string &address, unsigned short port,
                      sockaddr_in &addr) {
   memset(&addr, 0, sizeof(addr));  // Zero out address structure
   addr.sin_family = AF_INET;       // Internet address
 
   hostent *host;  // Resolve name
   if ((host = gethostbyname(address.c_str())) == NULL) {
-    // strerror() will not work for gethostbyname() and hstrerror() 
+    // strerror() will not work for gethostbyname() and hstrerror()
     // is supposedly obsolete
     throw SocketException("Failed to resolve name (gethostbyname())");
   }
@@ -169,13 +171,13 @@ unsigned short Socket::resolveService(const string &service,
 
   if ((serv = getservbyname(service.c_str(), protocol.c_str())) == NULL)
     return atoi(service.c_str());  /* Service is port number */
-  else 
+  else
     return ntohs(serv->s_port);    /* Found port (network byte order) by name */
 }
 
 // CommunicatingSocket Code
 
-CommunicatingSocket::CommunicatingSocket(int type, int protocol)  
+CommunicatingSocket::CommunicatingSocket(int type, int protocol)
     throw(SocketException) : Socket(type, protocol) {
 }
 
@@ -194,14 +196,14 @@ void CommunicatingSocket::connect(const string &foreignAddress,
   }
 }
 
-void CommunicatingSocket::send(const void *buffer, int bufferLen) 
+void CommunicatingSocket::send(const void *buffer, int bufferLen)
     throw(SocketException) {
   if (::send(sockDesc, (raw_type *) buffer, bufferLen, 0) < 0) {
     throw SocketException("Send failed (send())", true);
   }
 }
 
-int CommunicatingSocket::recv(void *buffer, int bufferLen) 
+int CommunicatingSocket::recv(void *buffer, int bufferLen)
     throw(SocketException) {
   int rtn;
   if ((rtn = ::recv(sockDesc, (raw_type *) buffer, bufferLen, 0)) < 0) {
@@ -211,7 +213,7 @@ int CommunicatingSocket::recv(void *buffer, int bufferLen)
   return rtn;
 }
 
-string CommunicatingSocket::getForeignAddress() 
+string CommunicatingSocket::getForeignAddress()
     throw(SocketException) {
   sockaddr_in addr;
   unsigned int addr_len = sizeof(addr);
@@ -234,8 +236,8 @@ unsigned short CommunicatingSocket::getForeignPort() throw(SocketException) {
 
 // TCPSocket Code
 
-TCPSocket::TCPSocket() 
-    throw(SocketException) : CommunicatingSocket(SOCK_STREAM, 
+TCPSocket::TCPSocket()
+    throw(SocketException) : CommunicatingSocket(SOCK_STREAM,
     IPPROTO_TCP) {
 }
 
@@ -249,14 +251,14 @@ TCPSocket::TCPSocket(int newConnSD) : CommunicatingSocket(newConnSD) {
 
 // TCPServerSocket Code
 
-TCPServerSocket::TCPServerSocket(unsigned short localPort, int queueLen) 
+TCPServerSocket::TCPServerSocket(unsigned short localPort, int queueLen)
     throw(SocketException) : Socket(SOCK_STREAM, IPPROTO_TCP) {
   setLocalPort(localPort);
   setListen(queueLen);
 }
 
-TCPServerSocket::TCPServerSocket(const string &localAddress, 
-    unsigned short localPort, int queueLen) 
+TCPServerSocket::TCPServerSocket(const string &localAddress,
+    unsigned short localPort, int queueLen)
     throw(SocketException) : Socket(SOCK_STREAM, IPPROTO_TCP) {
   setLocalAddressAndPort(localAddress, localPort);
   setListen(queueLen);
@@ -284,23 +286,23 @@ UDPSocket::UDPSocket() throw(SocketException) : CommunicatingSocket(SOCK_DGRAM,
   setBroadcast();
 }
 
-UDPSocket::UDPSocket(unsigned short localPort)  throw(SocketException) : 
+UDPSocket::UDPSocket(unsigned short localPort)  throw(SocketException) :
     CommunicatingSocket(SOCK_DGRAM, IPPROTO_UDP) {
   setLocalPort(localPort);
   setBroadcast();
 }
 
-UDPSocket::UDPSocket(const string &localAddress, unsigned short localPort) 
+UDPSocket::UDPSocket(const string &localAddress, unsigned short localPort)
      throw(SocketException) : CommunicatingSocket(SOCK_DGRAM, IPPROTO_UDP) {
   setLocalAddressAndPort(localAddress, localPort);
   setBroadcast();
 }
 
 void UDPSocket::setBroadcast() {
-  // If this fails, we'll hear about it when we try to send.  This will allow 
+  // If this fails, we'll hear about it when we try to send.  This will allow
   // system that cannot broadcast to continue if they don't plan to broadcast
   int broadcastPermission = 1;
-  setsockopt(sockDesc, SOL_SOCKET, SO_BROADCAST, 
+  setsockopt(sockDesc, SOL_SOCKET, SO_BROADCAST,
              (raw_type *) &broadcastPermission, sizeof(broadcastPermission));
 }
 
@@ -321,8 +323,8 @@ void UDPSocket::disconnect() throw(SocketException) {
   }
 }
 
-void UDPSocket::sendTo(const void *buffer, int bufferLen, 
-    const string &foreignAddress, unsigned short foreignPort) 
+void UDPSocket::sendTo(const void *buffer, int bufferLen,
+    const string &foreignAddress, unsigned short foreignPort)
     throw(SocketException) {
   sockaddr_in destAddr;
   fillAddr(foreignAddress, foreignPort, destAddr);
@@ -339,7 +341,7 @@ int UDPSocket::recvFrom(void *buffer, int bufferLen, string &sourceAddress,
   sockaddr_in clntAddr;
   socklen_t addrLen = sizeof(clntAddr);
   int rtn;
-  if ((rtn = recvfrom(sockDesc, (raw_type *) buffer, bufferLen, 0, 
+  if ((rtn = recvfrom(sockDesc, (raw_type *) buffer, bufferLen, 0,
                       (sockaddr *) &clntAddr, (socklen_t *) &addrLen)) < 0) {
     throw SocketException("Receive failed (recvfrom())", true);
   }
@@ -350,7 +352,7 @@ int UDPSocket::recvFrom(void *buffer, int bufferLen, string &sourceAddress,
 }
 
 void UDPSocket::setMulticastTTL(unsigned char multicastTTL) throw(SocketException) {
-  if (setsockopt(sockDesc, IPPROTO_IP, IP_MULTICAST_TTL, 
+  if (setsockopt(sockDesc, IPPROTO_IP, IP_MULTICAST_TTL,
                  (raw_type *) &multicastTTL, sizeof(multicastTTL)) < 0) {
     throw SocketException("Multicast TTL set failed (setsockopt())", true);
   }
@@ -361,8 +363,8 @@ void UDPSocket::joinGroup(const string &multicastGroup) throw(SocketException) {
 
   multicastRequest.imr_multiaddr.s_addr = inet_addr(multicastGroup.c_str());
   multicastRequest.imr_interface.s_addr = htonl(INADDR_ANY);
-  if (setsockopt(sockDesc, IPPROTO_IP, IP_ADD_MEMBERSHIP, 
-                 (raw_type *) &multicastRequest, 
+  if (setsockopt(sockDesc, IPPROTO_IP, IP_ADD_MEMBERSHIP,
+                 (raw_type *) &multicastRequest,
                  sizeof(multicastRequest)) < 0) {
     throw SocketException("Multicast group join failed (setsockopt())", true);
   }
@@ -373,8 +375,8 @@ void UDPSocket::leaveGroup(const string &multicastGroup) throw(SocketException)
 
   multicastRequest.imr_multiaddr.s_addr = inet_addr(multicastGroup.c_str());
   multicastRequest.imr_interface.s_addr = htonl(INADDR_ANY);
-  if (setsockopt(sockDesc, IPPROTO_IP, IP_DROP_MEMBERSHIP, 
-                 (raw_type *) &multicastRequest, 
+  if (setsockopt(sockDesc, IPPROTO_IP, IP_DROP_MEMBERSHIP,
+                 (raw_type *) &multicastRequest,
                  sizeof(multicastRequest)) < 0) {
     throw SocketException("Multicast group leave failed (setsockopt())", true);
   }

tools/streamer_recorder/ProtonectSR.cpp

@@ -1,7 +1,7 @@
 /*
  * This file is part of the OpenKinect Project. http://www.openkinect.org
  *
- * Copyright (c) 2011 individual OpenKinect contributors. See the CONTRIB file
+ * Copyright (c) 2017 individual OpenKinect contributors. See the CONTRIB file
  * for details.
  *
  * This code is licensed to you under the terms of the Apache License, version

tools/streamer_recorder/blender_viewer/scripts/main.py

@@ -1,3 +1,29 @@
+#
+# This file is part of the OpenKinect Project. http://www.openkinect.org
+#
+# Copyright (c) 2017 individual OpenKinect contributors. See the CONTRIB file
+# for details.
+#
+# This code is licensed to you under the terms of the Apache License, version
+# 2.0, or, at your option, the terms of the GNU General Public License,
+# version 2.0. See the APACHE20 and GPL2 files for the text of the licenses,
+# or the following URLs:
+# http://www.apache.org/licenses/LICENSE-2.0
+# http://www.gnu.org/licenses/gpl-2.0.txt
+#
+# If you redistribute this file in source form, modified or unmodified, you
+# may:
+#   1) Leave this header intact and distribute it under the same terms,
+#      accompanying it with the APACHE20 and GPL20 files, or
+#   2) Delete the Apache 2.0 clause and accompany it with the GPL2 file, or
+#   3) Delete the GPL v2 clause and accompany it with the APACHE20 file
+# In all cases you must keep the copyright notice intact and include a copy
+# of the CONTRIB file.
+#
+# Binary distributions must follow the binary distribution requirements of
+# either License.
+#
+
 from bge import (
         logic,
         texture,
@@ -6,7 +32,7 @@
 import socket
 import bgl
 
-# # add cv2 lib (requires numpy higher version than current in blender)
+# add cv2 lib (requires numpy higher version than current in blender)
 import sys
 sys.path.append('/usr/local/Cellar/python3/3.4.3/Frameworks/Python.framework/Versions/3.4/lib/python3.4/site-packages')
 import numpy
@@ -94,11 +120,9 @@ def run(controller):
                     logic.texture.source = source
                     logic.texture.refresh(False)
 
-
         except socket.timeout:
             pass
 
-
 def end(controller):
     """
     called when ending BGE (e.g. to properly close network connections)

tools/streamer_recorder/include/PracticalSocket.h

@@ -1,6 +1,8 @@
 /*
  *   C++ sockets on Unix and Windows
- *   Copyright (C) 2002
+ *   Copyright (C) 2002 Michael J. Donahoo and Kenneth L. Calvert
+ *   http://cs.ecs.baylor.edu/%7Edonahoo/practical/CSockets/practical/
+ *   Code forked from https://github.com/chenxiaoqino/udp-image-streaming
  *
  *   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

tools/streamer_recorder/include/config.h

@@ -1,3 +1,29 @@
+/*
+ * This file is part of the OpenKinect Project. http://www.openkinect.org
+ *
+ * Copyright (c) 2017 individual OpenKinect contributors. See the CONTRIB file
+ * for details.
+ *
+ * This code is licensed to you under the terms of the Apache License, version
+ * 2.0, or, at your option, the terms of the GNU General Public License,
+ * version 2.0. See the APACHE20 and GPL2 files for the text of the licenses,
+ * or the following URLs:
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.gnu.org/licenses/gpl-2.0.txt
+ *
+ * If you redistribute this file in source form, modified or unmodified, you
+ * may:
+ *   1) Leave this header intact and distribute it under the same terms,
+ *      accompanying it with the APACHE20 and GPL20 files, or
+ *   2) Delete the Apache 2.0 clause and accompany it with the GPL2 file, or
+ *   3) Delete the GPL v2 clause and accompany it with the APACHE20 file
+ * In all cases you must keep the copyright notice intact and include a copy
+ * of the CONTRIB file.
+ *
+ * Binary distributions must follow the binary distribution requirements of
+ * either License.
+ */
+
 #define FRAME_HEIGHT 720
 #define FRAME_WIDTH 1280
 #define FRAME_INTERVAL (1000/30)

tools/streamer_recorder/include/recorder.h

@@ -1,3 +1,29 @@
+/*
+ * This file is part of the OpenKinect Project. http://www.openkinect.org
+ *
+ * Copyright (c) 2017 individual OpenKinect contributors. See the CONTRIB file
+ * for details.
+ *
+ * This code is licensed to you under the terms of the Apache License, version
+ * 2.0, or, at your option, the terms of the GNU General Public License,
+ * version 2.0. See the APACHE20 and GPL2 files for the text of the licenses,
+ * or the following URLs:
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.gnu.org/licenses/gpl-2.0.txt
+ *
+ * If you redistribute this file in source form, modified or unmodified, you
+ * may:
+ *   1) Leave this header intact and distribute it under the same terms,
+ *      accompanying it with the APACHE20 and GPL20 files, or
+ *   2) Delete the Apache 2.0 clause and accompany it with the GPL2 file, or
+ *   3) Delete the GPL v2 clause and accompany it with the APACHE20 file
+ * In all cases you must keep the copyright notice intact and include a copy
+ * of the CONTRIB file.
+ *
+ * Binary distributions must follow the binary distribution requirements of
+ * either License.
+ */
+
 #ifndef RECORDER_H
 #define RECORDER_H
 

tools/streamer_recorder/include/streamer.h

@@ -1,3 +1,29 @@
+/*
+ * This file is part of the OpenKinect Project. http://www.openkinect.org
+ *
+ * Copyright (c) 2017 individual OpenKinect contributors. See the CONTRIB file
+ * for details.
+ *
+ * This code is licensed to you under the terms of the Apache License, version
+ * 2.0, or, at your option, the terms of the GNU General Public License,
+ * version 2.0. See the APACHE20 and GPL2 files for the text of the licenses,
+ * or the following URLs:
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.gnu.org/licenses/gpl-2.0.txt
+ *
+ * If you redistribute this file in source form, modified or unmodified, you
+ * may:
+ *   1) Leave this header intact and distribute it under the same terms,
+ *      accompanying it with the APACHE20 and GPL20 files, or
+ *   2) Delete the Apache 2.0 clause and accompany it with the GPL2 file, or
+ *   3) Delete the GPL v2 clause and accompany it with the APACHE20 file
+ * In all cases you must keep the copyright notice intact and include a copy
+ * of the CONTRIB file.
+ *
+ * Binary distributions must follow the binary distribution requirements of
+ * either License.
+ */
+
 #ifndef STREAMER_H
 #define STREAMER_H
 
@@ -17,8 +43,8 @@ class Streamer
 private:
   // frame related parameters
   int jpegqual; // Compression Parameter
-  vector < int > compression_params;
-  vector < uchar > encoded;
+  vector<int> compression_params;
+  vector<unsigned char> encoded;
   int total_pack;
   int ibuf[1];
 

tools/streamer_recorder/recorder.cpp

@@ -1,8 +1,33 @@
+/*
+ * This file is part of the OpenKinect Project. http://www.openkinect.org
+ *
+ * Copyright (c) 2017 individual OpenKinect contributors. See the CONTRIB file
+ * for details.
+ *
+ * This code is licensed to you under the terms of the Apache License, version
+ * 2.0, or, at your option, the terms of the GNU General Public License,
+ * version 2.0. See the APACHE20 and GPL2 files for the text of the licenses,
+ * or the following URLs:
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.gnu.org/licenses/gpl-2.0.txt
+ *
+ * If you redistribute this file in source form, modified or unmodified, you
+ * may:
+ *   1) Leave this header intact and distribute it under the same terms,
+ *      accompanying it with the APACHE20 and GPL20 files, or
+ *   2) Delete the Apache 2.0 clause and accompany it with the GPL2 file, or
+ *   3) Delete the GPL v2 clause and accompany it with the APACHE20 file
+ * In all cases you must keep the copyright notice intact and include a copy
+ * of the CONTRIB file.
+ *
+ * Binary distributions must follow the binary distribution requirements of
+ * either License.
+ */
+
 #include "recorder.h"
 #include <cstdlib>
 #include <iomanip>
 
-
 Recorder::Recorder() : timeStamps(MAX_FRAME_ID)
 {
 }
@@ -31,7 +56,7 @@ void Recorder::registTimeStamp()
   timeStamps[frameID] = Recorder::getMilliSpan(t_start);
   // printf("Elapsed time = %u ms \n", timeStamps[frameID]);
 
-  frameID ++;
+  frameID++;
 }
 
 void Recorder::initialize()