diff src/sid/xmms-sid.h @ 735:6c3c7b841382 trunk

[svn] - sync audacious-sid with latest xmms-sid, from Matti Hamalainen (ccr).

--- a/src/sid/xmms-sid.h	Tue Feb 27 01:27:06 2007 -0800
+++ b/src/sid/xmms-sid.h	Tue Feb 27 01:40:23 2007 -0800
@@ -4,7 +4,7 @@
    Main header file
 
    Programmed and designed by Matti 'ccr' Hamalainen <[e-mail]>
-   (C) Copyright 1999-2005 Tecnic Software productions (TNSP)
+   (C) Copyright 1999-2007 Tecnic Software productions (TNSP)
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -16,31 +16,41 @@
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
-   You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+   You should have received a copy of the GNU General Public License along
+   with this program; if not, write to the Free Software Foundation, Inc.,
+   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
-#ifndef _XMMS_SID_H
-#define _XMMS_SID_H
+#ifndef XMMS_SID_H
+#define XMMS_SID_H
 
-#ifdef HAVE_CONFIG_H
-#include <config.h>
-#endif
-
-#ifdef HAVE_ASSERT_H
-#include <assert.h>
-#else
-#define assert(x) /* stub */
-#endif
-
-#include <glib.h>
-#include <audacious/vfs.h>
+#include "xs_support.h"
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-#include "audacious/plugin.h"
+/*
+ * Standard gettext macros.
+ */
+#ifdef ENABLE_NLS
+#  include <libintl.h>
+#  undef _
+#  define _(String) dgettext (PACKAGE, String)
+#  ifdef gettext_noop
+#    define N_(String) gettext_noop (String)
+#  else
+#    define N_(String) (String)
+#  endif
+#else
+#  define textdomain(String) (String)
+#  define gettext(String) (String)
+#  define dgettext(Domain,Message) (Message)
+#  define dcgettext(Domain,Message,Type) (Message)
+#  define bindtextdomain(Domain,Directory) (Domain)
+#  define _(String) (String)
+#  define N_(String) (String)
+#endif
+
 
 /*
  * Some constants and defines
@@ -48,13 +58,19 @@
 /* #define to enable spurious debugging messages for development
  * purposes. Output goes to stderr. See also DEBUG_NP below.
  */
-#undef DEBUG
+#define DEBUG
 
 /* Define to ISO C99 macro for debugging instead of varargs function.
  * This provides more useful information, but is incompatible with
  * older standards. If #undef'd, a varargs function is used instead.
  */
-#undef DEBUG_NP
+#define DEBUG_NP
+
+/* Define to enable non-portable thread and mutex debugging code.
+ * You need to #define DEBUG also to make this useful.
+ * (Works probably with GNU/Linux pthreads implementation only)
+ */
+#undef XS_MUTEX_DEBUG
 
 /* HardSID-support is not working and is untested, thus we disable it here.
  */
@@ -68,6 +84,15 @@
  * but fails on systems with limited stack space. */
 #define XS_BUF_DYNAMIC
 
+/* Configuration section identifier
+ */
+#define XS_PACKAGE_STRING	"Audacious-SID v0.8.0beta18"
+#define XS_CONFIG_IDENT		"sid"		/* Configuration file identifier */
+
+/* Default audio rendering frequency in Hz
+ */
+#define XS_AUDIO_FREQ		(44100)
+
 /* Size of audio buffer. If you are experiencing lots of audio
  * "underruns" or clicks/gaps in output, try increasing this value.
  * Do notice, however, that it also affects the update frequency of
@@ -80,23 +105,39 @@
  * Largest SID files I've seen are ~70kB. */
 #define XS_SIDBUF_SIZE		(80*1024)
 
-
-/* libSIDPlay1 default filter values (copied from libsidplay1's headers) */
+/* libSIDPlay1/2 constants (copied from internal headers/source)
+ * For some stupid reason these are not available in public
+ * headers, so we have to duplicate them here...
+ */
 #define XS_SIDPLAY1_FS		(400.0f)
 #define XS_SIDPLAY1_FM		(60.0f)
 #define XS_SIDPLAY1_FT		(0.05f)
 
+#define XS_SIDPLAY2_NFPOINTS	(0x800)
+#define XS_SIDPLAY2_FMAX	(24000)
 
-#define XS_BIN_BAILOUT		(32)	/* Binary search bailout treshold */
-
-#define XS_STIL_MAXENTRY	(128)	/* Max number of sub-songs in STIL/SLDB node */
+/* Limits for oversampling
+ */
+#define XS_MIN_OVERSAMPLE	(2)
+#define XS_MAX_OVERSAMPLE	(8)
 
 
-#define XS_CONFIG_IDENT		"sid"		/* Configuration file identifier */
+/* Macros for mutexes and threads. These exist to be able to
+ * easily change from pthreads to glib threads, etc, if necessary.
+ */
+#define XS_THREAD_T		GThread *
+#define XS_THREAD_EXIT(M)	g_thread_exit(M)
+#define XS_THREAD_JOIN(M)	g_thread_join(M)
+#define XS_MPP(M)		M ## _mutex
+#define XS_MUTEX(M)		GStaticMutex	XS_MPP(M) = G_STATIC_MUTEX_INIT
+#define XS_MUTEX_H(M)		extern GStaticMutex XS_MPP(M)
+#define XS_MUTEX_LOCK(M)	g_static_mutex_lock(&XS_MPP(M))
+#define XS_MUTEX_UNLOCK(M)	g_static_mutex_unlock(&XS_MPP(M))
 
-#define XS_MIN_OVERSAMPLE	(2)		/* Minimum oversampling factor */
-#define XS_MAX_OVERSAMPLE	(8)		/* Maximum oversampling factor */
-
+/* Character set conversion helper macros
+ */
+#define XS_CS_SID(M)	g_convert(M, -1, "UTF-8", "ISO-8859-1", NULL, NULL, NULL)
+#define XS_CS_STIL(M)	g_convert(M, -1, "UTF-8", "ISO-8859-1", NULL, NULL, NULL)
 
 /* Shorthands for linked lists
  */
@@ -108,9 +149,9 @@
 /* Plugin-wide typedefs
  */
 typedef struct {
-	gint		tuneSpeed;
-	gint		tuneLength;
-	gchar		*tuneTitle;
+	gint		tuneSpeed,
+			tuneLength;
+	gboolean	tunePlayed;
 } t_xs_subtuneinfo;
 
 
@@ -118,56 +159,22 @@
 	gchar		*sidFilename,
 			*sidName,
 			*sidComposer,
-			*sidCopyright;
+			*sidCopyright,
+			*sidFormat;
 	gint		loadAddr,
 			initAddr,
 			playAddr,
-			dataFileLen;
+			dataFileLen,
+			sidModel;
 	gint		nsubTunes, startTune;
 	t_xs_subtuneinfo	*subTunes;
 } t_xs_tuneinfo;
 
 
-struct t_xs_status;
-
-typedef struct {
-	gint		plrIdent;
-	gboolean	(*plrIsOurFile)(gchar *);
-	gboolean	(*plrIsOurFileVfs)(gchar *,VFSFile *);
-	gboolean	(*plrInit)(struct t_xs_status *);
-	void		(*plrClose)(struct t_xs_status *);
-	gboolean	(*plrInitSong)(struct t_xs_status *);
-	guint		(*plrFillBuffer)(struct t_xs_status *, gchar *, guint);
-	gboolean	(*plrLoadSID)(struct t_xs_status *, gchar *);
-	void		(*plrDeleteSID)(struct t_xs_status *);
-	t_xs_tuneinfo*	(*plrGetSIDInfo)(gchar *);
-} t_xs_player;
-
-
-typedef struct t_xs_status {
-	gint		audioFrequency,		/* Audio settings */
-			audioChannels,
-			audioBitsPerSample,
-			oversampleFactor;	/* Factor of oversampling */
-	AFormat		audioFormat;
-	gboolean	oversampleEnable;	/* TRUE after sidEngine initialization,
-						if xs_cfg.oversampleEnable == TRUE and
-						emulation backend supports oversampling.
-						*/
-	void		*sidEngine;		/* SID-emulation internal engine data */
-	t_xs_player	*sidPlayer;		/* Selected player engine */
-	gboolean	isError, isPlaying;
-	gint		currSong,		/* Current sub-tune */
-			lastTime;
-	t_xs_tuneinfo	*tuneInfo;
-	gchar		*buffer;		/* Added by Audacious, to store file content got via VFS */
-} t_xs_status;
-
-
 /* Global variables
  */
 extern InputPlugin	xs_plugin_ip;
-extern t_xs_status	xs_status;
+
 
 /* Plugin function prototypes
  */
@@ -175,31 +182,40 @@
 void	xs_reinit(void);
 void	xs_close(void);
 gint	xs_is_our_file(gchar *);
-gint	xs_is_our_file_vfs(gchar *,VFSFile *);
+gint	xs_is_our_file_vfs(gchar *, t_xs_file *);
 void	xs_play_file(InputPlayback *);
 void	xs_stop(InputPlayback *);
 void	xs_pause(InputPlayback *, short);
-void	xs_seek(InputPlayback *,gint);
+void	xs_seek(InputPlayback *, gint);
 gint	xs_get_time(InputPlayback *);
 void	xs_get_song_info(gchar *, gchar **, gint *);
+TitleInput *xs_get_song_tuple(gchar *);
 void	xs_about(void);
 
-t_xs_tuneinfo *xs_tuneinfo_new(gchar *, gint, gint, gchar *, gchar *, gchar *, gint, gint, gint, gint);
+
+t_xs_tuneinfo *xs_tuneinfo_new(const gchar * pcFilename,
+		gint nsubTunes, gint startTune, const gchar * sidName,
+		const gchar * sidComposer, const gchar * sidCopyright,
+		gint loadAddr, gint initAddr, gint playAddr,
+		gint dataFileLen, const gchar *sidFormat, gint sidModel);
 void	xs_tuneinfo_free(t_xs_tuneinfo *);
 
-void	XSERR(const char *, ...);
+void	xs_error(const char *, ...);
+
 
+/* Debugging
+ */
 #ifndef DEBUG_NP
 void	XSDEBUG(const char *, ...);
 #else
-#ifdef DEBUG
-#define XSDEBUG(...) { fprintf(stderr, "XS[%s:%s:%d]: ", __FILE__, __FUNCTION__, (int) __LINE__); fprintf(stderr, __VA_ARGS__); }
-#else
-#define XSDEBUG(...) /* stub */
-#endif
+#  ifdef DEBUG
+#    define XSDEBUG(...) { fprintf(stderr, "XS[%s:%s:%d]: ", __FILE__, __FUNCTION__, (int) __LINE__); fprintf(stderr, __VA_ARGS__); }
+#  else
+#    define XSDEBUG(...) /* stub */
+#  endif
 #endif
 
 #ifdef __cplusplus
 }
 #endif
-#endif /* _XMMS_SID_H */
+#endif /* XMMS_SID_H */