firmware/export/audio.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2005 by Linus Nielsen Feltzing
  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 AUDIO_H
  22 #define AUDIO_H
  23
  24 #include <stdbool.h>
  25 #include <string.h> /* size_t */
  26 #include "config.h"
  27 /* These must always be included with audio.h for this to compile under
  28    cetain conditions. Do it here or else spread the complication around to
  29    many files. */
  30 #if CONFIG_CODEC == SWCODEC
  31 #include "pcm_sampr.h"
  32 #include "pcm.h"
  33 #ifdef HAVE_RECORDING
  34 #include "enc_base.h"
  35 #endif /* HAVE_RECORDING */
  36 #endif /* CONFIG_CODEC == SWCODEC */
  37
  38
  39 #if (CONFIG_PLATFORM & PLATFORM_HOSTED)
  40 #define audio_play(x) sim_audio_play(x)
  41 #endif
  42
  43 #define AUDIO_STATUS_PLAY       0x0001
  44 #define AUDIO_STATUS_PAUSE      0x0002
  45 #define AUDIO_STATUS_RECORD     0x0004
  46 #define AUDIO_STATUS_PRERECORD  0x0008
  47 #define AUDIO_STATUS_ERROR      0x0010
  48 #define AUDIO_STATUS_WARNING    0x0020
  49
  50 #define AUDIOERR_DISK_FULL      1
  51
  52 #define AUDIO_GAIN_LINEIN       0
  53 #define AUDIO_GAIN_MIC          1
  54
  55
  56 void audio_init(void) INIT_ATTR;
  57 void audio_play(long offset);
  58 void audio_stop(void);
  59 void audio_pause(void);
  60 void audio_resume(void);
  61 void audio_next(void);
  62 void audio_prev(void);
  63 int audio_status(void);
  64 void audio_ff_rewind(long newpos);
  65 void audio_flush_and_reload_tracks(void);
  66 struct mp3entry* audio_current_track(void);
  67 struct mp3entry* audio_next_track(void);
  68 bool audio_peek_track(struct mp3entry** id3, int offset);
  69 #ifdef HAVE_DISK_STORAGE
  70 void audio_set_buffer_margin(int setting);
  71 #endif
  72 void audio_error_clear(void);
  73 int audio_get_file_pos(void);
  74 void audio_beep(int duration);
  75
  76 #if CONFIG_CODEC == SWCODEC
  77 /* Required call when audio buffer is required for some other purpose */
  78 unsigned char *audio_get_buffer(bool talk_buf, size_t *buffer_size);
  79 /* only implemented in playback.c, but called from firmware */
  80
  81 void audio_next_dir(void);
  82 void audio_prev_dir(void);
  83
  84 #else /* hwcodec only */
  85 struct audio_debug
  86 {
  87         int audiobuflen;
  88         int audiobuf_write;
  89         int audiobuf_swapwrite;
  90         int audiobuf_read;
  91
  92         int last_dma_chunk_size;
  93
  94         bool dma_on;
  95         bool playing;
  96         bool play_pending;
  97         bool is_playing;
  98         bool filling;
  99         bool dma_underrun;
 100
 101         int unplayed_space;
 102         int playable_space;
 103         int unswapped_space;
 104
 105         int low_watermark_level;
 106         int lowest_watermark_level;
 107 };
 108
 109 void audio_get_debugdata(struct audio_debug *dbgdata);
 110 /* unsigned int audio_error(void); - unused function */
 111 void audio_init_playback(void);
 112
 113 #define audio_next_dir() ({ })
 114 #define audio_prev_dir() ({ })
 115
 116 #endif
 117
 118 /* channel modes */
 119 enum rec_channel_modes
 120 {
 121     __CHN_MODE_START_INDEX = -1,
 122
 123     CHN_MODE_STEREO,
 124     CHN_MODE_MONO,
 125
 126     CHN_NUM_MODES
 127 };
 128
 129 #if CONFIG_CODEC == SWCODEC
 130 /* channel mode capability bits */
 131 #define CHN_CAP_STEREO  (1 << CHN_MODE_STEREO)
 132 #define CHN_CAP_MONO    (1 << CHN_MODE_MONO)
 133 #define CHN_CAP_ALL     (CHN_CAP_STEREO | CHN_CAP_MONO)
 134 #endif /* CONFIG_CODEC == SWCODEC */
 135
 136 /* the enums below must match prestr[] in recording.c */
 137 enum audio_sources
 138 {
 139     AUDIO_SRC_PLAYBACK = -1, /* Virtual source */
 140     HAVE_MIC_IN_(AUDIO_SRC_MIC,)
 141     HAVE_LINE_IN_(AUDIO_SRC_LINEIN,)
 142     HAVE_SPDIF_IN_(AUDIO_SRC_SPDIF,)
 143     HAVE_FMRADIO_IN_(AUDIO_SRC_FMRADIO,)
 144     AUDIO_NUM_SOURCES,
 145     AUDIO_SRC_MAX = AUDIO_NUM_SOURCES-1,
 146     AUDIO_SRC_DEFAULT = AUDIO_SRC_PLAYBACK
 147 };
 148
 149 extern int audio_channels;
 150 extern int audio_output_source;
 151
 152 #ifdef HAVE_RECORDING
 153 /* Recordable source implies it has the input as well */
 154
 155 /* For now there's no restrictions on any targets with which inputs
 156    are recordable so define them as equivalent - if they do differ,
 157    special handling is needed right now. */
 158 enum rec_sources
 159 {
 160     __REC_SRC_FIRST = -1,
 161     HAVE_MIC_REC_(REC_SRC_MIC,)
 162     HAVE_LINE_REC_(REC_SRC_LINEIN,)
 163     HAVE_SPDIF_REC_(REC_SRC_SPDIF,)
 164     HAVE_FMRADIO_REC_(REC_SRC_FMRADIO,)
 165     REC_NUM_SOURCES
 166 };
 167 #endif /* HAVE_RECORDING */
 168
 169 #if CONFIG_CODEC == SWCODEC
 170 /* selects a source to monitor for recording or playback */
 171 #define SRCF_PLAYBACK         0x0000    /* default */
 172 #define SRCF_RECORDING        0x1000
 173 #if CONFIG_TUNER
 174 /* for AUDIO_SRC_FMRADIO */
 175 #define SRCF_FMRADIO_PLAYING  0x0000    /* default */
 176 #define SRCF_FMRADIO_PAUSED   0x2000
 177 #endif
 178 #endif
 179
 180 #ifdef HAVE_RECORDING
 181 /* parameters for audio_set_recording_options */
 182 struct audio_recording_options
 183 {
 184     int  rec_source;
 185     int  rec_frequency;
 186     int  rec_channels;
 187     int  rec_prerecord_time;
 188 #if CONFIG_CODEC == SWCODEC
 189     int  rec_mono_mode;
 190     int  rec_source_flags;  /* for rec_set_source */
 191     struct encoder_config enc_config;
 192 #else
 193     int  rec_quality;
 194     bool rec_editable;
 195 #endif
 196 };
 197
 198 /* audio recording functions */
 199 void audio_init_recording(unsigned int buffer_offset);
 200 void audio_close_recording(void);
 201 void audio_record(const char *filename);
 202 void audio_stop_recording(void);
 203 void audio_pause_recording(void);
 204 void audio_resume_recording(void);
 205 void audio_new_file(const char *filename);
 206 void audio_set_recording_options(struct audio_recording_options *options);
 207 void audio_set_recording_gain(int left, int right, int type);
 208 unsigned long audio_recorded_time(void);
 209 unsigned long audio_num_recorded_bytes(void);
 210
 211 #if CONFIG_CODEC == SWCODEC
 212 /* SWCODEC recording functions */
 213 /* playback.c */
 214 bool audio_load_encoder(int afmt);
 215 void audio_remove_encoder(void);
 216 unsigned char *audio_get_recording_buffer(size_t *buffer_size);
 217 #endif /* CONFIG_CODEC == SWCODEC */
 218
 219 #endif /* HAVE_RECORDING */
 220
 221 #if CONFIG_CODEC == SWCODEC
 222 /* SWCODEC misc. audio functions */
 223 #if INPUT_SRC_CAPS != 0
 224 /* audio.c */
 225 void audio_set_input_source(int source, unsigned flags);
 226 /* audio_input_mux: target-specific implementation used by audio_set_source
 227    to set hardware inputs and audio paths */
 228 void audio_input_mux(int source, unsigned flags);
 229 void audio_set_output_source(int source);
 230 #endif /* INPUT_SRC_CAPS */
 231 #endif /* CONFIG_CODEC == SWCODEC */
 232
 233 #ifdef HAVE_SPDIF_IN
 234 /* returns index into rec_master_sampr_list */
 235 int audio_get_spdif_sample_rate(void);
 236 /* > 0: monitor EBUin, 0: Monitor IISrecv, <0: reset only */
 237 void audio_spdif_set_monitor(int monitor_spdif);
 238 #endif /* HAVE_SPDIF_IN */
 239
 240 unsigned long audio_prev_elapsed(void);
 241
 242 #if CONFIG_CODEC != SWCODEC
 243 /***********************************************************************/
 244 /* audio event handling */
 245
 246 /* subscribe to one or more audio event(s) by OR'ing together the desired */
 247 /* event IDs (defined below); a handler is called with a solitary event ID */
 248 /* (so switch() is okay) and possibly some useful data (depending on the */
 249 /* event); a handler must return one of the return codes defined below */
 250
 251 typedef int (*AUDIO_EVENT_HANDLER)(unsigned short event, unsigned long data);
 252
 253 void audio_register_event_handler(AUDIO_EVENT_HANDLER handler, unsigned short mask);
 254
 255 /***********************************************************************/
 256 /* handler return codes */
 257
 258 #define AUDIO_EVENT_RC_IGNORED      200
 259     /* indicates that no action was taken or the event was not recognized */
 260
 261 #define AUDIO_EVENT_RC_HANDLED      201
 262     /* indicates that the event was handled and some action was taken which renders
 263     the original event invalid; USE WITH CARE!; this return code aborts all further
 264     processing of the given event */
 265
 266 /***********************************************************************/
 267 /* audio event IDs */
 268
 269 #define AUDIO_EVENT_POS_REPORT      (1<<0)
 270     /* sends a periodic song position report to handlers; a report is sent on
 271     each kernal tick; the number of ticks per second is defined by HZ; on each
 272     report the current song position is passed in 'data'; if a handler takes an
 273     action that changes the song or the song position it must return
 274     AUDIO_EVENT_RC_HANDLED which suppresses the event for any remaining handlers */
 275
 276 #define AUDIO_EVENT_END_OF_TRACK    (1<<1)
 277     /* generated when the end of the currently playing track is reached; no
 278     data is passed; if the handler implements some alternate end-of-track
 279     processing it should return AUDIO_EVENT_RC_HANDLED which suppresses the
 280     event for any remaining handlers as well as the normal end-of-track
 281     processing */
 282
 283 #endif
 284 #endif