[vlc-commits] skiptags: properly conceal ID3/APE tags (fixes #18501)
Rémi Denis-Courmont
git at videolan.org
Sun Jul 9 11:12:17 CEST 2017
vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Sat Jul 8 12:24:27 2017 +0300| [2c34ea75491e40e0aeb3f9e33094f5cd2da6d05a] | committer: Rémi Denis-Courmont
skiptags: properly conceal ID3/APE tags (fixes #18501)
As most demuxers cannot handle tags at the beginning of their input
streams, the demuxer code has automatically skipped them for a long
time.
Unfortunately, a number of demuxers also assume that the initial stream
byte offset is zero (while some others seem to assume zero in some paths
and not in others). This seems like a reasonable assumption. And even if
it were not, fixing all affected stream filters and demuxers to perform
only relative seeking seems impractical and unpalatable.
This stream filter shifts the stream byte offset so that the tags are
entirely invisible, and the demuxer can assume the start is at offset 0.
Of couse, the tags must still be accessible to the meta extraction
engine(s). The TagLib plugin uses "low-level" vlc_access_NewMRL() so it
is not subject to stream filters, and not affected by this change.
(This change does however remove tags from "demuxdump".)
NOTE: On the one hand, this also enables demuxing a file format with
embedded absolute file offsets, if the tags were prepended after muxing.
On the other hand, it conversely breaks demuxing such a file format if
the tags are added during muxing. As far as I know, tags are normally
appended rather than prepended to avoid this ambiguity.
> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=2c34ea75491e40e0aeb3f9e33094f5cd2da6d05a
---
modules/MODULES_LIST | 1 +
modules/stream_filter/Makefile.am | 3 +
modules/stream_filter/skiptags.c | 180 ++++++++++++++++++++++++++++++++++++++
po/POTFILES.in | 1 +
4 files changed, 185 insertions(+)
diff --git a/modules/MODULES_LIST b/modules/MODULES_LIST
index 353df9f1a7..ec2ed4ba5e 100644
--- a/modules/MODULES_LIST
+++ b/modules/MODULES_LIST
@@ -352,6 +352,7 @@ $Id$
* sid: Sidplay demuxer
* simple_channel_mixer: channel mixer
* skins2: Skinnable interface, new generation
+ * skiptags: APE & ID3 tags-skipping stream filter
* smb: SMB shares access module
* smf: Standard MIDI file demuxer
* sndio: OpenBSD sndio audio output
diff --git a/modules/stream_filter/Makefile.am b/modules/stream_filter/Makefile.am
index e8026e46ca..50d99faac9 100644
--- a/modules/stream_filter/Makefile.am
+++ b/modules/stream_filter/Makefile.am
@@ -52,3 +52,6 @@ EXTRA_LTLIBRARIES += libaccesstweaks_plugin.la
libadf_plugin_la_SOURCES = stream_filter/adf.c
stream_filter_LTLIBRARIES += libadf_plugin.la
+
+libskiptags_plugin_la_SOURCES = stream_filter/skiptags.c
+stream_filter_LTLIBRARIES += libskiptags_plugin.la
diff --git a/modules/stream_filter/skiptags.c b/modules/stream_filter/skiptags.c
new file mode 100644
index 0000000000..b33966f041
--- /dev/null
+++ b/modules/stream_filter/skiptags.c
@@ -0,0 +1,180 @@
+/*****************************************************************************
+ * skiptags.c:
+ *****************************************************************************
+ * Copyright © 2005-2008 VLC authors and VideoLAN
+ * Copyright © 2016-2017 Rémi Denis-Courmont
+ *
+ * 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 <limits.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include <vlc_common.h>
+#include <vlc_plugin.h>
+#include <vlc_stream.h>
+
+struct skiptags_sys_t
+{
+ uint64_t header_skip;
+ /* TODO? also discard trailer tags? */
+};
+
+static int SkipID3Tag(stream_t *s)
+{
+ const uint8_t *peek;
+
+ /* Get 10-bytes ID3 header */
+ if (vlc_stream_Peek(s, &peek, 10) < 10)
+ return 0;
+ if (memcmp(peek, "ID3", 3))
+ return 0;
+
+ uint_fast8_t version = peek[3];
+ uint_fast8_t revision = peek[4];
+ bool has_footer = (peek[5] & 0x10) != 0;
+ uint_fast32_t size = 10u + (peek[6] << 21) + (peek[7] << 14)
+ + (peek[8] << 7) + peek[9] + (has_footer ? 10u : 0u);
+
+ /* Skip the entire tag */
+ msg_Dbg(s, "ID3v2.%"PRIuFAST8" revision %"PRIuFAST8" tag found, "
+ "skipping %"PRIuFAST32" bytes", version, revision, size);
+ if (vlc_stream_Read(s, NULL, size) < (ssize_t)size)
+ return -1;
+
+ return 1;
+}
+
+static int SkipAPETag(stream_t *s)
+{
+ const uint8_t *peek;
+
+ /* Get 32-bytes APE header */
+ if (vlc_stream_Peek(s, &peek, 32) < 32)
+ return 0;
+ if (memcmp(peek, "APETAGEX", 8))
+ return 0;
+
+ uint_fast32_t version = GetDWLE(peek + 8);
+ if (version != 1000 && version != 2000)
+ return 0;
+
+ uint_fast32_t size = GetDWLE(peek + 12);
+ if (size > SSIZE_MAX - 32u)
+ return 0; /* impossibly long tag */
+
+ uint_fast32_t flags = GetDWLE(peek + 16);
+ if ((flags & (1u << 29)) == 0)
+ return 0;
+
+ if (flags & (1u << 30))
+ size += 32;
+
+ /* Skip the entire tag */
+ if (vlc_stream_Read(s, NULL, size) < (ssize_t)size)
+ return -1;
+
+ msg_Dbg(s, "AP2 v%"PRIuFAST32" tag found, "
+ "skipping %"PRIuFAST32" bytes", version / 1000, size);
+ return 1;
+}
+
+static bool SkipTag(stream_t *s, int (*skipper)(stream_t *))
+{
+ uint_fast64_t offset = vlc_stream_Tell(s);
+ int val = skipper(s);
+ if (unlikely(val < 0))
+ { /* I/O error, try to restore offset. If it fails, screwed. */
+ if (vlc_stream_Seek(s, offset))
+ msg_Err(s, "seek failure");
+ return false;
+ }
+ return val != 0;
+}
+
+static ssize_t Read(stream_t *stream, void *buf, size_t buflen)
+{
+ return vlc_stream_Read(stream->p_source, buf, buflen);
+}
+
+static int ReadDir(stream_t *stream, input_item_node_t *node)
+{
+ (void) stream; (void) node;
+ return VLC_EGENERIC;
+}
+
+static int Seek(stream_t *stream, uint64_t offset)
+{
+ const struct skiptags_sys_t *sys = stream->p_sys;
+
+ if (unlikely(offset + sys->header_skip < offset))
+ return -1;
+ return vlc_stream_Seek(stream->p_source, sys->header_skip + offset);
+}
+
+static int Control(stream_t *stream, int query, va_list args)
+{
+ /* In principles, we should return the meta-data embedded in the skipped
+ * tags in STREAM_GET_META. But the meta engine is devoted to that already.
+ */
+ return vlc_stream_vaControl(stream->p_source, query, args);
+}
+
+static int Open(vlc_object_t *obj)
+{
+ stream_t *stream = (stream_t *)obj;
+ stream_t *s = stream->p_source;
+
+ while (SkipTag(s, SkipID3Tag));
+ SkipTag(s, SkipAPETag);
+
+ uint_fast64_t offset = vlc_stream_Tell(s);
+ if (offset == 0)
+ return VLC_EGENERIC; /* nothing to do */
+
+ struct skiptags_sys_t *sys = malloc(sizeof (*sys));
+ if (unlikely(sys == NULL))
+ return VLC_ENOMEM;
+
+ sys->header_skip = offset;
+ stream->p_sys = sys;
+ stream->pf_read = Read;
+ stream->pf_readdir = ReadDir;
+ stream->pf_seek = Seek;
+ stream->pf_control = Control;
+ return VLC_SUCCESS;
+}
+
+static void Close(vlc_object_t *obj)
+{
+ stream_t *stream = (stream_t *)obj;
+ stream_sys_t *sys = stream->p_sys;
+
+ free(sys);
+}
+
+vlc_module_begin()
+ set_category(CAT_INPUT)
+ set_subcategory(SUBCAT_INPUT_STREAM_FILTER)
+ set_capability("stream_filter", 30)
+
+ set_description(N_("APE/ID3 tags-skipping filter"))
+ set_callbacks(Open, Close)
+vlc_module_end()
diff --git a/po/POTFILES.in b/po/POTFILES.in
index d5e49253ad..65d351e900 100644
--- a/po/POTFILES.in
+++ b/po/POTFILES.in
@@ -1019,6 +1019,7 @@ modules/stream_filter/hds/hds.c
modules/stream_filter/inflate.c
modules/stream_filter/prefetch.c
modules/stream_filter/record.c
+modules/stream_filter/skiptags.c
modules/stream_out/autodel.c
modules/stream_out/bridge.c
modules/stream_out/cycle.c
More information about the vlc-commits
mailing list