plugins/elements/gstfilesrc.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  * gstfilesrc.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_FILE_SRC_H__
  25 #define __GST_FILE_SRC_H__
  26
  27 #include <sys/types.h>
  28
  29 #include <gst/gst.h>
  30 #include <gst/base/gstbasesrc.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define GST_TYPE_FILE_SRC \
  35   (gst_file_src_get_type())
  36 #define GST_FILE_SRC(obj) \
  37   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_FILE_SRC,GstFileSrc))
  38 #define GST_FILE_SRC_CLASS(klass) \
  39   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_FILE_SRC,GstFileSrcClass))
  40 #define GST_IS_FILE_SRC(obj) \
  41   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_FILE_SRC))
  42 #define GST_IS_FILE_SRC_CLASS(klass) \
  43   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_FILE_SRC))
  44
  45 typedef struct _GstFileSrc GstFileSrc;
  46 typedef struct _GstFileSrcClass GstFileSrcClass;
  47
  48 /**
  49  * GstFileSrc:
  50  *
  51  * Opaque #GstFileSrc structure.
  52  */
  53 struct _GstFileSrc {
  54   GstBaseSrc element;
  55
  56   /*< private >*/
  57   guint pagesize;                       /* system page size */
  58
  59   gchar *filename;                      /* filename */
  60   gchar *uri;                           /* caching the URI */
  61   gint fd;                              /* open file descriptor */
  62   guint64 read_position;                /* position of fd */
  63
  64   gboolean touch;                       /* whether to touch every page */
  65   gboolean using_mmap;                  /* whether we opened it with mmap */
  66   gboolean sequential;                  /* Whether to madvise (MADV_SEQUENTIAL)
  67                                            for mmap pages */
  68   gboolean seekable;                    /* whether the file is seekable */
  69   gboolean is_regular;                  /* whether it's a (symlink to a)
  70                                            regular file */
  71   GstBuffer *mapbuf;
  72   size_t mapsize;
  73   gboolean use_mmap;
  74 };
  75
  76 struct _GstFileSrcClass {
  77   GstBaseSrcClass parent_class;
  78 };
  79
  80 GType gst_file_src_get_type (void);
  81
  82 G_END_DECLS
  83
  84 #endif /* __GST_FILE_SRC_H__ */