Skip to content

Commit

Permalink
Enhancement: Build Improvements (Unix + CoD Plugin) (#272)
Browse files Browse the repository at this point in the history
  • Loading branch information
bedwardly-down authored Sep 13, 2024
1 parent 97321a1 commit 2e51fb7
Show file tree
Hide file tree
Showing 16 changed files with 235 additions and 51 deletions.
49 changes: 47 additions & 2 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,31 @@ ELSE()
ENDIF()
ENDIF()

# Added these to solve some build issues I ran into - Brad
IF(FTE_BIG_ENDIAN)
ADD_DEFINITIONS(-DFTE_BIG_ENDIAN)
ENDIF()

IF(FTE_LITTLE_ENDIAN)
ADD_DEFINITIONS(-DFTE_LITTLE_ENDIAN)
ENDIF()

# libepoll-shim needs to be installed on the BSDs and Mac OSX to get
# some of the server code to compile and work correctly on those platforms - Brad
IF(UNIX AND NOT LINUX AND NOT CYGWIN)
INCLUDE(FetchContent)
FetchContent_Declare(
epoll-shim
GIT_REPOSITORY https://github.com/jiixyj/epoll-shim.git
GIT_TAG master
)
SET(epoll-shim BUILD_TESTS OFF CACHE INTERNAL "")
SET(epoll-shim BUILD_SHARED_LIBS OFF CACHE INTERNAL "")
FetchContent_MakeAvailable(epoll-shim)

SET(EPOLL_INC_DIR "${epoll-shim_SOURCE_DIR}/include")
ENDIF()

SET(FTE_BUILD_CONFIG ${CMAKE_HOME_DIRECTORY}/engine/common/config_fteqw.h CACHE FILEPATH "Which build config file to use to control supported features.")
SET(FTE_LIB_DEFINES ${FTE_LIB_DEFINES};CONFIG_FILE_NAME=${FTE_BUILD_CONFIG})
SET(FTE_USE_SDL false CACHE BOOL "Force the use of SDL instead of using native builds.")
Expand Down Expand Up @@ -495,6 +520,12 @@ ELSEIF(UNIX AND NOT FTE_USE_SDL) #linux(ish)
ENDIF()
ENDIF()

IF(NOT LINUX AND NOT CYGWIN)
FIND_LIBRARY(epoll-shim REQUIRED)
INCLUDE_DIRECTORIES(${EPOLL_INC_DIR})
SET(FTESV_LIBS ${FTESV_LIBS} epoll-shim)
ENDIF()

SET(FTESV_DEFINES ${FTESV_DEFINES};MULTITHREAD)
SET(FTESV_ARCH_FILES ${FTESV_ARCH_FILES}
engine/server/sv_sys_unix.c
Expand Down Expand Up @@ -1056,6 +1087,11 @@ ELSE()
${FTE_CLIENT_FILES}
${FTE_SERVER_FILES}
)
IF(UNIX AND NOT LINUX AND NOT CYGWIN)
FIND_LIBRARY(epoll-shim REQUIRED)
SET(FTE_INCLUDES ${FTE_INCLUDES} "${EPOLL_INC_DIR}")
SET(FTE_LIBS ${FTE_LIBS} epoll-shim)
ENDIF()
SET_TARGET_PROPERTIES(fteqw PROPERTIES COMPILE_DEFINITIONS "${FTE_LIB_DEFINES};${FTE_DEFINES};${FTE_REVISON}")
TARGET_INCLUDE_DIRECTORIES(fteqw PUBLIC ${FTE_INCLUDES})
TARGET_LINK_LIBRARIES(fteqw ${FTE_LIBS})
Expand Down Expand Up @@ -1158,8 +1194,13 @@ ELSE()
SET_TARGET_PROPERTIES(qtv PROPERTIES COMPILE_DEFINITIONS "${FTE_REVISON}")
IF(WIN32)
TARGET_LINK_LIBRARIES(qtv ws2_32 winmm ${SYS_LIBS} ${ZLIB_LIBRARIES})
ELSE()
ELSEIF(LINUX)
TARGET_LINK_LIBRARIES(qtv ${SYS_LIBS} ${ZLIB_LIBRARIES})
# Add Epoll-shim for the Unixes here - Brad
ELSE()
FIND_LIBRARY(epoll-shim REQUIRED)
TARGET_INCLUDE_DIRECTORIES(qtv PUBLIC "${EPOLL_INC_DIR}")
TARGET_LINK_LIBRARIES(qtv epoll-shim ${SYS_LIBS} ${ZLIB_LIBRARIES})
ENDIF()
SET(INSTALLTARGS ${INSTALLTARGS} qtv)
ENDIF()
Expand Down Expand Up @@ -1202,6 +1243,10 @@ ELSE()
SET_TARGET_PROPERTIES(httpserver PROPERTIES COMPILE_DEFINITIONS "WEBSERVER;WEBSVONLY;${FTE_REVISON}")
IF(WIN32)
TARGET_LINK_LIBRARIES(httpserver ws2_32)
ELSEIF(UNIX AND NOT LINUX AND NOT CYGWIN)
FIND_LIBRARY(epoll-shim REQUIRED)
TARGET_INCLUDE_DIRECTORIES(httpserver PUBLIC "${EPOLL_INC_DIR}")
TARGET_LINK_LIBRARIES(httpserver epoll-shim)
ENDIF()
#SET(INSTALLTARGS ${INSTALLTARGS} httpserver)
ENDIF()
Expand Down Expand Up @@ -1676,7 +1721,7 @@ IF(FTE_PLUG_XMPP)
)
SET_TARGET_PROPERTIES(plug_xmpp PROPERTIES COMPILE_DEFINITIONS "FTEPLUGIN;${FTE_LIB_DEFINES}")
IF(${WIN32})
ELSE()
ELSEIF(LINUX OR APPLE)
TARGET_LINK_LIBRARIES(plug_xmpp ${SYS_LIBS} resolv)
ENDIF()

Expand Down
117 changes: 110 additions & 7 deletions engine/client/cd_linux.c
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,16 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
// Quake is a trademark of Id Software, Inc., (c) 1996 Id Software, Inc. All
// rights reserved.

/*
* All Unix porting was primarily focused on getting this to work on FreeBSD 14+
* but hopefully will give others the ability to further improve upon it.
* Most information sourced from the following documentation:
* Linux CDROM ioctl: https://www.kernel.org/doc/html/latest/userspace-api/ioctl/cdrom.html
* FreeBSD 14.0 cd man page: https://man.freebsd.org/cgi/man.cgi?query=cd&sektion=4&apropos=0&manpath=FreeBSD+14.0-RELEASE+and+Ports
* The cdio header file found at /usr/include/sys/cdio.h (very well documented about what everything does)
* - Brad
*/

#include "quakedef.h"

#ifndef HAVE_CDPLAYER
Expand All @@ -40,10 +50,32 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#include <time.h>
#include <errno.h>

#if defined(__linux__)
#include <linux/cdrom.h>
#elif defined(__unix__) && !defined(__CYGWIN__)
#include <sys/cdio.h>
#define CDROMEJECT CDDOEJECT
#define CDROMCLOSETRAY CDDOCLOSE
#define CDROMPAUSE CDDOPAUSE
#define CDROMRESUME CDDORESUME
#define CDROMRESET CDDORESET
#define CDROMSTOP CDDOSTOP
#define CDROMSTART CDDOSTART
#define CDROMREADTOCHDR CDREADHEADER
#define CDROMREADTOCENTRY CDIOREADTOCENTRY
#define CDROMSUBCHNL CDREADSUBQ
#define CDROM_MSF CD_MSF_FORMAT
#define CDROM_DATA_TRACK CD_SUBQ_DATA
#define CDROM_AUDIO_PAUSED CD_AS_PLAY_PAUSED
#define CDROM_AUDIO_PLAY CD_AS_PLAY_IN_PROGRESS
#endif

static int cdfile = -1;
#if defined(__unix__) && !defined(__APPLE__) && !defined(__CYGWIN__) && !defined(__linux__)
static char cd_dev[64] = "/dev/cd0";
#else
static char cd_dev[64] = "/dev/cdrom";
#endif
static qboolean playing;

void CDAudio_Eject(void)
Expand All @@ -67,59 +99,109 @@ void CDAudio_CloseDoor(void)

int CDAudio_GetAudioDiskInfo(void)
{
#ifdef __linux__
struct cdrom_tochdr tochdr;
#elif defined(__unix__) && !defined(__CYGWIN__)
struct ioc_toc_header tochdr;
struct cd_sub_channel_track_info trk;
#endif

if (cdfile == -1)
return -1;

if ( ioctl(cdfile, CDROMREADTOCHDR, &tochdr) == -1 )
{
{
Con_DPrintf("ioctl cdromreadtochdr failed\n");
return -1;
}
}

if (tochdr.cdth_trk0 < 1)
#ifdef __linux__
if (tochdr.cdth_trk0 < 1)
#elif defined(__unix__) && !defined(__CYGWIN__)
if (trk.track_number < 0) // track_number may not work correctly here - Brad
#endif
{
Con_DPrintf("CDAudio: no music tracks\n");
return -1;
}

#ifdef __linux__
return tochdr.cdth_trk1;
#elif defined(__unix__) && !defined(__CYGWIN__)
return tochdr.starting_track;
#else
Con_DPrintf("CDAudio: no music tracks\n");
return -1;
#endif
}


void CDAudio_Play(int track)
{
#ifdef __linux__
struct cdrom_tocentry entry;
struct cdrom_ti ti;
#elif defined(__unix__) && !defined(__CYGWIN__) // This all may be wrong, but it should be close - Brad
struct ioc_toc_header tochdr; // cd drive header info (for getting start and end track info mostly)
struct ioc_read_toc_single_entry entry; // individual audio track's entry info
struct cd_sub_channel_info ti; // individual audio track's subchannel info (for indexing and whatnot)
struct ioc_play_track play; // cd drive audio indexing
#endif

if (cdfile == -1)
return;

// don't try to play a non-audio track
#ifdef __linux__
entry.cdte_track = track;
entry.cdte_format = CDROM_MSF;
if ( ioctl(cdfile, CDROMREADTOCENTRY, &entry) == -1 )
#elif defined(__unix__) && !defined(__CYGWIN__)
entry.track = track;
entry.address_format = CDROM_MSF;
#endif

if ( ioctl(cdfile, CDROMREADTOCENTRY, &entry) == -1 )
{
Con_DPrintf("ioctl cdromreadtocentry failed\n");
return;
}
#ifdef __linux__
if (entry.cdte_ctrl == CDROM_DATA_TRACK)
#elif defined(__unix__) && !defined(__CYGWIN__)
if (entry.entry.control == CDROM_DATA_TRACK)
#endif
{
Con_Printf("CDAudio: track %i is not audio\n", track);
return;
}

#ifdef __linux__
ti.cdti_trk0 = track;
ti.cdti_trk1 = track;
ti.cdti_ind0 = 1;
ti.cdti_ind1 = 99;
#elif defined(__unix__) && !defined(__CYGWIN__)
if (ti.what.position.track_number == 0 || ti.what.position.track_number == 1)
{
entry.track = track;
}
if (ti.what.position.index_number == 0)
{
play.start_track = tochdr.starting_track;
}
if (ti.what.position.index_number == 1)
{
play.end_track = tochdr.ending_track;
}

#define CDROMPLAYTRKIND ti.what.position.track_number
#endif

if ( ioctl(cdfile, CDROMPLAYTRKIND, &ti) == -1 )
{
{
Con_DPrintf("ioctl cdromplaytrkind failed\n");
return;
}
}

if ( ioctl(cdfile, CDROMRESUME) == -1 )
Con_DPrintf("ioctl cdromresume failed\n");
Expand Down Expand Up @@ -161,21 +243,42 @@ void CDAudio_Resume(void)

void CDAudio_Update(void)
{
#ifdef __linux__
struct cdrom_subchnl subchnl;
static time_t lastchk;
#elif defined(__unix__) && !defined(__CYGWIN__)
struct cd_sub_channel_info subchnl;
struct ioc_read_subchannel cdsc; // subchn.cdsc_format workaround - Brad
// Note: there doesn't seem to be a way to check how much time is left for playing
// cd audio without doing some extra manual work, so I'll be omitting it from
// the unix checks for the time being - Brad
#endif

if (playing && lastchk < time(NULL))
if (playing
#ifdef __linux__
&& lastchk < time(NULL)
#endif
)
{
#ifdef __linux__
lastchk = time(NULL) + 2; //two seconds between checks
subchnl.cdsc_format = CDROM_MSF;
#elif defined(__unix__) && !defined(__CYGWIN__)
cdsc.address_format = CDROM_MSF;
#endif
if (ioctl(cdfile, CDROMSUBCHNL, &subchnl) == -1 )
{
Con_DPrintf("ioctl cdromsubchnl failed\n");
playing = false;
return;
}
#ifdef __linux__
if (subchnl.cdsc_audiostatus != CDROM_AUDIO_PLAY &&
subchnl.cdsc_audiostatus != CDROM_AUDIO_PAUSED)
#elif defined(__unix__) && !defined(__CYGWIN__)
if (subchnl.header.audio_status != CDROM_AUDIO_PLAY &&
subchnl.header.audio_status != CDROM_AUDIO_PAUSED)
#endif
{
playing = false;
Media_EndedTrack();
Expand Down
Loading

0 comments on commit 2e51fb7

Please sign in to comment.