apps/codecs/spc.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2007-2008 Michael Sevakis (jhMikeS)
  11  * Copyright (C) 2006-2007 Adam Gashlin (hcs)
  12  * Copyright (C) 2004-2007 Shay Green (blargg)
  13  * Copyright (C) 2002 Brad Martin
  14  *
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  21  * KIND, either express or implied.
  22  *
  23  ****************************************************************************/
  24
  25 /* lovingly ripped off from Game_Music_Emu 0.5.2. http://www.slack.net/~ant/ */
  26 /* DSP Based on Brad Martin's OpenSPC DSP emulator */
  27 /* tag reading from sexyspc by John Brawn (John_Brawn@yahoo.com) and others */
  28 #include "codeclib.h"
  29 #include "../fracmul.h"
  30 #include "libspc/spc_codec.h"
  31 #include "libspc/spc_profiler.h"
  32
  33 CODEC_HEADER
  34
  35 /**************** ID666 parsing ****************/
  36
  37 struct {
  38     unsigned char isBinary;
  39     char song[32];
  40     char game[32];
  41     char dumper[16];
  42     char comments[32];
  43     int day,month,year;
  44     unsigned long length;
  45     unsigned long fade;
  46     char artist[32];
  47     unsigned char muted;
  48     unsigned char emulator;
  49 } ID666;
  50
  51 static int LoadID666(unsigned char *buf) {
  52     unsigned char *ib=buf;
  53     int isbinary = 1;
  54     int i;
  55
  56     memcpy(ID666.song,ib,32);
  57     ID666.song[31]=0;
  58     ib+=32;
  59
  60     memcpy(ID666.game,ib,32);
  61     ID666.game[31]=0;
  62     ib+=32;
  63
  64     memcpy(ID666.dumper,ib,16);
  65     ID666.dumper[15]=0;
  66     ib+=16;
  67
  68     memcpy(ID666.comments,ib,32);
  69     ID666.comments[31]=0;
  70     ib+=32;
  71
  72     /* Ok, now comes the fun part. */
  73
  74     /* Date check */
  75     if(ib[2] == '/'  && ib[5] == '/' )
  76         isbinary = 0;
  77
  78     /* Reserved bytes check */
  79     if(ib[0xD2 - 0x2E - 112] >= '0' &&
  80        ib[0xD2 - 0x2E - 112] <= '9' &&
  81        ib[0xD3 - 0x2E - 112] == 0x00)
  82         isbinary = 0;
  83
  84     /* is length & fade only digits? */
  85     for (i=0;i<8 && (
  86         (ib[0xA9 - 0x2E - 112+i]>='0'&&ib[0xA9 - 0x2E - 112+i]<='9') ||
  87         ib[0xA9 - 0x2E - 112+i]=='\0');
  88         i++);
  89     if (i==8) isbinary=0;
  90
  91     ID666.isBinary = isbinary;
  92
  93     if(isbinary) {
  94         DEBUGF("binary tag detected\n");
  95         ID666.year=*ib;
  96         ib++;
  97         ID666.year|=*ib<<8;
  98         ib++;
  99         ID666.month=*ib;
 100         ib++;
 101         ID666.day=*ib;
 102         ib++;
 103
 104         ib+=7;
 105
 106         ID666.length=*ib;
 107         ib++;
 108
 109         ID666.length|=*ib<<8;
 110         ib++;
 111
 112         ID666.length|=*ib<<16;
 113         ID666.length*=1000;
 114         ib++;
 115
 116         ID666.fade=*ib;
 117         ib++;
 118         ID666.fade|=*ib<<8;
 119         ib++;
 120         ID666.fade|=*ib<<16;
 121         ib++;
 122         ID666.fade|=*ib<<24;
 123         ib++;
 124
 125         memcpy(ID666.artist,ib,32);
 126         ID666.artist[31]=0;
 127         ib+=32;
 128
 129         ID666.muted=*ib;
 130         ib++;
 131
 132         ID666.emulator=*ib;
 133         ib++;
 134     } else {
 135         unsigned long tmp;
 136         char buf[64];
 137
 138         DEBUGF("text tag detected\n");
 139
 140         memcpy(buf, ib, 2);
 141         buf[2] = 0;
 142         tmp = 0;
 143         for (i=0;i<2 && buf[i]>='0' && buf[i]<='9';i++) tmp=tmp*10+buf[i]-'0';
 144         ID666.month = tmp;
 145         ib+=3;
 146
 147         memcpy(buf, ib, 2);
 148         buf[2] = 0;
 149         tmp = 0;
 150         for (i=0;i<2 && buf[i]>='0' && buf[i]<='9';i++) tmp=tmp*10+buf[i]-'0';
 151         ID666.day = tmp;
 152         ib+=3;
 153
 154         memcpy(buf, ib, 4);
 155         buf[4] = 0;
 156         tmp = 0;
 157         for (i=0;i<4 && buf[i]>='0' && buf[i]<='9';i++) tmp=tmp*10+buf[i]-'0';
 158         ID666.year = tmp;
 159         ib+=5;
 160
 161         memcpy(buf, ib, 3);
 162         buf[3] = 0;
 163         tmp = 0;
 164         for (i=0;i<3 && buf[i]>='0' && buf[i]<='9';i++) tmp=tmp*10+buf[i]-'0';
 165         ID666.length = tmp * 1000;
 166         ib+=3;
 167
 168         memcpy(buf, ib, 5);
 169         buf[5] = 0;
 170         tmp = 0;
 171         for (i=0;i<5 && buf[i]>='0' && buf[i]<='9';i++) tmp=tmp*10+buf[i]-'0';
 172         ID666.fade = tmp;
 173         ib+=5;
 174
 175         memcpy(ID666.artist,ib,32);
 176         ID666.artist[31]=0;
 177         ib+=32;
 178
 179         /*I have no idea if this is right or not.*/
 180         ID666.muted=*ib;
 181         ib++;
 182
 183         memcpy(buf, ib, 1);
 184         buf[1] = 0;
 185         tmp = 0;
 186         ib++;
 187     }
 188     return 1;
 189 }
 190
 191 /**************** Codec ****************/
 192 enum {SAMPLE_RATE = 32000};
 193 static struct Spc_Emu spc_emu IDATA_ATTR CACHEALIGN_ATTR;
 194
 195 #if SPC_DUAL_CORE
 196 /** Implementations for pipelined dual-core operation **/
 197 static int spc_emu_thread_stack[DEFAULT_STACK_SIZE/sizeof(int)]
 198     CACHEALIGN_ATTR;
 199
 200 static const unsigned char * const spc_emu_thread_name = "spc emu";
 201 static unsigned int emu_thread_id = 0;
 202
 203 enum
 204 {
 205     SPC_EMU_AUDIO = 0,
 206     SPC_EMU_LOAD,
 207     SPC_EMU_QUIT,
 208 };
 209
 210 struct spc_load
 211 {
 212     uint8_t *buf;
 213     size_t size;
 214 };
 215
 216 /* sample queue */
 217 #define WAV_NUM_CHUNKS 2
 218 #define WAV_CHUNK_MASK (WAV_NUM_CHUNKS-1)
 219 struct sample_queue_chunk
 220 {
 221     long id;
 222     union
 223     {
 224         intptr_t data;
 225         int32_t audio[WAV_CHUNK_SIZE*2];
 226     };
 227 };
 228
 229 static struct
 230 {
 231     int head, tail;
 232     struct semaphore emu_sem_head;
 233     struct semaphore emu_sem_tail;
 234     struct semaphore emu_evt_reply;
 235     intptr_t retval;
 236     struct sample_queue_chunk wav_chunk[WAV_NUM_CHUNKS];
 237 } sample_queue SHAREDBSS_ATTR;
 238
 239 static inline void samples_release_wrbuf(void)
 240 {
 241     sample_queue.tail++;
 242     ci->semaphore_release(&sample_queue.emu_sem_head);
 243 }
 244
 245 static inline struct sample_queue_chunk * samples_get_wrbuf(void)
 246 {
 247     ci->semaphore_wait(&sample_queue.emu_sem_tail);
 248     return &sample_queue.wav_chunk[sample_queue.tail & WAV_CHUNK_MASK];
 249 }
 250
 251 static inline void samples_release_rdbuf(void)
 252 {
 253     if (sample_queue.head != sample_queue.tail) {
 254         sample_queue.head++;
 255     }
 256
 257     ci->semaphore_release(&sample_queue.emu_sem_tail);
 258 }
 259
 260 static inline int32_t * samples_get_rdbuf(void)
 261 {
 262     ci->semaphore_wait(&sample_queue.emu_sem_head);
 263
 264     if (ci->stop_codec || ci->new_track)
 265     {
 266         /* Told to stop. Buffer must be released. */
 267         samples_release_rdbuf();
 268         return NULL;
 269     }
 270
 271     return sample_queue.wav_chunk[sample_queue.head & WAV_CHUNK_MASK].audio;
 272 }
 273
 274 static intptr_t emu_thread_send_msg(long id, intptr_t data)
 275 {
 276     struct sample_queue_chunk *chunk;
 277     /* Grab an audio output buffer */
 278     ci->semaphore_wait(&sample_queue.emu_sem_head);
 279     chunk = &sample_queue.wav_chunk[sample_queue.head & WAV_CHUNK_MASK];
 280     /* Place a message in it instead of audio */
 281     chunk->id = id;
 282     chunk->data = data;
 283     /* Release it to the emu thread */
 284     samples_release_rdbuf();
 285
 286     if (id != SPC_EMU_QUIT) {
 287         /* Wait for a response */
 288         ci->semaphore_wait(&sample_queue.emu_evt_reply);
 289     }
 290
 291     return sample_queue.retval;
 292 }
 293
 294 /* thread function */
 295 static bool emu_thread_process_msg(struct sample_queue_chunk *chunk)
 296 {
 297     long id = chunk->id;
 298     bool ret = id != SPC_EMU_QUIT;
 299
 300     chunk->id = SPC_EMU_AUDIO; /* Reset chunk type to audio */
 301     sample_queue.retval = 0;
 302
 303     if (id == SPC_EMU_LOAD)
 304     {
 305         struct spc_load *ld = (struct spc_load *)chunk->data;
 306         ci->cpucache_invalidate();
 307         SPC_Init(&spc_emu);
 308         sample_queue.retval = SPC_load_spc(&spc_emu, ld->buf, ld->size);
 309
 310         /* Empty the audio queue */
 311         /* This is a dirty hack a timeout based wait would make unnescessary but
 312            still safe because the other thread is known to be waiting for a reply
 313            and is not using the objects. */
 314         ci->semaphore_init(&sample_queue.emu_sem_tail, 2, 2);
 315         ci->semaphore_init(&sample_queue.emu_sem_head, 2, 0);
 316         sample_queue.head = sample_queue.tail = 0;
 317     }
 318
 319     if (id != SPC_EMU_QUIT) {
 320         ci->semaphore_release(&sample_queue.emu_evt_reply);
 321     }
 322
 323     return ret;
 324 }
 325
 326 static void spc_emu_thread(void)
 327 {
 328     CPU_Init(&spc_emu);
 329
 330     while (1) {
 331         /* get a buffer for output */
 332         struct sample_queue_chunk *chunk = samples_get_wrbuf();
 333
 334         if (chunk->id != SPC_EMU_AUDIO) {
 335             /* This chunk doesn't contain audio but a command */
 336             if (!emu_thread_process_msg(chunk))
 337                 break;
 338             /* Have to re-get this pointer to keep semaphore counts correct */
 339             continue;
 340         }
 341
 342         ENTER_TIMER(render);
 343         /* fill samples buffer */
 344         if ( SPC_play(&spc_emu, WAV_CHUNK_SIZE*2, chunk->audio) )
 345             assert( false );
 346         EXIT_TIMER(render);
 347
 348         /* done so release it to output */
 349         samples_release_wrbuf();
 350         ci->yield();
 351     }
 352 }
 353
 354 static bool spc_emu_start(void)
 355 {
 356     emu_thread_id = ci->create_thread(spc_emu_thread, spc_emu_thread_stack,
 357                            sizeof(spc_emu_thread_stack), CREATE_THREAD_FROZEN,
 358                            spc_emu_thread_name IF_PRIO(, PRIORITY_PLAYBACK), COP);
 359
 360     if (emu_thread_id == 0)
 361         return false;
 362
 363     /* Initialize audio queue as full to prevent emu thread from trying to run the
 364        emulator before loading something */
 365     ci->semaphore_init(&sample_queue.emu_evt_reply, 1, 0);
 366     ci->semaphore_init(&sample_queue.emu_sem_tail, 2, 0);
 367     ci->semaphore_init(&sample_queue.emu_sem_head, 2, 2);
 368     sample_queue.head = 0;
 369     sample_queue.tail = 2;
 370
 371     /* Start it running */
 372     ci->thread_thaw(emu_thread_id);
 373     return true;
 374 }
 375
 376 /* load a new program on the emu thread */
 377 static inline int load_spc_buffer(uint8_t *buf, size_t size)
 378 {
 379     struct spc_load ld = { buf, size };
 380     ci->cpucache_flush();
 381     return emu_thread_send_msg(SPC_EMU_LOAD, (intptr_t)&ld);
 382 }
 383
 384 static inline void spc_emu_quit(void)
 385 {
 386     if (emu_thread_id != 0) {
 387         emu_thread_send_msg(SPC_EMU_QUIT, 0);
 388         /* Wait for emu thread to be killed */
 389         ci->thread_wait(emu_thread_id);
 390         ci->cpucache_invalidate();
 391     }
 392 }
 393
 394 static inline bool spc_play_get_samples(int32_t **samples)
 395 {
 396     /* obtain filled samples buffer */
 397     *samples = samples_get_rdbuf();
 398     return *samples != NULL;
 399 }
 400
 401 static inline void spc_play_send_samples(int32_t *samples)
 402 {
 403     ci->pcmbuf_insert(samples, samples+WAV_CHUNK_SIZE, WAV_CHUNK_SIZE);
 404     /* done with chunk so release it to emu thread */
 405     samples_release_rdbuf();
 406 }
 407
 408 #else /* !SPC_DUAL_CORE */
 409 /** Implementations for single-core operation **/
 410 int32_t wav_chunk[WAV_CHUNK_SIZE*2] IBSS_ATTR;
 411
 412 /* load a new program into emu */
 413 static inline int load_spc_buffer(uint8_t *buf, size_t size)
 414 {
 415     SPC_Init(&spc_emu);
 416     return SPC_load_spc(&spc_emu, buf, size);
 417 }
 418
 419 static inline bool spc_emu_start(void)
 420 {
 421 #ifdef CPU_COLDFIRE
 422     /* signed integer mode with saturation */
 423     coldfire_set_macsr(EMAC_SATURATE);
 424 #endif
 425     CPU_Init(&spc_emu);
 426     return true;
 427 }
 428
 429 static inline void spc_play_send_samples(int32_t *samples)
 430 {
 431     ci->pcmbuf_insert(samples, samples+WAV_CHUNK_SIZE, WAV_CHUNK_SIZE);
 432 }
 433
 434 #define spc_emu_quit()
 435 #define samples_release_rdbuf()
 436
 437 static inline bool spc_play_get_samples(int32_t **samples)
 438 {
 439     ENTER_TIMER(render);
 440     /* fill samples buffer */
 441     if ( SPC_play(&spc_emu,WAV_CHUNK_SIZE*2,wav_chunk) )
 442         assert( false );
 443     EXIT_TIMER(render);
 444     *samples = wav_chunk;
 445     return true;
 446 }
 447 #endif /* SPC_DUAL_CORE */
 448
 449 /* The main decoder loop */
 450 static int play_track( void )
 451 {
 452     int sampleswritten=0;
 453
 454     unsigned long fadestartsample = ID666.length*(long long) SAMPLE_RATE/1000;
 455     unsigned long fadeendsample = (ID666.length+ID666.fade)*(long long) SAMPLE_RATE/1000;
 456     int fadedec = 0;
 457     int fadevol = 0x7fffffffl;
 458
 459     if (fadeendsample>fadestartsample)
 460         fadedec=0x7fffffffl/(fadeendsample-fadestartsample)+1;
 461
 462     ENTER_TIMER(total);
 463
 464     while ( 1 )
 465     {
 466         ci->yield();
 467         if (ci->stop_codec || ci->new_track) {
 468             break;
 469         }
 470
 471         if (ci->seek_time) {
 472             int curtime = sampleswritten*1000LL/SAMPLE_RATE;
 473             DEBUGF("seek to %ld\ncurrently at %d\n",ci->seek_time,curtime);
 474             if (ci->seek_time < curtime) {
 475                 DEBUGF("seek backwards = reset\n");
 476                 ci->seek_complete();
 477                 return 1;
 478             }
 479             ci->seek_complete();
 480         }
 481
 482         int32_t *samples;
 483         if (!spc_play_get_samples(&samples))
 484             break;
 485
 486         sampleswritten += WAV_CHUNK_SIZE;
 487
 488         /* is track timed? */
 489         if (ci->global_settings->repeat_mode!=REPEAT_ONE && ci->id3->length) {
 490             unsigned long curtime = sampleswritten*1000LL/SAMPLE_RATE;
 491             unsigned long lasttimesample = (sampleswritten-WAV_CHUNK_SIZE);
 492
 493             /* fade? */
 494             if (curtime>ID666.length)
 495             {
 496             #ifdef CPU_COLDFIRE
 497                 /* Have to switch modes to do this */
 498                 long macsr = coldfire_get_macsr();
 499                 coldfire_set_macsr(EMAC_SATURATE | EMAC_FRACTIONAL | EMAC_ROUND);
 500             #endif
 501                 int i;
 502                 for (i=0;i<WAV_CHUNK_SIZE;i++) {
 503                     if (lasttimesample+i>fadestartsample) {
 504                         if (fadevol>0) {
 505                             samples[i] = FRACMUL(samples[i], fadevol);
 506                             samples[i+WAV_CHUNK_SIZE] = FRACMUL(samples[i+WAV_CHUNK_SIZE], fadevol);
 507                         } else samples[i]=samples[i+WAV_CHUNK_SIZE]=0;
 508                         fadevol-=fadedec;
 509                     }
 510                 }
 511             #ifdef CPU_COLDFIRE
 512                coldfire_set_macsr(macsr);
 513             #endif
 514             }
 515             /* end? */
 516             if (lasttimesample>=fadeendsample)
 517             {
 518                 samples_release_rdbuf();
 519                 break;
 520             }
 521         }
 522
 523         spc_play_send_samples(samples);
 524
 525         if (ci->global_settings->repeat_mode!=REPEAT_ONE)
 526             ci->set_elapsed(sampleswritten*1000LL/SAMPLE_RATE);
 527         else
 528             ci->set_elapsed(0);
 529     }
 530
 531     EXIT_TIMER(total);
 532     return 0;
 533 }
 534
 535 /* this is the codec entry point */
 536 enum codec_status codec_main(void)
 537 {
 538     enum codec_status stat = CODEC_ERROR;
 539
 540     if (!spc_emu_start())
 541         goto codec_quit;
 542
 543     do
 544     {
 545         DEBUGF("SPC: next_track\n");
 546         if (codec_init()) {
 547             goto codec_quit;
 548         }
 549         DEBUGF("SPC: after init\n");
 550
 551         ci->configure(DSP_SET_SAMPLE_DEPTH, 24);
 552         ci->configure(DSP_SET_FREQUENCY, SAMPLE_RATE);
 553         ci->configure(DSP_SET_STEREO_MODE, STEREO_NONINTERLEAVED);
 554
 555         /* wait for track info to load */
 556         while (!*ci->taginfo_ready && !ci->stop_codec)
 557             ci->yield();
 558
 559         codec_set_replaygain(ci->id3);
 560
 561         /* Read the entire file */
 562         DEBUGF("SPC: request initial buffer\n");
 563         ci->seek_buffer(0);
 564         size_t buffersize;
 565         uint8_t* buffer = ci->request_buffer(&buffersize, ci->filesize);
 566         if (!buffer) {
 567             goto codec_quit;
 568         }
 569
 570         DEBUGF("SPC: read size = 0x%lx\n",(unsigned long)buffersize);
 571         do
 572         {
 573             if (load_spc_buffer(buffer, buffersize)) {
 574                 DEBUGF("SPC load failure\n");
 575                 goto codec_quit;
 576             }
 577
 578             LoadID666(buffer+0x2e);
 579
 580             if (ci->global_settings->repeat_mode!=REPEAT_ONE && ID666.length==0) {
 581                 ID666.length=3*60*1000; /* 3 minutes */
 582                 ID666.fade=5*1000; /* 5 seconds */
 583             }
 584
 585             reset_profile_timers();
 586         }
 587         while ( play_track() );
 588
 589         print_timers(ci->id3->path);
 590     }
 591     while ( ci->request_next_track() );
 592
 593     stat = CODEC_OK;
 594
 595 codec_quit:
 596     spc_emu_quit();
 597
 598     return stat;
 599 }