ogginfo2.c 30.5 KB
Newer Older
1 2 3 4
/* Ogginfo
 *
 * A tool to describe ogg file contents and metadata.
 *
5
 * Copyright 2002-2005 Michael Smith <msmith@xiph.org>
6 7 8 9 10 11 12 13
 * Licensed under the GNU GPL, distributed with this program.
 */


#include <stdio.h>
#include <stdlib.h>
#include <errno.h>
#include <string.h>
14 15
#include <stdarg.h>
#include <getopt.h>
Ralph Giles's avatar
Ralph Giles committed
16
#include <math.h>
17 18 19 20 21 22 23 24

#include <ogg/ogg.h>
#include <vorbis/codec.h>

#include <locale.h>
#include "utf8.h"
#include "i18n.h"

25 26
#include "theora.h"

27 28
#define CHUNK 4500

29 30 31 32 33 34 35 36 37 38 39
struct vorbis_release {
    char *vendor_string;
    char *desc;
} releases[] = {
        {"Xiphophorus libVorbis I 20000508", "1.0 beta 1 or beta 2"},
        {"Xiphophorus libVorbis I 20001031", "1.0 beta 3"},
        {"Xiphophorus libVorbis I 20010225", "1.0 beta 4"},
        {"Xiphophorus libVorbis I 20010615", "1.0 rc1"},
        {"Xiphophorus libVorbis I 20010813", "1.0 rc2"},
        {"Xiphophorus libVorbis I 20011217", "1.0 rc3"},
        {"Xiphophorus libVorbis I 20011231", "1.0 rc3"},
Ralph Giles's avatar
Ralph Giles committed
40
        {"Xiph.Org libVorbis I 20020717", "1.0"},
Monty's avatar
 
Monty committed
41
        {"Xiph.Org libVorbis I 20030909", "1.0.1"},
42 43
        {"Xiph.Org libVorbis I 20040629", "1.1.0"},
	{"Xiph.Org libVorbis I 20050304", "1.1.1"},
44 45 46 47
        {NULL, NULL},
    };


48 49 50
/* TODO:
 *
 * - detect violations of muxing constraints
51 52
 * - detect granulepos 'gaps' (possibly vorbis-specific). (seperate from 
 *   serial-number gaps)
53 54
 */

55 56 57 58
typedef struct _stream_processor {
    void (*process_page)(struct _stream_processor *, ogg_page *);
    void (*process_end)(struct _stream_processor *);
    int isillegal;
59
    int constraint_violated;
60 61
    int shownillegal;
    int isnew;
62 63
    long seqno;
    int lostseq;
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87

    int start;
    int end;

    int num;
    char *type;

    ogg_uint32_t serial; /* must be 32 bit unsigned */
    ogg_stream_state os;
    void *data;
} stream_processor;

typedef struct {
    stream_processor *streams;
    int allocated;
    int used;

    int in_headers;
} stream_set;

typedef struct {
    vorbis_info vi;
    vorbis_comment vc;

Monty's avatar
 
Monty committed
88
    ogg_int64_t bytes;
89
    ogg_int64_t lastgranulepos;
90
    ogg_int64_t firstgranulepos;
91 92 93 94

    int doneheaders;
} misc_vorbis_info;

95 96 97 98 99 100 101 102 103 104 105
typedef struct {
    theora_info ti;
    theora_comment tc;

    ogg_int64_t bytes;
    ogg_int64_t lastgranulepos;
    ogg_int64_t firstgranulepos;

    int doneheaders;
} misc_theora_info;

106 107 108 109
static int printinfo = 1;
static int printwarn = 1;
static int verbose = 1;

110 111
static int flawed;

112 113 114
#define CONSTRAINT_PAGE_AFTER_EOS   1
#define CONSTRAINT_MUXING_VIOLATED  2

115 116 117 118 119 120 121 122 123 124
static stream_set *create_stream_set(void) {
    stream_set *set = calloc(1, sizeof(stream_set));

    set->streams = calloc(5, sizeof(stream_processor));
    set->allocated = 5;
    set->used = 0;

    return set;
}

125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
static void info(char *format, ...) 
{
    va_list ap;

    if(!printinfo)
        return;

    va_start(ap, format);
    vfprintf(stdout, format, ap);
    va_end(ap);
}

static void warn(char *format, ...) 
{
    va_list ap;

141
    flawed = 1;
142 143 144 145 146 147 148 149 150 151 152 153
    if(!printwarn)
        return;

    va_start(ap, format);
    vfprintf(stdout, format, ap);
    va_end(ap);
}

static void error(char *format, ...) 
{
    va_list ap;

154 155
    flawed = 1;

156 157 158 159 160
    va_start(ap, format);
    vfprintf(stdout, format, ap);
    va_end(ap);
}

161 162
static void check_xiph_comment(stream_processor *stream, int i, char *comment,
    int comment_length)
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
{
    char *sep = strchr(comment, '=');
    char *decoded;
    int j;
    int broken = 0;
    unsigned char *val;
    int bytes;
    int remaining;

    if(sep == NULL) {
        warn(_("Warning: Comment %d in stream %d has invalid "
              "format, does not contain '=': \"%s\"\n"), 
              i, stream->num, comment);
             return;
    }

    for(j=0; j < sep-comment; j++) {
        if(comment[j] < 0x20 || comment[j] > 0x7D) {
            warn(_("Warning: Invalid comment fieldname in "
                   "comment %d (stream %d): \"%s\"\n"),
                   i, stream->num, comment);
            broken = 1;
            break;
        }
    }

    if(broken)
	return;

Ralph Giles's avatar
Ralph Giles committed
192
    val = (unsigned char *)comment;
193

194 195
    j = sep-comment+1;
    while(j < comment_length)
196
    {
197
        remaining = comment_length - j;
198 199 200 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 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
        if((val[j] & 0x80) == 0)
            bytes = 1;
        else if((val[j] & 0x40) == 0x40) {
            if((val[j] & 0x20) == 0)
                bytes = 2;
            else if((val[j] & 0x10) == 0)
                bytes = 3;
            else if((val[j] & 0x08) == 0)
                bytes = 4;
            else if((val[j] & 0x04) == 0)
                bytes = 5;
            else if((val[j] & 0x02) == 0)
                bytes = 6;
            else {
                warn(_("Warning: Illegal UTF-8 sequence in "
                    "comment %d (stream %d): length marker wrong\n"),
                    i, stream->num);
                broken = 1;
                break;
            }
        }
        else {
            warn(_("Warning: Illegal UTF-8 sequence in comment "
                "%d (stream %d): length marker wrong\n"), i, stream->num);
            broken = 1;
            break;
        }

        if(bytes > remaining) {
            warn(_("Warning: Illegal UTF-8 sequence in comment "
                "%d (stream %d): too few bytes\n"), i, stream->num);
            broken = 1;
            break;
        }

        switch(bytes) {
            case 1:
                /* No more checks needed */
                break;
            case 2:
                if((val[j+1] & 0xC0) != 0x80)
                    broken = 1;
                if((val[j] & 0xFE) == 0xC0)
                    broken = 1;
                break;
            case 3:
                if(!((val[j] == 0xE0 && val[j+1] >= 0xA0 && val[j+1] <= 0xBF && 
                         (val[j+2] & 0xC0) == 0x80) ||
                     (val[j] >= 0xE1 && val[j] <= 0xEC && 
                         (val[j+1] & 0xC0) == 0x80 &&
                         (val[j+2] & 0xC0) == 0x80) ||
                     (val[j] == 0xED && val[j+1] >= 0x80 &&
                         val[j+1] <= 0x9F &&
                         (val[j+2] & 0xC0) == 0x80) ||
                     (val[j] >= 0xEE && val[j] <= 0xEF &&
                         (val[j+1] & 0xC0) == 0x80 &&
                         (val[j+2] & 0xC0) == 0x80)))
                     broken = 1;
                 if(val[j] == 0xE0 && (val[j+1] & 0xE0) == 0x80)
                     broken = 1;
                 break;
            case 4:
                 if(!((val[j] == 0xF0 && val[j+1] >= 0x90 &&
                         val[j+1] <= 0xBF &&
                         (val[j+2] & 0xC0) == 0x80 &&
                         (val[j+3] & 0xC0) == 0x80) ||
                     (val[j] >= 0xF1 && val[j] <= 0xF3 &&
                         (val[j+1] & 0xC0) == 0x80 &&
                         (val[j+2] & 0xC0) == 0x80 &&
                         (val[j+3] & 0xC0) == 0x80) ||
                     (val[j] == 0xF4 && val[j+1] >= 0x80 &&
                         val[j+1] <= 0x8F &&
                         (val[j+2] & 0xC0) == 0x80 &&
                         (val[j+3] & 0xC0) == 0x80)))
                     broken = 1;
                 if(val[j] == 0xF0 && (val[j+1] & 0xF0) == 0x80)
                     broken = 1;
                 break;
             /* 5 and 6 aren't actually allowed at this point */
             case 5:
                 broken = 1;
                 break;
             case 6:
                 broken = 1;
                 break;
         }

         if(broken) {
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
             char *simple = malloc (comment_length + 1);
             char *seq = malloc (comment_length * 3 + 1);
             static char hex[] = {'0', '1', '2', '3', '4', '5', '6', '7', 
                                  '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'};
             int i, c1 = 0, c2 = 0;
             for (i = 0; i < comment_length; i++) {
               seq[c1++] = hex[((unsigned char)comment[i]) >> 4];
               seq[c1++] = hex[((unsigned char)comment[i]) & 0xf];
               seq[c1++] = ' ';

               if(comment[i] < 0x20 || comment[i] > 0x7D)
                 simple[c2++] = '?';
               else
                 simple[c2++] = comment[i];
             }
             seq[c1] = 0;
             simple[c2] = 0;
303
             warn(_("Warning: Illegal UTF-8 sequence in comment "
304 305
                   "%d (stream %d): invalid sequence \"%s\": %s\n"), i, 
                   stream->num, simple, seq);
306
             broken = 1;
307 308
             free (simple);
             free (seq);
309 310 311 312 313 314 315 316 317 318 319
             break;
         }

         j += bytes;
     }

     if(!broken) {
         if(utf8_decode(sep+1, &decoded) < 0) {
             warn(_("Warning: Failure in utf8 decoder. This should be impossible\n"));
             return;
	 }
320 321 322
         *sep = 0;
         info("\t%s=%s\n", comment, decoded);
         free(decoded);
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
     }
}

static void theora_process(stream_processor *stream, ogg_page *page)
{
    ogg_packet packet;
    misc_theora_info *inf = stream->data;
    int i, header=0;

    ogg_stream_pagein(&stream->os, page);
    if(inf->doneheaders < 3)
        header = 1;

    while(ogg_stream_packetout(&stream->os, &packet) > 0) {
        if(inf->doneheaders < 3) {
            if(theora_decode_header(&inf->ti, &inf->tc, &packet) < 0) {
                warn(_("Warning: Could not decode theora header "
                       "packet - invalid theora stream (%d)\n"), stream->num);
                continue;
            }
            inf->doneheaders++;
            if(inf->doneheaders == 3) {
                if(ogg_page_granulepos(page) != 0 || ogg_stream_packetpeek(&stream->os, NULL) == 1)
                    warn(_("Warning: Theora stream %d does not have headers "
                           "correctly framed. Terminal header page contains "
                           "additional packets or has non-zero granulepos\n"),
                            stream->num);
                info(_("Theora headers parsed for stream %d, "
                       "information follows...\n"), stream->num);

                info(_("Version: %d.%d.%d\n"), inf->ti.version_major, inf->ti.version_minor, inf->ti.version_subminor);
   
                info(_("Vendor: %s\n"), inf->tc.vendor);
                info(_("Width: %d\n"), inf->ti.frame_width);
                info(_("Height: %d\n"), inf->ti.frame_height);
358
		info(_("Total image: %d by %d, crop offset (%d, %d)\n"),
359 360 361 362 363 364 365 366 367
		    inf->ti.width, inf->ti.height, inf->ti.offset_x, inf->ti.offset_y);
		if(inf->ti.offset_x + inf->ti.frame_width > inf->ti.width)
		    warn(_("Frame offset/size invalid: width incorrect\n"));
		if(inf->ti.offset_y + inf->ti.frame_height > inf->ti.height)
		    warn(_("Frame offset/size invalid: height incorrect\n"));

		if(inf->ti.fps_numerator == 0 || inf->ti.fps_denominator == 0) 
		   warn(_("Invalid zero framerate\n"));
		else
368
		   info(_("Framerate %d/%d (%.02f fps)\n"), inf->ti.fps_numerator, inf->ti.fps_denominator, (float)inf->ti.fps_numerator/(float)inf->ti.fps_denominator);
369 370 371 372 373 374 375 376
		
		if(inf->ti.aspect_numerator == 0 || inf->ti.aspect_denominator == 0) 
		{
		    info(_("Aspect ratio undefined\n"));
		}	
		else
		{
		    float frameaspect = (float)inf->ti.frame_width/(float)inf->ti.frame_height * (float)inf->ti.aspect_numerator/(float)inf->ti.aspect_denominator; 
377
		    info(_("Pixel aspect ratio %d:%d (%f:1)\n"), inf->ti.aspect_numerator, inf->ti.aspect_denominator, (float)inf->ti.aspect_numerator/(float)inf->ti.aspect_denominator);
j's avatar
j committed
378
                    if(fabs(frameaspect - 4.0/3.0) < 0.02)
379
			info(_("Frame aspect 4:3\n"));
j's avatar
j committed
380
                    else if(fabs(frameaspect - 16.0/9.0) < 0.02)
381
			info(_("Frame aspect 16:9\n"));
382
		    else
j's avatar
j committed
383
			info(_("Frame aspect %f:1\n"), frameaspect);
384 385 386
		}

		if(inf->ti.colorspace == OC_CS_ITU_REC_470M)
387
		    info(_("Colourspace: Rec. ITU-R BT.470-6 System M (NTSC)\n")); 
388
		else if(inf->ti.colorspace == OC_CS_ITU_REC_470BG)
389
		    info(_("Colourspace: Rec. ITU-R BT.470-6 Systems B and G (PAL)\n")); 
390
		else
391
		    info(_("Colourspace unspecified\n"));
392 393

		if(inf->ti.pixelformat == OC_PF_420)
394
		    info(_("Pixel format 4:2:0\n"));
395
		else if(inf->ti.pixelformat == OC_PF_422)
396
		    info(_("Pixel format 4:2:2\n"));
397
		else if(inf->ti.pixelformat == OC_PF_444)
398
		    info(_("Pixel format 4:4:4\n"));
399
		else
400
		    warn(_("Pixel format invalid\n"));
401

402 403
		info(_("Target bitrate: %d kbps\n"), inf->ti.target_bitrate/1000);
		info(_("Nominal quality setting (0-63): %d\n"), inf->ti.quality);
404 405 406 407 408 409

                if(inf->tc.comments > 0)
                    info(_("User comments section follows...\n"));

                for(i=0; i < inf->tc.comments; i++) {
                    char *comment = inf->tc.user_comments[i];
410 411
		    check_xiph_comment(stream, i, comment, 
		            inf->tc.comment_lengths[i]);
412 413 414 415 416 417 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
		}
	    }
	}
    }

    if(!header) {
        ogg_int64_t gp = ogg_page_granulepos(page);
        if(gp > 0) {
            if(gp < inf->lastgranulepos)
#ifdef _WIN32
                warn(_("Warning: granulepos in stream %d decreases from %I64d to %I64d" ),
                        stream->num, inf->lastgranulepos, gp);
#else
                warn(_("Warning: granulepos in stream %d decreases from %lld to %lld" ),
                        stream->num, inf->lastgranulepos, gp);
#endif
            inf->lastgranulepos = gp;
        }
        if(inf->firstgranulepos < 0) { /* Not set yet */
        }
        inf->bytes += page->header_len + page->body_len;
    }
}

static void theora_end(stream_processor *stream) 
{
    misc_theora_info *inf = stream->data;
    long minutes, seconds, milliseconds;
    double bitrate, time;

    /* This should be lastgranulepos - startgranulepos, or something like that*/
443 444 445
    ogg_int64_t iframe=inf->lastgranulepos>>inf->ti.granule_shift;
    ogg_int64_t pframe=inf->lastgranulepos-(iframe<<inf->ti.granule_shift);
    time = (double)(iframe+pframe) /
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
	((float)inf->ti.fps_numerator/(float)inf->ti.fps_denominator);
    minutes = (long)time / 60;
    seconds = (long)time - minutes*60;
    milliseconds = (long)((time - minutes*60 - seconds)*1000);
    bitrate = inf->bytes*8 / time / 1000.0;

#ifdef _WIN32
    info(_("Theora stream %d:\n"
           "\tTotal data length: %I64d bytes\n"
           "\tPlayback length: %ldm:%02ld.%03lds\n"
           "\tAverage bitrate: %f kb/s\n"), 
            stream->num,inf->bytes, minutes, seconds, milliseconds, bitrate);
#else
    info(_("Theora stream %d:\n"
           "\tTotal data length: %lld bytes\n"
           "\tPlayback length: %ldm:%02ld.%03lds\n"
           "\tAverage bitrate: %f kb/s\n"), 
            stream->num,inf->bytes, minutes, seconds, milliseconds, bitrate);
#endif

    theora_comment_clear(&inf->tc);
    theora_info_clear(&inf->ti);

    free(stream->data);
}


473 474 475
static void vorbis_process(stream_processor *stream, ogg_page *page )
{
    ogg_packet packet;
476
    misc_vorbis_info *inf = stream->data;
477
    int i, header=0, packets=0;
478
    int k;
479 480

    ogg_stream_pagein(&stream->os, page);
481 482
    if(inf->doneheaders < 3)
        header = 1;
483 484

    while(ogg_stream_packetout(&stream->os, &packet) > 0) {
485
        packets++;
486 487 488
        if(inf->doneheaders < 3) {
            if(vorbis_synthesis_headerin(&inf->vi, &inf->vc, &packet) < 0) {
                warn(_("Warning: Could not decode vorbis header "
489 490 491
                       "packet - invalid vorbis stream (%d)\n"), stream->num);
                continue;
            }
492 493
            inf->doneheaders++;
            if(inf->doneheaders == 3) {
494
                if(ogg_page_granulepos(page) != 0 || ogg_stream_packetpeek(&stream->os, NULL) == 1)
495 496 497 498
                    warn(_("Warning: Vorbis stream %d does not have headers "
                           "correctly framed. Terminal header page contains "
                           "additional packets or has non-zero granulepos\n"),
                            stream->num);
499 500 501 502
                info(_("Vorbis headers parsed for stream %d, "
                       "information follows...\n"), stream->num);

                info(_("Version: %d\n"), inf->vi.version);
503 504 505 506 507 508 509 510 511 512 513
                k = 0;
                while(releases[k].vendor_string) {
                    if(!strcmp(inf->vc.vendor, releases[k].vendor_string)) {
                        info(_("Vendor: %s (%s)\n"), inf->vc.vendor, 
                                    releases[k].desc);
                        break;
                    }
                    k++;
                }
                if(!releases[k].vendor_string)
                    info(_("Vendor: %s\n"), inf->vc.vendor);
514 515 516
                info(_("Channels: %d\n"), inf->vi.channels);
                info(_("Rate: %ld\n\n"), inf->vi.rate);

517
                if(inf->vi.bitrate_nominal > 0)
518 519
                    info(_("Nominal bitrate: %f kb/s\n"), 
                            (double)inf->vi.bitrate_nominal / 1000.0);
520
                else
521
                    info(_("Nominal bitrate not set\n"));
522

523
                if(inf->vi.bitrate_upper > 0)
524 525
                    info(_("Upper bitrate: %f kb/s\n"), 
                            (double)inf->vi.bitrate_upper / 1000.0);
526
                else
527
                    info(_("Upper bitrate not set\n"));
528

529
                if(inf->vi.bitrate_lower > 0)
530 531
                    info(_("Lower bitrate: %f kb/s\n"), 
                            (double)inf->vi.bitrate_lower / 1000.0);
532
                else
533
                    info(_("Lower bitrate not set\n"));
534

535 536
                if(inf->vc.comments > 0)
                    info(_("User comments section follows...\n"));
537

538
                for(i=0; i < inf->vc.comments; i++) {
539
                    char *comment = inf->vc.user_comments[i];
540 541
		    check_xiph_comment(stream, i, comment, 
		            inf->vc.comment_lengths[i]);
542
		}
543 544 545 546 547
            }
        }
    }

    if(!header) {
548 549 550
        ogg_int64_t gp = ogg_page_granulepos(page);
        if(gp > 0) {
            if(gp < inf->lastgranulepos)
551 552 553 554
#ifdef _WIN32
                warn(_("Warning: granulepos in stream %d decreases from %I64d to %I64d" ),
                        stream->num, inf->lastgranulepos, gp);
#else
calc's avatar
calc committed
555
                warn(_("Warning: granulepos in stream %d decreases from %lld to %lld" ),
556 557
                        stream->num, inf->lastgranulepos, gp);
#endif
558 559
            inf->lastgranulepos = gp;
        }
560 561 562 563 564
        else if(packets) {
            /* Only do this if we saw at least one packet ending on this page.
             * It's legal (though very unusual) to have no packets in a page at
             * all - this is occasionally used to have an empty EOS page */
            warn(_("Negative or zero granulepos (%lld) on vorbis stream outside of headers. This file was created by a buggy encoder\n"), gp);
565 566 567
        }
        if(inf->firstgranulepos < 0) { /* Not set yet */
        }
568
        inf->bytes += page->header_len + page->body_len;
569 570 571 572 573
    }
}

static void vorbis_end(stream_processor *stream) 
{
574
    misc_vorbis_info *inf = stream->data;
575
    long minutes, seconds, milliseconds;
576 577
    double bitrate, time;

578
    /* This should be lastgranulepos - startgranulepos, or something like that*/
579
    time = (double)inf->lastgranulepos / inf->vi.rate;
580 581
    minutes = (long)time / 60;
    seconds = (long)time - minutes*60;
582
    milliseconds = (long)((time - minutes*60 - seconds)*1000);
583
    bitrate = inf->bytes*8 / time / 1000.0;
584

585 586 587
#ifdef _WIN32
    info(_("Vorbis stream %d:\n"
           "\tTotal data length: %I64d bytes\n"
588
           "\tPlayback length: %ldm:%02ld.%03lds\n"
589
           "\tAverage bitrate: %f kb/s\n"), 
590
            stream->num,inf->bytes, minutes, seconds, milliseconds, bitrate);
591
#else
592
    info(_("Vorbis stream %d:\n"
calc's avatar
calc committed
593
           "\tTotal data length: %lld bytes\n"
594
           "\tPlayback length: %ldm:%02ld.%03lds\n"
595
           "\tAverage bitrate: %f kb/s\n"), 
596
            stream->num,inf->bytes, minutes, seconds, milliseconds, bitrate);
597
#endif
598

599 600
    vorbis_comment_clear(&inf->vc);
    vorbis_info_clear(&inf->vi);
601 602 603 604

    free(stream->data);
}

605 606 607 608 609
static void process_null(stream_processor *stream, ogg_page *page)
{
    /* This is for invalid streams. */
}

610 611 612 613 614 615 616 617 618 619
static void process_other(stream_processor *stream, ogg_page *page )
{
    ogg_packet packet;

    ogg_stream_pagein(&stream->os, page);

    while(ogg_stream_packetout(&stream->os, &packet) > 0) {
        /* Should we do anything here? Currently, we don't */
    }
}
620

621 622 623 624 625 626

static void free_stream_set(stream_set *set)
{
    int i;
    for(i=0; i < set->used; i++) {
        if(!set->streams[i].end) {
627
            warn(_("Warning: EOS not set on stream %d\n"), 
628
                    set->streams[i].num);
629 630
            if(set->streams[i].process_end)
                set->streams[i].process_end(&set->streams[i]);
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650
        }
        ogg_stream_clear(&set->streams[i].os);
    }

    free(set->streams);
    free(set);
}

static int streams_open(stream_set *set)
{
    int i;
    int res=0;
    for(i=0; i < set->used; i++) {
        if(!set->streams[i].end)
            res++;
    }

    return res;
}

651 652 653 654 655 656 657
static void null_start(stream_processor *stream)
{
    stream->process_end = NULL;
    stream->type = "invalid";
    stream->process_page = process_null;
}

658
static void other_start(stream_processor *stream, char *type)
659
{
660 661 662 663
    if(type)
        stream->type = type;
    else
        stream->type = "unknown";
664 665 666 667
    stream->process_page = process_other;
    stream->process_end = NULL;
}

668 669 670 671 672 673 674 675 676 677 678 679
static void theora_start(stream_processor *stream)
{
    misc_theora_info *info;

    stream->type = "theora";
    stream->process_page = theora_process;
    stream->process_end = theora_end;

    stream->data = calloc(1, sizeof(misc_theora_info));
    info = stream->data;
}

680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701
static void vorbis_start(stream_processor *stream)
{
    misc_vorbis_info *info;

    stream->type = "vorbis";
    stream->process_page = vorbis_process;
    stream->process_end = vorbis_end;

    stream->data = calloc(1, sizeof(misc_vorbis_info));

    info = stream->data;

    vorbis_comment_init(&info->vc);
    vorbis_info_init(&info->vi);

}

static stream_processor *find_stream_processor(stream_set *set, ogg_page *page)
{
    ogg_uint32_t serial = ogg_page_serialno(page);
    int i, found = 0;
    int invalid = 0;
702
    int constraint = 0;
703 704 705 706 707 708 709 710 711 712 713 714
    stream_processor *stream;

    for(i=0; i < set->used; i++) {
        if(serial == set->streams[i].serial) {
            /* We have a match! */
            found = 1;
            stream = &(set->streams[i]);

            set->in_headers = 0;
            /* if we have detected EOS, then this can't occur here. */
            if(stream->end) {
                stream->isillegal = 1;
715
                stream->constraint_violated = CONSTRAINT_PAGE_AFTER_EOS;
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
                return stream;
            }

            stream->isnew = 0;
            stream->start = ogg_page_bos(page);
            stream->end = ogg_page_eos(page);
            stream->serial = serial;
            return stream;
        }
    }

    /* If there are streams open, and we've reached the end of the
     * headers, then we can't be starting a new stream.
     * XXX: might this sometimes catch ok streams if EOS flag is missing,
     * but the stream is otherwise ok?
     */
732 733
    if(streams_open(set) && !set->in_headers) {
        constraint = CONSTRAINT_MUXING_VIOLATED;
734
        invalid = 1;
735
    }
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751

    set->in_headers = 1;

    if(set->allocated < set->used)
        stream = &set->streams[set->used];
    else {
        set->allocated += 5;
        set->streams = realloc(set->streams, sizeof(stream_processor)*
                set->allocated);
        stream = &set->streams[set->used];
    }
    set->used++;
    stream->num = set->used; /* We count from 1 */

    stream->isnew = 1;
    stream->isillegal = invalid;
752
    stream->constraint_violated = constraint;
753 754 755 756 757 758 759 760 761 762

    {
        int res;
        ogg_packet packet;

        /* We end up processing the header page twice, but that's ok. */
        ogg_stream_init(&stream->os, serial);
        ogg_stream_pagein(&stream->os, page);
        res = ogg_stream_packetout(&stream->os, &packet);
        if(res <= 0) {
763
            warn(_("Warning: Invalid header page, no packet found\n"));
764
            null_start(stream);
765
        }
j's avatar
j committed
766
        else if(packet.bytes >= 7 && memcmp(packet.packet, "\x01vorbis", 7)==0)
767
            vorbis_start(stream);
j's avatar
j committed
768
        else if(packet.bytes >= 7 && memcmp(packet.packet, "\x80theora", 7)==0) 
769
            theora_start(stream);
770 771
        else if(packet.bytes >= 8 && memcmp(packet.packet, "OggMIDI\0", 8)==0) 
            other_start(stream, "MIDI");
772 773 774 775
        else if(packet.bytes >= 4 && memcmp(packet.packet, "fLaC", 4)==0) 
            other_start(stream, "FLAC");
        else if(packet.bytes >= 8 && memcmp(packet.packet, "Speex   ", 8)==0) 
            other_start(stream, "speex");
776 777
        else
            other_start(stream, NULL);
778 779 780

        res = ogg_stream_packetout(&stream->os, &packet);
        if(res > 0) {
781
            warn(_("Warning: Invalid header page in stream %d, "
782 783 784 785 786 787 788 789 790 791 792 793
                              "contains multiple packets\n"), stream->num);
        }

        /* re-init, ready for processing */
        ogg_stream_clear(&stream->os);
        ogg_stream_init(&stream->os, serial);
   }

   stream->start = ogg_page_bos(page);
   stream->end = ogg_page_eos(page);
   stream->serial = serial;

794 795
   if(stream->serial == 0 || stream->serial == -1) {
       info(_("Note: Stream %d has serial number %d, which is legal but may "
796 797
              "cause problems with some tools.\n"), stream->num, 
               stream->serial);
798 799
   }

800 801 802
   return stream;
}

803 804
static int get_next_page(FILE *f, ogg_sync_state *sync, ogg_page *page, 
        ogg_int64_t *written)
805 806 807 808 809
{
    int ret;
    char *buffer;
    int bytes;

810
    while((ret = ogg_sync_pageseek(sync, page)) <= 0) {
811
        if(ret < 0)
812
#ifdef _WIN32
813
            warn(_("Warning: Hole in data (%d bytes) found at approximate offset %I64d bytes. Corrupted ogg.\n"), *written);
814
#else
815
            warn(_("Warning: Hole in data (%d bytes) found at offset %lld bytes, skipped %d bytes. Corrupted ogg.\n"), *written, -ret);
816
#endif
817 818 819

        buffer = ogg_sync_buffer(sync, CHUNK);
        bytes = fread(buffer, 1, CHUNK, f);
820 821
        if(bytes <= 0) {
            ogg_sync_wrote(sync, 0);
822
            return 0;
823 824 825
        }
        ogg_sync_wrote(sync, bytes);
        *written += bytes;
826 827 828 829 830 831 832 833 834 835
    }

    return 1;
}

static void process_file(char *filename) {
    FILE *file = fopen(filename, "rb");
    ogg_sync_state sync;
    ogg_page page;
    stream_set *processors = create_stream_set();
836 837
    int gotpage = 0;
    ogg_int64_t written = 0;
838 839

    if(!file) {
840
        error(_("Error opening input file \"%s\": %s\n"), filename,
841 842 843 844
                    strerror(errno));
        return;
    }

845
    printf(_("Processing file \"%s\"...\n\n"), filename);
846 847 848

    ogg_sync_init(&sync);

849
    while(get_next_page(file, &sync, &page, &written)) {
850
        stream_processor *p = find_stream_processor(processors, &page);
851
        gotpage = 1;
852 853

        if(!p) {
854
            error(_("Could not find a processor for stream, bailing\n"));
855 856 857 858
            return;
        }

        if(p->isillegal && !p->shownillegal) {
859 860 861 862 863 864 865 866 867 868 869 870 871
            char *constraint;
            switch(p->constraint_violated) {
                case CONSTRAINT_PAGE_AFTER_EOS:
                    constraint = _("Page found for stream after EOS flag");
                    break;
                case CONSTRAINT_MUXING_VIOLATED:
                    constraint = _("Ogg muxing constraints violated, new "
                                   "stream before EOS of all previous streams");
                    break;
                default:
                    constraint = _("Error unknown.");
            }

872
            warn(_("Warning: illegally placed page(s) for logical stream %d\n"
873 874
                   "This indicates a corrupt ogg file: %s.\n"), 
                    p->num, constraint);
875
            p->shownillegal = 1;
876 877 878 879 880
            /* If it's a new stream, we want to continue processing this page
             * anyway to suppress additional spurious errors
             */
            if(!p->isnew)
                continue;
881 882 883
        }

        if(p->isnew) {
884
            info(_("New logical stream (#%d, serial: %08x): type %s\n"), 
885 886
                    p->num, p->serial, p->type);
            if(!p->start)
887
                warn(_("Warning: stream start flag not set on stream %d\n"),
888 889 890
                        p->num);
        }
        else if(p->start)
891
            warn(_("Warning: stream start flag found in mid-stream "
892 893
                      "on stream %d\n"), p->num);

894 895 896 897 898 899 900 901 902 903 904
        if(p->seqno++ != ogg_page_pageno(&page)) {
            if(!p->lostseq) 
                warn(_("Warning: sequence number gap in stream %d. Got page "
                       "%ld when expecting page %ld. Indicates missing data.\n"
                       ), p->num, ogg_page_pageno(&page), p->seqno - 1);
            p->seqno = ogg_page_pageno(&page);
            p->lostseq = 1;
        }
        else
            p->lostseq = 0;

905 906 907 908 909 910
        if(!p->isillegal) {
            p->process_page(p, &page);

            if(p->end) {
                if(p->process_end)
                    p->process_end(p);
911
                info(_("Logical stream %d ended\n"), p->num);
912
                p->isillegal = 1;
913
                p->constraint_violated = CONSTRAINT_PAGE_AFTER_EOS;
914 915 916 917
            }
        }
    }

918 919 920 921
    if(!gotpage)
        error(_("Error: No ogg data found in file \"%s\".\n"
                "Input probably not ogg.\n"), filename);

922 923 924 925 926 927 928
    free_stream_set(processors);

    ogg_sync_clear(&sync);

    fclose(file);
}

929
static void usage(void) {
930 931
    printf(_("ogginfo 1.1.0\n"
             "(c) 2003-2005 Michael Smith <msmith@xiph.org>\n"
932
             "\n"
Michael Smith's avatar
Michael Smith committed
933
             "Usage: ogginfo [flags] file1.ogg [file2.ogg ... fileN.ogg]\n"
934 935 936 937 938 939 940 941
             "Flags supported:\n"
             "\t-h Show this help message\n"
             "\t-q Make less verbose. Once will remove detailed informative\n"
             "\t   messages, two will remove warnings\n"
             "\t-v Make more verbose. This may enable more detailed checks\n"
             "\t   for some stream types.\n\n"));
}

942
int main(int argc, char **argv) {
943
    int f, ret;
944 945 946 947 948 949 950

    setlocale(LC_ALL, "");
    bindtextdomain(PACKAGE, LOCALEDIR);
    textdomain(PACKAGE);

    if(argc < 2) {
        fprintf(stderr, 
951
                _("Usage: ogginfo [flags] file1.ogg [file2.ogg ... fileN.ogg]\n"
952 953
                  "\n"
                  "Ogginfo is a tool for printing information about ogg files\n"
954 955
                  "and for diagnosing problems with them.\n"
                  "Full help shown with \"ogginfo -h\".\n"));
956 957 958
        exit(1);
    }

959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
    while((ret = getopt(argc, argv, "hvq")) >= 0) {
        switch(ret) {
            case 'h':
                usage();
                return 0;
            case 'v':
                verbose++;
                break;
            case 'q':
                verbose--;
                break;
        }
    }

    if(verbose < 1)
        printinfo = 0;
    if(verbose < 0) 
        printwarn = 0;

    if(optind >= argc) {
979 980
        fprintf(stderr, 
                _("No input files specified. \"ogginfo -h\" for help\n"));
981 982 983
        return 1;
    }

984 985
    ret = 0;

986
    for(f=optind; f < argc; f++) {
987
        flawed = 0;
988
        process_file(argv[f]);
989 990
        if(flawed != 0)
            ret = flawed;
991 992
    }

993
    return ret;
994
}