Commit a0c4c481 authored by Thomas Vander Stichele's avatar Thomas Vander Stichele
Browse files

CVS surgery + support to move base, check, and net out of gst and into libs/gst

Original commit message from CVS:
CVS surgery + support to move base, check, and net out of gst
and into libs/gst
parent 65ce5ed0
2005-11-29 Thomas Vander Stichele <thomas (at) apestaart (dot) org>
* check/Makefile.am:
* configure.ac:
* docs/gst/Makefile.am:
* gst/Makefile.am:
* gst/base/.cvsignore:
* gst/base/Makefile.am:
* gst/base/README:
* gst/base/gstadapter.c:
* gst/base/gstadapter.h:
* gst/base/gstbasesink.c:
* gst/base/gstbasesink.h:
* gst/base/gstbasesrc.c:
* gst/base/gstbasesrc.h:
* gst/base/gstbasetransform.c:
* gst/base/gstbasetransform.h:
* gst/base/gstcollectpads.c:
* gst/base/gstcollectpads.h:
* gst/base/gstpushsrc.c:
* gst/base/gstpushsrc.h:
* gst/base/gsttypefindhelper.c:
* gst/base/gsttypefindhelper.h:
* gst/check/Makefile.am:
* gst/check/gstcheck.c:
* gst/check/gstcheck.h:
* gst/net/Makefile.am:
* gst/net/gstnet.h:
* gst/net/gstnetclientclock.c:
* gst/net/gstnetclientclock.h:
* gst/net/gstnettimepacket.c:
* gst/net/gstnettimepacket.h:
* gst/net/gstnettimeprovider.c:
* gst/net/gstnettimeprovider.h:
* libs/gst/Makefile.am:
* libs/gst/base/Makefile.am:
* libs/gst/base/gstbasetransform.c:
* libs/gst/check/Makefile.am:
* plugins/elements/Makefile.am:
* po/POTFILES.in:
CVS surgery + support to move base, check, and net out of gst
and into libs/gst
2005-11-29 Andy Wingo <wingo@pobox.com>
* gst/gstevent.h (struct _GstEvent): Only one pointer of padding.
......
......@@ -70,7 +70,7 @@ TESTS = $(check_PROGRAMS)
noinst_HEADERS = gst/capslist.h
AM_CFLAGS = $(GST_OBJ_CFLAGS) $(CHECK_CFLAGS)
LDADD = $(top_builddir)/gst/check/libgstcheck-@GST_MAJORMINOR@.la \
LDADD = $(top_builddir)/libs/gst/check/libgstcheck-@GST_MAJORMINOR@.la \
$(GST_OBJ_LIBS) \
$(CHECK_LIBS)
......@@ -86,10 +86,10 @@ gst_libs_controller_LDADD = \
$(LDADD)
net_gstnetclientclock_LDADD = \
$(top_builddir)/gst/net/libgstnet-@GST_MAJORMINOR@.la \
$(top_builddir)/libs/gst/net/libgstnet-@GST_MAJORMINOR@.la \
$(LDADD)
net_gstnettimeprovider_LDADD = \
$(top_builddir)/gst/net/libgstnet-@GST_MAJORMINOR@.la \
$(top_builddir)/libs/gst/net/libgstnet-@GST_MAJORMINOR@.la \
$(LDADD)
# valgrind testing
......
......@@ -473,14 +473,14 @@ Makefile
gst/Makefile
gst/gstconfig.h
gst/gstversion.h
gst/base/Makefile
gst/check/Makefile
gst/net/Makefile
gst/parse/Makefile
libs/Makefile
libs/gst/Makefile
libs/gst/base/Makefile
libs/gst/check/Makefile
libs/gst/controller/Makefile
libs/gst/dataprotocol/Makefile
libs/gst/net/Makefile
plugins/Makefile
plugins/indexers/Makefile
plugins/elements/Makefile
......
......@@ -33,12 +33,6 @@ include $(srcdir)/../upload.mak
# The top-level SGML file. Change it if you want.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
# The directory containing the source code. Relative to $(top_srcdir).
# gtk-doc will search all .c & .h files beneath here for inline comments
# documenting functions and macros.
DOC_SOURCE_DIR=$(top_srcdir)/gst
DOC_BUILD_DIR=$(top_builddir)/gst
# Extra options to supply to gtkdoc-scan.
SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED"
......@@ -48,17 +42,22 @@ MKDB_OPTIONS=--sgml-mode --ignore-files=parse
# Extra options to supply to gtkdoc-fixref.
FIXXREF_OPTIONS=
# Used for dependencies.
HFILE_GLOB=$(DOC_SOURCE_DIR)/*.h
CFILE_GLOB=$(DOC_SOURCE_DIR)/*.c
# The files containing the source code. Relative to $(top_srcdir).
# gtk-doc will search all .c & .h files beneath here for inline comments
# documenting functions and macros.
DOC_SOURCE_DIR = $(top_srcdir)/gst
DOC_BUILD_DIR = $(top_builddir)/gst
HFILE_GLOB=$(top_srcdir)/gst/*.h $(top_srcdir)/libs/gst/*/*.h
CFILE_GLOB=$(top_srcdir)/gst/*.c $(top_srcdir)/libs/gst/*/*.c
# Dependencies for the intermediate scanobj tool
#SCANOBJ_DEPS = $(top_builddir)/gst/elements/libgstelements.la \
# $(top_builddir)/gst/schedulers/libgstbasicomegascheduler.la
SCANOBJ_DEPS = \
$(top_builddir)/plugins/elements/libgstelements.la \
$(top_builddir)/gst/base/libgstbase-@GST_MAJORMINOR@.la \
$(top_builddir)/gst/net/libgstnet-@GST_MAJORMINOR@.la
$(top_builddir)/libs/gst/base/libgstbase-@GST_MAJORMINOR@.la \
$(top_builddir)/libs/gst/net/libgstnet-@GST_MAJORMINOR@.la
# Header files to ignore when scanning. Use base file name, no paths
IGNORE_HFILES= \
......
lib_LTLIBRARIES = libgstreamer-@GST_MAJORMINOR@.la
if HAVE_CHECK
SUBDIRS_CHECK = check
else
SUBDIRS_CHECK =
endif
if GST_DISABLE_LOADSAVE
GST_LOADSAVE_SRC =
else
......@@ -52,24 +46,9 @@ else
GST_URI_SRC = gsturi.c
endif
if GST_DISABLE_NET
SUBDIRS_NET =
else
if HAVE_SYS_SOCKET_H
SUBDIRS_NET = net
else
SUBDIRS_NET =
endif
endif
SUBDIRS = \
$(SUBDIRS_PARSE) \
. \
base \
$(SUBDIRS_NET) \
$(SUBDIRS_CHECK)
SUBDIRS = $(SUBDIRS_PARSE)
DIST_SUBDIRS = base parse net check
DIST_SUBDIRS = parse
# make variables for all generated source and header files to make the
# distinction clear
......
lib_LTLIBRARIES = libgstbase-@GST_MAJORMINOR@.la
libgstbase_@GST_MAJORMINOR@_la_DEPENDENCIES = \
../libgstreamer-@GST_MAJORMINOR@.la
libgstbase_@GST_MAJORMINOR@_la_SOURCES = \
gstadapter.c \
gstbasesink.c \
gstbasesrc.c \
gstbasetransform.c \
gstcollectpads.c \
gstpushsrc.c \
gsttypefindhelper.c
libgstbase_@GST_MAJORMINOR@_la_CFLAGS = $(GST_OBJ_CFLAGS)
libgstbase_@GST_MAJORMINOR@_la_LIBADD = $(GST_OBJ_LIBS)
libgstbase_@GST_MAJORMINOR@_la_LDFLAGS = $(GST_LIB_LDFLAGS) $(GST_ALL_LDFLAGS) $(GST_LT_LDFLAGS)
libgstbase_@GST_MAJORMINOR@includedir = \
$(includedir)/gstreamer-@GST_MAJORMINOR@/gst/base
libgstbase_@GST_MAJORMINOR@include_HEADERS = \
gstadapter.h \
gstbasesink.h \
gstbasesrc.h \
gstbasetransform.h \
gstcollectpads.h \
gstpushsrc.h \
gsttypefindhelper.h
Base classes
------------
GstBaseSink
FIXME: not much point making it operate in pull mode as a generic
base class I guess...
/* GStreamer
* Copyright (C) 2004 Benjamin Otte <otte@gnome.org>
*
* 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., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:gstadapter
* @short_description: adapts incoming data on a sink pad into chunks of N bytes
*
* This class is for elements that receive buffers in an undesired size.
* While for example raw video contains one image per buffer, the same is not
* true for a lot of other formats, especially those that come directly from
* a file. So if you have undefined buffer sizes and require a specific size,
* this object is for you.
*
* The theory of operation is like this: All buffers received are put
* into the adapter using gst_adapter_push() and the data is then read back
* in chunks of the desired size using gst_adapter_peek(). After the data is
* processed, it is freed using gst_adapter_flush().
*
* For example, a sink pad's chain function that needs to pass data to a library
* in 512-byte chunks could be implemented like this:
* <programlisting>
* static GstFlowReturn
* sink_pad_chain (GstPad *pad, GstBuffer *buffer)
* {
* MyElement *this;
* GstAdapter *adapter;
* GstFlowReturn ret = GST_FLOW_OK;
*
* // will give the element an extra ref; remember to drop it
* this = MY_ELEMENT (gst_pad_get_parent (pad));
* adapter = this->adapter;
*
* // put buffer into adapter
* #gst_adapter_push (adapter, buffer);
* // while we can read out 512 bytes, process them
* while (#gst_adapter_available (adapter) >= 512 && ret == GST_FLOW_OK) {
* // use flowreturn as an error value
* ret = my_library_foo (#gst_adapter_peek (adapter, 512));
* #gst_adapter_flush (adapter, 512);
* }
*
* gst_object_unref (this);
* return ret;
* }
* </programlisting>
* For another example, a simple element inside GStreamer that uses GstAdapter
* is the libvisual element.
*
* An element using GstAdapter in its sink pad chain function should ensure that
* when the FLUSH_STOP event is received, that any queued data is cleared using
* gst_adapter_clear(). Data should also be cleared or processed on EOS and
* when changing state from #GST_STATE_PAUSED to #GST_STATE_READY.
*
* A last thing to note is that while GstAdapter is pretty optimized,
* merging buffers still might be an operation that requires a memcpy()
* operation, and this operation is not the fastest. Because of this, some
* functions like gst_adapter_available_fast() are provided to help speed up
* such cases should you want to.
*
* GstAdapter is not MT safe. All operations on an adapter must be serialized by
* the caller. This is not normally a problem, however, as the normal use case
* of GstAdapter is inside one pad's chain function, in which case access is
* serialized via the pad's stream lock.
*
* Last reviewed on 2005-11-08 (0.9.5).
*/
#include <string.h>
#include "gstadapter.h"
/* default size for the assembled data buffer */
#define DEFAULT_SIZE 16
GST_DEBUG_CATEGORY_STATIC (gst_adapter_debug);
#define GST_CAT_DEFAULT gst_adapter_debug
#define _do_init(thing) \
GST_DEBUG_CATEGORY_INIT (gst_adapter_debug, "adapter", 0, "object to splice and merge buffers to desired size")
GST_BOILERPLATE_FULL (GstAdapter, gst_adapter, GObject, G_TYPE_OBJECT,
_do_init);
static void gst_adapter_dispose (GObject * object);
static void gst_adapter_finalize (GObject * object);
static void
gst_adapter_base_init (gpointer g_class)
{
/* nop */
}
static void
gst_adapter_class_init (GstAdapterClass * klass)
{
GObjectClass *object = G_OBJECT_CLASS (klass);
object->dispose = gst_adapter_dispose;
object->finalize = gst_adapter_finalize;
}
static void
gst_adapter_init (GstAdapter * adapter, GstAdapterClass * g_class)
{
adapter->assembled_data = g_malloc (DEFAULT_SIZE);
adapter->assembled_size = DEFAULT_SIZE;
}
static void
gst_adapter_dispose (GObject * object)
{
GstAdapter *adapter = GST_ADAPTER (object);
gst_adapter_clear (adapter);
GST_CALL_PARENT (G_OBJECT_CLASS, dispose, (object));
}
static void
gst_adapter_finalize (GObject * object)
{
GstAdapter *adapter = GST_ADAPTER (object);
g_free (adapter->assembled_data);
GST_CALL_PARENT (G_OBJECT_CLASS, finalize, (object));
}
/**
* gst_adapter_new:
*
* Creates a new #GstAdapter.
*
* Returns: a new #GstAdapter
*/
GstAdapter *
gst_adapter_new (void)
{
return g_object_new (GST_TYPE_ADAPTER, NULL);
}
/**
* gst_adapter_clear:
* @adapter: a #GstAdapter
*
* Removes all buffers from @adapter.
*/
void
gst_adapter_clear (GstAdapter * adapter)
{
g_return_if_fail (GST_IS_ADAPTER (adapter));
g_slist_foreach (adapter->buflist, (GFunc) gst_mini_object_unref, NULL);
g_slist_free (adapter->buflist);
adapter->buflist = NULL;
adapter->size = 0;
adapter->skip = 0;
adapter->assembled_len = 0;
}
/**
* gst_adapter_push:
* @adapter: a #GstAdapter
* @buf: a #GstBuffer to add to queue in the adapter
*
* Adds the data from @buf to the data stored inside @adapter and takes
* ownership of the buffer.
*/
void
gst_adapter_push (GstAdapter * adapter, GstBuffer * buf)
{
g_return_if_fail (GST_IS_ADAPTER (adapter));
g_return_if_fail (GST_IS_BUFFER (buf));
adapter->size += GST_BUFFER_SIZE (buf);
adapter->buflist = g_slist_append (adapter->buflist, buf);
}
/**
* gst_adapter_peek:
* @adapter: a #GstAdapter
* @size: the number of bytes to peek
*
* Gets the first @size bytes stored in the @adapter. The returned pointer is
* valid until the next function is called on the adapter.
*
* Note that setting the returned pointer as the data of a #GstBuffer is
* incorrect for general-purpose plugins. The reason is that if a downstream
* element stores the buffer so that it has access to it outside of the bounds
* of its chain function, the buffer will have an invalid data pointer after
* your element flushes the bytes. In that case you should use
* gst_adapter_take(), which returns a freshly-allocated buffer that you can set
* as #GstBuffer malloc_data.
*
* Returns #NULL if @size bytes are not available.
*
* Returns: a pointer to the first @size bytes of data, or NULL.
*/
const guint8 *
gst_adapter_peek (GstAdapter * adapter, guint size)
{
GstBuffer *cur;
GSList *cur_list;
guint copied;
g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
g_return_val_if_fail (size > 0, NULL);
/* we don't have enough data, return NULL */
if (size > adapter->size)
return NULL;
/* we have enough assembled data, return it */
if (adapter->assembled_len >= size)
return adapter->assembled_data;
/* our head buffer has enough data left, return it */
cur = adapter->buflist->data;
if (GST_BUFFER_SIZE (cur) >= size + adapter->skip)
return GST_BUFFER_DATA (cur) + adapter->skip;
if (adapter->assembled_size < size) {
adapter->assembled_size = (size / DEFAULT_SIZE + 1) * DEFAULT_SIZE;
GST_DEBUG_OBJECT (adapter, "setting size of internal buffer to %u",
adapter->assembled_size);
adapter->assembled_data =
g_realloc (adapter->assembled_data, adapter->assembled_size);
}
adapter->assembled_len = size;
copied = GST_BUFFER_SIZE (cur) - adapter->skip;
memcpy (adapter->assembled_data, GST_BUFFER_DATA (cur) + adapter->skip,
copied);
cur_list = g_slist_next (adapter->buflist);
while (copied < size) {
g_assert (cur_list);
cur = cur_list->data;
cur_list = g_slist_next (cur_list);
memcpy (adapter->assembled_data + copied, GST_BUFFER_DATA (cur),
MIN (GST_BUFFER_SIZE (cur), size - copied));
copied = MIN (size, copied + GST_BUFFER_SIZE (cur));
}
return adapter->assembled_data;
}
/**
* gst_adapter_flush:
* @adapter: a #GstAdapter
* @flush: the number of bytes to flush
*
* Flushes the first @flush bytes in the @adapter. The caller must ensure that
* at least this many bytes are available.
*
* See also: gst_adapter_peek().
*/
void
gst_adapter_flush (GstAdapter * adapter, guint flush)
{
GstBuffer *cur;
g_return_if_fail (GST_IS_ADAPTER (adapter));
g_return_if_fail (flush >= 0);
g_return_if_fail (flush <= adapter->size);
GST_LOG_OBJECT (adapter, "flushing %u bytes", flush);
adapter->size -= flush;
adapter->assembled_len = 0;
while (flush > 0) {
cur = adapter->buflist->data;
if (GST_BUFFER_SIZE (cur) <= flush + adapter->skip) {
/* can skip whole buffer */
flush -= GST_BUFFER_SIZE (cur) - adapter->skip;
adapter->skip = 0;
adapter->buflist = g_slist_remove (adapter->buflist, cur);
gst_buffer_unref (cur);
} else {
adapter->skip += flush;
break;
}
}
}
/**
* gst_adapter_take:
* @adapter: a #GstAdapter
* @nbytes: the number of bytes to take
*
* Returns a freshly allocated buffer containing the first @nbytes bytes of the
* @adapter.
*
* Caller owns returned value.
*
* Returns: oven-fresh hot data, or #NULL if @nbytes bytes are not available
*/
guint8 *
gst_adapter_take (GstAdapter * adapter, guint nbytes)
{
const guint8 *cdata;
guint8 *data;
g_return_val_if_fail (GST_IS_ADAPTER (adapter), NULL);
g_return_val_if_fail (nbytes > 0, NULL);
GST_LOG_OBJECT (adapter, "taking %u bytes", nbytes);
cdata = gst_adapter_peek (adapter, nbytes);
if (!cdata)
return NULL;
data = g_malloc (nbytes);
memcpy (data, cdata, nbytes);
gst_adapter_flush (adapter, nbytes);
return data;
}
/**
* gst_adapter_available:
* @adapter: a #GstAdapter
*
* Gets the maximum amount of bytes available, that is it returns the maximum
* value that can be supplied to gst_adapter_peek() without that function
* returning NULL.
*
* Returns: number of bytes available in @adapter
*/
guint
gst_adapter_available (GstAdapter * adapter)
{
g_return_val_if_fail (GST_IS_ADAPTER (adapter), 0);
return adapter->size;
}
/**
* gst_adapter_available_fast:
* @adapter: a #GstAdapter
*
* Gets the maximum number of bytes available without the need to do expensive
* operations (like copying the data into a temporary buffer).
*
* Returns: number of bytes available in @adapter without expensive operations
*/
guint
gst_adapter_available_fast (GstAdapter * adapter)
{
g_return_val_if_fail (GST_IS_ADAPTER (adapter), 0);
if (!adapter->buflist)
return 0;
if (adapter->assembled_len)
return adapter->assembled_len;
g_assert (GST_BUFFER_SIZE (adapter->buflist->data) > adapter->skip);
return GST_BUFFER_SIZE (adapter->buflist->data) - adapter->skip;
}
/* GStreamer
* Copyright (C) 2004 Benjamin Otte <otte@gnome.org>
*
* 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., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#include <gst/gst.h>
#ifndef __GST_ADAPTER_H__
#define __GST_ADAPTER_H__
G_BEGIN_DECLS
#define GST_TYPE_ADAPTER \
(gst_adapter_get_type())
#define GST_ADAPTER(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj), GST_TYPE_ADAPTER, GstAdapter))
#define GST_ADAPTER_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST((klass), GST_TYPE_ADAPTER, GstAdapterClass))
#define GST_ADAPTER_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_ADAPTER, GstAdapterClass))
#define GST_IS_ADAPTER(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE((obj), GST_TYPE_ADAPTER))
#define GST_IS_ADAPTER_CLASS(obj) \
(G_TYPE_CHECK_CLASS_TYPE((klass), GST_TYPE_ADAPTER))
typedef struct _GstAdapter GstAdapter;
typedef struct _GstAdapterClass GstAdapterClass;
/**
* GstAdapter: