track_entry.h

Go to the documentation of this file.

/* Tide
 *
 * Header for the TrackEntry element and related elements.
 *
 * 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_TRACK_ENTRY_H_)
#define TIDE_TRACK_ENTRY_H_

#include <boost/operators.hpp>
#include <boost/shared_ptr.hpp>
#include <string>
#include <tide/binary_element.h>
#include <tide/float_element.h>
#include <tide/master_element.h>
#include <tide/string_element.h>
#include <tide/track_operation.h>
#include <tide/uint_element.h>
#include <tide/win_dll.h>


namespace tide
{
    class TIDE_EXPORT TrackEntry : public MasterElement,
            public boost::equality_comparable<TrackEntry>
    {
        public:
            TrackEntry(uint64_t number, uint64_t uid,
                    std::string const& codec);

            virtual ~TrackEntry() {}

            uint64_t number() const { return number_; }
            void number(uint64_t number);

            uint64_t uid() const { return uid_; }
            void uid(uint64_t uid);

            uint8_t type() const { return type_; }
            void type(uint8_t type);

            bool enabled() const { return enabled_; }
            void enabled(bool enabled) { enabled_ = enabled; }

            bool forced() const { return forced_; }
            void forced(bool forced) { forced_ = forced; }

            bool lacing() const { return lacing_; }
            void lacing(bool lacing) { lacing_ = lacing; }

            uint64_t min_cache() const { return min_cache_; }
            void min_cache(uint64_t min_cache) { min_cache_ = min_cache; }

            uint64_t max_cache() const { return max_cache_; }
            void max_cache(uint64_t max_cache) { max_cache_ = max_cache; }

            uint64_t default_duration() const { return default_dur_; }
            void default_duration(uint64_t default_duration)
                { default_dur_ = default_duration; }

            double timecode_scale() const { return timecode_scale_; }
            void timecode_scale(double timecode_scale);

            uint64_t max_block_add_id() const
                { return max_block_add_id_; }
            void max_block_add_id(uint64_t max_id)
                { max_block_add_id_ = max_id; }

            std::string name() const { return name_; }
            void name(std::string name) { name_ = name; }

            std::string codec_id() const { return codec_id_; }
            void codec_id(std::string id);

            std::vector<char> codec_private() const
                { return codec_private_; }
            void codec_private(std::vector<char> const& data)
                { codec_private_ = data; }

            std::string codec_name() const { return codec_name_; }
            void codec_name(std::string name) { codec_name_ = name; }

            uint64_t attachment_link() const
                { return attachment_link_; }
            void attachment_link(uint64_t uid) { attachment_link_ = uid; }

            bool decode_all() const { return decode_all_; }
            void decode_all(bool decode_all) { decode_all_ = decode_all; }

            std::vector<uint64_t> overlays() const;
            void overlays(std::vector<uint64_t> const& uids);

            bool is_virtual() const { return operation_; }
            TrackOperationBase::Ptr operation() const { return operation_; }
            void operation(TrackOperationBase::Ptr const& operation)
                { operation_ = operation; }

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

            typedef boost::shared_ptr<TrackEntry> Ptr;
            typedef boost::shared_ptr<TrackEntry const> ConstPtr;

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

        protected:
            UIntElement number_;
            UIntElement uid_;
            UIntElement type_;
            UIntElement enabled_;
            UIntElement forced_;
            UIntElement lacing_;
            UIntElement min_cache_;
            UIntElement max_cache_;
            UIntElement default_dur_;
            FloatElement timecode_scale_;
            UIntElement max_block_add_id_;
            StringElement name_;
            StringElement codec_id_;
            BinaryElement codec_private_;
            StringElement codec_name_;
            UIntElement attachment_link_;
            UIntElement decode_all_;
            std::vector<UIntElement> overlays_;
            TrackOperationBase::Ptr operation_;

            virtual std::streamsize body_size() const;

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

            void reset();
            std::streamsize read_operation(std::istream& input);
    }; // class TrackEntry

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

// group elements

#endif // TIDE_TRACK_ENTRY_H_