aacdec: raise min buffer size to 1000 bytes.
[paraslash.git] / afs.h
1 /*
2 * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
17 */
18
19 /** \file afs.h functions and structures for audio format handling (para_server) */
20
21 /** \cond */
22 #ifdef HAVE_OGGVORBIS
23 #define OV_AUDIO_FORMAT " ogg"
24 #define OV_AUDIO_FORMAT_ARRAY , "ogg"
25 #else
26 #define OV_AUDIO_FORMAT ""
27 #define OV_AUDIO_FORMAT_ARRAY
28 #endif
29
30 #define SUPPORTED_AUDIO_FORMATS "mp3" OV_AUDIO_FORMAT
31 #define SUPPORTED_AUDIO_FORMATS_ARRAY "mp3" OV_AUDIO_FORMAT_ARRAY, NULL
32
33
34 /* status flags */
35 #define AFS_NOMORE 1
36 #define AFS_NEXT 2
37 #define AFS_REPOS 4
38 #define AFS_PLAYING 8
39 #define DBT_CHANGE 16
40 /** \endcond */
41
42 /**
43 * structure for audio format handling
44 *
45 * There's exactly one such struct for each supported audio format. Initially,
46 * only \a name and \a init are defined. During the startup process,
47 * para_server calls the \a init function of each audio format handler which is
48 * expected to fill in all the other function pointers.
49 */
50 struct audio_format {
51 /**
52 *
53 *
54 * name of the audio format
55 */
56 const char *name;
57 /**
58 *
59 *
60 * pointer to the audio format handler's init function
61 *
62 * Must initialize all function pointers and is assumed to succeed.
63 */
64 void (*init)(void*);
65 /**
66 *
67 *
68 * period of time between sending data chunks
69 */
70 struct timeval chunk_tv; /* length of one chunk of data */
71 /**
72 *
73 *
74 * end of file timeout - do not load new audio file until this time
75 *
76 */
77 struct timeval eof_tv; /* timeout on eof */
78 /**
79 *
80 *
81 * Pointer to the optional get-header function.
82 *
83 * This is called from a sender in case a new client connects in the middle of
84 * the stream. The audio format handler may set this to NULL to indicate that
85 * this audio format does not need any special header treatment. If non-NULL,
86 * the function it points to must return a pointer to a buffer holding the
87 * current audio file header, together with the header length.
88 */
89 char *(*get_header_info)(int *header_len);
90 /**
91 *
92 *
93 * check if this audio format handler can handle the file
94 *
95 * This is a pointer to a function returning whether a given file is valid for
96 * this audio format. A negative return value indicates that this audio format
97 * handler did not recognize the given file. On success, the function is
98 * expected to return a positive value and to fill in \arg info_str, \arg
99 * chunks and \arg seconds appropriately.
100 */
101 int (*get_file_info)(FILE *audio_file, char *info_str,
102 long unsigned *chunks, int *seconds);
103 /**
104 *
105 *
106 * cleanup function of this audio format handler
107 *
108 * This close function should deallocate any resources
109 * associated with the current audio file. In particular, it is responsible
110 * for closing the file handle. It is assumed to succeed.
111 */
112 void (*close_audio_file)(void);
113 /**
114 *
115 *
116 * jump to another position in the current audio file
117 *
118 * This is called if a client issued the ff or jmp command with \a request
119 * being the number of the next chunk that should be sent out. Must return a
120 * positive value on success and a negative value on errors.
121 */
122 int (*reposition_stream)(long unsigned request);
123 /**
124 *
125 *
126 * function responsible for reading one data chunk.
127 *
128 * \a read_chunk() must return a pointer to the next chunk of data that should
129 * be sent out, or \p NULL on errors or if the end of the file was encountered.
130 *
131 * If it returns non-NULL, \a len must contain the length of the returned
132 * buffer (which may be zero if nothing has to be sent for some reason).
133 * Otherwise, \a len is used to distinguish between the eof and the error case:
134 * It must be zero in the eof case, or negative if an error occcured.
135 */
136 char * (*read_chunk)(long unsigned chunk_num, ssize_t *len);
137 };
138
139 void afs_init(void);
140 void afs_send_chunk(void);
141 struct timeval *afs_preselect(void);
142 const char *audio_format_name(int);
143 unsigned int afs_playing(void);
144 unsigned int afs_next(void);
145 unsigned int afs_repos(void);
146 unsigned int afs_paused(void);
147