ready for basic functions

Author: superfashi

CHANGELOG.md

@@ -1 +1,5 @@
-# tlvmmt
+# MMT/TLV Parser
+
+This package provides the parser for MMT/TLV transport file (mmts) according to
+[ARIB STD-B60](https://www.arib.or.jp/english/std_tr/broadcasting/std-b60.html) and 
+[ARIB STD-B32](https://www.arib.or.jp/english/std_tr/broadcasting/std-b32.html) Fascicle 3.

README.md

@@ -4,11 +4,11 @@ cabal-version: 2.2
 --
 -- see: https://github.com/sol/hpack
 
-name:           tlvmmt
+name:           mmttlv
 version:        0.1.0.0
-description:    Please see the README on GitHub at <https://github.com/superfashi/tlvmmt#readme>
-homepage:       https://github.com/superfashi/tlvmmt#readme
-bug-reports:    https://github.com/superfashi/tlvmmt/issues
+description:    Please see the README on GitHub at <https://github.com/superfashi/mmttlv#readme>
+homepage:       https://github.com/superfashi/mmttlv#readme
+bug-reports:    https://github.com/superfashi/mmttlv/issues
 author:         SuperFashi
 maintainer:     [email protected]
 copyright:      2023 SuperFashi
@@ -17,24 +17,23 @@ license-file:   LICENSE
 build-type:     Simple
 extra-source-files:
     README.md
-    CHANGELOG.md
 
 source-repository head
   type: git
-  location: https://github.com/superfashi/tlvmmt
+  location: https://github.com/superfashi/mmttlv
 
 library
   exposed-modules:
-      Common
-      Descriptor
-      Lib
-      Message
-      Net
-      Table
+      Data.MMTTLV
+      Data.MMTTLV.Descriptor
+      Data.MMTTLV.Internal
+      Data.MMTTLV.Message
+      Data.MMTTLV.Net
+      Data.MMTTLV.Table
   other-modules:
-      Paths_tlvmmt
+      Paths_mmttlv
   autogen-modules:
-      Paths_tlvmmt
+      Paths_mmttlv
   hs-source-dirs:
       src
   default-extensions:
@@ -47,15 +46,14 @@ library
     , binary
     , bytestring
     , extra
-    , pretty-hex
   default-language: Haskell2010
 
-executable tlvmmt-exe
+executable mmttlv-exe
   main-is: Main.hs
   other-modules:
-      Paths_tlvmmt
+      Paths_mmttlv
   autogen-modules:
-      Paths_tlvmmt
+      Paths_mmttlv
   hs-source-dirs:
       app
   ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wredundant-constraints -threaded -rtsopts -with-rtsopts=-N
@@ -64,25 +62,24 @@ executable tlvmmt-exe
     , binary
     , bytestring
     , containers
+    , mmttlv
     , pretty-show
     , streamly-core
-    , tlvmmt
-    , transformers
   default-language: Haskell2010
 
-test-suite tlvmmt-test
+test-suite mmttlv-test
   type: exitcode-stdio-1.0
   main-is: Spec.hs
   other-modules:
-      Paths_tlvmmt
+      Paths_mmttlv
   autogen-modules:
-      Paths_tlvmmt
+      Paths_mmttlv
   hs-source-dirs:
       test
   ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wredundant-constraints -threaded -rtsopts -with-rtsopts=-N
   build-depends:
       base >=4.15 && <5
     , binary
     , bytestring
-    , tlvmmt
+    , mmttlv
   default-language: Haskell2010

app/Main.hs

@@ -1,14 +1,13 @@
-name:                tlvmmt
+name:                mmttlv
 version:             0.1.0.0
-github:              "superfashi/tlvmmt"
+github:              "superfashi/mmttlv"
 license:             0BSD
 author:              "SuperFashi"
 maintainer:          "[email protected]"
 copyright:           "2023 SuperFashi"
 
 extra-source-files:
 - README.md
-- CHANGELOG.md
 
 # Metadata used when publishing your package
 # synopsis:            Short description of your package
@@ -17,7 +16,7 @@ extra-source-files:
 # To avoid duplicated efforts in documentation and dealing with the
 # complications of embedding Haddock markup inside cabal files, it is
 # common to point users to the README.md file.
-description:         Please see the README on GitHub at <https://github.com/superfashi/tlvmmt#readme>
+description:         Please see the README on GitHub at <https://github.com/superfashi/mmttlv#readme>
 
 dependencies:
 - base >= 4.15 && < 5
@@ -42,30 +41,28 @@ library:
   - NumericUnderscores
   dependencies:
   - extra
-  - pretty-hex
 
 executables:
-  tlvmmt-exe:
+  mmttlv-exe:
     main:                Main.hs
     source-dirs:         app
     ghc-options:
     - -threaded
     - -rtsopts
     - -with-rtsopts=-N
     dependencies:
-    - tlvmmt
+    - mmttlv
     - streamly-core
-    - transformers
     - pretty-show
     - containers
 
 tests:
-  tlvmmt-test:
+  mmttlv-test:
     main:                Spec.hs
     source-dirs:         test
     ghc-options:
     - -threaded
     - -rtsopts
     - -with-rtsopts=-N
     dependencies:
-    - tlvmmt
+    - mmttlv

tlvmmt.cabal mmttlv.cabal

@@ -1,6 +1,5 @@
-module Lib where
+module Data.MMTTLV (module Data.MMTTLV) where
 
-import Common (FragmentationIndicator, consumeAll, repeatRead)
 import Control.Monad (guard, when)
 import Control.Monad.Extra (whenMaybe)
 import Data.Binary (Binary (..), Word16, Word32, Word8)
@@ -14,13 +13,11 @@ import Data.Binary.Get
     lookAhead,
   )
 import Data.Bits (shiftR, testBit, (.&.))
-import Data.ByteString.Lazy (ByteString, toStrict)
+import Data.ByteString.Lazy (ByteString)
 import qualified Data.ByteString.Lazy as L
-import Debug.Trace (traceShow)
-import Hexdump (prettyHex)
-import Message (ControlMessages)
-import Net (IPv6Addr, IPv6Header (..), NetworkTimeProtocolData, PartialIPv6Header, PartialUDPHeader, UDPHeader (..))
-import Numeric (showHex)
+import Data.MMTTLV.Internal (FragmentationIndicator, consumeAll, repeatRead)
+import Data.MMTTLV.Message (ControlMessages)
+import Data.MMTTLV.Net (IPv6Addr, IPv6Header (..), NetworkTimeProtocolData, PartialIPv6Header, PartialUDPHeader, UDPHeader (..))
 
 data MPUFragment
   = MPUFragmentMPUMetadata ByteString
@@ -266,7 +263,7 @@ instance Binary IPv6Packet where
 
       parsePayload :: IPv6Addr -> Word16 -> Get (Either ByteString NetworkTimeProtocolData)
       parsePayload (_, _, _, _, _, _, _, 0x101) 123 = Right <$> get
-      parsePayload _ _ = error "somthing else"
+      parsePayload _ _ = fail "Unknown IPv6 packet"
 
   put = undefined
 
@@ -287,10 +284,10 @@ instance Binary TLVPacket where
         l <- getWord16be
         d <- getLazyByteString $ fromIntegral l
         case t of
-          0x01 -> error "TODO: IPv4"
+          0x01 -> fail "TODO: IPv4"
           0x02 -> TLVPacketIPv6 <$> consumeAll get d
           0x03 -> TLVPacketHeaderCompressedIP <$> consumeAll get d
-          0xFE -> error "TODO: TCS"
+          0xFE -> fail "TODO: TCS"
           0xFF ->
             TLVPacketNull l
               <$ when (L.any (/= 0xFF) d) (fail "TLV Null packet is not null")

package.yaml

@@ -1,6 +1,5 @@
-module Descriptor where
+module Data.MMTTLV.Descriptor (module Data.MMTTLV.Descriptor) where
 
-import Common (ISO639LanguageCode, consumeAll, readN, repeatRead)
 import Control.Monad (when)
 import Control.Monad.Extra (whenMaybe)
 import Data.Binary (Binary (..), Word16, Word32, Word64, Word8)
@@ -16,7 +15,7 @@ import Data.Binary.Get
   )
 import Data.Bits (Bits (testBit), shiftR, (.&.))
 import Data.ByteString.Lazy (ByteString)
-import Debug.Trace (traceShow)
+import Data.MMTTLV.Internal (ISO639LanguageCode, consumeAll, readN, repeatRead)
 
 data Descriptor
   = MPUTimestamp MPUTimestampDescriptor

src/Lib.hs src/Data/MMTTLV.hs

@@ -1,4 +1,4 @@
-module Common where
+module Data.MMTTLV.Internal (module Data.MMTTLV.Internal) where
 
 import Control.Monad.Extra (ifM)
 import Data.Binary (Binary (..), Get, Word8)

src/Descriptor.hs src/Data/MMTTLV/Descriptor.hs

@@ -1,6 +1,5 @@
-module Message where
+module Data.MMTTLV.Message (module Data.MMTTLV.Message) where
 
-import Common (FragmentationIndicator, consumeAll, readN, repeatRead)
 import Control.Monad (when)
 import Data.Binary (Binary (..), Word16, Word32, Word8)
 import Data.Binary.Get
@@ -12,11 +11,11 @@ import Data.Binary.Get
     getWord8,
     lookAhead,
   )
-import Data.Bits (Bits (testBit), shiftR, (.&.))
+import Data.Bits (shiftR, testBit, (.&.))
 import Data.ByteString.Lazy (ByteString)
 import qualified Data.ByteString.Lazy as L (length, splitAt)
-import Debug.Trace (traceShow)
-import Table (Table)
+import Data.MMTTLV.Internal (FragmentationIndicator, consumeAll, readN, repeatRead)
+import Data.MMTTLV.Table (Table)
 
 data PAMessageTableInfo = PAMessageTableInfo
   { tableId :: Word8,

src/Common.hs src/Data/MMTTLV/Internal.hs

@@ -1,4 +1,4 @@
-module Net where
+module Data.MMTTLV.Net (module Data.MMTTLV.Net) where
 
 import Data.Binary (Binary (..), Word16, Word32, Word64, Word8)
 import Data.Binary.Get (getWord16be, getWord32be, getWord64be, getWord8)

src/Message.hs src/Data/MMTTLV/Message.hs

@@ -1,13 +1,13 @@
-module Table where
+module Data.MMTTLV.Table where
 
-import Common (consumeAll, readN, repeatRead)
 import Control.Monad (when)
 import Data.Binary (Binary (..), Word16, Word32, Word8)
 import Data.Binary.Get (Get, getLazyByteString, getRemainingLazyByteString, getWord16be, getWord32be, getWord8, lookAhead)
 import Data.Bits (Bits (testBit), (.&.))
 import Data.ByteString.Lazy (ByteString)
-import Descriptor (Descriptor)
-import Net (IPv4Addr, IPv6Addr)
+import Data.MMTTLV.Descriptor (Descriptor)
+import Data.MMTTLV.Internal (consumeAll, readN, repeatRead)
+import Data.MMTTLV.Net (IPv4Addr, IPv6Addr)
 
 data Table
   = MPT MMTPackageTable