1 ////////////////////////////////////////////////////////////////////////////// 2 // 3 // Copyright (c) 2004-2021 musikcube team 4 // 5 // All rights reserved. 6 // 7 // Redistribution and use in source and binary forms, with or without 8 // modification, are permitted provided that the following conditions are met: 9 // 10 // * Redistributions of source code must retain the above copyright notice, 11 // this list of conditions and the following disclaimer. 12 // 13 // * Redistributions in binary form must reproduce the above copyright 14 // notice, this list of conditions and the following disclaimer in the 15 // documentation and/or other materials provided with the distribution. 16 // 17 // * Neither the name of the author nor the names of other contributors may 18 // be used to endorse or promote products derived from this software 19 // without specific prior written permission. 20 // 21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 22 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 25 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 26 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 30 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 31 // POSSIBILITY OF SUCH DAMAGE. 32 // 33 ////////////////////////////////////////////////////////////////////////////// 34 #pragma once 35 36 #include <string> 37 #include <vector> 38 #include <functional> 39 #include <limits> 40 41 #include <sigslot/sigslot.h> 42 43 #include <musikcore/library/IIndexer.h> 44 #include <musikcore/library/IQuery.h> 45 #include <musikcore/sdk/ITrack.h> 46 #include <musikcore/runtime/IMessageQueue.h> 47 48 namespace musik { namespace core { 49 50 static size_t kWaitIndefinite = std::numeric_limits<size_t>::max(); 51 52 class ILibrary { 53 public: 54 using QueryPtr = std::shared_ptr<musik::core::db::IQuery>; 55 using Callback = std::function<void(QueryPtr)>; 56 57 enum class Type: int { 58 Local = 1, 59 Remote = 2 60 }; 61 62 enum class ConnectionState: int { 63 Disconnected = 0, 64 Connected = 1, 65 Connecting = 2, 66 AuthenticationFailure = 3 67 }; 68 69 class IResourceLocator { 70 public: 71 virtual std::string GetTrackUri( 72 musik::core::sdk::ITrack* track, 73 const std::string& defaultUri = "") = 0; 74 }; 75 76 sigslot::signal1<musik::core::db::IQuery*> QueryCompleted; 77 sigslot::signal1<ConnectionState> ConnectionStateChanged; 78 ~ILibrary()79 virtual ~ILibrary() { } 80 81 virtual int Enqueue(QueryPtr query, Callback cb = Callback()) = 0; 82 virtual int EnqueueAndWait(QueryPtr query, size_t timeoutMs = kWaitIndefinite, Callback cb = Callback()) = 0; 83 virtual IIndexer *Indexer() = 0; 84 virtual int Id() = 0; 85 virtual const std::string& Name() = 0; 86 virtual void SetMessageQueue(musik::core::runtime::IMessageQueue& queue) = 0; 87 virtual musik::core::runtime::IMessageQueue& GetMessageQueue() = 0; 88 virtual IResourceLocator& GetResourceLocator() = 0; 89 virtual bool IsConfigured() = 0; 90 virtual ConnectionState GetConnectionState() const = 0; 91 virtual Type GetType() const = 0; 92 virtual void Close() = 0; 93 }; 94 95 typedef std::shared_ptr<ILibrary> ILibraryPtr; 96 97 } } 98