Music production session manager https://www.laborejo.org
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

483 lines
25KB

  1. :Author: Laborejo Software Suite
  2. :Version: 0.1
  3. :iconfont-remote!:
  4. :!webfonts:
  5. ////
  6. This documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.
  7. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a
  8. letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
  9. A copy of the license has been provided in the file documentation/LICENSE.
  10. ////
  11. ////
  12. https://powerman.name/doc/asciidoc
  13. https://asciidoctor.org/docs/user-manual/
  14. ////
  15. :sectnums:
  16. :toc: left
  17. :toc-title: Table of Contents
  18. :toclevels: 3
  19. = Agordejo
  20. // Don't write in the empty line above line. It will be interpreted as author html tag
  21. For program version 0.1
  22. == Introduction
  23. Agordejo (Esperanto: 'place to set things up') is a music production session manager.
  24. It is used to start your programs, remember their (JACK) interconnections and make your life easier
  25. in general.
  26. You can seamlessly change between two view modes to quickly start a few programs or have complete
  27. control and a detailed overview.
  28. Agordejo does not re-invent the wheel but instead uses the New-Session-Manager daemon and enhances
  29. it with some tricks of its own, that always remain 100% compatible with the original sessions.
  30. This is a proof of concept version. It aims to show that session management with NSM can be quick
  31. and convenient and make the user feel in control. Some functionality has not yet been
  32. implemented, most prominently anything related to NSM over network. There is always the possibility to
  33. break things when trying out corner cases and hacks.
  34. That said, for single-computer sessions with just one daemon and one GUI at the same time Agordejo
  35. should provide a good user experience.
  36. == Preamble
  37. Session Management leads to simplification of workflows, overview and control over
  38. programs and data and a good portion of convenience :)
  39. No program exists on its own, because no program can do everything that is necessary for today's
  40. music production.
  41. This is obvious in a JACK environment, which is fundamentally modular: Different
  42. programs fulfill different functions and "talk" to each other by sending data to each other.
  43. A sequencer sends MIDI to a sampler or synthesizer, which is connected to a plug-in host for effects etc.
  44. Even the most monolithic all-in-one DAWs have to, or want to, eventually connect to the outside
  45. world. For example, to connect to a screen recorder or streaming program, include a word processor
  46. for recording order or lyrics, or to use a function that is simply not available in the DAW.
  47. Much of the work is already done by the JACK subsystem. All programs can share their music in
  48. real time, have synchronized timelines and play in the same tempo.
  49. What remains is the tedious work of always starting all programs, loading project files, connecting
  50. audio channels etc. Session management in general (e.g. specifically written starter script files)
  51. and Agordejo in particular do this work for you, or at the very least, greatly simplify it.
  52. In contrast to the self-written script mentioned above, you don't have to decide in advance on a
  53. setup, but everything is saved automatically as long as you manage everything through Agordejo.
  54. === Example
  55. * Start Agordejo (Start menu, terminal etc.)
  56. * You are now in the "Quick View" to start a session
  57. * Press the big button "Start New Session"
  58. * Now you get a choice of programs:
  59. * A single click with the mouse starts a program
  60. * Another click hides (or subsequently shows) its graphical interface
  61. * If the program crashes you get a warning and can restart it.
  62. * Audio and midi ports can now be connected together in a patchbay. The connections are stored in Agordejo.
  63. * To get more programs and advanced features you can switch to the tab "Full View
  64. * The name of the session so far is simply a date. By clicking on it you can enter a real name. Like "My song"
  65. * If you are finished you can return to the session selection by pressing the button "Save and Close"
  66. * Now Agordejo could be closed itself.
  67. * All stored data is in a single directory on the hard disk (`~/NSM Sessions/My Song`)
  68. * The session can be resumed: After clicking on the name, all programs start automatically and connect their JACK ports to among themselves.
  69. "Quick View" is a good start. However, usually one would like to get into the full view, even if it
  70. is only to start a program twice or to save manually.
  71. == Quick View
  72. The quick view is an environment reduced to the minimum. You, as a user, should have to make as few
  73. decisions as possible and start an old session or create a new one as quickly as possible (with the
  74. at least clicks).
  75. For stability reasons, only programs are shown that are known to
  76. work correctly with Agordejos session management.
  77. The Quick View is only a view. There is no technical difference to the full view and you can switch
  78. back and forth at any time.
  79. === Selecting a Session
  80. There are only two options here: Click on "Start New Session" to do so, or
  81. select one of the existing sessions to resume it (if available).
  82. === In a Session
  83. The name can be changed. We recommend a date in the form YYYY-MM-DD followed by a informative name.
  84. Please note that the name change will only take effect (e.g. renaming the session directory on
  85. disk) when you close the session.
  86. Next, a larger text field is available for notes. Write what you want. TODO lists, lyrics, credits
  87. and sources of external samples etc.
  88. Programs are symbolized by icons. A mouse click starts the program (which can take a while, we have
  89. no influence on that). The status of the program is indicated by a symbol: The "Play" symbol for
  90. the running program, the eye means "program window hidden", the "Power On/Off" symbol means that
  91. the program has been terminated (or crashed).
  92. If the program supports it, a running program window can be hidden. Synthesizers, once set up, do
  93. not have to be permanently visible. Just click on the program icon again. Either nothing happens
  94. (the program does not support it) or the window will hide. Another click on a hidden window shows
  95. it again. Every program itself is responsible for whether it saves its window state. Also, some
  96. programs already start hidden.
  97. There is *no* way to end or remove a program in this view. To do this, switch to the full view or
  98. use the close function of the program itself.
  99. There is also *no* possibility to start a program multiple times, e.g. one synthesizer per
  100. track. If you want to start multiple program instances through the full view times you can still
  101. use the quick view to manage the general session, but it is not defined which program instance a
  102. click on the icon (e.g. to hide) affects. Multiple instances are a clear indicator that you are
  103. ready for the full view.
  104. As you'll eventually discover, not *all* available programs are in the list, and there there is
  105. also no possibility to start programs that would work well in a session (e.g. a tuner), but are not
  106. explicitly written for it, e.g. do not report their status. It is better to manage these programs
  107. in full view.
  108. If, unfortunately, a program has crashed, you can only restart it and hope its automatic saving
  109. worked. Good luck.
  110. == Full View
  111. Some concepts have already been explained in the chapter "Quick View". It is expected that you have
  112. read this.
  113. === Selecting a Session
  114. Sessions are displayed as a table, which you sort by clicking on a column header. Here is shown how
  115. the session is called and when it was saved the last time, probably the two most important pieces
  116. of information. Also shown is how many programs/clients are in the session and whether it contains
  117. symbolic links. The latter is probably set to "Yes" if use a sampler, or similar, that contains
  118. large audio files. These are initially only linked into the session, and not copied, to save disk
  119. space. The displayed disk space usage is not the actual one, but includes the sizes of
  120. symlink-targets. Only when you archive the session or replace the links with real files the number
  121. becomes correct.
  122. Finally, the directory in which the files are actually stored is also given.
  123. Sessions represent the directory tree. A session is always a "leaf" and cannot include subsessions.
  124. When creating or renaming sessions, you can also arrange them in the tree by using the usual slash
  125. notation: `song123` -> `New album/song 123` or `Test/asdf` -> `Romantic pop ballads/My heart will
  126. keep beating`. How to organize your sessions and how many subdirectories you create is up to you.
  127. It is, however, not allowed to start the name with `/` or use the special characters `..`. The
  128. tree view can be deactivated by a checkbox on the left side, e.g. to be able to sort them. This is
  129. just a view, your data remains untouched.
  130. Each session has a context menu (e.g. right mouse button) with further options: You can choose to
  131. rename a session, delete it (including all associated files on the hard disk!) and more. These
  132. functions are equivalent to your file manager. If you like, you can also use your file manager to
  133. rename, move, or delete the session directories themselves (unless they are is currently open). You
  134. don't need to restart Agordejo to do this, it will respond to the changes while running.
  135. There is also the possibility to remove a so-called "lock" file. This is a file which is created
  136. when the session starts and deleted when it ends. This tells Agordejo which session is currently
  137. running. If a lock file exists, the session cannot be opened! This should not happen during normal
  138. operation. But if a power failure or similar occurs in the middle of a session, the lock file may
  139. remain, although obviously no session is opened. In this case, unlock the session manually by
  140. deleting the lock file.
  141. Click on "New session" to create one. In contrast to the quick view, you must enter the name
  142. directly . As mentioned above, you can use the directory tree. In addition, there are several
  143. (almost obligatory) programs suggested to start with. Normally one should accept all suggestions.
  144. There is always the option to remove them later.
  145. A double click on an existing session (or the "Load Selected" button) does just that.
  146. === In a Session
  147. The full view is divided into three areas: Program starter, programs in the current session
  148. and the session notes. There is also a dynamic menu.
  149. On the left side you see the program starter. A double-click starts a program instance in this
  150. session. You can also start a program more than once. For available programs please refer to the
  151. chapter "Program Database".
  152. ==== Running Programs
  153. Started programs are located on the right side. A double-click switches the visibility
  154. to hide its window if the program supports it. If not, nothing happens.
  155. The following information is available per program:
  156. * The name (possibly with icon)
  157. * A "label" that programs can use freely (e.g. Fluajho shows the loaded .sf2 here)
  158. * The program status
  159. * Stopped , not running
  160. * Ready, running
  161. * Launch, If the status halts here but the programs works, it is one that does not specifically support session mode. Agordejo cannot know if it is already running or not. Everything is fine! :)
  162. * Other states are only transitions and usually only visible for a very short time, e.g. Open / Loading
  163. * Visibility (A cross for visible, blank for invisible)
  164. * Changes - Are there currently unsaved changes?
  165. * ID - A unique identifier that can be used to distinguish between multiple instances of the same program
  166. All other functions are accessible via the menu or context menu. One click on a program selects it,
  167. and the client menu in the menu bar will now apply to the client. Alternatively, you can
  168. right-click on an entry for a context menu, which is identical to the menu.
  169. In addition to self-explanatory functions there are also:
  170. * Rename gives the program a self-chosen name, mostly to make its purpose clear and to distinguish it better from others. This feature is only available when 'nsm-data' is running in the session.
  171. * Save only tells this program to save
  172. * Remove takes the program out of the session. However, no files are deleted in the process. At the moment you have to "clean up" in your file manager by hand.
  173. If the client "nsm-data" is in the session (this is the default setting) the lower area provides a
  174. large text field for notes. It is the same as in the quick view. Write what you want: TODO lists,
  175. lyrics, credits and sources from external Samples etc.
  176. ==== The Session Menu
  177. In contrast to the quick view, full mode offers menus, which can also be accessed via the usual keyboard shortcuts (Ctrl+S for saving etc.).
  178. * Save instructs all programs to save, the session continues to run
  179. * Save and Close ends the session, after all programs saved
  180. * Abort ends the session without saving the programs
  181. * Save As saves the session under a different name and closes the current session without saving. From now on you work under the new name.
  182. * Add Client offers the option to add any program, whether it is in the program database or not.
  183. * Any installed programs are suggested. Agordejo doesn't check them for usefulness for a music session, or even for runnability. You will find `ls` here as well as `agordejo` itself.
  184. == Program-Database
  185. Agordejos launcher is based on a program database, which is partly self-generated, partly
  186. maintained by hand. As in a start menu Agordejo will offer you only programs that are actually
  187. installed on your system.
  188. The database is created at the first start. Depending on your system, this can take some moments to
  189. a few minutes.
  190. If you are reinstalling or uninstalling audio programs, you will need to update the database via
  191. the command in the control menu. Program installations and system changes are even possible while
  192. Agordejo is running (even in a session). After a DB update you can immediately access all new
  193. programs.
  194. If you do not see an installed program in our launcher, but you are sure that it supports session
  195. management please report it to info@laborejo.org or under https://laborejo.org/bugs .
  196. In addition, you can add (in full view) programs that are not in the database.
  197. === For advanced users
  198. The strict rule is that only programs in the $PATH are included in the database. Absolutel paths
  199. are not allowed, even if you enter the program name yourself through the menu. However sometimes
  200. you just want to try out software, or you are a developer yourself and want to test without
  201. system-wide installation.
  202. In the control menu / settings is a tab "Program-PATH", where you can define and add your own
  203. search paths. One absolute directory path per line, no wildcards, trailing slash don't matter.
  204. For example: `/home/myuser/sources/newsequencer/bin/`
  205. These search paths are not stored in the session, but locally in your `~/.config` directory.
  206. == Tray
  207. Agordejo has a tray icon, if your window manager supports it. A click on the trayicon shows or
  208. hides Agordejo.
  209. If you close Agordejo using the normal window manager function, such as a click on the [X], the
  210. program and the session is not terminated, but minimized to the tray.
  211. A right click on the icon gives you access to common functions:
  212. You can directly start the most recently used sessions.
  213. If a session is already running you can save, cancel etc.
  214. Agordejo can also be completely exited here.
  215. == Network Sessions
  216. The functionality to distribute sessions over the local network is planned for a later program
  217. version.
  218. == Program parameters
  219. As an advanced user, you can start Agordejo in the terminal and add some parameters.. For a
  220. complete list please use the --help parameter.
  221. For example:
  222. * `--session newAlbum/mySong` starts the given session.
  223. * `--continue` starts the last active session.
  224. * `--hide` starts Agordejo as TrayIcon.
  225. * `--url osc.udp://myhost.localdomain:14294/` connects to this server, if available, or starts the internal session server at this address. This is a very technical option and probably not needed.
  226. * `--session-root /home/user/production2030` sets the root directory. Only sessions in this directory are displayed, everything is stored here.
  227. The combination of `--continue` and `--hide` is essentially what many people expect from Session
  228. Management: Resuming at the previous state, without any extra windows in their way.
  229. If your system uses a start menu you will find not only the normal Agordejo starter but also
  230. "Agordejo Continue" to start this mode directly.
  231. == Miscellaneous / Explanations / FAQ
  232. *Session Save and Exit responds slowly*: Agordejo is not a standalone program like an word
  233. processor. The participating programs in the session are not plugins either. When you end the
  234. session a signal is sent to all participating client to save. This may take a few moments where
  235. you are able to see "live" how individual programs terminate and disappear from the session.
  236. Everything is fine.
  237. *I have added a program but it does not save with the session*: Does the program support session
  238. management? If not, Agordejo cannot do much. But you can ask the program developers to contact us
  239. (info@laborejo.org) and we can work together on support.
  240. *The programs hang on exit*: Sorry about that. Actually, the programs themselves are to blame, but
  241. we are also interested in improving the situation by offering at least an emergency solution in the
  242. future.
  243. *Agordejo won't start! I start the program but I can't see anything*: Most likely Agordejo is
  244. running, but invisible, because you exited it from the tray last time. Is it in the tray? A
  245. message should have popped up, maybe you missed it. If there is no tray in your window manager, the
  246. program should always be visible. With all these special window managers in Linux it may be that
  247. the tray detection did not work properly. Contingency plan is to delete
  248. `~/.config/LaborejoSoftwareSuite/agordejo`. This will NOT remove any sessions, but only local
  249. settings such as the visibility of the program window. At next start Agordejo will behave like the
  250. very first start.
  251. *JACK crashed. A lot of programs hang. What can I do to prevent data loss?* Probably already many
  252. programs in the session are not running properly and are not reacting anymore. The best thing to do
  253. is to use the 'Abort Session' function and restart everything. If the data has actually been
  254. unsaved for a long time, you can also dare to save/exit. It may be necessary to re-draw some jack,
  255. or all, jack connections by hand at the next start. If you want to be on the safe side, you can
  256. manually make a copy of the session directory in your file manager before ending the session (with
  257. inevitable crashes).
  258. *A program update broke my session because it can no longer load its files.* Unfortunately, this is
  259. a problem that even Agordejo can't solve. It also happens with LV2 plugins and with all other
  260. software, such as office programs. If you fear that a program becomes incompatible in the future,
  261. write down its version number in the session notes, so that you can at least, in an emergency,
  262. reinstall the old program version (even if this is very is cumbersome).
  263. *What's better? Monolithic DAW or session management?* Why not both? There is no conflict. Session
  264. management is worthwhile with two or more participating programs, which one needs almost always.
  265. You should not feel compelled to suddenly make everything modular with individual programs, only
  266. because you use a session manager. Agordejo is designed to make your music production easier. If it
  267. is faster and more comfortable to manage all plugins and effects e.g. in a single "Carla" instance
  268. then you should do exactly that. If you basically want to do everything in Ardour, do that, but
  269. start Ardour anyway in session management, because no program can do everything alone and the time
  270. will come where you add a second one.
  271. Session management is another level of hierarchy. Sequencers or DAWs are not plug-ins themselves.
  272. Patroneo does not belong "in" Ardour and Ardour does not belong "in" Laborejo. Already in this
  273. example each of the programs fulfils a different role because the others follow a different design
  274. philosophy and cannot ever offer the same workflow. And more:
  275. Some programs can't host plugins, some can't export audio files. They are not bad programs, but
  276. programs that concentrate on one task. Furthermore, there is a lot of software that does not
  277. directly do music production, but still is connected in the grander scheme: Open Broadcast Studio
  278. (OBS), music player, word processors and graphic programs etc.
  279. *Agordejo contains functionality which is not within its scope*: Music production is very complex
  280. and complexity is inevitable. It's like a waterbed: if you press down on one side, something
  281. bounces up in another place. When you create a "clean and lean" program, which therefore implements
  282. only a part of the complete workflow, then the missing part pops up somewhere else. A minimalistic
  283. session manager provokes plug-ins (not LV2), helper-scripts, workarounds and hacks.
  284. E.g. not to include file management provokes user errors like deleting the wrong files. If the SM
  285. knows what to do and it can do it, then let it do it. Or crashes: Technically, crashing programs
  286. are not the "problem" of the session managers, but they are part of the software reality. Crashes
  287. happen every day and need to be handled. Can Agordejo simplify the work and help to restore good
  288. conditions again? Then that should be done. Session management is also an opportunity to simplify
  289. even complex technical scenarios, e.g. distributing sessions over the network.
  290. == Installation and Start
  291. Agordejo is exclusive for Linux. The best way to install is to use your package manager.
  292. If it is not there, or only in an outdated version, please ask your Linux distribution to provide a recent version.
  293. If not available in the package repository you can build Agordejo yourself.
  294. .Build and Install
  295. * Please check the supplied README.md for dependencies.
  296. * You can download a release or clone the git version
  297. ** Download the latest version from https://www.laborejo.org/downloads and extract it.
  298. ** git clone https://git.laborejo.org/lss/agordejo.git
  299. * Change into the new directory and use these commands:
  300. * `./configure --prefix=/usr`
  301. ** The default prefix is /usr/local
  302. * `make`
  303. * `sudo make install`
  304. Now the program is available to run via your menu/launcher or `agordejo` in a terminal.
  305. Please read README.md for other ways of starting agordejo, which are impractical for actual use but can
  306. be helpful for testing and development.
  307. == Help and Development
  308. You can help Agordejo in several ways: Testing and reporting errors, translating, marketing, support, programming and more.
  309. === Testing and Reporting Errors
  310. If you find a bug in the program (or it runs too slow) please contact us in a way that suits you best.
  311. We are thankful for any help.
  312. .How to contact us
  313. * Report bugs and issues: https://www.laborejo.org/bugs
  314. * Website: https://www.laborejo.org
  315. * E-Mail: info@laborejo.org
  316. * If you see the opportunity and know that a developer will read it also forums, social media etc..
  317. === Programming
  318. If you want to do some programming and don't know where to start please get in contact with us directly.
  319. The short version is: clone the git, change the code, create a git patch or point me to your public git.
  320. === Translations
  321. Agordejo is very easy to translate with the help of the Qt-Toolchain, without any need for programming.
  322. The easiest way is to contact the developers and they will setup the new language.
  323. However, here are the complete instructions for doing a translation completely on your own and integrating it into the program.
  324. You can add a new language like this:
  325. * Open a terminal and navigate to qtgui/resources/translations
  326. * Edit the file `config.pro` with a text editor
  327. ** Append the name of your language in the last line, in the form `XY.ts`, where XY is the language code.
  328. ** Make sure to leave a space between the individual languages entries.
  329. * Run `sh update.sh` in the same directory
  330. ** The program has now generated a new `.ts` file in the same directory.
  331. * Start Qt Linguist with `linguist-qt5` (may be named differently) and open your newly generated file
  332. * Select your "Target Language" and use the program to create a translation
  333. * Send us the `.ts` file, such as by e-mail to info@laborejo.org
  334. You can also incorporate the translation into Agordejo for testing purposes. This requires rudimentary Python knowledge.
  335. * Run the "Release" option in QtLinguists "File" menu. It creates a `.qm` file in the same directory as your `.ts` file.
  336. * Edit `qtgui/resources/resources.qrc` and duplicate the line `<file>translations/de.qm</file>` but change it to your new .qm file.
  337. * run `sh buildresources.sh`
  338. * Edit `engine/config.py`: add your language to the line that begins with "supportedLanguages" like this: `{"German": "de.qm", "Esperanto: "eo.qm"}`
  339. ** To find out your language string (German, Esperanto etc.) open the `python3` interpreter in a terminal and run the following command:
  340. ** `from PyQt5 import QtCore;QtCore.QLocale().languageToString(QtCore.QLocale().language())`
  341. To test the new translation you can either run the program normally, if your system is set to that language. Alternatively start agordejo via the terminal:
  342. * `LANGUAGE=de_DE.UTF-8 ./agordejo -V --save /dev/null`