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     int i_ret;
 145
 146     if( !p_access->psz_path || !*p_access->psz_path )
 147     {
 148         /* Only when selected */
 149         if( !p_this->b_force ) return VLC_EGENERIC;
 150
 151         psz_name = var_CreateGetString( p_this, "cd-audio" );
 152         if( !psz_name || !*psz_name )
 153         {
 154             if( psz_name ) free( psz_name );
 155             return VLC_EGENERIC;
 156         }
 157     }
 158     else psz_name = strdup( p_access->psz_path );
 159
 160 #ifdef WIN32
 161     if( psz_name[0] && psz_name[1] == ':' &&
 162         psz_name[2] == '\\' && psz_name[3] == '\0' ) psz_name[2] = '\0';
 163 #endif
 164
 165     /* Open CDDA */
 166     if( (vcddev = ioctl_Open( VLC_OBJECT(p_access), psz_name )) == NULL )
 167     {
 168         msg_Warn( p_access, "could not open %s", psz_name );
 169         free( psz_name );
 170         return VLC_EGENERIC;
 171     }
 172     free( psz_name );
 173
 174     /* Set up p_access */
 175     STANDARD_BLOCK_ACCESS_INIT
 176     p_sys->vcddev = vcddev;
 177
 178    /* Do we play a single track ? */
 179    p_sys->i_track = var_CreateGetInteger( p_access, "cdda-track" );
 180
 181    if( p_sys->i_track < 0 && i_mrl_tracknum <= 0 )
 182    {
 183         /* We only do separate items if the whole disc is requested */
 184         playlist_t *p_playlist = pl_Yield( p_access );
 185
 186         i_ret = -1;
 187         if( p_playlist )
 188         {
 189             input_thread_t *p_input = (input_thread_t*)vlc_object_find( p_access, VLC_OBJECT_INPUT, FIND_PARENT );
 190             if( p_input )
 191             {
 192                 input_item_t *p_current = input_GetItem( p_input );
 193                 playlist_item_t *p_item;
 194
 195                 if( p_playlist->status.p_item->p_input == p_current )
 196                     p_item = p_playlist->status.p_item;
 197                 else
 198                     p_item = playlist_ItemGetByInput( p_playlist, p_current, VLC_FALSE );
 199
 200                 if( p_item )
 201                     i_ret = GetTracks( p_access, p_playlist, p_item );
 202                 else
 203                     msg_Dbg( p_playlist, "unable to find item in playlist");
 204                 vlc_object_release( p_input );
 205             }
 206             vlc_object_release( p_playlist );
 207         }
 208         if( i_ret < 0 )
 209             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     return VLC_EGENERIC;
 263 }
 264
 265 /*****************************************************************************
 266  * Close: closes cdda
 267  *****************************************************************************/
 268 static void Close( vlc_object_t *p_this )
 269 {
 270     access_t     *p_access = (access_t *)p_this;
 271     access_sys_t *p_sys = p_access->p_sys;
 272     ioctl_Close( p_this, p_sys->vcddev );
 273     free( p_sys );
 274 }
 275
 276 /*****************************************************************************
 277  * Block: read data (CDDA_DATA_ONCE)
 278  *****************************************************************************/
 279 static block_t *Block( access_t *p_access )
 280 {
 281     access_sys_t *p_sys = p_access->p_sys;
 282     int i_blocks = CDDA_BLOCKS_ONCE;
 283     block_t *p_block;
 284
 285     if( p_sys->i_track < 0 ) p_access->info.b_eof = VLC_TRUE;
 286
 287     /* Check end of file */
 288     if( p_access->info.b_eof ) return NULL;
 289
 290     if( !p_sys->b_header )
 291     {
 292         /* Return only the header */
 293         p_block = block_New( p_access, sizeof( WAVEHEADER ) );
 294         memcpy( p_block->p_buffer, &p_sys->waveheader, sizeof(WAVEHEADER) );
 295         p_sys->b_header = VLC_TRUE;
 296         return p_block;
 297     }
 298
 299     if( p_sys->i_sector >= p_sys->i_last_sector )
 300     {
 301         p_access->info.b_eof = VLC_TRUE;
 302         return NULL;
 303     }
 304
 305     /* Don't read too far */
 306     if( p_sys->i_sector + i_blocks >= p_sys->i_last_sector )
 307         i_blocks = p_sys->i_last_sector - p_sys->i_sector;
 308
 309     /* Do the actual reading */
 310     if( !( p_block = block_New( p_access, i_blocks * CDDA_DATA_SIZE ) ) )
 311     {
 312         msg_Err( p_access, "cannot get a new block of size: %i",
 313                  i_blocks * CDDA_DATA_SIZE );
 314         return NULL;
 315     }
 316
 317     if( ioctl_ReadSectors( VLC_OBJECT(p_access), p_sys->vcddev,
 318             p_sys->i_sector, p_block->p_buffer, i_blocks, CDDA_TYPE ) < 0 )
 319     {
 320         msg_Err( p_access, "cannot read sector %i", p_sys->i_sector );
 321         block_Release( p_block );
 322
 323         /* Try to skip one sector (in case of bad sectors) */
 324         p_sys->i_sector++;
 325         p_access->info.i_pos += CDDA_DATA_SIZE;
 326         return NULL;
 327     }
 328
 329     /* Update a few values */
 330     p_sys->i_sector += i_blocks;
 331     p_access->info.i_pos += p_block->i_buffer;
 332
 333     return p_block;
 334 }
 335
 336 /****************************************************************************
 337  * Seek
 338  ****************************************************************************/
 339 static int Seek( access_t *p_access, int64_t i_pos )
 340 {
 341     access_sys_t *p_sys = p_access->p_sys;
 342
 343     /* Next sector to read */
 344     p_sys->i_sector = p_sys->i_first_sector + i_pos / CDDA_DATA_SIZE;
 345     p_access->info.i_pos = i_pos;
 346
 347     return VLC_SUCCESS;
 348 }
 349
 350 /*****************************************************************************
 351  * Control:
 352  *****************************************************************************/
 353 static int Control( access_t *p_access, int i_query, va_list args )
 354 {
 355     vlc_bool_t   *pb_bool;
 356     int          *pi_int;
 357     int64_t      *pi_64;
 358
 359     switch( i_query )
 360     {
 361         case ACCESS_CAN_SEEK:
 362         case ACCESS_CAN_FASTSEEK:
 363         case ACCESS_CAN_PAUSE:
 364         case ACCESS_CAN_CONTROL_PACE:
 365             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
 366             *pb_bool = VLC_TRUE;
 367             break;
 368
 369         case ACCESS_GET_MTU:
 370             pi_int = (int*)va_arg( args, int * );
 371             *pi_int = CDDA_DATA_ONCE;
 372             break;
 373
 374         case ACCESS_GET_PTS_DELAY:
 375             pi_64 = (int64_t*)va_arg( args, int64_t * );
 376             *pi_64 = var_GetInteger( p_access, "cdda-caching" ) * 1000;
 377             break;
 378
 379         case ACCESS_SET_PAUSE_STATE:
 380         case ACCESS_GET_TITLE_INFO:
 381         case ACCESS_SET_TITLE:
 382         case ACCESS_GET_META:
 383         case ACCESS_SET_SEEKPOINT:
 384         case ACCESS_SET_PRIVATE_ID_STATE:
 385             return VLC_EGENERIC;
 386
 387         default:
 388             msg_Warn( p_access, "unimplemented query in control" );
 389             return VLC_EGENERIC;
 390
 391     }
 392     return VLC_SUCCESS;
 393 }
 394
 395 static int GetTracks( access_t *p_access,
 396                       playlist_t *p_playlist, playlist_item_t *p_parent )
 397 {
 398     access_sys_t *p_sys = p_access->p_sys;
 399     int i, i_titles;
 400     input_item_t *p_input_item;
 401     playlist_item_t *p_item_in_category;
 402     char *psz_name;
 403     i_titles = ioctl_GetTracksMap( VLC_OBJECT(p_access),
 404                                    p_sys->vcddev, &p_sys->p_sectors );
 405     if( i_titles < 0 )
 406     {
 407         msg_Err( p_access, "unable to count tracks" );
 408         return VLC_EGENERIC;;
 409     }
 410     else if( i_titles <= 0 )
 411     {
 412         msg_Err( p_access, "no audio tracks found" );
 413         return VLC_EGENERIC;
 414     }
 415
 416     p_item_in_category = playlist_ItemToNode( p_playlist, p_parent, VLC_FALSE );
 417     psz_name = strdup( "Audio CD" );
 418     vlc_mutex_lock( &p_playlist->object_lock );
 419     playlist_ItemSetName( p_parent, psz_name );
 420     vlc_mutex_unlock( &p_playlist->object_lock );
 421     var_SetInteger( p_playlist, "item-change", p_parent->p_input->i_id );
 422     free( psz_name );
 423
 424 #ifdef HAVE_LIBCDDB
 425     GetCDDBInfo( p_access, i_titles, p_sys->p_sectors );
 426     if( p_sys->p_disc )
 427     {
 428         if( cddb_disc_get_title( p_sys->p_disc ) )
 429         {
 430             asprintf( &psz_name, "%s", cddb_disc_get_title( p_sys->p_disc ) );
 431             vlc_mutex_lock( &p_playlist->object_lock );
 432             playlist_ItemSetName( p_parent, psz_name );
 433             vlc_mutex_unlock( &p_playlist->object_lock );
 434             var_SetInteger( p_playlist, "item-change",
 435                             p_parent->p_input->i_id );
 436             free( psz_name );
 437         }
 438     }
 439 #endif
 440
 441     /* Build title table */
 442     for( i = 0; i < i_titles; i++ )
 443     {
 444         msg_Dbg( p_access, "track[%d] start=%d", i, p_sys->p_sectors[i] );
 445         char *psz_uri, *psz_opt, *psz_first, *psz_last;
 446         int i_path_len = p_access->psz_path ? strlen( p_access->psz_path ) : 0;
 447
 448         psz_name = (char*)malloc( strlen( _("Audio CD - Track ") ) + 5 );
 449         psz_opt = (char*)malloc( strlen( "cdda-track=" ) + 3 );
 450         psz_first = (char*)malloc( strlen( "cdda-first-sector=" ) + 7 );
 451         psz_last = (char*)malloc( strlen( "cdda-last-sector=" ) + 7 );
 452         psz_uri = (char*)malloc( i_path_len + 13 );
 453
 454         snprintf( psz_uri, i_path_len + 13, "cdda://%s",
 455                            p_access->psz_path ? p_access->psz_path : "" );
 456         sprintf( psz_opt, "cdda-track=%i", i+1 );
 457         sprintf( psz_first, "cdda-first-sector=%i",p_sys->p_sectors[i] );
 458
 459 //        if( i != i_titles -1 )
 460             sprintf( psz_last, "cdda-last-sector=%i", p_sys->p_sectors[i+1] );
 461 //         else
 462 //            sprintf( psz_last, "cdda-last-sector=%i", 1242 /* FIXME */);
 463
 464         /* Define a "default name" */
 465         sprintf( psz_name, _("Audio CD - Track %i"), (i+1) );
 466
 467         /* Create playlist items */
 468         p_input_item = input_ItemNewWithType( VLC_OBJECT( p_playlist ),
 469                                               psz_uri, psz_name, 0, NULL, -1,
 470                                               ITEM_TYPE_DISC );
 471         input_ItemAddOption( p_input_item, psz_first );
 472         input_ItemAddOption( p_input_item, psz_last );
 473         input_ItemAddOption( p_input_item, psz_opt );
 474
 475 #ifdef HAVE_LIBCDDB
 476         /* If we have CDDB info, change the name */
 477         if( p_sys->p_disc )
 478         {
 479             const char *psz_result;
 480             cddb_track_t *t = cddb_disc_get_track( p_sys->p_disc, i );
 481             if( t!= NULL )
 482             {
 483                 if( cddb_track_get_title( t )  != NULL )
 484                 {
 485                     input_ItemAddInfo( p_input_item, _(VLC_META_INFO_CAT),
 486                                             _(VLC_META_TITLE),
 487                                             cddb_track_get_title( t ) );
 488                     if( p_input_item->psz_name )
 489                         free( p_input_item->psz_name );
 490                     asprintf( &p_input_item->psz_name, "%s",
 491                               cddb_track_get_title( t ) );
 492                 }
 493                 psz_result = cddb_track_get_artist( t );
 494                 if( psz_result )
 495                 {
 496                     input_ItemAddInfo( p_input_item, _(VLC_META_INFO_CAT),
 497                                             _(VLC_META_ARTIST), psz_result );
 498                 }
 499             }
 500         }
 501 #endif
 502         playlist_BothAddInput( p_playlist, p_input_item, p_item_in_category,
 503                                PLAYLIST_APPEND, PLAYLIST_END, NULL, NULL,
 504                                VLC_FALSE );
 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*/