add error checking to readstring method

return pointers from byte parsing

bundle.go

@@ -21,25 +21,29 @@ func (b *OSCBundle) ToBytes() []byte {
 	return bytes
 }
 
-func BundleFromBytes(bytes []byte) (OSCBundle, []byte, error) {
+func BundleFromBytes(bytes []byte) (*OSCBundle, []byte, error) {
 	if len(bytes) < 20 {
-		return OSCBundle{}, bytes, errors.New("bundle has to be at least 20 bytes")
+		return nil, bytes, errors.New("bundle has to be at least 20 bytes")
 	}
 
 	if bytes[0] != 35 {
-		return OSCBundle{}, bytes, errors.New("bundle must start with a #")
+		return nil, bytes, errors.New("bundle must start with a #")
 	}
 
-	bundleHeader, bytesAfterBundleHeader := readOSCString(bytes)
+	bundleHeader, bytesAfterBundleHeader, err := readOSCString(bytes)
+
+	if err != nil {
+		return nil, bytes, err
+	}
 
 	if bundleHeader != "#bundle" {
-		return OSCBundle{}, bytesAfterBundleHeader, errors.New("bundle must start with #bundle string")
+		return nil, bytesAfterBundleHeader, errors.New("bundle must start with #bundle string")
 	}
 
 	timeTag, bytesAfterTimeTag, err := readOSCTimeTag(bytesAfterBundleHeader)
 
 	if err != nil {
-		return OSCBundle{}, bytesAfterBundleHeader, err
+		return nil, bytesAfterBundleHeader, err
 	}
 
 	bundleContents := []OSCPacket{}
@@ -52,13 +56,13 @@ func BundleFromBytes(bytes []byte) (OSCBundle, []byte, error) {
 		contentSize, bytesAfterContentSize, err := readOSCInt32(remainingBytes)
 
 		if err != nil {
-			return OSCBundle{}, remainingBytes, err
+			return nil, remainingBytes, err
 		}
 
 		remainingBytes = bytesAfterContentSize
 
 		if len(remainingBytes) < int(contentSize) {
-			return OSCBundle{}, remainingBytes, errors.New("bundle doesn't have enough bytes for the content size it specifies")
+			return nil, remainingBytes, errors.New("bundle doesn't have enough bytes for the content size it specifies")
 		}
 
 		bundleContentBytes := remainingBytes[0:contentSize]
@@ -66,17 +70,17 @@ func BundleFromBytes(bytes []byte) (OSCBundle, []byte, error) {
 		if bundleContentBytes[0] == 35 {
 			content, _, err := BundleFromBytes(bundleContentBytes)
 			if err != nil {
-				return OSCBundle{}, remainingBytes, err
+				return nil, remainingBytes, err
 			}
-			bundleContents = append(bundleContents, &content)
+			bundleContents = append(bundleContents, content)
 		} else if bundleContentBytes[0] == 47 {
 			content, err := MessageFromBytes(bundleContentBytes)
 			if err != nil {
-				return OSCBundle{}, remainingBytes, err
+				return nil, remainingBytes, err
 			}
-			bundleContents = append(bundleContents, &content)
+			bundleContents = append(bundleContents, content)
 		} else {
-			return OSCBundle{}, remainingBytes, errors.New("bundle contents does not look a bundle or message")
+			return nil, remainingBytes, errors.New("bundle contents does not look a bundle or message")
 		}
 		remainingBytes = bytesAfterContentSize[contentSize:]
 		if len(remainingBytes) == 0 {
@@ -85,7 +89,7 @@ func BundleFromBytes(bytes []byte) (OSCBundle, []byte, error) {
 
 	}
 
-	return OSCBundle{
+	return &OSCBundle{
 			TimeTag:  timeTag,
 			Contents: bundleContents,
 		},

bundle_test.go

@@ -10,12 +10,12 @@ func TestOSCBundleEncoding(t *testing.T) {
 
 	testCases := []struct {
 		description string
-		bundle      OSCBundle
+		bundle      *OSCBundle
 		expected    []byte
 	}{
 		{
 			"simple contents single message",
-			OSCBundle{
+			&OSCBundle{
 				TimeTag: OSCTimeTag{
 					seconds:           32,
 					fractionalSeconds: 0,
@@ -46,12 +46,12 @@ func TestOSCBundleEncoding(t *testing.T) {
 func TestOSCBundleDecoding(t *testing.T) {
 	testCases := []struct {
 		description string
-		expected    OSCBundle
+		expected    *OSCBundle
 		bytes       []byte
 	}{
 		{
 			"simple contents single message",
-			OSCBundle{
+			&OSCBundle{
 				TimeTag: OSCTimeTag{
 					seconds:           32,
 					fractionalSeconds: 0,

cmd/receiveosc/receiveosc.go

@@ -12,30 +12,31 @@ import (
 )
 
 func main() {
-	var Host string
+	var IP string
 	var Port int32
 	var Protocol string
 	var Format string
+	var Slip bool
 
 	cmd := &cli.Command{
 		Name:  "receiveosc",
 		Usage: "receive OSC messages via UDP or TCP",
 		Flags: []cli.Flag{
 			&cli.StringFlag{
-				Name:        "host",
-				Usage:       "host to send OSC message to",
-				Value:       "127.0.0.1",
-				Destination: &Host,
+				Name:        "ip",
+				Usage:       "ip to receive OSC messages on",
+				Value:       "0.0.0.0",
+				Destination: &IP,
 			},
 			&cli.Int32Flag{
 				Name:        "port",
-				Usage:       "port to send OSC message to",
+				Usage:       "port to receive OSC messages on",
 				Destination: &Port,
 				Value:       8888,
 			},
 			&cli.StringFlag{
 				Name:        "protocol",
-				Usage:       "protocol to use to send (tcp or udp)",
+				Usage:       "protocol to use to receive (tcp or udp)",
 				Value:       "udp",
 				Destination: &Protocol,
 				Validator: func(flag string) error {
@@ -57,13 +58,23 @@ func main() {
 					return nil
 				},
 			},
+			&cli.BoolFlag{
+				Name:        "slip",
+				Value:       false,
+				Usage:       "whether to slip encode the OSC Message bytes",
+				Destination: &Slip,
+			},
 		},
 		Action: func(ctx context.Context, cmd *cli.Command) error {
-			netAddress := fmt.Sprintf("%s:%d", Host, Port)
-			if Protocol == "udp" {
+			netAddress := fmt.Sprintf("%s:%d", IP, Port)
+			switch Protocol {
+			case "udp":
 				listenUDP(netAddress, Format)
-			} else if Protocol == "tcp" {
-				listenTCP(netAddress, Format)
+			case "tcp":
+				if !Slip {
+					return fmt.Errorf("OSC 1.0 over TCP is not supported yet")
+				}
+				listenTCP(netAddress, Slip, Format)
 			}
 			return nil
 		},
@@ -74,7 +85,7 @@ func main() {
 	}
 }
 
-func listenTCP(netAddress string, format string) {
+func listenTCP(netAddress string, useSLIP bool, format string) {
 	socket, err := net.Listen("tcp4", netAddress)
 	if err != nil {
 		fmt.Println(err)
@@ -89,13 +100,13 @@ func listenTCP(netAddress string, format string) {
 			fmt.Println(err)
 			continue
 		}
-		go handleConnection(conn, format)
+		go handleTCPConnection(conn, useSLIP, format)
 	}
 }
 
 type SLIP struct {
 	pendingBytes []byte
-	Messages     chan osc.OSCMessage
+	Packets      chan osc.OSCPacket
 }
 
 func (s *SLIP) decode(bytes []byte) {
@@ -121,14 +132,14 @@ func (s *SLIP) decode(bytes []byte) {
 			escapeNext = false
 		} else if packetByte == END {
 			if len(s.pendingBytes) == 0 {
-				// opening END byte, can discard
+				// probably opening END byte, can discard
 				continue
 			} else {
-				message, err := osc.MessageFromBytes(s.pendingBytes)
+				oscPacket, _, err := osc.PacketFromBytes(s.pendingBytes)
 				if err != nil {
-					fmt.Println(err)
+					panic(err)
 				} else {
-					s.Messages <- message
+					s.Packets <- oscPacket
 				}
 			}
 			s.pendingBytes = []byte{}
@@ -136,19 +147,18 @@ func (s *SLIP) decode(bytes []byte) {
 			s.pendingBytes = append(s.pendingBytes, packetByte)
 		}
 	}
-
 }
 
 func handleSLIP(slip SLIP, format string) {
-	for message := range slip.Messages {
-		handleMessage(message, format)
+	for message := range slip.Packets {
+		handlePacket(message, format)
 	}
 }
 
-func handleConnection(conn net.Conn, format string) {
+func handleTCPConnection(conn net.Conn, useSLIP bool, format string) {
 	slip := SLIP{
 		pendingBytes: []byte{},
-		Messages:     make(chan osc.OSCMessage),
+		Packets:      make(chan osc.OSCPacket),
 	}
 	go handleSLIP(slip, format)
 
@@ -161,12 +171,26 @@ func handleConnection(conn net.Conn, format string) {
 		if err != nil {
 			return
 		}
+		if useSLIP {
+			slip.decode(buffer[0:bytesRead])
+		} else {
+			// TODO(jwetzell): handle non-SLIP TCP messages properly
+		}
 
-		slip.decode(buffer[0:bytesRead])
 	}
 }
 
-func handleMessage(message osc.OSCMessage, format string) {
+func handlePacket(message osc.OSCPacket, format string) {
+	if bundle, ok := message.(*osc.OSCBundle); ok {
+		handleBundle(bundle, format)
+	} else if msg, ok := message.(*osc.OSCMessage); ok {
+		handleMessage(msg, format)
+	} else {
+		fmt.Println("Received unknown OSC Packet type")
+	}
+}
+
+func handleMessage(message *osc.OSCMessage, format string) {
 	if format == "json" {
 		jsonData, _ := json.Marshal(message)
 		fmt.Println(string(jsonData))
@@ -175,6 +199,12 @@ func handleMessage(message osc.OSCMessage, format string) {
 	}
 }
 
+func handleBundle(bundle *osc.OSCBundle, format string) {
+	for _, packet := range bundle.Contents {
+		handlePacket(packet, format)
+	}
+}
+
 func listenUDP(netAddress string, format string) {
 
 	s, err := net.ResolveUDPAddr("udp4", netAddress)
@@ -199,11 +229,11 @@ func listenUDP(netAddress string, format string) {
 			panic(err)
 		}
 
-		oscMessage, err := osc.MessageFromBytes(buffer[0:bytesRead])
+		oscPacket, _, err := osc.PacketFromBytes(buffer[0:bytesRead])
 
 		if err != nil {
 			panic(err)
 		}
-		handleMessage(oscMessage, format)
+		handlePacket(oscPacket, format)
 	}
 }

message.go

@@ -25,15 +25,18 @@ func (m *OSCMessage) ToBytes() []byte {
 	return oscBuffer
 }
 
-func MessageFromBytes(bytes []byte) (OSCMessage, error) {
+func MessageFromBytes(bytes []byte) (*OSCMessage, error) {
 	if len(bytes) == 0 {
-		return OSCMessage{}, errors.New("cannot create OSC Message from empty byte array")
+		return nil, errors.New("cannot create OSC Message from empty byte array")
+	}
+	if bytes[0] != 47 {
+		return nil, errors.New("OSC Message must start with /")
 	}
 
-	address, typeAndArgBytes := readOSCString(bytes)
+	address, typeAndArgBytes, err := readOSCString(bytes)
 
-	if address[0] != 47 {
-		return OSCMessage{}, errors.New("OSC Message address must start with /")
+	if err != nil {
+		return nil, err
 	}
 
 	oscMessage := OSCMessage{
@@ -41,22 +44,26 @@ func MessageFromBytes(bytes []byte) (OSCMessage, error) {
 		Args:    []OSCArg{},
 	}
 
-	typeString, argBytes := readOSCString(typeAndArgBytes)
+	typeString, argBytes, err := readOSCString(typeAndArgBytes)
+
+	if err != nil {
+		return nil, err
+	}
 
 	for index, oscType := range typeString {
 		if index == 0 {
 			if oscType != ',' {
-				return OSCMessage{}, errors.New("type string is malformed")
+				return nil, errors.New("type string is malformed")
 			}
 		} else {
 			oscArg, remainingBytes, error := readOSCArg(argBytes, string(oscType))
 			if error != nil {
-				return oscMessage, error
+				return nil, error
 			}
 			argBytes = remainingBytes
 			oscMessage.Args = append(oscMessage.Args, oscArg)
 		}
 	}
 
-	return oscMessage, nil
+	return &oscMessage, nil
 }

message_test.go

@@ -11,12 +11,12 @@ func TestOSCMessageEncoding(t *testing.T) {
 
 	testCases := []struct {
 		description string
-		message     OSCMessage
+		message     *OSCMessage
 		expected    []byte
 	}{
 		{
 			"simple hello",
-			OSCMessage{
+			&OSCMessage{
 				Address: "/hello",
 				Args:    []OSCArg{},
 			},
@@ -24,7 +24,7 @@ func TestOSCMessageEncoding(t *testing.T) {
 		},
 		{
 			"simple address string arg",
-			OSCMessage{
+			&OSCMessage{
 				Address: "/hello",
 				Args: []OSCArg{
 					{
@@ -37,47 +37,47 @@ func TestOSCMessageEncoding(t *testing.T) {
 		},
 		{
 			description: "simple address integer arg",
-			message:     OSCMessage{Address: "/hello", Args: []OSCArg{{Type: "i", Value: 35}}},
+			message:     &OSCMessage{Address: "/hello", Args: []OSCArg{{Type: "i", Value: 35}}},
 			expected:    []byte{47, 104, 101, 108, 108, 111, 0, 0, 44, 105, 0, 0, 0, 0, 0, 35},
 		},
 		{
 			description: "simple address float arg",
-			message:     OSCMessage{Address: "/hello", Args: []OSCArg{{Type: "f", Value: 34.5}}},
+			message:     &OSCMessage{Address: "/hello", Args: []OSCArg{{Type: "f", Value: 34.5}}},
 			expected:    []byte{47, 104, 101, 108, 108, 111, 0, 0, 44, 102, 0, 0, 66, 10, 0, 0},
 		},
 		{
 			description: "simple address blob arg",
-			message:     OSCMessage{Address: "/hello", Args: []OSCArg{{Type: "b", Value: []byte{98, 108, 111, 98}}}},
+			message:     &OSCMessage{Address: "/hello", Args: []OSCArg{{Type: "b", Value: []byte{98, 108, 111, 98}}}},
 			expected:    []byte{47, 104, 101, 108, 108, 111, 0, 0, 44, 98, 0, 0, 0, 0, 0, 4, 98, 108, 111, 98},
 		},
 		{
 			description: "simple address True arg",
-			message:     OSCMessage{Address: "/hello", Args: []OSCArg{OSCArg{Type: "T", Value: true}}},
+			message:     &OSCMessage{Address: "/hello", Args: []OSCArg{{Type: "T", Value: true}}},
 			expected:    []byte{47, 104, 101, 108, 108, 111, 0, 0, 44, 84, 0, 0},
 		},
 		{
 			description: "simple address False arg",
-			message:     OSCMessage{Address: "/hello", Args: []OSCArg{{Type: "F", Value: false}}},
+			message:     &OSCMessage{Address: "/hello", Args: []OSCArg{{Type: "F", Value: false}}},
 			expected:    []byte{47, 104, 101, 108, 108, 111, 0, 0, 44, 70, 0, 0},
 		},
 		{
 			description: "simple address color arg",
-			message:     OSCMessage{Address: "/hello", Args: []OSCArg{{Type: "r", Value: OSCColor{r: 20, g: 21, b: 22, a: 10}}}},
+			message:     &OSCMessage{Address: "/hello", Args: []OSCArg{{Type: "r", Value: OSCColor{r: 20, g: 21, b: 22, a: 10}}}},
 			expected:    []byte{47, 104, 101, 108, 108, 111, 0, 0, 44, 114, 0, 0, 20, 21, 22, 10},
 		},
 		{
 			description: "simple address nil arg",
-			message:     OSCMessage{Address: "/hello", Args: []OSCArg{{Type: "N", Value: nil}}},
+			message:     &OSCMessage{Address: "/hello", Args: []OSCArg{{Type: "N", Value: nil}}},
 			expected:    []byte{47, 104, 101, 108, 108, 111, 0, 0, 44, 78, 0, 0},
 		},
 		{
 			description: "simple address int64 arg",
-			message:     OSCMessage{Address: "/hello", Args: []OSCArg{{Type: "h", Value: 281474976710655}}},
+			message:     &OSCMessage{Address: "/hello", Args: []OSCArg{{Type: "h", Value: 281474976710655}}},
 			expected:    []byte{47, 104, 101, 108, 108, 111, 0, 0, 44, 104, 0, 0, 0, 0, 255, 255, 255, 255, 255, 255},
 		},
 		{
 			description: "simple address float64 arg",
-			message:     OSCMessage{Address: "/hello", Args: []OSCArg{{Type: "d", Value: 12.7654763}}},
+			message:     &OSCMessage{Address: "/hello", Args: []OSCArg{{Type: "d", Value: 12.7654763}}},
 			expected: []byte{
 				47, 104, 101, 108, 108, 111, 0, 0, 44, 100, 0, 0, 0x40, 0x29, 0x87, 0xec, 0x82, 0x74, 0xb9, 0xe6,
 			},
@@ -101,7 +101,7 @@ func TestOSCMessageEncoding(t *testing.T) {
 		// },
 		{
 			description: "osc 1.0 spec example 1",
-			message:     OSCMessage{Address: "/oscillator/4/frequency", Args: []OSCArg{{Type: "f", Value: 440}}},
+			message:     &OSCMessage{Address: "/oscillator/4/frequency", Args: []OSCArg{{Type: "f", Value: 440}}},
 			expected: []byte{
 				47, 111, 115, 99, 105, 108, 108, 97, 116, 111, 114, 47, 52, 47, 102, 114, 101, 113, 117, 101, 110, 99, 121, 0, 44,
 				102, 0, 0, 67, 220, 0, 0,
@@ -109,7 +109,7 @@ func TestOSCMessageEncoding(t *testing.T) {
 		},
 		{
 			description: "osc 1.0 spec example 2",
-			message: OSCMessage{
+			message: &OSCMessage{
 				Address: "/foo",
 				Args: []OSCArg{
 					{Type: "i", Value: 1000},

osc.go

@@ -171,7 +171,7 @@ func argsToBuffer(args []OSCArg) []byte {
 	return argBuffers
 }
 
-func readOSCString(bytes []byte) (string, []byte) {
+func readOSCString(bytes []byte) (string, []byte, error) {
 	//TODO(jwetzell): add error handling
 	oscString := ""
 	stringEndIndex := 0
@@ -190,9 +190,13 @@ func readOSCString(bytes []byte) (string, []byte) {
 		stringEndIndex = stringEndIndex + stringPadding
 	}
 
+	if stringEndIndex > len(bytes) {
+		return "", bytes, errors.New("string data is not properly padded")
+	}
+
 	remainingBytes := bytes[stringEndIndex:]
 
-	return oscString, remainingBytes
+	return oscString, remainingBytes, nil
 }
 
 func readOSCInt32(bytes []byte) (int32, []byte, error) {
@@ -287,27 +291,30 @@ func readOSCArg(bytes []byte, oscType string) (OSCArg, []byte, error) {
 	//TODO(jwetzell): add error handling
 	switch oscType {
 	case "s":
-		argString, bytesLeft := readOSCString(bytes)
+		argString, bytesLeft, err := readOSCString(bytes)
+		if err != nil {
+			return OSCArg{}, bytes, err
+		}
 		oscArg.Value = argString
 		remainingBytes = bytesLeft
 	case "i":
-		argInt, bytesLeft, error := readOSCInt32(bytes)
-		if error != nil {
-			readArgError = error
+		argInt, bytesLeft, err := readOSCInt32(bytes)
+		if err != nil {
+			readArgError = err
 		}
 		oscArg.Value = argInt
 		remainingBytes = bytesLeft
 	case "f":
-		argFloat, bytesLeft, error := readOSCFloat32(bytes)
-		if error != nil {
-			readArgError = error
+		argFloat, bytesLeft, err := readOSCFloat32(bytes)
+		if err != nil {
+			readArgError = err
 		}
 		oscArg.Value = argFloat
 		remainingBytes = bytesLeft
 	case "b":
-		argBytes, bytesLeft, error := readOSCBlob(bytes)
-		if error != nil {
-			readArgError = error
+		argBytes, bytesLeft, err := readOSCBlob(bytes)
+		if err != nil {
+			readArgError = err
 		}
 		oscArg.Value = argBytes
 		remainingBytes = bytesLeft
@@ -324,23 +331,23 @@ func readOSCArg(bytes []byte, oscType string) (OSCArg, []byte, error) {
 		oscArg.Value = math.MaxInt32
 		remainingBytes = bytes
 	case "r":
-		argColor, bytesLeft, error := readOSCColor(bytes)
-		if error != nil {
-			readArgError = error
+		argColor, bytesLeft, err := readOSCColor(bytes)
+		if err != nil {
+			readArgError = err
 		}
 		oscArg.Value = argColor
 		remainingBytes = bytesLeft
 	case "h":
-		argInt, bytesLeft, error := readOSCInt64(bytes)
-		if error != nil {
-			readArgError = error
+		argInt, bytesLeft, err := readOSCInt64(bytes)
+		if err != nil {
+			readArgError = err
 		}
 		oscArg.Value = argInt
 		remainingBytes = bytesLeft
 	case "d":
-		argFloat, bytesLeft, error := readOSCFloat64(bytes)
-		if error != nil {
-			readArgError = error
+		argFloat, bytesLeft, err := readOSCFloat64(bytes)
+		if err != nil {
+			readArgError = err
 		}
 		oscArg.Value = argFloat
 		remainingBytes = bytesLeft
@@ -350,3 +357,26 @@ func readOSCArg(bytes []byte, oscType string) (OSCArg, []byte, error) {
 	}
 	return oscArg, remainingBytes, readArgError
 }
+
+func PacketFromBytes(bytes []byte) (OSCPacket, []byte, error) {
+	if len(bytes) == 0 {
+		return nil, bytes, errors.New("cannot create OSC Packet from empty byte array")
+	}
+
+	switch bytes[0] {
+	case '#':
+		bundle, remainingBytes, err := BundleFromBytes(bytes)
+		if err != nil {
+			return nil, bytes, err
+		}
+		return bundle, remainingBytes, nil
+	case '/':
+		message, err := MessageFromBytes(bytes)
+		if err != nil {
+			return nil, bytes, err
+		}
+		return message, []byte{}, nil
+	default:
+		return nil, bytes, errors.New("OSC Packet must start with # for bundle or / for message")
+	}
+}