Add Music functionality #598

fishykins · 2017-02-23T11:04:01Z

This merge will incorporate musical functions for the handling of playback.
-Generic functions for searching and categorizing music, monitoring/initiating playback.
-Standardization of new config entries "Type" and "Tags", allowing for more dynamic music selection.
While this may seem trivial, many mod and mission makers rely on music in their projects. Standardizing how this is done seems the logical step!

EDIT- I took down my last pull request as the branch was incorrectly named. Sorry for the repeat

jonpas · 2017-02-23T11:13:49Z

No one cares about the branch name. :P

fishykins · 2017-02-23T12:09:02Z

good to know... thanks!

dedmen · 2017-03-09T12:58:38Z

addons/music/fnc_playMusic.sqf

+private _duration = [_className,"duration"] call CBA_fnc_getMusicData;
+
+if (!isNil "_duration") then {
+    if (_time < _duration) then {


you could make this an exitWith instead of a then. That way you could completly remove the _return variable and just return false in line 51.
But readability may suffer if you do this. not sure.

Style question. Both methods have their downsides. This is fine too.

Or just use try {} catch {}; :D

dedmen · 2017-03-09T12:59:14Z

addons/music/fnc_stopMusic.sqf

+    none
+
+Returns:
+    BOOL: true if music was stopped, false if already stopped


This return value is useless as it doesn't return false anymore.

Functions that "do stuff" as opposed to setter functions report usually nothing / nil in SQF, but true is ok too.

Dorbedo · 2017-03-09T12:43:45Z

addons/music/fnc_compileMusic.sqf

+        };
+    };
+
+    for [{_i=0}, {_i < (count _missionConfig)}, {INC(_i)}] do {


filtering via configProperties could be suitable too
e.g.:

private _allMusic = configProperties [MissionConfigFile >> "CfgMusic", "getNumber(_x>>'duration')>0",true]; _allMusic append configProperties [configFile >> "CfgMusic", "getNumber(_x>>'duration')>0",true]; private _unsortedSongs = []; {_unsortedSongs pushBackUnique _x;} count _allMusic;

That's better by a mile

Dorbedo · 2017-03-09T12:45:01Z

addons/music/fnc_stopMusic.sqf

+Function: CBA_fnc_stopMusic
+
+Description:
+    A function used to stop any music playing. Must have been started with CBA_fnc_playMusic, otherwise it is ignored. 


the header needs an update due to changed behavior.

Dorbedo · 2017-03-09T12:45:44Z

addons/music/fnc_stopMusic.sqf

+    none
+
+Returns:
+    BOOL: true if music was stopped, false if already stopped


there is no need to return anymore

Dorbedo · 2017-03-09T12:46:15Z

addons/music/fnc_stopMusic.sqf

+
+playMusic ["",0];
+GVAR(track) = nil;
+true 


true can be left out

Disagree. No function should end with an assignment operator. At least return nil. Returning the assignment operator has a bug in SQF.

_a = call { _b = 1; };

>generic error in expression

_a = call { _b = 1; nil };

>no error, _a is undefined.

Dorbedo · 2017-03-09T12:57:22Z

addons/music/fnc_getMusicPath.sqf

+
+if (!params [["_className","",[""]]]) exitWith {WARNING('No classname was provided');};
+
+private _config = configFile >> 'CfgMusic' >> _className;


the order of the config-files has to be switched.
playMusic prefers the missionConfigFile
The same way this function should behave.

Agreed. mission should overwrite addon.

Dorbedo · 2017-03-09T13:00:14Z

addons/music/fnc_compileMusic.sqf

+        };
+    };
+
+    GVARMAIN(compiledMusic) = _unsortedSongs;


this value can contain double entries. (same name inside missionconfig and config)
I think, this should not be the case.

Dorbedo · 2017-03-09T13:08:25Z

addons/music/fnc_findMusic.sqf

+                //No tags required so add it
+                _results pushBack _track;
+            };
+        }


; is missing

Dorbedo · 2017-03-09T13:12:48Z

addons/music/fnc_isMusicPlaying.sqf

+Function: CBA_fnc_isMusicPlaying
+
+Description:
+    A function used to return the current time on playing music. Must have been started with CBA_fnc_playMusic


This header needs an update ;-)

fishykins · 2017-03-09T21:29:42Z

Opinions please: should the functions be passing around music as config, or as a class name?

fishykins · 2017-03-09T22:26:31Z

I have included CfgMusic, which updates all base arma 3 music. This does two things: firstly it brings all music up BIS's own formatting standards (lots of music was lacking in detail) and secondly it adds "tags", allowing for a broader search criteria.

fishykins · 2017-03-15T12:09:53Z

so now what?

commy2 · 2017-03-15T21:05:14Z

Now someone must test it I guess. MP and all.

Dorbedo · 2017-03-15T21:29:39Z

addons/music/fnc_compileMusic.sqf

+
+if (isNil QGVARMAIN(compiledMusic)) then {
+    private _config = configFile >> 'CfgMusic';
+    private _missionConfig = missionConfigFile >> 'CfgMusic';


Theses Values are not used

Killswitch00 · 2017-03-18T08:17:25Z

addons/music/CfgFunctions.hpp

+            // CBA_fnc_findMusic
+            class findMusic
+            {
+                description = "Find music of spesified type";


"specific" (or "specified")

Killswitch00 · 2017-03-18T08:21:18Z

addons/music/fnc_playMusic.sqf

+
+Parameters:
+    1: CLASS or CONFIG- music to play
+    2: INT- Position to play from (default: 0)


Explain what unit the position is measured in (seconds?)

Killswitch00 · 2017-03-18T08:22:29Z

addons/music/fnc_playMusic.sqf

+Parameters:
+    1: CLASS or CONFIG- music to play
+    2: INT- Position to play from (default: 0)
+    3: BOOL- allowed to interupt already playing music (default: true)


Killswitch00 · 2017-03-18T08:23:09Z

addons/music/fnc_playMusic.sqf

+    3: BOOL- allowed to interupt already playing music (default: true)
+
+Returns:
+    BOOL- true if started playing music


true if music started playing

Killswitch00 · 2017-03-29T17:31:45Z

What commy2 said - needs MP testing.

commy2 · 2017-04-15T12:53:16Z

Sorry, I don't want this for the next update, which already had a release candidate. But I'll test and merge this into master as soon as 3.3 is released.

commy2 · 2017-05-01T02:38:19Z

Can be merged after v3.3 is released. Don't want to do it now to keep master==release branch.

dedmen · 2018-04-20T16:29:02Z

This should be extended using the new https://community.bistudio.com/wiki/getMusicPlayedTime command. Could return when the current song is over. or could be used for reliable autoplay in a playlist.

fishykins added 25 commits February 22, 2017 23:04

Create config.cpp

9626a95

Create CfgMusic.hpp

c1967a7

Create CfgFunctions.hpp

0bd367b

Create script_component.hpp

410492c

Create fnc_compileMusic.sqf

9ab739b

Create fnc_getMusicData.sqf

a67a6e0

Create fnc_getMusicPath.sqf

c35da7d

Create fnc_getMusicPlaying

3819c2b

Rename fnc_getMusicPlaying to fnc_getMusicPlaying.sqf

06d55d2

Create fnc_playMusic.sqf

097c336

Create fnc_searchMusic.sqf

25c8fef

Create fnc_stopMusic.sqf

aaaeed6

Update script_component.hpp

7aa2ddb

Update fnc_compileMusic.sqf

e3b5447

Update config.cpp

3957e01

Update CfgFunctions.hpp

3c2b703

Update fnc_getMusicData.sqf

5ae06cd

Update fnc_getMusicPath.sqf

e66ad53

Update fnc_getMusicPlaying.sqf

fb596b6

Update fnc_playMusic.sqf

9615d2b

Update fnc_searchMusic.sqf

924d38c

Update fnc_stopMusic.sqf

6258a15

Update CfgFunctions.hpp

e22e983

Update fnc_searchMusic.sqf

befaa7d

Update CfgMusic.hpp

45bded6

fishykins changed the title ~~Music~~ Add Music functionality Feb 23, 2017

commy2 added WIP Feature labels Feb 23, 2017

dedmen reviewed Mar 9, 2017

View reviewed changes

Dorbedo reviewed Mar 9, 2017

View reviewed changes

fishykins added 2 commits March 9, 2017 22:11

Tweaked as per comments

c4c2add

Fixed tabs in CfgMusic

2f42698

commy2 removed the WIP label Mar 15, 2017

commy2 added this to the 3.3 milestone Mar 15, 2017

Dorbedo reviewed Mar 15, 2017

View reviewed changes

Killswitch00 reviewed Mar 18, 2017

View reviewed changes

Fixed some typos

d87b29f

Killswitch00 approved these changes Mar 29, 2017

View reviewed changes

fishykins added 3 commits April 10, 2017 16:41

support for APEX music+ minor improvements

29c0d88

Improved getMusicData, tidied up headers

309d43d

tabs fix

de10876

commy2 modified the milestones: 3.4, 3.3 Apr 15, 2017

commy2 merged commit 4048d33 into CBATeam:master May 7, 2017

dedmen mentioned this pull request Jul 29, 2019

Put tags in CfgMusic.hpp into quotes #1192

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Music functionality #598

Add Music functionality #598

fishykins commented Feb 23, 2017

jonpas commented Feb 23, 2017

fishykins commented Feb 23, 2017

dedmen Mar 9, 2017

commy2 Mar 9, 2017

pixlcrashr Apr 9, 2017

dedmen Mar 9, 2017

commy2 Mar 9, 2017

Dorbedo Mar 9, 2017 •

edited

Loading

fishykins Mar 9, 2017

Dorbedo Mar 9, 2017

Dorbedo Mar 9, 2017

Dorbedo Mar 9, 2017

commy2 Mar 9, 2017 •

edited

Loading

Dorbedo Mar 9, 2017

commy2 Mar 9, 2017

Dorbedo Mar 9, 2017

Dorbedo Mar 9, 2017

Dorbedo Mar 9, 2017

fishykins commented Mar 9, 2017

fishykins commented Mar 9, 2017

fishykins commented Mar 15, 2017

commy2 commented Mar 15, 2017

Dorbedo Mar 15, 2017

Killswitch00 Mar 18, 2017 •

edited

Loading

Killswitch00 Mar 18, 2017 •

edited

Loading

Killswitch00 Mar 18, 2017

Killswitch00 Mar 18, 2017

Killswitch00 commented Mar 29, 2017

commy2 commented Apr 15, 2017

commy2 commented May 1, 2017

dedmen commented Apr 20, 2018


		if (!params [["_className","",[""]]]) exitWith {WARNING('No classname was provided');};

		private _config = configFile >> 'CfgMusic' >> _className;

Add Music functionality #598

Add Music functionality #598

Conversation

fishykins commented Feb 23, 2017

jonpas commented Feb 23, 2017

fishykins commented Feb 23, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Dorbedo Mar 9, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

commy2 Mar 9, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fishykins commented Mar 9, 2017

fishykins commented Mar 9, 2017

fishykins commented Mar 15, 2017

commy2 commented Mar 15, 2017

Choose a reason for hiding this comment

Killswitch00 Mar 18, 2017 • edited Loading

Choose a reason for hiding this comment

Killswitch00 Mar 18, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Killswitch00 commented Mar 29, 2017

commy2 commented Apr 15, 2017

commy2 commented May 1, 2017

dedmen commented Apr 20, 2018

Dorbedo Mar 9, 2017 •

edited

Loading

commy2 Mar 9, 2017 •

edited

Loading

Killswitch00 Mar 18, 2017 •

edited

Loading

Killswitch00 Mar 18, 2017 •

edited

Loading