00001 // Torc - Copyright 2011 University of Southern California. All Rights Reserved. 00002 // $HeadURL: https://torc-isi.svn.sourceforge.net/svnroot/torc-isi/branches/staging/0.9/src/torc/bitstream/VirtexBitstream.hpp $ 00003 // $Id: VirtexBitstream.hpp 10 2011-10-12 18:40:16Z nsteiner $ 00004 00005 // This program is free software: you can redistribute it and/or modify it under the terms of the 00006 // GNU General Public License as published by the Free Software Foundation, either version 3 of the 00007 // License, or (at your option) any later version. 00008 // 00009 // This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 00010 // without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See 00011 // the GNU General Public License for more details. 00012 // 00013 // You should have received a copy of the GNU General Public License along with this program. If 00014 // not, see <http://www.gnu.org/licenses/>. 00015 00016 /// \file 00017 /// \brief Header for the VirtexBitstream class. 00018 00019 #ifndef TORC_BITSTREAM_VIRTEXBITSTREAM_HPP 00020 #define TORC_BITSTREAM_VIRTEXBITSTREAM_HPP 00021 00022 #include <boost/cstdint.hpp> 00023 #include "torc/bitstream/Bitstream.hpp" 00024 #include "torc/bitstream/VirtexPacket.hpp" 00025 #include "torc/bitstream/FrameSet.hpp" 00026 #include <fstream> 00027 00028 namespace torc { 00029 namespace bitstream { 00030 00031 namespace bitstream { class VirtexBitstreamUnitTest; } 00032 00033 /// \brief Virtex-class bitstream. 00034 class VirtexBitstream : public Bitstream, public VirtexPacketVector, public VirtexPacketConstants, 00035 public VirtexFrameBlocks { 00036 friend class torc::bitstream::bitstream::VirtexBitstreamUnitTest; 00037 protected: 00038 // typedefs 00039 /// \brief Imported type name. 00040 typedef boost::uint32_t uint32_t; 00041 // members 00042 /// \brief Input Frame blocks. 00043 VirtexFrameBlocks mFrameBlocks; 00044 public: 00045 // constructors 00046 /// \brief Basic constructor. 00047 VirtexBitstream(void) : Bitstream(), VirtexPacketVector(), VirtexPacketConstants(), 00048 VirtexFrameBlocks() {} 00049 // functions 00050 /// \brief Read bitstream packets from a stream. 00051 /// \note This function should be called after the bitstream header has been read. 00052 virtual void readPackets(std::istream& inStream); 00053 /// \brief Write bitstream packets to a stream. 00054 virtual void writePackets(std::ostream& inStream); 00055 /// \brief Preflight the packets. 00056 virtual void preflightPackets(void); 00057 /// \brief Update the header packet length. 00058 virtual void updatePacketLength(void); 00059 }; 00060 00061 } // namespace bitstream 00062 } // namespace torc 00063 00064 #endif // TORC_BITSTREAM_VIRTEXBITSTREAM_HPP