firmware/pcm.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2007 by Michael Sevakis
  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 #include <stdlib.h>
  22 #include "system.h"
  23 #include "kernel.h"
  24
  25 /* Define LOGF_ENABLE to enable logf output in this file */
  26 /*#define LOGF_ENABLE*/
  27 #include "logf.h"
  28 #include "audio.h"
  29 #include "sound.h"
  30 #include "general.h"
  31
  32 /**
  33  * Aspects implemented in the target-specific portion:
  34  *
  35  * ==Playback==
  36  *   Public -
  37  *      pcm_postinit
  38  *      pcm_get_bytes_waiting
  39  *      pcm_play_lock
  40  *      pcm_play_unlock
  41  *   Semi-private -
  42  *      pcm_play_dma_init
  43  *      pcm_play_dma_init
  44  *      pcm_play_dma_start
  45  *      pcm_play_dma_stop
  46  *      pcm_play_dma_pause
  47  *      pcm_play_dma_get_peak_buffer
  48  *   Data Read/Written within TSP -
  49  *      pcm_sampr (R)
  50  *      pcm_fsel (R)
  51  *      pcm_curr_sampr (R)
  52  *      pcm_callback_for_more (R)
  53  *      pcm_playing (R)
  54  *      pcm_paused (R)
  55  *
  56  * ==Playback/Recording==
  57  *   Semi-private -
  58  *      pcm_dma_apply_settings
  59  *      pcm_dma_addr
  60  *
  61  * ==Recording==
  62  *   Public -
  63  *      pcm_rec_lock
  64  *      pcm_rec_unlock
  65  *   Semi-private -
  66  *      pcm_rec_dma_init
  67  *      pcm_rec_dma_close
  68  *      pcm_rec_dma_start
  69  *      pcm_rec_dma_stop
  70  *      pcm_rec_dma_get_peak_buffer
  71  *   Data Read/Written within TSP -
  72  *      pcm_rec_peak_addr (R/W)
  73  *      pcm_callback_more_ready (R)
  74  *      pcm_recording (R)
  75  *
  76  * States are set _after_ the target's pcm driver is called so that it may
  77  * know from whence the state is changed. One exception is init.
  78  *
  79  */
  80
  81 /* the registered callback function to ask for more mp3 data */
  82 volatile pcm_more_callback_type pcm_callback_for_more
  83     SHAREDBSS_ATTR = NULL;
  84 /* PCM playback state */
  85 volatile bool pcm_playing SHAREDBSS_ATTR = false;
  86 /* PCM paused state. paused implies playing */
  87 volatile bool pcm_paused SHAREDBSS_ATTR = false;
  88 /* samplerate of currently playing audio - undefined if stopped */
  89 unsigned long pcm_curr_sampr SHAREDBSS_ATTR = 0;
  90 /* samplerate waiting to be set */
  91 unsigned long pcm_sampr SHAREDBSS_ATTR = HW_SAMPR_DEFAULT;
  92 /* samplerate frequency selection index */
  93 int pcm_fsel SHAREDBSS_ATTR = HW_FREQ_DEFAULT;
  94
  95 /**
  96  * Do peak calculation using distance squared from axis and save a lot
  97  * of jumps and negation. Don't bother with the calculations of left or
  98  * right only as it's never really used and won't save much time.
  99  *
 100  * Used for recording and playback.
 101  */
 102 static void pcm_peak_peeker(const void *addr, int count, int peaks[2])
 103 {
 104     int32_t peak_l = 0, peak_r = 0;
 105     int32_t peaksq_l = 0, peaksq_r = 0;
 106
 107     do
 108     {
 109         int32_t value = *(int32_t *)addr;
 110         int32_t ch, chsq;
 111 #ifdef ROCKBOX_BIG_ENDIAN
 112         ch = value >> 16;
 113 #else
 114         ch = (int16_t)value;
 115 #endif
 116         chsq = ch*ch;
 117         if (chsq > peaksq_l)
 118             peak_l = ch, peaksq_l = chsq;
 119
 120 #ifdef ROCKBOX_BIG_ENDIAN
 121         ch = (int16_t)value;
 122 #else
 123         ch = value >> 16;
 124 #endif
 125         chsq = ch*ch;
 126         if (chsq > peaksq_r)
 127             peak_r = ch, peaksq_r = chsq;
 128
 129         addr += 16;
 130         count -= 4;
 131     }
 132     while (count > 0);
 133
 134     peaks[0] = abs(peak_l);
 135     peaks[1] = abs(peak_r);
 136 }
 137
 138 void pcm_calculate_peaks(int *left, int *right)
 139 {
 140     static int peaks[2] = { 0, 0 };
 141     static unsigned long last_peak_tick = 0;
 142     static unsigned long frame_period   = 0;
 143
 144     long tick = current_tick;
 145     int count;
 146     const void *addr;
 147
 148     /* Throttled peak ahead based on calling period */
 149     long period = tick - last_peak_tick;
 150
 151     /* Keep reasonable limits on period */
 152     if (period < 1)
 153         period = 1;
 154     else if (period > HZ/5)
 155         period = HZ/5;
 156
 157     frame_period = (3*frame_period + period) >> 2;
 158
 159     last_peak_tick = tick;
 160
 161     addr = pcm_play_dma_get_peak_buffer(&count);
 162
 163     if (pcm_playing && !pcm_paused)
 164     {
 165         int framecount;
 166
 167         framecount = frame_period*pcm_curr_sampr / HZ;
 168         count = MIN(framecount, count);
 169
 170         if (count > 0)
 171             pcm_peak_peeker(addr, count, peaks);
 172         /* else keep previous peak values */
 173     }
 174     else
 175     {
 176         peaks[0] = peaks[1] = 0;
 177     }
 178
 179     if (left)
 180         *left = peaks[0];
 181
 182     if (right)
 183         *right = peaks[1];
 184 }
 185
 186 /****************************************************************************
 187  * Functions that do not require targeted implementation but only a targeted
 188  * interface
 189  */
 190
 191 /* This should only be called at startup before any audio playback or
 192    recording is attempted */
 193 void pcm_init(void)
 194 {
 195     logf("pcm_init");
 196
 197     pcm_play_dma_stopped_callback();
 198
 199     pcm_set_frequency(HW_SAMPR_DEFAULT);
 200
 201     logf(" pcm_play_dma_init");
 202     pcm_play_dma_init();
 203 }
 204
 205 /* Common code to pcm_play_data and pcm_play_pause */
 206 static void pcm_play_data_start(unsigned char *start, size_t size)
 207 {
 208     if (!(start && size))
 209     {
 210         pcm_more_callback_type get_more = pcm_callback_for_more;
 211         size = 0;
 212         if (get_more)
 213         {
 214             logf(" get_more");
 215             get_more(&start, &size);
 216         }
 217     }
 218
 219     if (start && size)
 220     {
 221         logf(" pcm_play_dma_start");
 222         pcm_apply_settings();
 223         pcm_play_dma_start(start, size);
 224         pcm_playing = true;
 225         pcm_paused = false;
 226         return;
 227     }
 228
 229     /* Force a stop */
 230     logf(" pcm_play_dma_stop");
 231     pcm_play_dma_stop();
 232     pcm_play_dma_stopped_callback();
 233 }
 234
 235 void pcm_play_data(pcm_more_callback_type get_more,
 236                    unsigned char *start, size_t size)
 237 {
 238     logf("pcm_play_data");
 239
 240     pcm_play_lock();
 241
 242     pcm_callback_for_more = get_more;
 243
 244     logf(" pcm_play_data_start");
 245     pcm_play_data_start(start, size);
 246
 247     pcm_play_unlock();
 248 }
 249
 250 void pcm_play_pause(bool play)
 251 {
 252     logf("pcm_play_pause: %s", play ? "play" : "pause");
 253
 254     pcm_play_lock();
 255
 256     if (play == pcm_paused && pcm_playing)
 257     {
 258         if (!play)
 259         {
 260             logf(" pcm_play_dma_pause");
 261             pcm_play_dma_pause(true);
 262             pcm_paused = true;
 263         }
 264         else if (pcm_get_bytes_waiting() > 0)
 265         {
 266             logf(" pcm_play_dma_pause");
 267             pcm_apply_settings();
 268             pcm_play_dma_pause(false);
 269             pcm_paused = false;
 270         }
 271         else
 272         {
 273             logf(" pcm_play_dma_start: no data");
 274             pcm_play_data_start(NULL, 0);
 275         }
 276     }
 277     else
 278     {
 279         logf(" no change");
 280     }
 281
 282     pcm_play_unlock();
 283 }
 284
 285 void pcm_play_stop(void)
 286 {
 287     logf("pcm_play_stop");
 288
 289     pcm_play_lock();
 290
 291     if (pcm_playing)
 292     {
 293         logf(" pcm_play_dma_stop");
 294         pcm_play_dma_stop();
 295         pcm_play_dma_stopped_callback();
 296     }
 297     else
 298     {
 299         logf(" not playing");
 300     }
 301
 302     pcm_play_unlock();
 303 }
 304
 305 void pcm_play_dma_stopped_callback(void)
 306 {
 307     pcm_callback_for_more = NULL;
 308     pcm_paused = false;
 309     pcm_playing = false;
 310 }
 311
 312 /**/
 313
 314 /* set frequency next frequency used by the audio hardware -
 315  * what pcm_apply_settings will set */
 316 void pcm_set_frequency(unsigned int samplerate)
 317 {
 318     logf("pcm_set_frequency");
 319
 320     int index = round_value_to_list32(samplerate, hw_freq_sampr,
 321                                       HW_NUM_FREQ, false);
 322
 323     if (samplerate != hw_freq_sampr[index])
 324         index = HW_FREQ_DEFAULT; /* Invalid = default */
 325
 326     pcm_sampr = hw_freq_sampr[index];
 327     pcm_fsel = index;
 328 }
 329
 330 /* apply pcm settings to the hardware */
 331 void pcm_apply_settings(void)
 332 {
 333     logf("pcm_apply_settings");
 334
 335     if (pcm_sampr != pcm_curr_sampr)
 336     {
 337         logf(" pcm_dma_apply_settings");
 338         pcm_dma_apply_settings();
 339         pcm_curr_sampr = pcm_sampr;
 340     }
 341 }
 342
 343 bool pcm_is_playing(void)
 344 {
 345     return pcm_playing;
 346 }
 347
 348 bool pcm_is_paused(void)
 349 {
 350     return pcm_paused;
 351 }
 352
 353 void pcm_mute(bool mute)
 354 {
 355 #ifndef SIMULATOR
 356     audiohw_mute(mute);
 357 #endif
 358
 359     if (mute)
 360         sleep(HZ/16);
 361 }
 362
 363 #ifdef HAVE_RECORDING
 364 /** Low level pcm recording apis **/
 365
 366 /* Next start for recording peaks */
 367 const volatile void *pcm_rec_peak_addr SHAREDBSS_ATTR = NULL;
 368 /* the registered callback function for when more data is available */
 369 volatile pcm_more_callback_type2
 370     pcm_callback_more_ready SHAREDBSS_ATTR = NULL;
 371 /* DMA transfer in is currently active */
 372 volatile bool pcm_recording SHAREDBSS_ATTR = false;
 373
 374 /**
 375  * Return recording peaks - From the end of the last peak up to
 376  *                          current write position.
 377  */
 378 void pcm_calculate_rec_peaks(int *left, int *right)
 379 {
 380     static int peaks[2];
 381     int count;
 382     const void *addr = pcm_rec_dma_get_peak_buffer(&count);
 383
 384     if (pcm_recording)
 385     {
 386         if (count > 0)
 387         {
 388             pcm_peak_peeker(addr, count, peaks);
 389
 390             if (addr == pcm_rec_peak_addr)
 391                 pcm_rec_peak_addr = (int32_t *)addr + count;
 392         }
 393         /* else keep previous peak values */
 394     }
 395     else
 396     {
 397         peaks[0] = peaks[1] = 0;
 398     }
 399
 400     if (left)
 401         *left = peaks[0];
 402
 403     if (right)
 404         *right = peaks[1];
 405 } /* pcm_calculate_rec_peaks */
 406
 407 /****************************************************************************
 408  * Functions that do not require targeted implementation but only a targeted
 409  * interface
 410  */
 411 void pcm_init_recording(void)
 412 {
 413     logf("pcm_init_recording");
 414
 415     /* Recording init is locked unlike general pcm init since this is not
 416      * just a one-time event at startup and it should and must be safe by
 417      * now. */
 418     pcm_rec_lock();
 419
 420     logf(" pcm_rec_dma_init");
 421     pcm_rec_dma_stopped_callback();
 422     pcm_rec_dma_init();
 423
 424     pcm_rec_unlock();
 425 }
 426
 427 void pcm_close_recording(void)
 428 {
 429     logf("pcm_close_recording");
 430
 431     pcm_rec_lock();
 432
 433     if (pcm_recording)
 434     {
 435         logf(" pcm_rec_dma_stop");
 436         pcm_rec_dma_stop();
 437         pcm_rec_dma_stopped_callback();
 438     }
 439
 440     logf(" pcm_rec_dma_close");
 441     pcm_rec_dma_close();
 442
 443     pcm_rec_unlock();
 444 }
 445
 446 void pcm_record_data(pcm_more_callback_type2 more_ready,
 447                      void *start, size_t size)
 448 {
 449     logf("pcm_record_data");
 450
 451     if (!(start && size))
 452     {
 453         logf(" no buffer");
 454         return;
 455     }
 456
 457     pcm_rec_lock();
 458
 459     pcm_callback_more_ready = more_ready;
 460
 461     logf(" pcm_rec_dma_start");
 462     pcm_apply_settings();
 463     pcm_rec_dma_start(start, size);
 464     pcm_recording = true;
 465
 466     pcm_rec_unlock();
 467 } /* pcm_record_data */
 468
 469 void pcm_stop_recording(void)
 470 {
 471     logf("pcm_stop_recording");
 472
 473     pcm_rec_lock();
 474
 475     if (pcm_recording)
 476     {
 477         logf(" pcm_rec_dma_stop");
 478         pcm_rec_dma_stop();
 479         pcm_rec_dma_stopped_callback();
 480     }
 481
 482     pcm_rec_unlock();
 483 } /* pcm_stop_recording */
 484
 485 bool pcm_is_recording(void)
 486 {
 487     return pcm_recording;
 488 }
 489
 490 void pcm_rec_dma_stopped_callback(void)
 491 {
 492     pcm_recording = false;
 493     pcm_callback_more_ready = NULL;
 494 }
 495
 496 #endif /* HAVE_RECORDING */