git.sesse.net Git - vlc/blob - modules/stream_out/bridge.c

   1 /*****************************************************************************
   2  * bridge.c: bridge stream output module
   3  *****************************************************************************
   4  * Copyright (C) 2005 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Christophe Massiot <massiot@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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27
  28 #include <vlc/vlc.h>
  29 #include <vlc_sout.h>
  30 #include <vlc_block.h>
  31
  32 /*****************************************************************************
  33  * Module descriptor
  34  *****************************************************************************/
  35 #define ID_TEXT N_("ID")
  36 #define ID_LONGTEXT N_( \
  37     "Integer identifier for this elementary stream. This will be used to " \
  38     "\"find\" this stream later." )
  39
  40 #define DELAY_TEXT N_("Delay")
  41 #define DELAY_LONGTEXT N_("Pictures coming from the picture video outputs " \
  42         "will be delayed according to this value (in milliseconds, should be "\
  43         ">= 100 ms). For high values, you will need to raise caching values." )
  44
  45 #define ID_OFFSET_TEXT N_("ID Offset")
  46 #define ID_OFFSET_LONGTEXT N_("Offset to add to the stream IDs specified in " \
  47         "bridge_out to obtain the stream IDs bridge_in will register.")
  48
  49 static int  OpenOut ( vlc_object_t * );
  50 static void CloseOut( vlc_object_t * );
  51 static int  OpenIn  ( vlc_object_t * );
  52 static void CloseIn ( vlc_object_t * );
  53
  54 #define SOUT_CFG_PREFIX_OUT "sout-bridge-out-"
  55 #define SOUT_CFG_PREFIX_IN "sout-bridge-in-"
  56
  57 vlc_module_begin();
  58     set_shortname( _("Bridge"));
  59     set_description( _("Bridge stream output"));
  60     add_submodule();
  61     set_section( N_("Bridge out"), NULL );
  62     set_capability( "sout stream", 50 );
  63     add_shortcut( "bridge-out" );
  64     /* Only usable with VLM. No category so not in gui preferences
  65     set_category( CAT_SOUT );
  66     set_subcategory( SUBCAT_SOUT_STREAM );*/
  67     add_integer( SOUT_CFG_PREFIX_OUT "id", 0, NULL, ID_TEXT, ID_LONGTEXT,
  68                  VLC_FALSE );
  69     set_callbacks( OpenOut, CloseOut );
  70
  71     add_submodule();
  72     set_section( N_("Bridge in"), NULL );
  73     set_capability( "sout stream", 50 );
  74     add_shortcut( "bridge-in" );
  75     /*set_category( CAT_SOUT );
  76     set_subcategory( SUBCAT_SOUT_STREAM );*/
  77     add_integer( SOUT_CFG_PREFIX_IN "delay", 0, NULL, DELAY_TEXT,
  78                  DELAY_LONGTEXT, VLC_FALSE );
  79     add_integer( SOUT_CFG_PREFIX_IN "id-offset", 8192, NULL, ID_OFFSET_TEXT,
  80                  ID_OFFSET_LONGTEXT, VLC_FALSE );
  81     set_callbacks( OpenIn, CloseIn );
  82
  83 vlc_module_end();
  84
  85
  86 /*****************************************************************************
  87  * Local prototypes
  88  *****************************************************************************/
  89 static const char *ppsz_sout_options_out[] = {
  90     "id", NULL
  91 };
  92
  93 static const char *ppsz_sout_options_in[] = {
  94     "delay", "id-offset", NULL
  95 };
  96
  97 static sout_stream_id_t *AddOut ( sout_stream_t *, es_format_t * );
  98 static int               DelOut ( sout_stream_t *, sout_stream_id_t * );
  99 static int               SendOut( sout_stream_t *, sout_stream_id_t *, block_t * );
 100
 101 static sout_stream_id_t *AddIn ( sout_stream_t *, es_format_t * );
 102 static int               DelIn ( sout_stream_t *, sout_stream_id_t * );
 103 static int               SendIn( sout_stream_t *, sout_stream_id_t *, block_t * );
 104
 105 typedef struct bridged_es_t
 106 {
 107     es_format_t fmt;
 108     block_t *p_block;
 109     block_t **pp_last;
 110     vlc_bool_t b_empty;
 111
 112     /* bridge in part */
 113     sout_stream_id_t *id;
 114     mtime_t i_last;
 115     vlc_bool_t b_changed;
 116 } bridged_es_t;
 117
 118 typedef struct bridge_t
 119 {
 120     bridged_es_t **pp_es;
 121     int i_es_num;
 122 } bridge_t;
 123
 124 #define GetBridge(a) __GetBridge( VLC_OBJECT(a) )
 125 static bridge_t *__GetBridge( vlc_object_t *p_object )
 126 {
 127     bridge_t *p_bridge;
 128     vlc_value_t val;
 129
 130     if( var_Get( p_object->p_libvlc, "bridge-struct", &val ) )
 131     {
 132         p_bridge = NULL;
 133     }
 134     else
 135     {
 136         p_bridge = val.p_address;
 137     }
 138
 139     return p_bridge;
 140 }
 141
 142
 143 /*
 144  * Bridge out
 145  */
 146
 147 typedef struct out_sout_stream_sys_t
 148 {
 149     vlc_mutex_t *p_lock;
 150     bridged_es_t *p_es;
 151     int i_id;
 152     vlc_bool_t b_inited;
 153 } out_sout_stream_sys_t;
 154
 155 /*****************************************************************************
 156  * OpenOut:
 157  *****************************************************************************/
 158 static int OpenOut( vlc_object_t *p_this )
 159 {
 160     sout_stream_t     *p_stream = (sout_stream_t *)p_this;
 161     out_sout_stream_sys_t *p_sys;
 162     vlc_value_t val;
 163
 164     config_ChainParse( p_stream, SOUT_CFG_PREFIX_OUT, ppsz_sout_options_out,
 165                    p_stream->p_cfg );
 166
 167     p_sys          = malloc( sizeof( out_sout_stream_sys_t ) );
 168     p_sys->b_inited = VLC_FALSE;
 169
 170     var_Create( p_this->p_libvlc, "bridge-lock", VLC_VAR_MUTEX );
 171     var_Get( p_this->p_libvlc, "bridge-lock", &val );
 172     p_sys->p_lock = val.p_address;
 173
 174     var_Get( p_stream, SOUT_CFG_PREFIX_OUT "id", &val );
 175     p_sys->i_id = val.i_int;
 176
 177     p_stream->pf_add    = AddOut;
 178     p_stream->pf_del    = DelOut;
 179     p_stream->pf_send   = SendOut;
 180
 181     p_stream->p_sys     = (sout_stream_sys_t *)p_sys;
 182
 183     p_stream->p_sout->i_out_pace_nocontrol++;
 184
 185     return VLC_SUCCESS;
 186 }
 187
 188 /*****************************************************************************
 189  * CloseOut:
 190  *****************************************************************************/
 191 static void CloseOut( vlc_object_t * p_this )
 192 {
 193     sout_stream_t     *p_stream = (sout_stream_t*)p_this;
 194     out_sout_stream_sys_t *p_sys = (out_sout_stream_sys_t *)p_stream->p_sys;
 195
 196     p_stream->p_sout->i_out_pace_nocontrol--;
 197
 198     free( p_sys );
 199 }
 200
 201 static sout_stream_id_t * AddOut( sout_stream_t *p_stream, es_format_t *p_fmt )
 202 {
 203     out_sout_stream_sys_t *p_sys = (out_sout_stream_sys_t *)p_stream->p_sys;
 204     bridge_t *p_bridge;
 205     bridged_es_t *p_es;
 206     int i;
 207
 208     if ( p_sys->b_inited )
 209     {
 210         return NULL;
 211     }
 212     p_sys->b_inited = VLC_TRUE;
 213
 214     vlc_mutex_lock( p_sys->p_lock );
 215
 216     p_bridge = GetBridge( p_stream );
 217     if ( p_bridge == NULL )
 218     {
 219         vlc_object_t *p_libvlc = VLC_OBJECT( p_stream->p_libvlc );
 220         vlc_value_t val;
 221
 222         p_bridge = malloc( sizeof( bridge_t ) );
 223
 224         var_Create( p_libvlc, "bridge-struct", VLC_VAR_ADDRESS );
 225         val.p_address = p_bridge;
 226         var_Set( p_libvlc, "bridge-struct", val );
 227
 228         p_bridge->i_es_num = 0;
 229         p_bridge->pp_es = NULL;
 230     }
 231
 232     for ( i = 0; i < p_bridge->i_es_num; i++ )
 233     {
 234         if ( p_bridge->pp_es[i]->b_empty && !p_bridge->pp_es[i]->b_changed )
 235             break;
 236     }
 237
 238     if ( i == p_bridge->i_es_num )
 239     {
 240         p_bridge->pp_es = realloc( p_bridge->pp_es,
 241                                    (p_bridge->i_es_num + 1)
 242                                      * sizeof(bridged_es_t *) );
 243         p_bridge->i_es_num++;
 244         p_bridge->pp_es[i] = malloc( sizeof(bridged_es_t) );
 245     }
 246
 247     p_sys->p_es = p_es = p_bridge->pp_es[i];
 248
 249     p_es->fmt = *p_fmt;
 250     p_es->fmt.i_id = p_sys->i_id;
 251     p_es->p_block = NULL;
 252     p_es->pp_last = &p_es->p_block;
 253     p_es->b_empty = VLC_FALSE;
 254
 255     p_es->id = NULL;
 256     p_es->i_last = 0;
 257     p_es->b_changed = VLC_TRUE;
 258
 259     msg_Dbg( p_stream, "bridging out input codec=%4.4s id=%d pos=%d",
 260              (char*)&p_es->fmt.i_codec, p_es->fmt.i_id, i );
 261
 262     vlc_mutex_unlock( p_sys->p_lock );
 263
 264     return (sout_stream_id_t *)p_sys;
 265 }
 266
 267 static int DelOut( sout_stream_t *p_stream, sout_stream_id_t *id )
 268 {
 269     out_sout_stream_sys_t *p_sys = (out_sout_stream_sys_t *)p_stream->p_sys;
 270     bridged_es_t *p_es;
 271
 272     if ( !p_sys->b_inited )
 273     {
 274         return VLC_SUCCESS;
 275     }
 276
 277     vlc_mutex_lock( p_sys->p_lock );
 278
 279     p_es = p_sys->p_es;
 280
 281     p_es->b_empty = VLC_TRUE;
 282     block_ChainRelease( p_es->p_block );
 283     p_es->p_block = VLC_FALSE;
 284
 285     p_es->b_changed = VLC_TRUE;
 286     vlc_mutex_unlock( p_sys->p_lock );
 287
 288     p_sys->b_inited = VLC_FALSE;
 289
 290     return VLC_SUCCESS;
 291 }
 292
 293 static int SendOut( sout_stream_t *p_stream, sout_stream_id_t *id,
 294                     block_t *p_buffer )
 295 {
 296     out_sout_stream_sys_t *p_sys = (out_sout_stream_sys_t *)p_stream->p_sys;
 297     bridged_es_t *p_es;
 298
 299     if ( (out_sout_stream_sys_t *)id != p_sys )
 300     {
 301         block_ChainRelease( p_buffer );
 302         return VLC_SUCCESS;
 303     }
 304
 305     vlc_mutex_lock( p_sys->p_lock );
 306
 307     p_es = p_sys->p_es;
 308     *p_es->pp_last = p_buffer;
 309     while ( p_buffer != NULL )
 310     {
 311         p_es->pp_last = &p_buffer->p_next;
 312         p_buffer = p_buffer->p_next;
 313     }
 314
 315     vlc_mutex_unlock( p_sys->p_lock );
 316
 317     return VLC_SUCCESS;
 318 }
 319
 320
 321 /*
 322  * Bridge in
 323  */
 324
 325 typedef struct in_sout_stream_sys_t
 326 {
 327     sout_stream_t *p_out;
 328     vlc_mutex_t *p_lock;
 329     int i_id_offset;
 330     mtime_t i_delay;
 331 } in_sout_stream_sys_t;
 332
 333 /*****************************************************************************
 334  * OpenIn:
 335  *****************************************************************************/
 336 static int OpenIn( vlc_object_t *p_this )
 337 {
 338     sout_stream_t     *p_stream = (sout_stream_t*)p_this;
 339     in_sout_stream_sys_t *p_sys;
 340     vlc_value_t val;
 341
 342     p_sys          = malloc( sizeof( in_sout_stream_sys_t ) );
 343
 344     p_sys->p_out = sout_StreamNew( p_stream->p_sout, p_stream->psz_next );
 345     if( !p_sys->p_out )
 346     {
 347         msg_Err( p_stream, "cannot create chain" );
 348         free( p_sys );
 349         return VLC_EGENERIC;
 350     }
 351
 352     config_ChainParse( p_stream, SOUT_CFG_PREFIX_IN, ppsz_sout_options_in,
 353                    p_stream->p_cfg );
 354
 355     var_Create( p_this->p_libvlc, "bridge-lock", VLC_VAR_MUTEX );
 356     var_Get( p_this->p_libvlc, "bridge-lock", &val );
 357     p_sys->p_lock = val.p_address;
 358
 359     var_Get( p_stream, SOUT_CFG_PREFIX_IN "id-offset", &val );
 360     p_sys->i_id_offset = val.i_int;
 361
 362     var_Get( p_stream, SOUT_CFG_PREFIX_IN "delay", &val );
 363     p_sys->i_delay = (mtime_t)val.i_int * 1000;
 364
 365     p_stream->pf_add    = AddIn;
 366     p_stream->pf_del    = DelIn;
 367     p_stream->pf_send   = SendIn;
 368
 369     p_stream->p_sys     = (sout_stream_sys_t *)p_sys;
 370
 371     /* update p_sout->i_out_pace_nocontrol */
 372     p_stream->p_sout->i_out_pace_nocontrol++;
 373
 374     return VLC_SUCCESS;
 375 }
 376
 377 /*****************************************************************************
 378  * CloseIn:
 379  *****************************************************************************/
 380 static void CloseIn( vlc_object_t * p_this )
 381 {
 382     sout_stream_t     *p_stream = (sout_stream_t*)p_this;
 383     in_sout_stream_sys_t *p_sys = (in_sout_stream_sys_t *)p_stream->p_sys;
 384
 385     sout_StreamDelete( p_sys->p_out );
 386     p_stream->p_sout->i_out_pace_nocontrol--;
 387
 388     free( p_sys );
 389 }
 390
 391 static sout_stream_id_t * AddIn( sout_stream_t *p_stream, es_format_t *p_fmt )
 392 {
 393     in_sout_stream_sys_t *p_sys = (in_sout_stream_sys_t *)p_stream->p_sys;
 394
 395     return p_sys->p_out->pf_add( p_sys->p_out, p_fmt );
 396 }
 397
 398 static int DelIn( sout_stream_t *p_stream, sout_stream_id_t *id )
 399 {
 400     in_sout_stream_sys_t *p_sys = (in_sout_stream_sys_t *)p_stream->p_sys;
 401
 402     return p_sys->p_out->pf_del( p_sys->p_out, id );
 403 }
 404
 405 static int SendIn( sout_stream_t *p_stream, sout_stream_id_t *id,
 406                    block_t *p_buffer )
 407 {
 408     in_sout_stream_sys_t *p_sys = (in_sout_stream_sys_t *)p_stream->p_sys;
 409     bridge_t *p_bridge;
 410     vlc_bool_t b_no_es = VLC_TRUE;
 411     int i;
 412
 413     /* First forward the packet for our own ES */
 414     p_sys->p_out->pf_send( p_sys->p_out, id, p_buffer );
 415
 416     /* Then check all bridged streams */
 417     vlc_mutex_lock( p_sys->p_lock );
 418
 419     p_bridge = GetBridge( p_stream );
 420     if ( p_bridge == NULL )
 421     {
 422         vlc_mutex_unlock( p_sys->p_lock );
 423         return VLC_SUCCESS;
 424     }
 425
 426     for ( i = 0; i < p_bridge->i_es_num; i++ )
 427     {
 428         if ( !p_bridge->pp_es[i]->b_empty )
 429             b_no_es = VLC_FALSE;
 430
 431         while ( p_bridge->pp_es[i]->p_block != NULL
 432                  && (p_bridge->pp_es[i]->p_block->i_dts + p_sys->i_delay
 433                        < mdate()
 434                       || p_bridge->pp_es[i]->p_block->i_dts + p_sys->i_delay
 435                           < p_bridge->pp_es[i]->i_last) )
 436         {
 437             block_t *p_block = p_bridge->pp_es[i]->p_block;
 438             msg_Dbg( p_stream, "dropping a packet (" I64Fd ")",
 439                      mdate() - p_block->i_dts - p_sys->i_delay );
 440             p_bridge->pp_es[i]->p_block
 441                 = p_bridge->pp_es[i]->p_block->p_next;
 442             block_Release( p_block );
 443         }
 444
 445         if ( p_bridge->pp_es[i]->p_block == NULL )
 446         {
 447             p_bridge->pp_es[i]->pp_last = &p_bridge->pp_es[i]->p_block;
 448         }
 449
 450         if ( p_bridge->pp_es[i]->b_changed )
 451         {
 452             if ( p_bridge->pp_es[i]->b_empty && p_bridge->pp_es[i]->id != NULL )
 453             {
 454                 p_sys->p_out->pf_del( p_sys->p_out, p_bridge->pp_es[i]->id );
 455             }
 456             else
 457             {
 458                 /* We need at least two packets to enter the mux. */
 459                 if ( p_bridge->pp_es[i]->p_block == NULL
 460                       || p_bridge->pp_es[i]->p_block->p_next == NULL )
 461                 {
 462                     continue;
 463                 }
 464
 465                 p_bridge->pp_es[i]->fmt.i_id += p_sys->i_id_offset;
 466                 p_bridge->pp_es[i]->id = p_sys->p_out->pf_add(
 467                             p_sys->p_out, &p_bridge->pp_es[i]->fmt );
 468                 if ( p_bridge->pp_es[i]->id == NULL )
 469                 {
 470                     msg_Warn( p_stream, "couldn't create chain for id %d",
 471                               p_bridge->pp_es[i]->fmt.i_id );
 472                 }
 473                 msg_Dbg( p_stream, "bridging in input codec=%4.4s id=%d pos=%d",
 474                          (char*)&p_bridge->pp_es[i]->fmt.i_codec,
 475                          p_bridge->pp_es[i]->fmt.i_id, i );
 476             }
 477         }
 478         p_bridge->pp_es[i]->b_changed = VLC_FALSE;
 479
 480         if ( p_bridge->pp_es[i]->b_empty )
 481             continue;
 482
 483         if ( p_bridge->pp_es[i]->p_block == NULL )
 484         {
 485             if ( p_bridge->pp_es[i]->id != NULL
 486                   && p_bridge->pp_es[i]->i_last < mdate() )
 487             {
 488                 p_sys->p_out->pf_del( p_sys->p_out, p_bridge->pp_es[i]->id );
 489                 p_bridge->pp_es[i]->fmt.i_id -= p_sys->i_id_offset;
 490                 p_bridge->pp_es[i]->b_changed = VLC_TRUE;
 491                 p_bridge->pp_es[i]->id = NULL;
 492             }
 493             continue;
 494         }
 495
 496         if ( p_bridge->pp_es[i]->id != NULL )
 497         {
 498             block_t *p_block = p_bridge->pp_es[i]->p_block;
 499             while ( p_block != NULL )
 500             {
 501                 p_bridge->pp_es[i]->i_last = p_block->i_dts;
 502                 p_block->i_pts += p_sys->i_delay;
 503                 p_block->i_dts += p_sys->i_delay;
 504                 p_block = p_block->p_next;
 505             }
 506             p_sys->p_out->pf_send( p_sys->p_out, p_bridge->pp_es[i]->id,
 507                                    p_bridge->pp_es[i]->p_block );
 508         }
 509         else
 510         {
 511             block_ChainRelease( p_bridge->pp_es[i]->p_block );
 512         }
 513
 514         p_bridge->pp_es[i]->p_block = NULL;
 515         p_bridge->pp_es[i]->pp_last = &p_bridge->pp_es[i]->p_block;
 516     }
 517
 518     if( b_no_es )
 519     {
 520         vlc_object_t *p_libvlc = VLC_OBJECT( p_stream->p_libvlc );
 521         for ( i = 0; i < p_bridge->i_es_num; i++ )
 522             free( p_bridge->pp_es[i] );
 523         free( p_bridge->pp_es );
 524         free( p_bridge );
 525         var_Destroy( p_libvlc, "bridge-struct" );
 526     }
 527
 528     vlc_mutex_unlock( p_sys->p_lock );
 529
 530     return VLC_SUCCESS;
 531 }