.. packageparser documentation master file, created by
   sphinx-quickstart on Thu Jun  1 00:15:41 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Package Parser
==============

Package Parser is a Python library to probe and analyze audiovisual packages :

- DCP : Digital Cinema Package
- IMP : Interoperable Master Package

It uses a third party library not provided in this package to parse MXF `Cinecert asdcplib <http://www.cinecert.com/asdcplib/>`_

Find a ready for use `Docker container <https://hub.docker.com/r/antoinecozzi/packageparser/>`_  and `Package parser CLI <https://github.com/antoinecozzi/packageparser-cli>`_.

Installation
------------

.. code-block:: bash

   pip install packageparser

Usage
-----

.. code-block:: python

    from packageparser import DcpAnalyzor, DcpProbe,dcp_match_vf_ov
    from packageparser import ImpAnalyzor, ImpProbe
 
    da = DcpAnalyzor(dcp_path, skip_hash, skip_ff, skip_mxf_analyze)
    da.analyze()

    dp = DcpProbe(dcp_path, skip_mxf_analyze)
    dp.probe()

    dcp_match_vf_ov(vf_dcp_path, ov_dcp_path)

    ia = ImpAnalyzor(imp_path, skip_hash, skip_ff, skip_mxf_analyze)
    ia.analyze()

    ip = ImpProbe(imp_path, skip_mxf_analyze)
    ip.probe()


DCP Analyzor
------------

.. automodule:: packageparser.dcpanalyzor
    :members:
    :undoc-members:
    :show-inheritance:

DCP Probe
---------

.. automodule:: packageparser.dcpprobe
    :members:
    :undoc-members:
    :show-inheritance:

DCP XML
-------

.. automodule:: packageparser.dcpxml
    :members:
    :undoc-members:
    :show-inheritance:

DCP match vf ov
---------------

.. automodule:: packageparser.dcp_match_vf_ov
    :members:
    :undoc-members:
    :show-inheritance:

IMP Analyzor
------------

.. automodule:: packageparser.impanalyzor
    :members:
    :undoc-members:
    :show-inheritance:

IMP Probe
---------

.. automodule:: packageparser.impprobe
    :members:
    :undoc-members:
    :show-inheritance:

IMP XML
-------

.. automodule:: packageparser.impxml
    :members:
    :undoc-members:
    :show-inheritance:

MXF Process
-----------

.. automodule:: packageparser.mxfprocess
    :members:
    :undoc-members:
    :show-inheritance:

Utils
-----

.. automodule:: packageparser.utils
    :members:
    :undoc-members:
    :show-inheritance: