Mercurial > audlegacy
annotate src/audacious/plugin.h @ 2794:2685fc11cd9a trunk
[svn] - begin work on the host side of plugin API v2.
author | nenolod |
---|---|
date | Thu, 24 May 2007 01:47:50 -0700 |
parents | 637359219e10 |
children | e9af66a1be74 |
rev | line source |
---|---|
2313 | 1 /* Audacious |
2 * Copyright (C) 2005-2007 Audacious team. | |
3 * | |
4 * BMP - Cross-platform multimedia player | |
5 * Copyright (C) 2003-2004 BMP development team. | |
6 * | |
7 * Based on XMMS: | |
8 * Copyright (C) 1998-2000 Peter Alm, Mikael Alm, Olle Hallnas, Thomas Nilsson and 4Front Technologies | |
9 * | |
10 * Redistribution and use in source and binary forms, with or without | |
11 * modification, are permitted provided that the following conditions are | |
12 * met: | |
13 * | |
14 * 1. Redistributions of source code must retain the above copyright | |
15 * notice, this list of conditions and the following disclaimer. | |
16 * | |
17 * 2. Redistributions in binary form must reproduce the above copyright | |
18 * notice, this list of conditions and the following disclaimer in | |
19 * the documentation and/or other materials provided with the | |
20 * distribution. | |
21 * | |
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY | |
23 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | |
24 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | |
25 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR | |
26 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | |
28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | |
29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
32 * SUCH DAMAGE. | |
33 */ | |
34 | |
35 /* Please see the BMP Wiki for information about the plugin interface */ | |
36 | |
37 #ifndef BMP_PLUGIN_H | |
38 #define BMP_PLUGIN_H | |
39 | |
40 | |
41 #include <glib.h> | |
42 #include "audacious/vfs.h" | |
43 #include "audacious/titlestring.h" | |
44 | |
45 #define INPUT_PLUGIN(x) ((InputPlugin *)(x)) | |
46 #define OUTPUT_PLUGIN(x) ((OutputPlugin *)(x)) | |
47 #define EFFECT_PLUGIN(x) ((EffectPlugin *)(x)) | |
48 #define GENERAL_PLUGIN(x) ((GeneralPlugin *)(x)) | |
49 #define VIS_PLUGIN(x) ((VisPlugin *)(x)) | |
50 | |
51 #define LOWLEVEL_PLUGIN(x) ((LowlevelPlugin *)(x)) | |
52 | |
53 #define __AUDACIOUS_NEWVFS__ | |
2794
2685fc11cd9a
[svn] - begin work on the host side of plugin API v2.
nenolod
parents:
2763
diff
changeset
|
54 #define __AUDACIOUS_PLUGIN_API__ 2 |
2685fc11cd9a
[svn] - begin work on the host side of plugin API v2.
nenolod
parents:
2763
diff
changeset
|
55 #define __AUDACIOUS_INPUT_PLUGIN_API__ 3 |
2313 | 56 |
57 typedef enum { | |
58 FMT_U8, | |
59 FMT_S8, | |
60 FMT_U16_LE, | |
61 FMT_U16_BE, | |
62 FMT_U16_NE, | |
63 FMT_S16_LE, | |
64 FMT_S16_BE, | |
65 FMT_S16_NE | |
66 } AFormat; | |
67 | |
68 typedef enum { | |
69 INPUT_VIS_ANALYZER, | |
70 INPUT_VIS_SCOPE, | |
71 INPUT_VIS_VU, | |
72 INPUT_VIS_OFF | |
73 } InputVisType; | |
74 | |
75 | |
76 typedef struct _Plugin Plugin; | |
77 typedef struct _InputPlugin InputPlugin; | |
78 typedef struct _OutputPlugin OutputPlugin; | |
79 typedef struct _EffectPlugin EffectPlugin; | |
80 typedef struct _GeneralPlugin GeneralPlugin; | |
81 typedef struct _VisPlugin VisPlugin; | |
82 | |
83 typedef struct _LowlevelPlugin LowlevelPlugin; | |
84 | |
2436
f346d30bf5ab
[svn] Change the input plugin API to use a struct for the currently-playing file.
iabervon
parents:
2313
diff
changeset
|
85 typedef struct _InputPlayback InputPlayback; |
f346d30bf5ab
[svn] Change the input plugin API to use a struct for the currently-playing file.
iabervon
parents:
2313
diff
changeset
|
86 |
2313 | 87 /* Sadly, this is the most we can generalize out of the disparate |
88 plugin structs usable with typecasts - descender */ | |
89 struct _Plugin { | |
90 gpointer handle; | |
91 gchar *filename; | |
2794
2685fc11cd9a
[svn] - begin work on the host side of plugin API v2.
nenolod
parents:
2763
diff
changeset
|
92 gchar *description; |
2313 | 93 }; |
94 | |
95 /* | |
96 * LowlevelPlugin is used for lowlevel system services, such as PlaylistContainers, | |
97 * VFSContainers and the like. | |
98 * | |
99 * They are not GUI visible at this time. | |
100 */ | |
101 struct _LowlevelPlugin { | |
102 gpointer handle; | |
103 gchar *filename; | |
104 | |
105 gchar *description; | |
106 | |
107 void (*init) (void); | |
108 void (*cleanup) (void); | |
109 }; | |
110 | |
111 struct _OutputPlugin { | |
112 gpointer handle; | |
113 gchar *filename; | |
114 | |
115 gchar *description; | |
116 | |
117 void (*init) (void); | |
118 void (*cleanup) (void); | |
119 void (*about) (void); | |
120 void (*configure) (void); | |
121 void (*get_volume) (gint * l, gint * r); | |
122 void (*set_volume) (gint l, gint r); | |
123 | |
124 gint (*open_audio) (AFormat fmt, gint rate, gint nch); | |
125 void (*write_audio) (gpointer ptr, gint length); | |
126 void (*close_audio) (void); | |
127 | |
128 void (*flush) (gint time); | |
129 void (*pause) (gshort paused); | |
130 gint (*buffer_free) (void); | |
131 gint (*buffer_playing) (void); | |
132 gint (*output_time) (void); | |
133 gint (*written_time) (void); | |
134 | |
135 void (*tell_audio) (AFormat * fmt, gint * rate, gint * nch); | |
136 }; | |
137 | |
138 struct _EffectPlugin { | |
139 gpointer handle; | |
140 gchar *filename; | |
141 | |
142 gchar *description; | |
143 | |
144 void (*init) (void); | |
145 void (*cleanup) (void); | |
146 void (*about) (void); | |
147 void (*configure) (void); | |
148 | |
149 gint (*mod_samples) (gpointer * data, gint length, AFormat fmt, gint srate, gint nch); | |
150 void (*query_format) (AFormat * fmt, gint * rate, gint * nch); | |
151 }; | |
152 | |
2436
f346d30bf5ab
[svn] Change the input plugin API to use a struct for the currently-playing file.
iabervon
parents:
2313
diff
changeset
|
153 struct _InputPlayback { |
f346d30bf5ab
[svn] Change the input plugin API to use a struct for the currently-playing file.
iabervon
parents:
2313
diff
changeset
|
154 gchar *filename; |
f346d30bf5ab
[svn] Change the input plugin API to use a struct for the currently-playing file.
iabervon
parents:
2313
diff
changeset
|
155 InputPlugin *plugin; |
f346d30bf5ab
[svn] Change the input plugin API to use a struct for the currently-playing file.
iabervon
parents:
2313
diff
changeset
|
156 void *data; |
f346d30bf5ab
[svn] Change the input plugin API to use a struct for the currently-playing file.
iabervon
parents:
2313
diff
changeset
|
157 OutputPlugin *output; |
2438
8750a62abed8
[svn] Provide flags in InputPlayback for common plugin flag needs, and provide a
iabervon
parents:
2437
diff
changeset
|
158 |
8750a62abed8
[svn] Provide flags in InputPlayback for common plugin flag needs, and provide a
iabervon
parents:
2437
diff
changeset
|
159 int playing; |
8750a62abed8
[svn] Provide flags in InputPlayback for common plugin flag needs, and provide a
iabervon
parents:
2437
diff
changeset
|
160 gboolean error; |
8750a62abed8
[svn] Provide flags in InputPlayback for common plugin flag needs, and provide a
iabervon
parents:
2437
diff
changeset
|
161 gboolean eof; |
2436
f346d30bf5ab
[svn] Change the input plugin API to use a struct for the currently-playing file.
iabervon
parents:
2313
diff
changeset
|
162 }; |
f346d30bf5ab
[svn] Change the input plugin API to use a struct for the currently-playing file.
iabervon
parents:
2313
diff
changeset
|
163 |
2313 | 164 struct _InputPlugin { |
165 gpointer handle; | |
166 gchar *filename; | |
167 | |
168 gchar *description; | |
169 | |
170 void (*init) (void); | |
171 void (*about) (void); | |
172 void (*configure) (void); | |
173 | |
174 gint (*is_our_file) (gchar * filename); | |
175 GList *(*scan_dir) (gchar * dirname); | |
176 | |
2436
f346d30bf5ab
[svn] Change the input plugin API to use a struct for the currently-playing file.
iabervon
parents:
2313
diff
changeset
|
177 void (*play_file) (InputPlayback * playback); |
f346d30bf5ab
[svn] Change the input plugin API to use a struct for the currently-playing file.
iabervon
parents:
2313
diff
changeset
|
178 void (*stop) (InputPlayback * playback); |
f346d30bf5ab
[svn] Change the input plugin API to use a struct for the currently-playing file.
iabervon
parents:
2313
diff
changeset
|
179 void (*pause) (InputPlayback * playback, gshort paused); |
f346d30bf5ab
[svn] Change the input plugin API to use a struct for the currently-playing file.
iabervon
parents:
2313
diff
changeset
|
180 void (*seek) (InputPlayback * playback, gint time); |
2313 | 181 |
182 void (*set_eq) (gint on, gfloat preamp, gfloat * bands); | |
183 | |
2436
f346d30bf5ab
[svn] Change the input plugin API to use a struct for the currently-playing file.
iabervon
parents:
2313
diff
changeset
|
184 gint (*get_time) (InputPlayback * playback); |
2313 | 185 |
2437 | 186 gint (*get_volume) (gint * l, gint * r); |
187 gint (*set_volume) (gint l, gint r); | |
2313 | 188 |
189 void (*cleanup) (void); | |
190 | |
191 InputVisType (*get_vis_type) (void); | |
192 void (*add_vis_pcm) (gint time, AFormat fmt, gint nch, gint length, gpointer ptr); | |
193 | |
194 void (*set_info) (gchar * title, gint length, gint rate, gint freq, gint nch); | |
195 void (*set_info_text) (gchar * text); | |
196 void (*get_song_info) (gchar * filename, gchar ** title, gint * length); | |
197 void (*file_info_box) (gchar * filename); | |
198 | |
2437 | 199 OutputPlugin *output; /* deprecated */ |
2313 | 200 |
201 /* Added in Audacious 1.1.0 */ | |
202 TitleInput *(*get_song_tuple) (gchar * filename); | |
203 void (*set_song_tuple) (TitleInput * tuple); | |
204 void (*set_status_buffering) (gboolean status); | |
205 | |
206 /* Added in Audacious 1.3.0 */ | |
207 gint (*is_our_file_from_vfs) (gchar *filename, VFSFile *fd); | |
208 gchar **vfs_extensions; | |
2620
6393862824e5
[svn] - add millisecond seek function to InputPlugin API. with this function, cuesheet and encoder plugins can achieve higher accuracy.
yaz
parents:
2473
diff
changeset
|
209 |
6393862824e5
[svn] - add millisecond seek function to InputPlugin API. with this function, cuesheet and encoder plugins can achieve higher accuracy.
yaz
parents:
2473
diff
changeset
|
210 /* Added in Audacious 1.4.0 */ |
6393862824e5
[svn] - add millisecond seek function to InputPlugin API. with this function, cuesheet and encoder plugins can achieve higher accuracy.
yaz
parents:
2473
diff
changeset
|
211 void (*mseek) (InputPlayback * playback, gulong millisecond); |
2313 | 212 }; |
213 | |
214 struct _GeneralPlugin { | |
215 gpointer handle; | |
216 gchar *filename; | |
217 | |
218 gchar *description; | |
219 | |
220 void (*init) (void); | |
221 void (*about) (void); | |
222 void (*configure) (void); | |
223 void (*cleanup) (void); | |
224 }; | |
225 | |
226 struct _VisPlugin { | |
227 gpointer handle; | |
228 gchar *filename; | |
229 | |
230 gchar *description; | |
231 | |
232 gint num_pcm_chs_wanted; | |
233 gint num_freq_chs_wanted; | |
234 | |
235 void (*init) (void); | |
236 void (*cleanup) (void); | |
237 void (*about) (void); | |
238 void (*configure) (void); | |
239 void (*disable_plugin) (struct _VisPlugin *); | |
240 void (*playback_start) (void); | |
241 void (*playback_stop) (void); | |
242 void (*render_pcm) (gint16 pcm_data[2][512]); | |
243 void (*render_freq) (gint16 freq_data[2][256]); | |
244 }; | |
245 | |
246 | |
247 G_BEGIN_DECLS | |
248 | |
249 /* So that input plugins can get the title formatting information */ | |
250 G_CONST_RETURN gchar * xmms_get_gentitle_format(void); | |
251 | |
252 /* So that output plugins can communicate with effect plugins */ | |
253 EffectPlugin *get_current_effect_plugin(void); | |
254 gboolean effects_enabled(void); | |
255 gboolean plugin_set_errortext(const gchar * text); | |
256 | |
257 G_END_DECLS | |
258 | |
259 #endif |