Add support for locations

Author: 0x2b3bfa0

blobopera/command/common.py

@@ -83,14 +83,31 @@ class FillPhoneme(str, Enum):
 
 class InterfaceTheme(str, Enum):
     NORMAL = "NORMAL"
-    FESTIVE = "FESTIVE"
+    CHRISTMAS = "CHRISTMAS"
+    NEWYEARS = "NEWYEARS"
 
 
 DefaultInterfaceTheme = typer.Option(
     InterfaceTheme.NORMAL, case_sensitive=False
 )
 
 
+class InterfaceLocation(str, Enum):
+    BLOBPERAHOUSE = "BLOBPERAHOUSE"
+    LONDON = "LONDON"
+    NEWYORK = "NEWYORK"
+    HACKNEY = "HACKNEY"
+    PARIS = "PARIS"
+    CAPETOWN = "CAPETOWN"
+    MEXICOCITY = "MEXICOCITY"
+    SEOUL = "SEOUL"
+
+
+DefaultInterfaceLocation = typer.Option(
+    InterfaceLocation.BLOBPERAHOUSE, case_sensitive=False
+)
+
+
 def parse(data: bytes, message: Type[Message]) -> Message:
     """Parse a Protocol Buffer message from any of its representations.
 

blobopera/command/recording.py

@@ -6,6 +6,7 @@
 import typer
 
 from ..languages import GenericLanguage, RandomLanguage
+from ..location import Location
 from ..phoneme import Phoneme
 from ..recording import Recording
 from ..theme import Theme
@@ -87,6 +88,7 @@ def _import(  # Prepend an underscore because import is a reserved keyword.
     theme: common.InterfaceTheme = common.DefaultInterfaceTheme,
     language: common.PhonemeLanguage = common.DefaultPhonemeLanguage,
     fill: common.FillPhoneme = common.DefaultFillPhoneme,
+    location: common.InterfaceLocation = common.DefaultInterfaceLocation,
     soprano_part: int = 0,
     alto_part: int = 1,
     tenor_part: int = -2,
@@ -121,6 +123,9 @@ def _import(  # Prepend an underscore because import is a reserved keyword.
         Tempo: this value modifies the global tempo by the specified amount;
         0.5 would slow down the piece to half its original speed, and 2.0
         would make it twice as quicker.
+
+        Location: the location (i.e. background image) of the recording, like
+        e.g. Seoul or London.
     """
 
     if language == common.PhonemeLanguage.GENERIC:
@@ -144,6 +149,7 @@ def _import(  # Prepend an underscore because import is a reserved keyword.
         tempo=tempo,
         parts=parts,
         fill=Phoneme[fill.value],
+        location=Location[location.value]
     )
 
     output.write(

blobopera/location.py

@@ -0,0 +1,26 @@
+"""Graphical user interface locations.
+
+This module describes the location pictures that can be used in
+the Blob Opera application user interface.
+"""
+import proto  # type: ignore
+
+__protobuf__ = proto.module(package=__name__)
+
+
+class Location(proto.Enum):
+    """Background picture for the Blob Opera stage.
+
+    Note:
+        BlobperaHouse is a generic background.
+        Others are blurry outdoor views of emblematic places.
+    """
+
+    BLOBPERAHOUSE = 0
+    LONDON = 1
+    NEWYORK = 2
+    HACKNEY = 3
+    PARIS = 4
+    CAPETOWN = 5
+    MEXICOCITY = 6
+    SEOUL = 7

blobopera/recording.py

@@ -6,6 +6,7 @@
 from more_itertools import split_before, windowed_complete
 
 from .languages import GenericLanguage, Language
+from .location import Location
 from .phoneme import Phoneme
 from .theme import Theme
 
@@ -413,6 +414,7 @@ class Recording(proto.Message):
 
     theme = proto.Field(Theme, number=1, optional=True)
     parts = proto.RepeatedField(Part, number=2, optional=True)
+    location = proto.Field(Location, number=3, optional=True)
 
     @classmethod
     def from_score(
@@ -423,6 +425,7 @@ def from_score(
         tempo: float = 1.0,
         parts: Tuple[int] = (0, 0, 0, 0),
         fill: Phoneme = Phoneme.SILENCE,
+        location: Location = Location.BLOBPERAHOUSE,
     ):
         """Create a Blob Opera recording from a music21 score.
 
@@ -454,7 +457,7 @@ def from_score(
         if len(parts) != 4:
             raise ValueError("recordings require exactly four tracks")
         try:
-            recording = Recording(theme=theme)
+            recording = Recording(theme=theme, location=location)
             for index in parts:
                 part = Part.from_part(
                     score.parts[index],

blobopera/theme.py

@@ -12,9 +12,14 @@ class Theme(proto.Enum):
     """Graphical user interface theme.
 
     Note:
-        The :py:attr:`FESTIVE` theme adds lots of tiny falling snowflakes
+        The :py:attr:`CHRISTMAS` theme adds lots of tiny falling snowflakes
         in the background and Santa Claus hats over the singers.
+
+        The :py:attr:`NEWYEARS` theme adds lots of tiny falling snowflakes
+        in the background, party hats over the singers and a big aluminum
+        balloon with the year on it hovering their heads.
     """
 
     NORMAL = 0
-    FESTIVE = 1
+    CHRISTMAS = 1
+    NEWYEARS = 2

documentation/command/README.md

@@ -302,6 +302,9 @@ Options:
     0.5 would slow down the piece to half its original speed, and 2.0
     would make it twice as quicker.
 
+    Location: the location (i.e. background image) of the recording, like
+    e.g. Seoul or London.
+
 **Usage**:
 
 ```console
@@ -316,9 +319,10 @@ $ blobopera recording import [OPTIONS] INPUT OUTPUT
 **Options**:
 
 * `--format [BINARY|JSON]`: [default: BINARY]
-* `--theme [NORMAL|FESTIVE]`: [default: NORMAL]
+* `--theme [NORMAL|CHRISTMAS|NEWYEARS]`: [default: NORMAL]
 * `--language [GENERIC|RANDOM]`: [default: GENERIC]
-* `--fill [SILENCE|A|E|I|O|U]`: [default: SILENCE]
+* `--fill [SILENCE|A|E|I|O|U]`: [default: U]
+* `--location [BLOBPERAHOUSE|LONDON|NEWYORK|HACKNEY|PARIS|CAPETOWN|MEXICOCITY|SEOUL]`: [default: BLOBPERAHOUSE]
 * `--soprano-part INTEGER`: [default: 0]
 * `--alto-part INTEGER`: [default: 1]
 * `--tenor-part INTEGER`: [default: -2]

documentation/protocol/README.md

@@ -25,6 +25,9 @@ purposes.
 * **`Theme`** contains a list of valid themes; the festive theme adds
   falling snow and a red fluffy hat for each blob.
 
+* **`Location`** contains a list of valid locations; i.e. blurry background
+  pictures of emblematic places.
+
 ## Usage
 
 ```bash

documentation/protocol/enumerations/location.proto

@@ -0,0 +1,12 @@
+syntax = "proto2";
+
+enum Location {
+  BlobperaHouse = 0;
+  London = 1;
+  NewYork = 2;
+  Hackney = 3;
+  Paris = 4;
+  CapeTown = 5;
+  MexicoCity = 6;
+  Seoul = 7;
+}

documentation/protocol/enumerations/theme.proto

@@ -1,6 +1,7 @@
 syntax = "proto2";
 
 enum Theme {
-  Normal  = 0;
-  Festive = 1;
+  Normal = 0;
+  Christmas = 1;
+  NewYears = 2;
 }

documentation/protocol/messages/recording.proto

@@ -1,5 +1,6 @@
 syntax = "proto2";
 
+import "enumerations/location.proto";
 import "enumerations/phoneme.proto";
 import "enumerations/theme.proto";
 
@@ -28,4 +29,5 @@ message RecordingMessage {
 
   required Theme theme = 1;
   repeated Part parts = 2;
+  required Location location = 3;
 }