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