ogg_afh_common.c

   1 /* Copyright (C) 2004 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
   2
   3 /** \file ogg_afh_common.c Functions common to all ogg/ codecs. */
   4
   5 #include <ogg/ogg.h>
   6 #include <regex.h>
   7
   8 #include "para.h"
   9 #include "afh.h"
  10 #include "error.h"
  11 #include "string.h"
  12 #include "ogg_afh_common.h"
  13 #include "fd.h"
  14
  15 /* Taken from decoder_example.c of libvorbis-1.2.3. */
  16 static int process_packets_2_and_3(ogg_sync_state *oss,
  17                 ogg_stream_state *stream, struct afh_info *afhi,
  18                 struct oac_callback_info *ci)
  19 {
  20         ogg_page page;
  21         ogg_packet packet;
  22         int i = 0;
  23
  24         while (i < 2) {
  25                 while (i < 2) {
  26                         int ret = ogg_sync_pageout(oss, &page);
  27                         if (ret == 0)
  28                                 break; /* Need more data */
  29                         if (ret != 1)
  30                                 continue;
  31                         /*
  32                          * We can ignore any errors here as they'll also become
  33                          * apparent at packetout.
  34                          */
  35                         ogg_stream_pagein(stream, &page);
  36                         PARA_INFO_LOG("ogg page serial: %d\n",
  37                                 ogg_page_serialno(&page));
  38                         while (i < 2) {
  39                                 ret = ogg_stream_packetout(stream, &packet);
  40                                 if (ret == 0)
  41                                         break;
  42                                 if (ret < 0)
  43                                         return -E_STREAM_PACKETOUT;
  44                                 ret = ci->packet_callback(&packet, i + 1,
  45                                         ogg_page_serialno(&page), afhi,
  46                                         ci->private_data);
  47                                 if (ret < 0)
  48                                         return ret;
  49                                 if (ret == 0) /* header complete */
  50                                         return 1;
  51                                 i++;
  52                         }
  53                 }
  54         }
  55         return 1;
  56 }
  57
  58 static int process_ogg_packets(ogg_sync_state *oss, struct afh_info *afhi,
  59                 struct oac_callback_info *ci)
  60 {
  61         ogg_packet packet;
  62         ogg_stream_state stream;
  63         ogg_page page;
  64         int ret;
  65
  66         if (ogg_sync_pageout(oss, &page) != 1)
  67                 return -E_SYNC_PAGEOUT;
  68
  69         ret = ogg_page_serialno(&page);
  70         ogg_stream_init(&stream, ret);
  71
  72         ret = -E_STREAM_PAGEIN;
  73         if (ogg_stream_pagein(&stream, &page) < 0)
  74                 goto out;
  75
  76         ret = -E_STREAM_PACKETOUT;
  77         if (ogg_stream_packetout(&stream, &packet) != 1)
  78                 goto out;
  79         ret = ci->packet_callback(&packet, 0, ogg_page_serialno(&page),
  80                 afhi, ci->private_data);
  81         if (ret < 0)
  82                 goto out;
  83         ret = process_packets_2_and_3(oss, &stream, afhi, ci);
  84         if (ret < 0)
  85                 goto out;
  86         ret = 1;
  87 out:
  88         ogg_stream_clear(&stream);
  89         return ret;
  90 }
  91
  92 static void set_chunk_tv(int frames_per_chunk, int frequency,
  93                 struct timeval *result)
  94 {
  95         uint64_t x = (uint64_t)frames_per_chunk * 1000 * 1000 / frequency;
  96
  97         result->tv_sec = x / 1000 / 1000;
  98         result->tv_usec = x % (1000 * 1000);
  99         PARA_INFO_LOG("%d frames per chunk, chunk time: %lums\n",
 100                 frames_per_chunk, tv2ms(result));
 101 }
 102
 103 /**
 104  * Pass first three ogg packets to callback and build the chunk table.
 105  *
 106  * This function extracts the first three ogg packets of the audio data
 107  * given by \a map and \a numbytes and passes each packet to the callback
 108  * defined by \a ci.
 109  *
 110  * If the packet callback indicates success and \a afhi is not \p NULL, the
 111  * chunk table is built. Chunk zero contains the first three ogg packets while
 112  * all other chunks consist of exactly one ogg page.
 113  *
 114  * \param map Audio file data.
 115  * \param numbytes The length of \a map.
 116  * \param afhi Passed to the packet callback, contains chunk table.
 117  * \param ci The callback structure.
 118  *
 119  * \return Standard.
 120  */
 121 int oac_get_file_info(char *map, size_t numbytes, struct afh_info *afhi,
 122                 struct oac_callback_info *ci)
 123 {
 124         ogg_sync_state oss;
 125         ogg_page op;
 126         char *buf;
 127         int ret, i, j, frames_per_chunk, ct_size;
 128         long long unsigned num_frames = 0;
 129
 130         ogg_sync_init(&oss);
 131         ret = -E_OGG_SYNC;
 132         buf = ogg_sync_buffer(&oss, numbytes);
 133         if (!buf)
 134                 goto out;
 135         memcpy(buf, map, numbytes);
 136         ret = -E_OGG_SYNC;
 137         if (ogg_sync_wrote(&oss, numbytes) < 0)
 138                 goto out;
 139         ret = process_ogg_packets(&oss, afhi, ci);
 140         if (ret < 0)
 141                 goto out;
 142         if (!afhi)
 143                 goto out;
 144         afhi->header_len = oss.returned;
 145         oss.returned = 0;
 146         oss.fill = numbytes;
 147         /* count ogg pages and get duration of the file */
 148         for (i = 0; ogg_sync_pageseek(&oss, &op) > 0; i++)
 149                 num_frames = ogg_page_granulepos(&op);
 150         PARA_INFO_LOG("%d pages, %llu frames\n", i, num_frames);
 151         ret = -E_OGG_EMPTY;
 152         if (i == 0)
 153                 goto out;
 154         afhi->seconds_total = num_frames / afhi->frequency;
 155         /* use roughly one page per chunk */
 156         frames_per_chunk = num_frames / i;
 157         PARA_INFO_LOG("%" PRIu32 " seconds, %d frames/chunk\n",
 158                 afhi->seconds_total, frames_per_chunk);
 159         ct_size = 250;
 160         afhi->chunk_table = para_malloc(ct_size * sizeof(uint32_t));
 161         afhi->chunk_table[0] = 0;
 162         afhi->chunk_table[1] = afhi->header_len;
 163         oss.returned = afhi->header_len;
 164         oss.fill = numbytes;
 165         for (j = 1; ogg_sync_pageseek(&oss, &op) > 0; /* nothing */) {
 166                 int granule = ogg_page_granulepos(&op);
 167
 168                 while (granule >= (j + 1) * frames_per_chunk) {
 169                         j++;
 170                         if (j >= ct_size) {
 171                                 ct_size *= 2;
 172                                 afhi->chunk_table = para_realloc(
 173                                         afhi->chunk_table,
 174                                         ct_size * sizeof(uint32_t));
 175                         }
 176                         afhi->chunk_table[j] = oss.returned;
 177                 }
 178         }
 179         afhi->chunks_total = j;
 180         set_max_chunk_size(afhi);
 181         set_chunk_tv(frames_per_chunk, afhi->frequency, &afhi->chunk_tv);
 182         ret = 0;
 183 out:
 184         ogg_sync_clear(&oss);
 185         return ret;
 186 }
 187
 188 static int write_ogg_page(int fd, const ogg_page *op)
 189 {
 190         int ret;
 191
 192         PARA_DEBUG_LOG("header/body: %li/%li\n", op->header_len, op->body_len);
 193         ret = xwrite(fd, (const char *)op->header, op->header_len);
 194         if (ret < 0)
 195                 return ret;
 196         return xwrite(fd, (const char *)op->body, op->body_len);
 197 }
 198
 199 /**
 200  * Change meta tags of ogg files.
 201  *
 202  * \param map The (read-only) memory map of the input file.
 203  * \param map_sz The size of the input file in bytes.
 204  * \param fd The output file descriptor.
 205  * \param meta_packet Codec-specific packet containing modified tags.
 206  * \param meta_sz Size of the metadata packet.
 207  *
 208  * This function writes a new ogg file content using file descriptor \a fd,
 209  * which must correspond to a file which has been opened for writing.  The
 210  * second packet is supposed to contain the metadata, and is replaced by \a
 211  * meta_packet. This output file has to be closed by the caller.
 212  *
 213  * \return Standard.
 214  */
 215 int oac_rewrite_tags(const char *map, size_t map_sz, int fd,
 216                 char *meta_packet, size_t meta_sz)
 217 {
 218         ogg_sync_state oss_in, oss_out;
 219         ogg_stream_state stream_in, stream_out, *si = NULL, *so = NULL;
 220         ogg_packet packet;
 221         ogg_page op;
 222         char *buf;
 223         int serial, ret;
 224         long len = map_sz;
 225
 226         ogg_sync_init(&oss_in);
 227         ogg_sync_init(&oss_out);
 228
 229         ret = -E_OGG_SYNC;
 230         buf = ogg_sync_buffer(&oss_in, len);
 231         if (!buf)
 232                 goto out;
 233         memcpy(buf, map, len);
 234         ret = -E_OGG_SYNC;
 235         if (ogg_sync_wrote(&oss_in, len) < 0)
 236                 goto out;
 237         if (ogg_sync_pageout(&oss_in, &op) != 1)
 238                 goto out;
 239         ret = ogg_page_serialno(&op);
 240         serial = ret;
 241
 242         si = &stream_in;
 243         ogg_stream_init(si, serial);
 244         /* Packet #0 goes to an own page */
 245         ret = -E_STREAM_PAGEIN;
 246         if (ogg_stream_pagein(si, &op) < 0)
 247                 goto out;
 248         ret = -E_STREAM_PACKETOUT;
 249         if (ogg_stream_packetout(si, &packet) != 1)
 250                 goto out;
 251         ret = -E_STREAM_PACKETIN;
 252         so = &stream_out;
 253         ogg_stream_init(so, serial);
 254         if (ogg_stream_packetin(so, &packet) != 0)
 255                 goto out;
 256         ret = ogg_stream_flush(so, &op);
 257         assert(ret != 0);
 258         /* packets have been flushed into the page. */
 259         ret = write_ogg_page(fd, &op);
 260         if (ret < 0)
 261                 goto out;
 262         /*
 263          * For all supported ogg/xxx audio formats the meta data packet is
 264          * packet #1. Write out our modified version of this packet.
 265          */
 266         packet.packetno = 1;
 267         packet.b_o_s = packet.e_o_s = 0;
 268         packet.packet = (typeof(packet.packet))meta_packet;
 269         packet.bytes = meta_sz;
 270         ret = -E_STREAM_PACKETIN;
 271         if (ogg_stream_packetin(so, &packet) != 0)
 272                 goto out;
 273         /* Copy ogg packets, ignoring the meta data packet. */
 274         for (;;) {
 275                 ret = ogg_stream_packetout(si, &packet);
 276                 if (ret == -1)
 277                         break;
 278                 if (ret != 1) {
 279                         ret = -E_STREAM_PAGEOUT;
 280                         if (ogg_sync_pageout(&oss_in, &op) < 0)
 281                                 goto out;
 282                         ret = -E_STREAM_PAGEIN;
 283                         if (ogg_stream_pagein(si, &op))
 284                                 goto out;
 285                         continue;
 286                 }
 287                 PARA_DEBUG_LOG("packet: bytes: %d, granule: %d, packetno: %d\n",
 288                         (int)packet.bytes, (int)packet.granulepos,
 289                         (int)packet.packetno);
 290                 /* ignore meta data packet which we replaced */
 291                 if (packet.packetno == 1)
 292                         continue;
 293                 ret = -E_STREAM_PACKETIN;
 294                 if (ogg_stream_packetin(so, &packet) != 0)
 295                         goto out;
 296                 /* only create a new ogg page if granulepos is valid */
 297                 if (packet.granulepos == -1)
 298                         continue;
 299                 /* force remaining packets into a page */
 300                 for (;;) {
 301 #ifdef HAVE_OGG_STREAM_FLUSH_FILL
 302                         ret = ogg_stream_flush_fill(so, &op, INT_MAX);
 303 #else
 304                         ret = ogg_stream_flush(so, &op);
 305 #endif
 306                         if (ret <= 0)
 307                                 break;
 308                         PARA_DEBUG_LOG("writing page (%li bytes)\n",
 309                                 op.header_len + op.body_len);
 310                         ret = write_ogg_page(fd, &op);
 311                         if (ret < 0)
 312                                 goto out;
 313                 }
 314         }
 315         if (ogg_stream_flush(so, &op)) {
 316                 /* write remaining data */
 317                 ret = write_ogg_page(fd, &op);
 318                 if (ret < 0)
 319                         goto out;
 320         }
 321         ret = 1;
 322 out:
 323         ogg_sync_clear(&oss_in);
 324         ogg_sync_clear(&oss_out);
 325         if (si)
 326                 ogg_stream_clear(si);
 327         if (so)
 328                 ogg_stream_clear(so);
 329         return ret;
 330 }
 331
 332 /* Structure for providing custom headers for streaming. */
 333 struct oac_custom_header {
 334         char *buf;
 335         size_t len;
 336         ogg_stream_state oss;
 337 };
 338
 339 /**
 340  * Allocate and return a custom header structure.
 341  *
 342  * For some audio codecs which employ the ogg container format, the server side
 343  * wants to replace the meta tags at the beginning of the file because they are
 344  * not needed for streaming and can be arbitrary large. The structure returned
 345  * by this function is typically used as the ->private field of struct \ref
 346  * oac_callback_info for \ref oac_get_file_info(). This allows the audio format
 347  * handler to set up a custom header which is identical to the original header,
 348  * but with the meta data part replaced by fixed length dummy contents.
 349  *
 350  * \return The returned memory must be initialized with the serial number of
 351  * the ogg stream before ogg packets can be submitted to it. This is not done
 352  * here because the header structure is allocated before \ref
 353  * oac_get_file_info() is called, and the serial number is not known at this
 354  * point.
 355  *
 356  * \sa \ref oac_custom_header_init().
 357  */
 358 struct oac_custom_header *oac_custom_header_new(void)
 359 {
 360         return para_calloc(sizeof(struct oac_custom_header));
 361 }
 362
 363 /**
 364  * Set the serial number of an allocated header structure.
 365  *
 366  * \param serial Passed to the callback function.
 367  * \param h As returned from \ref oac_custom_header_new().
 368  *
 369  * This function must be called before any packets are submitted.
 370  */
 371 void oac_custom_header_init(int serial, struct oac_custom_header *h)
 372 {
 373         ogg_stream_init(&h->oss, serial);
 374 }
 375
 376 /**
 377  * Submit an ogg packet to a custom header structure.
 378  *
 379  * \param op The packet to append.
 380  * \param h Must be initialized.
 381  *
 382  * The packet may be the one which was passed to the callback, or a completely
 383  * different one, like a dummy metadata packet.
 384  *
 385  * \return Standard.
 386  */
 387 int oac_custom_header_append(ogg_packet *op, struct oac_custom_header *h)
 388 {
 389         return ogg_stream_packetin(&h->oss, op) < 0? -E_OGG_PACKET_IN : 1;
 390 }
 391
 392 /**
 393  * Force remaining packets into an ogg page.
 394  *
 395  * \param h Should contain submitted but not yet flushed packets.
 396  *
 397  * This is called after the first packet has been submitted with \ref
 398  * oac_custom_header_append() to make sure the first ogg page contains only
 399  * this packet. Also when header processing is complete, the callbacks call
 400  * this to force the previously submitted packets into a page.
 401  */
 402 void oac_custom_header_flush(struct oac_custom_header *h)
 403 {
 404         ogg_page og;
 405
 406         while (ogg_stream_flush(&h->oss, &og)) {
 407                 size_t len = og.header_len + og.body_len;
 408                 h->buf = para_realloc(h->buf, h->len + len);
 409                 memcpy(h->buf + h->len, og.header, og.header_len);
 410                 memcpy(h->buf + h->len + og.header_len, og.body, og.body_len);
 411                 h->len += len;
 412         }
 413 }
 414
 415 /**
 416  * Return the custom header buffer and deallocate resources.
 417  *
 418  * This is called after the ogg packets which comprise the header have been
 419  * submitted and flushed.
 420  *
 421  * \param buf Result pointer.
 422  * \param h Must not be used any more after the call.
 423  *
 424  * \return The size of the header. This is the sum of the sizes of all ogg
 425  * pages that have been flushed out.
 426  */
 427 size_t oac_custom_header_get(char **buf, struct oac_custom_header *h)
 428 {
 429         size_t ret = h->len;
 430
 431         *buf = h->buf;
 432         ogg_stream_clear(&h->oss);
 433         free(h);
 434         return ret;
 435 }