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, 2020 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>
15 ;;; Copyright © 2020 Oleg Pykhalov <go.wigust@gmail.com>
17 ;;; This file is part of GNU Guix.
19 ;;; GNU Guix is free software; you can redistribute it and/or modify it
20 ;;; under the terms of the GNU General Public License as published by
21 ;;; the Free Software Foundation; either version 3 of the License, or (at
22 ;;; your option) any later version.
24 ;;; GNU Guix is distributed in the hope that it will be useful, but
25 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
26 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 ;;; GNU General Public License for more details.
29 ;;; You should have received a copy of the GNU General Public License
30 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
32 (define-module (gnu packages sdl)
33 #:use-module (ice-9 match)
34 #:use-module (srfi srfi-1)
35 #:use-module (srfi srfi-26)
36 #:use-module (gnu packages)
37 #:use-module ((guix licenses) #:hide (freetype))
38 #:use-module (guix packages)
39 #:use-module (guix download)
40 #:use-module (guix git-download)
41 #:use-module (guix utils)
42 #:use-module (guix build-system gnu)
43 #:use-module (guix build-system trivial)
44 #:use-module (gnu packages audio)
45 #:use-module (gnu packages autotools)
46 #:use-module (gnu packages fcitx)
47 #:use-module (gnu packages fontutils)
48 #:use-module (gnu packages freedesktop)
49 #:use-module (gnu packages glib)
50 #:use-module (gnu packages gtk)
51 #:use-module (gnu packages guile)
52 #:use-module (gnu packages ibus)
53 #:use-module (gnu packages image)
54 #:use-module (gnu packages linux)
55 #:use-module (gnu packages mono)
56 #:use-module (gnu packages mp3)
57 #:use-module (gnu packages pkg-config)
58 #:use-module (gnu packages pulseaudio)
59 #:use-module (gnu packages gl)
60 #:use-module (gnu packages xdisorg)
61 #:use-module (gnu packages xiph)
62 #:use-module (gnu packages xorg)
72 (string-append "https://libsdl.org/release/SDL-"
76 "005d993xcac8236fpvd1iawkz4wqjybkpn8dbwaliqz5jfkidlyn"))
77 (patches (search-patches "sdl-libx11-1.6.patch"))))
78 (build-system gnu-build-system)
80 '(;; Explicitly link against shared libraries instead of dlopening them.
81 ;; For X11, ALSA, and PulseAudio.
82 ;; OpenGL library is still dlopened at runtime.
83 #:configure-flags '("--disable-alsa-shared"
84 "--disable-pulseaudio-shared"
85 "--disable-x11-shared"
86 ;; Explicitly link with mesa.
87 ;; This add mesa to libsdl's RUNPATH, to make dlopen
88 ;; finding the libGL from mesa at runtime.
91 #:make-flags '("V=1") ;build verbosely
93 #:tests? #f)) ; no check target
95 ;; SDL headers include X11 headers.
97 ("libcap" ,libcap) ; 'libSDL.la' contain `-lcap'.
98 ;; TODO: Since building Mesa with Meson it is now necessary that Mesa is
99 ;; a propogated input. We still need to figure out why, possibly due to a
100 ;; change in pkg-config.
102 (native-inputs `(("pkg-config" ,pkg-config)))
103 (inputs `(("libxrandr" ,libxrandr)
105 ("alsa-lib" ,alsa-lib)
106 ("pulseaudio" ,pulseaudio)))
107 (outputs '("out" "debug"))
108 (synopsis "Cross platform game development library")
109 (description "Simple DirectMedia Layer is a cross-platform development
110 library designed to provide low level access to audio, keyboard, mouse,
111 joystick, and graphics hardware.")
112 (home-page "https://libsdl.org/")
116 (package (inherit sdl)
122 (string-append "https://libsdl.org/release/SDL2-"
124 (patches (search-patches "sdl2-mesa-compat.patch"))
127 "0mqxp6w5jhbq6y1j690g9r3gpzwjxh4czaglw8x05l7hl49nqrdl"))))
129 (substitute-keyword-arguments (package-arguments sdl)
130 ((#:configure-flags flags)
131 `(append '("--disable-wayland-shared" "--enable-video-kmsdrm"
132 "--disable-kmsdrm-shared")
134 ((#:make-flags flags ''())
135 ;; Add the Fcitx header files to GCCs "system header" search path
136 ;; in order to suppress compiler warnings induced by those:
137 ;; .../include/fcitx-utils/utarray.h:178:9: error: ISO C90 forbids
138 ;; mixed declarations and code [-Werror=declaration-after-statement]
139 `(append (list (string-append "C_INCLUDE_PATH="
140 (assoc-ref %build-inputs "fcitx")
144 ;; SDL2 needs to be built with ibus support otherwise some systems
145 ;; experience a bug where input events are doubled.
147 ;; For more information, see: https://dev.solus-project.com/T1721
148 (append `(("dbus" ,dbus)
149 ("fcitx" ,fcitx) ; helps with CJK input
152 ("libxkbcommon" ,libxkbcommon)
153 ("libxcursor" ,libxcursor) ; enables X11 cursor support
155 ("wayland-protocols" ,wayland-protocols))
156 (package-inputs sdl)))
159 (define-public libmikmod
166 (string-append "mirror://sourceforge/mikmod/libmikmod/"
167 version "/libmikmod-" version ".tar.gz")
168 ;; Older versions are sometimes moved to:
169 (string-append "mirror://sourceforge/mikmod/"
170 "outdated_versions/libmikmod/"
171 version "/libmikmod-" version ".tar.gz")))
174 "06bdnhb0l81srdzg6gn2v2ydhhaazza7rshrcj3q8dpqr3gn97dd"))))
175 (build-system gnu-build-system)
177 ;; By default, libmikmod tries to dlopen libasound etc., which won't work
178 ;; unless the right libalsa happens to be in $LD_LIBRARY_PATH. Pass
179 ;; '--disable-dl' to avoid that.
180 '(#:configure-flags '("--disable-dl")))
181 (synopsis "Library for module sound formats")
183 "MikMod is able to play a wide range of module formats, as well as
184 digital sound files. It can take advantage of particular features of your
185 system, such as sound redirection over the network.")
187 (home-page "http://mikmod.sourceforge.net/")))
189 (define-public sdl-gfx
196 (string-append "http://www.ferzkopp.net/Software/SDL_gfx-2.0/SDL_gfx-"
200 "0ijljhs0v99dj6y27hc10z6qchyp8gdp4199y6jzngy6dzxlzsvw"))))
201 (build-system gnu-build-system)
202 (outputs '("out" "debug"))
204 `(,@(if (any (cute string-prefix? <> (or (%current-system)
205 (%current-target-system)))
207 ;; mmx is supported only on Intel processors.
209 '(#:configure-flags '("--disable-mmx")))))
210 (propagated-inputs `(("sdl" ,sdl)))
211 (synopsis "SDL graphics primitives library")
212 (description "SDL_gfx provides graphics drawing primitives, rotozoom and
213 other supporting functions for SDL.")
214 (home-page "http://www.ferzkopp.net/joomla/software-mainmenu-14/4-ferzkopps-linux-software/19-sdlgfx")
217 (define-public sdl-image
224 (string-append "https://www.libsdl.org/projects/SDL_image/release/SDL_image-"
228 "16an9slbb8ci7d89wakkmyfvp7c0cval8xw4hkg0842nhhlp540b"))))
229 (build-system gnu-build-system)
230 (outputs '("out" "debug"))
232 ;; Explicitly link against shared libraries instead of dlopening them.
233 '(#:configure-flags '("--disable-jpg-shared"
234 "--disable-png-shared"
235 "--disable-tif-shared"
236 "--disable-webp-shared")))
237 (native-inputs `(("pkg-config" ,pkg-config)))
238 ;; libjpeg, libpng, and libtiff are propagated inputs because the
239 ;; SDL_image headers include the headers of these libraries. SDL is a
240 ;; propagated input because the pkg-config file refers to SDL's pkg-config
242 (propagated-inputs `(("sdl" ,sdl)
246 ("libwebp" ,libwebp)))
247 (synopsis "SDL image loading library")
248 (description "SDL_image is an image file loading library for SDL that
249 supports the following formats: BMP, GIF, JPEG, LBM, PCX, PNG, PNM, TGA, TIFF,
250 WEBP, XCF, XPM, and XV.")
251 (home-page "https://www.libsdl.org/projects/SDL_image/")
254 (define-public sdl-mixer
261 (string-append "https://www.libsdl.org/projects/SDL_mixer/release/SDL_mixer-"
265 "0alrhqgm40p4c92s26mimg9cm1y7rzr6m0p49687jxd9g6130i0n"))))
266 (build-system gnu-build-system)
267 (outputs '("out" "debug"))
269 `(#:tests? #f ; No check target.
271 '("--enable-music-mp3-mad-gpl" ; Use libmad instead of smpeg.
272 ;; Explicitly link against shared libraries instead of dlopening them.
273 "--disable-music-flac-shared"
274 "--disable-music-fluidsynth-shared"
275 "--disable-music-mod-shared"
276 "--disable-music-ogg-shared")
278 (modify-phases %standard-phases
279 (add-after 'unpack 'fix-fluidsynth
280 (lambda* (#:key inputs #:allow-other-keys)
281 (substitute* "configure"
282 (("EXTRA_LDFLAGS -lfluidsynth")
283 (string-append "EXTRA_LDFLAGS "
285 (assoc-ref inputs "fluidsynth")
286 "/lib -lfluidsynth")))
289 `(("fluidsynth" ,fluidsynth)
292 ("libmikmod" ,libmikmod)
293 ("libvorbis" ,libvorbis)))
294 (propagated-inputs `(("sdl" ,sdl)))
295 (synopsis "SDL multi-channel audio mixer library")
296 (description "SDL_mixer is a multi-channel audio mixer library for SDL.
297 It supports any number of simultaneously playing channels of 16 bit stereo
298 audio, plus a single channel of music. Supported formats include FLAC, MOD,
299 MIDI, Ogg Vorbis, and MP3.
301 This package supports two MIDI backends, selectable at runtime. To use the
302 newer @code{fluidsynth} library, install a soundfont such as @code{fluid-3}
303 and specify it using the @code{SDL_SOUNDFONTS} environment variable. For the
304 legacy @code{timidity} backend, install a patch set such as @code{freepats}
305 and set the path to the configuration file with @code{TIMIDITY_CFG}.")
306 (home-page "https://www.libsdl.org/projects/SDL_mixer/")
309 (define-public sdl-net
316 (string-append "https://www.libsdl.org/projects/SDL_net/release/SDL_net-"
320 "1d5c9xqlf4s1c01gzv6cxmg0r621pq9kfgxcg3197xw4p25pljjz"))))
321 (build-system gnu-build-system)
322 (propagated-inputs `(("sdl" ,sdl)))
323 (native-inputs `(("pkg-config" ,pkg-config)))
324 (outputs '("out" "debug"))
325 (synopsis "SDL networking library")
326 (description "SDL_net is a small, cross-platform networking library for
328 (home-page "https://www.libsdl.org/projects/SDL_net/")
331 (define-public sdl-pango
339 "mirror://sourceforge/sdlpango/SDL_Pango/" version "/"
340 "SDL_Pango-" version ".tar.gz"))
342 (base32 "197baw1dsg0p4pljs5k0fshbyki00r4l49m1drlpqw6ggawx6xbz"))
345 "sdl-pango-api_additions.patch"
346 "sdl-pango-blit_overflow.patch"
347 "sdl-pango-fillrect_crash.patch"
348 "sdl-pango-fix-explicit-SDLPango_CopyFTBitmapToSurface.patch"
349 "sdl-pango-matrix_declarations.patch"
350 "sdl-pango-sans-serif.patch"))))
351 (build-system gnu-build-system)
353 `(#:configure-flags (list "--disable-static")
355 (modify-phases %standard-phases
356 (add-after 'unpack 'autogen
357 ;; Force reconfiguration because the included libtool
358 ;; generates linking errors.
359 (lambda _ (invoke "autoreconf" "-vif"))))))
361 `(("autoconf" ,autoconf)
362 ("automake" ,automake)
364 ("pkg-config" ,pkg-config)))
366 `(("fontconfig" ,fontconfig)
367 ("freetype" ,freetype)
369 ("harfbuzz" ,harfbuzz)
372 (home-page "http://sdlpango.sourceforge.net")
373 (synopsis "Pango SDL binding")
374 (description "This library is a wrapper around the Pango library.
375 It allows you to use TrueType fonts to render internationalized and
376 tagged text in SDL applications.")
379 (define-public sdl-ttf
386 (string-append "https://www.libsdl.org/projects/SDL_ttf/release/SDL_ttf-"
390 "1dydxd4f5kb1288i5n5568kdk2q7f8mqjr7i7sd33nplxjaxhk3j"))))
391 (build-system gnu-build-system)
392 (propagated-inputs `(("sdl" ,sdl)))
393 (inputs `(("freetype" ,freetype)
395 (native-inputs `(("pkg-config" ,pkg-config)))
396 (outputs '("out" "debug"))
397 (synopsis "SDL TrueType font library")
398 (description "SDL_ttf is a TrueType font rendering library for SDL.")
399 (home-page "https://www.libsdl.org/projects/SDL_ttf/")
402 (define* (sdl-union #:optional (packages (list sdl sdl-gfx sdl-net sdl-ttf
403 sdl-image sdl-mixer)))
404 "Return 'sdl-union' package which is a union of PACKAGES.
405 If PACKAGES are not specified, all SDL packages are used."
408 (version (package-version sdl))
410 (build-system trivial-build-system)
412 '(#:modules ((guix build union))
414 (use-modules (ice-9 match)
417 (((names . directories) ...)
418 (union-build (assoc-ref %outputs "out")
421 (inputs (map (lambda (package)
422 (list (package-name package) package))
424 (synopsis "Union of SDL libraries")
426 "A union of SDL and its extension libraries. A union is required because
427 sdl-config assumes that all of the headers and libraries are in the same
429 (home-page (package-home-page sdl))
430 (license (package-license sdl))))
432 (define (propagated-inputs-with-sdl2 package)
433 "Replace the \"sdl\" propagated input of PACKAGE with SDL2."
438 (package-propagated-inputs package)))
440 (define-public sdl2-gfx
441 (package (inherit sdl-gfx)
447 (string-append "https://www.ferzkopp.net/Software/SDL2_gfx/SDL2_gfx-"
451 "0qk2ax7f7grlxb13ba0ll3zlm8780s7j8fmrhlpxzjgdvldf1q33"))))
453 (propagated-inputs-with-sdl2 sdl-gfx))))
455 (define-public sdl2-image
456 (package (inherit sdl-image)
463 (string-append "https://www.libsdl.org/projects/SDL_image/release/"
464 "SDL2_image-" version ".tar.gz"))
466 (base32 "1l0864kas9cwpp2d32yxl81g98lx40dhbdp03dz7sbv84vhgdmdx"))))
468 (propagated-inputs-with-sdl2 sdl-image))))
470 (define-public sdl2-mixer
471 (package (inherit sdl-mixer)
478 (string-append "http://www.libsdl.org/projects/SDL_mixer/release/"
479 "SDL2_mixer-" version ".tar.gz"))
480 (modules '((guix build utils)))
482 ;; Remove bundled libraries.
483 (delete-file-recursively "external")
486 (base32 "0694vsz5bjkcdgfdra6x9fq8vpzrl8m6q96gh58df7065hw5mkxl"))))
488 (substitute-keyword-arguments (package-arguments sdl-mixer)
489 ((#:configure-flags flags)
491 "--disable-music-opus-shared"
492 ;; These options were renamed in SDL2 mixer. Keeping the inherited
493 ;; variants produces a harmless warning.
494 "--disable-music-mod-modplug-shared"
495 "--disable-music-midi-fluidsynth-shared"
498 `(("opusfile" ,opusfile)
499 ;; The default MOD library changed in SDL2 mixer.
500 ("libmodplug" ,libmodplug)
501 ,@(alist-delete "libmikmod" (package-inputs sdl-mixer))))
503 `(("pkgconfig" ,pkg-config))) ; Needed to find the opus library.
505 (propagated-inputs-with-sdl2 sdl-mixer))))
507 (define-public sdl2-net
508 (package (inherit sdl-net)
515 (string-append "http://www.libsdl.org/projects/SDL_net/release/"
516 "SDL2_net-" version ".tar.gz"))
519 "08cxc1bicmyk89kiks7izw1rlx5ng5n6xpy8fy0zxni3b9z8mkhm"))))
521 (propagated-inputs-with-sdl2 sdl-net))))
523 (define-public sdl2-ttf
524 (package (inherit sdl-ttf)
530 (string-append "https://www.libsdl.org/projects/SDL_ttf/release/SDL2_ttf-"
532 (modules '((guix build utils)))
534 ;; Remove bundled libraries.
535 '(delete-file-recursively "external")
539 "0cyd48dipc0m399qy8s03lci8b0bpiy8xlkvrm2ia7wcv0dfpv59"))))
541 (propagated-inputs-with-sdl2 sdl-ttf))))
543 (define-public guile-sdl
550 (string-append "mirror://gnu/guile-sdl/guile-sdl-"
554 "0cjgs012a9922hn6xqwj66w6qmfs3nycnm56hyykx5n3g5p7ag01"))))
555 (build-system gnu-build-system)
557 `(("pkg-config" ,pkg-config)
558 ;; Required by test suite.
559 ("xorg-server" ,xorg-server)
560 ("libjpeg" ,libjpeg)))
562 `(("guile" ,guile-2.2)
563 ("sdl-union" ,(sdl-union))))
566 (list (string-append "--with-sdl-prefix="
567 (assoc-ref %build-inputs "sdl-union")))
568 #:modules ((ice-9 popen)
570 (guix build gnu-build-system))
572 #:parallel-build? #f ; parallel build fails
575 (modify-phases %standard-phases
576 (add-before 'configure 'fix-env-and-patch
577 (lambda* (#:key inputs #:allow-other-keys)
578 (setenv "GUILE_AUTO_COMPILE" "0")
579 ;; SDL_image needs to dlopen libjpeg in the test suite.
580 (setenv "LD_LIBRARY_PATH"
581 (string-append (assoc-ref inputs "libjpeg") "/lib"))
583 ;; Change the site directory /site/X.Y like Guile expects.
584 (substitute* "build-aux/guile-baux/re-prefixed-site-dirs"
588 (open-pipe* OPEN_READ
590 "(write (effective-version))"))))
591 (string-append "\"/site/" effective "\""))))
593 ;; Skip tests that rely on sound support, which is unavailable in
594 ;; the build environment.
595 (substitute* "test/Makefile.in"
596 (("HAVE_MIXER = .*$")
599 (add-before 'check 'start-xorg-server
600 (lambda* (#:key inputs #:allow-other-keys)
601 ;; The test suite requires a running X server.
602 (system (format #f "~a/bin/Xvfb :1 &"
603 (assoc-ref inputs "xorg-server")))
604 (setenv "DISPLAY" ":1")
606 (add-before 'check 'skip-cursor-test
608 ;; XXX: This test sometimes enters an endless loop, and sometimes
610 ;; guile: xcb_io.c:147: append_pending_request: Assertion `!xcb_xlib_unknown_seq_number' failed.
612 (substitute* "test/cursor.scm"
613 (("\\(SDL:init .*" all)
614 (string-append "(exit 77) ;" all "\n")))
616 (synopsis "Guile interface for SDL (Simple DirectMedia Layer)")
617 (description "Guile-SDL is a set of bindings to the Simple DirectMedia
618 Layer (SDL). With them, Guile programmers can have easy access to graphics,
619 sound and device input (keyboards, joysticks, mice, etc.).")
620 (home-page "https://www.gnu.org/software/guile-sdl/")
623 (define-public guile-sdl2
629 (uri (string-append "https://files.dthompson.us/guile-sdl2/"
630 "guile-sdl2-" version ".tar.gz"))
633 "0zcxwgyadwpbhq6h5mv2569c3kalgra26zc186y9fqiyyzmh1v9s"))))
634 (build-system gnu-build-system)
636 '(#:make-flags '("GUILE_AUTO_COMPILE=0")
638 (list (string-append "--with-libsdl2-prefix="
639 (assoc-ref %build-inputs "sdl2"))
640 (string-append "--with-libsdl2-image-prefix="
641 (assoc-ref %build-inputs "sdl2-image"))
642 (string-append "--with-libsdl2-ttf-prefix="
643 (assoc-ref %build-inputs "sdl2-ttf"))
644 (string-append "--with-libsdl2-mixer-prefix="
645 (assoc-ref %build-inputs "sdl2-mixer")))))
647 `(("guile" ,guile-2.2)
648 ("pkg-config" ,pkg-config)))
651 ("sdl2-image" ,sdl2-image)
652 ("sdl2-mixer" ,sdl2-mixer)
653 ("sdl2-ttf" ,sdl2-ttf)))
654 (synopsis "Guile bindings for SDL2")
655 (home-page "https://dthompson.us/projects/guile-sdl2.html")
657 "Guile-SDL2 provides Guile Scheme bindings for the SDL2 C shared library.
658 The bindings are written in pure Scheme using Guile's foreign function
662 (define-public sdl2-cs
663 (let ((commit "1a3556441e1394eb0b5d46aeb514b8d1090b93f8"))
666 (version (git-version "B1" "1" commit))
670 (url "https://github.com/flibitijibibo/SDL2-CS")
672 (file-name (git-file-name name version))
675 "007mzkqr9nmvfrvvhs2r6cm36lzgsww24kwshsz9c4fd97f9qk58"))))
676 (build-system gnu-build-system)
678 '(#:tests? #f ; No tests.
680 (modify-phases %standard-phases
684 (invoke "make" "release")))
686 (lambda* (#:key outputs #:allow-other-keys)
687 (let ((out (assoc-ref outputs "out")))
688 (install-file "bin/Release/SDL2-CS.dll" (string-append out "/lib"))
694 ("sdl2-image" ,sdl2-image)
695 ("sdl2-mixer" ,sdl2-mixer)
696 ("sdl2-ttf" ,sdl2-ttf)))
697 (home-page "https://dthompson.us/projects/guile-sdl2.html")
698 (synopsis "C# wrapper for SDL2")
700 "SDL2-CS provides C# bindings for the SDL2 C shared library.
701 The C# wrapper was written to be used for FNA's platform support. However, this
702 is written in a way that can be used for any general C# application.")