gstreamer/gst/matroska/matroska-mux.h
fengalin a6702a76d5 matroska: re-activate and update TOC support
TOC support in mastroskamux has been deactivated for a couple of years. This commit updates it to recent GstToc evolutions and introduces toc unit tests for both matroska-mux and matroska-demux.

There are two UIDs for Chapters in Matroska's specifications:
- The ChapterUID is a mandatory unsigned integer which internally refers to a given chapter. Except for title & language which use dedicated fields, this UID can also be used to add tags to the Chapter. The tags come in a separate section of the container.
- The ChapterStringUID is an optional UTF-8 string which also uniquely refers to a chapter but from an external perspective. It can act as a "WebVTT cue identifier" which "can be used to reference a specific cue, for example from script or CSS".

During muxing, the ChapterUID is generated and checked for unicity, while the ChapterStringUID receives the user defined UID. In order to be able to refer to chapters from the tags section, we maintain an internal Toc tree with the generated ChapterUID.

When demuxing, the ChapterStringUIDs (if available) are assigned to the GstTocEntries UIDs and an internal toc mimicking the toc is used to keep track of the ChapterUIDs and match the tags with the appropriate GstTocEntries.

https://bugzilla.gnome.org/show_bug.cgi?id=790686
2017-12-15 16:14:43 +02:00

156 lines
4.2 KiB
C

/* GStreamer Matroska muxer/demuxer
* (c) 2003 Ronald Bultje <rbultje@ronald.bitfreak.net>
* (c) 2005 Michal Benes <michal.benes@xeris.cz>
*
* matroska-mux.h: matroska file/stream muxer object types
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef __GST_MATROSKA_MUX_H__
#define __GST_MATROSKA_MUX_H__
#include <gst/gst.h>
#include <gst/base/gstcollectpads.h>
#include "ebml-write.h"
#include "matroska-ids.h"
G_BEGIN_DECLS
#define GST_TYPE_MATROSKA_MUX \
(gst_matroska_mux_get_type ())
#define GST_MATROSKA_MUX(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_MATROSKA_MUX, GstMatroskaMux))
#define GST_MATROSKA_MUX_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_MATROSKA_MUX, GstMatroskaMuxClass))
#define GST_IS_MATROSKA_MUX(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_MATROSKA_MUX))
#define GST_IS_MATROSKA_MUX_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_MATROSKA_MUX))
typedef enum {
GST_MATROSKA_MUX_STATE_START,
GST_MATROSKA_MUX_STATE_HEADER,
GST_MATROSKA_MUX_STATE_DATA,
} GstMatroskaMuxState;
typedef struct _GstMatroskaMetaSeekIndex {
guint32 id;
guint64 pos;
} GstMatroskaMetaSeekIndex;
typedef gboolean (*GstMatroskaCapsFunc) (GstPad *pad, GstCaps *caps);
typedef struct _GstMatroskaMux GstMatroskaMux;
/* all information needed for one matroska stream */
typedef struct
{
GstCollectData collect; /* we extend the CollectData */
GstMatroskaCapsFunc capsfunc;
GstMatroskaTrackContext *track;
GstMatroskaMux *mux;
GstTagList *tags;
GstClockTime start_ts;
GstClockTime end_ts; /* last timestamp + (if available) duration */
guint64 default_duration_scaled;
}
GstMatroskaPad;
struct _GstMatroskaMux {
GstElement element;
/* < private > */
/* pads */
GstPad *srcpad;
GstCollectPads *collect;
GstEbmlWrite *ebml_write;
guint num_streams,
num_v_streams, num_a_streams, num_t_streams;
/* Application name (for the writing application header element) */
gchar *writing_app;
/* EBML DocType. */
const gchar *doctype;
/* DocType version. */
guint doctype_version;
/* state */
GstMatroskaMuxState state;
/* a cue (index) table */
GstMatroskaIndex *index;
guint num_indexes;
GstClockTimeDiff min_index_interval;
/* timescale in the file */
guint64 time_scale;
/* minimum and maximum limit of nanoseconds you can have in a cluster */
guint64 max_cluster_duration;
guint64 min_cluster_duration;
/* length, position (time, ns) */
guint64 duration;
/* byte-positions of master-elements (for replacing contents) */
guint64 segment_pos,
seekhead_pos,
cues_pos,
chapters_pos,
tags_pos,
info_pos,
tracks_pos,
duration_pos,
meta_pos;
guint64 segment_master;
/* current cluster */
guint64 cluster,
cluster_time,
cluster_pos,
prev_cluster_size;
/* GstForceKeyUnit event */
GstEvent *force_key_unit_event;
/* Internal Toc (adjusted UIDs and title tags removed when processed) */
GstToc *internal_toc;
/* Flag to ease handling of WebM specifics */
gboolean is_webm;
/* used uids */
GArray *used_uids;
};
typedef struct _GstMatroskaMuxClass {
GstElementClass parent;
} GstMatroskaMuxClass;
GType gst_matroska_mux_get_type (void);
G_END_DECLS
#endif /* __GST_MATROSKA_MUX_H__ */