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