codespell -w .

Author: Maximilian Brune

README.md

@@ -1,3 +1,4 @@
+[![Go Report Card](https://goreportcard.com/badge/github.com/CodingVoid/gomble)](https://goreportcard.com/report/github.com/CodingVoid/gomble)
 # gomble
 mumble library written in go. Intended for writing client side music bots.
 

go.mod

@@ -3,6 +3,7 @@ module github.com/CodingVoid/gomble
 go 1.14
 
 require (
-	github.com/golang/protobuf v1.3.5
+	github.com/golang/protobuf v1.4.1
 	golang.org/x/crypto v0.0.0-20200420201142-3c4aac89819a
+	google.golang.org/protobuf v1.25.0
 )

gomble/audiohandler.go

@@ -37,11 +37,11 @@ func Stop() { // {{{
 	audiohandler.playing = false
 } // }}}
 
-// This audioroutine get's called whenever a new audio stream should be played
+// This audioroutine gets called whenever a new audio stream should be played
 func audioroutine(track audiosources.Audiosource) { // {{{
 	enc, err := audioformats.NewOpusEncoder(audioformats.OPUS_SAMPLE_RATE, audioformats.OPUS_CHANNELS, audioformats.OPUS_APPLICATION) // initializes a new encoder
 	if err != nil {
-		logger.Errorf("Could not create Opus Encoder. End Track\n") //TODO break and raise done/exception event with error paramter or whatsoever
+		logger.Errorf("Could not create Opus Encoder. End Track\n") //TODO break and raise done/exception event with error parameter or whatsoever
 		eventpuffer <- TrackEndedEvent{
 			Track:  track,
 			Reason: TRACK_OTHER,

gomble/audiopackagewriter.go

@@ -86,21 +86,21 @@ func sendAudioPacket(opusPayload []byte, opusPayloadlen uint16, last bool) {
 			logger.Fatalf("Error writing to tls connection\n")
 		}
 		if n < len(all) {
-			logger.Fatalf("Weniger geschrieben als gedacht\n")
+			logger.Fatalf("Did not write as much as expected\n")
 		}
 	} else {
 		// encrypt ocb2-aes
 		var allencrypted []byte = make([]byte, len(all)-2) //ocb2 overhead is always 4 byte, but for UDP we don't need 2 bytes package type and 4 bytes package length (4-2-4 = -2)
 		audiocryptoconfig.cryptState.Encrypt(allencrypted[:], all[6:])
 		logger.Debugf("Send via UDP\n")
-		// send ocb2-aes encrytped udp package
+		// send ocb2-aes encrypted udp package
 		n, err := audioConn.Write(allencrypted[:])
 
 		if err != nil {
 			logger.Fatalf("Error writing to UDP connection")
 		}
 		if n < len(allencrypted) {
-			logger.Fatalf("Weniger geschrieben als gedacht")
+			logger.Fatalf("Did not write as much as expected")
 		}
 	}
 

gomble/audiosources/oggopusfile/oggopusfile.go

@@ -122,7 +122,7 @@ func getOpusFileError(prefix string, errorCode int32) error { // {{{
 	case 0:
 		str += "SUCCESS"
 	case C.OP_FALSE:
-		str += "OP_FALSE: A request did not succed"
+		str += "OP_FALSE: A request did not succeed"
 	case C.OP_EOF:
 		str += "OP_EOF: Currently not used externally"
 	case C.OP_HOLE:

gomble/audiosources/youtube/persistentYoutubeStream.go

@@ -17,7 +17,7 @@ type persistentYoutubeStream struct {
 	contentLength int
 	// The current http response that is in use
 	httpResp *http.Response
-	// byte array to save all the incoming data (usefull for seeking)
+	// byte array to save all the incoming data (useful for seeking)
 	//save []byte
 }
 
@@ -40,7 +40,7 @@ func (s *persistentYoutubeStream) Read(p []byte) (int, error) { // {{{
 	if err != nil {
 		// Check if error was end of file
 		if err != io.EOF {
-			logger.Debugf("Hier IST DAS MUHAHAHAH, body length: %d, readed: %d, to read: %d, already readed: %d, %v\n", s.httpResp.ContentLength, n, len(p), s.cposition, err)
+			logger.Warnf("Got Error while reading from http Response of youtube stream. Trying to connect again..., body length: %d, readed: %d, to read: %d, already readed: %d, %v\n", s.httpResp.ContentLength, n, len(p), s.cposition, err)
 			// try to "reconnect" (just request the remaining audiodata again)
 			err = s.RequestNext()
 			// here we will return 0 data even though there is still data left (so keep in mind that this function does not always return len(p) audiodata)
@@ -49,9 +49,8 @@ func (s *persistentYoutubeStream) Read(p []byte) (int, error) { // {{{
 	}
 	s.cposition += n
 	s.aposition += n
-	//s.save = append(s.save, p[:n]...) // save everything that has been readed so far (//TODO implement seeking)
 	// Check if that is the end of the http response
-	if s.httpResp.ContentLength == int64(s.cposition) {
+	if err == io.EOF {
 		// Check if the complete stream is at the end
 		if s.aposition == s.contentLength {
 			return n, io.EOF
@@ -70,7 +69,7 @@ func (s *persistentYoutubeStream) RequestNext() error { // {{{
 		return fmt.Errorf("RequestNext(%s:%d): %w", file, line, err)
 	}
 	val := burl.Query()                                                  // get values of url
-	val.Set("range", fmt.Sprintf("%d-%d", s.aposition, s.contentLength)) // set range paramter for value
+	val.Set("range", fmt.Sprintf("%d-%d", s.aposition, s.contentLength)) // set range parameter for value
 	burl.RawQuery = val.Encode()                                         // set values to url
 	resp, err := http.Get(burl.String())
 	if err != nil {

gomble/audiosources/youtube/youtube.go

@@ -35,7 +35,7 @@ func NewYoutubeVideo(path string) (*YoutubeVideo, error) { // {{{
 	var jsonstr string
 	// The following loop is for trying up to 3 times to download the youtube page and find a specific json string in it. You might not believe but it doesn't always work on the first try...
 	var i int
-	for i=0; i < 3 && len(jsonstr) == 0; i++ {
+	for i = 0; i < 3 && len(jsonstr) == 0; i++ {
 		resp, err := http.Get(path)
 		//resp, err := http.Get("https://www.youtube.com/watch?v=YO1GBsuzTWU")
 		if err != nil {
@@ -546,7 +546,7 @@ func applyOperations(operations []CipherOperation, text string) (string, error)
 			//logger.Debugf("SLICE Operation")
 		case SPLICE, SLICE:
 			logger.Debugf("SPLICE or SLICE Operation\n")
-			text = text[op.parameter:] // remove the bytes before op.paramter
+			text = text[op.parameter:] // remove the bytes before op.parameter
 		default:
 			_, file, line, _ := runtime.Caller(0)
 			return "", fmt.Errorf("applyOperations(%s:%d): Invalid cipher operation", file, line)

gomble/audiosources/youtube/youtubevideo.old.go

@@ -9,7 +9,7 @@ package youtube
 //
 //	"gomble/logger"
 //)
-//// after much time spent in trial and error I found out that youtube-dl does seem to ignore any kind of paramter if output is set to stdout (-o -), altough I can't find any of this in the documentation. Furthermore most problems I got had their origin in using youtube-dl for downloading the video/audio. It's safer to use youtube-dl only as plain donwloading and outputing to stdout of anything it can find under this url:
+//// after much time spent in trial and error I found out that youtube-dl does seem to ignore any kind of parameter if output is set to stdout (-o -), although I can't find any of this in the documentation. Furthermore most problems I got had their origin in using youtube-dl for downloading the video/audio. It's safer to use youtube-dl only as plain downloading and outputting to stdout of anything it can find under this url:
 //// youtube-dl -o - --rm-cache-dir --quiet {url}
 //
 //// -i -			takes the input of stdin
@@ -102,7 +102,7 @@ package youtube
 //		// we didn't got enough data, is ffmpeg and youtube-dl done?
 //		select {
 //		case _ = <- y.done:
-//			// Check if any problems occured with youtube-dl
+//			// Check if any problems occurred with youtube-dl
 //			if !y.ycmd.ProcessState.Success() {
 //				return nil, errors.New("Could not complete youtube-dl command with url: " + y.url + " stderr: " + y.ycmdError.String())
 //			}

gomble/event.go

@@ -27,7 +27,7 @@ const (
 	TRACK_INTERRUPTED = iota
 	// Track ended playing because Track was over
 	TRACK_ENDED
-	// Some other failure occured. The Logs should be checked for further Information
+	// Some other failure occurred. The Logs should be checked for further Information
 	TRACK_OTHER
 )
 

gomble/eventhandler.go

@@ -28,7 +28,7 @@ var tlsconfig tls.Config
 // audioConn is our udp connection to the server. It is used by audiopackagereader.go to read packages from mumble-server and by audiopackagewriter to write packages to the mumble-server
 var audioConn *net.UDPConn
 
-// Adress and port of mumble-server in syntax address:port
+// Address and port of mumble-server in syntax address:port
 var addr string
 
 // Initializes some settings for gomble and returns an Eventhandler which can be used to add event-listeners
@@ -70,9 +70,9 @@ func Begin() {
 		logger.Fatalf("Sending Version failed: " + err.Error() + "\n")
 	}
 
-	logger.Debugf("Send Authentification")
+	logger.Debugf("Send Authentication")
 	if err := writeProto(&authPacket); err != nil {
-		logger.Fatalf("Sending Authentification failed: " + err.Error() + "\n")
+		logger.Fatalf("Sending Authentication failed: " + err.Error() + "\n")
 	}
 
 	// mumble connection established