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