firmware/export/pcm.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 PCM_PLAYBACK_H
  22 #define PCM_PLAYBACK_H
  23
  24 #include <string.h> /* size_t */
  25
  26 #define DMA_REC_ERROR_DMA       (-1)
  27 #ifdef HAVE_SPDIF_REC
  28 #define DMA_REC_ERROR_SPDIF     (-2)
  29 #endif
  30
  31 /** Warnings **/
  32 /* pcm (dma) buffer has overflowed */
  33 #define PCMREC_W_PCM_BUFFER_OVF         0x00000001
  34 /* encoder output buffer has overflowed */
  35 #define PCMREC_W_ENC_BUFFER_OVF         0x00000002
  36 /** Errors **/
  37 /* failed to load encoder */
  38 #define PCMREC_E_LOAD_ENCODER           0x80001000
  39 /* error originating in encoder */
  40 #define PCMREC_E_ENCODER                0x80002000
  41 /* filename queue has desynced from stream markers */
  42 #define PCMREC_E_FNQ_DESYNC             0x80004000
  43 /* I/O error has occurred */
  44 #define PCMREC_E_IO                     0x80008000
  45 #ifdef DEBUG
  46 /* encoder has written past end of allotted space */
  47 #define PCMREC_E_CHUNK_OVF              0x80010000
  48 #endif /* DEBUG */
  49
  50 /** RAW PCM routines used with playback and recording **/
  51
  52 /* Typedef for registered callback */
  53 typedef void (*pcm_play_callback_type)(unsigned char **start,
  54                                        size_t *size);
  55 typedef void (*pcm_rec_callback_type)(int status, void **start, size_t *size);
  56
  57 /* set the pcm frequency - use values in hw_sampr_list
  58  * when CONFIG_SAMPR_TYPES is #defined, or-in SAMPR_TYPE_* fields with
  59  * frequency value. SAMPR_TYPE_PLAY is 0 and the default if none is
  60  * specified. */
  61 #ifdef CONFIG_SAMPR_TYPES
  62 #ifdef SAMPR_TYPE_REC
  63 unsigned int pcm_sampr_type_rec_to_play(unsigned int samplerate);
  64 #endif
  65 #endif /* CONFIG_SAMPR_TYPES */
  66
  67 void pcm_set_frequency(unsigned int samplerate);
  68 /* apply settings to hardware immediately */
  69 void pcm_apply_settings(void);
  70
  71 /** RAW PCM playback routines **/
  72
  73 /* Reenterable locks for locking and unlocking the playback interrupt */
  74 void pcm_play_lock(void);
  75 void pcm_play_unlock(void);
  76
  77 void pcm_init(void) INIT_ATTR;
  78 void pcm_postinit(void);
  79
  80 /* This is for playing "raw" PCM data */
  81 void pcm_play_data(pcm_play_callback_type get_more,
  82                    unsigned char* start, size_t size);
  83
  84 void pcm_calculate_peaks(int *left, int *right);
  85 const void* pcm_get_peak_buffer(int* count);
  86 size_t pcm_get_bytes_waiting(void);
  87
  88 void pcm_play_stop(void);
  89 void pcm_play_pause(bool play);
  90 bool pcm_is_paused(void);
  91 bool pcm_is_playing(void);
  92
  93 /** The following are for internal use between pcm.c and target-
  94     specific portion **/
  95
  96 /* Called by the bottom layer ISR when more data is needed. Returns non-
  97  * zero size if more data is to be played. Setting start to NULL
  98  * forces stop. */
  99 void pcm_play_get_more_callback(void **start, size_t *size);
 100
 101 extern unsigned long pcm_curr_sampr;
 102 extern unsigned long pcm_sampr;
 103 extern int pcm_fsel;
 104
 105 #ifdef HAVE_PCM_DMA_ADDRESS
 106 void * pcm_dma_addr(void *addr);
 107 #endif
 108
 109 extern volatile bool pcm_playing;
 110 extern volatile bool pcm_paused;
 111
 112 void pcm_play_dma_lock(void);
 113 void pcm_play_dma_unlock(void);
 114 void pcm_play_dma_init(void) INIT_ATTR;
 115 void pcm_play_dma_start(const void *addr, size_t size);
 116 void pcm_play_dma_stop(void);
 117 void pcm_play_dma_pause(bool pause);
 118 const void * pcm_play_dma_get_peak_buffer(int *count);
 119
 120 void pcm_dma_apply_settings(void);
 121
 122 #ifdef HAVE_RECORDING
 123
 124 /** RAW PCM recording routines **/
 125
 126 /* Reenterable locks for locking and unlocking the recording interrupt */
 127 void pcm_rec_lock(void);
 128 void pcm_rec_unlock(void);
 129
 130 /* Initialize pcm recording interface */
 131 void pcm_init_recording(void);
 132 /* Uninitialize pcm recording interface */
 133 void pcm_close_recording(void);
 134
 135 /* Start recording "raw" PCM data */
 136 void pcm_record_data(pcm_rec_callback_type more_ready,
 137                      void *start, size_t size);
 138
 139 /* Stop tranferring data into supplied buffer */
 140 void pcm_stop_recording(void);
 141
 142 /* Is pcm currently recording? */
 143 bool pcm_is_recording(void);
 144
 145 /* Called by bottom layer ISR when transfer is complete. Returns non-zero
 146  * size if successful. Setting start to NULL forces stop. */
 147 void pcm_rec_more_ready_callback(int status, void **start, size_t *size);
 148
 149 void pcm_calculate_rec_peaks(int *left, int *right);
 150
 151 /** The following are for internal use between pcm.c and target-
 152     specific portion **/
 153 /* DMA transfer in is currently active */
 154 extern volatile bool pcm_recording;
 155
 156 /* APIs implemented in the target-specific portion */
 157 void pcm_rec_dma_init(void);
 158 void pcm_rec_dma_close(void);
 159 void pcm_rec_dma_start(void *addr, size_t size);
 160 void pcm_rec_dma_record_more(void *start, size_t size);
 161 void pcm_rec_dma_stop(void);
 162 const void * pcm_rec_dma_get_peak_buffer(void);
 163
 164 #endif /* HAVE_RECORDING */
 165
 166 #endif /* PCM_PLAYBACK_H */