format_ebml.c 14.1 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

typedef enum ebml_chunk_type {
    EBML_CHUNK_HEADER = 0,
    EBML_CHUNK_CLUSTER_START,
    EBML_CHUNK_CLUSTER_CONTINUE
} ebml_chunk_type;

54 55 56 57 58 59 60 61 62 63 64
typedef struct ebml_client_data_st ebml_client_data_t;

struct ebml_client_data_st {

    refbuf_t *header;
    int header_pos;

};

struct ebml_st {

65 66
    ebml_read_mode output_state;
    
67 68
    char *cluster_id;
    int cluster_start;
69

70 71 72
    int position;
    unsigned char *input_buffer;
    unsigned char *buffer;
73
    
74 75 76 77 78 79 80
    int header_size;
    int header_position;
    int header_read_position;
    unsigned char *header;

};

81 82 83 84 85 86
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);
87 88 89 90

static ebml_t *ebml_create();
static void ebml_destroy(ebml_t *ebml);
static int ebml_read_space(ebml_t *ebml);
91
static int ebml_read(ebml_t *ebml, char *buffer, int len, ebml_chunk_type *chunk_type);
92 93 94
static char *ebml_write_buffer(ebml_t *ebml, int len);
static int ebml_wrote(ebml_t *ebml, int len);

95
int format_ebml_get_plugin(source_t *source)
96 97 98 99 100 101 102 103 104 105 106 107 108
{

    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;

109
    plugin->contenttype = httpp_getvar(source->parser, "content-type");
110 111

    plugin->_state = ebml_source_state;
112
    vorbis_comment_init(&plugin->vc);
113 114 115
    source->format = plugin;

    ebml_source_state->ebml = ebml_create();
116
    
117 118 119
    return 0;
}

120
static void ebml_free_plugin(format_plugin_t *plugin)
121 122 123 124
{

    ebml_source_state_t *ebml_source_state = plugin->_state;

125
    refbuf_release(ebml_source_state->header);
126
    ebml_destroy(ebml_source_state->ebml);
127
    free(ebml_source_state);
128
    vorbis_comment_clear(&plugin->vc);
129
    free(plugin);
130 131
}

132 133
/* Write to a client from the header buffer.
 */
134
static int send_ebml_header(client_t *client)
135 136 137 138 139 140
{

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

141
    if (ebml_client_data->header->len - ebml_client_data->header_pos < len)
142 143 144
    {
        len = ebml_client_data->header->len - ebml_client_data->header_pos;
    }
145
    ret = client_send_bytes (client,
146 147 148 149 150 151 152 153 154 155 156 157
                             ebml_client_data->header->data + ebml_client_data->header_pos,
                             len);

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

    return ret;

}

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

}

179 180
/* Return a refbuf to add to the queue.
 */
181
static refbuf_t *ebml_get_buffer(source_t *source)
182 183 184 185 186 187
{

    ebml_source_state_t *ebml_source_state = source->format->_state;
    format_plugin_t *format = source->format;
    char *data = NULL;
    int bytes = 0;
188
    ebml_chunk_type chunk_type;
189 190 191 192 193 194 195 196
    refbuf_t *refbuf;
    int ret;

    while (1)
    {

        if ((bytes = ebml_read_space(ebml_source_state->ebml)) > 0)
        {
197
            /* A chunk is available for reading */
198
            refbuf = refbuf_new(bytes);
199
            ebml_read(ebml_source_state->ebml, refbuf->data, bytes, &chunk_type);
200 201 202

            if (ebml_source_state->header == NULL)
            {
203
                /* Capture header before adding clusters to the queue */
204 205 206 207
                ebml_source_state->header = refbuf;
                continue;
            }

208 209 210 211 212
/*            ICECAST_LOG_DEBUG("EBML: generated refbuf, size %i : %hhi %hhi %hhi",
 *                            bytes, refbuf->data[0], refbuf->data[1], refbuf->data[2]);
 */
                              
            if (chunk_type == EBML_CHUNK_CLUSTER_START)
213 214
            {
                refbuf->sync_point = 1;
215
/*                ICECAST_LOG_DEBUG("EBML: ^ was sync point"); */
216 217 218 219 220 221
            }
            return refbuf;

        }
        else
        {
222
            /* Feed more bytes into the parser */
223 224 225 226 227 228 229 230 231 232
            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) {
233
                ICECAST_LOG_ERROR("Problem processing stream");
234 235 236 237 238 239 240
                source->running = 0;
                return NULL;
            }
        }
    }
}

241 242
/* Initialize client state.
 */
243
static int ebml_create_client_data(source_t *source, client_t *client)
244
{
245
    ebml_client_data_t *ebml_client_data;
246 247
    ebml_source_state_t *ebml_source_state = source->format->_state;

248 249
    if (!ebml_source_state->header)
        return -1;
250

251 252 253
    ebml_client_data = calloc(1, sizeof(ebml_client_data_t));
    if (!ebml_client_data)
        return -1;
254

255 256 257 258 259
    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;
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
}


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)
{
276
    ICECAST_LOG_WARN("Write to dump file failed, disabling");
277 278 279 280 281 282 283 284 285 286 287 288 289
    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,
290
                    ebml_source_state->header->len,
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
                    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));

322 323
    ebml->output_state = EBML_STATE_READING_HEADER;

324 325 326 327 328 329
    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";

330
    ebml->cluster_start = -1;
331 332 333 334 335

    return ebml;

}

336 337 338
/* Return the size of a buffer needed to store the next
 * chunk that ebml_read can yield.
 */
339 340 341 342 343
static int ebml_read_space(ebml_t *ebml)
{

    int read_space;

344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
    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 {
362 363
                /* return what we have */
                read_space = ebml->position;
364
            }
365

366
            return read_space;
367
    }
368 369 370
    
    ICECAST_LOG_ERROR("EBML: Invalid parser read state");
    return 0;
371 372
}

373
/* Return a chunk of the EBML/MKV/WebM stream.
374
 * The header will be buffered until it can be returned as one chunk.
375
 * A cluster element's opening tag will always start a new chunk.
376 377 378
 * 
 * chunk_type will be set to indicate if the chunk is the header,
 * the start of a cluster, or continuing the current cluster.
379
 */
380
static int ebml_read(ebml_t *ebml, char *buffer, int len, ebml_chunk_type *chunk_type)
381 382 383 384
{

    int read_space;
    int to_read;
385 386
    
    *chunk_type = EBML_CHUNK_HEADER;
387

388
    if (len < 1) {
389
        return 0;
390
    }
391

392 393 394 395 396 397 398
    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;
399

400 401 402 403 404
                if (read_space >= len) {
                    to_read = len;
                } else {
                    to_read = read_space;
                }
405

406 407
                memcpy(buffer, ebml->header, to_read);
                ebml->header_read_position += to_read;
408 409 410
                
                *chunk_type = EBML_CHUNK_HEADER;
                
411 412 413 414 415 416 417 418 419 420 421
                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:
422
        
423 424 425 426 427 428 429 430 431 432
            *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) {
433 434 435
                /* return up until just before a new cluster starts */
                read_space = ebml->cluster_start;
            }
436

437 438 439
            if (read_space < 1) {
                return 0;
            }
440

441
            if (read_space >= len ) {
442
                to_read = len;
443
            } else {
444
                to_read = read_space;
445
            }
446

447 448 449 450 451
            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;
452

453 454
            if (ebml->cluster_start > 0) {
                ebml->cluster_start -= to_read;
455
            }
456 457
        
            break;
458 459 460 461 462 463 464 465 466
    }

    return to_read;

}

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

467
    return (char *) ebml->input_buffer;
468 469 470

}

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

    int b;

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

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

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

497
    for (b = 0; b <= len - 4; b++)
498
    {
499 500 501 502 503 504
        /* 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.
         */
505 506
        if (!memcmp(ebml->input_buffer + b, ebml->cluster_id, 4))
        {
507 508 509
/*
            ICECAST_LOG_DEBUG("EBML: found cluster");
*/
510

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

530 531 532 533 534
    ebml->position += len;

    return len;

}