Skip to content

Commit

Permalink
plugins: add sounds service plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
Therealnull committed Jan 21, 2020
1 parent b78fe11 commit d8a4196
Show file tree
Hide file tree
Showing 5 changed files with 261 additions and 60 deletions.
6 changes: 6 additions & 0 deletions http-api/src/main/java/net/runelite/http/api/RuneLiteAPI.java
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ public class RuneLiteAPI
private static final String OPENOSRS_SESSION = "http://session.openosrs.dev";
private static final String OPENOSRS_XTEA = "http://xtea.openosrs.dev";
private static final String OPENOSRS_ANIMATIONS = "http://animations.openosrs.dev";
private static final String OPENOSRS_SOUNDS = "http://sounds.openosrs.dev";
private static final String MAVEN_METADATA = "http://repo.runelite.net/net/runelite/runelite-parent/maven-metadata.xml";

private static final Properties properties = new Properties();
Expand Down Expand Up @@ -133,6 +134,11 @@ public static HttpUrl getAnimationsBase()
return HttpUrl.parse(OPENOSRS_ANIMATIONS);
}

public static HttpUrl getSoundsBase()
{
return HttpUrl.parse(OPENOSRS_SOUNDS);
}

public static HttpUrl getApiBase()
{
final String prop = System.getProperty("runelite.http-service.url");
Expand Down
109 changes: 109 additions & 0 deletions http-api/src/main/java/net/runelite/http/api/sounds/SoundsClient.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
/*
* Copyright (c) 2017, Adam <[email protected]>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.runelite.http.api.sounds;

import com.google.gson.JsonParseException;
import com.google.gson.reflect.TypeToken;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.HashMap;
import net.runelite.http.api.RuneLiteAPI;
import okhttp3.Call;
import okhttp3.Callback;
import okhttp3.HttpUrl;
import okhttp3.Request;
import okhttp3.Response;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class SoundsClient
{
private static final Logger logger = LoggerFactory.getLogger(SoundsClient.class);

public void submit(int npcid, int soundid)
{

HttpUrl url = RuneLiteAPI.getSoundsBase().newBuilder()
.addPathSegment("submit")
.addQueryParameter("npcid", String.valueOf(npcid))
.addQueryParameter("soundid", String.valueOf(soundid))
.build();

Request request = new Request.Builder()
.url(url)
.build();

RuneLiteAPI.CLIENT.newCall(request).enqueue(new Callback()
{
@Override
public void onFailure(Call call, IOException e)
{
System.out.println("unable to submit sound");
}

@Override
public void onResponse(Call call, Response response)
{
try
{
if (!response.isSuccessful())
{
System.out.println("unsuccessful sound response");
}
}
finally
{
response.close();
}
}
});
}

public HashMap<Integer, int[]> get() throws IOException
{
HttpUrl url = RuneLiteAPI.getSoundsBase().newBuilder()
.addPathSegment("get")
.build();

Request request = new Request.Builder()
.url(url)
.build();

try (Response response = RuneLiteAPI.CLIENT.newCall(request).execute())
{
InputStream in = response.body().byteStream();
// CHECKSTYLE:OFF
return RuneLiteAPI.GSON.fromJson(new InputStreamReader(in), new TypeToken<HashMap<Integer, int[]>>()
{
}.getType());
// CHECKSTYLE:ON
}
catch (JsonParseException ex)
{
throw new IOException(ex);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ public class SoundEffectPlayed implements Event

private int soundId;
private int delay;
private int npcid;

private boolean consumed;

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
/*
* Copyright (c) 2017, Adam <[email protected]>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.runelite.client.plugins.sounds;

import java.io.IOException;
import java.util.HashMap;
import javax.inject.Inject;
import lombok.extern.slf4j.Slf4j;
import net.runelite.api.Client;
import net.runelite.api.events.SoundEffectPlayed;
import net.runelite.client.eventbus.Subscribe;
import net.runelite.client.plugins.Plugin;
import net.runelite.client.plugins.PluginDescriptor;
import net.runelite.http.api.sounds.SoundsClient;
import org.apache.commons.lang3.ArrayUtils;

@PluginDescriptor(
name = "Sounds",
hidden = true
)
@Slf4j
public class SoundsPlugin extends Plugin
{
private final SoundsClient soundsClient = new SoundsClient();

private HashMap<Integer, int[]> sounds;
@Inject
private Client client;

{
try
{
sounds = soundsClient.get();
}
catch (IOException e)
{
e.printStackTrace();
}
}

@Subscribe
private void onSoundEffectPlayed(SoundEffectPlayed event)
{
if (event.getNpcid() != -1)
{
if (ArrayUtils.contains(sounds.get(event.getNpcid()), event.getSoundId()))
{
return;
}
int[] newSounds = ArrayUtils.add(sounds.get(event.getNpcid()), event.getSoundId());
sounds.put(event.getNpcid(), newSounds);
soundsClient.submit(event.getNpcid(), event.getSoundId());
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
import net.runelite.api.mixins.Shadow;
import net.runelite.rs.api.RSActor;
import net.runelite.rs.api.RSClient;
import net.runelite.rs.api.RSNPC;
import net.runelite.rs.api.RSPcmStream;
import net.runelite.rs.api.RSRawPcmStream;
import net.runelite.rs.api.RSRawSound;
Expand All @@ -53,65 +54,7 @@ public abstract class SoundEffectMixin implements RSClient
private static RSActor lastSoundEffectSourceActor;

@Inject
@Override
public void playSoundEffect(int id)
{
playSoundEffect(id, 0, 0, 0, 0);
}

@Inject
@Override
public void playSoundEffect(int id, int x, int y, int range)
{
playSoundEffect(id, x, y, range, 0);
}

@Inject
@Override
public void playSoundEffect(int id, int x, int y, int range, int delay)
{
int position = ((x & 255) << 16) + ((y & 255) << 8) + (range & 255);

int[] queuedSoundEffectIDs = getQueuedSoundEffectIDs();
int[] queuedSoundEffectLoops = getQueuedSoundEffectLoops();
int[] queuedSoundEffectDelays = getQueuedSoundEffectDelays();
RSSoundEffect[] audioEffects = getAudioEffects();
int[] soundLocations = getSoundLocations();
int queuedSoundEffectCount = getQueuedSoundEffectCount();

queuedSoundEffectIDs[queuedSoundEffectCount] = id;
queuedSoundEffectLoops[queuedSoundEffectCount] = 1;
queuedSoundEffectDelays[queuedSoundEffectCount] = delay;
audioEffects[queuedSoundEffectCount] = null;
soundLocations[queuedSoundEffectCount] = position;

setQueuedSoundEffectCount(queuedSoundEffectCount + 1);
}

@Inject
@Override
public void playSoundEffect(int id, int volume)
{
RSSoundEffect soundEffect = getTrack(getIndexCache4(), id, 0);
if (soundEffect == null)
{
return;
}

// If the current volume is not muted, use it instead
final int soundEffectVolume = getSoundEffectVolume();
if (soundEffectVolume != SoundEffectVolume.MUTED)
{
volume = soundEffectVolume;
}

RSRawSound rawAudioNode = soundEffect.toRawAudioNode().applyResampler(getSoundEffectResampler());
RSRawPcmStream rawPcmStream = createRawPcmStream(rawAudioNode, 100, volume);
rawPcmStream.setNumLoops(1);

getSoundEffectAudioQueue().addSubStream((RSPcmStream) rawPcmStream);
}

private static int lastSoundEffectSourceNPCid;

@Copy("updateActorSequence")
public static void rs$updateActorSequence(RSActor actor, int size)
Expand All @@ -122,6 +65,10 @@ public void playSoundEffect(int id, int volume)
@Replace("updateActorSequence")
public static void rl$updateActorSequence(RSActor actor, int size)
{
if (actor instanceof RSNPC)
{
lastSoundEffectSourceNPCid = ((RSNPC) actor).getId();
}
lastSoundEffectSourceActor = actor;

rs$updateActorSequence(actor, size);
Expand All @@ -143,8 +90,9 @@ public static void queuedSoundEffectCountChanged(int idx)
if (packedLocation == 0)
{
// Regular sound effect

SoundEffectPlayed event = new SoundEffectPlayed(lastSoundEffectSourceActor);
event.setNpcid(lastSoundEffectSourceNPCid);
lastSoundEffectSourceNPCid = -1;
event.setSoundId(client.getQueuedSoundEffectIDs()[soundIndex]);
event.setDelay(client.getQueuedSoundEffectDelays()[soundIndex]);
client.getCallbacks().post(SoundEffectPlayed.class, event);
Expand Down Expand Up @@ -178,4 +126,64 @@ public static void queuedSoundEffectCountChanged(int idx)

lastSoundEffectCount = soundCount;
}

@Inject
@Override
public void playSoundEffect(int id)
{
playSoundEffect(id, 0, 0, 0, 0);
}

@Inject
@Override
public void playSoundEffect(int id, int x, int y, int range)
{
playSoundEffect(id, x, y, range, 0);
}

@Inject
@Override
public void playSoundEffect(int id, int x, int y, int range, int delay)
{
int position = ((x & 255) << 16) + ((y & 255) << 8) + (range & 255);

int[] queuedSoundEffectIDs = getQueuedSoundEffectIDs();
int[] queuedSoundEffectLoops = getQueuedSoundEffectLoops();
int[] queuedSoundEffectDelays = getQueuedSoundEffectDelays();
RSSoundEffect[] audioEffects = getAudioEffects();
int[] soundLocations = getSoundLocations();
int queuedSoundEffectCount = getQueuedSoundEffectCount();

queuedSoundEffectIDs[queuedSoundEffectCount] = id;
queuedSoundEffectLoops[queuedSoundEffectCount] = 1;
queuedSoundEffectDelays[queuedSoundEffectCount] = delay;
audioEffects[queuedSoundEffectCount] = null;
soundLocations[queuedSoundEffectCount] = position;

setQueuedSoundEffectCount(queuedSoundEffectCount + 1);
}

@Inject
@Override
public void playSoundEffect(int id, int volume)
{
RSSoundEffect soundEffect = getTrack(getIndexCache4(), id, 0);
if (soundEffect == null)
{
return;
}

// If the current volume is not muted, use it instead
final int soundEffectVolume = getSoundEffectVolume();
if (soundEffectVolume != SoundEffectVolume.MUTED)
{
volume = soundEffectVolume;
}

RSRawSound rawAudioNode = soundEffect.toRawAudioNode().applyResampler(getSoundEffectResampler());
RSRawPcmStream rawPcmStream = createRawPcmStream(rawAudioNode, 100, volume);
rawPcmStream.setNumLoops(1);

getSoundEffectAudioQueue().addSubStream((RSPcmStream) rawPcmStream);
}
}

0 comments on commit d8a4196

Please sign in to comment.