format_ebml.c 21.8 KB
Newer Older
1 2
/* Icecast
 *
3
 * This program is distributed under the GNU General Public License,
4 5 6
 * version 2. A copy of this license is included with this source.
 * At your option, this specific source file can also be distributed
 * under the GNU GPL version 3.
7
 *
8
 * Copyright 2012,      David Richards, Mozilla Foundation,
9
 *                      and others (see AUTHORS for details).
10
 * Copyright 2014,      Philipp "ph3-der-loewe" Schafft <lion@lion.leolix.org>.
11 12 13 14
 */

/* format_ebml.c
 *
giles's avatar
giles committed
15
 * format plugin for WebM/EBML
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
 *
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include "refbuf.h"
#include "source.h"
#include "client.h"

#include "stats.h"
#include "format.h"
#include "format_ebml.h"

#define CATMODULE "format-ebml"

#include "logging.h"

#define EBML_HEADER_MAX_SIZE 131072
#define EBML_SLICE_SIZE 4096

42 43 44
/* A value that no EBML var-int is allowed to take. */
#define EBML_UNKNOWN ((unsigned long long) -1)

45 46 47 48
typedef enum ebml_read_mode {
    EBML_STATE_READING_HEADER = 0,
    EBML_STATE_READING_CLUSTERS
} ebml_read_mode;
49

50 51 52 53 54 55 56 57
typedef enum ebml_parsing_state {
    EBML_STATE_PARSING_HEADER = 0,
    EBML_STATE_COPYING_TO_HEADER,
    EBML_STATE_START_CLUSTER,
    EBML_STATE_PARSING_CLUSTERS,
    EBML_STATE_COPYING_TO_DATA
} ebml_parsing_state;

58 59 60 61 62 63
typedef enum ebml_chunk_type {
    EBML_CHUNK_HEADER = 0,
    EBML_CHUNK_CLUSTER_START,
    EBML_CHUNK_CLUSTER_CONTINUE
} ebml_chunk_type;

64 65 66 67 68 69 70 71 72 73 74
typedef struct ebml_client_data_st ebml_client_data_t;

struct ebml_client_data_st {

    refbuf_t *header;
    int header_pos;

};

struct ebml_st {

75
    ebml_read_mode output_state;
76 77
    ebml_parsing_state parse_state;
    unsigned long long copy_len;
78
    
79
    int cluster_start;
80

81 82
    int position;
    unsigned char *buffer;
83 84 85

    int input_position;
    unsigned char *input_buffer;
86
    
87 88 89 90 91 92 93
    int header_size;
    int header_position;
    int header_read_position;
    unsigned char *header;

};

94 95 96 97 98 99
static void ebml_free_plugin(format_plugin_t *plugin);
static refbuf_t *ebml_get_buffer(source_t *source);
static int ebml_write_buf_to_client(client_t *client);
static void ebml_write_buf_to_file(source_t *source, refbuf_t *refbuf);
static int ebml_create_client_data(source_t *source, client_t *client);
static void ebml_free_client_data(client_t *client);
100 101 102 103

static ebml_t *ebml_create();
static void ebml_destroy(ebml_t *ebml);
static int ebml_read_space(ebml_t *ebml);
104
static int ebml_read(ebml_t *ebml, char *buffer, int len, ebml_chunk_type *chunk_type);
105
static unsigned char *ebml_get_write_buffer(ebml_t *ebml, int *bytes);
106
static int ebml_wrote(ebml_t *ebml, int len);
107 108 109 110 111 112
static int ebml_parse_tag(unsigned char      *buffer,
                          unsigned char      *buffer_end,
                          unsigned long long *payload_length);
static int ebml_parse_var_int(unsigned char      *buffer,
                              unsigned char      *buffer_end,
                              unsigned long long *out_value);
113

114
int format_ebml_get_plugin(source_t *source)
115 116 117 118 119 120 121 122 123 124 125 126 127
{

    ebml_source_state_t *ebml_source_state = calloc(1, sizeof(ebml_source_state_t));
    format_plugin_t *plugin = calloc(1, sizeof(format_plugin_t));

    plugin->get_buffer = ebml_get_buffer;
    plugin->write_buf_to_client = ebml_write_buf_to_client;
    plugin->create_client_data = ebml_create_client_data;
    plugin->free_plugin = ebml_free_plugin;
    plugin->write_buf_to_file = ebml_write_buf_to_file;
    plugin->set_tag = NULL;
    plugin->apply_settings = NULL;

128
    plugin->contenttype = httpp_getvar(source->parser, "content-type");
129 130

    plugin->_state = ebml_source_state;
131
    vorbis_comment_init(&plugin->vc);
132 133 134
    source->format = plugin;

    ebml_source_state->ebml = ebml_create();
135
    
136 137 138
    return 0;
}

139
static void ebml_free_plugin(format_plugin_t *plugin)
140 141 142 143
{

    ebml_source_state_t *ebml_source_state = plugin->_state;

144
    refbuf_release(ebml_source_state->header);
145
    ebml_destroy(ebml_source_state->ebml);
146
    free(ebml_source_state);
147
    vorbis_comment_clear(&plugin->vc);
148
    free(plugin);
149 150
}

151 152
/* Write to a client from the header buffer.
 */
153
static int send_ebml_header(client_t *client)
154 155 156 157 158 159
{

    ebml_client_data_t *ebml_client_data = client->format_data;
    int len = EBML_SLICE_SIZE;
    int ret;

160
    if (ebml_client_data->header->len - ebml_client_data->header_pos < len)
161 162 163
    {
        len = ebml_client_data->header->len - ebml_client_data->header_pos;
    }
164
    ret = client_send_bytes (client,
165 166 167 168 169 170 171 172 173 174 175 176
                             ebml_client_data->header->data + ebml_client_data->header_pos,
                             len);

    if (ret > 0)
    {
        ebml_client_data->header_pos += ret;
    }

    return ret;

}

177 178
/* Initial write-to-client function.
 */
179 180 181 182 183 184 185 186 187 188 189
static int ebml_write_buf_to_client (client_t *client)
{

    ebml_client_data_t *ebml_client_data = client->format_data;

    if (ebml_client_data->header_pos != ebml_client_data->header->len)
    {
        return send_ebml_header (client);
    }
    else
    {
190 191
        /* Now that the header's sent, short-circuit to the generic
         * write-refbufs function. */
192 193 194 195 196 197
        client->write_to_client = format_generic_write_to_client;
        return client->write_to_client(client);
    }

}

198 199
/* Return a refbuf to add to the queue.
 */
200
static refbuf_t *ebml_get_buffer(source_t *source)
201 202 203 204
{

    ebml_source_state_t *ebml_source_state = source->format->_state;
    format_plugin_t *format = source->format;
205 206 207
    unsigned char *write_buffer = NULL;
    int read_bytes = 0;
    int write_bytes = 0;
208
    ebml_chunk_type chunk_type;
209 210 211 212 213
    refbuf_t *refbuf;
    int ret;

    while (1)
    {
214 215
        read_bytes = ebml_read_space(ebml_source_state->ebml);
        if (read_bytes > 0) {
216
            /* A chunk is available for reading */
217 218
            refbuf = refbuf_new(read_bytes);
            ebml_read(ebml_source_state->ebml, refbuf->data, read_bytes, &chunk_type);
219 220 221

            if (ebml_source_state->header == NULL)
            {
222
                /* Capture header before adding clusters to the queue */
223 224 225 226
                ebml_source_state->header = refbuf;
                continue;
            }

227
/*            ICECAST_LOG_DEBUG("EBML: generated refbuf, size %i : %hhi %hhi %hhi",
228
 *                            read_bytes, refbuf->data[0], refbuf->data[1], refbuf->data[2]);
229 230 231
 */
                              
            if (chunk_type == EBML_CHUNK_CLUSTER_START)
232 233
            {
                refbuf->sync_point = 1;
234
/*                ICECAST_LOG_DEBUG("EBML: ^ was sync point"); */
235 236 237
            }
            return refbuf;

238
        } else if(read_bytes == 0) {
239
            /* Feed more bytes into the parser */
240 241 242
            write_buffer = ebml_get_write_buffer(ebml_source_state->ebml, &write_bytes);
            read_bytes = client_read_bytes (source->client, write_buffer, write_bytes);
            if (read_bytes <= 0) {
243 244 245
                ebml_wrote (ebml_source_state->ebml, 0);
                return NULL;
            }
246 247 248
            format->read_bytes += read_bytes;
            ret = ebml_wrote (ebml_source_state->ebml, read_bytes);
            if (ret != read_bytes) {
249
                ICECAST_LOG_ERROR("Problem processing stream");
250 251 252
                source->running = 0;
                return NULL;
            }
253 254 255 256
        } else {
            ICECAST_LOG_ERROR("Problem processing stream");
            source->running = 0;
            return NULL;
257 258 259 260
        }
    }
}

261 262
/* Initialize client state.
 */
263
static int ebml_create_client_data(source_t *source, client_t *client)
264
{
265
    ebml_client_data_t *ebml_client_data;
266 267
    ebml_source_state_t *ebml_source_state = source->format->_state;

268 269
    if (!ebml_source_state->header)
        return -1;
270

271 272 273
    ebml_client_data = calloc(1, sizeof(ebml_client_data_t));
    if (!ebml_client_data)
        return -1;
274

275 276 277 278 279
    ebml_client_data->header = ebml_source_state->header;
    refbuf_addref(ebml_client_data->header);
    client->format_data = ebml_client_data;
    client->free_client_data = ebml_free_client_data;
    return 0;
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
}


static void ebml_free_client_data (client_t *client)
{

    ebml_client_data_t *ebml_client_data = client->format_data;

    refbuf_release (ebml_client_data->header);
    free (client->format_data);
    client->format_data = NULL;
}


static void ebml_write_buf_to_file_fail (source_t *source)
{
296
    ICECAST_LOG_WARN("Write to dump file failed, disabling");
297 298 299 300 301 302 303 304 305 306 307 308 309
    fclose (source->dumpfile);
    source->dumpfile = NULL;
}


static void ebml_write_buf_to_file (source_t *source, refbuf_t *refbuf)
{

    ebml_source_state_t *ebml_source_state = source->format->_state;

    if (ebml_source_state->file_headers_written == 0)
    {
        if (fwrite (ebml_source_state->header->data, 1,
310
                    ebml_source_state->header->len,
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
                    source->dumpfile) != ebml_source_state->header->len)
            ebml_write_buf_to_file_fail(source);
        else
            ebml_source_state->file_headers_written = 1;
    }

    if (fwrite (refbuf->data, 1, refbuf->len, source->dumpfile) != refbuf->len)
    {
        ebml_write_buf_to_file_fail(source);
    }

}


/* internal ebml parsing */

static void ebml_destroy(ebml_t *ebml)
{

    free(ebml->header);
    free(ebml->input_buffer);
    free(ebml->buffer);
    free(ebml);

}

static ebml_t *ebml_create()
{

    ebml_t *ebml = calloc(1, sizeof(ebml_t));

342 343
    ebml->output_state = EBML_STATE_READING_HEADER;

344
    ebml->header = calloc(1, EBML_HEADER_MAX_SIZE);
345
    ebml->buffer = calloc(1, EBML_SLICE_SIZE);
346 347
    ebml->input_buffer = calloc(1, EBML_SLICE_SIZE);

348
    ebml->cluster_start = -1;
349 350 351 352 353

    return ebml;

}

354 355 356
/* Return the size of a buffer needed to store the next
 * chunk that ebml_read can yield.
 */
357 358 359 360 361
static int ebml_read_space(ebml_t *ebml)
{

    int read_space;

362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
    switch (ebml->output_state) {
        case EBML_STATE_READING_HEADER:
        
            if (ebml->header_size != 0) {
                /* The header can be read */
                return ebml->header_size;
            } else {
                /* The header's not ready yet */
                return 0;
            }
            break;
            
        case EBML_STATE_READING_CLUSTERS:
            
            if (ebml->cluster_start > 0) {
                /* return up until just before a new cluster starts */
                read_space = ebml->cluster_start;
            } else {
380 381
                /* return what we have */
                read_space = ebml->position;
382
            }
383

384
            return read_space;
385
    }
386 387 388
    
    ICECAST_LOG_ERROR("EBML: Invalid parser read state");
    return 0;
389 390
}

391
/* Return a chunk of the EBML/MKV/WebM stream.
392
 * The header will be buffered until it can be returned as one chunk.
393
 * A cluster element's opening tag will always start a new chunk.
394 395 396
 * 
 * chunk_type will be set to indicate if the chunk is the header,
 * the start of a cluster, or continuing the current cluster.
397
 */
398
static int ebml_read(ebml_t *ebml, char *buffer, int len, ebml_chunk_type *chunk_type)
399 400 401 402
{

    int read_space;
    int to_read;
403 404
    
    *chunk_type = EBML_CHUNK_HEADER;
405

406
    if (len < 1) {
407
        return 0;
408
    }
409

410 411 412 413 414 415 416
    switch (ebml->output_state) {
        case EBML_STATE_READING_HEADER:
        
            if (ebml->header_size != 0)
            {
                /* Can read a chunk of the header */
                read_space = ebml->header_size - ebml->header_read_position;
417

418 419 420 421 422
                if (read_space >= len) {
                    to_read = len;
                } else {
                    to_read = read_space;
                }
423

424 425
                memcpy(buffer, ebml->header, to_read);
                ebml->header_read_position += to_read;
426 427 428
                
                *chunk_type = EBML_CHUNK_HEADER;
                
429 430 431 432 433 434 435 436 437 438 439
                if (ebml->header_read_position == ebml->header_size) {
                    ebml->output_state = EBML_STATE_READING_CLUSTERS;
                }
            } else {
                /* The header's not ready yet */
                return 0;
            }
        
            break;
            
        case EBML_STATE_READING_CLUSTERS:
440
        
441 442 443 444 445 446 447 448 449 450
            *chunk_type = EBML_CHUNK_CLUSTER_CONTINUE;
            read_space = ebml->position;
            
            if (ebml->cluster_start == 0) {
                /* new cluster is starting now */
                *chunk_type = EBML_CHUNK_CLUSTER_START;
                
                /* mark end of cluster */
                ebml->cluster_start = -1;
            } else if (ebml->cluster_start > 0) {
451 452 453
                /* return up until just before a new cluster starts */
                read_space = ebml->cluster_start;
            }
454

455 456 457
            if (read_space < 1) {
                return 0;
            }
458

459
            if (read_space >= len ) {
460
                to_read = len;
461
            } else {
462
                to_read = read_space;
463
            }
464

465 466 467 468 469
            memcpy(buffer, ebml->buffer, to_read);
            
            /* Shift unread data down to the start of the buffer */
            memmove(ebml->buffer, ebml->buffer + to_read, ebml->position - to_read);
            ebml->position -= to_read;
470

471 472
            if (ebml->cluster_start > 0) {
                ebml->cluster_start -= to_read;
473
            }
474 475
        
            break;
476 477 478 479 480 481
    }

    return to_read;

}

482 483 484 485 486 487
/* Get pointer & length of the buffer able to accept input.
 * 
 * Returns the start of the writable space;
 * Sets bytes to the amount of space available.
 */
static unsigned char *ebml_get_write_buffer(ebml_t *ebml, int *bytes)
488
{
489 490
    *bytes = EBML_SLICE_SIZE - ebml->input_position;
    return ebml->input_buffer + ebml->input_position;
491 492
}

493 494
/* Process data that has been written to the EBML parser's input buffer.
 */
495 496
static int ebml_wrote(ebml_t *ebml, int len)
{
497 498 499 500
    int processing = 1;
    int cursor = 0;
    int to_copy;
    unsigned char *end_of_buffer;
501

502 503 504
    int tag_length;
    unsigned long long payload_length;
    int copy_state;
505

506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
    char *segment_id = "\x18\x53\x80\x67";
    char *cluster_id = "\x1F\x43\xB6\x75";
    
    ebml->input_position += len;
    end_of_buffer = ebml->input_buffer + ebml->input_position;
    
    while (processing) {
        
        /*ICECAST_LOG_DEBUG("Parse State: %i", ebml->parse_state);*/
        
        switch (ebml->parse_state) {
            
            case EBML_STATE_PARSING_HEADER:
            case EBML_STATE_PARSING_CLUSTERS:
                
                if (ebml->parse_state == EBML_STATE_PARSING_HEADER) {
                    copy_state = EBML_STATE_COPYING_TO_HEADER;
                } else {
                    copy_state = EBML_STATE_COPYING_TO_DATA;
                }
526
                
527 528
                tag_length = ebml_parse_tag(ebml->input_buffer + cursor,
                                            end_of_buffer, &payload_length);
529
                
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
                if (tag_length > 0) {
                    
                    if (payload_length == EBML_UNKNOWN) {
                        /* Parse all children for tags we can't skip */
                        payload_length = 0;
                    }
                    
                    if (!memcmp(ebml->input_buffer + cursor, cluster_id, 4)) {
                        /* Found a cluster */
                        ebml->parse_state = EBML_STATE_START_CLUSTER;
                        
                    } else if (!memcmp(ebml->input_buffer + cursor, segment_id, 4)) {
                        /* Segment tag, copy tag to buffer but parse children */
                        ebml->copy_len = tag_length;
                        ebml->parse_state = copy_state;
                        
                    } else {
                        /* Non-cluster tag, copy it & children into buffer */
                        ebml->copy_len = tag_length + payload_length;
                        ebml->parse_state = copy_state;
                        
                    }

                } else if (tag_length == 0) {
                    /* Wait for more data */
                    /* ICECAST_LOG_DEBUG("Wait"); */
                    processing = 0;
                } else if (tag_length < 0) {
                    /* Parse error */
                    /* ICECAST_LOG_DEBUG("Stop"); */
                    return -1;
                }
                break;
            
            case EBML_STATE_START_CLUSTER:
                /* found a cluster; wait to process it until
                 * any previous cluster tag has been flushed
                 * from the read buffer, so as to not lose the
                 * sync point.
                 */
                if (ebml->cluster_start >= 0) {
                    processing = 0;
                } else {
                    
                    tag_length = ebml_parse_tag(ebml->input_buffer + cursor,
                                                end_of_buffer, &payload_length);
                    
                    /* The header has been fully read by now, publish its size. */
                    ebml->header_size = ebml->header_position;
                    
                    /* Mark this sync point */
                    ebml->cluster_start = ebml->position;
                    
                    /* Copy cluster tag to read buffer */
                    ebml->copy_len = tag_length;
                    ebml->parse_state = EBML_STATE_COPYING_TO_DATA;
                }
                break;
            
            case EBML_STATE_COPYING_TO_HEADER:
            case EBML_STATE_COPYING_TO_DATA:
                to_copy = ebml->input_position - cursor;
                if (to_copy > ebml->copy_len) {
                    to_copy = ebml->copy_len;
                }
                
                if (ebml->parse_state == EBML_STATE_COPYING_TO_HEADER) {
                    if ((ebml->header_position + to_copy) > EBML_HEADER_MAX_SIZE) {
                        ICECAST_LOG_ERROR("EBML Header too large, failing");
                        return -1;
                    }
                    
                    memcpy(ebml->header + ebml->header_position, ebml->input_buffer + cursor, to_copy);
                    ebml->header_position += to_copy;
                    
                } else if (ebml->parse_state == EBML_STATE_COPYING_TO_DATA) {
                    if ((ebml->position + to_copy) > EBML_SLICE_SIZE) {
                        to_copy = EBML_SLICE_SIZE - ebml->position;
                    }
                    
                    memcpy(ebml->buffer + ebml->position, ebml->input_buffer + cursor, to_copy);
                    ebml->position += to_copy;
                }
                /* ICECAST_LOG_DEBUG("Copied %i of %hhu", to_copy, ebml->copy_len); */
                
                cursor += to_copy;
                ebml->copy_len -= to_copy;
                
                if (ebml->copy_len == 0) {
                    /* resume parsing */
                    if (ebml->parse_state == EBML_STATE_COPYING_TO_HEADER) {
                        ebml->parse_state = EBML_STATE_PARSING_HEADER;
                    } else {
                        ebml->parse_state = EBML_STATE_PARSING_CLUSTERS;
                    }
                } else {
                    /* wait for more data */
                    processing = 0;
                }
                
                break;
            
            default:
                processing = 0;
            
635
        }
636
    
637
    }
638 639 640 641 642
    
    /* Shift unprocessed data down to the start of the buffer */
    memmove(ebml->input_buffer, ebml->input_buffer + cursor, ebml->input_position - cursor);
    ebml->input_position -= cursor;
    
643
    return len;
644
    
645
}
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749

/* Try to parse an EBML tag at the given location, returning the
 * length of the tag & the length of the associated payload.
 * 
 * Returns the length of the tag on success, and writes the payload
 * size to *payload_length.
 * 
 * Return 0 if it would be necessary to read past the
 * given end-of-buffer address to read a complete tag.
 * 
 * Returns -1 if the tag is corrupt.
 */

static int ebml_parse_tag(unsigned char *buffer,
                          unsigned char *buffer_end,
                          unsigned long long *payload_length)
{
    int type_length;
    int size_length;
    unsigned long long value;
    
    *payload_length = 0;
    
    /* read past the type tag */
    type_length = ebml_parse_var_int(buffer, buffer_end, &value);
    
    if (type_length <= 0) {
        return type_length;
    }
    
    /* read the length tag */
    size_length = ebml_parse_var_int(buffer + type_length, buffer_end, payload_length);
    
    if (size_length <= 0) {
        return size_length;
    }
    
    return type_length + size_length;
}

/* Try to parse an EBML variable-length integer.
 * Returns 0 if there's not enough space to read the number;
 * Returns -1 if the number is malformed.
 * Else, returns the length of the number in bytes and writes the
 * value to *out_value.
 */
static int ebml_parse_var_int(unsigned char *buffer,
                              unsigned char *buffer_end,
                              unsigned long long *out_value)
{
    int size = 1;
    int i;
    unsigned char mask = 0x80;
    unsigned long long value;
    unsigned long long unknown_marker;
    
    if (buffer >= buffer_end) {
        return 0;
    }
    
    /* find the length marker bit in the first byte */
    value = buffer[0];
    
    while (mask) {
        if (value & mask) {
            value = value & ~mask;
            unknown_marker = mask - 1;
            break;
        }
        size++;
        mask = mask >> 1;
    }
    
    /* catch malformed number (no prefix) */
    if (mask == 0) {
        ICECAST_LOG_DEBUG("Corrupt var-int");
        return -1;
    }
    
    /* catch number bigger than parsing buffer */
    if (buffer + size - 1 >= buffer_end) {
        return 0;
    }
    
    /* read remaining bytes of (big-endian) number */
    for (i = 1; i < size; i++) {
        value = (value << 8) + buffer[i];
        unknown_marker = (unknown_marker << 8) + 0xFF;
    }
    
    /* catch special "unknown" length */
    
    if (value == unknown_marker) {
        *out_value = EBML_UNKNOWN;
    } else {
        *out_value = value;
    }

/*
    ICECAST_LOG_DEBUG("Varint: value %lli, unknown %llu, mask %hhu, size %i", value, unknown_marker, mask, size);
*/
    
    return size;
}