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  * use -1 for the default frequency
  59  */
  60 void pcm_set_frequency(unsigned int samplerate);
  61 /* apply settings to hardware immediately */
  62 void pcm_apply_settings(void);
  63
  64 /** RAW PCM playback routines **/
  65
  66 /* Reenterable locks for locking and unlocking the playback interrupt */
  67 void pcm_play_lock(void);
  68 void pcm_play_unlock(void);
  69
  70 void pcm_init(void) INIT_ATTR;
  71 void pcm_postinit(void) INIT_ATTR;
  72
  73 /* This is for playing "raw" PCM data */
  74 void pcm_play_data(pcm_play_callback_type get_more,
  75                    unsigned char* start, size_t size);
  76
  77 void pcm_calculate_peaks(int *left, int *right);
  78 const void* pcm_get_peak_buffer(int* count);
  79 size_t pcm_get_bytes_waiting(void);
  80
  81 void pcm_play_stop(void);
  82 void pcm_play_pause(bool play);
  83 bool pcm_is_paused(void);
  84 bool pcm_is_playing(void);
  85
  86 /** The following are for internal use between pcm.c and target-
  87     specific portion **/
  88
  89 /* Called by the bottom layer ISR when more data is needed. Returns non-
  90  * zero size if more data is to be played. Setting start to NULL
  91  * forces stop. */
  92 void pcm_play_get_more_callback(void **start, size_t *size);
  93
  94 extern unsigned long pcm_curr_sampr;
  95 extern unsigned long pcm_sampr;
  96 extern int pcm_fsel;
  97
  98 #ifdef HAVE_PCM_DMA_ADDRESS
  99 void * pcm_dma_addr(void *addr);
 100 #endif
 101
 102 extern volatile bool pcm_playing;
 103 extern volatile bool pcm_paused;
 104
 105 void pcm_play_dma_lock(void);
 106 void pcm_play_dma_unlock(void);
 107 void pcm_play_dma_init(void) INIT_ATTR;
 108 void pcm_play_dma_start(const void *addr, size_t size);
 109 void pcm_play_dma_stop(void);
 110 void pcm_play_dma_pause(bool pause);
 111 const void * pcm_play_dma_get_peak_buffer(int *count);
 112
 113 void pcm_dma_apply_settings(void);
 114
 115 #ifdef HAVE_RECORDING
 116
 117 /** RAW PCM recording routines **/
 118
 119 /* Reenterable locks for locking and unlocking the recording interrupt */
 120 void pcm_rec_lock(void);
 121 void pcm_rec_unlock(void);
 122
 123 /* Initialize pcm recording interface */
 124 void pcm_init_recording(void);
 125 /* Uninitialize pcm recording interface */
 126 void pcm_close_recording(void);
 127
 128 /* Start recording "raw" PCM data */
 129 void pcm_record_data(pcm_rec_callback_type more_ready,
 130                      void *start, size_t size);
 131
 132 /* Stop tranferring data into supplied buffer */
 133 void pcm_stop_recording(void);
 134
 135 /* Is pcm currently recording? */
 136 bool pcm_is_recording(void);
 137
 138 /* Called by bottom layer ISR when transfer is complete. Returns non-zero
 139  * size if successful. Setting start to NULL forces stop. */
 140 void pcm_rec_more_ready_callback(int status, void **start, size_t *size);
 141
 142 void pcm_calculate_rec_peaks(int *left, int *right);
 143
 144 /** The following are for internal use between pcm.c and target-
 145     specific portion **/
 146 /* DMA transfer in is currently active */
 147 extern volatile bool pcm_recording;
 148
 149 /* APIs implemented in the target-specific portion */
 150 void pcm_rec_dma_init(void);
 151 void pcm_rec_dma_close(void);
 152 void pcm_rec_dma_start(void *addr, size_t size);
 153 void pcm_rec_dma_record_more(void *start, size_t size);
 154 void pcm_rec_dma_stop(void);
 155 const void * pcm_rec_dma_get_peak_buffer(void);
 156
 157 #endif /* HAVE_RECORDING */
 158
 159 #endif /* PCM_PLAYBACK_H */