Packets documentation updates

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

diff --git a/Packets/MPEGDVBBundle/TransportPacket.hh b/Packets/MPEGDVBBundle/TransportPacket.hh
index 7363783..38200d5 100644 (file)
--- a/Packets/MPEGDVBBundle/TransportPacket.hh
+++ b/Packets/MPEGDVBBundle/TransportPacket.hh
@@ -1,9 +1,9 @@
 // $Id:TransportPacket.hh 560 2007-12-13 14:39:37Z tho $
 //
 // Copyright (C) 2007
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
-//     Thorsten Horstmann <thorsten.horstmann@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
@@ -23,11 +23,10 @@
 /** \file
     \brief TransportPacket public header */
 
-#ifndef HH_TransportPacket_
-#define HH_TransportPacket_ 1
+#ifndef HH_SENF_Packets_MPEGDVBBundle_TransportPacket_
+#define HH_SENF_Packets_MPEGDVBBundle_TransportPacket_ 1
 
 // Custom includes
-#include <algorithm>
 #include "../../Packets/Packets.hh"
 
 //#include "TransportPacket.mpp"
@@ -38,28 +37,37 @@ namespace senf {
     /** \brief Parse a Transport Stream packet
 
         Parser implementing the header of a MPEG Transport Stream packet.
+        \image html TransportPacket.png
         
         \see TransportPacketType
      */
     struct TransportPacketParser : public PacketParserBase
     {
-#       include SENF_FIXED_PARSER()
+#       include SENF_PARSER()
 
-        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_FIELD       ( sync_byte,                  UInt8Parser );
+
+        SENF_PARSER_BITFIELD    ( transport_error_indicator,  1, bool     );
+        SENF_PARSER_BITFIELD_RO ( 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_PRIVATE_VARIANT ( pointer_field_, pusi,
+                (senf::VoidPacketParser) (UInt8Parser) );
+        
         SENF_PARSER_FINALIZE( TransportPacketParser );
-    
-//        UInt8Parser payload_pointer() const {
-//            return parse<UInt8Parser>( TransportPacketParser::fixed_bytes ); 
-//        }
+        
+        UInt8Parser pointer_field() const;
+        void init_fields() const;
+        void setPUSI(bool pusi) const;
+
+        SENF_PARSER_INIT() {
+            defaultInit();
+            init_fields();
+        }
     };
     
     /** \brief Transport Stream packet
@@ -110,22 +118,23 @@ namespace senf {
         : public PacketTypeBase,
           public PacketTypeMixin<TransportPacketType>
     {
+#ifndef DOXYGEN
         typedef PacketTypeMixin<TransportPacketType> mixin;
-        typedef ConcretePacket<TransportPacketType> packet;
-        typedef TransportPacketParser parser;
+#endif
+        typedef ConcretePacket<TransportPacketType> packet; ///< Transport packet typedef
+        typedef TransportPacketParser parser; ///< typedef to the parser of Transport packet
     
         using mixin::nextPacketRange;
         using mixin::init;
         using mixin::initSize;
         
+        /** \brief Dump given Transport packet in readable form to given output stream */
         static void dump(packet p, std::ostream & os);
+        static const byte SYNC_BYTE = 0x47;
     };
     
     /** \brief Transport packet typedef */
-    typedef TransportPacketType::packet TransportPacket;
-    
-    #define TRANSPORT_PACKET_SYNC_BYTE 0x47
-  
+    typedef ConcretePacket<TransportPacketType> TransportPacket;
 }