giuliomoro@425: #!/bin/sh
andrewm@58: #
giuliomoro@377: # This script compiles a Bela project on the BeagleBone Black and
andrewm@58: # optionally runs it. Pass a directory path in the first argument. 
andrewm@58: # The source files in this directory are copied to the board and compiled.
andrewm@58: 
giuliomoro@262: # set defaults unless variables are already set
giuliomoro@445: 
giuliomoro@462: SCRIPTDIR=$(dirname "$0")
giuliomoro@462: [ -z $SCRIPTDIR ] && SCRIPTDIR="./" || SCRIPTDIR=$SCRIPTDIR/ 
giuliomoro@462: . $SCRIPTDIR.bela_common || { echo "You must be in Bela/scripts to run these scripts" | exit 1; }  
andrewm@58: 
giuliomoro@512: WATCH="0"
giuliomoro@430: usage()
andrewm@58: {
giuliomoro@512: 	THIS_SCRIPT=`basename "$0"`
giuliomoro@512: 	echo "Usage: $THIS_SCRIPT [-c command-line-args] [-nbfF] <directory-with-source-files>"
giuliomoro@512: 	echo "
giuliomoro@512: 	This script copies a directory of source files to the BeagleBone, compiles
giuliomoro@512: 	and runs it. The Bela core files should have first been copied over
giuliomoro@512: 	using the setup_board.sh script supplied with Bela.
andrewm@58: 
giuliomoro@512: 	The source directory should contain at least one .c, .cpp or .S file.
giuliomoro@512: 	If the argument -n is passed, the output will not be run after compiling.
giuliomoro@512: 	The -c option passes command-line arguments to
giuliomoro@512: 	the Bela program; enclose the argument string in quotes.
giuliomoro@512: 
giuliomoro@512: 	-p arg : sets the name of the project to run (default: $BBB_PROJECT_NAME ) 
giuliomoro@512: 	-r arg : additional folder which contents will be copied to the destination folder. Use this, e.g.: for audio files or Pd/pyo sources
giuliomoro@512: 
giuliomoro@512: 	By default, the project runs in the foreground of the current terminal,
giuliomoro@512: 	within a screen session that can be detached later. The -f argument runs
giuliomoro@512: 	the project in the foreground of the current terminal, without screen, so
giuliomoro@512: 	the output can be piped to another destination. The -b argument runs it
giuliomoro@512: 	in a screen in the background, so no output is shown. The -m argument allows
giuliomoro@512: 	to pass arguments to the Makefile before the run target. For instance,
giuliomoro@512: 	pass -m \`"projectclean"\` or \`-m "distclean"\` to clean project-specific
giuliomoro@512: 	pre-built objects, or all the pre-built objects, respectively."
andrewm@58: }
andrewm@58: 
andrewm@58: OPTIND=1
andrewm@58: 
giuliomoro@512: while [ "$2" != "" ]; do
giuliomoro@512: 	case $1 in
giuliomoro@512: 		-c)
giuliomoro@512: 			shift
giuliomoro@512: 			COMMAND_ARGS="$1"
giuliomoro@512: 		;;
giuliomoro@512: 		-b)
giuliomoro@512: 			RUN_IN_FOREGROUND=0
giuliomoro@512: 		;;
giuliomoro@512: 		-f)
giuliomoro@512: 			RUN_WITHOUT_SCREEN=1
giuliomoro@512: 		;;
giuliomoro@512: 		-n)
giuliomoro@512: 			RUN_PROJECT=0
giuliomoro@512: 		;;
giuliomoro@512: 		-p)
giuliomoro@512: 			shift
giuliomoro@512: 			BBB_PROJECT_NAME="$1"
giuliomoro@512: 		;;	
giuliomoro@512: 		-r)
giuliomoro@512: 			shift
giuliomoro@512: 			# TODO: this option can probably be removed, replaced by including multiple paths as regular positional arguments at the end.
giuliomoro@512: 			ADDITIONAL_PATH="$1"
giuliomoro@512: 		;;
giuliomoro@512: 		-m)
giuliomoro@512: 			shift
giuliomoro@512: 			BBB_MAKEFILE_OPTIONS="$1"
giuliomoro@512: 		;;
giuliomoro@512: 		--watch)
giuliomoro@512: 			WATCH=1
giuliomoro@512: 		;;
giuliomoro@512: 		-h|-\?)
giuliomoro@512: 			usage
giuliomoro@512: 			exit 0
giuliomoro@512: 		;;
giuliomoro@512: 		*)
giuliomoro@512: 			usage
giuliomoro@512: 			exit 1
giuliomoro@512: 		;;
giuliomoro@512: 	esac
giuliomoro@512: 	shift
andrewm@58: done
andrewm@58: 
andrewm@58: 
giuliomoro@439: #Only include all the files if the provided path is not empty
giuliomoro@439: [ -z "$ADDITIONAL_PATH" ] || ADDITIONAL_PATH="$ADDITIONAL_PATH/*"
giuliomoro@439: 
andrewm@58: # Check that we have a directory containing at least one source file
andrewm@58: # as an argument
giuliomoro@64: 
andrewm@58: if [ -z "$1" ]
andrewm@58: then
giuliomoro@512: 	usage
giuliomoro@512: 	exit 2
andrewm@58: fi
andrewm@58: 
giuliomoro@64: FIND_STRING="find $* -maxdepth 10000 -type f "
giuliomoro@472: EXTENSIONS_TO_FIND='\.cpp\|\.c\|\.S\|\.pd'
giuliomoro@472: FOUND_FILES=$($FIND_STRING | grep "$EXTENSIONS_TO_FIND")
giuliomoro@472: if [ -z "$FOUND_FILES" ]
andrewm@58: then
giuliomoro@512: 	 printf "ERROR: Please provide a directory containing .c, .cpp, .S or .pd files.\n\n"
giuliomoro@512: 	 exit
andrewm@58: fi
andrewm@58: 
giuliomoro@275: BBB_PROJECT_FOLDER=$BBB_PROJECT_HOME"/"$BBB_PROJECT_NAME #make sure there is no trailing slash here
giuliomoro@266: BBB_NETWORK_TARGET_FOLDER=$BBB_ADDRESS:$BBB_PROJECT_FOLDER
giuliomoro@266: 
giuliomoro@369: echo "Stopping running process..."
giuliomoro@369: # sets the date and stop running process
giuliomoro@443: ssh $BBB_ADDRESS "date -s \"`date '+%Y%m%d %T %Z'`\" > /dev/null; mkdir -p $BBB_PROJECT_FOLDER; make QUIET=true --no-print-directory -C $BBB_BELA_HOME stop"
giuliomoro@64: 
giuliomoro@64: #concatenate arguments to form path.
giuliomoro@264: HOST_SOURCE_PATH= #initially empty, will be filled with input arguments
giuliomoro@64: for i in "$@" #parse input arguments
giuliomoro@64: do
giuliomoro@512: 	HOST_SOURCE_PATH+=" $1"
giuliomoro@512: 	shift
giuliomoro@512: 	# Copy new souce files to the board
giuliomoro@64: done
andrewm@58: 
giuliomoro@512: # This file is used to keep track of when the last upload was made,
giuliomoro@512: # so to check for modifications if WATCH is active
giuliomoro@512: reference_time_file="$SCRIPTDIR/../tmp/"
giuliomoro@512: uploadBuildRun(){
giuliomoro@512: 	[ $WATCH -eq 1 ] && touch $reference_time_file
giuliomoro@512: 	# Copy new source files to the board
giuliomoro@512: 	echo "Copying new source files to BeagleBone..."
giuliomoro@512: 	if [ -z "`which rsync`" ];
giuliomoro@512: 	then
giuliomoro@512: 		#if rsync is not available, brutally clean the destination folder
giuliomoro@512: 		#and copy over all the files again and recompile them
giuliomoro@512: 		ssh bbb "make --no-print-directory -C $BBB_BELA_HOME sourceclean PROJECT=$BBB_PROJECT_NAME";
giuliomoro@512: 		scp -r $HOST_SOURCE_PATH $ADDITIONAL_PATH "$BBB_NETWORK_TARGET_FOLDER"
giuliomoro@512: 	else
giuliomoro@512: 		#rsync 
giuliomoro@512: 		# --delete makes sure it removes files that are not in the origin folder
giuliomoro@512: 		# -c evaluates changes using md5 checksum instead of file date, so we don't care about time skews 
giuliomoro@512: 		# --no-t makes sure file timestamps are not preserved, so that the Makefile will not think that targets are up to date when replacing files on the BBB
giuliomoro@512: 		#  with older files from the host. This will solve 99% of the issues with Makefile thinking a target is up to date when it is not.
giuliomoro@512: 		rsync -ac --out-format="   %n" --no-t --delete-after --exclude=$BBB_PROJECT_NAME --exclude=build $HOST_SOURCE_PATH"/" $ADDITIONAL_PATH "$BBB_NETWORK_TARGET_FOLDER/" #trailing slashes used here make sure rsync does not create another folder inside the target folder
giuliomoro@512: 	fi
giuliomoro@64: 
giuliomoro@512: 	if [ $? -ne 0 ]
giuliomoro@512: 	then
giuliomoro@512: 		echo "Error while copying files"
giuliomoro@512: 		exit
giuliomoro@512: 	fi
giuliomoro@512: 
giuliomoro@512: 	# Make new Bela executable and run
giuliomoro@512: 	MAKE_COMMAND="make --no-print-directory QUIET=true -C $BBB_BELA_HOME PROJECT='$BBB_PROJECT_NAME' CL='$COMMAND_ARGS' $BBB_MAKEFILE_OPTIONS"
giuliomoro@512: 	if [ $RUN_PROJECT -eq 0 ]
giuliomoro@512: 	then
giuliomoro@512: 		echo "Building project..."
giuliomoro@512: 		ssh $BBB_ADDRESS "$MAKE_COMMAND"
giuliomoro@512: 	else
giuliomoro@512:       echo "Building and running project..."
giuliomoro@512: 	    if [ $WATCH -eq 1 ]
giuliomoro@512: 		then
giuliomoro@512:           if [ $RUN_WITHOUT_SCREEN -eq 1 ];
giuliomoro@512:           then 
giuliomoro@512:               # try to emulate run_without_screen: run with fifo
giuliomoro@512:              ssh $BBB_ADDRESS "$MAKE_COMMAND runscreenfifo" & BACKGROUND_PROCESS_PID=$!
giuliomoro@512:            # run this in the background, it will be killed anyhow when the process stops.
giuliomoro@512:            # Either with the trap below or in another way
giuliomoro@512:              trap "kill $BACKGROUND_PROCESS_PID; exit 0;" 2 9 
giuliomoro@512:            else
giuliomoro@512:              ssh $BBB_ADDRESS "$MAKE_COMMAND runscreen"
giuliomoro@512:            fi
giuliomoro@512: 		else
giuliomoro@512: 		  if [ $RUN_WITHOUT_SCREEN -ne 0 ]
giuliomoro@512: 		  then
giuliomoro@512: 		  	ssh -t $BBB_ADDRESS "$MAKE_COMMAND run"	
giuliomoro@512: 		  elif [ $RUN_IN_FOREGROUND -eq 0 ]
giuliomoro@512: 		  then
giuliomoro@512: 		  	ssh $BBB_ADDRESS "$MAKE_COMMAND runscreen"
giuliomoro@512: 		  else
giuliomoro@512: 		  	ssh -t $BBB_ADDRESS "$MAKE_COMMAND runscreenfg"
giuliomoro@512: 		  fi
giuliomoro@512: 		fi
giuliomoro@512: 	fi
giuliomoro@512: }
giuliomoro@512: # run it once and then (maybe) start waiting for changes
giuliomoro@512: uploadBuildRun
giuliomoro@512: 
giuliomoro@512: if [ $WATCH -ne 0 ]; then
giuliomoro@512: 	while true
giuliomoro@512: 	do
giuliomoro@512: 		echo "Waiting for changes in $HOST_SOURCE_PATH, or press ctrl-c to terminate"
giuliomoro@512: 		CORE_DIR="$SCRIPTDIR/../core"
giuliomoro@512: 		INCLUDE_DIR="$SCRIPTDIR/../include"
giuliomoro@512: 		wait_for_change $HOST_SOURCE_PATH "$reference_time_file" && {
giuliomoro@512: 			echo "Content of "$HOST_SOURCE_PATH" has changed"
giuliomoro@512: 		}
giuliomoro@512: 		echo "Files changed"
giuliomoro@512: 		uploadBuildRun
giuliomoro@512: 	done
giuliomoro@64: fi