apps/codecs.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2002 Björn Stenberg
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21 #ifndef _CODECS_H_
  22 #define _CODECS_H_
  23
  24 /* instruct simulator code to not redefine any symbols when compiling codecs.
  25    (the CODEC macro is defined in apps/codecs/Makefile) */
  26 #ifdef CODEC
  27 #define NO_REDEFINES_PLEASE
  28 #endif
  29
  30 #ifndef MEM
  31 #define MEM 2
  32 #endif
  33
  34 #include <stdbool.h>
  35 #include <stdlib.h>
  36 #include "config.h"
  37 #include "system.h"
  38 #include "metadata.h"
  39 #include "audio.h"
  40 #ifdef RB_PROFILE
  41 #include "profile.h"
  42 #include "thread.h"
  43 #endif
  44 #if (CONFIG_CODEC == SWCODEC)
  45 #if !defined(SIMULATOR) && defined(HAVE_RECORDING)
  46 #include "pcm_record.h"
  47 #endif
  48 #include "dsp.h"
  49 #endif
  50 #include "settings.h"
  51
  52 #ifdef CODEC
  53 #if defined(DEBUG) || defined(SIMULATOR)
  54 #undef DEBUGF
  55 #define DEBUGF  ci->debugf
  56 #undef LDEBUGF
  57 #define LDEBUGF ci->debugf
  58 #else
  59 #define DEBUGF(...)
  60 #define LDEBUGF(...)
  61 #endif
  62
  63 #ifdef ROCKBOX_HAS_LOGF
  64 #undef LOGF
  65 #define LOGF ci->logf
  66 #else
  67 #define LOGF(...)
  68 #endif
  69
  70 #endif
  71
  72 /* magic for normal codecs */
  73 #define CODEC_MAGIC 0x52434F44 /* RCOD */
  74 /* magic for encoder codecs */
  75 #define CODEC_ENC_MAGIC 0x52454E43 /* RENC */
  76
  77 /* increase this every time the api struct changes */
  78 #define CODEC_API_VERSION 32
  79
  80 /* update this to latest version if a change to the api struct breaks
  81    backwards compatibility (and please take the opportunity to sort in any
  82    new function which are "waiting" at the end of the function table) */
  83 #define CODEC_MIN_API_VERSION 32
  84
  85 /* codec return codes */
  86 enum codec_status {
  87     CODEC_OK = 0,
  88     CODEC_USB_CONNECTED,
  89     CODEC_ERROR = -1,
  90 };
  91
  92 /* NOTE: To support backwards compatibility, only add new functions at
  93          the end of the structure.  Every time you add a new function,
  94          remember to increase CODEC_API_VERSION.  If you make changes to the
  95          existing APIs then also update CODEC_MIN_API_VERSION to current
  96          version
  97  */
  98 struct codec_api {
  99
 100     off_t  filesize;          /* Total file length */
 101     off_t  curpos;            /* Current buffer position */
 102
 103     /* For gapless mp3 */
 104     struct mp3entry *id3;     /* TAG metadata pointer */
 105     bool *taginfo_ready;      /* Is metadata read */
 106
 107     /* Codec should periodically check if stop_codec is set to true.
 108        In case it is, codec must return immediately */
 109     bool stop_codec;
 110     /* Codec should periodically check if new_track is non zero.
 111        When it is, the codec should request a new track. */
 112     int new_track;
 113     /* If seek_time != 0, codec should seek to that song position (in ms)
 114        if codec supports seeking. */
 115     long seek_time;
 116
 117     /* The dsp instance to be used for audio output */
 118     struct dsp_config *dsp;
 119
 120     /* Returns buffer to malloc array. Only codeclib should need this. */
 121     void* (*codec_get_buffer)(size_t *size);
 122     /* Insert PCM data into audio buffer for playback. Playback will start
 123        automatically. */
 124     bool (*pcmbuf_insert)(const void *ch1, const void *ch2, int count);
 125     /* Set song position in WPS (value in ms). */
 126     void (*set_elapsed)(unsigned int value);
 127
 128     /* Read next <size> amount bytes from file buffer to <ptr>.
 129        Will return number of bytes read or 0 if end of file. */
 130     size_t (*read_filebuf)(void *ptr, size_t size);
 131     /* Request pointer to file buffer which can be used to read
 132        <realsize> amount of data. <reqsize> tells the buffer system
 133        how much data it should try to allocate. If <realsize> is 0,
 134        end of file is reached. */
 135     void* (*request_buffer)(size_t *realsize, size_t reqsize);
 136     /* Advance file buffer position by <amount> amount of bytes. */
 137     void (*advance_buffer)(size_t amount);
 138     /* Advance file buffer to a pointer location inside file buffer. */
 139     void (*advance_buffer_loc)(void *ptr);
 140     /* Seek file buffer to position <newpos> beginning of file. */
 141     bool (*seek_buffer)(size_t newpos);
 142     /* Codec should call this function when it has done the seeking. */
 143     void (*seek_complete)(void);
 144     /* Request file change from file buffer. Returns true is next
 145        track is available and changed. If return value is false,
 146        codec should exit immediately with PLUGIN_OK status. */
 147     bool (*request_next_track)(void);
 148     /* Free the buffer area of the current codec after its loaded */
 149     void (*discard_codec)(void);
 150
 151     void (*set_offset)(size_t value);
 152     /* Configure different codec buffer parameters. */
 153     void (*configure)(int setting, intptr_t value);
 154
 155     /* kernel/ system */
 156 #ifdef CPU_ARM
 157     void (*__div0)(void);
 158 #endif
 159     void (*sleep)(int ticks);
 160     void (*yield)(void);
 161
 162 #if NUM_CORES > 1
 163     unsigned int
 164         (*create_thread)(void (*function)(void), void* stack,
 165                          size_t stack_size, unsigned flags, const char *name
 166                          IF_PRIO(, int priority)
 167                          IF_COP(, unsigned int core));
 168
 169     void (*thread_thaw)(unsigned int thread_id);
 170     void (*thread_wait)(unsigned int thread_id);
 171     void (*semaphore_init)(struct semaphore *s, int max, int start);
 172     void (*semaphore_wait)(struct semaphore *s);
 173     void (*semaphore_release)(struct semaphore *s);
 174 #endif /* NUM_CORES */
 175
 176 #if NUM_CORES > 1
 177     void (*cpucache_flush)(void);
 178     void (*cpucache_invalidate)(void);
 179 #endif
 180
 181     /* strings and memory */
 182     char* (*strcpy)(char *dst, const char *src);
 183     char* (*strncpy)(char *dst, const char *src, size_t length);
 184     size_t (*strlen)(const char *str);
 185     int (*strcmp)(const char *, const char *);
 186     char *(*strcat)(char *s1, const char *s2);
 187     void* (*memset)(void *dst, int c, size_t length);
 188     void* (*memcpy)(void *out, const void *in, size_t n);
 189     void* (*memmove)(void *out, const void *in, size_t n);
 190     int (*memcmp)(const void *s1, const void *s2, size_t n);
 191     void *(*memchr)(const void *s1, int c, size_t n);
 192     char *(*strcasestr) (const char* phaystack, const char* pneedle);
 193
 194 #if defined(DEBUG) || defined(SIMULATOR)
 195     void (*debugf)(const char *fmt, ...) ATTRIBUTE_PRINTF(1, 2);
 196 #endif
 197 #ifdef ROCKBOX_HAS_LOGF
 198     void (*logf)(const char *fmt, ...) ATTRIBUTE_PRINTF(1, 2);
 199 #endif
 200
 201     /* Tremor requires qsort */
 202     void (*qsort)(void *base, size_t nmemb, size_t size,
 203                   int(*compar)(const void *, const void *));
 204
 205     /* The ADX codec accesses global_settings to test for REPEAT_ONE mode */
 206     struct user_settings* global_settings;
 207
 208 #ifdef RB_PROFILE
 209     void (*profile_thread)(void);
 210     void (*profstop)(void);
 211     void (*profile_func_enter)(void *this_fn, void *call_site);
 212     void (*profile_func_exit)(void *this_fn, void *call_site);
 213 #endif
 214
 215 #if defined(HAVE_RECORDING) && !defined(SIMULATOR)
 216     volatile bool   stop_encoder;
 217     volatile int    enc_codec_loaded; /* <0=error, 0=pending, >0=ok */
 218     void            (*enc_get_inputs)(struct enc_inputs *inputs);
 219     void            (*enc_set_parameters)(struct enc_parameters *params);
 220     struct enc_chunk_hdr * (*enc_get_chunk)(void);
 221     void            (*enc_finish_chunk)(void);
 222     unsigned char * (*enc_get_pcm_data)(size_t size);
 223     size_t          (*enc_unget_pcm_data)(size_t size);
 224
 225     /* file */
 226     int (*open)(const char* pathname, int flags);
 227     int (*close)(int fd);
 228     ssize_t (*read)(int fd, void* buf, size_t count);
 229     off_t (*lseek)(int fd, off_t offset, int whence);
 230     ssize_t (*write)(int fd, const void* buf, size_t count);
 231     int (*round_value_to_list32)(unsigned long value,
 232                                  const unsigned long list[],
 233                                  int count,
 234                                  bool signd);
 235 #endif
 236
 237     /* new stuff at the end, sort into place next time
 238        the API gets incompatible */
 239 };
 240
 241 /* codec header */
 242 struct codec_header {
 243     unsigned long magic; /* RCOD or RENC */
 244     unsigned short target_id;
 245     unsigned short api_version;
 246     unsigned char *load_addr;
 247     unsigned char *end_addr;
 248     enum codec_status(*entry_point)(void);
 249     struct codec_api **api;
 250 };
 251
 252 extern unsigned char codecbuf[];
 253 extern size_t codec_size;
 254
 255 #ifdef CODEC
 256 #ifndef SIMULATOR
 257 /* plugin_* is correct, codecs use the plugin linker script */
 258 extern unsigned char plugin_start_addr[];
 259 extern unsigned char plugin_end_addr[];
 260 /* decoders */
 261 #define CODEC_HEADER \
 262         const struct codec_header __header \
 263         __attribute__ ((section (".header")))= { \
 264         CODEC_MAGIC, TARGET_ID, CODEC_API_VERSION, \
 265         plugin_start_addr, plugin_end_addr, codec_start, &ci };
 266 /* encoders */
 267 #define CODEC_ENC_HEADER \
 268         const struct codec_header __header \
 269         __attribute__ ((section (".header")))= { \
 270         CODEC_ENC_MAGIC, TARGET_ID, CODEC_API_VERSION, \
 271         plugin_start_addr, plugin_end_addr, codec_start, &ci };
 272
 273 #else /* def SIMULATOR */
 274 /* decoders */
 275 #define CODEC_HEADER \
 276         const struct codec_header __header \
 277         __attribute__((visibility("default"))) = { \
 278         CODEC_MAGIC, TARGET_ID, CODEC_API_VERSION, \
 279         NULL, NULL, codec_start, &ci };
 280 /* encoders */
 281 #define CODEC_ENC_HEADER \
 282         const struct codec_header __header = { \
 283         CODEC_ENC_MAGIC, TARGET_ID, CODEC_API_VERSION, \
 284         NULL, NULL, codec_start, &ci };
 285 #endif /* SIMULATOR */
 286 #endif /* CODEC */
 287
 288 /* create full codec path from root filenames in audio_formats[]
 289    assumes buffer size is MAX_PATH */
 290 void codec_get_full_path(char *path, const char *codec_root_fn);
 291
 292 /* defined by the codec loader (codec.c) */
 293 int codec_load_buf(unsigned int hid, struct codec_api *api);
 294 int codec_load_file(const char* codec, struct codec_api *api);
 295
 296 /* defined by the codec */
 297 enum codec_status codec_start(void);
 298 enum codec_status codec_main(void);
 299
 300 #endif