Update the discussion of themeing in the manual, and put a note in the wps tags appen...
[kugel-rb.git] / apps / playback.h
blob27e27ff240b1bcaea03ecef7fcbc9261c12e8bca
1 /***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
10 * Copyright (C) 2005 Miika Pekkarinen
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.
17 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
18 * KIND, either express or implied.
20 ****************************************************************************/
22 #ifndef _PLAYBACK_H
23 #define _PLAYBACK_H
25 #include <stdbool.h>
26 #include <stdlib.h>
27 #include "config.h"
29 #ifdef HAVE_ALBUMART
31 #include "bmp.h"
33 * Returns the handle id of the buffered albumart for the given slot id
34 **/
35 int playback_current_aa_hid(int slot);
38 * Hands out an albumart slot for buffering albumart using the size
39 * int the passed dim struct, it copies the data of dim in order to
40 * be safe to be reused for other code
42 * The slot may be reused if other code calls this with the same dimensions
43 * in dim, so if you change dim release and claim a new slot
45 * Save to call from other threads */
46 int playback_claim_aa_slot(struct dim *dim);
49 * Releases the albumart slot with given id
51 * Save to call from other threads */
52 void playback_release_aa_slot(int slot);
53 #endif
55 /* Functions */
56 void voice_wait(void);
57 bool audio_is_thread_ready(void);
58 int audio_track_count(void);
59 long audio_filebufused(void);
60 void audio_pre_ff_rewind(void);
61 void audio_skip(int direction);
62 void audio_hard_stop(void); /* Stops audio from serving playback */
63 #ifdef HAVE_CROSSFADE
64 void audio_set_crossfade(int enable);
65 #endif
67 enum
69 AUDIO_WANT_PLAYBACK = 0,
70 AUDIO_WANT_VOICE,
72 bool audio_restore_playback(int type); /* Restores the audio buffer to handle the requested playback */
73 size_t audio_get_filebuflen(void);
74 void audio_pcmbuf_position_callback(unsigned int time) ICODE_ATTR;
75 void audio_post_track_change(bool pcmbuf);
76 int get_audio_hid(void);
77 int *get_codec_hid(void);
78 void audio_set_prev_elapsed(unsigned long setting);
79 bool audio_buffer_state_trashed(void);
81 /* Define one constant that includes recording related functionality */
82 #if defined(HAVE_RECORDING) && !defined(SIMULATOR)
83 #define AUDIO_HAVE_RECORDING
84 #endif
86 enum {
87 Q_NULL = 0,
88 Q_AUDIO_PLAY = 1,
89 Q_AUDIO_STOP,
90 Q_AUDIO_PAUSE,
91 Q_AUDIO_SKIP,
92 Q_AUDIO_PRE_FF_REWIND,
93 Q_AUDIO_FF_REWIND,
94 Q_AUDIO_CHECK_NEW_TRACK,
95 Q_AUDIO_FLUSH,
96 Q_AUDIO_TRACK_CHANGED,
97 Q_AUDIO_DIR_SKIP,
98 Q_AUDIO_POSTINIT,
99 Q_AUDIO_FILL_BUFFER,
100 Q_AUDIO_FINISH_LOAD,
101 Q_CODEC_REQUEST_COMPLETE,
102 Q_CODEC_REQUEST_FAILED,
104 Q_CODEC_LOAD,
105 Q_CODEC_LOAD_DISK,
107 #ifdef AUDIO_HAVE_RECORDING
108 Q_ENCODER_LOAD_DISK,
109 Q_ENCODER_RECORD,
110 #endif
112 Q_CODEC_DO_CALLBACK,
115 #endif