block.h

Go to the documentation of this file.

/* Tide
 *
 * Header file for the Block interface.
 *
 * Copyright 2011 Geoffrey Biggs geoffrey.biggs@aist.go.jp
 *     RT-Synthesis Research Group
 *     Intelligent Systems Research Institute,
 *     National Institute of Advanced Industrial Science and Technology (AIST),
 *     Japan
 *     All rights reserved.
 *
 * This file is part of Tide.
 *
 * Tide is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * Tide 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 Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Tide. If not, see <http://www.gnu.org/licenses/>.
 */

#if !defined(TIDE_BLOCK_H_)
#define TIDE_BLOCK_H_

#include <boost/operators.hpp>
#include <boost/shared_ptr.hpp>
#include <stdint.h>
#include <tide/win_dll.h>
#include <vector>


namespace tide
{
    class TIDE_EXPORT Block :
        public boost::equality_comparable<Block>
    {
        public:
            typedef boost::shared_ptr<Block> Ptr;
            typedef boost::shared_ptr<Block const> ConstPtr;

            enum LacingType
            {
                LACING_NONE,
                LACING_EBML,
                LACING_FIXED
            };
            typedef std::vector<char> Frame;
            typedef boost::shared_ptr<Frame> FramePtr;
            typedef std::vector<FramePtr>::value_type value_type;
            typedef std::vector<FramePtr>::size_type size_type;
            typedef std::vector<FramePtr>::reference reference;
            typedef std::vector<FramePtr>::const_reference const_reference;
            typedef std::vector<FramePtr>::iterator iterator;
            typedef std::vector<FramePtr>::const_iterator const_iterator;
            typedef std::vector<FramePtr>::reverse_iterator reverse_iterator;
            typedef std::vector<FramePtr>::const_reverse_iterator
                const_reverse_iterator;

            Block(uint64_t track_number, int16_t timecode,
                    LacingType lacing=LACING_NONE)
            {}

            virtual ~Block() = 0;

            virtual uint64_t track_number() const = 0;
            virtual void track_number(uint64_t track_number) = 0;

            virtual int16_t timecode() const = 0;
            virtual void timecode(int16_t timecode) = 0;

            virtual bool invisible() const = 0;
            virtual void invisible(bool invisible) = 0;

            virtual LacingType lacing() const = 0;
            virtual void lacing(LacingType lacing) = 0;

            virtual value_type& at(size_type pos) = 0;
            virtual value_type const& at(size_type pos) const = 0;

            virtual value_type& operator[](size_type pos) = 0;
            virtual value_type const& operator[](size_type pos) const = 0;

            virtual iterator begin() = 0;
            virtual const_iterator begin() const = 0;
            virtual iterator end() = 0;
            virtual const_iterator end() const = 0;
            virtual reverse_iterator rbegin() = 0;
            virtual const_reverse_iterator rbegin() const = 0;
            virtual reverse_iterator rend() = 0;
            virtual const_reverse_iterator rend() const = 0;

            virtual bool empty() const = 0;
            virtual size_type count() const = 0;
            virtual size_type max_count() const = 0;

            virtual void clear() = 0;

            virtual void erase(iterator position) = 0;
            virtual void erase(iterator first, iterator last) = 0;

            virtual void push_back(value_type const& value) = 0;

            virtual void resize(size_type count) = 0;

            virtual void swap(Block& other) {}
    }; // class Block
}; // namespace tide

// group interfaces

#endif // TIDE_BLOCK_H_