gstreamer/plugins/elements/gstfilesink.h
Sebastian Dröge dcb2be3282 filesink: Add a new full buffer mode to filesink
Previously the default and full modes were the same. Now the default
mode is like before: it accumulates all buffers in a buffer list until
the threshold is reached and then writes them all out, potentially in
multiple writes.

The new full mode works by always copying memory to a single memory area
and writing everything out with a single write once the threshold is
reached.
2020-03-26 11:31:03 +00:00

109 lines
2.8 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;
/* For default buffer mode */
GstBufferList *buffer_list;
/* For full buffer mode */
guint8 *buffer;
gsize allocated_buffer_size;
/* For default/full buffer mode */
gsize 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__ */