gst/isomp4/qtdemux.h

   1 /* GStreamer
   2  * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  17  * Boston, MA 02110-1301, USA.
  18  */
  19
  20
  21 #ifndef __GST_QTDEMUX_H__
  22 #define __GST_QTDEMUX_H__
  23
  24 #include <gst/gst.h>
  25 #include <gst/base/gstadapter.h>
  26 #include <gst/base/gstflowcombiner.h>
  27 #include "gstisoff.h"
  28
  29 G_BEGIN_DECLS
  30
  31 #define GST_TYPE_QTDEMUX \
  32   (gst_qtdemux_get_type())
  33 #define GST_QTDEMUX(obj) \
  34   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_QTDEMUX,GstQTDemux))
  35 #define GST_QTDEMUX_CLASS(klass) \
  36   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_QTDEMUX,GstQTDemuxClass))
  37 #define GST_IS_QTDEMUX(obj) \
  38   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_QTDEMUX))
  39 #define GST_IS_QTDEMUX_CLASS(klass) \
  40   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_QTDEMUX))
  41
  42 #define GST_QTDEMUX_CAST(obj) ((GstQTDemux *)(obj))
  43
  44 /* qtdemux produces these for atoms it cannot parse */
  45 #define GST_QT_DEMUX_PRIVATE_TAG "private-qt-tag"
  46 #define GST_QT_DEMUX_CLASSIFICATION_TAG "classification"
  47
  48 typedef struct _GstQTDemux GstQTDemux;
  49 typedef struct _GstQTDemuxClass GstQTDemuxClass;
  50 typedef struct _QtDemuxStream QtDemuxStream;
  51
  52 enum QtDemuxState
  53 {
  54   QTDEMUX_STATE_INITIAL,        /* Initial state (haven't got the header yet) */
  55   QTDEMUX_STATE_HEADER,         /* Parsing the header */
  56   QTDEMUX_STATE_MOVIE,          /* Parsing/Playing the media data */
  57   QTDEMUX_STATE_BUFFER_MDAT     /* Buffering the mdat atom */
  58 };
  59
  60 struct _GstQTDemux {
  61   GstElement element;
  62
  63   /* Global state */
  64   enum QtDemuxState state;
  65
  66   /* static sink pad */
  67   GstPad *sinkpad;
  68
  69   /* TRUE if pull-based */
  70   gboolean pullbased;
  71
  72   gboolean posted_redirect;
  73
  74   /* Protect pad exposing from flush event */
  75   GMutex expose_lock;
  76
  77   /* list of QtDemuxStream */
  78   GList *active_streams;
  79   GList *old_streams;
  80
  81   gint     n_streams;
  82   gint     n_video_streams;
  83   gint     n_audio_streams;
  84   gint     n_sub_streams;
  85
  86   GstFlowCombiner *flowcombiner;
  87
  88   /* Incoming stream group-id to set on downstream STREAM_START events.
  89    * If upstream doesn't contain one, a global one will be generated */
  90   gboolean have_group_id;
  91   guint group_id;
  92
  93   guint  major_brand;
  94   GstBuffer *comp_brands;
  95
  96   /* [moov] header.
  97    * FIXME : This is discarded just after it's created. Just move it
  98    * to a temporary variable ? */
  99   GNode *moov_node;
 100
 101   /* FIXME : This is never freed. It is only assigned once. memleak ? */
 102   GNode *moov_node_compressed;
 103
 104   /* Set to TRUE when the [moov] header has been fully parsed */
 105   gboolean got_moov;
 106
 107   /* Global timescale for the incoming stream. Use the QTTIME macros
 108    * to convert values to/from GstClockTime */
 109   guint32 timescale;
 110
 111   /* Global duration (in global timescale). Use QTTIME macros to get GstClockTime */
 112   guint64 duration;
 113
 114   /* Total size of header atoms. Used to calculate fallback overall bitrate */
 115   guint header_size;
 116
 117   GstTagList *tag_list;
 118
 119   /* configured playback region */
 120   GstSegment segment;
 121
 122   /* PUSH-BASED only: If the initial segment event, or a segment consequence of
 123    * a seek or incoming TIME segment from upstream needs to be pushed. This
 124    * variable is used instead of pushing the event directly because at that
 125    * point we may not have yet emitted the srcpads. */
 126   gboolean need_segment;
 127
 128   guint32 segment_seqnum;
 129
 130   /* flag to indicate that we're working with a smoothstreaming fragment
 131    * Mss doesn't have 'moov' or any information about the streams format,
 132    * requiring qtdemux to expose and create the streams */
 133   gboolean mss_mode;
 134
 135   /* Set to TRUE if the incoming stream is either a MSS stream or
 136    * a Fragmented MP4 (containing the [mvex] atom in the header) */
 137   gboolean fragmented;
 138
 139   /* PULL-BASED only : If TRUE there is a pending seek */
 140   gboolean fragmented_seek_pending;
 141
 142   /* PULL-BASED : offset of first [moof] or of fragment to seek to
 143    * PUSH-BASED : offset of latest [moof] */
 144   guint64 moof_offset;
 145
 146   /* MSS streams have a single media that is unspecified at the atoms, so
 147    * upstream provides it at the caps */
 148   GstCaps *media_caps;
 149
 150   /* Set to TRUE when all streams have been exposed */
 151   gboolean exposed;
 152
 153   gint64 chapters_track_id;
 154
 155   /* protection support */
 156   GPtrArray *protection_system_ids; /* Holds identifiers of all content protection systems for all tracks */
 157   GQueue protection_event_queue; /* holds copy of upstream protection events */
 158   guint64 cenc_aux_info_offset;
 159   guint8 *cenc_aux_info_sizes;
 160   guint32 cenc_aux_sample_count;
 161   gchar *preferred_protection_system_id;
 162
 163   /* Whether the parent bin is streams-aware, meaning we can
 164    * add/remove streams at any point in time */
 165   gboolean streams_aware;
 166
 167   /*
 168    * ALL VARIABLES BELOW ARE ONLY USED IN PUSH-BASED MODE
 169    */
 170   GstAdapter *adapter;
 171   guint neededbytes;
 172   guint todrop;
 173   /* Used to store data if [mdat] is before the headers */
 174   GstBuffer *mdatbuffer;
 175   /* Amount of bytes left to read in the current [mdat] */
 176   guint64 mdatleft, mdatsize;
 177
 178   /* When restoring the mdat to the adapter, this buffer stores any
 179    * trailing data that was after the last atom parsed as it has to be
 180    * restored later along with the correct offset. Used in fragmented
 181    * scenario where mdat/moof are one after the other in any order.
 182    *
 183    * Check https://bugzilla.gnome.org/show_bug.cgi?id=710623 */
 184   GstBuffer *restoredata_buffer;
 185   guint64 restoredata_offset;
 186
 187   /* The current offset in bytes from upstream.
 188    * Note: While it makes complete sense when we are PULL-BASED (pulling
 189    * in BYTES from upstream) and PUSH-BASED with a BYTE SEGMENT (receiving
 190    * buffers with actual offsets), it is undefined in PUSH-BASED with a
 191    * TIME SEGMENT */
 192   guint64 offset;
 193
 194   /* offset of the mdat atom */
 195   guint64 mdatoffset;
 196   /* Offset of the first mdat */
 197   guint64 first_mdat;
 198   /* offset of last [moov] seen */
 199   guint64 last_moov_offset;
 200
 201   /* If TRUE, qtdemux received upstream newsegment in TIME format
 202    * which likely means that upstream is driving the pipeline (such as
 203    * adaptive demuxers or dlna sources) */
 204   gboolean upstream_format_is_time;
 205
 206   /* Seqnum of the seek event sent upstream.  Will be used to
 207    * detect incoming FLUSH events corresponding to that */
 208   guint32 offset_seek_seqnum;
 209
 210   /* UPSTREAM BYTE: Requested upstream byte seek offset.
 211    * Currently it is only used to check if an incoming BYTE SEGMENT
 212    * corresponds to a seek event that was sent upstream */
 213   gint64 seek_offset;
 214
 215   /* UPSTREAM BYTE: Requested start/stop TIME values from
 216    * downstream.
 217    * Used to set on the downstream segment once the corresponding upstream
 218    * BYTE SEEK has succeeded */
 219   gint64 push_seek_start;
 220   gint64 push_seek_stop;
 221
 222 #if 0
 223   /* gst index support */
 224   GstIndex *element_index;
 225   gint index_id;
 226 #endif
 227
 228   /* Whether upstream is seekable in BYTES */
 229   gboolean upstream_seekable;
 230   /* UPSTREAM BYTE: Size of upstream content.
 231    * Note : This is only computed once ! If upstream grows in the meantime
 232    * it will not be updated */
 233   gint64 upstream_size;
 234
 235   /* UPSTREAM TIME : Contains the PTS (if any) of the
 236    * buffer that contains a [moof] header. Will be used to establish
 237    * the actual PTS of the samples contained within that fragment. */
 238   guint64 fragment_start;
 239   /* UPSTREAM TIME : The offset in bytes of the [moof]
 240    * header start.
 241    * Note : This is not computed from the GST_BUFFER_OFFSET field */
 242   guint64 fragment_start_offset;
 243
 244   /* These two fields are used to perform an implicit seek when a fragmented
 245    * file whose first tfdt is not zero. This way if the first fragment starts
 246    * at 1 hour, the user does not have to wait 1 hour or perform a manual seek
 247    * for the image to move and the sound to play.
 248    *
 249    * This implicit seek is only done if the first parsed fragment has a non-zero
 250    * decode base time and a seek has not been received previously, hence these
 251    * fields. */
 252   gboolean received_seek;
 253   gboolean first_moof_already_parsed;
 254 };
 255
 256 struct _GstQTDemuxClass {
 257   GstElementClass parent_class;
 258 };
 259
 260 GType gst_qtdemux_get_type (void);
 261
 262 G_END_DECLS
 263
 264 #endif /* __GST_QTDEMUX_H__ */