diff --git a/contributing.md b/contributing.md index e141f3a..6f82b06 100644 --- a/contributing.md +++ b/contributing.md @@ -1,3 +1,3 @@ -Please read "Purpose" and "Why aren't there more rotoscoping -applications?" in README.md before commenting on the code or submitting -pull requests. +# Contributing + +See [doc/development.md](doc/development.md). diff --git a/doc/development.md b/doc/development.md new file mode 100644 index 0000000..287ad77 --- /dev/null +++ b/doc/development.md @@ -0,0 +1,67 @@ +# RotoCanvasPaint Development + + +You can feel free to use the code according to the license, but the project has been replaced by: + +[rotocanvas](https://github.com/poikilos/rotocanvas)). + + +## Known Issues +* Audit & test `getLayerImagePathMostRecent`. + + +## Low-priority Known Issues +* drawLineTo (this is used for painting) should draw line instead of + last point + + +## Developer Notes +The RotoCanvas class is modular, with hopes that it can be used by +various video editing applications in the future. The recommended use +of RotoCanvas in a video editing application is for applying effects +(primarily manual rotoscoping) to source videos (as frame sequences) as +a preprocessing step before they are trimmed or other effects are +added, since rotoscoping is highly dependent on the source frame (base +layer) remaining the same. Using the RotoCanvas as a post-processing +effect is possible, but accurate frame seeking must be assured somehow +(such as by a frame-accurate video editing engine), and further edits +to the previous layers will in some cases cause the rotoscoped parts +(parts of the image edited by RotoCanvas) to no longer make sense (such +as, if a lens pinch effect is added to a scene where there was a layer +order error that has been rotoscoped out, instead of the error being +rotoscoped out, there will be both the error and a corrected blotch +that is the error's original position & shape), which in such cases +would require redoing the rotoscoping. + +### Alternate names +See "~/Nextcloud/d.cs/RotoCanvas/1.RotoCanvas (SEE GitHub instead).txt". + + +### RotoCanvas Paint Notes +* The save method is used by both the Save and the Save As actions. The + save sender is pre-programmed with the format property + + +## Notes on Other Programs +* In some programs, ss;ff denotes drop frame, and ss:ff denotes NON-drop + frame. +* mplayer is included in megui in the mencoder folder +* Change aspect ratio flag: + Use DVD Patcher, then test the result by dropping into Sony DVD + Architect Studio to and playing (will play at specified aspect ratio) + +### Get CLI Video Utilities on Windows +(Command-line Interface) +#### ffmpeg +* Install WinFF and add C:\Program Files (x86)\WinFF\ffmpeg.exe to the + PATH variable, or whatever path to which you installed it. + - Or, download gui4ffmpeg and unzip it to C:\PortableApps\Video, and + add C:\PortableApps\Video\gui4ffmpeg to your PATH variable. + +#### mplayer & mencoder +* Get **MPlayer for Windows** and add the MPlayer directory to your PATH + variable. (If you have IntegratorEduImport, you can add + `%USERPROFILE%\Documents\Projects\IntegratorEduImport\bin\MPlayer` + to your PATH). + - or download and unzip **megui** to `C:\PortableApps\Video` and add + `C:\PortableApps\Video\megui\tools\mencoder` to your PATH. diff --git a/readme.md b/readme.md index af4f724..c0d74d3 100644 --- a/readme.md +++ b/readme.md @@ -1,43 +1,9 @@ # RotoCanvas For now this repository serves as a collection of scripts for manipulating videos and DVDs (being gradually moved from the "more" -directory to [rotocanvas](https://github.com/poikilos/rotocanvas)). +directory to: - -## Known Issues -* Audit & test `getLayerImagePathMostRecent`. - - -## Low-priority Known Issues -* drawLineTo (this is used for painting) should draw line instead of - last point - - -## Developer Notes -The RotoCanvas class is modular, with hopes that it can be used by -various video editing applications in the future. The recommended use -of RotoCanvas in a video editing application is for applying effects -(primarily manual rotoscoping) to source videos (as frame sequences) as -a preprocessing step before they are trimmed or other effects are -added, since rotoscoping is highly dependent on the source frame (base -layer) remaining the same. Using the RotoCanvas as a post-processing -effect is possible, but accurate frame seeking must be assured somehow -(such as by a frame-accurate video editing engine), and further edits -to the previous layers will in some cases cause the rotoscoped parts -(parts of the image edited by RotoCanvas) to no longer make sense (such -as, if a lens pinch effect is added to a scene where there was a layer -order error that has been rotoscoped out, instead of the error being -rotoscoped out, there will be both the error and a corrected blotch -that is the error's original position & shape), which in such cases -would require redoing the rotoscoping. - -### Alternate names -See "~/Nextcloud/d.cs/RotoCanvas/1.RotoCanvas (SEE GitHub instead).txt". - - -### RotoCanvas Paint Notes -* The save method is used by both the Save and the Save As actions. The - save sender is pre-programmed with the format property +[rotocanvas](https://github.com/poikilos/rotocanvas)). ## Credits @@ -46,31 +12,10 @@ See "~/Nextcloud/d.cs/RotoCanvas/1.RotoCanvas (SEE GitHub instead).txt". *DISCLAIMER: See [license.txt](license.txt)* +## Development +See [doc/development.md](doc/development.md). -## Notes on Other Programs -* In some programs, ss;ff denotes drop frame, and ss:ff denotes NON-drop - frame. -* mplayer is included in megui in the mencoder folder -* Change aspect ratio flag: - Use DVD Patcher, then test the result by dropping into Sony DVD - Architect Studio to and playing (will play at specified aspect ratio) +FFmpeg Notes have been moved to +[rotocanvas](https://github.com/poikilos/rotocanvas), but see also the +"[more](more)" directory for further ffmpeg examples. -### Get CLI Video Utilities on Windows -(Command-line Interface) -#### ffmpeg -* Install WinFF and add C:\Program Files (x86)\WinFF\ffmpeg.exe to the - PATH variable, or whatever path to which you installed it. - - Or, download gui4ffmpeg and unzip it to C:\PortableApps\Video, and - add C:\PortableApps\Video\gui4ffmpeg to your PATH variable. - -#### mplayer & mencoder -* Get **MPlayer for Windows** and add the MPlayer directory to your PATH - variable. (If you have IntegratorEduImport, you can add - `%USERPROFILE%\Documents\Projects\IntegratorEduImport\bin\MPlayer` - to your PATH). - - or download and unzip **megui** to `C:\PortableApps\Video` and add - `C:\PortableApps\Video\megui\tools\mencoder` to your PATH. - - -## FFmpeg Notes -Moved to .