miscellaneous bits and bobs ;)
[senf.git] / Packets / MPEGDVBBundle / TransportPacket.hh
index 9a935b9..ab9d495 100644 (file)
@@ -1,9 +1,9 @@
-// $Id:DatagramSection.hh 327 2007-07-20 10:03:44Z tho $
+// $Id:TransportPacket.hh 560 2007-12-13 14:39:37Z tho $
 //
 // Copyright (C) 2007
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
-//     Stefan Bund <stefan.bund@fokus.fraunhofer.de>
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
+//     Thorsten Horstmann <tho@berlios.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/Packets.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
      */
-    struct Parse_TransportPacket : public PacketParserBase
+    struct TransportPacketParser : public PacketParserBase
     {
-        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, 16 > Parse_pid;
-        typedef Parse_UIntField < 0,  2 > Parse_tsc; // transport_scrambling_control
-        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       ) ( sync_byte,                 Parse_UInt8         )) 
-            ((OverlayField) ( transport_error_indicator, Parse_tei           ))
-            ((OverlayField) ( pusi,                      Parse_pusi          ))
-            ((OverlayField) ( transport_priority,        Parse_transportPrio ))
-            ((Field       ) ( pid,                       Parse_pid           ))
-            ((OverlayField) ( transport_scrmbl_ctrl,     Parse_tsc           ))
-            ((OverlayField) ( adaptation_field_ctrl,     Parse_adaptCtrl     ))
-            ((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;
+#       include SENF_FIXED_PARSER()
 
-#       endif
-        
-//        Parse_UInt8 payload_pointer() const {
-//            return parse<Parse_UInt8>( Parse_TransportPacket::fixed_bytes ); 
+        SENF_PARSER_FIELD    ( sync_byte,                  UInt8Parser  );
+
+        SENF_PARSER_BITFIELD ( transport_error_indicator,   1, bool     );
+        SENF_PARSER_BITFIELD ( pusi,                        1, bool     );
+        SENF_PARSER_BITFIELD ( transport_priority,          1, bool     );
+        SENF_PARSER_BITFIELD ( pid,                        13, unsigned );
+        SENF_PARSER_BITFIELD ( transport_scrmbl_ctrl,       2, unsigned );
+        SENF_PARSER_BITFIELD ( adaptation_field_ctrl,       2, unsigned );
+        SENF_PARSER_BITFIELD ( continuity_counter,          4, unsigned );
+
+        SENF_PARSER_FINALIZE( TransportPacketParser );
+    
+//        UInt8Parser payload_pointer() const {
+//            return parse<UInt8Parser>( TransportPacketParser::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 TransportPacketParser::sync_byte() "sync_byte"</td>
+            <td>8</td></tr>
+          <tr>
+            <td style="padding-left:2em">\ref TransportPacketParser::transport_error_indicator() "transport_error_indicator"</td>
+            <td>1</td></tr>
+          <tr>
+            <td style="padding-left:2em">\ref TransportPacketParser::pusi() "payload_uni_start_indicator"</td>
+            <td>1</td></tr>
+          <tr>
+            <td style="padding-left:2em">\ref TransportPacketParser::transport_priority() "transport_priority"</td>
+            <td>1</td></tr>
+          <tr>
+            <td style="padding-left:2em">\ref TransportPacketParser::pid() "PID"</td>
+            <td>13</td></tr>
+          <tr>
+            <td style="padding-left:2em">\ref TransportPacketParser::transport_scrmbl_ctrl() "transport_scrambling_control"</td>
+            <td>2</td></tr>
+          <tr>
+            <td style="padding-left:2em">\ref TransportPacketParser::adaptation_field_ctrl() "adaptation_field_control"</td>
+            <td>2</td></tr>
+          <tr>
+            <td style="padding-left:2em">\ref TransportPacketParser::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
+            \ref TransportPacketParser
 
         \ingroup protocolbundle_mpegdvb
      */
@@ -100,19 +112,18 @@ namespace senf {
     {
         typedef PacketTypeMixin<TransportPacketType> mixin;
         typedef ConcretePacket<TransportPacketType> packet;
-        typedef Parse_TransportPacket parser;
+        typedef TransportPacketParser parser;
     
         using mixin::nextPacketRange;
-    //          using mixin::nextPacketType;
         using mixin::init;
         using mixin::initSize;
         
         static void dump(packet p, std::ostream & os);
+        static const byte SYNC_BYTE = 0x47;
     };
     
     /** \brief Transport packet typedef */
-    typedef TransportPacketType::packet TransportPacket;
-  
+    typedef ConcretePacket<TransportPacketType> TransportPacket;
 }