Merge pull request #35 from OpenShot/release-20190320

Merge release branch into master

.gitlab-ci.yml

@@ -14,7 +14,10 @@ linux-builder:
     - make
     - make install
     - echo -e "CI_PROJECT_NAME:$CI_PROJECT_NAME\nCI_COMMIT_REF_NAME:$CI_COMMIT_REF_NAME\nCI_COMMIT_SHA:$CI_COMMIT_SHA\nCI_JOB_ID:$CI_JOB_ID" > "install-x64/share/$CI_PROJECT_NAME"
+    - git log $(git describe --tags --abbrev=0)..HEAD --oneline --pretty=format:"%C(auto,yellow)%h%C(auto,magenta)% %C(auto,blue)%>(12,trunc)%ad %C(auto,green)%<(25,trunc)%aN%C(auto,reset)%s%C(auto,red)% gD% D" --date=short > "install-x64/share/$CI_PROJECT_NAME.log"
   when: always
+  except:
+  - tags
   tags:
     - linux
 
@@ -30,7 +33,10 @@ mac-builder:
     - make
     - make install
     - echo -e "CI_PROJECT_NAME:$CI_PROJECT_NAME\nCI_COMMIT_REF_NAME:$CI_COMMIT_REF_NAME\nCI_COMMIT_SHA:$CI_COMMIT_SHA\nCI_JOB_ID:$CI_JOB_ID" > "install-x64/share/$CI_PROJECT_NAME"
+    - git log $(git describe --tags --abbrev=0)..HEAD --oneline --pretty=format:"%C(auto,yellow)%h%C(auto,magenta)% %C(auto,blue)%>(12,trunc)%ad %C(auto,green)%<(25,trunc)%aN%C(auto,reset)%s%C(auto,red)% gD% D" --date=short > "install-x64/share/$CI_PROJECT_NAME.log"
   when: always
+  except:
+  - tags
   tags:
     - mac
 
@@ -51,7 +57,11 @@ windows-builder-x86:
     - mingw32-make
     - mingw32-make install
     - New-Item -path "install-x86/share/" -Name "$CI_PROJECT_NAME" -Value "CI_PROJECT_NAME:$CI_PROJECT_NAME`nCI_COMMIT_REF_NAME:$CI_COMMIT_REF_NAME`nCI_COMMIT_SHA:$CI_COMMIT_SHA`nCI_JOB_ID:$CI_JOB_ID" -ItemType file -force
+    - $PREV_GIT_LABEL=(git describe --tags --abbrev=0)
+    - git log "$PREV_GIT_LABEL..HEAD" --oneline --pretty=format:"%C(auto,yellow)%h%C(auto,magenta)% %C(auto,blue)%>(12,trunc)%ad %C(auto,green)%<(25,trunc)%aN%C(auto,reset)%s%C(auto,red)% gD% D" --date=short > "install-x86/share/$CI_PROJECT_NAME.log"
   when: always
+  except:
+  - tags
   tags:
     - windows
 
@@ -72,7 +82,11 @@ windows-builder-x64:
     - mingw32-make
     - mingw32-make install
     - New-Item -path "install-x64/share/" -Name "$CI_PROJECT_NAME" -Value "CI_PROJECT_NAME:$CI_PROJECT_NAME`nCI_COMMIT_REF_NAME:$CI_COMMIT_REF_NAME`nCI_COMMIT_SHA:$CI_COMMIT_SHA`nCI_JOB_ID:$CI_JOB_ID" -ItemType file -force
+    - $PREV_GIT_LABEL=(git describe --tags --abbrev=0)
+    - git log "$PREV_GIT_LABEL..HEAD" --oneline --pretty=format:"%C(auto,yellow)%h%C(auto,magenta)% %C(auto,blue)%>(12,trunc)%ad %C(auto,green)%<(25,trunc)%aN%C(auto,reset)%s%C(auto,red)% gD% D" --date=short > "install-x64/share/$CI_PROJECT_NAME.log"
   when: always
+  except:
+  - tags
   tags:
     - windows
 
@@ -82,5 +96,7 @@ trigger-pipeline:
     - "curl -X POST -F token=$LIBOPENSHOT_PIPELINE_TOKEN -F ref=$CI_COMMIT_REF_NAME http://gitlab.openshot.org/api/v4/projects/1/trigger/pipeline"
   when: always
   dependencies: []
+  except:
+  - tags
   tags:
     - linux

INSTALL.md

@@ -0,0 +1,69 @@
+## Detailed Install Instructions
+
+Operating system specific install instructions are located in:
+
+* doc/INSTALL-LINUX.md
+* doc/INSTALL-MAC.md
+* doc/INSTALL-WINDOWS.md
+
+## Getting Started
+
+The best way to get started with libopenshot-audio, is to learn about our build system, obtain all the source code, 
+install a development IDE and tools, and better understand our dependencies. So, please read through the 
+following sections, and follow the instructions. And keep in mind, that your computer is likely different 
+than the one used when writing these instructions. Your file paths and versions of applications might be 
+slightly different, so keep an eye out for subtle file path differences in the commands you type.
+
+## Build Tools
+
+CMake is the backbone of our build system.  It is a cross-platform build system, which checks for dependencies, 
+locates header files and libraries, generates makefiles, and supports the cross-platform compiling of 
+libopenshot and libopenshot-audio.  CMake uses an out-of-source build concept, where all temporary build 
+files, such as makefiles, object files, and even the final binaries, are created outside of the source 
+code folder, inside a /build/ sub-folder.  This prevents the build process from cluttering up the source 
+code.  These instructions have only been tested with the GNU compiler (including MSYS2/MinGW for Windows).
+
+## Dependencies
+
+The following libraries are required to build libopenshot-audio.  Instructions on how to install these 
+dependencies vary for each operating system.  Libraries and Executables have been labeled in the 
+list below to help distinguish between them.
+
+* ### CMake (cmake)
+  * http://www.cmake.org/ `(Executable)`
+  * This executable is used to automate the generation of Makefiles, check for dependencies, and is the backbone of libopenshot-audio’s cross-platform build process.
+
+* ### Doxygen (doxygen)
+  * http://www.stack.nl/~dimitri/doxygen/ `(Executable)`
+  * This executable is used to auto-generate the documentation used by libopenshot-audio.
+
+* ### OpenMP (-fopenmp)
+  * http://openmp.org/wp/ `(Compiler Flag)`
+  * If your compiler supports this flag (GCC, Clang, and most other compilers), it provides libopenshot-audio with easy methods of using parallel programming techniques to improve performance and take advantage of multi-core processors.
+
+## Obtaining Source Code
+
+The first step in installing libopenshot-audio is to obtain the most recent source code. The source code is available on [GitHub](https://github.com/OpenShot/libopenshot-audio). Use the following command to obtain the latest libopenshot-audio source code.
+
+```
+git clone https://github.com/OpenShot/libopenshot-audio.git
+```
+
+## Linux Build Instructions (libopenshot-audio)
+To compile libopenshot-audio, we need to go through a few additional steps to manually build and install it. Launch a terminal and enter:
+
+```
+cd [libopenshot-audio repo folder]
+mkdir build
+cd build
+cmake ../
+make
+make install
+./src/openshot-audio-test-sound  (This should play a test sound)
+```
+
+For more detailed instructions, please see:
+
+* doc/INSTALL-LINUX.md
+* doc/INSTALL-MAC.md
+* doc/INSTALL-WINDOWS.md

README.md

@@ -0,0 +1,67 @@
+OpenShot Audio Library (libopenshot-openshot) is a free, open-source C++ library dedicated to
+delivering high quality audio editing and audio playback solutions to the world.
+
+## Build Status
+
+[![Build Status](https://img.shields.io/travis/OpenShot/libopenshot-audio/develop.svg?label=libopenshot-audio)](https://travis-ci.org/OpenShot/libopenshot-audio)
+
+## Features
+
+* Cross-Platform (Linux, Mac, and Windows)
+* Audio Playback
+* Audio Mixing & Resampling
+* Audio Plug-ins (VST & AU)
+* Audio Drivers (ASIO, WASAPI, DirectSound, CoreAudio, iPhone Audio, ALSA, JACK, and Android)
+
+## Install
+
+Detailed instructions for building libopenshot and libopenshot-audio for each OS. These instructions
+are also available in the /docs/ source folder.
+
+   * [Linux](https://github.com/OpenShot/libopenshot/wiki/Linux-Build-Instructions)
+   * [Mac](https://github.com/OpenShot/libopenshot/wiki/Mac-Build-Instructions)
+   * [Windows](https://github.com/OpenShot/libopenshot/wiki/Windows-Build-Instructions)
+
+## Developers
+
+Are you interested in becoming more involved in the development of 
+OpenShot? Build exciting new features, fix bugs, make friends, and become a hero! 
+Please read the [step-by-step](https://github.com/OpenShot/openshot-qt/wiki/Become-a-Developer) 
+instructions for getting source code, configuring dependencies, and building OpenShot.
+
+## Report a bug
+
+You can report a new libopenshot-audio issue directly on GitHub:
+
+https://github.com/OpenShot/libopenshot-audio/issues
+
+## Websites
+
+- https://www.openshot.org/  (Official website and blog)
+- https://github.com/OpenShot/libopenshot-audio/ (source code and issue tracker)
+- https://github.com/OpenShot/libopenshot/ (source code for video library)
+- https://github.com/OpenShot/openshot-qt/ (source code for Qt client)
+- https://launchpad.net/openshot/
+
+### License
+
+Copyright (c) 2008-2019 OpenShot Studios, LLC.
+
+Copyright 2004-2014 by Raw Material Software Ltd.
+
+OpenShot Audio Library (libopenshot-audio) is free software: you can redistribute it
+and/or modify it under the terms of the GNU Lesser General Public License
+as published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+OpenShot Audio Library (libopenshot-audio) is distributed in the hope that it will be
+useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with OpenShot Audio Library. If not, see http://www.gnu.org/licenses/.
+
+To release a closed-source product which uses libopenshot-audio (i.e. audio
+editing and playback), commercial licenses are also available: contact
+[email protected] for more information.