jamulussoftware / jamulussoftware/jamulus
Incorporate local timezone in jam recorder folder
- Dominant language
- C
- Stars
- 1.1k
- Forks
- 248
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 9
Description
In an effort to have Jamulus log entries match up with associated jam recorder folder names (without having to manually calculate UTC offsets), it is proposed that the jam recorder folder names incorporate local timezone rather than UTC timezone. The current recording functionality uses UTC date/time only - currentDateTimeUtc(). This would involve revising jamrecorder.cpp to use local timezone date/time - currentDateTime().
To illustrate the problem, current jam recorder folder names are based on UTC time, whereas the associated log entry that initiates the recording is logged using local time. For example:
"Folder Jam-20200423-185758274" - corresponds to log entry - "23.4.2020, 11:57:58, 70.67.70.31, connected"
An alternative solution, as proposed by corrados, is to give users the choice of using either local or UTC timezone in the recorder folder name by using server command-line parameters as per the following comments:
https://github.com/jamulussoftware/jamulus/issues/497#issuecomment-670702534
> "Could we somehow encode that information in the given string? E.g.
> ./Jamulus -s -R [ltz]/home/test/jamulusrecordings
> So that we parse the directory name for a given "[ltz]" at the beginning. Not the nicest solution but would work.
https://github.com/jamulussoftware/jamulus/issues/497#issuecomment-670841260
> We already have command line arguments with combined informations. For consistency to these, we should use this format instead:
> ./Jamulus -s -R "localtimezone;/home/test/jamulusrecordings"
> I.e. we use a ";" as a separator."
Also, having both the jam recorder folder and corresponding log file entry presented in standard ISO format (yyyy-MM-dd HH:mm:ss) would also be helpful to match the two up.
Original post and discussion with detailed example - [sourceforge post](https://sourceforge.net/p/llcon/discussion/server/thread/bdc3c34844/?limit=25#e0c9), have the recorder folder name reflect the current date/time of the local timezone.
Contributor guide
Research direction
Start with jamrecorder.cpp and compare the currentDateTimeUtc() and currentDateTime() paths. Then inspect the server -R command-line parsing and the related discussion to determine whether local time, UTC, or a selectable mode is intended. Done means recorder folder names and log timestamps can be matched without manual offset calculation, using an agreed format.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- audio-video-rtc, cli
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100