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