Move include files in debian packge into 'senf' subdirectory

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

diff --git a/Packets/MPEGDVBBundle/TransportPacket.hh b/Packets/MPEGDVBBundle/TransportPacket.hh
index 86dba04..94248c9 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,28 +20,32 @@
 // 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/PacketRegistry.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
@@ -50,10 +54,12 @@ namespace senf {
         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 ))
@@ -63,8 +69,34 @@ namespace senf {
             ((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
+        
+        \par Packet type (typedef):
+            \ref TransportPacket
+
+        \par Fields:
+            \ref Parse_TransportPacket
+
+        \ingroup protocolbundle_mpegdvb
+     */
     struct TransportPacketType
         : public PacketTypeBase,
           public PacketTypeMixin<TransportPacketType>
@@ -80,10 +112,11 @@ namespace senf {
         
         static void dump(packet p, std::ostream & os);
     };
-        
+    
+    /** \brief Transport packet typedef */
     typedef TransportPacketType::packet TransportPacket;
     
-    ///@}
+    #define TRANSPORT_PACKET_SYNC_BYTE 0x47
   
 }