Makefile

## scarlatti-keyboard-sonatas Makefile
##
## Programmer:    Craig Stuart Sapp <craig@ccrma.stanford.edu>
## Creation Date: Tue Jun  3 16:52:17 PDT 2014
## Last Modified: Tue Jun  3 16:52:20 PDT 2014
## Filename:      Makefile
## Syntax:        GNU/BSD makefile
##
## Description:   Makefile for basic processing Humdrum data files 
##                for the piano sonatas of Dominico Scarlatti.
##
## To run this makefile, type "make" (without quotes) to see a list 
## of the makefile actions which can be done.
##

# targets which don't actually refer to files:
.PHONY : abc kernscores lilypond mei midi midi-norep musedata musicxml notearray pdf-abc pdf-lilypond pdf-musedata reference-edition

all:
	@echo ''
	@echo 'Run this makefile with one of the following labels:'
	@echo '   "make update"      : download any new changes from online repository.'
	@echo '   "make reference"   : download PDF scans of reference editions.'
	@echo '   "make clean"       : delete data directories created by this makefile.'
	@echo ''
	@echo 'Commands requiring the Humdrum Toolkit to be installed:'
	@echo '   "make census"      : run the census command on all files.'
	@echo ''
	@echo 'Commands requiring Humdrum Extras to be installed.'
	@echo '   "make abc"         : convert to ABC+ files.'
	@echo '   "make kernscores"  : download equivalent from kernscores.'
	@echo '   "make mei"         : convert to MEI files.'
	@echo '   "make midi"        : convert to MIDI files (full repeats)'
	@echo '   "make midi-norep"  : convert to MIDI files (no repeats)'
	@echo '   "make musedata"    : convert to MuseData files.'
	@echo '   "make musicxml"    : convert to MusicXML files.'
	@echo '   "make notearray"   : create notearray files.'
	@echo '   "make searchindex" : create themax search index.'
	@echo ''
	@echo 'Commands requiring other software to be installed.'
	@echo '   "make pdf-abc"     : convert to PDF files with abcm2ps.'
	@echo '   "make pdf-lilypond": convert to PDF files with lilypond.'
	@echo '   "make pdf-musedata": convert to PDF files with muse2ps.'
	@echo ''


############################################################################
##
## General make commands:
##

##############################
#
# make update -- Download any changes in the Github repositories for
#      each composer.  To download for the first time, type:
#           git clone https://github.com/craigsapp/scarlatti-keyboard-sonatas
#

update:       github-pull
pull:         github-pull
github:       github-pull
githubupdate: github-pull
githubpull:   github-pull
github-pull: git-check git-repository-check
	git pull



##############################
#
# make kernscores -- Download scores from the kernScores website
#   (http://kern.humdrum.org).  In theory these are the same as the 
#   files in the kern directory.
#

kernscores: humdrum-extras-check
	mkdir -p kernscores; (cd kernscores && humsplit h://scarlatti/sonatas)
	@echo ""
	@echo "*** Downloaded data from kernScores website into 'kernscores' directory."
	@echo ""



##############################
##
## make reference-edition -- Download scans of the source edition for the
##    encodings from the kernScore website.
##

pdf:           reference-edition
pdfs:          reference-edition
webpdf:        reference-edition
webpdfs:       reference-edition
reference:     reference-edition
reference-pdf: reference-edition
reference-edition:
	-mkdir reference-edition
ifeq ($(shell which wget),)
ifeq ($(shell which curl),)
	# No wget or curl, so don't know how to download
	@echo ""
	@echo "*** Error: don't know how to download from the internet."
	@echo "*** Install wget or curl on your computer and try again."
	@echo ""
else
	# Don't have wget but have curl
	for file in kern/*.krn; do \
	   TBASE=`basename $$file .krn`; \
	   echo "Downloading reference-edition/$$TBASE.pdf"; \
	   curl \
	      "http://kern.humdrum.org/data?l=scarlatti/sonatas&file=$$TBASE.krn&format=pdf" \
	      -o reference-edition/$$TBASE.pdf >& /dev/null; \
	done
	@echo ""
	@echo "*** Download PDF files in 'reference-edition' directory."
	@echo ""
endif
else
	# Have wget
	for file in kern/*.krn; do \
	   TBASE=`basename $$file .krn`; \
	   echo "Downloading reference-edition/$$TBASE.pdf"; \
	   wget -w 3 \
	      "http://kern.humdrum.org/data?l=scarlatti/sonatas&file=$$TBASE.krn&format=pdf" \
	      -O reference-edition/$$TBASE.pdf >& /dev/null; \
	done
	@echo ""
	@echo "*** Download PDF files in 'reference-edition' directory."
	@echo ""
endif



##############################
#
# make clean -- Remove all automatically generated or downloaded data files.  
#     Make sure that you have not added your own content into the directories 
#     in which these derivative files are located; otherwise, these will be 
#     deleted as well.
#

clean:
	-rm -rf abc
	-rm -rf kernscores
	-rm -rf lilypond
	-rm -rf mei
	-rm -rf midi
	-rm -rf midi-norep
	-rm -rf musedata
	-rm -rf musicxml
	-rm -rf notearray
	-rm -rf pdf-abc
	-rm -rf pdf-lilypond
	-rm -rf pdf-musedata
	-rm -rf reference-edition
	-rm searchindex.dat



############################################################################
##
## Humdrum Extras related make commands:
##

##############################
#
# make midi -- Create midi files for music, expanding repeats.
#

midi: humdrum-extras-check
	mkdir -p midi
	for file in kern/*.krn;						\
	do								\
	   TBASE=`basename $$file .krn`;                                \
	   echo Creating midi/$$TBASE.mid;				\
	   thrux $$file | hum2mid -o midi/$$TBASE.mid;			\
	done
	@echo ""
	@echo "*** Created midi data in 'midi' directory."
	@echo ""



##############################
#
# make midi-norep -- Create midi files for music, taking only second
#     endings (performance sequence with minimal repeats).
#

norep:      midi-norep
midinorep:  midi-norep
midi-norep: humdrum-extras-check
	mkdir -p midi-norep
	for file in kern/*.krn;						\
	do								\
	   TBASE=`basename $$file .krn`;                                \
	   echo Creating midi/$$TBASE.mid;				\
	   thrux -v norep $$file | hum2mid -o midi-norep/$$TBASE.mid;	\
	done
	@echo ""
	@echo "*** Created midi data in 'midi-norep' directory."
	@echo ""



##############################
#
# make notearray -- Create notearray files (useful for processing data
# in matlab).  Output is stored in a directory called "notearray".
#

notearray: humdrum-extras-check
	mkdir -p notearray
	for file in kern/*.krn;						\
	do								\
	   TBASE=`basename $$file .krn`;                                \
	   echo Creating notearray/$$TBASE.dat;				\
	   notearray -jicale --mel $$file 				\
		> notearray/$$TBASE.dat;				\
	done
	@echo ""
	@echo "*** Created notearray data in 'notearray' directory."
	@echo ""



##############################
#
# make abc -- Create ABC+ files (useful for printing with abcm2ps).
# Output is stored in a directory called "abc".
#

abc: humdrum-extras-check
	mkdir -p abc
	for file in kern/*.krn;						\
	do								\
	   TBASE=`basename $$file .krn`;				\
	   echo Creating abc/$$TBASE.abc;				\
	   hum2abc $$file > abc/$$TBASE.abc;				\
	done
	@echo ""
	@echo "*** Created abc data in 'abc' directory."
	@echo ""



##############################
#
# make pdf-abc -- Create PDF files with abcm2ps.
# Output is stored in a directory called "pdf-abc".
#

pdf-abc: abcm2ps-check ps2pdf-check humdrum-extras-check
	mkdir -p pdf-abc
	for file in kern/*.krn;						\
	do								\
	   TBASE=`basename $$file .krn`;				\
	   echo Creating pdf-abc/$$TBASE.pdf;				\
	   hum2abc $$file |		  				\
	   abcm2ps - -O - |		  				\
	   ps2pdf -sPAPERSIZE=letter - > pdf-abc/$$TBASE.pdf;		\
	done
	@echo ""
	@echo "*** Created PDF data in 'pdf-abc' directory."
	@echo ""



##############################
#
# make musedata -- Create musedata files (useful for printing with muse2ps).
# Output is stored in a directory called "musedata".
#

musedata: humextra-check
	mkdir -p musedata
	for file in kern/*.krn;						\
	do								\
	   TBASE=`basename $$file .krn`;				\
	   echo Creating musedata/$$TBASE.msd;				\
	   autostem $$file | hum2muse   				\
		> musedata/`basename $$file .krn`.msd;			\
	done
	@echo ""
	@echo "*** Created musedata data in 'musedata' directory."
	@echo ""



##############################
#
# make pdf-musedata -- Create PDF files of graphical notation using muse2ps:
#     http://muse2ps.ccarh.org
#     https://github.com/musedata/muse2ps
# Output is stored in a directory called "pdf-musedata".
#
# To print with this method, you need to install muse2ps from the above
# website, as well as the GhostScript package.  In linux, the ps2pdf
# program can be installed with "yum install ghostscript", or 
# "apt-get install ghostscript".  In OS X if you have installed homebrew:
# "brew install ghostscript", or "port install ghostscript" if you are
# using MacPorts.
#

pdf-musedata: ps2pdf-check muse2ps-check humdrum-extras-check
	mkdir -p pdf-musedata
	for file in kern/*.krn;						\
	do								\
	   TBASE=`basename $$file .krn`;			        \
	   echo Creating pdf-musedata/$$TBASE.pdf;			\
	   autostem $$file | hum2muse | muse2ps =z16j 			\
	      | ps2pdf -sPAPERSIZE=letter - 				\
		> pdf-musedata/$$TBASE.pdf;				\
	done
	@echo ""
	@echo "*** Created PDF files in 'pdf-musedata' directory."
	@echo ""



##############################
#
# make mei -- Create MEI files (useful for printing with verovio).
# Output is stored in a directory called "mei".
#

MEI: mei
mei: humdrum-extras-check
	mkdir -p mei
	for file in kern/*.krn;						\
	do								\
	   TBASE=`basename $$file .krn`;                                \
	   echo Creating mei/$$TBASE.mei;				\
	   autostem $$file | hum2mei > mei/$$TBASE.mei;			\
	done
	@echo ""
	@echo "*** Created MEI data in 'mei' directory."
	@echo ""



##############################
#
# make musicxml -- Create MusicXML files, which are useful for processing with
# various programs/systems.  Output is stored in a directory called "musicxml".
#

musicxml: humdrum-extras-check
	mkdir -p musicxml
	for file in kern/*.krn;						\
	do								\
	   TBASE=`basename $$file .krn`;				\
	   echo Creating musicxml/$$TBASE.xml;				\
	   autostem $$file | hum2xml > musicxml/$$TBASE.xml;		\
	done
	@echo ""
	@echo "*** Created MusicXML data in 'musicxml' directory."
	@echo ""



##############################
#
# make lilypond -- Create lilypond files.
# Output is stored in a directory called "lilypond".
#

lilypond: humdrum-extras-check
	mkdir -p lilypond
	for file in kern/*.krn;						\
	do								\
	   TBASE=`basename $$file .krn`;				\
	   echo Creating lilypond/$$TBASE.ly;				\
	   autostem $$file | hum2xml | musicxml2ly - -o-   		\
	       > lilypond/$$TBASE.ly;					\
	done
	@echo ""
	@echo "*** Created lilypond data in 'lilypond' directory."
	@echo ""



##############################
#
# make pdf-lilypond -- Create lilypond files.
# Output is stored in a directory called "lilypond".
#

pdf-lilypond: humdrum-extras-check lilypond-check
	mkdir -p pdf-lilypond
	for file in kern/*.krn;						\
	do								\
	   TBASE=`basename $$file .krn`;				\
	   echo Creating pdf-lilypond/%%TBASE.pdf;			\
	   autostem $$file | hum2xml | musicxml2ly - -o-   		\
	   | lilypond -f pdf -o pdf-lilypond/$$TBASE - ;		\
	done
	@echo ""
	@echo "*** Created PDF data in 'pdf-lilypond' directory."
	@echo ""



##############################
#
# make searchindex -- Create a themax search index file.  The searchindex.dat
# file can be used with the themax program to search for melodic/rhythmic 
# patterns in the data, such as searching for two successive rising 
# perfect fourths:
#
# Counting the number of occurrences within the data (all voices):
#    themax -I "+P4 +P4" searchindex.dat --total
#
# Count the number of matches by each voice separately:
#    grep ::1 searchindex.dat | themax -I "+P4 +P4" --count
#       (finds 53 matches in the bass part)
#    grep ::2 searchindex.dat | themax -I "+P4 +P4" --count
#       (finds 9 matches in the tenor part)
#    grep ::3 searchindex.dat | themax -I "+P4 +P4" --count
#       (finds 0 matches in the alto part)
#    grep ::4 searchindex.dat | themax -I "+P4 +P4" --count
#       (finds 2 matches in the soprano part)
#
# Counting the number of matches in a file:
#    themax -I "+P4 +P4" searchindex.dat --count
#
# Showing the note-number location of the matches:
#    themax -I "+P4 +P4" searchindex.dat --loc
#
# Resolve note-number locations to measure/beat locations:
#    themax -I "+P4 +P4" searchindex.dat --loc | theloc
#
# Extract measures which contain the matches in a particular work:
#    tindex kern/sonata01-1.krn | themax -I "+P4 +P4" --loc | theloc --mark | myank --marks
#
#

search:	     	searchindex
search-index:	searchindex
searchindex: humdrum-extras-check
	tindex kern/*.krn > searchindex.dat
	@echo ""
	@echo "*** Try the command:"
	@echo "***    themax -P \"e- d f e- d c\" searchindex.dat --loc | theloc"
	@echo "*** To search for a melodic fragment from the start of sonata no. 4."
	@echo "*** The result should be:"
	@echo "***     kern/sonata04-1.krn::1	41=14B7-46=15B5.5"
	@echo "***     kern/sonata04-1.krn::2	12=6B1-17=6B8.5 866=194B1-871=194B8.5"
	@echo "***     kern/sonata04-3.krn::2	65=20B3.5-70=21B3"
	@echo "***     kern/sonata05-3.krn::2	19=3B2-24=3B4.5 423=60B2-428=60B4.5"
	@echo "***     kern/sonata08-1.krn::2	87=9B1.625-92=9B1.9375"
	@echo "***     kern/sonata08-3.krn::2	172=35B2.66667-177=36B1.5 313=57B2.66667-318=58B2.83333"
	@echo "***     kern/sonata11-2.krn::1	326=43B7.75-331=43B11.5"
	@echo "***     kern/sonata11-2.krn::2	173=44B8.5-178=44B12.25"
	@echo "***     kern/sonata19-1.krn::2	110=25B2.25-115=26B1.5 223=45B2.25-228=46B2.75 420=88B2.75-425=89B2.5"
	@echo "***     kern/sonata31-3.krn::2	371=154B5.5-376=155B2.5"
	@echo "***"
	@echo "*** The string 41=14B7-46=15B5.5 in the first match line means that"
	@echo "*** the match starts at note 32 of the part at measure 17, beat 7"
	@echo "*** and goes to note 46 in measure 15, beat 5.5 (should make compound meter beats)."
	@echo ""
	



############################################################################
##
## standard Humdrum Toolkit related make commands:
##

##############################
#
# make census -- Count notes in all score for all composers.
#

census: humdrum-toolkit-check
	census -k kern/*.krn



############################################################################
##
## Check to see if various software packages are installed.
##

##############################
##
## make git-check -- Check to see if the git program is available.
##    If not, then make suggestions for how to install.
##

git-check:
ifeq ($(shell which git),)
	@echo ""
	@echo "*** Error: You must first install the git program."
	@echo "*** In Linux, try:"
	@echo "***    udo yum install git0;31m"
	@echo "*** or"
	@echo "***    udo apt-get install git0;31m"
	@echo "*** In OS X, install Homebrew (https://brew.sh) and then type:"
	@echo "***    rew install git0;31m"
	@echo ""
	exit 1
endif



##############################
##
## make git-repository-check -- Check to see if the directory is part of
##    a git repository.
##

git-repository-check:
ifeq ($(wildcard .git),)
	@echo ""
	@echo "*** Error: To automatically update, you need to have installed"
	@echo "*** this directory with the git command:"
	@echo "***    git clone https://github.com/craigsapp/scarlatti-keyboard-sonatas"
	@echo ""
	exit 1
endif



##############################
##
## make ps2pdf-check -- Check to see if the ps2pdf program, which is a script
##    in the GhostScript software package, is available.  If not, then make
##    suggestions for how to install.
##

ps2pdf-check:
ifeq ($(shell which ps2pdf),)
	@echo ""
	@echo "*** Error: You must first install ps2pdf from the GhostScript package".
	@echo "*** In Linux, try:"
	@echo "***    udo yum install ghostscript0;31m"
	@echo "*** or"
	@echo "***    udo apt-get install ghostscript0;31m"
	@echo "*** In OS X, install Homebrew (https://brew.sh) and then type:"
	@echo "***    rew install ghostscript0;31m"
	@echo ""
	exit 1
endif



##############################
##
## make abcm2ps-check -- Check to see if the abcm2ps program is available.
##    If not, then make suggestions for how to install.
##

abcm2ps-check:
ifeq ($(shell which abcm2ps),)
	@echo ""
	@echo "*** Error: You must first install abcm2ps from:"
	@echo "***    http://moinejf.free.fr"
	@echo ""
	exit 1
endif



##############################
##
## make muse2ps-check -- Check to see if the muse2ps program is available.
##    If not, then make suggestions for how to install.
##

muse2ps-check:
ifeq ($(shell which muse2ps),)
	@echo ""
	@echo "*** Error: You must first install muse2ps from:"
	@echo "***    http://muse2ps.ccarh.org"
	@echo ""
	exit 1
endif



##############################
##
## make lilypond-check -- Check to see if the lilypond program is available.
##    If not, then make suggestions for how to install.
##

lilypond-check:
ifeq ($(shell which lilypond),)
	@echo ""
	@echo "*** Error: You must first install lilypond."
	@echo "*** In Linux, try:"
	@echo "***    udo yum install lilypond0;31m"
	@echo "*** or"
	@echo "***    udo apt-get install lilypond0;31m"
	@echo "*** In OS X, install Homebrew (https://brew.sh) and then type:"
	@echo "***    rew install lilypond0;31m"
	@echo ""
	exit 1
endif



##############################
##
## make humdrum-toolkit-check -- Check to see if the Humdrum Toolkit package
##    is available.  If not, then make suggestions for how to install.
##

humdrum-toolkit-check:
ifeq ($(shell which humdrum),)
	@echo ""
	@echo "*** Error: You must first install the Humdrum Toolkit. See:"
	@echo "***    https://github.com/humdrum-tools/humdrum-tools"
	@echo ""
	exit 1
endif



##############################
##
## make humdrum-extras-check -- Check to see if the Humdrum Extras package
##    is available.  If not, then make suggestions for how to install.
##

humextra-check:      humdrum-extras-check
humdrumextra-check:  humdrum-extras-check
humdrum-extra-check: humdrum-extras-check
humdrum-extras-check:
ifeq ($(shell which keycor),)
	@echo ""
	@echo "*** Error: You must first install the Humdrum Extras. See:"
	@echo "***    https://github.com/humdrum-tools/humdrum-tools"
	@echo ""
	exit 1
endif