plugins/elements/gstsparsefile.h

   1 /* GStreamer
   2  * Copyright (C) 2014 Wim Taymans <wtaymans@redhat.com>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  17  * Boston, MA 02110-1301, USA.
  18  */
  19
  20 #include <glib.h>
  21
  22 #ifndef __GST_SPARSE_FILE_H__
  23 #define __GST_SPARSE_FILE_H__
  24
  25 G_BEGIN_DECLS
  26
  27 typedef struct _GstSparseFile GstSparseFile;
  28
  29 /* NOTE: Remove this before making this public API again! */
  30 typedef enum {
  31   GST_SPARSE_FILE_IO_ERROR_FAILED,
  32   GST_SPARSE_FILE_IO_ERROR_NOT_FOUND,
  33   GST_SPARSE_FILE_IO_ERROR_EXISTS,
  34   GST_SPARSE_FILE_IO_ERROR_IS_DIRECTORY,
  35   GST_SPARSE_FILE_IO_ERROR_NOT_DIRECTORY,
  36   GST_SPARSE_FILE_IO_ERROR_NOT_EMPTY,
  37   GST_SPARSE_FILE_IO_ERROR_NOT_REGULAR_FILE,
  38   GST_SPARSE_FILE_IO_ERROR_NOT_SYMBOLIC_LINK,
  39   GST_SPARSE_FILE_IO_ERROR_NOT_MOUNTABLE_FILE,
  40   GST_SPARSE_FILE_IO_ERROR_FILENAME_TOO_LONG,
  41   GST_SPARSE_FILE_IO_ERROR_INVALID_FILENAME,
  42   GST_SPARSE_FILE_IO_ERROR_TOO_MANY_LINKS,
  43   GST_SPARSE_FILE_IO_ERROR_NO_SPACE,
  44   GST_SPARSE_FILE_IO_ERROR_INVALID_ARGUMENT,
  45   GST_SPARSE_FILE_IO_ERROR_PERMISSION_DENIED,
  46   GST_SPARSE_FILE_IO_ERROR_NOT_SUPPORTED,
  47   GST_SPARSE_FILE_IO_ERROR_NOT_MOUNTED,
  48   GST_SPARSE_FILE_IO_ERROR_ALREADY_MOUNTED,
  49   GST_SPARSE_FILE_IO_ERROR_CLOSED,
  50   GST_SPARSE_FILE_IO_ERROR_CANCELLED,
  51   GST_SPARSE_FILE_IO_ERROR_PENDING,
  52   GST_SPARSE_FILE_IO_ERROR_READ_ONLY,
  53   GST_SPARSE_FILE_IO_ERROR_CANT_CREATE_BACKUP,
  54   GST_SPARSE_FILE_IO_ERROR_WRONG_ETAG,
  55   GST_SPARSE_FILE_IO_ERROR_TIMED_OUT,
  56   GST_SPARSE_FILE_IO_ERROR_WOULD_RECURSE,
  57   GST_SPARSE_FILE_IO_ERROR_BUSY,
  58   GST_SPARSE_FILE_IO_ERROR_WOULD_BLOCK,
  59   GST_SPARSE_FILE_IO_ERROR_HOST_NOT_FOUND,
  60   GST_SPARSE_FILE_IO_ERROR_WOULD_MERGE,
  61   GST_SPARSE_FILE_IO_ERROR_FAILED_HANDLED,
  62   GST_SPARSE_FILE_IO_ERROR_TOO_MANY_OPEN_FILES,
  63   GST_SPARSE_FILE_IO_ERROR_NOT_INITIALIZED,
  64   GST_SPARSE_FILE_IO_ERROR_ADDRESS_IN_USE,
  65   GST_SPARSE_FILE_IO_ERROR_PARTIAL_INPUT,
  66   GST_SPARSE_FILE_IO_ERROR_INVALID_DATA,
  67   GST_SPARSE_FILE_IO_ERROR_DBUS_ERROR,
  68   GST_SPARSE_FILE_IO_ERROR_HOST_UNREACHABLE,
  69   GST_SPARSE_FILE_IO_ERROR_NETWORK_UNREACHABLE,
  70   GST_SPARSE_FILE_IO_ERROR_CONNECTION_REFUSED,
  71   GST_SPARSE_FILE_IO_ERROR_PROXY_FAILED,
  72   GST_SPARSE_FILE_IO_ERROR_PROXY_AUTH_FAILED,
  73   GST_SPARSE_FILE_IO_ERROR_PROXY_NEED_AUTH,
  74   GST_SPARSE_FILE_IO_ERROR_PROXY_NOT_ALLOWED,
  75   GST_SPARSE_FILE_IO_ERROR_BROKEN_PIPE
  76 } GstSparseFileIOErrorEnum;
  77
  78 GstSparseFile * gst_sparse_file_new          (void);
  79 void            gst_sparse_file_free         (GstSparseFile *file);
  80
  81 gboolean        gst_sparse_file_set_fd       (GstSparseFile *file, gint fd);
  82 void            gst_sparse_file_clear        (GstSparseFile *file);
  83
  84 gsize           gst_sparse_file_write        (GstSparseFile *file,
  85                                               gsize offset,
  86                                               gconstpointer data,
  87                                               gsize count,
  88                                               gsize *available,
  89                                               GError **error);
  90
  91 gsize           gst_sparse_file_read         (GstSparseFile *file,
  92                                               gsize offset,
  93                                               gpointer data,
  94                                               gsize count,
  95                                               gsize *remaining,
  96                                               GError **error);
  97
  98 guint           gst_sparse_file_n_ranges         (GstSparseFile *file);
  99
 100 gboolean        gst_sparse_file_get_range_before (GstSparseFile *file, gsize offset,
 101                                                   gsize *start, gsize *stop);
 102
 103 gboolean        gst_sparse_file_get_range_after  (GstSparseFile *file, gsize offset,
 104                                                   gsize *start, gsize *stop);
 105
 106 G_END_DECLS
 107
 108 #endif /* __GST_SPARSE_FILE_H__ */