ogg_afh_common.c

   1 /*
   2  * Copyright (C) 2004 Andre Noll <maan@tuebingen.mpg.de>
   3  *
   4  * Licensed under the GPL v2. For licencing details see COPYING.
   5  */
   6
   7 /** \file ogg_afh_common.c Functions common to all ogg/ codecs. */
   8
   9 #include <ogg/ogg.h>
  10 #include <regex.h>
  11
  12 #include "para.h"
  13 #include "afh.h"
  14 #include "error.h"
  15 #include "string.h"
  16 #include "ogg_afh_common.h"
  17 #include "fd.h"
  18
  19 /* Taken from decoder_example.c of libvorbis-1.2.3. */
  20 static int process_packets_2_and_3(ogg_sync_state *oss,
  21                 ogg_stream_state *stream, struct afh_info *afhi,
  22                 struct ogg_afh_callback_info *ci)
  23 {
  24         ogg_page page;
  25         ogg_packet packet;
  26         int i = 0;
  27
  28         while (i < 2) {
  29                 while (i < 2) {
  30                         int ret = ogg_sync_pageout(oss, &page);
  31                         if (ret == 0)
  32                                 break; /* Need more data */
  33                         if (ret != 1)
  34                                 continue;
  35                         /*
  36                          * We can ignore any errors here as they'll also become
  37                          * apparent at packetout.
  38                          */
  39                         ogg_stream_pagein(stream, &page);
  40                         PARA_INFO_LOG("ogg page serial: %d\n",
  41                                 ogg_page_serialno(&page));
  42                         while (i < 2) {
  43                                 ret = ogg_stream_packetout(stream, &packet);
  44                                 if (ret == 0)
  45                                         break;
  46                                 if (ret < 0)
  47                                         return -E_STREAM_PACKETOUT;
  48                                 ret = ci->packet_callback(&packet, i + 1,
  49                                         ogg_page_serialno(&page), afhi,
  50                                         ci->private_data);
  51                                 if (ret < 0)
  52                                         return ret;
  53                                 if (ret == 0) /* header complete */
  54                                         return 1;
  55                                 i++;
  56                         }
  57                 }
  58         }
  59         return 1;
  60 }
  61
  62 static int process_ogg_packets(ogg_sync_state *oss, struct afh_info *afhi,
  63                 struct ogg_afh_callback_info *ci)
  64 {
  65         ogg_packet packet;
  66         ogg_stream_state stream;
  67         ogg_page page;
  68         int ret;
  69
  70         if (ogg_sync_pageout(oss, &page) != 1)
  71                 return -E_SYNC_PAGEOUT;
  72
  73         ret = ogg_page_serialno(&page);
  74         ogg_stream_init(&stream, ret);
  75
  76         ret = -E_STREAM_PAGEIN;
  77         if (ogg_stream_pagein(&stream, &page) < 0)
  78                 goto out;
  79
  80         ret = -E_STREAM_PACKETOUT;
  81         if (ogg_stream_packetout(&stream, &packet) != 1)
  82                 goto out;
  83         ret = ci->packet_callback(&packet, 0, ogg_page_serialno(&page),
  84                 afhi, ci->private_data);
  85         if (ret < 0)
  86                 goto out;
  87         ret = process_packets_2_and_3(oss, &stream, afhi, ci);
  88         if (ret < 0)
  89                 goto out;
  90         ret = 1;
  91 out:
  92         ogg_stream_clear(&stream);
  93         return ret;
  94 }
  95
  96 static void set_chunk_tv(int frames_per_chunk, int frequency,
  97                 struct timeval *result)
  98 {
  99         uint64_t x = (uint64_t)frames_per_chunk * 1000 * 1000 / frequency;
 100
 101         result->tv_sec = x / 1000 / 1000;
 102         result->tv_usec = x % (1000 * 1000);
 103         PARA_INFO_LOG("%d frames per chunk, chunk time: %lums\n",
 104                 frames_per_chunk, tv2ms(result));
 105 }
 106
 107 /**
 108  * Pass first three ogg packets to callback and build the chunk table.
 109  *
 110  * This function extracts the first three ogg packets of the audio data
 111  * given by \a map and \a numbytes and passes each packet to the callback
 112  * defined by \a ci.
 113  *
 114  * If the packet callback indicates success and \a afhi is not \p NULL, the
 115  * chunk table is built. Chunk zero contains the first three ogg packets while
 116  * all other chunks consist of exactly one ogg page.
 117  *
 118  * \param map Audio file data.
 119  * \param numbytes The length of \a map.
 120  * \param afhi Passed to the packet callback, contains chunk table.
 121  * \param ci The callback structure.
 122  *
 123  * \return Standard.
 124  */
 125 int ogg_get_file_info(char *map, size_t numbytes, struct afh_info *afhi,
 126                 struct ogg_afh_callback_info *ci)
 127 {
 128         ogg_sync_state oss;
 129         ogg_page op;
 130         long len = numbytes;
 131         char *buf;
 132         int ret, i, j, frames_per_chunk, ct_size;
 133         long long unsigned num_frames = 0;
 134
 135         ogg_sync_init(&oss);
 136         ret = -E_OGG_SYNC;
 137         buf = ogg_sync_buffer(&oss, len);
 138         if (!buf)
 139                 goto out;
 140         memcpy(buf, map, len);
 141         ret = -E_OGG_SYNC;
 142         if (ogg_sync_wrote(&oss, len) < 0)
 143                 goto out;
 144         ret = process_ogg_packets(&oss, afhi, ci);
 145         if (ret < 0)
 146                 goto out;
 147         if (!afhi)
 148                 goto out;
 149         afhi->header_len = oss.returned;
 150         oss.returned = 0;
 151         oss.fill = numbytes;
 152         /* count ogg pages and get duration of the file */
 153         for (i = 0; ogg_sync_pageseek(&oss, &op) > 0; i++)
 154                 num_frames = ogg_page_granulepos(&op);
 155         PARA_INFO_LOG("%d pages, %llu frames\n", i, num_frames);
 156         ret = -E_OGG_EMPTY;
 157         if (i == 0)
 158                 goto out;
 159         afhi->seconds_total = num_frames / afhi->frequency;
 160         /* use roughly one page per chunk */
 161         frames_per_chunk = num_frames / i;
 162         PARA_INFO_LOG("%" PRIu32 "seconds, %d frames/chunk\n",
 163                 afhi->seconds_total, frames_per_chunk);
 164         ct_size = 250;
 165         afhi->chunk_table = para_malloc(ct_size * sizeof(uint32_t));
 166         afhi->chunk_table[0] = 0;
 167         afhi->chunk_table[1] = afhi->header_len;
 168         oss.returned = afhi->header_len;
 169         oss.fill = numbytes;
 170         for (j = 1; ogg_sync_pageseek(&oss, &op) > 0; /* nothing */) {
 171                 int granule = ogg_page_granulepos(&op);
 172
 173                 while (granule >= (j + 1) * frames_per_chunk) {
 174                         j++;
 175                         if (j >= ct_size) {
 176                                 ct_size *= 2;
 177                                 afhi->chunk_table = para_realloc(
 178                                         afhi->chunk_table,
 179                                         ct_size * sizeof(uint32_t));
 180                         }
 181                         afhi->chunk_table[j] = oss.returned;
 182                 }
 183         }
 184         afhi->chunks_total = j;
 185         set_chunk_tv(frames_per_chunk, afhi->frequency, &afhi->chunk_tv);
 186         ret = 0;
 187 out:
 188         ogg_sync_clear(&oss);
 189         return ret;
 190 }
 191
 192 static int write_ogg_page(int fd, const ogg_page *op)
 193 {
 194         int ret;
 195
 196         PARA_DEBUG_LOG("header/body: %li/%li\n", op->header_len, op->body_len);
 197         ret = xwrite(fd, (const char *)op->header, op->header_len);
 198         if (ret < 0)
 199                 return ret;
 200         return xwrite(fd, (const char *)op->body, op->body_len);
 201 }
 202
 203 /**
 204  * Change meta tags of ogg files.
 205  *
 206  * \param map The (read-only) memory map of the input file.
 207  * \param map_sz The size of the input file in bytes.
 208  * \param fd The output file descriptor.
 209  * \param meta_packet Codec-specific packet containing modified tags.
 210  * \param meta_sz Size of the metadata packet.
 211  *
 212  * This function writes a new ogg file content using file descriptor \a fd,
 213  * which must correspond to a file which has been opened for writing.  The
 214  * second packet is supposed to contain the metadata, and is replaced by \a
 215  * meta_packet. This output file has to be closed by the caller.
 216  *
 217  * \return Standard.
 218  */
 219 int ogg_rewrite_tags(const char *map, size_t map_sz, int fd,
 220                 char *meta_packet, size_t meta_sz)
 221 {
 222         ogg_sync_state oss_in, oss_out;
 223         ogg_stream_state stream_in, stream_out, *si = NULL, *so = NULL;
 224         ogg_packet packet;
 225         ogg_page op;
 226         char *buf;
 227         int serial, ret;
 228         long len = map_sz;
 229
 230         ogg_sync_init(&oss_in);
 231         ogg_sync_init(&oss_out);
 232
 233         ret = -E_OGG_SYNC;
 234         buf = ogg_sync_buffer(&oss_in, len);
 235         if (!buf)
 236                 goto out;
 237         memcpy(buf, map, len);
 238         ret = -E_OGG_SYNC;
 239         if (ogg_sync_wrote(&oss_in, len) < 0)
 240                 goto out;
 241         if (ogg_sync_pageout(&oss_in, &op) != 1)
 242                 goto out;
 243         ret = ogg_page_serialno(&op);
 244         serial = ret;
 245
 246         si = &stream_in;
 247         ogg_stream_init(si, serial);
 248         /* Packet #0 goes to an own page */
 249         ret = -E_STREAM_PAGEIN;
 250         if (ogg_stream_pagein(si, &op) < 0)
 251                 goto out;
 252         ret = -E_STREAM_PACKETOUT;
 253         if (ogg_stream_packetout(si, &packet) != 1)
 254                 goto out;
 255         ret = -E_STREAM_PACKETIN;
 256         so = &stream_out;
 257         ogg_stream_init(so, serial);
 258         if (ogg_stream_packetin(so, &packet) != 0)
 259                 goto out;
 260         ret = ogg_stream_flush(so, &op);
 261         assert(ret != 0);
 262         /* packets have been flushed into the page. */
 263         ret = write_ogg_page(fd, &op);
 264         if (ret < 0)
 265                 goto out;
 266         /*
 267          * For all supported ogg/xxx audio formats the meta data packet is
 268          * packet #1. Write out our modified version of this packet.
 269          */
 270         packet.packetno = 1;
 271         packet.b_o_s = packet.e_o_s = 0;
 272         packet.packet = (typeof(packet.packet))meta_packet;
 273         packet.bytes = meta_sz;
 274         ret = -E_STREAM_PACKETIN;
 275         if (ogg_stream_packetin(so, &packet) != 0)
 276                 goto out;
 277         /* Copy ogg packets, ignoring the meta data packet. */
 278         for (;;) {
 279                 ret = ogg_stream_packetout(si, &packet);
 280                 if (ret == -1)
 281                         break;
 282                 if (ret != 1) {
 283                         ret = -E_STREAM_PAGEOUT;
 284                         if (ogg_sync_pageout(&oss_in, &op) < 0)
 285                                 goto out;
 286                         ret = -E_STREAM_PAGEIN;
 287                         if (ogg_stream_pagein(si, &op))
 288                                 goto out;
 289                         continue;
 290                 }
 291                 PARA_DEBUG_LOG("packet: bytes: %d, granule: %d, packetno: %d\n",
 292                         (int)packet.bytes, (int)packet.granulepos,
 293                         (int)packet.packetno);
 294                 /* ignore meta data packet which we replaced */
 295                 if (packet.packetno == 1)
 296                         continue;
 297                 ret = -E_STREAM_PACKETIN;
 298                 if (ogg_stream_packetin(so, &packet) != 0)
 299                         goto out;
 300                 /* only create a new ogg page if granulepos is valid */
 301                 if (packet.granulepos == -1)
 302                         continue;
 303                 /* force remaining packets into a page */
 304                 for (;;) {
 305 #ifdef HAVE_OGG_STREAM_FLUSH_FILL
 306                         ret = ogg_stream_flush_fill(so, &op, INT_MAX);
 307 #else
 308                         ret = ogg_stream_flush(so, &op);
 309 #endif
 310                         if (ret <= 0)
 311                                 break;
 312                         PARA_DEBUG_LOG("writing page (%li bytes)\n",
 313                                 op.header_len + op.body_len);
 314                         ret = write_ogg_page(fd, &op);
 315                         if (ret < 0)
 316                                 goto out;
 317                 }
 318         }
 319         if (ogg_stream_flush(so, &op)) {
 320                 /* write remaining data */
 321                 ret = write_ogg_page(fd, &op);
 322                 if (ret < 0)
 323                         goto out;
 324         }
 325         ret = 1;
 326 out:
 327         ogg_sync_clear(&oss_in);
 328         ogg_sync_clear(&oss_out);
 329         if (si)
 330                 ogg_stream_clear(si);
 331         if (so)
 332                 ogg_stream_clear(so);
 333         return ret;
 334 }