User Tools

Site Tools


ch10_13_handbook:start

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
ch10_13_handbook:start [2014/08/13 09:31] – [DOCUMENT PURPOSE] pferrillch10_13_handbook:start [2014/09/12 15:40] (current) – [SAMPLE CODE] mcferrill
Line 19: Line 19:
  
 [[Python Code using DLL]] [[Python Code using DLL]]
 +
 +=== Samples Repository ===
 +The samples repository is hosted on bitbucket [[https://bitbucket.org/pychapter10/handbook-samples|here]].
 +Included in the repository are basic installation and usage directions akin to what is given here.
 +
 +The samples are organized into 3 categories:
 +  * c - Standard C samples using the Irig 106 library (from irig106.org)
 +  * pyi106 - Python samples using a wrapper to the above C library.
 +  * pyc10 - Pure Python samples using the PyChapter10 library.
 +
 +Each of the above directories has the same basic samples written as similarly as possible to perform the following tasks:
 +  * stat - Read a .ch10/.c10 file and display information on the data it contains. Can also filter report based on data type and channel ID.
 +  * copy - Copy packets from one file to another. Can also filter based on data type and channel ID.
 +  * dump - Export packet contents to separate files (eg. export video data to .mpg files). Can also filter based on data type and channel ID.
 +  * video - Full GUI application that will play split-screen video directly from a chapter 10 file as it is parsed in the background.
 +  * reindex (C sample still work in progress) - Strip index packets from a file and optionally rebuild new indices entirely.
 +  * listen (work in progress) - Listens for chapter 10 over an ethernet stream and saves to file.
 +
 +**Dependencies (C samples)**
 +
 +  * Visual studio (developed on VS Ultimate 2013)
 +  * Qt 5 & Qt visual studio plugin (for video sample)
 +
 +**Dependencies (Python Samples)**
 +
 +  * Python 2.7
 +  * PyChapter10 (see above, for pyc10 samples only)
 +  * [[http://docopt.org|docopt]]
 +  * [[http://qt-project.org/wiki/PySide|PySide]] (for video samples)
 +
 +**Building and Running (C samples)**
 +
 +The code for the C samples are (as much as possible) kept in the src directory under C samples. The code has comments outlining the different sections and is written as consistently as possible to the matching samples in the pyc10 and pyi106 sample directories. The visual studio project files are in the vs directory at the top of the c directory structure. Make sure samples/c/src and samples/c/irig106lib/src are in your "Additional Include Directories" and you should be able to compile, debug, etc.
 +
 +Once dependencies are installed you should be able to build binaries of the samples. The video sample depends on the mplayer executable (included) located relative to the build and debug directories, but the others are self-contained.
 +
 +All of the samples (again, excluding video since it's a full GUI application) are run from the command line. Each one supports the --help option to view usage, options, etc. for that specific tool.
 +
 +**Building and Running (Python samples)**
 +
 +Once python and any other dependencies are installed the python samples can be run at the command prompt by prefixing the invocation with "python" as in: "python stat.py test.c10" which would run the stat sample on a file "test.c10".
 +
 -------- --------
 ===== APPENDIX ===== ===== APPENDIX =====
ch10_13_handbook/start.1407940294.txt.gz · Last modified: 2014/08/13 09:31 by pferrill

Except where otherwise noted, content on this wiki is licensed under the following license: CC0 1.0 Universal
CC0 1.0 Universal Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki