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/speaker-notes.md

@@ -0,0 +1,42 @@
+Speaker Notes
+===
+
+`presenterm` supports speaker notes.
+
+You can use the following HTML comment throughout your presentation markdown file:
+
+```markdown
+<!-- speaker_note: Your speaker note goes here. -->
+```
+
+<!-- speaker_note: This is a speaker note from slide 1. -->
+
+And you can run a separate instance of `presenterm` to view them.
+
+<!-- speaker_note: You can use multiple speaker notes within each slide and interleave them with other markdown. -->
+
+<!-- end_slide -->
+
+Usage
+===
+Run the following two commands in separate terminals.
+
+<!-- speaker_note: This is a speaker note from slide 2. -->
+
+The `--speaker-notes-mode=publisher` argument will render your actual presentation as normal, without speaker notes:
+
+```
+presenterm --speaker-notes-mode=publisher examples/speaker-notes.md
+```
+
+The `--speaker-notes-mode=receiver` argument will render only the speaker notes for the current slide being shown in the actual presentation:
+
+```
+presenterm --speaker-notes-mode=receiver examples/speaker-notes.md
+```
+
+<!-- speaker_note: Demonstrate changing slides in the actual presentation. -->
+
+As you change slides in your actual presentation, the speaker notes presentation slide will automatically navigate to the correct slide.
+
+<!-- speaker_note: Isn't that cool? -->

src/custom.rs

@@ -1,8 +1,8 @@
 use crate::{
-    GraphicsMode,
     input::user::KeyBinding,
     media::{emulator::TerminalEmulator, kitty::KittyMode},
     processing::code::SnippetLanguage,
+    GraphicsMode,
 };
 use clap::ValueEnum;
 use schemars::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, SpeakerNoteChannel},
     processing::builder::{PresentationBuilderOptions, Themes},
     render::highlighting::{CodeHighlighter, HighlightThemeSet},
     resource::Resources,

src/main.rs

@@ -1,12 +1,15 @@
-use clap::{CommandFactory, Parser, error::ErrorKind};
+use clap::{error::ErrorKind, CommandFactory, Parser, ValueEnum};
 use comrak::Arena;
 use directories::ProjectDirs;
+use iceoryx2::{node::NodeBuilder, prelude::ServiceName, service::ipc};
 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, SpeakerNoteChannel, Themes, ThemesDemo, ThirdPartyConfigs,
+    ThirdPartyRender, ValidateOverflows,
 };
+use schemars::JsonSchema;
+use serde::Deserialize;
 use std::{
     env::{self, current_dir},
     io,
@@ -17,6 +20,13 @@ use std::{
 
 const DEFAULT_THEME: &str = "dark";
 
+#[derive(Clone, Copy, Debug, Deserialize, ValueEnum, JsonSchema)]
+#[serde(rename_all = "kebab-case")]
+pub enum SpeakerNotesMode {
+    Publisher,
+    Receiver,
+}
+
 /// Run slideshows from your terminal.
 #[derive(Parser)]
 #[command()]
@@ -77,6 +87,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 {
@@ -138,7 +151,12 @@ fn display_acknowledgements() {
     println!("{}", String::from_utf8_lossy(acknowledgements));
 }
 
-fn make_builder_options(config: &Config, mode: &PresentMode, force_default_theme: bool) -> PresentationBuilderOptions {
+fn make_builder_options(
+    config: &Config,
+    mode: &PresentMode,
+    force_default_theme: bool,
+    speaker_notes_mode: Option<SpeakerNotesMode>,
+) -> PresentationBuilderOptions {
     PresentationBuilderOptions {
         allow_mutations: !matches!(mode, PresentMode::Export),
         implicit_slide_ends: config.options.implicit_slide_ends.unwrap_or_default(),
@@ -151,6 +169,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,
+        render_speaker_notes_only: speaker_notes_mode.is_some_and(|mode| matches!(mode, SpeakerNotesMode::Receiver)),
     }
 }
 
@@ -189,6 +208,27 @@ fn overflow_validation(mode: &PresentMode, config: &ValidateOverflows) -> bool {
     }
 }
 
+fn create_speaker_notes_channel(
+    speaker_notes_mode: SpeakerNotesMode,
+) -> Result<SpeakerNoteChannel, Box<dyn std::error::Error>> {
+    let node = NodeBuilder::new().create::<ipc::Service>()?;
+    // TODO: Use a service name that incorporates presenterm and/or the presentation filename/title?
+    let service_name: ServiceName = "SpeakerNoteEventService".try_into()?;
+    let speaker_note_channel = match speaker_notes_mode {
+        SpeakerNotesMode::Publisher => {
+            let event = node.service_builder(&service_name).event().open_or_create()?;
+            let notifier = event.notifier_builder().create()?;
+            SpeakerNoteChannel::Notifier(notifier)
+        }
+        SpeakerNotesMode::Receiver => {
+            let event = node.service_builder(&service_name).event().open_or_create()?;
+            let listener = event.listener_builder().create()?;
+            SpeakerNoteChannel::Listener(listener)
+        }
+    };
+    Ok(speaker_note_channel)
+}
+
 fn run(mut cli: Cli) -> Result<(), Box<dyn std::error::Error>> {
     if cli.generate_config_file_schema {
         let schema = schemars::schema_for!(Config);
@@ -229,7 +269,7 @@ fn run(mut cli: Cli) -> Result<(), Box<dyn std::error::Error>> {
     let parser = MarkdownParser::new(&arena);
 
     let validate_overflows = overflow_validation(&mode, &config.defaults.validate_overflows) || cli.validate_overflows;
-    let mut options = make_builder_options(&config, &mode, force_default_theme);
+    let mut options = make_builder_options(&config, &mode, force_default_theme, cli.speaker_notes_mode);
     if cli.enable_snippet_execution {
         options.enable_snippet_execution = true;
     }
@@ -273,6 +313,8 @@ fn run(mut cli: Cli) -> Result<(), Box<dyn std::error::Error>> {
         let commands = CommandSource::new(config.bindings.clone())?;
         options.print_modal_background = matches!(graphics_mode, GraphicsMode::Kitty { .. });
 
+        let speaker_notes_channel = cli.speaker_notes_mode.map(create_speaker_notes_channel).transpose()?;
+
         let options = PresenterOptions {
             builder_options: options,
             mode,
@@ -290,6 +332,7 @@ fn run(mut cli: Cli) -> Result<(), Box<dyn std::error::Error>> {
             themes,
             printer,
             options,
+            speaker_notes_channel,
         );
         presenter.present(&path)?;
     }

src/presenter.rs

@@ -1,3 +1,9 @@
+use iceoryx2::{
+    port::{listener::Listener, notifier::Notifier},
+    prelude::EventId,
+    service::ipc::Service,
+};
+
 use crate::{
     custom::KeyBindingsConfig,
     diff::PresentationDiffer,
@@ -37,6 +43,12 @@ pub struct PresenterOptions {
     pub validate_overflows: bool,
 }
 
+#[derive(Debug)]
+pub enum SpeakerNoteChannel {
+    Notifier(Notifier<Service>),
+    Listener(Listener<Service>),
+}
+
 /// A slideshow presenter.
 ///
 /// This type puts everything else together.
@@ -52,6 +64,7 @@ pub struct Presenter<'a> {
     image_printer: Arc<ImagePrinter>,
     themes: Themes,
     options: PresenterOptions,
+    speaker_notes_channel: Option<SpeakerNoteChannel>,
 }
 
 impl<'a> Presenter<'a> {
@@ -67,6 +80,7 @@ impl<'a> Presenter<'a> {
         themes: Themes,
         image_printer: Arc<ImagePrinter>,
         options: PresenterOptions,
+        speaker_notes_channel: Option<SpeakerNoteChannel>,
     ) -> Self {
         Self {
             default_theme,
@@ -80,6 +94,7 @@ impl<'a> Presenter<'a> {
             image_printer,
             themes,
             options,
+            speaker_notes_channel,
         }
     }
 
@@ -104,6 +119,13 @@ impl<'a> Presenter<'a> {
             self.render(&mut drawer)?;
 
             loop {
+                if let Some(SpeakerNoteChannel::Listener(listener)) = self.speaker_notes_channel.as_mut() {
+                    if let Some(evt) = listener.try_wait_one().unwrap() {
+                        self.apply_command(Command::GoToSlide(evt.as_value() as u32));
+                        break;
+                    }
+                }
+
                 if self.poll_async_renders()? {
                     self.render(&mut drawer)?;
                 }
@@ -136,6 +158,10 @@ impl<'a> Presenter<'a> {
                     CommandSideEffect::None => (),
                 };
             }
+            if let Some(SpeakerNoteChannel::Notifier(notifier)) = self.speaker_notes_channel.as_mut() {
+                let current_slide_idx = self.state.presentation().current_slide_index();
+                notifier.notify_with_custom_event_id(EventId::new(current_slide_idx + 1)).unwrap();
+            }
         }
     }
 
@@ -194,7 +220,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 +294,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) {