segment.h

Go to the documentation of this file.

/* Tide
 *
 * Header for the Segment 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_SEGMENT_H_)
#define TIDE_SEGMENT_H_

#include <map>
#include <tide/master_element.h>
#include <tide/metaseek.h>
#include <tide/segment_info.h>
#include <tide/win_dll.h>


namespace tide
{
    class TIDE_EXPORT Segment : public MasterElement
    {
        public:
            Segment(std::streamsize pad_size=4096);

            std::streamsize pad_size() const { return pad_size_; }
            void pad_size(std::streamsize pad_size) { pad_size_ = pad_size; }

            std::streamsize size() const;

            std::streamsize finalise(std::iostream& stream);

            SeekHead index;

            SegmentInfo info;

            std::streamsize to_segment_offset(std::streamsize stream_offset);

            std::streamsize to_stream_offset(std::streamsize seg_offset);

        protected:
            std::streamsize pad_size_;
            std::streamsize size_;
            bool writing_;

            std::streamsize body_size() const
                { return size_; }

            std::streamsize write_size(std::ostream& output);

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

            std::streamsize read_body(std::istream& input,
                    std::streamsize size);
    }; // class Segment
}; // namespace tide


#endif // TIDE_SEGMENT_H_