JackAudioDriver.h

Go to the documentation of this file.

/*
 * Hydrogen
 * Copyright(c) 2002-2008 by Alex >Comix< Cominu [comix@users.sourceforge.net]
 * Copyright(c) 2008-2025 The hydrogen development team [hydrogen-devel@lists.sourceforge.net]
 *
 * http://www.hydrogen-music.org
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY, without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see https://www.gnu.org/licenses
 *
 */
 
#ifndef H2_JACK_OUTPUT_H
#define H2_JACK_OUTPUT_H
 
#include <core/IO/AudioOutput.h>
#include <core/IO/NullDriver.h>
 
// check if jack support is disabled
#if defined(H2CORE_HAVE_JACK) || _DOXYGEN_
// JACK support is enabled.
 
#include <map>
#include <memory>
#include <pthread.h>
#include <jack/jack.h>
#include <jack/transport.h>
 
#include <core/Globals.h>
 
 
 
namespace H2Core
{
        
class Song;
class Instrument;
class InstrumentComponent;
class TransportPosition;

class JackAudioDriver : public Object<JackAudioDriver>, public AudioOutput
{
        H2_OBJECT(JackAudioDriver)
public:
        enum class Timebase {
                Controller = 1,
                Listener = 0,
                None = -1
        };
        static QString TimebaseToQString( const Timebase& t );
                static Timebase TimebaseFromInt( int nState );
        
        jack_client_t* m_pClient;
        JackAudioDriver( JackProcessCallback m_processCallback );
        ~JackAudioDriver();

        virtual int connect() override;
        virtual void disconnect() override;
        void deactivate();
        virtual unsigned getBufferSize() override;
        virtual unsigned getSampleRate() override;
 
        virtual int getXRuns() const override;

        void clearPerTrackAudioBuffers( uint32_t nFrames );
        
        void makeTrackOutputs( std::shared_ptr<Song> pSong );

        void setConnectDefaults( bool flag ) {
                m_bConnectDefaults = flag;
        }

        bool getConnectDefaults() {
                return m_bConnectDefaults;
        }

        virtual float* getOut_L() override;
        virtual float* getOut_R() override;
        float* getTrackOut_L( unsigned nTrack );
        float* getTrackOut_R( unsigned nTrack );
        float* getTrackOut_L( std::shared_ptr<Instrument> instr, std::shared_ptr<InstrumentComponent> pCompo );
        float* getTrackOut_R( std::shared_ptr<Instrument> instr, std::shared_ptr<InstrumentComponent> pCompo );

        virtual int init( unsigned bufferSize ) override;

        void startTransport();
        void stopTransport();
        void locateTransport( long long nFrame );
        void updateTransportPosition();
 
        void initTimebaseControl();
        void releaseTimebaseControl();
        
        Timebase getTimebaseState() const;
        
        static unsigned long            jackServerSampleRate;
        static jack_nframes_t           jackServerBufferSize;
        static JackAudioDriver*          pJackDriverInstance;
        static int jackServerXRuns;

        static int jackDriverSampleRate( jack_nframes_t nframes, void* param );
        
        static int jackDriverBufferSize( jack_nframes_t nframes, void* arg );
        static int jackXRunCallback( void* arg );

        float getTimebaseControllerBpm() const;

        void relocateUsingBBT();
                bool checkBBTPos() const;
 
                const jack_position_t& getJackPosition() const;
 
                static bool isBBTValid( const jack_position_t& pos );
                static double bbtToTick( const jack_position_t& pos );
                static void transportToBBT( const TransportPosition& transportPos,
                                                                        jack_position_t* pPos );
                static QString JackTransportPosToQString( const jack_position_t& pPos );
 
                friend class AudioEngineTests;
private:

                enum class TimebaseTracking {
                        Valid,
                        OnHold,
                        None
                };
                static QString TimebaseTrackingToQString( const TimebaseTracking& t );

        static void JackTimebaseCallback( jack_transport_state_t state,
                                            jack_nframes_t nFrames,
                                            jack_position_t* pJackPosition,
                                            int new_pos,
                                            void* arg );     
        static void jackDriverShutdown( void* arg );
 
        static QString JackTransportStateToQString( const jack_transport_state_t& pPos );

        void printState() const;

        void setTrackOutput( int n, std::shared_ptr<Instrument> instr, std::shared_ptr<InstrumentComponent> pCompo, std::shared_ptr<Song> pSong );
        JackProcessCallback             m_processCallback;
        jack_port_t*                    m_pOutputPort1;
        jack_port_t*                    m_pOutputPort2;
        QString                         m_sOutputPortName1;
        QString                         m_sOutputPortName2;
        int                             m_trackMap[MAX_INSTRUMENTS][MAX_COMPONENTS];
        int                             m_nTrackPortCount;
        jack_port_t*                    m_pTrackOutputPortsL[MAX_INSTRUMENTS];
        jack_port_t*                    m_pTrackOutputPortsR[MAX_INSTRUMENTS];

        jack_transport_state_t          m_JackTransportState;
        jack_position_t                 m_JackTransportPos;

        jack_position_t                 m_nextJackTransportPos;

        bool                            m_bConnectDefaults;
 
        Timebase m_timebaseState;

                TimebaseTracking m_timebaseTracking;

                float m_fLastTimebaseBpm;

                long long m_nTimebaseFrameOffset;

                int m_lastTransportBits;
 
#ifdef HAVE_INTEGRATION_TESTS
                static long m_nIntegrationLastRelocationFrame;
                bool m_bIntegrationRelocationLoop;
                bool m_bIntegrationCheckRelocationLoop;
#endif
};
 
}; // H2Core namespace
 
 
#else // H2CORE_HAVE_JACK
// JACK is disabled
 
namespace H2Core {
class JackAudioDriver : public NullDriver {
        H2_OBJECT(JackAudioDriver)
public:
        enum class Timebase {
                Controller = 1,
                Listener = 0,
                None = -1
        };
        static QString TimebaseToQString( const Timebase& t ) { return "Not supported"; };
                static Timebase TimebaseFromInt( int nState ) { return Timebase::None; };
        JackAudioDriver( audioProcessCallback m_processCallback ) : NullDriver( m_processCallback ) {}
 
        // Required since these functions are a friend of AudioEngine which
        // need to be build even if no JACK support is desired.
        void updateTransportPosition() {}
        void relocateUsingBBT() {}
};
 
}; // H2Core namespace
 
 
#endif // H2CORE_HAVE_JACK
 
#endif