Merge branch 'master' into Restored_behavior_of_.__filepath_prefix_in_legacy_compat_modes_

Author: MiranDMC

CHANGELOG.md

@@ -1,8 +1,11 @@
 ## 5.0.1
+- cleo.log file moved back to the game root (as in CLEO4)
 - Restored behavior of '.\\' prefix for scripts in legacy compat mode
+- fixed **0AB9 ([get_audio_stream_state](https://library.sannybuilder.com/#/sa/audio/0AB9))** not always returning Stopped, despite playback ended
+- fixed **2507 ([get_audio_stream_progress](https://library.sannybuilder.com/#/sa/audio/2507))** sometimes returning values smaller than 1.0, despite playback ended
+- fixed progress set with **2508 ([set_audio_stream_progress](https://library.sannybuilder.com/#/sa/audio/2508))** being ignored by stopped streams
 
 ## 5.0.0
-
 - support for CLEO modules feature https://github.com/sannybuilder/dev/issues/264
 - new [Audio](https://github.com/cleolibrary/CLEO5/tree/master/cleo_plugins/Audio) plugin
   - audio related opcodes moved from CLEO core into separated plugin
@@ -106,8 +109,7 @@
   - some errors now cause the script to pause, instead of crashing the game
 - updated included Silent's ASI Loader to version 1.3
 
-### Bug Fixes
-
+#### Bug Fixes
 - fixed error in **004E (terminate_this_script)** allowing to run multiple missions
 - fixed handling of strings longer than 128 characters causing errors in some cases
 - fixed error in handling of first string argument in **0AF5 (write_string to_ini_file)**
@@ -117,8 +119,7 @@
 - fixed invalid 7 characters length limit of **0AAA (get_script_struct_named)**
 - fixed an undefined behavior caused by **0459 (terminate_all_scripts_with_this_name)** when the name matches a custom script
 
-#### SDK AND PLUGINS
-
+#### SDK and plugins
 - now all opcodes in range **0-7FFF** can be registered by plugins
 - plugins moved to _cleo\cleo_plugins_ directory
 - new SDK methods:
@@ -154,19 +155,17 @@
   - CLEO_Log
 
 #### CLEO internal
-
 - introduced unit test scripts
 - project migrated to VS 2022
 - configured game debugging settings
 - plugins moved into single solution
 - configured automatic releases on GitHub
 - added setup_env.bat script
 
-#### Special Thanks
-
-- **123nir** for the alpha-testing, troubleshooting and valuable bug reports
-- **Hamal** for the beta-testing, troubleshooting and valuable bug reports
-
 ## Older
-
 For previous changes, see [CLEO4 changelog](https://github.com/cleolibrary/CLEO4/blob/master/CHANGELOG.md)
+
+## Special Thanks
+- **123nir** for the v5.0.0-alpha testing, troubleshooting and valuable bug reports
+- **Hamal** for the v5.0.0-beta testing, troubleshooting and valuable bug reports
+

README.md

@@ -10,29 +10,27 @@ Follow the instructions on the [release page](https://github.com/cleolibrary/CLE
 
 The ASI Loader replaces one original game file: `vorbisFile.dll` - be sure to make a backup of this file.
 CLEO itself does not replace any game file, however the following files and folders are added:
-
-- cleo\ (CLEO script directory)
-- cleo\\.cleo.log (main log file)
-- cleo\\.config\sa.json (opcodes info file)
-- cleo\cleo_plugins\SA.Audio.cleo (audio playback utilities powered by BASS.dll library)
-- cleo\cleo_plugins\SA.DebugUtils.cleo (script debugging utilities plugin)
-- cleo\cleo_plugins\SA.FileSystemOperations.cleo (disk drive files related operations plugin)
-- cleo\cleo_plugins\SA.IniFiles.cleo (.ini config files handling plugin)
-- cleo\cleo_plugins\SA.Math.cleo (additional math operations plugin)
-- cleo\cleo_plugins\SA.MemoryOperations.cleo (memory and .dll libraries utilities plugin)
-- cleo\cleo_plugins\SA.Text.cleo (text processing plugin)
-- cleo\cleo_saves\ (CLEO save directory)
-- cleo\cleo_text\ (CLEO text directory)
 - cleo.asi (core library)
+- cleo.log (main log file)
 - bass.dll (audio engine library)
+- cleo\\ (CLEO script directory)
+- cleo\\.config\\sa.json (opcodes info file)
+- cleo\\cleo_plugins\\SA.Audio.cleo (audio playback utilities powered by BASS.dll library)
+- cleo\\cleo_plugins\\SA.DebugUtils.cleo (script debugging utilities plugin)
+- cleo\\cleo_plugins\\SA.FileSystemOperations.cleo (disk drive files related operations plugin)
+- cleo\\cleo_plugins\\SA.IniFiles.cleo (.ini config files handling plugin)
+- cleo\\cleo_plugins\\SA.Math.cleo (additional math operations plugin)
+- cleo\\cleo_plugins\\SA.MemoryOperations.cleo (memory and .dll libraries utilities plugin)
+- cleo\\cleo_plugins\\SA.Text.cleo (text processing plugin)
+- cleo\\cleo_saves\\ (CLEO save directory)
+- cleo\\cleo_text\\ (CLEO text directory)
 
 All plugins are optional, however they may be required by various CLEO scripts.
 
 ## CLEO Scripts
 
 CLEO allows the installation of 'CLEO scripts', which often use the extension '.cs'. These third-party scripts are entirely user-made and are in no way supported by the developers of this library. While CLEO itself should work in a wide range of game installations, individual scripts are known to have their own compatibility restrictions and can not be guaranteed to work.
 CLEO scripts can be found on Grand Theft Auto fansites and modding sites such as:
-
 - https://libertycity.net/files/gta-san-andreas/mods/cleo-scripts/
 - https://www.gtainside.com/en/sanandreas/mods-322/
 - http://hotmist.ddo.jp/cleomod/index.html

cleo_plugins/Audio/CAudioStream.cpp

@@ -15,7 +15,7 @@ CAudioStream::CAudioStream(const char* filepath)
         return;
     }
 
-    unsigned flags = BASS_SAMPLE_SOFTWARE;
+    unsigned flags = BASS_SAMPLE_SOFTWARE | BASS_STREAM_PRESCAN;
     if (CSoundSystem::useFloatAudio) flags |= BASS_SAMPLE_FLOAT;
 
     if (!(streamInternal = BASS_StreamCreateFile(FALSE, filepath, 0, 0, flags)) &&
@@ -71,22 +71,27 @@ float CAudioStream::GetLength() const
 
 void CAudioStream::SetProgress(float value)
 {
+    if (GetState() == Stopped)
+    {
+        state = Paused; // resume from set progress
+    }
+
     value = std::clamp(value, 0.0f, 1.0f);
-    auto total = BASS_ChannelGetLength(streamInternal, BASS_POS_BYTE);
-    auto bytePos = QWORD(value * total);
+    auto bytePos = BASS_ChannelSeconds2Bytes(streamInternal, GetLength() * value);
+
     BASS_ChannelSetPosition(streamInternal, bytePos, BASS_POS_BYTE);
 }
 
 float CAudioStream::GetProgress() const
 {
-    auto total = BASS_ChannelGetLength(streamInternal, BASS_POS_BYTE); // returns -1 on error
-    auto bytePos = BASS_ChannelGetPosition(streamInternal, BASS_POS_BYTE); // returns -1 on error
-
+    auto bytePos = BASS_ChannelGetPosition(streamInternal, BASS_POS_BYTE);
     if (bytePos == -1) bytePos = 0; // error or not available yet
+    auto pos = BASS_ChannelBytes2Seconds(streamInternal, bytePos);
 
-    float progress = (float)bytePos / total;
-    progress = std::clamp(progress, 0.0f, 1.0f);
-    return progress;
+    auto byteTotal = BASS_ChannelGetLength(streamInternal, BASS_POS_BYTE);
+    auto total = BASS_ChannelBytes2Seconds(streamInternal, byteTotal);
+
+    return (float)(pos / total);
 }
 
 CAudioStream::eStreamState CAudioStream::GetState() const
@@ -240,10 +245,12 @@ void CAudioStream::Process()
         BASS_ChannelPlay(streamInternal, FALSE);
         state = Playing;
     }
-
-    if (!GetLooping() && GetProgress() >= 1.0f) // end reached
+    else
     {
-        state = Stopped;
+        if (state == Playing && BASS_ChannelIsActive(streamInternal) == BASS_ACTIVE_STOPPED) // end reached
+        {
+            state = Stopped;
+        }
     }
 
     if (state != Playing) return; // done

cleo_plugins/Audio/CAudioStream.h

@@ -5,6 +5,7 @@
 
 namespace CLEO
 {
+#pragma pack(push,4)
     class CAudioStream
     {
     public:
@@ -73,4 +74,5 @@ namespace CLEO
         void UpdateVolume();
         void UpdateSpeed();
     };
+#pragma pack(pop)
 }

cleo_plugins/Audio/SA.Audio.ini

@@ -1,5 +1,5 @@
 [General]
-; Manually select audio device. See `.cleo.log` file to check list of available options. -1 for automatic
+; Manually select audio device. See `cleo.log` file to check list of available options. -1 for automatic
 AudioDevice=-1
 
 ; Allow playing streams from http(s) locations

examples/Color_Blend.txt

@@ -0,0 +1,144 @@
+// CLEO5 example script
+// Sanny Builder 4
+// mode: GTA SA (v1.0 - SBL)
+{$CLEO .cs}
+
+script_name {name} 'colgrad'
+
+const Panel_Count = 120 // limit is 128 per script
+const Panel_Width = 5.2
+
+int lastPanelIdx = Panel_Count - 1
+int middleKeyIdx
+int colorStart[3] // red, green, blue
+int colormiddle[3] // red, green, blue
+int colorEnd[3] // red, green, blue
+
+int iTmp
+float fTmp
+
+TimerA = 3000
+while true
+    wait {time} 0
+    
+    // randomize colors every 3 seconds
+    if
+        TimerA > 3000
+    then
+        colorStart[0] = generate_random_int_in_range {min} 0x00 {max} 0xFF
+        colorStart[1] = generate_random_int_in_range {min} 0x00 {max} 0xFF
+        colorStart[2] = generate_random_int_in_range {min} 0x00 {max} 0xFF
+        
+        colormiddle[0] = generate_random_int_in_range {min} 0x00 {max} 0xFF
+        colormiddle[1] = generate_random_int_in_range {min} 0x00 {max} 0xFF
+        colormiddle[2] = generate_random_int_in_range {min} 0x00 {max} 0xFF
+        
+        colorEnd[0] = generate_random_int_in_range {min} 0x00 {max} 0xFF
+        colorEnd[1] = generate_random_int_in_range {min} 0x00 {max} 0xFF
+        colorEnd[2] = generate_random_int_in_range {min} 0x00 {max} 0xFF
+        
+        middleKeyIdx = generate_random_int_in_range {min} 0 {max} lastPanelIdx
+        
+        TimerA = 0
+    end
+        
+    // draw on screen
+    use_text_commands {state} true
+        
+    float posX = 10.0 // start pos
+    int i = 0
+    while i < Panel_Count
+        // select color
+        int color[3]
+        switch i
+            case 0 // start panel
+                color[0] = colorStart[0]
+                color[1] = colorStart[1]
+                color[2] = colorStart[2]
+                
+            case middleKeyIdx // middle color
+                color[0] = colormiddle[0]
+                color[1] = colormiddle[1]
+                color[2] = colormiddle[2]
+                
+            case lastPanelIdx
+                color[0] = colorEnd[0]
+                color[1] = colorEnd[1]
+                color[2] = colorEnd[2]
+                
+            default // for other panels we have to calculate blend color
+                float progress
+                if
+                    i < middleKeyIdx
+                then
+                    // blending start to middle
+                    progress =# i // current
+                    fTmp =# middleKeyIdx // total
+                    progress /= fTmp // 0.0 - 1.0 range
+                    
+                    color[0] = LERP_INT(colorStart[0], colormiddle[0], progress) // red
+                    color[1] = LERP_INT(colorStart[1], colormiddle[1], progress) // green
+                    color[2] = LERP_INT(colorStart[2], colormiddle[2], progress) // blue
+                else
+                    // blending middle to end
+                    iTmp = i - middleKeyIdx
+                    progress =# iTmp // current
+                    
+                    iTmp = lastPanelIdx - middleKeyIdx
+                    fTmp =# iTmp // total
+                    
+                    progress /= fTmp // 0.0 - 1.0 range
+                    
+                    color[0] = LERP_INT(colormiddle[0], colorEnd[0], progress) // red
+                    color[1] = LERP_INT(colormiddle[1], colorEnd[1], progress) // green
+                    color[2] = LERP_INT(colormiddle[2], colorEnd[2], progress) // blue
+                end
+        end
+    
+        // draw
+        if or
+            i == 0 // start panel
+            i == middleKeyIdx
+            i == lastPanelIdx
+        then
+            draw_rect {pos} posX 240.0 {size} Panel_Width 80.0 {rgb} color[0] color[1] color[2] {alpha} 240 // tall panel
+        else
+            draw_rect {pos} posX 240.0 {size} Panel_Width 40.0 {rgb} color[0] color[1] color[2] {alpha} 240 // regular panel
+        end
+            
+        // prepare next
+        i += 1
+        posX += Panel_Width
+    end
+     
+end
+terminate_this_custom_script
+
+
+// linear interpolation (or extrapolation) of two float values
+function LERP_FLOAT(valueA :float, valueB :float, progress :float): float
+    float invProgress = 1.0
+    invProgress -= progress
+    
+    valueA *= invProgress
+    valueB *= progress
+    
+    float result
+    result += valueA
+    result += valueB
+    
+    return result
+end
+
+
+// linear interpolation (or extrapolation) of two integer values
+function LERP_INT(valueA: int, valueB: int, progress: float): int
+    float aF =# valueA // to float
+    float bF =# valueB // to float
+    
+    float fResult = LERP_FLOAT(aF, bF, progress)
+    
+    int result =# fResult // to integer
+    
+    return result
+end

examples/Pickup_Shirt.txt

@@ -1,3 +1,4 @@
+// CLEO5 example script
 // Sanny Builder 4
 // mode: GTA SA (v1.0 - SBL)
 

source/stdafx.h

@@ -58,7 +58,7 @@ inline const std::string Filepath_Game = GetGameDirectory();
 inline const std::string Filepath_User = GetUserDirectory();
 inline const std::string Filepath_Cleo = Filepath_Game + "\\cleo";
 inline const std::string Filepath_Config = Filepath_Cleo + "\\.cleo_config.ini";
-inline const std::string Filepath_Log = Filepath_Cleo + "\\.cleo.log";
+inline const std::string Filepath_Log = Filepath_Game + "\\cleo.log";
 
 #define NUM_SCAN_ENTITIES 16
 

tests/.cleo_tests_runner.txt

@@ -13,6 +13,8 @@ clear_prints
 
 RUN_TESTS_DIR("cleo:", "cleo_tests")
 
+trace ""
+trace "All tests done"
 print_big_string {text} "DONE" {time} 5000 {style} TextStyle.MiddleSmaller
 
 terminate_this_custom_script