Compare commits
88
Commits
2f6839bcc4
...
main
No files matched your search
+2
-1
@@ -106,4 +106,5 @@ yarn.lock
|
|||||||
/build*
|
/build*
|
||||||
/assets/test
|
/assets/test
|
||||||
/tools_old
|
/tools_old
|
||||||
/assets/test.png
|
/assets/test.png
|
||||||
|
/assets/audio/boa.mp3
|
||||||
+29
-13
@@ -8,7 +8,10 @@ cmake_minimum_required(VERSION 3.13)
|
|||||||
|
|
||||||
set(CMAKE_C_STANDARD 11)
|
set(CMAKE_C_STANDARD 11)
|
||||||
set(CMAKE_C_STANDARD_REQUIRED ON)
|
set(CMAKE_C_STANDARD_REQUIRED ON)
|
||||||
set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules)
|
set(CMAKE_MODULE_PATH
|
||||||
|
${CMAKE_MODULE_PATH}
|
||||||
|
${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules
|
||||||
|
)
|
||||||
cmake_policy(SET CMP0079 NEW)
|
cmake_policy(SET CMP0079 NEW)
|
||||||
# set(FETCHCONTENT_UPDATES_DISCONNECTED ON)
|
# set(FETCHCONTENT_UPDATES_DISCONNECTED ON)
|
||||||
|
|
||||||
@@ -18,7 +21,9 @@ option(DUSK_NETWORK "Enable network support" ON)
|
|||||||
set(DUSK_GAME_NAME "Dusk" CACHE STRING "Game display name")
|
set(DUSK_GAME_NAME "Dusk" CACHE STRING "Game display name")
|
||||||
set(DUSK_GAME_AUTHOR "YourWishes" CACHE STRING "Game author / coder")
|
set(DUSK_GAME_AUTHOR "YourWishes" CACHE STRING "Game author / coder")
|
||||||
set(DUSK_GAME_SHORT_DESCRIPTION "Dusk game" CACHE STRING "One-line description")
|
set(DUSK_GAME_SHORT_DESCRIPTION "Dusk game" CACHE STRING "One-line description")
|
||||||
set(DUSK_GAME_LONG_DESCRIPTION "No description yet." CACHE STRING "Full description")
|
set(DUSK_GAME_LONG_DESCRIPTION
|
||||||
|
"No description yet." CACHE STRING "Full description"
|
||||||
|
)
|
||||||
|
|
||||||
# Prep cache
|
# Prep cache
|
||||||
set(DUSK_CACHE_TARGET "dusk-target")
|
set(DUSK_CACHE_TARGET "dusk-target")
|
||||||
@@ -32,13 +37,19 @@ set(DUSK_TEMP_DIR "${DUSK_BUILD_DIR}/temp")
|
|||||||
set(DUSK_TOOLS_DIR "${DUSK_ROOT_DIR}/tools")
|
set(DUSK_TOOLS_DIR "${DUSK_ROOT_DIR}/tools")
|
||||||
set(DUSK_DATA_DIR "${DUSK_ROOT_DIR}/data")
|
set(DUSK_DATA_DIR "${DUSK_ROOT_DIR}/data")
|
||||||
set(DUSK_ASSETS_DIR "${DUSK_ROOT_DIR}/assets")
|
set(DUSK_ASSETS_DIR "${DUSK_ROOT_DIR}/assets")
|
||||||
set(DUSK_BUILT_ASSETS_DIR "${DUSK_BUILD_DIR}/built_assets" CACHE INTERNAL ${DUSK_CACHE_TARGET})
|
set(DUSK_BUILT_ASSETS_DIR "${DUSK_BUILD_DIR}/built_assets"
|
||||||
|
CACHE INTERNAL ${DUSK_CACHE_TARGET}
|
||||||
|
)
|
||||||
set(DUSK_GENERATED_HEADERS_DIR "${DUSK_BUILD_DIR}/generated")
|
set(DUSK_GENERATED_HEADERS_DIR "${DUSK_BUILD_DIR}/generated")
|
||||||
set(DUSK_BUILD_BINARY ${DUSK_BUILD_DIR}/Dusk CACHE INTERNAL ${DUSK_CACHE_TARGET})
|
set(DUSK_BUILD_BINARY ${DUSK_BUILD_DIR}/Dusk
|
||||||
|
CACHE INTERNAL ${DUSK_CACHE_TARGET}
|
||||||
|
)
|
||||||
set(DUSK_ASSETS "" CACHE INTERNAL ${DUSK_CACHE_TARGET})
|
set(DUSK_ASSETS "" CACHE INTERNAL ${DUSK_CACHE_TARGET})
|
||||||
set(DUSK_LIBRARY_TARGET_NAME "DuskCore" CACHE INTERNAL ${DUSK_CACHE_TARGET})
|
set(DUSK_LIBRARY_TARGET_NAME "DuskCore" CACHE INTERNAL ${DUSK_CACHE_TARGET})
|
||||||
set(DUSK_BINARY_TARGET_NAME "Dusk" CACHE INTERNAL ${DUSK_CACHE_TARGET})
|
set(DUSK_BINARY_TARGET_NAME "Dusk" CACHE INTERNAL ${DUSK_CACHE_TARGET})
|
||||||
set(DUSK_ASSETS_ZIP "${DUSK_BUILD_DIR}/dusk.dsk" CACHE INTERNAL ${DUSK_CACHE_TARGET})
|
set(DUSK_ASSETS_ZIP "${DUSK_BUILD_DIR}/dusk.dsk"
|
||||||
|
CACHE INTERNAL ${DUSK_CACHE_TARGET}
|
||||||
|
)
|
||||||
|
|
||||||
if(NOT DEFINED DUSK_TARGET_SYSTEM)
|
if(NOT DEFINED DUSK_TARGET_SYSTEM)
|
||||||
set(DUSK_TARGET_SYSTEM "linux")
|
set(DUSK_TARGET_SYSTEM "linux")
|
||||||
@@ -73,7 +84,9 @@ if(DUSK_BUILD_TESTS)
|
|||||||
${DUSK_LIBRARY_TARGET_NAME}
|
${DUSK_LIBRARY_TARGET_NAME}
|
||||||
)
|
)
|
||||||
else()
|
else()
|
||||||
set(DUSK_LIBRARY_TARGET_NAME "${DUSK_BINARY_TARGET_NAME}" CACHE INTERNAL ${DUSK_CACHE_TARGET})
|
set(DUSK_LIBRARY_TARGET_NAME "${DUSK_BINARY_TARGET_NAME}"
|
||||||
|
CACHE INTERNAL ${DUSK_CACHE_TARGET}
|
||||||
|
)
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
if(NOT DEFINED DUSK_VERSION)
|
if(NOT DEFINED DUSK_VERSION)
|
||||||
@@ -122,18 +135,21 @@ if(DUSK_BUILD_TESTS)
|
|||||||
add_subdirectory(test)
|
add_subdirectory(test)
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
# Build assets
|
# Build assets. Runs unconditionally on every build (rather than being
|
||||||
file(GLOB_RECURSE DUSK_ASSET_FILES CONFIGURE_DEPENDS "${DUSK_ASSETS_DIR}/*")
|
# gated behind a custom_command's file-level DEPENDS list) because
|
||||||
add_custom_command(
|
# CONFIGURE_DEPENDS globs only pick up added/removed files on the next
|
||||||
OUTPUT "${DUSK_ASSETS_ZIP}"
|
# CMake configure, so that approach could miss/lag a rebuild behind an
|
||||||
|
# asset edit. tools.asset.pack itself decides whether anything actually
|
||||||
|
# changed (see its manifest check) and no-ops quickly when nothing did,
|
||||||
|
# so this stays cheap on a build where assets are untouched.
|
||||||
|
add_custom_target(DUSK_ASSETS_BUILT ALL
|
||||||
COMMAND ${CMAKE_COMMAND} -E make_directory "${DUSK_ASSETS_DIR}"
|
COMMAND ${CMAKE_COMMAND} -E make_directory "${DUSK_ASSETS_DIR}"
|
||||||
COMMAND ${CMAKE_COMMAND} -E rm -f "${DUSK_ASSETS_ZIP}"
|
|
||||||
COMMAND ${Python3_EXECUTABLE} -m tools.asset.pack
|
COMMAND ${Python3_EXECUTABLE} -m tools.asset.pack
|
||||||
--input "${DUSK_ASSETS_DIR}"
|
--input "${DUSK_ASSETS_DIR}"
|
||||||
--output "${DUSK_ASSETS_ZIP}"
|
--output "${DUSK_ASSETS_ZIP}"
|
||||||
WORKING_DIRECTORY "${DUSK_ROOT_DIR}"
|
WORKING_DIRECTORY "${DUSK_ROOT_DIR}"
|
||||||
DEPENDS ${DUSK_ASSET_FILES}
|
BYPRODUCTS "${DUSK_ASSETS_ZIP}"
|
||||||
|
COMMENT "Packing assets into dusk.dsk"
|
||||||
VERBATIM
|
VERBATIM
|
||||||
)
|
)
|
||||||
add_custom_target(DUSK_ASSETS_BUILT DEPENDS "${DUSK_ASSETS_ZIP}")
|
|
||||||
add_dependencies(${DUSK_LIBRARY_TARGET_NAME} DUSK_ASSETS_BUILT)
|
add_dependencies(${DUSK_LIBRARY_TARGET_NAME} DUSK_ASSETS_BUILT)
|
||||||
@@ -9,15 +9,18 @@ following packages, depending on your system;
|
|||||||
|
|
||||||
Fedora;
|
Fedora;
|
||||||
```
|
```
|
||||||
sudo dnf install git make gcc cmake python python-polib python3-pillow python3-dotenv python3-numpy python-qt5 python3-pyopengl SDL2-devel zlib-devel libzip-devel bzip2-devel openssl-devel lzma-sdk-devel xz xz-devel lua-devel
|
sudo dnf install git make gcc cmake python python-polib python3-pillow python3-dotenv python3-numpy python-qt5 python3-pyopengl SDL2-devel zlib-devel libzip-devel bzip2-devel openssl-devel lzma-sdk-devel xz xz-devel lua-devel libmad-devel
|
||||||
```
|
```
|
||||||
|
`libmad-devel` (used for MP3 decoding) is GPL-licensed and ships in the
|
||||||
|
[RPM Fusion](https://rpmfusion.org/) free repository rather than Fedora's
|
||||||
|
base repos - make sure RPM Fusion is enabled first.
|
||||||
|
|
||||||
Ubuntu;
|
Ubuntu;
|
||||||
```
|
```
|
||||||
sudo apt-get install git build-essential gcc python python-polib python3-pillow python3-dotenv python3-numpy python3-pyqt5 python3-opengl
|
sudo apt-get install git build-essential gcc python python-polib python3-pillow python3-dotenv python3-numpy python3-pyqt5 python3-opengl libmad0-dev
|
||||||
```
|
```
|
||||||
|
|
||||||
Arch Linux;
|
Arch Linux;
|
||||||
```
|
```
|
||||||
sudo pacman -S git base-devel gcc python python-polib python-pillow python-dotenv python-numpy python-pyqt5 python-opengl
|
sudo pacman -S git base-devel gcc python python-polib python-pillow python-dotenv python-numpy python-pyqt5 python-opengl libmad
|
||||||
```
|
```
|
||||||
Binary file not shown.
@@ -0,0 +1,21 @@
|
|||||||
|
{
|
||||||
|
"moves": {
|
||||||
|
"fire": {
|
||||||
|
// Target flags
|
||||||
|
"enemies": true,
|
||||||
|
"allies": true,
|
||||||
|
"multiple": false,
|
||||||
|
"self": true,
|
||||||
|
"default": "enemy",
|
||||||
|
"target": "SINGLE_ENEMY"
|
||||||
|
},
|
||||||
|
|
||||||
|
"slash": {
|
||||||
|
"enemies": true,
|
||||||
|
"allies": true,
|
||||||
|
"self": false,
|
||||||
|
"default": "enemy",
|
||||||
|
"target": "SINGLE_ENEMY"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -0,0 +1,21 @@
|
|||||||
|
{
|
||||||
|
"items": [
|
||||||
|
{
|
||||||
|
"type": "MODAL",
|
||||||
|
"title": "Fire",
|
||||||
|
"message": "A burst of flame scorches the target."
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "WAIT",
|
||||||
|
"seconds": 2
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "MODAL_CLOSE"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "BATTLE_FIGHTER_DAMAGE",
|
||||||
|
"fighter": "target",
|
||||||
|
"amount": 12
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
{
|
||||||
|
"items": [
|
||||||
|
{
|
||||||
|
"type": "MODAL",
|
||||||
|
"title": "Slash",
|
||||||
|
"message": "A quick blade strike cuts across the target."
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "WAIT",
|
||||||
|
"seconds": 2
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "MODAL_CLOSE"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "BATTLE_FIGHTER_DAMAGE",
|
||||||
|
"fighter": "target",
|
||||||
|
"amount": 8
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
{
|
||||||
|
"items": [
|
||||||
|
{
|
||||||
|
"type": "BATTLE_START",
|
||||||
|
"enemies": [
|
||||||
|
{
|
||||||
|
"attack": 8, "defense": 4, "magic": 0, "speed": 5, "luck": 2,
|
||||||
|
"healthMax": 30, "mpMax": 0,
|
||||||
|
"abilities": ["fire"]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attack": 6, "defense": 3, "magic": 0, "speed": 7, "luck": 2,
|
||||||
|
"healthMax": 20, "mpMax": 0
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
Binary file not shown.
@@ -1,7 +1,6 @@
|
|||||||
{
|
{
|
||||||
"items": [
|
"items": [
|
||||||
// Boot check: make sure a save device is available before handing off
|
// First thing, try and find a save device, used for settings and what not.
|
||||||
// to the main menu.
|
|
||||||
{
|
{
|
||||||
"type": "MODAL",
|
"type": "MODAL",
|
||||||
"title": "initial.checking_save.title",
|
"title": "initial.checking_save.title",
|
||||||
@@ -14,13 +13,13 @@
|
|||||||
{
|
{
|
||||||
"type": "SAVE_DEVICE_CHECK",
|
"type": "SAVE_DEVICE_CHECK",
|
||||||
"successMarker": "CONTINUE",
|
"successMarker": "CONTINUE",
|
||||||
"failureMarker": "NO_DEVICE"
|
"failureMarker": "SAVE_DEVICE_NOT_FOUND"
|
||||||
},
|
},
|
||||||
|
|
||||||
// No save device found - offer to retry or continue without saving.
|
// No save device found
|
||||||
{
|
{
|
||||||
"type": "MARKER",
|
"type": "MARKER",
|
||||||
"name": "NO_DEVICE"
|
"name": "SAVE_DEVICE_NOT_FOUND"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "MODAL_CLOSE"
|
"type": "MODAL_CLOSE"
|
||||||
@@ -32,7 +31,7 @@
|
|||||||
"options": [
|
"options": [
|
||||||
{
|
{
|
||||||
"text": "initial.no_device.retry",
|
"text": "initial.no_device.retry",
|
||||||
"marker": "RETRY"
|
"marker": "SAVE_DEVICE_RETRY"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"text": "initial.no_device.continue",
|
"text": "initial.no_device.continue",
|
||||||
@@ -41,9 +40,10 @@
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
|
||||||
|
// Save device not found, user to retry, just close modal and loop
|
||||||
{
|
{
|
||||||
"type": "MARKER",
|
"type": "MARKER",
|
||||||
"name": "RETRY"
|
"name": "SAVE_DEVICE_RETRY"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "MODAL_CLOSE"
|
"type": "MODAL_CLOSE"
|
||||||
@@ -52,8 +52,7 @@
|
|||||||
"type": "RESTART"
|
"type": "RESTART"
|
||||||
},
|
},
|
||||||
|
|
||||||
// Save device found (or continuing without one) - hand off to the
|
// Save device found (or continuing without one)
|
||||||
// main menu scene.
|
|
||||||
{
|
{
|
||||||
"type": "MARKER",
|
"type": "MARKER",
|
||||||
"name": "CONTINUE"
|
"name": "CONTINUE"
|
||||||
@@ -62,8 +61,8 @@
|
|||||||
"type": "MODAL_CLOSE"
|
"type": "MODAL_CLOSE"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "SCENE",
|
"type": "CUTSCENE",
|
||||||
"sceneType": "MAIN_MENU"
|
"name": "cutscenes/main_menu.jsonc"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,140 @@
|
|||||||
|
{
|
||||||
|
"items": [
|
||||||
|
{
|
||||||
|
"type": "MARKER",
|
||||||
|
"name": "MAIN_MENU_IDLE"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "UI_SHOW",
|
||||||
|
"name": "main_menu"
|
||||||
|
},
|
||||||
|
|
||||||
|
// Options button goes here - no options screen yet, so this is just
|
||||||
|
// an alias landing right back on the idle loop below.
|
||||||
|
{
|
||||||
|
"type": "MARKER",
|
||||||
|
"name": "OPTIONS"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "IDLE"
|
||||||
|
},
|
||||||
|
|
||||||
|
// New Game button goes here.
|
||||||
|
{
|
||||||
|
"type": "MARKER",
|
||||||
|
"name": "NEW_GAME"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "MODAL",
|
||||||
|
"title": "main_menu.checking_save.title",
|
||||||
|
"message": "main_menu.checking_save.message"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "WAIT",
|
||||||
|
"seconds": 0.2
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "SAVE_DEVICE_CHECK",
|
||||||
|
"successMarker": "SAVE_DEVICE_FOUND",
|
||||||
|
"failureMarker": "SAVE_DEVICE_NOT_FOUND"
|
||||||
|
},
|
||||||
|
|
||||||
|
// Save device not found
|
||||||
|
{
|
||||||
|
"type": "MARKER",
|
||||||
|
"name": "SAVE_DEVICE_NOT_FOUND"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "MODAL_CLOSE"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "MODAL_OPTIONS_MARKERS",
|
||||||
|
"title": "main_menu.no_device.title",
|
||||||
|
"message": "main_menu.no_device.message",
|
||||||
|
"options": [
|
||||||
|
{
|
||||||
|
"text": "main_menu.no_device.retry",
|
||||||
|
"marker": "NEW_GAME"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"text": "main_menu.no_device.continue",
|
||||||
|
"marker": "SAVE_DEVICE_FOUND"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
|
||||||
|
// Save data failed to load (e.g. corrupt/unreadable) - only option is
|
||||||
|
// to retry, no "continue without saving" here since we already know a
|
||||||
|
// device is present.
|
||||||
|
{
|
||||||
|
"type": "MARKER",
|
||||||
|
"name": "LOAD_ERROR"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "MODAL_OPTIONS_MARKERS",
|
||||||
|
"title": "main_menu.save_load_error.title",
|
||||||
|
"message": "main_menu.save_load_error.message",
|
||||||
|
"options": [
|
||||||
|
{
|
||||||
|
"text": "main_menu.save_load_error.retry",
|
||||||
|
"marker": "NEW_GAME"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
|
||||||
|
// Quit Game button goes here. Cancelling jumps back to
|
||||||
|
// MAIN_MENU_IDLE; confirming falls through to QUIT_GAME, which
|
||||||
|
// ends the process directly.
|
||||||
|
{
|
||||||
|
"type": "MARKER",
|
||||||
|
"name": "QUIT"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "MODAL_OPTIONS_MARKERS",
|
||||||
|
"title": "main_menu.quit_confirm",
|
||||||
|
"options": [
|
||||||
|
{
|
||||||
|
"text": "ui.confirm.confirm",
|
||||||
|
"marker": "QUIT_CONFIRMED"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"text": "ui.confirm.cancel",
|
||||||
|
"marker": "MAIN_MENU_IDLE"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
|
||||||
|
{
|
||||||
|
"type": "MARKER",
|
||||||
|
"name": "QUIT_CONFIRMED"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "QUIT_GAME"
|
||||||
|
},
|
||||||
|
|
||||||
|
// main menu just listens for cutscene ending to show the select save modal
|
||||||
|
// so we have that here.
|
||||||
|
{
|
||||||
|
"type": "MARKER",
|
||||||
|
"name": "SAVE_DEVICE_FOUND"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "MODAL_CLOSE"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "SAVE_LOAD_ALL_SLOTS",
|
||||||
|
"successMarker": "LOADED",
|
||||||
|
"failureMarker": "LOAD_ERROR"
|
||||||
|
},
|
||||||
|
|
||||||
|
// Must be the very last item - falling off the end here is what
|
||||||
|
// completes the cutscene and fires uiMainMenuOpenSelectSave (see
|
||||||
|
// cutsceneSystemSetOnComplete in ui/screen/mainmenu/uimainmenu.c).
|
||||||
|
// Placing this anywhere earlier would fall through into whatever
|
||||||
|
// comes next instead (e.g. the QUIT block, if placed just before it).
|
||||||
|
{
|
||||||
|
"type": "MARKER",
|
||||||
|
"name": "LOADED"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
Binary file not shown.
@@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
// Placeholder for the new-game intro flow - just shows a modal for now.
|
||||||
|
"items": [
|
||||||
|
{
|
||||||
|
"type": "MODAL",
|
||||||
|
"title": "New Game",
|
||||||
|
"message": "This is a placeholder for the new game intro.",
|
||||||
|
"blocking": true
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
{
|
||||||
|
"items": {
|
||||||
|
"potion": { "type": "MEDICINE" },
|
||||||
|
"potato": { "type": "FOOD" },
|
||||||
|
"apple": { "type": "FOOD" }
|
||||||
|
}
|
||||||
|
}
|
||||||
+20
-1
@@ -73,6 +73,12 @@ msgstr "Select Save"
|
|||||||
msgid "ui.select_save.empty"
|
msgid "ui.select_save.empty"
|
||||||
msgstr "Empty Slot"
|
msgstr "Empty Slot"
|
||||||
|
|
||||||
|
msgid "ui.select_save.corrupt"
|
||||||
|
msgstr "Corrupted Save"
|
||||||
|
|
||||||
|
msgid "ui.select_save.corrupt_warning"
|
||||||
|
msgstr "This save file is corrupted and could not be loaded. Please contact support if this issue persists."
|
||||||
|
|
||||||
msgid "ui.select_save.slot_format"
|
msgid "ui.select_save.slot_format"
|
||||||
msgstr "%s Lv.%d %s"
|
msgstr "%s Lv.%d %s"
|
||||||
|
|
||||||
@@ -260,6 +266,10 @@ msgstr "loading"
|
|||||||
msgid "ui.autosave.saving"
|
msgid "ui.autosave.saving"
|
||||||
msgstr "SAVING"
|
msgstr "SAVING"
|
||||||
|
|
||||||
|
|
||||||
|
#
|
||||||
|
# Items
|
||||||
|
#
|
||||||
msgid "item.potion.name"
|
msgid "item.potion.name"
|
||||||
msgstr "Potion"
|
msgstr "Potion"
|
||||||
|
|
||||||
@@ -267,4 +277,13 @@ msgid "item.potato.name"
|
|||||||
msgstr "Potato"
|
msgstr "Potato"
|
||||||
|
|
||||||
msgid "item.apple.name"
|
msgid "item.apple.name"
|
||||||
msgstr "Apple"
|
msgstr "Apple"
|
||||||
|
|
||||||
|
#
|
||||||
|
# Moves
|
||||||
|
#
|
||||||
|
msgid "move.fire.name"
|
||||||
|
msgstr "Fire"
|
||||||
|
|
||||||
|
msgid "move.slash.name"
|
||||||
|
msgstr "Slash"
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
{"meshes":[{"file":"house_4_4.dmf","pos":[2,1,0]},{"file":"house_6_3.dmf","pos":[1,9,0]},{"file":"house_2_2.dmf","pos":[12,6,0]}],"tiles":[[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,null,null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,null,null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,null,null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0]]}
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
{"tiles":[[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[6,0],[2,0],[2,0],[2,0],[2,0],[2,0],[2,0],[7,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[3,0],[1,1],[1,1],[1,1],[1,1],[1,1],[1,1],[5,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[3,0],[1,1],[1,1],[1,1],[1,1],[1,1],[1,1],[5,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[3,0],[1,1],[1,1],[1,1],[1,1],[1,1],[1,1],[5,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[8,0],[4,0],[4,0],[4,0],[12,0],[1,1],[1,1],[5,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[3,0],[1,1],[1,1],[5,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[3,0],[1,1],[1,1],[5,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[8,0],[4,0],[4,0],[9,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0]],"meshes":[{"file":"house_5_3.dmf","pos":[1,1,0]}],"entities":[{"type":"global","globalId":3,"pos":[8,8,1]},{"type":"global","globalId":4,"pos":[12,2,0]}],"areas":[{"min":[11,3,0],"max":[16,9,10],"callbackId":1,"notify":3,"trigger":6}]}
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
{"meshes":[{"file":"house_8_4.dmf","pos":[1,1,0]},{"file":"house_3_3.dmf","pos":[11,2,0]},{"file":"house_2_2.dmf","pos":[3,11,0]}],"tiles":[[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,null,null,null,null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,null,null,null,null,null,[1,0],[1,0],null,null,null,[1,0],[1,0],[1,0],null,null,null,null,null,null,null,null,[1,0],[1,0],null,null,null,[1,0],[1,0],[1,0],null,null,null,null,null,null,null,null,[1,0],[1,0],null,null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0]]}
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
{"meshes":[{"file":"house_3_2.dmf","pos":[1,1,0]},{"file":"house_2_3.dmf","pos":[7,2,0]},{"file":"house_4_2.dmf","pos":[1,8,0]},{"file":"house_1_1.dmf","pos":[11,10,0]},{"file":"house_5_2.dmf","pos":[13,6,0]}],"tiles":[[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,[1,0],[1,0],[1,0],null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,[1,0],null,null,null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0]]}
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
{"meshes":[{"file":"house_5_5.dmf","pos":[3,2,0]},{"file":"house_2_3.dmf","pos":[10,3,0]},{"file":"house_3_1.dmf","pos":[1,12,0]}],"tiles":[[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,null,null,[1,0],[1,0],null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,null,null,[1,0],[1,0],null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,null,null,[1,0],[1,0],null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],null,null,null,[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0]]}
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
{"tiles":[[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,3],[1,3],[1,3],[1,3],[1,3],[1,3],[1,0],[1,0],[1,0],[1,0],null,null,[1,0],[1,0],[1,0],[1,0],[1,3],[1,3],[1,3],[1,3],[1,3],[1,3],[1,0],[1,0],[1,0],[1,0],null,null,[1,0],[1,0],[1,0],[1,0],[1,3],[1,3],[1,3],[1,3],[1,3],[1,3],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[4,2],[4,2],[4,2],[4,2],[4,2],[4,2],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[4,1],[4,1],[4,1],[4,1],[4,1],[4,1],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[4,0],[4,0],[4,0],[4,0],[4,0],[4,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0],[1,0]],"meshes":[]}
|
||||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -1,10 +0,0 @@
|
|||||||
{
|
|
||||||
"mesh": "meshes/chunks/chunk_-1_0_0_0.dmf",
|
|
||||||
"color": [
|
|
||||||
255,
|
|
||||||
255,
|
|
||||||
255,
|
|
||||||
255
|
|
||||||
],
|
|
||||||
"texture": "tiles.png"
|
|
||||||
}
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
{
|
|
||||||
"mesh": "meshes/chunks/chunk_0_0_0_0.dmf",
|
|
||||||
"color": [
|
|
||||||
255,
|
|
||||||
255,
|
|
||||||
255,
|
|
||||||
255
|
|
||||||
],
|
|
||||||
"texture": "tiles.png"
|
|
||||||
}
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
{
|
|
||||||
"mesh": "meshes/chunks/chunk_0_1_0_0.dmf",
|
|
||||||
"color": [
|
|
||||||
255,
|
|
||||||
255,
|
|
||||||
255,
|
|
||||||
255
|
|
||||||
],
|
|
||||||
"texture": "tiles.png"
|
|
||||||
}
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
{
|
|
||||||
"mesh": "meshes/chunks/chunk_1_0_0_0.dmf",
|
|
||||||
"color": [
|
|
||||||
255,
|
|
||||||
255,
|
|
||||||
255,
|
|
||||||
255
|
|
||||||
],
|
|
||||||
"texture": "tiles.png"
|
|
||||||
}
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
{
|
|
||||||
"mesh": "meshes/chunks/chunk_1_1_0_0.dmf",
|
|
||||||
"color": [
|
|
||||||
255,
|
|
||||||
255,
|
|
||||||
255,
|
|
||||||
255
|
|
||||||
],
|
|
||||||
"texture": "tiles.png"
|
|
||||||
}
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
{
|
|
||||||
"mesh": "meshes/chunks/chunk_2_0_0_0.dmf",
|
|
||||||
"color": [
|
|
||||||
255,
|
|
||||||
255,
|
|
||||||
255,
|
|
||||||
255
|
|
||||||
],
|
|
||||||
"texture": "tiles.png"
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
{
|
||||||
|
"members": {
|
||||||
|
"hero": {
|
||||||
|
"attack": 10,
|
||||||
|
"defense": 5,
|
||||||
|
"magic": 0,
|
||||||
|
"speed": 10,
|
||||||
|
"luck": 0,
|
||||||
|
"healthMax": 30,
|
||||||
|
"mpMax": 10
|
||||||
|
},
|
||||||
|
"companion": {
|
||||||
|
"attack": 8,
|
||||||
|
"defense": 6,
|
||||||
|
"magic": 4,
|
||||||
|
"speed": 8,
|
||||||
|
"luck": 1,
|
||||||
|
"healthMax": 25,
|
||||||
|
"mpMax": 15
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
{
|
||||||
|
"flags": {
|
||||||
|
"test": {
|
||||||
|
"initial": true
|
||||||
|
},
|
||||||
|
"test2": {
|
||||||
|
"initial": 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
@@ -1,92 +0,0 @@
|
|||||||
{
|
|
||||||
"items": [
|
|
||||||
{
|
|
||||||
"type": "MODAL",
|
|
||||||
"title": "main_menu.checking_save.title",
|
|
||||||
"message": "main_menu.checking_save.message"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "WAIT",
|
|
||||||
"seconds": 0.2
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "SAVE_DEVICE_CHECK",
|
|
||||||
"successMarker": "CONTINUE",
|
|
||||||
"failureMarker": "NO_DEVICE"
|
|
||||||
},
|
|
||||||
|
|
||||||
// No save device found - offer to retry or continue without saving.
|
|
||||||
{
|
|
||||||
"type": "MARKER",
|
|
||||||
"name": "NO_DEVICE"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "MODAL_CLOSE"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "MODAL_OPTIONS_MARKERS",
|
|
||||||
"title": "main_menu.no_device.title",
|
|
||||||
"message": "main_menu.no_device.message",
|
|
||||||
"options": [
|
|
||||||
{
|
|
||||||
"text": "main_menu.no_device.retry",
|
|
||||||
"marker": "RETRY"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"text": "main_menu.no_device.continue",
|
|
||||||
"marker": "CONTINUE"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
|
|
||||||
// Retry
|
|
||||||
{
|
|
||||||
"type": "MARKER",
|
|
||||||
"name": "RETRY"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "MODAL_CLOSE"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "RESTART"
|
|
||||||
},
|
|
||||||
|
|
||||||
// Save device found - attempt to load all save slots.
|
|
||||||
{
|
|
||||||
"type": "MARKER",
|
|
||||||
"name": "CONTINUE"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "MODAL_CLOSE"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "SAVE_LOAD_ALL_SLOTS",
|
|
||||||
"successMarker": "LOADED",
|
|
||||||
"failureMarker": "LOAD_ERROR"
|
|
||||||
},
|
|
||||||
|
|
||||||
// Save data failed to load (e.g. corrupt/unreadable) - only option is
|
|
||||||
// to retry, no "continue without saving" here since we already know a
|
|
||||||
// device is present.
|
|
||||||
{
|
|
||||||
"type": "MARKER",
|
|
||||||
"name": "LOAD_ERROR"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "MODAL_OPTIONS_MARKERS",
|
|
||||||
"title": "main_menu.save_load_error.title",
|
|
||||||
"message": "main_menu.save_load_error.message",
|
|
||||||
"options": [
|
|
||||||
{
|
|
||||||
"text": "main_menu.save_load_error.retry",
|
|
||||||
"marker": "RETRY"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
|
|
||||||
{
|
|
||||||
"type": "MARKER",
|
|
||||||
"name": "LOADED"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
# Copyright (c) 2026 Dominic Masters
|
||||||
|
#
|
||||||
|
# This software is released under the MIT License.
|
||||||
|
# https://opensource.org/licenses/MIT
|
||||||
|
|
||||||
|
# NOTE: libmad itself is GPL-licensed (see https://www.underbit.com/products/mad/),
|
||||||
|
# not MIT like the rest of this project. Any binary linking it must comply
|
||||||
|
# with the GPL - a deliberate tradeoff accepted for MP3 decode correctness
|
||||||
|
# (see audiostreammp3decodersw.c's own comment on why minimp3 wasn't enough).
|
||||||
|
|
||||||
|
find_path(LIBMAD_INCLUDE_DIR NAMES mad.h)
|
||||||
|
mark_as_advanced(LIBMAD_INCLUDE_DIR)
|
||||||
|
|
||||||
|
find_library(LIBMAD_LIBRARY NAMES mad)
|
||||||
|
mark_as_advanced(LIBMAD_LIBRARY)
|
||||||
|
|
||||||
|
include(FindPackageHandleStandardArgs)
|
||||||
|
find_package_handle_standard_args(
|
||||||
|
libmad
|
||||||
|
REQUIRED_VARS
|
||||||
|
LIBMAD_LIBRARY
|
||||||
|
LIBMAD_INCLUDE_DIR
|
||||||
|
)
|
||||||
|
|
||||||
|
if(libmad_FOUND AND NOT TARGET libmad::mad)
|
||||||
|
add_library(libmad::mad UNKNOWN IMPORTED)
|
||||||
|
set_target_properties(libmad::mad
|
||||||
|
PROPERTIES
|
||||||
|
INTERFACE_INCLUDE_DIRECTORIES ${LIBMAD_INCLUDE_DIR}
|
||||||
|
IMPORTED_LOCATION ${LIBMAD_LIBRARY}
|
||||||
|
)
|
||||||
|
endif()
|
||||||
@@ -61,7 +61,8 @@ target_link_libraries(${DUSK_LIBRARY_TARGET_NAME} PRIVATE
|
|||||||
zstd
|
zstd
|
||||||
z
|
z
|
||||||
lzma
|
lzma
|
||||||
ansnd
|
asnd
|
||||||
|
mad
|
||||||
)
|
)
|
||||||
|
|
||||||
if(DUSK_DOLPHIN_BUILD_TYPE STREQUAL "ISO")
|
if(DUSK_DOLPHIN_BUILD_TYPE STREQUAL "ISO")
|
||||||
|
|||||||
@@ -27,6 +27,7 @@ target_link_libraries(${DUSK_LIBRARY_TARGET_NAME} PUBLIC
|
|||||||
)
|
)
|
||||||
|
|
||||||
set(DUSK_BACKTRACE ON CACHE BOOL "Enable backtrace support for assert failures.")
|
set(DUSK_BACKTRACE ON CACHE BOOL "Enable backtrace support for assert failures.")
|
||||||
|
set(DUSK_TRACK_MEMORY ON CACHE BOOL "Track memoryAllocate() call sites to help find memory leaks.")
|
||||||
|
|
||||||
# Define platform-specific macros.
|
# Define platform-specific macros.
|
||||||
target_compile_definitions(${DUSK_LIBRARY_TARGET_NAME} PUBLIC
|
target_compile_definitions(${DUSK_LIBRARY_TARGET_NAME} PUBLIC
|
||||||
|
|||||||
@@ -30,6 +30,7 @@ target_link_libraries(${DUSK_BINARY_TARGET_NAME} PUBLIC
|
|||||||
pspgu
|
pspgu
|
||||||
pspaudio
|
pspaudio
|
||||||
pspaudiolib
|
pspaudiolib
|
||||||
|
pspmp3
|
||||||
psputility
|
psputility
|
||||||
pspvfpu
|
pspvfpu
|
||||||
pspvram
|
pspvram
|
||||||
@@ -59,6 +60,19 @@ target_compile_definitions(${DUSK_BINARY_TARGET_NAME} PUBLIC
|
|||||||
DUSK_DISPLAY_OVERSCAN=6
|
DUSK_DISPLAY_OVERSCAN=6
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# logDebug()/logError() additionally write every call to a file on the
|
||||||
|
# Memory Stick (ms0:/PSP/GAME/Dusk/*.log) - a real, measured source of
|
||||||
|
# per-call hitching (fopen+write+fclose every log line), not just a
|
||||||
|
# theoretical cost. Default off so a normal build doesn't pay it; opt in
|
||||||
|
# with -DDUSK_PSP_LOG_FILE=ON when the log file itself is actually needed
|
||||||
|
# (e.g. no way to see stdout on real hardware).
|
||||||
|
set(DUSK_PSP_LOG_FILE OFF CACHE BOOL "Also write PSP debug/error logs to ms0:/PSP/GAME/Dusk/*.log (slow - Memory Stick I/O per call).")
|
||||||
|
if(DUSK_PSP_LOG_FILE)
|
||||||
|
target_compile_definitions(${DUSK_BINARY_TARGET_NAME} PUBLIC
|
||||||
|
DUSK_PSP_LOG_FILE
|
||||||
|
)
|
||||||
|
endif()
|
||||||
|
|
||||||
if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
|
if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
|
||||||
target_compile_definitions(${DUSK_BINARY_TARGET_NAME} PUBLIC
|
target_compile_definitions(${DUSK_BINARY_TARGET_NAME} PUBLIC
|
||||||
DUSK_ASSERTIONS_FAKED
|
DUSK_ASSERTIONS_FAKED
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ target_compile_definitions(${DUSK_LIBRARY_TARGET_NAME} PUBLIC
|
|||||||
)
|
)
|
||||||
|
|
||||||
# Wii save storage method - see src/duskdolphin/save/savedeviceplatform.h.
|
# Wii save storage method - see src/duskdolphin/save/savedeviceplatform.h.
|
||||||
set(DUSK_SAVE_WII_METHOD "NAND" CACHE STRING
|
set(DUSK_SAVE_WII_METHOD "SD" CACHE STRING
|
||||||
"Wii save storage: NAND (internal storage via ISFS), CARD (GameCube-\
|
"Wii save storage: NAND (internal storage via ISFS), CARD (GameCube-\
|
||||||
compatible memory card emulation), or SD (SD card via libfat)"
|
compatible memory card emulation), or SD (SD card via libfat)"
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -345,12 +345,14 @@
|
|||||||
return promise;
|
return promise;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const MAP_NAME = "overworld";
|
||||||
|
|
||||||
function chunkPaths(x, y, z) {
|
function chunkPaths(x, y, z) {
|
||||||
return {
|
return {
|
||||||
raw: `assetsraw/chunks/chunk_${x}_${y}_${z}.json`,
|
raw: `assetsraw/maps/${MAP_NAME}/chunks/chunk_${x}_${y}_${z}.json`,
|
||||||
dcf: `assets/chunks/${x}_${y}_${z}.dcf`,
|
dcf: `assets/maps/${MAP_NAME}/chunks/${x}_${y}_${z}.dcf`,
|
||||||
terrainDmf: `assets/meshes/chunks/chunk_${x}_${y}_${z}_0.dmf`,
|
terrainDmf: `assets/maps/${MAP_NAME}/meshes/chunks/chunk_${x}_${y}_${z}_0.dmf`,
|
||||||
terrainModel: `assets/models/chunks/chunk_${x}_${y}_${z}_0.json`,
|
terrainModel: `assets/maps/${MAP_NAME}/models/chunks/chunk_${x}_${y}_${z}_0.json`,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -767,7 +769,7 @@
|
|||||||
async function buildChunkBrowseList() {
|
async function buildChunkBrowseList() {
|
||||||
const list = document.getElementById("chunkBrowseList");
|
const list = document.getElementById("chunkBrowseList");
|
||||||
list.innerHTML = "";
|
list.innerHTML = "";
|
||||||
const res = await apiLs("assetsraw/chunks");
|
const res = await apiLs(`assetsraw/maps/${MAP_NAME}/chunks`);
|
||||||
for(const entry of res.entries || []) {
|
for(const entry of res.entries || []) {
|
||||||
const m = entry.name.match(/^chunk_(-?\d+)_(-?\d+)_(-?\d+)\.json$/);
|
const m = entry.name.match(/^chunk_(-?\d+)_(-?\d+)_(-?\d+)\.json$/);
|
||||||
if(!m) continue;
|
if(!m) continue;
|
||||||
|
|||||||
@@ -209,7 +209,10 @@ class Handler(BaseHTTPRequestHandler):
|
|||||||
self.send_json({"error": "invalid chunk coordinates"}, 400)
|
self.send_json({"error": "invalid chunk coordinates"}, 400)
|
||||||
return
|
return
|
||||||
|
|
||||||
json_path = PROJECT_ROOT / "assetsraw" / "chunks" / f"chunk_{x}_{y}_{z}.json"
|
json_path = (
|
||||||
|
PROJECT_ROOT / "assetsraw" / "maps" / "overworld" / "chunks"
|
||||||
|
/ f"chunk_{x}_{y}_{z}.json"
|
||||||
|
)
|
||||||
if not json_path.is_file():
|
if not json_path.is_file():
|
||||||
self.send_json({"error": "chunk json not found"}, 404)
|
self.send_json({"error": "chunk json not found"}, 404)
|
||||||
return
|
return
|
||||||
|
|||||||
+7
-2
@@ -13,6 +13,7 @@ if(DUSK_TARGET_SYSTEM STREQUAL "linux" OR DUSK_TARGET_SYSTEM STREQUAL "knulli")
|
|||||||
add_subdirectory(dusklinux)
|
add_subdirectory(dusklinux)
|
||||||
add_subdirectory(dusksdl2)
|
add_subdirectory(dusksdl2)
|
||||||
add_subdirectory(duskgl)
|
add_subdirectory(duskgl)
|
||||||
|
add_subdirectory(duskmad)
|
||||||
|
|
||||||
elseif(DUSK_TARGET_SYSTEM STREQUAL "psp")
|
elseif(DUSK_TARGET_SYSTEM STREQUAL "psp")
|
||||||
add_subdirectory(duskpsp)
|
add_subdirectory(duskpsp)
|
||||||
@@ -24,7 +25,11 @@ elseif(DUSK_TARGET_SYSTEM STREQUAL "vita")
|
|||||||
add_subdirectory(dusksdl2)
|
add_subdirectory(dusksdl2)
|
||||||
add_subdirectory(duskgl)
|
add_subdirectory(duskgl)
|
||||||
|
|
||||||
elseif(DUSK_TARGET_SYSTEM STREQUAL "wii" OR DUSK_TARGET_SYSTEM STREQUAL "gamecube")
|
elseif(
|
||||||
|
DUSK_TARGET_SYSTEM STREQUAL "wii" OR
|
||||||
|
DUSK_TARGET_SYSTEM STREQUAL "gamecube"
|
||||||
|
)
|
||||||
add_subdirectory(duskdolphin)
|
add_subdirectory(duskdolphin)
|
||||||
|
add_subdirectory(duskmad)
|
||||||
|
|
||||||
endif()
|
endif()
|
||||||
+13
-2
@@ -26,7 +26,9 @@ if(NOT stb_image_FOUND)
|
|||||||
if(STB_IMAGE_FOUND)
|
if(STB_IMAGE_FOUND)
|
||||||
target_link_libraries(${DUSK_LIBRARY_TARGET_NAME} PUBLIC stb_image)
|
target_link_libraries(${DUSK_LIBRARY_TARGET_NAME} PUBLIC stb_image)
|
||||||
else()
|
else()
|
||||||
message(FATAL_ERROR "stb_image not found. Please ensure stb is correctly fetched.")
|
message(FATAL_ERROR
|
||||||
|
"stb_image not found. Please ensure stb is correctly fetched."
|
||||||
|
)
|
||||||
endif()
|
endif()
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
@@ -35,7 +37,9 @@ if(NOT yyjson_FOUND)
|
|||||||
if(yyjson_FOUND)
|
if(yyjson_FOUND)
|
||||||
target_link_libraries(${DUSK_LIBRARY_TARGET_NAME} PUBLIC yyjson::yyjson)
|
target_link_libraries(${DUSK_LIBRARY_TARGET_NAME} PUBLIC yyjson::yyjson)
|
||||||
else()
|
else()
|
||||||
message(FATAL_ERROR "yyjson not found. Please ensure yyjson is correctly fetched.")
|
message(FATAL_ERROR
|
||||||
|
"yyjson not found. Please ensure yyjson is correctly fetched."
|
||||||
|
)
|
||||||
endif()
|
endif()
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
@@ -46,6 +50,12 @@ if(DUSK_BACKTRACE)
|
|||||||
)
|
)
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
|
if(DUSK_TRACK_MEMORY)
|
||||||
|
target_compile_definitions(${DUSK_LIBRARY_TARGET_NAME} PUBLIC
|
||||||
|
DUSK_TRACK_MEMORY
|
||||||
|
)
|
||||||
|
endif()
|
||||||
|
|
||||||
# Includes
|
# Includes
|
||||||
target_include_directories(${DUSK_LIBRARY_TARGET_NAME}
|
target_include_directories(${DUSK_LIBRARY_TARGET_NAME}
|
||||||
PUBLIC
|
PUBLIC
|
||||||
@@ -70,6 +80,7 @@ add_subdirectory(engine)
|
|||||||
add_subdirectory(error)
|
add_subdirectory(error)
|
||||||
add_subdirectory(input)
|
add_subdirectory(input)
|
||||||
add_subdirectory(locale)
|
add_subdirectory(locale)
|
||||||
|
add_subdirectory(perf)
|
||||||
add_subdirectory(rpg)
|
add_subdirectory(rpg)
|
||||||
add_subdirectory(scene)
|
add_subdirectory(scene)
|
||||||
add_subdirectory(system)
|
add_subdirectory(system)
|
||||||
|
|||||||
+7
-15
@@ -25,11 +25,9 @@ errorret_t assetInit(void) {
|
|||||||
threadMutexInit(&ASSET.loading[i].mutex);
|
threadMutexInit(&ASSET.loading[i].mutex);
|
||||||
}
|
}
|
||||||
|
|
||||||
// assetInitPlatform must either define both ASSET.zip/ASSET.zipStored or
|
// assetInitPlatform must either define ASSET.zip or throw an error.
|
||||||
// throw an error.
|
|
||||||
errorChain(assetInitPlatform());
|
errorChain(assetInitPlatform());
|
||||||
assertNotNull(ASSET.zip, "Asset zip null without error.");
|
assertNotNull(ASSET.zip, "Asset zip null without error.");
|
||||||
assertNotNull(ASSET.zipStored, "Asset stored zip null without error.");
|
|
||||||
threadInit(&ASSET.loadThread, assetUpdateAsync);
|
threadInit(&ASSET.loadThread, assetUpdateAsync);
|
||||||
threadStart(&ASSET.loadThread);
|
threadStart(&ASSET.loadThread);
|
||||||
|
|
||||||
@@ -40,9 +38,7 @@ bool_t assetFileExists(const char_t *filename) {
|
|||||||
assertStrLenMax(filename, ASSET_FILE_NAME_MAX, "Filename too long.");
|
assertStrLenMax(filename, ASSET_FILE_NAME_MAX, "Filename too long.");
|
||||||
|
|
||||||
threadMutexLock(&ASSET.zipLock);
|
threadMutexLock(&ASSET.zipLock);
|
||||||
bool_t found =
|
bool_t found = zip_name_locate(ASSET.zip, filename, 0) >= 0;
|
||||||
zip_name_locate(ASSET.zip, filename, 0) >= 0 ||
|
|
||||||
zip_name_locate(ASSET.zipStored, filename, 0) >= 0;
|
|
||||||
threadMutexUnlock(&ASSET.zipLock);
|
threadMutexUnlock(&ASSET.zipLock);
|
||||||
return found;
|
return found;
|
||||||
}
|
}
|
||||||
@@ -364,7 +360,9 @@ errorret_t assetUpdate(void) {
|
|||||||
assetentry_t *errEntry = loading->entry;
|
assetentry_t *errEntry = loading->entry;
|
||||||
loading->entry = NULL;
|
loading->entry = NULL;
|
||||||
threadMutexUnlock(&loading->mutex);
|
threadMutexUnlock(&loading->mutex);
|
||||||
if(errEntry->onError) errEntry->onError(errEntry, errEntry->onErrorUser);
|
if(errEntry->onError) {
|
||||||
|
errEntry->onError(errEntry, errEntry->onErrorUser);
|
||||||
|
}
|
||||||
loading++;
|
loading++;
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
@@ -443,19 +441,13 @@ errorret_t assetDispose(void) {
|
|||||||
|
|
||||||
errorChain(assetReapUnused());
|
errorChain(assetReapUnused());
|
||||||
|
|
||||||
// Cleanup zip files.
|
// Cleanup zip file.
|
||||||
if(ASSET.zip != NULL) {
|
if(ASSET.zip != NULL) {
|
||||||
if(zip_close(ASSET.zip) != 0) {
|
if(zip_close(ASSET.zip) != 0) {
|
||||||
errorThrow("Failed to close compressed asset zip archive.");
|
errorThrow("Failed to close asset zip archive.");
|
||||||
}
|
}
|
||||||
ASSET.zip = NULL;
|
ASSET.zip = NULL;
|
||||||
}
|
}
|
||||||
if(ASSET.zipStored != NULL) {
|
|
||||||
if(zip_close(ASSET.zipStored) != 0) {
|
|
||||||
errorThrow("Failed to close stored asset zip archive.");
|
|
||||||
}
|
|
||||||
ASSET.zipStored = NULL;
|
|
||||||
}
|
|
||||||
|
|
||||||
errorChain(assetDisposePlatform());
|
errorChain(assetDisposePlatform());
|
||||||
threadMutexDispose(&ASSET.zipLock);
|
threadMutexDispose(&ASSET.zipLock);
|
||||||
|
|||||||
+17
-8
@@ -26,20 +26,29 @@
|
|||||||
#define ASSET_LOADING_COUNT_MAX 10
|
#define ASSET_LOADING_COUNT_MAX 10
|
||||||
#define ASSET_ENTRY_COUNT_MAX 64
|
#define ASSET_ENTRY_COUNT_MAX 64
|
||||||
|
|
||||||
|
#define ASSET_BASE_DIRECTORY_MAX 256
|
||||||
|
|
||||||
typedef struct asset_s {
|
typedef struct asset_s {
|
||||||
// Compressed (DEFLATE) archive - expected to hold the bulk of a game's
|
// The dusk.dsk archive - a single uncompressed (ZIP_STORED) zip, so
|
||||||
// binary assets. Looked up first by assetFileInit().
|
// every entry gets the reliable repeated seeking/re-opening that
|
||||||
|
// libzip only supports reliably for uncompressed entries (locale
|
||||||
|
// strings, MP3 loop restarts, etc.).
|
||||||
zip_t *zip;
|
zip_t *zip;
|
||||||
|
|
||||||
// Stored (uncompressed) archive - expected to hold small files that need
|
// Directory dusk.dsk was actually found/opened in (on PSP, the directory
|
||||||
// reliable repeated seeking/re-opening (e.g. locale strings), which
|
// EBOOT.PBP lives in, since dusk.dsk is embedded inside it rather than a
|
||||||
// libzip only supports reliably for uncompressed entries. Looked up by
|
// loose file) - populated by each platform's own assetInitXxx() once it
|
||||||
// assetFileInit() only if the name isn't found in `zip`.
|
// locates the file. Save devices that persist to a real filesystem path
|
||||||
zip_t *zipStored;
|
// (Linux, PSP, Wii SD) use this as their base directory instead of a
|
||||||
|
// separate hardcoded location, so saves live next to wherever the game
|
||||||
|
// itself was actually launched from rather than some unrelated fixed
|
||||||
|
// path. Not meaningful for devices with no filesystem-path concept at
|
||||||
|
// all (GameCube/Wii memory card, Wii NAND's ISFS namespace).
|
||||||
|
char_t baseDirectory[ASSET_BASE_DIRECTORY_MAX];
|
||||||
|
|
||||||
assetplatform_t platform;
|
assetplatform_t platform;
|
||||||
|
|
||||||
// Guards every libzip call against ASSET.zip/ASSET.zipStored (zip_fopen,
|
// Guards every libzip call against ASSET.zip (zip_fopen,
|
||||||
// zip_fread, zip_fclose, zip_fseek, zip_stat, zip_name_locate - see
|
// zip_fread, zip_fclose, zip_fseek, zip_stat, zip_name_locate - see
|
||||||
// assetfile.c/assetFileExists). libzip is documented as not thread-safe,
|
// assetfile.c/assetFileExists). libzip is documented as not thread-safe,
|
||||||
// and this asset system genuinely calls it from multiple real threads at
|
// and this asset system genuinely calls it from multiple real threads at
|
||||||
|
|||||||
+39
-146
@@ -30,9 +30,9 @@ errorret_t assetDskParseHeader(
|
|||||||
// Every field is a little-endian uint32_t regardless of host - convert
|
// Every field is a little-endian uint32_t regardless of host - convert
|
||||||
// to host order (a no-op on little-endian hosts, a real byteswap on
|
// to host order (a no-op on little-endian hosts, a real byteswap on
|
||||||
// Dolphin's big-endian PowerPC).
|
// Dolphin's big-endian PowerPC).
|
||||||
uint32_t fields[7];
|
uint32_t fields[3];
|
||||||
memoryCopy(fields, bytes + ASSET_DSK_MAGIC_SIZE, sizeof(fields));
|
memoryCopy(fields, bytes + ASSET_DSK_MAGIC_SIZE, sizeof(fields));
|
||||||
for(uint8_t i = 0; i < 7; i++) {
|
for(uint8_t i = 0; i < 3; i++) {
|
||||||
fields[i] = endianLittleToHost32(fields[i]);
|
fields[i] = endianLittleToHost32(fields[i]);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -41,24 +41,17 @@ errorret_t assetDskParseHeader(
|
|||||||
errorThrow("dusk.dsk has an unsupported version: %u", version);
|
errorThrow("dusk.dsk has an unsupported version: %u", version);
|
||||||
}
|
}
|
||||||
|
|
||||||
outHeader->compressedOffset = fields[1];
|
outHeader->size = fields[1];
|
||||||
outHeader->compressedSize = fields[2];
|
outHeader->checksum = fields[2];
|
||||||
outHeader->compressedChecksum = fields[3];
|
|
||||||
outHeader->storedOffset = fields[4];
|
|
||||||
outHeader->storedSize = fields[5];
|
|
||||||
outHeader->storedChecksum = fields[6];
|
|
||||||
|
|
||||||
errorOk();
|
errorOk();
|
||||||
}
|
}
|
||||||
|
|
||||||
errorret_t assetDskOpenFromPath(
|
errorret_t assetDskOpenFromPath(
|
||||||
const char_t *path,
|
const char_t *path,
|
||||||
zip_t **outCompressed,
|
zip_t **outZip
|
||||||
zip_t **outStored
|
|
||||||
) {
|
) {
|
||||||
errorChain(assetDskOpenFromPathRange(
|
errorChain(assetDskOpenFromPathRange(path, 0, SIZE_MAX, outZip));
|
||||||
path, 0, SIZE_MAX, outCompressed, outStored
|
|
||||||
));
|
|
||||||
errorOk();
|
errorOk();
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -66,15 +59,12 @@ errorret_t assetDskOpenFromPathRange(
|
|||||||
const char_t *path,
|
const char_t *path,
|
||||||
const size_t baseOffset,
|
const size_t baseOffset,
|
||||||
const size_t baseSize,
|
const size_t baseSize,
|
||||||
zip_t **outCompressed,
|
zip_t **outZip
|
||||||
zip_t **outStored
|
|
||||||
) {
|
) {
|
||||||
assertNotNull(path, "Path cannot be NULL.");
|
assertNotNull(path, "Path cannot be NULL.");
|
||||||
assertNotNull(outCompressed, "Out compressed cannot be NULL.");
|
assertNotNull(outZip, "Out zip cannot be NULL.");
|
||||||
assertNotNull(outStored, "Out stored cannot be NULL.");
|
|
||||||
|
|
||||||
*outCompressed = NULL;
|
*outZip = NULL;
|
||||||
*outStored = NULL;
|
|
||||||
|
|
||||||
FILE *headerFile = fopen(path, "rb");
|
FILE *headerFile = fopen(path, "rb");
|
||||||
if(headerFile == NULL) {
|
if(headerFile == NULL) {
|
||||||
@@ -96,175 +86,78 @@ errorret_t assetDskOpenFromPathRange(
|
|||||||
assetdskheader_t header;
|
assetdskheader_t header;
|
||||||
errorChain(assetDskParseHeader(headerBytes, sizeof(headerBytes), &header));
|
errorChain(assetDskParseHeader(headerBytes, sizeof(headerBytes), &header));
|
||||||
|
|
||||||
if(
|
if((size_t) ASSET_DSK_HEADER_SIZE + header.size > baseSize) {
|
||||||
(size_t) header.compressedOffset + header.compressedSize > baseSize ||
|
errorThrow("dusk.dsk header describes a range beyond its containing file.");
|
||||||
(size_t) header.storedOffset + header.storedSize > baseSize
|
|
||||||
) {
|
|
||||||
errorThrow("dusk.dsk header describes ranges beyond its containing file.");
|
|
||||||
}
|
}
|
||||||
|
|
||||||
zip_error_t zipError;
|
zip_error_t zipError;
|
||||||
zip_error_init(&zipError);
|
zip_error_init(&zipError);
|
||||||
|
|
||||||
zip_source_t *compressedSource = zip_source_file_create(
|
zip_source_t *source = zip_source_file_create(
|
||||||
path,
|
path,
|
||||||
(zip_uint64_t) (baseOffset + header.compressedOffset),
|
(zip_uint64_t) (baseOffset + ASSET_DSK_HEADER_SIZE),
|
||||||
(zip_int64_t) header.compressedSize,
|
(zip_int64_t) header.size,
|
||||||
&zipError
|
&zipError
|
||||||
);
|
);
|
||||||
if(compressedSource == NULL) {
|
if(source == NULL) {
|
||||||
errorThrow(
|
errorThrow(
|
||||||
"Failed to create compressed dusk.dsk source: %s", zip_error_strerror(&zipError)
|
"Failed to create dusk.dsk source: %s", zip_error_strerror(&zipError)
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
*outCompressed = zip_open_from_source(compressedSource, ZIP_RDONLY, &zipError);
|
*outZip = zip_open_from_source(source, ZIP_RDONLY, &zipError);
|
||||||
if(*outCompressed == NULL) {
|
if(*outZip == NULL) {
|
||||||
zip_source_free(compressedSource);
|
zip_source_free(source);
|
||||||
errorThrow(
|
errorThrow(
|
||||||
"Failed to open compressed dusk.dsk archive: %s", zip_error_strerror(&zipError)
|
"Failed to open dusk.dsk archive: %s", zip_error_strerror(&zipError)
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
zip_source_t *storedSource = zip_source_file_create(
|
|
||||||
path,
|
|
||||||
(zip_uint64_t) (baseOffset + header.storedOffset),
|
|
||||||
(zip_int64_t) header.storedSize,
|
|
||||||
&zipError
|
|
||||||
);
|
|
||||||
if(storedSource == NULL) {
|
|
||||||
zip_close(*outCompressed);
|
|
||||||
*outCompressed = NULL;
|
|
||||||
errorThrow(
|
|
||||||
"Failed to create stored dusk.dsk source: %s", zip_error_strerror(&zipError)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
*outStored = zip_open_from_source(storedSource, ZIP_RDONLY, &zipError);
|
|
||||||
if(*outStored == NULL) {
|
|
||||||
zip_source_free(storedSource);
|
|
||||||
zip_close(*outCompressed);
|
|
||||||
*outCompressed = NULL;
|
|
||||||
errorThrow(
|
|
||||||
"Failed to open stored dusk.dsk archive: %s", zip_error_strerror(&zipError)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
// The stored archive is small by convention, so verifying its checksum
|
|
||||||
// here (one extra small read) is cheap; the compressed archive isn't
|
|
||||||
// checked since it's meant to be read lazily/on-demand from here on.
|
|
||||||
uint8_t *storedBytes = (uint8_t *) memoryAllocate(header.storedSize);
|
|
||||||
FILE *storedFile = fopen(path, "rb");
|
|
||||||
if(storedFile == NULL) {
|
|
||||||
memoryFree(storedBytes);
|
|
||||||
zip_close(*outStored);
|
|
||||||
zip_close(*outCompressed);
|
|
||||||
*outStored = NULL;
|
|
||||||
*outCompressed = NULL;
|
|
||||||
errorThrow("Failed to re-open dusk.dsk to verify stored checksum: %s", path);
|
|
||||||
}
|
|
||||||
fseek(storedFile, (long) (baseOffset + header.storedOffset), SEEK_SET);
|
|
||||||
size_t storedRead = fread(storedBytes, 1, header.storedSize, storedFile);
|
|
||||||
fclose(storedFile);
|
|
||||||
if(storedRead != header.storedSize) {
|
|
||||||
memoryFree(storedBytes);
|
|
||||||
zip_close(*outStored);
|
|
||||||
zip_close(*outCompressed);
|
|
||||||
*outStored = NULL;
|
|
||||||
*outCompressed = NULL;
|
|
||||||
errorThrow("Failed to read dusk.dsk stored archive to verify checksum: %s", path);
|
|
||||||
}
|
|
||||||
|
|
||||||
uint32_t checksum = (uint32_t) crc32(0L, storedBytes, (uInt) header.storedSize);
|
|
||||||
memoryFree(storedBytes);
|
|
||||||
if(checksum != header.storedChecksum) {
|
|
||||||
zip_close(*outStored);
|
|
||||||
zip_close(*outCompressed);
|
|
||||||
*outStored = NULL;
|
|
||||||
*outCompressed = NULL;
|
|
||||||
errorThrow("dusk.dsk stored archive failed checksum verification: %s", path);
|
|
||||||
}
|
|
||||||
|
|
||||||
errorOk();
|
errorOk();
|
||||||
}
|
}
|
||||||
|
|
||||||
errorret_t assetDskOpenFromBuffer(
|
errorret_t assetDskOpenFromBuffer(
|
||||||
uint8_t *buffer,
|
uint8_t *buffer,
|
||||||
const size_t bufferSize,
|
const size_t bufferSize,
|
||||||
zip_t **outCompressed,
|
zip_t **outZip
|
||||||
zip_t **outStored
|
|
||||||
) {
|
) {
|
||||||
assertNotNull(buffer, "Buffer cannot be NULL.");
|
assertNotNull(buffer, "Buffer cannot be NULL.");
|
||||||
assertNotNull(outCompressed, "Out compressed cannot be NULL.");
|
assertNotNull(outZip, "Out zip cannot be NULL.");
|
||||||
assertNotNull(outStored, "Out stored cannot be NULL.");
|
|
||||||
|
|
||||||
*outCompressed = NULL;
|
*outZip = NULL;
|
||||||
*outStored = NULL;
|
|
||||||
|
|
||||||
assetdskheader_t header;
|
assetdskheader_t header;
|
||||||
errorChain(assetDskParseHeader(buffer, bufferSize, &header));
|
errorChain(assetDskParseHeader(buffer, bufferSize, &header));
|
||||||
|
|
||||||
if(
|
if((size_t) ASSET_DSK_HEADER_SIZE + header.size > bufferSize) {
|
||||||
(size_t) header.compressedOffset + header.compressedSize > bufferSize ||
|
errorThrow("dusk.dsk header describes a range beyond the buffer.");
|
||||||
(size_t) header.storedOffset + header.storedSize > bufferSize
|
|
||||||
) {
|
|
||||||
errorThrow("dusk.dsk header describes ranges beyond the buffer.");
|
|
||||||
}
|
}
|
||||||
|
|
||||||
uint32_t compressedChecksum = (uint32_t) crc32(
|
uint8_t *data = buffer + ASSET_DSK_HEADER_SIZE;
|
||||||
0L, buffer + header.compressedOffset, (uInt) header.compressedSize
|
uint32_t checksum = (uint32_t) crc32(0L, data, (uInt) header.size);
|
||||||
);
|
if(checksum != header.checksum) {
|
||||||
if(compressedChecksum != header.compressedChecksum) {
|
errorThrow("dusk.dsk archive failed checksum verification.");
|
||||||
errorThrow("dusk.dsk compressed archive failed checksum verification.");
|
|
||||||
}
|
|
||||||
|
|
||||||
uint32_t storedChecksum = (uint32_t) crc32(
|
|
||||||
0L, buffer + header.storedOffset, (uInt) header.storedSize
|
|
||||||
);
|
|
||||||
if(storedChecksum != header.storedChecksum) {
|
|
||||||
errorThrow("dusk.dsk stored archive failed checksum verification.");
|
|
||||||
}
|
}
|
||||||
|
|
||||||
zip_error_t zipError;
|
zip_error_t zipError;
|
||||||
zip_error_init(&zipError);
|
zip_error_init(&zipError);
|
||||||
|
|
||||||
// freep=0 for both - they're non-owning windows into the same caller-owned
|
// freep=0 - this is a non-owning window into the same caller-owned
|
||||||
// buffer, not independent allocations libzip should free.
|
// buffer, not an independent allocation libzip should free.
|
||||||
zip_source_t *compressedSource = zip_source_buffer_create(
|
zip_source_t *source = zip_source_buffer_create(
|
||||||
buffer + header.compressedOffset, header.compressedSize, 0, &zipError
|
data, header.size, 0, &zipError
|
||||||
);
|
);
|
||||||
if(compressedSource == NULL) {
|
if(source == NULL) {
|
||||||
errorThrow(
|
errorThrow(
|
||||||
"Failed to create compressed dusk.dsk source: %s", zip_error_strerror(&zipError)
|
"Failed to create dusk.dsk source: %s", zip_error_strerror(&zipError)
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
*outCompressed = zip_open_from_source(compressedSource, ZIP_RDONLY, &zipError);
|
*outZip = zip_open_from_source(source, ZIP_RDONLY, &zipError);
|
||||||
if(*outCompressed == NULL) {
|
if(*outZip == NULL) {
|
||||||
zip_source_free(compressedSource);
|
zip_source_free(source);
|
||||||
errorThrow(
|
errorThrow(
|
||||||
"Failed to open compressed dusk.dsk archive: %s", zip_error_strerror(&zipError)
|
"Failed to open dusk.dsk archive: %s", zip_error_strerror(&zipError)
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
zip_source_t *storedSource = zip_source_buffer_create(
|
|
||||||
buffer + header.storedOffset, header.storedSize, 0, &zipError
|
|
||||||
);
|
|
||||||
if(storedSource == NULL) {
|
|
||||||
zip_close(*outCompressed);
|
|
||||||
*outCompressed = NULL;
|
|
||||||
errorThrow(
|
|
||||||
"Failed to create stored dusk.dsk source: %s", zip_error_strerror(&zipError)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
*outStored = zip_open_from_source(storedSource, ZIP_RDONLY, &zipError);
|
|
||||||
if(*outStored == NULL) {
|
|
||||||
zip_source_free(storedSource);
|
|
||||||
zip_close(*outCompressed);
|
|
||||||
*outCompressed = NULL;
|
|
||||||
errorThrow(
|
|
||||||
"Failed to open stored dusk.dsk archive: %s", zip_error_strerror(&zipError)
|
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+40
-48
@@ -12,31 +12,30 @@
|
|||||||
// "DSK2" - distinct from a plain zip's "PK\x03\x04" so a stray plain zip
|
// "DSK2" - distinct from a plain zip's "PK\x03\x04" so a stray plain zip
|
||||||
// never gets misread as a valid dusk.dsk.
|
// never gets misread as a valid dusk.dsk.
|
||||||
#define ASSET_DSK_MAGIC_SIZE 4
|
#define ASSET_DSK_MAGIC_SIZE 4
|
||||||
#define ASSET_DSK_MAGIC "DSK2"
|
#define ASSET_DSK_MAGIC "DSK"
|
||||||
#define ASSET_DSK_VERSION 1
|
#define ASSET_DSK_VERSION 2
|
||||||
|
|
||||||
// magic(4) + version(4) + compressedOffset(4) + compressedSize(4) +
|
// Magic + version + size + checksum
|
||||||
// compressedChecksum(4) + storedOffset(4) + storedSize(4) +
|
#define ASSET_DSK_HEADER_SIZE ( \
|
||||||
// storedChecksum(4), all little-endian regardless of host - see
|
ASSET_DSK_MAGIC_SIZE + \
|
||||||
// assetDskParseHeader.
|
sizeof(uint32_t) + \
|
||||||
#define ASSET_DSK_HEADER_SIZE 32
|
sizeof(uint32_t) + \
|
||||||
|
sizeof(uint32_t) \
|
||||||
|
)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parsed dusk.dsk (DSK2 format) header. dusk.dsk is two independent, back
|
* Parsed dusk.dsk (DSK2 format) header. dusk.dsk is a single uncompressed
|
||||||
* to back zip archives (see tools/asset/pack) rather than a single plain
|
* (ZIP_STORED) zip archive (see tools/asset/pack) rather than DEFLATEd -
|
||||||
* zip: a "compressed" one (DEFLATE, expected to hold the bulk of a game's
|
* the bulk of what's packed (audio, images) is already compressed at the
|
||||||
* binary assets, opened lazily/on-demand) and a "stored" one (uncompressed,
|
* file level, so DEFLATE-ing the whole archive on top buys negligible
|
||||||
* expected to hold small files - locale strings, config - that need
|
* space for real CPU cost, and every entry gets the reliable repeated
|
||||||
* reliable repeated seeking/re-opening, which libzip only supports for
|
* seeking/re-opening that libzip only supports for uncompressed entries
|
||||||
* uncompressed entries).
|
* (locale line-by-line reads, MP3 loop restarts, etc.) instead of just a
|
||||||
|
* hand-picked subset of files.
|
||||||
*/
|
*/
|
||||||
typedef struct {
|
typedef struct {
|
||||||
uint32_t compressedOffset;
|
uint32_t size;
|
||||||
uint32_t compressedSize;
|
uint32_t checksum;
|
||||||
uint32_t compressedChecksum;
|
|
||||||
uint32_t storedOffset;
|
|
||||||
uint32_t storedSize;
|
|
||||||
uint32_t storedChecksum;
|
|
||||||
} assetdskheader_t;
|
} assetdskheader_t;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -56,27 +55,24 @@ errorret_t assetDskParseHeader(
|
|||||||
);
|
);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Opens both archives of a dusk.dsk file given a filesystem path, using
|
* Opens the dusk.dsk archive given a filesystem path, using a lazy/
|
||||||
* lazy/windowed file-backed zip sources - no more memory used than the
|
* windowed file-backed zip source - no more memory used than the
|
||||||
* existing per-platform small read buffers, matching the memory
|
* existing per-platform small read buffers, matching the memory
|
||||||
* characteristics of a plain zip_open() on the whole file. Verifies the
|
* characteristics of a plain zip_open() on the whole file. The checksum
|
||||||
* (small, by convention) stored archive's checksum; the compressed
|
* is intentionally not verified here since doing so would require
|
||||||
* archive's checksum is intentionally not verified here since doing so
|
* reading the whole (potentially large) archive just to compute it.
|
||||||
* would require reading the bulk of the game's assets just to compute it.
|
|
||||||
*
|
*
|
||||||
* See assetDskOpenFromPathRange() for the case where the DSK2 blob isn't
|
* See assetDskOpenFromPathRange() for the case where the DSK2 blob isn't
|
||||||
* the whole file (e.g. embedded inside another container).
|
* the whole file (e.g. embedded inside another container).
|
||||||
*
|
*
|
||||||
* @param path Filesystem path to the dusk.dsk file.
|
* @param path Filesystem path to the dusk.dsk file.
|
||||||
* @param outCompressed Set to the opened compressed archive on success.
|
* @param outZip Set to the opened archive on success.
|
||||||
* @param outStored Set to the opened stored archive on success.
|
|
||||||
* @return OK on success, error if the file is missing, too short, has a
|
* @return OK on success, error if the file is missing, too short, has a
|
||||||
* bad header, or either archive fails to open/verify.
|
* bad header, or the archive fails to open.
|
||||||
*/
|
*/
|
||||||
errorret_t assetDskOpenFromPath(
|
errorret_t assetDskOpenFromPath(
|
||||||
const char_t *path,
|
const char_t *path,
|
||||||
zip_t **outCompressed,
|
zip_t **outZip
|
||||||
zip_t **outStored
|
|
||||||
);
|
);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -90,39 +86,35 @@ errorret_t assetDskOpenFromPath(
|
|||||||
* @param path Filesystem path to the container file.
|
* @param path Filesystem path to the container file.
|
||||||
* @param baseOffset Byte offset within `path` where the DSK2 blob starts.
|
* @param baseOffset Byte offset within `path` where the DSK2 blob starts.
|
||||||
* @param baseSize Number of bytes available at `baseOffset`.
|
* @param baseSize Number of bytes available at `baseOffset`.
|
||||||
* @param outCompressed Set to the opened compressed archive on success.
|
* @param outZip Set to the opened archive on success.
|
||||||
* @param outStored Set to the opened stored archive on success.
|
|
||||||
* @return OK on success, error if the file is missing, too short, has a
|
* @return OK on success, error if the file is missing, too short, has a
|
||||||
* bad header, or either archive fails to open/verify.
|
* bad header, or the archive fails to open.
|
||||||
*/
|
*/
|
||||||
errorret_t assetDskOpenFromPathRange(
|
errorret_t assetDskOpenFromPathRange(
|
||||||
const char_t *path,
|
const char_t *path,
|
||||||
const size_t baseOffset,
|
const size_t baseOffset,
|
||||||
const size_t baseSize,
|
const size_t baseSize,
|
||||||
zip_t **outCompressed,
|
zip_t **outZip
|
||||||
zip_t **outStored
|
|
||||||
);
|
);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Opens both archives of a dusk.dsk file already fully resident in memory
|
* Opens the dusk.dsk archive already fully resident in memory (e.g. a
|
||||||
* (e.g. a PSAR embedded in an EBOOT.PBP, or an ISO-embedded file already
|
* PSAR embedded in an EBOOT.PBP, or an ISO-embedded file already read via
|
||||||
* read via DVD_ReadAbs - platforms that already buffer the whole file for
|
* DVD_ReadAbs - platforms that already buffer the whole file for reasons
|
||||||
* reasons unrelated to this format). Neither archive takes ownership of
|
* unrelated to this format). The returned archive doesn't take ownership
|
||||||
* `buffer` (both are opened as non-owning sub-ranges of it) - the caller
|
* of `buffer` (it's opened as a non-owning sub-range of it) - the caller
|
||||||
* remains responsible for freeing it, and must keep it alive for as long
|
* remains responsible for freeing it, and must keep it alive for as long
|
||||||
* as either archive stays open. Verifies both archives' checksums, since
|
* as the archive stays open. Verifies the checksum, since the bytes are
|
||||||
* the bytes are already resident.
|
* already resident.
|
||||||
*
|
*
|
||||||
* @param buffer The whole dusk.dsk file's bytes.
|
* @param buffer The whole dusk.dsk file's bytes.
|
||||||
* @param bufferSize Number of bytes at `buffer`.
|
* @param bufferSize Number of bytes at `buffer`.
|
||||||
* @param outCompressed Set to the opened compressed archive on success.
|
* @param outZip Set to the opened archive on success.
|
||||||
* @param outStored Set to the opened stored archive on success.
|
|
||||||
* @return OK on success, error if too short, has a bad header/checksum, or
|
* @return OK on success, error if too short, has a bad header/checksum, or
|
||||||
* either archive fails to open.
|
* the archive fails to open.
|
||||||
*/
|
*/
|
||||||
errorret_t assetDskOpenFromBuffer(
|
errorret_t assetDskOpenFromBuffer(
|
||||||
uint8_t *buffer,
|
uint8_t *buffer,
|
||||||
const size_t bufferSize,
|
const size_t bufferSize,
|
||||||
zip_t **outCompressed,
|
zip_t **outZip
|
||||||
zip_t **outStored
|
|
||||||
);
|
);
|
||||||
@@ -24,20 +24,11 @@ errorret_t assetFileInit(
|
|||||||
file->params = params;
|
file->params = params;
|
||||||
file->output = output;
|
file->output = output;
|
||||||
|
|
||||||
// Stat the file, trying the compressed archive first and falling back to
|
|
||||||
// the stored one - remember which matched so assetFileOpen opens it from
|
|
||||||
// the right archive.
|
|
||||||
zip_stat_init(&file->stat);
|
zip_stat_init(&file->stat);
|
||||||
threadMutexLock(&ASSET.zipLock);
|
threadMutexLock(&ASSET.zipLock);
|
||||||
if(zip_stat(ASSET.zip, filename, 0, &file->stat) == 0) {
|
int statResult = zip_stat(ASSET.zip, filename, 0, &file->stat);
|
||||||
file->sourceZip = ASSET.zip;
|
|
||||||
} else if(zip_stat(ASSET.zipStored, filename, 0, &file->stat) == 0) {
|
|
||||||
file->sourceZip = ASSET.zipStored;
|
|
||||||
} else {
|
|
||||||
file->sourceZip = NULL;
|
|
||||||
}
|
|
||||||
threadMutexUnlock(&ASSET.zipLock);
|
threadMutexUnlock(&ASSET.zipLock);
|
||||||
if(file->sourceZip == NULL) {
|
if(statResult != 0) {
|
||||||
errorThrow("Failed to stat asset file: %s", filename);
|
errorThrow("Failed to stat asset file: %s", filename);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -85,11 +76,10 @@ errorret_t assetFileRewind(assetfile_t *file) {
|
|||||||
errorret_t assetFileOpen(assetfile_t *file) {
|
errorret_t assetFileOpen(assetfile_t *file) {
|
||||||
assertNotNull(file, "Asset file cannot be NULL.");
|
assertNotNull(file, "Asset file cannot be NULL.");
|
||||||
assertNotNull(file->filename, "Asset file filename cannot be NULL.");
|
assertNotNull(file->filename, "Asset file filename cannot be NULL.");
|
||||||
assertNotNull(file->sourceZip, "Asset file must be inited before opening.");
|
|
||||||
assertNull(file->zipFile, "Asset file already open.");
|
assertNull(file->zipFile, "Asset file already open.");
|
||||||
|
|
||||||
threadMutexLock(&ASSET.zipLock);
|
threadMutexLock(&ASSET.zipLock);
|
||||||
file->zipFile = zip_fopen(file->sourceZip, file->filename, 0);
|
file->zipFile = zip_fopen(ASSET.zip, file->filename, 0);
|
||||||
threadMutexUnlock(&ASSET.zipLock);
|
threadMutexUnlock(&ASSET.zipLock);
|
||||||
if(file->zipFile == NULL) {
|
if(file->zipFile == NULL) {
|
||||||
errorThrow("Failed to open asset file: %s", file->filename);
|
errorThrow("Failed to open asset file: %s", file->filename);
|
||||||
|
|||||||
@@ -9,7 +9,7 @@
|
|||||||
#include "error/error.h"
|
#include "error/error.h"
|
||||||
#include <zip.h>
|
#include <zip.h>
|
||||||
|
|
||||||
#define ASSET_FILE_NAME_MAX 48
|
#define ASSET_FILE_NAME_MAX 128
|
||||||
|
|
||||||
// Max bytes requested per zip_fread() call in assetFileRead(). Some
|
// Max bytes requested per zip_fread() call in assetFileRead(). Some
|
||||||
// zip_fread() implementations (seen on PSP) reject a single call asking
|
// zip_fread() implementations (seen on PSP) reject a single call asking
|
||||||
@@ -32,11 +32,6 @@ typedef struct assetfile_s {
|
|||||||
zip_int64_t position;
|
zip_int64_t position;
|
||||||
zip_int64_t lastRead;
|
zip_int64_t lastRead;
|
||||||
zip_file_t *zipFile;
|
zip_file_t *zipFile;
|
||||||
|
|
||||||
// The archive this file was found in (ASSET.zip or ASSET.zipStored),
|
|
||||||
// set by assetFileInit and used by assetFileOpen so lookups fall back
|
|
||||||
// correctly between the two dusk.dsk archives.
|
|
||||||
zip_t *sourceZip;
|
|
||||||
} assetfile_t;
|
} assetfile_t;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -17,5 +17,5 @@ add_subdirectory(locale)
|
|||||||
add_subdirectory(json)
|
add_subdirectory(json)
|
||||||
add_subdirectory(chunk)
|
add_subdirectory(chunk)
|
||||||
add_subdirectory(dmf)
|
add_subdirectory(dmf)
|
||||||
add_subdirectory(cutscene)
|
add_subdirectory(wav)
|
||||||
add_subdirectory(wav)
|
add_subdirectory(mp3)
|
||||||
@@ -52,15 +52,15 @@ assetloadercallbacks_t ASSET_LOADER_CALLBACKS[ASSET_LOADER_TYPE_COUNT] = {
|
|||||||
.dispose = assetChunkDispose
|
.dispose = assetChunkDispose
|
||||||
},
|
},
|
||||||
|
|
||||||
[ASSET_LOADER_TYPE_CUTSCENE] = {
|
|
||||||
.loadSync = assetCutsceneLoaderSync,
|
|
||||||
.loadAsync = assetCutsceneLoaderAsync,
|
|
||||||
.dispose = assetCutsceneDispose
|
|
||||||
},
|
|
||||||
|
|
||||||
[ASSET_LOADER_TYPE_WAV] = {
|
[ASSET_LOADER_TYPE_WAV] = {
|
||||||
.loadSync = assetWavLoaderSync,
|
.loadSync = assetWavLoaderSync,
|
||||||
.loadAsync = assetWavLoaderAsync,
|
.loadAsync = assetWavLoaderAsync,
|
||||||
.dispose = assetWavDispose
|
.dispose = assetWavDispose
|
||||||
},
|
},
|
||||||
|
|
||||||
|
[ASSET_LOADER_TYPE_MP3] = {
|
||||||
|
.loadSync = assetMp3LoaderSync,
|
||||||
|
.loadAsync = assetMp3LoaderAsync,
|
||||||
|
.dispose = assetMp3Dispose
|
||||||
|
},
|
||||||
};
|
};
|
||||||
@@ -13,8 +13,8 @@
|
|||||||
#include "asset/loader/locale/assetlocaleloader.h"
|
#include "asset/loader/locale/assetlocaleloader.h"
|
||||||
#include "asset/loader/json/assetjsonloader.h"
|
#include "asset/loader/json/assetjsonloader.h"
|
||||||
#include "asset/loader/chunk/assetchunkloader.h"
|
#include "asset/loader/chunk/assetchunkloader.h"
|
||||||
#include "asset/loader/cutscene/assetcutsceneloader.h"
|
|
||||||
#include "asset/loader/wav/assetwavloader.h"
|
#include "asset/loader/wav/assetwavloader.h"
|
||||||
|
#include "asset/loader/mp3/assetmp3loader.h"
|
||||||
|
|
||||||
typedef enum {
|
typedef enum {
|
||||||
ASSET_LOADER_TYPE_NULL,
|
ASSET_LOADER_TYPE_NULL,
|
||||||
@@ -26,8 +26,8 @@ typedef enum {
|
|||||||
ASSET_LOADER_TYPE_LOCALE,
|
ASSET_LOADER_TYPE_LOCALE,
|
||||||
ASSET_LOADER_TYPE_JSON,
|
ASSET_LOADER_TYPE_JSON,
|
||||||
ASSET_LOADER_TYPE_CHUNK,
|
ASSET_LOADER_TYPE_CHUNK,
|
||||||
ASSET_LOADER_TYPE_CUTSCENE,
|
|
||||||
ASSET_LOADER_TYPE_WAV,
|
ASSET_LOADER_TYPE_WAV,
|
||||||
|
ASSET_LOADER_TYPE_MP3,
|
||||||
|
|
||||||
ASSET_LOADER_TYPE_COUNT
|
ASSET_LOADER_TYPE_COUNT
|
||||||
} assetloadertype_t;
|
} assetloadertype_t;
|
||||||
@@ -40,8 +40,8 @@ typedef union {
|
|||||||
assetlocaleloaderloading_t locale;
|
assetlocaleloaderloading_t locale;
|
||||||
assetjsonloaderloading_t json;
|
assetjsonloaderloading_t json;
|
||||||
assetchunkloaderloading_t chunk;
|
assetchunkloaderloading_t chunk;
|
||||||
assetcutsceneloaderloading_t cutscene;
|
|
||||||
assetwavloaderloading_t wav;
|
assetwavloaderloading_t wav;
|
||||||
|
assetmp3loaderloading_t mp3;
|
||||||
} assetloaderloading_t;
|
} assetloaderloading_t;
|
||||||
|
|
||||||
typedef union {
|
typedef union {
|
||||||
@@ -52,8 +52,8 @@ typedef union {
|
|||||||
assetlocaleoutput_t locale;
|
assetlocaleoutput_t locale;
|
||||||
assetjsonoutput_t json;
|
assetjsonoutput_t json;
|
||||||
assetchunkoutput_t chunk;
|
assetchunkoutput_t chunk;
|
||||||
assetcutsceneoutput_t cutscene;
|
|
||||||
assetwavoutput_t wav;
|
assetwavoutput_t wav;
|
||||||
|
assetmp3output_t mp3;
|
||||||
} assetloaderoutput_t;
|
} assetloaderoutput_t;
|
||||||
|
|
||||||
typedef union {
|
typedef union {
|
||||||
@@ -62,8 +62,8 @@ typedef union {
|
|||||||
assetlocaleloaderinput_t locale;
|
assetlocaleloaderinput_t locale;
|
||||||
assetjsonloaderinput_t json;
|
assetjsonloaderinput_t json;
|
||||||
assetchunkloaderinput_t chunk;
|
assetchunkloaderinput_t chunk;
|
||||||
assetcutsceneloaderinput_t cutscene;
|
|
||||||
assetwavloaderinput_t wav;
|
assetwavloaderinput_t wav;
|
||||||
|
assetmp3loaderinput_t mp3;
|
||||||
} assetloaderinput_t;
|
} assetloaderinput_t;
|
||||||
|
|
||||||
typedef struct assetloading_s assetloading_t;
|
typedef struct assetloading_s assetloading_t;
|
||||||
|
|||||||
@@ -8,41 +8,284 @@
|
|||||||
#include "assetchunkloader.h"
|
#include "assetchunkloader.h"
|
||||||
#include "assert/assert.h"
|
#include "assert/assert.h"
|
||||||
#include "util/memory.h"
|
#include "util/memory.h"
|
||||||
#include "util/endian.h"
|
#include "util/string.h"
|
||||||
|
#include "asset/asset.h"
|
||||||
#include "asset/loader/assetloading.h"
|
#include "asset/loader/assetloading.h"
|
||||||
#include "asset/loader/assetentry.h"
|
#include "asset/loader/assetentry.h"
|
||||||
#include "asset/loader/assetloader.h"
|
#include "asset/loader/assetloader.h"
|
||||||
#include "asset/asset.h"
|
#include "asset/loader/json/assetjsonloader.h"
|
||||||
|
#include "display/color.h"
|
||||||
|
#include "display/texture/texture.h"
|
||||||
#include "rpg/overworld/worldpos.h"
|
#include "rpg/overworld/worldpos.h"
|
||||||
|
#include "yyjson.h"
|
||||||
|
|
||||||
|
#define ASSET_CHUNK_TERRAIN_TEXTURE "tiles.png"
|
||||||
|
|
||||||
|
// Per-shape corner Z offsets (sw, se, ne, nw) as offsets from a tile's own
|
||||||
|
// base Z, ported 1:1 from tools/asset/chunk/__main__.py's _RAMP_CORNERS.
|
||||||
|
// TILE_SHAPE_NULL's row is never read - assetChunkTilesHaveTerrain/
|
||||||
|
// assetChunkBuildTerrain skip those tiles outright.
|
||||||
|
static const float_t CHUNK_RAMP_CORNERS[TILE_SHAPE_COUNT][4] = {
|
||||||
|
[TILE_SHAPE_GROUND] = {0.0f, 0.0f, 0.0f, 0.0f},
|
||||||
|
[TILE_SHAPE_RAMP_NORTH] = {0.0f, 0.0f, 1.0f, 1.0f},
|
||||||
|
[TILE_SHAPE_RAMP_SOUTH] = {1.0f, 1.0f, 0.0f, 0.0f},
|
||||||
|
[TILE_SHAPE_RAMP_EAST] = {0.0f, 1.0f, 1.0f, 0.0f},
|
||||||
|
[TILE_SHAPE_RAMP_WEST] = {1.0f, 0.0f, 0.0f, 1.0f},
|
||||||
|
[TILE_SHAPE_RAMP_NORTHEAST] = {0.0f, 0.0f, 1.0f, 0.0f},
|
||||||
|
[TILE_SHAPE_RAMP_NORTHWEST] = {0.0f, 0.0f, 0.0f, 1.0f},
|
||||||
|
[TILE_SHAPE_RAMP_SOUTHEAST] = {0.0f, 1.0f, 0.0f, 0.0f},
|
||||||
|
[TILE_SHAPE_RAMP_SOUTHWEST] = {1.0f, 0.0f, 0.0f, 0.0f},
|
||||||
|
[TILE_SHAPE_RAMP_NORTHEAST_INNER] = {0.0f, 1.0f, 1.0f, 1.0f},
|
||||||
|
[TILE_SHAPE_RAMP_NORTHWEST_INNER] = {1.0f, 0.0f, 1.0f, 1.0f},
|
||||||
|
[TILE_SHAPE_RAMP_SOUTHEAST_INNER] = {1.0f, 1.0f, 1.0f, 0.0f},
|
||||||
|
[TILE_SHAPE_RAMP_SOUTHWEST_INNER] = {1.0f, 1.0f, 0.0f, 1.0f},
|
||||||
|
};
|
||||||
|
|
||||||
errorret_t assetChunkLoaderAsync(assetloading_t *loading) {
|
errorret_t assetChunkLoaderAsync(assetloading_t *loading) {
|
||||||
assertNotNull(loading, "Loading cannot be NULL");
|
assertNotNull(loading, "Loading cannot be NULL");
|
||||||
assertNotMainThread("Should be called from an async thread.");
|
assertNotMainThread("Should be called from an async thread.");
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
if(loading->loading.chunk.state != ASSET_CHUNK_LOADING_STATE_READ_FILE) {
|
static bool_t assetChunkTilesHaveTerrain(const tile_t *tiles) {
|
||||||
errorOk();
|
for(uint32_t i = 0; i < CHUNK_TILE_COUNT; i++) {
|
||||||
|
if(tiles[i].shape != TILE_SHAPE_NULL) return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reads the "tiles" array - a dense, fixed-size CHUNK_TILE_COUNT grid,
|
||||||
|
// one slot per (x, y) column at index x + y * CHUNK_WIDTH (position is
|
||||||
|
// implicit in the index, not stored). Each slot is either `null` (empty
|
||||||
|
// column, already zeroed = TILE_SHAPE_NULL) or a 2-element [type, z]
|
||||||
|
// array.
|
||||||
|
static void assetChunkParseTiles(yyjson_val *root, tile_t *tiles) {
|
||||||
|
memoryZero(tiles, CHUNK_TILE_COUNT * sizeof(tile_t));
|
||||||
|
|
||||||
|
yyjson_val *tilesArr = yyjson_obj_get(root, "tiles");
|
||||||
|
if(!yyjson_is_arr(tilesArr)) return;
|
||||||
|
|
||||||
|
size_t idx, len;
|
||||||
|
yyjson_val *tileVal;
|
||||||
|
yyjson_arr_foreach(tilesArr, idx, len, tileVal) {
|
||||||
|
if(idx >= CHUNK_TILE_COUNT) break;
|
||||||
|
if(!yyjson_is_arr(tileVal) || yyjson_arr_size(tileVal) < 2) continue;
|
||||||
|
|
||||||
|
int32_t type = (int32_t)yyjson_get_int(yyjson_arr_get(tileVal, 0));
|
||||||
|
int32_t z = (int32_t)yyjson_get_int(yyjson_arr_get(tileVal, 1));
|
||||||
|
tiles[idx] = (tile_t){ .shape = (tileshape_t)type, .z = (uint8_t)z };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Resolves "meshes" (external building references, by bare filename) into
|
||||||
|
// out->modelNames/meshOffsets starting at *ioIndex, advancing it as
|
||||||
|
// entries are written. Filenames are resolved as
|
||||||
|
// "models/buildings/<basename>.json" - a hardcoded stand-in for
|
||||||
|
// tools/asset/chunk/__main__.py's find_model() recursive search, valid
|
||||||
|
// as long as every building model lives flat under that one directory
|
||||||
|
// (true today - see the raw-json-maps plan notes for the tradeoff).
|
||||||
|
static void assetChunkParseMeshes(
|
||||||
|
yyjson_val *root, assetchunkoutput_t *out, uint8_t *ioIndex
|
||||||
|
) {
|
||||||
|
yyjson_val *meshesArr = yyjson_obj_get(root, "meshes");
|
||||||
|
if(!yyjson_is_arr(meshesArr)) return;
|
||||||
|
|
||||||
|
size_t idx, len;
|
||||||
|
yyjson_val *meshVal;
|
||||||
|
yyjson_arr_foreach(meshesArr, idx, len, meshVal) {
|
||||||
|
if(*ioIndex >= CHUNK_MESH_COUNT_MAX) break;
|
||||||
|
|
||||||
|
yyjson_val *fileVal = yyjson_obj_get(meshVal, "file");
|
||||||
|
if(!fileVal || !yyjson_is_str(fileVal)) continue;
|
||||||
|
|
||||||
|
char_t baseName[CHUNK_MESH_NAME_MAX];
|
||||||
|
stringCopy(baseName, yyjson_get_str(fileVal), sizeof(baseName));
|
||||||
|
char_t *dot = stringFindLastChar(baseName, '.');
|
||||||
|
if(dot != NULL) *dot = '\0';
|
||||||
|
|
||||||
|
uint8_t m = *ioIndex;
|
||||||
|
stringFormat(
|
||||||
|
out->modelNames[m], CHUNK_MESH_NAME_MAX,
|
||||||
|
"models/buildings/%s.json", baseName
|
||||||
|
);
|
||||||
|
|
||||||
|
vec3 offset = {0.0f, 0.0f, 0.0f};
|
||||||
|
yyjson_val *posArr = yyjson_obj_get(meshVal, "pos");
|
||||||
|
if(yyjson_is_arr(posArr) && yyjson_arr_size(posArr) >= 3) {
|
||||||
|
offset[0] = (float_t)yyjson_get_num(yyjson_arr_get(posArr, 0));
|
||||||
|
offset[1] = (float_t)yyjson_get_num(yyjson_arr_get(posArr, 1));
|
||||||
|
offset[2] = (float_t)yyjson_get_num(yyjson_arr_get(posArr, 2));
|
||||||
|
}
|
||||||
|
memoryCopy(out->meshOffsets[m], offset, sizeof(vec3));
|
||||||
|
|
||||||
|
(*ioIndex)++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
static void assetChunkParseEntities(yyjson_val *root, assetchunkoutput_t *out) {
|
||||||
|
out->entitySpawnCount = 0;
|
||||||
|
|
||||||
|
yyjson_val *arr = yyjson_obj_get(root, "entities");
|
||||||
|
if(!yyjson_is_arr(arr)) return;
|
||||||
|
|
||||||
|
size_t idx, len;
|
||||||
|
yyjson_val *val;
|
||||||
|
yyjson_arr_foreach(arr, idx, len, val) {
|
||||||
|
if(out->entitySpawnCount >= CHUNK_ENTITY_SPAWN_COUNT_MAX) break;
|
||||||
|
|
||||||
|
const char_t *type = yyjson_get_str(yyjson_obj_get(val, "type"));
|
||||||
|
yyjson_val *posArr = yyjson_obj_get(val, "pos");
|
||||||
|
if(type == NULL || !yyjson_is_arr(posArr) || yyjson_arr_size(posArr) < 3) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
worldpos_t pos = {
|
||||||
|
.x = (worldunit_t)yyjson_get_int(yyjson_arr_get(posArr, 0)),
|
||||||
|
.y = (worldunit_t)yyjson_get_int(yyjson_arr_get(posArr, 1)),
|
||||||
|
.z = (worldunit_t)yyjson_get_int(yyjson_arr_get(posArr, 2)),
|
||||||
|
};
|
||||||
|
|
||||||
|
chunkentityspawn_t *spawn = &out->entitySpawns[out->entitySpawnCount];
|
||||||
|
if(stringEquals(type, "global")) {
|
||||||
|
spawn->kind = CHUNK_ENTITY_SPAWN_KIND_GLOBAL;
|
||||||
|
spawn->globalId =
|
||||||
|
(uint16_t)yyjson_get_int(yyjson_obj_get(val, "globalId"));
|
||||||
|
spawn->itemId = 0;
|
||||||
|
spawn->itemQuantity = 0;
|
||||||
|
} else if(stringEquals(type, "item")) {
|
||||||
|
spawn->kind = CHUNK_ENTITY_SPAWN_KIND_ITEM;
|
||||||
|
spawn->globalId = 0;
|
||||||
|
spawn->itemId = (uint16_t)yyjson_get_int(yyjson_obj_get(val, "itemId"));
|
||||||
|
spawn->itemQuantity =
|
||||||
|
(uint8_t)yyjson_get_int(yyjson_obj_get(val, "quantity"));
|
||||||
|
} else {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
spawn->position = pos;
|
||||||
|
out->entitySpawnCount++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
static void assetChunkParseAreas(yyjson_val *root, assetchunkoutput_t *out) {
|
||||||
|
out->areaSpawnCount = 0;
|
||||||
|
|
||||||
|
yyjson_val *arr = yyjson_obj_get(root, "areas");
|
||||||
|
if(!yyjson_is_arr(arr)) return;
|
||||||
|
|
||||||
|
size_t idx, len;
|
||||||
|
yyjson_val *val;
|
||||||
|
yyjson_arr_foreach(arr, idx, len, val) {
|
||||||
|
if(out->areaSpawnCount >= CHUNK_AREA_COUNT_MAX) break;
|
||||||
|
|
||||||
|
yyjson_val *minArr = yyjson_obj_get(val, "min");
|
||||||
|
yyjson_val *maxArr = yyjson_obj_get(val, "max");
|
||||||
|
if(
|
||||||
|
!yyjson_is_arr(minArr) || yyjson_arr_size(minArr) < 3 ||
|
||||||
|
!yyjson_is_arr(maxArr) || yyjson_arr_size(maxArr) < 3
|
||||||
|
) continue;
|
||||||
|
|
||||||
|
chunkareaspawn_t *area = &out->areaSpawns[out->areaSpawnCount];
|
||||||
|
area->min = (worldpos_t){
|
||||||
|
.x = (worldunit_t)yyjson_get_int(yyjson_arr_get(minArr, 0)),
|
||||||
|
.y = (worldunit_t)yyjson_get_int(yyjson_arr_get(minArr, 1)),
|
||||||
|
.z = (worldunit_t)yyjson_get_int(yyjson_arr_get(minArr, 2)),
|
||||||
|
};
|
||||||
|
area->max = (worldpos_t){
|
||||||
|
.x = (worldunit_t)yyjson_get_int(yyjson_arr_get(maxArr, 0)),
|
||||||
|
.y = (worldunit_t)yyjson_get_int(yyjson_arr_get(maxArr, 1)),
|
||||||
|
.z = (worldunit_t)yyjson_get_int(yyjson_arr_get(maxArr, 2)),
|
||||||
|
};
|
||||||
|
area->callbackId =
|
||||||
|
(uint16_t)yyjson_get_int(yyjson_obj_get(val, "callbackId"));
|
||||||
|
area->notify = (uint8_t)yyjson_get_int(yyjson_obj_get(val, "notify"));
|
||||||
|
area->trigger = (uint8_t)yyjson_get_int(yyjson_obj_get(val, "trigger"));
|
||||||
|
out->areaSpawnCount++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Six vertices (2 CCW triangles) for one tile's quad, matching
|
||||||
|
// tools/asset/chunk/__main__.py's _tile_quad. Corner order: SW=(x,y),
|
||||||
|
// SE=(x+1,y), NE=(x+1,y+1), NW=(x,y+1). NORTH=+Y, EAST=+X.
|
||||||
|
static void assetChunkAppendTileQuad(
|
||||||
|
meshvertex_t *verts, uint32_t *vertCount,
|
||||||
|
const uint32_t x, const uint32_t y,
|
||||||
|
const float_t sw, const float_t se, const float_t ne, const float_t nw
|
||||||
|
) {
|
||||||
|
const float_t u0 = (float_t)x / (float_t)CHUNK_WIDTH;
|
||||||
|
const float_t u1 = (float_t)(x + 1) / (float_t)CHUNK_WIDTH;
|
||||||
|
const float_t v0 = (float_t)y / (float_t)CHUNK_HEIGHT;
|
||||||
|
const float_t v1 = (float_t)(y + 1) / (float_t)CHUNK_HEIGHT;
|
||||||
|
const float_t fx = (float_t)x;
|
||||||
|
const float_t fy = (float_t)y;
|
||||||
|
|
||||||
|
meshvertex_t *v = verts + *vertCount;
|
||||||
|
v[0] = (meshvertex_t){ .uv = {u0, v0}, .pos = {fx, fy, sw} };
|
||||||
|
v[1] = (meshvertex_t){ .uv = {u1, v0}, .pos = {fx + 1, fy, se} };
|
||||||
|
v[2] = (meshvertex_t){ .uv = {u1, v1}, .pos = {fx + 1, fy + 1, ne} };
|
||||||
|
v[3] = (meshvertex_t){ .uv = {u0, v0}, .pos = {fx, fy, sw} };
|
||||||
|
v[4] = (meshvertex_t){ .uv = {u1, v1}, .pos = {fx + 1, fy + 1, ne} };
|
||||||
|
v[5] = (meshvertex_t){ .uv = {u0, v1}, .pos = {fx, fy + 1, nw} };
|
||||||
|
*vertCount += 6;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Builds a mesh_t straight from the tile grid - one quad per non-null
|
||||||
|
// tile column, shaped by CHUNK_RAMP_CORNERS - the runtime equivalent of
|
||||||
|
// tools/asset/chunk/__main__.py's build_terrain_verts. Only called once
|
||||||
|
// assetChunkTilesHaveTerrain has confirmed at least one real tile exists.
|
||||||
|
// Mirrors assetMeshLoaderSync's meshInit/meshFlush/free-after-upload
|
||||||
|
// sequence (assetmeshloader.c) since this produces the same
|
||||||
|
// assetmeshoutput_t shape, just from generated verts instead of a file.
|
||||||
|
static errorret_t assetChunkBuildTerrain(
|
||||||
|
const tile_t *tiles, assetmeshoutput_t *out
|
||||||
|
) {
|
||||||
|
meshvertex_t *verts = memoryAllocate(
|
||||||
|
CHUNK_TILE_COUNT * 6 * sizeof(meshvertex_t)
|
||||||
|
);
|
||||||
|
uint32_t vertCount = 0;
|
||||||
|
|
||||||
|
for(uint32_t y = 0; y < CHUNK_HEIGHT; y++) {
|
||||||
|
for(uint32_t x = 0; x < CHUNK_WIDTH; x++) {
|
||||||
|
const tile_t *tile = &tiles[x + y * CHUNK_WIDTH];
|
||||||
|
if(tile->shape == TILE_SHAPE_NULL) continue;
|
||||||
|
|
||||||
|
const float_t *corners = CHUNK_RAMP_CORNERS[tile->shape];
|
||||||
|
const float_t fz = (float_t)tile->z;
|
||||||
|
assetChunkAppendTileQuad(
|
||||||
|
verts, &vertCount, x, y,
|
||||||
|
(fz + corners[0]) * WORLD_LAYER_HEIGHT,
|
||||||
|
(fz + corners[1]) * WORLD_LAYER_HEIGHT,
|
||||||
|
(fz + corners[2]) * WORLD_LAYER_HEIGHT,
|
||||||
|
(fz + corners[3]) * WORLD_LAYER_HEIGHT
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
assertNull(loading->loading.chunk.data, "Data already defined?");
|
assertTrue(vertCount > 0, "Terrain build called with no terrain tiles.");
|
||||||
|
|
||||||
assetfile_t *file = &loading->loading.chunk.file;
|
out->vertices = verts;
|
||||||
assetLoaderErrorChain(loading,
|
errorret_t ret = meshInit(
|
||||||
assetFileInit(file, loading->entry->name, NULL, NULL)
|
&out->mesh, MESH_PRIMITIVE_TYPE_TRIANGLES, (int32_t)vertCount, verts
|
||||||
);
|
);
|
||||||
|
if(errorIsNotOk(ret)) {
|
||||||
|
memoryFree(out->vertices);
|
||||||
|
out->vertices = NULL;
|
||||||
|
errorChain(ret);
|
||||||
|
}
|
||||||
|
out->meshInitialized = true;
|
||||||
|
|
||||||
uint8_t *data = memoryAllocate(file->size);
|
ret = meshFlush(&out->mesh, 0, (int32_t)vertCount);
|
||||||
assetLoaderErrorChain(loading, assetFileOpen(file));
|
if(errorIsNotOk(ret)) {
|
||||||
assetLoaderErrorChain(loading, assetFileRead(file, data, file->size));
|
meshDispose(&out->mesh);
|
||||||
assetLoaderErrorChain(loading, assetFileClose(file));
|
out->meshInitialized = false;
|
||||||
assetLoaderErrorChain(loading, assetFileDispose(file));
|
memoryFree(out->vertices);
|
||||||
assertTrue(
|
out->vertices = NULL;
|
||||||
file->lastRead == file->size,
|
errorChain(ret);
|
||||||
"Failed to read entire chunk file."
|
}
|
||||||
);
|
|
||||||
|
#if defined(DUSK_OPENGL) && !defined(DUSK_OPENGL_LEGACY)
|
||||||
|
memoryFree(out->vertices);
|
||||||
|
out->vertices = NULL;
|
||||||
|
#endif
|
||||||
|
|
||||||
loading->loading.chunk.data = data;
|
|
||||||
loading->loading.chunk.state = ASSET_CHUNK_LOADING_STATE_PARSE;
|
|
||||||
loading->entry->state = ASSET_ENTRY_STATE_PENDING_SYNC;
|
|
||||||
errorOk();
|
errorOk();
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -55,8 +298,8 @@ errorret_t assetChunkLoaderSync(assetloading_t *loading) {
|
|||||||
|
|
||||||
switch(loading->loading.chunk.state) {
|
switch(loading->loading.chunk.state) {
|
||||||
case ASSET_CHUNK_LOADING_STATE_INITIAL:
|
case ASSET_CHUNK_LOADING_STATE_INITIAL:
|
||||||
loading->loading.chunk.state = ASSET_CHUNK_LOADING_STATE_READ_FILE;
|
loading->loading.chunk.state = ASSET_CHUNK_LOADING_STATE_PARSE;
|
||||||
loading->entry->state = ASSET_ENTRY_STATE_PENDING_ASYNC;
|
loading->entry->state = ASSET_ENTRY_STATE_PENDING_SYNC;
|
||||||
errorOk();
|
errorOk();
|
||||||
|
|
||||||
case ASSET_CHUNK_LOADING_STATE_PARSE:
|
case ASSET_CHUNK_LOADING_STATE_PARSE:
|
||||||
@@ -69,9 +312,7 @@ errorret_t assetChunkLoaderSync(assetloading_t *loading) {
|
|||||||
out->modelEntries[m] = assetLock(
|
out->modelEntries[m] = assetLock(
|
||||||
out->modelNames[m], ASSET_LOADER_TYPE_MODEL, NULL
|
out->modelNames[m], ASSET_LOADER_TYPE_MODEL, NULL
|
||||||
);
|
);
|
||||||
assertNotNull(
|
assertNotNull(out->modelEntries[m], "Failed to lock model.");
|
||||||
out->modelEntries[m], "Failed to lock model."
|
|
||||||
);
|
|
||||||
loading->entry->state = ASSET_ENTRY_STATE_PENDING_SYNC;
|
loading->entry->state = ASSET_ENTRY_STATE_PENDING_SYNC;
|
||||||
errorOk();
|
errorOk();
|
||||||
}
|
}
|
||||||
@@ -93,126 +334,103 @@ errorret_t assetChunkLoaderSync(assetloading_t *loading) {
|
|||||||
errorOk();
|
errorOk();
|
||||||
}
|
}
|
||||||
|
|
||||||
uint8_t *data = loading->loading.chunk.data;
|
// --- PARSE: lock+require the chunk's own JSON as a sub-asset, exactly
|
||||||
assertNotNull(data, "Chunk data should have been loaded by now.");
|
// like assetmodelloader.c's ASSET_MODEL_LOADING_STATE_LOCK_ASSETS does
|
||||||
|
// for its model descriptor, then read everything out of it before
|
||||||
if(data[0] != 'D' || data[1] != 'C' || data[2] != 'F') {
|
// unlocking (the yyjson_doc/vals only stay valid while jsonEntry does).
|
||||||
memoryFree(data);
|
char_t jsonKey[ASSET_FILE_NAME_MAX];
|
||||||
assetLoaderErrorThrow(loading, "Invalid chunk file header");
|
stringFormat(jsonKey, sizeof(jsonKey), "json:%s", loading->entry->name);
|
||||||
}
|
assetloaderinput_t jsonInput;
|
||||||
|
memoryZero(&jsonInput, sizeof(jsonInput));
|
||||||
uint32_t version = endianLittleToHost32(*(uint32_t *)(data + 4));
|
stringCopy(
|
||||||
if(version != ASSET_CHUNK_FILE_VERSION) {
|
jsonInput.json.path, loading->entry->name, ASSET_FILE_NAME_MAX
|
||||||
memoryFree(data);
|
);
|
||||||
|
assetentry_t *jsonEntry =
|
||||||
|
assetLock(jsonKey, ASSET_LOADER_TYPE_JSON, &jsonInput);
|
||||||
|
errorret_t jsonRet = assetRequireLoaded(jsonEntry);
|
||||||
|
if(errorIsNotOk(jsonRet)) {
|
||||||
|
assetUnlockEntry(jsonEntry);
|
||||||
assetLoaderErrorThrow(
|
assetLoaderErrorThrow(
|
||||||
loading, "Unsupported chunk file version %u", version
|
loading, "Failed to load chunk JSON: %s", loading->entry->name
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
size_t offset = 8;
|
yyjson_val *root = yyjson_doc_get_root(jsonEntry->data.json);
|
||||||
|
|
||||||
size_t tileSize = CHUNK_TILE_COUNT * sizeof(tile_t);
|
tile_t tiles[CHUNK_TILE_COUNT];
|
||||||
out->tiles = memoryAllocate(tileSize);
|
assetChunkParseTiles(root, tiles);
|
||||||
memoryCopy(out->tiles, data + offset, tileSize);
|
out->hasTerrain = assetChunkTilesHaveTerrain(tiles);
|
||||||
offset += tileSize;
|
|
||||||
|
|
||||||
for(size_t t = 0; t < CHUNK_TILE_COUNT; t++) {
|
uint8_t meshIndex = out->hasTerrain ? 1 : 0;
|
||||||
uint32_t *shape = (uint32_t *)&out->tiles[t].shape;
|
assetChunkParseMeshes(root, out, &meshIndex);
|
||||||
*shape = endianLittleToHost32(*shape);
|
out->meshCount = meshIndex;
|
||||||
}
|
|
||||||
|
|
||||||
out->meshCount = data[offset];
|
assetChunkParseEntities(root, out);
|
||||||
offset += sizeof(uint8_t);
|
assetChunkParseAreas(root, out);
|
||||||
assertTrue(
|
|
||||||
out->meshCount <= CHUNK_MESH_COUNT_MAX,
|
|
||||||
"Chunk mesh count exceeds maximum."
|
|
||||||
);
|
|
||||||
|
|
||||||
for(uint8_t m = 0; m < out->meshCount; m++) {
|
assetUnlockEntry(jsonEntry);
|
||||||
uint8_t nameLen = 0;
|
|
||||||
while(
|
|
||||||
data[offset + nameLen] != '\0' &&
|
|
||||||
nameLen < CHUNK_MESH_NAME_MAX - 1
|
|
||||||
) {
|
|
||||||
nameLen++;
|
|
||||||
}
|
|
||||||
memoryCopy(out->modelNames[m], data + offset, nameLen);
|
|
||||||
out->modelNames[m][nameLen] = '\0';
|
|
||||||
offset += nameLen + 1;
|
|
||||||
|
|
||||||
memoryCopy(out->meshOffsets[m], data + offset, sizeof(vec3));
|
out->tiles = memoryAllocate(CHUNK_TILE_COUNT * sizeof(tile_t));
|
||||||
offset += sizeof(vec3);
|
memoryCopy(out->tiles, tiles, CHUNK_TILE_COUNT * sizeof(tile_t));
|
||||||
out->meshOffsets[m][0] = endianLittleToHostFloat(out->meshOffsets[m][0]);
|
|
||||||
out->meshOffsets[m][1] = endianLittleToHostFloat(out->meshOffsets[m][1]);
|
|
||||||
out->meshOffsets[m][2] = endianLittleToHostFloat(out->meshOffsets[m][2]);
|
|
||||||
}
|
|
||||||
|
|
||||||
out->entitySpawnCount = data[offset];
|
// Terrain: build the mesh, then wrap it in synthetic (non-cache,
|
||||||
offset += sizeof(uint8_t);
|
// non-refcounted) mesh/model entries so modelEntries[0] behaves exactly
|
||||||
assertTrue(
|
// like a real file-backed model entry for every downstream consumer -
|
||||||
out->entitySpawnCount <= CHUNK_ENTITY_SPAWN_COUNT_MAX,
|
// see the header's doc comment on hasTerrain/terrainMeshEntry.
|
||||||
"Chunk entity spawn count exceeds maximum."
|
if(out->hasTerrain) {
|
||||||
);
|
assetmeshoutput_t terrainMesh;
|
||||||
|
memoryZero(&terrainMesh, sizeof(terrainMesh));
|
||||||
for(uint8_t s = 0; s < out->entitySpawnCount; s++) {
|
errorret_t terrainRet = assetChunkBuildTerrain(out->tiles, &terrainMesh);
|
||||||
chunkentityspawn_t *spawn = &out->entitySpawns[s];
|
if(errorIsNotOk(terrainRet)) {
|
||||||
spawn->kind = (chunkentityspawnkind_t)data[offset];
|
memoryFree(out->tiles);
|
||||||
offset += sizeof(uint8_t);
|
out->tiles = NULL;
|
||||||
|
assetLoaderErrorThrow(
|
||||||
uint16_t a;
|
loading, "Failed to build chunk terrain mesh: %s",
|
||||||
memoryCopy(&a, data + offset, sizeof(uint16_t));
|
loading->entry->name
|
||||||
a = endianLittleToHost16(a);
|
);
|
||||||
offset += sizeof(uint16_t);
|
|
||||||
|
|
||||||
uint8_t b = data[offset];
|
|
||||||
offset += sizeof(uint8_t);
|
|
||||||
|
|
||||||
if(spawn->kind == CHUNK_ENTITY_SPAWN_KIND_ITEM) {
|
|
||||||
spawn->globalId = 0;
|
|
||||||
spawn->itemId = a;
|
|
||||||
spawn->itemQuantity = b;
|
|
||||||
} else {
|
|
||||||
spawn->globalId = a;
|
|
||||||
spawn->itemId = 0;
|
|
||||||
spawn->itemQuantity = 0;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
spawn->position = worldPosReadLE(data, &offset);
|
assetloaderinput_t texInput = { .texture = TEXTURE_FORMAT_RGBA };
|
||||||
|
assetentry_t *texEntry = assetLock(
|
||||||
|
ASSET_CHUNK_TERRAIN_TEXTURE, ASSET_LOADER_TYPE_TEXTURE, &texInput
|
||||||
|
);
|
||||||
|
errorret_t texRet = assetRequireLoaded(texEntry);
|
||||||
|
if(errorIsNotOk(texRet)) {
|
||||||
|
assetUnlockEntry(texEntry);
|
||||||
|
meshDispose(&terrainMesh.mesh);
|
||||||
|
memoryFree(out->tiles);
|
||||||
|
out->tiles = NULL;
|
||||||
|
assetLoaderErrorThrow(
|
||||||
|
loading, "Failed to load chunk terrain texture: %s",
|
||||||
|
loading->entry->name
|
||||||
|
);
|
||||||
|
}
|
||||||
|
out->terrainTexEntry = texEntry;
|
||||||
|
|
||||||
|
out->terrainMeshEntry = memoryAllocate(sizeof(assetentry_t));
|
||||||
|
memoryZero(out->terrainMeshEntry, sizeof(assetentry_t));
|
||||||
|
out->terrainMeshEntry->type = ASSET_LOADER_TYPE_MESH;
|
||||||
|
out->terrainMeshEntry->state = ASSET_ENTRY_STATE_LOADED;
|
||||||
|
out->terrainMeshEntry->data.mesh = terrainMesh;
|
||||||
|
|
||||||
|
out->terrainModelEntry = memoryAllocate(sizeof(assetentry_t));
|
||||||
|
memoryZero(out->terrainModelEntry, sizeof(assetentry_t));
|
||||||
|
out->terrainModelEntry->type = ASSET_LOADER_TYPE_MODEL;
|
||||||
|
out->terrainModelEntry->state = ASSET_ENTRY_STATE_LOADED;
|
||||||
|
out->terrainModelEntry->data.model.meshEntry = out->terrainMeshEntry;
|
||||||
|
out->terrainModelEntry->data.model.texEntry = out->terrainTexEntry;
|
||||||
|
out->terrainModelEntry->data.model.color = COLOR_WHITE;
|
||||||
|
|
||||||
|
out->modelEntries[0] = out->terrainModelEntry;
|
||||||
}
|
}
|
||||||
|
|
||||||
out->areaSpawnCount = data[offset];
|
|
||||||
offset += sizeof(uint8_t);
|
|
||||||
assertTrue(
|
|
||||||
out->areaSpawnCount <= CHUNK_AREA_COUNT_MAX,
|
|
||||||
"Chunk area spawn count exceeds maximum."
|
|
||||||
);
|
|
||||||
|
|
||||||
for(uint8_t s = 0; s < out->areaSpawnCount; s++) {
|
|
||||||
chunkareaspawn_t *area = &out->areaSpawns[s];
|
|
||||||
area->min = worldPosReadLE(data, &offset);
|
|
||||||
area->max = worldPosReadLE(data, &offset);
|
|
||||||
|
|
||||||
uint16_t callbackId;
|
|
||||||
memoryCopy(&callbackId, data + offset, sizeof(uint16_t));
|
|
||||||
area->callbackId = endianLittleToHost16(callbackId);
|
|
||||||
offset += sizeof(uint16_t);
|
|
||||||
|
|
||||||
area->notify = data[offset];
|
|
||||||
offset += sizeof(uint8_t);
|
|
||||||
area->trigger = data[offset];
|
|
||||||
offset += sizeof(uint8_t);
|
|
||||||
}
|
|
||||||
|
|
||||||
memoryFree(data);
|
|
||||||
loading->loading.chunk.data = NULL;
|
|
||||||
|
|
||||||
if(out->meshCount == 0) {
|
if(out->meshCount == 0) {
|
||||||
loading->entry->state = ASSET_ENTRY_STATE_LOADED;
|
loading->entry->state = ASSET_ENTRY_STATE_LOADED;
|
||||||
errorOk();
|
errorOk();
|
||||||
}
|
}
|
||||||
|
|
||||||
loading->loading.chunk.state = ASSET_CHUNK_LOADING_STATE_LOAD_MODELS;
|
loading->loading.chunk.state = ASSET_CHUNK_LOADING_STATE_LOAD_MODELS;
|
||||||
loading->loading.chunk.modelIndex = 0;
|
loading->loading.chunk.modelIndex = out->hasTerrain ? 1 : 0;
|
||||||
loading->entry->state = ASSET_ENTRY_STATE_PENDING_SYNC;
|
loading->entry->state = ASSET_ENTRY_STATE_PENDING_SYNC;
|
||||||
errorOk();
|
errorOk();
|
||||||
}
|
}
|
||||||
@@ -231,8 +449,36 @@ errorret_t assetChunkDispose(assetentry_t *entry) {
|
|||||||
|
|
||||||
for(uint8_t m = 0; m < out->meshCount; m++) {
|
for(uint8_t m = 0; m < out->meshCount; m++) {
|
||||||
if(out->modelEntries[m] == NULL) continue;
|
if(out->modelEntries[m] == NULL) continue;
|
||||||
|
if(out->hasTerrain && m == 0) continue; // synthetic - freed below.
|
||||||
assetUnlockEntry(out->modelEntries[m]);
|
assetUnlockEntry(out->modelEntries[m]);
|
||||||
out->modelEntries[m] = NULL;
|
out->modelEntries[m] = NULL;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if(out->hasTerrain) {
|
||||||
|
if(out->terrainMeshEntry != NULL) {
|
||||||
|
assetmeshoutput_t *meshOut = &out->terrainMeshEntry->data.mesh;
|
||||||
|
if(meshOut->meshInitialized) {
|
||||||
|
meshDispose(&meshOut->mesh);
|
||||||
|
meshOut->meshInitialized = false;
|
||||||
|
}
|
||||||
|
if(meshOut->vertices != NULL) {
|
||||||
|
memoryFree(meshOut->vertices);
|
||||||
|
meshOut->vertices = NULL;
|
||||||
|
}
|
||||||
|
memoryFree(out->terrainMeshEntry);
|
||||||
|
out->terrainMeshEntry = NULL;
|
||||||
|
}
|
||||||
|
if(out->terrainModelEntry != NULL) {
|
||||||
|
memoryFree(out->terrainModelEntry);
|
||||||
|
out->terrainModelEntry = NULL;
|
||||||
|
}
|
||||||
|
if(out->terrainTexEntry != NULL) {
|
||||||
|
assetUnlockEntry(out->terrainTexEntry);
|
||||||
|
out->terrainTexEntry = NULL;
|
||||||
|
}
|
||||||
|
out->modelEntries[0] = NULL;
|
||||||
|
out->hasTerrain = false;
|
||||||
|
}
|
||||||
|
|
||||||
errorOk();
|
errorOk();
|
||||||
}
|
}
|
||||||
@@ -9,8 +9,6 @@
|
|||||||
#include "asset/assetfile.h"
|
#include "asset/assetfile.h"
|
||||||
#include "rpg/overworld/chunk.h"
|
#include "rpg/overworld/chunk.h"
|
||||||
|
|
||||||
#define ASSET_CHUNK_FILE_VERSION 5
|
|
||||||
|
|
||||||
typedef struct assetloading_s assetloading_t;
|
typedef struct assetloading_s assetloading_t;
|
||||||
typedef struct assetentry_s assetentry_t;
|
typedef struct assetentry_s assetentry_t;
|
||||||
|
|
||||||
@@ -20,16 +18,17 @@ typedef struct {
|
|||||||
|
|
||||||
typedef enum {
|
typedef enum {
|
||||||
ASSET_CHUNK_LOADING_STATE_INITIAL,
|
ASSET_CHUNK_LOADING_STATE_INITIAL,
|
||||||
ASSET_CHUNK_LOADING_STATE_READ_FILE,
|
|
||||||
ASSET_CHUNK_LOADING_STATE_PARSE,
|
ASSET_CHUNK_LOADING_STATE_PARSE,
|
||||||
ASSET_CHUNK_LOADING_STATE_LOAD_MODELS,
|
ASSET_CHUNK_LOADING_STATE_LOAD_MODELS,
|
||||||
ASSET_CHUNK_LOADING_STATE_DONE
|
ASSET_CHUNK_LOADING_STATE_DONE
|
||||||
} assetchunkloadingstate_t;
|
} assetchunkloadingstate_t;
|
||||||
|
|
||||||
typedef struct {
|
typedef struct {
|
||||||
assetfile_t file;
|
|
||||||
assetchunkloadingstate_t state;
|
assetchunkloadingstate_t state;
|
||||||
uint8_t *data;
|
|
||||||
|
// Index into assetchunkoutput_t.modelNames/modelEntries the external
|
||||||
|
// (non-terrain) model polling loop has reached - see
|
||||||
|
// ASSET_CHUNK_LOADING_STATE_LOAD_MODELS.
|
||||||
uint8_t modelIndex;
|
uint8_t modelIndex;
|
||||||
} assetchunkloaderloading_t;
|
} assetchunkloaderloading_t;
|
||||||
|
|
||||||
@@ -61,6 +60,27 @@ typedef struct {
|
|||||||
vec3 meshOffsets[CHUNK_MESH_COUNT_MAX];
|
vec3 meshOffsets[CHUNK_MESH_COUNT_MAX];
|
||||||
assetentry_t *modelEntries[CHUNK_MESH_COUNT_MAX];
|
assetentry_t *modelEntries[CHUNK_MESH_COUNT_MAX];
|
||||||
|
|
||||||
|
// Terrain mesh generated at load time from the tile grid (no baked
|
||||||
|
// .dmf/.json - see assetChunkBuildTerrain in assetchunkloader.c). NULL
|
||||||
|
// (with hasTerrain false) for a chunk with no non-null tiles, in which
|
||||||
|
// case modelEntries[0] (if meshCount > 0) is the first external mesh
|
||||||
|
// instead - matches the old baked pipeline's "only write a terrain
|
||||||
|
// model if it has vertices" behavior.
|
||||||
|
//
|
||||||
|
// terrainMeshEntry/terrainModelEntry are heap-allocated, plain
|
||||||
|
// assetentry_t values that are never passed to assetLock/assetGetEntry/
|
||||||
|
// assetUnlockEntry (only a real, name-keyed, ref-counted entry may be)
|
||||||
|
// - they exist purely so modelEntries[0] can point at something with
|
||||||
|
// the same ->state/->data.model/->data.mesh.mesh shape every other
|
||||||
|
// model/mesh entry has, so chunk.c/map.c/sceneoverworld.c don't need to
|
||||||
|
// know terrain isn't file-backed. Freed directly (not assetUnlockEntry)
|
||||||
|
// in assetChunkDispose. terrainTexEntry is a real, ref-counted texture
|
||||||
|
// entry (the shared "tiles.png") and must be assetUnlockEntry'd there.
|
||||||
|
bool_t hasTerrain;
|
||||||
|
assetentry_t *terrainMeshEntry;
|
||||||
|
assetentry_t *terrainModelEntry;
|
||||||
|
assetentry_t *terrainTexEntry;
|
||||||
|
|
||||||
uint8_t entitySpawnCount;
|
uint8_t entitySpawnCount;
|
||||||
chunkentityspawn_t entitySpawns[CHUNK_ENTITY_SPAWN_COUNT_MAX];
|
chunkentityspawn_t entitySpawns[CHUNK_ENTITY_SPAWN_COUNT_MAX];
|
||||||
|
|
||||||
@@ -69,9 +89,10 @@ typedef struct {
|
|||||||
} assetchunkoutput_t;
|
} assetchunkoutput_t;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Asynchronous loader for chunk assets. Reads the raw DCF file bytes into
|
* Async loader stub for chunk assets. Chunk loading is performed entirely
|
||||||
* the loading buffer so the sync phase can parse without blocking the
|
* on the main thread (it delegates to the JSON asset loader and to
|
||||||
* main thread on I/O.
|
* meshInit/meshFlush, both main-thread-only); this callback is never
|
||||||
|
* reached.
|
||||||
*
|
*
|
||||||
* @param loading Loading information for the asset being loaded.
|
* @param loading Loading information for the asset being loaded.
|
||||||
* @return Error code indicating success or failure of the load operation.
|
* @return Error code indicating success or failure of the load operation.
|
||||||
@@ -79,9 +100,11 @@ typedef struct {
|
|||||||
errorret_t assetChunkLoaderAsync(assetloading_t *loading);
|
errorret_t assetChunkLoaderAsync(assetloading_t *loading);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Synchronous loader for chunk assets. Validates the DCF binary previously
|
* Synchronous loader for chunk assets. Locks the chunk's JSON descriptor
|
||||||
* read by the async phase and populates the output assetchunkoutput_t with
|
* as a sub-asset, parses tiles/external mesh references/entity spawns/
|
||||||
* tile data and model paths.
|
* area spawns, generates the terrain mesh directly from the tile grid,
|
||||||
|
* and locks/waits for every referenced model (and the terrain's shared
|
||||||
|
* tileset texture) to finish loading.
|
||||||
*
|
*
|
||||||
* @param loading Loading information for the asset being loaded.
|
* @param loading Loading information for the asset being loaded.
|
||||||
* @return Error code indicating success or failure of the load operation.
|
* @return Error code indicating success or failure of the load operation.
|
||||||
|
|||||||
@@ -1,449 +0,0 @@
|
|||||||
/**
|
|
||||||
* Copyright (c) 2026 Dominic Masters
|
|
||||||
*
|
|
||||||
* This software is released under the MIT License.
|
|
||||||
* https://opensource.org/licenses/MIT
|
|
||||||
*/
|
|
||||||
|
|
||||||
#include "assetcutsceneloader.h"
|
|
||||||
#include "assert/assert.h"
|
|
||||||
#include "util/memory.h"
|
|
||||||
#include "util/endian.h"
|
|
||||||
#include "asset/loader/assetloading.h"
|
|
||||||
#include "asset/loader/assetentry.h"
|
|
||||||
#include "asset/loader/assetloader.h"
|
|
||||||
#include "asset/asset.h"
|
|
||||||
#include "rpg/overworld/worldpos.h"
|
|
||||||
|
|
||||||
// DCTS header: magic "DCTS" (4), version u32 LE (4), pauseType u8 (1),
|
|
||||||
// itemCount u8 (1), poolSize u16 LE (2) = 12 bytes.
|
|
||||||
#define ASSET_CUTSCENE_HEADER_SIZE 12
|
|
||||||
|
|
||||||
uint8_t assetCutsceneReadU8(const uint8_t *data, size_t *offset) {
|
|
||||||
uint8_t value = data[*offset];
|
|
||||||
*offset += sizeof(uint8_t);
|
|
||||||
return value;
|
|
||||||
}
|
|
||||||
|
|
||||||
uint16_t assetCutsceneReadU16(const uint8_t *data, size_t *offset) {
|
|
||||||
uint16_t value;
|
|
||||||
memoryCopy(&value, data + *offset, sizeof(uint16_t));
|
|
||||||
*offset += sizeof(uint16_t);
|
|
||||||
return endianLittleToHost16(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
uint32_t assetCutsceneReadU32(const uint8_t *data, size_t *offset) {
|
|
||||||
uint32_t value;
|
|
||||||
memoryCopy(&value, data + *offset, sizeof(uint32_t));
|
|
||||||
*offset += sizeof(uint32_t);
|
|
||||||
return endianLittleToHost32(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
float_t assetCutsceneReadFloat(const uint8_t *data, size_t *offset) {
|
|
||||||
float_t value;
|
|
||||||
memoryCopy(&value, data + *offset, sizeof(float_t));
|
|
||||||
*offset += sizeof(float_t);
|
|
||||||
return endianLittleToHostFloat(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Copies a length-prefixed string directly into an item's own embedded
|
|
||||||
// char_t[destCapacity] field (CUTSCENE_TEXT_MAX_CHARS and friends) - these
|
|
||||||
// are never pool references, see the item-field inventory in the runtime
|
|
||||||
// cutscene file design.
|
|
||||||
void assetCutsceneReadEmbeddedString(
|
|
||||||
const uint8_t *data,
|
|
||||||
size_t *offset,
|
|
||||||
char_t *dest,
|
|
||||||
const size_t destCapacity
|
|
||||||
) {
|
|
||||||
uint8_t len = assetCutsceneReadU8(data, offset);
|
|
||||||
assertTrue(len < destCapacity, "Cutscene string exceeds field capacity");
|
|
||||||
memoryCopy(dest, data + *offset, len);
|
|
||||||
dest[len] = '\0';
|
|
||||||
*offset += len;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Resolves a u16 pool offset (read from the item stream) to a real pointer
|
|
||||||
// into the entry's own persistent pool allocation.
|
|
||||||
const char_t * assetCutsceneReadPoolString(
|
|
||||||
const uint8_t *data,
|
|
||||||
size_t *offset,
|
|
||||||
const char_t *pool
|
|
||||||
) {
|
|
||||||
uint16_t poolOffset = assetCutsceneReadU16(data, offset);
|
|
||||||
return pool + poolOffset;
|
|
||||||
}
|
|
||||||
|
|
||||||
errorret_t assetCutsceneLoaderAsync(assetloading_t *loading) {
|
|
||||||
assertNotNull(loading, "Loading cannot be NULL");
|
|
||||||
assertNotMainThread("Should be called from an async thread.");
|
|
||||||
|
|
||||||
if(loading->loading.cutscene.state != ASSET_CUTSCENE_LOADING_STATE_READ_FILE) {
|
|
||||||
errorOk();
|
|
||||||
}
|
|
||||||
|
|
||||||
assertNull(loading->loading.cutscene.data, "Data already defined?");
|
|
||||||
|
|
||||||
assetfile_t *file = &loading->loading.cutscene.file;
|
|
||||||
assetLoaderErrorChain(loading,
|
|
||||||
assetFileInit(file, loading->entry->name, NULL, NULL)
|
|
||||||
);
|
|
||||||
|
|
||||||
uint8_t *data = memoryAllocate(file->size);
|
|
||||||
assetLoaderErrorChain(loading, assetFileOpen(file));
|
|
||||||
assetLoaderErrorChain(loading, assetFileRead(file, data, file->size));
|
|
||||||
assertTrue(
|
|
||||||
file->lastRead == file->size,
|
|
||||||
"Failed to read entire cutscene file."
|
|
||||||
);
|
|
||||||
// Saved before assetFileDispose zeroes the whole assetfile_t struct
|
|
||||||
// (including .size) - the sync phase needs the file's total length to
|
|
||||||
// locate the pool region, which starts poolSize bytes before the end.
|
|
||||||
loading->loading.cutscene.dataSize = (size_t)file->size;
|
|
||||||
|
|
||||||
assetLoaderErrorChain(loading, assetFileClose(file));
|
|
||||||
assetLoaderErrorChain(loading, assetFileDispose(file));
|
|
||||||
|
|
||||||
loading->loading.cutscene.data = data;
|
|
||||||
loading->loading.cutscene.state = ASSET_CUTSCENE_LOADING_STATE_PARSE;
|
|
||||||
loading->entry->state = ASSET_ENTRY_STATE_PENDING_SYNC;
|
|
||||||
errorOk();
|
|
||||||
}
|
|
||||||
|
|
||||||
errorret_t assetCutsceneLoaderSync(assetloading_t *loading) {
|
|
||||||
assertNotNull(loading, "Loading cannot be NULL");
|
|
||||||
assertTrue(loading->type == ASSET_LOADER_TYPE_CUTSCENE, "Invalid type.");
|
|
||||||
assertIsMainThread("Must be called from the main thread.");
|
|
||||||
|
|
||||||
if(loading->loading.cutscene.state == ASSET_CUTSCENE_LOADING_STATE_INITIAL) {
|
|
||||||
loading->loading.cutscene.state = ASSET_CUTSCENE_LOADING_STATE_READ_FILE;
|
|
||||||
loading->entry->state = ASSET_ENTRY_STATE_PENDING_ASYNC;
|
|
||||||
errorOk();
|
|
||||||
}
|
|
||||||
|
|
||||||
assetcutsceneoutput_t *out = &loading->entry->data.cutscene;
|
|
||||||
uint8_t *data = loading->loading.cutscene.data;
|
|
||||||
assertNotNull(data, "Cutscene data should have been loaded by now.");
|
|
||||||
|
|
||||||
size_t fileSize = loading->loading.cutscene.dataSize;
|
|
||||||
|
|
||||||
if(data[0] != 'D' || data[1] != 'C' || data[2] != 'T' || data[3] != 'S') {
|
|
||||||
memoryFree(data);
|
|
||||||
assetLoaderErrorThrow(loading, "Invalid cutscene file header");
|
|
||||||
}
|
|
||||||
|
|
||||||
size_t offset = 4;
|
|
||||||
uint32_t version = assetCutsceneReadU32(data, &offset);
|
|
||||||
if(version != ASSET_CUTSCENE_FILE_VERSION) {
|
|
||||||
memoryFree(data);
|
|
||||||
assetLoaderErrorThrow(
|
|
||||||
loading, "Unsupported cutscene file version %u", version
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
cutscenepause_t pauseType = (cutscenepause_t)assetCutsceneReadU8(data, &offset);
|
|
||||||
uint8_t itemCount = assetCutsceneReadU8(data, &offset);
|
|
||||||
uint16_t poolSize = assetCutsceneReadU16(data, &offset);
|
|
||||||
assertTrue(offset == ASSET_CUTSCENE_HEADER_SIZE, "Cutscene header size mismatch");
|
|
||||||
|
|
||||||
out->pool = poolSize > 0 ? memoryAllocate(poolSize) : NULL;
|
|
||||||
if(poolSize > 0) {
|
|
||||||
size_t poolStart = fileSize - (size_t)poolSize;
|
|
||||||
memoryCopy(out->pool, data + poolStart, poolSize);
|
|
||||||
}
|
|
||||||
const char_t *pool = out->pool;
|
|
||||||
|
|
||||||
out->items = memoryAllocate(itemCount * sizeof(cutsceneitem_t));
|
|
||||||
memoryZero(out->items, itemCount * sizeof(cutsceneitem_t));
|
|
||||||
|
|
||||||
for(uint8_t i = 0; i < itemCount; i++) {
|
|
||||||
cutsceneitem_t *item = &out->items[i];
|
|
||||||
item->type = (cutsceneitemtype_t)assetCutsceneReadU8(data, &offset);
|
|
||||||
|
|
||||||
switch(item->type) {
|
|
||||||
case CUTSCENE_ITEM_TYPE_TEXT:
|
|
||||||
assetCutsceneReadEmbeddedString(
|
|
||||||
data, &offset, item->text.text, CUTSCENE_TEXT_MAX_CHARS
|
|
||||||
);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_TEXT_MINI:
|
|
||||||
assetCutsceneReadEmbeddedString(
|
|
||||||
data, &offset, item->textMini.text, CUTSCENE_TEXT_MINI_MAX_CHARS
|
|
||||||
);
|
|
||||||
item->textMini.position[0] = assetCutsceneReadFloat(data, &offset);
|
|
||||||
item->textMini.position[1] = assetCutsceneReadFloat(data, &offset);
|
|
||||||
item->textMini.position[2] = assetCutsceneReadFloat(data, &offset);
|
|
||||||
item->textMini.duration = assetCutsceneReadFloat(data, &offset);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_TEXT_MINI_HIDE:
|
|
||||||
item->textMiniHide.index = assetCutsceneReadU8(data, &offset);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_WAIT:
|
|
||||||
item->wait = assetCutsceneReadFloat(data, &offset);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_ENTITY_TELEPORT:
|
|
||||||
item->entityTeleport.entityIndex = assetCutsceneReadU8(data, &offset);
|
|
||||||
item->entityTeleport.target = worldPosReadLE(data, &offset);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_ENTITY_WALK_TO: {
|
|
||||||
item->entityWalkTo.entityIndex = assetCutsceneReadU8(data, &offset);
|
|
||||||
item->entityWalkTo.walkAround = assetCutsceneReadU8(data, &offset) != 0;
|
|
||||||
uint8_t count = assetCutsceneReadU8(data, &offset);
|
|
||||||
uint16_t poolOffset = assetCutsceneReadU16(data, &offset);
|
|
||||||
item->entityWalkTo.count = count;
|
|
||||||
item->entityWalkTo.positions = (const worldpos_t *)(pool + poolOffset);
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_FADE:
|
|
||||||
item->fade.from.r = assetCutsceneReadU8(data, &offset);
|
|
||||||
item->fade.from.g = assetCutsceneReadU8(data, &offset);
|
|
||||||
item->fade.from.b = assetCutsceneReadU8(data, &offset);
|
|
||||||
item->fade.from.a = assetCutsceneReadU8(data, &offset);
|
|
||||||
item->fade.to.r = assetCutsceneReadU8(data, &offset);
|
|
||||||
item->fade.to.g = assetCutsceneReadU8(data, &offset);
|
|
||||||
item->fade.to.b = assetCutsceneReadU8(data, &offset);
|
|
||||||
item->fade.to.a = assetCutsceneReadU8(data, &offset);
|
|
||||||
item->fade.duration = assetCutsceneReadFloat(data, &offset);
|
|
||||||
item->fade.easing = (easingtype_t)assetCutsceneReadU8(data, &offset);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_SET_PAUSE:
|
|
||||||
item->setPause = (cutscenepause_t)assetCutsceneReadU8(data, &offset);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_ITEM_GIVE:
|
|
||||||
item->itemGive.item = (itemid_t)assetCutsceneReadU16(data, &offset);
|
|
||||||
item->itemGive.quantity = assetCutsceneReadU8(data, &offset);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_ENTITY_REMOVE:
|
|
||||||
item->entityRemove.entityIndex = assetCutsceneReadU8(data, &offset);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_ENTITY_ADD:
|
|
||||||
item->entityAdd.entityType = assetCutsceneReadU8(data, &offset);
|
|
||||||
item->entityAdd.position = worldPosReadLE(data, &offset);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_ENTITY_TURN:
|
|
||||||
item->entityTurn.entityIndex = assetCutsceneReadU8(data, &offset);
|
|
||||||
item->entityTurn.direction =
|
|
||||||
(entitydir_t)assetCutsceneReadU8(data, &offset);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_ENTITY_WALK_TO_ENTITY:
|
|
||||||
item->entityWalkToEntity.entityIndex =
|
|
||||||
assetCutsceneReadU8(data, &offset);
|
|
||||||
item->entityWalkToEntity.targetEntityIndex =
|
|
||||||
assetCutsceneReadU8(data, &offset);
|
|
||||||
item->entityWalkToEntity.offsetX =
|
|
||||||
worldUnitReadLE(data, &offset);
|
|
||||||
item->entityWalkToEntity.offsetY =
|
|
||||||
worldUnitReadLE(data, &offset);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_MAP_AREA_REMOVE:
|
|
||||||
item->mapAreaRemove.areaId = assetCutsceneReadU8(data, &offset);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_MAP_AREA_WAIT: {
|
|
||||||
uint8_t count = assetCutsceneReadU8(data, &offset);
|
|
||||||
uint16_t poolOffset = assetCutsceneReadU16(data, &offset);
|
|
||||||
assertTrue(
|
|
||||||
count <= CUTSCENE_MAP_AREA_WAIT_MAX,
|
|
||||||
"Cutscene map area wait count exceeds maximum"
|
|
||||||
);
|
|
||||||
item->mapAreaWait.count = count;
|
|
||||||
item->mapAreaWait.areaIds = (const uint8_t *)(pool + poolOffset);
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_START_BATTLE: {
|
|
||||||
item->startBattle.encounterType =
|
|
||||||
(battleencountertype_t)assetCutsceneReadU8(data, &offset);
|
|
||||||
item->startBattle.fleeAvailable =
|
|
||||||
assetCutsceneReadU8(data, &offset) != 0;
|
|
||||||
uint8_t enemyCount = assetCutsceneReadU8(data, &offset);
|
|
||||||
assertTrue(
|
|
||||||
enemyCount <= CUTSCENE_START_BATTLE_ENEMY_COUNT_MAX,
|
|
||||||
"Cutscene battle enemy count exceeds maximum"
|
|
||||||
);
|
|
||||||
item->startBattle.enemyCount = enemyCount;
|
|
||||||
for(uint8_t e = 0; e < enemyCount; e++) {
|
|
||||||
cutscenestartbattleenemy_t *enemy = &item->startBattle.enemies[e];
|
|
||||||
enemy->stats.attack = assetCutsceneReadU16(data, &offset);
|
|
||||||
enemy->stats.defense = assetCutsceneReadU16(data, &offset);
|
|
||||||
enemy->stats.magic = assetCutsceneReadU16(data, &offset);
|
|
||||||
enemy->stats.speed = assetCutsceneReadU16(data, &offset);
|
|
||||||
enemy->stats.luck = assetCutsceneReadU16(data, &offset);
|
|
||||||
enemy->healthMax = assetCutsceneReadU16(data, &offset);
|
|
||||||
enemy->mpMax = assetCutsceneReadU16(data, &offset);
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_EMOJI:
|
|
||||||
item->emoji.entityIndex = assetCutsceneReadU8(data, &offset);
|
|
||||||
item->emoji.duration = assetCutsceneReadFloat(data, &offset);
|
|
||||||
item->emoji.emojiType = (uiemojitype_t)assetCutsceneReadU8(data, &offset);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_SHAKE:
|
|
||||||
item->shake.amount = assetCutsceneReadU8(data, &offset);
|
|
||||||
item->shake.duration = assetCutsceneReadFloat(data, &offset);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_BATTLE_WAIT_STATE:
|
|
||||||
item->battleWaitState.state =
|
|
||||||
(battlestate_t)assetCutsceneReadU8(data, &offset);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_BATTLE_FORCE_ACTION:
|
|
||||||
item->battleForceAction.fighterIndex = assetCutsceneReadU8(data, &offset);
|
|
||||||
item->battleForceAction.targetIndex = assetCutsceneReadU8(data, &offset);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_MODAL: {
|
|
||||||
assetCutsceneReadEmbeddedString(
|
|
||||||
data, &offset, item->modal.title, CUTSCENE_MODAL_TITLE_MAX_CHARS
|
|
||||||
);
|
|
||||||
assetCutsceneReadEmbeddedString(
|
|
||||||
data, &offset, item->modal.message, CUTSCENE_MODAL_MESSAGE_MAX_CHARS
|
|
||||||
);
|
|
||||||
// v1 only supports the message-only form: MODAL and MODAL_OPTIONS
|
|
||||||
// share this same tag with no separate discriminator, and there is
|
|
||||||
// no native-callback registry yet to resolve an options callback.
|
|
||||||
// Read into a local first (not inline in the check below) - on a
|
|
||||||
// release build with DUSK_ASSERTIONS_FAKED, an assert's condition
|
|
||||||
// is never evaluated at all, so a byte-consuming call inside one
|
|
||||||
// would silently desync every item after it. This is untrusted
|
|
||||||
// file content anyway, so it gets a real error, not an assert.
|
|
||||||
uint8_t optionCount = assetCutsceneReadU8(data, &offset);
|
|
||||||
if(optionCount != 0) {
|
|
||||||
memoryFree(data);
|
|
||||||
memoryFree(out->items);
|
|
||||||
out->items = NULL;
|
|
||||||
if(out->pool != NULL) {
|
|
||||||
memoryFree(out->pool);
|
|
||||||
out->pool = NULL;
|
|
||||||
}
|
|
||||||
assetLoaderErrorThrow(
|
|
||||||
loading,
|
|
||||||
"Cutscene MODAL item with options is not supported in "
|
|
||||||
"file-based cutscenes yet - use MODAL_OPTIONS_MARKERS instead"
|
|
||||||
);
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_MODAL_OPTIONS_MARKERS: {
|
|
||||||
assetCutsceneReadEmbeddedString(
|
|
||||||
data, &offset, item->modalOptionsMarkers.title,
|
|
||||||
CUTSCENE_MODAL_TITLE_MAX_CHARS
|
|
||||||
);
|
|
||||||
assetCutsceneReadEmbeddedString(
|
|
||||||
data, &offset, item->modalOptionsMarkers.message,
|
|
||||||
CUTSCENE_MODAL_MESSAGE_MAX_CHARS
|
|
||||||
);
|
|
||||||
uint8_t optionCount = assetCutsceneReadU8(data, &offset);
|
|
||||||
assertTrue(
|
|
||||||
optionCount <= CUTSCENE_MODAL_OPTIONS_MARKERS_MAX,
|
|
||||||
"Cutscene modal option count exceeds maximum"
|
|
||||||
);
|
|
||||||
item->modalOptionsMarkers.optionCount = optionCount;
|
|
||||||
for(uint8_t o = 0; o < optionCount; o++) {
|
|
||||||
item->modalOptionsMarkers.options[o] =
|
|
||||||
assetCutsceneReadPoolString(data, &offset, pool);
|
|
||||||
item->modalOptionsMarkers.markers[o] =
|
|
||||||
assetCutsceneReadPoolString(data, &offset, pool);
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_MODAL_CLOSE:
|
|
||||||
case CUTSCENE_ITEM_TYPE_RESTART:
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_PRINT:
|
|
||||||
assetCutsceneReadEmbeddedString(
|
|
||||||
data, &offset, item->print.text, CUTSCENE_PRINT_MAX_CHARS
|
|
||||||
);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_MARKER:
|
|
||||||
item->marker.name = assetCutsceneReadPoolString(data, &offset, pool);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_SCENE:
|
|
||||||
item->sceneChange.type = (scenetype_t)assetCutsceneReadU8(data, &offset);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_SAVE_DEVICE_CHECK:
|
|
||||||
item->saveDeviceCheck.successMarker =
|
|
||||||
assetCutsceneReadPoolString(data, &offset, pool);
|
|
||||||
item->saveDeviceCheck.failureMarker =
|
|
||||||
assetCutsceneReadPoolString(data, &offset, pool);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case CUTSCENE_ITEM_TYPE_SAVE_LOAD_ALL_SLOTS:
|
|
||||||
item->saveLoadAllSlots.successMarker =
|
|
||||||
assetCutsceneReadPoolString(data, &offset, pool);
|
|
||||||
item->saveLoadAllSlots.failureMarker =
|
|
||||||
assetCutsceneReadPoolString(data, &offset, pool);
|
|
||||||
break;
|
|
||||||
|
|
||||||
default:
|
|
||||||
memoryFree(data);
|
|
||||||
memoryFree(out->items);
|
|
||||||
out->items = NULL;
|
|
||||||
if(out->pool != NULL) {
|
|
||||||
memoryFree(out->pool);
|
|
||||||
out->pool = NULL;
|
|
||||||
}
|
|
||||||
assetLoaderErrorThrow(
|
|
||||||
loading,
|
|
||||||
"Cutscene item type %u is not supported in file-based cutscenes "
|
|
||||||
"(item %u/%u, offset %u/%u, poolSize %u)",
|
|
||||||
(uint32_t)item->type, (uint32_t)i, (uint32_t)itemCount,
|
|
||||||
(uint32_t)offset, (uint32_t)fileSize, (uint32_t)poolSize
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
memoryFree(data);
|
|
||||||
loading->loading.cutscene.data = NULL;
|
|
||||||
|
|
||||||
out->cutscene.items = out->items;
|
|
||||||
out->cutscene.itemCount = itemCount;
|
|
||||||
out->cutscene.pause = pauseType;
|
|
||||||
out->cutscene.dataSize = 0;
|
|
||||||
|
|
||||||
loading->entry->state = ASSET_ENTRY_STATE_LOADED;
|
|
||||||
errorOk();
|
|
||||||
}
|
|
||||||
|
|
||||||
errorret_t assetCutsceneDispose(assetentry_t *entry) {
|
|
||||||
assertNotNull(entry, "Entry cannot be NULL");
|
|
||||||
assertTrue(entry->type == ASSET_LOADER_TYPE_CUTSCENE, "Invalid type.");
|
|
||||||
assertIsMainThread("Must be called from the main thread.");
|
|
||||||
|
|
||||||
assetcutsceneoutput_t *out = &entry->data.cutscene;
|
|
||||||
|
|
||||||
if(out->items != NULL) {
|
|
||||||
memoryFree(out->items);
|
|
||||||
out->items = NULL;
|
|
||||||
}
|
|
||||||
|
|
||||||
if(out->pool != NULL) {
|
|
||||||
memoryFree(out->pool);
|
|
||||||
out->pool = NULL;
|
|
||||||
}
|
|
||||||
|
|
||||||
errorOk();
|
|
||||||
}
|
|
||||||
@@ -1,143 +0,0 @@
|
|||||||
/**
|
|
||||||
* Copyright (c) 2026 Dominic Masters
|
|
||||||
*
|
|
||||||
* This software is released under the MIT License.
|
|
||||||
* https://opensource.org/licenses/MIT
|
|
||||||
*/
|
|
||||||
|
|
||||||
#pragma once
|
|
||||||
#include "asset/assetfile.h"
|
|
||||||
#include "rpg/cutscene/cutscene.h"
|
|
||||||
#include "rpg/cutscene/item/cutsceneitem.h"
|
|
||||||
|
|
||||||
#define ASSET_CUTSCENE_FILE_VERSION 1
|
|
||||||
|
|
||||||
typedef struct assetloading_s assetloading_t;
|
|
||||||
typedef struct assetentry_s assetentry_t;
|
|
||||||
|
|
||||||
typedef struct {
|
|
||||||
void *nothing;
|
|
||||||
} assetcutsceneloaderinput_t;
|
|
||||||
|
|
||||||
typedef enum {
|
|
||||||
ASSET_CUTSCENE_LOADING_STATE_INITIAL,
|
|
||||||
ASSET_CUTSCENE_LOADING_STATE_READ_FILE,
|
|
||||||
ASSET_CUTSCENE_LOADING_STATE_PARSE
|
|
||||||
} assetcutsceneloadingstate_t;
|
|
||||||
|
|
||||||
typedef struct {
|
|
||||||
assetfile_t file;
|
|
||||||
assetcutsceneloadingstate_t state;
|
|
||||||
uint8_t *data;
|
|
||||||
size_t dataSize;// Saved before assetFileDispose zeroes file.size.
|
|
||||||
} assetcutsceneloaderloading_t;
|
|
||||||
|
|
||||||
// Runtime-loaded cutscene: items/pool are heap-allocated to the file's
|
|
||||||
// actual declared sizes (not fixed-capacity), so an entry that never holds
|
|
||||||
// a cutscene costs nothing extra in the shared assetloaderoutput_t union -
|
|
||||||
// see assetchunkoutput_t.tiles for the same pattern.
|
|
||||||
typedef struct {
|
|
||||||
cutscene_t cutscene; // .items points at the items array below
|
|
||||||
cutsceneitem_t *items;
|
|
||||||
char_t *pool;
|
|
||||||
} assetcutsceneoutput_t;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Reads a uint8_t from the current offset, advancing *offset past it.
|
|
||||||
*
|
|
||||||
* @param data The buffer to read from.
|
|
||||||
* @param offset In/out cursor into data, advanced past the value read.
|
|
||||||
* @return The decoded uint8_t.
|
|
||||||
*/
|
|
||||||
uint8_t assetCutsceneReadU8(const uint8_t *data, size_t *offset);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Reads a little-endian uint16_t from a potentially-unaligned offset,
|
|
||||||
* advancing *offset past it.
|
|
||||||
*
|
|
||||||
* @param data The buffer to read from.
|
|
||||||
* @param offset In/out cursor into data, advanced past the value read.
|
|
||||||
* @return The decoded uint16_t.
|
|
||||||
*/
|
|
||||||
uint16_t assetCutsceneReadU16(const uint8_t *data, size_t *offset);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Reads a little-endian uint32_t from a potentially-unaligned offset,
|
|
||||||
* advancing *offset past it.
|
|
||||||
*
|
|
||||||
* @param data The buffer to read from.
|
|
||||||
* @param offset In/out cursor into data, advanced past the value read.
|
|
||||||
* @return The decoded uint32_t.
|
|
||||||
*/
|
|
||||||
uint32_t assetCutsceneReadU32(const uint8_t *data, size_t *offset);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Reads a little-endian float_t from a potentially-unaligned offset,
|
|
||||||
* advancing *offset past it.
|
|
||||||
*
|
|
||||||
* @param data The buffer to read from.
|
|
||||||
* @param offset In/out cursor into data, advanced past the value read.
|
|
||||||
* @return The decoded float_t.
|
|
||||||
*/
|
|
||||||
float_t assetCutsceneReadFloat(const uint8_t *data, size_t *offset);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Copies a length-prefixed string directly into an item's own embedded
|
|
||||||
* char_t[destCapacity] field (CUTSCENE_TEXT_MAX_CHARS and friends) - these
|
|
||||||
* are never pool references, see the item-field inventory in the runtime
|
|
||||||
* cutscene file design.
|
|
||||||
*
|
|
||||||
* @param data The buffer to read from.
|
|
||||||
* @param offset In/out cursor into data, advanced past the string read.
|
|
||||||
* @param dest Destination buffer to copy the string into.
|
|
||||||
* @param destCapacity Capacity of dest, including the null terminator.
|
|
||||||
*/
|
|
||||||
void assetCutsceneReadEmbeddedString(
|
|
||||||
const uint8_t *data,
|
|
||||||
size_t *offset,
|
|
||||||
char_t *dest,
|
|
||||||
const size_t destCapacity
|
|
||||||
);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Resolves a u16 pool offset (read from the item stream) to a real pointer
|
|
||||||
* into the entry's own persistent pool allocation.
|
|
||||||
*
|
|
||||||
* @param data The buffer to read the pool offset from.
|
|
||||||
* @param offset In/out cursor into data, advanced past the pool offset.
|
|
||||||
* @param pool The base pointer of the entry's persistent pool allocation.
|
|
||||||
* @return Pointer to the string within pool.
|
|
||||||
*/
|
|
||||||
const char_t * assetCutsceneReadPoolString(
|
|
||||||
const uint8_t *data,
|
|
||||||
size_t *offset,
|
|
||||||
const char_t *pool
|
|
||||||
);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Asynchronous loader for cutscene assets. Reads the raw DCTS file bytes
|
|
||||||
* into the loading buffer so the sync phase can parse without blocking the
|
|
||||||
* main thread on I/O.
|
|
||||||
*
|
|
||||||
* @param loading Loading information for the asset being loaded.
|
|
||||||
* @return Error code indicating success or failure of the load operation.
|
|
||||||
*/
|
|
||||||
errorret_t assetCutsceneLoaderAsync(assetloading_t *loading);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Synchronous loader for cutscene assets. Validates the DCTS binary
|
|
||||||
* previously read by the async phase and decodes it into a heap-allocated
|
|
||||||
* cutsceneitem_t array + string/data pool.
|
|
||||||
*
|
|
||||||
* @param loading Loading information for the asset being loaded.
|
|
||||||
* @return Error code indicating success or failure of the load operation.
|
|
||||||
*/
|
|
||||||
errorret_t assetCutsceneLoaderSync(assetloading_t *loading);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Disposer for cutscene assets.
|
|
||||||
*
|
|
||||||
* @param entry Asset entry containing the cutscene data to dispose.
|
|
||||||
* @return Error code indicating success or failure of the dispose operation.
|
|
||||||
*/
|
|
||||||
errorret_t assetCutsceneDispose(assetentry_t *entry);
|
|
||||||
@@ -115,7 +115,8 @@ errorret_t assetModelLoaderSync(assetloading_t *loading) {
|
|||||||
assetUnlockEntry(jsonEntry);
|
assetUnlockEntry(jsonEntry);
|
||||||
|
|
||||||
// Lock and load the mesh sub-asset.
|
// Lock and load the mesh sub-asset.
|
||||||
assetentry_t *meshEntry = assetLock(meshName, ASSET_LOADER_TYPE_MESH, NULL);
|
assetentry_t *meshEntry =
|
||||||
|
assetLock(meshName, ASSET_LOADER_TYPE_MESH, NULL);
|
||||||
ret = assetRequireLoaded(meshEntry);
|
ret = assetRequireLoaded(meshEntry);
|
||||||
if(errorIsNotOk(ret)) {
|
if(errorIsNotOk(ret)) {
|
||||||
assetUnlockEntry(meshEntry);
|
assetUnlockEntry(meshEntry);
|
||||||
|
|||||||
@@ -30,8 +30,8 @@ errorret_t assetLocaleLoaderAsync(assetloading_t *loading) {
|
|||||||
assetLoaderErrorChain(loading, assetFileOpen(&localeFile->file));
|
assetLoaderErrorChain(loading, assetFileOpen(&localeFile->file));
|
||||||
|
|
||||||
char_t buffer[1024];
|
char_t buffer[1024];
|
||||||
assetLoaderErrorChain(loading, assetLocaleGetString(
|
assetLoaderErrorChain(loading, assetLocaleGetHeader(
|
||||||
localeFile, "", 0, buffer, sizeof(buffer)
|
localeFile, buffer, sizeof(buffer)
|
||||||
));
|
));
|
||||||
assetLoaderErrorChain(loading, assetLocaleParseHeader(
|
assetLoaderErrorChain(loading, assetLocaleParseHeader(
|
||||||
localeFile, buffer, sizeof(buffer)
|
localeFile, buffer, sizeof(buffer)
|
||||||
@@ -487,6 +487,7 @@ errorret_t assetLocaleCacheFind(
|
|||||||
assertNotNull(file, "Asset file cannot be NULL.");
|
assertNotNull(file, "Asset file cannot be NULL.");
|
||||||
assertNotNull(messageId, "Message ID cannot be NULL.");
|
assertNotNull(messageId, "Message ID cannot be NULL.");
|
||||||
assertNotNull(outHit, "outHit cannot be NULL.");
|
assertNotNull(outHit, "outHit cannot be NULL.");
|
||||||
|
assertStrLenMin(messageId, 1, "Message ID cannot be empty.");
|
||||||
|
|
||||||
*outHit = false;
|
*outHit = false;
|
||||||
if(file->cache == NULL) errorOk();
|
if(file->cache == NULL) errorOk();
|
||||||
@@ -502,7 +503,8 @@ errorret_t assetLocaleCacheFind(
|
|||||||
if(i > 0) {
|
if(i > 0) {
|
||||||
assetlocalecacheentry_t hit = *entry;
|
assetlocalecacheentry_t hit = *entry;
|
||||||
memoryMove(
|
memoryMove(
|
||||||
&cache->entries[1], &cache->entries[0], i * sizeof(assetlocalecacheentry_t)
|
&cache->entries[1], &cache->entries[0],
|
||||||
|
i * sizeof(assetlocalecacheentry_t)
|
||||||
);
|
);
|
||||||
cache->entries[0] = hit;
|
cache->entries[0] = hit;
|
||||||
}
|
}
|
||||||
@@ -526,6 +528,7 @@ void assetLocaleCacheInsert(
|
|||||||
assertNotNull(file, "Asset file cannot be NULL.");
|
assertNotNull(file, "Asset file cannot be NULL.");
|
||||||
assertNotNull(messageId, "Message ID cannot be NULL.");
|
assertNotNull(messageId, "Message ID cannot be NULL.");
|
||||||
assertNotNull(value, "Value cannot be NULL.");
|
assertNotNull(value, "Value cannot be NULL.");
|
||||||
|
assertStrLenMin(messageId, 1, "Message ID cannot be empty.");
|
||||||
|
|
||||||
// Caching is a pure optimization - a message ID or value too long for a
|
// Caching is a pure optimization - a message ID or value too long for a
|
||||||
// fixed cache slot is just never cached, not an error.
|
// fixed cache slot is just never cached, not an error.
|
||||||
@@ -533,7 +536,8 @@ void assetLocaleCacheInsert(
|
|||||||
if(strlen(value) >= ASSET_LOCALE_CACHE_VALUE_MAX) return;
|
if(strlen(value) >= ASSET_LOCALE_CACHE_VALUE_MAX) return;
|
||||||
|
|
||||||
if(file->cache == NULL) {
|
if(file->cache == NULL) {
|
||||||
file->cache = (assetlocalecache_t *)memoryAllocate(sizeof(assetlocalecache_t));
|
file->cache =
|
||||||
|
(assetlocalecache_t *)memoryAllocate(sizeof(assetlocalecache_t));
|
||||||
memoryZero(file->cache, sizeof(assetlocalecache_t));
|
memoryZero(file->cache, sizeof(assetlocalecache_t));
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -553,7 +557,13 @@ void assetLocaleCacheInsert(
|
|||||||
stringCopy(entry->value, value, ASSET_LOCALE_CACHE_VALUE_MAX);
|
stringCopy(entry->value, value, ASSET_LOCALE_CACHE_VALUE_MAX);
|
||||||
}
|
}
|
||||||
|
|
||||||
errorret_t assetLocaleGetString(
|
// Shared by assetLocaleGetString (external callers, messageId required
|
||||||
|
// non-empty) and assetLocaleGetHeader (messageId "", the PO format's own
|
||||||
|
// sentinel for its header entry - see assetLocaleGetHeader). Caching is
|
||||||
|
// skipped entirely for an empty messageId: assetLocaleCacheFind/Insert
|
||||||
|
// both reject one outright (same guard as assetLocaleGetString's own),
|
||||||
|
// and it's a one-shot boot-time read anyway, not worth caching.
|
||||||
|
errorret_t assetLocaleGetStringLookup(
|
||||||
assetlocalefile_t *file,
|
assetlocalefile_t *file,
|
||||||
const char_t *messageId,
|
const char_t *messageId,
|
||||||
const int32_t pluralCount,
|
const int32_t pluralCount,
|
||||||
@@ -567,10 +577,12 @@ errorret_t assetLocaleGetString(
|
|||||||
assertTrue(stringBufferSize > 0, "String buffer size must be > 0");
|
assertTrue(stringBufferSize > 0, "String buffer size must be > 0");
|
||||||
|
|
||||||
bool_t cacheHit = false;
|
bool_t cacheHit = false;
|
||||||
errorChain(assetLocaleCacheFind(
|
if(messageId[0] != '\0') {
|
||||||
file, messageId, pluralCount, stringBuffer, stringBufferSize, &cacheHit
|
errorChain(assetLocaleCacheFind(
|
||||||
));
|
file, messageId, pluralCount, stringBuffer, stringBufferSize, &cacheHit
|
||||||
if(cacheHit) errorOk();
|
));
|
||||||
|
if(cacheHit) errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
assetfilelinereader_t reader;
|
assetfilelinereader_t reader;
|
||||||
|
|
||||||
@@ -715,11 +727,38 @@ errorret_t assetLocaleGetString(
|
|||||||
errorThrow("Failed to find msgstr for message ID: %s", messageId);
|
errorThrow("Failed to find msgstr for message ID: %s", messageId);
|
||||||
}
|
}
|
||||||
|
|
||||||
assetLocaleCacheInsert(file, messageId, pluralCount, stringBuffer);
|
if(messageId[0] != '\0') {
|
||||||
|
assetLocaleCacheInsert(file, messageId, pluralCount, stringBuffer);
|
||||||
|
}
|
||||||
|
|
||||||
errorOk();
|
errorOk();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
errorret_t assetLocaleGetString(
|
||||||
|
assetlocalefile_t *file,
|
||||||
|
const char_t *messageId,
|
||||||
|
const int32_t pluralCount,
|
||||||
|
char_t *stringBuffer,
|
||||||
|
const size_t stringBufferSize
|
||||||
|
) {
|
||||||
|
assertNotNull(messageId, "Message ID cannot be NULL.");
|
||||||
|
assertStrLenMin(messageId, 1, "Message ID cannot be empty.");
|
||||||
|
|
||||||
|
return assetLocaleGetStringLookup(
|
||||||
|
file, messageId, pluralCount, stringBuffer, stringBufferSize
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
errorret_t assetLocaleGetHeader(
|
||||||
|
assetlocalefile_t *file,
|
||||||
|
char_t *stringBuffer,
|
||||||
|
const size_t stringBufferSize
|
||||||
|
) {
|
||||||
|
return assetLocaleGetStringLookup(
|
||||||
|
file, "", 0, stringBuffer, stringBufferSize
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
errorret_t assetLocaleGetStringWithVA(
|
errorret_t assetLocaleGetStringWithVA(
|
||||||
assetlocalefile_t *file,
|
assetlocalefile_t *file,
|
||||||
const char_t *messageId,
|
const char_t *messageId,
|
||||||
|
|||||||
@@ -299,16 +299,42 @@ void assetLocaleCacheInsert(
|
|||||||
);
|
);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Looks up a translated string by message ID from the open locale file.
|
* Shared lookup core behind assetLocaleGetString and assetLocaleGetHeader:
|
||||||
|
* checks the file's cache first (see @ref assetLocaleCacheFind; skipped
|
||||||
|
* entirely for an empty messageId, since the cache rejects one), on a
|
||||||
|
* miss rewinds the file and scans from the beginning, then caches the
|
||||||
|
* result (see @ref assetLocaleCacheInsert, same empty-messageId skip)
|
||||||
|
* before returning. For plural entries (`msgid_plural`) the
|
||||||
|
* `pluralCount` is evaluated against the loaded plural rules to select
|
||||||
|
* the correct `msgstr[N]` form.
|
||||||
*
|
*
|
||||||
* Checks the file's cache first (see @ref assetLocaleCacheFind); on a miss,
|
* Unlike assetLocaleGetString, messageId may be `""` here (see
|
||||||
* rewinds the file and scans from the beginning, then caches the result
|
* assetLocaleGetHeader) - this is the shared implementation both of
|
||||||
* (see @ref assetLocaleCacheInsert) before returning. For plural entries
|
* them delegate to, not a public entry point of its own in practice.
|
||||||
* (`msgid_plural`) the `pluralCount` is evaluated against the loaded plural
|
|
||||||
* rules to select the correct `msgstr[N]` form.
|
|
||||||
*
|
*
|
||||||
* @param file Locale file to search. Must be open.
|
* @param file Locale file to search. Must be open.
|
||||||
* @param messageId PO message ID to find (`""` retrieves the header entry).
|
* @param messageId PO message ID to find, or `""` for the header entry.
|
||||||
|
* @param pluralCount Count used to select the plural form (ignored for
|
||||||
|
* singular entries).
|
||||||
|
* @param stringBuffer Buffer to receive the translated string.
|
||||||
|
* @param stringBufferSize Capacity of `stringBuffer` in bytes.
|
||||||
|
* @return OK on success, error if the message ID is not found or I/O fails.
|
||||||
|
*/
|
||||||
|
errorret_t assetLocaleGetStringLookup(
|
||||||
|
assetlocalefile_t *file,
|
||||||
|
const char_t *messageId,
|
||||||
|
const int32_t pluralCount,
|
||||||
|
char_t *stringBuffer,
|
||||||
|
const size_t stringBufferSize
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Looks up a translated string by message ID from the open locale file.
|
||||||
|
* See @ref assetLocaleGetStringLookup for the lookup/caching mechanics.
|
||||||
|
*
|
||||||
|
* @param file Locale file to search. Must be open.
|
||||||
|
* @param messageId PO message ID to find. Must be non-empty - use
|
||||||
|
* @ref assetLocaleGetHeader to read the header entry.
|
||||||
* @param pluralCount Count used to select the plural form (ignored for
|
* @param pluralCount Count used to select the plural form (ignored for
|
||||||
* singular entries).
|
* singular entries).
|
||||||
* @param stringBuffer Buffer to receive the translated string.
|
* @param stringBuffer Buffer to receive the translated string.
|
||||||
@@ -323,6 +349,27 @@ errorret_t assetLocaleGetString(
|
|||||||
const size_t stringBufferSize
|
const size_t stringBufferSize
|
||||||
);
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reads the PO file's header entry (the `msgid ""` block every PO file
|
||||||
|
* starts with, holding metadata like the plural-forms rule) - see @ref
|
||||||
|
* assetLocaleParseHeader, its caller. A dedicated function rather than
|
||||||
|
* calling assetLocaleGetString(file, "", ...) since messageId "" is a
|
||||||
|
* PO-format-internal sentinel, not a real (untrusted) caller-supplied
|
||||||
|
* message ID, so it doesn't go through assetLocaleGetString's normal
|
||||||
|
* non-empty validation.
|
||||||
|
*
|
||||||
|
* @param file Locale file to search. Must be open.
|
||||||
|
* @param stringBuffer Buffer to receive the raw header block.
|
||||||
|
* @param stringBufferSize Capacity of `stringBuffer` in bytes.
|
||||||
|
* @return OK on success, error if the header entry is missing or I/O
|
||||||
|
* fails.
|
||||||
|
*/
|
||||||
|
errorret_t assetLocaleGetHeader(
|
||||||
|
assetlocalefile_t *file,
|
||||||
|
char_t *stringBuffer,
|
||||||
|
const size_t stringBufferSize
|
||||||
|
);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Looks up a translated string and formats it with a `printf`-style variadic
|
* Looks up a translated string and formats it with a `printf`-style variadic
|
||||||
* argument list.
|
* argument list.
|
||||||
|
|||||||
@@ -5,5 +5,5 @@
|
|||||||
|
|
||||||
target_sources(${DUSK_LIBRARY_TARGET_NAME}
|
target_sources(${DUSK_LIBRARY_TARGET_NAME}
|
||||||
PUBLIC
|
PUBLIC
|
||||||
scenemainmenu.c
|
assetmp3loader.c
|
||||||
)
|
)
|
||||||
@@ -0,0 +1,255 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2026 Dominic Masters
|
||||||
|
*
|
||||||
|
* This software is released under the MIT License.
|
||||||
|
* https://opensource.org/licenses/MIT
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include "assetmp3loader.h"
|
||||||
|
#include "util/memory.h"
|
||||||
|
#include "util/math.h"
|
||||||
|
#include "assert/assert.h"
|
||||||
|
#include "asset/loader/assetloading.h"
|
||||||
|
#include "asset/loader/assetentry.h"
|
||||||
|
|
||||||
|
// How far into the file (after any ID3v2 tag) assetMp3ParseHeader() will
|
||||||
|
// search for the first valid MPEG frame sync. Real encoders write it
|
||||||
|
// within the first handful of bytes; this is a generous sane upper bound
|
||||||
|
// (matching assetwavloader.c's own approach to bounding a stack buffer)
|
||||||
|
// rather than a real expectation of needing that much.
|
||||||
|
#define ASSET_MP3_HEADER_SEARCH_MAX 8192
|
||||||
|
|
||||||
|
// MPEG-1 Layer III bitrates (kbps), indexed by the header's 4-bit bitrate
|
||||||
|
// index. Index 0 ("free format") and 15 (reserved) aren't supported.
|
||||||
|
static const uint16_t ASSET_MP3_BITRATE_MPEG1_L3[16] = {
|
||||||
|
0, 32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320, 0
|
||||||
|
};
|
||||||
|
|
||||||
|
// MPEG-2/2.5 Layer III bitrates (kbps) - a different table from MPEG-1's.
|
||||||
|
static const uint16_t ASSET_MP3_BITRATE_MPEG2_L3[16] = {
|
||||||
|
0, 8, 16, 24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 144, 160, 0
|
||||||
|
};
|
||||||
|
|
||||||
|
static const uint32_t ASSET_MP3_SAMPLE_RATE_MPEG1[4] = {
|
||||||
|
44100, 48000, 32000, 0
|
||||||
|
};
|
||||||
|
static const uint32_t ASSET_MP3_SAMPLE_RATE_MPEG2[4] = {
|
||||||
|
22050, 24000, 16000, 0
|
||||||
|
};
|
||||||
|
static const uint32_t ASSET_MP3_SAMPLE_RATE_MPEG25[4] = {
|
||||||
|
11025, 12000, 8000, 0
|
||||||
|
};
|
||||||
|
|
||||||
|
errorret_t assetMp3LoaderAsync(assetloading_t *loading) {
|
||||||
|
assertNotNull(loading, "Loading cannot be NULL");
|
||||||
|
assertNotMainThread("Async loader should not be on main thread.");
|
||||||
|
|
||||||
|
if(loading->loading.mp3.state != ASSET_MP3_LOADER_STATE_READ_HEADER) {
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
|
assetmp3file_t *mp3File = &loading->entry->data.mp3;
|
||||||
|
memoryZero(mp3File, sizeof(assetmp3file_t));
|
||||||
|
|
||||||
|
assetfile_t file;
|
||||||
|
assetLoaderErrorChain(loading, assetFileInit(
|
||||||
|
&file, loading->entry->name, NULL, NULL
|
||||||
|
));
|
||||||
|
assetLoaderErrorChain(loading, assetFileOpen(&file));
|
||||||
|
assetLoaderErrorChain(loading, assetMp3ParseHeader(&file, mp3File));
|
||||||
|
assetLoaderErrorChain(loading, assetFileClose(&file));
|
||||||
|
assetLoaderErrorChain(loading, assetFileDispose(&file));
|
||||||
|
|
||||||
|
loading->loading.mp3.state = ASSET_MP3_LOADER_STATE_DONE;
|
||||||
|
loading->entry->state = ASSET_ENTRY_STATE_PENDING_SYNC;
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
|
errorret_t assetMp3LoaderSync(assetloading_t *loading) {
|
||||||
|
assertNotNull(loading, "Loading cannot be NULL");
|
||||||
|
assertTrue(loading->type == ASSET_LOADER_TYPE_MP3, "Invalid type.");
|
||||||
|
assertIsMainThread("Must be called from the main thread.");
|
||||||
|
|
||||||
|
switch(loading->loading.mp3.state) {
|
||||||
|
case ASSET_MP3_LOADER_STATE_INITIAL:
|
||||||
|
loading->loading.mp3.state = ASSET_MP3_LOADER_STATE_READ_HEADER;
|
||||||
|
loading->entry->state = ASSET_ENTRY_STATE_PENDING_ASYNC;
|
||||||
|
errorOk();
|
||||||
|
break;
|
||||||
|
|
||||||
|
case ASSET_MP3_LOADER_STATE_DONE:
|
||||||
|
break;
|
||||||
|
|
||||||
|
default:
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
|
loading->entry->state = ASSET_ENTRY_STATE_LOADED;
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
|
errorret_t assetMp3Dispose(assetentry_t *entry) {
|
||||||
|
assertNotNull(entry, "Asset entry cannot be NULL");
|
||||||
|
assertTrue(entry->type == ASSET_LOADER_TYPE_MP3, "Invalid type.");
|
||||||
|
assertIsMainThread("Must be called from the main thread.");
|
||||||
|
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
|
errorret_t assetMp3ParseHeader(assetfile_t *file, assetmp3file_t *mp3File) {
|
||||||
|
assertNotNull(file, "Asset file cannot be NULL.");
|
||||||
|
assertNotNull(mp3File, "Mp3 file cannot be NULL.");
|
||||||
|
|
||||||
|
memoryZero(mp3File, sizeof(assetmp3file_t));
|
||||||
|
|
||||||
|
// Skip a leading ID3v2 tag if present: "ID3" + version(2) + flags(1) + a
|
||||||
|
// 4-byte syncsafe (7 usable bits/byte) size covering everything after
|
||||||
|
// this 10-byte header.
|
||||||
|
uint8_t id3Header[10];
|
||||||
|
errorChain(assetFileRead(file, id3Header, sizeof(id3Header)));
|
||||||
|
|
||||||
|
size_t searchBase;
|
||||||
|
if(memoryCompare(id3Header, "ID3", 3) == 0) {
|
||||||
|
const uint32_t tagSize = (
|
||||||
|
((uint32_t) (id3Header[6] & 0x7F) << 21) |
|
||||||
|
((uint32_t) (id3Header[7] & 0x7F) << 14) |
|
||||||
|
((uint32_t) (id3Header[8] & 0x7F) << 7) |
|
||||||
|
((uint32_t) (id3Header[9] & 0x7F))
|
||||||
|
);
|
||||||
|
errorChain(assetFileRead(file, NULL, tagSize));
|
||||||
|
searchBase = sizeof(id3Header) + tagSize;
|
||||||
|
} else {
|
||||||
|
// No ID3v2 tag - rewind the probe bytes just consumed so the frame
|
||||||
|
// sync search below starts from the true beginning of the file.
|
||||||
|
errorChain(assetFileRewind(file));
|
||||||
|
searchBase = 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
const size_t searchWindowSize = mathMin(
|
||||||
|
(size_t) ASSET_MP3_HEADER_SEARCH_MAX,
|
||||||
|
(size_t) file->size > searchBase ? (size_t) file->size - searchBase : 0
|
||||||
|
);
|
||||||
|
if(searchWindowSize < 4) {
|
||||||
|
errorThrow(
|
||||||
|
"MP3 file is too short to contain a frame header: %s", file->filename
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
uint8_t *window = (uint8_t *) memoryAllocate(searchWindowSize);
|
||||||
|
errorret_t readRet = assetFileRead(file, window, searchWindowSize);
|
||||||
|
if(errorIsNotOk(readRet)) {
|
||||||
|
memoryFree(window);
|
||||||
|
errorChain(readRet);
|
||||||
|
}
|
||||||
|
|
||||||
|
bool_t found = false;
|
||||||
|
size_t frameIndex = 0;
|
||||||
|
|
||||||
|
for(size_t i = 0; i + 4 <= searchWindowSize; i++) {
|
||||||
|
if(window[i] != 0xFF || (window[i + 1] & 0xE0) != 0xE0) continue;
|
||||||
|
|
||||||
|
const uint8_t versionBits = (window[i + 1] >> 3) & 0x3;
|
||||||
|
const uint8_t layerBits = (window[i + 1] >> 1) & 0x3;
|
||||||
|
// reserved version, or not Layer III
|
||||||
|
if(versionBits == 1 || layerBits != 1) continue;
|
||||||
|
|
||||||
|
const uint8_t bitrateIndex = (window[i + 2] >> 4) & 0xF;
|
||||||
|
const uint8_t sampleRateIndex = (window[i + 2] >> 2) & 0x3;
|
||||||
|
if(
|
||||||
|
bitrateIndex == 0 || bitrateIndex == 15 || sampleRateIndex == 3
|
||||||
|
) continue;
|
||||||
|
|
||||||
|
const uint8_t channelMode = (window[i + 3] >> 6) & 0x3;
|
||||||
|
const bool_t isMpeg1 = versionBits == 3;
|
||||||
|
|
||||||
|
mp3File->bitrateKbps = isMpeg1
|
||||||
|
? ASSET_MP3_BITRATE_MPEG1_L3[bitrateIndex]
|
||||||
|
: ASSET_MP3_BITRATE_MPEG2_L3[bitrateIndex];
|
||||||
|
mp3File->sampleRate = isMpeg1
|
||||||
|
? ASSET_MP3_SAMPLE_RATE_MPEG1[sampleRateIndex]
|
||||||
|
: (versionBits == 2
|
||||||
|
? ASSET_MP3_SAMPLE_RATE_MPEG2[sampleRateIndex]
|
||||||
|
: ASSET_MP3_SAMPLE_RATE_MPEG25[sampleRateIndex]);
|
||||||
|
mp3File->samplesPerFrame = isMpeg1 ? 1152 : 576;
|
||||||
|
mp3File->channels = channelMode == 3 ? 1 : 2;
|
||||||
|
|
||||||
|
// A Xing/Info header, if present, sits right after the side info -
|
||||||
|
// whose size depends on MPEG version and channel mode - immediately
|
||||||
|
// following the 4-byte header (plus a 2-byte CRC, if the protection
|
||||||
|
// bit says one follows).
|
||||||
|
const bool_t hasCrc = (window[i + 1] & 0x1) == 0;
|
||||||
|
const size_t sideInfoSize = isMpeg1
|
||||||
|
? (mp3File->channels == 1 ? 17 : 32)
|
||||||
|
: (mp3File->channels == 1 ? 9 : 17);
|
||||||
|
const size_t xingOffset = i + 4 + (hasCrc ? 2 : 0) + sideInfoSize;
|
||||||
|
|
||||||
|
if(
|
||||||
|
xingOffset + 8 <= searchWindowSize &&
|
||||||
|
(
|
||||||
|
memoryCompare(window + xingOffset, "Xing", 4) == 0 ||
|
||||||
|
memoryCompare(window + xingOffset, "Info", 4) == 0
|
||||||
|
)
|
||||||
|
) {
|
||||||
|
const uint8_t *flagsBytes = window + xingOffset + 4;
|
||||||
|
const uint32_t flags = (
|
||||||
|
((uint32_t) flagsBytes[0] << 24) | ((uint32_t) flagsBytes[1] << 16) |
|
||||||
|
((uint32_t) flagsBytes[2] << 8) | (uint32_t) flagsBytes[3]
|
||||||
|
);
|
||||||
|
if((flags & 0x1) != 0 && xingOffset + 12 <= searchWindowSize) {
|
||||||
|
const uint8_t *framesBytes = window + xingOffset + 8;
|
||||||
|
const uint32_t xingFrameCount = (
|
||||||
|
((uint32_t) framesBytes[0] << 24) |
|
||||||
|
((uint32_t) framesBytes[1] << 16) |
|
||||||
|
((uint32_t) framesBytes[2] << 8) |
|
||||||
|
(uint32_t) framesBytes[3]
|
||||||
|
);
|
||||||
|
// The Xing/Info header's frame count includes the header's own
|
||||||
|
// frame (this one, at `i`) - which libmad (and sceMp3) will
|
||||||
|
// attempt to decode like any other, but which doesn't contribute a
|
||||||
|
// real decodable frame of audio the way every other one does.
|
||||||
|
// Confirmed against a real LAME-encoded file: its Xing header
|
||||||
|
// declared 40 frames, but decoding actually produced exactly 39
|
||||||
|
// frames' worth of real PCM - without this -1, playback would
|
||||||
|
// permanently stall one frame short of the declared total (audible
|
||||||
|
// as "never loops"), since real decode output can never catch up
|
||||||
|
// to an overstated total.
|
||||||
|
if(xingFrameCount > 0) {
|
||||||
|
mp3File->totalFrames =
|
||||||
|
(size_t) (xingFrameCount - 1) * mp3File->samplesPerFrame;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
frameIndex = i;
|
||||||
|
found = true;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
memoryFree(window);
|
||||||
|
|
||||||
|
if(!found) {
|
||||||
|
errorThrow(
|
||||||
|
"MP3 file has no valid MPEG-1/2/2.5 Layer III frame within the first "
|
||||||
|
"%u bytes: %s",
|
||||||
|
(uint32_t) searchWindowSize, file->filename
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
mp3File->dataOffset = searchBase + frameIndex;
|
||||||
|
mp3File->dataSize = (size_t) file->size - mp3File->dataOffset;
|
||||||
|
|
||||||
|
// No Xing/Info header found - estimate assuming constant bitrate (the
|
||||||
|
// common case when one's genuinely absent; a real VBR file without one
|
||||||
|
// is rare and will just get an approximate duration/loop point instead
|
||||||
|
// of an exact one).
|
||||||
|
if(mp3File->totalFrames == 0) {
|
||||||
|
const float_t durationSeconds = (
|
||||||
|
((float_t) mp3File->dataSize * 8.0f) /
|
||||||
|
((float_t) mp3File->bitrateKbps * 1000.0f)
|
||||||
|
);
|
||||||
|
mp3File->totalFrames =
|
||||||
|
(size_t) (durationSeconds * (float_t) mp3File->sampleRate);
|
||||||
|
}
|
||||||
|
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
@@ -0,0 +1,113 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2026 Dominic Masters
|
||||||
|
*
|
||||||
|
* This software is released under the MIT License.
|
||||||
|
* https://opensource.org/licenses/MIT
|
||||||
|
*/
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
#include "error/error.h"
|
||||||
|
#include "asset/assetfile.h"
|
||||||
|
|
||||||
|
typedef struct assetloading_s assetloading_t;
|
||||||
|
typedef struct assetentry_s assetentry_t;
|
||||||
|
|
||||||
|
typedef struct { void *nothing; } assetmp3loaderinput_t;
|
||||||
|
|
||||||
|
typedef enum {
|
||||||
|
ASSET_MP3_LOADER_STATE_INITIAL,
|
||||||
|
ASSET_MP3_LOADER_STATE_READ_HEADER,
|
||||||
|
ASSET_MP3_LOADER_STATE_DONE
|
||||||
|
} assetmp3loaderstate_t;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
assetmp3loaderstate_t state;
|
||||||
|
} assetmp3loaderloading_t;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parsed metadata for an MP3 asset - deliberately just enough to configure
|
||||||
|
* a decoder and know the clip's total length, not anything about its
|
||||||
|
* actual compressed content (which is read/decoded on demand at playback
|
||||||
|
* time - see audiostreammp3.c). Only MPEG-1/2/2.5 Layer III ("MP3" in the
|
||||||
|
* everyday sense) is supported; Layers I/II are rejected.
|
||||||
|
*/
|
||||||
|
typedef struct {
|
||||||
|
uint32_t sampleRate;
|
||||||
|
uint8_t channels;
|
||||||
|
|
||||||
|
// 1152 for MPEG-1, 576 for MPEG-2/2.5 - how many PCM samples (per
|
||||||
|
// channel) one compressed MPEG frame decodes to.
|
||||||
|
uint16_t samplesPerFrame;
|
||||||
|
|
||||||
|
// The first frame's bitrate, in kbps. Used only as a fallback duration
|
||||||
|
// estimate (assuming CBR) when no Xing/Info header is found - see
|
||||||
|
// assetMp3ParseHeader()'s own comment.
|
||||||
|
uint32_t bitrateKbps;
|
||||||
|
|
||||||
|
// Byte offset (from the start of the file) of the first real MPEG
|
||||||
|
// frame, i.e. right after any leading ID3v2 tag.
|
||||||
|
size_t dataOffset;
|
||||||
|
|
||||||
|
// Bytes of compressed MPEG data, from dataOffset to the end of the file.
|
||||||
|
size_t dataSize;
|
||||||
|
|
||||||
|
// Decoded PCM frame count for the whole clip - exact if a Xing/Info
|
||||||
|
// header was found (the common case for anything encoded with a modern
|
||||||
|
// tool), otherwise estimated from bitrateKbps/dataSize assuming CBR (see
|
||||||
|
// assetMp3ParseHeader()'s own comment) - unlike assetwavfile_t.dataSize,
|
||||||
|
// MP3 has no header field that gives this directly.
|
||||||
|
size_t totalFrames;
|
||||||
|
} assetmp3file_t;
|
||||||
|
|
||||||
|
typedef assetmp3file_t assetmp3output_t;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Async (background-thread) half of the MP3 loader - opens the asset file,
|
||||||
|
* parses its header (see assetMp3ParseHeader()), and closes it again. Never
|
||||||
|
* buffers the compressed MPEG data itself; that's read on demand at
|
||||||
|
* playback time by audiostreammp3.c via its own independent file handle.
|
||||||
|
*
|
||||||
|
* @param loading The asset loading slot.
|
||||||
|
* @return Error indicating success or failure.
|
||||||
|
*/
|
||||||
|
errorret_t assetMp3LoaderAsync(assetloading_t *loading);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sync (main-thread) half of the MP3 loader - a simple state machine that
|
||||||
|
* schedules the async header parse and marks the entry loaded once it's
|
||||||
|
* done, mirroring assetWavLoaderSync()'s shape exactly.
|
||||||
|
*
|
||||||
|
* @param loading The asset loading slot.
|
||||||
|
* @return Error indicating success or failure.
|
||||||
|
*/
|
||||||
|
errorret_t assetMp3LoaderSync(assetloading_t *loading);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Disposes an MP3 asset entry. A no-op - an assetmp3file_t owns no heap
|
||||||
|
* allocations, and playback streams open their own independent file
|
||||||
|
* handles (see audiostreammp3.c).
|
||||||
|
*
|
||||||
|
* @param entry The asset entry to dispose.
|
||||||
|
* @return Error indicating success or failure.
|
||||||
|
*/
|
||||||
|
errorret_t assetMp3Dispose(assetentry_t *entry);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parses an MP3 file's metadata from an already-opened asset file
|
||||||
|
* positioned at its very start: skips a leading ID3v2 tag if present,
|
||||||
|
* scans forward for the first valid MPEG-1/2/2.5 Layer III frame header
|
||||||
|
* (rejecting anything else - other layers, or no valid frame found within
|
||||||
|
* a sane search window), and checks that frame for a Xing/Info header
|
||||||
|
* (found in the vast majority of real-world MP3s, VBR or CBR) to get an
|
||||||
|
* exact total-frame count; falls back to a CBR estimate from the first
|
||||||
|
* frame's bitrate and the file's remaining size if absent.
|
||||||
|
*
|
||||||
|
* Never reads more than a bounded lookahead window into memory - the bulk
|
||||||
|
* of the file (the actual compressed audio, following the parsed frame's
|
||||||
|
* position) is left untouched, exactly like assetWavParseHeader().
|
||||||
|
*
|
||||||
|
* @param file Asset file to parse, positioned at offset 0.
|
||||||
|
* @param mp3File Filled with the parsed metadata on success.
|
||||||
|
* @return Error indicating success or failure.
|
||||||
|
*/
|
||||||
|
errorret_t assetMp3ParseHeader(assetfile_t *file, assetmp3file_t *mp3File);
|
||||||
@@ -7,7 +7,8 @@
|
|||||||
target_sources(${DUSK_LIBRARY_TARGET_NAME}
|
target_sources(${DUSK_LIBRARY_TARGET_NAME}
|
||||||
PUBLIC
|
PUBLIC
|
||||||
audio.c
|
audio.c
|
||||||
audiostream.c
|
)
|
||||||
audiostreampcm.c
|
|
||||||
audiostreammp3.c
|
# Subdirs
|
||||||
)
|
add_subdirectory(mixer)
|
||||||
|
add_subdirectory(stream)
|
||||||
+12
-2
@@ -6,6 +6,7 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
#include "audio.h"
|
#include "audio.h"
|
||||||
|
#include "audio/mixer/audiomixer.h"
|
||||||
#include "util/memory.h"
|
#include "util/memory.h"
|
||||||
#include "assert/assert.h"
|
#include "assert/assert.h"
|
||||||
|
|
||||||
@@ -15,6 +16,7 @@ errorret_t audioInit() {
|
|||||||
memoryZero(&AUDIO, sizeof(audio_t));
|
memoryZero(&AUDIO, sizeof(audio_t));
|
||||||
|
|
||||||
errorChain(audioPlatformInit());
|
errorChain(audioPlatformInit());
|
||||||
|
errorChain(audioMixerInit());
|
||||||
|
|
||||||
errorOk();
|
errorOk();
|
||||||
}
|
}
|
||||||
@@ -26,7 +28,7 @@ audiostream_t * audioAquireStream(assetentry_t *asset) {
|
|||||||
// too catches the mistake as early as possible, before any stream slot
|
// too catches the mistake as early as possible, before any stream slot
|
||||||
// is handed out for it.
|
// is handed out for it.
|
||||||
assertTrue(
|
assertTrue(
|
||||||
asset->type == ASSET_LOADER_TYPE_WAV,
|
audioStreamTypeForAssetType(asset->type) != AUDIO_STREAM_TYPE_NULL,
|
||||||
"Unsupported asset type for an audio stream."
|
"Unsupported asset type for an audio stream."
|
||||||
);
|
);
|
||||||
|
|
||||||
@@ -40,8 +42,9 @@ audiostream_t * audioAquireStream(assetentry_t *asset) {
|
|||||||
return NULL;
|
return NULL;
|
||||||
}
|
}
|
||||||
|
|
||||||
errorret_t audioUpdate() {
|
errorret_t audioUpdateEarly() {
|
||||||
errorChain(audioPlatformUpdate());
|
errorChain(audioPlatformUpdate());
|
||||||
|
errorChain(audioMixerUpdateEarly());
|
||||||
|
|
||||||
for(uint8_t i = 0; i < AUDIO_STREAMS_MAX; i++) {
|
for(uint8_t i = 0; i < AUDIO_STREAMS_MAX; i++) {
|
||||||
audiostream_t *stream = &AUDIO.streams[i];
|
audiostream_t *stream = &AUDIO.streams[i];
|
||||||
@@ -51,12 +54,19 @@ errorret_t audioUpdate() {
|
|||||||
errorOk();
|
errorOk();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
errorret_t audioUpdateLate() {
|
||||||
|
errorChain(audioMixerUpdateLate());
|
||||||
|
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
errorret_t audioDispose() {
|
errorret_t audioDispose() {
|
||||||
for(uint8_t i = 0; i < AUDIO_STREAMS_MAX; i++) {
|
for(uint8_t i = 0; i < AUDIO_STREAMS_MAX; i++) {
|
||||||
audiostream_t *stream = &AUDIO.streams[i];
|
audiostream_t *stream = &AUDIO.streams[i];
|
||||||
errorChain(audioStreamDispose(stream));
|
errorChain(audioStreamDispose(stream));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
errorChain(audioMixerDispose());
|
||||||
errorChain(audioPlatformDispose());
|
errorChain(audioPlatformDispose());
|
||||||
|
|
||||||
errorOk();
|
errorOk();
|
||||||
|
|||||||
+15
-3
@@ -7,7 +7,7 @@
|
|||||||
|
|
||||||
#pragma once
|
#pragma once
|
||||||
#include "dusk.h"
|
#include "dusk.h"
|
||||||
#include "audio/audiostream.h"
|
#include "audio/stream/audiostream.h"
|
||||||
#include "audio/audioplatform.h"
|
#include "audio/audioplatform.h"
|
||||||
|
|
||||||
#ifndef audioPlatformInit
|
#ifndef audioPlatformInit
|
||||||
@@ -51,11 +51,23 @@ audiostream_t * audioAquireStream(assetentry_t *asset);
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Updates the audio subsystem, updating every active stream. Should be
|
* Updates the audio subsystem, updating every active stream. Should be
|
||||||
* called once per frame.
|
* called once per frame, before rendering - keeps stream buffering/decode
|
||||||
|
* work off the render thread's critical path (see duskmad's MP3 decode
|
||||||
|
* ring for why this matters).
|
||||||
*
|
*
|
||||||
* @return Error indicating success or failure of the operation.
|
* @return Error indicating success or failure of the operation.
|
||||||
*/
|
*/
|
||||||
errorret_t audioUpdate();
|
errorret_t audioUpdateEarly();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Updates the audio subsystem's end-of-frame work - currently just starting
|
||||||
|
* whatever the audio mixer queued this frame (see
|
||||||
|
* audioMixerUpdateLate()'s own comment). Should be called once per frame,
|
||||||
|
* after rendering.
|
||||||
|
*
|
||||||
|
* @return Error indicating success or failure of the operation.
|
||||||
|
*/
|
||||||
|
errorret_t audioUpdateLate();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Disposes the audio subsystem, stopping and disposing every active stream.
|
* Disposes the audio subsystem, stopping and disposing every active stream.
|
||||||
|
|||||||
@@ -1,8 +0,0 @@
|
|||||||
/**
|
|
||||||
* Copyright (c) 2026 Dominic Masters
|
|
||||||
*
|
|
||||||
* This software is released under the MIT License.
|
|
||||||
* https://opensource.org/licenses/MIT
|
|
||||||
*/
|
|
||||||
|
|
||||||
#include "audiostreammp3.h"
|
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
# Copyright (c) 2026 Dominic Masters
|
||||||
|
#
|
||||||
|
# This software is released under the MIT License.
|
||||||
|
# https://opensource.org/licenses/MIT
|
||||||
|
|
||||||
|
# Sources
|
||||||
|
target_sources(${DUSK_LIBRARY_TARGET_NAME}
|
||||||
|
PUBLIC
|
||||||
|
audiomixer.c
|
||||||
|
audiomixerchannel.c
|
||||||
|
)
|
||||||
@@ -0,0 +1,199 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2026 Dominic Masters
|
||||||
|
*
|
||||||
|
* This software is released under the MIT License.
|
||||||
|
* https://opensource.org/licenses/MIT
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include "audiomixer.h"
|
||||||
|
#include "audio/stream/audiostream.h"
|
||||||
|
#include "util/memory.h"
|
||||||
|
#include "util/string.h"
|
||||||
|
#include "assert/assert.h"
|
||||||
|
|
||||||
|
audiomixer_t AUDIO_MIXER;
|
||||||
|
|
||||||
|
errorret_t audioMixerInit() {
|
||||||
|
memoryZero(&AUDIO_MIXER, sizeof(audiomixer_t));
|
||||||
|
|
||||||
|
audiomixerchannel_t channel = 0;
|
||||||
|
while(channel < AUDIO_MIXER_CHANNEL_COUNT) {
|
||||||
|
AUDIO_MIXER.channels[channel].fade = 1.0f;
|
||||||
|
// -1 means "no fade in progress" - see its own comment; zero-init
|
||||||
|
// would otherwise look like an active fade at time 0.
|
||||||
|
AUDIO_MIXER.channels[channel].fadeTime = -1.0f;
|
||||||
|
channel++;
|
||||||
|
}
|
||||||
|
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
|
errorret_t audioMixerUpdateEarly() {
|
||||||
|
audiomixerchannel_t channel = 0;
|
||||||
|
while(channel < AUDIO_MIXER_CHANNEL_COUNT) {
|
||||||
|
// One channel's error (e.g. a failed asset load) must not stop every
|
||||||
|
// other channel from being updated this frame - caught and logged
|
||||||
|
// rather than propagated, same as audioStream*IsFinished()'s own
|
||||||
|
// per-stream error handling.
|
||||||
|
errorret_t ret = audioMixerChannelUpdateEarly(
|
||||||
|
channel, &AUDIO_MIXER.channels[channel]
|
||||||
|
);
|
||||||
|
if(errorIsNotOk(ret)) errorCatch(errorPrint(ret));
|
||||||
|
channel++;
|
||||||
|
}
|
||||||
|
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
|
errorret_t audioMixerUpdateLate() {
|
||||||
|
audiomixerchannel_t channel = 0;
|
||||||
|
while(channel < AUDIO_MIXER_CHANNEL_COUNT) {
|
||||||
|
errorret_t ret =
|
||||||
|
audioMixerChannelUpdateLate(&AUDIO_MIXER.channels[channel]);
|
||||||
|
if(errorIsNotOk(ret)) errorCatch(errorPrint(ret));
|
||||||
|
channel++;
|
||||||
|
}
|
||||||
|
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
|
void audioMixerPlay(
|
||||||
|
const char_t *file,
|
||||||
|
const audiomixerchannel_t channel,
|
||||||
|
const float_t volume,
|
||||||
|
const float_t pan
|
||||||
|
) {
|
||||||
|
audioMixerQueuePlay(file, channel, volume, pan, false, 0, -1.0f, 0.0f);
|
||||||
|
}
|
||||||
|
|
||||||
|
void audioMixerPlayLooped(
|
||||||
|
const char_t *file,
|
||||||
|
const audiomixerchannel_t channel,
|
||||||
|
const float_t volume,
|
||||||
|
const float_t pan,
|
||||||
|
const uint8_t loopCount,
|
||||||
|
const float_t loopStart,
|
||||||
|
const float_t loopTo
|
||||||
|
) {
|
||||||
|
audioMixerQueuePlay(
|
||||||
|
file, channel, volume, pan, true, loopCount, loopStart, loopTo
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
void audioMixerQueuePlay(
|
||||||
|
const char_t *file,
|
||||||
|
const audiomixerchannel_t channel,
|
||||||
|
const float_t volume,
|
||||||
|
const float_t pan,
|
||||||
|
const bool_t looping,
|
||||||
|
const uint8_t loopCount,
|
||||||
|
const float_t loopStart,
|
||||||
|
const float_t loopTo
|
||||||
|
) {
|
||||||
|
assertStrLenMin(file, 1, "File is required, to stop use audioMixerStop");
|
||||||
|
assertTrue(channel < AUDIO_MIXER_CHANNEL_COUNT, "Channel is out of range");
|
||||||
|
assertTrue(volume > 0.0f && volume <= 1.0f, "Volume is out of range");
|
||||||
|
assertTrue(
|
||||||
|
pan >= AUDIO_STREAM_LEFT && pan <= AUDIO_STREAM_RIGHT,
|
||||||
|
"Pan is out of range"
|
||||||
|
);
|
||||||
|
assertTrue(
|
||||||
|
!looping || loopStart < 0.0f || loopTo < loopStart,
|
||||||
|
"Loop points incorrect"
|
||||||
|
);
|
||||||
|
|
||||||
|
audiomixercommand_t *command = &AUDIO_MIXER.channels[channel].pending;
|
||||||
|
|
||||||
|
command->command = AUDIO_MIXER_COMMAND_PLAY;
|
||||||
|
stringCopy(command->file, file, AUDIO_PATH_MAX);
|
||||||
|
command->volume = volume;
|
||||||
|
command->pan = pan;
|
||||||
|
command->looping = looping;
|
||||||
|
command->loopCount = loopCount;
|
||||||
|
command->loopStart = loopStart;
|
||||||
|
command->loopTo = loopTo;
|
||||||
|
}
|
||||||
|
|
||||||
|
void audioMixerStop(const audiomixerchannel_t channel) {
|
||||||
|
assertTrue(channel < AUDIO_MIXER_CHANNEL_COUNT, "Channel is out of range");
|
||||||
|
|
||||||
|
AUDIO_MIXER.channels[channel].pending.command = AUDIO_MIXER_COMMAND_STOP;
|
||||||
|
}
|
||||||
|
|
||||||
|
void audioMixerPause(const audiomixerchannel_t channel) {
|
||||||
|
assertTrue(channel < AUDIO_MIXER_CHANNEL_COUNT, "Channel is out of range");
|
||||||
|
|
||||||
|
audiostream_t *stream = AUDIO_MIXER.channels[channel].stream;
|
||||||
|
if(stream != NULL) audioStreamPause(stream);
|
||||||
|
}
|
||||||
|
|
||||||
|
void audioMixerResume(const audiomixerchannel_t channel) {
|
||||||
|
assertTrue(channel < AUDIO_MIXER_CHANNEL_COUNT, "Channel is out of range");
|
||||||
|
|
||||||
|
audiostream_t *stream = AUDIO_MIXER.channels[channel].stream;
|
||||||
|
if(stream != NULL) audioStreamPlay(stream);
|
||||||
|
}
|
||||||
|
|
||||||
|
void audioMixerSetPan(const audiomixerchannel_t channel, const float_t pan) {
|
||||||
|
assertTrue(channel < AUDIO_MIXER_CHANNEL_COUNT, "Channel is out of range");
|
||||||
|
assertTrue(
|
||||||
|
pan >= AUDIO_STREAM_LEFT && pan <= AUDIO_STREAM_RIGHT,
|
||||||
|
"Pan is out of range"
|
||||||
|
);
|
||||||
|
|
||||||
|
audiostream_t *stream = AUDIO_MIXER.channels[channel].stream;
|
||||||
|
if(stream != NULL) audioStreamSetDirectionality(stream, pan);
|
||||||
|
}
|
||||||
|
|
||||||
|
void audioMixerSetLoop(
|
||||||
|
const audiomixerchannel_t channel,
|
||||||
|
const bool_t looping,
|
||||||
|
const uint8_t loopCount,
|
||||||
|
const float_t loopStart,
|
||||||
|
const float_t loopTo
|
||||||
|
) {
|
||||||
|
assertTrue(channel < AUDIO_MIXER_CHANNEL_COUNT, "Channel is out of range");
|
||||||
|
assertTrue(
|
||||||
|
!looping || loopStart < 0.0f || loopTo < loopStart,
|
||||||
|
"Loop points incorrect"
|
||||||
|
);
|
||||||
|
|
||||||
|
audiostream_t *stream = AUDIO_MIXER.channels[channel].stream;
|
||||||
|
if(stream == NULL) return;
|
||||||
|
|
||||||
|
audioStreamSetLooping(stream, looping);
|
||||||
|
if(looping) {
|
||||||
|
audioStreamSetLoopPoints(stream, loopStart, loopTo);
|
||||||
|
audioStreamSetLoopLimit(stream, loopCount);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void audioMixerFadeTo(
|
||||||
|
const audiomixerchannel_t channel,
|
||||||
|
const float_t from,
|
||||||
|
const float_t to,
|
||||||
|
const float_t duration,
|
||||||
|
const easingtype_t easing
|
||||||
|
) {
|
||||||
|
assertTrue(channel < AUDIO_MIXER_CHANNEL_COUNT, "Channel is out of range");
|
||||||
|
|
||||||
|
audioMixerChannelFadeTo(
|
||||||
|
&AUDIO_MIXER.channels[channel], from, to, duration, easing
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
bool_t audioMixerIsFading(const audiomixerchannel_t channel) {
|
||||||
|
assertTrue(channel < AUDIO_MIXER_CHANNEL_COUNT, "Channel is out of range");
|
||||||
|
|
||||||
|
return audioMixerChannelIsFading(&AUDIO_MIXER.channels[channel]);
|
||||||
|
}
|
||||||
|
|
||||||
|
errorret_t audioMixerDispose() {
|
||||||
|
audiomixerchannel_t channel = 0;
|
||||||
|
while(channel < AUDIO_MIXER_CHANNEL_COUNT) {
|
||||||
|
errorChain(audioMixerChannelStopStream(&AUDIO_MIXER.channels[channel]));
|
||||||
|
channel++;
|
||||||
|
}
|
||||||
|
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
@@ -0,0 +1,204 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2026 Dominic Masters
|
||||||
|
*
|
||||||
|
* This software is released under the MIT License.
|
||||||
|
* https://opensource.org/licenses/MIT
|
||||||
|
*/
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
#include "audio/mixer/audiomixerchannel.h"
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
audiomixerchannelstate_t channels[AUDIO_MIXER_CHANNEL_COUNT];
|
||||||
|
} audiomixer_t;
|
||||||
|
|
||||||
|
extern audiomixer_t AUDIO_MIXER;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Initializes the audio mixer.
|
||||||
|
*/
|
||||||
|
errorret_t audioMixerInit();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Updates the audio mixer, called before rendering (the start of the
|
||||||
|
* frame) - see audioMixerChannelUpdateEarly()'s own comment, run for every
|
||||||
|
* channel.
|
||||||
|
*/
|
||||||
|
errorret_t audioMixerUpdateEarly();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Updates the audio mixer, called at the end of each frame - see
|
||||||
|
* audioMixerChannelUpdateLate()'s own comment, run for every channel.
|
||||||
|
*/
|
||||||
|
errorret_t audioMixerUpdateLate();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Same as audioMixerPlayLooped() but with no looping.
|
||||||
|
*
|
||||||
|
* @param file File to be played.
|
||||||
|
* @param channel Channel you want to play this sound on.
|
||||||
|
* @param volume Volume of the sound, from 0.0 (silent) to 1.0 (loudest).
|
||||||
|
* @param pan Stereo panning of the sound, from AUDIO_STREAM_LEFT to
|
||||||
|
* AUDIO_STREAM_RIGHT.
|
||||||
|
*/
|
||||||
|
void audioMixerPlay(
|
||||||
|
const char_t *file,
|
||||||
|
const audiomixerchannel_t channel,
|
||||||
|
const float_t volume,
|
||||||
|
const float_t pan
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Queues a sound to be played on the next audio mixer update, which occurs at
|
||||||
|
* the end of each frame.
|
||||||
|
*
|
||||||
|
* Mixer channels can only hold one voice (audio stream) at a time. If you try
|
||||||
|
* to queue multiple sounds on the same channel only the last one will be played
|
||||||
|
* and will stop any actively playing on that channel currently.
|
||||||
|
*
|
||||||
|
* Volume is also mixed based on the channel, so supplying volume 1.0 is then
|
||||||
|
* multiplied by the channel's volume, e.g. 0.5*1.0 = 0.5.
|
||||||
|
*
|
||||||
|
* @param file File to be played.
|
||||||
|
* @param channel Channel you want to play this sound on.
|
||||||
|
* @param volume Volume of the sound, from 0.0 (silent) to 1.0 (loudest).
|
||||||
|
* @param pan Stereo panning of the sound, from AUDIO_STREAM_LEFT to
|
||||||
|
* AUDIO_STREAM_RIGHT.
|
||||||
|
* @param loopCount How many times to loop the sound, 0 for infinite looping.
|
||||||
|
* @param loopStart Where the loop segment ends, in seconds, or -1 to loop
|
||||||
|
* the whole stream (the default).
|
||||||
|
* @param loopTo Where the loop segment starts, in seconds.
|
||||||
|
*/
|
||||||
|
void audioMixerPlayLooped(
|
||||||
|
const char_t *file,
|
||||||
|
const audiomixerchannel_t channel,
|
||||||
|
const float_t volume,
|
||||||
|
const float_t pan,
|
||||||
|
const uint8_t loopCount,
|
||||||
|
const float_t loopStart,
|
||||||
|
const float_t loopTo
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Shared implementation behind audioMixerPlay()/audioMixerPlayLooped() -
|
||||||
|
* queues an AUDIO_MIXER_COMMAND_PLAY for the given channel, to be loaded at
|
||||||
|
* the end of this frame and started at the start of the next (see
|
||||||
|
* audioMixerUpdateLate()/audioMixerUpdateEarly()).
|
||||||
|
*
|
||||||
|
* @param file File to be played.
|
||||||
|
* @param channel Channel you want to play this sound on.
|
||||||
|
* @param volume Volume of the sound, from 0.0 (silent) to 1.0 (loudest).
|
||||||
|
* @param pan Stereo panning of the sound, from AUDIO_STREAM_LEFT to
|
||||||
|
* AUDIO_STREAM_RIGHT.
|
||||||
|
* @param looping Whether the stream should loop once it finishes.
|
||||||
|
* @param loopCount How many times to loop the sound, 0 for infinite looping.
|
||||||
|
* Ignored unless looping is true.
|
||||||
|
* @param loopStart Where the loop segment ends, in seconds, or -1 to loop
|
||||||
|
* the whole stream. Ignored unless looping is true.
|
||||||
|
* @param loopTo Where the loop segment starts, in seconds. Ignored unless
|
||||||
|
* looping is true.
|
||||||
|
*/
|
||||||
|
void audioMixerQueuePlay(
|
||||||
|
const char_t *file,
|
||||||
|
const audiomixerchannel_t channel,
|
||||||
|
const float_t volume,
|
||||||
|
const float_t pan,
|
||||||
|
const bool_t looping,
|
||||||
|
const uint8_t loopCount,
|
||||||
|
const float_t loopStart,
|
||||||
|
const float_t loopTo
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stops playing sound on the given channel.
|
||||||
|
*
|
||||||
|
* @param channel Channel to stop.
|
||||||
|
*/
|
||||||
|
void audioMixerStop(const audiomixerchannel_t channel);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Pauses the given channel's currently playing stream, if any - a safe
|
||||||
|
* no-op if the channel isn't playing anything. Playback position is
|
||||||
|
* retained, so audioMixerResume() continues from the same point.
|
||||||
|
*
|
||||||
|
* @param channel Channel to pause.
|
||||||
|
*/
|
||||||
|
void audioMixerPause(const audiomixerchannel_t channel);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resumes the given channel's currently paused stream, if any - a safe
|
||||||
|
* no-op if the channel isn't playing anything.
|
||||||
|
*
|
||||||
|
* @param channel Channel to resume.
|
||||||
|
*/
|
||||||
|
void audioMixerResume(const audiomixerchannel_t channel);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the stereo panning of the given channel's currently playing stream,
|
||||||
|
* if any - a safe no-op if the channel isn't playing anything. Only
|
||||||
|
* affects what's playing right now; a later audioMixerPlay()/
|
||||||
|
* audioMixerPlayLooped() call on this channel uses its own `pan` argument
|
||||||
|
* instead.
|
||||||
|
*
|
||||||
|
* @param channel Channel to update.
|
||||||
|
* @param pan Stereo panning, from AUDIO_STREAM_LEFT to AUDIO_STREAM_RIGHT.
|
||||||
|
*/
|
||||||
|
void audioMixerSetPan(const audiomixerchannel_t channel, const float_t pan);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the looping behaviour of the given channel's currently playing
|
||||||
|
* stream, if any - a safe no-op if the channel isn't playing anything.
|
||||||
|
* Only affects what's playing right now; a later audioMixerPlay()/
|
||||||
|
* audioMixerPlayLooped() call on this channel uses its own loop arguments
|
||||||
|
* instead.
|
||||||
|
*
|
||||||
|
* @param channel Channel to update.
|
||||||
|
* @param looping Whether the stream should loop.
|
||||||
|
* @param loopCount How many times to loop, 0 for infinite. Ignored unless
|
||||||
|
* looping is true.
|
||||||
|
* @param loopStart Where the loop segment ends, in seconds, or -1 to loop
|
||||||
|
* the whole stream. Ignored unless looping is true.
|
||||||
|
* @param loopTo Where the loop segment starts, in seconds. Ignored unless
|
||||||
|
* looping is true.
|
||||||
|
*/
|
||||||
|
void audioMixerSetLoop(
|
||||||
|
const audiomixerchannel_t channel,
|
||||||
|
const bool_t looping,
|
||||||
|
const uint8_t loopCount,
|
||||||
|
const float_t loopStart,
|
||||||
|
const float_t loopTo
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Starts fading the given channel from `from` to `to` over `duration`
|
||||||
|
* seconds, eased by `easing` - see audioMixerChannelFadeTo()'s own
|
||||||
|
* comment. Continues running (advanced every audioMixerUpdateEarly()) even
|
||||||
|
* if the channel isn't currently playing anything.
|
||||||
|
*
|
||||||
|
* @param channel Channel to fade.
|
||||||
|
* @param from Starting fade value, from 0.0 (silent) to 1.0 (loudest).
|
||||||
|
* @param to Ending fade value, from 0.0 (silent) to 1.0 (loudest).
|
||||||
|
* @param duration How long the fade takes, in seconds.
|
||||||
|
* @param easing Easing curve to apply to the fade's progress.
|
||||||
|
*/
|
||||||
|
void audioMixerFadeTo(
|
||||||
|
const audiomixerchannel_t channel,
|
||||||
|
const float_t from,
|
||||||
|
const float_t to,
|
||||||
|
const float_t duration,
|
||||||
|
const easingtype_t easing
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the given channel currently has a fade in progress (started via
|
||||||
|
* audioMixerFadeTo() and not yet finished).
|
||||||
|
*
|
||||||
|
* @param channel Channel to check.
|
||||||
|
* @return true if a fade is still in progress.
|
||||||
|
*/
|
||||||
|
bool_t audioMixerIsFading(const audiomixerchannel_t channel);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Disposes the audio mixer.
|
||||||
|
*/
|
||||||
|
errorret_t audioMixerDispose();
|
||||||
@@ -0,0 +1,223 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2026 Dominic Masters
|
||||||
|
*
|
||||||
|
* This software is released under the MIT License.
|
||||||
|
* https://opensource.org/licenses/MIT
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include "audiomixerchannel.h"
|
||||||
|
#include "asset/asset.h"
|
||||||
|
#include "audio/audio.h"
|
||||||
|
#include "audio/stream/audiostream.h"
|
||||||
|
#include "audio/stream/audiostreamtype.h"
|
||||||
|
#include "save/save.h"
|
||||||
|
#include "time/time.h"
|
||||||
|
#include "util/math.h"
|
||||||
|
#include "assert/assert.h"
|
||||||
|
|
||||||
|
errorret_t audioMixerChannelStopStream(audiomixerchannelstate_t *state) {
|
||||||
|
assertNotNull(state, "State cannot be NULL.");
|
||||||
|
|
||||||
|
if(state->stream == NULL) errorOk();
|
||||||
|
|
||||||
|
errorChain(audioStreamDispose(state->stream));
|
||||||
|
state->stream = NULL;
|
||||||
|
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
|
void audioMixerChannelFadeTo(
|
||||||
|
audiomixerchannelstate_t *state,
|
||||||
|
const float_t from,
|
||||||
|
const float_t to,
|
||||||
|
const float_t duration,
|
||||||
|
const easingtype_t easing
|
||||||
|
) {
|
||||||
|
assertNotNull(state, "State cannot be NULL.");
|
||||||
|
|
||||||
|
state->fade = from;
|
||||||
|
state->fadeFrom = from;
|
||||||
|
state->fadeTo = to;
|
||||||
|
state->fadeDuration = duration;
|
||||||
|
state->fadeEasing = easing;
|
||||||
|
// A non-positive duration finishes instantly - marked inactive right
|
||||||
|
// away (fadeTime < 0) rather than left at 0 to progress next frame,
|
||||||
|
// since there's nothing left to progress.
|
||||||
|
if(duration <= 0.0f) {
|
||||||
|
state->fade = to;
|
||||||
|
state->fadeTime = -1.0f;
|
||||||
|
} else {
|
||||||
|
state->fadeTime = 0.0f;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
bool_t audioMixerChannelIsFading(const audiomixerchannelstate_t *state) {
|
||||||
|
assertNotNull(state, "State cannot be NULL.");
|
||||||
|
|
||||||
|
return state->fadeTime >= 0.0f;
|
||||||
|
}
|
||||||
|
|
||||||
|
void audioMixerChannelApplyVolume(
|
||||||
|
const audiomixerchannel_t channel,
|
||||||
|
audiomixerchannelstate_t *state
|
||||||
|
) {
|
||||||
|
assertNotNull(state, "State cannot be NULL.");
|
||||||
|
|
||||||
|
if(state->stream == NULL) return;
|
||||||
|
|
||||||
|
// Advances any in-progress fade before it's read below - see
|
||||||
|
// audioMixerChannelFadeTo()'s own comment on fadeTime's meaning.
|
||||||
|
if(state->fadeTime >= 0.0f) {
|
||||||
|
state->fadeTime += TIME.delta;
|
||||||
|
const float_t t = mathClamp(
|
||||||
|
state->fadeTime / state->fadeDuration, 0.0f, 1.0f
|
||||||
|
);
|
||||||
|
state->fade = state->fadeFrom +
|
||||||
|
(state->fadeTo - state->fadeFrom) * easingApply(state->fadeEasing, t);
|
||||||
|
if(state->fadeTime >= state->fadeDuration) {
|
||||||
|
state->fade = state->fadeTo;
|
||||||
|
state->fadeTime = -1.0f;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// state->fade and both SAVE.settings volumes have no setter - written
|
||||||
|
// directly by callers - so this is the only place any of them ever gets
|
||||||
|
// validated, rather than at the point they're set.
|
||||||
|
assertTrue(
|
||||||
|
state->fade >= 0.0f && state->fade <= 1.0f,
|
||||||
|
"Channel fade is out of range."
|
||||||
|
);
|
||||||
|
assertTrue(
|
||||||
|
SAVE.settings.audioChannelVolume[channel] >= 0.0f &&
|
||||||
|
SAVE.settings.audioChannelVolume[channel] <= 1.0f,
|
||||||
|
"Channel volume is out of range."
|
||||||
|
);
|
||||||
|
assertTrue(
|
||||||
|
SAVE.settings.audioMasterVolume >= 0.0f &&
|
||||||
|
SAVE.settings.audioMasterVolume <= 1.0f,
|
||||||
|
"Master volume is out of range."
|
||||||
|
);
|
||||||
|
|
||||||
|
// Final computed volume.
|
||||||
|
float_t volume = (
|
||||||
|
state->baseVolume *
|
||||||
|
state->fade *
|
||||||
|
SAVE.settings.audioChannelVolume[channel] *
|
||||||
|
SAVE.settings.audioMasterVolume
|
||||||
|
);
|
||||||
|
audioStreamSetVolume(state->stream, volume);
|
||||||
|
}
|
||||||
|
|
||||||
|
errorret_t audioMixerChannelUpdateEarly(
|
||||||
|
const audiomixerchannel_t channel,
|
||||||
|
audiomixerchannelstate_t *state
|
||||||
|
) {
|
||||||
|
assertNotNull(state, "State cannot be NULL.");
|
||||||
|
|
||||||
|
audiomixercommand_t *command = &state->pending;
|
||||||
|
|
||||||
|
if(command->command == AUDIO_MIXER_COMMAND_STOP) {
|
||||||
|
errorChain(audioMixerChannelStopStream(state));
|
||||||
|
command->command = AUDIO_MIXER_COMMAND_NONE;
|
||||||
|
audioMixerChannelApplyVolume(channel, state);
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
|
if(
|
||||||
|
command->command != AUDIO_MIXER_COMMAND_PLAY ||
|
||||||
|
command->loadingAsset == NULL
|
||||||
|
) {
|
||||||
|
// A PLAY command with no loadingAsset yet (command->loadingAsset ==
|
||||||
|
// NULL) was queued too late for the audioMixerChannelUpdateLate() that
|
||||||
|
// just ran immediately before this call to have locked it - the only
|
||||||
|
// way that happens is a command queued outside the normal per-frame
|
||||||
|
// cycle, e.g. during engine startup before any
|
||||||
|
// audioMixerChannelUpdateLate() has run yet. Left alone (still
|
||||||
|
// AUDIO_MIXER_COMMAND_PLAY) rather than treated as an error: the very
|
||||||
|
// next audioMixerChannelUpdateLate() will lock it, and the frame after
|
||||||
|
// that will reach here and apply it normally.
|
||||||
|
audioMixerChannelApplyVolume(channel, state);
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Blocks here if audioMixerChannelUpdateLate()'s load (kicked off at the
|
||||||
|
// end of the previous frame) hasn't finished yet - see this function's
|
||||||
|
// own doc comment on why that's accepted for now.
|
||||||
|
errorret_t loadRet = assetRequireLoaded(command->loadingAsset);
|
||||||
|
if(errorIsNotOk(loadRet)) {
|
||||||
|
assetUnlockEntry(command->loadingAsset);
|
||||||
|
command->loadingAsset = NULL;
|
||||||
|
command->command = AUDIO_MIXER_COMMAND_NONE;
|
||||||
|
errorChain(loadRet);
|
||||||
|
}
|
||||||
|
|
||||||
|
errorChain(audioMixerChannelStopStream(state));
|
||||||
|
|
||||||
|
audiostream_t *stream = audioAquireStream(command->loadingAsset);
|
||||||
|
assertNotNull(stream, "No free audio stream slots available.");
|
||||||
|
|
||||||
|
errorret_t initRet = audioStreamInit(stream, command->loadingAsset);
|
||||||
|
// The stream holds its own lock on the asset once initialized (or, on
|
||||||
|
// failure, audioStreamInit() has already released it itself) - either
|
||||||
|
// way this call's own lock is no longer needed.
|
||||||
|
assetUnlockEntry(command->loadingAsset);
|
||||||
|
command->loadingAsset = NULL;
|
||||||
|
command->command = AUDIO_MIXER_COMMAND_NONE;
|
||||||
|
errorChain(initRet);
|
||||||
|
|
||||||
|
// Forwards to this channel's own onLoop/onEnd (persistent across every
|
||||||
|
// play on this channel) rather than this one stream instance's own -
|
||||||
|
// see audiomixerchannelstate_t.onLoop's own comment.
|
||||||
|
stream->user = state;
|
||||||
|
stream->onLoop = audioMixerChannelOnStreamLoop;
|
||||||
|
stream->onEnd = audioMixerChannelOnStreamEnd;
|
||||||
|
|
||||||
|
audioStreamSetDirectionality(stream, command->pan);
|
||||||
|
if(command->looping) {
|
||||||
|
audioStreamSetLooping(stream, true);
|
||||||
|
audioStreamSetLoopPoints(stream, command->loopStart, command->loopTo);
|
||||||
|
audioStreamSetLoopLimit(stream, command->loopCount);
|
||||||
|
}
|
||||||
|
audioStreamPlay(stream);
|
||||||
|
|
||||||
|
state->stream = stream;
|
||||||
|
state->baseVolume = command->volume;
|
||||||
|
|
||||||
|
audioMixerChannelApplyVolume(channel, state);
|
||||||
|
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
|
errorret_t audioMixerChannelUpdateLate(audiomixerchannelstate_t *state) {
|
||||||
|
assertNotNull(state, "State cannot be NULL.");
|
||||||
|
|
||||||
|
audiomixercommand_t *command = &state->pending;
|
||||||
|
|
||||||
|
if(command->command != AUDIO_MIXER_COMMAND_PLAY) errorOk();
|
||||||
|
|
||||||
|
assetloadertype_t assetType = audioStreamAssetTypeForPath(command->file);
|
||||||
|
assertTrue(
|
||||||
|
assetType != ASSET_LOADER_TYPE_NULL, "Unsupported audio file extension."
|
||||||
|
);
|
||||||
|
|
||||||
|
// Begins loading now - kicked off at the end of this frame so it has
|
||||||
|
// until the start of the next (audioMixerChannelUpdateEarly()) to finish
|
||||||
|
// before that has to block on it.
|
||||||
|
command->loadingAsset = assetLock(command->file, assetType, NULL);
|
||||||
|
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
|
void audioMixerChannelOnStreamLoop(audiostream_t *stream) {
|
||||||
|
assertNotNull(stream, "Stream cannot be NULL.");
|
||||||
|
|
||||||
|
audiomixerchannelstate_t *state = (audiomixerchannelstate_t *) stream->user;
|
||||||
|
if(state->onLoop != NULL) state->onLoop(state);
|
||||||
|
}
|
||||||
|
|
||||||
|
void audioMixerChannelOnStreamEnd(audiostream_t *stream) {
|
||||||
|
assertNotNull(stream, "Stream cannot be NULL.");
|
||||||
|
|
||||||
|
audiomixerchannelstate_t *state = (audiomixerchannelstate_t *) stream->user;
|
||||||
|
if(state->onEnd != NULL) state->onEnd(state);
|
||||||
|
}
|
||||||
@@ -0,0 +1,241 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2026 Dominic Masters
|
||||||
|
*
|
||||||
|
* This software is released under the MIT License.
|
||||||
|
* https://opensource.org/licenses/MIT
|
||||||
|
*/
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
#include "dusk.h"
|
||||||
|
#include "error/error.h"
|
||||||
|
#include "animation/easing.h"
|
||||||
|
|
||||||
|
// Forward-declared rather than including asset/asset.h - this header only
|
||||||
|
// ever needs a pointer to it, and pulling in the full asset module here
|
||||||
|
// risks an include cycle for anything that reaches this header via a
|
||||||
|
// cutscene item (cutscene.h -> cutsceneitem.h -> the audio cutscene items
|
||||||
|
// -> this header -> asset/asset.h, mid-parse). audiomixerchannel.c itself
|
||||||
|
// still includes the full header.
|
||||||
|
typedef struct assetentry_s assetentry_t;
|
||||||
|
|
||||||
|
typedef struct audiostream_s audiostream_t;
|
||||||
|
|
||||||
|
#define AUDIO_PATH_MAX 256
|
||||||
|
|
||||||
|
typedef enum {
|
||||||
|
AUDIO_MIXER_CHANNEL_BGM_0,
|
||||||
|
AUDIO_MIXER_CHANNEL_VOICE_0,
|
||||||
|
AUDIO_MIXER_CHANNEL_VOICE_1,
|
||||||
|
AUDIO_MIXER_CHANNEL_SFX_0,
|
||||||
|
AUDIO_MIXER_CHANNEL_SFX_1,
|
||||||
|
AUDIO_MIXER_CHANNEL_SFX_2,
|
||||||
|
AUDIO_MIXER_CHANNEL_SFX_3,
|
||||||
|
AUDIO_MIXER_CHANNEL_COUNT
|
||||||
|
} audiomixerchannel_t;
|
||||||
|
|
||||||
|
typedef enum {
|
||||||
|
AUDIO_MIXER_COMMAND_NONE,
|
||||||
|
AUDIO_MIXER_COMMAND_PLAY,
|
||||||
|
AUDIO_MIXER_COMMAND_STOP
|
||||||
|
} audiomixercommandtype_t;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
// What audioMixerChannelUpdateEarly() should do to this channel at the
|
||||||
|
// start of the next frame - AUDIO_MIXER_COMMAND_NONE if nothing's
|
||||||
|
// queued. Set by audioMixerPlay()/audioMixerPlayLooped()/
|
||||||
|
// audioMixerStop(); queuing a new command on a channel replaces, rather
|
||||||
|
// than stacks on top of, whatever was already queued for it this frame -
|
||||||
|
// only the most recent survives.
|
||||||
|
audiomixercommandtype_t command;
|
||||||
|
|
||||||
|
// AUDIO_MIXER_COMMAND_PLAY only, below.
|
||||||
|
char_t file[AUDIO_PATH_MAX];
|
||||||
|
float_t volume;
|
||||||
|
float_t pan;
|
||||||
|
bool_t looping;
|
||||||
|
uint8_t loopCount;
|
||||||
|
float_t loopStart;
|
||||||
|
float_t loopTo;
|
||||||
|
|
||||||
|
// Set by audioMixerChannelUpdateLate() (the end of the frame this PLAY
|
||||||
|
// command was queued on), once it locks the requested file and kicks off
|
||||||
|
// its load. audioMixerChannelUpdateEarly() (the start of the next frame)
|
||||||
|
// blocks on this being fully loaded before actually starting playback -
|
||||||
|
// see its own comment. NULL except in that in-between window.
|
||||||
|
assetentry_t *loadingAsset;
|
||||||
|
} audiomixercommand_t;
|
||||||
|
|
||||||
|
typedef struct audiomixerchannelstate_s audiomixerchannelstate_t;
|
||||||
|
|
||||||
|
typedef struct audiomixerchannelstate_s {
|
||||||
|
// Queued action for the next audioMixerChannelUpdateEarly() to apply.
|
||||||
|
audiomixercommand_t pending;
|
||||||
|
|
||||||
|
// This channel's currently playing stream, or NULL if nothing is -
|
||||||
|
// acquired from AUDIO.streams by audioMixerChannelUpdateEarly() when it
|
||||||
|
// applies an AUDIO_MIXER_COMMAND_PLAY, disposed the same way on
|
||||||
|
// AUDIO_MIXER_COMMAND_STOP or before a new AUDIO_MIXER_COMMAND_PLAY
|
||||||
|
// replaces it.
|
||||||
|
audiostream_t *stream;
|
||||||
|
|
||||||
|
// The per-sound volume `stream` was last started with (the `volume`
|
||||||
|
// argument to whichever audioMixerPlay()/audioMixerPlayLooped() call
|
||||||
|
// started it) - combined with this channel's fade, its own volume
|
||||||
|
// (SAVE.settings.audioChannelVolume) and the mixer's master volume
|
||||||
|
// (SAVE.settings.audioMasterVolume), every frame, to get the volume
|
||||||
|
// actually passed to audioStreamSetVolume(). Meaningless while `stream`
|
||||||
|
// is NULL.
|
||||||
|
float_t baseVolume;
|
||||||
|
|
||||||
|
// This channel's own fade multiplier, from 0.0 (fully faded out) to 1.0
|
||||||
|
// (no fade applied, the default) - transient runtime state, unlike the
|
||||||
|
// channel/master volumes below (which are persisted user preferences).
|
||||||
|
// No setter - write it directly; audioMixerChannelApplyVolume() asserts
|
||||||
|
// it's in range the next time it reads it, rather than validating at the
|
||||||
|
// point it's set.
|
||||||
|
float_t fade;
|
||||||
|
|
||||||
|
// Fade transition state, set by audioMixerChannelFadeTo() and advanced
|
||||||
|
// every frame by audioMixerChannelApplyVolume(), before it reads `fade`
|
||||||
|
// to compute the mixed volume. fadeTime < 0 means no fade is in progress
|
||||||
|
// (audioMixerChannelIsFading() is just `fadeTime >= 0`) - audioMixerInit()
|
||||||
|
// explicitly sets this to -1.0f, since zero-initializing it would
|
||||||
|
// otherwise look like an active fade at time 0.
|
||||||
|
float_t fadeFrom;
|
||||||
|
float_t fadeTo;
|
||||||
|
float_t fadeDuration;
|
||||||
|
float_t fadeTime;
|
||||||
|
easingtype_t fadeEasing;
|
||||||
|
|
||||||
|
// Arbitrary caller data, handed back as-is to onLoop/onEnd below - never
|
||||||
|
// read or written by the mixer itself. NULL by default.
|
||||||
|
void *user;
|
||||||
|
|
||||||
|
// Fired (from the main thread - safe to do arbitrary work, same
|
||||||
|
// guarantee as audiostream_t's own onLoop/onEnd) whenever this channel's
|
||||||
|
// currently playing stream loops, or reaches its natural end (including
|
||||||
|
// hitting its loop limit - see audioStreamSetLoopLimit()) and stops.
|
||||||
|
// Wired onto every stream this channel starts via
|
||||||
|
// audioMixerChannelOnStreamLoop()/OnStreamEnd() - not called directly by
|
||||||
|
// anything else. No setter - write these fields directly; NULL (the
|
||||||
|
// default) means not notified. Unlike `stream`/`pending`, these persist
|
||||||
|
// across every play on this channel, not just one.
|
||||||
|
void (*onLoop)(audiomixerchannelstate_t *state);
|
||||||
|
void (*onEnd)(audiomixerchannelstate_t *state);
|
||||||
|
} audiomixerchannelstate_t;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stops and disposes the given channel's currently playing stream, if any -
|
||||||
|
* a safe no-op if the channel is already idle. Shared by
|
||||||
|
* audioMixerChannelUpdateEarly() (AUDIO_MIXER_COMMAND_STOP, and replacing a
|
||||||
|
* channel's stream before a new AUDIO_MIXER_COMMAND_PLAY starts) and
|
||||||
|
* audioMixerDispose().
|
||||||
|
*
|
||||||
|
* @param state The channel state to stop.
|
||||||
|
*/
|
||||||
|
errorret_t audioMixerChannelStopStream(audiomixerchannelstate_t *state);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Computes the given channel's actual playback volume - its currently
|
||||||
|
* playing sound's own volume (baseVolume), this channel's fade, this
|
||||||
|
* channel's own volume (SAVE.settings.audioChannelVolume[channel]) and the
|
||||||
|
* mixer's master volume (SAVE.settings.audioMasterVolume) - and applies it
|
||||||
|
* via audioStreamSetVolume(). Asserts fade and both save-settings volumes
|
||||||
|
* are each within [0.0, 1.0] - the only validation any of them ever gets,
|
||||||
|
* since none of them have a setter. A safe no-op if the channel isn't
|
||||||
|
* playing anything. Called every audioMixerChannelUpdateEarly(), not just
|
||||||
|
* when a PLAY command starts a new stream - see its own comment.
|
||||||
|
*
|
||||||
|
* @param channel Which channel `state` is, to index
|
||||||
|
* SAVE.settings.audioChannelVolume with.
|
||||||
|
* @param state The channel state to update.
|
||||||
|
*/
|
||||||
|
void audioMixerChannelApplyVolume(
|
||||||
|
const audiomixerchannel_t channel,
|
||||||
|
audiomixerchannelstate_t *state
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Starts fading the given channel's `fade` multiplier from `from` to `to`
|
||||||
|
* over `duration` seconds, eased by `easing` - snaps `fade` to `from`
|
||||||
|
* immediately, then audioMixerChannelApplyVolume() advances it every frame
|
||||||
|
* from here on. A `duration` of 0 or less snaps straight to `to` and marks
|
||||||
|
* the fade as already finished (audioMixerChannelIsFading() returns
|
||||||
|
* false on the very next call).
|
||||||
|
*
|
||||||
|
* @param state The channel state to fade.
|
||||||
|
* @param from Starting fade value, from 0.0 (silent) to 1.0 (loudest).
|
||||||
|
* @param to Ending fade value, from 0.0 (silent) to 1.0 (loudest).
|
||||||
|
* @param duration How long the fade takes, in seconds.
|
||||||
|
* @param easing Easing curve to apply to the fade's progress.
|
||||||
|
*/
|
||||||
|
void audioMixerChannelFadeTo(
|
||||||
|
audiomixerchannelstate_t *state,
|
||||||
|
const float_t from,
|
||||||
|
const float_t to,
|
||||||
|
const float_t duration,
|
||||||
|
const easingtype_t easing
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the given channel currently has a fade in progress (started via
|
||||||
|
* audioMixerChannelFadeTo() and not yet finished).
|
||||||
|
*
|
||||||
|
* @param state The channel state to check.
|
||||||
|
* @return true if a fade is still in progress.
|
||||||
|
*/
|
||||||
|
bool_t audioMixerChannelIsFading(const audiomixerchannelstate_t *state);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Updates a single mixer channel, called before rendering (the start of
|
||||||
|
* the frame): applies whatever command (play, stop - including everything
|
||||||
|
* a play carries, pan/looping) audioMixerChannelUpdateLate() queued for
|
||||||
|
* loading at the end of the previous frame. If that load hasn't finished
|
||||||
|
* yet, this blocks (via assetRequireLoaded()) until it has - a deliberate
|
||||||
|
* stall for now rather than skipping a frame, since there's currently no
|
||||||
|
* way to only partially apply a channel's command. Also recomputes and
|
||||||
|
* reapplies this channel's mixed volume (see
|
||||||
|
* audioMixerChannelApplyVolume()) every time, regardless of whether a
|
||||||
|
* command was queued this frame, so a live change to this channel's fade,
|
||||||
|
* its own volume, or the master volume takes effect on whatever's already
|
||||||
|
* playing too.
|
||||||
|
*
|
||||||
|
* @param channel Which channel `state` is - see
|
||||||
|
* audioMixerChannelApplyVolume()'s own comment.
|
||||||
|
* @param state The channel state to update.
|
||||||
|
*/
|
||||||
|
errorret_t audioMixerChannelUpdateEarly(
|
||||||
|
const audiomixerchannel_t channel,
|
||||||
|
audiomixerchannelstate_t *state
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Updates a single mixer channel, called at the end of each frame, once
|
||||||
|
* every other system has had a chance to queue a command via
|
||||||
|
* audioMixerPlay()/audioMixerPlayLooped()/audioMixerStop(). For a queued
|
||||||
|
* AUDIO_MIXER_COMMAND_PLAY, locks its file and begins loading it (see
|
||||||
|
* assetLock()) - giving it from now until the next
|
||||||
|
* audioMixerChannelUpdateEarly() to finish before that has to block on it.
|
||||||
|
* Actually starting/stopping playback happens there, not here.
|
||||||
|
*
|
||||||
|
* @param state The channel state to update.
|
||||||
|
*/
|
||||||
|
errorret_t audioMixerChannelUpdateLate(audiomixerchannelstate_t *state);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Trampoline wired onto every stream a channel starts (as that stream's
|
||||||
|
* onLoop) - forwards to the channel's own onLoop (see
|
||||||
|
* audiomixerchannelstate_t.onLoop's own comment) via stream->user, which
|
||||||
|
* audioMixerChannelUpdateEarly() points at the channel's own state.
|
||||||
|
*
|
||||||
|
* @param stream The stream that looped.
|
||||||
|
*/
|
||||||
|
void audioMixerChannelOnStreamLoop(audiostream_t *stream);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Same as audioMixerChannelOnStreamLoop() but wired onto onEnd, forwarding
|
||||||
|
* to the channel's own onEnd.
|
||||||
|
*
|
||||||
|
* @param stream The stream that ended.
|
||||||
|
*/
|
||||||
|
void audioMixerChannelOnStreamEnd(audiostream_t *stream);
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
# Copyright (c) 2026 Dominic Masters
|
||||||
|
#
|
||||||
|
# This software is released under the MIT License.
|
||||||
|
# https://opensource.org/licenses/MIT
|
||||||
|
|
||||||
|
# Sources
|
||||||
|
target_sources(${DUSK_LIBRARY_TARGET_NAME}
|
||||||
|
PUBLIC
|
||||||
|
audiostream.c
|
||||||
|
audiostreampcm.c
|
||||||
|
audiostreammp3.c
|
||||||
|
audiostreamtype.c
|
||||||
|
)
|
||||||
@@ -7,6 +7,7 @@
|
|||||||
|
|
||||||
#include "audiostream.h"
|
#include "audiostream.h"
|
||||||
#include "assert/assert.h"
|
#include "assert/assert.h"
|
||||||
|
#include "util/math.h"
|
||||||
|
|
||||||
errorret_t audioStreamInit(audiostream_t *stream, assetentry_t *asset) {
|
errorret_t audioStreamInit(audiostream_t *stream, assetentry_t *asset) {
|
||||||
assertNotNull(stream, "Stream cannot be NULL.");
|
assertNotNull(stream, "Stream cannot be NULL.");
|
||||||
@@ -15,17 +16,17 @@ errorret_t audioStreamInit(audiostream_t *stream, assetentry_t *asset) {
|
|||||||
asset->state == ASSET_ENTRY_STATE_LOADED,
|
asset->state == ASSET_ENTRY_STATE_LOADED,
|
||||||
"Asset must be loaded before it can back an audio stream."
|
"Asset must be loaded before it can back an audio stream."
|
||||||
);
|
);
|
||||||
// Only WAV (-> PCM) assets can back an audio stream today - a caller
|
// A caller passing an asset type that can't back an audio stream is a
|
||||||
// passing the wrong kind of asset entry is a programmer error, not
|
// programmer error, not something that can happen from untrusted data, so
|
||||||
// something that can happen from untrusted data, so this is an assert
|
// this is an assert rather than an errorThrow (see
|
||||||
// rather than an errorThrow (see feedback_assert_vs_error convention).
|
// feedback_assert_vs_error convention).
|
||||||
assertTrue(
|
assertTrue(
|
||||||
asset->type == ASSET_LOADER_TYPE_WAV,
|
audioStreamTypeForAssetType(asset->type) != AUDIO_STREAM_TYPE_NULL,
|
||||||
"Unsupported asset type for an audio stream."
|
"Unsupported asset type for an audio stream."
|
||||||
);
|
);
|
||||||
|
|
||||||
stream->state = 0;
|
stream->state = 0;
|
||||||
stream->volume = 0xFF;
|
stream->volume = 1.0f;
|
||||||
stream->directionality = AUDIO_STREAM_CENTER;
|
stream->directionality = AUDIO_STREAM_CENTER;
|
||||||
stream->loopStart = -1;
|
stream->loopStart = -1;
|
||||||
stream->loopTo = 0;
|
stream->loopTo = 0;
|
||||||
@@ -37,16 +38,20 @@ errorret_t audioStreamInit(audiostream_t *stream, assetentry_t *asset) {
|
|||||||
stream->onEnd = NULL;
|
stream->onEnd = NULL;
|
||||||
stream->loopCount = 0;
|
stream->loopCount = 0;
|
||||||
stream->lastLoopCount = 0;
|
stream->lastLoopCount = 0;
|
||||||
|
stream->loopLimit = 0;
|
||||||
|
stream->loopRestartCount = 0;
|
||||||
|
|
||||||
// Locked for as long as the stream is in use (see audiostream_t.asset's
|
// Locked for as long as the stream is in use (see audiostream_t.asset's
|
||||||
// own comment) - released in audioStreamDispose().
|
// own comment) - released in audioStreamDispose().
|
||||||
stream->asset = asset;
|
stream->asset = asset;
|
||||||
assetEntryLock(asset);
|
assetEntryLock(asset);
|
||||||
|
|
||||||
// Type-specific setup (audioStreamPcmInit() / audioStreamMp3Init(), once
|
// Type-specific setup (audioStreamPcmInit() / audioStreamMp3Init())
|
||||||
// MP3 exists) determines stream->type and asks the platform
|
// determines stream->type, sets stream->sampleRate/channels, and asks
|
||||||
// implementation to set up its state.
|
// the platform implementation to set up its state.
|
||||||
errorret_t ret = audioStreamPcmInit(stream);
|
errorret_t ret = asset->type == ASSET_LOADER_TYPE_MP3
|
||||||
|
? audioStreamMp3Init(stream)
|
||||||
|
: audioStreamPcmInit(stream);
|
||||||
if(errorIsNotOk(ret)) {
|
if(errorIsNotOk(ret)) {
|
||||||
assetEntryUnlock(asset);
|
assetEntryUnlock(asset);
|
||||||
stream->asset = NULL;
|
stream->asset = NULL;
|
||||||
@@ -56,6 +61,41 @@ errorret_t audioStreamInit(audiostream_t *stream, assetentry_t *asset) {
|
|||||||
errorOk();
|
errorOk();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
size_t audioStreamGetTotalFrames(const audiostream_t *stream) {
|
||||||
|
assertNotNull(stream, "Stream cannot be NULL.");
|
||||||
|
|
||||||
|
return stream->type == AUDIO_STREAM_TYPE_MP3
|
||||||
|
? audioStreamMp3GetTotalFrames(stream)
|
||||||
|
: audioStreamPcmGetTotalFrames(stream);
|
||||||
|
}
|
||||||
|
|
||||||
|
errorret_t audioStreamSeek(audiostream_t *stream, const size_t frame) {
|
||||||
|
assertNotNull(stream, "Stream cannot be NULL.");
|
||||||
|
|
||||||
|
errorChain(
|
||||||
|
stream->type == AUDIO_STREAM_TYPE_MP3
|
||||||
|
? audioStreamMp3Seek(stream, frame)
|
||||||
|
: audioStreamPcmSeek(stream, frame)
|
||||||
|
);
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
|
errorret_t audioStreamRead(
|
||||||
|
audiostream_t *stream,
|
||||||
|
int16_t *buffer,
|
||||||
|
const size_t frameCount,
|
||||||
|
size_t *outFramesRead
|
||||||
|
) {
|
||||||
|
assertNotNull(stream, "Stream cannot be NULL.");
|
||||||
|
|
||||||
|
errorChain(
|
||||||
|
stream->type == AUDIO_STREAM_TYPE_MP3
|
||||||
|
? audioStreamMp3Read(stream, buffer, frameCount, outFramesRead)
|
||||||
|
: audioStreamPcmRead(stream, buffer, frameCount, outFramesRead)
|
||||||
|
);
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
void audioStreamPlay(audiostream_t *stream) {
|
void audioStreamPlay(audiostream_t *stream) {
|
||||||
assertNotNull(stream, "Stream cannot be NULL.");
|
assertNotNull(stream, "Stream cannot be NULL.");
|
||||||
stream->state |= AUDIO_STREAM_STATE_PLAYING;
|
stream->state |= AUDIO_STREAM_STATE_PLAYING;
|
||||||
@@ -74,7 +114,7 @@ void audioStreamSetPosition(audiostream_t *stream, const float_t position) {
|
|||||||
while(t < 0) t += stream->duration;
|
while(t < 0) t += stream->duration;
|
||||||
while(t >= stream->duration) t -= stream->duration;
|
while(t >= stream->duration) t -= stream->duration;
|
||||||
|
|
||||||
stream->startFrame = (size_t) (t * stream->pcm.sampleRate);
|
stream->startFrame = (size_t) (t * stream->sampleRate);
|
||||||
stream->seeking = true;
|
stream->seeking = true;
|
||||||
|
|
||||||
// Force the next audioStreamUpdate() to re-buffer from startFrame instead
|
// Force the next audioStreamUpdate() to re-buffer from startFrame instead
|
||||||
@@ -108,26 +148,50 @@ void audioStreamGetPanFactors(
|
|||||||
assertNotNull(outLeft, "outLeft cannot be NULL.");
|
assertNotNull(outLeft, "outLeft cannot be NULL.");
|
||||||
assertNotNull(outRight, "outRight cannot be NULL.");
|
assertNotNull(outRight, "outRight cannot be NULL.");
|
||||||
|
|
||||||
// directionality is an int8_t clamped to AUDIO_STREAM_LEFT..RIGHT
|
// directionality is already a pan factor in AUDIO_STREAM_LEFT..RIGHT
|
||||||
// (-128..127) by its own type, so pan is always within [-1.0, 0.992] -
|
// (-1.0..1.0) - assertTrue'd here rather than clamped, since a caller
|
||||||
// no further clamping needed.
|
// passing something outside that range is a programmer error (see
|
||||||
const float_t pan = (float_t) stream->directionality / 128.0f;
|
// audioStreamSetDirectionality()'s own assert).
|
||||||
|
const float_t pan = stream->directionality;
|
||||||
|
|
||||||
*outLeft = pan > 0 ? (1.0f - pan) : 1.0f;
|
*outLeft = pan > 0 ? (1.0f - pan) : 1.0f;
|
||||||
*outRight = pan < 0 ? (1.0f + pan) : 1.0f;
|
*outRight = pan < 0 ? (1.0f + pan) : 1.0f;
|
||||||
}
|
}
|
||||||
|
|
||||||
void audioStreamSetVolume(audiostream_t *stream, const uint8_t volume) {
|
size_t audioStreamComputeEndFrame(
|
||||||
|
const audiostream_t *stream,
|
||||||
|
const size_t startFrame,
|
||||||
|
const size_t totalFrames
|
||||||
|
) {
|
||||||
assertNotNull(stream, "Stream cannot be NULL.");
|
assertNotNull(stream, "Stream cannot be NULL.");
|
||||||
|
|
||||||
|
size_t endFrame = totalFrames;
|
||||||
|
if((stream->state & AUDIO_STREAM_STATE_LOOPING) && stream->loopStart >= 0) {
|
||||||
|
endFrame = mathMin(
|
||||||
|
(size_t) (stream->loopStart * stream->sampleRate), totalFrames
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if(startFrame >= endFrame) endFrame = totalFrames;
|
||||||
|
|
||||||
|
return endFrame;
|
||||||
|
}
|
||||||
|
|
||||||
|
void audioStreamSetVolume(audiostream_t *stream, const float_t volume) {
|
||||||
|
assertNotNull(stream, "Stream cannot be NULL.");
|
||||||
|
assertTrue(volume >= 0.0f && volume <= 1.0f, "Volume is out of range.");
|
||||||
stream->volume = volume;
|
stream->volume = volume;
|
||||||
// TODO: Do I need to update the device output? PSP may require this
|
// TODO: Do I need to update the device output? PSP may require this
|
||||||
}
|
}
|
||||||
|
|
||||||
void audioStreamSetDirectionality(
|
void audioStreamSetDirectionality(
|
||||||
audiostream_t *stream,
|
audiostream_t *stream,
|
||||||
const int8_t directionality
|
const float_t directionality
|
||||||
) {
|
) {
|
||||||
assertNotNull(stream, "Stream cannot be NULL.");
|
assertNotNull(stream, "Stream cannot be NULL.");
|
||||||
|
assertTrue(
|
||||||
|
directionality >= AUDIO_STREAM_LEFT && directionality <= AUDIO_STREAM_RIGHT,
|
||||||
|
"Directionality is out of range."
|
||||||
|
);
|
||||||
stream->directionality = directionality;
|
stream->directionality = directionality;
|
||||||
// TODO: Need to update internal decoder?
|
// TODO: Need to update internal decoder?
|
||||||
}
|
}
|
||||||
@@ -142,6 +206,12 @@ void audioStreamSetLooping(audiostream_t *stream, const bool_t looping) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
void audioStreamSetLoopLimit(audiostream_t *stream, const uint32_t loopLimit) {
|
||||||
|
assertNotNull(stream, "Stream cannot be NULL.");
|
||||||
|
stream->loopLimit = loopLimit;
|
||||||
|
stream->loopRestartCount = 0;
|
||||||
|
}
|
||||||
|
|
||||||
errorret_t audioStreamUpdate(audiostream_t *stream) {
|
errorret_t audioStreamUpdate(audiostream_t *stream) {
|
||||||
assertNotNull(stream, "Stream cannot be NULL.");
|
assertNotNull(stream, "Stream cannot be NULL.");
|
||||||
|
|
||||||
@@ -176,20 +246,30 @@ errorret_t audioStreamUpdate(audiostream_t *stream) {
|
|||||||
(stream->state & AUDIO_STREAM_STATE_BUFFERED) &&
|
(stream->state & AUDIO_STREAM_STATE_BUFFERED) &&
|
||||||
audioStreamPlatformIsFinished(stream)
|
audioStreamPlatformIsFinished(stream)
|
||||||
) {
|
) {
|
||||||
if(stream->state & AUDIO_STREAM_STATE_LOOPING) {
|
// A limit of 0 means unlimited; otherwise this pass's restart only goes
|
||||||
|
// ahead while fewer than loopLimit restarts have already happened -
|
||||||
|
// once it's reached, fall through to the same stop/onEnd path as a
|
||||||
|
// non-looping stream instead of restarting again.
|
||||||
|
const bool_t loopLimitReached = stream->loopLimit > 0 &&
|
||||||
|
stream->loopRestartCount >= stream->loopLimit;
|
||||||
|
|
||||||
|
if((stream->state & AUDIO_STREAM_STATE_LOOPING) && !loopLimitReached) {
|
||||||
stream->state &= ~AUDIO_STREAM_STATE_BUFFERED;
|
stream->state &= ~AUDIO_STREAM_STATE_BUFFERED;
|
||||||
|
stream->loopRestartCount++;
|
||||||
|
|
||||||
// Resume from loopTo rather than the very start of the buffer - only
|
// Resume from loopTo rather than the very start of the buffer - only
|
||||||
// matters for platforms that reach this generic restart path at all;
|
// matters for platforms that reach this generic restart path at all
|
||||||
// PSP/Dolphin loop entirely on their own (thread/hardware) and never
|
// (Linux and Dolphin, both of which re-buffer per pass and report
|
||||||
// report "finished" while looping, so in practice this is Linux-only.
|
// "finished" at every loop boundary); PSP loops entirely on its own
|
||||||
stream->startFrame = (size_t) (stream->loopTo * stream->pcm.sampleRate);
|
// read-ahead ring instead (see loopRestartCount's own comment).
|
||||||
|
stream->startFrame = (size_t) (stream->loopTo * stream->sampleRate);
|
||||||
|
|
||||||
if(stream->onLoop != NULL) {
|
if(stream->onLoop != NULL) {
|
||||||
stream->onLoop(stream);
|
stream->onLoop(stream);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
stream->state &= ~(AUDIO_STREAM_STATE_PLAYING | AUDIO_STREAM_STATE_BUFFERED);
|
stream->state &=
|
||||||
|
~(AUDIO_STREAM_STATE_PLAYING | AUDIO_STREAM_STATE_BUFFERED);
|
||||||
|
|
||||||
if(stream->onEnd != NULL) {
|
if(stream->onEnd != NULL) {
|
||||||
stream->onEnd(stream);
|
stream->onEnd(stream);
|
||||||
@@ -217,6 +297,8 @@ errorret_t audioStreamDispose(audiostream_t *stream) {
|
|||||||
|
|
||||||
if(stream->type == AUDIO_STREAM_TYPE_PCM) {
|
if(stream->type == AUDIO_STREAM_TYPE_PCM) {
|
||||||
errorChain(audioStreamPcmDispose(stream));
|
errorChain(audioStreamPcmDispose(stream));
|
||||||
|
} else if(stream->type == AUDIO_STREAM_TYPE_MP3) {
|
||||||
|
errorChain(audioStreamMp3Dispose(stream));
|
||||||
}
|
}
|
||||||
|
|
||||||
if(stream->asset != NULL) {
|
if(stream->asset != NULL) {
|
||||||
@@ -6,8 +6,9 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
#pragma once
|
#pragma once
|
||||||
#include "audio/audiostreampcm.h"
|
#include "audio/stream/audiostreamtype.h"
|
||||||
#include "audio/audiostreammp3.h"
|
#include "audio/stream/audiostreampcm.h"
|
||||||
|
#include "audio/stream/audiostreammp3.h"
|
||||||
#include "audio/audiostreamplatform.h"
|
#include "audio/audiostreamplatform.h"
|
||||||
#include "asset/loader/assetentry.h"
|
#include "asset/loader/assetentry.h"
|
||||||
|
|
||||||
@@ -31,16 +32,9 @@
|
|||||||
#define AUDIO_STREAM_STATE_PLAYING (1 << 0)
|
#define AUDIO_STREAM_STATE_PLAYING (1 << 0)
|
||||||
#define AUDIO_STREAM_STATE_LOOPING (1 << 1)
|
#define AUDIO_STREAM_STATE_LOOPING (1 << 1)
|
||||||
#define AUDIO_STREAM_STATE_BUFFERED (1 << 2)
|
#define AUDIO_STREAM_STATE_BUFFERED (1 << 2)
|
||||||
#define AUDIO_STREAM_CENTER 0
|
#define AUDIO_STREAM_CENTER 0.0f
|
||||||
#define AUDIO_STREAM_LEFT -128
|
#define AUDIO_STREAM_LEFT -1.0f
|
||||||
#define AUDIO_STREAM_RIGHT 127
|
#define AUDIO_STREAM_RIGHT 1.0f
|
||||||
|
|
||||||
typedef enum {
|
|
||||||
AUDIO_STREAM_TYPE_NULL,
|
|
||||||
AUDIO_STREAM_TYPE_PCM,
|
|
||||||
AUDIO_STREAM_TYPE_MP3,
|
|
||||||
AUDIO_STREAM_TYPE_COUNT
|
|
||||||
} audistreamtype_t;
|
|
||||||
|
|
||||||
typedef struct audiostream_s audiostream_t;
|
typedef struct audiostream_s audiostream_t;
|
||||||
|
|
||||||
@@ -48,8 +42,11 @@ typedef struct audiostream_s {
|
|||||||
// Used for aquiring new data.
|
// Used for aquiring new data.
|
||||||
audistreamtype_t type;
|
audistreamtype_t type;
|
||||||
|
|
||||||
// What state the stream is in.
|
// What state the stream is in. volatile: PSP's output thread reads
|
||||||
uint8_t state;
|
// AUDIO_STREAM_STATE_PLAYING directly to honor a pause promptly instead
|
||||||
|
// of only reacting once the main thread's own per-frame gate notices -
|
||||||
|
// see audioStreamPSPThreadFeed()'s own comment.
|
||||||
|
volatile uint8_t state;
|
||||||
|
|
||||||
// The asset backing this stream's data (e.g. a WAV file) - determines
|
// The asset backing this stream's data (e.g. a WAV file) - determines
|
||||||
// `type` (see audioStreamInit()) and is read from on demand by the
|
// `type` (see audioStreamInit()) and is read from on demand by the
|
||||||
@@ -60,12 +57,14 @@ typedef struct audiostream_s {
|
|||||||
// playback may also be holding.
|
// playback may also be holding.
|
||||||
assetentry_t *asset;
|
assetentry_t *asset;
|
||||||
|
|
||||||
// Loudness. Can only be 0 to 0xFF
|
// Loudness, from 0.0 (silent) to 1.0 (loudest).
|
||||||
uint8_t volume;
|
float_t volume;
|
||||||
|
|
||||||
// In stereo space, where do we send the audio.
|
// In stereo space, where do we send the audio - from AUDIO_STREAM_LEFT
|
||||||
|
// (-1.0) to AUDIO_STREAM_RIGHT (1.0), AUDIO_STREAM_CENTER (0.0) by
|
||||||
|
// default.
|
||||||
// TODO: Can we use a 3D vector + Pro Logic II?
|
// TODO: Can we use a 3D vector + Pro Logic II?
|
||||||
int8_t directionality;
|
float_t directionality;
|
||||||
|
|
||||||
// In seconds, where the loop segment ends and playback jumps back to
|
// In seconds, where the loop segment ends and playback jumps back to
|
||||||
// loopTo - -1 (the default) means "at the end of the stream", i.e. loop
|
// loopTo - -1 (the default) means "at the end of the stream", i.e. loop
|
||||||
@@ -119,13 +118,38 @@ typedef struct audiostream_s {
|
|||||||
// onLoop for - only ever touched from the main thread.
|
// onLoop for - only ever touched from the main thread.
|
||||||
uint32_t lastLoopCount;
|
uint32_t lastLoopCount;
|
||||||
|
|
||||||
|
// Maximum number of times this stream is allowed to loop before stopping
|
||||||
|
// (firing onEnd) instead of restarting again - 0 (the default) means loop
|
||||||
|
// forever. Has no effect unless looping is also enabled via
|
||||||
|
// audioStreamSetLooping(). Set via audioStreamSetLoopLimit().
|
||||||
|
uint32_t loopLimit;
|
||||||
|
|
||||||
|
// How many loop restarts this stream has already committed to - compared
|
||||||
|
// against loopLimit each time a restart is considered, then incremented
|
||||||
|
// if it goes ahead; reset to 0 by audioStreamSetLoopLimit(). Distinct
|
||||||
|
// from loopCount (which tracks when a loop becomes audible, purely for
|
||||||
|
// onLoop notification, and is PSP-only) - this counts decided restarts,
|
||||||
|
// main-thread-only on every platform (PSP decides whether to loop from
|
||||||
|
// its own read-ahead ring, itself driven from the main thread via
|
||||||
|
// audioStreamPSPIsFinished() - see its own comment).
|
||||||
|
uint32_t loopRestartCount;
|
||||||
|
|
||||||
|
// PCM format of the stream's decoded output - read identically by every
|
||||||
|
// platform backend regardless of stream type (PCM decodes straight
|
||||||
|
// through; MP3 decodes to this same format), so it lives here rather
|
||||||
|
// than duplicated in both audiostreampcm_t and audiostreammp3_t. Set by
|
||||||
|
// whichever type-specific Init function runs (audioStreamPcmInit() /
|
||||||
|
// audioStreamMp3Init()).
|
||||||
|
uint32_t sampleRate;
|
||||||
|
uint8_t channels;
|
||||||
|
|
||||||
// Stream type specific data.
|
// Stream type specific data.
|
||||||
union {
|
union {
|
||||||
audiostreampcm_t pcm;
|
audiostreampcm_t pcm;
|
||||||
audiostreammp3_t mp3;
|
audiostreammp3_t mp3;
|
||||||
};
|
};
|
||||||
|
|
||||||
// Platform-specific playback state (e.g. SDL2 device, PSP channel, ansnd
|
// Platform-specific playback state (e.g. SDL2 device, PSP channel, ASND
|
||||||
// voice). Defined by each platform's audiostreamplatform.h.
|
// voice). Defined by each platform's audiostreamplatform.h.
|
||||||
audiostreamplatform_t platform;
|
audiostreamplatform_t platform;
|
||||||
} audiostream_t;
|
} audiostream_t;
|
||||||
@@ -143,11 +167,55 @@ typedef struct audiostream_s {
|
|||||||
*
|
*
|
||||||
* @param stream The audio stream to initialize.
|
* @param stream The audio stream to initialize.
|
||||||
* @param asset The loaded asset to play - its type must be one this
|
* @param asset The loaded asset to play - its type must be one this
|
||||||
* function supports (currently only ASSET_LOADER_TYPE_WAV).
|
* function supports (ASSET_LOADER_TYPE_WAV or
|
||||||
|
* ASSET_LOADER_TYPE_MP3).
|
||||||
* @return Error indicating success or failure.
|
* @return Error indicating success or failure.
|
||||||
*/
|
*/
|
||||||
errorret_t audioStreamInit(audiostream_t *stream, assetentry_t *asset);
|
errorret_t audioStreamInit(audiostream_t *stream, assetentry_t *asset);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the total number of decoded PCM frames (one sample per channel)
|
||||||
|
* available in the stream's underlying data, regardless of its type -
|
||||||
|
* dispatches to audioStreamPcmGetTotalFrames() or
|
||||||
|
* audioStreamMp3GetTotalFrames(). Platform backends should use this rather
|
||||||
|
* than a type-specific function directly, so they don't need to know or
|
||||||
|
* care which type they're driving.
|
||||||
|
*
|
||||||
|
* @param stream The audio stream to query.
|
||||||
|
* @return The total number of frames available.
|
||||||
|
*/
|
||||||
|
size_t audioStreamGetTotalFrames(const audiostream_t *stream);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Seeks the stream's decode position to the given frame offset, regardless
|
||||||
|
* of its type - dispatches to audioStreamPcmSeek() or audioStreamMp3Seek().
|
||||||
|
*
|
||||||
|
* @param stream The audio stream to seek.
|
||||||
|
* @param frame Frame offset to seek to, relative to the start of the
|
||||||
|
* stream's decoded data.
|
||||||
|
* @return Error indicating success or failure.
|
||||||
|
*/
|
||||||
|
errorret_t audioStreamSeek(audiostream_t *stream, const size_t frame);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reads up to frameCount frames of decoded PCM sample data from the
|
||||||
|
* stream's current position, regardless of its type - dispatches to
|
||||||
|
* audioStreamPcmRead() or audioStreamMp3Read(). See either for the exact
|
||||||
|
* short-read-at-end-of-stream contract, which is identical for both.
|
||||||
|
*
|
||||||
|
* @param stream The audio stream to read from.
|
||||||
|
* @param buffer Destination buffer, sized for at least frameCount frames.
|
||||||
|
* @param frameCount Maximum number of frames to read.
|
||||||
|
* @param outFramesRead Set to the number of frames actually read.
|
||||||
|
* @return Error indicating success or failure.
|
||||||
|
*/
|
||||||
|
errorret_t audioStreamRead(
|
||||||
|
audiostream_t *stream,
|
||||||
|
int16_t *buffer,
|
||||||
|
const size_t frameCount,
|
||||||
|
size_t *outFramesRead
|
||||||
|
);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Begins or resumes playback of the given audio stream.
|
* Begins or resumes playback of the given audio stream.
|
||||||
*
|
*
|
||||||
@@ -208,13 +276,34 @@ void audioStreamGetPanFactors(
|
|||||||
float_t *outRight
|
float_t *outRight
|
||||||
);
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Computes the stop frame for a playback pass starting at startFrame: the
|
||||||
|
* current loop segment's end (stream->loopStart, converted to frames and
|
||||||
|
* clamped to totalFrames) if looping is enabled and a loop start is set,
|
||||||
|
* or totalFrames itself otherwise - including when startFrame has already
|
||||||
|
* reached or passed the computed loop end (e.g. a seek landing in an
|
||||||
|
* outro past the loop point), in which case this pass plays out to the
|
||||||
|
* true end of the stream once instead of only the loop segment.
|
||||||
|
*
|
||||||
|
* @param stream The audio stream to compute this for.
|
||||||
|
* @param startFrame This pass's starting frame offset.
|
||||||
|
* @param totalFrames The stream's total decoded frame count
|
||||||
|
* (audioStreamGetTotalFrames()).
|
||||||
|
* @return This pass's stop frame offset.
|
||||||
|
*/
|
||||||
|
size_t audioStreamComputeEndFrame(
|
||||||
|
const audiostream_t *stream,
|
||||||
|
const size_t startFrame,
|
||||||
|
const size_t totalFrames
|
||||||
|
);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets the playback volume of the given audio stream.
|
* Sets the playback volume of the given audio stream.
|
||||||
*
|
*
|
||||||
* @param stream The audio stream to update.
|
* @param stream The audio stream to update.
|
||||||
* @param volume The new volume, from 0 (silent) to 0xFF (loudest).
|
* @param volume The new volume, from 0.0 (silent) to 1.0 (loudest).
|
||||||
*/
|
*/
|
||||||
void audioStreamSetVolume(audiostream_t *stream, const uint8_t volume);
|
void audioStreamSetVolume(audiostream_t *stream, const float_t volume);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets the stereo directionality (panning) of the given audio stream.
|
* Sets the stereo directionality (panning) of the given audio stream.
|
||||||
@@ -225,7 +314,7 @@ void audioStreamSetVolume(audiostream_t *stream, const uint8_t volume);
|
|||||||
*/
|
*/
|
||||||
void audioStreamSetDirectionality(
|
void audioStreamSetDirectionality(
|
||||||
audiostream_t *stream,
|
audiostream_t *stream,
|
||||||
const int8_t directionality
|
const float_t directionality
|
||||||
);
|
);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -239,6 +328,19 @@ void audioStreamSetDirectionality(
|
|||||||
*/
|
*/
|
||||||
void audioStreamSetLooping(audiostream_t *stream, const bool_t looping);
|
void audioStreamSetLooping(audiostream_t *stream, const bool_t looping);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the maximum number of times the given audio stream is allowed to
|
||||||
|
* loop before stopping (firing onEnd) instead of restarting again. Has no
|
||||||
|
* effect unless looping is also enabled via audioStreamSetLooping(). Resets
|
||||||
|
* the stream's current loop-restart progress back to 0, so the stream gets
|
||||||
|
* the full count from this call onward.
|
||||||
|
*
|
||||||
|
* @param stream The audio stream to update.
|
||||||
|
* @param loopLimit Maximum number of loop restarts, or 0 (the default) to
|
||||||
|
* loop forever.
|
||||||
|
*/
|
||||||
|
void audioStreamSetLoopLimit(audiostream_t *stream, const uint32_t loopLimit);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Updates the given audio stream, decoding new data and advancing playback
|
* Updates the given audio stream, decoding new data and advancing playback
|
||||||
* as needed. Should be called every frame for every active stream.
|
* as needed. Should be called every frame for every active stream.
|
||||||
@@ -0,0 +1,167 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2026 Dominic Masters
|
||||||
|
*
|
||||||
|
* This software is released under the MIT License.
|
||||||
|
* https://opensource.org/licenses/MIT
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include "audiostreammp3.h"
|
||||||
|
#include "audiostream.h"
|
||||||
|
#include "assert/assert.h"
|
||||||
|
#include "util/math.h"
|
||||||
|
#include "util/memory.h"
|
||||||
|
|
||||||
|
errorret_t audioStreamMp3Init(audiostream_t *stream) {
|
||||||
|
assertNotNull(stream, "Stream cannot be NULL.");
|
||||||
|
assertNotNull(stream->asset, "Stream must have an asset assigned.");
|
||||||
|
assertTrue(
|
||||||
|
stream->asset->type == ASSET_LOADER_TYPE_MP3,
|
||||||
|
"Asset is not an MP3 file."
|
||||||
|
);
|
||||||
|
|
||||||
|
const assetmp3file_t *mp3 = &stream->asset->data.mp3;
|
||||||
|
|
||||||
|
stream->type = AUDIO_STREAM_TYPE_MP3;
|
||||||
|
stream->sampleRate = mp3->sampleRate;
|
||||||
|
stream->channels = mp3->channels;
|
||||||
|
stream->duration = (float_t) mp3->totalFrames / (float_t) mp3->sampleRate;
|
||||||
|
|
||||||
|
stream->mp3.pendingFrames = 0;
|
||||||
|
stream->mp3.pendingPosition = 0;
|
||||||
|
stream->mp3.position = 0;
|
||||||
|
stream->mp3.totalFrames = mp3->totalFrames;
|
||||||
|
|
||||||
|
// Each stream opens its own independent handle to the same underlying
|
||||||
|
// asset file - see audiostreampcm.c's audioStreamPcmInit() for why.
|
||||||
|
errorChain(assetFileInit(
|
||||||
|
&stream->mp3.file, stream->asset->name, NULL, NULL
|
||||||
|
));
|
||||||
|
errorChain(assetFileOpen(&stream->mp3.file));
|
||||||
|
errorChain(assetFileRead(&stream->mp3.file, NULL, mp3->dataOffset));
|
||||||
|
|
||||||
|
errorChain(audioStreamMp3DecoderInit(stream));
|
||||||
|
|
||||||
|
errorChain(audioStreamPlatformInit(stream));
|
||||||
|
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
|
errorret_t audioStreamMp3Dispose(audiostream_t *stream) {
|
||||||
|
assertNotNull(stream, "Stream cannot be NULL.");
|
||||||
|
assertTrue(stream->type == AUDIO_STREAM_TYPE_MP3, "Stream is not MP3.");
|
||||||
|
|
||||||
|
errorChain(audioStreamMp3DecoderDispose(stream));
|
||||||
|
errorChain(assetFileClose(&stream->mp3.file));
|
||||||
|
errorChain(assetFileDispose(&stream->mp3.file));
|
||||||
|
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t audioStreamMp3GetTotalFrames(const audiostream_t *stream) {
|
||||||
|
assertNotNull(stream, "Stream cannot be NULL.");
|
||||||
|
assertTrue(stream->type == AUDIO_STREAM_TYPE_MP3, "Stream is not MP3.");
|
||||||
|
|
||||||
|
return stream->mp3.totalFrames;
|
||||||
|
}
|
||||||
|
|
||||||
|
errorret_t audioStreamMp3Seek(audiostream_t *stream, const size_t frame) {
|
||||||
|
assertNotNull(stream, "Stream cannot be NULL.");
|
||||||
|
assertTrue(stream->type == AUDIO_STREAM_TYPE_MP3, "Stream is not MP3.");
|
||||||
|
|
||||||
|
if(frame == stream->mp3.position) {
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Every seek - forward or backward - restarts decoding from the very
|
||||||
|
// start of the compressed stream and discards frames until reaching the
|
||||||
|
// target; see this file's own header comment for why MP3 has no cheaper
|
||||||
|
// option, unlike audioStreamPcmSeek()'s direct byte-offset seek.
|
||||||
|
errorChain(audioStreamMp3DecoderRewind(stream));
|
||||||
|
stream->mp3.position = 0;
|
||||||
|
stream->mp3.pendingFrames = 0;
|
||||||
|
stream->mp3.pendingPosition = 0;
|
||||||
|
|
||||||
|
const size_t channels = stream->channels;
|
||||||
|
int16_t discard[AUDIO_MP3_MAX_SAMPLES_PER_FRAME];
|
||||||
|
|
||||||
|
while(stream->mp3.position < frame) {
|
||||||
|
size_t decodedFrames = 0;
|
||||||
|
errorChain(
|
||||||
|
audioStreamMp3DecoderDecodeFrame(stream, discard, &decodedFrames)
|
||||||
|
);
|
||||||
|
if(decodedFrames == 0) {
|
||||||
|
// Ran out of stream before reaching the target - clamp rather than
|
||||||
|
// erroring, same tolerance audioStreamPcmRead() has for a
|
||||||
|
// shorter-than-declared asset.
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
const size_t framesNeeded = frame - stream->mp3.position;
|
||||||
|
if(decodedFrames <= framesNeeded) {
|
||||||
|
stream->mp3.position += decodedFrames;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
// This frame overshoots the target - keep the excess as pending so
|
||||||
|
// the next Read() starts exactly at `frame` instead of skipping past
|
||||||
|
// it.
|
||||||
|
const size_t keepFrames = decodedFrames - framesNeeded;
|
||||||
|
memoryMove(
|
||||||
|
discard, discard + (framesNeeded * channels),
|
||||||
|
keepFrames * channels * sizeof(int16_t)
|
||||||
|
);
|
||||||
|
memoryCopy(
|
||||||
|
stream->mp3.pending, discard, keepFrames * channels * sizeof(int16_t)
|
||||||
|
);
|
||||||
|
stream->mp3.pendingFrames = keepFrames;
|
||||||
|
stream->mp3.pendingPosition = 0;
|
||||||
|
stream->mp3.position = frame;
|
||||||
|
}
|
||||||
|
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
|
|
||||||
|
errorret_t audioStreamMp3Read(
|
||||||
|
audiostream_t *stream,
|
||||||
|
int16_t *buffer,
|
||||||
|
const size_t frameCount,
|
||||||
|
size_t *outFramesRead
|
||||||
|
) {
|
||||||
|
assertNotNull(stream, "Stream cannot be NULL.");
|
||||||
|
assertNotNull(buffer, "Buffer cannot be NULL.");
|
||||||
|
assertNotNull(outFramesRead, "outFramesRead cannot be NULL.");
|
||||||
|
assertTrue(stream->type == AUDIO_STREAM_TYPE_MP3, "Stream is not MP3.");
|
||||||
|
|
||||||
|
const size_t channels = stream->channels;
|
||||||
|
size_t framesWritten = 0;
|
||||||
|
|
||||||
|
while(framesWritten < frameCount) {
|
||||||
|
if(stream->mp3.pendingPosition >= stream->mp3.pendingFrames) {
|
||||||
|
size_t decodedFrames = 0;
|
||||||
|
errorChain(audioStreamMp3DecoderDecodeFrame(
|
||||||
|
stream, stream->mp3.pending, &decodedFrames
|
||||||
|
));
|
||||||
|
stream->mp3.pendingFrames = decodedFrames;
|
||||||
|
stream->mp3.pendingPosition = 0;
|
||||||
|
if(decodedFrames == 0) break; // Genuine end of stream.
|
||||||
|
}
|
||||||
|
|
||||||
|
const size_t framesAvailable =
|
||||||
|
stream->mp3.pendingFrames - stream->mp3.pendingPosition;
|
||||||
|
const size_t framesToCopy =
|
||||||
|
mathMin(frameCount - framesWritten, framesAvailable);
|
||||||
|
|
||||||
|
memoryCopy(
|
||||||
|
buffer + (framesWritten * channels),
|
||||||
|
stream->mp3.pending + (stream->mp3.pendingPosition * channels),
|
||||||
|
framesToCopy * channels * sizeof(int16_t)
|
||||||
|
);
|
||||||
|
|
||||||
|
stream->mp3.pendingPosition += framesToCopy;
|
||||||
|
framesWritten += framesToCopy;
|
||||||
|
}
|
||||||
|
|
||||||
|
stream->mp3.position += framesWritten;
|
||||||
|
*outFramesRead = framesWritten;
|
||||||
|
errorOk();
|
||||||
|
}
|
||||||
@@ -0,0 +1,140 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2026 Dominic Masters
|
||||||
|
*
|
||||||
|
* This software is released under the MIT License.
|
||||||
|
* https://opensource.org/licenses/MIT
|
||||||
|
*/
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
#include "error/error.h"
|
||||||
|
#include "asset/assetfile.h"
|
||||||
|
#include "audio/audiostreammp3decoder.h"
|
||||||
|
|
||||||
|
typedef struct audiostream_s audiostream_t;
|
||||||
|
|
||||||
|
// How many interleaved PCM samples (not frames - samples, i.e. frames *
|
||||||
|
// channels) a single audioStreamMp3DecoderDecodeFrame() call is ever
|
||||||
|
// allowed to produce. Sizes the pending-sample buffer below, which every
|
||||||
|
// decoder backend writes directly into - this must be sized to the
|
||||||
|
// largest of them, not just "one MPEG frame":
|
||||||
|
// - libmad (software, Linux/Dolphin): always exactly one frame, 1152
|
||||||
|
// samples/channel for MPEG-1 Layer III, doubled here for stereo.
|
||||||
|
// - sceMp3 (hardware, PSP): its own pcmBuf is provisioned at double that
|
||||||
|
// (see AUDIO_MP3_PSP_PCM_BUF_SIZE) - i.e. sceMp3Decode() can
|
||||||
|
// legitimately hand back more than one frame's worth in a single call.
|
||||||
|
// Sizing this for only one frame silently overflowed stream->mp3.pending
|
||||||
|
// on real hardware whenever that happened - confirmed as the cause of
|
||||||
|
// very intermittent audio corruption/clicking, since it only bit when
|
||||||
|
// sceMp3 actually returned the larger amount.
|
||||||
|
// So this covers the larger (PSP) case; libmad's decode is safely well
|
||||||
|
// within it.
|
||||||
|
#define AUDIO_MP3_MAX_SAMPLES_PER_FRAME (1152 * 2 * 2)
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
// This stream's own private handle into its asset's underlying file -
|
||||||
|
// see audiostreampcm_t.file's own comment for why this isn't shared
|
||||||
|
// across streams playing the same asset. Holds compressed MP3 bytes;
|
||||||
|
// the decoder backend (audiostreammp3decoder.h) reads from it directly.
|
||||||
|
assetfile_t file;
|
||||||
|
|
||||||
|
// Opaque per-platform decoder state - a reserved sceMp3 handle plus its
|
||||||
|
// buffers on PSP, or libmad's mad_stream/mad_frame/mad_synth state plus a
|
||||||
|
// sliding compressed-byte window on the libmad-based software backend
|
||||||
|
// (Linux/Dolphin). Defined by whichever audiostreammp3decoder.h is
|
||||||
|
// actually visible when this file is compiled - see that header's own
|
||||||
|
// comment.
|
||||||
|
audiostreammp3decoder_t decoder;
|
||||||
|
|
||||||
|
// One decoded MPEG frame's worth of PCM, held here across Read() calls
|
||||||
|
// since a frame (576 or 1152 samples/channel) rarely lines up exactly
|
||||||
|
// with whatever frameCount a caller asks for. pendingPosition marks how
|
||||||
|
// many of the first pendingFrames frames have already been consumed.
|
||||||
|
int16_t pending[AUDIO_MP3_MAX_SAMPLES_PER_FRAME];
|
||||||
|
size_t pendingFrames;
|
||||||
|
size_t pendingPosition;
|
||||||
|
|
||||||
|
// Current logical PCM frame position, relative to the start of the
|
||||||
|
// decoded stream - decoding is push-forward-only (see
|
||||||
|
// audioStreamMp3Seek()'s own comment on why a backward seek re-decodes
|
||||||
|
// from the start rather than truly random-accessing).
|
||||||
|
size_t position;
|
||||||
|
|
||||||
|
// Total decoded PCM frame count for the whole clip - copied from the
|
||||||
|
// asset's parsed metadata at Init (see assetmp3file_t.totalFrames),
|
||||||
|
// exact if a Xing/Info header was present, otherwise an estimate.
|
||||||
|
size_t totalFrames;
|
||||||
|
} audiostreammp3_t;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Configures the given MP3 audio stream from its already-assigned asset
|
||||||
|
* (see audiostream_t.asset - set by audioStreamInit(), which is what
|
||||||
|
* should be calling this, not application code directly): opens this
|
||||||
|
* stream's own private file handle onto the asset's compressed MPEG data,
|
||||||
|
* and initializes the platform decoder backend
|
||||||
|
* (audioStreamMp3DecoderInit()).
|
||||||
|
*
|
||||||
|
* Must be called after stream->asset is set and before audioStreamPlay().
|
||||||
|
*
|
||||||
|
* @param stream The audio stream to configure.
|
||||||
|
* @return Error indicating success or failure.
|
||||||
|
*/
|
||||||
|
errorret_t audioStreamMp3Init(audiostream_t *stream);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Disposes the given MP3 audio stream's decoder backend and private file
|
||||||
|
* handle.
|
||||||
|
*
|
||||||
|
* @param stream The audio stream to dispose.
|
||||||
|
* @return Error indicating success or failure.
|
||||||
|
*/
|
||||||
|
errorret_t audioStreamMp3Dispose(audiostream_t *stream);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the total number of frames (one sample per channel) available in
|
||||||
|
* the stream's underlying MP3 data - see assetmp3file_t.totalFrames's own
|
||||||
|
* comment on why this is sometimes an estimate rather than an exact count,
|
||||||
|
* unlike audioStreamPcmGetTotalFrames().
|
||||||
|
*
|
||||||
|
* @param stream The audio stream to query. Must be AUDIO_STREAM_TYPE_MP3.
|
||||||
|
* @return The total number of frames available.
|
||||||
|
*/
|
||||||
|
size_t audioStreamMp3GetTotalFrames(const audiostream_t *stream);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Seeks the stream's decode position to the given frame offset. Unlike
|
||||||
|
* audioStreamPcmSeek(), this is never cheap: MPEG frames aren't
|
||||||
|
* independently decodable (each one's bit reservoir can depend on data
|
||||||
|
* carried over from prior frames), so there's no equivalent of PCM's
|
||||||
|
* direct byte-offset seek - every call, forward or backward, rewinds the
|
||||||
|
* decoder to the very start of the compressed stream and decodes (and
|
||||||
|
* discards) frames until reaching the target. Acceptable for this engine's
|
||||||
|
* actual use (looping background music, where loopTo is typically near
|
||||||
|
* the start anyway), but a real, non-constant cost for a seek deep into a
|
||||||
|
* long track.
|
||||||
|
*
|
||||||
|
* @param stream The audio stream to seek. Must be AUDIO_STREAM_TYPE_MP3.
|
||||||
|
* @param frame Frame offset to seek to, relative to the start of the
|
||||||
|
* decoded stream.
|
||||||
|
* @return Error indicating success or failure.
|
||||||
|
*/
|
||||||
|
errorret_t audioStreamMp3Seek(audiostream_t *stream, const size_t frame);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reads up to frameCount frames of PCM sample data from the stream's
|
||||||
|
* current position, advancing it by however many frames were actually
|
||||||
|
* read. Reads fewer than frameCount (down to zero) once the underlying
|
||||||
|
* MP3 data is exhausted, rather than erroring - same contract as
|
||||||
|
* audioStreamPcmRead().
|
||||||
|
*
|
||||||
|
* @param stream The audio stream to read from. Must be AUDIO_STREAM_TYPE_MP3.
|
||||||
|
* @param buffer Destination buffer, sized for at least frameCount frames.
|
||||||
|
* @param frameCount Maximum number of frames to read.
|
||||||
|
* @param outFramesRead Set to the number of frames actually read.
|
||||||
|
* @return Error indicating success or failure.
|
||||||
|
*/
|
||||||
|
errorret_t audioStreamMp3Read(
|
||||||
|
audiostream_t *stream,
|
||||||
|
int16_t *buffer,
|
||||||
|
const size_t frameCount,
|
||||||
|
size_t *outFramesRead
|
||||||
|
);
|
||||||
@@ -10,6 +10,7 @@
|
|||||||
#include "assert/assert.h"
|
#include "assert/assert.h"
|
||||||
#include "util/math.h"
|
#include "util/math.h"
|
||||||
#include "util/memory.h"
|
#include "util/memory.h"
|
||||||
|
#include "util/endian.h"
|
||||||
|
|
||||||
errorret_t audioStreamPcmInit(audiostream_t *stream) {
|
errorret_t audioStreamPcmInit(audiostream_t *stream) {
|
||||||
assertNotNull(stream, "Stream cannot be NULL.");
|
assertNotNull(stream, "Stream cannot be NULL.");
|
||||||
@@ -22,8 +23,8 @@ errorret_t audioStreamPcmInit(audiostream_t *stream) {
|
|||||||
assetwavfile_t *wav = &stream->asset->data.wav;
|
assetwavfile_t *wav = &stream->asset->data.wav;
|
||||||
|
|
||||||
stream->type = AUDIO_STREAM_TYPE_PCM;
|
stream->type = AUDIO_STREAM_TYPE_PCM;
|
||||||
stream->pcm.sampleRate = wav->sampleRate;
|
stream->sampleRate = wav->sampleRate;
|
||||||
stream->pcm.channels = wav->channels;
|
stream->channels = wav->channels;
|
||||||
stream->duration = (
|
stream->duration = (
|
||||||
(float_t) audioStreamPcmGetTotalFrames(stream) /
|
(float_t) audioStreamPcmGetTotalFrames(stream) /
|
||||||
(float_t) wav->sampleRate
|
(float_t) wav->sampleRate
|
||||||
@@ -64,7 +65,7 @@ size_t audioStreamPcmGetTotalFrames(const audiostream_t *stream) {
|
|||||||
|
|
||||||
const assetwavfile_t *wav = &stream->asset->data.wav;
|
const assetwavfile_t *wav = &stream->asset->data.wav;
|
||||||
const size_t sourceFrameSize = (
|
const size_t sourceFrameSize = (
|
||||||
stream->pcm.channels * (wav->bitsPerSample / 8)
|
stream->channels * (wav->bitsPerSample / 8)
|
||||||
);
|
);
|
||||||
return wav->dataSize / sourceFrameSize;
|
return wav->dataSize / sourceFrameSize;
|
||||||
}
|
}
|
||||||
@@ -75,7 +76,7 @@ errorret_t audioStreamPcmSeek(audiostream_t *stream, const size_t frame) {
|
|||||||
|
|
||||||
assetwavfile_t *wav = &stream->asset->data.wav;
|
assetwavfile_t *wav = &stream->asset->data.wav;
|
||||||
const size_t sourceFrameSize = (
|
const size_t sourceFrameSize = (
|
||||||
stream->pcm.channels * (wav->bitsPerSample / 8)
|
stream->channels * (wav->bitsPerSample / 8)
|
||||||
);
|
);
|
||||||
const size_t targetByte = wav->dataOffset + (frame * sourceFrameSize);
|
const size_t targetByte = wav->dataOffset + (frame * sourceFrameSize);
|
||||||
|
|
||||||
@@ -86,10 +87,10 @@ errorret_t audioStreamPcmSeek(audiostream_t *stream, const size_t frame) {
|
|||||||
|
|
||||||
const size_t currentByte = (size_t) stream->pcm.file.position;
|
const size_t currentByte = (size_t) stream->pcm.file.position;
|
||||||
if(targetByte < currentByte) {
|
if(targetByte < currentByte) {
|
||||||
// Only a full rewind can move a read cursor earlier once it's already
|
// A rewind is needed to move the read cursor earlier once it's
|
||||||
// advanced past a point - a compressed archive entry can't be decoded
|
// already advanced past a point - assetFileRewind() takes the cheap
|
||||||
// backward. See this function's own doc comment for the performance
|
// in-place seek path since every dusk.dsk entry is stored
|
||||||
// implications of a deep loopTo.
|
// uncompressed.
|
||||||
errorChain(assetFileRewind(&stream->pcm.file));
|
errorChain(assetFileRewind(&stream->pcm.file));
|
||||||
errorChain(assetFileRead(&stream->pcm.file, NULL, targetByte));
|
errorChain(assetFileRead(&stream->pcm.file, NULL, targetByte));
|
||||||
} else if(targetByte > currentByte) {
|
} else if(targetByte > currentByte) {
|
||||||
@@ -113,7 +114,7 @@ errorret_t audioStreamPcmRead(
|
|||||||
assertTrue(stream->type == AUDIO_STREAM_TYPE_PCM, "Stream is not PCM.");
|
assertTrue(stream->type == AUDIO_STREAM_TYPE_PCM, "Stream is not PCM.");
|
||||||
|
|
||||||
assetwavfile_t *wav = &stream->asset->data.wav;
|
assetwavfile_t *wav = &stream->asset->data.wav;
|
||||||
const size_t channels = stream->pcm.channels;
|
const size_t channels = stream->channels;
|
||||||
const size_t sourceSampleBytes = wav->bitsPerSample / 8;
|
const size_t sourceSampleBytes = wav->bitsPerSample / 8;
|
||||||
const size_t sourceFrameSize = channels * sourceSampleBytes;
|
const size_t sourceFrameSize = channels * sourceSampleBytes;
|
||||||
const size_t dataEndByte = wav->dataOffset + wav->dataSize;
|
const size_t dataEndByte = wav->dataOffset + wav->dataSize;
|
||||||
@@ -131,10 +132,19 @@ errorret_t audioStreamPcmRead(
|
|||||||
}
|
}
|
||||||
|
|
||||||
if(sourceSampleBytes == sizeof(int16_t)) {
|
if(sourceSampleBytes == sizeof(int16_t)) {
|
||||||
// Output format already matches the source - read straight through.
|
// Output format already matches the source in width, but WAV samples
|
||||||
|
// are always little-endian per the format spec regardless of host -
|
||||||
|
// read straight through, then fix up byte order in place. A no-op on
|
||||||
|
// every little-endian platform (endianLittleToHost16() compiles down
|
||||||
|
// to returning its argument unchanged there) - only actually swaps
|
||||||
|
// anything on a big-endian host (Dolphin/GameCube/Wii).
|
||||||
errorChain(assetFileRead(
|
errorChain(assetFileRead(
|
||||||
&stream->pcm.file, buffer, framesToRead * sourceFrameSize
|
&stream->pcm.file, buffer, framesToRead * sourceFrameSize
|
||||||
));
|
));
|
||||||
|
const size_t sampleCount = framesToRead * channels;
|
||||||
|
for(size_t i = 0; i < sampleCount; i++) {
|
||||||
|
buffer[i] = (int16_t) endianLittleToHost16((uint16_t) buffer[i]);
|
||||||
|
}
|
||||||
} else {
|
} else {
|
||||||
// 24-bit source (the only other width assetWavParseHeader() accepts) -
|
// 24-bit source (the only other width assetWavParseHeader() accepts) -
|
||||||
// read the raw 3-byte samples into a scratch buffer, then truncate
|
// read the raw 3-byte samples into a scratch buffer, then truncate
|
||||||
@@ -12,12 +12,6 @@
|
|||||||
typedef struct audiostream_s audiostream_t;
|
typedef struct audiostream_s audiostream_t;
|
||||||
|
|
||||||
typedef struct {
|
typedef struct {
|
||||||
// Sample rate of the stream's data, in Hz.
|
|
||||||
uint32_t sampleRate;
|
|
||||||
|
|
||||||
// Number of interleaved channels in the stream's data.
|
|
||||||
uint8_t channels;
|
|
||||||
|
|
||||||
// This stream's own private handle into its asset's underlying file -
|
// This stream's own private handle into its asset's underlying file -
|
||||||
// deliberately not shared with any other stream reading the same asset
|
// deliberately not shared with any other stream reading the same asset
|
||||||
// (see audioStreamPcmInit's own comment for why). Its read cursor is
|
// (see audioStreamPcmInit's own comment for why). Its read cursor is
|
||||||
@@ -69,11 +63,8 @@ size_t audioStreamPcmGetTotalFrames(const audiostream_t *stream);
|
|||||||
* (relative to the start of the PCM data - the same units as
|
* (relative to the start of the PCM data - the same units as
|
||||||
* audiostream_t's startFrame/loopStart/loopTo, once converted from
|
* audiostream_t's startFrame/loopStart/loopTo, once converted from
|
||||||
* seconds). Seeking backward re-reads from the start of the underlying
|
* seconds). Seeking backward re-reads from the start of the underlying
|
||||||
* asset file (see assetFileRewind()) since a compressed archive entry can
|
* asset file (see assetFileRewind()), which is a cheap in-place seek
|
||||||
* only be decoded forward - this makes a loop with a deep loopTo more
|
* since every dusk.dsk entry is stored uncompressed.
|
||||||
* expensive to restart than one near the start, which is a real
|
|
||||||
* performance caveat, not just a theoretical one, for anything backed by
|
|
||||||
* a compressed (not stored) asset archive entry.
|
|
||||||
*
|
*
|
||||||
* @param stream The audio stream to seek. Must be AUDIO_STREAM_TYPE_PCM.
|
* @param stream The audio stream to seek. Must be AUDIO_STREAM_TYPE_PCM.
|
||||||
* @param frame Frame offset to seek to, relative to the start of the PCM
|
* @param frame Frame offset to seek to, relative to the start of the PCM
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2026 Dominic Masters
|
||||||
|
*
|
||||||
|
* This software is released under the MIT License.
|
||||||
|
* https://opensource.org/licenses/MIT
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include "audiostreamtype.h"
|
||||||
|
#include "util/string.h"
|
||||||
|
|
||||||
|
const audiostreamassettypeinfo_t
|
||||||
|
AUDIO_STREAM_TYPE_FOR_ASSET_TYPE[ASSET_LOADER_TYPE_COUNT] = {
|
||||||
|
[ASSET_LOADER_TYPE_WAV] = {
|
||||||
|
.type = AUDIO_STREAM_TYPE_PCM, .extension = ".wav"
|
||||||
|
},
|
||||||
|
[ASSET_LOADER_TYPE_MP3] = {
|
||||||
|
.type = AUDIO_STREAM_TYPE_MP3, .extension = ".mp3"
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
assetloadertype_t audioStreamAssetTypeForPath(const char_t *path) {
|
||||||
|
for(assetloadertype_t i = 0; i < ASSET_LOADER_TYPE_COUNT; i++) {
|
||||||
|
const char_t *extension = AUDIO_STREAM_TYPE_FOR_ASSET_TYPE[i].extension;
|
||||||
|
if(extension != NULL && stringEndsWithCaseInsensitive(path, extension)) {
|
||||||
|
return i;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return ASSET_LOADER_TYPE_NULL;
|
||||||
|
}
|
||||||
|
|
||||||
|
audistreamtype_t audioStreamTypeForAssetType(
|
||||||
|
const assetloadertype_t assetType
|
||||||
|
) {
|
||||||
|
return AUDIO_STREAM_TYPE_FOR_ASSET_TYPE[assetType].type;
|
||||||
|
}
|
||||||
|
|
||||||
|
assetloadertype_t audioStreamAssetTypeForStreamType(
|
||||||
|
const audistreamtype_t streamType
|
||||||
|
) {
|
||||||
|
if(streamType == AUDIO_STREAM_TYPE_NULL) return ASSET_LOADER_TYPE_NULL;
|
||||||
|
|
||||||
|
for(assetloadertype_t i = 0; i < ASSET_LOADER_TYPE_COUNT; i++) {
|
||||||
|
if(AUDIO_STREAM_TYPE_FOR_ASSET_TYPE[i].type == streamType) {
|
||||||
|
return i;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return ASSET_LOADER_TYPE_NULL;
|
||||||
|
}
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2026 Dominic Masters
|
||||||
|
*
|
||||||
|
* This software is released under the MIT License.
|
||||||
|
* https://opensource.org/licenses/MIT
|
||||||
|
*/
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
#include "dusk.h"
|
||||||
|
#include "asset/loader/assetloader.h"
|
||||||
|
|
||||||
|
typedef enum {
|
||||||
|
AUDIO_STREAM_TYPE_NULL,
|
||||||
|
AUDIO_STREAM_TYPE_PCM,
|
||||||
|
AUDIO_STREAM_TYPE_MP3,
|
||||||
|
AUDIO_STREAM_TYPE_COUNT
|
||||||
|
} audistreamtype_t;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
// The audistreamtype_t an audio stream backed by this asset type should
|
||||||
|
// become - AUDIO_STREAM_TYPE_NULL (the zero-initialized default) for any
|
||||||
|
// asset type that can't back an audio stream.
|
||||||
|
audistreamtype_t type;
|
||||||
|
|
||||||
|
// This asset type's file extension, including the leading '.' (e.g.
|
||||||
|
// ".wav"). NULL for any asset type that can't back an audio stream.
|
||||||
|
const char_t *extension;
|
||||||
|
} audiostreamassettypeinfo_t;
|
||||||
|
|
||||||
|
// Maps an assetloadertype_t to the info describing the audio stream it
|
||||||
|
// backs. Indexed directly by assetentry_t.type; see audioStreamInit()'s own
|
||||||
|
// use of this for the canonical "is this asset type supported" check. Use
|
||||||
|
// the functions below rather than indexing this directly, except where
|
||||||
|
// you already have an assetloadertype_t in hand.
|
||||||
|
extern const audiostreamassettypeinfo_t
|
||||||
|
AUDIO_STREAM_TYPE_FOR_ASSET_TYPE[ASSET_LOADER_TYPE_COUNT];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Determines which asset loader type a file path's extension corresponds
|
||||||
|
* to, by matching it against AUDIO_STREAM_TYPE_FOR_ASSET_TYPE's own
|
||||||
|
* extensions (case-insensitively).
|
||||||
|
*
|
||||||
|
* @param path The file path to inspect, e.g. "audio/boa.mp3".
|
||||||
|
* @return The matching assetloadertype_t, or ASSET_LOADER_TYPE_NULL if the
|
||||||
|
* path's extension doesn't match any audio asset type.
|
||||||
|
*/
|
||||||
|
assetloadertype_t audioStreamAssetTypeForPath(const char_t *path);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Looks up the audistreamtype_t an audio stream backed by the given asset
|
||||||
|
* type should become.
|
||||||
|
*
|
||||||
|
* @param assetType The asset loader type to look up.
|
||||||
|
* @return The matching audistreamtype_t, or AUDIO_STREAM_TYPE_NULL if
|
||||||
|
* assetType can't back an audio stream.
|
||||||
|
*/
|
||||||
|
audistreamtype_t audioStreamTypeForAssetType(const assetloadertype_t assetType);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Looks up which asset loader type backs audio streams of the given type -
|
||||||
|
* the reverse of audioStreamTypeForAssetType(). Scans
|
||||||
|
* AUDIO_STREAM_TYPE_FOR_ASSET_TYPE for the first entry whose type matches,
|
||||||
|
* since it isn't itself indexed by audistreamtype_t.
|
||||||
|
*
|
||||||
|
* @param streamType The audio stream type to look up.
|
||||||
|
* @return The matching assetloadertype_t, or ASSET_LOADER_TYPE_NULL if
|
||||||
|
* streamType is AUDIO_STREAM_TYPE_NULL or otherwise unmapped.
|
||||||
|
*/
|
||||||
|
assetloadertype_t audioStreamAssetTypeForStreamType(
|
||||||
|
const audistreamtype_t streamType
|
||||||
|
);
|
||||||
@@ -17,8 +17,8 @@ console_t CONSOLE;
|
|||||||
|
|
||||||
void consoleInit(void) {
|
void consoleInit(void) {
|
||||||
memoryZero(&CONSOLE, sizeof(console_t));
|
memoryZero(&CONSOLE, sizeof(console_t));
|
||||||
// CONSOLE.visible = false;
|
CONSOLE.visible = false;
|
||||||
CONSOLE.visible = true;
|
// CONSOLE.visible = true;
|
||||||
threadMutexInit(&CONSOLE.printMutex);
|
threadMutexInit(&CONSOLE.printMutex);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -73,27 +73,33 @@ void sphereBuffer(
|
|||||||
const float_t u1 = (float_t)j / (float_t)sectors;
|
const float_t u1 = (float_t)j / (float_t)sectors;
|
||||||
const float_t u2 = (float_t)(j + 1) / (float_t)sectors;
|
const float_t u2 = (float_t)(j + 1) / (float_t)sectors;
|
||||||
|
|
||||||
vertices[vi].pos[0] = center[0] + x11; vertices[vi].pos[1] = center[1] + y1;
|
vertices[vi].pos[0] = center[0] + x11;
|
||||||
|
vertices[vi].pos[1] = center[1] + y1;
|
||||||
vertices[vi].pos[2] = center[2] + z11;
|
vertices[vi].pos[2] = center[2] + z11;
|
||||||
vertices[vi].uv[0] = u1; vertices[vi].uv[1] = v1; vi++;
|
vertices[vi].uv[0] = u1; vertices[vi].uv[1] = v1; vi++;
|
||||||
|
|
||||||
vertices[vi].pos[0] = center[0] + x21; vertices[vi].pos[1] = center[1] + y2;
|
vertices[vi].pos[0] = center[0] + x21;
|
||||||
|
vertices[vi].pos[1] = center[1] + y2;
|
||||||
vertices[vi].pos[2] = center[2] + z21;
|
vertices[vi].pos[2] = center[2] + z21;
|
||||||
vertices[vi].uv[0] = u1; vertices[vi].uv[1] = v2; vi++;
|
vertices[vi].uv[0] = u1; vertices[vi].uv[1] = v2; vi++;
|
||||||
|
|
||||||
vertices[vi].pos[0] = center[0] + x12; vertices[vi].pos[1] = center[1] + y1;
|
vertices[vi].pos[0] = center[0] + x12;
|
||||||
|
vertices[vi].pos[1] = center[1] + y1;
|
||||||
vertices[vi].pos[2] = center[2] + z12;
|
vertices[vi].pos[2] = center[2] + z12;
|
||||||
vertices[vi].uv[0] = u2; vertices[vi].uv[1] = v1; vi++;
|
vertices[vi].uv[0] = u2; vertices[vi].uv[1] = v1; vi++;
|
||||||
|
|
||||||
vertices[vi].pos[0] = center[0] + x12; vertices[vi].pos[1] = center[1] + y1;
|
vertices[vi].pos[0] = center[0] + x12;
|
||||||
|
vertices[vi].pos[1] = center[1] + y1;
|
||||||
vertices[vi].pos[2] = center[2] + z12;
|
vertices[vi].pos[2] = center[2] + z12;
|
||||||
vertices[vi].uv[0] = u2; vertices[vi].uv[1] = v1; vi++;
|
vertices[vi].uv[0] = u2; vertices[vi].uv[1] = v1; vi++;
|
||||||
|
|
||||||
vertices[vi].pos[0] = center[0] + x21; vertices[vi].pos[1] = center[1] + y2;
|
vertices[vi].pos[0] = center[0] + x21;
|
||||||
|
vertices[vi].pos[1] = center[1] + y2;
|
||||||
vertices[vi].pos[2] = center[2] + z21;
|
vertices[vi].pos[2] = center[2] + z21;
|
||||||
vertices[vi].uv[0] = u1; vertices[vi].uv[1] = v2; vi++;
|
vertices[vi].uv[0] = u1; vertices[vi].uv[1] = v2; vi++;
|
||||||
|
|
||||||
vertices[vi].pos[0] = center[0] + x22; vertices[vi].pos[1] = center[1] + y2;
|
vertices[vi].pos[0] = center[0] + x22;
|
||||||
|
vertices[vi].pos[1] = center[1] + y2;
|
||||||
vertices[vi].pos[2] = center[2] + z22;
|
vertices[vi].pos[2] = center[2] + z22;
|
||||||
vertices[vi].uv[0] = u2; vertices[vi].uv[1] = v2; vi++;
|
vertices[vi].uv[0] = u2; vertices[vi].uv[1] = v2; vi++;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -76,7 +76,8 @@ errorret_t spriteBatchBuffer(
|
|||||||
|
|
||||||
// Buffer to the mesh vertices.
|
// Buffer to the mesh vertices.
|
||||||
spriteBatchBufferToMesh(
|
spriteBatchBufferToMesh(
|
||||||
sprites + (count - remaining), batchCount, v, batchCount * QUAD_VERTEX_COUNT
|
sprites + (count - remaining), batchCount, v,
|
||||||
|
batchCount * QUAD_VERTEX_COUNT
|
||||||
);
|
);
|
||||||
SPRITEBATCH.spriteCount += batchCount;
|
SPRITEBATCH.spriteCount += batchCount;
|
||||||
remaining -= batchCount;
|
remaining -= batchCount;
|
||||||
|
|||||||
@@ -82,9 +82,11 @@ const uint8_t FONT_DEFAULT_GLYPHS[FONT_DEFAULT_TILE_COUNT][
|
|||||||
// Caps Lock's row widths becomes a column height here, centered
|
// Caps Lock's row widths becomes a column height here, centered
|
||||||
// vertically). Backslash was never drawn anyway, and isn't a key this
|
// vertically). Backslash was never drawn anyway, and isn't a key this
|
||||||
// virtual keyboard can type - see FONT_ICON_BACKSPACE.
|
// virtual keyboard can type - see FONT_ICON_BACKSPACE.
|
||||||
{ 0x00, 0x00, 0x08, 0x1F, 0x3F, 0x3F, 0x1F, 0x08, 0x00, 0x00 }, // FONT_ICON_BACKSPACE
|
// FONT_ICON_BACKSPACE
|
||||||
|
{ 0x00, 0x00, 0x08, 0x1F, 0x3F, 0x3F, 0x1F, 0x08, 0x00, 0x00 },
|
||||||
{ 0x00, 0x18, 0x08, 0x08, 0x08, 0x08, 0x08, 0x18, 0x00, 0x00 }, // ]
|
{ 0x00, 0x18, 0x08, 0x08, 0x08, 0x08, 0x08, 0x18, 0x00, 0x00 }, // ]
|
||||||
{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }, // ^ (not drawn in source font)
|
// ^ (not drawn in source font)
|
||||||
|
{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 },
|
||||||
{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x3E }, // _
|
{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x3E }, // _
|
||||||
// Custom icon glyph, not a real backtick - an up arrow for Shift, same
|
// Custom icon glyph, not a real backtick - an up arrow for Shift, same
|
||||||
// head as Caps Lock's (see FONT_ICON_CAPSLOCK) but with a shaft 2px
|
// head as Caps Lock's (see FONT_ICON_CAPSLOCK) but with a shaft 2px
|
||||||
@@ -92,7 +94,8 @@ const uint8_t FONT_DEFAULT_GLYPHS[FONT_DEFAULT_TILE_COUNT][
|
|||||||
// lighter/broken version of Caps Lock's thicker uninterrupted one.
|
// lighter/broken version of Caps Lock's thicker uninterrupted one.
|
||||||
// Backtick was never drawn anyway, and isn't a key this virtual
|
// Backtick was never drawn anyway, and isn't a key this virtual
|
||||||
// keyboard can type - see FONT_ICON_SHIFT.
|
// keyboard can type - see FONT_ICON_SHIFT.
|
||||||
{ 0x0C, 0x1E, 0x3F, 0x0C, 0x0C, 0x0C, 0x0C, 0x00, 0x0C, 0x00 }, // FONT_ICON_SHIFT
|
// FONT_ICON_SHIFT
|
||||||
|
{ 0x0C, 0x1E, 0x3F, 0x0C, 0x0C, 0x0C, 0x0C, 0x00, 0x0C, 0x00 },
|
||||||
{ 0x00, 0x00, 0x00, 0x1E, 0x22, 0x22, 0x22, 0x1E, 0x00, 0x00 }, // a
|
{ 0x00, 0x00, 0x00, 0x1E, 0x22, 0x22, 0x22, 0x1E, 0x00, 0x00 }, // a
|
||||||
{ 0x00, 0x20, 0x20, 0x3C, 0x22, 0x22, 0x22, 0x3C, 0x00, 0x00 }, // b
|
{ 0x00, 0x20, 0x20, 0x3C, 0x22, 0x22, 0x22, 0x3C, 0x00, 0x00 }, // b
|
||||||
{ 0x00, 0x00, 0x00, 0x1C, 0x22, 0x20, 0x22, 0x1C, 0x00, 0x00 }, // c
|
{ 0x00, 0x00, 0x00, 0x1C, 0x22, 0x20, 0x22, 0x1C, 0x00, 0x00 }, // c
|
||||||
@@ -125,21 +128,25 @@ const uint8_t FONT_DEFAULT_GLYPHS[FONT_DEFAULT_TILE_COUNT][
|
|||||||
// hooks left into a leftward-pointing arrowhead, i.e. "<-|" rotated
|
// hooks left into a leftward-pointing arrowhead, i.e. "<-|" rotated
|
||||||
// into an L. Pipe was never drawn anyway, and isn't a key this
|
// into an L. Pipe was never drawn anyway, and isn't a key this
|
||||||
// virtual keyboard can type - see FONT_ICON_NEWLINE.
|
// virtual keyboard can type - see FONT_ICON_NEWLINE.
|
||||||
{ 0x02, 0x02, 0x02, 0x02, 0x0E, 0x1E, 0x08, 0x00, 0x00, 0x00 }, // FONT_ICON_NEWLINE
|
// FONT_ICON_NEWLINE
|
||||||
|
{ 0x02, 0x02, 0x02, 0x02, 0x0E, 0x1E, 0x08, 0x00, 0x00, 0x00 },
|
||||||
{ 0x00, 0x10, 0x08, 0x08, 0x04, 0x08, 0x08, 0x10, 0x00, 0x00 }, // }
|
{ 0x00, 0x10, 0x08, 0x08, 0x04, 0x08, 0x08, 0x10, 0x00, 0x00 }, // }
|
||||||
// Custom icon glyph, not a real tilde - a spacebar symbol for the
|
// Custom icon glyph, not a real tilde - a spacebar symbol for the
|
||||||
// keyboard's space key: an underscore with a tick at each end, like
|
// keyboard's space key: an underscore with a tick at each end, like
|
||||||
// "|___|". Tilde was never drawn anyway, and was explicitly dropped
|
// "|___|". Tilde was never drawn anyway, and was explicitly dropped
|
||||||
// from this virtual keyboard's own key set - see FONT_ICON_SPACE.
|
// from this virtual keyboard's own key set - see FONT_ICON_SPACE.
|
||||||
{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x21, 0x3F }, // FONT_ICON_SPACE
|
// FONT_ICON_SPACE
|
||||||
|
{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x21, 0x3F },
|
||||||
// Custom icon glyph, not a real ASCII character - a thick, solid,
|
// Custom icon glyph, not a real ASCII character - a thick, solid,
|
||||||
// uninterrupted up arrow for Caps Lock (contrast FONT_ICON_SHIFT's
|
// uninterrupted up arrow for Caps Lock (contrast FONT_ICON_SHIFT's
|
||||||
// same head but a thinner, gapped shaft). Assigned to char code 127
|
// same head but a thinner, gapped shaft). Assigned to char code 127
|
||||||
// (DEL) since that codepoint is never legitimately typed text and
|
// (DEL) since that codepoint is never legitimately typed text and
|
||||||
// (unlike 128+) is still a positive value regardless of whether this
|
// (unlike 128+) is still a positive value regardless of whether this
|
||||||
// platform's plain `char` is signed - see FONT_ICON_CAPSLOCK.
|
// platform's plain `char` is signed - see FONT_ICON_CAPSLOCK.
|
||||||
{ 0x0C, 0x1E, 0x3F, 0x1E, 0x1E, 0x1E, 0x1E, 0x1E, 0x1E, 0x00 }, // FONT_ICON_CAPSLOCK
|
// FONT_ICON_CAPSLOCK
|
||||||
{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }, // unused trailing tile
|
{ 0x0C, 0x1E, 0x3F, 0x1E, 0x1E, 0x1E, 0x1E, 0x1E, 0x1E, 0x00 },
|
||||||
|
// unused trailing tile
|
||||||
|
{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 },
|
||||||
};
|
};
|
||||||
|
|
||||||
errorret_t fontDefaultInit(void) {
|
errorret_t fontDefaultInit(void) {
|
||||||
@@ -155,7 +162,8 @@ errorret_t fontDefaultInit(void) {
|
|||||||
|
|
||||||
for(uint16_t i = 0; i < FONT_DEFAULT_TILE_COUNT; i++) {
|
for(uint16_t i = 0; i < FONT_DEFAULT_TILE_COUNT; i++) {
|
||||||
const uint16_t tileX = (i % FONT_DEFAULT_COLUMNS) * FONT_DEFAULT_TILE_WIDTH;
|
const uint16_t tileX = (i % FONT_DEFAULT_COLUMNS) * FONT_DEFAULT_TILE_WIDTH;
|
||||||
const uint16_t tileY = (i / FONT_DEFAULT_COLUMNS) * FONT_DEFAULT_TILE_HEIGHT;
|
const uint16_t tileY =
|
||||||
|
(i / FONT_DEFAULT_COLUMNS) * FONT_DEFAULT_TILE_HEIGHT;
|
||||||
|
|
||||||
for(uint8_t row = 0; row < FONT_DEFAULT_TILE_HEIGHT; row++) {
|
for(uint8_t row = 0; row < FONT_DEFAULT_TILE_HEIGHT; row++) {
|
||||||
const uint8_t bits = FONT_DEFAULT_GLYPHS[i][row];
|
const uint8_t bits = FONT_DEFAULT_GLYPHS[i][row];
|
||||||
@@ -172,8 +180,10 @@ errorret_t fontDefaultInit(void) {
|
|||||||
FONT_DEFAULT_TILESET.columns = FONT_DEFAULT_COLUMNS;
|
FONT_DEFAULT_TILESET.columns = FONT_DEFAULT_COLUMNS;
|
||||||
FONT_DEFAULT_TILESET.rows = FONT_DEFAULT_ROWS;
|
FONT_DEFAULT_TILESET.rows = FONT_DEFAULT_ROWS;
|
||||||
FONT_DEFAULT_TILESET.tileCount = FONT_DEFAULT_TILE_COUNT;
|
FONT_DEFAULT_TILESET.tileCount = FONT_DEFAULT_TILE_COUNT;
|
||||||
FONT_DEFAULT_TILESET.uv[0] = (float_t)FONT_DEFAULT_TILE_WIDTH / (float_t)width;
|
FONT_DEFAULT_TILESET.uv[0] =
|
||||||
FONT_DEFAULT_TILESET.uv[1] = (float_t)FONT_DEFAULT_TILE_HEIGHT / (float_t)height;
|
(float_t)FONT_DEFAULT_TILE_WIDTH / (float_t)width;
|
||||||
|
FONT_DEFAULT_TILESET.uv[1] =
|
||||||
|
(float_t)FONT_DEFAULT_TILE_HEIGHT / (float_t)height;
|
||||||
|
|
||||||
const texturedata_t data = { .rgbaColors = pixels };
|
const texturedata_t data = { .rgbaColors = pixels };
|
||||||
errorret_t textureResult = textureInit(
|
errorret_t textureResult = textureInit(
|
||||||
|
|||||||
@@ -7,6 +7,7 @@
|
|||||||
|
|
||||||
#include "engine.h"
|
#include "engine.h"
|
||||||
#include "util/memory.h"
|
#include "util/memory.h"
|
||||||
|
#include "perf/perf.h"
|
||||||
#include "time/time.h"
|
#include "time/time.h"
|
||||||
#include "input/input.h"
|
#include "input/input.h"
|
||||||
#include "locale/localemanager.h"
|
#include "locale/localemanager.h"
|
||||||
@@ -23,17 +24,10 @@
|
|||||||
#include "console/console.h"
|
#include "console/console.h"
|
||||||
#include "save/save.h"
|
#include "save/save.h"
|
||||||
#include "audio/audio.h"
|
#include "audio/audio.h"
|
||||||
|
#include "audio/mixer/audiomixer.h"
|
||||||
|
|
||||||
engine_t ENGINE;
|
engine_t ENGINE;
|
||||||
|
|
||||||
void engineTestToneOnEnd(audiostream_t *stream) {
|
|
||||||
consolePrint("Test tone finished playing");
|
|
||||||
}
|
|
||||||
|
|
||||||
void engineTestToneOnLoop(audiostream_t *stream) {
|
|
||||||
consolePrint("Test tone looped");
|
|
||||||
}
|
|
||||||
|
|
||||||
errorret_t engineInit(const int32_t argc, const char_t **argv) {
|
errorret_t engineInit(const int32_t argc, const char_t **argv) {
|
||||||
assertInit();
|
assertInit();
|
||||||
memoryZero(&ENGINE, sizeof(engine_t));
|
memoryZero(&ENGINE, sizeof(engine_t));
|
||||||
@@ -43,6 +37,7 @@ errorret_t engineInit(const int32_t argc, const char_t **argv) {
|
|||||||
ENGINE.version = DUSK_VERSION;
|
ENGINE.version = DUSK_VERSION;
|
||||||
|
|
||||||
// Init systems. Order is important.
|
// Init systems. Order is important.
|
||||||
|
perfInit();
|
||||||
timeInit();
|
timeInit();
|
||||||
consoleInit();
|
consoleInit();
|
||||||
errorChain(systemInit());
|
errorChain(systemInit());
|
||||||
@@ -52,32 +47,13 @@ errorret_t engineInit(const int32_t argc, const char_t **argv) {
|
|||||||
errorChain(localeManagerInit());
|
errorChain(localeManagerInit());
|
||||||
errorChain(displayInit());
|
errorChain(displayInit());
|
||||||
errorChain(audioInit());
|
errorChain(audioInit());
|
||||||
errorChain(uiInit());
|
|
||||||
errorChain(rpgInit());
|
errorChain(rpgInit());
|
||||||
|
errorChain(uiInit());
|
||||||
#ifdef DUSK_NETWORK
|
#ifdef DUSK_NETWORK
|
||||||
errorChain(networkInit());
|
errorChain(networkInit());
|
||||||
#endif
|
#endif
|
||||||
errorChain(sceneInit());
|
errorChain(sceneInit());
|
||||||
|
|
||||||
// Smoke-tests the audio subsystem end to end (asset loading -> PCM
|
|
||||||
// streaming -> platform playback) against a real WAV asset rather than
|
|
||||||
// synthesizing PCM data at runtime.
|
|
||||||
assetentry_t *testToneEntry = assetLock(
|
|
||||||
"audio/pepsiman.wav", ASSET_LOADER_TYPE_WAV, NULL
|
|
||||||
// "audio/audiotest.wav", ASSET_LOADER_TYPE_WAV, NULL
|
|
||||||
);
|
|
||||||
errorChain(assetRequireLoaded(testToneEntry));
|
|
||||||
|
|
||||||
audiostream_t *stream = audioAquireStream(testToneEntry);
|
|
||||||
assertNotNull(stream, "No free audio stream slots available.");
|
|
||||||
errorChain(audioStreamInit(stream, testToneEntry));
|
|
||||||
assetUnlockEntry(testToneEntry); // The stream now holds its own lock.
|
|
||||||
|
|
||||||
stream->onEnd = engineTestToneOnEnd;
|
|
||||||
stream->onLoop = engineTestToneOnLoop;
|
|
||||||
audioStreamSetLooping(stream, true);
|
|
||||||
audioStreamPlay(stream);
|
|
||||||
|
|
||||||
consolePrint("Engine initialized");
|
consolePrint("Engine initialized");
|
||||||
|
|
||||||
#ifdef DUSK_ASSERTIONS_FAKED
|
#ifdef DUSK_ASSERTIONS_FAKED
|
||||||
@@ -100,7 +76,7 @@ errorret_t engineUpdate(void) {
|
|||||||
timeUpdate();
|
timeUpdate();
|
||||||
inputUpdate();
|
inputUpdate();
|
||||||
consoleUpdate();
|
consoleUpdate();
|
||||||
errorChain(audioUpdate());
|
errorChain(audioUpdateEarly());
|
||||||
errorChain(rpgUpdate());
|
errorChain(rpgUpdate());
|
||||||
errorChain(sceneUpdate());
|
errorChain(sceneUpdate());
|
||||||
errorChain(assetUpdate());
|
errorChain(assetUpdate());
|
||||||
@@ -108,6 +84,7 @@ errorret_t engineUpdate(void) {
|
|||||||
|
|
||||||
// Render
|
// Render
|
||||||
errorChain(displayUpdate());
|
errorChain(displayUpdate());
|
||||||
|
errorChain(audioUpdateLate());
|
||||||
if(inputPressed(INPUT_ACTION_RAGEQUIT)) ENGINE.running = false;
|
if(inputPressed(INPUT_ACTION_RAGEQUIT)) ENGINE.running = false;
|
||||||
errorOk();
|
errorOk();
|
||||||
}
|
}
|
||||||
@@ -129,6 +106,9 @@ errorret_t engineDispose(void) {
|
|||||||
errorChain(displayDispose());
|
errorChain(displayDispose());
|
||||||
errorChain(saveDispose());
|
errorChain(saveDispose());
|
||||||
errorChain(assetDispose());
|
errorChain(assetDispose());
|
||||||
|
perfDispose();
|
||||||
|
|
||||||
|
memoryCheckUnfreed();
|
||||||
|
|
||||||
errorOk();
|
errorOk();
|
||||||
}
|
}
|
||||||
@@ -34,13 +34,43 @@ errorret_t localeManagerInit();
|
|||||||
errorret_t localeManagerSetLocale(const localeinfo_t *locale);
|
errorret_t localeManagerSetLocale(const localeinfo_t *locale);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a localized string for the given message ID.
|
* Get a localized string for the given message ID verbatim, with no
|
||||||
*
|
* printf-style formatting applied - use this (rather than
|
||||||
|
* localeManagerGetText with no variadic args) whenever the raw string
|
||||||
|
* is displayed as-is, or cached to be formatted later (e.g. a
|
||||||
|
* "_format" message ID whose %-specifiers are filled in by the caller
|
||||||
|
* itself via stringFormat once the actual values are known). Passing a
|
||||||
|
* "_format" string through localeManagerGetText/GetTextArgs instead
|
||||||
|
* would consume it immediately as a format string with zero args,
|
||||||
|
* which is wrong for this use, and would also mishandle any literal
|
||||||
|
* '%' in a plain display string.
|
||||||
|
*
|
||||||
* @param id The message ID to retrieve.
|
* @param id The message ID to retrieve.
|
||||||
* @param buffer Buffer to write the retrieved string to.
|
* @param buffer Buffer to write the retrieved string to.
|
||||||
* @param bufferSize Size of the buffer.
|
* @param bufferSize Size of the buffer.
|
||||||
* @param plural Plural index to retrieve.
|
* @param plural Plural index to retrieve.
|
||||||
* @param ... Additional arguments for formatting the string.
|
* @return An error code if a failure occurs.
|
||||||
|
*/
|
||||||
|
#define localeManagerGetString(id, buffer, bufferSize, plural) \
|
||||||
|
assetLocaleGetString( \
|
||||||
|
&LOCALE.entry->data.locale, \
|
||||||
|
id, \
|
||||||
|
plural, \
|
||||||
|
buffer, \
|
||||||
|
bufferSize \
|
||||||
|
)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a localized string for the given message ID, formatted
|
||||||
|
* printf-style with the given variadic arguments.
|
||||||
|
*
|
||||||
|
* @param id The message ID to retrieve.
|
||||||
|
* @param buffer Buffer to write the retrieved string to.
|
||||||
|
* @param bufferSize Size of the buffer.
|
||||||
|
* @param plural Plural index to retrieve.
|
||||||
|
* @param ... Arguments for formatting the string - must not be empty,
|
||||||
|
* since the retrieved string is always run through vsnprintf; see
|
||||||
|
* localeManagerGetString for a message ID with no format args at all.
|
||||||
* @return An error code if a failure occurs.
|
* @return An error code if a failure occurs.
|
||||||
*/
|
*/
|
||||||
#define localeManagerGetText(id, buffer, bufferSize, plural, ...) \
|
#define localeManagerGetText(id, buffer, bufferSize, plural, ...) \
|
||||||
|
|||||||
Loaded 100 of 469 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user