Skip to content

Commit

Permalink
Update 0.11 (#43)
Browse files Browse the repository at this point in the history 
Update for version 0.11
  • Loading branch information
@alatdneg
alatdneg authored Jul 18, 2023
1 parent d07a8c1 commit 0eb42ce
Show file tree
Hide file tree
Showing 544 changed files with 40,669 additions and 11,312 deletions.
4 changes: 2 additions & 2 deletions CMakeLists.txt
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
cmake_minimum_required(VERSION 3.12 FATAL_ERROR)

set(XSTUDIO_GLOBAL_VERSION "0.10.0" CACHE STRING "Version string")
set(XSTUDIO_GLOBAL_VERSION "0.11.0" CACHE STRING "Version string")
set(XSTUDIO_GLOBAL_NAME xStudio)

project(${XSTUDIO_GLOBAL_NAME} VERSION ${XSTUDIO_GLOBAL_VERSION} LANGUAGES CXX)
Expand All @@ -13,6 +13,7 @@ option(ENABLE_CLANG_TIDY "Enable clang-tidy, ninja clang-tidy." OFF)
option(ENABLE_CLANG_FORMAT "Enable clang format, ninja clangformat." OFF)
option(FORCE_COLORED_OUTPUT "Always produce ANSI-colored output (GNU/Clang only)." TRUE)
option(OPTIMIZE_FOR_NATIVE "Build with -march=native" OFF)
option(BUILD_RESKIN "Build xstudio reskin binary" ON)

list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules")

Expand Down Expand Up @@ -154,7 +155,6 @@ if(INSTALL_XSTUDIO)
add_subdirectory(docs)
else()
install(DIRECTORY share/docs/ DESTINATION share/xstudio/docs)
add_subdirectory(share/docs)
endif ()

endif ()
Expand Down
25 changes: 17 additions & 8 deletions docs/build_guides/centos_7.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
sudo yum install -y alsa-lib-devel pulseaudio-libs-devel freeglut-devel
sudo yum install -y python3-devel bzip2-devel freetype-devel zlib-devel
sudo yum install -y libuuid-devel
pip3 install --user pytest opentimelineio

#### Qt 5.15
Install 5.15 dev tools, using Qt5 online installer, requires login account (free).
Expand Down Expand Up @@ -44,15 +43,14 @@ Install 5.15 dev tools, using Qt5 online installer, requires login account (free
cd -

#### NLOHMANN JSON
wget https://github.com/nlohmann/json/archive/refs/tags/v3.7.3.tar.gz
tar -xf v3.7.3.tar.gz
cd json-3.7.3
mkdir build
cd build
wget https://github.com/nlohmann/json/archive/refs/tags/v3.11.2.tar.gz
tar -xf v3.11.2.tar.gz
mkdir json-3.11.2/build
cd json-3.7.3/build
cmake .. -DJSON_BuildTests=Off
make -j $JOBS
sudo make install
cd ../..
sudo make install
cd -


#### PYBIND11
Expand Down Expand Up @@ -131,6 +129,17 @@ Install 5.15 dev tools, using Qt5 online installer, requires login account (free
cd -


#### OpenTimelineIO
git clone https://github.com/AcademySoftwareFoundation/OpenTimelineIO.git
cd OpenTimelineIO
git checkout cxx17
mkdir build
cd build
cmake -DOTIO_PYTHON_INSTALL=ON -DOTIO_DEPENDENCIES_INSTALL=OFF -DOTIO_FIND_IMATH=ON ..
make -j $JOBS
sudo make install
cd ../..


#### FFMPEG AND DEPS

Expand Down
21 changes: 17 additions & 4 deletions docs/build_guides/rocky_linux_9_1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
sudo dnf install doxygen python3-sphinx
sudo dnf install opus-devel libvpx-devel openjpeg2-devel lame-devel
sudo dnf install qt5 qt5-devel
pip install --user sphinx_rtd_theme breathe opentimelineio
pip install --user sphinx_rtd_theme breathe


### Local installs
Expand All @@ -25,9 +25,9 @@


#### NLOHMANN JSON
wget https://github.com/nlohmann/json/archive/refs/tags/v3.7.3.tar.gz
tar -xf v3.7.3.tar.gz
mkdir json-3.7.3/build
wget https://github.com/nlohmann/json/archive/refs/tags/v3.11.2.tar.gz
tar -xf v3.11.2.tar.gz
mkdir json-3.11.2/build
cd json-3.7.3/build
cmake .. -DJSON_BuildTests=Off
make -j $JOBS
Expand Down Expand Up @@ -92,6 +92,19 @@
sudo make install
cd ../..


#### OpenTimelineIO
git clone https://github.com/AcademySoftwareFoundation/OpenTimelineIO.git
cd OpenTimelineIO
git checkout cxx17
mkdir build
cd build
cmake -DOTIO_PYTHON_INSTALL=ON -DOTIO_DEPENDENCIES_INSTALL=OFF -DOTIO_FIND_IMATH=ON ..
make -j $JOBS
sudo make install
cd ../..


#### FFMPEG AND DEPS

##### NASM
Expand Down
26 changes: 14 additions & 12 deletions docs/build_guides/ubuntu_22_04.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,12 @@
sudo apt install python-is-python3 pybind11-dev libpython3-dev
sudo apt install libspdlog-dev libfmt-dev libssl-dev zlib1g-dev libasound2-dev nlohmann-json3-dev uuid-dev
sudo apt install libglu1-mesa-dev freeglut3-dev mesa-common-dev libglew-dev libfreetype-dev
sudo apt install libjpeg-dev libpulse-dev
sudo apt install libjpeg-dev libpulse-dev nlohmann-json3-dev
sudo apt install yasm nasm libfdk-aac-dev libfdk-aac2 libmp3lame-dev libopus-dev libvpx-dev libx265-dev libx264-dev
sudo apt install qttools5-dev qtbase5-dev qt5-qmake qtdeclarative5-dev qtquickcontrols2-5-dev
sudo apt install qml-module-qtquick* qml-module-qt-labs-*

pip install sphinx_rtd_theme
pip install opentimelineio


### Local installs
Expand All @@ -40,28 +39,30 @@
cd ../..


#### OCIO2
wget https://github.com/AcademySoftwareFoundation/OpenColorIO/archive/refs/tags/v2.2.0.tar.gz
tar -xf v2.2.0.tar.gz
cd OpenColorIO-2.2.0/
#### OpenTimelineIO
git clone https://github.com/AcademySoftwareFoundation/OpenTimelineIO.git
cd OpenTimelineIO
git checkout cxx17
mkdir build
cd build
cmake -DOCIO_BUILD_APPS=OFF -DOCIO_BUILD_TESTS=OFF -DOCIO_BUILD_GPU_TESTS=OFF ../
cmake -DOTIO_PYTHON_INSTALL=ON -DOTIO_DEPENDENCIES_INSTALL=OFF -DOTIO_FIND_IMATH=ON ..
make -j $JOBS
sudo make install
cd ../..

#### NLOHMANN JSON
wget https://github.com/nlohmann/json/archive/refs/tags/v3.7.3.tar.gz
tar -xf v3.7.3.tar.gz
cd json-3.7.3

#### OCIO2
wget https://github.com/AcademySoftwareFoundation/OpenColorIO/archive/refs/tags/v2.2.0.tar.gz
tar -xf v2.2.0.tar.gz
cd OpenColorIO-2.2.0/
mkdir build
cd build
cmake .. -DJSON_BuildTests=Off
cmake -DOCIO_BUILD_APPS=OFF -DOCIO_BUILD_TESTS=OFF -DOCIO_BUILD_GPU_TESTS=OFF ../
make -j $JOBS
sudo make install
cd ../..


#### FFMPEG
wget https://ffmpeg.org/releases/ffmpeg-5.1.tar.bz2
tar -xf ffmpeg-5.1.tar.bz2
Expand All @@ -72,6 +73,7 @@
sudo make install
cd -


### xStudio
export PKG_CONFIG_PATH=/usr/local/lib64/pkgconfig:/usr/local/lib64/pkgconfig
cd xstudio
Expand Down
120 changes: 120 additions & 0 deletions docs/user_docs/getting_started/hotkeys.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
.. _hotkeys
Hotkeys
=======

.. note:: Hotkeys will be fully user-configurable in future releases.

+------------------------------------+----------------------------------------------------------------------------+
| **Playback** |
+------------------------------------+----------------------------------------------------------------------------+
| ``j,k,l`` | | Play backwards, Pause, Play forwards |
| | | Press ``j`` or ``l`` multiple times to increase the playback rate |
+------------------------------------+----------------------------------------------------------------------------+
| ``Spacebar`` | Play/Pause toggle |
+------------------------------------+----------------------------------------------------------------------------+
| ``Arrow left``, ``Arrow right`` | Previous Frame, Next Frame |
+------------------------------------+----------------------------------------------------------------------------+
| ``,``, ``.`` | Previous / Next Note or Annotation |
+------------------------------------+----------------------------------------------------------------------------+
| ``Arrow up``, ``Arrow down`` | Previous / Next Media Item |
+------------------------------------+----------------------------------------------------------------------------+
| ``i``, ``o`` | Set Loop In & Point |
+------------------------------------+----------------------------------------------------------------------------+
| ``p`` | Enable / Disable loop range |
+------------------------------------+----------------------------------------------------------------------------+
| ``Home`` | Jump to start of range. |
+------------------------------------+----------------------------------------------------------------------------+
| ``End`` | Jump to end of range. |
+------------------------------------+----------------------------------------------------------------------------+
| ``Shift + P`` | Set Loop In/Out Points to match 'cut range' for shot. |
+------------------------------------+----------------------------------------------------------------------------+
| ``Ctrl + P`` | Set Loop In/Out Points to match 'comp range' for shot. |
+------------------------------------+----------------------------------------------------------------------------+
| **Viewer Controls** |
+------------------------------------+----------------------------------------------------------------------------+
| ``Hold z`` | | Zoom mode. Click and drag image to zoom around the cursor |
+------------------------------------+----------------------------------------------------------------------------+
| ``Hold x`` | | Pan mode. Click and drag image to pan around the image |
+------------------------------------+----------------------------------------------------------------------------+
| ``Hold e`` | | Exposure mode. Click and drag image to adjust the exposure |
| | | Double click while holding ``e`` to toggle Exposure Adjustment on or off |
+------------------------------------+----------------------------------------------------------------------------+
| ``f`` | Toggle Fit mode |
| | Toggles between the last 2 Fit modes |
+------------------------------------+----------------------------------------------------------------------------+
| ``Ctrl + r`` | | Reset Viewer |
| | | Resets the Fit Mode, Channel Selection and Exposure to default values |
+------------------------------------+----------------------------------------------------------------------------+
|| ``r`` || Toggle Red Channel/RGB |
|| ``g`` || Toggle Green Channel/RGB |
|| ``b`` || Toggle Blue Channel/RGB |
|| ``a`` || Toggle Alpha Channel/RGB |
|| ``Ctrl + l`` || Toggle Luminence Channel/RGB |
|| ``c`` || Display RGB Channels |
+------------------------------------+----------------------------------------------------------------------------+
| ``1, 2, 3,...,9`` | Change which media item to view in A/B compare mode |
+------------------------------------+----------------------------------------------------------------------------+
| **User Interface** |
+------------------------------------+----------------------------------------------------------------------------+
| ``Tab`` | Toggle Presentation Mode |
+------------------------------------+----------------------------------------------------------------------------+
| ``Ctrl + f`` | Toggle Full-Screen Mode |
+------------------------------------+----------------------------------------------------------------------------+
| ``Ctrl + h`` | Toggle Viewer UI Visibility |
+------------------------------------+----------------------------------------------------------------------------+
| ``Ctrl + p`` | Launch the pop-out (2nd) viewer window |
+------------------------------------+----------------------------------------------------------------------------+
| ``f`` | Toggle Fit Mode |
+------------------------------------+----------------------------------------------------------------------------+
| ``d`` | Open Drawing Tools Window |
+------------------------------------+----------------------------------------------------------------------------+
| ``n`` | Open Notes Window |
+------------------------------------+----------------------------------------------------------------------------+
| ``Escape`` | Show UI -> exit presentation mode -> exit full screen |
+------------------------------------+----------------------------------------------------------------------------+
| **Session Controls** |
+------------------------------------+----------------------------------------------------------------------------+
| ``Ctrl + s`` | Save session |
+------------------------------------+----------------------------------------------------------------------------+
| ``Ctrl + Shift + s`` | Save session as... |
+------------------------------------+----------------------------------------------------------------------------+
| ``Ctrl + q`` | Close session |
+------------------------------------+----------------------------------------------------------------------------+
| ``Ctrl + \`` | Open about dialogue |
+------------------------------------+----------------------------------------------------------------------------+
| ``F1`` | Open user docs |
+------------------------------------+----------------------------------------------------------------------------+
| **Playlist Controls** |
+------------------------------------+----------------------------------------------------------------------------+
| ``Shift + p`` | Make a new playlist |
+------------------------------------+----------------------------------------------------------------------------+
| ``Shift + d`` | Make a new divider in the Session Pane |
+------------------------------------+----------------------------------------------------------------------------+
| ``Ctrl + a`` | Selected all media items in the current playlist |
+------------------------------------+----------------------------------------------------------------------------+
| ``Ctrl + d`` | Clear current selection |
+------------------------------------+----------------------------------------------------------------------------+
| **Media List** |
+------------------------------------+----------------------------------------------------------------------------+
| ``Ctrl 1, 2, 3,...0`` | Set selected media flag |
+------------------------------------+----------------------------------------------------------------------------+
| ``Ctrl + D`` | Clear selected media |
+------------------------------------+----------------------------------------------------------------------------+
| ``Ctrl + A`` | Select all media |
+------------------------------------+----------------------------------------------------------------------------+
| ``Del BSpace`` | Remove selected media |
+------------------------------------+----------------------------------------------------------------------------+
| **Notes** |
+------------------------------------+----------------------------------------------------------------------------+
| ``n`` | Show/Hide Notes Window |
+------------------------------------+----------------------------------------------------------------------------+
| ``;`` | Add Note |
+------------------------------------+----------------------------------------------------------------------------+
| ``:`` | Add Note And Open Notes Window |
+------------------------------------+----------------------------------------------------------------------------+
| ``'`` | Set Note Out-Point |
+------------------------------------+----------------------------------------------------------------------------+
| ``Shift + L`` | Set Loop In/Out Points From Note Duration |
+------------------------------------+----------------------------------------------------------------------------+

Loading

0 comments on commit 0eb42ce

Please sign in to comment.