Skip to content

Project File Structure

Matthew Ng edited this page Jul 11, 2015 · 8 revisions

Root

  • Lightpack.sln: the visual studio project that has the API and filter

LightpackAPI

Contains the files for the Lightpack C++ API

Contains the libraries (inside thirdparty folder):

  • hidapi: ability to speak to the USB (lightpack) device
  • inih: ability to read .ini files

Test

Contains the test project for the Lightpack C++ API

Directshow

Contains the Lightpack filter and its GUI

  • Lighpack-filter-gui/dependencies.bat: installs node.js dependency projects (Needs node.js installed)
  • Lighpack-filter-gui/compile.bat: builds the Node-webkit project and moves all the necessary files to the Release folder including the setup files, the bat files, icons, etc
  • Lighpack-filter-gui/build_all.bat: does compile.bat and zips up the project to lightpack-filter.zip
  • Lighpack-filter-gui/bat.bat: does compile.bat and runs nw.exe inside the Release folder

Release

Once all the projects are built, this folder will appear and be populated with files

  • installFilter.bat: installs lightpack.ax filter on Windows
  • uninstallFilter.bat: uninstalls lightpack.ax filter on Windows
  • lightpack.ax: the lightpack directshow filter
  • lightpack64.ax: the lightpack directshow filter (x64)
  • lightpack.node: the Nodejs extension of Lightpack
  • app-mutex.node: the Nodejs extension of Window's mutexes
  • lightpack-filter.zip: the release package of lightpack filter
  • setup.iss: the Inno setup file to build setup.exe
  • nw.exe: able to run the application
  • app/: the resources of the GUI
  • package.json: manifest of the GUI for nw.js
  • Other files (debug symbols, logs etc)

include

  • Lightpack.h: the header file to include when using Lightpack C++ API

lib

The x64 folder holds 64 bit versions of the libraries.

  • lightpack.lib: the Lightpack C++ API library file (for Windows), Release build
  • lightpackd.lib: the Lightpack C++ API library file (for Windows), Debug build