format_vorbis.c 17 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

/* Ogg codec handler for vorbis streams */
Jack Moffitt's avatar
Jack Moffitt committed
16

17 18 19 20
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

Jack Moffitt's avatar
Jack Moffitt committed
21 22 23
#include <stdlib.h>
#include <ogg/ogg.h>
#include <vorbis/codec.h>
24
#include <memory.h>
25
#include <string.h>
Jack Moffitt's avatar
Jack Moffitt committed
26 27

#include "refbuf.h"
28 29
#include "source.h"
#include "client.h"
Jack Moffitt's avatar
Jack Moffitt committed
30

31
#include "format_ogg.h"
Michael Smith's avatar
Michael Smith committed
32
#include "stats.h"
Jack Moffitt's avatar
Jack Moffitt committed
33 34
#include "format.h"

35 36 37
#define CATMODULE "format-vorbis"
#include "logging.h"

Michael Smith's avatar
Michael Smith committed
38

39
typedef struct vorbis_codec_tag
Jack Moffitt's avatar
Jack Moffitt committed
40
{
41
    vorbis_info    vi;
42

43 44
    int rebuild_comment;
    int stream_notify;
45
    int initial_audio_page;
Jack Moffitt's avatar
Jack Moffitt committed
46

47 48 49 50 51 52 53 54 55 56 57 58
    ogg_stream_state    new_os;
    int                 page_samples_trigger;
    ogg_int64_t         prev_granulepos;
    ogg_packet          *prev_packet;
    ogg_int64_t         granulepos;
    ogg_int64_t         initial_page_granulepos;
    ogg_int64_t         samples_in_page;
    int                 prev_window;
    int                 initial_audio_packet;

    ogg_page    bos_page;
    ogg_packet  *header[3];
59 60
    ogg_int64_t prev_page_samples;

61
    int (*process_packet)(ogg_state_t *ogg_info, ogg_codec_t *codec, format_plugin_t *plugin);
62
    refbuf_t *(*get_buffer_page)(ogg_state_t *ogg_info, ogg_codec_t *codec);
63

64
} vorbis_codec_t;
65

66
static int process_vorbis_headers (ogg_state_t *ogg_info, ogg_codec_t *codec, format_plugin_t *plugin);
67
static refbuf_t *process_vorbis_page (ogg_state_t *ogg_info,
68 69
                ogg_codec_t *codec, ogg_page *page, format_plugin_t *plugin);
static refbuf_t *process_vorbis (ogg_state_t *ogg_info, ogg_codec_t *codec, format_plugin_t *plugin);
70
static void vorbis_set_tag (format_plugin_t *plugin, const char *tag, const char *value, const char *charset);
Jack Moffitt's avatar
Jack Moffitt committed
71

72

73
static void free_ogg_packet (ogg_packet *packet)
Jack Moffitt's avatar
Jack Moffitt committed
74
{
75 76 77 78 79 80
    if (packet)
    {
        free (packet->packet);
        free (packet);
    }
}
Jack Moffitt's avatar
Jack Moffitt committed
81

82

83 84 85 86
static void vorbis_codec_free (ogg_state_t *ogg_info, ogg_codec_t *codec)
{
    vorbis_codec_t *vorbis = codec->specific;

87
    ICECAST_LOG_DEBUG("freeing vorbis codec");
88 89 90
    stats_event (ogg_info->mount, "audio_bitrate", NULL);
    stats_event (ogg_info->mount, "audio_channels", NULL);
    stats_event (ogg_info->mount, "audio_samplerate", NULL);
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
    vorbis_info_clear (&vorbis->vi);
    ogg_stream_clear (&codec->os);
    ogg_stream_clear (&vorbis->new_os);
    free_ogg_packet (vorbis->header[0]);
    free_ogg_packet (vorbis->header[1]);
    free_ogg_packet (vorbis->header[2]);
    free_ogg_packet (vorbis->prev_packet);
    free (vorbis->bos_page.header);
    free (vorbis);
    free (codec);
}


static ogg_packet *copy_ogg_packet (ogg_packet *packet)
{
    ogg_packet *next;
    do
    {
        next = malloc (sizeof (ogg_packet));
        if (next == NULL)
            break;
        memcpy (next, packet, sizeof (ogg_packet));
        next->packet = malloc (next->bytes);
        if (next->packet == NULL)
            break;
        memcpy (next->packet, packet->packet, next->bytes);
        return next;
    } while (0);
Jack Moffitt's avatar
Jack Moffitt committed
119

120 121 122 123
    if (next)
        free (next);
    return NULL;
}
Jack Moffitt's avatar
Jack Moffitt committed
124 125


126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
static void add_audio_packet (vorbis_codec_t *source_vorbis, ogg_packet *packet)
{
    if (source_vorbis->initial_audio_packet)
    {
        packet->granulepos = 0;
        source_vorbis->initial_audio_packet = 0;
    }
    else
    {
        source_vorbis->samples_in_page +=
            (packet->granulepos - source_vorbis->prev_granulepos);
        source_vorbis->prev_granulepos = packet->granulepos;
        source_vorbis->granulepos += source_vorbis->prev_window;
    }
    ogg_stream_packetin (&source_vorbis->new_os, packet);
Jack Moffitt's avatar
Jack Moffitt committed
141 142
}

143 144

static refbuf_t *get_buffer_audio (ogg_state_t *ogg_info, ogg_codec_t *codec)
145
{
146 147 148 149
    refbuf_t *refbuf = NULL;
    ogg_page page;
    vorbis_codec_t *source_vorbis = codec->specific;
    int (*get_ogg_page)(ogg_stream_state*, ogg_page *) = ogg_stream_pageout;
150

151 152
    if (source_vorbis->samples_in_page > source_vorbis->page_samples_trigger)
        get_ogg_page = ogg_stream_flush;
153

154
    if (get_ogg_page (&source_vorbis->new_os, &page) > 0)
155
    {
156 157 158 159 160
        /* squeeze a page copy into a buffer */
        source_vorbis->samples_in_page -= (ogg_page_granulepos (&page) - source_vorbis->prev_page_samples);
        source_vorbis->prev_page_samples = ogg_page_granulepos (&page);

        refbuf = make_refbuf_with_page (&page);
161
    }
162 163 164
    return refbuf;
}

165

166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
static refbuf_t *get_buffer_header (ogg_state_t *ogg_info, ogg_codec_t *codec)
{
    int headers_flushed = 0;
    ogg_page page;
    vorbis_codec_t *source_vorbis = codec->specific;

    while (ogg_stream_flush (&source_vorbis->new_os, &page) > 0)
    {
        format_ogg_attach_header (ogg_info, &page);
        headers_flushed = 1;
    }
    if (headers_flushed)
    {
        source_vorbis->get_buffer_page = get_buffer_audio;
    }
    return NULL;
182 183
}

184

185
static refbuf_t *get_buffer_finished(ogg_state_t *ogg_info, ogg_codec_t *codec)
Jack Moffitt's avatar
Jack Moffitt committed
186
{
187 188 189 190 191
    vorbis_codec_t *source_vorbis = codec->specific;
    ogg_page page;
    refbuf_t *refbuf;

    if (ogg_stream_flush (&source_vorbis->new_os, &page) > 0)
192
    {
193 194 195 196
        source_vorbis->samples_in_page -= (ogg_page_granulepos (&page) - source_vorbis->prev_page_samples);
        source_vorbis->prev_page_samples = ogg_page_granulepos (&page);

        refbuf = make_refbuf_with_page (&page);
197
        ICECAST_LOG_DEBUG("flushing page");
198
        return refbuf;
199
    }
200 201 202 203 204
    ogg_stream_clear (&source_vorbis->new_os);
    ogg_stream_init (&source_vorbis->new_os, rand());

    format_ogg_free_headers (ogg_info);
    source_vorbis->get_buffer_page = NULL;
205 206 207 208 209
    if (source_vorbis->prev_packet)
        source_vorbis->process_packet = process_vorbis_headers;
    else
        source_vorbis->process_packet = NULL;

210 211 212 213 214 215 216 217 218 219 220
    if (source_vorbis->initial_audio_packet == 0)
        source_vorbis->prev_window = 0;

    return NULL;
}


/* push last packet into stream marked with eos */
static void initiate_flush (vorbis_codec_t *source_vorbis)
{
    if (source_vorbis->prev_packet)
221
    {
222
        /* insert prev_packet with eos */
223
        ICECAST_LOG_DEBUG("adding EOS packet");
224 225 226
        source_vorbis->prev_packet->e_o_s = 1;
        add_audio_packet (source_vorbis, source_vorbis->prev_packet);
        source_vorbis->prev_packet->e_o_s = 0;
227
    }
228 229 230
    source_vorbis->get_buffer_page = get_buffer_finished;
    source_vorbis->initial_audio_packet = 1;
}
Jack Moffitt's avatar
Jack Moffitt committed
231

232

233
/* process the vorbis audio packets. Here we just take each packet out
234 235 236
 * and add them into the new stream, flushing after so many samples. We
 * also check if an new headers are requested after each processed page
 */
237
static int process_vorbis_audio(ogg_state_t *ogg_info, ogg_codec_t *codec, format_plugin_t *plugin)
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
{
    vorbis_codec_t *source_vorbis = codec->specific;

    while (1)
    {
        int window;
        ogg_packet packet;

        /* now, lets extract what packets we can */
        if (ogg_stream_packetout (&codec->os, &packet) <= 0)
            break;

        /* calculate granulepos for the packet */
        window = vorbis_packet_blocksize (&source_vorbis->vi, &packet) / 4;

        source_vorbis->granulepos += window;
        if (source_vorbis->prev_packet)
        {
            ogg_packet *prev_packet = source_vorbis->prev_packet;

            add_audio_packet (source_vorbis, prev_packet);
            free_ogg_packet (prev_packet);
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278

            /* check for short values on first initial page */
            if (packet . packetno == 4)
            {
                if (source_vorbis->initial_page_granulepos < source_vorbis->granulepos)
                {
                    source_vorbis->granulepos -= source_vorbis->initial_page_granulepos;
                    source_vorbis->samples_in_page = source_vorbis->page_samples_trigger;
                }
            }
            /* check for long values on first page */
            if (packet.granulepos == source_vorbis->initial_page_granulepos)
            {
                if (source_vorbis->initial_page_granulepos > source_vorbis->granulepos)
                    source_vorbis->granulepos = source_vorbis->initial_page_granulepos;
            }

            if (packet.e_o_s == 0)
                packet . granulepos = source_vorbis->granulepos;
279
        }
280
        else
281
        {
282
            packet . granulepos = 0;
283
        }
Jack Moffitt's avatar
Jack Moffitt committed
284

285 286 287 288 289 290
        /* store the current packet details */
        source_vorbis->prev_window = window;
        source_vorbis->prev_packet = copy_ogg_packet (&packet);
        if (packet.e_o_s)
        {
            initiate_flush (source_vorbis);
291 292
            free_ogg_packet (source_vorbis->prev_packet);
            source_vorbis->prev_packet = NULL;
293 294
            return 1;
        }
Jack Moffitt's avatar
Jack Moffitt committed
295

296 297 298 299 300 301 302 303
        /* allow for pages to be flushed if there's over a certain number of samples */
        if (source_vorbis->samples_in_page > source_vorbis->page_samples_trigger)
            return 1;
    }
    if (source_vorbis->stream_notify)
    {
        initiate_flush (source_vorbis);
        source_vorbis->stream_notify = 0;
304
        return 1;
305 306
    }
    return -1;
Jack Moffitt's avatar
Jack Moffitt committed
307 308
}

309 310 311 312

/* This handles the headers at the backend, here we insert the header packets
 * we want for the queue.
 */
313
static int process_vorbis_headers (ogg_state_t *ogg_info, ogg_codec_t *codec, format_plugin_t *plugin)
314
{
315 316 317 318
    vorbis_codec_t *source_vorbis = codec->specific;

    if (source_vorbis->header [0] == NULL)
        return 0;
319

320
    ICECAST_LOG_DEBUG("Adding the 3 header packets");
321 322 323
    ogg_stream_packetin (&source_vorbis->new_os, source_vorbis->header [0]);
    /* NOTE: we could build a separate comment packet each time */
    if (source_vorbis->rebuild_comment)
324
    {
325
        ogg_packet header;
326
        ice_config_t *config;
327

328
        config = config_get_config();
329
        format_set_vorbiscomment(plugin, "server", config->server_id);
330
        config_release_config();
331
        vorbis_commentheader_out (&plugin->vc, &header);
332 333 334

        ogg_stream_packetin (&source_vorbis->new_os, &header);
        ogg_packet_clear (&header);
335
    }
336 337 338 339 340 341 342 343 344 345 346
    else
        ogg_stream_packetin (&source_vorbis->new_os, source_vorbis->header [1]);
    ogg_stream_packetin (&source_vorbis->new_os, source_vorbis->header [2]);
    source_vorbis->rebuild_comment = 0;

    ogg_info->log_metadata = 1;
    source_vorbis->get_buffer_page = get_buffer_header;
    source_vorbis->process_packet = process_vorbis_audio;
    source_vorbis->granulepos = source_vorbis->prev_window;
    source_vorbis->initial_audio_packet = 1;
    return 1;
347
}
Jack Moffitt's avatar
Jack Moffitt committed
348

349 350 351 352 353

/* check if the provided BOS page is the start of a vorbis stream. If so
 * then setup a structure so it can be used
 */
ogg_codec_t *initial_vorbis_page (format_plugin_t *plugin, ogg_page *page)
354
{
355 356 357 358 359 360 361 362 363 364 365 366
    ogg_codec_t *codec = calloc (1, sizeof (ogg_codec_t));
    ogg_packet packet;

    vorbis_codec_t *vorbis = calloc (1, sizeof (vorbis_codec_t));

    ogg_stream_init (&codec->os, ogg_page_serialno (page));
    ogg_stream_pagein (&codec->os, page);

    vorbis_info_init (&vorbis->vi);

    ogg_stream_packetout (&codec->os, &packet);

367 368 369
    vorbis_comment_clear(&plugin->vc);
    vorbis_comment_init(&plugin->vc);

370
    ICECAST_LOG_DEBUG("checking for vorbis codec");
371
    if (vorbis_synthesis_headerin (&vorbis->vi, &plugin->vc, &packet) < 0)
372 373 374
    {
        ogg_stream_clear (&codec->os);
        vorbis_info_clear (&vorbis->vi);
375
        vorbis_comment_clear (&plugin->vc);
376 377 378 379
        free (vorbis);
        free (codec);
        return NULL;
    }
380
    ICECAST_LOG_INFO("seen initial vorbis header");
381 382 383
    codec->specific = vorbis;
    codec->codec_free = vorbis_codec_free;
    codec->headers = 1;
384
    codec->name = "Vorbis";
385

386 387 388 389 390 391
    free_ogg_packet(vorbis->header[0]);
    free_ogg_packet(vorbis->header[1]);
    free_ogg_packet(vorbis->header[2]);
    memset(vorbis->header, 0, sizeof(vorbis->header));
    vorbis->header[0] = copy_ogg_packet(&packet);
    ogg_stream_init(&vorbis->new_os, rand());
392 393 394 395 396

    codec->process_page = process_vorbis_page;
    codec->process = process_vorbis;
    plugin->set_tag = vorbis_set_tag;

397 398 399
    vorbis->bos_page.header = malloc(page->header_len + page->body_len);

    memcpy(vorbis->bos_page.header, page->header, page->header_len);
400
    vorbis->bos_page.header_len = page->header_len;
401

402
    vorbis->bos_page.body = vorbis->bos_page.header + page->header_len;
403
    memcpy(vorbis->bos_page.body, page->body, page->body_len);
404
    vorbis->bos_page.body_len = page->body_len;
405

406
    return codec;
407 408
}

409

410 411 412
/* called from the admin interface, here we update the artist/title info
 * and schedule a new set of header pages
 */
413
static void vorbis_set_tag (format_plugin_t *plugin, const char *tag, const char *in_value, const char *charset)
414
{
415 416 417
    ogg_state_t *ogg_info = plugin->_state;
    ogg_codec_t *codec = ogg_info->codecs;
    vorbis_codec_t *source_vorbis;
418
    char *value;
419

420 421
    ICECAST_LOG_WARN("Not officially supported metadata update detected, please inform the source client software vendor that they should fix their software!");

422 423 424 425 426 427
    /* avoid updating if multiple codecs in use */
    if (codec && codec->next == NULL)
        source_vorbis = codec->specific;
    else
        return;

428 429 430 431 432 433 434
    if (tag == NULL)
    {
        source_vorbis->stream_notify = 1;
        source_vorbis->rebuild_comment = 1;
        return;
    }

Karl Heyes's avatar
Karl Heyes committed
435
    value = util_conv_string (in_value, charset, "UTF-8");
436 437 438
    if (value == NULL)
        value = strdup (in_value);

439 440 441 442 443
    if (strcmp(tag, "song") == 0)
        tag = "title";

    format_set_vorbiscomment(plugin, tag, value);
    free (value);
444 445 446
}


447 448 449
/* main backend routine when rebuilding streams. Here we loop until we either
 * have a refbuf to add onto the queue, or we want more data to process.
 */
450
static refbuf_t *process_vorbis (ogg_state_t *ogg_info, ogg_codec_t *codec, format_plugin_t *plugin)
451 452 453
{
    vorbis_codec_t *source_vorbis = codec->specific;
    refbuf_t *refbuf;
454

455
    while (1)
456
    {
457
        if (source_vorbis->get_buffer_page)
458
        {
459 460 461
            refbuf = source_vorbis->get_buffer_page (ogg_info, codec);
            if (refbuf)
                return refbuf;
462 463
        }

464
        if (source_vorbis->process_packet &&
465
                source_vorbis->process_packet (ogg_info, codec, plugin) > 0)
466 467 468
            continue;
        return NULL;
    }
469 470
}

471 472 473 474 475

/* no processing of pages, just wrap them up in a refbuf and pass
 * back for adding to the queue
 */
static refbuf_t *process_vorbis_passthru_page (ogg_state_t *ogg_info,
476
        ogg_codec_t *codec, ogg_page *page, format_plugin_t *plugin)
477 478
{
    return make_refbuf_with_page (page);
479 480 481
}


482 483 484 485
/* handle incoming page. as the stream is being rebuilt, we need to
 * add all pages from the stream before processing packets
 */
static refbuf_t *process_vorbis_page (ogg_state_t *ogg_info,
486
        ogg_codec_t *codec, ogg_page *page, format_plugin_t *plugin)
487 488 489
{
    ogg_packet header;
    vorbis_codec_t *source_vorbis = codec->specific;
490

491 492 493 494 495 496
    if (ogg_stream_pagein (&codec->os, page) < 0)
    {
        ogg_info->error = 1;
        return NULL;
    }
    if (codec->headers == 3)
497 498 499 500 501 502
    {
        if (source_vorbis->initial_audio_page)
        {
            source_vorbis->initial_page_granulepos = ogg_page_granulepos (page);
            source_vorbis->initial_audio_page = 0;
        }
503
        return NULL;
504
    }
505

506
    while (codec->headers < 3)
507
    {
508
        /* now, lets extract the packets */
509
        ICECAST_LOG_DEBUG("processing incoming header packet (%d)", codec->headers);
510 511 512 513

        if (ogg_stream_packetout (&codec->os, &header) <= 0)
        {
            if (ogg_info->codecs->next)
514
                format_ogg_attach_header(ogg_info, page);
515 516 517
            return NULL;
        }

518
        if (vorbis_synthesis_headerin (&source_vorbis->vi, &plugin->vc, &header) < 0)
519
        {
520
            ogg_info->error = 1;
521
            ICECAST_LOG_WARN("Problem parsing ogg vorbis header");
522
            return NULL;
523
        }
524
        header.granulepos = 0;
525
        source_vorbis->header[codec->headers] = copy_ogg_packet(&header);
526 527
        codec->headers++;
    }
528
    ICECAST_LOG_DEBUG("we have the header packets now");
529 530 531 532 533 534 535

    /* if vorbis is the only codec then allow rebuilding of the streams */
    if (ogg_info->codecs->next == NULL)
    {
        /* set queued vorbis pages to contain about 1/2 of a second worth of samples */
        source_vorbis->page_samples_trigger = source_vorbis->vi.rate / 2;
        source_vorbis->process_packet = process_vorbis_headers;
536
        source_vorbis->initial_audio_page = 1;
537 538 539 540 541 542
    }
    else
    {
        format_ogg_attach_header (ogg_info, &source_vorbis->bos_page);
        format_ogg_attach_header (ogg_info, page);
        codec->process_page = process_vorbis_passthru_page;
543
    }
544 545 546

    ogg_info->log_metadata = 1;

547 548 549
    stats_event_args (ogg_info->mount, "audio_samplerate", "%ld", (long)source_vorbis->vi.rate);
    stats_event_args (ogg_info->mount, "audio_channels", "%ld", (long)source_vorbis->vi.channels);
    stats_event_args (ogg_info->mount, "audio_bitrate", "%ld", (long)source_vorbis->vi.bitrate_nominal);
550 551 552
    stats_event_args (ogg_info->mount, "ice-bitrate", "%ld", (long)source_vorbis->vi.bitrate_nominal/1000);

    return NULL;
553
}
Jack Moffitt's avatar
Jack Moffitt committed
554