Did some cleaning up and changed way to send Messages

Author: Maximilian Brune

README.md

@@ -15,6 +15,8 @@ mumble library written in go. Intended for writing client side music bots.
 
 ## TODO
 - implement more than just youtube videos as source for music
+- be more or less OS independent (I am only using Linux and have not tested it on other Operating Systems)
+- make library capable of using TLS certificates
 
 ## Notes
 If you want to use this library be aware that this Project is still very much experimental. I appreciate and welcome any Issue or pull request or feature request.

gomble/audioformats/opus.go

@@ -24,8 +24,8 @@ const (
     // Best for most VoIP/videoconference applications where listening quality and intelligibility matter most
     OPUS_APPICATION_VOIP = 2048
 
-    // Best for broadcast/high-fidelity application where the decoded audio sho uld be as close as possible to the input
-    OPUS_APPLICATION_VOICE = 2049
+    // Best for broadcast/high-fidelity application where the decoded audio should be as close as possible to the input
+    OPUS_APPLICATION_AUDIO = 2049
 
     // Only use when lowest-achievable latency is what matters most. Voice-optimized modes cannot be used.
     OPUS_APPLICATION_RESTRICTEDLOWDELAY = 2051
@@ -58,7 +58,7 @@ const (
     //OPUS_MAX_PACKET_SIZE = 1275
 
     // The Application to use for opus. libopus will automatically
-    OPUS_APPLICATION = OPUS_APPLICATION_VOICE
+    OPUS_APPLICATION = OPUS_APPLICATION_AUDIO
 
     // Variable Bit Rate, if set to one libopus will automatically change the bitrate as it sees fit.
     OPUS_VBR = 0

gomble/audiopackagewriter.go

@@ -72,9 +72,7 @@ func sendAudioPacket(opusPayload []byte, opusPayloadlen uint16, last bool) {
     var all []byte = make([]byte, len(header)+len(opusPayload))
     copy(all[:len(header)], header[:])
     copy(all[len(header):], opusPayload[:])
-    logger.Debugf("header size: %d\n", len(header))
-    logger.Debugf("payloa size: %d\n", len(opusPayload))
-    logger.Debugf("entire size %d\n", len(all))
+    logger.Debugf("header size: %d, payload size: %d, entire size %d\n", len(header), len(opusPayload), len(all))
 
     // Do we tunnel audio over TCP or do we send it over UDP
     if audiocryptoconfig.tcpTunnelMode {

gomble/channel.go

@@ -18,10 +18,10 @@ var Listener listener
 type listener struct {
     OnPrivateMessageReceived func(e PrivateMessageReceivedEvent)
     OnChannelMessageReceived func(e ChannelMessageReceivedEvent)
-    OnTrackPaused			 func(e TrackPausedEvent)
-    OnTrackStopped			 func(e TrackStoppedEvent)
-    OnTrackException		 func(e TrackExceptionEvent)
-    OnTrackFinished			 func(e TrackFinishedEvent)
+    OnTrackPaused            func(e TrackPausedEvent)
+    OnTrackStopped           func(e TrackStoppedEvent)
+    OnTrackException         func(e TrackExceptionEvent)
+    OnTrackFinished          func(e TrackFinishedEvent)
 }
 
 // conn is our tcp connection to the server. It is used by packagereader.go to read packages from mumble-server and by packagewriter to write packages to the mumble-server.

gomble/eventhandler.go

@@ -88,6 +88,12 @@ func handlePacket(pckType uint16, data []byte) { // {{{
     case 9:
         var pck mumbleproto.UserState
         proto.Unmarshal(data, &pck)
+        if (pck.GetName() == "gomble-bot") {
+            // We got our own UserState
+            BotUserState.ChannelId = pck.GetChannelId()
+            BotUserState.Name = pck.GetName()
+            BotUserState.Session = pck.GetSession()
+        }
         break
         // Server sync
     case 5:

gomble/packagereader.go

@@ -99,7 +99,7 @@ func audioroutine(t *Track) { // {{{
         return
     }
 
-    opusbuf := make(chan []byte, t.buffer_ms / audioformats.OPUS_FRAME_DURATION)
+    opusbuf := make(chan []byte, t.buffer_ms / audioformats.OPUS_FRAME_DURATION) // make channel with buffer_ms/frame_duration number of frames as buffer
     // our producer
     go func () {
         for true {
@@ -156,7 +156,7 @@ func audioroutine(t *Track) { // {{{
             }
         default:
         }
-        logger.Debugf("Get next opus frame\n")
+        logger.Debugf("Get next opus frame, number of frames in buffer: %d\n", len(opusbuf))
         lastTime := time.Now()
         opusPayload, ok := <-opusbuf
         elapsed := time.Since(lastTime)

gomble/track.go

@@ -37,13 +37,14 @@ type YoutubedlFormat struct {
 }
 
 func NewYoutubedlVideo(path string) (*YoutubedlVideo, error) {// {{{
+    var video YoutubedlVideo
+
     cmd := exec.Command("youtube-dl", "-j", path)
     buf, err := cmd.Output()
     if err != nil {
         _, file, line, _ := runtime.Caller(0)
         return nil, fmt.Errorf("NewYoutubeVideo(%s:%d): %w", file, line, err)
     }
-    var video YoutubedlVideo
     err = json.Unmarshal(buf, &video)
     if err != nil {
         _, file, line, _ := runtime.Caller(0)

gomble/tracksources/youtube/youtubedl.go

@@ -3,41 +3,39 @@ package gomble
 import "github.com/CodingVoid/gomble/logger"
 import "github.com/CodingVoid/gomble/mumbleproto"
 
-type user struct {
-    id uint32
-    //name string
+type UserState struct {
+    Name string
+    Session uint32
+    ChannelId uint32
 }
 
-//var users = map[uint32]string{}
-
-func GetUser(userid uint32) *user {
-    //username := users[userid]
-    //if username == "" {
-    //	return nil
-    //}
-    return &user{
-        id: userid,
-        //name: username,
-    }
-}
-
-//func CheckUserExists(userid uint32) bool {
-//	if users[userid] != "" {
-//		return true
-//	}
-//	return false
-//}
+var BotUserState UserState
 
 // send Message to the user
-func (u user) SendMessage(msg string) {
+func SendMessageToUser(msg string, userid uint32) {
     pck := mumbleproto.TextMessage{
         Actor:     nil, //uint32
         Message:   &msg,
         TreeId:    nil, //[]uint32 {},
-        Session:   []uint32{u.id},
+        Session:   []uint32{userid},
         ChannelId: nil, //[]uint32{},
     }
-    logger.Infof("Sending Message to user %d\n", u.id)
+    logger.Infof("Sending Message to user with session-ID: %d\n", userid)
+    if err := writeProto(&pck); err != nil {
+        panic(err.Error())
+    }
+}
+
+// send Message to the user
+func SendMessageToChannel(msg string, channelid uint32) {
+    pck := mumbleproto.TextMessage{
+        Actor:     nil, // uint32
+        Message:   &msg,
+        TreeId:    nil, // []uint32 {},
+        Session:   nil, // []uint32{},
+        ChannelId: []uint32{channelid},
+    }
+    logger.Infof("Sending Message to Channel %d\n", channelid)
     if err := writeProto(&pck); err != nil {
         panic(err.Error())
     }

gomble/user.go

@@ -10,9 +10,6 @@ import (
 // queue of tracks
 var queue []*gomble.Track
 
-// current Channel the bot is in
-var currentChannel gomble.Channel
-
 func main() {
     gomble.Init(logger.TRACE, "127.0.0.1:64738", false)
     gomble.Listener.OnPrivateMessageReceived = OnPrivateMessageReceived
@@ -26,12 +23,12 @@ func main() {
 }
 
 func OnPrivateMessageReceived(e gomble.PrivateMessageReceivedEvent) {
-    gomble.GetUser(e.Actor).SendMessage("Send Back Private")
+    gomble.SendMessageToUser("Send Back Private", e.Actor)
 }
 
 func OnChannelMessageReceived(e gomble.ChannelMessageReceivedEvent) {
     // set current channel
-    currentChannel = gomble.GetChannel(e.Channel)
+    //gomble.SwitchChannel(e.Channel) TODO
     if strings.HasPrefix(e.Message, "#play ") {
         logger.Debugf(e.Message + "\n")
         yt, err := gomble.LoadTrack(e.Message)
@@ -71,7 +68,7 @@ func startNextTrack() {
         t := queue[0]
         // returns false if a track is already playing (or t == nil). returns true if starting was successful
         if gomble.Play(t) {
-            currentChannel.SendMessage("Start playing Track " + t.GetTitle())
+            gomble.SendMessageToChannel("Start playing Track " + t.GetTitle(), gomble.BotUserState.ChannelId)
             // If successful remove the track from the queue
             queue = queue[1:]
         }