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