format_ebml.c 13.9 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 45
typedef enum ebml_read_mode {
    EBML_STATE_READING_HEADER = 0,
    EBML_STATE_READING_CLUSTERS
} ebml_read_mode;
46 47 48 49 50 51 52 53 54 55 56 57

typedef struct ebml_client_data_st ebml_client_data_t;

struct ebml_client_data_st {

    refbuf_t *header;
    int header_pos;

};

struct ebml_st {

58 59
    ebml_read_mode output_state;
    
60 61
    char *cluster_id;
    int cluster_start;
62

63 64 65
    int position;
    unsigned char *input_buffer;
    unsigned char *buffer;
66
    
67 68 69 70 71 72 73
    int header_size;
    int header_position;
    int header_read_position;
    unsigned char *header;

};

74 75 76 77 78 79
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);
80 81 82 83 84 85 86 87 88

static ebml_t *ebml_create();
static void ebml_destroy(ebml_t *ebml);
static int ebml_read_space(ebml_t *ebml);
static int ebml_read(ebml_t *ebml, char *buffer, int len);
static int ebml_last_was_sync(ebml_t *ebml);
static char *ebml_write_buffer(ebml_t *ebml, int len);
static int ebml_wrote(ebml_t *ebml, int len);

89
int format_ebml_get_plugin(source_t *source)
90 91 92 93 94 95 96 97 98 99 100 101 102
{

    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;

103
    plugin->contenttype = httpp_getvar(source->parser, "content-type");
104 105

    plugin->_state = ebml_source_state;
106
    vorbis_comment_init(&plugin->vc);
107 108 109
    source->format = plugin;

    ebml_source_state->ebml = ebml_create();
110
    
111 112 113
    return 0;
}

114
static void ebml_free_plugin(format_plugin_t *plugin)
115 116 117 118
{

    ebml_source_state_t *ebml_source_state = plugin->_state;

119
    refbuf_release(ebml_source_state->header);
120
    ebml_destroy(ebml_source_state->ebml);
121
    free(ebml_source_state);
122
    vorbis_comment_clear(&plugin->vc);
123
    free(plugin);
124 125
}

126 127
/* Write to a client from the header buffer.
 */
128
static int send_ebml_header(client_t *client)
129 130 131 132 133 134
{

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

135
    if (ebml_client_data->header->len - ebml_client_data->header_pos < len)
136 137 138
    {
        len = ebml_client_data->header->len - ebml_client_data->header_pos;
    }
139
    ret = client_send_bytes (client,
140 141 142 143 144 145 146 147 148 149 150 151
                             ebml_client_data->header->data + ebml_client_data->header_pos,
                             len);

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

    return ret;

}

152 153
/* Initial write-to-client function.
 */
154 155 156 157 158 159 160 161 162 163 164
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
    {
165 166
        /* Now that the header's sent, short-circuit to the generic
         * write-refbufs function. */
167 168 169 170 171 172
        client->write_to_client = format_generic_write_to_client;
        return client->write_to_client(client);
    }

}

173 174
/* Return a refbuf to add to the queue.
 */
175
static refbuf_t *ebml_get_buffer(source_t *source)
176 177 178 179 180 181 182 183 184 185 186 187 188 189
{

    ebml_source_state_t *ebml_source_state = source->format->_state;
    format_plugin_t *format = source->format;
    char *data = NULL;
    int bytes = 0;
    refbuf_t *refbuf;
    int ret;

    while (1)
    {

        if ((bytes = ebml_read_space(ebml_source_state->ebml)) > 0)
        {
190
            /* A chunk is available for reading */
191 192 193 194 195
            refbuf = refbuf_new(bytes);
            ebml_read(ebml_source_state->ebml, refbuf->data, bytes);

            if (ebml_source_state->header == NULL)
            {
196
                /* Capture header before adding clusters to the queue */
197 198 199 200 201 202 203 204 205 206 207 208 209
                ebml_source_state->header = refbuf;
                continue;
            }

            if (ebml_last_was_sync(ebml_source_state->ebml))
            {
                refbuf->sync_point = 1;
            }
            return refbuf;

        }
        else
        {
210
            /* Feed more bytes into the parser */
211 212 213 214 215 216 217 218 219 220
            data = ebml_write_buffer(ebml_source_state->ebml, EBML_SLICE_SIZE);
            bytes = client_read_bytes (source->client, data, EBML_SLICE_SIZE);
            if (bytes <= 0)
            {
                ebml_wrote (ebml_source_state->ebml, 0);
                return NULL;
            }
            format->read_bytes += bytes;
            ret = ebml_wrote (ebml_source_state->ebml, bytes);
            if (ret != bytes) {
221
                ICECAST_LOG_ERROR("Problem processing stream");
222 223 224 225 226 227 228
                source->running = 0;
                return NULL;
            }
        }
    }
}

229 230
/* Initialize client state.
 */
231
static int ebml_create_client_data(source_t *source, client_t *client)
232
{
233
    ebml_client_data_t *ebml_client_data;
234 235
    ebml_source_state_t *ebml_source_state = source->format->_state;

236 237
    if (!ebml_source_state->header)
        return -1;
238

239 240 241
    ebml_client_data = calloc(1, sizeof(ebml_client_data_t));
    if (!ebml_client_data)
        return -1;
242

243 244 245 246 247
    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;
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
}


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)
{
264
    ICECAST_LOG_WARN("Write to dump file failed, disabling");
265 266 267 268 269 270 271 272 273 274 275 276 277
    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,
278
                    ebml_source_state->header->len,
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
                    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));

310 311
    ebml->output_state = EBML_STATE_READING_HEADER;

312 313 314 315 316 317 318 319 320 321 322 323
    ebml->header = calloc(1, EBML_HEADER_MAX_SIZE);
    ebml->buffer = calloc(1, EBML_SLICE_SIZE * 4);
    ebml->input_buffer = calloc(1, EBML_SLICE_SIZE);

    ebml->cluster_id = "\x1F\x43\xB6\x75";

    ebml->cluster_start = -2;

    return ebml;

}

324 325 326
/* Return the size of a buffer needed to store the next
 * chunk that ebml_read can yield.
 */
327 328 329 330 331
static int ebml_read_space(ebml_t *ebml)
{

    int read_space;

332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
    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 {
                /* return most of what we have, but leave enough unread
                 * to detect the next cluster.
                 */
                read_space = ebml->position - 4;
            }
355

356
            return read_space;
357
    }
358 359 360
    
    ICECAST_LOG_ERROR("EBML: Invalid parser read state");
    return 0;
361 362
}

363
/* Return a chunk of the EBML/MKV/WebM stream.
364
 * The header will be buffered until it can be returned as one chunk.
365 366
 * A cluster element's opening tag will always start a new chunk.
 */
367 368 369 370 371 372
static int ebml_read(ebml_t *ebml, char *buffer, int len)
{

    int read_space;
    int to_read;

373
    if (len < 1) {
374
        return 0;
375
    }
376

377 378 379 380 381 382 383
    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;
384

385 386 387 388 389
                if (read_space >= len) {
                    to_read = len;
                } else {
                    to_read = read_space;
                }
390

391 392
                memcpy(buffer, ebml->header, to_read);
                ebml->header_read_position += to_read;
393

394 395 396 397 398 399 400 401 402 403 404
                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:
405
        
406 407 408 409 410 411
            if (ebml->cluster_start > 0) {
                /* return up until just before a new cluster starts */
                read_space = ebml->cluster_start;
            } else {
                read_space = ebml->position - 4;
            }
412

413 414 415
            if (read_space < 1) {
                return 0;
            }
416

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

423 424 425 426 427
            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;
428

429 430
            if (ebml->cluster_start > 0) {
                ebml->cluster_start -= to_read;
431
            }
432 433
        
            break;
434 435 436 437 438 439
    }

    return to_read;

}

440 441 442
/* Return nonzero if the chunk last returned by ebml_read was
 * a sync point.
 */
443 444 445
static int ebml_last_was_sync(ebml_t *ebml)
{

446 447 448 449
    if (ebml->cluster_start == 0) {
        /* The data buffer now starts with a cluster, so the chunk
         * just removed from it was (probably) not a cluster's start.
         */
450 451 452
        ebml->cluster_start -= 1;
        return 0;
    }
453

454 455 456 457
    if (ebml->cluster_start == -1) {
        /* Above logic triggered for the previous chunk, therefore the
         * chunk just removed was a cluster's start.
         */
458 459 460
        ebml->cluster_start -= 1;
        return 1;
    }
461

462 463 464 465 466 467 468
    return 0;

}

static char *ebml_write_buffer(ebml_t *ebml, int len)
{

469
    return (char *) ebml->input_buffer;
470 471 472

}

473 474
/* Process data that has been written to the EBML parser's input buffer.
 */
475 476 477 478 479
static int ebml_wrote(ebml_t *ebml, int len)
{

    int b;

480 481 482
    if (ebml->header_size == 0) {
        /* Still reading header */
        if ((ebml->header_position + len) > EBML_HEADER_MAX_SIZE) {
483
            ICECAST_LOG_ERROR("EBML Header too large, failing");
484 485
            return -1;
        }
486

487 488
/*
        ICECAST_LOG_DEBUG("EBML: Adding to header, ofset is %d size is %d adding %d",
489 490
                          ebml->header_size, ebml->header_position, len);
*/
491

492 493
        memcpy(ebml->header + ebml->header_position, ebml->input_buffer, len);
        ebml->header_position += len;
494 495
    } else {
        /* Header's already been determined, read into data buffer */
496 497
        memcpy(ebml->buffer + ebml->position, ebml->input_buffer, len);
    }
498

499 500
    for (b = 0; b < len - 4; b++)
    {
501 502 503 504 505 506
        /* Scan for cluster start marker.
         * False positives are possible, but unlikely, and only
         * permanently corrupt a stream if they occur while scanning
         * the initial header. Else, a client can reconnect in a few
         * seconds and get a real sync point.
         */
507 508
        if (!memcmp(ebml->input_buffer + b, ebml->cluster_id, 4))
        {
509 510 511
/*
            ICECAST_LOG_DEBUG("EBML: found cluster");
*/
512

513 514
            if (ebml->header_size == 0)
            {
515
                /* We were looking for the header end; now we've found it */
516
                ebml->header_size = ebml->header_position - len + b;
517 518
                
                /* Shift data after the header into the data buffer */
519 520
                memcpy(ebml->buffer, ebml->input_buffer + b, len - b);
                ebml->position = len - b;
521 522
                
                /* Mark the start of the data as the first sync point */
523 524
                ebml->cluster_start = -1;
                return len;
525 526
            } else {
                /* We've located a sync point in the data stream */
527 528 529 530
                ebml->cluster_start = ebml->position + b;
            }
        }
    }
531

532 533 534 535 536
    ebml->position += len;

    return len;

}