pilapse.sh

#!/bin/bash

# Raspi Time Lapse from sunrise to sunset with text overlay,
# Backup on remote Linux server, upload to YouTube.
# Requires libcamera and hdate.

# @Version 5.2.0, 13.01.2025.   added functionality to replace placeholders for YouTube title and description
# @Version 5.2.1, 15.01.2025.   added functionality to replace placeholders in description
# @Version 5.2.2, 16.01.2025.   added more placeholders in description, added flag to enable/disable overlay text, added escape characters for special characters in overlay text

# Configuration file path
script_dir=$(dirname "$(realpath "$0")")
CONFIG_FILE="$script_dir/config.cfg"         # set path to config file

# Read security-relevant variables from config file
if [ -f "$CONFIG_FILE" ]; then
    source "$CONFIG_FILE"
else
    echo "Configuration file $CONFIG_FILE not found. Exiting."
    exit 1
fi

# ------------------------------------------------------------------------------------------------------------------------------------------- 

#### INIT ####
echo "---------------------------------------------------------------------------"
echo "Initialization"

i=1                                                 # Picture counter
fin=1                                               # Flag to continue loop

# Timestamp for filenames and directories
ts_path=$(date +%Y-%m-%d_%H%M%S)
tsfriendly=$(date +%d.%m.%Y)

# Working directory
wdir="$TDIR/$ts_path"
resxy="${RESW}x${RESH}"                             # Image/video size
fr=$(echo "scale=0; 1/$DT" | bc)                    # Calculate frame rate

# Current time
tnow1=$(date +%H:%M:%S)
snow1=$(date +%s -d "$tnow1")

# Get sunrise and sunset times
sunrisesunset=`hdate -q -s -S -l $LONG -L $LAT -z$TIZO`
tsunrise=`echo $sunrisesunset | awk '{ print $6}'`
tsunset=`echo $sunrisesunset | awk '{ print $8}'`

# Convert sunrise and sunset to seconds
ssunrise=$(date +%s -d "$tsunrise")
ssunset=$(date +%s -d "$tsunset")

# Calculate script start and end times
sstart=$((offSTART * 3600))
sstarttime=$((ssunrise - sstart))
send=$((offEND * 3600))
sendtime=$((ssunset + send))

# Wait until start time if not in debug mode
if [ "$debug" -eq 0 ]; then
    offwait=$((sstarttime - snow1))
    offwait=$((offwait < 0 ? 0 : offwait))
    echo "Sunrise at $ssunrise ($tsunrise). Sunset at $ssunset ($tsunset). Offset $offSTART hrs. It is $tnow1. Waiting $offwait second(s)..."
    sleep "$offwait"
else
    echo "Debugging mode is on. Starting immediately."
fi

# Function to replace placeholders in a given string with actual values
replace_placeholders() {
    local input_string="$1"
    local output_string="$input_string"

    # leading zero for image count
    local formatted_i=$(printf "%05d" "$i")
    output_string=$(echo "$output_string" | sed "s|\[IMAGE-COUNT\]|$formatted_i|")

    output_string=$(echo "$output_string" | sed "s|\[SUNRISE\]|$tsunrise|")
    output_string=$(echo "$output_string" | sed "s|\[SUNRISE-OFFSET\]|$offSTART|")
    output_string=$(echo "$output_string" | sed "s|\[SUNSET\]|$tsunset|")
    output_string=$(echo "$output_string" | sed "s|\[SUNSET-OFFSET\]|$offEND|")
    output_string=$(echo "$output_string" | sed "s|\[IMAGE-COUNT\]|$i|")
    output_string=$(echo "$output_string" | sed "s|\[IMAGE-COUNT-FORMATED\]|$formatted_i|")
    output_string=$(echo "$output_string" | sed "s|\[INTERVALL\]|$INTERVALL|")
    output_string=$(echo "$output_string" | sed "s|\[HEIGHT\]|$RESH|")
    output_string=$(echo "$output_string" | sed "s|\[LENGTH\]|$RESW|")
    output_string=$(echo "$output_string" | sed "s|\[FRAMERATE\]|$fr|")
    output_string=$(echo "$output_string" | sed "s|\[FORMATED_DATE\]|$tsfriendly|")
    output_string=$(echo "$output_string" | sed "s|\[FORMATED_DATETIME\]|$tsoverlay|")
    output_string=$(echo "$output_string" | sed "s|\[INT-TEMP\]|$obrdtmp|")
    output_string=$(echo "$output_string" | sed "s|\[WEATHER\]|$weather|")
    output_string=$(echo "$output_string" | sed "s|\[LATITUDE\]|$LATITUDE|")
    output_string=$(echo "$output_string" | sed "s|\[LONGITUDE\]|$LONGITUDE|")
    output_string=$(echo "$output_string" | sed "s|\[PLAYLIST\]|$PLAYLIST|")
    output_string=$(echo "$output_string" | sed "s|\[YOUTUBE-CATEGORY\]|$YOUTUBE_CATEGORY|")
    output_string=$(echo "$output_string" | sed "s|\[YOUTUBE-LANGUAGE\]|$YOUTUBE_LANGUAGE|")
    output_string=$(echo "$output_string" | sed "s|\[YOUTUBE-PRIVACY\]|$YOUTUBE_PRIVACY|")
    output_string=$(echo "$output_string" | sed "s|\[YOUTUBE-TAGS\]|$YOUTUBE_TAGS|")

    echo "$output_string"
}

### INIT END ###


#### INTRO ####
echo "---------------------------------------------------------------------------"
echo "INTRO"
echo "---------------------------------------------------------------------------"

# Create working directory
if mkdir -p "$wdir"; then
    echo "Successfully created $wdir."
else
    echo "Unable to create $wdir."
    exit 1
fi

## INTRO END ##


#### LOOP ####
echo "---------------------------------------------------------------------------"
echo "Loop through capturing images until sunset every $INTERVAL seconds"
echo "or for $z pictures if debug ($debug) is on." 
echo "---------------------------------------------------------------------------"

while [ $fin -eq 1 ]; do
    # Calculate sleep time based on last image capture
    tnow2=$(date +%H:%M:%S)
    snow2=$(date +%s -d "$tnow2")
    sdiff=$((snow2 - snow1))
    tsleep=$((INTERVAL - sdiff))
    tsleep=$((tsleep < 0 ? 0 : tsleep))

    tnow1=$(date +%H:%M:%S)
    snow1=$(date +%s -d "$tnow1")

    # Format picture number
    n=$(printf "%05d" $i)

    # Capture image
    if libcamera-jpeg -n --width "$RESW" --height "$RESH" --output "$wdir/pic_$n.jpg"; then
        echo "Successfully created picture $i as $wdir/pic_$n.jpg."
    else
        echo "Unable to create picture $i as $wdir/pic_$n.jpg."
        exit 1
    fi

    # Add text overlay text to image if enabled in config
    if [ "$OVERLAY_ENABLED" -eq 1 ]; then

        echo "* overlay is enabled."
        
        # Time Date Stamp for overlay
        tsoverlay=$(date "+%d.%m.%Y %H:%M:%S")

        # Get system temperature
        temp=$(cat /sys/class/thermal/thermal_zone0/temp)
        obrdtmp=$(echo "scale=2; $temp / 1000" | bc)

        # Retrieve weather if enabled
        weather=""
        if [ "$WEATHER_ENABLED" -eq 1 ]; then
            echo "* weather is enabled."
            if [ -f "$WFILE" ]; then
                weather=$(cat "$WFILE")
            else
                echo "Weather file $WFILE not found. Skipping weather information."
            fi
        fi

        # Prepare text overlay
        otext=$(replace_placeholders "$OVERLAY_TEXT")
        otext=${otext//:/\\:}
        otext=${otext//,/\\,}
        otext=${otext//|/\\|}
        otext=${otext//°/\\°}
        otext=${otext//%/\\\\\\\\\\\%}
        otext=${otext//(/\\(}
        otext=${otext//)/\\)}
        otext=${otext//#/\\#}
        otext=${otext//\!/\\!}
        otext=${otext//\?/\\?}

        echo "Overlay Text:"
        echo "$otext"

        # Test if font file exists
        if [ -f "$FPATH" ]; then
            echo "Font file $FPATH found. Prooceed."
        else
            echo "Font file $FPATH not found. Exiting."
            exit 1
        fi

        # Add text overlay to image
        if ffmpeg -hide_banner -loglevel panic -i "$wdir/pic_$n.jpg" \
            -vf "drawtext=fontfile='$FPATH':text='$otext':fontcolor=white:fontsize=48:box=1:boxcolor=black@0.5:boxborderw=5:x=w-tw-10:y=h-th-50" "$wdir/pic_txt_$n.jpg"; then
            echo "Successfully added text to picture $i as $wdir/pic_txt_$n.jpg."
        else
            echo "Unable to add text to picture $i as $wdir/pic_txt_$n.jpg."
            exit 1
        fi
    fi

    i=$((i + 1))

    # Check if it's time to end the loop
    if [ $debug -eq 1 ]; then
        echo "Debugging mode is on. Current iteration: $i."
        if [ $i -gt $z ]; then
            echo "Setting exit flag."
            fin=0
        fi
    elif [ $snow1 -gt $sendtime ]; then
        echo "$tnow1 is the time to exit the loop. Sunset at $tsunset. Offset $offEND hrs. Exit continuous image creation."
        fin=0
    fi

    # Sleep for the interval
    echo "Interval is $INTERVAL, difference is $sdiff ($snow2 - $snow1). Sleeping for $tsleep second(s)..."
    sleep "$tsleep"

done

## LOOP END ##


### Video ###
echo "---------------------------------------------------------------------------"
echo "Create Video from $i pictures. Please wait a while..."
echo "---------------------------------------------------------------------------"

finfile="${vidpref}_${tsfriendly}"

# Create video
if ffmpeg -hide_banner -loglevel panic -r "$fr" -i "$wdir/pic_txt_%05d.jpg" "$wdir/$finfile.mp4"; then
    echo "Successfully created final video as $wdir/$finfile.mp4."
else
    echo "Unable to create final video as $wdir/$finfile.mp4."
    exit 1
fi

## Video END ##


#### OUTRO ####
echo "---------------------------------------------------------------------------"
echo "OUTRO"
echo "---------------------------------------------------------------------------"

# Optional SCP upload
if [ "$SCP_UPLOAD_ENABLED" -eq 1 ] && ([ "$debug" -eq 0 ] || [ "$FORCE_SCP_UPLOAD" -eq 1 ]); then
    echo "Uploading video to remote server..."
    scp "$wdir/$finfile.mp4" "$SCP_SERVER_PATH"
else
    echo "No remote server upload since upload is disabled or debug mode is enabled."
fi

# Optional YouTube upload
if [ "$YOUTUBE_UPLOAD_ENABLED" -eq 1 ] && ([ "$debug" -eq 0 ] || [ "$FORCE_YT_UPLOAD" -eq 1 ]); then
    echo "Preparing to upload to YouTube..."

    # Replace placeholders in title
    YOUTUBE_TITLE=$(replace_placeholders "$YOUTUBE_TITLE")
    echo "YouTube title: $YOUTUBE_TITLE"

    # Replace placeholders in description: TODO: Create a function for this
    YOUTUBE_DESC=$(replace_placeholders "$YOUTUBE_DESC")
    echo "YouTube description: $YOUTUBE_DESC"

    # Call youtube-upload script
    python3 $YOUTUBE_SCRIPT_PATH \
    --videofile="$wdir/$finfile.mp4" \
    --title="$YOUTUBE_TITLE" \
    --description="$YOUTUBE_DESC" \
    --category="$YOUTUBE_CATEGORY" \
    --keywords="$YOUTUBE_TAGS" \
    --privacyStatus="$YOUTUBE_PRIVACY" \
    --latitude="$LATITUDE" \
    --longitude="$LONGITUDE" \
    --playlistId="$PLAYLIST" \
    --language="$YOUTUBE_LANGUAGE"
    
else
    echo "No youtube upload since debug mode is enabled and upload not foreced."
fi

# Cleanup
if [ "$debug" -eq 0 ]; then
    echo "Deleting temp directory $wdir."
    rm -r "$wdir"
else
    echo "Won't delete directory $wdir as debugging is enabled."
fi

echo "---------------------------------------------------------------------------"
echo "** All done. **"
echo "---------------------------------------------------------------------------"