Mercurial > hg > xmms-sid
annotate src/xmms-sid.h @ 392:b09d74eb71e6
Working on getting STIL and SLDB using completely dynamically allocated
structures. Indentation cleanups, etc.
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Wed, 31 May 2006 10:02:00 +0000 |
parents | b20300813b42 |
children | 7c4216c7aa47 |
rev | line source |
---|---|
1 | 1 /* |
3 | 2 XMMS-SID - SIDPlay input plugin for X MultiMedia System (XMMS) |
1 | 3 |
4 Main header file | |
5 | |
324 | 6 Programmed and designed by Matti 'ccr' Hamalainen <ccr@tnsp.org> |
7 (C) Copyright 1999-2005 Tecnic Software productions (TNSP) | |
1 | 8 |
9 This program is free software; you can redistribute it and/or modify | |
10 it under the terms of the GNU General Public License as published by | |
11 the Free Software Foundation; either version 2 of the License, or | |
12 (at your option) any later version. | |
13 | |
14 This program is distributed in the hope that it will be useful, | |
15 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 GNU General Public License for more details. | |
18 | |
19 You should have received a copy of the GNU General Public License | |
20 along with this program; if not, write to the Free Software | |
21 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. | |
22 */ | |
92
2607683bc9eb
Improvements in length- and title handling.
Matti Hamalainen <ccr@tnsp.org>
parents:
87
diff
changeset
|
23 #ifndef _XMMS_SID_H |
2607683bc9eb
Improvements in length- and title handling.
Matti Hamalainen <ccr@tnsp.org>
parents:
87
diff
changeset
|
24 #define _XMMS_SID_H |
1 | 25 |
92
2607683bc9eb
Improvements in length- and title handling.
Matti Hamalainen <ccr@tnsp.org>
parents:
87
diff
changeset
|
26 #ifdef HAVE_CONFIG_H |
24 | 27 #include <config.h> |
92
2607683bc9eb
Improvements in length- and title handling.
Matti Hamalainen <ccr@tnsp.org>
parents:
87
diff
changeset
|
28 #endif |
219 | 29 |
92
2607683bc9eb
Improvements in length- and title handling.
Matti Hamalainen <ccr@tnsp.org>
parents:
87
diff
changeset
|
30 #ifdef HAVE_ASSERT_H |
2607683bc9eb
Improvements in length- and title handling.
Matti Hamalainen <ccr@tnsp.org>
parents:
87
diff
changeset
|
31 #include <assert.h> |
2607683bc9eb
Improvements in length- and title handling.
Matti Hamalainen <ccr@tnsp.org>
parents:
87
diff
changeset
|
32 #else |
2607683bc9eb
Improvements in length- and title handling.
Matti Hamalainen <ccr@tnsp.org>
parents:
87
diff
changeset
|
33 #define assert(x) /* stub */ |
2607683bc9eb
Improvements in length- and title handling.
Matti Hamalainen <ccr@tnsp.org>
parents:
87
diff
changeset
|
34 #endif |
219 | 35 |
1 | 36 #include <glib.h> |
230 | 37 #include <pthread.h> |
1 | 38 |
230 | 39 #ifdef __cplusplus |
40 extern "C" { | |
41 #endif | |
42 | |
328 | 43 #include <xmms/plugin.h> |
44 | |
241
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
45 /* |
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
46 * Some constants and defines |
78
ab522ab65c85
Various fixes and improvements
Matti Hamalainen <ccr@tnsp.org>
parents:
73
diff
changeset
|
47 */ |
365
5a92a2aee74c
Better comments and .. you guessed it: more indentation fixes. :)
Matti Hamalainen <ccr@tnsp.org>
parents:
355
diff
changeset
|
48 /* #define to enable spurious debugging messages for development |
5a92a2aee74c
Better comments and .. you guessed it: more indentation fixes. :)
Matti Hamalainen <ccr@tnsp.org>
parents:
355
diff
changeset
|
49 * purposes. Output goes to stderr. See also DEBUG_NP below. |
5a92a2aee74c
Better comments and .. you guessed it: more indentation fixes. :)
Matti Hamalainen <ccr@tnsp.org>
parents:
355
diff
changeset
|
50 */ |
300 | 51 #define DEBUG |
52 | |
53 /* Define to ISO C99 macro for debugging instead of varargs function. | |
365
5a92a2aee74c
Better comments and .. you guessed it: more indentation fixes. :)
Matti Hamalainen <ccr@tnsp.org>
parents:
355
diff
changeset
|
54 * This provides more useful information, but is incompatible with |
5a92a2aee74c
Better comments and .. you guessed it: more indentation fixes. :)
Matti Hamalainen <ccr@tnsp.org>
parents:
355
diff
changeset
|
55 * older standards. If #undef'd, a varargs function is used instead. |
300 | 56 */ |
308
ae5795ba5c77
Remove "only when song-length unknown" option from minimum playtime, it
Matti Hamalainen <ccr@tnsp.org>
parents:
300
diff
changeset
|
57 #define DEBUG_NP |
230 | 58 |
272 | 59 /* Define to enable non-portable thread and mutex debugging code. |
300 | 60 * You need to #define DEBUG also to make this useful. |
61 * (Works probably with GNU/Linux pthreads implementation only) | |
272 | 62 */ |
241
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
63 #undef XS_MUTEX_DEBUG |
72
e3b205a6bc7e
Lots re-arranging and new code for upcoming modularization.
Matti Hamalainen <ccr@tnsp.org>
parents:
65
diff
changeset
|
64 |
272 | 65 /* HardSID-support is not working and is untested, thus we disable it here. |
66 */ | |
241
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
67 #undef HAVE_HARDSID_BUILDER |
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
68 |
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
69 /* Size for some small buffers (always static variables) */ |
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
70 #define XS_BUF_SIZE (1024) |
1 | 71 |
355
26079ab52fc3
Comment about XS_DYNAMIC_BUF changed
Matti Hamalainen <ccr@tnsp.org>
parents:
334
diff
changeset
|
72 /* If defined, some dynamically allocated temp. buffers are used. |
26079ab52fc3
Comment about XS_DYNAMIC_BUF changed
Matti Hamalainen <ccr@tnsp.org>
parents:
334
diff
changeset
|
73 * Static (#undef) might give slight performance gain, |
26079ab52fc3
Comment about XS_DYNAMIC_BUF changed
Matti Hamalainen <ccr@tnsp.org>
parents:
334
diff
changeset
|
74 * but fails on systems with limited stack space. */ |
241
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
75 #define XS_BUF_DYNAMIC |
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
76 |
242 | 77 /* Size of audio buffer. If you are experiencing lots of audio |
78 * "underruns" or clicks/gaps in output, try increasing this value. | |
79 * Do notice, however, that it also affects the update frequency of | |
80 * XMMS's visualization plugins... | |
81 */ | |
82 #define XS_AUDIOBUF_SIZE (2*1024) | |
230 | 83 |
241
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
84 /* Size of data buffer used for SID-tune MD5 hash calculation. |
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
85 * If this is too small, the computed hash will be incorrect. |
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
86 * Largest SID files I've seen are ~70kB. */ |
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
87 #define XS_SIDBUF_SIZE (80*1024) |
230 | 88 |
241
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
89 |
376
b20300813b42
Moved some #defines from xs_config.c to xmms-sid.h; Changed default SID
Matti Hamalainen <ccr@tnsp.org>
parents:
369
diff
changeset
|
90 /* libSIDPlay1 default filter values (copied from libsidplay1's headers) */ |
b20300813b42
Moved some #defines from xs_config.c to xmms-sid.h; Changed default SID
Matti Hamalainen <ccr@tnsp.org>
parents:
369
diff
changeset
|
91 #define XS_SIDPLAY1_FS (400.0f) |
b20300813b42
Moved some #defines from xs_config.c to xmms-sid.h; Changed default SID
Matti Hamalainen <ccr@tnsp.org>
parents:
369
diff
changeset
|
92 #define XS_SIDPLAY1_FM (60.0f) |
b20300813b42
Moved some #defines from xs_config.c to xmms-sid.h; Changed default SID
Matti Hamalainen <ccr@tnsp.org>
parents:
369
diff
changeset
|
93 #define XS_SIDPLAY1_FT (0.05f) |
b20300813b42
Moved some #defines from xs_config.c to xmms-sid.h; Changed default SID
Matti Hamalainen <ccr@tnsp.org>
parents:
369
diff
changeset
|
94 |
b20300813b42
Moved some #defines from xs_config.c to xmms-sid.h; Changed default SID
Matti Hamalainen <ccr@tnsp.org>
parents:
369
diff
changeset
|
95 |
369
4611f1194941
Make binary search bailout value a #define in xmms-sid.h
Matti Hamalainen <ccr@tnsp.org>
parents:
365
diff
changeset
|
96 #define XS_BIN_BAILOUT (32) /* Binary search bailout treshold */ |
241
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
97 |
230 | 98 |
50
dae6d3c2268d
Minor fixes, updated to support default XMMS configfile
Matti Hamalainen <ccr@tnsp.org>
parents:
40
diff
changeset
|
99 #define XS_CONFIG_IDENT "XMMS-SID" /* Configuration file identifier */ |
62
0d1df20745dd
Started to rewrite STIL-support
Matti Hamalainen <ccr@tnsp.org>
parents:
50
diff
changeset
|
100 #define XS_CONFIG_FILE "/.xmms/xmms-sid" /* Use this configfile if autocyrpe fails */ |
0d1df20745dd
Started to rewrite STIL-support
Matti Hamalainen <ccr@tnsp.org>
parents:
50
diff
changeset
|
101 |
0d1df20745dd
Started to rewrite STIL-support
Matti Hamalainen <ccr@tnsp.org>
parents:
50
diff
changeset
|
102 #define XS_MIN_OVERSAMPLE (2) /* Minimum oversampling factor */ |
0d1df20745dd
Started to rewrite STIL-support
Matti Hamalainen <ccr@tnsp.org>
parents:
50
diff
changeset
|
103 #define XS_MAX_OVERSAMPLE (8) /* Maximum oversampling factor */ |
1 | 104 |
230 | 105 |
106 /* Macros for mutexes and threads. These exist to be able to | |
107 * easily change from pthreads to glib threads, etc, if necessary. | |
108 */ | |
109 #define XS_MPP(M) M ## _mutex | |
241
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
110 #if XS_MUTEX_DEBUG |
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
111 #define XS_MUTEX(M) pthread_mutex_t XS_MPP(M) = PTHREAD_ERRORCHECK_MUTEX_INITIALIZER_NP; int M ## _qq; |
293
3fa910269508
Remove extra semicolon from macro definition, #undef DEBUG
Matti Hamalainen <ccr@tnsp.org>
parents:
278
diff
changeset
|
112 #define XS_MUTEX_H(M) extern pthread_mutex_t XS_MPP(M); extern int M ## _qq |
230 | 113 #define XS_MUTEX_LOCK(M) { M ## _qq = pthread_mutex_lock(&XS_MPP(M)); if (M ## _qq) XSDEBUG("XS_MUTEX_LOCK(" #M ") == %i\n", M ## _qq); } |
114 #define XS_MUTEX_UNLOCK(M) { M ## _qq = pthread_mutex_unlock(&XS_MPP(M)); if (M ## _qq) XSDEBUG("XS_MUTEX_UNLOCK(" #M ") == %i\n", M ## _qq); } | |
241
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
115 #else |
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
116 #define XS_MUTEX(M) pthread_mutex_t XS_MPP(M) = PTHREAD_MUTEX_INITIALIZER |
293
3fa910269508
Remove extra semicolon from macro definition, #undef DEBUG
Matti Hamalainen <ccr@tnsp.org>
parents:
278
diff
changeset
|
117 #define XS_MUTEX_H(M) extern pthread_mutex_t XS_MPP(M) |
241
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
118 #define XS_MUTEX_LOCK(M) pthread_mutex_lock(&XS_MPP(M)) |
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
119 #define XS_MUTEX_UNLOCK(M) pthread_mutex_unlock(&XS_MPP(M)) |
291715a519e2
Compile-time setting to enable/disable use of dynamically allocated buffers.
Matti Hamalainen <ccr@tnsp.org>
parents:
235
diff
changeset
|
120 #endif |
230 | 121 |
122 /* Shorthands for linked lists | |
123 */ | |
124 #define LPREV (pNode->pPrev) | |
125 #define LTHIS (pNode) | |
126 #define LNEXT (pNode->pNext) | |
62
0d1df20745dd
Started to rewrite STIL-support
Matti Hamalainen <ccr@tnsp.org>
parents:
50
diff
changeset
|
127 |
72
e3b205a6bc7e
Lots re-arranging and new code for upcoming modularization.
Matti Hamalainen <ccr@tnsp.org>
parents:
65
diff
changeset
|
128 |
230 | 129 /* Plugin-wide typedefs |
130 */ | |
72
e3b205a6bc7e
Lots re-arranging and new code for upcoming modularization.
Matti Hamalainen <ccr@tnsp.org>
parents:
65
diff
changeset
|
131 typedef struct { |
78
ab522ab65c85
Various fixes and improvements
Matti Hamalainen <ccr@tnsp.org>
parents:
73
diff
changeset
|
132 gint tuneSpeed; |
ab522ab65c85
Various fixes and improvements
Matti Hamalainen <ccr@tnsp.org>
parents:
73
diff
changeset
|
133 gint tuneLength; |
87
94497283affa
Various fixes and improvements
Matti Hamalainen <ccr@tnsp.org>
parents:
78
diff
changeset
|
134 gchar *tuneTitle; |
392
b09d74eb71e6
Working on getting STIL and SLDB using completely dynamically allocated
Matti Hamalainen <ccr@tnsp.org>
parents:
376
diff
changeset
|
135 gboolean tunePlayed; |
230 | 136 } t_xs_subtuneinfo; |
78
ab522ab65c85
Various fixes and improvements
Matti Hamalainen <ccr@tnsp.org>
parents:
73
diff
changeset
|
137 |
ab522ab65c85
Various fixes and improvements
Matti Hamalainen <ccr@tnsp.org>
parents:
73
diff
changeset
|
138 |
ab522ab65c85
Various fixes and improvements
Matti Hamalainen <ccr@tnsp.org>
parents:
73
diff
changeset
|
139 typedef struct { |
230 | 140 gchar *sidFilename, |
141 *sidName, | |
142 *sidComposer, | |
143 *sidCopyright; | |
144 gint loadAddr, | |
145 initAddr, | |
146 playAddr, | |
147 dataFileLen; | |
148 gint nsubTunes, startTune; | |
334 | 149 t_xs_subtuneinfo *subTunes; |
230 | 150 } t_xs_tuneinfo; |
151 | |
152 | |
153 struct t_xs_status; | |
154 | |
155 typedef struct { | |
156 gint plrIdent; | |
157 gboolean (*plrIsOurFile)(gchar *); | |
158 gboolean (*plrInit)(struct t_xs_status *); | |
159 void (*plrClose)(struct t_xs_status *); | |
160 gboolean (*plrInitSong)(struct t_xs_status *); | |
161 guint (*plrFillBuffer)(struct t_xs_status *, gchar *, guint); | |
162 gboolean (*plrLoadSID)(struct t_xs_status *, gchar *); | |
163 void (*plrDeleteSID)(struct t_xs_status *); | |
164 t_xs_tuneinfo* (*plrGetSIDInfo)(gchar *); | |
165 } t_xs_player; | |
166 | |
167 | |
168 typedef struct t_xs_status { | |
169 gint audioFrequency, /* Audio settings */ | |
127
ddb513bd2610
Improved audio format support, now supported formats are "queried" from
Matti Hamalainen <ccr@tnsp.org>
parents:
119
diff
changeset
|
170 audioChannels, |
269 | 171 audioBitsPerSample, |
172 oversampleFactor; /* Factor of oversampling */ | |
295 | 173 AFormat audioFormat; |
269 | 174 gboolean oversampleEnable; /* TRUE after sidEngine initialization, |
175 if xs_cfg.oversampleEnable == TRUE and | |
176 emulation backend supports oversampling. | |
177 */ | |
230 | 178 void *sidEngine; /* SID-emulation internal engine data */ |
179 t_xs_player *sidPlayer; /* Selected player engine */ | |
87
94497283affa
Various fixes and improvements
Matti Hamalainen <ccr@tnsp.org>
parents:
78
diff
changeset
|
180 gboolean isError, isPlaying; |
230 | 181 gint currSong, /* Current sub-tune */ |
132
4162a5370b9e
Added "seek"-subsong control option, in style of xmms-sidplay.
Matti Hamalainen <ccr@tnsp.org>
parents:
127
diff
changeset
|
182 lastTime; |
230 | 183 t_xs_tuneinfo *tuneInfo; |
72
e3b205a6bc7e
Lots re-arranging and new code for upcoming modularization.
Matti Hamalainen <ccr@tnsp.org>
parents:
65
diff
changeset
|
184 } t_xs_status; |
e3b205a6bc7e
Lots re-arranging and new code for upcoming modularization.
Matti Hamalainen <ccr@tnsp.org>
parents:
65
diff
changeset
|
185 |
87
94497283affa
Various fixes and improvements
Matti Hamalainen <ccr@tnsp.org>
parents:
78
diff
changeset
|
186 |
230 | 187 /* Global variables |
188 */ | |
189 extern InputPlugin xs_plugin_ip; | |
190 | |
191 extern t_xs_status xs_status; | |
192 XS_MUTEX_H(xs_status); | |
1 | 193 |
194 | |
230 | 195 |
196 /* Plugin function prototypes | |
1 | 197 */ |
198 void xs_init(void); | |
147
a7abcda7a86c
SLDB, STIL and emulation engine settings are now updated
Matti Hamalainen <ccr@tnsp.org>
parents:
138
diff
changeset
|
199 void xs_reinit(void); |
3 | 200 void xs_close(void); |
65
bf7b647b3239
The fabled 0.8-rewrite now works to some extent
Matti Hamalainen <ccr@tnsp.org>
parents:
62
diff
changeset
|
201 gint xs_is_our_file(gchar *); |
bf7b647b3239
The fabled 0.8-rewrite now works to some extent
Matti Hamalainen <ccr@tnsp.org>
parents:
62
diff
changeset
|
202 void xs_play_file(gchar *); |
1 | 203 void xs_stop(void); |
204 void xs_pause(short); | |
65
bf7b647b3239
The fabled 0.8-rewrite now works to some extent
Matti Hamalainen <ccr@tnsp.org>
parents:
62
diff
changeset
|
205 void xs_seek(gint); |
bf7b647b3239
The fabled 0.8-rewrite now works to some extent
Matti Hamalainen <ccr@tnsp.org>
parents:
62
diff
changeset
|
206 gint xs_get_time(void); |
bf7b647b3239
The fabled 0.8-rewrite now works to some extent
Matti Hamalainen <ccr@tnsp.org>
parents:
62
diff
changeset
|
207 void xs_get_song_info(gchar *, gchar **, gint *); |
40
1788f4ce6a44
Numerous changes towards 0.8
Matti Hamalainen <ccr@tnsp.org>
parents:
24
diff
changeset
|
208 void xs_about(void); |
1 | 209 |
230 | 210 t_xs_tuneinfo *xs_tuneinfo_new(gchar *, gint, gint, gchar *, gchar *, gchar *, gint, gint, gint, gint); |
211 void xs_tuneinfo_free(t_xs_tuneinfo *); | |
87
94497283affa
Various fixes and improvements
Matti Hamalainen <ccr@tnsp.org>
parents:
78
diff
changeset
|
212 |
300 | 213 void XSERR(const char *, ...); |
1 | 214 |
300 | 215 #ifndef DEBUG_NP |
216 void XSDEBUG(const char *, ...); | |
217 #else | |
1 | 218 #ifdef DEBUG |
297 | 219 #define XSDEBUG(...) { fprintf(stderr, "XS[%s:%s:%d]: ", __FILE__, __FUNCTION__, (int) __LINE__); fprintf(stderr, __VA_ARGS__); } |
1 | 220 #else |
300 | 221 #define XSDEBUG(...) /* stub */ |
1 | 222 #endif |
300 | 223 #endif |
1 | 224 |
225 #ifdef __cplusplus | |
226 } | |
227 #endif | |
92
2607683bc9eb
Improvements in length- and title handling.
Matti Hamalainen <ccr@tnsp.org>
parents:
87
diff
changeset
|
228 #endif /* _XMMS_SID_H */ |