1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2013, 2015, 2017 David Thompson <dthompson2@worcester.edu>
3 ;;; Copyright © 2014 Mark H Weaver <mhw@netris.org>
4 ;;; Copyright © 2015, 2017 Sou Bunnbu <iyzsong@member.fsf.org>
5 ;;; Copyright © 2015 Alex Kost <alezost@gmail.com>
6 ;;; Copyright © 2016, 2017 Efraim Flashner <efraim@flashner.co.il>
7 ;;; Copyright © 2017, 2018, 2019 Rutger Helling <rhelling@mykolab.com>
8 ;;; Copyright © 2018, 2019 Tobias Geerinckx-Rice <me@tobias.gr>
9 ;;; Copyright © 2018, 2019 Ricardo Wurmus <rekado@elephly.net>
10 ;;; Copyright © 2019 Kei Kebreau <kkebreau@posteo.net>
11 ;;; Copyright © 2019 Nicolas Goaziou <mail@nicolasgoaziou.fr>
12 ;;; Copyright © 2019 Marius Bakke <mbakke@fastmail.com>
13 ;;; Copyright © 2019 Pierre Neidhardt <mail@ambrevar.xyz>
14 ;;; Copyright © 2020 Timotej Lazar <timotej.lazar@araneo.si>
16 ;;; This file is part of GNU Guix.
18 ;;; GNU Guix is free software; you can redistribute it and/or modify it
19 ;;; under the terms of the GNU General Public License as published by
20 ;;; the Free Software Foundation; either version 3 of the License, or (at
21 ;;; your option) any later version.
23 ;;; GNU Guix is distributed in the hope that it will be useful, but
24 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
25 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 ;;; GNU General Public License for more details.
28 ;;; You should have received a copy of the GNU General Public License
29 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
31 (define-module (gnu packages sdl)
32 #:use-module (ice-9 match)
33 #:use-module (srfi srfi-1)
34 #:use-module (srfi srfi-26)
35 #:use-module (gnu packages)
36 #:use-module ((guix licenses) #:hide (freetype))
37 #:use-module (guix packages)
38 #:use-module (guix download)
39 #:use-module (guix git-download)
40 #:use-module (guix utils)
41 #:use-module (guix build-system gnu)
42 #:use-module (guix build-system trivial)
43 #:use-module (gnu packages audio)
44 #:use-module (gnu packages fcitx)
45 #:use-module (gnu packages fontutils)
46 #:use-module (gnu packages freedesktop)
47 #:use-module (gnu packages glib)
48 #:use-module (gnu packages guile)
49 #:use-module (gnu packages ibus)
50 #:use-module (gnu packages image)
51 #:use-module (gnu packages linux)
52 #:use-module (gnu packages mono)
53 #:use-module (gnu packages mp3)
54 #:use-module (gnu packages pkg-config)
55 #:use-module (gnu packages pulseaudio)
56 #:use-module (gnu packages gl)
57 #:use-module (gnu packages xdisorg)
58 #:use-module (gnu packages xiph)
59 #:use-module (gnu packages xorg)
69 (string-append "https://libsdl.org/release/SDL-"
73 "005d993xcac8236fpvd1iawkz4wqjybkpn8dbwaliqz5jfkidlyn"))
74 (patches (search-patches "sdl-libx11-1.6.patch"))))
75 (build-system gnu-build-system)
77 '(;; Explicitly link against shared libraries instead of dlopening them.
78 ;; For X11, ALSA, and PulseAudio.
79 ;; OpenGL library is still dlopened at runtime.
80 #:configure-flags '("--disable-alsa-shared"
81 "--disable-pulseaudio-shared"
82 "--disable-x11-shared"
83 ;; Explicitly link with mesa.
84 ;; This add mesa to libsdl's RUNPATH, to make dlopen
85 ;; finding the libGL from mesa at runtime.
88 #:make-flags '("V=1") ;build verbosely
90 #:tests? #f)) ; no check target
92 ;; SDL headers include X11 headers.
94 ("libcap" ,libcap) ; 'libSDL.la' contain `-lcap'.
95 ;; TODO: Since building Mesa with Meson it is now necessary that Mesa is
96 ;; a propogated input. We still need to figure out why, possibly due to a
97 ;; change in pkg-config.
99 (native-inputs `(("pkg-config" ,pkg-config)))
100 (inputs `(("libxrandr" ,libxrandr)
102 ("alsa-lib" ,alsa-lib)
103 ("pulseaudio" ,pulseaudio)))
104 (outputs '("out" "debug"))
105 (synopsis "Cross platform game development library")
106 (description "Simple DirectMedia Layer is a cross-platform development
107 library designed to provide low level access to audio, keyboard, mouse,
108 joystick, and graphics hardware.")
109 (home-page "https://libsdl.org/")
113 (package (inherit sdl)
119 (string-append "https://libsdl.org/release/SDL2-"
121 (patches (search-patches "sdl2-mesa-compat.patch"))
124 "0mqxp6w5jhbq6y1j690g9r3gpzwjxh4czaglw8x05l7hl49nqrdl"))))
126 (substitute-keyword-arguments (package-arguments sdl)
127 ((#:configure-flags flags)
128 `(append '("--disable-wayland-shared" "--enable-video-kmsdrm"
129 "--disable-kmsdrm-shared")
131 ((#:make-flags flags ''())
132 ;; Add the Fcitx header files to GCCs "system header" search path
133 ;; in order to suppress compiler warnings induced by those:
134 ;; .../include/fcitx-utils/utarray.h:178:9: error: ISO C90 forbids
135 ;; mixed declarations and code [-Werror=declaration-after-statement]
136 `(append (list (string-append "C_INCLUDE_PATH="
137 (assoc-ref %build-inputs "fcitx")
141 ;; SDL2 needs to be built with ibus support otherwise some systems
142 ;; experience a bug where input events are doubled.
144 ;; For more information, see: https://dev.solus-project.com/T1721
145 (append `(("dbus" ,dbus)
146 ("fcitx" ,fcitx) ; helps with CJK input
149 ("libxkbcommon" ,libxkbcommon)
150 ("libxcursor" ,libxcursor) ; enables X11 cursor support
152 ("wayland-protocols" ,wayland-protocols))
153 (package-inputs sdl)))
156 (define-public libmikmod
163 (string-append "mirror://sourceforge/mikmod/libmikmod/"
164 version "/libmikmod-" version ".tar.gz")
165 ;; Older versions are sometimes moved to:
166 (string-append "mirror://sourceforge/mikmod/"
167 "outdated_versions/libmikmod/"
168 version "/libmikmod-" version ".tar.gz")))
171 "06bdnhb0l81srdzg6gn2v2ydhhaazza7rshrcj3q8dpqr3gn97dd"))))
172 (build-system gnu-build-system)
174 ;; By default, libmikmod tries to dlopen libasound etc., which won't work
175 ;; unless the right libalsa happens to be in $LD_LIBRARY_PATH. Pass
176 ;; '--disable-dl' to avoid that.
177 '(#:configure-flags '("--disable-dl")))
178 (synopsis "Library for module sound formats")
180 "MikMod is able to play a wide range of module formats, as well as
181 digital sound files. It can take advantage of particular features of your
182 system, such as sound redirection over the network.")
184 (home-page "http://mikmod.sourceforge.net/")))
186 (define-public sdl-gfx
193 (string-append "http://www.ferzkopp.net/Software/SDL_gfx-2.0/SDL_gfx-"
197 "0ijljhs0v99dj6y27hc10z6qchyp8gdp4199y6jzngy6dzxlzsvw"))))
198 (build-system gnu-build-system)
199 (outputs '("out" "debug"))
201 `(,@(if (any (cute string-prefix? <> (or (%current-system)
202 (%current-target-system)))
204 ;; mmx is supported only on Intel processors.
206 '(#:configure-flags '("--disable-mmx")))))
207 (propagated-inputs `(("sdl" ,sdl)))
208 (synopsis "SDL graphics primitives library")
209 (description "SDL_gfx provides graphics drawing primitives, rotozoom and
210 other supporting functions for SDL.")
211 (home-page "http://www.ferzkopp.net/joomla/software-mainmenu-14/4-ferzkopps-linux-software/19-sdlgfx")
214 (define-public sdl-image
221 (string-append "https://www.libsdl.org/projects/SDL_image/release/SDL_image-"
225 "16an9slbb8ci7d89wakkmyfvp7c0cval8xw4hkg0842nhhlp540b"))))
226 (build-system gnu-build-system)
227 (outputs '("out" "debug"))
229 ;; Explicitly link against shared libraries instead of dlopening them.
230 '(#:configure-flags '("--disable-jpg-shared"
231 "--disable-png-shared"
232 "--disable-tif-shared"
233 "--disable-webp-shared")))
234 (native-inputs `(("pkg-config" ,pkg-config)))
235 ;; libjpeg, libpng, and libtiff are propagated inputs because the
236 ;; SDL_image headers include the headers of these libraries. SDL is a
237 ;; propagated input because the pkg-config file refers to SDL's pkg-config
239 (propagated-inputs `(("sdl" ,sdl)
243 ("libwebp" ,libwebp)))
244 (synopsis "SDL image loading library")
245 (description "SDL_image is an image file loading library for SDL that
246 supports the following formats: BMP, GIF, JPEG, LBM, PCX, PNG, PNM, TGA, TIFF,
247 WEBP, XCF, XPM, and XV.")
248 (home-page "https://www.libsdl.org/projects/SDL_image/")
251 (define-public sdl-mixer
258 (string-append "https://www.libsdl.org/projects/SDL_mixer/release/SDL_mixer-"
262 "0alrhqgm40p4c92s26mimg9cm1y7rzr6m0p49687jxd9g6130i0n"))))
263 (build-system gnu-build-system)
264 (outputs '("out" "debug"))
266 `(#:tests? #f ; No check target.
268 '("--enable-music-mp3-mad-gpl" ; Use libmad instead of smpeg.
269 ;; Explicitly link against shared libraries instead of dlopening them.
270 "--disable-music-flac-shared"
271 "--disable-music-fluidsynth-shared"
272 "--disable-music-mod-shared"
273 "--disable-music-ogg-shared")))
275 `(("fluidsynth" ,fluidsynth)
278 ("libmikmod" ,libmikmod)
279 ("libvorbis" ,libvorbis)))
280 (propagated-inputs `(("sdl" ,sdl)))
281 (synopsis "SDL multi-channel audio mixer library")
282 (description "SDL_mixer is a multi-channel audio mixer library for SDL.
283 It supports any number of simultaneously playing channels of 16 bit stereo
284 audio, plus a single channel of music. Supported formats include FLAC, MOD,
285 MIDI, Ogg Vorbis, and MP3.
287 This package supports two MIDI backends, selectable at runtime. To use the
288 newer @code{fluidsynth} library, install a soundfont such as @code{fluid-3}
289 and specify it using the @code{SDL_SOUNDFONTS} environment variable. For the
290 legacy @code{timidity} backend, install a patch set such as @code{freepats}
291 and set the path to the configuration file with @code{TIMIDITY_CFG}.")
292 (home-page "https://www.libsdl.org/projects/SDL_mixer/")
295 (define-public sdl-net
302 (string-append "https://www.libsdl.org/projects/SDL_net/release/SDL_net-"
306 "1d5c9xqlf4s1c01gzv6cxmg0r621pq9kfgxcg3197xw4p25pljjz"))))
307 (build-system gnu-build-system)
308 (propagated-inputs `(("sdl" ,sdl)))
309 (native-inputs `(("pkg-config" ,pkg-config)))
310 (outputs '("out" "debug"))
311 (synopsis "SDL networking library")
312 (description "SDL_net is a small, cross-platform networking library for
314 (home-page "https://www.libsdl.org/projects/SDL_net/")
317 (define-public sdl-ttf
324 (string-append "https://www.libsdl.org/projects/SDL_ttf/release/SDL_ttf-"
328 "1dydxd4f5kb1288i5n5568kdk2q7f8mqjr7i7sd33nplxjaxhk3j"))))
329 (build-system gnu-build-system)
330 (propagated-inputs `(("sdl" ,sdl)))
331 (inputs `(("freetype" ,freetype)
333 (native-inputs `(("pkg-config" ,pkg-config)))
334 (outputs '("out" "debug"))
335 (synopsis "SDL TrueType font library")
336 (description "SDL_ttf is a TrueType font rendering library for SDL.")
337 (home-page "https://www.libsdl.org/projects/SDL_ttf/")
340 (define* (sdl-union #:optional (packages (list sdl sdl-gfx sdl-net sdl-ttf
341 sdl-image sdl-mixer)))
342 "Return 'sdl-union' package which is a union of PACKAGES.
343 If PACKAGES are not specified, all SDL packages are used."
346 (version (package-version sdl))
348 (build-system trivial-build-system)
350 '(#:modules ((guix build union))
352 (use-modules (ice-9 match)
355 (((names . directories) ...)
356 (union-build (assoc-ref %outputs "out")
359 (inputs (map (lambda (package)
360 (list (package-name package) package))
362 (synopsis "Union of SDL libraries")
364 "A union of SDL and its extension libraries. A union is required because
365 sdl-config assumes that all of the headers and libraries are in the same
367 (home-page (package-home-page sdl))
368 (license (package-license sdl))))
370 (define (propagated-inputs-with-sdl2 package)
371 "Replace the \"sdl\" propagated input of PACKAGE with SDL2."
376 (package-propagated-inputs package)))
378 (define-public sdl2-gfx
379 (package (inherit sdl-gfx)
385 (string-append "https://www.ferzkopp.net/Software/SDL2_gfx/SDL2_gfx-"
389 "0qk2ax7f7grlxb13ba0ll3zlm8780s7j8fmrhlpxzjgdvldf1q33"))))
391 (propagated-inputs-with-sdl2 sdl-gfx))))
393 (define-public sdl2-image
394 (package (inherit sdl-image)
401 (string-append "https://www.libsdl.org/projects/SDL_image/release/"
402 "SDL2_image-" version ".tar.gz"))
404 (base32 "1b6f7002bm007y3zpyxb5r6ag0lml51jyvx1pwpj9sq24jfc8kp7"))))
406 (propagated-inputs-with-sdl2 sdl-image))))
408 (define-public sdl2-mixer
409 (package (inherit sdl-mixer)
416 (string-append "http://www.libsdl.org/projects/SDL_mixer/release/"
417 "SDL2_mixer-" version ".tar.gz"))
418 (modules '((guix build utils)))
420 ;; Remove bundled libraries.
421 (delete-file-recursively "external")
424 (base32 "0694vsz5bjkcdgfdra6x9fq8vpzrl8m6q96gh58df7065hw5mkxl"))))
426 (substitute-keyword-arguments (package-arguments sdl-mixer)
427 ((#:configure-flags flags)
429 "--disable-music-opus-shared"
430 ;; These options were renamed in SDL2 mixer. Keeping the inherited
431 ;; variants produces a harmless warning.
432 "--disable-music-mod-modplug-shared"
433 "--disable-music-midi-fluidsynth-shared"
436 `(("opusfile" ,opusfile)
437 ;; The default MOD library changed in SDL2 mixer.
438 ("libmodplug" ,libmodplug)
439 ,@(alist-delete "libmikmod" (package-inputs sdl-mixer))))
441 `(("pkgconfig" ,pkg-config))) ; Needed to find the opus library.
443 (propagated-inputs-with-sdl2 sdl-mixer))))
445 (define-public sdl2-net
446 (package (inherit sdl-net)
453 (string-append "http://www.libsdl.org/projects/SDL_net/release/"
454 "SDL2_net-" version ".tar.gz"))
457 "08cxc1bicmyk89kiks7izw1rlx5ng5n6xpy8fy0zxni3b9z8mkhm"))))
459 (propagated-inputs-with-sdl2 sdl-net))))
461 (define-public sdl2-ttf
462 (package (inherit sdl-ttf)
468 (string-append "https://www.libsdl.org/projects/SDL_ttf/release/SDL2_ttf-"
470 (modules '((guix build utils)))
472 ;; Remove bundled libraries.
473 '(delete-file-recursively "external")
477 "0cyd48dipc0m399qy8s03lci8b0bpiy8xlkvrm2ia7wcv0dfpv59"))))
479 (propagated-inputs-with-sdl2 sdl-ttf))))
481 (define-public guile-sdl
488 (string-append "mirror://gnu/guile-sdl/guile-sdl-"
492 "0cjgs012a9922hn6xqwj66w6qmfs3nycnm56hyykx5n3g5p7ag01"))))
493 (build-system gnu-build-system)
495 `(("pkg-config" ,pkg-config)
496 ;; Required by test suite.
497 ("xorg-server" ,xorg-server)
498 ("libjpeg" ,libjpeg)))
500 `(("guile" ,guile-2.2)
501 ("sdl-union" ,(sdl-union))))
504 (list (string-append "--with-sdl-prefix="
505 (assoc-ref %build-inputs "sdl-union")))
506 #:modules ((ice-9 popen)
508 (guix build gnu-build-system))
510 #:parallel-build? #f ; parallel build fails
513 (modify-phases %standard-phases
514 (add-before 'configure 'fix-env-and-patch
515 (lambda* (#:key inputs #:allow-other-keys)
516 (setenv "GUILE_AUTO_COMPILE" "0")
517 ;; SDL_image needs to dlopen libjpeg in the test suite.
518 (setenv "LD_LIBRARY_PATH"
519 (string-append (assoc-ref inputs "libjpeg") "/lib"))
521 ;; Change the site directory /site/X.Y like Guile expects.
522 (substitute* "build-aux/guile-baux/re-prefixed-site-dirs"
526 (open-pipe* OPEN_READ
528 "(write (effective-version))"))))
529 (string-append "\"/site/" effective "\""))))
531 ;; Skip tests that rely on sound support, which is unavailable in
532 ;; the build environment.
533 (substitute* "test/Makefile.in"
534 (("HAVE_MIXER = .*$")
537 (add-before 'check 'start-xorg-server
538 (lambda* (#:key inputs #:allow-other-keys)
539 ;; The test suite requires a running X server.
540 (system (format #f "~a/bin/Xvfb :1 &"
541 (assoc-ref inputs "xorg-server")))
542 (setenv "DISPLAY" ":1")
544 (add-before 'check 'skip-cursor-test
546 ;; XXX: This test sometimes enters an endless loop, and sometimes
548 ;; guile: xcb_io.c:147: append_pending_request: Assertion `!xcb_xlib_unknown_seq_number' failed.
550 (substitute* "test/cursor.scm"
551 (("\\(SDL:init .*" all)
552 (string-append "(exit 77) ;" all "\n")))
554 (synopsis "Guile interface for SDL (Simple DirectMedia Layer)")
555 (description "Guile-SDL is a set of bindings to the Simple DirectMedia
556 Layer (SDL). With them, Guile programmers can have easy access to graphics,
557 sound and device input (keyboards, joysticks, mice, etc.).")
558 (home-page "https://www.gnu.org/software/guile-sdl/")
561 (define-public guile-sdl2
567 (uri (string-append "https://files.dthompson.us/guile-sdl2/"
568 "guile-sdl2-" version ".tar.gz"))
571 "0zcxwgyadwpbhq6h5mv2569c3kalgra26zc186y9fqiyyzmh1v9s"))))
572 (build-system gnu-build-system)
574 '(#:make-flags '("GUILE_AUTO_COMPILE=0")
576 (list (string-append "--with-libsdl2-prefix="
577 (assoc-ref %build-inputs "sdl2"))
578 (string-append "--with-libsdl2-image-prefix="
579 (assoc-ref %build-inputs "sdl2-image"))
580 (string-append "--with-libsdl2-ttf-prefix="
581 (assoc-ref %build-inputs "sdl2-ttf"))
582 (string-append "--with-libsdl2-mixer-prefix="
583 (assoc-ref %build-inputs "sdl2-mixer")))))
585 `(("guile" ,guile-2.2)
586 ("pkg-config" ,pkg-config)))
589 ("sdl2-image" ,sdl2-image)
590 ("sdl2-mixer" ,sdl2-mixer)
591 ("sdl2-ttf" ,sdl2-ttf)))
592 (synopsis "Guile bindings for SDL2")
593 (home-page "https://dthompson.us/projects/guile-sdl2.html")
595 "Guile-SDL2 provides Guile Scheme bindings for the SDL2 C shared library.
596 The bindings are written in pure Scheme using Guile's foreign function
600 (define-public sdl2-cs
601 (let ((commit "1a3556441e1394eb0b5d46aeb514b8d1090b93f8"))
604 (version (git-version "B1" "1" commit))
608 (url "https://github.com/flibitijibibo/SDL2-CS")
610 (file-name (git-file-name name version))
613 "007mzkqr9nmvfrvvhs2r6cm36lzgsww24kwshsz9c4fd97f9qk58"))))
614 (build-system gnu-build-system)
616 '(#:tests? #f ; No tests.
618 (modify-phases %standard-phases
622 (invoke "make" "release")))
624 (lambda* (#:key outputs #:allow-other-keys)
625 (let ((out (assoc-ref outputs "out")))
626 (install-file "bin/Release/SDL2-CS.dll" (string-append out "/lib"))
632 ("sdl2-image" ,sdl2-image)
633 ("sdl2-mixer" ,sdl2-mixer)
634 ("sdl2-ttf" ,sdl2-ttf)))
635 (home-page "https://dthompson.us/projects/guile-sdl2.html")
636 (synopsis "C# wrapper for SDL2")
638 "SDL2-CS provides C# bindings for the SDL2 C shared library.
639 The C# wrapper was written to be used for FNA's platform support. However, this
640 is written in a way that can be used for any general C# application.")