1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
|
/*
deadbeef.h -- plugin API of the DeaDBeeF audio player
http://deadbeef.sourceforge.net
Copyright (C) 2009 Alexey Yakovenko
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
Note: DeaDBeeF player itself uses different license
*/
#ifndef __DEADBEEF_H
#define __DEADBEEF_H
#include <stdint.h>
#include <time.h>
#include <stdio.h>
#ifdef __cplusplus
extern "C" {
#endif
// every plugin must define following entry-point:
// extern "C" DB_plugin_t* $MODULENAME_load (DB_functions_t *api);
// where $MODULENAME is a name of module
// e.g. if your plugin is called "myplugin.so", $MODULENAME is "myplugin"
// this function should return pointer to DB_plugin_t structure
// that is enough for both static and dynamic modules
// add DB_PLUGIN_SET_API_VERSION macro when you define plugin structure
// like this:
// static DB_decoder_t plugin = {
// DB_PLUGIN_SET_API_VERSION
// ............
// }
// this is required for versioning
// if you don't do it -- no version checking will be done (useful for
// debugging/development)
// DON'T release plugins without DB_PLUGIN_SET_API_VERSION
// api version history:
// 0.7 -- devel
// 0.6 -- deadbeef-0.3.3
// 0.5 -- deadbeef-0.3.2
// 0.4 -- deadbeef-0.3.0
// 0.3 -- deadbeef-0.2.3.2
// 0.2 -- deadbeef-0.2.3
// 0.1 -- deadbeef-0.2.0
#define DB_API_VERSION_MAJOR 0
#define DB_API_VERSION_MINOR 7
#define DB_PLUGIN_SET_API_VERSION\
.plugin.api_vmajor = DB_API_VERSION_MAJOR,\
.plugin.api_vminor = DB_API_VERSION_MINOR,
#define MAX_DECODER_PLUGINS 50
////////////////////////////
// playlist structures
// iterators
// that's a good candidate for redesign
#define PL_MAIN 0
#define PL_SEARCH 1
// playlist item
// these are "public" fields, available to plugins
typedef struct DB_playItem_s {
char *fname; // full pathname
const char *decoder_id;
int tracknum; // used for stuff like sid, nsf, cue (will be ignored by most codecs)
int startsample; // start sample of track, or -1 for auto
int endsample; // end sample of track, or -1 for auto
int shufflerating; // sort order for shuffle mode
float playtime; // actual playback time of this track in seconds
time_t started_timestamp; // result of calling time(NULL)
const char *filetype; // e.g. MP3 or OGG
float replaygain_album_gain;
float replaygain_album_peak;
float replaygain_track_gain;
float replaygain_track_peak;
} DB_playItem_t;
typedef struct DB_metaInfo_s {
const char *key;
const char *value;
struct DB_metaInfo_s *next;
} DB_metaInfo_t;
// FIXME: that needs to be in separate plugin
typedef struct DB_id3v2_frame_s {
struct DB_id3v2_frame_s *next;
char id[5];
uint32_t size;
uint8_t flags[2];
uint8_t data[0];
} DB_id3v2_frame_t;
typedef struct DB_id3v2_tag_s {
uint8_t version[2];
uint8_t flags;
DB_id3v2_frame_t *frames;
} DB_id3v2_tag_t;
typedef struct DB_apev2_frame_s {
struct DB_apev2_frame_s *next;
uint32_t flags;
char key[256];
uint32_t size; // size of data
uint8_t data[0];
} DB_apev2_frame_t;
typedef struct DB_apev2_tag_s {
uint32_t version;
uint32_t flags;
DB_apev2_frame_t *frames;
} DB_apev2_tag_t;
// plugin types
enum {
DB_PLUGIN_DECODER = 1,
DB_PLUGIN_OUTPUT = 2,
DB_PLUGIN_DSP = 3,
DB_PLUGIN_MISC = 4,
DB_PLUGIN_VFS = 5,
};
// output plugin states
enum output_state_t {
OUTPUT_STATE_STOPPED = 0,
OUTPUT_STATE_PLAYING = 1,
OUTPUT_STATE_PAUSED = 2,
};
// playback order
enum playback_order_t {
PLAYBACK_ORDER_LINEAR = 0,
PLAYBACK_ORDER_SHUFFLE = 1,
PLAYBACK_ORDER_RANDOM = 2,
};
// playback modes
enum playback_mode_t {
PLAYBACK_MODE_LOOP_ALL = 0, // loop playlist
PLAYBACK_MODE_NOLOOP = 1, // don't loop
PLAYBACK_MODE_LOOP_SINGLE = 2, // loop single track
};
typedef struct {
int event;
time_t time;
} DB_event_t;
typedef struct {
DB_event_t ev;
int index;
DB_playItem_t *track;
} DB_event_track_t;
typedef struct {
DB_event_t ev;
int from;
int to;
} DB_event_trackchange_t;
typedef struct {
DB_event_t ev;
int state;
} DB_event_state_t;
typedef struct DB_conf_item_s {
char *key;
char *value;
struct DB_conf_item_s *next;
} DB_conf_item_t;
// event callback type
typedef int (*DB_callback_t)(DB_event_t *, uintptr_t data);
// events
enum {
DB_EV_FRAMEUPDATE = 0, // ticks around 20 times per second, but ticker may stop sometimes
DB_EV_SONGCHANGED = 1, // triggers when song was just changed
DB_EV_SONGSTARTED = 2, // triggers when song started playing (for scrobblers and such)
DB_EV_SONGFINISHED = 3, // triggers when song finished playing (for scrobblers and such)
DB_EV_TRACKDELETED = 4, // triggers when track is to be deleted from playlist
DB_EV_CONFIGCHANGED = 5, // configuration option changed
DB_EV_ACTIVATE = 6, // will be fired every time player is activated
DB_EV_TRACKINFOCHANGED = 7, // notify plugins that trackinfo was changed
DB_EV_PAUSED = 8, // player was paused or unpaused
DB_EV_PLAYLISTCHANGED = 9, // playlist contents were changed
DB_EV_VOLUMECHANGED = 10, // volume was changed
DB_EV_OUTPUTCHANGED = 11, // sound output plugin changed
DB_EV_ABORTREAD = 12, // tells plugins to stop reading operations, e.g. long-time http requests
DB_EV_PLAYLISTSWITCH = 13, // playlist switch occured
DB_EV_MAX
};
// preset columns, working using IDs
enum pl_column_t {
DB_COLUMN_FILENUMBER = 0,
DB_COLUMN_PLAYING = 1,
DB_COLUMN_ARTIST_ALBUM = 2,
DB_COLUMN_ARTIST = 3,
DB_COLUMN_ALBUM = 4,
DB_COLUMN_TITLE = 5,
DB_COLUMN_DURATION = 6,
DB_COLUMN_TRACK = 7,
DB_COLUMN_ALBUM_ART = 8,
DB_COLUMN_ID_MAX
};
// message ids for communicating with player
enum {
M_SONGFINISHED,
M_NEXTSONG,
M_PREVSONG,
M_PLAYSONG,
M_PLAYSONGNUM,
M_STOPSONG,
M_PAUSESONG,
M_PLAYRANDOM,
M_SONGCHANGED, // p1=from, p2=to
M_TERMINATE, // must be sent to player thread to terminate
M_PLAYLISTREFRESH,
M_REINIT_SOUND,
M_TRACKCHANGED, // p1=tracknumber
M_CONFIGCHANGED, // no arguments
};
// typecasting macros
#define DB_PLUGIN(x) ((DB_plugin_t *)(x))
#define DB_CALLBACK(x) ((DB_callback_t)(x))
#define DB_EVENT(x) ((DB_event_t *)(x))
#define DB_PLAYITEM(x) ((DB_playItem_t *)(x))
// FILE object wrapper for vfs access
typedef struct {
struct DB_vfs_s *vfs;
} DB_FILE;
// md5 calc control structure (see md5/md5.h)
typedef struct DB_md5_s {
char data[70];
} DB_md5_t;
// forward decl for plugin struct
struct DB_plugin_s;
// player api definition
typedef struct {
// versioning
int vmajor;
int vminor;
// event subscribing
void (*ev_subscribe) (struct DB_plugin_s *plugin, int ev, DB_callback_t callback, uintptr_t data);
void (*ev_unsubscribe) (struct DB_plugin_s *plugin, int ev, DB_callback_t callback, uintptr_t data);
// md5sum calc
void (*md5) (uint8_t sig[16], const char *in, int len);
void (*md5_to_str) (char *str, const uint8_t sig[16]);
void (*md5_init)(DB_md5_t *s);
void (*md5_append)(DB_md5_t *s, const uint8_t *data, int nbytes);
void (*md5_finish)(DB_md5_t *s, uint8_t digest[16]);
// playback control
struct DB_output_s* (*get_output) (void);
void (*playback_next) (void);
void (*playback_prev) (void);
void (*playback_pause) (void);
void (*playback_stop) (void);
void (*playback_play) (void);
void (*playback_random) (void);
float (*playback_get_pos) (void); // [0..100]
void (*playback_set_pos) (float pos); // [0..100]
// streamer access
// FIXME: needs to be thread-safe
DB_playItem_t *(*streamer_get_playing_track) (void);
DB_playItem_t *(*streamer_get_streaming_track) (void);
float (*streamer_get_playpos) (void);
void (*streamer_seek) (float time);
int (*streamer_ok_to_read) (int len);
void (*streamer_reset) (int full);
int (*streamer_read) (char *bytes, int size);
void (*streamer_set_bitrate) (int bitrate);
int (*streamer_get_apx_bitrate) (void);
struct DB_fileinfo_s *(*streamer_get_current_fileinfo) (void);
int (*streamer_get_current_playlist) (void);
// process control
const char *(*get_config_dir) (void);
void (*quit) (void);
// threading
intptr_t (*thread_start) (void (*fn)(void *ctx), void *ctx);
intptr_t (*thread_start_low_priority) (void (*fn)(void *ctx), void *ctx);
int (*thread_join) (intptr_t tid);
uintptr_t (*mutex_create) (void);
uintptr_t (*mutex_create_nonrecursive) (void);
void (*mutex_free) (uintptr_t mtx);
int (*mutex_lock) (uintptr_t mtx);
int (*mutex_unlock) (uintptr_t mtx);
uintptr_t (*cond_create) (void);
void (*cond_free) (uintptr_t cond);
int (*cond_wait) (uintptr_t cond, uintptr_t mutex);
int (*cond_signal) (uintptr_t cond);
int (*cond_broadcast) (uintptr_t cond);
// playlist management
int (*plt_get_count) (void);
DB_playItem_t * (*plt_get_head) (int plt);
int (*plt_get_sel_count) (int plt);
int (*plt_add) (int before, const char *title);
void (*plt_remove) (int plt);
void (*plt_free) (void);
void (*plt_set_curr) (int plt);
int (*plt_get_curr) (void);
int (*plt_get_title) (int plt, char *buffer, int bufsize);
int (*plt_set_title) (int plt, const char *title);
void (*plt_move) (int from, int before);
// playlist control
void (*pl_lock) (void);
void (*pl_unlock) (void);
void (*plt_lock) (void);
void (*plt_unlock) (void);
// playlist tracks access
DB_playItem_t * (*pl_item_alloc) (void);
void (*pl_item_ref) (DB_playItem_t *it);
void (*pl_item_unref) (DB_playItem_t *it);
void (*pl_item_copy) (DB_playItem_t *out, DB_playItem_t *in);
int (*pl_add_file) (const char *fname, int (*cb)(DB_playItem_t *it, void *data), void *user_data);
int (*pl_add_dir) (const char *dirname, int (*cb)(DB_playItem_t *it, void *data), void *user_data);
DB_playItem_t *(*pl_insert_item) (DB_playItem_t *after, DB_playItem_t *it);
DB_playItem_t *(*pl_insert_dir) (DB_playItem_t *after, const char *dirname, int *pabort, int (*cb)(DB_playItem_t *it, void *data), void *user_data);
DB_playItem_t *(*pl_insert_file) (DB_playItem_t *after, const char *fname, int *pabort, int (*cb)(DB_playItem_t *it, void *data), void *user_data);
int (*pl_get_idx_of) (DB_playItem_t *it);
DB_playItem_t * (*pl_get_for_idx) (int idx);
DB_playItem_t * (*pl_get_for_idx_and_iter) (int idx, int iter);
float (*pl_get_totaltime) (void);
int (*pl_getcount) (int iter);
int (*pl_delete_selected) (void);
void (*pl_set_cursor) (int iter, int cursor);
int (*pl_get_cursor) (int iter);
void (*pl_set_selected) (DB_playItem_t *it, int sel);
int (*pl_is_selected) (DB_playItem_t *it);
void (*pl_clear) (void);
int (*pl_load) (const char *name);
int (*pl_save) (const char *name);
void (*pl_select_all) (void);
void (*pl_crop_selected) (void);
int (*pl_getselcount) (void);
DB_playItem_t *(*pl_get_first) (int iter);
DB_playItem_t *(*pl_get_last) (int iter);
DB_playItem_t *(*pl_get_next) (DB_playItem_t *it, int iter);
DB_playItem_t *(*pl_get_prev) (DB_playItem_t *it, int iter);
/*
this function formats line for display in playlist
@it pointer to playlist item
@idx number of that item in playlist (or -1)
@s output buffer
@size size of output buffer
@id one of IDs defined in pl_column_id_t enum, can be -1
@fmt format string, used if id is -1
format is printf-alike. specification:
%a artist
%t title
%b album
%n track
%l length (duration)
%y year
%g genre
%c comment
%r copyright
more to come
*/
int (*pl_format_title) (DB_playItem_t *it, int idx, char *s, int size, int id, const char *fmt);
void (*pl_format_item_display_name) (DB_playItem_t *it, char *str, int len);
// void (*pl_set_next) (DB_playItem_t *it, DB_playItem_t *next, int iter);
// void (*pl_set_prev) (DB_playItem_t *it, DB_playItem_t *prev, int iter);
// void (*pl_set_head) (DB_playItem_t *it, int iter);
// void (*pl_set_tail) (DB_playItem_t *it, int iter);
// DB_playItem_t* (*pl_get_head) (void);
// DB_playItem_t* (*pl_get_tail) (void);
void (*pl_move_items) (int iter, DB_playItem_t *drop_before, uint32_t *indexes, int count);
void (*pl_copy_items) (int iter, int plt_from, DB_playItem_t *before, uint32_t *indices, int cnt);
void (*pl_search_reset) (void);
void (*pl_search_process) (const char *text);
// metainfo
void (*pl_add_meta) (DB_playItem_t *it, const char *key, const char *value);
void (*pl_append_meta) (DB_playItem_t *it, const char *key, const char *value);
// must be used from within explicit pl_lock/unlock block
const char *(*pl_find_meta) (DB_playItem_t *it, const char *key);
void (*pl_replace_meta) (DB_playItem_t *it, const char *key, const char *value);
void (*pl_delete_all_meta) (DB_playItem_t *it);
DB_metaInfo_t * (*pl_get_metadata) (DB_playItem_t *it);
void (*pl_set_item_duration) (DB_playItem_t *it, float duration);
float (*pl_get_item_duration) (DB_playItem_t *it);
void (*pl_sort) (int iter, int id, const char *format, int ascending);
void (*pl_items_copy_junk)(DB_playItem_t *from, DB_playItem_t *first, DB_playItem_t *last);
// playqueue support
int (*pl_playqueue_push) (DB_playItem_t *it);
void (*pl_playqueue_clear) (void);
void (*pl_playqueue_pop) (void);
void (*pl_playqueue_remove) (DB_playItem_t *it);
int (*pl_playqueue_test) (DB_playItem_t *it);
// cuesheet support
DB_playItem_t *(*pl_insert_cue_from_buffer) (DB_playItem_t *after, DB_playItem_t *origin, const uint8_t *buffer, int buffersize, int numsamples, int samplerate);
DB_playItem_t * (*pl_insert_cue) (DB_playItem_t *after, DB_playItem_t *origin, int numsamples, int samplerate);
// volume control
void (*volume_set_db) (float dB);
float (*volume_get_db) (void);
void (*volume_set_amp) (float amp);
float (*volume_get_amp) (void);
float (*volume_get_min_db) (void);
// junk reading/writing
int (*junk_id3v1_read) (DB_playItem_t *it, DB_FILE *fp);
int (*junk_id3v1_find) (DB_FILE *fp);
int (*junk_id3v1_write) (FILE *fp, DB_playItem_t *it);
int (*junk_id3v2_find) (DB_FILE *fp, int *psize);
int (*junk_id3v2_read) (DB_playItem_t *it, DB_FILE *fp);
int (*junk_id3v2_read_full) (DB_playItem_t *it, DB_id3v2_tag_t *tag, DB_FILE *fp);
int (*junk_id3v2_convert_24_to_23) (DB_id3v2_tag_t *tag24, DB_id3v2_tag_t *tag23);
int (*junk_id3v2_convert_23_to_24) (DB_id3v2_tag_t *tag23, DB_id3v2_tag_t *tag24);
int (*junk_id3v2_convert_22_to_24) (DB_id3v2_tag_t *tag22, DB_id3v2_tag_t *tag24);
void (*junk_id3v2_free) (DB_id3v2_tag_t *tag);
int (*junk_id3v2_write) (FILE *file, DB_id3v2_tag_t *tag);
DB_id3v2_frame_t *(*junk_id3v2_add_text_frame_23) (DB_id3v2_tag_t *tag, const char *frame_id, const char *value);
DB_id3v2_frame_t *(*junk_id3v2_add_text_frame_24) (DB_id3v2_tag_t *tag, const char *frame_id, const char *value);
int (*junk_id3v2_remove_frames) (DB_id3v2_tag_t *tag, const char *frame_id);
int (*junk_apev2_read) (DB_playItem_t *it, DB_FILE *fp);
int (*junk_apev2_read_full) (DB_playItem_t *it, DB_apev2_tag_t *tag_store, DB_FILE *fp);
int (*junk_apev2_find) (DB_FILE *fp, int32_t *psize, uint32_t *pflags, uint32_t *pnumitems);
int (*junk_apev2_remove_frames) (DB_apev2_tag_t *tag, const char *frame_id);
DB_apev2_frame_t * (*junk_apev2_add_text_frame) (DB_apev2_tag_t *tag, const char *frame_id, const char *value);
void (*junk_apev2_free) (DB_apev2_tag_t *tag);
int (*junk_apev2_write) (FILE *fp, DB_apev2_tag_t *tag, int write_header, int write_footer);
int (*junk_get_leading_size) (DB_FILE *fp);
int (*junk_get_leading_size_stdio) (FILE *fp);
void (*junk_copy) (DB_playItem_t *from, DB_playItem_t *first, DB_playItem_t *last);
const char * (*junk_detect_charset) (const char *s);
void (*junk_recode) (const char *in, int inlen, char *out, int outlen, const char *cs);
// vfs
DB_FILE* (*fopen) (const char *fname);
void (*fclose) (DB_FILE *f);
size_t (*fread) (void *ptr, size_t size, size_t nmemb, DB_FILE *stream);
int (*fseek) (DB_FILE *stream, int64_t offset, int whence);
int64_t (*ftell) (DB_FILE *stream);
void (*rewind) (DB_FILE *stream);
int64_t (*fgetlength) (DB_FILE *stream);
const char *(*fget_content_type) (DB_FILE *stream);
const char *(*fget_content_name) (DB_FILE *stream);
const char *(*fget_content_genre) (DB_FILE *stream);
void (*fstop) (DB_FILE *stream);
// message passing
int (*sendmessage) (uint32_t id, uintptr_t ctx, uint32_t p1, uint32_t p2);
// configuration access
const char * (*conf_get_str) (const char *key, const char *def);
float (*conf_get_float) (const char *key, float def);
int (*conf_get_int) (const char *key, int def);
void (*conf_set_str) (const char *key, const char *val);
void (*conf_set_int) (const char *key, int val);
void (*conf_set_float) (const char *key, float val);
DB_conf_item_t * (*conf_find) (const char *group, DB_conf_item_t *prev);
void (*conf_remove_items) (const char *key);
// plugin communication
struct DB_decoder_s **(*plug_get_decoder_list) (void);
struct DB_output_s **(*plug_get_output_list) (void);
struct DB_dsp_s **(*plug_get_dsp_list) (void);
struct DB_plugin_s **(*plug_get_list) (void);
int (*plug_activate) (struct DB_plugin_s *p, int activate);
const char * (*plug_get_decoder_id) (const char *id);
void (*plug_remove_decoder_id) (const char *id);
} DB_functions_t;
// base plugin interface
typedef struct DB_plugin_s {
// type must be one of DB_PLUGIN_ types
int32_t type;
// api version
int16_t api_vmajor;
int16_t api_vminor;
// plugin version
int16_t version_major;
int16_t version_minor;
// may be deactivated on failures after load
int inactive;
// prevent plugin from being dynamically stopped
int nostop;
// any of those can be left NULL
// though it's much better to fill them with something useful
const char *id; // id used for serialization and runtime binding
const char *name; // short name
const char *descr; // short description
const char *author; // author's name
const char *email; // author's email
const char *website; // author's website
// start is called to start plugin; can be NULL
int (*start) (void);
// stop is called to deinit plugin; can be NULL
int (*stop) (void);
// exec_cmdline may be called at any moment when user sends commandline to player
// can be NULL if plugin doesn't support commandline processing
// cmdline is 0-separated list of strings, guaranteed to have 0 at the end
// cmdline_size is number of bytes pointed by cmdline
int (*exec_cmdline) (const char *cmdline, int cmdline_size);
// plugin configuration dialog is constructed from this data
// can be NULL
const char *configdialog;
} DB_plugin_t;
typedef struct DB_fileinfo_s {
struct DB_decoder_s *plugin;
int bps;
int channels;
int samplerate;
float readpos;
} DB_fileinfo_t;
// decoder plugin
typedef struct DB_decoder_s {
DB_plugin_t plugin;
// init is called to prepare song to be started
DB_fileinfo_t *(*init) (DB_playItem_t *it);
// free is called after decoding is finished
void (*free) (DB_fileinfo_t *info);
// read is called by streamer to decode specified number of bytes
// must return number of bytes that were successfully decoded (sample aligned)
// read_int16 must always output 16 bit signed integer samples
int (*read_int16) (DB_fileinfo_t *info, char *buffer, int size);
// read_float32 must always output 32 bit floating point samples
int (*read_float32) (DB_fileinfo_t *info, char *buffer, int size);
int (*seek) (DB_fileinfo_t *info, float seconds);
// perform seeking in samples (if possible)
// return -1 if failed, or 0 on success
// if -1 is returned, that will mean that streamer must skip that song
int (*seek_sample) (DB_fileinfo_t *info, int sample);
// 'insert' is called to insert new item to playlist
// decoder is responsible to calculate duration, split it into subsongs, load cuesheet, etc
// after==NULL means "prepend before 1st item in playlist"
DB_playItem_t * (*insert) (DB_playItem_t *after, const char *fname);
int (*numvoices) (DB_fileinfo_t *info);
void (*mutevoice) (DB_fileinfo_t *info, int voice, int mute);
int (*read_metadata) (DB_playItem_t *it);
int (*write_metadata) (DB_playItem_t *it);
// NULL terminated array of all supported extensions
const char **exts;
// NULL terminated array of all file type names
const char **filetypes;
} DB_decoder_t;
// output plugin
typedef struct DB_output_s {
DB_plugin_t plugin;
// init is called once at plugin activation
int (*init) (void);
// free is called if output plugin was changed to another, or unload is about to happen
int (*free) (void);
// reconfigure output to another samplerate, if supported
int (*change_rate) (int rate);
// play, stop, pause, unpause are called by deadbeef in response to user
// events, or as part of streaming process
int (*play) (void);
int (*stop) (void);
int (*pause) (void);
int (*unpause) (void);
// one of output_state_t enum values
int (*state) (void);
// following functions must return output sampling rate, bits per sample and number
// of channels
int (*samplerate) (void);
int (*bitspersample) (void);
int (*channels) (void);
// must return 0 for little endian output, or 1 for big endian
int (*endianness) (void);
// soundcard enumeration (can be NULL)
void (*enum_soundcards) (void (*callback)(const char *name, const char *desc, void*), void *userdata);
} DB_output_t;
// dsp plugin
typedef struct DB_dsp_s {
DB_plugin_t plugin;
// process gets called before SRC
// stereo samples are stored in interleaved format
// stereo sample is counted as 1 sample
int (*process_int16) (int16_t *samples, int nsamples, int nch, int bps, int srate);
void (*reset) (void);
} DB_dsp_t;
// misc plugin
// purpose is to provide extra services
// e.g. scrobbling, converting, tagging, custom gui, etc.
// misc plugins should be mostly event driven, so no special entry points in them
typedef struct {
DB_plugin_t plugin;
} DB_misc_t;
// vfs plugin
// provides means for reading, seeking, etc
// api is based on stdio
typedef struct DB_vfs_s {
DB_plugin_t plugin;
DB_FILE* (*open) (const char *fname);
void (*close) (DB_FILE *f);
size_t (*read) (void *ptr, size_t size, size_t nmemb, DB_FILE *stream);
int (*seek) (DB_FILE *stream, int64_t offset, int whence);
int64_t (*tell) (DB_FILE *stream);
void (*rewind) (DB_FILE *stream);
int64_t (*getlength)(DB_FILE *stream);
const char * (*get_content_type) (DB_FILE *stream);
const char * (*get_content_name) (DB_FILE *stream);
const char * (*get_content_genre) (DB_FILE *stream);
const char **scheme_names; // NULL-terminated list of supported schemes, e.g. {"http", "ftp", NULL}
unsigned streaming : 1;
} DB_vfs_t;
// gui plugin
// implements pretty much anything it wants
// works mostly like misc plugin, except we need separate type for that
typedef struct DB_gui_s {
DB_plugin_t plugin;
} DB_gui_t;
#ifdef __cplusplus
}
#endif
#endif // __DEADBEEF_H
|