apps/voice_thread.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2007 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 <sys/types.h>
  22 #include "system.h"
  23 #include "thread.h"
  24 #include "voice_thread.h"
  25 #include "talk.h"
  26 #include "dsp.h"
  27 #include "audio.h"
  28 #include "playback.h"
  29 #include "pcmbuf.h"
  30 #include "pcm.h"
  31 #include "pcm_mixer.h"
  32 #include "codecs/libspeex/speex/speex.h"
  33
  34 /* Define any of these as "1" and uncomment the LOGF_ENABLE line to log
  35    regular and/or timeout messages */
  36 #define VOICE_LOGQUEUES 0
  37 #define VOICE_LOGQUEUES_SYS_TIMEOUT 0
  38
  39 /*#define LOGF_ENABLE*/
  40 #include "logf.h"
  41
  42 #if VOICE_LOGQUEUES
  43 #define LOGFQUEUE logf
  44 #else
  45 #define LOGFQUEUE(...)
  46 #endif
  47
  48 #if VOICE_LOGQUEUES_SYS_TIMEOUT
  49 #define LOGFQUEUE_SYS_TIMEOUT logf
  50 #else
  51 #define LOGFQUEUE_SYS_TIMEOUT(...)
  52 #endif
  53
  54 #ifndef IBSS_ATTR_VOICE_STACK
  55 #define IBSS_ATTR_VOICE_STACK IBSS_ATTR
  56 #endif
  57
  58 /* Minimum priority needs to be a bit elevated since voice has fairly low
  59    latency */
  60 #define PRIORITY_VOICE (PRIORITY_PLAYBACK-4)
  61
  62 #define VOICE_FRAME_SIZE    320 /* Samples / frame */
  63 #define VOICE_SAMPLE_RATE 16000 /* Sample rate in HZ */
  64 #define VOICE_SAMPLE_DEPTH   16 /* Sample depth in bits */
  65
  66 /* Voice thread variables */
  67 static unsigned int voice_thread_id = 0;
  68 #ifdef CPU_COLDFIRE
  69 /* ISR uses any available stack - need a bit more room */
  70 #define VOICE_STACK_EXTRA   0x400
  71 #else
  72 #define VOICE_STACK_EXTRA   0x3c0
  73 #endif
  74 static long voice_stack[(DEFAULT_STACK_SIZE + VOICE_STACK_EXTRA)/sizeof(long)]
  75     IBSS_ATTR_VOICE_STACK;
  76 static const char voice_thread_name[] = "voice";
  77
  78 /* Voice thread synchronization objects */
  79 static struct event_queue voice_queue SHAREDBSS_ATTR;
  80 static struct queue_sender_list voice_queue_sender_list SHAREDBSS_ATTR;
  81 static int quiet_counter SHAREDDATA_ATTR = 0;
  82
  83 /* Buffer for decoded samples */
  84 static spx_int16_t voice_output_buf[VOICE_FRAME_SIZE] CACHEALIGN_ATTR;
  85
  86 #define VOICE_PCM_FRAME_COUNT   ((NATIVE_FREQUENCY*VOICE_FRAME_SIZE + \
  87                                  VOICE_SAMPLE_RATE) / VOICE_SAMPLE_RATE)
  88 #define VOICE_PCM_FRAME_SIZE    (VOICE_PCM_FRAME_COUNT*4)
  89
  90 /* Default number of native-frequency PCM frames to queue - adjust as
  91    necessary per-target */
  92 #define VOICE_FRAMES            3
  93
  94 /* Might have lookahead and be skipping samples, so size is needed */
  95 static size_t voicebuf_sizes[VOICE_FRAMES];
  96 static uint32_t (* voicebuf)[VOICE_PCM_FRAME_COUNT];
  97 static unsigned int cur_buf_in, cur_buf_out;
  98
  99 /* Voice processing states */
 100 enum voice_state
 101 {
 102     VOICE_STATE_MESSAGE = 0,
 103     VOICE_STATE_DECODE,
 104     VOICE_STATE_BUFFER_INSERT,
 105 };
 106
 107 /* A delay to not bring audio back to normal level too soon */
 108 #define QUIET_COUNT 3
 109
 110 enum voice_thread_messages
 111 {
 112     Q_VOICE_PLAY = 0, /* Play a clip */
 113     Q_VOICE_STOP,     /* Stop current clip */
 114 };
 115
 116 /* Structure to store clip data callback info */
 117 struct voice_info
 118 {
 119     pcm_play_callback_type get_more; /* Callback to get more clips */
 120     unsigned char *start;            /* Start of clip */
 121     size_t size;                     /* Size of clip */
 122 };
 123
 124 /* Private thread data for its current state that must be passed to its
 125  * internal functions */
 126 struct voice_thread_data
 127 {
 128     struct queue_event ev;  /* Last queue event pulled from queue */
 129     void *st;               /* Decoder instance */
 130     SpeexBits bits;         /* Bit cursor */
 131     struct dsp_config *dsp; /* DSP used for voice output */
 132     struct voice_info vi;   /* Copy of clip data */
 133     const char *src[2];     /* Current output buffer pointers */
 134     int lookahead;          /* Number of samples to drop at start of clip */
 135     int count;              /* Count of samples remaining to send to PCM */
 136 };
 137
 138 /* Functions called in their repective state that return the next state to
 139    state machine loop - compiler may inline them at its discretion */
 140 static enum voice_state voice_message(struct voice_thread_data *td);
 141 static enum voice_state voice_decode(struct voice_thread_data *td);
 142 static enum voice_state voice_buffer_insert(struct voice_thread_data *td);
 143
 144 /* Number of frames in queue */
 145 static inline int voice_unplayed_frames(void)
 146 {
 147     return cur_buf_in - cur_buf_out;
 148 }
 149
 150 /* Mixer channel callback */
 151 static void voice_pcm_callback(unsigned char **start, size_t *size)
 152 {
 153     if (voice_unplayed_frames() == 0)
 154         return; /* Done! */
 155
 156     unsigned int i = ++cur_buf_out % VOICE_FRAMES;
 157
 158     *start = (unsigned char *)voicebuf[i];
 159     *size = voicebuf_sizes[i];
 160 }
 161
 162 /* Start playback of voice channel if not already playing */
 163 static void voice_start_playback(void)
 164 {
 165     if (mixer_channel_status(PCM_MIXER_CHAN_VOICE) != CHANNEL_STOPPED)
 166         return;
 167
 168     unsigned int i = cur_buf_out % VOICE_FRAMES;
 169     mixer_channel_play_data(PCM_MIXER_CHAN_VOICE, voice_pcm_callback,
 170                             (unsigned char *)voicebuf[i], voicebuf_sizes[i]);
 171 }
 172
 173 /* Stop the voice channel */
 174 static void voice_stop_playback(void)
 175 {
 176     mixer_channel_stop(PCM_MIXER_CHAN_VOICE);
 177     cur_buf_in = cur_buf_out = 0;
 178 }
 179
 180 /* Grab a free PCM frame */
 181 static uint32_t * voice_buf_get(void)
 182 {
 183     if (voice_unplayed_frames() >= VOICE_FRAMES)
 184     {
 185         /* Full */
 186         voice_start_playback();
 187         return NULL;
 188     }
 189
 190     return voicebuf[cur_buf_in % VOICE_FRAMES];
 191 }
 192
 193 /* Commit a frame returned by voice_buf_get and set the actual size */
 194 static void voice_buf_commit(size_t size)
 195 {
 196     voicebuf_sizes[cur_buf_in++ % VOICE_FRAMES] = size;
 197 }
 198
 199 /* Stop any current clip and start playing a new one */
 200 void mp3_play_data(const unsigned char* start, int size,
 201                    pcm_play_callback_type get_more)
 202 {
 203     if (get_more != NULL && start != NULL && (ssize_t)size > 0)
 204     {
 205         struct voice_info voice_clip =
 206         {
 207             .get_more = get_more,
 208             .start    = (unsigned char *)start,
 209             .size     = size,
 210         };
 211
 212         LOGFQUEUE("mp3 >| voice Q_VOICE_PLAY");
 213         queue_send(&voice_queue, Q_VOICE_PLAY, (intptr_t)&voice_clip);
 214     }
 215 }
 216
 217 /* Stop current voice clip from playing */
 218 void mp3_play_stop(void)
 219 {
 220     LOGFQUEUE("mp3 >| voice Q_VOICE_STOP");
 221     queue_send(&voice_queue, Q_VOICE_STOP, 0);
 222 }
 223
 224 void mp3_play_pause(bool play)
 225 {
 226     /* a dummy */
 227     (void)play;
 228 }
 229
 230 /* Tell if voice is still in a playing state */
 231 bool mp3_is_playing(void)
 232 {
 233     return quiet_counter != 0;
 234 }
 235
 236 /* This function is meant to be used by the buffer request functions to
 237    ensure the codec is no longer active */
 238 void voice_stop(void)
 239 {
 240     /* Unqueue all future clips */
 241     talk_force_shutup();
 242 }
 243
 244 /* Wait for voice to finish speaking. */
 245 void voice_wait(void)
 246 {
 247     /* NOTE: One problem here is that we can't tell if another thread started a
 248      * new clip by the time we wait. This should be resolvable if conditions
 249      * ever require knowing the very clip you requested has finished. */
 250
 251     while (quiet_counter != 0)
 252         sleep(1);
 253 }
 254
 255 /* Initialize voice thread data that must be valid upon starting and the
 256  * setup the DSP parameters */
 257 static void voice_data_init(struct voice_thread_data *td)
 258 {
 259     td->dsp = (struct dsp_config *)dsp_configure(NULL, DSP_MYDSP,
 260                                                  CODEC_IDX_VOICE);
 261
 262     dsp_configure(td->dsp, DSP_RESET, 0);
 263     dsp_configure(td->dsp, DSP_SET_FREQUENCY, VOICE_SAMPLE_RATE);
 264     dsp_configure(td->dsp, DSP_SET_SAMPLE_DEPTH, VOICE_SAMPLE_DEPTH);
 265     dsp_configure(td->dsp, DSP_SET_STEREO_MODE, STEREO_MONO);
 266
 267     mixer_channel_set_amplitude(PCM_MIXER_CHAN_VOICE, MIX_AMP_UNITY);
 268 }
 269
 270 /* Voice thread message processing */
 271 static enum voice_state voice_message(struct voice_thread_data *td)
 272 {
 273     if (quiet_counter > 0)
 274         queue_wait_w_tmo(&voice_queue, &td->ev, HZ/10);
 275     else
 276         queue_wait(&voice_queue, &td->ev);
 277
 278     switch (td->ev.id)
 279     {
 280     case Q_VOICE_PLAY:
 281         LOGFQUEUE("voice < Q_VOICE_PLAY");
 282         if (quiet_counter == 0)
 283         {
 284             /* Boost CPU now */
 285             trigger_cpu_boost();
 286         }
 287         else
 288         {
 289             /* Stop any clip still playing */
 290             voice_stop_playback();
 291         }
 292
 293         quiet_counter = QUIET_COUNT;
 294
 295         /* Copy the clip info */
 296         td->vi = *(struct voice_info *)td->ev.data;
 297
 298         /* Be sure audio buffer is initialized */
 299         audio_restore_playback(AUDIO_WANT_VOICE);
 300
 301         /* We need nothing more from the sending thread - let it run */
 302         queue_reply(&voice_queue, 1);
 303
 304         /* Make audio play more softly and set delay to return to normal
 305            playback level */
 306         pcmbuf_soft_mode(true);
 307
 308         /* Clean-start the decoder */
 309         td->st = speex_decoder_init(&speex_wb_mode);
 310
 311         /* Make bit buffer use our own buffer */
 312         speex_bits_set_bit_buffer(&td->bits, td->vi.start, td->vi.size);
 313         speex_decoder_ctl(td->st, SPEEX_GET_LOOKAHEAD, &td->lookahead);
 314
 315         return VOICE_STATE_DECODE;
 316
 317     case SYS_TIMEOUT:
 318         if (voice_unplayed_frames())
 319         {
 320             /* Waiting for PCM to finish */
 321             break;
 322         }
 323
 324         /* Drop through and stop the first time after clip runs out */
 325         if (quiet_counter-- != QUIET_COUNT)
 326         {
 327             if (quiet_counter <= 0)
 328                 pcmbuf_soft_mode(false);
 329
 330             break;
 331         }
 332
 333         /* Fall-through */
 334     case Q_VOICE_STOP:
 335         LOGFQUEUE("voice < Q_VOICE_STOP");
 336         cancel_cpu_boost();
 337         voice_stop_playback();
 338         break;
 339
 340     /* No default: no other message ids are sent */
 341     }
 342
 343     return VOICE_STATE_MESSAGE;
 344 }
 345
 346 /* Decode frames or stop if all have completed */
 347 static enum voice_state voice_decode(struct voice_thread_data *td)
 348 {
 349     if (!queue_empty(&voice_queue))
 350         return VOICE_STATE_MESSAGE;
 351
 352     /* Decode the data */
 353     if (speex_decode_int(td->st, &td->bits, voice_output_buf) < 0)
 354     {
 355         /* End of stream or error - get next clip */
 356         td->vi.size = 0;
 357
 358         if (td->vi.get_more != NULL)
 359             td->vi.get_more(&td->vi.start, &td->vi.size);
 360
 361         if (td->vi.start != NULL && (ssize_t)td->vi.size > 0)
 362         {
 363             /* Make bit buffer use our own buffer */
 364             speex_bits_set_bit_buffer(&td->bits, td->vi.start, td->vi.size);
 365             /* Don't skip any samples when we're stringing clips together */
 366             td->lookahead = 0;
 367         }
 368         else
 369         {
 370             /* If all clips are done and not playing, force pcm playback. */
 371             voice_start_playback();
 372             return VOICE_STATE_MESSAGE;
 373         }
 374     }
 375     else
 376     {
 377         yield();
 378
 379         /* Output the decoded frame */
 380         td->count = VOICE_FRAME_SIZE - td->lookahead;
 381         td->src[0] = (const char *)&voice_output_buf[td->lookahead];
 382         td->src[1] = NULL;
 383         td->lookahead -= MIN(VOICE_FRAME_SIZE, td->lookahead);
 384
 385         if (td->count > 0)
 386             return VOICE_STATE_BUFFER_INSERT;
 387     }
 388
 389     return VOICE_STATE_DECODE;
 390 }
 391
 392 /* Process the PCM samples in the DSP and send out for mixing */
 393 static enum voice_state voice_buffer_insert(struct voice_thread_data *td)
 394 {
 395     if (!queue_empty(&voice_queue))
 396         return VOICE_STATE_MESSAGE;
 397
 398     char *dest = (char *)voice_buf_get();
 399
 400     if (dest != NULL)
 401     {
 402         voice_buf_commit(dsp_process(td->dsp, dest, td->src, td->count)
 403                          * sizeof (int32_t));
 404         return VOICE_STATE_DECODE;
 405     }
 406
 407     sleep(0);
 408     return VOICE_STATE_BUFFER_INSERT;
 409 }
 410
 411 /* Voice thread entrypoint */
 412 static void NORETURN_ATTR voice_thread(void)
 413 {
 414     struct voice_thread_data td;
 415     enum voice_state state = VOICE_STATE_MESSAGE;
 416
 417     voice_data_init(&td);
 418
 419     while (1)
 420     {
 421         switch (state)
 422         {
 423         case VOICE_STATE_MESSAGE:
 424             state = voice_message(&td);
 425             break;
 426         case VOICE_STATE_DECODE:
 427             state = voice_decode(&td);
 428             break;
 429         case VOICE_STATE_BUFFER_INSERT:
 430             state = voice_buffer_insert(&td);
 431             break;
 432         }
 433     }
 434 }
 435
 436 /* Initialize all synchronization objects create the thread */
 437 void voice_thread_init(void)
 438 {
 439     logf("Starting voice thread");
 440     queue_init(&voice_queue, false);
 441
 442     voice_thread_id = create_thread(voice_thread, voice_stack,
 443             sizeof(voice_stack), 0, voice_thread_name
 444             IF_PRIO(, PRIORITY_VOICE) IF_COP(, CPU));
 445
 446     queue_enable_queue_send(&voice_queue, &voice_queue_sender_list,
 447                             voice_thread_id);
 448 }
 449
 450 #ifdef HAVE_PRIORITY_SCHEDULING
 451 /* Set the voice thread priority */
 452 void voice_thread_set_priority(int priority)
 453 {
 454     if (priority > PRIORITY_VOICE)
 455         priority = PRIORITY_VOICE;
 456
 457     thread_set_priority(voice_thread_id, priority);
 458 }
 459 #endif
 460
 461 /* Initialize voice PCM buffer and return size, allocated from the end */
 462 size_t voicebuf_init(unsigned char *bufend)
 463 {
 464     size_t size = VOICE_FRAMES * VOICE_PCM_FRAME_SIZE;
 465     cur_buf_out = cur_buf_in = 0;
 466     voicebuf = (uint32_t (*)[VOICE_PCM_FRAME_COUNT])(bufend - size);
 467     return size;
 468 }