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 <sys/types.h>
  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 #ifdef SIMULATOR
  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);
  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 #ifdef HAVE_DISK_STORAGE
  69 void audio_set_buffer_margin(int setting);
  70 #endif
  71 void audio_error_clear(void);
  72 int audio_get_file_pos(void);
  73 void audio_beep(int duration);
  74
  75 #if CONFIG_CODEC == SWCODEC
  76 /* Required call when audio buffer is required for some other purpose */
  77 unsigned char *audio_get_buffer(bool talk_buf, size_t *buffer_size);
  78 /* only implemented in playback.c, but called from firmware */
  79
  80 #else /* hwcodec only */
  81 struct audio_debug
  82 {
  83         int audiobuflen;
  84         int audiobuf_write;
  85         int audiobuf_swapwrite;
  86         int audiobuf_read;
  87
  88         int last_dma_chunk_size;
  89
  90         bool dma_on;
  91         bool playing;
  92         bool play_pending;
  93         bool is_playing;
  94         bool filling;
  95         bool dma_underrun;
  96
  97         int unplayed_space;
  98         int playable_space;
  99         int unswapped_space;
 100
 101         int low_watermark_level;
 102         int lowest_watermark_level;
 103 };
 104
 105 void audio_get_debugdata(struct audio_debug *dbgdata);
 106 /* unsigned int audio_error(void); - unused function */
 107 void audio_init_playback(void);
 108 #endif
 109
 110 /* channel modes */
 111 enum rec_channel_modes
 112 {
 113     __CHN_MODE_START_INDEX = -1,
 114
 115     CHN_MODE_STEREO,
 116     CHN_MODE_MONO,
 117
 118     CHN_NUM_MODES
 119 };
 120
 121 #if CONFIG_CODEC == SWCODEC
 122 /* channel mode capability bits */
 123 #define CHN_CAP_STEREO  (1 << CHN_MODE_STEREO)
 124 #define CHN_CAP_MONO    (1 << CHN_MODE_MONO)
 125 #define CHN_CAP_ALL     (CHN_CAP_STEREO | CHN_CAP_MONO)
 126 #endif /* CONFIG_CODEC == SWCODEC */
 127
 128 /* the enums below must match prestr[] in recording.c */
 129 enum audio_sources
 130 {
 131     AUDIO_SRC_PLAYBACK = -1, /* Virtual source */
 132     HAVE_MIC_IN_(AUDIO_SRC_MIC,)
 133     HAVE_LINE_IN_(AUDIO_SRC_LINEIN,)
 134     HAVE_SPDIF_IN_(AUDIO_SRC_SPDIF,)
 135     HAVE_FMRADIO_IN_(AUDIO_SRC_FMRADIO,)
 136     AUDIO_NUM_SOURCES,
 137     AUDIO_SRC_MAX = AUDIO_NUM_SOURCES-1,
 138     AUDIO_SRC_DEFAULT = AUDIO_SRC_PLAYBACK
 139 };
 140
 141 extern int audio_channels;
 142 extern int audio_output_source;
 143
 144 #ifdef HAVE_RECORDING
 145 /* Recordable source implies it has the input as well */
 146
 147 /* For now there's no restrictions on any targets with which inputs
 148    are recordable so define them as equivalent - if they do differ,
 149    special handling is needed right now. */
 150 enum rec_sources
 151 {
 152     __REC_SRC_FIRST = -1,
 153     HAVE_MIC_REC_(REC_SRC_MIC,)
 154     HAVE_LINE_REC_(REC_SRC_LINEIN,)
 155     HAVE_SPDIF_REC_(REC_SRC_SPDIF,)
 156     HAVE_FMRADIO_REC_(REC_SRC_FMRADIO,)
 157     REC_NUM_SOURCES
 158 };
 159 #endif /* HAVE_RECORDING */
 160
 161 #if CONFIG_CODEC == SWCODEC
 162 /* selects a source to monitor for recording or playback */
 163 #define SRCF_PLAYBACK         0x0000    /* default */
 164 #define SRCF_RECORDING        0x1000
 165 #if CONFIG_TUNER
 166 /* for AUDIO_SRC_FMRADIO */
 167 #define SRCF_FMRADIO_PLAYING  0x0000    /* default */
 168 #define SRCF_FMRADIO_PAUSED   0x2000
 169 #endif
 170 #endif
 171
 172 #ifdef HAVE_RECORDING
 173 /* parameters for audio_set_recording_options */
 174 struct audio_recording_options
 175 {
 176     int  rec_source;
 177     int  rec_frequency;
 178     int  rec_channels;
 179     int  rec_prerecord_time;
 180 #if CONFIG_CODEC == SWCODEC
 181     int  rec_mono_mode;
 182     int  rec_source_flags;  /* for rec_set_source */
 183     struct encoder_config enc_config;
 184 #else
 185     int  rec_quality;
 186     bool rec_editable;
 187 #endif
 188 };
 189
 190 /* audio recording functions */
 191 void audio_init_recording(unsigned int buffer_offset);
 192 void audio_close_recording(void);
 193 void audio_record(const char *filename);
 194 void audio_stop_recording(void);
 195 void audio_pause_recording(void);
 196 void audio_resume_recording(void);
 197 void audio_new_file(const char *filename);
 198 void audio_set_recording_options(struct audio_recording_options *options);
 199 void audio_set_recording_gain(int left, int right, int type);
 200 unsigned long audio_recorded_time(void);
 201 unsigned long audio_num_recorded_bytes(void);
 202
 203 #if CONFIG_CODEC == SWCODEC
 204 /* SWCODEC recording functions */
 205 /* playback.c */
 206 bool audio_load_encoder(int afmt);
 207 void audio_remove_encoder(void);
 208 unsigned char *audio_get_recording_buffer(size_t *buffer_size);
 209 #endif /* CONFIG_CODEC == SWCODEC */
 210
 211 #endif /* HAVE_RECORDING */
 212
 213 #if CONFIG_CODEC == SWCODEC
 214 /* SWCODEC misc. audio functions */
 215 #if INPUT_SRC_CAPS != 0
 216 /* audio.c */
 217 void audio_set_input_source(int source, unsigned flags);
 218 /* audio_input_mux: target-specific implementation used by audio_set_source
 219    to set hardware inputs and audio paths */
 220 void audio_input_mux(int source, unsigned flags);
 221 void audio_set_output_source(int source);
 222 #endif /* INPUT_SRC_CAPS */
 223 #endif /* CONFIG_CODEC == SWCODEC */
 224
 225 #ifdef HAVE_SPDIF_IN
 226 /* returns index into rec_master_sampr_list */
 227 int audio_get_spdif_sample_rate(void);
 228 /* > 0: monitor EBUin, 0: Monitor IISrecv, <0: reset only */
 229 void audio_spdif_set_monitor(int monitor_spdif);
 230 #endif /* HAVE_SPDIF_IN */
 231
 232 unsigned long audio_prev_elapsed(void);
 233
 234 #if CONFIG_CODEC != SWCODEC
 235 /***********************************************************************/
 236 /* audio event handling */
 237
 238 /* subscribe to one or more audio event(s) by OR'ing together the desired */
 239 /* event IDs (defined below); a handler is called with a solitary event ID */
 240 /* (so switch() is okay) and possibly some useful data (depending on the */
 241 /* event); a handler must return one of the return codes defined below */
 242
 243 typedef int (*AUDIO_EVENT_HANDLER)(unsigned short event, unsigned long data);
 244
 245 void audio_register_event_handler(AUDIO_EVENT_HANDLER handler, unsigned short mask);
 246
 247 /***********************************************************************/
 248 /* handler return codes */
 249
 250 #define AUDIO_EVENT_RC_IGNORED      200
 251     /* indicates that no action was taken or the event was not recognized */
 252
 253 #define AUDIO_EVENT_RC_HANDLED      201
 254     /* indicates that the event was handled and some action was taken which renders
 255     the original event invalid; USE WITH CARE!; this return code aborts all further
 256     processing of the given event */
 257
 258 /***********************************************************************/
 259 /* audio event IDs */
 260
 261 #define AUDIO_EVENT_POS_REPORT      (1<<0)
 262     /* sends a periodic song position report to handlers; a report is sent on
 263     each kernal tick; the number of ticks per second is defined by HZ; on each
 264     report the current song position is passed in 'data'; if a handler takes an
 265     action that changes the song or the song position it must return
 266     AUDIO_EVENT_RC_HANDLED which suppresses the event for any remaining handlers */
 267
 268 #define AUDIO_EVENT_END_OF_TRACK    (1<<1)
 269     /* generated when the end of the currently playing track is reached; no
 270     data is passed; if the handler implements some alternate end-of-track
 271     processing it should return AUDIO_EVENT_RC_HANDLED which suppresses the
 272     event for any remaining handlers as well as the normal end-of-track
 273     processing */
 274
 275 #endif
 276 #endif