GStreamer multimedia framework
Find a file
David Schleef 1e4ad29e52 docs/gst/gstreamer-docs.sgml: I got tired of the reference manual being such complete crap, that I decided to do majo...
Original commit message from CVS:
* docs/gst/gstreamer-docs.sgml:  I got tired of the reference
manual being such complete crap, that I decided to do major
hacking of it.  This checkin replaces any fine tuning that
may have been done previously, with the benefit of actually
being complete for much of the API that was changed since
0.6.  Further fine tuning will occur shortly.  (bug #134721)
* docs/gst/gstreamer-sections.txt:
* docs/gst/tmpl/GstBin.sgml:
* docs/gst/tmpl/GstBuffer.sgml:
* docs/gst/tmpl/GstCaps.sgml:
* docs/gst/tmpl/GstClock.sgml:
* docs/gst/tmpl/GstCompat.sgml:
* docs/gst/tmpl/GstData.sgml:
* docs/gst/tmpl/GstElement.sgml:
* docs/gst/tmpl/GstEvent.sgml:
* docs/gst/tmpl/GstIndex.sgml:
* docs/gst/tmpl/GstStructure.sgml:
* docs/gst/tmpl/GstTag.sgml:
* docs/gst/tmpl/cothreads.sgml:
* docs/gst/tmpl/cothreads_compat.sgml:
* docs/gst/tmpl/gettext.sgml:
* docs/gst/tmpl/grammar.tab.sgml:
* docs/gst/tmpl/gst-i18n-app.sgml:
* docs/gst/tmpl/gst-i18n-lib.sgml:
* docs/gst/tmpl/gst.sgml:
* docs/gst/tmpl/gst_private.sgml:
* docs/gst/tmpl/gstaggregator.sgml:
* docs/gst/tmpl/gstarch.sgml:
* docs/gst/tmpl/gstatomic.sgml:
* docs/gst/tmpl/gstatomic_impl.sgml:
* docs/gst/tmpl/gstbin.sgml:
* docs/gst/tmpl/gstbuffer.sgml:
* docs/gst/tmpl/gstbufferstore.sgml:
* docs/gst/tmpl/gstcaps.sgml:
* docs/gst/tmpl/gstclock.sgml:
* docs/gst/tmpl/gstcompat.sgml:
* docs/gst/tmpl/gstconfig.sgml:
* docs/gst/tmpl/gstcpu.sgml:
* docs/gst/tmpl/gstdata.sgml:
* docs/gst/tmpl/gstdata_private.sgml:
* docs/gst/tmpl/gstelement.sgml:
* docs/gst/tmpl/gstenumtypes.sgml:
* docs/gst/tmpl/gsterror.sgml:
* docs/gst/tmpl/gstevent.sgml:
* docs/gst/tmpl/gstfakesink.sgml:
* docs/gst/tmpl/gstfakesrc.sgml:
* docs/gst/tmpl/gstfilesink.sgml:
* docs/gst/tmpl/gstfilter.sgml:
* docs/gst/tmpl/gstindex.sgml:
* docs/gst/tmpl/gstinfo.sgml:
* docs/gst/tmpl/gstinterface.sgml:
* docs/gst/tmpl/gstlog.sgml:
* docs/gst/tmpl/gstmacros.sgml:
* docs/gst/tmpl/gstmarshal.sgml:
* docs/gst/tmpl/gstmd5sink.sgml:
* docs/gst/tmpl/gstmultifilesrc.sgml:
* docs/gst/tmpl/gstobject.sgml:
* docs/gst/tmpl/gstpad.sgml:
* docs/gst/tmpl/gstparse.sgml:
* docs/gst/tmpl/gstpipeline.sgml:
* docs/gst/tmpl/gstplugin.sgml:
* docs/gst/tmpl/gstpluginfeature.sgml:
* docs/gst/tmpl/gstqueue.sgml:
* docs/gst/tmpl/gstreamer-unused.sgml:
* docs/gst/tmpl/gstregistry.sgml:
* docs/gst/tmpl/gstregistrypool.sgml:
* docs/gst/tmpl/gstscheduler.sgml:
* docs/gst/tmpl/gstsearchfuncs.sgml:
* docs/gst/tmpl/gstshaper.sgml:
* docs/gst/tmpl/gstspider.sgml:
* docs/gst/tmpl/gstspideridentity.sgml:
* docs/gst/tmpl/gststructure.sgml:
* docs/gst/tmpl/gstsystemclock.sgml:
* docs/gst/tmpl/gsttag.sgml:
* docs/gst/tmpl/gsttaginterface.sgml:
* docs/gst/tmpl/gsttee.sgml:
* docs/gst/tmpl/gstthread.sgml:
* docs/gst/tmpl/gsttrace.sgml:
* docs/gst/tmpl/gsttrashstack.sgml:
* docs/gst/tmpl/gsttypefind.sgml:
* docs/gst/tmpl/gsttypes.sgml:
* docs/gst/tmpl/gsturi.sgml:
* docs/gst/tmpl/gsturitype.sgml:
* docs/gst/tmpl/gstutils.sgml:
* docs/gst/tmpl/gstvalue.sgml:
* docs/gst/tmpl/gstversion.sgml:
* docs/gst/tmpl/gstxml.sgml:
* docs/gst/tmpl/gstxmlregistry.sgml:
* docs/gst/tmpl/gthread-cothreads.sgml:
* docs/gst/tmpl/types.sgml:
2004-03-25 04:20:33 +00:00
common@99901894a4 dist common properly 2004-03-18 12:14:43 +00:00
components don't mix tabs and spaces 2004-03-15 19:27:17 +00:00
docs docs/gst/gstreamer-docs.sgml: I got tired of the reference manual being such complete crap, that I decided to do majo... 2004-03-25 04:20:33 +00:00
examples don't mix tabs and spaces 2004-03-15 19:27:17 +00:00
gst gst/schedulers/: fix GStreamer to not have issues with lvalue casts anymore (fixes some bug, but bugzilla is down) 2004-03-24 14:06:48 +00:00
include Revert again, this time without post-commit reindent hooks to put back the indentation :-) 2004-03-15 14:43:35 +00:00
libs libs/gst/control/: fix lvalue casts for real 2004-03-24 15:51:27 +00:00
pkgconfig merge in tagging 2003-11-24 02:09:23 +00:00
plugins gst/: clean up used memory in this elements correctly on teardown (closes #137279) 2004-03-21 03:22:55 +00:00
po updated swedish translation 2004-03-18 18:15:17 +00:00
scripts check out cvs code, autogen, make, make distcheck if you have spare machines at work sitting idly during the night, r... 2001-12-14 09:44:11 +00:00
tests no dear, that dress doesn't make you look fat. You look fat even without it. 2004-03-25 02:43:28 +00:00
testsuite no dear, that dress doesn't make you look fat. You look fat even without it. 2004-03-25 02:43:28 +00:00
tools don't mix tabs and spaces 2004-03-15 19:27:17 +00:00
.gitignore ignore some more 2004-03-15 17:26:30 +00:00
.gitmodules Added a first stab at a better clocking system. 2002-02-03 20:07:09 +00:00
AUTHORS AUTHORS: Added some names. Add yourself if you're missing. 2004-03-01 21:00:55 +00:00
autogen.sh update libtool requirement for latest plugin symbol changes 2004-02-29 08:34:03 +00:00
ChangeLog docs/gst/gstreamer-docs.sgml: I got tired of the reference manual being such complete crap, that I decided to do majo... 2004-03-25 04:20:33 +00:00
configure.ac configure.ac: Remove HAVE_ATOMIC_H test, since it's unused. (bug #137625) 2004-03-18 20:24:32 +00:00
COPYING initial checkin 2000-01-30 09:03:00 +00:00
COPYING.LIB initial checkin 2000-01-30 09:03:00 +00:00
DEVEL more registry fixes 2002-04-12 18:50:48 +00:00
DOCBUILDING more docbuilding notes 2002-04-12 09:43:11 +00:00
gst-element-check.m4 fixing automake warnings 2004-02-11 18:21:51 +00:00
gst-element-check.m4.in fixing automake warnings 2004-02-11 18:21:51 +00:00
gstreamer.spec.in adding back RELEASE clean up disting of built files 2004-02-27 12:37:13 +00:00
idiottest.mak idiottest was failing because of change of PLUGIN_USE_SRCDIR to 2001-06-19 12:53:05 +00:00
INSTALL initial checkin 2000-01-30 09:03:00 +00:00
LICENSE Adding explicit license information, since quite a large number of source files don't have the LGPL header. This is ... 2000-08-05 03:53:00 +00:00
MAINTAINERS MAINTAINERS: Add 2004-03-01 20:54:13 +00:00
Makefile.am dist common properly 2004-03-18 12:14:43 +00:00
NEWS releasing 2004-03-16 12:24:23 +00:00
README Trigger build 2004-02-16 10:30:11 +00:00
RELEASE releasing 2004-03-16 12:24:23 +00:00
REQUIREMENTS REQUIREMENTS: Add bison and flex. 2004-03-06 04:54:06 +00:00
stamp.h.in initial checkin 2000-01-30 09:03:00 +00:00
TODO update TODO 2003-02-12 23:33:55 +00:00

WHAT IT IS
----------
This is GStreamer, a framework for streaming media.  The
fundamental design comes from the video pipeline at Oregon Graduate
Institute, as well as some ideas from DirectMedia.  It's based on plug-ins
that will provide the various codec and other functionality.  The
interface hopefully is generic enough for various companies (ahem, Apple)
to release binary codecs for Linux, until such time as they get a clue and
release the source.

COMPILING FROM SOURCE
---------------------
- check output of ./configure --help to see if any options apply to you
- run
  ./configure
  make

  to build GStreamer.
- if you want to install it (not required), run
  make install
- You should create a registry for things to work.
  If you ran make install in the previous step, run
  gst-register
  as root.

  If you didn't install, run
  tools/gst-register
  as a normal user.

- try out a simple test:
  gst-launch fakesrc num_buffers=5 ! fakesink
  (If you didn't install GStreamer, again prefix gst-launch with tools/)

  If it outputs a bunch of messages from fakesrc and fakesink, everything is
  ok.

- After this, you're ready to install gst-plugins, which will provide the
  functionality you're probably looking for by now, so go on and read
  that README.

COMPILING FROM CVS
------------------
When building from CVS sources, you will need to run autogen.sh to generate 
the build system files.

GStreamer is cutting-edge stuff.  To be a CVS developer, you need 
what used to be considered cutting-edge tools.

ATM, most of us have at least these versions :

* autoconf	2.52	(NOT 2.52d)
* automake	1.5
* libtool	1.4     (NOT Gentoo's genetic failure 1.4.2)
* pkg-config    0.8.0

autogen.sh will check for these versions and complain if you don't have 
them.  You can also specify specific versions of automake and autoconf with
--with-automake and --with-autoconf

Check autogen.sh options by running autogen.sh --help

autogen.sh can pass on arguments to configure - you just need to separate them
from autogen.sh with -- between the two.
prefix has been added to autogen.sh but will be passed on to configure because
some build scripts like that.

When you have done this once, you can use autoregen.sh to re-autogen with
the last passed options as a handy shortcut.  Use it.

After the autogen.sh stage, you can follow the directions listed in
"COMPILING FROM SOURCE"