diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ac86f819..8fd08833 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -93,14 +93,10 @@ jobs: id: build-cores run: | # https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources - set amount=2 + amount=2 if [ '${{ runner.os }}' == 'macOS' ]; then amount=3 fi - # the Actions runner does not seem to be happy with two jobs at once on MinGW - if [ '${{ matrix.config.compiler }}' == 'mingw' ]; then - amount=1 - fi echo "Amount of cores we can build with: ${amount}" @@ -229,17 +225,18 @@ jobs: if [ '${{ matrix.config.compiler }}' == 'msvc' ]; then binPath="${binPath}/${{ env.BUILD_TYPE }}" fi - if [ '${{ matrix.config.compiler }}' == 'mingw' ] && [ '${{ env.BUILD_TYPE }}' == 'Release' ]; then - # arch-specific strip prefix - # TODO maybe extract from cross toolchain files? - toolPrefix="-w64-mingw32-" - if [ '${{ matrix.config.arch }}' == 'x86_64' ]; then - toolPrefix="x86_64${toolPrefix}" - else - toolPrefix="i686${toolPrefix}" - fi - ${toolPrefix}strip -s "${binPath}/furnace.exe" - fi + # always strip on MinGW as it generate massive artifacts + #if [ '${{ matrix.config.compiler }}' == 'mingw' ]; then + # # arch-specific strip prefix + # # TODO maybe extract from cross toolchain files? + # toolPrefix="-w64-mingw32-" + # if [ '${{ matrix.config.arch }}' == 'x86_64' ]; then + # toolPrefix="x86_64${toolPrefix}" + # else + # toolPrefix="i686${toolPrefix}" + # fi + # ${toolPrefix}strip -s "${binPath}/furnace.exe" + #fi mkdir ${{ steps.package-identify.outputs.filename }} pushd ${{ steps.package-identify.outputs.filename }} @@ -261,9 +258,9 @@ jobs: - name: Package [Ubuntu] if: ${{ runner.os == 'Linux' && matrix.config.compiler != 'mingw' }} run: | - if [ '${{ env.BUILD_TYPE }}' == 'Release' ]; then - strip -s build/furnace - fi + #if [ '${{ env.BUILD_TYPE }}' == 'Release' ]; then + # strip -s build/furnace + #fi mkdir -p target/furnace.AppDir make -C ${PWD}/build DESTDIR=${PWD}/target/furnace.AppDir install diff --git a/.gitignore b/.gitignore index e582f4e3..06576ee5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ .vscode/ build/ +nosdl/ release/ t/ winbuild/ diff --git a/CMakeLists.txt b/CMakeLists.txt index 11251aa7..c57da901 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -18,12 +18,16 @@ set(CMAKE_PROJECT_VERSION_MINOR 6) set(CMAKE_PROJECT_VERSION_PATCH 0) set(BUILD_GUI_DEFAULT ON) +set(USE_SDL2_DEFAULT ON) +set(USE_SNDFILE_DEFAULT ON) set(SYSTEM_SDL2_DEFAULT OFF) if (ANDROID) set(USE_RTMIDI_DEFAULT OFF) + set(USE_BACKWARD_DEFAULT OFF) else() set(USE_RTMIDI_DEFAULT ON) + set(USE_BACKWARD_DEFAULT ON) endif() find_package(PkgConfig) @@ -35,7 +39,10 @@ else() endif() option(BUILD_GUI "Build the tracker (disable to build only a headless player)" ${BUILD_GUI_DEFAULT}) -option(USE_RTMIDI "Build with MIDI support using RtMidi. Currently unfinished." ${USE_RTMIDI_DEFAULT}) +option(USE_RTMIDI "Build with MIDI support using RtMidi." ${USE_RTMIDI_DEFAULT}) +option(USE_SDL2 "Build with SDL2. Required to build with GUI." ${USE_SDL2_DEFAULT}) +option(USE_SNDFILE "Build with libsndfile. Required in order to work with audio files." ${USE_SNDFILE_DEFAULT}) +option(USE_BACKWARD "Use backward-cpp to print a backtrace on crash/abort." ${USE_BACKWARD_DEFAULT}) option(WITH_JACK "Whether to build with JACK support. Auto-detects if JACK is available" ${WITH_JACK_DEFAULT}) option(SYSTEM_FMT "Use a system-installed version of fmt instead of the vendored one" OFF) option(SYSTEM_LIBSNDFILE "Use a system-installed version of libsndfile instead of the vendored one" OFF) @@ -93,25 +100,30 @@ else() message(STATUS "Using vendored fmt") endif() -if (SYSTEM_LIBSNDFILE) - find_package(PkgConfig REQUIRED) - pkg_check_modules(LIBSNDFILE REQUIRED sndfile) - list(APPEND DEPENDENCIES_INCLUDE_DIRS ${LIBSNDFILE_INCLUDE_DIRS}) - list(APPEND DEPENDENCIES_COMPILE_OPTIONS ${LIBSNDFILE_CFLAGS_OTHER}) - list(APPEND DEPENDENCIES_LIBRARIES ${LIBSNDFILE_LIBRARIES}) - list(APPEND DEPENDENCIES_LIBRARY_DIRS ${LIBSNDFILE_LIBRARY_DIRS}) - list(APPEND DEPENDENCIES_LINK_OPTIONS ${LIBSNDFILE_LDFLAGS_OTHER}) - list(APPEND DEPENDENCIES_LEGACY_LDFLAGS ${LIBSNDFILE_LDFLAGS}) - message(STATUS "Using system-installed libsndfile") +if (USE_SNDFILE) + list(APPEND DEPENDENCIES_DEFINES HAVE_SNDFILE) + if (SYSTEM_LIBSNDFILE) + find_package(PkgConfig REQUIRED) + pkg_check_modules(LIBSNDFILE REQUIRED sndfile) + list(APPEND DEPENDENCIES_INCLUDE_DIRS ${LIBSNDFILE_INCLUDE_DIRS}) + list(APPEND DEPENDENCIES_COMPILE_OPTIONS ${LIBSNDFILE_CFLAGS_OTHER}) + list(APPEND DEPENDENCIES_LIBRARIES ${LIBSNDFILE_LIBRARIES}) + list(APPEND DEPENDENCIES_LIBRARY_DIRS ${LIBSNDFILE_LIBRARY_DIRS}) + list(APPEND DEPENDENCIES_LINK_OPTIONS ${LIBSNDFILE_LDFLAGS_OTHER}) + list(APPEND DEPENDENCIES_LEGACY_LDFLAGS ${LIBSNDFILE_LDFLAGS}) + message(STATUS "Using system-installed libsndfile") + else() + set(BUILD_TESTING OFF CACHE BOOL "aaaaaa" FORCE) + set(BUILD_PROGRAMS OFF CACHE BOOL "aaa" FORCE) + set(BUILD_EXAMPLES OFF CACHE BOOL "a" FORCE) + set(ENABLE_EXTERNAL_LIBS OFF CACHE BOOL "come on" FORCE) + set(ENABLE_MPEG OFF CACHE BOOL "come on" FORCE) + add_subdirectory(extern/libsndfile EXCLUDE_FROM_ALL) + list(APPEND DEPENDENCIES_LIBRARIES sndfile) + message(STATUS "Using vendored libsndfile") + endif() else() - set(BUILD_TESTING OFF CACHE BOOL "aaaaaa" FORCE) - set(BUILD_PROGRAMS OFF CACHE BOOL "aaa" FORCE) - set(BUILD_EXAMPLES OFF CACHE BOOL "a" FORCE) - set(ENABLE_EXTERNAL_LIBS OFF CACHE BOOL "come on" FORCE) - set(ENABLE_MPEG OFF CACHE BOOL "come on" FORCE) - add_subdirectory(extern/libsndfile EXCLUDE_FROM_ALL) - list(APPEND DEPENDENCIES_LIBRARIES sndfile) - message(STATUS "Using vendored libsndfile") + message(STATUS "Not using libsndfile") endif() if (USE_RTMIDI) @@ -154,58 +166,71 @@ else() message(STATUS "Using vendored zlib") endif() -if (SYSTEM_SDL2) - if (PKG_CONFIG_FOUND) - pkg_check_modules(SDL2 sdl2>=${SYSTEM_SDL_MIN_VER}) - if (SDL2_FOUND) - list(APPEND DEPENDENCIES_INCLUDE_DIRS ${SDL2_INCLUDE_DIRS}) - list(APPEND DEPENDENCIES_COMPILE_OPTIONS ${SDL2_CFLAGS_OTHER}) - list(APPEND DEPENDENCIES_LIBRARIES ${SDL2_LIBRARIES}) - list(APPEND DEPENDENCIES_LIBRARY_DIRS ${SDL2_LIBRARY_DIRS}) - list(APPEND DEPENDENCIES_LINK_OPTIONS ${SDL2_LDFLAGS_OTHER}) - list(APPEND DEPENDENCIES_LEGACY_LDFLAGS ${SDL2_LDFLAGS}) +if (USE_SDL2) + if (SYSTEM_SDL2) + if (PKG_CONFIG_FOUND) + pkg_check_modules(SDL2 sdl2>=${SYSTEM_SDL_MIN_VER}) + if (SDL2_FOUND) + list(APPEND DEPENDENCIES_DEFINES HAVE_SDL2) + list(APPEND DEPENDENCIES_INCLUDE_DIRS ${SDL2_INCLUDE_DIRS}) + list(APPEND DEPENDENCIES_COMPILE_OPTIONS ${SDL2_CFLAGS_OTHER}) + list(APPEND DEPENDENCIES_LIBRARIES ${SDL2_LIBRARIES}) + list(APPEND DEPENDENCIES_LIBRARY_DIRS ${SDL2_LIBRARY_DIRS}) + list(APPEND DEPENDENCIES_LINK_OPTIONS ${SDL2_LDFLAGS_OTHER}) + list(APPEND DEPENDENCIES_LEGACY_LDFLAGS ${SDL2_LDFLAGS}) + endif() endif() + if (NOT SDL2_FOUND) + find_package(SDL2 ${SYSTEM_SDL_MIN_VER} REQUIRED) + list(APPEND DEPENDENCIES_DEFINES HAVE_SDL2) + list(APPEND DEPENDENCIES_INCLUDE_DIRS ${SDL2_INCLUDE_DIR}) + list(APPEND DEPENDENCIES_LIBRARIES ${SDL2_LIBRARY}) + endif() + message(STATUS "Using system-installed SDL2") + else() + if (ANDROID) + set(SDL_SHARED ON CACHE BOOL "Force no dynamically-linked SDL" FORCE) + set(SDL_STATIC OFF CACHE BOOL "Force statically-linked SDL" FORCE) + else() + set(SDL_SHARED OFF CACHE BOOL "Force no dynamically-linked SDL" FORCE) + set(SDL_STATIC ON CACHE BOOL "Force statically-linked SDL" FORCE) + endif() + # https://github.com/libsdl-org/SDL/issues/1481 + # On 2014-06-22 17:15:50 +0000, Sam Lantinga wrote: + # If you link SDL statically, you also need to define HAVE_LIBC so it builds with the C runtime that your application uses. + # This should probably go in a FAQ. + set(SDL_LIBC ON CACHE BOOL "Tell SDL that we want it to use our C runtime (required for proper static linking)" FORCE) + add_subdirectory(extern/SDL EXCLUDE_FROM_ALL) + list(APPEND DEPENDENCIES_DEFINES HAVE_SDL2) + list(APPEND DEPENDENCIES_INCLUDE_DIRS extern/SDL/include) + if (ANDROID) + list(APPEND DEPENDENCIES_LIBRARIES SDL2) + else() + list(APPEND DEPENDENCIES_LIBRARIES SDL2-static) + endif() + # Work around add_subdirectory'd SDL not propagating HAVE_LIBC to MSVC furnace build + if (MSVC) + list(APPEND DEPENDENCIES_COMPILE_OPTIONS "/DHAVE_LIBC") + endif() + message(STATUS "Using vendored SDL2") endif() - if (NOT SDL2_FOUND) - find_package(SDL2 ${SYSTEM_SDL_MIN_VER} REQUIRED) - list(APPEND DEPENDENCIES_INCLUDE_DIRS ${SDL2_INCLUDE_DIR}) - list(APPEND DEPENDENCIES_LIBRARIES ${SDL2_LIBRARY}) - endif() - message(STATUS "Using system-installed SDL2") else() - if (ANDROID) - set(SDL_SHARED ON CACHE BOOL "Force no dynamically-linked SDL" FORCE) - set(SDL_STATIC OFF CACHE BOOL "Force statically-linked SDL" FORCE) - else() - set(SDL_SHARED OFF CACHE BOOL "Force no dynamically-linked SDL" FORCE) - set(SDL_STATIC ON CACHE BOOL "Force statically-linked SDL" FORCE) + message(STATUS "Not using SDL2") + if (BUILD_GUI) + message(FATAL_ERROR "SDL2 is required in order to build with GUI! Disable BUILD_GUI otherwise.") endif() - # https://github.com/libsdl-org/SDL/issues/1481 - # On 2014-06-22 17:15:50 +0000, Sam Lantinga wrote: - # If you link SDL statically, you also need to define HAVE_LIBC so it builds with the C runtime that your application uses. - # This should probably go in a FAQ. - set(SDL_LIBC ON CACHE BOOL "Tell SDL that we want it to use our C runtime (required for proper static linking)" FORCE) - add_subdirectory(extern/SDL EXCLUDE_FROM_ALL) - list(APPEND DEPENDENCIES_INCLUDE_DIRS extern/SDL/include) - if (ANDROID) - list(APPEND DEPENDENCIES_LIBRARIES SDL2) - else() - list(APPEND DEPENDENCIES_LIBRARIES SDL2-static) - endif() - # Work around add_subdirectory'd SDL not propagating HAVE_LIBC to MSVC furnace build - if (MSVC) - list(APPEND DEPENDENCIES_COMPILE_OPTIONS "/DHAVE_LIBC") - endif() - message(STATUS "Using vendored SDL2") endif() set(AUDIO_SOURCES src/audio/abstract.cpp src/audio/midi.cpp -src/audio/sdl.cpp ) -if(WITH_JACK) +if (USE_SDL2) + list(APPEND AUDIO_SOURCES src/audio/sdl.cpp) +endif() + +if (WITH_JACK) find_package(PkgConfig REQUIRED) pkg_check_modules(JACK REQUIRED jack) list(APPEND AUDIO_SOURCES src/audio/jack.cpp) @@ -250,6 +275,7 @@ extern/adpcm/ymb_codec.c extern/adpcm/ymz_codec.c extern/Nuked-OPN2/ym3438.c +extern/Nuked-PSG/ympsg.c extern/opm/opm.c extern/Nuked-OPLL/opll.c extern/opl/opl3.c @@ -330,6 +356,9 @@ src/engine/platform/sound/ymz280b.cpp src/engine/platform/sound/rf5c68.cpp +src/engine/platform/sound/oki/okim6258.cpp +src/engine/platform/sound/oki/msm6295.cpp + src/engine/platform/oplAInterface.cpp src/engine/platform/ym2608Interface.cpp src/engine/platform/ym2610Interface.cpp @@ -380,6 +409,8 @@ src/engine/platform/fds.cpp src/engine/platform/tia.cpp src/engine/platform/saa.cpp src/engine/platform/amiga.cpp +src/engine/platform/msm6258.cpp +src/engine/platform/msm6295.cpp src/engine/platform/pcspkr.cpp src/engine/platform/segapcm.cpp src/engine/platform/qsound.cpp @@ -481,6 +512,13 @@ endif() set(USED_SOURCES ${ENGINE_SOURCES} ${AUDIO_SOURCES} src/main.cpp) +if (USE_BACKWARD) + list(APPEND USED_SOURCES src/backtrace.cpp) + if (WIN32 AND CMAKE_CXX_COMPILER_ID STREQUAL "GNU") + list(APPEND DEPENDENCIES_LIBRARIES dbghelp psapi) + endif() +endif() + if (BUILD_GUI) list(APPEND USED_SOURCES ${GUI_SOURCES}) list(APPEND DEPENDENCIES_INCLUDE_DIRS diff --git a/TODO.md b/TODO.md index 0ba67f47..b5d890ff 100644 --- a/TODO.md +++ b/TODO.md @@ -20,7 +20,6 @@ - volume commands should work on Game Boy - add another FM editor layout - try to find out why does VSlider not accept keyboard input -- finish lock layout - if macros have release, note off should release them - add ability to select a column by double clicking - add ability to move selection by dragging diff --git a/extern/Nuked-PSG/LICENSE b/extern/Nuked-PSG/LICENSE new file mode 100644 index 00000000..d159169d --- /dev/null +++ b/extern/Nuked-PSG/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/extern/Nuked-PSG/README.md b/extern/Nuked-PSG/README.md new file mode 100644 index 00000000..af533a79 --- /dev/null +++ b/extern/Nuked-PSG/README.md @@ -0,0 +1,6 @@ +# Nuked-PSG +Yamaha YM7101 PSG emulator + +# modification disclaimer + +this is a modified version of Nuked-PSG which adds support for changing the noise LFSR size and taps. diff --git a/extern/Nuked-PSG/ympsg.c b/extern/Nuked-PSG/ympsg.c new file mode 100644 index 00000000..f6b8247b --- /dev/null +++ b/extern/Nuked-PSG/ympsg.c @@ -0,0 +1,405 @@ +// Copyright (C) 2021 Nuke.YKT +// License: GPLv2+ +// Version 1.0.1 +#include +#include "ympsg.h" + +const float ympsg_vol[17] = { + 1.0, 0.772, 0.622, 0.485, 0.382, 0.29, 0.229, 0.174, 0.132, 0.096, 0.072, 0.051, 0.034, 0.019, 0.009, 0.0, -1.059 +}; + +static void YMPSG_WriteLatch(ympsg_t *chip) +{ + uint8_t data = chip->data; + if (chip->data_mask) + { + data = 0; + } + if (data & 128) + { + chip->latch = (data >> 4) & 7; + } +} + +static void YMPSG_UpdateRegisters(ympsg_t* chip) +{ + uint8_t data = chip->data; + if (chip->data_mask) + { + data = 0; + } + if (chip->reg_reset || (chip->write_flag_l && chip->latch == 1)) + { + chip->volume[0] = data & 15; + if (chip->data_mask) + { + chip->volume[0] = 15; + } + } + if (chip->reg_reset || (chip->write_flag_l && chip->latch == 3)) + { + chip->volume[1] = data & 15; + if (chip->data_mask) + { + chip->volume[1] = 15; + } + } + if (chip->reg_reset || (chip->write_flag_l && chip->latch == 4)) + { + if ((data & 128) || chip->reg_reset) + { + chip->freq[2] &= 1008; + chip->freq[2] |= data & 15; + } + if (!(data & 128)) + { + chip->freq[2] &= 15; + chip->freq[2] |= (data << 4) & 1008; + } + } + if (chip->reg_reset || (chip->write_flag_l && chip->latch == 2)) + { + if ((data & 128) || chip->reg_reset) + { + chip->freq[1] &= 1008; + chip->freq[1] |= data & 15; + } + if (!(data & 128)) + { + chip->freq[1] &= 15; + chip->freq[1] |= (data << 4) & 1008; + } + } + if (chip->reg_reset || (chip->write_flag_l && chip->latch == 5)) + { + chip->volume[2] = data & 15; + if (chip->data_mask) + { + chip->volume[2] = 15; + } + } + if (chip->reg_reset || (chip->write_flag_l && chip->latch == 0)) + { + if ((data & 128) || chip->reg_reset) + { + chip->freq[0] &= 1008; + chip->freq[0] |= data & 15; + } + if (!(data & 128)) + { + chip->freq[0] &= 15; + chip->freq[0] |= (data << 4) & 1008; + } + } + if (chip->reg_reset || (chip->write_flag_l && chip->latch == 7)) + { + chip->volume[3] = data & 15; + if (chip->data_mask) + { + chip->volume[3] = 15; + } + } + if (chip->reg_reset || (chip->write_flag_l && chip->latch == 6)) + { + chip->noise_data = data & 7; + chip->noise_trig = 1; + } +} + +static void YMPSG_ClockInternal1(ympsg_t *chip) +{ + uint16_t freq = 0; + uint8_t chan_sel = chip->chan_sel; + uint8_t noise_of, noise_bit1, noise_bit2, noise_next; + if ((chip->noise_data & 3) == 3) + { + noise_of = (chip->sign >> 1) & 1; + } + else + { + noise_of = chip->sign & 1; + } + if (chip->noise_trig_l || (chip->ic_latch2 & 1)) + { + chip->noise = 0; + } + else if (noise_of && !chip->noise_of) + { + noise_bit1 = (chip->noise >> chip->noise_tap2) & 1; + noise_bit2 = (chip->noise >> 12) & 1; + noise_bit1 ^= noise_bit2; + noise_next = ((noise_bit1 && ((chip->noise_data >> 2) & 1)) || ((chip->noise & chip->noise_size) == 0)); + chip->noise <<= 1; + chip->noise |= noise_next; + } + chip->noise_of = noise_of; + if (chip->ic_latch2 & 2) + { + chan_sel = 0; + } + if (chip->chan_sel & 1) + { + freq |= chip->freq[0]; + } + if (chip->chan_sel & 2) + { + freq |= chip->freq[1]; + } + if (chip->chan_sel & 4) + { + freq |= chip->freq[2]; + } + if (chip->chan_sel & 8) + { + if ((chip->noise_data & 3) == 0) + { + freq |= 16; + } + if ((chip->noise_data & 3) == 1) + { + freq |= 32; + } + if ((chip->noise_data & 3) == 2) + { + freq |= 64; + } + } + if (chip->chan_sel & 1) + { + chip->sign ^= chip->counter_of & 15; + } + if (chip->ic_latch2 & 2) + { + chip->sign = 0; + } + chip->counter_of <<= 1; + if (chip->counter[chip->rot] >= freq) + { + chip->counter_of |= 1; + chip->counter[chip->rot] = 0; + } + if (chip->ic_latch2 & 2) + { + chip->counter[chip->rot] = 0; + } + chip->counter[chip->rot]++; + chip->counter[chip->rot] &= 1023; + if ((chip->ic_latch2 & 1) || (chip->chan_sel & 7) != 0) + { + chip->chan_sel <<= 1; + } + else + { + chip->chan_sel <<= 1; + chip->chan_sel |= 1; + } + chip->ic_latch2 <<= 1; + chip->ic_latch2 |= chip->ic & 1; + chip->noise_trig_l = chip->noise_trig; +} + +static void YMPSG_ClockInternal2(ympsg_t *chip) +{ + chip->data_mask = (chip->ic_latch2 >> 1) & 1; + chip->reg_reset = (chip->ic_latch2 >> 0) & 1; + if (chip->noise_trig_l) + { + chip->noise_trig = 0; + } + YMPSG_UpdateRegisters(chip); + + chip->rot = (chip->rot + 1) & 3; + chip->sign_l = chip->sign; + chip->noise_sign_l = (chip->noise >> 14) & 1; +} + +static void YMPSG_UpdateSample(ympsg_t *chip) +{ + uint32_t i; + uint8_t sign = chip->sign & 14; + sign |= chip->noise_sign_l; + if (chip->test & 1) + { + sign |= 15; + } + for (i = 0; i < 4; i++) + { + if ((sign >> (3 - i)) & 1) + { + chip->volume_out[i] = chip->volume[i]; + } + else + { + chip->volume_out[i] = 15; + } + } +} + +void YMPSG_Write(ympsg_t *chip, uint8_t data) +{ + chip->data = data; + chip->write_flag = 1; +} + +uint16_t YMPSG_Read(ympsg_t *chip) +{ + uint16_t data = 0; + uint32_t i; + YMPSG_UpdateSample(chip); + for (i = 0; i < 4; i++) + { + data |= chip->volume_out[i] << ((3 - i) * 4); + } + return data; +} + +void YMPSG_Init(ympsg_t *chip, uint8_t real_sn) +{ + uint32_t i; + memset(chip, 0, sizeof(ympsg_t)); + YMPSG_SetIC(chip, 1); + chip->noise_tap2 = real_sn ? 13 : 15; + chip->noise_size = real_sn ? 16383 : 32767; + for (i = 0; i < 16; i++) + { + YMPSG_Clock(chip); + } + YMPSG_SetIC(chip, 0); +} + +void YMPSG_SetIC(ympsg_t *chip, uint32_t ic) +{ + chip->ic = (uint8_t)ic; +} + +void YMPSG_Clock(ympsg_t *chip) +{ + uint8_t prescaler2_latch; + prescaler2_latch = chip->prescaler_2; + chip->prescaler_2 += chip->prescaler_1; + chip->prescaler_2 &= 1; + chip->prescaler_1 ^= 1; + if ((chip->ic_latch1 & 3) == 2) + { + chip->prescaler_1 = 0; + chip->prescaler_2 = 0; + } + chip->ic_latch1 <<= 1; + chip->ic_latch1 |= chip->ic & 1; + YMPSG_UpdateRegisters(chip); + chip->write_flag_l = 0; + if (chip->write_flag) + { + YMPSG_WriteLatch(chip); + chip->write_flag = 0; + chip->write_flag_l = 1; + } + if (chip->prescaler_1) + { + if (!prescaler2_latch) + { + YMPSG_ClockInternal1(chip); + } + else + { + YMPSG_ClockInternal2(chip); + } + } +} + +float YMPSG_GetOutput(ympsg_t *chip) +{ + float sample = 0.f; + uint32_t i; + YMPSG_UpdateSample(chip); + if (chip->test & 1) + { + sample += ympsg_vol[chip->volume_out[chip->test >> 1]]; + sample += ympsg_vol[16] * 3.f; + } + else if (!chip->mute) + { + sample += ympsg_vol[chip->volume_out[0]]; + sample += ympsg_vol[chip->volume_out[1]]; + sample += ympsg_vol[chip->volume_out[2]]; + sample += ympsg_vol[chip->volume_out[3]]; + } + else + { + for (i = 0; i < 4; i++) + { + if (!((chip->mute>>i) & 1)) + sample += ympsg_vol[chip->volume_out[i]]; + } + } + return sample; +} + +void YMPSG_Test(ympsg_t *chip, uint16_t test) +{ + chip->test = (test >> 9) & 7; +} + + +void YMPSG_Generate(ympsg_t *chip, int32_t *buf) +{ + uint32_t i; + float out; + + for (i = 0; i < 16; i++) + { + YMPSG_Clock(chip); + + while (chip->writebuf[chip->writebuf_cur].time <= chip->writebuf_samplecnt) + { + if (!chip->writebuf[chip->writebuf_cur].stat) + { + break; + } + chip->writebuf[chip->writebuf_cur].stat = 0; + YMPSG_Write(chip, chip->writebuf[chip->writebuf_cur].data); + chip->writebuf_cur = (chip->writebuf_cur + 1) % YMPSG_WRITEBUF_SIZE; + } + chip->writebuf_samplecnt++; + } + out = YMPSG_GetOutput(chip); + *buf = (int32_t)(out * 8192.f); +} + +void YMPSG_WriteBuffered(ympsg_t *chip, uint8_t data) +{ + uint64_t time1, time2; + uint64_t skip; + + if (chip->writebuf[chip->writebuf_last].stat) + { + YMPSG_Write(chip, chip->writebuf[chip->writebuf_last].data); + + chip->writebuf_cur = (chip->writebuf_last + 1) % YMPSG_WRITEBUF_SIZE; + skip = chip->writebuf[chip->writebuf_last].time - chip->writebuf_samplecnt; + chip->writebuf_samplecnt = chip->writebuf[chip->writebuf_last].time; + while (skip--) + { + YMPSG_Clock(chip); + } + } + + chip->writebuf[chip->writebuf_last].stat = 1; + chip->writebuf[chip->writebuf_last].data = data; + time1 = chip->writebuf_lasttime + YMPSG_WRITEBUF_DELAY; + time2 = chip->writebuf_samplecnt; + + if (time1 < time2) + { + time1 = time2; + } + + chip->writebuf[chip->writebuf_last].time = time1; + chip->writebuf_lasttime = time1; + chip->writebuf_last = (chip->writebuf_last + 1) % YMPSG_WRITEBUF_SIZE; +} + +void YMPSG_SetMute(ympsg_t *chip, uint8_t mute) +{ + chip->mute = mute; +} diff --git a/extern/Nuked-PSG/ympsg.h b/extern/Nuked-PSG/ympsg.h new file mode 100644 index 00000000..06310580 --- /dev/null +++ b/extern/Nuked-PSG/ympsg.h @@ -0,0 +1,79 @@ +// Copyright (C) 2021 Nuke.YKT +// License: GPLv2+ +// Version 1.0.1 +#ifndef _YMPSG_H_ +#define _YMPSG_H_ +#include + +#define YMPSG_WRITEBUF_SIZE 2048 +#define YMPSG_WRITEBUF_DELAY 8 + +typedef struct _ympsg_writebuf { + uint64_t time; + uint8_t stat; + uint8_t data; +} ympsg_writebuf; + +typedef struct { + // IO + uint8_t data; + uint8_t latch; + uint8_t write_flag; + uint8_t write_flag_l; + + uint8_t prescaler_1; + uint8_t prescaler_2; + uint8_t prescaler_2_l; + uint8_t reset_latch; + uint8_t ic; + uint8_t ic_latch1; + uint8_t ic_latch2; + uint8_t data_mask; + uint8_t reg_reset; + uint8_t volume[4]; + uint16_t freq[3]; + uint8_t noise_data; + uint8_t noise_of; + uint8_t noise_trig; + uint8_t noise_trig_l; + uint8_t rot; + + uint8_t chan_sel; + + uint16_t counter[4]; + uint8_t counter_of; + uint8_t sign; + uint8_t sign_l; + uint8_t noise_sign_l; + uint16_t noise; + uint8_t noise_tap2; + uint16_t noise_size; + uint8_t test; + uint8_t volume_out[4]; + + // + uint64_t writebuf_samplecnt; + uint32_t writebuf_cur; + uint32_t writebuf_last; + uint64_t writebuf_lasttime; + ympsg_writebuf writebuf[YMPSG_WRITEBUF_SIZE]; + + uint8_t mute; +} ympsg_t; + + +void YMPSG_Write(ympsg_t *chip, uint8_t data); +uint16_t YMPSG_Read(ympsg_t *chip); +void YMPSG_Init(ympsg_t *chip, uint8_t real_sn); +void YMPSG_SetIC(ympsg_t *chip, uint32_t ic); +void YMPSG_Clock(ympsg_t *chip); +float YMPSG_GetOutput(ympsg_t *chip); +void YMPSG_Test(ympsg_t *chip, uint16_t test); + + +void YMPSG_Generate(ympsg_t *chip, int32_t *buf); +void YMPSG_WriteBuffered(ympsg_t *chip, uint8_t data); + +void YMPSG_SetMute(ympsg_t *chip, uint8_t mute); + +#endif diff --git a/extern/backward/BackwardConfig.cmake b/extern/backward/BackwardConfig.cmake new file mode 100644 index 00000000..4e0eb90e --- /dev/null +++ b/extern/backward/BackwardConfig.cmake @@ -0,0 +1,265 @@ +# +# BackwardMacros.cmake +# Copyright 2013 Google Inc. All Rights Reserved. +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +# SOFTWARE. + +############################################################################### +# OPTIONS +############################################################################### + +set(STACK_WALKING_UNWIND TRUE CACHE BOOL + "Use compiler's unwind API") +set(STACK_WALKING_BACKTRACE FALSE CACHE BOOL + "Use backtrace from (e)glibc for stack walking") +set(STACK_WALKING_LIBUNWIND FALSE CACHE BOOL + "Use libunwind for stack walking") + +set(STACK_DETAILS_AUTO_DETECT TRUE CACHE BOOL + "Auto detect backward's stack details dependencies") + +set(STACK_DETAILS_BACKTRACE_SYMBOL FALSE CACHE BOOL + "Use backtrace from (e)glibc for symbols resolution") +set(STACK_DETAILS_DW FALSE CACHE BOOL + "Use libdw to read debug info") +set(STACK_DETAILS_BFD FALSE CACHE BOOL + "Use libbfd to read debug info") +set(STACK_DETAILS_DWARF FALSE CACHE BOOL + "Use libdwarf/libelf to read debug info") + +if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR AND NOT DEFINED BACKWARD_TESTS) + # If this is a top level CMake project, we most lixely want the tests + set(BACKWARD_TESTS ON CACHE BOOL "Enable tests") +else() + set(BACKWARD_TESTS OFF CACHE BOOL "Enable tests") +endif() +############################################################################### +# CONFIGS +############################################################################### +include(FindPackageHandleStandardArgs) + +if (STACK_WALKING_LIBUNWIND) + # libunwind works on the macOS without having to add special include + # paths or libraries + if (NOT APPLE) + find_path(LIBUNWIND_INCLUDE_DIR NAMES "libunwind.h") + find_library(LIBUNWIND_LIBRARY unwind) + + if (LIBUNWIND_LIBRARY) + include(CheckSymbolExists) + check_symbol_exists(UNW_INIT_SIGNAL_FRAME libunwind.h HAVE_UNW_INIT_SIGNAL_FRAME) + if (NOT HAVE_UNW_INIT_SIGNAL_FRAME) + message(STATUS "libunwind does not support unwinding from signal handler frames") + endif() + endif() + + set(LIBUNWIND_INCLUDE_DIRS ${LIBUNWIND_INCLUDE_DIR}) + set(LIBDWARF_LIBRARIES ${LIBUNWIND_LIBRARY}) + find_package_handle_standard_args(libunwind DEFAULT_MSG + LIBUNWIND_LIBRARY LIBUNWIND_INCLUDE_DIR) + mark_as_advanced(LIBUNWIND_INCLUDE_DIR LIBUNWIND_LIBRARY) + list(APPEND _BACKWARD_LIBRARIES ${LIBUNWIND_LIBRARY}) + endif() + + # Disable other unwinders if libunwind is found + set(STACK_WALKING_UNWIND FALSE) + set(STACK_WALKING_BACKTRACE FALSE) +endif() + +if (${STACK_DETAILS_AUTO_DETECT}) + if(NOT CMAKE_VERSION VERSION_LESS 3.17) + set(_name_mismatched_arg NAME_MISMATCHED) + endif() + # find libdw + find_path(LIBDW_INCLUDE_DIR NAMES "elfutils/libdw.h" "elfutils/libdwfl.h") + find_library(LIBDW_LIBRARY dw) + # in case it's statically linked, look for all the possible dependencies + find_library(LIBELF_LIBRARY elf) + find_library(LIBPTHREAD_LIBRARY pthread) + find_library(LIBZ_LIBRARY z) + find_library(LIBBZ2_LIBRARY bz2) + find_library(LIBLZMA_LIBRARY lzma) + find_library(LIBZSTD_LIBRARY zstd) + set(LIBDW_INCLUDE_DIRS ${LIBDW_INCLUDE_DIR} ) + set(LIBDW_LIBRARIES ${LIBDW_LIBRARY} + $<$:${LIBELF_LIBRARY}> + $<$:${LIBPTHREAD_LIBRARY}> + $<$:${LIBZ_LIBRARY}> + $<$:${LIBBZ2_LIBRARY}> + $<$:${LIBLZMA_LIBRARY}> + $<$:${LIBZSTD_LIBRARY}>) + find_package_handle_standard_args(libdw ${_name_mismatched_arg} + REQUIRED_VARS LIBDW_LIBRARY LIBDW_INCLUDE_DIR) + mark_as_advanced(LIBDW_INCLUDE_DIR LIBDW_LIBRARY) + + # find libbfd + find_path(LIBBFD_INCLUDE_DIR NAMES "bfd.h") + find_path(LIBDL_INCLUDE_DIR NAMES "dlfcn.h") + find_library(LIBBFD_LIBRARY bfd) + find_library(LIBDL_LIBRARY dl) + set(LIBBFD_INCLUDE_DIRS ${LIBBFD_INCLUDE_DIR} ${LIBDL_INCLUDE_DIR}) + set(LIBBFD_LIBRARIES ${LIBBFD_LIBRARY} ${LIBDL_LIBRARY}) + find_package_handle_standard_args(libbfd ${_name_mismatched_arg} + REQUIRED_VARS LIBBFD_LIBRARY LIBBFD_INCLUDE_DIR + LIBDL_LIBRARY LIBDL_INCLUDE_DIR) + mark_as_advanced(LIBBFD_INCLUDE_DIR LIBBFD_LIBRARY + LIBDL_INCLUDE_DIR LIBDL_LIBRARY) + + # find libdwarf + find_path(LIBDWARF_INCLUDE_DIR NAMES "libdwarf.h" PATH_SUFFIXES libdwarf) + find_path(LIBELF_INCLUDE_DIR NAMES "libelf.h") + find_path(LIBDL_INCLUDE_DIR NAMES "dlfcn.h") + find_library(LIBDWARF_LIBRARY dwarf) + find_library(LIBELF_LIBRARY elf) + find_library(LIBDL_LIBRARY dl) + set(LIBDWARF_INCLUDE_DIRS ${LIBDWARF_INCLUDE_DIR} ${LIBELF_INCLUDE_DIR} ${LIBDL_INCLUDE_DIR}) + set(LIBDWARF_LIBRARIES ${LIBDWARF_LIBRARY} ${LIBELF_LIBRARY} ${LIBDL_LIBRARY}) + find_package_handle_standard_args(libdwarf ${_name_mismatched_arg} + REQUIRED_VARS LIBDWARF_LIBRARY LIBDWARF_INCLUDE_DIR + LIBELF_LIBRARY LIBELF_INCLUDE_DIR + LIBDL_LIBRARY LIBDL_INCLUDE_DIR) + mark_as_advanced(LIBDWARF_INCLUDE_DIR LIBDWARF_LIBRARY + LIBELF_INCLUDE_DIR LIBELF_LIBRARY + LIBDL_INCLUDE_DIR LIBDL_LIBRARY) + + if (LIBDW_FOUND) + LIST(APPEND _BACKWARD_INCLUDE_DIRS ${LIBDW_INCLUDE_DIRS}) + LIST(APPEND _BACKWARD_LIBRARIES ${LIBDW_LIBRARIES}) + set(STACK_DETAILS_DW TRUE) + set(STACK_DETAILS_BFD FALSE) + set(STACK_DETAILS_DWARF FALSE) + set(STACK_DETAILS_BACKTRACE_SYMBOL FALSE) + elseif(LIBBFD_FOUND) + LIST(APPEND _BACKWARD_INCLUDE_DIRS ${LIBBFD_INCLUDE_DIRS}) + LIST(APPEND _BACKWARD_LIBRARIES ${LIBBFD_LIBRARIES}) + + # If we attempt to link against static bfd, make sure to link its dependencies, too + get_filename_component(bfd_lib_ext "${LIBBFD_LIBRARY}" EXT) + if (bfd_lib_ext STREQUAL "${CMAKE_STATIC_LIBRARY_SUFFIX}") + list(APPEND _BACKWARD_LIBRARIES iberty z) + endif() + + set(STACK_DETAILS_DW FALSE) + set(STACK_DETAILS_BFD TRUE) + set(STACK_DETAILS_DWARF FALSE) + set(STACK_DETAILS_BACKTRACE_SYMBOL FALSE) + elseif(LIBDWARF_FOUND) + LIST(APPEND _BACKWARD_INCLUDE_DIRS ${LIBDWARF_INCLUDE_DIRS}) + LIST(APPEND _BACKWARD_LIBRARIES ${LIBDWARF_LIBRARIES}) + + set(STACK_DETAILS_DW FALSE) + set(STACK_DETAILS_BFD FALSE) + set(STACK_DETAILS_DWARF TRUE) + set(STACK_DETAILS_BACKTRACE_SYMBOL FALSE) + else() + set(STACK_DETAILS_DW FALSE) + set(STACK_DETAILS_BFD FALSE) + set(STACK_DETAILS_DWARF FALSE) + set(STACK_DETAILS_BACKTRACE_SYMBOL TRUE) + endif() +else() + if (STACK_DETAILS_DW) + LIST(APPEND _BACKWARD_LIBRARIES dw) + endif() + + if (STACK_DETAILS_BFD) + LIST(APPEND _BACKWARD_LIBRARIES bfd dl) + endif() + + if (STACK_DETAILS_DWARF) + LIST(APPEND _BACKWARD_LIBRARIES dwarf elf) + endif() +endif() + +macro(map_definitions var_prefix define_prefix) + foreach(def ${ARGN}) + if (${${var_prefix}${def}}) + LIST(APPEND _BACKWARD_DEFINITIONS "${define_prefix}${def}=1") + else() + LIST(APPEND _BACKWARD_DEFINITIONS "${define_prefix}${def}=0") + endif() + endforeach() +endmacro() + +if (NOT _BACKWARD_DEFINITIONS) + map_definitions("STACK_WALKING_" "BACKWARD_HAS_" UNWIND LIBUNWIND BACKTRACE) + map_definitions("STACK_DETAILS_" "BACKWARD_HAS_" BACKTRACE_SYMBOL DW BFD DWARF) +endif() + +if(WIN32) + list(APPEND _BACKWARD_LIBRARIES dbghelp psapi) + if(MINGW) + set(MINGW_MSVCR_LIBRARY "msvcr90$<$:d>" CACHE STRING "Mingw MSVC runtime import library") + list(APPEND _BACKWARD_LIBRARIES ${MINGW_MSVCR_LIBRARY}) + endif() +endif() + +set(BACKWARD_INCLUDE_DIR "${CMAKE_CURRENT_LIST_DIR}") + +set(BACKWARD_HAS_EXTERNAL_LIBRARIES FALSE) +set(FIND_PACKAGE_REQUIRED_VARS BACKWARD_INCLUDE_DIR) +if(DEFINED _BACKWARD_LIBRARIES) + set(BACKWARD_HAS_EXTERNAL_LIBRARIES TRUE) + list(APPEND FIND_PACKAGE_REQUIRED_VARS _BACKWARD_LIBRARIES) +endif() + +include(FindPackageHandleStandardArgs) +find_package_handle_standard_args(Backward + REQUIRED_VARS ${FIND_PACKAGE_REQUIRED_VARS} +) +list(APPEND _BACKWARD_INCLUDE_DIRS ${BACKWARD_INCLUDE_DIR}) + +# add_backward, optional bool argument; if passed and true, backward will be included as a system header +macro(add_backward target) + if ("${ARGN}") + target_include_directories(${target} SYSTEM PRIVATE ${BACKWARD_INCLUDE_DIRS}) + else() + target_include_directories(${target} PRIVATE ${BACKWARD_INCLUDE_DIRS}) + endif() + set_property(TARGET ${target} APPEND PROPERTY COMPILE_DEFINITIONS ${BACKWARD_DEFINITIONS}) + set_property(TARGET ${target} APPEND PROPERTY LINK_LIBRARIES ${BACKWARD_LIBRARIES}) +endmacro() + +set(BACKWARD_INCLUDE_DIRS ${_BACKWARD_INCLUDE_DIRS} CACHE INTERNAL "_BACKWARD_INCLUDE_DIRS") +set(BACKWARD_DEFINITIONS ${_BACKWARD_DEFINITIONS} CACHE INTERNAL "BACKWARD_DEFINITIONS") +set(BACKWARD_LIBRARIES ${_BACKWARD_LIBRARIES} CACHE INTERNAL "BACKWARD_LIBRARIES") +mark_as_advanced(BACKWARD_INCLUDE_DIRS BACKWARD_DEFINITIONS BACKWARD_LIBRARIES) + +# Expand each definition in BACKWARD_DEFINITIONS to its own cmake var and export +# to outer scope +foreach(var ${BACKWARD_DEFINITIONS}) + string(REPLACE "=" ";" var_as_list ${var}) + list(GET var_as_list 0 var_name) + list(GET var_as_list 1 var_value) + set(${var_name} ${var_value}) + mark_as_advanced(${var_name}) +endforeach() + +if (NOT TARGET Backward::Backward) + add_library(Backward::Backward INTERFACE IMPORTED) + set_target_properties(Backward::Backward PROPERTIES + INTERFACE_INCLUDE_DIRECTORIES "${BACKWARD_INCLUDE_DIRS}" + INTERFACE_COMPILE_DEFINITIONS "${BACKWARD_DEFINITIONS}" + ) + if(BACKWARD_HAS_EXTERNAL_LIBRARIES) + set_target_properties(Backward::Backward PROPERTIES + INTERFACE_LINK_LIBRARIES "${BACKWARD_LIBRARIES}" + ) + endif() +endif() diff --git a/extern/backward/CMakeLists.txt b/extern/backward/CMakeLists.txt new file mode 100644 index 00000000..97327ccd --- /dev/null +++ b/extern/backward/CMakeLists.txt @@ -0,0 +1,139 @@ +# +# CMakeLists.txt +# Copyright 2013 Google Inc. All Rights Reserved. +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +# SOFTWARE. + +cmake_minimum_required(VERSION 3.0) +project(backward CXX) + +# Introduce variables: +# * CMAKE_INSTALL_LIBDIR +# * CMAKE_INSTALL_BINDIR +# * CMAKE_INSTALL_INCLUDEDIR +include(GNUInstallDirs) + +include(BackwardConfig.cmake) + +# check if compiler is nvcc or nvcc_wrapper +set(COMPILER_IS_NVCC false) +get_filename_component(COMPILER_NAME ${CMAKE_CXX_COMPILER} NAME) +if (COMPILER_NAME MATCHES "^nvcc") + set(COMPILER_IS_NVCC true) +endif() + +if (DEFINED ENV{OMPI_CXX} OR DEFINED ENV{MPICH_CXX}) + if ( ($ENV{OMPI_CXX} MATCHES "nvcc") OR ($ENV{MPICH_CXX} MATCHES "nvcc") ) + set(COMPILER_IS_NVCC true) + endif() +endif() + +# set CXX standard +set(CMAKE_CXX_STANDARD_REQUIRED True) +set(CMAKE_CXX_STANDARD 11) +if (${COMPILER_IS_NVCC}) + # GNU CXX extensions are not supported by nvcc + set(CMAKE_CXX_EXTENSIONS OFF) +endif() + +############################################################################### +# COMPILER FLAGS +############################################################################### + +if (CMAKE_CXX_COMPILER_ID STREQUAL "Clang" OR CMAKE_COMPILER_IS_GNUCXX) + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra") + if (NOT ${COMPILER_IS_NVCC}) + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -pedantic-errors") + endif() + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g") +endif() + +############################################################################### +# BACKWARD OBJECT +############################################################################### + +add_library(backward_object OBJECT backward.cpp) +target_compile_definitions(backward_object PRIVATE ${BACKWARD_DEFINITIONS}) +target_include_directories(backward_object PRIVATE ${BACKWARD_INCLUDE_DIRS}) +set(BACKWARD_ENABLE $ CACHE STRING + "Link with this object to setup backward automatically") + + +############################################################################### +# BACKWARD LIBRARY (Includes backward.cpp) +############################################################################### +option(BACKWARD_SHARED "Build dynamic backward-cpp shared lib" OFF) + +if(BACKWARD_SHARED) + set(libtype SHARED) +endif() +add_library(backward ${libtype} backward.cpp) +target_compile_definitions(backward PUBLIC ${BACKWARD_DEFINITIONS}) +target_include_directories(backward PUBLIC ${BACKWARD_INCLUDE_DIRS}) + +############################################################################### +# TESTS +############################################################################### + +if(BACKWARD_TESTS) + enable_testing() + + add_library(test_main OBJECT test/_test_main.cpp) + + macro(backward_add_test src) + get_filename_component(name ${src} NAME_WE) + set(test_name "test_${name}") + + add_executable(${test_name} ${src} ${ARGN} $) + + target_link_libraries(${test_name} PRIVATE Backward::Backward) + + add_test(NAME ${name} COMMAND ${test_name}) + endmacro() + + # Tests without backward.cpp + set(TESTS + test + stacktrace + rectrace + select_signals + ) + + foreach(test ${TESTS}) + backward_add_test(test/${test}.cpp) + endforeach() + + # Tests with backward.cpp + set(TESTS + suicide + ) + + foreach(test ${TESTS}) + backward_add_test(test/${test}.cpp ${BACKWARD_ENABLE}) + endforeach() +endif() + +install( + FILES "backward.hpp" + DESTINATION ${CMAKE_INSTALL_INCLUDEDIR} +) +install( + FILES "BackwardConfig.cmake" + DESTINATION ${CMAKE_INSTALL_LIBDIR}/backward +) diff --git a/extern/backward/LICENSE.txt b/extern/backward/LICENSE.txt new file mode 100644 index 00000000..269e8abb --- /dev/null +++ b/extern/backward/LICENSE.txt @@ -0,0 +1,21 @@ +Copyright 2013 Google Inc. All Rights Reserved. + +The MIT License (MIT) + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/extern/backward/README.md b/extern/backward/README.md new file mode 100644 index 00000000..031716f3 --- /dev/null +++ b/extern/backward/README.md @@ -0,0 +1,442 @@ +Backward-cpp [![badge](https://img.shields.io/badge/conan.io-backward%2F1.3.0-green.svg?logo=data:image/png;base64%2CiVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAMAAAAolt3jAAAA1VBMVEUAAABhlctjlstkl8tlmMtlmMxlmcxmmcxnmsxpnMxpnM1qnc1sn85voM91oM11oc1xotB2oc56pNF6pNJ2ptJ8ptJ8ptN9ptN8p9N5qNJ9p9N9p9R8qtOBqdSAqtOAqtR%2BrNSCrNJ/rdWDrNWCsNWCsNaJs9eLs9iRvNuVvdyVv9yXwd2Zwt6axN6dxt%2Bfx%2BChyeGiyuGjyuCjyuGly%2BGlzOKmzOGozuKoz%2BKqz%2BOq0OOv1OWw1OWw1eWx1eWy1uay1%2Baz1%2Baz1%2Bez2Oe02Oe12ee22ujUGwH3AAAAAXRSTlMAQObYZgAAAAFiS0dEAIgFHUgAAAAJcEhZcwAACxMAAAsTAQCanBgAAAAHdElNRQfgBQkREyOxFIh/AAAAiklEQVQI12NgAAMbOwY4sLZ2NtQ1coVKWNvoc/Eq8XDr2wB5Ig62ekza9vaOqpK2TpoMzOxaFtwqZua2Bm4makIM7OzMAjoaCqYuxooSUqJALjs7o4yVpbowvzSUy87KqSwmxQfnsrPISyFzWeWAXCkpMaBVIC4bmCsOdgiUKwh3JojLgAQ4ZCE0AMm2D29tZwe6AAAAAElFTkSuQmCC)](http://www.conan.io/source/backward/1.3.0/Manu343726/testing) +============ + +Backward is a beautiful stack trace pretty printer for C++. + +If you are bored to see this: + +![default trace](doc/rude.png) + +Backward will spice it up for you: + +![pretty stackstrace](doc/pretty.png) + +There is not much to say. Of course it will be able to display the code +snippets only if the source files are accessible (else see trace #4 in the +example). + +All "Source" lines and code snippet prefixed by a pipe "|" are frames inline +the next frame. +You can see that for the trace #1 in the example, the function +`you_shall_not_pass()` was inlined in the function `...read2::do_test()` by the +compiler. + +## Installation + +#### Install backward.hpp + +Backward is a header only library. So installing Backward is easy, simply drop +a copy of `backward.hpp` along with your other source files in your C++ project. +You can also use a git submodule or really any other way that best fits your +environment, as long as you can include `backward.hpp`. + +#### Install backward.cpp + +If you want Backward to automatically print a stack trace on most common fatal +errors (segfault, abort, un-handled exception...), simply add a copy of +`backward.cpp` to your project, and don't forget to tell your build system. + +The code in `backward.cpp` is trivial anyway, you can simply copy what it's +doing at your convenience. + +Note for [folly](https://github.com/facebook/folly) library users: must define `backward::SignalHandling sh;` after `folly::init(&argc, &argv);`. + +## Configuration & Dependencies + +### Integration with CMake + +If you are using CMake and want to use its configuration abilities to save +you the trouble, you can easily integrate Backward, depending on how you obtained +the library. + +#### As a subdirectory: + +In this case you have a subdirectory containing the whole repository of Backward +(eg.: using git-submodules), in this case you can do: + +``` +add_subdirectory(/path/to/backward-cpp) + +# This will add backward.cpp to your target +add_executable(mytarget mysource.cpp ${BACKWARD_ENABLE}) + +# This will add libraries, definitions and include directories needed by backward +# by setting each property on the target. +add_backward(mytarget) +``` + +#### Modifying CMAKE_MODULE_PATH + +In this case you can have Backward installed as a subdirectory: + +``` +list(APPEND CMAKE_MODULE_PATH /path/to/backward-cpp) +find_package(Backward) + +# This will add libraries, definitions and include directories needed by backward +# through an IMPORTED target. +target_link_libraries(mytarget PUBLIC Backward::Backward) +``` + +Notice that this is equivalent to using the the approach that uses `add_subdirectory()`, +however it uses cmake's [imported target](https://cmake.org/Wiki/CMake/Tutorials/Exporting_and_Importing_Targets) mechanism. + +#### Installation through a regular package manager + +In this case you have obtained Backward through a package manager. + +Packages currently available: +- [conda-forge](https://anaconda.org/conda-forge/backward-cpp) + +``` +find_package(Backward) + +# This will add libraries, definitions and include directories needed by backward +# through an IMPORTED target. +target_link_libraries(mytarget PUBLIC Backward::Backward) +``` +### Libraries to unwind the stack + +On Linux and macOS, backtrace can back-trace or "walk" the stack using the +following libraries: + +#### unwind + +Unwind comes from libgcc, but there is an equivalent inside clang itself. With +unwind, the stacktrace is as accurate as it can possibly be, since this is +used by the C++ runtine in gcc/clang for stack unwinding on exception. + +Normally libgcc is already linked to your program by default. + +#### libunwind from the [libunwind project](https://github.com/libunwind/libunwind) + + apt-get install binutils-dev (or equivalent) + +Libunwind provides, in some cases, a more accurate stacktrace as it knows +to decode signal handler frames and lets us edit the context registers when +unwinding, allowing stack traces over bad function references. + +For best results make sure you are using libunwind 1.3 or later, which added +`unw_init_local2` and support for handling signal frames. + +CMake will warn you when configuring if your libunwind version doesn't support +signal frames. + +On macOS clang provides a libunwind API compatible library as part of its +environment, so no third party libraries are necessary. + +### Compile with debug info + +You need to compile your project with generation of debug symbols enabled, +usually `-g` with clang++ and g++. + +Note that you can use `-g` with any level of optimization, with modern debug +information encoding like DWARF, it only takes space in the binary (it's not +loaded in memory until your debugger or Backward makes use of it, don't worry), +and it doesn't impact the code generation (at least on GNU/Linux x86\_64 for +what I know). + +If you are missing debug information, the stack trace will lack details about +your sources. + +### Libraries to read the debug info + +Backward supports pretty printed stack traces on GNU/Linux, macOS and Windows, +it will compile fine under other platforms but will not do anything. **Pull +requests are welcome :)** + +Also, by default you will get a really basic stack trace, based on the +`backtrace_symbols` API: + +![default trace](doc/nice.png) + +You will need to install some dependencies to get the ultimate stack trace. +Three libraries are currently supported, the only difference is which one is the +easiest for you to install, so pick your poison: + +#### libbfd from the [GNU/binutils](http://www.gnu.org/software/binutils/) + + apt-get install binutils-dev (or equivalent) + +And do not forget to link with the lib: `g++/clang++ -lbfd -ldl ...` + +This library requires dynamic loading. Which is provided by the library `dl`. +Hence why we also link with `-ldl`. + +Then define the following before every inclusion of `backward.hpp` (don't +forget to update `backward.cpp` as well): + + #define BACKWARD_HAS_BFD 1 + +#### libdw from the [elfutils](https://fedorahosted.org/elfutils/) + + apt-get install libdw-dev (or equivalent) + +And do not forget to link with the lib and inform Backward to use it: + + #define BACKWARD_HAS_DW 1 + +Of course you can simply add the define (`-DBACKWARD_HAS_...=1`) and the +linkage details in your build system and even auto-detect which library is +installed, it's up to you. + +#### [libdwarf](https://sourceforge.net/projects/libdwarf/) and [libelf](http://www.mr511.de/software/english.html) + + apt-get install libdwarf-dev (or equivalent) + +And do not forget to link with the lib and inform Backward to use it: + + #define BACKWARD_HAS_DWARF 1 + +There are several alternative implementations of libdwarf and libelf that +are API compatible so it's possible, although it hasn't been tested, to +replace the ones used when developing backward (in bold, below): + +* **_libelf_** by [Michael "Tired" Riepe](http://www.mr511.de/software/english.html) +* **_libdwarf_** by [David Anderson](https://www.prevanders.net/dwarf.html) +* libelf from [elfutils](https://fedorahosted.org/elfutils/) +* libelf and libdwarf from FreeBSD's [ELF Tool Chain](https://sourceforge.net/p/elftoolchain/wiki/Home/) project + + +Of course you can simply add the define (`-DBACKWARD_HAS_...=1`) and the +linkage details in your build system and even auto-detect which library is +installed, it's up to you. + +That's it, you are all set, you should be getting nice stack traces like the +one at the beginning of this document. + +## API + +If you don't want to limit yourself to the defaults offered by `backward.cpp`, +and you want to take some random stack traces for whatever reason and pretty +print them the way you love or you decide to send them all to your buddies over +the Internet, you will appreciate the simplicity of Backward's API. + +### Stacktrace + +The StackTrace class lets you take a "snapshot" of the current stack. +You can use it like this: + +```c++ +using namespace backward; +StackTrace st; st.load_here(32); +Printer p; p.print(st); +``` + +The public methods are: + +```c++ +class StackTrace { public: + // Take a snapshot of the current stack, with at most "trace_cnt_max" + // traces in it. The first trace is the most recent (ie the current + // frame). You can also provide a trace address to load_from() assuming + // the address is a valid stack frame (useful for signal handling traces). + // Both function return size(). + size_t load_here(size_t trace_cnt_max) + size_t load_from(void* address, size_t trace_cnt_max) + + // The number of traces loaded. This can be less than "trace_cnt_max". + size_t size() const + + // A unique id for the thread in which the trace was taken. The value + // 0 means the stack trace comes from the main thread. + size_t thread_id() const + + // Retrieve a trace by index. 0 is the most recent trace, size()-1 is + // the oldest one. + Trace operator[](size_t trace_idx) +}; +``` + +### TraceResolver + +The `TraceResolver` does the heavy lifting, and intends to transform a simple +`Trace` from its address into a fully detailed `ResolvedTrace` with the +filename of the source, line numbers, inlined functions and so on. + +You can use it like this: + +```c++ +using namespace backward; +StackTrace st; st.load_here(32); + +TraceResolver tr; tr.load_stacktrace(st); +for (size_t i = 0; i < st.size(); ++i) { + ResolvedTrace trace = tr.resolve(st[i]); + std::cout << "#" << i + << " " << trace.object_filename + << " " << trace.object_function + << " [" << trace.addr << "]" + << std::endl; +} +``` + +The public methods are: + +```c++ +class TraceResolver { public: + // Pre-load whatever is necessary from the stack trace. + template + void load_stacktrace(ST&) + + // Resolve a trace. It takes a ResolvedTrace, because a `Trace` is + // implicitly convertible to it. + ResolvedTrace resolve(ResolvedTrace t) +}; +``` + +### SnippetFactory + +The SnippetFactory is a simple helper class to automatically load and cache +source files in order to extract code snippets. + +```c++ +class SnippetFactory { public: + // A snippet is a list of line numbers and line contents. + typedef std::vector > lines_t; + + // Return a snippet starting at line_start with up to context_size lines. + lines_t get_snippet(const std::string& filename, + size_t line_start, size_t context_size) + + // Return a combined snippet from two different locations and combine them. + // context_size / 2 lines will be extracted from each location. + lines_t get_combined_snippet( + const std::string& filename_a, size_t line_a, + const std::string& filename_b, size_t line_b, + size_t context_size) + + // Tries to return a unified snippet if the two locations from the same + // file are close enough to fit inside one context_size, else returns + // the equivalent of get_combined_snippet(). + lines_t get_coalesced_snippet(const std::string& filename, + size_t line_a, size_t line_b, size_t context_size) +``` + +### Printer + +A simpler way to pretty print a stack trace to the terminal. It will +automatically resolve the traces for you: + +```c++ +using namespace backward; +StackTrace st; st.load_here(32); +Printer p; +p.object = true; +p.color_mode = ColorMode::always; +p.address = true; +p.print(st, stderr); +``` + +You can set a few options: + +```c++ +class Printer { public: + // Print a little snippet of code if possible. + bool snippet = true; + + // Colorize the trace + // - ColorMode::automatic: Activate colors if possible. For example, when using a TTY on linux. + // - ColorMode::always: Always use colors. + // - ColorMode::never: Never use colors. + bool color_mode = ColorMode::automatic; + + // Add the addresses of every source location to the trace. + bool address = false; + + // Even if there is a source location, also prints the object + // from where the trace came from. + bool object = false; + + // Resolve and print a stack trace to the given C FILE* object. + // On linux, if the FILE* object is attached to a TTY, + // color will be used if color_mode is set to automatic. + template + FILE* print(StackTrace& st, FILE* fp = stderr); + + // Resolve and print a stack trace to the given std::ostream object. + // Color will only be used if color_mode is set to always. + template + std::ostream& print(ST& st, std::ostream& os); +``` + + +### SignalHandling + +A simple helper class that registers for you the most common signals and other +callbacks to segfault, hardware exception, un-handled exception etc. + +`backward.cpp` simply uses it like that: + +```c++ +backward::SignalHandling sh; +``` + +Creating the object registers all the different signals and hooks. Destroying +this object doesn't do anything. It exposes only one method: + +```c++ +bool loaded() const // true if loaded with success +``` + +### Trace object + +To keep the memory footprint of a loaded `StackTrace` on the low-side, there a +hierarchy of trace object, from a minimal `Trace `to a `ResolvedTrace`. + +#### Simple trace + +```c++ +struct Trace { + void* addr; // address of the trace + size_t idx; // its index (0 == most recent) +}; +``` + +#### Resolved trace + +A `ResolvedTrace` should contains a maximum of details about the location of +the trace in the source code. Note that not all fields might be set. + +```c++ +struct ResolvedTrace: public Trace { + + struct SourceLoc { + std::string function; + std::string filename; + size_t line; + size_t col; + }; + + // In which binary object this trace is located. + std::string object_filename; + + // The function in the object that contains the trace. This is not the same + // as source.function which can be an function inlined in object_function. + std::string object_function; + + // The source location of this trace. It is possible for filename to be + // empty and for line/col to be invalid (value 0) if this information + // couldn't be deduced, for example if there is no debug information in the + // binary object. + SourceLoc source; + + // An optional list of "inliners". All of these sources locations where + // inlined in the source location of the trace (the attribute right above). + // This is especially useful when you compile with optimizations turned on. + typedef std::vector source_locs_t; + source_locs_t inliners; +}; +``` + +## Contact and copyright + +François-Xavier Bourlet + +Copyright 2013-2017 Google Inc. All Rights Reserved. +MIT License. + +### Disclaimer + +Although this project is owned by Google Inc. this is not a Google supported or +affiliated project. diff --git a/extern/backward/backward.cpp b/extern/backward/backward.cpp new file mode 100644 index 00000000..110441cb --- /dev/null +++ b/extern/backward/backward.cpp @@ -0,0 +1,42 @@ +// Pick your poison. +// +// On GNU/Linux, you have few choices to get the most out of your stack trace. +// +// By default you get: +// - object filename +// - function name +// +// In order to add: +// - source filename +// - line and column numbers +// - source code snippet (assuming the file is accessible) + +// Install one of the following libraries then uncomment one of the macro (or +// better, add the detection of the lib and the macro definition in your build +// system) + +// - apt-get install libdw-dev ... +// - g++/clang++ -ldw ... +// #define BACKWARD_HAS_DW 1 + +// - apt-get install binutils-dev ... +// - g++/clang++ -lbfd ... +// #define BACKWARD_HAS_BFD 1 + +// - apt-get install libdwarf-dev ... +// - g++/clang++ -ldwarf ... +// #define BACKWARD_HAS_DWARF 1 + +// Regardless of the library you choose to read the debug information, +// for potentially more detailed stack traces you can use libunwind +// - apt-get install libunwind-dev +// - g++/clang++ -lunwind +// #define BACKWARD_HAS_LIBUNWIND 1 + +#include "backward.hpp" + +namespace backward { + +backward::SignalHandling sh; + +} // namespace backward diff --git a/extern/backward/backward.hpp b/extern/backward/backward.hpp new file mode 100644 index 00000000..37620265 --- /dev/null +++ b/extern/backward/backward.hpp @@ -0,0 +1,4488 @@ +/* + * backward.hpp + * Copyright 2013 Google Inc. All Rights Reserved. + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +#ifndef H_6B9572DA_A64B_49E6_B234_051480991C89 +#define H_6B9572DA_A64B_49E6_B234_051480991C89 + +#ifndef __cplusplus +#error "It's not going to compile without a C++ compiler..." +#endif + +#if defined(BACKWARD_CXX11) +#elif defined(BACKWARD_CXX98) +#else +#if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800) +#define BACKWARD_CXX11 +#define BACKWARD_ATLEAST_CXX11 +#define BACKWARD_ATLEAST_CXX98 +#if __cplusplus >= 201703L || (defined(_MSVC_LANG) && _MSVC_LANG >= 201703L) +#define BACKWARD_ATLEAST_CXX17 +#endif +#else +#define BACKWARD_CXX98 +#define BACKWARD_ATLEAST_CXX98 +#endif +#endif + +// You can define one of the following (or leave it to the auto-detection): +// +// #define BACKWARD_SYSTEM_LINUX +// - specialization for linux +// +// #define BACKWARD_SYSTEM_DARWIN +// - specialization for Mac OS X 10.5 and later. +// +// #define BACKWARD_SYSTEM_WINDOWS +// - specialization for Windows (Clang 9 and MSVC2017) +// +// #define BACKWARD_SYSTEM_UNKNOWN +// - placebo implementation, does nothing. +// +#if defined(BACKWARD_SYSTEM_LINUX) +#elif defined(BACKWARD_SYSTEM_DARWIN) +#elif defined(BACKWARD_SYSTEM_UNKNOWN) +#elif defined(BACKWARD_SYSTEM_WINDOWS) +#else +#if defined(__linux) || defined(__linux__) +#define BACKWARD_SYSTEM_LINUX +#elif defined(__APPLE__) +#define BACKWARD_SYSTEM_DARWIN +#elif defined(_WIN32) +#define BACKWARD_SYSTEM_WINDOWS +#else +#define BACKWARD_SYSTEM_UNKNOWN +#endif +#endif + +#define NOINLINE __attribute__((noinline)) + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#if defined(BACKWARD_SYSTEM_LINUX) + +// On linux, backtrace can back-trace or "walk" the stack using the following +// libraries: +// +// #define BACKWARD_HAS_UNWIND 1 +// - unwind comes from libgcc, but I saw an equivalent inside clang itself. +// - with unwind, the stacktrace is as accurate as it can possibly be, since +// this is used by the C++ runtine in gcc/clang for stack unwinding on +// exception. +// - normally libgcc is already linked to your program by default. +// +// #define BACKWARD_HAS_LIBUNWIND 1 +// - libunwind provides, in some cases, a more accurate stacktrace as it knows +// to decode signal handler frames and lets us edit the context registers when +// unwinding, allowing stack traces over bad function references. +// +// #define BACKWARD_HAS_BACKTRACE == 1 +// - backtrace seems to be a little bit more portable than libunwind, but on +// linux, it uses unwind anyway, but abstract away a tiny information that is +// sadly really important in order to get perfectly accurate stack traces. +// - backtrace is part of the (e)glib library. +// +// The default is: +// #define BACKWARD_HAS_UNWIND == 1 +// +// Note that only one of the define should be set to 1 at a time. +// +#if BACKWARD_HAS_UNWIND == 1 +#elif BACKWARD_HAS_LIBUNWIND == 1 +#elif BACKWARD_HAS_BACKTRACE == 1 +#else +#undef BACKWARD_HAS_UNWIND +#define BACKWARD_HAS_UNWIND 1 +#undef BACKWARD_HAS_LIBUNWIND +#define BACKWARD_HAS_LIBUNWIND 0 +#undef BACKWARD_HAS_BACKTRACE +#define BACKWARD_HAS_BACKTRACE 0 +#endif + +// On linux, backward can extract detailed information about a stack trace +// using one of the following libraries: +// +// #define BACKWARD_HAS_DW 1 +// - libdw gives you the most juicy details out of your stack traces: +// - object filename +// - function name +// - source filename +// - line and column numbers +// - source code snippet (assuming the file is accessible) +// - variable names (if not optimized out) +// - variable values (not supported by backward-cpp) +// - You need to link with the lib "dw": +// - apt-get install libdw-dev +// - g++/clang++ -ldw ... +// +// #define BACKWARD_HAS_BFD 1 +// - With libbfd, you get a fair amount of details: +// - object filename +// - function name +// - source filename +// - line numbers +// - source code snippet (assuming the file is accessible) +// - You need to link with the lib "bfd": +// - apt-get install binutils-dev +// - g++/clang++ -lbfd ... +// +// #define BACKWARD_HAS_DWARF 1 +// - libdwarf gives you the most juicy details out of your stack traces: +// - object filename +// - function name +// - source filename +// - line and column numbers +// - source code snippet (assuming the file is accessible) +// - variable names (if not optimized out) +// - variable values (not supported by backward-cpp) +// - You need to link with the lib "dwarf": +// - apt-get install libdwarf-dev +// - g++/clang++ -ldwarf ... +// +// #define BACKWARD_HAS_BACKTRACE_SYMBOL 1 +// - backtrace provides minimal details for a stack trace: +// - object filename +// - function name +// - backtrace is part of the (e)glib library. +// +// The default is: +// #define BACKWARD_HAS_BACKTRACE_SYMBOL == 1 +// +// Note that only one of the define should be set to 1 at a time. +// +#if BACKWARD_HAS_DW == 1 +#elif BACKWARD_HAS_BFD == 1 +#elif BACKWARD_HAS_DWARF == 1 +#elif BACKWARD_HAS_BACKTRACE_SYMBOL == 1 +#else +#undef BACKWARD_HAS_DW +#define BACKWARD_HAS_DW 0 +#undef BACKWARD_HAS_BFD +#define BACKWARD_HAS_BFD 0 +#undef BACKWARD_HAS_DWARF +#define BACKWARD_HAS_DWARF 0 +#undef BACKWARD_HAS_BACKTRACE_SYMBOL +#define BACKWARD_HAS_BACKTRACE_SYMBOL 1 +#endif + +#include +#include +#ifdef __ANDROID__ +// Old Android API levels define _Unwind_Ptr in both link.h and +// unwind.h Rename the one in link.h as we are not going to be using +// it +#define _Unwind_Ptr _Unwind_Ptr_Custom +#include +#undef _Unwind_Ptr +#else +#include +#endif +#if defined(__ppc__) || defined(__powerpc) || defined(__powerpc__) || \ + defined(__POWERPC__) +// Linux kernel header required for the struct pt_regs definition +// to access the NIP (Next Instruction Pointer) register value +#include +#endif +#include +#include +#include +#include + +#if BACKWARD_HAS_BFD == 1 +// NOTE: defining PACKAGE{,_VERSION} is required before including +// bfd.h on some platforms, see also: +// https://sourceware.org/bugzilla/show_bug.cgi?id=14243 +#ifndef PACKAGE +#define PACKAGE +#endif +#ifndef PACKAGE_VERSION +#define PACKAGE_VERSION +#endif +#include +#ifndef _GNU_SOURCE +#define _GNU_SOURCE +#include +#undef _GNU_SOURCE +#else +#include +#endif +#endif + +#if BACKWARD_HAS_DW == 1 +#include +#include +#include +#endif + +#if BACKWARD_HAS_DWARF == 1 +#include +#include +#include +#include +#include +#ifndef _GNU_SOURCE +#define _GNU_SOURCE +#include +#undef _GNU_SOURCE +#else +#include +#endif +#endif + +#if (BACKWARD_HAS_BACKTRACE == 1) || (BACKWARD_HAS_BACKTRACE_SYMBOL == 1) +// then we shall rely on backtrace +#include +#endif + +#endif // defined(BACKWARD_SYSTEM_LINUX) + +#if defined(BACKWARD_SYSTEM_DARWIN) +// On Darwin, backtrace can back-trace or "walk" the stack using the following +// libraries: +// +// #define BACKWARD_HAS_UNWIND 1 +// - unwind comes from libgcc, but I saw an equivalent inside clang itself. +// - with unwind, the stacktrace is as accurate as it can possibly be, since +// this is used by the C++ runtine in gcc/clang for stack unwinding on +// exception. +// - normally libgcc is already linked to your program by default. +// +// #define BACKWARD_HAS_LIBUNWIND 1 +// - libunwind comes from clang, which implements an API compatible version. +// - libunwind provides, in some cases, a more accurate stacktrace as it knows +// to decode signal handler frames and lets us edit the context registers when +// unwinding, allowing stack traces over bad function references. +// +// #define BACKWARD_HAS_BACKTRACE == 1 +// - backtrace is available by default, though it does not produce as much +// information as another library might. +// +// The default is: +// #define BACKWARD_HAS_UNWIND == 1 +// +// Note that only one of the define should be set to 1 at a time. +// +#if BACKWARD_HAS_UNWIND == 1 +#elif BACKWARD_HAS_BACKTRACE == 1 +#elif BACKWARD_HAS_LIBUNWIND == 1 +#else +#undef BACKWARD_HAS_UNWIND +#define BACKWARD_HAS_UNWIND 1 +#undef BACKWARD_HAS_BACKTRACE +#define BACKWARD_HAS_BACKTRACE 0 +#undef BACKWARD_HAS_LIBUNWIND +#define BACKWARD_HAS_LIBUNWIND 0 +#endif + +// On Darwin, backward can extract detailed information about a stack trace +// using one of the following libraries: +// +// #define BACKWARD_HAS_BACKTRACE_SYMBOL 1 +// - backtrace provides minimal details for a stack trace: +// - object filename +// - function name +// +// The default is: +// #define BACKWARD_HAS_BACKTRACE_SYMBOL == 1 +// +#if BACKWARD_HAS_BACKTRACE_SYMBOL == 1 +#else +#undef BACKWARD_HAS_BACKTRACE_SYMBOL +#define BACKWARD_HAS_BACKTRACE_SYMBOL 1 +#endif + +#include +#include +#include +#include +#include +#include + +#if (BACKWARD_HAS_BACKTRACE == 1) || (BACKWARD_HAS_BACKTRACE_SYMBOL == 1) +#include +#endif +#endif // defined(BACKWARD_SYSTEM_DARWIN) + +#if defined(BACKWARD_SYSTEM_WINDOWS) + +#include +#include +#include + +#include + +#ifdef _WIN64 +typedef SSIZE_T ssize_t; +#else +typedef int ssize_t; +#endif + +#ifndef NOMINMAX +#define NOMINMAX +#endif +#include +#include + +#include +#include + +#ifndef __clang__ +#undef NOINLINE +#define NOINLINE __declspec(noinline) +#endif + +#ifdef _MSC_VER +#pragma comment(lib, "psapi.lib") +#pragma comment(lib, "dbghelp.lib") +#endif + +// Comment / packing is from stackoverflow: +// https://stackoverflow.com/questions/6205981/windows-c-stack-trace-from-a-running-app/28276227#28276227 +// Some versions of imagehlp.dll lack the proper packing directives themselves +// so we need to do it. +#pragma pack(push, before_imagehlp, 8) +#include +#pragma pack(pop, before_imagehlp) + +// TODO maybe these should be undefined somewhere else? +#undef BACKWARD_HAS_UNWIND +#undef BACKWARD_HAS_BACKTRACE +#if BACKWARD_HAS_PDB_SYMBOL == 1 +#else +#undef BACKWARD_HAS_PDB_SYMBOL +#define BACKWARD_HAS_PDB_SYMBOL 1 +#endif + +#endif + +#if BACKWARD_HAS_UNWIND == 1 + +#include +// while gcc's unwind.h defines something like that: +// extern _Unwind_Ptr _Unwind_GetIP (struct _Unwind_Context *); +// extern _Unwind_Ptr _Unwind_GetIPInfo (struct _Unwind_Context *, int *); +// +// clang's unwind.h defines something like this: +// uintptr_t _Unwind_GetIP(struct _Unwind_Context* __context); +// +// Even if the _Unwind_GetIPInfo can be linked to, it is not declared, worse we +// cannot just redeclare it because clang's unwind.h doesn't define _Unwind_Ptr +// anyway. +// +// Luckily we can play on the fact that the guard macros have a different name: +#ifdef __CLANG_UNWIND_H +// In fact, this function still comes from libgcc (on my different linux boxes, +// clang links against libgcc). +#include +extern "C" uintptr_t _Unwind_GetIPInfo(_Unwind_Context *, int *); +#endif + +#endif // BACKWARD_HAS_UNWIND == 1 + +#if BACKWARD_HAS_LIBUNWIND == 1 +#define UNW_LOCAL_ONLY +#include +#endif // BACKWARD_HAS_LIBUNWIND == 1 + +#ifdef BACKWARD_ATLEAST_CXX11 +#include +#include // for std::swap +namespace backward { +namespace details { +template struct hashtable { + typedef std::unordered_map type; +}; +using std::move; +} // namespace details +} // namespace backward +#else // NOT BACKWARD_ATLEAST_CXX11 +#define nullptr NULL +#define override +#include +namespace backward { +namespace details { +template struct hashtable { + typedef std::map type; +}; +template const T &move(const T &v) { return v; } +template T &move(T &v) { return v; } +} // namespace details +} // namespace backward +#endif // BACKWARD_ATLEAST_CXX11 + +namespace backward { +namespace details { +#if defined(BACKWARD_SYSTEM_WINDOWS) +const char kBackwardPathDelimiter[] = ";"; +#else +const char kBackwardPathDelimiter[] = ":"; +#endif +} // namespace details +} // namespace backward + +namespace backward { + +namespace system_tag { +struct linux_tag; // seems that I cannot call that "linux" because the name +// is already defined... so I am adding _tag everywhere. +struct darwin_tag; +struct windows_tag; +struct unknown_tag; + +#if defined(BACKWARD_SYSTEM_LINUX) +typedef linux_tag current_tag; +#elif defined(BACKWARD_SYSTEM_DARWIN) +typedef darwin_tag current_tag; +#elif defined(BACKWARD_SYSTEM_WINDOWS) +typedef windows_tag current_tag; +#elif defined(BACKWARD_SYSTEM_UNKNOWN) +typedef unknown_tag current_tag; +#else +#error "May I please get my system defines?" +#endif +} // namespace system_tag + +namespace trace_resolver_tag { +#if defined(BACKWARD_SYSTEM_LINUX) +struct libdw; +struct libbfd; +struct libdwarf; +struct backtrace_symbol; + +#if BACKWARD_HAS_DW == 1 +typedef libdw current; +#elif BACKWARD_HAS_BFD == 1 +typedef libbfd current; +#elif BACKWARD_HAS_DWARF == 1 +typedef libdwarf current; +#elif BACKWARD_HAS_BACKTRACE_SYMBOL == 1 +typedef backtrace_symbol current; +#else +#error "You shall not pass, until you know what you want." +#endif +#elif defined(BACKWARD_SYSTEM_DARWIN) +struct backtrace_symbol; + +#if BACKWARD_HAS_BACKTRACE_SYMBOL == 1 +typedef backtrace_symbol current; +#else +#error "You shall not pass, until you know what you want." +#endif +#elif defined(BACKWARD_SYSTEM_WINDOWS) +struct pdb_symbol; +#if BACKWARD_HAS_PDB_SYMBOL == 1 +typedef pdb_symbol current; +#else +#error "You shall not pass, until you know what you want." +#endif +#endif +} // namespace trace_resolver_tag + +namespace details { + +template struct rm_ptr { typedef T type; }; + +template struct rm_ptr { typedef T type; }; + +template struct rm_ptr { typedef const T type; }; + +template struct deleter { + template void operator()(U &ptr) const { (*F)(ptr); } +}; + +template struct default_delete { + void operator()(T &ptr) const { delete ptr; } +}; + +template > +class handle { + struct dummy; + T _val; + bool _empty; + +#ifdef BACKWARD_ATLEAST_CXX11 + handle(const handle &) = delete; + handle &operator=(const handle &) = delete; +#endif + +public: + ~handle() { + if (!_empty) { + Deleter()(_val); + } + } + + explicit handle() : _val(), _empty(true) {} + explicit handle(T val) : _val(val), _empty(false) { + if (!_val) + _empty = true; + } + +#ifdef BACKWARD_ATLEAST_CXX11 + handle(handle &&from) : _empty(true) { swap(from); } + handle &operator=(handle &&from) { + swap(from); + return *this; + } +#else + explicit handle(const handle &from) : _empty(true) { + // some sort of poor man's move semantic. + swap(const_cast(from)); + } + handle &operator=(const handle &from) { + // some sort of poor man's move semantic. + swap(const_cast(from)); + return *this; + } +#endif + + void reset(T new_val) { + handle tmp(new_val); + swap(tmp); + } + + void update(T new_val) { + _val = new_val; + _empty = !static_cast(new_val); + } + + operator const dummy *() const { + if (_empty) { + return nullptr; + } + return reinterpret_cast(_val); + } + T get() { return _val; } + T release() { + _empty = true; + return _val; + } + void swap(handle &b) { + using std::swap; + swap(b._val, _val); // can throw, we are safe here. + swap(b._empty, _empty); // should not throw: if you cannot swap two + // bools without throwing... It's a lost cause anyway! + } + + T &operator->() { return _val; } + const T &operator->() const { return _val; } + + typedef typename rm_ptr::type &ref_t; + typedef const typename rm_ptr::type &const_ref_t; + ref_t operator*() { return *_val; } + const_ref_t operator*() const { return *_val; } + ref_t operator[](size_t idx) { return _val[idx]; } + + // Watch out, we've got a badass over here + T *operator&() { + _empty = false; + return &_val; + } +}; + +// Default demangler implementation (do nothing). +template struct demangler_impl { + static std::string demangle(const char *funcname) { return funcname; } +}; + +#if defined(BACKWARD_SYSTEM_LINUX) || defined(BACKWARD_SYSTEM_DARWIN) + +template <> struct demangler_impl { + demangler_impl() : _demangle_buffer_length(0) {} + + std::string demangle(const char *funcname) { + using namespace details; + char *result = abi::__cxa_demangle(funcname, _demangle_buffer.get(), + &_demangle_buffer_length, nullptr); + if (result) { + _demangle_buffer.update(result); + return result; + } + return funcname; + } + +private: + details::handle _demangle_buffer; + size_t _demangle_buffer_length; +}; + +#endif // BACKWARD_SYSTEM_LINUX || BACKWARD_SYSTEM_DARWIN + +struct demangler : public demangler_impl {}; + +// Split a string on the platform's PATH delimiter. Example: if delimiter +// is ":" then: +// "" --> [] +// ":" --> ["",""] +// "::" --> ["","",""] +// "/a/b/c" --> ["/a/b/c"] +// "/a/b/c:/d/e/f" --> ["/a/b/c","/d/e/f"] +// etc. +inline std::vector split_source_prefixes(const std::string &s) { + std::vector out; + size_t last = 0; + size_t next = 0; + size_t delimiter_size = sizeof(kBackwardPathDelimiter) - 1; + while ((next = s.find(kBackwardPathDelimiter, last)) != std::string::npos) { + out.push_back(s.substr(last, next - last)); + last = next + delimiter_size; + } + if (last <= s.length()) { + out.push_back(s.substr(last)); + } + return out; +} + +} // namespace details + +/*************** A TRACE ***************/ + +struct Trace { + void *addr; + size_t idx; + + Trace() : addr(nullptr), idx(0) {} + + explicit Trace(void *_addr, size_t _idx) : addr(_addr), idx(_idx) {} +}; + +struct ResolvedTrace : public Trace { + + struct SourceLoc { + std::string function; + std::string filename; + unsigned line; + unsigned col; + + SourceLoc() : line(0), col(0) {} + + bool operator==(const SourceLoc &b) const { + return function == b.function && filename == b.filename && + line == b.line && col == b.col; + } + + bool operator!=(const SourceLoc &b) const { return !(*this == b); } + }; + + // In which binary object this trace is located. + std::string object_filename; + + // The function in the object that contain the trace. This is not the same + // as source.function which can be an function inlined in object_function. + std::string object_function; + + // The source location of this trace. It is possible for filename to be + // empty and for line/col to be invalid (value 0) if this information + // couldn't be deduced, for example if there is no debug information in the + // binary object. + SourceLoc source; + + // An optionals list of "inliners". All the successive sources location + // from where the source location of the trace (the attribute right above) + // is inlined. It is especially useful when you compiled with optimization. + typedef std::vector source_locs_t; + source_locs_t inliners; + + ResolvedTrace() : Trace() {} + ResolvedTrace(const Trace &mini_trace) : Trace(mini_trace) {} +}; + +/*************** STACK TRACE ***************/ + +// default implemention. +template class StackTraceImpl { +public: + size_t size() const { return 0; } + Trace operator[](size_t) const { return Trace(); } + size_t load_here(size_t = 0) { return 0; } + size_t load_from(void *, size_t = 0, void * = nullptr, void * = nullptr) { + return 0; + } + size_t thread_id() const { return 0; } + void skip_n_firsts(size_t) {} +}; + +class StackTraceImplBase { +public: + StackTraceImplBase() + : _thread_id(0), _skip(0), _context(nullptr), _error_addr(nullptr) {} + + size_t thread_id() const { return _thread_id; } + + void skip_n_firsts(size_t n) { _skip = n; } + +protected: + void load_thread_info() { +#ifdef BACKWARD_SYSTEM_LINUX +#ifndef __ANDROID__ + _thread_id = static_cast(syscall(SYS_gettid)); +#else + _thread_id = static_cast(gettid()); +#endif + if (_thread_id == static_cast(getpid())) { + // If the thread is the main one, let's hide that. + // I like to keep little secret sometimes. + _thread_id = 0; + } +#elif defined(BACKWARD_SYSTEM_DARWIN) + _thread_id = reinterpret_cast(pthread_self()); + if (pthread_main_np() == 1) { + // If the thread is the main one, let's hide that. + _thread_id = 0; + } +#endif + } + + void set_context(void *context) { _context = context; } + void *context() const { return _context; } + + void set_error_addr(void *error_addr) { _error_addr = error_addr; } + void *error_addr() const { return _error_addr; } + + size_t skip_n_firsts() const { return _skip; } + +private: + size_t _thread_id; + size_t _skip; + void *_context; + void *_error_addr; +}; + +class StackTraceImplHolder : public StackTraceImplBase { +public: + size_t size() const { + return (_stacktrace.size() >= skip_n_firsts()) + ? _stacktrace.size() - skip_n_firsts() + : 0; + } + Trace operator[](size_t idx) const { + if (idx >= size()) { + return Trace(); + } + return Trace(_stacktrace[idx + skip_n_firsts()], idx); + } + void *const *begin() const { + if (size()) { + return &_stacktrace[skip_n_firsts()]; + } + return nullptr; + } + +protected: + std::vector _stacktrace; +}; + +#if BACKWARD_HAS_UNWIND == 1 + +namespace details { + +template class Unwinder { +public: + size_t operator()(F &f, size_t depth) { + _f = &f; + _index = -1; + _depth = depth; + _Unwind_Backtrace(&this->backtrace_trampoline, this); + return static_cast(_index); + } + +private: + F *_f; + ssize_t _index; + size_t _depth; + + static _Unwind_Reason_Code backtrace_trampoline(_Unwind_Context *ctx, + void *self) { + return (static_cast(self))->backtrace(ctx); + } + + _Unwind_Reason_Code backtrace(_Unwind_Context *ctx) { + if (_index >= 0 && static_cast(_index) >= _depth) + return _URC_END_OF_STACK; + + int ip_before_instruction = 0; + uintptr_t ip = _Unwind_GetIPInfo(ctx, &ip_before_instruction); + + if (!ip_before_instruction) { + // calculating 0-1 for unsigned, looks like a possible bug to sanitiziers, + // so let's do it explicitly: + if (ip == 0) { + ip = std::numeric_limits::max(); // set it to 0xffff... (as + // from casting 0-1) + } else { + ip -= 1; // else just normally decrement it (no overflow/underflow will + // happen) + } + } + + if (_index >= 0) { // ignore first frame. + (*_f)(static_cast(_index), reinterpret_cast(ip)); + } + _index += 1; + return _URC_NO_REASON; + } +}; + +template size_t unwind(F f, size_t depth) { + Unwinder unwinder; + return unwinder(f, depth); +} + +} // namespace details + +template <> +class StackTraceImpl : public StackTraceImplHolder { +public: + NOINLINE + size_t load_here(size_t depth = 32, void *context = nullptr, + void *error_addr = nullptr) { + load_thread_info(); + set_context(context); + set_error_addr(error_addr); + if (depth == 0) { + return 0; + } + _stacktrace.resize(depth); + size_t trace_cnt = details::unwind(callback(*this), depth); + _stacktrace.resize(trace_cnt); + skip_n_firsts(0); + return size(); + } + size_t load_from(void *addr, size_t depth = 32, void *context = nullptr, + void *error_addr = nullptr) { + load_here(depth + 8, context, error_addr); + + for (size_t i = 0; i < _stacktrace.size(); ++i) { + if (_stacktrace[i] == addr) { + skip_n_firsts(i); + break; + } + } + + _stacktrace.resize(std::min(_stacktrace.size(), skip_n_firsts() + depth)); + return size(); + } + +private: + struct callback { + StackTraceImpl &self; + callback(StackTraceImpl &_self) : self(_self) {} + + void operator()(size_t idx, void *addr) { self._stacktrace[idx] = addr; } + }; +}; + +#elif BACKWARD_HAS_LIBUNWIND == 1 + +template <> +class StackTraceImpl : public StackTraceImplHolder { +public: + __attribute__((noinline)) size_t load_here(size_t depth = 32, + void *_context = nullptr, + void *_error_addr = nullptr) { + set_context(_context); + set_error_addr(_error_addr); + load_thread_info(); + if (depth == 0) { + return 0; + } + _stacktrace.resize(depth + 1); + + int result = 0; + + unw_context_t ctx; + size_t index = 0; + + // Add the tail call. If the Instruction Pointer is the crash address it + // means we got a bad function pointer dereference, so we "unwind" the + // bad pointer manually by using the return address pointed to by the + // Stack Pointer as the Instruction Pointer and letting libunwind do + // the rest + + if (context()) { + ucontext_t *uctx = reinterpret_cast(context()); +#ifdef REG_RIP // x86_64 + if (uctx->uc_mcontext.gregs[REG_RIP] == + reinterpret_cast(error_addr())) { + uctx->uc_mcontext.gregs[REG_RIP] = + *reinterpret_cast(uctx->uc_mcontext.gregs[REG_RSP]); + } + _stacktrace[index] = + reinterpret_cast(uctx->uc_mcontext.gregs[REG_RIP]); + ++index; + ctx = *reinterpret_cast(uctx); +#elif defined(REG_EIP) // x86_32 + if (uctx->uc_mcontext.gregs[REG_EIP] == + reinterpret_cast(error_addr())) { + uctx->uc_mcontext.gregs[REG_EIP] = + *reinterpret_cast(uctx->uc_mcontext.gregs[REG_ESP]); + } + _stacktrace[index] = + reinterpret_cast(uctx->uc_mcontext.gregs[REG_EIP]); + ++index; + ctx = *reinterpret_cast(uctx); +#elif defined(__arm__) + // libunwind uses its own context type for ARM unwinding. + // Copy the registers from the signal handler's context so we can + // unwind + unw_getcontext(&ctx); + ctx.regs[UNW_ARM_R0] = uctx->uc_mcontext.arm_r0; + ctx.regs[UNW_ARM_R1] = uctx->uc_mcontext.arm_r1; + ctx.regs[UNW_ARM_R2] = uctx->uc_mcontext.arm_r2; + ctx.regs[UNW_ARM_R3] = uctx->uc_mcontext.arm_r3; + ctx.regs[UNW_ARM_R4] = uctx->uc_mcontext.arm_r4; + ctx.regs[UNW_ARM_R5] = uctx->uc_mcontext.arm_r5; + ctx.regs[UNW_ARM_R6] = uctx->uc_mcontext.arm_r6; + ctx.regs[UNW_ARM_R7] = uctx->uc_mcontext.arm_r7; + ctx.regs[UNW_ARM_R8] = uctx->uc_mcontext.arm_r8; + ctx.regs[UNW_ARM_R9] = uctx->uc_mcontext.arm_r9; + ctx.regs[UNW_ARM_R10] = uctx->uc_mcontext.arm_r10; + ctx.regs[UNW_ARM_R11] = uctx->uc_mcontext.arm_fp; + ctx.regs[UNW_ARM_R12] = uctx->uc_mcontext.arm_ip; + ctx.regs[UNW_ARM_R13] = uctx->uc_mcontext.arm_sp; + ctx.regs[UNW_ARM_R14] = uctx->uc_mcontext.arm_lr; + ctx.regs[UNW_ARM_R15] = uctx->uc_mcontext.arm_pc; + + // If we have crashed in the PC use the LR instead, as this was + // a bad function dereference + if (reinterpret_cast(error_addr()) == + uctx->uc_mcontext.arm_pc) { + ctx.regs[UNW_ARM_R15] = + uctx->uc_mcontext.arm_lr - sizeof(unsigned long); + } + _stacktrace[index] = reinterpret_cast(ctx.regs[UNW_ARM_R15]); + ++index; +#elif defined(__APPLE__) && defined(__x86_64__) + unw_getcontext(&ctx); + // OS X's implementation of libunwind uses its own context object + // so we need to convert the passed context to libunwind's format + // (information about the data layout taken from unw_getcontext.s + // in Apple's libunwind source + ctx.data[0] = uctx->uc_mcontext->__ss.__rax; + ctx.data[1] = uctx->uc_mcontext->__ss.__rbx; + ctx.data[2] = uctx->uc_mcontext->__ss.__rcx; + ctx.data[3] = uctx->uc_mcontext->__ss.__rdx; + ctx.data[4] = uctx->uc_mcontext->__ss.__rdi; + ctx.data[5] = uctx->uc_mcontext->__ss.__rsi; + ctx.data[6] = uctx->uc_mcontext->__ss.__rbp; + ctx.data[7] = uctx->uc_mcontext->__ss.__rsp; + ctx.data[8] = uctx->uc_mcontext->__ss.__r8; + ctx.data[9] = uctx->uc_mcontext->__ss.__r9; + ctx.data[10] = uctx->uc_mcontext->__ss.__r10; + ctx.data[11] = uctx->uc_mcontext->__ss.__r11; + ctx.data[12] = uctx->uc_mcontext->__ss.__r12; + ctx.data[13] = uctx->uc_mcontext->__ss.__r13; + ctx.data[14] = uctx->uc_mcontext->__ss.__r14; + ctx.data[15] = uctx->uc_mcontext->__ss.__r15; + ctx.data[16] = uctx->uc_mcontext->__ss.__rip; + + // If the IP is the same as the crash address we have a bad function + // dereference The caller's address is pointed to by %rsp, so we + // dereference that value and set it to be the next frame's IP. + if (uctx->uc_mcontext->__ss.__rip == + reinterpret_cast<__uint64_t>(error_addr())) { + ctx.data[16] = + *reinterpret_cast<__uint64_t *>(uctx->uc_mcontext->__ss.__rsp); + } + _stacktrace[index] = reinterpret_cast(ctx.data[16]); + ++index; +#elif defined(__APPLE__) + unw_getcontext(&ctx) + // TODO: Convert the ucontext_t to libunwind's unw_context_t like + // we do in 64 bits + if (ctx.uc_mcontext->__ss.__eip == + reinterpret_cast(error_addr())) { + ctx.uc_mcontext->__ss.__eip = ctx.uc_mcontext->__ss.__esp; + } + _stacktrace[index] = + reinterpret_cast(ctx.uc_mcontext->__ss.__eip); + ++index; +#endif + } + + unw_cursor_t cursor; + if (context()) { +#if defined(UNW_INIT_SIGNAL_FRAME) + result = unw_init_local2(&cursor, &ctx, UNW_INIT_SIGNAL_FRAME); +#else + result = unw_init_local(&cursor, &ctx); +#endif + } else { + unw_getcontext(&ctx); + ; + result = unw_init_local(&cursor, &ctx); + } + + if (result != 0) + return 1; + + unw_word_t ip = 0; + + while (index <= depth && unw_step(&cursor) > 0) { + result = unw_get_reg(&cursor, UNW_REG_IP, &ip); + if (result == 0) { + _stacktrace[index] = reinterpret_cast(--ip); + ++index; + } + } + --index; + + _stacktrace.resize(index + 1); + skip_n_firsts(0); + return size(); + } + + size_t load_from(void *addr, size_t depth = 32, void *context = nullptr, + void *error_addr = nullptr) { + load_here(depth + 8, context, error_addr); + + for (size_t i = 0; i < _stacktrace.size(); ++i) { + if (_stacktrace[i] == addr) { + skip_n_firsts(i); + _stacktrace[i] = (void *)((uintptr_t)_stacktrace[i]); + break; + } + } + + _stacktrace.resize(std::min(_stacktrace.size(), skip_n_firsts() + depth)); + return size(); + } +}; + +#elif defined(BACKWARD_HAS_BACKTRACE) + +template <> +class StackTraceImpl : public StackTraceImplHolder { +public: + NOINLINE + size_t load_here(size_t depth = 32, void *context = nullptr, + void *error_addr = nullptr) { + set_context(context); + set_error_addr(error_addr); + load_thread_info(); + if (depth == 0) { + return 0; + } + _stacktrace.resize(depth + 1); + size_t trace_cnt = backtrace(&_stacktrace[0], _stacktrace.size()); + _stacktrace.resize(trace_cnt); + skip_n_firsts(1); + return size(); + } + + size_t load_from(void *addr, size_t depth = 32, void *context = nullptr, + void *error_addr = nullptr) { + load_here(depth + 8, context, error_addr); + + for (size_t i = 0; i < _stacktrace.size(); ++i) { + if (_stacktrace[i] == addr) { + skip_n_firsts(i); + _stacktrace[i] = (void *)((uintptr_t)_stacktrace[i] + 1); + break; + } + } + + _stacktrace.resize(std::min(_stacktrace.size(), skip_n_firsts() + depth)); + return size(); + } +}; + +#elif defined(BACKWARD_SYSTEM_WINDOWS) + +template <> +class StackTraceImpl : public StackTraceImplHolder { +public: + // We have to load the machine type from the image info + // So we first initialize the resolver, and it tells us this info + void set_machine_type(DWORD machine_type) { machine_type_ = machine_type; } + void set_context(CONTEXT *ctx) { ctx_ = ctx; } + void set_thread_handle(HANDLE handle) { thd_ = handle; } + + NOINLINE + size_t load_here(size_t depth = 32, void *context = nullptr, + void *error_addr = nullptr) { + set_context(static_cast(context)); + set_error_addr(error_addr); + CONTEXT localCtx; // used when no context is provided + + if (depth == 0) { + return 0; + } + + if (!ctx_) { + ctx_ = &localCtx; + RtlCaptureContext(ctx_); + } + + if (!thd_) { + thd_ = GetCurrentThread(); + } + + HANDLE process = GetCurrentProcess(); + + STACKFRAME64 s; + memset(&s, 0, sizeof(STACKFRAME64)); + + // TODO: 32 bit context capture + s.AddrStack.Mode = AddrModeFlat; + s.AddrFrame.Mode = AddrModeFlat; + s.AddrPC.Mode = AddrModeFlat; +#ifdef _M_X64 + s.AddrPC.Offset = ctx_->Rip; + s.AddrStack.Offset = ctx_->Rsp; + s.AddrFrame.Offset = ctx_->Rbp; +#else + s.AddrPC.Offset = ctx_->Eip; + s.AddrStack.Offset = ctx_->Esp; + s.AddrFrame.Offset = ctx_->Ebp; +#endif + + if (!machine_type_) { +#ifdef _M_X64 + machine_type_ = IMAGE_FILE_MACHINE_AMD64; +#else + machine_type_ = IMAGE_FILE_MACHINE_I386; +#endif + } + + for (;;) { + // NOTE: this only works if PDBs are already loaded! + SetLastError(0); + if (!StackWalk64(machine_type_, process, thd_, &s, ctx_, NULL, + SymFunctionTableAccess64, SymGetModuleBase64, NULL)) + break; + + if (s.AddrReturn.Offset == 0) + break; + + _stacktrace.push_back(reinterpret_cast(s.AddrPC.Offset)); + + if (size() >= depth) + break; + } + + return size(); + } + + size_t load_from(void *addr, size_t depth = 32, void *context = nullptr, + void *error_addr = nullptr) { + load_here(depth + 8, context, error_addr); + + for (size_t i = 0; i < _stacktrace.size(); ++i) { + if (_stacktrace[i] == addr) { + skip_n_firsts(i); + break; + } + } + + _stacktrace.resize(std::min(_stacktrace.size(), skip_n_firsts() + depth)); + return size(); + } + +private: + DWORD machine_type_ = 0; + HANDLE thd_ = 0; + CONTEXT *ctx_ = nullptr; +}; + +#endif + +class StackTrace : public StackTraceImpl {}; + +/*************** TRACE RESOLVER ***************/ + +class TraceResolverImplBase { +public: + virtual ~TraceResolverImplBase() {} + + virtual void load_addresses(void *const*addresses, int address_count) { + (void)addresses; + (void)address_count; + } + + template void load_stacktrace(ST &st) { + load_addresses(st.begin(), static_cast(st.size())); + } + + virtual ResolvedTrace resolve(ResolvedTrace t) { return t; } + +protected: + std::string demangle(const char *funcname) { + return _demangler.demangle(funcname); + } + +private: + details::demangler _demangler; +}; + +template class TraceResolverImpl; + +#ifdef BACKWARD_SYSTEM_UNKNOWN + +template <> class TraceResolverImpl + : public TraceResolverImplBase {}; + +#endif + +#ifdef BACKWARD_SYSTEM_LINUX + +class TraceResolverLinuxBase : public TraceResolverImplBase { +public: + TraceResolverLinuxBase() + : argv0_(get_argv0()), exec_path_(read_symlink("/proc/self/exe")) {} + std::string resolve_exec_path(Dl_info &symbol_info) const { + // mutates symbol_info.dli_fname to be filename to open and returns filename + // to display + if (symbol_info.dli_fname == argv0_) { + // dladdr returns argv[0] in dli_fname for symbols contained in + // the main executable, which is not a valid path if the + // executable was found by a search of the PATH environment + // variable; In that case, we actually open /proc/self/exe, which + // is always the actual executable (even if it was deleted/replaced!) + // but display the path that /proc/self/exe links to. + // However, this right away reduces probability of successful symbol + // resolution, because libbfd may try to find *.debug files in the + // same dir, in case symbols are stripped. As a result, it may try + // to find a file /proc/self/.debug, which obviously does + // not exist. /proc/self/exe is a last resort. First load attempt + // should go for the original executable file path. + symbol_info.dli_fname = "/proc/self/exe"; + return exec_path_; + } else { + return symbol_info.dli_fname; + } + } + +private: + std::string argv0_; + std::string exec_path_; + + static std::string get_argv0() { + std::string argv0; + std::ifstream ifs("/proc/self/cmdline"); + std::getline(ifs, argv0, '\0'); + return argv0; + } + + static std::string read_symlink(std::string const &symlink_path) { + std::string path; + path.resize(100); + + while (true) { + ssize_t len = + ::readlink(symlink_path.c_str(), &*path.begin(), path.size()); + if (len < 0) { + return ""; + } + if (static_cast(len) == path.size()) { + path.resize(path.size() * 2); + } else { + path.resize(static_cast(len)); + break; + } + } + + return path; + } +}; + +template class TraceResolverLinuxImpl; + +#if BACKWARD_HAS_BACKTRACE_SYMBOL == 1 + +template <> +class TraceResolverLinuxImpl + : public TraceResolverLinuxBase { +public: + void load_addresses(void *const*addresses, int address_count) override { + if (address_count == 0) { + return; + } + _symbols.reset(backtrace_symbols(addresses, address_count)); + } + + ResolvedTrace resolve(ResolvedTrace trace) override { + char *filename = _symbols[trace.idx]; + char *funcname = filename; + while (*funcname && *funcname != '(') { + funcname += 1; + } + trace.object_filename.assign(filename, + funcname); // ok even if funcname is the ending + // \0 (then we assign entire string) + + if (*funcname) { // if it's not end of string (e.g. from last frame ip==0) + funcname += 1; + char *funcname_end = funcname; + while (*funcname_end && *funcname_end != ')' && *funcname_end != '+') { + funcname_end += 1; + } + *funcname_end = '\0'; + trace.object_function = this->demangle(funcname); + trace.source.function = trace.object_function; // we cannot do better. + } + return trace; + } + +private: + details::handle _symbols; +}; + +#endif // BACKWARD_HAS_BACKTRACE_SYMBOL == 1 + +#if BACKWARD_HAS_BFD == 1 + +template <> +class TraceResolverLinuxImpl + : public TraceResolverLinuxBase { +public: + TraceResolverLinuxImpl() : _bfd_loaded(false) {} + + ResolvedTrace resolve(ResolvedTrace trace) override { + Dl_info symbol_info; + + // trace.addr is a virtual address in memory pointing to some code. + // Let's try to find from which loaded object it comes from. + // The loaded object can be yourself btw. + if (!dladdr(trace.addr, &symbol_info)) { + return trace; // dat broken trace... + } + + // Now we get in symbol_info: + // .dli_fname: + // pathname of the shared object that contains the address. + // .dli_fbase: + // where the object is loaded in memory. + // .dli_sname: + // the name of the nearest symbol to trace.addr, we expect a + // function name. + // .dli_saddr: + // the exact address corresponding to .dli_sname. + + if (symbol_info.dli_sname) { + trace.object_function = demangle(symbol_info.dli_sname); + } + + if (!symbol_info.dli_fname) { + return trace; + } + + trace.object_filename = resolve_exec_path(symbol_info); + bfd_fileobject *fobj; + // Before rushing to resolution need to ensure the executable + // file still can be used. For that compare inode numbers of + // what is stored by the executable's file path, and in the + // dli_fname, which not necessarily equals to the executable. + // It can be a shared library, or /proc/self/exe, and in the + // latter case has drawbacks. See the exec path resolution for + // details. In short - the dli object should be used only as + // the last resort. + // If inode numbers are equal, it is known dli_fname and the + // executable file are the same. This is guaranteed by Linux, + // because if the executable file is changed/deleted, it will + // be done in a new inode. The old file will be preserved in + // /proc/self/exe, and may even have inode 0. The latter can + // happen if the inode was actually reused, and the file was + // kept only in the main memory. + // + struct stat obj_stat; + struct stat dli_stat; + if (stat(trace.object_filename.c_str(), &obj_stat) == 0 && + stat(symbol_info.dli_fname, &dli_stat) == 0 && + obj_stat.st_ino == dli_stat.st_ino) { + // The executable file, and the shared object containing the + // address are the same file. Safe to use the original path. + // this is preferable. Libbfd will search for stripped debug + // symbols in the same directory. + fobj = load_object_with_bfd(trace.object_filename); + } else{ + // The original object file was *deleted*! The only hope is + // that the debug symbols are either inside the shared + // object file, or are in the same directory, and this is + // not /proc/self/exe. + fobj = nullptr; + } + if (fobj == nullptr || !fobj->handle) { + fobj = load_object_with_bfd(symbol_info.dli_fname); + if (!fobj->handle) { + return trace; + } + } + + find_sym_result *details_selected; // to be filled. + + // trace.addr is the next instruction to be executed after returning + // from the nested stack frame. In C++ this usually relate to the next + // statement right after the function call that leaded to a new stack + // frame. This is not usually what you want to see when printing out a + // stacktrace... + find_sym_result details_call_site = + find_symbol_details(fobj, trace.addr, symbol_info.dli_fbase); + details_selected = &details_call_site; + +#if BACKWARD_HAS_UNWIND == 0 + // ...this is why we also try to resolve the symbol that is right + // before the return address. If we are lucky enough, we will get the + // line of the function that was called. But if the code is optimized, + // we might get something absolutely not related since the compiler + // can reschedule the return address with inline functions and + // tail-call optimisation (among other things that I don't even know + // or cannot even dream about with my tiny limited brain). + find_sym_result details_adjusted_call_site = find_symbol_details( + fobj, (void *)(uintptr_t(trace.addr) - 1), symbol_info.dli_fbase); + + // In debug mode, we should always get the right thing(TM). + if (details_call_site.found && details_adjusted_call_site.found) { + // Ok, we assume that details_adjusted_call_site is a better estimation. + details_selected = &details_adjusted_call_site; + trace.addr = (void *)(uintptr_t(trace.addr) - 1); + } + + if (details_selected == &details_call_site && details_call_site.found) { + // we have to re-resolve the symbol in order to reset some + // internal state in BFD... so we can call backtrace_inliners + // thereafter... + details_call_site = + find_symbol_details(fobj, trace.addr, symbol_info.dli_fbase); + } +#endif // BACKWARD_HAS_UNWIND + + if (details_selected->found) { + if (details_selected->filename) { + trace.source.filename = details_selected->filename; + } + trace.source.line = details_selected->line; + + if (details_selected->funcname) { + // this time we get the name of the function where the code is + // located, instead of the function were the address is + // located. In short, if the code was inlined, we get the + // function correspoding to the code. Else we already got in + // trace.function. + trace.source.function = demangle(details_selected->funcname); + + if (!symbol_info.dli_sname) { + // for the case dladdr failed to find the symbol name of + // the function, we might as well try to put something + // here. + trace.object_function = trace.source.function; + } + } + + // Maybe the source of the trace got inlined inside the function + // (trace.source.function). Let's see if we can get all the inlined + // calls along the way up to the initial call site. + trace.inliners = backtrace_inliners(fobj, *details_selected); + +#if 0 + if (trace.inliners.size() == 0) { + // Maybe the trace was not inlined... or maybe it was and we + // are lacking the debug information. Let's try to make the + // world better and see if we can get the line number of the + // function (trace.source.function) now. + // + // We will get the location of where the function start (to be + // exact: the first instruction that really start the + // function), not where the name of the function is defined. + // This can be quite far away from the name of the function + // btw. + // + // If the source of the function is the same as the source of + // the trace, we cannot say if the trace was really inlined or + // not. However, if the filename of the source is different + // between the function and the trace... we can declare it as + // an inliner. This is not 100% accurate, but better than + // nothing. + + if (symbol_info.dli_saddr) { + find_sym_result details = find_symbol_details(fobj, + symbol_info.dli_saddr, + symbol_info.dli_fbase); + + if (details.found) { + ResolvedTrace::SourceLoc diy_inliner; + diy_inliner.line = details.line; + if (details.filename) { + diy_inliner.filename = details.filename; + } + if (details.funcname) { + diy_inliner.function = demangle(details.funcname); + } else { + diy_inliner.function = trace.source.function; + } + if (diy_inliner != trace.source) { + trace.inliners.push_back(diy_inliner); + } + } + } + } +#endif + } + + return trace; + } + +private: + bool _bfd_loaded; + + typedef details::handle > + bfd_handle_t; + + typedef details::handle bfd_symtab_t; + + struct bfd_fileobject { + bfd_handle_t handle; + bfd_vma base_addr; + bfd_symtab_t symtab; + bfd_symtab_t dynamic_symtab; + }; + + typedef details::hashtable::type fobj_bfd_map_t; + fobj_bfd_map_t _fobj_bfd_map; + + bfd_fileobject *load_object_with_bfd(const std::string &filename_object) { + using namespace details; + + if (!_bfd_loaded) { + using namespace details; + bfd_init(); + _bfd_loaded = true; + } + + fobj_bfd_map_t::iterator it = _fobj_bfd_map.find(filename_object); + if (it != _fobj_bfd_map.end()) { + return &it->second; + } + + // this new object is empty for now. + bfd_fileobject *r = &_fobj_bfd_map[filename_object]; + + // we do the work temporary in this one; + bfd_handle_t bfd_handle; + + int fd = open(filename_object.c_str(), O_RDONLY); + bfd_handle.reset(bfd_fdopenr(filename_object.c_str(), "default", fd)); + if (!bfd_handle) { + close(fd); + return r; + } + + if (!bfd_check_format(bfd_handle.get(), bfd_object)) { + return r; // not an object? You lose. + } + + if ((bfd_get_file_flags(bfd_handle.get()) & HAS_SYMS) == 0) { + return r; // that's what happen when you forget to compile in debug. + } + + ssize_t symtab_storage_size = bfd_get_symtab_upper_bound(bfd_handle.get()); + + ssize_t dyn_symtab_storage_size = + bfd_get_dynamic_symtab_upper_bound(bfd_handle.get()); + + if (symtab_storage_size <= 0 && dyn_symtab_storage_size <= 0) { + return r; // weird, is the file is corrupted? + } + + bfd_symtab_t symtab, dynamic_symtab; + ssize_t symcount = 0, dyn_symcount = 0; + + if (symtab_storage_size > 0) { + symtab.reset(static_cast( + malloc(static_cast(symtab_storage_size)))); + symcount = bfd_canonicalize_symtab(bfd_handle.get(), symtab.get()); + } + + if (dyn_symtab_storage_size > 0) { + dynamic_symtab.reset(static_cast( + malloc(static_cast(dyn_symtab_storage_size)))); + dyn_symcount = bfd_canonicalize_dynamic_symtab(bfd_handle.get(), + dynamic_symtab.get()); + } + + if (symcount <= 0 && dyn_symcount <= 0) { + return r; // damned, that's a stripped file that you got there! + } + + r->handle = move(bfd_handle); + r->symtab = move(symtab); + r->dynamic_symtab = move(dynamic_symtab); + return r; + } + + struct find_sym_result { + bool found; + const char *filename; + const char *funcname; + unsigned int line; + }; + + struct find_sym_context { + TraceResolverLinuxImpl *self; + bfd_fileobject *fobj; + void *addr; + void *base_addr; + find_sym_result result; + }; + + find_sym_result find_symbol_details(bfd_fileobject *fobj, void *addr, + void *base_addr) { + find_sym_context context; + context.self = this; + context.fobj = fobj; + context.addr = addr; + context.base_addr = base_addr; + context.result.found = false; + bfd_map_over_sections(fobj->handle.get(), &find_in_section_trampoline, + static_cast(&context)); + return context.result; + } + + static void find_in_section_trampoline(bfd *, asection *section, void *data) { + find_sym_context *context = static_cast(data); + context->self->find_in_section( + reinterpret_cast(context->addr), + reinterpret_cast(context->base_addr), context->fobj, section, + context->result); + } + + void find_in_section(bfd_vma addr, bfd_vma base_addr, bfd_fileobject *fobj, + asection *section, find_sym_result &result) { + if (result.found) + return; + +#ifdef bfd_get_section_flags + if ((bfd_get_section_flags(fobj->handle.get(), section) & SEC_ALLOC) == 0) +#else + if ((bfd_section_flags(section) & SEC_ALLOC) == 0) +#endif + return; // a debug section is never loaded automatically. + +#ifdef bfd_get_section_vma + bfd_vma sec_addr = bfd_get_section_vma(fobj->handle.get(), section); +#else + bfd_vma sec_addr = bfd_section_vma(section); +#endif +#ifdef bfd_get_section_size + bfd_size_type size = bfd_get_section_size(section); +#else + bfd_size_type size = bfd_section_size(section); +#endif + + // are we in the boundaries of the section? + if (addr < sec_addr || addr >= sec_addr + size) { + addr -= base_addr; // oups, a relocated object, lets try again... + if (addr < sec_addr || addr >= sec_addr + size) { + return; + } + } + +#if defined(__clang__) +#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Wzero-as-null-pointer-constant" +#endif + if (!result.found && fobj->symtab) { + result.found = bfd_find_nearest_line( + fobj->handle.get(), section, fobj->symtab.get(), addr - sec_addr, + &result.filename, &result.funcname, &result.line); + } + + if (!result.found && fobj->dynamic_symtab) { + result.found = bfd_find_nearest_line( + fobj->handle.get(), section, fobj->dynamic_symtab.get(), + addr - sec_addr, &result.filename, &result.funcname, &result.line); + } +#if defined(__clang__) +#pragma clang diagnostic pop +#endif + } + + ResolvedTrace::source_locs_t + backtrace_inliners(bfd_fileobject *fobj, find_sym_result previous_result) { + // This function can be called ONLY after a SUCCESSFUL call to + // find_symbol_details. The state is global to the bfd_handle. + ResolvedTrace::source_locs_t results; + while (previous_result.found) { + find_sym_result result; + result.found = bfd_find_inliner_info(fobj->handle.get(), &result.filename, + &result.funcname, &result.line); + + if (result + .found) /* and not ( + cstrings_eq(previous_result.filename, + result.filename) and + cstrings_eq(previous_result.funcname, result.funcname) + and result.line == previous_result.line + )) */ + { + ResolvedTrace::SourceLoc src_loc; + src_loc.line = result.line; + if (result.filename) { + src_loc.filename = result.filename; + } + if (result.funcname) { + src_loc.function = demangle(result.funcname); + } + results.push_back(src_loc); + } + previous_result = result; + } + return results; + } + + bool cstrings_eq(const char *a, const char *b) { + if (!a || !b) { + return false; + } + return strcmp(a, b) == 0; + } +}; +#endif // BACKWARD_HAS_BFD == 1 + +#if BACKWARD_HAS_DW == 1 + +template <> +class TraceResolverLinuxImpl + : public TraceResolverLinuxBase { +public: + TraceResolverLinuxImpl() : _dwfl_handle_initialized(false) {} + + ResolvedTrace resolve(ResolvedTrace trace) override { + using namespace details; + + Dwarf_Addr trace_addr = (Dwarf_Addr)trace.addr; + + if (!_dwfl_handle_initialized) { + // initialize dwfl... + _dwfl_cb.reset(new Dwfl_Callbacks); + _dwfl_cb->find_elf = &dwfl_linux_proc_find_elf; + _dwfl_cb->find_debuginfo = &dwfl_standard_find_debuginfo; + _dwfl_cb->debuginfo_path = 0; + + _dwfl_handle.reset(dwfl_begin(_dwfl_cb.get())); + _dwfl_handle_initialized = true; + + if (!_dwfl_handle) { + return trace; + } + + // ...from the current process. + dwfl_report_begin(_dwfl_handle.get()); + int r = dwfl_linux_proc_report(_dwfl_handle.get(), getpid()); + dwfl_report_end(_dwfl_handle.get(), NULL, NULL); + if (r < 0) { + return trace; + } + } + + if (!_dwfl_handle) { + return trace; + } + + // find the module (binary object) that contains the trace's address. + // This is not using any debug information, but the addresses ranges of + // all the currently loaded binary object. + Dwfl_Module *mod = dwfl_addrmodule(_dwfl_handle.get(), trace_addr); + if (mod) { + // now that we found it, lets get the name of it, this will be the + // full path to the running binary or one of the loaded library. + const char *module_name = dwfl_module_info(mod, 0, 0, 0, 0, 0, 0, 0); + if (module_name) { + trace.object_filename = module_name; + } + // We also look after the name of the symbol, equal or before this + // address. This is found by walking the symtab. We should get the + // symbol corresponding to the function (mangled) containing the + // address. If the code corresponding to the address was inlined, + // this is the name of the out-most inliner function. + const char *sym_name = dwfl_module_addrname(mod, trace_addr); + if (sym_name) { + trace.object_function = demangle(sym_name); + } + } + + // now let's get serious, and find out the source location (file and + // line number) of the address. + + // This function will look in .debug_aranges for the address and map it + // to the location of the compilation unit DIE in .debug_info and + // return it. + Dwarf_Addr mod_bias = 0; + Dwarf_Die *cudie = dwfl_module_addrdie(mod, trace_addr, &mod_bias); + +#if 1 + if (!cudie) { + // Sadly clang does not generate the section .debug_aranges, thus + // dwfl_module_addrdie will fail early. Clang doesn't either set + // the lowpc/highpc/range info for every compilation unit. + // + // So in order to save the world: + // for every compilation unit, we will iterate over every single + // DIEs. Normally functions should have a lowpc/highpc/range, which + // we will use to infer the compilation unit. + + // note that this is probably badly inefficient. + while ((cudie = dwfl_module_nextcu(mod, cudie, &mod_bias))) { + Dwarf_Die die_mem; + Dwarf_Die *fundie = + find_fundie_by_pc(cudie, trace_addr - mod_bias, &die_mem); + if (fundie) { + break; + } + } + } +#endif + +//#define BACKWARD_I_DO_NOT_RECOMMEND_TO_ENABLE_THIS_HORRIBLE_PIECE_OF_CODE +#ifdef BACKWARD_I_DO_NOT_RECOMMEND_TO_ENABLE_THIS_HORRIBLE_PIECE_OF_CODE + if (!cudie) { + // If it's still not enough, lets dive deeper in the shit, and try + // to save the world again: for every compilation unit, we will + // load the corresponding .debug_line section, and see if we can + // find our address in it. + + Dwarf_Addr cfi_bias; + Dwarf_CFI *cfi_cache = dwfl_module_eh_cfi(mod, &cfi_bias); + + Dwarf_Addr bias; + while ((cudie = dwfl_module_nextcu(mod, cudie, &bias))) { + if (dwarf_getsrc_die(cudie, trace_addr - bias)) { + + // ...but if we get a match, it might be a false positive + // because our (address - bias) might as well be valid in a + // different compilation unit. So we throw our last card on + // the table and lookup for the address into the .eh_frame + // section. + + handle frame; + dwarf_cfi_addrframe(cfi_cache, trace_addr - cfi_bias, &frame); + if (frame) { + break; + } + } + } + } +#endif + + if (!cudie) { + return trace; // this time we lost the game :/ + } + + // Now that we have a compilation unit DIE, this function will be able + // to load the corresponding section in .debug_line (if not already + // loaded) and hopefully find the source location mapped to our + // address. + Dwarf_Line *srcloc = dwarf_getsrc_die(cudie, trace_addr - mod_bias); + + if (srcloc) { + const char *srcfile = dwarf_linesrc(srcloc, 0, 0); + if (srcfile) { + trace.source.filename = srcfile; + } + int line = 0, col = 0; + dwarf_lineno(srcloc, &line); + dwarf_linecol(srcloc, &col); + trace.source.line = line; + trace.source.col = col; + } + + deep_first_search_by_pc(cudie, trace_addr - mod_bias, + inliners_search_cb(trace)); + if (trace.source.function.size() == 0) { + // fallback. + trace.source.function = trace.object_function; + } + + return trace; + } + +private: + typedef details::handle > + dwfl_handle_t; + details::handle > + _dwfl_cb; + dwfl_handle_t _dwfl_handle; + bool _dwfl_handle_initialized; + + // defined here because in C++98, template function cannot take locally + // defined types... grrr. + struct inliners_search_cb { + void operator()(Dwarf_Die *die) { + switch (dwarf_tag(die)) { + const char *name; + case DW_TAG_subprogram: + if ((name = dwarf_diename(die))) { + trace.source.function = name; + } + break; + + case DW_TAG_inlined_subroutine: + ResolvedTrace::SourceLoc sloc; + Dwarf_Attribute attr_mem; + + if ((name = dwarf_diename(die))) { + sloc.function = name; + } + if ((name = die_call_file(die))) { + sloc.filename = name; + } + + Dwarf_Word line = 0, col = 0; + dwarf_formudata(dwarf_attr(die, DW_AT_call_line, &attr_mem), &line); + dwarf_formudata(dwarf_attr(die, DW_AT_call_column, &attr_mem), &col); + sloc.line = (unsigned)line; + sloc.col = (unsigned)col; + + trace.inliners.push_back(sloc); + break; + }; + } + ResolvedTrace &trace; + inliners_search_cb(ResolvedTrace &t) : trace(t) {} + }; + + static bool die_has_pc(Dwarf_Die *die, Dwarf_Addr pc) { + Dwarf_Addr low, high; + + // continuous range + if (dwarf_hasattr(die, DW_AT_low_pc) && dwarf_hasattr(die, DW_AT_high_pc)) { + if (dwarf_lowpc(die, &low) != 0) { + return false; + } + if (dwarf_highpc(die, &high) != 0) { + Dwarf_Attribute attr_mem; + Dwarf_Attribute *attr = dwarf_attr(die, DW_AT_high_pc, &attr_mem); + Dwarf_Word value; + if (dwarf_formudata(attr, &value) != 0) { + return false; + } + high = low + value; + } + return pc >= low && pc < high; + } + + // non-continuous range. + Dwarf_Addr base; + ptrdiff_t offset = 0; + while ((offset = dwarf_ranges(die, offset, &base, &low, &high)) > 0) { + if (pc >= low && pc < high) { + return true; + } + } + return false; + } + + static Dwarf_Die *find_fundie_by_pc(Dwarf_Die *parent_die, Dwarf_Addr pc, + Dwarf_Die *result) { + if (dwarf_child(parent_die, result) != 0) { + return 0; + } + + Dwarf_Die *die = result; + do { + switch (dwarf_tag(die)) { + case DW_TAG_subprogram: + case DW_TAG_inlined_subroutine: + if (die_has_pc(die, pc)) { + return result; + } + }; + bool declaration = false; + Dwarf_Attribute attr_mem; + dwarf_formflag(dwarf_attr(die, DW_AT_declaration, &attr_mem), + &declaration); + if (!declaration) { + // let's be curious and look deeper in the tree, + // function are not necessarily at the first level, but + // might be nested inside a namespace, structure etc. + Dwarf_Die die_mem; + Dwarf_Die *indie = find_fundie_by_pc(die, pc, &die_mem); + if (indie) { + *result = die_mem; + return result; + } + } + } while (dwarf_siblingof(die, result) == 0); + return 0; + } + + template + static bool deep_first_search_by_pc(Dwarf_Die *parent_die, Dwarf_Addr pc, + CB cb) { + Dwarf_Die die_mem; + if (dwarf_child(parent_die, &die_mem) != 0) { + return false; + } + + bool branch_has_pc = false; + Dwarf_Die *die = &die_mem; + do { + bool declaration = false; + Dwarf_Attribute attr_mem; + dwarf_formflag(dwarf_attr(die, DW_AT_declaration, &attr_mem), + &declaration); + if (!declaration) { + // let's be curious and look deeper in the tree, function are + // not necessarily at the first level, but might be nested + // inside a namespace, structure, a function, an inlined + // function etc. + branch_has_pc = deep_first_search_by_pc(die, pc, cb); + } + if (!branch_has_pc) { + branch_has_pc = die_has_pc(die, pc); + } + if (branch_has_pc) { + cb(die); + } + } while (dwarf_siblingof(die, &die_mem) == 0); + return branch_has_pc; + } + + static const char *die_call_file(Dwarf_Die *die) { + Dwarf_Attribute attr_mem; + Dwarf_Word file_idx = 0; + + dwarf_formudata(dwarf_attr(die, DW_AT_call_file, &attr_mem), &file_idx); + + if (file_idx == 0) { + return 0; + } + + Dwarf_Die die_mem; + Dwarf_Die *cudie = dwarf_diecu(die, &die_mem, 0, 0); + if (!cudie) { + return 0; + } + + Dwarf_Files *files = 0; + size_t nfiles; + dwarf_getsrcfiles(cudie, &files, &nfiles); + if (!files) { + return 0; + } + + return dwarf_filesrc(files, file_idx, 0, 0); + } +}; +#endif // BACKWARD_HAS_DW == 1 + +#if BACKWARD_HAS_DWARF == 1 + +template <> +class TraceResolverLinuxImpl + : public TraceResolverLinuxBase { +public: + TraceResolverLinuxImpl() : _dwarf_loaded(false) {} + + ResolvedTrace resolve(ResolvedTrace trace) override { + // trace.addr is a virtual address in memory pointing to some code. + // Let's try to find from which loaded object it comes from. + // The loaded object can be yourself btw. + + Dl_info symbol_info; + int dladdr_result = 0; +#if defined(__GLIBC__) + link_map *link_map; + // We request the link map so we can get information about offsets + dladdr_result = + dladdr1(trace.addr, &symbol_info, reinterpret_cast(&link_map), + RTLD_DL_LINKMAP); +#else + // Android doesn't have dladdr1. Don't use the linker map. + dladdr_result = dladdr(trace.addr, &symbol_info); +#endif + if (!dladdr_result) { + return trace; // dat broken trace... + } + + // Now we get in symbol_info: + // .dli_fname: + // pathname of the shared object that contains the address. + // .dli_fbase: + // where the object is loaded in memory. + // .dli_sname: + // the name of the nearest symbol to trace.addr, we expect a + // function name. + // .dli_saddr: + // the exact address corresponding to .dli_sname. + // + // And in link_map: + // .l_addr: + // difference between the address in the ELF file and the address + // in memory + // l_name: + // absolute pathname where the object was found + + if (symbol_info.dli_sname) { + trace.object_function = demangle(symbol_info.dli_sname); + } + + if (!symbol_info.dli_fname) { + return trace; + } + + trace.object_filename = resolve_exec_path(symbol_info); + dwarf_fileobject &fobj = load_object_with_dwarf(symbol_info.dli_fname); + if (!fobj.dwarf_handle) { + return trace; // sad, we couldn't load the object :( + } + +#if defined(__GLIBC__) + // Convert the address to a module relative one by looking at + // the module's loading address in the link map + Dwarf_Addr address = reinterpret_cast(trace.addr) - + reinterpret_cast(link_map->l_addr); +#else + Dwarf_Addr address = reinterpret_cast(trace.addr); +#endif + + if (trace.object_function.empty()) { + symbol_cache_t::iterator it = fobj.symbol_cache.lower_bound(address); + + if (it != fobj.symbol_cache.end()) { + if (it->first != address) { + if (it != fobj.symbol_cache.begin()) { + --it; + } + } + trace.object_function = demangle(it->second.c_str()); + } + } + + // Get the Compilation Unit DIE for the address + Dwarf_Die die = find_die(fobj, address); + + if (!die) { + return trace; // this time we lost the game :/ + } + + // libdwarf doesn't give us direct access to its objects, it always + // allocates a copy for the caller. We keep that copy alive in a cache + // and we deallocate it later when it's no longer required. + die_cache_entry &die_object = get_die_cache(fobj, die); + if (die_object.isEmpty()) + return trace; // We have no line section for this DIE + + die_linemap_t::iterator it = die_object.line_section.lower_bound(address); + + if (it != die_object.line_section.end()) { + if (it->first != address) { + if (it == die_object.line_section.begin()) { + // If we are on the first item of the line section + // but the address does not match it means that + // the address is below the range of the DIE. Give up. + return trace; + } else { + --it; + } + } + } else { + return trace; // We didn't find the address. + } + + // Get the Dwarf_Line that the address points to and call libdwarf + // to get source file, line and column info. + Dwarf_Line line = die_object.line_buffer[it->second]; + Dwarf_Error error = DW_DLE_NE; + + char *filename; + if (dwarf_linesrc(line, &filename, &error) == DW_DLV_OK) { + trace.source.filename = std::string(filename); + dwarf_dealloc(fobj.dwarf_handle.get(), filename, DW_DLA_STRING); + } + + Dwarf_Unsigned number = 0; + if (dwarf_lineno(line, &number, &error) == DW_DLV_OK) { + trace.source.line = number; + } else { + trace.source.line = 0; + } + + if (dwarf_lineoff_b(line, &number, &error) == DW_DLV_OK) { + trace.source.col = number; + } else { + trace.source.col = 0; + } + + std::vector namespace_stack; + deep_first_search_by_pc(fobj, die, address, namespace_stack, + inliners_search_cb(trace, fobj, die)); + + dwarf_dealloc(fobj.dwarf_handle.get(), die, DW_DLA_DIE); + + return trace; + } + +public: + static int close_dwarf(Dwarf_Debug dwarf) { + return dwarf_finish(dwarf, NULL); + } + +private: + bool _dwarf_loaded; + + typedef details::handle > + dwarf_file_t; + + typedef details::handle > + dwarf_elf_t; + + typedef details::handle > + dwarf_handle_t; + + typedef std::map die_linemap_t; + + typedef std::map die_specmap_t; + + struct die_cache_entry { + die_specmap_t spec_section; + die_linemap_t line_section; + Dwarf_Line *line_buffer; + Dwarf_Signed line_count; + Dwarf_Line_Context line_context; + + inline bool isEmpty() { + return line_buffer == NULL || line_count == 0 || line_context == NULL || + line_section.empty(); + } + + die_cache_entry() : line_buffer(0), line_count(0), line_context(0) {} + + ~die_cache_entry() { + if (line_context) { + dwarf_srclines_dealloc_b(line_context); + } + } + }; + + typedef std::map die_cache_t; + + typedef std::map symbol_cache_t; + + struct dwarf_fileobject { + dwarf_file_t file_handle; + dwarf_elf_t elf_handle; + dwarf_handle_t dwarf_handle; + symbol_cache_t symbol_cache; + + // Die cache + die_cache_t die_cache; + die_cache_entry *current_cu; + }; + + typedef details::hashtable::type + fobj_dwarf_map_t; + fobj_dwarf_map_t _fobj_dwarf_map; + + static bool cstrings_eq(const char *a, const char *b) { + if (!a || !b) { + return false; + } + return strcmp(a, b) == 0; + } + + dwarf_fileobject &load_object_with_dwarf(const std::string &filename_object) { + + if (!_dwarf_loaded) { + // Set the ELF library operating version + // If that fails there's nothing we can do + _dwarf_loaded = elf_version(EV_CURRENT) != EV_NONE; + } + + fobj_dwarf_map_t::iterator it = _fobj_dwarf_map.find(filename_object); + if (it != _fobj_dwarf_map.end()) { + return it->second; + } + + // this new object is empty for now + dwarf_fileobject &r = _fobj_dwarf_map[filename_object]; + + dwarf_file_t file_handle; + file_handle.reset(open(filename_object.c_str(), O_RDONLY)); + if (file_handle.get() < 0) { + return r; + } + + // Try to get an ELF handle. We need to read the ELF sections + // because we want to see if there is a .gnu_debuglink section + // that points to a split debug file + dwarf_elf_t elf_handle; + elf_handle.reset(elf_begin(file_handle.get(), ELF_C_READ, NULL)); + if (!elf_handle) { + return r; + } + + const char *e_ident = elf_getident(elf_handle.get(), 0); + if (!e_ident) { + return r; + } + + // Get the number of sections + // We use the new APIs as elf_getshnum is deprecated + size_t shdrnum = 0; + if (elf_getshdrnum(elf_handle.get(), &shdrnum) == -1) { + return r; + } + + // Get the index to the string section + size_t shdrstrndx = 0; + if (elf_getshdrstrndx(elf_handle.get(), &shdrstrndx) == -1) { + return r; + } + + std::string debuglink; + // Iterate through the ELF sections to try to get a gnu_debuglink + // note and also to cache the symbol table. + // We go the preprocessor way to avoid having to create templated + // classes or using gelf (which might throw a compiler error if 64 bit + // is not supported +#define ELF_GET_DATA(ARCH) \ + Elf_Scn *elf_section = 0; \ + Elf_Data *elf_data = 0; \ + Elf##ARCH##_Shdr *section_header = 0; \ + Elf_Scn *symbol_section = 0; \ + size_t symbol_count = 0; \ + size_t symbol_strings = 0; \ + Elf##ARCH##_Sym *symbol = 0; \ + const char *section_name = 0; \ + \ + while ((elf_section = elf_nextscn(elf_handle.get(), elf_section)) != NULL) { \ + section_header = elf##ARCH##_getshdr(elf_section); \ + if (section_header == NULL) { \ + return r; \ + } \ + \ + if ((section_name = elf_strptr(elf_handle.get(), shdrstrndx, \ + section_header->sh_name)) == NULL) { \ + return r; \ + } \ + \ + if (cstrings_eq(section_name, ".gnu_debuglink")) { \ + elf_data = elf_getdata(elf_section, NULL); \ + if (elf_data && elf_data->d_size > 0) { \ + debuglink = \ + std::string(reinterpret_cast(elf_data->d_buf)); \ + } \ + } \ + \ + switch (section_header->sh_type) { \ + case SHT_SYMTAB: \ + symbol_section = elf_section; \ + symbol_count = section_header->sh_size / section_header->sh_entsize; \ + symbol_strings = section_header->sh_link; \ + break; \ + \ + /* We use .dynsyms as a last resort, we prefer .symtab */ \ + case SHT_DYNSYM: \ + if (!symbol_section) { \ + symbol_section = elf_section; \ + symbol_count = section_header->sh_size / section_header->sh_entsize; \ + symbol_strings = section_header->sh_link; \ + } \ + break; \ + } \ + } \ + \ + if (symbol_section && symbol_count && symbol_strings) { \ + elf_data = elf_getdata(symbol_section, NULL); \ + symbol = reinterpret_cast(elf_data->d_buf); \ + for (size_t i = 0; i < symbol_count; ++i) { \ + int type = ELF##ARCH##_ST_TYPE(symbol->st_info); \ + if (type == STT_FUNC && symbol->st_value > 0) { \ + r.symbol_cache[symbol->st_value] = std::string( \ + elf_strptr(elf_handle.get(), symbol_strings, symbol->st_name)); \ + } \ + ++symbol; \ + } \ + } + + if (e_ident[EI_CLASS] == ELFCLASS32) { + ELF_GET_DATA(32) + } else if (e_ident[EI_CLASS] == ELFCLASS64) { + // libelf might have been built without 64 bit support +#if __LIBELF64 + ELF_GET_DATA(64) +#endif + } + + if (!debuglink.empty()) { + // We have a debuglink section! Open an elf instance on that + // file instead. If we can't open the file, then return + // the elf handle we had already opened. + dwarf_file_t debuglink_file; + debuglink_file.reset(open(debuglink.c_str(), O_RDONLY)); + if (debuglink_file.get() > 0) { + dwarf_elf_t debuglink_elf; + debuglink_elf.reset(elf_begin(debuglink_file.get(), ELF_C_READ, NULL)); + + // If we have a valid elf handle, return the new elf handle + // and file handle and discard the original ones + if (debuglink_elf) { + elf_handle = move(debuglink_elf); + file_handle = move(debuglink_file); + } + } + } + + // Ok, we have a valid ELF handle, let's try to get debug symbols + Dwarf_Debug dwarf_debug; + Dwarf_Error error = DW_DLE_NE; + dwarf_handle_t dwarf_handle; + + int dwarf_result = dwarf_elf_init(elf_handle.get(), DW_DLC_READ, NULL, NULL, + &dwarf_debug, &error); + + // We don't do any special handling for DW_DLV_NO_ENTRY specially. + // If we get an error, or the file doesn't have debug information + // we just return. + if (dwarf_result != DW_DLV_OK) { + return r; + } + + dwarf_handle.reset(dwarf_debug); + + r.file_handle = move(file_handle); + r.elf_handle = move(elf_handle); + r.dwarf_handle = move(dwarf_handle); + + return r; + } + + die_cache_entry &get_die_cache(dwarf_fileobject &fobj, Dwarf_Die die) { + Dwarf_Error error = DW_DLE_NE; + + // Get the die offset, we use it as the cache key + Dwarf_Off die_offset; + if (dwarf_dieoffset(die, &die_offset, &error) != DW_DLV_OK) { + die_offset = 0; + } + + die_cache_t::iterator it = fobj.die_cache.find(die_offset); + + if (it != fobj.die_cache.end()) { + fobj.current_cu = &it->second; + return it->second; + } + + die_cache_entry &de = fobj.die_cache[die_offset]; + fobj.current_cu = &de; + + Dwarf_Addr line_addr; + Dwarf_Small table_count; + + // The addresses in the line section are not fully sorted (they might + // be sorted by block of code belonging to the same file), which makes + // it necessary to do so before searching is possible. + // + // As libdwarf allocates a copy of everything, let's get the contents + // of the line section and keep it around. We also create a map of + // program counter to line table indices so we can search by address + // and get the line buffer index. + // + // To make things more difficult, the same address can span more than + // one line, so we need to keep the index pointing to the first line + // by using insert instead of the map's [ operator. + + // Get the line context for the DIE + if (dwarf_srclines_b(die, 0, &table_count, &de.line_context, &error) == + DW_DLV_OK) { + // Get the source lines for this line context, to be deallocated + // later + if (dwarf_srclines_from_linecontext(de.line_context, &de.line_buffer, + &de.line_count, + &error) == DW_DLV_OK) { + + // Add all the addresses to our map + for (int i = 0; i < de.line_count; i++) { + if (dwarf_lineaddr(de.line_buffer[i], &line_addr, &error) != + DW_DLV_OK) { + line_addr = 0; + } + de.line_section.insert(std::pair(line_addr, i)); + } + } + } + + // For each CU, cache the function DIEs that contain the + // DW_AT_specification attribute. When building with -g3 the function + // DIEs are separated in declaration and specification, with the + // declaration containing only the name and parameters and the + // specification the low/high pc and other compiler attributes. + // + // We cache those specifications so we don't skip over the declarations, + // because they have no pc, and we can do namespace resolution for + // DWARF function names. + Dwarf_Debug dwarf = fobj.dwarf_handle.get(); + Dwarf_Die current_die = 0; + if (dwarf_child(die, ¤t_die, &error) == DW_DLV_OK) { + for (;;) { + Dwarf_Die sibling_die = 0; + + Dwarf_Half tag_value; + dwarf_tag(current_die, &tag_value, &error); + + if (tag_value == DW_TAG_subprogram || + tag_value == DW_TAG_inlined_subroutine) { + + Dwarf_Bool has_attr = 0; + if (dwarf_hasattr(current_die, DW_AT_specification, &has_attr, + &error) == DW_DLV_OK) { + if (has_attr) { + Dwarf_Attribute attr_mem; + if (dwarf_attr(current_die, DW_AT_specification, &attr_mem, + &error) == DW_DLV_OK) { + Dwarf_Off spec_offset = 0; + if (dwarf_formref(attr_mem, &spec_offset, &error) == + DW_DLV_OK) { + Dwarf_Off spec_die_offset; + if (dwarf_dieoffset(current_die, &spec_die_offset, &error) == + DW_DLV_OK) { + de.spec_section[spec_offset] = spec_die_offset; + } + } + } + dwarf_dealloc(dwarf, attr_mem, DW_DLA_ATTR); + } + } + } + + int result = dwarf_siblingof(dwarf, current_die, &sibling_die, &error); + if (result == DW_DLV_ERROR) { + break; + } else if (result == DW_DLV_NO_ENTRY) { + break; + } + + if (current_die != die) { + dwarf_dealloc(dwarf, current_die, DW_DLA_DIE); + current_die = 0; + } + + current_die = sibling_die; + } + } + return de; + } + + static Dwarf_Die get_referenced_die(Dwarf_Debug dwarf, Dwarf_Die die, + Dwarf_Half attr, bool global) { + Dwarf_Error error = DW_DLE_NE; + Dwarf_Attribute attr_mem; + + Dwarf_Die found_die = NULL; + if (dwarf_attr(die, attr, &attr_mem, &error) == DW_DLV_OK) { + Dwarf_Off offset; + int result = 0; + if (global) { + result = dwarf_global_formref(attr_mem, &offset, &error); + } else { + result = dwarf_formref(attr_mem, &offset, &error); + } + + if (result == DW_DLV_OK) { + if (dwarf_offdie(dwarf, offset, &found_die, &error) != DW_DLV_OK) { + found_die = NULL; + } + } + dwarf_dealloc(dwarf, attr_mem, DW_DLA_ATTR); + } + return found_die; + } + + static std::string get_referenced_die_name(Dwarf_Debug dwarf, Dwarf_Die die, + Dwarf_Half attr, bool global) { + Dwarf_Error error = DW_DLE_NE; + std::string value; + + Dwarf_Die found_die = get_referenced_die(dwarf, die, attr, global); + + if (found_die) { + char *name; + if (dwarf_diename(found_die, &name, &error) == DW_DLV_OK) { + if (name) { + value = std::string(name); + } + dwarf_dealloc(dwarf, name, DW_DLA_STRING); + } + dwarf_dealloc(dwarf, found_die, DW_DLA_DIE); + } + + return value; + } + + // Returns a spec DIE linked to the passed one. The caller should + // deallocate the DIE + static Dwarf_Die get_spec_die(dwarf_fileobject &fobj, Dwarf_Die die) { + Dwarf_Debug dwarf = fobj.dwarf_handle.get(); + Dwarf_Error error = DW_DLE_NE; + Dwarf_Off die_offset; + if (fobj.current_cu && + dwarf_die_CU_offset(die, &die_offset, &error) == DW_DLV_OK) { + die_specmap_t::iterator it = + fobj.current_cu->spec_section.find(die_offset); + + // If we have a DIE that completes the current one, check if + // that one has the pc we are looking for + if (it != fobj.current_cu->spec_section.end()) { + Dwarf_Die spec_die = 0; + if (dwarf_offdie(dwarf, it->second, &spec_die, &error) == DW_DLV_OK) { + return spec_die; + } + } + } + + // Maybe we have an abstract origin DIE with the function information? + return get_referenced_die(fobj.dwarf_handle.get(), die, + DW_AT_abstract_origin, true); + } + + static bool die_has_pc(dwarf_fileobject &fobj, Dwarf_Die die, Dwarf_Addr pc) { + Dwarf_Addr low_pc = 0, high_pc = 0; + Dwarf_Half high_pc_form = 0; + Dwarf_Form_Class return_class; + Dwarf_Error error = DW_DLE_NE; + Dwarf_Debug dwarf = fobj.dwarf_handle.get(); + bool has_lowpc = false; + bool has_highpc = false; + bool has_ranges = false; + + if (dwarf_lowpc(die, &low_pc, &error) == DW_DLV_OK) { + // If we have a low_pc check if there is a high pc. + // If we don't have a high pc this might mean we have a base + // address for the ranges list or just an address. + has_lowpc = true; + + if (dwarf_highpc_b(die, &high_pc, &high_pc_form, &return_class, &error) == + DW_DLV_OK) { + // We do have a high pc. In DWARF 4+ this is an offset from the + // low pc, but in earlier versions it's an absolute address. + + has_highpc = true; + // In DWARF 2/3 this would be a DW_FORM_CLASS_ADDRESS + if (return_class == DW_FORM_CLASS_CONSTANT) { + high_pc = low_pc + high_pc; + } + + // We have low and high pc, check if our address + // is in that range + return pc >= low_pc && pc < high_pc; + } + } else { + // Reset the low_pc, in case dwarf_lowpc failing set it to some + // undefined value. + low_pc = 0; + } + + // Check if DW_AT_ranges is present and search for the PC in the + // returned ranges list. We always add the low_pc, as it not set it will + // be 0, in case we had a DW_AT_low_pc and DW_AT_ranges pair + bool result = false; + + Dwarf_Attribute attr; + if (dwarf_attr(die, DW_AT_ranges, &attr, &error) == DW_DLV_OK) { + + Dwarf_Off offset; + if (dwarf_global_formref(attr, &offset, &error) == DW_DLV_OK) { + Dwarf_Ranges *ranges; + Dwarf_Signed ranges_count = 0; + Dwarf_Unsigned byte_count = 0; + + if (dwarf_get_ranges_a(dwarf, offset, die, &ranges, &ranges_count, + &byte_count, &error) == DW_DLV_OK) { + has_ranges = ranges_count != 0; + for (int i = 0; i < ranges_count; i++) { + if (ranges[i].dwr_addr1 != 0 && + pc >= ranges[i].dwr_addr1 + low_pc && + pc < ranges[i].dwr_addr2 + low_pc) { + result = true; + break; + } + } + dwarf_ranges_dealloc(dwarf, ranges, ranges_count); + } + } + } + + // Last attempt. We might have a single address set as low_pc. + if (!result && low_pc != 0 && pc == low_pc) { + result = true; + } + + // If we don't have lowpc, highpc and ranges maybe this DIE is a + // declaration that relies on a DW_AT_specification DIE that happens + // later. Use the specification cache we filled when we loaded this CU. + if (!result && (!has_lowpc && !has_highpc && !has_ranges)) { + Dwarf_Die spec_die = get_spec_die(fobj, die); + if (spec_die) { + result = die_has_pc(fobj, spec_die, pc); + dwarf_dealloc(dwarf, spec_die, DW_DLA_DIE); + } + } + + return result; + } + + static void get_type(Dwarf_Debug dwarf, Dwarf_Die die, std::string &type) { + Dwarf_Error error = DW_DLE_NE; + + Dwarf_Die child = 0; + if (dwarf_child(die, &child, &error) == DW_DLV_OK) { + get_type(dwarf, child, type); + } + + if (child) { + type.insert(0, "::"); + dwarf_dealloc(dwarf, child, DW_DLA_DIE); + } + + char *name; + if (dwarf_diename(die, &name, &error) == DW_DLV_OK) { + type.insert(0, std::string(name)); + dwarf_dealloc(dwarf, name, DW_DLA_STRING); + } else { + type.insert(0, ""); + } + } + + static std::string get_type_by_signature(Dwarf_Debug dwarf, Dwarf_Die die) { + Dwarf_Error error = DW_DLE_NE; + + Dwarf_Sig8 signature; + Dwarf_Bool has_attr = 0; + if (dwarf_hasattr(die, DW_AT_signature, &has_attr, &error) == DW_DLV_OK) { + if (has_attr) { + Dwarf_Attribute attr_mem; + if (dwarf_attr(die, DW_AT_signature, &attr_mem, &error) == DW_DLV_OK) { + if (dwarf_formsig8(attr_mem, &signature, &error) != DW_DLV_OK) { + return std::string(""); + } + } + dwarf_dealloc(dwarf, attr_mem, DW_DLA_ATTR); + } + } + + Dwarf_Unsigned next_cu_header; + Dwarf_Sig8 tu_signature; + std::string result; + bool found = false; + + while (dwarf_next_cu_header_d(dwarf, 0, 0, 0, 0, 0, 0, 0, &tu_signature, 0, + &next_cu_header, 0, &error) == DW_DLV_OK) { + + if (strncmp(signature.signature, tu_signature.signature, 8) == 0) { + Dwarf_Die type_cu_die = 0; + if (dwarf_siblingof_b(dwarf, 0, 0, &type_cu_die, &error) == DW_DLV_OK) { + Dwarf_Die child_die = 0; + if (dwarf_child(type_cu_die, &child_die, &error) == DW_DLV_OK) { + get_type(dwarf, child_die, result); + found = !result.empty(); + dwarf_dealloc(dwarf, child_die, DW_DLA_DIE); + } + dwarf_dealloc(dwarf, type_cu_die, DW_DLA_DIE); + } + } + } + + if (found) { + while (dwarf_next_cu_header_d(dwarf, 0, 0, 0, 0, 0, 0, 0, 0, 0, + &next_cu_header, 0, &error) == DW_DLV_OK) { + // Reset the cu header state. Unfortunately, libdwarf's + // next_cu_header API keeps its own iterator per Dwarf_Debug + // that can't be reset. We need to keep fetching elements until + // the end. + } + } else { + // If we couldn't resolve the type just print out the signature + std::ostringstream string_stream; + string_stream << "<0x" << std::hex << std::setfill('0'); + for (int i = 0; i < 8; ++i) { + string_stream << std::setw(2) << std::hex + << (int)(unsigned char)(signature.signature[i]); + } + string_stream << ">"; + result = string_stream.str(); + } + return result; + } + + struct type_context_t { + bool is_const; + bool is_typedef; + bool has_type; + bool has_name; + std::string text; + + type_context_t() + : is_const(false), is_typedef(false), has_type(false), has_name(false) { + } + }; + + // Types are resolved from right to left: we get the variable name first + // and then all specifiers (like const or pointer) in a chain of DW_AT_type + // DIEs. Call this function recursively until we get a complete type + // string. + static void set_parameter_string(dwarf_fileobject &fobj, Dwarf_Die die, + type_context_t &context) { + char *name; + Dwarf_Error error = DW_DLE_NE; + + // typedefs contain also the base type, so we skip it and only + // print the typedef name + if (!context.is_typedef) { + if (dwarf_diename(die, &name, &error) == DW_DLV_OK) { + if (!context.text.empty()) { + context.text.insert(0, " "); + } + context.text.insert(0, std::string(name)); + dwarf_dealloc(fobj.dwarf_handle.get(), name, DW_DLA_STRING); + } + } else { + context.is_typedef = false; + context.has_type = true; + if (context.is_const) { + context.text.insert(0, "const "); + context.is_const = false; + } + } + + bool next_type_is_const = false; + bool is_keyword = true; + + Dwarf_Half tag = 0; + Dwarf_Bool has_attr = 0; + if (dwarf_tag(die, &tag, &error) == DW_DLV_OK) { + switch (tag) { + case DW_TAG_structure_type: + case DW_TAG_union_type: + case DW_TAG_class_type: + case DW_TAG_enumeration_type: + context.has_type = true; + if (dwarf_hasattr(die, DW_AT_signature, &has_attr, &error) == + DW_DLV_OK) { + // If we have a signature it means the type is defined + // in .debug_types, so we need to load the DIE pointed + // at by the signature and resolve it + if (has_attr) { + std::string type = + get_type_by_signature(fobj.dwarf_handle.get(), die); + if (context.is_const) + type.insert(0, "const "); + + if (!context.text.empty()) + context.text.insert(0, " "); + context.text.insert(0, type); + } + + // Treat enums like typedefs, and skip printing its + // base type + context.is_typedef = (tag == DW_TAG_enumeration_type); + } + break; + case DW_TAG_const_type: + next_type_is_const = true; + break; + case DW_TAG_pointer_type: + context.text.insert(0, "*"); + break; + case DW_TAG_reference_type: + context.text.insert(0, "&"); + break; + case DW_TAG_restrict_type: + context.text.insert(0, "restrict "); + break; + case DW_TAG_rvalue_reference_type: + context.text.insert(0, "&&"); + break; + case DW_TAG_volatile_type: + context.text.insert(0, "volatile "); + break; + case DW_TAG_typedef: + // Propagate the const-ness to the next type + // as typedefs are linked to its base type + next_type_is_const = context.is_const; + context.is_typedef = true; + context.has_type = true; + break; + case DW_TAG_base_type: + context.has_type = true; + break; + case DW_TAG_formal_parameter: + context.has_name = true; + break; + default: + is_keyword = false; + break; + } + } + + if (!is_keyword && context.is_const) { + context.text.insert(0, "const "); + } + + context.is_const = next_type_is_const; + + Dwarf_Die ref = + get_referenced_die(fobj.dwarf_handle.get(), die, DW_AT_type, true); + if (ref) { + set_parameter_string(fobj, ref, context); + dwarf_dealloc(fobj.dwarf_handle.get(), ref, DW_DLA_DIE); + } + + if (!context.has_type && context.has_name) { + context.text.insert(0, "void "); + context.has_type = true; + } + } + + // Resolve the function return type and parameters + static void set_function_parameters(std::string &function_name, + std::vector &ns, + dwarf_fileobject &fobj, Dwarf_Die die) { + Dwarf_Debug dwarf = fobj.dwarf_handle.get(); + Dwarf_Error error = DW_DLE_NE; + Dwarf_Die current_die = 0; + std::string parameters; + bool has_spec = true; + // Check if we have a spec DIE. If we do we use it as it contains + // more information, like parameter names. + Dwarf_Die spec_die = get_spec_die(fobj, die); + if (!spec_die) { + has_spec = false; + spec_die = die; + } + + std::vector::const_iterator it = ns.begin(); + std::string ns_name; + for (it = ns.begin(); it < ns.end(); ++it) { + ns_name.append(*it).append("::"); + } + + if (!ns_name.empty()) { + function_name.insert(0, ns_name); + } + + // See if we have a function return type. It can be either on the + // current die or in its spec one (usually true for inlined functions) + std::string return_type = + get_referenced_die_name(dwarf, die, DW_AT_type, true); + if (return_type.empty()) { + return_type = get_referenced_die_name(dwarf, spec_die, DW_AT_type, true); + } + if (!return_type.empty()) { + return_type.append(" "); + function_name.insert(0, return_type); + } + + if (dwarf_child(spec_die, ¤t_die, &error) == DW_DLV_OK) { + for (;;) { + Dwarf_Die sibling_die = 0; + + Dwarf_Half tag_value; + dwarf_tag(current_die, &tag_value, &error); + + if (tag_value == DW_TAG_formal_parameter) { + // Ignore artificial (ie, compiler generated) parameters + bool is_artificial = false; + Dwarf_Attribute attr_mem; + if (dwarf_attr(current_die, DW_AT_artificial, &attr_mem, &error) == + DW_DLV_OK) { + Dwarf_Bool flag = 0; + if (dwarf_formflag(attr_mem, &flag, &error) == DW_DLV_OK) { + is_artificial = flag != 0; + } + dwarf_dealloc(dwarf, attr_mem, DW_DLA_ATTR); + } + + if (!is_artificial) { + type_context_t context; + set_parameter_string(fobj, current_die, context); + + if (parameters.empty()) { + parameters.append("("); + } else { + parameters.append(", "); + } + parameters.append(context.text); + } + } + + int result = dwarf_siblingof(dwarf, current_die, &sibling_die, &error); + if (result == DW_DLV_ERROR) { + break; + } else if (result == DW_DLV_NO_ENTRY) { + break; + } + + if (current_die != die) { + dwarf_dealloc(dwarf, current_die, DW_DLA_DIE); + current_die = 0; + } + + current_die = sibling_die; + } + } + if (parameters.empty()) + parameters = "("; + parameters.append(")"); + + // If we got a spec DIE we need to deallocate it + if (has_spec) + dwarf_dealloc(dwarf, spec_die, DW_DLA_DIE); + + function_name.append(parameters); + } + + // defined here because in C++98, template function cannot take locally + // defined types... grrr. + struct inliners_search_cb { + void operator()(Dwarf_Die die, std::vector &ns) { + Dwarf_Error error = DW_DLE_NE; + Dwarf_Half tag_value; + Dwarf_Attribute attr_mem; + Dwarf_Debug dwarf = fobj.dwarf_handle.get(); + + dwarf_tag(die, &tag_value, &error); + + switch (tag_value) { + char *name; + case DW_TAG_subprogram: + if (!trace.source.function.empty()) + break; + if (dwarf_diename(die, &name, &error) == DW_DLV_OK) { + trace.source.function = std::string(name); + dwarf_dealloc(dwarf, name, DW_DLA_STRING); + } else { + // We don't have a function name in this DIE. + // Check if there is a referenced non-defining + // declaration. + trace.source.function = + get_referenced_die_name(dwarf, die, DW_AT_abstract_origin, true); + if (trace.source.function.empty()) { + trace.source.function = + get_referenced_die_name(dwarf, die, DW_AT_specification, true); + } + } + + // Append the function parameters, if available + set_function_parameters(trace.source.function, ns, fobj, die); + + // If the object function name is empty, it's possible that + // there is no dynamic symbol table (maybe the executable + // was stripped or not built with -rdynamic). See if we have + // a DWARF linkage name to use instead. We try both + // linkage_name and MIPS_linkage_name because the MIPS tag + // was the unofficial one until it was adopted in DWARF4. + // Old gcc versions generate MIPS_linkage_name + if (trace.object_function.empty()) { + details::demangler demangler; + + if (dwarf_attr(die, DW_AT_linkage_name, &attr_mem, &error) != + DW_DLV_OK) { + if (dwarf_attr(die, DW_AT_MIPS_linkage_name, &attr_mem, &error) != + DW_DLV_OK) { + break; + } + } + + char *linkage; + if (dwarf_formstring(attr_mem, &linkage, &error) == DW_DLV_OK) { + trace.object_function = demangler.demangle(linkage); + dwarf_dealloc(dwarf, linkage, DW_DLA_STRING); + } + dwarf_dealloc(dwarf, attr_mem, DW_DLA_ATTR); + } + break; + + case DW_TAG_inlined_subroutine: + ResolvedTrace::SourceLoc sloc; + + if (dwarf_diename(die, &name, &error) == DW_DLV_OK) { + sloc.function = std::string(name); + dwarf_dealloc(dwarf, name, DW_DLA_STRING); + } else { + // We don't have a name for this inlined DIE, it could + // be that there is an abstract origin instead. + // Get the DW_AT_abstract_origin value, which is a + // reference to the source DIE and try to get its name + sloc.function = + get_referenced_die_name(dwarf, die, DW_AT_abstract_origin, true); + } + + set_function_parameters(sloc.function, ns, fobj, die); + + std::string file = die_call_file(dwarf, die, cu_die); + if (!file.empty()) + sloc.filename = file; + + Dwarf_Unsigned number = 0; + if (dwarf_attr(die, DW_AT_call_line, &attr_mem, &error) == DW_DLV_OK) { + if (dwarf_formudata(attr_mem, &number, &error) == DW_DLV_OK) { + sloc.line = number; + } + dwarf_dealloc(dwarf, attr_mem, DW_DLA_ATTR); + } + + if (dwarf_attr(die, DW_AT_call_column, &attr_mem, &error) == + DW_DLV_OK) { + if (dwarf_formudata(attr_mem, &number, &error) == DW_DLV_OK) { + sloc.col = number; + } + dwarf_dealloc(dwarf, attr_mem, DW_DLA_ATTR); + } + + trace.inliners.push_back(sloc); + break; + }; + } + ResolvedTrace &trace; + dwarf_fileobject &fobj; + Dwarf_Die cu_die; + inliners_search_cb(ResolvedTrace &t, dwarf_fileobject &f, Dwarf_Die c) + : trace(t), fobj(f), cu_die(c) {} + }; + + static Dwarf_Die find_fundie_by_pc(dwarf_fileobject &fobj, + Dwarf_Die parent_die, Dwarf_Addr pc, + Dwarf_Die result) { + Dwarf_Die current_die = 0; + Dwarf_Error error = DW_DLE_NE; + Dwarf_Debug dwarf = fobj.dwarf_handle.get(); + + if (dwarf_child(parent_die, ¤t_die, &error) != DW_DLV_OK) { + return NULL; + } + + for (;;) { + Dwarf_Die sibling_die = 0; + Dwarf_Half tag_value; + dwarf_tag(current_die, &tag_value, &error); + + switch (tag_value) { + case DW_TAG_subprogram: + case DW_TAG_inlined_subroutine: + if (die_has_pc(fobj, current_die, pc)) { + return current_die; + } + }; + bool declaration = false; + Dwarf_Attribute attr_mem; + if (dwarf_attr(current_die, DW_AT_declaration, &attr_mem, &error) == + DW_DLV_OK) { + Dwarf_Bool flag = 0; + if (dwarf_formflag(attr_mem, &flag, &error) == DW_DLV_OK) { + declaration = flag != 0; + } + dwarf_dealloc(dwarf, attr_mem, DW_DLA_ATTR); + } + + if (!declaration) { + // let's be curious and look deeper in the tree, functions are + // not necessarily at the first level, but might be nested + // inside a namespace, structure, a function, an inlined + // function etc. + Dwarf_Die die_mem = 0; + Dwarf_Die indie = find_fundie_by_pc(fobj, current_die, pc, die_mem); + if (indie) { + result = die_mem; + return result; + } + } + + int res = dwarf_siblingof(dwarf, current_die, &sibling_die, &error); + if (res == DW_DLV_ERROR) { + return NULL; + } else if (res == DW_DLV_NO_ENTRY) { + break; + } + + if (current_die != parent_die) { + dwarf_dealloc(dwarf, current_die, DW_DLA_DIE); + current_die = 0; + } + + current_die = sibling_die; + } + return NULL; + } + + template + static bool deep_first_search_by_pc(dwarf_fileobject &fobj, + Dwarf_Die parent_die, Dwarf_Addr pc, + std::vector &ns, CB cb) { + Dwarf_Die current_die = 0; + Dwarf_Debug dwarf = fobj.dwarf_handle.get(); + Dwarf_Error error = DW_DLE_NE; + + if (dwarf_child(parent_die, ¤t_die, &error) != DW_DLV_OK) { + return false; + } + + bool branch_has_pc = false; + bool has_namespace = false; + for (;;) { + Dwarf_Die sibling_die = 0; + + Dwarf_Half tag; + if (dwarf_tag(current_die, &tag, &error) == DW_DLV_OK) { + if (tag == DW_TAG_namespace || tag == DW_TAG_class_type) { + char *ns_name = NULL; + if (dwarf_diename(current_die, &ns_name, &error) == DW_DLV_OK) { + if (ns_name) { + ns.push_back(std::string(ns_name)); + } else { + ns.push_back(""); + } + dwarf_dealloc(dwarf, ns_name, DW_DLA_STRING); + } else { + ns.push_back(""); + } + has_namespace = true; + } + } + + bool declaration = false; + Dwarf_Attribute attr_mem; + if (tag != DW_TAG_class_type && + dwarf_attr(current_die, DW_AT_declaration, &attr_mem, &error) == + DW_DLV_OK) { + Dwarf_Bool flag = 0; + if (dwarf_formflag(attr_mem, &flag, &error) == DW_DLV_OK) { + declaration = flag != 0; + } + dwarf_dealloc(dwarf, attr_mem, DW_DLA_ATTR); + } + + if (!declaration) { + // let's be curious and look deeper in the tree, function are + // not necessarily at the first level, but might be nested + // inside a namespace, structure, a function, an inlined + // function etc. + branch_has_pc = deep_first_search_by_pc(fobj, current_die, pc, ns, cb); + } + + if (!branch_has_pc) { + branch_has_pc = die_has_pc(fobj, current_die, pc); + } + + if (branch_has_pc) { + cb(current_die, ns); + } + + int result = dwarf_siblingof(dwarf, current_die, &sibling_die, &error); + if (result == DW_DLV_ERROR) { + return false; + } else if (result == DW_DLV_NO_ENTRY) { + break; + } + + if (current_die != parent_die) { + dwarf_dealloc(dwarf, current_die, DW_DLA_DIE); + current_die = 0; + } + + if (has_namespace) { + has_namespace = false; + ns.pop_back(); + } + current_die = sibling_die; + } + + if (has_namespace) { + ns.pop_back(); + } + return branch_has_pc; + } + + static std::string die_call_file(Dwarf_Debug dwarf, Dwarf_Die die, + Dwarf_Die cu_die) { + Dwarf_Attribute attr_mem; + Dwarf_Error error = DW_DLE_NE; + Dwarf_Unsigned file_index; + + std::string file; + + if (dwarf_attr(die, DW_AT_call_file, &attr_mem, &error) == DW_DLV_OK) { + if (dwarf_formudata(attr_mem, &file_index, &error) != DW_DLV_OK) { + file_index = 0; + } + dwarf_dealloc(dwarf, attr_mem, DW_DLA_ATTR); + + if (file_index == 0) { + return file; + } + + char **srcfiles = 0; + Dwarf_Signed file_count = 0; + if (dwarf_srcfiles(cu_die, &srcfiles, &file_count, &error) == DW_DLV_OK) { + if (file_count > 0 && file_index <= static_cast(file_count)) { + file = std::string(srcfiles[file_index - 1]); + } + + // Deallocate all strings! + for (int i = 0; i < file_count; ++i) { + dwarf_dealloc(dwarf, srcfiles[i], DW_DLA_STRING); + } + dwarf_dealloc(dwarf, srcfiles, DW_DLA_LIST); + } + } + return file; + } + + Dwarf_Die find_die(dwarf_fileobject &fobj, Dwarf_Addr addr) { + // Let's get to work! First see if we have a debug_aranges section so + // we can speed up the search + + Dwarf_Debug dwarf = fobj.dwarf_handle.get(); + Dwarf_Error error = DW_DLE_NE; + Dwarf_Arange *aranges; + Dwarf_Signed arange_count; + + Dwarf_Die returnDie; + bool found = false; + if (dwarf_get_aranges(dwarf, &aranges, &arange_count, &error) != + DW_DLV_OK) { + aranges = NULL; + } + + if (aranges) { + // We have aranges. Get the one where our address is. + Dwarf_Arange arange; + if (dwarf_get_arange(aranges, arange_count, addr, &arange, &error) == + DW_DLV_OK) { + + // We found our address. Get the compilation-unit DIE offset + // represented by the given address range. + Dwarf_Off cu_die_offset; + if (dwarf_get_cu_die_offset(arange, &cu_die_offset, &error) == + DW_DLV_OK) { + // Get the DIE at the offset returned by the aranges search. + // We set is_info to 1 to specify that the offset is from + // the .debug_info section (and not .debug_types) + int dwarf_result = + dwarf_offdie_b(dwarf, cu_die_offset, 1, &returnDie, &error); + + found = dwarf_result == DW_DLV_OK; + } + dwarf_dealloc(dwarf, arange, DW_DLA_ARANGE); + } + } + + if (found) + return returnDie; // The caller is responsible for freeing the die + + // The search for aranges failed. Try to find our address by scanning + // all compilation units. + Dwarf_Unsigned next_cu_header; + Dwarf_Half tag = 0; + returnDie = 0; + + while (!found && + dwarf_next_cu_header_d(dwarf, 1, 0, 0, 0, 0, 0, 0, 0, 0, + &next_cu_header, 0, &error) == DW_DLV_OK) { + + if (returnDie) + dwarf_dealloc(dwarf, returnDie, DW_DLA_DIE); + + if (dwarf_siblingof(dwarf, 0, &returnDie, &error) == DW_DLV_OK) { + if ((dwarf_tag(returnDie, &tag, &error) == DW_DLV_OK) && + tag == DW_TAG_compile_unit) { + if (die_has_pc(fobj, returnDie, addr)) { + found = true; + } + } + } + } + + if (found) { + while (dwarf_next_cu_header_d(dwarf, 1, 0, 0, 0, 0, 0, 0, 0, 0, + &next_cu_header, 0, &error) == DW_DLV_OK) { + // Reset the cu header state. Libdwarf's next_cu_header API + // keeps its own iterator per Dwarf_Debug that can't be reset. + // We need to keep fetching elements until the end. + } + } + + if (found) + return returnDie; + + // We couldn't find any compilation units with ranges or a high/low pc. + // Try again by looking at all DIEs in all compilation units. + Dwarf_Die cudie; + while (dwarf_next_cu_header_d(dwarf, 1, 0, 0, 0, 0, 0, 0, 0, 0, + &next_cu_header, 0, &error) == DW_DLV_OK) { + if (dwarf_siblingof(dwarf, 0, &cudie, &error) == DW_DLV_OK) { + Dwarf_Die die_mem = 0; + Dwarf_Die resultDie = find_fundie_by_pc(fobj, cudie, addr, die_mem); + + if (resultDie) { + found = true; + break; + } + } + } + + if (found) { + while (dwarf_next_cu_header_d(dwarf, 1, 0, 0, 0, 0, 0, 0, 0, 0, + &next_cu_header, 0, &error) == DW_DLV_OK) { + // Reset the cu header state. Libdwarf's next_cu_header API + // keeps its own iterator per Dwarf_Debug that can't be reset. + // We need to keep fetching elements until the end. + } + } + + if (found) + return cudie; + + // We failed. + return NULL; + } +}; +#endif // BACKWARD_HAS_DWARF == 1 + +template <> +class TraceResolverImpl + : public TraceResolverLinuxImpl {}; + +#endif // BACKWARD_SYSTEM_LINUX + +#ifdef BACKWARD_SYSTEM_DARWIN + +template class TraceResolverDarwinImpl; + +template <> +class TraceResolverDarwinImpl + : public TraceResolverImplBase { +public: + void load_addresses(void *const*addresses, int address_count) override { + if (address_count == 0) { + return; + } + _symbols.reset(backtrace_symbols(addresses, address_count)); + } + + ResolvedTrace resolve(ResolvedTrace trace) override { + // parse: + // + + char *filename = _symbols[trace.idx]; + + // skip " " + while (*filename && *filename != ' ') + filename++; + while (*filename == ' ') + filename++; + + // find start of from end ( may contain a space) + char *p = filename + strlen(filename) - 1; + // skip to start of " + " + while (p > filename && *p != ' ') + p--; + while (p > filename && *p == ' ') + p--; + while (p > filename && *p != ' ') + p--; + while (p > filename && *p == ' ') + p--; + char *funcname_end = p + 1; + + // skip to start of "" + while (p > filename && *p != ' ') + p--; + char *funcname = p + 1; + + // skip to start of " " + while (p > filename && *p == ' ') + p--; + while (p > filename && *p != ' ') + p--; + while (p > filename && *p == ' ') + p--; + + // skip "", handling the case where it contains a + char *filename_end = p + 1; + if (p == filename) { + // something went wrong, give up + filename_end = filename + strlen(filename); + funcname = filename_end; + } + trace.object_filename.assign( + filename, filename_end); // ok even if filename_end is the ending \0 + // (then we assign entire string) + + if (*funcname) { // if it's not end of string + *funcname_end = '\0'; + + trace.object_function = this->demangle(funcname); + trace.object_function += " "; + trace.object_function += (funcname_end + 1); + trace.source.function = trace.object_function; // we cannot do better. + } + return trace; + } + +private: + details::handle _symbols; +}; + +template <> +class TraceResolverImpl + : public TraceResolverDarwinImpl {}; + +#endif // BACKWARD_SYSTEM_DARWIN + +#ifdef BACKWARD_SYSTEM_WINDOWS + +// Load all symbol info +// Based on: +// https://stackoverflow.com/questions/6205981/windows-c-stack-trace-from-a-running-app/28276227#28276227 + +struct module_data { + std::string image_name; + std::string module_name; + void *base_address; + DWORD load_size; +}; + +class get_mod_info { + HANDLE process; + static const int buffer_length = 4096; + +public: + get_mod_info(HANDLE h) : process(h) {} + + module_data operator()(HMODULE module) { + module_data ret; + char temp[buffer_length]; + MODULEINFO mi; + + GetModuleInformation(process, module, &mi, sizeof(mi)); + ret.base_address = mi.lpBaseOfDll; + ret.load_size = mi.SizeOfImage; + + GetModuleFileNameExA(process, module, temp, sizeof(temp)); + ret.image_name = temp; + GetModuleBaseNameA(process, module, temp, sizeof(temp)); + ret.module_name = temp; + std::vector img(ret.image_name.begin(), ret.image_name.end()); + std::vector mod(ret.module_name.begin(), ret.module_name.end()); + SymLoadModule64(process, 0, &img[0], &mod[0], (DWORD64)ret.base_address, + ret.load_size); + return ret; + } +}; + +template <> class TraceResolverImpl + : public TraceResolverImplBase { +public: + TraceResolverImpl() { + + HANDLE process = GetCurrentProcess(); + + std::vector modules; + DWORD cbNeeded; + std::vector module_handles(1); + SymInitialize(process, NULL, false); + DWORD symOptions = SymGetOptions(); + symOptions |= SYMOPT_LOAD_LINES | SYMOPT_UNDNAME; + SymSetOptions(symOptions); + EnumProcessModules(process, &module_handles[0], + module_handles.size() * sizeof(HMODULE), &cbNeeded); + module_handles.resize(cbNeeded / sizeof(HMODULE)); + EnumProcessModules(process, &module_handles[0], + module_handles.size() * sizeof(HMODULE), &cbNeeded); + std::transform(module_handles.begin(), module_handles.end(), + std::back_inserter(modules), get_mod_info(process)); + void *base = modules[0].base_address; + IMAGE_NT_HEADERS *h = ImageNtHeader(base); + image_type = h->FileHeader.Machine; + } + + static const int max_sym_len = 255; + struct symbol_t { + SYMBOL_INFO sym; + char buffer[max_sym_len]; + } sym; + + DWORD64 displacement; + + ResolvedTrace resolve(ResolvedTrace t) override { + HANDLE process = GetCurrentProcess(); + + char name[256]; + + memset(&sym, 0, sizeof(sym)); + sym.sym.SizeOfStruct = sizeof(SYMBOL_INFO); + sym.sym.MaxNameLen = max_sym_len; + + if (!SymFromAddr(process, (ULONG64)t.addr, &displacement, &sym.sym)) { + // TODO: error handling everywhere + char* lpMsgBuf; + DWORD dw = GetLastError(); + + if (FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER | + FORMAT_MESSAGE_FROM_SYSTEM | + FORMAT_MESSAGE_IGNORE_INSERTS, + NULL, dw, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), + (char*)&lpMsgBuf, 0, NULL)) { + std::fprintf(stderr, "%s\n", lpMsgBuf); + LocalFree(lpMsgBuf); + } + + // abort(); + } + UnDecorateSymbolName(sym.sym.Name, (PSTR)name, 256, UNDNAME_COMPLETE); + + DWORD offset = 0; + IMAGEHLP_LINE line; + if (SymGetLineFromAddr(process, (ULONG64)t.addr, &offset, &line)) { + t.object_filename = line.FileName; + t.source.filename = line.FileName; + t.source.line = line.LineNumber; + t.source.col = offset; + } + + t.source.function = name; + t.object_filename = ""; + t.object_function = name; + + return t; + } + + DWORD machine_type() const { return image_type; } + +private: + DWORD image_type; +}; + +#endif + +class TraceResolver : public TraceResolverImpl {}; + +/*************** CODE SNIPPET ***************/ + +class SourceFile { +public: + typedef std::vector > lines_t; + + SourceFile() {} + SourceFile(const std::string &path) { + // 1. If BACKWARD_CXX_SOURCE_PREFIXES is set then assume it contains + // a colon-separated list of path prefixes. Try prepending each + // to the given path until a valid file is found. + const std::vector &prefixes = get_paths_from_env_variable(); + for (size_t i = 0; i < prefixes.size(); ++i) { + // Double slashes (//) should not be a problem. + std::string new_path = prefixes[i] + '/' + path; + _file.reset(new std::ifstream(new_path.c_str())); + if (is_open()) + break; + } + // 2. If no valid file found then fallback to opening the path as-is. + if (!_file || !is_open()) { + _file.reset(new std::ifstream(path.c_str())); + } + } + bool is_open() const { return _file->is_open(); } + + lines_t &get_lines(unsigned line_start, unsigned line_count, lines_t &lines) { + using namespace std; + // This function make uses of the dumbest algo ever: + // 1) seek(0) + // 2) read lines one by one and discard until line_start + // 3) read line one by one until line_start + line_count + // + // If you are getting snippets many time from the same file, it is + // somewhat a waste of CPU, feel free to benchmark and propose a + // better solution ;) + + _file->clear(); + _file->seekg(0); + string line; + unsigned line_idx; + + for (line_idx = 1; line_idx < line_start; ++line_idx) { + std::getline(*_file, line); + if (!*_file) { + return lines; + } + } + + // think of it like a lambda in C++98 ;) + // but look, I will reuse it two times! + // What a good boy am I. + struct isspace { + bool operator()(char c) { return std::isspace(c); } + }; + + bool started = false; + for (; line_idx < line_start + line_count; ++line_idx) { + getline(*_file, line); + if (!*_file) { + return lines; + } + if (!started) { + if (std::find_if(line.begin(), line.end(), not_isspace()) == line.end()) + continue; + started = true; + } + lines.push_back(make_pair(line_idx, line)); + } + + lines.erase( + std::find_if(lines.rbegin(), lines.rend(), not_isempty()).base(), + lines.end()); + return lines; + } + + lines_t get_lines(unsigned line_start, unsigned line_count) { + lines_t lines; + return get_lines(line_start, line_count, lines); + } + + // there is no find_if_not in C++98, lets do something crappy to + // workaround. + struct not_isspace { + bool operator()(char c) { return !std::isspace(c); } + }; + // and define this one here because C++98 is not happy with local defined + // struct passed to template functions, fuuuu. + struct not_isempty { + bool operator()(const lines_t::value_type &p) { + return !(std::find_if(p.second.begin(), p.second.end(), not_isspace()) == + p.second.end()); + } + }; + + void swap(SourceFile &b) { _file.swap(b._file); } + +#ifdef BACKWARD_ATLEAST_CXX11 + SourceFile(SourceFile &&from) : _file(nullptr) { swap(from); } + SourceFile &operator=(SourceFile &&from) { + swap(from); + return *this; + } +#else + explicit SourceFile(const SourceFile &from) { + // some sort of poor man's move semantic. + swap(const_cast(from)); + } + SourceFile &operator=(const SourceFile &from) { + // some sort of poor man's move semantic. + swap(const_cast(from)); + return *this; + } +#endif + +private: + details::handle > + _file; + + std::vector get_paths_from_env_variable_impl() { + std::vector paths; + const char *prefixes_str = std::getenv("BACKWARD_CXX_SOURCE_PREFIXES"); + if (prefixes_str && prefixes_str[0]) { + paths = details::split_source_prefixes(prefixes_str); + } + return paths; + } + + const std::vector &get_paths_from_env_variable() { + static std::vector paths = get_paths_from_env_variable_impl(); + return paths; + } + +#ifdef BACKWARD_ATLEAST_CXX11 + SourceFile(const SourceFile &) = delete; + SourceFile &operator=(const SourceFile &) = delete; +#endif +}; + +class SnippetFactory { +public: + typedef SourceFile::lines_t lines_t; + + lines_t get_snippet(const std::string &filename, unsigned line_start, + unsigned context_size) { + + SourceFile &src_file = get_src_file(filename); + unsigned start = line_start - context_size / 2; + return src_file.get_lines(start, context_size); + } + + lines_t get_combined_snippet(const std::string &filename_a, unsigned line_a, + const std::string &filename_b, unsigned line_b, + unsigned context_size) { + SourceFile &src_file_a = get_src_file(filename_a); + SourceFile &src_file_b = get_src_file(filename_b); + + lines_t lines = + src_file_a.get_lines(line_a - context_size / 4, context_size / 2); + src_file_b.get_lines(line_b - context_size / 4, context_size / 2, lines); + return lines; + } + + lines_t get_coalesced_snippet(const std::string &filename, unsigned line_a, + unsigned line_b, unsigned context_size) { + SourceFile &src_file = get_src_file(filename); + + using std::max; + using std::min; + unsigned a = min(line_a, line_b); + unsigned b = max(line_a, line_b); + + if ((b - a) < (context_size / 3)) { + return src_file.get_lines((a + b - context_size + 1) / 2, context_size); + } + + lines_t lines = src_file.get_lines(a - context_size / 4, context_size / 2); + src_file.get_lines(b - context_size / 4, context_size / 2, lines); + return lines; + } + +private: + typedef details::hashtable::type src_files_t; + src_files_t _src_files; + + SourceFile &get_src_file(const std::string &filename) { + src_files_t::iterator it = _src_files.find(filename); + if (it != _src_files.end()) { + return it->second; + } + SourceFile &new_src_file = _src_files[filename]; + new_src_file = SourceFile(filename); + return new_src_file; + } +}; + +/*************** PRINTER ***************/ + +namespace ColorMode { +enum type { automatic, never, always }; +} + +class cfile_streambuf : public std::streambuf { +public: + cfile_streambuf(FILE *_sink) : sink(_sink) {} + int_type underflow() override { return traits_type::eof(); } + int_type overflow(int_type ch) override { + if (traits_type::not_eof(ch) && fputc(ch, sink) != EOF) { + return ch; + } + return traits_type::eof(); + } + + std::streamsize xsputn(const char_type *s, std::streamsize count) override { + return static_cast( + fwrite(s, sizeof *s, static_cast(count), sink)); + } + +#ifdef BACKWARD_ATLEAST_CXX11 +public: + cfile_streambuf(const cfile_streambuf &) = delete; + cfile_streambuf &operator=(const cfile_streambuf &) = delete; +#else +private: + cfile_streambuf(const cfile_streambuf &); + cfile_streambuf &operator=(const cfile_streambuf &); +#endif + +private: + FILE *sink; + std::vector buffer; +}; + +#ifdef BACKWARD_SYSTEM_LINUX + +namespace Color { +enum type { yellow = 33, purple = 35, reset = 39 }; +} // namespace Color + +class Colorize { +public: + Colorize(std::ostream &os) : _os(os), _reset(false), _enabled(false) {} + + void activate(ColorMode::type mode) { _enabled = mode == ColorMode::always; } + + void activate(ColorMode::type mode, FILE *fp) { activate(mode, fileno(fp)); } + + void set_color(Color::type ccode) { + if (!_enabled) + return; + + // I assume that the terminal can handle basic colors. Seriously I + // don't want to deal with all the termcap shit. + _os << "\033[" << static_cast(ccode) << "m"; + _reset = (ccode != Color::reset); + } + + ~Colorize() { + if (_reset) { + set_color(Color::reset); + } + } + +private: + void activate(ColorMode::type mode, int fd) { + activate(mode == ColorMode::automatic && isatty(fd) ? ColorMode::always + : mode); + } + + std::ostream &_os; + bool _reset; + bool _enabled; +}; + +#else // ndef BACKWARD_SYSTEM_LINUX + +namespace Color { +enum type { yellow = 0, purple = 0, reset = 0 }; +} // namespace Color + +class Colorize { +public: + Colorize(std::ostream &) {} + void activate(ColorMode::type) {} + void activate(ColorMode::type, FILE *) {} + void set_color(Color::type) {} +}; + +#endif // BACKWARD_SYSTEM_LINUX + +class Printer { +public: + bool snippet; + ColorMode::type color_mode; + bool address; + bool object; + int inliner_context_size; + int trace_context_size; + + Printer() + : snippet(true), color_mode(ColorMode::automatic), address(false), + object(false), inliner_context_size(5), trace_context_size(7) {} + + template FILE *print(ST &st, FILE *fp = stderr) { + cfile_streambuf obuf(fp); + std::ostream os(&obuf); + Colorize colorize(os); + colorize.activate(color_mode, fp); + print_stacktrace(st, os, colorize); + return fp; + } + + template std::ostream &print(ST &st, std::ostream &os) { + Colorize colorize(os); + colorize.activate(color_mode); + print_stacktrace(st, os, colorize); + return os; + } + + template + FILE *print(IT begin, IT end, FILE *fp = stderr, size_t thread_id = 0) { + cfile_streambuf obuf(fp); + std::ostream os(&obuf); + Colorize colorize(os); + colorize.activate(color_mode, fp); + print_stacktrace(begin, end, os, thread_id, colorize); + return fp; + } + + template + std::ostream &print(IT begin, IT end, std::ostream &os, + size_t thread_id = 0) { + Colorize colorize(os); + colorize.activate(color_mode); + print_stacktrace(begin, end, os, thread_id, colorize); + return os; + } + + TraceResolver const &resolver() const { return _resolver; } + +private: + TraceResolver _resolver; + SnippetFactory _snippets; + + template + void print_stacktrace(ST &st, std::ostream &os, Colorize &colorize) { + print_header(os, st.thread_id()); + _resolver.load_stacktrace(st); + for (size_t trace_idx = st.size(); trace_idx > 0; --trace_idx) { + print_trace(os, _resolver.resolve(st[trace_idx - 1]), colorize); + } + } + + template + void print_stacktrace(IT begin, IT end, std::ostream &os, size_t thread_id, + Colorize &colorize) { + print_header(os, thread_id); + for (; begin != end; ++begin) { + print_trace(os, *begin, colorize); + } + } + + void print_header(std::ostream &os, size_t thread_id) { + os << "Stack trace (most recent call last)"; + if (thread_id) { + os << " in thread " << thread_id; + } + os << ":\n"; + } + + void print_trace(std::ostream &os, const ResolvedTrace &trace, + Colorize &colorize) { + os << "#" << std::left << std::setw(2) << trace.idx << std::right; + bool already_indented = true; + + if (!trace.source.filename.size() || object) { + os << " Object \"" << trace.object_filename << "\", at " << trace.addr + << ", in " << trace.object_function << "\n"; + already_indented = false; + } + + for (size_t inliner_idx = trace.inliners.size(); inliner_idx > 0; + --inliner_idx) { + if (!already_indented) { + os << " "; + } + const ResolvedTrace::SourceLoc &inliner_loc = + trace.inliners[inliner_idx - 1]; + print_source_loc(os, " | ", inliner_loc); + if (snippet) { + print_snippet(os, " | ", inliner_loc, colorize, Color::purple, + inliner_context_size); + } + already_indented = false; + } + + if (trace.source.filename.size()) { + if (!already_indented) { + os << " "; + } + print_source_loc(os, " ", trace.source, trace.addr); + if (snippet) { + print_snippet(os, " ", trace.source, colorize, Color::yellow, + trace_context_size); + } + } + } + + void print_snippet(std::ostream &os, const char *indent, + const ResolvedTrace::SourceLoc &source_loc, + Colorize &colorize, Color::type color_code, + int context_size) { + using namespace std; + typedef SnippetFactory::lines_t lines_t; + + lines_t lines = _snippets.get_snippet(source_loc.filename, source_loc.line, + static_cast(context_size)); + + for (lines_t::const_iterator it = lines.begin(); it != lines.end(); ++it) { + if (it->first == source_loc.line) { + colorize.set_color(color_code); + os << indent << ">"; + } else { + os << indent << " "; + } + os << std::setw(4) << it->first << ": " << it->second << "\n"; + if (it->first == source_loc.line) { + colorize.set_color(Color::reset); + } + } + } + + void print_source_loc(std::ostream &os, const char *indent, + const ResolvedTrace::SourceLoc &source_loc, + void *addr = nullptr) { + os << indent << "Source \"" << source_loc.filename << "\", line " + << source_loc.line << ", in " << source_loc.function; + + if (address && addr != nullptr) { + os << " [" << addr << "]"; + } + os << "\n"; + } +}; + +/*************** SIGNALS HANDLING ***************/ + +#if defined(BACKWARD_SYSTEM_LINUX) || defined(BACKWARD_SYSTEM_DARWIN) + +class SignalHandling { +public: + static std::vector make_default_signals() { + const int posix_signals[] = { + // Signals for which the default action is "Core". + SIGABRT, // Abort signal from abort(3) + SIGBUS, // Bus error (bad memory access) + SIGFPE, // Floating point exception + SIGILL, // Illegal Instruction + SIGIOT, // IOT trap. A synonym for SIGABRT + SIGQUIT, // Quit from keyboard + SIGSEGV, // Invalid memory reference + SIGSYS, // Bad argument to routine (SVr4) + SIGTRAP, // Trace/breakpoint trap + SIGXCPU, // CPU time limit exceeded (4.2BSD) + SIGXFSZ, // File size limit exceeded (4.2BSD) +#if defined(BACKWARD_SYSTEM_DARWIN) + SIGEMT, // emulation instruction executed +#endif + }; + return std::vector(posix_signals, + posix_signals + + sizeof posix_signals / sizeof posix_signals[0]); + } + + SignalHandling(const std::vector &posix_signals = make_default_signals()) + : _loaded(false) { + bool success = true; + + const size_t stack_size = 1024 * 1024 * 8; + _stack_content.reset(static_cast(malloc(stack_size))); + if (_stack_content) { + stack_t ss; + ss.ss_sp = _stack_content.get(); + ss.ss_size = stack_size; + ss.ss_flags = 0; + if (sigaltstack(&ss, nullptr) < 0) { + success = false; + } + } else { + success = false; + } + + for (size_t i = 0; i < posix_signals.size(); ++i) { + struct sigaction action; + memset(&action, 0, sizeof action); + action.sa_flags = + static_cast(SA_SIGINFO | SA_ONSTACK | SA_NODEFER | SA_RESETHAND); + sigfillset(&action.sa_mask); + sigdelset(&action.sa_mask, posix_signals[i]); +#if defined(__clang__) +#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Wdisabled-macro-expansion" +#endif + action.sa_sigaction = &sig_handler; +#if defined(__clang__) +#pragma clang diagnostic pop +#endif + + int r = sigaction(posix_signals[i], &action, nullptr); + if (r < 0) + success = false; + } + + _loaded = success; + } + + bool loaded() const { return _loaded; } + + static void handleSignal(int, siginfo_t *info, void *_ctx) { + ucontext_t *uctx = static_cast(_ctx); + + StackTrace st; + void *error_addr = nullptr; +#ifdef REG_RIP // x86_64 + error_addr = reinterpret_cast(uctx->uc_mcontext.gregs[REG_RIP]); +#elif defined(REG_EIP) // x86_32 + error_addr = reinterpret_cast(uctx->uc_mcontext.gregs[REG_EIP]); +#elif defined(__arm__) + error_addr = reinterpret_cast(uctx->uc_mcontext.arm_pc); +#elif defined(__aarch64__) + #if defined(__APPLE__) + error_addr = reinterpret_cast(uctx->uc_mcontext->__ss.__pc); + #else + error_addr = reinterpret_cast(uctx->uc_mcontext.pc); + #endif +#elif defined(__mips__) + error_addr = reinterpret_cast( + reinterpret_cast(&uctx->uc_mcontext)->sc_pc); +#elif defined(__ppc__) || defined(__powerpc) || defined(__powerpc__) || \ + defined(__POWERPC__) + error_addr = reinterpret_cast(uctx->uc_mcontext.regs->nip); +#elif defined(__riscv) + error_addr = reinterpret_cast(uctx->uc_mcontext.__gregs[REG_PC]); +#elif defined(__s390x__) + error_addr = reinterpret_cast(uctx->uc_mcontext.psw.addr); +#elif defined(__APPLE__) && defined(__x86_64__) + error_addr = reinterpret_cast(uctx->uc_mcontext->__ss.__rip); +#elif defined(__APPLE__) + error_addr = reinterpret_cast(uctx->uc_mcontext->__ss.__eip); +#else +#warning ":/ sorry, ain't know no nothing none not of your architecture!" +#endif + if (error_addr) { + st.load_from(error_addr, 32, reinterpret_cast(uctx), + info->si_addr); + } else { + st.load_here(32, reinterpret_cast(uctx), info->si_addr); + } + + FILE* crashDump=fopen("furnace_crash.txt","w"); + + Printer printer; + printer.address = true; + printer.print(st, stderr); + + if (crashDump!=NULL) { + Printer printer; + printer.address = true; + printer.print(st, crashDump); + fclose(crashDump); + } + +#if (defined(_XOPEN_SOURCE) && _XOPEN_SOURCE >= 700) || \ + (defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE >= 200809L) + psiginfo(info, nullptr); +#else + (void)info; +#endif + } + +private: + details::handle _stack_content; + bool _loaded; + +#ifdef __GNUC__ + __attribute__((noreturn)) +#endif + static void + sig_handler(int signo, siginfo_t *info, void *_ctx) { + handleSignal(signo, info, _ctx); + + // try to forward the signal. + raise(info->si_signo); + + // terminate the process immediately. + puts("watf? exit"); + _exit(EXIT_FAILURE); + } +}; + +#endif // BACKWARD_SYSTEM_LINUX || BACKWARD_SYSTEM_DARWIN + +#ifdef BACKWARD_SYSTEM_WINDOWS + +class SignalHandling { +public: + SignalHandling(const std::vector & = std::vector()) + : reporter_thread_([]() { + /* We handle crashes in a utility thread: + backward structures and some Windows functions called here + need stack space, which we do not have when we encounter a + stack overflow. + To support reporting stack traces during a stack overflow, + we create a utility thread at startup, which waits until a + crash happens or the program exits normally. */ + + { + std::unique_lock lk(mtx()); + cv().wait(lk, [] { return crashed() != crash_status::running; }); + } + if (crashed() == crash_status::crashed) { + handle_stacktrace(skip_recs()); + } + { + std::unique_lock lk(mtx()); + crashed() = crash_status::ending; + } + cv().notify_one(); + }) { + SetUnhandledExceptionFilter(crash_handler); + + signal(SIGABRT, signal_handler); +#ifdef _MSC_VER + // TODO: fix for MinGW + _set_abort_behavior(0, _WRITE_ABORT_MSG | _CALL_REPORTFAULT); +#endif + + std::set_terminate(&terminator); +#ifndef BACKWARD_ATLEAST_CXX17 + std::set_unexpected(&terminator); +#endif + _set_purecall_handler(&terminator); + _set_invalid_parameter_handler(&invalid_parameter_handler); + } + bool loaded() const { return true; } + + ~SignalHandling() { + { + std::unique_lock lk(mtx()); + crashed() = crash_status::normal_exit; + } + + cv().notify_one(); + + reporter_thread_.join(); + } + +private: + static CONTEXT *ctx() { + static CONTEXT data; + return &data; + } + + enum class crash_status { running, crashed, normal_exit, ending }; + + static crash_status &crashed() { + static crash_status data; + return data; + } + + static std::mutex &mtx() { + static std::mutex data; + return data; + } + + static std::condition_variable &cv() { + static std::condition_variable data; + return data; + } + + static HANDLE &thread_handle() { + static HANDLE handle; + return handle; + } + + std::thread reporter_thread_; + + // TODO: how not to hardcode these? + static const constexpr int signal_skip_recs = +#ifdef __clang__ + // With clang, RtlCaptureContext also captures the stack frame of the + // current function Below that, there ar 3 internal Windows functions + 4 +#else + // With MSVC cl, RtlCaptureContext misses the stack frame of the current + // function The first entries during StackWalk are the 3 internal Windows + // functions + 3 +#endif + ; + + static int &skip_recs() { + static int data; + return data; + } + + static inline void terminator() { + crash_handler(signal_skip_recs); + abort(); + } + + static inline void signal_handler(int) { + crash_handler(signal_skip_recs); + abort(); + } + + static inline void __cdecl invalid_parameter_handler(const wchar_t *, + const wchar_t *, + const wchar_t *, + unsigned int, + uintptr_t) { + crash_handler(signal_skip_recs); + abort(); + } + + NOINLINE static LONG WINAPI crash_handler(EXCEPTION_POINTERS *info) { + // The exception info supplies a trace from exactly where the issue was, + // no need to skip records + crash_handler(0, info->ContextRecord); + return EXCEPTION_CONTINUE_SEARCH; + } + + NOINLINE static void crash_handler(int skip, CONTEXT *ct = nullptr) { + + if (ct == nullptr) { + RtlCaptureContext(ctx()); + } else { + memcpy(ctx(), ct, sizeof(CONTEXT)); + } + DuplicateHandle(GetCurrentProcess(), GetCurrentThread(), + GetCurrentProcess(), &thread_handle(), 0, FALSE, + DUPLICATE_SAME_ACCESS); + + skip_recs() = skip; + + { + std::unique_lock lk(mtx()); + crashed() = crash_status::crashed; + } + + cv().notify_one(); + + { + std::unique_lock lk(mtx()); + cv().wait(lk, [] { return crashed() != crash_status::crashed; }); + } + } + + static void handle_stacktrace(int skip_frames = 0) { + // printer creates the TraceResolver, which can supply us a machine type + // for stack walking. Without this, StackTrace can only guess using some + // macros. + // StackTrace also requires that the PDBs are already loaded, which is done + // in the constructor of TraceResolver + Printer printer; + + StackTrace st; + st.set_machine_type(printer.resolver().machine_type()); + st.set_thread_handle(thread_handle()); + st.load_here(32 + skip_frames, ctx()); + st.skip_n_firsts(skip_frames); + + printer.address = true; + printer.print(st, std::cerr); + } +}; + +#endif // BACKWARD_SYSTEM_WINDOWS + +#ifdef BACKWARD_SYSTEM_UNKNOWN + +class SignalHandling { +public: + SignalHandling(const std::vector & = std::vector()) {} + bool init() { return false; } + bool loaded() { return false; } +}; + +#endif // BACKWARD_SYSTEM_UNKNOWN + +} // namespace backward + +#endif /* H_GUARD */ diff --git a/extern/backward/builds.sh b/extern/backward/builds.sh new file mode 100755 index 00000000..6e1fb207 --- /dev/null +++ b/extern/backward/builds.sh @@ -0,0 +1,77 @@ +#!/bin/bash + +COMPILERS_CXX98=`cat</dev/null + ( + cd "$builddir" + cmake -DCMAKE_BUILD_TYPE=$buildtype -DBACKWARD_TESTS=ON .. + ) +} + +function build() { + local builddir=$1 + shift + make -C "$builddir" $@ +} + +function dotest() { + local builddir=$1 + shift + make -C "$builddir" test $@ + return 0 +} + +function do_action() { + local lang=$1 + local action=$2 + shift 2 + + for compiler in $COMPILERS; do + local builddir="build_${lang}_${compiler}" + + if [[ $action == "cmake" ]]; then + buildtype=$1 + mkbuild $compiler $lang "$buildtype" "$builddir" + [[ $? != 0 ]] && exit + elif [[ $action == "make" ]]; then + build "$builddir" $@ + [[ $? != 0 ]] && exit + elif [[ $action == "test" ]]; then + dotest "$builddir" $@ + [[ $? != 0 ]] && exit + elif [[ $action == "clean" ]]; then + rm -r "$builddir" + else + echo "usage: $0 cmake [debug|release|relwithdbg]|make|test|clean" + exit 255 + fi + done +} + +COMPILERS=$COMPILERS_CXX98 +do_action c++98 $@ +COMPILERS=$COMPILERS_CXX11 +do_action c++11 $@ diff --git a/extern/igfd/ImGuiFileDialog.cpp b/extern/igfd/ImGuiFileDialog.cpp index f4641e97..f7a2be5b 100644 --- a/extern/igfd/ImGuiFileDialog.cpp +++ b/extern/igfd/ImGuiFileDialog.cpp @@ -1220,6 +1220,8 @@ namespace IGFD std::sort(prFileList.begin(), prFileList.end(), [](const std::shared_ptr& a, const std::shared_ptr& b) -> bool { + if (a==NULL || b==NULL) + return false; if (!a.use_count() || !b.use_count()) return false; @@ -1249,6 +1251,8 @@ namespace IGFD std::sort(prFileList.begin(), prFileList.end(), [](const std::shared_ptr& a, const std::shared_ptr& b) -> bool { + if (a==NULL || b==NULL) + return false; if (!a.use_count() || !b.use_count()) return false; @@ -1283,6 +1287,8 @@ namespace IGFD std::sort(prFileList.begin(), prFileList.end(), [](const std::shared_ptr& a, const std::shared_ptr& b) -> bool { + if (a==NULL || b==NULL) + return false; if (!a.use_count() || !b.use_count()) return false; @@ -1298,6 +1304,8 @@ namespace IGFD std::sort(prFileList.begin(), prFileList.end(), [](const std::shared_ptr& a, const std::shared_ptr& b) -> bool { + if (a==NULL || b==NULL) + return false; if (!a.use_count() || !b.use_count()) return false; @@ -1319,6 +1327,8 @@ namespace IGFD std::sort(prFileList.begin(), prFileList.end(), [](const std::shared_ptr& a, const std::shared_ptr& b) -> bool { + if (a==NULL || b==NULL) + return false; if (!a.use_count() || !b.use_count()) return false; @@ -1334,6 +1344,8 @@ namespace IGFD std::sort(prFileList.begin(), prFileList.end(), [](const std::shared_ptr& a, const std::shared_ptr& b) -> bool { + if (a==NULL || b==NULL) + return false; if (!a.use_count() || !b.use_count()) return false; @@ -1355,6 +1367,8 @@ namespace IGFD std::sort(prFileList.begin(), prFileList.end(), [](const std::shared_ptr& a, const std::shared_ptr& b) -> bool { + if (a==NULL || b==NULL) + return false; if (!a.use_count() || !b.use_count()) return false; @@ -1370,6 +1384,8 @@ namespace IGFD std::sort(prFileList.begin(), prFileList.end(), [](const std::shared_ptr& a, const std::shared_ptr& b) -> bool { + if (a==NULL || b==NULL) + return false; if (!a.use_count() || !b.use_count()) return false; diff --git a/extern/imgui_patched/imgui.cpp b/extern/imgui_patched/imgui.cpp index 33259164..8b013816 100644 --- a/extern/imgui_patched/imgui.cpp +++ b/extern/imgui_patched/imgui.cpp @@ -1075,6 +1075,7 @@ ImGuiStyle::ImGuiStyle() PopupBorderSize = 1.0f; // Thickness of border around popup or tooltip windows. Generally set to 0.0f or 1.0f. Other values not well tested. FramePadding = ImVec2(4,3); // Padding within a framed rectangle (used by most widgets) FrameRounding = 0.0f; // Radius of frame corners rounding. Set to 0.0f to have rectangular frames (used by most widgets). + FrameShading = 0.0f; // Gradient intensity of frame FrameBorderSize = 0.0f; // Thickness of border around frames. Generally set to 0.0f or 1.0f. Other values not well tested. ItemSpacing = ImVec2(8,4); // Horizontal and vertical spacing between widgets/lines ItemInnerSpacing = ImVec2(4,4); // Horizontal and vertical spacing between within elements of a composed widget (e.g. a slider and its label) @@ -2881,6 +2882,7 @@ static const ImGuiStyleVarInfo GStyleVarInfo[] = { ImGuiDataType_Float, 1, (ImU32)IM_OFFSETOF(ImGuiStyle, PopupBorderSize) }, // ImGuiStyleVar_PopupBorderSize { ImGuiDataType_Float, 2, (ImU32)IM_OFFSETOF(ImGuiStyle, FramePadding) }, // ImGuiStyleVar_FramePadding { ImGuiDataType_Float, 1, (ImU32)IM_OFFSETOF(ImGuiStyle, FrameRounding) }, // ImGuiStyleVar_FrameRounding + { ImGuiDataType_Float, 1, (ImU32)IM_OFFSETOF(ImGuiStyle, FrameShading) }, // ImGuiStyleVar_FrameShading { ImGuiDataType_Float, 1, (ImU32)IM_OFFSETOF(ImGuiStyle, FrameBorderSize) }, // ImGuiStyleVar_FrameBorderSize { ImGuiDataType_Float, 2, (ImU32)IM_OFFSETOF(ImGuiStyle, ItemSpacing) }, // ImGuiStyleVar_ItemSpacing { ImGuiDataType_Float, 2, (ImU32)IM_OFFSETOF(ImGuiStyle, ItemInnerSpacing) }, // ImGuiStyleVar_ItemInnerSpacing @@ -3205,7 +3207,14 @@ void ImGui::RenderFrame(ImVec2 p_min, ImVec2 p_max, ImU32 fill_col, bool border, { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; - window->DrawList->AddRectFilled(p_min, p_max, fill_col, rounding); + if (g.Style.FrameShading>0.0f) { + ImVec4 fill_colPre=ImGui::ColorConvertU32ToFloat4(fill_col); + fill_colPre.w*=1.0f-g.Style.FrameShading; + ImU32 fill_col1=ImGui::ColorConvertFloat4ToU32(fill_colPre); + window->DrawList->AddRectFilledMultiColor(p_min, p_max, fill_col, fill_col, fill_col1, fill_col1, rounding); + } else { + window->DrawList->AddRectFilled(p_min, p_max, fill_col, rounding); + } const float border_size = g.Style.FrameBorderSize; if (border && border_size > 0.0f) { @@ -3909,6 +3918,8 @@ void ImGui::StartMouseMovingWindowOrNode(ImGuiWindow* window, ImGuiDockNode* nod if (root_node->OnlyNodeWithWindows != node || root_node->CentralNode != NULL) // -V1051 PVS-Studio thinks node should be root_node and is wrong about that. if (undock_floating_node || root_node->IsDockSpace()) can_undock_node = true; + if (node->MergedFlags & ImGuiDockNodeFlags_NoMove) + can_undock_node = false; } const bool clicked = IsMouseClicked(0); @@ -6122,7 +6133,7 @@ void ImGui::RenderWindowDecorations(ImGuiWindow* window, const ImRect& title_bar // Docking: Unhide tab bar (small triangle in the corner), drag from small triangle to quickly undock ImGuiDockNode* node = window->DockNode; - if (window->DockIsActive && node->IsHiddenTabBar() && !node->IsNoTabBar()) + if (window->DockIsActive && node->IsHiddenTabBar() && !node->IsNoTabBar() && !(node->MergedFlags & ImGuiDockNodeFlags_NoMove)) { float unhide_sz_draw = ImFloor(g.FontSize * 0.70f); float unhide_sz_hit = ImFloor(g.FontSize * 0.55f); diff --git a/extern/imgui_patched/imgui.h b/extern/imgui_patched/imgui.h index c0ab8f22..fef6dba4 100644 --- a/extern/imgui_patched/imgui.h +++ b/extern/imgui_patched/imgui.h @@ -1342,7 +1342,8 @@ enum ImGuiDockNodeFlags_ ImGuiDockNodeFlags_PassthruCentralNode = 1 << 3, // Shared // Enable passthru dockspace: 1) DockSpace() will render a ImGuiCol_WindowBg background covering everything excepted the Central Node when empty. Meaning the host window should probably use SetNextWindowBgAlpha(0.0f) prior to Begin() when using this. 2) When Central Node is empty: let inputs pass-through + won't display a DockingEmptyBg background. See demo for details. ImGuiDockNodeFlags_NoSplit = 1 << 4, // Shared/Local // Disable splitting the node into smaller nodes. Useful e.g. when embedding dockspaces into a main root one (the root one may have splitting disabled to reduce confusion). Note: when turned off, existing splits will be preserved. ImGuiDockNodeFlags_NoResize = 1 << 5, // Shared/Local // Disable resizing node using the splitter/separators. Useful with programmatically setup dockspaces. - ImGuiDockNodeFlags_AutoHideTabBar = 1 << 6 // Shared/Local // Tab bar will automatically hide when there is a single window in the dock node. + ImGuiDockNodeFlags_AutoHideTabBar = 1 << 6, // Shared/Local // Tab bar will automatically hide when there is a single window in the dock node. + ImGuiDockNodeFlags_NoMove = 1 << 7 // Shared/Local // Disable moving node }; // Flags for ImGui::BeginDragDropSource(), ImGui::AcceptDragDropPayload() @@ -1680,6 +1681,7 @@ enum ImGuiStyleVar_ ImGuiStyleVar_PopupBorderSize, // float PopupBorderSize ImGuiStyleVar_FramePadding, // ImVec2 FramePadding ImGuiStyleVar_FrameRounding, // float FrameRounding + ImGuiStyleVar_FrameShading, // float FrameShading ImGuiStyleVar_FrameBorderSize, // float FrameBorderSize ImGuiStyleVar_ItemSpacing, // ImVec2 ItemSpacing ImGuiStyleVar_ItemInnerSpacing, // ImVec2 ItemInnerSpacing @@ -1926,6 +1928,7 @@ struct ImGuiStyle float PopupBorderSize; // Thickness of border around popup/tooltip windows. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly). ImVec2 FramePadding; // Padding within a framed rectangle (used by most widgets). float FrameRounding; // Radius of frame corners rounding. Set to 0.0f to have rectangular frame (used by most widgets). + float FrameShading; float FrameBorderSize; // Thickness of border around frames. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly). ImVec2 ItemSpacing; // Horizontal and vertical spacing between widgets/lines. ImVec2 ItemInnerSpacing; // Horizontal and vertical spacing between within elements of a composed widget (e.g. a slider and its label). @@ -2652,7 +2655,7 @@ struct ImDrawList IMGUI_API void AddLine(const ImVec2& p1, const ImVec2& p2, ImU32 col, float thickness = 1.0f); IMGUI_API void AddRect(const ImVec2& p_min, const ImVec2& p_max, ImU32 col, float rounding = 0.0f, ImDrawFlags flags = 0, float thickness = 1.0f); // a: upper-left, b: lower-right (== upper-left + size) IMGUI_API void AddRectFilled(const ImVec2& p_min, const ImVec2& p_max, ImU32 col, float rounding = 0.0f, ImDrawFlags flags = 0); // a: upper-left, b: lower-right (== upper-left + size) - IMGUI_API void AddRectFilledMultiColor(const ImVec2& p_min, const ImVec2& p_max, ImU32 col_upr_left, ImU32 col_upr_right, ImU32 col_bot_right, ImU32 col_bot_left); + IMGUI_API void AddRectFilledMultiColor(const ImVec2& p_min, const ImVec2& p_max, ImU32 col_upr_left, ImU32 col_upr_right, ImU32 col_bot_right, ImU32 col_bot_left, float rounding = 0.0f, ImDrawFlags flags = 0); IMGUI_API void AddQuad(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, ImU32 col, float thickness = 1.0f); IMGUI_API void AddQuadFilled(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, ImU32 col); IMGUI_API void AddTriangle(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, ImU32 col, float thickness = 1.0f); diff --git a/extern/imgui_patched/imgui_draw.cpp b/extern/imgui_patched/imgui_draw.cpp index b6df4a17..e73bce28 100644 --- a/extern/imgui_patched/imgui_draw.cpp +++ b/extern/imgui_patched/imgui_draw.cpp @@ -1427,11 +1427,58 @@ void ImDrawList::AddRectFilled(const ImVec2& p_min, const ImVec2& p_max, ImU32 c } // p_min = upper-left, p_max = lower-right -void ImDrawList::AddRectFilledMultiColor(const ImVec2& p_min, const ImVec2& p_max, ImU32 col_upr_left, ImU32 col_upr_right, ImU32 col_bot_right, ImU32 col_bot_left) +void ImDrawList::AddRectFilledMultiColor(const ImVec2& p_min, const ImVec2& p_max, ImU32 col_upr_left, ImU32 col_upr_right, ImU32 col_bot_right, ImU32 col_bot_left, float rounding, ImDrawFlags flags) { if (((col_upr_left | col_upr_right | col_bot_right | col_bot_left) & IM_COL32_A_MASK) == 0) return; + if (rounding > 0.0f) { + // https://github.com/ocornut/imgui/issues/3710 + // TODO: optimize + const int v0 = VtxBuffer.Size; + AddRectFilled(p_min,p_max,0xffffffff,rounding,flags); + const int v1 = VtxBuffer.Size; + + for (int i=v0; ipos.x-p_min.x)/(p_max.x-p_min.x); + float shadeY=(v->pos.y-p_min.y)/(p_max.y-p_min.y); + if (shadeX<0.0f) shadeX=0.0f; + if (shadeX>1.0f) shadeX=1.0f; + if (shadeY<0.0f) shadeY=0.0f; + if (shadeY>1.0f) shadeY=1.0f; + + col0.x+=(col2.x-col0.x)*shadeX; + col0.y+=(col2.y-col0.y)*shadeX; + col0.z+=(col2.z-col0.z)*shadeX; + col0.w+=(col2.w-col0.w)*shadeX; + + col1.x+=(col3.x-col1.x)*shadeX; + col1.y+=(col3.y-col1.y)*shadeX; + col1.z+=(col3.z-col1.z)*shadeX; + col1.w+=(col3.w-col1.w)*shadeX; + + col0.x+=(col1.x-col0.x)*shadeY; + col0.y+=(col1.y-col0.y)*shadeY; + col0.z+=(col1.z-col0.z)*shadeY; + col0.w+=(col1.w-col0.w)*shadeY; + + ImVec4 conv=ImGui::ColorConvertU32ToFloat4(v->col); + col0.x*=conv.x; + col0.y*=conv.y; + col0.z*=conv.z; + col0.w*=conv.w; + + v->col=ImGui::ColorConvertFloat4ToU32(col0); + } + return; + } + const ImVec2 uv = _Data->TexUvWhitePixel; PrimReserve(6, 4); PrimWriteIdx((ImDrawIdx)(_VtxCurrentIdx)); PrimWriteIdx((ImDrawIdx)(_VtxCurrentIdx + 1)); PrimWriteIdx((ImDrawIdx)(_VtxCurrentIdx + 2)); diff --git a/extern/imgui_patched/imgui_widgets.cpp b/extern/imgui_patched/imgui_widgets.cpp index 3830f962..c6fec68b 100644 --- a/extern/imgui_patched/imgui_widgets.cpp +++ b/extern/imgui_patched/imgui_widgets.cpp @@ -8160,12 +8160,16 @@ bool ImGui::TabItemEx(ImGuiTabBar* tab_bar, const char* label, bool* p_open, // Drag and drop a single floating window node moves it ImGuiDockNode* node = docked_window ? docked_window->DockNode : NULL; const bool single_floating_window_node = node && node->IsFloatingNode() && (node->Windows.Size == 1); + bool can_undock = true; + if (node) { + if (node->MergedFlags & ImGuiDockNodeFlags_NoMove) can_undock = false; + } if (held && single_floating_window_node && IsMouseDragging(0, 0.0f)) { // Move StartMouseMovingWindow(docked_window); } - else if (held && !tab_appearing && IsMouseDragging(0)) + else if (held && !tab_appearing && IsMouseDragging(0) && can_undock) { // Drag and drop: re-order tabs int drag_dir = 0; @@ -8247,7 +8251,7 @@ bool ImGui::TabItemEx(ImGuiTabBar* tab_bar, const char* label, bool* p_open, flags |= ImGuiTabItemFlags_NoCloseWithMiddleMouseButton; // Render tab label, process close button - const ImGuiID close_button_id = p_open ? GetIDWithSeed("#CLOSE", NULL, docked_window ? docked_window->ID : id) : 0; + const ImGuiID close_button_id = (p_open && can_undock) ? GetIDWithSeed("#CLOSE", NULL, docked_window ? docked_window->ID : id) : 0; bool just_closed; bool text_clipped; TabItemLabelAndCloseButton(display_draw_list, bb, flags, tab_bar->FramePadding, label, id, close_button_id, tab_contents_visible, &just_closed, &text_clipped); diff --git a/papers/doc/7-systems/n163.md b/papers/doc/7-systems/n163.md index 68774801..76b750cb 100644 --- a/papers/doc/7-systems/n163.md +++ b/papers/doc/7-systems/n163.md @@ -1,4 +1,4 @@ -# Namco 163 +# Namco C163 This is Namco's one of NES mapper, with up to 8 wavetable channels. It has also 128 byte of internal RAM, both channel register and wavetables are stored here. Wavetables are variable size and freely allocable anywhere in RAM, it means it can be uses part of or continuously pre-loaded waveform and/or its sequences in RAM. But waveform RAM area becomes smaller as much as activating more channels; Channel register consumes 8 byte for each channels. You must avoid conflict with channel register area and waveform for avoid channel playback broken. diff --git a/papers/format.md b/papers/format.md index a2c66da7..d519e863 100644 --- a/papers/format.md +++ b/papers/format.md @@ -29,6 +29,7 @@ furthermore, an `or reserved` indicates this field is always present, but is res the format versions are: +- 97: Furnace dev97 - 96: Furnace dev96 - 95: Furnace dev95 - 94: Furnace dev94 @@ -300,7 +301,8 @@ size | description 1 | SN duty macro always resets phase (>=86) or reserved 1 | pitch macro is linear (>=90) or reserved 1 | pitch slide speed in full linear pitch mode (>=94) or reserved - 14 | reserved + 1 | old octave boundary behavior (>=97) or reserved + 13 | reserved --- | **virtual tempo data** 2 | virtual tempo numerator of first song (>=96) or reserved 2 | virtual tempo denominator of first song (>=96) or reserved diff --git a/src/backtrace.cpp b/src/backtrace.cpp new file mode 100644 index 00000000..68a648ff --- /dev/null +++ b/src/backtrace.cpp @@ -0,0 +1,42 @@ +// Pick your poison. +// +// On GNU/Linux, you have few choices to get the most out of your stack trace. +// +// By default you get: +// - object filename +// - function name +// +// In order to add: +// - source filename +// - line and column numbers +// - source code snippet (assuming the file is accessible) + +// Install one of the following libraries then uncomment one of the macro (or +// better, add the detection of the lib and the macro definition in your build +// system) + +// - apt-get install libdw-dev ... +// - g++/clang++ -ldw ... +// #define BACKWARD_HAS_DW 1 + +// - apt-get install binutils-dev ... +// - g++/clang++ -lbfd ... +// #define BACKWARD_HAS_BFD 1 + +// - apt-get install libdwarf-dev ... +// - g++/clang++ -ldwarf ... +// #define BACKWARD_HAS_DWARF 1 + +// Regardless of the library you choose to read the debug information, +// for potentially more detailed stack traces you can use libunwind +// - apt-get install libunwind-dev +// - g++/clang++ -lunwind +// #define BACKWARD_HAS_LIBUNWIND 1 + +#include "../extern/backward/backward.hpp" + +namespace backward { + +backward::SignalHandling sh; + +} // namespace backward diff --git a/src/engine/dispatchContainer.cpp b/src/engine/dispatchContainer.cpp index 6b4e4bb9..3f7d0ba4 100644 --- a/src/engine/dispatchContainer.cpp +++ b/src/engine/dispatchContainer.cpp @@ -21,6 +21,8 @@ #include "engine.h" #include "platform/genesis.h" #include "platform/genesisext.h" +#include "platform/msm6258.h" +#include "platform/msm6295.h" #include "platform/namcowsg.h" #include "platform/sms.h" #include "platform/opll.h" @@ -190,6 +192,7 @@ void DivDispatchContainer::init(DivSystem sys, DivEngine* eng, int chanCount, do break; case DIV_SYSTEM_SMS: dispatch=new DivPlatformSMS; + ((DivPlatformSMS*)dispatch)->setNuked(eng->getConfInt("snCore",0)); break; case DIV_SYSTEM_GB: dispatch=new DivPlatformGB; @@ -368,6 +371,12 @@ void DivDispatchContainer::init(DivSystem sys, DivEngine* eng, int chanCount, do case DIV_SYSTEM_SOUND_UNIT: dispatch=new DivPlatformSoundUnit; break; + case DIV_SYSTEM_MSM6258: + dispatch=new DivPlatformMSM6258; + break; + case DIV_SYSTEM_MSM6295: + dispatch=new DivPlatformMSM6295; + break; case DIV_SYSTEM_NAMCO: dispatch=new DivPlatformNamcoWSG; // Pac-Man (TODO: support Pole Position?) diff --git a/src/engine/engine.cpp b/src/engine/engine.cpp index ee71a0b9..a4227fee 100644 --- a/src/engine/engine.cpp +++ b/src/engine/engine.cpp @@ -23,7 +23,9 @@ #include "safeReader.h" #include "../ta-log.h" #include "../fileutils.h" +#ifdef HAVE_SDL2 #include "../audio/sdl.h" +#endif #include #ifndef _WIN32 #include @@ -34,7 +36,9 @@ #include "../audio/jack.h" #endif #include +#ifdef HAVE_SNDFILE #include +#endif #include void process(void* u, float** in, float** out, int inChans, int outChans, unsigned int size) { @@ -187,6 +191,7 @@ bool DivEngine::isExporting() { #define EXPORT_BUFSIZE 2048 +#ifdef HAVE_SNDFILE void DivEngine::runExportThread() { switch (exportMode) { case DIV_EXPORT_MODE_ONE: { @@ -438,8 +443,16 @@ void DivEngine::runExportThread() { } stopExport=false; } +#else +void DivEngine::runExportThread() { +} +#endif bool DivEngine::saveAudio(const char* path, int loops, DivAudioExportModes mode) { +#ifndef HAVE_SNDFILE + logE("Furnace was not compiled with libsndfile. cannot export!"); + return false; +#else exportPath=path; exportMode=mode; if (exportMode!=DIV_EXPORT_MODE_ONE) { @@ -461,6 +474,7 @@ bool DivEngine::saveAudio(const char* path, int loops, DivAudioExportModes mode) remainingLoops=loops; exportThread=new std::thread(_runExportThread,this); return true; +#endif } void DivEngine::waitAudioFile() { @@ -2027,6 +2041,10 @@ int DivEngine::addSampleFromFile(const char* path) { } } +#ifndef HAVE_SNDFILE + lastError="Furnace was not compiled with libsndfile!"; + return -1; +#else SF_INFO si; SNDFILE* f=sf_open(path,SFM_READ,&si); if (f==NULL) { @@ -2107,6 +2125,7 @@ int DivEngine::addSampleFromFile(const char* path) { renderSamples(); BUSY_END; return sampleCount; +#endif } void DivEngine::delSample(int index) { @@ -2757,13 +2776,23 @@ bool DivEngine::initAudioBackend() { logE("Furnace was not compiled with JACK support!"); setConf("audioEngine","SDL"); saveConf(); +#ifdef HAVE_SDL2 output=new TAAudioSDL; +#else + logE("Furnace was not compiled with SDL support either!"); + output=new TAAudio; +#endif #else output=new TAAudioJACK; #endif break; case DIV_AUDIO_SDL: +#ifdef HAVE_SDL2 output=new TAAudioSDL; +#else + logE("Furnace was not compiled with SDL support!"); + output=new TAAudio; +#endif break; case DIV_AUDIO_DUMMY: output=new TAAudio; @@ -2858,7 +2887,7 @@ bool DivEngine::init() { // init config #ifdef _WIN32 configPath=getWinConfigPath(); -#elif defined(ANDROID) +#elif defined(IS_MOBILE) configPath=SDL_GetPrefPath("tildearrow","furnace"); #else struct stat st; diff --git a/src/engine/engine.h b/src/engine/engine.h index 735965df..6d0743e6 100644 --- a/src/engine/engine.h +++ b/src/engine/engine.h @@ -45,8 +45,8 @@ #define BUSY_BEGIN_SOFT softLocked=true; isBusy.lock(); #define BUSY_END isBusy.unlock(); softLocked=false; -#define DIV_VERSION "dev96" -#define DIV_ENGINE_VERSION 96 +#define DIV_VERSION "dev97" +#define DIV_ENGINE_VERSION 97 // for imports #define DIV_VERSION_MOD 0xff01 diff --git a/src/engine/fileOps.cpp b/src/engine/fileOps.cpp index e7f06455..7ce1b7b2 100644 --- a/src/engine/fileOps.cpp +++ b/src/engine/fileOps.cpp @@ -166,6 +166,7 @@ bool DivEngine::loadDMF(unsigned char* file, size_t len) { ds.e1e2AlsoTakePriority=true; ds.fbPortaPause=true; ds.snDutyReset=true; + ds.oldOctaveBoundary=false; // 1.1 compat flags if (ds.version>24) { @@ -307,19 +308,19 @@ bool DivEngine::loadDMF(unsigned char* file, size_t len) { logI("reading instruments (%d)...",ds.insLen); for (int i=0; i0x05) { ins->name=reader.readString((unsigned char)reader.readC()); } logD("%d name: %s",i,ins->name.c_str()); if (ds.version<0x0b) { // instruments in ancient versions were all FM or STD. - ins->mode=1; + mode=1; } else { - unsigned char mode=reader.readC(); + mode=reader.readC(); if (mode>1) logW("%d: invalid instrument mode %d!",i,mode); - ins->mode=mode; } - ins->type=ins->mode?DIV_INS_FM:DIV_INS_STD; + ins->type=mode?DIV_INS_FM:DIV_INS_STD; if (ds.system[0]==DIV_SYSTEM_GB) { ins->type=DIV_INS_GB; } @@ -329,7 +330,7 @@ bool DivEngine::loadDMF(unsigned char* file, size_t len) { if (ds.system[0]==DIV_SYSTEM_YM2610 || ds.system[0]==DIV_SYSTEM_YM2610_EXT || ds.system[0]==DIV_SYSTEM_YM2610_FULL || ds.system[0]==DIV_SYSTEM_YM2610_FULL_EXT || ds.system[0]==DIV_SYSTEM_YM2610B || ds.system[0]==DIV_SYSTEM_YM2610B_EXT) { - if (!ins->mode) { + if (!mode) { ins->type=DIV_INS_AY; } } @@ -343,7 +344,7 @@ bool DivEngine::loadDMF(unsigned char* file, size_t len) { ins->type=DIV_INS_OPL; } - if (ins->mode) { // FM + if (mode) { // FM if (ds.version>0x05) { ins->fm.alg=reader.readC(); if (ds.version<0x13) { @@ -1027,6 +1028,9 @@ bool DivEngine::loadFur(unsigned char* file, size_t len) { if (ds.version<90) { ds.pitchMacroIsLinear=false; } + if (ds.version<97) { + ds.oldOctaveBoundary=true; + } ds.isDMF=false; reader.readS(); // reserved @@ -1404,7 +1408,12 @@ bool DivEngine::loadFur(unsigned char* file, size_t len) { } else { reader.readC(); } - for (int i=0; i<14; i++) { + if (ds.version>=97) { + ds.oldOctaveBoundary=reader.readC(); + } else { + reader.readC(); + } + for (int i=0; i<13; i++) { reader.readC(); } } @@ -2405,8 +2414,8 @@ bool DivEngine::loadFTM(unsigned char* file, size_t len) { const int dpcmNotes=(blockVersion>=2)?96:72; for (int j=0; jamiga.noteMap[j]=(short)((unsigned char)reader.readC())-1; - ins->amiga.noteFreq[j]=(unsigned char)reader.readC(); + ins->amiga.noteMap[j].ind=(short)((unsigned char)reader.readC())-1; + ins->amiga.noteMap[j].freq=(unsigned char)reader.readC(); if (blockVersion>=6) { reader.readC(); // DMC value } @@ -2884,7 +2893,8 @@ SafeWriter* DivEngine::saveFur(bool notPrimary) { w->writeC(song.snDutyReset); w->writeC(song.pitchMacroIsLinear); w->writeC(song.pitchSlideSpeed); - for (int i=0; i<14; i++) { + w->writeC(song.oldOctaveBoundary); + for (int i=0; i<13; i++) { w->writeC(0); } @@ -3234,15 +3244,15 @@ SafeWriter* DivEngine::saveDMF(unsigned char version) { w->writeString(i->name,true); // safety check - if (!isFMSystem(sys) && i->mode) { - i->mode=0; + if (!isFMSystem(sys) && i->type!=DIV_INS_STD && i->type!=DIV_INS_FDS) { + i->type=DIV_INS_STD; } - if (!isSTDSystem(sys) && i->mode==0) { - i->mode=1; + if (!isSTDSystem(sys) && i->type!=DIV_INS_FM) { + i->type=DIV_INS_FM; } - w->writeC(i->mode); - if (i->mode) { // FM + w->writeC((i->type==DIV_INS_FM || i->type==DIV_INS_OPLL)?1:0); + if (i->type==DIV_INS_FM || i->type==DIV_INS_OPLL) { // FM w->writeC(i->fm.alg); w->writeC(i->fm.fb); w->writeC(i->fm.fms); diff --git a/src/engine/instrument.h b/src/engine/instrument.h index d521cabb..3c5d5917 100644 --- a/src/engine/instrument.h +++ b/src/engine/instrument.h @@ -326,7 +326,7 @@ struct DivInstrumentAmiga { double sliceEnd; // inlines - inline double updateSize(double length, double loopStart, double loopEnd) { + inline void updateSize(double length, double loopStart, double loopEnd) { sliceSize=loopEnd-loopStart; sliceBound=(length-sliceSize); } @@ -589,7 +589,6 @@ struct DivInstrument { bool save(const char* path); DivInstrument(): name(""), - mode(false), type(DIV_INS_FM) { } }; diff --git a/src/engine/platform/amiga.cpp b/src/engine/platform/amiga.cpp index db10ae4b..09d9817e 100644 --- a/src/engine/platform/amiga.cpp +++ b/src/engine/platform/amiga.cpp @@ -207,7 +207,7 @@ void DivPlatformAmiga::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/arcade.cpp b/src/engine/platform/arcade.cpp index 6bd4e203..56446725 100644 --- a/src/engine/platform/arcade.cpp +++ b/src/engine/platform/arcade.cpp @@ -337,7 +337,7 @@ void DivPlatformArcade::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } @@ -345,7 +345,7 @@ void DivPlatformArcade::tick(bool sysTick) { } if (chan[i].std.phaseReset.had) { - if (chan[i].std.phaseReset.val==1) { + if (chan[i].std.phaseReset.val==1 && chan[i].active) { chan[i].keyOn=true; } } diff --git a/src/engine/platform/ay.cpp b/src/engine/platform/ay.cpp index 329af958..6e86a47f 100644 --- a/src/engine/platform/ay.cpp +++ b/src/engine/platform/ay.cpp @@ -224,7 +224,7 @@ void DivPlatformAY8910::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/ay8930.cpp b/src/engine/platform/ay8930.cpp index 8ec2aea2..3168bca7 100644 --- a/src/engine/platform/ay8930.cpp +++ b/src/engine/platform/ay8930.cpp @@ -242,7 +242,7 @@ void DivPlatformAY8930::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/bubsyswsg.cpp b/src/engine/platform/bubsyswsg.cpp index 52fb4a50..f25e6da9 100644 --- a/src/engine/platform/bubsyswsg.cpp +++ b/src/engine/platform/bubsyswsg.cpp @@ -124,7 +124,7 @@ void DivPlatformBubSysWSG::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/c64.cpp b/src/engine/platform/c64.cpp index 17b8124d..72692887 100644 --- a/src/engine/platform/c64.cpp +++ b/src/engine/platform/c64.cpp @@ -191,7 +191,7 @@ void DivPlatformC64::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/es5506.cpp b/src/engine/platform/es5506.cpp index dac3f4c0..a9e5d439 100644 --- a/src/engine/platform/es5506.cpp +++ b/src/engine/platform/es5506.cpp @@ -284,7 +284,7 @@ void DivPlatformES5506::e_pin(bool state) } if (chan[ch].transwaveIRQ) { if ((chan[ch].cr&0x37)==0x34) { // IRQE = 1, BLE = 1, LPE = 0, LEI = 1 - DivInstrument* ins=parent->getIns(chan[i].ins); + DivInstrument* ins=parent->getIns(chan[ch].ins); if (!ins->amiga.useNoteMap && ins->amiga.transWave.enable) { const int next=chan[ch].pcm.next; if (next>=0 && nextamiga.transWaveMap.size()) { @@ -316,8 +316,7 @@ void DivPlatformES5506::e_pin(bool state) loopEnd=(double)transWaveInd.loopEnd; if (ins->amiga.transWave.sliceEnable) { // sliced loop position? chan[ch].transWave.updateSize(s->samples,loopStart,loopEnd); - chan[ch].transWave.slice=transWaveInd.slice; - chan[ch].transWave.slicePos(chan[ch].transWave.slice); + chan[ch].transWave.slicePos(double(chan[ch].transWave.slice)/4095.0); loopStart=transWaveInd.sliceStart; loopEnd=transWaveInd.sliceEnd; } @@ -371,10 +370,10 @@ void DivPlatformES5506::e_pin(bool state) } chan[ch].transwaveIRQ=false; } - if (chan[ch].isTransWave) { + if (chan[ch].isTranswave) { pageReadMask(0x00|ch,0x5f,0x00,&chan[ch].cr); chan[ch].transwaveIRQ=true; - chan[ch].isTransWave=false; + chan[ch].isTranswave=false; } } } @@ -640,7 +639,7 @@ void DivPlatformES5506::tick(bool sysTick) { chan[i].volChanged.changed=0; } if (chan[i].pcmChanged.changed) { - if (!chan[i].isTransWave) { + if (!chan[i].isTranswave) { if (chan[i].pcmChanged.transwaveInd && (!ins->amiga.useNoteMap && ins->amiga.transWave.enable)) { const int next=chan[i].pcm.next; if (next>=0 && nextamiga.transWaveMap.size()) { @@ -667,8 +666,7 @@ void DivPlatformES5506::tick(bool sysTick) { loopEnd=(double)transWaveInd.loopEnd; if (ins->amiga.transWave.sliceEnable) { // sliced loop position? chan[i].transWave.updateSize(s->samples,loopStart,loopEnd); - chan[i].transWave.slice=transWaveInd.slice; - chan[i].transWave.slicePos(transWaveInd.slice); + chan[i].transWave.slicePos(double(chan[i].transWave.slice)/4095.0); loopStart=transWaveInd.sliceStart; loopEnd=transWaveInd.sliceEnd; } @@ -688,7 +686,7 @@ void DivPlatformES5506::tick(bool sysTick) { } chan[i].pcmChanged.transwaveInd=0; } - if ((!chan[i].pcmChanged.transwaveInd) && (!chan[i].isTransWave)) { + if ((!chan[i].pcmChanged.transwaveInd) && (!chan[i].isTranswave)) { if (chan[i].pcmChanged.index) { const int next=chan[i].pcm.next; bool sampleVaild=false; @@ -737,8 +735,7 @@ void DivPlatformES5506::tick(bool sysTick) { loopEnd=(double)transWaveInd.loopEnd; if (ins->amiga.transWave.sliceEnable) { // sliced loop position? chan[i].transWave.updateSize(s->samples,loopStart,loopEnd); - chan[i].transWave.slice=transWaveInd.slice; - chan[i].transWave.slicePos(transWaveInd.slice); + chan[i].transWave.slicePos(double(chan[i].transWave.slice)/4095.0); loopStart=transWaveInd.sliceStart; loopEnd=transWaveInd.sliceEnd; } @@ -790,7 +787,7 @@ void DivPlatformES5506::tick(bool sysTick) { double loopEnd=(double)s->loopEnd; if (ins->amiga.transWave.sliceEnable) { // sliced loop position? chan[i].transWave.updateSize(s->samples,loopStart,loopEnd); - chan[i].transWave.slicePos(chan[i].transWave.slice); + chan[i].transWave.slicePos(double(chan[i].transWave.slice)/4095.0); loopStart=chan[i].transWave.sliceStart; loopEnd=chan[i].transWave.sliceEnd; } @@ -798,8 +795,8 @@ void DivPlatformES5506::tick(bool sysTick) { const unsigned int nextLoopStart=(start+(unsigned int)(loopStart*2048.0))&0xfffff800; const unsigned int nextLoopEnd=(start+(unsigned int)((loopEnd-1.0)*2048.0))&0xffffff80; if ((chan[i].pcm.loopStart!=nextLoopStart) || (chan[i].pcm.loopEnd!=nextLoopEnd)) { - chan[i].pcm.loopStart=(start+(unsigned int)(loopStart*2048.0))&0xfffff800; - chan[i].pcm.loopEnd=(start+(unsigned int)((loopEnd-1.0)*2048.0))&0xffffff80; + chan[i].pcm.loopStart=nextLoopStart; + chan[i].pcm.loopEnd=nextLoopEnd; chan[i].pcmChanged.position=1; } } @@ -1002,11 +999,11 @@ void DivPlatformES5506::tick(bool sysTick) { int DivPlatformES5506::dispatch(DivCommand c) { switch (c.cmd) { case DIV_CMD_NOTE_ON: { + DivInstrument* ins=parent->getIns(chan[c.chan].ins); bool sampleVaild=false; if (((ins->amiga.useNoteMap && !ins->amiga.transWave.enable) && (c.value>=0 && c.value<120)) || ((!ins->amiga.useNoteMap && ins->amiga.transWave.enable) && (ins->amiga.transWave.ind>=0 && ins->amiga.transWave.indamiga.transWaveMap.size())) || ((!ins->amiga.useNoteMap && !ins->amiga.transWave.enable) && (ins->amiga.initSample>=0 && ins->amiga.initSamplesong.sampleLen))) { - DivInstrument* ins=parent->getIns(chan[c.chan].ins); DivInstrumentAmiga::NoteMap& noteMapind=ins->amiga.noteMap[c.value]; DivInstrumentAmiga::TransWaveMap& transWaveInd=ins->amiga.transWaveMap[ins->amiga.transWave.ind]; int sample=ins->amiga.initSample; @@ -1043,7 +1040,7 @@ int DivPlatformES5506::dispatch(DivCommand c) { if (ins->amiga.transWave.enable) { if (transWaveInd.loopMode!=DIV_SAMPLE_LOOPMODE_ONESHOT) { loopMode=transWaveInd.loopMode; - } else if ((chan[i].pcm.loopMode==DIV_SAMPLE_LOOPMODE_ONESHOT) || (!s->isLoopable())) { // default + } else if ((chan[c.chan].pcm.loopMode==DIV_SAMPLE_LOOPMODE_ONESHOT) || (!s->isLoopable())) { // default loopMode=DIV_SAMPLE_LOOPMODE_PINGPONG; } // get loop position @@ -1051,8 +1048,8 @@ int DivPlatformES5506::dispatch(DivCommand c) { loopEnd=(double)transWaveInd.loopEnd; if (ins->amiga.transWave.sliceEnable) { // sliced loop position? chan[c.chan].transWave.updateSize(s->samples,loopStart,loopEnd); - chan[c.chan].transWave.slice=transWaveInd.slice; - chan[c.chan].transWave.slicePos(transWaveInd.slice); + chan[c.chan].transWave.slice=ins->amiga.transWave.slice; + chan[c.chan].transWave.slicePos(double(ins->amiga.transWave.slice)/4095.0); loopStart=transWaveInd.sliceStart; loopEnd=transWaveInd.sliceEnd; } @@ -1173,6 +1170,7 @@ int DivPlatformES5506::dispatch(DivCommand c) { case DIV_CMD_WAVE: if (!chan[c.chan].useWave) { if (chan[c.chan].active) { + DivInstrument* ins=parent->getIns(chan[c.chan].ins); if (((ins->amiga.useNoteMap && !ins->amiga.transWave.enable) && (c.value>=0 && c.value<120)) || ((!ins->amiga.useNoteMap && ins->amiga.transWave.enable) && (c.value>=0 && c.valueamiga.transWaveMap.size())) || ((!ins->amiga.useNoteMap && !ins->amiga.transWave.enable) && (c.value>=0 && c.valuesong.sampleLen))) { @@ -1246,7 +1244,7 @@ int DivPlatformES5506::dispatch(DivCommand c) { if (chan[c.chan].active) { if (chan[c.chan].pcm.pause!=(bool)(c.value&1)) { chan[c.chan].pcm.pause=c.value&1; - pageWriteMask(0x00|i,0x5f,0x00,chan[c.chan].pcm.pause?0x0002:0x0000,0x0002); + pageWriteMask(0x00|c.chan,0x5f,0x00,chan[c.chan].pcm.pause?0x0002:0x0000,0x0002); } } break; @@ -1325,7 +1323,7 @@ void DivPlatformES5506::forceIns() { chan[i].volChanged.changed=0xff; chan[i].filterChanged.changed=0xff; chan[i].envChanged.changed=0xff; - chan[i].sample=-1; + chan[i].pcmChanged.changed=0xff; } } diff --git a/src/engine/platform/es5506.h b/src/engine/platform/es5506.h index 3f2d88de..4c4ad341 100644 --- a/src/engine/platform/es5506.h +++ b/src/engine/platform/es5506.h @@ -64,7 +64,7 @@ class DivPlatformES5506: public DivDispatch, public es550x_intf { } pcm; int freq, baseFreq, nextFreq, pitch, pitch2, note, nextNote, prevNote, ins, wave; unsigned int volMacroMax, panMacroMax; - bool active, insChanged, freqChanged, pcmChanged, keyOn, keyOff, inPorta, useWave, isReverseLoop, isTranswave, transwaveIRQ; + bool active, insChanged, freqChanged, keyOn, keyOff, inPorta, useWave, isReverseLoop, isTranswave, transwaveIRQ; unsigned int cr; struct NoteChanged { // Note changed flags @@ -181,7 +181,6 @@ class DivPlatformES5506: public DivDispatch, public es550x_intf { active(false), insChanged(true), freqChanged(false), - pcmChanged(false), keyOn(false), keyOff(false), inPorta(false), diff --git a/src/engine/platform/fds.cpp b/src/engine/platform/fds.cpp index 5698f004..ebf69fa2 100644 --- a/src/engine/platform/fds.cpp +++ b/src/engine/platform/fds.cpp @@ -185,7 +185,7 @@ void DivPlatformFDS::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } @@ -498,6 +498,10 @@ void DivPlatformFDS::notifyInsDeletion(void* ins) { } } +float DivPlatformFDS::getPostAmp() { + return useNP?2.0f:1.0f; +} + void DivPlatformFDS::poke(unsigned int addr, unsigned short val) { rWrite(addr,val); } diff --git a/src/engine/platform/fds.h b/src/engine/platform/fds.h index 1c08e1bb..c563a47f 100644 --- a/src/engine/platform/fds.h +++ b/src/engine/platform/fds.h @@ -99,6 +99,7 @@ class DivPlatformFDS: public DivDispatch { void setNSFPlay(bool use); void setFlags(unsigned int flags); void notifyInsDeletion(void* ins); + float getPostAmp(); void poke(unsigned int addr, unsigned short val); void poke(std::vector& wlist); const char** getRegisterSheet(); diff --git a/src/engine/platform/fmshared_OPN.h b/src/engine/platform/fmshared_OPN.h index 00573980..a709aa1a 100644 --- a/src/engine/platform/fmshared_OPN.h +++ b/src/engine/platform/fmshared_OPN.h @@ -32,4 +32,65 @@ #define ADDR_FB_ALG 0xb0 #define ADDR_LRAF 0xb4 +#define PLEASE_HELP_ME(_targetChan) \ + int boundaryBottom=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,0,false); \ + int boundaryTop=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,12,false); \ + int destFreq=NOTE_FNUM_BLOCK(c.value2,11); \ + int newFreq; \ + bool return2=false; \ + if (_targetChan.portaPause) { \ + if (parent->song.oldOctaveBoundary) { \ + if ((_targetChan.portaPauseFreq&0xf800)>(_targetChan.baseFreq&0xf800)) { \ + _targetChan.baseFreq=((_targetChan.baseFreq&0x7ff)>>1)|(_targetChan.portaPauseFreq&0xf800); \ + } else { \ + _targetChan.baseFreq=((_targetChan.baseFreq&0x7ff)<<1)|(_targetChan.portaPauseFreq&0xf800); \ + } \ + c.value*=2; \ + } else { \ + _targetChan.baseFreq=_targetChan.portaPauseFreq; \ + } \ + } \ + if (destFreq>_targetChan.baseFreq) { \ + newFreq=_targetChan.baseFreq+c.value; \ + if (newFreq>=destFreq) { \ + newFreq=destFreq; \ + return2=true; \ + } \ + } else { \ + newFreq=_targetChan.baseFreq-c.value; \ + if (newFreq<=destFreq) { \ + newFreq=destFreq; \ + return2=true; \ + } \ + } \ + /* check for octave boundary */ \ + /* what the heck! */ \ + if (!_targetChan.portaPause) { \ + if ((newFreq&0x7ff)>boundaryTop && (newFreq&0xf800)<0x3800) { \ + if (parent->song.fbPortaPause) { \ + _targetChan.portaPauseFreq=(boundaryBottom)|((newFreq+0x800)&0xf800); \ + _targetChan.portaPause=true; \ + break; \ + } else { \ + newFreq=((newFreq&0x7ff)>>1)|((newFreq+0x800)&0xf800); \ + } \ + } \ + if ((newFreq&0x7ff)0) { \ + if (parent->song.fbPortaPause) { \ + _targetChan.portaPauseFreq=newFreq=(boundaryTop-1)|((newFreq-0x800)&0xf800); \ + _targetChan.portaPause=true; \ + break; \ + } else { \ + newFreq=((newFreq&0x7ff)<<1)|((newFreq-0x800)&0xf800); \ + } \ + } \ + } \ + _targetChan.portaPause=false; \ + _targetChan.freqChanged=true; \ + _targetChan.baseFreq=newFreq; \ + if (return2) { \ + _targetChan.inPorta=false; \ + return 2; \ + } + #endif \ No newline at end of file diff --git a/src/engine/platform/gb.cpp b/src/engine/platform/gb.cpp index 963d2fde..40bf6a83 100644 --- a/src/engine/platform/gb.cpp +++ b/src/engine/platform/gb.cpp @@ -204,7 +204,7 @@ void DivPlatformGB::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/genesis.cpp b/src/engine/platform/genesis.cpp index 8915056e..d1bf35a6 100644 --- a/src/engine/platform/genesis.cpp +++ b/src/engine/platform/genesis.cpp @@ -339,7 +339,7 @@ void DivPlatformGenesis::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } @@ -347,7 +347,7 @@ void DivPlatformGenesis::tick(bool sysTick) { } if (chan[i].std.phaseReset.had) { - if (chan[i].std.phaseReset.val==1) { + if (chan[i].std.phaseReset.val==1 && chan[i].active) { chan[i].keyOn=true; } } @@ -758,48 +758,7 @@ int DivPlatformGenesis::dispatch(DivCommand c) { } break; } - int boundaryBottom=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,0,false); - int boundaryTop=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,12,false); - int destFreq=NOTE_FNUM_BLOCK(c.value2,11); - int newFreq; - bool return2=false; - if (chan[c.chan].portaPause) { - chan[c.chan].baseFreq=chan[c.chan].portaPauseFreq; - } - if (destFreq>chan[c.chan].baseFreq) { - newFreq=chan[c.chan].baseFreq+c.value; - if (newFreq>=destFreq) { - newFreq=destFreq; - return2=true; - } - } else { - newFreq=chan[c.chan].baseFreq-c.value; - if (newFreq<=destFreq) { - newFreq=destFreq; - return2=true; - } - } - // check for octave boundary - // what the heck! - if (!chan[c.chan].portaPause) { - if ((newFreq&0x7ff)>boundaryTop && (newFreq&0xf800)<0x3800) { - chan[c.chan].portaPauseFreq=(boundaryBottom)|((newFreq+0x800)&0xf800); - chan[c.chan].portaPause=true; - break; - } - if ((newFreq&0x7ff)0) { - chan[c.chan].portaPauseFreq=newFreq=(boundaryTop-1)|((newFreq-0x800)&0xf800); - chan[c.chan].portaPause=true; - break; - } - } - chan[c.chan].portaPause=false; - chan[c.chan].freqChanged=true; - chan[c.chan].baseFreq=newFreq; - if (return2) { - chan[c.chan].inPorta=false; - return 2; - } + PLEASE_HELP_ME(chan[c.chan]); break; } case DIV_CMD_SAMPLE_MODE: { diff --git a/src/engine/platform/genesisext.cpp b/src/engine/platform/genesisext.cpp index d9f2b7a8..9f768ad2 100644 --- a/src/engine/platform/genesisext.cpp +++ b/src/engine/platform/genesisext.cpp @@ -150,52 +150,7 @@ int DivPlatformGenesisExt::dispatch(DivCommand c) { } break; } - int boundaryBottom=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,0,false); - int boundaryTop=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,12,false); - int destFreq=NOTE_FNUM_BLOCK(c.value2,11); - int newFreq; - bool return2=false; - if (opChan[ch].portaPause) { - opChan[ch].baseFreq=opChan[ch].portaPauseFreq; - } - if (destFreq>opChan[ch].baseFreq) { - newFreq=opChan[ch].baseFreq+c.value; - if (newFreq>=destFreq) { - newFreq=destFreq; - return2=true; - } - } else { - newFreq=opChan[ch].baseFreq-c.value; - if (newFreq<=destFreq) { - newFreq=destFreq; - return2=true; - } - } - // what the heck! - if (!opChan[ch].portaPause) { - if ((newFreq&0x7ff)>boundaryTop && (newFreq&0xf800)<0x3800) { - if (parent->song.fbPortaPause) { - opChan[ch].portaPauseFreq=(boundaryBottom)|((newFreq+0x800)&0xf800); - opChan[ch].portaPause=true; - break; - } else { - newFreq=(newFreq>>1)|((newFreq+0x800)&0xf800); - } - } - if ((newFreq&0x7ff)0) { - if (parent->song.fbPortaPause) { - opChan[ch].portaPauseFreq=newFreq=(boundaryTop-1)|((newFreq-0x800)&0xf800); - opChan[ch].portaPause=true; - break; - } else { - newFreq=(newFreq<<1)|((newFreq-0x800)&0xf800); - } - } - } - opChan[ch].portaPause=false; - opChan[ch].freqChanged=true; - opChan[ch].baseFreq=newFreq; - if (return2) return 2; + PLEASE_HELP_ME(opChan[ch]); break; } case DIV_CMD_SAMPLE_MODE: { diff --git a/src/engine/platform/genesisext.h b/src/engine/platform/genesisext.h index b482663c..f6c1e3dc 100644 --- a/src/engine/platform/genesisext.h +++ b/src/engine/platform/genesisext.h @@ -27,7 +27,7 @@ class DivPlatformGenesisExt: public DivPlatformGenesis { unsigned char freqH, freqL; int freq, baseFreq, pitch, pitch2, portaPauseFreq, ins; signed char konCycles; - bool active, insChanged, freqChanged, keyOn, keyOff, portaPause; + bool active, insChanged, freqChanged, keyOn, keyOff, portaPause, inPorta; int vol; unsigned char pan; OpChannel(): @@ -45,6 +45,7 @@ class DivPlatformGenesisExt: public DivPlatformGenesis { keyOn(false), keyOff(false), portaPause(false), + inPorta(false), vol(0), pan(3) {} }; diff --git a/src/engine/platform/lynx.cpp b/src/engine/platform/lynx.cpp index dd5a2be0..a87ae763 100644 --- a/src/engine/platform/lynx.cpp +++ b/src/engine/platform/lynx.cpp @@ -142,23 +142,52 @@ const char* DivPlatformLynx::getEffectName(unsigned char effect) { } void DivPlatformLynx::acquire(short* bufL, short* bufR, size_t start, size_t len) { - mikey->sampleAudio( bufL + start, bufR + start, len, oscBuf ); + for (size_t h=start; h=0 && chan[i].samplesong.sampleLen) { + chan[i].sampleAccum-=chan[i].sampleFreq; + if (chan[i].sampleAccum<0) { + chan[i].sampleAccum+=rate; + DivSample* s=parent->getSample(chan[i].sample); + if (s!=NULL) { + if (isMuted[i]) { + WRITE_VOLUME(i,0); + chan[i].samplePos++; + } else { + WRITE_VOLUME(i,(s->data8[chan[i].samplePos++]*chan[i].outVol)>>7); + } + if (chan[i].samplePos>=(int)s->samples) { + chan[i].sample=-1; + } + } + } + } + } + + mikey->sampleAudio( bufL + h, bufR + h, 1, oscBuf ); + } } void DivPlatformLynx::tick(bool sysTick) { for (int i=0; i<4; i++) { chan[i].std.next(); if (chan[i].std.vol.had) { - chan[i].outVol=((chan[i].vol&127)*MIN(127,chan[i].std.vol.val))>>7; - WRITE_VOLUME(i,(isMuted[i]?0:(chan[i].outVol&127))); + if (chan[i].pcm) { + chan[i].outVol=((chan[i].vol&127)*MIN(64,chan[i].std.vol.val))>>6; + } else { + chan[i].outVol=((chan[i].vol&127)*MIN(127,chan[i].std.vol.val))>>7; + WRITE_VOLUME(i,(isMuted[i]?0:(chan[i].outVol&127))); + } } if (chan[i].std.arp.had) { if (!chan[i].inPorta) { if (chan[i].std.arp.mode) { chan[i].baseFreq=NOTE_PERIODIC(chan[i].std.arp.val); + if (chan[i].pcm) chan[i].sampleBaseFreq=parent->calcBaseFreq(1.0,1.0,chan[i].std.arp.val,false); chan[i].actualNote=chan[i].std.arp.val; } else { chan[i].baseFreq=NOTE_PERIODIC(chan[i].note+chan[i].std.arp.val); + if (chan[i].pcm) chan[i].sampleBaseFreq=parent->calcBaseFreq(1.0,1.0,chan[i].note+chan[i].std.arp.val,false); chan[i].actualNote=chan[i].note+chan[i].std.arp.val; } chan[i].freqChanged=true; @@ -166,6 +195,7 @@ void DivPlatformLynx::tick(bool sysTick) { } else { if (chan[i].std.arp.mode && chan[i].std.arp.finished) { chan[i].baseFreq=NOTE_PERIODIC(chan[i].note); + if (chan[i].pcm) chan[i].sampleBaseFreq=parent->calcBaseFreq(1.0,1.0,chan[i].note,false); chan[i].actualNote=chan[i].note; chan[i].freqChanged=true; } @@ -188,40 +218,75 @@ void DivPlatformLynx::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } chan[i].freqChanged=true; } + if (chan[i].std.phaseReset.had) { + if (chan[i].std.phaseReset.val==1) { + WRITE_LFSR(i, 0); + WRITE_OTHER(i, 0); + } + } + if (chan[i].freqChanged) { - if (chan[i].lfsr >= 0) { - WRITE_LFSR(i, (chan[i].lfsr&0xff)); - WRITE_OTHER(i, ((chan[i].lfsr&0xf00)>>4)); - chan[i].lfsr=-1; + if (chan[i].pcm) { + double off=1.0; + if (chan[i].sample>=0 && chan[i].samplesong.sampleLen) { + DivSample* s=parent->getSample(chan[i].sample); + if (s->centerRate<1) { + off=1.0; + } else { + off=(double)s->centerRate/8363.0; + } + } + chan[i].sampleFreq=off*parent->calcFreq(chan[i].sampleBaseFreq,chan[i].pitch,false,2,chan[i].pitch2,1,1); + WRITE_FEEDBACK(i,0); + WRITE_LFSR(i,0); + WRITE_OTHER(i,0); + WRITE_CONTROL(i,0x18); + WRITE_BACKUP(i,2); + } else { + if (chan[i].lfsr >= 0) { + WRITE_LFSR(i, (chan[i].lfsr&0xff)); + WRITE_OTHER(i, ((chan[i].lfsr&0xf00)>>4)); + chan[i].lfsr=-1; + } + chan[i].fd=parent->calcFreq(chan[i].baseFreq,chan[i].pitch,true,0,chan[i].pitch2,chipClock,CHIP_DIVIDER); + if (chan[i].std.duty.had) { + chan[i].duty=chan[i].std.duty.val; + WRITE_FEEDBACK(i, chan[i].duty.feedback); + } + WRITE_CONTROL(i, (chan[i].fd.clockDivider|0x18|chan[i].duty.int_feedback7)); + WRITE_BACKUP( i, chan[i].fd.backup ); } - chan[i].fd=parent->calcFreq(chan[i].baseFreq,chan[i].pitch,true,0,chan[i].pitch2,chipClock,CHIP_DIVIDER); - if (chan[i].std.duty.had) { - chan[i].duty=chan[i].std.duty.val; - WRITE_FEEDBACK(i, chan[i].duty.feedback); - } - WRITE_CONTROL(i, (chan[i].fd.clockDivider|0x18|chan[i].duty.int_feedback7)); - WRITE_BACKUP( i, chan[i].fd.backup ); chan[i].freqChanged=false; } else if (chan[i].std.duty.had) { chan[i].duty = chan[i].std.duty.val; - WRITE_FEEDBACK(i, chan[i].duty.feedback); - WRITE_CONTROL(i, (chan[i].fd.clockDivider|0x18|chan[i].duty.int_feedback7)); + if (!chan[i].pcm) { + WRITE_FEEDBACK(i, chan[i].duty.feedback); + WRITE_CONTROL(i, (chan[i].fd.clockDivider|0x18|chan[i].duty.int_feedback7)); + } } } } int DivPlatformLynx::dispatch(DivCommand c) { switch (c.cmd) { - case DIV_CMD_NOTE_ON: + case DIV_CMD_NOTE_ON: { + DivInstrument* ins=parent->getIns(chan[c.chan].ins,DIV_INS_MIKEY); + chan[c.chan].pcm=(ins->type==DIV_INS_AMIGA); if (c.value!=DIV_NOTE_NULL) { chan[c.chan].baseFreq=NOTE_PERIODIC(c.value); + if (chan[c.chan].pcm) { + chan[c.chan].sampleBaseFreq=parent->calcBaseFreq(1.0,1.0,c.value,false); + chan[c.chan].sample=ins->amiga.getSample(c.value); + chan[c.chan].sampleAccum=0; + chan[c.chan].samplePos=0; + } chan[c.chan].freqChanged=true; chan[c.chan].note=c.value; chan[c.chan].actualNote=c.value; @@ -232,10 +297,14 @@ int DivPlatformLynx::dispatch(DivCommand c) { WRITE_VOLUME(c.chan,(isMuted[c.chan]?0:(chan[c.chan].vol&127))); chan[c.chan].macroInit(parent->getIns(chan[c.chan].ins,DIV_INS_MIKEY)); break; + } case DIV_CMD_NOTE_OFF: chan[c.chan].active=false; WRITE_VOLUME(c.chan, 0); chan[c.chan].macroInit(NULL); + if (chan[c.chan].pcm) { + chan[c.chan].pcm=false; + } break; case DIV_CMD_LYNX_LFSR_LOAD: chan[c.chan].freqChanged=true; @@ -255,7 +324,7 @@ int DivPlatformLynx::dispatch(DivCommand c) { if (!chan[c.chan].std.vol.has) { chan[c.chan].outVol=c.value; } - if (chan[c.chan].active) WRITE_VOLUME(c.chan,(isMuted[c.chan]?0:(chan[c.chan].vol&127))); + if (chan[c.chan].active && !chan[c.chan].pcm) WRITE_VOLUME(c.chan,(isMuted[c.chan]?0:(chan[c.chan].vol&127))); } break; case DIV_CMD_PANNING: @@ -289,18 +358,26 @@ int DivPlatformLynx::dispatch(DivCommand c) { } } chan[c.chan].freqChanged=true; + if (chan[c.chan].pcm && parent->song.linearPitch==2) { + chan[c.chan].sampleBaseFreq=chan[c.chan].baseFreq; + } if (return2) { chan[c.chan].inPorta=false; return 2; } break; } - case DIV_CMD_LEGATO: - chan[c.chan].baseFreq=NOTE_PERIODIC(c.value+((chan[c.chan].std.arp.will && !chan[c.chan].std.arp.mode)?(chan[c.chan].std.arp.val):(0))); + case DIV_CMD_LEGATO: { + int whatAMess=c.value+((chan[c.chan].std.arp.will && !chan[c.chan].std.arp.mode)?(chan[c.chan].std.arp.val):(0)); + chan[c.chan].baseFreq=NOTE_PERIODIC(whatAMess); + if (chan[c.chan].pcm) { + chan[c.chan].sampleBaseFreq=parent->calcBaseFreq(1.0,1.0,whatAMess,false); + } chan[c.chan].freqChanged=true; chan[c.chan].note=c.value; chan[c.chan].actualNote=c.value; break; + } case DIV_CMD_PRE_PORTA: if (chan[c.chan].active && c.value2) { if (parent->song.resetMacroOnPorta) chan[c.chan].macroInit(parent->getIns(chan[c.chan].ins,DIV_INS_MIKEY)); diff --git a/src/engine/platform/lynx.h b/src/engine/platform/lynx.h index fab8b0f8..4f221d03 100644 --- a/src/engine/platform/lynx.h +++ b/src/engine/platform/lynx.h @@ -44,9 +44,9 @@ class DivPlatformLynx: public DivDispatch { DivMacroInt std; MikeyFreqDiv fd; MikeyDuty duty; - int baseFreq, pitch, pitch2, note, actualNote, lfsr, ins; + int baseFreq, pitch, pitch2, note, actualNote, lfsr, ins, sample, samplePos, sampleAccum, sampleBaseFreq, sampleFreq; unsigned char pan; - bool active, insChanged, freqChanged, keyOn, keyOff, inPorta; + bool active, insChanged, freqChanged, keyOn, keyOff, inPorta, pcm; signed char vol, outVol; void macroInit(DivInstrument* which) { std.init(which); @@ -63,6 +63,11 @@ class DivPlatformLynx: public DivDispatch { actualNote(0), lfsr(-1), ins(-1), + sample(-1), + samplePos(0), + sampleAccum(0), + sampleBaseFreq(0), + sampleFreq(0), pan(0xff), active(false), insChanged(true), @@ -70,6 +75,7 @@ class DivPlatformLynx: public DivDispatch { keyOn(false), keyOff(false), inPorta(false), + pcm(false), vol(127), outVol(127) {} }; diff --git a/src/engine/platform/mmc5.cpp b/src/engine/platform/mmc5.cpp index 97b5aa15..25eaae9f 100644 --- a/src/engine/platform/mmc5.cpp +++ b/src/engine/platform/mmc5.cpp @@ -134,7 +134,7 @@ void DivPlatformMMC5::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/msm6258.cpp b/src/engine/platform/msm6258.cpp new file mode 100644 index 00000000..826d221b --- /dev/null +++ b/src/engine/platform/msm6258.cpp @@ -0,0 +1,349 @@ +/** + * Furnace Tracker - multi-system chiptune tracker + * Copyright (C) 2021-2022 tildearrow and contributors + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#include "msm6258.h" +#include "../engine.h" +#include "../../ta-log.h" +#include "sound/oki/okim6258.h" +#include +#include + +#define rWrite(a,v) if (!skipRegisterWrites) {writes.emplace(a,v); if (dumpWrites) {addWrite(a,v);} } + +const char** DivPlatformMSM6258::getRegisterSheet() { + return NULL; +} + +const char* DivPlatformMSM6258::getEffectName(unsigned char effect) { + return NULL; +} + +void DivPlatformMSM6258::acquire(short* bufL, short* bufR, size_t start, size_t len) { + for (size_t h=start; hctrl_w(w.val); + break; + } + writes.pop(); + } + + if (sample>=0 && samplesong.sampleLen) { + DivSample* s=parent->getSample(sample); + unsigned char nextData=(s->dataVOX[samplePos]>>4)|(s->dataVOX[samplePos]<<4); + if (msm->data_w(nextData)) { + samplePos++; + if (samplePos>=(int)s->lengthVOX) { + sample=-1; + samplePos=0; + msm->ctrl_w(1); + } + } + } + + msm->sound_stream_update(outs,1); + if (isMuted[0]) { + bufL[h]=0; + } + + /*if (++updateOsc>=22) { + updateOsc=0; + // TODO: per-channel osc + for (int i=0; i<1; i++) { + oscBuf[i]->data[oscBuf[i]->needle++]=msm->m_voice[i].m_muted?0:(msm->m_voice[i].m_out<<6); + } + }*/ + } +} + +void DivPlatformMSM6258::tick(bool sysTick) { + // nothing +} + +int DivPlatformMSM6258::dispatch(DivCommand c) { + switch (c.cmd) { + case DIV_CMD_NOTE_ON: { + DivInstrument* ins=parent->getIns(chan[c.chan].ins,DIV_INS_FM); + if (ins->type==DIV_INS_AMIGA) { + chan[c.chan].furnacePCM=true; + } else { + chan[c.chan].furnacePCM=false; + } + if (skipRegisterWrites) break; + if (chan[c.chan].furnacePCM) { + chan[c.chan].macroInit(ins); + if (!chan[c.chan].std.vol.will) { + chan[c.chan].outVol=chan[c.chan].vol; + } + sample=ins->amiga.getSample(c.value); + if (sample>=0 && samplesong.sampleLen) { + //DivSample* s=parent->getSample(chan[c.chan].sample); + if (c.value!=DIV_NOTE_NULL) { + chan[c.chan].note=c.value; + chan[c.chan].freqChanged=true; + } + chan[c.chan].active=true; + chan[c.chan].keyOn=true; + rWrite(0,1); + rWrite(0,2); + } else { + break; + } + } else { + chan[c.chan].sample=-1; + chan[c.chan].macroInit(NULL); + chan[c.chan].outVol=chan[c.chan].vol; + if ((12*sampleBank+c.value%12)>=parent->song.sampleLen) { + break; + } + //DivSample* s=parent->getSample(12*sampleBank+c.value%12); + sample=12*sampleBank+c.value%12; + samplePos=0; + msm->ctrl_w(1); + msm->ctrl_w(2); + } + break; + } + case DIV_CMD_NOTE_OFF: + chan[c.chan].keyOff=true; + chan[c.chan].keyOn=false; + chan[c.chan].active=false; + rWrite(0,1); // turn off + sample=-1; + samplePos=0; + chan[c.chan].macroInit(NULL); + break; + case DIV_CMD_NOTE_OFF_ENV: + chan[c.chan].keyOff=true; + chan[c.chan].keyOn=false; + chan[c.chan].active=false; + rWrite(0,1); // turn off + sample=-1; + samplePos=0; + chan[c.chan].std.release(); + break; + case DIV_CMD_ENV_RELEASE: + chan[c.chan].std.release(); + break; + case DIV_CMD_VOLUME: { + chan[c.chan].vol=c.value; + if (!chan[c.chan].std.vol.has) { + chan[c.chan].outVol=c.value; + } + break; + } + case DIV_CMD_GET_VOLUME: { + return chan[c.chan].vol; + break; + } + case DIV_CMD_INSTRUMENT: + if (chan[c.chan].ins!=c.value || c.value2==1) { + chan[c.chan].insChanged=true; + } + chan[c.chan].ins=c.value; + break; + case DIV_CMD_PITCH: { + break; + } + case DIV_CMD_NOTE_PORTA: { + return 2; + } + case DIV_CMD_SAMPLE_BANK: + sampleBank=c.value; + if (sampleBank>(parent->song.sample.size()/12)) { + sampleBank=parent->song.sample.size()/12; + } + break; + case DIV_CMD_LEGATO: { + break; + } + case DIV_ALWAYS_SET_VOLUME: + return 0; + break; + case DIV_CMD_GET_VOLMAX: + return 8; + break; + case DIV_CMD_PRE_PORTA: + break; + case DIV_CMD_PRE_NOTE: + break; + default: + //printf("WARNING: unimplemented command %d\n",c.cmd); + break; + } + return 1; +} + +void DivPlatformMSM6258::muteChannel(int ch, bool mute) { + isMuted[ch]=mute; +} + +void DivPlatformMSM6258::forceIns() { + while (!writes.empty()) writes.pop(); + for (int i=0; i<1; i++) { + chan[i].insChanged=true; + } +} + +void* DivPlatformMSM6258::getChanState(int ch) { + return &chan[ch]; +} + +DivDispatchOscBuffer* DivPlatformMSM6258::getOscBuffer(int ch) { + return oscBuf[ch]; +} + +unsigned char* DivPlatformMSM6258::getRegisterPool() { + return NULL; +} + +int DivPlatformMSM6258::getRegisterPoolSize() { + return 0; +} + +void DivPlatformMSM6258::poke(unsigned int addr, unsigned short val) { + //immWrite(addr,val); +} + +void DivPlatformMSM6258::poke(std::vector& wlist) { + //for (DivRegWrite& i: wlist) immWrite(i.addr,i.val); +} + +void DivPlatformMSM6258::reset() { + while (!writes.empty()) writes.pop(); + msm->device_reset(); + if (dumpWrites) { + addWrite(0xffffffff,0); + } + for (int i=0; i<1; i++) { + chan[i]=DivPlatformMSM6258::Channel(); + chan[i].std.setEngine(parent); + } + for (int i=0; i<1; i++) { + chan[i].vol=8; + chan[i].outVol=8; + } + + sampleBank=0; + sample=-1; + samplePos=0; + + delay=0; +} + +bool DivPlatformMSM6258::keyOffAffectsArp(int ch) { + return false; +} + +void DivPlatformMSM6258::notifyInsChange(int ins) { + for (int i=0; i<1; i++) { + if (chan[i].ins==ins) { + chan[i].insChanged=true; + } + } +} + +void DivPlatformMSM6258::notifyInsDeletion(void* ins) { +} + +const void* DivPlatformMSM6258::getSampleMem(int index) { + return index == 0 ? adpcmMem : NULL; +} + +size_t DivPlatformMSM6258::getSampleMemCapacity(int index) { + return index == 0 ? 262144 : 0; +} + +size_t DivPlatformMSM6258::getSampleMemUsage(int index) { + return index == 0 ? adpcmMemLen : 0; +} + +void DivPlatformMSM6258::renderSamples() { + memset(adpcmMem,0,getSampleMemCapacity(0)); + + // sample data + size_t memPos=0; + int sampleCount=parent->song.sampleLen; + if (sampleCount>128) sampleCount=128; + for (int i=0; isong.sample[i]; + int paddedLen=s->lengthVOX; + if (memPos>=getSampleMemCapacity(0)) { + logW("out of ADPCM memory for sample %d!",i); + break; + } + if (memPos+paddedLen>=getSampleMemCapacity(0)) { + memcpy(adpcmMem+memPos,s->dataVOX,getSampleMemCapacity(0)-memPos); + logW("out of ADPCM memory for sample %d!",i); + } else { + memcpy(adpcmMem+memPos,s->dataVOX,paddedLen); + } + s->offVOX=memPos; + memPos+=paddedLen; + } + adpcmMemLen=memPos+256; +} + +void DivPlatformMSM6258::setFlags(unsigned int flags) { + if (flags&1) { + chipClock=4096000; + } else { + chipClock=4000000; + } + rate=chipClock/256; + for (int i=0; i<1; i++) { + isMuted[i]=false; + oscBuf[i]->rate=rate/256; + } +} + +int DivPlatformMSM6258::init(DivEngine* p, int channels, int sugRate, unsigned int flags) { + parent=p; + adpcmMem=new unsigned char[getSampleMemCapacity(0)]; + adpcmMemLen=0; + dumpWrites=false; + skipRegisterWrites=false; + updateOsc=0; + for (int i=0; i<1; i++) { + isMuted[i]=false; + oscBuf[i]=new DivDispatchOscBuffer; + } + msm=new okim6258_device(4000000); + msm->device_start(); + setFlags(flags); + reset(); + return 4; +} + +void DivPlatformMSM6258::quit() { + for (int i=0; i<1; i++) { + delete oscBuf[i]; + } + delete msm; + delete[] adpcmMem; +} + +DivPlatformMSM6258::~DivPlatformMSM6258() { +} diff --git a/src/engine/platform/msm6258.h b/src/engine/platform/msm6258.h new file mode 100644 index 00000000..ea0482f3 --- /dev/null +++ b/src/engine/platform/msm6258.h @@ -0,0 +1,129 @@ +/** + * Furnace Tracker - multi-system chiptune tracker + * Copyright (C) 2021-2022 tildearrow and contributors + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#ifndef _MSM6258_H +#define _MSM6258_H +#include "../dispatch.h" +#include "../macroInt.h" +#include +#include "sound/oki/okim6258.h" + +class DivPlatformMSM6258: public DivDispatch { + protected: + const unsigned short chanOffs[6]={ + 0x00, 0x01, 0x02, 0x100, 0x101, 0x102 + }; + + struct Channel { + unsigned char freqH, freqL; + int freq, baseFreq, pitch, pitch2, portaPauseFreq, note, ins; + unsigned char psgMode, autoEnvNum, autoEnvDen; + signed char konCycles; + bool active, insChanged, freqChanged, keyOn, keyOff, portaPause, inPorta, furnacePCM, hardReset; + int vol, outVol; + int sample; + unsigned char pan; + DivMacroInt std; + void macroInit(DivInstrument* which) { + std.init(which); + pitch2=0; + } + Channel(): + freqH(0), + freqL(0), + freq(0), + baseFreq(0), + pitch(0), + pitch2(0), + portaPauseFreq(0), + note(0), + ins(-1), + psgMode(1), + autoEnvNum(0), + autoEnvDen(0), + active(false), + insChanged(true), + freqChanged(false), + keyOn(false), + keyOff(false), + portaPause(false), + inPorta(false), + furnacePCM(false), + hardReset(false), + vol(0), + outVol(15), + sample(-1), + pan(3) {} + }; + Channel chan[1]; + DivDispatchOscBuffer* oscBuf[1]; + bool isMuted[1]; + struct QueuedWrite { + unsigned short addr; + unsigned char val; + bool addrOrVal; + QueuedWrite(unsigned short a, unsigned char v): addr(a), val(v), addrOrVal(false) {} + }; + std::queue writes; + okim6258_device* msm; + unsigned char regPool[512]; + unsigned char lastBusy; + + unsigned char* adpcmMem; + size_t adpcmMemLen; + unsigned char sampleBank; + + int delay, updateOsc, sample, samplePos; + + bool extMode; + + short oldWrites[512]; + short pendingWrites[512]; + + friend void putDispatchChan(void*,int,int); + + public: + void acquire(short* bufL, short* bufR, size_t start, size_t len); + int dispatch(DivCommand c); + void* getChanState(int chan); + DivDispatchOscBuffer* getOscBuffer(int chan); + unsigned char* getRegisterPool(); + int getRegisterPoolSize(); + void reset(); + void forceIns(); + void tick(bool sysTick=true); + void muteChannel(int ch, bool mute); + bool keyOffAffectsArp(int ch); + void notifyInsChange(int ins); + void notifyInsDeletion(void* ins); + void poke(unsigned int addr, unsigned short val); + void poke(std::vector& wlist); + void setFlags(unsigned int flags); + const char** getRegisterSheet(); + const char* getEffectName(unsigned char effect); + const void* getSampleMem(int index); + size_t getSampleMemCapacity(int index); + size_t getSampleMemUsage(int index); + void renderSamples(); + + int init(DivEngine* parent, int channels, int sugRate, unsigned int flags); + void quit(); + ~DivPlatformMSM6258(); +}; +#endif diff --git a/src/engine/platform/msm6295.cpp b/src/engine/platform/msm6295.cpp new file mode 100644 index 00000000..c426af01 --- /dev/null +++ b/src/engine/platform/msm6295.cpp @@ -0,0 +1,345 @@ +/** + * Furnace Tracker - multi-system chiptune tracker + * Copyright (C) 2021-2022 tildearrow and contributors + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#include "msm6295.h" +#include "../engine.h" +#include "../../ta-log.h" +#include +#include + +#define rWrite(v) if (!skipRegisterWrites) {writes.emplace(0,v); if (dumpWrites) {addWrite(0,v);} } + +const char** DivPlatformMSM6295::getRegisterSheet() { + return NULL; +} + +const char* DivPlatformMSM6295::getEffectName(unsigned char effect) { + return NULL; +} + +u8 DivMSM6295Interface::read_byte(u32 address) { + return adpcmMem[address&0xffff]; +} + +void DivPlatformMSM6295::acquire(short* bufL, short* bufR, size_t start, size_t len) { + for (size_t h=start; hcommand_w(w.val); + writes.pop(); + delay=32; + } + } else { + delay--; + } + + msm->tick(); + + bufL[h]=msm->out()<<4; + + if (++updateOsc>=22) { + updateOsc=0; + // TODO: per-channel osc + for (int i=0; i<4; i++) { + oscBuf[i]->data[oscBuf[i]->needle++]=msm->m_voice[i].m_muted?0:(msm->m_voice[i].m_out<<6); + } + } + } +} + +void DivPlatformMSM6295::tick(bool sysTick) { + // nothing +} + +int DivPlatformMSM6295::dispatch(DivCommand c) { + switch (c.cmd) { + case DIV_CMD_NOTE_ON: { + DivInstrument* ins=parent->getIns(chan[c.chan].ins,DIV_INS_FM); + if (ins->type==DIV_INS_AMIGA) { + chan[c.chan].furnacePCM=true; + } else { + chan[c.chan].furnacePCM=false; + } + if (skipRegisterWrites) break; + if (chan[c.chan].furnacePCM) { + chan[c.chan].macroInit(ins); + if (!chan[c.chan].std.vol.will) { + chan[c.chan].outVol=chan[c.chan].vol; + } + chan[c.chan].sample=ins->amiga.getSample(c.value); + if (chan[c.chan].sample>=0 && chan[c.chan].samplesong.sampleLen) { + //DivSample* s=parent->getSample(chan[c.chan].sample); + if (c.value!=DIV_NOTE_NULL) { + chan[c.chan].note=c.value; + chan[c.chan].freqChanged=true; + } + chan[c.chan].active=true; + chan[c.chan].keyOn=true; + rWrite((8<=parent->song.sampleLen) { + break; + } + //DivSample* s=parent->getSample(12*sampleBank+c.value%12); + chan[c.chan].sample=12*sampleBank+c.value%12; + rWrite((8<(parent->song.sample.size()/12)) { + sampleBank=parent->song.sample.size()/12; + } + iface.sampleBank=sampleBank; + break; + case DIV_CMD_LEGATO: { + break; + } + case DIV_ALWAYS_SET_VOLUME: + return 0; + break; + case DIV_CMD_GET_VOLMAX: + return 8; + break; + case DIV_CMD_PRE_PORTA: + break; + case DIV_CMD_PRE_NOTE: + break; + default: + //printf("WARNING: unimplemented command %d\n",c.cmd); + break; + } + return 1; +} + +void DivPlatformMSM6295::muteChannel(int ch, bool mute) { + isMuted[ch]=mute; + msm->m_voice[ch].m_muted=mute; +} + +void DivPlatformMSM6295::forceIns() { + while (!writes.empty()) writes.pop(); + for (int i=0; i<4; i++) { + chan[i].insChanged=true; + } +} + +void* DivPlatformMSM6295::getChanState(int ch) { + return &chan[ch]; +} + +DivDispatchOscBuffer* DivPlatformMSM6295::getOscBuffer(int ch) { + return oscBuf[ch]; +} + +unsigned char* DivPlatformMSM6295::getRegisterPool() { + return NULL; +} + +int DivPlatformMSM6295::getRegisterPoolSize() { + return 0; +} + +void DivPlatformMSM6295::poke(unsigned int addr, unsigned short val) { + //immWrite(addr,val); +} + +void DivPlatformMSM6295::poke(std::vector& wlist) { + //for (DivRegWrite& i: wlist) immWrite(i.addr,i.val); +} + +void DivPlatformMSM6295::reset() { + while (!writes.empty()) writes.pop(); + msm->reset(); + if (dumpWrites) { + addWrite(0xffffffff,0); + } + for (int i=0; i<4; i++) { + chan[i]=DivPlatformMSM6295::Channel(); + chan[i].std.setEngine(parent); + } + for (int i=0; i<4; i++) { + chan[i].vol=8; + chan[i].outVol=8; + } + + sampleBank=0; + + delay=0; +} + +bool DivPlatformMSM6295::keyOffAffectsArp(int ch) { + return false; +} + +void DivPlatformMSM6295::notifyInsChange(int ins) { + for (int i=0; i<4; i++) { + if (chan[i].ins==ins) { + chan[i].insChanged=true; + } + } +} + +void DivPlatformMSM6295::notifyInsDeletion(void* ins) { +} + +const void* DivPlatformMSM6295::getSampleMem(int index) { + return index == 0 ? adpcmMem : NULL; +} + +size_t DivPlatformMSM6295::getSampleMemCapacity(int index) { + return index == 0 ? 262144 : 0; +} + +size_t DivPlatformMSM6295::getSampleMemUsage(int index) { + return index == 0 ? adpcmMemLen : 0; +} + +void DivPlatformMSM6295::renderSamples() { + memset(adpcmMem,0,getSampleMemCapacity(0)); + + // sample data + size_t memPos=128*8; + int sampleCount=parent->song.sampleLen; + if (sampleCount>128) sampleCount=128; + for (int i=0; isong.sample[i]; + int paddedLen=s->lengthVOX; + if (memPos>=getSampleMemCapacity(0)) { + logW("out of ADPCM memory for sample %d!",i); + break; + } + if (memPos+paddedLen>=getSampleMemCapacity(0)) { + memcpy(adpcmMem+memPos,s->dataVOX,getSampleMemCapacity(0)-memPos); + logW("out of ADPCM memory for sample %d!",i); + } else { + memcpy(adpcmMem+memPos,s->dataVOX,paddedLen); + } + s->offVOX=memPos; + memPos+=paddedLen; + } + adpcmMemLen=memPos+256; + + // phrase book + for (int i=0; isong.sample[i]; + int endPos=s->offVOX+s->lengthVOX; + adpcmMem[i*8]=(s->offVOX>>16)&0xff; + adpcmMem[1+i*8]=(s->offVOX>>8)&0xff; + adpcmMem[2+i*8]=(s->offVOX)&0xff; + adpcmMem[3+i*8]=(endPos>>16)&0xff; + adpcmMem[4+i*8]=(endPos>>8)&0xff; + adpcmMem[5+i*8]=(endPos)&0xff; + } +} + +void DivPlatformMSM6295::setFlags(unsigned int flags) { + if (flags&1) { + chipClock=8448000; + } else { + chipClock=8000000; + } + rate=chipClock/((flags&2)?6:24); + for (int i=0; i<4; i++) { + isMuted[i]=false; + oscBuf[i]->rate=rate/22; + } +} + +int DivPlatformMSM6295::init(DivEngine* p, int channels, int sugRate, unsigned int flags) { + parent=p; + adpcmMem=new unsigned char[getSampleMemCapacity(0)]; + adpcmMemLen=0; + iface.adpcmMem=adpcmMem; + iface.sampleBank=0; + dumpWrites=false; + skipRegisterWrites=false; + updateOsc=0; + for (int i=0; i<4; i++) { + isMuted[i]=false; + oscBuf[i]=new DivDispatchOscBuffer; + } + msm=new msm6295_core(iface); + setFlags(flags); + reset(); + return 4; +} + +void DivPlatformMSM6295::quit() { + for (int i=0; i<4; i++) { + delete oscBuf[i]; + } + delete msm; + delete[] adpcmMem; +} + +DivPlatformMSM6295::~DivPlatformMSM6295() { +} diff --git a/src/engine/platform/msm6295.h b/src/engine/platform/msm6295.h new file mode 100644 index 00000000..bedaab41 --- /dev/null +++ b/src/engine/platform/msm6295.h @@ -0,0 +1,138 @@ +/** + * Furnace Tracker - multi-system chiptune tracker + * Copyright (C) 2021-2022 tildearrow and contributors + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#ifndef _MSM6295_H +#define _MSM6295_H +#include "../dispatch.h" +#include "../macroInt.h" +#include +#include "sound/oki/msm6295.hpp" + +class DivMSM6295Interface: public vgsound_emu_mem_intf { + public: + unsigned char* adpcmMem; + int sampleBank; + u8 read_byte(u32 address); + DivMSM6295Interface(): adpcmMem(NULL), sampleBank(0) {} +}; + +class DivPlatformMSM6295: public DivDispatch { + protected: + const unsigned short chanOffs[6]={ + 0x00, 0x01, 0x02, 0x100, 0x101, 0x102 + }; + + struct Channel { + unsigned char freqH, freqL; + int freq, baseFreq, pitch, pitch2, portaPauseFreq, note, ins; + unsigned char psgMode, autoEnvNum, autoEnvDen; + signed char konCycles; + bool active, insChanged, freqChanged, keyOn, keyOff, portaPause, inPorta, furnacePCM, hardReset; + int vol, outVol; + int sample; + unsigned char pan; + DivMacroInt std; + void macroInit(DivInstrument* which) { + std.init(which); + pitch2=0; + } + Channel(): + freqH(0), + freqL(0), + freq(0), + baseFreq(0), + pitch(0), + pitch2(0), + portaPauseFreq(0), + note(0), + ins(-1), + psgMode(1), + autoEnvNum(0), + autoEnvDen(0), + active(false), + insChanged(true), + freqChanged(false), + keyOn(false), + keyOff(false), + portaPause(false), + inPorta(false), + furnacePCM(false), + hardReset(false), + vol(0), + outVol(15), + sample(-1), + pan(3) {} + }; + Channel chan[4]; + DivDispatchOscBuffer* oscBuf[4]; + bool isMuted[4]; + struct QueuedWrite { + unsigned short addr; + unsigned char val; + bool addrOrVal; + QueuedWrite(unsigned short a, unsigned char v): addr(a), val(v), addrOrVal(false) {} + }; + std::queue writes; + msm6295_core* msm; + unsigned char regPool[512]; + unsigned char lastBusy; + + unsigned char* adpcmMem; + size_t adpcmMemLen; + DivMSM6295Interface iface; + unsigned char sampleBank; + + int delay, updateOsc; + + bool extMode; + + short oldWrites[512]; + short pendingWrites[512]; + + friend void putDispatchChan(void*,int,int); + + public: + void acquire(short* bufL, short* bufR, size_t start, size_t len); + int dispatch(DivCommand c); + void* getChanState(int chan); + DivDispatchOscBuffer* getOscBuffer(int chan); + unsigned char* getRegisterPool(); + int getRegisterPoolSize(); + void reset(); + void forceIns(); + void tick(bool sysTick=true); + void muteChannel(int ch, bool mute); + bool keyOffAffectsArp(int ch); + void notifyInsChange(int ins); + void notifyInsDeletion(void* ins); + void poke(unsigned int addr, unsigned short val); + void poke(std::vector& wlist); + void setFlags(unsigned int flags); + const char** getRegisterSheet(); + const char* getEffectName(unsigned char effect); + const void* getSampleMem(int index); + size_t getSampleMemCapacity(int index); + size_t getSampleMemUsage(int index); + void renderSamples(); + + int init(DivEngine* parent, int channels, int sugRate, unsigned int flags); + void quit(); + ~DivPlatformMSM6295(); +}; +#endif diff --git a/src/engine/platform/n163.cpp b/src/engine/platform/n163.cpp index 2e7c82a4..58a41693 100644 --- a/src/engine/platform/n163.cpp +++ b/src/engine/platform/n163.cpp @@ -268,7 +268,7 @@ void DivPlatformN163::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/namcowsg.cpp b/src/engine/platform/namcowsg.cpp index 4d519597..021ddf6c 100644 --- a/src/engine/platform/namcowsg.cpp +++ b/src/engine/platform/namcowsg.cpp @@ -244,7 +244,7 @@ void DivPlatformNamcoWSG::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/nes.cpp b/src/engine/platform/nes.cpp index c351e52a..ee645fb4 100644 --- a/src/engine/platform/nes.cpp +++ b/src/engine/platform/nes.cpp @@ -284,7 +284,7 @@ void DivPlatformNES::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/opl.cpp b/src/engine/platform/opl.cpp index c81fb6da..aed4c315 100644 --- a/src/engine/platform/opl.cpp +++ b/src/engine/platform/opl.cpp @@ -352,7 +352,7 @@ void DivPlatformOPL::tick(bool sysTick) { if (isMuted[i]) { rWrite(baseAddr+ADDR_KSL_TL,63|(op.ksl<<6)); } else { - if (isOutputL[ops==4][chan[i].state.alg][j] || i>=melodicChans) { + if (isOutputL[ops==4][chan[i].state.alg][j] || i>melodicChans) { rWrite(baseAddr+ADDR_KSL_TL,(63-(((63-op.tl)*(chan[i].outVol&0x3f))/63))|(op.ksl<<6)); } else { rWrite(baseAddr+ADDR_KSL_TL,op.tl|(op.ksl<<6)); @@ -384,7 +384,7 @@ void DivPlatformOPL::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } @@ -392,7 +392,7 @@ void DivPlatformOPL::tick(bool sysTick) { } if (chan[i].std.phaseReset.had) { - if (chan[i].std.phaseReset.val==1) { + if (chan[i].std.phaseReset.val==1 && chan[i].active) { chan[i].keyOn=true; } } @@ -479,7 +479,7 @@ void DivPlatformOPL::tick(bool sysTick) { if (isMuted[i]) { rWrite(baseAddr+ADDR_KSL_TL,63|(op.ksl<<6)); } else { - if (isOutputL[ops==4][chan[i].state.alg][j] || i>=melodicChans) { + if (isOutputL[ops==4][chan[i].state.alg][j] || i>melodicChans) { rWrite(baseAddr+ADDR_KSL_TL,(63-(((63-op.tl)*(chan[i].outVol&0x3f))/63))|(op.ksl<<6)); } else { rWrite(baseAddr+ADDR_KSL_TL,op.tl|(op.ksl<<6)); @@ -688,7 +688,7 @@ void DivPlatformOPL::muteChannel(int ch, bool mute) { if (isMuted[ch]) { rWrite(baseAddr+ADDR_KSL_TL,63|(op.ksl<<6)); } else { - if (isOutputL[ops==4][chan[ch].state.alg][i] || ch>=melodicChans) { + if (isOutputL[ops==4][chan[ch].state.alg][i] || ch>melodicChans) { rWrite(baseAddr+ADDR_KSL_TL,(63-(((63-op.tl)*(chan[ch].outVol&0x3f))/63))|(op.ksl<<6)); } else { rWrite(baseAddr+ADDR_KSL_TL,op.tl|(op.ksl<<6)); @@ -734,12 +734,12 @@ int DivPlatformOPL::dispatch(DivCommand c) { chan[c.chan].sample=ins->amiga.getSample(c.value); if (chan[c.chan].sample>=0 && chan[c.chan].samplesong.sampleLen) { DivSample* s=parent->getSample(chan[c.chan].sample); - immWrite(9,(s->offB>>5)&0xff); - immWrite(10,(s->offB>>13)&0xff); + immWrite(8,0); + immWrite(9,(s->offB>>2)&0xff); + immWrite(10,(s->offB>>10)&0xff); int end=s->offB+s->lengthB-1; - immWrite(11,(end>>5)&0xff); - immWrite(12,(end>>13)&0xff); - immWrite(8,1); + immWrite(11,(end>>2)&0xff); + immWrite(12,(end>>10)&0xff); immWrite(7,(s->loopStart>=0)?0xb0:0xa0); // start/repeat if (c.value!=DIV_NOTE_NULL) { chan[c.chan].note=c.value; @@ -769,12 +769,12 @@ int DivPlatformOPL::dispatch(DivCommand c) { break; } DivSample* s=parent->getSample(12*sampleBank+c.value%12); + immWrite(8,0); immWrite(9,(s->offB>>2)&0xff); immWrite(10,(s->offB>>10)&0xff); int end=s->offB+s->lengthB-1; immWrite(11,(end>>2)&0xff); immWrite(12,(end>>10)&0xff); - immWrite(8,1); immWrite(7,(s->loopStart>=0)?0xb0:0xa0); // start/repeat int freq=(65536.0*(double)s->rate)/(double)rate; immWrite(16,freq&0xff); @@ -808,7 +808,7 @@ int DivPlatformOPL::dispatch(DivCommand c) { if (isMuted[c.chan]) { rWrite(baseAddr+ADDR_KSL_TL,63|(op.ksl<<6)); } else { - if (isOutputL[ops==4][chan[c.chan].state.alg][i] || c.chan>=melodicChans) { + if (isOutputL[ops==4][chan[c.chan].state.alg][i] || c.chan>melodicChans) { rWrite(baseAddr+ADDR_KSL_TL,(63-(((63-op.tl)*(chan[c.chan].outVol&0x3f))/63))|(op.ksl<<6)); } else { rWrite(baseAddr+ADDR_KSL_TL,op.tl|(op.ksl<<6)); @@ -911,7 +911,7 @@ int DivPlatformOPL::dispatch(DivCommand c) { if (isMuted[c.chan]) { rWrite(baseAddr+ADDR_KSL_TL,63|(op.ksl<<6)); } else { - if (isOutputL[ops==4][chan[c.chan].state.alg][i] || c.chan>=melodicChans) { + if (isOutputL[ops==4][chan[c.chan].state.alg][i] || c.chan>melodicChans) { rWrite(baseAddr+ADDR_KSL_TL,(63-(((63-op.tl)*(chan[c.chan].outVol&0x3f))/63))|(op.ksl<<6)); } else { rWrite(baseAddr+ADDR_KSL_TL,op.tl|(op.ksl<<6)); @@ -1060,7 +1060,7 @@ int DivPlatformOPL::dispatch(DivCommand c) { if (isMuted[c.chan]) { rWrite(baseAddr+ADDR_KSL_TL,63|(op.ksl<<6)); } else { - if (isOutputL[ops==4][chan[c.chan].state.alg][c.value] || c.chan>=melodicChans) { + if (isOutputL[ops==4][chan[c.chan].state.alg][c.value] || c.chan>melodicChans) { rWrite(baseAddr+ADDR_KSL_TL,(63-(((63-op.tl)*(chan[c.chan].outVol&0x3f))/63))|(op.ksl<<6)); } else { rWrite(baseAddr+ADDR_KSL_TL,op.tl|(op.ksl<<6)); @@ -1290,7 +1290,7 @@ int DivPlatformOPL::dispatch(DivCommand c) { if (isMuted[c.chan]) { rWrite(baseAddr+ADDR_KSL_TL,63|(op.ksl<<6)); } else { - if (isOutputL[ops==4][chan[c.chan].state.alg][i] || c.chan>=melodicChans) { + if (isOutputL[ops==4][chan[c.chan].state.alg][i] || c.chan>melodicChans) { rWrite(baseAddr+ADDR_KSL_TL,(63-(((63-op.tl)*(chan[c.chan].outVol&0x3f))/63))|(op.ksl<<6)); } else { rWrite(baseAddr+ADDR_KSL_TL,op.tl|(op.ksl<<6)); @@ -1307,7 +1307,7 @@ int DivPlatformOPL::dispatch(DivCommand c) { if (isMuted[c.chan]) { rWrite(baseAddr+ADDR_KSL_TL,63|(op.ksl<<6)); } else { - if (isOutputL[ops==4][chan[c.chan].state.alg][c.value] || c.chan>=melodicChans) { + if (isOutputL[ops==4][chan[c.chan].state.alg][c.value] || c.chan>melodicChans) { rWrite(baseAddr+ADDR_KSL_TL,(63-(((63-op.tl)*(chan[c.chan].outVol&0x3f))/63))|(op.ksl<<6)); } else { rWrite(baseAddr+ADDR_KSL_TL,op.tl|(op.ksl<<6)); @@ -1367,9 +1367,10 @@ void DivPlatformOPL::forceIns() { totalChans=properDrums?11:9; } for (int i=0; i=melodicChans) { + if (isOutputL[ops==4][chan[i].state.alg][j] || i>melodicChans) { rWrite(baseAddr+ADDR_KSL_TL,(63-(((63-op.tl)*(chan[i].outVol&0x3f))/63))|(op.ksl<<6)); } else { rWrite(baseAddr+ADDR_KSL_TL,op.tl|(op.ksl<<6)); @@ -1406,6 +1407,10 @@ void DivPlatformOPL::forceIns() { rWrite(chanMap[i+1]+ADDR_LR_FB_ALG,((chan[i].state.alg>>1)&1)|(chan[i].state.fb<<1)|((chan[i].pan&3)<<4)); } } + */ + } + for (int i=0; i<512; i++) { + oldWrites[i]=-1; } immWrite(0xbd,(dam<<7)|(dvb<<6)|(properDrums<<5)|drumState); update4OpMask=true; @@ -1698,7 +1703,7 @@ int DivPlatformOPL::init(DivEngine* p, int channels, int sugRate, unsigned int f adpcmBMemLen=0; iface.adpcmBMem=adpcmBMem; iface.sampleBank=0; - adpcmB=new ymfm::adpcm_b_engine(iface,5); + adpcmB=new ymfm::adpcm_b_engine(iface,2); } reset(); diff --git a/src/engine/platform/opll.cpp b/src/engine/platform/opll.cpp index 0b3274e4..c232e68e 100644 --- a/src/engine/platform/opll.cpp +++ b/src/engine/platform/opll.cpp @@ -181,7 +181,7 @@ void DivPlatformOPLL::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } @@ -189,7 +189,7 @@ void DivPlatformOPLL::tick(bool sysTick) { } if (chan[i].std.phaseReset.had) { - if (chan[i].std.phaseReset.val==1) { + if (chan[i].std.phaseReset.val==1 && chan[i].active) { chan[i].keyOn=true; } } diff --git a/src/engine/platform/pce.cpp b/src/engine/platform/pce.cpp index 5013c2fe..ff171cc4 100644 --- a/src/engine/platform/pce.cpp +++ b/src/engine/platform/pce.cpp @@ -214,7 +214,7 @@ void DivPlatformPCE::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/pcspkr.cpp b/src/engine/platform/pcspkr.cpp index 8ecf6dae..91ddd5f2 100644 --- a/src/engine/platform/pcspkr.cpp +++ b/src/engine/platform/pcspkr.cpp @@ -216,7 +216,7 @@ void DivPlatformPCSpeaker::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/qsound.cpp b/src/engine/platform/qsound.cpp index 0992cd13..b562271e 100644 --- a/src/engine/platform/qsound.cpp +++ b/src/engine/platform/qsound.cpp @@ -331,7 +331,7 @@ void DivPlatformQSound::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/rf5c68.cpp b/src/engine/platform/rf5c68.cpp index b9ce1a18..830a1685 100644 --- a/src/engine/platform/rf5c68.cpp +++ b/src/engine/platform/rf5c68.cpp @@ -104,7 +104,7 @@ void DivPlatformRF5C68::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/saa.cpp b/src/engine/platform/saa.cpp index ec5f4f6d..31382068 100644 --- a/src/engine/platform/saa.cpp +++ b/src/engine/platform/saa.cpp @@ -189,7 +189,7 @@ void DivPlatformSAA1099::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/scc.cpp b/src/engine/platform/scc.cpp index 88132b12..1b9ad17d 100644 --- a/src/engine/platform/scc.cpp +++ b/src/engine/platform/scc.cpp @@ -146,7 +146,7 @@ void DivPlatformSCC::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } @@ -161,9 +161,14 @@ void DivPlatformSCC::tick(bool sysTick) { chan[i].freq=parent->calcFreq(chan[i].baseFreq,chan[i].pitch,true,0,chan[i].pitch2,chipClock,CHIP_DIVIDER)-1; if (chan[i].freq<0) chan[i].freq=0; if (chan[i].freq>4095) chan[i].freq=4095; - rWrite(regBase+0+i*2,chan[i].freq&0xff); - rWrite(regBase+1+i*2,chan[i].freq>>8); + if (!chan[i].freqInit || regPool[regBase+0+i*2]!=(chan[i].freq&0xff)) { + rWrite(regBase+0+i*2,chan[i].freq&0xff); + } + if (!chan[i].freqInit || regPool[regBase+1+i*2]!=(chan[i].freq>>8)) { + rWrite(regBase+1+i*2,chan[i].freq>>8); + } chan[i].freqChanged=false; + chan[i].freqInit=!skipRegisterWrites; } } } @@ -286,6 +291,7 @@ void DivPlatformSCC::forceIns() { for (int i=0; i<5; i++) { chan[i].insChanged=true; chan[i].freqChanged=true; + chan[i].freqInit=false; if (isPlus || i<3) { updateWave(i); } diff --git a/src/engine/platform/scc.h b/src/engine/platform/scc.h index 11d6521c..df6ef84e 100644 --- a/src/engine/platform/scc.h +++ b/src/engine/platform/scc.h @@ -29,7 +29,7 @@ class DivPlatformSCC: public DivDispatch { struct Channel { int freq, baseFreq, pitch, pitch2, note, ins; - bool active, insChanged, freqChanged, inPorta; + bool active, insChanged, freqChanged, freqInit, inPorta; signed char vol, outVol, wave; signed char waveROM[32] = {0}; // 4 bit PROM per channel on bubble system DivMacroInt std; @@ -48,6 +48,7 @@ class DivPlatformSCC: public DivDispatch { active(false), insChanged(true), freqChanged(false), + freqInit(false), inPorta(false), vol(15), outVol(15), diff --git a/src/engine/platform/segapcm.cpp b/src/engine/platform/segapcm.cpp index 75329f17..bdb894ff 100644 --- a/src/engine/platform/segapcm.cpp +++ b/src/engine/platform/segapcm.cpp @@ -122,7 +122,7 @@ void DivPlatformSegaPCM::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/sms.cpp b/src/engine/platform/sms.cpp index be2039cf..c0dd9ed5 100644 --- a/src/engine/platform/sms.cpp +++ b/src/engine/platform/sms.cpp @@ -21,7 +21,7 @@ #include "../engine.h" #include -#define rWrite(v) {if (!skipRegisterWrites) {sn->write(v); if (dumpWrites) {addWrite(0x200,v);}}} +#define rWrite(v) {if (!skipRegisterWrites) {writes.push(v); if (dumpWrites) {addWrite(0x200,v);}}} const char* regCheatSheetSN[]={ "DATA", "0", @@ -41,7 +41,47 @@ const char* DivPlatformSMS::getEffectName(unsigned char effect) { return NULL; } -void DivPlatformSMS::acquire(short* bufL, short* bufR, size_t start, size_t len) { +void DivPlatformSMS::acquire_nuked(short* bufL, short* bufR, size_t start, size_t len) { + for (size_t h=start; hdata[oscBuf[i]->needle++]=0; + } else { + oscBuf[i]->data[oscBuf[i]->needle++]=sn->get_channel_output(i); + } + }*/ + } +} + +void DivPlatformSMS::acquire_mame(short* bufL, short* bufR, size_t start, size_t len) { + while (!writes.empty()) { + unsigned char w=writes.front(); + sn->write(w); + writes.pop(); + } for (size_t h=start; hsound_stream_update(bufL+h,1); for (int i=0; i<4; i++) { @@ -54,6 +94,14 @@ void DivPlatformSMS::acquire(short* bufL, short* bufR, size_t start, size_t len) } } +void DivPlatformSMS::acquire(short* bufL, short* bufR, size_t start, size_t len) { + if (nuked) { + acquire_nuked(bufL,bufR,start,len); + } else { + acquire_mame(bufL,bufR,start,len); + } +} + int DivPlatformSMS::acquireOne() { short v; sn->sound_stream_update(&v,1); @@ -112,7 +160,7 @@ void DivPlatformSMS::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } @@ -301,6 +349,7 @@ DivDispatchOscBuffer* DivPlatformSMS::getOscBuffer(int ch) { } void DivPlatformSMS::reset() { + while (!writes.empty()) writes.pop(); for (int i=0; i<4; i++) { chan[i]=DivPlatformSMS::Channel(); chan[i].std.setEngine(parent); @@ -309,6 +358,7 @@ void DivPlatformSMS::reset() { addWrite(0xffffffff,0); } sn->device_start(); + YMPSG_Init(&sn_nuked,isRealSN); snNoiseMode=3; rWrite(0xe7); updateSNMode=false; @@ -352,6 +402,7 @@ void DivPlatformSMS::setFlags(unsigned int flags) { chipClock=COLOR_NTSC; } resetPhase=!(flags&16); + if (sn!=NULL) delete sn; switch ((flags>>2)&3) { case 1: // TI @@ -377,6 +428,10 @@ void DivPlatformSMS::setFlags(unsigned int flags) { } } +void DivPlatformSMS::setNuked(bool value) { + nuked=value; +} + int DivPlatformSMS::init(DivEngine* p, int channels, int sugRate, unsigned int flags) { parent=p; dumpWrites=false; diff --git a/src/engine/platform/sms.h b/src/engine/platform/sms.h index d1b52881..3c97a9a5 100644 --- a/src/engine/platform/sms.h +++ b/src/engine/platform/sms.h @@ -23,6 +23,10 @@ #include "../dispatch.h" #include "../macroInt.h" #include "sound/sn76496.h" +extern "C" { + #include "../../../extern/Nuked-PSG/ympsg.h" +} +#include class DivPlatformSMS: public DivDispatch { struct Channel { @@ -59,8 +63,14 @@ class DivPlatformSMS: public DivDispatch { bool updateSNMode; bool resetPhase; bool isRealSN; + bool nuked; sn76496_base_device* sn; + ympsg_t sn_nuked; + std::queue writes; friend void putDispatchChan(void*,int,int); + + void acquire_nuked(short* bufL, short* bufR, size_t start, size_t len); + void acquire_mame(short* bufL, short* bufR, size_t start, size_t len); public: int acquireOne(); void acquire(short* bufL, short* bufR, size_t start, size_t len); @@ -80,6 +90,7 @@ class DivPlatformSMS: public DivDispatch { void poke(std::vector& wlist); const char** getRegisterSheet(); const char* getEffectName(unsigned char effect); + void setNuked(bool value); int init(DivEngine* parent, int channels, int sugRate, unsigned int flags); void quit(); ~DivPlatformSMS(); diff --git a/src/engine/platform/sound/n163/n163.cpp b/src/engine/platform/sound/n163/n163.cpp index 20853963..e6801fc1 100644 --- a/src/engine/platform/sound/n163/n163.cpp +++ b/src/engine/platform/sound/n163/n163.cpp @@ -67,6 +67,7 @@ */ #include "n163.hpp" +#include void n163_core::tick() { @@ -126,12 +127,12 @@ void n163_core::reset() // reset this chip m_disable = false; m_multiplex = true; - std::fill(std::begin(m_ram), std::end(m_ram), 0); + memset(m_ram,0,sizeof(m_ram)); m_voice_cycle = 0x78; m_addr_latch.reset(); m_out = 0; m_acc = 0; - std::fill(std::begin(m_ch_out), std::end(m_ch_out), 0); + memset(m_ch_out,0,sizeof(m_ch_out)); } // accessor diff --git a/src/engine/platform/sound/nes_nsfplay/nes_fds.cpp b/src/engine/platform/sound/nes_nsfplay/nes_fds.cpp index 7599fa85..91b316e3 100644 --- a/src/engine/platform/sound/nes_nsfplay/nes_fds.cpp +++ b/src/engine/platform/sound/nes_nsfplay/nes_fds.cpp @@ -243,7 +243,7 @@ unsigned int NES_FDS::Render (int b[2]) int((MASTER_VOL / MAX_OUT) * 256.0 * 2.0f / 4.0f), int((MASTER_VOL / MAX_OUT) * 256.0 * 2.0f / 5.0f) }; - int v = fout * MASTER[master_vol] >> 8; + int v = fout * MASTER[master_vol] >> 1; // lowpass RC filter int rc_out = ((rc_accum * rc_k) + (v * rc_l)) >> RC_BITS; @@ -252,8 +252,8 @@ unsigned int NES_FDS::Render (int b[2]) // output mix int m = mask ? 0 : v; - b[0] = (m * sm[0]) >> 7; - b[1] = (m * sm[1]) >> 7; + b[0] = (m * sm[0]) >> 14; + b[1] = (m * sm[1]) >> 14; return 2; } diff --git a/src/engine/platform/sound/oki/msm6295.cpp b/src/engine/platform/sound/oki/msm6295.cpp new file mode 100644 index 00000000..7a455e1b --- /dev/null +++ b/src/engine/platform/sound/oki/msm6295.cpp @@ -0,0 +1,214 @@ +/* + License: BSD-3-Clause + see https://github.com/cam900/vgsound_emu/blob/main/LICENSE for more details + + Copyright holder(s): cam900 + OKI MSM6295 emulation core + + It is 4 channel ADPCM playback chip from OKI semiconductor. + It was becomes de facto standard for ADPCM playback in arcade machine, due to cost performance. + + The chip itself is pretty barebone: there is no "register" in chip. + It can't control volume and pitch in currently playing channels, only stopable them. + And volume is must be determined at playback start command. + + Command format: + + Playback command (2 byte): + + Byte Bit Description + 76543210 + 0 1xxxxxxx Phrase select (Header stored in ROM) + 1 x000---- Play channel 4 + 0x00---- Play channel 3 + 00x0---- Play channel 2 + 000x---- Play channel 1 + ----xxxx Volume + ----0000 0.0dB + ----0001 -3.2dB + ----0010 -6.0dB + ----0011 -9.2dB + ----0100 -12.0dB + ----0101 -14.5dB + ----0110 -18.0dB + ----0111 -20.5dB + ----1000 -24.0dB + + Suspend command (1 byte): + + Byte Bit Description + 76543210 + 0 0x------ Suspend channel 4 + 0-x----- Suspend channel 3 + 0--x---- Suspend channel 2 + 0---x--- Suspend channel 1 + + Frequency calculation: + if (SS) then + Frequency = Input clock / 165 + else then + Frequency = Input clock / 132 + +*/ + +#include "msm6295.hpp" + +#define CORE_DIVIDER 3 + +#define CHANNEL_DELAY (15/CORE_DIVIDER) +#define MASTER_DELAY (33/CORE_DIVIDER) + +void msm6295_core::tick() +{ + // command handler + if (m_command_pending) + { + if (bitfield(m_command, 7)) // play voice + { + if ((++m_clock) >= ((CHANNEL_DELAY * (m_ss ? 5 : 4)))) + { + m_clock = 0; + if (bitfield(m_next_command, 4, 4) != 0) + { + for (int i = 0; i < 4; i++) + { + if (bitfield(m_next_command, 4 + i)) + { + if (!m_voice[i].m_busy) + { + m_voice[i].m_command = m_command; + m_voice[i].m_volume = (bitfield(m_next_command, 0, 4) < 9) ? m_volume_table[std::min(8, bitfield(m_next_command, 0, 4))] : 0; + } + break; // voices aren't be playable simultaneously at once + } + } + } + m_command = 0; + m_command_pending = false; + } + } + else if (bitfield(m_next_command, 7)) // select phrase + { + if ((++m_clock) >= ((CHANNEL_DELAY * (m_ss ? 5 : 4)))) + { + m_clock = 0; + m_command = m_next_command; + m_command_pending = false; + } + } + else + { + if (bitfield(m_next_command, 3, 4) != 0) // suspend voices + { + for (int i = 0; i < 4; i++) + { + if (bitfield(m_next_command, 3 + i)) + { + if (m_voice[i].m_busy) + m_voice[i].m_command = m_next_command; + } + } + m_next_command &= ~0x78; + } + m_command_pending = false; + } + } + m_out = 0; + for (int i = 0; i < 4; i++) + { + m_voice[i].tick(); + if (!m_voice[i].m_muted) m_out += m_voice[i].m_out; + } +} + +void msm6295_core::reset() +{ + for (auto & elem : m_voice) + elem.reset(); + + m_command = 0; + m_next_command = 0; + m_command_pending = false; + m_clock = 0; + m_out = 0; +} + +void msm6295_core::voice_t::tick() +{ + if (!m_busy) + { + if (bitfield(m_command, 7)) + { + // get phrase header (stored in data memory) + const u32 phrase = bitfield(m_command, 0, 7) << 3; + // Start address + m_addr = (bitfield(m_host.m_intf.read_byte(phrase | 0), 0, 2) << 16) + | (m_host.m_intf.read_byte(phrase | 1) << 8) + | (m_host.m_intf.read_byte(phrase | 2) << 0); + // End address + m_end = (bitfield(m_host.m_intf.read_byte(phrase | 3), 0, 2) << 16) + | (m_host.m_intf.read_byte(phrase | 4) << 8) + | (m_host.m_intf.read_byte(phrase | 5) << 0); + m_nibble = 4; // MSB first, LSB second + m_command = 0; + m_busy = true; + vox_decoder_t::reset(); + } + m_out = 0; + } + else + { + // playback + if ((++m_clock) >= ((MASTER_DELAY * (m_host.m_ss ? 5 : 4)))) + { + m_clock = 0; + bool is_end = (m_command != 0); + m_curr.decode(bitfield(m_host.m_intf.read_byte(m_addr), m_nibble, 4)); + if (m_nibble <= 0) + { + m_nibble = 4; + if (++m_addr > m_end) + is_end = true; + } + else + m_nibble -= 4; + if (is_end) + { + m_command = 0; + m_busy = false; + } + m_out = (out() * m_volume) >> 7; // scale out to 12 bit output + } + } +} + +void msm6295_core::voice_t::reset() +{ + vox_decoder_t::reset(); + m_clock = 0; + m_busy = false; + m_command = 0; + m_addr = 0; + m_nibble = 0; + m_end = 0; + m_volume = 0; + m_out = 0; +} + +// accessors +u8 msm6295_core::busy_r() +{ + return (m_voice[0].m_busy ? 0x01 : 0x00) + | (m_voice[1].m_busy ? 0x02 : 0x00) + | (m_voice[2].m_busy ? 0x04 : 0x00) + | (m_voice[3].m_busy ? 0x08 : 0x00); +} + +void msm6295_core::command_w(u8 data) +{ + if (!m_command_pending) + { + m_next_command = data; + m_command_pending = true; + } +} diff --git a/src/engine/platform/sound/oki/msm6295.hpp b/src/engine/platform/sound/oki/msm6295.hpp new file mode 100644 index 00000000..f5684a29 --- /dev/null +++ b/src/engine/platform/sound/oki/msm6295.hpp @@ -0,0 +1,94 @@ +/* + License: BSD-3-Clause + see https://github.com/cam900/vgsound_emu/blob/main/LICENSE for more details + + Copyright holder(s): cam900 + OKI MSM6295 emulation core + + See msm6295.cpp for more info. +*/ + +#include "util.hpp" +#include "vox.hpp" +#include +#include + +#ifndef _VGSOUND_EMU_MSM6295_HPP +#define _VGSOUND_EMU_MSM6295_HPP + +#pragma once + +class msm6295_core : public vox_core +{ + friend class vgsound_emu_mem_intf; // common memory interface +public: + // constructor + msm6295_core(vgsound_emu_mem_intf &intf) + : m_voice{{*this,*this},{*this,*this},{*this,*this},{*this,*this}} + , m_intf(intf) + { + } + // accessors, getters, setters + u8 busy_r(); + void command_w(u8 data); + void ss_w(bool ss) { m_ss = ss; } // SS pin + + // internal state + void reset(); + void tick(); + + s32 out() { return m_out; } // built in 12 bit DAC + +private: + // Internal volume table, 9 step + const s32 m_volume_table[9] = { + 32/* 0.0dB */, + 22/* -3.2dB */, + 16/* -6.0dB */, + 11/* -9.2dB */, + 8/* -12.0dB */, + 6/* -14.5dB */, + 4/* -18.0dB */, + 3/* -20.5dB */, + 2/* -24.0dB */ }; // scale out to 5 bit for optimization + +public: + // msm6295 voice structs + struct voice_t : vox_decoder_t + { + // constructor + voice_t(vox_core &vox, msm6295_core &host) + : vox_decoder_t(vox) + , m_host(host) + {}; + + // internal state + virtual void reset() override; + void tick(); + + // accessors, getters, setters + // registers + msm6295_core &m_host; + u16 m_clock = 0; // clock counter + bool m_busy = false; // busy status + bool m_muted = false; // muted + u8 m_command = 0; // current command + u32 m_addr = 0; // current address + s8 m_nibble = 0; // current nibble + u32 m_end = 0; // end address + s32 m_volume = 0; // volume + s32 m_out = 0; // output + }; + voice_t m_voice[4]; +private: + vgsound_emu_mem_intf &m_intf; // common memory interface + + bool m_ss = false; // SS pin controls divider, input clock / 33 * (SS ? 5 : 4) + u8 m_command = 0; // Command byte + u8 m_next_command = 0; // Next command + bool m_command_pending = false; // command pending flag + u16 m_clock = 0; // clock counter + s32 m_out = 0; // 12 bit output +}; + +#endif diff --git a/src/engine/platform/sound/oki/okim6258.cpp b/src/engine/platform/sound/oki/okim6258.cpp index 349fe9ca..728507df 100644 --- a/src/engine/platform/sound/oki/okim6258.cpp +++ b/src/engine/platform/sound/oki/okim6258.cpp @@ -11,8 +11,10 @@ **********************************************************************************************/ -#include "emu.h" #include "okim6258.h" +#include +#include +#include #define COMMAND_STOP (1 << 0) #define COMMAND_PLAY (1 << 1) @@ -34,9 +36,6 @@ static int tables_computed = 0; -// device type definition -DEFINE_DEVICE_TYPE(OKIM6258, okim6258_device, "okim6258", "OKI MSM6258 ADPCM") - //************************************************************************** // LIVE DEVICE @@ -46,19 +45,18 @@ DEFINE_DEVICE_TYPE(OKIM6258, okim6258_device, "okim6258", "OKI MSM6258 ADPCM") // okim6258_device - constructor //------------------------------------------------- -okim6258_device::okim6258_device(const machine_config &mconfig, const char *tag, device_t *owner, uint32_t clock) - : device_t(mconfig, OKIM6258, tag, owner, clock), - device_sound_interface(mconfig, *this), +okim6258_device::okim6258_device(uint32_t clock) + : m_status(0), m_start_divider(0), m_divider(512), m_adpcm_type(0), m_data_in(0), m_nibble_shift(0), - m_stream(nullptr), m_output_bits(0), m_signal(0), - m_step(0) + m_step(0), + m_clock(clock) { } @@ -114,12 +112,9 @@ void okim6258_device::device_start() m_divider = dividers[m_start_divider]; - m_stream = stream_alloc(0, 1, clock()/m_divider); - m_signal = -2; m_step = 0; - - state_save_register(); + m_has_data = false; } @@ -129,11 +124,10 @@ void okim6258_device::device_start() void okim6258_device::device_reset() { - m_stream->update(); - m_signal = -2; m_step = 0; m_status = 0; + m_has_data = false; } @@ -141,7 +135,7 @@ void okim6258_device::device_reset() // sound_stream_update - handle a stream update //------------------------------------------------- -void okim6258_device::sound_stream_update(sound_stream &stream, std::vector const &inputs, std::vector &outputs) +void okim6258_device::sound_stream_update(short** outputs, int len) { auto &buffer = outputs[0]; @@ -149,7 +143,7 @@ void okim6258_device::sound_stream_update(sound_stream &stream, std::vector> nibble_shift) & 0xf; @@ -159,7 +153,9 @@ void okim6258_device::sound_stream_update(sound_stream &stream, std::vectorset_sample_rate(clock() / m_divider); } @@ -248,7 +225,7 @@ void okim6258_device::device_clock_changed() int okim6258_device::get_vclk() { - return (clock() / m_divider); + return (m_clock / m_divider); } @@ -260,8 +237,6 @@ int okim6258_device::get_vclk() uint8_t okim6258_device::status_r() { - m_stream->update(); - return (m_status & STATUS_PLAYING) ? 0x00 : 0x80; } @@ -271,13 +246,13 @@ uint8_t okim6258_device::status_r() okim6258_data_w -- write to the control port of an OKIM6258-compatible chip ***********************************************************************************************/ -void okim6258_device::data_w(uint8_t data) +bool okim6258_device::data_w(uint8_t data) { - /* update the stream */ - m_stream->update(); - + if (m_has_data) return false; m_data_in = data; m_nibble_shift = 0; + m_has_data = true; + return true; } @@ -289,11 +264,10 @@ void okim6258_device::data_w(uint8_t data) void okim6258_device::ctrl_w(uint8_t data) { - m_stream->update(); - if (data & COMMAND_STOP) { m_status &= ~(STATUS_PLAYING | STATUS_RECORDING); + m_has_data = false; return; } @@ -316,7 +290,7 @@ void okim6258_device::ctrl_w(uint8_t data) if (data & COMMAND_RECORD) { - logerror("M6258: Record enabled\n"); + //logerror("M6258: Record enabled\n"); m_status |= STATUS_RECORDING; } else diff --git a/src/engine/platform/sound/oki/okim6258.h b/src/engine/platform/sound/oki/okim6258.h index 95189f0e..88a429d3 100644 --- a/src/engine/platform/sound/oki/okim6258.h +++ b/src/engine/platform/sound/oki/okim6258.h @@ -3,8 +3,7 @@ #ifndef MAME_SOUND_OKIM6258_H #define MAME_SOUND_OKIM6258_H -#pragma once - +#include //************************************************************************** // TYPE DEFINITIONS @@ -12,9 +11,7 @@ // ======================> okim6258_device -class okim6258_device : public device_t, - public device_sound_interface -{ +class okim6258_device { public: static constexpr int FOSC_DIV_BY_1024 = 0; static constexpr int FOSC_DIV_BY_768 = 1; @@ -26,7 +23,7 @@ public: static constexpr int OUTPUT_10BITS = 10; static constexpr int OUTPUT_12BITS = 12; - okim6258_device(const machine_config &mconfig, const char *tag, device_t *owner, uint32_t clock); + okim6258_device(uint32_t clock); // configuration void set_start_div(int div) { m_start_divider = div; } @@ -34,23 +31,21 @@ public: void set_outbits(int outbit) { m_output_bits = outbit; } uint8_t status_r(); - void data_w(uint8_t data); + bool data_w(uint8_t data); void ctrl_w(uint8_t data); void set_divider(int val); int get_vclk(); -protected: - // device-level overrides - virtual void device_start() override; - virtual void device_reset() override; - virtual void device_clock_changed() override; + // device-levels + void device_start(); + void device_reset(); + void device_clock_changed(); - // sound stream update overrides - virtual void sound_stream_update(sound_stream &stream, std::vector const &inputs, std::vector &outputs) override; + // sound stream updates + void sound_stream_update(short** outputs, int len); private: - void state_save_register(); int16_t clock_adpcm(uint8_t nibble); uint8_t m_status; @@ -59,16 +54,15 @@ private: uint32_t m_divider; /* master clock divider */ uint8_t m_adpcm_type; /* 3/4 bit ADPCM select */ uint8_t m_data_in; /* ADPCM data-in register */ + bool m_has_data; /* whether we already have data */ uint8_t m_nibble_shift; /* nibble select */ - sound_stream *m_stream; /* which stream are we playing on? */ uint8_t m_output_bits; /* D/A precision is 10-bits but 12-bit data can be output serially to an external DAC */ int32_t m_signal; int32_t m_step; + unsigned int m_clock; }; -DECLARE_DEVICE_TYPE(OKIM6258, okim6258_device) - #endif // MAME_SOUND_OKIM6258_H diff --git a/src/engine/platform/sound/oki/util.hpp b/src/engine/platform/sound/oki/util.hpp new file mode 100644 index 00000000..71e10cbe --- /dev/null +++ b/src/engine/platform/sound/oki/util.hpp @@ -0,0 +1,158 @@ +/* + License: BSD-3-Clause + see https://github.com/cam900/vgsound_emu/blob/main/LICENSE for more details + + Copyright holders: cam900 + Various core utilities for vgsound_emu +*/ + +#include +#include +#include + +#ifndef _VGSOUND_EMU_CORE_UTIL_HPP +#define _VGSOUND_EMU_CORE_UTIL_HPP + +#pragma once + +typedef unsigned char u8; +typedef unsigned short u16; +typedef unsigned int u32; +typedef unsigned long long u64; +typedef signed char s8; +typedef signed short s16; +typedef signed int s32; +typedef signed long long s64; +typedef float f32; +typedef double f64; + +const f64 PI = 3.1415926535897932384626433832795; + +// get bitfield, bitfield(input, position, len) +template T bitfield(T in, u8 pos, u8 len = 1) +{ + return (in >> pos) & (len ? (T(1 << len) - 1) : 1); +} + +// get sign extended value, sign_ext(input, len) +template T sign_ext(T in, u8 len) +{ + len = std::max(0, (8 * sizeof(T)) - len); + return T(T(in) << len) >> len; +} + +// convert attenuation decibel value to gain +inline f32 dB_to_gain(f32 attenuation) +{ + return powf(10.0f, attenuation / 20.0f); +} + +class vgsound_emu_mem_intf +{ +public: + virtual u8 read_byte(u32 address) { return 0; } + virtual u16 read_word(u32 address) { return 0; } + virtual u32 read_dword(u32 address) { return 0; } + virtual u64 read_qword(u32 address) { return 0; } + virtual void write_byte(u32 address, u8 data) { } + virtual void write_word(u32 address, u16 data) { } + virtual void write_dword(u32 address, u32 data) { } + virtual void write_qword(u32 address, u64 data) { } +}; + +template +struct clock_pulse_t +{ + void reset(T init = InitWidth) + { + m_edge.reset(); + m_width = m_width_latch = m_counter = init; + m_cycle = 0; + } + + bool tick(T width = 0) + { + bool carry = ((--m_counter) <= 0); + if (carry) + { + if (!width) + m_width = m_width_latch; + else + m_width = width; // reset width + m_counter = m_width; + m_cycle = 0; + } + else + m_cycle++; + + m_edge.tick(carry); + return carry; + } + + void set_width(T width) { m_width = width; } + void set_width_latch(T width) { m_width_latch = width; } + + // Accessors + bool current_edge() { return m_edge.m_current; } + bool rising_edge() { return m_edge.m_rising; } + bool falling_edge() { return m_edge.m_rising; } + T cycle() { return m_cycle; } + + struct edge_t + { + edge_t() + : m_current(InitEdge ^ 1) + , m_previous(InitEdge) + , m_rising(0) + , m_falling(0) + , m_changed(0) + { + set(InitEdge); + } + + void tick(bool toggle) + { + u8 current = m_current; + if (toggle) + current ^= 1; + set(current); + } + + void set(u8 edge) + { + edge &= 1; + m_rising = m_falling = m_changed = 0; + if (m_current != edge) + { + m_changed = 1; + if (m_current && (!edge)) + m_falling = 1; + else if ((!m_current) && edge) + m_rising = 1; + m_current = edge; + } + m_previous = m_current; + } + + void reset() + { + m_previous = InitEdge; + m_current = InitEdge ^ 1; + set(InitEdge); + } + + u8 m_current : 1; // current edge + u8 m_previous : 1; // previous edge + u8 m_rising : 1; // rising edge + u8 m_falling : 1; // falling edge + u8 m_changed : 1; // changed flag + }; + + edge_t m_edge; + T m_width = InitWidth; // clock pulse width + T m_width_latch = InitWidth; // clock pulse width latch + T m_counter = InitWidth; // clock counter + T m_cycle = 0; // clock cycle +}; + +#endif diff --git a/src/engine/platform/sound/oki/vox.hpp b/src/engine/platform/sound/oki/vox.hpp new file mode 100644 index 00000000..b1fc6e23 --- /dev/null +++ b/src/engine/platform/sound/oki/vox.hpp @@ -0,0 +1,115 @@ +/* + License: BSD-3-Clause + see https://github.com/cam900/vgsound_emu/blob/main/LICENSE for more details + + Copyright holder(s): cam900 + Dialogic ADPCM core +*/ + +#include "util.hpp" +#include +#include + +#ifndef _VGSOUND_EMU_CORE_VOX_HPP +#define _VGSOUND_EMU_CORE_VOX_HPP + +#pragma once + +#define MODIFIED_CLAMP(x,xMin,xMax) (std::min(std::max((x),(xMin)),(xMax))) + +class vox_core +{ +protected: + struct vox_decoder_t + { + vox_decoder_t(vox_core &vox) + : m_curr(vox) + , m_loop(vox) + { }; + + virtual void reset() + { + m_curr.reset(); + m_loop.reset(); + m_loop_saved = false; + } + + void save() + { + if (!m_loop_saved) + { + m_loop.copy(m_curr); + m_loop_saved = true; + } + } + + void restore() + { + if (m_loop_saved) + m_curr.copy(m_loop); + } + + s32 out() { return m_curr.m_step; } + + struct decoder_state_t + { + decoder_state_t(vox_core &vox) + : m_vox(vox) + { }; + + void reset() + { + m_index = 0; + m_step = 16; + } + + void copy(decoder_state_t src) + { + m_index = src.m_index; + m_step = src.m_step; + } + + void decode(u8 nibble) + { + const u8 delta = bitfield(nibble, 0, 3); + s16 ss = m_vox.m_step_table[m_index]; // ss(n) + + // d(n) = (ss(n) * B2) + ((ss(n) / 2) * B1) + ((ss(n) / 4) * B0) + (ss(n) / 8) + s16 d = ss >> 3; + if (bitfield(delta, 2)) + d += ss; + if (bitfield(delta, 1)) + d += (ss >> 1); + if (bitfield(delta, 0)) + d += (ss >> 2); + + // if (B3 = 1) then d(n) = d(n) * (-1) X(n) = X(n-1) * d(n) + if (bitfield(nibble, 3)) + m_step = std::max(m_step - d, -2048); + else + m_step = std::min(m_step + d, 2047); + + // adjust step index + m_index = MODIFIED_CLAMP(m_index + m_vox.m_index_table[delta], 0, 48); + } + + vox_core &m_vox; + s8 m_index = 0; + s32 m_step = 16; + }; + + decoder_state_t m_curr; + decoder_state_t m_loop; + bool m_loop_saved = false; + }; + + s8 m_index_table[8] = {-1, -1, -1, -1, 2, 4, 6, 8}; + s32 m_step_table[49] = { + 16, 17, 19, 21, 23, 25, 28, 31, 34, 37, 41, 45, + 50, 55, 60, 66, 73, 80, 88, 97, 107, 118, 130, 143, + 157, 173, 190, 209, 230, 253, 279, 307, 337, 371, 408, 449, + 494, 544, 598, 658, 724, 796, 876, 963, 1060, 1166, 1282, 1411, 1552 + }; +}; + +#endif diff --git a/src/engine/platform/sound/scc/scc.cpp b/src/engine/platform/sound/scc/scc.cpp index db74d3f0..b9758fae 100644 --- a/src/engine/platform/sound/scc/scc.cpp +++ b/src/engine/platform/sound/scc/scc.cpp @@ -322,6 +322,7 @@ */ #include "scc.hpp" +#include // shared SCC features void scc_core::tick() @@ -372,12 +373,12 @@ void scc_core::reset() m_test.reset(); m_out = 0; - std::fill(std::begin(m_reg), std::end(m_reg), 0); + memset(m_reg,0,sizeof(m_reg)); } void scc_core::voice_t::reset() { - std::fill(std::begin(wave), std::end(wave), 0); + memset(wave,0,sizeof(wave)); enable = false; pitch = 0; volume = 0; @@ -454,6 +455,7 @@ void scc_core::freq_vol_enable_w(u8 address, u8 data) if (m_test.resetpos) // Reset address m_voice[voice_freq].addr = 0; m_voice[voice_freq].pitch = (m_voice[voice_freq].pitch & ~0x0ff) | data; + m_voice[voice_freq].counter = m_voice[voice_freq].pitch; break; case 0x1: // 0x*1 Voice 0 Pitch MSB case 0x3: // 0x*3 Voice 1 Pitch MSB @@ -463,6 +465,7 @@ void scc_core::freq_vol_enable_w(u8 address, u8 data) if (m_test.resetpos) // Reset address m_voice[voice_freq].addr = 0; m_voice[voice_freq].pitch = (m_voice[voice_freq].pitch & ~0xf00) | (u16(bitfield(data, 0, 4)) << 8); + m_voice[voice_freq].counter = m_voice[voice_freq].pitch; break; case 0xa: // 0x*a Voice 0 Volume case 0xb: // 0x*b Voice 1 Volume diff --git a/src/engine/platform/sound/vrcvi/vrcvi.cpp b/src/engine/platform/sound/vrcvi/vrcvi.cpp index bca3ecda..a6561db8 100644 --- a/src/engine/platform/sound/vrcvi/vrcvi.cpp +++ b/src/engine/platform/sound/vrcvi/vrcvi.cpp @@ -81,6 +81,7 @@ */ #include "vrcvi.hpp" +#include void vrcvi_core::tick() { @@ -119,7 +120,7 @@ void vrcvi_core::reset() m_timer.reset(); m_control.reset(); m_out = 0; - std::fill(std::begin(m_ch_out),std::end(m_ch_out),0); + memset(m_ch_out,0,sizeof(m_ch_out)); } bool vrcvi_core::alu_t::tick() diff --git a/src/engine/platform/su.cpp b/src/engine/platform/su.cpp index 3e638ac5..b9e7f319 100644 --- a/src/engine/platform/su.cpp +++ b/src/engine/platform/su.cpp @@ -168,7 +168,7 @@ void DivPlatformSoundUnit::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/swan.cpp b/src/engine/platform/swan.cpp index f8e5e2aa..1e2274c6 100644 --- a/src/engine/platform/swan.cpp +++ b/src/engine/platform/swan.cpp @@ -190,7 +190,7 @@ void DivPlatformSwan::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/tia.cpp b/src/engine/platform/tia.cpp index d3bd5ce2..e74533d5 100644 --- a/src/engine/platform/tia.cpp +++ b/src/engine/platform/tia.cpp @@ -119,7 +119,7 @@ void DivPlatformTIA::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/tx81z.cpp b/src/engine/platform/tx81z.cpp index ca3e7492..569f722b 100644 --- a/src/engine/platform/tx81z.cpp +++ b/src/engine/platform/tx81z.cpp @@ -317,7 +317,7 @@ void DivPlatformTX81Z::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } @@ -325,7 +325,7 @@ void DivPlatformTX81Z::tick(bool sysTick) { } if (chan[i].std.phaseReset.had) { - if (chan[i].std.phaseReset.val==1) { + if (chan[i].std.phaseReset.val==1 && chan[i].active) { chan[i].keyOn=true; } } diff --git a/src/engine/platform/vera.cpp b/src/engine/platform/vera.cpp index 5ca16458..98f36139 100644 --- a/src/engine/platform/vera.cpp +++ b/src/engine/platform/vera.cpp @@ -201,7 +201,7 @@ void DivPlatformVERA::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/vic20.cpp b/src/engine/platform/vic20.cpp index 1c8c1fe0..708db4ab 100644 --- a/src/engine/platform/vic20.cpp +++ b/src/engine/platform/vic20.cpp @@ -125,7 +125,7 @@ void DivPlatformVIC20::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/vrc6.cpp b/src/engine/platform/vrc6.cpp index 08e3f428..24fef0f8 100644 --- a/src/engine/platform/vrc6.cpp +++ b/src/engine/platform/vrc6.cpp @@ -189,7 +189,7 @@ void DivPlatformVRC6::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/x1_010.cpp b/src/engine/platform/x1_010.cpp index c161b56b..eb5a1069 100644 --- a/src/engine/platform/x1_010.cpp +++ b/src/engine/platform/x1_010.cpp @@ -390,7 +390,7 @@ void DivPlatformX1_010::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/ym2203.cpp b/src/engine/platform/ym2203.cpp index 057c98b7..3303fbf8 100644 --- a/src/engine/platform/ym2203.cpp +++ b/src/engine/platform/ym2203.cpp @@ -373,7 +373,7 @@ void DivPlatformYM2203::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } @@ -381,7 +381,7 @@ void DivPlatformYM2203::tick(bool sysTick) { } if (chan[i].std.phaseReset.had) { - if (chan[i].std.phaseReset.val==1) { + if (chan[i].std.phaseReset.val==1 && chan[i].active) { chan[i].keyOn=true; } } @@ -659,48 +659,7 @@ int DivPlatformYM2203::dispatch(DivCommand c) { } break; } - int boundaryBottom=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,0,false); - int boundaryTop=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,12,false); - int destFreq=NOTE_FNUM_BLOCK(c.value2,11); - int newFreq; - bool return2=false; - if (chan[c.chan].portaPause) { - chan[c.chan].baseFreq=chan[c.chan].portaPauseFreq; - } - if (destFreq>chan[c.chan].baseFreq) { - newFreq=chan[c.chan].baseFreq+c.value; - if (newFreq>=destFreq) { - newFreq=destFreq; - return2=true; - } - } else { - newFreq=chan[c.chan].baseFreq-c.value; - if (newFreq<=destFreq) { - newFreq=destFreq; - return2=true; - } - } - // check for octave boundary - // what the heck! - if (!chan[c.chan].portaPause) { - if ((newFreq&0x7ff)>boundaryTop && (newFreq&0xf800)<0x3800) { - chan[c.chan].portaPauseFreq=(boundaryBottom)|((newFreq+0x800)&0xf800); - chan[c.chan].portaPause=true; - break; - } - if ((newFreq&0x7ff)0) { - chan[c.chan].portaPauseFreq=newFreq=(boundaryTop-1)|((newFreq-0x800)&0xf800); - chan[c.chan].portaPause=true; - break; - } - } - chan[c.chan].portaPause=false; - chan[c.chan].freqChanged=true; - chan[c.chan].baseFreq=newFreq; - if (return2) { - chan[c.chan].inPorta=false; - return 2; - } + PLEASE_HELP_ME(chan[c.chan]); break; } case DIV_CMD_LEGATO: { diff --git a/src/engine/platform/ym2203ext.cpp b/src/engine/platform/ym2203ext.cpp index 7052027c..929687fe 100644 --- a/src/engine/platform/ym2203ext.cpp +++ b/src/engine/platform/ym2203ext.cpp @@ -143,52 +143,7 @@ int DivPlatformYM2203Ext::dispatch(DivCommand c) { } break; } - int boundaryBottom=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,0,false); - int boundaryTop=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,12,false); - int destFreq=NOTE_FNUM_BLOCK(c.value2,11); - int newFreq; - bool return2=false; - if (opChan[ch].portaPause) { - opChan[ch].baseFreq=opChan[ch].portaPauseFreq; - } - if (destFreq>opChan[ch].baseFreq) { - newFreq=opChan[ch].baseFreq+c.value; - if (newFreq>=destFreq) { - newFreq=destFreq; - return2=true; - } - } else { - newFreq=opChan[ch].baseFreq-c.value; - if (newFreq<=destFreq) { - newFreq=destFreq; - return2=true; - } - } - // what the heck! - if (!opChan[ch].portaPause) { - if ((newFreq&0x7ff)>boundaryTop && (newFreq&0xf800)<0x3800) { - if (parent->song.fbPortaPause) { - opChan[ch].portaPauseFreq=(boundaryBottom)|((newFreq+0x800)&0xf800); - opChan[ch].portaPause=true; - break; - } else { - newFreq=(newFreq>>1)|((newFreq+0x800)&0xf800); - } - } - if ((newFreq&0x7ff)0) { - if (parent->song.fbPortaPause) { - opChan[ch].portaPauseFreq=newFreq=(boundaryTop-1)|((newFreq-0x800)&0xf800); - opChan[ch].portaPause=true; - break; - } else { - newFreq=(newFreq<<1)|((newFreq-0x800)&0xf800); - } - } - } - opChan[ch].portaPause=false; - opChan[ch].freqChanged=true; - opChan[ch].baseFreq=newFreq; - if (return2) return 2; + PLEASE_HELP_ME(opChan[ch]); break; } case DIV_CMD_LEGATO: { diff --git a/src/engine/platform/ym2203ext.h b/src/engine/platform/ym2203ext.h index 7dde3abb..5025881c 100644 --- a/src/engine/platform/ym2203ext.h +++ b/src/engine/platform/ym2203ext.h @@ -27,10 +27,12 @@ class DivPlatformYM2203Ext: public DivPlatformYM2203 { unsigned char freqH, freqL; int freq, baseFreq, pitch, pitch2, portaPauseFreq, ins; signed char konCycles; - bool active, insChanged, freqChanged, keyOn, keyOff, portaPause; + bool active, insChanged, freqChanged, keyOn, keyOff, portaPause, inPorta; int vol; unsigned char pan; - OpChannel(): freqH(0), freqL(0), freq(0), baseFreq(0), pitch(0), pitch2(0), portaPauseFreq(0), ins(-1), active(false), insChanged(true), freqChanged(false), keyOn(false), keyOff(false), portaPause(false), vol(0), pan(3) {} + // UGLY + OpChannel(): freqH(0), freqL(0), freq(0), baseFreq(0), pitch(0), pitch2(0), portaPauseFreq(0), ins(-1), active(false), insChanged(true), freqChanged(false), keyOn(false), keyOff(false), portaPause(false), + inPorta(false), vol(0), pan(3) {} }; OpChannel opChan[4]; bool isOpMuted[4]; diff --git a/src/engine/platform/ym2608.cpp b/src/engine/platform/ym2608.cpp index 2f785349..48156af9 100644 --- a/src/engine/platform/ym2608.cpp +++ b/src/engine/platform/ym2608.cpp @@ -536,7 +536,7 @@ void DivPlatformYM2608::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } @@ -544,7 +544,7 @@ void DivPlatformYM2608::tick(bool sysTick) { } if (chan[i].std.phaseReset.had) { - if (chan[i].std.phaseReset.val==1) { + if (chan[i].std.phaseReset.val==1 && chan[i].active) { chan[i].keyOn=true; } } @@ -980,48 +980,7 @@ int DivPlatformYM2608::dispatch(DivCommand c) { } break; } - int boundaryBottom=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,0,false); - int boundaryTop=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,12,false); - int destFreq=NOTE_FNUM_BLOCK(c.value2,11); - int newFreq; - bool return2=false; - if (chan[c.chan].portaPause) { - chan[c.chan].baseFreq=chan[c.chan].portaPauseFreq; - } - if (destFreq>chan[c.chan].baseFreq) { - newFreq=chan[c.chan].baseFreq+c.value; - if (newFreq>=destFreq) { - newFreq=destFreq; - return2=true; - } - } else { - newFreq=chan[c.chan].baseFreq-c.value; - if (newFreq<=destFreq) { - newFreq=destFreq; - return2=true; - } - } - // check for octave boundary - // what the heck! - if (!chan[c.chan].portaPause) { - if ((newFreq&0x7ff)>boundaryTop && (newFreq&0xf800)<0x3800) { - chan[c.chan].portaPauseFreq=(boundaryBottom)|((newFreq+0x800)&0xf800); - chan[c.chan].portaPause=true; - break; - } - if ((newFreq&0x7ff)0) { - chan[c.chan].portaPauseFreq=newFreq=(boundaryTop-1)|((newFreq-0x800)&0xf800); - chan[c.chan].portaPause=true; - break; - } - } - chan[c.chan].portaPause=false; - chan[c.chan].freqChanged=true; - chan[c.chan].baseFreq=newFreq; - if (return2) { - chan[c.chan].inPorta=false; - return 2; - } + PLEASE_HELP_ME(chan[c.chan]); break; } case DIV_CMD_SAMPLE_BANK: diff --git a/src/engine/platform/ym2608ext.cpp b/src/engine/platform/ym2608ext.cpp index f2b1f62d..285e350d 100644 --- a/src/engine/platform/ym2608ext.cpp +++ b/src/engine/platform/ym2608ext.cpp @@ -143,52 +143,7 @@ int DivPlatformYM2608Ext::dispatch(DivCommand c) { } break; } - int boundaryBottom=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,0,false); - int boundaryTop=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,12,false); - int destFreq=NOTE_FNUM_BLOCK(c.value2,11); - int newFreq; - bool return2=false; - if (opChan[ch].portaPause) { - opChan[ch].baseFreq=opChan[ch].portaPauseFreq; - } - if (destFreq>opChan[ch].baseFreq) { - newFreq=opChan[ch].baseFreq+c.value; - if (newFreq>=destFreq) { - newFreq=destFreq; - return2=true; - } - } else { - newFreq=opChan[ch].baseFreq-c.value; - if (newFreq<=destFreq) { - newFreq=destFreq; - return2=true; - } - } - // what the heck! - if (!opChan[ch].portaPause) { - if ((newFreq&0x7ff)>boundaryTop && (newFreq&0xf800)<0x3800) { - if (parent->song.fbPortaPause) { - opChan[ch].portaPauseFreq=(boundaryBottom)|((newFreq+0x800)&0xf800); - opChan[ch].portaPause=true; - break; - } else { - newFreq=(newFreq>>1)|((newFreq+0x800)&0xf800); - } - } - if ((newFreq&0x7ff)0) { - if (parent->song.fbPortaPause) { - opChan[ch].portaPauseFreq=newFreq=(boundaryTop-1)|((newFreq-0x800)&0xf800); - opChan[ch].portaPause=true; - break; - } else { - newFreq=(newFreq<<1)|((newFreq-0x800)&0xf800); - } - } - } - opChan[ch].portaPause=false; - opChan[ch].freqChanged=true; - opChan[ch].baseFreq=newFreq; - if (return2) return 2; + PLEASE_HELP_ME(opChan[ch]); break; } case DIV_CMD_LEGATO: { diff --git a/src/engine/platform/ym2608ext.h b/src/engine/platform/ym2608ext.h index aedbd831..a0966dfe 100644 --- a/src/engine/platform/ym2608ext.h +++ b/src/engine/platform/ym2608ext.h @@ -27,10 +27,12 @@ class DivPlatformYM2608Ext: public DivPlatformYM2608 { unsigned char freqH, freqL; int freq, baseFreq, pitch, pitch2, portaPauseFreq, ins; signed char konCycles; - bool active, insChanged, freqChanged, keyOn, keyOff, portaPause; + bool active, insChanged, freqChanged, keyOn, keyOff, portaPause, inPorta; int vol; unsigned char pan; - OpChannel(): freqH(0), freqL(0), freq(0), baseFreq(0), pitch(0), pitch2(0), portaPauseFreq(0), ins(-1), active(false), insChanged(true), freqChanged(false), keyOn(false), keyOff(false), portaPause(false), vol(0), pan(3) {} + // UGLY + OpChannel(): freqH(0), freqL(0), freq(0), baseFreq(0), pitch(0), pitch2(0), portaPauseFreq(0), ins(-1), active(false), insChanged(true), freqChanged(false), keyOn(false), keyOff(false), portaPause(false), + inPorta(false), vol(0), pan(3) {} }; OpChannel opChan[4]; bool isOpMuted[4]; diff --git a/src/engine/platform/ym2610.cpp b/src/engine/platform/ym2610.cpp index 43857820..935e6652 100644 --- a/src/engine/platform/ym2610.cpp +++ b/src/engine/platform/ym2610.cpp @@ -580,7 +580,7 @@ void DivPlatformYM2610::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } @@ -588,7 +588,7 @@ void DivPlatformYM2610::tick(bool sysTick) { } if (chan[i].std.phaseReset.had) { - if (chan[i].std.phaseReset.val==1) { + if (chan[i].std.phaseReset.val==1 && chan[i].active) { chan[i].keyOn=true; } } @@ -1027,48 +1027,7 @@ int DivPlatformYM2610::dispatch(DivCommand c) { } break; } - int boundaryBottom=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,0,false); - int boundaryTop=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,12,false); - int destFreq=NOTE_FNUM_BLOCK(c.value2,11); - int newFreq; - bool return2=false; - if (chan[c.chan].portaPause) { - chan[c.chan].baseFreq=chan[c.chan].portaPauseFreq; - } - if (destFreq>chan[c.chan].baseFreq) { - newFreq=chan[c.chan].baseFreq+c.value; - if (newFreq>=destFreq) { - newFreq=destFreq; - return2=true; - } - } else { - newFreq=chan[c.chan].baseFreq-c.value; - if (newFreq<=destFreq) { - newFreq=destFreq; - return2=true; - } - } - // check for octave boundary - // what the heck! - if (!chan[c.chan].portaPause) { - if ((newFreq&0x7ff)>boundaryTop && (newFreq&0xf800)<0x3800) { - chan[c.chan].portaPauseFreq=(boundaryBottom)|((newFreq+0x800)&0xf800); - chan[c.chan].portaPause=true; - break; - } - if ((newFreq&0x7ff)0) { - chan[c.chan].portaPauseFreq=newFreq=(boundaryTop-1)|((newFreq-0x800)&0xf800); - chan[c.chan].portaPause=true; - break; - } - } - chan[c.chan].portaPause=false; - chan[c.chan].freqChanged=true; - chan[c.chan].baseFreq=newFreq; - if (return2) { - chan[c.chan].inPorta=false; - return 2; - } + PLEASE_HELP_ME(chan[c.chan]); break; } case DIV_CMD_SAMPLE_BANK: diff --git a/src/engine/platform/ym2610b.cpp b/src/engine/platform/ym2610b.cpp index 79af4339..622efa16 100644 --- a/src/engine/platform/ym2610b.cpp +++ b/src/engine/platform/ym2610b.cpp @@ -559,7 +559,7 @@ void DivPlatformYM2610B::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } @@ -567,7 +567,7 @@ void DivPlatformYM2610B::tick(bool sysTick) { } if (chan[i].std.phaseReset.had) { - if (chan[i].std.phaseReset.val==1) { + if (chan[i].std.phaseReset.val==1 && chan[i].active) { chan[i].keyOn=true; } } @@ -1005,48 +1005,7 @@ int DivPlatformYM2610B::dispatch(DivCommand c) { } break; } - int boundaryBottom=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,0,false); - int boundaryTop=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,12,false); - int destFreq=NOTE_FNUM_BLOCK(c.value2,11); - int newFreq; - bool return2=false; - if (chan[c.chan].portaPause) { - chan[c.chan].baseFreq=chan[c.chan].portaPauseFreq; - } - if (destFreq>chan[c.chan].baseFreq) { - newFreq=chan[c.chan].baseFreq+c.value; - if (newFreq>=destFreq) { - newFreq=destFreq; - return2=true; - } - } else { - newFreq=chan[c.chan].baseFreq-c.value; - if (newFreq<=destFreq) { - newFreq=destFreq; - return2=true; - } - } - // check for octave boundary - // what the heck! - if (!chan[c.chan].portaPause) { - if ((newFreq&0x7ff)>boundaryTop && (newFreq&0xf800)<0x3800) { - chan[c.chan].portaPauseFreq=(boundaryBottom)|((newFreq+0x800)&0xf800); - chan[c.chan].portaPause=true; - break; - } - if ((newFreq&0x7ff)0) { - chan[c.chan].portaPauseFreq=newFreq=(boundaryTop-1)|((newFreq-0x800)&0xf800); - chan[c.chan].portaPause=true; - break; - } - } - chan[c.chan].portaPause=false; - chan[c.chan].freqChanged=true; - chan[c.chan].baseFreq=newFreq; - if (return2) { - chan[c.chan].inPorta=false; - return 2; - } + PLEASE_HELP_ME(chan[c.chan]); break; } case DIV_CMD_SAMPLE_BANK: diff --git a/src/engine/platform/ym2610bext.cpp b/src/engine/platform/ym2610bext.cpp index ced8a640..20b56c01 100644 --- a/src/engine/platform/ym2610bext.cpp +++ b/src/engine/platform/ym2610bext.cpp @@ -143,52 +143,7 @@ int DivPlatformYM2610BExt::dispatch(DivCommand c) { } break; } - int boundaryBottom=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,0,false); - int boundaryTop=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,12,false); - int destFreq=NOTE_FNUM_BLOCK(c.value2,11); - int newFreq; - bool return2=false; - if (opChan[ch].portaPause) { - opChan[ch].baseFreq=opChan[ch].portaPauseFreq; - } - if (destFreq>opChan[ch].baseFreq) { - newFreq=opChan[ch].baseFreq+c.value; - if (newFreq>=destFreq) { - newFreq=destFreq; - return2=true; - } - } else { - newFreq=opChan[ch].baseFreq-c.value; - if (newFreq<=destFreq) { - newFreq=destFreq; - return2=true; - } - } - // what the heck! - if (!opChan[ch].portaPause) { - if ((newFreq&0x7ff)>boundaryTop && (newFreq&0xf800)<0x3800) { - if (parent->song.fbPortaPause) { - opChan[ch].portaPauseFreq=(boundaryBottom)|((newFreq+0x800)&0xf800); - opChan[ch].portaPause=true; - break; - } else { - newFreq=(newFreq>>1)|((newFreq+0x800)&0xf800); - } - } - if ((newFreq&0x7ff)0) { - if (parent->song.fbPortaPause) { - opChan[ch].portaPauseFreq=newFreq=(boundaryTop-1)|((newFreq-0x800)&0xf800); - opChan[ch].portaPause=true; - break; - } else { - newFreq=(newFreq<<1)|((newFreq-0x800)&0xf800); - } - } - } - opChan[ch].portaPause=false; - opChan[ch].freqChanged=true; - opChan[ch].baseFreq=newFreq; - if (return2) return 2; + PLEASE_HELP_ME(opChan[ch]); break; } case DIV_CMD_LEGATO: { diff --git a/src/engine/platform/ym2610bext.h b/src/engine/platform/ym2610bext.h index 4e3f7c5f..c17fd8d8 100644 --- a/src/engine/platform/ym2610bext.h +++ b/src/engine/platform/ym2610bext.h @@ -27,10 +27,12 @@ class DivPlatformYM2610BExt: public DivPlatformYM2610B { unsigned char freqH, freqL; int freq, baseFreq, pitch, pitch2, portaPauseFreq, ins; signed char konCycles; - bool active, insChanged, freqChanged, keyOn, keyOff, portaPause; + bool active, insChanged, freqChanged, keyOn, keyOff, portaPause, inPorta; int vol; unsigned char pan; - OpChannel(): freqH(0), freqL(0), freq(0), baseFreq(0), pitch(0), pitch2(0), portaPauseFreq(0), ins(-1), active(false), insChanged(true), freqChanged(false), keyOn(false), keyOff(false), portaPause(false), vol(0), pan(3) {} + // UGLY + OpChannel(): freqH(0), freqL(0), freq(0), baseFreq(0), pitch(0), pitch2(0), portaPauseFreq(0), ins(-1), active(false), insChanged(true), freqChanged(false), keyOn(false), keyOff(false), portaPause(false), + inPorta(false), vol(0), pan(3) {} }; OpChannel opChan[4]; bool isOpMuted[4]; diff --git a/src/engine/platform/ym2610ext.cpp b/src/engine/platform/ym2610ext.cpp index b12fd3de..a3d5df21 100644 --- a/src/engine/platform/ym2610ext.cpp +++ b/src/engine/platform/ym2610ext.cpp @@ -143,52 +143,7 @@ int DivPlatformYM2610Ext::dispatch(DivCommand c) { } break; } - int boundaryBottom=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,0,false); - int boundaryTop=parent->calcBaseFreq(chipClock,CHIP_FREQBASE,12,false); - int destFreq=NOTE_FNUM_BLOCK(c.value2,11); - int newFreq; - bool return2=false; - if (opChan[ch].portaPause) { - opChan[ch].baseFreq=opChan[ch].portaPauseFreq; - } - if (destFreq>opChan[ch].baseFreq) { - newFreq=opChan[ch].baseFreq+c.value; - if (newFreq>=destFreq) { - newFreq=destFreq; - return2=true; - } - } else { - newFreq=opChan[ch].baseFreq-c.value; - if (newFreq<=destFreq) { - newFreq=destFreq; - return2=true; - } - } - // what the heck! - if (!opChan[ch].portaPause) { - if ((newFreq&0x7ff)>boundaryTop && (newFreq&0xf800)<0x3800) { - if (parent->song.fbPortaPause) { - opChan[ch].portaPauseFreq=(boundaryBottom)|((newFreq+0x800)&0xf800); - opChan[ch].portaPause=true; - break; - } else { - newFreq=(newFreq>>1)|((newFreq+0x800)&0xf800); - } - } - if ((newFreq&0x7ff)0) { - if (parent->song.fbPortaPause) { - opChan[ch].portaPauseFreq=newFreq=(boundaryTop-1)|((newFreq-0x800)&0xf800); - opChan[ch].portaPause=true; - break; - } else { - newFreq=(newFreq<<1)|((newFreq-0x800)&0xf800); - } - } - } - opChan[ch].portaPause=false; - opChan[ch].freqChanged=true; - opChan[ch].baseFreq=newFreq; - if (return2) return 2; + PLEASE_HELP_ME(opChan[ch]); break; } case DIV_CMD_LEGATO: { diff --git a/src/engine/platform/ym2610ext.h b/src/engine/platform/ym2610ext.h index 287bf08b..492eb5de 100644 --- a/src/engine/platform/ym2610ext.h +++ b/src/engine/platform/ym2610ext.h @@ -27,10 +27,12 @@ class DivPlatformYM2610Ext: public DivPlatformYM2610 { unsigned char freqH, freqL; int freq, baseFreq, pitch, pitch2, portaPauseFreq, ins; signed char konCycles; - bool active, insChanged, freqChanged, keyOn, keyOff, portaPause; + bool active, insChanged, freqChanged, keyOn, keyOff, portaPause, inPorta; int vol; unsigned char pan; - OpChannel(): freqH(0), freqL(0), freq(0), baseFreq(0), pitch(0), pitch2(0), portaPauseFreq(0), ins(-1), active(false), insChanged(true), freqChanged(false), keyOn(false), keyOff(false), portaPause(false), vol(0), pan(3) {} + // UGLY + OpChannel(): freqH(0), freqL(0), freq(0), baseFreq(0), pitch(0), pitch2(0), portaPauseFreq(0), ins(-1), active(false), insChanged(true), freqChanged(false), keyOn(false), keyOff(false), portaPause(false), + inPorta(false), vol(0), pan(3) {} }; OpChannel opChan[4]; bool isOpMuted[4]; diff --git a/src/engine/platform/ymz280b.cpp b/src/engine/platform/ymz280b.cpp index 2d714243..961ec8b8 100644 --- a/src/engine/platform/ymz280b.cpp +++ b/src/engine/platform/ymz280b.cpp @@ -115,7 +115,7 @@ void DivPlatformYMZ280B::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/platform/zxbeeper.cpp b/src/engine/platform/zxbeeper.cpp index fad63ae8..3ea42ede 100644 --- a/src/engine/platform/zxbeeper.cpp +++ b/src/engine/platform/zxbeeper.cpp @@ -107,7 +107,7 @@ void DivPlatformZXBeeper::tick(bool sysTick) { if (chan[i].std.pitch.had) { if (chan[i].std.pitch.mode) { chan[i].pitch2+=chan[i].std.pitch.val; - CLAMP_VAR(chan[i].pitch2,-2048,2048); + CLAMP_VAR(chan[i].pitch2,-32768,32767); } else { chan[i].pitch2=chan[i].std.pitch.val; } diff --git a/src/engine/playback.cpp b/src/engine/playback.cpp index e8fba16c..ea493fd6 100644 --- a/src/engine/playback.cpp +++ b/src/engine/playback.cpp @@ -23,7 +23,9 @@ #include "engine.h" #include "../ta-log.h" #include +#ifdef HAVE_SNDFILE #include +#endif constexpr int MASTER_CLOCK_PREC=(sizeof(void*)==8)?8:0; @@ -566,6 +568,7 @@ void DivEngine::processRow(int i, bool afterDelay) { if (divider<10) divider=10; cycles=got.rate*pow(2,MASTER_CLOCK_PREC)/divider; clockDrift=0; + subticks=0; break; case 0xe0: // arp speed if (effectVal>0) { @@ -646,6 +649,7 @@ void DivEngine::processRow(int i, bool afterDelay) { if (divider<10) divider=10; cycles=got.rate*pow(2,MASTER_CLOCK_PREC)/divider; clockDrift=0; + subticks=0; break; case 0xf1: // single pitch ramp up case 0xf2: // single pitch ramp down diff --git a/src/engine/sample.cpp b/src/engine/sample.cpp index 226a7019..a3d8247f 100644 --- a/src/engine/sample.cpp +++ b/src/engine/sample.cpp @@ -21,7 +21,9 @@ #include "../ta-log.h" #include #include +#ifdef HAVE_SNDFILE #include +#endif #include "filter.h" extern "C" { @@ -41,6 +43,10 @@ bool DivSample::isLoopable() { } bool DivSample::save(const char* path) { +#ifndef HAVE_SNDFILE + logE("Furnace was not compiled with libsndfile!"); + return false; +#else SNDFILE* f; SF_INFO si; memset(&si,0,sizeof(SF_INFO)); @@ -80,6 +86,7 @@ bool DivSample::save(const char* path) { sf_close(f); return true; +#endif } // 16-bit memory is padded to 512, to make things easier for ADPCM-A/B. diff --git a/src/engine/song.h b/src/engine/song.h index 3d40e649..dd98ee81 100644 --- a/src/engine/song.h +++ b/src/engine/song.h @@ -394,6 +394,7 @@ struct DivSong { bool fbPortaPause; bool snDutyReset; bool pitchMacroIsLinear; + bool oldOctaveBoundary; std::vector ins; std::vector wave; @@ -486,7 +487,8 @@ struct DivSong { newSegaPCM(true), fbPortaPause(false), snDutyReset(false), - pitchMacroIsLinear(true) { + pitchMacroIsLinear(true), + oldOctaveBoundary(false) { for (int i=0; i<32; i++) { system[i]=DIV_SYSTEM_NULL; systemVol[i]=64; diff --git a/src/engine/sysDef.cpp b/src/engine/sysDef.cpp index f2eedc70..a983bd48 100644 --- a/src/engine/sysDef.cpp +++ b/src/engine/sysDef.cpp @@ -176,7 +176,7 @@ String DivEngine::getSongSystemName(bool isMultiSystemAcceptable) { return "Famicom Disk System"; } if (song.system[0]==DIV_SYSTEM_NES && song.system[1]==DIV_SYSTEM_N163) { - return "NES + Namco 163"; + return "NES + Namco C163"; } if (song.system[0]==DIV_SYSTEM_NES && song.system[1]==DIV_SYSTEM_MMC5) { return "NES + MMC5"; @@ -1234,7 +1234,7 @@ void DivEngine::registerSystems() { ); sysDefs[DIV_SYSTEM_N163]=new DivSysDef( - "Namco 163", NULL, 0x8c, 0, 8, false, true, 0, false, + "Namco C163", NULL, 0x8c, 0, 8, false, true, 0, false, "an expansion chip for the Famicom, with full wavetable.", {"Channel 1", "Channel 2", "Channel 3", "Channel 4", "Channel 5", "Channel 6", "Channel 7", "Channel 8"}, {"CH1", "CH2", "CH3", "CH4", "CH5", "CH6", "CH7", "CH8"}, @@ -1655,7 +1655,7 @@ void DivEngine::registerSystems() { {"CH1", "CH2", "CH3", "CH4"}, {DIV_CH_WAVE, DIV_CH_WAVE, DIV_CH_WAVE, DIV_CH_WAVE}, {DIV_INS_MIKEY, DIV_INS_MIKEY, DIV_INS_MIKEY, DIV_INS_MIKEY}, - {}, + {DIV_INS_AMIGA, DIV_INS_AMIGA, DIV_INS_AMIGA, DIV_INS_AMIGA}, [](int,unsigned char,unsigned char) -> bool {return false;}, [this](int ch, unsigned char effect, unsigned char effectVal) -> bool { if (effect>=0x30 && effect<0x40) { @@ -2045,7 +2045,7 @@ void DivEngine::registerSystems() { ); sysDefs[DIV_SYSTEM_YMZ280B]=new DivSysDef( - "Yamaha YMZ280B", NULL, 0xb8, 0, 8, false, true, 0x151, false, + "Yamaha YMZ280B (PCMD8)", NULL, 0xb8, 0, 8, false, true, 0x151, false, "used in some arcade boards. Can play back either 4-bit ADPCM, 8-bit PCM or 16-bit PCM.", {"PCM 1", "PCM 2", "PCM 3", "PCM 4", "PCM 5", "PCM 6", "PCM 7", "PCM 8"}, {"1", "2", "3", "4", "5", "6", "7", "8"}, @@ -2079,7 +2079,7 @@ void DivEngine::registerSystems() { ); sysDefs[DIV_SYSTEM_NAMCO_15XX]=new DivSysDef( - "Namco 15XX WSG", NULL, 0xba, 0, 8, false, true, 0, false, + "Namco C15 WSG", NULL, 0xba, 0, 8, false, true, 0, false, "successor of the original Namco WSG chip, used in later Namco arcade games.", {"Channel 1", "Channel 2", "Channel 3", "Channel 4", "Channel 5", "Channel 6", "Channel 7", "Channel 8"}, {"CH1", "CH2", "CH3", "CH4", "CH5", "CH6", "CH7", "CH8"}, @@ -2090,8 +2090,8 @@ void DivEngine::registerSystems() { ); sysDefs[DIV_SYSTEM_NAMCO_CUS30]=new DivSysDef( - "Namco CUS30 WSG", NULL, 0xbb, 0, 8, false, true, 0, false, - "like Namco 15XX but with stereo sound.", + "Namco C30 WSG", NULL, 0xbb, 0, 8, false, true, 0, false, + "like Namco C15 but with stereo sound.", {"Channel 1", "Channel 2", "Channel 3", "Channel 4", "Channel 5", "Channel 6", "Channel 7", "Channel 8"}, {"CH1", "CH2", "CH3", "CH4", "CH5", "CH6", "CH7", "CH8"}, {DIV_CH_WAVE, DIV_CH_WAVE, DIV_CH_WAVE, DIV_CH_WAVE, DIV_CH_WAVE, DIV_CH_WAVE, DIV_CH_WAVE, DIV_CH_WAVE}, diff --git a/src/engine/waveSynth.cpp b/src/engine/waveSynth.cpp index 0dbe852d..c61fc424 100644 --- a/src/engine/waveSynth.cpp +++ b/src/engine/waveSynth.cpp @@ -186,7 +186,7 @@ bool DivWaveSynth::tick(bool skipSubDiv) { break; case DIV_WS_PHASE_MOD: for (int i=0; i<=state.speed; i++) { - int mod=(wave2[pos]*(state.param2-stage))>>8; + int mod=(wave2[pos]*(state.param2-stage)*width)/512; output[pos]=wave1[(pos+mod)%width]; if (++pos>=width) { pos=0; diff --git a/src/gui/compatFlags.cpp b/src/gui/compatFlags.cpp index ca4195af..b6dabafc 100644 --- a/src/gui/compatFlags.cpp +++ b/src/gui/compatFlags.cpp @@ -209,6 +209,10 @@ void FurnaceGUI::drawCompatFlags() { if (ImGui::IsItemHovered()) { ImGui::SetTooltip("behavior changed in 0.6"); } + ImGui::Checkbox("Old FM octave boundary behavior",&e->song.oldOctaveBoundary); + if (ImGui::IsItemHovered()) { + ImGui::SetTooltip("behavior changed in 0.6"); + } } if (ImGui::IsWindowFocused(ImGuiFocusedFlags_ChildWindows)) curWindow=GUI_WINDOW_COMPAT_FLAGS; ImGui::End(); diff --git a/src/gui/dataList.cpp b/src/gui/dataList.cpp index 5829e2c3..4dfc9f28 100644 --- a/src/gui/dataList.cpp +++ b/src/gui/dataList.cpp @@ -319,11 +319,11 @@ void FurnaceGUI::drawWaveList() { } ImGui::SameLine(); if (ImGui::ArrowButton("WaveUp",ImGuiDir_Up)) { - doAction(GUI_ACTION_WAVE_LIST_UP); + doAction(GUI_ACTION_WAVE_LIST_MOVE_UP); } ImGui::SameLine(); if (ImGui::ArrowButton("WaveDown",ImGuiDir_Down)) { - doAction(GUI_ACTION_WAVE_LIST_DOWN); + doAction(GUI_ACTION_WAVE_LIST_MOVE_DOWN); } ImGui::SameLine(); if (ImGui::Button(ICON_FA_TIMES "##WaveDelete")) { diff --git a/src/gui/debug.cpp b/src/gui/debug.cpp index c3fcd4d4..269b4284 100644 --- a/src/gui/debug.cpp +++ b/src/gui/debug.cpp @@ -340,7 +340,6 @@ void putDispatchChan(void* data, int chanNum, int type) { ImGui::Text("* freq: %.5x",ch->freq); ImGui::Text(" - base: %d",ch->baseFreq); ImGui::Text(" - next: %d",ch->nextFreq); - ImGui::Text(" - prev: %d",ch->prevFreq); ImGui::Text(" - pitch: %d",ch->pitch); ImGui::Text(" - pitch2: %d",ch->pitch2); ImGui::Text("* note: %d",ch->note); diff --git a/src/gui/editControls.cpp b/src/gui/editControls.cpp index 9c8f0ad4..671ca63b 100644 --- a/src/gui/editControls.cpp +++ b/src/gui/editControls.cpp @@ -19,6 +19,7 @@ #include "gui.h" #include "IconsFontAwesome4.h" +#include void FurnaceGUI::drawMobileControls() { if (ImGui::Begin("Mobile Controls",NULL,ImGuiWindowFlags_NoScrollbar|ImGuiWindowFlags_NoScrollWithMouse|globalWinFlags)) { @@ -81,27 +82,40 @@ void FurnaceGUI::drawEditControls() { switch (settings.controlLayout) { case 0: // classic if (ImGui::Begin("Play/Edit Controls",&editControlsOpen,globalWinFlags)) { - ImGui::Text("Octave"); - ImGui::SameLine(); - if (ImGui::InputInt("##Octave",&curOctave,1,1)) { - if (curOctave>7) curOctave=7; - if (curOctave<-5) curOctave=-5; - e->autoNoteOffAll(); + if (ImGui::BeginTable("PlayEditAlign",2)) { + ImGui::TableSetupColumn("c0",ImGuiTableColumnFlags_WidthFixed); + ImGui::TableSetupColumn("c1",ImGuiTableColumnFlags_WidthStretch); - if (settings.insFocusesPattern && !ImGui::IsItemActive() && patternOpen) { - nextWindow=GUI_WINDOW_PATTERN; + ImGui::TableNextRow(); + ImGui::TableNextColumn(); + ImGui::Text("Octave"); + ImGui::TableNextColumn(); + ImGui::SetNextItemWidth(ImGui::GetContentRegionAvail().x); + if (ImGui::InputInt("##Octave",&curOctave,1,1)) { + if (curOctave>7) curOctave=7; + if (curOctave<-5) curOctave=-5; + e->autoNoteOffAll(); + + if (settings.insFocusesPattern && !ImGui::IsItemActive() && patternOpen) { + nextWindow=GUI_WINDOW_PATTERN; + } } - } - ImGui::Text("Edit Step"); - ImGui::SameLine(); - if (ImGui::InputInt("##EditStep",&editStep,1,1)) { - if (editStep>=e->curSubSong->patLen) editStep=e->curSubSong->patLen-1; - if (editStep<0) editStep=0; + ImGui::TableNextRow(); + ImGui::TableNextColumn(); + ImGui::Text("Edit Step"); + ImGui::TableNextColumn(); + ImGui::SetNextItemWidth(ImGui::GetContentRegionAvail().x); + if (ImGui::InputInt("##EditStep",&editStep,1,1)) { + if (editStep>=e->curSubSong->patLen) editStep=e->curSubSong->patLen-1; + if (editStep<0) editStep=0; - if (settings.insFocusesPattern && !ImGui::IsItemActive() && patternOpen) { - nextWindow=GUI_WINDOW_PATTERN; + if (settings.insFocusesPattern && !ImGui::IsItemActive() && patternOpen) { + nextWindow=GUI_WINDOW_PATTERN; + } } + + ImGui::EndTable(); } ImGui::PushStyleColor(ImGuiCol_Button,TOGGLE_COLOR(e->isPlaying())); @@ -219,35 +233,36 @@ void FurnaceGUI::drawEditControls() { break; case 2: // compact vertical if (ImGui::Begin("Play/Edit Controls",&editControlsOpen,ImGuiWindowFlags_NoScrollbar|ImGuiWindowFlags_NoScrollWithMouse|globalWinFlags)) { + ImVec2 buttonSize=ImVec2(ImGui::GetContentRegionAvail().x,0.0f); ImGui::PushStyleColor(ImGuiCol_Button,TOGGLE_COLOR(e->isPlaying())); - if (ImGui::Button(ICON_FA_PLAY "##Play")) { + if (ImGui::Button(ICON_FA_PLAY "##Play",buttonSize)) { play(); } ImGui::PopStyleColor(); - if (ImGui::Button(ICON_FA_STOP "##Stop")) { + if (ImGui::Button(ICON_FA_STOP "##Stop",buttonSize)) { stop(); } - if (ImGui::Button(ICON_FA_ARROW_DOWN "##StepOne")) { + if (ImGui::Button(ICON_FA_ARROW_DOWN "##StepOne",buttonSize)) { e->stepOne(cursor.y); pendingStepUpdate=true; } bool repeatPattern=e->getRepeatPattern(); ImGui::PushStyleColor(ImGuiCol_Button,TOGGLE_COLOR(repeatPattern)); - if (ImGui::Button(ICON_FA_REPEAT "##RepeatPattern")) { + if (ImGui::Button(ICON_FA_REPEAT "##RepeatPattern",buttonSize)) { e->setRepeatPattern(!repeatPattern); } ImGui::PopStyleColor(); ImGui::PushStyleColor(ImGuiCol_Button,TOGGLE_COLOR(edit)); - if (ImGui::Button(ICON_FA_CIRCLE "##Edit")) { + if (ImGui::Button(ICON_FA_CIRCLE "##Edit",buttonSize)) { edit=!edit; } ImGui::PopStyleColor(); bool metro=e->getMetronome(); ImGui::PushStyleColor(ImGuiCol_Button,TOGGLE_COLOR(metro)); - if (ImGui::Button(ICON_FA_BELL_O "##Metronome")) { + if (ImGui::Button(ICON_FA_BELL_O "##Metronome",buttonSize)) { e->setMetronome(!metro); } ImGui::PopStyleColor(); @@ -278,12 +293,12 @@ void FurnaceGUI::drawEditControls() { ImGui::Text("Foll."); ImGui::PushStyleColor(ImGuiCol_Button,TOGGLE_COLOR(followOrders)); - if (ImGui::SmallButton("Ord##FollowOrders")) { handleUnimportant + if (ImGui::Button("Ord##FollowOrders",buttonSize)) { handleUnimportant followOrders=!followOrders; } ImGui::PopStyleColor(); ImGui::PushStyleColor(ImGuiCol_Button,TOGGLE_COLOR(followPattern)); - if (ImGui::SmallButton("Pat##FollowPattern")) { handleUnimportant + if (ImGui::Button("Pat##FollowPattern",buttonSize)) { handleUnimportant followPattern=!followPattern; } ImGui::PopStyleColor(); diff --git a/src/gui/gui.cpp b/src/gui/gui.cpp index 9b2e8fdd..2aaee330 100644 --- a/src/gui/gui.cpp +++ b/src/gui/gui.cpp @@ -1842,7 +1842,7 @@ void FurnaceGUI::processDrags(int dragX, int dragY) { for (char& i: lowerCase) { \ if (i>='A' && i<='Z') i+='a'-'A'; \ } \ - if (lowerCase.size()<4 || lowerCase.rfind(x)!=lowerCase.size()-4) { \ + if (lowerCase.size()amiga.transWave.sliceEnable)); DivInstrumentAmiga::TransWaveMap ind=ins->amiga.transWaveMap[ins->amiga.transWave.ind]; if (ins->amiga.transWave.sliceEnable && (ind.ind>=0 && ind.indsong.sampleLen)) { - DivSample* s=e->song.sample[ind.ind]; double sliceInit=(double)(ins->amiga.transWave.slice)/4095.0; double slicePos=ins->amiga.transWave.slicePos(sliceInit); double sliceStart=ins->amiga.transWave.sliceStart; double sliceEnd=ins->amiga.transWave.sliceEnd; P(CWSliderScalar("Initial Transwave Slice##TransWaveSliceInit",ImGuiDataType_U16,&ins->amiga.transWave.slice,&_ZERO,&_FOUR_THOUSAND_NINETY_FIVE,fmt::sprintf("%d: %.6f - %.6f",ins->amiga.transWave.slice,sliceStart,sliceEnd).c_str())); rightClickable + ImGui::Text("Position: %.6f", slicePos); } if (ImGui::BeginTable("TransWaveMap",6,ImGuiTableFlags_ScrollY|ImGuiTableFlags_Borders|ImGuiTableFlags_SizingStretchSame)) { ImGui::TableSetupColumn("c0",ImGuiTableColumnFlags_WidthFixed); // Number @@ -2725,7 +2725,7 @@ void FurnaceGUI::drawInsEdit() { ImGui::TableNextRow(); ImGui::PushID(fmt::sprintf("TransWaveMap_%d",i).c_str()); ImGui::TableNextColumn(); - ImGui::Text("%d",i); + ImGui::Text("%d",(int)(i)); ImGui::TableNextColumn(); if (transWaveMap.ind<0 || transWaveMap.ind>=e->song.sampleLen) { sName="-- empty --"; @@ -3415,9 +3415,9 @@ void FurnaceGUI::drawInsEdit() { macroList.push_back(FurnaceGUIMacroDesc("Panning",&ins->std.panLMacro,0,2,32,uiColors[GUI_COLOR_MACRO_OTHER],false,false,NULL,NULL,true,panBits)); } else { if (panSingleNoBit || (ins->type==DIV_INS_AMIGA && ins->std.panLMacro.mode)) { - macroList.push_back(FurnaceGUIMacroDesc("Panning",&ins->std.panLMacro,panMin,panMax,CLAMP_VAL(31+panMax-panMin,32,160),uiColors[GUI_COLOR_MACRO_OTHER],false,(ins->type==DIV_INS_AMIGA)?macroQSoundMode:NULL)); + macroList.push_back(FurnaceGUIMacroDesc("Panning",&ins->std.panLMacro,panMin,panMax,CLAMP_VAL(31+panMax-panMin,32,160),uiColors[GUI_COLOR_MACRO_OTHER],false,(ins->type==DIV_INS_AMIGA)?true:false,(ins->type==DIV_INS_AMIGA)?macroQSoundMode:NULL)); } else { - macroList.push_back(FurnaceGUIMacroDesc("Panning (left)",&ins->std.panLMacro,panMin,panMax,CLAMP_VAL(31+panMax-panMin,32,160),uiColors[GUI_COLOR_MACRO_OTHER],false,(ins->type==DIV_INS_AMIGA)?macroQSoundMode:NULL)); + macroList.push_back(FurnaceGUIMacroDesc("Panning (left)",&ins->std.panLMacro,panMin,panMax,CLAMP_VAL(31+panMax-panMin,32,160),uiColors[GUI_COLOR_MACRO_OTHER],false,(ins->type==DIV_INS_AMIGA)?true:false,(ins->type==DIV_INS_AMIGA)?macroQSoundMode:NULL)); } if (!panSingleNoBit) { if (ins->type==DIV_INS_AMIGA && ins->std.panLMacro.mode) { @@ -3442,7 +3442,8 @@ void FurnaceGUI::drawInsEdit() { ins->type==DIV_INS_SWAN || ins->type==DIV_INS_ES5506 || ins->type==DIV_INS_MULTIPCM || - ins->type==DIV_INS_SU) { + ins->type==DIV_INS_SU || + ins->type==DIV_INS_MIKEY) { macroList.push_back(FurnaceGUIMacroDesc("Phase Reset",&ins->std.phaseResetMacro,0,1,32,uiColors[GUI_COLOR_MACRO_OTHER],false,false,NULL,NULL,true)); } if (ex1Max>0) { diff --git a/src/gui/osc.cpp b/src/gui/osc.cpp index b90e7fd0..f85a323d 100644 --- a/src/gui/osc.cpp +++ b/src/gui/osc.cpp @@ -19,6 +19,7 @@ #include "gui.h" #include "imgui_internal.h" +#include // TODO: // - potentially move oscilloscope seek position to the end, and read the last samples @@ -122,48 +123,15 @@ void FurnaceGUI::drawOsc() { ImU32 guideColor=ImGui::GetColorU32(uiColors[GUI_COLOR_OSC_GUIDE]); ImGui::ItemSize(size,style.FramePadding.y); if (ImGui::ItemAdd(rect,ImGui::GetID("wsDisplay"))) { - // https://github.com/ocornut/imgui/issues/3710 - const int v0 = dl->VtxBuffer.Size; - dl->AddRectFilled(inRect.Min,inRect.Max,0xffffffff,settings.oscRoundedCorners?(8.0f*dpiScale):0.0f); - const int v1 = dl->VtxBuffer.Size; - - for (int i=v0; iVtxBuffer.Data[i]; - ImVec4 col0=uiColors[GUI_COLOR_OSC_BG1]; - ImVec4 col1=uiColors[GUI_COLOR_OSC_BG3]; - ImVec4 col2=uiColors[GUI_COLOR_OSC_BG2]; - ImVec4 col3=uiColors[GUI_COLOR_OSC_BG4]; - - float shadeX=(v->pos.x-rect.Min.x)/(rect.Max.x-rect.Min.x); - float shadeY=(v->pos.y-rect.Min.y)/(rect.Max.y-rect.Min.y); - if (shadeX<0.0f) shadeX=0.0f; - if (shadeX>1.0f) shadeX=1.0f; - if (shadeY<0.0f) shadeY=0.0f; - if (shadeY>1.0f) shadeY=1.0f; - - col0.x+=(col2.x-col0.x)*shadeX; - col0.y+=(col2.y-col0.y)*shadeX; - col0.z+=(col2.z-col0.z)*shadeX; - col0.w+=(col2.w-col0.w)*shadeX; - - col1.x+=(col3.x-col1.x)*shadeX; - col1.y+=(col3.y-col1.y)*shadeX; - col1.z+=(col3.z-col1.z)*shadeX; - col1.w+=(col3.w-col1.w)*shadeX; - - col0.x+=(col1.x-col0.x)*shadeY; - col0.y+=(col1.y-col0.y)*shadeY; - col0.z+=(col1.z-col0.z)*shadeY; - col0.w+=(col1.w-col0.w)*shadeY; - - ImVec4 conv=ImGui::ColorConvertU32ToFloat4(v->col); - col0.x*=conv.x; - col0.y*=conv.y; - col0.z*=conv.z; - col0.w*=conv.w; - - v->col=ImGui::ColorConvertFloat4ToU32(col0); - } + dl->AddRectFilledMultiColor( + inRect.Min, + inRect.Max, + ImGui::GetColorU32(uiColors[GUI_COLOR_OSC_BG1]), + ImGui::GetColorU32(uiColors[GUI_COLOR_OSC_BG2]), + ImGui::GetColorU32(uiColors[GUI_COLOR_OSC_BG4]), + ImGui::GetColorU32(uiColors[GUI_COLOR_OSC_BG3]), + settings.oscRoundedCorners?(8.0f*dpiScale):0.0f + ); dl->AddLine( ImLerp(rect.Min,rect.Max,ImVec2(0.0f,0.5f)), @@ -224,11 +192,18 @@ void FurnaceGUI::drawOsc() { for (size_t i=0; i<512; i++) { float x=(float)i/512.0f; float y=oscValues[i]*oscZoom; - if (y<-0.5f) y=-0.5f; - if (y>0.5f) y=0.5f; + if (!settings.oscEscapesBoundary) { + if (y<-0.5f) y=-0.5f; + if (y>0.5f) y=0.5f; + } waveform[i]=ImLerp(inRect.Min,inRect.Max,ImVec2(x,0.5f-y)); } - dl->AddPolyline(waveform,512,color,ImDrawFlags_None,dpiScale); + if (settings.oscEscapesBoundary) { + ImDrawList* dlf=ImGui::GetForegroundDrawList(); + dlf->AddPolyline(waveform,512,color,ImDrawFlags_None,dpiScale); + } else { + dl->AddPolyline(waveform,512,color,ImDrawFlags_None,dpiScale); + } if (settings.oscBorder) { dl->AddRect(inRect.Min,inRect.Max,borderColor,settings.oscRoundedCorners?(8.0f*dpiScale):0.0f,0,1.5f*dpiScale); } diff --git a/src/gui/pattern.cpp b/src/gui/pattern.cpp index 2140af27..603a0c9f 100644 --- a/src/gui/pattern.cpp +++ b/src/gui/pattern.cpp @@ -553,6 +553,7 @@ void FurnaceGUI::drawPattern() { // オップナー2608 i owe you one more for this horrible code // previous pattern ImGui::BeginDisabled(); + ImGui::PushStyleVar(ImGuiStyleVar_FrameShading,0.0f); if (settings.viewPrevPattern) { if ((ord-1)>=0) for (int i=0; icurPat[i].getPattern(e->curOrders->ord[i][ord-1],true); @@ -590,6 +591,7 @@ void FurnaceGUI::drawPattern() { } } ImGui::EndDisabled(); + ImGui::PopStyleVar(); oldRow=curRow; if (demandScrollX) { int totalDemand=demandX-ImGui::GetScrollX(); diff --git a/src/gui/presets.cpp b/src/gui/presets.cpp index 8abdbaf4..119e8889 100644 --- a/src/gui/presets.cpp +++ b/src/gui/presets.cpp @@ -37,13 +37,13 @@ void FurnaceGUI::initSystemPresets() { cat=FurnaceGUISysCategory("FM","chips which use frequency modulation (FM) to generate sound.\nsome of these also pack more (like square and sample channels)."); cat.systems.push_back(FurnaceGUISysDef( - "Yamaha YM2151", { + "Yamaha YM2151 (OPM)", { DIV_SYSTEM_YM2151, 64, 0, 0, 0 } )); cat.systems.push_back(FurnaceGUISysDef( - "Yamaha YM2203", { + "Yamaha YM2203 (OPN)", { DIV_SYSTEM_OPN, 64, 0, 3, 0 } @@ -55,7 +55,7 @@ void FurnaceGUI::initSystemPresets() { } )); cat.systems.push_back(FurnaceGUISysDef( - "Yamaha YM2608", { + "Yamaha YM2608 (OPNA)", { DIV_SYSTEM_PC98, 64, 0, 3, 0 } @@ -67,7 +67,7 @@ void FurnaceGUI::initSystemPresets() { } )); cat.systems.push_back(FurnaceGUISysDef( - "Yamaha YM2610", { + "Yamaha YM2610 (OPNB)", { DIV_SYSTEM_YM2610_FULL, 64, 0, 0, 0 } @@ -79,7 +79,7 @@ void FurnaceGUI::initSystemPresets() { } )); cat.systems.push_back(FurnaceGUISysDef( - "Yamaha YM2610B", { + "Yamaha YM2610B (OPNB-B)", { DIV_SYSTEM_YM2610B, 64, 0, 0, 0 } @@ -91,7 +91,7 @@ void FurnaceGUI::initSystemPresets() { } )); cat.systems.push_back(FurnaceGUISysDef( - "Yamaha YM2612", { + "Yamaha YM2612 (OPN2)", { DIV_SYSTEM_YM2612, 64, 0, (int)0x80000000, 0 } @@ -103,7 +103,7 @@ void FurnaceGUI::initSystemPresets() { } )); cat.systems.push_back(FurnaceGUISysDef( - "Yamaha YM2413", { + "Yamaha YM2413 (OPLL)", { DIV_SYSTEM_OPLL, 64, 0, 0, 0 } @@ -115,13 +115,13 @@ void FurnaceGUI::initSystemPresets() { } )); cat.systems.push_back(FurnaceGUISysDef( - "Yamaha YM2414", { + "Yamaha YM2414 (OPZ)", { DIV_SYSTEM_OPZ, 64, 0, 0, 0 } )); cat.systems.push_back(FurnaceGUISysDef( - "Yamaha YM3438", { + "Yamaha YM3438 (OPN2C)", { DIV_SYSTEM_YM2612, 64, 0, 0, 0 } @@ -133,7 +133,7 @@ void FurnaceGUI::initSystemPresets() { } )); cat.systems.push_back(FurnaceGUISysDef( - "Yamaha YM3526", { + "Yamaha YM3526 (OPL)", { DIV_SYSTEM_OPL, 64, 0, 0, 0 } @@ -157,7 +157,7 @@ void FurnaceGUI::initSystemPresets() { } )); cat.systems.push_back(FurnaceGUISysDef( - "Yamaha YM3812", { + "Yamaha YM3812 (OPL2)", { DIV_SYSTEM_OPL2, 64, 0, 0, 0 } @@ -169,7 +169,7 @@ void FurnaceGUI::initSystemPresets() { } )); cat.systems.push_back(FurnaceGUISysDef( - "Yamaha YMF262", { + "Yamaha YMF262 (OPL3)", { DIV_SYSTEM_OPL3, 64, 0, 0, 0 } @@ -182,7 +182,7 @@ void FurnaceGUI::initSystemPresets() { )); if (settings.hiddenSystems) { cat.systems.push_back(FurnaceGUISysDef( - "Yamaha YMU759", { + "Yamaha YMU759 (MA-2)", { DIV_SYSTEM_YMU759, 64, 0, 0, 0 } @@ -261,13 +261,13 @@ void FurnaceGUI::initSystemPresets() { } )); cat.systems.push_back(FurnaceGUISysDef( - "Ensoniq ES5506", { + "Ensoniq ES5506 (OTTO)", { DIV_SYSTEM_ES5506, 64, 0, 31, 0 } )); cat.systems.push_back(FurnaceGUISysDef( - "Yamaha YMZ280B", { + "Yamaha YMZ280B (PCMD8)", { DIV_SYSTEM_YMZ280B, 64, 0, 0, 0 } @@ -318,19 +318,19 @@ void FurnaceGUI::initSystemPresets() { } )); cat.systems.push_back(FurnaceGUISysDef( - "Namco 15xx", { + "Namco C15 (8-channel mono)", { DIV_SYSTEM_NAMCO_15XX, 64, 0, 0, 0 } )); cat.systems.push_back(FurnaceGUISysDef( - "Namco CUS30", { + "Namco C30 (8-channel stereo)", { DIV_SYSTEM_NAMCO_CUS30, 64, 0, 0, 0 } )); cat.systems.push_back(FurnaceGUISysDef( - "Namco 163", { + "Namco C163", { DIV_SYSTEM_N163, 64, 0, 0, 0 } @@ -518,7 +518,7 @@ void FurnaceGUI::initSystemPresets() { } )); cat.systems.push_back(FurnaceGUISysDef( - "NES with Namco 163", { + "NES with Namco C163", { DIV_SYSTEM_NES, 64, 0, 0, DIV_SYSTEM_N163, 64, 0, 112, 0 diff --git a/src/gui/settings.cpp b/src/gui/settings.cpp index a5e0127d..0d16f389 100644 --- a/src/gui/settings.cpp +++ b/src/gui/settings.cpp @@ -79,6 +79,11 @@ const char* ym2612Cores[]={ "ymfm" }; +const char* snCores[]={ + "MAME", + "Nuked-PSG Mod" +}; + const char* saaCores[]={ "MAME", "SAASound" @@ -872,6 +877,10 @@ void FurnaceGUI::drawSettings() { ImGui::SameLine(); ImGui::Combo("##YM2612Core",&settings.ym2612Core,ym2612Cores,2); + ImGui::Text("SN76489 core"); + ImGui::SameLine(); + ImGui::Combo("##SNCore",&settings.snCore,snCores,2); + ImGui::Text("SAA1099 core"); ImGui::SameLine(); ImGui::Combo("##SAACore",&settings.saaCore,saaCores,2); @@ -1219,6 +1228,11 @@ void FurnaceGUI::drawSettings() { settings.oscTakesEntireWindow=oscTakesEntireWindowB; } + bool oscEscapesBoundaryB=settings.oscEscapesBoundary; + if (ImGui::Checkbox("Waveform goes out of bounds",&oscEscapesBoundaryB)) { + settings.oscEscapesBoundary=oscEscapesBoundaryB; + } + bool oscBorderB=settings.oscBorder; if (ImGui::Checkbox("Border",&oscBorderB)) { settings.oscBorder=oscBorderB; @@ -1242,9 +1256,16 @@ void FurnaceGUI::drawSettings() { ImGui::Text("Color scheme type:"); if (ImGui::RadioButton("Dark##gcb0",settings.guiColorsBase==0)) { settings.guiColorsBase=0; + applyUISettings(false); } if (ImGui::RadioButton("Light##gcb1",settings.guiColorsBase==1)) { settings.guiColorsBase=1; + applyUISettings(false); + } + if (ImGui::SliderInt("Frame shading",&settings.guiColorsShading,0,100,"%d%%")) { + if (settings.guiColorsShading<0) settings.guiColorsShading=0; + if (settings.guiColorsShading>100) settings.guiColorsShading=100; + applyUISettings(false); } UI_COLOR_CONFIG(GUI_COLOR_BACKGROUND,"Background"); UI_COLOR_CONFIG(GUI_COLOR_FRAME_BACKGROUND,"Window background"); @@ -1877,6 +1898,7 @@ void FurnaceGUI::syncSettings() { settings.audioRate=e->getConfInt("audioRate",44100); settings.arcadeCore=e->getConfInt("arcadeCore",0); settings.ym2612Core=e->getConfInt("ym2612Core",0); + settings.snCore=e->getConfInt("snCore",0); settings.saaCore=e->getConfInt("saaCore",1); settings.nesCore=e->getConfInt("nesCore",0); settings.fdsCore=e->getConfInt("fdsCore",0); @@ -1910,6 +1932,7 @@ void FurnaceGUI::syncSettings() { settings.dpiScale=e->getConfFloat("dpiScale",0.0f); settings.viewPrevPattern=e->getConfInt("viewPrevPattern",1); settings.guiColorsBase=e->getConfInt("guiColorsBase",0); + settings.guiColorsShading=e->getConfInt("guiColorsShading",0); settings.avoidRaisingPattern=e->getConfInt("avoidRaisingPattern",0); settings.insFocusesPattern=e->getConfInt("insFocusesPattern",1); settings.stepOnInsert=e->getConfInt("stepOnInsert",0); @@ -1933,6 +1956,7 @@ void FurnaceGUI::syncSettings() { settings.oscRoundedCorners=e->getConfInt("oscRoundedCorners",1); settings.oscTakesEntireWindow=e->getConfInt("oscTakesEntireWindow",0); settings.oscBorder=e->getConfInt("oscBorder",1); + settings.oscEscapesBoundary=e->getConfInt("oscEscapesBoundary",0); settings.separateFMColors=e->getConfInt("separateFMColors",0); settings.insEditColorize=e->getConfInt("insEditColorize",0); settings.metroVol=e->getConfInt("metroVol",100); @@ -1961,6 +1985,7 @@ void FurnaceGUI::syncSettings() { clampSetting(settings.audioRate,8000,384000); clampSetting(settings.arcadeCore,0,1); clampSetting(settings.ym2612Core,0,1); + clampSetting(settings.snCore,0,1); clampSetting(settings.saaCore,0,1); clampSetting(settings.nesCore,0,1); clampSetting(settings.fdsCore,0,1); @@ -1988,6 +2013,7 @@ void FurnaceGUI::syncSettings() { clampSetting(settings.dpiScale,0.0f,4.0f); clampSetting(settings.viewPrevPattern,0,1); clampSetting(settings.guiColorsBase,0,1); + clampSetting(settings.guiColorsShading,0,100); clampSetting(settings.avoidRaisingPattern,0,1); clampSetting(settings.insFocusesPattern,0,1); clampSetting(settings.stepOnInsert,0,1); @@ -2074,6 +2100,7 @@ void FurnaceGUI::commitSettings() { e->setConf("audioRate",settings.audioRate); e->setConf("arcadeCore",settings.arcadeCore); e->setConf("ym2612Core",settings.ym2612Core); + e->setConf("snCore",settings.snCore); e->setConf("saaCore",settings.saaCore); e->setConf("nesCore",settings.nesCore); e->setConf("fdsCore",settings.fdsCore); @@ -2107,6 +2134,7 @@ void FurnaceGUI::commitSettings() { e->setConf("dpiScale",settings.dpiScale); e->setConf("viewPrevPattern",settings.viewPrevPattern); e->setConf("guiColorsBase",settings.guiColorsBase); + e->setConf("guiColorsShading",settings.guiColorsShading); e->setConf("avoidRaisingPattern",settings.avoidRaisingPattern); e->setConf("insFocusesPattern",settings.insFocusesPattern); e->setConf("stepOnInsert",settings.stepOnInsert); @@ -2130,6 +2158,7 @@ void FurnaceGUI::commitSettings() { e->setConf("oscRoundedCorners",settings.oscRoundedCorners); e->setConf("oscTakesEntireWindow",settings.oscTakesEntireWindow); e->setConf("oscBorder",settings.oscBorder); + e->setConf("oscEscapesBoundary",settings.oscEscapesBoundary); e->setConf("separateFMColors",settings.separateFMColors); e->setConf("insEditColorize",settings.insEditColorize); e->setConf("metroVol",settings.metroVol); @@ -2670,6 +2699,10 @@ void FurnaceGUI::applyUISettings(bool updateFonts) { sty.FrameBorderSize=0.0f; } + if (settings.guiColorsShading>0) { + sty.FrameShading=(float)settings.guiColorsShading/100.0f; + } + sty.ScaleAllSizes(dpiScale); ImGui::GetStyle()=sty; diff --git a/src/gui/sysConf.cpp b/src/gui/sysConf.cpp index 8e748a53..befa13ed 100644 --- a/src/gui/sysConf.cpp +++ b/src/gui/sysConf.cpp @@ -380,6 +380,22 @@ void FurnaceGUI::drawSysConf(int chan, DivSystem type, unsigned int& flags, bool } break; } + case DIV_SYSTEM_MSM6295: { + ImGui::Text("Clock rate:"); + if (ImGui::RadioButton("1MHz",flags==0)) { + copyOfFlags=0; + } + if (ImGui::RadioButton("1.056MHz",flags==1)) { + copyOfFlags=1; + } + if (ImGui::RadioButton("4MHz",flags==2)) { + copyOfFlags=2; + } + if (ImGui::RadioButton("4.224MHz",flags==3)) { + copyOfFlags=3; + } + break; + } case DIV_SYSTEM_GB: case DIV_SYSTEM_SWAN: case DIV_SYSTEM_VERA: diff --git a/src/gui/waveEdit.cpp b/src/gui/waveEdit.cpp index b4057e68..4ff2182e 100644 --- a/src/gui/waveEdit.cpp +++ b/src/gui/waveEdit.cpp @@ -30,7 +30,7 @@ void FurnaceGUI::drawWaveEdit() { nextWindow=GUI_WINDOW_NOTHING; } if (!waveEditOpen) return; - float wavePreview[256]; + float wavePreview[257]; ImGui::SetNextWindowSizeConstraints(ImVec2(300.0f*dpiScale,300.0f*dpiScale),ImVec2(scrW*dpiScale,scrH*dpiScale)); if (ImGui::Begin("Wavetable Editor",&waveEditOpen,globalWinFlags|(settings.allowEditDocking?0:ImGuiWindowFlags_NoDocking))) { if (curWave<0 || curWave>=(int)e->song.wave.size()) {