pa_jack.c uses deprecated jack_port_get_latency API

[Be-ing]

be@gsuss-iMac portaudio % cmake -D CMAKE_BUILD_TYPE=Debug -S . -B cmake_build

-- The C compiler identification is AppleClang 12.0.5.12050022
-- The CXX compiler identification is AppleClang 12.0.5.12050022
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working C compiler: /Library/Developer/CommandLineTools/usr/bin/cc - skipped
-- Detecting C compile features
-- Detecting C compile features - done
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Check for working CXX compiler: /Library/Developer/CommandLineTools/usr/bin/c++ - skipped
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Looking for pthread.h
-- Looking for pthread.h - found
-- Performing Test CMAKE_HAVE_LIBC_PTHREAD
-- Performing Test CMAKE_HAVE_LIBC_PTHREAD - Success
-- Found Threads: TRUE  
-- Found Regex: POSIX regex.h  
-- Found JACK: /usr/local/lib/libjack.dylib;Regex::regex  
-- Configuring done
-- Generating done
-- Build files have been written to: /Users/be/sw/portaudio/cmake_build
be@gsuss-iMac portaudio % cmake --build cmake_build

...

/Users/be/sw/portaudio/src/hostapi/jack/pa_jack.c:637:17: warning: 'jack_port_get_latency' is deprecated [-Wdeprecated-declarations]
                jack_port_get_latency( p ) / globalSampleRate;
                ^
/usr/local/include/jack/jack.h:1233:58: note: 'jack_port_get_latency' has been explicitly marked deprecated here
jack_nframes_t jack_port_get_latency (jack_port_t *port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
                                                         ^
/usr/local/include/jack/weakmacros.h:80:61: note: expanded from macro 'JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT'
#define JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT __attribute__((__deprecated__))
                                                            ^
/Users/be/sw/portaudio/src/hostapi/jack/pa_jack.c:658:17: warning: 'jack_port_get_latency' is deprecated [-Wdeprecated-declarations]
                jack_port_get_latency( p ) / globalSampleRate;
                ^
/usr/local/include/jack/jack.h:1233:58: note: 'jack_port_get_latency' has been explicitly marked deprecated here
jack_nframes_t jack_port_get_latency (jack_port_t *port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
                                                         ^
/usr/local/include/jack/weakmacros.h:80:61: note: expanded from macro 'JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT'
#define JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT __attribute__((__deprecated__))
                                                            ^
/Users/be/sw/portaudio/src/hostapi/jack/pa_jack.c:1354:65: warning: 'jack_port_get_latency' is deprecated [-Wdeprecated-declarations]
        stream->streamRepresentation.streamInfo.inputLatency = (jack_port_get_latency( stream->remote_output_ports[0] )
                                                                ^
/usr/local/include/jack/jack.h:1233:58: note: 'jack_port_get_latency' has been explicitly marked deprecated here
jack_nframes_t jack_port_get_latency (jack_port_t *port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
                                                         ^
/usr/local/include/jack/weakmacros.h:80:61: note: expanded from macro 'JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT'
#define JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT __attribute__((__deprecated__))
                                                            ^
/Users/be/sw/portaudio/src/hostapi/jack/pa_jack.c:1358:66: warning: 'jack_port_get_latency' is deprecated [-Wdeprecated-declarations]
        stream->streamRepresentation.streamInfo.outputLatency = (jack_port_get_latency( stream->remote_input_ports[0] )
                                                                 ^
/usr/local/include/jack/jack.h:1233:58: note: 'jack_port_get_latency' has been explicitly marked deprecated here
jack_nframes_t jack_port_get_latency (jack_port_t *port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
                                                         ^
/usr/local/include/jack/weakmacros.h:80:61: note: expanded from macro 'JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT'
#define JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT __attribute__((__deprecated__))
                                                            ^
/Users/be/sw/portaudio/src/hostapi/jack/pa_jack.c:1420:62: warning: 'jack_port_get_latency' is deprecated [-Wdeprecated-declarations]
        timeInfo.inputBufferAdcTime = timeInfo.currentTime - jack_port_get_latency( stream->remote_output_ports[0] )
                                                             ^
/usr/local/include/jack/jack.h:1233:58: note: 'jack_port_get_latency' has been explicitly marked deprecated here
jack_nframes_t jack_port_get_latency (jack_port_t *port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
                                                         ^
/usr/local/include/jack/weakmacros.h:80:61: note: expanded from macro 'JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT'
#define JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT __attribute__((__deprecated__))
                                                            ^
/Users/be/sw/portaudio/src/hostapi/jack/pa_jack.c:1423:63: warning: 'jack_port_get_latency' is deprecated [-Wdeprecated-declarations]
        timeInfo.outputBufferDacTime = timeInfo.currentTime + jack_port_get_latency( stream->remote_input_ports[0] )
                                                              ^
/usr/local/include/jack/jack.h:1233:58: note: 'jack_port_get_latency' has been explicitly marked deprecated here
jack_nframes_t jack_port_get_latency (jack_port_t *port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
                                                         ^
/usr/local/include/jack/weakmacros.h:80:61: note: expanded from macro 'JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT'
#define JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT __attribute__((__deprecated__))
                                                            ^

Desktop (please complete the following information):

• OS: macOS, though this affects every OS
• OS Version: 11.2.3
• PortAudio version: master branch (55b97bf)

[philburk]

Here is a Jack doc that says we should use jack_port_get_latency_range()

https://jackaudio.org/api/deprecated.html

[RossBencina]

I am changing this to P2 because #636 (-Werror CI improvements) depends on it being fixed.

[RossBencina]

I'm not sure how JACK defines the min,max range of latency values, and what factors it takes into account, however in PortAudio single value "latency" is defined in PortAudio:

For output the output latency is the time from the callback in invocation to the first callback buffer sample hitting the analog output of the audio interface. Under the assumption that the callback is invoked at the best-case earliest-possible instant.

For input the input latency is the time from the "first callback buffer sample" hitting the analog signal entering the audio interface until the callback is invoked. Under the assumption that the callback is invoked at the best-case earliest-possible instant.

I think for input we just use the JACK "min" value and for output we use the JACK "max" value (converted to appropriate units).

Hopefully this helps someone create a workable patch.