Fix r29054 red...yeah?
[kugel-rb.git] / apps / playback.c
blobe71e06b92cf8870b772b5e542185ff24cfef331a
1 /***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
10 * Copyright (C) 2005-2007 Miika Pekkarinen
11 * Copyright (C) 2007-2008 Nicolas Pennequin
13 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License
15 * as published by the Free Software Foundation; either version 2
16 * of the License, or (at your option) any later version.
18 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 * KIND, either express or implied.
21 ****************************************************************************/
23 /* TODO: Pause should be handled in here, rather than PCMBUF so that voice can
24 * play whilst audio is paused */
26 #include <string.h>
27 #include "playback.h"
28 #include "codec_thread.h"
29 #include "kernel.h"
30 #include "codecs.h"
31 #include "buffering.h"
32 #include "voice_thread.h"
33 #include "usb.h"
34 #include "ata.h"
35 #include "playlist.h"
36 #include "pcmbuf.h"
37 #include "buffer.h"
38 #include "cuesheet.h"
39 #ifdef HAVE_TAGCACHE
40 #include "tagcache.h"
41 #endif
42 #ifdef HAVE_LCD_BITMAP
43 #ifdef HAVE_ALBUMART
44 #include "albumart.h"
45 #endif
46 #endif
47 #include "sound.h"
48 #include "metadata.h"
49 #include "splash.h"
50 #include "talk.h"
51 #include "panic.h"
53 #ifdef HAVE_RECORDING
54 #include "pcm_record.h"
55 #endif
57 #define PLAYBACK_VOICE
59 /* amount of guess-space to allow for codecs that must hunt and peck
60 * for their correct seeek target, 32k seems a good size */
61 #define AUDIO_REBUFFER_GUESS_SIZE (1024*32)
63 /* Define LOGF_ENABLE to enable logf output in this file */
64 /*#define LOGF_ENABLE*/
65 #include "logf.h"
67 /* macros to enable logf for queues
68 logging on SYS_TIMEOUT can be disabled */
69 #ifdef SIMULATOR
70 /* Define this for logf output of all queuing except SYS_TIMEOUT */
71 #define PLAYBACK_LOGQUEUES
72 /* Define this to logf SYS_TIMEOUT messages */
73 /*#define PLAYBACK_LOGQUEUES_SYS_TIMEOUT*/
74 #endif
76 #ifdef PLAYBACK_LOGQUEUES
77 #define LOGFQUEUE logf
78 #else
79 #define LOGFQUEUE(...)
80 #endif
82 #ifdef PLAYBACK_LOGQUEUES_SYS_TIMEOUT
83 #define LOGFQUEUE_SYS_TIMEOUT logf
84 #else
85 #define LOGFQUEUE_SYS_TIMEOUT(...)
86 #endif
89 static enum filling_state {
90 STATE_IDLE, /* audio is stopped: nothing to do */
91 STATE_FILLING, /* adding tracks to the buffer */
92 STATE_FULL, /* can't add any more tracks */
93 STATE_END_OF_PLAYLIST, /* all remaining tracks have been added */
94 STATE_FINISHED, /* all remaining tracks are fully buffered */
95 } filling;
97 /* As defined in plugins/lib/xxx2wav.h */
98 #define GUARD_BUFSIZE (32*1024)
100 bool audio_is_initialized = false;
101 static bool audio_thread_ready SHAREDBSS_ATTR = false;
103 /* Variables are commented with the threads that use them: *
104 * A=audio, C=codec, V=voice. A suffix of - indicates that *
105 * the variable is read but not updated on that thread. */
106 /* TBD: Split out "audio" and "playback" (ie. calling) threads */
108 /* Main state control */
109 static volatile bool playing SHAREDBSS_ATTR = false;/* Is audio playing? (A) */
110 static volatile bool paused SHAREDBSS_ATTR = false; /* Is audio paused? (A/C-) */
111 extern volatile bool audio_codec_loaded; /* Codec loaded? (C/A-) */
113 /* Ring buffer where compressed audio and codecs are loaded */
114 static unsigned char *filebuf = NULL; /* Start of buffer (A/C-) */
115 static unsigned char *malloc_buf = NULL; /* Start of malloc buffer (A/C-) */
116 static size_t filebuflen = 0; /* Size of buffer (A/C-) */
117 /* FIXME: make buf_ridx (C/A-) */
119 /* Possible arrangements of the buffer */
120 enum audio_buffer_state
122 AUDIOBUF_STATE_TRASHED = -1, /* trashed; must be reset */
123 AUDIOBUF_STATE_INITIALIZED = 0, /* voice+audio OR audio-only */
124 AUDIOBUF_STATE_VOICED_ONLY = 1, /* voice-only */
126 static int buffer_state = AUDIOBUF_STATE_TRASHED; /* Buffer state */
128 /* These are used to store the current and next (or prev if the current is the last)
129 * mp3entry's in a round-robin system. This guarentees that the pointer returned
130 * by audio_current/next_track will be valid for the full duration of the
131 * currently playing track */
132 static struct mp3entry mp3entry_buf[2];
133 struct mp3entry *thistrack_id3, /* the currently playing track */
134 *othertrack_id3; /* prev track during track-change-transition, or end of playlist,
135 * next track otherwise */
136 static struct mp3entry unbuffered_id3; /* the id3 for the first unbuffered track */
138 /* for cuesheet support */
139 static struct cuesheet *curr_cue = NULL;
142 #define MAX_MULTIPLE_AA SKINNABLE_SCREENS_COUNT
144 #ifdef HAVE_ALBUMART
145 static struct albumart_slot {
146 struct dim dim; /* holds width, height of the albumart */
147 int used; /* counter, increments if something uses it */
148 } albumart_slots[MAX_MULTIPLE_AA];
150 #define FOREACH_ALBUMART(i) for(i = 0;i < MAX_MULTIPLE_AA; i++)
151 #endif
154 #define MAX_TRACK 128
155 #define MAX_TRACK_MASK (MAX_TRACK-1)
157 /* Track info structure about songs in the file buffer (A/C-) */
158 static struct track_info {
159 int audio_hid; /* The ID for the track's buffer handle */
160 int id3_hid; /* The ID for the track's metadata handle */
161 int codec_hid; /* The ID for the track's codec handle */
162 #ifdef HAVE_ALBUMART
163 int aa_hid[MAX_MULTIPLE_AA];/* The ID for the track's album art handle */
164 #endif
165 int cuesheet_hid; /* The ID for the track's parsed cueesheet handle */
167 size_t filesize; /* File total length */
169 bool taginfo_ready; /* Is metadata read */
171 } tracks[MAX_TRACK];
173 static volatile int track_ridx = 0; /* Track being decoded (A/C-) */
174 static int track_widx = 0; /* Track being buffered (A) */
175 #define CUR_TI (&tracks[track_ridx]) /* Playing track info pointer (A/C-) */
177 static struct track_info *prev_ti = NULL; /* Pointer to the previously played
178 track */
180 /* Information used only for filling the buffer */
181 /* Playlist steps from playing track to next track to be buffered (A) */
182 static int last_peek_offset = 0;
184 /* Scrobbler support */
185 static unsigned long prev_track_elapsed = 0; /* Previous track elapsed time (C/A-)*/
187 /* Track change controls */
188 bool automatic_skip = false; /* Who initiated in-progress skip? (C/A-) */
189 extern bool track_transition; /* Are we in a track transition? */
190 static bool dir_skip = false; /* Is a directory skip pending? (A) */
191 static bool new_playlist = false; /* Are we starting a new playlist? (A) */
192 static int wps_offset = 0; /* Pending track change offset, to keep WPS responsive (A) */
193 static bool skipped_during_pause = false; /* Do we need to clear the PCM buffer when playback resumes (A) */
195 static bool start_play_g = false; /* Used by audio_load_track to notify
196 audio_finish_load_track about start_play */
198 /* True when a track load is in progress, i.e. audio_load_track() has returned
199 * but audio_finish_load_track() hasn't been called yet. Used to avoid allowing
200 * audio_load_track() to get called twice in a row, which would cause problems.
202 static bool track_load_started = false;
204 #ifdef HAVE_DISK_STORAGE
205 static size_t buffer_margin = 5; /* Buffer margin aka anti-skip buffer (A/C-) */
206 #endif
208 /* Event queues */
209 struct event_queue audio_queue SHAREDBSS_ATTR;
210 struct event_queue codec_queue SHAREDBSS_ATTR;
211 static struct event_queue pcmbuf_queue SHAREDBSS_ATTR;
213 extern struct codec_api ci;
214 extern unsigned int codec_thread_id;
216 /* Multiple threads */
217 /* Set the watermark to trigger buffer fill (A/C) */
218 static void set_filebuf_watermark(void);
220 /* Audio thread */
221 static struct queue_sender_list audio_queue_sender_list SHAREDBSS_ATTR;
222 static long audio_stack[(DEFAULT_STACK_SIZE + 0x1000)/sizeof(long)];
223 static const char audio_thread_name[] = "audio";
225 static void audio_thread(void);
226 static void audio_initiate_track_change(long direction);
227 static bool audio_have_tracks(void);
228 static void audio_reset_buffer(void);
229 static void audio_stop_playback(void);
232 /**************************************/
235 /** Pcmbuf callbacks */
237 /* Between the codec and PCM track change, we need to keep updating the
238 * "elapsed" value of the previous (to the codec, but current to the
239 * user/PCM/WPS) track, so that the progressbar reaches the end.
240 * During that transition, the WPS will display othertrack_id3. */
241 void audio_pcmbuf_position_callback(unsigned int time)
243 time += othertrack_id3->elapsed;
245 if (time >= othertrack_id3->length)
247 /* we just played the end of the track, so stop this callback */
248 track_transition = false;
249 othertrack_id3->elapsed = othertrack_id3->length;
251 else
252 othertrack_id3->elapsed = time;
255 /* Post message from pcmbuf that the end of the previous track
256 * has just been played. */
257 void audio_post_track_change(bool pcmbuf)
259 if (pcmbuf)
261 LOGFQUEUE("pcmbuf > pcmbuf Q_AUDIO_TRACK_CHANGED");
262 queue_post(&pcmbuf_queue, Q_AUDIO_TRACK_CHANGED, 0);
264 else
266 LOGFQUEUE("pcmbuf > audio Q_AUDIO_TRACK_CHANGED");
267 queue_post(&audio_queue, Q_AUDIO_TRACK_CHANGED, 0);
271 /* Scan the pcmbuf queue and return true if a message pulled */
272 static bool pcmbuf_queue_scan(struct queue_event *ev)
274 if (!queue_empty(&pcmbuf_queue))
276 /* Transfer message to audio queue */
277 pcm_play_lock();
278 /* Pull message - never, ever any blocking call! */
279 queue_wait_w_tmo(&pcmbuf_queue, ev, 0);
280 pcm_play_unlock();
281 return true;
284 return false;
288 /** Helper functions */
290 static struct mp3entry *bufgetid3(int handle_id)
292 if (handle_id < 0)
293 return NULL;
295 struct mp3entry *id3;
296 ssize_t ret = bufgetdata(handle_id, 0, (void *)&id3);
298 if (ret < 0 || ret != sizeof(struct mp3entry))
299 return NULL;
301 return id3;
304 static bool clear_track_info(struct track_info *track)
306 /* bufclose returns true if the handle is not found, or if it is closed
307 * successfully, so these checks are safe on non-existant handles */
308 if (!track)
309 return false;
311 if (track->codec_hid >= 0) {
312 if (bufclose(track->codec_hid))
313 track->codec_hid = -1;
314 else
315 return false;
318 if (track->id3_hid >= 0) {
319 if (bufclose(track->id3_hid))
320 track->id3_hid = -1;
321 else
322 return false;
325 if (track->audio_hid >= 0) {
326 if (bufclose(track->audio_hid))
327 track->audio_hid = -1;
328 else
329 return false;
332 #ifdef HAVE_ALBUMART
334 int i;
335 FOREACH_ALBUMART(i)
337 if (track->aa_hid[i] >= 0) {
338 if (bufclose(track->aa_hid[i]))
339 track->aa_hid[i] = -1;
340 else
341 return false;
345 #endif
347 if (track->cuesheet_hid >= 0) {
348 if (bufclose(track->cuesheet_hid))
349 track->cuesheet_hid = -1;
350 else
351 return false;
354 track->filesize = 0;
355 track->taginfo_ready = false;
357 return true;
360 /* --- External interfaces --- */
362 /* This sends a stop message and the audio thread will dump all it's
363 subsequenct messages */
364 void audio_hard_stop(void)
366 /* Stop playback */
367 LOGFQUEUE("audio >| audio Q_AUDIO_STOP: 1");
368 queue_send(&audio_queue, Q_AUDIO_STOP, 1);
369 #ifdef PLAYBACK_VOICE
370 voice_stop();
371 #endif
374 bool audio_restore_playback(int type)
376 switch (type)
378 case AUDIO_WANT_PLAYBACK:
379 if (buffer_state != AUDIOBUF_STATE_INITIALIZED)
380 audio_reset_buffer();
381 return true;
382 case AUDIO_WANT_VOICE:
383 if (buffer_state == AUDIOBUF_STATE_TRASHED)
384 audio_reset_buffer();
385 return true;
386 default:
387 return false;
391 unsigned char *audio_get_buffer(bool talk_buf, size_t *buffer_size)
393 unsigned char *buf, *end;
395 if (audio_is_initialized)
397 audio_hard_stop();
399 /* else buffer_state will be AUDIOBUF_STATE_TRASHED at this point */
401 /* Reset the buffering thread so that it doesn't try to use the data */
402 buffering_reset(filebuf, filebuflen);
404 if (buffer_size == NULL)
406 /* Special case for talk_init to use since it already knows it's
407 trashed */
408 buffer_state = AUDIOBUF_STATE_TRASHED;
409 return NULL;
412 if (talk_buf || buffer_state == AUDIOBUF_STATE_TRASHED
413 || !talk_voice_required())
415 logf("get buffer: talk, audio");
416 /* Ok to use everything from audiobuf to audiobufend - voice is loaded,
417 the talk buffer is not needed because voice isn't being used, or
418 could be AUDIOBUF_STATE_TRASHED already. If state is
419 AUDIOBUF_STATE_VOICED_ONLY, no problem as long as memory isn't written
420 without the caller knowing what's going on. Changing certain settings
421 may move it to a worse condition but the memory in use by something
422 else will remain undisturbed.
424 if (buffer_state != AUDIOBUF_STATE_TRASHED)
426 talk_buffer_steal();
427 buffer_state = AUDIOBUF_STATE_TRASHED;
430 buf = audiobuf;
431 end = audiobufend;
433 else
435 /* Safe to just return this if already AUDIOBUF_STATE_VOICED_ONLY or
436 still AUDIOBUF_STATE_INITIALIZED */
437 /* Skip talk buffer and move pcm buffer to end to maximize available
438 contiguous memory - no audio running means voice will not need the
439 swap space */
440 logf("get buffer: audio");
441 buf = audiobuf + talk_get_bufsize();
442 end = audiobufend - pcmbuf_init(audiobufend);
443 buffer_state = AUDIOBUF_STATE_VOICED_ONLY;
446 *buffer_size = end - buf;
448 return buf;
451 bool audio_buffer_state_trashed(void)
453 return buffer_state == AUDIOBUF_STATE_TRASHED;
456 #ifdef HAVE_RECORDING
457 unsigned char *audio_get_recording_buffer(size_t *buffer_size)
459 /* Stop audio, voice and obtain all available buffer space */
460 audio_hard_stop();
461 talk_buffer_steal();
463 unsigned char *end = audiobufend;
464 buffer_state = AUDIOBUF_STATE_TRASHED;
465 *buffer_size = end - audiobuf;
467 return (unsigned char *)audiobuf;
470 bool audio_load_encoder(int afmt)
472 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
473 const char *enc_fn = get_codec_filename(afmt | CODEC_TYPE_ENCODER);
474 if (!enc_fn)
475 return false;
477 audio_remove_encoder();
478 ci.enc_codec_loaded = 0; /* clear any previous error condition */
480 LOGFQUEUE("codec > Q_ENCODER_LOAD_DISK");
481 queue_post(&codec_queue, Q_ENCODER_LOAD_DISK, (intptr_t)enc_fn);
483 while (ci.enc_codec_loaded == 0)
484 yield();
486 logf("codec loaded: %d", ci.enc_codec_loaded);
488 return ci.enc_codec_loaded > 0;
489 #else
490 (void)afmt;
491 return true;
492 #endif
493 } /* audio_load_encoder */
495 void audio_remove_encoder(void)
497 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
498 /* force encoder codec unload (if currently loaded) */
499 if (ci.enc_codec_loaded <= 0)
500 return;
502 ci.stop_encoder = true;
503 while (ci.enc_codec_loaded > 0)
504 yield();
505 #endif
506 } /* audio_remove_encoder */
508 #endif /* HAVE_RECORDING */
511 struct mp3entry* audio_current_track(void)
513 const char *filename;
514 struct playlist_track_info trackinfo;
515 int cur_idx;
516 int offset = ci.new_track + wps_offset;
517 struct mp3entry *write_id3;
519 cur_idx = (track_ridx + offset) & MAX_TRACK_MASK;
521 if (cur_idx == track_ridx && *thistrack_id3->path)
523 /* The usual case */
524 if (tracks[cur_idx].cuesheet_hid >= 0 && !thistrack_id3->cuesheet)
526 bufread(tracks[cur_idx].cuesheet_hid, sizeof(struct cuesheet), curr_cue);
527 thistrack_id3->cuesheet = curr_cue;
529 return thistrack_id3;
531 else if (automatic_skip && offset == -1 && *othertrack_id3->path)
533 /* We're in a track transition. The codec has moved on to the next track,
534 but the audio being played is still the same (now previous) track.
535 othertrack_id3.elapsed is being updated in an ISR by
536 codec_pcmbuf_position_callback */
537 if (tracks[cur_idx].cuesheet_hid >= 0 && !thistrack_id3->cuesheet)
539 bufread(tracks[cur_idx].cuesheet_hid, sizeof(struct cuesheet), curr_cue);
540 othertrack_id3->cuesheet = curr_cue;
542 return othertrack_id3;
545 if (offset != 0)
547 /* Codec may be using thistrack_id3, so it must not be overwritten.
548 If this is a manual skip, othertrack_id3 will become
549 thistrack_id3 in audio_check_new_track().
550 FIXME: If this is an automatic skip, it probably means multiple
551 short tracks fit in the PCM buffer. Overwriting othertrack_id3
552 can lead to an incorrect value later.
553 Note that othertrack_id3 may also be used for next track.
555 write_id3 = othertrack_id3;
557 else
559 write_id3 = thistrack_id3;
562 if (tracks[cur_idx].id3_hid >= 0)
564 /* The current track's info has been buffered but not read yet, so get it */
565 if (bufread(tracks[cur_idx].id3_hid, sizeof(struct mp3entry), write_id3)
566 == sizeof(struct mp3entry))
567 return write_id3;
570 /* We didn't find the ID3 metadata, so we fill temp_id3 with the little info
571 we have and return that. */
573 memset(write_id3, 0, sizeof(struct mp3entry));
575 playlist_get_track_info(NULL, playlist_next(0)+wps_offset, &trackinfo);
576 filename = trackinfo.filename;
577 if (!filename)
578 filename = "No file!";
580 #if defined(HAVE_TC_RAMCACHE) && defined(HAVE_DIRCACHE)
581 if (tagcache_fill_tags(write_id3, filename))
582 return write_id3;
583 #endif
585 strlcpy(write_id3->path, filename, sizeof(write_id3->path));
586 write_id3->title = strrchr(write_id3->path, '/');
587 if (!write_id3->title)
588 write_id3->title = &write_id3->path[0];
589 else
590 write_id3->title++;
592 return write_id3;
595 struct mp3entry* audio_next_track(void)
597 int next_idx;
598 int offset = ci.new_track + wps_offset;
600 if (!audio_have_tracks())
601 return NULL;
603 if (wps_offset == -1 && *thistrack_id3->path)
605 /* We're in a track transition. The next track for the WPS is the one
606 currently being decoded. */
607 return thistrack_id3;
610 next_idx = (track_ridx + offset + 1) & MAX_TRACK_MASK;
612 if (tracks[next_idx].id3_hid >= 0)
614 if (bufread(tracks[next_idx].id3_hid, sizeof(struct mp3entry), othertrack_id3)
615 == sizeof(struct mp3entry))
616 return othertrack_id3;
617 else
618 return NULL;
621 if (next_idx == track_widx)
623 /* The next track hasn't been buffered yet, so we return the static
624 version of its metadata. */
625 return &unbuffered_id3;
628 return NULL;
631 /* gets a pointer to the id3 data, Not thread safe!, DON'T yield()/sleep() */
632 bool audio_peek_track(struct mp3entry** id3, int offset)
634 int next_idx;
635 int new_offset = ci.new_track + wps_offset + offset;
637 if (!audio_have_tracks())
638 return false;
639 next_idx = (track_ridx + new_offset) & MAX_TRACK_MASK;
641 if (tracks[next_idx].id3_hid >= 0)
643 return bufgetdata(tracks[next_idx].id3_hid, 0, (void**)id3)
644 == sizeof(struct mp3entry);
646 return false;
649 #ifdef HAVE_ALBUMART
650 int playback_current_aa_hid(int slot)
652 if (slot < 0)
653 return -1;
654 int cur_idx;
655 int offset = ci.new_track + wps_offset;
657 cur_idx = track_ridx + offset;
658 cur_idx &= MAX_TRACK_MASK;
660 return tracks[cur_idx].aa_hid[slot];
663 int playback_claim_aa_slot(struct dim *dim)
665 int i;
666 /* first try to find a slot already having the size to reuse it
667 * since we don't want albumart of the same size buffered multiple times */
668 FOREACH_ALBUMART(i)
670 struct albumart_slot *slot = &albumart_slots[i];
671 if (slot->dim.width == dim->width
672 && slot->dim.height == dim->height)
674 slot->used++;
675 return i;
678 /* size is new, find a free slot */
679 FOREACH_ALBUMART(i)
681 if (!albumart_slots[i].used)
683 albumart_slots[i].used++;
684 albumart_slots[i].dim = *dim;
685 return i;
688 /* sorry, no free slot */
689 return -1;
692 void playback_release_aa_slot(int slot)
694 /* invalidate the albumart_slot */
695 struct albumart_slot *aa_slot = &albumart_slots[slot];
696 if (aa_slot->used > 0)
697 aa_slot->used--;
700 #endif
701 void audio_play(long offset)
703 logf("audio_play");
705 #ifdef PLAYBACK_VOICE
706 /* Truncate any existing voice output so we don't have spelling
707 * etc. over the first part of the played track */
708 talk_force_shutup();
709 #endif
711 /* Start playback */
712 LOGFQUEUE("audio >| audio Q_AUDIO_PLAY: %ld", offset);
713 /* Don't return until playback has actually started */
714 queue_send(&audio_queue, Q_AUDIO_PLAY, offset);
717 void audio_stop(void)
719 /* Stop playback */
720 LOGFQUEUE("audio >| audio Q_AUDIO_STOP");
721 /* Don't return until playback has actually stopped */
722 queue_send(&audio_queue, Q_AUDIO_STOP, 0);
725 void audio_pause(void)
727 LOGFQUEUE("audio >| audio Q_AUDIO_PAUSE");
728 /* Don't return until playback has actually paused */
729 queue_send(&audio_queue, Q_AUDIO_PAUSE, true);
732 void audio_resume(void)
734 LOGFQUEUE("audio >| audio Q_AUDIO_PAUSE resume");
735 /* Don't return until playback has actually resumed */
736 queue_send(&audio_queue, Q_AUDIO_PAUSE, false);
739 void audio_skip(int direction)
741 if (playlist_check(ci.new_track + wps_offset + direction))
743 if (global_settings.beep)
744 pcmbuf_beep(2000, 100, 2500*global_settings.beep);
746 LOGFQUEUE("audio > audio Q_AUDIO_SKIP %d", direction);
747 queue_post(&audio_queue, Q_AUDIO_SKIP, direction);
748 /* Update wps while our message travels inside deep playback queues. */
749 wps_offset += direction;
751 else
753 /* No more tracks. */
754 if (global_settings.beep)
755 pcmbuf_beep(1000, 100, 1500*global_settings.beep);
759 void audio_next(void)
761 audio_skip(1);
764 void audio_prev(void)
766 audio_skip(-1);
769 void audio_next_dir(void)
771 LOGFQUEUE("audio > audio Q_AUDIO_DIR_SKIP 1");
772 queue_post(&audio_queue, Q_AUDIO_DIR_SKIP, 1);
775 void audio_prev_dir(void)
777 LOGFQUEUE("audio > audio Q_AUDIO_DIR_SKIP -1");
778 queue_post(&audio_queue, Q_AUDIO_DIR_SKIP, -1);
781 void audio_pre_ff_rewind(void)
783 LOGFQUEUE("audio > audio Q_AUDIO_PRE_FF_REWIND");
784 queue_post(&audio_queue, Q_AUDIO_PRE_FF_REWIND, 0);
787 void audio_ff_rewind(long newpos)
789 LOGFQUEUE("audio > audio Q_AUDIO_FF_REWIND");
790 queue_post(&audio_queue, Q_AUDIO_FF_REWIND, newpos);
793 void audio_flush_and_reload_tracks(void)
795 LOGFQUEUE("audio > audio Q_AUDIO_FLUSH");
796 queue_post(&audio_queue, Q_AUDIO_FLUSH, 0);
799 void audio_error_clear(void)
801 #ifdef AUDIO_HAVE_RECORDING
802 pcm_rec_error_clear();
803 #endif
806 int audio_status(void)
808 int ret = 0;
810 if (playing)
811 ret |= AUDIO_STATUS_PLAY;
813 if (paused)
814 ret |= AUDIO_STATUS_PAUSE;
816 #ifdef HAVE_RECORDING
817 /* Do this here for constitency with mpeg.c version */
818 /* FIXME: pcm_rec_status() is deprecated */
819 ret |= pcm_rec_status();
820 #endif
822 return ret;
825 int audio_get_file_pos(void)
827 return 0;
830 #ifdef HAVE_DISK_STORAGE
831 void audio_set_buffer_margin(int setting)
833 static const unsigned short lookup[] = {5, 15, 30, 60, 120, 180, 300, 600};
834 buffer_margin = lookup[setting];
835 logf("buffer margin: %ld", (long)buffer_margin);
836 set_filebuf_watermark();
838 #endif
840 #ifdef HAVE_CROSSFADE
841 /* Take necessary steps to enable or disable the crossfade setting */
842 void audio_set_crossfade(int enable)
844 size_t offset;
845 bool was_playing;
846 size_t size;
848 /* Tell it the next setting to use */
849 pcmbuf_request_crossfade_enable(enable);
851 /* Return if size hasn't changed or this is too early to determine
852 which in the second case there's no way we could be playing
853 anything at all */
854 if (pcmbuf_is_same_size()) return;
856 offset = 0;
857 was_playing = playing;
859 /* Playback has to be stopped before changing the buffer size */
860 if (was_playing)
862 /* Store the track resume position */
863 offset = thistrack_id3->offset;
866 /* Blast it - audio buffer will have to be setup again next time
867 something plays */
868 audio_get_buffer(true, &size);
870 /* Restart playback if audio was running previously */
871 if (was_playing)
872 audio_play(offset);
874 #endif
876 /* --- Routines called from multiple threads --- */
878 static void set_filebuf_watermark(void)
880 if (!filebuf)
881 return; /* Audio buffers not yet set up */
883 #ifdef HAVE_DISK_STORAGE
884 int seconds;
885 int spinup = ata_spinup_time();
886 if (spinup)
887 seconds = (spinup / HZ) + 1;
888 else
889 seconds = 5;
891 seconds += buffer_margin;
892 #else
893 /* flash storage */
894 int seconds = 1;
895 #endif
897 /* bitrate of last track in buffer dictates watermark */
898 struct mp3entry* id3 = NULL;
899 if (tracks[track_widx].taginfo_ready)
900 id3 = bufgetid3(tracks[track_widx].id3_hid);
901 else
902 id3 = bufgetid3(tracks[track_widx-1].id3_hid);
903 if (!id3) {
904 logf("fwmark: No id3 for last track (r%d/w%d), aborting!", track_ridx, track_widx);
905 return;
907 size_t bytes = id3->bitrate * (1000/8) * seconds;
908 buf_set_watermark(bytes);
909 logf("fwmark: %d", bytes);
912 /* --- Buffering callbacks --- */
914 static void buffering_low_buffer_callback(void *data)
916 (void)data;
917 logf("low buffer callback");
919 if (filling == STATE_FULL || filling == STATE_END_OF_PLAYLIST) {
920 /* force a refill */
921 LOGFQUEUE("buffering > audio Q_AUDIO_FILL_BUFFER");
922 queue_post(&audio_queue, Q_AUDIO_FILL_BUFFER, 0);
926 static void buffering_handle_rebuffer_callback(void *data)
928 (void)data;
929 LOGFQUEUE("audio >| audio Q_AUDIO_FLUSH");
930 queue_post(&audio_queue, Q_AUDIO_FLUSH, 0);
933 static void buffering_handle_finished_callback(void *data)
935 logf("handle %d finished buffering", *(int*)data);
936 int hid = (*(int*)data);
938 if (hid == tracks[track_widx].id3_hid)
940 int offset = ci.new_track + wps_offset;
941 int next_idx = (track_ridx + offset + 1) & MAX_TRACK_MASK;
942 /* The metadata handle for the last loaded track has been buffered.
943 We can ask the audio thread to load the rest of the track's data. */
944 LOGFQUEUE("audio >| audio Q_AUDIO_FINISH_LOAD");
945 queue_post(&audio_queue, Q_AUDIO_FINISH_LOAD, 0);
946 if (tracks[next_idx].id3_hid == hid)
947 send_event(PLAYBACK_EVENT_NEXTTRACKID3_AVAILABLE, NULL);
949 else
951 /* This is most likely an audio handle, so we strip the useless
952 trailing tags that are left. */
953 strip_tags(hid);
955 if (hid == tracks[track_widx-1].audio_hid
956 && filling == STATE_END_OF_PLAYLIST)
958 /* This was the last track in the playlist.
959 We now have all the data we need. */
960 logf("last track finished buffering");
961 filling = STATE_FINISHED;
967 /* --- Audio thread --- */
969 static bool audio_have_tracks(void)
971 return (audio_track_count() != 0);
974 static int audio_free_track_count(void)
976 /* Used tracks + free tracks adds up to MAX_TRACK - 1 */
977 return MAX_TRACK - 1 - audio_track_count();
980 int audio_track_count(void)
982 /* Calculate difference from track_ridx to track_widx
983 * taking into account a possible wrap-around. */
984 return (MAX_TRACK + track_widx - track_ridx) & MAX_TRACK_MASK;
987 long audio_filebufused(void)
989 return (long) buf_used();
992 /* Update track info after successful a codec track change */
993 static void audio_update_trackinfo(void)
995 bool resume = false;
997 /* Load the curent track's metadata into curtrack_id3 */
998 if (CUR_TI->id3_hid >= 0)
999 copy_mp3entry(thistrack_id3, bufgetid3(CUR_TI->id3_hid));
1001 /* Reset current position */
1002 thistrack_id3->elapsed = 0;
1004 #ifdef HAVE_TAGCACHE
1005 /* Resume all manually selected tracks if so configured */
1006 resume = global_settings.autoresume_enable && !automatic_skip;
1007 #endif
1009 if (!resume)
1011 thistrack_id3->offset = 0;
1014 logf("audio_update_trackinfo: Set offset for %s to %lX\n",
1015 thistrack_id3->title, thistrack_id3->offset);
1017 /* Update the codec API */
1018 ci.filesize = CUR_TI->filesize;
1019 ci.id3 = thistrack_id3;
1020 ci.curpos = 0;
1021 ci.taginfo_ready = &CUR_TI->taginfo_ready;
1024 /* Clear tracks between write and read, non inclusive */
1025 static void audio_clear_track_entries(void)
1027 int cur_idx = track_widx;
1029 logf("Clearing tracks: r%d/w%d", track_ridx, track_widx);
1031 /* Loop over all tracks from write-to-read */
1032 while (1)
1034 cur_idx = (cur_idx + 1) & MAX_TRACK_MASK;
1036 if (cur_idx == track_ridx)
1037 break;
1039 clear_track_info(&tracks[cur_idx]);
1043 /* Clear all tracks */
1044 static bool audio_release_tracks(void)
1046 int i, cur_idx;
1048 logf("releasing all tracks");
1050 for(i = 0; i < MAX_TRACK; i++)
1052 cur_idx = (track_ridx + i) & MAX_TRACK_MASK;
1053 if (!clear_track_info(&tracks[cur_idx]))
1054 return false;
1057 return true;
1060 static bool audio_loadcodec(bool start_play)
1062 int prev_track;
1063 char codec_path[MAX_PATH]; /* Full path to codec */
1064 const struct mp3entry *id3, *prev_id3;
1066 if (tracks[track_widx].id3_hid < 0) {
1067 return false;
1070 id3 = bufgetid3(tracks[track_widx].id3_hid);
1071 if (!id3)
1072 return false;
1074 const char *codec_fn = get_codec_filename(id3->codectype);
1075 if (codec_fn == NULL)
1076 return false;
1078 tracks[track_widx].codec_hid = -1;
1080 if (start_play)
1082 /* Load the codec directly from disk and save some memory. */
1083 track_ridx = track_widx;
1084 ci.filesize = CUR_TI->filesize;
1085 ci.id3 = thistrack_id3;
1086 ci.taginfo_ready = &CUR_TI->taginfo_ready;
1087 ci.curpos = 0;
1088 LOGFQUEUE("codec > codec Q_CODEC_LOAD_DISK");
1089 queue_post(&codec_queue, Q_CODEC_LOAD_DISK, (intptr_t)codec_fn);
1090 return true;
1092 else
1094 /* If we already have another track than this one buffered */
1095 if (track_widx != track_ridx)
1097 prev_track = (track_widx - 1) & MAX_TRACK_MASK;
1099 id3 = bufgetid3(tracks[track_widx].id3_hid);
1100 prev_id3 = bufgetid3(tracks[prev_track].id3_hid);
1102 /* If the previous codec is the same as this one, there is no need
1103 * to put another copy of it on the file buffer */
1104 if (id3 && prev_id3 &&
1105 get_codec_base_type(id3->codectype) ==
1106 get_codec_base_type(prev_id3->codectype)
1107 && audio_codec_loaded)
1109 logf("Reusing prev. codec");
1110 return true;
1115 codec_get_full_path(codec_path, codec_fn);
1117 tracks[track_widx].codec_hid = bufopen(codec_path, 0, TYPE_CODEC, NULL);
1118 if (tracks[track_widx].codec_hid < 0)
1119 return false;
1121 logf("Loaded codec");
1123 return true;
1126 /* Load metadata for the next track (with bufopen). The rest of the track
1127 loading will be handled by audio_finish_load_track once the metadata has been
1128 actually loaded by the buffering thread. */
1129 static bool audio_load_track(size_t offset, bool start_play)
1131 char name_buf[MAX_PATH + 1];
1132 const char *trackname;
1133 int fd = -1;
1135 if (track_load_started) {
1136 /* There is already a track load in progress, so track_widx hasn't been
1137 incremented yet. Loading another track would overwrite the one that
1138 hasn't finished loading. */
1139 logf("audio_load_track(): a track load is already in progress");
1140 return false;
1143 start_play_g = start_play; /* will be read by audio_finish_load_track */
1145 /* Stop buffer filling if there is no free track entries.
1146 Don't fill up the last track entry (we wan't to store next track
1147 metadata there). */
1148 if (!audio_free_track_count())
1150 logf("No free tracks");
1151 return false;
1154 last_peek_offset++;
1155 tracks[track_widx].taginfo_ready = false;
1157 logf("Buffering track: r%d/w%d", track_ridx, track_widx);
1158 /* Get track name from current playlist read position. */
1159 while ((trackname = playlist_peek(last_peek_offset, name_buf,
1160 sizeof(name_buf))) != NULL)
1162 /* Handle broken playlists. */
1163 fd = open(trackname, O_RDONLY);
1164 if (fd < 0)
1166 logf("Open failed");
1167 /* Skip invalid entry from playlist. */
1168 playlist_skip_entry(NULL, last_peek_offset);
1170 else
1171 break;
1174 if (!trackname)
1176 logf("End-of-playlist");
1177 memset(&unbuffered_id3, 0, sizeof(struct mp3entry));
1178 filling = STATE_END_OF_PLAYLIST;
1180 if (thistrack_id3->length == 0 && thistrack_id3->filesize == 0)
1182 /* Stop playback if no valid track was found. */
1183 audio_stop_playback();
1186 return false;
1189 tracks[track_widx].filesize = filesize(fd);
1191 if (offset > tracks[track_widx].filesize)
1192 offset = 0;
1194 /* Set default values */
1195 if (start_play)
1197 buf_set_watermark(filebuflen/2);
1198 dsp_configure(ci.dsp, DSP_RESET, 0);
1199 playlist_update_resume_info(audio_current_track());
1202 /* Get track metadata if we don't already have it. */
1203 if (tracks[track_widx].id3_hid < 0)
1205 tracks[track_widx].id3_hid = bufopen(trackname, 0, TYPE_ID3, NULL);
1207 if (tracks[track_widx].id3_hid < 0)
1209 /* Buffer is full. */
1210 get_metadata(&unbuffered_id3, fd, trackname);
1211 last_peek_offset--;
1212 close(fd);
1213 logf("buffer is full for now (get metadata)");
1214 filling = STATE_FULL;
1215 return false;
1218 if (track_widx == track_ridx)
1220 /* TODO: Superfluos buffering call? */
1221 buf_request_buffer_handle(tracks[track_widx].id3_hid);
1222 struct mp3entry *id3 = bufgetid3(tracks[track_widx].id3_hid);
1223 if (id3)
1225 copy_mp3entry(thistrack_id3, id3);
1226 thistrack_id3->offset = offset;
1227 logf("audio_load_track: set offset for %s to %lX\n",
1228 thistrack_id3->title,
1229 offset);
1231 else
1232 memset(thistrack_id3, 0, sizeof(struct mp3entry));
1235 if (start_play)
1237 playlist_update_resume_info(audio_current_track());
1241 close(fd);
1242 track_load_started = true; /* Remember that we've started loading a track */
1243 return true;
1246 /* Second part of the track loading: We now have the metadata available, so we
1247 can load the codec, the album art and finally the audio data.
1248 This is called on the audio thread after the buffering thread calls the
1249 buffering_handle_finished_callback callback. */
1250 static void audio_finish_load_track(void)
1252 size_t file_offset = 0;
1253 size_t offset = 0;
1254 bool start_play = start_play_g;
1256 track_load_started = false;
1258 if (tracks[track_widx].id3_hid < 0) {
1259 logf("No metadata");
1260 return;
1263 struct mp3entry *track_id3;
1265 if (track_widx == track_ridx)
1266 track_id3 = thistrack_id3;
1267 else
1268 track_id3 = bufgetid3(tracks[track_widx].id3_hid);
1270 if (track_id3->length == 0 && track_id3->filesize == 0)
1272 logf("audio_finish_load_track: invalid metadata");
1274 /* Invalid metadata */
1275 bufclose(tracks[track_widx].id3_hid);
1276 tracks[track_widx].id3_hid = -1;
1278 /* Skip invalid entry from playlist. */
1279 playlist_skip_entry(NULL, last_peek_offset--);
1281 /* load next track */
1282 LOGFQUEUE("audio > audio Q_AUDIO_FILL_BUFFER %d", (int)start_play);
1283 queue_post(&audio_queue, Q_AUDIO_FILL_BUFFER, start_play);
1285 return;
1287 /* Try to load a cuesheet for the track */
1288 if (curr_cue)
1290 char cuepath[MAX_PATH];
1291 if (look_for_cuesheet_file(track_id3->path, cuepath))
1293 void *temp;
1294 tracks[track_widx].cuesheet_hid =
1295 bufalloc(NULL, sizeof(struct cuesheet), TYPE_CUESHEET);
1296 if (tracks[track_widx].cuesheet_hid >= 0)
1298 bufgetdata(tracks[track_widx].cuesheet_hid,
1299 sizeof(struct cuesheet), &temp);
1300 struct cuesheet *cuesheet = (struct cuesheet*)temp;
1301 if (!parse_cuesheet(cuepath, cuesheet))
1303 bufclose(tracks[track_widx].cuesheet_hid);
1304 track_id3->cuesheet = NULL;
1309 #ifdef HAVE_ALBUMART
1311 int i;
1312 char aa_path[MAX_PATH];
1313 FOREACH_ALBUMART(i)
1315 /* albumart_slots may change during a yield of bufopen,
1316 * but that's no problem */
1317 if (tracks[track_widx].aa_hid[i] >= 0 || !albumart_slots[i].used)
1318 continue;
1319 /* find_albumart will error out if the wps doesn't have AA */
1320 if (find_albumart(track_id3, aa_path, sizeof(aa_path),
1321 &(albumart_slots[i].dim)))
1323 int aa_hid = bufopen(aa_path, 0, TYPE_BITMAP,
1324 &(albumart_slots[i].dim));
1326 if(aa_hid == ERR_BUFFER_FULL)
1328 filling = STATE_FULL;
1329 logf("buffer is full for now (get album art)");
1330 return; /* No space for track's album art, not an error */
1332 else if (aa_hid < 0)
1334 /* another error, ignore AlbumArt */
1335 logf("Album art loading failed");
1337 tracks[track_widx].aa_hid[i] = aa_hid;
1342 #endif
1344 /* Load the codec. */
1345 if (!audio_loadcodec(start_play))
1347 if (tracks[track_widx].codec_hid == ERR_BUFFER_FULL)
1349 /* No space for codec on buffer, not an error */
1350 filling = STATE_FULL;
1351 return;
1354 /* This is an error condition, either no codec was found, or reading
1355 * the codec file failed part way through, either way, skip the track */
1356 /* FIXME: We should not use splashf from audio thread! */
1357 splashf(HZ*2, "No codec for: %s", track_id3->path);
1358 /* Skip invalid entry from playlist. */
1359 playlist_skip_entry(NULL, last_peek_offset);
1360 return;
1363 track_id3->elapsed = 0;
1364 offset = track_id3->offset;
1365 size_t resume_rewind = (global_settings.resume_rewind *
1366 track_id3->bitrate * 1000) / 8;
1368 if (offset < resume_rewind)
1370 offset = 0;
1372 else
1374 offset -= resume_rewind;
1377 enum data_type type = TYPE_PACKET_AUDIO;
1379 switch (track_id3->codectype) {
1380 case AFMT_MPA_L1:
1381 case AFMT_MPA_L2:
1382 case AFMT_MPA_L3:
1383 if (offset > 0) {
1384 file_offset = offset;
1386 break;
1388 case AFMT_WAVPACK:
1389 if (offset > 0) {
1390 file_offset = offset;
1391 track_id3->elapsed = track_id3->length / 2;
1393 break;
1395 case AFMT_NSF:
1396 case AFMT_SPC:
1397 case AFMT_SID:
1398 logf("Loading atomic %d",track_id3->codectype);
1399 type = TYPE_ATOMIC_AUDIO;
1400 break;
1402 default:
1403 /* no special treatment needed */
1404 break;
1407 track_id3->offset = offset;
1409 logf("load track: %s", track_id3->path);
1411 if (file_offset > AUDIO_REBUFFER_GUESS_SIZE)
1412 file_offset -= AUDIO_REBUFFER_GUESS_SIZE;
1413 else if (track_id3->first_frame_offset)
1414 file_offset = track_id3->first_frame_offset;
1415 else
1416 file_offset = 0;
1418 tracks[track_widx].audio_hid = bufopen(track_id3->path, file_offset, type,
1419 NULL);
1421 /* No space left, not an error */
1422 if (tracks[track_widx].audio_hid == ERR_BUFFER_FULL)
1424 filling = STATE_FULL;
1425 logf("buffer is full for now (load audio)");
1426 return;
1428 else if (tracks[track_widx].audio_hid < 0)
1430 /* another error, do not continue either */
1431 logf("Could not add audio data handle");
1432 return;
1435 /* All required data is now available for the codec -- unless the
1436 autoresume feature is in effect. In the latter case, the codec
1437 must wait until after PLAYBACK_EVENT_TRACK_BUFFER, which may
1438 generate a resume position. */
1439 #ifdef HAVE_TAGCACHE
1440 if (! global_settings.autoresume_enable)
1441 #endif
1442 tracks[track_widx].taginfo_ready = true;
1444 if (start_play)
1446 ci.curpos=file_offset;
1447 buf_request_buffer_handle(tracks[track_widx].audio_hid);
1450 send_event(PLAYBACK_EVENT_TRACK_BUFFER, track_id3);
1452 #ifdef HAVE_TAGCACHE
1453 /* In case the autoresume feature has been enabled, finally all
1454 required data is available for the codec. */
1455 if (global_settings.autoresume_enable)
1456 tracks[track_widx].taginfo_ready = true;
1457 #endif
1459 track_widx = (track_widx + 1) & MAX_TRACK_MASK;
1461 /* load next track */
1462 LOGFQUEUE("audio > audio Q_AUDIO_FILL_BUFFER");
1463 queue_post(&audio_queue, Q_AUDIO_FILL_BUFFER, 0);
1465 return;
1468 static void audio_fill_file_buffer(bool start_play, size_t offset)
1470 trigger_cpu_boost();
1472 /* No need to rebuffer if there are track skips pending,
1473 * however don't cancel buffering on skipping while filling. */
1474 if (ci.new_track != 0 && filling != STATE_FILLING)
1475 return;
1476 filling = STATE_FILLING;
1478 /* Must reset the buffer before use if trashed or voice only - voice
1479 file size shouldn't have changed so we can go straight from
1480 AUDIOBUF_STATE_VOICED_ONLY to AUDIOBUF_STATE_INITIALIZED */
1481 if (buffer_state != AUDIOBUF_STATE_INITIALIZED)
1482 audio_reset_buffer();
1484 logf("Starting buffer fill");
1486 if (!start_play)
1487 audio_clear_track_entries();
1489 /* Save the current resume position once. */
1490 playlist_update_resume_info(audio_current_track());
1492 audio_load_track(offset, start_play);
1495 static void audio_rebuffer(void)
1497 logf("Forcing rebuffer");
1499 clear_track_info(CUR_TI);
1501 /* Reset track pointers */
1502 track_widx = track_ridx;
1503 audio_clear_track_entries();
1505 /* Reset a possibly interrupted track load */
1506 track_load_started = false;
1508 /* Fill the buffer */
1509 last_peek_offset = -1;
1510 ci.curpos = 0;
1512 if (!CUR_TI->taginfo_ready)
1513 memset(thistrack_id3, 0, sizeof(struct mp3entry));
1515 audio_fill_file_buffer(false, 0);
1518 /* Called on request from the codec to get a new track. This is the codec part
1519 of the track transition. */
1520 static int audio_check_new_track(void)
1522 int track_count = audio_track_count();
1523 int old_track_ridx = track_ridx;
1524 int i, idx;
1525 bool forward;
1526 struct mp3entry *temp = thistrack_id3;
1528 /* Now it's good time to send track finish events. */
1529 send_event(PLAYBACK_EVENT_TRACK_FINISH, thistrack_id3);
1530 /* swap the mp3entry pointers */
1531 thistrack_id3 = othertrack_id3;
1532 othertrack_id3 = temp;
1533 ci.id3 = thistrack_id3;
1534 memset(thistrack_id3, 0, sizeof(struct mp3entry));
1536 if (dir_skip)
1538 dir_skip = false;
1539 /* regardless of the return value we need to rebuffer.
1540 if it fails the old playlist will resume, else the
1541 next dir will start playing */
1542 playlist_next_dir(ci.new_track);
1543 ci.new_track = 0;
1544 audio_rebuffer();
1545 goto skip_done;
1548 if (new_playlist)
1549 ci.new_track = 0;
1551 /* If the playlist isn't that big */
1552 if (automatic_skip)
1554 while (!playlist_check(ci.new_track))
1556 if (ci.new_track >= 0)
1558 LOGFQUEUE("audio >|= codec Q_CODEC_REQUEST_FAILED");
1559 return Q_CODEC_REQUEST_FAILED;
1561 ci.new_track++;
1565 /* Update the playlist */
1566 last_peek_offset -= ci.new_track;
1568 if (playlist_next(ci.new_track) < 0)
1570 LOGFQUEUE("audio >|= codec Q_CODEC_REQUEST_FAILED");
1571 return Q_CODEC_REQUEST_FAILED;
1574 if (new_playlist)
1576 ci.new_track = 1;
1577 new_playlist = false;
1580 /* Save a pointer to the old track to allow later clearing */
1581 prev_ti = CUR_TI;
1583 for (i = 0; i < ci.new_track; i++)
1585 idx = (track_ridx + i) & MAX_TRACK_MASK;
1586 struct mp3entry *id3 = bufgetid3(tracks[idx].id3_hid);
1587 ssize_t offset = buf_handle_offset(tracks[idx].audio_hid);
1588 if (!id3 || offset < 0 || (unsigned)offset > id3->first_frame_offset)
1590 /* We don't have all the audio data for that track, so clear it,
1591 but keep the metadata. */
1592 if (tracks[idx].audio_hid >= 0 && bufclose(tracks[idx].audio_hid))
1594 tracks[idx].audio_hid = -1;
1595 tracks[idx].filesize = 0;
1600 /* Move to the new track */
1601 track_ridx = (track_ridx + ci.new_track) & MAX_TRACK_MASK;
1602 buf_set_base_handle(CUR_TI->audio_hid);
1605 if (automatic_skip)
1607 wps_offset = -ci.new_track;
1610 /* If it is not safe to even skip this many track entries */
1611 if (ci.new_track >= track_count || ci.new_track <= track_count - MAX_TRACK)
1613 ci.new_track = 0;
1614 audio_rebuffer();
1615 goto skip_done;
1618 forward = ci.new_track > 0;
1619 ci.new_track = 0;
1621 /* If the target track is clearly not in memory */
1622 if (CUR_TI->filesize == 0 || !CUR_TI->taginfo_ready)
1624 audio_rebuffer();
1625 goto skip_done;
1628 /* When skipping backwards, it is possible that we've found a track that's
1629 * buffered, but which is around the track-wrap and therefore not the track
1630 * we are looking for */
1631 if (!forward)
1633 int cur_idx = track_ridx;
1634 bool taginfo_ready = true;
1635 /* We've wrapped the buffer backwards if new > old */
1636 bool wrap = track_ridx > old_track_ridx;
1638 while (1)
1640 cur_idx = (cur_idx + 1) & MAX_TRACK_MASK;
1642 /* if we've advanced past the wrap when cur_idx is zeroed */
1643 if (!cur_idx)
1644 wrap = false;
1646 /* if we aren't still on the wrap and we've caught the old track */
1647 if (!(wrap || cur_idx < old_track_ridx))
1648 break;
1650 /* If we hit a track in between without valid tag info, bail */
1651 if (!tracks[cur_idx].taginfo_ready)
1653 taginfo_ready = false;
1654 break;
1657 if (!taginfo_ready)
1659 audio_rebuffer();
1663 skip_done:
1664 audio_update_trackinfo();
1665 LOGFQUEUE("audio >|= codec Q_CODEC_REQUEST_COMPLETE");
1666 return Q_CODEC_REQUEST_COMPLETE;
1669 unsigned long audio_prev_elapsed(void)
1671 return prev_track_elapsed;
1674 void audio_set_prev_elapsed(unsigned long setting)
1676 prev_track_elapsed = setting;
1679 static void audio_stop_codec_flush(void)
1681 ci.stop_codec = true;
1682 pcmbuf_pause(true);
1684 while (audio_codec_loaded)
1685 yield();
1687 /* If the audio codec is not loaded any more, and the audio is still
1688 * playing, it is now and _only_ now safe to call this function from the
1689 * audio thread */
1690 if (pcm_is_playing())
1692 pcmbuf_play_stop();
1693 pcm_play_lock();
1694 queue_clear(&pcmbuf_queue);
1695 pcm_play_unlock();
1697 pcmbuf_pause(paused);
1700 static void audio_stop_playback(void)
1702 if (playing)
1704 /* If we were playing, save resume information */
1705 struct mp3entry *id3 = NULL;
1707 if (!ci.stop_codec)
1709 /* Set this early, the outside code yields and may allow the codec
1710 to try to wait for a reply on a buffer wait */
1711 ci.stop_codec = true;
1712 id3 = audio_current_track();
1715 /* Save the current playing spot, or NULL if the playlist has ended */
1716 playlist_update_resume_info(id3);
1718 /* Now it's good time to send track finish events. Do this
1719 only if this hasn't been done already as part of a track
1720 switch. */
1721 if (id3 == thistrack_id3)
1722 send_event(PLAYBACK_EVENT_TRACK_FINISH, thistrack_id3);
1724 /* TODO: Create auto bookmark too? */
1726 prev_track_elapsed = othertrack_id3->elapsed;
1728 remove_event(BUFFER_EVENT_BUFFER_LOW, buffering_low_buffer_callback);
1731 audio_stop_codec_flush();
1732 paused = false;
1733 playing = false;
1734 track_load_started = false;
1736 filling = STATE_IDLE;
1738 /* Mark all entries null. */
1739 audio_clear_track_entries();
1741 /* Close all tracks */
1742 audio_release_tracks();
1745 static void audio_play_start(size_t offset)
1747 int i;
1749 send_event(PLAYBACK_EVENT_START_PLAYBACK, NULL);
1750 #if INPUT_SRC_CAPS != 0
1751 audio_set_input_source(AUDIO_SRC_PLAYBACK, SRCF_PLAYBACK);
1752 audio_set_output_source(AUDIO_SRC_PLAYBACK);
1753 #endif
1755 /* Wait for any previously playing audio to flush - TODO: Not necessary? */
1756 paused = false;
1757 audio_stop_codec_flush();
1759 playing = true;
1760 track_load_started = false;
1762 ci.new_track = 0;
1763 ci.seek_time = 0;
1764 wps_offset = 0;
1766 sound_set_volume(global_settings.volume);
1767 track_widx = track_ridx = 0;
1768 buf_set_base_handle(-1);
1770 /* Clear all track entries. */
1771 for (i = 0; i < MAX_TRACK; i++) {
1772 clear_track_info(&tracks[i]);
1775 last_peek_offset = -1;
1777 /* Officially playing */
1778 queue_reply(&audio_queue, 1);
1780 audio_fill_file_buffer(true, offset);
1782 add_event(BUFFER_EVENT_BUFFER_LOW, false, buffering_low_buffer_callback);
1784 LOGFQUEUE("audio > audio Q_AUDIO_TRACK_CHANGED");
1785 queue_post(&audio_queue, Q_AUDIO_TRACK_CHANGED, 0);
1789 /* Invalidates all but currently playing track. */
1790 static void audio_invalidate_tracks(void)
1792 if (audio_have_tracks())
1794 last_peek_offset = 0;
1795 track_widx = track_ridx;
1797 /* Mark all other entries null (also buffered wrong metadata). */
1798 audio_clear_track_entries();
1800 track_widx = (track_widx + 1) & MAX_TRACK_MASK;
1802 audio_fill_file_buffer(false, 0);
1803 send_event(PLAYBACK_EVENT_TRACK_CHANGE, thistrack_id3);
1807 static void audio_new_playlist(void)
1809 /* Prepare to start a new fill from the beginning of the playlist */
1810 last_peek_offset = -1;
1811 if (audio_have_tracks())
1813 if (paused)
1814 skipped_during_pause = true;
1815 track_widx = track_ridx;
1816 audio_clear_track_entries();
1818 track_widx = (track_widx + 1) & MAX_TRACK_MASK;
1820 /* Mark the current track as invalid to prevent skipping back to it */
1821 CUR_TI->taginfo_ready = false;
1824 /* Signal the codec to initiate a track change forward */
1825 new_playlist = true;
1826 ci.new_track = 1;
1828 /* Officially playing */
1829 queue_reply(&audio_queue, 1);
1831 audio_fill_file_buffer(false, 0);
1834 /* Called on manual track skip */
1835 static void audio_initiate_track_change(long direction)
1837 logf("audio_initiate_track_change(%ld)", direction);
1839 ci.new_track += direction;
1840 wps_offset -= direction;
1841 if (paused)
1842 skipped_during_pause = true;
1845 /* Called on manual dir skip */
1846 static void audio_initiate_dir_change(long direction)
1848 dir_skip = true;
1849 ci.new_track = direction;
1850 if (paused)
1851 skipped_during_pause = true;
1854 /* Called when PCM track change is complete */
1855 static void audio_finalise_track_change(void)
1857 logf("audio_finalise_track_change");
1859 if (automatic_skip)
1861 wps_offset = 0;
1862 automatic_skip = false;
1864 /* Invalidate prevtrack_id3 */
1865 memset(othertrack_id3, 0, sizeof(struct mp3entry));
1867 if (prev_ti && prev_ti->audio_hid < 0)
1869 /* No audio left so we clear all the track info. */
1870 clear_track_info(prev_ti);
1873 send_event(PLAYBACK_EVENT_TRACK_CHANGE, thistrack_id3);
1874 playlist_update_resume_info(audio_current_track());
1878 * Layout audio buffer as follows - iram buffer depends on target:
1879 * [|SWAP:iram][|TALK]|FILE|GUARD|PCM|[SWAP:dram[|iram]|]
1881 static void audio_reset_buffer(void)
1883 /* see audio_get_recording_buffer if this is modified */
1884 logf("audio_reset_buffer");
1886 /* If the setup of anything allocated before the file buffer is
1887 changed, do check the adjustments after the buffer_alloc call
1888 as it will likely be affected and need sliding over */
1890 /* Initially set up file buffer as all space available */
1891 malloc_buf = audiobuf + talk_get_bufsize();
1893 /* Align the malloc buf to line size.
1894 * Especially important to cf targets that do line reads/writes.
1895 * Also for targets which need aligned DMA storage buffers */
1896 malloc_buf = (unsigned char *)(((uintptr_t)malloc_buf + (CACHEALIGN_SIZE - 1)) & ~(CACHEALIGN_SIZE - 1));
1897 filebuf = malloc_buf; /* filebuf line align implied */
1898 filebuflen = (audiobufend - filebuf) & ~(CACHEALIGN_SIZE - 1);
1900 /* Subtract whatever the pcm buffer says it used plus the guard buffer */
1901 const size_t pcmbuf_size = pcmbuf_init(filebuf + filebuflen) +GUARD_BUFSIZE;
1902 if(pcmbuf_size > filebuflen)
1903 panicf("%s(): EOM (%zu > %zu)", __func__, pcmbuf_size, filebuflen);
1905 filebuflen -= pcmbuf_size;
1907 /* Make sure filebuflen is a longword multiple after adjustment - filebuf
1908 will already be line aligned */
1909 filebuflen &= ~3;
1911 buffering_reset(filebuf, filebuflen);
1913 /* Clear any references to the file buffer */
1914 buffer_state = AUDIOBUF_STATE_INITIALIZED;
1916 #if defined(ROCKBOX_HAS_LOGF) && defined(LOGF_ENABLE)
1917 /* Make sure everything adds up - yes, some info is a bit redundant but
1918 aids viewing and the sumation of certain variables should add up to
1919 the location of others. */
1921 size_t pcmbufsize;
1922 const unsigned char *pcmbuf = pcmbuf_get_meminfo(&pcmbufsize);
1923 logf("mabuf: %08X", (unsigned)malloc_buf);
1924 logf("fbuf: %08X", (unsigned)filebuf);
1925 logf("fbufe: %08X", (unsigned)(filebuf + filebuflen));
1926 logf("gbuf: %08X", (unsigned)(filebuf + filebuflen));
1927 logf("gbufe: %08X", (unsigned)(filebuf + filebuflen + GUARD_BUFSIZE));
1928 logf("pcmb: %08X", (unsigned)pcmbuf);
1929 logf("pcmbe: %08X", (unsigned)(pcmbuf + pcmbufsize));
1931 #endif
1934 static void audio_thread(void)
1936 struct queue_event ev;
1938 pcm_postinit();
1940 audio_thread_ready = true;
1942 while (1)
1944 if (filling != STATE_FILLING && filling != STATE_IDLE) {
1945 /* End of buffering, let's calculate the watermark and unboost */
1946 set_filebuf_watermark();
1947 cancel_cpu_boost();
1950 if (!pcmbuf_queue_scan(&ev))
1951 queue_wait_w_tmo(&audio_queue, &ev, HZ/2);
1953 switch (ev.id) {
1955 case Q_AUDIO_FILL_BUFFER:
1956 LOGFQUEUE("audio < Q_AUDIO_FILL_BUFFER %d", (int)ev.data);
1957 audio_fill_file_buffer((bool)ev.data, 0);
1958 break;
1960 case Q_AUDIO_FINISH_LOAD:
1961 LOGFQUEUE("audio < Q_AUDIO_FINISH_LOAD");
1962 audio_finish_load_track();
1963 buf_set_base_handle(CUR_TI->audio_hid);
1964 break;
1966 case Q_AUDIO_PLAY:
1967 LOGFQUEUE("audio < Q_AUDIO_PLAY");
1968 if (playing && ev.data <= 0)
1969 audio_new_playlist();
1970 else
1972 audio_stop_playback();
1973 audio_play_start((size_t)ev.data);
1975 break;
1977 case Q_AUDIO_STOP:
1978 LOGFQUEUE("audio < Q_AUDIO_STOP");
1979 if (playing)
1980 audio_stop_playback();
1981 if (ev.data != 0)
1982 queue_clear(&audio_queue);
1983 break;
1985 case Q_AUDIO_PAUSE:
1986 LOGFQUEUE("audio < Q_AUDIO_PAUSE");
1987 if (!(bool) ev.data && skipped_during_pause
1988 #ifdef HAVE_CROSSFADE
1989 && !pcmbuf_is_crossfade_active()
1990 #endif
1992 pcmbuf_play_stop(); /* Flush old track on resume after skip */
1993 skipped_during_pause = false;
1994 if (!playing)
1995 break;
1996 pcmbuf_pause((bool)ev.data);
1997 paused = (bool)ev.data;
1998 break;
2000 case Q_AUDIO_SKIP:
2001 LOGFQUEUE("audio < Q_AUDIO_SKIP");
2002 audio_initiate_track_change((long)ev.data);
2003 break;
2005 case Q_AUDIO_PRE_FF_REWIND:
2006 LOGFQUEUE("audio < Q_AUDIO_PRE_FF_REWIND");
2007 if (!playing)
2008 break;
2009 pcmbuf_pause(true);
2010 break;
2012 case Q_AUDIO_FF_REWIND:
2013 LOGFQUEUE("audio < Q_AUDIO_FF_REWIND");
2014 if (!playing)
2015 break;
2016 if (automatic_skip)
2018 /* An automatic track skip is in progress. Finalize it,
2019 then go back to the previous track */
2020 audio_finalise_track_change();
2021 ci.new_track = -1;
2023 ci.seek_time = (long)ev.data+1;
2024 break;
2026 case Q_AUDIO_CHECK_NEW_TRACK:
2027 LOGFQUEUE("audio < Q_AUDIO_CHECK_NEW_TRACK");
2028 queue_reply(&audio_queue, audio_check_new_track());
2029 break;
2031 case Q_AUDIO_DIR_SKIP:
2032 LOGFQUEUE("audio < Q_AUDIO_DIR_SKIP");
2033 audio_initiate_dir_change(ev.data);
2034 break;
2036 case Q_AUDIO_FLUSH:
2037 LOGFQUEUE("audio < Q_AUDIO_FLUSH");
2038 audio_invalidate_tracks();
2039 break;
2041 case Q_AUDIO_TRACK_CHANGED:
2042 /* PCM track change done */
2043 LOGFQUEUE("audio < Q_AUDIO_TRACK_CHANGED");
2044 audio_finalise_track_change();
2045 break;
2046 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
2047 case SYS_USB_CONNECTED:
2048 LOGFQUEUE("audio < SYS_USB_CONNECTED");
2049 if (playing)
2050 audio_stop_playback();
2051 #ifdef PLAYBACK_VOICE
2052 voice_stop();
2053 #endif
2054 usb_acknowledge(SYS_USB_CONNECTED_ACK);
2055 usb_wait_for_disconnect(&audio_queue);
2057 /* Mark all entries null. */
2058 audio_clear_track_entries();
2060 /* release tracks to make sure all handles are closed */
2061 audio_release_tracks();
2062 break;
2063 #endif
2065 case SYS_TIMEOUT:
2066 LOGFQUEUE_SYS_TIMEOUT("audio < SYS_TIMEOUT");
2067 break;
2069 default:
2070 /* LOGFQUEUE("audio < default : %08lX", ev.id); */
2071 break;
2072 } /* end switch */
2073 } /* end while */
2076 /* Initialize the audio system - called from init() in main.c.
2077 * Last function because of all the references to internal symbols
2079 void audio_init(void)
2081 unsigned int audio_thread_id;
2083 /* Can never do this twice */
2084 if (audio_is_initialized)
2086 logf("audio: already initialized");
2087 return;
2090 logf("audio: initializing");
2092 /* Initialize queues before giving control elsewhere in case it likes
2093 to send messages. Thread creation will be delayed however so nothing
2094 starts running until ready if something yields such as talk_init. */
2095 queue_init(&audio_queue, true);
2096 queue_init(&codec_queue, false);
2097 queue_init(&pcmbuf_queue, false);
2099 pcm_init();
2101 codec_init_codec_api();
2103 thistrack_id3 = &mp3entry_buf[0];
2104 othertrack_id3 = &mp3entry_buf[1];
2106 /* cuesheet support */
2107 if (global_settings.cuesheet)
2108 curr_cue = (struct cuesheet*)buffer_alloc(sizeof(struct cuesheet));
2110 /* initialize the buffer */
2111 filebuf = audiobuf;
2113 /* audio_reset_buffer must to know the size of voice buffer so init
2114 talk first */
2115 talk_init();
2117 make_codec_thread();
2119 audio_thread_id = create_thread(audio_thread, audio_stack,
2120 sizeof(audio_stack), CREATE_THREAD_FROZEN,
2121 audio_thread_name IF_PRIO(, PRIORITY_USER_INTERFACE)
2122 IF_COP(, CPU));
2124 queue_enable_queue_send(&audio_queue, &audio_queue_sender_list,
2125 audio_thread_id);
2127 #ifdef PLAYBACK_VOICE
2128 voice_thread_init();
2129 #endif
2131 #ifdef HAVE_CROSSFADE
2132 /* Set crossfade setting for next buffer init which should be about... */
2133 pcmbuf_request_crossfade_enable(global_settings.crossfade);
2134 #endif
2136 /* initialize the buffering system */
2138 buffering_init();
2139 /* ...now! Set up the buffers */
2140 audio_reset_buffer();
2142 int i;
2143 for(i = 0; i < MAX_TRACK; i++)
2145 tracks[i].audio_hid = -1;
2146 tracks[i].id3_hid = -1;
2147 tracks[i].codec_hid = -1;
2148 tracks[i].cuesheet_hid = -1;
2150 #ifdef HAVE_ALBUMART
2151 FOREACH_ALBUMART(i)
2153 int j;
2154 for (j = 0; j < MAX_TRACK; j++)
2156 tracks[j].aa_hid[i] = -1;
2159 #endif
2161 add_event(BUFFER_EVENT_REBUFFER, false, buffering_handle_rebuffer_callback);
2162 add_event(BUFFER_EVENT_FINISHED, false, buffering_handle_finished_callback);
2164 /* Probably safe to say */
2165 audio_is_initialized = true;
2167 sound_settings_apply();
2168 #ifdef HAVE_DISK_STORAGE
2169 audio_set_buffer_margin(global_settings.buffer_margin);
2170 #endif
2172 /* it's safe to let the threads run now */
2173 #ifdef PLAYBACK_VOICE
2174 voice_thread_resume();
2175 #endif
2176 thread_thaw(codec_thread_id);
2177 thread_thaw(audio_thread_id);
2179 } /* audio_init */
2181 bool audio_is_thread_ready(void)
2183 return audio_thread_ready;
2186 size_t audio_get_filebuflen(void)
2188 return filebuflen;
2191 int get_audio_hid()
2193 return CUR_TI->audio_hid;
2196 int *get_codec_hid()
2198 return &tracks[track_ridx].codec_hid;