matroska: refactor code common to matroskademux and matroskaparse
[gstreamer-omap:kzeros-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   GList                   *tags_parsed;
64
65   /* start-of-segment */
66   guint64                  ebml_segment_start;
67
68   /* a cue (index) table */
69   GArray                  *index;
70
71   /* timescale in the file */
72   guint64                  time_scale;
73
74   /* keeping track of playback position */
75   GstSegment               segment;
76
77   GstTagList              *global_tags;
78
79   /* pull mode caching */
80   GstBuffer *cached_buffer;
81
82   /* push and pull mode */
83   guint64                  offset;
84
85   /* push based mode usual suspects */
86   GstAdapter              *adapter;
87 } GstMatroskaReadCommon;
88
89 GstFlowReturn gst_matroska_decode_content_encodings (GArray * encodings);
90 gboolean gst_matroska_decode_data (GArray * encodings, guint8 ** data_out,
91     guint * size_out, GstMatroskaTrackEncodingScope scope, gboolean free);
92 gint gst_matroska_index_seek_find (GstMatroskaIndex * i1, GstClockTime * time,
93     gpointer user_data);
94 GstMatroskaIndex * gst_matroska_read_common_do_index_seek (
95     GstMatroskaReadCommon * common, GstMatroskaTrackContext * track, gint64
96     seek_pos, GArray ** _index, gint * _entry_index);
97 void gst_matroska_read_common_found_global_tag (GstMatroskaReadCommon * common,
98     GstElement * el, GstTagList * taglist);
99 gint64 gst_matroska_read_common_get_length (GstMatroskaReadCommon * common);
100 GstMatroskaTrackContext * gst_matroska_read_common_get_seek_track (
101     GstMatroskaReadCommon * common, GstMatroskaTrackContext * track);
102 GstFlowReturn gst_matroska_read_common_parse_index (GstMatroskaReadCommon *
103     common, GstEbmlRead * ebml);
104 GstFlowReturn gst_matroska_read_common_parse_info (GstMatroskaReadCommon *
105     common, GstElement * el, GstEbmlRead * ebml);
106 GstFlowReturn gst_matroska_read_common_parse_attached_file (
107     GstMatroskaReadCommon * common, GstEbmlRead * ebml, GstTagList * taglist);
108 GstFlowReturn gst_matroska_read_common_parse_header (GstMatroskaReadCommon *
109     common, GstEbmlRead * ebml);
110 GstFlowReturn gst_matroska_read_common_parse_metadata (GstMatroskaReadCommon *
111     common, GstElement * el, GstEbmlRead * ebml);
112 GstFlowReturn gst_matroska_read_common_parse_skip (GstMatroskaReadCommon *
113     common, GstEbmlRead * ebml, const gchar * parent_name, guint id);
114 GstFlowReturn gst_matroska_read_common_peek_bytes (GstMatroskaReadCommon *
115     common, guint64 offset, guint size, GstBuffer ** p_buf, guint8 ** bytes);
116 GstFlowReturn gst_matroska_read_common_peek_id_length_pull (GstMatroskaReadCommon *
117     common, GstElement * el, guint32 * _id, guint64 * _length, guint *
118     _needed);
119 GstFlowReturn gst_matroska_read_common_peek_id_length_push (GstMatroskaReadCommon *
120     common, GstElement * el, guint32 * _id, guint64 * _length, guint *
121     _needed);
122 gint gst_matroska_read_common_stream_from_num (GstMatroskaReadCommon * common,
123     guint track_num);
124 GstFlowReturn gst_matroska_read_common_read_track_encodings (
125     GstMatroskaReadCommon * common, GstEbmlRead * ebml,
126     GstMatroskaTrackContext * context);
127 void gst_matroska_read_common_reset_streams (GstMatroskaReadCommon * common,
128     GstClockTime time, gboolean full);
129 gboolean gst_matroska_read_common_tracknumber_unique (GstMatroskaReadCommon *
130     common, guint64 num);
131
132 G_END_DECLS
133
134 #endif /* __GST_MATROSKA_READ_COMMON_H__ */