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>
14 ;;; This file is part of GNU Guix.
16 ;;; GNU Guix is free software; you can redistribute it and/or modify it
17 ;;; under the terms of the GNU General Public License as published by
18 ;;; the Free Software Foundation; either version 3 of the License, or (at
19 ;;; your option) any later version.
21 ;;; GNU Guix is distributed in the hope that it will be useful, but
22 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
23 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 ;;; GNU General Public License for more details.
26 ;;; You should have received a copy of the GNU General Public License
27 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
29 (define-module (gnu packages sdl)
30 #:use-module (ice-9 match)
31 #:use-module (srfi srfi-1)
32 #:use-module (srfi srfi-26)
33 #:use-module (gnu packages)
34 #:use-module ((guix licenses) #:hide (freetype))
35 #:use-module (guix packages)
36 #:use-module (guix download)
37 #:use-module (guix utils)
38 #:use-module (guix build-system gnu)
39 #:use-module (guix build-system trivial)
40 #:use-module (gnu packages audio)
41 #:use-module (gnu packages fcitx)
42 #:use-module (gnu packages fontutils)
43 #:use-module (gnu packages freedesktop)
44 #:use-module (gnu packages glib)
45 #:use-module (gnu packages guile)
46 #:use-module (gnu packages ibus)
47 #:use-module (gnu packages image)
48 #:use-module (gnu packages linux)
49 #:use-module (gnu packages mp3)
50 #:use-module (gnu packages pkg-config)
51 #:use-module (gnu packages pulseaudio)
52 #:use-module (gnu packages gl)
53 #:use-module (gnu packages xdisorg)
54 #:use-module (gnu packages xiph)
55 #:use-module (gnu packages xorg)
65 (string-append "https://libsdl.org/release/SDL-"
69 "005d993xcac8236fpvd1iawkz4wqjybkpn8dbwaliqz5jfkidlyn"))
70 (patches (search-patches "sdl-libx11-1.6.patch"))))
71 (build-system gnu-build-system)
73 '(;; Explicitly link against shared libraries instead of dlopening them.
74 ;; For X11, ALSA, and PulseAudio.
75 ;; OpenGL library is still dlopened at runtime.
76 #:configure-flags '("--disable-alsa-shared"
77 "--disable-pulseaudio-shared"
78 "--disable-x11-shared"
79 ;; Explicitly link with mesa.
80 ;; This add mesa to libsdl's RUNPATH, to make dlopen
81 ;; finding the libGL from mesa at runtime.
84 #:make-flags '("V=1") ;build verbosely
86 #:tests? #f)) ; no check target
88 ;; SDL headers include X11 headers.
90 ("libcap" ,libcap) ; 'libSDL.la' contain `-lcap'.
91 ;; TODO: Since building Mesa with Meson it is now necessary that Mesa is
92 ;; a propogated input. We still need to figure out why, possibly due to a
93 ;; change in pkg-config.
95 (native-inputs `(("pkg-config" ,pkg-config)))
96 (inputs `(("libxrandr" ,libxrandr)
98 ("alsa-lib" ,alsa-lib)
99 ("pulseaudio" ,pulseaudio)))
100 (outputs '("out" "debug"))
101 (synopsis "Cross platform game development library")
102 (description "Simple DirectMedia Layer is a cross-platform development
103 library designed to provide low level access to audio, keyboard, mouse,
104 joystick, and graphics hardware.")
105 (home-page "https://libsdl.org/")
109 (package (inherit sdl)
115 (string-append "https://libsdl.org/release/SDL2-"
119 "0mqxp6w5jhbq6y1j690g9r3gpzwjxh4czaglw8x05l7hl49nqrdl"))))
121 (substitute-keyword-arguments (package-arguments sdl)
122 ((#:configure-flags flags)
123 `(append '("--disable-wayland-shared" "--enable-video-kmsdrm"
124 "--disable-kmsdrm-shared")
126 ((#:make-flags flags ''())
127 ;; Add the Fcitx header files to GCCs "system header" search path
128 ;; in order to suppress compiler warnings induced by those:
129 ;; .../include/fcitx-utils/utarray.h:178:9: error: ISO C90 forbids
130 ;; mixed declarations and code [-Werror=declaration-after-statement]
131 `(append (list (string-append "C_INCLUDE_PATH="
132 (assoc-ref %build-inputs "fcitx")
136 ;; SDL2 needs to be built with ibus support otherwise some systems
137 ;; experience a bug where input events are doubled.
139 ;; For more information, see: https://dev.solus-project.com/T1721
140 (append `(("dbus" ,dbus)
141 ("fcitx" ,fcitx) ; helps with CJK input
144 ("libxkbcommon" ,libxkbcommon)
145 ("libxcursor" ,libxcursor) ; enables X11 cursor support
147 ("wayland-protocols" ,wayland-protocols))
148 (package-inputs sdl)))
151 (define-public libmikmod
158 (string-append "mirror://sourceforge/mikmod/libmikmod/"
159 version "/libmikmod-" version ".tar.gz")
160 ;; Older versions are sometimes moved to:
161 (string-append "mirror://sourceforge/mikmod/"
162 "outdated_versions/libmikmod/"
163 version "/libmikmod-" version ".tar.gz")))
166 "06bdnhb0l81srdzg6gn2v2ydhhaazza7rshrcj3q8dpqr3gn97dd"))))
167 (build-system gnu-build-system)
169 ;; By default, libmikmod tries to dlopen libasound etc., which won't work
170 ;; unless the right libalsa happens to be in $LD_LIBRARY_PATH. Pass
171 ;; '--disable-dl' to avoid that.
172 '(#:configure-flags '("--disable-dl")))
173 (synopsis "Library for module sound formats")
175 "MikMod is able to play a wide range of module formats, as well as
176 digital sound files. It can take advantage of particular features of your
177 system, such as sound redirection over the network.")
179 (home-page "http://mikmod.sourceforge.net/")))
181 (define-public sdl-gfx
188 (string-append "http://www.ferzkopp.net/Software/SDL_gfx-2.0/SDL_gfx-"
192 "0ijljhs0v99dj6y27hc10z6qchyp8gdp4199y6jzngy6dzxlzsvw"))))
193 (build-system gnu-build-system)
194 (outputs '("out" "debug"))
196 `(,@(if (any (cute string-prefix? <> (or (%current-system)
197 (%current-target-system)))
199 ;; mmx is supported only on Intel processors.
201 '(#:configure-flags '("--disable-mmx")))))
202 (propagated-inputs `(("sdl" ,sdl)))
203 (synopsis "SDL graphics primitives library")
204 (description "SDL_gfx provides graphics drawing primitives, rotozoom and
205 other supporting functions for SDL.")
206 (home-page "http://www.ferzkopp.net/joomla/software-mainmenu-14/4-ferzkopps-linux-software/19-sdlgfx")
209 (define-public sdl-image
216 (string-append "https://www.libsdl.org/projects/SDL_image/release/SDL_image-"
220 "16an9slbb8ci7d89wakkmyfvp7c0cval8xw4hkg0842nhhlp540b"))))
221 (build-system gnu-build-system)
222 (outputs '("out" "debug"))
224 ;; Explicitly link against shared libraries instead of dlopening them.
225 '(#:configure-flags '("--disable-jpg-shared"
226 "--disable-png-shared"
227 "--disable-tif-shared"
228 "--disable-webp-shared")))
229 (native-inputs `(("pkg-config" ,pkg-config)))
230 ;; libjpeg, libpng, and libtiff are propagated inputs because the
231 ;; SDL_image headers include the headers of these libraries. SDL is a
232 ;; propagated input because the pkg-config file refers to SDL's pkg-config
234 (propagated-inputs `(("sdl" ,sdl)
238 ("libwebp" ,libwebp)))
239 (synopsis "SDL image loading library")
240 (description "SDL_image is an image file loading library for SDL that
241 supports the following formats: BMP, GIF, JPEG, LBM, PCX, PNG, PNM, TGA, TIFF,
242 WEBP, XCF, XPM, and XV.")
243 (home-page "https://www.libsdl.org/projects/SDL_image/")
246 (define-public sdl-mixer
253 (string-append "https://www.libsdl.org/projects/SDL_mixer/release/SDL_mixer-"
257 "0alrhqgm40p4c92s26mimg9cm1y7rzr6m0p49687jxd9g6130i0n"))))
258 (build-system gnu-build-system)
259 (outputs '("out" "debug"))
261 ;; use libmad instead of smpeg
262 ;; explicitly link against shared libraries instead of dlopening them
263 (arguments `(#:tests? #f
264 #:configure-flags '("--enable-music-mp3-mad-gpl"
265 "--disable-music-mod-shared"
266 "--disable-music-fluidsynth-shared"
267 "--disable-music-ogg-shared"
268 "--disable-music-flac-shared"
269 "--disable-music-mp3-shared")))
270 (inputs `(("libvorbis" ,libvorbis)
273 ("libmikmod" ,libmikmod)
274 ("libmodplug" ,libmodplug)))
275 ;; FIXME: Add libfluidsynth
276 (propagated-inputs `(("sdl" ,sdl)))
277 (synopsis "SDL multi-channel audio mixer library")
278 (description "SDL_mixer is a multi-channel audio mixer library for SDL.
279 It supports any number of simultaneously playing channels of 16 bit stereo
280 audio, plus a single channel of music. Supported format include FLAC, MOD,
281 MIDI, Ogg Vorbis, and MP3.")
282 (home-page "https://www.libsdl.org/projects/SDL_mixer/")
285 (define-public sdl-net
292 (string-append "https://www.libsdl.org/projects/SDL_net/release/SDL_net-"
296 "1d5c9xqlf4s1c01gzv6cxmg0r621pq9kfgxcg3197xw4p25pljjz"))))
297 (build-system gnu-build-system)
298 (propagated-inputs `(("sdl" ,sdl)))
299 (native-inputs `(("pkg-config" ,pkg-config)))
300 (outputs '("out" "debug"))
301 (synopsis "SDL networking library")
302 (description "SDL_net is a small, cross-platform networking library for
304 (home-page "https://www.libsdl.org/projects/SDL_net/")
307 (define-public sdl-ttf
314 (string-append "https://www.libsdl.org/projects/SDL_ttf/release/SDL_ttf-"
318 "1dydxd4f5kb1288i5n5568kdk2q7f8mqjr7i7sd33nplxjaxhk3j"))))
319 (build-system gnu-build-system)
320 (propagated-inputs `(("sdl" ,sdl)))
321 (inputs `(("freetype" ,freetype)
323 (native-inputs `(("pkg-config" ,pkg-config)))
324 (outputs '("out" "debug"))
325 (synopsis "SDL TrueType font library")
326 (description "SDL_ttf is a TrueType font rendering library for SDL.")
327 (home-page "https://www.libsdl.org/projects/SDL_ttf/")
330 (define* (sdl-union #:optional (packages (list sdl sdl-gfx sdl-net sdl-ttf
331 sdl-image sdl-mixer)))
332 "Return 'sdl-union' package which is a union of PACKAGES.
333 If PACKAGES are not specified, all SDL packages are used."
336 (version (package-version sdl))
338 (build-system trivial-build-system)
340 '(#:modules ((guix build union))
342 (use-modules (ice-9 match)
345 (((names . directories) ...)
346 (union-build (assoc-ref %outputs "out")
349 (inputs (map (lambda (package)
350 (list (package-name package) package))
352 (synopsis "Union of SDL libraries")
354 "A union of SDL and its extension libraries. A union is required because
355 sdl-config assumes that all of the headers and libraries are in the same
357 (home-page (package-home-page sdl))
358 (license (package-license sdl))))
360 (define (propagated-inputs-with-sdl2 package)
361 "Replace the \"sdl\" propagated input of PACKAGE with SDL2."
366 (package-propagated-inputs package)))
368 (define-public sdl2-gfx
369 (package (inherit sdl-gfx)
375 (string-append "https://www.ferzkopp.net/Software/SDL2_gfx/SDL2_gfx-"
379 "0qk2ax7f7grlxb13ba0ll3zlm8780s7j8fmrhlpxzjgdvldf1q33"))))
381 (propagated-inputs-with-sdl2 sdl-gfx))))
383 (define-public sdl2-image
384 (package (inherit sdl-image)
391 (string-append "https://www.libsdl.org/projects/SDL_image/release/"
392 "SDL2_image-" version ".tar.gz"))
394 (base32 "1b6f7002bm007y3zpyxb5r6ag0lml51jyvx1pwpj9sq24jfc8kp7"))))
396 (propagated-inputs-with-sdl2 sdl-image))))
398 (define-public sdl2-mixer
399 (package (inherit sdl-mixer)
406 (string-append "http://www.libsdl.org/projects/SDL_mixer/release/"
407 "SDL2_mixer-" version ".tar.gz"))
408 (modules '((guix build utils)))
410 ;; Remove bundled libraries.
411 (delete-file-recursively "external")
414 (base32 "0694vsz5bjkcdgfdra6x9fq8vpzrl8m6q96gh58df7065hw5mkxl"))))
416 (propagated-inputs-with-sdl2 sdl-mixer))))
418 (define-public sdl2-net
419 (package (inherit sdl-net)
426 (string-append "http://www.libsdl.org/projects/SDL_net/release/"
427 "SDL2_net-" version ".tar.gz"))
430 "08cxc1bicmyk89kiks7izw1rlx5ng5n6xpy8fy0zxni3b9z8mkhm"))))
432 (propagated-inputs-with-sdl2 sdl-net))))
434 (define-public sdl2-ttf
435 (package (inherit sdl-ttf)
441 (string-append "https://www.libsdl.org/projects/SDL_ttf/release/SDL2_ttf-"
443 (modules '((guix build utils)))
445 ;; Remove bundled libraries.
446 '(delete-file-recursively "external")
450 "0cyd48dipc0m399qy8s03lci8b0bpiy8xlkvrm2ia7wcv0dfpv59"))))
452 (propagated-inputs-with-sdl2 sdl-ttf))))
454 (define-public guile-sdl
461 (string-append "mirror://gnu/guile-sdl/guile-sdl-"
465 "0cjgs012a9922hn6xqwj66w6qmfs3nycnm56hyykx5n3g5p7ag01"))))
466 (build-system gnu-build-system)
468 `(("pkg-config" ,pkg-config)
469 ;; Required by test suite.
470 ("xorg-server" ,xorg-server)
471 ("libjpeg" ,libjpeg)))
473 `(("guile" ,guile-2.2)
474 ("sdl-union" ,(sdl-union))))
477 (list (string-append "--with-sdl-prefix="
478 (assoc-ref %build-inputs "sdl-union")))
479 #:modules ((ice-9 popen)
481 (guix build gnu-build-system))
483 #:parallel-build? #f ; parallel build fails
486 (modify-phases %standard-phases
487 (add-before 'configure 'fix-env-and-patch
488 (lambda* (#:key inputs #:allow-other-keys)
489 (setenv "GUILE_AUTO_COMPILE" "0")
490 ;; SDL_image needs to dlopen libjpeg in the test suite.
491 (setenv "LD_LIBRARY_PATH"
492 (string-append (assoc-ref inputs "libjpeg") "/lib"))
494 ;; Change the site directory /site/X.Y like Guile expects.
495 (substitute* "build-aux/guile-baux/re-prefixed-site-dirs"
499 (open-pipe* OPEN_READ
501 "(write (effective-version))"))))
502 (string-append "\"/site/" effective "\""))))
504 ;; Skip tests that rely on sound support, which is unavailable in
505 ;; the build environment.
506 (substitute* "test/Makefile.in"
507 (("HAVE_MIXER = .*$")
510 (add-before 'check 'start-xorg-server
511 (lambda* (#:key inputs #:allow-other-keys)
512 ;; The test suite requires a running X server.
513 (system (format #f "~a/bin/Xvfb :1 &"
514 (assoc-ref inputs "xorg-server")))
515 (setenv "DISPLAY" ":1")
517 (add-before 'check 'skip-cursor-test
519 ;; XXX: This test sometimes enters an endless loop, and sometimes
521 ;; guile: xcb_io.c:147: append_pending_request: Assertion `!xcb_xlib_unknown_seq_number' failed.
523 (substitute* "test/cursor.scm"
524 (("\\(SDL:init .*" all)
525 (string-append "(exit 77) ;" all "\n")))
527 (synopsis "Guile interface for SDL (Simple DirectMedia Layer)")
528 (description "Guile-SDL is a set of bindings to the Simple DirectMedia
529 Layer (SDL). With them, Guile programmers can have easy access to graphics,
530 sound and device input (keyboards, joysticks, mice, etc.).")
531 (home-page "https://www.gnu.org/software/guile-sdl/")
534 (define-public guile-sdl2
540 (uri (string-append "https://files.dthompson.us/guile-sdl2/"
541 "guile-sdl2-" version ".tar.gz"))
544 "0zcxwgyadwpbhq6h5mv2569c3kalgra26zc186y9fqiyyzmh1v9s"))))
545 (build-system gnu-build-system)
547 '(#:make-flags '("GUILE_AUTO_COMPILE=0")
549 (list (string-append "--with-libsdl2-prefix="
550 (assoc-ref %build-inputs "sdl2"))
551 (string-append "--with-libsdl2-image-prefix="
552 (assoc-ref %build-inputs "sdl2-image"))
553 (string-append "--with-libsdl2-ttf-prefix="
554 (assoc-ref %build-inputs "sdl2-ttf"))
555 (string-append "--with-libsdl2-mixer-prefix="
556 (assoc-ref %build-inputs "sdl2-mixer")))))
558 `(("guile" ,guile-2.2)
559 ("pkg-config" ,pkg-config)))
562 ("sdl2-image" ,sdl2-image)
563 ("sdl2-mixer" ,sdl2-mixer)
564 ("sdl2-ttf" ,sdl2-ttf)))
565 (synopsis "Guile bindings for SDL2")
566 (home-page "https://dthompson.us/projects/guile-sdl2.html")
568 "Guile-SDL2 provides Guile Scheme bindings for the SDL2 C shared library.
569 The bindings are written in pure Scheme using Guile's foreign function