mpv/stream/stream_cdda.c

/*
 * This file is part of MPlayer.
 *
 * MPlayer is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * MPlayer is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with MPlayer; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#include "config.h"
#include <cdio/cdda.h>
#include <cdio/paranoia.h>
#include <cdio/cdio.h>

#include <stdio.h>
#include <stdlib.h>
#include <stdbool.h>
#include <sys/types.h>

#include "talloc.h"

#include "stream.h"
#include "core/m_option.h"
#include "core/m_struct.h"
#include "libavutil/common.h"
#include "compat/mpbswap.h"
#include "demux/demux.h"

#include "cdd.h"

#include "core/mp_msg.h"

extern char *cdrom_device;

typedef struct {
    cdrom_drive_t *cd;
    cdrom_paranoia_t *cdp;
    int sector;
    int start_sector;
    int end_sector;
    cd_info_t *cd_info;
} cdda_priv;

static struct cdda_params {
    int speed;
    int paranoia_mode;
    char *generic_dev;
    int sector_size;
    int search_overlap;
    int toc_bias;
    int toc_offset;
    int no_skip;
    char *device;
    m_span_t span;
} cdda_dflts = {
    .search_overlap = -1,
};

#define ST_OFF(f) M_ST_OFF(struct cdda_params, f)
static const m_option_t cdda_params_fields[] = {
    {"speed", ST_OFF(speed), CONF_TYPE_INT, M_OPT_RANGE, 0, 100, NULL},
    {"paranoia", ST_OFF(paranoia_mode), CONF_TYPE_INT, M_OPT_RANGE, 0, 2,
     NULL},
    {"generic-dev", ST_OFF(generic_dev), CONF_TYPE_STRING, 0, 0, 0, NULL},
    {"sector-size", ST_OFF(sector_size), CONF_TYPE_INT, M_OPT_RANGE, 1, 100,
     NULL},
    {"overlap", ST_OFF(search_overlap), CONF_TYPE_INT, M_OPT_RANGE, -1, 75,
     NULL},
    {"toc-bias", ST_OFF(toc_bias), CONF_TYPE_INT, 0, 0, 0, NULL},
    {"toc-offset", ST_OFF(toc_offset), CONF_TYPE_INT, 0, 0, 0, NULL},
    {"noskip", ST_OFF(no_skip), CONF_TYPE_FLAG, 0, 0, 1, NULL},
    {"skip", ST_OFF(no_skip), CONF_TYPE_FLAG, 0, 1, 0, NULL},
    {"device", ST_OFF(device), CONF_TYPE_STRING, 0, 0, 0, NULL},
    {"span", ST_OFF(span), CONF_TYPE_OBJ_PARAMS, 0, 0, 0,
     (void *)&m_span_params_def},
    /// For url parsing
    {"hostname", ST_OFF(span), CONF_TYPE_OBJ_PARAMS, 0, 0, 0,
     (void *)&m_span_params_def},
    {"port", ST_OFF(speed), CONF_TYPE_INT, M_OPT_RANGE, 1, 100, NULL},
    {"filename", ST_OFF(device), CONF_TYPE_STRING, 0, 0, 0, NULL},
    {0}
};
static const struct m_struct_st stream_opts = {
    "cdda",
    sizeof(struct cdda_params),
    &cdda_dflts,
    cdda_params_fields
};

/// We keep these options but now they set the defaults
const m_option_t cdda_opts[] = {
    {"speed", &cdda_dflts.speed, CONF_TYPE_INT, M_OPT_RANGE, 1, 100, NULL},
    {"paranoia", &cdda_dflts.paranoia_mode, CONF_TYPE_INT, M_OPT_RANGE, 0, 2,
     NULL},
    {"generic-dev", &cdda_dflts.generic_dev, CONF_TYPE_STRING, 0, 0, 0, NULL},
    {"sector-size", &cdda_dflts.sector_size, CONF_TYPE_INT, M_OPT_RANGE, 1,
     100, NULL},
    {"overlap", &cdda_dflts.search_overlap, CONF_TYPE_INT, M_OPT_RANGE, 0, 75,
     NULL},
    {"toc-bias", &cdda_dflts.toc_bias, CONF_TYPE_INT, 0, 0, 0, NULL},
    {"toc-offset", &cdda_dflts.toc_offset, CONF_TYPE_INT, 0, 0, 0, NULL},
    {"noskip", &cdda_dflts.no_skip, CONF_TYPE_FLAG, 0, 0, 1, NULL},
    {"skip", &cdda_dflts.no_skip, CONF_TYPE_FLAG, 0, 1, 0, NULL},
    {"device", &cdda_dflts.device, CONF_TYPE_STRING, 0, 0, 0, NULL},
    {"span", &cdda_dflts.span, CONF_TYPE_OBJ_PARAMS, 0, 0, 0,
     (void *)&m_span_params_def},
    {NULL, NULL, 0, 0, 0, 0, NULL}
};

static const char *cdtext_name[] = {
    [CDTEXT_ARRANGER] = "Arranger",
    [CDTEXT_COMPOSER] = "Composer",
    [CDTEXT_MESSAGE]  =  "Message",
    [CDTEXT_ISRC] =  "ISRC",
    [CDTEXT_PERFORMER] = "Performer",
    [CDTEXT_SONGWRITER] =  "Songwriter",
    [CDTEXT_TITLE] =  "Title",
    [CDTEXT_UPC_EAN] = "UPC_EAN",
};

static bool print_cdtext(stream_t *s, int track)
{
    cdda_priv* p = (cdda_priv*)s->priv;
    cdtext_t *text = cdio_get_cdtext(p->cd->p_cdio, track);
    if (text) {
        mp_msg(MSGT_SEEK, MSGL_INFO, "CD-Text (%s):\n", track ? "track" : "CD");
        for (int i = 0; i < sizeof(cdtext_name) / sizeof(cdtext_name[0]); i++) {
            const char *name = cdtext_name[i];
            const char *value = cdtext_get_const(i, text);
            if (name && value)
                mp_msg(MSGT_SEEK, MSGL_INFO, "  %s: '%s'\n", name, value);
        }
        return true;
    }
    return false;
}

static void print_track_info(stream_t *s, int track)
{
    cdda_priv* p = (cdda_priv*)s->priv;
    cd_track_t *cd_track = cd_info_get_track(p->cd_info, track);
    if( cd_track!=NULL ) {
        mp_msg(MSGT_SEEK, MSGL_INFO, "\n%s\n", cd_track->name);
        mp_msg(MSGT_IDENTIFY, MSGL_INFO, "ID_CDDA_TRACK=%d\n",
               cd_track->track_nb);
    }
    if (print_cdtext(s, track)) {
        // hack for term OSD overwriting the last line of CDTEXT
        mp_msg(MSGT_SEEK, MSGL_INFO, "\n");
    }
}

static void cdparanoia_callback(long int inpos, paranoia_cb_mode_t function)
{
}

static int fill_buffer(stream_t *s, char *buffer, int max_len)
{
    cdda_priv *p = (cdda_priv *)s->priv;
    int16_t *buf;
    int i;

    if ((p->sector < p->start_sector) || (p->sector > p->end_sector)) {
        s->eof = 1;
        return 0;
    }

    buf = paranoia_read(p->cdp, cdparanoia_callback);
    if (!buf)
        return 0;

#if BYTE_ORDER == BIG_ENDIAN
    for (i = 0; i < CDIO_CD_FRAMESIZE_RAW / 2; i++)
        buf[i] = le2me_16(buf[i]);
#endif

    p->sector++;
    memcpy(buffer, buf, CDIO_CD_FRAMESIZE_RAW);

    for (i = 0; i < p->cd->tracks; i++) {
        if (p->cd->disc_toc[i].dwStartSector == p->sector - 1) {
            print_track_info(s, i + 1);
            break;
        }
    }

    return CDIO_CD_FRAMESIZE_RAW;
}

static int seek(stream_t *s, off_t newpos)
{
    cdda_priv *p = (cdda_priv *)s->priv;
    int sec;
    int current_track = 0, seeked_track = 0;
    int seek_to_track = 0;
    int i;

    s->pos = newpos;
    sec = s->pos / CDIO_CD_FRAMESIZE_RAW;
    if (s->pos < 0 || sec > p->end_sector) {
        s->eof = 1;
        p->sector = p->end_sector + 1;
        return 0;
    }

    for (i = 0; i < p->cd->tracks; i++) {
        if (p->sector >= p->cd->disc_toc[i].dwStartSector
            && p->sector < p->cd->disc_toc[i + 1].dwStartSector)
            current_track = i;
        if (sec >= p->cd->disc_toc[i].dwStartSector
            && sec < p->cd->disc_toc[i + 1].dwStartSector)
        {
            seeked_track = i;
            seek_to_track = sec == p->cd->disc_toc[i].dwStartSector;
        }
    }
    if (current_track != seeked_track && !seek_to_track)
        print_track_info(s, seeked_track + 1);

    p->sector = sec;

    paranoia_seek(p->cdp, sec, SEEK_SET);
    return 1;
}

static void close_cdda(stream_t *s)
{
    cdda_priv *p = (cdda_priv *)s->priv;
    paranoia_free(p->cdp);
    cdda_close(p->cd);
    cd_info_free(p->cd_info);
    free(p);
}

static int get_track_by_sector(cdda_priv *p, unsigned int sector)
{
    int i;
    for (i = p->cd->tracks; i >= 0; --i)
        if (p->cd->disc_toc[i].dwStartSector <= sector)
            break;
    return i;
}

static int control(stream_t *stream, int cmd, void *arg)
{
    cdda_priv *p = stream->priv;
    switch (cmd) {
    case STREAM_CTRL_GET_NUM_TITLES:
    {
      *(unsigned int *)arg = p->cd->tracks;
      return STREAM_OK;
    }
    case STREAM_CTRL_GET_NUM_CHAPTERS:
    {
        int start_track = get_track_by_sector(p, p->start_sector);
        int end_track = get_track_by_sector(p, p->end_sector);
        if (start_track == -1 || end_track == -1)
            return STREAM_ERROR;
        *(unsigned int *)arg = end_track + 1 - start_track;
        return STREAM_OK;
    }
    case STREAM_CTRL_SEEK_TO_CHAPTER:
    {
        int r;
        unsigned int track = *(unsigned int *)arg;
        int start_track = get_track_by_sector(p, p->start_sector);
        int end_track = get_track_by_sector(p, p->end_sector);
        int seek_sector;
        if (start_track == -1 || end_track == -1)
            return STREAM_ERROR;
        track += start_track;
        if (track > end_track) {
            seek(stream, (p->end_sector + 1) * CDIO_CD_FRAMESIZE_RAW);
            // seeking beyond EOF should not be an error,
            // the cache cannot handle changing stream pos and
            // returning error.
            return STREAM_OK;
        }
        seek_sector = track <= 0 ? p->start_sector
                      : p->cd->disc_toc[track].dwStartSector;
        r = seek(stream, seek_sector * CDIO_CD_FRAMESIZE_RAW);
        if (r)
            return STREAM_OK;
        break;
    }
    case STREAM_CTRL_GET_CURRENT_CHAPTER:
    {
        int start_track = get_track_by_sector(p, p->start_sector);
        int cur_track = get_track_by_sector(p, p->sector);
        if (start_track == -1 || cur_track == -1)
            return STREAM_ERROR;
        *(unsigned int *)arg = cur_track - start_track;
        return STREAM_OK;
    }
    }
    return STREAM_UNSUPPORTED;
}

static int open_cdda(stream_t *st, int m, void *opts, int *file_format)
{
    struct cdda_params *p = (struct cdda_params *)opts;
    int mode = p->paranoia_mode;
    int offset = p->toc_offset;
    cdrom_drive_t *cdd = NULL;
    cdda_priv *priv;
    cd_info_t *cd_info, *cddb_info = NULL;
    unsigned int audiolen = 0;
    int last_track;
    int i;
    char *xmcd_file = NULL;

    if (m != STREAM_READ) {
        m_struct_free(&stream_opts, opts);
        return STREAM_UNSUPPORTED;
    }

    if (!p->device) {
        if (cdrom_device)
            p->device = talloc_strdup(NULL, cdrom_device);
        else
            p->device = talloc_strdup(NULL, DEFAULT_CDROM_DEVICE);
    }

#ifdef CONFIG_CDDB
    // cdd_identify returns -1 if it cannot read the TOC,
    // in which case there is no point in calling cddb_resolve
    if (cdd_identify(p->device) >= 0 && strncmp(st->url, "cddb", 4) == 0) {
        i = cddb_resolve(p->device, &xmcd_file);
        if (i == 0) {
            cddb_info = cddb_parse_xmcd(xmcd_file);
            free(xmcd_file);
        }
    }
#endif

#if defined(__NetBSD__)
    cdd = cdda_identify_scsi(p->device, p->device, 0, NULL);
#else
    cdd = cdda_identify(p->device, 0, NULL);
#endif

    if (!cdd) {
        mp_tmsg(MSGT_OPEN, MSGL_ERR, "Can't open CDDA device.\n");
        m_struct_free(&stream_opts, opts);
        free(cddb_info);
        return STREAM_ERROR;
    }

    cdda_verbose_set(cdd, CDDA_MESSAGE_FORGETIT, CDDA_MESSAGE_FORGETIT);

    if (p->sector_size)
        cdd->nsectors = p->sector_size;

    if (cdda_open(cdd) != 0) {
        mp_tmsg(MSGT_OPEN, MSGL_ERR, "Can't open disc.\n");
        cdda_close(cdd);
        m_struct_free(&stream_opts, opts);
        free(cddb_info);
        return STREAM_ERROR;
    }

    cd_info = cd_info_new();
    mp_tmsg(MSGT_OPEN, MSGL_INFO, "Found audio CD with %d tracks.\n",
            (int)cdda_tracks(cdd));
    for (i = 0; i < cdd->tracks; i++) {
        char track_name[80];
        long sec = cdda_track_firstsector(cdd, i + 1);
        long off = cdda_track_lastsector(cdd, i + 1) - sec + 1;

        sprintf(track_name, "Track %d", i + 1);
        cd_info_add_track(cd_info, track_name, i + 1,
                          (unsigned int)(off / (60 * 75)),
                          (unsigned int)((off / 75) % 60),
                          (unsigned int)(off % 75), sec, off);
        audiolen += off;
    }
    cd_info->min  = (unsigned int)(audiolen / (60 * 75));
    cd_info->sec  = (unsigned int)((audiolen / 75) % 60);
    cd_info->msec = (unsigned int)(audiolen % 75);

    priv = malloc(sizeof(cdda_priv));
    memset(priv, 0, sizeof(cdda_priv));
    priv->cd = cdd;
    priv->cd_info = cd_info;

    if (p->toc_bias)
        offset -= cdda_track_firstsector(cdd, 1);

    if (offset) {
        int i;
        for (i = 0; i < cdd->tracks + 1; i++)
            cdd->disc_toc[i].dwStartSector += offset;
    }

    if (p->speed > 0)
        cdda_speed_set(cdd, p->speed);

    last_track = cdda_tracks(cdd);
    if (p->span.start > last_track)
        p->span.start = last_track;
    if (p->span.end < p->span.start)
        p->span.end = p->span.start;
    if (p->span.end > last_track)
        p->span.end = last_track;
    if (p->span.start)
        priv->start_sector = cdda_track_firstsector(cdd, p->span.start);
    else
        priv->start_sector = cdda_disc_firstsector(cdd);

    if (p->span.end)
        priv->end_sector = cdda_track_lastsector(cdd, p->span.end);
    else
        priv->end_sector = cdda_disc_lastsector(cdd);

    priv->cdp = paranoia_init(cdd);
    if (priv->cdp == NULL) {
        cdda_close(cdd);
        free(priv);
        cd_info_free(cd_info);
        m_struct_free(&stream_opts, opts);
        free(cddb_info);
        return STREAM_ERROR;
    }

    if (mode == 0)
        mode = PARANOIA_MODE_DISABLE;
    else if (mode == 1)
        mode = PARANOIA_MODE_OVERLAP;
    else
        mode = PARANOIA_MODE_FULL;

    if (p->no_skip)
        mode |= PARANOIA_MODE_NEVERSKIP;
    else
        mode &= ~PARANOIA_MODE_NEVERSKIP;

    if (p->search_overlap > 0)
        mode |= PARANOIA_MODE_OVERLAP;
    else if (p->search_overlap == 0)
        mode &= ~PARANOIA_MODE_OVERLAP;

    paranoia_modeset(priv->cdp, mode);

    if (p->search_overlap > 0)
        paranoia_overlapset(priv->cdp, p->search_overlap);

    paranoia_seek(priv->cdp, priv->start_sector, SEEK_SET);
    priv->sector = priv->start_sector;

#ifdef CONFIG_CDDB
    if (cddb_info) {
        cd_info_free(cd_info);
        priv->cd_info = cddb_info;
        cd_info_debug(cddb_info);
    }
#endif

    st->priv = priv;
    st->start_pos = priv->start_sector * CDIO_CD_FRAMESIZE_RAW;
    st->end_pos = (priv->end_sector + 1) * CDIO_CD_FRAMESIZE_RAW;
    st->type = STREAMTYPE_CDDA;
    st->sector_size = CDIO_CD_FRAMESIZE_RAW;

    st->fill_buffer = fill_buffer;
    st->seek = seek;
    st->control = control;
    st->close = close_cdda;

    *file_format = DEMUXER_TYPE_RAWAUDIO;

    m_struct_free(&stream_opts, opts);

    print_cdtext(st, 0);

    return STREAM_OK;
}

const stream_info_t stream_info_cdda = {
    "CDDA",
    "cdda",
    "Albeu",
    "",
    open_cdda,
    {"cdda",
#ifdef CONFIG_CDDB
     "cddb",
#endif
     NULL },
    &stream_opts,
    .opts_url = 1,
};