modules/lua/libs/stream.c

   1 /*****************************************************************************
   2  * stream.c: stream functions
   3  *****************************************************************************
   4  * Copyright (C) 2007-2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Antoine Cellerier <dionoea at videolan tod org>
   8  *          Pierre d'Herbemont <pdherbemont # videolan.org>
   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  * Preamble
  27  *****************************************************************************/
  28 #ifndef  _GNU_SOURCE
  29 #   define  _GNU_SOURCE
  30 #endif
  31
  32 #ifdef HAVE_CONFIG_H
  33 # include "config.h"
  34 #endif
  35
  36 #include <vlc_common.h>
  37 #include <vlc_plugin.h>
  38 #include <vlc_meta.h>
  39 #include <vlc_stream_extractor.h>
  40
  41 #include "../vlc.h"
  42 #include "../libs.h"
  43
  44 /*****************************************************************************
  45  * Stream handling
  46  *****************************************************************************/
  47 static int vlclua_stream_read( lua_State * );
  48 static int vlclua_stream_readline( lua_State * );
  49 static int vlclua_stream_delete( lua_State * );
  50 static int vlclua_stream_add_filter( lua_State *L );
  51 static int vlclua_stream_readdir( lua_State *L );
  52 static int vlclua_stream_getsize( lua_State *L );
  53 static int vlclua_stream_seek( lua_State *L );
  54
  55 static const luaL_Reg vlclua_stream_reg[] = {
  56     { "read", vlclua_stream_read },
  57     { "readline", vlclua_stream_readline },
  58     { "addfilter", vlclua_stream_add_filter },
  59     { "readdir", vlclua_stream_readdir },
  60     { "getsize", vlclua_stream_getsize },
  61     { "seek", vlclua_stream_seek },
  62     { NULL, NULL }
  63 };
  64
  65 static int vlclua_stream_new_inner( lua_State *L, stream_t *p_stream )
  66 {
  67     if( !p_stream )
  68     {
  69         lua_pushnil( L );
  70         lua_pushliteral( L, "Error when opening stream" );
  71         return 2;
  72     }
  73
  74     stream_t **pp_stream = lua_newuserdata( L, sizeof( stream_t * ) );
  75     *pp_stream = p_stream;
  76
  77     if( luaL_newmetatable( L, "stream" ) )
  78     {
  79         lua_newtable( L );
  80         luaL_register( L, NULL, vlclua_stream_reg );
  81         lua_setfield( L, -2, "__index" );
  82         lua_pushcfunction( L, vlclua_stream_delete );
  83         lua_setfield( L, -2, "__gc" );
  84     }
  85
  86     lua_setmetatable( L, -2 );
  87     return 1;
  88 }
  89
  90 static int vlclua_stream_new( lua_State *L )
  91 {
  92     vlc_object_t * p_this = vlclua_get_this( L );
  93     const char * psz_url = luaL_checkstring( L, 1 );
  94     stream_t *p_stream = vlc_stream_NewMRL( p_this, psz_url );
  95     return vlclua_stream_new_inner( L, p_stream );
  96 }
  97
  98 static int vlclua_memory_stream_new( lua_State *L )
  99 {
 100     vlc_object_t * p_this = vlclua_get_this( L );
 101     /* FIXME: duplicating the whole buffer is suboptimal. Keeping a reference to the string so that it doesn't get garbage collected would be better */
 102     char * psz_content = strdup( luaL_checkstring( L, 1 ) );
 103     stream_t *p_stream = vlc_stream_MemoryNew( p_this, (uint8_t *)psz_content, strlen( psz_content ), false );
 104     return vlclua_stream_new_inner( L, p_stream );
 105 }
 106
 107 static int vlclua_directory_stream_new( lua_State *L )
 108 {
 109     vlc_object_t * p_this = vlclua_get_this( L );
 110     const char * psz_url = luaL_checkstring( L, 1 );
 111     stream_t *p_stream = vlc_stream_NewURL( p_this, psz_url );
 112     if( !p_stream )
 113         return vlclua_error( L );
 114     if( vlc_stream_directory_Attach( &p_stream, NULL ) != VLC_SUCCESS )
 115     {
 116         vlc_stream_Delete( p_stream );
 117         return vlclua_error( L );
 118     }
 119     return vlclua_stream_new_inner( L, p_stream );
 120 }
 121
 122 static int vlclua_stream_read( lua_State *L )
 123 {
 124     int i_read;
 125     stream_t **pp_stream = (stream_t **)luaL_checkudata( L, 1, "stream" );
 126     int n = luaL_checkint( L, 2 );
 127     uint8_t *p_read = malloc( n );
 128     if( !p_read ) return vlclua_error( L );
 129
 130     i_read = vlc_stream_Read( *pp_stream, p_read, n );
 131     if( i_read > 0 )
 132         lua_pushlstring( L, (const char *)p_read, i_read );
 133     else
 134         lua_pushnil( L );
 135     free( p_read );
 136     return 1;
 137 }
 138
 139 static int vlclua_stream_readline( lua_State *L )
 140 {
 141     stream_t **pp_stream = (stream_t **)luaL_checkudata( L, 1, "stream" );
 142     char *psz_line = vlc_stream_ReadLine( *pp_stream );
 143     if( psz_line )
 144     {
 145         lua_pushstring( L, psz_line );
 146         free( psz_line );
 147     }
 148     else
 149         lua_pushnil( L );
 150     return 1;
 151 }
 152
 153 static int vlclua_stream_add_filter( lua_State *L )
 154 {
 155     vlc_object_t *p_this = vlclua_get_this( L );
 156
 157     /* Make sure that we have 1 argument (+ 1 object) */
 158     lua_settop( L, 2 );
 159
 160     stream_t **pp_stream = (stream_t **)luaL_checkudata( L, 1, "stream" );
 161     if( !*pp_stream ) return vlclua_error( L );
 162     const char *psz_filter = NULL;
 163
 164     if( lua_isstring( L, 2 ) )
 165         psz_filter = lua_tostring( L, 2 );
 166
 167     if( !psz_filter || !*psz_filter )
 168     {
 169         msg_Dbg( p_this, "adding all automatic stream filters" );
 170         while( true )
 171         {
 172             /* Add next automatic stream */
 173             stream_t *p_filtered = vlc_stream_FilterNew( *pp_stream, NULL );
 174             if( !p_filtered )
 175                 break;
 176             else
 177             {
 178                 msg_Dbg( p_this, "inserted an automatic stream filter" );
 179                 *pp_stream = p_filtered;
 180             }
 181         }
 182         luaL_getmetatable( L, "stream" );
 183         lua_setmetatable( L, 1 );
 184     }
 185     else
 186     {
 187         /* Add a named filter */
 188         stream_t *p_filter = vlc_stream_FilterNew( *pp_stream, psz_filter );
 189         if( !p_filter )
 190             msg_Dbg( p_this, "Unable to open requested stream filter '%s'",
 191                      psz_filter );
 192         else
 193         {
 194             *pp_stream = p_filter;
 195             luaL_getmetatable( L, "stream" );
 196             lua_setmetatable( L, 1 );
 197         }
 198     }
 199
 200     return 1;
 201 }
 202
 203 static int vlclua_stream_readdir( lua_State *L )
 204 {
 205     stream_t **pp_stream = (stream_t **)luaL_checkudata( L, 1, "stream" );
 206     const char *psz_filter = NULL;
 207     bool b_show_hidden = false;
 208     if( lua_gettop( L ) >= 2 )
 209     {
 210         psz_filter = lua_tostring( L, 2 );
 211         if( lua_gettop( L ) >= 3 )
 212             b_show_hidden = lua_toboolean( L, 3 );
 213     }
 214
 215     if( !pp_stream || !*pp_stream )
 216         return vlclua_error( L );
 217     if( (*pp_stream)->pf_readdir == NULL )
 218         return vlclua_error( L );
 219
 220     input_item_t *p_input = input_item_New( (*pp_stream)->psz_url, NULL );
 221     if( psz_filter )
 222     {
 223         char *psz_opt;
 224         if( asprintf( &psz_opt, ":ignore-filetype=\"%s\"", psz_filter ) < 0 )
 225         {
 226             input_item_Release( p_input );
 227             return vlclua_error( L );
 228         }
 229         input_item_AddOption( p_input, psz_opt, VLC_INPUT_OPTION_TRUSTED );
 230         free( psz_opt );
 231     }
 232     else
 233         input_item_AddOption( p_input, "ignore-filetypes=\"\"",
 234                               VLC_INPUT_OPTION_TRUSTED );
 235     if( b_show_hidden )
 236         input_item_AddOption( p_input, "show-hiddenfiles",
 237                               VLC_INPUT_OPTION_TRUSTED );
 238     input_item_node_t *p_items = input_item_node_Create( p_input );
 239     input_item_Release( p_input );
 240     if( !p_items )
 241         return vlclua_error( L );
 242     if ( vlc_stream_ReadDir( *pp_stream, p_items ) )
 243     {
 244         input_item_node_Delete( p_items );
 245         return vlclua_error( L );
 246     }
 247     lua_newtable( L );
 248     for ( int i = 0; i < p_items->i_children; ++i )
 249     {
 250         lua_pushinteger( L, i + 1 );
 251         vlclua_input_item_get( L, p_items->pp_children[i]->p_item );
 252         lua_settable( L, -3 );
 253     }
 254     input_item_node_Delete( p_items );
 255     return 1;
 256 }
 257
 258 static int vlclua_stream_getsize( lua_State *L )
 259 {
 260     stream_t **pp_stream = (stream_t **)luaL_checkudata( L, 1, "stream" );
 261     uint64_t i_size;
 262     int i_res = vlc_stream_GetSize( *pp_stream, &i_size );
 263     if ( i_res != 0 )
 264         return luaL_error( L, "Failed to get stream size" );
 265     lua_pushnumber( L, i_size );
 266     return 1;
 267 }
 268
 269 static int vlclua_stream_seek( lua_State *L )
 270 {
 271     stream_t **pp_stream = (stream_t **)luaL_checkudata( L, 1, "stream" );
 272     lua_Integer i_offset = luaL_checkinteger( L, 2 );
 273     if ( i_offset < 0 )
 274         return luaL_error( L, "Invalid negative seek offset" );
 275     int i_res = vlc_stream_Seek( *pp_stream, (uint64_t)i_offset );
 276     lua_pushboolean( L, i_res == 0 );
 277     return 1;
 278 }
 279
 280 static int vlclua_stream_delete( lua_State *L )
 281 {
 282     stream_t **pp_stream = (stream_t **)luaL_checkudata( L, 1, "stream" );
 283     vlc_stream_Delete( *pp_stream );
 284     return 0;
 285 }
 286
 287 /*****************************************************************************
 288  *
 289  *****************************************************************************/
 290 void luaopen_stream( lua_State *L )
 291 {
 292     lua_pushcfunction( L, vlclua_stream_new );
 293     lua_setfield( L, -2, "stream" );
 294     lua_pushcfunction( L, vlclua_memory_stream_new );
 295     lua_setfield( L, -2, "memory_stream" );
 296     lua_pushcfunction( L, vlclua_directory_stream_new );
 297     lua_setfield( L, -2, "directory_stream" );
 298 }