QStreamer/include/qelement.h

Go to the documentation of this file.

#pragma once

// QStreamer
//  A GStreamer replacement for Qt.
//
// Authors :
//     Darren R. Starr <submux at gmail dot com>
//
// Copyright :   2010 The QStreamer Project
// License :     BSD (until we're informed that we're in violation of some other license)
// Donations :   Appreciated and possible through SourceForge donation page.
// 
// All code included in this project can be used freely in whatever way the user feels fit.
// If you want to take it, close it and be a weasel that doesn't even contribute back patches,
// so be it. Patches are however appreciated. Wrappers for other open source components are
// also appreciated.
//
// If you wish to be nice to us so we can see how our code is being used. Drop us a mail and let us
// know you're using it in your project.
//
// Support : By default the support is "you get what you pay for". Paid nothing, there's no implied
//           requirement to support you. On the other hand, some project developers are likely to 
//           make fixes, changes, features on request or contract.
//
// Enjoy

#include "qelementlist.h"
#include "qpinlist.h"

namespace QStreamer
{
        class QElement
        {
        public:
                virtual ~QElement();

                class QPipeline *pipeline();

                const class QPipeline *pipeline() const;

                const QString &name() const;

                QElement *parent();

                const QElement *parent() const;

                class QMediaError &error();

                QElementList &children();

                const QElementList &children() const;

                const QPinList &pins() const;

                class QMediaClock *clock();

                void setClock(class QMediaClock *clock);

                bool connectSourceTo(QElement *destinationElement, const QString &destinationPinName="sink");

                bool connectSourceTo(const QString &sourcePinName, QElement *destinationElement, const QString &destinationPinName="sink");

                class QSourcePin *sourcePin(const QString &name);

                class QSinkPin *sinkPin(const QString &name);

        protected:
                QElement(const QString &name, class QPipeline *parent);

                QElement(const QString &name, QElement *parent);

                bool addChild(QElement *child);

                bool removeChild(QElement *child);

                bool addPin(QPin *pin);

                bool removePin(QPin *pin);

                QPinList &pins();

                class QSourcePin *constructSourcePin(const QString &name);

                void deleteSourcePin(class QSourcePin *pin);

                void setParentElement(QElement *parent);

        private:
                QString m_name;

                class QPipeline *m_parentPipeline;
                QElement *m_parentElement;

                QElementList m_children;
                QPinList m_pins;

                class QMediaClock *m_clock;
        };

        inline class QPipeline *QElement::pipeline()
        {
                if(m_parentPipeline)
                        return m_parentPipeline;
                if(m_parentElement)
                        return m_parentElement->pipeline();
                return 0;
        }

        inline const class QPipeline *QElement::pipeline() const
        {
                if(m_parentPipeline)
                        return m_parentPipeline;
                if(m_parentElement)
                        return m_parentElement->pipeline();
                return 0;
        }

        inline const QString &QElement::name() const
        {
                return m_name;
        }

        inline QElement *QElement::parent()
        {
                return m_parentElement;
        }

        inline const QElement *QElement::parent() const
        {
                return m_parentElement;
        }

        inline void setParentElement(QElement *parent)
        {
                m_parentElement = parent;
        }
}