update VstTimeInfo structure, from Qtractor's version of vestige, which has all field...
[ardour.git] / gtk2_ardour / sfdb_freesound_mootcher.cc
index 6833bae7684c44320878837fae3958b9bd0b770d..8e57d9a0c44bab7b7702047202485b89ef5086a4 100644 (file)
 #include "sfdb_freesound_mootcher.h"\r
 \r
 #include "pbd/xml++.h"\r
+#include "pbd/error.h"\r
 \r
 #include <sys/stat.h>\r
 #include <sys/types.h>\r
 #include <iostream>\r
 \r
+#include <glib.h>\r
+#include <glib/gstdio.h>\r
+\r
+#include "i18n.h"\r
+\r
 #include "ardour/audio_library.h"\r
+#include "ardour/rc_configuration.h"\r
+#include "pbd/pthread_utils.h"\r
+#include "gui_thread.h"\r
+\r
+using namespace PBD;\r
 \r
 static const std::string base_url = "http://www.freesound.org/api";\r
 static const std::string api_key = "9d77cb8d841b4bcfa960e1aae62224eb"; // ardour3\r
 \r
-\r
 //------------------------------------------------------------------------\r
-Mootcher::Mootcher(const char *saveLocation)\r
+Mootcher::Mootcher()\r
        : curl(curl_easy_init())\r
 {\r
-       changeWorkingDir(saveLocation);\r
+       cancel_download_btn.set_label (_("Cancel"));\r
+       progress_hbox.pack_start (progress_bar, true, true);\r
+       progress_hbox.pack_end (cancel_download_btn, false, false);\r
+       progress_bar.show();\r
+       cancel_download_btn.show();\r
+       cancel_download_btn.signal_clicked().connect(sigc::mem_fun (*this, &Mootcher::cancelDownload));\r
 };\r
 //------------------------------------------------------------------------\r
 Mootcher:: ~Mootcher()\r
 {\r
+       curl_easy_cleanup(curl);\r
 }\r
 \r
 //------------------------------------------------------------------------\r
-const char* Mootcher::changeWorkingDir(const char *saveLocation)\r
+\r
+void Mootcher::ensureWorkingDir ()\r
 {\r
-       basePath = saveLocation;\r
+       std::string p = ARDOUR::Config->get_freesound_download_dir();\r
+\r
+       if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {\r
+               if (g_mkdir_with_parents (p.c_str(), 0775) != 0) {\r
+                       PBD::error << "Unable to create Mootcher working dir" << endmsg;\r
+               }\r
+       }\r
+       basePath = p;\r
 #ifdef __WIN32__\r
        std::string replace = "/";\r
        size_t pos = basePath.find("\\");\r
@@ -75,18 +99,8 @@ const char* Mootcher::changeWorkingDir(const char *saveLocation)
                pos = basePath.find("\\");\r
        }\r
 #endif\r
-       //\r
-       size_t pos2 = basePath.find_last_of("/");\r
-       if(basePath.length() != (pos2+1)) basePath += "/";\r
-\r
-       // create Freesound directory and sound dir\r
-       std::string sndLocation = basePath;\r
-       mkdir(sndLocation.c_str(), 0777);\r
-       sndLocation += "snd";\r
-       mkdir(sndLocation.c_str(), 0777);\r
-\r
-       return basePath.c_str();\r
 }\r
+       \r
 \r
 //------------------------------------------------------------------------\r
 size_t Mootcher::WriteMemoryCallback(void *ptr, size_t size, size_t nmemb, void *data)\r
@@ -107,7 +121,10 @@ size_t Mootcher::WriteMemoryCallback(void *ptr, size_t size, size_t nmemb, void
 \r
 //------------------------------------------------------------------------\r
 \r
-std::string Mootcher::sortMethodString(enum sortMethod sort) {\r
+std::string Mootcher::sortMethodString(enum sortMethod sort)\r
+{\r
+// given a sort type, returns the string value to be passed to the API to\r
+// sort the results in the requested way.\r
 \r
        switch (sort) {\r
                case sort_duration_desc:        return "duration_desc"; \r
@@ -136,7 +153,7 @@ void Mootcher::setcUrlOptions()
        \r
        // Allow connections to time out (without using signals)\r
        curl_easy_setopt(curl, CURLOPT_NOSIGNAL, 1);\r
-       curl_easy_setopt(curl, CURLOPT_CONNECTTIMEOUT, 10);\r
+       curl_easy_setopt(curl, CURLOPT_CONNECTTIMEOUT, 30);\r
 \r
 \r
 }\r
@@ -165,27 +182,38 @@ std::string Mootcher::doRequest(std::string uri, std::string params)
        }\r
                \r
        curl_easy_setopt(curl, CURLOPT_URL, url.c_str() );\r
-       std::cerr << "doRequest: " << url << std::endl;\r
        \r
        // perform online request\r
        CURLcode res = curl_easy_perform(curl);\r
        if( res != 0 ) {\r
-               std::cerr << "curl error " << res << " (" << curl_easy_strerror(res) << ")" << std::endl;\r
+               error << string_compose (_("curl error %1 (%2)"), res, curl_easy_strerror(res)) << endmsg;\r
                return "";\r
        }\r
 \r
-       result = xml_page.memory;\r
        // free the memory\r
-       if(xml_page.memory){\r
-               free( xml_page.memory );\r
-               xml_page.memory = NULL;\r
-               xml_page.size = 0;\r
+       if (xml_page.memory) {\r
+               result = xml_page.memory;\r
        }\r
+       \r
+       free (xml_page.memory);\r
+       xml_page.memory = NULL;\r
+       xml_page.size = 0;\r
 \r
        return result;\r
+}\r
+\r
 \r
+std::string Mootcher::searchSimilar(std::string id)\r
+{\r
+       std::string params = "";\r
+\r
+       params += "&fields=id,original_filename,duration,filesize,samplerate,license,serve";\r
+       params += "&num_results=100";\r
+\r
+       return doRequest("/sounds/" + id + "/similar", params);\r
 }\r
 \r
+//------------------------------------------------------------------------\r
 \r
 std::string Mootcher::searchText(std::string query, int page, std::string filter, enum sortMethod sort)\r
 {\r
@@ -196,15 +224,23 @@ std::string Mootcher::searchText(std::string query, int page, std::string filter
                snprintf(buf, 23, "p=%d&", page);\r
                params += buf;\r
        }\r
-       \r
-       params += "q=" + query; \r
 \r
-       if (filter != "")\r
-               params += "&f=" + filter;\r
+       char *eq = curl_easy_escape(curl, query.c_str(), query.length());\r
+       params += "q=\"" + std::string(eq) + "\"";\r
+       free(eq);\r
+\r
+       if (filter != "") {\r
+               char *ef = curl_easy_escape(curl, filter.c_str(), filter.length());\r
+               params += "&f=" + std::string(ef);\r
+               free(ef);\r
+       }\r
        \r
        if (sort)\r
                params += "&s=" + sortMethodString(sort);\r
 \r
+       params += "&fields=id,original_filename,duration,filesize,samplerate,license,serve";\r
+       params += "&sounds_per_page=100";\r
+\r
        return doRequest("/sounds/search", params);\r
 }\r
 \r
@@ -215,12 +251,9 @@ std::string Mootcher::getSoundResourceFile(std::string ID)
 \r
        std::string originalSoundURI;\r
        std::string audioFileName;\r
-       std::string xmlFileName;\r
        std::string xml;\r
 \r
 \r
-       std::cerr << "getSoundResourceFile(" << ID << ")" << std::endl;\r
-\r
        // download the xmlfile into xml_page\r
        xml = doRequest("/sounds/" + ID, "");\r
 \r
@@ -230,36 +263,21 @@ std::string Mootcher::getSoundResourceFile(std::string ID)
 \r
        // if the page is not a valid xml document with a 'freesound' root\r
        if (freesound == NULL) {\r
-               std::cerr << "getSoundResourceFile: There is no valid root in the xml file" << std::endl;\r
+               error << _("getSoundResourceFile: There is no valid root in the xml file") << endmsg;\r
                return "";\r
        }\r
 \r
        if (strcmp(doc.root()->name().c_str(), "response") != 0) {\r
-               std::cerr << "getSoundResourceFile: root =" << doc.root()->name() << ", != response" << std::endl;\r
+               error << string_compose (_("getSoundResourceFile: root = %1, != response"), doc.root()->name()) << endmsg;\r
                return "";\r
        }\r
 \r
        XMLNode *name = freesound->child("original_filename");\r
-       XMLNode *filesize = freesound->child("filesize");\r
-\r
 \r
        // get the file name and size from xml file\r
-       if (name && filesize) {\r
-\r
-               audioFileName = basePath + "snd/" + ID + "-" + name->child("text")->content();\r
-\r
-               // create new filename with the ID number\r
-               xmlFileName = basePath;\r
-               xmlFileName += "snd/";\r
-               xmlFileName += freesound->child("id")->child("text")->content();\r
-               xmlFileName += "-";\r
-               xmlFileName += name->child("text")->content();\r
-               xmlFileName += ".xml";\r
+       if (name) {\r
 \r
-               // std::cerr << "getSoundResourceFile: saving XML: " << xmlFileName << std::endl;\r
-\r
-               // save the xml file to disk\r
-               doc.write(xmlFileName.c_str());\r
+               audioFileName = Glib::build_filename (basePath, ID + "-" + name->child("text")->content());\r
 \r
                //store all the tags in the database\r
                XMLNode *tags = freesound->child("tags");\r
@@ -291,83 +309,156 @@ int audioFileWrite(void *buffer, size_t size, size_t nmemb, void *file)
 };\r
 \r
 //------------------------------------------------------------------------\r
-std::string Mootcher::getAudioFile(std::string originalFileName, std::string ID, std::string audioURL, Gtk::ProgressBar *progress_bar)\r
+\r
+void *\r
+Mootcher::threadFunc() {\r
+CURLcode res;\r
+\r
+       res = curl_easy_perform (curl);\r
+       fclose (theFile);\r
+       curl_easy_setopt (curl, CURLOPT_NOPROGRESS, 1); // turn off the progress bar\r
+       \r
+       if (res != CURLE_OK) {\r
+               /* it's not an error if the user pressed the stop button */\r
+               if (res != CURLE_ABORTED_BY_CALLBACK) {\r
+                       error <<  string_compose (_("curl error %1 (%2)"), res, curl_easy_strerror(res)) << endmsg;\r
+               }\r
+               remove ( (audioFileName+".part").c_str() );  \r
+       } else {\r
+               rename ( (audioFileName+".part").c_str(), audioFileName.c_str() );\r
+               // now download the tags &c.\r
+               getSoundResourceFile(ID);\r
+       }\r
+\r
+       return (void *) res;\r
+}\r
\r
+void\r
+Mootcher::doneWithMootcher()\r
 {\r
 \r
-       std::string audioFileName = basePath + "snd/" + ID + "-" + originalFileName;\r
+       // update the sound info pane if the selection in the list box is still us \r
+       sfb->refresh_display(ID, audioFileName);\r
+\r
+       delete this; // this should be OK to do as long as Progress and Finished signals are always received in the order in which they are emitted\r
+}\r
+\r
+static void *\r
+freesound_download_thread_func(void *arg) \r
+{ \r
+       Mootcher *thisMootcher = (Mootcher *) arg;\r
+       void *res;\r
+\r
+       // std::cerr << "freesound_download_thread_func(" << arg << ")" << std::endl;\r
+       res = thisMootcher->threadFunc();\r
 \r
-       //check to see if audio file already exists\r
-       FILE *testFile = fopen(audioFileName.c_str(), "r");\r
+       thisMootcher->Finished(); /* EMIT SIGNAL */\r
+       return res;\r
+}\r
+\r
+\r
+//------------------------------------------------------------------------\r
+\r
+bool Mootcher::checkAudioFile(std::string originalFileName, std::string theID)\r
+{\r
+       ensureWorkingDir();\r
+       ID = theID;\r
+       audioFileName = Glib::build_filename (basePath, ID + "-" + originalFileName);\r
+\r
+       // check to see if audio file already exists\r
+       FILE *testFile = g_fopen(audioFileName.c_str(), "r");\r
        if (testFile) {  \r
                fseek (testFile , 0 , SEEK_END);\r
                if (ftell (testFile) > 256) {\r
-                       std::cerr << "audio file " << audioFileName << " already exists" << std::endl;\r
                        fclose (testFile);\r
-                       return audioFileName;\r
+                       return true;\r
                }\r
                \r
-               // else file was small, probably an error, delete it and try again\r
+               // else file was small, probably an error, delete it \r
                fclose(testFile);\r
                remove( audioFileName.c_str() );  \r
        }\r
+       return false;\r
+}\r
 \r
-       //now download the actual file\r
-       if (curl) {\r
 \r
-               FILE* theFile;\r
-               theFile = fopen( audioFileName.c_str(), "wb" );\r
+bool Mootcher::fetchAudioFile(std::string originalFileName, std::string theID, std::string audioURL, SoundFileBrowser *caller)\r
+{\r
+       ensureWorkingDir();\r
+       ID = theID;\r
+       audioFileName = Glib::build_filename (basePath, ID + "-" + originalFileName);\r
 \r
-               if (theFile) {\r
-               \r
-                       // create the download url\r
-                       audioURL += "?api_key=" + api_key;\r
-               \r
-                       setcUrlOptions();\r
-                       curl_easy_setopt(curl, CURLOPT_URL, audioURL.c_str() );\r
-                       curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, audioFileWrite);\r
-                       curl_easy_setopt(curl, CURLOPT_WRITEDATA, theFile);\r
-\r
-                       std::cerr << "downloading " << audioFileName << " from " << audioURL << "..." << std::endl;\r
-\r
-                       curl_easy_setopt (curl, CURLOPT_NOPROGRESS, 0); // turn on the progress bar\r
-                       curl_easy_setopt (curl, CURLOPT_PROGRESSFUNCTION, progress_callback);\r
-                       curl_easy_setopt (curl, CURLOPT_PROGRESSDATA, progress_bar);\r
-\r
-                       CURLcode res = curl_easy_perform(curl);\r
-                       fclose(theFile);\r
-\r
-                       curl_easy_setopt (curl, CURLOPT_NOPROGRESS, 1); // turn off the progress bar\r
-                       progress_bar->set_fraction(0.0);\r
-\r
-                       if( res != 0 ) {\r
-                               std::cerr <<  "curl error " << res << " (" << curl_easy_strerror(res) << ")" << std::endl;\r
-                               remove( audioFileName.c_str() );  \r
-                               return "";\r
-                       } else {\r
-                               std::cerr << "done!" << std::endl;\r
-                               // now download the tags &c.\r
-                               getSoundResourceFile(ID);\r
-                       }\r
-               }\r
+       if (!curl) {\r
+               return false;\r
        }\r
+       // now download the actual file\r
+       theFile = g_fopen( (audioFileName + ".part").c_str(), "wb" );\r
 \r
-       return audioFileName;\r
+       if (!theFile) {\r
+               return false;\r
+       }\r
+       \r
+       // create the download url\r
+       audioURL += "?api_key=" + api_key;\r
+\r
+       setcUrlOptions();\r
+       curl_easy_setopt(curl, CURLOPT_URL, audioURL.c_str() );\r
+       curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, audioFileWrite);\r
+       curl_easy_setopt(curl, CURLOPT_WRITEDATA, theFile);\r
+\r
+       std::string prog;\r
+       prog = string_compose (_("%1"), originalFileName);\r
+       progress_bar.set_text(prog);\r
+\r
+       Gtk::VBox *freesound_vbox = dynamic_cast<Gtk::VBox *> (caller->notebook.get_nth_page(2));\r
+       freesound_vbox->pack_start(progress_hbox, Gtk::PACK_SHRINK);\r
+       progress_hbox.show();\r
+       cancel_download = false;\r
+       sfb = caller;\r
+\r
+       curl_easy_setopt (curl, CURLOPT_NOPROGRESS, 0); // turn on the progress bar\r
+       curl_easy_setopt (curl, CURLOPT_PROGRESSFUNCTION, progress_callback);\r
+       curl_easy_setopt (curl, CURLOPT_PROGRESSDATA, this);\r
+\r
+       Progress.connect(*this, invalidator (*this), boost::bind(&Mootcher::updateProgress, this, _1, _2), gui_context());\r
+       Finished.connect(*this, invalidator (*this), boost::bind(&Mootcher::doneWithMootcher, this), gui_context());\r
+       pthread_t freesound_download_thread;\r
+       pthread_create_and_store("freesound_import", &freesound_download_thread, freesound_download_thread_func, this);\r
+\r
+       return true;\r
 }\r
 \r
 //---------\r
-int Mootcher::progress_callback(void *bar, double dltotal, double dlnow, double ultotal, double ulnow)\r
+\r
+void \r
+Mootcher::updateProgress(double dlnow, double dltotal) \r
+{\r
+       if (dltotal > 0) {\r
+               double fraction = dlnow / dltotal;\r
+               // std::cerr << "progress idle: " << progress->bar->get_text() << ". " << progress->dlnow << " / " << progress->dltotal << " = " << fraction << std::endl;\r
+               if (fraction > 1.0) {\r
+                       fraction = 1.0;\r
+               } else if (fraction < 0.0) {\r
+                       fraction = 0.0;\r
+               }\r
+               progress_bar.set_fraction(fraction);\r
+       }\r
+}\r
+\r
+int \r
+Mootcher::progress_callback(void *caller, double dltotal, double dlnow, double /*ultotal*/, double /*ulnow*/)\r
 {\r
+       // It may seem curious to pass a pointer to an instance of an object to a static\r
+       // member function, but we can't use a normal member function as a curl progress callback,\r
+       // and we want access to some private members of Mootcher.\r
 \r
-       //XXX I hope it's OK to do GTK things in this callback. Otherwise\r
-       // I'll have to do stuff like in interthread_progress_window.\r
+       Mootcher *thisMootcher = (Mootcher *) caller;\r
        \r
-       Gtk::ProgressBar *progress_bar = (Gtk::ProgressBar *) bar;\r
-       progress_bar->set_fraction(dlnow/dltotal);\r
-       /* Make sure the progress widget gets updated */\r
-       while (Glib::MainContext::get_default()->iteration (false)) {\r
-               /* do nothing */\r
+       if (thisMootcher->cancel_download) {\r
+               return -1;\r
        }\r
-       std::cerr << "progress: " << dlnow << " of " << dltotal << " \r";\r
+\r
+       thisMootcher->Progress(dlnow, dltotal); /* EMIT SIGNAL */\r
        return 0;\r
 }\r
 \r