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 "system.h"
  22 #include "thread.h"
  23 #include "voice_thread.h"
  24 #include "talk.h"
  25 #include "dsp.h"
  26 #include "audio.h"
  27 #include "playback.h"
  28 #include "pcmbuf.h"
  29 #include "codecs/libspeex/speex/speex.h"
  30
  31 /* Define any of these as "1" and uncomment the LOGF_ENABLE line to log
  32    regular and/or timeout messages */
  33 #define VOICE_LOGQUEUES 0
  34 #define VOICE_LOGQUEUES_SYS_TIMEOUT 0
  35
  36 /*#define LOGF_ENABLE*/
  37 #include "logf.h"
  38
  39 #if VOICE_LOGQUEUES
  40 #define LOGFQUEUE logf
  41 #else
  42 #define LOGFQUEUE(...)
  43 #endif
  44
  45 #if VOICE_LOGQUEUES_SYS_TIMEOUT
  46 #define LOGFQUEUE_SYS_TIMEOUT logf
  47 #else
  48 #define LOGFQUEUE_SYS_TIMEOUT(...)
  49 #endif
  50
  51 #ifndef IBSS_ATTR_VOICE_STACK
  52 #define IBSS_ATTR_VOICE_STACK IBSS_ATTR
  53 #endif
  54
  55 #define VOICE_FRAME_SIZE    320 /* Samples / frame */
  56 #define VOICE_SAMPLE_RATE 16000 /* Sample rate in HZ */
  57 #define VOICE_SAMPLE_DEPTH   16 /* Sample depth in bits */
  58
  59 /* Voice thread variables */
  60 static unsigned int voice_thread_id = 0;
  61 static long voice_stack[0x7c0/sizeof(long)] IBSS_ATTR_VOICE_STACK;
  62 static const char voice_thread_name[] = "voice";
  63
  64 /* Voice thread synchronization objects */
  65 static struct event_queue voice_queue SHAREDBSS_ATTR;
  66 static struct mutex voice_mutex SHAREDBSS_ATTR;
  67 static struct queue_sender_list voice_queue_sender_list SHAREDBSS_ATTR;
  68 static bool voice_done SHAREDDATA_ATTR = true;
  69
  70 /* Buffer for decoded samples */
  71 static spx_int16_t voice_output_buf[VOICE_FRAME_SIZE] CACHEALIGN_ATTR;
  72
  73 enum voice_thread_states
  74 {
  75     TSTATE_STOPPED = 0,   /* Voice thread is stopped and awaiting commands */
  76     TSTATE_DECODE,        /* Voice is decoding a clip */
  77     TSTATE_BUFFER_INSERT, /* Voice is sending decoded audio to PCM */
  78 };
  79
  80 enum voice_thread_messages
  81 {
  82     Q_VOICE_NULL = 0, /* A message for thread sync - no effect on state */
  83     Q_VOICE_PLAY,     /* Play a clip */
  84     Q_VOICE_STOP,     /* Stop current clip */
  85     Q_VOICE_STATE,    /* Query playing state */
  86 };
  87
  88 /* Structure to store clip data callback info */
  89 struct voice_info
  90 {
  91     pcm_more_callback_type get_more; /* Callback to get more clips */
  92     unsigned char *start;            /* Start of clip */
  93     size_t size;                     /* Size of clip */
  94 };
  95
  96 /* Private thread data for its current state that must be passed to its
  97  * internal functions */
  98 struct voice_thread_data
  99 {
 100     int state;              /* Thread state (TSTATE_*) */
 101     struct queue_event ev;  /* Last queue event pulled from queue */
 102     void *st;               /* Decoder instance */
 103     SpeexBits bits;         /* Bit cursor */
 104     struct dsp_config *dsp; /* DSP used for voice output */
 105     struct voice_info vi;   /* Copy of clip data */
 106     const char *src[2];     /* Current output buffer pointers */
 107     int lookahead;          /* Number of samples to drop at start of clip */
 108     int count;              /* Count of samples remaining to send to PCM */
 109 };
 110
 111 /* Audio playback is in a playing state? */
 112 static inline bool playback_is_playing(void)
 113 {
 114     return (audio_status() & AUDIO_STATUS_PLAY) != 0;
 115 }
 116
 117 /* Stop any current clip and start playing a new one */
 118 void mp3_play_data(const unsigned char* start, int size,
 119                    pcm_more_callback_type get_more)
 120 {
 121     /* Shared struct to get data to the thread - once it replies, it has
 122      * safely cached it in its own private data */
 123     static struct voice_info voice_clip SHAREDBSS_ATTR;
 124
 125     if (get_more != NULL && start != NULL && (ssize_t)size > 0)
 126     {
 127         mutex_lock(&voice_mutex);
 128
 129         voice_clip.get_more = get_more;
 130         voice_clip.start    = (unsigned char *)start;
 131         voice_clip.size     = size;
 132         LOGFQUEUE("mp3 >| voice Q_VOICE_PLAY");
 133         queue_send(&voice_queue, Q_VOICE_PLAY, (intptr_t)&voice_clip);
 134
 135         mutex_unlock(&voice_mutex);
 136     }
 137 }
 138
 139 /* Stop current voice clip from playing */
 140 void mp3_play_stop(void)
 141 {
 142     if(!audio_is_thread_ready())
 143        return;
 144
 145     mutex_lock(&voice_mutex); /* Sync against voice_stop */
 146     LOGFQUEUE("mp3 >| voice Q_VOICE_STOP: 1");
 147     queue_send(&voice_queue, Q_VOICE_STOP, 1);
 148
 149     mutex_unlock(&voice_mutex);
 150 }
 151
 152 void mp3_play_pause(bool play)
 153 {
 154     /* a dummy */
 155     (void)play;
 156 }
 157
 158 /* Tell is voice is still in a playing state */
 159 bool mp3_is_playing(void)
 160 {
 161     /* TODO: Implement a timeout or state query function for event objects */
 162     LOGFQUEUE("mp3 >| voice Q_VOICE_STATE");
 163     int state = queue_send(&voice_queue, Q_VOICE_STATE, 0);
 164     return state != TSTATE_STOPPED;
 165 }
 166
 167 /* This function is meant to be used by the buffer request functions to
 168    ensure the codec is no longer active */
 169 void voice_stop(void)
 170 {
 171     mutex_lock(&voice_mutex);
 172
 173     /* Stop the output and current clip */
 174     mp3_play_stop();
 175
 176     /* Careful if using sync objects in talk.c - make sure locking order is
 177      * observed with one or the other always granted first */
 178
 179     /* Unqueue all future clips */
 180     talk_force_shutup();
 181
 182     /* Wait for any final queue_post to be processed */
 183     LOGFQUEUE("mp3 >| voice Q_VOICE_NULL");
 184     queue_send(&voice_queue, Q_VOICE_NULL, 0);
 185
 186     mutex_unlock(&voice_mutex);
 187 } /* voice_stop */
 188
 189 /* Wait for voice to finish speaking. */
 190 void voice_wait(void)
 191 {
 192     /* NOTE: One problem here is that we can't tell if another thread started a
 193      * new clip by the time we wait. This should be resolvable if conditions
 194      * ever require knowing the very clip you requested has finished. */
 195
 196     /* Wait for PCM buffer to be exhausted. Works only if not playing. */
 197     while(!voice_done || (!playback_is_playing() && pcm_is_playing()))
 198         sleep(1);
 199 }
 200
 201 /* Initialize voice thread data that must be valid upon starting and the
 202  * setup the DSP parameters */
 203 static void voice_data_init(struct voice_thread_data *td)
 204 {
 205     td->state = TSTATE_STOPPED;
 206     td->dsp = (struct dsp_config *)dsp_configure(NULL, DSP_MYDSP,
 207                                                  CODEC_IDX_VOICE);
 208
 209     dsp_configure(td->dsp, DSP_RESET, 0);
 210     dsp_configure(td->dsp, DSP_SET_FREQUENCY, VOICE_SAMPLE_RATE);
 211     dsp_configure(td->dsp, DSP_SET_SAMPLE_DEPTH, VOICE_SAMPLE_DEPTH);
 212     dsp_configure(td->dsp, DSP_SET_STEREO_MODE, STEREO_MONO);
 213 }
 214
 215 /* Voice thread message processing */
 216 static void voice_message(struct voice_thread_data *td)
 217 {
 218     while (1)
 219     {
 220         switch (td->ev.id)
 221         {
 222         case Q_VOICE_PLAY:
 223             LOGFQUEUE("voice < Q_VOICE_PLAY");
 224             /* Put up a block for completion signal */
 225             voice_done = false;
 226
 227             /* Copy the clip info */
 228             td->vi = *(struct voice_info *)td->ev.data;
 229
 230             /* Be sure audio buffer is initialized */
 231             audio_restore_playback(AUDIO_WANT_VOICE);
 232
 233             /* We need nothing more from the sending thread - let it run */
 234             queue_reply(&voice_queue, 1);
 235
 236             if (td->state == TSTATE_STOPPED)
 237             {
 238                 /* Boost CPU now */
 239                 trigger_cpu_boost();
 240             }
 241             else if (!playback_is_playing())
 242             {
 243                 /* Just voice, stop any clip still playing */
 244                 pcmbuf_play_stop();
 245             }
 246
 247             /* Clean-start the decoder */
 248             td->st = speex_decoder_init(&speex_wb_mode);
 249
 250             /* Make bit buffer use our own buffer */
 251             speex_bits_set_bit_buffer(&td->bits, td->vi.start, td->vi.size);
 252             speex_decoder_ctl(td->st, SPEEX_GET_LOOKAHEAD, &td->lookahead);
 253
 254             td->state = TSTATE_DECODE;
 255             return;
 256
 257         case Q_VOICE_STOP:
 258             LOGFQUEUE("voice < Q_VOICE_STOP: %d", ev.data);
 259
 260             if (td->ev.data != 0 && !playback_is_playing())
 261             {
 262                 /* If not playing, it's just voice so stop pcm playback */
 263                 pcmbuf_play_stop();
 264             }
 265
 266             /* Cancel boost */
 267             cancel_cpu_boost();
 268
 269             td->state = TSTATE_STOPPED;
 270             voice_done = true;
 271             break;
 272
 273         case Q_VOICE_STATE:
 274             LOGFQUEUE("voice < Q_VOICE_STATE");
 275             queue_reply(&voice_queue, td->state);
 276
 277             if (td->state == TSTATE_STOPPED)
 278                 break; /* Not in a playback state */
 279
 280             return;
 281
 282         default:
 283             /* Default messages get a reply and thread continues with no
 284              * state transition */
 285             LOGFQUEUE("voice < default");
 286
 287             if (td->state == TSTATE_STOPPED)
 288                 break;  /* Not in playback state */
 289
 290             queue_reply(&voice_queue, 0);
 291             return;
 292         }
 293
 294         queue_wait(&voice_queue, &td->ev);
 295     }
 296 }
 297
 298 /* Voice thread entrypoint */
 299 static void voice_thread(void)
 300 {
 301     struct voice_thread_data td;
 302
 303     voice_data_init(&td);
 304
 305     /* audio thread will only set this once after it finished the final
 306      * audio hardware init so this little construct is safe - even
 307      * cross-core. */
 308     while (!audio_is_thread_ready())
 309         sleep(0);
 310
 311     goto message_wait;
 312
 313     while (1)
 314     {
 315         td.state = TSTATE_DECODE;
 316
 317         if (!queue_empty(&voice_queue))
 318         {
 319         message_wait:
 320             queue_wait(&voice_queue, &td.ev);
 321
 322         message_process:
 323             voice_message(&td);
 324
 325             /* Branch to initial start point or branch back to previous
 326              * operation if interrupted by a message */
 327             switch (td.state)
 328             {
 329             case TSTATE_DECODE:        goto voice_decode;
 330             case TSTATE_BUFFER_INSERT: goto buffer_insert;
 331             default:                   goto message_wait;
 332             }
 333         }
 334
 335     voice_decode:
 336         /* Decode the data */
 337         if (speex_decode_int(td.st, &td.bits, voice_output_buf) < 0)
 338         {
 339             /* End of stream or error - get next clip */
 340             td.vi.size = 0;
 341
 342             if (td.vi.get_more != NULL)
 343                 td.vi.get_more(&td.vi.start, &td.vi.size);
 344
 345             if (td.vi.start != NULL && (ssize_t)td.vi.size > 0)
 346             {
 347                 /* Make bit buffer use our own buffer */
 348                 speex_bits_set_bit_buffer(&td.bits, td.vi.start, td.vi.size);
 349                 /* Don't skip any samples when we're stringing clips together */
 350                 td.lookahead = 0;
 351
 352                 /* Paranoid check - be sure never to somehow get stuck in a
 353                  * loop without listening to the queue */
 354                 yield();
 355
 356                 if (!queue_empty(&voice_queue))
 357                     goto message_wait;
 358                 else
 359                     goto voice_decode;
 360             }
 361
 362             /* If all clips are done and not playing, force pcm playback. */
 363             if (!pcm_is_playing())
 364                 pcmbuf_play_start();
 365
 366             /* Synthesize a stop request */
 367             /* NOTE: We have no way to know when the pcm data placed in the
 368              * buffer is actually consumed and playback has reached the end
 369              * so until the info is available or inferred somehow, this will
 370              * not be accurate and the stopped signal will come too soon.
 371              * ie. You may not hear the "Shutting Down" splash even though
 372              * it waits for voice to stop. */
 373             td.ev.id = Q_VOICE_STOP;
 374             td.ev.data = 0; /* Let PCM drain by itself */
 375             yield();
 376             goto message_process;
 377         }
 378
 379         yield();
 380
 381         /* Output the decoded frame */
 382         td.count = VOICE_FRAME_SIZE - td.lookahead;
 383         td.src[0] = (const char *)&voice_output_buf[td.lookahead];
 384         td.src[1] = NULL;
 385         td.lookahead -= MIN(VOICE_FRAME_SIZE, td.lookahead);
 386
 387     buffer_insert:
 388         /* Process the PCM samples in the DSP and send out for mixing */
 389         td.state = TSTATE_BUFFER_INSERT;
 390
 391         while (td.count > 0)
 392         {
 393             int out_count = dsp_output_count(td.dsp, td.count);
 394             int inp_count;
 395             char *dest;
 396
 397             while (1)
 398             {
 399                 if (!queue_empty(&voice_queue))
 400                     goto message_wait;
 401
 402                 if ((dest = pcmbuf_request_voice_buffer(&out_count)) != NULL)
 403                     break;
 404
 405                 yield();
 406             }
 407
 408             /* Get the real input_size for output_size bytes, guarding
 409              * against resampling buffer overflows. */
 410             inp_count = dsp_input_count(td.dsp, out_count);
 411
 412             if (inp_count <= 0)
 413                 break;
 414
 415             /* Input size has grown, no error, just don't write more than
 416              * length */
 417             if (inp_count > td.count)
 418                 inp_count = td.count;
 419
 420             out_count = dsp_process(td.dsp, dest, td.src, inp_count);
 421
 422             if (out_count <= 0)
 423                 break;
 424
 425             pcmbuf_write_voice_complete(out_count);
 426             td.count -= inp_count;
 427         }
 428
 429         yield();
 430     } /* end while */
 431 } /* voice_thread */
 432
 433 /* Initialize all synchronization objects create the thread */
 434 void voice_thread_init(void)
 435 {
 436     logf("Starting voice thread");
 437     queue_init(&voice_queue, false);
 438     mutex_init(&voice_mutex);
 439
 440     voice_thread_id = create_thread(voice_thread, voice_stack,
 441             sizeof(voice_stack), CREATE_THREAD_FROZEN,
 442             voice_thread_name IF_PRIO(, PRIORITY_PLAYBACK) IF_COP(, CPU));
 443
 444     queue_enable_queue_send(&voice_queue, &voice_queue_sender_list,
 445                             voice_thread_id);
 446 } /* voice_thread_init */
 447
 448 /* Unfreeze the voice thread */
 449 void voice_thread_resume(void)
 450 {
 451     logf("Thawing voice thread");
 452     thread_thaw(voice_thread_id);
 453 }
 454
 455 #ifdef HAVE_PRIORITY_SCHEDULING
 456 /* Set the voice thread priority */
 457 void voice_thread_set_priority(int priority)
 458 {
 459     thread_set_priority(voice_thread_id, priority);
 460 }
 461 #endif