gstreamer/plugins/elements/gstfilesink.h
Sebastian Dröge eec9bd8db3 filesink: Implement workaround for some (network) filesystems that spuriously return EACCES on write
This seems to happen when another client is accessing the file at the
same time, and retrying after a short amount of time solves it.

Sometimes partial data is written at that point already but we have no
idea how much it is, or if what was written is correct (it sometimes
isn't) so we always first seek back to the current position and repeat
the whole failed write.

It happens at least on Linux and macOS on SMB/CIFS and NFS file systems.

Between write attempts that failed with EACCES we wait 10ms, and after
enough consecutive tries that failed with EACCES we simply time out.

In theory a valid EACCES for files to which we simply have no access
should've happened already during the call to open(), except for NFS
(see open(2)).

This can be enabled with the new max-transient-error-timeout property, and
a new o-sync boolean property was added to open the file in O_SYNC mode
as without that it's not guaranteed that we get EACCES for the actual
writev() call that failed but might only get it at a later time.

Fixes https://gitlab.freedesktop.org/gstreamer/gstreamer/issues/305
2019-05-16 14:15:02 +03:00

102 lines
2.7 KiB
C

/* GStreamer
* Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
* 2000 Wim Taymans <wtay@chello.be>
*
* gstfilesink.h:
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef __GST_FILE_SINK_H__
#define __GST_FILE_SINK_H__
#include <stdio.h>
#include <gst/gst.h>
#include <gst/base/gstbasesink.h>
G_BEGIN_DECLS
#define GST_TYPE_FILE_SINK \
(gst_file_sink_get_type())
#define GST_FILE_SINK(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_FILE_SINK,GstFileSink))
#define GST_FILE_SINK_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_FILE_SINK,GstFileSinkClass))
#define GST_IS_FILE_SINK(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_FILE_SINK))
#define GST_IS_FILE_SINK_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_FILE_SINK))
#define GST_FILE_SINK_CAST(obj) ((GstFileSink *)(obj))
typedef struct _GstFileSink GstFileSink;
typedef struct _GstFileSinkClass GstFileSinkClass;
/**
* GstFileSinkBufferMode:
* @GST_FILE_SINK_BUFFER_MODE_DEFAULT: Default buffering
* @GST_FILE_SINK_BUFFER_MODE_FULL: Fully buffered
* @GST_FILE_SINK_BUFFER_MODE_LINE: Line buffered
* @GST_FILE_SINK_BUFFER_MODE_UNBUFFERED: Unbuffered
*
* File read buffering mode.
*/
typedef enum {
GST_FILE_SINK_BUFFER_MODE_DEFAULT = -1,
GST_FILE_SINK_BUFFER_MODE_FULL = _IOFBF,
GST_FILE_SINK_BUFFER_MODE_LINE = _IOLBF,
GST_FILE_SINK_BUFFER_MODE_UNBUFFERED = _IONBF
} GstFileSinkBufferMode;
/**
* GstFileSink:
*
* Opaque #GstFileSink structure.
*/
struct _GstFileSink {
GstBaseSink parent;
/*< private >*/
gchar *filename;
gchar *uri;
FILE *file;
gboolean seekable;
guint64 current_pos;
gint buffer_mode;
guint buffer_size;
GstBufferList *buffer;
guint current_buffer_size;
gboolean append;
gboolean o_sync;
gint max_transient_error_timeout;
gboolean flushing;
};
struct _GstFileSinkClass {
GstBaseSinkClass parent_class;
};
G_GNUC_INTERNAL GType gst_file_sink_get_type (void);
G_END_DECLS
#endif /* __GST_FILE_SINK_H__ */