docs/: add new API entries to the docs

Original commit message from CVS:
* docs/gst/gstreamer-docs.sgml:
* docs/gst/gstreamer-sections.txt:
* docs/libs/gstreamer-libs-sections.txt:
add new API entries to the docs
* libs/gst/controller/Makefile.am:
* libs/gst/controller/gstcontroller.c:
* libs/gst/controller/gstcontroller.h:
* libs/gst/controller/gstcontrollerprivate.h:
* libs/gst/controller/gsthelper.c:
* libs/gst/controller/gstinterpolation.c:
move private structs to private header
* po/README:
gstreamer-0.7 -> gstreamer-0.10
* tests/check/libs/struct_i386.h:
remove private structs

ChangeLog

@@ -1,3 +1,22 @@
+2006-01-13  Stefan Kost  <ensonic@users.sf.net>
+
+
+	* docs/gst/gstreamer-docs.sgml:
+	* docs/gst/gstreamer-sections.txt:
+	* docs/libs/gstreamer-libs-sections.txt:
+          add new API entries to the docs
+	* libs/gst/controller/Makefile.am:
+	* libs/gst/controller/gstcontroller.c:
+	* libs/gst/controller/gstcontroller.h:
+	* libs/gst/controller/gstcontrollerprivate.h:
+	* libs/gst/controller/gsthelper.c:
+	* libs/gst/controller/gstinterpolation.c:
+          move private structs to private header
+	* po/README:
+          gstreamer-0.7 -> gstreamer-0.10
+	* tests/check/libs/struct_i386.h:
+          remove private structs
+
 2006-01-13  Thomas Vander Stichele  <thomas at apestaart dot org>
 
 	* plugins/indexers/Makefile.am:

docs/gst/gstreamer-docs.sgml

@@ -190,7 +190,7 @@ Windows.  It is released under the GNU Library General Public License
   </index>
   <!-- disable, as
      - index generation is extremly slow in gtk-doc
-     - we have not tagged lots of symbols thsi way anyway
+     - we have not tagged lots of symbols this way anyway
   <index role="0.8">
     <title>Index of new symbols in 0.8</title>
   </index>

docs/gst/gstreamer-sections.txt

@@ -1357,11 +1357,15 @@ GST_IS_PAD_TEMPLATE_CLASS
 GST_STATIC_PAD_TEMPLATE
 GST_TYPE_PAD_TEMPLATE
 GST_TYPE_PAD_TEMPLATE_FLAGS
+GST_TYPE_STATIC_CAPS
+GST_TYPE_STATIC_PAD_TEMPLATE
 
 <SUBSECTION Private>
 gst_pad_template_get_type
 gst_pad_template_flags_get_type
 gst_pad_template_pad_created
+gst_static_pad_template_get_type
+gst_static_caps_get_type
 
 </SECTION>
 

docs/libs/gstreamer-libs-sections.txt

@@ -94,6 +94,8 @@ gst_object_get_value_array
 <SUBSECTION Standard>
 <SUBSECTION Private>
 </SECTION>
+
+
 # base classes
 
 <SECTION>
@@ -271,6 +273,7 @@ GST_IS_NET_CLIENT_CLOCK_CLASS
 gst_net_client_clock_get_type
 </SECTION>
 
+
 <SECTION>
 <FILE>gstnettimepacket</FILE>
 <TITLE>GstNetTimePacket</TITLE>
@@ -285,6 +288,7 @@ gst_net_time_packet_serialize
 <SUBSECTION Private>
 </SECTION>
 
+
 <SECTION>
 <FILE>gstnettimeprovider</FILE>
 <TITLE>GstNetTimeProvider</TITLE>
@@ -347,3 +351,7 @@ gst_check_teardown_element
 gst_check_teardown_sink_pad
 gst_check_teardown_src_pad
 </SECTION>
+
+# misc
+
+# TODO : add gsttypefindhelper

libs/gst/controller/Makefile.am

@@ -3,6 +3,7 @@ lib_LTLIBRARIES = libgstcontroller-@GST_MAJORMINOR@.la
 libgstcontroller_@GST_MAJORMINOR@_includedir = $(includedir)/gstreamer-@GST_MAJORMINOR@/gst/controller
 libgstcontroller_@GST_MAJORMINOR@_include_HEADERS = \
 	gstcontroller.h
+noinst_HEADERS = gstcontrollerprivate.h
 
 libgstcontroller_@GST_MAJORMINOR@_la_SOURCES = \
 	lib.c \

libs/gst/controller/gstcontroller.c

@@ -69,6 +69,7 @@
 #ifdef HAVE_CONFIG_H
 #  include "config.h"
 #endif
+#include "gstcontrollerprivate.h"
 #include "gstcontroller.h"
 
 #define GST_CAT_DEFAULT gst_controller_debug

libs/gst/controller/gstcontroller.h

@@ -100,74 +100,6 @@ typedef enum
   GST_INTERPOLATE_USER
 } GstInterpolateMode;
 
-
-struct _GstControlledProperty;
-
-typedef GValue *(*InterpolateGet) (struct _GstControlledProperty * prop,
-        GstClockTime timestamp);
-typedef gboolean (*InterpolateGetValueArray) (struct _GstControlledProperty * prop,
-        GstClockTime timestamp, GstValueArray * value_array);
-
-/**
- * GstInterpolateMethod:
- *
- * Function pointer structure to do user-defined interpolation methods
- */
-typedef struct _GstInterpolateMethod
-{
-  InterpolateGet get_int;
-  InterpolateGetValueArray get_int_value_array;
-  InterpolateGet get_uint;
-  InterpolateGetValueArray get_uint_value_array;
-  InterpolateGet get_long;
-  InterpolateGetValueArray get_long_value_array;
-  InterpolateGet get_ulong;
-  InterpolateGetValueArray get_ulong_value_array;
-  InterpolateGet get_float;
-  InterpolateGetValueArray get_float_value_array;
-  InterpolateGet get_double;
-  InterpolateGetValueArray get_double_value_array;
-  InterpolateGet get_boolean;
-  InterpolateGetValueArray get_boolean_value_array;
-  InterpolateGet get_enum;
-  InterpolateGetValueArray get_enum_value_array;
-  InterpolateGet get_string;
-  InterpolateGetValueArray get_string_value_array;
-} GstInterpolateMethod;
-
-/**
- * GstControlledProperty:
- */
-typedef struct _GstControlledProperty
-{
-  gchar *name;                  /* name of the property */
-  GType type;                   /* type of the handled property */
-  GType base;                   /* base-type of the handled property */
-  GValue default_value;         /* default value for the handled property */
-  GValue result_value;          /* result value location for the interpolation method */
-  GstTimedValue last_value;     /* the last value a _sink call wrote */
-  GstTimedValue live_value;     /* temporary value override for live input */
-  gulong notify_handler_id;     /* id of the notify::<name> signal handler */
-  GstInterpolateMode interpolation;     /* Interpolation mode */
-  /* TODO instead of *method, have pointers to get() and get_value_array() here
-     gst_controller_set_interpolation_mode() will pick the right ones for the
-     properties value type
-     GstInterpolateMethod *method; // User-implemented handler (if interpolation == GST_INTERPOLATE_USER)
-  */
-  InterpolateGet get;
-  InterpolateGetValueArray get_value_array;
-
-  GList *values;                /* List of GstTimedValue */
-  /* TODO keep the last search result to be able to continue
-     GList      *last_value;     // last search result, can be used for incremental searches
-   */
-
-  /*< private >*/
-  gpointer       _gst_reserved[GST_PADDING];
-} GstControlledProperty;
-
-#define GST_CONTROLLED_PROPERTY(obj)    ((GstControlledProperty *)(obj))
-
 /* type macros */
 
 #define GST_TYPE_CONTROLLER	       (gst_controller_get_type ())

libs/gst/controller/gstcontrollerprivate.h

@@ -0,0 +1,103 @@
+/* GStreamer
+ *
+ * Copyright (C) <2005> Stefan Kost <ensonic at users dot sf dot net>
+ *
+ * gstcontrollerprivate.h: dynamic parameter control subsystem
+ *
+ * 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.
+ */
+
+#ifndef __GST_CONTROLLER_PRIVATE_H__
+#define __GST_CONTROLLER_PRIVATE_H__
+
+#include <glib.h>
+#include <glib-object.h>
+#include <gst/gst.h>
+
+#include "gstcontroller.h"
+
+G_BEGIN_DECLS
+
+struct _GstControlledProperty;
+
+typedef GValue *(*InterpolateGet) (struct _GstControlledProperty * prop,
+        GstClockTime timestamp);
+typedef gboolean (*InterpolateGetValueArray) (struct _GstControlledProperty * prop,
+        GstClockTime timestamp, GstValueArray * value_array);
+
+/**
+ * GstInterpolateMethod:
+ *
+ * Function pointer structure to do user-defined interpolation methods
+ */
+typedef struct _GstInterpolateMethod
+{
+  InterpolateGet get_int;
+  InterpolateGetValueArray get_int_value_array;
+  InterpolateGet get_uint;
+  InterpolateGetValueArray get_uint_value_array;
+  InterpolateGet get_long;
+  InterpolateGetValueArray get_long_value_array;
+  InterpolateGet get_ulong;
+  InterpolateGetValueArray get_ulong_value_array;
+  InterpolateGet get_float;
+  InterpolateGetValueArray get_float_value_array;
+  InterpolateGet get_double;
+  InterpolateGetValueArray get_double_value_array;
+  InterpolateGet get_boolean;
+  InterpolateGetValueArray get_boolean_value_array;
+  InterpolateGet get_enum;
+  InterpolateGetValueArray get_enum_value_array;
+  InterpolateGet get_string;
+  InterpolateGetValueArray get_string_value_array;
+} GstInterpolateMethod;
+
+/**
+ * GstControlledProperty:
+ */
+typedef struct _GstControlledProperty
+{
+  gchar *name;                  /* name of the property */
+  GType type;                   /* type of the handled property */
+  GType base;                   /* base-type of the handled property */
+  GValue default_value;         /* default value for the handled property */
+  GValue result_value;          /* result value location for the interpolation method */
+  GstTimedValue last_value;     /* the last value a _sink call wrote */
+  GstTimedValue live_value;     /* temporary value override for live input */
+  gulong notify_handler_id;     /* id of the notify::<name> signal handler */
+  GstInterpolateMode interpolation;     /* Interpolation mode */
+  /* TODO instead of *method, have pointers to get() and get_value_array() here
+     gst_controller_set_interpolation_mode() will pick the right ones for the
+     properties value type
+     GstInterpolateMethod *method; // User-implemented handler (if interpolation == GST_INTERPOLATE_USER)
+  */
+  InterpolateGet get;
+  InterpolateGetValueArray get_value_array;
+
+  GList *values;                /* List of GstTimedValue */
+  /* TODO keep the last search result to be able to continue
+     GList      *last_value;     // last search result, can be used for incremental searches
+   */
+
+  /*< private >*/
+  gpointer       _gst_reserved[GST_PADDING];
+} GstControlledProperty;
+
+#define GST_CONTROLLED_PROPERTY(obj)    ((GstControlledProperty *)(obj))
+
+G_END_DECLS
+
+#endif /* __GST_CONTROLLER_PRIVATE_H__ */

libs/gst/controller/gsthelper.c

@@ -35,6 +35,7 @@
 
 #include <stdarg.h>
 
+#include "gstcontrollerprivate.h"
 #include "gstcontroller.h"
 
 #define GST_CAT_DEFAULT gst_controller_debug

libs/gst/controller/gstinterpolation.c

@@ -23,6 +23,7 @@
 #ifdef HAVE_CONFIG_H
 #  include "config.h"
 #endif
+#include "gstcontrollerprivate.h"
 #include "gstcontroller.h"
 
 #define GST_CAT_DEFAULT gst_controller_debug

po/README

@@ -8,11 +8,11 @@ A: - Make sure the source file includes either gst-i18n-lib.h (if it's a part
 Q: How do I add/mark strings to be translated ?
 A: - Use N_(...) to mark for translation.
    - Use _(...) to get a translated string
-   - run "make gstreamer-0.7.pot-update" to update the .pot file
+   - run "make gstreamer-0.10.pot-update" to update the .pot file
      and check if your new strings got added
 
 Q: How do I add a language ?
-A: - copy gstreamer-0.7.pot to your new language.po
+A: - copy gstreamer-0.10.pot to your new language.po
    - add the language code to LINGUAS
    - edit the header of this language.po file and make it match one of
      the existing .po files

tests/check/libs/struct_i386.h

@@ -15,8 +15,6 @@ Struct list[] = {
 
  {"GstTimedValue", sizeof(GstTimedValue), 28},
  {"GstValueArray", sizeof(GstValueArray), 20},
- {"GstInterpolateMethod", sizeof(GstInterpolateMethod), 64},
- {"GstControlledProperty", sizeof(GstControlledProperty), 144},
  {"GstController", sizeof(GstController), 40},
  {"GstControllerClass", sizeof(GstControllerClass), 84},