Merge pull request #3161 from OpenShot/release-20200105

Release of openshot-qt 2.5.0 (min libopenshot version: 0.2.4)

Author: jonoomph

.editorconfig

@@ -0,0 +1,14 @@
+root = true
+[*]
+insert_final_newline = true
+end_of_line = 'lf'
+[*.py]
+charset = 'utf8'
+trim_trailing_whitespace = true
+indent_style = 'space'
+indent_size = 4
+[*.js]
+charset = 'utf8'
+trim_trailing_whitespace = true
+indent_style = 'space'
+indent_size = 2

.github/ISSUE_TEMPLATE/bug-report.md

@@ -2,7 +2,7 @@
 name: Bug Report
 about: Create a bug report for a new issue
 title: Give your bug report a descriptive title
-labels: bug
+labels: ':beetle: bug'
 assignees: ''
 
 ---

.github/ISSUE_TEMPLATE/feature-request.md

@@ -2,7 +2,7 @@
 name: Feature Request
 about: Suggest a new idea to improve OpenShot
 title: Give your feature request a descriptive title
-labels: enhancement
+labels: '💡 enhancement'
 assignees: ''
 
 ---

.gitlab-ci.yml

@@ -9,6 +9,7 @@ linux-builder:
     - build/*.AppImage
     - build/*.torrent
     - build/install-x64/share/
+    - build/build-server.log
   script:
     - "curl -O -J -L --header PRIVATE-TOKEN:$ACCESS_TOKEN http://gitlab.openshot.org/OpenShot/libopenshot/-/jobs/artifacts/$CI_COMMIT_REF_NAME/download?job=linux-builder"
     - if [ ! -f artifacts.zip ]; then
@@ -18,7 +19,7 @@ linux-builder:
     - cp -r "$CI_PROJECT_DIR/build/install-x64/python/." "$CI_PROJECT_DIR"
     - export LD_LIBRARY_PATH=$CI_PROJECT_DIR/build/install-x64/lib:$LD_LIBRARY_PATH
     - 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" > "build/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 > "build/install-x64/share/$CI_PROJECT_NAME.log"
+    - git log $(git describe --tags --abbrev=0 @^)..@ --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 > "build/install-x64/share/$CI_PROJECT_NAME.log"
     - python3 freeze.py build
     - python3 installer/build-server.py "$SLACK_TOKEN" "$S3_ACCESS_KEY" "$S3_SECRET_KEY" "$WINDOWS_KEY" "$WINDOWS_PASSWORD" "$GITHUB_USER" "$GITHUB_PASS" "False" "$CI_COMMIT_REF_NAME"
   when: always
@@ -35,6 +36,7 @@ mac-builder:
     - build/*.dmg
     - build/*.torrent
     - build/install-x64/share/
+    - build/build-server.log
   script:
     - "curl -O -J -L --header PRIVATE-TOKEN:$ACCESS_TOKEN http://gitlab.openshot.org/OpenShot/libopenshot/-/jobs/artifacts/$CI_COMMIT_REF_NAME/download?job=mac-builder"
     - if [ ! -f artifacts.zip ]; then
@@ -57,7 +59,7 @@ mac-builder:
     - export LD_LIBRARY_PATH=$CI_PROJECT_DIR/build/install-x64/lib:$LD_LIBRARY_PATH
     - export DYLD_LIBRARY_PATH=$CI_PROJECT_DIR/build/install-x64/lib:DYLD_LIBRARY_PATH
     - 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" > "build/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 > "build/install-x64/share/$CI_PROJECT_NAME.log"
+    - git log $(git describe --tags --abbrev=0 @^)..@ --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 > "build/install-x64/share/$CI_PROJECT_NAME.log"
     - /Library/Frameworks/Python.Framework/Versions/3.6/bin/python3.6 freeze.py bdist_mac --iconfile=installer/openshot.icns --custom-info-plist=installer/Info.plist --bundle-name="OpenShot Video Editor"
     - /Library/Frameworks/Python.Framework/Versions/3.6/bin/python3.6 installer/build-server.py "$SLACK_TOKEN" "$S3_ACCESS_KEY" "$S3_SECRET_KEY" "$WINDOWS_KEY" "$WINDOWS_PASSWORD" "$GITHUB_USER" "$GITHUB_PASS" "False" "$CI_COMMIT_REF_NAME"
   when: always
@@ -74,15 +76,17 @@ windows-builder-x64:
     - build\*.exe
     - build\*.torrent
     - build\install-x64\share\
+    - build\build-server.log
   script:
     - try { Invoke-WebRequest -Uri "http://gitlab.openshot.org/OpenShot/libopenshot/-/jobs/artifacts/$CI_COMMIT_REF_NAME/download?job=windows-builder-x64" -Headers @{"PRIVATE-TOKEN"="$ACCESS_TOKEN"} -OutFile "artifacts.zip" } catch { $_.Exception.Response.StatusCode.Value__ }
     - if (-not (Test-Path "artifacts.zip")) { Invoke-WebRequest -Uri "http://gitlab.openshot.org/OpenShot/libopenshot/-/jobs/artifacts/develop/download?job=windows-builder-x64" -Headers @{"PRIVATE-TOKEN"="$ACCESS_TOKEN"} -OutFile "artifacts.zip" }
     - Expand-Archive -Path artifacts.zip -DestinationPath .
     - Copy-Item "$CI_PROJECT_DIR/build/install-x64/python/*" -Destination "$CI_PROJECT_DIR"
-    - $env:Path = "$CI_PROJECT_DIR\build\install-x64\lib;C:\msys64\mingw64\bin;C:\msys64\mingw64\lib;C:\msys64\usr\lib\cmake\UnitTest++;C:\msys64\home\jonathan\depot_tools;C:\msys64\usr;C:\msys64\usr\lib;" + $env:Path;
+    - $env:Path = "$CI_PROJECT_DIR\build\install-x64\lib;$CI_PROJECT_DIR\build\install-x64\lib\python3.7\site-packages\;C:\msys64\mingw64\bin;C:\msys64\mingw64\lib;C:\msys64\mingw64\lib\python3.7\;C:\msys64\mingw64\lib\python3.7\site-packages\;C:\msys64\mingw64\lib\python3.7\site-packages\PyQt5;C:\msys64\usr\lib\cmake\UnitTest++;C:\msys64\usr;C:\msys64\usr\lib;" + $env:Path;
+    - $env:PYTHONPATH = "$CI_PROJECT_DIR\build\install-x64\lib\python3.7\site-packages\;C:\msys64\usr\lib;C:\msys64\usr\lib\site-packages\;C:\msys64\mingw64\lib\python3.7\;C:\msys64\mingw64\lib\python3.7\site-packages\;C:\msys64\mingw64\lib\python3.7\site-packages\PyQt5;";
     - New-Item -path "build/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 > "build/install-x64/share/$CI_PROJECT_NAME.log"
+    - $PREV_GIT_LABEL=(git describe --tags --abbrev=0 '@^')
+    - git log "$PREV_GIT_LABEL..@" --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 > "build/install-x64/share/$CI_PROJECT_NAME.log"
     - python3 freeze.py build
     - python3 installer/build-server.py "$SLACK_TOKEN" "$S3_ACCESS_KEY" "$S3_SECRET_KEY" "$WINDOWS_KEY" "$WINDOWS_PASSWORD" "$GITHUB_USER" "$GITHUB_PASS" "False" "$CI_COMMIT_REF_NAME"
   when: always
@@ -99,17 +103,19 @@ windows-builder-x86:
     - build\*.exe
     - build\*.torrent
     - build\install-x86\share\
+    - build\build-server.log
   script:
     - try { Invoke-WebRequest -Uri "http://gitlab.openshot.org/OpenShot/libopenshot/-/jobs/artifacts/$CI_COMMIT_REF_NAME/download?job=windows-builder-x86" -Headers @{"PRIVATE-TOKEN"="$ACCESS_TOKEN"} -OutFile "artifacts.zip" } catch { $_.Exception.Response.StatusCode.Value__ }
     - if (-not (Test-Path "artifacts.zip")) { Invoke-WebRequest -Uri "http://gitlab.openshot.org/OpenShot/libopenshot/-/jobs/artifacts/develop/download?job=windows-builder-x86" -Headers @{"PRIVATE-TOKEN"="$ACCESS_TOKEN"} -OutFile "artifacts.zip" }
     - Expand-Archive -Path artifacts.zip -DestinationPath .
     - Copy-Item "$CI_PROJECT_DIR/build/install-x86/python/*" -Destination "$CI_PROJECT_DIR"
-    - $env:Path = "$CI_PROJECT_DIR\build\install-x86\lib;C:\msys32\mingw32\bin;C:\msys32\mingw32\lib;C:\msys32\usr\lib\cmake\UnitTest++;C:\msys32\home\jonathan\depot_tools;C:\msys32\usr;C:\msys32\usr\lib;" + $env:Path;
+    - $env:Path = "$CI_PROJECT_DIR\build\install-x86\lib;$CI_PROJECT_DIR\build\install-x86\lib\python3.7\site-packages\;C:\msys32\mingw32\bin;C:\msys32\mingw32\lib;C:\msys32\mingw32\lib\python3.7\;C:\msys32\mingw32\lib\python3.7\site-packages\;C:\msys32\mingw32\lib\python3.7\site-packages\PyQt5;C:\msys32\usr\lib\cmake\UnitTest++;C:\msys32\usr;C:\msys32\usr\lib;" + $env:Path;
+    - $env:PYTHONPATH = "$CI_PROJECT_DIR\build\install-x86\lib\python3.7\site-packages\;C:\msys32\usr\lib;C:\msys32\usr\lib\site-packages\;C:\msys32\mingw32\lib\python3.7\;C:\msys32\mingw32\lib\python3.7\site-packages\;C:\msys32\mingw32\lib\python3.7\site-packages\PyQt5;";
     - New-Item -path "build/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 > "build/install-x86/share/$CI_PROJECT_NAME.log"
+    - $PREV_GIT_LABEL=(git describe --tags --abbrev=0 '@^')
+    - git log "$PREV_GIT_LABEL..@" --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 > "build/install-x86/share/$CI_PROJECT_NAME.log"
     - python3 freeze.py build
-    - editbin /LARGEADDRESSAWARE "$CI_PROJECT_DIR\build\exe.mingw-3.6\launch.exe"
+    - editbin /LARGEADDRESSAWARE "$CI_PROJECT_DIR\build\exe.mingw-3.7\openshot-qt.exe"
     - python3 installer/build-server.py "$SLACK_TOKEN" "$S3_ACCESS_KEY" "$S3_SECRET_KEY" "$WINDOWS_KEY" "$WINDOWS_PASSWORD" "$GITHUB_USER" "$GITHUB_PASS" "True" "$CI_COMMIT_REF_NAME"
   when: always
   except:

.travis.yml

@@ -1,5 +1,6 @@
 language: cpp
-dist: trusty
+dist: xenial
+sudo: required
 
 before_install:
   - sudo add-apt-repository ppa:openshot.developers/libopenshot-daily -y

AUTHORS

@@ -2,7 +2,7 @@ OpenShot 2.0 is the result of work by (in no particular order):
 
 Contributors / Developers:
 
-See src/settings/contributors.json for details on contributors and
+See src/resources/contributors.json for details on contributors and
 developer credits.
 
 
@@ -27,7 +27,7 @@ Canonical / Ubuntu (Ubuntu-R.ttf font)
 Supporters
 
 A big thanks to all the financial backers and supporters from PayPay,
-Kickstarter, and Patreon! Details can be found in src/settings/supporters.json
+Kickstarter, and Patreon! Details can be found in src/resources/supporters.json
 
 
 For the full list of developers and technical contributors, please visit:

CONTRIBUTING.md

@@ -15,10 +15,10 @@
   2. Then enable 'Debug Mode (Verbose)' in the Preferences
   3. Quit OpenShot and delete both log files:
       * **Windows**: OpenShot stores its logs in your user profile directory (`%USERPROFILE%`, e.g. `C:\Users\username\`)
-        * **`%USERPROFILE%/.openshot_qt/openshot_qt.log`**
+        * **`%USERPROFILE%/.openshot_qt/openshot-qt.log`**
         * **`%USERPROFILE%/.openshot_qt/libopenshot.log`**
       * **Linux/MacOS**: OpenShot stores its logs in your home directory (`$HOME`, e.g. `/home/username/`)
-        * **`$HOME/.openshot_qt/openshot_qt.log`**
+        * **`$HOME/.openshot_qt/openshot-qt.log`**
         * **`$HOME/.openshot_qt/libopenshot.log`**
   4. Re-launch OpenShot and trigger the crash as quickly as possible (to keep the log files small)
   5. Attach **both** log files

README.md

@@ -26,6 +26,9 @@ video editing and animation solutions to the world.
 * Time-mapping and speed changes on clips (slow/fast, forward/backward, etc...)
 * Audio mixing and editing
 * Digital video effects, including brightness, gamma, hue, greyscale, chroma key, and many more!
+* Experimental hardware encoding and decoding (VA-API, NVDEC, D3D9, D3D11, VTB)
+* Import & Export widely supported formats (EDL, XML)
+* Render videos in many codecs and formats (based on FFmpeg)
 
 ## Getting Started
 
@@ -51,11 +54,13 @@ instructions for getting source code, configuring dependencies, and building Ope
 
 Beautiful HTML documentation can be generated using Sphinx.
 
-```
+```sh
 cd doc
 make html
 ```
 
+The documentation for the most recent release can be viewed online at [openshot.org/user-guide](https://www.openshot.org/user-guide/).
+
 ## Report a bug
 
 Please report bugs using the official [Report a Bug](https://www.openshot.org/issues/new/) 
@@ -92,12 +97,27 @@ dependencies in order to run OpenShot successfully:
 
 ## Launch
 
-To run OpenShot from the command line, use the following syntax:
+To run OpenShot from the command line with an installed `libopenshot`,
+use the following syntax:
 (be sure the change the path to match the install or repo location 
 of openshot-qt)
 
-    $ cd [openshot-qt folder]
-    $ python3 src/launch.py
+```sh
+cd [openshot-qt folder]
+python3 src/launch.py
+```
+    
+To run with a version of `libopenshot` built from source but not installed,
+set `PYTHONPATH` to the location of the compiled Python bindings. e.g.:
+
+```sh
+cd [libopenshot folder]
+mkdir build; cd build; cmake [options] ..; make
+    
+cd [openshot-qt folder]
+PYTHONPATH=[libopenshot folder]/build/src/bindings/python \
+python3 src/launch.py
+```
 
 ## Websites
 

doc/conf.py

@@ -19,8 +19,9 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.dirname(os.path.abspath('.')))
-from src.classes import info
+sys.path.insert(0, os.path.join(os.path.dirname(os.path.abspath('.')), "src"))
+
+from classes import info
 
 # -- General configuration ------------------------------------------------
 
@@ -31,7 +32,28 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = [
+    'sphinx.ext.extlinks'
+]
+
+try:
+    # Add Copy button to code cells, if extension is available
+    import sphinx_copybutton
+    extensions.append('sphinx_copybutton')
+except ImportError:
+    pass
+
+# External links mappings for extlinks
+# see: http://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html
+extlinks = {
+    # alias: (url_template, prefix)
+    'openshot-github':
+        ('https://github.com/OpenShot/%s', ''),
+    'libopenshot-wiki':
+        ('https://github.com/OpenShot/libopenshot/wiki/%s', ''),
+    'openshot-issue':
+        ('https://github.com/OpenShot/openshot-qt/issues/%s', 'issue ')
+}
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -240,21 +262,21 @@
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-     # The paper size ('letterpaper' or 'a4paper').
-     #
-     # 'papersize': 'letterpaper',
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
 
-     # The font size ('10pt', '11pt' or '12pt').
-     #
-     # 'pointsize': '10pt',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
 
-     # Additional stuff for the LaTeX preamble.
-     #
-     # 'preamble': '',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
 
-     # Latex figure (float) alignment
-     #
-     # 'figure_align': 'htbp',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples

doc/contributing.rst

@@ -25,12 +25,11 @@ Did you find a bug?
 -------------------
 
 -  **Please check if this bug was already reported** by searching on
-   GitHub under
-   `Issues <https://github.com/OpenShot/openshot-qt/issues>`__.
+   GitHub under `Issues`_.
 
--  If you're unable to find an open issue addressing the problem, `open
-   a new one <https://github.com/OpenShot/openshot-qt/issues/new>`__. Be
-   sure to include a **title and clear description**, as much relevant
+-  If you're unable to find an open issue addressing the problem,
+   :openshot-issue:`open a new one <new/choose>`.
+   Be sure to include a **title and clear description**, as much relevant
    information as possible, and the steps to reproduce the crash or
    issue.
 
@@ -39,21 +38,21 @@ Did you find a bug?
 
 Please download our latest daily installer:
 """""""""""""""""""""""""""""""""""""""""""
-1. `www.openshot.org/download <https://www.openshot.org/download>`__ - click the '**DAILY BUILDS**' button, then grab the latest build from the list.
+1. `openshot.org/download <https://www.openshot.org/download>`_ - click the '**DAILY BUILDS**' button, then grab the latest build from the list.
    (Use the buttons below to download installers for a different Operating System.)
 2. Then enable 'Debug Mode (Verbose)' in the Preferences
 3. Quit OpenShot and delete both log files:
 
    -  **Windows**: OpenShot stores its logs in your user profile
       directory (``%USERPROFILE%``, e.g. ``C:\Users\username\``)
 
-      -  ``%USERPROFILE%/.openshot_qt/openshot_qt.log``
+      -  ``%USERPROFILE%/.openshot_qt/openshot-qt.log``
       -  ``%USERPROFILE%/.openshot_qt/libopenshot.log``
 
    -  **Linux/MacOS**: OpenShot stores its logs in your home directory
       (``$HOME``, e.g. ``/home/username/``)
 
-      -  ``$HOME/.openshot_qt/openshot_qt.log``
+      -  ``$HOME/.openshot_qt/openshot-qt.log``
       -  ``$HOME/.openshot_qt/libopenshot.log``
 
 4. Re-launch OpenShot and trigger the crash as quickly as possible (to
@@ -78,3 +77,5 @@ help us fix them!
 Thanks!
 
 OpenShot Team
+
+.. _Issues: https://github.com/OpenShot/openshot-qt/issues/