TLVPacket creating is working now; thanx to Stefan once again. Documentation will...

[senf.git] / Packets / MPEGDVBBundle / TransportPacket.hh

diff --git a/Packets/MPEGDVBBundle/TransportPacket.hh b/Packets/MPEGDVBBundle/TransportPacket.hh
index 9a935b9..31b66cd 100644 (file)
--- a/Packets/MPEGDVBBundle/TransportPacket.hh
+++ b/Packets/MPEGDVBBundle/TransportPacket.hh
@@ -3,7 +3,7 @@
 // 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
@@ -20,24 +20,26 @@
 // 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 {
 
-    /** \brief Parse a UDP packet
+    /** \brief Parse a Transport Stream packet
 
-        Parser implementing the header of a MPEG Transport Stream Packet.
+        Parser implementing the header of a MPEG Transport Stream packet.
         
         \see TransportPacketType
      */
@@ -86,6 +88,40 @@ namespace senf {
     
     /** \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
 
@@ -103,7 +139,6 @@ namespace senf {
         typedef Parse_TransportPacket parser;
     
         using mixin::nextPacketRange;
-    //          using mixin::nextPacketType;
         using mixin::init;
         using mixin::initSize;
         
@@ -112,6 +147,8 @@ namespace senf {
     
     /** \brief Transport packet typedef */
     typedef TransportPacketType::packet TransportPacket;
+    
+    #define TRANSPORT_PACKET_SYNC_BYTE 0x47
   
 }