diff options
Diffstat (limited to 'apps/playback.h')
| -rw-r--r-- | apps/playback.h | 38 |
1 files changed, 32 insertions, 6 deletions
diff --git a/apps/playback.h b/apps/playback.h index 18f9248..4cdece7 100644 --- a/apps/playback.h +++ b/apps/playback.h @@ -20,6 +20,7 @@ #ifndef _AUDIO_H #define _AUDIO_H +/* Supported file types. */ #define AFMT_MPA_L1 0x0001 // MPEG Audio layer 1 #define AFMT_MPA_L2 0x0002 // MPEG Audio layer 2 #define AFMT_MPA_L3 0x0004 // MPEG Audio layer 3 @@ -36,6 +37,7 @@ #define AFMT_UNKNOWN 0x1000 // Unknown file format #define AFMT_WAVPACK 0x2000 // WavPack +/* File buffer configuration keys. */ #define CODEC_SET_FILEBUF_WATERMARK 1 #define CODEC_SET_FILEBUF_CHUNKSIZE 2 #define CODEC_SET_FILEBUF_LIMIT 3 @@ -43,32 +45,56 @@ /* Not yet implemented. */ #define CODEC_SET_AUDIOBUF_WATERMARK 4 +/* Codec Interface */ struct codec_api { - off_t filesize; - off_t curpos; - size_t bitspersampe; + off_t filesize; /* Total file length */ + off_t curpos; /* Current buffer position */ /* For gapless mp3 */ - struct mp3entry *id3; - struct mp3info *mp3data; - bool *taginfo_ready; + struct mp3entry *id3; /* TAG metadata pointer */ + struct mp3info *mp3data; /* MP3 metadata pointer */ + bool *taginfo_ready; /* Is metadata read */ + /* Codec should periodically check if stop_codec is set to true. + In case it's, codec must return with PLUGIN_OK status immediately. */ bool stop_codec; + /* Codec should periodically check if reload_codec is set to true. + In case it's, codec should reload itself without exiting. */ bool reload_codec; + /* If seek_time != 0, codec should seek to that song position (in ms) + if codec supports seeking. */ int seek_time; + /* Returns buffer to malloc array. Only codeclib should need this. */ void* (*get_codec_memory)(size_t *size); + /* Insert PCM data into audio buffer for playback. Playback will start + automatically. */ bool (*audiobuffer_insert)(char *data, size_t length); + /* Set song position in WPS (value in ms). */ void (*set_elapsed)(unsigned int value); + /* Read next <size> amount bytes from file buffer to <ptr>. + Will return number of bytes read or 0 if end of file. */ size_t (*read_filebuf)(void *ptr, size_t size); + /* Request pointer to file buffer which can be used to read + <realsize> amount of data. <reqsize> tells the buffer system + how much data it should try to allocate. If <realsize> is 0, + end of file is reached. */ void* (*request_buffer)(size_t *realsize, size_t reqsize); + /* Advance file buffer position by <amount> amount of bytes. */ void (*advance_buffer)(size_t amount); + /* Advance file buffer to a pointer location inside file buffer. */ void (*advance_buffer_loc)(void *ptr); + /* Seek file buffer to position <newpos> beginning of file. */ bool (*seek_buffer)(off_t newpos); + /* Calculate mp3 seek position from given time data in ms. */ off_t (*mp3_get_filepos)(int newtime); + /* Request file change from file buffer. Returns true is next + track is available and changed. If return value is false, + codec should exit immediately with PLUGIN_OK status. */ bool (*request_next_track)(void); + /* Configure different codec buffer parameters. */ void (*configure)(int setting, void *value); }; |