feat: support speaker notes

Cargo.toml

@@ -36,6 +36,7 @@ thiserror = "1"
 unicode-width = "0.2"
 os_pipe = "1.1.5"
 libc = "0.2.155"
+iceoryx2 = "0.4.1"
 
 [dependencies.syntect]
 version = "5.2"

examples/code.md

@@ -6,14 +6,13 @@ theme:
       background: false
 ---
 
-Code styling
-===
+# Code styling
 
 This presentation shows how to:
 
-* Left-align code blocks.
-* Have code blocks without background.
-* Execute code snippets.
+- Left-align code blocks.
+- Have code blocks without background.
+- Execute code snippets.
 
 ```rust
 pub struct Greeter {
@@ -35,10 +34,11 @@ fn main() {
 }
 ```
 
+<!-- speaker_note: These are speaker notes on slide 1. -->
+
 <!-- end_slide -->
 
-Column layouts
-===
+# Column layouts
 
 The same code as the one before but split into two columns to split the API definition with its usage:
 
@@ -76,10 +76,11 @@ fn main() {
 }
 ```
 
+<!-- speaker_note: These are speaker notes on slide 2. -->
+
 <!-- end_slide -->
 
-Snippet execution
-===
+# Snippet execution
 
 Run code snippets from the presentation and display their output dynamically.
 
@@ -90,10 +91,11 @@ for i in range(0, 5):
     time.sleep(0.5)
 ```
 
+<!-- speaker_note: These are speaker notes on slide 3. -->
+
 <!-- end_slide -->
 
-Snippet execution - `stderr`
-===
+# Snippet execution - `stderr`
 
 Output from `stderr` will also be shown as output.
 
@@ -106,3 +108,5 @@ echo "This is a successful command again"
 sleep 0.5
 man # Missing argument
 ```
+
+<!-- speaker_note: These are speaker notes on slide 4. -->

src/custom.rs

@@ -1,8 +1,8 @@
 use crate::{
-    GraphicsMode,
     input::user::KeyBinding,
     media::{emulator::TerminalEmulator, kitty::KittyMode},
     processing::code::SnippetLanguage,
+    GraphicsMode, SpeakerNotesMode,
 };
 use clap::ValueEnum;
 use schemars::JsonSchema;
@@ -123,6 +123,7 @@ pub struct OptionsConfig {
 
     /// Whether to be strict about parsing the presentation's front matter.
     pub strict_front_matter_parsing: Option<bool>,
+    pub speaker_notes_mode: Option<SpeakerNotesMode>,
 }
 
 #[derive(Clone, Debug, Default, Deserialize, JsonSchema)]

src/lib.rs

@@ -29,7 +29,7 @@ pub use crate::{
     input::source::CommandSource,
     markdown::parse::MarkdownParser,
     media::{graphics::GraphicsMode, printer::ImagePrinter, register::ImageRegistry},
-    presenter::{PresentMode, Presenter, PresenterOptions},
+    presenter::{PresentMode, Presenter, PresenterOptions, SpeakerNotesMode},
     processing::builder::{PresentationBuilderOptions, Themes},
     render::highlighting::{CodeHighlighter, HighlightThemeSet},
     resource::Resources,

src/main.rs

@@ -1,11 +1,11 @@
-use clap::{CommandFactory, Parser, error::ErrorKind};
+use clap::{error::ErrorKind, CommandFactory, Parser};
 use comrak::Arena;
 use directories::ProjectDirs;
 use presenterm::{
     CommandSource, Config, Exporter, GraphicsMode, HighlightThemeSet, ImagePrinter, ImageProtocol, ImageRegistry,
     MarkdownParser, PresentMode, PresentationBuilderOptions, PresentationTheme, PresentationThemeSet, Presenter,
-    PresenterOptions, Resources, SnippetExecutor, Themes, ThemesDemo, ThirdPartyConfigs, ThirdPartyRender,
-    ValidateOverflows,
+    PresenterOptions, Resources, SnippetExecutor, SpeakerNotesMode, Themes, ThemesDemo, ThirdPartyConfigs,
+    ThirdPartyRender, ValidateOverflows,
 };
 use std::{
     env::{self, current_dir},
@@ -77,6 +77,9 @@ struct Cli {
     /// The path to the configuration file.
     #[clap(short, long)]
     config_file: Option<String>,
+
+    #[clap(short, long)]
+    speaker_notes_mode: Option<SpeakerNotesMode>,
 }
 
 fn create_splash() -> String {
@@ -151,6 +154,7 @@ fn make_builder_options(config: &Config, mode: &PresentMode, force_default_theme
         strict_front_matter_parsing: config.options.strict_front_matter_parsing.unwrap_or(true),
         enable_snippet_execution: config.snippet.exec.enable,
         enable_snippet_execution_replace: config.snippet.exec_replace.enable,
+        speaker_notes_mode: config.options.speaker_notes_mode.clone(),
     }
 }
 
@@ -272,6 +276,7 @@ fn run(mut cli: Cli) -> Result<(), Box<dyn std::error::Error>> {
     } else {
         let commands = CommandSource::new(config.bindings.clone())?;
         options.print_modal_background = matches!(graphics_mode, GraphicsMode::Kitty { .. });
+        options.speaker_notes_mode = cli.speaker_notes_mode;
 
         let options = PresenterOptions {
             builder_options: options,

src/presentation.rs

@@ -6,6 +6,11 @@ use crate::{
     style::{Color, Colors},
     theme::{Alignment, Margin, PresentationTheme},
 };
+use iceoryx2::{
+    port::{listener::Listener, notifier::Notifier},
+    prelude::EventId,
+    service::ipc::Service,
+};
 use serde::Deserialize;
 use std::{
     cell::RefCell,
@@ -30,6 +35,12 @@ pub(crate) struct Presentation {
     pub(crate) state: PresentationState,
 }
 
+#[derive(Debug)]
+pub enum SpeakerNoteChannel {
+    Notifier(Notifier<Service>),
+    Listener(Listener<Service>),
+}
+
 impl Presentation {
     /// Construct a new presentation.
     pub(crate) fn new(slides: Vec<Slide>, modals: Modals, state: PresentationState) -> Self {
@@ -253,6 +264,10 @@ impl Presentation {
             false
         }
     }
+
+    pub(crate) fn listen_for_speaker_note_evt(&self) -> Option<usize> {
+        self.state.listen_for_speaker_note_evt()
+    }
 }
 
 impl From<Vec<Slide>> for Presentation {
@@ -274,6 +289,7 @@ pub(crate) type AsyncPresentationErrorHolder = Arc<Mutex<Option<AsyncPresentatio
 pub(crate) struct PresentationStateInner {
     current_slide_index: usize,
     async_error_holder: AsyncPresentationErrorHolder,
+    pub(crate) channel: Option<SpeakerNoteChannel>,
 }
 
 #[derive(Clone, Debug, Default)]
@@ -292,6 +308,22 @@ impl PresentationState {
 
     fn set_current_slide_index(&self, value: usize) {
         self.inner.deref().borrow_mut().current_slide_index = value;
+        if let Some(SpeakerNoteChannel::Notifier(notifier)) = &self.inner.deref().borrow().channel {
+            notifier.notify_with_custom_event_id(EventId::new(value)).unwrap();
+        }
+    }
+
+    pub(crate) fn set_channel(&self, speaker_note_channel: SpeakerNoteChannel) {
+        self.inner.deref().borrow_mut().channel = Some(speaker_note_channel);
+    }
+
+    fn listen_for_speaker_note_evt(&self) -> Option<usize> {
+        if let Some(SpeakerNoteChannel::Listener(listener)) = &self.inner.deref().borrow().channel {
+            if let Some(evt) = listener.try_wait_one().unwrap() {
+                return Some(evt.as_value() + 1);
+            }
+        }
+        None
     }
 }
 

src/presenter.rs

@@ -1,3 +1,7 @@
+use clap::ValueEnum;
+use schemars::JsonSchema;
+use serde::Deserialize;
+
 use crate::{
     custom::KeyBindingsConfig,
     diff::PresentationDiffer,
@@ -37,6 +41,13 @@ pub struct PresenterOptions {
     pub validate_overflows: bool,
 }
 
+#[derive(Clone, Debug, Deserialize, ValueEnum, JsonSchema)]
+#[serde(rename_all = "kebab-case")]
+pub enum SpeakerNotesMode {
+    Publisher,
+    Receiver,
+}
+
 /// A slideshow presenter.
 ///
 /// This type puts everything else together.
@@ -104,6 +115,11 @@ impl<'a> Presenter<'a> {
             self.render(&mut drawer)?;
 
             loop {
+                if let Some(idx) = self.state.presentation().listen_for_speaker_note_evt() {
+                    self.apply_command(Command::GoToSlide(idx as u32));
+                    break;
+                }
+
                 if self.poll_async_renders()? {
                     self.render(&mut drawer)?;
                 }
@@ -194,7 +210,11 @@ impl<'a> Presenter<'a> {
         };
         // If the screen is too small, simply ignore this. Eventually the user will resize the
         // screen.
-        if matches!(result, Err(RenderError::TerminalTooSmall)) { Ok(()) } else { result }
+        if matches!(result, Err(RenderError::TerminalTooSmall)) {
+            Ok(())
+        } else {
+            result
+        }
     }
 
     fn apply_command(&mut self, command: Command) -> CommandSideEffect {
@@ -264,7 +284,11 @@ impl<'a> Presenter<'a> {
                 panic!("unreachable commands")
             }
         };
-        if needs_redraw { CommandSideEffect::Redraw } else { CommandSideEffect::None }
+        if needs_redraw {
+            CommandSideEffect::Redraw
+        } else {
+            CommandSideEffect::None
+        }
     }
 
     fn try_reload(&mut self, path: &Path, force: bool) {