Merge pull request Dash-Industry-Forum#5 from TobbeEdgeware/restructure-for-distribution-packaging

Major restructuring for packaging for PyPi.

Author: tobbee

AUTHORS.md

@@ -3,6 +3,7 @@
 * @GitHub UserName (Required) [Name and/or Organization] (Optional)
 
 #Authors
+* @TobbeEdgeware [Torbjörn Einarsson, Edgeware]
 * @TobbeMobiTV [Torbjörn Einarsson, MobiTV]
 * @mobiola [Ola Hållmarker, MobiTV]
 * @KenthMobiTV [Kenth Andersson, MobiTV]

README.md

@@ -1,17 +1,22 @@
 # media-tools
-A collection of tools for analyzing, handling, and creating media and media containers.
+A collection of tools for analyzing, handling, and creating media and media
+containers.
 
-Recent additions:
+There are two main parts
 
-* **create\_ondemand\_dash.py**
-    * Combination of scripts to generate good DASH on-demand content using ffmpeg and MP4Box
-    * Aligns audio segments with video segments in an optional way
-    * More info in [how\_create\_dash\_ondemand.md](python/content_production/how_create_dash_ondemand.md)
-* **dashondemand\_verifier.py**
-    * Checks if an asset or tree of assets are good DASH on-demand assets
-    * Available at python/content_analyzers
+1. Python 2.7 tools for generating, analyzing, fetching DASH media. This is
+published as a PyPi module: dash-tools. Install by using
 
-These tools have been contributed by members of DASH-IF and are provided as is. They are not to be seen as reference software for DASH.
+> pip install dash_mediatools
+
+or clone the parser. For more info, see
+[dash_mediatools documentation](python/README.rst)
+
+2. A [Javascript mp4 parser](javascript/README.md)
+
+
+These tools have been contributed by members of DASH-IF and are provided as is.
+They are not to be seen as reference software for DASH.
 
 The contributing companies are (this far):
 MobiTV and Edgeware

javascript/README.md

@@ -0,0 +1 @@
+The mp4parser is available online at [http://mp4parser.com](http://mp4parser.com).

python/.gitignore

@@ -0,0 +1,2 @@
+__pycache__/
+*.py[cod]

python/LICENSE.txt

@@ -0,0 +1,28 @@
+# The copyright in this software is being made available under the BSD License,
+# included below. This software may be subject to other third party and contributor
+# rights, including patent rights, and no such rights are granted under this license.
+#
+# Copyright (c) 2016-2017, Dash Industry Forum.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#  * Redistributions of source code must retain the above copyright notice, this
+#  list of conditions and the following disclaimer.
+#  * Redistributions in binary form must reproduce the above copyright notice,
+#  this list of conditions and the following disclaimer in the documentation and/or
+#  other materials provided with the distribution.
+#  * Neither the name of Dash Industry Forum nor the names of its
+#  contributors may be used to endorse or promote products derived from this software
+#  without specific prior written permission.
+#
+#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS AS IS AND ANY
+#  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+#  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+#  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+#  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+#  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+#  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+#  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+#  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+#  POSSIBILITY OF SUCH DAMAGE.

python/MANIFEST.in

@@ -0,0 +1,4 @@
+include LICENSE.txt
+
+# Include the data files
+# recursive-include data *

python/Makefile

@@ -0,0 +1,11 @@
+SHELL=/usr/bin/env bash
+
+all: dist
+
+dist:
+	python setup.py bdist_wheel
+
+clean:
+	rm -rf build
+	rm -rf dist
+	rm -rf dash_mediatools.egg-info

python/README.rst

@@ -0,0 +1,37 @@
+Tools for creating, analyzing, modifying, downloading MPEG-DASH content
+=======================================================================
+DASH Industry Forum collection of various tools. A lot of them are small and
+need to be run directly from the source tree.
+
+Major tools
+-----------
+
+**dash-batch-encoder** (dash_tools.bache_encoder)
+  * Uses *ffmpeg* to create multi-variant mp4 content with fixed
+    GoP duration
+  * Output is suitable for transforming into DASH ABR content
+  * Configured via JSON recipes
+
+**dash-ondemand-creator** (dash_tools.ondemand_creator)
+  * Uses *MP4Box* to transform the output of dash-batch-encoder into
+    DASH OnDemand content.
+  * Postprocesses audio tracks to get segment alignment with video
+  * Configured via JSON recipy
+
+**dash-ondemand-verifier**  (dash_tools.ondemand_verifier)
+    * Performs checks on (trees of) DASH OnDemand asset and reports issues
+
+**dash-livedownloader**  (dash_tools.livedownloader)
+    * Downloads a live DASH asset and stores on disk. Only supports
+      $Number$-template
+
+These above tools are exported as scripts starting with prefix dash-.
+There corresponding names in the source code does not have that part.
+
+**dashtools.ts**
+    * This is a competent MPEG-2 TS parser
+
+For more details, see online documentation_.
+
+
+.. _documentation: https://github.com/Dash-Industry-Forum/media-tools/tree/master/python/doc/dash_tools.rst