modules/demux/nsv.c

   1 /*****************************************************************************
   2  * nsv.c: NullSoft Video demuxer.
   3  *****************************************************************************
   4  * Copyright (C) 2004-2007 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc_common.h>
  33 #include <vlc_plugin.h>
  34 #include <vlc_demux.h>
  35
  36 /* TODO:
  37  *  - implement NSVf parsing (to get meta data)
  38  *  - implement missing Control (and in the right way)
  39  *  - ...
  40  */
  41
  42 /*****************************************************************************
  43  * Module descriptor
  44  *****************************************************************************/
  45 static int  Open    ( vlc_object_t * );
  46 static void Close  ( vlc_object_t * );
  47
  48 vlc_module_begin ()
  49     set_description( N_("NullSoft demuxer" ) )
  50     set_capability( "demux", 10 )
  51     set_category( CAT_INPUT )
  52     set_subcategory( SUBCAT_INPUT_DEMUX )
  53     set_callbacks( Open, Close )
  54     add_shortcut( "nsv" )
  55 vlc_module_end ()
  56
  57 /*****************************************************************************
  58  * Local prototypes
  59  *****************************************************************************/
  60
  61 struct demux_sys_t
  62 {
  63     es_format_t  fmt_audio;
  64     es_out_id_t *p_audio;
  65
  66     es_format_t  fmt_video;
  67     es_out_id_t *p_video;
  68
  69     es_format_t  fmt_sub;
  70     es_out_id_t  *p_sub;
  71
  72     int64_t     i_pcr;
  73     int64_t     i_time;
  74     int64_t     i_pcr_inc;
  75
  76     bool b_start_record;
  77 };
  78
  79 static int Demux  ( demux_t *p_demux );
  80 static int Control( demux_t *p_demux, int i_query, va_list args );
  81
  82 static int ReSynch( demux_t *p_demux );
  83
  84 static int ReadNSVf( demux_t *p_demux );
  85 static int ReadNSVs( demux_t *p_demux );
  86
  87 /*****************************************************************************
  88  * Open
  89  *****************************************************************************/
  90 static int Open( vlc_object_t *p_this )
  91 {
  92     demux_t     *p_demux = (demux_t*)p_this;
  93     demux_sys_t *p_sys;
  94
  95     const uint8_t *p_peek;
  96
  97     if( vlc_stream_Peek( p_demux->s, &p_peek, 8 ) < 8 )
  98         return VLC_EGENERIC;
  99
 100     if( memcmp( p_peek, "NSVf", 4 ) && memcmp( p_peek, "NSVs", 4 ) )
 101     {
 102        /* In case we had force this demuxer we try to resynch */
 103         if( !p_demux->obj.force || ReSynch( p_demux ) )
 104             return VLC_EGENERIC;
 105     }
 106
 107     p_sys = malloc( sizeof( demux_sys_t ) );
 108     if( unlikely(p_sys == NULL) )
 109         return VLC_ENOMEM;
 110
 111     /* Fill p_demux field */
 112     p_demux->p_sys = p_sys;
 113     p_demux->pf_demux = Demux;
 114     p_demux->pf_control = Control;
 115
 116     es_format_Init( &p_sys->fmt_audio, AUDIO_ES, 0 );
 117     p_sys->p_audio = NULL;
 118
 119     es_format_Init( &p_sys->fmt_video, VIDEO_ES, 0 );
 120     p_sys->p_video = NULL;
 121
 122     es_format_Init( &p_sys->fmt_sub, SPU_ES, 0 );
 123     p_sys->p_sub = NULL;
 124
 125     p_sys->i_pcr   = 0;
 126     p_sys->i_time  = 0;
 127     p_sys->i_pcr_inc = 0;
 128
 129     p_sys->b_start_record = false;
 130
 131     return VLC_SUCCESS;
 132 }
 133
 134 /*****************************************************************************
 135  * Close
 136  *****************************************************************************/
 137 static void Close( vlc_object_t *p_this )
 138 {
 139     demux_t     *p_demux = (demux_t*)p_this;
 140     demux_sys_t *p_sys = p_demux->p_sys;
 141
 142     free( p_sys );
 143 }
 144
 145
 146 /*****************************************************************************
 147  * Demux:
 148  *****************************************************************************/
 149 static int Demux( demux_t *p_demux )
 150 {
 151     demux_sys_t *p_sys = p_demux->p_sys;
 152
 153     uint8_t     header[5];
 154     const uint8_t *p_peek;
 155
 156     int         i_size;
 157     block_t     *p_frame;
 158
 159     for( ;; )
 160     {
 161         if( vlc_stream_Peek( p_demux->s, &p_peek, 8 ) < 8 )
 162         {
 163             msg_Warn( p_demux, "cannot peek" );
 164             return 0;
 165         }
 166
 167         if( !memcmp( p_peek, "NSVf", 4 ) )
 168         {
 169             if( ReadNSVf( p_demux ) )
 170                 return -1;
 171         }
 172         else if( !memcmp( p_peek, "NSVs", 4 ) )
 173         {
 174             if( p_sys->b_start_record )
 175             {
 176                 /* Enable recording once synchronized */
 177                 vlc_stream_Control( p_demux->s, STREAM_SET_RECORD_STATE, true, "nsv" );
 178                 p_sys->b_start_record = false;
 179             }
 180
 181             if( ReadNSVs( p_demux ) )
 182                 return -1;
 183             break;
 184         }
 185         else if( GetWLE( p_peek ) == 0xbeef )
 186         {
 187             /* Next frame of the current NSVs chunk */
 188             if( vlc_stream_Read( p_demux->s, NULL, 2 ) < 2 )
 189             {
 190                 msg_Warn( p_demux, "cannot read" );
 191                 return 0;
 192             }
 193             break;
 194         }
 195         else
 196         {
 197             msg_Err( p_demux, "invalid signature 0x%x (%4.4s)", GetDWLE( p_peek ), (const char*)p_peek );
 198             if( ReSynch( p_demux ) )
 199                 return -1;
 200         }
 201     }
 202
 203     if( vlc_stream_Read( p_demux->s, header, 5 ) < 5 )
 204     {
 205         msg_Warn( p_demux, "cannot read" );
 206         return 0;
 207     }
 208
 209     /* Set PCR */
 210     es_out_SetPCR( p_demux->out, VLC_TS_0 + p_sys->i_pcr );
 211
 212     /* Read video */
 213     i_size = ( header[0] >> 4 ) | ( header[1] << 4 ) | ( header[2] << 12 );
 214     if( i_size > 0 )
 215     {
 216         /* extra data ? */
 217         if( (header[0]&0x0f) != 0x0 )
 218         {
 219             uint8_t      aux[6];
 220             int          i_aux;
 221             vlc_fourcc_t fcc;
 222             if( vlc_stream_Read( p_demux->s, aux, 6 ) < 6 )
 223             {
 224                 msg_Warn( p_demux, "cannot read" );
 225                 return 0;
 226             }
 227             i_aux = GetWLE( aux );
 228             fcc   = VLC_FOURCC( aux[2], aux[3], aux[4], aux[5] );
 229
 230             msg_Dbg( p_demux, "Belekas: %d - size=%d fcc=%4.4s",
 231                      header[0]&0xf, i_aux, (char*)&fcc );
 232
 233             if( fcc == VLC_FOURCC( 'S', 'U', 'B', 'T' ) && i_aux > 2 )
 234             {
 235                 if( p_sys->p_sub == NULL )
 236                 {
 237                     p_sys->fmt_sub.i_codec = VLC_FOURCC( 's', 'u', 'b', 't' );
 238                     p_sys->p_sub = es_out_Add( p_demux->out, &p_sys->fmt_sub );
 239                     es_out_Control( p_demux->out, ES_OUT_SET_ES, p_sys->p_sub );
 240                 }
 241                 if( vlc_stream_Read( p_demux->s, NULL, 2 ) < 2 )
 242                     return 0;
 243
 244                 if( ( p_frame = vlc_stream_Block( p_demux->s, i_aux - 2 ) ) )
 245                 {
 246                     uint8_t *p = p_frame->p_buffer;
 247
 248                     while( p < &p_frame->p_buffer[p_frame->i_buffer] && *p != 0 )
 249                     {
 250                         p++;
 251                     }
 252                     if( *p == 0 && p + 1 < &p_frame->p_buffer[p_frame->i_buffer] )
 253                     {
 254                         p_frame->i_buffer -= p + 1 - p_frame->p_buffer;
 255                         p_frame->p_buffer = p + 1;
 256                     }
 257
 258                     /* Skip the first part (it is the language name) */
 259                     p_frame->i_pts = VLC_TS_0 + p_sys->i_pcr;
 260                     p_frame->i_dts = VLC_TS_0 + p_sys->i_pcr + 4000000;    /* 4s */
 261
 262                     es_out_Send( p_demux->out, p_sys->p_sub, p_frame );
 263                 }
 264             }
 265             else
 266             {
 267                 /* We skip this extra data */
 268                 if( vlc_stream_Read( p_demux->s, NULL, i_aux ) < i_aux )
 269                 {
 270                     msg_Warn( p_demux, "cannot read" );
 271                     return 0;
 272                 }
 273             }
 274             i_size -= 6 + i_aux;
 275         }
 276
 277         /* msg_Dbg( p_demux, "frame video size=%d", i_size ); */
 278         if( i_size > 0 && ( p_frame = vlc_stream_Block( p_demux->s, i_size ) ) )
 279         {
 280             p_frame->i_dts = VLC_TS_0 + p_sys->i_pcr;
 281
 282             if( p_sys->p_video )
 283                 es_out_Send( p_demux->out, p_sys->p_video, p_frame );
 284             else
 285             {
 286                 block_Release( p_frame );
 287                 msg_Dbg( p_demux, "ignoring unsupported video frame (size=%d)",
 288                          i_size );
 289             }
 290         }
 291     }
 292
 293     /* Read audio */
 294     i_size = header[3] | ( header[4] << 8 );
 295     if( i_size > 0 )
 296     {
 297         /* msg_Dbg( p_demux, "frame audio size=%d", i_size ); */
 298         if( p_sys->fmt_audio.i_codec == VLC_FOURCC( 'a', 'r', 'a', 'w' ) )
 299         {
 300             uint8_t h[4];
 301             if( vlc_stream_Read( p_demux->s, h, 4 ) < 4 )
 302                 return 0;
 303
 304             p_sys->fmt_audio.audio.i_channels = h[1];
 305             p_sys->fmt_audio.audio.i_rate = GetWLE( &h[2] );
 306
 307             i_size -= 4;
 308         }
 309         if( p_sys->p_audio == NULL )
 310         {
 311             p_sys->p_audio = es_out_Add( p_demux->out, &p_sys->fmt_audio );
 312         }
 313
 314         if( ( p_frame = vlc_stream_Block( p_demux->s, i_size ) ) )
 315         {
 316             p_frame->i_dts =
 317             p_frame->i_pts = VLC_TS_0 + p_sys->i_pcr;
 318
 319             if( p_sys->p_audio )
 320                 es_out_Send( p_demux->out, p_sys->p_audio, p_frame );
 321             else
 322             {
 323                 block_Release( p_frame );
 324                 msg_Dbg( p_demux, "ignoring unsupported audio frame (size=%d)",
 325                          i_size );
 326             }
 327         }
 328     }
 329
 330     p_sys->i_pcr += p_sys->i_pcr_inc;
 331     if( p_sys->i_time >= 0 )
 332     {
 333         p_sys->i_time += p_sys->i_pcr_inc;
 334     }
 335
 336     return 1;
 337 }
 338
 339 /*****************************************************************************
 340  * Control:
 341  *****************************************************************************/
 342 static int Control( demux_t *p_demux, int i_query, va_list args )
 343 {
 344     demux_sys_t *p_sys = p_demux->p_sys;
 345     double f, *pf;
 346     bool b_bool, *pb_bool;
 347     int64_t i64, *pi64;
 348
 349     switch( i_query )
 350     {
 351         case DEMUX_CAN_SEEK:
 352             return vlc_stream_vaControl( p_demux->s, i_query, args );
 353
 354         case DEMUX_GET_POSITION:
 355             pf = va_arg( args, double * );
 356             i64 = stream_Size( p_demux->s );
 357             if( i64 > 0 )
 358             {
 359                 double current = vlc_stream_Tell( p_demux->s );
 360                 *pf = current / (double)i64;
 361             }
 362             else
 363             {
 364                 *pf = 0.0;
 365             }
 366             return VLC_SUCCESS;
 367
 368         case DEMUX_SET_POSITION:
 369             f = va_arg( args, double );
 370             i64 = stream_Size( p_demux->s );
 371
 372             if( vlc_stream_Seek( p_demux->s, (int64_t)(i64 * f) ) || ReSynch( p_demux ) )
 373                 return VLC_EGENERIC;
 374
 375             p_sys->i_time = -1; /* Invalidate time display */
 376             return VLC_SUCCESS;
 377
 378         case DEMUX_GET_TIME:
 379             pi64 = va_arg( args, int64_t * );
 380             if( p_sys->i_time < 0 )
 381             {
 382                 *pi64 = 0;
 383                 return VLC_EGENERIC;
 384             }
 385             *pi64 = p_sys->i_time;
 386             return VLC_SUCCESS;
 387
 388 #if 0
 389         case DEMUX_GET_LENGTH:
 390             pi64 = va_arg( args, int64_t * );
 391             if( p_sys->i_mux_rate > 0 )
 392             {
 393                 *pi64 = (int64_t)1000000 * ( stream_Size( p_demux->s ) / 50 ) / p_sys->i_mux_rate;
 394                 return VLC_SUCCESS;
 395             }
 396             *pi64 = 0;
 397             return VLC_EGENERIC;
 398
 399 #endif
 400         case DEMUX_GET_FPS:
 401             pf = va_arg( args, double * );
 402             *pf = (double)1000000.0 / (double)p_sys->i_pcr_inc;
 403             return VLC_SUCCESS;
 404
 405         case DEMUX_CAN_RECORD:
 406             pb_bool = va_arg( args, bool * );
 407             *pb_bool = true;
 408             return VLC_SUCCESS;
 409
 410         case DEMUX_SET_RECORD_STATE:
 411             b_bool = (bool)va_arg( args, int );
 412
 413             if( !b_bool )
 414                 vlc_stream_Control( p_demux->s, STREAM_SET_RECORD_STATE, false );
 415             p_sys->b_start_record = b_bool;
 416             return VLC_SUCCESS;
 417
 418
 419         case DEMUX_SET_TIME:
 420         default:
 421             return VLC_EGENERIC;
 422     }
 423 }
 424
 425 /*****************************************************************************
 426  * ReSynch:
 427  *****************************************************************************/
 428 static int ReSynch( demux_t *p_demux )
 429 {
 430     for( ;; )
 431     {
 432         const uint8_t *p_peek;
 433         int i_peek = vlc_stream_Peek( p_demux->s, &p_peek, 1024 );
 434         if( i_peek < 8 )
 435             break;
 436
 437         int i_skip = 0;
 438
 439         while( i_skip < i_peek - 4 )
 440         {
 441             if( !memcmp( p_peek, "NSVf", 4 )
 442              || !memcmp( p_peek, "NSVs", 4 ) )
 443             {
 444                 if( i_skip > 0
 445                  && vlc_stream_Read( p_demux->s, NULL, i_skip ) )
 446                     return VLC_EGENERIC;
 447                 return VLC_SUCCESS;
 448             }
 449             p_peek++;
 450             i_skip++;
 451         }
 452
 453         if( vlc_stream_Read( p_demux->s, NULL, i_skip ) < i_skip )
 454             break;
 455     }
 456     return VLC_EGENERIC;
 457 }
 458
 459 /*****************************************************************************
 460  * ReadNSVf:
 461  *****************************************************************************/
 462 static int ReadNSVf( demux_t *p_demux )
 463 {
 464     /* demux_sys_t *p_sys = p_demux->p_sys; */
 465     const uint8_t     *p;
 466
 467     msg_Dbg( p_demux, "new NSVf chunk" );
 468     if( vlc_stream_Peek( p_demux->s, &p, 8 ) < 8 )
 469     {
 470         return VLC_EGENERIC;
 471     }
 472
 473     uint32_t i_header_size = GetDWLE( &p[4] );
 474     msg_Dbg( p_demux, "    - size=%" PRIu32, i_header_size );
 475
 476     if( i_header_size == 0 || i_header_size == UINT32_MAX )
 477         return VLC_EGENERIC;
 478
 479
 480     return vlc_stream_Read( p_demux->s, NULL, i_header_size ) == i_header_size
 481         ? VLC_SUCCESS : VLC_EGENERIC;
 482 }
 483 /*****************************************************************************
 484  * ReadNSVs:
 485  *****************************************************************************/
 486 static int ReadNSVs( demux_t *p_demux )
 487 {
 488     demux_sys_t *p_sys = p_demux->p_sys;
 489     uint8_t      header[19];
 490     vlc_fourcc_t fcc;
 491
 492     if( vlc_stream_Read( p_demux->s, header, 19 ) < 19 )
 493     {
 494         msg_Warn( p_demux, "cannot read" );
 495         return VLC_EGENERIC;
 496     }
 497
 498     /* Video */
 499     switch( ( fcc = VLC_FOURCC( header[4], header[5], header[6], header[7] ) ) )
 500     {
 501         case VLC_FOURCC( 'V', 'P', '3', ' ' ):
 502         case VLC_FOURCC( 'V', 'P', '3', '0' ):
 503             fcc = VLC_FOURCC( 'V', 'P', '3', '0' );
 504             break;
 505
 506         case VLC_FOURCC( 'V', 'P', '3', '1' ):
 507             fcc = VLC_FOURCC( 'V', 'P', '3', '1' );
 508             break;
 509
 510         case VLC_FOURCC( 'V', 'P', '5', ' ' ):
 511         case VLC_FOURCC( 'V', 'P', '5', '0' ):
 512             fcc = VLC_FOURCC( 'V', 'P', '5', '0' );
 513             break;
 514         case VLC_FOURCC( 'V', 'P', '6', '0' ):
 515         case VLC_FOURCC( 'V', 'P', '6', '1' ):
 516         case VLC_FOURCC( 'V', 'P', '6', '2' ):
 517         case VLC_FOURCC( 'V', 'P', '8', '0' ):
 518         case VLC_FOURCC( 'H', '2', '6', '4' ):
 519         case VLC_FOURCC( 'N', 'O', 'N', 'E' ):
 520             break;
 521         default:
 522             msg_Err( p_demux, "unsupported video codec %4.4s", (char *)&fcc );
 523             break;
 524     }
 525     if( fcc != VLC_FOURCC( 'N', 'O', 'N', 'E' ) && fcc != p_sys->fmt_video.i_codec  )
 526     {
 527         es_format_Init( &p_sys->fmt_video, VIDEO_ES, fcc );
 528         p_sys->fmt_video.video.i_width = GetWLE( &header[12] );
 529         p_sys->fmt_video.video.i_height = GetWLE( &header[14] );
 530         p_sys->fmt_video.video.i_visible_width = p_sys->fmt_video.video.i_width;
 531         p_sys->fmt_video.video.i_visible_height = p_sys->fmt_video.video.i_height;
 532         if( p_sys->p_video )
 533         {
 534             es_out_Del( p_demux->out, p_sys->p_video );
 535         }
 536         p_sys->p_video = es_out_Add( p_demux->out, &p_sys->fmt_video );
 537
 538         msg_Dbg( p_demux, "    - video `%4.4s' %dx%d",
 539                  (char*)&fcc,
 540                  p_sys->fmt_video.video.i_width,
 541                  p_sys->fmt_video.video.i_height );
 542     }
 543
 544     /* Audio */
 545     switch( ( fcc = VLC_FOURCC( header[8], header[9], header[10], header[11] ) ) )
 546     {
 547         case VLC_FOURCC( 'M', 'P', '3', ' ' ):
 548             fcc = VLC_FOURCC( 'm', 'p', 'g', 'a' );
 549             break;
 550         case VLC_FOURCC( 'P', 'C', 'M', ' ' ):
 551             fcc = VLC_FOURCC( 'a', 'r', 'a', 'w' );
 552             break;
 553         case VLC_FOURCC( 'A', 'A', 'C', ' ' ):
 554         case VLC_FOURCC( 'A', 'A', 'C', 'P' ):
 555             fcc = VLC_FOURCC( 'm', 'p', '4', 'a' );
 556             break;
 557         case VLC_FOURCC( 'S', 'P', 'X', ' ' ):
 558             fcc = VLC_FOURCC( 's', 'p', 'x', ' ' );
 559             break;
 560         case VLC_FOURCC( 'N', 'O', 'N', 'E' ):
 561             break;
 562         default:
 563             msg_Err( p_demux, "unsupported audio codec %4.4s", (char *)&fcc );
 564             break;
 565     }
 566
 567     if( fcc != VLC_FOURCC( 'N', 'O', 'N', 'E' ) && fcc != p_sys->fmt_audio.i_codec )
 568     {
 569         msg_Dbg( p_demux, "    - audio `%4.4s'", (char*)&fcc );
 570
 571         if( p_sys->p_audio )
 572         {
 573             es_out_Del( p_demux->out, p_sys->p_audio );
 574             p_sys->p_audio = NULL;
 575         }
 576         es_format_Init( &p_sys->fmt_audio, AUDIO_ES, fcc );
 577     }
 578
 579     if( header[16]&0x80 )
 580     {
 581         /* Fractional frame rate */
 582         switch( header[16]&0x03 )
 583         {
 584             case 0: /* 30 fps */
 585                 p_sys->i_pcr_inc = 33333; /* 300000/9 */
 586                 break;
 587             case 1: /* 29.97 fps */
 588                 p_sys->i_pcr_inc = 33367; /* 300300/9 */
 589                 break;
 590             case 2: /* 25 fps */
 591                 p_sys->i_pcr_inc = 40000; /* 360000/9 */
 592                 break;
 593             case 3: /* 23.98 fps */
 594                 p_sys->i_pcr_inc = 41700; /* 375300/9 */
 595                 break;
 596         }
 597
 598         if( header[16] < 0xc0 )
 599             p_sys->i_pcr_inc = p_sys->i_pcr_inc * (((header[16] ^ 0x80) >> 2 ) +1 );
 600         else
 601             p_sys->i_pcr_inc = p_sys->i_pcr_inc / (((header[16] ^ 0xc0) >> 2 ) +1 );
 602     }
 603     else if( header[16] != 0 )
 604     {
 605         /* Integer frame rate */
 606         p_sys->i_pcr_inc = 1000000 / header[16];
 607     }
 608     else
 609     {
 610         msg_Dbg( p_demux, "invalid fps (0x00)" );
 611         p_sys->i_pcr_inc = 40000;
 612     }
 613     //msg_Dbg( p_demux, "    - fps=%.3f", 1000000.0 / (double)p_sys->i_pcr_inc );
 614
 615     if( p_sys->p_audio == NULL && p_sys->p_video == NULL )
 616     {
 617         msg_Err( p_demux, "unable to play neither audio nor video, aborting." );
 618         return VLC_EGENERIC;
 619     }
 620
 621     return VLC_SUCCESS;
 622 }
 623