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