maialib 1.6.1__cp311-cp311-win_amd64.whl → 1.7.0__cp311-cp311-win_amd64.whl

maialib/maiacore/Release/maiacore.pyi

@@ -385,6 +385,22 @@ class HeapData:
     pass
 class Helper:
     @staticmethod
+    @typing.overload
+    def calculateMelodyEuclideanSimilarity(melodyPattern: list[Note], otherMelody: list[Note]) -> float:
+        ...
+    @staticmethod
+    @typing.overload
+    def calculateMelodyEuclideanSimilarity(semitonesDifference: list[float]) -> float:
+        ...
+    @staticmethod
+    @typing.overload
+    def calculateRhythmicEuclideanSimilarity(rhythmPattern: list[Note], otherRhythm: list[Note]) -> float:
+        ...
+    @staticmethod
+    @typing.overload
+    def calculateRhythmicEuclideanSimilarity(durationDifferences: list[float]) -> float:
+        ...
+    @staticmethod
     def durationRatio(duration_A: float, duration_B: float) -> float:
         ...
     @staticmethod
@@ -400,9 +416,15 @@ class Helper:
     def frequencies2cents(freq_A: float, freq_B: float) -> int:
         ...
     @staticmethod
+    def getDurationDifferenceBetweenRhythms(referenceRhythm: list[Note], otherRhythm: list[Note]) -> list[float]:
+        ...
+    @staticmethod
     def getPercentiles(arg0: typing.Any, arg1: list[float]) -> typing.Any:
         ...
     @staticmethod
+    def getSemitonesDifferenceBetweenMelodies(referenceMelody: list[Note], otherMelody: list[Note]) -> list[float]:
+        ...
+    @staticmethod
     def isEnharmonic(arg0: str, arg1: str) -> bool:
         ...
     @staticmethod
@@ -475,6 +497,8 @@ class Interval:
         ...
     def getDiatonicSteps(self, useSingleOctave: bool = True, absoluteValue: bool = False) -> int:
         ...
+    def getDirection(self) -> str:
+        ...
     def getName(self) -> str:
         ...
     def getNotes(self) -> list[Note]:
@@ -1052,6 +1076,8 @@ class Part:
     @typing.overload
     def getMeasure(self, measureId: int) -> Measure:
         ...
+    def getMeasures(self) -> list[Measure]:
+        ...
     def getMidiUnpitched(self) -> list[int]:
         ...
     def getName(self) -> str:
@@ -1184,6 +1210,8 @@ class Score:
         ...
     def clear(self) -> None:
         ...
+    def findMelodyPatternDataFrame(self, melodyPattern: list[Note], totalIntervalsSimilarityThreshold: float = 0.5, totalRhythmSimilarityThreshold: float = 0.5, intervalsSimilarityCallback: typing.Callable[[list[Note], list[Note]], list[float]] = None, rhythmSimilarityCallback: typing.Callable[[list[Note], list[Note]], list[float]] = None, totalIntervalSimilarityCallback: typing.Callable[[list[float]], float] = None, totalRhythmSimilarityCallback: typing.Callable[[list[float]], float] = None, totalSimilarityCallback: typing.Callable[[float, float], float] = None) -> typing.Any:
+        ...
     def forEachNote(self, callback: typing.Callable[[Part, Measure, int, Note], None], measureStart: int = 0, measureEnd: int = -1, partNames: list[str] = []) -> None:
         ...
     def getChords(self, config: json = None) -> list[tuple[int, float, Key, Chord, bool]]:
@@ -1317,4 +1345,4 @@ C: ClefSign  # value = <ClefSign.C: 2>
 F: ClefSign  # value = <ClefSign.F: 1>
 G: ClefSign  # value = <ClefSign.G: 0>
 P: ClefSign  # value = <ClefSign.P: 3>
-__version__: str = '"1.6.1"'
+__version__: str = '"1.7.0"'

maialib/maiapy/other.pyi

@@ -1,20 +1,79 @@
 import maialib.maiacore as mc
 from enum import Enum
 
-__all__ = ['getSampleScorePath', 'SampleScore', 'setScoreEditorApp', 'getScoreEditorApp', 'openScore', 'getXmlSamplesDirPath']
+def setScoreEditorApp(executableFullPath: str) -> None:
+    '''Set the full path to the installed score editor app
 
-def setScoreEditorApp(executableFullPath: str) -> None: ...
+    Args:
+       executableFullPath (str): Score editor full path
+       Example 01: "C:/path/to/MuseScore"
+       Example 02: "/Applications/MuseScore 4.app/Contents/MacOS/mscore"
+
+    Examples of use:
+
+    >>> import maialib as ml
+    >>> # Example for Windows:
+    >>> ml.setScoreEditorApp("C:/path/to/MuseScore.exe")
+    >>> # Example for Mac OSX:
+    >>> ml.setScoreEditorApp("/Applications/MuseScore 4.app/Contents/MacOS/mscore")
+    '''
 def getScoreEditorApp() -> str: ...
 def openScore(score: mc.Score) -> None: ...
 
 class SampleScore(Enum):
-    Bach_Cello_Suite_1 = 'Bach_Cello_Suite_1'
-    Beethoven_Symphony_5th = 'Beethoven_Symphony_5th'
-    Chopin_Fantasie_Impromptu = 'Chopin_Fantasie_Impromptu'
-    Dvorak_Symphony_9_mov_4 = 'Dvorak_Symphony_9_mov_4'
-    Mahler_Symphony_8_Finale = 'Mahler_Symphony_8_Finale'
-    Mozart_Requiem_Introitus = 'Mozart_Requiem_Introitus'
-    Strauss_Also_Sprach_Zarathustra = 'Strauss_Also_Sprach_Zarathustra'
-
-def getSampleScorePath(sampleEnum: SampleScore) -> str: ...
-def getXmlSamplesDirPath() -> str: ...
+    Bach_Cello_Suite_1: str
+    Beethoven_Symphony_5th: str
+    Chopin_Fantasie_Impromptu: str
+    Dvorak_Symphony_9_mov_4: str
+    Mahler_Symphony_8_Finale: str
+    Mozart_Requiem_Introitus: str
+    Strauss_Also_Sprach_Zarathustra: str
+
+def getSampleScorePath(sampleEnum: SampleScore) -> str:
+    """Get a maialib internal XML sample file
+
+    Args:
+       sampleEnum (SampleScore): Maialib SampleScore enum value
+           - Bach_Cello_Suite_1
+           - Beethoven_Symphony_5th
+           - Chopin_Fantasie_Impromptu
+           - Dvorak_Symphony_9_mov_4
+           - Mahler_Symphony_8_Finale
+           - Mozart_Requiem_Introitus
+           - Strauss_Also_Sprach_Zarathustra
+
+    Kwargs:
+       None
+
+    Returns:
+       A full file path (str) to the XML maialib internal sample score
+
+    Raises:
+       RuntimeError
+
+    Examples of use:
+
+    >>> import maialib as ml
+    >>> filePath = ml.getSampleScorePath(ml.SampleScore.Bach_Cello_Suite_1)
+    >>> score = ml.Score(filePath)
+    >>> score.info()
+    """
+def getXmlSamplesDirPath() -> str:
+    '''Get the maialib XML samples directory path
+
+    Kwargs:
+       None
+
+    Returns:
+       A full dir path (str) to the XML maialib internal samples score directory
+
+    Raises:
+       RuntimeError
+
+    Examples of use:
+
+    >>> import maialib as ml
+    >>> xmlDir = ml.getXmlSamplesDirPath()
+    >>> score = ml.Score(xmlDir + "Bach/cello_suite_1_violin.xml")
+    >>> score.info()
+    '''

maialib/maiapy/plots.pyi

@@ -2,9 +2,102 @@ import maialib.maiacore as mc
 import pandas as pd
 import plotly
 
-__all__ = ['plotPartsActivity', 'plotPianoRoll', 'plotScorePitchEnvelope', 'plotChordsNumberOfNotes']
+def plotPartsActivity(score: mc.Score, **kwargs) -> tuple[plotly.graph_objs._figure.Figure, pd.DataFrame]:
+    '''Plots a timeline graph showing the musical activity of each score instrument
 
-def plotPartsActivity(score: mc.Score, **kwargs) -> tuple[plotly.graph_objs._figure.Figure, pd.DataFrame]: ...
-def plotPianoRoll(score: mc.Score, **kwargs) -> tuple[plotly.graph_objs._figure.Figure, pd.DataFrame]: ...
-def plotScorePitchEnvelope(score: mc.Score, **kwargs) -> tuple[plotly.graph_objs._figure.Figure, pd.DataFrame]: ...
-def plotChordsNumberOfNotes(score: mc.Score, **kwargs) -> tuple[plotly.graph_objs._figure.Figure, pd.DataFrame]: ...
+    Args:
+       score (maialib.Score):  A maialib Score object loaded with a valid MusicXML file
+
+    Kwargs:
+       measureStart (int): Start measure to plot
+       measureEnd (int): End measure to plot
+       partNames (list): A str list that contains the filtered desired score parts to plot
+
+    Returns:
+       A list: [Plotly Figure, The plot data as a Pandas Dataframe]
+
+    Raises:
+       RuntimeError, KeyError
+
+    Examples of use:
+
+    >>> plotPartsActivity(myScore)
+    >>> plotPartsActivity(myScore, measureStart=50)
+    >>> plotPartsActivity(myScore, measureStart=50, measureEnd=100)
+    >>> plotPartsActivity(myScore, measureStart=50, measureEnd=100, partNames=["Violin 1", "Cello"])
+    '''
+def plotPianoRoll(score: mc.Score, **kwargs) -> tuple[plotly.graph_objs._figure.Figure, pd.DataFrame]:
+    '''Plots a piano roll graph showing the musical activity of each score instrument
+
+    Args:
+       score (maialib.Score):  A maialib Score object loaded with a valid MusicXML file
+
+    Kwargs:
+       measureStart (int): Start measure to plot
+       measureEnd (int): End measure to plot
+       partNames (list): A str list that contains the filtered desired score parts to plot
+
+    Returns:
+       A list: [Plotly Figure, The plot data as a Pandas Dataframe]
+
+    Raises:
+       RuntimeError, KeyError
+
+    Examples of use:
+
+    >>> plotPianoRoll(myScore)
+    >>> plotPianoRoll(myScore, measureStart=50)
+    >>> plotPianoRoll(myScore, measureStart=50, measureEnd=100)
+    >>> plotPianoRoll(myScore, measureStart=50, measureEnd=100, partNames=["Violin 1", "Cello"])
+    '''
+def plotScorePitchEnvelope(score: mc.Score, **kwargs) -> tuple[plotly.graph_objs._figure.Figure, pd.DataFrame]:
+    '''Plot a score pitch envelope
+
+    Args:
+       score (maialib.Score):  A maialib Score object loaded with a valid MusicXML file
+
+    Kwargs:
+       numPoints: (int): Number of interpolated points
+       showHigher (bool): Plot the envelop upper limit
+       showLower (bool): Plot the envelop lower limit
+       showMean (bool): Plot the envelop mean curve
+       showMeanOfExtremes (bool): Plot the envelop mean of extremes curve
+
+    Returns:
+       A list: [Plotly Figure, The plot data as a Pandas Dataframe]
+
+    Raises:
+       RuntimeError, KeyError
+
+    Examples of use:
+
+    >>> myScore = ml.Score("/path/to/score.xml")
+    >>> plotScorePitchEnvelope(myScore)
+    >>> plotScorePitchEnvelope(myScore, numPoints=10)
+    >>> plotScorePitchEnvelope(myScore, showLower=False)
+    >>> plotScorePitchEnvelope(myScore, showMean=False, showMean=True)
+    '''
+def plotChordsNumberOfNotes(score: mc.Score, **kwargs) -> tuple[plotly.graph_objs._figure.Figure, pd.DataFrame]:
+    '''Plot chord number of notes varying in time
+
+    Args:
+       score (maialib.Score):  A maialib Score object loaded with a valid MusicXML file
+
+    Kwargs:
+       measureStart (int): Start measure to plot
+       measureEnd (int): End measure to plot
+       numPoints (int): Number of interpolated points
+
+    Returns:
+       A list: [Plotly Figure, The plot data as a Pandas Dataframe]
+
+    Raises:
+       RuntimeError, KeyError
+
+    Examples of use:
+
+    >>> myScore = ml.Score("/path/to/score.xml")
+    >>> plotChordsNumberOfNotes(myScore)
+    >>> plotChordsNumberOfNotes(myScore, numPoints=15)
+    >>> plotChordsNumberOfNotes(myScore, measureStart=10, measureEnd=20)
+    '''

maialib/maiapy/sethares_dissonance.pyi

@@ -4,8 +4,68 @@ import plotly.graph_objects as go
 from maialib import maiacore as mc
 from typing import Callable
 
-__all__ = ['plotSetharesDissonanceCurve', 'plotScoreSetharesDissonance', 'plotChordDyadsSetharesDissonanceHeatmap']
+def plotSetharesDissonanceCurve(fundamentalFreq: float = 440, numPartials: int = 6, ratioLowLimit: float = 1.0, ratioHighLimit: float = 2.3, ratioStepIncrement: float = 0.001, amplCallback: Callable[[list[float]], list[float]] | None = None) -> tuple[go.Figure, pd.DataFrame]:
+    """
+    Compute the Sethares Dissonance Curve of a given base frequency
 
-def plotSetharesDissonanceCurve(fundamentalFreq: float = 440, numPartials: int = 6, ratioLowLimit: float = 1.0, ratioHighLimit: float = 2.3, ratioStepIncrement: float = 0.001, amplCallback: Callable[[list[float]], list[float]] | None = None) -> tuple[go.Figure, pd.DataFrame]: ...
-def plotScoreSetharesDissonance(score: mc.Score, plotType: str = 'line', lineShape: str = 'linear', numPartialsPerNote: int = 6, useMinModel: bool = True, amplCallback: Callable[[list[float]], list[float]] | None = None, dissCallback: Callable[[list[float]], float] | None = None, **kwargs) -> tuple[go.Figure, pd.DataFrame]: ...
-def plotChordDyadsSetharesDissonanceHeatmap(chord: mc.Chord, numPartialsPerNote: int = 6, useMinModel: bool = True, amplCallback: Callable[[list[float]], list[float]] | None = None, dissonanceThreshold: float = 0.1, dissonanceDecimalPoint: int = 2) -> tuple[plotly.graph_objs._figure.Figure, pd.DataFrame]: ...
+    Return
+        A tuple that contains a Plotly figure, and the pair 'ratios' and 'dissonance' lists
+    """
+def plotScoreSetharesDissonance(score: mc.Score, plotType: str = 'line', lineShape: str = 'linear', numPartialsPerNote: int = 6, useMinModel: bool = True, amplCallback: Callable[[list[float]], list[float]] | None = None, dissCallback: Callable[[list[float]], float] | None = None, **kwargs) -> tuple[go.Figure, pd.DataFrame]:
+    '''Plot 2D line graph of the Sethares Dissonance over time
+
+    Args:
+       score (maialib.Score): A maialib Score object loaded with a valid MusicXML file
+       plotType (str): Can be \'line\' or \'scatter\'
+       lineShape (str): Can be \'linear\' or \'spline\'
+       numPartialsPerNote (int): Amount of spectral partials for each note
+       useMinModel (bool): Sethares dissonance values can be computed using the \'minimal amplitude\' model
+                    or the \'product amplitudes\' model. The \'min\' model is a more recent approach
+       amplCallback: Custom user function callback to generate the amplitude of each spectrum partial
+       dissCallback: Custom user function callback to receive all paired partial dissonances and computes 
+                     a single total dissonance value output
+    Kwargs:
+       measureStart (int): Start measure to plot
+       measureEnd (int): End measure to plot
+       numPoints (int): Number of interpolated points
+
+    Returns:
+       A list: [Plotly Figure, The plot data as a Pandas Dataframe]
+
+    Raises:
+       RuntimeError, KeyError
+
+    Examples of use:
+
+    >>> myScore = ml.Score("/path/to/score.xml")
+    >>> ml.plotScoreSetharesDissonance(myScore)
+    >>> ml.plotScoreSetharesDissonance(myScore, numPoints=15)
+    >>> ml.plotScoreSetharesDissonance(myScore, measureStart=10, measureEnd=20)
+    '''
+def plotChordDyadsSetharesDissonanceHeatmap(chord: mc.Chord, numPartialsPerNote: int = 6, useMinModel: bool = True, amplCallback: Callable[[list[float]], list[float]] | None = None, dissonanceThreshold: float = 0.1, dissonanceDecimalPoint: int = 2) -> tuple[plotly.graph_objs._figure.Figure, pd.DataFrame]:
+    '''Plot chord dyads Sethares dissonance heatmap
+
+    Args:
+       chord (maialib.Chord):  A maialib Chord
+
+    Kwargs:
+       numPartialsPerNote (int): Amount of spectral partials for each note
+       useMinModel (bool): Sethares dissonance values can be computed using the \'minimal amplitude\' model
+                    or the \'product amplitudes\' model. The \'min\' model is a more recent approach
+       amplCallback: Custom user function callback to generate the amplitude of each spectrum partial
+       dissonanceThreshold (float): Dissonance threshold to skip small dissonance values
+       dissonanceDecimalPoint (int): Round chord dissonance value in the plot title
+
+    Returns:
+       A list: [Plotly Figure, The plot data as a Pandas Dataframe]
+
+    Raises:
+       RuntimeError, KeyError
+
+    Examples of use:
+
+    >>> import maialib as ml
+    >>> myChord = ml.Chord(["C3", "E3", "G3"])
+    >>> fig, df = plotChordDyadsSetharesDissonanceHeatmap(myChord)
+    >>> fig.show()
+    '''

{maialib-1.6.1.dist-info → maialib-1.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maialib
-Version: 1.6.1
+Version: 1.7.0
 Summary: A C++/Python library to manipulate sheet music data
 Home-page: https://github.com/nyckmaia/maialib
 Author: Nycholas Maia

{maialib-1.6.1.dist-info → maialib-1.7.0.dist-info}/RECORD

@@ -3,16 +3,16 @@ maialib/setup.py,sha256=SRFKCV1MVKftVrdnbrjQkL-ee4nR6pzlaURgwSJgqXU,2221
 maialib/maiacore/__init__.py,sha256=0sK4fUTlwdUaieWSoGvL11TBkw6BebR2cd-MpYpJn1o,81
 maialib/maiacore/__init__.pyi,sha256=68w5bv3qhq6lEK0JNHSWER9zuyQN8mxJV-y3JayNxNA,1472
 maialib/maiacore/Release/__init__.pyi,sha256=ncPiCbsaSZXZUykVnOw-yqVPbE-I285Kj5moTnKTNCU,84
-maialib/maiacore/Release/maiacore.cp311-win_amd64.pyd,sha256=_ae4tO8W7qHs0FGuWk9-P_jQPDIv6oBMTWprepbZ0lM,4430336
-maialib/maiacore/Release/maiacore.pyi,sha256=GJwgP5Zq70Kanxc_fohVuvNGPV5n2t_YmPFPhWkoYes,44715
+maialib/maiacore/Release/maiacore.cp311-win_amd64.pyd,sha256=2w6cbC5UO1U243TTtk6jk1XgO6KX0wPWZqwVNLvYhnQ,4484096
+maialib/maiacore/Release/maiacore.pyi,sha256=pjQSd89thPmoFUQQYuiPo87_6yPzEj0BT3YmCIElnMg,46325
 maialib/maiapy/__init__.py,sha256=Kd9D0GBofeJYa6ampk8C47otrr20uwoTYlJlPyMu6fU,80
 maialib/maiapy/__init__.pyi,sha256=Kd9D0GBofeJYa6ampk8C47otrr20uwoTYlJlPyMu6fU,80
 maialib/maiapy/other.py,sha256=BgoqM8GRyCon00qnYyXWbZTE0WtDYlkg6Z7_xSoHnI4,4172
-maialib/maiapy/other.pyi,sha256=C49D3Hw0xoXKJMoozO3_jRtr43zUDF3k1wwWDATkra4,871
+maialib/maiapy/other.pyi,sha256=kjn7QULRPrLmGCwj0SJzcuJ544Yo4vpduumq3v9CUzg,2242
 maialib/maiapy/plots.py,sha256=_RYvckdfalkbXf-SlozSELWVB1ATyTCGIKBuVs1DrC4,23809
-maialib/maiapy/plots.pyi,sha256=0Zb920t9fvtjxYv7270YUBBC-Q9xkk2uTElj4RM0jxg,629
+maialib/maiapy/plots.pyi,sha256=FCiM2grDLYPqFkyHPG3x0-Y1NbD8L6UfAMWXFMLv5K0,3723
 maialib/maiapy/sethares_dissonance.py,sha256=oDphSv2-jRlCFAk1hcDT4gDjonqX6QP77ybwkRlfu6U,13161
-maialib/maiapy/sethares_dissonance.pyi,sha256=w4mRC-XfFHshQxrDMVE0crvF5Vbbnwm1wnumDYhnvKE,1182
+maialib/maiapy/sethares_dissonance.pyi,sha256=iBoK28luL78I--NeJMxa-CaOYyG7OuvO6qXH7meTGA0,3680
 maialib/xml-scores-examples/Bach_Cello_Suite_1.mxl,sha256=0XGNlcW8o0W7kkeG8j2V_M4eggdOnrxvvvCkpf6x_z4,29622
 maialib/xml-scores-examples/Beethoven_Symphony_5_mov_1.xml,sha256=GHDk53y0lbR9Ajc-63vHDP2tT1BX0ZWfx9jpFDUU5sU,4947722
 maialib/xml-scores-examples/Chopin_Fantasie_Impromptu.mxl,sha256=HkouQ_4bI6XDoGmzJITuU81CzQZE2lQjwl6WNlfZmJA,35727
@@ -20,8 +20,8 @@ maialib/xml-scores-examples/Dvorak_Symphony_9_mov_4.mxl,sha256=s7FGUEmFmgcIdmkZ-
 maialib/xml-scores-examples/Mahler_Symphony_8_Finale.mxl,sha256=F2-QBKNYjBv_sWT-z4LWi1rX84-P3msxtl-g6joA2FQ,229034
 maialib/xml-scores-examples/Mozart_Requiem_Introitus.mxl,sha256=_wc4hMaPhtgocUoL94uVzfVN3TGb08z8Xa2BL4SHfgA,91112
 maialib/xml-scores-examples/Strauss_Also_Sprach_Zarathustra.mxl,sha256=nOQra05RHHDe_dXFs5WBJG2l9R1KQk64urV7lWYC2vw,18863
-maialib-1.6.1.dist-info/LICENSE.txt,sha256=gcuuhKKc5-dwvyvHsXjlC9oM6N5gZ6umYbC8ewW1Yvg,35821
-maialib-1.6.1.dist-info/METADATA,sha256=5B3xlh8haXTDCmqiqmRKl7kX0RIra-7Qx4RjwoNL4-o,7115
-maialib-1.6.1.dist-info/WHEEL,sha256=dCuJ4f0faaLdEJehgDqauYbxfYcPtrcUnDoQw-il14k,101
-maialib-1.6.1.dist-info/top_level.txt,sha256=sZWQaa-Up2ba00WpAxBhOLKM6qQYTpUKJMXgSE0Nc48,17
-maialib-1.6.1.dist-info/RECORD,,
+maialib-1.7.0.dist-info/LICENSE.txt,sha256=gcuuhKKc5-dwvyvHsXjlC9oM6N5gZ6umYbC8ewW1Yvg,35821
+maialib-1.7.0.dist-info/METADATA,sha256=WK6MJV1VPNZCXrytPIvVrH9_j3buhJ3MfPVvY4CbR1s,7115
+maialib-1.7.0.dist-info/WHEEL,sha256=WutsMqxRjo8PALJe8NWxuOYrO2lUIIHDIxhZ8tjc8BY,101
+maialib-1.7.0.dist-info/top_level.txt,sha256=sZWQaa-Up2ba00WpAxBhOLKM6qQYTpUKJMXgSE0Nc48,17
+maialib-1.7.0.dist-info/RECORD,,

{maialib-1.6.1.dist-info → maialib-1.7.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (72.2.0)
+Generator: setuptools (75.3.0)
 Root-Is-Purelib: false
 Tag: cp311-cp311-win_amd64