Misc updates for broadcaster and OBS for latest standards

(still not fully up to date)

Author: rkdarst

broadcaster.rst

@@ -3,9 +3,9 @@ Broadcaster
 
 This page explains the setup and how-to guide for the OBS broadcaster.
 This person manages the technical setup of :doc:`OBS <obs>` and thus
-the streaming.  This person often is, but does not have to be, the OBS
-director [todo: link] who switches the scenes and manages the
-broadcast after it has started.
+the streaming.  This person often is, but does not have to be, the
+:doc:`director` who switches the scenes and manages the broadcast
+after it has started.
 
 
 
@@ -55,16 +55,13 @@ Prerequisites:
     without much `jitter
     <https://en.wikipedia.org/wiki/Jitter#Packet_jitter_in_computer_networks>`__.
     However, OBS settings can be tuned to have a larger buffer to
-    handle this.
+    handle this (but that introduces latency in the broadcast).
 
 
 Software installation:
 
 * `Install OBS <https://obsproject.com/>`__ (Linux, Mac, Windows -
   this is a mass market product so there is good support)
-* Install `obs-websocket
-  <https://github.com/obsproject/obs-websocket/>`__.  This is also
-  fairly widespread, but slightly less so than OBS.
 * Zoom (but you likely already have that)
 
 Zoom setup:
@@ -75,7 +72,9 @@ Zoom setup:
 
   * General → Use dual monitors → yes.  Despite the name, this gives
     Zoom two *windows*: one for the gallery view, one for the
-    screenshare (or active speaker if there is no screenshare).
+    screenshare (or active speaker if there is no screenshare).  You
+    need two monitors plugged in, though, otherwise the mode doesn't
+    work.
 
   * General → Enter full screen automatically when starting or joining
     a meeting → false
@@ -87,12 +86,12 @@ Zoom setup:
 
 OBS setup:
 
-* Clone the `obs-scenes repository
-  <https://github.com/coderefinery/obs-scenes>`__.  This contains some
+* Clone the `obs-config repository
+  <https://github.com/coderefinery/obs-config/>`__.  This contains some
   pre-made scenes which will set your OBS up for teaching nicely.
 
-* Import the TeachingStreaming profile
-  (Profile → Import → ``obs-scenes/profiles/Teaching_Streaming``).  This contains things
+* Import the latest TeachingStreaming profile
+  (Profile → Import → ``obs-config/profiles/TeachingStreaming-v*``).  This contains things
   like audio and encoder settings
 
   * TODO: this may need adjustment for your particular situation.  At
@@ -104,29 +103,21 @@ OBS setup:
 
 * Import the Teaching_Streaming_ZoomCapture scene collection (Scene
   Collection → Import →
-  ``obs-scenes/scenes/Teaching_Streaming_ZoomCapture``).
+  ``obs-scenes/scenes/TeachingStreaming-v*``).
 
 * You now need to configure some window captures, for example, you
   need to tell OBS which window has the gallery of all instructors in
   it.  From the "Scenes"
 
-  * Scene ``_GalleryCapture[hidden]`` → source ``ZoomMeeting-Gallery``
-    right click → Properties → Window → select the Zoom gallery view
-    (for me it is titled "Zoom meeting").  TODO: adjust the size of
-    this window until it fits the pre-made scene [it looks nice and
-    large]
+  * In one of the scenes like ``Screenshare``, change the sources
+    ``ZoomMeetingCapture`` to the window named ZoomMeeting, and the
+    source ``ZoomCapture`` to the window named Zoom.
 
-  * Scene ``_Screenshare-Zoom-Capture[hidden]`` → source
-    ``Zoom-SecondWindow`` right click → Properties → Window → select
-    the Zoom screenshare/active speaker window (for me it is titled
-    only "Zoom").  Adjust the size of this window until it nicely
-    fills the preview pane (the ideal size is 840×1080).
+  * In the scene scene ``Notes``, change the ``HackMDCapture``
+    source to the notes window you are capturing
 
-  * (optional) Scene ``_Hackmd-Capture[hidden]``: similar, select the
-    shared HackMD
-
-  * (optional) Scene ``_Broadcaster-Screen[hidden]``: configure your
-    local desktop capture.
+  * (optional) In the scene scene ``BroadcasterScreen``: configure
+    your local desktop capture.
 
 * Configure the audio
 
@@ -155,9 +146,15 @@ OBS setup:
 * Configure obs-websocket (set the listening socket + authentication).
 
   * Tools → Websocket server settings → {Enable websockets
-    server=true, Server port=(something), Enable authentication=true,
-    Password=something}.  Share your IP address, server port, and
-    password with your other instructors.
+    server=true, Server port=4455, Enable authentication=true,
+    Password=something}.
+
+* Begin the websocket proxy.  This accepts incoming connections with
+  SSL, filters to only allow known safe requests, and then forwards
+  the connection to OBS.  The password authentication is proxied to
+  OBS, so there isn't a separate password set here.  ``python3
+  obs_cr/websocket_proxy.py 127.0.0.1:4456 [other options]``
+
 
 * Allow outside connections.  On of these two:
 
@@ -174,6 +171,9 @@ OBS setup:
 
 * Verify the obs-tablet-remote connection (see TODO director-setup).
 
+* Share your IP address, server port, and
+  password with your other instructors.
+
 
 
 Before each day checklist
@@ -193,7 +193,7 @@ Before each day checklist
     * attendee hackmd: 
     * notes hackmd: 
     * live preview: 
-    * control panel:
+    * control panel: 
 
 
 Before each broadcast checklist
@@ -279,6 +279,31 @@ Common problems
 
 
 
+Broadcaster practice
+--------------------
+
+1. Start OBS and import the scenes
+2. Start Zoom and configure OBS to capture the Zoom windows.
+3. Now we try to get the control panel working.
+
+   a. Clone obs-cr
+   a. Run obs_cr/websocket_proxy.py with the right arguments
+
+4. Get the local headless client working (this listens to signals and does
+   stuff like run the xdotool command to resize windows or scroll notes.)
+
+   a. obs_cr/headless.py
+
+5. Practice switching scenes
+6. Practice making scene presets and switching to them
+7. Practice scrolling the notes
+8. Use your headphones to monitor the sound (audio advanced settings)
+9. Include the music/jingle in the recorded video.  Now remove it from
+   the recorded video.  (I found it's better to leave it out because
+   it affects transcription.)
+
+
+
 See also
 --------
 

obs.rst

@@ -290,11 +290,11 @@ can make some uniform scripting tools):
 * **Gallery**, a gallery of the people presenting (or the one).  When
   presenting from a Zoom meeting, this is a capture of the gallery
   view in dual-monitor mode.
-* **Local** is a local screenshare, that you get by capturing your own
-  screen.
-* **Remote** is a screenshare by someone remote.  If you are capturing
+* **Screenshare** is a screenshare by someone remote.  If you are capturing
   from a Zoom meeting, it is the capture of the second window of the
   dual-monitor mode.
+* **BroadcasterScreen** is a local screenshare, that you get by capturing your own
+  screen.
 * **Notes** is some HackMD or other material you might want to show
   during discussion periods or breaks.
 
@@ -374,7 +374,7 @@ guides:
 High-quality audio is quite important.  I've spent far too long
 playing with it, and my conclusion is that I don't know enough to make
 it better than what I have now.  What I know is in the "instructor
-tech setup, online" page linked above.  I propose a central
+audio" page linked above.  I propose a central
 recommendation: *talk about audio quality*.  Start meetings early and
 test it.  Communicate about problems early, don't ignore and think
 it's "good enough for now".
@@ -409,7 +409,8 @@ monitor or window.
 
 * The **windowed projector** does similar, but makes a new window that
   can be moved and resized.  This can be captured as a single-window
-  screenshare in an online meeting.
+  screenshare in an online meeting.  Or it can be a smaller preview of
+  the scene if the main OBS window is too large for your space.
 
 
 The **loopback output** creates a **virtual camera device**.  This
@@ -432,7 +433,8 @@ Example configurations
 Recording your own demo
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-Scenes: Title, Gallery, Local.  Variable bitrate.
+Scenes: Title, Gallery, BroadcasterScreen.  Variable bitrate
+recording.
 
 Online teaching event
 ~~~~~~~~~~~~~~~~~~~~~
@@ -441,9 +443,9 @@ Scenes:
 
 * Title
 * Gallery - contains galleryCapture
-* Local - capture of your screen, when you need to teach.  Has
+* BroadcasterScreen - capture of your screen, when you need to teach.  Has
   galleryCapture in top-right corner
-* Remote: capture of Zoom second window (which has been
+* Screenshare: capture of Zoom second window (which has been
   adjusted to be same resolution as your base canvas size).  Also has
   galleryCapture in top-right corner.
 * Notes: contains HackMD + galleryCapture