OscServer.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 OSC_SERVER_H
#define OSC_SERVER_H
 
#if defined(H2CORE_HAVE_OSC) || _DOXYGEN_
 
#include <lo/lo.h>
 
 
#include <core/Object.h>
#include <cassert>
 
namespace lo
{
        class ServerThread;
}
 
namespace H2Core
{
        class Preferences;
}

class OscServer : public H2Core::Object<OscServer>
{
        H2_OBJECT(OscServer)
        public:
                static OscServer* __instance;
                ~OscServer();
        
                static void create_instance( H2Core::Preferences* pPreferences );
                static OscServer* get_instance() { assert(__instance); return __instance; }

                static QString qPrettyPrint(lo_type type,void * data);
                
                bool init();
                bool start();
                bool stop();
                void handleAction(std::shared_ptr<Action> pAction);

        lo::ServerThread* getServerThread() const;

                static void PLAY_Handler(lo_arg **argv, int i);
                static void PLAY_STOP_TOGGLE_Handler(lo_arg **argv, int i);
                static void PLAY_PAUSE_TOGGLE_Handler(lo_arg **argv, int i);
                static void STOP_Handler(lo_arg **argv, int i);
                static void PAUSE_Handler(lo_arg **argv, int i);
                static void RECORD_READY_Handler(lo_arg **argv, int i);
                static void RECORD_STROBE_TOGGLE_Handler(lo_arg **argv, int i);
                static void RECORD_STROBE_Handler(lo_arg **argv, int i);
                static void RECORD_EXIT_Handler(lo_arg **argv, int i);
                static void MUTE_Handler(lo_arg **argv, int i);
                static void UNMUTE_Handler(lo_arg **argv, int i);
                static void MUTE_TOGGLE_Handler(lo_arg **argv, int i);
                static void NEXT_BAR_Handler(lo_arg **argv, int i);
                static void PREVIOUS_BAR_Handler(lo_arg **argv, int i);
                static void BPM_Handler(lo_arg **argv, int i);
                static void BPM_INCR_Handler(lo_arg **argv, int i);
                static void BPM_DECR_Handler(lo_arg **argv, int i);
                static void MASTER_VOLUME_RELATIVE_Handler(lo_arg **argv, int i);
                static void MASTER_VOLUME_ABSOLUTE_Handler(lo_arg **argv, int i);
                static void STRIP_VOLUME_RELATIVE_Handler(QString param1, QString param2);
                static void STRIP_VOLUME_ABSOLUTE_Handler(int param1, float param2);
                static void SELECT_NEXT_PATTERN_Handler(lo_arg **argv, int i);
                static void SELECT_ONLY_NEXT_PATTERN_Handler(lo_arg **argv, int i);
                static void SELECT_AND_PLAY_PATTERN_Handler(lo_arg **argv, int i);
                static void INSTRUMENT_PITCH_Handler( lo_arg **argv, int t);
                static void FILTER_CUTOFF_LEVEL_ABSOLUTE_Handler(QString param1, QString param2);
                static void BEATCOUNTER_Handler(lo_arg **argv, int i);
                static void TAP_TEMPO_Handler(lo_arg **argv, int i);
                static void PLAYLIST_SONG_Handler(lo_arg **argv, int i);
                static void PLAYLIST_NEXT_SONG_Handler(lo_arg **argv, int i);
                static void PLAYLIST_PREV_SONG_Handler(lo_arg **argv, int i);
                static void TOGGLE_METRONOME_Handler(lo_arg **argv, int i);
                static void SELECT_INSTRUMENT_Handler(lo_arg **argv, int i);
                static void UNDO_ACTION_Handler(lo_arg **argv, int i);
                static void REDO_ACTION_Handler(lo_arg **argv, int argc);
                static void NEW_SONG_Handler(lo_arg **argv, int argc);
                static void OPEN_SONG_Handler(lo_arg **argv, int argc);
                static void SAVE_SONG_Handler(lo_arg **argv, int argc);
                static void SAVE_SONG_AS_Handler(lo_arg **argv, int argc);
                static void SAVE_PREFERENCES_Handler(lo_arg **argv, int argc);
                static void QUIT_Handler(lo_arg **argv, int argc);
                static void TIMELINE_ACTIVATION_Handler(lo_arg **argv, int argc);
                static void TIMELINE_ADD_MARKER_Handler(lo_arg **argv, int argc);
                static void TIMELINE_DELETE_MARKER_Handler(lo_arg **argv, int argc);
                static void JACK_TRANSPORT_ACTIVATION_Handler(lo_arg **argv, int argc);
                static void JACK_TIMEBASE_MASTER_ACTIVATION_Handler(lo_arg **argv, int argc);
                static void SONG_MODE_ACTIVATION_Handler(lo_arg **argv, int argc);
                static void LOOP_MODE_ACTIVATION_Handler(lo_arg **argv, int argc);
                static void RELOCATE_Handler(lo_arg **argv, int argc);
                static void NEW_PATTERN_Handler(lo_arg **argv, int argc);
                static void OPEN_PATTERN_Handler(lo_arg **argv, int argc);
                static void REMOVE_PATTERN_Handler(lo_arg **argv, int argc);
                static void CLEAR_SELECTED_INSTRUMENT_Handler(lo_arg **argv, int argc);
                static void CLEAR_INSTRUMENT_Handler(lo_arg **argv, int argc);
                static void CLEAR_PATTERN_Handler(lo_arg **argv, int argc);

                static void NOTE_ON_Handler(lo_arg **argv, int argc);

                static void NOTE_OFF_Handler(lo_arg **argv, int argc);

                static void SONG_EDITOR_TOGGLE_GRID_CELL_Handler(lo_arg **argv, int argc);
        static void LOAD_DRUMKIT_Handler( lo_arg **argv, int argc );
        static void UPGRADE_DRUMKIT_Handler( lo_arg **argv, int argc );
        static void VALIDATE_DRUMKIT_Handler( lo_arg **argv, int argc );
        static void EXTRACT_DRUMKIT_Handler( lo_arg **argv, int argc );
                static int  generic_handler(const char *path, const char *types, lo_arg ** argv,
                                                                int argc, lo_message data, void *user_data);
        static int incomingMessageLogging(const char *path, const char *types, lo_arg ** argv,
                                                                int argc, lo_message data, void *user_data);
 
        private:
                OscServer( H2Core::Preferences* pPreferences );
                
                void broadcastMessage( const char* msgText, lo_message message);
        
                H2Core::Preferences*                 m_pPreferences;
                bool m_bInitialized;
                lo::ServerThread*                               m_pServerThread;
                std::list<lo_address> m_pClientRegistry;
};
 
inline lo::ServerThread* OscServer::getServerThread() const {
        return m_pServerThread;
}
 
#endif /* H2CORE_HAVE_OSC */
 
#endif // OSC_SERVER_H