matroska: refactor code common to matroskademux and matroskaparse
[gstreamer-omap:gst-plugins-good.git] / gst / matroska / matroska-read-common.h
1 /* GStreamer Matroska muxer/demuxer
2  * (c) 2003 Ronald Bultje <rbultje@ronald.bitfreak.net>
3  * (c) 2011 Debarshi Ray <rishi@gnu.org>
4  *
5  * matroska-read-common.h: shared by matroska file/stream demuxer and parser
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public
18  * License along with this library; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22
23 #ifndef __GST_MATROSKA_READ_COMMON_H__
24 #define __GST_MATROSKA_READ_COMMON_H__
25
26 #include <glib.h>
27 #include <gst/gst.h>
28 #include <gst/base/gstadapter.h>
29
30 #include "matroska-ids.h"
31
32 G_BEGIN_DECLS
33
34 typedef enum {
35   GST_MATROSKA_READ_STATE_START,
36   GST_MATROSKA_READ_STATE_SEGMENT,
37   GST_MATROSKA_READ_STATE_HEADER,
38   GST_MATROSKA_READ_STATE_DATA,
39   GST_MATROSKA_READ_STATE_SEEK,
40   GST_MATROSKA_READ_STATE_SCANNING
41 } GstMatroskaReadState;
42
43 typedef struct _GstMatroskaReadCommon {
44   GstIndex                *element_index;
45   gint                     element_index_writer_id;
46
47   /* pads */
48   GstPad                  *sinkpad;
49   GPtrArray               *src;
50   guint                    num_streams;
51
52   /* metadata */
53   gchar                   *muxing_app;
54   gchar                   *writing_app;
55   gint64                   created;
56
57   /* state */
58   GstMatroskaReadState     state;
59
60   /* did we parse cues/tracks/segmentinfo already? */
61   gboolean                 index_parsed;
62   gboolean                 segmentinfo_parsed;
63   gboolean                 attachments_parsed;
64   GList                   *tags_parsed;
65
66   /* start-of-segment */
67   guint64                  ebml_segment_start;
68
69   /* a cue (index) table */
70   GArray                  *index;
71
72   /* timescale in the file */
73   guint64                  time_scale;
74
75   /* keeping track of playback position */
76   GstSegment               segment;
77
78   GstTagList              *global_tags;
79
80   /* pull mode caching */
81   GstBuffer *cached_buffer;
82
83   /* push and pull mode */
84   guint64                  offset;
85
86   /* push based mode usual suspects */
87   GstAdapter              *adapter;
88 } GstMatroskaReadCommon;
89
90 GstFlowReturn gst_matroska_decode_content_encodings (GArray * encodings);
91 gboolean gst_matroska_decode_data (GArray * encodings, guint8 ** data_out,
92     guint * size_out, GstMatroskaTrackEncodingScope scope, gboolean free);
93 gint gst_matroska_index_seek_find (GstMatroskaIndex * i1, GstClockTime * time,
94     gpointer user_data);
95 GstMatroskaIndex * gst_matroska_read_common_do_index_seek (
96     GstMatroskaReadCommon * common, GstMatroskaTrackContext * track, gint64
97     seek_pos, GArray ** _index, gint * _entry_index);
98 void gst_matroska_read_common_found_global_tag (GstMatroskaReadCommon * common,
99     GstElement * el, GstTagList * taglist);
100 gint64 gst_matroska_read_common_get_length (GstMatroskaReadCommon * common);
101 GstMatroskaTrackContext * gst_matroska_read_common_get_seek_track (
102     GstMatroskaReadCommon * common, GstMatroskaTrackContext * track);
103 GstFlowReturn gst_matroska_read_common_parse_index (GstMatroskaReadCommon *
104     common, GstEbmlRead * ebml);
105 GstFlowReturn gst_matroska_read_common_parse_info (GstMatroskaReadCommon *
106     common, GstElement * el, GstEbmlRead * ebml);
107 GstFlowReturn gst_matroska_read_common_parse_attachments (
108     GstMatroskaReadCommon * common, GstElement * el, GstEbmlRead * ebml);
109 GstFlowReturn gst_matroska_read_common_parse_header (GstMatroskaReadCommon *
110     common, GstEbmlRead * ebml);
111 GstFlowReturn gst_matroska_read_common_parse_metadata (GstMatroskaReadCommon *
112     common, GstElement * el, GstEbmlRead * ebml);
113 GstFlowReturn gst_matroska_read_common_parse_skip (GstMatroskaReadCommon *
114     common, GstEbmlRead * ebml, const gchar * parent_name, guint id);
115 GstFlowReturn gst_matroska_read_common_peek_bytes (GstMatroskaReadCommon *
116     common, guint64 offset, guint size, GstBuffer ** p_buf, guint8 ** bytes);
117 GstFlowReturn gst_matroska_read_common_peek_id_length_pull (GstMatroskaReadCommon *
118     common, GstElement * el, guint32 * _id, guint64 * _length, guint *
119     _needed);
120 GstFlowReturn gst_matroska_read_common_peek_id_length_push (GstMatroskaReadCommon *
121     common, GstElement * el, guint32 * _id, guint64 * _length, guint *
122     _needed);
123 gint gst_matroska_read_common_stream_from_num (GstMatroskaReadCommon * common,
124     guint track_num);
125 GstFlowReturn gst_matroska_read_common_read_track_encodings (
126     GstMatroskaReadCommon * common, GstEbmlRead * ebml,
127     GstMatroskaTrackContext * context);
128 void gst_matroska_read_common_reset_streams (GstMatroskaReadCommon * common,
129     GstClockTime time, gboolean full);
130 gboolean gst_matroska_read_common_tracknumber_unique (GstMatroskaReadCommon *
131     common, guint64 num);
132
133 G_END_DECLS
134
135 #endif /* __GST_MATROSKA_READ_COMMON_H__ */