3725ffa10c52baaef3926ecea50178ea99c4aa46
[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 #ifdef HAVE_FAAD
31 #define AAC_AUDIO_FORMAT " aac"
32 #define AAC_AUDIO_FORMAT_ARRAY , "aac"
33 #else
34 #define AAC_AUDIO_FORMAT ""
35 #define AAC_AUDIO_FORMAT_ARRAY
36 #endif
37
38 #define SUPPORTED_AUDIO_FORMATS "mp3" OV_AUDIO_FORMAT AAC_AUDIO_FORMAT
39 #define SUPPORTED_AUDIO_FORMATS_ARRAY "mp3" OV_AUDIO_FORMAT_ARRAY \
40 AAC_AUDIO_FORMAT_ARRAY, NULL
41
42 /* status flags */
43 #define AFS_NOMORE 1
44 #define AFS_NEXT 2
45 #define AFS_REPOS 4
46 #define AFS_PLAYING 8
47 #define DBT_CHANGE 16
48 /** \endcond */
49
50 /**
51 * structure for audio format handling
52 *
53 * There's exactly one such struct for each supported audio format. Initially,
54 * only \a name and \a init are defined. During the startup process,
55 * para_server calls the \a init function of each audio format handler which is
56 * expected to fill in all the other function pointers.
57 */
58 struct audio_format_handler {
59 /**
60 * name of the audio format
61 */
62 const char *name;
63 /**
64 * typical file endings for files that can be handled by this afh.
65 */
66 const char **suffixes;
67 /**
68 * pointer to the audio format handler's init function
69 *
70 * Must initialize all function pointers and is assumed to succeed.
71 */
72 void (*init)(struct audio_format_handler*);
73 /**
74 * period of time between sending data chunks
75 */
76 struct timeval chunk_tv; /* length of one chunk of data */
77 /**
78 * end of file timeout - do not load new audio file until this time
79 *
80 */
81 struct timeval eof_tv; /* timeout on eof */
82 /**
83 * Pointer to the optional get-header function.
84 *
85 * This is called from a sender in case a new client connects in the middle of
86 * the stream. The audio format handler may set this to NULL to indicate that
87 * this audio format does not need any special header treatment. If non-NULL,
88 * the function it points to must return a pointer to a buffer holding the
89 * current audio file header, together with the header length.
90 */
91 char *(*get_header_info)(int *header_len);
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 * cleanup function of this audio format handler
105 *
106 * This close function should deallocate any resources
107 * associated with the current audio file. In particular, it is responsible
108 * for closing the file handle. It is assumed to succeed.
109 */
110 void (*close_audio_file)(void);
111 /**
112 * jump to another position in the current audio file
113 *
114 * This is called if a client issued the ff or jmp command with \a request
115 * being the number of the next chunk that should be sent out. Must return a
116 * positive value on success and a negative value on errors.
117 */
118 int (*reposition_stream)(long unsigned request);
119 /**
120 * function responsible for reading one data chunk.
121 *
122 * \a read_chunk() must return a pointer to the next chunk of data that should
123 * be sent out, or \p NULL on errors or if the end of the file was encountered.
124 *
125 * If it returns non-NULL, \a len must contain the length of the returned
126 * buffer (which may be zero if nothing has to be sent for some reason).
127 * Otherwise, \a len is used to distinguish between the eof and the error case:
128 * It must be zero in the eof case, or negative if an error occcured.
129 */
130 char * (*read_chunk)(long unsigned chunk_num, ssize_t *len);
131 };
132
133
134 void afs_init(void);
135 void afs_send_chunk(void);
136 struct timeval *afs_preselect(void);
137 const char *audio_format_name(int);
138 unsigned int afs_playing(void);
139 unsigned int afs_next(void);
140 unsigned int afs_repos(void);
141 unsigned int afs_paused(void);
142 char *afs_get_header(int *header_len);
143 struct timeval *afs_chunk_time(void);
144 int guess_audio_format(const char *name);