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