git.sesse.net Git - vlc/blob - modules/demux/voc.c

   1 /*****************************************************************************
   2  * voc.c : Creative Voice File (.VOC) demux module for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2005 VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Remi Denis-Courmont <rem # via.ecp.fr>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #include <stdlib.h>                                      /* malloc(), free() */
  28
  29 #include <vlc/vlc.h>
  30 #include <vlc/input.h>
  31 #include <vlc/aout.h>
  32
  33 #include <codecs.h>
  34
  35 /*****************************************************************************
  36  * Module descriptor
  37  *****************************************************************************/
  38 static int  Open ( vlc_object_t * );
  39 static void Close( vlc_object_t * );
  40
  41 vlc_module_begin();
  42     set_description( _("VOC demuxer") );
  43     set_category( CAT_INPUT );
  44     set_subcategory( SUBCAT_INPUT_DEMUX );
  45     set_capability( "demux2", 10 );
  46     set_callbacks( Open, Close );
  47 vlc_module_end();
  48
  49 /*****************************************************************************
  50  * Local prototypes
  51  *****************************************************************************/
  52 static int Demux  ( demux_t * );
  53 static int Control( demux_t *, int i_query, va_list args );
  54
  55 struct demux_sys_t
  56 {
  57     es_format_t     fmt;
  58     es_out_id_t     *p_es;
  59
  60     int64_t         i_block_offset;
  61
  62     int64_t         i_loop_offset;
  63     unsigned        i_loop_count;
  64     unsigned        i_silence_countdown;
  65
  66     int32_t         i_block_size;
  67
  68     date_t          pts;
  69 };
  70
  71 static const char ct_header[] = "Creative Voice File\x1a";
  72
  73 /*****************************************************************************
  74  * Open: check file and initializes structures
  75  *****************************************************************************/
  76 static int Open( vlc_object_t * p_this )
  77 {
  78     demux_t     *p_demux = (demux_t*)p_this;
  79     demux_sys_t *p_sys;
  80     uint8_t     *p_buf;
  81     uint16_t    i_data_offset, i_version;
  82
  83     if( stream_Peek( p_demux->s, &p_buf, 26 ) < 26 )
  84         return VLC_EGENERIC;
  85
  86     if( memcmp( p_buf, ct_header, 20 ) )
  87         return VLC_EGENERIC;
  88     p_buf += 20;
  89
  90     i_data_offset = GetWLE( p_buf );
  91     if ( i_data_offset < 26 /* not enough room for full VOC header */ )
  92         return VLC_EGENERIC;
  93     p_buf += 2;
  94
  95     i_version = GetWLE( p_buf );
  96     if( ( i_version != 0x10A ) && ( i_version != 0x114 ) )
  97         return VLC_EGENERIC; /* unknown VOC version */
  98     p_buf += 2;
  99
 100     if( GetWLE( p_buf ) != (uint16_t)(0x1234 + ~i_version) )
 101         return VLC_EGENERIC;
 102
 103     /* We have a valid VOC header */
 104     msg_Dbg( p_demux, "CT Voice file v%d.%d", i_version >> 8,
 105              i_version & 0xff );
 106
 107     /* skip VOC header */
 108     if( stream_Read( p_demux->s, NULL, i_data_offset ) < i_data_offset )
 109         return VLC_EGENERIC;
 110
 111     p_demux->pf_demux   = Demux;
 112     p_demux->pf_control = Control;
 113     p_demux->p_sys      = p_sys = malloc( sizeof( demux_sys_t ) );
 114     if( p_sys == NULL )
 115         return VLC_ENOMEM;
 116
 117     p_sys->i_silence_countdown = p_sys->i_block_offset = p_sys->i_block_size =
 118     p_sys->i_loop_count = 0;
 119     p_sys->p_es = NULL;
 120
 121     date_Init( &p_sys->pts, 1, 1 );
 122     date_Set( &p_sys->pts, 1 );
 123
 124     return VLC_SUCCESS;
 125 }
 126
 127
 128 static int fmtcmp( es_format_t *ofmt, es_format_t *nfmt )
 129 {
 130     return (ofmt->audio.i_bitspersample != nfmt->audio.i_bitspersample)
 131         || (ofmt->audio.i_rate != nfmt->audio.i_rate)
 132         || (ofmt->audio.i_channels != nfmt->audio.i_channels);
 133 }
 134
 135
 136 static int ReadBlockHeader( demux_t *p_demux )
 137 {
 138     es_format_t     new_fmt;
 139     uint8_t buf[8];
 140     int32_t i_block_size;
 141     demux_sys_t *p_sys = p_demux->p_sys;
 142
 143     if( stream_Read( p_demux->s, buf, 4 ) < 4 )
 144         return VLC_EGENERIC; /* EOF */
 145
 146     i_block_size = GetDWLE( buf ) >> 8;
 147     msg_Dbg( p_demux, "new block: type: %u, size: %u",
 148              (unsigned)*buf, i_block_size );
 149
 150     es_format_Init( &new_fmt, AUDIO_ES, 0 );
 151
 152     switch( *buf )
 153     {
 154         case 0: /* not possible : caught with earlier stream_Read */
 155             goto corrupt;
 156
 157         case 1:
 158             if( i_block_size < 2 )
 159                 goto corrupt;
 160             i_block_size -= 2;
 161
 162             if( stream_Read( p_demux->s, buf, 2 ) < 2 )
 163                 goto corrupt;
 164
 165             new_fmt.audio.i_rate = 1000000L / (256L - buf[0]);
 166             if( buf[1] )
 167             {
 168                 msg_Err( p_demux, "Unsupported compression" );
 169                 return VLC_EGENERIC;
 170             }
 171
 172             new_fmt.i_codec = VLC_FOURCC('u','8',' ',' ');
 173             new_fmt.audio.i_bytes_per_frame = 1;
 174             new_fmt.audio.i_frame_length = 1;
 175             new_fmt.audio.i_channels = 1;
 176             new_fmt.audio.i_blockalign = 1;
 177             new_fmt.audio.i_bitspersample = 8;
 178             new_fmt.i_bitrate = p_sys->fmt.audio.i_rate * 8;
 179             break;
 180
 181         case 2: /* data block with same format as the previous one */
 182             if( p_sys->p_es == NULL )
 183                 goto corrupt; /* no previous block! */
 184
 185             memcpy( &new_fmt, &p_sys->fmt, sizeof( new_fmt ) );
 186             break;
 187
 188         case 3: /* silence block */
 189             if( ( i_block_size != 3 )
 190              || ( stream_Read( p_demux->s, buf, 3 ) < 3 ) )
 191                 goto corrupt;
 192
 193             i_block_size = 0;
 194             p_sys->i_silence_countdown = GetWLE( buf );
 195
 196             new_fmt.audio.i_rate = 1000000L / (256L - buf[2]);
 197             new_fmt.i_codec = VLC_FOURCC('u','8',' ',' ');
 198             new_fmt.audio.i_bytes_per_frame = 1;
 199             new_fmt.audio.i_frame_length = 1;
 200             new_fmt.audio.i_channels = 1;
 201             new_fmt.audio.i_blockalign = 1;
 202             new_fmt.audio.i_bitspersample = 8;
 203             new_fmt.i_bitrate = p_sys->fmt.audio.i_rate * 8;
 204             break;
 205
 206         case 6: /* repeat block */
 207             if( ( i_block_size != 2 )
 208              || ( stream_Read( p_demux->s, buf, 2 ) < 2 ) )
 209                 goto corrupt;
 210
 211             i_block_size = 0;
 212             p_sys->i_loop_count = GetWLE( buf );
 213             p_sys->i_loop_offset = stream_Tell( p_demux->s );
 214             break;
 215
 216         case 7: /* repeat end block */
 217             if( i_block_size != 0 )
 218                 goto corrupt;
 219
 220             if( p_sys->i_loop_count > 0 )
 221             {
 222                 if( stream_Seek( p_demux->s, p_sys->i_loop_offset ) )
 223                     msg_Warn( p_demux, "cannot loop: seek failed" );
 224                 else
 225                     p_sys->i_loop_count--;
 226             }
 227             break;
 228
 229         /* FIXME: support block type 8 properly */
 230         case 8:
 231             msg_Err( p_demux, "Unimplemented block type 8" );
 232             return VLC_EGENERIC;
 233
 234         case 9:
 235             if( i_block_size < 12 )
 236                 goto corrupt;
 237             i_block_size -= 12;
 238
 239             if( ( stream_Read( p_demux->s, buf, 8 ) < 8 )
 240              || ( stream_Read( p_demux->s, NULL, 4 ) < 4 ) )
 241                 goto corrupt;
 242
 243             new_fmt.audio.i_rate = GetDWLE( buf );
 244             new_fmt.audio.i_bitspersample = buf[4];
 245             new_fmt.audio.i_channels = buf[5];
 246
 247             switch( GetWLE( &buf[6] ) ) /* format */
 248             {
 249                 case 0x0000: /* PCM */
 250                     switch( new_fmt.audio.i_bitspersample )
 251                     {
 252                         case 8:
 253                             new_fmt.i_codec = VLC_FOURCC('u','8',' ',' ');
 254                             break;
 255
 256                         case 16:
 257                             new_fmt.i_codec = VLC_FOURCC('u','1','6','l');
 258                             break;
 259
 260                         default:
 261                             msg_Err( p_demux, "Unsupported bit res.: %u bits",
 262                                      new_fmt.audio.i_bitspersample );
 263                             return VLC_EGENERIC;
 264                     }
 265                     break;
 266
 267                 case 0x0004: /* signed */
 268                     switch( new_fmt.audio.i_bitspersample )
 269                     {
 270                         case 8:
 271                             new_fmt.i_codec = VLC_FOURCC('s','8',' ',' ');
 272                             break;
 273
 274                         case 16:
 275                             new_fmt.i_codec = VLC_FOURCC('s','1','6','l');
 276                             break;
 277
 278                         default:
 279                             msg_Err( p_demux, "Unsupported bit res.: %u bits",
 280                                      new_fmt.audio.i_bitspersample );
 281                             return VLC_EGENERIC;
 282                     }
 283                     break;
 284
 285                 default:
 286                     msg_Err( p_demux, "Unsupported compression" );
 287                     return VLC_EGENERIC;
 288             }
 289
 290             new_fmt.audio.i_bytes_per_frame = new_fmt.audio.i_channels
 291                 * (new_fmt.audio.i_bitspersample / 8);
 292             new_fmt.audio.i_frame_length = 1;
 293             new_fmt.audio.i_blockalign = p_sys->fmt.audio.i_bytes_per_frame;
 294             new_fmt.i_bitrate = 8 * new_fmt.audio.i_rate
 295                                      * new_fmt.audio.i_bytes_per_frame;
 296             break;
 297
 298         default:
 299             msg_Dbg( p_demux, "Unknown block type %u - skipping block",
 300                      (unsigned)*buf);
 301         case 4: /* blocks of non-audio types can be skipped */
 302         case 5:
 303             if( stream_Read( p_demux->s, NULL, i_block_size ) < i_block_size )
 304                 goto corrupt;
 305             i_block_size = 0;
 306             break;
 307     }
 308
 309     p_sys->i_block_size = i_block_size;
 310     p_sys->i_block_offset = stream_Tell( p_demux->s );
 311
 312     if( i_block_size || p_sys->i_silence_countdown )
 313     {
 314         /* we've read a block with data in it - update decoder */
 315         msg_Dbg( p_demux, "fourcc: %4.4s, channels: %d, "
 316                  "freq: %d Hz, bitrate: %dKo/s, blockalign: %d, "
 317                  "bits/samples: %d", (char *)&new_fmt.i_codec,
 318                  new_fmt.audio.i_channels, new_fmt.audio.i_rate,
 319                  new_fmt.i_bitrate / 8192, new_fmt.audio.i_blockalign,
 320                  new_fmt.audio.i_bitspersample );
 321
 322         if( ( p_sys->p_es != NULL ) && fmtcmp( &p_sys->fmt, &new_fmt ) )
 323         {
 324             msg_Dbg( p_demux, "codec change needed" );
 325             es_out_Del( p_demux->out, p_sys->p_es );
 326             p_sys->p_es = NULL;
 327         }
 328
 329         if( p_sys->p_es == NULL )
 330         {
 331             memcpy( &p_sys->fmt, &new_fmt, sizeof( p_sys->fmt ) );
 332             date_Change( &p_sys->pts, p_sys->fmt.audio.i_rate, 1 );
 333             p_sys->p_es = es_out_Add( p_demux->out, &p_sys->fmt );
 334         }
 335     }
 336
 337     return VLC_SUCCESS;
 338
 339 corrupt:
 340     msg_Err( p_demux, "corrupted file - halting demux" );
 341     return VLC_EGENERIC;
 342 }
 343
 344 /*****************************************************************************
 345  * Demux: read packet and send them to decoders
 346  *****************************************************************************
 347  * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
 348  *****************************************************************************/
 349 static int Demux( demux_t *p_demux )
 350 {
 351     demux_sys_t *p_sys = p_demux->p_sys;
 352     block_t     *p_block;
 353     int64_t     i_offset;
 354
 355     if( p_sys->i_silence_countdown == 0 )
 356     {
 357         i_offset = stream_Tell( p_demux->s );
 358
 359         while( ( i_offset >= p_sys->i_block_offset + p_sys->i_block_size )
 360              && ( p_sys->i_silence_countdown == 0 ) )
 361             if( ReadBlockHeader( p_demux ) != VLC_SUCCESS )
 362                 return 0;
 363
 364         p_block = stream_Block( p_demux->s,
 365                                 p_sys->fmt.audio.i_bytes_per_frame );
 366         if( p_block == NULL )
 367         {
 368             msg_Warn( p_demux, "cannot read data" );
 369             return 0;
 370         }
 371     }
 372     else
 373     {   /* emulates silence from the stream */
 374         p_block = block_New( p_demux, 1 );
 375         if( p_block == NULL )
 376             return VLC_ENOMEM;
 377
 378         p_block->p_buffer[0] = 0;
 379         p_sys->i_silence_countdown--;
 380     }
 381
 382     p_block->i_dts = p_block->i_pts =
 383         date_Increment( &p_sys->pts, p_sys->fmt.audio.i_frame_length );
 384
 385     es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block->i_pts );
 386
 387     es_out_Send( p_demux->out, p_sys->p_es, p_block );
 388
 389     return 1;
 390 }
 391
 392 /*****************************************************************************
 393  * Close: frees unused data
 394  *****************************************************************************/
 395 static void Close ( vlc_object_t * p_this )
 396 {
 397     demux_sys_t *p_sys  = ((demux_t *)p_this)->p_sys;
 398
 399     free( p_sys );
 400 }
 401
 402 /*****************************************************************************
 403  * Control:
 404  *****************************************************************************/
 405 static int Control( demux_t *p_demux, int i_query, va_list args )
 406 {
 407     demux_sys_t *p_sys  = p_demux->p_sys;
 408
 409     return demux2_vaControlHelper( p_demux->s, p_sys->i_block_offset,
 410                                    p_sys->i_block_offset + p_sys->i_block_size,
 411                                    p_sys->fmt.i_bitrate,
 412                                    p_sys->fmt.audio.i_blockalign,
 413                                    i_query, args );
 414 }