gst/base/gstbasesrc.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *                    2005 Wim Taymans <wim@fluendo.com>
   5  *
   6  * gstbasesrc.h:
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 #ifndef __GST_BASESRC_H__
  25 #define __GST_BASESRC_H__
  26
  27 #include <gst/gst.h>
  28
  29 G_BEGIN_DECLS
  30
  31 #define GST_TYPE_BASESRC                (gst_basesrc_get_type())
  32 #define GST_BASESRC(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_BASESRC,GstBaseSrc))
  33 #define GST_BASESRC_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_BASESRC,GstBaseSrcClass))
  34 #define GST_BASESRC_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_BASESRC, GstBaseSrcClass))
  35 #define GST_IS_BASESRC(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BASESRC))
  36 #define GST_IS_BASESRC_CLASS(obj)       (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BASESRC))
  37
  38 typedef enum {
  39   GST_BASESRC_STARTED           = GST_ELEMENT_FLAG_LAST,
  40
  41   GST_BASESRC_FLAG_LAST         = GST_ELEMENT_FLAG_LAST + 2
  42 } GstFileSrcFlags;
  43
  44
  45 typedef struct _GstBaseSrc GstBaseSrc;
  46 typedef struct _GstBaseSrcClass GstBaseSrcClass;
  47
  48 struct _GstBaseSrc {
  49   GstElement     element;
  50
  51   GstPad        *srcpad;
  52
  53   gint           blocksize;
  54
  55   gint64         segment_start;
  56   gint64         segment_end;
  57   gboolean       segment_loop;
  58
  59   gboolean       has_loop;
  60   gboolean       has_getrange;
  61
  62   gboolean       seekable;
  63   guint64        offset;
  64   guint64        size;
  65 };
  66
  67 struct _GstBaseSrcClass {
  68   GstElementClass parent_class;
  69
  70   GstCaps*      (*get_caps)     (GstBaseSrc *src);
  71   gboolean      (*set_caps)     (GstBaseSrc *src, GstCaps *caps);
  72
  73   gboolean      (*start)        (GstBaseSrc *src);
  74   gboolean      (*stop)         (GstBaseSrc *src);
  75
  76   void          (*get_times)    (GstBaseSrc *src, GstBuffer *buffer,
  77                                  GstClockTime *start, GstClockTime *end);
  78
  79   gboolean      (*get_size)     (GstBaseSrc *src, guint64 *size);
  80
  81   gboolean      (*is_seekable)  (GstBaseSrc *src);
  82   gboolean      (*unlock)       (GstBaseSrc *src);
  83
  84   gboolean      (*event)        (GstBaseSrc *src, GstEvent *event);
  85   GstFlowReturn (*create)       (GstBaseSrc *src, guint64 offset, guint size,
  86                                  GstBuffer **buf);
  87 };
  88
  89 GType gst_basesrc_get_type(void);
  90
  91 G_END_DECLS
  92
  93 #endif /* __GST_BASESRC_H__ */