Sign in to follow this  
Followers 0
coolAlias

[1.7.10][SOLVED] Stopping records once started

By coolAlias, in Modder Support

Recommended Posts

coolAlias    745

coolAlias
Posted

I've been looking all over in vanilla code for how records are handled, and I'm stumped on 2 things:

 

1. Where do the records actually START playing in vanilla code?

2. How can I stop the record track once it starts without terminating all sounds?

 

So far, I've looked through BlockJukebox and its nested TileEntity, ItemRecord, the World playRecord and playAuxSFX methods, and the Client and Server NetPlayHandlers for S24PacketBlockAction and S28PacketEffect, thinking that there might have been some 'special cases' tucked away in the packet handling, but nope.

 

When ItemRecord is inserted, it plays auxiliary sound effect #1005 with the item id and sets the itemstack in the tile entity. When the record is ejected from the BlockJukebox, it plays aux #1005, with 0 as the 'id' and calls playRecord(null, x, y, z). All of that happens only on the server side, btw.

 

I suspect that the auxiliary sound effect is what's playing the record track, since nothing in BlockJukebox appears to play the record, but I can't find where aux SFX actually get handled. Not in World, WorldClient, WorldServer, packets...

 

Now, I'm playing the record on the client side for now from a Gui (I know how to broadcast via packets if I need), and I can play the record using mc.theWorld.playRecord, BUT I can't get it to stop!

 

For the x/y/z coordinates, I tried using MathHelper.floor_double of mc.thePlayer's position, as well as passing in the x/y/z from the GuiHandler when the gui is opened (which are also from the player's position). I use the same coordinates for playing the song as I do for attempting to stop it.

@Override
public void onGuiClosed() {
if (song != null) { // && ticksSinceLastNote < song.getDuration()
	LogHelper.info("Gui closed, stopping song"); // prints
	mc.theWorld.playAuxSFX(1005, x, y, z, 0); // no effect, but this is what BlockJukebox does when the disc is ejected
	mc.theWorld.playRecord((String) null, x, y, z); // no effect, but this is what BlockJukebox does when the disc is ejected
}
}

I have also sent a packet to the server making the exact same method calls (obviously NOT with mc.theWorld), but to no avail.

 

It looked so obvious when I first wrote the code, but it doesn't work at all. The record just keeps on playing. Does anyone know how the vanilla code actually works in this case?

Share this post

Link to post
Share on other sites

diesieben07    6671

diesieben07
Posted

This is what happens when you play a record:

 

> ItemRecord#onItemUse

> World#playAuxSFXAtEntity (serverside)

> WorldManager#playAuxSFX (serverside)

> S28PacketEffect is sent to all nearby clients

> [... network stuff ...]

> World#playAuxSFX (clientside)

> RenderGlobal#playAuxSFX (clientside)

> World#playRecord (clientside)

> RenderGlobal#playRecord <-- Actually plays the sound

 

Stopping the record when it's removed works similarly. The last method in the chain should give you an idea of how to stop a sound for any Jukebox, you just need to access the private field 

mapSoundPositions

in RenderGlobal.

Share this post

Link to post
Share on other sites

coolAlias    745

coolAlias
Posted

This was very easy to find out. Learn to use your IDE ;)

When I searched for references, RenderGlobal#playAuxSFX never showed up, neither from World nor IWorldAccess :\

 

Nevertheless, you are right - I am not very good with my IDE. Something to work on xD

 

EDIT: Derp... opened up the type hierarchy and voilá. Lol.

 

However, I'm still confused: calling WorldClient#playRecord iterates through all the IWorldAccesses and calls playRecord, so when I call mc.theWorld.playRecord(null) it should also call RenderGlobal#playRecord(null) automatically, should it not?

Share this post

Link to post
Share on other sites

diesieben07    6671

diesieben07
Posted

If it is a client world, yes. You only have either RenderGlobal or WorldManager as a IWorldAccess. WorldManager for a server world, RenderGlobal for a client world.

Share this post

Link to post
Share on other sites

coolAlias    745

coolAlias
Posted

Exactly - WorldManager sends packets, RenderGlobal actually plays the record.

 

In my Gui#keyTyped, I call 'mc.theWorld.playRecord("records.cat", x, y, z);', then in #onGuiClosed(), I call 'mc.theWorld.playAuxSFX(1005, x, y, z, 0);' and 'mc.theWorld.playRecord((String) null, x, y, z);', but the record keeps playing.

 

Pastebin of Gui code; don't mind the ZeldaSongPacket - it doesn't play the record again.

 

Thanks for the help so far.

Share this post

Link to post
Share on other sites

coolAlias    745

coolAlias
Posted

Glad it's not just me xD

 

So I went ahead and created my own mapped sound positions in my ClientProxy to see more closely what's going on. Now it gets even more interesting - the sound is found playing at the position, but calling 'stopSound(isound)' does not stop it! SoundHandler#stopSounds() works, with the downside that it will stop all other sounds from playing at the same time.

 

Code:

 

// In GuiOcarina#onGuiClosed: replaced vanilla mc.theWorld method calls with this:
ZSSMain.proxy.playRecord(null, x, y, z);

// And starting the music with:
ZSSMain.proxy.playRecord("records.cat", x, y, z);

// in ClientProxy
/** Map of all custom streaming sounds for this client. See RenderGlobal#mapSoundPositions */
private final Map<ChunkCoordinates, ISound> mapSoundPositions = new HashMap<ChunkCoordinates, ISound>();

@Override
public void playRecord(String sound, int x, int y, int z) {
ChunkCoordinates chunkcoordinates = new ChunkCoordinates(x, y, z);
ISound isound = mapSoundPositions.get(chunkcoordinates);
if (isound != null) {
	LogHelper.info("Sound already playing at " + x + "/" + y + "/" + z + "; stopping sound");
	Minecraft.getMinecraft().getSoundHandler().stopSounds();//.stopSound(isound);
	mapSoundPositions.remove(chunkcoordinates);
}
if (sound != null) {
	LogHelper.info("Playing sound at " + x + "/" + y + "/" + z + ": " + sound);
	ResourceLocation resource = new ResourceLocation(sound);
	PositionedSoundRecord psr = PositionedSoundRecord.func_147675_a(resource, x, y, z);
	mapSoundPositions.put(chunkcoordinates, psr);
	Minecraft.getMinecraft().getSoundHandler().playSound(psr);
}
}

 

 

Console Output is as expected:

[11:15:33] [ZeldaSwordSkills] [iNFO] Playing record on client
[11:15:33] [ZeldaSwordSkills] [iNFO] Playing sound at -417/74/838: records.cat
[11:15:35] [ZeldaSwordSkills] [iNFO] Song finished - closing screen
[11:15:35] [ZeldaSwordSkills] [iNFO] Gui closed, stopping song
[11:15:35] [ZeldaSwordSkills] [iNFO] Sound already playing at -417/74/838; stopping sound

 

I'm very confused why the vanilla code works, but me using what seems to be the same code fails. As far as I can tell, it should be doing exactly the same thing.

Share this post

Link to post
Share on other sites

coolAlias    745

coolAlias
Posted

It sure does - I even checked if Minecraft.getMinecraft().getSoundHandler().isSoundPlaying(isound) is returning true in my client proxy method just now, and it does; judging from the SoundManager isSoundPlaying and stopSound methods, this should be enough to guarantee that the sound system is able to stop it.

 

EDIT: Okay, after listening carefully, the record IS stopping, but immediately starts playing again, whether using my custom method or the vanilla one... curiouser and curiouser :\  I'm 100% sure that I'm not playing the record anywhere else, but I'm going to look again anyway. So bizarre.

Share this post

Link to post
Share on other sites

coolAlias    745

coolAlias
Posted

I tried replacing the playRecord calls in my gui like so:

private ISound songTrack;

// trigger song:
songTrack = PositionedSoundRecord.func_147675_a(new ResourceLocation("records.mall"), x, y, z);
mc.getSoundHandler().playSound(songTrack);

// turn it off:
mc.getSoundHandler().stopSound(songTrack);

This has the exact same behavior as everything else - the music stops but immediately restarts from the beginning, even though I'm not playing the sound from anywhere else and the gui has closed. Any ideas why it might be doing this?

Share this post

Link to post
Share on other sites

coolAlias    745

coolAlias
Posted

Turns out that it IS playing twice, but not in the way one might think.

 

What's happening is that the sound system sends the stop notification, but the sound entry is still in the playingSounds Map - after the Gui closes in Minecraft#displayGuiScreen, it calls SoundHandler#resumeSounds -> SoundMananger#resumeAllSounds and finds the entry still there, for which it then calls SoundSystem#play.

 

I'm not exactly sure how "CommandQueue( new CommandObject( CommandObject.STOP, sourcename) );" works, but for whatever reason it is either not executing properly or something else is going awry.

 

The only thing in my code different from vanilla that I can see is I'm trying to stop the sound from a Gui and the game resumes sounds after it closes, so I'm going to try sending a packet back and forth to stop the sound instead of doing it from inside the Gui. StopAllSounds clears all of the sound maps, which is why it works no matter what.

 

I shall post back with results of my experiment shortly. Thanks again for helping out ;)

Share this post

Link to post
Share on other sites

coolAlias    745

coolAlias
Posted

Worked like a charm! Sent a packet when the Gui closes, then replied back to the client and shut the sound down from there. Thanks for getting me to use my IDE :D

Share this post

Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

×
Sign in to follow this  
Followers 0
Go To Topic Listing


  • Recently Browsing

    No registered users viewing this page.

  • Posts

    • thedarkcolour
      [1.14] Patching method with coremod in TreeFeature causes IncompatibleClassChangeError

      By thedarkcolour · Posted

      https://github.com/thedarkcolour/Future-MC/tree/1.14
    • Draco18s
      [1.14] layout of a modpack

      By Draco18s · Posted

      I'm pretty sure I've left some comments on his videos about the mistakes he's perpetuating, but its not like anyone reads those.
    • Choco
      [1.14.4] Modifying the containers & screens of vanilla entities

      By Choco · Posted

      Perfect. Thank you very much
    • diesieben07
      [1.14.4] Modifying the containers & screens of vanilla entities

      By diesieben07 · Posted

      You should use ObfuscationReflectionHelper for your reflection code and use SRG names, otherwise your reflection code won't work outside the development environment.
    • Choco
      [1.14.4] Modifying the containers & screens of vanilla entities

      By Choco · Posted

      That was where my confusion layed. There was no mention of SlotItemHandler anywhere whatsoever on the capabilities page, or really anywhere I did prior research before creating this thread. Knowing this now, it makes more sense and I've since resolved the issue No error, slot has been added and all works as intended. Do keep in mind that I'm going into these APIs entirely blind so I'm unfamiliar with them. What may seem simple to you in Forge 1.14 I have yet to learn. I appreciate the assistance.   I needed an instance of the horse from both the container and the screen when registering the slot in order to grab its capabilities, so that as well I had to retrieve reflectively. With all those changes being made, I've finalized on the following (and will be making changes to ensure the reflection is properly cached). private static final ResourceLocation HORSE_GUI_TEXTURES = new ResourceLocation("textures/gui/container/horse.png"); private static final Function<IItemHandler, Slot> SLOT_CREATOR = i -> new SlotItemHandler(i, 0, 8, 54); @SubscribeEvent public static void attachHorseCapabilities(AttachCapabilitiesEvent<Entity> event) { if (event.getObject() instanceof AbstractHorseEntity) { event.addCapability(new ResourceLocation(MOD_ID, "my_custom_capability_id"), new MyCustomIItemHandlerProvider()); } } @SubscribeEvent public static void addSlotServerSide(PlayerContainerEvent.Open event) { Container container = event.getContainer(); if (container instanceof HorseInventoryContainer) { AbstractHorseEntity horse = getHorseFromField(container, "horse"); IItemHandler itemHandler = horse.getCapability(MyCustomCapabilities.MY_CUSTOM_CAPABILITY).orElseThrow(IllegalStateException::new); addSlotToHorseContainer((HorseInventoryContainer) container, itemHandler, SLOT_CREATOR); } } @SubscribeEvent public static void addSlotClientSide(GuiOpenEvent event) { Screen screen = event.getGui(); if (screen instanceof HorseInventoryScreen) { AbstractHorseEntity horse = getHorseFromField(screen, "horseEntity"); IItemHandler itemHandler = horse.getCapability(MyCustomCapabilities.MY_CUSTOM_CAPABILITY).orElseThrow(IllegalStateException::new); addSlotToHorseContainer(((HorseInventoryScreen) screen).getContainer(), itemHandler, SLOT_CREATOR); } } @SubscribeEvent public static void renderExtraSlot(GuiContainerEvent.DrawBackground event) { ContainerScreen<?> screen = event.getGuiContainer(); if (screen instanceof HorseInventoryScreen) { GlStateManager.color4f(1.0F, 1.0F, 1.0F, 1.0F); Minecraft.getInstance().getTextureManager().bindTexture(HORSE_GUI_TEXTURES); int ySize = screen.getYSize(); int i = (screen.width - screen.getXSize()) / 2; int j = (screen.height - ySize) / 2; // screen x, screen y, texture x, texture y, width, height screen.blit(i + 7, j + 53, 0, ySize, 18, 18); } } private static void addSlotToHorseContainer(HorseInventoryContainer container, IItemHandler handler, Function<IItemHandler, Slot> slotCreator) { try { Method methodAddSlot = Container.class.getDeclaredMethod("addSlot", Slot.class); methodAddSlot.setAccessible(true); methodAddSlot.invoke(container, slotCreator.apply(handler)); } catch (ReflectiveOperationException e) { e.printStackTrace(); } } private static AbstractHorseEntity getHorseFromField(Object instance, String fieldName) { try { Field field = instance.getClass().getDeclaredField(fieldName); return (AbstractHorseEntity) ReflectionUtil.getFieldValue(field, instance); } catch (ReflectiveOperationException e) { e.printStackTrace(); } return null; } } If, aside from reflection caching, there is anything you feel needs changing, I'm open to critiques. Of course the name of my mod and a few classes were renamed. "MyCustomCapabilities" and other obviously poorly named classes and constants are named much more appropriately.

  • Topics

  • Who's Online (See full list)