format_ogg.c 15.5 KB
Newer Older
1 2 3 4 5
/* Icecast
 *
 * This program is distributed under the GNU General Public License, version 2.
 * A copy of this license is included with this source.
 *
6
 * Copyright 2000-2004, Jack Moffitt <jack@xiph.org,
7 8 9 10
 *                      Michael Smith <msmith@xiph.org>,
 *                      oddsock <oddsock@xiph.org>,
 *                      Karl Heyes <karl@xiph.org>
 *                      and others (see AUTHORS for details).
11
 * Copyright 2014-2018, Philipp "ph3-der-loewe" Schafft <lion@lion.leolix.org>,
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
 */

/* format_ogg.c
 *
 * format plugin for Ogg
 *
 */

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

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

#include <ogg/ogg.h>

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

#include "stats.h"
35
#include "playlist.h"
36 37 38 39 40 41
#include "format.h"
#include "format_ogg.h"
#include "format_vorbis.h"
#ifdef HAVE_THEORA
#include "format_theora.h"
#endif
42 43 44
#ifdef HAVE_SPEEX
#include "format_speex.h"
#endif
giles's avatar
giles committed
45
#include "format_opus.h"
46 47
#include "format_midi.h"
#include "format_flac.h"
48 49
#include "format_kate.h"
#include "format_skeleton.h"
50 51 52 53

#ifdef _WIN32
#define snprintf _snprintf
#endif
54 55 56 57 58 59

#define CATMODULE "format-ogg"
#include "logging.h"

struct _ogg_state_tag;

60 61 62
static void format_ogg_free_plugin(format_plugin_t *plugin);
static int create_ogg_client_data(source_t *source, client_t *client);
static void free_ogg_client_data(client_t *client);
63

64
static void write_ogg_to_file(source_t *source, refbuf_t *refbuf);
65 66
static refbuf_t *ogg_get_buffer(source_t *source);
static int write_buf_to_client(client_t *client);
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96


struct ogg_client
{
    refbuf_t *headers;
    refbuf_t *header_page;
    unsigned pos;
    int headers_sent;
};


refbuf_t *make_refbuf_with_page (ogg_page *page)
{
    refbuf_t *refbuf = refbuf_new (page->header_len + page->body_len);

    memcpy (refbuf->data, page->header, page->header_len);
    memcpy (refbuf->data+page->header_len, page->body, page->body_len);
    return refbuf;
}


/* routine for taking the provided page (should be a header page) and
 * placing it on the collection of header pages
 */
void format_ogg_attach_header (ogg_state_t *ogg_info, ogg_page *page)
{
    refbuf_t *refbuf = make_refbuf_with_page (page);

    if (ogg_page_bos (page))
    {
97
        ICECAST_LOG_DEBUG("attaching BOS page");
98 99 100 101 102 103 104
        if (*ogg_info->bos_end == NULL)
            ogg_info->header_pages_tail = refbuf;
        refbuf->next = *ogg_info->bos_end;
        *ogg_info->bos_end = refbuf;
        ogg_info->bos_end = &refbuf->next;
        return;
    }
105
    ICECAST_LOG_DEBUG("attaching header page");
106 107 108 109 110 111 112 113 114
    if (ogg_info->header_pages_tail)
        ogg_info->header_pages_tail->next = refbuf;
    ogg_info->header_pages_tail = refbuf;

    if (ogg_info->header_pages == NULL)
        ogg_info->header_pages = refbuf;
}


115
void format_ogg_free_headers(ogg_state_t *ogg_info)
116 117 118 119
{
    refbuf_t *header;

    /* release the header pages first */
120
    ICECAST_LOG_DEBUG("releasing header pages");
121 122 123 124 125
    header = ogg_info->header_pages;
    while (header)
    {
        refbuf_t *to_release = header;
        header = header->next;
126
        refbuf_release(to_release);
127 128 129 130 131 132 133 134
    }
    ogg_info->header_pages = NULL;
    ogg_info->header_pages_tail = NULL;
    ogg_info->bos_end = &ogg_info->header_pages;
}


/* release the memory used for the codec and header pages from the module */
135
static void free_ogg_codecs(ogg_state_t *ogg_info)
136 137 138 139 140 141
{
    ogg_codec_t *codec;

    if (ogg_info == NULL)
        return;

142
    format_ogg_free_headers(ogg_info);
143 144 145

    /* now free the codecs */
    codec = ogg_info->codecs;
146
    ICECAST_LOG_DEBUG("freeing codecs");
147 148 149
    while (codec)
    {
        ogg_codec_t *next = codec->next;
150
        if (codec->possible_start)
151 152
            refbuf_release(codec->possible_start);
        codec->codec_free(ogg_info, codec);
153 154 155 156 157
        codec = next;
    }
    ogg_info->codecs = NULL;
    ogg_info->current = NULL;
    ogg_info->bos_completed = 0;
158
    ogg_info->codec_count = 0;
159 160 161
}


162
int format_ogg_get_plugin(source_t *source)
163 164
{
    format_plugin_t *plugin;
165
    ogg_state_t *state = calloc(1, sizeof(ogg_state_t));
166

167
    plugin = (format_plugin_t *) calloc(1, sizeof(format_plugin_t));
168 169 170 171 172 173 174 175

    plugin->type = FORMAT_TYPE_OGG;
    plugin->get_buffer = ogg_get_buffer;
    plugin->write_buf_to_client = write_buf_to_client;
    plugin->write_buf_to_file = write_ogg_to_file;
    plugin->create_client_data = create_ogg_client_data;
    plugin->free_plugin = format_ogg_free_plugin;
    plugin->set_tag = NULL;
Karl Heyes's avatar
Karl Heyes committed
176 177 178
    if (strcmp (httpp_getvar (source->parser, "content-type"), "application/x-ogg") == 0)
        httpp_setvar (source->parser, "content-type", "application/ogg");
    plugin->contenttype = httpp_getvar (source->parser, "content-type");
179 180

    ogg_sync_init (&state->oy);
181
    vorbis_comment_init(&plugin->vc);
182 183 184 185 186 187 188 189 190 191

    plugin->_state = state;
    source->format = plugin;
    state->mount = source->mount;
    state->bos_end = &state->header_pages;

    return 0;
}


192
static void format_ogg_free_plugin (format_plugin_t *plugin)
193 194 195 196 197 198 199
{
    ogg_state_t *state = plugin->_state;

    /* free memory associated with this plugin instance */
    free_ogg_codecs (state);

    ogg_sync_clear (&state->oy);
200

201 202
    free (state);

203 204
    vorbis_comment_clear(&plugin->vc);

205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
    free (plugin);
}


/* a new BOS page has been seen so check which codec it is */
static int process_initial_page (format_plugin_t *plugin, ogg_page *page)
{
    ogg_state_t *ogg_info = plugin->_state;
    ogg_codec_t *codec;

    if (ogg_info->bos_completed)
    {
        ogg_info->bitrate = 0;
        ogg_info->codec_sync = NULL;
        /* need to zap old list of codecs when next group of BOS pages appear */
220
        free_ogg_codecs(ogg_info);
221 222 223
    }
    do
    {
224 225
        if (ogg_info->codec_count > 10)
        {
226
            ICECAST_LOG_ERROR("many codecs in stream, playing safe, dropping source");
227 228 229
            ogg_info->error = 1;
            return -1;
        }
230
        codec = initial_vorbis_page(plugin, page);
231 232 233 234 235 236 237
        if (codec)
            break;
#ifdef HAVE_THEORA
        codec = initial_theora_page (plugin, page);
        if (codec)
            break;
#endif
238
        codec = initial_midi_page(plugin, page);
239 240
        if (codec)
            break;
241
        codec = initial_flac_page(plugin, page);
242 243 244 245 246 247 248
        if (codec)
            break;
#ifdef HAVE_SPEEX
        codec = initial_speex_page (plugin, page);
        if (codec)
            break;
#endif
249
        codec = initial_kate_page(plugin, page);
250 251
        if (codec)
            break;
252
        codec = initial_skeleton_page(plugin, page);
giles's avatar
giles committed
253 254
        if (codec)
            break;
255
        codec = initial_opus_page(plugin, page);
256 257
        if (codec)
            break;
258

259
        /* any others */
260
        ICECAST_LOG_ERROR("Seen BOS page with unknown type");
261
        ogg_info->error = 1;
262 263 264 265 266 267 268 269
        return -1;
    } while (0);

    if (codec)
    {
        /* add codec to list */
        codec->next = ogg_info->codecs;
        ogg_info->codecs = codec;
270
        ogg_info->codec_count++;
271 272 273 274 275 276 277 278 279 280
    }

    return 0;
}


/* This is called when there has been a change in the metadata. Usually
 * artist and title are provided separately so here we update the stats
 * and write log entry if required.
 */
281
static void update_comments(source_t *source)
282 283
{
    ogg_state_t *ogg_info = source->format->_state;
284 285
    char *title = vorbis_comment_query(&source->format->vc, "TITLE", 0);
    char *artist = vorbis_comment_query(&source->format->vc, "ARTIST", 0);
286
    char *metadata = NULL;
Karl Heyes's avatar
Karl Heyes committed
287
    unsigned int len = 1; /* space for the nul byte at least */
288 289
    ogg_codec_t *codec;
    char codec_names [100] = "";
290

291
    if (artist)
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
    {
        if (title)
        {
            len += strlen(artist) + strlen(title) + 3;
            metadata = calloc (1, len);
            snprintf (metadata, len, "%s - %s", artist, title);
        }
        else
        {
            len += strlen(artist);
            metadata = calloc (1, len);
            snprintf (metadata, len, "%s", artist);
        }
    }
    else
    {
        if (title)
        {
            len += strlen (title);
            metadata = calloc (1, len);
            snprintf (metadata, len, "%s", title);
        }
    }
    if (metadata)
    {
        logging_playlist (source->mount, metadata, source->listeners);
        free (metadata);
    }
    stats_event (source->mount, "artist", artist);
    stats_event (source->mount, "title", title);
322

323 324
    playlist_push_track(source->history, &source->format->vc);

325 326 327 328 329 330 331 332
    codec = ogg_info->codecs;
    while (codec)
    {
        if (codec->name)
        {
            int len = strlen (codec_names);
            int remaining = sizeof (codec_names) - len;
            char *where = codec_names + len;
333
            char *separator = "/";
334 335 336 337 338 339 340
            if (len == 0)
                separator = "";
            snprintf (where, remaining, "%s%s", separator, codec->name);
        }
        codec = codec->next;
    }
    stats_event (source->mount, "subtype", codec_names);
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
    yp_touch (source->mount);
}


/* called when preparing a refbuf with audio data to be passed
 * back for queueing
 */
static refbuf_t *complete_buffer (source_t *source, refbuf_t *refbuf)
{
    ogg_state_t *ogg_info = source->format->_state;
    refbuf_t *header = ogg_info->header_pages;

    while (header)
    {
        refbuf_addref (header);
        header = header->next;
    }
    refbuf->associated = ogg_info->header_pages;

    if (ogg_info->log_metadata)
    {
        update_comments (source);
        ogg_info->log_metadata = 0;
    }
    /* listeners can start anywhere unless the codecs themselves are
     * marking starting points */
    if (ogg_info->codec_sync == NULL)
        refbuf->sync_point = 1;
    return refbuf;
}


/* process the incoming page. this requires searching through the
 * currently known codecs that have been seen in the stream
 */
376
static refbuf_t *process_ogg_page(ogg_state_t *ogg_info, ogg_page *page, format_plugin_t *plugin)
377 378 379 380 381 382 383 384 385
{
    ogg_codec_t *codec = ogg_info->codecs;
    refbuf_t *refbuf = NULL;

    while (codec)
    {
        if (ogg_page_serialno (page) == codec->os.serialno)
        {
            if (codec->process_page)
386
                refbuf = codec->process_page(ogg_info, codec, page, plugin);
387 388 389 390 391 392 393 394 395 396 397 398 399 400
            break;
        }

        codec = codec->next;
    }
    ogg_info->current = codec;
    return refbuf;
}


/* main plugin handler for getting a buffer for the queue. In here we
 * just add an incoming page to the codecs and process it until either
 * more data is needed or we prodice a buffer for the queue.
 */
401
static refbuf_t *ogg_get_buffer(source_t *source)
402 403
{
    ogg_state_t *ogg_info = source->format->_state;
404
    format_plugin_t *format = source->format;
405
    char *data = NULL;
406
    ssize_t bytes = 0;
407 408 409 410 411 412

    while (1)
    {
        while (1)
        {
            ogg_page page;
413
            refbuf_t *refbuf = NULL;
414 415 416 417 418
            ogg_codec_t *codec = ogg_info->current;

            /* if a codec has just been given a page then process it */
            if (codec && codec->process)
            {
419
                refbuf = codec->process (ogg_info, codec, source->format);
420 421 422 423 424 425 426 427 428 429 430 431
                if (refbuf)
                    return complete_buffer (source, refbuf);

                ogg_info->current = NULL;
            }

            if (ogg_sync_pageout (&ogg_info->oy, &page) > 0)
            {
                if (ogg_page_bos (&page))
                {
                    process_initial_page (source->format, &page);
                }
432 433 434
                else
                {
                    ogg_info->bos_completed = 1;
435
                    refbuf = process_ogg_page (ogg_info, &page, source->format);
436
                }
437 438
                if (ogg_info->error)
                {
439
                    ICECAST_LOG_ERROR("Problem processing stream");
440 441 442 443 444 445 446 447 448 449 450 451 452
                    source->running = 0;
                    return NULL;
                }
                if (refbuf)
                    return complete_buffer (source, refbuf);
                continue;
            }
            /* need more stream data */
            break;
        }
        /* we need more data to continue getting pages */
        data = ogg_sync_buffer (&ogg_info->oy, 4096);

453
        bytes = client_body_read(source->client, data, 4096);
454
        if (bytes <= 0)
455 456 457 458
        {
            ogg_sync_wrote (&ogg_info->oy, 0);
            return NULL;
        }
459
        format->read_bytes += bytes;
460 461 462 463 464
        ogg_sync_wrote (&ogg_info->oy, bytes);
    }
}


465
static int create_ogg_client_data (source_t *source, client_t *client)
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
{
    struct ogg_client *client_data = calloc (1, sizeof (struct ogg_client));
    int ret = -1;

    if (client_data)
    {
        client_data->headers_sent = 1;
        client->format_data = client_data;
        client->free_client_data = free_ogg_client_data;
        ret = 0;
    }
    return ret;
}


static void free_ogg_client_data (client_t *client)
{
    free (client->format_data);
    client->format_data = NULL;
}


/* send out the header pages. These are for all codecs but are
 * in the order for the stream, ie BOS pages first
 */
static int send_ogg_headers (client_t *client, refbuf_t *headers)
{
    struct ogg_client *client_data = client->format_data;
    refbuf_t *refbuf;
    int written = 0;

    if (client_data->headers_sent)
    {
        client_data->header_page = headers;
        client_data->pos = 0;
        client_data->headers_sent = 0;
    }
    refbuf = client_data->header_page;
    while (refbuf)
    {
        char *data = refbuf->data + client_data->pos;
        unsigned len = refbuf->len - client_data->pos;
        int ret;

510
        ret = client_send_bytes(client, data, len);
511
        if (ret > 0)
512 513
            written += ret;
        if (ret < (int) len)
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
            return written ? written : -1;
        client_data->pos += ret;
        if (client_data->pos == refbuf->len)
        {
            refbuf = refbuf->next;
            client_data->header_page = refbuf;
            client_data->pos = 0;
        }
    }
    client_data->headers_sent = 1;
    client_data->headers = headers;
    return written;
}


/* main client write routine for sending ogg data. Each refbuf has a
 * single page so we only need to determine if there are new headers
 */
532
static int write_buf_to_client(client_t *client)
533 534
{
    refbuf_t *refbuf = client->refbuf;
535 536
    char *buf = refbuf->data + client->pos;
    unsigned len = refbuf->len - client->pos;
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
    struct ogg_client *client_data = client->format_data;
    int ret, written = 0;

    do
    {
        if (client_data->headers != refbuf->associated)
        {
            ret = send_ogg_headers (client, refbuf->associated);
            if (client_data->headers_sent == 0)
                break;
            written += ret;
        }
        ret = client_send_bytes (client, buf, len);

        if (ret > 0)
            client->pos += ret;

        if (ret < (int)len)
            break;
        written += ret;
        /* we have now written the page(s) */
        ret = 0;
    } while (0);

    if (ret > 0)
       written += ret;
    return written;
}


567
static int write_ogg_data (source_t *source, refbuf_t *refbuf)
568 569 570 571 572
{
    int ret = 1;

    if (fwrite (refbuf->data, 1, refbuf->len, source->dumpfile) != refbuf->len)
    {
573
        ICECAST_LOG_WARN("Write to dump file failed, disabling");
574 575 576 577 578 579 580 581
        fclose (source->dumpfile);
        source->dumpfile = NULL;
        ret = 0;
    }
    return ret;
}


582
static void write_ogg_to_file (source_t *source, refbuf_t *refbuf)
583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
{
    ogg_state_t *ogg_info = source->format->_state;

    if (ogg_info->file_headers != refbuf->associated)
    {
        refbuf_t *header = refbuf->associated;
        while (header)
        {
            if (write_ogg_data (source, header) == 0)
                return;
            header = header->next;
        }
        ogg_info->file_headers = refbuf->associated;
    }
    write_ogg_data (source, refbuf);
}