ra/runelite
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Merge pull request #2272 from open-osrs/service-sounds

Browse Source 
plugins: add sounds service plugin
This commit is contained in:
Tyler Bochard
2020-01-21 00:07:38 -05:00
committed by GitHub
parent b78fe11550 d8a4196c76
commit 2ab6b2ee5f
5 changed files with 268 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
http-api/src/main/java/net/runelite/http/api/RuneLiteAPI.java
View File

@@ -68,6 +68,7 @@ public class RuneLiteAPI
private static final String OPENOSRS_SESSION = "http://session.openosrs.dev"; 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_XTEA = "http://xtea.openosrs.dev";
private static final String OPENOSRS_ANIMATIONS = "http://animations.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 String MAVEN_METADATA = "http://repo.runelite.net/net/runelite/runelite-parent/maven-metadata.xml";
private static final Properties properties = new Properties(); private static final Properties properties = new Properties();
@@ -133,6 +134,11 @@ public class RuneLiteAPI
return HttpUrl.parse(OPENOSRS_ANIMATIONS); return HttpUrl.parse(OPENOSRS_ANIMATIONS);
} }
public static HttpUrl getSoundsBase()
{
return HttpUrl.parse(OPENOSRS_SOUNDS);
}
public static HttpUrl getApiBase() public static HttpUrl getApiBase()
{ {
final String prop = System.getProperty("runelite.http-service.url"); final String prop = System.getProperty("runelite.http-service.url");

109
http-api/src/main/java/net/runelite/http/api/sounds/SoundsClient.java Normal file
View File

@@ -0,0 +1,109 @@
/*
* Copyright (c) 2017, Adam <Adam@sigterm.info>
* 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);
}
}
}

1
runelite-api/src/main/java/net/runelite/api/events/SoundEffectPlayed.java
View File

@@ -36,6 +36,7 @@ public class SoundEffectPlayed implements Event
private int soundId; private int soundId;
private int delay; private int delay;
private int npcid;
private boolean consumed; private boolean consumed;

77
runelite-client/src/main/java/net/runelite/client/plugins/sounds/SoundsPlugin.java Normal file
View File

@@ -0,0 +1,77 @@
/*
* Copyright (c) 2017, Adam <Adam@sigterm.info>
* 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());
}
}
}

142
runelite-mixins/src/main/java/net/runelite/mixins/SoundEffectMixin.java
View File

@@ -35,6 +35,7 @@ import net.runelite.api.mixins.Replace;
import net.runelite.api.mixins.Shadow; import net.runelite.api.mixins.Shadow;
import net.runelite.rs.api.RSActor; import net.runelite.rs.api.RSActor;
import net.runelite.rs.api.RSClient; import net.runelite.rs.api.RSClient;
import net.runelite.rs.api.RSNPC;
import net.runelite.rs.api.RSPcmStream; import net.runelite.rs.api.RSPcmStream;
import net.runelite.rs.api.RSRawPcmStream; import net.runelite.rs.api.RSRawPcmStream;
import net.runelite.rs.api.RSRawSound; import net.runelite.rs.api.RSRawSound;
@@ -52,6 +53,80 @@ public abstract class SoundEffectMixin implements RSClient
@Inject @Inject
private static RSActor lastSoundEffectSourceActor; private static RSActor lastSoundEffectSourceActor;
@Inject
private static int lastSoundEffectSourceNPCid;
@Copy("updateActorSequence")
public static void rs$updateActorSequence(RSActor actor, int size)
{
throw new RuntimeException();
}
@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);
lastSoundEffectSourceActor = null;
}
@FieldHook("soundEffectCount")
@Inject
public static void queuedSoundEffectCountChanged(int idx)
{
int soundCount = client.getQueuedSoundEffectCount();
if (soundCount == lastSoundEffectCount + 1)
{
int soundIndex = soundCount - 1;
int packedLocation = client.getSoundLocations()[soundIndex];
boolean consumed;
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);
consumed = event.isConsumed();
}
else
{
// Area sound effect
int x = (packedLocation >> 16) & 0xFF;
int y = (packedLocation >> 8) & 0xFF;
int range = (packedLocation) & 0xFF;
AreaSoundEffectPlayed event = new AreaSoundEffectPlayed(lastSoundEffectSourceActor);
event.setSoundId(client.getQueuedSoundEffectIDs()[soundIndex]);
event.setSceneX(x);
event.setSceneY(y);
event.setRange(range);
event.setDelay(client.getQueuedSoundEffectDelays()[soundIndex]);
client.getCallbacks().post(AreaSoundEffectPlayed.class, event);
consumed = event.isConsumed();
}
if (consumed)
{
soundCount--;
client.setQueuedSoundEffectCount(soundCount);
}
}
lastSoundEffectCount = soundCount;
}
@Inject @Inject
@Override @Override
public void playSoundEffect(int id) public void playSoundEffect(int id)
@@ -111,71 +186,4 @@ public abstract class SoundEffectMixin implements RSClient
getSoundEffectAudioQueue().addSubStream((RSPcmStream) rawPcmStream); getSoundEffectAudioQueue().addSubStream((RSPcmStream) rawPcmStream);
} }
@Copy("updateActorSequence")
public static void rs$updateActorSequence(RSActor actor, int size)
{
throw new RuntimeException();
}
@Replace("updateActorSequence")
public static void rl$updateActorSequence(RSActor actor, int size)
{
lastSoundEffectSourceActor = actor;
rs$updateActorSequence(actor, size);
lastSoundEffectSourceActor = null;
}
@FieldHook("soundEffectCount")
@Inject
public static void queuedSoundEffectCountChanged(int idx)
{
int soundCount = client.getQueuedSoundEffectCount();
if (soundCount == lastSoundEffectCount + 1)
{
int soundIndex = soundCount - 1;
int packedLocation = client.getSoundLocations()[soundIndex];
boolean consumed;
if (packedLocation == 0)
{
// Regular sound effect
SoundEffectPlayed event = new SoundEffectPlayed(lastSoundEffectSourceActor);
event.setSoundId(client.getQueuedSoundEffectIDs()[soundIndex]);
event.setDelay(client.getQueuedSoundEffectDelays()[soundIndex]);
client.getCallbacks().post(SoundEffectPlayed.class, event);
consumed = event.isConsumed();
}
else
{
// Area sound effect
int x = (packedLocation >> 16) & 0xFF;
int y = (packedLocation >> 8) & 0xFF;
int range = (packedLocation) & 0xFF;
AreaSoundEffectPlayed event = new AreaSoundEffectPlayed(lastSoundEffectSourceActor);
event.setSoundId(client.getQueuedSoundEffectIDs()[soundIndex]);
event.setSceneX(x);
event.setSceneY(y);
event.setRange(range);
event.setDelay(client.getQueuedSoundEffectDelays()[soundIndex]);
client.getCallbacks().post(AreaSoundEffectPlayed.class, event);
consumed = event.isConsumed();
}
if (consumed)
{
soundCount--;
client.setQueuedSoundEffectCount(soundCount);
}
}
lastSoundEffectCount = soundCount;
}
} }