
    rh              	      ~   S r SSKJr  SSKJr  SSKJr  SSKrSSKrSSK	r	SSK
r
SSKJr  SSKJr  SSKJr  SS	KJr  SS
KJr  SSKJr  SSKJrJr  SSKJrJr  / SQr " S S\R4                  5      r " S S\R8                  5      r " S S\" S/ SQ5      5      r " S S5      rS0S jr S r!S r"S r#S r$S r%S r&S r'S1S  jr(S1S! jr)S1S" jr*S1S# jr+S1S$ jr,S2S% jr-S3S2S& jjr.S2S' jr/S2S( jr0S1S) jr1 " S* S+\Rd                  5      r3 " S, S-\
Rh                  5      r5/ S.Qr6\7S/:X  a  SSKr\Rp                  " \55        gg)4zn
base classes for searching scores.

See User's Guide, Chapter 43: Searching in and Among Scores for details.
    )annotations)
namedtuple)CallableN)windowed)base)exceptions21)chordduration)note)MeasureStream)filtersiterator)WildcardWildcardDurationSearchMatchStreamSearcherstreamSearchBaserhythmicSearchnoteNameSearchnoteNameRhythmicSearchapproximateNoteSearchapproximateNoteSearchNoRhythmapproximateNoteSearchOnlyRhythmapproximateNoteSearchWeightedtranslateStreamToStringtranslateDiatonicStreamToStringtranslateIntervalsAndSpeedtranslateStreamToStringNoRhythm!translateStreamToStringOnlyRhythmtranslateNoteToByte translateNoteWithDurationToBytestranslateNoteTieToBytetranslateDurationToBytesmostCommonMeasureRhythmsSearchExceptionc                      \ rS rSrSrSrg)r   4   z
a wildcard duration (it might define a duration
in itself, but the methods here will see that it
is a wildcard of some sort)

No difference from any other duration.
 N)__name__
__module____qualname____firstlineno____doc____static_attributes__r*       M/home/james-whalen/.local/lib/python3.13/site-packages/music21/search/base.pyr   r   4   s     	r1   r   c                  ,   ^  \ rS rSrSrU 4S jrSrU =r$ )r   ?   a5  
An object that may have some properties defined, but others not that
matches a single object in a music21 stream.  Equivalent to the
regular expression "."

>>> wc1 = search.Wildcard()
>>> wc1.pitch = pitch.Pitch('C')
>>> st1 = stream.Stream()
>>> st1.append(note.Note('D', type='half'))
>>> st1.append(wc1)
c                D   > [         TU ]  " S0 UD6  [        5       U l        g )Nr*   )super__init__r   r   )selfkeywords	__class__s     r2   r7   Wildcard.__init__K   s    $8$(*r1   r
   )r+   r,   r-   r.   r/   r7   r0   __classcell__)r:   s   @r2   r   r   ?   s    
+ +r1   r   c                  <    \ rS rSr% SrSrSSSSS.rS	\S
'   S rSr	g)r   P   z]
A lightweight object representing the match (if any) for a search.  Derived from namedtuple
r*   z(The first element that matches the list.z%A tuple of all the matching elements.zAThe index in the iterator at which the first element can be foundz+The iterator which produced these elements.elStartelsindexr   zdict[str, str]	_DOC_ATTRc                    SR                  [        U R                  5      [        U R                  5      [        U R
                  5      5      $ )NzASearchMatch(elStart={0}, els=len({1}), index={2}, iterator=[...]))formatreprr@   lenrA   rB   )r8   s    r2   __repr__SearchMatch.__repr__\   s8    RYYDHHtDJJ/?A 	Ar1   N)
r+   r,   r-   r.   r/   	__slots__rC   __annotations__rH   r0   r*   r1   r2   r   r   P   s.     IA:XE	!I~ Ar1   r   r?   c                  J    \ rS rSrSrS
S jrSS jrSS jrSS jrSS jr	Sr
g	)r   a   a  
An object that can search through streams for a set of elements
or notes or something of that sort.

Create a basic Stream first:

>>> thisStream = converter.parse('tinynotation: 3/4 c4. d8 e4 g4. a8 f4. c4. d4')
>>> thisStream.show('text')
{0.0} <music21.stream.Measure 1 offset=0.0>
    {0.0} <music21.clef.TrebleClef>
    {0.0} <music21.meter.TimeSignature 3/4>
    {0.0} <music21.note.Note C>
    {1.5} <music21.note.Note D>
    {2.0} <music21.note.Note E>
{3.0} <music21.stream.Measure 2 offset=3.0>
    {0.0} <music21.note.Note G>
    {1.5} <music21.note.Note A>
    {2.0} <music21.note.Note F>
{6.0} <music21.stream.Measure 3 offset=6.0>
    {0.5} <music21.note.Note C>
    {2.0} <music21.note.Note D>
    {3.0} <music21.bar.Barline type=final>

Let's create something to search for:

>>> c = note.Note('C', quarterLength=1.5)
>>> d = note.Note('D', quarterLength=0.5)
>>> searchList = [c, d]


Now create a StreamSearcher:

>>> ss = search.StreamSearcher(thisStream, searchList)

`searchList` could also be a Stream in itself.

Let's configure it for recursive search and to filter so only notes are there:

>>> ss.recurse = True
>>> ss.filterNotes = True  # or `.filterNotesAndRests`

Alternatively, we could have passed in a StreamIterator instead of `thisStream`.

Now let's configure the algorithms:

>>> ss.algorithms
[<function StreamSearcher.wildcardAlgorithm at 0x111b6e340>]

Wildcard search is a default algorithm that lets you use wildcards.
I suggest you leave it in place and add to the algorithms list.  We can add the
`rhythmAlgorithm` to it:

>>> ss.algorithms.append(search.StreamSearcher.rhythmAlgorithm)
>>> ss.algorithms
[<function StreamSearcher.wildcardAlgorithm at 0x111b6e340>,
 <function StreamSearcher.rhythmAlgorithm at 0x11200000>]


Now run it:

>>> results = ss.run()
>>> results
[SearchMatch(elStart=<music21.note.Note C>, els=len(2), index=0, iterator=[...]),
 SearchMatch(elStart=<music21.note.Note G>, els=len(2), index=3, iterator=[...])]

>>> results[0].elStart.measureNumber
1
>>> results[1].elStart.measureNumber
2


Wildcards can be useful:

>>> searchStream2 = stream.Stream()
>>> searchStream2.append(note.Note(quarterLength=0.5))
>>> searchStream2.append(search.Wildcard())
>>> searchStream2.append(note.Note(quarterLength=1.5))

>>> ss.searchList = searchStream2
>>> results = ss.run()
>>> results
[SearchMatch(elStart=<music21.note.Note D>, els=len(3), index=1, iterator=[...]),
 SearchMatch(elStart=<music21.note.Note A>, els=len(3), index=4, iterator=[...])]
>>> results[0].els
(<music21.note.Note D>, <music21.note.Note E>, <music21.note.Note G>)
>>> [n.duration.quarterLength for n in results[0].els]
[0.5, 1.0, 1.5]


OMIT_FROM_DOCS

>>> emptyS = stream.Stream()
>>> ss.searchList = emptyS
>>> ss.run()
Traceback (most recent call last):
music21.search.base.SearchException: the search Stream or list cannot be empty

why doesn't this work?  thisStream[found].expressions.append(expressions.TextExpression('*'))
c                    Xl         X l        SU l        SU l        SU l        [
        R                  /U l        S U l        g )NF)	streamSearch
searchListrecursefilterNotesfilterNotesAndRestsr   wildcardAlgorithm
algorithmsactiveIterator)r8   rO   rP   s      r2   r7   StreamSearcher.__init__   sD    <H7A"!&). 
 --. 	
 =Ar1   c                "   [        U R                  [        R                  5      (       a  U R                  nOU R                  (       a  U R                  R	                  5       nOU R                  R                  5       nU R                  (       a4  UR                  [        R                  " [        R                  5      5      nOTU R                  (       aC  UR                  [        R                  " [        R                  [        R                  /5      5      nXl        [#        U5      n[%        U5      n[%        U R&                  5      nUS:X  a  [)        S5      e/ nXC:  a  U$ [+        [-        X$5      5       H  u  pgS n[/        U5       HN  n	Xy   n
U
c  Sn  ODU R&                  U	   nU R0                   H  nU" X
U5      nUc  M    O   USL a    OUSL d  ML  S nMP     USLd  Mk  [3        US   XvU R                   5      nUR5                  U5        M     U$ )Nr   )the search Stream or list cannot be emptyFT)
isinstancerO   r   StreamIteratorrQ   iterrS   	addFilterr   ClassFilterr   GeneralNoterR   Noter	   ChordrV   listrG   rP   r'   	enumerater   rangerU   r   append)r8   thisStreamIteratorstreamIteratorElsstreamLengthsearchLengthfoundElsstartPosition	streamElsresultjstreamElsearchElthisAlgorithmsms                 r2   runStreamSearcher.run   s   d'')@)@AA!%!2!2||%)%6%6%>%>%@"%)%6%6%;%;%="''%7%A%A''(8(89&" !!%7%A%A''EKK(@A&" 19=>P9Q,-4??+1!"MNN&(&O(1(;L2[(\$MF<($<# #F??1-%)__M*48DF) &5 U?T>!F# )& U" 1yI\I\]#/ )]2 r1   c                0    [        U[        5      (       a  gg)zR
An algorithm that supports Wildcards -- added by default to the search function.
TN)rZ   r   r8   ro   rp   s      r2   rT    StreamSearcher.wildcardAlgorithm  s     h))r1   c                    [        UR                  [        5      (       a  gUR                  R                  UR                  R                  :w  a  gg )NTF)rZ   r   r   quarterLengthrv   s      r2   rhythmAlgorithmStreamSearcher.rhythmAlgorithm  s?    h'')9::**h.?.?.M.MMr1   c                    [        US5      (       d  g[        US5      (       d  gUR                  UR                  :w  a  gg )NnameF)hasattrr}   rv   s      r2   noteNameAlgorithm StreamSearcher.noteNameAlgorithm  s8    x((x((==HMM)r1   )rV   rU   rR   rS   rQ   rP   rO   N)rO   r   rP   zlist[m21Base.Music21Object])returnzlist[SearchMatch])ro   m21Base.Music21Objectrp   r   )r+   r,   r-   r.   r/   r7   rs   rT   rz   r   r0   r*   r1   r2   r   r   a   s$    bHA9vr1   r   c                   Uc  [        S5      eSnSU R                  ;   a  U nOU R                  5       n[        U5      n[	        U5      n[	        U5      nUS:X  a  [        S5      e/ nXv:  a  U$ [        [        XW5      5       HJ  u  p[        U5       H  nX   nX   nU" X5      nU(       a  M    O   U(       d  M9  UR                  U	5        ML     U$ )z
A basic search function that is used by other search mechanisms,
which takes in a stream or StreamIterator and a searchList or stream
and an algorithm to run on each pair of elements to determine if they match.
Nz%algorithm must be a function not Noner[   r   rY   )	r'   classesrQ   rb   rG   rc   r   rd   re   )thisStreamOrIteratorrP   	algorithmrm   rf   rg   rh   ri   rj   rk   rl   rn   ro   rp   s                 r2   r   r   )  s     EFFF/7771199;/0()Lz?LqIJJH"$-h7H.W$X |$A |H!}Hx2F6 % 6OOM* %Y Or1   c                    S n[        XUS9$ )a  
Takes two streams -- the first is the stream to be searched and the second
is a stream of elements whose rhythms must match the first.  Returns a list
of indices which begin a successful search.

searches are made based on quarterLength.
thus a dotted sixteenth-note and a quadruplet (4:3) eighth
will match each other.

Example 1: First we will set up a simple stream for searching:

>>> thisStream = converter.parse('tinynotation: 3/4 c4. d8 e4 g4. a8 f4. c4. r4')
>>> thisStream.show('text')
{0.0} <music21.stream.Measure 1 offset=0.0>
    {0.0} <music21.clef.TrebleClef>
    {0.0} <music21.meter.TimeSignature 3/4>
    {0.0} <music21.note.Note C>
    {1.5} <music21.note.Note D>
    {2.0} <music21.note.Note E>
{3.0} <music21.stream.Measure 2 offset=3.0>
    {0.0} <music21.note.Note G>
    {1.5} <music21.note.Note A>
    {2.0} <music21.note.Note F>
{6.0} <music21.stream.Measure 3 offset=6.0>
    {0.5} <music21.note.Note C>
    {2.0} <music21.note.Rest quarter>
    {3.0} <music21.bar.Barline type=final>

Now we will search for all dotted-quarter/eighth elements in the Stream:

>>> thisStreamIter = thisStream.recurse().notes

>>> searchStream1 = stream.Stream()
>>> searchStream1.append(note.Note(quarterLength=1.5))
>>> searchStream1.append(note.Note(quarterLength=0.5))

>>> l = search.rhythmicSearch(thisStreamIter, searchStream1)
>>> l
[0, 3]
>>> stream.Stream(thisStreamIter[3:5]).show('text')
{0.0} <music21.note.Note G>
{1.5} <music21.note.Note A>



Slightly more advanced search: we will look for any instances of eighth,
followed by a note (or other element) of any length, followed by a dotted quarter
note.  Again, we will find two instances; this time we will tag them both with
a TextExpression of "*" and then show the original stream:


>>> searchStream2 = stream.Stream()
>>> searchStream2.append(note.Note(quarterLength=0.5))
>>> searchStream2.append(search.Wildcard())
>>> searchStream2.append(note.Note(quarterLength=1.5))
>>> l = search.rhythmicSearch(thisStreamIter, searchStream2)
>>> l
[1, 4]
>>> for found in l:
...     thisStreamIter[found].lyric = '*'
>>> #_DOCS_SHOW thisStream.show()


.. image:: images/searchRhythmic1.*
    :width: 221

Now we can test the search on a real dataset and show the types
of preparation that are needed to make it most likely a success.
We will look through the first movement of Corelli Trio Sonata op. 3 no. 1 (F major)
looking to see how much more common the first search term (dotted-quarter, eighth)
is than the second (eighth, anything, dotted-quarter).  In fact, my hypothesis
was wrong, and the second term is actually more common than the first! (n.b. rests
are being counted here as well as notes)


>>> grave = corpus.parse('corelli/opus3no1/1grave')
>>> term1results = []
>>> term2results = []
>>> for p in grave.parts:
...    pf = p.flatten().stripTies().notesAndRests  # consider tied notes as one long note
...    temp1 = search.rhythmicSearch(pf, searchStream1)
...    temp2 = search.rhythmicSearch(pf, searchStream2)
...    for found in temp1:
...        term1results.append(found)
...    for found in temp2:
...        term2results.append(found)
>>> term1results
[0, 7, 13, 21, 42, 57, 64, 66, 0, 5, 7, 19, 21, 40, 46, 63, 0, 8, 31, 61, 69, 71, 73, 97]
>>> term2results
[5, 29, 95]
>>> float(len(term1results)) / len(term2results)
8.0
c                    SUR                   R                  ;   a  gUR                   R                  U R                   R                  :w  a  gg)Nr   TF)r   r   ry   ro   rp   s     r2   rz   'rhythmicSearch.<locals>.rhythmAlgorithm  s?    !2!2!:!::**h.?.?.M.MMr1   r   r   )r   rP   rz   s      r2   r   r   N  s    | 0XXr1   c                    S n[        XUS9$ )a  
>>> thisStream = converter.parse('tinynotation: 3/4 c4 d8 e c d e f c D E c c4 d# e')
>>> searchList = [note.Note('C'), note.Note('D'), note.Note('E')]
>>> thisStreamIter = thisStream.recurse().notes

>>> search.noteNameSearch(thisStreamIter, searchList)
[0, 3, 7]
>>> searchList2 = [note.Note('C'), search.Wildcard(), note.Note('E')]
>>> search.noteNameSearch(thisStreamIter, searchList2)
[0, 3, 7, 11]
c                    SUR                   ;   a  g[        US5      (       d  g[        U S5      (       d  gUR                  U R                  :w  a  gg)Nr   Tr}   F)r   r~   r}   r   s     r2   r   )noteNameSearch.<locals>.noteNameAlgorithm  sI    )))x((x((==HMM)r1   r   r   )r   rP   r   s      r2   r   r     s    
 0HYZZr1   c                    S n[        XUS9$ )a  
>>> thisStream = converter.parse('tinynotation: 3/4 c4 d8 e c d e f c D E c c4 d# e')
>>> searchList = [note.Note('C'), note.Note('D'), note.Note('E')]
>>> for n in searchList:
...     n.duration.type = 'eighth'
>>> thisStreamIter = thisStream.recurse().notes

>>> search.noteNameRhythmicSearch(thisStreamIter, searchList)
[3, 7]

>>> searchList[0].duration = search.WildcardDuration()
>>> search.noteNameRhythmicSearch(thisStreamIter, searchList)
[0, 3, 7]
c                8   SUR                   ;   a  g[        US5      (       d  g[        U S5      (       d  gUR                  U R                  :w  a  gSUR                  R                   ;   a  gUR                  R                  U R                  R                  :w  a  gg)Nr   Tr}   Fr   )r   r~   r}   r   ry   r   s     r2   noteNameRhythmAlgorithm7noteNameRhythmicSearch.<locals>.noteNameRhythmAlgorithm  s    )))x((x((==HMM)!2!2!:!::**h.?.?.M.MMr1   r   r   )r   rP   r   s      r2   r   r     s     $ 0H_``r1   c                v   SnU R                  5       R                  n[        U5      n/ nU He  nUR                  5       R                  n[        U5      n[        R                  " X$U5      R                  5       n	Xl        UR                  X45        Mg     [        US S9n
U
 Vs/ s H  oS   PM	     nnU$ s  snf )a  
searches the list of otherStreams and returns an ordered list of matches
(each stream will have a new property of matchProbability to show how
well it matches)

>>> s = converter.parse("tinynotation: 4/4 c4 d8 e16 FF a'4 b-")
>>> o1 = converter.parse("tinynotation: 4/4 c4 d8 e GG a' b-4")
>>> o1.id = 'o1'
>>> o2 = converter.parse("tinynotation: 4/4 d#2 f A a' G b")
>>> o2.id = 'o2'
>>> o3 = converter.parse("tinynotation: 4/4 c8 d16 e32 FF32 a'8 b-8")
>>> o3.id = 'o3'
>>> l = search.approximateNoteSearch(s, [o1, o2, o3])
>>> for i in l:
...    print('%s %r' % (i.id, i.matchProbability))
o1 0.666666...
o3 0.333333...
o2 0.083333...
Nc                    SU S   -
  $ N   r   r*   xs    r2   <lambda>'approximateNoteSearch.<locals>.<lambda>      !ad(r1   keyr   )	flattennotesAndRestsr   difflibSequenceMatcherratiomatchProbabilityre   sorted
thisStreamotherStreamsisJunknthisStreamStr
sorterListssnthatStreamStrr   
sortedListr   sortedStreamss                r2   r   r     s    * F**A+A.MJYY[&&/3''}MSSU"5*%  
(:;J#-.:aqT:M. /s   $B6c                   SnU R                  5       R                  R                  5       n[        U5      n/ nU Hs  nUR                  5       R                  R                  5       n[        U5      n[        R
                  " X$U5      R                  5       n	Xl        UR                  X45        Mu     [        US S9n
U
 Vs/ s H  oS   PM	     nnU$ s  snf )az  
searches the list of otherStreams and returns an ordered list of matches
(each stream will have a new property of matchProbability to show how
well it matches)

>>> s = converter.parse("tinynotation: 4/4 c4 d8 e16 FF a'4 b-")
>>> o1 = converter.parse("tinynotation: 4/4 c4 d8 e GG a' b-4")
>>> o1.id = 'o1'
>>> o2 = converter.parse("tinynotation: 4/4 d#2 f A a' G b")
>>> o2.id = 'o2'
>>> o3 = converter.parse("tinynotation: 4/4 c4 d e GG CCC r")
>>> o3.id = 'o3'
>>> l = search.approximateNoteSearchNoRhythm(s, [o1, o2, o3])
>>> for i in l:
...    print('%s %r' % (i.id, i.matchProbability))
o1 0.83333333...
o3 0.5
o2 0.1666666...
Nc                    SU S   -
  $ r   r*   r   s    r2   r   /approximateNoteSearchNoRhythm.<locals>.<lambda>:  r   r1   r   r   )
r   r   streamr    r   r   r   r   re   r   r   s                r2   r   r     s    * F**113A3A6MJYY[&&--/7;''}MSSU"5*%  
(:;J#-.:aqT:M. /    Cc                   SnU R                  5       R                  R                  5       n[        U5      n/ nU Hs  nUR                  5       R                  R                  5       n[        U5      n[        R
                  " X$U5      R                  5       n	Xl        UR                  X45        Mu     [        US S9n
U
 Vs/ s H  oS   PM	     nnU$ s  snf )am  
searches the list of otherStreams and returns an ordered list of matches
(each stream will have a new property of matchProbability to show how
well it matches)

>>> s = converter.parse("tinynotation: 4/4 c4 d8 e16 FF a'4 b-")
>>> o1 = converter.parse("tinynotation: 4/4 c4 d8 e GG a' b-4")
>>> o1.id = 'o1'
>>> o2 = converter.parse("tinynotation: 4/4 d#2 f A a' G b")
>>> o2.id = 'o2'
>>> o3 = converter.parse("tinynotation: 4/4 c4 d e GG CCC r")
>>> o3.id = 'o3'
>>> l = search.approximateNoteSearchOnlyRhythm(s, [o1, o2, o3])
>>> for i in l:
...    print('%s %r' % (i.id, i.matchProbability))
o1 0.5
o3 0.33...
o2 0.0
Nc                    SU S   -
  $ r   r*   r   s    r2   r   1approximateNoteSearchOnlyRhythm.<locals>.<lambda>^  r   r1   r   r   )
r   r   r   r!   r   r   r   r   re   r   r   s                r2   r   r   ?  s    * F**113A5a8MJYY[&&--/9"=''}MSSU"5*%  
(:;J#-.:aqT:M. /r   c                "   SnU R                  5       R                  R                  5       n[        U5      n[	        U5      n/ nU H  nUR                  5       R                  n[        U5      n	[	        U5      n
[
        R                  " UUU	5      R                  5       n[
        R                  " UUU
5      R                  5       nSU-  U-   S-  nXl        UR                  X45        M     [        US S9nU Vs/ s H  oS   PM	     nnU$ s  snf )a  
searches the list of otherStreams and returns an ordered list of matches
(each stream will have a new property of matchProbability to show how
well it matches)

>>> s = converter.parse("tinynotation: 4/4 c4 d8 e16 FF a'4 b-")
>>> o1 = converter.parse("tinynotation: 4/4 c4 d8 e GG2 a' b-4")
>>> o1.id = 'o1'
>>> o2 = converter.parse("tinynotation: 4/4 AAA4 AAA8 AAA16 AAA16 AAA4 AAA4")
>>> o2.id = 'o2'
>>> o3 = converter.parse("tinynotation: 4/4 c8 d16 e32 FF32 a'8 b-8")
>>> o3.id = 'o3'
>>> o4 = converter.parse("tinynotation: 4/4 c1 d1 e1 FF1 a'1 b-1")
>>> o4.id = 'o4'
>>> l = search.approximateNoteSearchWeighted(s, [o1, o2, o3, o4])
>>> for i in l:
...    print('%s %r' % (i.id, i.matchProbability))
o3 0.83333...
o1 0.75
o4 0.75
o2 0.25
N   g      @c                    SU S   -
  $ r   r*   r   s    r2   r   /approximateNoteSearchWeighted.<locals>.<lambda>  r   r1   r   r   )r   r   r   r    r!   r   r   r   r   re   r   )r   r   r   r   thisStreamStrPitchesthisStreamStrDurationr   r   r   thatStreamStrPitchesthatStreamStrDurationratioPitchesratioDurationr   r   r   r   s                    r2   r   r   c  s   0 F**113A:1==a@ JYY[&&>rB A" E ..v/C/CEEJUW 	  //0E0EGGLuw 	 \!M1S8"5*%  
(:;J#-.:aqT:M. /s   :Dc                    Sn/ nU  H5  nU[        U5      -  nU(       d  M  UR                  UR                  5        M7     USL a  U$ X#4$ )a  
takes a stream (or streamIterator) of notesAndRests only and returns
a string for searching on.

>>> s = converter.parse("tinynotation: 3/4 c4 d8 r16 FF8. a'8 b-2.")
>>> sn = s.flatten().notesAndRests
>>> streamString = search.translateStreamToString(sn)
>>> print(streamString)
<P>F<)KQFF_
>>> len(streamString)
12

Chords give the pitch only of the first note and Unpitched objects are
treated as rests:

>>> s = stream.Stream([note.Note('C4'), note.Rest(),
...                    chord.Chord(['C4', 'E4']), note.Unpitched()])
>>> streamString = search.translateStreamToString(s)
>>> list(streamString.encode('utf-8'))
[60, 80, 127, 80, 60, 80, 127, 80]
 F)r#   re   measureNumber)inputStreamOrIteratorreturnMeasuresbmeasuresr   s        r2   r   r     sT    , 	AH"	-a00>OOAOO, # }r1   c                   / n/ nSnSnSnU  GH  nSnU(       a  UR                   nUR                  (       a-  USL a  M1  SnUR                  S5        UR                  U5        MW  SnUSL a+  UR                  b  UR                  R                  S:X  a  SnM  UR                  b  SnUR
                  R                  n	Ub  Xi:X  a  Sn
O
Xi:  a  Sn
OSn
U	n[        [        UR                  S   R                  5      U
-   5      nUR                  U5        UR                  U5        GM     S	R                  U5      nUSL a  U$ X4$ )
a  
Translates a Stream or StreamIterator of Notes and Rests only into a string,
encoding only the .step (no accidental or octave) and whether
the note is slower, faster, or the same speed as the previous
note.

Skips all but the first note of tie. Skips multiple rests in a row

Each note gets one byte:

A-G = note of same length as previous
H-N = note of longer length than previous
O-U = note of shorter length than previous
Z = rest


>>> s = converter.parse("tinynotation: 3/4 c4 d8~ d16 r16 FF8 F#8 a'8 b-2.")
>>> streamString = search.translateDiatonicStreamToString(s.recurse().notesAndRests)
>>> print(streamString)
CRZFFAI
>>> len(streamString)
7

If returnMeasures is True, returns an array of measureNumbers where each entry represents
the measure number of the measure of the object at that character position :

>>> streamString2, measures = search.translateDiatonicStreamToString(s.recurse().notesAndRests,
...                                    returnMeasures=True)
>>> streamString == streamString2
True
>>> measures
[1, 1, 1, 1, 1, 2, 2]
FNTZstopr         r   )r   isRestre   tietyper   ry   chrordpitchesstepjoin)r   r   r   r   previousRestpreviousTie
previousQLr   mNumqlascShiftnewNamejoineds                r2   r   r     s9   F 	AHLKJ"??D88t##% L$uu}

f 4#UUKZZ%%!1H_HH
c!))A,++,x78	? #B WWQZF!!r1   c                B   / n/ nSnSnSnSnU  H/  nUR                   (       d  M  UR                  S   R                  n  O   U  GH=  nSn	U(       a  UR                  n	UR                  (       a-  USL a  M1  SnUR                  S5        UR                  U	5        MW  SnUSL a+  UR                  b  UR                  R                  S:X  a  SnM  UR                  b  SnUR                  R                  n
Ub  Xj:X  a  SnO
Xj:  a  S	nOS
nU
nXxR                  S   R                  -
  nUS:  a  SnOUS:  a  SnUR                  S   R                  n[        SU-   U-   5      nUR                  U	5        UR                  U5        GM@     SR                  U5      nUSL a  U$ X4$ )aB  
Translates a Stream (not StreamIterator) of Notes and Rests only into a string,
encoding only the chromatic distance from the last note and whether
the note is slower, faster, or the same speed as the previous
note.

Skips all but the first note of tie. Skips multiple rests in a row

Each note gets one byte and encodes up from -13 to 13 (all notes > octave are 13 or -13)


>>> s = converter.parse("tinynotation: 3/4 c4 d8~ d16 r16 F8 F#8 F8 a'8 b-2")
>>> sn = s.flatten().notesAndRests.stream()
>>> streamString = search.translateIntervalsAndSpeed(sn)
>>> print(streamString)
Ib RHJ<9
>>> print([ord(x) for x in streamString])
[73, 98, 32, 82, 72, 74, 60, 57]
>>> len(streamString)
8

If returnMeasures is True, returns a triplet of whether the last note
was a rest, whether the last note was tied, what the last quarterLength was, and what the
last pitches' midi number was

which can be fed back into this algorithm:

>>> streamString2, measures = search.translateIntervalsAndSpeed(sn, returnMeasures=True)
>>> streamString == streamString2
True
>>> measures
[1, 1, 1, 1, 1, 2, 2, 2]
FN<   r   T r   )   D   r      i    r   )isNoter   midir   r   re   r   r   r   ry   r   r   )inputStreamr   r   r   r   r   r   previousMidir   r   r   r   pitchDifferencer   r   s                  r2   r   r   	  s   F 	AHLKJL88899Q<,,L 
 ??D88t##% L$uu}

f 4#UUKZZ%%!1H_"HH
&1):)::R Os"!Oyy|((b?*X56	I L WWQZF!!r1   c                    Sn/ nU  H5  nU[        U5      -  nU(       d  M  UR                  UR                  5        M7     U(       a  X#4$ U$ )a  
takes a stream or streamIterator of notesAndRests only and returns
a string for searching on, using translateNoteToByte.

>>> s = converter.parse("tinynotation: 4/4 c4 d e FF a'2 b-2")
>>> sn = s.flatten().notesAndRests
>>> search.translateStreamToStringNoRhythm(sn)
'<>@)QF'

With returnMeasures, will return a tuple of bytes and a list of measure numbers:

>>> search.translateStreamToStringNoRhythm(sn, returnMeasures=True)
('<>@)QF', [1, 1, 1, 1, 2, 2])
r   )r"   re   r   r   r   r   r   r   s        r2   r    r    e  sO     	AH	 ##>OOAOO,  }r1   c                    Sn/ nU  H5  nU[        U5      -  nU(       d  M  UR                  UR                  5        M7     U(       a  X#4$ U$ )a?  
takes a stream or streamIterator of notesAndRests only and returns
a string for searching on.

>>> s = converter.parse("tinynotation: 3/4 c4 d8 e16 FF8. a'8 b-2.")
>>> sn = s.flatten().notesAndRests
>>> streamString = search.translateStreamToStringOnlyRhythm(sn)
>>> print(streamString)
PF<KF_
>>> len(streamString)
6
r   )r%   re   r   r   s        r2   r!   r!     sO     	AH	%a((>OOAOO,  }r1   c                N   [        U [        R                  5      (       a  [        U R                  R
                  5      $ [        U [        R                  5      (       a>  U R                  (       a"  [        U R                  S   R
                  5      $ [        S5      $ [        S5      $ )aw  
takes a note.Note object and translates it to a single byte representation.

currently returns the chr() for the note's midi number. or chr(127) for rests
and unpitched.

>>> n = note.Note('C4')
>>> b = search.translateNoteToByte(n)
>>> b
'<'
>>> ord(b)
60
>>> ord(b) == n.pitch.midi
True

Chords are currently just searched on the first Note (or treated as a Rest if None)
r      )	rZ   r   r`   r   pitchr   r	   ra   r   r   s    r2   r"   r"     sk    & !TYY177<<  	Au{{	#	#99qyy|(())s8O3xr1   c                d    [        U 5      n[        U 5      n[        U 5      nUSL a  X#-   U-   $ X#-   $ )a  
takes a note.Note object and translates it to a three-byte representation.

currently returns the chr() for the note's midi number. or chr(127) for rests
followed by the log of the quarter length (fitted to 1-127, see
:func:`~music21.search.base.translateDurationToBytes`)
followed by 's', 'c', or 'e' if includeTieByte is True and there is a tie.

>>> n = note.Note('C4')
>>> n.duration.quarterLength = 3  # dotted half
>>> trans = search.translateNoteWithDurationToBytes(n)
>>> trans
'<_'
>>> (2**(ord(trans[1])/10.0))/256  # approximately 3
2.828...

>>> n.tie = tie.Tie('stop')
>>> trans = search.translateNoteWithDurationToBytes(n)
>>> trans
'<_e'

>>> trans = search.translateNoteWithDurationToBytes(n, includeTieByte=False)
>>> trans
'<_'
T)r"   r%   r$   )r   includeTieByte	firstByte
secondByte	thirdBytes        r2   r#   r#     sA    6 $A&I)!,J&q)I%	11%%r1   c                    U R                   c  gU R                   R                  S:X  a  gU R                   R                  S:X  a  gU R                   R                  S:X  a  gg)a  
takes a note.Note object and returns a one-byte representation
of its tie status.
's' if start tie, 'e' if stop tie, 'c' if continue tie, and '' if no tie

>>> n = note.Note('E')
>>> search.translateNoteTieToByte(n)
''

>>> n.tie = tie.Tie('start')
>>> search.translateNoteTieToByte(n)
's'

>>> n.tie.type = 'continue'
>>> search.translateNoteTieToByte(n)
'c'

>>> n.tie.type = 'stop'
>>> search.translateNoteTieToByte(n)
'e'
r   startr   continuecr   e)r   r   r   s    r2   r$   r$     sL    . 	uu}	
w		
z	!	
v	r1   c                    SnU R                   R                  (       aO  [        [        R                  " U R                   R                  S-  5      S-  5      n[        [        US5      S5      n[        U5      nU$ )a  
takes a note.Note object and translates it to a two-byte representation

currently returns the chr() for the note's midi number. or chr(127) for rests
followed by the log of the quarter length (fitted to 1-127, see formula below)

>>> n = note.Note('C4')
>>> n.duration.quarterLength = 3  # dotted half
>>> trans = search.translateDurationToBytes(n)
>>> trans
'_'
>>> (2 ** (ord(trans[0]) / 10)) / 256  # approximately 3
2.828...

r      
   r   )r   ry   intmathlog2maxminr   )r   duration1to127r   s      r2   r%   r%     s`    " NzzTYYqzz'?'?#'EFKLS5q9^$Jr1   c                R   / nSnU [             GH  n[        UR                  5      nSnU H1  nUS   U:X  d  M  SnUS==   S-  ss'   US   R                  U5          O   USL d  MY  SUS.nUR                  n	U	 H}  n
[        U
[        R                  5      (       d  M$  S	U	S   R                  R                  -
  n[        R                  " U5      nUR                   H  nUR                  USS
9  M     XS'     O   XHS'   U/US'   UR                  U5        GM     [        US SS9nU$ )a  
returns a sorted list of dictionaries
of the most common rhythms in a stream where
each dictionary contains:

number: the number of times a rhythm appears
rhythm: the rhythm found (with the pitches of the first instance of the rhythm transposed to C5)
measures: a list of measures containing the rhythm
rhythmString: a string representation of the rhythm (see translateStreamToStringOnlyRhythm)


>>> bach = corpus.parse('bwv1.6')
>>> sortedRhythms = search.mostCommonMeasureRhythms(bach)
>>> for in_dict in sortedRhythms[0:3]:
...     print(f"no: {in_dict['number']} rhythmString: {in_dict['rhythmString']}")
...     print('bars: %r' % ([(m.number,
...                               str(m.getContextByClass(stream.Part).id))
...                            for m in in_dict['measures']]))
...     in_dict['rhythm'].show('text')
...     print('-----')
no: 34 rhythmString: PPPP
bars: [(1, 'Soprano'), (2, 'Soprano'), (3, 'Soprano'), ..., (1, 'Alto'), ..., (10, 'Bass')]
{0.0} <music21.note.Note C>
{1.0} <music21.note.Note A>
{2.0} <music21.note.Note F>
{3.0} <music21.note.Note C>
-----
no: 7 rhythmString: ZZ
bars: [(13, 'Soprano'), (14, 'Soprano'), ..., (14, 'Bass')]
{0.0} <music21.note.Note C>
{2.0} <music21.note.Note A>
-----
no: 6 rhythmString: ZPP
bars: [(6, 'Soprano'), (12, 'Soprano'), ..., (18, 'Tenor'), ... (12, 'Bass')]
{0.0} <music21.note.Note C>
{2.0} <music21.note.Note B->
{3.0} <music21.note.Note B->
-----

* Changed in v7: bars are ordered first by number, then by part.
r   FrhythmStringTnumberr   r   )r  r  H   )inPlacerhythmc                    U S   $ )Nr  r*   )ks    r2   r   *mostCommonMeasureRhythms.<locals>.<lambda>b  s    AhKr1   )r   reverse)r   r!   r   re   notesrZ   r   r`   r   pscopydeepcopy	transposer   )streamIntransposeDiatonicreturnDictsdistanceToTransposethisMeasurer  rhythmFoundentrynewDictmeasureNotesmeasureNotethisMeasureCopyr   sortedDictss                 r2   r&   r&     sE   T K(89R9RS E^$4"h1$j!((5 ! % ,G ',,L+k49955*,|A/D/D/G/G*G'&*mmK&@O,22$7F 3 )8H%  , %0!#.-GJw'7 ): *?NKr1   c                      \ rS rSrSrg)r'   if  r*   N)r+   r,   r-   r.   r0   r*   r1   r2   r'   r'   f  s    r1   r'   c                      \ rS rSrS rSrg)Testij  c                2    SSK Jn  U" U [        5       5        g )Nr   )testCopyAll)music21.test.commonTestr%  globals)r8   r%  s     r2   testCopyAndDeepcopyTest.testCopyAndDeepcopyl  s    7D')$r1   r*   N)r+   r,   r-   r.   r(  r0   r*   r1   r2   r#  r#  j  s    %r1   r#  )r   r   r   __main__)N)F)r   znote.GeneralNote)T)9r/   
__future__r   collectionsr   collections.abcr   r  r   r  unittestmore_itertoolsr   music21r   m21Baser   r	   r   r   music21.streamr   r   r   r   __all__Durationr   Music21Objectr   r   r   r   r   r   r   r   r   r   r   r   r   r   r    r!   r"   r#   r$   r%   r&   Music21Exceptionr'   TestCaser#  
_DOC_ORDERr+   mainTestr*   r1   r2   <module>r:     s@  
 # " $     # #      * ,"	x(( 	+w$$ +"A*],ST A"E EP"JeYP[8"aJ!H!H!H0hDM"`Y"x62:!&H F6K\	l33 	%8 %
 zT r1   