subprojects/gstreamer/plugins/elements/gstfilesink.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gstfilesink.h:
   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., 51 Franklin St, Fifth Floor,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23
  24 #ifndef __GST_FILE_SINK_H__
  25 #define __GST_FILE_SINK_H__
  26
  27 #include <stdio.h>
  28
  29 #include <gst/gst.h>
  30 #include <gst/base/gstbasesink.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define GST_TYPE_FILE_SINK \
  35   (gst_file_sink_get_type())
  36 #define GST_FILE_SINK(obj) \
  37   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_FILE_SINK,GstFileSink))
  38 #define GST_FILE_SINK_CLASS(klass) \
  39   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_FILE_SINK,GstFileSinkClass))
  40 #define GST_IS_FILE_SINK(obj) \
  41   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_FILE_SINK))
  42 #define GST_IS_FILE_SINK_CLASS(klass) \
  43   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_FILE_SINK))
  44 #define GST_FILE_SINK_CAST(obj) ((GstFileSink *)(obj))
  45
  46 typedef struct _GstFileSink GstFileSink;
  47 typedef struct _GstFileSinkClass GstFileSinkClass;
  48
  49 /**
  50  * GstFileSinkBufferMode:
  51  * @GST_FILE_SINK_BUFFER_MODE_DEFAULT: Default buffering
  52  * @GST_FILE_SINK_BUFFER_MODE_FULL: Fully buffered
  53  * @GST_FILE_SINK_BUFFER_MODE_LINE: Line buffered
  54  * @GST_FILE_SINK_BUFFER_MODE_UNBUFFERED: Unbuffered
  55  *
  56  * File read buffering mode.
  57  */
  58 typedef enum {
  59   GST_FILE_SINK_BUFFER_MODE_DEFAULT    = -1,
  60   GST_FILE_SINK_BUFFER_MODE_FULL       = _IOFBF,
  61   GST_FILE_SINK_BUFFER_MODE_LINE       = _IOLBF,
  62   GST_FILE_SINK_BUFFER_MODE_UNBUFFERED = _IONBF
  63 } GstFileSinkBufferMode;
  64
  65 /**
  66  * GstFileSink:
  67  *
  68  * Opaque #GstFileSink structure.
  69  */
  70 struct _GstFileSink {
  71   GstBaseSink parent;
  72
  73   /*< private >*/
  74   gchar *filename;
  75   gchar *uri;
  76   FILE *file;
  77
  78   gboolean seekable;
  79   guint64 current_pos;
  80
  81   gint    buffer_mode;
  82   guint   buffer_size;
  83
  84   /* For default buffer mode */
  85   GstBufferList *buffer_list;
  86
  87   /* For full buffer mode */
  88   guint8 *buffer;
  89   gsize   allocated_buffer_size;
  90
  91   /* For default/full buffer mode */
  92   gsize current_buffer_size;
  93
  94   gboolean append;
  95   gboolean o_sync;
  96   gint max_transient_error_timeout;
  97
  98   gboolean flushing;
  99 };
 100
 101 struct _GstFileSinkClass {
 102   GstBaseSinkClass parent_class;
 103 };
 104
 105 G_GNUC_INTERNAL GType gst_file_sink_get_type (void);
 106
 107 G_END_DECLS
 108
 109 #endif /* __GST_FILE_SINK_H__ */