OSC:: needs the .h file too...
[ardour.git] / gtk2_ardour / sfdb_freesound_mootcher.h
1 /*
2     Copyright (C) 2012 Paul Davis
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 /*sfdb_freesound_mootcher.h****************************************************************************
21
22         Adapted for Ardour by Ben Loftis, March 2008
23         Updated to new Freesound API by Colin Fletcher, November 2011
24
25         Mootcher Online Access to thefreesoundproject website
26         http://freesound.iua.upf.edu/
27
28         GPL 2005 Jorn Lemon
29         mail for questions/remarks: mootcher@twistedlemon.nl
30         or go to the freesound website forum
31
32 *****************************************************************************/
33
34 #include <string>
35 #include <stdio.h>
36 #include <cstring>
37 #include <string>
38 #include <sstream>
39 #include <vector>
40 #include <gtkmm/progressbar.h>
41 //#include <ctime>
42
43 #include "sfdb_ui.h"
44
45 #include "curl/curl.h"
46
47 //--- struct to store XML file
48 struct MemoryStruct {
49         char *memory;
50         size_t size;
51 };
52
53 enum sortMethod {
54         sort_none,              // no sort
55         sort_duration_desc,     // Sort by the duration of the sounds, longest sounds first.
56         sort_duration_asc,      // Same as above, but shortest sounds first.
57         sort_created_desc,      // Sort by the date of when the sound was added. newest sounds first.
58         sort_created_asc,       // Same as above, but oldest sounds first.
59         sort_downloads_desc,    // Sort by the number of downloads, most downloaded sounds first.
60         sort_downloads_asc,     // Same as above, but least downloaded sounds first.
61         sort_rating_desc,       // Sort by the average rating given to the sounds, highest rated first.
62         sort_rating_asc         // Same as above, but lowest rated sounds first.
63 };
64
65
66 class Mootcher: public sigc::trackable, public PBD::ScopedConnectionList
67 {
68 public:
69         Mootcher();
70         ~Mootcher();
71
72         bool            checkAudioFile(std::string originalFileName, std::string ID);
73         bool            fetchAudioFile(std::string originalFileName, std::string ID, std::string audioURL, SoundFileBrowser *caller);
74         std::string     searchText(std::string query, int page, std::string filter, enum sortMethod sort);
75         std::string     searchSimilar(std::string id);
76         void *          threadFunc();
77         SoundFileBrowser *sfb;
78         std::string     audioFileName;
79         std::string     ID;
80
81         /** signal emitted when mootcher reports progress updates during download.
82          * The parameters are current and total numbers of bytes downloaded.
83          */
84         PBD::Signal2<void, double, double> Progress;
85         /** signal emitted when the mootcher has finished downloading. */
86         PBD::Signal0<void> Finished;
87
88
89 private:
90
91         void            ensureWorkingDir();
92
93         std::string     doRequest(std::string uri, std::string params);
94         void            setcUrlOptions();
95
96         static size_t   WriteMemoryCallback(void *ptr, size_t size, size_t nmemb, void *data);
97         static int      progress_callback(void *clientp, double dltotal, double dlnow, double ultotal, double ulnow);
98         std::string     sortMethodString(enum sortMethod sort);
99         std::string     getSoundResourceFile(std::string ID);
100
101         CURL *curl;
102         char errorBuffer[CURL_ERROR_SIZE];      // storage for cUrl error message
103
104         FILE* theFile;
105
106         void updateProgress(double dlnow, double dltotal);
107         void doneWithMootcher();
108
109         Gtk::HBox progress_hbox;
110         Gtk::ProgressBar progress_bar;
111         Gtk::Button cancel_download_btn;
112
113         bool cancel_download;
114         void cancelDownload() {
115                 cancel_download = true;
116                 progress_hbox.hide();
117         }
118
119         std::string basePath;
120         std::string xmlLocation;
121 };
122