oggzdump.c 12.6 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 50

#include <oggz/oggz.h>

conrad's avatar
conrad committed
51 52
#define DEBUG

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

conrad's avatar
conrad committed
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
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);
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
  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
91 92 93 94 95 96 97 98
}

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

  fprintf (outfile, "  ");
99

conrad's avatar
conrad committed
100 101 102 103 104 105 106 107 108 109
  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
110 111 112 113 114 115 116 117
  int i;
  long remaining = n, count = 0;
  long rowlen;

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

    if (n > 0xffffff)
conrad's avatar
conrad committed
118
      fprintf (outfile, "%08lx:", count);
andre's avatar
andre committed
119
    else if (n > 0xffff)
conrad's avatar
conrad committed
120
      fprintf (outfile, "  %06lx:", count);
andre's avatar
andre committed
121
    else
conrad's avatar
conrad committed
122
      fprintf (outfile, "    %04lx:", count);
andre's avatar
andre committed
123 124

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

    for (; i < 16; i++) {
conrad's avatar
conrad committed
130 131
      if (!(i%2)) fprintf (outfile, " ");
      fprintf (outfile, "  ");
andre's avatar
andre committed
132 133
    }

conrad's avatar
conrad committed
134 135
    if (dump_char)
      dump_char_line (buf, rowlen);
andre's avatar
andre committed
136

conrad's avatar
conrad committed
137
    fprintf(outfile, "\n");
andre's avatar
andre committed
138 139 140 141 142 143 144

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

conrad's avatar
conrad committed
145 146 147
static void
bin_dump (unsigned char * buf, long n)
{
andre's avatar
andre committed
148 149 150 151 152 153 154 155
  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
156
      fprintf (outfile, "%08lx:", count);
andre's avatar
andre committed
157
    else if (n > 0xffff)
conrad's avatar
conrad committed
158
      fprintf (outfile, "  %06lx:", count);
andre's avatar
andre committed
159
    else
conrad's avatar
conrad committed
160
      fprintf (outfile, "    %04lx:", count);
andre's avatar
andre committed
161 162

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

    for (; i < 6; i++) {
conrad's avatar
conrad committed
173 174
      if (!(i%2)) fprintf (outfile, " ");
      fprintf (outfile, "         ");
andre's avatar
andre committed
175 176
    }

conrad's avatar
conrad committed
177 178
    if (dump_char)
      dump_char_line (buf, rowlen);
andre's avatar
andre committed
179 180 181 182 183 184 185 186 187

    printf("\n");

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

188 189 190 191 192 193 194 195
/* 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
196 197 198
static int
read_packet (OGGZ * oggz, ogg_packet * op, long serialno, void * user_data)
{
199
  fprintf (outfile, "%08" PRI_off_t "x: serialno %010ld, "
conrad's avatar
conrad committed
200 201 202 203 204
	   "granulepos %" PRId64 ", packetno %" PRId64,
	   hide_offset ? -1 : oggz_tell (oggz),
	   hide_serialno ? -1 : serialno,
	   hide_granulepos ? -1 : op->granulepos,
	   hide_packetno ? -1 : op->packetno);
andre's avatar
andre committed
205 206

  if (op->b_o_s) {
conrad's avatar
conrad committed
207
    fprintf (outfile, " *** bos");
andre's avatar
andre committed
208 209 210
  }

  if (op->e_o_s) {
conrad's avatar
conrad committed
211
    fprintf (outfile, " *** eos");
andre's avatar
andre committed
212 213
  }

conrad's avatar
conrad committed
214
  fprintf (outfile, ":\n");
andre's avatar
andre committed
215

conrad's avatar
conrad committed
216 217 218 219 220
  if (dump_bits) {
    bin_dump (op->packet, op->bytes);
  } else {
    hex_dump (op->packet, op->bytes);
  }
andre's avatar
andre committed
221

conrad's avatar
conrad committed
222
  fprintf (outfile, "\n");
andre's avatar
andre committed
223 224 225 226 227

  return 0;
}

static int
conrad's avatar
conrad committed
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
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
244
{
conrad's avatar
conrad committed
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
  OGGZ * oggz;
  FILE * infile;
  char line[80];
  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 {
267
    infile = fopen (infilename, "rb");
conrad's avatar
conrad committed
268 269 270 271 272 273 274 275 276 277 278 279 280
  }

  oggz = oggz_new (OGGZ_WRITE|OGGZ_NONSTRICT);

  while (fgets (line, 80, infile)) {
    if (sscanf (line, "%x: serialno %ld, granulepos %lld, packetno %lld%n",
		&offset, &serialno, &granulepos, &packetno,
		&line_offset) >= 4) {

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

281
#ifdef DEBUG
conrad's avatar
conrad committed
282 283 284 285 286 287 288 289 290 291 292
	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) {
	  fwrite (buf, 1, 1024, outfile);
	}
      }
293

conrad's avatar
conrad committed
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 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
      /* 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 {
344
	      max_bytes = (long)new_size;
conrad's avatar
conrad committed
345 346 347 348
	      packet = new_packet;
	      op.packet = packet;
	    }
	  }
349

conrad's avatar
conrad committed
350 351 352 353 354 355 356
	  packet[op.bytes-1] = (unsigned char) val;

	  line_offset += consumed;
	  nread++;
	}
      }
    }
andre's avatar
andre committed
357 358
  }

conrad's avatar
conrad committed
359
  fclose (infile);
andre's avatar
andre committed
360 361 362 363 364 365
}

int
main (int argc, char ** argv)
{
  OGGZ * oggz;
conrad's avatar
conrad committed
366 367 368 369 370 371
  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
372 373
  long n;

conrad's avatar
conrad committed
374 375
  progname = argv[0];

andre's avatar
andre committed
376
  if (argc < 2) {
377 378
    usage (progname);
    return (1);
conrad's avatar
conrad committed
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
  }

  table = oggz_table_new();

  while (1) {
    char * optstring = "hbxnro:s:OSGP";

#ifdef HAVE_GETOPT_LONG
    static struct option long_options[] = {
      {"help", no_argument, 0, 'h'},
      {"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);
zen's avatar
ZEN:  
zen committed
409
	  oggz_table_delete(table);
410
      return (1);
conrad's avatar
conrad committed
411 412 413 414 415
    }

    switch (i) {
    case 'h': /* help */
      usage (progname);
zen's avatar
ZEN:  
zen committed
416
	  oggz_table_delete(table);
417
      return (0);
conrad's avatar
conrad committed
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
      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
451 452
  }

conrad's avatar
conrad committed
453 454
  if (optind >= argc) {
    usage (progname);
zen's avatar
ZEN:  
zen committed
455
	oggz_table_delete(table);
456
    return (1);
andre's avatar
andre committed
457 458
  }

conrad's avatar
conrad committed
459 460 461 462 463
  infilename = argv[optind++];

  if (outfilename == NULL) {
    outfile = stdout;
  } else {
464
    outfile = fopen (outfilename, "wb");
conrad's avatar
conrad committed
465 466 467
    if (outfile == NULL) {
      fprintf (stderr, "%s: unable to open output file %s\n",
	       progname, outfilename);
zen's avatar
ZEN:  
zen committed
468
	  oggz_table_delete(table);
469
      return (1);
conrad's avatar
conrad committed
470 471 472 473 474 475
    }
  }

  if (revert) {
    if (dump_bits) {
      fprintf (stderr, "%s: Revert of binary dump not supported\n", progname);
zen's avatar
ZEN:  
zen committed
476
	  oggz_table_delete(table);
477
      return (1);
conrad's avatar
conrad committed
478 479 480 481 482 483 484 485 486 487 488
    }

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

    if (strcmp (infilename, "-") == 0) {
      oggz = oggz_open_stdio (stdin, OGGZ_READ);
    } else {
      oggz = oggz_open (infilename, OGGZ_READ);
    }
andre's avatar
andre committed
489

conrad's avatar
conrad committed
490 491 492 493 494 495 496 497
    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));
      }
zen's avatar
ZEN:  
zen committed
498
	oggz_table_delete(table);
499
      return (1);
conrad's avatar
conrad committed
500 501 502 503 504 505 506 507 508 509 510
    }

    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);
      }
    }
511

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

conrad's avatar
conrad committed
514 515
    oggz_close (oggz);
  }
zen's avatar
ZEN:  
zen committed
516
  oggz_table_delete(table);
517 518

  return (0);
andre's avatar
andre committed
519
}