Mercurial > audlegacy
annotate audacious/plugin.h @ 2144:b76039eeb6f0 trunk
[svn] - added auto-enqueue option for search-in-playlist
author | giacomo |
---|---|
date | Sat, 16 Dec 2006 10:44:25 -0800 |
parents | 82a6284108c1 |
children | e0e50e151bab |
rev | line source |
---|---|
2107
8d2b17ee266e
[svn] - add gchar **vfs_extensions to InputPlugin struct, adding support for
nenolod
parents:
1951
diff
changeset
|
1 /* Audacious |
8d2b17ee266e
[svn] - add gchar **vfs_extensions to InputPlugin struct, adding support for
nenolod
parents:
1951
diff
changeset
|
2 * Copyright (C) 2005-2007 Audacious team. |
8d2b17ee266e
[svn] - add gchar **vfs_extensions to InputPlugin struct, adding support for
nenolod
parents:
1951
diff
changeset
|
3 * |
8d2b17ee266e
[svn] - add gchar **vfs_extensions to InputPlugin struct, adding support for
nenolod
parents:
1951
diff
changeset
|
4 * BMP - Cross-platform multimedia player |
0 | 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 | |
2107
8d2b17ee266e
[svn] - add gchar **vfs_extensions to InputPlugin struct, adding support for
nenolod
parents:
1951
diff
changeset
|
12 * met: |
8d2b17ee266e
[svn] - add gchar **vfs_extensions to InputPlugin struct, adding support for
nenolod
parents:
1951
diff
changeset
|
13 * |
8d2b17ee266e
[svn] - add gchar **vfs_extensions to InputPlugin struct, adding support for
nenolod
parents:
1951
diff
changeset
|
14 * 1. Redistributions of source code must retain the above copyright |
8d2b17ee266e
[svn] - add gchar **vfs_extensions to InputPlugin struct, adding support for
nenolod
parents:
1951
diff
changeset
|
15 * notice, this list of conditions and the following disclaimer. |
8d2b17ee266e
[svn] - add gchar **vfs_extensions to InputPlugin struct, adding support for
nenolod
parents:
1951
diff
changeset
|
16 * |
8d2b17ee266e
[svn] - add gchar **vfs_extensions to InputPlugin struct, adding support for
nenolod
parents:
1951
diff
changeset
|
17 * 2. Redistributions in binary form must reproduce the above copyright |
8d2b17ee266e
[svn] - add gchar **vfs_extensions to InputPlugin struct, adding support for
nenolod
parents:
1951
diff
changeset
|
18 * notice, this list of conditions and the following disclaimer in |
8d2b17ee266e
[svn] - add gchar **vfs_extensions to InputPlugin struct, adding support for
nenolod
parents:
1951
diff
changeset
|
19 * the documentation and/or other materials provided with the |
8d2b17ee266e
[svn] - add gchar **vfs_extensions to InputPlugin struct, adding support for
nenolod
parents:
1951
diff
changeset
|
20 * distribution. |
0 | 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> | |
1951
c2a63f41d8c6
[svn] - NewVFS input probing layer. VFS-Aware plugins can automatically take
nenolod
parents:
1563
diff
changeset
|
42 #ifdef _AUDACIOUS_CORE |
c2a63f41d8c6
[svn] - NewVFS input probing layer. VFS-Aware plugins can automatically take
nenolod
parents:
1563
diff
changeset
|
43 # include "libaudacious/vfs.h" |
c2a63f41d8c6
[svn] - NewVFS input probing layer. VFS-Aware plugins can automatically take
nenolod
parents:
1563
diff
changeset
|
44 #else |
c2a63f41d8c6
[svn] - NewVFS input probing layer. VFS-Aware plugins can automatically take
nenolod
parents:
1563
diff
changeset
|
45 # include "audacious/vfs.h" |
c2a63f41d8c6
[svn] - NewVFS input probing layer. VFS-Aware plugins can automatically take
nenolod
parents:
1563
diff
changeset
|
46 #endif |
1248
6d9c45d157f9
[svn] - this is a hack until I find a better solution
nenolod
parents:
1231
diff
changeset
|
47 #include "audacious/titlestring.h" |
0 | 48 |
49 #define INPUT_PLUGIN(x) ((InputPlugin *)(x)) | |
50 #define OUTPUT_PLUGIN(x) ((OutputPlugin *)(x)) | |
51 #define EFFECT_PLUGIN(x) ((EffectPlugin *)(x)) | |
52 #define GENERAL_PLUGIN(x) ((GeneralPlugin *)(x)) | |
53 #define VIS_PLUGIN(x) ((VisPlugin *)(x)) | |
54 | |
1563 | 55 #define LOWLEVEL_PLUGIN(x) ((LowlevelPlugin *)(x)) |
56 | |
1951
c2a63f41d8c6
[svn] - NewVFS input probing layer. VFS-Aware plugins can automatically take
nenolod
parents:
1563
diff
changeset
|
57 #define __AUDACIOUS_NEWVFS__ |
0 | 58 |
59 typedef enum { | |
60 FMT_U8, | |
61 FMT_S8, | |
62 FMT_U16_LE, | |
63 FMT_U16_BE, | |
64 FMT_U16_NE, | |
65 FMT_S16_LE, | |
66 FMT_S16_BE, | |
67 FMT_S16_NE | |
68 } AFormat; | |
69 | |
70 typedef enum { | |
71 INPUT_VIS_ANALYZER, | |
72 INPUT_VIS_SCOPE, | |
73 INPUT_VIS_VU, | |
74 INPUT_VIS_OFF | |
75 } InputVisType; | |
76 | |
77 | |
78 typedef struct _Plugin Plugin; | |
79 typedef struct _InputPlugin InputPlugin; | |
80 typedef struct _OutputPlugin OutputPlugin; | |
81 typedef struct _EffectPlugin EffectPlugin; | |
82 typedef struct _GeneralPlugin GeneralPlugin; | |
83 typedef struct _VisPlugin VisPlugin; | |
84 | |
1563 | 85 typedef struct _LowlevelPlugin LowlevelPlugin; |
86 | |
0 | 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; | |
92 }; | |
93 | |
1563 | 94 /* |
95 * LowlevelPlugin is used for lowlevel system services, such as PlaylistContainers, | |
96 * VFSContainers and the like. | |
97 * | |
98 * They are not GUI visible at this time. | |
99 */ | |
100 struct _LowlevelPlugin { | |
101 gpointer handle; | |
102 gchar *filename; | |
103 | |
104 gchar *description; | |
105 | |
106 void (*init) (void); | |
107 void (*cleanup) (void); | |
108 }; | |
109 | |
0 | 110 struct _OutputPlugin { |
111 gpointer handle; | |
112 gchar *filename; | |
113 | |
114 gchar *description; | |
115 | |
116 void (*init) (void); | |
309 | 117 void (*cleanup) (void); |
0 | 118 void (*about) (void); |
119 void (*configure) (void); | |
120 void (*get_volume) (gint * l, gint * r); | |
121 void (*set_volume) (gint l, gint r); | |
122 | |
123 gint (*open_audio) (AFormat fmt, gint rate, gint nch); | |
124 void (*write_audio) (gpointer ptr, gint length); | |
125 void (*close_audio) (void); | |
126 | |
127 void (*flush) (gint time); | |
128 void (*pause) (gshort paused); | |
129 gint (*buffer_free) (void); | |
130 gint (*buffer_playing) (void); | |
131 gint (*output_time) (void); | |
132 gint (*written_time) (void); | |
515
802a8ed87f67
[svn] Add support for tell_audio(), an output plugin accessor which will give us the information the input plugin passed to
nenolod
parents:
309
diff
changeset
|
133 |
516 | 134 void (*tell_audio) (AFormat * fmt, gint * rate, gint * nch); |
0 | 135 }; |
136 | |
137 struct _EffectPlugin { | |
138 gpointer handle; | |
139 gchar *filename; | |
140 | |
141 gchar *description; | |
142 | |
143 void (*init) (void); | |
144 void (*cleanup) (void); | |
145 void (*about) (void); | |
146 void (*configure) (void); | |
147 | |
148 gint (*mod_samples) (gpointer * data, gint length, AFormat fmt, gint srate, gint nch); | |
149 void (*query_format) (AFormat * fmt, gint * rate, gint * nch); | |
150 }; | |
151 | |
152 struct _InputPlugin { | |
153 gpointer handle; | |
154 gchar *filename; | |
155 | |
156 gchar *description; | |
157 | |
158 void (*init) (void); | |
159 void (*about) (void); | |
160 void (*configure) (void); | |
161 | |
162 gint (*is_our_file) (gchar * filename); | |
163 GList *(*scan_dir) (gchar * dirname); | |
164 | |
165 void (*play_file) (gchar * filename); | |
166 void (*stop) (void); | |
167 void (*pause) (gshort paused); | |
168 void (*seek) (gint time); | |
169 | |
170 void (*set_eq) (gint on, gfloat preamp, gfloat * bands); | |
171 | |
172 gint (*get_time) (void); | |
173 | |
174 void (*get_volume) (gint * l, gint * r); | |
175 void (*set_volume) (gint l, gint r); | |
176 | |
177 void (*cleanup) (void); | |
178 | |
179 InputVisType (*get_vis_type) (void); | |
180 void (*add_vis_pcm) (gint time, AFormat fmt, gint nch, gint length, gpointer ptr); | |
181 | |
182 void (*set_info) (gchar * title, gint length, gint rate, gint freq, gint nch); | |
183 void (*set_info_text) (gchar * text); | |
184 void (*get_song_info) (gchar * filename, gchar ** title, gint * length); | |
185 void (*file_info_box) (gchar * filename); | |
186 | |
187 OutputPlugin *output; | |
1231 | 188 |
1951
c2a63f41d8c6
[svn] - NewVFS input probing layer. VFS-Aware plugins can automatically take
nenolod
parents:
1563
diff
changeset
|
189 /* Added in Audacious 1.1.0 */ |
1231 | 190 TitleInput *(*get_song_tuple) (gchar * filename); |
191 void (*set_song_tuple) (TitleInput * tuple); | |
1273
3b990c26fc46
[svn] - Support for the buffer indicator in playpaus.png that was apparently
nhjm449
parents:
1248
diff
changeset
|
192 void (*set_status_buffering) (gboolean status); |
1951
c2a63f41d8c6
[svn] - NewVFS input probing layer. VFS-Aware plugins can automatically take
nenolod
parents:
1563
diff
changeset
|
193 |
2107
8d2b17ee266e
[svn] - add gchar **vfs_extensions to InputPlugin struct, adding support for
nenolod
parents:
1951
diff
changeset
|
194 /* Added in Audacious 1.3.0 */ |
1951
c2a63f41d8c6
[svn] - NewVFS input probing layer. VFS-Aware plugins can automatically take
nenolod
parents:
1563
diff
changeset
|
195 gint (*is_our_file_from_vfs) (gchar *filename, VFSFile *fd); |
2111 | 196 gchar **vfs_extensions; |
0 | 197 }; |
198 | |
199 struct _GeneralPlugin { | |
200 gpointer handle; | |
201 gchar *filename; | |
202 | |
203 gint xmms_session; | |
204 gchar *description; | |
205 | |
206 void (*init) (void); | |
207 void (*about) (void); | |
208 void (*configure) (void); | |
209 void (*cleanup) (void); | |
210 }; | |
211 | |
212 struct _VisPlugin { | |
213 gpointer handle; | |
214 gchar *filename; | |
215 | |
216 gint xmms_session; | |
217 gchar *description; | |
218 | |
219 gint num_pcm_chs_wanted; | |
220 gint num_freq_chs_wanted; | |
221 | |
222 void (*init) (void); | |
223 void (*cleanup) (void); | |
224 void (*about) (void); | |
225 void (*configure) (void); | |
226 void (*disable_plugin) (struct _VisPlugin *); | |
227 void (*playback_start) (void); | |
228 void (*playback_stop) (void); | |
229 void (*render_pcm) (gint16 pcm_data[2][512]); | |
230 void (*render_freq) (gint16 freq_data[2][256]); | |
231 }; | |
232 | |
233 | |
234 G_BEGIN_DECLS | |
235 | |
236 /* So that input plugins can get the title formatting information */ | |
237 G_CONST_RETURN gchar * xmms_get_gentitle_format(void); | |
238 | |
239 /* So that output plugins can communicate with effect plugins */ | |
240 EffectPlugin *get_current_effect_plugin(void); | |
241 gboolean effects_enabled(void); | |
242 gboolean plugin_set_errortext(const gchar * text); | |
243 | |
244 G_END_DECLS | |
245 | |
246 #endif |