Merge "BuildSystem: Really do not pass unknown-warning options to the compiler."
[asterisk/asterisk.git] / formats / format_ogg_vorbis.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2005, Jeff Ollie
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17 /*! \file
18  *
19  * \brief OGG/Vorbis streams.
20  * \arg File name extension: ogg
21  * \ingroup formats
22  */
23
24 /* the order of these dependencies is important... it also specifies
25    the link order of the libraries during linking
26 */
27
28 /*** MODULEINFO
29         <depend>vorbis</depend>
30         <depend>ogg</depend>
31         <support_level>core</support_level>
32  ***/
33
34 #include "asterisk.h"
35
36 #include <vorbis/codec.h>
37 #include <vorbis/vorbisenc.h>
38 #include <vorbis/vorbisfile.h>
39
40 #ifdef _WIN32
41 #include <io.h>
42 #endif
43
44 #include "asterisk/mod_format.h"
45 #include "asterisk/module.h"
46 #include "asterisk/format_cache.h"
47
48 /*
49  * this is the number of samples we deal with. Samples are converted
50  * to SLINEAR so each one uses 2 bytes in the buffer.
51  */
52 #define SAMPLES_MAX 512
53 #define BUF_SIZE        (2*SAMPLES_MAX)
54
55 #define BLOCK_SIZE 4096         /* used internally in the vorbis routines */
56
57 struct ogg_vorbis_desc {        /* format specific parameters */
58         /* OggVorbis_File structure for libvorbisfile interface */
59         OggVorbis_File ov_f;
60
61         /* structures for handling the Ogg container */
62         ogg_stream_state os;
63         ogg_page og;
64         ogg_packet op;
65
66         /* structures for handling Vorbis audio data */
67         vorbis_info vi;
68         vorbis_comment vc;
69         vorbis_dsp_state vd;
70         vorbis_block vb;
71
72         /*! \brief Indicates whether this filestream is set up for reading or writing. */
73         int writing;
74
75         /*! \brief Stores the current pcm position to support tell() on writing mode. */
76         off_t writing_pcm_pos;
77
78         /*! \brief Indicates whether an End of Stream condition has been detected. */
79         int eos;
80 };
81
82 #if !defined(HAVE_VORBIS_OPEN_CALLBACKS)
83 /*
84  * Declared for backward compatibility with vorbisfile v1.1.2.
85  * Code taken from vorbisfile.h v1.2.0.
86  */
87 static int _ov_header_fseek_wrap(FILE *f, ogg_int64_t off, int whence)
88 {
89         if (f == NULL) {
90                 return -1;
91         }
92         return fseek(f, off, whence);
93 }
94
95 static ov_callbacks OV_CALLBACKS_NOCLOSE = {
96   (size_t (*)(void *, size_t, size_t, void *))  fread,
97   (int (*)(void *, ogg_int64_t, int))           _ov_header_fseek_wrap,
98   (int (*)(void *))                             NULL,
99   (long (*)(void *))                            ftell
100 };
101 #endif  /* !defined(HAVE_VORBIS_OPEN_CALLBACKS) */
102
103 /*!
104  * \brief Create a new OGG/Vorbis filestream and set it up for reading.
105  * \param s File that points to on disk storage of the OGG/Vorbis data.
106  * \return The new filestream.
107  */
108 static int ogg_vorbis_open(struct ast_filestream *s)
109 {
110         int result;
111         struct ogg_vorbis_desc *desc = (struct ogg_vorbis_desc *) s->_private;
112
113         /* initialize private description block */
114         memset(desc, 0, sizeof(struct ogg_vorbis_desc));
115         desc->writing = 0;
116
117         /* actually open file */
118         result = ov_open_callbacks(s->f, &desc->ov_f, NULL, 0, OV_CALLBACKS_NOCLOSE);
119         if (result != 0) {
120                 ast_log(LOG_ERROR, "Error opening Ogg/Vorbis file stream.\n");
121                 return -1;
122         }
123
124         /* check stream(s) type */
125         if (desc->ov_f.vi->channels != 1) {
126                 ast_log(LOG_ERROR, "Only monophonic OGG/Vorbis files are currently supported!\n");
127                 ov_clear(&desc->ov_f);
128                 return -1;
129         }
130
131         if (desc->ov_f.vi->rate != DEFAULT_SAMPLE_RATE) {
132                 ast_log(LOG_ERROR, "Only 8000Hz OGG/Vorbis files are currently supported!\n");
133                 ov_clear(&desc->ov_f);
134                 return -1;
135         }
136
137         return 0;
138 }
139
140 /*!
141  * \brief Create a new OGG/Vorbis filestream and set it up for writing.
142  * \param s File pointer that points to on-disk storage.
143  * \param comment Comment that should be embedded in the OGG/Vorbis file.
144  * \return A new filestream.
145  */
146 static int ogg_vorbis_rewrite(struct ast_filestream *s,
147                                                  const char *comment)
148 {
149         ogg_packet header;
150         ogg_packet header_comm;
151         ogg_packet header_code;
152         struct ogg_vorbis_desc *tmp = (struct ogg_vorbis_desc *) s->_private;
153
154         tmp->writing = 1;
155         tmp->writing_pcm_pos = 0;
156
157         vorbis_info_init(&tmp->vi);
158
159         if (vorbis_encode_init_vbr(&tmp->vi, 1, DEFAULT_SAMPLE_RATE, 0.4)) {
160                 ast_log(LOG_ERROR, "Unable to initialize Vorbis encoder!\n");
161                 vorbis_info_clear(&tmp->vi);
162                 return -1;
163         }
164
165         vorbis_comment_init(&tmp->vc);
166         vorbis_comment_add_tag(&tmp->vc, "ENCODER", "Asterisk PBX");
167         if (comment)
168                 vorbis_comment_add_tag(&tmp->vc, "COMMENT", (char *) comment);
169
170         vorbis_analysis_init(&tmp->vd, &tmp->vi);
171         vorbis_block_init(&tmp->vd, &tmp->vb);
172
173         ogg_stream_init(&tmp->os, ast_random());
174
175         vorbis_analysis_headerout(&tmp->vd, &tmp->vc, &header, &header_comm,
176                                   &header_code);
177         ogg_stream_packetin(&tmp->os, &header);
178         ogg_stream_packetin(&tmp->os, &header_comm);
179         ogg_stream_packetin(&tmp->os, &header_code);
180
181         while (!tmp->eos) {
182                 if (ogg_stream_flush(&tmp->os, &tmp->og) == 0)
183                         break;
184                 if (fwrite(tmp->og.header, 1, tmp->og.header_len, s->f) != tmp->og.header_len) {
185                         ast_log(LOG_WARNING, "fwrite() failed: %s\n", strerror(errno));
186                 }
187                 if (fwrite(tmp->og.body, 1, tmp->og.body_len, s->f) != tmp->og.body_len) {
188                         ast_log(LOG_WARNING, "fwrite() failed: %s\n", strerror(errno));
189                 }
190                 if (ogg_page_eos(&tmp->og))
191                         tmp->eos = 1;
192         }
193
194         return 0;
195 }
196
197 /*!
198  * \brief Write out any pending encoded data.
199  * \param s An OGG/Vorbis filestream.
200  * \param f The file to write to.
201  */
202 static void write_stream(struct ogg_vorbis_desc *s, FILE *f)
203 {
204         while (vorbis_analysis_blockout(&s->vd, &s->vb) == 1) {
205                 vorbis_analysis(&s->vb, NULL);
206                 vorbis_bitrate_addblock(&s->vb);
207
208                 while (vorbis_bitrate_flushpacket(&s->vd, &s->op)) {
209                         ogg_stream_packetin(&s->os, &s->op);
210                         while (!s->eos) {
211                                 if (ogg_stream_pageout(&s->os, &s->og) == 0) {
212                                         break;
213                                 }
214                                 if (fwrite(s->og.header, 1, s->og.header_len, f) != s->og.header_len) {
215                                         ast_log(LOG_WARNING, "fwrite() failed: %s\n", strerror(errno));
216                                 }
217                                 if (fwrite(s->og.body, 1, s->og.body_len, f) != s->og.body_len) {
218                                         ast_log(LOG_WARNING, "fwrite() failed: %s\n", strerror(errno));
219                                 }
220                                 if (ogg_page_eos(&s->og)) {
221                                         s->eos = 1;
222                                 }
223                         }
224                 }
225         }
226 }
227
228 /*!
229  * \brief Write audio data from a frame to an OGG/Vorbis filestream.
230  * \param fs An OGG/Vorbis filestream.
231  * \param f A frame containing audio to be written to the filestream.
232  * \return -1 if there was an error, 0 on success.
233  */
234 static int ogg_vorbis_write(struct ast_filestream *fs, struct ast_frame *f)
235 {
236         int i;
237         float **buffer;
238         short *data;
239         struct ogg_vorbis_desc *s = (struct ogg_vorbis_desc *) fs->_private;
240
241         if (!s->writing) {
242                 ast_log(LOG_ERROR, "This stream is not set up for writing!\n");
243                 return -1;
244         }
245         if (!f->datalen)
246                 return -1;
247
248         data = (short *) f->data.ptr;
249
250         buffer = vorbis_analysis_buffer(&s->vd, f->samples);
251
252         for (i = 0; i < f->samples; i++)
253                 buffer[0][i] = (double)data[i] / 32768.0;
254
255         vorbis_analysis_wrote(&s->vd, f->samples);
256
257         write_stream(s, fs->f);
258
259         s->writing_pcm_pos +=  f->samples;
260
261         return 0;
262 }
263
264 /*!
265  * \brief Close a OGG/Vorbis filestream.
266  * \param fs A OGG/Vorbis filestream.
267  */
268 static void ogg_vorbis_close(struct ast_filestream *fs)
269 {
270         struct ogg_vorbis_desc *s = (struct ogg_vorbis_desc *) fs->_private;
271
272         if (s->writing) {
273                 /* Tell the Vorbis encoder that the stream is finished
274                  * and write out the rest of the data */
275                 vorbis_analysis_wrote(&s->vd, 0);
276                 write_stream(s, fs->f);
277
278                 /* Cleanup */
279                 ogg_stream_clear(&s->os);
280                 vorbis_block_clear(&s->vb);
281                 vorbis_dsp_clear(&s->vd);
282                 vorbis_comment_clear(&s->vc);
283                 vorbis_info_clear(&s->vi);
284         } else {
285                 /* clear OggVorbis_File handle */
286                 ov_clear(&s->ov_f);
287         }
288 }
289
290 /*!
291  * \brief Read a frame full of audio data from the filestream.
292  * \param fs The filestream.
293  * \param whennext Number of sample times to schedule the next call.
294  * \return A pointer to a frame containing audio data or NULL ifthere is no more audio data.
295  */
296 static struct ast_frame *ogg_vorbis_read(struct ast_filestream *fs,
297                                          int *whennext)
298 {
299         struct ogg_vorbis_desc *desc = (struct ogg_vorbis_desc *) fs->_private;
300         int current_bitstream = -10;
301         char *out_buf;
302         long bytes_read;
303
304         if (desc->writing) {
305                 ast_log(LOG_WARNING, "Reading is not supported on OGG/Vorbis on write files.\n");
306                 return NULL;
307         }
308
309         /* initialize frame */
310         AST_FRAME_SET_BUFFER(&fs->fr, fs->buf, AST_FRIENDLY_OFFSET, BUF_SIZE);
311         out_buf = (char *) (fs->fr.data.ptr);   /* SLIN data buffer */
312
313         /* read samples from OV interface */
314         bytes_read = ov_read(
315                 &desc->ov_f,
316                 out_buf,                                                /* Buffer to write data */
317                 BUF_SIZE,                                               /* Size of buffer */
318                 (__BYTE_ORDER == __BIG_ENDIAN), /* Endianes (0 for little) */
319                 2,                                                              /* 1 = 8bit, 2 = 16bit */
320                 1,                                                              /* 0 = unsigned, 1 = signed */
321                 &current_bitstream                              /* Returns the current bitstream section */
322         );
323
324         /* check returned data */
325         if (bytes_read <= 0) {
326                 /* End of stream */
327                 return NULL;
328         }
329
330         /* Return decoded bytes */
331         fs->fr.datalen = bytes_read;
332         fs->fr.samples = bytes_read / 2;
333         *whennext = fs->fr.samples;
334         return &fs->fr;
335 }
336
337 /*!
338  * \brief Trucate an OGG/Vorbis filestream.
339  * \param fs The filestream to truncate.
340  * \return 0 on success, -1 on failure.
341  */
342
343 static int ogg_vorbis_trunc(struct ast_filestream *fs)
344 {
345         ast_log(LOG_WARNING, "Truncation is not supported on OGG/Vorbis streams!\n");
346         return -1;
347 }
348
349 /*!
350  * \brief Tell the current position in OGG/Vorbis filestream measured in pcms.
351  * \param fs The filestream to take action on.
352  * \return 0 or greater with the position measured in samples, or -1 for false.
353  */
354 static off_t ogg_vorbis_tell(struct ast_filestream *fs)
355 {
356         off_t pos;
357         struct ogg_vorbis_desc *desc = (struct ogg_vorbis_desc *) fs->_private;
358
359         if (desc->writing) {
360                 return desc->writing_pcm_pos;
361         }
362
363         if ((pos = ov_pcm_tell(&desc->ov_f)) < 0) {
364                 return -1;
365         }
366         return pos;
367 }
368
369 /*!
370  * \brief Seek to a specific position in an OGG/Vorbis filestream.
371  * \param fs The filestream to take action on.
372  * \param sample_offset New position for the filestream, measured in 8KHz samples.
373  * \param whence Location to measure
374  * \return 0 on success, -1 on failure.
375  */
376 static int ogg_vorbis_seek(struct ast_filestream *fs, off_t sample_offset, int whence)
377 {
378         int seek_result = -1;
379         off_t relative_pcm_pos;
380         struct ogg_vorbis_desc *desc = (struct ogg_vorbis_desc *) fs->_private;
381
382         if (desc->writing) {
383                 ast_log(LOG_WARNING, "Seeking is not supported on OGG/Vorbis streams in writing mode!\n");
384                 return -1;
385         }
386
387         /* ov_pcm_seek support seeking only from begining (SEEK_SET), the rest must be emulated */
388         switch (whence) {
389         case SEEK_SET:
390                 seek_result = ov_pcm_seek(&desc->ov_f, sample_offset);
391                 break;
392         case SEEK_CUR:
393                 if ((relative_pcm_pos = ogg_vorbis_tell(fs)) < 0) {
394                         seek_result = -1;
395                         break;
396                 }
397                 seek_result = ov_pcm_seek(&desc->ov_f, relative_pcm_pos + sample_offset);
398                 break;
399         case SEEK_END:
400                 if ((relative_pcm_pos = ov_pcm_total(&desc->ov_f, -1)) < 0) {
401                         seek_result = -1;
402                         break;
403                 }
404                 seek_result = ov_pcm_seek(&desc->ov_f, relative_pcm_pos - sample_offset);
405                 break;
406         default:
407                 ast_log(LOG_WARNING, "Unknown *whence* to seek on OGG/Vorbis streams!\n");
408                 break;
409         }
410
411         /* normalize error value to -1,0 */
412         return (seek_result == 0) ? 0 : -1;
413 }
414
415 static struct ast_format_def vorbis_f = {
416         .name = "ogg_vorbis",
417         .exts = "ogg",
418         .open = ogg_vorbis_open,
419         .rewrite = ogg_vorbis_rewrite,
420         .write = ogg_vorbis_write,
421         .seek = ogg_vorbis_seek,
422         .trunc = ogg_vorbis_trunc,
423         .tell = ogg_vorbis_tell,
424         .read = ogg_vorbis_read,
425         .close = ogg_vorbis_close,
426         .buf_size = BUF_SIZE + AST_FRIENDLY_OFFSET,
427         .desc_size = sizeof(struct ogg_vorbis_desc),
428 };
429
430 static int load_module(void)
431 {
432         vorbis_f.format = ast_format_slin;
433         if (ast_format_def_register(&vorbis_f))
434                 return AST_MODULE_LOAD_DECLINE;
435         return AST_MODULE_LOAD_SUCCESS;
436 }
437
438 static int unload_module(void)
439 {
440         return ast_format_def_unregister(vorbis_f.name);
441 }
442
443 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "OGG/Vorbis audio",
444         .support_level = AST_MODULE_SUPPORT_CORE,
445         .load = load_module,
446         .unload = unload_module,
447         .load_pri = AST_MODPRI_APP_DEPEND
448 );