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