gst/matroska/ebml-write.h

   1 /* GStreamer EBML I/O
   2  * (c) 2003 Ronald Bultje <rbultje@ronald.bitfreak.net>
   3  * (c) 2005 Michal Benes <michal.benes@xeris.cz>
   4  *
   5  * ebml-write.c: write EBML data to file/stream
   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_EBML_WRITE_H__
  24 #define __GST_EBML_WRITE_H__
  25
  26 #include <glib.h>
  27 #include <gst/gst.h>
  28 #include <gst/base/gstbytewriter.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define GST_TYPE_EBML_WRITE \
  33   (gst_ebml_write_get_type ())
  34 #define GST_EBML_WRITE(obj) \
  35   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_EBML_WRITE, GstEbmlWrite))
  36 #define GST_EBML_WRITE_CLASS(klass) \
  37   (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_EBML_WRITE, GstEbmlWriteClass))
  38 #define GST_IS_EBML_WRITE(obj) \
  39   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_EBML_WRITE))
  40 #define GST_IS_EBML_WRITE_CLASS(klass) \
  41   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_EBML_WRITE))
  42 #define GST_EBML_WRITE_GET_CLASS(obj) \
  43   (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_EBML_WRITE, GstEbmlWriteClass))
  44
  45 typedef struct _GstEbmlWrite {
  46   GstObject object;
  47
  48   GstPad *srcpad;
  49   guint64 pos;
  50   guint64 last_pos;
  51   GstClockTime timestamp;
  52
  53   GstByteWriter *cache;
  54   guint64 cache_pos;
  55
  56   GstFlowReturn last_write_result;
  57
  58   gboolean writing_streamheader;
  59   GstByteWriter *streamheader;
  60   guint64 streamheader_pos;
  61
  62   GstCaps *caps;
  63 } GstEbmlWrite;
  64
  65 typedef struct _GstEbmlWriteClass {
  66   GstObjectClass parent;
  67 } GstEbmlWriteClass;
  68
  69 GType   gst_ebml_write_get_type      (void);
  70
  71 GstEbmlWrite *gst_ebml_write_new     (GstPad *srcpad);
  72 void    gst_ebml_write_reset         (GstEbmlWrite *ebml);
  73
  74 GstFlowReturn gst_ebml_last_write_result (GstEbmlWrite *ebml);
  75
  76 /* Used to create streamheaders */
  77 void    gst_ebml_start_streamheader  (GstEbmlWrite *ebml);
  78 GstBuffer*    gst_ebml_stop_streamheader   (GstEbmlWrite *ebml);
  79
  80 /*
  81  * Caching means that we do not push one buffer for
  82  * each element, but fill this one until a flush.
  83  */
  84 void    gst_ebml_write_set_cache     (GstEbmlWrite *ebml,
  85                                       guint         size);
  86 void    gst_ebml_write_flush_cache   (GstEbmlWrite *ebml,
  87                                       gboolean is_keyframe,
  88                                       GstClockTime timestamp);
  89
  90 /*
  91  * Seeking.
  92  */
  93 void    gst_ebml_write_seek          (GstEbmlWrite *ebml,
  94                                       guint64       pos);
  95
  96 /*
  97  * Data writing.
  98  */
  99 void    gst_ebml_write_uint          (GstEbmlWrite *ebml,
 100                                       guint32       id,
 101                                       guint64       num);
 102 void    gst_ebml_write_sint          (GstEbmlWrite *ebml,
 103                                       guint32       id,
 104                                       gint64        num);
 105 void    gst_ebml_write_float         (GstEbmlWrite *ebml,
 106                                       guint32       id,
 107                                       gdouble       num);
 108 void    gst_ebml_write_ascii         (GstEbmlWrite *ebml,
 109                                       guint32       id,
 110                                       const gchar  *str);
 111 void    gst_ebml_write_utf8          (GstEbmlWrite *ebml,
 112                                       guint32       id,
 113                                       const gchar  *str);
 114 void    gst_ebml_write_date          (GstEbmlWrite *ebml,
 115                                       guint32       id,
 116                                       gint64        date);
 117 guint64 gst_ebml_write_master_start  (GstEbmlWrite *ebml,
 118                                       guint32       id);
 119 void    gst_ebml_write_master_finish (GstEbmlWrite *ebml,
 120                                       guint64       startpos);
 121 void    gst_ebml_write_master_finish_full (GstEbmlWrite * ebml,
 122                                       guint64 startpos,
 123                                       guint64 extra_size);
 124 void    gst_ebml_write_binary        (GstEbmlWrite *ebml,
 125                                       guint32       id,
 126                                       guchar       *binary,
 127                                       guint64       length);
 128 void    gst_ebml_write_header        (GstEbmlWrite *ebml,
 129                                       const gchar  *doctype,
 130                                       guint         version);
 131
 132 /*
 133  * Note: this is supposed to be used only for media data.
 134  */
 135 void    gst_ebml_write_buffer_header (GstEbmlWrite *ebml,
 136                                       guint32       id,
 137                                       guint64       length);
 138 void    gst_ebml_write_buffer        (GstEbmlWrite *ebml,
 139                                       GstBuffer    *data);
 140
 141 /*
 142  * A hack, basically... See matroska-mux.c. I should actually
 143  * make a nice _replace_element_with_size() or so, but this
 144  * works for now.
 145  */
 146 void    gst_ebml_replace_uint        (GstEbmlWrite *ebml,
 147                                       guint64       pos,
 148                                       guint64       num);
 149
 150 G_END_DECLS
 151
 152 #endif /* __GST_EBML_WRITE_H__ */