git.sesse.net Git - vlc/blob - modules/access/cdda.c

   1 /*****************************************************************************
   2  * cdda.c : CD digital audio input module for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2000, 2003 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *          Gildas Bazin <gbazin@netcourrier.com>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /**
  26  * Todo:
  27  *   - Improve CDDB support (non-blocking, cache, ...)
  28  *   - Fix tracknumber in MRL
  29  */
  30
  31 /*****************************************************************************
  32  * Preamble
  33  *****************************************************************************/
  34 #include <stdlib.h>
  35
  36 #include <vlc/vlc.h>
  37 #include <vlc/input.h>
  38
  39 #include "codecs.h"
  40 #include "vcd/cdrom.h"
  41
  42 #include <vlc_playlist.h>
  43
  44 #ifdef HAVE_LIBCDDB
  45 #include <cddb/cddb.h>
  46 #endif
  47
  48 #ifdef HAVE_ERRNO_H
  49 #include <errno.h>
  50 #endif
  51
  52 /*****************************************************************************
  53  * Module descriptior
  54  *****************************************************************************/
  55 static int  Open ( vlc_object_t * );
  56 static void Close( vlc_object_t * );
  57
  58 #define CACHING_TEXT N_("Caching value in ms")
  59 #define CACHING_LONGTEXT N_( \
  60     "Default caching value for Audio CDs. This " \
  61     "value should be set in milliseconds." )
  62
  63 vlc_module_begin();
  64     set_shortname( _("Audio CD"));
  65     set_description( _("Audio CD input") );
  66     set_capability( "access2", 10 );
  67     set_category( CAT_INPUT );
  68     set_subcategory( SUBCAT_INPUT_ACCESS );
  69     set_callbacks( Open, Close );
  70
  71     add_usage_hint( N_("[cdda:][device][@[track]]") );
  72     add_integer( "cdda-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT,
  73                  CACHING_LONGTEXT, VLC_TRUE );
  74
  75     add_integer( "cdda-track", -1 , NULL, NULL, NULL, VLC_TRUE );
  76         change_internal();
  77     add_integer( "cdda-first-sector", -1, NULL, NULL, NULL, VLC_TRUE );
  78         change_internal();
  79     add_integer( "cdda-last-sector", -1, NULL, NULL, NULL, VLC_TRUE );
  80         change_internal();
  81
  82     add_string( "cddb-server", "freedb.freedb.org", NULL,
  83                 N_( "CDDB Server" ), N_( "Address of the CDDB server to use." ),
  84                 VLC_TRUE );
  85     add_integer( "cddb-port", 8880, NULL,
  86                 N_( "CDDB port" ), N_( "CDDB Server port to use." ),
  87                 VLC_TRUE );
  88     add_shortcut( "cdda" );
  89     add_shortcut( "cddasimple" );
  90 vlc_module_end();
  91
  92
  93 /* how many blocks VCDRead will read in each loop */
  94 #define CDDA_BLOCKS_ONCE 20
  95 #define CDDA_DATA_ONCE   (CDDA_BLOCKS_ONCE * CDDA_DATA_SIZE)
  96
  97 /*****************************************************************************
  98  * Access: local prototypes
  99  *****************************************************************************/
 100 struct access_sys_t
 101 {
 102     vcddev_t    *vcddev;                            /* vcd device descriptor */
 103
 104     /* Current position */
 105     int         i_sector;                                  /* Current Sector */
 106     int *       p_sectors;                                  /* Track sectors */
 107
 108     /* Wave header for the output data */
 109     WAVEHEADER  waveheader;
 110     vlc_bool_t  b_header;
 111
 112     int         i_track;
 113     int         i_first_sector;
 114     int         i_last_sector;
 115
 116 #ifdef HAVE_LIBCDDB
 117     cddb_disc_t *p_disc;
 118 #endif
 119 };
 120
 121 static block_t *Block( access_t * );
 122 static int      Seek( access_t *, int64_t );
 123 static int      Control( access_t *, int, va_list );
 124
 125 static int GetTracks( access_t *p_access, playlist_t *p_playlist,
 126                       playlist_item_t *p_parent );
 127
 128 #ifdef HAVE_LIBCDDB
 129 static void GetCDDBInfo( access_t *p_access, int i_titles, int *p_sectors );
 130 #endif
 131
 132 /*****************************************************************************
 133  * Open: open cdda
 134  *****************************************************************************/
 135 static int Open( vlc_object_t *p_this )
 136 {
 137     access_t     *p_access = (access_t*)p_this;
 138     access_sys_t *p_sys;
 139     vcddev_t *vcddev;
 140     char *psz_name;
 141     int i_mrl_tracknum = -1;
 142
 143     input_thread_t *p_input;
 144     playlist_item_t *p_item = NULL;
 145     playlist_t *p_playlist  = NULL;
 146     int i_ret;
 147
 148     if( !p_access->psz_path || !*p_access->psz_path )
 149     {
 150         /* Only when selected */
 151         if( !p_this->b_force ) return VLC_EGENERIC;
 152
 153         psz_name = var_CreateGetString( p_this, "cd-audio" );
 154         if( !psz_name || !*psz_name )
 155         {
 156             if( psz_name ) free( psz_name );
 157             return VLC_EGENERIC;
 158         }
 159     }
 160     else psz_name = strdup( p_access->psz_path );
 161
 162 #ifdef WIN32
 163     if( psz_name[0] && psz_name[1] == ':' &&
 164         psz_name[2] == '\\' && psz_name[3] == '\0' ) psz_name[2] = '\0';
 165 #endif
 166
 167     /* Open CDDA */
 168     if( (vcddev = ioctl_Open( VLC_OBJECT(p_access), psz_name )) == NULL )
 169     {
 170         msg_Warn( p_access, "could not open %s", psz_name );
 171         free( psz_name );
 172         return VLC_EGENERIC;
 173     }
 174     free( psz_name );
 175
 176     /* Set up p_access */
 177     STANDARD_BLOCK_ACCESS_INIT
 178     p_sys->vcddev = vcddev;
 179
 180     /* We only do separate items if the whole disc is requested -
 181      *  Dirty hack we access some private data ! */
 182     p_input = (input_thread_t *)( p_access->p_parent );
 183
 184    /* Do we play a single track ? */
 185    p_sys->i_track = var_CreateGetInteger( p_access, "cdda-track" );
 186
 187    if( p_sys->i_track < 0 && i_mrl_tracknum <= 0 )
 188    {
 189         p_playlist = pl_Yield( p_access );
 190         if( p_playlist->status.p_item->p_input ==
 191              ((input_thread_t *)p_access->p_parent)->input.p_item )
 192             p_item = p_playlist->status.p_item;
 193         else
 194         {
 195             input_item_t *p_current = ( (input_thread_t*)p_access->p_parent)->
 196                                          input.p_item;
 197             p_item = playlist_LockItemGetByInput( p_playlist, p_current );
 198
 199             if( !p_item )
 200             {
 201                 msg_Dbg( p_playlist, "unable to find item in playlist");
 202                 return -1;
 203             }
 204         }
 205
 206         i_ret = GetTracks( p_access, p_playlist, p_item );
 207
 208         if( p_playlist ) vlc_object_release( p_playlist );
 209         if( i_ret < 0 ) goto error;
 210     }
 211     else
 212     {
 213         /* Build a WAV header for the output data */
 214         memset( &p_sys->waveheader, 0, sizeof(WAVEHEADER) );
 215         SetWLE( &p_sys->waveheader.Format, 1 ); /*WAVE_FORMAT_PCM*/
 216         SetWLE( &p_sys->waveheader.BitsPerSample, 16);
 217         p_sys->waveheader.MainChunkID = VLC_FOURCC('R', 'I', 'F', 'F');
 218         p_sys->waveheader.Length = 0;               /* we just don't know */
 219         p_sys->waveheader.ChunkTypeID = VLC_FOURCC('W', 'A', 'V', 'E');
 220         p_sys->waveheader.SubChunkID = VLC_FOURCC('f', 'm', 't', ' ');
 221         SetDWLE( &p_sys->waveheader.SubChunkLength, 16);
 222         SetWLE( &p_sys->waveheader.Modus, 2);
 223         SetDWLE( &p_sys->waveheader.SampleFreq, 44100);
 224         SetWLE( &p_sys->waveheader.BytesPerSample,
 225                     2 /*Modus*/ * 16 /*BitsPerSample*/ / 8 );
 226         SetDWLE( &p_sys->waveheader.BytesPerSec,
 227                     2*16/8 /*BytesPerSample*/ * 44100 /*SampleFreq*/ );
 228         p_sys->waveheader.DataChunkID = VLC_FOURCC('d', 'a', 't', 'a');
 229         p_sys->waveheader.DataLength = 0;           /* we just don't know */
 230
 231         p_sys->i_first_sector = var_CreateGetInteger( p_access,
 232                                                       "cdda-first-sector" );
 233         p_sys->i_last_sector  = var_CreateGetInteger( p_access,
 234                                                       "cdda-last-sector" );
 235         /* Tracknumber in MRL */
 236         if( p_sys->i_first_sector < 0 || p_sys->i_last_sector < 0 )
 237         {
 238             int i_titles;
 239             if( i_mrl_tracknum <= 0 )
 240             {
 241                 msg_Err( p_access, "wrong sector information" );
 242                 goto error;
 243             }
 244             i_titles = ioctl_GetTracksMap( VLC_OBJECT(p_access),
 245                                             p_sys->vcddev, &p_sys->p_sectors );
 246         }
 247
 248
 249         p_sys->i_sector = p_sys->i_first_sector;
 250         p_access->info.i_size = (p_sys->i_last_sector - p_sys->i_first_sector)
 251                                      * (int64_t)CDDA_DATA_SIZE;
 252     }
 253
 254     /* PTS delay */
 255     var_Create( p_access, "cdda-caching", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 256
 257     return VLC_SUCCESS;
 258
 259 error:
 260     ioctl_Close( VLC_OBJECT(p_access), p_sys->vcddev );
 261     free( p_sys );
 262     if( p_playlist ) vlc_object_release( p_playlist );
 263     return VLC_EGENERIC;
 264 }
 265
 266 /*****************************************************************************
 267  * Close: closes cdda
 268  *****************************************************************************/
 269 static void Close( vlc_object_t *p_this )
 270 {
 271     access_t     *p_access = (access_t *)p_this;
 272     access_sys_t *p_sys = p_access->p_sys;
 273     ioctl_Close( p_this, p_sys->vcddev );
 274     free( p_sys );
 275 }
 276
 277 /*****************************************************************************
 278  * Block: read data (CDDA_DATA_ONCE)
 279  *****************************************************************************/
 280 static block_t *Block( access_t *p_access )
 281 {
 282     access_sys_t *p_sys = p_access->p_sys;
 283     int i_blocks = CDDA_BLOCKS_ONCE;
 284     block_t *p_block;
 285
 286     if( p_sys->i_track < 0 ) p_access->info.b_eof = VLC_TRUE;
 287
 288     /* Check end of file */
 289     if( p_access->info.b_eof ) return NULL;
 290
 291     if( !p_sys->b_header )
 292     {
 293         /* Return only the header */
 294         p_block = block_New( p_access, sizeof( WAVEHEADER ) );
 295         memcpy( p_block->p_buffer, &p_sys->waveheader, sizeof(WAVEHEADER) );
 296         p_sys->b_header = VLC_TRUE;
 297         return p_block;
 298     }
 299
 300     if( p_sys->i_sector >= p_sys->i_last_sector )
 301     {
 302         p_access->info.b_eof = VLC_TRUE;
 303         return NULL;
 304     }
 305
 306     /* Don't read too far */
 307     if( p_sys->i_sector + i_blocks >= p_sys->i_last_sector )
 308         i_blocks = p_sys->i_last_sector - p_sys->i_sector;
 309
 310     /* Do the actual reading */
 311     if( !( p_block = block_New( p_access, i_blocks * CDDA_DATA_SIZE ) ) )
 312     {
 313         msg_Err( p_access, "cannot get a new block of size: %i",
 314                  i_blocks * CDDA_DATA_SIZE );
 315         return NULL;
 316     }
 317
 318     if( ioctl_ReadSectors( VLC_OBJECT(p_access), p_sys->vcddev,
 319             p_sys->i_sector, p_block->p_buffer, i_blocks, CDDA_TYPE ) < 0 )
 320     {
 321         msg_Err( p_access, "cannot read sector %i", p_sys->i_sector );
 322         block_Release( p_block );
 323
 324         /* Try to skip one sector (in case of bad sectors) */
 325         p_sys->i_sector++;
 326         p_access->info.i_pos += CDDA_DATA_SIZE;
 327         return NULL;
 328     }
 329
 330     /* Update a few values */
 331     p_sys->i_sector += i_blocks;
 332     p_access->info.i_pos += p_block->i_buffer;
 333
 334     return p_block;
 335 }
 336
 337 /****************************************************************************
 338  * Seek
 339  ****************************************************************************/
 340 static int Seek( access_t *p_access, int64_t i_pos )
 341 {
 342     access_sys_t *p_sys = p_access->p_sys;
 343
 344     /* Next sector to read */
 345     p_sys->i_sector = p_sys->i_first_sector + i_pos / CDDA_DATA_SIZE;
 346     p_access->info.i_pos = i_pos;
 347
 348     return VLC_SUCCESS;
 349 }
 350
 351 /*****************************************************************************
 352  * Control:
 353  *****************************************************************************/
 354 static int Control( access_t *p_access, int i_query, va_list args )
 355 {
 356     vlc_bool_t   *pb_bool;
 357     int          *pi_int;
 358     int64_t      *pi_64;
 359
 360     switch( i_query )
 361     {
 362         case ACCESS_CAN_SEEK:
 363         case ACCESS_CAN_FASTSEEK:
 364         case ACCESS_CAN_PAUSE:
 365         case ACCESS_CAN_CONTROL_PACE:
 366             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
 367             *pb_bool = VLC_TRUE;
 368             break;
 369
 370         case ACCESS_GET_MTU:
 371             pi_int = (int*)va_arg( args, int * );
 372             *pi_int = CDDA_DATA_ONCE;
 373             break;
 374
 375         case ACCESS_GET_PTS_DELAY:
 376             pi_64 = (int64_t*)va_arg( args, int64_t * );
 377             *pi_64 = var_GetInteger( p_access, "cdda-caching" ) * 1000;
 378             break;
 379
 380         case ACCESS_SET_PAUSE_STATE:
 381         case ACCESS_GET_TITLE_INFO:
 382         case ACCESS_SET_TITLE:
 383         case ACCESS_GET_META:
 384         case ACCESS_SET_SEEKPOINT:
 385         case ACCESS_SET_PRIVATE_ID_STATE:
 386             return VLC_EGENERIC;
 387
 388         default:
 389             msg_Warn( p_access, "unimplemented query in control" );
 390             return VLC_EGENERIC;
 391
 392     }
 393     return VLC_SUCCESS;
 394 }
 395
 396 static int GetTracks( access_t *p_access,
 397                       playlist_t *p_playlist, playlist_item_t *p_parent )
 398 {
 399     access_sys_t *p_sys = p_access->p_sys;
 400     int i, i_titles;
 401     input_item_t *p_input_item;
 402     playlist_item_t *p_item_in_category;
 403     char *psz_name;
 404     i_titles = ioctl_GetTracksMap( VLC_OBJECT(p_access),
 405                                    p_sys->vcddev, &p_sys->p_sectors );
 406     if( i_titles < 0 )
 407     {
 408         msg_Err( p_access, "unable to count tracks" );
 409         return VLC_EGENERIC;;
 410     }
 411     else if( i_titles <= 0 )
 412     {
 413         msg_Err( p_access, "no audio tracks found" );
 414         return VLC_EGENERIC;
 415     }
 416
 417     p_item_in_category = playlist_LockItemToNode( p_playlist, p_parent );
 418     psz_name = strdup( "Audio CD" );
 419     vlc_mutex_lock( &p_playlist->object_lock );
 420     playlist_ItemSetName( p_parent, psz_name );
 421     vlc_mutex_unlock( &p_playlist->object_lock );
 422     var_SetInteger( p_playlist, "item-change", p_parent->p_input->i_id );
 423     free( psz_name );
 424
 425 #ifdef HAVE_LIBCDDB
 426     GetCDDBInfo( p_access, i_titles, p_sys->p_sectors );
 427     if( p_sys->p_disc )
 428     {
 429         if( cddb_disc_get_title( p_sys->p_disc ) )
 430         {
 431             asprintf( &psz_name, "%s", cddb_disc_get_title( p_sys->p_disc ) );
 432             vlc_mutex_lock( &p_playlist->object_lock );
 433             playlist_ItemSetName( p_parent, psz_name );
 434             vlc_mutex_unlock( &p_playlist->object_lock );
 435             var_SetInteger( p_playlist, "item-change",
 436                             p_parent->p_input->i_id );
 437             free( psz_name );
 438         }
 439     }
 440 #endif
 441
 442     /* Build title table */
 443     for( i = 0; i < i_titles; i++ )
 444     {
 445         msg_Dbg( p_access, "track[%d] start=%d", i, p_sys->p_sectors[i] );
 446         char *psz_uri, *psz_opt, *psz_first, *psz_last;
 447         int i_path_len = p_access->psz_path ? strlen( p_access->psz_path ) : 0;
 448
 449         psz_name = (char*)malloc( strlen( _("Audio CD - Track ") ) + 5 );
 450         psz_opt = (char*)malloc( strlen( "cdda-track=" ) + 3 );
 451         psz_first = (char*)malloc( strlen( "cdda-first-sector=" ) + 7 );
 452         psz_last = (char*)malloc( strlen( "cdda-last-sector=" ) + 7 );
 453         psz_uri = (char*)malloc( i_path_len + 13 );
 454
 455         snprintf( psz_uri, i_path_len + 13, "cdda://%s",
 456                            p_access->psz_path ? p_access->psz_path : "" );
 457         sprintf( psz_opt, "cdda-track=%i", i+1 );
 458         sprintf( psz_first, "cdda-first-sector=%i",p_sys->p_sectors[i] );
 459
 460 //        if( i != i_titles -1 )
 461             sprintf( psz_last, "cdda-last-sector=%i", p_sys->p_sectors[i+1] );
 462 //         else
 463 //            sprintf( psz_last, "cdda-last-sector=%i", 1242 /* FIXME */);
 464
 465         /* Define a "default name" */
 466         sprintf( psz_name, _("Audio CD - Track %i"), (i+1) );
 467
 468         /* Create playlist items */
 469         p_input_item = input_ItemNewWithType( VLC_OBJECT( p_playlist ),
 470                                               psz_uri, psz_name, 0, NULL, -1,
 471                                               ITEM_TYPE_DISC );
 472         input_ItemAddOption( p_input_item, psz_first );
 473         input_ItemAddOption( p_input_item, psz_last );
 474         input_ItemAddOption( p_input_item, psz_opt );
 475
 476 #ifdef HAVE_LIBCDDB
 477         /* If we have CDDB info, change the name */
 478         if( p_sys->p_disc )
 479         {
 480             char *psz_result;
 481             cddb_track_t *t = cddb_disc_get_track( p_sys->p_disc, i );
 482             if( t!= NULL )
 483             {
 484                 if( cddb_track_get_title( t )  != NULL )
 485                 {
 486                     input_ItemAddInfo( p_input_item, _(VLC_META_INFO_CAT),
 487                                             _(VLC_META_TITLE),
 488                                             cddb_track_get_title( t ) );
 489                     if( p_input_item->psz_name )
 490                         free( p_input_item->psz_name );
 491                     asprintf( &p_input_item->psz_name, "%s",
 492                               cddb_track_get_title( t ) );
 493                 }
 494                 psz_result = cddb_track_get_artist( t );
 495                 if( psz_result )
 496                 {
 497                     input_ItemAddInfo( p_input_item, _(VLC_META_INFO_CAT),
 498                                             _(VLC_META_ARTIST), psz_result );
 499                 }
 500             }
 501         }
 502 #endif
 503         playlist_AddWhereverNeeded( p_playlist, p_input_item, p_parent,
 504                                p_item_in_category, VLC_FALSE, PLAYLIST_APPEND );
 505         free( psz_uri ); free( psz_opt ); free( psz_name );
 506         free( psz_first ); free( psz_last );
 507     }
 508     return VLC_SUCCESS;
 509 }
 510
 511 #ifdef HAVE_LIBCDDB
 512 static void GetCDDBInfo( access_t *p_access, int i_titles, int *p_sectors )
 513 {
 514     int i, i_matches;
 515     int64_t  i_length = 0, i_size = 0;
 516     cddb_conn_t  *p_cddb = cddb_new();
 517
 518     if( !p_cddb )
 519     {
 520         msg_Warn( p_access, "unable to use CDDB" );
 521         goto cddb_destroy;
 522     }
 523
 524     cddb_set_email_address( p_cddb, "vlc@videolan.org" );
 525     cddb_set_server_name( p_cddb, config_GetPsz( p_access, "cddb-server" ) );
 526     cddb_set_server_port( p_cddb, config_GetInt( p_access, "cddb-port" ) );
 527
 528     /// \todo
 529     cddb_cache_disable( p_cddb );
 530
 531 //    cddb_cache_set_dir( p_cddb,
 532 //                     config_GetPsz( p_access,
 533 //                                    MODULE_STRING "-cddb-cachedir") );
 534
 535     cddb_set_timeout( p_cddb, 10 );
 536
 537     /// \todo
 538     cddb_http_disable( p_cddb);
 539
 540     p_access->p_sys->p_disc = cddb_disc_new();
 541
 542     if(! p_access->p_sys->p_disc )
 543     {
 544         msg_Err( p_access, "unable to create CDDB disc structure." );
 545         goto cddb_end;
 546     }
 547
 548     for(i = 0; i < i_titles ; i++ )
 549     {
 550         cddb_track_t *t = cddb_track_new();
 551         cddb_track_set_frame_offset(t, p_sectors[i] );
 552         cddb_disc_add_track( p_access->p_sys->p_disc, t );
 553         i_size = ( p_sectors[i+1] - p_sectors[i] ) *
 554                    (int64_t)CDDA_DATA_SIZE;
 555         i_length += I64C(1000000) * i_size / 44100 / 4  ;
 556     }
 557
 558     cddb_disc_set_length( p_access->p_sys->p_disc, (int)(i_length/1000000) );
 559
 560     if (!cddb_disc_calc_discid(p_access->p_sys->p_disc ))
 561     {
 562         msg_Err( p_access, "CDDB disc ID calculation failed" );
 563         goto cddb_destroy;
 564     }
 565
 566     i_matches = cddb_query( p_cddb, p_access->p_sys->p_disc);
 567
 568     if (i_matches > 0)
 569     {
 570         if (i_matches > 1)
 571              msg_Warn( p_access, "found %d matches in CDDB. Using first one.",
 572                                  i_matches);
 573         cddb_read( p_cddb, p_access->p_sys->p_disc );
 574     }
 575     else
 576         msg_Warn( p_access, "CDDB error: %s", cddb_error_str(errno));
 577
 578 cddb_destroy:
 579     cddb_destroy( p_cddb);
 580
 581 cddb_end: ;
 582 }
 583 #endif /*HAVE_LIBCDDB*/