# -*- coding: utf-8 -*- """ The MIT License (MIT) Copyright (c) 2015 Rapptz Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. """ """Some documentation to refer to: - Our main web socket (mWS) sends opcode 4 with a server ID and channel ID. - The mWS receives VOICE_STATE_UPDATE and VOICE_SERVER_UPDATE. - We pull the session_id from VOICE_STATE_UPDATE. - We pull the token, endpoint and guild_id from VOICE_SERVER_UPDATE. - Then we initiate the voice web socket (vWS) pointing to the endpoint. - We send opcode 0 with the user_id, guild_id, session_id and token using the vWS. - The vWS sends back opcode 2 with an ssrc, port, modes(array) and hearbeat_interval. - We send a UDP discovery packet to endpoint:port and receive our IP and our port in LE. - Then we send our IP and port via vWS with opcode 1. - When that's all done, we receive opcode 4 from the vWS. - Finally we can transmit data to endpoint:port. """ import asyncio import websockets import socket import json, time import logging import struct import threading import subprocess import shlex log = logging.getLogger(__name__) from . import utils from .errors import ClientException, InvalidArgument from .opus import Encoder as OpusEncoder class StreamPlayer(threading.Thread): def __init__(self, stream, encoder, connected, player, after, **kwargs): threading.Thread.__init__(self, **kwargs) self.buff = stream self.encoder = encoder self.player = player self._event = threading.Event() self._connected = connected self.after = after self.delay = self.encoder.frame_length / 1000.0 def run(self): self.loops = 0 start = time.time() while not self.is_done(): self.loops += 1 data = self.buff.read(self.encoder.frame_size) log.info('received {} bytes (out of {})'.format(len(data), self.encoder.frame_size)) if len(data) != self.encoder.frame_size: self.stop() break self.player(data) next_time = start + self.delay * self.loops delay = max(0, self.delay + (next_time - time.time())) time.sleep(delay) def stop(self): self._event.set() if callable(self.after): try: self.after() except: pass def is_done(self): return not self._connected.is_set() or self._event.is_set() class VoiceClient: """Represents a Discord voice connection. This client is created solely through :meth:`Client.join_voice_channel` and its only purpose is to transmit voice. Attributes ----------- session_id : str The voice connection session ID. token : str The voice connection token. user : :class:`User` The user connected to voice. endpoint : str The endpoint we are connecting to. channel : :class:`Channel` The voice channel connected to. """ def __init__(self, user, connected, main_ws, session_id, channel, data, loop): self.user = user self._connected = connected self.main_ws = main_ws self.channel = channel self.session_id = session_id self.loop = loop self.token = data.get('token') self.guild_id = data.get('guild_id') self.endpoint = data.get('endpoint') self.sequence = 0 self.timestamp = 0 self.encoder = OpusEncoder(48000, 2) log.info('created opus encoder with {0.__dict__}'.format(self.encoder)) def checked_add(self, attr, value, limit): val = getattr(self, attr) if val + value > limit: setattr(self, attr, 0) else: setattr(self, attr, val + value) @asyncio.coroutine def keep_alive_handler(self, delay): while True: payload = { 'op': 3, 'd': int(time.time()) } msg = 'Keeping voice websocket alive with timestamp {}' log.debug(msg.format(payload['d'])) yield from self.ws.send(utils.to_json(payload)) yield from asyncio.sleep(delay) @asyncio.coroutine def received_message(self, msg): log.debug('Voice websocket frame received: {}'.format(msg)) op = msg.get('op') data = msg.get('d') if op == 2: delay = (data['heartbeat_interval'] / 100.0) - 5 self.keep_alive = utils.create_task(self.keep_alive_handler(delay), loop=self.loop) yield from self.initial_connection(data) elif op == 4: yield from self.connection_ready(data) @asyncio.coroutine def initial_connection(self, data): self.ssrc = data.get('ssrc') self.voice_port = data.get('port') packet = bytearray(70) struct.pack_into('>I', packet, 0, self.ssrc) self.socket.sendto(packet, (self.endpoint_ip, self.voice_port)) recv = yield from self.loop.sock_recv(self.socket, 70) self.ip = [] for x in range(4, len(recv)): val = recv[x] if val == 0: break self.ip.append(str(val)) self.ip = '.'.join(self.ip) self.port = recv[len(recv) - 2] << 0 | recv[len(recv) - 1] << 1 payload = { 'op': 1, 'd': { 'protocol': 'udp', 'data': { 'address': self.ip, 'port': self.port, 'mode': 'plain' } } } yield from self.ws.send(utils.to_json(payload)) log.debug('sent {} to initialize voice connection'.format(payload)) log.info('initial voice connection is done') @asyncio.coroutine def connection_ready(self, data): log.info('voice connection is now ready') speaking = { 'op': 5, 'd': { 'speaking': True, 'delay': 0 } } yield from self.ws.send(utils.to_json(speaking)) self._connected.set() # connection related @asyncio.coroutine def connect(self): log.info('voice connection is connecting...') self.endpoint = self.endpoint.replace(':80', '') self.endpoint_ip = socket.gethostbyname(self.endpoint) self.socket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) self.socket.setblocking(False) log.info('Voice endpoint found {0.endpoint} (IP: {0.endpoint_ip})'.format(self)) self.ws = yield from websockets.connect('wss://' + self.endpoint, loop=self.loop) self.ws.max_size = None payload = { 'op': 0, 'd': { 'server_id': self.guild_id, 'user_id': self.user.id, 'session_id': self.session_id, 'token': self.token } } yield from self.ws.send(utils.to_json(payload)) while not self._connected.is_set(): msg = yield from self.ws.recv() if msg is None: yield from self.disconnect() raise ClientException('Unexpected websocket close on voice websocket') yield from self.received_message(json.loads(msg)) @asyncio.coroutine def disconnect(self): """|coro| Disconnects all connections to the voice client. In order to reconnect, you must create another voice client using :meth:`Client.join_voice_channel`. """ if not self._connected.is_set(): return self.keep_alive.cancel() self.socket.shutdown(socket.SHUT_RDWR) self.socket.close() self._connected.clear() yield from self.ws.close() payload = { 'op': 4, 'd': { 'guild_id': None, 'channel_id': None, 'self_mute': True, 'self_deaf': False } } yield from self.main_ws.send(utils.to_json(payload)) # audio related def _get_voice_packet(self, data): log.info('creating a voice packet') buff = bytearray(len(data) + 12) buff[0] = 0x80 buff[1] = 0x78 for i in range(0, len(data)): buff[i + 12] = data[i] struct.pack_into('>H', buff, 2, self.sequence) struct.pack_into('>I', buff, 4, self.timestamp) struct.pack_into('>I', buff, 8, self.ssrc) return buff def create_ffmpeg_player(self, filename, *, use_avconv=False, after=None): """Creates a stream player for ffmpeg that launches in a separate thread to play audio. The ffmpeg player launches a subprocess of ``ffmpeg`` to a specific filename and then plays that file. You must have the ffmpeg or avconv executable in your path environment variable in order for this to work. The operations that can be done on the player are the same as those in :meth:`create_stream_player`. Examples ---------- Basic usage: :: voice = yield from client.join_voice_channel(channel) player = voice.create_ffmpeg_player('cool.mp3') player.start() Parameters ----------- filename : str The filename that ffmpeg will take and convert to PCM bytes. This is passed to the ``-i`` flag that ffmpeg takes. use_avconv: bool Use ``avconv`` instead of ``ffmpeg``. after : callable The finalizer that is called after the stream is done being played. All exceptions the finalizer throws are silently discarded. Raises ------- ClientException Popen failed to due to an error in ``ffmpeg`` or ``avconv``. Returns -------- StreamPlayer A stream player with specific operations. See :meth:`create_stream_player`. """ command = 'ffmpeg' if not use_avconv else 'avconv' cmd = '{} -i "{}" -f s16le -ar {} -ac {} -loglevel warning pipe:1' cmd = cmd.format(command, filename, self.encoder.sampling_rate, self.encoder.channels) try: process = subprocess.Popen(shlex.split(cmd), stdout=subprocess.PIPE) except: raise ClientException('Popen failed: {}'.format(str(e))) return StreamPlayer(process.stdout, self.encoder, self._connected, self.play_audio, after) def encoder_options(self, *, sample_rate, channels=2): """Sets the encoder options for the OpusEncoder. Calling this after you create a stream player via :meth:`create_ffmpeg_player` or :meth:`create_stream_player` has no effect. Parameters ---------- sample_rate : int Sets the sample rate of the OpusEncoder. channels : int Sets the number of channels for the OpusEncoder. 2 for stereo, 1 for mono. Raises ------- InvalidArgument The values provided are invalid. """ if sample_rate not in (8000, 12000, 16000, 24000, 48000): raise InvalidArgument('Sample rate out of range. Valid: [8000, 12000, 16000, 24000, 48000]') if channels not in (1, 2): raise InvalidArgument('Channels must be either 1 or 2.') self.encoder = OpusEncoder(sample_rate, channels) log.info('created opus encoder with {0.__dict__}'.format(self.encoder)) def create_stream_player(self, stream, after=None): """Creates a stream player that launches in a separate thread to play audio. The stream player assumes that ``stream.read`` is a valid function that returns a *bytes-like* object. The finalizer, ``after`` is called after the stream has been exhausted. The following operations are valid on the ``StreamPlayer`` object: +------------------+--------------------------------------------------+ | Operation | Description | +==================+==================================================+ | player.start() | Starts the audio stream. | +------------------+--------------------------------------------------+ | player.stop() | Stops the audio stream. | +------------------+--------------------------------------------------+ | player.is_done() | Returns a bool indicating if the stream is done. | +------------------+--------------------------------------------------+ Parameters ----------- stream The stream object to read from. after: The finalizer that is called after the stream is exhausted. All exceptions it throws are silently discarded. It is called without parameters. Returns -------- StreamPlayer A stream player with the operations noted above. """ def play_audio(self, data): """Sends an audio packet composed of the data. You must be connected to play audio. Parameters ---------- data The *bytes-like object* denoting PCM voice data. Raises ------- ClientException You are not connected. OpusError Encoding the data failed. """ self.checked_add('sequence', 1, 65535) encoded_data = self.encoder.encode(data, self.encoder.samples_per_frame) packet = self._get_voice_packet(encoded_data) sent = self.socket.sendto(packet, (self.endpoint_ip, self.voice_port)) self.checked_add('timestamp', self.encoder.samples_per_frame, 4294967295)