ogginfo2.c 29.3 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>
16 17 18 19 20 21 22 23

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

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

24 25
#include "theora.h"

26 27
#define CHUNK 4500

28 29 30 31 32 33 34 35 36 37 38
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
39
        {"Xiph.Org libVorbis I 20020717", "1.0"},
Monty's avatar
 
Monty committed
40
        {"Xiph.Org libVorbis I 20030909", "1.0.1"},
41
        {"Xiph.Org libVorbis I 20040629", "1.1.0 rc1"},
42 43 44 45
        {NULL, NULL},
    };


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

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

    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
86
    ogg_int64_t bytes;
87
    ogg_int64_t lastgranulepos;
88
    ogg_int64_t firstgranulepos;
89 90 91 92

    int doneheaders;
} misc_vorbis_info;

93 94 95 96 97 98 99 100 101 102 103
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;

104 105 106 107
static int printinfo = 1;
static int printwarn = 1;
static int verbose = 1;

108 109
static int flawed;

110 111 112
#define CONSTRAINT_PAGE_AFTER_EOS   1
#define CONSTRAINT_MUXING_VIOLATED  2

113 114 115 116 117 118 119 120 121 122
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;
}

123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
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;

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

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

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

152 153
    flawed = 1;

154 155 156 157 158
    va_start(ap, format);
    vfprintf(stdout, format, ap);
    va_end(ap);
}

159 160
static void check_xiph_comment(stream_processor *stream, int i, char *comment,
    int comment_length)
161 162 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;

    val = comment;

192 193
    j = sep-comment+1;
    while(j < comment_length)
194
    {
195
        remaining = comment_length - j;
196 197 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 286 287 288 289 290 291 292 293 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
        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) {
             warn(_("Warning: Illegal UTF-8 sequence in comment "
                   "%d (stream %d): invalid sequence\n"), i, stream->num);
             broken = 1;
             break;
         }

         j += bytes;
     }

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

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);
j's avatar
j committed
337
		info(_("Total image: %d by %d, offset x %d, offset y %d\n"),
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
		    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
		   info(_("Framerate %d/%d (%f fps)\n"), inf->ti.fps_numerator, inf->ti.fps_denominator, (float)inf->ti.fps_numerator/(float)inf->ti.fps_denominator);
		
		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; 
		    info(_("Pixel aspect ratio %d:%d (1:%f)\n"), inf->ti.aspect_numerator, inf->ti.aspect_denominator, (float)inf->ti.aspect_numerator/(float)inf->ti.aspect_denominator);
                    if(abs(frameaspect - 4.0/3.0) < 0.02)
358
			info(_("Frame aspect 4:3\n"));
359
                    else if(abs(frameaspect - 16.0/9.0) < 0.02)
360
			info(_("Frame aspect 16:9\n"));
361
		    else
362
			info(_("Frame aspect 1:%d\n"), frameaspect);
363 364 365
		}

		if(inf->ti.colorspace == OC_CS_ITU_REC_470M)
366
		    info(_("Colourspace: Rec. ITU-R BT.470-6 System M (NTSC)\n")); 
367
		else if(inf->ti.colorspace == OC_CS_ITU_REC_470BG)
368
		    info(_("Colourspace: Rec. ITU-R BT.470-6 Systems B and G (PAL)\n")); 
369
		else
370
		    info(_("Colourspace unspecified\n"));
371 372

		if(inf->ti.pixelformat == OC_PF_420)
373
		    info(_("Pixel format 4:2:0\n"));
374
		else if(inf->ti.pixelformat == OC_PF_422)
375
		    info(_("Pixel format 4:2:2\n"));
376
		else if(inf->ti.pixelformat == OC_PF_444)
377
		    info(_("Pixel format 4:4:4\n"));
378
		else
379
		    warn(_("Pixel format invalid\n"));
380

381 382
		info(_("Target bitrate: %d kbps\n"), inf->ti.target_bitrate/1000);
		info(_("Nominal quality setting (0-63): %d\n"), inf->ti.quality);
383 384 385 386 387 388

                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];
389 390
		    check_xiph_comment(stream, i, comment, 
		            inf->tc.comment_lengths[i]);
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
		}
	    }
	}
    }

    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*/
422 423 424
    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) /
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 451
	((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);
}


452 453 454
static void vorbis_process(stream_processor *stream, ogg_page *page )
{
    ogg_packet packet;
455
    misc_vorbis_info *inf = stream->data;
456
    int i, header=0;
457
    int k;
458 459

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

    while(ogg_stream_packetout(&stream->os, &packet) > 0) {
464 465 466
        if(inf->doneheaders < 3) {
            if(vorbis_synthesis_headerin(&inf->vi, &inf->vc, &packet) < 0) {
                warn(_("Warning: Could not decode vorbis header "
467 468 469
                       "packet - invalid vorbis stream (%d)\n"), stream->num);
                continue;
            }
470 471
            inf->doneheaders++;
            if(inf->doneheaders == 3) {
472
                if(ogg_page_granulepos(page) != 0 || ogg_stream_packetpeek(&stream->os, NULL) == 1)
473 474 475 476
                    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);
477 478 479 480
                info(_("Vorbis headers parsed for stream %d, "
                       "information follows...\n"), stream->num);

                info(_("Version: %d\n"), inf->vi.version);
481 482 483 484 485 486 487 488 489 490 491
                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);
492 493 494
                info(_("Channels: %d\n"), inf->vi.channels);
                info(_("Rate: %ld\n\n"), inf->vi.rate);

495
                if(inf->vi.bitrate_nominal > 0)
496 497
                    info(_("Nominal bitrate: %f kb/s\n"), 
                            (double)inf->vi.bitrate_nominal / 1000.0);
498
                else
499
                    info(_("Nominal bitrate not set\n"));
500

501
                if(inf->vi.bitrate_upper > 0)
502 503
                    info(_("Upper bitrate: %f kb/s\n"), 
                            (double)inf->vi.bitrate_upper / 1000.0);
504
                else
505
                    info(_("Upper bitrate not set\n"));
506

507
                if(inf->vi.bitrate_lower > 0)
508 509
                    info(_("Lower bitrate: %f kb/s\n"), 
                            (double)inf->vi.bitrate_lower / 1000.0);
510
                else
511
                    info(_("Lower bitrate not set\n"));
512

513 514
                if(inf->vc.comments > 0)
                    info(_("User comments section follows...\n"));
515

516
                for(i=0; i < inf->vc.comments; i++) {
517
                    char *comment = inf->vc.user_comments[i];
518 519
		    check_xiph_comment(stream, i, comment, 
		            inf->vc.comment_lengths[i]);
520
		}
521 522 523 524 525
            }
        }
    }

    if(!header) {
526 527 528
        ogg_int64_t gp = ogg_page_granulepos(page);
        if(gp > 0) {
            if(gp < inf->lastgranulepos)
529 530 531 532
#ifdef _WIN32
                warn(_("Warning: granulepos in stream %d decreases from %I64d to %I64d" ),
                        stream->num, inf->lastgranulepos, gp);
#else
calc's avatar
calc committed
533
                warn(_("Warning: granulepos in stream %d decreases from %lld to %lld" ),
534 535
                        stream->num, inf->lastgranulepos, gp);
#endif
536 537
            inf->lastgranulepos = gp;
        }
538 539 540 541 542
        else {
            warn(_("Negative granulepos on vorbis stream outside of headers. This file was created by a buggy encoder\n"));
        }
        if(inf->firstgranulepos < 0) { /* Not set yet */
        }
543
        inf->bytes += page->header_len + page->body_len;
544 545 546 547 548
    }
}

static void vorbis_end(stream_processor *stream) 
{
549
    misc_vorbis_info *inf = stream->data;
550
    long minutes, seconds, milliseconds;
551 552
    double bitrate, time;

553
    /* This should be lastgranulepos - startgranulepos, or something like that*/
554
    time = (double)inf->lastgranulepos / inf->vi.rate;
555 556
    minutes = (long)time / 60;
    seconds = (long)time - minutes*60;
557
    milliseconds = (long)((time - minutes*60 - seconds)*1000);
558
    bitrate = inf->bytes*8 / time / 1000.0;
559

560 561 562
#ifdef _WIN32
    info(_("Vorbis stream %d:\n"
           "\tTotal data length: %I64d bytes\n"
563
           "\tPlayback length: %ldm:%02ld.%03lds\n"
564
           "\tAverage bitrate: %f kb/s\n"), 
565
            stream->num,inf->bytes, minutes, seconds, milliseconds, bitrate);
566
#else
567
    info(_("Vorbis stream %d:\n"
calc's avatar
calc committed
568
           "\tTotal data length: %lld bytes\n"
569
           "\tPlayback length: %ldm:%02ld.%03lds\n"
570
           "\tAverage bitrate: %f kb/s\n"), 
571
            stream->num,inf->bytes, minutes, seconds, milliseconds, bitrate);
572
#endif
573

574 575
    vorbis_comment_clear(&inf->vc);
    vorbis_info_clear(&inf->vi);
576 577 578 579

    free(stream->data);
}

580 581 582 583 584
static void process_null(stream_processor *stream, ogg_page *page)
{
    /* This is for invalid streams. */
}

585 586 587 588 589 590 591 592 593 594
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 */
    }
}
595

596 597 598 599 600 601

static void free_stream_set(stream_set *set)
{
    int i;
    for(i=0; i < set->used; i++) {
        if(!set->streams[i].end) {
602
            warn(_("Warning: EOS not set on stream %d\n"), 
603
                    set->streams[i].num);
604 605
            if(set->streams[i].process_end)
                set->streams[i].process_end(&set->streams[i]);
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
        }
        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;
}

626 627 628 629 630 631 632
static void null_start(stream_processor *stream)
{
    stream->process_end = NULL;
    stream->type = "invalid";
    stream->process_page = process_null;
}

633
static void other_start(stream_processor *stream, char *type)
634
{
635 636 637 638
    if(type)
        stream->type = type;
    else
        stream->type = "unknown";
639 640 641 642
    stream->process_page = process_other;
    stream->process_end = NULL;
}

643 644 645 646 647 648 649 650 651 652 653 654
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;
}

655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
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;
677
    int constraint = 0;
678 679 680 681 682 683 684 685 686 687 688 689
    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;
690
                stream->constraint_violated = CONSTRAINT_PAGE_AFTER_EOS;
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706
                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?
     */
707 708
    if(streams_open(set) && !set->in_headers) {
        constraint = CONSTRAINT_MUXING_VIOLATED;
709
        invalid = 1;
710
    }
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726

    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;
727
    stream->constraint_violated = constraint;
728 729 730 731 732 733 734 735 736 737

    {
        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) {
738
            warn(_("Warning: Invalid header page, no packet found\n"));
739
            null_start(stream);
740
        }
j's avatar
j committed
741
        else if(packet.bytes >= 7 && memcmp(packet.packet, "\x01vorbis", 7)==0)
742
            vorbis_start(stream);
j's avatar
j committed
743
        else if(packet.bytes >= 7 && memcmp(packet.packet, "\x80theora", 7)==0) 
744
            theora_start(stream);
745 746
        else if(packet.bytes >= 8 && memcmp(packet.packet, "OggMIDI\0", 8)==0) 
            other_start(stream, "MIDI");
747 748 749 750
        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");
751 752
        else
            other_start(stream, NULL);
753 754 755

        res = ogg_stream_packetout(&stream->os, &packet);
        if(res > 0) {
756
            warn(_("Warning: Invalid header page in stream %d, "
757 758 759 760 761 762 763 764 765 766 767 768
                              "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;

769 770
   if(stream->serial == 0 || stream->serial == -1) {
       info(_("Note: Stream %d has serial number %d, which is legal but may "
771 772
              "cause problems with some tools.\n"), stream->num, 
               stream->serial);
773 774
   }

775 776 777
   return stream;
}

778 779
static int get_next_page(FILE *f, ogg_sync_state *sync, ogg_page *page, 
        ogg_int64_t *written)
780 781 782 783 784 785 786
{
    int ret;
    char *buffer;
    int bytes;

    while((ret = ogg_sync_pageout(sync, page)) <= 0) {
        if(ret < 0)
787 788 789
#ifdef _WIN32
            warn(_("Warning: Hole in data found at approximate offset %I64d bytes. Corrupted ogg.\n"), *written);
#else
calc's avatar
calc committed
790
            warn(_("Warning: Hole in data found at approximate offset %lld bytes. Corrupted ogg.\n"), *written);
791
#endif
792 793 794

        buffer = ogg_sync_buffer(sync, CHUNK);
        bytes = fread(buffer, 1, CHUNK, f);
795 796
        if(bytes <= 0) {
            ogg_sync_wrote(sync, 0);
797
            return 0;
798 799 800
        }
        ogg_sync_wrote(sync, bytes);
        *written += bytes;
801 802 803 804 805 806 807 808 809 810
    }

    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();
811 812
    int gotpage = 0;
    ogg_int64_t written = 0;
813 814

    if(!file) {
815
        error(_("Error opening input file \"%s\": %s\n"), filename,
816 817 818 819
                    strerror(errno));
        return;
    }

820
    printf(_("Processing file \"%s\"...\n\n"), filename);
821 822 823

    ogg_sync_init(&sync);

824
    while(get_next_page(file, &sync, &page, &written)) {
825
        stream_processor *p = find_stream_processor(processors, &page);
826
        gotpage = 1;
827 828

        if(!p) {
829
            error(_("Could not find a processor for stream, bailing\n"));
830 831 832 833
            return;
        }

        if(p->isillegal && !p->shownillegal) {
834 835 836 837 838 839 840 841 842 843 844 845 846
            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.");
            }

847
            warn(_("Warning: illegally placed page(s) for logical stream %d\n"
848 849
                   "This indicates a corrupt ogg file: %s.\n"), 
                    p->num, constraint);
850
            p->shownillegal = 1;
851 852 853 854 855
            /* If it's a new stream, we want to continue processing this page
             * anyway to suppress additional spurious errors
             */
            if(!p->isnew)
                continue;
856 857 858
        }

        if(p->isnew) {
859
            info(_("New logical stream (#%d, serial: %08x): type %s\n"), 
860 861
                    p->num, p->serial, p->type);
            if(!p->start)
862
                warn(_("Warning: stream start flag not set on stream %d\n"),
863 864 865
                        p->num);
        }
        else if(p->start)
866
            warn(_("Warning: stream start flag found in mid-stream "
867 868
                      "on stream %d\n"), p->num);

869 870 871 872 873 874 875 876 877 878 879
        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;

880 881 882 883 884 885
        if(!p->isillegal) {
            p->process_page(p, &page);

            if(p->end) {
                if(p->process_end)
                    p->process_end(p);
886
                info(_("Logical stream %d ended\n"), p->num);
887
                p->isillegal = 1;
888
                p->constraint_violated = CONSTRAINT_PAGE_AFTER_EOS;
889 890 891 892
            }
        }
    }

893 894 895 896
    if(!gotpage)
        error(_("Error: No ogg data found in file \"%s\".\n"
                "Input probably not ogg.\n"), filename);

897 898 899 900 901 902 903
    free_stream_set(processors);

    ogg_sync_clear(&sync);

    fclose(file);
}

904
static void usage(void) {
905 906
    printf(_("ogginfo 1.1.0\n"
             "(c) 2003-2005 Michael Smith <msmith@xiph.org>\n"
907
             "\n"
Michael Smith's avatar
Michael Smith committed
908
             "Usage: ogginfo [flags] file1.ogg [file2.ogg ... fileN.ogg]\n"
909 910 911 912 913 914 915 916
             "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"));
}

917
int main(int argc, char **argv) {
918
    int f, ret;
919 920 921 922 923 924 925

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

    if(argc < 2) {
        fprintf(stderr, 
926
                _("Usage: ogginfo [flags] file1.ogg [file2.ogg ... fileN.ogg]\n"
927 928
                  "\n"
                  "Ogginfo is a tool for printing information about ogg files\n"
929 930
                  "and for diagnosing problems with them.\n"
                  "Full help shown with \"ogginfo -h\".\n"));
931 932 933
        exit(1);
    }

934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
    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) {
954 955
        fprintf(stderr, 
                _("No input files specified. \"ogginfo -h\" for help\n"));
956 957 958
        return 1;
    }

959 960
    ret = 0;

961
    for(f=optind; f < argc; f++) {
962
        flawed = 0;
963
        process_file(argv[f]);
964 965
        if(flawed != 0)
            ret = flawed;
966 967
    }

968
    return ret;
969
}