audio with time zone conversion; bugfix config with --no-yaml-scan

swoellauer · swoellauer · commit 3e7460a94b17 · 2023-04-20T14:52:22.000+02:00
diff --git a/AudioApp/src/components/browser.vue b/AudioApp/src/components/browser.vue
@@ -146,7 +146,7 @@
           <thead>
             <tr>
               <th class="text-left">Location</th>
-              <th class="text-left">Time</th>
+              <th class="text-left">Time <span style="font-size: 0.7em;">{{time_zone}}</span></th>
               <th class="text-left">Device</th>
               <th class="text-left">Id</th>
               </tr>
@@ -244,6 +244,7 @@ export default defineComponent({
   computed: {
     ...mapState({
       samples_table_count: state => state.project.samples_table_count,
+      time_zone: state => state.project.time_zone,
     }),
     refreshConfirmNeeded() {
       const count = this.samples_table_count;
@@ -416,6 +417,9 @@ export default defineComponent({
             params.end = t + (86400 - 1);
           }          
         }
+        if(this.time_zone) {
+          params.tz = this.time_zone;
+        }
         this.requestError = false;
         this.requestLoading = true;
         var response = await this.$api.get('samples2', { params });
diff --git a/AudioApp/src/pages/project/main.vue b/AudioApp/src/pages/project/main.vue
@@ -8,7 +8,7 @@
         <q-btn :icon="$refs.browser.movePrevSelectedSampleRequested ? 'recycling' : 'navigate_before'" padding="xs" :class="{'element-hidden': $refs.browser.movePrevSelectedSampleRequested || !$refs.browser.hasSelectedSamplePrev}" @click="if(userSelectedLabelNamesChanged) {onSaveLabels();} $refs.browser.movePrevSelectedSampleRequested = true" title="Move to previous sample on the browsed list of samples"/>
         <span class="text-weight-bold" v-if="sample.location"><q-icon name="home"/>{{sample.location}}</span>
         <span class="text-weight-regular text-grey-9" style="padding-left: 10px;" v-if="sample.date"><q-icon name="calendar_today"/>{{sample.date}}</span>
-        <span class="text-weight-light text-grey-7" style="padding-left: 5px;" v-if="sample.time"><q-icon name="query_builder"/>{{sample.time}}</span>
+        <span class="text-weight-light text-grey-9" style="padding-left: 5px;" v-if="sample.time"><q-icon name="query_builder"/>{{sample.time}} <span class="text-weight-light text-grey-7" style="font-size: 0.7em;">{{time_zone}}</span></span>
         <span class="text-weight-thin text-grey-6" style="padding-left: 10px; font-family: monospace;" v-if="sample.device"><q-icon name="memory"/>{{sample.device}}</span>
         <span class="text-weight-bold" v-if="(!sample.location || !sample.device) && sample.date === undefined"><q-icon name="fingerprint"/>{{sample.id}}</span>
         <span class="text-weight-thin text-grey-6" style="padding-left: 10px;" v-if="sampleRate"><q-icon name="leaderboard"/>{{Math.trunc(sampleRate/1000)}}<sup style="font-size: 0.8em">.{{sampleRatemhz}}</sup> kHz</span>
@@ -598,7 +598,9 @@ export default defineComponent({
       player_spectrum_shrink_Factor: state => state.project.player_spectrum_shrink_Factor,
       player_time_expansion_factor: state => state.project.player_time_expansion_factor,
       player_static_lines_frequency: state => state.project.player_static_lines_frequency,
-      player_mouse_move_factor: state => state.project.player_mouse_move_factor, 
+      player_mouse_move_factor: state => state.project.player_mouse_move_factor,
+      time_zone: state => state.project.time_zone,  
+      project_data: state => state.project.data,
     }),
     player_fft_cutoff_lower() {
       let c = Math.floor((this.player_fft_cutoff_lower_frequency *  this.player_fft_window) / this.sampleRate);
@@ -1191,6 +1193,9 @@ export default defineComponent({
       try {
         var urlPath = 'samples2/' + this.selectedSampleId;
         var params = {samples: true, sample_rate: true, labels: true,};
+        if(this.time_zone) {
+          params.tz = this.time_zone;
+        }
         this.sampleLoading = true;
         this.sampleError = false;
         var response = await this.$api.get(urlPath, {params});
@@ -1397,6 +1402,13 @@ export default defineComponent({
     selectedSampleId: {
       immediate: true,   
       async handler() {
+        if(this.project_data !== undefined) {
+          this.refreshSample();
+        }
+      }
+    },
+    async project_data() {
+      if(this.project_data !== undefined) {
         this.refreshSample();
       }
     },
@@ -1460,6 +1472,7 @@ export default defineComponent({
     },    
   },
   async mounted() {
+    //this.$store.dispatch('project/init'); 
     this.audio = new Audio();    
     this.audio.addEventListener('playing', e => this.onAudioPlaying(e));
     this.audio.addEventListener('pause', e => this.onAudioPause(e));
diff --git a/AudioApp/src/store/project.js b/AudioApp/src/store/project.js
@@ -43,6 +43,9 @@ state: {
   detail_fft_window_overlap_percent: 0.75,
   default_detail_fft_window_overlap_percent: 0.75,
 
+  time_zone: 'UTC',
+  default_time_zone: 'UTC',  
+
   profiles: {},
   profileIds: [''],
   profileDefaultId: '(Project defaults)',
@@ -120,6 +123,10 @@ mutations: {
     if(settings.detail_fft_window_overlap_percent !== undefined) {
       state.default_detail_fft_window_overlap_percent = settings.detail_fft_window_overlap_percent;    
     }
+
+    if(settings.time_zone !== undefined) {
+      state.default_time_zone = settings.time_zone;    
+    }
   },
   set(state, settings) {
     if(settings.player_fft_window !== undefined) {
@@ -158,6 +165,10 @@ mutations: {
     if(settings.detail_fft_window_overlap_percent !== undefined) {
       state.detail_fft_window_overlap_percent = settings.detail_fft_window_overlap_percent;    
     }
+
+    if(settings.time_zone !== undefined) {
+      state.time_zone = settings.time_zone;    
+    }
   },  
   setProfile(state, profileID) {
     this.commit('project/setDefaultProfile');
diff --git a/src/audio/AudioProjectConfig.java b/src/audio/AudioProjectConfig.java
@@ -39,6 +39,7 @@ public final class AudioProjectConfig {
 	private final Map<String, AudioProfile> profileMap;
 
 	public final int audio_cache_max_files;
+	public final String time_zone;
 
 	public static class Builder {
 		public String project = "default_project"; // project name is needed
@@ -65,6 +66,7 @@ public static class Builder {
 		public Map<String, AudioProfile> profileMap = null;
 
 		public int audio_cache_max_files = 20;
+		public String time_zone = "UTC";
 
 		public Builder() {}
 
@@ -100,6 +102,7 @@ public Builder(YamlMap yamlMap) {
 			}
 
 			audio_cache_max_files = yamlMap.optInt("audio_cache_max_files", audio_cache_max_files);
+			yamlMap.optFunString("time_zone", s -> time_zone = s);
 		}
 	}
 
@@ -128,6 +131,7 @@ public AudioProjectConfig(Builder builder) {
 		profileMap = builder.profileMap == null ? null : new LinkedHashMap<String, AudioProfile>(builder.profileMap);
 
 		audio_cache_max_files = builder.audio_cache_max_files;
+		time_zone = builder.time_zone;
 		Logger.info(this);
 	}
 
@@ -157,6 +161,7 @@ public String toString() {
 				+ player_fft_cutoff_lower_frequency + ", player_fft_cutoff_upper_frequency="
 				+ player_fft_cutoff_upper_frequency + ", player_mouse_move_factor=" + player_mouse_move_factor
 				+ ", detail_fft_window_overlap_percent=" + detail_fft_window_overlap_percent + ", profileMap="
-				+ profileMap + ", audio_cache_max_files=" + audio_cache_max_files + "]";
+				+ profileMap + ", audio_cache_max_files=" + audio_cache_max_files + ", time_zone="
+				+ time_zone + "]";
 	}
 }
diff --git a/src/audio/CommandlineConfig.java b/src/audio/CommandlineConfig.java
@@ -19,6 +19,7 @@ public Builder(String[] args) {
 				String arg = args[i];
 				switch(arg) {
 				case "--no-yaml-scan":
+					this.no_yaml_scan = true;
 					break;
 				default:
 					throw new RuntimeException("unknown command line arg: |" + arg + "|   available args: --no-yaml-scan");
diff --git a/src/audio/server/api/ProjectHandler.java b/src/audio/server/api/ProjectHandler.java
@@ -75,6 +75,9 @@ private void handleRoot(String project, Request request, HttpServletResponse res
 		String dates_of_location = Web.getString(request, "dates_of_location", null);
 		boolean fInventory = Web.getFlagBoolean(request, "inventory");
 		boolean fSamplesTableCount = Web.getFlagBoolean(request, "samples_table_count");
+		String reqTimeZone = Web.getString(request, "tz", "UTC");
+		int timeZoneOffsetSeconds = AudioTimeUtil.getTimeZoneOffsetSeconds(reqTimeZone);
+		
 		AudioProjectConfig config = broker.config().audioConfig;		
 		if(!config.project.equals(project)) {
 			throw new RuntimeException("unknown project");
@@ -118,6 +121,8 @@ private void handleRoot(String project, Request request, HttpServletResponse res
 		json.value(config.player_mouse_move_factor);
 		json.key("detail_fft_window_overlap_percent");
 		json.value(config.detail_fft_window_overlap_percent);
+		json.key("time_zone");
+		json.value(config.time_zone);		
 		
 		if(config.hasProfiles()) {
 			json.key("profiles");
@@ -180,8 +185,8 @@ private void handleRoot(String project, Request request, HttpServletResponse res
 			json.value(samples_table_count);
 		}
 
-		LongConsumer timestampDateTimeWriter = AudioTimeUtil.timestampDateTimeWriter(json); 		
-		LongConsumer timestampDateWriter = AudioTimeUtil.timestampDateWriter(json);
+		LongConsumer timestampDateTimeWriter = AudioTimeUtil.timestampDateTimeWriter(json, timeZoneOffsetSeconds); 		
+		LongConsumer timestampDateWriter = AudioTimeUtil.timestampDateWriter(json, timeZoneOffsetSeconds);
 
 		if(fTimestamps) {
 			json.key("timestamps");
@@ -231,27 +236,11 @@ private void handleRoot(String project, Request request, HttpServletResponse res
 				json.value(entry.location);
 				if(entry.start != Long.MIN_VALUE) {
 					json.key("start");
-					json.object();
-					json.key("timestamp");
-					json.value(entry.start);
-					LocalDateTime dateTime = AudioTimeUtil.ofAudiotime(entry.start);
-					json.key("date");
-					json.value(dateTime.toLocalDate());
-					json.key("time");
-					json.value(dateTime.toLocalTime());
-					json.endObject();
+					AudioTimeUtil.writeTimestampDateTime(json, entry.start, timeZoneOffsetSeconds);					
 				}
 				if(entry.end != Long.MAX_VALUE) {
 					json.key("end");
-					json.object();
-					json.key("timestamp");
-					json.value(entry.end);
-					LocalDateTime dateTime = AudioTimeUtil.ofAudiotime(entry.end);
-					json.key("date");
-					json.value(dateTime.toLocalDate());
-					json.key("time");
-					json.value(dateTime.toLocalTime());
-					json.endObject();
+					AudioTimeUtil.writeTimestampDateTime(json, entry.end, timeZoneOffsetSeconds);	
 				}
 				json.endObject();
 			});
diff --git a/src/audio/server/api/Sample2Handler.java b/src/audio/server/api/Sample2Handler.java
@@ -120,6 +120,8 @@ private void handleRoot_GET(Sample2 sample, Request request, HttpServletResponse
 		boolean reqSamples = Web.getFlagBoolean(request, "samples");
 		boolean reqSampleRate = Web.getFlagBoolean(request, "sample_rate");
 		boolean reqLabels = Web.getFlagBoolean(request, "labels");
+		String reqTimeZone = Web.getString(request, "tz", "UTC");
+		int timeZoneOffsetSeconds = AudioTimeUtil.getTimeZoneOffsetSeconds(reqTimeZone);
 
 		json.object();
 		json.key("sample");		
@@ -137,7 +139,7 @@ private void handleRoot_GET(Sample2 sample, Request request, HttpServletResponse
 			json.value(sample.device);
 		}
 		if(sample.hasTimestamp()) {
-			AudioTimeUtil.writePropsTimestampDateTime(json, sample.timestamp);
+			AudioTimeUtil.writePropsTimestampDateTime(json, sample.timestamp, timeZoneOffsetSeconds);
 		}
 		if(reqSamples && sample.hasSamples()) {
 			json.key("samples");
diff --git a/src/audio/server/api/Samples2Handler.java b/src/audio/server/api/Samples2Handler.java
@@ -84,6 +84,8 @@ private void handleRoot(Request request, HttpServletResponse response) throws IO
 		boolean flagCount = Web.getFlagBoolean(request, "count");
 		boolean flagDevices = Web.getFlagBoolean(request, "devices");
 		boolean flagSamples = Web.getFlagBoolean(request, "samples");
+		String reqTimeZone = Web.getString(request, "tz", "UTC");
+		int timeZoneOffsetSeconds = AudioTimeUtil.getTimeZoneOffsetSeconds(reqTimeZone);
 
 		Consumer<Sample2> sampleWriter = sample -> {
 			json.object();
@@ -100,7 +102,7 @@ private void handleRoot(Request request, HttpServletResponse response) throws IO
 				//json.key("timestamp");
 				//json.value(sample.timestamp);
 				//Logger.info(sample.timestamp);
-				LocalDateTime dateTime = AudioTimeUtil.ofAudiotime(sample.timestamp);
+				LocalDateTime dateTime = AudioTimeUtil.ofAudiotime(sample.timestamp, timeZoneOffsetSeconds);
 				json.key("date");
 				json.value(dateTime.toLocalDate());
 				json.key("time");
diff --git a/src/audio/task/Task_audio_sample_statistics.java b/src/audio/task/Task_audio_sample_statistics.java
@@ -6,6 +6,9 @@
 import java.text.DecimalFormat;
 import java.text.DecimalFormatSymbols;
 import java.time.Duration;
+import java.time.LocalDateTime;
+import java.time.ZoneOffset;
+import java.time.ZonedDateTime;
 import java.util.Locale;
 
 import org.tinylog.Logger;
@@ -32,10 +35,12 @@
 @Param(name = "col_sample", type = Type.BOOLEAN, preset = "TRUE", description = "Include column 'sample' in CSV output. Folder path including filename.")
 @Param(name = "col_device", type = Type.BOOLEAN, preset = "TRUE", description = "Include column 'device' in CSV output.")
 @Param(name = "col_duration", type = Type.BOOLEAN, preset = "FALSE", description = "Include column 'duration' in CSV output.")
-@Param(name = "col_time_zone", type = Type.BOOLEAN, preset = "FALSE", description = "Include column 'time_zone' in CSV output.")
+@Param(name = "col_original_time_zone", type = Type.BOOLEAN, preset = "FALSE", description = "Include column 'original_time_zone' of recording in CSV output. This may not be identical to the time zone of the 'time' column.")
 @Param(name = "col_temperature", type = Type.BOOLEAN, preset = "FALSE", description = "Include column 'temperature' in CSV output.")
 @Param(name = "col_file_size", type = Type.BOOLEAN, preset = "FALSE", description = "Include column 'file_size' in CSV output and sum up total file size in log message.")
 @Param(name = "filename", type = Type.STRING, preset = "samples.csv", description = "Filename of output CSV-file.")
+@Param(name = "time_zone", type = Type.STRING, preset = "", description = "Set time zone of the 'time' column. e.g. UTC+1  If left empty, default time zone of project will be set.")
+@Param(name = "include_time_zone", type = Type.BOOLEAN, preset = "FALSE", description = "In 'time' column, include the time zone marker. If false, time zone marker is not included in output, but time zone conversions are still applied.")
 @Param(name = "filter_by_location", type = Type.STRING, preset = "", description = "(optional) Process the specified location only.")
 @Param(name = "filter_by_device", type = Type.STRING, preset = "", description = "(optional) Process the specified device id only.")
 @Param(name = "filter_by_time", type = Type.STRING, preset = "", description = "(optional) Process the specified range of time only. Format: yyyy-MM-ddTHH:mm:ss  A shortened format leads to a range of time. e.g. 2022 means all samples from year 2022. e.g. 2022-02 means all samples from February at year 2022.")
@@ -64,10 +69,15 @@ public void run() {
 		boolean col_sample = this.ctx.getParamBoolean("col_sample");
 		boolean col_device = this.ctx.getParamBoolean("col_device");
 		boolean col_duration = this.ctx.getParamBoolean("col_duration");
-		boolean col_time_zone = this.ctx.getParamBoolean("col_time_zone");
+		boolean col_original_time_zone = this.ctx.getParamBoolean("col_original_time_zone");
 		boolean col_temperature = this.ctx.getParamBoolean("col_temperature");
 		boolean col_file_size = this.ctx.getParamBoolean("col_file_size");
 		String filename = this.ctx.getParamString("filename");
+		String reqTimeZone = this.ctx.getParamString("time_zone");
+		boolean include_time_zone = this.ctx.getParamBoolean("include_time_zone");
+		String tz = reqTimeZone.isBlank() ? ctx.broker.config().audioConfig.time_zone : reqTimeZone;
+		int timeZoneOffsetSeconds = AudioTimeUtil.getTimeZoneOffsetSeconds(tz);
+		ZoneOffset timeZoneOffset = include_time_zone ? ZoneOffset.ofTotalSeconds(timeZoneOffsetSeconds) : null;
 		String filter_by_location = this.ctx.getParamString("filter_by_location");
 		String filter_by_device = this.ctx.getParamString("filter_by_device");
 		String filter_by_time = this.ctx.getParamString("filter_by_time");
@@ -103,8 +113,8 @@ public void run() {
 			if(col_duration) {
 				cols.add("duration");	
 			}
-			if(col_time_zone) {
-				cols.add("time_zone");	
+			if(col_original_time_zone) {
+				cols.add("original_time_zone");	
 			}			
 			if(col_temperature) {
 				cols.add("temperature");	
@@ -133,8 +143,15 @@ public void run() {
 						row.add(location);
 					}
 					if(col_time) {
-						String timeName = AudioTimeUtil.ofAudiotime(sample.timestamp).toString();
-						row.add(timeName);
+						LocalDateTime dt = AudioTimeUtil.ofAudiotime(sample.timestamp, timeZoneOffsetSeconds);
+						if(include_time_zone) {
+							ZonedDateTime zdt = ZonedDateTime.of(dt, timeZoneOffset);
+							String timeName = zdt.toString();
+							row.add(timeName);
+						} else {
+							String timeName = dt.toString();
+							row.add(timeName);
+						}
 					}
 					if(col_path || col_filename || col_sample) {
 						Path path = root_data_path.relativize(sample.samplePath);
@@ -165,7 +182,7 @@ public void run() {
 							row.add("NA");
 						}					
 					}
-					if(col_time_zone) {
+					if(col_original_time_zone) {
 						String utc_ = sample.getUTC();
 						String utc = utc_ == null ? "" : utc_;
 						row.add(utc);
diff --git a/src/util/AudioTimeUtil.java b/src/util/AudioTimeUtil.java

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,7 @@ public final class AudioProjectConfig {`
`39`	`39`	`private final Map<String, AudioProfile> profileMap;`
`40`	`40`
`41`	`41`	`public final int audio_cache_max_files;`
	`42`	`+ public final String time_zone;`
`42`	`43`
`43`	`44`	`public static class Builder {`
`44`	`45`	`public String project = "default_project"; // project name is needed`
`@@ -65,6 +66,7 @@ public static class Builder {`
`65`	`66`	`public Map<String, AudioProfile> profileMap = null;`
`66`	`67`
`67`	`68`	`public int audio_cache_max_files = 20;`
	`69`	`+ public String time_zone = "UTC";`
`68`	`70`
`69`	`71`	`public Builder() {}`
`70`	`72`
`@@ -100,6 +102,7 @@ public Builder(YamlMap yamlMap) {`
`100`	`102`	`}`
`101`	`103`
`102`	`104`	`audio_cache_max_files = yamlMap.optInt("audio_cache_max_files", audio_cache_max_files);`
	`105`	`+ yamlMap.optFunString("time_zone", s -> time_zone = s);`
`103`	`106`	`}`
`104`	`107`	`}`
`105`	`108`
`@@ -128,6 +131,7 @@ public AudioProjectConfig(Builder builder) {`
`128`	`131`	`profileMap = builder.profileMap == null ? null : new LinkedHashMap<String, AudioProfile>(builder.profileMap);`
`129`	`132`
`130`	`133`	`audio_cache_max_files = builder.audio_cache_max_files;`
	`134`	`+ time_zone = builder.time_zone;`
`131`	`135`	`Logger.info(this);`
`132`	`136`	`}`
`133`	`137`
`@@ -157,6 +161,7 @@ public String toString() {`
`157`	`161`	`+ player_fft_cutoff_lower_frequency + ", player_fft_cutoff_upper_frequency="`
`158`	`162`	`+ player_fft_cutoff_upper_frequency + ", player_mouse_move_factor=" + player_mouse_move_factor`
`159`	`163`	`+ ", detail_fft_window_overlap_percent=" + detail_fft_window_overlap_percent + ", profileMap="`
`160`		`- + profileMap + ", audio_cache_max_files=" + audio_cache_max_files + "]";`
	`164`	`+ + profileMap + ", audio_cache_max_files=" + audio_cache_max_files + ", time_zone="`
	`165`	`+ + time_zone + "]";`
`161`	`166`	`}`
`162`	`167`	`}`