moved and renamed the codecs, gave the codecs a new extension (.codec),

unified to a single codec-only API, made a new codeclib, disabled the building
of the *2wav plugins


git-svn-id: svn://svn.rockbox.org/rockbox/trunk@6812 a1c6a512-1295-4272-9138-f99709370657

1 files changed, 403 insertions, 0 deletions

diff --git a/apps/codecs.h b/apps/codecs.h
new file mode 100644
index 0000000000..2c2a4cfe43
--- /dev/null
+++ b/apps/codecs.h
@@ -0,0 +1,403 @@
+/***************************************************************************
+ *             __________               __   ___.
+ *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
+ *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
+ *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
+ *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
+ *                     \/            \/     \/    \/            \/
+ * $Id$
+ *
+ * Copyright (C) 2002 Björn Stenberg
+ *
+ * All files in this archive are subject to the GNU General Public License.
+ * See the file COPYING in the source tree root for full license agreement.
+ *
+ * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
+ * KIND, either express or implied.
+ *
+ ****************************************************************************/
+#ifndef _CODECS_H_
+#define _CODECS_H_
+
+/* instruct simulator code to not redefine any symbols when compiling codecs.
+   (the CODEC macro is defined in apps/codecs/Makefile) */
+#ifdef CODEC
+#define NO_REDEFINES_PLEASE
+#endif
+
+#ifndef MEM
+#define MEM 2
+#endif
+
+#include <stdbool.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <sys/types.h>
+#include "config.h"
+#include "dir.h"
+#include "kernel.h"
+#include "button.h"
+#include "font.h"
+#include "system.h"
+#include "lcd.h"
+#include "id3.h"
+#include "mpeg.h"
+#include "audio.h"
+#include "mp3_playback.h"
+#if (HWCODEC == MASNONE)
+#include "pcm_playback.h"
+#endif
+#include "settings.h"
+#include "thread.h"
+#include "playlist.h"
+#ifdef HAVE_LCD_BITMAP
+#include "widgets.h"
+#endif
+#include "sound.h"
+
+#ifdef HAVE_REMOTE_LCD
+#include "lcd-remote.h"
+#endif
+
+#ifdef CODEC
+
+#if defined(DEBUG) || defined(SIMULATOR)
+#undef DEBUGF
+#define DEBUGF  rb->debugf
+#undef LDEBUGF
+#define LDEBUGF rb->debugf
+#else
+#define DEBUGF(...)
+#define LDEBUGF(...)
+#endif
+
+#ifdef ROCKBOX_HAS_LOGF
+#undef LOGF
+#define LOGF rb->logf
+#else
+#define LOGF(...)
+#endif
+
+#endif
+
+/* This size must match the one set in ../plugins/plugin.lds */
+#define CODEC_BUFFER_SIZE 0x3C000
+
+#ifdef SIMULATOR
+#define PREFIX(_x_) sim_ ## _x_
+#else
+#define PREFIX(_x_) _x_
+#endif
+
+/* increase this every time the api struct changes */
+#define CODEC_API_VERSION 40
+
+/* update this to latest version if a change to the api struct breaks
+   backwards compatibility (and please take the opportunity to sort in any 
+   new function which are "waiting" at the end of the function table) */
+#define CODEC_MIN_API_VERSION 40
+
+/* codec return codes */
+enum codec_status {
+    CODEC_OK = 0,
+    CODEC_USB_CONNECTED,
+
+    CODEC_WRONG_API_VERSION = -1,
+    CODEC_WRONG_MODEL = -2,
+    CODEC_ERROR = -3,
+};
+
+/* compatibility test macro */
+#define TEST_CODEC_API(_api_) \
+do { \
+ int _rc_ = _api_->codec_test(CODEC_API_VERSION, 1, MEM); \
+ if (_rc_<0) \
+     return _rc_; \
+} while(0)
+
+/* NOTE: To support backwards compatibility, only add new functions at
+         the end of the structure.  Every time you add a new function,
+         remember to increase CODEC_API_VERSION.  If you make changes to the
+         existing APIs then also update CODEC_MIN_API_VERSION to current
+         version
+ */
+struct codec_api {
+    /* these two fields must always be first, to ensure
+       TEST_CODEC_API will always work */
+    int version;
+    int (*codec_test)(int api_version, int model, int memsize);
+
+    off_t  filesize;          /* Total file length */
+    off_t  curpos;            /* Current buffer position */
+    
+    /* For gapless mp3 */
+    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);
+
+
+    /* lcd */
+    void (*lcd_clear_display)(void);
+    void (*lcd_puts)(int x, int y, const unsigned char *string);
+    void (*lcd_puts_scroll)(int x, int y, const unsigned char* string);
+    void (*lcd_stop_scroll)(void);
+    void (*lcd_set_contrast)(int x);
+#ifdef HAVE_LCD_CHARCELLS
+    void (*lcd_define_pattern)(int which,const char *pattern);
+    unsigned char (*lcd_get_locked_pattern)(void);
+    void (*lcd_unlock_pattern)(unsigned char pat);
+    void (*lcd_putc)(int x, int y, unsigned short ch);
+    void (*lcd_put_cursor)(int x, int y, char cursor_char);
+    void (*lcd_remove_cursor)(void);
+    void (*PREFIX(lcd_icon))(int icon, bool enable);
+#else
+    void (*lcd_putsxy)(int x, int y, const unsigned char *string);
+    void (*lcd_puts_style)(int x, int y, const unsigned char *str, int style);
+    void (*lcd_puts_scroll_style)(int x, int y, const unsigned char* string,
+                                  int style);
+    void (*lcd_bitmap)(const unsigned char *src, int x, int y,
+                       int nx, int ny, bool clear);
+    void (*lcd_drawline)(int x1, int y1, int x2, int y2);
+    void (*lcd_clearline)(int x1, int y1, int x2, int y2);
+    void (*lcd_drawpixel)(int x, int y);
+    void (*lcd_clearpixel)(int x, int y);
+    void (*lcd_setfont)(int font);
+    struct font* (*font_get)(int font);
+    void (*lcd_clearrect)(int x, int y, int nx, int ny);
+    void (*lcd_fillrect)(int x, int y, int nx, int ny);
+    void (*lcd_drawrect)(int x, int y, int nx, int ny);
+    void (*lcd_invertrect)(int x, int y, int nx, int ny);
+    int  (*lcd_getstringsize)(const unsigned char *str, int *w, int *h);
+    void (*lcd_update)(void);
+    void (*lcd_update_rect)(int x, int y, int width, int height);
+    void (*scrollbar)(int x, int y, int width, int height, int items,
+                      int min_shown, int max_shown, int orientation);
+    void (*checkbox)(int x, int y, int width, int height, bool checked);
+    unsigned char* lcd_framebuffer;
+    void (*lcd_blit) (const unsigned char* p_data, int x, int y, int width,
+                      int height, int stride);
+#ifndef SIMULATOR
+    void (*lcd_roll)(int pixels);
+#endif
+#endif
+    void (*backlight_on)(void);
+    void (*backlight_off)(void);
+    void (*backlight_set_timeout)(int index);
+    void (*splash)(int ticks, bool center, const char *fmt, ...);
+
+    /* file */
+    int (*PREFIX(open))(const char* pathname, int flags);
+    int (*close)(int fd);
+    ssize_t (*read)(int fd, void* buf, size_t count);
+    off_t (*PREFIX(lseek))(int fd, off_t offset, int whence);
+    int (*PREFIX(creat))(const char *pathname, mode_t mode);
+    ssize_t (*write)(int fd, const void* buf, size_t count);
+    int (*PREFIX(remove))(const char* pathname);
+    int (*PREFIX(rename))(const char* path, const char* newname);
+    int (*PREFIX(ftruncate))(int fd, off_t length);
+
+    int (*fdprintf)(int fd, const char *fmt, ...);
+    int (*read_line)(int fd, char* buffer, int buffer_size);
+    bool (*settings_parseline)(char* line, char** name, char** value);
+#ifndef SIMULATOR
+    int (*ata_sleep)(void);
+#endif
+    
+    /* dir */
+    DIR* (*PREFIX(opendir))(const char* name);
+    int (*PREFIX(closedir))(DIR* dir);
+    struct dirent* (*PREFIX(readdir))(DIR* dir);
+    int (*PREFIX(mkdir))(const char *name, int mode);
+
+    /* kernel/ system */
+    void (*PREFIX(sleep))(int ticks);
+    void (*yield)(void);
+    long* current_tick;
+    long (*default_event_handler)(long event);
+    long (*default_event_handler_ex)(long event, void (*callback)(void *), void *parameter);
+    int (*create_thread)(void* function, void* stack, int stack_size, const char *name);
+    void (*remove_thread)(int threadnum);
+    void (*reset_poweroff_timer)(void);
+#ifndef SIMULATOR
+    int (*system_memory_guard)(int newmode);
+    long *cpu_frequency;
+#ifdef HAVE_ADJUSTABLE_CPU_FREQ
+    void (*cpu_boost)(bool on_off);
+#endif
+#endif
+
+    /* strings and memory */
+    int (*snprintf)(char *buf, size_t size, const char *fmt, ...);
+    char* (*strcpy)(char *dst, const char *src);
+    char* (*strncpy)(char *dst, const char *src, size_t length);
+    size_t (*strlen)(const char *str);
+    char * (*strrchr)(const char *s, int c);
+    int (*strcmp)(const char *, const char *);
+    int (*strcasecmp)(const char *, const char *);
+    int (*strncasecmp)(const char *s1, const char *s2, size_t n);
+    void* (*memset)(void *dst, int c, size_t length);
+    void* (*memcpy)(void *out, const void *in, size_t n);
+    const char *_ctype_;
+    int (*atoi)(const char *str);
+    char *(*strchr)(const char *s, int c);
+    char *(*strcat)(char *s1, const char *s2);
+    int (*memcmp)(const void *s1, const void *s2, size_t n);
+    char *(*strcasestr) (const char* phaystack, const char* pneedle);
+
+    /* sound */
+    void (*sound_set)(int setting, int value);
+#ifndef SIMULATOR
+    void (*mp3_play_data)(const unsigned char* start, int size, void (*get_more)(unsigned char** start, int* size));
+    void (*mp3_play_pause)(bool play);
+    void (*mp3_play_stop)(void);
+    bool (*mp3_is_playing)(void);
+#if CONFIG_HWCODEC != MASNONE
+    void (*bitswap)(unsigned char *data, int length);
+#endif
+#if CONFIG_HWCODEC == MASNONE
+    void (*pcm_play_data)(const unsigned char *start, int size,
+		    void (*get_more)(unsigned char** start, long*size));
+    void (*pcm_play_stop)(void);
+    void (*pcm_set_frequency)(unsigned int frequency);
+    bool (*pcm_is_playing)(void);
+    void (*pcm_play_pause)(bool play);
+#endif
+#endif /* !SIMULATOR */
+
+    /* playback control */
+    void (*PREFIX(audio_play))(int offset);
+    void (*audio_stop)(void);
+    void (*audio_pause)(void);
+    void (*audio_resume)(void);
+    void (*audio_next)(void);
+    void (*audio_prev)(void);
+    void (*audio_ff_rewind)(int newtime);
+    struct mp3entry* (*audio_next_track)(void);
+    int (*playlist_amount)(void);
+    int (*audio_status)(void);
+    bool (*audio_has_changed_track)(void);
+    struct mp3entry* (*audio_current_track)(void);
+    void (*audio_flush_and_reload_tracks)(void);
+    int (*audio_get_file_pos)(void);
+#if !defined(SIMULATOR) && (CONFIG_HWCODEC != MASNONE)
+    unsigned long (*mpeg_get_last_header)(void);
+#endif
+#if (CONFIG_HWCODEC == MAS3587F) || (CONFIG_HWCODEC == MAS3539F)
+    void (*sound_set_pitch)(int pitch);        
+#endif
+
+    /* MAS communication */
+#if !defined(SIMULATOR) && (CONFIG_HWCODEC != MASNONE)
+    int (*mas_readmem)(int bank, int addr, unsigned long* dest, int len);
+    int (*mas_writemem)(int bank, int addr, const unsigned long* src, int len);
+    int (*mas_readreg)(int reg);
+    int (*mas_writereg)(int reg, unsigned int val);
+#if (CONFIG_HWCODEC == MAS3587F) || (CONFIG_HWCODEC == MAS3539F)
+    int (*mas_codec_writereg)(int reg, unsigned int val);
+    int (*mas_codec_readreg)(int reg);
+#endif
+#endif
+
+    /* tag database */
+    struct tagdb_header *tagdbheader;
+    int *tagdb_fd;
+    int *tagdb_initialized;
+    int (*tagdb_init) (void);
+
+    /* misc */
+    void (*srand)(unsigned int seed);
+    int  (*rand)(void);
+    void (*qsort)(void *base, size_t nmemb, size_t size,
+                  int(*compar)(const void *, const void *));
+    int (*kbd_input)(char* buffer, int buflen);
+    struct tm* (*get_time)(void);
+    int  (*set_time)(const struct tm *tm);
+    void* (*plugin_get_audio_buffer)(int* buffer_size);
+
+#if defined(DEBUG) || defined(SIMULATOR)
+    void (*debugf)(const char *fmt, ...);
+#endif
+    struct user_settings* global_settings;
+    bool (*mp3info)(struct mp3entry *entry, const char *filename, bool v1first);
+    int (*count_mp3_frames)(int fd, int startpos, int filesize,
+                            void (*progressfunc)(int));
+    int (*create_xing_header)(int fd, int startpos, int filesize,
+                              unsigned char *buf, int num_frames,
+                              unsigned long header_template,
+                              void (*progressfunc)(int), bool generate_toc);
+    unsigned long (*find_next_frame)(int fd, long *offset,
+                                     long max_offset, unsigned long last_header);
+    int (*battery_level)(void);
+    bool (*battery_level_safe)(void);
+#if (CONFIG_HWCODEC == MAS3587F) || (CONFIG_HWCODEC == MAS3539F)
+    unsigned short (*peak_meter_scale_value)(unsigned short val,
+                                             int meterwidth);
+    void (*peak_meter_set_use_dbfs)(int use);
+    int (*peak_meter_get_use_dbfs)(void);
+#endif
+#ifdef HAVE_LCD_BITMAP
+    int (*read_bmp_file)(char* filename, int *get_width, int *get_height,
+                         char *bitmap, int maxsize);
+#endif
+
+    /* new stuff at the end, sort into place next time
+       the API gets incompatible */     
+       
+#ifdef ROCKBOX_HAS_LOGF
+    void (*logf)(const char *fmt, ...);
+#endif
+};
+
+/* defined by the codec loader (codec.c) */
+#if CONFIG_HWCODEC == MASNONE
+int codec_load_ram(char* codecptr, size_t size, void* ptr2, size_t bufwrap);
+int codec_load_file(const char* codec);
+#endif
+
+/* defined by the codec */
+enum codec_status codec_start(struct codec_api* rockbox, void* parameter)
+    __attribute__ ((section (".entry")));
+
+#endif