619b21425a
Context: The codecs implement a read-write callback function
(RWops) used to read N bytes from the underlying binary stream
into a buffer. In some cases, a codec might only return a
subset of the requested bytes and requires subsequent read()
requests to get the remaining bytes. Internally, the codec
might have to reposition or run second decode sequence to get
the bytes.
The RWops callbacks for the various codecs were inconsistently
implemented: some performed the above mentioned subsequent
re-read attempts while others simply accepted whatever we got
after the first read attempt. This commit makes them the same
by attempting to re-read ("get the requested bytes at all
costs") until the underly stream goes EOF.
Some of these RWops functions also contained a book-keeping
bug from upstream that resulted in over-reading after
under-delivering on the first read attempt. The concequence
being that too much data would be written to the buffer
(writing past its end) and leaving the underlying stream's
file position too-far-forward.
|
||
|---|---|---|
| .github | ||
| contrib | ||
| docs | ||
| include | ||
| m4 | ||
| scripts | ||
| src | ||
| vs | ||
| .gitignore | ||
| .mdlrc | ||
| .pvs-suppress | ||
| .pylint | ||
| AUTHORS | ||
| autogen.sh | ||
| configure.ac | ||
| COPYING | ||
| INSTALL | ||
| Makefile.am | ||
| README | ||
| README.md | ||
| THANKS | ||
dosbox-staging
This repository attempts to modernize the DOSBox project by using current development practices and tools, fixing issues, adding features that better support today's systems, and sending patches upstream. Read more at Vogons thread.
Summary of differences compared to upstream
| dosbox-staging | DOSBox | |
|---|---|---|
| Version control | Git | SVN |
| Language | C++11 | C++031 |
| CI | Yes | No |
| Static analysis | Yes2,3 | No |
| Dynamic analysis | Yes | No |
| Automated regression tests | No (planned)4 | No |
| SDL | 2.0 | 1.2＊ |
dosbox-staging does not support audio playback using physical CDs. Using CD Digital Audio emulation (loading CD music via cue sheets or mounting ISO images) is preferred instead.
Codecs supported for CD-DA emulation:
| dosbox-staging† | DOSBox‡ | |
|---|---|---|
| Opus | Yes (libopus) | No |
| OGG/Vorbis | Yes (built-in) | Yes - SDL_sound 1.2 (libvorbis)5,＊ |
| MP3 | Yes (built-in) | Yes - SDL_sound 1.2 (libmpg123)5,＊,§ |
| FLAC | Yes (built-in) | No§ |
| WAV | Yes (built-in) | Yes - SDL_sound 1.2 (internal)6,＊ |
| AIFF | No | Yes - SDL_sound 1.2 (internal)6,＊ |
＊- SDL 1.2 was last updated 2013-08-17 and SDL_sound 2008-04-20
† - 22.05 kHz, 44.1 kHz, 48 kHz; mono, stereo
‡ - 44.1 kHz stereo only
§ - Broken or unsupported in either SDL_sound or DOSBox
Other feature differences:
| dosbox-staging | DOSBox | |
|---|---|---|
| OPL emulators | compat, fast, mame, nuked7 | compat, fast, mame |
| CGA/mono support | Yes (machine=cga_mono)8 |
Only CGA with colour |
| Wayland support | Experimental (use SDL_VIDEODRIVER=wayland) |
N/A |
Development snapshot builds
Pre-release builds can be downloaded from CI build artifacts. Go to Linux or Windows, select a build you are interested in, and download the package linked in the "Artifacts" section.
Linux
Snapshots are dynamically-linked x86_64 builds, you'll need additional packages installed via your package manager.
Fedora
sudo dnf install SDL2 SDL2_net opusfile
Debian, Ubuntu
sudo apt install libsdl2-2.0 libsdl2-net-2.0 libopusfile0
Arch, Manjaro
sudo pacman -S sdl2 sdl2_net opusfile
Windows
A dosbox.exe file in a snapshot package is not signed, therefore Windows 10 might prevent the program from starting.
If Windows displays the message "Windows Defender SmartScreen prevented an unrecognised app from starting", you have two options to dismiss it:
- Click "More info", and button "Run anyway" will appear.
- Right-click on dosbox.exe, select: Properties → General → Security → Unblock
Windows packages are built for "x86" architecture (in practice it means i686).
macOS
macOS snapshots are not available at the moment. See #148.
Build instructions
Linux, macOS, MSYS2, MinGW, other OSes
Read INSTALL file for a general summary about dependencies and configure options. Read build.md for the comprehensive compilation guide.
git clone https://github.com/dreamer/dosbox-staging.git
cd dosbox-staging
./autogen.sh
./configure
make
You can also use a helper script ./scripts/build.sh,
that performs builds for many useful scenarios (LTO, FDO, sanitizer builds,
many others).
Visual Studio (2019 or newer)
First, you need to setup vcpkg to install build dependencies. Once vcpkg is installed and bootstrapped, open PowerShell, and run:
PS:\> .\vcpkg integrate install
PS:\> .\vcpkg install libpng sdl2 sdl2-net opusfile
These two steps will ensure that MSVC finds and links all dependencies.
Start Visual Studio, open file: vs\dosbox.sln and build all projects
(Ctrl+Shift+B).
Interop with SVN
This repository is (deliberately) NOT git-svn compatible, this is a pure Git repo.
Commits landing in SVN upstream are imported to this repo in a timely manner,
to the branches matching
svn/*
pattern.
You can safely use those branches to rebase your changes, and prepare patches
using Git format-patch for sending
upstream (it is easier and faster, than preparing patches manually).
Other branch name patterns are also in use, e.g.
vogons/*
for various patches posted on the Vogons forum.
Git tags matching pattern svn/* are pointing to the commits referenced by SVN
"tag" paths at the time of creation.
Additionally, we attach some optional metadata to the commits imported from SVN in the form of Git notes. To fetch them, run:
git fetch origin "refs/notes/*:refs/notes/*"