modules/demux/sid.cpp

   1 /**
   2  * @file sid.cpp
   3  * @brief Sidplay demux module for VLC media player
   4  */
   5 /*****************************************************************************
   6  * Copyright © 2010 Rémi Denis-Courmont
   7  * Copyright © 2010 Alan Fischer <alan@lightningtoads.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * NOTA BENE: this module requires the linking against a library which is
  26  * known to require licensing under the GNU General Public License version 2
  27  * (or later). Therefore, the result of compiling this module will normally
  28  * be subject to the terms of that later license.
  29  *****************************************************************************/
  30
  31
  32 #ifdef HAVE_CONFIG_H
  33 # include <config.h>
  34 #endif
  35
  36 #include <vlc_common.h>
  37 #include <vlc_input.h>
  38 #include <vlc_demux.h>
  39 #include <vlc_plugin.h>
  40
  41 #include <limits.h>
  42
  43 #include <sidplay/sidplay2.h>
  44 #include <sidplay/builders/resid.h>
  45
  46 #include <new>
  47
  48 static int  Open (vlc_object_t *);
  49 static void Close (vlc_object_t *);
  50
  51 vlc_module_begin ()
  52     set_shortname ("sid")
  53     set_description ( N_("C64 sid demuxer") )
  54     set_category (CAT_INPUT)
  55     set_subcategory (SUBCAT_INPUT_DEMUX)
  56     set_capability ("demux", 100)
  57     set_callbacks (Open, Close)
  58 vlc_module_end ()
  59
  60 struct demux_sys_t
  61 {
  62     sidplay2 *player;
  63     sid2_config_t config;
  64     sid2_info_t info;
  65     SidTune *tune;
  66     SidTuneInfo tuneInfo;
  67
  68     int bytes_per_frame;
  69     int block_size;
  70     es_out_id_t *es;
  71     date_t pts;
  72
  73     int last_title;
  74 };
  75
  76
  77 static int Demux (demux_t *);
  78 static int Control (demux_t *, int, va_list);
  79
  80 static int Open (vlc_object_t *obj)
  81 {
  82     demux_t *demux = (demux_t *)obj;
  83     demux_sys_t *sys = NULL;
  84     es_format_t fmt;
  85     bool result = false;
  86     SidTune *tune = NULL;
  87     sidplay2 *player = NULL;
  88     ReSIDBuilder *builder = NULL;
  89
  90     int64_t size = stream_Size (demux->s);
  91     if (size < 4 || size > LONG_MAX) /* We need to load the whole file for sidplay */
  92         return VLC_EGENERIC;
  93
  94     const uint8_t *peek;
  95     if (vlc_stream_Peek (demux->s, &peek, 4) < 4)
  96         return VLC_EGENERIC;
  97
  98     /* sidplay2 can read PSID and the newer RSID formats */
  99     if(memcmp(peek,"PSID",4)!=0 && memcmp(peek,"RSID",4)!=0)
 100         return VLC_EGENERIC;
 101
 102     uint8_t *data = (uint8_t*) malloc(size);
 103     if (unlikely (data==NULL))
 104         goto error;
 105
 106     if (vlc_stream_Read (demux->s,data,size) < size) {
 107         free (data);
 108         goto error;
 109     }
 110
 111     tune = new (std::nothrow) SidTune(0);
 112     if (unlikely (tune==NULL)) {
 113         free (data);
 114         goto error;
 115     }
 116
 117     result = tune->read (data, size);
 118     free (data);
 119     if (!result)
 120         goto error;
 121
 122     player = new (std::nothrow) sidplay2();
 123     if (unlikely(player==NULL))
 124         goto error;
 125
 126     sys = (demux_sys_t*) calloc (1, sizeof(demux_sys_t));
 127     if (unlikely(sys==NULL))
 128         goto error;
 129
 130     sys->player = player;
 131     sys->tune = tune;
 132
 133     tune->getInfo (sys->tuneInfo);
 134
 135     sys->info = player->info();
 136     sys->config = player->config();
 137
 138     builder = new (std::nothrow) ReSIDBuilder ("ReSID");
 139     if (unlikely(builder==NULL))
 140         goto error;
 141
 142     builder->create (sys->info.maxsids);
 143     builder->sampling (sys->config.frequency);
 144
 145     sys->config.sidEmulation = builder;
 146     sys->config.precision    = 16;
 147     sys->config.playback     = (sys->info.channels == 2 ? sid2_stereo : sid2_mono);
 148
 149     player->config (sys->config);
 150
 151     sys->bytes_per_frame = sys->info.channels * sys->config.precision / 8;
 152     sys->block_size = sys->config.frequency / 10 * sys->bytes_per_frame;
 153
 154     es_format_Init (&fmt, AUDIO_ES, VLC_CODEC_S16N);
 155
 156     fmt.audio.i_channels        = sys->info.channels;
 157     fmt.audio.i_bitspersample   = sys->config.precision;
 158     fmt.audio.i_rate            = sys->config.frequency;
 159     fmt.audio.i_bytes_per_frame = sys->bytes_per_frame;
 160     fmt.audio.i_frame_length    = fmt.audio.i_bytes_per_frame;
 161     fmt.audio.i_blockalign      = fmt.audio.i_bytes_per_frame;
 162
 163     fmt.i_bitrate = fmt.audio.i_rate * fmt.audio.i_bytes_per_frame;
 164
 165     sys->es = es_out_Add (demux->out, &fmt);
 166
 167     date_Init (&sys->pts, fmt.audio.i_rate, 1);
 168     date_Set (&sys->pts, 0);
 169
 170     sys->tune->selectSong (0);
 171     result = (sys->player->load (sys->tune) >=0 );
 172     sys->player->fastForward (100);
 173     if (!result)
 174         goto error;
 175
 176     /* Callbacks */
 177     demux->pf_demux = Demux;
 178     demux->pf_control = Control;
 179     demux->p_sys = sys;
 180
 181     return VLC_SUCCESS;
 182
 183 error:
 184     msg_Err (demux, "An error occurred during sid demuxing" );
 185     delete player;
 186     delete builder;
 187     delete tune;
 188     free (sys);
 189     return VLC_EGENERIC;
 190 }
 191
 192
 193 static void Close (vlc_object_t *obj)
 194 {
 195     demux_t *demux = (demux_t *)obj;
 196     demux_sys_t *sys = (demux_sys_t *)demux->p_sys;
 197
 198     delete sys->player;
 199     delete sys->config.sidEmulation;
 200     delete sys->tune;
 201     free (sys);
 202 }
 203
 204 static int Demux (demux_t *demux)
 205 {
 206     demux_sys_t *sys = (demux_sys_t *)demux->p_sys;
 207
 208     block_t *block = block_Alloc( sys->block_size);
 209     if (unlikely(block==NULL))
 210         return 0;
 211
 212     if (!sys->tune->getStatus()) {
 213         block_Release (block);
 214         return 0;
 215     }
 216
 217     int i_read = sys->player->play ((void*)block->p_buffer, block->i_buffer);
 218     if (i_read <= 0) {
 219         block_Release (block);
 220         return 0;
 221     }
 222     block->i_buffer = i_read;
 223     block->i_pts = block->i_dts = VLC_TS_0 + date_Get (&sys->pts);
 224
 225     es_out_SetPCR (demux->out, block->i_pts);
 226
 227     es_out_Send (demux->out, sys->es, block);
 228
 229     date_Increment (&sys->pts, i_read / sys->bytes_per_frame);
 230
 231     return 1;
 232 }
 233
 234
 235 static int Control (demux_t *demux, int query, va_list args)
 236 {
 237     demux_sys_t *sys = (demux_sys_t *)demux->p_sys;
 238
 239     switch (query)
 240     {
 241         case DEMUX_GET_TIME : {
 242             int64_t *v = va_arg (args, int64_t*);
 243             *v = sys->player->time() * sys->player->timebase() * (CLOCK_FREQ / 100);
 244             return VLC_SUCCESS;
 245         }
 246
 247         case DEMUX_GET_META : {
 248             vlc_meta_t *p_meta = va_arg (args, vlc_meta_t *);
 249
 250             /* These are specified in the sid tune class as 0 = Title, 1 = Artist, 2 = Copyright/Publisher */
 251             vlc_meta_SetTitle( p_meta, sys->tuneInfo.infoString[0] );
 252             vlc_meta_SetArtist( p_meta, sys->tuneInfo.infoString[1] );
 253             vlc_meta_SetCopyright( p_meta, sys->tuneInfo.infoString[2] );
 254
 255             return VLC_SUCCESS;
 256         }
 257
 258         case DEMUX_GET_TITLE_INFO :
 259             if ( sys->tuneInfo.songs > 1 ) {
 260                 input_title_t ***ppp_title = va_arg (args, input_title_t ***);
 261                 int *pi_int = va_arg( args, int* );
 262
 263                 *pi_int = sys->tuneInfo.songs;
 264                 *ppp_title = (input_title_t**) vlc_alloc( sys->tuneInfo.songs, sizeof (input_title_t*));
 265
 266                 for( int i = 0; i < sys->tuneInfo.songs; i++ ) {
 267                     (*ppp_title)[i] = vlc_input_title_New();
 268                 }
 269
 270                 return VLC_SUCCESS;
 271             }
 272             return VLC_EGENERIC;
 273
 274         case DEMUX_SET_TITLE : {
 275             int i_idx = va_arg (args, int);
 276             sys->tune->selectSong (i_idx+1);
 277             bool result = (sys->player->load (sys->tune) >=0 );
 278             if (!result)
 279                 return  VLC_EGENERIC;
 280
 281             sys->last_title = i_idx;
 282             demux->info.i_update = INPUT_UPDATE_TITLE;
 283             msg_Dbg( demux, "set song %i", i_idx);
 284
 285             return VLC_SUCCESS;
 286         }
 287
 288         case DEMUX_GET_TITLE:
 289             *va_arg(args, int *) = sys->last_title;
 290             return VLC_SUCCESS;
 291     }
 292
 293     return VLC_EGENERIC;
 294 }