oggz-chop.c 18 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
/*
   Copyright (C) 2008 Annodex Association

   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
   are met:

   - Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.

   - Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

   - Neither the name of the Annodex Association nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.

   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
   PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE ASSOCIATION OR
   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#include "config.h"

#include <stdlib.h>
#include <string.h>
#include <getopt.h>
#include <errno.h>
38
#include <math.h>
39 40 41

#include <oggz/oggz.h>

42
#include "oggz-chop.h"
43
#include "skeleton.h"
44

45 46 47 48 49 50
#ifdef OGG_H_CONST_CORRECT
#define OGG_PAGE_CONST(x) (x)
#else
#define OGG_PAGE_CONST(x) ((ogg_page *)x)
#endif

51 52 53 54
#ifdef WIN32                                                                   
#define snprintf _snprintf
#endif 

55 56 57 58 59
/************************************************************
 * OCTrackState
 */

typedef struct _OCTrackState {
60 61 62 63
  /* Skeleton track info (fisbone) */
  fisbone_packet fisbone;

  /* Page accumulator for the GOP before the chop start */
64 65 66 67
  OggzTable * page_accum;

  int headers_remaining;

68
  int rec_skeleton;
69 70 71 72 73 74

  /* Greatest previously inferred keyframe value */
  ogg_int64_t prev_keyframe;

} OCTrackState;

75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
static OCTrackState *
track_state_new (void)
{
  OCTrackState * ts;

  ts = (OCTrackState *) malloc (sizeof(*ts));

  memset (ts, 0, sizeof(*ts));

  return ts;
}

static void
track_state_delete (OCTrackState * ts)
{
  if (ts == NULL) return;

92 93
  fisbone_clear (&ts->fisbone);

94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
  /* XXX: delete accumulated pages */
  oggz_table_delete (ts->page_accum);

  free (ts);

  return;
}

/* Add a track to the overall state */
static OCTrackState *
track_state_add (OggzTable * state, long serialno)
{
  OCTrackState * ts;

  ts = track_state_new ();
109

110 111 112 113 114 115 116 117
  if (oggz_table_insert (state, serialno, ts) == ts) {
    return ts;
  } else {
    track_state_delete (ts);
    return NULL;
  }
}

118 119 120
static void
state_init (OCState * state)
{
121 122 123 124 125
  /* Initialize fishead presentation time */
  state->fishead.ptime_n = state->start / (ogg_int64_t)1000;
  state->fishead.ptime_d = 1000;

  /* Initialize track table and page accumulator */
126
  state->tracks = oggz_table_new ();
127
  state->status = OC_INIT;
128 129 130 131 132 133 134 135 136 137 138 139 140 141
}

static void
state_clear (OCState * state)
{
  int i, ntracks;

  ntracks = oggz_table_size (state->tracks);
  for (i = 0; i < ntracks; i++) {
    track_state_delete (oggz_table_nth(state->tracks, i, NULL));
  }
  oggz_table_delete (state->tracks);
}

142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
/************************************************************
 * ogg_page helpers
 */

static ogg_page *
_ogg_page_copy (const ogg_page * og)
{
  ogg_page * new_og;

  new_og = malloc (sizeof (*og));
  new_og->header = malloc (og->header_len);
  new_og->header_len = og->header_len;
  memcpy (new_og->header, og->header, og->header_len);
  new_og->body = malloc (og->body_len);
  new_og->body_len = og->body_len;
  memcpy (new_og->body, og->body, og->body_len);

  return new_og;
}

static void
_ogg_page_free (const ogg_page * og)
{
  if (og == NULL) return;

  free (og->header);
  free (og->body);
  free ((ogg_page *)og);
}

static void
_ogg_page_set_eos (const ogg_page * og)
{
  if (og == NULL) return;

  og->header[5] |= 0x04;
178
  ogg_page_checksum_set (OGG_PAGE_CONST(og));
179 180 181
}

static void
182
fwrite_ogg_page (FILE * outfile, const ogg_page * og)
183 184 185 186 187 188 189
{
  if (og == NULL) return;

  fwrite (og->header, 1, og->header_len, outfile);
  fwrite (og->body, 1, og->body_len, outfile);
}

190 191 192 193 194 195 196 197 198 199
/************************************************************
 * OCPageAccum
 */

typedef struct _OCPageAccum {
  ogg_page * og;
  double time;
} OCPageAccum;

static OCPageAccum *
200
page_accum_new (const ogg_page * og, double time)
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
{
  OCPageAccum * pa;

  pa = malloc(sizeof (*pa));
  pa->og = _ogg_page_copy (og);
  pa->time = time;

  return pa;
}

static void
page_accum_delete (OCPageAccum * pa)
{
  if (pa == NULL) return;

  _ogg_page_free (pa->og);
  free (pa);
}

static void
track_state_remove_page_accum (OCTrackState * ts)
{
  int i, accum_size;

  if (ts == NULL || ts->page_accum == NULL) return;

  accum_size = oggz_table_size (ts->page_accum);

229
  for (i = accum_size-1; i >= 0; i--) {
230 231 232 233 234
    page_accum_delete((OCPageAccum *)oggz_table_lookup (ts->page_accum, i));
    oggz_table_remove (ts->page_accum, (long)i);
  }
}

235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
/*
 * Advance the page accumulator:
 *   - Remove all pages that only contain packets from the previous GOP.
 *   - Shift all remaining packets to start from index 0
 * Returns: the new size of the page accumulator.
 */
static int
track_state_advance_page_accum (OCTrackState * ts)
{
  int i, accum_size;
  int e, earliest_new; /* Index into page accumulator of the earliest page that
                        * contains a packet from the new GOP */
  OCPageAccum * pa;

  if (ts == NULL || ts->page_accum == NULL) return 0;

  earliest_new = accum_size = oggz_table_size (ts->page_accum);

  /* Working backwards through the page accumulator ... */
  for (i = accum_size-1; i >= 0; i--) {
    pa = (OCPageAccum *) oggz_table_lookup (ts->page_accum, i);

257
    /* If we have a page with granulepos, it necessarily contains the end
258 259 260 261 262 263 264 265 266
     * of a packet from an earlier GOP, and thus this is the last page that
     * we need to recover.
     */
    if (ogg_page_granulepos (pa->og) != -1) {
      earliest_new = i;
      break;
    }
  }

267 268
  /* If all accumulated pages have no granulepos, keep them,
   * and do not modify start_granule */
269 270
  if (earliest_new == 0) return accum_size;

271 272 273 274 275 276
  if (earliest_new > accum_size)
    earliest_new = accum_size;

  /* Delete the rest */
  for (i = earliest_new-1; i >= 0; i--) {
    pa = (OCPageAccum *) oggz_table_lookup (ts->page_accum, i);
277 278 279
    /* Record this track's start_granule as the granulepos of the page prior
     * to earliest_new */
    if (i == (earliest_new-1)) {
280
      ts->fisbone.start_granule = ogg_page_granulepos (pa->og);
281
    }
282 283 284 285 286 287 288 289 290 291 292 293 294 295
    page_accum_delete(pa);
    oggz_table_remove (ts->page_accum, (long)i);
  }

  /* Shift the best */
  for (i = 0, e = earliest_new; e < accum_size; i++, e++) {
    pa = (OCPageAccum *) oggz_table_lookup (ts->page_accum, e);
    oggz_table_insert (ts->page_accum, i, pa);
    oggz_table_remove (ts->page_accum, (long)e);
  }

  return accum_size - earliest_new;
}

296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
/************************************************************
 * chop
 */

/*
 * OggzReadPageCallback read_plain
 *
 * A page reading callback for tracks without granuleshift.
 */
static int
read_plain (OGGZ * oggz, const ogg_page * og, long serialno, void * user_data)
{
  OCState * state = (OCState *)user_data;
  OCTrackState * ts;
  double page_time;
311
  long gp;
312 313 314 315 316

  ts = oggz_table_lookup (state->tracks, serialno);

  page_time = oggz_tell_units (oggz) / 1000.0;

317
#ifdef DEBUG
318 319 320 321 322
  printf ("page_time: %g\tspan (%g, %g)\n", page_time, state->start, state->end);
  printf ("\tpageno: %d, numheaders %d\n", ogg_page_pageno(og),
          oggz_stream_get_numheaders (oggz, serialno));
#endif

323 324
  if (page_time < state->start) {
    if ((gp = ogg_page_granulepos (og)) != -1)
325
      ts->fisbone.start_granule = ogg_page_granulepos (og);
326
  } else if (page_time >= state->start &&
327
      (state->end == -1 || page_time <= state->end)) {
328 329
    if (!ts->rec_skeleton) {
#ifdef DEBUG
330 331
      printf ("read_plain: start granule for serialno %010ld: %ld\n",
              serialno, ts->fisbone.start_granule);
332 333 334
#endif
      ts->rec_skeleton = 1;
    }
335 336 337 338 339 340 341 342 343 344 345 346 347
    fwrite_ogg_page (state->outfile, og);
  } else if (state->end != -1.0 && page_time > state->end) {
    /* This is the first page past the end time; set EOS */
    _ogg_page_set_eos (og);
    fwrite_ogg_page (state->outfile, og);

    /* Stop handling this track */
    oggz_set_read_page (oggz, serialno, NULL, NULL);
  }

  return OGGZ_CONTINUE;
}

348 349 350 351 352 353 354 355 356 357 358
static int
write_accum (OCState * state)
{
  OCTrackState * ts;
  OCPageAccum * pa;
  OggzTable * candidates;
  long serialno, min_serialno;
  int i, ntracks, ncandidates=0, remaining=0, min_i, cn, min_cn;
  ogg_page * og, * min_og;
  double min_time;

359
  if (state->status >= OC_WRITTEN_ACCUM) return -1;
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427

  /*
   * We create a table of candidate tracks, which are all those which
   * have a page_accum table, ie. for which granuleshift matters.
   * We insert into this table the index of the next page_accum element
   * to be merged for that track. All start at 0.
   * The variable 'remaining' counts down the total number of accumulated
   * pages to be written from all candidate tracks.
   */

  /* Prime candidates */
  candidates = oggz_table_new ();
  ntracks = oggz_table_size (state->tracks);
  for (i=0; i < ntracks; i++) {
    ts = oggz_table_nth (state->tracks, i, &serialno);
    if (ts != NULL && ts->page_accum != NULL) {
      ncandidates++;
      /* XXX: we offset the candidate index by 7 to avoid storing 0, as
       * OggzTable treats insertion of NULL as a deletion */
      oggz_table_insert (candidates, serialno, (void *)0x7);
      remaining += oggz_table_size (ts->page_accum);
    }
  }

  /* Merge candidates */
  while (remaining > 0) {
    /* Find minimum page in all accum buffers */
    min_time = 10e100;
    min_cn = -1;
    min_og = NULL;
    min_serialno = -1;
    for (i=0; i < ncandidates; i++) {
      cn = ((int) oggz_table_nth (candidates, i, &serialno)) - 7;
      ts = oggz_table_lookup (state->tracks, serialno);
      if (ts && ts->page_accum) {
        if (cn < oggz_table_size (ts->page_accum)) {
          pa = oggz_table_nth (ts->page_accum, cn, NULL);

          if (pa->time < min_time) {
            min_i = i;
            min_cn = cn;
            min_og = pa->og;
            min_serialno = serialno;
            min_time = pa->time;
          }
        }
      }
    }

    if (min_og) {
      /* Increment index for minimum page */
      oggz_table_insert (candidates, min_serialno, (void *)(min_cn+1+7));

      /* Write out minimum page */
      fwrite_ogg_page (state->outfile, min_og);
    }

    remaining--;
  }

  /* Cleanup */
  for (i=0; i < ntracks; i++) {
    ts = oggz_table_nth (state->tracks, i, &serialno);
    track_state_remove_page_accum (ts);
  }

  oggz_table_delete (candidates);

428
  state->status = OC_WRITTEN_ACCUM;
429 430 431 432
 
  return 0;
}

433 434 435 436 437 438 439 440 441 442
/*
 * OggzReadPageCallback read_gs
 *
 * A page reading callback for tracks with granuleshift.
 */
static int
read_gs (OGGZ * oggz, const ogg_page * og, long serialno, void * user_data)
{
  OCState * state = (OCState *)user_data;
  OCTrackState * ts;
443
  OCPageAccum * pa;
444 445 446 447 448 449 450 451 452 453 454 455
  double page_time;
  ogg_int64_t granulepos, keyframe;
  int granuleshift, i, accum_size;
  ogg_page * accum_og;

  page_time = oggz_tell_units (oggz) / 1000.0;

  ts = oggz_table_lookup (state->tracks, serialno);
  accum_size = oggz_table_size (ts->page_accum);

  if (page_time >= state->start) {
    /* Write out accumulated pages */
456
    write_accum (state);
457

458 459
    if (!ts->rec_skeleton) {
#ifdef DEBUG
460 461
      printf ("read_gs: start granule for serialno %010ld: %ld\n",
              serialno, ts->fisbone.start_granule);
462 463 464 465
#endif
      ts->rec_skeleton = 1;
    }

466 467 468 469 470
    /* Switch to the plain page reader */
    oggz_set_read_page (oggz, serialno, read_plain, state);
    return read_plain (oggz, og, serialno, user_data);
  } /* else { ... */

471
  granulepos = ogg_page_granulepos (OGG_PAGE_CONST(og));
472 473 474 475 476
  if (granulepos != -1) {
    granuleshift = oggz_get_granuleshift (oggz, serialno);
    keyframe = granulepos >> granuleshift;

    if (keyframe != ts->prev_keyframe) {
477 478 479 480 481 482 483 484
      if (ogg_page_continued(og)) {
        /* If this new-keyframe page is continued, advance the page accumulator,
         * ie. recover earlier pages from this new GOP */
        accum_size = track_state_advance_page_accum (ts);
      } else {
        /* Otherwise, just clear the page accumulator */
        track_state_remove_page_accum (ts);
        accum_size = 0;
485 486 487 488 489 490 491 492
      }

      /* Record this as prev_keyframe */
      ts->prev_keyframe = keyframe;
    }
  }

  /* Add a copy of this to the page accumulator */
493 494
  pa = page_accum_new (og, page_time);
  oggz_table_insert (ts->page_accum, accum_size, pa);
495 496 497 498 499 500 501 502 503 504 505 506 507 508

  return OGGZ_CONTINUE;
}

/*
 * OggzReadPageCallback read_headers
 *
 * A page reading callback for header pages
 */
static int
read_headers (OGGZ * oggz, const ogg_page * og, long serialno, void * user_data)
{
  OCState * state = (OCState *)user_data;
  OCTrackState * ts;
509 510
  int content_type;
  fisbone_packet fisbone;
511

512 513
  content_type = oggz_stream_get_content(oggz, serialno);
  if(content_type == OGGZ_CONTENT_SKELETON) {
514 515 516 517 518 519
    if (fisbone_from_ogg_page (og, &fisbone) != -1) {
      if ((ts = oggz_table_lookup (state->tracks, fisbone.serial_no)) != NULL) {
        ts->fisbone.current_header_size = fisbone.current_header_size;
        ts->fisbone.message_header_fields = fisbone.message_header_fields;
      }
    }
520
  } else {
521 522
    fwrite_ogg_page (state->outfile, og);

523 524
    ts = oggz_table_lookup (state->tracks, serialno);
    ts->headers_remaining -= ogg_page_packets (OGG_PAGE_CONST(og));
525

526 527 528 529 530 531 532
    if (ts->headers_remaining <= 0) {
      if (state->start == 0.0 || oggz_get_granuleshift (oggz, serialno) == 0) {
        oggz_set_read_page (oggz, serialno, read_plain, state);
      } else {
        ts->page_accum = oggz_table_new();
        oggz_set_read_page (oggz, serialno, read_gs, state);
      }
533 534 535 536 537 538
    }
  }

  return OGGZ_CONTINUE;
}

539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
static int
fisbone_init (OGGZ * oggz, OCState * state, OCTrackState * ts, long serialno)
{
  const char * content_type;
  int len;

  if (ts == NULL) return -1;

  ts->fisbone.serial_no = serialno;
  ts->fisbone.nr_header_packet = oggz_stream_get_numheaders (oggz, serialno);
  oggz_get_granulerate (oggz, serialno, &ts->fisbone.granule_rate_n, &ts->fisbone.granule_rate_d);
  ts->fisbone.start_granule = 0;
  ts->fisbone.preroll = 0;
  ts->fisbone.granule_shift = (unsigned char) oggz_get_granuleshift (oggz, serialno);
  if (state->original_had_skeleton) {
    /* Wait, and copy over message headers from original */
    ts->fisbone.message_header_fields = NULL;
    ts->fisbone.current_header_size = FISBONE_SIZE;
  } else {
    /* XXX: C99 */
#define CONTENT_TYPE_FMT "Content-Type: %s\r\n"
    content_type = oggz_stream_get_content_type (oggz, serialno);
    len = snprintf (NULL, 0, CONTENT_TYPE_FMT, content_type);
    ts->fisbone.message_header_fields = malloc(len+1);
    snprintf (ts->fisbone.message_header_fields, len+1, CONTENT_TYPE_FMT, content_type);
    ts->fisbone.current_header_size = len+1;
  }

  return 0;
}

static int
fishead_update (OCState * state, const ogg_page * og)
{
  fishead_packet fishead;

  fishead_from_ogg_page (og, &fishead);
  state->fishead.btime_n = fishead.btime_n;
  state->fishead.btime_d = fishead.btime_d;

  return 0;
}

582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
static long
skeleton_write_packet (OCState * state, ogg_packet * op)
{
  oggz_write_feed (state->skeleton_writer, op, state->skeleton_serialno,
                   OGGZ_FLUSH_BEFORE|OGGZ_FLUSH_AFTER, NULL);
  return oggz_run (state->skeleton_writer);
}

static long
fishead_write (OCState * state)
{
  ogg_packet op;
  int ret = -1001;

  if (state->do_skeleton) {
    ogg_from_fishead (&state->fishead, &op);
    ret = skeleton_write_packet (state, &op);
    _ogg_free (op.packet);
  }

  return ret;
}


606 607 608 609 610 611
static int
read_bos (OGGZ * oggz, const ogg_page * og, long serialno, void * user_data)
{
  OCState * state = (OCState *)user_data;
  OCTrackState * ts;
  double page_time;
612
  int content_type;
613

614
  if (ogg_page_bos (OGG_PAGE_CONST(og))) {
615 616
    content_type = oggz_stream_get_content(oggz, serialno);
    if(content_type == OGGZ_CONTENT_SKELETON) {
617 618 619 620 621
      if (state->do_skeleton) {
        state->original_had_skeleton = 1;
        state->skeleton_serialno = serialno;
        fishead_update (state, og);
      }
622 623 624 625 626
    } else {
      ts = track_state_add (state->tracks, serialno);
      fisbone_init (oggz, state, ts, serialno);
      ts->headers_remaining = ts->fisbone.nr_header_packet;
    }
627

628 629 630 631 632 633
    /* Write the Skeleton BOS page out */
    if (state->status == OC_INIT) {
      fishead_write (state);
      state->status = OC_HEADERS;
    }

634 635 636 637 638 639 640 641 642 643
    oggz_set_read_page (oggz, serialno, read_headers, state);
    read_headers (oggz, og, serialno, user_data);
  } else {
    /* Deregister the catch-all page reading callback */
    oggz_set_read_page (oggz, -1, NULL, NULL);
  }

  return OGGZ_CONTINUE;
}

644
int
645
chop (OCState * state)
646 647 648
{
  OGGZ * oggz;

649
  state_init (state);
650

651
  if (strcmp (state->infilename, "-") == 0) {
652 653
    oggz = oggz_open_stdio (stdin, OGGZ_READ|OGGZ_AUTO);
  } else {
654
    oggz = oggz_open (state->infilename, OGGZ_READ|OGGZ_AUTO);
655 656
  }

657 658
  if (state->outfilename == NULL) {
    state->outfile = stdout;
659
  } else {
660 661
    state->outfile = fopen (state->outfilename, "wb");
    if (state->outfile == NULL) {
662
      fprintf (stderr, "oggz-chop: unable to open output file %s\n",
663
	       state->outfilename);
664 665 666 667
      return -1;
    }
  }

668 669 670 671 672 673 674 675
  /* Only need the writer if creating skeleton */
  if (state->do_skeleton) {
    state->skeleton_writer = oggz_open_stdio (state->outfile, OGGZ_WRITE);
    /* Choose a serialno that does not appear in the input stream. */
    state->skeleton_serialno = oggz_serialno_new (oggz);
  }

  /* set up a demux filter on the reader */
676
  oggz_set_read_page (oggz, -1, read_bos, state);
677 678 679 680 681 682

  oggz_run_set_blocksize (oggz, 1024*1024);
  oggz_run (oggz);

  oggz_close (oggz);

683 684 685 686
  if (state->outfilename != NULL) {
    fclose (state->outfile);
  }

687 688
  state_clear (state);

689 690
  return 0; 
}