Prevent sounds being produced by inactive industries #7752

abmyii · 2019-09-27T21:16:43Z

nielsmh · 2019-09-28T05:59:23Z

Hmm, all the regression tests are failing, and the reason must be because the consumption of random numbers has changed. Notice there is a Chance16 call in the branch of the if no longer taken when production is zero. Since that gets skipped, the RNG for the rest of the game gets out of sync with the "expected". This isn't wrong, but it makes the output for the purpose of regression testing different.

Additionally, the commit checker is rejecting your commit because the commit message does not start with a keyword. (See this about commit messages.) Update the commit message with git commit --amend and force-push, Github handles that just fine.
Suggestion: Fix #7703: Prevent sounds being produced by inactive industries

abmyii · 2019-09-28T08:31:40Z

In that case should I let Chance16 be called then check last_month_production before playing sounds?

abmyii · 2019-09-28T08:35:40Z

Sorry about the merge commit - I cloned the main repository (this) rather than my fork, so the merge took place when I pulled before amending. Still trying to find my way around with git!

abmyii · 2019-09-28T09:31:36Z

I tried make test to test my changes but I kept on getting this error despite everything I tried:
+Error: Failed to find a graphics set. Please acquire a graphics set for OpenTTD. See section 4.1 of README.md.

src/industry_cmd.cpp

J0anJosep · 2019-09-28T14:28:43Z

El ds. 28 de set. de 2019 15.50, glx22 <notifications@github.com> va escriure:

…

***@***.**** commented on this pull request. ------------------------------ In src/industry_cmd.cpp <#7752 (comment)>: > @@ -1125,7 +1125,7 @@ static void ProduceIndustryGoods(Industry *i) if ((i->counter & 0x3F) == 0) { uint32 r; uint num; - if (Chance16R(1, 14, r) && (num = indsp->number_of_sounds) != 0 && _settings_client.sound.ambient) { + if (Chance16R(1, 14, r) && (num = indsp->number_of_sounds) != 0 && _settings_client.sound.ambient && *i->last_month_production > 0) { Oh my bad, i->last_month_production is an array (= a pointer) so by dereferencing you effectively access i->last_month_production[0] — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#7752?email_source=notifications&email_token=AAYBYXUT66KULNFIWSM6K5TQL5OLTA5CNFSM4I3K7KGKYY3PNVWWK3TUL52HS4DFWFIHK3DMKJSXC5LFON2FEZLWNFSXPKTDN5WW2ZLOORPWSZGOCGH5CII#discussion_r329311028>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAYBYXWF76MDVFMYXJOOVYLQL5OLTANCNFSM4I3K7KGA> .

andythenorth · 2019-09-29T06:52:44Z

Is it defined what 'inactive' is for a newgrf industry? :)

abmyii · 2019-09-29T10:09:11Z

@andythenorth

Is it defined what 'inactive' is for a newgrf industry? :)

I assume so, but I haven't tested it yet. I take it you have already done so?

abmyii · 2019-09-29T10:21:07Z

I tried with FIRS Replacement Set 3, however it doesn't seem to have any industry sounds - I didn't hear anything anyway.

andythenorth · 2019-09-30T08:21:48Z

For newgrf industry, there is simply no way to know in advance what behaviour is defined 'inactive'.

I don't think industry sounds are particularly important for newgrf, but I am just one opinion.

But if this PR is merged, it would be worth noting in the newgrf docs (nfo and nml) that sound effects aren't purely random, and may never trigger for newgrf industries. Potentially a newgrf author could spend a long time investigating why sound effects don't work / no longer work as expected.

abmyii · 2019-09-30T09:55:15Z

True, I never thought of that - being new to the inner workings of OpenTTD. Where/how would that be documented? Also, surely the definition of inactivity chosen (last month's production) should be fairly ubiquitously applicable?
Thanks for all of the insight you have provided!

andythenorth · 2019-09-30T12:29:23Z

Relevant newgrf docs are:

'random_sound_effects' https://newgrf-specs.tt-wiki.net/wiki/NML:Industries#Industry_properties
property 15 'Random sound effects' https://newgrf-specs.tt-wiki.net/wiki/Action0/Industries#Random_sound_effects_.2815.29

They don't promise more than sound is played 'sometimes', and just need a note explaining the conditions under which sounds won't be played. That wouldn't need doing unless the PR is accepted.

I would not mind never hearing the sawmill noise ever again, but maybe that's just me 😃

abmyii · 2019-09-30T13:19:33Z

Should that be part of this PR? Also, is there a repo for the wiki or should the editions be done on the wiki itself (I expect this is the correct method)?

abmyii · 2019-09-30T13:25:51Z

I would not mind never hearing the sawmill noise ever again, but maybe that's just me smiley

Haha! Funnily enough I've always played without sound since I never could be bothered to take the extra steps of downloading and enabling the sounds.

abmyii · 2019-10-01T21:47:22Z

Any updates on what else needs to be done to this PR?

abmyii · 2019-10-06T16:49:46Z

Any follow-up?

glx22 · 2019-10-06T17:18:44Z

I still fail to understand why the commit checker was successful, but you'll need to use git rebase -i HEAD~6 to squash all your commits into one.

abmyii · 2019-10-06T18:46:27Z

Thanks for that. I've applied it and pushed. Hopefully it works this time!

abmyii · 2019-10-06T21:27:00Z

Changes made to check all of the industry's outputs.

abmyii · 2019-10-06T22:13:31Z

I can't seem to fix this tab indentation (of all things) despite my efforts. Any ideas?

glx22 · 2019-10-06T22:24:46Z

You need to fix it in the commit introducing the wrong indentation, as the commit checker checks the diffs individually

abmyii · 2019-10-06T22:49:00Z

Oh my, may I ask what the easiest way to do that would be? Sorry for my basic questions and thanks for all your help!

glx22 · 2019-10-06T23:00:01Z

The easiest way is to rebase, but it seems your previous rebase somehow failed. I can force push a rebase on your branch if you want.

abmyii · 2019-10-06T23:00:51Z

Yes, please!

src/industry_cmd.cpp

abmyii · 2019-10-06T23:22:02Z

Thank you for resolving that problem @glx22! I believe that now the PR should be complete (hopefully!).

src/industry_cmd.cpp

abmyii · 2019-10-06T23:36:19Z

Sorry for tiring you with such trivial problems throughout @glx22. You've been a great help!

glx22 · 2019-10-06T23:43:23Z

Arg, github commits don't follow our style. But it's easily fixable with git commit --amend and a forced push. Do you want to try it ?

abmyii · 2019-10-07T18:17:22Z

Done, thanks for the tip.

planetmaker · 2019-10-07T18:35:03Z

I've one question regarding black-hole industries (that is industries which only receive cargo but don't produce anything like power plants): I don't see how they will be able to make sounds with this patch. Do I miss something?
If not, please also add as an or-condition a check for received cargo :)

abmyii · 2019-10-07T18:37:41Z

It doesn't apply to them, since I can hear their sounds despite no cargo being transported to them. I never bothered checking why, but I expect the i->last_month_production is never 0 for them.
Thanks for your input!

abmyii · 2019-10-07T18:50:38Z

Haha, you made me curious and I couldn't help but check. As was mentioned in the issue, the code for the power station sound is here:

OpenTTD/src/industry_cmd.cpp

Lines 893 to 898 in b50aeff

    
           case GFX_POWERPLANT_SPARKS: 
        
           	if (Chance16(1, 3)) { 
        
           		if (_settings_client.sound.ambient) SndPlayTileFx(SND_0C_ELECTRIC_SPARK, tile); 
        
           		AddAnimatedTile(tile); 
        
           	} 
        
           	break;

Whereas the code for the production sounds is in the function ProduceIndustryGoods:

OpenTTD/src/industry_cmd.cpp

Lines 1120 to 1139 in b50aeff

    
           static void ProduceIndustryGoods(Industry *i) 
        
           { 
        
           	const IndustrySpec *indsp = GetIndustrySpec(i->type); 
        
           	/* play a sound? */ 
        
           	if ((i->counter & 0x3F) == 0) { 
        
           		uint32 r; 
        
           		uint num; 
        
           		if (Chance16R(1, 14, r) && (num = indsp->number_of_sounds) != 0 && _settings_client.sound.ambient) { 
        
           			for (size_t j = 0; j < lengthof(i->last_month_production); j++) { 
        
           				if (i->last_month_production[j] > 0) { 
        
           					/* Play sound since last month had production */ 
        
           					SndPlayTileFx( 
        
           						(SoundFx)(indsp->random_sounds[((r >> 16) * num) >> 16]), 
        
           						i->location.tile); 
        
           					break; 
        
           				} 
        
           			} 
        
           		} 
        
           	}

This does raise another question though - are there any NewGRF/extension packs with black-hole industries that play their sounds through the ProduceIndustryGoods function? I doubt it but I am not very familiar with how they work. If it was the case, what would be checked to identify one?

planetmaker · 2019-10-07T18:55:46Z

ah, right. Looking at the broader context (that is beyond the patch), that function is only called for producing industries. :) And the accepting default industries are handled via the tile loop separately :) Cheers!

EDIT: NewGRFs can also make use of the tile loop. or run callback on receiving cargo at which time they can play a sound.

But you actually pointed out the place an additional patch might go: making the blackhole industries kinda inactive unless they actually receive something to eat :D (But if so: that's for a separate PR)

abmyii · 2019-10-07T19:00:58Z

Great, thanks again!

abmyii · 2019-10-07T21:49:53Z

@planetmaker With regards to the point you added, that'd have to be done by someone with a better idea of how the engine works since I expect that a new attribute will have to be added, unless there is a more obvious way that I don't know?

abmyii · 2019-10-08T22:41:15Z

Anything else required for this PR?

src/industry_cmd.cpp

abmyii · 2019-10-09T20:28:06Z

Thanks for the approval! What else is remaining?

LordAro · 2019-10-09T20:50:34Z

Patience :p

abmyii · 2019-10-09T20:56:39Z

Haha, and I thought it would only require changing one or two lines and be done in a day!
I'm still not used to the PRing and I expect this isn't an abnormally long time to wait, but my preconceived expectations will obviously need adjusting. Pardon my impatience!

abmyii · 2019-10-11T22:43:15Z

Have I been patient long enough (wink)?

abmyii · 2019-10-12T09:46:16Z

Great, thanks a lot!

OpenTTD#7752)

glx22 reviewed Sep 28, 2019

View reviewed changes

src/industry_cmd.cpp Outdated Show resolved Hide resolved

Fix OpenTTD#7703: Prevent sounds being produced by inactive industries

e738181

glx22 force-pushed the fix_inactive_sounds branch from fe7d9b0 to e738181 Compare October 6, 2019 23:04

PeterN reviewed Oct 6, 2019

View reviewed changes

src/industry_cmd.cpp Outdated Show resolved Hide resolved

Fix OpenTTD#7703: Refactor code

50834c2

glx22 reviewed Oct 6, 2019

View reviewed changes

src/industry_cmd.cpp Outdated Show resolved Hide resolved

Fix OpenTTD#7703: Correct style for comment

b50aeff

abmyii force-pushed the fix_inactive_sounds branch from b4eb561 to b50aeff Compare October 7, 2019 09:46

LordAro reviewed Oct 9, 2019

View reviewed changes

src/industry_cmd.cpp Outdated Show resolved Hide resolved

Fix OpenTTD#7703: Remove unused variable

5d01f3a

LordAro approved these changes Oct 9, 2019

View reviewed changes

nielsmh merged commit ac21118 into OpenTTD:master Oct 12, 2019

abmyii deleted the fix_inactive_sounds branch October 12, 2019 09:46

douiwby pushed a commit to douiwby/OpenTTD that referenced this pull request Apr 16, 2020

Fix OpenTTD#7703: Prevent sounds being produced by inactive industries (

0db3124

OpenTTD#7752)

Prevent sounds being produced by inactive industries #7752

Prevent sounds being produced by inactive industries #7752

Conversation

abmyii commented Sep 27, 2019

nielsmh commented Sep 28, 2019 • edited Loading

abmyii commented Sep 28, 2019

abmyii commented Sep 28, 2019

abmyii commented Sep 28, 2019

J0anJosep commented Sep 28, 2019 via email

andythenorth commented Sep 29, 2019 • edited Loading

abmyii commented Sep 29, 2019 • edited Loading

abmyii commented Sep 29, 2019

andythenorth commented Sep 30, 2019 • edited Loading

abmyii commented Sep 30, 2019 • edited Loading

andythenorth commented Sep 30, 2019 • edited Loading

abmyii commented Sep 30, 2019

abmyii commented Sep 30, 2019 • edited Loading

abmyii commented Oct 1, 2019 • edited Loading

abmyii commented Oct 6, 2019

glx22 commented Oct 6, 2019

abmyii commented Oct 6, 2019

abmyii commented Oct 6, 2019

abmyii commented Oct 6, 2019

glx22 commented Oct 6, 2019

abmyii commented Oct 6, 2019 • edited Loading

glx22 commented Oct 6, 2019

abmyii commented Oct 6, 2019

abmyii commented Oct 6, 2019 • edited Loading

abmyii commented Oct 6, 2019

glx22 commented Oct 6, 2019

abmyii commented Oct 7, 2019

planetmaker commented Oct 7, 2019

abmyii commented Oct 7, 2019

abmyii commented Oct 7, 2019

planetmaker commented Oct 7, 2019 • edited Loading

abmyii commented Oct 7, 2019

abmyii commented Oct 7, 2019

abmyii commented Oct 8, 2019

abmyii commented Oct 9, 2019

LordAro commented Oct 9, 2019

abmyii commented Oct 9, 2019 • edited Loading

abmyii commented Oct 11, 2019

abmyii commented Oct 12, 2019

nielsmh commented Sep 28, 2019 •

edited

Loading

andythenorth commented Sep 29, 2019 •

edited

Loading

abmyii commented Sep 29, 2019 •

edited

Loading

andythenorth commented Sep 30, 2019 •

edited

Loading

abmyii commented Sep 30, 2019 •

edited

Loading

andythenorth commented Sep 30, 2019 •

edited

Loading

abmyii commented Sep 30, 2019 •

edited

Loading

abmyii commented Oct 1, 2019 •

edited

Loading

abmyii commented Oct 6, 2019 •

edited

Loading

abmyii commented Oct 6, 2019 •

edited

Loading

planetmaker commented Oct 7, 2019 •

edited

Loading

abmyii commented Oct 9, 2019 •

edited

Loading