// Copyright (C) 2007
// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
-// Stefan Bund <stefan.bund@fokus.fraunhofer.de>
+// Thorsten Horstmann <thorsten.horstmann@fokus.fraunhofer.de>
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// Free Software Foundation, Inc.,
// 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+/** \file
+ \brief TransportPacket public header */
+
#ifndef HH_TransportPacket_
#define HH_TransportPacket_ 1
// Custom includes
#include <algorithm>
-#include "Packets/PacketType.hh"
-#include "Packets/ParseInt.hh"
-#include "Packets/PacketRegistry.hh"
-#include "Packets/PacketParser.hh"
+#include "../../Packets/PacketType.hh"
+#include "../../Packets/ParseInt.hh"
+#include "../../Packets/PacketParser.hh"
//#include "TransportPacket.mpp"
///////////////////////////////hh.p////////////////////////////////////////
namespace senf {
-
- ///\addtogroup protocolbundle_mpegdvb
- ///@{
-
+
+ /** \brief Parse a Transport Stream packet
+
+ Parser implementing the header of a MPEG Transport Stream packet.
+
+ \see TransportPacketType
+ */
struct Parse_TransportPacket : public PacketParserBase
{
- SENF_PACKET_PARSER_INIT(Parse_TransportPacket);
-
typedef Parse_Flag < 0 > Parse_tei; // transport_error_indicator
typedef Parse_Flag < 1 > Parse_pusi; // payload_unit_start_indicator
typedef Parse_Flag < 2 > Parse_transportPrio; // transport_priority
typedef Parse_UIntField < 2, 4 > Parse_adaptCtrl; // adaptation_field_control
typedef Parse_UIntField < 4, 8 > Parse_contCounter; // continuity_counter
- ///////////////////////////////////////////////////////////////////////////
-
+# ifndef DOXYGEN
+
+ SENF_PACKET_PARSER_INIT(Parse_TransportPacket);
+
SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS(
- ((Field ) ( syncByte, Parse_UInt8 ))
+ ((Field ) ( sync_byte, Parse_UInt8 ))
((OverlayField) ( transport_error_indicator, Parse_tei ))
((OverlayField) ( pusi, Parse_pusi ))
((OverlayField) ( transport_priority, Parse_transportPrio ))
((Field ) ( continuity_counter, Parse_contCounter ))
);
+# else
+
+ Parse_UInt8 sync_byte() const;
+ Parse_tei transport_error_indicator() const;
+ Parse_pusi pusi() const;
+ Parse_transportPrio transport_priority() const;
+ Parse_pid pid() const;
+ Parse_tsc transport_scrmbl_ctrl() const;
+ Parse_adaptCtrl adaptation_field_ctrl() const;
+ Parse_contCounter continuity_counter() const;
+
+# endif
+
+// Parse_UInt8 payload_pointer() const {
+// return parse<Parse_UInt8>( Parse_TransportPacket::fixed_bytes );
+// }
};
+ /** \brief Transport Stream packet
+
+ <table class="senf">
+ <tr style="text-align:center">
+ <th>Syntax</th><th>No. of bits</th></tr>
+ <tr>
+ <td>transport_packet() {</td> <td></td>
+ </tr>
+ <tr>
+ <td style="padding-left:2em">\ref Parse_TransportPacket::sync_byte() "sync_byte"</td>
+ <td>8</td></tr>
+ <tr>
+ <td style="padding-left:2em">\ref Parse_TransportPacket::transport_error_indicator() "transport_error_indicator"</td>
+ <td>1</td></tr>
+ <tr>
+ <td style="padding-left:2em">\ref Parse_TransportPacket::pusi() "payload_uni_start_indicator"</td>
+ <td>1</td></tr>
+ <tr>
+ <td style="padding-left:2em">\ref Parse_TransportPacket::transport_priority() "transport_priority"</td>
+ <td>1</td></tr>
+ <tr>
+ <td style="padding-left:2em">\ref Parse_TransportPacket::pid() "PID"</td>
+ <td>13</td></tr>
+ <tr>
+ <td style="padding-left:2em">\ref Parse_TransportPacket::transport_scrmbl_ctrl() "transport_scrambling_control"</td>
+ <td>2</td></tr>
+ <tr>
+ <td style="padding-left:2em">\ref Parse_TransportPacket::adaptation_field_ctrl() "adaptation_field_control"</td>
+ <td>2</td></tr>
+ <tr>
+ <td style="padding-left:2em">\ref Parse_TransportPacket::continuity_counter() "continuity_counter"</td>
+ <td>4</td></tr>
+ <tr>
+ <td>}</td> <td></td></tr>
+ </table>
+
+ \par Packet type (typedef):
+ \ref TransportPacket
+
+ \par Fields:
+ \ref Parse_TransportPacket
+
+ \ingroup protocolbundle_mpegdvb
+ */
struct TransportPacketType
: public PacketTypeBase,
public PacketTypeMixin<TransportPacketType>
typedef Parse_TransportPacket parser;
using mixin::nextPacketRange;
- // using mixin::nextPacketType;
using mixin::init;
using mixin::initSize;
static void dump(packet p, std::ostream & os);
};
-
+
+ /** \brief Transport packet typedef */
typedef TransportPacketType::packet TransportPacket;
- ///@}
+ #define TRANSPORT_PACKET_SYNC_BYTE 0x47
}