oggzdump.c 13.5 KB
Newer Older
andre's avatar
andre committed
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
/*
   Copyright (C) 2003 Commonwealth Scientific and Industrial Research
   Organisation (CSIRO) Australia

   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 CSIRO Australia 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 ORGANISATION 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.
*/

33
#include "config.h"
andre's avatar
andre committed
34 35 36

#include <stdio.h>
#include <stdlib.h>
conrad's avatar
conrad committed
37
#include <string.h>
andre's avatar
andre committed
38
#include <ctype.h>
39 40 41 42 43

#ifdef HAVE_INTTYPES_H
#  include <inttypes.h>
#else
#  define PRId64 "I64d"
44
#endif
45

conrad's avatar
conrad committed
46 47
#include <getopt.h>
#include <errno.h>
andre's avatar
andre committed
48 49

#include <oggz/oggz.h>
conrad's avatar
conrad committed
50
#include "oggz_tools.h"
andre's avatar
andre committed
51

conrad's avatar
conrad committed
52 53
#define DEBUG

andre's avatar
andre committed
54 55 56
#undef MIN
#define MIN(a,b) (((a)<(b))?(a):(b))

conrad's avatar
conrad committed
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
static char * progname;
static FILE * outfile = NULL;
static int dump_bits = 0;
static int dump_char = 1;
static int dump_all_serialnos = 1;
static int truth = 1;

static int hide_offset = 0;
static int hide_serialno = 0;
static int hide_granulepos = 0;
static int hide_packetno = 0;

static void
usage (char * progname)
{
  printf ("Usage: %s [options] filename\n", progname);
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
  printf ("Hexdump packets of an Ogg file, or revert an Ogg file from such a hexdump\n");
  printf ("\nDump format options\n");
  printf ("  -b, --binary           Generate a binary dump of each packet\n");
  printf ("  -x, --hexadecimal      Generate a hexadecimal dump of each packet\n");
  printf ("\nFiltering options\n");
  printf ("  -n, --new              Only dump the first packet of each logical bitstream\n");
  printf ("  -s serialno, --serialno serialno\n");
  printf ("                         Dump only the logical bitstream with specified serialno\n");
  printf ("  -O, --hide-offset      Hide the byte offset of each packet\n");
  printf ("  -S, --hide-serialno    Hide the serialno field of each packet\n");
  printf ("  -G, --hide-granulepos  Hide the granulepos field of each packet\n");
  printf ("  -P, --hide-packetno    Hide the packetno field of each packet\n");
  printf ("\nMode options\n");
  printf ("  -r, --revert           Revert an oggzdump. Generates an Ogg bitstream\n");
  printf ("                         as prescribed in the input oggzdump\n");
  printf ("\nMiscellaneous options\n");
  printf ("  -o filename, --output filename\n");
  printf ("                         Specify output filename\n");
  printf ("  -h, --help             Display this help and exit\n");
conrad's avatar
conrad committed
92
  printf ("  -v, --version          Output version information and exit\n");
93
  printf ("\n");
conrad's avatar
conrad committed
94
  printf ("Please report bugs to <ogg-dev@xiph.org>\n");
conrad's avatar
conrad committed
95 96 97 98 99 100 101 102
}

static void
dump_char_line (unsigned char * buf, long n)
{
  int i;

  fprintf (outfile, "  ");
103

conrad's avatar
conrad committed
104 105 106 107 108 109 110 111 112 113
  for (i = 0; i < n; i++) {
    if (isgraph(buf[i])) fprintf (outfile, "%c", buf[i]);
    else if (isspace(buf[i])) fprintf (outfile, " ");
    else fprintf (outfile, ".");
  }
}

static void
hex_dump (unsigned char * buf, long n)
{
andre's avatar
andre committed
114 115 116 117 118 119 120 121
  int i;
  long remaining = n, count = 0;
  long rowlen;

  while (remaining > 0) {
    rowlen = MIN (remaining, 16);

    if (n > 0xffffff)
conrad's avatar
conrad committed
122
      fprintf (outfile, "%08lx:", count);
andre's avatar
andre committed
123
    else if (n > 0xffff)
conrad's avatar
conrad committed
124
      fprintf (outfile, "  %06lx:", count);
andre's avatar
andre committed
125
    else
conrad's avatar
conrad committed
126
      fprintf (outfile, "    %04lx:", count);
andre's avatar
andre committed
127 128

    for (i = 0; i < rowlen; i++) {
conrad's avatar
conrad committed
129 130
      if (!(i%2)) fprintf (outfile, " ");
      fprintf (outfile, "%02x", buf[i]);
andre's avatar
andre committed
131 132 133
    }

    for (; i < 16; i++) {
conrad's avatar
conrad committed
134 135
      if (!(i%2)) fprintf (outfile, " ");
      fprintf (outfile, "  ");
andre's avatar
andre committed
136 137
    }

conrad's avatar
conrad committed
138 139
    if (dump_char)
      dump_char_line (buf, rowlen);
andre's avatar
andre committed
140

conrad's avatar
conrad committed
141
    fprintf(outfile, "\n");
andre's avatar
andre committed
142 143 144 145 146 147 148

    remaining -= rowlen;
    buf += rowlen;
    count += rowlen;
  }
}

conrad's avatar
conrad committed
149 150 151
static void
bin_dump (unsigned char * buf, long n)
{
andre's avatar
andre committed
152 153 154 155 156 157 158 159
  int i, j;
  long remaining = n, count = 0;
  long rowlen;

  while (remaining > 0) {
    rowlen = MIN (remaining, 6);

    if (n > 0xffffff)
conrad's avatar
conrad committed
160
      fprintf (outfile, "%08lx:", count);
andre's avatar
andre committed
161
    else if (n > 0xffff)
conrad's avatar
conrad committed
162
      fprintf (outfile, "  %06lx:", count);
andre's avatar
andre committed
163
    else
conrad's avatar
conrad committed
164
      fprintf (outfile, "    %04lx:", count);
andre's avatar
andre committed
165 166

    for (i = 0; i < rowlen; i++) {
conrad's avatar
conrad committed
167
      fprintf (outfile, " ");
andre's avatar
andre committed
168 169 170 171 172
#ifdef WORDS_BIGENDIAN
      for (j = 0; j < 8; j++)
#else
      for (j = 7; j >= 0; j--)
#endif
conrad's avatar
conrad committed
173
	fprintf (outfile, "%c", (buf[i]&(1<<j)) ? '1' : '0');
andre's avatar
andre committed
174 175 176
    }

    for (; i < 6; i++) {
conrad's avatar
conrad committed
177 178
      if (!(i%2)) fprintf (outfile, " ");
      fprintf (outfile, "         ");
andre's avatar
andre committed
179 180
    }

conrad's avatar
conrad committed
181 182
    if (dump_char)
      dump_char_line (buf, rowlen);
andre's avatar
andre committed
183 184 185 186 187 188 189 190 191

    printf("\n");

    remaining -= rowlen;
    buf += rowlen;
    count += rowlen;
  }
}

192 193 194 195 196 197 198 199
/* FIXME: on Mac OS X, off_t is 64-bits.  Obviously we want a nicer
 * way to do it than this, but a quick fix is a good fix */
#ifdef __APPLE__
#  define PRI_off_t "q"
#else
#  define PRI_off_t "l"
#endif

andre's avatar
andre committed
200 201 202
static int
read_packet (OGGZ * oggz, ogg_packet * op, long serialno, void * user_data)
{
203 204 205 206 207 208 209 210 211 212 213 214 215 216
  ogg_int64_t units;
  double time_offset;

  units = oggz_tell_units (oggz);
  if (hide_offset) {
    fprintf (outfile, "oOo");
  } else if (units == -1) {
    fprintf (outfile, "%08" PRI_off_t "x", oggz_tell (oggz));
  } else {
    time_offset = (double)units / 1000.0;
    ot_fprint_time (outfile, time_offset);
  }

  fprintf (outfile, ": serialno %010ld, "
conrad's avatar
conrad committed
217 218 219 220
	   "granulepos %" PRId64 ", packetno %" PRId64,
	   hide_serialno ? -1 : serialno,
	   hide_granulepos ? -1 : op->granulepos,
	   hide_packetno ? -1 : op->packetno);
andre's avatar
andre committed
221 222

  if (op->b_o_s) {
conrad's avatar
conrad committed
223
    fprintf (outfile, " *** bos");
andre's avatar
andre committed
224 225 226
  }

  if (op->e_o_s) {
conrad's avatar
conrad committed
227
    fprintf (outfile, " *** eos");
andre's avatar
andre committed
228 229
  }

230 231 232
  fprintf (outfile, ": ");
  ot_fprint_bytes (outfile, op->bytes);
  fputc ('\n', outfile);
andre's avatar
andre committed
233

conrad's avatar
conrad committed
234 235 236 237 238
  if (dump_bits) {
    bin_dump (op->packet, op->bytes);
  } else {
    hex_dump (op->packet, op->bytes);
  }
andre's avatar
andre committed
239

conrad's avatar
conrad committed
240
  fprintf (outfile, "\n");
andre's avatar
andre committed
241 242 243 244 245

  return 0;
}

static int
conrad's avatar
conrad committed
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
ignore_packet (OGGZ * oggz, ogg_packet * op, long serialno, void * user_data)
{
  return -1;
}

static int
read_new_packet (OGGZ * oggz, ogg_packet * op, long serialno, void * user_data)
{
  oggz_set_read_callback (oggz, serialno, ignore_packet, NULL);
  read_packet (oggz, op, serialno, user_data);

  return -1;
}

static void
revert_file (char * infilename)
andre's avatar
andre committed
262
{
conrad's avatar
conrad committed
263 264 265
  OGGZ * oggz;
  FILE * infile;
  char line[80];
266
  int hh, mm, ss;
conrad's avatar
conrad committed
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
  unsigned int offset;
  long current_serialno = -1, serialno;
  ogg_int64_t granulepos, packetno;
  int bos = 0, eos = 0;

  int line_offset = 0, consumed = 0;

  unsigned char * packet = NULL;
  long max_bytes = 0;

  unsigned char buf[1024];
  ogg_packet op;
  int flush = 1;
  long n;
  char c;

  if (strcmp (infilename, "-") == 0) {
    infile = stdin;
  } else {
286
    infile = fopen (infilename, "rb");
conrad's avatar
conrad committed
287 288 289 290 291
  }

  oggz = oggz_new (OGGZ_WRITE|OGGZ_NONSTRICT);

  while (fgets (line, 80, infile)) {
292 293 294 295 296 297 298
    line_offset = 0;

    /* Skip time offsets, OR ensure line_offset is 0 */
    if (sscanf (line, "%2d:%2d:%2d.%n", &hh, &mm, &ss, &line_offset) < 3)
      line_offset = 0;

    if (sscanf (&line[line_offset], "%x: serialno %ld, granulepos %lld, packetno %lld%n",
conrad's avatar
conrad committed
299 300 301 302 303 304 305
		&offset, &serialno, &granulepos, &packetno,
		&line_offset) >= 4) {

      /* flush any existing packets */
      if (current_serialno != -1) {
	int ret;

306
#ifdef DEBUG
conrad's avatar
conrad committed
307 308 309 310 311 312 313 314
	printf ("feeding packet (%010ld) %ld bytes\n",
		current_serialno, op.bytes);
#endif
	if ((ret = oggz_write_feed (oggz, &op, current_serialno, flush, NULL)) != 0) {
	  fprintf (stderr, "%s: oggz_write_feed error %d\n", progname, ret);
	}

	while ((n = oggz_write_output (oggz, buf, 1024)) > 0) {
conrad's avatar
conrad committed
315
	  fwrite (buf, 1, n, outfile);
conrad's avatar
conrad committed
316 317
	}
      }
318

conrad's avatar
conrad committed
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
      /* Start new packet */
      bos = 0; eos = 0;
      if (sscanf (&line[line_offset], " *** %[b]%[o]%[s]%n", &c, &c, &c,
		  &consumed) >= 3) {
	bos = 1;
	line_offset += consumed;
      }
      if (sscanf (&line[line_offset], " *** %[e]%[o]%[s]%n", &c, &c, &c,
		  &consumed) >= 3) {
	eos = 1;
	line_offset += consumed;
      }

      current_serialno = serialno;

      op.packet = packet;
      op.bytes = 0;
      op.b_o_s = bos;
      op.e_o_s = eos;
      op.granulepos = granulepos;
      op.packetno = packetno;

    } else {
      int nread = 0;
      unsigned int val = 0;
      unsigned int offset;

      if (current_serialno != -1 &&
	  sscanf (line, "%x:%n", &offset, &line_offset) >= 1) {
	while (nread < 16 &&
	       (sscanf (&line[line_offset], "%2x%n", &val, &consumed) > 0)) {
	  op.bytes++;
	  if (op.bytes > max_bytes) {
	    unsigned char * new_packet;
	    size_t new_size;

	    if (max_bytes == 0) {
	      new_size = 128;
	    } else {
	      new_size = max_bytes * 2;
	    }

	    new_packet =
	      (unsigned char *) realloc ((void *)packet, new_size);
	    if (new_packet == NULL) {
	      fprintf (stderr,
		       "%s: error allocating memory for packet data\n",
		       progname);
	      exit (1);
	    } else {
369
	      max_bytes = (long)new_size;
conrad's avatar
conrad committed
370 371 372 373
	      packet = new_packet;
	      op.packet = packet;
	    }
	  }
374

conrad's avatar
conrad committed
375 376 377 378 379 380 381
	  packet[op.bytes-1] = (unsigned char) val;

	  line_offset += consumed;
	  nread++;
	}
      }
    }
andre's avatar
andre committed
382 383
  }

conrad's avatar
conrad committed
384
  fclose (infile);
andre's avatar
andre committed
385 386 387 388 389
}

int
main (int argc, char ** argv)
{
conrad's avatar
conrad committed
390 391 392
  int show_version = 0;
  int show_help = 0;

andre's avatar
andre committed
393
  OGGZ * oggz;
conrad's avatar
conrad committed
394 395 396 397 398 399
  char * infilename = NULL, * outfilename = NULL;
  int revert = 0;
  OggzTable * table = NULL;
  long serialno;
  OggzReadPacket my_read_packet = read_packet;
  int i, size;
andre's avatar
andre committed
400 401
  long n;

conrad's avatar
conrad committed
402 403
  ot_init ();

conrad's avatar
conrad committed
404 405
  progname = argv[0];

andre's avatar
andre committed
406
  if (argc < 2) {
407 408
    usage (progname);
    return (1);
conrad's avatar
conrad committed
409 410 411 412 413
  }

  table = oggz_table_new();

  while (1) {
conrad's avatar
conrad committed
414
    char * optstring = "hvbxnro:s:OSGP";
conrad's avatar
conrad committed
415 416 417 418

#ifdef HAVE_GETOPT_LONG
    static struct option long_options[] = {
      {"help", no_argument, 0, 'h'},
conrad's avatar
conrad committed
419
      {"version", no_argument, 0, 'v'},
conrad's avatar
conrad committed
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
      {"binary", no_argument, 0, 'b'},
      {"hexadecimal", no_argument, 0, 'x'},
      {"new", no_argument, 0, 'n'},
      {"revert", no_argument, 0, 'r'},
      {"output", required_argument, 0, 'o'},
      {"serialno", required_argument, 0, 's'},
      {"hide-offset", no_argument, 0, 'O'},
      {"hide-serialno", no_argument, 0, 'S'},
      {"hide-granulepos", no_argument, 0, 'G'},
      {"hide-packetno", no_argument, 0, 'P'},
      {0,0,0,0}
    };

    i = getopt_long(argc, argv, optstring, long_options, NULL);
#else
    i = getopt (argc, argv, optstring);
#endif
    if (i == -1) break;
    if (i == ':') {
      usage (progname);
conrad's avatar
conrad committed
440
      goto exit_err;
conrad's avatar
conrad committed
441 442 443 444
    }

    switch (i) {
    case 'h': /* help */
conrad's avatar
conrad committed
445 446 447 448
      show_help = 1;
      break;
    case 'v': /* version */
      show_version = 1;
conrad's avatar
conrad committed
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
      break;
    case 'b': /* binary */
      dump_bits = 1;
      break;
    case 'n': /* new */
      my_read_packet = read_new_packet;
      break;
    case 'o': /* output */
      outfilename = optarg;
      break;
    case 'r': /* revert */
      revert = 1;
      break;
    case 's': /* serialno */
      dump_all_serialnos = 0;
      serialno = atol (optarg);
      oggz_table_insert (table, serialno, &truth);
      break;
    case 'O': /* hide offset */
      hide_offset = 1;
      break;
    case 'S': /* hide serialno */
      hide_serialno = 1;
      break;
    case 'G': /* hide granulepos */
      hide_granulepos = 1;
      break;
    case 'P': /* hide packetno */
      hide_packetno = 1;
      break;
    default:
      break;
    }
andre's avatar
andre committed
482 483
  }

conrad's avatar
conrad committed
484 485 486 487 488 489 490 491 492 493 494 495
  if (show_version) {
    printf ("%s version " VERSION "\n", progname);
  }

  if (show_help) {
    usage (progname);
  }

  if (show_version || show_help) {
    goto exit_ok;
  }

conrad's avatar
conrad committed
496 497
  if (optind >= argc) {
    usage (progname);
conrad's avatar
conrad committed
498
    goto exit_err;
andre's avatar
andre committed
499 500
  }

conrad's avatar
conrad committed
501 502 503 504 505
  infilename = argv[optind++];

  if (outfilename == NULL) {
    outfile = stdout;
  } else {
506
    outfile = fopen (outfilename, "wb");
conrad's avatar
conrad committed
507 508 509
    if (outfile == NULL) {
      fprintf (stderr, "%s: unable to open output file %s\n",
	       progname, outfilename);
conrad's avatar
conrad committed
510
      goto exit_err;
conrad's avatar
conrad committed
511 512 513 514 515 516
    }
  }

  if (revert) {
    if (dump_bits) {
      fprintf (stderr, "%s: Revert of binary dump not supported\n", progname);
conrad's avatar
conrad committed
517
      goto exit_err;
conrad's avatar
conrad committed
518 519 520 521 522 523 524
    }

    revert_file (infilename);
  } else {
    errno = 0;

    if (strcmp (infilename, "-") == 0) {
525
      oggz = oggz_open_stdio (stdin, OGGZ_READ|OGGZ_AUTO);
conrad's avatar
conrad committed
526
    } else {
527
      oggz = oggz_open (infilename, OGGZ_READ|OGGZ_AUTO);
conrad's avatar
conrad committed
528
    }
andre's avatar
andre committed
529

conrad's avatar
conrad committed
530 531 532 533 534 535 536 537
    if (oggz == NULL) {
      if (errno == 0) {
	fprintf (stderr, "%s: %s: OGGZ error opening input file\n",
		 progname, infilename);
      } else {
	fprintf (stderr, "%s: %s: %s\n",
		 progname, infilename, strerror (errno));
      }
conrad's avatar
conrad committed
538
      goto exit_err;
conrad's avatar
conrad committed
539 540 541 542 543 544 545 546 547 548 549
    }

    if (dump_all_serialnos) {
      oggz_set_read_callback (oggz, -1, my_read_packet, NULL);
    } else {
      size = oggz_table_size (table);
      for (i = 0; i < size; i++) {
	oggz_table_nth (table, i, &serialno);
	oggz_set_read_callback (oggz, serialno, my_read_packet, NULL);
      }
    }
550

conrad's avatar
conrad committed
551
    while ((n = oggz_read (oggz, 1024)) > 0);
552

conrad's avatar
conrad committed
553 554
    oggz_close (oggz);
  }
555

conrad's avatar
conrad committed
556 557 558 559 560 561 562
 exit_ok:
  oggz_table_delete (table);
  exit (0);

 exit_err:
  oggz_table_delete (table);
  exit (1);
andre's avatar
andre committed
563
}