block_group.h

Go to the documentation of this file.

/* Tide
 *
 * Header for the BlockGroup element.
 *
 * 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_GROUP_H_)
#define TIDE_BLOCK_GROUP_H_

#include <boost/operators.hpp>
#include <tide/binary_element.h>
#include <tide/block_element.h>
#include <tide/block_additions.h>
#include <tide/block_impl.h>
#include <tide/master_element.h>
#include <tide/uint_element.h>
#include <tide/win_dll.h>


namespace tide
{
    class BlockGroup : public BlockElement,
        public boost::equality_comparable<BlockGroup>
    {
        public:
            BlockGroup(uint64_t track_number, int16_t timecode,
                    LacingType lacing=LACING_NONE, uint64_t duration=0,
                    uint64_t ref_priority=0);

            BlockAdditions& additions() { return additions_; }

            uint64_t duration() const { return duration_; }
            void duration(uint64_t duration) { duration_ = duration; }

            uint64_t ref_priority() const { return ref_priority_; }
            void ref_priority(uint64_t ref_priority)
                { ref_priority_ = ref_priority; }

            std::vector<int16_t>& ref_blocks() { return ref_blocks_; }

            std::vector<char> codec_state() const
                { return codec_state_; }
            void codec_state(std::vector<char> const& codec_state)
                { codec_state_ = codec_state; }

            // Block interface

            virtual uint64_t track_number() const
                { return block_.track_number(); }
            virtual void track_number(uint64_t track_number)
                { block_.track_number(track_number); }

            virtual int16_t timecode() const { return block_.timecode(); }
            virtual void timecode(int16_t timecode)
                { block_.timecode(timecode); }

            virtual bool invisible() const { return block_.invisible(); }
            virtual void invisible(bool invisible)
                { block_.invisible(invisible); }

            virtual LacingType lacing() const { return block_.lacing(); }
            virtual void lacing(LacingType lacing)
                { block_.lacing(lacing); }

            virtual value_type& at(size_type pos) { return block_.at(pos); }
            virtual value_type const& at(size_type pos) const
                { return block_.at(pos); }

            virtual value_type& operator[](size_type pos)
                { return block_[pos]; }
            virtual value_type const& operator[](size_type pos) const
                { return block_[pos]; }

            virtual iterator begin() { return block_.begin(); }
            virtual const_iterator begin() const { return block_.begin(); }
            virtual iterator end() { return block_.end(); }
            virtual const_iterator end() const { return block_.end(); }
            virtual reverse_iterator rbegin() { return block_.rbegin(); }
            virtual const_reverse_iterator rbegin() const
                { return block_.rbegin(); }
            virtual reverse_iterator rend() { return block_.rend(); }
            virtual const_reverse_iterator rend() const
                { return block_.rend(); }

            virtual bool empty() const { return block_.empty(); }
            virtual size_type count() const { return block_.count(); }
            virtual size_type max_count() const { return block_.max_count(); }

            virtual void clear() { block_.clear(); }

            virtual void erase(iterator position) { block_.erase(position); }
            virtual void erase(iterator first, iterator last)
                { block_.erase(first, last); }

            virtual void push_back(value_type const& value)
                { block_.push_back(value); }

            virtual void resize(size_type count) { block_.resize(count); }

            virtual void swap(BlockGroup& other);

            friend bool operator==(BlockGroup const& lhs,
                    BlockGroup const& rhs);

        protected:
            BlockAdditions additions_;
            UIntElement duration_;
            UIntElement ref_priority_;
            std::vector<int16_t> ref_blocks_;
            BinaryElement codec_state_;
            BlockImpl block_;

            // Element interface

            virtual std::streamsize body_size() const;

            virtual std::streamsize read_body(std::istream& input,
                    std::streamsize size);

            virtual std::streamsize write_body(std::ostream& output);

            void reset();
    }; // class BlockGroup

    bool operator==(BlockGroup const& lhs, BlockGroup const& rhs);
}; // namespace tide

// group elements

#endif // TIDE_BLOCK_GROUP_H_