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_more_callback_type)(unsigned char **start,
  54                                        size_t *size);
  55 typedef int (*pcm_more_callback_type2)(int status);
  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);
  71 void pcm_postinit(void);
  72
  73 /* This is for playing "raw" PCM data */
  74 void pcm_play_data(pcm_more_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 extern unsigned long pcm_curr_sampr;
  90 extern unsigned long pcm_sampr;
  91 extern int pcm_fsel;
  92
  93 #ifdef HAVE_PCM_DMA_ADDRESS
  94 void * pcm_dma_addr(void *addr);
  95 #endif
  96
  97 /* the registered callback function to ask for more mp3 data */
  98 extern volatile pcm_more_callback_type pcm_callback_for_more;
  99 extern volatile bool                   pcm_playing;
 100 extern volatile bool                   pcm_paused;
 101
 102 void pcm_play_dma_lock(void);
 103 void pcm_play_dma_unlock(void);
 104 void pcm_play_dma_init(void);
 105 void pcm_play_dma_start(const void *addr, size_t size);
 106 void pcm_play_dma_stop(void);
 107 void pcm_play_dma_pause(bool pause);
 108 void pcm_play_dma_stopped_callback(void);
 109 const void * pcm_play_dma_get_peak_buffer(int *count);
 110
 111 void pcm_dma_apply_settings(void);
 112
 113 #ifdef HAVE_RECORDING
 114
 115 /** RAW PCM recording routines **/
 116
 117 /* Reenterable locks for locking and unlocking the recording interrupt */
 118 void pcm_rec_lock(void);
 119 void pcm_rec_unlock(void);
 120
 121 /* Initialize pcm recording interface */
 122 void pcm_init_recording(void);
 123 /* Uninitialize pcm recording interface */
 124 void pcm_close_recording(void);
 125
 126 /* Start recording "raw" PCM data */
 127 void pcm_record_data(pcm_more_callback_type2 more_ready,
 128                      void *start, size_t size);
 129
 130 /* Stop tranferring data into supplied buffer */
 131 void pcm_stop_recording(void);
 132
 133 /* Is pcm currently recording? */
 134 bool pcm_is_recording(void);
 135
 136 /* Continue transferring data in - call during interrupt handler */
 137 void pcm_record_more(void *start, size_t size);
 138
 139 void pcm_calculate_rec_peaks(int *left, int *right);
 140
 141 /** The following are for internal use between pcm.c and target-
 142     specific portion **/
 143 /* the registered callback function for when more data is available */
 144 extern volatile pcm_more_callback_type2 pcm_callback_more_ready;
 145 /* DMA transfer in is currently active */
 146 extern volatile bool                    pcm_recording;
 147
 148 /* APIs implemented in the target-specific portion */
 149 void pcm_rec_dma_init(void);
 150 void pcm_rec_dma_close(void);
 151 void pcm_rec_dma_start(void *addr, size_t size);
 152 void pcm_rec_dma_record_more(void *start, size_t size);
 153 void pcm_rec_dma_stop(void);
 154 void pcm_rec_dma_stopped_callback(void);
 155 const void * pcm_rec_dma_get_peak_buffer(void);
 156
 157 #endif /* HAVE_RECORDING */
 158
 159 #endif /* PCM_PLAYBACK_H */