convmlv/README.md

# convmlv #

RAW ML Formats to Workable Images/Movies Developer
=======
I needed a workflow to provide me full control over development for filmmaking with Magic Lantern (beyond mlrawviewer's excellent preview!), while keeping things simple by providing defaults for everything.

**So**, I wrote this: A program that converts from RAW formats (MLV, RAW, DNG, CR2) to workable formats (EXR, MOV, DPX, DNxHD, MJPEG, etc.) with many, many features in between (color management, filters, dual iso, demosaic, etc.)

It's extensible, letting you write plugins controlling/filtering any leg of the journey from raw to developed. Config file syntax also makes it a kind of "make for productions"; with configs and one command, you can develop your whole project from unsorted raw footage to editable, proxied, organized stuff!

I use it myself :D so here's some shorts with it (back at v1.7) in action!!

http://youtu.be/yi-G7sXHB1M
http://youtu.be/yi-G7sXHB1M

## Installation
Supported platforms are Linux and Mac. To install, copy/paste the following into a terminal:

1. **Extract tarball**. Rename it "convmlv" and put it somewhere useful. `cd` to that directory.
2. **Install Deps**: `sudo apt-get install $(./convmlv.sh -K <number>)`. Replace <number> as indicated below:
    * For Debain, use the number "0"
    * For Fedora, replace `apt-get` with `yum` and use the number "2".
    * For Mac, replace `sudo apt-get` with `brew` and use the number "3". *Requires Homebrew to be installed.

3. **Install Python deps**: `sudo python3 -m pip install $ (./convmlv.sh -Y)`
4. (Optional) **Add to Path**: `sudo ln -s $(pwd)/convmlv.sh /usr/local/bin/convmlv`

You're done! For more info, see the Documentation (especially the PDF has a guide to this).

## Documentation
Especially the PDF is designed as a tutorial; take a look!

**The Forum Thread** at [http://www.magiclantern.fm/forum/index.php?topic=16799.0](http://www.magiclantern.fm/forum/index.php?topic=16799.0) is always up to date.

**The PDF** found *in the release* is up to date, including tutorials, tips, explanations, plugin API, and more.

**The Help Page** is the most up to date; just run `convmlv -h` or look at docs-->MANPAGE in the release tarball.

## Development
To build the PDF and MANPAGE using LATEX, run `docs/buildDocs.sh`. You can clean it up using `docs/cleanDocs.sh`.

To make a release tarball, simply place all the manual binary deps into the `binaries` dir and run `./mkrelease.sh`.

The source code is located in `src`, where you'll find bash and Python code, as well as the builtin plugins. convmlv.sh itself imports all the src's, and acts as a kind of program selector; develop is but one option.
Think I fiexed readme... 2016-03-11 04:12:34 +01:00			`# convmlv #`
README update. 2016-03-11 04:10:39 +01:00
README update 2016-11-30 07:03:57 +01:00			`RAW ML Formats to Workable Images/Movies Developer`
Think I fiexed readme... 2016-03-11 04:12:34 +01:00			`=======`
README update 2016-11-30 07:03:57 +01:00			`I needed a workflow to provide me full control over development for filmmaking with Magic Lantern (beyond mlrawviewer's excellent preview!), while keeping things simple by providing defaults for everything.`

Using array; start wipe of globals. Need to complete arg functions, globals transition, and modularization of develop() before a lot of code cleanup, then the plugin system. That'll deserve a merge, where I'll branch into the big califrames, then start committing modular features. Before 2.1.0 I'll do some RCs for myself, reevaluate the colorspace bug, and that'll be it! 2016-12-09 04:37:22 +01:00			`So, I wrote this: A program that converts from RAW formats (MLV, RAW, DNG, CR2) to workable formats (EXR, MOV, DPX, DNxHD, MJPEG, etc.) with many, many features in between (color management, filters, dual iso, demosaic, etc.)`
README update 2016-11-30 07:03:57 +01:00
Using array; start wipe of globals. Need to complete arg functions, globals transition, and modularization of develop() before a lot of code cleanup, then the plugin system. That'll deserve a merge, where I'll branch into the big califrames, then start committing modular features. Before 2.1.0 I'll do some RCs for myself, reevaluate the colorspace bug, and that'll be it! 2016-12-09 04:37:22 +01:00			`It's extensible, letting you write plugins controlling/filtering any leg of the journey from raw to developed. Config file syntax also makes it a kind of "make for productions"; with configs and one command, you can develop your whole project from unsorted raw footage to editable, proxied, organized stuff!`

			`I use it myself :D so here's some shorts with it (back at v1.7) in action!!`
README update 2016-11-30 07:03:57 +01:00
			`http://youtu.be/yi-G7sXHB1M`
			`http://youtu.be/yi-G7sXHB1M`

Using array; start wipe of globals. Need to complete arg functions, globals transition, and modularization of develop() before a lot of code cleanup, then the plugin system. That'll deserve a merge, where I'll branch into the big califrames, then start committing modular features. Before 2.1.0 I'll do some RCs for myself, reevaluate the colorspace bug, and that'll be it! 2016-12-09 04:37:22 +01:00			`## Installation`
			`Supported platforms are Linux and Mac. To install, copy/paste the following into a terminal:`
Added reference to documentation. 2016-03-28 23:30:26 +02:00
Using array; start wipe of globals. Need to complete arg functions, globals transition, and modularization of develop() before a lot of code cleanup, then the plugin system. That'll deserve a merge, where I'll branch into the big califrames, then start committing modular features. Before 2.1.0 I'll do some RCs for myself, reevaluate the colorspace bug, and that'll be it! 2016-12-09 04:37:22 +01:00			1. Extract tarball. Rename it "convmlv" and put it somewhere useful. `cd` to that directory.
			2. Install Deps: `sudo apt-get install $(./convmlv.sh -K <number>)`. Replace <number> as indicated below:
			`* For Debain, use the number "0"`
			* For Fedora, replace `apt-get` with `yum` and use the number "2".
			* For Mac, replace `sudo apt-get` with `brew` and use the number "3". *Requires Homebrew to be installed.
Update readme 2016-03-12 21:43:46 +01:00
Using array; start wipe of globals. Need to complete arg functions, globals transition, and modularization of develop() before a lot of code cleanup, then the plugin system. That'll deserve a merge, where I'll branch into the big califrames, then start committing modular features. Before 2.1.0 I'll do some RCs for myself, reevaluate the colorspace bug, and that'll be it! 2016-12-09 04:37:22 +01:00			3. Install Python deps: `sudo python3 -m pip install $ (./convmlv.sh -Y)`
			4. (Optional) Add to Path: `sudo ln -s $(pwd)/convmlv.sh /usr/local/bin/convmlv`
Huge color management release. Added lists getting ready for true compatibility, multiple LUTs, dcraw paths, updated convmlv -h. Bug Fixes: Reuse of DNGs, DPX colorspace bug, PNG compression format, "files left" display for DNG folders, ARG bug, filter application sequence, file-specific reset bugs. Error Checking: Though not complete, it's been drastically upscaled - there should be far fewer "weird errors"; it'll tell you what's wrong. Speedups: ffmpeg filtering is faster for EXRs. movie creation is much faster if images were developed. 2016-07-09 02:11:59 +02:00
Using array; start wipe of globals. Need to complete arg functions, globals transition, and modularization of develop() before a lot of code cleanup, then the plugin system. That'll deserve a merge, where I'll branch into the big califrames, then start committing modular features. Before 2.1.0 I'll do some RCs for myself, reevaluate the colorspace bug, and that'll be it! 2016-12-09 04:37:22 +01:00			`You're done! For more info, see the Documentation (especially the PDF has a guide to this).`
Update readme 2016-03-12 21:43:46 +01:00
Using array; start wipe of globals. Need to complete arg functions, globals transition, and modularization of develop() before a lot of code cleanup, then the plugin system. That'll deserve a merge, where I'll branch into the big califrames, then start committing modular features. Before 2.1.0 I'll do some RCs for myself, reevaluate the colorspace bug, and that'll be it! 2016-12-09 04:37:22 +01:00			`## Documentation`
			`Especially the PDF is designed as a tutorial; take a look!`
Huge color management release. Added lists getting ready for true compatibility, multiple LUTs, dcraw paths, updated convmlv -h. Bug Fixes: Reuse of DNGs, DPX colorspace bug, PNG compression format, "files left" display for DNG folders, ARG bug, filter application sequence, file-specific reset bugs. Error Checking: Though not complete, it's been drastically upscaled - there should be far fewer "weird errors"; it'll tell you what's wrong. Speedups: ffmpeg filtering is faster for EXRs. movie creation is much faster if images were developed. 2016-07-09 02:11:59 +02:00
Using array; start wipe of globals. Need to complete arg functions, globals transition, and modularization of develop() before a lot of code cleanup, then the plugin system. That'll deserve a merge, where I'll branch into the big califrames, then start committing modular features. Before 2.1.0 I'll do some RCs for myself, reevaluate the colorspace bug, and that'll be it! 2016-12-09 04:37:22 +01:00			`The Forum Thread at [http://www.magiclantern.fm/forum/index.php?topic=16799.0](http://www.magiclantern.fm/forum/index.php?topic=16799.0) is always up to date.`
Fixed the huge colorspace bug (in a weird way - see Nasty Hacks in source). Fixed sRange 1 n error, where no output would be given. Implemented hqdn3d denoiser, and ffmpeg deshake, filters. Expanded filter framework; list now formats correctly. 2016-06-27 06:59:14 +02:00
Using array; start wipe of globals. Need to complete arg functions, globals transition, and modularization of develop() before a lot of code cleanup, then the plugin system. That'll deserve a merge, where I'll branch into the big califrames, then start committing modular features. Before 2.1.0 I'll do some RCs for myself, reevaluate the colorspace bug, and that'll be it! 2016-12-09 04:37:22 +01:00			`The PDF found in the release is up to date, including tutorials, tips, explanations, plugin API, and more.`
Fixed the huge colorspace bug (in a weird way - see Nasty Hacks in source). Fixed sRange 1 n error, where no output would be given. Implemented hqdn3d denoiser, and ffmpeg deshake, filters. Expanded filter framework; list now formats correctly. 2016-06-27 06:59:14 +02:00
Using array; start wipe of globals. Need to complete arg functions, globals transition, and modularization of develop() before a lot of code cleanup, then the plugin system. That'll deserve a merge, where I'll branch into the big califrames, then start committing modular features. Before 2.1.0 I'll do some RCs for myself, reevaluate the colorspace bug, and that'll be it! 2016-12-09 04:37:22 +01:00			The Help Page is the most up to date; just run `convmlv -h` or look at docs-->MANPAGE in the release tarball.
Huge color management release. Added lists getting ready for true compatibility, multiple LUTs, dcraw paths, updated convmlv -h. Bug Fixes: Reuse of DNGs, DPX colorspace bug, PNG compression format, "files left" display for DNG folders, ARG bug, filter application sequence, file-specific reset bugs. Error Checking: Though not complete, it's been drastically upscaled - there should be far fewer "weird errors"; it'll tell you what's wrong. Speedups: ffmpeg filtering is faster for EXRs. movie creation is much faster if images were developed. 2016-07-09 02:11:59 +02:00
Using array; start wipe of globals. Need to complete arg functions, globals transition, and modularization of develop() before a lot of code cleanup, then the plugin system. That'll deserve a merge, where I'll branch into the big califrames, then start committing modular features. Before 2.1.0 I'll do some RCs for myself, reevaluate the colorspace bug, and that'll be it! 2016-12-09 04:37:22 +01:00			`## Development`
			To build the PDF and MANPAGE using LATEX, run `docs/buildDocs.sh`. You can clean it up using `docs/cleanDocs.sh`.
Finished release + bugfixes. See 1.9.4 changelog. 2016-06-30 23:01:35 +02:00
Using array; start wipe of globals. Need to complete arg functions, globals transition, and modularization of develop() before a lot of code cleanup, then the plugin system. That'll deserve a merge, where I'll branch into the big califrames, then start committing modular features. Before 2.1.0 I'll do some RCs for myself, reevaluate the colorspace bug, and that'll be it! 2016-12-09 04:37:22 +01:00			To make a release tarball, simply place all the manual binary deps into the `binaries` dir and run `./mkrelease.sh`.
Huge color management release. Added lists getting ready for true compatibility, multiple LUTs, dcraw paths, updated convmlv -h. Bug Fixes: Reuse of DNGs, DPX colorspace bug, PNG compression format, "files left" display for DNG folders, ARG bug, filter application sequence, file-specific reset bugs. Error Checking: Though not complete, it's been drastically upscaled - there should be far fewer "weird errors"; it'll tell you what's wrong. Speedups: ffmpeg filtering is faster for EXRs. movie creation is much faster if images were developed. 2016-07-09 02:11:59 +02:00
Using array; start wipe of globals. Need to complete arg functions, globals transition, and modularization of develop() before a lot of code cleanup, then the plugin system. That'll deserve a merge, where I'll branch into the big califrames, then start committing modular features. Before 2.1.0 I'll do some RCs for myself, reevaluate the colorspace bug, and that'll be it! 2016-12-09 04:37:22 +01:00			The source code is located in `src`, where you'll find bash and Python code, as well as the builtin plugins. convmlv.sh itself imports all the src's, and acts as a kind of program selector; develop is but one option.