vlc | branch: master | Filip Roséen <fi...@atch.se> | Wed Oct 19 00:15:54 2016 +0200| [6a884379663bf3440368a32dfd24b7a198175626] | committer: Jean-Baptiste Kempf
modules/stream_extractor: add libarchive extractor Signed-off-by: Jean-Baptiste Kempf <j...@videolan.org> > http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=6a884379663bf3440368a32dfd24b7a198175626 --- NEWS | 1 + configure.ac | 2 +- modules/MODULES_LIST | 1 + modules/stream_extractor/Makefile.am | 9 + modules/stream_extractor/archive.c | 701 +++++++++++++++++++++++++++++++++++ po/POTFILES.in | 1 + 6 files changed, 714 insertions(+), 1 deletion(-) diff --git a/NEWS b/NEWS index c589109..6f423ae 100644 --- a/NEWS +++ b/NEWS @@ -128,6 +128,7 @@ Stream filter: * Added ADF stream filter * Added ARIB STD-B25 TS streams decoder * Added stream prebuffering plugin + * Rewrite libarchive module as a stream_extractor * Removed HTTP Live streaming stream filter * Added zlib (a.k.a. deflate) decompression filter diff --git a/configure.ac b/configure.ac index 00285a9..5fddd51 100644 --- a/configure.ac +++ b/configure.ac @@ -1672,7 +1672,7 @@ EXTEND_HELP_STRING([Input plugins:]) dnl dnl libarchive access module dnl -PKG_ENABLE_MODULES_VLC([ARCHIVE], [access_archive], [libarchive >= 3.1.0], (libarchive support), [auto]) +PKG_ENABLE_MODULES_VLC([ARCHIVE], [archive], [libarchive >= 3.1.0], (libarchive support), [auto]) dnl dnl live555 input diff --git a/modules/MODULES_LIST b/modules/MODULES_LIST index 42e83d0..b858438 100644 --- a/modules/MODULES_LIST +++ b/modules/MODULES_LIST @@ -41,6 +41,7 @@ $Id$ * antiflicker: anti-flicker video filter * aom: AOM decoder (AV1) * araw: Pseudo audio decoder for raw PCM + * archive: libarchive based access and stream filter and stream_extractor * aribcam: ARIB STD-B25 decoder/virtual CAM * aribsub: ARIB subtitles decoder * asf: ASF demuxer diff --git a/modules/stream_extractor/Makefile.am b/modules/stream_extractor/Makefile.am index e69de29..6b37a01 100644 --- a/modules/stream_extractor/Makefile.am +++ b/modules/stream_extractor/Makefile.am @@ -0,0 +1,9 @@ +stream_extractordir = $(pluginsdir)/stream_extractor +stream_extractor_LTLIBRARIES = + +libarchive_plugin_la_SOURCES = stream_extractor/archive.c +libarchive_plugin_la_CFLAGS = $(AM_CFLAGS) $(ARCHIVE_CFLAGS) +libarchive_plugin_la_LDFLAGS = $(AM_LDFLAGS) -rpath '$(stream_extractordir)' +libarchive_plugin_la_LIBADD = $(ARCHIVE_LIBS) +EXTRA_LTLIBRARIES += libarchive_plugin.la +stream_extractor_LTLIBRARIES += $(LTLIBarchive) diff --git a/modules/stream_extractor/archive.c b/modules/stream_extractor/archive.c new file mode 100644 index 0000000..3d34d8c --- /dev/null +++ b/modules/stream_extractor/archive.c @@ -0,0 +1,701 @@ +/***************************************************************************** + * archive.c: libarchive based stream filter + ***************************************************************************** + * Copyright (C) 2016 VLC authors and VideoLAN + * $Id$ + * + * Authors: Filip Roséen <fi...@atch.se> + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation; either version 2.1 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. + *****************************************************************************/ + +#ifdef HAVE_CONFIG_H +# include "config.h" +#endif + +#include <vlc_common.h> +#include <vlc_plugin.h> +#include <vlc_stream.h> +#include <vlc_stream_extractor.h> +#include <vlc_dialog.h> +#include <vlc_input_item.h> + +#include <assert.h> +#include <archive.h> +#include <archive_entry.h> + +static int ExtractorOpen( vlc_object_t* ); +static void ExtractorClose( vlc_object_t* ); + +static int DirectoryOpen( vlc_object_t* ); +static void DirectoryClose( vlc_object_t* ); + +vlc_module_begin() + set_category( CAT_INPUT ) + set_subcategory( SUBCAT_INPUT_STREAM_FILTER ) + set_capability( "stream_directory", 99 ) + set_description( N_( "libarchive based stream directory" ) ) + set_callbacks( DirectoryOpen, DirectoryClose ); + + add_submodule() + set_description( N_( "libarchive based stream extractor" ) ) + set_capability( "stream_extractor", 99 ) + set_callbacks( ExtractorOpen, ExtractorClose ); + +vlc_module_end() + +typedef struct libarchive_callback_t libarchive_callback_t; +typedef struct private_sys_t private_sys_t; +typedef struct archive libarchive_t; + +struct private_sys_t +{ + libarchive_t* p_archive; + vlc_object_t* p_obj; + stream_t* source; + + struct archive_entry* p_entry; + bool b_dead; + + uint64_t i_offset; + + uint8_t buffer[ 8192 ]; + bool b_seekable_source; + bool b_seekable_archive; + + libarchive_callback_t** pp_callback_data; + size_t i_callback_data; +}; + +struct libarchive_callback_t { + private_sys_t* p_sys; + stream_t* p_source; + char* psz_url; +}; + +/* ------------------------------------------------------------------------- */ + +static int libarchive_exit_cb( libarchive_t* p_arc, void* p_obj ) +{ + VLC_UNUSED( p_arc ); + + libarchive_callback_t* p_cb = (libarchive_callback_t*)p_obj; + + if( p_cb->p_sys->source == p_cb->p_source ) + { /* DO NOT CLOSE OUR MOTHER STREAM */ + + if( vlc_stream_Seek( p_cb->p_source, 0 ) ) + return ARCHIVE_FATAL; + } + else if( p_cb->p_source ) + { + vlc_stream_Delete( p_cb->p_source ); + p_cb->p_source = NULL; + } + + return ARCHIVE_OK; +} + +static int libarchive_jump_cb( libarchive_t* p_arc, void* p_obj_current, + void* p_obj_next ) +{ + libarchive_callback_t* p_current = (libarchive_callback_t*)p_obj_current; + libarchive_callback_t* p_next = (libarchive_callback_t*)p_obj_next; + + libarchive_exit_cb( p_arc, p_current ); + + if( p_next->p_source == NULL ) + p_next->p_source = vlc_stream_NewURL( p_next->p_sys->p_obj, + p_next->psz_url ); + + return p_next->p_source ? ARCHIVE_OK : ARCHIVE_FATAL; +} + + +static la_int64_t libarchive_skip_cb( libarchive_t* p_arc, void* p_obj, + off_t i_request ) +{ + VLC_UNUSED( p_arc ); + + libarchive_callback_t* p_cb = (libarchive_callback_t*)p_obj; + + stream_t* p_source = p_cb->p_source; + private_sys_t* p_sys = p_cb->p_sys; + + /* TODO: fix b_seekable_source on libarchive_callback_t */ + + if( p_sys->b_seekable_source ) + { + if( vlc_stream_Seek( p_source, vlc_stream_Tell( p_source ) + i_request ) ) + return ARCHIVE_FATAL; + + return i_request; + } + + ssize_t i_read = vlc_stream_Read( p_source, NULL, i_request ); + return i_read >= 0 ? i_read : ARCHIVE_FATAL; +} + +static la_int64_t libarchive_seek_cb( libarchive_t* p_arc, void* p_obj, + la_int64_t offset, int whence ) +{ + VLC_UNUSED( p_arc ); + + libarchive_callback_t* p_cb = (libarchive_callback_t*)p_obj; + stream_t* p_source = p_cb->p_source; + + ssize_t whence_pos; + + switch( whence ) + { + case SEEK_SET: whence_pos = 0; break; + case SEEK_CUR: whence_pos = vlc_stream_Tell( p_source ); break; + case SEEK_END: whence_pos = stream_Size( p_source ) - 1; break; + default: vlc_assert_unreachable(); + + } + + if( whence_pos < 0 || vlc_stream_Seek( p_source, whence_pos + offset ) ) + return ARCHIVE_FATAL; + + return vlc_stream_Tell( p_source ); +} + +static la_ssize_t libarchive_read_cb( libarchive_t* p_arc, void* p_obj, + const void** pp_dst ) +{ + VLC_UNUSED( p_arc ); + + libarchive_callback_t* p_cb = (libarchive_callback_t*)p_obj; + + stream_t* p_source = p_cb->p_source; + private_sys_t* p_sys = p_cb->p_sys; + + ssize_t i_ret = vlc_stream_Read( p_source, &p_sys->buffer, + sizeof( p_sys->buffer ) ); + + if( i_ret < 0 ) + { + archive_set_error( p_sys->p_archive, ARCHIVE_FATAL, + "libarchive_read_cb failed = %" PRId64, i_ret ); + + return ARCHIVE_FATAL; + } + + *pp_dst = &p_sys->buffer; + return i_ret; +} + +/* ------------------------------------------------------------------------- */ + +static int archive_push_resource( private_sys_t* p_sys, + stream_t* p_source, char const* psz_url ) +{ + libarchive_callback_t** pp_callback_data; + libarchive_callback_t* p_callback_data; + + /* INCREASE BUFFER SIZE */ + + pp_callback_data = realloc( p_sys->pp_callback_data, + sizeof( *p_sys->pp_callback_data ) * ( p_sys->i_callback_data + 1 ) ); + + if( unlikely( !pp_callback_data ) ) + goto error; + + /* CREATE NEW NODE */ + + p_callback_data = malloc( sizeof( *p_callback_data ) ); + + if( unlikely( !p_callback_data ) ) + goto error; + + /* INITIALIZE AND APPEND */ + + p_callback_data->psz_url = psz_url ? strdup( psz_url ) : NULL; + p_callback_data->p_source = p_source; + p_callback_data->p_sys = p_sys; + + if( unlikely( !p_callback_data->psz_url && psz_url ) ) + goto error; + + pp_callback_data[ p_sys->i_callback_data++ ] = p_callback_data; + p_sys->pp_callback_data = pp_callback_data; + + return VLC_SUCCESS; + +error: + free( pp_callback_data ); + return VLC_ENOMEM; +} + +static int archive_init( private_sys_t* p_sys, stream_t* source ) +{ + /* CREATE ARCHIVE HANDLE */ + + p_sys->p_archive = archive_read_new(); + + if( unlikely( !p_sys->p_archive ) ) + { + msg_Dbg( p_sys->p_obj, "unable to create libarchive handle" ); + return VLC_EGENERIC; + } + + /* SETUP SEEKING */ + + p_sys->b_seekable_archive = false; + + if( vlc_stream_Control( source, STREAM_CAN_SEEK, + &p_sys->b_seekable_source ) ) + { + msg_Warn( p_sys->p_obj, "unable to query whether source stream can seek" ); + p_sys->b_seekable_source = false; + } + + if( p_sys->b_seekable_source ) + { + if( archive_read_set_seek_callback( p_sys->p_archive, + libarchive_seek_cb ) ) + { + msg_Err( p_sys->p_obj, "archive_read_set_callback failed, aborting." ); + return VLC_EGENERIC; + } + } + + /* ENABLE ALL FORMATS/FILTERS */ + + archive_read_support_filter_all( p_sys->p_archive ); + archive_read_support_format_all( p_sys->p_archive ); + + /* REGISTER CALLBACK DATA */ + + if( archive_read_set_switch_callback( p_sys->p_archive, + libarchive_jump_cb ) ) + { + msg_Err( p_sys->p_obj, "archive_read_set_switch_callback failed, aborting." ); + return VLC_EGENERIC; + } + + for( size_t i = 0; i < p_sys->i_callback_data; ++i ) + { + if( archive_read_append_callback_data( p_sys->p_archive, + p_sys->pp_callback_data[i] ) ) + { + return VLC_EGENERIC; + } + } + + /* OPEN THE ARCHIVE */ + + if( archive_read_open2( p_sys->p_archive, p_sys->pp_callback_data[0], NULL, + libarchive_read_cb, libarchive_skip_cb, libarchive_exit_cb ) ) + { + msg_Dbg( p_sys->p_obj, "libarchive: %s", + archive_error_string( p_sys->p_archive ) ); + + return VLC_EGENERIC; + } + + return VLC_SUCCESS; +} + +static int archive_clean( private_sys_t* p_sys ) +{ + libarchive_t* p_arc = p_sys->p_archive; + + archive_entry_free( p_sys->p_entry ); + archive_read_free( p_arc ); + + p_sys->p_entry = NULL; + p_sys->p_archive = NULL; + + return VLC_SUCCESS; +} + +static int archive_seek_subentry( private_sys_t* p_sys, char const* psz_subentry ) +{ + libarchive_t* p_arc = p_sys->p_archive; + + struct archive_entry* entry; + int archive_status; + + while( !( archive_status = archive_read_next_header( p_arc, &entry ) ) ) + { + char const* entry_path = archive_entry_pathname( entry ); + + if( strcmp( entry_path, psz_subentry ) == 0 ) + { + p_sys->p_entry = archive_entry_clone( entry ); + + if( unlikely( !p_sys->p_entry ) ) + return VLC_ENOMEM; + + break; + } + + archive_read_data_skip( p_arc ); + } + + switch( archive_status ) + { + case ARCHIVE_WARN: + msg_Warn( p_sys->p_obj, + "libarchive: %s", archive_error_string( p_arc ) ); + + case ARCHIVE_EOF: + case ARCHIVE_FATAL: + case ARCHIVE_RETRY: + archive_set_error( p_arc, ARCHIVE_FATAL, + "archive does not contain >>> %s <<<", psz_subentry ); + + return VLC_EGENERIC; + } + + /* check if seeking is supported */ + + if( p_sys->b_seekable_source ) + { + if( archive_seek_data( p_sys->p_archive, 0, SEEK_CUR ) >= 0 ) + p_sys->b_seekable_archive = true; + } + + return VLC_SUCCESS; +} + +/* ------------------------------------------------------------------------- */ + +static private_sys_t* setup( vlc_object_t* obj, stream_t* source ) +{ + private_sys_t* p_sys = calloc( 1, sizeof( *p_sys ) ); + char* psz_files = var_InheritString( p_sys->p_obj, "concat-list" ); + + if( unlikely( !p_sys ) ) + goto error; + + if( archive_push_resource( p_sys, source, NULL ) ) + goto error; + + if( psz_files ) + { + for( char* state, + * path = strtok_r( psz_files, ",", &state ); + path; path = strtok_r( NULL, ",", &state ) ) + { + if( path == psz_files ) + continue; + + if( archive_push_resource( p_sys, NULL, path ) ) + goto error; + } + + free( psz_files ); + } + + p_sys->source = source; + p_sys->p_obj = obj; + + return p_sys; + +error: + free( psz_files ); + free( p_sys ); + return NULL; +} + +static int probe( stream_t* source ) +{ + struct + { + uint16_t i_offset; + uint8_t i_length; + char const * p_bytes; + } const magicbytes[] = { + /* keep heaviest at top */ + { 257, 5, "ustar" }, //TAR + { 0, 7, "Rar!\x1A\x07" }, //RAR + { 0, 6, "7z\xBC\xAF\x27\x1C" }, //7z + { 0, 4, "xar!" }, //XAR + { 0, 4, "PK\x03\x04" }, //ZIP + { 0, 4, "PK\x05\x06" }, //ZIP + { 0, 4, "PK\x07\x08" }, //ZIP + { 2, 3, "-lh" }, //LHA/LHZ + { 0, 3, "\x1f\x8b\x08" }, // Gzip + { 0, 3, "PAX" }, //PAX + { 0, 6, "070707" }, //CPIO + { 0, 6, "070701" }, //CPIO + { 0, 6, "070702" }, //CPIO + { 0, 4, "MSCH" }, //CAB + }; + + const uint8_t *p_peek; + + int i_peek = vlc_stream_Peek( source, &p_peek, + magicbytes[0].i_offset + magicbytes[0].i_length); + + for(unsigned i=0; i < ARRAY_SIZE( magicbytes ); i++) + { + if (i_peek < magicbytes[i].i_offset + magicbytes[i].i_length) + continue; + + if ( !memcmp(p_peek + magicbytes[i].i_offset, + magicbytes[i].p_bytes, magicbytes[i].i_length) ) + return VLC_SUCCESS; + } + + return VLC_EGENERIC; +} + +/* ------------------------------------------------------------------------- */ + +static int Control( stream_extractor_t* p_extractor, int i_query, va_list args ) +{ + private_sys_t* p_sys = p_extractor->p_sys; + + if( p_sys->b_dead ) + return VLC_EGENERIC; + + switch( i_query ) + { + case STREAM_CAN_FASTSEEK: + *va_arg( args, bool* ) = false; + break; + + case STREAM_CAN_SEEK: + *va_arg( args, bool* ) = p_sys->b_seekable_source; + break; + + case STREAM_GET_SIZE: + *va_arg( args, uint64_t* ) = archive_entry_size( p_sys->p_entry ); + break; + + default: + return vlc_stream_vaControl( p_extractor->source, i_query, args ); + } + + return VLC_SUCCESS; +} + +static int ReadDir( stream_directory_t* p_directory, input_item_node_t* p_node ) +{ + private_sys_t* p_sys = p_directory->p_sys; + libarchive_t* p_arc = p_sys->p_archive; + + struct archive_entry* entry; + int archive_status; + + while( !( archive_status = archive_read_next_header( p_arc, &entry ) ) ) + { + if( archive_entry_filetype( entry ) == AE_IFDIR ) + continue; + + char const* path = archive_entry_pathname( entry ); + char* mrl = vlc_stream_extractor_CreateMRL( p_directory, path ); + + if( unlikely( !mrl ) ) + return VLC_ENOMEM; + + input_item_t* p_item = input_item_New( mrl, path ); + + free( mrl ); + + if( unlikely( !p_item ) ) + return VLC_ENOMEM; + + + input_item_CopyOptions( p_node->p_item, p_item ); + input_item_node_AppendItem( p_node, p_item ); + input_item_Release( p_item ); + + if( archive_read_data_skip( p_arc ) ) + break; + } + + if( archive_status != ARCHIVE_EOF ) + return VLC_EGENERIC; + + return VLC_SUCCESS; +} + +static ssize_t Read( stream_extractor_t *p_extractor, void* p_data, size_t i_size ) +{ + char dummy_buffer[ 8192 ]; + + private_sys_t* p_sys = p_extractor->p_sys; + libarchive_t* p_arc = p_sys->p_archive; + ssize_t i_ret; + + if( p_sys->b_dead ) + return 0; + + i_ret = archive_read_data( p_arc, + p_data ? p_data : dummy_buffer, + p_data ? i_size : __MIN( i_size, sizeof( dummy_buffer ) ) ); + + switch( i_ret ) + { + case ARCHIVE_RETRY: + case ARCHIVE_FAILED: + msg_Dbg( p_extractor, "libarchive: %s", archive_error_string( p_arc ) ); + return -1; + + case ARCHIVE_WARN: + msg_Warn( p_extractor, "libarchive: %s", archive_error_string( p_arc ) ); + return -1; + + case ARCHIVE_FATAL: + p_sys->b_dead = true; + msg_Err( p_extractor, "libarchive: %s", archive_error_string( p_arc ) ); + return 0; + } + + p_sys->i_offset += i_ret; + return i_ret; +} + +static int Seek( stream_extractor_t* p_extractor, uint64_t i_req ) +{ + private_sys_t* p_sys = p_extractor->p_sys; + + if( p_sys->b_dead ) + return VLC_EGENERIC; + + if( !p_sys->p_entry ) + return VLC_EGENERIC; + + if( !p_sys->b_seekable_source ) + return VLC_EGENERIC; + + if( !p_sys->b_seekable_archive + || archive_seek_data( p_sys->p_archive, i_req, SEEK_SET ) < 0 ) + { + msg_Dbg( p_extractor, "libarchive intrinsic seek failed:" + " '%s' (falling back to dumb seek)", + archive_error_string( p_sys->p_archive ) ); + + uint64_t i_offset = p_sys->i_offset; + uint64_t i_skip = i_req - i_offset; + + /* RECREATE LIBARCHIE HANDLE IF WE ARE SEEKING BACKWARDS */ + + if( i_req < i_offset ) + { + if( archive_clean( p_sys ) ) + return VLC_EGENERIC; + + if( archive_init( p_sys, p_extractor->source ) ) + return VLC_EGENERIC; + + if( archive_seek_subentry( p_sys, p_extractor->identifier ) ) + return VLC_EGENERIC; + + i_skip = i_req; + i_offset = 0; + } + + /* SKIP _DECOMPRESSED_ DATA */ + + while( i_skip ) + { + ssize_t i_read = Read( p_extractor, NULL, i_skip ); + + if( i_read < 1 ) + return VLC_EGENERIC; + + i_offset += i_read; + i_skip -= i_read; + } + } + + p_sys->i_offset = i_req; + return VLC_SUCCESS; +} + + +static void CommonClose( private_sys_t* p_sys ) +{ + archive_clean( p_sys ); + + for( size_t i = 0; i < p_sys->i_callback_data; ++i ) + { + free( p_sys->pp_callback_data[i]->psz_url ); + free( p_sys->pp_callback_data[i] ); + } + + free( p_sys->pp_callback_data ); + free( p_sys ); +} + +static void DirectoryClose( vlc_object_t* p_obj ) +{ + stream_directory_t* p_directory = (void*)p_obj; + return CommonClose( p_directory->p_sys ); +} + +static void ExtractorClose( vlc_object_t* p_obj ) +{ + stream_extractor_t* p_extractor = (void*)p_obj; + return CommonClose( p_extractor->p_sys ); +} + +static private_sys_t* CommonOpen( vlc_object_t* p_obj, stream_t* source ) +{ + if( probe( source ) ) + return NULL; + + private_sys_t* p_sys = setup( p_obj, source ); + + if( p_sys == NULL ) + return NULL; + + if( archive_init( p_sys, source ) ) + { + CommonClose( p_sys ); + return NULL; + } + + return p_sys; +} + +static int DirectoryOpen( vlc_object_t* p_obj ) +{ + stream_directory_t* p_directory = (void*)p_obj; + private_sys_t* p_sys = CommonOpen( p_obj, p_directory->source ); + + if( p_sys == NULL ) + return VLC_EGENERIC; + + p_directory->p_sys = p_sys; + p_directory->pf_readdir = ReadDir; + + return VLC_SUCCESS; +} + +static int ExtractorOpen( vlc_object_t* p_obj ) +{ + stream_extractor_t* p_extractor = (void*)p_obj; + private_sys_t* p_sys = CommonOpen( p_obj, p_extractor->source ); + + if( archive_seek_subentry( p_sys, p_extractor->identifier ) ) + { + CommonClose( p_sys ); + return VLC_EGENERIC; + } + + p_extractor->p_sys = p_sys; + p_extractor->pf_read = Read; + p_extractor->pf_control = Control; + p_extractor->pf_seek = Seek; + + return VLC_SUCCESS; +} diff --git a/po/POTFILES.in b/po/POTFILES.in index 772e20e..08bf6d7 100644 --- a/po/POTFILES.in +++ b/po/POTFILES.in @@ -1017,6 +1017,7 @@ modules/spu/mosaic.c modules/spu/remoteosd.c modules/spu/rss.c modules/spu/subsdelay.c +modules/stream_extractor/archive.c modules/stream_filter/adf.c modules/stream_filter/aribcam.c modules/stream_filter/cache_block.c _______________________________________________ vlc-commits mailing list vlc-commits@videolan.org https://mailman.videolan.org/listinfo/vlc-commits
